From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-6.0 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI,SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 951877D2F0 for ; Fri, 5 Jul 2019 09:41:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728327AbfGEJl5 (ORCPT ); Fri, 5 Jul 2019 05:41:57 -0400 Received: from cloudserver094114.home.pl ([79.96.170.134]:56386 "EHLO cloudserver094114.home.pl" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726568AbfGEJl5 (ORCPT ); Fri, 5 Jul 2019 05:41:57 -0400 Received: from 79.184.254.216.ipv4.supernova.orange.pl (79.184.254.216) (HELO kreacher.localnet) by serwer1319399.home.pl (79.96.170.134) with SMTP (IdeaSmtpServer 0.83.267) id 383b1dcbbf02a5ce; Fri, 5 Jul 2019 11:41:53 +0200 From: "Rafael J. Wysocki" To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , MyungJoo Ham , Chanwoo Choi , Len Brown , linux-acpi@vger.kernel.org Subject: Re: [PATCH 41/43] docs: extcon: convert it to ReST and move to acpi dir Date: Fri, 05 Jul 2019 11:41:53 +0200 Message-ID: <2703072.RnsRGL6fiV@kreacher> In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Friday, June 28, 2019 2:20:37 PM CEST Mauro Carvalho Chehab wrote: > The intel-int3496.txt file is a documentation for an ACPI driver. > > There's no reason to keep it on a separate directory. > > So, instead of keeping it on some random location, move it > to a sub-directory inside the ACPI documentation dir, > renaming it to .rst. > > Signed-off-by: Mauro Carvalho Chehab > --- > .../acpi/extcon-intel-int3496.rst} | 14 ++++++++++---- > Documentation/firmware-guide/acpi/index.rst | 1 + > MAINTAINERS | 6 +++--- > 3 files changed, 14 insertions(+), 7 deletions(-) > rename Documentation/{extcon/intel-int3496.txt => firmware-guide/acpi/extcon-intel-int3496.rst} (66%) > > diff --git a/Documentation/extcon/intel-int3496.txt b/Documentation/firmware-guide/acpi/extcon-intel-int3496.rst > similarity index 66% > rename from Documentation/extcon/intel-int3496.txt > rename to Documentation/firmware-guide/acpi/extcon-intel-int3496.rst > index 8155dbc7fad3..5137ca834b54 100644 > --- a/Documentation/extcon/intel-int3496.txt > +++ b/Documentation/firmware-guide/acpi/extcon-intel-int3496.rst > @@ -1,5 +1,6 @@ > +===================================================== > Intel INT3496 ACPI device extcon driver documentation > ------------------------------------------------------ > +===================================================== > > The Intel INT3496 ACPI device extcon driver is a driver for ACPI > devices with an acpi-id of INT3496, such as found for example on > @@ -13,15 +14,20 @@ between an USB host and an USB peripheral controller. > The ACPI devices exposes this functionality by returning an array with up > to 3 gpio descriptors from its ACPI _CRS (Current Resource Settings) call: > > -Index 0: The input gpio for the id-pin, this is always present and valid > -Index 1: The output gpio for enabling Vbus output from the device to the otg > +======= ===================================================================== > +Index 0 The input gpio for the id-pin, this is always present and valid > +Index 1 The output gpio for enabling Vbus output from the device to the otg > port, write 1 to enable the Vbus output (this gpio descriptor may > be absent or invalid) > -Index 2: The output gpio for muxing of the data pins between the USB host and > +Index 2 The output gpio for muxing of the data pins between the USB host and > the USB peripheral controller, write 1 to mux to the peripheral > controller > +======= ===================================================================== > > There is a mapping between indices and GPIO connection IDs as follows > + > + ======= ======= > id index 0 > vbus index 1 > mux index 2 > + ======= ======= > diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst > index ae609eec4679..90c90d42d9ad 100644 > --- a/Documentation/firmware-guide/acpi/index.rst > +++ b/Documentation/firmware-guide/acpi/index.rst > @@ -24,3 +24,4 @@ ACPI Support > acpi-lid > lpit > video_extension > + extcon-intel-int3496 > diff --git a/MAINTAINERS b/MAINTAINERS > index fd6fab0dec77..2cf8abf6d48e 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -321,7 +321,7 @@ F: drivers/pnp/pnpacpi/ > F: include/linux/acpi.h > F: include/linux/fwnode.h > F: include/acpi/ > -F: Documentation/acpi/ > +F: Documentation/firmware-guide/acpi/ > F: Documentation/ABI/testing/sysfs-bus-acpi > F: Documentation/ABI/testing/configfs-acpi > F: drivers/pci/*acpi* > @@ -4896,7 +4896,7 @@ S: Maintained > F: Documentation/ > F: scripts/kernel-doc > X: Documentation/ABI/ > -X: Documentation/acpi/ > +X: Documentation/firmware-guide/acpi/ > X: Documentation/devicetree/ > X: Documentation/i2c/ > X: Documentation/media/ > @@ -6073,7 +6073,7 @@ S: Maintained > F: drivers/extcon/ > F: include/linux/extcon/ > F: include/linux/extcon.h > -F: Documentation/extcon/ > +F: Documentation/firmware-guide/acpi/extcon-intel-int3496.rst > F: Documentation/devicetree/bindings/extcon/ > > EXYNOS DP DRIVER > Applied, thanks!