Kernel/linux-next
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git synced 2025-01-07 14:32:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

platform/chrome: Use tables for values lists of ChromeOS ACPI sysfs ABI

Browse Source 
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/20220516213832.19127535@canb.auug.org.au/
Fixes: 0a4cad9c11 ("platform/chrome: Add ChromeOS ACPI device driver")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Benson Leung <bleung@google.com>
Cc: Guenter Roeck <groeck@chromium.org>
Cc: Andy Shevchenko <andy.shevchenko@gmail.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Cc: Muhammad Usama Anjum <usama.anjum@collabora.com>
Cc: Tzung-Bi Shih <tzungbi@kernel.org>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Cc: Linux Next Mailing List <linux-next@vger.kernel.org>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Muhammad Usama Anjum <usama.anjum@collabora.com>
Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
Link: https://lore.kernel.org/r/20220518083524.37380-2-bagasdotme@gmail.com
[tzungbi: fix the Fixes tag to 12-chars hash.]
Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
This commit is contained in:
Bagas Sanjaya 2022-05-18 15:35:23 +07:00 committed by Tzung-Bi Shih
parent bbd43a37ec
commit a6c13d87b4
1 changed files with 33 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
Documentation/ABI/testing/sysfs-driver-chromeos-acpi
View File

@ -4,8 +4,11 @@ KernelVersion: 5.19
Description:
This file shows information about the current boot of
the active EC firmware.
* 0 - Read only (recovery) firmware.
* 1 - Rewritable firmware.
== ===============================
0 Read only (recovery) firmware.
1 Rewritable firmware.
== ===============================
What: /sys/bus/platform/devices/GGL0001:*/BINF.3
Date: May 2022
@ -13,23 +16,28 @@ KernelVersion: 5.19
Description:
This file shows information about the current boot of
the active main firmware type.
* 0 - Recovery.
* 1 - Normal.
* 2 - Developer.
* 3 - Netboot (factory installation only).
== =====================================
0 Recovery.
1 Normal.
2 Developer.
3 Netboot (factory installation only).
== =====================================
What: /sys/bus/platform/devices/GGL0001:*/CHSW
Date: May 2022
KernelVersion: 5.19
Description:
This file shows the switch position for the Chrome OS specific
hardware switches.
* 0 - No changes.
* 2 - Recovery button was pressed when firmware booted.
* 4 - Recovery button was pressed when EC firmware booted.
* 32 - Developer switch was enabled when firmware booted.
* 512 - Firmware write protection was disabled when firmware
booted.
hardware switches when the firmware is booted.
==== ===========================================
0 No changes.
2 Recovery button was pressed.
4 Recovery button was pressed (EC firmware).
32 Developer switch was enabled.
512 Firmware write protection was disabled.
==== ===========================================
What: /sys/bus/platform/devices/GGL0001:*/FMAP
Date: May 2022
@ -58,18 +66,24 @@ KernelVersion: 5.19
Description:
This file shows the type of the GPIO signal for the Chrome OS
specific GPIO assignments.
* 1 - Recovery button.
* 2 - Developer mode switch.
* 3 - Firmware write protection switch.
* 256 to 511 - Debug header GPIO 0 to GPIO 255.
=========== ==================================
1 Recovery button.
2 Developer mode switch.
3 Firmware write protection switch.
256 to 511 Debug header GPIO 0 to GPIO 255.
=========== ==================================
What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.1
Date: May 2022
KernelVersion: 5.19
Description:
This file shows the signal attributes of the GPIO signal.
* 0 - Signal is active low.
* 1 - Signal is active high.
== =======================
0 Signal is active low.
1 Signal is active high.
== =======================
What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.2
Date: May 2022