From patchwork Wed Sep 2 18:07:09 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dirk Behme X-Patchwork-Id: 513605 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 E53DB140216 for ; Thu, 3 Sep 2015 04:07:17 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b=czKPLoH+; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755783AbbIBSHQ (ORCPT ); Wed, 2 Sep 2015 14:07:16 -0400 Received: from mail-wi0-f182.google.com ([209.85.212.182]:33010 "EHLO mail-wi0-f182.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755768AbbIBSHP (ORCPT ); Wed, 2 Sep 2015 14:07:15 -0400 Received: by wicmc4 with SMTP id mc4so74618550wic.0 for ; Wed, 02 Sep 2015 11:07:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id; bh=FUtssrsEhtiLaVGxBRrG8heh96rEXW8yWwEgXQg7Lds=; b=czKPLoH+RY2wmj963gtKs2L346Le2v9HYTAxFyo1/1gCeau8mKyGsNGvfI0lFDY7MN yLX4JuM7SZqoekhC8/yDfyPrNc9f9qDhAx/b4fxQPciF/CzeKWhzH/ELx6mK7Fcnm+N7 dRWpHtQ3DOxdT6ufSz9YL+9HIUdC+UFFVlS1n4Pvf8/PKG0hAzhC+AmwkifrdbdYD0sK gbn/EKacKJPiZdedzJ0qDOkiM4tX42vdvFJOSwrx4kaIErQyfHGaGEISffxmcLGwH1rM OyYJX/L8xJ70k1z9LIsxI5x0Sv9VoorFxCxjyt1+xzQvATBLPEgsBVGfgU1A9EeISJcm Mzhw== X-Received: by 10.180.84.65 with SMTP id w1mr5911361wiy.62.1441217234585; Wed, 02 Sep 2015 11:07:14 -0700 (PDT) Received: from localhost.localdomain (p4FEE232A.dip0.t-ipconnect.de. [79.238.35.42]) by smtp.gmail.com with ESMTPSA id c10sm4808232wiy.1.2015.09.02.11.07.13 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 02 Sep 2015 11:07:13 -0700 (PDT) From: Dirk Behme To: Alexandre Courbot , Linus Walleij Cc: linux-gpio@vger.kernel.org, Dirk Behme Subject: [PATCH 1/2 v3] Documentation: gpio: board: add flags parameter to gpiod_get*() functions Date: Wed, 2 Sep 2015 20:07:09 +0200 Message-Id: <1441217230-4530-1-git-send-email-dirk.behme@gmail.com> X-Mailer: git-send-email 2.5.1 Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org With commit 39b2bbe3d715 ("gpio: add flags argument to gpiod_get*() functions") the gpiod_get*() functions got a 'flags' parameter. Reflect this in the documentation, too. Signed-off-by: Dirk Behme --- Changes in v3: Add a short note to mention the fact that the example will switch the LEDs on, similarly to the existing explanation for the "power" GPIO. Documentation/gpio/board.txt | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/Documentation/gpio/board.txt b/Documentation/gpio/board.txt index b80606d..9edd5af 100644 --- a/Documentation/gpio/board.txt +++ b/Documentation/gpio/board.txt @@ -39,11 +39,11 @@ This property will make GPIOs 15, 16 and 17 available to the driver under the struct gpio_desc *red, *green, *blue, *power; - red = gpiod_get_index(dev, "led", 0); - green = gpiod_get_index(dev, "led", 1); - blue = gpiod_get_index(dev, "led", 2); + red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH); + green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH); + blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH); - power = gpiod_get(dev, "power"); + power = gpiod_get(dev, "power", GPIOD_OUT_HIGH); The led GPIOs will be active-high, while the power GPIO will be active-low (i.e. gpiod_is_active_low(power) will be true). @@ -142,13 +142,14 @@ The driver controlling "foo.0" will then be able to obtain its GPIOs as follows: struct gpio_desc *red, *green, *blue, *power; - red = gpiod_get_index(dev, "led", 0); - green = gpiod_get_index(dev, "led", 1); - blue = gpiod_get_index(dev, "led", 2); + red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH); + green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH); + blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH); - power = gpiod_get(dev, "power"); - gpiod_direction_output(power, 1); + power = gpiod_get(dev, "power", GPIOD_OUT_HIGH); -Since the "power" GPIO is mapped as active-low, its actual signal will be 0 -after this code. Contrary to the legacy integer GPIO interface, the active-low -property is handled during mapping and is thus transparent to GPIO consumers. +Since the "led" GPIOs are mapped as active-high, this example will switch their +signals to 1, i.e. enabling the LEDs. And for the "power" GPIO, which is mapped +as active-low, its actual signal will be 0 after this code. Contrary to the legacy +integer GPIO interface, the active-low property is handled during mapping and is +thus transparent to GPIO consumers.