Documentation/ABI: Fix typos

Fix typos in Documentation/ABI.  The changes are in descriptions or
comments where they shouldn't affect use of the ABIs.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230814212822.193684-2-helgaas@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Bjorn Helgaas 2023-08-14 16:28:20 -05:00 committed by Jonathan Corbet
parent 0ef5de7b1e
commit ebab9426cd
35 changed files with 46 additions and 46 deletions

View File

@ -295,7 +295,7 @@ Description:
capable of executing requests targeting different sector ranges capable of executing requests targeting different sector ranges
in parallel. For instance, single LUN multi-actuator hard-disks in parallel. For instance, single LUN multi-actuator hard-disks
will have an independent_access_ranges directory if the device will have an independent_access_ranges directory if the device
correctly advertizes the sector ranges of its actuators. correctly advertises the sector ranges of its actuators.
The independent_access_ranges directory contains one directory The independent_access_ranges directory contains one directory
per access range, with each range described using the sector per access range, with each range described using the sector

View File

@ -356,7 +356,7 @@ Description:
pkeys/<n>: (RO) Displays the contents of the physical pkeys/<n>: (RO) Displays the contents of the physical
key table n = 0..126 key table n = 0..126
mcgs/: (RO) Muticast group table mcgs/: (RO) Multicast group table
<m>/gid_idx/0: (RO) Display the GID mapping m = 1..2 <m>/gid_idx/0: (RO) Display the GID mapping m = 1..2

View File

@ -2,6 +2,6 @@ What: /sys/bus/wmi/devices/05901221-D566-11D1-B2F0-00A0C9062910[-X]/bmof
Date: Jun 2017 Date: Jun 2017
KernelVersion: 4.13 KernelVersion: 4.13
Description: Description:
Binary MOF metadata used to decribe the details of available ACPI WMI interfaces. Binary MOF metadata used to describe the details of available ACPI WMI interfaces.
See Documentation/wmi/devices/wmi-bmof.rst for details. See Documentation/wmi/devices/wmi-bmof.rst for details.

View File

@ -95,7 +95,7 @@ What: /sys/kernel/debug/habanalabs/hl<n>/device_release_watchdog_timeo
Date: Oct 2022 Date: Oct 2022
KernelVersion: 6.2 KernelVersion: 6.2
Contact: ttayar@habana.ai Contact: ttayar@habana.ai
Description: The watchdog timeout value in seconds for a device relese upon Description: The watchdog timeout value in seconds for a device release upon
certain error cases, after which the device is reset. certain error cases, after which the device is reset.
What: /sys/kernel/debug/habanalabs/hl<n>/dma_size What: /sys/kernel/debug/habanalabs/hl<n>/dma_size

View File

@ -8,7 +8,7 @@ Description:
== =================================== == ===================================
1 major number 1 major number
2 minor mumber 2 minor number
3 device name 3 device name
4 reads completed successfully 4 reads completed successfully
5 reads merged 5 reads merged

View File

@ -21,7 +21,7 @@ What: /sys/bus/coreboot/devices/cbmem-<id>/address
Date: August 2022 Date: August 2022
Contact: Jack Rosenthal <jrosenth@chromium.org> Contact: Jack Rosenthal <jrosenth@chromium.org>
Description: Description:
This is the pyhsical memory address that the CBMEM entry's data This is the physical memory address that the CBMEM entry's data
begins at, in hexadecimal (e.g., ``0x76ffe000``). begins at, in hexadecimal (e.g., ``0x76ffe000``).
What: /sys/bus/coreboot/devices/cbmem-<id>/size What: /sys/bus/coreboot/devices/cbmem-<id>/size

View File

