Skip to content

Commit abd4fd4

Browse files
bagasmeTzung-Bi Shih
authored andcommitted
platform/chrome: Use imperative mood for ChromeOS ACPI sysfs ABI descriptions
The current descriptions all begin with ("This file shows something") clause, which is incorrect wording since these mean return value from sysfs. Use imperative mood ("Returns something") instead, in line with corresponding ACPI documentation at firmware-guide/. 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]
1 parent a6c13d8 commit abd4fd4

File tree

1 file changed

+30
-33
lines changed

1 file changed

+30
-33
lines changed

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

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ What: /sys/bus/platform/devices/GGL0001:*/BINF.2
22
Date: May 2022
33
KernelVersion: 5.19
44
Description:
5-
This file shows information about the current boot of
6-
the active EC firmware.
5+
Returns active EC firmware of current boot (boolean).
76

87
== ===============================
98
0 Read only (recovery) firmware.
@@ -14,8 +13,7 @@ What: /sys/bus/platform/devices/GGL0001:*/BINF.3
1413
Date: May 2022
1514
KernelVersion: 5.19
1615
Description:
17-
This file shows information about the current boot of
18-
the active main firmware type.
16+
Returns main firmware type for current boot (integer).
1917

2018
== =====================================
2119
0 Recovery.
@@ -28,8 +26,8 @@ What: /sys/bus/platform/devices/GGL0001:*/CHSW
2826
Date: May 2022
2927
KernelVersion: 5.19
3028
Description:
31-
This file shows the switch position for the Chrome OS specific
32-
hardware switches when the firmware is booted.
29+
Returns switch position for Chrome OS specific hardware
30+
switches when the firmware is booted (integer).
3331

3432
==== ===========================================
3533
0 No changes.
@@ -43,29 +41,29 @@ What: /sys/bus/platform/devices/GGL0001:*/FMAP
4341
Date: May 2022
4442
KernelVersion: 5.19
4543
Description:
46-
This file shows the physical memory address of the start of
47-
the main processor firmware flashmap.
44+
Returns physical memory address of the start of the main
45+
processor firmware flashmap.
4846

4947
What: /sys/bus/platform/devices/GGL0001:*/FRID
5048
Date: May 2022
5149
KernelVersion: 5.19
5250
Description:
53-
This file shows the firmware version for the read-only portion
54-
of the main processor firmware.
51+
Returns firmware version for the read-only portion of the
52+
main processor firmware.
5553

5654
What: /sys/bus/platform/devices/GGL0001:*/FWID
5755
Date: May 2022
5856
KernelVersion: 5.19
5957
Description:
60-
This file shows the firmware version for the rewritable portion
61-
of the main processor firmware.
58+
Returns firmware version for the rewritable portion of the
59+
main processor firmware.
6260

6361
What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.0
6462
Date: May 2022
6563
KernelVersion: 5.19
6664
Description:
67-
This file shows the type of the GPIO signal for the Chrome OS
68-
specific GPIO assignments.
65+
Returns type of the GPIO signal for the Chrome OS specific
66+
GPIO assignments (integer).
6967

7068
=========== ==================================
7169
1 Recovery button.
@@ -78,7 +76,7 @@ What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.1
7876
Date: May 2022
7977
KernelVersion: 5.19
8078
Description:
81-
This file shows the signal attributes of the GPIO signal.
79+
Returns signal attributes of the GPIO signal (integer bitfield).
8280

8381
== =======================
8482
0 Signal is active low.
@@ -89,52 +87,51 @@ What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.2
8987
Date: May 2022
9088
KernelVersion: 5.19
9189
Description:
92-
This file shows the GPIO number on the specified GPIO
90+
Returns the GPIO number on the specified GPIO
9391
controller.
9492

9593
What: /sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.3
9694
Date: May 2022
9795
KernelVersion: 5.19
9896
Description:
99-
This file shows the name of the GPIO controller.
97+
Returns name of the GPIO controller.
10098

10199
What: /sys/bus/platform/devices/GGL0001:*/HWID
102100
Date: May 2022
103101
KernelVersion: 5.19
104102
Description:
105-
This file shows the hardware ID for the Chromebook.
103+
Returns hardware ID for the Chromebook.
106104

107105
What: /sys/bus/platform/devices/GGL0001:*/MECK
108106
Date: May 2022
109107
KernelVersion: 5.19
110108
Description:
111-
This binary file returns the SHA-1 or SHA-256 hash that is
112-
read out of the Management Engine extended registers during
113-
boot. The hash is exported vi ACPI so the OS can verify that
114-
the Management Engine firmware has not changed. If Management
115-
Engine is not present, or if the firmware was unable to read the
116-
extended registers, this buffer size can be zero.
109+
Returns the SHA-1 or SHA-256 hash that is read out of the
110+
Management Engine extended registers during boot. The hash
111+
is exported via ACPI so the OS can verify that the Management
112+
Engine firmware has not changed. If Management Engine is not
113+
present, or if the firmware was unable to read the extended registers, this buffer size can be zero.
117114

118115
What: /sys/bus/platform/devices/GGL0001:*/VBNV.0
119116
Date: May 2022
120117
KernelVersion: 5.19
121118
Description:
122-
This file shows the offset in CMOS bank 0 of the verified boot
123-
non-volatile storage block, counting from the first writable
124-
CMOS byte (that is, 'offset = 0' is the byte following the 14
125-
bytes of clock data).
119+
Returns offset in CMOS bank 0 of the verified boot non-volatile
120+
storage block, counting from the first writable CMOS byte
121+
(that is, 'offset = 0' is the byte following the 14 bytes of
122+
clock data).
126123

127124
What: /sys/bus/platform/devices/GGL0001:*/VBNV.1
128125
Date: May 2022
129126
KernelVersion: 5.19
130127
Description:
131-
This file shows the size in bytes of the verified boot
132-
non-volatile storage block.
128+
Return the size in bytes of the verified boot non-volatile
129+
storage block.
133130

134131
What: /sys/bus/platform/devices/GGL0001:*/VDAT
135132
Date: May 2022
136133
KernelVersion: 5.19
137134
Description:
138-
This binary file returns the verified boot data block shared
139-
between the firmware verification step and the kernel
140-
verification step.
135+
Returns the verified boot data block shared between the
136+
firmware verification step and the kernel verification step
137+
(binary).

0 commit comments

Comments
 (0)