Commit 4119f0df authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

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: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6e81ad8064f3ed4f8dc265086fdf1c618043f935.1604042072.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 54a19b4d

Documentation/ABI/testing/debugfs-moxtet

+1 −1
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ What: /sys/kernel/debug/moxtet/input 
Date:		March 2019

KernelVersion:	5.3

Contact:	Marek Behún <marek.behun@nic.cz>

Description:	(R) Read input from the shift registers, in hexadecimal.

Description:	(Read) Read input from the shift registers, in hexadecimal.

		Returns N+1 bytes, where N is the number of Moxtet connected

		modules. The first byte is from the CPU board itself.

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

+8 −7
Original line number Diff line number Diff line
@@ -4,10 +4,11 @@ KernelVersion: 5.8 
Contact:	Marek Behún <marek.behun@nic.cz>

Description:



		=== ===========================================================

		(W) Message to sign with the ECDSA private key stored in

		    device's OTP. The message must be exactly 64 bytes (since

		    this is intended for SHA-512 hashes).

		(R) The resulting signature, 136 bytes. This contains the R and

		    S values of the ECDSA signature, both in big-endian format.

		=== ===========================================================
 
		======= ===========================================================

		(Write) Message to sign with the ECDSA private key stored in

		        device's OTP. The message must be exactly 64 bytes

		        (since this is intended for SHA-512 hashes).

		(Read)  The resulting signature, 136 bytes. This contains the

			R and S values of the ECDSA signature, both in

			big-endian format.

		======= ===========================================================

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

+30 −30
Original line number Diff line number Diff line
@@ -8,50 +8,50 @@ What: /sys/bus/coresight/devices/<cti-name>/powered 
Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Indicate if the CTI hardware is powered.

Description:	(Read) Indicate if the CTI hardware is powered.



What:		/sys/bus/coresight/devices/<cti-name>/ctmid

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Display the associated CTM ID

Description:	(Read) Display the associated CTM ID



What:		/sys/bus/coresight/devices/<cti-name>/nr_trigger_cons

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Number of devices connected to triggers on this CTI

Description:	(Read) Number of devices connected to triggers on this CTI



What:		/sys/bus/coresight/devices/<cti-name>/triggers<N>/name

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Name of connected device <N>

Description:	(Read) Name of connected device <N>



What:		/sys/bus/coresight/devices/<cti-name>/triggers<N>/in_signals

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Input trigger signals from connected device <N>

Description:	(Read) Input trigger signals from connected device <N>



What:		/sys/bus/coresight/devices/<cti-name>/triggers<N>/in_types

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Functional types for the input trigger signals

Description:	(Read) Functional types for the input trigger signals

		from connected device <N>



What:		/sys/bus/coresight/devices/<cti-name>/triggers<N>/out_signals

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Output trigger signals to connected device <N>

Description:	(Read) Output trigger signals to connected device <N>



What:		/sys/bus/coresight/devices/<cti-name>/triggers<N>/out_types

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Functional types for the output trigger signals

Description:	(Read) Functional types for the output trigger signals

		to connected device <N>



What:		/sys/bus/coresight/devices/<cti-name>/regs/inout_sel
@@ -88,7 +88,7 @@ What: /sys/bus/coresight/devices/<cti-name>/regs/intack 
Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Write the INTACK register.

Description:	(Write) Write the INTACK register.



What:		/sys/bus/coresight/devices/<cti-name>/regs/appset

Date:		March 2020
@@ -101,99 +101,99 @@ What: /sys/bus/coresight/devices/<cti-name>/regs/appclear 
Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Write APPCLEAR register to deactivate channel.

Description:	(Write) Write APPCLEAR register to deactivate channel.



What:		/sys/bus/coresight/devices/<cti-name>/regs/apppulse

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Write APPPULSE to pulse a channel active for one clock

Description:	(Write) Write APPPULSE to pulse a channel active for one clock

		cycle.



What:		/sys/bus/coresight/devices/<cti-name>/regs/chinstatus

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Read current status of channel inputs.

Description:	(Read) Read current status of channel inputs.



What:		/sys/bus/coresight/devices/<cti-name>/regs/choutstatus

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) read current status of channel outputs.

Description:	(Read) read current status of channel outputs.



What:		/sys/bus/coresight/devices/<cti-name>/regs/triginstatus

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) read current status of input trigger signals

Description:	(Read) read current status of input trigger signals



What:		/sys/bus/coresight/devices/<cti-name>/regs/trigoutstatus

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) read current status of output trigger signals.

Description:	(Read) read current status of output trigger signals.



What:		/sys/bus/coresight/devices/<cti-name>/channels/trigin_attach

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Attach a CTI input trigger to a CTM channel.

Description:	(Write) Attach a CTI input trigger to a CTM channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/trigin_detach

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Detach a CTI input trigger from a CTM channel.

Description:	(Write) Detach a CTI input trigger from a CTM channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/trigout_attach

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Attach a CTI output trigger to a CTM channel.

Description:	(Write) Attach a CTI output trigger to a CTM channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/trigout_detach

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Detach a CTI output trigger from a CTM channel.

Description:	(Write) Detach a CTI output trigger from a CTM channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_gate_enable

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(RW) Enable CTIGATE for single channel (W) or list enabled

Description:	(RW) Enable CTIGATE for single channel (Write) or list enabled

		channels through the gate (R).



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_gate_disable

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Disable CTIGATE for single channel.

