bertos/net/afsk.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief AFSK1200 modem.
  34  *
  35  * \version $Id$
  36  * \author Francesco Sacchi <asterix@develer.com>
  37  *
  38  * $WIZ$ module_name = "afsk"
  39  * $WIZ$ module_configuration = "bertos/cfg/cfg_afsk.h"
  40  * $WIZ$ module_depends = "timer", "kfile"
  41  * $WIZ$ module_hw = "bertos/hw/hw_afsk.h"
  42  */
  43
  44 #ifndef DRV_AFSK_H
  45 #define DRV_AFSK_H
  46
  47 #include "cfg/cfg_afsk.h"
  48 #include "hw/hw_afsk.h"
  49
  50 #include <kern/kfile.h>
  51 #include <cfg/compiler.h>
  52 #include <struct/fifobuf.h>
  53
  54
  55
  56 /**
  57  * ADC sample rate.
  58  * The demodulator filters are designed to work at this frequency.
  59  * If you need to change this remember to update afsk_adc_isr().
  60  */
  61 #define SAMPLERATE 9600
  62
  63 /**
  64  * Bitrate of the received/transmitted data.
  65  * The demodulator filters and decoderes are designed to work at this frequency.
  66  * If you need to change this remember to update afsk_adc_isr().
  67  */
  68 #define BITRATE    1200
  69
  70 #define SAMPLEPERBIT (SAMPLERATE / BITRATE)
  71
  72 /**
  73  * HDLC (High-Level Data Link Control) context.
  74  * Maybe to be moved in a separate HDLC module one day.
  75  */
  76 typedef struct Hdlc
  77 {
  78         uint8_t demod_bits; ///< Bitstream from the demodulator.
  79         uint8_t bit_idx;    ///< Current received bit.
  80         uint8_t currchar;   ///< Current received character.
  81         bool rxstart;       ///< True if an HDLC_FLAG char has been found in the bitstream.
  82 } Hdlc;
  83
  84
  85 /**
  86  * AFSK1200 modem context.
  87  */
  88 typedef struct Afsk
  89 {
  90         /** Base "class" */
  91         KFile fd;
  92
  93         /** ADC channel to be used by the demodulator */
  94         int adc_ch;
  95
  96         /** DAC channel to be used by the modulator */
  97         int dac_ch;
  98
  99         /** Current sample of bit for output data. */
 100         uint8_t sample_count;
 101
 102         /** Current character to be modulated */
 103         uint8_t curr_out;
 104
 105         /** Mask of current modulated bit */
 106         uint8_t tx_bit;
 107
 108         /** True if bit stuff is allowed, false otherwise */
 109         bool bit_stuff;
 110
 111         /** Counter for bit stuffing */
 112         uint8_t stuff_cnt;
 113         /**
 114          * DDS phase accumulator for generating modulated data.
 115          */
 116         uint16_t phase_acc;
 117
 118         /** Current phase increment for current modulated bit */
 119         uint16_t phase_inc;
 120
 121         /** Delay line used to delay samples by (SAMPLEPERBIT / 2) */
 122         FIFOBuffer delay_fifo;
 123
 124         /**
 125          * Buffer for delay FIFO.
 126          * The 1 is added because the FIFO macros need
 127          * 1 byte more to handle a buffer (SAMPLEPERBIT / 2) bytes long.
 128          */
 129         int8_t delay_buf[SAMPLEPERBIT / 2 + 1];
 130
 131         /** FIFO for received data */
 132         FIFOBuffer rx_fifo;
 133
 134         /** FIFO rx buffer */
 135         uint8_t rx_buf[CONFIG_AFSK_RX_BUFLEN];
 136
 137         /** FIFO for transmitted data */
 138         FIFOBuffer tx_fifo;
 139
 140         /** FIFO tx buffer */
 141         uint8_t tx_buf[CONFIG_AFSK_TX_BUFLEN];
 142
 143         /** IIR filter X cells, used to filter sampled data by the demodulator */
 144         int16_t iir_x[2];
 145
 146         /** IIR filter Y cells, used to filter sampled data by the demodulator */
 147         int16_t iir_y[2];
 148
 149         /**
 150          * Bits sampled by the demodulator are here.
 151          * Since ADC samplerate is higher than the bitrate, the bits here are
 152          * SAMPLEPERBIT times the bitrate.
 153          */
 154         uint8_t sampled_bits;
 155
 156         /**
 157          * Current phase, needed to know when the bitstream at ADC speed
 158          * should be sampled.
 159          */
 160         int8_t curr_phase;
 161
 162         /** Bits found by the demodulator at the correct bitrate speed. */
 163         uint8_t found_bits;
 164
 165         /** True while modem sends data */
 166         volatile bool sending;
 167
 168         /** Hdlc context */
 169         Hdlc hdlc;
 170
 171         /**
 172          * Preamble length.
 173          * When the AFSK modem wants to send data, before sending the actual data,
 174          * shifts out preamble_len HDLC_FLAG characters.
 175          * This helps to synchronize the demodulator filters on the receiver side.
 176          */
 177         uint16_t preamble_len;
 178
 179         /**
 180          * Preamble length.
 181          * After sending the actual data, the AFSK shifts out
 182          * trailer_len HDLC_FLAG characters.
 183          * This helps to synchronize the demodulator filters on the receiver side.
 184          */
 185         uint16_t trailer_len;
 186 } Afsk;
 187
 188 #define KFT_AFSK MAKE_ID('A', 'F', 'S', 'K')
 189
 190 INLINE Afsk *AFSK_CAST(KFile *fd)
 191 {
 192   ASSERT(fd->_type == KFT_AFSK);
 193   return (Afsk *)fd;
 194 }
 195
 196 /**
 197  * ADC ISR callback.
 198  * This function has to be called by the ADC ISR when a sample of the configured
 199  * channel is available.
 200  * \param af Afsk context to operate one (\see Afsk).
 201  * \param sample current sample from the ADC.
 202  */
 203 void afsk_adc_isr(Afsk *af, int8_t sample);
 204
 205 /**
 206  * DAC ISR callback.
 207  * This function has to be called by the DAC ISR when a sample of the configured
 208  * channel has been converted out.
 209  *
 210  * \param af Afsk context to operate one (\see Afsk).
 211  *
 212  * \note The next DAC output sample is supplied by the Afsk driver through calling
 213  *        the AFSK_DAC_SET() callback.
 214  */
 215 void afsk_dac_isr(Afsk *af);
 216
 217 /**
 218  * Initialize an AFSK1200 modem.
 219  * \param af Afsk context to operate one (\see Afsk).
 220  * \param adc_ch  ADC channel used by the demodulator.
 221  * \param dac_ch  DAC channel used by the modulator.
 222  */
 223 void afsk_init(Afsk *af, int adc_ch, int dac_ch);
 224
 225
 226 /**
 227  * \name afsk filter type
 228  * $WIZ$ afsk_filter_list = "AFSK_BUTTERWORTH", "AFSK_CHEBYSHEV"
 229  * \{
 230  */
 231 #define AFSK_BUTTERWORTH  0
 232 #define AFSK_CHEBYSHEV    1
 233 /* \} */
 234
 235 int afsk_testSetup(void);
 236 int afsk_testRun(void);
 237 int afsk_testTearDown(void);
 238
 239 #endif