riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ieee802154_submac doc: Make readable in doxygen builds

Browse Source
This commit is contained in:
chrysn 2021-09-18 21:25:15 +02:00
parent f93d1276b4
commit eaf6219af3
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sys/include/net/ieee802154/submac.h
View File

@ -22,6 +22,7 @@
* *
* The SubMAC defines the following state machine: * The SubMAC defines the following state machine:
* *
* ```
* +--------+ +--------+ +--------+ * +--------+ +--------+ +--------+
* | |------->| | | | * | |------->| | | |
* | RX | |PREPARE |<--->| TX | * | RX | |PREPARE |<--->| TX |
@ -43,6 +44,7 @@
* | | IDLE | | * | | IDLE | |
* +------------->| |<-------+ * +------------->| |<-------+
* +--------+ * +--------+
* ```
* *
* - IDLE: The transceiver is off and therefore cannot receive frames. Sending * - IDLE: The transceiver is off and therefore cannot receive frames. Sending
* frames might be triggered using @ref ieee802154_send. The next SubMAC * frames might be triggered using @ref ieee802154_send. The next SubMAC
@ -73,18 +75,17 @@
* *
* The following events are valid for each state: * The following events are valid for each state:
* *
* +---------------+----+-------+---------+----+--------------+ * Event/State | RX | IDLE | PREPARE | TX | WAIT FOR ACK
* | Event/State | RX | IDLE | PREPARE | TX | WAIT FOR ACK | * --------------|----|-------|---------|----|-------------
* +---------------+----+-------+---------+----+--------------+ * TX_DONE | - | - | - | X | -
* | TX_DONE | - | - | - | X | - | * RX_DONE | X | X* | X* | X* | X
* | RX_DONE | X | X* | X* | X* | X | * CRC_ERROR | X | X* | X* | X* | X
* | CRC_ERROR | X | X* | X* | X* | X | * ACK_TIMEOUT | - | - | - | - | X
* | ACK_TIMEOUT | - | - | - | - | X | * BH | - | - | X | - | -
* | BH | - | - | X | - | - | * REQ_TX | X | X | - | - | -
* | REQ_TX | X | X | - | - | - | * REQ_SET_RX_ON | - | X | - | - | -
* | REQ_SET_RX_ON | - | X | - | - | - | * REQ_SET_IDLE | X | - | - | - | -
* | REQ_SET_IDLE | X | - | - | - | - | *
* +---------------+----+-------+---------+----+--------------+
* *: RX_DONE and CRC_ERROR during these events might be a race condition * *: RX_DONE and CRC_ERROR during these events might be a race condition
* between the ACK Timer and the radios RX_DONE event. If this happens, the * between the ACK Timer and the radios RX_DONE event. If this happens, the
* SubMAC will react accordingly * SubMAC will react accordingly