michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: hwinfo: Clarify return values.

Browse source 
Change the doxygen doc from "negative on error" to -ENOSUP and
negative value on driver specific errors.

Signed-off-by: Alexander Wachter <alexander@wachter.cloud>
This commit is contained in:
Alexander Wachter 2020-02-19 18:37:50 +01:00 • committed by Carles Cufí
commit 75724bf299
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/drivers/hwinfo.h
View file

@ -39,7 +39,9 @@ extern "C" {
* @param buffer Buffer to write the ID to.
* @param length Max length of the buffer.
*
* @retval size of the device ID copied or negative on error.
* @retval size of the device ID copied.
* @retval -ENOTSUP if there is no implementation for the particular device.
* @retval any negative value on driver specific errors.
*/
__syscall ssize_t hwinfo_get_device_id(u8_t *buffer, size_t length);