Detailed Description

This module contains drivers for radio devices in Atmel's AT86RF2xx series. The driver is aimed to work with all devices of this series.

Files
file	at86rf2xx_aes.h
	Interface of the at86rf2xx security module (AES)

file	at86rf2xx_internal.h
	Internal interfaces for AT86RF2xx drivers.

file	at86rf2xx_netdev.h
	Netdev interface to AT86RF2xx drivers.

file	at86rf2xx_params.h
	Default configuration for the AT86RF2xx driver.

file	at86rf2xx_registers.h
	Register and command definitions for AT86RF2xx devices.

file	at86rf2xx.h
	Interface definition for AT86RF2xx based drivers.

Data Structures
struct	at86rf2xx_params
	struct holding all params needed for device initialization More...

struct	at86rf2xx_t
	Device descriptor for AT86RF2XX radio devices. More...

Macros
#define	AT86RF2XX_MAX_PKT_LENGTH (IEEE802154_FRAME_LEN_MAX)
	Maximum possible packet size in byte.

#define	AT86RF2XX_DEFAULT_TXPOWER (CONFIG_IEEE802154_DEFAULT_TXPOWER)
	Default TX power (0dBm)

#define	RSSI_BASE_VAL (-91)
	Base (minimal) RSSI value in dBm.

#define	MIN_RX_SENSITIVITY (-101)
	Min Receiver sensitivity value in dBm.

#define	AT86RF2XX_HAVE_RETRIES (1)
	Frame retry counter reporting. More...

#define	AT86RF2XX_RANDOM_NUMBER_GENERATOR (0)
	Random Number Generator. More...

#define	AT86RF2XX_SMART_IDLE_LISTENING (0)
	Smart idle listening feature. More...

#define	AT86RF2XX_PHY_STATE_RX AT86RF2XX_STATE_RX_ON
	Internal radio state equivalent to RX_ON.

#define	AT86RF2XX_PHY_STATE_RX_BUSY AT86RF2XX_STATE_BUSY_RX
	Internal radio state equivalent to RX_BUSY.

#define	AT86RF2XX_PHY_STATE_TX AT86RF2XX_STATE_PLL_ON
	Internal radio state equivalent to TX_ON.

#define	AT86RF2XX_PHY_STATE_TX_BUSY AT86RF2XX_STATE_BUSY_TX
	Internal radio state equivalent to TX_BUSY.

Typedefs
typedef struct at86rf2xx_params	at86rf2xx_params_t
	struct holding all params needed for device initialization

Functions
void	at86rf2xx_setup (at86rf2xx_t dev, const at86rf2xx_params_t params, uint8_t index)
	Setup an AT86RF2xx based device state. More...

void	at86rf2xx_reset (at86rf2xx_t *dev)
	Trigger a hardware reset and configure radio with default values. More...

void	at86rf2xx_get_addr_short (const at86rf2xx_t dev, network_uint16_t addr)
	Get the short address of the given device. More...

void	at86rf2xx_set_addr_short (at86rf2xx_t dev, const network_uint16_t addr)
	Set the short address of the given device. More...

void	at86rf2xx_get_addr_long (const at86rf2xx_t dev, eui64_t addr)
	Get the configured long address of the given device. More...

void	at86rf2xx_set_addr_long (at86rf2xx_t dev, const eui64_t addr)
	Set the long address of the given device. More...

uint8_t	at86rf2xx_get_chan (const at86rf2xx_t *dev)
	Get the configured channel number of the given device. More...

void	at86rf2xx_set_chan (at86rf2xx_t *dev, uint8_t chan)
	Set the channel number of the given device. More...

uint8_t	at86rf2xx_get_page (const at86rf2xx_t *dev)
	Get the configured channel page of the given device. More...

void	at86rf2xx_set_page (at86rf2xx_t *dev, uint8_t page)
	Set the channel page of the given device. More...

uint8_t	at86rf2xx_get_phy_mode (at86rf2xx_t *dev)
	Get the PHY mode of the given device. More...

uint8_t	at86rf2xx_get_rate (at86rf2xx_t *dev)
	Get the current O-QPSK rate mode of the PHY. More...

