Data Structures | Defines | Typedefs | Enumerations | Functions

# Radio Access Functions
[Radio Library]

The high level interface to the radio chip.
More...

## Data Structures
union | radio_param_t
| Container for handover of radio parameter values. More...
struct | radio_status_t
| Structure for storage of radio parameters. More...
## Defines
#define | CRC_CCITT_UPDATE(crc, data) _crc_ccitt_update(crc, data)
#define | MOD_BPSK_20 (0)
#define | MOD_BPSK_40 (1)
#define | MOD_OQPSK_100 (2)
#define | MOD_OQPSK_1000 (7)
#define | MOD_OQPSK_200 (3)
#define | MOD_OQPSK_2000 (8)
#define | MOD_OQPSK_250 (4)
#define | MOD_OQPSK_400 (5)
#define | MOD_OQPSK_500 (6)
#define | RADIO_AT86RF212 (4)
#define | RADIO_AT86RF230 (1)
#define | RADIO_AT86RF230A (RADIO_AT86RF230)
#define | RADIO_AT86RF230B (2)
#define | RADIO_AT86RF231 (3)
#define | RADIO_AT86RF232 (9)
#define | RADIO_ATMEGA128RFA1_A (5)
#define | RADIO_ATMEGA128RFA1_B (6)
#define | RADIO_ATMEGA128RFA1_C (7)
#define | RADIO_ATMEGA128RFA1_D (8)
#define | RADIO_BAND_2400 (4)
#define | RADIO_BAND_700 (1)
#define | RADIO_BAND_800 (2)
#define | RADIO_BAND_900 (3)
#define | RADIO_CFG_DATA {chan: 16, txp: 0, cca: 1, edt: 11, clkm: 0, crc: 0xab12}
#define | RADIO_CFG_EEOFFSET (8)
#define | RP_CCAMODE(x)
#define | RP_CHANNEL(x)
#define | RP_DATARATE(x)
#define | RP_IDLESTATE(x)
#define | RP_LONGADDR(x)
#define | RP_PANID(x)
#define | RP_SHORTADDR(x)
#define | RP_TXPWR(x)
#define | STATE_OFF (0)
#define | STATE_RX (2)
#define | STATE_RXAUTO (4)
#define | STATE_SLEEP (5)
#define | STATE_TX (1)
#define | STATE_TXAUTO (3)
#define | VOID_RSSI (0xff)
## Typedefs
typedef uint8_t | radio_state_t
## Enumerations
enum | radio_attribute_t { phyCurrentChannel, phyChannelsSupported, phyTransmitPower, phyIdleState, phyCCAMode, phyPanId, phyShortAddr, phyLongAddr, phyDataRate }
enum | radio_cca_t { RADIO_CCA_FREE = 0, RADIO_CCA_BUSY, RADIO_CCA_FAIL }
enum | radio_error_t { SUCCESS = 0, STATE_SET_FAILED = 1, SET_PARM_FAILED, GET_PARM_FAILED, GENERAL_ERROR }
| Error codes. More...
enum | radio_tx_done_t { TX_OK, TX_CCA_FAIL, TX_NO_ACK, TX_FAIL }
## Functions
radio_cca_t | radio_do_cca (void)
| Perform CCA Measure.
void | radio_force_state (radio_state_t state)
| Force the radio to the requested state. (using CMD_FORCE_TRX_OFF).
int | radio_getchar (void)
void | radio_init (uint8_t *rxbuf, uint8_t rxbufsz)
| Radio related ressource initialization.
int | radio_putchar (int c)
void | radio_send_frame (uint8_t len, uint8_t *frm, uint8_t compcrc)
| Frame transmission.
void | radio_set_param (radio_attribute_t attr, radio_param_t parm)
| Set a radio parameter.
void | radio_set_state (radio_state_t state)
| Bring the the radio in the requested state.
void | usr_radio_error (radio_error_t err)
| Callback for errors in radio module functions.
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)
| Frame reception callback function.
void | usr_radio_tx_done (radio_tx_done_t status)
| Callback function for TX_END IRQ.

## Detailed Description

The high level interface to the radio chip.

This group of functions combines various register accesses (see Transceiver Access Functions) to higher primitives.

Various examples on how to use this module can be found here.

## Define Documentation

#define MOD_BPSK_20 (0)

PHY modulation BPSK, 20 kbit/s

#define MOD_BPSK_40 (1)

PHY modulation BPSK, 40 kbit/s

#define MOD_OQPSK_100 (2)

