boards/arduino/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 #include <avr/io.h>
  46
  47 struct Afsk;
  48 void hw_afsk_adcInit(int ch, struct Afsk *_ctx);
  49 void hw_afsk_dacInit(int ch, struct Afsk *_ctx);
  50
  51 /**
  52  * Initialize the specified channel of the ADC for AFSK needs.
  53  * The adc should be configured to have a continuos stream of convertions.
  54  * For every convertion there must be an ISR that read the sample
  55  * and call afsk_adc_isr(), passing the context and the sample.
  56  *
  57  * \param ch channel to be used for AFSK demodulation.
  58  * \param ctx AFSK context (\see Afsk). This parameter must be saved and
  59  *            passed back to afsk_adc_isr() for every convertion.
  60  */
  61
  62 /*
  63  * This macro will be called for AFSK initialization. We could implement everything here as a macro,
  64  * but since initialization is rather complicated we decided to split its own function. Such function
  65  * is defined in hw_afsk.c.
  66  * Remember: since this .c file is not created by the wizard, you must add it to your_project_name.mk.
  67  * If you create the file using BeRTOS SDK, it will be added for you.
  68  */
  69 #define AFSK_ADC_INIT(ch, ctx) hw_afsk_adcInit(ch, ctx)
  70
  71 /*
  72  * Activate strobe pin. We use it for debugging purposes. If you don't use it, simply
  73  * leave empty the following macros
  74  */
  75 #define AFSK_STROBE_INIT() do { DDRB |= BV(5); } while (0)
  76
  77 /*
  78  * Set the pin high. This macro is called at the beginning of the interrupt routine
  79  */
  80 #define AFSK_STROBE_ON()   do { PORTB |= BV(5); } while (0)
  81
  82 /*
  83  * Set the pin low. This macro is called at the end of the interrupt routine
  84  */
  85 #define AFSK_STROBE_OFF()  do { PORTB &= ~BV(5); } while (0)
  86
  87 /**
  88  * Initialize the specified channel of the DAC for AFSK needs.
  89  * The DAC has to be configured in order to call an ISR for every sample sent.
  90  * The DAC doesn't have to start the IRQ immediatly but have to wait
  91  * the AFSK driver to call AFSK_DAC_IRQ_START().
  92  * The ISR must then call afsk_dac_isr() passing the AFSK context.
  93  * \param ch DAC channel to be used for AFSK modulation.
  94  * \param ctx AFSK context (\see Afsk).  This parameter must be saved and
  95  *             passed back to afsk_dac_isr() for every convertion.
  96  */
  97 #define AFSK_DAC_INIT(ch, ctx)   do { (void)ch, (void)ctx; DDRD |= 0xF0; DDRB |= BV(3); } while (0)
  98
  99 /**
 100  * Start DAC convertions on channel \a ch.
 101  * \param ch DAC channel.
 102  */
 103 #define AFSK_DAC_IRQ_START(ch)   do { (void)ch; extern bool hw_afsk_dac_isr; PORTB |= BV(3); hw_afsk_dac_isr = true; } while (0)
 104
 105 /**
 106  * Stop DAC convertions on channel \a ch.
 107  * \param ch DAC channel.
 108  */
 109 #define AFSK_DAC_IRQ_STOP(ch)    do { (void)ch; extern bool hw_afsk_dac_isr; PORTB &= ~BV(3); hw_afsk_dac_isr = false; } while (0)
 110
 111 #endif /* HW_AFSK_H */