From 5d8cbf7176a427cd904eaa6efdaf6960d717b0de Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 28 Jun 2019 09:20:37 -0300 Subject: docs: extcon: convert it to ReST and move to ACPI dir 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 Acked-by: Chanwoo Choi Signed-off-by: Rafael J. Wysocki --- Documentation/extcon/intel-int3496.txt | 27 ------------------ .../firmware-guide/acpi/extcon-intel-int3496.rst | 33 ++++++++++++++++++++++ Documentation/firmware-guide/acpi/index.rst | 1 + MAINTAINERS | 6 ++-- 4 files changed, 37 insertions(+), 30 deletions(-) delete mode 100644 Documentation/extcon/intel-int3496.txt create mode 100644 Documentation/firmware-guide/acpi/extcon-intel-int3496.rst diff --git a/Documentation/extcon/intel-int3496.txt b/Documentation/extcon/intel-int3496.txt deleted file mode 100644 index 8155dbc7fad3..000000000000 --- a/Documentation/extcon/intel-int3496.txt +++ /dev/null @@ -1,27 +0,0 @@ -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 -Intel Baytrail and Cherrytrail tablets. - -This ACPI device describes how the OS can read the id-pin of the devices' -USB-otg port, as well as how it optionally can enable Vbus output on the -otg port and how it can optionally control the muxing of the data pins -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 - 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 - 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/extcon-intel-int3496.rst b/Documentation/firmware-guide/acpi/extcon-intel-int3496.rst new file mode 100644 index 000000000000..5137ca834b54 --- /dev/null +++ b/Documentation/firmware-guide/acpi/extcon-intel-int3496.rst @@ -0,0 +1,33 @@ +===================================================== +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 +Intel Baytrail and Cherrytrail tablets. + +This ACPI device describes how the OS can read the id-pin of the devices' +USB-otg port, as well as how it optionally can enable Vbus output on the +otg port and how it can optionally control the muxing of the data pins +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 + 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 + 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 a6954776a37e..bf9ba7c59ce8 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* @@ -4862,7 +4862,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/ @@ -6032,7 +6032,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 -- cgit v1.2.3