Skip to content

Commit 002a9c2

Browse files
mchehabgregkh
authored andcommitted
docs: ABI: fix syntax to be parsed using ReST notation
There are a number of new changes at the ABI files that cause them to produce warnings when generating ABI output. Fix them. Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/55a89f423cf122982c462d257722e44d6ece4b36.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent b1faa36 commit 002a9c2

17 files changed

Lines changed: 271 additions & 161 deletions

Documentation/ABI/stable/sysfs-driver-firmware-zynqmp

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ Description:
1212
resets. Three registers are used by the FSBL and
1313
other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
1414

15-
Usage:
16-
# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
17-
# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
15+
Usage::
16+
17+
# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
18+
# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
19+
20+
Example::
1821

19-
Example:
20-
# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
21-
# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
22+
# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
23+
# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
2224

2325
Users: Xilinx
2426

@@ -39,13 +41,15 @@ Description:
3941
software products: PERS_GLOB_GEN_STORAGE{4:7}.
4042
Register is reset only by a POR reset.
4143

42-
Usage:
43-
# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
44-
# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
44+
Usage::
45+
46+
# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
47+
# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
48+
49+
Example::
4550

46-
Example:
47-
# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
48-
# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
51+
# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
52+
# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
4953

5054
Users: Xilinx
5155

@@ -61,23 +65,28 @@ Description:
6165

6266
Following are available shutdown scopes(subtypes):
6367

64-
subsystem: Only the APU along with all of its peripherals
68+
subsystem:
69+
Only the APU along with all of its peripherals
6570
not used by other processing units will be
6671
shut down. This may result in the FPD power
6772
domain being shut down provided that no other
6873
processing unit uses FPD peripherals or DRAM.
69-
ps_only: The complete PS will be shut down, including the
74+
ps_only:
75+
The complete PS will be shut down, including the
7076
RPU, PMU, etc. Only the PL domain (FPGA)
7177
remains untouched.
72-
system: The complete system/device is shut down.
78+
system:
79+
The complete system/device is shut down.
7380

74-
Usage:
75-
# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
76-
# echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
81+
Usage::
82+
83+
# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
84+
# echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
85+
86+
Example::
7787

78-
Example:
79-
# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
80-
# echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
88+
# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
89+
# echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
8190

8291
Users: Xilinx
8392

@@ -94,10 +103,13 @@ Description:
94103
system restart.
95104

96105
Usage:
97-
Set healthy bit
98-
# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
99106

100-
Unset healthy bit
101-
# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
107+
Set healthy bit::
108+
109+
# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
110+
111+
Unset healthy bit::
112+
113+
# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
102114

103115
Users: Xilinx

Documentation/ABI/testing/debugfs-moxtet

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ Contact: Marek Behún <marek.behun@nic.cz>
55
Description: (R) Read input from the shift registers, in hexadecimal.
66
Returns N+1 bytes, where N is the number of Moxtet connected
77
modules. The first byte is from the CPU board itself.
8-
Example: 101214
9-
10: CPU board with SD card
10-
12: 2 = PCIe module, 1 = IRQ not active
11-
14: 4 = Peridot module, 1 = IRQ not active
8+
9+
Example::
10+
11+
101214
12+
13+
== =======================================
14+
10 CPU board with SD card
15+
12 2 = PCIe module, 1 = IRQ not active
16+
14 4 = Peridot module, 1 = IRQ not active
17+
== =======================================
1218

1319
What: /sys/kernel/debug/moxtet/output
1420
Date: March 2019
@@ -17,7 +23,13 @@ Contact: Marek Behún <marek.behun@nic.cz>
1723
Description: (RW) Read last written value to the shift registers, in
1824
hexadecimal, or write values to the shift registers, also
1925
in hexadecimal.
20-
Example: 0102
21-
01: 01 was last written, or is to be written, to the
22-
first module's shift register
23-
02: the same for second module
26+
27+
Example::
28+
29+
0102
30+
31+
== ================================================
32+
01 01 was last written, or is to be written, to the
33+
first module's shift register
34+
02 the same for second module
35+
== ================================================

Documentation/ABI/testing/debugfs-turris-mox-rwtm

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign
22
Date: Jun 2020
33
KernelVersion: 5.8
44
Contact: Marek Behún <marek.behun@nic.cz>
5-
Description: (W) Message to sign with the ECDSA private key stored in
5+
Description: (W)
6+
Message to sign with the ECDSA private key stored in
67
device's OTP. The message must be exactly 64 bytes (since
78
this is intended for SHA-512 hashes).
8-
(R) The resulting signature, 136 bytes. This contains the R and
9+
(R)
10+
The resulting signature, 136 bytes. This contains the R and
911
S values of the ECDSA signature, both in big-endian format.

Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Description: Read-only. Attribute group to describe the magic bits
88

99
Each attribute under this group defines a bit range of the
1010
perf_event_attr.config. All supported attributes are listed
11-
below.
11+
below::
1212

1313
event = "config:0-11" - event ID
1414
evtype = "config:12-15" - event type
1515
portid = "config:16-23" - event source
1616

17-
For example,
17+
For example::
1818

1919
fab_mmio_read = "event=0x06,evtype=0x02,portid=0xff"
2020

@@ -40,11 +40,11 @@ Description: Read-only. Attribute group to describe performance monitoring
4040

4141
All supported performance monitoring events are listed below.
4242

43-
Basic events (evtype=0x00)
43+
Basic events (evtype=0x00)::
4444

4545
clock = "event=0x00,evtype=0x00,portid=0xff"
4646

47-
Cache events (evtype=0x01)
47+
Cache events (evtype=0x01)::
4848

