Refactor afsk IRQ macros in order to handle multiple modems.
[bertos.git] / 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 // Demodulator constants
56 #define SAMPLERATE 9600
57 #define BITRATE    1200
58
59 #define SAMPLEPERBIT (SAMPLERATE / BITRATE)
60
61
62 typedef struct Afsk
63 {
64         KFile fd;
65
66         int adc_ch;
67         int dac_ch;
68
69         /** Current sample of bit for output data. */
70         uint8_t sample_count;
71
72         /** Current character to be modulated */
73         uint8_t curr_out;
74
75         /** Mask of current modulated bit */
76         uint8_t tx_bit;
77
78         /** True if bit stuff is allowed, false otherwise */
79         bool bit_stuff;
80
81         /** Counter for bit stuffing */
82         uint8_t stuff_cnt;
83         /**
84          * DDS phase accumulator for generating modulated data.
85          */
86         uint16_t phase_acc;
87
88         /** Current phase increment for current modulated bit */
89         uint16_t phase_inc;
90
91         /** Delay line used to delay samples by (SAMPLEPERBIT / 2) */
92         FIFOBuffer delay_fifo;
93
94         /**
95          * Buffer for delay FIFO.
96          * The 1 is added because the FIFO macros need
97          * 1 byte more to handle a buffer (SAMPLEPERBIT / 2) bytes long.
98          */
99         int8_t delay_buf[SAMPLEPERBIT / 2 + 1];
100
101         FIFOBuffer rx_fifo;
102         uint8_t rx_buf[CONFIG_AFSK_RX_BUFLEN];
103
104         FIFOBuffer tx_fifo;
105         uint8_t tx_buf[CONFIG_AFSK_TX_BUFLEN];
106
107         int16_t iir_x[2];
108         int16_t iir_y[2];
109
110         uint8_t sampled_bits;
111         uint8_t found_bits;
112         int8_t curr_phase;
113
114         /* True while modem sends data */
115         volatile bool sending;
116
117
118         bool hdlc_rxstart;
119         uint8_t hdlc_currchar;
120         uint8_t hdlc_bit_idx;
121         uint8_t hdlc_demod_bits;
122
123         uint16_t preamble_len;
124         uint16_t trailer_len;
125 } Afsk;
126
127 #define KFT_AFSK MAKE_ID('A', 'F', 'S', 'K')
128
129 INLINE Afsk *AFSK_CAST(KFile *fd)
130 {
131   ASSERT(fd->_type == KFT_AFSK);
132   return (Afsk *)fd;
133 }
134
135 void afsk_adc_isr(Afsk *af, int8_t curr_sample);
136 void afsk_dac_isr(Afsk *af);
137 void afsk_init(Afsk *af, int adc_ch, int dac_ch);
138
139
140 /**
141  * \name afsk filter type
142  * $WIZ$ afsk_filter_list = "AFSK_BUTTERWORTH", "AFSK_CHEBYSHEV"
143  * \{
144  */
145 #define AFSK_BUTTERWORTH  0
146 #define AFSK_CHEBYSHEV    1
147 /* \} */
148
149 int afsk_testSetup(void);
150 int afsk_testRun(void);
151 int afsk_testTearDown(void);
152
153 #endif