Skip to content

Commit 4119f0d

Browse files
mchehabgregkh
authored andcommitted
docs: ABI: change read/write attributes
Unfortunately, (R) and (W) are valid markups for enumerated lists, as described at: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#enumerated-lists So, we ned to replace them by: (R) -> (Read) (W) -> (Write) As otherwise, (R) will be displayed as R., with is not what it is desired. There's no need to touch (RO) and (RW). Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/6e81ad8064f3ed4f8dc265086fdf1c618043f935.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 54a19b4 commit 4119f0d

10 files changed

Lines changed: 109 additions & 108 deletions

Documentation/ABI/testing/debugfs-moxtet

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ What: /sys/kernel/debug/moxtet/input
22
Date: March 2019
33
KernelVersion: 5.3
44
Contact: Marek Behún <marek.behun@nic.cz>
5-
Description: (R) Read input from the shift registers, in hexadecimal.
5+
Description: (Read) 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.
88

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ KernelVersion: 5.8
44
Contact: Marek Behún <marek.behun@nic.cz>
55
Description:
66

7-
=== ===========================================================
8-
(W) Message to sign with the ECDSA private key stored in
9-
device's OTP. The message must be exactly 64 bytes (since
10-
this is intended for SHA-512 hashes).
11-
(R) The resulting signature, 136 bytes. This contains the R and
12-
S values of the ECDSA signature, both in big-endian format.
13-
=== ===========================================================
7+
======= ===========================================================
8+
(Write) Message to sign with the ECDSA private key stored in
9+
device's OTP. The message must be exactly 64 bytes
10+
(since this is intended for SHA-512 hashes).
11+
(Read) The resulting signature, 136 bytes. This contains the
12+
R and S values of the ECDSA signature, both in
13+
big-endian format.
14+
======= ===========================================================

Documentation/ABI/testing/sysfs-bus-coresight-devices-cti

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,50 +8,50 @@ What: /sys/bus/coresight/devices/<cti-name>/powered
88
Date: March 2020
99
KernelVersion 5.7
1010
Contact: Mike Leach or Mathieu Poirier
11-
Description: (R) Indicate if the CTI hardware is powered.
11+
Description: (Read) Indicate if the CTI hardware is powered.
1212

1313
What: /sys/bus/coresight/devices/<cti-name>/ctmid
1414
Date: March 2020
1515
KernelVersion 5.7
1616
Contact: Mike Leach or Mathieu Poirier
17-
Description: (R) Display the associated CTM ID
17+
Description: (Read) Display the associated CTM ID
1818

1919
What: /sys/bus/coresight/devices/<cti-name>/nr_trigger_cons
2020
Date: March 2020
2121
KernelVersion 5.7
2222
Contact: Mike Leach or Mathieu Poirier
23-
Description: (R) Number of devices connected to triggers on this CTI
23+
Description: (Read) Number of devices connected to triggers on this CTI
2424

2525
What: /sys/bus/coresight/devices/<cti-name>/triggers<N>/name
2626
Date: March 2020
2727
KernelVersion 5.7
2828
Contact: Mike Leach or Mathieu Poirier
29-
Description: (R) Name of connected device <N>
29+
Description: (Read) Name of connected device <N>
3030

3131
What: /sys/bus/coresight/devices/<cti-name>/triggers<N>/in_signals
3232
Date: March 2020
3333
KernelVersion 5.7
3434
Contact: Mike Leach or Mathieu Poirier
35-
Description: (R) Input trigger signals from connected device <N>
35+
Description: (Read) Input trigger signals from connected device <N>
3636

3737
What: /sys/bus/coresight/devices/<cti-name>/triggers<N>/in_types
3838
Date: March 2020
3939
KernelVersion 5.7
4040
Contact: Mike Leach or Mathieu Poirier
41-
Description: (R) Functional types for the input trigger signals
41+
Description: (Read) Functional types for the input trigger signals
4242
from connected device <N>
4343

4444
What: /sys/bus/coresight/devices/<cti-name>/triggers<N>/out_signals
4545
Date: March 2020
4646
KernelVersion 5.7
4747
Contact: Mike Leach or Mathieu Poirier
48-
Description: (R) Output trigger signals to connected device <N>
48+
Description: (Read) Output trigger signals to connected device <N>
4949