@ -31,7 +31,7 @@ Date: November 2014
KernelVersion: 3.19 KernelVersion: 3.19
Contact: Mathieu Poirier <mathieu.poirier@linaro.org> Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
Description: (RW) Used in conjunction with @addr_idx. Specifies the range of Description: (RW) Used in conjunction with @addr_idx. Specifies the range of
addresses to trigger on. Inclusion or exclusion is specificed addresses to trigger on. Inclusion or exclusion is specified
in the corresponding access type register. in the corresponding access type register.
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single
@ -304,19 +304,19 @@ What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtsscr
Date: September 2015 Date: September 2015
KernelVersion: 4.4 KernelVersion: 4.4
Contact: Mathieu Poirier <mathieu.poirier@linaro.org> Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
Description: (RO) Print the content of the ETM Trace Start/Stop Conrol Description: (RO) Print the content of the ETM Trace Start/Stop Control
register (0x018). The value is read directly from the HW. register (0x018). The value is read directly from the HW.
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr1 What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr1
Date: September 2015 Date: September 2015
KernelVersion: 4.4 KernelVersion: 4.4
Contact: Mathieu Poirier <mathieu.poirier@linaro.org> Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
Description: (RO) Print the content of the ETM Enable Conrol #1 Description: (RO) Print the content of the ETM Enable Control #1
register (0x024). The value is read directly from the HW. register (0x024). The value is read directly from the HW.
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr2 What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr2
Date: September 2015 Date: September 2015
KernelVersion: 4.4 KernelVersion: 4.4
Contact: Mathieu Poirier <mathieu.poirier@linaro.org> Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
Description: (RO) Print the content of the ETM Enable Conrol #2 Description: (RO) Print the content of the ETM Enable Control #2
register (0x01c). The value is read directly from the HW. register (0x01c). The value is read directly from the HW.

View File

@ -446,7 +446,7 @@ Date: April 2015
KernelVersion: 4.01 KernelVersion: 4.01
Contact: Mathieu Poirier <mathieu.poirier@linaro.org> Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
Description: (Read) Returns the maximum size of the data value, data address, Description: (Read) Returns the maximum size of the data value, data address,
VMID, context ID and instuction address in the trace unit VMID, context ID and instruction address in the trace unit
(0x1E8). The value is taken directly from the HW. (0x1E8). The value is taken directly from the HW.
What: /sys/bus/coresight/devices/etm<N>/trcidr/trcidr3 What: /sys/bus/coresight/devices/etm<N>/trcidr/trcidr3

View File

@ -47,7 +47,7 @@ Description: Per-pmu performance monitoring events specific to the running syste
If a <term> is specified alone (without an assigned value), it If a <term> is specified alone (without an assigned value), it
is implied that 0x1 is assigned to that <term>. is implied that 0x1 is assigned to that <term>.
Examples (each of these lines would be in a seperate file): Examples (each of these lines would be in a separate file):
event=0x2abc event=0x2abc
event=0x423,inv,cmask=0x3 event=0x423,inv,cmask=0x3
@ -83,7 +83,7 @@ Description: Perf event scaling factors
A string representing a floating point value expressed in A string representing a floating point value expressed in
scientific notation to be multiplied by the event count scientific notation to be multiplied by the event count
recieved from the kernel to match the unit specified in the received from the kernel to match the unit specified in the
<event>.unit file. <event>.unit file.
Example: Example:

View File

@ -5,6 +5,6 @@ Description:
Indicates whether or not this SBE device has experienced a Indicates whether or not this SBE device has experienced a
timeout; i.e. the SBE did not respond within the time allotted timeout; i.e. the SBE did not respond within the time allotted
by the driver. A value of 1 indicates that a timeout has by the driver. A value of 1 indicates that a timeout has
ocurred and no transfers have completed since the timeout. A occurred and no transfers have completed since the timeout. A
value of 0 indicates that no timeout has ocurred, or if one value of 0 indicates that no timeout has occurred, or if one
has, more recent transfers have completed successful. has, more recent transfers have completed successful.

View File

