submac.h
1 /*
2  * Copyright (C) 2020 HAW Hamburg
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 
107 #ifndef NET_IEEE802154_SUBMAC_H
108 #define NET_IEEE802154_SUBMAC_H
109 
110 #ifdef __cplusplus
111 extern "C" {
112 #endif
113 
114 #include <stdio.h>
115 #include <string.h>
116 #include "assert.h"
117 
118 #include "net/ieee802154.h"
119 #include "net/ieee802154/radio.h"
120 
121 #define IEEE802154_SUBMAC_MAX_RETRANSMISSIONS (4U)
127 
131 typedef struct {
145  void (*rx_done)(ieee802154_submac_t *submac);
158  void (*tx_done)(ieee802154_submac_t *submac, int status,
159  ieee802154_tx_info_t *info);
161 
165 typedef enum {
174 
178 typedef enum {
189 
200  uint16_t panid;
201  uint16_t channel_num;
202  uint8_t channel_page;
203  uint8_t retrans;
204  uint8_t csma_retries_nb;
205  uint8_t backoff_mask;
206  uint8_t csma_retries;
207  int8_t tx_pow;
210  const iolist_t *psdu;
211 };
212 
229 
240  const network_uint16_t *short_addr)
241 {
242  int res = ieee802154_radio_config_addr_filter(&submac->dev,
244  short_addr);
245 
246  if (res >= 0) {
247  memcpy(&submac->short_addr, short_addr, IEEE802154_SHORT_ADDRESS_LEN);
248  }
249 
250  return res;
251 }
252 
263  const eui64_t *ext_addr)
264 {
265  int res = ieee802154_radio_config_addr_filter(&submac->dev,
267  ext_addr);
268 
269  if (res >= 0) {
270  memcpy(&submac->ext_addr, ext_addr, IEEE802154_LONG_ADDRESS_LEN);
271  }
272  return res;
273 }
274 
284 static inline int ieee802154_set_panid(ieee802154_submac_t *submac,
285  const uint16_t *panid)
286 {
287  int res = ieee802154_radio_config_addr_filter(&submac->dev,
289  panid);
290 
291  if (res >= 0) {
292  submac->panid = *panid;
293  }
294 
295  return res;
296 }
297 
306  ieee802154_submac_t *submac)
307 {
308  return submac->phy_mode;
309 }
310 
326 int ieee802154_set_phy_conf(ieee802154_submac_t *submac, uint16_t channel_num,
327  uint8_t channel_page, int8_t tx_pow);
328 
345  uint16_t channel_num)
346 {
347  return ieee802154_set_phy_conf(submac, channel_num, submac->channel_page,
348  submac->tx_pow);
349 }
350 
367  uint16_t channel_page)
368 {
369  return ieee802154_set_phy_conf(submac, submac->channel_num, channel_page,
370  submac->tx_pow);
371 }
372 
389  int8_t tx_pow)
390 {
391  return ieee802154_set_phy_conf(submac, submac->channel_num,
392  submac->channel_page, tx_pow);
393 }
394 
406 {
407  return ieee802154_radio_len(&submac->dev);
408 }
409 
426 static inline int ieee802154_read_frame(ieee802154_submac_t *submac, void *buf,
427  size_t len, ieee802154_rx_info_t *info)
428 {
429  return ieee802154_radio_read(&submac->dev, buf, len, info);
430 }
431 
445 
458 
468 {
469  return submac->fsm_state == IEEE802154_FSM_STATE_RX;
470 }
471 
481 {
482  return submac->fsm_state == IEEE802154_FSM_STATE_IDLE;
483 }
484 
498  const eui64_t *ext_addr);
499 
509  uint16_t us);
510 
519 
528 
541 
554 {
556 }
557 
564 {
566 }
567 
574 {
576 }
577 
584 {
586 }
587 
594 {
596 }
597 
598 #ifdef __cplusplus
599 }
600 #endif
601 
602 #endif /* NET_IEEE802154_SUBMAC_H */
POSIX.1-2008 compliant version of the assert macro.
static int ieee802154_radio_read(ieee802154_dev_t *dev, void *buf, size_t size, ieee802154_rx_info_t *info)
Shortcut to ieee802154_radio_ops::read.
Definition: radio.h:871
static int ieee802154_radio_len(ieee802154_dev_t *dev)
Shortcut to ieee802154_radio_ops::len.
Definition: radio.h:855
static int ieee802154_radio_config_addr_filter(ieee802154_dev_t *dev, ieee802154_af_cmd_t cmd, const void *value)
Shortcut to ieee802154_radio_ops::config_addr_filter.
Definition: radio.h:966
@ IEEE802154_AF_EXT_ADDR
Set extended IEEE 802.15.4 address (eui64_t)
Definition: radio.h:333
@ IEEE802154_AF_SHORT_ADDR
Set short IEEE 802.15.4 address (network_uint16_t)
Definition: radio.h:332
@ IEEE802154_AF_PANID
Set PAN ID (uint16_t)
Definition: radio.h:334
#define IEEE802154_SHORT_ADDRESS_LEN
IEEE 802.15.4 address lengths.
Definition: ieee802154.h:44
ieee802154_phy_mode_t
802.15.4 PHY modes
Definition: ieee802154.h:167
#define IEEE802154_LONG_ADDRESS_LEN
long address (EUI-64)
Definition: ieee802154.h:45
ieee802154_fsm_state_t
Internal SubMAC FSM state machine states.
Definition: submac.h:165
static int ieee802154_get_frame_length(ieee802154_submac_t *submac)
Get the received frame length.
Definition: submac.h:405
void ieee802154_submac_ack_timer_cancel(ieee802154_submac_t *submac)
Cancel the ACK timeout timer.
static int ieee802154_set_channel_page(ieee802154_submac_t *submac, uint16_t channel_page)
Set IEEE 802.15.4 channel page.
Definition: submac.h:366
int ieee802154_send(ieee802154_submac_t *submac, const iolist_t *iolist)
Transmit an IEEE 802.15.4 PSDU.
ieee802154_fsm_state_t ieee802154_submac_process_ev(ieee802154_submac_t *submac, ieee802154_fsm_ev_t ev)
Process an FSM event.
static void ieee802154_submac_tx_done_cb(ieee802154_submac_t *submac)
Indicate the SubMAC that the device finished the transmission procedure.
Definition: submac.h:593
static int ieee802154_set_short_addr(ieee802154_submac_t *submac, const network_uint16_t *short_addr)
Set the IEEE 802.15.4 short address.
Definition: submac.h:239
static bool ieee802154_submac_state_is_rx(ieee802154_submac_t *submac)
Check whether the SubMAC is in RX state.
Definition: submac.h:467
int ieee802154_submac_init(ieee802154_submac_t *submac, const network_uint16_t *short_addr, const eui64_t *ext_addr)
Init the IEEE 802.15.4 SubMAC.
static int ieee802154_set_ext_addr(ieee802154_submac_t *submac, const eui64_t *ext_addr)
Set the IEEE 802.15.4 extended address.
Definition: submac.h:262
static int ieee802154_set_channel_number(ieee802154_submac_t *submac, uint16_t channel_num)
Set IEEE 802.15.4 channel number.
Definition: submac.h:344
ieee802154_fsm_ev_t
Internal SubMAC FSM state machine events.
Definition: submac.h:178
static void ieee802154_submac_bh_process(ieee802154_submac_t *submac)
Indicate the SubMAC that the BH should process an internal event.
Definition: submac.h:563
static bool ieee802154_submac_state_is_idle(ieee802154_submac_t *submac)
Check whether the SubMAC is in IDLE state.
Definition: submac.h:480
int ieee802154_set_rx(ieee802154_submac_t *submac)
Set the SubMAC to RX state.
void ieee802154_submac_ack_timer_set(ieee802154_submac_t *submac, uint16_t us)
Set the ACK timeout timer.
void ieee802154_submac_bh_request(ieee802154_submac_t *submac)
ieee802154_submac_bh_process should be called as soon as possible.
int ieee802154_set_idle(ieee802154_submac_t *submac)
Set the SubMAC to IDLE state.
static ieee802154_phy_mode_t ieee802154_get_phy_mode(ieee802154_submac_t *submac)
Get IEEE 802.15.4 PHY mode.
Definition: submac.h:305
static int ieee802154_set_tx_power(ieee802154_submac_t *submac, int8_t tx_pow)
Set IEEE 802.15.4 transmission power.
Definition: submac.h:388
static int ieee802154_read_frame(ieee802154_submac_t *submac, void *buf, size_t len, ieee802154_rx_info_t *info)
Read the received frame.
Definition: submac.h:426
static void ieee802154_submac_ack_timeout_fired(ieee802154_submac_t *submac)
Indicate the SubMAC that the ACK timeout fired.
Definition: submac.h:553
static int ieee802154_set_panid(ieee802154_submac_t *submac, const uint16_t *panid)
Set the IEEE 802.15.4 PAN ID.
Definition: submac.h:284
static void ieee802154_submac_rx_done_cb(ieee802154_submac_t *submac)
Indicate the SubMAC that the device received a frame.
Definition: submac.h:573
static void ieee802154_submac_crc_error_cb(ieee802154_submac_t *submac)
Indicate the SubMAC that a frame with invalid CRC was received.
Definition: submac.h:583
int ieee802154_set_phy_conf(ieee802154_submac_t *submac, uint16_t channel_num, uint8_t channel_page, int8_t tx_pow)
Set IEEE 802.15.4 PHY configuration (channel, TX power)
@ IEEE802154_FSM_STATE_IDLE
The transceiver is off.
Definition: submac.h:168
@ IEEE802154_FSM_STATE_NUMOF
Number of SubMAC FSM states.
Definition: submac.h:172
@ IEEE802154_FSM_STATE_INVALID
Invalid state.
Definition: submac.h:166
@ IEEE802154_FSM_STATE_PREPARE
The SubMAC is preparing the next transmission.
Definition: submac.h:169
@ IEEE802154_FSM_STATE_TX
The SubMAC is currently transmitting a frame.
Definition: submac.h:170
@ IEEE802154_FSM_STATE_RX
SubMAC is ready to receive frames.
Definition: submac.h:167
@ IEEE802154_FSM_STATE_WAIT_FOR_ACK
The SubMAC is waiting for an ACK frame.
Definition: submac.h:171
@ IEEE802154_FSM_EV_BH
The Bottom Half should process an event.
Definition: submac.h:183
@ IEEE802154_FSM_EV_ACK_TIMEOUT
ACK timer fired.
Definition: submac.h:182
@ IEEE802154_FSM_EV_CRC_ERROR
Radio reports frame was received but CRC failed.
Definition: submac.h:181
@ IEEE802154_FSM_EV_REQUEST_TX
The upper layer requested to transmit a frame.
Definition: submac.h:184
@ IEEE802154_FSM_EV_TX_DONE
Radio reports frame was sent.
Definition: submac.h:179
@ IEEE802154_FSM_EV_REQUEST_SET_IDLE
The upper layer requested to go to IDLE.
Definition: submac.h:186
@ IEEE802154_FSM_EV_NUMOF
Number of SubMAC FSM events.
Definition: submac.h:187
@ IEEE802154_FSM_EV_RX_DONE
Radio reports frame was received.
Definition: submac.h:180
@ IEEE802154_FSM_EV_REQUEST_SET_RX_ON
The upper layer requested to go to RX.
Definition: submac.h:185
CSMA-CA exponential backoff parameters.
Definition: radio.h:371
the IEEE802.15.4 device descriptor
Definition: radio.h:415
RX information associated to a frame.
Definition: radio.h:379
IEEE 802.15.4 SubMAC callbacks.
Definition: submac.h:131
IEEE 802.15.4 SubMAC descriptor.
Definition: submac.h:193
uint8_t backoff_mask
internal value used for random backoff calculation
Definition: submac.h:205
uint8_t csma_retries_nb
current number of CSMA-CA retries
Definition: submac.h:204
const ieee802154_submac_cb_t * cb
pointer to the SubMAC callbacks
Definition: submac.h:197
eui64_t ext_addr
IEEE 802.15.4 extended address.
Definition: submac.h:195
const iolist_t * psdu
stores the current PSDU
Definition: submac.h:210
int8_t tx_pow
Transmission power (in dBm)
Definition: submac.h:207
network_uint16_t short_addr
IEEE 802.15.4 short address.
Definition: submac.h:196
uint8_t retrans
current number of retransmissions
Definition: submac.h:203
bool wait_for_ack
SubMAC is waiting for an ACK frame.
Definition: submac.h:199
uint8_t channel_page
IEEE 802.15.4 channel page.
Definition: submac.h:202
uint16_t channel_num
IEEE 802.15.4 channel number.
Definition: submac.h:201
ieee802154_phy_mode_t phy_mode
IEEE 802.15.4 PHY mode.
Definition: submac.h:209
ieee802154_csma_be_t be
CSMA-CA backoff exponent params.
Definition: submac.h:198
ieee802154_fsm_state_t fsm_state
State of the SubMAC.
Definition: submac.h:208
ieee802154_dev_t dev
802.15.4 HAL descriptor
Definition: submac.h:194
uint8_t csma_retries
maximum number of CSMA-CA retries
Definition: submac.h:206
uint16_t panid
IEEE 802.15.4 PAN ID.
Definition: submac.h:200
TX information of the last transmitted frame.
Definition: radio.h:393
iolist structure definition
Definition: iolist.h:39
IEEE 802.15.4 header definitions.
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