From: Dirk Behme <dirk.behme@gmail.com>
To: linux-gpio@vger.kernel.org
Cc: Dirk Behme <dirk.behme@gmail.com>
Subject: [PATCH] Documentation: gpio: consumer: describe the con_id parameter
Date: Sat, 11 Jul 2015 07:46:02 +0200 [thread overview]
Message-ID: <1436593562-5119-1-git-send-email-dirk.behme@gmail.com> (raw)
The con_id parameter has to match the GPIO description and is automatically
extended by the GPIO suffix if not NULL. I had to look into the code to
understand this and properly find the GPIO I've been looking for, so document
this.
Signed-off-by: Dirk Behme <dirk.behme@gmail.com>
---
Documentation/gpio/consumer.txt | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/Documentation/gpio/consumer.txt b/Documentation/gpio/consumer.txt
index 75542b9..d0d1e47 100644
--- a/Documentation/gpio/consumer.txt
+++ b/Documentation/gpio/consumer.txt
@@ -39,6 +39,18 @@ device that displays digits), an additional index argument can be specified:
const char *con_id, unsigned int idx,
enum gpiod_flags flags)
+The con_id string parameter has to be either NULL or the prefix of the GPIO
+suffixes ("gpios" or "gpio"):
+
+* If the GPIO description is just named with one of the GPIO suffixes
+ ("gpios" or "gpio") use NULL.
+* If the GPIO description is prefixed with anything, e.g. "reset-gpios", use the
+ prefix without the "-" as con_id parameter (in this example "reset").
+
+In case con_id is not NULL, the gpiod subsystem prefixes the GPIO suffix
+("gpios" or "gpio") with the string passed in con_id to get the resulting string
+(snprintf(... "%s-%s", con_id, gpio_suffixes[]).
+
The flags parameter is used to optionally specify a direction and initial value
for the GPIO. Values can be:
--
2.4.5
next reply other threads:[~2015-07-11 6:16 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-07-11 5:46 Dirk Behme [this message]
2015-07-14 5:01 ` [PATCH] Documentation: gpio: consumer: describe the con_id parameter Alexandre Courbot
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1436593562-5119-1-git-send-email-dirk.behme@gmail.com \
--to=dirk.behme@gmail.com \
--cc=linux-gpio@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.