RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #16869 from chrysn-pull-requests/802154_submac-docs-syntax

Browse Source 
ieee802154_submac doc: Make readable in doxygen builds
This commit is contained in:
chrysn 2021-09-19 11:11:22 +02:00 committed by GitHub
commit b6dee72161
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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:
*
* ```
* +--------+ +--------+ +--------+
* | |------->| | | |
* | RX | |PREPARE |<--->| TX |
@ -43,6 +44,7 @@
* | | IDLE | |
* +------------->| |<-------+
* +--------+
* ```
*
* - IDLE: The transceiver is off and therefore cannot receive frames. Sending
* frames might be triggered using @ref ieee802154_send. The next SubMAC
@ -73,18 +75,17 @@
*
* The following events are valid for each state:
*
* +---------------+----+-------+---------+----+--------------+
* | Event/State | RX | IDLE | PREPARE | TX | WAIT FOR ACK |
* +---------------+----+-------+---------+----+--------------+
* | TX_DONE | - | - | - | X | - |
* | RX_DONE | X | X* | X* | X* | X |
* | CRC_ERROR | X | X* | X* | X* | X |
* | ACK_TIMEOUT | - | - | - | - | X |
* | BH | - | - | X | - | - |
* | REQ_TX | X | X | - | - | - |
* | REQ_SET_RX_ON | - | X | - | - | - |
* | REQ_SET_IDLE | X | - | - | - | - |
* +---------------+----+-------+---------+----+--------------+
* Event/State | RX | IDLE | PREPARE | TX | WAIT FOR ACK
* --------------|----|-------|---------|----|-------------
* TX_DONE | - | - | - | X | -
* RX_DONE | X | X* | X* | X* | X
* CRC_ERROR | X | X* | X* | X* | X
* ACK_TIMEOUT | - | - | - | - | X
* BH | - | - | X | - | -
* REQ_TX | X | X | - | - | -
* REQ_SET_RX_ON | - | X | - | - | -
* REQ_SET_IDLE | X | - | - | - | -
*
* *: 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
* SubMAC will react accordingly