From: Peter Ujfalusi <peter.ujfalusi@ti.com>
To: <linus.walleij@linaro.org>, <bgolaszewski@baylibre.com>,
<robh+dt@kernel.org>
Cc: <linux-gpio@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<m.szyprowski@samsung.com>, <broonie@kernel.org>,
<mripard@kernel.org>, <p.zabel@pengutronix.de>,
<devicetree@vger.kernel.org>
Subject: [RFC 1/2] dt-bindings: gpio: Document shared GPIO line usage
Date: Wed, 20 Nov 2019 15:34:08 +0200 [thread overview]
Message-ID: <20191120133409.9217-2-peter.ujfalusi@ti.com> (raw)
In-Reply-To: <20191120133409.9217-1-peter.ujfalusi@ti.com>
Boards might use the same GPIO line to control several external devices.
Add section to document on how a shared GPIO pin can be described.
Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
---
.../devicetree/bindings/gpio/gpio.txt | 66 +++++++++++++++++++
1 file changed, 66 insertions(+)
diff --git a/Documentation/devicetree/bindings/gpio/gpio.txt b/Documentation/devicetree/bindings/gpio/gpio.txt
index a8895d339bfe..644e6513607c 100644
--- a/Documentation/devicetree/bindings/gpio/gpio.txt
+++ b/Documentation/devicetree/bindings/gpio/gpio.txt
@@ -228,6 +228,72 @@ Example of two SOC GPIO banks defined as gpio-controller nodes:
#gpio-cells = <2>;
};
+On boards one GPIO line might be connected to multiple devices as reset, enable
+or other control pins. In order to make it safer for this usage of a GPIO line
+one can describe the shared GPIO pin.
+
+Each shared GPIO pin definition is represented as a child node of the GPIO
+controller.
+
+Required properties:
+- gpio-shared: A property specifying that this child node represents a shared
+ GPIO pin.
+- gpios: Store the GPIO information (id, flags, ...) for each GPIO to
+ affect. Shall contain an integer multiple of the number of cells
+ specified in its parent node (GPIO controller node).
+Only one of the following properties scanned in the order shown below.
+This means that when multiple properties are present they will be searched
+in the order presented below and the first match is taken as the intended
+configuration.
+- output-low: A property specifying to set the GPIO direction as output with
+ the value low initially.
+- output-high: A property specifying to set the GPIO direction as output with
+ the value high initially.
+The shared GPIO line management strategy can be selected with either of the
+following properties:
+- refcounted-low: The line must be kept low as long as there is at least one
+ request asking it to be low.
+- refcounted-high: The line must be kept high as long as there is at least one
+ request asking it to be high.
+If neither of the refcounting strategy was selected then the shared GPIO is
+handled as pass through. In this mode all user requests will be forwarded to the
+shared GPIO pin without refcounting.
+
+Optional properties:
+- line-name: The GPIO label name. If not present the node name is used.
+
+Example of shared GPIO use:
+
+ qe_pio_a: gpio-controller@1400 {
+ compatible = "fsl,qe-pario-bank-a", "fsl,qe-pario-bank";
+ reg = <0x1400 0x18>;
+ gpio-controller;
+ #gpio-cells = <2>;
+
+ line_a {
+ gpio-shared;
+ gpios = <5 0>;
+ output-low;
+ refcounted-high;
+ line-name = "enable-for-devices";
+ };
+ };
+
+ device@0 {
+ compatible = "some,device";
+ enable-gpios = <&qe_pio_a 5 0>;
+ };
+
+ device@1 {
+ compatible = "some,device";
+ enable-gpios = <&qe_pio_a 5 0>;
+ };
+
+ component@0 {
+ compatible = "some,component";
+ select-gpios = <&qe_pio_a 5 0>;
+ };
+
2.1) gpio- and pin-controller interaction
-----------------------------------------
--
Peter
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki.
Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
next prev parent reply other threads:[~2019-11-20 13:34 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-20 13:34 [RFC 0/2] gpiolib: Initial, basic support for shared GPIO lines Peter Ujfalusi
2019-11-20 13:34 ` Peter Ujfalusi [this message]
2019-11-22 12:10 ` [RFC 1/2] dt-bindings: gpio: Document shared GPIO line usage Linus Walleij
2019-11-22 13:36 ` Peter Ujfalusi
2019-11-28 10:06 ` Linus Walleij
2019-12-02 21:31 ` Peter Ujfalusi
2019-12-11 0:06 ` Linus Walleij
2019-12-03 23:51 ` Rob Herring
2019-12-10 23:54 ` Linus Walleij
2019-11-20 13:34 ` [RFC 2/2] gpiolib: Support for (output only) shared GPIO line Peter Ujfalusi
2019-11-22 12:22 ` Linus Walleij
2019-11-22 15:14 ` Peter Ujfalusi
2019-11-20 13:49 ` [RFC 0/2] gpiolib: Initial, basic support for shared GPIO lines Peter Ujfalusi
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=20191120133409.9217-2-peter.ujfalusi@ti.com \
--to=peter.ujfalusi@ti.com \
--cc=bgolaszewski@baylibre.com \
--cc=broonie@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=linus.walleij@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=m.szyprowski@samsung.com \
--cc=mripard@kernel.org \
--cc=p.zabel@pengutronix.de \
--cc=robh+dt@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).