PHY modulation O-QPSK, 100 kbit/s

#define MOD_OQPSK_1000 (7)

PHY modulation O-QPSK, 1000 kbit/s

#define MOD_OQPSK_200 (3)

PHY modulation O-QPSK, 200 kbit/s

#define MOD_OQPSK_2000 (8)

PHY modulation O-QPSK, 2000 kbit/s

#define MOD_OQPSK_250 (4)

PHY modulation O-QPSK, 250 kbit/s

#define MOD_OQPSK_400 (5)

PHY modulation O-QPSK, 400 kbit/s

#define MOD_OQPSK_500 (6)

PHY modulation O-QPSK, 500 kbit/s

#define RADIO_AT86RF212 (4)

Identifier for radio AT86RF212

#define RADIO_AT86RF230 (1)

Identifier for radio AT86RF230

#define RADIO_AT86RF230A (RADIO_AT86RF230)

Identifier for radio AT86RF230 Rev A

#define RADIO_AT86RF230B (2)

Identifier for radio AT86RF230 Rev B

#define RADIO_AT86RF231 (3)

Identifier for radio AT86RF231

#define RADIO_AT86RF232 (9)

Identifier for radio AT86RF232

#define RADIO_ATMEGA128RFA1_A (5)

Identifier for radio ATmega128RFA1 Rev. A

#define RADIO_ATMEGA128RFA1_B (6)

Identifier for radio ATmega128RFA1 Rev. B

#define RADIO_ATMEGA128RFA1_C (7)

Identifier for radio ATmega128RFA1 Rev. C

#define RADIO_ATMEGA128RFA1_D (8)

Identifier for radio ATmega128RFA1 Rev. D

#define RADIO_BAND_2400 (4)

2.4GHz frequency band (international)

#define RADIO_BAND_700 (1)

700MHz frequency band (china)

#define RADIO_BAND_800 (2)

868MHz frequency band (europe)

#define RADIO_BAND_900 (3)

900MHz frequency band (north america)

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

a default radio configuration data structure

#define RADIO_CFG_EEOFFSET (8)

offset of radio config data in EEPROM

#define RP_CCAMODE | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the CCA mode to `x`.

#define RP_CHANNEL | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the channel number to `x`.

#define RP_DATARATE | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the data rate to `x`.

#define RP_IDLESTATE | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the transceiver's idle state to `x`.

#define RP_LONGADDR | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the long address pointer to `x`.

#define RP_PANID | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the PAN ID to `x`.

#define RP_SHORTADDR | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the short address to `x`.

#define RP_TXPWR | ( |  | x | ) |

Helper macro to construct the arguments for radio_set_param in order to set the tx power value to `x`.

#define STATE_OFF (0)

Radio state enumeration TRX in OFF state.

#define STATE_RX (2)

Basic mode RX state.

#define STATE_RXAUTO (4)

Extended mode RX state (RX_AACK).

#define STATE_SLEEP (5)

Sleep state (lowest power consumption).

#define STATE_TX (1)

Basic mode TX state.

#define STATE_TXAUTO (3)

Extended mode TX state (TX_ARET).

#define VOID_RSSI (0xff)

Code for invalid RSSI value.

## Typedef Documentation

typedef uint8_t radio_state_t

Radio state type

## Enumeration Type Documentation

enum radio_attribute_t

Enumeration to identify radio attributes.

Enumerator:

  phyCurrentChannel | Set the current channel
  phyChannelsSupported | Currently unused
  phyTransmitPower | Set the Tx power
  phyIdleState | Transceiver state to return to after transmission
  phyCCAMode | CCA mode to use in CSMA-CA:
  value | CCA mode
  --- | ---
  0 | carrier sense OR energy above threshold
  1 | energy above threshold (default)
  2 | carrier sense
  3 | carrier sense AND energy above threshold
  phyPanId | PAN ID to use in STATE_RXAUTO frame filter
  phyShortAddr | Short (16-bit) address to use in STATE_RXAUTO frame filter
  phyLongAddr | Pointer to long (EUI-64) address to use in STATE_RXAUTO frame filter
  phyDataRate | Datarate

enum radio_cca_t

codes for CCA

Enumerator:

  RADIO_CCA_FREE | The CCA measurement estimates, that the channel is free.
  RADIO_CCA_BUSY | The CCA measurement estimates, that the channel is busy.
  RADIO_CCA_FAIL | The CCA measurement was not finished.

enum radio_error_t

Error codes.