int	at86rf2xx_set_rate (at86rf2xx_t *dev, uint8_t rate)
	Set the current O-QPSK rate mode of the PHY rate modes > 0 are proprietary. More...

uint16_t	at86rf2xx_get_pan (const at86rf2xx_t *dev)
	Get the configured PAN ID of the given device. More...

void	at86rf2xx_set_pan (at86rf2xx_t *dev, uint16_t pan)
	Set the PAN ID of the given device. More...

int16_t	at86rf2xx_get_txpower (const at86rf2xx_t *dev)
	Get the configured transmission power of the given device [in dBm]. More...

void	at86rf2xx_set_txpower (const at86rf2xx_t *dev, int16_t txpower)
	Set the transmission power of the given device [in dBm]. More...

int8_t	at86rf2xx_get_rxsensitivity (const at86rf2xx_t *dev)
	Get the configured receiver sensitivity of the given device [in dBm]. More...

void	at86rf2xx_set_rxsensitivity (const at86rf2xx_t *dev, int8_t rxsens)
	Set the receiver sensitivity of the given device [in dBm]. More...

uint8_t	at86rf2xx_get_max_retries (const at86rf2xx_t *dev)
	Get the maximum number of retransmissions. More...

void	at86rf2xx_set_max_retries (const at86rf2xx_t *dev, uint8_t max)
	Set the maximum number of retransmissions. More...

uint8_t	at86rf2xx_get_csma_max_retries (const at86rf2xx_t *dev)
	Get the maximum number of channel access attempts per frame (CSMA) More...

void	at86rf2xx_set_csma_max_retries (const at86rf2xx_t *dev, int8_t retries)
	Set the maximum number of channel access attempts per frame (CSMA) More...

void	at86rf2xx_set_csma_backoff_exp (const at86rf2xx_t *dev, uint8_t min, uint8_t max)
	Set the min and max backoff exponent for CSMA/CA. More...

void	at86rf2xx_set_csma_seed (const at86rf2xx_t *dev, const uint8_t entropy[2])
	Set seed for CSMA random backoff. More...

int8_t	at86rf2xx_get_cca_threshold (const at86rf2xx_t *dev)
	Get the CCA threshold value. More...

void	at86rf2xx_set_cca_threshold (const at86rf2xx_t *dev, int8_t value)
	Set the CCA threshold value. More...

int8_t	at86rf2xx_get_ed_level (at86rf2xx_t *dev)
	Get the latest ED level measurement. More...

void	at86rf2xx_set_option (at86rf2xx_t *dev, uint16_t option, bool state)
	Enable or disable driver specific options. More...

uint8_t	at86rf2xx_set_state (at86rf2xx_t *dev, uint8_t state)
	Set the state of the given device (trigger a state change) More...

size_t	at86rf2xx_send (at86rf2xx_t dev, const uint8_t data, size_t len)
	Convenience function for simply sending data. More...

void	at86rf2xx_tx_prepare (at86rf2xx_t *dev)
	Prepare for sending of data. More...

size_t	at86rf2xx_tx_load (at86rf2xx_t dev, const uint8_t data, size_t len, size_t offset)
	Load chunks of data into the transmit buffer of the given device. More...

void	at86rf2xx_tx_exec (at86rf2xx_t *dev)
	Trigger sending of data previously loaded into transmit buffer. More...

bool	at86rf2xx_cca (at86rf2xx_t *dev)
	Perform one manual channel clear assessment (CCA) More...

Channel configuration
#define	AT86RF2XX_MIN_CHANNEL (IEEE802154_CHANNEL_MIN)

#define	AT86RF2XX_MAX_CHANNEL (IEEE802154_CHANNEL_MAX)

#define	AT86RF2XX_DEFAULT_CHANNEL (CONFIG_IEEE802154_DEFAULT_CHANNEL)

Flags for device internal states (see datasheet)
#define	AT86RF2XX_STATE_P_ON (0x00)
	initial power on

#define	AT86RF2XX_STATE_BUSY_RX (0x01)
	busy receiving data (basic mode)

#define	AT86RF2XX_STATE_BUSY_TX (0x02)
	busy transmitting data (basic mode)

