diff mbox series

[libgpiod,v4,18/20] core: document gpiod_line_set_value_bulk NULL values behaviour

Message ID 20191201032407.23589-19-warthog618@gmail.com
State New
Headers show
Series Add support for bias flags and SET_CONFIG | expand

Commit Message

Kent Gibson Dec. 1, 2019, 3:24 a.m. UTC 
The handling of NULL values by gpiod_line_set_value_bulk has been changed
to interpret NULL as low values for all lines.  This patch updates the
documentation of the function to describe that.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
 include/gpiod.h | 1 +
 1 file changed, 1 insertion(+)
diff mbox series

Patch

diff --git a/include/gpiod.h b/include/gpiod.h
index 41527d3..0e9f125 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -1296,6 +1296,7 @@  int gpiod_line_set_value(struct gpiod_line *line, int value) GPIOD_API;
  * @brief Set the values of a set of GPIO lines.
  * @param bulk Set of GPIO lines to reserve.
  * @param values An array holding line_bulk->num_lines new values for lines.
+ *               A NULL pointer is interpreted as a logical low for all lines.
  * @return 0 is the operation succeeds. In case of an error this routine
  *         returns -1 and sets the last error number.
  *