@ -8,7 +8,7 @@ Description:
NONE no device NONE no device
USB USB device is attached USB USB device is attached
UART UART is attached UART UART is attached
CHARGER Charger is attaced CHARGER Charger is attached
JIG JIG is attached JIG JIG is attached
======= ====================== ======= ======================

View File

@ -121,7 +121,7 @@ KernelVersion: v4.7
Contact: nvdimm@lists.linux.dev Contact: nvdimm@lists.linux.dev
Description: Description:
(RO) ACPI specification 6.2 section 5.2.25.9, defines an (RO) ACPI specification 6.2 section 5.2.25.9, defines an
identifier for an NVDIMM, which refelects the id attribute. identifier for an NVDIMM, which reflects the id attribute.
What: /sys/bus/nd/devices/nmemX/nfit/subsystem_vendor What: /sys/bus/nd/devices/nmemX/nfit/subsystem_vendor

View File

@ -30,7 +30,7 @@ Description:
Indicating that contents of the Indicating that contents of the
NVDIMM have been scrubbed. NVDIMM have been scrubbed.
* "locked" * "locked"
Indicating that NVDIMM contents cant Indicating that NVDIMM contents can't
be modified until next power cycle. be modified until next power cycle.
What: /sys/bus/nd/devices/nmemX/papr/perf_stats What: /sys/bus/nd/devices/nmemX/papr/perf_stats

View File

@ -9,7 +9,7 @@ Description:
Controller (UMC). Controller (UMC).
The umc bus presents each of the individual The umc bus presents each of the individual
capabilties as a device. capabilities as a device.
What: /sys/bus/umc/devices/.../capability_id What: /sys/bus/umc/devices/.../capability_id
Date: July 2008 Date: July 2008

View File

@ -1,5 +1,5 @@
What: /sys/class/ What: /sys/class/
Date: Febuary 2006 Date: February 2006
Contact: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Contact: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Description: Description:
The /sys/class directory will consist of a group of The /sys/class directory will consist of a group of

View File

@ -42,7 +42,7 @@ What: /sys/class/cxl/<afu>/mmio_size
Date: September 2014 Date: September 2014
Contact: linuxppc-dev@lists.ozlabs.org Contact: linuxppc-dev@lists.ozlabs.org
Description: read only Description: read only
Decimal value of the size of the MMIO space that may be mmaped Decimal value of the size of the MMIO space that may be mmapped
by userspace. by userspace.
Users: https://github.com/ibm-capi/libcxl Users: https://github.com/ibm-capi/libcxl
@ -155,7 +155,7 @@ What: /sys/class/cxl/<afu>m/mmio_size
Date: September 2014 Date: September 2014
Contact: linuxppc-dev@lists.ozlabs.org Contact: linuxppc-dev@lists.ozlabs.org
Description: read only Description: read only
Decimal value of the size of the MMIO space that may be mmaped Decimal value of the size of the MMIO space that may be mmapped
by userspace. This includes all slave contexts space also. by userspace. This includes all slave contexts space also.
Users: https://github.com/ibm-capi/libcxl Users: https://github.com/ibm-capi/libcxl

View File

@ -39,7 +39,7 @@ KernelVersion: 2.6.29
Contact: linux-mtd@lists.infradead.org Contact: linux-mtd@lists.infradead.org
Description: Description:
Major and minor numbers of the character device corresponding Major and minor numbers of the character device corresponding
to the read-only variant of thie MTD device (in to the read-only variant of the MTD device (in
<major>:<minor> format). In this case <minor> will be odd. <major>:<minor> format). In this case <minor> will be odd.
What: /sys/class/mtd/mtdX/erasesize What: /sys/class/mtd/mtdX/erasesize

View File

@ -82,7 +82,7 @@ KernelVersion: 2.6.12
Contact: netdev@vger.kernel.org Contact: netdev@vger.kernel.org
Description: Description:
Indicates the current physical link state of the interface. Indicates the current physical link state of the interface.
Posssible values are: Possible values are:
== ===================== == =====================
0 physical link is down 0 physical link is down

