bertos/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  * \version $Id$
  36  *
  37  * \author Francesco Sacchi <batt@develer.com>
  38  */
  39
  40 #ifndef HW_AFSK_H
  41 #define HW_AFSK_H
  42
  43 #include "cfg/cfg_arch.h"
  44
  45 #if !(ARCH & ARCH_UNITTEST)
  46         #warning TODO:This is an example implementation, you must implement it!
  47
  48         /**
  49          * Initialize the specified channel of the ADC for AFSK needs.
  50          * The adc should be configured to have a continuos stream of convertions.
  51          * For every convertion there must be an ISR that read the sample
  52          * and call afsk_adc_isr(), passing the context and the sample.
  53          *
  54          * \param ch channel to be used for AFSK demodulation.
  55          * \param ctx AFSK context (\see Afsk). This parameter must be saved and
  56          *            passed back to afsk_adc_isr() for every convertion.
  57          */
  58         #define AFSK_ADC_INIT(ch, ctx) do { (void)ch, (void)ctx; } while (0)
  59
  60         #define AFSK_STROBE_INIT() do { /* Implement me */ } while (0)
  61         #define AFSK_STROBE_ON()   do { /* Implement me */ } while (0)
  62         #define AFSK_STROBE_OFF()  do { /* Implement me */ } while (0)
  63
  64         /**
  65          * Initialize the specified channel of the DAC for AFSK needs.
  66          * The DAC has to be configured in order to call an ISR for every sample sent.
  67          * The DAC doesn't have to start the IRQ immediatly but have to wait
  68          * the AFSK driver to call AFSK_DAC_IRQ_START().
  69          * The ISR must then call afsk_dac_isr() passing the AFSK context.
  70          * \param ch DAC channel to be used for AFSK modulation.
  71          * \param ctx AFSK context (\see Afsk).  This parameter must be saved and
  72          *             passed back to afsk_dac_isr() for every convertion.
  73          */
  74         #define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; } while (0)
  75
  76         /**
  77          * Start DAC convertions on channel \a ch.
  78          * \param ch DAC channel.
  79          */
  80         #define AFSK_DAC_IRQ_START(ch)   do { (void)ch; /* Implement me */ } while (0)
  81
  82         /**
  83          * Stop DAC convertions on channel \a ch.
  84          * \param ch DAC channel.
  85          */
  86         #define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; /* Implement me */ } while (0)
  87
  88         /**
  89          * Set the next DAC value for channel \a ch.
  90          * This macro is called by afsk_dac_isr() to set the next DAC output value.
  91          * \param ch DAC channel.
  92          * \param val Next DAC output value for channel.
  93          */
  94         #define AFSK_DAC_SET(ch, val)    do { (void)ch; (void)val; } while (0)
  95 #else /* (ARCH & ARCH_UNITTEST) */
  96
  97         #include <stdio.h>
  98         #include <cfg/compiler.h>
  99
 100         /* For test */
 101         extern uint32_t data_written;
 102         extern FILE *fp_dac;
 103         extern bool afsk_tx_test;
 104
 105         #define AFSK_ADC_INIT(ch, ctx)    do { (void)ch, (void)ctx; } while (0)
 106
 107         #define AFSK_STROBE_INIT()  /* Implement me */
 108         #define AFSK_STROBE_ON()    /* Implement me */
 109         #define AFSK_STROBE_OFF()   /* Implement me */
 110
 111         #define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; } while (0)
 112         #define AFSK_DAC_IRQ_START(ch)   do { (void)ch; afsk_tx_test = true; } while (0)
 113         #define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; afsk_tx_test = false; } while (0)
 114         #define AFSK_DAC_SET(ch, _val)     \
 115         do { \
 116                 (void)ch; \
 117                 int8_t val = (_val) - 128; \
 118                 ASSERT(fwrite(&val, 1, sizeof(val), fp_dac) == sizeof(val)); \
 119                 data_written++; \
 120         } while (0)
 121
 122 #endif /* !(ARCH & ARCH_UNITTEST) */
 123
 124 #endif /* HW_AFSK_H */