From patchwork Thu Dec 4 21:02:02 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Benoit Parrot X-Patchwork-Id: 417919 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id F40FA1400D2 for ; Fri, 5 Dec 2014 08:02:55 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754827AbaLDVCm (ORCPT ); Thu, 4 Dec 2014 16:02:42 -0500 Received: from arroyo.ext.ti.com ([192.94.94.40]:46355 "EHLO arroyo.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754823AbaLDVCk (ORCPT ); Thu, 4 Dec 2014 16:02:40 -0500 Received: from dlelxv90.itg.ti.com ([172.17.2.17]) by arroyo.ext.ti.com (8.13.7/8.13.7) with ESMTP id sB4L2Xv2000452; Thu, 4 Dec 2014 15:02:33 -0600 Received: from DLEE71.ent.ti.com (dlee71.ent.ti.com [157.170.170.114]) by dlelxv90.itg.ti.com (8.14.3/8.13.8) with ESMTP id sB4L2Xmb003315; Thu, 4 Dec 2014 15:02:33 -0600 Received: from dflp33.itg.ti.com (10.64.6.16) by DLEE71.ent.ti.com (157.170.170.114) with Microsoft SMTP Server id 14.3.174.1; Thu, 4 Dec 2014 15:02:33 -0600 Received: from tct7400.am.dhcp.ti.com (ileax41-snat.itg.ti.com [10.172.224.153]) by dflp33.itg.ti.com (8.14.3/8.13.8) with ESMTP id sB4L27iS022171; Thu, 4 Dec 2014 15:02:33 -0600 From: Benoit Parrot To: CC: , , , Alexandre Courbot , Maxime Ripard , Jiri Prchal , Pantelis Antoniou , Benoit Parrot Subject: [Patch v3 2/2] gpio: Document GPIO hogging mechanism Date: Thu, 4 Dec 2014 15:02:02 -0600 Message-ID: <1417726922-10376-3-git-send-email-bparrot@ti.com> X-Mailer: git-send-email 1.8.5.1 In-Reply-To: <1417726922-10376-1-git-send-email-bparrot@ti.com> References: <1417726922-10376-1-git-send-email-bparrot@ti.com> MIME-Version: 1.0 Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org Add GPIO hogging documentation to gpio.txt Signed-off-by: Benoit Parrot --- Changes since v2: * Updated to the latest hog syntax. Changes since v1: * Split the devicetree bindings documentation in its own patch. Documentation/devicetree/bindings/gpio/gpio.txt | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/Documentation/devicetree/bindings/gpio/gpio.txt b/Documentation/devicetree/bindings/gpio/gpio.txt index 3fb8f53..6d88133 100644 --- a/Documentation/devicetree/bindings/gpio/gpio.txt +++ b/Documentation/devicetree/bindings/gpio/gpio.txt @@ -103,6 +103,22 @@ Every GPIO controller node must contain both an empty "gpio-controller" property, and a #gpio-cells integer property, which indicates the number of cells in a gpio-specifier. +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. +Required properties: +- gpio-hog: A property specifying that this child node represent a gpio-hog. +- gpios: Store the gpio information (id, flags, ...). Shall contain the + number of cells specified in its parent node (GPIO controller + node). +- direction: A property specifying the direction/value needed. This property + can take the folowing values: input, output-high, output-low. + +Optional properties: +- line-name: The GPIO label name. If not present the node name is used. + Example of two SOC GPIO banks defined as gpio-controller nodes: qe_pio_a: gpio-controller@1400 { @@ -110,6 +126,13 @@ Example of two SOC GPIO banks defined as gpio-controller nodes: reg = <0x1400 0x18>; gpio-controller; #gpio-cells = <2>; + + line_b { + gpio-hog; + gpios = <6 0>; + direction = "output-low"; + line-name = "foo-bar-gpio"; + }; }; qe_pio_e: gpio-controller@1460 {