OSDN Git Service

docs: ABI: cleanup several ABI documents
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 30 Oct 2020 07:40:50 +0000 (08:40 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 30 Oct 2020 12:14:29 +0000 (13:14 +0100)
There are some ABI documents that, while they don't generate
any warnings, they have issues when parsed by get_abi.pl script
on its output result.

Address them, in order to provide a clean output.

Reviewed-by: Tom Rix <trix@redhat.com> # for fpga-manager
Reviewed-By: Kajol Jain<kjain@linux.ibm.com> # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
Acked-by: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt
Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com>
Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd
Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
126 files changed:
Documentation/ABI/obsolete/sysfs-class-dax
Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra
Documentation/ABI/removed/devfs
Documentation/ABI/removed/raw1394
Documentation/ABI/removed/sysfs-class-rfkill
Documentation/ABI/removed/video1394
Documentation/ABI/stable/firewire-cdev
Documentation/ABI/stable/sysfs-acpi-pmprofile
Documentation/ABI/stable/sysfs-bus-w1
Documentation/ABI/stable/sysfs-class-tpm
Documentation/ABI/stable/sysfs-driver-speakup
Documentation/ABI/testing/configfs-most
Documentation/ABI/testing/configfs-usb-gadget-ecm
Documentation/ABI/testing/configfs-usb-gadget-eem
Documentation/ABI/testing/configfs-usb-gadget-loopback
Documentation/ABI/testing/configfs-usb-gadget-mass-storage
Documentation/ABI/testing/configfs-usb-gadget-midi
Documentation/ABI/testing/configfs-usb-gadget-printer
Documentation/ABI/testing/configfs-usb-gadget-sourcesink
Documentation/ABI/testing/configfs-usb-gadget-subset
Documentation/ABI/testing/configfs-usb-gadget-uac2
Documentation/ABI/testing/configfs-usb-gadget-uvc
Documentation/ABI/testing/debugfs-cec-error-inj
Documentation/ABI/testing/debugfs-driver-habanalabs
Documentation/ABI/testing/debugfs-pfo-nx-crypto
Documentation/ABI/testing/debugfs-pktcdvd
Documentation/ABI/testing/debugfs-turris-mox-rwtm
Documentation/ABI/testing/debugfs-wilco-ec
Documentation/ABI/testing/dell-smbios-wmi
Documentation/ABI/testing/gpio-cdev
Documentation/ABI/testing/procfs-diskstats
Documentation/ABI/testing/procfs-smaps_rollup
Documentation/ABI/testing/pstore
Documentation/ABI/testing/sysfs-block-rnbd
Documentation/ABI/testing/sysfs-bus-acpi
Documentation/ABI/testing/sysfs-bus-coresight-devices-etb10
Documentation/ABI/testing/sysfs-bus-css
Documentation/ABI/testing/sysfs-bus-dfl
Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7
Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
Documentation/ABI/testing/sysfs-bus-fcoe
Documentation/ABI/testing/sysfs-bus-fsl-mc
Documentation/ABI/testing/sysfs-bus-i2c-devices-fsa9480
Documentation/ABI/testing/sysfs-bus-i3c
Documentation/ABI/testing/sysfs-bus-iio
Documentation/ABI/testing/sysfs-bus-iio-adc-hi8435
Documentation/ABI/testing/sysfs-bus-iio-adc-stm32
Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9523
Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371
Documentation/ABI/testing/sysfs-bus-iio-health-afe440x
Documentation/ABI/testing/sysfs-bus-iio-light-isl29018
Documentation/ABI/testing/sysfs-bus-intel_th-devices-gth
Documentation/ABI/testing/sysfs-bus-papr-pmem
Documentation/ABI/testing/sysfs-bus-pci
Documentation/ABI/testing/sysfs-bus-pci-devices-catpt
Documentation/ABI/testing/sysfs-bus-pci-drivers-ehci_hcd
Documentation/ABI/testing/sysfs-bus-rbd
Documentation/ABI/testing/sysfs-bus-siox
Documentation/ABI/testing/sysfs-bus-thunderbolt
Documentation/ABI/testing/sysfs-bus-usb
Documentation/ABI/testing/sysfs-class-backlight-driver-lm3533
Documentation/ABI/testing/sysfs-class-bdi
Documentation/ABI/testing/sysfs-class-chromeos
Documentation/ABI/testing/sysfs-class-cxl
Documentation/ABI/testing/sysfs-class-devlink
Documentation/ABI/testing/sysfs-class-extcon
Documentation/ABI/testing/sysfs-class-fpga-manager
Documentation/ABI/testing/sysfs-class-gnss
Documentation/ABI/testing/sysfs-class-led
Documentation/ABI/testing/sysfs-class-led-driver-el15203000
Documentation/ABI/testing/sysfs-class-led-driver-lm3533
Documentation/ABI/testing/sysfs-class-led-flash
Documentation/ABI/testing/sysfs-class-led-trigger-netdev
Documentation/ABI/testing/sysfs-class-led-trigger-usbport
Documentation/ABI/testing/sysfs-class-leds-gt683r
Documentation/ABI/testing/sysfs-class-net
Documentation/ABI/testing/sysfs-class-net-cdc_ncm
Documentation/ABI/testing/sysfs-class-net-phydev
Documentation/ABI/testing/sysfs-class-pktcdvd
Documentation/ABI/testing/sysfs-class-power
Documentation/ABI/testing/sysfs-class-power-mp2629
Documentation/ABI/testing/sysfs-class-power-twl4030
Documentation/ABI/testing/sysfs-class-rapidio
Documentation/ABI/testing/sysfs-class-regulator
Documentation/ABI/testing/sysfs-class-remoteproc
Documentation/ABI/testing/sysfs-class-rtc-rtc0-device-rtc_calibration
Documentation/ABI/testing/sysfs-class-uwb_rc
Documentation/ABI/testing/sysfs-class-watchdog
Documentation/ABI/testing/sysfs-dev
Documentation/ABI/testing/sysfs-devices-mapping
Documentation/ABI/testing/sysfs-devices-memory
Documentation/ABI/testing/sysfs-devices-platform-_UDC_-gadget
Documentation/ABI/testing/sysfs-devices-platform-ipmi
Documentation/ABI/testing/sysfs-devices-system-cpu
Documentation/ABI/testing/sysfs-driver-hid-lenovo
Documentation/ABI/testing/sysfs-driver-hid-ntrig
Documentation/ABI/testing/sysfs-driver-hid-roccat-kone
Documentation/ABI/testing/sysfs-driver-hid-wiimote
Documentation/ABI/testing/sysfs-driver-input-exc3000
Documentation/ABI/testing/sysfs-driver-jz4780-efuse
Documentation/ABI/testing/sysfs-driver-pciback
Documentation/ABI/testing/sysfs-driver-ufs
Documentation/ABI/testing/sysfs-driver-w1_ds28e17
Documentation/ABI/testing/sysfs-firmware-acpi
Documentation/ABI/testing/sysfs-firmware-efi-esrt
Documentation/ABI/testing/sysfs-firmware-efi-runtime-map
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
Documentation/ABI/testing/sysfs-firmware-sfi
Documentation/ABI/testing/sysfs-firmware-sgi_uv
Documentation/ABI/testing/sysfs-fs-f2fs
Documentation/ABI/testing/sysfs-kernel-mm-ksm
Documentation/ABI/testing/sysfs-kernel-slab
Documentation/ABI/testing/sysfs-module
Documentation/ABI/testing/sysfs-platform-dell-laptop
Documentation/ABI/testing/sysfs-platform-dell-smbios
Documentation/ABI/testing/sysfs-platform-i2c-demux-pinctrl
Documentation/ABI/testing/sysfs-platform-kim
Documentation/ABI/testing/sysfs-platform-phy-rcar-gen3-usb2
Documentation/ABI/testing/sysfs-platform-renesas_usb3
Documentation/ABI/testing/sysfs-power
Documentation/ABI/testing/sysfs-profiling
Documentation/ABI/testing/sysfs-wusb_cbaf
Documentation/ABI/testing/usb-charger-uevent
Documentation/ABI/testing/usb-uevent
scripts/get_abi.pl

index 2cb9fc5..0faf135 100644 (file)
@@ -8,11 +8,11 @@ Description:  Device DAX is the device-centric analogue of Filesystem
                system.  Device DAX is strict, precise and predictable.
                Specifically this interface:
 
-               1/ Guarantees fault granularity with respect to a given
-               page size (pte, pmd, or pud) set at configuration time.
+               1. Guarantees fault granularity with respect to a given
+                  page size (pte, pmd, or pud) set at configuration time.
 
-               2/ Enforces deterministic behavior by being strict about
-               what fault scenarios are supported.
+               2. Enforces deterministic behavior by being strict about
+                  what fault scenarios are supported.
 
                The /sys/class/dax/ interface enumerates all the
                device-dax instances in the system. The ABI is
index 5d41eba..66545c5 100644 (file)
@@ -7,10 +7,13 @@ Description:  It is possible to switch the cpi setting of the mouse with the
                setting reported by the mouse. This number has to be further
                processed to receive the real dpi value:
 
+               ===== ====
                VALUE DPI
+               ===== ====
                1     400
                2     800
                4     1600
+               ===== ====
 
                This file is readonly.
                Has never been used. If bookkeeping is done, it's done in userland tools.
index 0020c49..24fb35a 100644 (file)
@@ -5,6 +5,7 @@ Description:
        devfs has been unmaintained for a number of years, has unfixable
        races, contains a naming policy within the kernel that is
        against the LSB, and can be replaced by using udev.
+
        The files fs/devfs/*, include/linux/devfs_fs*.h were removed,
        along with the assorted devfs function calls throughout the
        kernel tree.
index ec333e6..9ec7ec4 100644 (file)
@@ -7,6 +7,7 @@ Description:
        to implement sensible device security policies, and its low level
        of abstraction that required userspace clients to duplicate much
        of the kernel's ieee1394 core functionality.
+
        Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of
        firewire-core.
 
index 9c08c7f..f25174e 100644 (file)
@@ -10,4 +10,4 @@ Description:  This file was deprecated because there no longer was a way to
                claim just control over a single rfkill instance.
                This file was scheduled to be removed in 2012, and was removed
                in 2016.
-Values:        0: Kernel handles events
+Values:                0: Kernel handles events
index c39c25a..1905d35 100644 (file)
@@ -8,6 +8,7 @@ Description:
        performance issues in its first generation.  Any video1394 user had
        to use raw1394 + libraw1394 too because video1394 did not provide
        asynchronous I/O for device discovery and configuration.
+
        Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of
        firewire-core.
 
index c9e8ff0..261f85b 100644 (file)
@@ -16,6 +16,7 @@ Description:
                different scope:
 
                  - The 1394 node which is associated with the file:
+
                          - Asynchronous request transmission
                          - Get the Configuration ROM
                          - Query node ID
@@ -23,6 +24,7 @@ Description:
                            and local node
 
                  - The 1394 bus (i.e. "card") to which the node is attached to:
+
                          - Isochronous stream transmission and reception
                          - Asynchronous stream transmission and reception
                          - Asynchronous broadcast request transmission
@@ -35,6 +37,7 @@ Description:
                          - Bus reset initiation, bus reset event reception
 
                  - All 1394 buses:
+
                          - Allocation of IEEE 1212 address ranges on the local
                            link layers, reception of inbound requests to such
                            an address range, asynchronous response transmission
@@ -59,50 +62,50 @@ Description:
                The following file operations are supported:
 
                open(2)
-               Currently the only useful flags are O_RDWR.
+                   Currently the only useful flags are O_RDWR.
 
                ioctl(2)
-               Initiate various actions.  Some take immediate effect, others
-               are performed asynchronously while or after the ioctl returns.
-               See the inline documentation in <linux/firewire-cdev.h> for
-               descriptions of all ioctls.
+                   Initiate various actions.  Some take immediate effect, others
+                   are performed asynchronously while or after the ioctl returns.
+                   See the inline documentation in <linux/firewire-cdev.h> for
+                   descriptions of all ioctls.
 
                poll(2), select(2), epoll_wait(2) etc.
-               Watch for events to become available to be read.
+                   Watch for events to become available to be read.
 
                read(2)
-               Receive various events.  There are solicited events like
-               outbound asynchronous transaction completion or isochronous
-               buffer completion, and unsolicited events such as bus resets,
-               request reception, or PHY packet reception.  Always use a read
-               buffer which is large enough to receive the largest event that
-               could ever arrive.  See <linux/firewire-cdev.h> for descriptions
-               of all event types and for which ioctls affect reception of
-               events.
+                   Receive various events.  There are solicited events like
+                   outbound asynchronous transaction completion or isochronous
+                   buffer completion, and unsolicited events such as bus resets,
+                   request reception, or PHY packet reception.  Always use a read
+                   buffer which is large enough to receive the largest event that
+                   could ever arrive.  See <linux/firewire-cdev.h> for descriptions
+                   of all event types and for which ioctls affect reception of
+                   events.
 
                mmap(2)
-               Allocate a DMA buffer for isochronous reception or transmission
-               and map it into the process address space.  The arguments should
-               be used as follows:  addr = NULL, length = the desired buffer
-               size, i.e. number of packets times size of largest packet,
-               prot = at least PROT_READ for reception and at least PROT_WRITE
-               for transmission, flags = MAP_SHARED, fd = the handle to the
-               /dev/fw*, offset = 0.
+                   Allocate a DMA buffer for isochronous reception or transmission
+                   and map it into the process address space.  The arguments should
+                   be used as follows:  addr = NULL, length = the desired buffer
+                   size, i.e. number of packets times size of largest packet,
+                   prot = at least PROT_READ for reception and at least PROT_WRITE
+                   for transmission, flags = MAP_SHARED, fd = the handle to the
+                   /dev/fw*, offset = 0.
 
                Isochronous reception works in packet-per-buffer fashion except
                for multichannel reception which works in buffer-fill mode.
 
                munmap(2)
-               Unmap the isochronous I/O buffer from the process address space.
+                   Unmap the isochronous I/O buffer from the process address space.
 
                close(2)
-               Besides stopping and freeing I/O contexts that were associated
-               with the file descriptor, back out any changes to the local
-               nodes' Configuration ROM.  Deallocate isochronous channels and
-               bandwidth at the IRM that were marked for kernel-assisted
-               re- and deallocation.
-
-Users:         libraw1394
-               libdc1394
-               libhinawa
+                   Besides stopping and freeing I/O contexts that were associated
+                   with the file descriptor, back out any changes to the local
+                   nodes' Configuration ROM.  Deallocate isochronous channels and
+                   bandwidth at the IRM that were marked for kernel-assisted
+                   re- and deallocation.
+
+Users:         libraw1394;
+               libdc1394;
+               libhinawa;
                tools like linux-firewire-utils, fwhack, ...
index fd97d22..2d6314f 100644 (file)
@@ -1,8 +1,8 @@
-What:          /sys/firmware/acpi/pm_profile
+What:          /sys/firmware/acpi/pm_profile
 Date:          03-Nov-2011
 KernelVersion: v3.2
 Contact:       linux-acpi@vger.kernel.org
-Description:   The ACPI pm_profile sysfs interface exports the platform
+Description:   The ACPI pm_profile sysfs interface exports the platform
                power management (and performance) requirement expectations
                as provided by BIOS. The integer value is directly passed as
                retrieved from the FADT ACPI table.
index 992dfb1..5cd5e87 100644 (file)
@@ -6,6 +6,7 @@ Description:    Bus scanning interval, microseconds component.
                control systems are attached/generate presence for as short as
                100 ms - hence the tens-to-hundreds milliseconds scan intervals
                are required.
+
                see Documentation/w1/w1-generic.rst for detailed information.
 Users:         any user space application which wants to know bus scanning
                interval
index ec464cf..91ca63e 100644 (file)
@@ -191,6 +191,6 @@ Contact:    linux-integrity@vger.kernel.org
 Description:   The "tpm_version_major" property shows the TCG spec major version
                implemented by the TPM device.
 
-               Example output:
+               Example output::
 
-               2
+                 2
index c6a32c4..792f58b 100644 (file)
@@ -69,6 +69,7 @@ Description:  Controls if typing interrupts output from speakup. With
                speakup if for example
                the say screen command is used before the
                entire screen  is read.
+
                With no_interrupt set to one, if the say
                screen command is used, and one then types on the keyboard,
                speakup will continue to say the whole screen regardless until
@@ -215,8 +216,10 @@ Description:       This file contains names for key states.
                Again, these are part of the help system.  For instance, if you
                had pressed speakup + keypad 3, you would hear:
                "speakup keypad 3 is go to bottom edge."
+
                The speakup key is depressed, so the name of the key state is
                speakup.
+
                This part of the message comes from the states collection.
 
 What:          /sys/accessibility/speakup/i18n/characters
@@ -297,6 +300,7 @@ KernelVersion:      2.6
 Contact:       speakup@linux-speakup.org
 Description:   Controls if punctuation is spoken by speakup, or by the
                synthesizer.
+
                For example, speakup speaks ">" as "greater", while
                the espeak synthesizer used by the soft driver speaks "greater
                than". Zero lets speakup speak the punctuation. One lets the
index ed67a4d..bc6b8bd 100644 (file)
@@ -15,22 +15,28 @@ KernelVersion:  5.2
 Description:
                The attributes:
 
-               buffer_size     configure the buffer size for this channel
+               buffer_size
+                               configure the buffer size for this channel
 
-               subbuffer_size  configure the sub-buffer size for this channel
+               subbuffer_size
+                               configure the sub-buffer size for this channel
                                (needed for synchronous and isochrnous data)
 
 
-               num_buffers     configure number of buffers used for this
+               num_buffers
+                               configure number of buffers used for this
                                channel
 
-               datatype        configure type of data that will travel over
+               datatype
+                               configure type of data that will travel over
                                this channel
 
-               direction       configure whether this link will be an input
+               direction
+                               configure whether this link will be an input
                                or output
 
-               dbr_size        configure DBR data buffer size (this is used
+               dbr_size
+                               configure DBR data buffer size (this is used
                                for MediaLB communication only)
 
                packets_per_xact
@@ -39,18 +45,23 @@ Description:
                                transmitted via USB (this is used for USB
                                communication only)
 
-               device          name of the device the link is to be attached to
+               device
+                               name of the device the link is to be attached to
 
-               channel         name of the channel the link is to be attached to
+               channel
+                               name of the channel the link is to be attached to
 
-               comp_params     pass parameters needed by some components
+               comp_params
+                               pass parameters needed by some components
 
-               create_link     write '1' to this attribute to trigger the
+               create_link
+                               write '1' to this attribute to trigger the
                                creation of the link. In case of speculative
                                configuration, the creation is post-poned until
                                a physical device is being attached to the bus.
 
-               destroy_link    write '1' to this attribute to destroy an
+               destroy_link
+                               write '1' to this attribute to destroy an
                                active link
 
 What:          /sys/kernel/config/most_video/<link>
@@ -59,22 +70,28 @@ KernelVersion:  5.2
 Description:
                The attributes:
 
-               buffer_size     configure the buffer size for this channel
+               buffer_size
+                               configure the buffer size for this channel
 
-               subbuffer_size  configure the sub-buffer size for this channel
+               subbuffer_size
+                               configure the sub-buffer size for this channel
                                (needed for synchronous and isochrnous data)
 
 
-               num_buffers     configure number of buffers used for this
+               num_buffers
+                               configure number of buffers used for this
                                channel
 
-               datatype        configure type of data that will travel over
+               datatype
+                               configure type of data that will travel over
                                this channel
 
-               direction       configure whether this link will be an input
+               direction
+                               configure whether this link will be an input
                                or output
 
-               dbr_size        configure DBR data buffer size (this is used
+               dbr_size
+                               configure DBR data buffer size (this is used
                                for MediaLB communication only)
 
                packets_per_xact
@@ -83,18 +100,23 @@ Description:
                                transmitted via USB (this is used for USB
                                communication only)
 
-               device          name of the device the link is to be attached to
+               device
+                               name of the device the link is to be attached to
 
-               channel         name of the channel the link is to be attached to
+               channel
+                               name of the channel the link is to be attached to
 
-               comp_params     pass parameters needed by some components
+               comp_params
+                               pass parameters needed by some components
 
-               create_link     write '1' to this attribute to trigger the
+               create_link
+                               write '1' to this attribute to trigger the
                                creation of the link. In case of speculative
                                configuration, the creation is post-poned until
                                a physical device is being attached to the bus.
 
-               destroy_link    write '1' to this attribute to destroy an
+               destroy_link
+                               write '1' to this attribute to destroy an
                                active link
 
 What:          /sys/kernel/config/most_net/<link>
@@ -103,22 +125,28 @@ KernelVersion:  5.2
 Description:
                The attributes:
 
-               buffer_size     configure the buffer size for this channel
+               buffer_size
+                               configure the buffer size for this channel
 
-               subbuffer_size  configure the sub-buffer size for this channel
+               subbuffer_size
+                               configure the sub-buffer size for this channel
                                (needed for synchronous and isochrnous data)
 
 
-               num_buffers     configure number of buffers used for this
+               num_buffers
+                               configure number of buffers used for this
                                channel
 
-               datatype        configure type of data that will travel over
+               datatype
+                               configure type of data that will travel over
                                this channel
 
-               direction       configure whether this link will be an input
+               direction
+                               configure whether this link will be an input
                                or output
 
-               dbr_size        configure DBR data buffer size (this is used
+               dbr_size
+                               configure DBR data buffer size (this is used
                                for MediaLB communication only)
 
                packets_per_xact
@@ -127,18 +155,23 @@ Description:
                                transmitted via USB (this is used for USB
                                communication only)
 
-               device          name of the device the link is to be attached to
+               device
+                               name of the device the link is to be attached to
 
-               channel         name of the channel the link is to be attached to
+               channel
+                               name of the channel the link is to be attached to
 
-               comp_params     pass parameters needed by some components
+               comp_params
+                               pass parameters needed by some components
 
-               create_link     write '1' to this attribute to trigger the
+               create_link
+                               write '1' to this attribute to trigger the
                                creation of the link. In case of speculative
                                configuration, the creation is post-poned until
                                a physical device is being attached to the bus.
 
-               destroy_link    write '1' to this attribute to destroy an
+               destroy_link
+                               write '1' to this attribute to destroy an
                                active link
 
 What:          /sys/kernel/config/most_sound/<card>
@@ -147,7 +180,8 @@ KernelVersion:  5.2
 Description:
                The attributes:
 
-               create_card     write '1' to this attribute to trigger the
+               create_card
+                               write '1' to this attribute to trigger the
                                 registration of the sound card with the ALSA
                                subsystem.
 
@@ -157,22 +191,28 @@ KernelVersion:  5.2
 Description:
                The attributes:
 
-               buffer_size     configure the buffer size for this channel
+               buffer_size
+                               configure the buffer size for this channel
 
-               subbuffer_size  configure the sub-buffer size for this channel
+               subbuffer_size
+                               configure the sub-buffer size for this channel
                                (needed for synchronous and isochrnous data)
 
 
-               num_buffers     configure number of buffers used for this
+               num_buffers
+                               configure number of buffers used for this
                                channel
 
-               datatype        configure type of data that will travel over
+               datatype
+                               configure type of data that will travel over
                                this channel
 
-               direction       configure whether this link will be an input
+               direction
+                               configure whether this link will be an input
                                or output
 
-               dbr_size        configure DBR data buffer size (this is used
+               dbr_size
+                               configure DBR data buffer size (this is used
                                for MediaLB communication only)
 
                packets_per_xact
@@ -181,16 +221,21 @@ Description:
                                transmitted via USB (this is used for USB
                                communication only)
 
-               device          name of the device the link is to be attached to
+               device
+                               name of the device the link is to be attached to
 
-               channel         name of the channel the link is to be attached to
+               channel
+                               name of the channel the link is to be attached to
 
-               comp_params     pass parameters needed by some components
+               comp_params
+                               pass parameters needed by some components
 
-               create_link     write '1' to this attribute to trigger the
+               create_link
+                               write '1' to this attribute to trigger the
                                creation of the link. In case of speculative
                                configuration, the creation is post-poned until
                                a physical device is being attached to the bus.
 
-               destroy_link    write '1' to this attribute to destroy an
+               destroy_link
+                               write '1' to this attribute to destroy an
                                active link
index 0addf77..272bc1e 100644 (file)
@@ -4,13 +4,17 @@ KernelVersion:        3.11
 Description:
                The attributes:
 
-               ifname          - network device interface name associated with
+               ifname
+                             - network device interface name associated with
                                this function instance
-               qmult           - queue length multiplier for high and
+               qmult   
+                             - queue length multiplier for high and
                                super speed
-               host_addr       - MAC address of host's end of this
+               host_addr
+                             - MAC address of host's end of this
                                Ethernet over USB link
-               dev_addr        - MAC address of device's end of this
+               dev_addr
+                             - MAC address of device's end of this
                                Ethernet over USB link
 
 
index a4c5715..178c3d5 100644 (file)
@@ -4,11 +4,13 @@ KernelVersion:        3.11
 Description:
                The attributes:
 
-               ifname          - network device interface name associated with
+               ==========      =============================================
+               ifname          network device interface name associated with
                                this function instance
-               qmult           queue length multiplier for high and
+               qmult           queue length multiplier for high and
                                super speed
-               host_addr       MAC address of host's end of this
+               host_addr       MAC address of host's end of this
                                Ethernet over USB link
-               dev_addr        MAC address of device's end of this
+               dev_addr        MAC address of device's end of this
                                Ethernet over USB link
+               ==========      =============================================
index 06beefb..e6c6ba5 100644 (file)
@@ -4,5 +4,7 @@ KernelVersion:  3.13
 Description:
                The attributes:
 
-               qlen            - depth of loopback queue
-               buflen          - buffer length
+               =======         =======================
+               qlen            depth of loopback queue
+               buflen          buffer length
+               =======         =======================
index 9931fb0..c86b63a 100644 (file)
@@ -4,12 +4,14 @@ KernelVersion:        3.13
 Description:
                The attributes:
 
-               stall           - Set to permit function to halt bulk endpoints.
+               ===========     ==============================================
+               stall           Set to permit function to halt bulk endpoints.
                                Disabled on some USB devices known not to work
                                correctly. You should set it to true.
-               num_buffers     Number of pipeline buffers. Valid numbers
+               num_buffers     Number of pipeline buffers. Valid numbers
                                are 2..4. Available only if
                                CONFIG_USB_GADGET_DEBUG_FILES is set.
+               ===========     ==============================================
 
 What:          /config/usb-gadget/gadget/functions/mass_storage.name/lun.name
 Date:          Oct 2013
@@ -17,15 +19,17 @@ KernelVersion:      3.13
 Description:
                The attributes:
 
-               file            - The path to the backing file for the LUN.
+               ===========     ==============================================
+               file            The path to the backing file for the LUN.
                                Required if LUN is not marked as removable.
-               ro              Flag specifying access to the LUN shall be
+               ro              Flag specifying access to the LUN shall be
                                read-only. This is implied if CD-ROM emulation
                                is enabled as well as when it was impossible
                                to open "filename" in R/W mode.
-               removable       Flag specifying that LUN shall be indicated as
+               removable       Flag specifying that LUN shall be indicated as
                                being removable.
-               cdrom           Flag specifying that LUN shall be reported as
+               cdrom           Flag specifying that LUN shall be reported as
                                being a CD-ROM.
-               nofua           Flag specifying that FUA flag
+               nofua           Flag specifying that FUA flag
                                in SCSI WRITE(10,12)
+               ===========     ==============================================
index 6b341df..07389cd 100644 (file)
@@ -4,9 +4,11 @@ KernelVersion: 3.19
 Description:
                The attributes:
 
-               index           - index value for the USB MIDI adapter
-               id              - ID string for the USB MIDI adapter
-               buflen          - MIDI buffer length
-               qlen            - USB read request queue length
-               in_ports        - number of MIDI input ports
-               out_ports       - number of MIDI output ports
+               ==========      ====================================
+               index           index value for the USB MIDI adapter
+               id              ID string for the USB MIDI adapter
+               buflen          MIDI buffer length
+               qlen            USB read request queue length
+               in_ports        number of MIDI input ports
+               out_ports       number of MIDI output ports
+               ==========      ====================================
index 6b0714e..7aa731b 100644 (file)
@@ -4,6 +4,8 @@ KernelVersion:  4.1
 Description:
                The attributes:
 
-               pnp_string      - Data to be passed to the host in pnp string
-               q_len           - Number of requests per endpoint
+               ==========      ===========================================
+               pnp_string      Data to be passed to the host in pnp string
+               q_len           Number of requests per endpoint
+               ==========      ===========================================
 
index f56335a..1f3d31b 100644 (file)
@@ -4,11 +4,13 @@ KernelVersion:        3.13
 Description:
                The attributes:
 
-               pattern         - 0 (all zeros), 1 (mod63), 2 (none)
-               isoc_interval   - 1..16
-               isoc_maxpacket  - 0 - 1023 (fs), 0 - 1024 (hs/ss)
-               isoc_mult       - 0..2 (hs/ss only)
-               isoc_maxburst   - 0..15 (ss only)
-               buflen          - buffer length
-               bulk_qlen       - depth of queue for bulk
-               iso_qlen        - depth of queue for iso
+               ==============    ==================================
+               pattern           0 (all zeros), 1 (mod63), 2 (none)
+               isoc_interval     1..16
+               isoc_maxpacket    0 - 1023 (fs), 0 - 1024 (hs/ss)
+               isoc_mult         0..2 (hs/ss only)
+               isoc_maxburst     0..15 (ss only)
+               buflen            buffer length
+               bulk_qlen         depth of queue for bulk
+               iso_qlen          depth of queue for iso
+               ==============    ==================================
index 9373e2c..0061b86 100644 (file)
@@ -4,11 +4,13 @@ KernelVersion:        3.11
 Description:
                The attributes:
 
-               ifname          - network device interface name associated with
+               ==========      =============================================
+               ifname          network device interface name associated with
                                this function instance
-               qmult           queue length multiplier for high and
+               qmult           queue length multiplier for high and
                                super speed
-               host_addr       MAC address of host's end of this
+               host_addr       MAC address of host's end of this
                                Ethernet over USB link
-               dev_addr        MAC address of device's end of this
+               dev_addr        MAC address of device's end of this
                                Ethernet over USB link
+               ==========      =============================================
index 2bfdd4e..d4356c8 100644 (file)
@@ -4,9 +4,11 @@ KernelVersion: 3.18
 Description:
                The attributes:
 
-               c_chmask - capture channel mask
-               c_srate - capture sampling rate
-               c_ssize - capture sample size (bytes)
-               p_chmask - playback channel mask
-               p_srate - playback sampling rate
-               p_ssize - playback sample size (bytes)
+               =========  ============================
+               c_chmask   capture channel mask
+               c_srate    capture sampling rate
+               c_ssize    capture sample size (bytes)
+               p_chmask   playback channel mask
+               p_srate    playback sampling rate
+               p_ssize    playback sample size (bytes)
+               =========  ============================
index cee81b0..ac5e11a 100644 (file)
@@ -55,7 +55,7 @@ Description:  Default output terminal descriptors
 
                ==============  =============================================
                iTerminal       index of string descriptor
-               bSourceID       id of the terminal to which this terminal
+               bSourceID       id of the terminal to which this terminal
                                is connected
                bAssocTerminal  id of the input terminal to which this output
                                terminal is associated
index 5afcd78..8debcb0 100644 (file)
@@ -23,7 +23,7 @@ error injections without having to know the details of the driver-specific
 commands.
 
 Note that the output of 'error-inj' shall be valid as input to 'error-inj'.
-So this must work:
+So this must work::
 
        $ cat error-inj >einj.txt
        $ cat einj.txt >error-inj
index 2e9ae31..c5d678d 100644 (file)
@@ -20,9 +20,13 @@ Description:    Allow the root user to disable/enable in runtime the clock
                 The user can supply a bitmask value, each bit represents
                 a different engine to disable/enable its clock gating feature.
                 The bitmask is composed of 20 bits:
-                0  -  7 : DMA channels
-                8  - 11 : MME engines
-                12 - 19 : TPC engines
+
+               =======   ============
+                0  -  7   DMA channels
+                8  - 11   MME engines
+                12 - 19   TPC engines
+               =======   ============
+
                 The bit's location of a specific engine can be determined
                 using (1 << GAUDI_ENGINE_ID_*). GAUDI_ENGINE_ID_* values
                 are defined in uapi habanalabs.h file in enum gaudi_engine_id
@@ -59,6 +63,7 @@ Description:    Allows the root user to read or write directly through the
                 the generic Linux user-space PCI mapping) because the DDR bar
                 is very small compared to the DDR memory and only the driver can
                 move the bar before and after the transaction.
+
                 If the IOMMU is disabled, it also allows the root user to read
                 or write from the host a device VA of a host mapped memory
 
@@ -73,6 +78,7 @@ Description:    Allows the root user to read or write 64 bit data directly
                 the generic Linux user-space PCI mapping) because the DDR bar
                 is very small compared to the DDR memory and only the driver can
                 move the bar before and after the transaction.
+
                 If the IOMMU is disabled, it also allows the root user to read
                 or write from the host a device VA of a host mapped memory
 
index 685d5a4..f75a655 100644 (file)
@@ -4,42 +4,42 @@ KernelVersion:        3.4
 Contact:       Kent Yoder <key@linux.vnet.ibm.com>
 Description:
 
-  These debugfs interfaces are built by the nx-crypto driver, built in
+These debugfs interfaces are built by the nx-crypto driver, built in
 arch/powerpc/crypto/nx.
 
 Error Detection
 ===============
 
 errors:
-- A u32 providing a total count of errors since the driver was loaded. The
-only errors counted here are those returned from the hcall, H_COP_OP.
+  A u32 providing a total count of errors since the driver was loaded. The
+  only errors counted here are those returned from the hcall, H_COP_OP.
 
 last_error:
-- The most recent non-zero return code from the H_COP_OP hcall. -EBUSY is not
-recorded here (the hcall will retry until -EBUSY goes away).
+  The most recent non-zero return code from the H_COP_OP hcall. -EBUSY is not
+  recorded here (the hcall will retry until -EBUSY goes away).
 
 last_error_pid:
-- The process ID of the process who received the most recent error from the
-hcall.
+  The process ID of the process who received the most recent error from the
+  hcall.
 
 Device Use
 ==========
 
 aes_bytes:
-- The total number of bytes encrypted using AES in any of the driver's
-supported modes.
+  The total number of bytes encrypted using AES in any of the driver's
+  supported modes.
 
 aes_ops:
-- The total number of AES operations submitted to the hardware.
+  The total number of AES operations submitted to the hardware.
 
 sha256_bytes:
-- The total number of bytes hashed by the hardware using SHA-256.
+  The total number of bytes hashed by the hardware using SHA-256.
 
 sha256_ops:
-- The total number of SHA-256 operations submitted to the hardware.
+  The total number of SHA-256 operations submitted to the hardware.
 
 sha512_bytes:
-- The total number of bytes hashed by the hardware using SHA-512.
+  The total number of bytes hashed by the hardware using SHA-512.
 
 sha512_ops:
-- The total number of SHA-512 operations submitted to the hardware.
+  The total number of SHA-512 operations submitted to the hardware.
index 787907d..f6f65a4 100644 (file)
@@ -10,7 +10,7 @@ these files in debugfs:
 /sys/kernel/debug/pktcdvd/pktcdvd[0-7]/
 
     ====            ====== ====================================
-    info            (0444) Lots of driver statistics and infos.
+    info            0444   Lots of driver statistics and infos.
     ====            ====== ====================================
 
 Example::
index c8f7dad..ad08f53 100644 (file)
@@ -2,10 +2,12 @@ What:         /sys/kernel/debug/turris-mox-rwtm/do_sign
 Date:          Jun 2020
 KernelVersion: 5.8
 Contact:       Marek Behún <marek.behun@nic.cz>
-Description:   (W)
-                   Message to sign with the ECDSA private key stored in
+Description:
+
+               === ===========================================================
+               (W) Message to sign with the ECDSA private key stored in
                    device's OTP. The message must be exactly 64 bytes (since
                    this is intended for SHA-512 hashes).
-               (R)
-                   The resulting signature, 136 bytes. This contains the R and
+               (R) The resulting signature, 136 bytes. This contains the R and
                    S values of the ECDSA signature, both in big-endian format.
+               === ===========================================================
index 9d8d9d2..682e3c0 100644 (file)
@@ -27,16 +27,17 @@ Description:
                for writing, two for the type and at least a single byte of
                data.
 
-               Example:
-               // Request EC info type 3 (EC firmware build date)
-               // Corresponds with sending type 0x00f0 with
-               // MBOX = [38, 00, 03, 00]
-               $ echo 00 f0 38 00 03 00 > /sys/kernel/debug/wilco_ec/raw
-               // View the result. The decoded ASCII result "12/21/18" is
-               // included after the raw hex.
-               // Corresponds with MBOX = [00, 00, 31, 32, 2f, 32, 31, 38, ...]
-               $ cat /sys/kernel/debug/wilco_ec/raw
-               00 00 31 32 2f 32 31 2f 31 38 00 38 00 01 00 2f 00  ..12/21/18.8...
+               Example::
+
+                   // Request EC info type 3 (EC firmware build date)
+                   // Corresponds with sending type 0x00f0 with
+                   // MBOX = [38, 00, 03, 00]
+                   $ echo 00 f0 38 00 03 00 > /sys/kernel/debug/wilco_ec/raw
+                   // View the result. The decoded ASCII result "12/21/18" is
+                   // included after the raw hex.
+                   // Corresponds with MBOX = [00, 00, 31, 32, 2f, 32, 31, 38, ...]
+                   $ cat /sys/kernel/debug/wilco_ec/raw
+                   00 00 31 32 2f 32 31 2f 31 38 00 38 00 01 00 2f 00  ..12/21/18.8...
 
                Note that the first 16 bytes of the received MBOX[] will be
                printed, even if some of the data is junk, and skipping bytes
index fc919ce..5f3a0dc 100644 (file)
@@ -10,29 +10,29 @@ Description:
                <uapi/linux/wmi.h>
 
                1) To perform an SMBIOS call from userspace, you'll need to
-               first determine the minimum size of the calling interface
-               buffer for your machine.
-               Platforms that contain larger buffers can return larger
-               objects from the system firmware.
-               Commonly this size is either 4k or 32k.
+                  first determine the minimum size of the calling interface
+                  buffer for your machine.
+                  Platforms that contain larger buffers can return larger
+                  objects from the system firmware.
+                  Commonly this size is either 4k or 32k.
 
-               To determine the size of the buffer read() a u64 dword from
-               the WMI character device /dev/wmi/dell-smbios.
+                  To determine the size of the buffer read() a u64 dword from
+                  the WMI character device /dev/wmi/dell-smbios.
 
                2) After you've determined the minimum size of the calling
-               interface buffer, you can allocate a structure that represents
-               the structure documented above.
+                  interface buffer, you can allocate a structure that represents
+                  the structure documented above.
 
                3) In the 'length' object store the size of the buffer you
-               determined above and allocated.
+                  determined above and allocated.
 
                4) In this buffer object, prepare as necessary for the SMBIOS
-               call you're interested in.  Typically SMBIOS buffers have
-               "class", "select", and "input" defined to values that coincide
-               with the data you are interested in.
-               Documenting class/select/input values is outside of the scope
-               of this documentation. Check with the libsmbios project for
-               further documentation on these values.
+                  call you're interested in.  Typically SMBIOS buffers have
+                  "class", "select", and "input" defined to values that coincide
+                  with the data you are interested in.
+                  Documenting class/select/input values is outside of the scope
+                  of this documentation. Check with the libsmbios project for
+                  further documentation on these values.
 
                6) Run the call by using ioctl() as described in the header.
 
index 7b265fb..66bdcd1 100644 (file)
@@ -12,15 +12,16 @@ Description:
                The following file operations are supported:
 
                open(2)
-               Currently the only useful flags are O_RDWR.
+                 Currently the only useful flags are O_RDWR.
 
                ioctl(2)
-               Initiate various actions.
-               See the inline documentation in [include/uapi]<linux/gpio.h>
-               for descriptions of all ioctls.
+                 Initiate various actions.
+
+                 See the inline documentation in [include/uapi]<linux/gpio.h>
+                 for descriptions of all ioctls.
 
                close(2)
-               Stops and free up the I/O contexts that was associated
-               with the file descriptor.
+                 Stops and free up the I/O contexts that was associated
+                 with the file descriptor.
 
 Users:         TBD
index df5a3a8..e58d641 100644 (file)
@@ -35,7 +35,9 @@ Description:
 
                Kernel 5.5+ appends two more fields for flush requests:
 
-               19 - flush requests completed successfully
-               20 - time spent flushing
+               ==  =====================================
+               19  flush requests completed successfully
+               20  time spent flushing
+               ==  =====================================
 
                For more details refer to Documentation/admin-guide/iostats.rst
index 0469781..a4e31c4 100644 (file)
@@ -14,28 +14,28 @@ Description:
                For more details, see Documentation/filesystems/proc.rst
                and the procfs man page.
 
-               Typical output looks like this:
+               Typical output looks like this::
 
-               00100000-ff709000 ---p 00000000 00:00 0          [rollup]
-               Size:               1192 kB
-               KernelPageSize:        4 kB
-               MMUPageSize:           4 kB
-               Rss:                 884 kB
-               Pss:                 385 kB
-               Pss_Anon:            301 kB
-               Pss_File:             80 kB
-               Pss_Shmem:             4 kB
-               Shared_Clean:        696 kB
-               Shared_Dirty:          0 kB
-               Private_Clean:       120 kB
-               Private_Dirty:        68 kB
-               Referenced:          884 kB
-               Anonymous:            68 kB
-               LazyFree:              0 kB
-               AnonHugePages:         0 kB
-               ShmemPmdMapped:        0 kB
-               Shared_Hugetlb:        0 kB
-               Private_Hugetlb:       0 kB
-               Swap:                  0 kB
-               SwapPss:               0 kB
-               Locked:              385 kB
+                       00100000-ff709000 ---p 00000000 00:00 0          [rollup]
+                       Size:               1192 kB
+                       KernelPageSize:        4 kB
+                       MMUPageSize:           4 kB
+                       Rss:                 884 kB
+                       Pss:                 385 kB
+                       Pss_Anon:            301 kB
+                       Pss_File:             80 kB
+                       Pss_Shmem:             4 kB
+                       Shared_Clean:        696 kB
+                       Shared_Dirty:          0 kB
+                       Private_Clean:       120 kB
+                       Private_Dirty:        68 kB
+                       Referenced:          884 kB
+                       Anonymous:            68 kB
+                       LazyFree:              0 kB
+                       AnonHugePages:         0 kB
+                       ShmemPmdMapped:        0 kB
+                       Shared_Hugetlb:        0 kB
+                       Private_Hugetlb:       0 kB
+                       Swap:                  0 kB
+                       SwapPss:               0 kB
+                       Locked:              385 kB
index d45209a..5b02540 100644 (file)
@@ -9,25 +9,25 @@ Description:  Generic interface to platform dependent persistent storage.
                provide a generic interface to show records captured in
                the dying moments.  In the case of a panic the last part
                of the console log is captured, but other interesting
-               data can also be saved.
+               data can also be saved::
 
-               # mount -t pstore -o kmsg_bytes=8000 - /sys/fs/pstore
+                   # mount -t pstore -o kmsg_bytes=8000 - /sys/fs/pstore
 
-               $ ls -l /sys/fs/pstore/
-               total 0
-               -r--r--r-- 1 root root 7896 Nov 30 15:38 dmesg-erst-1
+                   $ ls -l /sys/fs/pstore/
+                   total 0
+                   -r--r--r-- 1 root root 7896 Nov 30 15:38 dmesg-erst-1
 
                Different users of this interface will result in different
                filename prefixes.  Currently two are defined:
 
-               "dmesg" - saved console log
-               "mce"   - architecture dependent data from fatal h/w error
+               "dmesg" - saved console log
+               "mce"   - architecture dependent data from fatal h/w error
 
                Once the information in a file has been read, removing
                the file will signal to the underlying persistent storage
-               device that it can reclaim the space for later re-use.
+               device that it can reclaim the space for later re-use::
 
-               $ rm /sys/fs/pstore/dmesg-erst-1
+                   $ rm /sys/fs/pstore/dmesg-erst-1
 
                The expectation is that all files in /sys/fs/pstore/
                will be saved elsewhere and erased from persistent store
@@ -44,4 +44,3 @@ Description:  Generic interface to platform dependent persistent storage.
                backends are available, the preferred backend may be
                set by passing the pstore.backend= argument to the kernel at
                boot time.
-
index 8f070b4..14a6fe9 100644 (file)
@@ -9,9 +9,9 @@ Description:    To unmap a volume, "normal" or "force" has to be written to:
                is using the device.  When "force" is used, the device is also unmapped
                when device is in use.  All I/Os that are in progress will fail.
 
-               Example:
+               Example::
 
-               # echo "normal" > /sys/block/rnbd0/rnbd/unmap_device
+                 # echo "normal" > /sys/block/rnbd0/rnbd/unmap_device
 
 What:          /sys/block/rnbd<N>/rnbd/state
 Date:          Feb 2020
index c786034..58abacf 100644 (file)
@@ -5,6 +5,7 @@ Description:
                This attribute indicates the full path of ACPI namespace
                object associated with the device object.  For example,
                \_SB_.PCI0.
+
                This file is not present for device objects representing
                fixed ACPI hardware features (like power and sleep
                buttons).
index b5f5260..3e92cbd 100644 (file)
@@ -4,7 +4,10 @@ KernelVersion: 3.19
 Contact:       Mathieu Poirier <mathieu.poirier@linaro.org>
 Description:   (RW) Add/remove a sink from a trace path.  There can be multiple
                source for a single sink.
-               ex: echo 1 > /sys/bus/coresight/devices/20010000.etb/enable_sink
+
+               ex::
+
+                 echo 1 > /sys/bus/coresight/devices/20010000.etb/enable_sink
 
 What:          /sys/bus/coresight/devices/<memory_map>.etb/trigger_cntr
 Date:          November 2014
index 966f850..12a733f 100644 (file)
@@ -20,6 +20,7 @@ Contact:      Cornelia Huck <cornelia.huck@de.ibm.com>
 Description:   Contains the ids of the channel paths used by this
                subchannel, as reported by the channel subsystem
                during subchannel recognition.
+
                Note: This is an I/O-subchannel specific attribute.
 Users:         s390-tools, HAL
 
@@ -31,6 +32,7 @@ Description:  Contains the PIM/PAM/POM values, as reported by the
                channel subsystem when last queried by the common I/O
                layer (this implies that this attribute is not necessarily
                in sync with the values current in the channel subsystem).
+
                Note: This is an I/O-subchannel specific attribute.
 Users:         s390-tools, HAL
 
@@ -53,6 +55,7 @@ Description:  This file allows the driver for a device to be specified. When
                opt-out of driver binding using a driver_override name such as
                "none".  Only a single driver may be specified in the override,
                there is no support for parsing delimiters.
+
                Note that unlike the mechanism of the same name for pci, this
                file does not allow to override basic matching rules. I.e.,
                the driver must still match the subchannel type of the device.
index 23543be..b0265ab 100644 (file)
@@ -4,6 +4,7 @@ KernelVersion:  5.10
 Contact:       Xu Yilun <yilun.xu@intel.com>
 Description:   Read-only. It returns type of DFL FIU of the device. Now DFL
                supports 2 FIU types, 0 for FME, 1 for PORT.
+
                Format: 0x%x
 
 What:          /sys/bus/dfl/devices/dfl_dev.X/feature_id
@@ -12,4 +13,5 @@ KernelVersion:        5.10
 Contact:       Xu Yilun <yilun.xu@intel.com>
 Description:   Read-only. It returns feature identifier local to its DFL FIU
                type.
+
                Format: 0x%x
index 2273627..de390a0 100644 (file)
@@ -7,7 +7,7 @@ Description:    Read-only. Attribute group to describe the magic bits
 
                 Each attribute under this group defines a bit range of the
                 perf_event_attr.config. All supported attributes are listed
-                below.
+                below::
 
                                chip = "config:16-31"
                                core  = "config:16-31"
@@ -16,9 +16,9 @@ Description:    Read-only. Attribute group to describe the magic bits
                                offset = "config:32-63"
                                vcpu = "config:16-31"
 
-               For example,
+                For example::
 
-               PM_PB_CYC =  "domain=1,offset=0x80,chip=?,lpar=0x0"
+                 PM_PB_CYC =  "domain=1,offset=0x80,chip=?,lpar=0x0"
 
                In this event, '?' after chip specifies that
                this value will be provided by user while running this event.
index 6a023b4..12e2bf9 100644 (file)
@@ -7,7 +7,7 @@ Description:    Read-only. Attribute group to describe the magic bits
 
                 Each attribute under this group defines a bit range of the
                 perf_event_attr.config. All supported attributes are listed
-                below.
+                below::
 
                                counter_info_version  = "config:16-23"
                                length  = "config:24-31"
@@ -20,9 +20,9 @@ Description:    Read-only. Attribute group to describe the magic bits
                                secondary_index = "config:0-15"
                                starting_index = "config:32-63"
 
-               For example,
+                For example::
 
-               processor_core_utilization_instructions_completed = "request=0x94,
+                 processor_core_utilization_instructions_completed = "request=0x94,
                                        phys_processor_idx=?,counter_info_version=0x8,
                                        length=8,offset=0x18"
 
@@ -36,6 +36,7 @@ Description:
                '0' if the hypervisor is configured to forbid access to event
                counters being accumulated by other guests and to physical
                domain event counters.
+
                '1' if that access is allowed.
 
 What:          /sys/bus/event_source/devices/hv_gpci/interface/ga
index 657df13..8fe787c 100644 (file)
@@ -3,16 +3,19 @@ Date:         August 2012
 KernelVersion: TBD
 Contact:       Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
 Description:   The FCoE bus. Attributes in this directory are control interfaces.
+
 Attributes:
 
-       ctlr_create: 'FCoE Controller' instance creation interface. Writing an
+       ctlr_create:
+                    'FCoE Controller' instance creation interface. Writing an
                     <ifname> to this file will allocate and populate sysfs with a
                     fcoe_ctlr_device (ctlr_X). The user can then configure any
                     per-port settings and finally write to the fcoe_ctlr_device's
                     'start' attribute to begin the kernel's discovery and login
                     process.
 
-       ctlr_destroy: 'FCoE Controller' instance removal interface. Writing a
+       ctlr_destroy:
+                      'FCoE Controller' instance removal interface. Writing a
                       fcoe_ctlr_device's sysfs name to this file will log the
                       fcoe_ctlr_device out of the fabric or otherwise connected
                       FCoE devices. It will also free all kernel memory allocated
@@ -32,11 +35,13 @@ Description:        'FCoE Controller' instances on the fcoe bus.
 
 Attributes:
 
-       fcf_dev_loss_tmo: Device loss timeout period (see below). Changing
+       fcf_dev_loss_tmo:
+                         Device loss timeout period (see below). Changing
                          this value will change the dev_loss_tmo for all
                          FCFs discovered by this controller.
 
-       mode:             Display or change the FCoE Controller's mode. Possible
+       mode:
+                         Display or change the FCoE Controller's mode. Possible
                          modes are 'Fabric' and 'VN2VN'. If a FCoE Controller
                          is started in 'Fabric' mode then FIP FCF discovery is
                          initiated and ultimately a fabric login is attempted.
@@ -44,23 +49,30 @@ Attributes:
                          FIP VN2VN discovery and login is performed. A FCoE
                          Controller only supports one mode at a time.
 
-       enabled:          Whether an FCoE controller is enabled or disabled.
+       enabled:
+                         Whether an FCoE controller is enabled or disabled.
                          0 if disabled, 1 if enabled. Writing either 0 or 1
                          to this file will enable or disable the FCoE controller.
 
-       lesb/link_fail:   Link Error Status Block (LESB) link failure count.
+       lesb/link_fail:
+                         Link Error Status Block (LESB) link failure count.
 
-       lesb/vlink_fail:  Link Error Status Block (LESB) virtual link
+       lesb/vlink_fail:
+                         Link Error Status Block (LESB) virtual link
                          failure count.
 
-       lesb/miss_fka:    Link Error Status Block (LESB) missed FCoE
+       lesb/miss_fka:
+                         Link Error Status Block (LESB) missed FCoE
                          Initialization Protocol (FIP) Keep-Alives (FKA).
 
-       lesb/symb_err:    Link Error Status Block (LESB) symbolic error count.
+       lesb/symb_err:
+                         Link Error Status Block (LESB) symbolic error count.
 
-       lesb/err_block:   Link Error Status Block (LESB) block error count.
+       lesb/err_block:
+                         Link Error Status Block (LESB) block error count.
 
-       lesb/fcs_error:   Link Error Status Block (LESB) Fibre Channel
+       lesb/fcs_error:
+                         Link Error Status Block (LESB) Fibre Channel
                          Services error count.
 
 Notes: ctlr_X (global increment starting at 0)
@@ -75,31 +87,41 @@ Description:        'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel
                Fibre Channel frames into a FC fabric. It can also take
                outbound FC frames and pack them in Ethernet packets to
                be sent to their destination on the Ethernet segment.
+
 Attributes:
 
-       fabric_name: Identifies the fabric that the FCF services.
+       fabric_name:
+                    Identifies the fabric that the FCF services.
 
-       switch_name: Identifies the FCF.
+       switch_name:
+                    Identifies the FCF.
 
-       priority:    The switch's priority amongst other FCFs on the same
+       priority:
+                    The switch's priority amongst other FCFs on the same
                     fabric.
 
-       selected:    1 indicates that the switch has been selected for use;
+       selected:
+                    1 indicates that the switch has been selected for use;
                     0 indicates that the switch will not be used.
 
-       fc_map:      The Fibre Channel MAP
+       fc_map:
+                    The Fibre Channel MAP
 
-       vfid:        The Virtual Fabric ID
+       vfid:
+                    The Virtual Fabric ID
 
-       mac:         The FCF's MAC address
+       mac:
+                    The FCF's MAC address
 
-       fka_period:  The FIP Keep-Alive period
+       fka_period:
+                    The FIP Keep-Alive period
 
        fabric_state: The internal kernel state
-                     "Unknown" - Initialization value
-                     "Disconnected" - No link to the FCF/fabric
-                     "Connected" - Host is connected to the FCF
-                     "Deleted" - FCF is being removed from the system
+
+                     - "Unknown" - Initialization value
+                     - "Disconnected" - No link to the FCF/fabric
+                     - "Connected" - Host is connected to the FCF
+                     - "Deleted" - FCF is being removed from the system
 
        dev_loss_tmo: The device loss timeout period for this FCF.
 
index 80256b8..bf3c6af 100644 (file)
@@ -6,8 +6,10 @@ Description:
                the driver to attempt to bind to the device found at
                this location. The format for the location is Object.Id
                and is the same as found in /sys/bus/fsl-mc/devices/.
-                For example:
-               # echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/bind
+
+                For example::
+
+                 # echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/bind
 
 What:          /sys/bus/fsl-mc/drivers/.../unbind
 Date:          December 2016
@@ -17,5 +19,7 @@ Description:
                driver to attempt to unbind from the device found at
                this location. The format for the location is Object.Id
                and is the same as found in /sys/bus/fsl-mc/devices/.
-                For example:
-               # echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/unbind
+
+                For example::
+
+                 # echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/unbind
index 9de269b..42dfc93 100644 (file)
@@ -3,19 +3,25 @@ Date:         February 2011
 Contact:       Minkyu Kang <mk7.kang@samsung.com>
 Description:
                show what device is attached
-               NONE - no device
-               USB - USB device is attached
-               UART - UART is attached
-               CHARGER - Charger is attaced
-               JIG - JIG is attached
+
+               =======  ======================
+               NONE     no device
+               USB      USB device is attached
+               UART     UART is attached
+               CHARGER  Charger is attaced
+               JIG      JIG is attached
+               =======  ======================
 
 What:          /sys/bus/i2c/devices/.../switch
 Date:          February 2011
 Contact:       Minkyu Kang <mk7.kang@samsung.com>
 Description:
                show or set the state of manual switch
-               VAUDIO - switch to VAUDIO path
-               UART - switch to UART path
-               AUDIO - switch to AUDIO path
-               DHOST - switch to DHOST path
-               AUTO - switch automatically by device
+
+               =======  ==============================
+               VAUDIO   switch to VAUDIO path
+               UART     switch to UART path
+               AUDIO    switch to AUDIO path
+               DHOST    switch to DHOST path
+               AUTO     switch automatically by device
+               =======  ==============================
index 2f332ec..1f4a266 100644 (file)
@@ -84,6 +84,7 @@ Description:
                by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
                See the I3C specification for more details about these HDR
                modes.
+
                This entry describes the HDRCAP of the master controller
                driving the bus.
 
@@ -135,6 +136,7 @@ Description:
                Expose the HDR (High Data Rate) capabilities of a device.
                Returns a list of supported HDR mode, each element is separated
                by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
+
                See the I3C specification for more details about these HDR
                modes.
 
index e3df719..df42bed 100644 (file)
@@ -15,6 +15,7 @@ Description:
                based on hardware generated events (e.g. data ready) or
                provided by a separate driver for other hardware (e.g.
                periodic timer, GPIO or high resolution timer).
+
                Contains trigger type specific elements. These do not
                generalize well and hence are not documented in this file.
                X is the IIO index of the trigger.
@@ -666,6 +667,7 @@ Description:
                <type>[Y][_name]_<raw|input>_thresh_falling_value may take
                different values, but the device can only enable both thresholds
                or neither.
+
                Note the driver will assume the last p events requested are
                to be enabled where p is how many it supports (which may vary
                depending on the exact set requested. So if you want to be
@@ -720,6 +722,7 @@ Description:
                <type>[Y][_name]_<raw|input>_roc_falling_value may take
                different values, but the device can only enable both rate of
                change thresholds or neither.
+
                Note the driver will assume the last p events requested are
                to be enabled where p is however many it supports (which may
                vary depending on the exact set requested. So if you want to be
@@ -775,9 +778,11 @@ Description:
                Specifies the value of threshold that the device is comparing
                against for the events enabled by
                <type>Y[_name]_thresh[_rising|falling]_en.
+
                If separate attributes exist for the two directions, but
                direction is not specified for this attribute, then a single
                threshold value applies to both directions.
+
                The raw or input element of the name indicates whether the
                value is in raw device units or in processed units (as _raw
                and _input do on sysfs direct channel read attributes).
@@ -860,6 +865,7 @@ Description:
                If separate attributes exist for the two directions, but
                direction is not specified for this attribute, then a single
                hysteresis value applies to both directions.
+
                For falling events the hysteresis is added to the _value attribute for
                this event to get the upper threshold for when the event goes back to
                normal, for rising events the hysteresis is subtracted from the _value
@@ -906,6 +912,7 @@ Description:
                Specifies the value of rate of change threshold that the
                device is comparing against for the events enabled by
                <type>[Y][_name]_roc[_rising|falling]_en.
+
                If separate attributes exist for the two directions,
                but direction is not specified for this attribute,
                then a single threshold value applies to both directions.
@@ -1305,6 +1312,7 @@ Description:
                Proximity measurement indicating that some
                object is near the sensor, usually by observing
                reflectivity of infrared or ultrasound emitted.
+
                Often these sensors are unit less and as such conversion
                to SI units is not possible. Higher proximity measurements
                indicate closer objects, and vice versa. Units after
@@ -1450,9 +1458,12 @@ Contact: linux-iio@vger.kernel.org
 Description:
                A single positive integer specifying the maximum number of scan
                elements to wait for.
+
                Poll will block until the watermark is reached.
+
                Blocking read will wait until the minimum between the requested
                read amount or the low water mark is available.
+
                Non-blocking read will retrieve the available samples from the
                buffer even if there are less samples then watermark level. This
                allows the application to block on poll with a timeout and read
@@ -1481,11 +1492,13 @@ Description:
                device settings allows it (e.g. if a trigger is set that samples
                data differently that the hardware fifo does then hardware fifo
                will not enabled).
+
                If the hardware fifo is enabled and the level of the hardware
                fifo reaches the hardware fifo watermark level the device will
                flush its hardware fifo to the device buffer. Doing a non
                blocking read on the device when no samples are present in the
                device buffer will also force a flush.
+
                When the hardware fifo is enabled there is no need to use a
                trigger to use buffer mode since the watermark settings
                guarantees that the hardware fifo is flushed to the device
@@ -1523,6 +1536,7 @@ Description:
                A single positive integer specifying the minimum watermark level
                for the hardware fifo of this device. If the device does not
                have a hardware fifo this entry is not present.
+
                If the user sets buffer/watermark to a value less than this one,
                then the hardware watermark will remain unset.
 
@@ -1533,6 +1547,7 @@ Description:
                A single positive integer specifying the maximum watermark level
                for the hardware fifo of this device. If the device does not
                have a hardware fifo this entry is not present.
+
                If the user sets buffer/watermark to a value greater than this
                one, then the hardware watermark will be capped at this value.
 
@@ -1544,6 +1559,7 @@ Description:
                levels for the hardware fifo. This entry is optional and if it
                is not present it means that all the values between
                hwfifo_watermark_min and hwfifo_watermark_max are supported.
+
                If the user sets buffer/watermark to a value greater than
                hwfifo_watermak_min but not equal to any of the values in this
                list, the driver will chose an appropriate value for the
@@ -1605,7 +1621,8 @@ KernelVersion:    4.1.0
 Contact:       linux-iio@vger.kernel.org
 Description:
                '1' (enable) or '0' (disable) specifying the enable
-               of heater function. Same reading values apply
+               of heater function. Same reading values apply.
+
                This ABI is especially applicable for humidity sensors
                to heatup the device and get rid of any condensation
                in some humidity environment
index f30b4c4..4b01150 100644 (file)
@@ -19,9 +19,11 @@ Description:
                is separately set for "GND-Open" and "Supply-Open" modes.
                Channels 0..31 have common low threshold values, but could have different
                sensing_modes.
+
                The low voltage threshold range is between 2..21V.
                Hysteresis between low and high thresholds can not be lower then 2 and
                can not be odd.
+
                If falling threshold results hysteresis to odd value then rising
                threshold is automatically subtracted by one.
 
@@ -34,10 +36,13 @@ Description:
                this value then the threshold rising event is pushed.
                Depending on in_voltageY_sensing_mode the high voltage threshold
                is separately set for "GND-Open" and "Supply-Open" modes.
+
                Channels 0..31 have common high threshold values, but could have different
                sensing_modes.
+
                The high voltage threshold range is between 3..22V.
                Hysteresis between low and high thresholds can not be lower then 2 and
                can not be odd.
+
                If rising threshold results hysteresis to odd value then falling
                threshold is automatically appended by one.
index efe4c85..1975c7a 100644 (file)
@@ -5,10 +5,13 @@ Description:
                The STM32 ADC can be configured to use external trigger sources
                (e.g. timers, pwm or exti gpio). Then, it can be tuned to start
                conversions on external trigger by either:
+
                - "rising-edge"
                - "falling-edge"
                - "both-edges".
+
                Reading returns current trigger polarity.
+
                Writing value before enabling conversions sets trigger polarity.
 
 What:          /sys/bus/iio/devices/triggerX/trigger_polarity_available
index a133fd8..40df5c9 100644 (file)
@@ -15,8 +15,11 @@ Description:
                first object echoed in meters. Default value is 6.020.
                This setting limits the time the driver is waiting for a
                echo.
+
                Showing the range of available values is represented as the
                minimum value, the step and the maximum value, all enclosed
                in square brackets.
-               Example:
-               [0.043 0.043 11.008]
+
+               Example::
+
+                       [0.043 0.043 11.008]
index a91aeab..d065cda 100644 (file)
@@ -8,7 +8,9 @@ KernelVersion:  3.4.0
 Contact:       linux-iio@vger.kernel.org
 Description:
                Reading returns either '1' or '0'.
+
                '1' means that the clock in question is present.
+
                '0' means that the clock is missing.
 
 What:          /sys/bus/iio/devices/iio:deviceX/pllY_locked
index 302de64..544548e 100644 (file)
@@ -27,12 +27,12 @@ What:               /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_name
 KernelVersion:
 Contact:       linux-iio@vger.kernel.org
 Description:
-               Reading returns the datasheet name for channel Y:
+               Reading returns the datasheet name for channel Y::
 
-               out_altvoltage0_name: RF8x
-               out_altvoltage1_name: RFAUX8x
-               out_altvoltage2_name: RF16x
-               out_altvoltage3_name: RF32x
+                 out_altvoltage0_name: RF8x
+                 out_altvoltage1_name: RFAUX8x
+                 out_altvoltage2_name: RF16x
+                 out_altvoltage3_name: RF32x
 
 What:          /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown
 KernelVersion:
index 6adba90..66b621f 100644 (file)
@@ -6,10 +6,14 @@ Description:
                Get measured values from the ADC for these stages. Y is the
                specific stage number corresponding to datasheet stage names
                as follows:
-               1 -> LED2
-               2 -> ALED2/LED3
-               3 -> LED1
-               4 -> ALED1/LED4
+
+               == ==========
+               1  LED2
+               2  ALED2/LED3
+               3  LED1
+               4  ALED1/LED4
+               == ==========
+
                Note that channels 5 and 6 represent LED2-ALED2 and LED1-ALED1
                respectively which simply helper channels containing the
                calculated difference in the value of stage 1 - 2 and 3 - 4.
index f0ce0a0..220206a 100644 (file)
@@ -15,5 +15,7 @@ Description:
                Scheme 0 has wider dynamic range, Scheme 1 proximity detection
                is less affected by the ambient IR noise variation.
 
-               0 Sensing IR from LED and ambient
-               1 Sensing IR from LED with ambient IR rejection
+               == =============================================
+               0  Sensing IR from LED and ambient
+               1  Sensing IR from LED with ambient IR rejection
+               == =============================================
index 22d0843..b7b2278 100644 (file)
@@ -10,10 +10,13 @@ Date:               June 2015
 KernelVersion: 4.3
 Contact:       Alexander Shishkin <alexander.shishkin@linux.intel.com>
 Description:   (RO) Output port type:
-                 0: not present,
-                 1: MSU (Memory Storage Unit)
-                 2: CTP (Common Trace Port)
-                 4: PTI (MIPI PTI).
+
+                ==  =========================
+                 0  not present,
+                 1  MSU (Memory Storage Unit)
+                 2  CTP (Common Trace Port)
+                 4  PTI (MIPI PTI).
+                ==  =========================
 
 What:          /sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_drop
 Date:          June 2015
index c1a6727..8316c33 100644 (file)
@@ -11,19 +11,26 @@ Description:
                at 'Documentation/powerpc/papr_hcalls.rst' . Below are
                the flags reported in this sysfs file:
 
-               * "not_armed"   : Indicates that NVDIMM contents will not
+               * "not_armed"
+                                 Indicates that NVDIMM contents will not
                                  survive a power cycle.
-               * "flush_fail"  : Indicates that NVDIMM contents
+               * "flush_fail"
+                                 Indicates that NVDIMM contents
                                  couldn't be flushed during last
                                  shut-down event.
-               * "restore_fail": Indicates that NVDIMM contents
+               * "restore_fail"
+                                 Indicates that NVDIMM contents
                                  couldn't be restored during NVDIMM
                                  initialization.
-               * "encrypted"   : NVDIMM contents are encrypted.
-               * "smart_notify": There is health event for the NVDIMM.
-               * "scrubbed"    : Indicating that contents of the
+               * "encrypted"
+                                 NVDIMM contents are encrypted.
+               * "smart_notify"
+                                 There is health event for the NVDIMM.
+               * "scrubbed"
+                                 Indicating that contents of the
                                  NVDIMM have been scrubbed.
-               * "locked"      : Indicating that NVDIMM contents cant
+               * "locked"
+                                 Indicating that NVDIMM contents cant
                                  be modified until next power cycle.
 
 What:          /sys/bus/nd/devices/nmemX/papr/perf_stats
@@ -51,4 +58,4 @@ Description:
                * "MedWDur " : Media Write Duration
                * "CchRHCnt" : Cache Read Hit Count
                * "CchWHCnt" : Cache Write Hit Count
-               * "FastWCnt" : Fast Write Count
\ No newline at end of file
+               * "FastWCnt" : Fast Write Count
index 450296c..77ad9ec 100644 (file)
@@ -7,8 +7,10 @@ Description:
                this location.  This is useful for overriding default
                bindings.  The format for the location is: DDDD:BB:DD.F.
                That is Domain:Bus:Device.Function and is the same as
-               found in /sys/bus/pci/devices/.  For example:
-               # echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/bind
+               found in /sys/bus/pci/devices/.  For example::
+
+                 # echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/bind
+
                (Note: kernels before 2.6.28 may require echo -n).
 
 What:          /sys/bus/pci/drivers/.../unbind
@@ -20,8 +22,10 @@ Description:
                this location.  This may be useful when overriding default
                bindings.  The format for the location is: DDDD:BB:DD.F.
                That is Domain:Bus:Device.Function and is the same as
-               found in /sys/bus/pci/devices/. For example:
-               # echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/unbind
+               found in /sys/bus/pci/devices/. For example::
+
+                 # echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/unbind
+
                (Note: kernels before 2.6.28 may require echo -n).
 
 What:          /sys/bus/pci/drivers/.../new_id
@@ -38,8 +42,9 @@ Description:
                Class, Class Mask, and Private Driver Data.  The Vendor ID
                and Device ID fields are required, the rest are optional.
                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/pci/drivers/foo/new_id
+               for the device and attempt to bind to it.  For example::
+
+                 # echo "8086 10f5" > /sys/bus/pci/drivers/foo/new_id
 
 What:          /sys/bus/pci/drivers/.../remove_id
 Date:          February 2009
@@ -54,8 +59,9 @@ Description:
                required, the rest are optional.  After successfully
                removing an ID, the driver will no longer support the
                device.  This is useful to ensure auto probing won't
-               match the driver to the device.  For example:
-               # echo "8086 10f5" > /sys/bus/pci/drivers/foo/remove_id
+               match the driver to the device.  For example::
+
+                 # echo "8086 10f5" > /sys/bus/pci/drivers/foo/remove_id
 
 What:          /sys/bus/pci/rescan
 Date:          January 2009
index 8a200f4..f85db86 100644 (file)
@@ -4,6 +4,7 @@ Contact:        Cezary Rojewski <cezary.rojewski@intel.com>
 Description:
                Version of AudioDSP firmware ASoC catpt driver is
                communicating with.
+
                Format: %d.%d.%d.%d, type:major:minor:build.
 
 What:          /sys/devices/pci0000:00/<dev>/fw_info
index 60c60fa..c90d97a 100644 (file)
@@ -21,11 +21,11 @@ Description:
                number returns the port to normal operation.
 
                For example: To force the high-speed device attached to
-               port 4 on bus 2 to run at full speed:
+               port 4 on bus 2 to run at full speed::
 
                        echo 4 >/sys/bus/usb/devices/usb2/../companion
 
-               To return the port to high-speed operation:
+               To return the port to high-speed operation::
 
                        echo -4 >/sys/bus/usb/devices/usb2/../companion
 
index cc30bee..417a2fe 100644 (file)
@@ -7,6 +7,8 @@ Description:
 
                Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
 
+               Example::
+
                 $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
 
                The snapshot name can be "-" or omitted to map the image
@@ -23,6 +25,8 @@ Description:
 
                Usage: <dev-id> [force]
 
+               Example::
+
                 $ echo 2 > /sys/bus/rbd/remove
 
                Optional "force" argument which when passed will wait for
@@ -80,26 +84,29 @@ Date:               Oct, 2010
 KernelVersion: v2.6.37
 Contact:       Sage Weil <sage@newdream.net>
 Description:
-               size:           (RO) The size (in bytes) of the mapped block
+
+               ==============  ================================================
+               size            (RO) The size (in bytes) of the mapped block
                                device.
 
-               major:          (RO) The block device major number.
+               major           (RO) The block device major number.
 
-               client_id:      (RO) The ceph unique client id that was assigned
+               client_id       (RO) The ceph unique client id that was assigned
                                for this specific session.
 
-               pool:           (RO) The name of the storage pool where this rbd
+               pool            (RO) The name of the storage pool where this rbd
                                image resides. An rbd image name is unique
                                within its pool.
 
-               name:           (RO) The name of the rbd image.
+               name            (RO) The name of the rbd image.
 
-               refresh:        (WO) Writing to this file will reread the image
+               refresh         (WO) Writing to this file will reread the image
                                header data and set all relevant data structures
                                accordingly.
 
-               current_snap:   (RO) The current snapshot for which the device
+               current_snap    (RO) The current snapshot for which the device
                                is mapped.
+               ==============  ================================================
 
 
 What:          /sys/bus/rbd/devices/<dev-id>/pool_id
@@ -117,11 +124,13 @@ Date:             Oct, 2012
 KernelVersion: v3.7
 Contact:       Sage Weil <sage@newdream.net>
 Description:
-               image_id:       (RO) The unique id for the rbd image. (For rbd
+               =========       ===============================================
+               image_id        (RO) The unique id for the rbd image. (For rbd
                                image format 1 this is empty.)
 
-               features:       (RO) A hexadecimal encoding of the feature bits
+               features        (RO) A hexadecimal encoding of the feature bits
                                for this image.
+               =========       ===============================================
 
 
 What:          /sys/bus/rbd/devices/<dev-id>/parent
@@ -149,14 +158,16 @@ Date:             Aug, 2016
 KernelVersion: v4.9
 Contact:       Sage Weil <sage@newdream.net>
 Description:
-               snap_id:        (RO) The current snapshot's id.
+               ============    ================================================
+               snap_id         (RO) The current snapshot's id.
 
-               config_info:    (RO) The string written into
+               config_info     (RO) The string written into
                                /sys/bus/rbd/add{,_single_major}.
 
-               cluster_fsid:   (RO) The ceph cluster UUID.
+               cluster_fsid    (RO) The ceph cluster UUID.
 
-               client_addr:    (RO) The ceph unique client
+               client_addr     (RO) The ceph unique client
                                entity_addr_t (address + nonce). The format is
                                <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
                                '[1:2:3:4:5:6:7:8]:1234/5678'.
+               ============    ================================================
index c2a403f..50e8023 100644 (file)
@@ -8,6 +8,7 @@ Description:
                When the file contains a "1" the bus is operated and periodically
                does a push-pull cycle to write and read data from the
                connected devices.
+
                When writing a "0" or "1" the bus moves to the described state.
 
 What:          /sys/bus/siox/devices/siox-X/device_add
@@ -21,8 +22,10 @@ Description:
                to add a new device dynamically. <type> is the name that is used to match
                to a driver (similar to the platform bus). <inbytes> and <outbytes> define
                the length of the input and output shift register in bytes respectively.
+
                <statustype> defines the 4 bit device type that is check to identify connection
                problems.
+
                The new device is added to the end of the existing chain.
 
 What:          /sys/bus/siox/devices/siox-X/device_remove
index 1711272..0b4ab9e 100644 (file)
@@ -193,10 +193,11 @@ Description:      When new NVM image is written to the non-active NVM
                verification fails an error code is returned instead.
 
                This file will accept writing values "1" or "2"
+
                - Writing "1" will flush the image to the storage
-               area and authenticate the image in one action.
+                 area and authenticate the image in one action.
                - Writing "2" will run some basic validation on the image
-               and flush it to the storage area.
+                 and flush it to the storage area.
 
                When read holds status of the last authentication
                operation if an error occurred during the process. This
@@ -213,9 +214,11 @@ Description:       This contains name of the property directory the XDomain
                question. Following directories are already reserved by
                the Apple XDomain specification:
 
-               network:  IP/ethernet over Thunderbolt
-               targetdm: Target disk mode protocol over Thunderbolt
-               extdisp:  External display mode protocol over Thunderbolt
+               ========  ===============================================
+               network   IP/ethernet over Thunderbolt
+               targetdm  Target disk mode protocol over Thunderbolt
+               extdisp   External display mode protocol over Thunderbolt
+               ========  ===============================================
 
 What:          /sys/bus/thunderbolt/devices/<xdomain>.<service>/modalias
 Date:          Jan 2018
@@ -293,7 +296,8 @@ Description:        For supported devices, automatically authenticate the new Thunderbo
                image when the device is disconnected from the host system.
 
                This file will accept writing values "1" or "2"
+
                - Writing "1" will flush the image to the storage
-               area and prepare the device for authentication on disconnect.
+                 area and prepare the device for authentication on disconnect.
                - Writing "2" will run some basic validation on the image
-               and flush it to the storage area.
+                 and flush it to the storage area.
index e449b83..bf2c196 100644 (file)
@@ -9,6 +9,7 @@ Description:
                by writing INTERFACE to /sys/bus/usb/drivers_probe
                This allows to avoid side-effects with drivers
                that need multiple interfaces.
+
                A deauthorized interface cannot be probed or claimed.
 
 What:          /sys/bus/usb/devices/usbX/interface_authorized_default
@@ -216,6 +217,7 @@ Description:
                 - Bit 0 of this field selects the "old" enumeration scheme,
                   as it is considerably faster (it only causes one USB reset
                   instead of 2).
+
                   The old enumeration scheme can also be selected globally
                   using /sys/module/usbcore/parameters/old_scheme_first, but
                   it is often not desirable as the new scheme was introduced to
index c0e0a9a..8251e78 100644 (file)
@@ -6,8 +6,10 @@ Description:
                Get the ALS output channel used as input in
                ALS-current-control mode (0, 1), where:
 
-               0 - out_current0 (backlight 0)
-               1 - out_current1 (backlight 1)
+               ==  ==========================
+               0   out_current0 (backlight 0)
+               1   out_current1 (backlight 1)
+               ==  ==========================
 
 What:          /sys/class/backlight/<backlight>/als_en
 Date:          May 2012
@@ -30,8 +32,10 @@ Contact:     Johan Hovold <jhovold@gmail.com>
 Description:
                Set the brightness-mapping mode (0, 1), where:
 
-               0 - exponential mode
-               1 - linear mode
+               ==  ================
+               0   exponential mode
+               1   linear mode
+               ==  ================
 
 What:          /sys/class/backlight/<backlight>/pwm
 Date:          April 2012
@@ -40,9 +44,11 @@ Contact:     Johan Hovold <jhovold@gmail.com>
 Description:
                Set the PWM-input control mask (5 bits), where:
 
-               bit 5 - PWM-input enabled in Zone 4
-               bit 4 - PWM-input enabled in Zone 3
-               bit 3 - PWM-input enabled in Zone 2
-               bit 2 - PWM-input enabled in Zone 1
-               bit 1 - PWM-input enabled in Zone 0
-               bit 0 - PWM-input enabled
+               =====   ===========================
+               bit 5   PWM-input enabled in Zone 4
+               bit 4   PWM-input enabled in Zone 3
+               bit 3   PWM-input enabled in Zone 2
+               bit 2   PWM-input enabled in Zone 1
+               bit 1   PWM-input enabled in Zone 0
+               bit 0   PWM-input enabled
+               =====   ===========================
index d773d56..5402bd7 100644 (file)
@@ -24,7 +24,6 @@ default
        filesystems which do not provide their own BDI.
 
 Files under /sys/class/bdi/<bdi>/
----------------------------------
 
 read_ahead_kb (read-write)
 
index 5819699..74ece94 100644 (file)
@@ -17,13 +17,14 @@ Date:               August 2015
 KernelVersion: 4.2
 Description:
                Tell the EC to reboot in various ways. Options are:
-               "cancel": Cancel a pending reboot.
-               "ro": Jump to RO without rebooting.
-               "rw": Jump to RW without rebooting.
-               "cold": Cold reboot.
-               "disable-jump": Disable jump until next reboot.
-               "hibernate": Hibernate the EC.
-               "at-shutdown": Reboot after an AP shutdown.
+
+               - "cancel": Cancel a pending reboot.
+               - "ro": Jump to RO without rebooting.
+               - "rw": Jump to RW without rebooting.
+               - "cold": Cold reboot.
+               - "disable-jump": Disable jump until next reboot.
+               - "hibernate": Hibernate the EC.
+               - "at-shutdown": Reboot after an AP shutdown.
 
 What:          /sys/class/chromeos/<ec-device-name>/version
 Date:          August 2015
index a6f51a1..818f559 100644 (file)
@@ -217,6 +217,7 @@ Description:    read/write
                 card.  A power cycle is required to load the image.
                 "none" could be useful for debugging because the trace arrays
                 are preserved.
+
                 "user" and "factory" means PERST will cause either the user or
                 user or factory image to be loaded.
                 Default is to reload on PERST whichever image the card has
@@ -240,8 +241,11 @@ Contact:   linuxppc-dev@lists.ozlabs.org
 Description:   read/write
                Trust that when an image is reloaded via PERST, it will not
                have changed.
-               0 = don't trust, the image may be different (default)
-               1 = trust that the image will not change.
+
+               ==  =================================================
+               0   don't trust, the image may be different (default)
+               1   trust that the image will not change.
+               ==  =================================================
 Users:         https://github.com/ibm-capi/libcxl
 
 What:           /sys/class/cxl/<card>/psl_timebase_synced
index 64791b6..b662f74 100644 (file)
@@ -18,9 +18,9 @@ Description:
 
                This will be one of the following strings:
 
-               'consumer unbind'
-               'supplier unbind'
-               'never'
+               'consumer unbind'
+               'supplier unbind'
+               'never'
 
                'consumer unbind' means the device link will be removed when
                the consumer's driver is unbound from the consumer device.
@@ -49,8 +49,10 @@ Description:
 
                This will be one of the following strings:
 
-               '0' - Does not affect runtime power management
-               '1' - Affects runtime power management
+               ===   ========================================
+               '0'   Does not affect runtime power management
+               '1'   Affects runtime power management
+               ===   ========================================
 
 What:          /sys/class/devlink/.../status
 Date:          May 2020
@@ -68,13 +70,13 @@ Description:
 
                This will be one of the following strings:
 
-               'not tracked'
-               'dormant'
-               'available'
-               'consumer probing'
-               'active'
-               'supplier unbinding'
-               'unknown'
+               'not tracked'
+               'dormant'
+               'available'
+               'consumer probing'
+               'active'
+               'supplier unbinding'
+               'unknown'
 
                'not tracked' means this device link does not track the status
                and has no impact on the binding, unbinding and syncing the
@@ -114,8 +116,10 @@ Description:
 
                This will be one of the following strings:
 
+               ===  ================================
                '0'
-               '1' - Affects runtime power management
+               '1'  Affects runtime power management
+               ===  ================================
 
                '0' means the device link can affect other device behaviors
                like binding/unbinding, suspend/resume, runtime power
index 57a7262..fde0fec 100644 (file)
@@ -39,19 +39,22 @@ Description:
                callback.
 
                If the default callback for showing function is used, the
-               format is like this:
-               # cat state
-               USB_OTG=1
-               HDMI=0
-               TA=1
-               EAR_JACK=0
-               #
+               format is like this::
+
+                   # cat state
+                   USB_OTG=1
+                   HDMI=0
+                   TA=1
+                   EAR_JACK=0
+                   #
+
                In this example, the extcon device has USB_OTG and TA
                cables attached and HDMI and EAR_JACK cables detached.
 
                In order to update the state of an extcon device, enter a hex
-               state number starting with 0x:
-               # echo 0xHEX > state
+               state number starting with 0x::
+
+                   # echo 0xHEX > state
 
                This updates the whole state of the extcon device.
                Inputs of all the methods are required to meet the
@@ -84,12 +87,13 @@ Contact:    MyungJoo Ham <myungjoo.ham@samsung.com>
 Description:
                Shows the relations of mutually exclusiveness. For example,
                if the mutually_exclusive array of extcon device is
-               {0x3, 0x5, 0xC, 0x0}, then the output is:
-               # ls mutually_exclusive/
-               0x3
-               0x5
-               0xc
-               #
+               {0x3, 0x5, 0xC, 0x0}, then the output is::
+
+                   # ls mutually_exclusive/
+                   0x3
+                   0x5
+                   0xc
+                   #
 
                Note that mutually_exclusive is a sub-directory of the extcon
                device and the file names under the mutually_exclusive
index 5284fa3..d78689c 100644 (file)
@@ -28,8 +28,7 @@ Description:  Read fpga manager state as a string.
                * firmware request      = firmware class request in progress
                * firmware request error = firmware request failed
                * write init            = preparing FPGA for programming
-               * write init error      = Error while preparing FPGA for
-                                         programming
+               * write init error      = Error while preparing FPGA for programming
                * write                 = FPGA ready to receive image data
                * write error           = Error while programming
                * write complete        = Doing post programming steps
@@ -47,7 +46,7 @@ Description:  Read fpga manager status as a string.
                programming errors to userspace. This is a list of strings for
                the supported status.
 
-               * reconfig operation error      - invalid operations detected by
+               * reconfig operation error      - invalid operations detected by
                                                  reconfiguration hardware.
                                                  e.g. start reconfiguration
                                                  with errors not cleared
index 2467b69..c8553d9 100644 (file)
@@ -6,9 +6,11 @@ Description:
                The GNSS receiver type. The currently identified types reflect
                the protocol(s) supported by the receiver:
 
+                       ======          ===========
                        "NMEA"          NMEA 0183
                        "SiRF"          SiRF Binary
                        "UBX"           UBX
+                       ======          ===========
 
                Note that also non-"NMEA" type receivers typically support a
                subset of NMEA 0183 with vendor extensions (e.g. to allow
index 65e0409..0ed5c26 100644 (file)
@@ -47,6 +47,7 @@ Contact:      Richard Purdie <rpurdie@rpsys.net>
 Description:
                Set the trigger for this LED. A trigger is a kernel based source
                of LED events.
+
                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
index 69befe9..da546e8 100644 (file)
@@ -27,23 +27,23 @@ Description:
 
                        ^
                        |
-                   0 On -|----+                   +----+                   +---
+                 0 On -|----+                   +----+                   +---
                        |    |                   |    |                   |
                    Off-|    +-------------------+    +-------------------+
                        |
-                   1 On -|    +----+                   +----+
+                 1 On -|    +----+                   +----+
                        |    |    |                   |    |
                    Off |----+    +-------------------+    +------------------
                        |
-                   2 On -|         +----+                   +----+
+                 2 On -|         +----+                   +----+
                        |         |    |                   |    |
                    Off-|---------+    +-------------------+    +-------------
                        |
-                   3 On -|              +----+                   +----+
+                 3 On -|              +----+                   +----+
                        |              |    |                   |    |
                    Off-|--------------+    +-------------------+    +--------
                        |
-                   4 On -|                   +----+                   +----+
+                 4 On -|                   +----+                   +----+
                        |                   |    |                   |    |
                    Off-|-------------------+    +-------------------+    +---
                        |
@@ -55,23 +55,23 @@ Description:
 
                        ^
                        |
-                   0 On -|    +-------------------+    +-------------------+
+                 0 On -|    +-------------------+    +-------------------+
                        |    |                   |    |                   |
                    Off-|----+                   +----+                   +---
                        |
-                   1 On -|----+    +-------------------+    +------------------
+                 1 On -|----+    +-------------------+    +------------------
                        |    |    |                   |    |
                    Off |    +----+                   +----+
                        |
-                   2 On -|---------+    +-------------------+    +-------------
+                 2 On -|---------+    +-------------------+    +-------------
                        |         |    |                   |    |
                    Off-|         +----+                   +----+
                        |
-                   3 On -|--------------+    +-------------------+    +--------
+                 3 On -|--------------+    +-------------------+    +--------
                        |              |    |                   |    |
                    Off-|              +----+                   +----+
                        |
-                   4 On -|-------------------+    +-------------------+    +---
+                 4 On -|-------------------+    +-------------------+    +---
                        |                   |    |                   |    |
                    Off-|                   +----+                   +----+
                        |
@@ -83,23 +83,23 @@ Description:
 
                        ^
                        |
-                   0 On -|----+                                       +--------
+                 0 On -|----+                                       +--------
                        |    |                                       |
                    Off-|    +---------------------------------------+
                        |
-                   1 On -|    +----+                             +----+
+                 1 On -|    +----+                             +----+
                        |    |    |                             |    |
                    Off |----+    +-----------------------------+    +--------
                        |
-                   2 On -|         +----+                   +----+
+                 2 On -|         +----+                   +----+
                        |         |    |                   |    |
                    Off-|---------+    +-------------------+    +-------------
                        |
-                   3 On -|              +----+         +----+
+                 3 On -|              +----+         +----+
                        |              |    |         |    |
                    Off-|--------------+    +---------+    +------------------
                        |
-                   4 On -|                   +---------+
+                 4 On -|                   +---------+
                        |                   |         |
                    Off-|-------------------+         +-----------------------
                        |
index e4c89b2..e38a835 100644 (file)
@@ -6,8 +6,10 @@ Description:
                Set the ALS output channel to use as input in
                ALS-current-control mode (1, 2), where:
 
-               1 - out_current1
-               2 - out_current2
+               ==  ============
+               1   out_current1
+               2   out_current2
+               ==  ============
 
 What:          /sys/class/leds/<led>/als_en
 Date:          May 2012
@@ -24,14 +26,16 @@ Contact:    Johan Hovold <jhovold@gmail.com>
 Description:
                Set the pattern generator fall and rise times (0..7), where:
 
-               0 - 2048 us
-               1 - 262 ms
-               2 - 524 ms
-               3 - 1.049 s
-               4 - 2.097 s
-               5 - 4.194 s
-               6 - 8.389 s
-               7 - 16.78 s
+               ==  =======
+               0   2048 us
+               1   262 ms
+               2   524 ms
+               3   1.049 s
+               4   2.097 s
+               5   4.194 s
+               6   8.389 s
+               7   16.78 s
+               ==  =======
 
 What:          /sys/class/leds/<led>/id
 Date:          April 2012
@@ -47,8 +51,10 @@ Contact:     Johan Hovold <jhovold@gmail.com>
 Description:
                Set the brightness-mapping mode (0, 1), where:
 
-               0 - exponential mode
-               1 - linear mode
+               ==  ================
+               0   exponential mode
+               1   linear mode
+               ==  ================
 
 What:          /sys/class/leds/<led>/pwm
 Date:          April 2012
@@ -57,9 +63,11 @@ Contact:     Johan Hovold <jhovold@gmail.com>
 Description:
                Set the PWM-input control mask (5 bits), where:
 
-               bit 5 - PWM-input enabled in Zone 4
-               bit 4 - PWM-input enabled in Zone 3
-               bit 3 - PWM-input enabled in Zone 2
-               bit 2 - PWM-input enabled in Zone 1
-               bit 1 - PWM-input enabled in Zone 0
-               bit 0 - PWM-input enabled
+               =====  ===========================
+               bit 5  PWM-input enabled in Zone 4
+               bit 4  PWM-input enabled in Zone 3
+               bit 3  PWM-input enabled in Zone 2
+               bit 2  PWM-input enabled in Zone 1
+               bit 1  PWM-input enabled in Zone 0
+               bit 0  PWM-input enabled
+               =====  ===========================
index 220a027..11e5677 100644 (file)
@@ -55,26 +55,35 @@ Description:        read only
                Flash faults are re-read after strobing the flash. Possible
                flash faults:
 
-               * led-over-voltage - flash controller voltage to the flash LED
+               * led-over-voltage
+                       flash controller voltage to the flash LED
                        has exceeded the limit specific to the flash controller
-               * flash-timeout-exceeded - the flash strobe was still on when
+               * flash-timeout-exceeded
+                       the flash strobe was still on when
                        the timeout set by the user has expired; not all flash
                        controllers may set this in all such conditions
-               * controller-over-temperature - the flash controller has
+               * controller-over-temperature
+                       the flash controller has
                        overheated
-               * controller-short-circuit - the short circuit protection
+               * controller-short-circuit
+                       the short circuit protection
                        of the flash controller has been triggered
-               * led-power-supply-over-current - current in the LED power
+               * led-power-supply-over-current
+                       current in the LED power
                        supply has exceeded the limit specific to the flash
                        controller
-               * indicator-led-fault - the flash controller has detected
+               * indicator-led-fault
+                       the flash controller has detected
                        a short or open circuit condition on the indicator LED
-               * led-under-voltage - flash controller voltage to the flash
+               * led-under-voltage
+                       flash controller voltage to the flash
                        LED has been below the minimum limit specific to
                        the flash
-               * controller-under-voltage - the input voltage of the flash
+               * controller-under-voltage
+                       the input voltage of the flash
                        controller is below the limit under which strobing the
                        flash at full current will not be possible;
                        the condition persists until this flag is no longer set
-               * led-over-temperature - the temperature of the LED has exceeded
+               * led-over-temperature
+                       the temperature of the LED has exceeded
                        its allowed upper limit
index 451af6d..6465409 100644 (file)
@@ -19,18 +19,23 @@ KernelVersion:      4.16
 Contact:       linux-leds@vger.kernel.org
 Description:
                Signal the link state of the named network device.
+
                If set to 0 (default), the LED's normal state is off.
+
                If set to 1, the LED's normal state reflects the link state
                of the named network device.
                Setting this value also immediately changes the LED state.
 
+
 What:          /sys/class/leds/<led>/tx
 Date:          Dec 2017
 KernelVersion: 4.16
 Contact:       linux-leds@vger.kernel.org
 Description:
                Signal transmission of data on the named network device.
+
                If set to 0 (default), the LED will not blink on transmission.
+
                If set to 1, the LED will blink for the milliseconds specified
                in interval to signal transmission.
 
@@ -40,6 +45,8 @@ KernelVersion:        4.16
 Contact:       linux-leds@vger.kernel.org
 Description:
                Signal reception of data on the named network device.
+
                If set to 0 (default), the LED will not blink on reception.
+
                If set to 1, the LED will blink for the milliseconds specified
                in interval to signal reception.
index f440e69..eb81152 100644 (file)
@@ -8,5 +8,6 @@ Description:
                selected for the USB port trigger. Selecting ports makes trigger
                observing them for any connected devices and lighting on LED if
                there are any.
+
                Echoing "1" value selects USB port. Echoing "0" unselects it.
                Current state can be also read.
index 6adab27..b57ffb2 100644 (file)
@@ -7,9 +7,11 @@ Description:
                of one LED will update the mode of its two sibling devices as
                well. Possible values are:
 
-               0 - normal
-               1 - audio
-               2 - breathing
+               ==  =========
+               0   normal
+               1   audio
+               2   breathing
+               ==  =========
 
                Normal: LEDs are fully on when enabled
                Audio:  LEDs brightness depends on sound level
index 3b40457..7670012 100644 (file)
@@ -4,10 +4,13 @@ KernelVersion:        3.17
 Contact:       netdev@vger.kernel.org
 Description:
                Indicates the name assignment type. Possible values are:
-               1: enumerated by the kernel, possibly in an unpredictable way
-               2: predictably named by the kernel
-               3: named by userspace
-               4: renamed
+
+               == ==========================================================
+               1  enumerated by the kernel, possibly in an unpredictable way
+               2  predictably named by the kernel
+               3  named by userspace
+               4  renamed
+               == ==========================================================
 
 What:          /sys/class/net/<iface>/addr_assign_type
 Date:          July 2010
@@ -15,10 +18,13 @@ KernelVersion:      3.2
 Contact:       netdev@vger.kernel.org
 Description:
                Indicates the address assignment type. Possible values are:
-               0: permanent address
-               1: randomly generated
-               2: stolen from another device
-               3: set using dev_set_mac_address
+
+               == =============================
+               0  permanent address
+               1  randomly generated
+               2  stolen from another device
+               3  set using dev_set_mac_address
+               == =============================
 
 What:          /sys/class/net/<iface>/addr_len
 Date:          April 2005
@@ -51,9 +57,12 @@ Description:
                Default value 0 does not forward any link local frames.
 
                Restricted bits:
-               0: 01-80-C2-00-00-00 Bridge Group Address used for STP
-               1: 01-80-C2-00-00-01 (MAC Control) 802.3 used for MAC PAUSE
-               2: 01-80-C2-00-00-02 (Link Aggregation) 802.3ad
+
+               == ========================================================
+               0  01-80-C2-00-00-00 Bridge Group Address used for STP
+               1  01-80-C2-00-00-01 (MAC Control) 802.3 used for MAC PAUSE
+               2  01-80-C2-00-00-02 (Link Aggregation) 802.3ad
+               == ========================================================
 
                Any values not setting these bits can be used. Take special
                care when forwarding control frames e.g. 802.1X-PAE or LLDP.
@@ -74,8 +83,11 @@ Contact:     netdev@vger.kernel.org
 Description:
                Indicates the current physical link state of the interface.
                Posssible values are:
-               0: physical link is down
-               1: physical link is up
+
+               == =====================
+               0  physical link is down
+               1  physical link is up
+               == =====================
 
                Note: some special devices, e.g: bonding and team drivers will
                allow this attribute to be written to force a link state for
@@ -131,8 +143,11 @@ Contact:   netdev@vger.kernel.org
 Description:
                Indicates whether the interface is under test. Possible
                values are:
-               0: interface is not being tested
-               1: interface is being tested
+
+               == =============================
+               0  interface is not being tested
+               1  interface is being tested
+               == =============================
 
                When an interface is under test, it cannot be expected
                to pass packets as normal.
@@ -144,8 +159,11 @@ Contact:   netdev@vger.kernel.org
 Description:
                Indicates the interface latest or current duplex value. Possible
                values are:
-               half: half duplex
-               full: full duplex
+
+               ====  ===========
+               half  half duplex
+               full  full duplex
+               ====  ===========
 
                Note: This attribute is only valid for interfaces that implement
                the ethtool get_link_ksettings method (mostly Ethernet).
@@ -196,8 +214,11 @@ Description:
                Indicates the interface link mode, as a decimal number. This
                attribute should be used in conjunction with 'dormant' attribute
                to determine the interface usability. Possible values:
-               0: default link mode
-               1: dormant link mode
+
+               ==  =================
+               0   default link mode
+               1   dormant link mode
+               ==  =================
 
 What:          /sys/class/net/<iface>/mtu
 Date:          April 2005
@@ -226,7 +247,9 @@ KernelVersion:      2.6.17
 Contact:       netdev@vger.kernel.org
 Description:
                Indicates the interface RFC2863 operational state as a string.
+
                Possible values are:
+
                "unknown", "notpresent", "down", "lowerlayerdown", "testing",
                "dormant", "up".
 
index f7be0e8..06416d0 100644 (file)
@@ -91,9 +91,9 @@ Date:         May 2014
 KernelVersion: 3.16
 Contact:       Bjørn Mork <bjorn@mork.no>
 Description:
-               Bit 0: 16-bit NTB supported (set to 1)
-               Bit 1: 32-bit NTB supported
-               Bits 2 â€“ 15: reserved (reset to zero; must be ignored by host)
+               Bit 0: 16-bit NTB supported (set to 1)
+               Bit 1: 32-bit NTB supported
+               Bits 2 â€“ 15: reserved (reset to zero; must be ignored by host)
 
 What:          /sys/class/net/<iface>/cdc_ncm/dwNtbInMaxSize
 Date:          May 2014
index 206cbf5..40ced0e 100644 (file)
@@ -35,7 +35,9 @@ Description:
                Ethernet driver during bus enumeration, encoded in string.
                This interface mode is used to configure the Ethernet MAC with the
                appropriate mode for its data lines to the PHY hardware.
+
                Possible values are:
+
                <empty> (not available), mii, gmii, sgmii, tbi, rev-mii,
                rmii, rgmii, rgmii-id, rgmii-rxid, rgmii-txid, rtbi, smii
                xgmii, moca, qsgmii, trgmii, 1000base-x, 2500base-x, rxaui,
index dde4f26..ba1ce62 100644 (file)
@@ -11,15 +11,17 @@ KernelVersion:      2.6.20
 Contact:       Thomas Maier <balagi@justmail.de>
 Description:
 
-               add:            (WO) Write a block device id (major:minor) to
+               ==========      ==============================================
+               add             (WO) Write a block device id (major:minor) to
                                create a new pktcdvd device and map it to the
                                block device.
 
-               remove:         (WO) Write the pktcdvd device id (major:minor)
+               remove          (WO) Write the pktcdvd device id (major:minor)
                                to remove the pktcdvd device.
 
-               device_map:     (RO) Shows the device mapping in format:
+               device_map      (RO) Shows the device mapping in format:
                                pktcdvd[0-7] <pktdevid> <blkdevid>
+               ==========      ==============================================
 
 
 What:          /sys/class/pktcdvd/pktcdvd[0-7]/dev
@@ -65,29 +67,31 @@ Date:               Oct. 2006
 KernelVersion: 2.6.20
 Contact:       Thomas Maier <balagi@justmail.de>
 Description:
-               size:           (RO) Contains the size of the bio write queue.
+               ==============  ================================================
+               size            (RO) Contains the size of the bio write queue.
 
-               congestion_off: (RW) If bio write queue size is below this mark,
+               congestion_off  (RW) If bio write queue size is below this mark,
                                accept new bio requests from the block layer.
 
-               congestion_on:  (RW) If bio write queue size is higher as this
+               congestion_on   (RW) If bio write queue size is higher as this
                                mark, do no longer accept bio write requests
                                from the block layer and wait till the pktcdvd
                                device has processed enough bio's so that bio
                                write queue size is below congestion off mark.
                                A value of <= 0 disables congestion control.
+               ==============  ================================================
 
 
 Example:
 --------
-To use the pktcdvd sysfs interface directly, you can do:
-
-# create a new pktcdvd device mapped to /dev/hdc
-echo "22:0" >/sys/class/pktcdvd/add
-cat /sys/class/pktcdvd/device_map
-# assuming device pktcdvd0 was created, look at stat's
-cat /sys/class/pktcdvd/pktcdvd0/stat/kb_written
-# print the device id of the mapped block device
-fgrep pktcdvd0 /sys/class/pktcdvd/device_map
-# remove device, using pktcdvd0 device id   253:0
-echo "253:0" >/sys/class/pktcdvd/remove
+To use the pktcdvd sysfs interface directly, you can do::
+
+    # create a new pktcdvd device mapped to /dev/hdc
+    echo "22:0" >/sys/class/pktcdvd/add
+    cat /sys/class/pktcdvd/device_map
+    # assuming device pktcdvd0 was created, look at stat's
+    cat /sys/class/pktcdvd/pktcdvd0/stat/kb_written
+    # print the device id of the mapped block device
+    fgrep pktcdvd0 /sys/class/pktcdvd/device_map
+    # remove device, using pktcdvd0 device id   253:0
+    echo "253:0" >/sys/class/pktcdvd/remove
index d4319a0..d68ad52 100644 (file)
@@ -43,7 +43,9 @@ Date:         May 2007
 Contact:       linux-pm@vger.kernel.org
 Description:
                Fine grain representation of battery capacity.
+
                Access: Read
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_alert_max
@@ -58,6 +60,7 @@ Description:
                low).
 
                Access: Read, Write
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_alert_min
@@ -88,6 +91,7 @@ Description:
                completely useless.
 
                Access: Read
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_level
@@ -111,6 +115,7 @@ Description:
                which they average readings to smooth out the reported value.
 
                Access: Read
+
                Valid values: Represented in microamps. Negative values are used
                for discharging batteries, positive values for charging batteries.
 
@@ -131,6 +136,7 @@ Description:
                This value is not averaged/smoothed.
 
                Access: Read
+
                Valid values: Represented in microamps. Negative values are used
                for discharging batteries, positive values for charging batteries.
 
@@ -383,7 +389,7 @@ Description:
 
 **USB Properties**
 
-What:          /sys/class/power_supply/<supply_name>/current_avg
+What:          /sys/class/power_supply/<supply_name>/current_avg
 Date:          May 2007
 Contact:       linux-pm@vger.kernel.org
 Description:
@@ -449,6 +455,7 @@ Description:
                solved using power limit use input_voltage_limit.
 
                Access: Read, Write
+
                Valid values: Represented in microvolts
 
 What:          /sys/class/power_supply/<supply_name>/input_power_limit
@@ -462,6 +469,7 @@ Description:
                limit only for problems that can be solved using power limit.
 
                Access: Read, Write
+
                Valid values: Represented in microwatts
 
 What:          /sys/class/power_supply/<supply_name>/online,
@@ -747,6 +755,7 @@ Description:
                manufactured.
 
                Access: Read
+
                Valid values: Reported as integer
 
 What:          /sys/class/power_supply/<supply_name>/manufacture_month
@@ -756,6 +765,7 @@ Description:
                Reports the month when the device has been manufactured.
 
                Access: Read
+
                Valid values: 1-12
 
 What:          /sys/class/power_supply/<supply_name>/manufacture_day
index 327a07e..914d67c 100644 (file)
@@ -5,4 +5,5 @@ Description:
                Represents a battery impedance compensation to accelerate charging.
 
                 Access: Read, Write
+
                 Valid values: Represented in milli-ohms. Valid range is [0, 140].
index 7ac36db..b52f702 100644 (file)
@@ -6,9 +6,9 @@ Description:
        Possible values are:
 
                =============   ===========================================
-               "auto"          draw power as appropriate for detected
+               "auto"          draw power as appropriate for detected
                                power source and battery status.
-               "off"           do not draw any power.
+               "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
index 8716bee..19aefb2 100644 (file)
@@ -6,6 +6,7 @@ Description:
                The /sys/class/rapidio_port subdirectory contains individual
                subdirectories named as "rapidioN" where N = mport ID registered
                with RapidIO subsystem.
+
                NOTE: An mport ID is not a RapidIO destination ID assigned to a
                given local mport device.
 
@@ -16,7 +17,9 @@ Contact:      Matt Porter <mporter@kernel.crashing.org>,
                Alexandre Bounine <alexandre.bounine@idt.com>
 Description:
                (RO) reports RapidIO common transport system size:
+
                0 = small (8-bit destination ID, max. 256 devices),
+
                1 = large (16-bit destination ID, max. 65536 devices).
 
 What:          /sys/class/rapidio_port/rapidioN/port_destid
@@ -25,31 +28,32 @@ KernelVersion:      v3.15
 Contact:       Matt Porter <mporter@kernel.crashing.org>,
                Alexandre Bounine <alexandre.bounine@idt.com>
 Description:
-               (RO) reports RapidIO destination ID assigned to the given
-               RapidIO mport device. If value 0xFFFFFFFF is returned this means
-               that no valid destination ID have been assigned to the mport
-               (yet). Normally, before enumeration/discovery have been executed
-               only fabric enumerating mports have a valid destination ID
-               assigned to them using "hdid=..." rapidio module parameter.
+
+(RO) reports RapidIO destination ID assigned to the given
+RapidIO mport device. If value 0xFFFFFFFF is returned this means
+that no valid destination ID have been assigned to the mport
+(yet). Normally, before enumeration/discovery have been executed
+only fabric enumerating mports have a valid destination ID
+assigned to them using "hdid=..." rapidio module parameter.
 
 After enumeration or discovery was performed for a given mport device,
 the corresponding subdirectory will also contain subdirectories for each
 child RapidIO device connected to the mport.
 
 The example below shows mport device subdirectory with several child RapidIO
-devices attached to it.
-
-[rio@rapidio ~]$ ls /sys/class/rapidio_port/rapidio0/ -l
-total 0
-drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0001
-drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0004
-drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0007
-drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0002
-drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0003
-drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0005
-lrwxrwxrwx 1 root root    0 Feb 11 15:11 device -> ../../../0000:01:00.0
--r--r--r-- 1 root root 4096 Feb 11 15:11 port_destid
-drwxr-xr-x 2 root root    0 Feb 11 15:11 power
-lrwxrwxrwx 1 root root    0 Feb 11 15:04 subsystem -> ../../../../../../class/rapidio_port
--r--r--r-- 1 root root 4096 Feb 11 15:11 sys_size
--rw-r--r-- 1 root root 4096 Feb 11 15:04 uevent
+devices attached to it::
+
+    [rio@rapidio ~]$ ls /sys/class/rapidio_port/rapidio0/ -l
+    total 0
+    drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0001
+    drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0004
+    drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0007
+    drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0002
+    drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0003
+    drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0005
+    lrwxrwxrwx 1 root root    0 Feb 11 15:11 device -> ../../../0000:01:00.0
+    -r--r--r-- 1 root root 4096 Feb 11 15:11 port_destid
+    drwxr-xr-x 2 root root    0 Feb 11 15:11 power
+    lrwxrwxrwx 1 root root    0 Feb 11 15:04 subsystem -> ../../../../../../class/rapidio_port
+    -r--r--r-- 1 root root 4096 Feb 11 15:11 sys_size
+    -rw-r--r-- 1 root root 4096 Feb 11 15:04 uevent
index bc578bc..8516f08 100644 (file)
@@ -35,13 +35,13 @@ Description:
 
                This will be one of the following strings:
 
-                       off
-                       on
-                       error
-                       fast
-                       normal
-                       idle
-                       standby
+                       off
+                       on
+                       error
+                       fast
+                       normal
+                       idle
+                       standby
 
                "off" means the regulator is not supplying power to the
                system.
@@ -74,9 +74,9 @@ Description:
 
                This will be one of the following strings:
 
-               'voltage'
-               'current'
-               'unknown'
+               'voltage'
+               'current'
+               'unknown'
 
                'voltage' means the regulator output voltage can be controlled
                by software.
@@ -129,11 +129,11 @@ Description:
 
                The opmode value can be one of the following strings:
 
-               'fast'
-               'normal'
-               'idle'
-               'standby'
-               'unknown'
+               'fast'
+               'normal'
+               'idle'
+               'standby'
+               'unknown'
 
                The modes are described in include/linux/regulator/consumer.h
 
@@ -360,9 +360,9 @@ Description:
 
                This will be one of the following strings:
 
-               'enabled'
-               'disabled'
-               'unknown'
+               'enabled'
+               'disabled'
+               'unknown'
 
                'enabled' means the regulator is in bypass mode.
 
index 066b9b6..0c9ee55 100644 (file)
@@ -16,11 +16,11 @@ Description:        Remote processor state
 
                Reports the state of the remote processor, which will be one of:
 
-               "offline"
-               "suspended"
-               "running"
-               "crashed"
-               "invalid"
+               "offline"
+               "suspended"
+               "running"
+               "crashed"
+               "invalid"
 
                "offline" means the remote processor is powered off.
 
@@ -38,8 +38,8 @@ Description:  Remote processor state
                Writing this file controls the state of the remote processor.
                The following states can be written:
 
-               "start"
-               "stop"
+               "start"
+               "stop"
 
                Writing "start" will attempt to start the processor running the
                firmware indicated by, or written to,
index ec950c9..ee8ed64 100644 (file)
@@ -7,6 +7,7 @@ Description:    Attribute for calibrating ST-Ericsson AB8500 Real Time Clock
                 calibrate the AB8500.s 32KHz Real Time Clock.
                 Every 60 seconds the AB8500 will correct the RTC's value
                 by adding to it the value of this attribute.
+
                 The range of the attribute is -127 to +127 in units of
                 30.5 micro-seconds (half-parts-per-million of the 32KHz clock)
 Users:          The /vendor/st-ericsson/base_utilities/core/rtc_calibration
index a057875..6c5dcad 100644 (file)
@@ -66,11 +66,14 @@ Description:
                 <channel> <type> [<bpst offset>]
 
                 to start (or stop) scanning on a channel.  <type> is one of:
-                    0 - scan
-                    1 - scan outside BP
-                    2 - scan while inactive
-                    3 - scanning disabled
-                    4 - scan (with start time of <bpst offset>)
+
+                  ==   =======================================
+                    0   scan
+                    1   scan outside BP
+                    2   scan while inactive
+                    3   scanning disabled
+                    4   scan (with start time of <bpst offset>)
+                  ==   =======================================
 
 What:           /sys/class/uwb_rc/uwbN/mac_address
 Date:           July 2008
index 9860a8b..585caec 100644 (file)
@@ -91,10 +91,13 @@ Description:
                h/w strapping (for WDT2 only).
 
                At alternate flash the 'access_cs0' sysfs node provides:
-                       ast2400: a way to get access to the primary SPI flash
+
+                       ast2400:
+                               a way to get access to the primary SPI flash
                                chip at CS0 after booting from the alternate
                                chip at CS1.
-                       ast2500: a way to restore the normal address mapping
+                       ast2500:
+                               a way to restore the normal address mapping
                                from (CS0->CS1, CS1->CS0) to (CS0->CS0,
                                CS1->CS1).
 
index a9f2b8b..d173906 100644 (file)
@@ -9,9 +9,10 @@ Description:   The /sys/dev tree provides a method to look up the sysfs
                the form "<major>:<minor>".  These links point to the
                corresponding sysfs path for the given device.
 
-               Example:
-               $ readlink /sys/dev/block/8:32
-               ../../block/sdc
+               Example::
+
+                 $ readlink /sys/dev/block/8:32
+                 ../../block/sdc
 
                Entries in /sys/dev/char and /sys/dev/block will be
                dynamically created and destroyed as devices enter and
index 490ccfd..8d202ba 100644 (file)
@@ -8,26 +8,27 @@ Description:
                 block.
                 For example, on 4-die Xeon platform with up to 6 IIO stacks per
                 die and, therefore, 6 IIO PMON blocks per die, the mapping of
-                IIO PMON block 0 exposes as the following:
+                IIO PMON block 0 exposes as the following::
 
-                $ ls /sys/devices/uncore_iio_0/die*
-                -r--r--r-- /sys/devices/uncore_iio_0/die0
-                -r--r--r-- /sys/devices/uncore_iio_0/die1
-                -r--r--r-- /sys/devices/uncore_iio_0/die2
-                -r--r--r-- /sys/devices/uncore_iio_0/die3
+                   $ ls /sys/devices/uncore_iio_0/die*
+                   -r--r--r-- /sys/devices/uncore_iio_0/die0
+                   -r--r--r-- /sys/devices/uncore_iio_0/die1
+                   -r--r--r-- /sys/devices/uncore_iio_0/die2
+                   -r--r--r-- /sys/devices/uncore_iio_0/die3
 
-                $ tail /sys/devices/uncore_iio_0/die*
-                ==> /sys/devices/uncore_iio_0/die0 <==
-                0000:00
-                ==> /sys/devices/uncore_iio_0/die1 <==
-                0000:40
-                ==> /sys/devices/uncore_iio_0/die2 <==
-                0000:80
-                ==> /sys/devices/uncore_iio_0/die3 <==
-                0000:c0
+                   $ tail /sys/devices/uncore_iio_0/die*
+                   ==> /sys/devices/uncore_iio_0/die0 <==
+                   0000:00
+                   ==> /sys/devices/uncore_iio_0/die1 <==
+                   0000:40
+                   ==> /sys/devices/uncore_iio_0/die2 <==
+                   0000:80
+                   ==> /sys/devices/uncore_iio_0/die3 <==
+                   0000:c0
 
-                Which means:
-                IIO PMU 0 on die 0 belongs to PCI RP on bus 0x00, domain 0x0000
-                IIO PMU 0 on die 1 belongs to PCI RP on bus 0x40, domain 0x0000
-                IIO PMU 0 on die 2 belongs to PCI RP on bus 0x80, domain 0x0000
-                IIO PMU 0 on die 3 belongs to PCI RP on bus 0xc0, domain 0x0000
+                Which means::
+
+                   IIO PMU 0 on die 0 belongs to PCI RP on bus 0x00, domain 0x0000
+                   IIO PMU 0 on die 1 belongs to PCI RP on bus 0x40, domain 0x0000
+                   IIO PMU 0 on die 2 belongs to PCI RP on bus 0x80, domain 0x0000
+                   IIO PMU 0 on die 3 belongs to PCI RP on bus 0xc0, domain 0x0000
index deef3b5..2da2b1f 100644 (file)
@@ -47,16 +47,19 @@ Description:
                online/offline state of the memory section.  When written,
                root can toggle the the online/offline state of a removable
                memory section (see removable file description above)
-               using the following commands.
-               # echo online > /sys/devices/system/memory/memoryX/state
-               # echo offline > /sys/devices/system/memory/memoryX/state
+               using the following commands::
+
+                 # echo online > /sys/devices/system/memory/memoryX/state
+                 # echo offline > /sys/devices/system/memory/memoryX/state
 
                For example, if /sys/devices/system/memory/memory22/removable
                contains a value of 1 and
                /sys/devices/system/memory/memory22/state contains the
                string "online" the following command can be executed by
-               by root to offline that section.
-               # echo offline > /sys/devices/system/memory/memory22/state
+               by root to offline that section::
+
+                 # echo offline > /sys/devices/system/memory/memory22/state
+
 Users:         hotplug memory remove tools
                http://www.ibm.com/developerworks/wikis/display/LinuxP/powerpc-utils
 
@@ -78,6 +81,7 @@ Description:
 
                For example, the following symbolic link is created for
                memory section 9 on node0:
+
                /sys/devices/system/memory/memory9/node0 -> ../../node/node0
 
 
@@ -90,4 +94,5 @@ Description:
                points to the corresponding /sys/devices/system/memory/memoryY
                memory section directory.  For example, the following symbolic
                link is created for memory section 9 on node0.
+
                /sys/devices/system/node/node0/memory9 -> ../../memory/memory9
index d548eaa..40f29a0 100644 (file)
@@ -3,8 +3,9 @@ Date:           April 2010
 Contact:       Fabien Chouteau <fabien.chouteau@barco.com>
 Description:
                Show the suspend state of an USB composite gadget.
-               1 -> suspended
-               0 -> resumed
+
+               - 1 -> suspended
+               - 0 -> resumed
 
                (_UDC_ is the name of the USB Device Controller driver)
 
@@ -17,5 +18,6 @@ Description:
                Storage mode.
 
                Possible values are:
-                       1 -> ignore the FUA flag
-                       0 -> obey the FUA flag
+
+                       - 1 -> ignore the FUA flag
+                       - 0 -> obey the FUA flag
index afb5db8..07df0dd 100644 (file)
@@ -123,38 +123,40 @@ KernelVersion:    v4.15
 Contact:       openipmi-developer@lists.sourceforge.net
 Description:
 
-               idles:                  (RO) Number of times the interface was
+               ======================  ========================================
+               idles                   (RO) Number of times the interface was
                                        idle while being polled.
 
-               watchdog_pretimeouts:   (RO) Number of watchdog pretimeouts.
+               watchdog_pretimeouts    (RO) Number of watchdog pretimeouts.
 
-               complete_transactions:  (RO) Number of completed messages.
+               complete_transactions   (RO) Number of completed messages.
 
-               events:                 (RO) Number of IPMI events received from
+               events                  (RO) Number of IPMI events received from
                                        the hardware.
 
-               interrupts:             (RO) Number of interrupts the driver
+               interrupts              (RO) Number of interrupts the driver
                                        handled.
 
-               hosed_count:            (RO) Number of times the hardware didn't
+               hosed_count             (RO) Number of times the hardware didn't
                                        follow the state machine.
 
-               long_timeouts:          (RO) Number of times the driver
+               long_timeouts           (RO) Number of times the driver
                                        requested a timer while nothing was in
                                        progress.
 
-               flag_fetches:           (RO) Number of times the driver
+               flag_fetches            (RO) Number of times the driver
                                        requested flags from the hardware.
 
-               attentions:             (RO) Number of time the driver got an
+               attentions              (RO) Number of time the driver got an
                                        ATTN from the hardware.
 
-               incoming_messages:      (RO) Number of asynchronous messages
+               incoming_messages       (RO) Number of asynchronous messages
                                        received.
 
-               short_timeouts:         (RO) Number of times the driver
+               short_timeouts          (RO) Number of times the driver
                                        requested a timer while an operation was
                                        in progress.
+               ======================  ========================================
 
 
 What:          /sys/devices/platform/ipmi_si.*/interrupts_enabled
@@ -201,38 +203,40 @@ Date:             Sep, 2017
 KernelVersion: v4.15
 Contact:       openipmi-developer@lists.sourceforge.net
 Description:
-               hosed:                  (RO) Number of times the hardware didn't
+               ======================  ========================================
+               hosed                   (RO) Number of times the hardware didn't
                                        follow the state machine.
 
-               alerts:                 (RO) Number of alerts received.
+               alerts                  (RO) Number of alerts received.
 
-               sent_messages:          (RO) Number of total messages sent.
+               sent_messages           (RO) Number of total messages sent.
 
-               sent_message_parts:     (RO) Number of message parts sent.
+               sent_message_parts      (RO) Number of message parts sent.
                                        Messages may be broken into parts if
                                        they are long.
 
-               received_messages:      (RO) Number of message responses
+               received_messages       (RO) Number of message responses
                                        received.
 
-               received_message_parts: (RO) Number of message fragments
+               received_message_parts  (RO) Number of message fragments
                                        received.
 
-               events:                 (RO) Number of received events.
+               events                  (RO) Number of received events.
 
-               watchdog_pretimeouts:   (RO) Number of watchdog pretimeouts.
+               watchdog_pretimeouts    (RO) Number of watchdog pretimeouts.
 
-               flag_fetches:           (RO) Number of times a flag fetch was
+               flag_fetches            (RO) Number of times a flag fetch was
                                        requested.
 
-               send_retries:           (RO) Number of time a message was
+               send_retries            (RO) Number of time a message was
                                        retried.
 
-               receive_retries:        (RO) Number of times the receive of a
+               receive_retries         (RO) Number of times the receive of a
                                        message was retried.
 
-               send_errors:            (RO) Number of times the send of a
+               send_errors             (RO) Number of times the send of a
                                        message failed.
 
-               receive_errors:         (RO) Number of errors in receiving
+               receive_errors          (RO) Number of errors in receiving
                                        messages.
+               ======================  ========================================
index 274c337..1a04ca8 100644 (file)
@@ -169,7 +169,7 @@ Description:
                              observed CPU idle duration was too short for it
                              (a count).
 
-               below:   (RO) Number of times this state was entered, but the
+               below:   (RO) Number of times this state was entered, but the
                              observed CPU idle duration was too long for it
                              (a count).
                ======== ==== =================================================
@@ -601,7 +601,7 @@ Description:        Secure Virtual Machine
                Facility in POWER9 and newer processors. i.e., it is a Secure
                Virtual Machine.
 
-What:          /sys/devices/system/cpu/cpuX/purr
+What:          /sys/devices/system/cpu/cpuX/purr
 Date:          Apr 2005
 Contact:       Linux for PowerPC mailing list <linuxppc-dev@ozlabs.org>
 Description:   PURR ticks for this CPU since the system boot.
index 53a0725..aee85ca 100644 (file)
@@ -3,14 +3,18 @@ Date:         July 2011
 Contact:       linux-input@vger.kernel.org
 Description:   This controls if mouse clicks should be generated if the trackpoint is quickly pressed. How fast this press has to be
                is being controlled by press_speed.
+
                Values are 0 or 1.
+
                Applies to Thinkpad USB Keyboard with TrackPoint.
 
 What:          /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/dragging
 Date:          July 2011
 Contact:       linux-input@vger.kernel.org
 Description:   If this setting is enabled, it is possible to do dragging by pressing the trackpoint. This requires press_to_select to be enabled.
+
                Values are 0 or 1.
+
                Applies to Thinkpad USB Keyboard with TrackPoint.
 
 What:          /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/release_to_select
@@ -25,7 +29,9 @@ Date:         July 2011
 Contact:       linux-input@vger.kernel.org
 Description:   This setting controls if the mouse click events generated by pressing the trackpoint (if press_to_select is enabled) generate
                a left or right mouse button click.
+
                Values are 0 or 1.
+
                Applies to Thinkpad USB Keyboard with TrackPoint.
 
 What:          /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/sensitivity
@@ -39,12 +45,16 @@ What:               /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
 Date:          July 2011
 Contact:       linux-input@vger.kernel.org
 Description:   This setting controls how fast the trackpoint needs to be pressed to generate a mouse click if press_to_select is enabled.
+
                Values are decimal integers from 1 (slowest) to 255 (fastest).
+
                Applies to Thinkpad USB Keyboard with TrackPoint.
 
 What:          /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/fn_lock
 Date:          July 2014
 Contact:       linux-input@vger.kernel.org
 Description:   This setting controls whether Fn Lock is enabled on the keyboard (i.e. if F1 is Mute or F1)
+
                Values are 0 or 1
+
                Applies to ThinkPad Compact (USB|Bluetooth) Keyboard with TrackPoint.
index e574a56..0e323a5 100644 (file)
@@ -29,12 +29,13 @@ Contact:    linux-input@vger.kernel.org
 Description:
                Threholds to override activation slack.
 
-               activation_width:       (RW) Width threshold to immediately
+               =================       =====================================
+               activation_width        (RW) Width threshold to immediately
                                        start processing touch events.
 
-               activation_height:      (RW) Height threshold to immediately
+               activation_height       (RW) Height threshold to immediately
                                        start processing touch events.
-
+               =================       =====================================
 
 What:          /sys/bus/hid/drivers/ntrig/<dev>/min_width
 What:          /sys/bus/hid/drivers/ntrig/<dev>/min_height
@@ -44,11 +45,13 @@ Contact:    linux-input@vger.kernel.org
 Description:
                Minimum size contact accepted.
 
-               min_width:      (RW) Minimum touch contact width to decide
+               ==========      ===========================================
+               min_width       (RW) Minimum touch contact width to decide
                                activation and activity.
 
-               min_height:     (RW) Minimum touch contact height to decide
+               min_height      (RW) Minimum touch contact height to decide
                                activation and activity.
+               ==========      ===========================================
 
 
 What:          /sys/bus/hid/drivers/ntrig/<dev>/sensor_physical_width
index 8f7982c..11cd9bf 100644 (file)
@@ -3,17 +3,21 @@ Date:         March 2010
 Contact:       Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   It is possible to switch the dpi setting of the mouse with the
                press of a button.
+
                When read, this file returns the raw number of the actual dpi
                setting reported by the mouse. This number has to be further
                processed to receive the real dpi value:
 
+               ===== =====
                VALUE DPI
+               ===== =====
                1     800
                2     1200
                3     1600
                4     2000
                5     2400
                6     3200
+               ===== =====
 
                This file is readonly.
 Users:         http://roccat.sourceforge.net
@@ -22,6 +26,7 @@ What:         /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
 Date:          March 2010
 Contact:       Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   When read, this file returns the number of the actual profile.
+
                This file is readonly.
 Users:         http://roccat.sourceforge.net
 
@@ -33,6 +38,7 @@ Description:  When read, this file returns the raw integer version number of the
                further usage in other programs. To receive the real version
                number the decimal point has to be shifted 2 positions to the
                left. E.g. a returned value of 138 means 1.38
+
                This file is readonly.
 Users:         http://roccat.sourceforge.net
 
@@ -43,10 +49,13 @@ Description:        The mouse can store 5 profiles which can be switched by the
                 press of a button. A profile holds information like button
                 mappings, sensitivity, the colors of the 5 leds and light
                 effects.
+
                 When read, these files return the respective profile. The
                 returned data is 975 bytes in size.
+
                When written, this file lets one write the respective profile
                data back to the mouse. The data has to be 975 bytes long.
+
                The mouse will reject invalid data, whereas the profile number
                stored in the profile doesn't need to fit the number of the
                store.
@@ -58,6 +67,7 @@ Contact:      Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   When read, this file returns the settings stored in the mouse.
                The size of the data is 36 bytes and holds information like the
                startup_profile, tcu state and calibration_data.
+
                When written, this file lets write settings back to the mouse.
                The data has to be 36 bytes long. The mouse will reject invalid
                data.
@@ -67,8 +77,10 @@ What:                /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
 Date:          March 2010
 Contact:       Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   The integer value of this attribute ranges from 1 to 5.
+
                 When read, this attribute returns the number of the profile
                 that's active when the mouse is powered on.
+
                When written, this file sets the number of the startup profile
                and the mouse activates this profile immediately.
 Users:         http://roccat.sourceforge.net
@@ -80,9 +92,12 @@ Description: The mouse has a "Tracking Control Unit" which lets the user
                calibrate the laser power to fit the mousepad surface.
                When read, this file returns the current state of the TCU,
                where 0 means off and 1 means on.
+
                Writing 0 in this file will switch the TCU off.
+
                Writing 1 in this file will start the calibration which takes
                around 6 seconds to complete and activates the TCU.
+
 Users:         http://roccat.sourceforge.net
 
 What:          /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight
@@ -93,14 +108,18 @@ Description:       The mouse can be equipped with one of four supplied weights
                and its value can be read out. When read, this file returns the
                raw value returned by the mouse which eases further processing
                in other software.
+
                The values map to the weights as follows:
 
+               ===== ======
                VALUE WEIGHT
+               ===== ======
                0     none
                1     5g
                2     10g
                3     15g
                4     20g
+               ===== ======
 
                This file is readonly.
 Users:         http://roccat.sourceforge.net
index cd7b82a..3bf43d9 100644 (file)
@@ -20,6 +20,7 @@ Description:  This file contains the currently connected and initialized
                the official Nintendo Nunchuck extension and classic is the
                Nintendo Classic Controller extension. The motionp extension can
                be combined with the other two.
+
                Starting with kernel-version 3.11 Motion Plus hotplugging is
                supported and if detected, it's no longer reported as static
                extension. You will get uevent notifications for the motion-plus
index 3d316d5..cd7c578 100644 (file)
@@ -4,6 +4,7 @@ Contact:        linux-input@vger.kernel.org
 Description:    Reports the firmware version provided by the touchscreen, for example "00_T6" on a EXC80H60
 
                Access: Read
+
                Valid values: Represented as string
 
 What:          /sys/bus/i2c/devices/xxx/model
@@ -12,4 +13,5 @@ Contact:      linux-input@vger.kernel.org
 Description:    Reports the model identification provided by the touchscreen, for example "Orion_1320" on a EXC80H60
 
                Access: Read
+
                Valid values: Represented as string
index bb6f5d6..4cf595d 100644 (file)
@@ -4,7 +4,9 @@ Contact:        PrasannaKumar Muralidharan <prasannatsmkumar@gmail.com>
 Description:   read-only access to the efuse on the Ingenic JZ4780 SoC
                The SoC has a one time programmable 8K efuse that is
                split into segments. The driver supports read only.
-               The segments are
+               The segments are:
+
+               ===== ======== =================
                0x000   64 bit Random Number
                0x008  128 bit Ingenic Chip ID
                0x018  128 bit Customer ID
@@ -12,5 +14,7 @@ Description:  read-only access to the efuse on the Ingenic JZ4780 SoC
                0x1E0    8 bit Protect Segment
                0x1E1 2296 bit HDMI Key
                0x300 2048 bit Security boot key
+               ===== ======== =================
+
 Users:         any user space application which wants to read the Chip
                and Customer ID
index 73308c2..49f5fd0 100644 (file)
@@ -7,8 +7,10 @@ Description:
                 the format of DDDD:BB:DD.F-REG:SIZE:MASK will allow the guest
                 to write and read from the PCI device. That is Domain:Bus:
                 Device.Function-Register:Size:Mask (Domain is optional).
-                For example:
-                #echo 00:19.0-E0:2:FF > /sys/bus/pci/drivers/pciback/quirks
+                For example::
+
+                  #echo 00:19.0-E0:2:FF > /sys/bus/pci/drivers/pciback/quirks
+
                 will allow the guest to read and write to the configuration
                 register 0x0E.
 
index d1a3521..adc0d0e 100644 (file)
@@ -18,6 +18,7 @@ Contact:      Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the device type. This is one of the UFS
                device descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
@@ -26,6 +27,7 @@ Contact:      Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the device class. This is one of the UFS
                device descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
@@ -34,6 +36,7 @@ Contact:      Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the UFS storage subclass. This is one of
                the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
@@ -43,6 +46,7 @@ Description:  This file shows the protocol supported by an UFS device.
                This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
@@ -51,6 +55,7 @@ Contact:      Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows number of logical units. This is one of
                the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
@@ -60,6 +65,7 @@ Description:  This file shows number of well known logical units.
                This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
@@ -69,6 +75,7 @@ Description:  This file shows value that indicates whether the device is
                enabled for boot. This is one of the UFS device descriptor
                parameters. The full information about the descriptor could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
@@ -79,6 +86,7 @@ Description:  This file shows value that indicates whether the device
                of the boot sequence. This is one of the UFS device descriptor
                parameters. The full information about the descriptor could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
@@ -88,6 +96,7 @@ Description:  This file shows value that defines the power mode after
                device initialization or hardware reset. This is one of
                the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun
@@ -96,6 +105,7 @@ Contact:     Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the high priority lun. This is one of
                the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
@@ -104,6 +114,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the secure removal type. This is one of
                the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
@@ -113,6 +124,7 @@ Description:        This file shows whether the security lun is supported.
                This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
@@ -122,6 +134,7 @@ Description:        This file shows the background operations termination
                latency. This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
@@ -130,6 +143,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the initial active ICC level. This is one
                of the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
@@ -138,6 +152,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the specification version. This is one
                of the UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
@@ -147,6 +162,7 @@ Description:        This file shows the manufacturing date in BCD format.
                This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
@@ -155,6 +171,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the manufacturee ID. This is one of the
                UFS device descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
@@ -164,6 +181,7 @@ Description:        This file shows the maximum number of outstanding RTTs
                supported by the device. This is one of the UFS device
                descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
@@ -173,6 +191,7 @@ Description:        This file shows the frequency and method of the realtime
                clock update. This is one of the UFS device descriptor
                parameters. The full information about the descriptor
                could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
@@ -182,6 +201,7 @@ Description:        This file shows which features are supported by the device.
                This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be
                found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
@@ -190,6 +210,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the FFU timeout. This is one of the
                UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
@@ -198,6 +219,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the device queue depth. This is one of the
                UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
@@ -206,6 +228,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the device version. This is one of the
                UFS device descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
@@ -215,6 +238,7 @@ Description:        This file shows number of secure write protect areas
                supported by the device. This is one of the UFS device
                descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
@@ -225,6 +249,7 @@ Description:        This file shows the maximum amount of data that may be
                This is one of the UFS device descriptor parameters.
                The full information about the descriptor could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
@@ -234,6 +259,7 @@ Description:        This file shows the command maximum timeout for a change
                in PSA state. This is one of the UFS device descriptor
                parameters. The full information about the descriptor could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -244,6 +270,7 @@ Description:        This file shows the MIPI UniPro version number in BCD format.
                This is one of the UFS interconnect descriptor parameters.
                The full information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
@@ -253,6 +280,7 @@ Description:        This file shows the MIPI M-PHY version number in BCD format.
                This is one of the UFS interconnect descriptor parameters.
                The full information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -264,6 +292,7 @@ Description:        This file shows the total memory quantity available to
                of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
@@ -273,6 +302,7 @@ Description:        This file shows the maximum number of logical units
                supported by the UFS device. This is one of the UFS
                geometry descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
@@ -281,6 +311,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the segment size. This is one of the UFS
                geometry descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
@@ -289,6 +320,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the allocation unit size. This is one of
                the UFS geometry descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
@@ -298,6 +330,7 @@ Description:        This file shows the minimum addressable block size. This
                is one of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at UFS
                specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
@@ -307,6 +340,7 @@ Description:        This file shows the optimal read block size. This is one
                of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at UFS
                specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
@@ -316,6 +350,7 @@ Description:        This file shows the optimal write block size. This is one
                of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at UFS
                specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
@@ -325,6 +360,7 @@ Description:        This file shows the maximum data-in buffer size. This
                is one of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at UFS
                specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
@@ -334,6 +370,7 @@ Description:        This file shows the maximum data-out buffer size. This
                is one of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at UFS
                specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
@@ -343,6 +380,7 @@ Description:        This file shows the maximum number of RPMB frames allowed
                in Security Protocol In/Out. This is one of the UFS geometry
                descriptor parameters. The full information about the
                descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
@@ -352,6 +390,7 @@ Description:        This file shows the dynamic capacity resource policy. This
                is one of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
@@ -361,6 +400,7 @@ Description:        This file shows support for out-of-order data transfer.
                This is one of the UFS geometry descriptor parameters.
                The full information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts
@@ -370,6 +410,7 @@ Description:        This file shows maximum available number of contexts which
                are supported by the device. This is one of the UFS geometry
                descriptor parameters. The full information about the
                descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
@@ -378,6 +419,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows system data tag unit size. This is one of
                the UFS geometry descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
@@ -388,6 +430,7 @@ Description:        This file shows maximum storage area size allocated by
                This is one of the UFS geometry descriptor parameters.
                The full information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
@@ -397,6 +440,7 @@ Description:        This file shows supported secure removal types. This is
                one of the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
@@ -406,6 +450,7 @@ Description:        This file shows supported memory types. This is one of
                the UFS geometry descriptor parameters. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
@@ -416,6 +461,7 @@ Description:        This file shows the maximum number of allocation units for
                enhanced type 1-4). This is one of the UFS geometry
                descriptor parameters. The full information about the
                descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
