From: Fabrice Gasnier <fabrice.gasnier@st.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
"Gautham R. Shenoy" <ego@linux.vnet.ibm.com>,
"Jason A. Donenfeld" <Jason@zx2c4.com>,
"Javier González" <javier@javigon.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
"Alexander Shishkin" <alexander.shishkin@linux.intel.com>,
"Alexandre Belloni" <alexandre.belloni@bootlin.com>,
"Alexandre Torgue" <alexandre.torgue@st.com>,
"Andrew Donnellan" <ajd@linux.ibm.com>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
"Baolin Wang" <baolin.wang7@gmail.com>,
"Benson Leung" <bleung@chromium.org>,
"Boris Ostrovsky" <boris.ostrovsky@oracle.com>,
"Bruno Meneguele" <bmeneg@redhat.com>,
"Chunyan Zhang" <zhang.lyra@gmail.com>,
"Dan Murphy" <dmurphy@ti.com>,
"Dan Williams" <dan.j.williams@intel.com>,
"Enric Balletbo i Serra" <enric.balletbo@collabora.com>,
"Felipe Balbi" <balbi@kernel.org>,
"Frederic Barrat" <fbarrat@linux.ibm.com>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Guenter Roeck" <groeck@chromium.org>,
"Hanjun Guo" <guohanjun@huawei.com>,
"Heikki Krogerus" <heikki.krogerus@linux.intel.com>,
"Jens Axboe" <axboe@kernel.dk>,
"Johannes Thumshirn" <johannes.thumshirn@wdc.com>,
"Jonathan Cameron" <jic23@kernel.org>,
"Juergen Gross" <jgross@suse.com>,
"Konstantin Khlebnikov" <koct9i@gmail.com>,
"Kranthi Kuntala" <kranthi.kuntala@intel.com>,
"Lakshmi Ramasubramanian" <nramas@linux.microsoft.com>,
"Lars-Peter Clausen" <lars@metafoo.de>,
"Len Brown" <lenb@kernel.org>,
"Leonid Maksymchuk" <leonmaxx@gmail.com>,
"Ludovic Desroches" <ludovic.desroches@microchip.com>,
"Mario Limonciello" <mario.limonciello@dell.com>,
"Mark Gross" <mgross@linux.intel.com>,
"Maxime Coquelin" <mcoquelin.stm32@gmail.com>,
"Michael Ellerman" <mpe@ellerman.id.au>,
"Mika Westerberg" <mika.westerberg@linux.intel.com>,
"Mike Kravetz" <mike.kravetz@oracle.com>,
"Mimi Zohar" <zohar@linux.ibm.com>,
"Nayna Jain" <nayna@linux.ibm.com>,
"Nicolas Ferre" <nicolas.ferre@microchip.com>,
"Niklas Cassel" <niklas.cassel@wdc.com>,
"Oded Gabbay" <oded.gabbay@gmail.com>,
"Oleh Kravchenko" <oleg@kaa.org.ua>,
"Orson Zhai" <orsonzhai@gmail.com>, "Pavel Machek" <pavel@ucw.cz>,
"Pawan Gupta" <pawan.kumar.gupta@linux.intel.com>,
"Peter Meerwald-Stadler" <pmeerw@pmeerw.net>,
"Peter Rosin" <peda@axentia.se>, "Petr Mladek" <pmladek@suse.com>,
"Philippe Bergheaud" <felix@linux.ibm.com>,
"Richard Cochran" <richardcochran@gmail.com>,
"Sebastian Reichel" <sre@kernel.org>,
"Sergey Senozhatsky" <sergey.senozhatsky@gmail.com>,
"Stefano Stabellini" <sstabellini@kernel.org>,
"Thinh Nguyen" <Thinh.Nguyen@synopsys.com>,
"Thomas Gleixner" <tglx@linutronix.de>,
"Tom Rix" <trix@redhat.com>,
"Vaibhav Jain" <vaibhav@linux.ibm.com>,
"Vineela Tummalapalli" <vineela.tummalapalli@intel.com>,
"Vishal Verma" <vishal.l.verma@intel.com>,
linux-acpi@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-mm@kvack.org, linux-pm@vger.kernel.org,
linux-stm32@st-md-mailman.stormreply.com,
linux-usb@vger.kernel.org, linuxppc-dev@lists.ozlabs.org,
netdev@vger.kernel.org, xen-devel@lists.xenproject.org,
"Jonathan Cameron" <Jonathan.Cameron@huawei.com>
Subject: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
Date: Fri, 30 Oct 2020 10:19:12 +0100 [thread overview]
Message-ID: <5326488b-4185-9d67-fc09-79b911fbb3b8@st.com> (raw)
In-Reply-To: <58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org>
On 10/30/20 8:40 AM, Mauro Carvalho Chehab wrote:
> Some files over there won't parse well by Sphinx.
>
> Fix them.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../ABI/testing/configfs-spear-pcie-gadget | 36 +--
> Documentation/ABI/testing/configfs-usb-gadget | 83 +++---
> .../ABI/testing/configfs-usb-gadget-hid | 10 +-
> .../ABI/testing/configfs-usb-gadget-rndis | 16 +-
> .../ABI/testing/configfs-usb-gadget-uac1 | 18 +-
> .../ABI/testing/configfs-usb-gadget-uvc | 220 +++++++++-------
> Documentation/ABI/testing/debugfs-ec | 11 +-
> Documentation/ABI/testing/debugfs-pktcdvd | 11 +-
> Documentation/ABI/testing/dev-kmsg | 27 +-
> Documentation/ABI/testing/evm | 17 +-
> Documentation/ABI/testing/ima_policy | 30 ++-
> Documentation/ABI/testing/procfs-diskstats | 40 +--
> Documentation/ABI/testing/sysfs-block | 38 +--
> Documentation/ABI/testing/sysfs-block-device | 2 +
> Documentation/ABI/testing/sysfs-bus-acpi | 18 +-
> .../sysfs-bus-event_source-devices-format | 3 +-
> .../ABI/testing/sysfs-bus-i2c-devices-pca954x | 27 +-
> Documentation/ABI/testing/sysfs-bus-iio | 11 +
> .../sysfs-bus-iio-adc-envelope-detector | 5 +-
> .../ABI/testing/sysfs-bus-iio-cros-ec | 2 +-
> .../ABI/testing/sysfs-bus-iio-dfsdm-adc-stm32 | 8 +-
> .../ABI/testing/sysfs-bus-iio-lptimer-stm32 | 29 ++-
> .../sysfs-bus-iio-magnetometer-hmc5843 | 19 +-
> .../sysfs-bus-iio-temperature-max31856 | 19 +-
> .../ABI/testing/sysfs-bus-iio-timer-stm32 | 137 ++++++----
> .../testing/sysfs-bus-intel_th-devices-msc | 4 +
> Documentation/ABI/testing/sysfs-bus-nfit | 2 +-
> .../testing/sysfs-bus-pci-devices-aer_stats | 119 +++++----
> Documentation/ABI/testing/sysfs-bus-rapidio | 23 +-
> .../ABI/testing/sysfs-bus-thunderbolt | 40 +--
> Documentation/ABI/testing/sysfs-bus-usb | 30 ++-
> .../testing/sysfs-bus-usb-devices-usbsevseg | 7 +-
> Documentation/ABI/testing/sysfs-bus-vfio-mdev | 10 +-
> Documentation/ABI/testing/sysfs-class-cxl | 15 +-
> Documentation/ABI/testing/sysfs-class-led | 2 +-
> .../testing/sysfs-class-led-driver-el15203000 | 229 ++++++++---------
> .../ABI/testing/sysfs-class-led-driver-sc27xx | 4 +-
> Documentation/ABI/testing/sysfs-class-mic | 52 ++--
> Documentation/ABI/testing/sysfs-class-ocxl | 3 +
> Documentation/ABI/testing/sysfs-class-power | 73 +++++-
> .../ABI/testing/sysfs-class-power-twl4030 | 33 +--
> Documentation/ABI/testing/sysfs-class-rc | 30 ++-
> .../ABI/testing/sysfs-class-scsi_host | 7 +-
> Documentation/ABI/testing/sysfs-class-typec | 12 +-
> .../testing/sysfs-devices-platform-ACPI-TAD | 4 +
> .../ABI/testing/sysfs-devices-platform-docg3 | 10 +-
> .../sysfs-devices-platform-sh_mobile_lcdc_fb | 8 +-
> .../ABI/testing/sysfs-devices-system-cpu | 99 +++++---
> .../ABI/testing/sysfs-devices-system-ibm-rtl | 6 +-
> .../testing/sysfs-driver-bd9571mwv-regulator | 4 +
> Documentation/ABI/testing/sysfs-driver-genwqe | 11 +-
> .../testing/sysfs-driver-hid-logitech-lg4ff | 18 +-
> .../ABI/testing/sysfs-driver-hid-wiimote | 11 +-
> .../ABI/testing/sysfs-driver-samsung-laptop | 13 +-
> .../ABI/testing/sysfs-driver-toshiba_acpi | 26 ++
> .../ABI/testing/sysfs-driver-toshiba_haps | 2 +
> Documentation/ABI/testing/sysfs-driver-wacom | 4 +-
> Documentation/ABI/testing/sysfs-firmware-acpi | 237 +++++++++---------
> .../ABI/testing/sysfs-firmware-dmi-entries | 50 ++--
> Documentation/ABI/testing/sysfs-firmware-gsmi | 2 +-
> .../ABI/testing/sysfs-firmware-memmap | 16 +-
> Documentation/ABI/testing/sysfs-fs-ext4 | 4 +-
> .../ABI/testing/sysfs-hypervisor-xen | 13 +-
> .../ABI/testing/sysfs-kernel-boot_params | 23 +-
> .../ABI/testing/sysfs-kernel-mm-hugepages | 12 +-
> .../ABI/testing/sysfs-platform-asus-laptop | 21 +-
> .../ABI/testing/sysfs-platform-asus-wmi | 1 +
> Documentation/ABI/testing/sysfs-platform-at91 | 10 +-
> .../ABI/testing/sysfs-platform-eeepc-laptop | 14 +-
> .../ABI/testing/sysfs-platform-ideapad-laptop | 9 +-
> .../sysfs-platform-intel-wmi-thunderbolt | 1 +
> .../ABI/testing/sysfs-platform-sst-atom | 13 +-
> .../ABI/testing/sysfs-platform-usbip-vudc | 11 +-
> Documentation/ABI/testing/sysfs-ptp | 2 +-
> 74 files changed, 1322 insertions(+), 865 deletions(-)
>
Hi Mauro,
[...]
>
> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> +KernelVersion: 4.12
> +Contact: benjamin.gaignard@st.com
> +Description:
> + Reading returns the list possible quadrature modes.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> +KernelVersion: 4.12
> +Contact: benjamin.gaignard@st.com
> +Description:
> + Configure the device counter quadrature modes:
> +
> + channel_A:
> + Encoder A input servers as the count input and B as
> + the UP/DOWN direction control input.
> +
> + channel_B:
> + Encoder B input serves as the count input and A as
> + the UP/DOWN direction control input.
> +
> + quadrature:
> + Encoder A and B inputs are mixed to get direction
> + and count with a scale of 0.25.
> +
I just noticed that since Jonathan question in v1.
Above ABI has been moved in the past as discussed in [1]. You can take a
look at:
b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
Could you please remove the above chunk ?
With that, for the stm32 part:
Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
[1] https://lkml.org/lkml/2019/5/7/698
Best Regards,
Fabrice
> What: /sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available
> KernelVersion: 4.12
> Contact: benjamin.gaignard@st.com
> @@ -104,6 +146,7 @@ Description:
> Configure the device counter enable modes, in all case
> counting direction is set by in_count0_count_direction
> attribute and the counter is clocked by the internal clock.
> +
> always:
> Counter is always ON.
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc b/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
> index 7fd2601c2831..a74252e580a5 100644
> --- a/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
> +++ b/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
> @@ -9,11 +9,13 @@ Date: June 2015
> KernelVersion: 4.3
> Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com>
> Description: (RW) Configure MSC operating mode:
> +
> - "single", for contiguous buffer mode (high-order alloc);
> - "multi", for multiblock mode;
> - "ExI", for DCI handler mode;
> - "debug", for debug mode;
> - any of the currently loaded buffer sinks.
> +
> If operating mode changes, existing buffer is deallocated,
> provided there are no active users and tracing is not enabled,
> otherwise the write will fail.
> @@ -23,10 +25,12 @@ Date: June 2015
> KernelVersion: 4.3
> Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com>
> Description: (RW) Configure MSC buffer size for "single" or "multi" modes.
> +
> In single mode, this is a single number of pages, has to be
> power of 2. In multiblock mode, this is a comma-separated list
> of numbers of pages for each window to be allocated. Number of
> windows is not limited.
> +
> Writing to this file deallocates existing buffer (provided
> there are no active users and tracing is not enabled) and then
> allocates a new one.
> diff --git a/Documentation/ABI/testing/sysfs-bus-nfit b/Documentation/ABI/testing/sysfs-bus-nfit
> index e4f76e7eab93..63ef0b9ecce7 100644
> --- a/Documentation/ABI/testing/sysfs-bus-nfit
> +++ b/Documentation/ABI/testing/sysfs-bus-nfit
> @@ -1,4 +1,4 @@
> -For all of the nmem device attributes under nfit/*, see the 'NVDIMM Firmware
> +For all of the nmem device attributes under ``nfit/*``, see the 'NVDIMM Firmware
> Interface Table (NFIT)' section in the ACPI specification
> (http://www.uefi.org/specifications) for more details.
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
> index 3c9a8c4a25eb..860db53037a5 100644
> --- a/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
> +++ b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
> @@ -1,6 +1,6 @@
> -==========================
> PCIe Device AER statistics
> -==========================
> +--------------------------
> +
> These attributes show up under all the devices that are AER capable. These
> statistical counters indicate the errors "as seen/reported by the device".
> Note that this may mean that if an endpoint is causing problems, the AER
> @@ -17,19 +17,18 @@ Description: List of correctable errors seen and reported by this
> PCI device using ERR_COR. Note that since multiple errors may
> be reported using a single ERR_COR message, thus
> TOTAL_ERR_COR at the end of the file may not match the actual
> - total of all the errors in the file. Sample output:
> --------------------------------------------------------------------------
> -localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable
> -Receiver Error 2
> -Bad TLP 0
> -Bad DLLP 0
> -RELAY_NUM Rollover 0
> -Replay Timer Timeout 0
> -Advisory Non-Fatal 0
> -Corrected Internal Error 0
> -Header Log Overflow 0
> -TOTAL_ERR_COR 2
> --------------------------------------------------------------------------
> + total of all the errors in the file. Sample output::
> +
> + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable
> + Receiver Error 2
> + Bad TLP 0
> + Bad DLLP 0
> + RELAY_NUM Rollover 0
> + Replay Timer Timeout 0
> + Advisory Non-Fatal 0
> + Corrected Internal Error 0
> + Header Log Overflow 0
> + TOTAL_ERR_COR 2
>
> What: /sys/bus/pci/devices/<dev>/aer_dev_fatal
> Date: July 2018
> @@ -39,28 +38,27 @@ Description: List of uncorrectable fatal errors seen and reported by this
> PCI device using ERR_FATAL. Note that since multiple errors may
> be reported using a single ERR_FATAL message, thus
> TOTAL_ERR_FATAL at the end of the file may not match the actual
> - total of all the errors in the file. Sample output:
> --------------------------------------------------------------------------
> -localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal
> -Undefined 0
> -Data Link Protocol 0
> -Surprise Down Error 0
> -Poisoned TLP 0
> -Flow Control Protocol 0
> -Completion Timeout 0
> -Completer Abort 0
> -Unexpected Completion 0
> -Receiver Overflow 0
> -Malformed TLP 0
> -ECRC 0
> -Unsupported Request 0
> -ACS Violation 0
> -Uncorrectable Internal Error 0
> -MC Blocked TLP 0
> -AtomicOp Egress Blocked 0
> -TLP Prefix Blocked Error 0
> -TOTAL_ERR_FATAL 0
> --------------------------------------------------------------------------
> + total of all the errors in the file. Sample output::
> +
> + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal
> + Undefined 0
> + Data Link Protocol 0
> + Surprise Down Error 0
> + Poisoned TLP 0
> + Flow Control Protocol 0
> + Completion Timeout 0
> + Completer Abort 0
> + Unexpected Completion 0
> + Receiver Overflow 0
> + Malformed TLP 0
> + ECRC 0
> + Unsupported Request 0
> + ACS Violation 0
> + Uncorrectable Internal Error 0
> + MC Blocked TLP 0
> + AtomicOp Egress Blocked 0
> + TLP Prefix Blocked Error 0
> + TOTAL_ERR_FATAL 0
>
> What: /sys/bus/pci/devices/<dev>/aer_dev_nonfatal
> Date: July 2018
> @@ -70,32 +68,31 @@ Description: List of uncorrectable nonfatal errors seen and reported by this
> PCI device using ERR_NONFATAL. Note that since multiple errors
> may be reported using a single ERR_FATAL message, thus
> TOTAL_ERR_NONFATAL at the end of the file may not match the
> - actual total of all the errors in the file. Sample output:
> --------------------------------------------------------------------------
> -localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal
> -Undefined 0
> -Data Link Protocol 0
> -Surprise Down Error 0
> -Poisoned TLP 0
> -Flow Control Protocol 0
> -Completion Timeout 0
> -Completer Abort 0
> -Unexpected Completion 0
> -Receiver Overflow 0
> -Malformed TLP 0
> -ECRC 0
> -Unsupported Request 0
> -ACS Violation 0
> -Uncorrectable Internal Error 0
> -MC Blocked TLP 0
> -AtomicOp Egress Blocked 0
> -TLP Prefix Blocked Error 0
> -TOTAL_ERR_NONFATAL 0
> --------------------------------------------------------------------------
> + actual total of all the errors in the file. Sample output::
> +
> + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal
> + Undefined 0
> + Data Link Protocol 0
> + Surprise Down Error 0
> + Poisoned TLP 0
> + Flow Control Protocol 0
> + Completion Timeout 0
> + Completer Abort 0
> + Unexpected Completion 0
> + Receiver Overflow 0
> + Malformed TLP 0
> + ECRC 0
> + Unsupported Request 0
> + ACS Violation 0
> + Uncorrectable Internal Error 0
> + MC Blocked TLP 0
> + AtomicOp Egress Blocked 0
> + TLP Prefix Blocked Error 0
> + TOTAL_ERR_NONFATAL 0
>
> -============================
> PCIe Rootport AER statistics
> -============================
> +----------------------------
> +
> These attributes show up under only the rootports (or root complex event
> collectors) that are AER capable. These indicate the number of error messages as
> "reported to" the rootport. Please note that the rootports also transmit
> diff --git a/Documentation/ABI/testing/sysfs-bus-rapidio b/Documentation/ABI/testing/sysfs-bus-rapidio
> index 13208b27dd87..634ea207a50a 100644
> --- a/Documentation/ABI/testing/sysfs-bus-rapidio
> +++ b/Documentation/ABI/testing/sysfs-bus-rapidio
> @@ -4,24 +4,27 @@ Description:
> an individual subdirectory with the following name format of
> device_name "nn:d:iiii", where:
>
> - nn - two-digit hexadecimal ID of RapidIO network where the
> + ==== ========================================================
> + nn two-digit hexadecimal ID of RapidIO network where the
> device resides
> - d - device type: 'e' - for endpoint or 's' - for switch
> - iiii - four-digit device destID for endpoints, or switchID for
> + d device type: 'e' - for endpoint or 's' - for switch
> + iiii four-digit device destID for endpoints, or switchID for
> switches
> + ==== ========================================================
>
> For example, below is a list of device directories that
> represents a typical RapidIO network with one switch, one host,
> and two agent endpoints, as it is seen by the enumerating host
> - (with destID = 1):
> + (with destID = 1)::
>
> - /sys/bus/rapidio/devices/00:e:0000
> - /sys/bus/rapidio/devices/00:e:0002
> - /sys/bus/rapidio/devices/00:s:0001
> + /sys/bus/rapidio/devices/00:e:0000
> + /sys/bus/rapidio/devices/00:e:0002
> + /sys/bus/rapidio/devices/00:s:0001
>
> - NOTE: An enumerating or discovering endpoint does not create a
> - sysfs entry for itself, this is why an endpoint with destID=1 is
> - not shown in the list.
> + NOTE:
> + An enumerating or discovering endpoint does not create a
> + sysfs entry for itself, this is why an endpoint with destID=1
> + is not shown in the list.
>
> Attributes Common for All RapidIO Devices
> -----------------------------------------
> diff --git a/Documentation/ABI/testing/sysfs-bus-thunderbolt b/Documentation/ABI/testing/sysfs-bus-thunderbolt
> index dd565c378b40..171127294674 100644
> --- a/Documentation/ABI/testing/sysfs-bus-thunderbolt
> +++ b/Documentation/ABI/testing/sysfs-bus-thunderbolt
> @@ -37,16 +37,18 @@ Contact: thunderbolt-software@lists.01.org
> Description: This attribute holds current Thunderbolt security level
> set by the system BIOS. Possible values are:
>
> - none: All devices are automatically authorized
> - user: Devices are only authorized based on writing
> - appropriate value to the authorized attribute
> - secure: Require devices that support secure connect at
> - minimum. User needs to authorize each device.
> - dponly: Automatically tunnel Display port (and USB). No
> - PCIe tunnels are created.
> - usbonly: Automatically tunnel USB controller of the
> + ======= ==================================================
> + none All devices are automatically authorized
> + user Devices are only authorized based on writing
> + appropriate value to the authorized attribute
> + secure Require devices that support secure connect at
> + minimum. User needs to authorize each device.
> + dponly Automatically tunnel Display port (and USB). No
> + PCIe tunnels are created.
> + usbonly Automatically tunnel USB controller of the
> connected Thunderbolt dock (and Display Port). All
> PCIe links downstream of the dock are removed.
> + ======= ==================================================
>
> What: /sys/bus/thunderbolt/devices/.../authorized
> Date: Sep 2017
> @@ -61,17 +63,23 @@ Description: This attribute is used to authorize Thunderbolt devices
> yet authorized.
>
> Possible values are supported:
> - 1: The device will be authorized and connected
> +
> + == ===========================================
> + 1 The device will be authorized and connected
> + == ===========================================
>
> When key attribute contains 32 byte hex string the possible
> values are:
> - 1: The 32 byte hex string is added to the device NVM and
> - the device is authorized.
> - 2: Send a challenge based on the 32 byte hex string. If the
> - challenge response from device is valid, the device is
> - authorized. In case of failure errno will be ENOKEY if
> - the device did not contain a key at all, and
> - EKEYREJECTED if the challenge response did not match.
> +
> + == ========================================================
> + 1 The 32 byte hex string is added to the device NVM and
> + the device is authorized.
> + 2 Send a challenge based on the 32 byte hex string. If the
> + challenge response from device is valid, the device is
> + authorized. In case of failure errno will be ENOKEY if
> + the device did not contain a key at all, and
> + EKEYREJECTED if the challenge response did not match.
> + == ========================================================
>
> What: /sys/bus/thunderbolt/devices/.../boot
> Date: Jun 2018
> diff --git a/Documentation/ABI/testing/sysfs-bus-usb b/Documentation/ABI/testing/sysfs-bus-usb
> index 614d216dff1d..e449b8374f6a 100644
> --- a/Documentation/ABI/testing/sysfs-bus-usb
> +++ b/Documentation/ABI/testing/sysfs-bus-usb
> @@ -72,24 +72,27 @@ Description:
> table at compile time. The format for the device ID is:
> idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct
> The vendor ID and device ID fields are required, the
> - rest is optional. The Ref* tuple can be used to tell the
> + rest is optional. The `Ref*` tuple can be used to tell the
> driver to use the same driver_data for the new device as
> it is used for the reference device.
> Upon successfully adding an ID, the driver will probe
> - for the device and attempt to bind to it. For example:
> - # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
> + for the device and attempt to bind to it. For example::
> +
> + # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
>
> Here add a new device (0458:7045) using driver_data from
> - an already supported device (0458:704c):
> - # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
> + an already supported device (0458:704c)::
> +
> + # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
>
> Reading from this file will list all dynamically added
> device IDs in the same format, with one entry per
> - line. For example:
> - # cat /sys/bus/usb/drivers/foo/new_id
> - 8086 10f5
> - dead beef 06
> - f00d cafe
> + line. For example::
> +
> + # cat /sys/bus/usb/drivers/foo/new_id
> + 8086 10f5
> + dead beef 06
> + f00d cafe
>
> The list will be truncated at PAGE_SIZE bytes due to
> sysfs restrictions.
> @@ -209,6 +212,7 @@ Description:
> advance, and behaves well according to the specification.
> This attribute is a bit-field that controls the behavior of
> a specific port:
> +
> - Bit 0 of this field selects the "old" enumeration scheme,
> as it is considerably faster (it only causes one USB reset
> instead of 2).
> @@ -233,10 +237,10 @@ Description:
> poll() for monitoring changes to this value in user space.
>
> Any time this value changes the corresponding hub device will send a
> - udev event with the following attributes:
> + udev event with the following attributes::
>
> - OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX
> - OVER_CURRENT_COUNT=[current value of this sysfs attribute]
> + OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX
> + OVER_CURRENT_COUNT=[current value of this sysfs attribute]
>
> What: /sys/bus/usb/devices/.../(hub interface)/portX/usb3_lpm_permit
> Date: November 2015
> diff --git a/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg b/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
> index 9ade80f81f96..2f86e4223bfc 100644
> --- a/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
> +++ b/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
> @@ -12,8 +12,11 @@ KernelVersion: 2.6.26
> Contact: Harrison Metzger <harrisonmetz@gmail.com>
> Description: Controls the devices display mode.
> For a 6 character display the values are
> +
> MSB 0x06; LSB 0x3F, and
> +
> for an 8 character display the values are
> +
> MSB 0x08; LSB 0xFF.
>
> What: /sys/bus/usb/.../textmode
> @@ -37,7 +40,7 @@ KernelVersion: 2.6.26
> Contact: Harrison Metzger <harrisonmetz@gmail.com>
> Description: Controls the decimal places on the device.
> To set the nth decimal place, give this field
> - the value of 10 ** n. Assume this field has
> + the value of ``10 ** n``. Assume this field has
> the value k and has 1 or more decimal places set,
> to set the mth place (where m is not already set),
> - change this fields value to k + 10 ** m.
> + change this fields value to ``k + 10 ** m``.
> diff --git a/Documentation/ABI/testing/sysfs-bus-vfio-mdev b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> index 452dbe39270e..59fc804265db 100644
> --- a/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> +++ b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> @@ -28,8 +28,9 @@ Description:
> Writing UUID to this file will create mediated device of
> type <type-id> for parent device <device>. This is a
> write-only file.
> - For example:
> - # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
> + For example::
> +
> + # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
> /sys/devices/foo/mdev_supported_types/foo-1/create
>
> What: /sys/.../mdev_supported_types/<type-id>/devices/
> @@ -107,5 +108,6 @@ Description:
> Writing '1' to this file destroys the mediated device. The
> vendor driver can fail the remove() callback if that device
> is active and the vendor driver doesn't support hot unplug.
> - Example:
> - # echo 1 > /sys/bus/mdev/devices/<UUID>/remove
> + Example::
> +
> + # echo 1 > /sys/bus/mdev/devices/<UUID>/remove
> diff --git a/Documentation/ABI/testing/sysfs-class-cxl b/Documentation/ABI/testing/sysfs-class-cxl
> index 7970e3713e70..a6f51a104c44 100644
> --- a/Documentation/ABI/testing/sysfs-class-cxl
> +++ b/Documentation/ABI/testing/sysfs-class-cxl
> @@ -72,11 +72,16 @@ Description: read/write
> when performing the START_WORK ioctl. Only applicable when
> running under hashed page table mmu.
> Possible values:
> - none: No prefaulting (default)
> - work_element_descriptor: Treat the work element
> - descriptor as an effective address and
> - prefault what it points to.
> - all: all segments process calling START_WORK maps.
> +
> + ======================= ======================================
> + none No prefaulting (default)
> + work_element_descriptor Treat the work element
> + descriptor as an effective address and
> + prefault what it points to.
> + all all segments process calling
> + START_WORK maps.
> + ======================= ======================================
> +
> Users: https://github.com/ibm-capi/libcxl
>
> What: /sys/class/cxl/<afu>/reset
> diff --git a/Documentation/ABI/testing/sysfs-class-led b/Documentation/ABI/testing/sysfs-class-led
> index 5f67f7ab277b..65e040978f73 100644
> --- a/Documentation/ABI/testing/sysfs-class-led
> +++ b/Documentation/ABI/testing/sysfs-class-led
> @@ -50,7 +50,7 @@ Description:
> You can change triggers in a similar manner to the way an IO
> scheduler is chosen. Trigger specific parameters can appear in
> /sys/class/leds/<led> once a given trigger is selected. For
> - their documentation see sysfs-class-led-trigger-*.
> + their documentation see `sysfs-class-led-trigger-*`.
>
> What: /sys/class/leds/<led>/inverted
> Date: January 2011
> diff --git a/Documentation/ABI/testing/sysfs-class-led-driver-el15203000 b/Documentation/ABI/testing/sysfs-class-led-driver-el15203000
> index f520ece9b64c..69befe947d7e 100644
> --- a/Documentation/ABI/testing/sysfs-class-led-driver-el15203000
> +++ b/Documentation/ABI/testing/sysfs-class-led-driver-el15203000
> @@ -6,127 +6,132 @@ Description:
> The LEDs board supports only predefined patterns by firmware
> for specific LEDs.
>
> - Breathing mode for Screen frame light tube:
> - "0 4000 1 4000"
> + Breathing mode for Screen frame light tube::
>
> - ^
> - |
> - Max-| ---
> - | / \
> - | / \
> - | / \ /
> - | / \ /
> - Min-|- ---
> - |
> - 0------4------8--> time (sec)
> + "0 4000 1 4000"
>
> - Cascade mode for Pipe LED:
> - "1 800 2 800 4 800 8 800 16 800"
> + ^
> + |
> + Max-| ---
> + | / \
> + | / \
> + | / \ /
> + | / \ /
> + Min-|- ---
> + |
> + 0------4------8--> time (sec)
>
> - ^
> - |
> - 0 On -|----+ +----+ +---
> - | | | | |
> - Off-| +-------------------+ +-------------------+
> - |
> - 1 On -| +----+ +----+
> - | | | | |
> - Off |----+ +-------------------+ +------------------
> - |
> - 2 On -| +----+ +----+
> - | | | | |
> - Off-|---------+ +-------------------+ +-------------
> - |
> - 3 On -| +----+ +----+
> - | | | | |
> - Off-|--------------+ +-------------------+ +--------
> - |
> - 4 On -| +----+ +----+
> - | | | | |
> - Off-|-------------------+ +-------------------+ +---
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + Cascade mode for Pipe LED::
>
> - Inverted cascade mode for Pipe LED:
> - "30 800 29 800 27 800 23 800 15 800"
> + "1 800 2 800 4 800 8 800 16 800"
>
> - ^
> - |
> - 0 On -| +-------------------+ +-------------------+
> - | | | | |
> - Off-|----+ +----+ +---
> - |
> - 1 On -|----+ +-------------------+ +------------------
> - | | | | |
> - Off | +----+ +----+
> - |
> - 2 On -|---------+ +-------------------+ +-------------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 3 On -|--------------+ +-------------------+ +--------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 4 On -|-------------------+ +-------------------+ +---
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + ^
> + |
> + 0 On -|----+ +----+ +---
> + | | | | |
> + Off-| +-------------------+ +-------------------+
> + |
> + 1 On -| +----+ +----+
> + | | | | |
> + Off |----+ +-------------------+ +------------------
> + |
> + 2 On -| +----+ +----+
> + | | | | |
> + Off-|---------+ +-------------------+ +-------------
> + |
> + 3 On -| +----+ +----+
> + | | | | |
> + Off-|--------------+ +-------------------+ +--------
> + |
> + 4 On -| +----+ +----+
> + | | | | |
> + Off-|-------------------+ +-------------------+ +---
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
>
> - Bounce mode for Pipe LED:
> - "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
> + Inverted cascade mode for Pipe LED::
>
> - ^
> - |
> - 0 On -|----+ +--------
> - | | |
> - Off-| +---------------------------------------+
> - |
> - 1 On -| +----+ +----+
> - | | | | |
> - Off |----+ +-----------------------------+ +--------
> - |
> - 2 On -| +----+ +----+
> - | | | | |
> - Off-|---------+ +-------------------+ +-------------
> - |
> - 3 On -| +----+ +----+
> - | | | | |
> - Off-|--------------+ +---------+ +------------------
> - |
> - 4 On -| +---------+
> - | | |
> - Off-|-------------------+ +-----------------------
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + "30 800 29 800 27 800 23 800 15 800"
>
> - Inverted bounce mode for Pipe LED:
> - "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
> + ^
> + |
> + 0 On -| +-------------------+ +-------------------+
> + | | | | |
> + Off-|----+ +----+ +---
> + |
> + 1 On -|----+ +-------------------+ +------------------
> + | | | | |
> + Off | +----+ +----+
> + |
> + 2 On -|---------+ +-------------------+ +-------------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 3 On -|--------------+ +-------------------+ +--------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 4 On -|-------------------+ +-------------------+ +---
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
>
> - ^
> - |
> - 0 On -| +---------------------------------------+
> - | | |
> - Off-|----+ +--------
> - |
> - 1 On -|----+ +-----------------------------+ +--------
> - | | | | |
> - Off | +----+ +----+
> - |
> - 2 On -|---------+ +-------------------+ +-------------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 3 On -|--------------+ +---------+ +------------------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 4 On -|-------------------+ +-----------------------
> - | | |
> - Off-| +---------+
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + Bounce mode for Pipe LED::
> +
> + "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
> +
> + ^
> + |
> + 0 On -|----+ +--------
> + | | |
> + Off-| +---------------------------------------+
> + |
> + 1 On -| +----+ +----+
> + | | | | |
> + Off |----+ +-----------------------------+ +--------
> + |
> + 2 On -| +----+ +----+
> + | | | | |
> + Off-|---------+ +-------------------+ +-------------
> + |
> + 3 On -| +----+ +----+
> + | | | | |
> + Off-|--------------+ +---------+ +------------------
> + |
> + 4 On -| +---------+
> + | | |
> + Off-|-------------------+ +-----------------------
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> +
> + Inverted bounce mode for Pipe LED::
> +
> + "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
> +
> + ^
> + |
> + 0 On -| +---------------------------------------+
> + | | |
> + Off-|----+ +--------
> + |
> + 1 On -|----+ +-----------------------------+ +--------
> + | | | | |
> + Off | +----+ +----+
> + |
> + 2 On -|---------+ +-------------------+ +-------------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 3 On -|--------------+ +---------+ +------------------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 4 On -|-------------------+ +-----------------------
> + | | |
> + Off-| +---------+
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
>
> What: /sys/class/leds/<led>/repeat
> Date: September 2019
> diff --git a/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx b/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
> index 45b1e605d355..215482379580 100644
> --- a/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
> +++ b/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
> @@ -12,8 +12,8 @@ Description:
> format, we should set brightness as 0 for rise stage, fall
> stage and low stage.
>
> - Min stage duration: 125 ms
> - Max stage duration: 31875 ms
> + - Min stage duration: 125 ms
> + - Max stage duration: 31875 ms
>
> Since the stage duration step is 125 ms, the duration should be
> a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.
> diff --git a/Documentation/ABI/testing/sysfs-class-mic b/Documentation/ABI/testing/sysfs-class-mic
> index 6ef682603179..bd0e780c3760 100644
> --- a/Documentation/ABI/testing/sysfs-class-mic
> +++ b/Documentation/ABI/testing/sysfs-class-mic
> @@ -41,24 +41,33 @@ Description:
> When read, this entry provides the current state of an Intel
> MIC device in the context of the card OS. Possible values that
> will be read are:
> - "ready" - The MIC device is ready to boot the card OS. On
> - reading this entry after an OSPM resume, a "boot" has to be
> - written to this entry if the card was previously shutdown
> - during OSPM suspend.
> - "booting" - The MIC device has initiated booting a card OS.
> - "online" - The MIC device has completed boot and is online
> - "shutting_down" - The card OS is shutting down.
> - "resetting" - A reset has been initiated for the MIC device
> - "reset_failed" - The MIC device has failed to reset.
> +
> +
> + =============== ===============================================
> + "ready" The MIC device is ready to boot the card OS.
> + On reading this entry after an OSPM resume,
> + a "boot" has to be written to this entry if
> + the card was previously shutdown during OSPM
> + suspend.
> + "booting" The MIC device has initiated booting a card OS.
> + "online" The MIC device has completed boot and is online
> + "shutting_down" The card OS is shutting down.
> + "resetting" A reset has been initiated for the MIC device
> + "reset_failed" The MIC device has failed to reset.
> + =============== ===============================================
>
> When written, this sysfs entry triggers different state change
> operations depending upon the current state of the card OS.
> Acceptable values are:
> - "boot" - Boot the card OS image specified by the combination
> - of firmware, ramdisk, cmdline and bootmode
> - sysfs entries.
> - "reset" - Initiates device reset.
> - "shutdown" - Initiates card OS shutdown.
> +
> +
> + ========== ===================================================
> + "boot" Boot the card OS image specified by the combination
> + of firmware, ramdisk, cmdline and bootmode
> + sysfs entries.
> + "reset" Initiates device reset.
> + "shutdown" Initiates card OS shutdown.
> + ========== ===================================================
>
> What: /sys/class/mic/mic(x)/shutdown_status
> Date: October 2013
> @@ -69,12 +78,15 @@ Description:
> OS can shutdown because of various reasons. When read, this
> entry provides the status on why the card OS was shutdown.
> Possible values are:
> - "nop" - shutdown status is not applicable, when the card OS is
> - "online"
> - "crashed" - Shutdown because of a HW or SW crash.
> - "halted" - Shutdown because of a halt command.
> - "poweroff" - Shutdown because of a poweroff command.
> - "restart" - Shutdown because of a restart command.
> +
> + ========== ===================================================
> + "nop" shutdown status is not applicable, when the card OS
> + is "online"
> + "crashed" Shutdown because of a HW or SW crash.
> + "halted" Shutdown because of a halt command.
> + "poweroff" Shutdown because of a poweroff command.
> + "restart" Shutdown because of a restart command.
> + ========== ===================================================
>
> What: /sys/class/mic/mic(x)/cmdline
> Date: October 2013
> diff --git a/Documentation/ABI/testing/sysfs-class-ocxl b/Documentation/ABI/testing/sysfs-class-ocxl
> index ae1276efa45a..bf33f4fda58f 100644
> --- a/Documentation/ABI/testing/sysfs-class-ocxl
> +++ b/Documentation/ABI/testing/sysfs-class-ocxl
> @@ -11,8 +11,11 @@ Contact: linuxppc-dev@lists.ozlabs.org
> Description: read only
> Number of contexts for the AFU, in the format <n>/<max>
> where:
> +
> + ==== ===============================================
> n: number of currently active contexts, for debug
> max: maximum number of contexts supported by the AFU
> + ==== ===============================================
>
> What: /sys/class/ocxl/<afu name>/pp_mmio_size
> Date: January 2018
> diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
> index dbccb2fcd7ce..d4319a04c302 100644
> --- a/Documentation/ABI/testing/sysfs-class-power
> +++ b/Documentation/ABI/testing/sysfs-class-power
> @@ -1,4 +1,4 @@
> -===== General Properties =====
> +**General Properties**
>
> What: /sys/class/power_supply/<supply_name>/manufacturer
> Date: May 2007
> @@ -72,6 +72,7 @@ Description:
> critically low).
>
> Access: Read, Write
> +
> Valid values: 0 - 100 (percent)
>
> What: /sys/class/power_supply/<supply_name>/capacity_error_margin
> @@ -96,7 +97,9 @@ Description:
> Coarse representation of battery capacity.
>
> Access: Read
> - Valid values: "Unknown", "Critical", "Low", "Normal", "High",
> +
> + Valid values:
> + "Unknown", "Critical", "Low", "Normal", "High",
> "Full"
>
> What: /sys/class/power_supply/<supply_name>/current_avg
> @@ -139,6 +142,7 @@ Description:
> throttling for thermal cooling or improving battery health.
>
> Access: Read, Write
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/charge_control_limit_max
> @@ -148,6 +152,7 @@ Description:
> Maximum legal value for the charge_control_limit property.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/charge_control_start_threshold
> @@ -168,6 +173,7 @@ Description:
> stop.
>
> Access: Read, Write
> +
> Valid values: 0 - 100 (percent)
>
> What: /sys/class/power_supply/<supply_name>/charge_type
> @@ -183,7 +189,9 @@ Description:
> different algorithm.
>
> Access: Read, Write
> - Valid values: "Unknown", "N/A", "Trickle", "Fast", "Standard",
> +
> + Valid values:
> + "Unknown", "N/A", "Trickle", "Fast", "Standard",
> "Adaptive", "Custom"
>
> What: /sys/class/power_supply/<supply_name>/charge_term_current
> @@ -194,6 +202,7 @@ Description:
> when the battery is considered full and charging should end.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/health
> @@ -204,7 +213,9 @@ Description:
> functionality.
>
> Access: Read
> - Valid values: "Unknown", "Good", "Overheat", "Dead",
> +
> + Valid values:
> + "Unknown", "Good", "Overheat", "Dead",
> "Over voltage", "Unspecified failure", "Cold",
> "Watchdog timer expire", "Safety timer expire",
> "Over current", "Calibration required", "Warm",
> @@ -218,6 +229,7 @@ Description:
> for a battery charge cycle.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/present
> @@ -227,9 +239,13 @@ Description:
> Reports whether a battery is present or not in the system.
>
> Access: Read
> +
> Valid values:
> +
> + == =======
> 0: Absent
> 1: Present
> + == =======
>
> What: /sys/class/power_supply/<supply_name>/status
> Date: May 2007
> @@ -240,7 +256,9 @@ Description:
> used to enable/disable charging to the battery.
>
> Access: Read, Write
> - Valid values: "Unknown", "Charging", "Discharging",
> +
> + Valid values:
> + "Unknown", "Charging", "Discharging",
> "Not charging", "Full"
>
> What: /sys/class/power_supply/<supply_name>/technology
> @@ -250,7 +268,9 @@ Description:
> Describes the battery technology supported by the supply.
>
> Access: Read
> - Valid values: "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
> +
> + Valid values:
> + "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
> "NiCd", "LiMn"
>
> What: /sys/class/power_supply/<supply_name>/temp
> @@ -260,6 +280,7 @@ Description:
> Reports the current TBAT battery temperature reading.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_max
> @@ -274,6 +295,7 @@ Description:
> critically high, and charging has stopped).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_min
> @@ -289,6 +311,7 @@ Description:
> remedy the situation).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_max
> @@ -299,6 +322,7 @@ Description:
> charging.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_min
> @@ -309,6 +333,7 @@ Description:
> charging.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/voltage_avg,
> @@ -320,6 +345,7 @@ Description:
> which they average readings to smooth out the reported value.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_max,
> @@ -330,6 +356,7 @@ Description:
> during charging.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_min,
> @@ -340,6 +367,7 @@ Description:
> during discharging.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_now,
> @@ -350,9 +378,10 @@ Description:
> This value is not averaged/smoothed.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> -===== USB Properties =====
> +**USB Properties**
>
> What: /sys/class/power_supply/<supply_name>/current_avg
> Date: May 2007
> @@ -363,6 +392,7 @@ Description:
> average readings to smooth out the reported value.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
>
> @@ -373,6 +403,7 @@ Description:
> Reports the maximum IBUS current the supply can support.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/current_now
> @@ -385,6 +416,7 @@ Description:
> within the reported min/max range.
>
> Access: Read, Write
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/input_current_limit
> @@ -399,6 +431,7 @@ Description:
> solved using power limit use input_current_limit.
>
> Access: Read, Write
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/input_voltage_limit
> @@ -441,10 +474,14 @@ Description:
> USB supply so voltage and current can be controlled).
>
> Access: Read, Write
> +
> Valid values:
> +
> + == ==================================================
> 0: Offline
> 1: Online Fixed - Fixed Voltage Supply
> 2: Online Programmable - Programmable Voltage Supply
> + == ==================================================
>
> What: /sys/class/power_supply/<supply_name>/temp
> Date: May 2007
> @@ -455,6 +492,7 @@ Description:
> TJUNC temperature of an IC)
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_max
> @@ -470,6 +508,7 @@ Description:
> remedy the situation).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_min
> @@ -485,6 +524,7 @@ Description:
> accordingly to remedy the situation).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_max
> @@ -494,6 +534,7 @@ Description:
> Reports the maximum allowed supply temperature for operation.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_min
> @@ -503,6 +544,7 @@ Description:
> Reports the mainimum allowed supply temperature for operation.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/usb_type
> @@ -514,7 +556,9 @@ Description:
> is attached.
>
> Access: Read-Only
> - Valid values: "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
> +
> + Valid values:
> + "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
> "PD_DRP", "PD_PPS", "BrickID"
>
> What: /sys/class/power_supply/<supply_name>/voltage_max
> @@ -524,6 +568,7 @@ Description:
> Reports the maximum VBUS voltage the supply can support.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_min
> @@ -533,6 +578,7 @@ Description:
> Reports the minimum VBUS voltage the supply can support.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_now
> @@ -545,9 +591,10 @@ Description:
> within the reported min/max range.
>
> Access: Read, Write
> +
> Valid values: Represented in microvolts
>
> -===== Device Specific Properties =====
> +**Device Specific Properties**
>
> What: /sys/class/power/ds2760-battery.*/charge_now
> Date: May 2010
> @@ -581,6 +628,7 @@ Description:
> will drop to 0 A) and will trigger interrupt.
>
> Valid values:
> +
> - 5, 6 or 7 (hours),
> - 0: disabled.
>
> @@ -595,6 +643,7 @@ Description:
> will drop to 0 A) and will trigger interrupt.
>
> Valid values:
> +
> - 4 - 16 (hours), step by 2 (rounded down)
> - 0: disabled.
>
> @@ -609,6 +658,7 @@ Description:
> interrupt and start top-off charging mode.
>
> Valid values:
> +
> - 100000 - 200000 (microamps), step by 25000 (rounded down)
> - 200000 - 350000 (microamps), step by 50000 (rounded down)
> - 0: disabled.
> @@ -624,6 +674,7 @@ Description:
> will drop to 0 A) and will trigger interrupt.
>
> Valid values:
> +
> - 0 - 70 (minutes), step by 10 (rounded down)
>
> What: /sys/class/power_supply/bq24257-charger/ovp_voltage
> @@ -637,6 +688,7 @@ Description:
> device datasheet for details.
>
> Valid values:
> +
> - 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000,
> 10500000 (all uV)
>
> @@ -652,6 +704,7 @@ Description:
> lower than the set value. See device datasheet for details.
>
> Valid values:
> +
> - 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000,
> 4760000 (all uV)
>
> @@ -666,6 +719,7 @@ Description:
> the charger operates normally. See device datasheet for details.
>
> Valid values:
> +
> - 1: enabled
> - 0: disabled
>
> @@ -681,6 +735,7 @@ Description:
> from the system. See device datasheet for details.
>
> Valid values:
> +
> - 1: enabled
> - 0: disabled
>
> diff --git a/Documentation/ABI/testing/sysfs-class-power-twl4030 b/Documentation/ABI/testing/sysfs-class-power-twl4030
> index b4fd32d210c5..7ac36dba87bc 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-twl4030
> +++ b/Documentation/ABI/testing/sysfs-class-power-twl4030
> @@ -4,18 +4,20 @@ Description:
> Writing to this can disable charging.
>
> Possible values are:
> - "auto" - draw power as appropriate for detected
> - power source and battery status.
> - "off" - do not draw any power.
> - "continuous"
> - - activate mode described as "linear" in
> - TWL data sheets. This uses whatever
> - current is available and doesn't switch off
> - when voltage drops.
>
> - This is useful for unstable power sources
> - such as bicycle dynamo, but care should
> - be taken that battery is not over-charged.
> + ============= ===========================================
> + "auto" draw power as appropriate for detected
> + power source and battery status.
> + "off" do not draw any power.
> + "continuous" activate mode described as "linear" in
> + TWL data sheets. This uses whatever
> + current is available and doesn't switch off
> + when voltage drops.
> +
> + This is useful for unstable power sources
> + such as bicycle dynamo, but care should
> + be taken that battery is not over-charged.
> + ============= ===========================================
>
> What: /sys/class/power_supply/twl4030_ac/mode
> Description:
> @@ -23,6 +25,9 @@ Description:
> Writing to this can disable charging.
>
> Possible values are:
> - "auto" - draw power as appropriate for detected
> - power source and battery status.
> - "off" - do not draw any power.
> +
> + ====== ===========================================
> + "auto" draw power as appropriate for detected
> + power source and battery status.
> + "off" do not draw any power.
> + ====== ===========================================
> diff --git a/Documentation/ABI/testing/sysfs-class-rc b/Documentation/ABI/testing/sysfs-class-rc
> index 6c0d6c8cb911..9c8ff7910858 100644
> --- a/Documentation/ABI/testing/sysfs-class-rc
> +++ b/Documentation/ABI/testing/sysfs-class-rc
> @@ -21,15 +21,22 @@ KernelVersion: 2.6.36
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Reading this file returns a list of available protocols,
> - something like:
> + something like::
> +
> "rc5 [rc6] nec jvc [sony]"
> +
> Enabled protocols are shown in [] brackets.
> +
> Writing "+proto" will add a protocol to the list of enabled
> protocols.
> +
> Writing "-proto" will remove a protocol from the list of enabled
> protocols.
> +
> Writing "proto" will enable only "proto".
> +
> Writing "none" will disable all protocols.
> +
> Write fails with EINVAL if an invalid protocol combination or
> unknown protocol name is used.
>
> @@ -39,11 +46,13 @@ KernelVersion: 3.15
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Sets the scancode filter expected value.
> +
> Use in combination with /sys/class/rc/rcN/filter_mask to set the
> expected value of the bits set in the filter mask.
> If the hardware supports it then scancodes which do not match
> the filter will be ignored. Otherwise the write will fail with
> an error.
> +
> This value may be reset to 0 if the current protocol is altered.
>
> What: /sys/class/rc/rcN/filter_mask
> @@ -56,9 +65,11 @@ Description:
> of the scancode which should be compared against the expected
> value. A value of 0 disables the filter to allow all valid
> scancodes to be processed.
> +
> If the hardware supports it then scancodes which do not match
> the filter will be ignored. Otherwise the write will fail with
> an error.
> +
> This value may be reset to 0 if the current protocol is altered.
>
> What: /sys/class/rc/rcN/wakeup_protocols
> @@ -67,15 +78,22 @@ KernelVersion: 4.11
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Reading this file returns a list of available protocols to use
> - for the wakeup filter, something like:
> + for the wakeup filter, something like::
> +
> "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
> +
> Note that protocol variants are listed, so "nec", "sony",
> "rc-5", "rc-6" have their different bit length encodings
> listed if available.
> +
> The enabled wakeup protocol is shown in [] brackets.
> +
> Only one protocol can be selected at a time.
> +
> Writing "proto" will use "proto" for wakeup events.
> +
> Writing "none" will disable wakeup.
> +
> Write fails with EINVAL if an invalid protocol combination or
> unknown protocol name is used, or if wakeup is not supported by
> the hardware.
> @@ -86,13 +104,17 @@ KernelVersion: 3.15
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Sets the scancode wakeup filter expected value.
> +
> Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
> set the expected value of the bits set in the wakeup filter mask
> to trigger a system wake event.
> +
> If the hardware supports it and wakeup_filter_mask is not 0 then
> scancodes which match the filter will wake the system from e.g.
> suspend to RAM or power off.
> +
> Otherwise the write will fail with an error.
> +
> This value may be reset to 0 if the wakeup protocol is altered.
>
> What: /sys/class/rc/rcN/wakeup_filter_mask
> @@ -101,11 +123,15 @@ KernelVersion: 3.15
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Sets the scancode wakeup filter mask of bits to compare.
> +
> Use in combination with /sys/class/rc/rcN/wakeup_filter to set
> the bits of the scancode which should be compared against the
> expected value to trigger a system wake event.
> +
> If the hardware supports it and wakeup_filter_mask is not 0 then
> scancodes which match the filter will wake the system from e.g.
> suspend to RAM or power off.
> +
> Otherwise the write will fail with an error.
> +
> This value may be reset to 0 if the wakeup protocol is altered.
> diff --git a/Documentation/ABI/testing/sysfs-class-scsi_host b/Documentation/ABI/testing/sysfs-class-scsi_host
> index bafc59fd7b69..7c98d8f43c45 100644
> --- a/Documentation/ABI/testing/sysfs-class-scsi_host
> +++ b/Documentation/ABI/testing/sysfs-class-scsi_host
> @@ -56,8 +56,9 @@ Description:
> management) on top, which makes it match the Windows IRST (Intel
> Rapid Storage Technology) driver settings. This setting is also
> close to min_power, except that:
> +
> a) It does not use host-initiated slumber mode, but it does
> - allow device-initiated slumber
> + allow device-initiated slumber
> b) It does not enable low power device sleep mode (DevSlp).
>
> What: /sys/class/scsi_host/hostX/em_message
> @@ -70,8 +71,8 @@ Description:
> protocol, writes and reads correspond to the LED message format
> as defined in the AHCI spec.
>
> - The user must turn sw_activity (under /sys/block/*/device/) OFF
> - it they wish to control the activity LED via the em_message
> + The user must turn sw_activity (under `/sys/block/*/device/`)
> + OFF it they wish to control the activity LED via the em_message
> file.
>
> em_message_type: (RO) Displays the current enclosure management
> diff --git a/Documentation/ABI/testing/sysfs-class-typec b/Documentation/ABI/testing/sysfs-class-typec
> index b834671522d6..b7794e02ad20 100644
> --- a/Documentation/ABI/testing/sysfs-class-typec
> +++ b/Documentation/ABI/testing/sysfs-class-typec
> @@ -40,10 +40,13 @@ Description:
> attribute will not return until the operation has finished.
>
> Valid values:
> - - source (The port will behave as source only DFP port)
> - - sink (The port will behave as sink only UFP port)
> - - dual (The port will behave as dual-role-data and
> +
> + ====== ==============================================
> + source (The port will behave as source only DFP port)
> + sink (The port will behave as sink only UFP port)
> + dual (The port will behave as dual-role-data and
> dual-role-power port)
> + ====== ==============================================
>
> What: /sys/class/typec/<port>/vconn_source
> Date: April 2017
> @@ -59,6 +62,7 @@ Description:
> generates uevent KOBJ_CHANGE.
>
> Valid values:
> +
> - "no" when the port is not the VCONN Source
> - "yes" when the port is the VCONN Source
>
> @@ -72,6 +76,7 @@ Description:
> power operation mode should show "usb_power_delivery".
>
> Valid values:
> +
> - default
> - 1.5A
> - 3.0A
> @@ -191,6 +196,7 @@ Date: April 2017
> Contact: Heikki Krogerus <heikki.krogerus@linux.intel.com>
> Description:
> Shows type of the plug on the cable:
> +
> - type-a - Standard A
> - type-b - Standard B
> - type-c
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD b/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
> index 7e43cdce9a52..f7b360a61b21 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
> @@ -7,6 +7,7 @@ Description:
> (RO) Hexadecimal bitmask of the TAD attributes are reported by
> the platform firmware (see ACPI 6.2, section 9.18.2):
>
> + ======= ======================================================
> BIT(0): AC wakeup implemented if set
> BIT(1): DC wakeup implemented if set
> BIT(2): Get/set real time features implemented if set
> @@ -16,6 +17,7 @@ Description:
> BIT(6): The AC timer wakes up from S5 if set
> BIT(7): The DC timer wakes up from S4 if set
> BIT(8): The DC timer wakes up from S5 if set
> + ======= ======================================================
>
> The other bits are reserved.
>
> @@ -62,9 +64,11 @@ Description:
> timer status with the following meaning of bits (see ACPI 6.2,
> Section 9.18.5):
>
> + ======= ======================================================
> Bit(0): The timer has expired if set.
> Bit(1): The timer has woken up the system from a sleep state
> (S3 or S4/S5 if supported) if set.
> + ======= ======================================================
>
> The other bits are reserved.
>
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-docg3 b/Documentation/ABI/testing/sysfs-devices-platform-docg3
> index 8aa36716882f..378c42694bfb 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-docg3
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-docg3
> @@ -9,8 +9,10 @@ Description:
> The protection has information embedded whether it blocks reads,
> writes or both.
> The result is:
> - 0 -> the DPS is not keylocked
> - 1 -> the DPS is keylocked
> +
> + - 0 -> the DPS is not keylocked
> + - 1 -> the DPS is keylocked
> +
> Users: None identified so far.
>
> What: /sys/devices/platform/docg3/f[0-3]_dps[01]_protection_key
> @@ -27,8 +29,12 @@ Description:
> Entering the correct value toggle the lock, and can be observed
> through f[0-3]_dps[01]_is_keylocked.
> Possible values are:
> +
> - 8 bytes
> +
> Typical values are:
> +
> - "00000000"
> - "12345678"
> +
> Users: None identified so far.
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb b/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
> index 2107082426da..e45ac2e865d5 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
> @@ -17,10 +17,10 @@ Description:
> to overlay planes.
>
> Selects the composition mode for the overlay. Possible values
> - are
> + are:
>
> - 0 - Alpha Blending
> - 1 - ROP3
> + - 0 - Alpha Blending
> + - 1 - ROP3
>
> What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_position
> Date: May 2012
> @@ -30,7 +30,7 @@ Description:
> to overlay planes.
>
> Stores the x,y overlay position on the display in pixels. The
> - position format is `[0-9]+,[0-9]+'.
> + position format is `[0-9]+,[0-9]+`.
>
> What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_rop3
> Date: May 2012
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu
> index b555df825447..274c337ec6a9 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-cpu
> +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
> @@ -151,23 +151,28 @@ Description:
> The processor idle states which are available for use have the
> following attributes:
>
> - name: (RO) Name of the idle state (string).
> + ======== ==== =================================================
> + name: (RO) Name of the idle state (string).
>
> latency: (RO) The latency to exit out of this idle state (in
> - microseconds).
> + microseconds).
>
> - power: (RO) The power consumed while in this idle state (in
> - milliwatts).
> + power: (RO) The power consumed while in this idle state (in
> + milliwatts).
>
> - time: (RO) The total time spent in this idle state (in microseconds).
> + time: (RO) The total time spent in this idle state
> + (in microseconds).
>
> - usage: (RO) Number of times this state was entered (a count).
> + usage: (RO) Number of times this state was entered (a count).
>
> - above: (RO) Number of times this state was entered, but the
> - observed CPU idle duration was too short for it (a count).
> + above: (RO) Number of times this state was entered, but the
> + observed CPU idle duration was too short for it
> + (a count).
>
> - below: (RO) Number of times this state was entered, but the
> - observed CPU idle duration was too long for it (a count).
> + below: (RO) Number of times this state was entered, but the
> + observed CPU idle duration was too long for it
> + (a count).
> + ======== ==== =================================================
>
> What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc
> Date: February 2008
> @@ -290,6 +295,7 @@ Description: Processor frequency boosting control
> This switch controls the boost setting for the whole system.
> Boosting allows the CPU and the firmware to run at a frequency
> beyound it's nominal limit.
> +
> More details can be found in
> Documentation/admin-guide/pm/cpufreq.rst
>
> @@ -337,43 +343,57 @@ Contact: Sudeep Holla <sudeep.holla@arm.com>
> Description: Parameters for the CPU cache attributes
>
> allocation_policy:
> - - WriteAllocate: allocate a memory location to a cache line
> - on a cache miss because of a write
> - - ReadAllocate: allocate a memory location to a cache line
> + - WriteAllocate:
> + allocate a memory location to a cache line
> + on a cache miss because of a write
> + - ReadAllocate:
> + allocate a memory location to a cache line
> on a cache miss because of a read
> - - ReadWriteAllocate: both writeallocate and readallocate
> + - ReadWriteAllocate:
> + both writeallocate and readallocate
>
> - attributes: LEGACY used only on IA64 and is same as write_policy
> + attributes:
> + LEGACY used only on IA64 and is same as write_policy
>
> - coherency_line_size: the minimum amount of data in bytes that gets
> + coherency_line_size:
> + the minimum amount of data in bytes that gets
> transferred from memory to cache
>
> - level: the cache hierarchy in the multi-level cache configuration
> + level:
> + the cache hierarchy in the multi-level cache configuration
>
> - number_of_sets: total number of sets in the cache, a set is a
> + number_of_sets:
> + total number of sets in the cache, a set is a
> collection of cache lines with the same cache index
>
> - physical_line_partition: number of physical cache line per cache tag
> + physical_line_partition:
> + number of physical cache line per cache tag
>
> - shared_cpu_list: the list of logical cpus sharing the cache
> + shared_cpu_list:
> + the list of logical cpus sharing the cache
>
> - shared_cpu_map: logical cpu mask containing the list of cpus sharing
> + shared_cpu_map:
> + logical cpu mask containing the list of cpus sharing
> the cache
>
> - size: the total cache size in kB
> + size:
> + the total cache size in kB
>
> type:
> - Instruction: cache that only holds instructions
> - Data: cache that only caches data
> - Unified: cache that holds both data and instructions
>
> - ways_of_associativity: degree of freedom in placing a particular block
> - of memory in the cache
> + ways_of_associativity:
> + degree of freedom in placing a particular block
> + of memory in the cache
>
> write_policy:
> - - WriteThrough: data is written to both the cache line
> + - WriteThrough:
> + data is written to both the cache line
> and to the block in the lower-level memory
> - - WriteBack: data is written only to the cache line and
> + - WriteBack:
> + data is written only to the cache line and
> the modified cache line is written to main
> memory only when it is replaced
>
> @@ -414,30 +434,30 @@ Description: POWERNV CPUFreq driver's frequency throttle stats directory and
> throttle attributes exported in the 'throttle_stats' directory:
>
> - turbo_stat : This file gives the total number of times the max
> - frequency is throttled to lower frequency in turbo (at and above
> - nominal frequency) range of frequencies.
> + frequency is throttled to lower frequency in turbo (at and above
> + nominal frequency) range of frequencies.
>
> - sub_turbo_stat : This file gives the total number of times the
> - max frequency is throttled to lower frequency in sub-turbo(below
> - nominal frequency) range of frequencies.
> + max frequency is throttled to lower frequency in sub-turbo(below
> + nominal frequency) range of frequencies.
>
> - unthrottle : This file gives the total number of times the max
> - frequency is unthrottled after being throttled.
> + frequency is unthrottled after being throttled.
>
> - powercap : This file gives the total number of times the max
> - frequency is throttled due to 'Power Capping'.
> + frequency is throttled due to 'Power Capping'.
>
> - overtemp : This file gives the total number of times the max
> - frequency is throttled due to 'CPU Over Temperature'.
> + frequency is throttled due to 'CPU Over Temperature'.
>
> - supply_fault : This file gives the total number of times the
> - max frequency is throttled due to 'Power Supply Failure'.
> + max frequency is throttled due to 'Power Supply Failure'.
>
> - overcurrent : This file gives the total number of times the
> - max frequency is throttled due to 'Overcurrent'.
> + max frequency is throttled due to 'Overcurrent'.
>
> - occ_reset : This file gives the total number of times the max
> - frequency is throttled due to 'OCC Reset'.
> + frequency is throttled due to 'OCC Reset'.
>
> The sysfs attributes representing different throttle reasons like
> powercap, overtemp, supply_fault, overcurrent and occ_reset map to
> @@ -469,8 +489,9 @@ What: /sys/devices/system/cpu/cpuX/regs/
> Date: June 2016
> Contact: Linux ARM Kernel Mailing list <linux-arm-kernel@lists.infradead.org>
> Description: AArch64 CPU registers
> +
> 'identification' directory exposes the CPU ID registers for
> - identifying model and revision of the CPU.
> + identifying model and revision of the CPU.
>
> What: /sys/devices/system/cpu/cpu#/cpu_capacity
> Date: December 2016
> @@ -497,9 +518,11 @@ Description: Information about CPU vulnerabilities
> vulnerabilities. The output of those files reflects the
> state of the CPUs in the system. Possible output values:
>
> + ================ ==============================================
> "Not affected" CPU is not affected by the vulnerability
> "Vulnerable" CPU is affected and no mitigation in effect
> "Mitigation: $M" CPU is affected and mitigation $M is in effect
> + ================ ==============================================
>
> See also: Documentation/admin-guide/hw-vuln/index.rst
>
> @@ -515,12 +538,14 @@ Description: Control Symetric Multi Threading (SMT)
> control: Read/write interface to control SMT. Possible
> values:
>
> + ================ =========================================
> "on" SMT is enabled
> "off" SMT is disabled
> "forceoff" SMT is force disabled. Cannot be changed.
> "notsupported" SMT is not supported by the CPU
> "notimplemented" SMT runtime toggling is not
> implemented for the architecture
> + ================ =========================================
>
> If control status is "forceoff" or "notsupported" writes
> are rejected.
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl b/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> index 470def06ab0a..1a8ee26e92ae 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> +++ b/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> @@ -5,8 +5,10 @@ Contact: Vernon Mauery <vernux@us.ibm.com>
> Description: The state file allows a means by which to change in and
> out of Premium Real-Time Mode (PRTM), as well as the
> ability to query the current state.
> - 0 => PRTM off
> - 1 => PRTM enabled
> +
> + - 0 => PRTM off
> + - 1 => PRTM enabled
> +
> Users: The ibm-prtm userspace daemon uses this interface.
>
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator b/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
> index 4d63a7904b94..42214b4ff14a 100644
> --- a/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
> +++ b/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
> @@ -6,11 +6,13 @@ Description: Read/write the current state of DDR Backup Mode, which controls
> if DDR power rails will be kept powered during system suspend.
> ("on"/"1" = enabled, "off"/"0" = disabled).
> Two types of power switches (or control signals) can be used:
> +
> A. With a momentary power switch (or pulse signal), DDR
> Backup Mode is enabled by default when available, as the
> PMIC will be configured only during system suspend.
> B. With a toggle power switch (or level signal), the
> following steps must be followed exactly:
> +
> 1. Configure PMIC for backup mode, to change the role of
> the accessory power switch from a power switch to a
> wake-up switch,
> @@ -20,8 +22,10 @@ Description: Read/write the current state of DDR Backup Mode, which controls
> 3. Suspend system,
> 4. Switch accessory power switch on, to resume the
> system.
> +
> DDR Backup Mode must be explicitly enabled by the user,
> to invoke step 1.
> +
> See also Documentation/devicetree/bindings/mfd/bd9571mwv.txt.
> Users: User space applications for embedded boards equipped with a
> BD9571MWV PMIC.
> diff --git a/Documentation/ABI/testing/sysfs-driver-genwqe b/Documentation/ABI/testing/sysfs-driver-genwqe
> index 64ac6d567c4b..69d855dc4c47 100644
> --- a/Documentation/ABI/testing/sysfs-driver-genwqe
> +++ b/Documentation/ABI/testing/sysfs-driver-genwqe
> @@ -29,8 +29,12 @@ What: /sys/class/genwqe/genwqe<n>_card/reload_bitstream
> Date: May 2014
> Contact: klebers@linux.vnet.ibm.com
> Description: Interface to trigger a PCIe card reset to reload the bitstream.
> +
> + ::
> +
> sudo sh -c 'echo 1 > \
> /sys/class/genwqe/genwqe0_card/reload_bitstream'
> +
> If successfully, the card will come back with the bitstream set
> on 'next_bitstream'.
>
> @@ -64,8 +68,11 @@ Description: Base clock frequency of the card.
> What: /sys/class/genwqe/genwqe<n>_card/device/sriov_numvfs
> Date: Oct 2013
> Contact: haver@linux.vnet.ibm.com
> -Description: Enable VFs (1..15):
> +Description: Enable VFs (1..15)::
> +
> sudo sh -c 'echo 15 > \
> /sys/bus/pci/devices/0000\:1b\:00.0/sriov_numvfs'
> - Disable VFs:
> +
> + Disable VFs::
> +
> Write a 0 into the same sysfs entry.
> diff --git a/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff b/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
> index 305dffd229a8..de07be314efc 100644
> --- a/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
> +++ b/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
> @@ -12,7 +12,9 @@ KernelVersion: 4.1
> Contact: Michal Malý <madcatxster@devoid-pointer.net>
> Description: Displays a set of alternate modes supported by a wheel. Each
> mode is listed as follows:
> +
> Tag: Mode Name
> +
> Currently active mode is marked with an asterisk. List also
> contains an abstract item "native" which always denotes the
> native mode of the wheel. Echoing the mode tag switches the
> @@ -24,24 +26,30 @@ Description: Displays a set of alternate modes supported by a wheel. Each
> This entry is not created for devices that have only one mode.
>
> Currently supported mode switches:
> - Driving Force Pro:
> +
> + Driving Force Pro::
> +
> DF-EX --> DFP
>
> - G25:
> + G25::
> +
> DF-EX --> DFP --> G25
>
> - G27:
> + G27::
> +
> DF-EX <*> DFP <-> G25 <-> G27
> DF-EX <*--------> G25 <-> G27
> DF-EX <*----------------> G27
>
> - G29:
> + G29::
> +
> DF-EX <*> DFP <-> G25 <-> G27 <-> G29
> DF-EX <*--------> G25 <-> G27 <-> G29
> DF-EX <*----------------> G27 <-> G29
> DF-EX <*------------------------> G29
>
> - DFGT:
> + DFGT::
> +
> DF-EX <*> DFP <-> DFGT
> DF-EX <*--------> DFGT
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-hid-wiimote b/Documentation/ABI/testing/sysfs-driver-hid-wiimote
> index 39dfa5cb1cc5..cd7b82a5c27d 100644
> --- a/Documentation/ABI/testing/sysfs-driver-hid-wiimote
> +++ b/Documentation/ABI/testing/sysfs-driver-hid-wiimote
> @@ -39,9 +39,13 @@ Description: While a device is initialized by the wiimote driver, we perform
> Other strings for each device-type are available and may be
> added if new device-specific detections are added.
> Currently supported are:
> - gen10: First Wii Remote generation
> - gen20: Second Wii Remote Plus generation (builtin MP)
> +
> + ============= =======================================
> + gen10: First Wii Remote generation
> + gen20: Second Wii Remote Plus generation
> + (builtin MP)
> balanceboard: Wii Balance Board
> + ============= =======================================
>
> What: /sys/bus/hid/drivers/wiimote/<dev>/bboard_calib
> Date: May 2013
> @@ -54,6 +58,7 @@ Description: This attribute is only provided if the device was detected as a
> First, 0kg values for all 4 sensors are written, followed by the
> 17kg values for all 4 sensors and last the 34kg values for all 4
> sensors.
> +
> Calibration data is already applied by the kernel to all input
> values but may be used by user-space to perform other
> transformations.
> @@ -68,9 +73,11 @@ Description: This attribute is only provided if the device was detected as a
> is prefixed with a +/-. Each value is a signed 16bit number.
> Data is encoded as decimal numbers and specifies the offsets of
> the analog sticks of the pro-controller.
> +
> Calibration data is already applied by the kernel to all input
> values but may be used by user-space to perform other
> transformations.
> +
> Calibration data is detected by the kernel during device setup.
> You can write "scan\n" into this file to re-trigger calibration.
> You can also write data directly in the form "x1:y1 x2:y2" to
> diff --git a/Documentation/ABI/testing/sysfs-driver-samsung-laptop b/Documentation/ABI/testing/sysfs-driver-samsung-laptop
> index 34d3a3359cf4..28c9c040de5d 100644
> --- a/Documentation/ABI/testing/sysfs-driver-samsung-laptop
> +++ b/Documentation/ABI/testing/sysfs-driver-samsung-laptop
> @@ -9,10 +9,12 @@ Description: Some Samsung laptops have different "performance levels"
> their fans quiet at all costs. Reading from this file
> will show the current performance level. Writing to the
> file can change this value.
> +
> Valid options:
> - "silent"
> - "normal"
> - "overclock"
> + - "silent"
> + - "normal"
> + - "overclock"
> +
> Note that not all laptops support all of these options.
> Specifically, not all support the "overclock" option,
> and it's still unknown if this value even changes
> @@ -25,8 +27,9 @@ Contact: Corentin Chary <corentin.chary@gmail.com>
> Description: Max battery charge level can be modified, battery cycle
> life can be extended by reducing the max battery charge
> level.
> - 0 means normal battery mode (100% charge)
> - 1 means battery life extender mode (80% charge)
> +
> + - 0 means normal battery mode (100% charge)
> + - 1 means battery life extender mode (80% charge)
>
> What: /sys/devices/platform/samsung/usb_charge
> Date: December 1, 2011
> diff --git a/Documentation/ABI/testing/sysfs-driver-toshiba_acpi b/Documentation/ABI/testing/sysfs-driver-toshiba_acpi
> index f34221b52b14..e5a438d84e1f 100644
> --- a/Documentation/ABI/testing/sysfs-driver-toshiba_acpi
> +++ b/Documentation/ABI/testing/sysfs-driver-toshiba_acpi
> @@ -4,10 +4,12 @@ KernelVersion: 3.15
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the keyboard backlight operation mode, valid
> values are:
> +
> * 0x1 -> FN-Z
> * 0x2 -> AUTO (also called TIMER)
> * 0x8 -> ON
> * 0x10 -> OFF
> +
> Note that from kernel 3.16 onwards this file accepts all listed
> parameters, kernel 3.15 only accepts the first two (FN-Z and
> AUTO).
> @@ -41,8 +43,10 @@ KernelVersion: 3.15
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This files controls the status of the touchpad and pointing
> stick (if available), valid values are:
> +
> * 0 -> OFF
> * 1 -> ON
> +
> Users: KToshiba
>
> What: /sys/devices/LNXSYSTM:00/LNXSYBUS:00/TOS{1900,620{0,7,8}}:00/available_kbd_modes
> @@ -51,10 +55,12 @@ KernelVersion: 3.16
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file shows the supported keyboard backlight modes
> the system supports, which can be:
> +
> * 0x1 -> FN-Z
> * 0x2 -> AUTO (also called TIMER)
> * 0x8 -> ON
> * 0x10 -> OFF
> +
> Note that not all keyboard types support the listed modes.
> See the entry named "available_kbd_modes"
> Users: KToshiba
> @@ -65,6 +71,7 @@ KernelVersion: 3.16
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file shows the current keyboard backlight type,
> which can be:
> +
> * 1 -> Type 1, supporting modes FN-Z and AUTO
> * 2 -> Type 2, supporting modes TIMER, ON and OFF
> Users: KToshiba
> @@ -75,10 +82,12 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB Sleep & Charge charging mode, which
> can be:
> +
> * 0 -> Disabled (0x00)
> * 1 -> Alternate (0x09)
> * 2 -> Auto (0x21)
> * 3 -> Typical (0x11)
> +
> Note that from kernel 4.1 onwards this file accepts all listed
> values, kernel 4.0 only supports the first three.
> Note that this feature only works when connected to power, if
> @@ -93,8 +102,10 @@ Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB Sleep Functions under battery, and
> set the level at which point they will be disabled, accepted
> values can be:
> +
> * 0 -> Disabled
> * 1-100 -> Battery level to disable sleep functions
> +
> Currently it prints two values, the first one indicates if the
> feature is enabled or disabled, while the second one shows the
> current battery level set.
> @@ -107,8 +118,10 @@ Date: January 23, 2015
> KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB Rapid Charge state, which can be:
> +
> * 0 -> Disabled
> * 1 -> Enabled
> +
> Note that toggling this value requires a reboot for changes to
> take effect.
> Users: KToshiba
> @@ -118,8 +131,10 @@ Date: January 23, 2015
> KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the Sleep & Music state, which values can be:
> +
> * 0 -> Disabled
> * 1 -> Enabled
> +
> Note that this feature only works when connected to power, if
> you want to use it under battery, see the entry named
> "sleep_functions_on_battery"
> @@ -138,6 +153,7 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the state of the internal fan, valid
> values are:
> +
> * 0 -> OFF
> * 1 -> ON
>
> @@ -147,8 +163,10 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the Special Functions (hotkeys) operation
> mode, valid values are:
> +
> * 0 -> Normal Operation
> * 1 -> Special Functions
> +
> In the "Normal Operation" mode, the F{1-12} keys are as usual
> and the hotkeys are accessed via FN-F{1-12}.
> In the "Special Functions" mode, the F{1-12} keys trigger the
> @@ -163,8 +181,10 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls whether the laptop should turn ON whenever
> the LID is opened, valid values are:
> +
> * 0 -> Disabled
> * 1 -> Enabled
> +
> Note that toggling this value requires a reboot for changes to
> take effect.
> Users: KToshiba
> @@ -174,8 +194,10 @@ Date: February 12, 2015
> KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB 3 functionality, valid values are:
> +
> * 0 -> Disabled (Acts as a regular USB 2)
> * 1 -> Enabled (Full USB 3 functionality)
> +
> Note that toggling this value requires a reboot for changes to
> take effect.
> Users: KToshiba
> @@ -188,10 +210,14 @@ Description: This file controls the Cooling Method feature.
> Reading this file prints two values, the first is the actual cooling method
> and the second is the maximum cooling method supported.
> When the maximum cooling method is ONE, valid values are:
> +
> * 0 -> Maximum Performance
> * 1 -> Battery Optimized
> +
> When the maximum cooling method is TWO, valid values are:
> +
> * 0 -> Maximum Performance
> * 1 -> Performance
> * 2 -> Battery Optimized
> +
> Users: KToshiba
> diff --git a/Documentation/ABI/testing/sysfs-driver-toshiba_haps b/Documentation/ABI/testing/sysfs-driver-toshiba_haps
> index a662370b4dbf..c938690ce10d 100644
> --- a/Documentation/ABI/testing/sysfs-driver-toshiba_haps
> +++ b/Documentation/ABI/testing/sysfs-driver-toshiba_haps
> @@ -4,10 +4,12 @@ KernelVersion: 3.17
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the built-in accelerometer protection level,
> valid values are:
> +
> * 0 -> Disabled
> * 1 -> Low
> * 2 -> Medium
> * 3 -> High
> +
> The default potection value is set to 2 (Medium).
> Users: KToshiba
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-wacom b/Documentation/ABI/testing/sysfs-driver-wacom
> index afc48fc163b5..16acaa5712ec 100644
> --- a/Documentation/ABI/testing/sysfs-driver-wacom
> +++ b/Documentation/ABI/testing/sysfs-driver-wacom
> @@ -79,7 +79,9 @@ Description:
> When the Wacom Intuos 4 is connected over Bluetooth, the
> image has to contain 256 bytes (64x32 px 1 bit colour).
> The format is also scrambled, like in the USB mode, and it can
> - be summarized by converting 76543210 into GECA6420.
> + be summarized by converting::
> +
> + 76543210 into GECA6420.
> HGFEDCBA HFDB7531
>
> What: /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote
> diff --git a/Documentation/ABI/testing/sysfs-firmware-acpi b/Documentation/ABI/testing/sysfs-firmware-acpi
> index 613f42a9d5cd..e4afc2538210 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-acpi
> +++ b/Documentation/ABI/testing/sysfs-firmware-acpi
> @@ -12,11 +12,14 @@ Description:
> image: The image bitmap. Currently a 32-bit BMP.
> status: 1 if the image is valid, 0 if firmware invalidated it.
> type: 0 indicates image is in BMP format.
> +
> + ======== ===================================================
> version: The version of the BGRT. Currently 1.
> xoffset: The number of pixels between the left of the screen
> and the left edge of the image.
> yoffset: The number of pixels between the top of the screen
> and the top edge of the image.
> + ======== ===================================================
>
> What: /sys/firmware/acpi/hotplug/
> Date: February 2013
> @@ -33,12 +36,14 @@ Description:
> The following setting is available to user space for each
> hotplug profile:
>
> + ======== =======================================================
> enabled: If set, the ACPI core will handle notifications of
> - hotplug events associated with the given class of
> - devices and will allow those devices to be ejected with
> - the help of the _EJ0 control method. Unsetting it
> - effectively disables hotplug for the correspoinding
> - class of devices.
> + hotplug events associated with the given class of
> + devices and will allow those devices to be ejected with
> + the help of the _EJ0 control method. Unsetting it
> + effectively disables hotplug for the correspoinding
> + class of devices.
> + ======== =======================================================
>
> The value of the above attribute is an integer number: 1 (set)
> or 0 (unset). Attempts to write any other values to it will
> @@ -71,86 +76,90 @@ Description:
> To figure out where all the SCI's are coming from,
> /sys/firmware/acpi/interrupts contains a file listing
> every possible source, and the count of how many
> - times it has triggered.
> -
> - $ cd /sys/firmware/acpi/interrupts
> - $ grep . *
> - error: 0
> - ff_gbl_lock: 0 enable
> - ff_pmtimer: 0 invalid
> - ff_pwr_btn: 0 enable
> - ff_rt_clk: 2 disable
> - ff_slp_btn: 0 invalid
> - gpe00: 0 invalid
> - gpe01: 0 enable
> - gpe02: 108 enable
> - gpe03: 0 invalid
> - gpe04: 0 invalid
> - gpe05: 0 invalid
> - gpe06: 0 enable
> - gpe07: 0 enable
> - gpe08: 0 invalid
> - gpe09: 0 invalid
> - gpe0A: 0 invalid
> - gpe0B: 0 invalid
> - gpe0C: 0 invalid
> - gpe0D: 0 invalid
> - gpe0E: 0 invalid
> - gpe0F: 0 invalid
> - gpe10: 0 invalid
> - gpe11: 0 invalid
> - gpe12: 0 invalid
> - gpe13: 0 invalid
> - gpe14: 0 invalid
> - gpe15: 0 invalid
> - gpe16: 0 invalid
> - gpe17: 1084 enable
> - gpe18: 0 enable
> - gpe19: 0 invalid
> - gpe1A: 0 invalid
> - gpe1B: 0 invalid
> - gpe1C: 0 invalid
> - gpe1D: 0 invalid
> - gpe1E: 0 invalid
> - gpe1F: 0 invalid
> - gpe_all: 1192
> - sci: 1194
> - sci_not: 0
> -
> - sci - The number of times the ACPI SCI
> - has been called and claimed an interrupt.
> -
> - sci_not - The number of times the ACPI SCI
> - has been called and NOT claimed an interrupt.
> -
> - gpe_all - count of SCI caused by GPEs.
> -
> - gpeXX - count for individual GPE source
> -
> - ff_gbl_lock - Global Lock
> -
> - ff_pmtimer - PM Timer
> -
> - ff_pwr_btn - Power Button
> -
> - ff_rt_clk - Real Time Clock
> -
> - ff_slp_btn - Sleep Button
> -
> - error - an interrupt that can't be accounted for above.
> -
> - invalid: it's either a GPE or a Fixed Event that
> - doesn't have an event handler.
> -
> - disable: the GPE/Fixed Event is valid but disabled.
> -
> - enable: the GPE/Fixed Event is valid and enabled.
> -
> - Root has permission to clear any of these counters. Eg.
> - # echo 0 > gpe11
> -
> - All counters can be cleared by clearing the total "sci":
> - # echo 0 > sci
> + times it has triggered::
> +
> + $ cd /sys/firmware/acpi/interrupts
> + $ grep . *
> + error: 0
> + ff_gbl_lock: 0 enable
> + ff_pmtimer: 0 invalid
> + ff_pwr_btn: 0 enable
> + ff_rt_clk: 2 disable
> + ff_slp_btn: 0 invalid
> + gpe00: 0 invalid
> + gpe01: 0 enable
> + gpe02: 108 enable
> + gpe03: 0 invalid
> + gpe04: 0 invalid
> + gpe05: 0 invalid
> + gpe06: 0 enable
> + gpe07: 0 enable
> + gpe08: 0 invalid
> + gpe09: 0 invalid
> + gpe0A: 0 invalid
> + gpe0B: 0 invalid
> + gpe0C: 0 invalid
> + gpe0D: 0 invalid
> + gpe0E: 0 invalid
> + gpe0F: 0 invalid
> + gpe10: 0 invalid
> + gpe11: 0 invalid
> + gpe12: 0 invalid
> + gpe13: 0 invalid
> + gpe14: 0 invalid
> + gpe15: 0 invalid
> + gpe16: 0 invalid
> + gpe17: 1084 enable
> + gpe18: 0 enable
> + gpe19: 0 invalid
> + gpe1A: 0 invalid
> + gpe1B: 0 invalid
> + gpe1C: 0 invalid
> + gpe1D: 0 invalid
> + gpe1E: 0 invalid
> + gpe1F: 0 invalid
> + gpe_all: 1192
> + sci: 1194
> + sci_not: 0
> +
> + =========== ==================================================
> + sci The number of times the ACPI SCI
> + has been called and claimed an interrupt.
> +
> + sci_not The number of times the ACPI SCI
> + has been called and NOT claimed an interrupt.
> +
> + gpe_all count of SCI caused by GPEs.
> +
> + gpeXX count for individual GPE source
> +
> + ff_gbl_lock Global Lock
> +
> + ff_pmtimer PM Timer
> +
> + ff_pwr_btn Power Button
> +
> + ff_rt_clk Real Time Clock
> +
> + ff_slp_btn Sleep Button
> +
> + error an interrupt that can't be accounted for above.
> +
> + invalid it's either a GPE or a Fixed Event that
> + doesn't have an event handler.
> +
> + disable the GPE/Fixed Event is valid but disabled.
> +
> + enable the GPE/Fixed Event is valid and enabled.
> + =========== ==================================================
> +
> + Root has permission to clear any of these counters. Eg.::
> +
> + # echo 0 > gpe11
> +
> + All counters can be cleared by clearing the total "sci"::
> +
> + # echo 0 > sci
>
> None of these counters has an effect on the function
> of the system, they are simply statistics.
> @@ -165,32 +174,34 @@ Description:
>
> Let's take power button fixed event for example, please kill acpid
> and other user space applications so that the machine won't shutdown
> - when pressing the power button.
> - # cat ff_pwr_btn
> - 0 enabled
> - # press the power button for 3 times;
> - # cat ff_pwr_btn
> - 3 enabled
> - # echo disable > ff_pwr_btn
> - # cat ff_pwr_btn
> - 3 disabled
> - # press the power button for 3 times;
> - # cat ff_pwr_btn
> - 3 disabled
> - # echo enable > ff_pwr_btn
> - # cat ff_pwr_btn
> - 4 enabled
> - /*
> - * this is because the status bit is set even if the enable bit is cleared,
> - * and it triggers an ACPI fixed event when the enable bit is set again
> - */
> - # press the power button for 3 times;
> - # cat ff_pwr_btn
> - 7 enabled
> - # echo disable > ff_pwr_btn
> - # press the power button for 3 times;
> - # echo clear > ff_pwr_btn /* clear the status bit */
> - # echo disable > ff_pwr_btn
> - # cat ff_pwr_btn
> - 7 enabled
> + when pressing the power button::
> +
> + # cat ff_pwr_btn
> + 0 enabled
> + # press the power button for 3 times;
> + # cat ff_pwr_btn
> + 3 enabled
> + # echo disable > ff_pwr_btn
> + # cat ff_pwr_btn
> + 3 disabled
> + # press the power button for 3 times;
> + # cat ff_pwr_btn
> + 3 disabled
> + # echo enable > ff_pwr_btn
> + # cat ff_pwr_btn
> + 4 enabled
> + /*
> + * this is because the status bit is set even if the enable
> + * bit is cleared, and it triggers an ACPI fixed event when
> + * the enable bit is set again
> + */
> + # press the power button for 3 times;
> + # cat ff_pwr_btn
> + 7 enabled
> + # echo disable > ff_pwr_btn
> + # press the power button for 3 times;
> + # echo clear > ff_pwr_btn /* clear the status bit */
> + # echo disable > ff_pwr_btn
> + # cat ff_pwr_btn
> + 7 enabled
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-dmi-entries b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> index 210ad44b95a5..fe0289c87768 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> +++ b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> @@ -33,7 +33,7 @@ Description:
> doesn't matter), they will be represented in sysfs as
> entries "T-0" through "T-(N-1)":
>
> - Example entry directories:
> + Example entry directories::
>
> /sys/firmware/dmi/entries/17-0
> /sys/firmware/dmi/entries/17-1
> @@ -50,61 +50,65 @@ Description:
> Each DMI entry in sysfs has the common header values
> exported as attributes:
>
> - handle : The 16bit 'handle' that is assigned to this
> + ======== =================================================
> + handle The 16bit 'handle' that is assigned to this
> entry by the firmware. This handle may be
> referred to by other entries.
> - length : The length of the entry, as presented in the
> + length The length of the entry, as presented in the
> entry itself. Note that this is _not the
> total count of bytes associated with the
> - entry_. This value represents the length of
> + entry. This value represents the length of
> the "formatted" portion of the entry. This
> "formatted" region is sometimes followed by
> the "unformatted" region composed of nul
> terminated strings, with termination signalled
> by a two nul characters in series.
> - raw : The raw bytes of the entry. This includes the
> + raw The raw bytes of the entry. This includes the
> "formatted" portion of the entry, the
> "unformatted" strings portion of the entry,
> and the two terminating nul characters.
> - type : The type of the entry. This value is the same
> + type The type of the entry. This value is the same
> as found in the directory name. It indicates
> how the rest of the entry should be interpreted.
> - instance: The instance ordinal of the entry for the
> + instance The instance ordinal of the entry for the
> given type. This value is the same as found
> in the parent directory name.
> - position: The ordinal position (zero-based) of the entry
> + position The ordinal position (zero-based) of the entry
> within the entirety of the DMI entry table.
> + ======== =================================================
>
> - === Entry Specialization ===
> + **Entry Specialization**
>
> Some entry types may have other information available in
> sysfs. Not all types are specialized.
>
> - --- Type 15 - System Event Log ---
> + **Type 15 - System Event Log**
>
> This entry allows the firmware to export a log of
> events the system has taken. This information is
> typically backed by nvram, but the implementation
> details are abstracted by this table. This entry's data
> - is exported in the directory:
> + is exported in the directory::
>
> - /sys/firmware/dmi/entries/15-0/system_event_log
> + /sys/firmware/dmi/entries/15-0/system_event_log
>
> and has the following attributes (documented in the
> SMBIOS / DMI specification under "System Event Log (Type 15)":
>
> - area_length
> - header_start_offset
> - data_start_offset
> - access_method
> - status
> - change_token
> - access_method_address
> - header_format
> - per_log_type_descriptor_length
> - type_descriptors_supported_count
> + - area_length
> + - header_start_offset
> + - data_start_offset
> + - access_method
> + - status
> + - change_token
> + - access_method_address
> + - header_format
> + - per_log_type_descriptor_length
> + - type_descriptors_supported_count
>
> As well, the kernel exports the binary attribute:
>
> - raw_event_log : The raw binary bits of the event log
> + ============= ====================================
> + raw_event_log The raw binary bits of the event log
> as described by the DMI entry.
> + ============= ====================================
> diff --git a/Documentation/ABI/testing/sysfs-firmware-gsmi b/Documentation/ABI/testing/sysfs-firmware-gsmi
> index 0faa0aaf4b6a..7a558354c1ee 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-gsmi
> +++ b/Documentation/ABI/testing/sysfs-firmware-gsmi
> @@ -20,7 +20,7 @@ Description:
>
> This directory has the same layout (and
> underlying implementation as /sys/firmware/efi/vars.
> - See Documentation/ABI/*/sysfs-firmware-efi-vars
> + See `Documentation/ABI/*/sysfs-firmware-efi-vars`
> for more information on how to interact with
> this structure.
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-memmap b/Documentation/ABI/testing/sysfs-firmware-memmap
> index eca0d65087dc..1f6f4d3a32c0 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-memmap
> +++ b/Documentation/ABI/testing/sysfs-firmware-memmap
> @@ -20,7 +20,7 @@ Description:
> the raw memory map to userspace.
>
> The structure is as follows: Under /sys/firmware/memmap there
> - are subdirectories with the number of the entry as their name:
> + are subdirectories with the number of the entry as their name::
>
> /sys/firmware/memmap/0
> /sys/firmware/memmap/1
> @@ -34,14 +34,16 @@ Description:
>
> Each directory contains three files:
>
> - start : The start address (as hexadecimal number with the
> + ======== =====================================================
> + start The start address (as hexadecimal number with the
> '0x' prefix).
> - end : The end address, inclusive (regardless whether the
> + end The end address, inclusive (regardless whether the
> firmware provides inclusive or exclusive ranges).
> - type : Type of the entry as string. See below for a list of
> + type Type of the entry as string. See below for a list of
> valid types.
> + ======== =====================================================
>
> - So, for example:
> + So, for example::
>
> /sys/firmware/memmap/0/start
> /sys/firmware/memmap/0/end
> @@ -57,9 +59,8 @@ Description:
> - reserved
>
> Following shell snippet can be used to display that memory
> - map in a human-readable format:
> + map in a human-readable format::
>
> - -------------------- 8< ----------------------------------------
> #!/bin/bash
> cd /sys/firmware/memmap
> for dir in * ; do
> @@ -68,4 +69,3 @@ Description:
> type=$(cat $dir/type)
> printf "%016x-%016x (%s)\n" $start $[ $end +1] "$type"
> done
> - -------------------- >8 ----------------------------------------
> diff --git a/Documentation/ABI/testing/sysfs-fs-ext4 b/Documentation/ABI/testing/sysfs-fs-ext4
> index 78604db56279..99e3d92f8299 100644
> --- a/Documentation/ABI/testing/sysfs-fs-ext4
> +++ b/Documentation/ABI/testing/sysfs-fs-ext4
> @@ -45,8 +45,8 @@ Description:
> parameter will have their blocks allocated out of a
> block group specific preallocation pool, so that small
> files are packed closely together. Each large file
> - will have its blocks allocated out of its own unique
> - preallocation pool.
> + will have its blocks allocated out of its own unique
> + preallocation pool.
>
> What: /sys/fs/ext4/<disk>/inode_readahead_blks
> Date: March 2008
> diff --git a/Documentation/ABI/testing/sysfs-hypervisor-xen b/Documentation/ABI/testing/sysfs-hypervisor-xen
> index 53b7b2ea7515..4dbe0c49b393 100644
> --- a/Documentation/ABI/testing/sysfs-hypervisor-xen
> +++ b/Documentation/ABI/testing/sysfs-hypervisor-xen
> @@ -15,14 +15,17 @@ KernelVersion: 4.3
> Contact: Boris Ostrovsky <boris.ostrovsky@oracle.com>
> Description: If running under Xen:
> Describes mode that Xen's performance-monitoring unit (PMU)
> - uses. Accepted values are
> - "off" -- PMU is disabled
> - "self" -- The guest can profile itself
> - "hv" -- The guest can profile itself and, if it is
> + uses. Accepted values are:
> +
> + ====== ============================================
> + "off" PMU is disabled
> + "self" The guest can profile itself
> + "hv" The guest can profile itself and, if it is
> privileged (e.g. dom0), the hypervisor
> - "all" -- The guest can profile itself, the hypervisor
> + "all" The guest can profile itself, the hypervisor
> and all other guests. Only available to
> privileged guests.
> + ====== ============================================
>
> What: /sys/hypervisor/pmu/pmu_features
> Date: August 2015
> diff --git a/Documentation/ABI/testing/sysfs-kernel-boot_params b/Documentation/ABI/testing/sysfs-kernel-boot_params
> index eca38ce2852d..7f9bda453c4d 100644
> --- a/Documentation/ABI/testing/sysfs-kernel-boot_params
> +++ b/Documentation/ABI/testing/sysfs-kernel-boot_params
> @@ -23,16 +23,17 @@ Description: The /sys/kernel/boot_params directory contains two
> representation of setup_data type. "data" file is the binary
> representation of setup_data payload.
>
> - The whole boot_params directory structure is like below:
> - /sys/kernel/boot_params
> - |__ data
> - |__ setup_data
> - | |__ 0
> - | | |__ data
> - | | |__ type
> - | |__ 1
> - | |__ data
> - | |__ type
> - |__ version
> + The whole boot_params directory structure is like below::
> +
> + /sys/kernel/boot_params
> + |__ data
> + |__ setup_data
> + | |__ 0
> + | | |__ data
> + | | |__ type
> + | |__ 1
> + | |__ data
> + | |__ type
> + |__ version
>
> Users: Kexec
> diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages
> index fdaa2162fae1..294387e2c7fb 100644
> --- a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages
> +++ b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages
> @@ -7,9 +7,11 @@ Description:
> of the hugepages supported by the kernel/CPU combination.
>
> Under these directories are a number of files:
> - nr_hugepages
> - nr_overcommit_hugepages
> - free_hugepages
> - surplus_hugepages
> - resv_hugepages
> +
> + - nr_hugepages
> + - nr_overcommit_hugepages
> + - free_hugepages
> + - surplus_hugepages
> + - resv_hugepages
> +
> See Documentation/admin-guide/mm/hugetlbpage.rst for details.
> diff --git a/Documentation/ABI/testing/sysfs-platform-asus-laptop b/Documentation/ABI/testing/sysfs-platform-asus-laptop
> index 8b0e8205a6a2..c78d358dbdbe 100644
> --- a/Documentation/ABI/testing/sysfs-platform-asus-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-asus-laptop
> @@ -4,13 +4,16 @@ KernelVersion: 2.6.20
> Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> This file allows display switching. The value
> - is composed by 4 bits and defined as follow:
> - 4321
> - |||`- LCD
> - ||`-- CRT
> - |`--- TV
> - `---- DVI
> - Ex: - 0 (0000b) means no display
> + is composed by 4 bits and defined as follow::
> +
> + 4321
> + |||`- LCD
> + ||`-- CRT
> + |`--- TV
> + `---- DVI
> +
> + Ex:
> + - 0 (0000b) means no display
> - 3 (0011b) CRT+LCD.
>
> What: /sys/devices/platform/asus_laptop/gps
> @@ -28,8 +31,10 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> Some models like the W1N have a LED display that can be
> used to display several items of information.
> - To control the LED display, use the following :
> + To control the LED display, use the following::
> +
> echo 0x0T000DDD > /sys/devices/platform/asus_laptop/
> +
> where T control the 3 letters display, and DDD the 3 digits display.
> The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst
>
> diff --git a/Documentation/ABI/testing/sysfs-platform-asus-wmi b/Documentation/ABI/testing/sysfs-platform-asus-wmi
> index 1efac0ddb417..04885738cf15 100644
> --- a/Documentation/ABI/testing/sysfs-platform-asus-wmi
> +++ b/Documentation/ABI/testing/sysfs-platform-asus-wmi
> @@ -5,6 +5,7 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> Change CPU clock configuration (write-only).
> There are three available clock configuration:
> +
> * 0 -> Super Performance Mode
> * 1 -> High Performance Mode
> * 2 -> Power Saving Mode
> diff --git a/Documentation/ABI/testing/sysfs-platform-at91 b/Documentation/ABI/testing/sysfs-platform-at91
> index 4cc6a865ae66..b146be74b8e0 100644
> --- a/Documentation/ABI/testing/sysfs-platform-at91
> +++ b/Documentation/ABI/testing/sysfs-platform-at91
> @@ -18,8 +18,10 @@ Description:
> In order to use an extended can_id add the
> CAN_EFF_FLAG (0x80000000U) to the can_id. Example:
>
> - - standard id 0x7ff:
> - echo 0x7ff > /sys/class/net/can0/mb0_id
> + - standard id 0x7ff::
>
> - - extended id 0x1fffffff:
> - echo 0x9fffffff > /sys/class/net/can0/mb0_id
> + echo 0x7ff > /sys/class/net/can0/mb0_id
> +
> + - extended id 0x1fffffff::
> +
> + echo 0x9fffffff > /sys/class/net/can0/mb0_id
> diff --git a/Documentation/ABI/testing/sysfs-platform-eeepc-laptop b/Documentation/ABI/testing/sysfs-platform-eeepc-laptop
> index 5b026c69587a..70dbe0733cf6 100644
> --- a/Documentation/ABI/testing/sysfs-platform-eeepc-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-eeepc-laptop
> @@ -4,9 +4,11 @@ KernelVersion: 2.6.26
> Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> This file allows display switching.
> +
> - 1 = LCD
> - 2 = CRT
> - 3 = LCD+CRT
> +
> If you run X11, you should use xrandr instead.
>
> What: /sys/devices/platform/eeepc/camera
> @@ -30,16 +32,20 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> Change CPU clock configuration.
> On the Eee PC 1000H there are three available clock configuration:
> +
> * 0 -> Super Performance Mode
> * 1 -> High Performance Mode
> * 2 -> Power Saving Mode
> +
> On Eee PC 701 there is only 2 available clock configurations.
> Available configuration are listed in available_cpufv file.
> Reading this file will show the raw hexadecimal value which
> - is defined as follow:
> - | 8 bit | 8 bit |
> - | `---- Current mode
> - `------------ Availables modes
> + is defined as follow::
> +
> + | 8 bit | 8 bit |
> + | `---- Current mode
> + `------------ Availables modes
> +
> For example, 0x301 means: mode 1 selected, 3 available modes.
>
> What: /sys/devices/platform/eeepc/available_cpufv
> diff --git a/Documentation/ABI/testing/sysfs-platform-ideapad-laptop b/Documentation/ABI/testing/sysfs-platform-ideapad-laptop
> index 1b31be3f996a..fd2ac02bc5bd 100644
> --- a/Documentation/ABI/testing/sysfs-platform-ideapad-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-ideapad-laptop
> @@ -12,6 +12,7 @@ Contact: "Maxim Mikityanskiy <maxtram95@gmail.com>"
> Description:
> Change fan mode
> There are four available modes:
> +
> * 0 -> Super Silent Mode
> * 1 -> Standard Mode
> * 2 -> Dust Cleaning
> @@ -32,9 +33,11 @@ KernelVersion: 4.18
> Contact: "Oleg Keri <ezhi99@gmail.com>"
> Description:
> Control fn-lock mode.
> +
> * 1 -> Switched On
> * 0 -> Switched Off
>
> - For example:
> - # echo "0" > \
> - /sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock
> + For example::
> +
> + # echo "0" > \
> + /sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt b/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
> index 8af65059d519..e19144fd5d86 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
> @@ -7,5 +7,6 @@ Description:
> Thunderbolt controllers to turn on or off when no
> devices are connected (write-only)
> There are two available states:
> +
> * 0 -> Force power disabled
> * 1 -> Force power enabled
> diff --git a/Documentation/ABI/testing/sysfs-platform-sst-atom b/Documentation/ABI/testing/sysfs-platform-sst-atom
> index 0d07c0395660..d5f6e21f0e42 100644
> --- a/Documentation/ABI/testing/sysfs-platform-sst-atom
> +++ b/Documentation/ABI/testing/sysfs-platform-sst-atom
> @@ -5,13 +5,22 @@ Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com>
> Description:
> LPE Firmware version for SST driver on all atom
> plaforms (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"
> - If FW has been loaded it will display:
> +
> + If FW has been loaded it will display::
> +
> "v01.aa.bb.cc"
> +
> aa: Major version is reflecting SoC version:
> +
> + === =============
> 0d: BYT FW
> 0b: BSW FW
> 07: Merrifield FW
> + === =============
> +
> bb: Minor version
> +
> cc: Build version
> diff --git a/Documentation/ABI/testing/sysfs-platform-usbip-vudc b/Documentation/ABI/testing/sysfs-platform-usbip-vudc
> index 81fcfb454913..53622d3ba27c 100644
> --- a/Documentation/ABI/testing/sysfs-platform-usbip-vudc
> +++ b/Documentation/ABI/testing/sysfs-platform-usbip-vudc
> @@ -16,10 +16,13 @@ Contact: Krzysztof Opasiak <k.opasiak@samsung.com>
> Description:
> Current status of the device.
> Allowed values:
> - 1 - Device is available and can be exported
> - 2 - Device is currently exported
> - 3 - Fatal error occurred during communication
> - with peer
> +
> + == ==========================================
> + 1 Device is available and can be exported
> + 2 Device is currently exported
> + 3 Fatal error occurred during communication
> + with peer
> + == ==========================================
>
> What: /sys/devices/platform/usbip-vudc.%d/usbip_sockfd
> Date: April 2016
> diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp
> index a17f817a9309..2363ad810ddb 100644
> --- a/Documentation/ABI/testing/sysfs-ptp
> +++ b/Documentation/ABI/testing/sysfs-ptp
> @@ -69,7 +69,7 @@ Description:
> pin offered by the PTP hardware clock. The file name
> is the hardware dependent pin name. Reading from this
> file produces two numbers, the assigned function (see
> - the PTP_PF_ enumeration values in linux/ptp_clock.h)
> + the `PTP_PF_` enumeration values in linux/ptp_clock.h)
> and the channel number. The function and channel
> assignment may be changed by two writing numbers into
> the file.
>
WARNING: multiple messages have this Message-ID (diff)
From: Fabrice Gasnier <fabrice.gasnier@st.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Gautham R. Shenoy" <ego@linux.vnet.ibm.com>,
"Jason A. Donenfeld" <Jason@zx2c4.com>,
"Heikki Krogerus" <heikki.krogerus@linux.intel.com>,
"Peter Meerwald-Stadler" <pmeerw@pmeerw.net>,
"Petr Mladek" <pmladek@suse.com>,
"Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
"Alexander Shishkin" <alexander.shishkin@linux.intel.com>,
"Nayna Jain" <nayna@linux.ibm.com>,
"Jonathan Cameron" <Jonathan.Cameron@huawei.com>,
"Alexandre Belloni" <alexandre.belloni@bootlin.com>,
"Mimi Zohar" <zohar@linux.ibm.com>,
"Sebastian Reichel" <sre@kernel.org>,
linux-mm@kvack.org, "Bruno Meneguele" <bmeneg@redhat.com>,
"Vishal Verma" <vishal.l.verma@intel.com>,
"Pavel Machek" <pavel@ucw.cz>,
"Hanjun Guo" <guohanjun@huawei.com>,
"Guenter Roeck" <groeck@chromium.org>,
netdev@vger.kernel.org, "Oleh Kravchenko" <oleg@kaa.org.ua>,
"Dan Williams" <dan.j.williams@intel.com>,
"Andrew Donnellan" <ajd@linux.ibm.com>,
"Javier González" <javier@javigon.com>,
"Lars-Peter Clausen" <lars@metafoo.de>,
"Mark Gross" <mgross@linux.intel.com>,
linux-acpi@vger.kernel.org, "Jonathan Corbet" <corbet@lwn.net>,
"Chunyan Zhang" <zhang.lyra@gmail.com>,
"Mario Limonciello" <mario.limonciello@dell.com>,
linux-stm32@st-md-mailman.stormreply.com,
"Lakshmi Ramasubramanian" <nramas@linux.microsoft.com>,
"Ludovic Desroches" <ludovic.desroches@microchip.com>,
"Pawan Gupta" <pawan.kumar.gupta@linux.intel.com>,
linux-arm-kernel@lists.infradead.org, "Tom Rix" <trix@redhat.com>,
"Frederic Barrat" <fbarrat@linux.ibm.com>,
"Niklas Cassel" <niklas.cassel@wdc.com>,
"Len Brown" <lenb@kernel.org>, "Juergen Gross" <jgross@suse.com>,
linuxppc-dev@lists.ozlabs.org,
"Mika Westerberg" <mika.westerberg@linux.intel.com>,
"Alexandre Torgue" <alexandre.torgue@st.com>,
linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
"Richard Cochran" <richardcochran@gmail.com>,
"Oded Gabbay" <oded.gabbay@gmail.com>,
"Baolin Wang" <baolin.wang7@gmail.com>,
"Stefano Stabellini" <sstabellini@kernel.org>,
"Dan Murphy" <dmurphy@ti.com>, "Orson Zhai" <orsonzhai@gmail.com>,
"Philippe Bergheaud" <felix@linux.ibm.com>,
xen-devel@lists.xenproject.org,
"Boris Ostrovsky" <boris.ostrovsky@oracle.com>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
"Benson Leung" <bleung@chromium.org>,
"Konstantin Khlebnikov" <koct9i@gmail.com>,
"Jens Axboe" <axboe@kernel.dk>, "Felipe Balbi" <balbi@kernel.org>,
"Kranthi Kuntala" <kranthi.kuntala@intel.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
linux-usb@vger.kernel.org,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
"Nicolas Ferre" <nicolas.ferre@microchip.com>,
linux-iio@vger.kernel.org,
"Thinh Nguyen" <Thinh.Nguyen@synopsys.com>,
"Sergey Senozhatsky" <sergey.senozhatsky@gmail.com>,
"Thomas Gleixner" <tglx@linutronix.de>,
"Leonid Maksymchuk" <leonmaxx@gmail.com>,
"Maxime Coquelin" <mcoquelin.stm32@gmail.com>,
"Johannes Thumshirn" <johannes.thumshirn@wdc.com>,
"Enric Balletbo i Serra" <enric.balletbo@collabora.com>,
"Vaibhav Jain" <vaibhav@linux.ibm.com>,
"Vineela Tummalapalli" <vineela.tummalapalli@intel.com>,
"Peter Rosin" <peda@axentia.se>,
"Jonathan Cameron" <jic23@kernel.org>,
"Mike Kravetz" <mike.kravetz@oracle.com>
Subject: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
Date: Fri, 30 Oct 2020 10:19:12 +0100 [thread overview]
Message-ID: <5326488b-4185-9d67-fc09-79b911fbb3b8@st.com> (raw)
In-Reply-To: <58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org>
On 10/30/20 8:40 AM, Mauro Carvalho Chehab wrote:
> Some files over there won't parse well by Sphinx.
>
> Fix them.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../ABI/testing/configfs-spear-pcie-gadget | 36 +--
> Documentation/ABI/testing/configfs-usb-gadget | 83 +++---
> .../ABI/testing/configfs-usb-gadget-hid | 10 +-
> .../ABI/testing/configfs-usb-gadget-rndis | 16 +-
> .../ABI/testing/configfs-usb-gadget-uac1 | 18 +-
> .../ABI/testing/configfs-usb-gadget-uvc | 220 +++++++++-------
> Documentation/ABI/testing/debugfs-ec | 11 +-
> Documentation/ABI/testing/debugfs-pktcdvd | 11 +-
> Documentation/ABI/testing/dev-kmsg | 27 +-
> Documentation/ABI/testing/evm | 17 +-
> Documentation/ABI/testing/ima_policy | 30 ++-
> Documentation/ABI/testing/procfs-diskstats | 40 +--
> Documentation/ABI/testing/sysfs-block | 38 +--
> Documentation/ABI/testing/sysfs-block-device | 2 +
> Documentation/ABI/testing/sysfs-bus-acpi | 18 +-
> .../sysfs-bus-event_source-devices-format | 3 +-
> .../ABI/testing/sysfs-bus-i2c-devices-pca954x | 27 +-
> Documentation/ABI/testing/sysfs-bus-iio | 11 +
> .../sysfs-bus-iio-adc-envelope-detector | 5 +-
> .../ABI/testing/sysfs-bus-iio-cros-ec | 2 +-
> .../ABI/testing/sysfs-bus-iio-dfsdm-adc-stm32 | 8 +-
> .../ABI/testing/sysfs-bus-iio-lptimer-stm32 | 29 ++-
> .../sysfs-bus-iio-magnetometer-hmc5843 | 19 +-
> .../sysfs-bus-iio-temperature-max31856 | 19 +-
> .../ABI/testing/sysfs-bus-iio-timer-stm32 | 137 ++++++----
> .../testing/sysfs-bus-intel_th-devices-msc | 4 +
> Documentation/ABI/testing/sysfs-bus-nfit | 2 +-
> .../testing/sysfs-bus-pci-devices-aer_stats | 119 +++++----
> Documentation/ABI/testing/sysfs-bus-rapidio | 23 +-
> .../ABI/testing/sysfs-bus-thunderbolt | 40 +--
> Documentation/ABI/testing/sysfs-bus-usb | 30 ++-
> .../testing/sysfs-bus-usb-devices-usbsevseg | 7 +-
> Documentation/ABI/testing/sysfs-bus-vfio-mdev | 10 +-
> Documentation/ABI/testing/sysfs-class-cxl | 15 +-
> Documentation/ABI/testing/sysfs-class-led | 2 +-
> .../testing/sysfs-class-led-driver-el15203000 | 229 ++++++++---------
> .../ABI/testing/sysfs-class-led-driver-sc27xx | 4 +-
> Documentation/ABI/testing/sysfs-class-mic | 52 ++--
> Documentation/ABI/testing/sysfs-class-ocxl | 3 +
> Documentation/ABI/testing/sysfs-class-power | 73 +++++-
> .../ABI/testing/sysfs-class-power-twl4030 | 33 +--
> Documentation/ABI/testing/sysfs-class-rc | 30 ++-
> .../ABI/testing/sysfs-class-scsi_host | 7 +-
> Documentation/ABI/testing/sysfs-class-typec | 12 +-
> .../testing/sysfs-devices-platform-ACPI-TAD | 4 +
> .../ABI/testing/sysfs-devices-platform-docg3 | 10 +-
> .../sysfs-devices-platform-sh_mobile_lcdc_fb | 8 +-
> .../ABI/testing/sysfs-devices-system-cpu | 99 +++++---
> .../ABI/testing/sysfs-devices-system-ibm-rtl | 6 +-
> .../testing/sysfs-driver-bd9571mwv-regulator | 4 +
> Documentation/ABI/testing/sysfs-driver-genwqe | 11 +-
> .../testing/sysfs-driver-hid-logitech-lg4ff | 18 +-
> .../ABI/testing/sysfs-driver-hid-wiimote | 11 +-
> .../ABI/testing/sysfs-driver-samsung-laptop | 13 +-
> .../ABI/testing/sysfs-driver-toshiba_acpi | 26 ++
> .../ABI/testing/sysfs-driver-toshiba_haps | 2 +
> Documentation/ABI/testing/sysfs-driver-wacom | 4 +-
> Documentation/ABI/testing/sysfs-firmware-acpi | 237 +++++++++---------
> .../ABI/testing/sysfs-firmware-dmi-entries | 50 ++--
> Documentation/ABI/testing/sysfs-firmware-gsmi | 2 +-
> .../ABI/testing/sysfs-firmware-memmap | 16 +-
> Documentation/ABI/testing/sysfs-fs-ext4 | 4 +-
> .../ABI/testing/sysfs-hypervisor-xen | 13 +-
> .../ABI/testing/sysfs-kernel-boot_params | 23 +-
> .../ABI/testing/sysfs-kernel-mm-hugepages | 12 +-
> .../ABI/testing/sysfs-platform-asus-laptop | 21 +-
> .../ABI/testing/sysfs-platform-asus-wmi | 1 +
> Documentation/ABI/testing/sysfs-platform-at91 | 10 +-
> .../ABI/testing/sysfs-platform-eeepc-laptop | 14 +-
> .../ABI/testing/sysfs-platform-ideapad-laptop | 9 +-
> .../sysfs-platform-intel-wmi-thunderbolt | 1 +
> .../ABI/testing/sysfs-platform-sst-atom | 13 +-
> .../ABI/testing/sysfs-platform-usbip-vudc | 11 +-
> Documentation/ABI/testing/sysfs-ptp | 2 +-
> 74 files changed, 1322 insertions(+), 865 deletions(-)
>
Hi Mauro,
[...]
>
> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> +KernelVersion: 4.12
> +Contact: benjamin.gaignard@st.com
> +Description:
> + Reading returns the list possible quadrature modes.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> +KernelVersion: 4.12
> +Contact: benjamin.gaignard@st.com
> +Description:
> + Configure the device counter quadrature modes:
> +
> + channel_A:
> + Encoder A input servers as the count input and B as
> + the UP/DOWN direction control input.
> +
> + channel_B:
> + Encoder B input serves as the count input and A as
> + the UP/DOWN direction control input.
> +
> + quadrature:
> + Encoder A and B inputs are mixed to get direction
> + and count with a scale of 0.25.
> +
I just noticed that since Jonathan question in v1.
Above ABI has been moved in the past as discussed in [1]. You can take a
look at:
b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
Could you please remove the above chunk ?
With that, for the stm32 part:
Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
[1] https://lkml.org/lkml/2019/5/7/698
Best Regards,
Fabrice
> What: /sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available
> KernelVersion: 4.12
> Contact: benjamin.gaignard@st.com
> @@ -104,6 +146,7 @@ Description:
> Configure the device counter enable modes, in all case
> counting direction is set by in_count0_count_direction
> attribute and the counter is clocked by the internal clock.
> +
> always:
> Counter is always ON.
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc b/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
> index 7fd2601c2831..a74252e580a5 100644
> --- a/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
> +++ b/Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
> @@ -9,11 +9,13 @@ Date: June 2015
> KernelVersion: 4.3
> Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com>
> Description: (RW) Configure MSC operating mode:
> +
> - "single", for contiguous buffer mode (high-order alloc);
> - "multi", for multiblock mode;
> - "ExI", for DCI handler mode;
> - "debug", for debug mode;
> - any of the currently loaded buffer sinks.
> +
> If operating mode changes, existing buffer is deallocated,
> provided there are no active users and tracing is not enabled,
> otherwise the write will fail.
> @@ -23,10 +25,12 @@ Date: June 2015
> KernelVersion: 4.3
> Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com>
> Description: (RW) Configure MSC buffer size for "single" or "multi" modes.
> +
> In single mode, this is a single number of pages, has to be
> power of 2. In multiblock mode, this is a comma-separated list
> of numbers of pages for each window to be allocated. Number of
> windows is not limited.
> +
> Writing to this file deallocates existing buffer (provided
> there are no active users and tracing is not enabled) and then
> allocates a new one.
> diff --git a/Documentation/ABI/testing/sysfs-bus-nfit b/Documentation/ABI/testing/sysfs-bus-nfit
> index e4f76e7eab93..63ef0b9ecce7 100644
> --- a/Documentation/ABI/testing/sysfs-bus-nfit
> +++ b/Documentation/ABI/testing/sysfs-bus-nfit
> @@ -1,4 +1,4 @@
> -For all of the nmem device attributes under nfit/*, see the 'NVDIMM Firmware
> +For all of the nmem device attributes under ``nfit/*``, see the 'NVDIMM Firmware
> Interface Table (NFIT)' section in the ACPI specification
> (http://www.uefi.org/specifications) for more details.
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
> index 3c9a8c4a25eb..860db53037a5 100644
> --- a/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
> +++ b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
> @@ -1,6 +1,6 @@
> -==========================
> PCIe Device AER statistics
> -==========================
> +--------------------------
> +
> These attributes show up under all the devices that are AER capable. These
> statistical counters indicate the errors "as seen/reported by the device".
> Note that this may mean that if an endpoint is causing problems, the AER
> @@ -17,19 +17,18 @@ Description: List of correctable errors seen and reported by this
> PCI device using ERR_COR. Note that since multiple errors may
> be reported using a single ERR_COR message, thus
> TOTAL_ERR_COR at the end of the file may not match the actual
> - total of all the errors in the file. Sample output:
> --------------------------------------------------------------------------
> -localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable
> -Receiver Error 2
> -Bad TLP 0
> -Bad DLLP 0
> -RELAY_NUM Rollover 0
> -Replay Timer Timeout 0
> -Advisory Non-Fatal 0
> -Corrected Internal Error 0
> -Header Log Overflow 0
> -TOTAL_ERR_COR 2
> --------------------------------------------------------------------------
> + total of all the errors in the file. Sample output::
> +
> + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable
> + Receiver Error 2
> + Bad TLP 0
> + Bad DLLP 0
> + RELAY_NUM Rollover 0
> + Replay Timer Timeout 0
> + Advisory Non-Fatal 0
> + Corrected Internal Error 0
> + Header Log Overflow 0
> + TOTAL_ERR_COR 2
>
> What: /sys/bus/pci/devices/<dev>/aer_dev_fatal
> Date: July 2018
> @@ -39,28 +38,27 @@ Description: List of uncorrectable fatal errors seen and reported by this
> PCI device using ERR_FATAL. Note that since multiple errors may
> be reported using a single ERR_FATAL message, thus
> TOTAL_ERR_FATAL at the end of the file may not match the actual
> - total of all the errors in the file. Sample output:
> --------------------------------------------------------------------------
> -localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal
> -Undefined 0
> -Data Link Protocol 0
> -Surprise Down Error 0
> -Poisoned TLP 0
> -Flow Control Protocol 0
> -Completion Timeout 0
> -Completer Abort 0
> -Unexpected Completion 0
> -Receiver Overflow 0
> -Malformed TLP 0
> -ECRC 0
> -Unsupported Request 0
> -ACS Violation 0
> -Uncorrectable Internal Error 0
> -MC Blocked TLP 0
> -AtomicOp Egress Blocked 0
> -TLP Prefix Blocked Error 0
> -TOTAL_ERR_FATAL 0
> --------------------------------------------------------------------------
> + total of all the errors in the file. Sample output::
> +
> + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal
> + Undefined 0
> + Data Link Protocol 0
> + Surprise Down Error 0
> + Poisoned TLP 0
> + Flow Control Protocol 0
> + Completion Timeout 0
> + Completer Abort 0
> + Unexpected Completion 0
> + Receiver Overflow 0
> + Malformed TLP 0
> + ECRC 0
> + Unsupported Request 0
> + ACS Violation 0
> + Uncorrectable Internal Error 0
> + MC Blocked TLP 0
> + AtomicOp Egress Blocked 0
> + TLP Prefix Blocked Error 0
> + TOTAL_ERR_FATAL 0
>
> What: /sys/bus/pci/devices/<dev>/aer_dev_nonfatal
> Date: July 2018
> @@ -70,32 +68,31 @@ Description: List of uncorrectable nonfatal errors seen and reported by this
> PCI device using ERR_NONFATAL. Note that since multiple errors
> may be reported using a single ERR_FATAL message, thus
> TOTAL_ERR_NONFATAL at the end of the file may not match the
> - actual total of all the errors in the file. Sample output:
> --------------------------------------------------------------------------
> -localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal
> -Undefined 0
> -Data Link Protocol 0
> -Surprise Down Error 0
> -Poisoned TLP 0
> -Flow Control Protocol 0
> -Completion Timeout 0
> -Completer Abort 0
> -Unexpected Completion 0
> -Receiver Overflow 0
> -Malformed TLP 0
> -ECRC 0
> -Unsupported Request 0
> -ACS Violation 0
> -Uncorrectable Internal Error 0
> -MC Blocked TLP 0
> -AtomicOp Egress Blocked 0
> -TLP Prefix Blocked Error 0
> -TOTAL_ERR_NONFATAL 0
> --------------------------------------------------------------------------
> + actual total of all the errors in the file. Sample output::
> +
> + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal
> + Undefined 0
> + Data Link Protocol 0
> + Surprise Down Error 0
> + Poisoned TLP 0
> + Flow Control Protocol 0
> + Completion Timeout 0
> + Completer Abort 0
> + Unexpected Completion 0
> + Receiver Overflow 0
> + Malformed TLP 0
> + ECRC 0
> + Unsupported Request 0
> + ACS Violation 0
> + Uncorrectable Internal Error 0
> + MC Blocked TLP 0
> + AtomicOp Egress Blocked 0
> + TLP Prefix Blocked Error 0
> + TOTAL_ERR_NONFATAL 0
>
> -============================
> PCIe Rootport AER statistics
> -============================
> +----------------------------
> +
> These attributes show up under only the rootports (or root complex event
> collectors) that are AER capable. These indicate the number of error messages as
> "reported to" the rootport. Please note that the rootports also transmit
> diff --git a/Documentation/ABI/testing/sysfs-bus-rapidio b/Documentation/ABI/testing/sysfs-bus-rapidio
> index 13208b27dd87..634ea207a50a 100644
> --- a/Documentation/ABI/testing/sysfs-bus-rapidio
> +++ b/Documentation/ABI/testing/sysfs-bus-rapidio
> @@ -4,24 +4,27 @@ Description:
> an individual subdirectory with the following name format of
> device_name "nn:d:iiii", where:
>
> - nn - two-digit hexadecimal ID of RapidIO network where the
> + ==== ========================================================
> + nn two-digit hexadecimal ID of RapidIO network where the
> device resides
> - d - device type: 'e' - for endpoint or 's' - for switch
> - iiii - four-digit device destID for endpoints, or switchID for
> + d device type: 'e' - for endpoint or 's' - for switch
> + iiii four-digit device destID for endpoints, or switchID for
> switches
> + ==== ========================================================
>
> For example, below is a list of device directories that
> represents a typical RapidIO network with one switch, one host,
> and two agent endpoints, as it is seen by the enumerating host
> - (with destID = 1):
> + (with destID = 1)::
>
> - /sys/bus/rapidio/devices/00:e:0000
> - /sys/bus/rapidio/devices/00:e:0002
> - /sys/bus/rapidio/devices/00:s:0001
> + /sys/bus/rapidio/devices/00:e:0000
> + /sys/bus/rapidio/devices/00:e:0002
> + /sys/bus/rapidio/devices/00:s:0001
>
> - NOTE: An enumerating or discovering endpoint does not create a
> - sysfs entry for itself, this is why an endpoint with destID=1 is
> - not shown in the list.
> + NOTE:
> + An enumerating or discovering endpoint does not create a
> + sysfs entry for itself, this is why an endpoint with destID=1
> + is not shown in the list.
>
> Attributes Common for All RapidIO Devices
> -----------------------------------------
> diff --git a/Documentation/ABI/testing/sysfs-bus-thunderbolt b/Documentation/ABI/testing/sysfs-bus-thunderbolt
> index dd565c378b40..171127294674 100644
> --- a/Documentation/ABI/testing/sysfs-bus-thunderbolt
> +++ b/Documentation/ABI/testing/sysfs-bus-thunderbolt
> @@ -37,16 +37,18 @@ Contact: thunderbolt-software@lists.01.org
> Description: This attribute holds current Thunderbolt security level
> set by the system BIOS. Possible values are:
>
> - none: All devices are automatically authorized
> - user: Devices are only authorized based on writing
> - appropriate value to the authorized attribute
> - secure: Require devices that support secure connect at
> - minimum. User needs to authorize each device.
> - dponly: Automatically tunnel Display port (and USB). No
> - PCIe tunnels are created.
> - usbonly: Automatically tunnel USB controller of the
> + ======= ==================================================
> + none All devices are automatically authorized
> + user Devices are only authorized based on writing
> + appropriate value to the authorized attribute
> + secure Require devices that support secure connect at
> + minimum. User needs to authorize each device.
> + dponly Automatically tunnel Display port (and USB). No
> + PCIe tunnels are created.
> + usbonly Automatically tunnel USB controller of the
> connected Thunderbolt dock (and Display Port). All
> PCIe links downstream of the dock are removed.
> + ======= ==================================================
>
> What: /sys/bus/thunderbolt/devices/.../authorized
> Date: Sep 2017
> @@ -61,17 +63,23 @@ Description: This attribute is used to authorize Thunderbolt devices
> yet authorized.
>
> Possible values are supported:
> - 1: The device will be authorized and connected
> +
> + == ===========================================
> + 1 The device will be authorized and connected
> + == ===========================================
>
> When key attribute contains 32 byte hex string the possible
> values are:
> - 1: The 32 byte hex string is added to the device NVM and
> - the device is authorized.
> - 2: Send a challenge based on the 32 byte hex string. If the
> - challenge response from device is valid, the device is
> - authorized. In case of failure errno will be ENOKEY if
> - the device did not contain a key at all, and
> - EKEYREJECTED if the challenge response did not match.
> +
> + == ========================================================
> + 1 The 32 byte hex string is added to the device NVM and
> + the device is authorized.
> + 2 Send a challenge based on the 32 byte hex string. If the
> + challenge response from device is valid, the device is
> + authorized. In case of failure errno will be ENOKEY if
> + the device did not contain a key at all, and
> + EKEYREJECTED if the challenge response did not match.
> + == ========================================================
>
> What: /sys/bus/thunderbolt/devices/.../boot
> Date: Jun 2018
> diff --git a/Documentation/ABI/testing/sysfs-bus-usb b/Documentation/ABI/testing/sysfs-bus-usb
> index 614d216dff1d..e449b8374f6a 100644
> --- a/Documentation/ABI/testing/sysfs-bus-usb
> +++ b/Documentation/ABI/testing/sysfs-bus-usb
> @@ -72,24 +72,27 @@ Description:
> table at compile time. The format for the device ID is:
> idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct
> The vendor ID and device ID fields are required, the
> - rest is optional. The Ref* tuple can be used to tell the
> + rest is optional. The `Ref*` tuple can be used to tell the
> driver to use the same driver_data for the new device as
> it is used for the reference device.
> Upon successfully adding an ID, the driver will probe
> - for the device and attempt to bind to it. For example:
> - # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
> + for the device and attempt to bind to it. For example::
> +
> + # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
>
> Here add a new device (0458:7045) using driver_data from
> - an already supported device (0458:704c):
> - # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
> + an already supported device (0458:704c)::
> +
> + # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
>
> Reading from this file will list all dynamically added
> device IDs in the same format, with one entry per
> - line. For example:
> - # cat /sys/bus/usb/drivers/foo/new_id
> - 8086 10f5
> - dead beef 06
> - f00d cafe
> + line. For example::
> +
> + # cat /sys/bus/usb/drivers/foo/new_id
> + 8086 10f5
> + dead beef 06
> + f00d cafe
>
> The list will be truncated at PAGE_SIZE bytes due to
> sysfs restrictions.
> @@ -209,6 +212,7 @@ Description:
> advance, and behaves well according to the specification.
> This attribute is a bit-field that controls the behavior of
> a specific port:
> +
> - Bit 0 of this field selects the "old" enumeration scheme,
> as it is considerably faster (it only causes one USB reset
> instead of 2).
> @@ -233,10 +237,10 @@ Description:
> poll() for monitoring changes to this value in user space.
>
> Any time this value changes the corresponding hub device will send a
> - udev event with the following attributes:
> + udev event with the following attributes::
>
> - OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX
> - OVER_CURRENT_COUNT=[current value of this sysfs attribute]
> + OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX
> + OVER_CURRENT_COUNT=[current value of this sysfs attribute]
>
> What: /sys/bus/usb/devices/.../(hub interface)/portX/usb3_lpm_permit
> Date: November 2015
> diff --git a/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg b/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
> index 9ade80f81f96..2f86e4223bfc 100644
> --- a/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
> +++ b/Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
> @@ -12,8 +12,11 @@ KernelVersion: 2.6.26
> Contact: Harrison Metzger <harrisonmetz@gmail.com>
> Description: Controls the devices display mode.
> For a 6 character display the values are
> +
> MSB 0x06; LSB 0x3F, and
> +
> for an 8 character display the values are
> +
> MSB 0x08; LSB 0xFF.
>
> What: /sys/bus/usb/.../textmode
> @@ -37,7 +40,7 @@ KernelVersion: 2.6.26
> Contact: Harrison Metzger <harrisonmetz@gmail.com>
> Description: Controls the decimal places on the device.
> To set the nth decimal place, give this field
> - the value of 10 ** n. Assume this field has
> + the value of ``10 ** n``. Assume this field has
> the value k and has 1 or more decimal places set,
> to set the mth place (where m is not already set),
> - change this fields value to k + 10 ** m.
> + change this fields value to ``k + 10 ** m``.
> diff --git a/Documentation/ABI/testing/sysfs-bus-vfio-mdev b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> index 452dbe39270e..59fc804265db 100644
> --- a/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> +++ b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> @@ -28,8 +28,9 @@ Description:
> Writing UUID to this file will create mediated device of
> type <type-id> for parent device <device>. This is a
> write-only file.
> - For example:
> - # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
> + For example::
> +
> + # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
> /sys/devices/foo/mdev_supported_types/foo-1/create
>
> What: /sys/.../mdev_supported_types/<type-id>/devices/
> @@ -107,5 +108,6 @@ Description:
> Writing '1' to this file destroys the mediated device. The
> vendor driver can fail the remove() callback if that device
> is active and the vendor driver doesn't support hot unplug.
> - Example:
> - # echo 1 > /sys/bus/mdev/devices/<UUID>/remove
> + Example::
> +
> + # echo 1 > /sys/bus/mdev/devices/<UUID>/remove
> diff --git a/Documentation/ABI/testing/sysfs-class-cxl b/Documentation/ABI/testing/sysfs-class-cxl
> index 7970e3713e70..a6f51a104c44 100644
> --- a/Documentation/ABI/testing/sysfs-class-cxl
> +++ b/Documentation/ABI/testing/sysfs-class-cxl
> @@ -72,11 +72,16 @@ Description: read/write
> when performing the START_WORK ioctl. Only applicable when
> running under hashed page table mmu.
> Possible values:
> - none: No prefaulting (default)
> - work_element_descriptor: Treat the work element
> - descriptor as an effective address and
> - prefault what it points to.
> - all: all segments process calling START_WORK maps.
> +
> + ======================= ======================================
> + none No prefaulting (default)
> + work_element_descriptor Treat the work element
> + descriptor as an effective address and
> + prefault what it points to.
> + all all segments process calling
> + START_WORK maps.
> + ======================= ======================================
> +
> Users: https://github.com/ibm-capi/libcxl
>
> What: /sys/class/cxl/<afu>/reset
> diff --git a/Documentation/ABI/testing/sysfs-class-led b/Documentation/ABI/testing/sysfs-class-led
> index 5f67f7ab277b..65e040978f73 100644
> --- a/Documentation/ABI/testing/sysfs-class-led
> +++ b/Documentation/ABI/testing/sysfs-class-led
> @@ -50,7 +50,7 @@ Description:
> You can change triggers in a similar manner to the way an IO
> scheduler is chosen. Trigger specific parameters can appear in
> /sys/class/leds/<led> once a given trigger is selected. For
> - their documentation see sysfs-class-led-trigger-*.
> + their documentation see `sysfs-class-led-trigger-*`.
>
> What: /sys/class/leds/<led>/inverted
> Date: January 2011
> diff --git a/Documentation/ABI/testing/sysfs-class-led-driver-el15203000 b/Documentation/ABI/testing/sysfs-class-led-driver-el15203000
> index f520ece9b64c..69befe947d7e 100644
> --- a/Documentation/ABI/testing/sysfs-class-led-driver-el15203000
> +++ b/Documentation/ABI/testing/sysfs-class-led-driver-el15203000
> @@ -6,127 +6,132 @@ Description:
> The LEDs board supports only predefined patterns by firmware
> for specific LEDs.
>
> - Breathing mode for Screen frame light tube:
> - "0 4000 1 4000"
> + Breathing mode for Screen frame light tube::
>
> - ^
> - |
> - Max-| ---
> - | / \
> - | / \
> - | / \ /
> - | / \ /
> - Min-|- ---
> - |
> - 0------4------8--> time (sec)
> + "0 4000 1 4000"
>
> - Cascade mode for Pipe LED:
> - "1 800 2 800 4 800 8 800 16 800"
> + ^
> + |
> + Max-| ---
> + | / \
> + | / \
> + | / \ /
> + | / \ /
> + Min-|- ---
> + |
> + 0------4------8--> time (sec)
>
> - ^
> - |
> - 0 On -|----+ +----+ +---
> - | | | | |
> - Off-| +-------------------+ +-------------------+
> - |
> - 1 On -| +----+ +----+
> - | | | | |
> - Off |----+ +-------------------+ +------------------
> - |
> - 2 On -| +----+ +----+
> - | | | | |
> - Off-|---------+ +-------------------+ +-------------
> - |
> - 3 On -| +----+ +----+
> - | | | | |
> - Off-|--------------+ +-------------------+ +--------
> - |
> - 4 On -| +----+ +----+
> - | | | | |
> - Off-|-------------------+ +-------------------+ +---
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + Cascade mode for Pipe LED::
>
> - Inverted cascade mode for Pipe LED:
> - "30 800 29 800 27 800 23 800 15 800"
> + "1 800 2 800 4 800 8 800 16 800"
>
> - ^
> - |
> - 0 On -| +-------------------+ +-------------------+
> - | | | | |
> - Off-|----+ +----+ +---
> - |
> - 1 On -|----+ +-------------------+ +------------------
> - | | | | |
> - Off | +----+ +----+
> - |
> - 2 On -|---------+ +-------------------+ +-------------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 3 On -|--------------+ +-------------------+ +--------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 4 On -|-------------------+ +-------------------+ +---
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + ^
> + |
> + 0 On -|----+ +----+ +---
> + | | | | |
> + Off-| +-------------------+ +-------------------+
> + |
> + 1 On -| +----+ +----+
> + | | | | |
> + Off |----+ +-------------------+ +------------------
> + |
> + 2 On -| +----+ +----+
> + | | | | |
> + Off-|---------+ +-------------------+ +-------------
> + |
> + 3 On -| +----+ +----+
> + | | | | |
> + Off-|--------------+ +-------------------+ +--------
> + |
> + 4 On -| +----+ +----+
> + | | | | |
> + Off-|-------------------+ +-------------------+ +---
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
>
> - Bounce mode for Pipe LED:
> - "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
> + Inverted cascade mode for Pipe LED::
>
> - ^
> - |
> - 0 On -|----+ +--------
> - | | |
> - Off-| +---------------------------------------+
> - |
> - 1 On -| +----+ +----+
> - | | | | |
> - Off |----+ +-----------------------------+ +--------
> - |
> - 2 On -| +----+ +----+
> - | | | | |
> - Off-|---------+ +-------------------+ +-------------
> - |
> - 3 On -| +----+ +----+
> - | | | | |
> - Off-|--------------+ +---------+ +------------------
> - |
> - 4 On -| +---------+
> - | | |
> - Off-|-------------------+ +-----------------------
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + "30 800 29 800 27 800 23 800 15 800"
>
> - Inverted bounce mode for Pipe LED:
> - "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
> + ^
> + |
> + 0 On -| +-------------------+ +-------------------+
> + | | | | |
> + Off-|----+ +----+ +---
> + |
> + 1 On -|----+ +-------------------+ +------------------
> + | | | | |
> + Off | +----+ +----+
> + |
> + 2 On -|---------+ +-------------------+ +-------------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 3 On -|--------------+ +-------------------+ +--------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 4 On -|-------------------+ +-------------------+ +---
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
>
> - ^
> - |
> - 0 On -| +---------------------------------------+
> - | | |
> - Off-|----+ +--------
> - |
> - 1 On -|----+ +-----------------------------+ +--------
> - | | | | |
> - Off | +----+ +----+
> - |
> - 2 On -|---------+ +-------------------+ +-------------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 3 On -|--------------+ +---------+ +------------------
> - | | | | |
> - Off-| +----+ +----+
> - |
> - 4 On -|-------------------+ +-----------------------
> - | | |
> - Off-| +---------+
> - |
> - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> + Bounce mode for Pipe LED::
> +
> + "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
> +
> + ^
> + |
> + 0 On -|----+ +--------
> + | | |
> + Off-| +---------------------------------------+
> + |
> + 1 On -| +----+ +----+
> + | | | | |
> + Off |----+ +-----------------------------+ +--------
> + |
> + 2 On -| +----+ +----+
> + | | | | |
> + Off-|---------+ +-------------------+ +-------------
> + |
> + 3 On -| +----+ +----+
> + | | | | |
> + Off-|--------------+ +---------+ +------------------
> + |
> + 4 On -| +---------+
> + | | |
> + Off-|-------------------+ +-----------------------
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
> +
> + Inverted bounce mode for Pipe LED::
> +
> + "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
> +
> + ^
> + |
> + 0 On -| +---------------------------------------+
> + | | |
> + Off-|----+ +--------
> + |
> + 1 On -|----+ +-----------------------------+ +--------
> + | | | | |
> + Off | +----+ +----+
> + |
> + 2 On -|---------+ +-------------------+ +-------------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 3 On -|--------------+ +---------+ +------------------
> + | | | | |
> + Off-| +----+ +----+
> + |
> + 4 On -|-------------------+ +-----------------------
> + | | |
> + Off-| +---------+
> + |
> + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
>
> What: /sys/class/leds/<led>/repeat
> Date: September 2019
> diff --git a/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx b/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
> index 45b1e605d355..215482379580 100644
> --- a/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
> +++ b/Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
> @@ -12,8 +12,8 @@ Description:
> format, we should set brightness as 0 for rise stage, fall
> stage and low stage.
>
> - Min stage duration: 125 ms
> - Max stage duration: 31875 ms
> + - Min stage duration: 125 ms
> + - Max stage duration: 31875 ms
>
> Since the stage duration step is 125 ms, the duration should be
> a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.
> diff --git a/Documentation/ABI/testing/sysfs-class-mic b/Documentation/ABI/testing/sysfs-class-mic
> index 6ef682603179..bd0e780c3760 100644
> --- a/Documentation/ABI/testing/sysfs-class-mic
> +++ b/Documentation/ABI/testing/sysfs-class-mic
> @@ -41,24 +41,33 @@ Description:
> When read, this entry provides the current state of an Intel
> MIC device in the context of the card OS. Possible values that
> will be read are:
> - "ready" - The MIC device is ready to boot the card OS. On
> - reading this entry after an OSPM resume, a "boot" has to be
> - written to this entry if the card was previously shutdown
> - during OSPM suspend.
> - "booting" - The MIC device has initiated booting a card OS.
> - "online" - The MIC device has completed boot and is online
> - "shutting_down" - The card OS is shutting down.
> - "resetting" - A reset has been initiated for the MIC device
> - "reset_failed" - The MIC device has failed to reset.
> +
> +
> + =============== ===============================================
> + "ready" The MIC device is ready to boot the card OS.
> + On reading this entry after an OSPM resume,
> + a "boot" has to be written to this entry if
> + the card was previously shutdown during OSPM
> + suspend.
> + "booting" The MIC device has initiated booting a card OS.
> + "online" The MIC device has completed boot and is online
> + "shutting_down" The card OS is shutting down.
> + "resetting" A reset has been initiated for the MIC device
> + "reset_failed" The MIC device has failed to reset.
> + =============== ===============================================
>
> When written, this sysfs entry triggers different state change
> operations depending upon the current state of the card OS.
> Acceptable values are:
> - "boot" - Boot the card OS image specified by the combination
> - of firmware, ramdisk, cmdline and bootmode
> - sysfs entries.
> - "reset" - Initiates device reset.
> - "shutdown" - Initiates card OS shutdown.
> +
> +
> + ========== ===================================================
> + "boot" Boot the card OS image specified by the combination
> + of firmware, ramdisk, cmdline and bootmode
> + sysfs entries.
> + "reset" Initiates device reset.
> + "shutdown" Initiates card OS shutdown.
> + ========== ===================================================
>
> What: /sys/class/mic/mic(x)/shutdown_status
> Date: October 2013
> @@ -69,12 +78,15 @@ Description:
> OS can shutdown because of various reasons. When read, this
> entry provides the status on why the card OS was shutdown.
> Possible values are:
> - "nop" - shutdown status is not applicable, when the card OS is
> - "online"
> - "crashed" - Shutdown because of a HW or SW crash.
> - "halted" - Shutdown because of a halt command.
> - "poweroff" - Shutdown because of a poweroff command.
> - "restart" - Shutdown because of a restart command.
> +
> + ========== ===================================================
> + "nop" shutdown status is not applicable, when the card OS
> + is "online"
> + "crashed" Shutdown because of a HW or SW crash.
> + "halted" Shutdown because of a halt command.
> + "poweroff" Shutdown because of a poweroff command.
> + "restart" Shutdown because of a restart command.
> + ========== ===================================================
>
> What: /sys/class/mic/mic(x)/cmdline
> Date: October 2013
> diff --git a/Documentation/ABI/testing/sysfs-class-ocxl b/Documentation/ABI/testing/sysfs-class-ocxl
> index ae1276efa45a..bf33f4fda58f 100644
> --- a/Documentation/ABI/testing/sysfs-class-ocxl
> +++ b/Documentation/ABI/testing/sysfs-class-ocxl
> @@ -11,8 +11,11 @@ Contact: linuxppc-dev@lists.ozlabs.org
> Description: read only
> Number of contexts for the AFU, in the format <n>/<max>
> where:
> +
> + ==== ===============================================
> n: number of currently active contexts, for debug
> max: maximum number of contexts supported by the AFU
> + ==== ===============================================
>
> What: /sys/class/ocxl/<afu name>/pp_mmio_size
> Date: January 2018
> diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
> index dbccb2fcd7ce..d4319a04c302 100644
> --- a/Documentation/ABI/testing/sysfs-class-power
> +++ b/Documentation/ABI/testing/sysfs-class-power
> @@ -1,4 +1,4 @@
> -===== General Properties =====
> +**General Properties**
>
> What: /sys/class/power_supply/<supply_name>/manufacturer
> Date: May 2007
> @@ -72,6 +72,7 @@ Description:
> critically low).
>
> Access: Read, Write
> +
> Valid values: 0 - 100 (percent)
>
> What: /sys/class/power_supply/<supply_name>/capacity_error_margin
> @@ -96,7 +97,9 @@ Description:
> Coarse representation of battery capacity.
>
> Access: Read
> - Valid values: "Unknown", "Critical", "Low", "Normal", "High",
> +
> + Valid values:
> + "Unknown", "Critical", "Low", "Normal", "High",
> "Full"
>
> What: /sys/class/power_supply/<supply_name>/current_avg
> @@ -139,6 +142,7 @@ Description:
> throttling for thermal cooling or improving battery health.
>
> Access: Read, Write
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/charge_control_limit_max
> @@ -148,6 +152,7 @@ Description:
> Maximum legal value for the charge_control_limit property.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/charge_control_start_threshold
> @@ -168,6 +173,7 @@ Description:
> stop.
>
> Access: Read, Write
> +
> Valid values: 0 - 100 (percent)
>
> What: /sys/class/power_supply/<supply_name>/charge_type
> @@ -183,7 +189,9 @@ Description:
> different algorithm.
>
> Access: Read, Write
> - Valid values: "Unknown", "N/A", "Trickle", "Fast", "Standard",
> +
> + Valid values:
> + "Unknown", "N/A", "Trickle", "Fast", "Standard",
> "Adaptive", "Custom"
>
> What: /sys/class/power_supply/<supply_name>/charge_term_current
> @@ -194,6 +202,7 @@ Description:
> when the battery is considered full and charging should end.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/health
> @@ -204,7 +213,9 @@ Description:
> functionality.
>
> Access: Read
> - Valid values: "Unknown", "Good", "Overheat", "Dead",
> +
> + Valid values:
> + "Unknown", "Good", "Overheat", "Dead",
> "Over voltage", "Unspecified failure", "Cold",
> "Watchdog timer expire", "Safety timer expire",
> "Over current", "Calibration required", "Warm",
> @@ -218,6 +229,7 @@ Description:
> for a battery charge cycle.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/present
> @@ -227,9 +239,13 @@ Description:
> Reports whether a battery is present or not in the system.
>
> Access: Read
> +
> Valid values:
> +
> + == =======
> 0: Absent
> 1: Present
> + == =======
>
> What: /sys/class/power_supply/<supply_name>/status
> Date: May 2007
> @@ -240,7 +256,9 @@ Description:
> used to enable/disable charging to the battery.
>
> Access: Read, Write
> - Valid values: "Unknown", "Charging", "Discharging",
> +
> + Valid values:
> + "Unknown", "Charging", "Discharging",
> "Not charging", "Full"
>
> What: /sys/class/power_supply/<supply_name>/technology
> @@ -250,7 +268,9 @@ Description:
> Describes the battery technology supported by the supply.
>
> Access: Read
> - Valid values: "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
> +
> + Valid values:
> + "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
> "NiCd", "LiMn"
>
> What: /sys/class/power_supply/<supply_name>/temp
> @@ -260,6 +280,7 @@ Description:
> Reports the current TBAT battery temperature reading.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_max
> @@ -274,6 +295,7 @@ Description:
> critically high, and charging has stopped).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_min
> @@ -289,6 +311,7 @@ Description:
> remedy the situation).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_max
> @@ -299,6 +322,7 @@ Description:
> charging.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_min
> @@ -309,6 +333,7 @@ Description:
> charging.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/voltage_avg,
> @@ -320,6 +345,7 @@ Description:
> which they average readings to smooth out the reported value.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_max,
> @@ -330,6 +356,7 @@ Description:
> during charging.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_min,
> @@ -340,6 +367,7 @@ Description:
> during discharging.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_now,
> @@ -350,9 +378,10 @@ Description:
> This value is not averaged/smoothed.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> -===== USB Properties =====
> +**USB Properties**
>
> What: /sys/class/power_supply/<supply_name>/current_avg
> Date: May 2007
> @@ -363,6 +392,7 @@ Description:
> average readings to smooth out the reported value.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
>
> @@ -373,6 +403,7 @@ Description:
> Reports the maximum IBUS current the supply can support.
>
> Access: Read
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/current_now
> @@ -385,6 +416,7 @@ Description:
> within the reported min/max range.
>
> Access: Read, Write
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/input_current_limit
> @@ -399,6 +431,7 @@ Description:
> solved using power limit use input_current_limit.
>
> Access: Read, Write
> +
> Valid values: Represented in microamps
>
> What: /sys/class/power_supply/<supply_name>/input_voltage_limit
> @@ -441,10 +474,14 @@ Description:
> USB supply so voltage and current can be controlled).
>
> Access: Read, Write
> +
> Valid values:
> +
> + == ==================================================
> 0: Offline
> 1: Online Fixed - Fixed Voltage Supply
> 2: Online Programmable - Programmable Voltage Supply
> + == ==================================================
>
> What: /sys/class/power_supply/<supply_name>/temp
> Date: May 2007
> @@ -455,6 +492,7 @@ Description:
> TJUNC temperature of an IC)
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_max
> @@ -470,6 +508,7 @@ Description:
> remedy the situation).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_alert_min
> @@ -485,6 +524,7 @@ Description:
> accordingly to remedy the situation).
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_max
> @@ -494,6 +534,7 @@ Description:
> Reports the maximum allowed supply temperature for operation.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/temp_min
> @@ -503,6 +544,7 @@ Description:
> Reports the mainimum allowed supply temperature for operation.
>
> Access: Read
> +
> Valid values: Represented in 1/10 Degrees Celsius
>
> What: /sys/class/power_supply/<supply_name>/usb_type
> @@ -514,7 +556,9 @@ Description:
> is attached.
>
> Access: Read-Only
> - Valid values: "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
> +
> + Valid values:
> + "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
> "PD_DRP", "PD_PPS", "BrickID"
>
> What: /sys/class/power_supply/<supply_name>/voltage_max
> @@ -524,6 +568,7 @@ Description:
> Reports the maximum VBUS voltage the supply can support.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_min
> @@ -533,6 +578,7 @@ Description:
> Reports the minimum VBUS voltage the supply can support.
>
> Access: Read
> +
> Valid values: Represented in microvolts
>
> What: /sys/class/power_supply/<supply_name>/voltage_now
> @@ -545,9 +591,10 @@ Description:
> within the reported min/max range.
>
> Access: Read, Write
> +
> Valid values: Represented in microvolts
>
> -===== Device Specific Properties =====
> +**Device Specific Properties**
>
> What: /sys/class/power/ds2760-battery.*/charge_now
> Date: May 2010
> @@ -581,6 +628,7 @@ Description:
> will drop to 0 A) and will trigger interrupt.
>
> Valid values:
> +
> - 5, 6 or 7 (hours),
> - 0: disabled.
>
> @@ -595,6 +643,7 @@ Description:
> will drop to 0 A) and will trigger interrupt.
>
> Valid values:
> +
> - 4 - 16 (hours), step by 2 (rounded down)
> - 0: disabled.
>
> @@ -609,6 +658,7 @@ Description:
> interrupt and start top-off charging mode.
>
> Valid values:
> +
> - 100000 - 200000 (microamps), step by 25000 (rounded down)
> - 200000 - 350000 (microamps), step by 50000 (rounded down)
> - 0: disabled.
> @@ -624,6 +674,7 @@ Description:
> will drop to 0 A) and will trigger interrupt.
>
> Valid values:
> +
> - 0 - 70 (minutes), step by 10 (rounded down)
>
> What: /sys/class/power_supply/bq24257-charger/ovp_voltage
> @@ -637,6 +688,7 @@ Description:
> device datasheet for details.
>
> Valid values:
> +
> - 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000,
> 10500000 (all uV)
>
> @@ -652,6 +704,7 @@ Description:
> lower than the set value. See device datasheet for details.
>
> Valid values:
> +
> - 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000,
> 4760000 (all uV)
>
> @@ -666,6 +719,7 @@ Description:
> the charger operates normally. See device datasheet for details.
>
> Valid values:
> +
> - 1: enabled
> - 0: disabled
>
> @@ -681,6 +735,7 @@ Description:
> from the system. See device datasheet for details.
>
> Valid values:
> +
> - 1: enabled
> - 0: disabled
>
> diff --git a/Documentation/ABI/testing/sysfs-class-power-twl4030 b/Documentation/ABI/testing/sysfs-class-power-twl4030
> index b4fd32d210c5..7ac36dba87bc 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-twl4030
> +++ b/Documentation/ABI/testing/sysfs-class-power-twl4030
> @@ -4,18 +4,20 @@ Description:
> Writing to this can disable charging.
>
> Possible values are:
> - "auto" - draw power as appropriate for detected
> - power source and battery status.
> - "off" - do not draw any power.
> - "continuous"
> - - activate mode described as "linear" in
> - TWL data sheets. This uses whatever
> - current is available and doesn't switch off
> - when voltage drops.
>
> - This is useful for unstable power sources
> - such as bicycle dynamo, but care should
> - be taken that battery is not over-charged.
> + ============= ===========================================
> + "auto" draw power as appropriate for detected
> + power source and battery status.
> + "off" do not draw any power.
> + "continuous" activate mode described as "linear" in
> + TWL data sheets. This uses whatever
> + current is available and doesn't switch off
> + when voltage drops.
> +
> + This is useful for unstable power sources
> + such as bicycle dynamo, but care should
> + be taken that battery is not over-charged.
> + ============= ===========================================
>
> What: /sys/class/power_supply/twl4030_ac/mode
> Description:
> @@ -23,6 +25,9 @@ Description:
> Writing to this can disable charging.
>
> Possible values are:
> - "auto" - draw power as appropriate for detected
> - power source and battery status.
> - "off" - do not draw any power.
> +
> + ====== ===========================================
> + "auto" draw power as appropriate for detected
> + power source and battery status.
> + "off" do not draw any power.
> + ====== ===========================================
> diff --git a/Documentation/ABI/testing/sysfs-class-rc b/Documentation/ABI/testing/sysfs-class-rc
> index 6c0d6c8cb911..9c8ff7910858 100644
> --- a/Documentation/ABI/testing/sysfs-class-rc
> +++ b/Documentation/ABI/testing/sysfs-class-rc
> @@ -21,15 +21,22 @@ KernelVersion: 2.6.36
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Reading this file returns a list of available protocols,
> - something like:
> + something like::
> +
> "rc5 [rc6] nec jvc [sony]"
> +
> Enabled protocols are shown in [] brackets.
> +
> Writing "+proto" will add a protocol to the list of enabled
> protocols.
> +
> Writing "-proto" will remove a protocol from the list of enabled
> protocols.
> +
> Writing "proto" will enable only "proto".
> +
> Writing "none" will disable all protocols.
> +
> Write fails with EINVAL if an invalid protocol combination or
> unknown protocol name is used.
>
> @@ -39,11 +46,13 @@ KernelVersion: 3.15
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Sets the scancode filter expected value.
> +
> Use in combination with /sys/class/rc/rcN/filter_mask to set the
> expected value of the bits set in the filter mask.
> If the hardware supports it then scancodes which do not match
> the filter will be ignored. Otherwise the write will fail with
> an error.
> +
> This value may be reset to 0 if the current protocol is altered.
>
> What: /sys/class/rc/rcN/filter_mask
> @@ -56,9 +65,11 @@ Description:
> of the scancode which should be compared against the expected
> value. A value of 0 disables the filter to allow all valid
> scancodes to be processed.
> +
> If the hardware supports it then scancodes which do not match
> the filter will be ignored. Otherwise the write will fail with
> an error.
> +
> This value may be reset to 0 if the current protocol is altered.
>
> What: /sys/class/rc/rcN/wakeup_protocols
> @@ -67,15 +78,22 @@ KernelVersion: 4.11
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Reading this file returns a list of available protocols to use
> - for the wakeup filter, something like:
> + for the wakeup filter, something like::
> +
> "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
> +
> Note that protocol variants are listed, so "nec", "sony",
> "rc-5", "rc-6" have their different bit length encodings
> listed if available.
> +
> The enabled wakeup protocol is shown in [] brackets.
> +
> Only one protocol can be selected at a time.
> +
> Writing "proto" will use "proto" for wakeup events.
> +
> Writing "none" will disable wakeup.
> +
> Write fails with EINVAL if an invalid protocol combination or
> unknown protocol name is used, or if wakeup is not supported by
> the hardware.
> @@ -86,13 +104,17 @@ KernelVersion: 3.15
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Sets the scancode wakeup filter expected value.
> +
> Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
> set the expected value of the bits set in the wakeup filter mask
> to trigger a system wake event.
> +
> If the hardware supports it and wakeup_filter_mask is not 0 then
> scancodes which match the filter will wake the system from e.g.
> suspend to RAM or power off.
> +
> Otherwise the write will fail with an error.
> +
> This value may be reset to 0 if the wakeup protocol is altered.
>
> What: /sys/class/rc/rcN/wakeup_filter_mask
> @@ -101,11 +123,15 @@ KernelVersion: 3.15
> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Description:
> Sets the scancode wakeup filter mask of bits to compare.
> +
> Use in combination with /sys/class/rc/rcN/wakeup_filter to set
> the bits of the scancode which should be compared against the
> expected value to trigger a system wake event.
> +
> If the hardware supports it and wakeup_filter_mask is not 0 then
> scancodes which match the filter will wake the system from e.g.
> suspend to RAM or power off.
> +
> Otherwise the write will fail with an error.
> +
> This value may be reset to 0 if the wakeup protocol is altered.
> diff --git a/Documentation/ABI/testing/sysfs-class-scsi_host b/Documentation/ABI/testing/sysfs-class-scsi_host
> index bafc59fd7b69..7c98d8f43c45 100644
> --- a/Documentation/ABI/testing/sysfs-class-scsi_host
> +++ b/Documentation/ABI/testing/sysfs-class-scsi_host
> @@ -56,8 +56,9 @@ Description:
> management) on top, which makes it match the Windows IRST (Intel
> Rapid Storage Technology) driver settings. This setting is also
> close to min_power, except that:
> +
> a) It does not use host-initiated slumber mode, but it does
> - allow device-initiated slumber
> + allow device-initiated slumber
> b) It does not enable low power device sleep mode (DevSlp).
>
> What: /sys/class/scsi_host/hostX/em_message
> @@ -70,8 +71,8 @@ Description:
> protocol, writes and reads correspond to the LED message format
> as defined in the AHCI spec.
>
> - The user must turn sw_activity (under /sys/block/*/device/) OFF
> - it they wish to control the activity LED via the em_message
> + The user must turn sw_activity (under `/sys/block/*/device/`)
> + OFF it they wish to control the activity LED via the em_message
> file.
>
> em_message_type: (RO) Displays the current enclosure management
> diff --git a/Documentation/ABI/testing/sysfs-class-typec b/Documentation/ABI/testing/sysfs-class-typec
> index b834671522d6..b7794e02ad20 100644
> --- a/Documentation/ABI/testing/sysfs-class-typec
> +++ b/Documentation/ABI/testing/sysfs-class-typec
> @@ -40,10 +40,13 @@ Description:
> attribute will not return until the operation has finished.
>
> Valid values:
> - - source (The port will behave as source only DFP port)
> - - sink (The port will behave as sink only UFP port)
> - - dual (The port will behave as dual-role-data and
> +
> + ====== ==============================================
> + source (The port will behave as source only DFP port)
> + sink (The port will behave as sink only UFP port)
> + dual (The port will behave as dual-role-data and
> dual-role-power port)
> + ====== ==============================================
>
> What: /sys/class/typec/<port>/vconn_source
> Date: April 2017
> @@ -59,6 +62,7 @@ Description:
> generates uevent KOBJ_CHANGE.
>
> Valid values:
> +
> - "no" when the port is not the VCONN Source
> - "yes" when the port is the VCONN Source
>
> @@ -72,6 +76,7 @@ Description:
> power operation mode should show "usb_power_delivery".
>
> Valid values:
> +
> - default
> - 1.5A
> - 3.0A
> @@ -191,6 +196,7 @@ Date: April 2017
> Contact: Heikki Krogerus <heikki.krogerus@linux.intel.com>
> Description:
> Shows type of the plug on the cable:
> +
> - type-a - Standard A
> - type-b - Standard B
> - type-c
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD b/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
> index 7e43cdce9a52..f7b360a61b21 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
> @@ -7,6 +7,7 @@ Description:
> (RO) Hexadecimal bitmask of the TAD attributes are reported by
> the platform firmware (see ACPI 6.2, section 9.18.2):
>
> + ======= ======================================================
> BIT(0): AC wakeup implemented if set
> BIT(1): DC wakeup implemented if set
> BIT(2): Get/set real time features implemented if set
> @@ -16,6 +17,7 @@ Description:
> BIT(6): The AC timer wakes up from S5 if set
> BIT(7): The DC timer wakes up from S4 if set
> BIT(8): The DC timer wakes up from S5 if set
> + ======= ======================================================
>
> The other bits are reserved.
>
> @@ -62,9 +64,11 @@ Description:
> timer status with the following meaning of bits (see ACPI 6.2,
> Section 9.18.5):
>
> + ======= ======================================================
> Bit(0): The timer has expired if set.
> Bit(1): The timer has woken up the system from a sleep state
> (S3 or S4/S5 if supported) if set.
> + ======= ======================================================
>
> The other bits are reserved.
>
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-docg3 b/Documentation/ABI/testing/sysfs-devices-platform-docg3
> index 8aa36716882f..378c42694bfb 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-docg3
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-docg3
> @@ -9,8 +9,10 @@ Description:
> The protection has information embedded whether it blocks reads,
> writes or both.
> The result is:
> - 0 -> the DPS is not keylocked
> - 1 -> the DPS is keylocked
> +
> + - 0 -> the DPS is not keylocked
> + - 1 -> the DPS is keylocked
> +
> Users: None identified so far.
>
> What: /sys/devices/platform/docg3/f[0-3]_dps[01]_protection_key
> @@ -27,8 +29,12 @@ Description:
> Entering the correct value toggle the lock, and can be observed
> through f[0-3]_dps[01]_is_keylocked.
> Possible values are:
> +
> - 8 bytes
> +
> Typical values are:
> +
> - "00000000"
> - "12345678"
> +
> Users: None identified so far.
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb b/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
> index 2107082426da..e45ac2e865d5 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
> @@ -17,10 +17,10 @@ Description:
> to overlay planes.
>
> Selects the composition mode for the overlay. Possible values
> - are
> + are:
>
> - 0 - Alpha Blending
> - 1 - ROP3
> + - 0 - Alpha Blending
> + - 1 - ROP3
>
> What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_position
> Date: May 2012
> @@ -30,7 +30,7 @@ Description:
> to overlay planes.
>
> Stores the x,y overlay position on the display in pixels. The
> - position format is `[0-9]+,[0-9]+'.
> + position format is `[0-9]+,[0-9]+`.
>
> What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_rop3
> Date: May 2012
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu
> index b555df825447..274c337ec6a9 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-cpu
> +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
> @@ -151,23 +151,28 @@ Description:
> The processor idle states which are available for use have the
> following attributes:
>
> - name: (RO) Name of the idle state (string).
> + ======== ==== =================================================
> + name: (RO) Name of the idle state (string).
>
> latency: (RO) The latency to exit out of this idle state (in
> - microseconds).
> + microseconds).
>
> - power: (RO) The power consumed while in this idle state (in
> - milliwatts).
> + power: (RO) The power consumed while in this idle state (in
> + milliwatts).
>
> - time: (RO) The total time spent in this idle state (in microseconds).
> + time: (RO) The total time spent in this idle state
> + (in microseconds).
>
> - usage: (RO) Number of times this state was entered (a count).
> + usage: (RO) Number of times this state was entered (a count).
>
> - above: (RO) Number of times this state was entered, but the
> - observed CPU idle duration was too short for it (a count).
> + above: (RO) Number of times this state was entered, but the
> + observed CPU idle duration was too short for it
> + (a count).
>
> - below: (RO) Number of times this state was entered, but the
> - observed CPU idle duration was too long for it (a count).
> + below: (RO) Number of times this state was entered, but the
> + observed CPU idle duration was too long for it
> + (a count).
> + ======== ==== =================================================
>
> What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc
> Date: February 2008
> @@ -290,6 +295,7 @@ Description: Processor frequency boosting control
> This switch controls the boost setting for the whole system.
> Boosting allows the CPU and the firmware to run at a frequency
> beyound it's nominal limit.
> +
> More details can be found in
> Documentation/admin-guide/pm/cpufreq.rst
>
> @@ -337,43 +343,57 @@ Contact: Sudeep Holla <sudeep.holla@arm.com>
> Description: Parameters for the CPU cache attributes
>
> allocation_policy:
> - - WriteAllocate: allocate a memory location to a cache line
> - on a cache miss because of a write
> - - ReadAllocate: allocate a memory location to a cache line
> + - WriteAllocate:
> + allocate a memory location to a cache line
> + on a cache miss because of a write
> + - ReadAllocate:
> + allocate a memory location to a cache line
> on a cache miss because of a read
> - - ReadWriteAllocate: both writeallocate and readallocate
> + - ReadWriteAllocate:
> + both writeallocate and readallocate
>
> - attributes: LEGACY used only on IA64 and is same as write_policy
> + attributes:
> + LEGACY used only on IA64 and is same as write_policy
>
> - coherency_line_size: the minimum amount of data in bytes that gets
> + coherency_line_size:
> + the minimum amount of data in bytes that gets
> transferred from memory to cache
>
> - level: the cache hierarchy in the multi-level cache configuration
> + level:
> + the cache hierarchy in the multi-level cache configuration
>
> - number_of_sets: total number of sets in the cache, a set is a
> + number_of_sets:
> + total number of sets in the cache, a set is a
> collection of cache lines with the same cache index
>
> - physical_line_partition: number of physical cache line per cache tag
> + physical_line_partition:
> + number of physical cache line per cache tag
>
> - shared_cpu_list: the list of logical cpus sharing the cache
> + shared_cpu_list:
> + the list of logical cpus sharing the cache
>
> - shared_cpu_map: logical cpu mask containing the list of cpus sharing
> + shared_cpu_map:
> + logical cpu mask containing the list of cpus sharing
> the cache
>
> - size: the total cache size in kB
> + size:
> + the total cache size in kB
>
> type:
> - Instruction: cache that only holds instructions
> - Data: cache that only caches data
> - Unified: cache that holds both data and instructions
>
> - ways_of_associativity: degree of freedom in placing a particular block
> - of memory in the cache
> + ways_of_associativity:
> + degree of freedom in placing a particular block
> + of memory in the cache
>
> write_policy:
> - - WriteThrough: data is written to both the cache line
> + - WriteThrough:
> + data is written to both the cache line
> and to the block in the lower-level memory
> - - WriteBack: data is written only to the cache line and
> + - WriteBack:
> + data is written only to the cache line and
> the modified cache line is written to main
> memory only when it is replaced
>
> @@ -414,30 +434,30 @@ Description: POWERNV CPUFreq driver's frequency throttle stats directory and
> throttle attributes exported in the 'throttle_stats' directory:
>
> - turbo_stat : This file gives the total number of times the max
> - frequency is throttled to lower frequency in turbo (at and above
> - nominal frequency) range of frequencies.
> + frequency is throttled to lower frequency in turbo (at and above
> + nominal frequency) range of frequencies.
>
> - sub_turbo_stat : This file gives the total number of times the
> - max frequency is throttled to lower frequency in sub-turbo(below
> - nominal frequency) range of frequencies.
> + max frequency is throttled to lower frequency in sub-turbo(below
> + nominal frequency) range of frequencies.
>
> - unthrottle : This file gives the total number of times the max
> - frequency is unthrottled after being throttled.
> + frequency is unthrottled after being throttled.
>
> - powercap : This file gives the total number of times the max
> - frequency is throttled due to 'Power Capping'.
> + frequency is throttled due to 'Power Capping'.
>
> - overtemp : This file gives the total number of times the max
> - frequency is throttled due to 'CPU Over Temperature'.
> + frequency is throttled due to 'CPU Over Temperature'.
>
> - supply_fault : This file gives the total number of times the
> - max frequency is throttled due to 'Power Supply Failure'.
> + max frequency is throttled due to 'Power Supply Failure'.
>
> - overcurrent : This file gives the total number of times the
> - max frequency is throttled due to 'Overcurrent'.
> + max frequency is throttled due to 'Overcurrent'.
>
> - occ_reset : This file gives the total number of times the max
> - frequency is throttled due to 'OCC Reset'.
> + frequency is throttled due to 'OCC Reset'.
>
> The sysfs attributes representing different throttle reasons like
> powercap, overtemp, supply_fault, overcurrent and occ_reset map to
> @@ -469,8 +489,9 @@ What: /sys/devices/system/cpu/cpuX/regs/
> Date: June 2016
> Contact: Linux ARM Kernel Mailing list <linux-arm-kernel@lists.infradead.org>
> Description: AArch64 CPU registers
> +
> 'identification' directory exposes the CPU ID registers for
> - identifying model and revision of the CPU.
> + identifying model and revision of the CPU.
>
> What: /sys/devices/system/cpu/cpu#/cpu_capacity
> Date: December 2016
> @@ -497,9 +518,11 @@ Description: Information about CPU vulnerabilities
> vulnerabilities. The output of those files reflects the
> state of the CPUs in the system. Possible output values:
>
> + ================ ==============================================
> "Not affected" CPU is not affected by the vulnerability
> "Vulnerable" CPU is affected and no mitigation in effect
> "Mitigation: $M" CPU is affected and mitigation $M is in effect
> + ================ ==============================================
>
> See also: Documentation/admin-guide/hw-vuln/index.rst
>
> @@ -515,12 +538,14 @@ Description: Control Symetric Multi Threading (SMT)
> control: Read/write interface to control SMT. Possible
> values:
>
> + ================ =========================================
> "on" SMT is enabled
> "off" SMT is disabled
> "forceoff" SMT is force disabled. Cannot be changed.
> "notsupported" SMT is not supported by the CPU
> "notimplemented" SMT runtime toggling is not
> implemented for the architecture
> + ================ =========================================
>
> If control status is "forceoff" or "notsupported" writes
> are rejected.
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl b/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> index 470def06ab0a..1a8ee26e92ae 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> +++ b/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> @@ -5,8 +5,10 @@ Contact: Vernon Mauery <vernux@us.ibm.com>
> Description: The state file allows a means by which to change in and
> out of Premium Real-Time Mode (PRTM), as well as the
> ability to query the current state.
> - 0 => PRTM off
> - 1 => PRTM enabled
> +
> + - 0 => PRTM off
> + - 1 => PRTM enabled
> +
> Users: The ibm-prtm userspace daemon uses this interface.
>
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator b/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
> index 4d63a7904b94..42214b4ff14a 100644
> --- a/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
> +++ b/Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
> @@ -6,11 +6,13 @@ Description: Read/write the current state of DDR Backup Mode, which controls
> if DDR power rails will be kept powered during system suspend.
> ("on"/"1" = enabled, "off"/"0" = disabled).
> Two types of power switches (or control signals) can be used:
> +
> A. With a momentary power switch (or pulse signal), DDR
> Backup Mode is enabled by default when available, as the
> PMIC will be configured only during system suspend.
> B. With a toggle power switch (or level signal), the
> following steps must be followed exactly:
> +
> 1. Configure PMIC for backup mode, to change the role of
> the accessory power switch from a power switch to a
> wake-up switch,
> @@ -20,8 +22,10 @@ Description: Read/write the current state of DDR Backup Mode, which controls
> 3. Suspend system,
> 4. Switch accessory power switch on, to resume the
> system.
> +
> DDR Backup Mode must be explicitly enabled by the user,
> to invoke step 1.
> +
> See also Documentation/devicetree/bindings/mfd/bd9571mwv.txt.
> Users: User space applications for embedded boards equipped with a
> BD9571MWV PMIC.
> diff --git a/Documentation/ABI/testing/sysfs-driver-genwqe b/Documentation/ABI/testing/sysfs-driver-genwqe
> index 64ac6d567c4b..69d855dc4c47 100644
> --- a/Documentation/ABI/testing/sysfs-driver-genwqe
> +++ b/Documentation/ABI/testing/sysfs-driver-genwqe
> @@ -29,8 +29,12 @@ What: /sys/class/genwqe/genwqe<n>_card/reload_bitstream
> Date: May 2014
> Contact: klebers@linux.vnet.ibm.com
> Description: Interface to trigger a PCIe card reset to reload the bitstream.
> +
> + ::
> +
> sudo sh -c 'echo 1 > \
> /sys/class/genwqe/genwqe0_card/reload_bitstream'
> +
> If successfully, the card will come back with the bitstream set
> on 'next_bitstream'.
>
> @@ -64,8 +68,11 @@ Description: Base clock frequency of the card.
> What: /sys/class/genwqe/genwqe<n>_card/device/sriov_numvfs
> Date: Oct 2013
> Contact: haver@linux.vnet.ibm.com
> -Description: Enable VFs (1..15):
> +Description: Enable VFs (1..15)::
> +
> sudo sh -c 'echo 15 > \
> /sys/bus/pci/devices/0000\:1b\:00.0/sriov_numvfs'
> - Disable VFs:
> +
> + Disable VFs::
> +
> Write a 0 into the same sysfs entry.
> diff --git a/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff b/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
> index 305dffd229a8..de07be314efc 100644
> --- a/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
> +++ b/Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
> @@ -12,7 +12,9 @@ KernelVersion: 4.1
> Contact: Michal Malý <madcatxster@devoid-pointer.net>
> Description: Displays a set of alternate modes supported by a wheel. Each
> mode is listed as follows:
> +
> Tag: Mode Name
> +
> Currently active mode is marked with an asterisk. List also
> contains an abstract item "native" which always denotes the
> native mode of the wheel. Echoing the mode tag switches the
> @@ -24,24 +26,30 @@ Description: Displays a set of alternate modes supported by a wheel. Each
> This entry is not created for devices that have only one mode.
>
> Currently supported mode switches:
> - Driving Force Pro:
> +
> + Driving Force Pro::
> +
> DF-EX --> DFP
>
> - G25:
> + G25::
> +
> DF-EX --> DFP --> G25
>
> - G27:
> + G27::
> +
> DF-EX <*> DFP <-> G25 <-> G27
> DF-EX <*--------> G25 <-> G27
> DF-EX <*----------------> G27
>
> - G29:
> + G29::
> +
> DF-EX <*> DFP <-> G25 <-> G27 <-> G29
> DF-EX <*--------> G25 <-> G27 <-> G29
> DF-EX <*----------------> G27 <-> G29
> DF-EX <*------------------------> G29
>
> - DFGT:
> + DFGT::
> +
> DF-EX <*> DFP <-> DFGT
> DF-EX <*--------> DFGT
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-hid-wiimote b/Documentation/ABI/testing/sysfs-driver-hid-wiimote
> index 39dfa5cb1cc5..cd7b82a5c27d 100644
> --- a/Documentation/ABI/testing/sysfs-driver-hid-wiimote
> +++ b/Documentation/ABI/testing/sysfs-driver-hid-wiimote
> @@ -39,9 +39,13 @@ Description: While a device is initialized by the wiimote driver, we perform
> Other strings for each device-type are available and may be
> added if new device-specific detections are added.
> Currently supported are:
> - gen10: First Wii Remote generation
> - gen20: Second Wii Remote Plus generation (builtin MP)
> +
> + ============= =======================================
> + gen10: First Wii Remote generation
> + gen20: Second Wii Remote Plus generation
> + (builtin MP)
> balanceboard: Wii Balance Board
> + ============= =======================================
>
> What: /sys/bus/hid/drivers/wiimote/<dev>/bboard_calib
> Date: May 2013
> @@ -54,6 +58,7 @@ Description: This attribute is only provided if the device was detected as a
> First, 0kg values for all 4 sensors are written, followed by the
> 17kg values for all 4 sensors and last the 34kg values for all 4
> sensors.
> +
> Calibration data is already applied by the kernel to all input
> values but may be used by user-space to perform other
> transformations.
> @@ -68,9 +73,11 @@ Description: This attribute is only provided if the device was detected as a
> is prefixed with a +/-. Each value is a signed 16bit number.
> Data is encoded as decimal numbers and specifies the offsets of
> the analog sticks of the pro-controller.
> +
> Calibration data is already applied by the kernel to all input
> values but may be used by user-space to perform other
> transformations.
> +
> Calibration data is detected by the kernel during device setup.
> You can write "scan\n" into this file to re-trigger calibration.
> You can also write data directly in the form "x1:y1 x2:y2" to
> diff --git a/Documentation/ABI/testing/sysfs-driver-samsung-laptop b/Documentation/ABI/testing/sysfs-driver-samsung-laptop
> index 34d3a3359cf4..28c9c040de5d 100644
> --- a/Documentation/ABI/testing/sysfs-driver-samsung-laptop
> +++ b/Documentation/ABI/testing/sysfs-driver-samsung-laptop
> @@ -9,10 +9,12 @@ Description: Some Samsung laptops have different "performance levels"
> their fans quiet at all costs. Reading from this file
> will show the current performance level. Writing to the
> file can change this value.
> +
> Valid options:
> - "silent"
> - "normal"
> - "overclock"
> + - "silent"
> + - "normal"
> + - "overclock"
> +
> Note that not all laptops support all of these options.
> Specifically, not all support the "overclock" option,
> and it's still unknown if this value even changes
> @@ -25,8 +27,9 @@ Contact: Corentin Chary <corentin.chary@gmail.com>
> Description: Max battery charge level can be modified, battery cycle
> life can be extended by reducing the max battery charge
> level.
> - 0 means normal battery mode (100% charge)
> - 1 means battery life extender mode (80% charge)
> +
> + - 0 means normal battery mode (100% charge)
> + - 1 means battery life extender mode (80% charge)
>
> What: /sys/devices/platform/samsung/usb_charge
> Date: December 1, 2011
> diff --git a/Documentation/ABI/testing/sysfs-driver-toshiba_acpi b/Documentation/ABI/testing/sysfs-driver-toshiba_acpi
> index f34221b52b14..e5a438d84e1f 100644
> --- a/Documentation/ABI/testing/sysfs-driver-toshiba_acpi
> +++ b/Documentation/ABI/testing/sysfs-driver-toshiba_acpi
> @@ -4,10 +4,12 @@ KernelVersion: 3.15
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the keyboard backlight operation mode, valid
> values are:
> +
> * 0x1 -> FN-Z
> * 0x2 -> AUTO (also called TIMER)
> * 0x8 -> ON
> * 0x10 -> OFF
> +
> Note that from kernel 3.16 onwards this file accepts all listed
> parameters, kernel 3.15 only accepts the first two (FN-Z and
> AUTO).
> @@ -41,8 +43,10 @@ KernelVersion: 3.15
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This files controls the status of the touchpad and pointing
> stick (if available), valid values are:
> +
> * 0 -> OFF
> * 1 -> ON
> +
> Users: KToshiba
>
> What: /sys/devices/LNXSYSTM:00/LNXSYBUS:00/TOS{1900,620{0,7,8}}:00/available_kbd_modes
> @@ -51,10 +55,12 @@ KernelVersion: 3.16
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file shows the supported keyboard backlight modes
> the system supports, which can be:
> +
> * 0x1 -> FN-Z
> * 0x2 -> AUTO (also called TIMER)
> * 0x8 -> ON
> * 0x10 -> OFF
> +
> Note that not all keyboard types support the listed modes.
> See the entry named "available_kbd_modes"
> Users: KToshiba
> @@ -65,6 +71,7 @@ KernelVersion: 3.16
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file shows the current keyboard backlight type,
> which can be:
> +
> * 1 -> Type 1, supporting modes FN-Z and AUTO
> * 2 -> Type 2, supporting modes TIMER, ON and OFF
> Users: KToshiba
> @@ -75,10 +82,12 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB Sleep & Charge charging mode, which
> can be:
> +
> * 0 -> Disabled (0x00)
> * 1 -> Alternate (0x09)
> * 2 -> Auto (0x21)
> * 3 -> Typical (0x11)
> +
> Note that from kernel 4.1 onwards this file accepts all listed
> values, kernel 4.0 only supports the first three.
> Note that this feature only works when connected to power, if
> @@ -93,8 +102,10 @@ Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB Sleep Functions under battery, and
> set the level at which point they will be disabled, accepted
> values can be:
> +
> * 0 -> Disabled
> * 1-100 -> Battery level to disable sleep functions
> +
> Currently it prints two values, the first one indicates if the
> feature is enabled or disabled, while the second one shows the
> current battery level set.
> @@ -107,8 +118,10 @@ Date: January 23, 2015
> KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB Rapid Charge state, which can be:
> +
> * 0 -> Disabled
> * 1 -> Enabled
> +
> Note that toggling this value requires a reboot for changes to
> take effect.
> Users: KToshiba
> @@ -118,8 +131,10 @@ Date: January 23, 2015
> KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the Sleep & Music state, which values can be:
> +
> * 0 -> Disabled
> * 1 -> Enabled
> +
> Note that this feature only works when connected to power, if
> you want to use it under battery, see the entry named
> "sleep_functions_on_battery"
> @@ -138,6 +153,7 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the state of the internal fan, valid
> values are:
> +
> * 0 -> OFF
> * 1 -> ON
>
> @@ -147,8 +163,10 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the Special Functions (hotkeys) operation
> mode, valid values are:
> +
> * 0 -> Normal Operation
> * 1 -> Special Functions
> +
> In the "Normal Operation" mode, the F{1-12} keys are as usual
> and the hotkeys are accessed via FN-F{1-12}.
> In the "Special Functions" mode, the F{1-12} keys trigger the
> @@ -163,8 +181,10 @@ KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls whether the laptop should turn ON whenever
> the LID is opened, valid values are:
> +
> * 0 -> Disabled
> * 1 -> Enabled
> +
> Note that toggling this value requires a reboot for changes to
> take effect.
> Users: KToshiba
> @@ -174,8 +194,10 @@ Date: February 12, 2015
> KernelVersion: 4.0
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the USB 3 functionality, valid values are:
> +
> * 0 -> Disabled (Acts as a regular USB 2)
> * 1 -> Enabled (Full USB 3 functionality)
> +
> Note that toggling this value requires a reboot for changes to
> take effect.
> Users: KToshiba
> @@ -188,10 +210,14 @@ Description: This file controls the Cooling Method feature.
> Reading this file prints two values, the first is the actual cooling method
> and the second is the maximum cooling method supported.
> When the maximum cooling method is ONE, valid values are:
> +
> * 0 -> Maximum Performance
> * 1 -> Battery Optimized
> +
> When the maximum cooling method is TWO, valid values are:
> +
> * 0 -> Maximum Performance
> * 1 -> Performance
> * 2 -> Battery Optimized
> +
> Users: KToshiba
> diff --git a/Documentation/ABI/testing/sysfs-driver-toshiba_haps b/Documentation/ABI/testing/sysfs-driver-toshiba_haps
> index a662370b4dbf..c938690ce10d 100644
> --- a/Documentation/ABI/testing/sysfs-driver-toshiba_haps
> +++ b/Documentation/ABI/testing/sysfs-driver-toshiba_haps
> @@ -4,10 +4,12 @@ KernelVersion: 3.17
> Contact: Azael Avalos <coproscefalo@gmail.com>
> Description: This file controls the built-in accelerometer protection level,
> valid values are:
> +
> * 0 -> Disabled
> * 1 -> Low
> * 2 -> Medium
> * 3 -> High
> +
> The default potection value is set to 2 (Medium).
> Users: KToshiba
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-wacom b/Documentation/ABI/testing/sysfs-driver-wacom
> index afc48fc163b5..16acaa5712ec 100644
> --- a/Documentation/ABI/testing/sysfs-driver-wacom
> +++ b/Documentation/ABI/testing/sysfs-driver-wacom
> @@ -79,7 +79,9 @@ Description:
> When the Wacom Intuos 4 is connected over Bluetooth, the
> image has to contain 256 bytes (64x32 px 1 bit colour).
> The format is also scrambled, like in the USB mode, and it can
> - be summarized by converting 76543210 into GECA6420.
> + be summarized by converting::
> +
> + 76543210 into GECA6420.
> HGFEDCBA HFDB7531
>
> What: /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote
> diff --git a/Documentation/ABI/testing/sysfs-firmware-acpi b/Documentation/ABI/testing/sysfs-firmware-acpi
> index 613f42a9d5cd..e4afc2538210 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-acpi
> +++ b/Documentation/ABI/testing/sysfs-firmware-acpi
> @@ -12,11 +12,14 @@ Description:
> image: The image bitmap. Currently a 32-bit BMP.
> status: 1 if the image is valid, 0 if firmware invalidated it.
> type: 0 indicates image is in BMP format.
> +
> + ======== ===================================================
> version: The version of the BGRT. Currently 1.
> xoffset: The number of pixels between the left of the screen
> and the left edge of the image.
> yoffset: The number of pixels between the top of the screen
> and the top edge of the image.
> + ======== ===================================================
>
> What: /sys/firmware/acpi/hotplug/
> Date: February 2013
> @@ -33,12 +36,14 @@ Description:
> The following setting is available to user space for each
> hotplug profile:
>
> + ======== =======================================================
> enabled: If set, the ACPI core will handle notifications of
> - hotplug events associated with the given class of
> - devices and will allow those devices to be ejected with
> - the help of the _EJ0 control method. Unsetting it
> - effectively disables hotplug for the correspoinding
> - class of devices.
> + hotplug events associated with the given class of
> + devices and will allow those devices to be ejected with
> + the help of the _EJ0 control method. Unsetting it
> + effectively disables hotplug for the correspoinding
> + class of devices.
> + ======== =======================================================
>
> The value of the above attribute is an integer number: 1 (set)
> or 0 (unset). Attempts to write any other values to it will
> @@ -71,86 +76,90 @@ Description:
> To figure out where all the SCI's are coming from,
> /sys/firmware/acpi/interrupts contains a file listing
> every possible source, and the count of how many
> - times it has triggered.
> -
> - $ cd /sys/firmware/acpi/interrupts
> - $ grep . *
> - error: 0
> - ff_gbl_lock: 0 enable
> - ff_pmtimer: 0 invalid
> - ff_pwr_btn: 0 enable
> - ff_rt_clk: 2 disable
> - ff_slp_btn: 0 invalid
> - gpe00: 0 invalid
> - gpe01: 0 enable
> - gpe02: 108 enable
> - gpe03: 0 invalid
> - gpe04: 0 invalid
> - gpe05: 0 invalid
> - gpe06: 0 enable
> - gpe07: 0 enable
> - gpe08: 0 invalid
> - gpe09: 0 invalid
> - gpe0A: 0 invalid
> - gpe0B: 0 invalid
> - gpe0C: 0 invalid
> - gpe0D: 0 invalid
> - gpe0E: 0 invalid
> - gpe0F: 0 invalid
> - gpe10: 0 invalid
> - gpe11: 0 invalid
> - gpe12: 0 invalid
> - gpe13: 0 invalid
> - gpe14: 0 invalid
> - gpe15: 0 invalid
> - gpe16: 0 invalid
> - gpe17: 1084 enable
> - gpe18: 0 enable
> - gpe19: 0 invalid
> - gpe1A: 0 invalid
> - gpe1B: 0 invalid
> - gpe1C: 0 invalid
> - gpe1D: 0 invalid
> - gpe1E: 0 invalid
> - gpe1F: 0 invalid
> - gpe_all: 1192
> - sci: 1194
> - sci_not: 0
> -
> - sci - The number of times the ACPI SCI
> - has been called and claimed an interrupt.
> -
> - sci_not - The number of times the ACPI SCI
> - has been called and NOT claimed an interrupt.
> -
> - gpe_all - count of SCI caused by GPEs.
> -
> - gpeXX - count for individual GPE source
> -
> - ff_gbl_lock - Global Lock
> -
> - ff_pmtimer - PM Timer
> -
> - ff_pwr_btn - Power Button
> -
> - ff_rt_clk - Real Time Clock
> -
> - ff_slp_btn - Sleep Button
> -
> - error - an interrupt that can't be accounted for above.
> -
> - invalid: it's either a GPE or a Fixed Event that
> - doesn't have an event handler.
> -
> - disable: the GPE/Fixed Event is valid but disabled.
> -
> - enable: the GPE/Fixed Event is valid and enabled.
> -
> - Root has permission to clear any of these counters. Eg.
> - # echo 0 > gpe11
> -
> - All counters can be cleared by clearing the total "sci":
> - # echo 0 > sci
> + times it has triggered::
> +
> + $ cd /sys/firmware/acpi/interrupts
> + $ grep . *
> + error: 0
> + ff_gbl_lock: 0 enable
> + ff_pmtimer: 0 invalid
> + ff_pwr_btn: 0 enable
> + ff_rt_clk: 2 disable
> + ff_slp_btn: 0 invalid
> + gpe00: 0 invalid
> + gpe01: 0 enable
> + gpe02: 108 enable
> + gpe03: 0 invalid
> + gpe04: 0 invalid
> + gpe05: 0 invalid
> + gpe06: 0 enable
> + gpe07: 0 enable
> + gpe08: 0 invalid
> + gpe09: 0 invalid
> + gpe0A: 0 invalid
> + gpe0B: 0 invalid
> + gpe0C: 0 invalid
> + gpe0D: 0 invalid
> + gpe0E: 0 invalid
> + gpe0F: 0 invalid
> + gpe10: 0 invalid
> + gpe11: 0 invalid
> + gpe12: 0 invalid
> + gpe13: 0 invalid
> + gpe14: 0 invalid
> + gpe15: 0 invalid
> + gpe16: 0 invalid
> + gpe17: 1084 enable
> + gpe18: 0 enable
> + gpe19: 0 invalid
> + gpe1A: 0 invalid
> + gpe1B: 0 invalid
> + gpe1C: 0 invalid
> + gpe1D: 0 invalid
> + gpe1E: 0 invalid
> + gpe1F: 0 invalid
> + gpe_all: 1192
> + sci: 1194
> + sci_not: 0
> +
> + =========== ==================================================
> + sci The number of times the ACPI SCI
> + has been called and claimed an interrupt.
> +
> + sci_not The number of times the ACPI SCI
> + has been called and NOT claimed an interrupt.
> +
> + gpe_all count of SCI caused by GPEs.
> +
> + gpeXX count for individual GPE source
> +
> + ff_gbl_lock Global Lock
> +
> + ff_pmtimer PM Timer
> +
> + ff_pwr_btn Power Button
> +
> + ff_rt_clk Real Time Clock
> +
> + ff_slp_btn Sleep Button
> +
> + error an interrupt that can't be accounted for above.
> +
> + invalid it's either a GPE or a Fixed Event that
> + doesn't have an event handler.
> +
> + disable the GPE/Fixed Event is valid but disabled.
> +
> + enable the GPE/Fixed Event is valid and enabled.
> + =========== ==================================================
> +
> + Root has permission to clear any of these counters. Eg.::
> +
> + # echo 0 > gpe11
> +
> + All counters can be cleared by clearing the total "sci"::
> +
> + # echo 0 > sci
>
> None of these counters has an effect on the function
> of the system, they are simply statistics.
> @@ -165,32 +174,34 @@ Description:
>
> Let's take power button fixed event for example, please kill acpid
> and other user space applications so that the machine won't shutdown
> - when pressing the power button.
> - # cat ff_pwr_btn
> - 0 enabled
> - # press the power button for 3 times;
> - # cat ff_pwr_btn
> - 3 enabled
> - # echo disable > ff_pwr_btn
> - # cat ff_pwr_btn
> - 3 disabled
> - # press the power button for 3 times;
> - # cat ff_pwr_btn
> - 3 disabled
> - # echo enable > ff_pwr_btn
> - # cat ff_pwr_btn
> - 4 enabled
> - /*
> - * this is because the status bit is set even if the enable bit is cleared,
> - * and it triggers an ACPI fixed event when the enable bit is set again
> - */
> - # press the power button for 3 times;
> - # cat ff_pwr_btn
> - 7 enabled
> - # echo disable > ff_pwr_btn
> - # press the power button for 3 times;
> - # echo clear > ff_pwr_btn /* clear the status bit */
> - # echo disable > ff_pwr_btn
> - # cat ff_pwr_btn
> - 7 enabled
> + when pressing the power button::
> +
> + # cat ff_pwr_btn
> + 0 enabled
> + # press the power button for 3 times;
> + # cat ff_pwr_btn
> + 3 enabled
> + # echo disable > ff_pwr_btn
> + # cat ff_pwr_btn
> + 3 disabled
> + # press the power button for 3 times;
> + # cat ff_pwr_btn
> + 3 disabled
> + # echo enable > ff_pwr_btn
> + # cat ff_pwr_btn
> + 4 enabled
> + /*
> + * this is because the status bit is set even if the enable
> + * bit is cleared, and it triggers an ACPI fixed event when
> + * the enable bit is set again
> + */
> + # press the power button for 3 times;
> + # cat ff_pwr_btn
> + 7 enabled
> + # echo disable > ff_pwr_btn
> + # press the power button for 3 times;
> + # echo clear > ff_pwr_btn /* clear the status bit */
> + # echo disable > ff_pwr_btn
> + # cat ff_pwr_btn
> + 7 enabled
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-dmi-entries b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> index 210ad44b95a5..fe0289c87768 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> +++ b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> @@ -33,7 +33,7 @@ Description:
> doesn't matter), they will be represented in sysfs as
> entries "T-0" through "T-(N-1)":
>
> - Example entry directories:
> + Example entry directories::
>
> /sys/firmware/dmi/entries/17-0
> /sys/firmware/dmi/entries/17-1
> @@ -50,61 +50,65 @@ Description:
> Each DMI entry in sysfs has the common header values
> exported as attributes:
>
> - handle : The 16bit 'handle' that is assigned to this
> + ======== =================================================
> + handle The 16bit 'handle' that is assigned to this
> entry by the firmware. This handle may be
> referred to by other entries.
> - length : The length of the entry, as presented in the
> + length The length of the entry, as presented in the
> entry itself. Note that this is _not the
> total count of bytes associated with the
> - entry_. This value represents the length of
> + entry. This value represents the length of
> the "formatted" portion of the entry. This
> "formatted" region is sometimes followed by
> the "unformatted" region composed of nul
> terminated strings, with termination signalled
> by a two nul characters in series.
> - raw : The raw bytes of the entry. This includes the
> + raw The raw bytes of the entry. This includes the
> "formatted" portion of the entry, the
> "unformatted" strings portion of the entry,
> and the two terminating nul characters.
> - type : The type of the entry. This value is the same
> + type The type of the entry. This value is the same
> as found in the directory name. It indicates
> how the rest of the entry should be interpreted.
> - instance: The instance ordinal of the entry for the
> + instance The instance ordinal of the entry for the
> given type. This value is the same as found
> in the parent directory name.
> - position: The ordinal position (zero-based) of the entry
> + position The ordinal position (zero-based) of the entry
> within the entirety of the DMI entry table.
> + ======== =================================================
>
> - === Entry Specialization ===
> + **Entry Specialization**
>
> Some entry types may have other information available in
> sysfs. Not all types are specialized.
>
> - --- Type 15 - System Event Log ---
> + **Type 15 - System Event Log**
>
> This entry allows the firmware to export a log of
> events the system has taken. This information is
> typically backed by nvram, but the implementation
> details are abstracted by this table. This entry's data
> - is exported in the directory:
> + is exported in the directory::
>
> - /sys/firmware/dmi/entries/15-0/system_event_log
> + /sys/firmware/dmi/entries/15-0/system_event_log
>
> and has the following attributes (documented in the
> SMBIOS / DMI specification under "System Event Log (Type 15)":
>
> - area_length
> - header_start_offset
> - data_start_offset
> - access_method
> - status
> - change_token
> - access_method_address
> - header_format
> - per_log_type_descriptor_length
> - type_descriptors_supported_count
> + - area_length
> + - header_start_offset
> + - data_start_offset
> + - access_method
> + - status
> + - change_token
> + - access_method_address
> + - header_format
> + - per_log_type_descriptor_length
> + - type_descriptors_supported_count
>
> As well, the kernel exports the binary attribute:
>
> - raw_event_log : The raw binary bits of the event log
> + ============= ====================================
> + raw_event_log The raw binary bits of the event log
> as described by the DMI entry.
> + ============= ====================================
> diff --git a/Documentation/ABI/testing/sysfs-firmware-gsmi b/Documentation/ABI/testing/sysfs-firmware-gsmi
> index 0faa0aaf4b6a..7a558354c1ee 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-gsmi
> +++ b/Documentation/ABI/testing/sysfs-firmware-gsmi
> @@ -20,7 +20,7 @@ Description:
>
> This directory has the same layout (and
> underlying implementation as /sys/firmware/efi/vars.
> - See Documentation/ABI/*/sysfs-firmware-efi-vars
> + See `Documentation/ABI/*/sysfs-firmware-efi-vars`
> for more information on how to interact with
> this structure.
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-memmap b/Documentation/ABI/testing/sysfs-firmware-memmap
> index eca0d65087dc..1f6f4d3a32c0 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-memmap
> +++ b/Documentation/ABI/testing/sysfs-firmware-memmap
> @@ -20,7 +20,7 @@ Description:
> the raw memory map to userspace.
>
> The structure is as follows: Under /sys/firmware/memmap there
> - are subdirectories with the number of the entry as their name:
> + are subdirectories with the number of the entry as their name::
>
> /sys/firmware/memmap/0
> /sys/firmware/memmap/1
> @@ -34,14 +34,16 @@ Description:
>
> Each directory contains three files:
>
> - start : The start address (as hexadecimal number with the
> + ======== =====================================================
> + start The start address (as hexadecimal number with the
> '0x' prefix).
> - end : The end address, inclusive (regardless whether the
> + end The end address, inclusive (regardless whether the
> firmware provides inclusive or exclusive ranges).
> - type : Type of the entry as string. See below for a list of
> + type Type of the entry as string. See below for a list of
> valid types.
> + ======== =====================================================
>
> - So, for example:
> + So, for example::
>
> /sys/firmware/memmap/0/start
> /sys/firmware/memmap/0/end
> @@ -57,9 +59,8 @@ Description:
> - reserved
>
> Following shell snippet can be used to display that memory
> - map in a human-readable format:
> + map in a human-readable format::
>
> - -------------------- 8< ----------------------------------------
> #!/bin/bash
> cd /sys/firmware/memmap
> for dir in * ; do
> @@ -68,4 +69,3 @@ Description:
> type=$(cat $dir/type)
> printf "%016x-%016x (%s)\n" $start $[ $end +1] "$type"
> done
> - -------------------- >8 ----------------------------------------
> diff --git a/Documentation/ABI/testing/sysfs-fs-ext4 b/Documentation/ABI/testing/sysfs-fs-ext4
> index 78604db56279..99e3d92f8299 100644
> --- a/Documentation/ABI/testing/sysfs-fs-ext4
> +++ b/Documentation/ABI/testing/sysfs-fs-ext4
> @@ -45,8 +45,8 @@ Description:
> parameter will have their blocks allocated out of a
> block group specific preallocation pool, so that small
> files are packed closely together. Each large file
> - will have its blocks allocated out of its own unique
> - preallocation pool.
> + will have its blocks allocated out of its own unique
> + preallocation pool.
>
> What: /sys/fs/ext4/<disk>/inode_readahead_blks
> Date: March 2008
> diff --git a/Documentation/ABI/testing/sysfs-hypervisor-xen b/Documentation/ABI/testing/sysfs-hypervisor-xen
> index 53b7b2ea7515..4dbe0c49b393 100644
> --- a/Documentation/ABI/testing/sysfs-hypervisor-xen
> +++ b/Documentation/ABI/testing/sysfs-hypervisor-xen
> @@ -15,14 +15,17 @@ KernelVersion: 4.3
> Contact: Boris Ostrovsky <boris.ostrovsky@oracle.com>
> Description: If running under Xen:
> Describes mode that Xen's performance-monitoring unit (PMU)
> - uses. Accepted values are
> - "off" -- PMU is disabled
> - "self" -- The guest can profile itself
> - "hv" -- The guest can profile itself and, if it is
> + uses. Accepted values are:
> +
> + ====== ============================================
> + "off" PMU is disabled
> + "self" The guest can profile itself
> + "hv" The guest can profile itself and, if it is
> privileged (e.g. dom0), the hypervisor
> - "all" -- The guest can profile itself, the hypervisor
> + "all" The guest can profile itself, the hypervisor
> and all other guests. Only available to
> privileged guests.
> + ====== ============================================
>
> What: /sys/hypervisor/pmu/pmu_features
> Date: August 2015
> diff --git a/Documentation/ABI/testing/sysfs-kernel-boot_params b/Documentation/ABI/testing/sysfs-kernel-boot_params
> index eca38ce2852d..7f9bda453c4d 100644
> --- a/Documentation/ABI/testing/sysfs-kernel-boot_params
> +++ b/Documentation/ABI/testing/sysfs-kernel-boot_params
> @@ -23,16 +23,17 @@ Description: The /sys/kernel/boot_params directory contains two
> representation of setup_data type. "data" file is the binary
> representation of setup_data payload.
>
> - The whole boot_params directory structure is like below:
> - /sys/kernel/boot_params
> - |__ data
> - |__ setup_data
> - | |__ 0
> - | | |__ data
> - | | |__ type
> - | |__ 1
> - | |__ data
> - | |__ type
> - |__ version
> + The whole boot_params directory structure is like below::
> +
> + /sys/kernel/boot_params
> + |__ data
> + |__ setup_data
> + | |__ 0
> + | | |__ data
> + | | |__ type
> + | |__ 1
> + | |__ data
> + | |__ type
> + |__ version
>
> Users: Kexec
> diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages
> index fdaa2162fae1..294387e2c7fb 100644
> --- a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages
> +++ b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages
> @@ -7,9 +7,11 @@ Description:
> of the hugepages supported by the kernel/CPU combination.
>
> Under these directories are a number of files:
> - nr_hugepages
> - nr_overcommit_hugepages
> - free_hugepages
> - surplus_hugepages
> - resv_hugepages
> +
> + - nr_hugepages
> + - nr_overcommit_hugepages
> + - free_hugepages
> + - surplus_hugepages
> + - resv_hugepages
> +
> See Documentation/admin-guide/mm/hugetlbpage.rst for details.
> diff --git a/Documentation/ABI/testing/sysfs-platform-asus-laptop b/Documentation/ABI/testing/sysfs-platform-asus-laptop
> index 8b0e8205a6a2..c78d358dbdbe 100644
> --- a/Documentation/ABI/testing/sysfs-platform-asus-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-asus-laptop
> @@ -4,13 +4,16 @@ KernelVersion: 2.6.20
> Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> This file allows display switching. The value
> - is composed by 4 bits and defined as follow:
> - 4321
> - |||`- LCD
> - ||`-- CRT
> - |`--- TV
> - `---- DVI
> - Ex: - 0 (0000b) means no display
> + is composed by 4 bits and defined as follow::
> +
> + 4321
> + |||`- LCD
> + ||`-- CRT
> + |`--- TV
> + `---- DVI
> +
> + Ex:
> + - 0 (0000b) means no display
> - 3 (0011b) CRT+LCD.
>
> What: /sys/devices/platform/asus_laptop/gps
> @@ -28,8 +31,10 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> Some models like the W1N have a LED display that can be
> used to display several items of information.
> - To control the LED display, use the following :
> + To control the LED display, use the following::
> +
> echo 0x0T000DDD > /sys/devices/platform/asus_laptop/
> +
> where T control the 3 letters display, and DDD the 3 digits display.
> The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst
>
> diff --git a/Documentation/ABI/testing/sysfs-platform-asus-wmi b/Documentation/ABI/testing/sysfs-platform-asus-wmi
> index 1efac0ddb417..04885738cf15 100644
> --- a/Documentation/ABI/testing/sysfs-platform-asus-wmi
> +++ b/Documentation/ABI/testing/sysfs-platform-asus-wmi
> @@ -5,6 +5,7 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> Change CPU clock configuration (write-only).
> There are three available clock configuration:
> +
> * 0 -> Super Performance Mode
> * 1 -> High Performance Mode
> * 2 -> Power Saving Mode
> diff --git a/Documentation/ABI/testing/sysfs-platform-at91 b/Documentation/ABI/testing/sysfs-platform-at91
> index 4cc6a865ae66..b146be74b8e0 100644
> --- a/Documentation/ABI/testing/sysfs-platform-at91
> +++ b/Documentation/ABI/testing/sysfs-platform-at91
> @@ -18,8 +18,10 @@ Description:
> In order to use an extended can_id add the
> CAN_EFF_FLAG (0x80000000U) to the can_id. Example:
>
> - - standard id 0x7ff:
> - echo 0x7ff > /sys/class/net/can0/mb0_id
> + - standard id 0x7ff::
>
> - - extended id 0x1fffffff:
> - echo 0x9fffffff > /sys/class/net/can0/mb0_id
> + echo 0x7ff > /sys/class/net/can0/mb0_id
> +
> + - extended id 0x1fffffff::
> +
> + echo 0x9fffffff > /sys/class/net/can0/mb0_id
> diff --git a/Documentation/ABI/testing/sysfs-platform-eeepc-laptop b/Documentation/ABI/testing/sysfs-platform-eeepc-laptop
> index 5b026c69587a..70dbe0733cf6 100644
> --- a/Documentation/ABI/testing/sysfs-platform-eeepc-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-eeepc-laptop
> @@ -4,9 +4,11 @@ KernelVersion: 2.6.26
> Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> This file allows display switching.
> +
> - 1 = LCD
> - 2 = CRT
> - 3 = LCD+CRT
> +
> If you run X11, you should use xrandr instead.
>
> What: /sys/devices/platform/eeepc/camera
> @@ -30,16 +32,20 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
> Description:
> Change CPU clock configuration.
> On the Eee PC 1000H there are three available clock configuration:
> +
> * 0 -> Super Performance Mode
> * 1 -> High Performance Mode
> * 2 -> Power Saving Mode
> +
> On Eee PC 701 there is only 2 available clock configurations.
> Available configuration are listed in available_cpufv file.
> Reading this file will show the raw hexadecimal value which
> - is defined as follow:
> - | 8 bit | 8 bit |
> - | `---- Current mode
> - `------------ Availables modes
> + is defined as follow::
> +
> + | 8 bit | 8 bit |
> + | `---- Current mode
> + `------------ Availables modes
> +
> For example, 0x301 means: mode 1 selected, 3 available modes.
>
> What: /sys/devices/platform/eeepc/available_cpufv
> diff --git a/Documentation/ABI/testing/sysfs-platform-ideapad-laptop b/Documentation/ABI/testing/sysfs-platform-ideapad-laptop
> index 1b31be3f996a..fd2ac02bc5bd 100644
> --- a/Documentation/ABI/testing/sysfs-platform-ideapad-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-ideapad-laptop
> @@ -12,6 +12,7 @@ Contact: "Maxim Mikityanskiy <maxtram95@gmail.com>"
> Description:
> Change fan mode
> There are four available modes:
> +
> * 0 -> Super Silent Mode
> * 1 -> Standard Mode
> * 2 -> Dust Cleaning
> @@ -32,9 +33,11 @@ KernelVersion: 4.18
> Contact: "Oleg Keri <ezhi99@gmail.com>"
> Description:
> Control fn-lock mode.
> +
> * 1 -> Switched On
> * 0 -> Switched Off
>
> - For example:
> - # echo "0" > \
> - /sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock
> + For example::
> +
> + # echo "0" > \
> + /sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt b/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
> index 8af65059d519..e19144fd5d86 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
> @@ -7,5 +7,6 @@ Description:
> Thunderbolt controllers to turn on or off when no
> devices are connected (write-only)
> There are two available states:
> +
> * 0 -> Force power disabled
> * 1 -> Force power enabled
> diff --git a/Documentation/ABI/testing/sysfs-platform-sst-atom b/Documentation/ABI/testing/sysfs-platform-sst-atom
> index 0d07c0395660..d5f6e21f0e42 100644
> --- a/Documentation/ABI/testing/sysfs-platform-sst-atom
> +++ b/Documentation/ABI/testing/sysfs-platform-sst-atom
> @@ -5,13 +5,22 @@ Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com>
> Description:
> LPE Firmware version for SST driver on all atom
> plaforms (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"
> - If FW has been loaded it will display:
> +
> + If FW has been loaded it will display::
> +
> "v01.aa.bb.cc"
> +
> aa: Major version is reflecting SoC version:
> +
> + === =============
> 0d: BYT FW
> 0b: BSW FW
> 07: Merrifield FW
> + === =============
> +
> bb: Minor version
> +
> cc: Build version
> diff --git a/Documentation/ABI/testing/sysfs-platform-usbip-vudc b/Documentation/ABI/testing/sysfs-platform-usbip-vudc
> index 81fcfb454913..53622d3ba27c 100644
> --- a/Documentation/ABI/testing/sysfs-platform-usbip-vudc
> +++ b/Documentation/ABI/testing/sysfs-platform-usbip-vudc
> @@ -16,10 +16,13 @@ Contact: Krzysztof Opasiak <k.opasiak@samsung.com>
> Description:
> Current status of the device.
> Allowed values:
> - 1 - Device is available and can be exported
> - 2 - Device is currently exported
> - 3 - Fatal error occurred during communication
> - with peer
> +
> + == ==========================================
> + 1 Device is available and can be exported
> + 2 Device is currently exported
> + 3 Fatal error occurred during communication
> + with peer
> + == ==========================================
>
> What: /sys/devices/platform/usbip-vudc.%d/usbip_sockfd
> Date: April 2016
> diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp
> index a17f817a9309..2363ad810ddb 100644
> --- a/Documentation/ABI/testing/sysfs-ptp
> +++ b/Documentation/ABI/testing/sysfs-ptp
> @@ -69,7 +69,7 @@ Description:
> pin offered by the PTP hardware clock. The file name
> is the hardware dependent pin name. Reading from this
> file produces two numbers, the assigned function (see
> - the PTP_PF_ enumeration values in linux/ptp_clock.h)
> + the `PTP_PF_` enumeration values in linux/ptp_clock.h)
> and the channel number. The function and channel
> assignment may be changed by two writing numbers into
> the file.
>
next prev parent reply other threads:[~2020-10-30 9:20 UTC|newest]
Thread overview: 102+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-30 7:40 [PATCH v2 00/39] ABI: add it to the documentation build system Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 01/39] scripts: get_abi.pl: change script to allow parsing in ReST mode Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 02/39] scripts: get_abi.pl: fix parsing on " Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 03/39] scripts: get_abi.pl: Allow optionally record from where a line came from Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 04/39] scripts: get_abi.pl: improve its parser to better catch up indentation Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 05/39] scripts: get_abi.pl: cleanup ABI cross-reference logic Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 06/39] scripts: get_abi.pl: detect duplicated ABI definitions Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 07/39] scripts: get_abi.pl: output users in ReST format Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 08/39] scripts: get_abi.pl: prevent duplicated file names Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 09/39] scripts: get_abi.pl: use bold font for ABI definitions Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 10/39] scripts: get_abi.pl: auto-generate cross references Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 11/39] docs: kernellog.py: add support for info() Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 12/39] docs: kernel_abi.py: add a script to parse ABI documentation Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 13/39] docs: kernel_abi.py: fix UTF-8 support Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 14/39] docs: kernel_abi.py: make it compatible with Sphinx 1.7+ Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 15/39] docs: kernel_abi.py: use --enable-lineno for get_abi.pl Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 16/39] docs: kernel_abi.py: Handle with a lazy Sphinx parser Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 17/39] docs: add ABI documentation to the admin-guide book Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 18/39] docs: ABI: README: specify that files should be ReST compatible Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 19/39] docs: ABI: stable: make files " Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 10:04 ` Srinivas Kandagatla
2020-10-30 10:04 ` Srinivas Kandagatla
2020-10-30 10:04 ` Srinivas Kandagatla
2020-10-30 7:40 ` [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 9:19 ` Fabrice Gasnier [this message]
2020-10-30 9:19 ` Fabrice Gasnier
2020-10-30 10:09 ` Mauro Carvalho Chehab
2020-10-30 10:09 ` Mauro Carvalho Chehab
2020-11-02 11:04 ` Fabrice Gasnier
2020-11-02 11:04 ` Fabrice Gasnier
2020-11-02 12:46 ` Greg Kroah-Hartman
2020-11-02 12:46 ` Greg Kroah-Hartman
2020-11-02 14:42 ` Mauro Carvalho Chehab
2020-11-02 14:42 ` Mauro Carvalho Chehab
2020-11-08 16:56 ` Jonathan Cameron
2020-11-08 16:56 ` Jonathan Cameron
2020-11-10 7:26 ` Duplicated ABI entries - Was: " Mauro Carvalho Chehab
2020-11-10 7:26 ` Mauro Carvalho Chehab
2020-11-10 18:18 ` Randy Dunlap
2020-11-10 18:18 ` Randy Dunlap
2020-11-14 15:27 ` Jonathan Cameron
2020-11-14 15:27 ` Jonathan Cameron
2020-10-30 17:26 ` Frederic Barrat
2020-10-30 17:26 ` Frederic Barrat
2020-10-30 7:40 ` [PATCH v2 21/39] docs: ABI: sysfs-uevent: make it " Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 22/39] docs: ABI: make it parse ABI/stable as ReST-compatible files Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 23/39] docs: ABI: create a 2-depth index for ABI Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 24/39] docs: ABI: don't escape ReST-incompatible chars from obsolete and removed Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 25/39] docs: abi-testing.rst: enable --rst-sources when building docs Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 26/39] docs: Kconfig/Makefile: add a check for broken ABI files Mauro Carvalho Chehab
2020-10-30 16:49 ` Randy Dunlap
2020-10-30 7:40 ` [PATCH v2 27/39] docs: ABI: convert testing/configfs-acpi to ReST Mauro Carvalho Chehab
2020-10-30 14:33 ` Rafael J. Wysocki
2020-10-30 7:40 ` [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 14:39 ` Rafael J. Wysocki
2020-10-30 14:39 ` Rafael J. Wysocki
2020-11-02 5:50 ` Jinpu Wang
2020-11-02 5:50 ` Jinpu Wang
2020-11-02 18:39 ` Joseph, Jithu
2020-11-02 18:39 ` Joseph, Jithu
2020-10-30 7:40 ` [PATCH v2 29/39] docs: ABI: vdso: use the right format for ABI Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 30/39] docs: ABI: sysfs-bus-nvdimm: " Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 31/39] docs: ABI: cleanup several ABI documents Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 7:40 ` [f2fs-dev] " Mauro Carvalho Chehab
2020-10-30 8:27 ` Rojewski, Cezary
2020-10-30 8:27 ` Rojewski, Cezary
2020-10-30 8:27 ` Rojewski, Cezary
2020-10-30 8:27 ` [f2fs-dev] " Rojewski, Cezary
2020-10-30 9:49 ` Suzuki K Poulose
2020-10-30 9:49 ` Suzuki K Poulose
2020-10-30 9:49 ` Suzuki K Poulose
2020-10-30 9:49 ` [f2fs-dev] " Suzuki K Poulose
2020-10-30 11:11 ` Ilya Dryomov
2020-10-30 11:11 ` Ilya Dryomov
2020-10-30 11:11 ` Ilya Dryomov
2020-10-30 11:11 ` [f2fs-dev] " Ilya Dryomov
2020-10-30 16:42 ` Mathieu Poirier
2020-10-30 16:42 ` Mathieu Poirier
2020-10-30 16:42 ` Mathieu Poirier
2020-10-30 16:42 ` [f2fs-dev] " Mathieu Poirier
2020-10-30 23:23 ` Peter Chen
2020-10-30 23:23 ` Peter Chen
2020-10-30 23:23 ` Peter Chen
2020-10-30 23:23 ` [f2fs-dev] " Peter Chen
2020-11-01 3:43 ` Dmitry Torokhov
2020-10-30 7:40 ` [PATCH v2 32/39] docs: ABI: change read/write attributes Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 33/39] docs: ABI: stable: remove a duplicated documentation Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 34/39] docs: ABI: unify /sys/class/leds/<led>/brightness documentation Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 35/39] docs: ABI: sysfs-class-power: unify duplicated properties Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 36/39] docs: ABI: sysfs-c2port: remove a duplicated entry Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 37/39] docs: ABI: sysfs-class-backlight: unify ABI documentation Mauro Carvalho Chehab
2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 38/39] docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern duplication Mauro Carvalho Chehab
2020-10-30 7:40 ` [PATCH v2 39/39] scripts: get_abi.pl: assume ReST format by default Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5326488b-4185-9d67-fc09-79b911fbb3b8@st.com \
--to=fabrice.gasnier@st.com \
--cc=Jason@zx2c4.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=Thinh.Nguyen@synopsys.com \
--cc=ajd@linux.ibm.com \
--cc=alexander.shishkin@linux.intel.com \
--cc=alexandre.belloni@bootlin.com \
--cc=alexandre.torgue@st.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=axboe@kernel.dk \
--cc=balbi@kernel.org \
--cc=baolin.wang7@gmail.com \
--cc=bleung@chromium.org \
--cc=bmeneg@redhat.com \
--cc=boris.ostrovsky@oracle.com \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=dmurphy@ti.com \
--cc=ego@linux.vnet.ibm.com \
--cc=enric.balletbo@collabora.com \
--cc=fbarrat@linux.ibm.com \
--cc=felix@linux.ibm.com \
--cc=gregkh@linuxfoundation.org \
--cc=groeck@chromium.org \
--cc=guohanjun@huawei.com \
--cc=heikki.krogerus@linux.intel.com \
--cc=javier@javigon.com \
--cc=jgross@suse.com \
--cc=jic23@kernel.org \
--cc=johannes.thumshirn@wdc.com \
--cc=koct9i@gmail.com \
--cc=kranthi.kuntala@intel.com \
--cc=lars@metafoo.de \
--cc=lenb@kernel.org \
--cc=leonmaxx@gmail.com \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-stm32@st-md-mailman.stormreply.com \
--cc=linux-usb@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=ludovic.desroches@microchip.com \
--cc=mario.limonciello@dell.com \
--cc=martin.petersen@oracle.com \
--cc=mchehab+huawei@kernel.org \
--cc=mcoquelin.stm32@gmail.com \
--cc=mgross@linux.intel.com \
--cc=mika.westerberg@linux.intel.com \
--cc=mike.kravetz@oracle.com \
--cc=mpe@ellerman.id.au \
--cc=nayna@linux.ibm.com \
--cc=netdev@vger.kernel.org \
--cc=nicolas.ferre@microchip.com \
--cc=niklas.cassel@wdc.com \
--cc=nramas@linux.microsoft.com \
--cc=oded.gabbay@gmail.com \
--cc=oleg@kaa.org.ua \
--cc=orsonzhai@gmail.com \
--cc=pavel@ucw.cz \
--cc=pawan.kumar.gupta@linux.intel.com \
--cc=peda@axentia.se \
--cc=pmeerw@pmeerw.net \
--cc=pmladek@suse.com \
--cc=richardcochran@gmail.com \
--cc=rjw@rjwysocki.net \
--cc=sergey.senozhatsky@gmail.com \
--cc=sre@kernel.org \
--cc=sstabellini@kernel.org \
--cc=tglx@linutronix.de \
--cc=trix@redhat.com \
--cc=vaibhav@linux.ibm.com \
--cc=vineela.tummalapalli@intel.com \
--cc=vishal.l.verma@intel.com \
--cc=xen-devel@lists.xenproject.org \
--cc=zhang.lyra@gmail.com \
--cc=zohar@linux.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.