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

Merge pull request #15280 from jia200x/pr/radio_/read_doc

Browse Source 
ieee802154/radio: indicate that FCS is ignored when reading buffer
This commit is contained in:
Marian Buschsieweke 2020-10-23 12:30:21 +02:00 committed by GitHub
commit 19e45f6189
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sys/include/net/ieee802154/radio.h
View File

@ -441,7 +441,9 @@ struct ieee802154_radio_ops {
* @brief Read a frame from the internal framebuffer * @brief Read a frame from the internal framebuffer
* *
* This function reads the received frame from the internal framebuffer. * This function reads the received frame from the internal framebuffer.
* It should try to copy the received frame into @p buf * It should try to copy the received PSDU frame into @p buf. The FCS
* field will **not** be copied and its size **not** be taken into account
* for the return value.
* *
* @post It's not safe to call this function again before setting the * @post It's not safe to call this function again before setting the
* transceiver state to @ref IEEE802154_TRX_STATE_RX_ON (thus flushing * transceiver state to @ref IEEE802154_TRX_STATE_RX_ON (thus flushing