Skip to content

Commit a6c13d8

Browse files
bagasmeTzung-Bi Shih
authored andcommitted
platform/chrome: Use tables for values lists of ChromeOS ACPI sysfs ABI
Stephen Rothwell reported htmldocs warning when merging chrome-platform tree: Documentation/ABI/testing/sysfs-driver-chromeos-acpi:2: WARNING: Unexpected indentation. Documentation/ABI/testing/sysfs-driver-chromeos-acpi:11: WARNING: Unexpected indentation. Documentation/ABI/testing/sysfs-driver-chromeos-acpi:22: WARNING: Unexpected indentation. Documentation/ABI/testing/sysfs-driver-chromeos-acpi:56: WARNING: Unexpected indentation. The warning is due to missing blank line separator surrounding values lists. Instead of using lists, use tables to be consistent with rest of sysfs ABI documentation. Link: https://lore.kernel.org/linux-next/[email protected]/ Fixes: 0a4cad9 ("platform/chrome: Add ChromeOS ACPI device driver") Reported-by: Stephen Rothwell <[email protected]> Cc: Benson Leung <[email protected]> Cc: Guenter Roeck <[email protected]> Cc: Andy Shevchenko <[email protected]> Cc: Greg Kroah-Hartman <[email protected]> Cc: Rafael J. Wysocki <[email protected]> Cc: Dmitry Torokhov <[email protected]> Cc: Enric Balletbo i Serra <[email protected]> Cc: Muhammad Usama Anjum <[email protected]> Cc: Tzung-Bi Shih <[email protected]> Cc: Linux Kernel Mailing List <[email protected]> Cc: Linux Next Mailing List <[email protected]> Signed-off-by: Bagas Sanjaya <[email protected]> Reviewed-by: Muhammad Usama Anjum <[email protected]> Signed-off-by: Tzung-Bi Shih <[email protected]> Link: https://lore.kernel.org/r/[email protected] [tzungbi: fix the Fixes tag to 12-chars hash.] Signed-off-by: Tzung-Bi Shih <[email protected]>
1 parent bbd43a3 commit a6c13d8

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

Documentation/ABI/testing/sysfs-driver-chromeos-acpi

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,40 @@ KernelVersion: 5.19
44
Description:
55
This file shows information about the current boot of
66
the active EC firmware.
7-
* 0 - Read only (recovery) firmware.
8-
* 1 - Rewritable firmware.
7+
8+
== ===============================
9+
0 Read only (recovery) firmware.
10+
1 Rewritable firmware.
11+
== ===============================
912

1013
What: /sys/bus/platform/devices/GGL0001:*/BINF.3
1114
Date: May 2022
1215
KernelVersion: 5.19
1316
Description:
1417
This file shows information about the current boot of
1518
the active main firmware type.
16-
* 0 - Recovery.
17-
* 1 - Normal.
18-
* 2 - Developer.
19-
* 3 - Netboot (factory installation only).
19+
20+
== =====================================
21+
0 Recovery.
22+
1 Normal.
23+
2 Developer.
24+
3 Netboot (factory installation only).
25+
== =====================================
2026

2127
What: /sys/bus/platform/devices/GGL0001:*/CHSW
2228
Date: May 2022
2329
KernelVersion: 5.19
2430
Description:
2531
This file shows the switch position for the Chrome OS specific
26-
hardware switches.
27-
* 0 - No changes.
28-
* 2 - Recovery button was pressed when firmware booted.
29-
* 4 - Recovery button was pressed when EC firmware booted.
30-
* 32 - Developer switch was enabled when firmware booted.
31-
* 512 - Firmware write protection was disabled when firmware
32-
booted.
32+
hardware switches when the firmware is booted.
33+
34+
==== ===========================================
35+
0 No changes.
36+
2 Recovery button was pressed.
37+
4 Recovery button was pressed (EC firmware).
38+
32 Developer switch was enabled.
39+
512 Firmware write protection was disabled.
40+
==== ===========================================
3341

3442
What: /sys/bus/platform/devices/GGL0001:*/FMAP
3543
Date: May 2022
@@ -58,18 +66,24 @@ KernelVersion: 5.19
5866
Description:
5967
This file shows the type of the GPIO signal for the Chrome OS
6068
specific GPIO assignments.
61-
* 1 - Recovery button.
62-
* 2 - Developer mode switch.
63-
* 3 - Firmware write protection switch.
64-
* 256 to 511 - Debug header GPIO 0 to GPIO 255.
69+
70+
=========== ==================================
71+
1 Recovery button.
72+
2 Developer mode switch.
73+
3 Firmware write protection switch.
74+
256 to 511 Debug header GPIO 0 to GPIO 255.
75+
=========== ==================================
6576

6677
What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.1
6778
Date: May 2022
6879
KernelVersion: 5.19
6980
Description:
7081
This file shows the signal attributes of the GPIO signal.
71-
* 0 - Signal is active low.
72-
* 1 - Signal is active high.
82+
83+
== =======================
84+
0 Signal is active low.
85+
1 Signal is active high.
86+
== =======================
7387

7488
What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.2
7589
Date: May 2022

0 commit comments

Comments
 (0)