From patchwork Mon Jul 24 14:57:27 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thierry Reding X-Patchwork-Id: 9859693 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id BA53460349 for ; Mon, 24 Jul 2017 14:59:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id AC027283E8 for ; Mon, 24 Jul 2017 14:59:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id A0F2E283ED; Mon, 24 Jul 2017 14:59:44 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.3 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_HI, RCVD_IN_SORBS_SPAM, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8E173283FD for ; Mon, 24 Jul 2017 14:59:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932447AbdGXO6B (ORCPT ); Mon, 24 Jul 2017 10:58:01 -0400 Received: from mail-wr0-f194.google.com ([209.85.128.194]:38373 "EHLO mail-wr0-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932333AbdGXO5j (ORCPT ); Mon, 24 Jul 2017 10:57:39 -0400 Received: by mail-wr0-f194.google.com with SMTP id g32so404143wrd.5; Mon, 24 Jul 2017 07:57:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=9kdW18tqih8vHagyZinIT8SoCDBvRLAoitUxeXEFuas=; b=p+W9MV9pKYROG5Q3h+mt2yPNq0Nh2OOkZQpvVok6xewbkDwSF2mmARHbCKZNooxSNc ObhBl3uiYN3vvIpfXsvpkSXHgPg+5e3VZnCb3mRi/8YTjjPOoVccqwYKqS1YCQGpyykk XRo+3oCyryWi1bmnia0R4UuJC8yVqNNhL6dzpgnziXRKsV7iaSQTxCWkIq4S3LYiRUgh D1U2TsbBqX6oGzFP6Ro92ye8MV07nPm1OIC7gGiZ31mOgUqMzU2EMb7gLc8t/XRDYEFn YMJjOpATk+x9CTuo1TCp+au0BlUgVj2fUTHCT6xVJ1mngJpbF6cgt2frDLcEFngd7o9c DEDg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=9kdW18tqih8vHagyZinIT8SoCDBvRLAoitUxeXEFuas=; b=I80r02/4JK7EBLTQtRxLMqRayilHtwz9IdS07FmTXZ9iK6Dqen9ntpxDBTNSu+hj+7 dmSU0pLzDMVlGaaI5ms/1pe78vIwx2nYyhwnLr3jBHzibdtftQi8DtlER4OBysHshyJG Nno4MPYEad5FFsQmd0TqWyId0WHHeagSXQiZIgW/RRpysWsBbJVrHmnUXrTxJ/syBoE3 67xOPDB8opjVZJKm8LAwshld2R183QKr88VlR3XB9Ix/O4Sk/e6+Mr2v3UpkhO6El6PT H4kBztjfRS8ZHcJptZDk4WWypyzhuERL/3hYMi2Nsqy+AAu07ymINaO1D4mlV0ehWtY7 UemA== X-Gm-Message-State: AIVw112gU3CCa5OI+5OqA+L0N34BsL+Hj6mKIBWZsnn86jKwSM3ilhRA /FV4drp4FMGmMA== X-Received: by 10.223.134.221 with SMTP id 29mr9044225wry.63.1500908257829; Mon, 24 Jul 2017 07:57:37 -0700 (PDT) Received: from localhost (p200300E41BDFF20076D02BFFFE273F51.dip0.t-ipconnect.de. [2003:e4:1bdf:f200:76d0:2bff:fe27:3f51]) by smtp.gmail.com with ESMTPSA id u1sm9990266wrd.73.2017.07.24.07.57.36 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 24 Jul 2017 07:57:37 -0700 (PDT) From: Thierry Reding To: Linus Walleij Cc: Mika Westerberg , Andy Shevchenko , Jonathan Corbet , linux-gpio@vger.kernel.org, linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 6/7] docs: driver-api: Add GPIO section Date: Mon, 24 Jul 2017 16:57:27 +0200 Message-Id: <20170724145728.7662-6-thierry.reding@gmail.com> X-Mailer: git-send-email 2.13.3 In-Reply-To: <20170724145728.7662-1-thierry.reding@gmail.com> References: <20170724145728.7662-1-thierry.reding@gmail.com> Sender: linux-acpi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Thierry Reding This adds a section about the various parts of the GPIO subsystem to the driver API documentation. Note that this isn't exhaustive documentation, but rather focusses on pulling in the kerneldoc from various sources, in order to improve coverage of kerneldoc processing. Signed-off-by: Thierry Reding --- Documentation/driver-api/gpio.rst | 45 ++++++++++++++++++++++++++++++++++++++ Documentation/driver-api/index.rst | 1 + 2 files changed, 46 insertions(+) create mode 100644 Documentation/driver-api/gpio.rst diff --git a/Documentation/driver-api/gpio.rst b/Documentation/driver-api/gpio.rst new file mode 100644 index 000000000000..6dd4aa647f27 --- /dev/null +++ b/Documentation/driver-api/gpio.rst @@ -0,0 +1,45 @@ +=================================== +General Purpose Input/Output (GPIO) +=================================== + +Core +==== + +.. kernel-doc:: include/linux/gpio/driver.h + :internal: + +.. kernel-doc:: drivers/gpio/gpiolib.c + :export: + +Legacy API +========== + +The functions listed in this section are deprecated. The GPIO descriptor based +API described above should be used in new code. + +.. kernel-doc:: drivers/gpio/gpiolib-legacy.c + :export: + +ACPI support +============ + +.. kernel-doc:: drivers/gpio/gpiolib-acpi.c + :export: + +Device tree support +=================== + +.. kernel-doc:: drivers/gpio/gpiolib-of.c + :export: + +Device-managed API +================== + +.. kernel-doc:: drivers/gpio/devres.c + :export: + +sysfs helpers +============= + +.. kernel-doc:: drivers/gpio/gpiolib-sysfs.c + :export: diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index 7c94ab50afed..9c20624842b7 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -44,6 +44,7 @@ available subsections can be seen below. uio-howto firmware/index pinctl + gpio misc_devices .. only:: subproject and html