at86rf2xx.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Freie Universit├Ąt Berlin
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser General
5  * Public License v2.1. See the file LICENSE in the top level directory for more
6  * details.
7  */
8 
29 #ifndef AT86RF2XX_H
30 #define AT86RF2XX_H
31 
32 #include <stdint.h>
33 #include <stdbool.h>
34 
35 #include "board.h"
36 #include "kernel_defines.h"
37 #include "net/netdev.h"
38 #include "net/netdev/ieee802154.h"
39 #include "net/gnrc/nettype.h"
40 
41 /* we need no peripherals for memory mapped radios */
42 #if !defined(MODULE_AT86RFA1) && !defined(MODULE_AT86RFR2)
43 #include "periph/spi.h"
44 #include "periph/gpio.h"
45 #endif
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
54 #define AT86RF2XX_MAX_PKT_LENGTH (IEEE802154_FRAME_LEN_MAX)
55 
60 #ifdef MODULE_AT86RF212B
61 /* the AT86RF212B has a sub-1GHz radio */
62 #define AT86RF2XX_MIN_CHANNEL (IEEE802154_CHANNEL_MIN_SUBGHZ)
63 #define AT86RF2XX_MAX_CHANNEL (IEEE802154_CHANNEL_MAX_SUBGHZ)
64 #define AT86RF2XX_DEFAULT_CHANNEL (CONFIG_IEEE802154_DEFAULT_SUBGHZ_CHANNEL)
65 /* Page 2 is O-QPSK 100 kbit/s (channel 0), or 250 kbit/s (channels 1-10) */
66 #define AT86RF2XX_DEFAULT_PAGE (CONFIG_IEEE802154_DEFAULT_SUBGHZ_PAGE)
67 #else
68 #define AT86RF2XX_MIN_CHANNEL (IEEE802154_CHANNEL_MIN)
69 #define AT86RF2XX_MAX_CHANNEL (IEEE802154_CHANNEL_MAX)
70 #define AT86RF2XX_DEFAULT_CHANNEL (CONFIG_IEEE802154_DEFAULT_CHANNEL)
71 /* Only page 0 is supported in the 2.4 GHz band */
72 #endif
78 #define AT86RF2XX_DEFAULT_TXPOWER (CONFIG_IEEE802154_DEFAULT_TXPOWER)
79 
83 #if MODULE_AT86RF233
84 # define RSSI_BASE_VAL (-94)
85 #elif MODULE_AT86RF212B
90 # define RSSI_BASE_VAL (-98)
91 #elif MODULE_AT86RFA1 || MODULE_AT86RFR2
92 # define RSSI_BASE_VAL (-90)
93 #else
94 # define RSSI_BASE_VAL (-91)
95 #endif
96 
100 #if MODULE_AT86RF233
101 # define MIN_RX_SENSITIVITY (-101)
102 #elif MODULE_AT86RF212B
103 # define MIN_RX_SENSITIVITY (-110)
104 #elif MODULE_AT86RFA1 || MODULE_AT86RFR2
105 # define MIN_RX_SENSITIVITY (-100)
106 #else
107 # define MIN_RX_SENSITIVITY (-101)
108 #endif
109 
110 #if defined(DOXYGEN) || defined(MODULE_AT86RF232) || defined(MODULE_AT86RF233) || defined(MODULE_AT86RFR2)
119 #define AT86RF2XX_HAVE_RETRIES (1)
120 #else
121 #define AT86RF2XX_HAVE_RETRIES (0)
122 #endif
123 
131 #if defined(MODULE_AT86RF233) || defined(MODULE_AT86RF231) || defined(MODULE_AT86RFA1) || defined(MODULE_AT86RFR2)
132 #ifndef AT86RF2XX_RANDOM_NUMBER_GENERATOR
133 #define AT86RF2XX_RANDOM_NUMBER_GENERATOR (1)
134 #endif
135 #else
136 #ifndef AT86RF2XX_RANDOM_NUMBER_GENERATOR
137 #define AT86RF2XX_RANDOM_NUMBER_GENERATOR (0)
138 #endif
139 #endif
140 
149 #if defined(MODULE_AT86RF233) || defined(MODULE_AT86RFR2)
150 #ifndef AT86RF2XX_SMART_IDLE_LISTENING
151 #define AT86RF2XX_SMART_IDLE_LISTENING (1)
152 #endif
153 #else
154 #define AT86RF2XX_SMART_IDLE_LISTENING (0)
155 #endif
156 
161 #define AT86RF2XX_STATE_P_ON (0x00)
162 #define AT86RF2XX_STATE_BUSY_RX (0x01)
163 #define AT86RF2XX_STATE_BUSY_TX (0x02)
164 #define AT86RF2XX_STATE_FORCE_TRX_OFF (0x03)
165 #define AT86RF2XX_STATE_RX_ON (0x06)
166 #define AT86RF2XX_STATE_TRX_OFF (0x08)
167 #define AT86RF2XX_STATE_PLL_ON (0x09)
168 #define AT86RF2XX_STATE_SLEEP (0x0f)
169 #define AT86RF2XX_STATE_BUSY_RX_AACK (0x11)
170 #define AT86RF2XX_STATE_BUSY_TX_ARET (0x12)
171 #define AT86RF2XX_STATE_RX_AACK_ON (0x16)
172 #define AT86RF2XX_STATE_TX_ARET_ON (0x19)
173 #define AT86RF2XX_STATE_IN_PROGRESS (0x1f)
180 #define AT86RF2XX_OPT_CSMA (0x0010)
181 #define AT86RF2XX_OPT_PROMISCUOUS (0x0020)
182 #define AT86RF2XX_OPT_PRELOADING (0x0040)
183 #define AT86RF2XX_OPT_AUTOACK (0x0080)
184 #define AT86RF2XX_OPT_ACK_PENDING (0x0100)
188 #if IS_ACTIVE(AT86RF2XX_BASIC_MODE) || defined(DOXYGEN)
192 #define AT86RF2XX_PHY_STATE_RX AT86RF2XX_STATE_RX_ON
196 #define AT86RF2XX_PHY_STATE_RX_BUSY AT86RF2XX_STATE_BUSY_RX
200 #define AT86RF2XX_PHY_STATE_TX AT86RF2XX_STATE_PLL_ON
204 #define AT86RF2XX_PHY_STATE_TX_BUSY AT86RF2XX_STATE_BUSY_TX
205 #else
206 #define AT86RF2XX_PHY_STATE_RX AT86RF2XX_STATE_RX_AACK_ON
207 #define AT86RF2XX_PHY_STATE_RX_BUSY AT86RF2XX_STATE_BUSY_RX_AACK
208 #define AT86RF2XX_PHY_STATE_TX AT86RF2XX_STATE_TX_ARET_ON
209 #define AT86RF2XX_PHY_STATE_TX_BUSY AT86RF2XX_STATE_BUSY_TX_ARET
210 #endif /* IS_ACTIVE(AT86RF2XX_BASIC_MODE) */
211 
212 #if defined(MODULE_AT86RFA1) || defined(MODULE_AT86RFR2)
216 typedef void at86rf2xx_params_t;
217 #else
221 typedef struct at86rf2xx_params {
222  spi_t spi;
225  gpio_t int_pin;
226  gpio_t sleep_pin;
227  gpio_t reset_pin;
229 #endif
230 
236 typedef struct {
238 #if defined(MODULE_AT86RFA1) || defined(MODULE_AT86RFR2)
239  /* ATmega256rfr2 signals transceiver events with different interrupts
240  * they have to be stored to mimic the same flow as external transceiver
241  * Use irq_status to map saved interrupts of SOC transceiver,
242  * as they clear after IRQ callback.
243  *
244  * irq_status = IRQ_STATUS
245  */
246  uint8_t irq_status;
247 #else
248  /* device specific fields */
250 #endif
251  uint16_t flags;
252  uint8_t state;
253  uint8_t tx_frame_len;
254 #ifdef MODULE_AT86RF212B
255  /* Only AT86RF212B supports multiple pages (PHY modes) */
256  uint8_t page;
257 #endif
258  uint8_t idle_state;
259  uint8_t pending_tx;
262 #if AT86RF2XX_HAVE_RETRIES
263  /* Only radios with the XAH_CTRL_2 register support frame retry reporting */
264  int8_t tx_retries;
265 #endif
267 } at86rf2xx_t;
268 
277 void at86rf2xx_setup(at86rf2xx_t *dev, const at86rf2xx_params_t *params, uint8_t index);
278 
285 
295 
303 
313 
321 
329 uint8_t at86rf2xx_get_chan(const at86rf2xx_t *dev);
330 
337 void at86rf2xx_set_chan(at86rf2xx_t *dev, uint8_t chan);
338 
346 uint8_t at86rf2xx_get_page(const at86rf2xx_t *dev);
347 
354 void at86rf2xx_set_page(at86rf2xx_t *dev, uint8_t page);
355 
363 
372 
387 int at86rf2xx_set_rate(at86rf2xx_t *dev, uint8_t rate);
388 
396 uint16_t at86rf2xx_get_pan(const at86rf2xx_t *dev);
397 
404 void at86rf2xx_set_pan(at86rf2xx_t *dev, uint16_t pan);
405 
413 int16_t at86rf2xx_get_txpower(const at86rf2xx_t *dev);
414 
426 void at86rf2xx_set_txpower(const at86rf2xx_t *dev, int16_t txpower);
427 
436 
448 void at86rf2xx_set_rxsensitivity(const at86rf2xx_t *dev, int8_t rxsens);
449 
458 
469 void at86rf2xx_set_max_retries(const at86rf2xx_t *dev, uint8_t max);
470 
479 
491 void at86rf2xx_set_csma_max_retries(const at86rf2xx_t *dev, int8_t retries);
492 
504  uint8_t min, uint8_t max);
505 
512 void at86rf2xx_set_csma_seed(const at86rf2xx_t *dev, const uint8_t entropy[2]);
513 
522 
529 void at86rf2xx_set_cca_threshold(const at86rf2xx_t *dev, int8_t value);
530 
539 
547 void at86rf2xx_set_option(at86rf2xx_t *dev, uint16_t option, bool state);
548 
557 uint8_t at86rf2xx_set_state(at86rf2xx_t *dev, uint8_t state);
558 
571 size_t at86rf2xx_send(at86rf2xx_t *dev, const uint8_t *data, size_t len);
572 
582 
593 size_t at86rf2xx_tx_load(at86rf2xx_t *dev, const uint8_t *data,
594  size_t len, size_t offset);
595 
602 
614 
624 
632 
633 #ifdef __cplusplus
634 }
635 #endif
636 
637 #endif /* AT86RF2XX_H */
spi_clk_t
Definition: periph_cpu.h:348
Definitions for netdev common IEEE 802.15.4 code.
Definitions low-level network driver interface.
Low-level GPIO peripheral driver interface definitions.
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.
void at86rf2xx_reset(at86rf2xx_t *dev)
Trigger a hardware reset and configure radio with default values.
size_t at86rf2xx_send(at86rf2xx_t *dev, const uint8_t *data, size_t len)
Convenience function for simply sending data.
int8_t at86rf2xx_get_cca_threshold(const at86rf2xx_t *dev)
Get the CCA threshold value.
void at86rf2xx_disable_smart_idle(at86rf2xx_t *dev)
Disable the smart receive tecnology (SRT)
void at86rf2xx_tx_prepare(at86rf2xx_t *dev)
Prepare for sending of data.
void at86rf2xx_set_pan(at86rf2xx_t *dev, uint16_t pan)
Set the PAN ID of the given device.
bool at86rf2xx_cca(at86rf2xx_t *dev)
Perform one manual channel clear assessment (CCA)
void at86rf2xx_get_addr_long(const at86rf2xx_t *dev, eui64_t *addr)
Get the configured long address of the given device.
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.
void at86rf2xx_set_cca_threshold(const at86rf2xx_t *dev, int8_t value)
Set the CCA threshold value.
void at86rf2xx_tx_exec(at86rf2xx_t *dev)
Trigger sending of data previously loaded into transmit buffer.
uint8_t at86rf2xx_get_chan(const at86rf2xx_t *dev)
Get the configured channel number of the given device.
void at86rf2xx_set_addr_long(at86rf2xx_t *dev, const eui64_t *addr)
Set the long address of the given device.
void at86rf2xx_set_csma_max_retries(const at86rf2xx_t *dev, int8_t retries)
Set the maximum number of channel access attempts per frame (CSMA)
uint8_t at86rf2xx_get_rate(at86rf2xx_t *dev)
Get the current O-QPSK rate mode of the PHY.
void at86rf2xx_set_csma_seed(const at86rf2xx_t *dev, const uint8_t entropy[2])
Set seed for CSMA random backoff.
uint16_t at86rf2xx_get_pan(const at86rf2xx_t *dev)
Get the configured PAN ID of the given device.
uint8_t at86rf2xx_get_phy_mode(at86rf2xx_t *dev)
Get the PHY mode of the given device.
uint8_t at86rf2xx_set_state(at86rf2xx_t *dev, uint8_t state)
Set the state of the given device (trigger a state change)
void at86rf2xx_setup(at86rf2xx_t *dev, const at86rf2xx_params_t *params, uint8_t index)
Setup an AT86RF2xx based device state.
int8_t at86rf2xx_get_rxsensitivity(const at86rf2xx_t *dev)
Get the configured receiver sensitivity of the given device [in dBm].
uint8_t at86rf2xx_get_csma_max_retries(const at86rf2xx_t *dev)
Get the maximum number of channel access attempts per frame (CSMA)
struct at86rf2xx_params at86rf2xx_params_t
struct holding all params needed for device initialization
int16_t at86rf2xx_get_txpower(const at86rf2xx_t *dev)
Get the configured transmission power of the given device [in dBm].
void at86rf2xx_enable_smart_idle(at86rf2xx_t *dev)
Enable the smart receive tecnology (SRT)
void at86rf2xx_set_max_retries(const at86rf2xx_t *dev, uint8_t max)
Set the maximum number of retransmissions.
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.
void at86rf2xx_get_addr_short(const at86rf2xx_t *dev, network_uint16_t *addr)
Get the short address of the given device.
void at86rf2xx_set_option(at86rf2xx_t *dev, uint16_t option, bool state)
Enable or disable driver specific options.
uint8_t at86rf2xx_get_max_retries(const at86rf2xx_t *dev)
Get the maximum number of retransmissions.
void at86rf2xx_set_addr_short(at86rf2xx_t *dev, const network_uint16_t *addr)
Set the short address of the given device.
void at86rf2xx_set_chan(at86rf2xx_t *dev, uint8_t chan)
Set the channel number of the given device.
void at86rf2xx_set_txpower(const at86rf2xx_t *dev, int16_t txpower)
Set the transmission power of the given device [in dBm].
void at86rf2xx_set_page(at86rf2xx_t *dev, uint8_t page)
Set the channel page of the given device.
uint8_t at86rf2xx_get_page(const at86rf2xx_t *dev)
Get the configured channel page of the given device.
void at86rf2xx_set_rxsensitivity(const at86rf2xx_t *dev, int8_t rxsens)
Set the receiver sensitivity of the given device [in dBm].
int8_t at86rf2xx_get_ed_level(at86rf2xx_t *dev)
Get the latest ED level measurement.
gpio_t spi_cs_t
Chip select pin type overlaps with gpio_t so it can be casted to this.
Definition: spi.h:127
Common macros and compiler attributes/pragmas configuration.
Protocol type definitions.
Low-level SPI peripheral driver interface definition.
struct holding all params needed for device initialization
Definition: at86rf2xx.h:221
spi_t spi
SPI bus the device is connected to.
Definition: at86rf2xx.h:222
spi_cs_t cs_pin
GPIO pin connected to chip select.
Definition: at86rf2xx.h:224
gpio_t reset_pin
GPIO pin connected to the reset pin.
Definition: at86rf2xx.h:227
gpio_t sleep_pin
GPIO pin connected to the sleep pin.
Definition: at86rf2xx.h:226
gpio_t int_pin
GPIO pin connected to the interrupt pin.
Definition: at86rf2xx.h:225
spi_clk_t spi_clk
SPI clock speed to use.
Definition: at86rf2xx.h:223
Device descriptor for AT86RF2XX radio devices.
Definition: at86rf2xx.h:236
int8_t tx_retries
Number of NOACK retransmissions.
Definition: at86rf2xx.h:264
uint8_t pending_tx
keep track of pending TX calls this is required to know when to return to at86rf2xx_t::idle_state
Definition: at86rf2xx.h:259
uint8_t tx_frame_len
length of the current TX frame
Definition: at86rf2xx.h:253
netdev_ieee802154_t netdev
netdev parent struct
Definition: at86rf2xx.h:237
uint8_t idle_state
state to return to after sending
Definition: at86rf2xx.h:258
uint8_t state
current state of the radio
Definition: at86rf2xx.h:252
at86rf2xx_params_t params
parameters for initialization
Definition: at86rf2xx.h:249
uint16_t flags
Device specific flags.
Definition: at86rf2xx.h:251
Extended structure to hold IEEE 802.15.4 driver state.
Definition: ieee802154.h:100
A 16 bit integer in big endian aka network byte order.
Definition: byteorder.h:77
Data type to represent an EUI-64.
Definition: eui64.h:55