Release 2.7.0
[bertos.git] / boards / ek-lm3s1968 / hw / hw_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 2006 Develer S.r.l. (http://www.develer.com/)
30  * All Rights Reserved.
31  * -->
32  *
33  * \brief AFSK modem hardware-specific definitions.
34  *
35  *
36  * \author Francesco Sacchi <batt@develer.com>
37  */
38
39 #ifndef HW_AFSK_H
40 #define HW_AFSK_H
41
42 #include "cfg/cfg_arch.h"
43
44 #warning TODO:This is an example implementation, you must implement it!
45
46 /**
47  * Initialize the specified channel of the ADC for AFSK needs.
48  * The adc should be configured to have a continuos stream of convertions.
49  * For every convertion there must be an ISR that read the sample
50  * and call afsk_adc_isr(), passing the context and the sample.
51  *
52  * \param ch channel to be used for AFSK demodulation.
53  * \param ctx AFSK context (\see Afsk). This parameter must be saved and
54  *            passed back to afsk_adc_isr() for every convertion.
55  */
56 #define AFSK_ADC_INIT(ch, ctx) do { (void)ch, (void)ctx; } while (0)
57
58 #define AFSK_STROBE_INIT() do { /* Implement me */ } while (0)
59 #define AFSK_STROBE_ON()   do { /* Implement me */ } while (0)
60 #define AFSK_STROBE_OFF()  do { /* Implement me */ } while (0)
61
62 /**
63  * Initialize the specified channel of the DAC for AFSK needs.
64  * The DAC has to be configured in order to call an ISR for every sample sent.
65  * The DAC doesn't have to start the IRQ immediatly but have to wait
66  * the AFSK driver to call AFSK_DAC_IRQ_START().
67  * The ISR must then call afsk_dac_isr() passing the AFSK context.
68  * \param ch DAC channel to be used for AFSK modulation.
69  * \param ctx AFSK context (\see Afsk).  This parameter must be saved and
70  *             passed back to afsk_dac_isr() for every convertion.
71  */
72 #define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; } while (0)
73
74 /**
75  * Start DAC convertions on channel \a ch.
76  * \param ch DAC channel.
77  */
78 #define AFSK_DAC_IRQ_START(ch)   do { (void)ch; /* Implement me */ } while (0)
79
80 /**
81  * Stop DAC convertions on channel \a ch.
82  * \param ch DAC channel.
83  */
84 #define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; /* Implement me */ } while (0)
85
86 #endif /* HW_AFSK_H */