Enumerator:

  SUCCESS | OK Code
  STATE_SET_FAILED | function radio_set_state failed
  SET_PARM_FAILED | function radio_set_param failed
  GET_PARM_FAILED | function radio_get_param failed
  GENERAL_ERROR | something unexpected happened

enum radio_tx_done_t

error codes for tx done event

Enumerator:

  TX_OK | transmission completed successfully
  TX_CCA_FAIL | channel was busy (TX_AUTO only)
  TX_NO_ACK | no ACK received (TX_AUTO only)
  TX_FAIL | unexpected error

## Function Documentation

radio_cca_t radio_do_cca | ( | void |  | ) |

Perform CCA Measure.

Returns:
  cca status (see radio_cca_t)

void radio_force_state | ( | radio_state_t | state | ) |

Force the radio to the requested state. (using CMD_FORCE_TRX_OFF).

Parameters:

  | state | requested radio state

void radio_init | ( | uint8_t * | rxbuf,
|  | uint8_t | rxbufsz |
| ) |  |  |

Radio related ressource initialization.

The function initializes all IO ressources, needed for the usage of the radio and performs a reset.

Parameters:

  | rxbuf | A buffer for the receive frames. This buffer needs to be static, and of size MAX_FRAME_SIZE (see also function usr_radio_receive_frame).
  | rxbufsz | maximum size of the rx buffer, frames longer then rxbufsz will be ignored

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

Frame transmission.

Initiates a frame transmission procedure, and then downloads the frame passed as `frm`. The function returns immediately once the frame download procedure completed; the end of transmission is signalled by the usr_radio_tx_done callback. If the radio is in STATE_TXAUTO, a full unslotted CSMA-CA is procedure is performed by the transceiver hardware, including frame retransmissions in case the transmitted frame has requested an acknowledgement by the recipient. If the transceiver is in STATE_TX, an immediate frame transmission is initiated, without CSMA-CA or frame retransmissions.

Parameters:

  | len | length of frame to transmit
  | frm | pointer to frame to transmit
  | compcrc | compute CRC-16 if != 0 (currently ignored)

void radio_set_param | ( | radio_attribute_t | attr,
|  | radio_param_t | parm |
| ) |  |  |

Set a radio parameter.

Note that the radio must not be in STATE_SLEEP when setting parameters. Preferrably, it should be kept in STATE_OFF (in which it is immediately after a call to radio_init) in order to set parameters.

Parameters:

  | attr | attribute parameter (enumeration value radio_attribute_t)
  | parm | pointer to parameter value (union type radio_param_t)

Examples:

       radio_set_param(RP_IDLESTATE(STATE_RX));

       #define CHANNEL (17)

       radio_set_param(RP_CHANNEL(CHANNEL));

void radio_set_state | ( | radio_state_t | state | ) |

Bring the the radio in the requested state.

Parameters:

  | state | requested radio state

void usr_radio_error | ( | radio_error_t | err | ) |

Callback for errors in radio module functions.

Error callback function which has to be implemented in the application.

This function is called, when a fatal error occurs. see also radio_error_t.

Parameters:

  | err | error code being reported

void usr_radio_irq | ( | uint8_t | cause | ) |

Interrupt callback function.

Parameters:

  | cause | value of the transceiver's IRQ status register

uint8_t* usr_radio_receive_frame | ( | uint8_t | len,
|  | uint8_t * | frm,
|  | uint8_t | lqi,
|  | int8_t | ed,
|  | uint8_t | crc |
| ) |  |  |

Frame reception callback function.

This function is called within an interrupt context for every received frame, according to the current receive mode used (which involves address filtering in case the transceiver is in state RX_AUTO). The frame has been internally stored into the receive buffer that has been configured before, either by radio_init, or as the result of a previous call to usr_radio_receive_frame. The function must return a valid pointer to a receive buffer to be used for receiving the next frame; this can be the same value as the parameter `frm`, or a different one in case the application wants to maintain multiple buffers.

The `rssi` parameter is obtained at the frame's RX_START interrupt. If there was no RX_START interrupt to read an RSSI value at, the value VOID_RSSI is passed instead.

Parameters:

  | len | length of frame received
  | frm | pointer to frame received
  | lqi | LQI value reported by transceiver
  | rssi | RSSI value obtained from transceiver
  | crc_fail | boolean indicating whether the received frame failed FCS verification

Returns:
  address of new receive buffer

void usr_radio_tx_done | ( | radio_tx_done_t | status | ) |

Callback function for TX_END IRQ.

Transmit done callback function.

Parameters:

  | status | completion status, radio_tx_done_t