5050
What: /sys/bus/coresight/devices/<cti-name>/triggers<N>/out_types
5151
Date: March 2020
5252
KernelVersion 5.7
5353
Contact: Mike Leach or Mathieu Poirier
54-
Description: (R) Functional types for the output trigger signals
54+
Description: (Read) Functional types for the output trigger signals
5555
to connected device <N>
5656

5757
What: /sys/bus/coresight/devices/<cti-name>/regs/inout_sel
@@ -88,7 +88,7 @@ What: /sys/bus/coresight/devices/<cti-name>/regs/intack
8888
Date: March 2020
8989
KernelVersion 5.7
9090
Contact: Mike Leach or Mathieu Poirier
91-
Description: (W) Write the INTACK register.
91+
Description: (Write) Write the INTACK register.
9292

9393
What: /sys/bus/coresight/devices/<cti-name>/regs/appset
9494
Date: March 2020
@@ -101,99 +101,99 @@ What: /sys/bus/coresight/devices/<cti-name>/regs/appclear
101101
Date: March 2020
102102
KernelVersion 5.7
103103
Contact: Mike Leach or Mathieu Poirier
104-
Description: (W) Write APPCLEAR register to deactivate channel.
104+
Description: (Write) Write APPCLEAR register to deactivate channel.
105105

106106
What: /sys/bus/coresight/devices/<cti-name>/regs/apppulse
107107
Date: March 2020
108108
KernelVersion 5.7
109109
Contact: Mike Leach or Mathieu Poirier
110-
Description: (W) Write APPPULSE to pulse a channel active for one clock
110+
Description: (Write) Write APPPULSE to pulse a channel active for one clock
111111
cycle.
112112

113113
What: /sys/bus/coresight/devices/<cti-name>/regs/chinstatus
114114
Date: March 2020
115115
KernelVersion 5.7
116116
Contact: Mike Leach or Mathieu Poirier
117-
Description: (R) Read current status of channel inputs.
117+
Description: (Read) Read current status of channel inputs.
118118

119119
What: /sys/bus/coresight/devices/<cti-name>/regs/choutstatus
120120
Date: March 2020
121121
KernelVersion 5.7
122122
Contact: Mike Leach or Mathieu Poirier
123-
Description: (R) read current status of channel outputs.
123+
Description: (Read) read current status of channel outputs.
124124

125125
What: /sys/bus/coresight/devices/<cti-name>/regs/triginstatus
126126
Date: March 2020
127127
KernelVersion 5.7
128128
Contact: Mike Leach or Mathieu Poirier
129-
Description: (R) read current status of input trigger signals
129+
Description: (Read) read current status of input trigger signals
130130

131131
What: /sys/bus/coresight/devices/<cti-name>/regs/trigoutstatus
132132
Date: March 2020
133133
KernelVersion 5.7
134134
Contact: Mike Leach or Mathieu Poirier
135-
Description: (R) read current status of output trigger signals.
135+
Description: (Read) read current status of output trigger signals.
136136

137137
What: /sys/bus/coresight/devices/<cti-name>/channels/trigin_attach
138138
Date: March 2020
139139
KernelVersion 5.7
140140
Contact: Mike Leach or Mathieu Poirier
141-
Description: (W) Attach a CTI input trigger to a CTM channel.
141+
Description: (Write) Attach a CTI input trigger to a CTM channel.
142142

143143
What: /sys/bus/coresight/devices/<cti-name>/channels/trigin_detach
144144
Date: March 2020
145145
KernelVersion 5.7
146146
Contact: Mike Leach or Mathieu Poirier
147-
Description: (W) Detach a CTI input trigger from a CTM channel.
147+
Description: (Write) Detach a CTI input trigger from a CTM channel.
148148

149149
What: /sys/bus/coresight/devices/<cti-name>/channels/trigout_attach
150150
Date: March 2020
151151
KernelVersion 5.7
152152
Contact: Mike Leach or Mathieu Poirier
153-
Description: (W) Attach a CTI output trigger to a CTM channel.
153+
Description: (Write) Attach a CTI output trigger to a CTM channel.
154154

