summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>2021-01-01 21:00:51 +0100
committerBartosz Golaszewski <bgolaszewski@baylibre.com>2021-02-15 11:43:25 +0100
commitdb63c0953cfa678ae199d7449705ccd076cb174a (patch)
tree0b3cf82f2b79ed64d2bfb797e335a8cd00d24062
parent0bb8e80b58c90208fdea05bd51d24b26af98a71c (diff)
downloadlinux-stable-db63c0953cfa678ae199d7449705ccd076cb174a.tar.gz
linux-stable-db63c0953cfa678ae199d7449705ccd076cb174a.tar.bz2
linux-stable-db63c0953cfa678ae199d7449705ccd076cb174a.zip
docs: gpio: Fix formatting in description of gpiod_*_array_* functions
The gpiod_*_array_* functions take four arguments, not three. Additionally, the formatting of the "value_bitmap" line results in misformatted HTML, so fix that. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
-rw-r--r--Documentation/driver-api/gpio/consumer.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/driver-api/gpio/consumer.rst b/Documentation/driver-api/gpio/consumer.rst
index 173e4c7b037d..22271c342d92 100644
--- a/Documentation/driver-api/gpio/consumer.rst
+++ b/Documentation/driver-api/gpio/consumer.rst
@@ -361,12 +361,13 @@ corresponding chip driver. In that case a significantly improved performance
can be expected. If simultaneous access is not possible the GPIOs will be
accessed sequentially.
-The functions take three arguments:
+The functions take four arguments:
+
* array_size - the number of array elements
* desc_array - an array of GPIO descriptors
* array_info - optional information obtained from gpiod_get_array()
* value_bitmap - a bitmap to store the GPIOs' values (get) or
- a bitmap of values to assign to the GPIOs (set)
+ a bitmap of values to assign to the GPIOs (set)
The descriptor array can be obtained using the gpiod_get_array() function
or one of its variants. If the group of descriptors returned by that function