@@ -426,6 +472,7 @@ Description:        This file shows the memory capacity adjustment factor for
                enhanced type 1-4). This is one of the UFS geometry
                descriptor parameters. The full information about the
                descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -436,6 +483,7 @@ Description:        This file shows preend of life information. This is one
                of the UFS health descriptor parameters. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
@@ -445,6 +493,7 @@ Description:        This file shows indication of the device life time
                (method a). This is one of the UFS health descriptor
                parameters. The full information about the descriptor
                could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
@@ -454,6 +503,7 @@ Description:        This file shows indication of the device life time
                (method b). This is one of the UFS health descriptor
                parameters. The full information about the descriptor
                could be found at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -464,6 +514,7 @@ Description:        This file shows maximum VCC, VCCQ and VCCQ2 value for
                active ICC levels from 0 to 15. This is one of the UFS
                power descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -473,6 +524,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file contains a device manufactureer name string.
                The full information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
@@ -480,6 +532,7 @@ Date:               February 2018
 Contact:       Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file contains a product name string. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
@@ -487,6 +540,7 @@ Date:               February 2018
 Contact:       Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file contains a OEM ID string. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
@@ -495,6 +549,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file contains a device serial number string. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
@@ -503,6 +558,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file contains a product revision string. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -512,6 +568,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows boot LUN information. This is one of
                the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect
