kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-27 15:31:17 +01:00
Code Releases Activity

netdev_driver_t::recv: Extend doc on size feature

Browse Source 
Some drivers return on netdev_driver_t::recv() not the actual frame size, but
an upper bound estimation of it. The upper layer code is already prepared to
handle that. This brings the doc in sync with the code.
This commit is contained in:
Marian Buschsieweke 2018-12-26 20:43:41 +01:00
parent e81b6191aa
commit 58f496de47
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
drivers/include/net/netdev.h
View File

@ -318,8 +318,8 @@ typedef struct netdev_driver {
* Supposed to be called from
* @ref netdev_t::event_callback "netdev->event_callback()"
*
* If @p buf == NULL and @p len == 0, returns the packet size without
* dropping it.
* If @p buf == NULL and @p len == 0, returns the packet size -- or an upper
* bound estimation of the size -- without dropping the packet.
* If @p buf == NULL and @p len > 0, drops the packet and returns the packet
* size.
*
@ -342,7 +342,7 @@ typedef struct netdev_driver {
*
* @return `-ENOBUFS` if supplied buffer is too small
* @return number of bytes read if buf != NULL
* @return packet size if buf == NULL
* @return packet size (or upper bound estimation) if buf == NULL
*/
int (*recv)(netdev_t *dev, void *buf, size_t len, void *info);