#define	AT86RF2XX_STATE_FORCE_TRX_OFF (0x03)
	force transition to idle

#define	AT86RF2XX_STATE_RX_ON (0x06)
	listen mode (basic mode)

#define	AT86RF2XX_STATE_TRX_OFF (0x08)
	idle

#define	AT86RF2XX_STATE_PLL_ON (0x09)
	ready to transmit

#define	AT86RF2XX_STATE_SLEEP (0x0f)
	sleep mode

#define	AT86RF2XX_STATE_BUSY_RX_AACK (0x11)
	busy receiving data (extended mode)

#define	AT86RF2XX_STATE_BUSY_TX_ARET (0x12)
	busy transmitting data (extended mode)

#define	AT86RF2XX_STATE_RX_AACK_ON (0x16)
	wait for incoming data

#define	AT86RF2XX_STATE_TX_ARET_ON (0x19)
	ready for sending data

#define	AT86RF2XX_STATE_IN_PROGRESS (0x1f)
	ongoing state conversion

Internal device option flags
#define	AT86RF2XX_OPT_TELL_TX_START (0x0001)
	notify MAC layer on TX start

#define	AT86RF2XX_OPT_TELL_TX_END (0x0002)
	notify MAC layer on TX finished

#define	AT86RF2XX_OPT_TELL_RX_START (0x0004)
	notify MAC layer on RX start

#define	AT86RF2XX_OPT_TELL_RX_END (0x0008)
	notify MAC layer on RX finished

#define	AT86RF2XX_OPT_CSMA (0x0010)
	CSMA active.

#define	AT86RF2XX_OPT_PROMISCUOUS (0x0020)
	promiscuous mode active

#define	AT86RF2XX_OPT_PRELOADING (0x0040)
	preloading enabled

#define	AT86RF2XX_OPT_AUTOACK (0x0080)
	Auto ACK active.

#define	AT86RF2XX_OPT_ACK_PENDING (0x0100)
	ACK frames with data pending.

Macro Definition Documentation

◆ AT86RF2XX_HAVE_RETRIES

#define AT86RF2XX_HAVE_RETRIES (1)

Frame retry counter reporting.

The AT86RF2XX_HAVE_RETRIES flag enables support for NETOPT_TX_RETRIES NEEDED operation. Required for this functionality is the XAH_CTRL_2 register which contains the frame retry counter. Only the at86rf232 and the at86rf233 support this register.

Definition at line 119 of file at86rf2xx.h.

◆ AT86RF2XX_RANDOM_NUMBER_GENERATOR

#define AT86RF2XX_RANDOM_NUMBER_GENERATOR (0)

Random Number Generator.

Most AT86RF radios have the option to use the highest bits of the RSSI register as a source of randomness. See Section 11.2 of the at86rf233 reference manual. (RND_VALUE)

Definition at line 137 of file at86rf2xx.h.

◆ AT86RF2XX_SMART_IDLE_LISTENING

#define AT86RF2XX_SMART_IDLE_LISTENING (0)

Smart idle listening feature.

This feature optimizes radio operation in the listening mode, reducing current consumption by ~50%. It is supported by only at86rf233. The reference manual recommends to disable this feature for RSSI measurements or random number generation (Section 8.4 and Section 11.2).

Definition at line 154 of file at86rf2xx.h.

Function Documentation

◆ at86rf2xx_cca()

bool at86rf2xx_cca ( at86rf2xx_t * dev )

Perform one manual channel clear assessment (CCA)

The CCA mode and threshold level depends on the current transceiver settings.

Parameters

[in] dev device to use

Returns: true if channel is determined clear; false if channel is determined busy

◆ at86rf2xx_get_addr_long()

void at86rf2xx_get_addr_long	(	const at86rf2xx_t *	dev,
		eui64_t *	addr
	)

Get the configured long address of the given device.

Parameters

[in]	dev	device to read from
[out]	addr	the long address will be stored here

Returns: the currently set (8-byte) long address

◆ at86rf2xx_get_addr_short()

void at86rf2xx_get_addr_short	(	const at86rf2xx_t *	dev,
		network_uint16_t *	addr
	)

Get the short address of the given device.

Parameters