@@ -520,6 +577,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows LUN write protection status. This is one of
                the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
@@ -528,6 +586,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows LUN queue depth. This is one of the UFS
                unit descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
@@ -536,6 +595,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows PSA sensitivity. This is one of the UFS
                unit descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
@@ -544,6 +604,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows LUN memory type. This is one of the UFS
                unit descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/data_reliability
@@ -553,6 +614,7 @@ Description:        This file defines the device behavior when a power failure
                occurs during a write operation. This is one of the UFS
                unit descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/logical_block_size
@@ -562,6 +624,7 @@ Description:        This file shows the size of addressable logical blocks
                (calculated as an exponent with base 2). This is one of
                the UFS unit descriptor parameters. The full information about
                the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
@@ -571,6 +634,7 @@ Description:        This file shows total number of addressable logical blocks.
                This is one of the UFS unit descriptor parameters. The full
                information about the descriptor could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
@@ -579,6 +643,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the erase block size. This is one of
                the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
@@ -587,6 +652,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the thin provisioning type. This is one of
                the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
@@ -595,6 +661,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the total physical memory resources. This is
                one of the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
@@ -603,6 +670,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the context capabilities. This is one of
                the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
@@ -611,6 +679,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the granularity of the LUN. This is one of
                the UFS unit descriptor parameters. The full information
                about the descriptor could be found at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -619,6 +688,7 @@ Date:               February 2018
 Contact:       Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the device init status. The full information
                about the flag could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