155155
What: /sys/bus/coresight/devices/<cti-name>/channels/trigout_detach
156156
Date: March 2020
157157
KernelVersion 5.7
158158
Contact: Mike Leach or Mathieu Poirier
159-
Description: (W) Detach a CTI output trigger from a CTM channel.
159+
Description: (Write) Detach a CTI output trigger from a CTM channel.
160160

161161
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_gate_enable
162162
Date: March 2020
163163
KernelVersion 5.7
164164
Contact: Mike Leach or Mathieu Poirier
165-
Description: (RW) Enable CTIGATE for single channel (W) or list enabled
165+
Description: (RW) Enable CTIGATE for single channel (Write) or list enabled
166166
channels through the gate (R).
167167

168168
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_gate_disable
169169
Date: March 2020
170170
KernelVersion 5.7
171171
Contact: Mike Leach or Mathieu Poirier
172-
Description: (W) Disable CTIGATE for single channel.
172+
Description: (Write) Disable CTIGATE for single channel.
173173

174174
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_set
175175
Date: March 2020
176176
KernelVersion 5.7
177177
Contact: Mike Leach or Mathieu Poirier
178-
Description: (W) Activate a single channel.
178+
Description: (Write) Activate a single channel.
179179

180180
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_clear
181181
Date: March 2020
182182
KernelVersion 5.7
183183
Contact: Mike Leach or Mathieu Poirier
184-
Description: (W) Deactivate a single channel.
184+
Description: (Write) Deactivate a single channel.
185185

186186
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_pulse
187187
Date: March 2020
188188
KernelVersion 5.7
189189
Contact: Mike Leach or Mathieu Poirier
190-
Description: (W) Pulse a single channel - activate for a single clock cycle.
190+
Description: (Write) Pulse a single channel - activate for a single clock cycle.
191191

192192
What: /sys/bus/coresight/devices/<cti-name>/channels/trigout_filtered
193193
Date: March 2020
194194
KernelVersion 5.7
195195
Contact: Mike Leach or Mathieu Poirier
196-
Description: (R) List of output triggers filtered across all connections.
196+
Description: (Read) List of output triggers filtered across all connections.
197197

198198
What: /sys/bus/coresight/devices/<cti-name>/channels/trig_filter_enable
199199
Date: March 2020
@@ -205,13 +205,13 @@ What: /sys/bus/coresight/devices/<cti-name>/channels/chan_inuse
205205
Date: March 2020
206206
KernelVersion 5.7
207207
Contact: Mike Leach or Mathieu Poirier
208-
Description: (R) show channels with at least one attached trigger signal.
208+
Description: (Read) show channels with at least one attached trigger signal.
209209

210210
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_free
211211
Date: March 2020
212212
KernelVersion 5.7
213213
Contact: Mike Leach or Mathieu Poirier
214-
Description: (R) show channels with no attached trigger signals.
214+
Description: (Read) show channels with no attached trigger signals.
215215

216216
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_sel
217217
Date: March 2020
@@ -224,18 +224,18 @@ What: /sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_in
224224
Date: March 2020
225225
KernelVersion 5.7
226226
Contact: Mike Leach or Mathieu Poirier
227-
Description: (R) Read to see input triggers connected to selected view
227+
Description: (Read) Read to see input triggers connected to selected view
228228
channel.
229229

230230
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_out
231231
Date: March 2020
232232
KernelVersion 5.7
233233
Contact: Mike Leach or Mathieu Poirier
234-
Description: (R) Read to see output triggers connected to selected view
234+
Description: (Read) Read to see output triggers connected to selected view
235235
channel.
236236

237237
What: /sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_reset
238238
Date: March 2020
239239
KernelVersion 5.7
240240
Contact: Mike Leach or Mathieu Poirier
241-
Description: (W) Clear all channel / trigger programming.
241+
Description: (Write) Clear all channel / trigger programming.

Documentation/ABI/testing/sysfs-bus-coresight-devices-etb10

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/rdp
2323
Date: March 2016
2424
KernelVersion: 4.7
2525
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
26-
Description: (R) Defines the depth, in words, of the trace RAM in powers of
26+
Description: (Read) Defines the depth, in words, of the trace RAM in powers of
2727
2. The value is read directly from HW register RDP, 0x004.
2828

