radio.h

Go to the documentation of this file.

/* Copyright (c) 2007-2009 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: radio_8h_source.html,v 1.1.1.4 2013/04/09 21:11:37 awachtler Exp $ */
#ifndef RADIO_H
#define RADIO_H

/* === Includes ============================================================== */
#include <stdbool.h>
#include <stdio.h>
#include <util/crc16.h>
#include "const.h"

/* === Externals ============================================================= */

/* === Types ================================================================= */

#define  STATE_OFF (0)

#define  STATE_TX (1)

#define STATE_RX (2)

#define STATE_TXAUTO (3)

#define STATE_RXAUTO (4)

#define STATE_SLEEP (5)


typedef uint8_t radio_state_t;

typedef enum
{
    TX_OK,          
    TX_CCA_FAIL,        
    TX_NO_ACK,          
    TX_FAIL,            
} radio_tx_done_t;


typedef enum SHORTENUM
{
#if defined(CCA_BUSY)

    RADIO_CCA_FREE = CCA_IDLE,
    RADIO_CCA_BUSY = CCA_BUSY,
    RADIO_CCA_FAIL = 255,
#else

    RADIO_CCA_FREE = 0,
    RADIO_CCA_BUSY,
    RADIO_CCA_FAIL
#endif

} radio_cca_t;


typedef enum SHORTENUM
{
    phyCurrentChannel,
    phyChannelsSupported,
    phyTransmitPower,
    phyIdleState,
    phyCCAMode,
    phyPanId,
    phyShortAddr,
    phyLongAddr,

    phyDataRate,

} radio_attribute_t;


typedef union radio_param_t
{
#if defined __cplusplus
public:
    radio_param_t(int8_t c) { channel = c; } /* also used for txpwr_t */
    //radio_param_t(radio_state_t s) { idle_state = s; }
    radio_param_t(uint8_t m) { cca_mode = m; } /* use used for data_rate */
    radio_param_t(uint16_t p) { pan_id = p; } /* also used for short_addr */
    radio_param_t(uint64_t *la) { long_addr = la; }
#endif

    channel_t channel;
    txpwr_t   tx_pwr;
    radio_state_t idle_state;
    ccamode_t cca_mode;
    uint16_t pan_id;
    uint16_t short_addr;
    uint64_t *long_addr;
    uint8_t data_rate;

} radio_param_t;


typedef enum SHORTENUM
{
    #ifndef SUCCESS

    SUCCESS = 0,        
    #endif
    STATE_SET_FAILED = 1,   
    SET_PARM_FAILED,    
    GET_PARM_FAILED,    
    GENERAL_ERROR,      
} radio_error_t;


typedef struct
{
    uint8_t  channel;      
    uint8_t  tx_pwr;       
    uint8_t  cca_mode;     
    radio_state_t state;      
    radio_state_t idle_state; 
    uint8_t  *rxframe;      
    uint8_t  rxframesz;     
} radio_status_t;

/* === Macros ================================================================ */

#define VOID_RSSI (0xff)

#if defined(DOXYGEN)

#  define RP_CHANNEL(x)
#elif defined __cplusplus
#  define RP_CHANNEL(x) phyCurrentChannel,radio_param_t((channel_t)x)
#else
#  define RP_CHANNEL(x) phyCurrentChannel,(radio_param_t){.channel=x}
#endif

#if defined(DOXYGEN)

#  define RP_TXPWR(x)
#elif defined __cplusplus
#  define RP_TXPWR(x)   phyTransmitPower,radio_param_t((txpwr_t)x)
#else
#  define RP_TXPWR(x)   phyTransmitPower,(radio_param_t){.tx_pwr=x}
#endif

#if defined(DOXYGEN)

#  define RP_IDLESTATE(x)
#elif defined __cplusplus
#  define RP_IDLESTATE(x)  phyIdleState,radio_param_t(x)
#else
#  define RP_IDLESTATE(x)  phyIdleState,(radio_param_t){.idle_state=x}
#endif

#if defined(DOXYGEN)

#  define RP_CCAMODE(x)
#elif defined __cplusplus
#  define RP_CCAMODE(x)  phyCCAMode,radio_param_t((ccamode_t)x)
#else
#  define RP_CCAMODE(x) phyCCAMode,(radio_param_t){.cca_mode=x}
#endif

#if defined(DOXYGEN)

#  define RP_PANID(x)
#elif defined __cplusplus
#  define RP_PANID(x) phyPanId,radio_param_t((uint16_t)x)
#else
#  define RP_PANID(x) phyPanId,(radio_param_t){.pan_id=x}
#endif

#if defined(DOXYGEN)

#  define RP_SHORTADDR(x)
#elif defined __cplusplus
#  define RP_SHORTADDR(x) phyShortAddr,radio_param_t((uint16_t)x)
#else
#  define RP_SHORTADDR(x) phyShortAddr,(radio_param_t){.short_addr=x}
#endif

#if defined(DOXYGEN)

#  define RP_LONGADDR(x)
#elif defined __cplusplus
#  define RP_LONGADDR(x) phyLongAddr,radio_param_t((uint64_t *)x)
#else
#  define RP_LONGADDR(x) phyLongAddr,(radio_param_t){.long_addr=x}
#endif


#if defined(DOXYGEN)

#  define RP_DATARATE(x)
#elif defined __cplusplus
#  define RP_DATARATE(x) phyDataRate,radio_param_t((uint16_t)x)
#else
#  define RP_DATARATE(x) phyDataRate,(radio_param_t){.data_rate=x}
#endif


#define CRC_CCITT_UPDATE(crc, data) _crc_ccitt_update(crc, data)

#ifndef RADIO_CFG_EEOFFSET

#define RADIO_CFG_EEOFFSET (8)
#endif

#ifndef RADIO_CFG_DATA

#define RADIO_CFG_DATA {chan: 16, txp: 0, cca: 1, edt: 11, clkm: 0, crc: 0xab12}
#endif

/* === Prototypes ============================================================ */
#ifdef __cplusplus
extern "C" {
#endif


void radio_init(uint8_t * rxbuf, uint8_t rxbufsz);


void radio_force_state(radio_state_t state);


void radio_set_state(radio_state_t state);

void radio_set_param(radio_attribute_t attr, radio_param_t parm);

void radio_send_frame(uint8_t len, uint8_t *frm, uint8_t compcrc);


radio_cca_t radio_do_cca(void);



int radio_putchar(int c);
int radio_getchar(void);



/* application call back functions to radio library */


void usr_radio_error(radio_error_t err);

void usr_radio_irq(uint8_t cause);

uint8_t * usr_radio_receive_frame(uint8_t len, uint8_t *frm, uint8_t lqi, int8_t ed, uint8_t crc_fail);


void usr_radio_tx_done(radio_tx_done_t status);


#ifdef __cplusplus
} /* extern "C" */
#endif


#endif  /* #ifndef RADIO_H */
/* EOF */