@@ -627,6 +697,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows whether permanent write protection is enabled.
                The full information about the flag could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
@@ -636,6 +707,7 @@ Description:        This file shows whether write protection is enabled on all
                logical units configured as power on write protected. The
                full information about the flag could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
@@ -644,6 +716,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows whether the device background operations are
                enabled. The full information about the flag could be
                found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
@@ -652,6 +725,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows whether the device life span mode is enabled.
                The full information about the flag could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
@@ -660,6 +734,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows whether physical resource removal is enable.
                The full information about the flag could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
@@ -668,6 +743,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows whether the device is executing internal
                operation related to real time clock. The full information
                about the flag could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
@@ -676,6 +752,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows whether the device FW update is permanently
                disabled. The full information about the flag could be found
                at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -685,6 +762,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the boot lun enabled UFS device attribute.
                The full information about the attribute could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
@@ -693,6 +771,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the current power mode UFS device attribute.
                The full information about the attribute could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
@@ -701,6 +780,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the active icc level UFS device attribute.
                The full information about the attribute could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
@@ -709,6 +789,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the out of order data transfer enabled UFS
                device attribute. The full information about the attribute
                could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
@@ -717,6 +798,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the background operations status UFS device
                attribute. The full information about the attribute could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
@@ -725,6 +807,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the purge operation status UFS device
                attribute. The full information about the attribute could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