2929
What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/sts
3030
Date: March 2016
3131
KernelVersion: 4.7
3232
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
33-
Description: (R) Shows the value held by the ETB status register. The value
33+
Description: (Read) Shows the value held by the ETB status register. The value
3434
is read directly from HW register STS, 0x00C.
3535

3636
What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/rrp
3737
Date: March 2016
3838
KernelVersion: 4.7
3939
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
40-
Description: (R) Shows the value held by the ETB RAM Read Pointer register
40+
Description: (Read) Shows the value held by the ETB RAM Read Pointer register
4141
that is used to read entries from the Trace RAM over the APB
4242
interface. The value is read directly from HW register RRP,
4343
0x014.
@@ -46,7 +46,7 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/rwp
4646
Date: March 2016
4747
KernelVersion: 4.7
4848
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
49-
Description: (R) Shows the value held by the ETB RAM Write Pointer register
49+
Description: (Read) Shows the value held by the ETB RAM Write Pointer register
5050
that is used to sets the write pointer to write entries from
5151
the CoreSight bus into the Trace RAM. The value is read directly
5252
from HW register RWP, 0x018.
@@ -55,28 +55,28 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/trg
5555
Date: March 2016
5656
KernelVersion: 4.7
5757
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
58-
Description: (R) Similar to "trigger_cntr" above except that this value is
58+
Description: (Read) Similar to "trigger_cntr" above except that this value is
5959
read directly from HW register TRG, 0x01C.
6060

6161
What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/ctl
6262
Date: March 2016
6363
KernelVersion: 4.7
6464
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
65-
Description: (R) Shows the value held by the ETB Control register. The value
65+
Description: (Read) Shows the value held by the ETB Control register. The value
6666
is read directly from HW register CTL, 0x020.
6767

6868
What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/ffsr
6969
Date: March 2016
7070
KernelVersion: 4.7
7171
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
72-
Description: (R) Shows the value held by the ETB Formatter and Flush Status
72+
Description: (Read) Shows the value held by the ETB Formatter and Flush Status
7373
register. The value is read directly from HW register FFSR,
7474
0x300.
7575

7676
What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/ffcr
7777
Date: March 2016
7878
KernelVersion: 4.7
7979
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
80-
Description: (R) Shows the value held by the ETB Formatter and Flush Control
80+
Description: (Read) Shows the value held by the ETB Formatter and Flush Control
8181
register. The value is read directly from HW register FFCR,
8282
0x304.

Documentation/ABI/testing/sysfs-bus-coresight-devices-etm3x

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,28 +146,28 @@ What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_addr_cmp
146146
Date: November 2014
147147
KernelVersion: 3.19
148148
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
149-
Description: (R) Provides the number of address comparators pairs accessible
149+
Description: (Read) Provides the number of address comparators pairs accessible
150150
on a trace unit, as specified by bit 3:0 of register ETMCCR.
151151

152152
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_cntr
153153
Date: November 2014
154154
KernelVersion: 3.19
155155
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
156-
Description: (R) Provides the number of counters accessible on a trace unit,
156+
Description: (Read) Provides the number of counters accessible on a trace unit,
157157
as specified by bit 15:13 of register ETMCCR.
158158

159159
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_ctxid_cmp
160160
Date: November 2014
161161
KernelVersion: 3.19
162162
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
163-
Description: (R) Provides the number of context ID comparator available on a
163+
Description: (Read) Provides the number of context ID comparator available on a
164164
trace unit, as specified by bit 25:24 of register ETMCCR.
165165

166166
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/reset
167167
Date: November 2014
168168
KernelVersion: 3.19
169169
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
170-
Description: (W) Cancels all configuration on a trace unit and set it back
170+
Description: (Write) Cancels all configuration on a trace unit and set it back
171171
to its boot configuration.
172172

173173
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_12_event
@@ -216,7 +216,7 @@ What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/curr_seq_state
216216
Date: November 2014
217217
KernelVersion: 3.19
218218
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
219-
Description: (R) Holds the current state of the sequencer.
219+
Description: (Read) Holds the current state of the sequencer.
220220

221221
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/sync_freq
222222
Date: November 2014

0 commit comments

Comments
 (0)