[in]	dev	device to read from
[out]	addr	the short address will be stored here

Returns: the currently set (2-byte) short address

◆ at86rf2xx_get_cca_threshold()

int8_t at86rf2xx_get_cca_threshold ( const at86rf2xx_t * dev )

Get the CCA threshold value.

Parameters

[in] dev device to read value from

Returns: the current CCA threshold value

◆ at86rf2xx_get_chan()

uint8_t at86rf2xx_get_chan ( const at86rf2xx_t * dev )

Get the configured channel number of the given device.

Parameters

[in] dev device to read from

Returns: the currently set channel number

◆ at86rf2xx_get_csma_max_retries()

uint8_t at86rf2xx_get_csma_max_retries ( const at86rf2xx_t * dev )

Get the maximum number of channel access attempts per frame (CSMA)

Parameters

[in] dev device to read from

Returns: configured number of retries

◆ at86rf2xx_get_ed_level()

int8_t at86rf2xx_get_ed_level ( at86rf2xx_t * dev )

Get the latest ED level measurement.

Parameters

[in] dev device to read value from

Returns: the last ED level

◆ at86rf2xx_get_max_retries()

uint8_t at86rf2xx_get_max_retries ( const at86rf2xx_t * dev )

Get the maximum number of retransmissions.

Parameters

[in] dev device to read from

Returns: configured number of retransmissions

◆ at86rf2xx_get_page()

uint8_t at86rf2xx_get_page ( const at86rf2xx_t * dev )

Get the configured channel page of the given device.

Parameters

[in] dev device to read from

Returns: the currently set channel page

◆ at86rf2xx_get_pan()

uint16_t at86rf2xx_get_pan ( const at86rf2xx_t * dev )

Get the configured PAN ID of the given device.

Parameters

[in] dev device to read from

Returns: the currently set PAN ID

◆ at86rf2xx_get_phy_mode()

uint8_t at86rf2xx_get_phy_mode ( at86rf2xx_t * dev )

Get the PHY mode of the given device.

Parameters

[in,out] dev device to read from

Returns: the currently set phy mode

◆ at86rf2xx_get_rate()

uint8_t at86rf2xx_get_rate ( at86rf2xx_t * dev )

Get the current O-QPSK rate mode of the PHY.

Parameters

[in] dev device to read from

Returns: the currently set rate mode

◆ at86rf2xx_get_rxsensitivity()

int8_t at86rf2xx_get_rxsensitivity ( const at86rf2xx_t * dev )

Get the configured receiver sensitivity of the given device [in dBm].

Parameters

[in] dev device to read from

Returns: configured receiver sensitivity in dBm

◆ at86rf2xx_get_txpower()

int16_t at86rf2xx_get_txpower ( const at86rf2xx_t * dev )

Get the configured transmission power of the given device [in dBm].

Parameters

[in] dev device to read from

Returns: configured transmission power in dBm

◆ at86rf2xx_reset()

void at86rf2xx_reset ( at86rf2xx_t * dev )

Trigger a hardware reset and configure radio with default values.

Parameters

[in,out] dev device to reset

◆ at86rf2xx_send()

size_t at86rf2xx_send	(	at86rf2xx_t *	dev,
		const uint8_t *	data,
		size_t	len
	)

Convenience function for simply sending data.

Note: This function ignores the PRELOADING option

Parameters

[in,out]	dev	device to use for sending
[in]	data	data to send (must include IEEE802.15.4 header)
[in]	len	length of `data`

Returns: number of bytes that were actually send; 0 on error

◆ at86rf2xx_set_addr_long()

void at86rf2xx_set_addr_long	(	at86rf2xx_t *	dev,
		const eui64_t *	addr
	)

Set the long address of the given device.

Parameters

[in,out]	dev	device to write to
[in]	addr	(8-byte) long address to set

◆ at86rf2xx_set_addr_short()

void at86rf2xx_set_addr_short	(	at86rf2xx_t *	dev,
		const network_uint16_t *	addr
	)

Set the short address of the given device.

Parameters

[in,out]	dev	device to write to
[in]	addr	(2-byte) short address to set

◆ at86rf2xx_set_cca_threshold()

