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  * \author Francesco Sacchi <batt@develer.com>
  36  *
  37  * $WIZ$ module_name = "afsk"
  38  * $WIZ$ module_configuration = "bertos/cfg/cfg_afsk.h"
  39  * $WIZ$ module_depends = "timer", "kfile"
  40  * $WIZ$ module_hw = "bertos/hw/hw_afsk.h"
  41  */
  42
  43 #ifndef NET_AFSK_H
  44 #define NET_AFSK_H
  45
  46 #include "cfg/cfg_afsk.h"
  47 #include "hw/hw_afsk.h"
  48
  49 #include <cfg/compiler.h>
  50
  51 #include <io/kfile.h>
  52
  53 #include <struct/fifobuf.h>
  54
  55
  56
  57 /**
  58  * ADC sample rate.
  59  * The demodulator filters are designed to work at this frequency.
  60  * If you need to change this remember to update afsk_adc_isr().
  61  */
  62 #define SAMPLERATE 9600
  63
  64 /**
  65  * Bitrate of the received/transmitted data.
  66  * The demodulator filters and decoderes are designed to work at this frequency.
  67  * If you need to change this remember to update afsk_adc_isr().
  68  */
  69 #define BITRATE    1200
  70
  71 #define SAMPLEPERBIT (SAMPLERATE / BITRATE)
  72
  73 /**
  74  * HDLC (High-Level Data Link Control) context.
  75  * Maybe to be moved in a separate HDLC module one day.
  76  */
  77 typedef struct Hdlc
  78 {
  79         uint8_t demod_bits; ///< Bitstream from the demodulator.
  80         uint8_t bit_idx;    ///< Current received bit.
  81         uint8_t currchar;   ///< Current received character.
  82         bool rxstart;       ///< True if an HDLC_FLAG char has been found in the bitstream.
  83 } Hdlc;
  84
  85 /**
  86  * RX FIFO buffer full error.
  87  */
  88 #define AFSK_RXFIFO_OVERRUN BV(0)
  89
  90 /**
  91  * AFSK1200 modem context.
  92  */
  93 typedef struct Afsk
  94 {
  95         /** Base "class" */
  96         KFile fd;
  97
  98         /** ADC channel to be used by the demodulator */
  99         int adc_ch;
 100
 101         /** DAC channel to be used by the modulator */
 102         int dac_ch;
 103
 104         /** Current sample of bit for output data. */
 105         uint8_t sample_count;
 106
 107         /** Current character to be modulated */
 108         uint8_t curr_out;
 109
 110         /** Mask of current modulated bit */
 111         uint8_t tx_bit;
 112
 113         /** True if bit stuff is allowed, false otherwise */
 114         bool bit_stuff;
 115
 116         /** Counter for bit stuffing */
 117         uint8_t stuff_cnt;
 118         /**
 119          * DDS phase accumulator for generating modulated data.
 120          */
 121         uint16_t phase_acc;
 122
 123         /** Current phase increment for current modulated bit */
 124         uint16_t phase_inc;
 125
 126         /** Delay line used to delay samples by (SAMPLEPERBIT / 2) */
 127         FIFOBuffer delay_fifo;
 128
 129         /**
 130          * Buffer for delay FIFO.
 131          * The 1 is added because the FIFO macros need
 132          * 1 byte more to handle a buffer (SAMPLEPERBIT / 2) bytes long.
 133          */
 134         int8_t delay_buf[SAMPLEPERBIT / 2 + 1];
 135
 136         /** FIFO for received data */
 137         FIFOBuffer rx_fifo;
 138
 139         /** FIFO rx buffer */
 140         uint8_t rx_buf[CONFIG_AFSK_RX_BUFLEN];
 141
 142         /** FIFO for transmitted data */
 143         FIFOBuffer tx_fifo;
 144
 145         /** FIFO tx buffer */
 146         uint8_t tx_buf[CONFIG_AFSK_TX_BUFLEN];
 147
 148         /** IIR filter X cells, used to filter sampled data by the demodulator */
 149         int16_t iir_x[2];
 150
 151         /** IIR filter Y cells, used to filter sampled data by the demodulator */
 152         int16_t iir_y[2];
 153
 154         /**
 155          * Bits sampled by the demodulator are here.
 156          * Since ADC samplerate is higher than the bitrate, the bits here are
 157          * SAMPLEPERBIT times the bitrate.
 158          */
 159         uint8_t sampled_bits;
 160
 161         /**
 162          * Current phase, needed to know when the bitstream at ADC speed
 163          * should be sampled.
 164          */
 165         int8_t curr_phase;
 166
 167         /** Bits found by the demodulator at the correct bitrate speed. */
 168         uint8_t found_bits;
 169
 170         /** True while modem sends data */
 171         volatile bool sending;
 172
 173         /**
 174          * AFSK modem status.
 175          * If 0 all is ok, otherwise errors are present.
 176          */
 177         volatile int status;
 178
 179         /** Hdlc context */
 180         Hdlc hdlc;
 181
 182         /**
 183          * Preamble length.
 184          * When the AFSK modem wants to send data, before sending the actual data,
 185          * shifts out preamble_len HDLC_FLAG characters.
 186          * This helps to synchronize the demodulator filters on the receiver side.
 187          */
 188         uint16_t preamble_len;
 189
 190         /**
 191          * Trailer length.
 192          * After sending the actual data, the AFSK shifts out
 193          * trailer_len HDLC_FLAG characters.
 194          * This helps to synchronize the demodulator filters on the receiver side.
 195          */
 196         uint16_t trailer_len;
 197 } Afsk;
 198
 199 #define KFT_AFSK MAKE_ID('A', 'F', 'S', 'K')
 200
 201 INLINE Afsk *AFSK_CAST(KFile *fd)
 202 {
 203   ASSERT(fd->_type == KFT_AFSK);
 204   return (Afsk *)fd;
 205 }
 206
 207
 208 void afsk_adc_isr(Afsk *af, int8_t sample);
 209 uint8_t afsk_dac_isr(Afsk *af);
 210 void afsk_init(Afsk *af, int adc_ch, int dac_ch);
 211
 212
 213 /**
 214  * \name Afsk filter types.
 215  * $WIZ$ afsk_filter_list = "AFSK_BUTTERWORTH", "AFSK_CHEBYSHEV"
 216  * \{
 217  */
 218 #define AFSK_BUTTERWORTH  0
 219 #define AFSK_CHEBYSHEV    1
 220 /* \} */
 221
 222 int afsk_testSetup(void);
 223 int afsk_testRun(void);
 224 int afsk_testTearDown(void);
 225
 226 #endif /* NET_AFSK_H */