api: gpio: correct doxygen for return values in error cases
If a method is not supported by the driver, it should return
-ENOSYS, not -ENOTSUP.
Signed-off-by: Christopher Friedt <cfriedt@fb.com>
diff --git a/include/zephyr/drivers/gpio.h b/include/zephyr/drivers/gpio.h
index 41d4d1a..f6f1035 100644
--- a/include/zephyr/drivers/gpio.h
+++ b/include/zephyr/drivers/gpio.h
@@ -768,6 +768,7 @@
* @param outputs Pointer to a variable where output directions will be stored.
*
* @retval 0 If successful.
+ * @retval -ENOSYS if the underlying driver does not support this call.
* @retval -EIO I/O error when accessing an external GPIO chip.
* @retval -EWOULDBLOCK if operation would block.
*/
@@ -797,8 +798,9 @@
*
* @retval 1 if @p pin is configured as @ref GPIO_INPUT.
* @retval 0 if @p pin is not configured as @ref GPIO_INPUT.
- * @retval -ENOTSUP if the underlying driver does not support this call.
- * @return another negative errno code on failure.
+ * @retval -ENOSYS if the underlying driver does not support this call.
+ * @retval -EIO I/O error when accessing an external GPIO chip.
+ * @retval -EWOULDBLOCK if operation would block.
*/
static inline int gpio_pin_is_input(const struct device *port, gpio_pin_t pin)
{
@@ -825,8 +827,9 @@
*
* @retval 1 if @p pin is configured as @ref GPIO_OUTPUT.
* @retval 0 if @p pin is not configured as @ref GPIO_OUTPUT.
- * @retval -ENOTSUP if the underlying driver does not support this call.
- * @return another negative errno code on failure.
+ * @retval -ENOSYS if the underlying driver does not support this call.
+ * @retval -EIO I/O error when accessing an external GPIO chip.
+ * @retval -EWOULDBLOCK if operation would block.
*/
static inline int gpio_pin_is_output(const struct device *port, gpio_pin_t pin)
{