View File

@ -39,7 +39,7 @@ Contact: netdev@vger.kernel.org
Description: Description:
Mask of the CPU(s) currently enabled to participate into the Mask of the CPU(s) currently enabled to participate into the
Transmit Packet Steering packet processing flow for this Transmit Packet Steering packet processing flow for this
network device transmit queue. Possible vaules depend on the network device transmit queue. Possible values depend on the
number of available CPU(s) in the system. number of available CPU(s) in the system.
What: /sys/class/<iface>/queues/tx-<queue>/xps_rxqs What: /sys/class/<iface>/queues/tx-<queue>/xps_rxqs

View File

@ -22,7 +22,7 @@ Description:
Long Life: Long Life:
Customized charge rate for last longer battery life. Customized charge rate for last longer battery life.
On Wilco device this mode is pre-configured in the factory On Wilco device this mode is pre-configured in the factory
through EC's private PID. Swiching to a different mode will through EC's private PID. Switching to a different mode will
be denied by Wilco EC when Long Life mode is enabled. be denied by Wilco EC when Long Life mode is enabled.
What: /sys/class/power_supply/wilco-charger/charge_control_start_threshold What: /sys/class/power_supply/wilco-charger/charge_control_start_threshold

View File

@ -81,7 +81,7 @@ Description: Remote processor coredump configuration
collected userspace will directly read from the remote collected userspace will directly read from the remote
processor's device memory. Extra buffer will not be used to processor's device memory. Extra buffer will not be used to
copy the dump. Also recovery process will not proceed until copy the dump. Also recovery process will not proceed until
all data is read by usersapce. all data is read by userspace.
What: /sys/class/remoteproc/.../recovery What: /sys/class/remoteproc/.../recovery
Date: July 2020 Date: July 2020

View File

@ -4,7 +4,7 @@ Description:
This is given by thermal zone driver as part of registration. This is given by thermal zone driver as part of registration.
E.g: "acpitz" indicates it's an ACPI thermal device. E.g: "acpitz" indicates it's an ACPI thermal device.
In order to keep it consistent with hwmon sys attribute; this In order to keep it consistent with hwmon sys attribute; this
shouldbe a short, lowercase string, not containing spaces nor should be a short, lowercase string, not containing spaces nor
dashes. dashes.
RO, Required RO, Required

View File

@ -42,7 +42,7 @@ Date: June 2013
KernelVersion: 3.11 KernelVersion: 3.11
Contact: Thomas Pugliese <thomas.pugliese@gmail.com> Contact: Thomas Pugliese <thomas.pugliese@gmail.com>
Description: Description:
The device notification time slot (DNTS) count and inverval in The device notification time slot (DNTS) count and interval in
milliseconds that the WUSB host should use. This controls how milliseconds that the WUSB host should use. This controls how
often the devices will have the opportunity to send often the devices will have the opportunity to send
notifications to the host. notifications to the host.

View File

@ -17,4 +17,4 @@ Description:
After a successful execution of the bus type's .offline() After a successful execution of the bus type's .offline()
callback the device cannot be used for any purpose until either callback the device cannot be used for any purpose until either
it is removed (i.e. device_del() is called for it), or its bus it is removed (i.e. device_del() is called for it), or its bus
type's .online() is exeucted successfully. type's .online() is executed successfully.

View File

@ -5,7 +5,7 @@ Description: Write 1 to this file to update the ACHC microcontroller
firmware via the EzPort interface. For this the kernel firmware via the EzPort interface. For this the kernel
will load "achc.bin" via the firmware API (so usually will load "achc.bin" via the firmware API (so usually
from /lib/firmware). The write will block until the FW from /lib/firmware). The write will block until the FW
has either been flashed successfully or an error occured. has either been flashed successfully or an error occurred.
What: /sys/bus/spi/<dev>/reset What: /sys/bus/spi/<dev>/reset
Date: Jul 2021 Date: Jul 2021

