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

netdev: clarify documentation of netdev_driver_t::get_option()

Browse Source
This commit is contained in:
Martine Lenders 2014-11-03 14:16:09 +01:00
parent 9d74d6b1ad
commit 038beb0f99
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
drivers/include/netdev/base.h
View File

@ -252,12 +252,13 @@ typedef struct {
* @param[in] opt the option type
* @param[out] value pointer to store the gotten value in
* @param[in,out] value_len the length of *value*. Must be initialized to the
* available space in value on call.
* available space in *value* on call.
* @return 0, on success
* @return -ENODEV, if *dev* is not recognized
* @return -ENOTSUP, if *opt* is not supported for the device with this
* operation
* @return -EOVERFLOW, if length of *value* is longer then *value_len*.
* @return -EOVERFLOW, if available space in *value* given in *value_len*
* is not big enough to store the option value.
* @return any other fitting negative errno if the ones stated above
* are not sufficient
*/