@@ -733,6 +816,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the maximum data size in a DATA IN
                UPIU. The full information about the attribute could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
@@ -741,6 +825,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file shows the maximum number of bytes that can be
                requested with a READY TO TRANSFER UPIU. The full information
                about the attribute could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
@@ -749,6 +834,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the reference clock frequency UFS device
                attribute. The full information about the attribute could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
@@ -765,6 +851,7 @@ Description:        This file provides the maximum current number of
                outstanding RTTs in device that is allowed. The full
                information about the attribute could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
@@ -773,6 +860,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the exception event control UFS device
                attribute. The full information about the attribute could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
@@ -781,6 +869,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the exception event status UFS device
                attribute. The full information about the attribute could
                be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
@@ -789,6 +878,7 @@ Contact:    Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file provides the ffu status UFS device attribute.
                The full information about the attribute could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
@@ -796,6 +886,7 @@ Date:               February 2018
 Contact:       Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
 Description:   This file show the PSA feature status. The full information
                about the attribute could be found at UFS specifications 2.1.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
@@ -805,6 +896,7 @@ Description:        This file shows the amount of data that the host plans to
                load to all logical units in pre-soldering state.
                The full information about the attribute could be found at
                UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -815,6 +907,7 @@ Description:        This file shows the The amount of physical memory needed
                to be removed from the physical memory resources pool of
                the particular logical unit. The full information about
                the attribute could be found at UFS specifications 2.1.