View File

@ -3,7 +3,7 @@ Date: February 2014
Contact: Peter De Schrijver <pdeschrijver@nvidia.com> Contact: Peter De Schrijver <pdeschrijver@nvidia.com>
Description: read-only access to the efuses on Tegra20, Tegra30, Tegra114 Description: read-only access to the efuses on Tegra20, Tegra30, Tegra114
and Tegra124 SoC's from NVIDIA. The efuses contain write once and Tegra124 SoC's from NVIDIA. The efuses contain write once
data programmed at the factory. The data is layed out in 32bit data programmed at the factory. The data is laid out in 32bit
words in LSB first format. Each bit represents a single value words in LSB first format. Each bit represents a single value
as decoded from the fuse registers. Bits order/assignment as decoded from the fuse registers. Bits order/assignment
exactly matches the HW registers, including any unused bits. exactly matches the HW registers, including any unused bits.

View File

@ -84,7 +84,7 @@ Description:
hotplug events associated with the given class of hotplug events associated with the given class of
devices and will allow those devices to be ejected with devices and will allow those devices to be ejected with
the help of the _EJ0 control method. Unsetting it the help of the _EJ0 control method. Unsetting it
effectively disables hotplug for the correspoinding effectively disables hotplug for the corresponding
class of devices. class of devices.
======== ======================================================= ======== =======================================================

View File

@ -102,12 +102,12 @@ Description:
conn_port conn_port
The conn_hub entry contains a value representing the unique The conn_hub entry contains a value representing the unique
oridinal value of the hub on the other end of the fabric ordinal value of the hub on the other end of the fabric
cable plugged into the port. If the port is disconnected, cable plugged into the port. If the port is disconnected,
the value returned will be -1. the value returned will be -1.
The conn_port entry contains a value representing the unique The conn_port entry contains a value representing the unique
oridinal value of the port on the other end of the fabric cable ordinal value of the port on the other end of the fabric cable
plugged into the port. If the port is disconnected, the value plugged into the port. If the port is disconnected, the value
returned will be -1. returned will be -1.

View File

@ -54,9 +54,9 @@ Description: Controls the in-place-update policy.
0x00 DISABLE disable IPU(=default option in LFS mode) 0x00 DISABLE disable IPU(=default option in LFS mode)
0x01 FORCE all the time 0x01 FORCE all the time
0x02 SSR if SSR mode is activated 0x02 SSR if SSR mode is activated
0x04 UTIL if FS utilization is over threashold 0x04 UTIL if FS utilization is over threshold
0x08 SSR_UTIL if SSR mode is activated and FS utilization is over 0x08 SSR_UTIL if SSR mode is activated and FS utilization is over
threashold threshold
0x10 FSYNC activated in fsync path only for high performance 0x10 FSYNC activated in fsync path only for high performance
flash storages. IPU will be triggered only if the flash storages. IPU will be triggered only if the
# of dirty pages over min_fsync_blocks. # of dirty pages over min_fsync_blocks.
@ -117,7 +117,7 @@ Date: December 2021
Contact: "Konstantin Vyshetsky" <vkon@google.com> Contact: "Konstantin Vyshetsky" <vkon@google.com>
Description: Controls the number of discards a thread will issue at a time. Description: Controls the number of discards a thread will issue at a time.
Higher number will allow the discard thread to finish its work Higher number will allow the discard thread to finish its work
faster, at the cost of higher latency for incomming I/O. faster, at the cost of higher latency for incoming I/O.
What: /sys/fs/f2fs/<disk>/min_discard_issue_time What: /sys/fs/f2fs/<disk>/min_discard_issue_time
Date: December 2021 Date: December 2021
@ -334,7 +334,7 @@ Description: This indicates how many GC can be failed for the pinned
state. 2048 trials is set by default. state. 2048 trials is set by default.
What: /sys/fs/f2fs/<disk>/extension_list What: /sys/fs/f2fs/<disk>/extension_list
Date: Feburary 2018 Date: February 2018
Contact: "Chao Yu" <yuchao0@huawei.com> Contact: "Chao Yu" <yuchao0@huawei.com>
Description: Used to control configure extension list: Description: Used to control configure extension list:
- Query: cat /sys/fs/f2fs/<disk>/extension_list - Query: cat /sys/fs/f2fs/<disk>/extension_list