void at86rf2xx_set_cca_threshold	(	const at86rf2xx_t *	dev,
		int8_t	value
	)

Set the CCA threshold value.

Parameters

[in]	dev	device to write to
[in]	value	the new CCA threshold value

◆ at86rf2xx_set_chan()

void at86rf2xx_set_chan	(	at86rf2xx_t *	dev,
		uint8_t	chan
	)

Set the channel number of the given device.

Parameters

[in,out]	dev	device to write to
[in]	chan	channel number to set

◆ at86rf2xx_set_csma_backoff_exp()

void at86rf2xx_set_csma_backoff_exp	(	const at86rf2xx_t *	dev,
		uint8_t	min,
		uint8_t	max
	)

Set the min and max backoff exponent for CSMA/CA.

Maximum BE: 0 - 8
Minimum BE: 0 - [max]

Parameters

[in]	dev	device to write to
[in]	min	the minimum BE
[in]	max	the maximum BE

◆ at86rf2xx_set_csma_max_retries()

void at86rf2xx_set_csma_max_retries	(	const at86rf2xx_t *	dev,
		int8_t	retries
	)

Set the maximum number of channel access attempts per frame (CSMA)

This setting specifies the number of attempts to access the channel to transmit a frame. If the channel is busy retries times, then frame transmission fails. Valid values: 0 to 5, -1 means CSMA disabled

Parameters

[in]	dev	device to write to
[in]	retries	the maximum number of retries

◆ at86rf2xx_set_csma_seed()

void at86rf2xx_set_csma_seed	(	const at86rf2xx_t *	dev,
		const uint8_t	entropy[2]
	)

Set seed for CSMA random backoff.

Parameters

[in]	dev	device to write to
[in]	entropy	11 bit of entropy as seed for random backoff

◆ at86rf2xx_set_max_retries()

void at86rf2xx_set_max_retries	(	const at86rf2xx_t *	dev,
		uint8_t	max
	)

Set the maximum number of retransmissions.

This setting specifies the number of attempts to retransmit a frame, when it was not acknowledged by the recipient, before the transaction gets cancelled. The maximum value is 7.

Parameters

[in]	dev	device to write to
[in]	max	the maximum number of retransmissions

◆ at86rf2xx_set_option()

void at86rf2xx_set_option	(	at86rf2xx_t *	dev,
		uint16_t	option,
		bool	state
	)

Enable or disable driver specific options.

Parameters

[in,out]	dev	device to set/clear option flag for
[in]	option	option to enable/disable
[in]	state	true for enable, false for disable

◆ at86rf2xx_set_page()

void at86rf2xx_set_page	(	at86rf2xx_t *	dev,
		uint8_t	page
	)

Set the channel page of the given device.

Parameters

[in,out]	dev	device to write to
[in]	page	channel page to set

◆ at86rf2xx_set_pan()

void at86rf2xx_set_pan	(	at86rf2xx_t *	dev,
		uint16_t	pan
	)

Set the PAN ID of the given device.

Parameters

[in,out]	dev	device to write to
[in]	pan	PAN ID to set

◆ at86rf2xx_set_rate()

int at86rf2xx_set_rate	(	at86rf2xx_t *	dev,
		uint8_t	rate
	)

Set the current O-QPSK rate mode of the PHY rate modes > 0 are proprietary.

rate 0: 250 kbit/s (IEEE mode) rate 1: 500 kbit/s rate 2: 1000 kbit/s (compatible with AT86RF215) rate 3: 2000 kbit/s

Parameters

[in]	dev	device to write to
[in]	rate	the selected data rate mode (0-3)

Returns: 0 on success, otherwise error value

◆ at86rf2xx_set_rxsensitivity()

void at86rf2xx_set_rxsensitivity	(	const at86rf2xx_t *	dev,
		int8_t	rxsens
	)

Set the receiver sensitivity of the given device [in dBm].

If the device does not support the exact dBm value given, it will set a value as close as possible to the given value. If the given value is larger or lower then the maximal or minimal possible value, the min or max value is set, respectively.

Parameters

[in]	dev	device to write to
[in]	rxsens	rx sensitivity in dBm

◆ at86rf2xx_set_state()