+
                The file is read only.
 
 
@@ -824,24 +917,28 @@ Contact:  Subhash Jadavani <subhashj@codeaurora.org>
 Description:   This entry could be used to set or show the UFS device
                runtime power management level. The current driver
                implementation supports 6 levels with next target states:
-               0 - an UFS device will stay active, an UIC link will
-               stay active
-               1 - an UFS device will stay active, an UIC link will
-               hibernate
-               2 - an UFS device will moved to sleep, an UIC link will
-               stay active
-               3 - an UFS device will moved to sleep, an UIC link will
-               hibernate
-               4 - an UFS device will be powered off, an UIC link will
-               hibernate
-               5 - an UFS device will be powered off, an UIC link will
-               be powered off
+
+               ==  ====================================================
+               0   an UFS device will stay active, an UIC link will
+                   stay active
+               1   an UFS device will stay active, an UIC link will
+                   hibernate
+               2   an UFS device will moved to sleep, an UIC link will
+                   stay active
+               3   an UFS device will moved to sleep, an UIC link will
+                   hibernate
+               4   an UFS device will be powered off, an UIC link will
+                   hibernate
+               5   an UFS device will be powered off, an UIC link will
+                   be powered off
+               ==  ====================================================
 
 What:          /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
 Date:          February 2018
 Contact:       Subhash Jadavani <subhashj@codeaurora.org>
 Description:   This entry shows the target power mode of an UFS device
                for the chosen runtime power management level.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