Description:	(Write) Disable CTIGATE for single channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_set

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Activate a single channel.

Description:	(Write) Activate a single channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_clear

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Deactivate a single channel.

Description:	(Write) Deactivate a single channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_pulse

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Pulse a single channel - activate for a single clock cycle.

Description:	(Write) Pulse a single channel - activate for a single clock cycle.



What:		/sys/bus/coresight/devices/<cti-name>/channels/trigout_filtered

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) List of output triggers filtered across all connections.

Description:	(Read) List of output triggers filtered across all connections.



What:		/sys/bus/coresight/devices/<cti-name>/channels/trig_filter_enable

Date:		March 2020
@@ -205,13 +205,13 @@ What: /sys/bus/coresight/devices/<cti-name>/channels/chan_inuse 
Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) show channels with at least one attached trigger signal.

Description:	(Read) show channels with at least one attached trigger signal.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_free

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) show channels with no attached trigger signals.

Description:	(Read) show channels with no attached trigger signals.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_sel

Date:		March 2020
@@ -224,18 +224,18 @@ What: /sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_in 
Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Read to see input triggers connected to selected view

Description:	(Read) Read to see input triggers connected to selected view

		channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_out

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(R) Read to see output triggers connected to selected view

Description:	(Read) Read to see output triggers connected to selected view

		channel.



What:		/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_reset

Date:		March 2020

KernelVersion	5.7

Contact:	Mike Leach or Mathieu Poirier

Description:	(W) Clear all channel / trigger programming.
 
Description:	(Write) Clear all channel / trigger programming.

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

+8 −8
Original line number Diff line number Diff line
@@ -23,21 +23,21 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/rdp 
Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Defines the depth, in words, of the trace RAM in powers of

Description:	(Read) Defines the depth, in words, of the trace RAM in powers of

		2.  The value is read directly from HW register RDP, 0x004.



What:		/sys/bus/coresight/devices/<memory_map>.etb/mgmt/sts

Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Shows the value held by the ETB status register.  The value

Description:	(Read) Shows the value held by the ETB status register.  The value

		is read directly from HW register STS, 0x00C.



What:		/sys/bus/coresight/devices/<memory_map>.etb/mgmt/rrp

Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Shows the value held by the ETB RAM Read Pointer register

Description:	(Read) Shows the value held by the ETB RAM Read Pointer register

		that is used to read entries from the Trace RAM over the APB

		interface.  The value is read directly from HW register RRP,

		0x014.
@@ -46,7 +46,7 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/rwp 
Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Shows the value held by the ETB RAM Write Pointer register

Description:	(Read) Shows the value held by the ETB RAM Write Pointer register

		that is used to sets the write pointer to write entries from

		the CoreSight bus into the Trace RAM. The value is read directly

		from HW register RWP, 0x018.
@@ -55,21 +55,21 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/trg 
Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Similar to "trigger_cntr" above except that this value is

Description:	(Read) Similar to "trigger_cntr" above except that this value is

		read directly from HW register TRG, 0x01C.



What:		/sys/bus/coresight/devices/<memory_map>.etb/mgmt/ctl

Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Shows the value held by the ETB Control register. The value

Description:	(Read) Shows the value held by the ETB Control register. The value

		is read directly from HW register CTL, 0x020.



What:		/sys/bus/coresight/devices/<memory_map>.etb/mgmt/ffsr

Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Shows the value held by the ETB Formatter and Flush Status

Description:	(Read) Shows the value held by the ETB Formatter and Flush Status

		register.  The value is read directly from HW register FFSR,

		0x300.
@@ -77,6 +77,6 @@ What: /sys/bus/coresight/devices/<memory_map>.etb/mgmt/ffcr 
Date:		March 2016

KernelVersion:	4.7

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description:	(R) Shows the value held by the ETB Formatter and Flush Control

Description:	(Read) Shows the value held by the ETB Formatter and Flush Control

		register.  The value is read directly from HW register FFCR,

		0x304.

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

+5 −5
Original line number Diff line number Diff line
@@ -146,28 +146,28 @@ What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_addr_cmp 
Date:		November 2014

KernelVersion:	3.19

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description: 	(R) Provides the number of address comparators pairs accessible

Description: 	(Read) Provides the number of address comparators pairs accessible

		on a trace unit, as specified by bit 3:0 of register ETMCCR.



What:		/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_cntr

Date:		November 2014

KernelVersion:	3.19

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description: 	(R) Provides the number of counters accessible on a trace unit,

Description: 	(Read) Provides the number of counters accessible on a trace unit,

		as specified by bit 15:13 of register ETMCCR.



What:		/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_ctxid_cmp

Date:		November 2014

KernelVersion:	3.19

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description: 	(R) Provides the number of context ID comparator available on a

Description: 	(Read) Provides the number of context ID comparator available on a

		trace unit, as specified by bit 25:24 of register ETMCCR.



What:		/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/reset

Date:		November 2014

KernelVersion:	3.19

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description: 	(W) Cancels all configuration on a trace unit and set it back

Description: 	(Write) Cancels all configuration on a trace unit and set it back

		to its boot configuration.



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 
Date:		November 2014

KernelVersion:	3.19

Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>

Description: 	(R) Holds the current state of the sequencer.

Description: 	(Read) Holds the current state of the sequencer.



What:		/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/sync_freq

Date:		November 2014

CRA Git | Maintained and supported by SUSTech CRA and CCSE