4949
cache_read_hit = "event=0x00,evtype=0x01,portid=0xff"
5050
cache_read_miss = "event=0x01,evtype=0x01,portid=0xff"
@@ -59,7 +59,7 @@ Description: Read-only. Attribute group to describe performance monitoring
5959
cache_rx_req_stall = "event=0x09,evtype=0x01,portid=0xff"
6060
cache_eviction = "event=0x0a,evtype=0x01,portid=0xff"
6161

62-
Fabric events (evtype=0x02)
62+
Fabric events (evtype=0x02)::
6363

6464
fab_pcie0_read = "event=0x00,evtype=0x02,portid=0xff"
6565
fab_pcie0_write = "event=0x01,evtype=0x02,portid=0xff"
@@ -78,7 +78,7 @@ Description: Read-only. Attribute group to describe performance monitoring
7878
fab_port_mmio_read = "event=0x06,evtype=0x02,portid=?"
7979
fab_port_mmio_write = "event=0x07,evtype=0x02,portid=?"
8080

81-
VTD events (evtype=0x03)
81+
VTD events (evtype=0x03)::
8282

8383
vtd_port_read_transaction = "event=0x00,evtype=0x03,portid=?"
8484
vtd_port_write_transaction = "event=0x01,evtype=0x03,portid=?"
@@ -88,7 +88,7 @@ Description: Read-only. Attribute group to describe performance monitoring
8888
vtd_port_devtlb_2m_fill = "event=0x05,evtype=0x03,portid=?"
8989
vtd_port_devtlb_1g_fill = "event=0x06,evtype=0x03,portid=?"
9090

91-
VTD SIP events (evtype=0x04)
91+
VTD SIP events (evtype=0x04)::
9292

9393
vtd_sip_iotlb_4k_hit = "event=0x00,evtype=0x04,portid=0xff"
9494
vtd_sip_iotlb_2m_hit = "event=0x01,evtype=0x04,portid=0xff"

Documentation/ABI/testing/sysfs-bus-most

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,8 @@ KernelVersion: 4.15
235235
Contact: Christian Gromm <christian.gromm@microchip.com>
236236
Description:
237237
This is to read back the configured direction of the channel.
238-
The following strings will be accepted:
238+
The following strings will be accepted::
239+
239240
'tx',
240241
'rx'
241242
Users:
@@ -246,7 +247,8 @@ KernelVersion: 4.15
246247
Contact: Christian Gromm <christian.gromm@microchip.com>
247248
Description:
248249
This is to read back the configured data type of the channel.
249-
The following strings will be accepted:
250+
The following strings will be accepted::
251+
250252
'control',
251253
'async',
252254
'sync',

Documentation/ABI/testing/sysfs-class-devfreq

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ Description:
6262
driver should provide the list of available frequencies
6363
with its profile. If need to reset the statistics of devfreq
6464
behavior on a specific device, enter 0(zero) to 'trans_stat'
65-
as following:
65+
as following::
66+
6667
echo 0 > /sys/class/devfreq/.../trans_stat
6768

6869
What: /sys/class/devfreq/.../userspace/set_freq
@@ -117,6 +118,7 @@ Description:
117118
This work timer is used by devfreq workqueue in order to
118119
monitor the device status such as utilization. The user
119120
can change the work timer on runtime according to their demand
120-
as following:
121+
as following::
122+
121123
echo deferrable > /sys/class/devfreq/.../timer
122124
echo delayed > /sys/class/devfreq/.../timer

Documentation/ABI/testing/sysfs-class-ocxl

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Description: read only
1313
where:
1414

1515
==== ===============================================
16-
n: number of currently active contexts, for debug
17-
max: maximum number of contexts supported by the AFU
16+
n number of currently active contexts, for debug
17+
max maximum number of contexts supported by the AFU
1818
==== ===============================================
1919

2020
What: /sys/class/ocxl/<afu name>/pp_mmio_size
@@ -43,7 +43,9 @@ Contact: linuxppc-dev@lists.ozlabs.org
4343
Description: read/write
4444
Control whether the FPGA is reloaded on a link reset. Enabled
4545
through a vendor-specific logic block on the FPGA.
46-
0 Do not reload FPGA image from flash
47-
1 Reload FPGA image from flash
48-
unavailable
49-
The device does not support this capability
46+
47+
=========== ===========================================
48+
0 Do not reload FPGA image from flash
49+
1 Reload FPGA image from flash
50+
unavailable The device does not support this capability
51+
=========== ===========================================

Documentation/ABI/testing/sysfs-class-power-wilco

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,23 @@ KernelVersion: 5.2
44
Description:
55
What charging algorithm to use:
66

7-
Standard: Fully charges battery at a standard rate.
8-
Adaptive: Battery settings adaptively optimized based on
7+
Standard:
8+
Fully charges battery at a standard rate.
9+
Adaptive:
10+
Battery settings adaptively optimized based on
911
typical battery usage pattern.
10-
Fast: Battery charges over a shorter period.
11-
Trickle: Extends battery lifespan, intended for users who
12+
Fast:
13+
Battery charges over a shorter period.
14+
Trickle:
15+
Extends battery lifespan, intended for users who
1216
primarily use their Chromebook while connected to AC.
13-
Custom: A low and high threshold percentage is specified.
17+
Custom:
18+
A low and high threshold percentage is specified.
1419
Charging begins when level drops below
1520
charge_control_start_threshold, and ceases when
1621
level is above charge_control_end_threshold.
17-
Long Life: Customized charge rate for last longer battery life.
22+
Long Life:
23+
Customized charge rate for last longer battery life.
1824
On Wilco device this mode is pre-configured in the factory
1925
through EC's private PID. Swiching to a different mode will
2026
be denied by Wilco EC when Long Life mode is enabled.

0 commit comments

Comments
 (0)