@@ -849,6 +946,7 @@ Date:               February 2018
 Contact:       Subhash Jadavani <subhashj@codeaurora.org>
 Description:   This entry shows the target state of an UFS UIC link
                for the chosen runtime power management level.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/spm_lvl
@@ -857,24 +955,28 @@ Contact:  Subhash Jadavani <subhashj@codeaurora.org>
 Description:   This entry could be used to set or show the UFS device
                system power management level. The current driver
                implementation supports 6 levels with next target states:
-               0 - an UFS device will stay active, an UIC link will
-               stay active
-               1 - an UFS device will stay active, an UIC link will
-               hibernate
-               2 - an UFS device will moved to sleep, an UIC link will
-               stay active
-               3 - an UFS device will moved to sleep, an UIC link will
-               hibernate
-               4 - an UFS device will be powered off, an UIC link will
-               hibernate
-               5 - an UFS device will be powered off, an UIC link will
-               be powered off
+
+               ==  ====================================================
+               0   an UFS device will stay active, an UIC link will
+                   stay active
+               1   an UFS device will stay active, an UIC link will
+                   hibernate
+               2   an UFS device will moved to sleep, an UIC link will
+                   stay active
+               3   an UFS device will moved to sleep, an UIC link will
+                   hibernate
+               4   an UFS device will be powered off, an UIC link will
+                   hibernate
+               5   an UFS device will be powered off, an UIC link will
+                   be powered off
+               ==  ====================================================
 
 What:          /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
 Date:          February 2018
 Contact:       Subhash Jadavani <subhashj@codeaurora.org>
 Description:   This entry shows the target power mode of an UFS device
                for the chosen system power management level.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
@@ -882,18 +984,21 @@ Date:             February 2018
 Contact:       Subhash Jadavani <subhashj@codeaurora.org>
 Description:   This entry shows the target state of an UFS UIC link
                for the chosen system power management level.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows if preserve user-space was configured
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the shared allocated units of WB buffer
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
@@ -901,6 +1006,7 @@ Date:              June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the configured WB type.
                0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
@@ -910,6 +1016,7 @@ Description:       This entry shows the total user-space decrease in shared
                buffer mode.
                The value of this parameter is 3 for TLC NAND when SLC mode
                is used as WriteBooster Buffer. 2 for MLC NAND.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
@@ -917,6 +1024,7 @@ Date:              June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the Maximum total WriteBooster Buffer size
                which is supported by the entire device.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
@@ -924,6 +1032,7 @@ Date:              June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the maximum number of luns that can support
                WriteBooster.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
@@ -937,46 +1046,59 @@ Description:     The supportability of user space reduction mode
                preserve user space type.
                02h: Device can be configured in either user space
                reduction type or preserve user space type.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   The supportability of WriteBooster Buffer type.
-               00h: LU based WriteBooster Buffer configuration
-               01h: Single shared WriteBooster Buffer
-               configuration
-               02h: Supporting both LU based WriteBooster
-               Buffer and Single shared WriteBooster Buffer
-               configuration
+
+               ===  ==========================================================
+               00h  LU based WriteBooster Buffer configuration
+               01h  Single shared WriteBooster Buffer configuration
+               02h  Supporting both LU based WriteBooster.
+                    Buffer and Single shared WriteBooster Buffer configuration
+               ===  ==========================================================
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the status of WriteBooster.
-               0: WriteBooster is not enabled.
-               1: WriteBooster is enabled
+
+               == ============================
+               0  WriteBooster is not enabled.
+               1  WriteBooster is enabled
+               == ============================
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows if flush is enabled.
-               0: Flush operation is not performed.
-               1: Flush operation is performed.
+
+               == =================================
+               0  Flush operation is not performed.
+               1  Flush operation is performed.
+               == =================================
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   Flush WriteBooster Buffer during hibernate state.
-               0: Device is not allowed to flush the
-               WriteBooster Buffer during link hibernate
-               state.
-               1: Device is allowed to flush the
-               WriteBooster Buffer during link hibernate
-               state
+
+               == =================================================
+               0  Device is not allowed to flush the
+                  WriteBooster Buffer during link hibernate state.
+               1  Device is allowed to flush the
+                  WriteBooster Buffer during link hibernate state.
+               == =================================================
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
@@ -984,23 +1106,30 @@ Date:            June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the amount of unused WriteBooster buffer
                available.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the amount of unused current buffer.
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
 Date:          June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the flush operation status.
-               00h: idle
-               01h: Flush operation in progress
-               02h: Flush operation stopped prematurely.
-               03h: Flush operation completed successfully
-               04h: Flush operation general failure
+
+
+               ===  ======================================
+               00h  idle
+               01h  Flush operation in progress
+               02h  Flush operation stopped prematurely.
+               03h  Flush operation completed successfully
+               04h  Flush operation general failure
+               ===  ======================================
+
                The file is read only.
 
 What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
@@ -1008,9 +1137,13 @@ Date:            June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows an indication of the WriteBooster Buffer
                lifetime based on the amount of performed program/erase cycles
-               01h: 0% - 10% WriteBooster Buffer life time used
+
+               ===  =============================================
+               01h  0% - 10% WriteBooster Buffer life time used
                ...
-               0Ah: 90% - 100% WriteBooster Buffer life time used
+               0Ah  90% - 100% WriteBooster Buffer life time used
+               ===  =============================================
+
                The file is read only.
 
 What:          /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
@@ -1018,4 +1151,5 @@ Date:             June 2020
 Contact:       Asutosh Das <asutoshd@codeaurora.org>
 Description:   This entry shows the configured size of WriteBooster buffer.
                0400h corresponds to 4GB.
+
                The file is read only.
index d301e70..e92aba4 100644 (file)
@@ -5,7 +5,9 @@ Contact:        Jan Kandziora <jjj@gmx.de>
 Description:   When written, this file sets the I2C speed on the connected
                DS28E17 chip. When read, it reads the current setting from
                the DS28E17 chip.
+
                Valid values: 100, 400, 900 [kBaud].
+
                Default 100, can be set by w1_ds28e17.speed= module parameter.
 Users:         w1_ds28e17 driver
 
@@ -17,5 +19,6 @@ Description:  When written, this file sets the multiplier used to calculate
                the busy timeout for I2C operations on the connected DS28E17
                chip. When read, returns the current setting.
                Valid values: 1 to 9.
+
                Default 1, can be set by w1_ds28e17.stretch= module parameter.
 Users:         w1_ds28e17 driver
index e4afc25..b16d30a 100644 (file)
@@ -81,11 +81,11 @@ Description:
                  $ 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
+                 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
@@ -118,9 +118,9 @@ Description:
                  gpe1D:             0  invalid
                  gpe1E:             0  invalid
                  gpe1F:             0  invalid
-                 gpe_all:    1192
-                 sci:  1194
-                 sci_not:     0
+                 gpe_all:        1192
+                 sci:            1194
+                 sci_not:           0
 
                ===========  ==================================================
                sci          The number of times the ACPI SCI
index 6e431d1..31b5767 100644 (file)
@@ -35,10 +35,13 @@ What:               /sys/firmware/efi/esrt/entries/entry$N/fw_type
 Date:          February 2015
 Contact:       Peter Jones <pjones@redhat.com>
 Description:   What kind of firmware entry this is:
-               0 - Unknown
-               1 - System Firmware
-               2 - Device Firmware
-               3 - UEFI Driver
+
+               ==  ===============
+               0   Unknown
+               1   System Firmware
+               2   Device Firmware
+               3   UEFI Driver
+               ==  ===============
 
 What:          /sys/firmware/efi/esrt/entries/entry$N/fw_class
 Date:          February 2015
@@ -71,11 +74,14 @@ Date:               February 2015
 Contact:       Peter Jones <pjones@redhat.com>
 Description:   The result of the last firmware update attempt for the
                firmware resource entry.
-               0 - Success
-               1 - Insufficient resources
-               2 - Incorrect version
-               3 - Invalid format
-               4 - Authentication error
-               5 - AC power event
-               6 - Battery power event
+
+               ==  ======================
+               0   Success
+               1   Insufficient resources
+               2   Incorrect version
+               3   Invalid format
+               4   Authentication error
+               5   AC power event
+               6   Battery power event
+               ==  ======================
 
index c61b9b3..9c4d581 100644 (file)
@@ -14,7 +14,7 @@ Description:  Switching efi runtime services to virtual mode requires
                /sys/firmware/efi/runtime-map/ is the directory the kernel
                exports that information in.
 
-               subdirectories are named with the number of the memory range:
+               subdirectories are named with the number of the memory range::
 
                        /sys/firmware/efi/runtime-map/0
                        /sys/firmware/efi/runtime-map/1
@@ -24,11 +24,13 @@ Description:        Switching efi runtime services to virtual mode requires
 
                Each subdirectory contains five files:
 
-               attribute : The attributes of the memory range.
-               num_pages : The size of the memory range in pages.
-               phys_addr : The physical address of the memory range.
-               type      : The type of the memory range.
-               virt_addr : The virtual address of the memory range.
+               =========   =========================================
+               attribute   The attributes of the memory range.
+               num_pages   The size of the memory range in pages.
+               phys_addr   The physical address of the memory range.
+               type        The type of the memory range.
+               virt_addr   The virtual address of the memory range.
+               =========   =========================================
 
                Above values are all hexadecimal numbers with the '0x' prefix.
 Users:         Kexec
index 011dda4..ee0d6db 100644 (file)
@@ -15,7 +15,7 @@ Description:
                to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
                in the QEMU source tree.
 