View File

@ -152,7 +152,7 @@ Description: Writing to and reading from this file sets and gets the action
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min
Date: Mar 2022 Date: Mar 2022
Contact: SeongJae Park <sj@kernel.org> Contact: SeongJae Park <sj@kernel.org>
Description: Writing to and reading from this file sets and gets the mimimum Description: Writing to and reading from this file sets and gets the minimum
size of the scheme's target regions in bytes. size of the scheme's target regions in bytes.
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max

View File

@ -10,7 +10,7 @@ Description:
dropping it if possible. The kernel will then be placed dropping it if possible. The kernel will then be placed
on the bad page list and never be reused. on the bad page list and never be reused.
The offlining is done in kernel specific granuality. The offlining is done in kernel specific granularity.
Normally it's the base page size of the kernel, but Normally it's the base page size of the kernel, but
this might change. this might change.
@ -35,7 +35,7 @@ Description:
to access this page assuming it's poisoned by the to access this page assuming it's poisoned by the
hardware. hardware.
The offlining is done in kernel specific granuality. The offlining is done in kernel specific granularity.
Normally it's the base page size of the kernel, but Normally it's the base page size of the kernel, but
this might change. this might change.

View File

@ -15,7 +15,7 @@ KernelVersion: 3.19
Contact: Gabriele Mazzotta <gabriele.mzt@gmail.com>, Contact: Gabriele Mazzotta <gabriele.mzt@gmail.com>,
Pali Rohár <pali@kernel.org> Pali Rohár <pali@kernel.org>
Description: Description:
This file allows to specifiy the on/off threshold value, This file allows to specify the on/off threshold value,
as reported by the ambient light sensor. as reported by the ambient light sensor.
What: /sys/class/leds/dell::kbd_backlight/start_triggers What: /sys/class/leds/dell::kbd_backlight/start_triggers

View File

@ -90,7 +90,7 @@ KernelVersion: 5.4
Contact: Wu Hao <hao.wu@intel.com> Contact: Wu Hao <hao.wu@intel.com>
Description: Read-Write. Read this file to get errors detected on FME. Description: Read-Write. Read this file to get errors detected on FME.
Write this file to clear errors logged in fme_errors. Write Write this file to clear errors logged in fme_errors. Write
fials with -EINVAL if input parsing fails or input error code fails with -EINVAL if input parsing fails or input error code
doesn't match. doesn't match.
What: /sys/bus/platform/devices/dfl-fme.0/errors/first_error What: /sys/bus/platform/devices/dfl-fme.0/errors/first_error

View File

@ -9,7 +9,7 @@ Description:
The device name flows down to architecture specific board The device name flows down to architecture specific board
initialization file from the ATAGS bootloader initialization file from the ATAGS bootloader
firmware. The name exposed is read from the user-space firmware. The name exposed is read from the user-space
dameon and opens the device when install is requested. daemon and opens the device when install is requested.
What: /sys/devices/platform/kim/baud_rate What: /sys/devices/platform/kim/baud_rate
Date: January 2010 Date: January 2010

View File

@ -4,7 +4,7 @@ KernelVersion: 4.10
Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com> Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com>
Description: Description:
LPE Firmware version for SST driver on all atom LPE Firmware version for SST driver on all atom
plaforms (BYT/CHT/Merrifield/BSW). platforms (BYT/CHT/Merrifield/BSW).
If the FW has never been loaded it will display:: If the FW has never been loaded it will display::
"FW not yet loaded" "FW not yet loaded"