Commit 5d8cbf7176a427cd904eaa6efdaf6960d717b0de
Committed by
Rafael J. Wysocki
Rafael J. Wysocki
1 parent
9fe51603d9
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 <mchehab+samsung@kernel.org> Acked-by: Chanwoo Choi <cw00.choi@samsung.com> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Showing 4 changed files with 37 additions and 30 deletions Side-by-side Diff
Documentation/extcon/intel-int3496.txt
| 1 | -Intel INT3496 ACPI device extcon driver documentation | |
| 2 | ------------------------------------------------------ | |
| 3 | - | |
| 4 | -The Intel INT3496 ACPI device extcon driver is a driver for ACPI | |
| 5 | -devices with an acpi-id of INT3496, such as found for example on | |
| 6 | -Intel Baytrail and Cherrytrail tablets. | |
| 7 | - | |
| 8 | -This ACPI device describes how the OS can read the id-pin of the devices' | |
| 9 | -USB-otg port, as well as how it optionally can enable Vbus output on the | |
| 10 | -otg port and how it can optionally control the muxing of the data pins | |
| 11 | -between an USB host and an USB peripheral controller. | |
| 12 | - | |
| 13 | -The ACPI devices exposes this functionality by returning an array with up | |
| 14 | -to 3 gpio descriptors from its ACPI _CRS (Current Resource Settings) call: | |
| 15 | - | |
| 16 | -Index 0: The input gpio for the id-pin, this is always present and valid | |
| 17 | -Index 1: The output gpio for enabling Vbus output from the device to the otg | |
| 18 | - port, write 1 to enable the Vbus output (this gpio descriptor may | |
| 19 | - be absent or invalid) | |
| 20 | -Index 2: The output gpio for muxing of the data pins between the USB host and | |
| 21 | - the USB peripheral controller, write 1 to mux to the peripheral | |
| 22 | - controller | |
| 23 | - | |
| 24 | -There is a mapping between indices and GPIO connection IDs as follows | |
| 25 | - id index 0 | |
| 26 | - vbus index 1 | |
| 27 | - mux index 2 |
Documentation/firmware-guide/acpi/extcon-intel-int3496.rst
| 1 | +===================================================== | |
| 2 | +Intel INT3496 ACPI device extcon driver documentation | |
| 3 | +===================================================== | |
| 4 | + | |
| 5 | +The Intel INT3496 ACPI device extcon driver is a driver for ACPI | |
| 6 | +devices with an acpi-id of INT3496, such as found for example on | |
| 7 | +Intel Baytrail and Cherrytrail tablets. | |
| 8 | + | |
| 9 | +This ACPI device describes how the OS can read the id-pin of the devices' | |
| 10 | +USB-otg port, as well as how it optionally can enable Vbus output on the | |
| 11 | +otg port and how it can optionally control the muxing of the data pins | |
| 12 | +between an USB host and an USB peripheral controller. | |
| 13 | + | |
| 14 | +The ACPI devices exposes this functionality by returning an array with up | |
| 15 | +to 3 gpio descriptors from its ACPI _CRS (Current Resource Settings) call: | |
| 16 | + | |
| 17 | +======= ===================================================================== | |
| 18 | +Index 0 The input gpio for the id-pin, this is always present and valid | |
| 19 | +Index 1 The output gpio for enabling Vbus output from the device to the otg | |
| 20 | + port, write 1 to enable the Vbus output (this gpio descriptor may | |
| 21 | + be absent or invalid) | |
| 22 | +Index 2 The output gpio for muxing of the data pins between the USB host and | |
| 23 | + the USB peripheral controller, write 1 to mux to the peripheral | |
| 24 | + controller | |
| 25 | +======= ===================================================================== | |
| 26 | + | |
| 27 | +There is a mapping between indices and GPIO connection IDs as follows | |
| 28 | + | |
| 29 | + ======= ======= | |
| 30 | + id index 0 | |
| 31 | + vbus index 1 | |
| 32 | + mux index 2 | |
| 33 | + ======= ======= |
Documentation/firmware-guide/acpi/index.rst
MAINTAINERS
| ... | ... | @@ -321,7 +321,7 @@ |
| 321 | 321 | F: include/linux/acpi.h |
| 322 | 322 | F: include/linux/fwnode.h |
| 323 | 323 | F: include/acpi/ |
| 324 | -F: Documentation/acpi/ | |
| 324 | +F: Documentation/firmware-guide/acpi/ | |
| 325 | 325 | F: Documentation/ABI/testing/sysfs-bus-acpi |
| 326 | 326 | F: Documentation/ABI/testing/configfs-acpi |
| 327 | 327 | F: drivers/pci/*acpi* |
| ... | ... | @@ -4862,7 +4862,7 @@ |
| 4862 | 4862 | F: Documentation/ |
| 4863 | 4863 | F: scripts/kernel-doc |
| 4864 | 4864 | X: Documentation/ABI/ |
| 4865 | -X: Documentation/acpi/ | |
| 4865 | +X: Documentation/firmware-guide/acpi/ | |
| 4866 | 4866 | X: Documentation/devicetree/ |
| 4867 | 4867 | X: Documentation/i2c/ |
| 4868 | 4868 | X: Documentation/media/ |
| ... | ... | @@ -6032,7 +6032,7 @@ |
| 6032 | 6032 | F: drivers/extcon/ |
| 6033 | 6033 | F: include/linux/extcon/ |
| 6034 | 6034 | F: include/linux/extcon.h |
| 6035 | -F: Documentation/extcon/ | |
| 6035 | +F: Documentation/firmware-guide/acpi/extcon-intel-int3496.rst | |
| 6036 | 6036 | F: Documentation/devicetree/bindings/extcon/ |
| 6037 | 6037 | |
| 6038 | 6038 | EXYNOS DP DRIVER |