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  * RX FIFO buffer full error.
  86  */
  87 #define AFSK_RXFIFO_OVERRUN BV(0)
  88
  89 /**
  90  * AFSK1200 modem context.
  91  */
  92 typedef struct Afsk
  93 {
  94         /** Base "class" */
  95         KFile fd;
  96
  97         /** ADC channel to be used by the demodulator */
  98         int adc_ch;
  99
 100         /** DAC channel to be used by the modulator */
 101         int dac_ch;
 102
 103         /** Current sample of bit for output data. */
 104         uint8_t sample_count;
 105
 106         /** Current character to be modulated */
 107         uint8_t curr_out;
 108
 109         /** Mask of current modulated bit */
 110         uint8_t tx_bit;
 111
 112         /** True if bit stuff is allowed, false otherwise */
 113         bool bit_stuff;
 114
 115         /** Counter for bit stuffing */
 116         uint8_t stuff_cnt;
 117         /**
 118          * DDS phase accumulator for generating modulated data.
 119          */
 120         uint16_t phase_acc;
 121
 122         /** Current phase increment for current modulated bit */
 123         uint16_t phase_inc;
 124
 125         /** Delay line used to delay samples by (SAMPLEPERBIT / 2) */
 126         FIFOBuffer delay_fifo;
 127
 128         /**
 129          * Buffer for delay FIFO.
 130          * The 1 is added because the FIFO macros need
 131          * 1 byte more to handle a buffer (SAMPLEPERBIT / 2) bytes long.
 132          */
 133         int8_t delay_buf[SAMPLEPERBIT / 2 + 1];
 134
 135         /** FIFO for received data */
 136         FIFOBuffer rx_fifo;
 137
 138         /** FIFO rx buffer */
 139         uint8_t rx_buf[CONFIG_AFSK_RX_BUFLEN];
 140
 141         /** FIFO for transmitted data */
 142         FIFOBuffer tx_fifo;
 143
 144         /** FIFO tx buffer */
 145         uint8_t tx_buf[CONFIG_AFSK_TX_BUFLEN];
 146
 147         /** IIR filter X cells, used to filter sampled data by the demodulator */
 148         int16_t iir_x[2];
 149
 150         /** IIR filter Y cells, used to filter sampled data by the demodulator */
 151         int16_t iir_y[2];
 152
 153         /**
 154          * Bits sampled by the demodulator are here.
 155          * Since ADC samplerate is higher than the bitrate, the bits here are
 156          * SAMPLEPERBIT times the bitrate.
 157          */
 158         uint8_t sampled_bits;
 159
 160         /**
 161          * Current phase, needed to know when the bitstream at ADC speed
 162          * should be sampled.
 163          */
 164         int8_t curr_phase;
 165
 166         /** Bits found by the demodulator at the correct bitrate speed. */
 167         uint8_t found_bits;
 168
 169         /** True while modem sends data */
 170         volatile bool sending;
 171
 172         /**
 173          * AFSK modem status.
 174          * If 0 all is ok, otherwise errors are present.
 175          */
 176         volatile int status;
 177
 178         /** Hdlc context */
 179         Hdlc hdlc;
 180
 181         /**
 182          * Preamble length.
 183          * When the AFSK modem wants to send data, before sending the actual data,
 184          * shifts out preamble_len HDLC_FLAG characters.
 185          * This helps to synchronize the demodulator filters on the receiver side.
 186          */
 187         uint16_t preamble_len;
 188
 189         /**
 190          * Trailer length.
 191          * After sending the actual data, the AFSK shifts out
 192          * trailer_len HDLC_FLAG characters.
 193          * This helps to synchronize the demodulator filters on the receiver side.
 194          */
 195         uint16_t trailer_len;
 196 } Afsk;
 197
 198 #define KFT_AFSK MAKE_ID('A', 'F', 'S', 'K')
 199
 200 INLINE Afsk *AFSK_CAST(KFile *fd)
 201 {
 202   ASSERT(fd->_type == KFT_AFSK);
 203   return (Afsk *)fd;
 204 }
 205
 206
 207 void afsk_adc_isr(Afsk *af, int8_t sample);
 208 uint8_t afsk_dac_isr(Afsk *af);
 209 void afsk_init(Afsk *af, int adc_ch, int dac_ch);
 210
 211
 212 /**
 213  * \name Afsk filter types.
 214  * $WIZ$ afsk_filter_list = "AFSK_BUTTERWORTH", "AFSK_CHEBYSHEV"
 215  * \{
 216  */
 217 #define AFSK_BUTTERWORTH  0
 218 #define AFSK_CHEBYSHEV    1
 219 /* \} */
 220
 221 int afsk_testSetup(void);
 222 int afsk_testRun(void);
 223 int afsk_testTearDown(void);
 224
 225 #endif