Skip to content

Commit ad63b2b

Browse files
yonschcarlescufi
authored andcommitted
hwinfo: Replace ENOTSUP with ENOSYS in documentation
Fix hwinfo documentation claiming API returns ENOTSUP for unimplemented functions, with the correct ENOSYS Signed-off-by: Yonatan Schachter <[email protected]>
1 parent 3d6a42b commit ad63b2b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/drivers/hwinfo.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ extern "C" {
6363
* @param length Max length of the buffer.
6464
*
6565
* @retval size of the device ID copied.
66-
* @retval -ENOTSUP if there is no implementation for the particular device.
66+
* @retval -ENOSYS if there is no implementation for the particular device.
6767
* @retval any negative value on driver specific errors.
6868
*/
6969
__syscall ssize_t hwinfo_get_device_id(uint8_t *buffer, size_t length);
@@ -87,7 +87,7 @@ ssize_t z_impl_hwinfo_get_device_id(uint8_t *buffer, size_t length);
8787
* `hwinfo_clear_reset_cause` has been called.
8888
*
8989
* @retval zero if successful.
90-
* @retval -ENOTSUP if there is no implementation for the particular device.
90+
* @retval -ENOSYS if there is no implementation for the particular device.
9191
* @retval any negative value on driver specific errors.
9292
*/
9393
__syscall int hwinfo_get_reset_cause(uint32_t *cause);
@@ -100,7 +100,7 @@ int z_impl_hwinfo_get_reset_cause(uint32_t *cause);
100100
* Clears reset cause flags.
101101
*
102102
* @retval zero if successful.
103-
* @retval -ENOTSUP if there is no implementation for the particular device.
103+
* @retval -ENOSYS if there is no implementation for the particular device.
104104
* @retval any negative value on driver specific errors.
105105
*/
106106
__syscall int hwinfo_clear_reset_cause(void);
@@ -115,7 +115,7 @@ int z_impl_hwinfo_clear_reset_cause(void);
115115
* Retrieves all `reset_cause` flags that are supported by this device.
116116
*
117117
* @retval zero if successful.
118-
* @retval -ENOTSUP if there is no implementation for the particular device.
118+
* @retval -ENOSYS if there is no implementation for the particular device.
119119
* @retval any negative value on driver specific errors.
120120
*/
121121
__syscall int hwinfo_get_supported_reset_cause(uint32_t *supported);

0 commit comments

Comments
 (0)