board_dummy.h

Go to the documentation of this file.

/* Copyright (c) 2007 Axel Wachtler
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
   * Neither the name of the authors nor the names of its contributors
     may be used to endorse or promote products derived from this software
     without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   POSSIBILITY OF SUCH DAMAGE. */

/* $Id: board__dummy_8h_source.html,v 1.1.1.4 2013/04/09 21:11:56 awachtler Exp $ */
/*%*
 *
 * @defgroup grp<brD> ....
 * @brief .....
 *
 * 
 *
 * The wiring of the radio and the AT.... is shown below:
*
<pre>
     AVR      RF230
     ---      -----
     Pxx  -->  SLPTR
     Pxx  <--  MCLK
     Pxx  <--  IRQ (INT2)
     Pxx  -->  RSTN
     Pxx  -->  SS
     Pxx  -->  MOSI
     Pxx  <--  MISO
     Pxx  -->  SCK

     <other peripherals>
</pre>
 */
/*%*
 * @addtogroup grpBoard
 * @{
 */

#define BOARD_NAME_<brd> "<brd>"

#ifndef BOARD_DUMMY_H
#define BOARD_DUMMY_H

#define BOARD_TYPE (<brd>)              
#define BOARD_NAME BOARD_NAME_<brd>     
/*=== Compile time parameters ========================================*/
#ifndef MAX_FRAME_SIZE
# define MAX_FRAME_SIZE (127) 
#endif

#ifndef DEFAULT_SPI_RATE
# define DEFAULT_SPI_RATE  (SPI_RATE_1_2)
#endif

/*=== Hardware Components ============================================*/
#ifndef RADIO_TYPE
#define RADIO_TYPE (RADIO_AT86RF230)    
#endif

/*=== TRX pin access macros ==========================================*/

#define DDR_TRX_RESET   DDR...          
#define PORT_TRX_RESET  PORT...         
#define MASK_TRX_RESET  (_BV(...))      
/* check in board.h if standard definitions of TRX_RESET_INIT,
   TRX_RESET_HIGH, TRX_RESET_LOW are Ok, otherwise define here */

#define PORT_TRX_SLPTR  PORT...         
#define DDR_TRX_SLPTR   DDR...          
#define MASK_TRX_SLPTR  (_BV(PB...))    
/* check in board.h if standard definitions of TRX_SLPTR_INIT,
   TRX_SLPTR_HIGH, TRX_SLPTR_LOW are Ok, otherwise define here */

/*=== IRQ access macros ==============================================*/
# define TRX_IRQ         _BV(INT...)    
# define TRX_IRQ_vect    INT..._vect    
# define TRX_IRQ_INIT()  do{\
                            MCUCSR  |= _BV(ISC...);\
                          } while(0) 
#define DI_TRX_IRQ() {GICR... &= (~(TRX_IRQ));}

#define EI_TRX_IRQ() {GICR... |= (TRX_IRQ);}

#define TRX_TSTAMP_REG ...

/*=== SPI access macros ==============================================*/
#define SPI_TYPE  SPI_TYPE_SPI
#define DDR_SPI  (DDR...)   
#define PORT_SPI (PORT...)  
#define SPI_MOSI _BV(P...)  
#define SPI_MISO _BV(P...)  
#define SPI_SCK  _BV(P...)  
#define SPI_SS   _BV(P...)  
#define SPI_DATA_REG SPDR...    
static inline void SPI_INIT(uint8_t spirate)
{
    /* first configure SPI Port, then SPCR */
    DDR_SPI  |= SPI_MOSI | SPI_SCK | SPI_SS;
    DDR_SPI  &= ~SPI_MISO;
    PORT_SPI |= SPI_SCK | SPI_SS;

    SPCR = (_BV(SPE) | _BV(MSTR));

    SPCR &= ~(_BV(SPR1) | _BV(SPR0) );
    SPSR &= ~_BV(SPI2X);

    SPCR |= (spirate & 0x03);
    SPSR |= ((spirate >> 2) & 0x01);

}

#define SPI_SELN_LOW()       uint8_t sreg = SREG; cli(); PORT_SPI &=~SPI_SS

#define SPI_SELN_HIGH()      PORT_SPI |= SPI_SS; SREG = sreg

#define SPI_WAITFOR()        do { while((SPSR & _BV(SPIF)) == 0);} while(0)

/*=== LED access macros ==============================================*/
#define NO_LEDS       (1)        
#define LED_PORT      PORT.      
#define LED_DDR       DDR.       
#define LED_MASK      (0x..)     
#define LED_SHIFT     (.)        
#define LEDS_INVERSE  (.)        
#define LED_NUMBER    (.)        
/*=== KEY access macros ==============================================*/
#define NO_KEYS       (1)        
#define PORT_KEY      PORT.      
#define PIN_KEY       PIN.       
#define DDR_KEY       DDR.       
#define MASK_KEY      (0x..)     
#define SHIFT_KEY     (.)        
#define INVERSE_KEYS  (.)        
#define PULLUP_KEYS   (.)        
/*=== Host Interface ================================================*/

#define HIF_TYPE    HIF_.

/*=== TIMER Interface ===============================================*/
#define NO_TIMER (1)

#define HWTMR_PRESCALE  (1) 
#define HWTIMER_TICK    ((1.0*HWTMR_PRESCALE)/F_CPU) 
#define HWTIMER_TICK_NB (0xFFFFUL) 
#define HWTIMER_REG (TCNT1) 
#define TIMER_TICK (HWTIMER_TICK * HWTIMER_TICK_NB)

#define TIMER_POOL_SIZE (0) 
#define TIMER_INIT() do{}while(0) 
#define TIMER_IRQ_vect   ...


/*=== OSCCAL tuning =================================================*/
#ifndef TUNED_OSCCAL
# define TUNED_OSCCAL (0xbf)  /* default is 0xb1, but @2.9V 0xbf is better */
#endif
#endif