diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-06-28 08:20:37 -0400 |
---|---|---|
committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-07-03 07:00:26 -0400 |
commit | 5d8cbf7176a427cd904eaa6efdaf6960d717b0de (patch) | |
tree | 8e2d09552554626373520e270972211306222e41 /Documentation/firmware-guide | |
parent | 9fe51603d953419b8da74f455269eca8e6b84228 (diff) |
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>
Diffstat (limited to 'Documentation/firmware-guide')
-rw-r--r-- | Documentation/firmware-guide/acpi/extcon-intel-int3496.rst | 33 | ||||
-rw-r--r-- | Documentation/firmware-guide/acpi/index.rst | 1 |
2 files changed, 34 insertions, 0 deletions
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 @@ | |||
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 | ======= ======= | ||
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 | |||
24 | acpi-lid | 24 | acpi-lid |
25 | lpit | 25 | lpit |
26 | video_extension | 26 | video_extension |
27 | extcon-intel-int3496 | ||