From patchwork Thu Sep 17 16:52:49 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Krzysztof Kozlowski X-Patchwork-Id: 254357 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2BA31C433E2 for ; Thu, 17 Sep 2020 18:43:26 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E0167208E4 for ; Thu, 17 Sep 2020 18:43:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1600368205; bh=LNr3F6vUQ7DT7Vs4mRissQqyWTp6Maw/uPs1wDTihEw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=m0IGJ3NBvgkXI7s4g5fKnZV3UFOupNFiHT9NF0WLyEUZisY0KxZw9PxgmNzjjvPk8 ixIpSfKtx0afwMcroCSS6GVUK7oFeqnZAYo9M/9pWEKxDlINDvsN7rgEjpVjG3V8RB 7/LBItdLXgijfEVgxnW5dfp2XPYTxw1kqa4Sua/Q= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728480AbgIQQyD (ORCPT ); Thu, 17 Sep 2020 12:54:03 -0400 Received: from mail.kernel.org ([198.145.29.99]:58358 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728680AbgIQQxm (ORCPT ); Thu, 17 Sep 2020 12:53:42 -0400 Received: from kozik-lap.mshome.net (unknown [194.230.155.191]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 5BD6320838; Thu, 17 Sep 2020 16:53:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1600361620; bh=LNr3F6vUQ7DT7Vs4mRissQqyWTp6Maw/uPs1wDTihEw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=yeo4MNqxqC/0rz60dpD7fLLtv1ESeHX2KZc97xj2v6ggaQfUM97Jr3QW5WwdStQmS Fpq6bmCpxks5q1+3NvLTNNqb8abOukMhKoMkRZXnMxp5roNeV5a8N5rWUZEPTPMd9g kKCq6g9PCfmnot5dawhs35T9ZSnDlUPM0ALOyrEI= From: Krzysztof Kozlowski To: Linus Walleij , Bartosz Golaszewski , Rob Herring , Ray Jui , Scott Branden , bcm-kernel-feedback-list@broadcom.com, Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , NXP Linux Team , Manivannan Sadhasivam , Andy Gross , Bjorn Andersson , Palmer Dabbelt , Paul Walmsley , Hoan Tran , Serge Semin , Masahiro Yamada , Jacopo Mondi , Kieran Bingham , Laurent Pinchart , =?utf-8?q?Niklas_S=C3=B6?= =?utf-8?q?derlund?= , Mauro Carvalho Chehab , Charles Keepax , Richard Fitzgerald , Lee Jones , Maxime Coquelin , Alexandre Torgue , =?utf-8?q?Andreas_F=C3=A4?= =?utf-8?q?rber?= , Maxime Ripard , Chen-Yu Tsai , Matthias Brugger , Geert Uytterhoeven , Liam Girdwood , Mark Brown , Chris Packham , Anson Huang , Sungbo Eo , Stefan Agner , Srinivas Kandagatla , Magnus Damm , Yash Shah , Paul Kocialkowski , - , Matti Vaittinen , Amelie Delaunay , Cristian Ciocaltea , Paul Cercueil , Andy Teng , Sean Wang , Sricharan R , Chris Brandt , Jaroslav Kysela , Takashi Iwai , linux-gpio@vger.kernel.org, devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-unisoc@lists.infradead.org, linux-arm-msm@vger.kernel.org, linux-riscv@lists.infradead.org, linux-media@vger.kernel.org, alsa-devel@alsa-project.org, linux-stm32@st-md-mailman.stormreply.com, linux-mediatek@lists.infradead.org, linux-renesas-soc@vger.kernel.org Cc: Krzysztof Kozlowski Subject: [PATCH v2 01/13] dt-bindings: gpio: add common schema for GPIO controllers Date: Thu, 17 Sep 2020 18:52:49 +0200 Message-Id: <20200917165301.23100-2-krzk@kernel.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200917165301.23100-1-krzk@kernel.org> References: <20200917165301.23100-1-krzk@kernel.org> Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org Convert parts of gpio.txt bindings into common dtschema file for GPIO controllers. The schema enforces proper naming of GPIO controller nodes and GPIO hogs. The schema should be included by specific GPIO controllers bindings. Signed-off-by: Krzysztof Kozlowski --- Changes since v1: 1. Do not require compatible (some child nodes are gpio-controllers without the compatible). --- .../devicetree/bindings/gpio/gpio-common.yaml | 125 ++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 Documentation/devicetree/bindings/gpio/gpio-common.yaml diff --git a/Documentation/devicetree/bindings/gpio/gpio-common.yaml b/Documentation/devicetree/bindings/gpio/gpio-common.yaml new file mode 100644 index 000000000000..af9f6c7feeec --- /dev/null +++ b/Documentation/devicetree/bindings/gpio/gpio-common.yaml @@ -0,0 +1,125 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/gpio/gpio-common.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Common GPIO controller properties + +maintainers: + - Krzysztof Kozlowski + - Linus Walleij + +properties: + nodename: + pattern: "^(gpio-controller|gpio)(@[0-9a-f]+|-[0-9a-f]+)?$" + + '#gpio-cells': true + gpio-controller: true + gpio-ranges: true + + gpio-line-names: + description: | + Optionally, a GPIO controller may have a "gpio-line-names" property. This + is an array of strings defining the names of the GPIO lines going out of + the GPIO controller. This name should be the most meaningful producer + name for the system, such as a rail name indicating the usage. Package + names such as pin name are discouraged: such lines have opaque names + (since they are by definition generic purpose) and such names are usually + not very helpful. + + For example "MMC-CD", "Red LED Vdd" and "ethernet reset" are reasonable + line names as they describe what the line is used for. "GPIO0" is not a + good name to give to a GPIO line. + + Placeholders are discouraged: rather use the "" (blank string) if the use + of the GPIO line is undefined in your design. The names are assigned + starting from line offset 0 from left to right from the passed array. An + incomplete array (where the number of passed named are less than ngpios) + will still be used up until the last provided valid line index. + + gpio-reserved-ranges: + description: + Indicates the start and size of the GPIOs that can't be used. + + ngpios: + description: | + Optionally, a GPIO controller may have a "ngpios" property. This property + indicates the number of in-use slots of available slots for GPIOs. The + typical example is something like this: the hardware register is 32 bits + wide, but only 18 of the bits have a physical counterpart. The driver is + generally written so that all 32 bits can be used, but the IP block is + reused in a lot of designs, some using all 32 bits, some using 18 and + some using 12. In this case, setting "ngpios = <18>;" informs the driver + that only the first 18 GPIOs, at local offset 0 .. 17, are in use. + + If these GPIOs do not happen to be the first N GPIOs at offset 0...N-1, + an additional set of tuples is needed to specify which GPIOs are + unusable, with the gpio-reserved-ranges binding. + +patternProperties: + "^(hog-[0-9]+|.+-hog(-[0-9]+)?)$": + type: object + description: + The GPIO chip may contain GPIO hog definitions. GPIO hogging is a mechanism + providing automatic GPIO request and configuration as part of the + gpio-controller's driver probe function. + Each GPIO hog definition is represented as a child node of the GPIO controller. + + properties: + gpio-hog: true + gpios: true + input: true + output-high: true + output-low: true + line-name: + description: + The GPIO label name. If not present the node name is used. + + required: + - gpio-hog + - gpios + + oneOf: + - required: + - input + - required: + - output-high + - required: + - output-low + + additionalProperties: false + +required: + - "#gpio-cells" + - gpio-controller + +examples: + - | + gpio-controller@15000000 { + compatible = "foo"; + reg = <0x15000000 0x1000>; + gpio-controller; + #gpio-cells = <2>; + ngpios = <18>; + gpio-reserved-ranges = <0 4>, <12 2>; + gpio-line-names = "MMC-CD", "MMC-WP", "VDD eth", "RST eth", "LED R", + "LED G", "LED B", "Col A", "Col B", "Col C", "Col D", + "Row A", "Row B", "Row C", "Row D", "NMI button", + "poweroff", "reset"; + }; + + - | + gpio-controller@1400 { + compatible = "fsl,qe-pario-bank-a", "fsl,qe-pario-bank"; + reg = <0x1400 0x18>; + gpio-controller; + #gpio-cells = <2>; + + line-b-hog { + gpio-hog; + gpios = <6 0>; + input; + line-name = "foo-bar-gpio"; + }; + };