-               === SysFS fw_cfg Interface ===
+               **SysFS fw_cfg Interface**
 
                The fw_cfg sysfs interface described in this document is only
                intended to display discoverable blobs (i.e., those registered
@@ -31,7 +31,7 @@ Description:
 
                        /sys/firmware/qemu_fw_cfg/rev
 
-               --- Discoverable fw_cfg blobs by selector key ---
+               **Discoverable fw_cfg blobs by selector key**
 
                All discoverable blobs listed in the fw_cfg file directory are
                displayed as entries named after their unique selector key
@@ -45,24 +45,26 @@ Description:
                Each such fw_cfg sysfs entry has the following values exported
                as attributes:
 
-               name    : The 56-byte nul-terminated ASCII string used as the
+               ====      ====================================================
+               name      The 56-byte nul-terminated ASCII string used as the
                          blob's 'file name' in the fw_cfg directory.
-               size    : The length of the blob, as given in the fw_cfg
+               size      The length of the blob, as given in the fw_cfg
                          directory.
-               key     : The value of the blob's selector key as given in the
+               key       The value of the blob's selector key as given in the
                          fw_cfg directory. This value is the same as used in
                          the parent directory name.
-               raw     : The raw bytes of the blob, obtained by selecting the
+               raw       The raw bytes of the blob, obtained by selecting the
                          entry via the control register, and reading a number
                          of bytes equal to the blob size from the data
                          register.
+               ====      ====================================================
 
-               --- Listing fw_cfg blobs by file name ---
+               **Listing fw_cfg blobs by file name**
 
                While the fw_cfg device does not impose any specific naming
                convention on the blobs registered in the file directory,
                QEMU developers have traditionally used path name semantics
-               to give each blob a descriptive name. For example:
+               to give each blob a descriptive name. For example::
 
                        "bootorder"
                        "genroms/kvmvapic.bin"
@@ -81,7 +83,7 @@ Description:
                of directories matching the path name components of fw_cfg
                blob names, ending in symlinks to the by_key entry for each
                "basename", as illustrated below (assume current directory is
-               /sys/firmware):
+               /sys/firmware)::
 
                    qemu_fw_cfg/by_name/bootorder -> ../by_key/38
                    qemu_fw_cfg/by_name/etc/e820 -> ../../by_key/35
index 4be7d44..5210e0f 100644 (file)
@@ -9,7 +9,7 @@ Description:
                http://simplefirmware.org/documentation
 
                While the tables are used by the kernel, user-space
-               can observe them this way:
+               can observe them this way::
 
-               # cd /sys/firmware/sfi/tables
-               # cat $TABLENAME > $TABLENAME.bin
+                 # cd /sys/firmware/sfi/tables
+                 # cat $TABLENAME > $TABLENAME.bin
index 4573fd4..66800ba 100644 (file)
@@ -5,7 +5,7 @@ Description:
                The /sys/firmware/sgi_uv directory contains information
                about the SGI UV platform.
 
-               Under that directory are a number of files:
+               Under that directory are a number of files::
 
                        partition_id
                        coherence_id
@@ -14,7 +14,7 @@ Description:
                SGI UV systems can be partitioned into multiple physical
                machines, which each partition running a unique copy
                of the operating system.  Each partition will have a unique
-               partition id.  To display the partition id, use the command:
+               partition id.  To display the partition id, use the command::
 
                        cat /sys/firmware/sgi_uv/partition_id
 
@@ -22,6 +22,6 @@ Description:
                A partitioned SGI UV system can have one or more coherence
                domain.  The coherence id indicates which coherence domain
                this partition is in.  To display the coherence id, use the
-               command:
+               command::
 
                        cat /sys/firmware/sgi_uv/coherence_id
index 834d0be..67b3ed8 100644 (file)
@@ -20,10 +20,13 @@ What:               /sys/fs/f2fs/<disk>/gc_idle
 Date:          July 2013
 Contact:       "Namjae Jeon" <namjae.jeon@samsung.com>
 Description:   Controls the victim selection policy for garbage collection.
-               Setting gc_idle = 0(default) will disable this option. Setting
-               gc_idle = 1 will select the Cost Benefit approach & setting
-               gc_idle = 2 will select the greedy approach & setting
-               gc_idle = 3 will select the age-threshold based approach.
+               Setting gc_idle = 0(default) will disable this option. Setting:
+
+               ===========  ===============================================
+               gc_idle = 1  will select the Cost Benefit approach & setting
+               gc_idle = 2  will select the greedy approach & setting
+               gc_idle = 3  will select the age-threshold based approach.
+               ===========  ===============================================
 
 What:          /sys/fs/f2fs/<disk>/reclaim_segments
 Date:          October 2013
@@ -46,10 +49,17 @@ Date:               November 2013
 Contact:       "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
 Description:   Controls the in-place-update policy.
                updates in f2fs. User can set:
-               0x01: F2FS_IPU_FORCE, 0x02: F2FS_IPU_SSR,
-               0x04: F2FS_IPU_UTIL,  0x08: F2FS_IPU_SSR_UTIL,
-               0x10: F2FS_IPU_FSYNC, 0x20: F2FS_IPU_ASYNC,
-               0x40: F2FS_IPU_NOCACHE.
+
+               ====  =================
+               0x01  F2FS_IPU_FORCE
+               0x02  F2FS_IPU_SSR
+               0x04  F2FS_IPU_UTIL
+               0x08  F2FS_IPU_SSR_UTIL
+               0x10  F2FS_IPU_FSYNC
+               0x20  F2FS_IPU_ASYNC,
+               0x40  F2FS_IPU_NOCACHE
+               ====  =================
+
                Refer segment.h for details.
 
 What:          /sys/fs/f2fs/<disk>/min_ipu_util
@@ -332,18 +342,28 @@ Date:             April 2020
 Contact:       "Jaegeuk Kim" <jaegeuk@kernel.org>
 Description:   Give a way to attach REQ_META|FUA to data writes
                given temperature-based bits. Now the bits indicate:
-               *      REQ_META     |      REQ_FUA      |
-               *    5 |    4 |   3 |    2 |    1 |   0 |
-               * Cold | Warm | Hot | Cold | Warm | Hot |
+
+               +-------------------+-------------------+
+               |      REQ_META     |      REQ_FUA      |
+               +------+------+-----+------+------+-----+
+               |    5 |    4 |   3 |    2 |    1 |   0 |
+               +------+------+-----+------+------+-----+
+               | Cold | Warm | Hot | Cold | Warm | Hot |
+               +------+------+-----+------+------+-----+
 
 What:          /sys/fs/f2fs/<disk>/node_io_flag
 Date:          June 2020
 Contact:       "Jaegeuk Kim" <jaegeuk@kernel.org>
 Description:   Give a way to attach REQ_META|FUA to node writes
                given temperature-based bits. Now the bits indicate:
-               *      REQ_META     |      REQ_FUA      |
-               *    5 |    4 |   3 |    2 |    1 |   0 |
-               * Cold | Warm | Hot | Cold | Warm | Hot |
+
+               +-------------------+-------------------+
+               |      REQ_META     |      REQ_FUA      |
+               +------+------+-----+------+------+-----+
+               |    5 |    4 |   3 |    2 |    1 |   0 |
+               +------+------+-----+------+------+-----+
+               | Cold | Warm | Hot | Cold | Warm | Hot |
+               +------+------+-----+------+------+-----+
 
 What:          /sys/fs/f2fs/<disk>/iostat_period_ms
 Date:          April 2020
index dfc1324..1c9bed5 100644 (file)
@@ -34,8 +34,9 @@ Description:  Kernel Samepage Merging daemon sysfs interface
                in a tree.
 
                run: write 0 to disable ksm, read 0 while ksm is disabled.
-                       write 1 to run ksm, read 1 while ksm is running.
-                       write 2 to disable ksm and unmerge all its pages.
+
+                       - write 1 to run ksm, read 1 while ksm is running.
+                       - write 2 to disable ksm and unmerge all its pages.
 
                sleep_millisecs: how many milliseconds ksm should sleep between
                scans.
index ed35833..c9f12ba 100644 (file)
@@ -346,6 +346,7 @@ Description:
                number of objects per slab.  If a slab cannot be allocated
                because of fragmentation, SLUB will retry with the minimum order
                possible depending on its characteristics.
+
                When debug_guardpage_minorder=N (N > 0) parameter is specified
                (see Documentation/admin-guide/kernel-parameters.rst), the minimum possible
                order is used and this sysfs entry can not be used to change
@@ -361,6 +362,7 @@ Description:
                new slab has not been possible at the cache's order and instead
                fallen back to its minimum possible order.  It can be written to
                clear the current count.
+
                Available when CONFIG_SLUB_STATS is enabled.
 
 What:          /sys/kernel/slab/cache/partial
@@ -410,6 +412,7 @@ Description:
                slab from a remote node as opposed to allocating a new slab on
                the local node.  This reduces the amount of wasted memory over
                the entire system but can be expensive.
+
                Available when CONFIG_NUMA is enabled.
 
 What:          /sys/kernel/slab/cache/sanity_checks
index 0aac02e..353c0db 100644 (file)
@@ -17,14 +17,15 @@ KernelVersion:      3.1
 Contact:       Kirill Smelkov <kirr@mns.spb.ru>
 Description:   Maximum time allowed for periodic transfers per microframe (μs)
 
-               [ USB 2.0 sets maximum allowed time for periodic transfers per
+               Note:
+                 USB 2.0 sets maximum allowed time for periodic transfers per
                  microframe to be 80%, that is 100 microseconds out of 125
                  microseconds (full microframe).
 
                  However there are cases, when 80% max isochronous bandwidth is
                  too limiting. For example two video streams could require 110
                  microseconds of isochronous bandwidth per microframe to work
-                 together. ]
+                 together. 
 
                Through this setting it is possible to raise the limit so that
                the host controller would allow allocating more than 100
@@ -45,8 +46,10 @@ Date:                Jan 2012
 KernelVersion:»·3.3
 Contact:       Kay Sievers <kay.sievers@vrfy.org>
 Description:   Module taint flags:
-                       P - proprietary module
-                       O - out-of-tree module
-                       F - force-loaded module
-                       C - staging driver module
-                       E - unsigned module
+                       ==  =====================
+                       P   proprietary module
+                       O   out-of-tree module
+                       F   force-loaded module
+                       C   staging driver module
+                       E   unsigned module
+                       ==  =====================
index 9b917c7..82bcfe9 100644 (file)
@@ -34,9 +34,12 @@ Description:
                this file. To disable a trigger, write its name preceded
                by '-' instead.
 
-               For example, to enable the keyboard as trigger run:
+               For example, to enable the keyboard as trigger run::
+
                    echo +keyboard > /sys/class/leds/dell::kbd_backlight/start_triggers
-               To disable it:
+
+               To disable it::
+
                    echo -keyboard > /sys/class/leds/dell::kbd_backlight/start_triggers
 
                Note that not all the available triggers can be configured.
@@ -57,7 +60,8 @@ Description:
                with any the above units. If no unit is specified, the value
                is assumed to be expressed in seconds.
 
-               For example, to set the timeout to 10 minutes run:
+               For example, to set the timeout to 10 minutes run::
+
                    echo 10m > /sys/class/leds/dell::kbd_backlight/stop_timeout
 
                Note that when this file is read, the returned value might be
index 205d3b6..e6e0f7f 100644 (file)
@@ -13,8 +13,8 @@ Description:
                For example the token ID "5" would be available
                as the following attributes:
 
-               0005_location
-               0005_value
+               0005_location
+               0005_value
 
                Tokens will vary from machine to machine, and
                only tokens available on that machine will be
index c394b80..b6a138b 100644 (file)
@@ -5,9 +5,9 @@ Contact:        Wolfram Sang <wsa+renesas@sang-engineering.com>
 Description:
                Reading the file will give you a list of masters which can be
                selected for a demultiplexed bus. The format is
-               "<index>:<name>". Example from a Renesas Lager board:
+               "<index>:<name>". Example from a Renesas Lager board::
 
-               0:/i2c@e6500000 1:/i2c@e6508000
+                 0:/i2c@e6500000 1:/i2c@e6508000
 
 What:          /sys/devices/platform/<i2c-demux-name>/current_master
 Date:          January 2016
index c165327..a7f81de 100644 (file)
@@ -5,6 +5,7 @@ Contact:        "Pavan Savoy" <pavan_savoy@ti.com>
 Description:
                Name of the UART device at which the WL128x chip
                is connected. example: "/dev/ttyS0".
+
                The device name flows down to architecture specific board
                initialization file from the SFI/ATAGS bootloader
                firmware. The name exposed is read from the user-space
index 6212697..bc510cc 100644 (file)
@@ -7,9 +7,11 @@ Description:
                The file can show/change the phy mode for role swap of usb.
 
                Write the following strings to change the mode:
-                "host" - switching mode from peripheral to host.
-                "peripheral" - switching mode from host to peripheral.
+
+                - "host" - switching mode from peripheral to host.
+                - "peripheral" - switching mode from host to peripheral.
 
                Read the file, then it shows the following strings:
-                "host" - The mode is host now.
-                "peripheral" - The mode is peripheral now.
+
+                - "host" - The mode is host now.
+                - "peripheral" - The mode is peripheral now.
index 5621c15..8af5b9c 100644 (file)
@@ -7,9 +7,11 @@ Description:
                The file can show/change the drd mode of usb.
 
                Write the following string to change the mode:
-                "host" - switching mode from peripheral to host.
-                "peripheral" - switching mode from host to peripheral.
+
+               - "host" - switching mode from peripheral to host.
+               - "peripheral" - switching mode from host to peripheral.
 
                Read the file, then it shows the following strings:
-                "host" - The mode is host now.
-                "peripheral" - The mode is peripheral now.
+               
+               - "host" - The mode is host now.
+               - "peripheral" - The mode is peripheral now.
index 5e6ead2..51c0f57 100644 (file)
@@ -47,14 +47,18 @@ Description:
                suspend-to-disk mechanism.  Reading from this file returns
                the name of the method by which the system will be put to
                sleep on the next suspend.  There are four methods supported:
+
                'firmware' - means that the memory image will be saved to disk
                by some firmware, in which case we also assume that the
                firmware will handle the system suspend.
+
                'platform' - the memory image will be saved by the kernel and
                the system will be put to sleep by the platform driver (e.g.
                ACPI or other PM registers).
+
                'shutdown' - the memory image will be saved by the kernel and
                the system will be powered off.
+
                'reboot' - the memory image will be saved by the kernel and
                the system will be rebooted.
 
@@ -74,12 +78,12 @@ Description:
                The suspend-to-disk method may be chosen by writing to this
                file one of the accepted strings:
 
-               'firmware'
-               'platform'
-               'shutdown'
-               'reboot'
-               'testproc'
-               'test'
+               'firmware'
+               'platform'
+               'shutdown'
+               'reboot'
+               'testproc'
+               'test'
 
                It will only change to 'firmware' or 'platform' if the system
                supports that.
@@ -114,9 +118,9 @@ Description:
                string representing a nonzero integer into it.
 
                To use this debugging feature you should attempt to suspend
-               the machine, then reboot it and run
+               the machine, then reboot it and run::
 
-               dmesg -s 1000000 | grep 'hash matches'
+                 dmesg -s 1000000 | grep 'hash matches'
 
                If you do not get any matches (or they appear to be false
                positives), it is possible that the last PM event point
@@ -244,6 +248,7 @@ Description:
                wakeup sources created with the help of /sys/power/wake_lock.
                When a string is written to /sys/power/wake_unlock, it will be
                assumed to represent the name of a wakeup source to deactivate.
+
                If a wakeup source object of that name exists and is active at
                the moment, it will be deactivated.
 
index 8a8e466..e39dd3a 100644 (file)
@@ -5,7 +5,7 @@ Description:
                /sys/kernel/profiling is the runtime equivalent
                of the boot-time profile= option.
 
-               You can get the same effect running:
+               You can get the same effect running::
 
                        echo 2 > /sys/kernel/profiling
 
index a99c5f8..2969d36 100644 (file)
@@ -45,7 +45,8 @@ Description:
                 7. Device is unplugged.
 
                 References:
-                  [WUSB-AM] Association Models Supplement to the
+                  [WUSB-AM]
+                           Association Models Supplement to the
                             Certified Wireless Universal Serial Bus
                             Specification, version 1.0.
 
index 419a92d..1db89b0 100644 (file)
@@ -3,44 +3,52 @@ Date:         2020-01-14
 KernelVersion: 5.6
 Contact:       linux-usb@vger.kernel.org
 Description:   There are two USB charger states:
-               USB_CHARGER_ABSENT
-               USB_CHARGER_PRESENT
+
+               - USB_CHARGER_ABSENT
+               - USB_CHARGER_PRESENT
+
                There are five USB charger types:
-               USB_CHARGER_UNKNOWN_TYPE: Charger type is unknown
-               USB_CHARGER_SDP_TYPE: Standard Downstream Port
-               USB_CHARGER_CDP_TYPE: Charging Downstream Port
-               USB_CHARGER_DCP_TYPE: Dedicated Charging Port
-               USB_CHARGER_ACA_TYPE: Accessory Charging Adapter
+
+               ========================  ==========================
+               USB_CHARGER_UNKNOWN_TYPE  Charger type is unknown
+               USB_CHARGER_SDP_TYPE      Standard Downstream Port
+               USB_CHARGER_CDP_TYPE      Charging Downstream Port
+               USB_CHARGER_DCP_TYPE      Dedicated Charging Port
+               USB_CHARGER_ACA_TYPE      Accessory Charging Adapter
+               ========================  ==========================
+
                https://www.usb.org/document-library/battery-charging-v12-spec-and-adopters-agreement
 
-               Here are two examples taken using udevadm monitor -p when
-               USB charger is online:
-               UDEV  change   /devices/soc0/usbphynop1 (platform)
-               ACTION=change
-               DEVPATH=/devices/soc0/usbphynop1
-               DRIVER=usb_phy_generic
-               MODALIAS=of:Nusbphynop1T(null)Cusb-nop-xceiv
-               OF_COMPATIBLE_0=usb-nop-xceiv
-               OF_COMPATIBLE_N=1
-               OF_FULLNAME=/usbphynop1
-               OF_NAME=usbphynop1
-               SEQNUM=2493
-               SUBSYSTEM=platform
-               USB_CHARGER_STATE=USB_CHARGER_PRESENT
-               USB_CHARGER_TYPE=USB_CHARGER_SDP_TYPE
-               USEC_INITIALIZED=227422826
-
-               USB charger is offline:
-               KERNEL change   /devices/soc0/usbphynop1 (platform)
-               ACTION=change
-               DEVPATH=/devices/soc0/usbphynop1
-               DRIVER=usb_phy_generic
-               MODALIAS=of:Nusbphynop1T(null)Cusb-nop-xceiv
-               OF_COMPATIBLE_0=usb-nop-xceiv
-               OF_COMPATIBLE_N=1
-               OF_FULLNAME=/usbphynop1
-               OF_NAME=usbphynop1
-               SEQNUM=2494
-               SUBSYSTEM=platform
-               USB_CHARGER_STATE=USB_CHARGER_ABSENT
-               USB_CHARGER_TYPE=USB_CHARGER_UNKNOWN_TYPE
+               Here are two examples taken using ``udevadm monitor -p`` when
+               USB charger is online::
+
+                   UDEV  change   /devices/soc0/usbphynop1 (platform)
+                   ACTION=change
+                   DEVPATH=/devices/soc0/usbphynop1
+                   DRIVER=usb_phy_generic
+                   MODALIAS=of:Nusbphynop1T(null)Cusb-nop-xceiv
+                   OF_COMPATIBLE_0=usb-nop-xceiv
+                   OF_COMPATIBLE_N=1
+                   OF_FULLNAME=/usbphynop1
+                   OF_NAME=usbphynop1
+                   SEQNUM=2493
+                   SUBSYSTEM=platform
+                   USB_CHARGER_STATE=USB_CHARGER_PRESENT
+                   USB_CHARGER_TYPE=USB_CHARGER_SDP_TYPE
+                   USEC_INITIALIZED=227422826
+
+               USB charger is offline::
+
+                   KERNEL change   /devices/soc0/usbphynop1 (platform)
+                   ACTION=change
+                   DEVPATH=/devices/soc0/usbphynop1
+                   DRIVER=usb_phy_generic
+                   MODALIAS=of:Nusbphynop1T(null)Cusb-nop-xceiv
+                   OF_COMPATIBLE_0=usb-nop-xceiv
+                   OF_COMPATIBLE_N=1
+                   OF_FULLNAME=/usbphynop1
+                   OF_NAME=usbphynop1
+                   SEQNUM=2494
+                   SUBSYSTEM=platform
+                   USB_CHARGER_STATE=USB_CHARGER_ABSENT
+                   USB_CHARGER_TYPE=USB_CHARGER_UNKNOWN_TYPE
index d35c3ca..2b8eca4 100644 (file)
@@ -6,22 +6,22 @@ Description:  When the USB Host Controller has entered a state where it is no
                longer functional a uevent will be raised. The uevent will
                contain ACTION=offline and ERROR=DEAD.
 
-               Here is an example taken using udevadm monitor -p:
+               Here is an example taken using udevadm monitor -p::
 
-               KERNEL[130.428945] offline  /devices/pci0000:00/0000:00:10.0/usb2 (usb)
-               ACTION=offline
-               BUSNUM=002
-               DEVNAME=/dev/bus/usb/002/001
-               DEVNUM=001
-               DEVPATH=/devices/pci0000:00/0000:00:10.0/usb2
-               DEVTYPE=usb_device
-               DRIVER=usb
-               ERROR=DEAD
-               MAJOR=189
-               MINOR=128
-               PRODUCT=1d6b/2/414
-               SEQNUM=2168
-               SUBSYSTEM=usb
-               TYPE=9/0/1
+                   KERNEL[130.428945] offline  /devices/pci0000:00/0000:00:10.0/usb2 (usb)
+                   ACTION=offline
+                   BUSNUM=002
+                   DEVNAME=/dev/bus/usb/002/001
+                   DEVNUM=001
+                   DEVPATH=/devices/pci0000:00/0000:00:10.0/usb2
+                   DEVTYPE=usb_device
+                   DRIVER=usb
+                   ERROR=DEAD
+                   MAJOR=189
+                   MINOR=128
+                   PRODUCT=1d6b/2/414
+                   SEQNUM=2168
+                   SUBSYSTEM=usb
+                   TYPE=9/0/1
 
 Users:         chromium-os-dev@chromium.org
index f6adf4b..d09bb37 100755 (executable)
@@ -316,8 +316,6 @@ sub output_rest {
                                $len = length($name) if (length($name) > $len);
                        }
 
-                       print "What:\n\n";
-
                        print "+-" . "-" x $len . "-+\n";
                        foreach my $name (@names) {
                                printf "| %s", $name . " " x ($len - length($name)) . " |\n";