Move functions documentation near their implementation.

[bertos.git] / bertos / net / afsk.c

diff --git a/bertos/net/afsk.c b/bertos/net/afsk.c
index a7273bdfd45789095091d6abe1fd5d9a1f92757c..f8f29f9da395df7b525ab1cd8327e3d514a12ba9 100644 (file)
--- a/bertos/net/afsk.c
+++ b/bertos/net/afsk.c
@@ -109,69 +109,77 @@ INLINE uint8_t sin_sample(uint16_t idx)
 #define EDGE_FOUND(bitline)            BIT_DIFFER((bitline), (bitline) >> 1)
 
 
-static void hdlc_parse(Afsk *af, bool bit)
+static void hdlc_parse(Hdlc *hdlc, bool bit, FIFOBuffer *fifo)
 {
-       af->hdlc_demod_bits <<= 1;
-       af->hdlc_demod_bits |= bit ? 1 : 0;
+       hdlc->demod_bits <<= 1;
+       hdlc->demod_bits |= bit ? 1 : 0;
 
        /* HDLC Flag */
-       if (af->hdlc_demod_bits == HDLC_FLAG)
+       if (hdlc->demod_bits == HDLC_FLAG)
        {
-               if (!fifo_isfull(&af->rx_fifo))
+               if (!fifo_isfull(fifo))
                {
-                       fifo_push(&af->rx_fifo, HDLC_FLAG);
-                       af->hdlc_rxstart = true;
+                       fifo_push(fifo, HDLC_FLAG);
+                       hdlc->rxstart = true;
                }
                else
-                       af->hdlc_rxstart = false;
+                       hdlc->rxstart = false;
 
-               af->hdlc_currchar = 0;
-               af->hdlc_bit_idx = 0;
+               hdlc->currchar = 0;
+               hdlc->bit_idx = 0;
                return;
        }
 
        /* Reset */
-       if ((af->hdlc_demod_bits & HDLC_RESET) == HDLC_RESET)
+       if ((hdlc->demod_bits & HDLC_RESET) == HDLC_RESET)
        {
-               af->hdlc_rxstart = false;
+               hdlc->rxstart = false;
                return;
        }
 
-       if (!af->hdlc_rxstart)
+       if (!hdlc->rxstart)
                return;
 
        /* Stuffed bit */
-       if ((af->hdlc_demod_bits & 0x3f) == 0x3e)
+       if ((hdlc->demod_bits & 0x3f) == 0x3e)
                return;
 
-       if (af->hdlc_demod_bits & 0x01)
-               af->hdlc_currchar |= 0x80;
+       if (hdlc->demod_bits & 0x01)
+               hdlc->currchar |= 0x80;
 
-       if (++af->hdlc_bit_idx >= 8)
+       if (++hdlc->bit_idx >= 8)
        {
-               if ((af->hdlc_currchar == HDLC_FLAG
-                       || af->hdlc_currchar == HDLC_RESET
-                       || af->hdlc_currchar == AX25_ESC))
+               if ((hdlc->currchar == HDLC_FLAG
+                       || hdlc->currchar == HDLC_RESET
+                       || hdlc->currchar == AX25_ESC))
                {
-                       if (!fifo_isfull(&af->rx_fifo))
-                               fifo_push(&af->rx_fifo, AX25_ESC);
+                       if (!fifo_isfull(fifo))
+                               fifo_push(fifo, AX25_ESC);
                        else
-                               af->hdlc_rxstart = false;
+                               hdlc->rxstart = false;
                }
 
-               if (!fifo_isfull(&af->rx_fifo))
-                       fifo_push(&af->rx_fifo, af->hdlc_currchar);
+               if (!fifo_isfull(fifo))
+                       fifo_push(fifo, hdlc->currchar);
                else
-                       af->hdlc_rxstart = false;
+                       hdlc->rxstart = false;
 
-               af->hdlc_currchar = 0;
-               af->hdlc_bit_idx = 0;
+               hdlc->currchar = 0;
+               hdlc->bit_idx = 0;
                return;
        }
 
-       af->hdlc_currchar >>= 1;
+       hdlc->currchar >>= 1;
 }
 
+
+/**
+ * ADC ISR callback.
+ * This function has to be called by the ADC ISR when a sample of the configured
+ * channel is available.
+ * \param af Afsk context to operate one (\see Afsk).
+ * \param curr_sample current sample from the ADC.
+ */
 void afsk_adc_isr(Afsk *af, int8_t curr_sample)
 {
        AFSK_STROBE_ON();
@@ -254,7 +262,9 @@ void afsk_adc_isr(Afsk *af, int8_t curr_sample)
                 * Determine bit value by reading the last 3 sampled bits.
                 * If the number of ones is two or greater, the bit value is a 1,
                 * otherwise is a 0.
+                * This algorithm presumes that there are 8 samples per bit.
                 */
+               STATIC_ASSERT(SAMPLEPERBIT == 8);
                uint8_t bits = af->sampled_bits & 0x07;
                if (bits == 0x07 // 111, 3 bits set to 1
                 || bits == 0x06 // 110, 2 bits
@@ -267,7 +277,7 @@ void afsk_adc_isr(Afsk *af, int8_t curr_sample)
                 * NRZI coding: if 2 consecutive bits have the same value
                 * a 1 is received, otherwise it's a 0.
                 */
-               hdlc_parse(af, !EDGE_FOUND(af->found_bits));
+               hdlc_parse(&af->hdlc, !EDGE_FOUND(af->found_bits), &af->rx_fifo);
        }
 
 
@@ -292,6 +302,16 @@ static void afsk_txStart(Afsk *af)
 
 #define SWITCH_TONE(inc)  (((inc) == MARK_INC) ? SPACE_INC : MARK_INC)
 
+/**
+ * DAC ISR callback.
+ * This function has to be called by the DAC ISR when a sample of the configured
+ * channel has been converted out.
+ *
+ * \param af Afsk context to operate one (\see Afsk).
+ *
+ * \note The next DAC output sample is supplied by the Afsk driver through calling
+ *        the AFSK_DAC_SET() callback.
+ */
 void afsk_dac_isr(Afsk *af)
 {
        /* Check if we are at a start of a sample cycle */
@@ -461,6 +481,12 @@ static int afsk_flush(KFile *fd)
 }
 
 
+/**
+ * Initialize an AFSK1200 modem.
+ * \param af Afsk context to operate one (\see Afsk).
+ * \param adc_ch  ADC channel used by the demodulator.
+ * \param dac_ch  DAC channel used by the modulator.
+ */
 void afsk_init(Afsk *af, int adc_ch, int dac_ch)
 {
        #if CONFIG_AFSK_RXTIMEOUT != -1