uint8_t at86rf2xx_set_state	(	at86rf2xx_t *	dev,
		uint8_t	state
	)

Set the state of the given device (trigger a state change)

Parameters

[in,out]	dev	device to change state of
[in]	state	the targeted new state

Returns: the previous state before the new state was set

◆ at86rf2xx_set_txpower()

void at86rf2xx_set_txpower	(	const at86rf2xx_t *	dev,
		int16_t	txpower
	)

Set the transmission power of the given device [in dBm].

If the device does not support the exact dBm value given, it will set a value as close as possible to the given value. If the given value is larger or lower then the maximal or minimal possible value, the min or max value is set, respectively.

Parameters

[in]	dev	device to write to
[in]	txpower	transmission power in dBm

◆ at86rf2xx_setup()

void at86rf2xx_setup	(	at86rf2xx_t *	dev,
		const at86rf2xx_params_t *	params,
		uint8_t	index
	)

Setup an AT86RF2xx based device state.

Parameters

[out]	dev	device descriptor
[in]	params	parameters for device initialization
[in]	index	index of `params` in a global parameter struct array. If initialized manually, pass a unique identifier instead.

◆ at86rf2xx_tx_exec()

void at86rf2xx_tx_exec ( at86rf2xx_t * dev )

Trigger sending of data previously loaded into transmit buffer.

Parameters

[in] dev device to trigger

◆ at86rf2xx_tx_load()

size_t at86rf2xx_tx_load	(	at86rf2xx_t *	dev,
		const uint8_t *	data,
		size_t	len,
		size_t	offset
	)

Load chunks of data into the transmit buffer of the given device.

Parameters

[in,out]	dev	device to write data to
[in]	data	buffer containing the data to load
[in]	len	number of bytes in `buffer`
[in]	offset	offset used when writing data to internal buffer

Returns: offset + number of bytes written

◆ at86rf2xx_tx_prepare()

void at86rf2xx_tx_prepare ( at86rf2xx_t * dev )

Prepare for sending of data.

This function puts the given device into the TX state, so no receiving of data is possible after it was called.

Parameters

[in,out] dev device to prepare for sending

Detailed Description

Files

Data Structures

Macros

Typedefs

Functions

Channel configuration

Flags for device internal states (see datasheet)

Internal device option flags

Macro Definition Documentation

◆ AT86RF2XX_HAVE_RETRIES

◆ AT86RF2XX_RANDOM_NUMBER_GENERATOR

◆ AT86RF2XX_SMART_IDLE_LISTENING

Function Documentation

◆ at86rf2xx_cca()

◆ at86rf2xx_get_addr_long()

◆ at86rf2xx_get_addr_short()

◆ at86rf2xx_get_cca_threshold()

◆ at86rf2xx_get_chan()

◆ at86rf2xx_get_csma_max_retries()

◆ at86rf2xx_get_ed_level()

◆ at86rf2xx_get_max_retries()

◆ at86rf2xx_get_page()

◆ at86rf2xx_get_pan()

◆ at86rf2xx_get_phy_mode()

◆ at86rf2xx_get_rate()

◆ at86rf2xx_get_rxsensitivity()

◆ at86rf2xx_get_txpower()

◆ at86rf2xx_reset()

◆ at86rf2xx_send()

◆ at86rf2xx_set_addr_long()

◆ at86rf2xx_set_addr_short()

◆ at86rf2xx_set_cca_threshold()

◆ at86rf2xx_set_chan()

◆ at86rf2xx_set_csma_backoff_exp()

◆ at86rf2xx_set_csma_max_retries()

◆ at86rf2xx_set_csma_seed()

◆ at86rf2xx_set_max_retries()

◆ at86rf2xx_set_option()

◆ at86rf2xx_set_page()

◆ at86rf2xx_set_pan()

◆ at86rf2xx_set_rate()

◆ at86rf2xx_set_rxsensitivity()

◆ at86rf2xx_set_state()

◆ at86rf2xx_set_txpower()

◆ at86rf2xx_setup()

◆ at86rf2xx_tx_exec()

◆ at86rf2xx_tx_load()

◆ at86rf2xx_tx_prepare()