Commit 98913408 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman

docs: ABI: stable: make files ReST compatible

Several entries at the stable ABI files won't parse if we pass
them directly to the ReST output.

Adjust them, in order to allow adding their contents as-is at
the stable ABI book.
Acked-by: default avatarSrinivas Kandagatla <srinivas.kandagatla@linaro.org>
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/467a0dfbcdf00db710a629d3fe4a2563750339d8.1604042072.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent c7e45ea4
...@@ -14,12 +14,14 @@ Description: ...@@ -14,12 +14,14 @@ Description:
Each /dev/fw* is associated with one IEEE 1394 node, which can Each /dev/fw* is associated with one IEEE 1394 node, which can
be remote or local nodes. Operations on a /dev/fw* file have be remote or local nodes. Operations on a /dev/fw* file have
different scope: different scope:
- The 1394 node which is associated with the file: - The 1394 node which is associated with the file:
- Asynchronous request transmission - Asynchronous request transmission
- Get the Configuration ROM - Get the Configuration ROM
- Query node ID - Query node ID
- Query maximum speed of the path between this node - Query maximum speed of the path between this node
and local node and local node
- The 1394 bus (i.e. "card") to which the node is attached to: - The 1394 bus (i.e. "card") to which the node is attached to:
- Isochronous stream transmission and reception - Isochronous stream transmission and reception
- Asynchronous stream transmission and reception - Asynchronous stream transmission and reception
...@@ -31,6 +33,7 @@ Description: ...@@ -31,6 +33,7 @@ Description:
manager manager
- Query cycle time - Query cycle time
- Bus reset initiation, bus reset event reception - Bus reset initiation, bus reset event reception
- All 1394 buses: - All 1394 buses:
- Allocation of IEEE 1212 address ranges on the local - Allocation of IEEE 1212 address ranges on the local
link layers, reception of inbound requests to such link layers, reception of inbound requests to such
...@@ -43,6 +46,7 @@ Description: ...@@ -43,6 +46,7 @@ Description:
userland implement different access permission models, some userland implement different access permission models, some
operations are restricted to /dev/fw* files that are associated operations are restricted to /dev/fw* files that are associated
with a local node: with a local node:
- Addition of descriptors or directories to the local - Addition of descriptors or directories to the local
nodes' Configuration ROM nodes' Configuration ROM
- PHY packet transmission and reception - PHY packet transmission and reception
......
...@@ -6,11 +6,14 @@ Description: The ACPI pm_profile sysfs interface exports the platform ...@@ -6,11 +6,14 @@ Description: The ACPI pm_profile sysfs interface exports the platform
power management (and performance) requirement expectations power management (and performance) requirement expectations
as provided by BIOS. The integer value is directly passed as as provided by BIOS. The integer value is directly passed as
retrieved from the FADT ACPI table. retrieved from the FADT ACPI table.
Values: For possible values see ACPI specification: Values: For possible values see ACPI specification:
5.2.9 Fixed ACPI Description Table (FADT) 5.2.9 Fixed ACPI Description Table (FADT)
Field: Preferred_PM_Profile Field: Preferred_PM_Profile
Currently these values are defined by spec: Currently these values are defined by spec:
== =================
0 Unspecified 0 Unspecified
1 Desktop 1 Desktop
2 Mobile 2 Mobile
...@@ -20,3 +23,4 @@ Values: For possible values see ACPI specification: ...@@ -20,3 +23,4 @@ Values: For possible values see ACPI specification:
6 Appliance PC 6 Appliance PC
7 Performance Server 7 Performance Server
>7 Reserved >7 Reserved
== =================
...@@ -47,6 +47,7 @@ Description: ...@@ -47,6 +47,7 @@ Description:
IEEE 1394 node device attribute. IEEE 1394 node device attribute.
Read-only and immutable. Read-only and immutable.
Values: 1: The sysfs entry represents a local node (a controller card). Values: 1: The sysfs entry represents a local node (a controller card).
0: The sysfs entry represents a remote node. 0: The sysfs entry represents a remote node.
...@@ -125,7 +126,9 @@ Description: ...@@ -125,7 +126,9 @@ Description:
Read-only attribute, immutable during the target's lifetime. Read-only attribute, immutable during the target's lifetime.
Format, as exposed by firewire-sbp2 since 2.6.22, May 2007: Format, as exposed by firewire-sbp2 since 2.6.22, May 2007:
Colon-separated hexadecimal string representations of Colon-separated hexadecimal string representations of
u64 EUI-64 : u24 directory_ID : u16 LUN u64 EUI-64 : u24 directory_ID : u16 LUN
without 0x prefixes, without whitespace. The former sbp2 driver without 0x prefixes, without whitespace. The former sbp2 driver
(removed in 2.6.37 after being superseded by firewire-sbp2) used (removed in 2.6.37 after being superseded by firewire-sbp2) used
a somewhat shorter format which was not as close to SAM. a somewhat shorter format which was not as close to SAM.
......
...@@ -9,7 +9,8 @@ Description: ...@@ -9,7 +9,8 @@ Description:
Note: This file is only present if CONFIG_NVMEM_SYSFS Note: This file is only present if CONFIG_NVMEM_SYSFS
is enabled is enabled
ex: ex::
hexdump /sys/bus/nvmem/devices/qfprom0/nvmem hexdump /sys/bus/nvmem/devices/qfprom0/nvmem
0000000 0000 0000 0000 0000 0000 0000 0000 0000 0000000 0000 0000 0000 0000 0000 0000 0000 0000
......
...@@ -50,8 +50,10 @@ Description: ...@@ -50,8 +50,10 @@ Description:
Tools can use this file and the connected_duration file to Tools can use this file and the connected_duration file to
compute the percentage of time that a device has been active. compute the percentage of time that a device has been active.
For example, For example::
echo $((100 * `cat active_duration` / `cat connected_duration`)) echo $((100 * `cat active_duration` / `cat connected_duration`))
will give an integer percentage. Note that this does not will give an integer percentage. Note that this does not
account for counter wrap. account for counter wrap.
Users: Users:
......
...@@ -4,6 +4,7 @@ KernelVersion: 2.6.12 ...@@ -4,6 +4,7 @@ KernelVersion: 2.6.12
Contact: Richard Purdie <rpurdie@rpsys.net> Contact: Richard Purdie <rpurdie@rpsys.net>
Description: Description:
Control BACKLIGHT power, values are FB_BLANK_* from fb.h Control BACKLIGHT power, values are FB_BLANK_* from fb.h
- FB_BLANK_UNBLANK (0) : power on. - FB_BLANK_UNBLANK (0) : power on.
- FB_BLANK_POWERDOWN (4) : power off - FB_BLANK_POWERDOWN (4) : power off
Users: HAL Users: HAL
......
...@@ -2,7 +2,7 @@ rfkill - radio frequency (RF) connector kill switch support ...@@ -2,7 +2,7 @@ rfkill - radio frequency (RF) connector kill switch support
For details to this subsystem look at Documentation/driver-api/rfkill.rst. For details to this subsystem look at Documentation/driver-api/rfkill.rst.
For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in For the deprecated ``/sys/class/rfkill/*/claim`` knobs of this interface look in
Documentation/ABI/removed/sysfs-class-rfkill. Documentation/ABI/removed/sysfs-class-rfkill.
What: /sys/class/rfkill What: /sys/class/rfkill
...@@ -36,9 +36,10 @@ KernelVersion v2.6.22 ...@@ -36,9 +36,10 @@ KernelVersion v2.6.22
Contact: linux-wireless@vger.kernel.org Contact: linux-wireless@vger.kernel.org
Description: Whether the soft blocked state is initialised from non-volatile Description: Whether the soft blocked state is initialised from non-volatile
storage at startup. storage at startup.
Values: A numeric value. Values: A numeric value:
0: false
1: true - 0: false
- 1: true
What: /sys/class/rfkill/rfkill[0-9]+/state What: /sys/class/rfkill/rfkill[0-9]+/state
...@@ -54,6 +55,7 @@ Description: Current state of the transmitter. ...@@ -54,6 +55,7 @@ Description: Current state of the transmitter.
through this interface. There will likely be another attempt to through this interface. There will likely be another attempt to
remove it in the future. remove it in the future.
Values: A numeric value. Values: A numeric value.
0: RFKILL_STATE_SOFT_BLOCKED 0: RFKILL_STATE_SOFT_BLOCKED
transmitter is turned off by software transmitter is turned off by software
1: RFKILL_STATE_UNBLOCKED 1: RFKILL_STATE_UNBLOCKED
...@@ -69,6 +71,7 @@ KernelVersion v2.6.34 ...@@ -69,6 +71,7 @@ KernelVersion v2.6.34
Contact: linux-wireless@vger.kernel.org Contact: linux-wireless@vger.kernel.org
Description: Current hardblock state. This file is read only. Description: Current hardblock state. This file is read only.
Values: A numeric value. Values: A numeric value.
0: inactive 0: inactive
The transmitter is (potentially) active. The transmitter is (potentially) active.
1: active 1: active
...@@ -82,7 +85,9 @@ KernelVersion v2.6.34 ...@@ -82,7 +85,9 @@ KernelVersion v2.6.34
Contact: linux-wireless@vger.kernel.org Contact: linux-wireless@vger.kernel.org
Description: Current softblock state. This file is read and write. Description: Current softblock state. This file is read and write.
Values: A numeric value. Values: A numeric value.
0: inactive 0: inactive
The transmitter is (potentially) active. The transmitter is (potentially) active.
1: active 1: active
The transmitter is turned off by software. The transmitter is turned off by software.
...@@ -32,7 +32,7 @@ KernelVersion: 2.6.12 ...@@ -32,7 +32,7 @@ KernelVersion: 2.6.12
Contact: linux-integrity@vger.kernel.org Contact: linux-integrity@vger.kernel.org
Description: The "caps" property contains TPM manufacturer and version info. Description: The "caps" property contains TPM manufacturer and version info.
Example output: Example output::
Manufacturer: 0x53544d20 Manufacturer: 0x53544d20
TCG version: 1.2 TCG version: 1.2
...@@ -54,7 +54,7 @@ Description: The "durations" property shows the 3 vendor-specific values ...@@ -54,7 +54,7 @@ Description: The "durations" property shows the 3 vendor-specific values
any longer than necessary before starting to poll for a any longer than necessary before starting to poll for a
result. result.
Example output: Example output::
3015000 4508000 180995000 [original] 3015000 4508000 180995000 [original]
...@@ -92,7 +92,7 @@ Description: The "pcrs" property will dump the current value of all Platform ...@@ -92,7 +92,7 @@ Description: The "pcrs" property will dump the current value of all Platform
values may be constantly changing, the output is only valid values may be constantly changing, the output is only valid
for a snapshot in time. for a snapshot in time.
Example output: Example output::
PCR-00: 3A 3F 78 0F 11 A4 B4 99 69 FC AA 80 CD 6E 39 57 C3 3B 22 75 PCR-00: 3A 3F 78 0F 11 A4 B4 99 69 FC AA 80 CD 6E 39 57 C3 3B 22 75
PCR-01: 3A 3F 78 0F 11 A4 B4 99 69 FC AA 80 CD 6E 39 57 C3 3B 22 75 PCR-01: 3A 3F 78 0F 11 A4 B4 99 69 FC AA 80 CD 6E 39 57 C3 3B 22 75
...@@ -119,7 +119,7 @@ Description: The "pubek" property will return the TPM's public endorsement ...@@ -119,7 +119,7 @@ Description: The "pubek" property will return the TPM's public endorsement
ated at TPM manufacture time and exists for the life of the ated at TPM manufacture time and exists for the life of the
chip. chip.
Example output: Example output::
Algorithm: 00 00 00 01 Algorithm: 00 00 00 01
Encscheme: 00 03 Encscheme: 00 03
...@@ -144,7 +144,7 @@ Description: The "pubek" property will return the TPM's public endorsement ...@@ -144,7 +144,7 @@ Description: The "pubek" property will return the TPM's public endorsement
F7 02 71 CF 15 AE 16 DD D1 C1 8E A8 CF 9B 50 7B F7 02 71 CF 15 AE 16 DD D1 C1 8E A8 CF 9B 50 7B
C3 91 FF 44 1E CF 7C 39 FE 17 77 21 20 BD CE 9B C3 91 FF 44 1E CF 7C 39 FE 17 77 21 20 BD CE 9B
Possible values: Possible values::
Algorithm: TPM_ALG_RSA (1) Algorithm: TPM_ALG_RSA (1)
Encscheme: TPM_ES_RSAESPKCSv15 (2) Encscheme: TPM_ES_RSAESPKCSv15 (2)
...@@ -176,7 +176,7 @@ Description: The "timeouts" property shows the 4 vendor-specific values ...@@ -176,7 +176,7 @@ Description: The "timeouts" property shows the 4 vendor-specific values
timeouts is defined by the TPM interface spec that the chip timeouts is defined by the TPM interface spec that the chip
conforms to. conforms to.
Example output: Example output::
750000 750000 750000 750000 [original] 750000 750000 750000 750000 [original]
......
# Note: This documents additional properties of any device beyond what Note:
# is documented in Documentation/admin-guide/sysfs-rules.rst This documents additional properties of any device beyond what
is documented in Documentation/admin-guide/sysfs-rules.rst
What: /sys/devices/*/of_node What: /sys/devices/*/of_node
Date: February 2015 Date: February 2015
......
...@@ -6,6 +6,7 @@ Description: Interface for making ib_srp connect to a new target. ...@@ -6,6 +6,7 @@ Description: Interface for making ib_srp connect to a new target.
One can request ib_srp to connect to a new target by writing One can request ib_srp to connect to a new target by writing
a comma-separated list of login parameters to this sysfs a comma-separated list of login parameters to this sysfs
attribute. The supported parameters are: attribute. The supported parameters are:
* id_ext, a 16-digit hexadecimal number specifying the eight * id_ext, a 16-digit hexadecimal number specifying the eight
byte identifier extension in the 16-byte SRP target port byte identifier extension in the 16-byte SRP target port
identifier. The target port identifier is sent by ib_srp identifier. The target port identifier is sent by ib_srp
......
...@@ -17,6 +17,7 @@ Description: ...@@ -17,6 +17,7 @@ Description:
directory has a name of the form "<key>-<vendor guid>" directory has a name of the form "<key>-<vendor guid>"
and contains the following files: and contains the following files:
=============== ========================================
attributes: A read-only text file enumerating the attributes: A read-only text file enumerating the
EFI variable flags. Potential values EFI variable flags. Potential values
include: include:
...@@ -59,12 +60,14 @@ Description: ...@@ -59,12 +60,14 @@ Description:
size: As ASCII representation of the size of size: As ASCII representation of the size of
the variable's value. the variable's value.
=============== ========================================
In addition, two other magic binary files are provided In addition, two other magic binary files are provided
in the top-level directory and are used for adding and in the top-level directory and are used for adding and
removing variables: removing variables:
=============== ========================================
new_var: Takes a "struct efi_variable" and new_var: Takes a "struct efi_variable" and
instructs the EFI firmware to create a instructs the EFI firmware to create a
new variable. new variable.
...@@ -73,3 +76,4 @@ Description: ...@@ -73,3 +76,4 @@ Description:
instructs the EFI firmware to remove any instructs the EFI firmware to remove any
variable that has a matching vendor GUID variable that has a matching vendor GUID
and variable key name. and variable key name.
=============== ========================================
...@@ -7,6 +7,7 @@ Description: ...@@ -7,6 +7,7 @@ Description:
This is only for the powerpc/powernv platform. This is only for the powerpc/powernv platform.
=============== ===============================================
initiate_dump: When '1' is written to it, initiate_dump: When '1' is written to it,
we will initiate a dump. we will initiate a dump.
Read this file for supported commands. Read this file for supported commands.
...@@ -19,8 +20,11 @@ Description: ...@@ -19,8 +20,11 @@ Description:
and ID of the dump, use the id and type files. and ID of the dump, use the id and type files.
Do not rely on any particular size of dump Do not rely on any particular size of dump
type or dump id. type or dump id.
=============== ===============================================
Each dump has the following files: Each dump has the following files:
=============== ===============================================
id: An ASCII representation of the dump ID id: An ASCII representation of the dump ID
in hex (e.g. '0x01') in hex (e.g. '0x01')
type: An ASCII representation of the type of type: An ASCII representation of the type of
...@@ -39,3 +43,4 @@ Description: ...@@ -39,3 +43,4 @@ Description:
inaccessible. inaccessible.
Reading this file will get a list of Reading this file will get a list of
supported actions. supported actions.
=============== ===============================================
...@@ -38,6 +38,7 @@ Description: ...@@ -38,6 +38,7 @@ Description:
For each log entry (directory), there are the following For each log entry (directory), there are the following
files: files:
============== ================================================
id: An ASCII representation of the ID of the id: An ASCII representation of the ID of the
error log, in hex - e.g. "0x01". error log, in hex - e.g. "0x01".
...@@ -58,3 +59,4 @@ Description: ...@@ -58,3 +59,4 @@ Description:
entry will be removed from sysfs. entry will be removed from sysfs.
Reading this file will list the supported Reading this file will list the supported
operations (currently just acknowledge). operations (currently just acknowledge).
============== ================================================
...@@ -33,6 +33,8 @@ Description: If running under Xen: ...@@ -33,6 +33,8 @@ Description: If running under Xen:
Space separated list of supported guest system types. Each type Space separated list of supported guest system types. Each type
is in the format: <class>-<major>.<minor>-<arch> is in the format: <class>-<major>.<minor>-<arch>
With: With:
======== ============================================
<class>: "xen" -- x86: paravirtualized, arm: standard <class>: "xen" -- x86: paravirtualized, arm: standard
"hvm" -- x86 only: fully virtualized "hvm" -- x86 only: fully virtualized
<major>: major guest interface version <major>: major guest interface version
...@@ -43,6 +45,7 @@ Description: If running under Xen: ...@@ -43,6 +45,7 @@ Description: If running under Xen:
"x86_64": 64 bit x86 guest "x86_64": 64 bit x86 guest
"armv7l": 32 bit arm guest "armv7l": 32 bit arm guest
"aarch64": 64 bit arm guest "aarch64": 64 bit arm guest
======== ============================================
What: /sys/hypervisor/properties/changeset What: /sys/hypervisor/properties/changeset
Date: March 2009 Date: March 2009
......
...@@ -23,6 +23,7 @@ Unless otherwise noted, the set of symbols with any given version and the ...@@ -23,6 +23,7 @@ Unless otherwise noted, the set of symbols with any given version and the
ABI of those symbols is considered stable. It may vary across architectures, ABI of those symbols is considered stable. It may vary across architectures,
though. though.
(As of this writing, this ABI documentation as been confirmed for x86_64. Note:
As of this writing, this ABI documentation as been confirmed for x86_64.
The maintainers of the other vDSO-using architectures should confirm The maintainers of the other vDSO-using architectures should confirm
that it is correct for their architecture.) that it is correct for their architecture.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment