docs: ABI: fix syntax to be parsed using ReST notation (002a9c2f) · Commits · 戴 / test

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

+37 −25

Original line number	Diff line number	Diff line
		@@ -12,11 +12,13 @@ Description:
		resets. Three registers are used by the FSBL and
		other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.

		Usage:
		Usage::

		# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
		# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0

		Example:
		Example::

		# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
		# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0

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

		Usage:
		Usage::

		# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
		# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0

		Example:
		Example::

		# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
		# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0

		@@ -61,21 +65,26 @@ Description:

		Following are available shutdown scopes(subtypes):

		subsystem: Only the APU along with all of its peripherals
		subsystem:
		Only the APU along with all of its peripherals
		not used by other processing units will be
		shut down. This may result in the FPD power
		domain being shut down provided that no other
		processing unit uses FPD peripherals or DRAM.
		ps_only: The complete PS will be shut down, including the
		ps_only:
		The complete PS will be shut down, including the
		RPU, PMU, etc. Only the PL domain (FPGA)
		remains untouched.
		system: The complete system/device is shut down.
		system:
		The complete system/device is shut down.

		Usage::

		Usage:
		# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
		# echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope

		Example:
		Example::

		# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
		# echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope

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

		Usage:
		Set healthy bit

		Set healthy bit::

		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status

		Unset healthy bit
		Unset healthy bit::

		# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status

		Users: Xilinx

Documentation/ABI/testing/debugfs-moxtet

+20 −8

Original line number	Diff line number	Diff line
		@@ -5,10 +5,16 @@ Contact: Marek Behún <marek.behun@nic.cz>
		Description: (R) 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.
		Example: 101214
		10: CPU board with SD card
		12: 2 = PCIe module, 1 = IRQ not active
		14: 4 = Peridot module, 1 = IRQ not active

		Example::

		101214

		== =======================================
		10 CPU board with SD card
		12 2 = PCIe module, 1 = IRQ not active
		14 4 = Peridot module, 1 = IRQ not active
		== =======================================

		What: /sys/kernel/debug/moxtet/output
		Date: March 2019
		@@ -17,7 +23,13 @@ Contact: Marek Behún <marek.behun@nic.cz>
		Description: (RW) Read last written value to the shift registers, in
		hexadecimal, or write values to the shift registers, also
		in hexadecimal.
		Example: 0102
		01: 01 was last written, or is to be written, to the

		Example::

		0102

		== ================================================
		01 01 was last written, or is to be written, to the
		first module's shift register
		02: the same for second module
		02 the same for second module
		== ================================================

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

+4 −2

Original line number	Diff line number	Diff line
		@@ -2,8 +2,10 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign
		Date: Jun 2020
		KernelVersion: 5.8
		Contact: Marek Behún <marek.behun@nic.cz>
		Description: (W) Message to sign with the ECDSA private key stored in
		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
		(R)
		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-event_source-devices-dfl_fme

+7 −7

Original line number	Diff line number	Diff line
		@@ -8,13 +8,13 @@ Description: Read-only. Attribute group to describe the magic bits

		Each attribute under this group defines a bit range of the
		perf_event_attr.config. All supported attributes are listed
		below.
		below::

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

		For example,
		For example::

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

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

		All supported performance monitoring events are listed below.

		Basic events (evtype=0x00)
		Basic events (evtype=0x00)::

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

		Cache events (evtype=0x01)
		Cache events (evtype=0x01)::

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

		Fabric events (evtype=0x02)
		Fabric events (evtype=0x02)::

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

		VTD events (evtype=0x03)
		VTD events (evtype=0x03)::

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

		VTD SIP events (evtype=0x04)
		VTD SIP events (evtype=0x04)::

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

Documentation/ABI/testing/sysfs-bus-most

+4 −2

Original line number	Diff line number	Diff line
		@@ -235,7 +235,8 @@ KernelVersion: 4.15
		Contact: Christian Gromm <christian.gromm@microchip.com>
		Description:
		This is to read back the configured direction of the channel.
		The following strings will be accepted:
		The following strings will be accepted::

		'tx',
		'rx'
		Users:
		@@ -246,7 +247,8 @@ KernelVersion: 4.15
		Contact: Christian Gromm <christian.gromm@microchip.com>
		Description:
		This is to read back the configured data type of the channel.
		The following strings will be accepted:
		The following strings will be accepted::

		'control',
		'async',
		'sync',

Admin message