* [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation
[not found] <cover.1604042072.git.mchehab+huawei@kernel.org>
@ 2020-10-30 7:40 ` Mauro Carvalho Chehab
2020-10-30 14:39 ` Rafael J. Wysocki
` (2 more replies)
2020-10-30 7:40 ` [PATCH v2 35/39] docs: ABI: sysfs-class-power: unify duplicated properties Mauro Carvalho Chehab
` (2 subsequent siblings)
3 siblings, 3 replies; 19+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-30 7:40 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Rafael J. Wysocki,
Akira Shimahara, Andrew Donnellan, Andy Shevchenko,
Bart Van Assche, Bartlomiej Zolnierkiewicz, Chanwoo Choi,
Christian Gromm, Danil Kipnis, Darren Hart, Evgeniy Polyakov,
Frederic Barrat, Greg Kroah-Hartman, Gregory CLEMENT,
Ivan Zaentsev, Jack Wang, Jason Gunthorpe, Jithu Joseph,
Jolly Shah, Jonathan Cameron, Kamil Konieczny, Lukasz Luba,
Luwei Kang, Marek Behun, Michal Simek, Philippe Bergheaud,
Rajan Vaja, Richard Gong, Sebastian Reichel, Srinivas Pandruvada,
Tejas Patel, Vadim Pasternak, Vaibhav Jain, Wu Hao, Xu Yilun,
linux-arm-kernel, linux-kernel, linux-pm, platform-driver-x86
There are a number of new changes at the ABI files that cause
them to produce warnings when generating ABI output.
Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../ABI/stable/sysfs-driver-firmware-zynqmp | 62 ++++++++-----
Documentation/ABI/testing/debugfs-moxtet | 28 ++++--
.../ABI/testing/debugfs-turris-mox-rwtm | 6 +-
.../sysfs-bus-event_source-devices-dfl_fme | 14 +--
Documentation/ABI/testing/sysfs-bus-most | 6 +-
Documentation/ABI/testing/sysfs-class-devfreq | 6 +-
Documentation/ABI/testing/sysfs-class-ocxl | 14 +--
.../ABI/testing/sysfs-class-power-wilco | 18 ++--
.../ABI/testing/sysfs-class-rnbd-client | 93 ++++++++++---------
.../ABI/testing/sysfs-class-rtrs-client | 23 +++--
.../sysfs-devices-platform-stratix10-rsu | 10 ++
.../ABI/testing/sysfs-driver-w1_therm | 75 ++++++++++-----
.../ABI/testing/sysfs-platform-dfl-fme | 14 ++-
Documentation/ABI/testing/sysfs-platform-dptf | 11 ++-
.../sysfs-platform-intel-wmi-sbl-fw-update | 1 +
.../testing/sysfs-platform-mellanox-bootctl | 50 ++++++----
.../ABI/testing/sysfs-platform-wilco-ec | 1 +
17 files changed, 271 insertions(+), 161 deletions(-)
diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
index 00fa04c76ff3..f5724bb5b462 100644
--- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
+++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
@@ -12,13 +12,15 @@ Description:
resets. Three registers are used by the FSBL and
other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
- Usage:
- # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
- # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+ Usage::
- Example:
- # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
- # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+ # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+ # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+
+ Example::
+
+ # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+ # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
Users: Xilinx
@@ -39,13 +41,15 @@ Description:
software products: PERS_GLOB_GEN_STORAGE{4:7}.
Register is reset only by a POR reset.
- Usage:
- # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
- # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+ Usage::
- Example:
- # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
- # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+ # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+ # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+
+ Example::
+
+ # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+ # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
Users: Xilinx
@@ -61,23 +65,28 @@ Description:
Following are available shutdown scopes(subtypes):
- subsystem: Only the APU along with all of its peripherals
+ subsystem:
+ Only the APU along with all of its peripherals
not used by other processing units will be
shut down. This may result in the FPD power
domain being shut down provided that no other
processing unit uses FPD peripherals or DRAM.
- ps_only: The complete PS will be shut down, including the
+ ps_only:
+ The complete PS will be shut down, including the
RPU, PMU, etc. Only the PL domain (FPGA)
remains untouched.
- system: The complete system/device is shut down.
+ system:
+ The complete system/device is shut down.
- Usage:
- # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
- # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+ Usage::
- Example:
- # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
- # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+ # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+ # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+
+ Example::
+
+ # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+ # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
Users: Xilinx
@@ -94,10 +103,13 @@ Description:
system restart.
Usage:
- Set healthy bit
- # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
- Unset healthy bit
- # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
+ Set healthy bit::
+
+ # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
+
+ Unset healthy bit::
+
+ # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
Users: Xilinx
diff --git a/Documentation/ABI/testing/debugfs-moxtet b/Documentation/ABI/testing/debugfs-moxtet
index 67b1717794d8..15dfaecb2892 100644
--- a/Documentation/ABI/testing/debugfs-moxtet
+++ b/Documentation/ABI/testing/debugfs-moxtet
@@ -5,10 +5,16 @@ Contact: Marek Behún <marek.behun@nic.cz>
Description: (R) Read input from the shift registers, in hexadecimal.
Returns N+1 bytes, where N is the number of Moxtet connected
modules. The first byte is from the CPU board itself.
- Example: 101214
- 10: CPU board with SD card
- 12: 2 = PCIe module, 1 = IRQ not active
- 14: 4 = Peridot module, 1 = IRQ not active
+
+ Example::
+
+ 101214
+
+ == =======================================
+ 10 CPU board with SD card
+ 12 2 = PCIe module, 1 = IRQ not active
+ 14 4 = Peridot module, 1 = IRQ not active
+ == =======================================
What: /sys/kernel/debug/moxtet/output
Date: March 2019
@@ -17,7 +23,13 @@ Contact: Marek Behún <marek.behun@nic.cz>
Description: (RW) Read last written value to the shift registers, in
hexadecimal, or write values to the shift registers, also
in hexadecimal.
- Example: 0102
- 01: 01 was last written, or is to be written, to the
- first module's shift register
- 02: the same for second module
+
+ Example::
+
+ 0102
+
+ == ================================================
+ 01 01 was last written, or is to be written, to the
+ first module's shift register
+ 02 the same for second module
+ == ================================================
diff --git a/Documentation/ABI/testing/debugfs-turris-mox-rwtm b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
index 2b3255ee68fd..c8f7dadd591c 100644
--- a/Documentation/ABI/testing/debugfs-turris-mox-rwtm
+++ b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
@@ -2,8 +2,10 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign
Date: Jun 2020
KernelVersion: 5.8
Contact: Marek Behún <marek.behun@nic.cz>
-Description: (W) Message to sign with the ECDSA private key stored in
+Description: (W)
+ Message to sign with the ECDSA private key stored in
device's OTP. The message must be exactly 64 bytes (since
this is intended for SHA-512 hashes).
- (R) The resulting signature, 136 bytes. This contains the R and
+ (R)
+ The resulting signature, 136 bytes. This contains the R and
S values of the ECDSA signature, both in big-endian format.
diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme b/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
index c9278a3b3df1..63a32ddcb95e 100644
--- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
+++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
@@ -8,13 +8,13 @@ Description: Read-only. Attribute group to describe the magic bits
Each attribute under this group defines a bit range of the
perf_event_attr.config. All supported attributes are listed
- below.
+ below::
event = "config:0-11" - event ID
evtype = "config:12-15" - event type
portid = "config:16-23" - event source
- For example,
+ For example::
fab_mmio_read = "event=0x06,evtype=0x02,portid=0xff"
@@ -40,11 +40,11 @@ Description: Read-only. Attribute group to describe performance monitoring
All supported performance monitoring events are listed below.
- Basic events (evtype=0x00)
+ Basic events (evtype=0x00)::
clock = "event=0x00,evtype=0x00,portid=0xff"
- Cache events (evtype=0x01)
+ Cache events (evtype=0x01)::
cache_read_hit = "event=0x00,evtype=0x01,portid=0xff"
cache_read_miss = "event=0x01,evtype=0x01,portid=0xff"
@@ -59,7 +59,7 @@ Description: Read-only. Attribute group to describe performance monitoring
cache_rx_req_stall = "event=0x09,evtype=0x01,portid=0xff"
cache_eviction = "event=0x0a,evtype=0x01,portid=0xff"
- Fabric events (evtype=0x02)
+ Fabric events (evtype=0x02)::
fab_pcie0_read = "event=0x00,evtype=0x02,portid=0xff"
fab_pcie0_write = "event=0x01,evtype=0x02,portid=0xff"
@@ -78,7 +78,7 @@ Description: Read-only. Attribute group to describe performance monitoring
fab_port_mmio_read = "event=0x06,evtype=0x02,portid=?"
fab_port_mmio_write = "event=0x07,evtype=0x02,portid=?"
- VTD events (evtype=0x03)
+ VTD events (evtype=0x03)::
vtd_port_read_transaction = "event=0x00,evtype=0x03,portid=?"
vtd_port_write_transaction = "event=0x01,evtype=0x03,portid=?"
@@ -88,7 +88,7 @@ Description: Read-only. Attribute group to describe performance monitoring
vtd_port_devtlb_2m_fill = "event=0x05,evtype=0x03,portid=?"
vtd_port_devtlb_1g_fill = "event=0x06,evtype=0x03,portid=?"
- VTD SIP events (evtype=0x04)
+ VTD SIP events (evtype=0x04)::
vtd_sip_iotlb_4k_hit = "event=0x00,evtype=0x04,portid=0xff"
vtd_sip_iotlb_2m_hit = "event=0x01,evtype=0x04,portid=0xff"
diff --git a/Documentation/ABI/testing/sysfs-bus-most b/Documentation/ABI/testing/sysfs-bus-most
index ec0a603d804b..38cc03e408e7 100644
--- a/Documentation/ABI/testing/sysfs-bus-most
+++ b/Documentation/ABI/testing/sysfs-bus-most
@@ -235,7 +235,8 @@ KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com>
Description:
This is to read back the configured direction of the channel.
- The following strings will be accepted:
+ The following strings will be accepted::
+
'tx',
'rx'
Users:
@@ -246,7 +247,8 @@ KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com>
Description:
This is to read back the configured data type of the channel.
- The following strings will be accepted:
+ The following strings will be accepted::
+
'control',
'async',
'sync',
diff --git a/Documentation/ABI/testing/sysfs-class-devfreq b/Documentation/ABI/testing/sysfs-class-devfreq
index 67af3f31e17c..386bc230a33d 100644
--- a/Documentation/ABI/testing/sysfs-class-devfreq
+++ b/Documentation/ABI/testing/sysfs-class-devfreq
@@ -48,7 +48,8 @@ Description:
driver should provide the list of available frequencies
with its profile. If need to reset the statistics of devfreq
behavior on a specific device, enter 0(zero) to 'trans_stat'
- as following:
+ as following::
+
echo 0 > /sys/class/devfreq/.../trans_stat
What: /sys/class/devfreq/.../available_frequencies
@@ -124,7 +125,8 @@ Description:
This work timer is used by devfreq workqueue in order to
monitor the device status such as utilization. The user
can change the work timer on runtime according to their demand
- as following:
+ as following::
+
echo deferrable > /sys/class/devfreq/.../timer
echo delayed > /sys/class/devfreq/.../timer
diff --git a/Documentation/ABI/testing/sysfs-class-ocxl b/Documentation/ABI/testing/sysfs-class-ocxl
index bf33f4fda58f..847a7edc3113 100644
--- a/Documentation/ABI/testing/sysfs-class-ocxl
+++ b/Documentation/ABI/testing/sysfs-class-ocxl
@@ -13,8 +13,8 @@ Description: read only
where:
==== ===============================================
- n: number of currently active contexts, for debug
- max: maximum number of contexts supported by the AFU
+ n number of currently active contexts, for debug
+ max maximum number of contexts supported by the AFU
==== ===============================================
What: /sys/class/ocxl/<afu name>/pp_mmio_size
@@ -43,7 +43,9 @@ Contact: linuxppc-dev@lists.ozlabs.org
Description: read/write
Control whether the FPGA is reloaded on a link reset. Enabled
through a vendor-specific logic block on the FPGA.
- 0 Do not reload FPGA image from flash
- 1 Reload FPGA image from flash
- unavailable
- The device does not support this capability
+
+ =========== ===========================================
+ 0 Do not reload FPGA image from flash
+ 1 Reload FPGA image from flash
+ unavailable The device does not support this capability
+ =========== ===========================================
diff --git a/Documentation/ABI/testing/sysfs-class-power-wilco b/Documentation/ABI/testing/sysfs-class-power-wilco
index 84fde1d0ada0..82af180fcaab 100644
--- a/Documentation/ABI/testing/sysfs-class-power-wilco
+++ b/Documentation/ABI/testing/sysfs-class-power-wilco
@@ -4,17 +4,23 @@ KernelVersion: 5.2
Description:
What charging algorithm to use:
- Standard: Fully charges battery at a standard rate.
- Adaptive: Battery settings adaptively optimized based on
+ Standard:
+ Fully charges battery at a standard rate.
+ Adaptive:
+ Battery settings adaptively optimized based on
typical battery usage pattern.
- Fast: Battery charges over a shorter period.
- Trickle: Extends battery lifespan, intended for users who
+ Fast:
+ Battery charges over a shorter period.
+ Trickle:
+ Extends battery lifespan, intended for users who
primarily use their Chromebook while connected to AC.
- Custom: A low and high threshold percentage is specified.
+ Custom:
+ A low and high threshold percentage is specified.
Charging begins when level drops below
charge_control_start_threshold, and ceases when
level is above charge_control_end_threshold.
- Long Life: Customized charge rate for last longer battery life.
+ Long Life:
+ Customized charge rate for last longer battery life.
On Wilco device this mode is pre-configured in the factory
through EC's private PID. Swiching to a different mode will
be denied by Wilco EC when Long Life mode is enabled.
diff --git a/Documentation/ABI/testing/sysfs-class-rnbd-client b/Documentation/ABI/testing/sysfs-class-rnbd-client
index c084f203b41e..00c0286733d4 100644
--- a/Documentation/ABI/testing/sysfs-class-rnbd-client
+++ b/Documentation/ABI/testing/sysfs-class-rnbd-client
@@ -5,62 +5,70 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud
Description: Provide information about RNBD-client.
All sysfs files that are not read-only provide the usage information on read:
- Example:
- # cat /sys/class/rnbd-client/ctl/map_device
+ Example::
- > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr>
- > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side>
- > [access_mode=<ro|rw|migration>] > map_device
- >
- > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
+ # cat /sys/class/rnbd-client/ctl/map_device
+
+ > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr>
+ > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side>
+ > [access_mode=<ro|rw|migration>] > map_device
+ >
+ > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
What: /sys/class/rnbd-client/ctl/map_device
Date: Feb 2020
KernelVersion: 5.7
Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
-Description: Expected format is the following:
+Description: Expected format is the following::
- sessname=<name of the rtrs session>
- path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
- device_path=<full path on remote side>
- [access_mode=<ro|rw|migration>]
+ sessname=<name of the rtrs session>
+ path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
+ device_path=<full path on remote side>
+ [access_mode=<ro|rw|migration>]
Where:
- sessname: accepts a string not bigger than 256 chars, which identifies
- a given session on the client and on the server.
- I.e. "clt_hostname-srv_hostname" could be a natural choice.
+ sessname:
+ accepts a string not bigger than 256 chars, which identifies
+ a given session on the client and on the server.
+ I.e. "clt_hostname-srv_hostname" could be a natural choice.
- path: describes a connection between the client and the server by
- specifying destination and, when required, the source address.
- The addresses are to be provided in the following format:
+ path:
+ describes a connection between the client and the server by
+ specifying destination and, when required, the source address.
+ The addresses are to be provided in the following format::
- ip:<IPv6>
- ip:<IPv4>
- gid:<GID>
+ ip:<IPv6>
+ ip:<IPv4>
+ gid:<GID>
- for example:
+ for example::
+
+ path=ip:10.0.0.66
- path=ip:10.0.0.66
The single addr is treated as the destination.
The connection will be established to this server from any client IP address.
- path=ip:10.0.0.66,ip:10.0.1.66
+ ::
+
+ path=ip:10.0.0.66,ip:10.0.1.66
+
First addr is the source address and the second is the destination.
If multiple "path=" options are specified multiple connection
will be established and data will be sent according to
the selected multipath policy (see RTRS mp_policy sysfs entry description).
- device_path: Path to the block device on the server side. Path is specified
- relative to the directory on server side configured in the
- 'dev_search_path' module parameter of the rnbd_server.
- The rnbd_server prepends the <device_path> received from client
- with <dev_search_path> and tries to open the
- <dev_search_path>/<device_path> block device. On success,
- a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/
- directory and an entry in /sys/class/rnbd-client/ctl/devices
- will be created.
+ device_path:
+ Path to the block device on the server side. Path is specified
+ relative to the directory on server side configured in the
+ 'dev_search_path' module parameter of the rnbd_server.
+ The rnbd_server prepends the <device_path> received from client
+ with <dev_search_path> and tries to open the
+ <dev_search_path>/<device_path> block device. On success,
+ a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/
+ directory and an entry in /sys/class/rnbd-client/ctl/devices
+ will be created.
If 'dev_search_path' contains '%SESSNAME%', then each session can
have different devices namespace, e.g. server was configured with
@@ -68,11 +76,12 @@ Description: Expected format is the following:
client has this string "sessname=blya device_path=sda", then server
will try to open: /run/rnbd-devs/blya/sda.
- access_mode: the access_mode parameter specifies if the device is to be
- mapped as "ro" read-only or "rw" read-write. The server allows
- a device to be exported in rw mode only once. The "migration"
- access mode has to be specified if a second mapping in read-write
- mode is desired.
+ access_mode:
+ the access_mode parameter specifies if the device is to be
+ mapped as "ro" read-only or "rw" read-write. The server allows
+ a device to be exported in rw mode only once. The "migration"
+ access mode has to be specified if a second mapping in read-write
+ mode is desired.
By default "rw" is used.
@@ -91,7 +100,7 @@ Description: Expected format is the following:
is the same as the device name. By extracting the last part of the
path the path to the device /dev/<dev-name> can be build.
- o /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev)
+ * /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev)
How to find the <device_id> of the device is described on the next
section.
@@ -106,6 +115,6 @@ Description: For each device mapped on the client a new symbolic link is created
The <device_id> of each device is created as follows:
- If the 'device_path' provided during mapping contains slashes ("/"),
- they are replaced by exclamation mark ("!") and used as as the
- <device_id>. Otherwise, the <device_id> will be the same as the
- "device_path" provided.
+ they are replaced by exclamation mark ("!") and used as as the
+ <device_id>. Otherwise, the <device_id> will be the same as the
+ "device_path" provided.
diff --git a/Documentation/ABI/testing/sysfs-class-rtrs-client b/Documentation/ABI/testing/sysfs-class-rtrs-client
index e7e718db8941..0f7165aab251 100644
--- a/Documentation/ABI/testing/sysfs-class-rtrs-client
+++ b/Documentation/ABI/testing/sysfs-class-rtrs-client
@@ -10,10 +10,10 @@ Date: Feb 2020
KernelVersion: 5.7
Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
Description: RW, adds a new path (connection) to an existing session. Expected format is the
- following:
+ following::
- <[source addr,]destination addr>
- *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
+ <[source addr,]destination addr>
+ *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
What: /sys/class/rtrs-client/<session-name>/max_reconnect_attempts
Date: Feb 2020
@@ -29,10 +29,10 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud
Description: Multipath policy specifies which path should be selected on each IO:
round-robin (0):
- select path in per CPU round-robin manner.
+ select path in per CPU round-robin manner.
min-inflight (1):
- select path with minimum inflights.
+ select path with minimum inflights.
What: /sys/class/rtrs-client/<session-name>/paths/
Date: Feb 2020
@@ -109,8 +109,11 @@ Description: RTRS expects that each HCA IRQ is pinned to a separate CPU. If it's
not the case, the processing of an I/O response could be processed on a
different CPU than where it was originally submitted. This file shows
how many interrupts where generated on a non expected CPU.
- "from:" is the CPU on which the IRQ was expected, but not generated.
- "to:" is the CPU on which the IRQ was generated, but not expected.
+
+ "from:"
+ is the CPU on which the IRQ was expected, but not generated.
+ "to:"
+ is the CPU on which the IRQ was generated, but not expected.
What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reconnects
Date: Feb 2020
@@ -125,7 +128,7 @@ Date: Feb 2020
KernelVersion: 5.7
Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
Description: Contains statistics regarding rdma operations and inflight operations.
- The output consists of 6 values:
+ The output consists of 6 values::
- <read-count> <read-total-size> <write-count> <write-total-size> \
- <inflights> <failovered>
+ <read-count> <read-total-size> <write-count> \
+ <write-total-size> <inflights> <failovered>
diff --git a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
index a8daceb4a956..ee253b033280 100644
--- a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
+++ b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
@@ -102,6 +102,8 @@ Description:
b[15:0]
inform firmware the current software execution
stage.
+
+ == ===========================================
0 the first stage bootloader didn't run or
didn't reach the point of launching second
stage bootloader.
@@ -111,21 +113,29 @@ Description:
2 both first and second stage bootloader ran
and the operating system launch was
attempted.
+ == ===========================================
b[16]
+ == ===========================================
1 firmware to reset current image retry
counter.
0 no action.
+ == ===========================================
b[17]
+ == ===========================================
1 firmware to clear RSU log
0 no action.
+ == ===========================================
b[18]
this is negative logic
+
+ == ===========================================
1 no action
0 firmware record the notify code defined
in b[15:0].
+ == ===========================================
What: /sys/devices/platform/stratix10-rsu.0/dcmf0
Date: June 2020
diff --git a/Documentation/ABI/testing/sysfs-driver-w1_therm b/Documentation/ABI/testing/sysfs-driver-w1_therm
index 8873bbb075cb..6a37dc33ffdb 100644
--- a/Documentation/ABI/testing/sysfs-driver-w1_therm
+++ b/Documentation/ABI/testing/sysfs-driver-w1_therm
@@ -22,8 +22,10 @@ Description:
device data to its embedded EEPROM, either restore data
embedded in device EEPROM. Be aware that devices support
limited EEPROM writing cycles (typical 50k)
+
* 'save': save device RAM to EEPROM
* 'restore': restore EEPROM data in device RAM
+
Users: any user space application which wants to communicate with
w1_term device
@@ -33,9 +35,11 @@ Date: May 2020
Contact: Akira Shimahara <akira215corp@gmail.com>
Description:
(RO) return the power status by asking the device
+
* '0': device parasite powered
* '1': device externally powered
* '-xx': xx is kernel error when reading power status
+
Users: any user space application which wants to communicate with
w1_term device
@@ -49,10 +53,12 @@ Description:
will be changed only in device RAM, so it will be cleared when
power is lost. Trigger a 'save' to EEPROM command to keep
values after power-on. Read or write are :
+
* '9..14': device resolution in bit
- or resolution to set in bit
+ or resolution to set in bit
* '-xx': xx is kernel error when reading the resolution
* Anything else: do nothing
+
Some DS18B20 clones are fixed in 12-bit resolution, so the
actual resolution is read back from the chip and verified. Error
is reported if the results differ.
@@ -65,16 +71,18 @@ Date: May 2020
Contact: Akira Shimahara <akira215corp@gmail.com>
Description:
(RO) return the temperature in 1/1000 degC.
+
* If a bulk read has been triggered, it will directly
- return the temperature computed when the bulk read
- occurred, if available. If not yet available, nothing
- is returned (a debug kernel message is sent), you
- should retry later on.
+ return the temperature computed when the bulk read
+ occurred, if available. If not yet available, nothing
+ is returned (a debug kernel message is sent), you
+ should retry later on.
* If no bulk read has been triggered, it will trigger
- a conversion and send the result. Note that the
- conversion duration depend on the resolution (if
- device support this feature). It takes 94ms in 9bits
- resolution, 750ms for 12bits.
+ a conversion and send the result. Note that the
+ conversion duration depend on the resolution (if
+ device support this feature). It takes 94ms in 9bits
+ resolution, 750ms for 12bits.
+
Users: any user space application which wants to communicate with
w1_term device
@@ -86,12 +94,14 @@ Description:
(RW) return the temperature in 1/1000 degC.
*read*: return 2 lines with the hexa output data sent on the
bus, return the CRC check and temperature in 1/1000 degC
- *write* :
+ *write*:
+
* '0' : save the 2 or 3 bytes to the device EEPROM
- (i.e. TH, TL and config register)
+ (i.e. TH, TL and config register)
* '9..14' : set the device resolution in RAM
- (if supported)
+ (if supported)
* Anything else: do nothing
+
refer to Documentation/w1/slaves/w1_therm.rst for detailed
information.
Users: any user space application which wants to communicate with
@@ -103,14 +113,21 @@ Date: May 2020
Contact: Akira Shimahara <akira215corp@gmail.com>
Description:
(RW) trigger a bulk read conversion. read the status
+
*read*:
- * '-1': conversion in progress on at least 1 sensor
- * '1' : conversion complete but at least one sensor
+ * '-1':
+ conversion in progress on at least 1 sensor
+ * '1' :
+ conversion complete but at least one sensor
value has not been read yet
- * '0' : no bulk operation. Reading temperature will
+ * '0' :
+ no bulk operation. Reading temperature will
trigger a conversion on each device
- *write*: 'trigger': trigger a bulk read on all supporting
+
+ *write*:
+ 'trigger': trigger a bulk read on all supporting
devices on the bus
+
Note that if a bulk read is sent but one sensor is not read
immediately, the next access to temperature on this device
will return the temperature measured at the time of issue
@@ -128,14 +145,19 @@ Description:
reset to default (datasheet) conversion time for a new
resolution.
- *read*: Actual conversion time in milliseconds. *write*:
- '0': Set the default conversion time from the datasheet.
- '1': Measure and set the conversion time. Make a single
+ *read*:
+ Actual conversion time in milliseconds.
+
+ *write*:
+ * '0':
+ Set the default conversion time from the datasheet.
+ * '1':
+ Measure and set the conversion time. Make a single
temperature conversion, measure an actual value.
Increase it by 20% for temperature range. A new
conversion time can be obtained by reading this
same attribute.
- other positive value:
+ * other positive value:
Set the conversion time in milliseconds.
Users: An application using the w1_term device
@@ -148,16 +170,21 @@ Description:
(RW) Control optional driver settings.
Bit masks to read/write (bitwise OR):
- 1: Enable check for conversion success. If byte 6 of
+ == ============================================================
+ 1 Enable check for conversion success. If byte 6 of
scratchpad memory is 0xC after conversion, and
temperature reads 85.00 (powerup value) or 127.94
(insufficient power) - return a conversion error.
- 2: Enable poll for conversion completion. Generate read cycles
+ 2 Enable poll for conversion completion. Generate read cycles
after the conversion start and wait for 1's. In parasite
power mode this feature is not available.
+ == ============================================================
- *read*: Currently selected features.
- *write*: Select features.
+ *read*:
+ Currently selected features.
+
+ *write*:
+ Select features.
Users: An application using the w1_term device
diff --git a/Documentation/ABI/testing/sysfs-platform-dfl-fme b/Documentation/ABI/testing/sysfs-platform-dfl-fme
index 3683cb1cdc3d..d6ab34e81b9b 100644
--- a/Documentation/ABI/testing/sysfs-platform-dfl-fme
+++ b/Documentation/ABI/testing/sysfs-platform-dfl-fme
@@ -113,8 +113,11 @@ KernelVersion: 5.5
Contact: Wu Hao <hao.wu@intel.com>
Description: Read-Only. Read this file to get the name of hwmon device, it
supports values:
- 'dfl_fme_thermal' - thermal hwmon device name
- 'dfl_fme_power' - power hwmon device name
+
+ ================= =========================
+ 'dfl_fme_thermal' thermal hwmon device name
+ 'dfl_fme_power' power hwmon device name
+ ================= =========================
What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input
Date: October 2019
@@ -169,8 +172,11 @@ KernelVersion: 5.5
Contact: Wu Hao <hao.wu@intel.com>
Description: Read-Only. Read this file to get the policy of hardware threshold1
(see 'temp1_max'). It only supports two values (policies):
- 0 - AP2 state (90% throttling)
- 1 - AP1 state (50% throttling)
+
+ == ==========================
+ 0 AP2 state (90% throttling)
+ 1 AP1 state (50% throttling)
+ == ==========================
What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_input
Date: October 2019
diff --git a/Documentation/ABI/testing/sysfs-platform-dptf b/Documentation/ABI/testing/sysfs-platform-dptf
index 2cbc660d163b..141834342a4d 100644
--- a/Documentation/ABI/testing/sysfs-platform-dptf
+++ b/Documentation/ABI/testing/sysfs-platform-dptf
@@ -27,12 +27,15 @@ KernelVersion: v4.10
Contact: linux-acpi@vger.kernel.org
Description:
(RO) Display the platform power source
+
+ ========= ============================
bits[3:0] Current power source
- 0x00 = DC
- 0x01 = AC
- 0x02 = USB
- 0x03 = Wireless Charger
+ - 0x00 = DC
+ - 0x01 = AC
+ - 0x02 = USB
+ - 0x03 = Wireless Charger
bits[7:4] Power source sequence number
+ ========= ============================
What: /sys/bus/platform/devices/INT3407:00/dptf_power/battery_steady_power
Date: Jul, 2016
diff --git a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
index 5aa618987cad..02ae1e9bbfc8 100644
--- a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
+++ b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
@@ -8,5 +8,6 @@ Description:
of 0 and userspace can signal SBL to update firmware,
on next reboot, by writing a value of 1.
There are two available states:
+
* 0 -> Skip firmware update while rebooting
* 1 -> Attempt firmware update on next reboot
diff --git a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
index 401d202f478b..e79ca22e2f45 100644
--- a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
+++ b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
@@ -5,10 +5,13 @@ Contact: "Liming Sun <lsun@mellanox.com>"
Description:
The Life-cycle state of the SoC, which could be one of the
following values.
- Production - Production state and can be updated to secure
- GA Secured - Secure chip and not able to change state
- GA Non-Secured - Non-Secure chip and not able to change state
- RMA - Return Merchandise Authorization
+
+ ============== =============================================
+ Production Production state and can be updated to secure
+ GA Secured Secure chip and not able to change state
+ GA Non-Secured Non-Secure chip and not able to change state
+ RMA Return Merchandise Authorization
+ ============== =============================================
What: /sys/bus/platform/devices/MLNXBF04:00/post_reset_wdog
Date: Oct 2019
@@ -25,10 +28,13 @@ KernelVersion: 5.5
Contact: "Liming Sun <lsun@mellanox.com>"
Description:
The source of the boot stream for the next reset. It could be
- one of the following values.
- external - boot from external source (USB or PCIe)
- emmc - boot from the onchip eMMC
- emmc_legacy - boot from the onchip eMMC in legacy (slow) mode
+ one of the following values:
+
+ =========== ===============================================
+ external boot from external source (USB or PCIe)
+ emmc boot from the onchip eMMC
+ emmc_legacy boot from the onchip eMMC in legacy (slow) mode
+ =========== ===============================================
What: /sys/bus/platform/devices/MLNXBF04:00/second_reset_action
Date: Oct 2019
@@ -38,11 +44,14 @@ Description:
Update the source of the boot stream after next reset. It could
be one of the following values and will be applied after next
reset.
- external - boot from external source (USB or PCIe)
- emmc - boot from the onchip eMMC
- emmc_legacy - boot from the onchip eMMC in legacy (slow) mode
- swap_emmc - swap the primary / secondary boot partition
- none - cancel the action
+
+ =========== ===============================================
+ external boot from external source (USB or PCIe)
+ emmc boot from the onchip eMMC
+ emmc_legacy boot from the onchip eMMC in legacy (slow) mode
+ swap_emmc swap the primary / secondary boot partition
+ none cancel the action
+ =========== ===============================================
What: /sys/bus/platform/devices/MLNXBF04:00/secure_boot_fuse_state
Date: Oct 2019
@@ -50,9 +59,12 @@ KernelVersion: 5.5
Contact: "Liming Sun <lsun@mellanox.com>"
Description:
The state of eFuse versions with the following values.
- InUse - burnt, valid and currently in use
- Used - burnt and valid
- Free - not burnt and free to use
- Skipped - not burnt but not free (skipped)
- Wasted - burnt and invalid
- Invalid - not burnt but marked as valid (error state).
+
+ ======= ===============================================
+ InUse burnt, valid and currently in use
+ Used burnt and valid
+ Free not burnt and free to use
+ Skipped not burnt but not free (skipped)
+ Wasted burnt and invalid
+ Invalid not burnt but marked as valid (error state).
+ ======= ===============================================
diff --git a/Documentation/ABI/testing/sysfs-platform-wilco-ec b/Documentation/ABI/testing/sysfs-platform-wilco-ec
index 5f60b184a5a5..4439d0644091 100644
--- a/Documentation/ABI/testing/sysfs-platform-wilco-ec
+++ b/Documentation/ABI/testing/sysfs-platform-wilco-ec
@@ -39,6 +39,7 @@ Description:
which affects charging via the special USB PowerShare port
(marked with a small lightning bolt or battery icon) when in
low power states:
+
- In S0, the port will always provide power.
- In S0ix, if usb_charge is enabled, then power will be
supplied to the port when on AC or if battery is > 50%.
--
2.26.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* [PATCH v2 35/39] docs: ABI: sysfs-class-power: unify duplicated properties
[not found] <cover.1604042072.git.mchehab+huawei@kernel.org>
2020-10-30 7:40 ` [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation Mauro Carvalho Chehab
@ 2020-10-30 7:40 ` Mauro Carvalho Chehab
[not found] ` <58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org>
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
3 siblings, 0 replies; 19+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-30 7:40 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Sebastian Reichel,
linux-kernel, linux-pm
The ABI is not supposed to have duplicated entries, as warned
by get_abi.pl:
$ ./scripts/get_abi.pl validate 2>&1|grep sysfs-class-power
Warning: /sys/class/power_supply/<supply_name>/current_avg is defined 2 times: Documentation/ABI/testing/sysfs-class-power:108 Documentation/ABI/testing/sysfs-class-power:391
Warning: /sys/class/power_supply/<supply_name>/current_max is defined 2 times: Documentation/ABI/testing/sysfs-class-power:121 Documentation/ABI/testing/sysfs-class-power:404
Warning: /sys/class/power_supply/<supply_name>/current_now is defined 2 times: Documentation/ABI/testing/sysfs-class-power:130 Documentation/ABI/testing/sysfs-class-power:414
Warning: /sys/class/power_supply/<supply_name>/temp is defined 2 times: Documentation/ABI/testing/sysfs-class-power:281 Documentation/ABI/testing/sysfs-class-power:493
Warning: /sys/class/power_supply/<supply_name>/temp_alert_max is defined 2 times: Documentation/ABI/testing/sysfs-class-power:291 Documentation/ABI/testing/sysfs-class-power:505
Warning: /sys/class/power_supply/<supply_name>/temp_alert_min is defined 2 times: Documentation/ABI/testing/sysfs-class-power:306 Documentation/ABI/testing/sysfs-class-power:521
Warning: /sys/class/power_supply/<supply_name>/temp_max is defined 2 times: Documentation/ABI/testing/sysfs-class-power:322 Documentation/ABI/testing/sysfs-class-power:537
Warning: /sys/class/power_supply/<supply_name>/temp_min is defined 2 times: Documentation/ABI/testing/sysfs-class-power:333 Documentation/ABI/testing/sysfs-class-power:547
Warning: /sys/class/power_supply/<supply_name>/voltage_max is defined 2 times: Documentation/ABI/testing/sysfs-class-power:356 Documentation/ABI/testing/sysfs-class-power:571
Warning: /sys/class/power_supply/<supply_name>/voltage_min is defined 2 times: Documentation/ABI/testing/sysfs-class-power:367 Documentation/ABI/testing/sysfs-class-power:581
Warning: /sys/class/power_supply/<supply_name>/voltage_now is defined 2 times: Documentation/ABI/testing/sysfs-class-power:378 Documentation/ABI/testing/sysfs-class-power:591
Yet, both USB and Battery share a common set of charging-related
properties.
Unify the entries for such properties in order to avoid
duplication, while preserving the battery and USB-specific
data properly documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/ABI/testing/sysfs-class-power | 486 +++++++++-----------
1 file changed, 223 insertions(+), 263 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
index d68ad528a8e5..ca830c6cd809 100644
--- a/Documentation/ABI/testing/sysfs-class-power
+++ b/Documentation/ABI/testing/sysfs-class-power
@@ -36,7 +36,229 @@ Description:
Access: Read
Valid values: "Battery", "UPS", "Mains", "USB", "Wireless"
-===== Battery Properties =====
+**Battery and USB properties**
+
+What: /sys/class/power_supply/<supply_name>/current_avg
+Date: May 2007
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports an average IBAT current reading for the battery, over
+ a fixed period. Normally devices will provide a fixed interval
+ in which they average readings to smooth out the reported
+ value.
+
+ USB:
+
+ Reports an average IBUS current reading over a fixed period.
+ Normally devices will provide a fixed interval in 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 and for USB IBUS current.
+
+What: /sys/class/power_supply/<supply_name>/current_max
+Date: October 2010
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports the maximum IBAT current allowed into the battery.
+
+ USB:
+
+ Reports the maximum IBUS current the supply can support.
+
+ Access: Read
+ Valid values: Represented in microamps
+
+What: /sys/class/power_supply/<supply_name>/current_now
+Date: May 2007
+Contact: linux-pm@vger.kernel.org
+Description:
+
+ Battery:
+
+ Reports an instant, single IBAT current reading for the
+ battery. This value is not averaged/smoothed.
+
+ Access: Read
+
+ USB:
+
+ Reports the IBUS current supplied now. This value is generally
+ read-only reporting, unless the 'online' state of the supply
+ is set to be programmable, in which case this value can be set
+ within the reported min/max range.
+
+ Access: Read, Write
+
+ Valid values: Represented in microamps. Negative values are
+ used for discharging batteries, positive values for charging
+ batteries and for USB IBUS current.
+
+What: /sys/class/power_supply/<supply_name>/temp
+Date: May 2007
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports the current TBAT battery temperature reading.
+
+ USB:
+
+ Reports the current supply temperature reading. This would
+ normally be the internal temperature of the device itself
+ (e.g TJUNC temperature of an IC)
+
+ Access: Read
+
+ Valid values: Represented in 1/10 Degrees Celsius
+
+What: /sys/class/power_supply/<supply_name>/temp_alert_max
+Date: July 2012
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Maximum TBAT temperature trip-wire value where the supply will
+ notify user-space of the event.
+
+ USB:
+
+ Maximum supply temperature trip-wire value where the supply
+ will notify user-space of the event.
+
+ This is normally used for the charging scenario where
+ user-space needs to know if the temperature has crossed an
+ upper threshold so it can take appropriate action (e.g. warning
+ user that the temperature is critically high, and charging has
+ stopped).
+
+ Access: Read
+
+ Valid values: Represented in 1/10 Degrees Celsius
+
+What: /sys/class/power_supply/<supply_name>/temp_alert_min
+Date: July 2012
+Contact: linux-pm@vger.kernel.org
+Description:
+
+ Battery:
+
+ Minimum TBAT temperature trip-wire value where the supply will
+ notify user-space of the event.
+
+ USB:
+
+ Minimum supply temperature trip-wire value where the supply
+ will notify user-space of the event.
+
+ This is normally used for the charging scenario where user-space
+ needs to know if the temperature has crossed a lower threshold
+ so it can take appropriate action (e.g. warning user that
+ temperature level is high, and charging current has been
+ reduced accordingly to remedy the situation).
+
+ Access: Read
+
+ Valid values: Represented in 1/10 Degrees Celsius
+
+What: /sys/class/power_supply/<supply_name>/temp_max
+Date: July 2014
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports the maximum allowed TBAT battery temperature for
+ charging.
+
+ USB:
+
+ Reports the maximum allowed supply temperature for operation.
+
+ Access: Read
+
+ Valid values: Represented in 1/10 Degrees Celsius
+
+What: /sys/class/power_supply/<supply_name>/temp_min
+Date: July 2014
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports the minimum allowed TBAT battery temperature for
+ charging.
+
+ USB:
+
+ Reports the minimum allowed supply temperature for operation.
+
+ Access: Read
+
+ Valid values: Represented in 1/10 Degrees Celsius
+
+What: /sys/class/power_supply/<supply_name>/voltage_max,
+Date: January 2008
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports the maximum safe VBAT voltage permitted for the
+ battery, during charging.
+
+ USB:
+
+ Reports the maximum VBUS voltage the supply can support.
+
+ Access: Read
+
+ Valid values: Represented in microvolts
+
+What: /sys/class/power_supply/<supply_name>/voltage_min,
+Date: January 2008
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports the minimum safe VBAT voltage permitted for the
+ battery, during discharging.
+
+ USB:
+
+ Reports the minimum VBUS voltage the supply can support.
+
+ Access: Read
+
+ Valid values: Represented in microvolts
+
+What: /sys/class/power_supply/<supply_name>/voltage_now,
+Date: May 2007
+Contact: linux-pm@vger.kernel.org
+Description:
+ Battery:
+
+ Reports an instant, single VBAT voltage reading for the
+ battery. This value is not averaged/smoothed.
+
+ Access: Read
+
+ USB:
+
+ Reports the VBUS voltage supplied now. This value is generally
+ read-only reporting, unless the 'online' state of the supply
+ is set to be programmable, in which case this value can be set
+ within the reported min/max range.
+
+ Access: Read, Write
+
+ Valid values: Represented in microvolts
+
+**Battery Properties**
What: /sys/class/power_supply/<supply_name>/capacity
Date: May 2007
@@ -106,40 +328,6 @@ Description:
"Unknown", "Critical", "Low", "Normal", "High",
"Full"
-What: /sys/class/power_supply/<supply_name>/current_avg
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports an average IBAT current reading for the battery, over a
- fixed period. Normally devices will provide a fixed interval in
- 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.
-
-What: /sys/class/power_supply/<supply_name>/current_max
-Date: October 2010
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the maximum IBAT current allowed into the battery.
-
- Access: Read
- Valid values: Represented in microamps
-
-What: /sys/class/power_supply/<supply_name>/current_now
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports an instant, single IBAT current reading for the battery.
- 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.
-
What: /sys/class/power_supply/<supply_name>/charge_control_limit
Date: Oct 2012
Contact: linux-pm@vger.kernel.org
@@ -279,68 +467,6 @@ Description:
"Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
"NiCd", "LiMn"
-What: /sys/class/power_supply/<supply_name>/temp
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the current TBAT battery temperature reading.
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_alert_max
-Date: July 2012
-Contact: linux-pm@vger.kernel.org
-Description:
- Maximum TBAT temperature trip-wire value where the supply will
- notify user-space of the event. This is normally used for the
- battery charging scenario where user-space needs to know the
- battery temperature has crossed an upper threshold so it can
- take appropriate action (e.g. warning user that battery level is
- critically high, and charging has stopped).
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_alert_min
-Date: July 2012
-Contact: linux-pm@vger.kernel.org
-Description:
- Minimum TBAT temperature trip-wire value where the supply will
- notify user-space of the event. This is normally used for the
- battery charging scenario where user-space needs to know the
- battery temperature has crossed a lower threshold so it can take
- appropriate action (e.g. warning user that battery level is
- high, and charging current has been reduced accordingly to
- remedy the situation).
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_max
-Date: July 2014
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the maximum allowed TBAT battery temperature for
- charging.
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_min
-Date: July 2014
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the minimum allowed TBAT battery temperature for
- charging.
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/voltage_avg,
Date: May 2007
@@ -354,77 +480,8 @@ Description:
Valid values: Represented in microvolts
-What: /sys/class/power_supply/<supply_name>/voltage_max,
-Date: January 2008
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the maximum safe VBAT voltage permitted for the battery,
- during charging.
-
- Access: Read
-
- Valid values: Represented in microvolts
-
-What: /sys/class/power_supply/<supply_name>/voltage_min,
-Date: January 2008
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the minimum safe VBAT voltage permitted for the battery,
- during discharging.
-
- Access: Read
-
- Valid values: Represented in microvolts
-
-What: /sys/class/power_supply/<supply_name>/voltage_now,
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports an instant, single VBAT voltage reading for the battery.
- This value is not averaged/smoothed.
-
- Access: Read
-
- Valid values: Represented in microvolts
-
**USB Properties**
-What: /sys/class/power_supply/<supply_name>/current_avg
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports an average IBUS current reading over a fixed period.
- Normally devices will provide a fixed interval in which they
- average readings to smooth out the reported value.
-
- Access: Read
-
- Valid values: Represented in microamps
-
-
-What: /sys/class/power_supply/<supply_name>/current_max
-Date: October 2010
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the maximum IBUS current the supply can support.
-
- Access: Read
-
- Valid values: Represented in microamps
-
-What: /sys/class/power_supply/<supply_name>/current_now
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the IBUS current supplied now. This value is generally
- read-only reporting, unless the 'online' state of the supply
- is set to be programmable, in which case this value can be set
- within the reported min/max range.
-
- Access: Read, Write
-
- Valid values: Represented in microamps
-
What: /sys/class/power_supply/<supply_name>/input_current_limit
Date: July 2014
Contact: linux-pm@vger.kernel.org
@@ -491,70 +548,6 @@ Description:
2: Online Programmable - Programmable Voltage Supply
== ==================================================
-What: /sys/class/power_supply/<supply_name>/temp
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the current supply temperature reading. This would
- normally be the internal temperature of the device itself (e.g
- TJUNC temperature of an IC)
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_alert_max
-Date: July 2012
-Contact: linux-pm@vger.kernel.org
-Description:
- Maximum supply temperature trip-wire value where the supply will
- notify user-space of the event. This is normally used for the
- charging scenario where user-space needs to know the supply
- temperature has crossed an upper threshold so it can take
- appropriate action (e.g. warning user that the supply
- temperature is critically high, and charging has stopped to
- remedy the situation).
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_alert_min
-Date: July 2012
-Contact: linux-pm@vger.kernel.org
-Description:
- Minimum supply temperature trip-wire value where the supply will
- notify user-space of the event. This is normally used for the
- charging scenario where user-space needs to know the supply
- temperature has crossed a lower threshold so it can take
- appropriate action (e.g. warning user that the supply
- temperature is high, and charging current has been reduced
- accordingly to remedy the situation).
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_max
-Date: July 2014
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the maximum allowed supply temperature for operation.
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
-What: /sys/class/power_supply/<supply_name>/temp_min
-Date: July 2014
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the mainimum allowed supply temperature for operation.
-
- Access: Read
-
- Valid values: Represented in 1/10 Degrees Celsius
-
What: /sys/class/power_supply/<supply_name>/usb_type
Date: March 2018
Contact: linux-pm@vger.kernel.org
@@ -569,39 +562,6 @@ Description:
"Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
"PD_DRP", "PD_PPS", "BrickID"
-What: /sys/class/power_supply/<supply_name>/voltage_max
-Date: January 2008
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the maximum VBUS voltage the supply can support.
-
- Access: Read
-
- Valid values: Represented in microvolts
-
-What: /sys/class/power_supply/<supply_name>/voltage_min
-Date: January 2008
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the minimum VBUS voltage the supply can support.
-
- Access: Read
-
- Valid values: Represented in microvolts
-
-What: /sys/class/power_supply/<supply_name>/voltage_now
-Date: May 2007
-Contact: linux-pm@vger.kernel.org
-Description:
- Reports the VBUS voltage supplied now. This value is generally
- read-only reporting, unless the 'online' state of the supply
- is set to be programmable, in which case this value can be set
- within the reported min/max range.
-
- Access: Read, Write
-
- Valid values: Represented in microvolts
-
**Device Specific Properties**
What: /sys/class/power/ds2760-battery.*/charge_now
--
2.26.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* RE: [PATCH v2 31/39] docs: ABI: cleanup several ABI documents
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
@ 2020-10-30 8:27 ` Rojewski, Cezary
2020-10-30 9:49 ` Suzuki K Poulose
` (3 subsequent siblings)
4 siblings, 0 replies; 19+ messages in thread
From: Rojewski, Cezary @ 2020-10-30 8:27 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Gautham R. Shenoy, Jonathan Corbet, Marek Behún,
Marek Marczykowski-Górecki, Pali Rohár,
Peter Zijlstra (Intel), Rafael J. Wysocki, Roger Pau Monné,
Alexander Antonov, Alexander Shishkin, Alexandre Torgue,
Andreas Klinger, Andrew Donnellan, Andrew Lunn, Shevchenko,
Andriy, Anton Vorontsov, Asutosh Das, Bart Van Assche,
Bartosz Golaszewski, Bjorn Andersson, Bjorn Helgaas,
Boris Brezillon, Boris Ostrovsky, Chao Yu, Christian Gromm,
Colin Cross, Dan Murphy, Williams, Dan J, Daniel Thompson,
Danil Kipnis, David Sterba, Dmitry Torokhov, Dongsheng Yang,
Enric Balletbo i Serra, Florian Fainelli, Frederic Barrat,
Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo, Hans Verkuil,
Heiner Kallweit, Ilya Dryomov, Jack Wang, Jaegeuk Kim,
Jarkko Sakkinen, Jason Gunthorpe, Jens Axboe, Jerry Snitselaar,
Jingoo Han, Johan Hovold, Jonas Meurer, Jonathan Cameron,
Kajol Jain, Kees Cook, Konstantin Khlebnikov, Kuntala, Kranthi,
Lars-Peter Clausen, Lee Jones, Len Brown, Linus Walleij,
Mario Limonciello, Mark Gross, Mathieu Poirier, Maxime Coquelin,
Michael Ellerman, Michael Hennerich, Mika Westerberg, Mike Leach,
Oded Gabbay, Ohad Ben-Cohen, Oleh Kravchenko, Pavel Machek,
Pawan Gupta, Peter Chen, Peter Meerwald-Stadler,
PrasannaKumar Muralidharan, Rasmus Villemoes, Roman Sudarikov,
Russell King, Samuel Thibault, Saravana Kannan,
Sebastian Reichel, Srinivas Kandagatla, Stefan Achatz,
Suzuki K Poulose, Thomas Gleixner, Tom Rix, Luck, Tony,
Vaibhav Jain, Tummalapalli, Vineela, Wu, Hao, ceph-devel,
coresight, dri-devel, linux-acpi, linux-arm-kernel,
linux-f2fs-devel, linux-fpga, linux-gpio, linux-i3c, linux-iio,
linux-kernel, linux-media, linux-pm, linux-remoteproc,
linux-stm32, linuxppc-dev, netdev, Jonathan Cameron
On 2020-10-30 8:40 AM, Mauro Carvalho Chehab wrote:
> 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.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
> 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: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
> Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
sysfs-bus-pci-devices-catpt changes LGTM, thanks.
Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt
Regards,
Czarek
> Documentation/ABI/obsolete/sysfs-class-dax | 8 +-
> .../ABI/obsolete/sysfs-driver-hid-roccat-pyra | 3 +
> Documentation/ABI/removed/devfs | 1 +
> Documentation/ABI/removed/raw1394 | 1 +
> Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
> Documentation/ABI/removed/video1394 | 1 +
> Documentation/ABI/stable/firewire-cdev | 63 ++---
> Documentation/ABI/stable/sysfs-acpi-pmprofile | 4 +-
> Documentation/ABI/stable/sysfs-bus-w1 | 1 +
> Documentation/ABI/stable/sysfs-class-tpm | 4 +-
> Documentation/ABI/stable/sysfs-driver-speakup | 4 +
> Documentation/ABI/testing/configfs-most | 135 +++++++----
> .../ABI/testing/configfs-usb-gadget-ecm | 12 +-
> .../ABI/testing/configfs-usb-gadget-eem | 10 +-
> .../ABI/testing/configfs-usb-gadget-loopback | 6 +-
> .../testing/configfs-usb-gadget-mass-storage | 18 +-
> .../ABI/testing/configfs-usb-gadget-midi | 14 +-
> .../ABI/testing/configfs-usb-gadget-printer | 6 +-
> .../testing/configfs-usb-gadget-sourcesink | 18 +-
> .../ABI/testing/configfs-usb-gadget-subset | 10 +-
> .../ABI/testing/configfs-usb-gadget-uac2 | 14 +-
> .../ABI/testing/configfs-usb-gadget-uvc | 2 +-
> .../ABI/testing/debugfs-cec-error-inj | 2 +-
> .../ABI/testing/debugfs-driver-habanalabs | 12 +-
> .../ABI/testing/debugfs-pfo-nx-crypto | 28 +--
> Documentation/ABI/testing/debugfs-pktcdvd | 2 +-
> .../ABI/testing/debugfs-turris-mox-rwtm | 10 +-
> Documentation/ABI/testing/debugfs-wilco-ec | 21 +-
> Documentation/ABI/testing/dell-smbios-wmi | 32 +--
> Documentation/ABI/testing/gpio-cdev | 13 +-
> Documentation/ABI/testing/procfs-diskstats | 6 +-
> Documentation/ABI/testing/procfs-smaps_rollup | 48 ++--
> Documentation/ABI/testing/pstore | 19 +-
> Documentation/ABI/testing/sysfs-block-rnbd | 4 +-
> Documentation/ABI/testing/sysfs-bus-acpi | 1 +
> .../testing/sysfs-bus-coresight-devices-etb10 | 5 +-
> Documentation/ABI/testing/sysfs-bus-css | 3 +
> Documentation/ABI/testing/sysfs-bus-dfl | 2 +
> .../sysfs-bus-event_source-devices-hv_24x7 | 6 +-
> .../sysfs-bus-event_source-devices-hv_gpci | 7 +-
> Documentation/ABI/testing/sysfs-bus-fcoe | 68 ++++--
> Documentation/ABI/testing/sysfs-bus-fsl-mc | 12 +-
> .../ABI/testing/sysfs-bus-i2c-devices-fsa9480 | 26 +-
> Documentation/ABI/testing/sysfs-bus-i3c | 2 +
> Documentation/ABI/testing/sysfs-bus-iio | 19 +-
> .../ABI/testing/sysfs-bus-iio-adc-hi8435 | 5 +
> .../ABI/testing/sysfs-bus-iio-adc-stm32 | 3 +
> .../ABI/testing/sysfs-bus-iio-distance-srf08 | 7 +-
> .../testing/sysfs-bus-iio-frequency-ad9523 | 2 +
> .../testing/sysfs-bus-iio-frequency-adf4371 | 10 +-
> .../ABI/testing/sysfs-bus-iio-health-afe440x | 12 +-
> .../ABI/testing/sysfs-bus-iio-light-isl29018 | 6 +-
> .../testing/sysfs-bus-intel_th-devices-gth | 11 +-
> Documentation/ABI/testing/sysfs-bus-papr-pmem | 23 +-
> Documentation/ABI/testing/sysfs-bus-pci | 22 +-
> .../ABI/testing/sysfs-bus-pci-devices-catpt | 1 +
> .../testing/sysfs-bus-pci-drivers-ehci_hcd | 4 +-
> Documentation/ABI/testing/sysfs-bus-rbd | 37 ++-
> Documentation/ABI/testing/sysfs-bus-siox | 3 +
> .../ABI/testing/sysfs-bus-thunderbolt | 18 +-
> Documentation/ABI/testing/sysfs-bus-usb | 2 +
> .../sysfs-class-backlight-driver-lm3533 | 26 +-
> Documentation/ABI/testing/sysfs-class-bdi | 1 -
> .../ABI/testing/sysfs-class-chromeos | 15 +-
> Documentation/ABI/testing/sysfs-class-cxl | 8 +-
> Documentation/ABI/testing/sysfs-class-devlink | 30 ++-
> Documentation/ABI/testing/sysfs-class-extcon | 34 +--
> .../ABI/testing/sysfs-class-fpga-manager | 5 +-
> Documentation/ABI/testing/sysfs-class-gnss | 2 +
> Documentation/ABI/testing/sysfs-class-led | 1 +
> .../testing/sysfs-class-led-driver-el15203000 | 30 +--
> .../ABI/testing/sysfs-class-led-driver-lm3533 | 44 ++--
> .../ABI/testing/sysfs-class-led-flash | 27 ++-
> .../testing/sysfs-class-led-trigger-netdev | 7 +
> .../testing/sysfs-class-led-trigger-usbport | 1 +
> .../ABI/testing/sysfs-class-leds-gt683r | 8 +-
> Documentation/ABI/testing/sysfs-class-net | 61 +++--
> .../ABI/testing/sysfs-class-net-cdc_ncm | 6 +-
> .../ABI/testing/sysfs-class-net-phydev | 2 +
> Documentation/ABI/testing/sysfs-class-pktcdvd | 36 +--
> Documentation/ABI/testing/sysfs-class-power | 12 +-
> .../ABI/testing/sysfs-class-power-mp2629 | 1 +
> .../ABI/testing/sysfs-class-power-twl4030 | 4 +-
> Documentation/ABI/testing/sysfs-class-rapidio | 46 ++--
> .../ABI/testing/sysfs-class-regulator | 36 +--
> .../ABI/testing/sysfs-class-remoteproc | 14 +-
> ...ysfs-class-rtc-rtc0-device-rtc_calibration | 1 +
> Documentation/ABI/testing/sysfs-class-uwb_rc | 13 +-
> .../ABI/testing/sysfs-class-watchdog | 7 +-
> Documentation/ABI/testing/sysfs-dev | 7 +-
> .../ABI/testing/sysfs-devices-mapping | 41 ++--
> .../ABI/testing/sysfs-devices-memory | 15 +-
> .../sysfs-devices-platform-_UDC_-gadget | 10 +-
> .../ABI/testing/sysfs-devices-platform-ipmi | 52 ++--
> .../ABI/testing/sysfs-devices-system-cpu | 4 +-
> .../ABI/testing/sysfs-driver-hid-lenovo | 10 +
> .../ABI/testing/sysfs-driver-hid-ntrig | 13 +-
> .../ABI/testing/sysfs-driver-hid-roccat-kone | 19 ++
> .../ABI/testing/sysfs-driver-hid-wiimote | 1 +
> .../ABI/testing/sysfs-driver-input-exc3000 | 2 +
> .../ABI/testing/sysfs-driver-jz4780-efuse | 6 +-
> .../ABI/testing/sysfs-driver-pciback | 6 +-
> Documentation/ABI/testing/sysfs-driver-ufs | 228 ++++++++++++++----
> .../ABI/testing/sysfs-driver-w1_ds28e17 | 3 +
> Documentation/ABI/testing/sysfs-firmware-acpi | 16 +-
> .../ABI/testing/sysfs-firmware-efi-esrt | 28 ++-
> .../testing/sysfs-firmware-efi-runtime-map | 14 +-
> .../ABI/testing/sysfs-firmware-qemu_fw_cfg | 20 +-
> Documentation/ABI/testing/sysfs-firmware-sfi | 6 +-
> .../ABI/testing/sysfs-firmware-sgi_uv | 6 +-
> Documentation/ABI/testing/sysfs-fs-f2fs | 48 ++--
> Documentation/ABI/testing/sysfs-kernel-mm-ksm | 5 +-
> Documentation/ABI/testing/sysfs-kernel-slab | 3 +
> Documentation/ABI/testing/sysfs-module | 17 +-
> .../ABI/testing/sysfs-platform-dell-laptop | 10 +-
> .../ABI/testing/sysfs-platform-dell-smbios | 4 +-
> .../testing/sysfs-platform-i2c-demux-pinctrl | 4 +-
> Documentation/ABI/testing/sysfs-platform-kim | 1 +
> .../testing/sysfs-platform-phy-rcar-gen3-usb2 | 10 +-
> .../ABI/testing/sysfs-platform-renesas_usb3 | 10 +-
> Documentation/ABI/testing/sysfs-power | 21 +-
> Documentation/ABI/testing/sysfs-profiling | 2 +-
> Documentation/ABI/testing/sysfs-wusb_cbaf | 3 +-
> Documentation/ABI/testing/usb-charger-uevent | 82 ++++---
> Documentation/ABI/testing/usb-uevent | 32 +--
> scripts/get_abi.pl | 2 -
> 126 files changed, 1323 insertions(+), 767 deletions(-)
>
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 31/39] docs: ABI: cleanup several ABI documents
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
2020-10-30 8:27 ` [PATCH v2 31/39] docs: ABI: cleanup several ABI documents Rojewski, Cezary
@ 2020-10-30 9:49 ` Suzuki K Poulose
2020-10-30 11:11 ` Ilya Dryomov
` (2 subsequent siblings)
4 siblings, 0 replies; 19+ messages in thread
From: Suzuki K Poulose @ 2020-10-30 9:49 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Gautham R. Shenoy, Jonathan Corbet, Marek Behún,
Marek Marczykowski-Górecki, Pali Rohár,
Peter Zijlstra (Intel), Rafael J. Wysocki, Roger Pau Monné,
Alexander Antonov, Alexander Shishkin, Alexandre Torgue,
Andreas Klinger, Andrew Donnellan, Andrew Lunn, Andy Shevchenko,
Anton Vorontsov, Asutosh Das, Bart Van Assche,
Bartosz Golaszewski, Bjorn Andersson, Bjorn Helgaas,
Boris Brezillon, Boris Ostrovsky, Cezary Rojewski, Chao Yu,
Christian Gromm, Colin Cross, Dan Murphy, Dan Williams,
Daniel Thompson, Danil Kipnis, David Sterba, Dmitry Torokhov,
Dongsheng Yang, Enric Balletbo i Serra, Florian Fainelli,
Frederic Barrat, Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo,
Hans Verkuil, Heiner Kallweit, Ilya Dryomov, Jack Wang,
Jaegeuk Kim, Jarkko Sakkinen, Jason Gunthorpe, Jens Axboe,
Jerry Snitselaar, Jingoo Han, Johan Hovold, Jonas Meurer,
Jonathan Cameron, Kajol Jain, Kees Cook, Konstantin Khlebnikov,
Kranthi Kuntala, Lars-Peter Clausen, Lee Jones, Len Brown,
Linus Walleij, Mario Limonciello, Mark Gross, Mathieu Poirier,
Maxime Coquelin, Michael Ellerman, Michael Hennerich,
Mika Westerberg, Mike Leach, Oded Gabbay, Ohad Ben-Cohen,
Oleh Kravchenko, Pavel Machek, Pawan Gupta, Peter Chen,
Peter Meerwald-Stadler, PrasannaKumar Muralidharan,
Rasmus Villemoes, Roman Sudarikov, Russell King, Samuel Thibault,
Saravana Kannan, Sebastian Reichel, Srinivas Kandagatla,
Stefan Achatz, Thomas Gleixner, Tom Rix, Tony Luck, Vaibhav Jain,
Vineela Tummalapalli, Wu Hao, ceph-devel, coresight, dri-devel,
linux-acpi, linux-arm-kernel, linux-f2fs-devel, linux-fpga,
linux-gpio, linux-i3c, linux-iio, linux-kernel, linux-media,
linux-pm, linux-remoteproc, linux-stm32, linuxppc-dev, netdev,
Jonathan Cameron
On 10/30/20 7:40 AM, Mauro Carvalho Chehab wrote:
> 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.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
> 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: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
> Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> .../testing/sysfs-bus-coresight-devices-etb10 | 5 +-
For the above,
Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com>
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
[not found] ` <5326488b-4185-9d67-fc09-79b911fbb3b8@st.com>
@ 2020-10-30 10:09 ` Mauro Carvalho Chehab
2020-11-02 11:04 ` Fabrice Gasnier
0 siblings, 1 reply; 19+ messages in thread
From: Mauro Carvalho Chehab @ 2020-10-30 10:09 UTC (permalink / raw)
To: Fabrice Gasnier
Cc: Linux Doc Mailing List, Gautham R. Shenoy, Jason A. Donenfeld,
Javier González, Jonathan Corbet, Martin K. Petersen,
Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
Dan Murphy, Dan Williams, Enric Balletbo i Serra, Felipe Balbi,
Frederic Barrat, Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo,
Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
Jonathan Cameron, Juergen Gross, Konstantin Khlebnikov,
Kranthi Kuntala, Lakshmi Ramasubramanian, Lars-Peter Clausen,
Len Brown, Leonid Maksymchuk, Ludovic Desroches,
Mario Limonciello, Mark Gross, Maxime Coquelin, Michael Ellerman,
Mika Westerberg, Mike Kravetz, Mimi Zohar, Nayna Jain,
Nicolas Ferre, Niklas Cassel, Oded Gabbay, Oleh Kravchenko,
Orson Zhai, Pavel Machek, Pawan Gupta, Peter Meerwald-Stadler,
Peter Rosin, Petr Mladek, Philippe Bergheaud, Richard Cochran,
Sebastian Reichel, Sergey Senozhatsky, Stefano Stabellini,
Thinh Nguyen, Thomas Gleixner, Tom Rix, Vaibhav Jain,
Vineela Tummalapalli, Vishal Verma, linux-acpi, linux-arm-kernel,
linux-iio, linux-kernel, linux-mm, linux-pm, linux-stm32,
linux-usb, linuxppc-dev, netdev, xen-devel, Jonathan Cameron
Em Fri, 30 Oct 2020 10:19:12 +0100
Fabrice Gasnier <fabrice.gasnier@st.com> escreveu:
> Hi Mauro,
>
> [...]
>
> >
> > +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> > +KernelVersion: 4.12
> > +Contact: benjamin.gaignard@st.com
> > +Description:
> > + Reading returns the list possible quadrature modes.
> > +
> > +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> > +KernelVersion: 4.12
> > +Contact: benjamin.gaignard@st.com
> > +Description:
> > + Configure the device counter quadrature modes:
> > +
> > + channel_A:
> > + Encoder A input servers as the count input and B as
> > + the UP/DOWN direction control input.
> > +
> > + channel_B:
> > + Encoder B input serves as the count input and A as
> > + the UP/DOWN direction control input.
> > +
> > + quadrature:
> > + Encoder A and B inputs are mixed to get direction
> > + and count with a scale of 0.25.
> > +
>
Hi Fabrice,
> I just noticed that since Jonathan question in v1.
>
> Above ABI has been moved in the past as discussed in [1]. You can take a
> look at:
> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
>
> Could you please remove the above chunk ?
>
> With that, for the stm32 part:
> Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
Hmm... probably those were re-introduced due to a rebase. This
series were originally written about 1,5 years ago.
I'll drop those hunks.
Thanks!
Mauro
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 31/39] docs: ABI: cleanup several ABI documents
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
2020-10-30 8:27 ` [PATCH v2 31/39] docs: ABI: cleanup several ABI documents Rojewski, Cezary
2020-10-30 9:49 ` Suzuki K Poulose
@ 2020-10-30 11:11 ` Ilya Dryomov
2020-10-30 16:42 ` Mathieu Poirier
2020-10-30 23:23 ` Peter Chen
4 siblings, 0 replies; 19+ messages in thread
From: Ilya Dryomov @ 2020-10-30 11:11 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Gautham R. Shenoy, Jonathan Corbet,
Marek Behún, Marek Marczykowski-Górecki,
Pali Rohár, Peter Zijlstra (Intel),
Rafael J. Wysocki, Roger Pau Monné,
Alexander Antonov, Alexander Shishkin, Alexandre Torgue,
Andreas Klinger, Andrew Donnellan, Andrew Lunn, Andy Shevchenko,
Anton Vorontsov, Asutosh Das, Bart Van Assche,
Bartosz Golaszewski, Bjorn Andersson, Bjorn Helgaas,
Boris Brezillon, Boris Ostrovsky, Cezary Rojewski, Chao Yu,
Christian Gromm, Colin Cross, Dan Murphy, Dan Williams,
Daniel Thompson, Danil Kipnis, David Sterba, Dmitry Torokhov,
Dongsheng Yang, Enric Balletbo i Serra, Florian Fainelli,
Frederic Barrat, Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo,
Hans Verkuil, Heiner Kallweit, Jack Wang, Jaegeuk Kim,
Jarkko Sakkinen, Jason Gunthorpe, Jens Axboe, Jerry Snitselaar,
Jingoo Han, Johan Hovold, Jonas Meurer, Jonathan Cameron,
Kajol Jain, Kees Cook, Konstantin Khlebnikov, Kranthi Kuntala,
Lars-Peter Clausen, Lee Jones, Len Brown, Linus Walleij,
Mario Limonciello, Mark Gross, Mathieu Poirier, Maxime Coquelin,
Michael Ellerman, Michael Hennerich, Mika Westerberg, Mike Leach,
Oded Gabbay, Ohad Ben-Cohen, Oleh Kravchenko, Pavel Machek,
Pawan Gupta, Peter Chen, Peter Meerwald-Stadler,
PrasannaKumar Muralidharan, Rasmus Villemoes, Roman Sudarikov,
Russell King, Samuel Thibault, Saravana Kannan,
Sebastian Reichel, Srinivas Kandagatla, Stefan Achatz,
Suzuki K Poulose, Thomas Gleixner, Tom Rix, Tony Luck,
Vaibhav Jain, Vineela Tummalapalli, Wu Hao, Ceph Development,
coresight, dri-devel, linux-acpi, linux-arm-kernel,
linux-f2fs-devel, linux-fpga, linux-gpio, linux-i3c, linux-iio,
LKML, linux-media, linux-pm, linux-remoteproc, linux-stm32,
linuxppc-dev, netdev, Jonathan Cameron
On Fri, Oct 30, 2020 at 8:41 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> 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.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
> 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: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
> Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>
> [...]
>
> Documentation/ABI/testing/sysfs-bus-rbd | 37 ++-
Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd
Thanks,
Ilya
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation
2020-10-30 7:40 ` [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation Mauro Carvalho Chehab
@ 2020-10-30 14:39 ` Rafael J. Wysocki
2020-11-02 5:50 ` Jinpu Wang
2020-11-02 18:39 ` Joseph, Jithu
2 siblings, 0 replies; 19+ messages in thread
From: Rafael J. Wysocki @ 2020-10-30 14:39 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Jonathan Corbet, Rafael J. Wysocki,
Akira Shimahara, Andrew Donnellan, Andy Shevchenko,
Bart Van Assche, Bartlomiej Zolnierkiewicz, Chanwoo Choi,
Christian Gromm, Danil Kipnis, Darren Hart, Evgeniy Polyakov,
Frederic Barrat, Greg Kroah-Hartman, Gregory CLEMENT,
Ivan Zaentsev, Jack Wang, Jason Gunthorpe, Jithu Joseph,
Jolly Shah, Jonathan Cameron, Kamil Konieczny, Lukasz Luba,
Luwei Kang, Marek Behun, Michal Simek, Philippe Bergheaud,
Rajan Vaja, Richard Gong, Sebastian Reichel, Srinivas Pandruvada,
Tejas Patel, Vadim Pasternak, Vaibhav Jain, Wu Hao, Xu Yilun,
Linux ARM, Linux Kernel Mailing List, Linux PM, Platform Driver
On Fri, Oct 30, 2020 at 8:41 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> There are a number of new changes at the ABI files that cause
> them to produce warnings when generating ABI output.
>
> Fix them.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../ABI/stable/sysfs-driver-firmware-zynqmp | 62 ++++++++-----
> Documentation/ABI/testing/debugfs-moxtet | 28 ++++--
> .../ABI/testing/debugfs-turris-mox-rwtm | 6 +-
> .../sysfs-bus-event_source-devices-dfl_fme | 14 +--
> Documentation/ABI/testing/sysfs-bus-most | 6 +-
> Documentation/ABI/testing/sysfs-class-devfreq | 6 +-
> Documentation/ABI/testing/sysfs-class-ocxl | 14 +--
> .../ABI/testing/sysfs-class-power-wilco | 18 ++--
> .../ABI/testing/sysfs-class-rnbd-client | 93 ++++++++++---------
> .../ABI/testing/sysfs-class-rtrs-client | 23 +++--
> .../sysfs-devices-platform-stratix10-rsu | 10 ++
> .../ABI/testing/sysfs-driver-w1_therm | 75 ++++++++++-----
> .../ABI/testing/sysfs-platform-dfl-fme | 14 ++-
> Documentation/ABI/testing/sysfs-platform-dptf | 11 ++-
For the DPTF part
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> .../sysfs-platform-intel-wmi-sbl-fw-update | 1 +
> .../testing/sysfs-platform-mellanox-bootctl | 50 ++++++----
> .../ABI/testing/sysfs-platform-wilco-ec | 1 +
> 17 files changed, 271 insertions(+), 161 deletions(-)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> index 00fa04c76ff3..f5724bb5b462 100644
> --- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> +++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> @@ -12,13 +12,15 @@ Description:
> resets. Three registers are used by the FSBL and
> other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> - # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> - # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
>
> Users: Xilinx
>
> @@ -39,13 +41,15 @@ Description:
> software products: PERS_GLOB_GEN_STORAGE{4:7}.
> Register is reset only by a POR reset.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> - # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> - # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
>
> Users: Xilinx
>
> @@ -61,23 +65,28 @@ Description:
>
> Following are available shutdown scopes(subtypes):
>
> - subsystem: Only the APU along with all of its peripherals
> + subsystem:
> + Only the APU along with all of its peripherals
> not used by other processing units will be
> shut down. This may result in the FPD power
> domain being shut down provided that no other
> processing unit uses FPD peripherals or DRAM.
> - ps_only: The complete PS will be shut down, including the
> + ps_only:
> + The complete PS will be shut down, including the
> RPU, PMU, etc. Only the PL domain (FPGA)
> remains untouched.
> - system: The complete system/device is shut down.
> + system:
> + The complete system/device is shut down.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> - # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> - # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
>
> Users: Xilinx
>
> @@ -94,10 +103,13 @@ Description:
> system restart.
>
> Usage:
> - Set healthy bit
> - # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
>
> - Unset healthy bit
> - # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
> + Set healthy bit::
> +
> + # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
> +
> + Unset healthy bit::
> +
> + # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
>
> Users: Xilinx
> diff --git a/Documentation/ABI/testing/debugfs-moxtet b/Documentation/ABI/testing/debugfs-moxtet
> index 67b1717794d8..15dfaecb2892 100644
> --- a/Documentation/ABI/testing/debugfs-moxtet
> +++ b/Documentation/ABI/testing/debugfs-moxtet
> @@ -5,10 +5,16 @@ Contact: Marek Behún <marek.behun@nic.cz>
> Description: (R) Read input from the shift registers, in hexadecimal.
> Returns N+1 bytes, where N is the number of Moxtet connected
> modules. The first byte is from the CPU board itself.
> - Example: 101214
> - 10: CPU board with SD card
> - 12: 2 = PCIe module, 1 = IRQ not active
> - 14: 4 = Peridot module, 1 = IRQ not active
> +
> + Example::
> +
> + 101214
> +
> + == =======================================
> + 10 CPU board with SD card
> + 12 2 = PCIe module, 1 = IRQ not active
> + 14 4 = Peridot module, 1 = IRQ not active
> + == =======================================
>
> What: /sys/kernel/debug/moxtet/output
> Date: March 2019
> @@ -17,7 +23,13 @@ Contact: Marek Behún <marek.behun@nic.cz>
> Description: (RW) Read last written value to the shift registers, in
> hexadecimal, or write values to the shift registers, also
> in hexadecimal.
> - Example: 0102
> - 01: 01 was last written, or is to be written, to the
> - first module's shift register
> - 02: the same for second module
> +
> + Example::
> +
> + 0102
> +
> + == ================================================
> + 01 01 was last written, or is to be written, to the
> + first module's shift register
> + 02 the same for second module
> + == ================================================
> diff --git a/Documentation/ABI/testing/debugfs-turris-mox-rwtm b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> index 2b3255ee68fd..c8f7dadd591c 100644
> --- a/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> +++ b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> @@ -2,8 +2,10 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign
> Date: Jun 2020
> KernelVersion: 5.8
> Contact: Marek Behún <marek.behun@nic.cz>
> -Description: (W) Message to sign with the ECDSA private key stored in
> +Description: (W)
> + Message to sign with the ECDSA private key stored in
> device's OTP. The message must be exactly 64 bytes (since
> this is intended for SHA-512 hashes).
> - (R) The resulting signature, 136 bytes. This contains the R and
> + (R)
> + The resulting signature, 136 bytes. This contains the R and
> S values of the ECDSA signature, both in big-endian format.
> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme b/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
> index c9278a3b3df1..63a32ddcb95e 100644
> --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
> @@ -8,13 +8,13 @@ Description: Read-only. Attribute group to describe the magic bits
>
> Each attribute under this group defines a bit range of the
> perf_event_attr.config. All supported attributes are listed
> - below.
> + below::
>
> event = "config:0-11" - event ID
> evtype = "config:12-15" - event type
> portid = "config:16-23" - event source
>
> - For example,
> + For example::
>
> fab_mmio_read = "event=0x06,evtype=0x02,portid=0xff"
>
> @@ -40,11 +40,11 @@ Description: Read-only. Attribute group to describe performance monitoring
>
> All supported performance monitoring events are listed below.
>
> - Basic events (evtype=0x00)
> + Basic events (evtype=0x00)::
>
> clock = "event=0x00,evtype=0x00,portid=0xff"
>
> - Cache events (evtype=0x01)
> + Cache events (evtype=0x01)::
>
> cache_read_hit = "event=0x00,evtype=0x01,portid=0xff"
> cache_read_miss = "event=0x01,evtype=0x01,portid=0xff"
> @@ -59,7 +59,7 @@ Description: Read-only. Attribute group to describe performance monitoring
> cache_rx_req_stall = "event=0x09,evtype=0x01,portid=0xff"
> cache_eviction = "event=0x0a,evtype=0x01,portid=0xff"
>
> - Fabric events (evtype=0x02)
> + Fabric events (evtype=0x02)::
>
> fab_pcie0_read = "event=0x00,evtype=0x02,portid=0xff"
> fab_pcie0_write = "event=0x01,evtype=0x02,portid=0xff"
> @@ -78,7 +78,7 @@ Description: Read-only. Attribute group to describe performance monitoring
> fab_port_mmio_read = "event=0x06,evtype=0x02,portid=?"
> fab_port_mmio_write = "event=0x07,evtype=0x02,portid=?"
>
> - VTD events (evtype=0x03)
> + VTD events (evtype=0x03)::
>
> vtd_port_read_transaction = "event=0x00,evtype=0x03,portid=?"
> vtd_port_write_transaction = "event=0x01,evtype=0x03,portid=?"
> @@ -88,7 +88,7 @@ Description: Read-only. Attribute group to describe performance monitoring
> vtd_port_devtlb_2m_fill = "event=0x05,evtype=0x03,portid=?"
> vtd_port_devtlb_1g_fill = "event=0x06,evtype=0x03,portid=?"
>
> - VTD SIP events (evtype=0x04)
> + VTD SIP events (evtype=0x04)::
>
> vtd_sip_iotlb_4k_hit = "event=0x00,evtype=0x04,portid=0xff"
> vtd_sip_iotlb_2m_hit = "event=0x01,evtype=0x04,portid=0xff"
> diff --git a/Documentation/ABI/testing/sysfs-bus-most b/Documentation/ABI/testing/sysfs-bus-most
> index ec0a603d804b..38cc03e408e7 100644
> --- a/Documentation/ABI/testing/sysfs-bus-most
> +++ b/Documentation/ABI/testing/sysfs-bus-most
> @@ -235,7 +235,8 @@ KernelVersion: 4.15
> Contact: Christian Gromm <christian.gromm@microchip.com>
> Description:
> This is to read back the configured direction of the channel.
> - The following strings will be accepted:
> + The following strings will be accepted::
> +
> 'tx',
> 'rx'
> Users:
> @@ -246,7 +247,8 @@ KernelVersion: 4.15
> Contact: Christian Gromm <christian.gromm@microchip.com>
> Description:
> This is to read back the configured data type of the channel.
> - The following strings will be accepted:
> + The following strings will be accepted::
> +
> 'control',
> 'async',
> 'sync',
> diff --git a/Documentation/ABI/testing/sysfs-class-devfreq b/Documentation/ABI/testing/sysfs-class-devfreq
> index 67af3f31e17c..386bc230a33d 100644
> --- a/Documentation/ABI/testing/sysfs-class-devfreq
> +++ b/Documentation/ABI/testing/sysfs-class-devfreq
> @@ -48,7 +48,8 @@ Description:
> driver should provide the list of available frequencies
> with its profile. If need to reset the statistics of devfreq
> behavior on a specific device, enter 0(zero) to 'trans_stat'
> - as following:
> + as following::
> +
> echo 0 > /sys/class/devfreq/.../trans_stat
>
> What: /sys/class/devfreq/.../available_frequencies
> @@ -124,7 +125,8 @@ Description:
> This work timer is used by devfreq workqueue in order to
> monitor the device status such as utilization. The user
> can change the work timer on runtime according to their demand
> - as following:
> + as following::
> +
> echo deferrable > /sys/class/devfreq/.../timer
> echo delayed > /sys/class/devfreq/.../timer
>
> diff --git a/Documentation/ABI/testing/sysfs-class-ocxl b/Documentation/ABI/testing/sysfs-class-ocxl
> index bf33f4fda58f..847a7edc3113 100644
> --- a/Documentation/ABI/testing/sysfs-class-ocxl
> +++ b/Documentation/ABI/testing/sysfs-class-ocxl
> @@ -13,8 +13,8 @@ Description: read only
> where:
>
> ==== ===============================================
> - n: number of currently active contexts, for debug
> - max: maximum number of contexts supported by the AFU
> + n number of currently active contexts, for debug
> + max maximum number of contexts supported by the AFU
> ==== ===============================================
>
> What: /sys/class/ocxl/<afu name>/pp_mmio_size
> @@ -43,7 +43,9 @@ Contact: linuxppc-dev@lists.ozlabs.org
> Description: read/write
> Control whether the FPGA is reloaded on a link reset. Enabled
> through a vendor-specific logic block on the FPGA.
> - 0 Do not reload FPGA image from flash
> - 1 Reload FPGA image from flash
> - unavailable
> - The device does not support this capability
> +
> + =========== ===========================================
> + 0 Do not reload FPGA image from flash
> + 1 Reload FPGA image from flash
> + unavailable The device does not support this capability
> + =========== ===========================================
> diff --git a/Documentation/ABI/testing/sysfs-class-power-wilco b/Documentation/ABI/testing/sysfs-class-power-wilco
> index 84fde1d0ada0..82af180fcaab 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-wilco
> +++ b/Documentation/ABI/testing/sysfs-class-power-wilco
> @@ -4,17 +4,23 @@ KernelVersion: 5.2
> Description:
> What charging algorithm to use:
>
> - Standard: Fully charges battery at a standard rate.
> - Adaptive: Battery settings adaptively optimized based on
> + Standard:
> + Fully charges battery at a standard rate.
> + Adaptive:
> + Battery settings adaptively optimized based on
> typical battery usage pattern.
> - Fast: Battery charges over a shorter period.
> - Trickle: Extends battery lifespan, intended for users who
> + Fast:
> + Battery charges over a shorter period.
> + Trickle:
> + Extends battery lifespan, intended for users who
> primarily use their Chromebook while connected to AC.
> - Custom: A low and high threshold percentage is specified.
> + Custom:
> + A low and high threshold percentage is specified.
> Charging begins when level drops below
> charge_control_start_threshold, and ceases when
> level is above charge_control_end_threshold.
> - Long Life: Customized charge rate for last longer battery life.
> + Long Life:
> + Customized charge rate for last longer battery life.
> On Wilco device this mode is pre-configured in the factory
> through EC's private PID. Swiching to a different mode will
> be denied by Wilco EC when Long Life mode is enabled.
> diff --git a/Documentation/ABI/testing/sysfs-class-rnbd-client b/Documentation/ABI/testing/sysfs-class-rnbd-client
> index c084f203b41e..00c0286733d4 100644
> --- a/Documentation/ABI/testing/sysfs-class-rnbd-client
> +++ b/Documentation/ABI/testing/sysfs-class-rnbd-client
> @@ -5,62 +5,70 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud
> Description: Provide information about RNBD-client.
> All sysfs files that are not read-only provide the usage information on read:
>
> - Example:
> - # cat /sys/class/rnbd-client/ctl/map_device
> + Example::
>
> - > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr>
> - > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side>
> - > [access_mode=<ro|rw|migration>] > map_device
> - >
> - > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
> + # cat /sys/class/rnbd-client/ctl/map_device
> +
> + > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr>
> + > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side>
> + > [access_mode=<ro|rw|migration>] > map_device
> + >
> + > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
>
> What: /sys/class/rnbd-client/ctl/map_device
> Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
> -Description: Expected format is the following:
> +Description: Expected format is the following::
>
> - sessname=<name of the rtrs session>
> - path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
> - device_path=<full path on remote side>
> - [access_mode=<ro|rw|migration>]
> + sessname=<name of the rtrs session>
> + path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
> + device_path=<full path on remote side>
> + [access_mode=<ro|rw|migration>]
>
> Where:
>
> - sessname: accepts a string not bigger than 256 chars, which identifies
> - a given session on the client and on the server.
> - I.e. "clt_hostname-srv_hostname" could be a natural choice.
> + sessname:
> + accepts a string not bigger than 256 chars, which identifies
> + a given session on the client and on the server.
> + I.e. "clt_hostname-srv_hostname" could be a natural choice.
>
> - path: describes a connection between the client and the server by
> - specifying destination and, when required, the source address.
> - The addresses are to be provided in the following format:
> + path:
> + describes a connection between the client and the server by
> + specifying destination and, when required, the source address.
> + The addresses are to be provided in the following format::
>
> - ip:<IPv6>
> - ip:<IPv4>
> - gid:<GID>
> + ip:<IPv6>
> + ip:<IPv4>
> + gid:<GID>
>
> - for example:
> + for example::
> +
> + path=ip:10.0.0.66
>
> - path=ip:10.0.0.66
> The single addr is treated as the destination.
> The connection will be established to this server from any client IP address.
>
> - path=ip:10.0.0.66,ip:10.0.1.66
> + ::
> +
> + path=ip:10.0.0.66,ip:10.0.1.66
> +
> First addr is the source address and the second is the destination.
>
> If multiple "path=" options are specified multiple connection
> will be established and data will be sent according to
> the selected multipath policy (see RTRS mp_policy sysfs entry description).
>
> - device_path: Path to the block device on the server side. Path is specified
> - relative to the directory on server side configured in the
> - 'dev_search_path' module parameter of the rnbd_server.
> - The rnbd_server prepends the <device_path> received from client
> - with <dev_search_path> and tries to open the
> - <dev_search_path>/<device_path> block device. On success,
> - a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/
> - directory and an entry in /sys/class/rnbd-client/ctl/devices
> - will be created.
> + device_path:
> + Path to the block device on the server side. Path is specified
> + relative to the directory on server side configured in the
> + 'dev_search_path' module parameter of the rnbd_server.
> + The rnbd_server prepends the <device_path> received from client
> + with <dev_search_path> and tries to open the
> + <dev_search_path>/<device_path> block device. On success,
> + a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/
> + directory and an entry in /sys/class/rnbd-client/ctl/devices
> + will be created.
>
> If 'dev_search_path' contains '%SESSNAME%', then each session can
> have different devices namespace, e.g. server was configured with
> @@ -68,11 +76,12 @@ Description: Expected format is the following:
> client has this string "sessname=blya device_path=sda", then server
> will try to open: /run/rnbd-devs/blya/sda.
>
> - access_mode: the access_mode parameter specifies if the device is to be
> - mapped as "ro" read-only or "rw" read-write. The server allows
> - a device to be exported in rw mode only once. The "migration"
> - access mode has to be specified if a second mapping in read-write
> - mode is desired.
> + access_mode:
> + the access_mode parameter specifies if the device is to be
> + mapped as "ro" read-only or "rw" read-write. The server allows
> + a device to be exported in rw mode only once. The "migration"
> + access mode has to be specified if a second mapping in read-write
> + mode is desired.
>
> By default "rw" is used.
>
> @@ -91,7 +100,7 @@ Description: Expected format is the following:
> is the same as the device name. By extracting the last part of the
> path the path to the device /dev/<dev-name> can be build.
>
> - o /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev)
> + * /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev)
>
> How to find the <device_id> of the device is described on the next
> section.
> @@ -106,6 +115,6 @@ Description: For each device mapped on the client a new symbolic link is created
> The <device_id> of each device is created as follows:
>
> - If the 'device_path' provided during mapping contains slashes ("/"),
> - they are replaced by exclamation mark ("!") and used as as the
> - <device_id>. Otherwise, the <device_id> will be the same as the
> - "device_path" provided.
> + they are replaced by exclamation mark ("!") and used as as the
> + <device_id>. Otherwise, the <device_id> will be the same as the
> + "device_path" provided.
> diff --git a/Documentation/ABI/testing/sysfs-class-rtrs-client b/Documentation/ABI/testing/sysfs-class-rtrs-client
> index e7e718db8941..0f7165aab251 100644
> --- a/Documentation/ABI/testing/sysfs-class-rtrs-client
> +++ b/Documentation/ABI/testing/sysfs-class-rtrs-client
> @@ -10,10 +10,10 @@ Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
> Description: RW, adds a new path (connection) to an existing session. Expected format is the
> - following:
> + following::
>
> - <[source addr,]destination addr>
> - *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
> + <[source addr,]destination addr>
> + *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
>
> What: /sys/class/rtrs-client/<session-name>/max_reconnect_attempts
> Date: Feb 2020
> @@ -29,10 +29,10 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud
> Description: Multipath policy specifies which path should be selected on each IO:
>
> round-robin (0):
> - select path in per CPU round-robin manner.
> + select path in per CPU round-robin manner.
>
> min-inflight (1):
> - select path with minimum inflights.
> + select path with minimum inflights.
>
> What: /sys/class/rtrs-client/<session-name>/paths/
> Date: Feb 2020
> @@ -109,8 +109,11 @@ Description: RTRS expects that each HCA IRQ is pinned to a separate CPU. If it's
> not the case, the processing of an I/O response could be processed on a
> different CPU than where it was originally submitted. This file shows
> how many interrupts where generated on a non expected CPU.
> - "from:" is the CPU on which the IRQ was expected, but not generated.
> - "to:" is the CPU on which the IRQ was generated, but not expected.
> +
> + "from:"
> + is the CPU on which the IRQ was expected, but not generated.
> + "to:"
> + is the CPU on which the IRQ was generated, but not expected.
>
> What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reconnects
> Date: Feb 2020
> @@ -125,7 +128,7 @@ Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
> Description: Contains statistics regarding rdma operations and inflight operations.
> - The output consists of 6 values:
> + The output consists of 6 values::
>
> - <read-count> <read-total-size> <write-count> <write-total-size> \
> - <inflights> <failovered>
> + <read-count> <read-total-size> <write-count> \
> + <write-total-size> <inflights> <failovered>
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> index a8daceb4a956..ee253b033280 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> @@ -102,6 +102,8 @@ Description:
> b[15:0]
> inform firmware the current software execution
> stage.
> +
> + == ===========================================
> 0 the first stage bootloader didn't run or
> didn't reach the point of launching second
> stage bootloader.
> @@ -111,21 +113,29 @@ Description:
> 2 both first and second stage bootloader ran
> and the operating system launch was
> attempted.
> + == ===========================================
>
> b[16]
> + == ===========================================
> 1 firmware to reset current image retry
> counter.
> 0 no action.
> + == ===========================================
>
> b[17]
> + == ===========================================
> 1 firmware to clear RSU log
> 0 no action.
> + == ===========================================
>
> b[18]
> this is negative logic
> +
> + == ===========================================
> 1 no action
> 0 firmware record the notify code defined
> in b[15:0].
> + == ===========================================
>
> What: /sys/devices/platform/stratix10-rsu.0/dcmf0
> Date: June 2020
> diff --git a/Documentation/ABI/testing/sysfs-driver-w1_therm b/Documentation/ABI/testing/sysfs-driver-w1_therm
> index 8873bbb075cb..6a37dc33ffdb 100644
> --- a/Documentation/ABI/testing/sysfs-driver-w1_therm
> +++ b/Documentation/ABI/testing/sysfs-driver-w1_therm
> @@ -22,8 +22,10 @@ Description:
> device data to its embedded EEPROM, either restore data
> embedded in device EEPROM. Be aware that devices support
> limited EEPROM writing cycles (typical 50k)
> +
> * 'save': save device RAM to EEPROM
> * 'restore': restore EEPROM data in device RAM
> +
> Users: any user space application which wants to communicate with
> w1_term device
>
> @@ -33,9 +35,11 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RO) return the power status by asking the device
> +
> * '0': device parasite powered
> * '1': device externally powered
> * '-xx': xx is kernel error when reading power status
> +
> Users: any user space application which wants to communicate with
> w1_term device
>
> @@ -49,10 +53,12 @@ Description:
> will be changed only in device RAM, so it will be cleared when
> power is lost. Trigger a 'save' to EEPROM command to keep
> values after power-on. Read or write are :
> +
> * '9..14': device resolution in bit
> - or resolution to set in bit
> + or resolution to set in bit
> * '-xx': xx is kernel error when reading the resolution
> * Anything else: do nothing
> +
> Some DS18B20 clones are fixed in 12-bit resolution, so the
> actual resolution is read back from the chip and verified. Error
> is reported if the results differ.
> @@ -65,16 +71,18 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RO) return the temperature in 1/1000 degC.
> +
> * If a bulk read has been triggered, it will directly
> - return the temperature computed when the bulk read
> - occurred, if available. If not yet available, nothing
> - is returned (a debug kernel message is sent), you
> - should retry later on.
> + return the temperature computed when the bulk read
> + occurred, if available. If not yet available, nothing
> + is returned (a debug kernel message is sent), you
> + should retry later on.
> * If no bulk read has been triggered, it will trigger
> - a conversion and send the result. Note that the
> - conversion duration depend on the resolution (if
> - device support this feature). It takes 94ms in 9bits
> - resolution, 750ms for 12bits.
> + a conversion and send the result. Note that the
> + conversion duration depend on the resolution (if
> + device support this feature). It takes 94ms in 9bits
> + resolution, 750ms for 12bits.
> +
> Users: any user space application which wants to communicate with
> w1_term device
>
> @@ -86,12 +94,14 @@ Description:
> (RW) return the temperature in 1/1000 degC.
> *read*: return 2 lines with the hexa output data sent on the
> bus, return the CRC check and temperature in 1/1000 degC
> - *write* :
> + *write*:
> +
> * '0' : save the 2 or 3 bytes to the device EEPROM
> - (i.e. TH, TL and config register)
> + (i.e. TH, TL and config register)
> * '9..14' : set the device resolution in RAM
> - (if supported)
> + (if supported)
> * Anything else: do nothing
> +
> refer to Documentation/w1/slaves/w1_therm.rst for detailed
> information.
> Users: any user space application which wants to communicate with
> @@ -103,14 +113,21 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RW) trigger a bulk read conversion. read the status
> +
> *read*:
> - * '-1': conversion in progress on at least 1 sensor
> - * '1' : conversion complete but at least one sensor
> + * '-1':
> + conversion in progress on at least 1 sensor
> + * '1' :
> + conversion complete but at least one sensor
> value has not been read yet
> - * '0' : no bulk operation. Reading temperature will
> + * '0' :
> + no bulk operation. Reading temperature will
> trigger a conversion on each device
> - *write*: 'trigger': trigger a bulk read on all supporting
> +
> + *write*:
> + 'trigger': trigger a bulk read on all supporting
> devices on the bus
> +
> Note that if a bulk read is sent but one sensor is not read
> immediately, the next access to temperature on this device
> will return the temperature measured at the time of issue
> @@ -128,14 +145,19 @@ Description:
> reset to default (datasheet) conversion time for a new
> resolution.
>
> - *read*: Actual conversion time in milliseconds. *write*:
> - '0': Set the default conversion time from the datasheet.
> - '1': Measure and set the conversion time. Make a single
> + *read*:
> + Actual conversion time in milliseconds.
> +
> + *write*:
> + * '0':
> + Set the default conversion time from the datasheet.
> + * '1':
> + Measure and set the conversion time. Make a single
> temperature conversion, measure an actual value.
> Increase it by 20% for temperature range. A new
> conversion time can be obtained by reading this
> same attribute.
> - other positive value:
> + * other positive value:
> Set the conversion time in milliseconds.
>
> Users: An application using the w1_term device
> @@ -148,16 +170,21 @@ Description:
> (RW) Control optional driver settings.
> Bit masks to read/write (bitwise OR):
>
> - 1: Enable check for conversion success. If byte 6 of
> + == ============================================================
> + 1 Enable check for conversion success. If byte 6 of
> scratchpad memory is 0xC after conversion, and
> temperature reads 85.00 (powerup value) or 127.94
> (insufficient power) - return a conversion error.
>
> - 2: Enable poll for conversion completion. Generate read cycles
> + 2 Enable poll for conversion completion. Generate read cycles
> after the conversion start and wait for 1's. In parasite
> power mode this feature is not available.
> + == ============================================================
>
> - *read*: Currently selected features.
> - *write*: Select features.
> + *read*:
> + Currently selected features.
> +
> + *write*:
> + Select features.
>
> Users: An application using the w1_term device
> diff --git a/Documentation/ABI/testing/sysfs-platform-dfl-fme b/Documentation/ABI/testing/sysfs-platform-dfl-fme
> index 3683cb1cdc3d..d6ab34e81b9b 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dfl-fme
> +++ b/Documentation/ABI/testing/sysfs-platform-dfl-fme
> @@ -113,8 +113,11 @@ KernelVersion: 5.5
> Contact: Wu Hao <hao.wu@intel.com>
> Description: Read-Only. Read this file to get the name of hwmon device, it
> supports values:
> - 'dfl_fme_thermal' - thermal hwmon device name
> - 'dfl_fme_power' - power hwmon device name
> +
> + ================= =========================
> + 'dfl_fme_thermal' thermal hwmon device name
> + 'dfl_fme_power' power hwmon device name
> + ================= =========================
>
> What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input
> Date: October 2019
> @@ -169,8 +172,11 @@ KernelVersion: 5.5
> Contact: Wu Hao <hao.wu@intel.com>
> Description: Read-Only. Read this file to get the policy of hardware threshold1
> (see 'temp1_max'). It only supports two values (policies):
> - 0 - AP2 state (90% throttling)
> - 1 - AP1 state (50% throttling)
> +
> + == ==========================
> + 0 AP2 state (90% throttling)
> + 1 AP1 state (50% throttling)
> + == ==========================
>
> What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_input
> Date: October 2019
> diff --git a/Documentation/ABI/testing/sysfs-platform-dptf b/Documentation/ABI/testing/sysfs-platform-dptf
> index 2cbc660d163b..141834342a4d 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dptf
> +++ b/Documentation/ABI/testing/sysfs-platform-dptf
> @@ -27,12 +27,15 @@ KernelVersion: v4.10
> Contact: linux-acpi@vger.kernel.org
> Description:
> (RO) Display the platform power source
> +
> + ========= ============================
> bits[3:0] Current power source
> - 0x00 = DC
> - 0x01 = AC
> - 0x02 = USB
> - 0x03 = Wireless Charger
> + - 0x00 = DC
> + - 0x01 = AC
> + - 0x02 = USB
> + - 0x03 = Wireless Charger
> bits[7:4] Power source sequence number
> + ========= ============================
>
> What: /sys/bus/platform/devices/INT3407:00/dptf_power/battery_steady_power
> Date: Jul, 2016
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
> index 5aa618987cad..02ae1e9bbfc8 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
> @@ -8,5 +8,6 @@ Description:
> of 0 and userspace can signal SBL to update firmware,
> on next reboot, by writing a value of 1.
> There are two available states:
> +
> * 0 -> Skip firmware update while rebooting
> * 1 -> Attempt firmware update on next reboot
> diff --git a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> index 401d202f478b..e79ca22e2f45 100644
> --- a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> +++ b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> @@ -5,10 +5,13 @@ Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The Life-cycle state of the SoC, which could be one of the
> following values.
> - Production - Production state and can be updated to secure
> - GA Secured - Secure chip and not able to change state
> - GA Non-Secured - Non-Secure chip and not able to change state
> - RMA - Return Merchandise Authorization
> +
> + ============== =============================================
> + Production Production state and can be updated to secure
> + GA Secured Secure chip and not able to change state
> + GA Non-Secured Non-Secure chip and not able to change state
> + RMA Return Merchandise Authorization
> + ============== =============================================
>
> What: /sys/bus/platform/devices/MLNXBF04:00/post_reset_wdog
> Date: Oct 2019
> @@ -25,10 +28,13 @@ KernelVersion: 5.5
> Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The source of the boot stream for the next reset. It could be
> - one of the following values.
> - external - boot from external source (USB or PCIe)
> - emmc - boot from the onchip eMMC
> - emmc_legacy - boot from the onchip eMMC in legacy (slow) mode
> + one of the following values:
> +
> + =========== ===============================================
> + external boot from external source (USB or PCIe)
> + emmc boot from the onchip eMMC
> + emmc_legacy boot from the onchip eMMC in legacy (slow) mode
> + =========== ===============================================
>
> What: /sys/bus/platform/devices/MLNXBF04:00/second_reset_action
> Date: Oct 2019
> @@ -38,11 +44,14 @@ Description:
> Update the source of the boot stream after next reset. It could
> be one of the following values and will be applied after next
> reset.
> - external - boot from external source (USB or PCIe)
> - emmc - boot from the onchip eMMC
> - emmc_legacy - boot from the onchip eMMC in legacy (slow) mode
> - swap_emmc - swap the primary / secondary boot partition
> - none - cancel the action
> +
> + =========== ===============================================
> + external boot from external source (USB or PCIe)
> + emmc boot from the onchip eMMC
> + emmc_legacy boot from the onchip eMMC in legacy (slow) mode
> + swap_emmc swap the primary / secondary boot partition
> + none cancel the action
> + =========== ===============================================
>
> What: /sys/bus/platform/devices/MLNXBF04:00/secure_boot_fuse_state
> Date: Oct 2019
> @@ -50,9 +59,12 @@ KernelVersion: 5.5
> Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The state of eFuse versions with the following values.
> - InUse - burnt, valid and currently in use
> - Used - burnt and valid
> - Free - not burnt and free to use
> - Skipped - not burnt but not free (skipped)
> - Wasted - burnt and invalid
> - Invalid - not burnt but marked as valid (error state).
> +
> + ======= ===============================================
> + InUse burnt, valid and currently in use
> + Used burnt and valid
> + Free not burnt and free to use
> + Skipped not burnt but not free (skipped)
> + Wasted burnt and invalid
> + Invalid not burnt but marked as valid (error state).
> + ======= ===============================================
> diff --git a/Documentation/ABI/testing/sysfs-platform-wilco-ec b/Documentation/ABI/testing/sysfs-platform-wilco-ec
> index 5f60b184a5a5..4439d0644091 100644
> --- a/Documentation/ABI/testing/sysfs-platform-wilco-ec
> +++ b/Documentation/ABI/testing/sysfs-platform-wilco-ec
> @@ -39,6 +39,7 @@ Description:
> which affects charging via the special USB PowerShare port
> (marked with a small lightning bolt or battery icon) when in
> low power states:
> +
> - In S0, the port will always provide power.
> - In S0ix, if usb_charge is enabled, then power will be
> supplied to the port when on AC or if battery is > 50%.
> --
> 2.26.2
>
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 31/39] docs: ABI: cleanup several ABI documents
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
` (2 preceding siblings ...)
2020-10-30 11:11 ` Ilya Dryomov
@ 2020-10-30 16:42 ` Mathieu Poirier
2020-10-30 23:23 ` Peter Chen
4 siblings, 0 replies; 19+ messages in thread
From: Mathieu Poirier @ 2020-10-30 16:42 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Gautham R. Shenoy, Jonathan Corbet,
Marek Behún, Marek Marczykowski-Górecki,
Pali Rohár, Peter Zijlstra (Intel),
Rafael J. Wysocki, Roger Pau Monné,
Alexander Antonov, Alexander Shishkin, Alexandre Torgue,
Andreas Klinger, Andrew Donnellan, Andrew Lunn, Andy Shevchenko,
Anton Vorontsov, Asutosh Das, Bart Van Assche,
Bartosz Golaszewski, Bjorn Andersson, Bjorn Helgaas,
Boris Brezillon, Boris Ostrovsky, Cezary Rojewski, Chao Yu,
Christian Gromm, Colin Cross, Dan Murphy, Dan Williams,
Daniel Thompson, Danil Kipnis, David Sterba, Dmitry Torokhov,
Dongsheng Yang, Enric Balletbo i Serra, Florian Fainelli,
Frederic Barrat, Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo,
Hans Verkuil, Heiner Kallweit, Ilya Dryomov, Jack Wang,
Jaegeuk Kim, Jarkko Sakkinen, Jason Gunthorpe, Jens Axboe,
Jerry Snitselaar, Jingoo Han, Johan Hovold, Jonas Meurer,
Jonathan Cameron, Kajol Jain, Kees Cook, Konstantin Khlebnikov,
Kranthi Kuntala, Lars-Peter Clausen, Lee Jones, Len Brown,
Linus Walleij, Mario Limonciello, Mark Gross, Maxime Coquelin,
Michael Ellerman, Michael Hennerich, Mika Westerberg, Mike Leach,
Oded Gabbay, Ohad Ben-Cohen, Oleh Kravchenko, Pavel Machek,
Pawan Gupta, Peter Chen, Peter Meerwald-Stadler,
PrasannaKumar Muralidharan, Rasmus Villemoes, Roman Sudarikov,
Russell King, Samuel Thibault, Saravana Kannan,
Sebastian Reichel, Srinivas Kandagatla, Stefan Achatz,
Suzuki K Poulose, Thomas Gleixner, Tom Rix, Tony Luck,
Vaibhav Jain, Vineela Tummalapalli, Wu Hao, ceph-devel,
Coresight ML, dri-devel, linux-acpi, linux-arm-kernel,
linux-f2fs-devel, linux-fpga, linux-gpio, linux-i3c, linux-iio,
Linux Kernel Mailing List, linux-media, linux-pm,
linux-remoteproc, linux-stm32, linuxppc-dev, netdev,
Jonathan Cameron
On Fri, 30 Oct 2020 at 01:41, Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> 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.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
> 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: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
> Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../testing/sysfs-bus-coresight-devices-etb10 | 5 +-
For the CoreSight part:
Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org>
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
[not found] ` <58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org>
[not found] ` <5326488b-4185-9d67-fc09-79b911fbb3b8@st.com>
@ 2020-10-30 17:26 ` Frederic Barrat
1 sibling, 0 replies; 19+ messages in thread
From: Frederic Barrat @ 2020-10-30 17:26 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Gautham R. Shenoy, Jason A. Donenfeld, Javier González,
Jonathan Corbet, Martin K. Petersen, Rafael J. Wysocki,
Alexander Shishkin, Alexandre Belloni, Alexandre Torgue,
Andrew Donnellan, Andy Shevchenko, Baolin Wang, Benson Leung,
Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang, Dan Murphy,
Dan Williams, Enric Balletbo i Serra, Fabrice Gasnier,
Felipe Balbi, Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo,
Heikki Krogerus, Jens Axboe, Johannes Thumshirn,
Jonathan Cameron, Juergen Gross, Konstantin Khlebnikov,
Kranthi Kuntala, Lakshmi Ramasubramanian, Lars-Peter Clausen,
Len Brown, Leonid Maksymchuk, Ludovic Desroches,
Mario Limonciello, Mark Gross, Maxime Coquelin, Michael Ellerman,
Mika Westerberg, Mike Kravetz, Mimi Zohar, Nayna Jain,
Nicolas Ferre, Niklas Cassel, Oded Gabbay, Oleh Kravchenko,
Orson Zhai, Pavel Machek, Pawan Gupta, Peter Meerwald-Stadler,
Peter Rosin, Petr Mladek, Philippe Bergheaud, Richard Cochran,
Sebastian Reichel, Sergey Senozhatsky, Stefano Stabellini,
Thinh Nguyen, Thomas Gleixner, Tom Rix, Vaibhav Jain,
Vineela Tummalapalli, Vishal Verma, linux-acpi, linux-arm-kernel,
linux-iio, linux-kernel, linux-mm, linux-pm, linux-stm32,
linux-usb, linuxppc-dev, netdev, xen-devel, Jonathan Cameron
Le 30/10/2020 à 08:40, Mauro Carvalho Chehab a écrit :
> Some files over there won't parse well by Sphinx.
>
> Fix them.
>
> Acked-by: Jonathan Cameron<Jonathan.Cameron@huawei.com> # for IIO
> Signed-off-by: Mauro Carvalho Chehab<mchehab+huawei@kernel.org>
> ---
...
> Documentation/ABI/testing/sysfs-class-cxl | 15 +-
...
> Documentation/ABI/testing/sysfs-class-ocxl | 3 +
Patches 20, 28 and 31 look good for cxl and ocxl.
Acked-by: Frederic Barrat <fbarrat@linux.ibm.com>
Fred
^ permalink raw reply [flat|nested] 19+ messages in thread
* RE: [PATCH v2 31/39] docs: ABI: cleanup several ABI documents
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
` (3 preceding siblings ...)
2020-10-30 16:42 ` Mathieu Poirier
@ 2020-10-30 23:23 ` Peter Chen
4 siblings, 0 replies; 19+ messages in thread
From: Peter Chen @ 2020-10-30 23:23 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Gautham R. Shenoy, Jonathan Corbet, Marek Behún,
Marek Marczykowski-Górecki, Pali Rohár,
Peter Zijlstra (Intel), Rafael J. Wysocki, Roger Pau Monné,
Alexander Antonov, Alexander Shishkin, Alexandre Torgue,
Andreas Klinger, Andrew Donnellan, Andrew Lunn, Andy Shevchenko,
Anton Vorontsov, Asutosh Das, Bart Van Assche,
Bartosz Golaszewski, Bjorn Andersson, Bjorn Helgaas,
Boris Brezillon, Boris Ostrovsky, Cezary Rojewski, Chao Yu,
Christian Gromm, Colin Cross, Dan Murphy, Dan Williams,
Daniel Thompson, Danil Kipnis, David Sterba, Dmitry Torokhov,
Dongsheng Yang, Enric Balletbo i Serra, Florian Fainelli,
Frederic Barrat, Greg Kroah-Hartman, Guenter Roeck, Hanjun Guo,
Hans Verkuil, Heiner Kallweit, Ilya Dryomov, Jack Wang,
Jaegeuk Kim, Jarkko Sakkinen, Jason Gunthorpe, Jens Axboe,
Jerry Snitselaar, Jingoo Han, Johan Hovold, Jonas Meurer,
Jonathan Cameron, Kajol Jain, Kees Cook, Konstantin Khlebnikov,
Kranthi Kuntala, Lars-Peter Clausen, Lee Jones, Len Brown,
Linus Walleij, Mario Limonciello, Mark Gross, Mathieu Poirier,
Maxime Coquelin, Michael Ellerman, Michael Hennerich,
Mika Westerberg, Mike Leach, Oded Gabbay, Ohad Ben-Cohen,
Oleh Kravchenko, Pavel Machek, Pawan Gupta,
Peter Meerwald-Stadler, PrasannaKumar Muralidharan,
Rasmus Villemoes, Roman Sudarikov, Russell King, Samuel Thibault,
Saravana Kannan, Sebastian Reichel, Srinivas Kandagatla,
Stefan Achatz, Suzuki K Poulose, Thomas Gleixner, Tom Rix,
Tony Luck, Vaibhav Jain, Vineela Tummalapalli, Wu Hao,
ceph-devel, coresight, dri-devel, linux-acpi, linux-arm-kernel,
linux-f2fs-devel, linux-fpga, linux-gpio, linux-i3c, linux-iio,
linux-kernel, linux-media, linux-pm, linux-remoteproc,
linux-stm32, linuxppc-dev, netdev, Jonathan Cameron
Acked-by: Peter Chen <peter.chen@nxp.com>
For:
Documentation/ABI/testing/usb-charger-uevent
Peter
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation
2020-10-30 7:40 ` [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation Mauro Carvalho Chehab
2020-10-30 14:39 ` Rafael J. Wysocki
@ 2020-11-02 5:50 ` Jinpu Wang
2020-11-02 18:39 ` Joseph, Jithu
2 siblings, 0 replies; 19+ messages in thread
From: Jinpu Wang @ 2020-11-02 5:50 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Jonathan Corbet, Rafael J. Wysocki,
Akira Shimahara, Andrew Donnellan, Andy Shevchenko,
Bart Van Assche, Bartlomiej Zolnierkiewicz, Chanwoo Choi,
Christian Gromm, Danil Kipnis, Darren Hart, Evgeniy Polyakov,
Frederic Barrat, Greg Kroah-Hartman, Gregory CLEMENT,
Ivan Zaentsev, Jason Gunthorpe, Jithu Joseph, Jolly Shah,
Jonathan Cameron, Kamil Konieczny, Lukasz Luba, Luwei Kang,
Marek Behun, Michal Simek, Philippe Bergheaud, Rajan Vaja,
Richard Gong, Sebastian Reichel, Srinivas Pandruvada,
Tejas Patel, Vadim Pasternak, Vaibhav Jain, Wu Hao, Xu Yilun,
linux-arm-kernel, linux-kernel, linux-pm, platform-driver-x86
On Fri, Oct 30, 2020 at 8:41 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> There are a number of new changes at the ABI files that cause
> them to produce warnings when generating ABI output.
>
> Fix them.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../ABI/stable/sysfs-driver-firmware-zynqmp | 62 ++++++++-----
> Documentation/ABI/testing/debugfs-moxtet | 28 ++++--
> .../ABI/testing/debugfs-turris-mox-rwtm | 6 +-
> .../sysfs-bus-event_source-devices-dfl_fme | 14 +--
> Documentation/ABI/testing/sysfs-bus-most | 6 +-
> Documentation/ABI/testing/sysfs-class-devfreq | 6 +-
> Documentation/ABI/testing/sysfs-class-ocxl | 14 +--
> .../ABI/testing/sysfs-class-power-wilco | 18 ++--
> .../ABI/testing/sysfs-class-rnbd-client | 93 ++++++++++---------
> .../ABI/testing/sysfs-class-rtrs-client | 23 +++--
For rnbd/rtrs, looks good to me, thanks!
Acked-by: Jack Wang <jinpu.wang@cloud.ionos.com>
> .../sysfs-devices-platform-stratix10-rsu | 10 ++
> .../ABI/testing/sysfs-driver-w1_therm | 75 ++++++++++-----
> .../ABI/testing/sysfs-platform-dfl-fme | 14 ++-
> Documentation/ABI/testing/sysfs-platform-dptf | 11 ++-
> .../sysfs-platform-intel-wmi-sbl-fw-update | 1 +
> .../testing/sysfs-platform-mellanox-bootctl | 50 ++++++----
> .../ABI/testing/sysfs-platform-wilco-ec | 1 +
> 17 files changed, 271 insertions(+), 161 deletions(-)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> index 00fa04c76ff3..f5724bb5b462 100644
> --- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> +++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> @@ -12,13 +12,15 @@ Description:
> resets. Three registers are used by the FSBL and
> other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> - # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> - # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
>
> Users: Xilinx
>
> @@ -39,13 +41,15 @@ Description:
> software products: PERS_GLOB_GEN_STORAGE{4:7}.
> Register is reset only by a POR reset.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> - # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> - # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
>
> Users: Xilinx
>
> @@ -61,23 +65,28 @@ Description:
>
> Following are available shutdown scopes(subtypes):
>
> - subsystem: Only the APU along with all of its peripherals
> + subsystem:
> + Only the APU along with all of its peripherals
> not used by other processing units will be
> shut down. This may result in the FPD power
> domain being shut down provided that no other
> processing unit uses FPD peripherals or DRAM.
> - ps_only: The complete PS will be shut down, including the
> + ps_only:
> + The complete PS will be shut down, including the
> RPU, PMU, etc. Only the PL domain (FPGA)
> remains untouched.
> - system: The complete system/device is shut down.
> + system:
> + The complete system/device is shut down.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> - # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> - # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
>
> Users: Xilinx
>
> @@ -94,10 +103,13 @@ Description:
> system restart.
>
> Usage:
> - Set healthy bit
> - # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
>
> - Unset healthy bit
> - # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
> + Set healthy bit::
> +
> + # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
> +
> + Unset healthy bit::
> +
> + # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
>
> Users: Xilinx
> diff --git a/Documentation/ABI/testing/debugfs-moxtet b/Documentation/ABI/testing/debugfs-moxtet
> index 67b1717794d8..15dfaecb2892 100644
> --- a/Documentation/ABI/testing/debugfs-moxtet
> +++ b/Documentation/ABI/testing/debugfs-moxtet
> @@ -5,10 +5,16 @@ Contact: Marek Behún <marek.behun@nic.cz>
> Description: (R) Read input from the shift registers, in hexadecimal.
> Returns N+1 bytes, where N is the number of Moxtet connected
> modules. The first byte is from the CPU board itself.
> - Example: 101214
> - 10: CPU board with SD card
> - 12: 2 = PCIe module, 1 = IRQ not active
> - 14: 4 = Peridot module, 1 = IRQ not active
> +
> + Example::
> +
> + 101214
> +
> + == =======================================
> + 10 CPU board with SD card
> + 12 2 = PCIe module, 1 = IRQ not active
> + 14 4 = Peridot module, 1 = IRQ not active
> + == =======================================
>
> What: /sys/kernel/debug/moxtet/output
> Date: March 2019
> @@ -17,7 +23,13 @@ Contact: Marek Behún <marek.behun@nic.cz>
> Description: (RW) Read last written value to the shift registers, in
> hexadecimal, or write values to the shift registers, also
> in hexadecimal.
> - Example: 0102
> - 01: 01 was last written, or is to be written, to the
> - first module's shift register
> - 02: the same for second module
> +
> + Example::
> +
> + 0102
> +
> + == ================================================
> + 01 01 was last written, or is to be written, to the
> + first module's shift register
> + 02 the same for second module
> + == ================================================
> diff --git a/Documentation/ABI/testing/debugfs-turris-mox-rwtm b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> index 2b3255ee68fd..c8f7dadd591c 100644
> --- a/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> +++ b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> @@ -2,8 +2,10 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign
> Date: Jun 2020
> KernelVersion: 5.8
> Contact: Marek Behún <marek.behun@nic.cz>
> -Description: (W) Message to sign with the ECDSA private key stored in
> +Description: (W)
> + Message to sign with the ECDSA private key stored in
> device's OTP. The message must be exactly 64 bytes (since
> this is intended for SHA-512 hashes).
> - (R) The resulting signature, 136 bytes. This contains the R and
> + (R)
> + The resulting signature, 136 bytes. This contains the R and
> S values of the ECDSA signature, both in big-endian format.
> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme b/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
> index c9278a3b3df1..63a32ddcb95e 100644
> --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
> @@ -8,13 +8,13 @@ Description: Read-only. Attribute group to describe the magic bits
>
> Each attribute under this group defines a bit range of the
> perf_event_attr.config. All supported attributes are listed
> - below.
> + below::
>
> event = "config:0-11" - event ID
> evtype = "config:12-15" - event type
> portid = "config:16-23" - event source
>
> - For example,
> + For example::
>
> fab_mmio_read = "event=0x06,evtype=0x02,portid=0xff"
>
> @@ -40,11 +40,11 @@ Description: Read-only. Attribute group to describe performance monitoring
>
> All supported performance monitoring events are listed below.
>
> - Basic events (evtype=0x00)
> + Basic events (evtype=0x00)::
>
> clock = "event=0x00,evtype=0x00,portid=0xff"
>
> - Cache events (evtype=0x01)
> + Cache events (evtype=0x01)::
>
> cache_read_hit = "event=0x00,evtype=0x01,portid=0xff"
> cache_read_miss = "event=0x01,evtype=0x01,portid=0xff"
> @@ -59,7 +59,7 @@ Description: Read-only. Attribute group to describe performance monitoring
> cache_rx_req_stall = "event=0x09,evtype=0x01,portid=0xff"
> cache_eviction = "event=0x0a,evtype=0x01,portid=0xff"
>
> - Fabric events (evtype=0x02)
> + Fabric events (evtype=0x02)::
>
> fab_pcie0_read = "event=0x00,evtype=0x02,portid=0xff"
> fab_pcie0_write = "event=0x01,evtype=0x02,portid=0xff"
> @@ -78,7 +78,7 @@ Description: Read-only. Attribute group to describe performance monitoring
> fab_port_mmio_read = "event=0x06,evtype=0x02,portid=?"
> fab_port_mmio_write = "event=0x07,evtype=0x02,portid=?"
>
> - VTD events (evtype=0x03)
> + VTD events (evtype=0x03)::
>
> vtd_port_read_transaction = "event=0x00,evtype=0x03,portid=?"
> vtd_port_write_transaction = "event=0x01,evtype=0x03,portid=?"
> @@ -88,7 +88,7 @@ Description: Read-only. Attribute group to describe performance monitoring
> vtd_port_devtlb_2m_fill = "event=0x05,evtype=0x03,portid=?"
> vtd_port_devtlb_1g_fill = "event=0x06,evtype=0x03,portid=?"
>
> - VTD SIP events (evtype=0x04)
> + VTD SIP events (evtype=0x04)::
>
> vtd_sip_iotlb_4k_hit = "event=0x00,evtype=0x04,portid=0xff"
> vtd_sip_iotlb_2m_hit = "event=0x01,evtype=0x04,portid=0xff"
> diff --git a/Documentation/ABI/testing/sysfs-bus-most b/Documentation/ABI/testing/sysfs-bus-most
> index ec0a603d804b..38cc03e408e7 100644
> --- a/Documentation/ABI/testing/sysfs-bus-most
> +++ b/Documentation/ABI/testing/sysfs-bus-most
> @@ -235,7 +235,8 @@ KernelVersion: 4.15
> Contact: Christian Gromm <christian.gromm@microchip.com>
> Description:
> This is to read back the configured direction of the channel.
> - The following strings will be accepted:
> + The following strings will be accepted::
> +
> 'tx',
> 'rx'
> Users:
> @@ -246,7 +247,8 @@ KernelVersion: 4.15
> Contact: Christian Gromm <christian.gromm@microchip.com>
> Description:
> This is to read back the configured data type of the channel.
> - The following strings will be accepted:
> + The following strings will be accepted::
> +
> 'control',
> 'async',
> 'sync',
> diff --git a/Documentation/ABI/testing/sysfs-class-devfreq b/Documentation/ABI/testing/sysfs-class-devfreq
> index 67af3f31e17c..386bc230a33d 100644
> --- a/Documentation/ABI/testing/sysfs-class-devfreq
> +++ b/Documentation/ABI/testing/sysfs-class-devfreq
> @@ -48,7 +48,8 @@ Description:
> driver should provide the list of available frequencies
> with its profile. If need to reset the statistics of devfreq
> behavior on a specific device, enter 0(zero) to 'trans_stat'
> - as following:
> + as following::
> +
> echo 0 > /sys/class/devfreq/.../trans_stat
>
> What: /sys/class/devfreq/.../available_frequencies
> @@ -124,7 +125,8 @@ Description:
> This work timer is used by devfreq workqueue in order to
> monitor the device status such as utilization. The user
> can change the work timer on runtime according to their demand
> - as following:
> + as following::
> +
> echo deferrable > /sys/class/devfreq/.../timer
> echo delayed > /sys/class/devfreq/.../timer
>
> diff --git a/Documentation/ABI/testing/sysfs-class-ocxl b/Documentation/ABI/testing/sysfs-class-ocxl
> index bf33f4fda58f..847a7edc3113 100644
> --- a/Documentation/ABI/testing/sysfs-class-ocxl
> +++ b/Documentation/ABI/testing/sysfs-class-ocxl
> @@ -13,8 +13,8 @@ Description: read only
> where:
>
> ==== ===============================================
> - n: number of currently active contexts, for debug
> - max: maximum number of contexts supported by the AFU
> + n number of currently active contexts, for debug
> + max maximum number of contexts supported by the AFU
> ==== ===============================================
>
> What: /sys/class/ocxl/<afu name>/pp_mmio_size
> @@ -43,7 +43,9 @@ Contact: linuxppc-dev@lists.ozlabs.org
> Description: read/write
> Control whether the FPGA is reloaded on a link reset. Enabled
> through a vendor-specific logic block on the FPGA.
> - 0 Do not reload FPGA image from flash
> - 1 Reload FPGA image from flash
> - unavailable
> - The device does not support this capability
> +
> + =========== ===========================================
> + 0 Do not reload FPGA image from flash
> + 1 Reload FPGA image from flash
> + unavailable The device does not support this capability
> + =========== ===========================================
> diff --git a/Documentation/ABI/testing/sysfs-class-power-wilco b/Documentation/ABI/testing/sysfs-class-power-wilco
> index 84fde1d0ada0..82af180fcaab 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-wilco
> +++ b/Documentation/ABI/testing/sysfs-class-power-wilco
> @@ -4,17 +4,23 @@ KernelVersion: 5.2
> Description:
> What charging algorithm to use:
>
> - Standard: Fully charges battery at a standard rate.
> - Adaptive: Battery settings adaptively optimized based on
> + Standard:
> + Fully charges battery at a standard rate.
> + Adaptive:
> + Battery settings adaptively optimized based on
> typical battery usage pattern.
> - Fast: Battery charges over a shorter period.
> - Trickle: Extends battery lifespan, intended for users who
> + Fast:
> + Battery charges over a shorter period.
> + Trickle:
> + Extends battery lifespan, intended for users who
> primarily use their Chromebook while connected to AC.
> - Custom: A low and high threshold percentage is specified.
> + Custom:
> + A low and high threshold percentage is specified.
> Charging begins when level drops below
> charge_control_start_threshold, and ceases when
> level is above charge_control_end_threshold.
> - Long Life: Customized charge rate for last longer battery life.
> + Long Life:
> + Customized charge rate for last longer battery life.
> On Wilco device this mode is pre-configured in the factory
> through EC's private PID. Swiching to a different mode will
> be denied by Wilco EC when Long Life mode is enabled.
> diff --git a/Documentation/ABI/testing/sysfs-class-rnbd-client b/Documentation/ABI/testing/sysfs-class-rnbd-client
> index c084f203b41e..00c0286733d4 100644
> --- a/Documentation/ABI/testing/sysfs-class-rnbd-client
> +++ b/Documentation/ABI/testing/sysfs-class-rnbd-client
> @@ -5,62 +5,70 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud
> Description: Provide information about RNBD-client.
> All sysfs files that are not read-only provide the usage information on read:
>
> - Example:
> - # cat /sys/class/rnbd-client/ctl/map_device
> + Example::
>
> - > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr>
> - > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side>
> - > [access_mode=<ro|rw|migration>] > map_device
> - >
> - > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
> + # cat /sys/class/rnbd-client/ctl/map_device
> +
> + > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr>
> + > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side>
> + > [access_mode=<ro|rw|migration>] > map_device
> + >
> + > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
>
> What: /sys/class/rnbd-client/ctl/map_device
> Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
> -Description: Expected format is the following:
> +Description: Expected format is the following::
>
> - sessname=<name of the rtrs session>
> - path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
> - device_path=<full path on remote side>
> - [access_mode=<ro|rw|migration>]
> + sessname=<name of the rtrs session>
> + path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
> + device_path=<full path on remote side>
> + [access_mode=<ro|rw|migration>]
>
> Where:
>
> - sessname: accepts a string not bigger than 256 chars, which identifies
> - a given session on the client and on the server.
> - I.e. "clt_hostname-srv_hostname" could be a natural choice.
> + sessname:
> + accepts a string not bigger than 256 chars, which identifies
> + a given session on the client and on the server.
> + I.e. "clt_hostname-srv_hostname" could be a natural choice.
>
> - path: describes a connection between the client and the server by
> - specifying destination and, when required, the source address.
> - The addresses are to be provided in the following format:
> + path:
> + describes a connection between the client and the server by
> + specifying destination and, when required, the source address.
> + The addresses are to be provided in the following format::
>
> - ip:<IPv6>
> - ip:<IPv4>
> - gid:<GID>
> + ip:<IPv6>
> + ip:<IPv4>
> + gid:<GID>
>
> - for example:
> + for example::
> +
> + path=ip:10.0.0.66
>
> - path=ip:10.0.0.66
> The single addr is treated as the destination.
> The connection will be established to this server from any client IP address.
>
> - path=ip:10.0.0.66,ip:10.0.1.66
> + ::
> +
> + path=ip:10.0.0.66,ip:10.0.1.66
> +
> First addr is the source address and the second is the destination.
>
> If multiple "path=" options are specified multiple connection
> will be established and data will be sent according to
> the selected multipath policy (see RTRS mp_policy sysfs entry description).
>
> - device_path: Path to the block device on the server side. Path is specified
> - relative to the directory on server side configured in the
> - 'dev_search_path' module parameter of the rnbd_server.
> - The rnbd_server prepends the <device_path> received from client
> - with <dev_search_path> and tries to open the
> - <dev_search_path>/<device_path> block device. On success,
> - a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/
> - directory and an entry in /sys/class/rnbd-client/ctl/devices
> - will be created.
> + device_path:
> + Path to the block device on the server side. Path is specified
> + relative to the directory on server side configured in the
> + 'dev_search_path' module parameter of the rnbd_server.
> + The rnbd_server prepends the <device_path> received from client
> + with <dev_search_path> and tries to open the
> + <dev_search_path>/<device_path> block device. On success,
> + a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/
> + directory and an entry in /sys/class/rnbd-client/ctl/devices
> + will be created.
>
> If 'dev_search_path' contains '%SESSNAME%', then each session can
> have different devices namespace, e.g. server was configured with
> @@ -68,11 +76,12 @@ Description: Expected format is the following:
> client has this string "sessname=blya device_path=sda", then server
> will try to open: /run/rnbd-devs/blya/sda.
>
> - access_mode: the access_mode parameter specifies if the device is to be
> - mapped as "ro" read-only or "rw" read-write. The server allows
> - a device to be exported in rw mode only once. The "migration"
> - access mode has to be specified if a second mapping in read-write
> - mode is desired.
> + access_mode:
> + the access_mode parameter specifies if the device is to be
> + mapped as "ro" read-only or "rw" read-write. The server allows
> + a device to be exported in rw mode only once. The "migration"
> + access mode has to be specified if a second mapping in read-write
> + mode is desired.
>
> By default "rw" is used.
>
> @@ -91,7 +100,7 @@ Description: Expected format is the following:
> is the same as the device name. By extracting the last part of the
> path the path to the device /dev/<dev-name> can be build.
>
> - o /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev)
> + * /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev)
>
> How to find the <device_id> of the device is described on the next
> section.
> @@ -106,6 +115,6 @@ Description: For each device mapped on the client a new symbolic link is created
> The <device_id> of each device is created as follows:
>
> - If the 'device_path' provided during mapping contains slashes ("/"),
> - they are replaced by exclamation mark ("!") and used as as the
> - <device_id>. Otherwise, the <device_id> will be the same as the
> - "device_path" provided.
> + they are replaced by exclamation mark ("!") and used as as the
> + <device_id>. Otherwise, the <device_id> will be the same as the
> + "device_path" provided.
> diff --git a/Documentation/ABI/testing/sysfs-class-rtrs-client b/Documentation/ABI/testing/sysfs-class-rtrs-client
> index e7e718db8941..0f7165aab251 100644
> --- a/Documentation/ABI/testing/sysfs-class-rtrs-client
> +++ b/Documentation/ABI/testing/sysfs-class-rtrs-client
> @@ -10,10 +10,10 @@ Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
> Description: RW, adds a new path (connection) to an existing session. Expected format is the
> - following:
> + following::
>
> - <[source addr,]destination addr>
> - *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
> + <[source addr,]destination addr>
> + *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
>
> What: /sys/class/rtrs-client/<session-name>/max_reconnect_attempts
> Date: Feb 2020
> @@ -29,10 +29,10 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud
> Description: Multipath policy specifies which path should be selected on each IO:
>
> round-robin (0):
> - select path in per CPU round-robin manner.
> + select path in per CPU round-robin manner.
>
> min-inflight (1):
> - select path with minimum inflights.
> + select path with minimum inflights.
>
> What: /sys/class/rtrs-client/<session-name>/paths/
> Date: Feb 2020
> @@ -109,8 +109,11 @@ Description: RTRS expects that each HCA IRQ is pinned to a separate CPU. If it's
> not the case, the processing of an I/O response could be processed on a
> different CPU than where it was originally submitted. This file shows
> how many interrupts where generated on a non expected CPU.
> - "from:" is the CPU on which the IRQ was expected, but not generated.
> - "to:" is the CPU on which the IRQ was generated, but not expected.
> +
> + "from:"
> + is the CPU on which the IRQ was expected, but not generated.
> + "to:"
> + is the CPU on which the IRQ was generated, but not expected.
>
> What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reconnects
> Date: Feb 2020
> @@ -125,7 +128,7 @@ Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
> Description: Contains statistics regarding rdma operations and inflight operations.
> - The output consists of 6 values:
> + The output consists of 6 values::
>
> - <read-count> <read-total-size> <write-count> <write-total-size> \
> - <inflights> <failovered>
> + <read-count> <read-total-size> <write-count> \
> + <write-total-size> <inflights> <failovered>
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> index a8daceb4a956..ee253b033280 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> @@ -102,6 +102,8 @@ Description:
> b[15:0]
> inform firmware the current software execution
> stage.
> +
> + == ===========================================
> 0 the first stage bootloader didn't run or
> didn't reach the point of launching second
> stage bootloader.
> @@ -111,21 +113,29 @@ Description:
> 2 both first and second stage bootloader ran
> and the operating system launch was
> attempted.
> + == ===========================================
>
> b[16]
> + == ===========================================
> 1 firmware to reset current image retry
> counter.
> 0 no action.
> + == ===========================================
>
> b[17]
> + == ===========================================
> 1 firmware to clear RSU log
> 0 no action.
> + == ===========================================
>
> b[18]
> this is negative logic
> +
> + == ===========================================
> 1 no action
> 0 firmware record the notify code defined
> in b[15:0].
> + == ===========================================
>
> What: /sys/devices/platform/stratix10-rsu.0/dcmf0
> Date: June 2020
> diff --git a/Documentation/ABI/testing/sysfs-driver-w1_therm b/Documentation/ABI/testing/sysfs-driver-w1_therm
> index 8873bbb075cb..6a37dc33ffdb 100644
> --- a/Documentation/ABI/testing/sysfs-driver-w1_therm
> +++ b/Documentation/ABI/testing/sysfs-driver-w1_therm
> @@ -22,8 +22,10 @@ Description:
> device data to its embedded EEPROM, either restore data
> embedded in device EEPROM. Be aware that devices support
> limited EEPROM writing cycles (typical 50k)
> +
> * 'save': save device RAM to EEPROM
> * 'restore': restore EEPROM data in device RAM
> +
> Users: any user space application which wants to communicate with
> w1_term device
>
> @@ -33,9 +35,11 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RO) return the power status by asking the device
> +
> * '0': device parasite powered
> * '1': device externally powered
> * '-xx': xx is kernel error when reading power status
> +
> Users: any user space application which wants to communicate with
> w1_term device
>
> @@ -49,10 +53,12 @@ Description:
> will be changed only in device RAM, so it will be cleared when
> power is lost. Trigger a 'save' to EEPROM command to keep
> values after power-on. Read or write are :
> +
> * '9..14': device resolution in bit
> - or resolution to set in bit
> + or resolution to set in bit
> * '-xx': xx is kernel error when reading the resolution
> * Anything else: do nothing
> +
> Some DS18B20 clones are fixed in 12-bit resolution, so the
> actual resolution is read back from the chip and verified. Error
> is reported if the results differ.
> @@ -65,16 +71,18 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RO) return the temperature in 1/1000 degC.
> +
> * If a bulk read has been triggered, it will directly
> - return the temperature computed when the bulk read
> - occurred, if available. If not yet available, nothing
> - is returned (a debug kernel message is sent), you
> - should retry later on.
> + return the temperature computed when the bulk read
> + occurred, if available. If not yet available, nothing
> + is returned (a debug kernel message is sent), you
> + should retry later on.
> * If no bulk read has been triggered, it will trigger
> - a conversion and send the result. Note that the
> - conversion duration depend on the resolution (if
> - device support this feature). It takes 94ms in 9bits
> - resolution, 750ms for 12bits.
> + a conversion and send the result. Note that the
> + conversion duration depend on the resolution (if
> + device support this feature). It takes 94ms in 9bits
> + resolution, 750ms for 12bits.
> +
> Users: any user space application which wants to communicate with
> w1_term device
>
> @@ -86,12 +94,14 @@ Description:
> (RW) return the temperature in 1/1000 degC.
> *read*: return 2 lines with the hexa output data sent on the
> bus, return the CRC check and temperature in 1/1000 degC
> - *write* :
> + *write*:
> +
> * '0' : save the 2 or 3 bytes to the device EEPROM
> - (i.e. TH, TL and config register)
> + (i.e. TH, TL and config register)
> * '9..14' : set the device resolution in RAM
> - (if supported)
> + (if supported)
> * Anything else: do nothing
> +
> refer to Documentation/w1/slaves/w1_therm.rst for detailed
> information.
> Users: any user space application which wants to communicate with
> @@ -103,14 +113,21 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RW) trigger a bulk read conversion. read the status
> +
> *read*:
> - * '-1': conversion in progress on at least 1 sensor
> - * '1' : conversion complete but at least one sensor
> + * '-1':
> + conversion in progress on at least 1 sensor
> + * '1' :
> + conversion complete but at least one sensor
> value has not been read yet
> - * '0' : no bulk operation. Reading temperature will
> + * '0' :
> + no bulk operation. Reading temperature will
> trigger a conversion on each device
> - *write*: 'trigger': trigger a bulk read on all supporting
> +
> + *write*:
> + 'trigger': trigger a bulk read on all supporting
> devices on the bus
> +
> Note that if a bulk read is sent but one sensor is not read
> immediately, the next access to temperature on this device
> will return the temperature measured at the time of issue
> @@ -128,14 +145,19 @@ Description:
> reset to default (datasheet) conversion time for a new
> resolution.
>
> - *read*: Actual conversion time in milliseconds. *write*:
> - '0': Set the default conversion time from the datasheet.
> - '1': Measure and set the conversion time. Make a single
> + *read*:
> + Actual conversion time in milliseconds.
> +
> + *write*:
> + * '0':
> + Set the default conversion time from the datasheet.
> + * '1':
> + Measure and set the conversion time. Make a single
> temperature conversion, measure an actual value.
> Increase it by 20% for temperature range. A new
> conversion time can be obtained by reading this
> same attribute.
> - other positive value:
> + * other positive value:
> Set the conversion time in milliseconds.
>
> Users: An application using the w1_term device
> @@ -148,16 +170,21 @@ Description:
> (RW) Control optional driver settings.
> Bit masks to read/write (bitwise OR):
>
> - 1: Enable check for conversion success. If byte 6 of
> + == ============================================================
> + 1 Enable check for conversion success. If byte 6 of
> scratchpad memory is 0xC after conversion, and
> temperature reads 85.00 (powerup value) or 127.94
> (insufficient power) - return a conversion error.
>
> - 2: Enable poll for conversion completion. Generate read cycles
> + 2 Enable poll for conversion completion. Generate read cycles
> after the conversion start and wait for 1's. In parasite
> power mode this feature is not available.
> + == ============================================================
>
> - *read*: Currently selected features.
> - *write*: Select features.
> + *read*:
> + Currently selected features.
> +
> + *write*:
> + Select features.
>
> Users: An application using the w1_term device
> diff --git a/Documentation/ABI/testing/sysfs-platform-dfl-fme b/Documentation/ABI/testing/sysfs-platform-dfl-fme
> index 3683cb1cdc3d..d6ab34e81b9b 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dfl-fme
> +++ b/Documentation/ABI/testing/sysfs-platform-dfl-fme
> @@ -113,8 +113,11 @@ KernelVersion: 5.5
> Contact: Wu Hao <hao.wu@intel.com>
> Description: Read-Only. Read this file to get the name of hwmon device, it
> supports values:
> - 'dfl_fme_thermal' - thermal hwmon device name
> - 'dfl_fme_power' - power hwmon device name
> +
> + ================= =========================
> + 'dfl_fme_thermal' thermal hwmon device name
> + 'dfl_fme_power' power hwmon device name
> + ================= =========================
>
> What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input
> Date: October 2019
> @@ -169,8 +172,11 @@ KernelVersion: 5.5
> Contact: Wu Hao <hao.wu@intel.com>
> Description: Read-Only. Read this file to get the policy of hardware threshold1
> (see 'temp1_max'). It only supports two values (policies):
> - 0 - AP2 state (90% throttling)
> - 1 - AP1 state (50% throttling)
> +
> + == ==========================
> + 0 AP2 state (90% throttling)
> + 1 AP1 state (50% throttling)
> + == ==========================
>
> What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_input
> Date: October 2019
> diff --git a/Documentation/ABI/testing/sysfs-platform-dptf b/Documentation/ABI/testing/sysfs-platform-dptf
> index 2cbc660d163b..141834342a4d 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dptf
> +++ b/Documentation/ABI/testing/sysfs-platform-dptf
> @@ -27,12 +27,15 @@ KernelVersion: v4.10
> Contact: linux-acpi@vger.kernel.org
> Description:
> (RO) Display the platform power source
> +
> + ========= ============================
> bits[3:0] Current power source
> - 0x00 = DC
> - 0x01 = AC
> - 0x02 = USB
> - 0x03 = Wireless Charger
> + - 0x00 = DC
> + - 0x01 = AC
> + - 0x02 = USB
> + - 0x03 = Wireless Charger
> bits[7:4] Power source sequence number
> + ========= ============================
>
> What: /sys/bus/platform/devices/INT3407:00/dptf_power/battery_steady_power
> Date: Jul, 2016
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
> index 5aa618987cad..02ae1e9bbfc8 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
> @@ -8,5 +8,6 @@ Description:
> of 0 and userspace can signal SBL to update firmware,
> on next reboot, by writing a value of 1.
> There are two available states:
> +
> * 0 -> Skip firmware update while rebooting
> * 1 -> Attempt firmware update on next reboot
> diff --git a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> index 401d202f478b..e79ca22e2f45 100644
> --- a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> +++ b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> @@ -5,10 +5,13 @@ Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The Life-cycle state of the SoC, which could be one of the
> following values.
> - Production - Production state and can be updated to secure
> - GA Secured - Secure chip and not able to change state
> - GA Non-Secured - Non-Secure chip and not able to change state
> - RMA - Return Merchandise Authorization
> +
> + ============== =============================================
> + Production Production state and can be updated to secure
> + GA Secured Secure chip and not able to change state
> + GA Non-Secured Non-Secure chip and not able to change state
> + RMA Return Merchandise Authorization
> + ============== =============================================
>
> What: /sys/bus/platform/devices/MLNXBF04:00/post_reset_wdog
> Date: Oct 2019
> @@ -25,10 +28,13 @@ KernelVersion: 5.5
> Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The source of the boot stream for the next reset. It could be
> - one of the following values.
> - external - boot from external source (USB or PCIe)
> - emmc - boot from the onchip eMMC
> - emmc_legacy - boot from the onchip eMMC in legacy (slow) mode
> + one of the following values:
> +
> + =========== ===============================================
> + external boot from external source (USB or PCIe)
> + emmc boot from the onchip eMMC
> + emmc_legacy boot from the onchip eMMC in legacy (slow) mode
> + =========== ===============================================
>
> What: /sys/bus/platform/devices/MLNXBF04:00/second_reset_action
> Date: Oct 2019
> @@ -38,11 +44,14 @@ Description:
> Update the source of the boot stream after next reset. It could
> be one of the following values and will be applied after next
> reset.
> - external - boot from external source (USB or PCIe)
> - emmc - boot from the onchip eMMC
> - emmc_legacy - boot from the onchip eMMC in legacy (slow) mode
> - swap_emmc - swap the primary / secondary boot partition
> - none - cancel the action
> +
> + =========== ===============================================
> + external boot from external source (USB or PCIe)
> + emmc boot from the onchip eMMC
> + emmc_legacy boot from the onchip eMMC in legacy (slow) mode
> + swap_emmc swap the primary / secondary boot partition
> + none cancel the action
> + =========== ===============================================
>
> What: /sys/bus/platform/devices/MLNXBF04:00/secure_boot_fuse_state
> Date: Oct 2019
> @@ -50,9 +59,12 @@ KernelVersion: 5.5
> Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The state of eFuse versions with the following values.
> - InUse - burnt, valid and currently in use
> - Used - burnt and valid
> - Free - not burnt and free to use
> - Skipped - not burnt but not free (skipped)
> - Wasted - burnt and invalid
> - Invalid - not burnt but marked as valid (error state).
> +
> + ======= ===============================================
> + InUse burnt, valid and currently in use
> + Used burnt and valid
> + Free not burnt and free to use
> + Skipped not burnt but not free (skipped)
> + Wasted burnt and invalid
> + Invalid not burnt but marked as valid (error state).
> + ======= ===============================================
> diff --git a/Documentation/ABI/testing/sysfs-platform-wilco-ec b/Documentation/ABI/testing/sysfs-platform-wilco-ec
> index 5f60b184a5a5..4439d0644091 100644
> --- a/Documentation/ABI/testing/sysfs-platform-wilco-ec
> +++ b/Documentation/ABI/testing/sysfs-platform-wilco-ec
> @@ -39,6 +39,7 @@ Description:
> which affects charging via the special USB PowerShare port
> (marked with a small lightning bolt or battery icon) when in
> low power states:
> +
> - In S0, the port will always provide power.
> - In S0ix, if usb_charge is enabled, then power will be
> supplied to the port when on AC or if battery is > 50%.
> --
> 2.26.2
>
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-10-30 10:09 ` [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output Mauro Carvalho Chehab
@ 2020-11-02 11:04 ` Fabrice Gasnier
2020-11-02 12:46 ` Greg Kroah-Hartman
0 siblings, 1 reply; 19+ messages in thread
From: Fabrice Gasnier @ 2020-11-02 11:04 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Greg Kroah-Hartman
Cc: Linux Doc Mailing List, Gautham R. Shenoy, Jason A. Donenfeld,
Javier González, Jonathan Corbet, Martin K. Petersen,
Rafael J. Wysocki, Alexander Shishkin, Alexandre Belloni,
Alexandre Torgue, Andrew Donnellan, Andy Shevchenko, Baolin Wang,
Benson Leung, Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang,
Dan Murphy, Dan Williams, Enric Balletbo i Serra, Felipe Balbi,
Frederic Barrat, Guenter Roeck, Hanjun Guo, Heikki Krogerus,
Jens Axboe, Johannes Thumshirn, Jonathan Cameron, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote:
> Em Fri, 30 Oct 2020 10:19:12 +0100
> Fabrice Gasnier <fabrice.gasnier@st.com> escreveu:
>
>> Hi Mauro,
>>
>> [...]
>>
>>>
>>> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
>>> +KernelVersion: 4.12
>>> +Contact: benjamin.gaignard@st.com
>>> +Description:
>>> + Reading returns the list possible quadrature modes.
>>> +
>>> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
>>> +KernelVersion: 4.12
>>> +Contact: benjamin.gaignard@st.com
>>> +Description:
>>> + Configure the device counter quadrature modes:
>>> +
>>> + channel_A:
>>> + Encoder A input servers as the count input and B as
>>> + the UP/DOWN direction control input.
>>> +
>>> + channel_B:
>>> + Encoder B input serves as the count input and A as
>>> + the UP/DOWN direction control input.
>>> +
>>> + quadrature:
>>> + Encoder A and B inputs are mixed to get direction
>>> + and count with a scale of 0.25.
>>> +
>>
>
> Hi Fabrice,
>
>> I just noticed that since Jonathan question in v1.
>>
>> Above ABI has been moved in the past as discussed in [1]. You can take a
>> look at:
>> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
>>
>> Could you please remove the above chunk ?
>>
>> With that, for the stm32 part:
>> Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
>
>
> Hmm... probably those were re-introduced due to a rebase. This
> series were originally written about 1,5 years ago.
>
> I'll drop those hunks.
Hi Mauro, Greg,
I just figured out this patch has been applied with above hunk.
This should be dropped: is there a fix on its way already ?
(I may have missed it)
Please advise,
Fabrice
>
> Thanks!
> Mauro
>
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-11-02 11:04 ` Fabrice Gasnier
@ 2020-11-02 12:46 ` Greg Kroah-Hartman
2020-11-02 14:42 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 19+ messages in thread
From: Greg Kroah-Hartman @ 2020-11-02 12:46 UTC (permalink / raw)
To: Fabrice Gasnier
Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Gautham R. Shenoy,
Jason A. Donenfeld, Javier González, Jonathan Corbet,
Martin K. Petersen, Rafael J. Wysocki, Alexander Shishkin,
Alexandre Belloni, Alexandre Torgue, Andrew Donnellan,
Andy Shevchenko, Baolin Wang, Benson Leung, Boris Ostrovsky,
Bruno Meneguele, Chunyan Zhang, Dan Murphy, Dan Williams,
Enric Balletbo i Serra, Felipe Balbi, Frederic Barrat,
Guenter Roeck, Hanjun Guo, Heikki Krogerus, Jens Axboe,
Johannes Thumshirn, Jonathan Cameron, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
On Mon, Nov 02, 2020 at 12:04:36PM +0100, Fabrice Gasnier wrote:
> On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote:
> > Em Fri, 30 Oct 2020 10:19:12 +0100
> > Fabrice Gasnier <fabrice.gasnier@st.com> escreveu:
> >
> >> Hi Mauro,
> >>
> >> [...]
> >>
> >>>
> >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> >>> +KernelVersion: 4.12
> >>> +Contact: benjamin.gaignard@st.com
> >>> +Description:
> >>> + Reading returns the list possible quadrature modes.
> >>> +
> >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> >>> +KernelVersion: 4.12
> >>> +Contact: benjamin.gaignard@st.com
> >>> +Description:
> >>> + Configure the device counter quadrature modes:
> >>> +
> >>> + channel_A:
> >>> + Encoder A input servers as the count input and B as
> >>> + the UP/DOWN direction control input.
> >>> +
> >>> + channel_B:
> >>> + Encoder B input serves as the count input and A as
> >>> + the UP/DOWN direction control input.
> >>> +
> >>> + quadrature:
> >>> + Encoder A and B inputs are mixed to get direction
> >>> + and count with a scale of 0.25.
> >>> +
> >>
> >
> > Hi Fabrice,
> >
> >> I just noticed that since Jonathan question in v1.
> >>
> >> Above ABI has been moved in the past as discussed in [1]. You can take a
> >> look at:
> >> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
> >>
> >> Could you please remove the above chunk ?
> >>
> >> With that, for the stm32 part:
> >> Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> >
> >
> > Hmm... probably those were re-introduced due to a rebase. This
> > series were originally written about 1,5 years ago.
> >
> > I'll drop those hunks.
>
> Hi Mauro, Greg,
>
> I just figured out this patch has been applied with above hunk.
>
> This should be dropped: is there a fix on its way already ?
> (I may have missed it)
Can you send a fix for just this hunk?
thanks,
greg k-h
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-11-02 12:46 ` Greg Kroah-Hartman
@ 2020-11-02 14:42 ` Mauro Carvalho Chehab
2020-11-08 16:56 ` Jonathan Cameron
0 siblings, 1 reply; 19+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-02 14:42 UTC (permalink / raw)
To: Greg Kroah-Hartman
Cc: Fabrice Gasnier, Linux Doc Mailing List, Gautham R. Shenoy,
Jason A. Donenfeld, Javier González, Jonathan Corbet,
Martin K. Petersen, Rafael J. Wysocki, Alexander Shishkin,
Alexandre Belloni, Alexandre Torgue, Andrew Donnellan,
Andy Shevchenko, Baolin Wang, Benson Leung, Boris Ostrovsky,
Bruno Meneguele, Chunyan Zhang, Dan Murphy, Dan Williams,
Enric Balletbo i Serra, Felipe Balbi, Frederic Barrat,
Guenter Roeck, Hanjun Guo, Heikki Krogerus, Jens Axboe,
Johannes Thumshirn, Jonathan Cameron, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
Em Mon, 2 Nov 2020 13:46:41 +0100
Greg Kroah-Hartman <gregkh@linuxfoundation.org> escreveu:
> On Mon, Nov 02, 2020 at 12:04:36PM +0100, Fabrice Gasnier wrote:
> > On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote:
> > > Em Fri, 30 Oct 2020 10:19:12 +0100
> > > Fabrice Gasnier <fabrice.gasnier@st.com> escreveu:
> > >
> > >> Hi Mauro,
> > >>
> > >> [...]
> > >>
> > >>>
> > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> > >>> +KernelVersion: 4.12
> > >>> +Contact: benjamin.gaignard@st.com
> > >>> +Description:
> > >>> + Reading returns the list possible quadrature modes.
> > >>> +
> > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> > >>> +KernelVersion: 4.12
> > >>> +Contact: benjamin.gaignard@st.com
> > >>> +Description:
> > >>> + Configure the device counter quadrature modes:
> > >>> +
> > >>> + channel_A:
> > >>> + Encoder A input servers as the count input and B as
> > >>> + the UP/DOWN direction control input.
> > >>> +
> > >>> + channel_B:
> > >>> + Encoder B input serves as the count input and A as
> > >>> + the UP/DOWN direction control input.
> > >>> +
> > >>> + quadrature:
> > >>> + Encoder A and B inputs are mixed to get direction
> > >>> + and count with a scale of 0.25.
> > >>> +
> > >>
> > >
> > > Hi Fabrice,
> > >
> > >> I just noticed that since Jonathan question in v1.
> > >>
> > >> Above ABI has been moved in the past as discussed in [1]. You can take a
> > >> look at:
> > >> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
> > >>
> > >> Could you please remove the above chunk ?
> > >>
> > >> With that, for the stm32 part:
> > >> Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> > >
> > >
> > > Hmm... probably those were re-introduced due to a rebase. This
> > > series were originally written about 1,5 years ago.
> > >
> > > I'll drop those hunks.
> >
> > Hi Mauro, Greg,
> >
> > I just figured out this patch has been applied with above hunk.
> >
> > This should be dropped: is there a fix on its way already ?
> > (I may have missed it)
>
> Can you send a fix for just this hunk?
Hmm...
$ git grep /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
Even re-doing the changes from
changeset b299d00420e2 ("IIO: stm32: Remove quadrature related functions from trigger driver")
at Documentation/ABI/testing/sysfs-bus-iio-timer-stm32, there's still
a third duplicate of some of those, as reported by the script:
$ ./scripts/get_abi.pl validate 2>&1|grep quadra
Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
As in_count_quadrature_mode_available is also defined at:
Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2
The best here seems to have a patch that will also drop the other
duplication of this, probably moving in_count_quadrature_mode_available
to a generic node probably placing it inside
Documentation/ABI/testing/sysfs-bus-iio.
Comments?
Thanks,
Mauro
PS.: the IIO subsystem is the one that currently has more duplicated
ABI entries:
$ ./scripts/get_abi.pl validate 2>&1|grep iio
Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 Documentation/ABI/testing/sysfs-bus-iio:394
Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 Documentation/ABI/testing/sysfs-bus-iio:395
Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 Documentation/ABI/testing/sysfs-bus-iio:396
Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 Documentation/ABI/testing/sysfs-bus-iio:397
Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 Documentation/ABI/testing/sysfs-bus-iio:398
Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 Documentation/ABI/testing/sysfs-bus-iio:399
Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 Documentation/ABI/testing/sysfs-bus-iio:599
Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 Documentation/ABI/testing/sysfs-bus-iio:588
Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:45
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation
2020-10-30 7:40 ` [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation Mauro Carvalho Chehab
2020-10-30 14:39 ` Rafael J. Wysocki
2020-11-02 5:50 ` Jinpu Wang
@ 2020-11-02 18:39 ` Joseph, Jithu
2 siblings, 0 replies; 19+ messages in thread
From: Joseph, Jithu @ 2020-11-02 18:39 UTC (permalink / raw)
To: mchehab+huawei, linux-doc
Cc: jinpu.wang, cw00.choi, gregkh, felix, lukasz.luba, k.konieczny,
jgg, richard.gong, dvhart, vadimp, ajd, vaibhav, danil.kipnis,
jolly.shah, christian.gromm, rajan.vaja, michal.simek, zbr, Wu,
Hao, Kang, Luwei, Wysocki, Rafael J, tejas.patel, ivan.zaentsev,
srinivas.pandruvada, andy, gregory.clement, akira215corp,
fbarrat, Xu, Yilun, linux-arm-kernel, linux-pm, Jonathan.Cameron,
bvanassche, marek.behun, platform-driver-x86, corbet,
b.zolnierkie, sre, linux-kernel
On Fri, 2020-10-30 at 08:40 +0100, Mauro Carvalho Chehab wrote:
> There are a number of new changes at the ABI files that cause
> them to produce warnings when generating ABI output.
>
> Fix them.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../ABI/stable/sysfs-driver-firmware-zynqmp | 62 ++++++++-----
> Documentation/ABI/testing/debugfs-moxtet | 28 ++++--
> .../ABI/testing/debugfs-turris-mox-rwtm | 6 +-
> .../sysfs-bus-event_source-devices-dfl_fme | 14 +--
> Documentation/ABI/testing/sysfs-bus-most | 6 +-
> Documentation/ABI/testing/sysfs-class-devfreq | 6 +-
> Documentation/ABI/testing/sysfs-class-ocxl | 14 +--
> .../ABI/testing/sysfs-class-power-wilco | 18 ++--
> .../ABI/testing/sysfs-class-rnbd-client | 93 ++++++++++-------
> --
> .../ABI/testing/sysfs-class-rtrs-client | 23 +++--
> .../sysfs-devices-platform-stratix10-rsu | 10 ++
> .../ABI/testing/sysfs-driver-w1_therm | 75 ++++++++++-----
> .../ABI/testing/sysfs-platform-dfl-fme | 14 ++-
> Documentation/ABI/testing/sysfs-platform-dptf | 11 ++-
> .../sysfs-platform-intel-wmi-sbl-fw-update | 1 +
For intel-wmi-sbl-fw-update part
Acked-by: Jithu Joseph<jithu.joseph@intel.com>
> .../testing/sysfs-platform-mellanox-bootctl | 50 ++++++----
> .../ABI/testing/sysfs-platform-wilco-ec | 1 +
> 17 files changed, 271 insertions(+), 161 deletions(-)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> index 00fa04c76ff3..f5724bb5b462 100644
> --- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> +++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> @@ -12,13 +12,15 @@ Description:
> resets. Three registers are used by the FSBL and
> other Xilinx software products:
> GLOBAL_GEN_STORAGE{4:6}.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/ggs0
> - # echo <value> >
> /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/ggs0
> - # echo 0x1234ABCD >
> /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> + # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/ggs0
> + # echo <value> >
> /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/ggs0
> + # echo 0x1234ABCD >
> /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
>
> Users: Xilinx
>
> @@ -39,13 +41,15 @@ Description:
> software products: PERS_GLOB_GEN_STORAGE{4:7}.
> Register is reset only by a POR reset.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/pggs0
> - # echo <value> >
> /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/pggs0
> - # echo 0x1234ABCD >
> /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> + # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/pggs0
> + # echo <value> >
> /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/pggs0
> + # echo 0x1234ABCD >
> /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
>
> Users: Xilinx
>
> @@ -61,23 +65,28 @@ Description:
>
> Following are available shutdown scopes(subtypes):
>
> - subsystem: Only the APU along with all of its
> peripherals
> + subsystem:
> + Only the APU along with all of its
> peripherals
> not used by other processing units will
> be
> shut down. This may result in the FPD
> power
> domain being shut down provided that no
> other
> processing unit uses FPD peripherals or
> DRAM.
> - ps_only: The complete PS will be shut down, including
> the
> + ps_only:
> + The complete PS will be shut down,
> including the
> RPU, PMU, etc. Only the PL domain
> (FPGA)
> remains untouched.
> - system: The complete system/device is shut
> down.
> + system:
> + The complete system/device is shut
> down.
>
> - Usage:
> - # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/shutdown_scope
> - # echo <scope> >
> /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + Usage::
>
> - Example:
> - # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/shutdown_scope
> - # echo "subsystem" >
> /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> + # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/shutdown_scope
> + # echo <scope> >
> /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
> +
> + Example::
> +
> + # cat /sys/devices/platform/firmware\:zynqmp-
> firmware/shutdown_scope
> + # echo "subsystem" >
> /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
>
> Users: Xilinx
>
> @@ -94,10 +103,13 @@ Description:
> system restart.
>
> Usage:
> - Set healthy bit
> - # echo 1 > /sys/devices/platform/firmware\:zynqmp-
> firmware/health_status
>
> - Unset healthy bit
> - # echo 0 > /sys/devices/platform/firmware\:zynqmp-
> firmware/health_status
> + Set healthy bit::
> +
> + # echo 1 > /sys/devices/platform/firmware\:zynqmp-
> firmware/health_status
> +
> + Unset healthy bit::
> +
> + # echo 0 > /sys/devices/platform/firmware\:zynqmp-
> firmware/health_status
>
> Users: Xilinx
> diff --git a/Documentation/ABI/testing/debugfs-moxtet
> b/Documentation/ABI/testing/debugfs-moxtet
> index 67b1717794d8..15dfaecb2892 100644
> --- a/Documentation/ABI/testing/debugfs-moxtet
> +++ b/Documentation/ABI/testing/debugfs-moxtet
> @@ -5,10 +5,16 @@ Contact: Marek Behún <marek.behun@nic.cz>
> Description: (R) Read input from the shift registers, in
> hexadecimal.
> Returns N+1 bytes, where N is the number of Moxtet
> connected
> modules. The first byte is from the CPU board itself.
> - Example: 101214
> - 10: CPU board with SD card
> - 12: 2 = PCIe module, 1 = IRQ not active
> - 14: 4 = Peridot module, 1 = IRQ not active
> +
> + Example::
> +
> + 101214
> +
> + == =======================================
> + 10 CPU board with SD card
> + 12 2 = PCIe module, 1 = IRQ not active
> + 14 4 = Peridot module, 1 = IRQ not active
> + == =======================================
>
> What: /sys/kernel/debug/moxtet/output
> Date: March 2019
> @@ -17,7 +23,13 @@ Contact: Marek Behún <marek.behun@nic.cz>
> Description: (RW) Read last written value to the shift registers, in
> hexadecimal, or write values to the shift registers,
> also
> in hexadecimal.
> - Example: 0102
> - 01: 01 was last written, or is to be written,
> to the
> - first module's shift register
> - 02: the same for second module
> +
> + Example::
> +
> + 0102
> +
> + == ================================================
> + 01 01 was last written, or is to be written, to the
> + first module's shift register
> + 02 the same for second module
> + == ================================================
> diff --git a/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> index 2b3255ee68fd..c8f7dadd591c 100644
> --- a/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> +++ b/Documentation/ABI/testing/debugfs-turris-mox-rwtm
> @@ -2,8 +2,10 @@ What: /sys/kernel/debug/turris-mox-
> rwtm/do_sign
> Date: Jun 2020
> KernelVersion: 5.8
> Contact: Marek Behún <marek.behun@nic.cz>
> -Description: (W) Message to sign with the ECDSA private key stored
> in
> +Description: (W)
> + Message to sign with the ECDSA private key stored
> in
> device's OTP. The message must be exactly 64 bytes
> (since
> this is intended for SHA-512 hashes).
> - (R) The resulting signature, 136 bytes. This contains
> the R and
> + (R)
> + The resulting signature, 136 bytes. This contains
> the R and
> S values of the ECDSA signature, both in big-endian
> format.
> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-
> devices-dfl_fme b/Documentation/ABI/testing/sysfs-bus-event_source-
> devices-dfl_fme
> index c9278a3b3df1..63a32ddcb95e 100644
> --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-
> dfl_fme
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-
> dfl_fme
> @@ -8,13 +8,13 @@ Description: Read-only. Attribute group to
> describe the magic bits
>
> Each attribute under this group defines a bit range of
> the
> perf_event_attr.config. All supported attributes are
> listed
> - below.
> + below::
>
> event = "config:0-11" - event ID
> evtype = "config:12-15" - event type
> portid = "config:16-23" - event source
>
> - For example,
> + For example::
>
> fab_mmio_read =
> "event=0x06,evtype=0x02,portid=0xff"
>
> @@ -40,11 +40,11 @@ Description: Read-only. Attribute group to
> describe performance monitoring
>
> All supported performance monitoring events are listed
> below.
>
> - Basic events (evtype=0x00)
> + Basic events (evtype=0x00)::
>
> clock = "event=0x00,evtype=0x00,portid=0xff"
>
> - Cache events (evtype=0x01)
> + Cache events (evtype=0x01)::
>
> cache_read_hit =
> "event=0x00,evtype=0x01,portid=0xff"
> cache_read_miss =
> "event=0x01,evtype=0x01,portid=0xff"
> @@ -59,7 +59,7 @@ Description: Read-only. Attribute group to
> describe performance monitoring
> cache_rx_req_stall =
> "event=0x09,evtype=0x01,portid=0xff"
> cache_eviction =
> "event=0x0a,evtype=0x01,portid=0xff"
>
> - Fabric events (evtype=0x02)
> + Fabric events (evtype=0x02)::
>
> fab_pcie0_read =
> "event=0x00,evtype=0x02,portid=0xff"
> fab_pcie0_write =
> "event=0x01,evtype=0x02,portid=0xff"
> @@ -78,7 +78,7 @@ Description: Read-only. Attribute group to
> describe performance monitoring
> fab_port_mmio_read =
> "event=0x06,evtype=0x02,portid=?"
> fab_port_mmio_write =
> "event=0x07,evtype=0x02,portid=?"
>
> - VTD events (evtype=0x03)
> + VTD events (evtype=0x03)::
>
> vtd_port_read_transaction =
> "event=0x00,evtype=0x03,portid=?"
> vtd_port_write_transaction =
> "event=0x01,evtype=0x03,portid=?"
> @@ -88,7 +88,7 @@ Description: Read-only. Attribute group to
> describe performance monitoring
> vtd_port_devtlb_2m_fill =
> "event=0x05,evtype=0x03,portid=?"
> vtd_port_devtlb_1g_fill =
> "event=0x06,evtype=0x03,portid=?"
>
> - VTD SIP events (evtype=0x04)
> + VTD SIP events (evtype=0x04)::
>
> vtd_sip_iotlb_4k_hit =
> "event=0x00,evtype=0x04,portid=0xff"
> vtd_sip_iotlb_2m_hit =
> "event=0x01,evtype=0x04,portid=0xff"
> diff --git a/Documentation/ABI/testing/sysfs-bus-most
> b/Documentation/ABI/testing/sysfs-bus-most
> index ec0a603d804b..38cc03e408e7 100644
> --- a/Documentation/ABI/testing/sysfs-bus-most
> +++ b/Documentation/ABI/testing/sysfs-bus-most
> @@ -235,7 +235,8 @@ KernelVersion: 4.15
> Contact: Christian Gromm <christian.gromm@microchip.com>
> Description:
> This is to read back the configured direction of the
> channel.
> - The following strings will be accepted:
> + The following strings will be accepted::
> +
> 'tx',
> 'rx'
> Users:
> @@ -246,7 +247,8 @@ KernelVersion: 4.15
> Contact: Christian Gromm <christian.gromm@microchip.com>
> Description:
> This is to read back the configured data type of the
> channel.
> - The following strings will be accepted:
> + The following strings will be accepted::
> +
> 'control',
> 'async',
> 'sync',
> diff --git a/Documentation/ABI/testing/sysfs-class-devfreq
> b/Documentation/ABI/testing/sysfs-class-devfreq
> index 67af3f31e17c..386bc230a33d 100644
> --- a/Documentation/ABI/testing/sysfs-class-devfreq
> +++ b/Documentation/ABI/testing/sysfs-class-devfreq
> @@ -48,7 +48,8 @@ Description:
> driver should provide the list of available frequencies
> with its profile. If need to reset the statistics of
> devfreq
> behavior on a specific device, enter 0(zero) to
> 'trans_stat'
> - as following:
> + as following::
> +
> echo 0 > /sys/class/devfreq/.../trans_stat
>
> What: /sys/class/devfreq/.../available_frequencies
> @@ -124,7 +125,8 @@ Description:
> This work timer is used by devfreq workqueue in order
> to
> monitor the device status such as utilization. The user
> can change the work timer on runtime according to their
> demand
> - as following:
> + as following::
> +
> echo deferrable > /sys/class/devfreq/.../timer
> echo delayed > /sys/class/devfreq/.../timer
>
> diff --git a/Documentation/ABI/testing/sysfs-class-ocxl
> b/Documentation/ABI/testing/sysfs-class-ocxl
> index bf33f4fda58f..847a7edc3113 100644
> --- a/Documentation/ABI/testing/sysfs-class-ocxl
> +++ b/Documentation/ABI/testing/sysfs-class-ocxl
> @@ -13,8 +13,8 @@ Description: read only
> where:
>
> ==== =====================================
> ==========
> - n: number of currently active contexts,
> for debug
> - max: maximum number of contexts supported
> by the AFU
> + n number of currently active contexts, for
> debug
> + max maximum number of contexts supported
> by the AFU
> ==== =====================================
> ==========
>
> What: /sys/class/ocxl/<afu name>/pp_mmio_size
> @@ -43,7 +43,9 @@ Contact: linuxppc-dev@lists.ozlabs.org
> Description: read/write
> Control whether the FPGA is reloaded on a link reset.
> Enabled
> through a vendor-specific logic block on the FPGA.
> - 0 Do not reload FPGA image from flash
> - 1 Reload FPGA image from flash
> - unavailable
> - The device does not support this
> capability
> +
> + =========== ==================================
> =========
> + 0 Do not reload FPGA image from flash
> + 1 Reload FPGA image from flash
> + unavailable The device does not support this
> capability
> + =========== ==================================
> =========
> diff --git a/Documentation/ABI/testing/sysfs-class-power-wilco
> b/Documentation/ABI/testing/sysfs-class-power-wilco
> index 84fde1d0ada0..82af180fcaab 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-wilco
> +++ b/Documentation/ABI/testing/sysfs-class-power-wilco
> @@ -4,17 +4,23 @@ KernelVersion: 5.2
> Description:
> What charging algorithm to use:
>
> - Standard: Fully charges battery at a standard rate.
> - Adaptive: Battery settings adaptively optimized based
> on
> + Standard:
> + Fully charges battery at a standard rate.
> + Adaptive:
> + Battery settings adaptively optimized based on
> typical battery usage pattern.
> - Fast: Battery charges over a shorter period.
> - Trickle: Extends battery lifespan, intended for users
> who
> + Fast:
> + Battery charges over a shorter period.
> + Trickle:
> + Extends battery lifespan, intended for users
> who
> primarily use their Chromebook while connected
> to AC.
> - Custom: A low and high threshold percentage is
> specified.
> + Custom:
> + A low and high threshold percentage is
> specified.
> Charging begins when level drops below
> charge_control_start_threshold, and ceases when
> level is above charge_control_end_threshold.
> - Long Life: Customized charge rate for last longer
> battery life.
> + Long Life:
> + Customized charge rate for last longer battery
> life.
> On Wilco device this mode is pre-configured in
> the factory
> through EC's private PID. Swiching to a
> different mode will
> be denied by Wilco EC when Long Life mode is
> enabled.
> diff --git a/Documentation/ABI/testing/sysfs-class-rnbd-client
> b/Documentation/ABI/testing/sysfs-class-rnbd-client
> index c084f203b41e..00c0286733d4 100644
> --- a/Documentation/ABI/testing/sysfs-class-rnbd-client
> +++ b/Documentation/ABI/testing/sysfs-class-rnbd-client
> @@ -5,62 +5,70 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com>
> Danil Kipnis <danil.kipnis@cloud
> Description: Provide information about RNBD-client.
> All sysfs files that are not read-only provide the
> usage information on read:
>
> - Example:
> - # cat /sys/class/rnbd-client/ctl/map_device
> + Example::
>
> - > Usage: echo "sessname=<name of the rtrs session>
> path=<[srcaddr,]dstaddr>
> - > [path=<[srcaddr,]dstaddr>] device_path=<full path on
> remote side>
> - > [access_mode=<ro|rw|migration>] > map_device
> - >
> - > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
> + # cat /sys/class/rnbd-client/ctl/map_device
> +
> + > Usage: echo "sessname=<name of the rtrs session>
> path=<[srcaddr,]dstaddr>
> + > [path=<[srcaddr,]dstaddr>] device_path=<full path
> on remote side>
> + > [access_mode=<ro|rw|migration>] > map_device
> + >
> + > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]
>
> What: /sys/class/rnbd-client/ctl/map_device
> Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <
> danil.kipnis@cloud.ionos.com>
> -Description: Expected format is the following:
> +Description: Expected format is the following::
>
> - sessname=<name of the rtrs session>
> - path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...]
> - device_path=<full path on remote side>
> - [access_mode=<ro|rw|migration>]
> + sessname=<name of the rtrs session>
> + path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr>
> ...]
> + device_path=<full path on remote side>
> + [access_mode=<ro|rw|migration>]
>
> Where:
>
> - sessname: accepts a string not bigger than 256 chars,
> which identifies
> - a given session on the client and on the server.
> - I.e. "clt_hostname-srv_hostname" could be a natural
> choice.
> + sessname:
> + accepts a string not bigger than 256 chars, which
> identifies
> + a given session on the client and on the server.
> + I.e. "clt_hostname-srv_hostname" could be a natural
> choice.
>
> - path: describes a connection between the client and
> the server by
> - specifying destination and, when required, the source
> address.
> - The addresses are to be provided in the following
> format:
> + path:
> + describes a connection between the client and the
> server by
> + specifying destination and, when required, the
> source address.
> + The addresses are to be provided in the following
> format::
>
> - ip:<IPv6>
> - ip:<IPv4>
> - gid:<GID>
> + ip:<IPv6>
> + ip:<IPv4>
> + gid:<GID>
>
> - for example:
> + for example::
> +
> + path=ip:10.0.0.66
>
> - path=ip:10.0.0.66
> The single addr is treated as the destination.
> The connection will be established to this server from
> any client IP address.
>
> - path=ip:10.0.0.66,ip:10.0.1.66
> + ::
> +
> + path=ip:10.0.0.66,ip:10.0.1.66
> +
> First addr is the source address and the second is the
> destination.
>
> If multiple "path=" options are specified multiple
> connection
> will be established and data will be sent according to
> the selected multipath policy (see RTRS mp_policy sysfs
> entry description).
>
> - device_path: Path to the block device on the server
> side. Path is specified
> - relative to the directory on server side configured in
> the
> - 'dev_search_path' module parameter of the rnbd_server.
> - The rnbd_server prepends the <device_path> received
> from client
> - with <dev_search_path> and tries to open the
> - <dev_search_path>/<device_path> block device. On
> success,
> - a /dev/rnbd<N> device file, a
> /sys/block/rnbd_client/rnbd<N>/
> - directory and an entry in /sys/class/rnbd-
> client/ctl/devices
> - will be created.
> + device_path:
> + Path to the block device on the server side. Path
> is specified
> + relative to the directory on server side configured
> in the
> + 'dev_search_path' module parameter of the
> rnbd_server.
> + The rnbd_server prepends the <device_path> received
> from client
> + with <dev_search_path> and tries to open the
> + <dev_search_path>/<device_path> block device. On
> success,
> + a /dev/rnbd<N> device file, a
> /sys/block/rnbd_client/rnbd<N>/
> + directory and an entry in /sys/class/rnbd-
> client/ctl/devices
> + will be created.
>
> If 'dev_search_path' contains '%SESSNAME%', then each
> session can
> have different devices namespace, e.g. server was
> configured with
> @@ -68,11 +76,12 @@ Description: Expected format is the
> following:
> client has this string "sessname=blya device_path=sda",
> then server
> will try to open: /run/rnbd-devs/blya/sda.
>
> - access_mode: the access_mode parameter specifies if the
> device is to be
> - mapped as "ro" read-only or "rw" read-write. The server
> allows
> - a device to be exported in rw mode only once. The
> "migration"
> - access mode has to be specified if a second mapping in
> read-write
> - mode is desired.
> + access_mode:
> + the access_mode parameter specifies if the device
> is to be
> + mapped as "ro" read-only or "rw" read-write. The
> server allows
> + a device to be exported in rw mode only once. The
> "migration"
> + access mode has to be specified if a second mapping
> in read-write
> + mode is desired.
>
> By default "rw" is used.
>
> @@ -91,7 +100,7 @@ Description: Expected format is the
> following:
> is the same as the device name. By extracting the last
> part of the
> path the path to the device /dev/<dev-name> can be
> build.
>
> - o /dev/block/$(cat /sys/class/rnbd-
> client/ctl/devices/<device_id>/dev)
> + * /dev/block/$(cat /sys/class/rnbd-
> client/ctl/devices/<device_id>/dev)
>
> How to find the <device_id> of the device is described
> on the next
> section.
> @@ -106,6 +115,6 @@ Description: For each device mapped on the
> client a new symbolic link is created
> The <device_id> of each device is created as follows:
>
> - If the 'device_path' provided during mapping contains
> slashes ("/"),
> - they are replaced by exclamation mark ("!") and used as
> as the
> - <device_id>. Otherwise, the <device_id> will be the
> same as the
> - "device_path" provided.
> + they are replaced by exclamation mark ("!") and used
> as as the
> + <device_id>. Otherwise, the <device_id> will be the
> same as the
> + "device_path" provided.
> diff --git a/Documentation/ABI/testing/sysfs-class-rtrs-client
> b/Documentation/ABI/testing/sysfs-class-rtrs-client
> index e7e718db8941..0f7165aab251 100644
> --- a/Documentation/ABI/testing/sysfs-class-rtrs-client
> +++ b/Documentation/ABI/testing/sysfs-class-rtrs-client
> @@ -10,10 +10,10 @@ Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <
> danil.kipnis@cloud.ionos.com>
> Description: RW, adds a new path (connection) to an existing
> session. Expected format is the
> - following:
> + following::
>
> - <[source addr,]destination addr>
> - *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
> + <[source addr,]destination addr>
> + *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
>
> What: /sys/class/rtrs-client/<session-
> name>/max_reconnect_attempts
> Date: Feb 2020
> @@ -29,10 +29,10 @@ Contact: Jack Wang <jinpu.wang@cloud.ionos.com>
> Danil Kipnis <danil.kipnis@cloud
> Description: Multipath policy specifies which path should be
> selected on each IO:
>
> round-robin (0):
> - select path in per CPU round-robin manner.
> + select path in per CPU round-robin manner.
>
> min-inflight (1):
> - select path with minimum inflights.
> + select path with minimum inflights.
>
> What: /sys/class/rtrs-client/<session-name>/paths/
> Date: Feb 2020
> @@ -109,8 +109,11 @@ Description: RTRS expects that each HCA IRQ
> is pinned to a separate CPU. If it's
> not the case, the processing of an I/O response could
> be processed on a
> different CPU than where it was originally
> submitted. This file shows
> how many interrupts where generated on a non expected
> CPU.
> - "from:" is the CPU on which the IRQ was expected, but
> not generated.
> - "to:" is the CPU on which the IRQ was generated, but
> not expected.
> +
> + "from:"
> + is the CPU on which the IRQ was expected, but not
> generated.
> + "to:"
> + is the CPU on which the IRQ was generated, but not
> expected.
>
> What: /sys/class/rtrs-client/<session-name>/paths/<
> src@dst>/stats/reconnects
> Date: Feb 2020
> @@ -125,7 +128,7 @@ Date: Feb 2020
> KernelVersion: 5.7
> Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <
> danil.kipnis@cloud.ionos.com>
> Description: Contains statistics regarding rdma operations and
> inflight operations.
> - The output consists of 6 values:
> + The output consists of 6 values::
>
> - <read-count> <read-total-size> <write-count> <write-
> total-size> \
> - <inflights> <failovered>
> + <read-count> <read-total-size> <write-count> \
> + <write-total-size> <inflights> <failovered>
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-
> stratix10-rsu b/Documentation/ABI/testing/sysfs-devices-platform-
> stratix10-rsu
> index a8daceb4a956..ee253b033280 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
> @@ -102,6 +102,8 @@ Description:
> b[15:0]
> inform firmware the current software execution
> stage.
> +
> + == =====================================
> ======
> 0 the first stage bootloader didn't run or
> didn't reach the point of launching
> second
> stage bootloader.
> @@ -111,21 +113,29 @@ Description:
> 2 both first and second stage bootloader ran
> and the operating system launch was
> attempted.
> + == =====================================
> ======
>
> b[16]
> + == =====================================
> ======
> 1 firmware to reset current image retry
> counter.
> 0 no action.
> + == =====================================
> ======
>
> b[17]
> + == =====================================
> ======
> 1 firmware to clear RSU log
> 0 no action.
> + == =====================================
> ======
>
> b[18]
> this is negative logic
> +
> + == =====================================
> ======
> 1 no action
> 0 firmware record the notify code defined
> in b[15:0].
> + == =====================================
> ======
>
> What: /sys/devices/platform/stratix10-rsu.0/dcmf0
> Date: June 2020
> diff --git a/Documentation/ABI/testing/sysfs-driver-w1_therm
> b/Documentation/ABI/testing/sysfs-driver-w1_therm
> index 8873bbb075cb..6a37dc33ffdb 100644
> --- a/Documentation/ABI/testing/sysfs-driver-w1_therm
> +++ b/Documentation/ABI/testing/sysfs-driver-w1_therm
> @@ -22,8 +22,10 @@ Description:
> device data to its embedded EEPROM, either restore data
> embedded in device EEPROM. Be aware that devices
> support
> limited EEPROM writing cycles (typical 50k)
> +
> * 'save': save device RAM to EEPROM
> * 'restore': restore EEPROM data in device RAM
> +
> Users: any user space application which wants to
> communicate with
> w1_term device
>
> @@ -33,9 +35,11 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RO) return the power status by asking the device
> +
> * '0': device parasite powered
> * '1': device externally powered
> * '-xx': xx is kernel error when reading power
> status
> +
> Users: any user space application which wants to
> communicate with
> w1_term device
>
> @@ -49,10 +53,12 @@ Description:
> will be changed only in device RAM, so it will be
> cleared when
> power is lost. Trigger a 'save' to EEPROM command to
> keep
> values after power-on. Read or write are :
> +
> * '9..14': device resolution in bit
> - or resolution to set in bit
> + or resolution to set in bit
> * '-xx': xx is kernel error when reading the
> resolution
> * Anything else: do nothing
> +
> Some DS18B20 clones are fixed in 12-bit resolution, so
> the
> actual resolution is read back from the chip and
> verified. Error
> is reported if the results differ.
> @@ -65,16 +71,18 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RO) return the temperature in 1/1000 degC.
> +
> * If a bulk read has been triggered, it will
> directly
> - return the temperature computed when the bulk
> read
> - occurred, if available. If not yet available,
> nothing
> - is returned (a debug kernel message is sent),
> you
> - should retry later on.
> + return the temperature computed when the bulk
> read
> + occurred, if available. If not yet available,
> nothing
> + is returned (a debug kernel message is sent),
> you
> + should retry later on.
> * If no bulk read has been triggered, it will
> trigger
> - a conversion and send the result. Note that the
> - conversion duration depend on the resolution
> (if
> - device support this feature). It takes 94ms in
> 9bits
> - resolution, 750ms for 12bits.
> + a conversion and send the result. Note that
> the
> + conversion duration depend on the resolution
> (if
> + device support this feature). It takes 94ms
> in 9bits
> + resolution, 750ms for 12bits.
> +
> Users: any user space application which wants to
> communicate with
> w1_term device
>
> @@ -86,12 +94,14 @@ Description:
> (RW) return the temperature in 1/1000 degC.
> *read*: return 2 lines with the hexa output data sent
> on the
> bus, return the CRC check and temperature in 1/1000
> degC
> - *write* :
> + *write*:
> +
> * '0' : save the 2 or 3 bytes to the device
> EEPROM
> - (i.e. TH, TL and config register)
> + (i.e. TH, TL and config register)
> * '9..14' : set the device resolution in RAM
> - (if supported)
> + (if supported)
> * Anything else: do nothing
> +
> refer to Documentation/w1/slaves/w1_therm.rst for
> detailed
> information.
> Users: any user space application which wants to
> communicate with
> @@ -103,14 +113,21 @@ Date: May 2020
> Contact: Akira Shimahara <akira215corp@gmail.com>
> Description:
> (RW) trigger a bulk read conversion. read the status
> +
> *read*:
> - * '-1': conversion in progress on at least 1
> sensor
> - * '1' : conversion complete but at least one
> sensor
> + * '-1':
> + conversion in progress on at least 1
> sensor
> + * '1' :
> + conversion complete but at least one
> sensor
> value has not been read yet
> - * '0' : no bulk operation. Reading
> temperature will
> + * '0' :
> + no bulk operation. Reading temperature
> will
> trigger a conversion on each device
> - *write*: 'trigger': trigger a bulk read on all
> supporting
> +
> + *write*:
> + 'trigger': trigger a bulk read on all
> supporting
> devices on the bus
> +
> Note that if a bulk read is sent but one sensor is not
> read
> immediately, the next access to temperature on this
> device
> will return the temperature measured at the time of
> issue
> @@ -128,14 +145,19 @@ Description:
> reset to default (datasheet) conversion time for a new
> resolution.
>
> - *read*: Actual conversion time in milliseconds.
> *write*:
> - '0': Set the default conversion time from the
> datasheet.
> - '1': Measure and set the conversion time. Make
> a single
> + *read*:
> + Actual conversion time in milliseconds.
> +
> + *write*:
> + * '0':
> + Set the default conversion time from the
> datasheet.
> + * '1':
> + Measure and set the conversion time. Make
> a single
> temperature conversion, measure an actual
> value.
> Increase it by 20% for temperature range.
> A new
> conversion time can be obtained by reading
> this
> same attribute.
> - other positive value:
> + * other positive value:
> Set the conversion time in milliseconds.
>
> Users: An application using the w1_term device
> @@ -148,16 +170,21 @@ Description:
> (RW) Control optional driver settings.
> Bit masks to read/write (bitwise OR):
>
> - 1: Enable check for conversion success. If byte 6 of
> + ==
> ============================================================
> + 1 Enable check for conversion success. If byte 6 of
> scratchpad memory is 0xC after conversion, and
> temperature reads 85.00 (powerup value) or 127.94
> (insufficient power) - return a conversion error.
>
> - 2: Enable poll for conversion completion. Generate
> read cycles
> + 2 Enable poll for conversion completion. Generate
> read cycles
> after the conversion start and wait for 1's. In
> parasite
> power mode this feature is not available.
> + ==
> ============================================================
>
> - *read*: Currently selected features.
> - *write*: Select features.
> + *read*:
> + Currently selected features.
> +
> + *write*:
> + Select features.
>
> Users: An application using the w1_term device
> diff --git a/Documentation/ABI/testing/sysfs-platform-dfl-fme
> b/Documentation/ABI/testing/sysfs-platform-dfl-fme
> index 3683cb1cdc3d..d6ab34e81b9b 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dfl-fme
> +++ b/Documentation/ABI/testing/sysfs-platform-dfl-fme
> @@ -113,8 +113,11 @@ KernelVersion: 5.5
> Contact: Wu Hao <hao.wu@intel.com>
> Description: Read-Only. Read this file to get the name of hwmon
> device, it
> supports values:
> - 'dfl_fme_thermal' - thermal hwmon device name
> - 'dfl_fme_power' - power hwmon device name
> +
> + ================= =========================
> + 'dfl_fme_thermal' thermal hwmon device name
> + 'dfl_fme_power' power hwmon device name
> + ================= =========================
>
> What: /sys/bus/platform/devices/dfl-
> fme.0/hwmon/hwmonX/temp1_input
> Date: October 2019
> @@ -169,8 +172,11 @@ KernelVersion: 5.5
> Contact: Wu Hao <hao.wu@intel.com>
> Description: Read-Only. Read this file to get the policy of hardware
> threshold1
> (see 'temp1_max'). It only supports two values
> (policies):
> - 0 - AP2 state (90% throttling)
> - 1 - AP1 state (50% throttling)
> +
> + == ==========================
> + 0 AP2 state (90% throttling)
> + 1 AP1 state (50% throttling)
> + == ==========================
>
> What: /sys/bus/platform/devices/dfl-
> fme.0/hwmon/hwmonX/power1_input
> Date: October 2019
> diff --git a/Documentation/ABI/testing/sysfs-platform-dptf
> b/Documentation/ABI/testing/sysfs-platform-dptf
> index 2cbc660d163b..141834342a4d 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dptf
> +++ b/Documentation/ABI/testing/sysfs-platform-dptf
> @@ -27,12 +27,15 @@ KernelVersion: v4.10
> Contact: linux-acpi@vger.kernel.org
> Description:
> (RO) Display the platform power source
> +
> + ========= ============================
> bits[3:0] Current power source
> - 0x00 = DC
> - 0x01 = AC
> - 0x02 = USB
> - 0x03 = Wireless Charger
> + - 0x00 = DC
> + - 0x01 = AC
> + - 0x02 = USB
> + - 0x03 = Wireless Charger
> bits[7:4] Power source sequence number
> + ========= ============================
>
> What: /sys/bus/platform/devices/INT3407:00/dptf_power
> /battery_steady_power
> Date: Jul, 2016
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-
> fw-update b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-
> fw-update
> index 5aa618987cad..02ae1e9bbfc8 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-
> update
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-
> update
> @@ -8,5 +8,6 @@ Description:
> of 0 and userspace can signal SBL to update firmware,
> on next reboot, by writing a value of 1.
> There are two available states:
> +
> * 0 -> Skip firmware update while rebooting
> * 1 -> Attempt firmware update on next reboot
> diff --git a/Documentation/ABI/testing/sysfs-platform-mellanox-
> bootctl b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> index 401d202f478b..e79ca22e2f45 100644
> --- a/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> +++ b/Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
> @@ -5,10 +5,13 @@ Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The Life-cycle state of the SoC, which could be one of
> the
> following values.
> - Production - Production state and can be updated to
> secure
> - GA Secured - Secure chip and not able to change state
> - GA Non-Secured - Non-Secure chip and not able to
> change state
> - RMA - Return Merchandise Authorization
> +
> + ============== =======================================
> ======
> + Production Production state and can be updated to
> secure
> + GA Secured Secure chip and not able to change
> state
> + GA Non-Secured Non-Secure chip and not able to change
> state
> + RMA Return Merchandise Authorization
> + ============== =======================================
> ======
>
> What: /sys/bus/platform/devices/MLNXBF04:00/post_rese
> t_wdog
> Date: Oct 2019
> @@ -25,10 +28,13 @@ KernelVersion: 5.5
> Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The source of the boot stream for the next reset. It
> could be
> - one of the following values.
> - external - boot from external source (USB or PCIe)
> - emmc - boot from the onchip eMMC
> - emmc_legacy - boot from the onchip eMMC in legacy
> (slow) mode
> + one of the following values:
> +
> + =========== ==========================================
> =====
> + external boot from external source (USB or PCIe)
> + emmc boot from the onchip eMMC
> + emmc_legacy boot from the onchip eMMC in legacy (slow)
> mode
> + =========== ==========================================
> =====
>
> What: /sys/bus/platform/devices/MLNXBF04:00/second_re
> set_action
> Date: Oct 2019
> @@ -38,11 +44,14 @@ Description:
> Update the source of the boot stream after next reset.
> It could
> be one of the following values and will be applied
> after next
> reset.
> - external - boot from external source (USB or PCIe)
> - emmc - boot from the onchip eMMC
> - emmc_legacy - boot from the onchip eMMC in legacy
> (slow) mode
> - swap_emmc - swap the primary / secondary boot
> partition
> - none - cancel the action
> +
> + =========== ==========================================
> =====
> + external boot from external source (USB or PCIe)
> + emmc boot from the onchip eMMC
> + emmc_legacy boot from the onchip eMMC in legacy (slow)
> mode
> + swap_emmc swap the primary / secondary boot
> partition
> + none cancel the action
> + =========== ==========================================
> =====
>
> What: /sys/bus/platform/devices/MLNXBF04:00/secure_bo
> ot_fuse_state
> Date: Oct 2019
> @@ -50,9 +59,12 @@ KernelVersion: 5.5
> Contact: "Liming Sun <lsun@mellanox.com>"
> Description:
> The state of eFuse versions with the following values.
> - InUse - burnt, valid and currently in use
> - Used - burnt and valid
> - Free - not burnt and free to use
> - Skipped - not burnt but not free (skipped)
> - Wasted - burnt and invalid
> - Invalid - not burnt but marked as valid (error
> state).
> +
> + ======= ==============================================
> =
> + InUse burnt, valid and currently in use
> + Used burnt and valid
> + Free not burnt and free to use
> + Skipped not burnt but not free (skipped)
> + Wasted burnt and invalid
> + Invalid not burnt but marked as valid (error state).
> + ======= ==============================================
> =
> diff --git a/Documentation/ABI/testing/sysfs-platform-wilco-ec
> b/Documentation/ABI/testing/sysfs-platform-wilco-ec
> index 5f60b184a5a5..4439d0644091 100644
> --- a/Documentation/ABI/testing/sysfs-platform-wilco-ec
> +++ b/Documentation/ABI/testing/sysfs-platform-wilco-ec
> @@ -39,6 +39,7 @@ Description:
> which affects charging via the special USB PowerShare
> port
> (marked with a small lightning bolt or battery icon)
> when in
> low power states:
> +
> - In S0, the port will always provide power.
> - In S0ix, if usb_charge is enabled, then power will
> be
> supplied to the port when on AC or if battery is >
> 50%.
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-11-02 14:42 ` Mauro Carvalho Chehab
@ 2020-11-08 16:56 ` Jonathan Cameron
2020-11-10 7:26 ` Duplicated ABI entries - Was: " Mauro Carvalho Chehab
0 siblings, 1 reply; 19+ messages in thread
From: Jonathan Cameron @ 2020-11-08 16:56 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Greg Kroah-Hartman, Fabrice Gasnier, Linux Doc Mailing List,
Gautham R. Shenoy, Jason A. Donenfeld, Javier González,
Jonathan Corbet, Martin K. Petersen, Rafael J. Wysocki,
Alexander Shishkin, Alexandre Belloni, Alexandre Torgue,
Andrew Donnellan, Andy Shevchenko, Baolin Wang, Benson Leung,
Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang, Dan Murphy,
Dan Williams, Enric Balletbo i Serra, Felipe Balbi,
Frederic Barrat, Guenter Roeck, Hanjun Guo, Heikki Krogerus,
Jens Axboe, Johannes Thumshirn, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
On Mon, 2 Nov 2020 15:42:50 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> Em Mon, 2 Nov 2020 13:46:41 +0100
> Greg Kroah-Hartman <gregkh@linuxfoundation.org> escreveu:
>
> > On Mon, Nov 02, 2020 at 12:04:36PM +0100, Fabrice Gasnier wrote:
> > > On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote:
> > > > Em Fri, 30 Oct 2020 10:19:12 +0100
> > > > Fabrice Gasnier <fabrice.gasnier@st.com> escreveu:
> > > >
> > > >> Hi Mauro,
> > > >>
> > > >> [...]
> > > >>
> > > >>>
> > > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> > > >>> +KernelVersion: 4.12
> > > >>> +Contact: benjamin.gaignard@st.com
> > > >>> +Description:
> > > >>> + Reading returns the list possible quadrature modes.
> > > >>> +
> > > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> > > >>> +KernelVersion: 4.12
> > > >>> +Contact: benjamin.gaignard@st.com
> > > >>> +Description:
> > > >>> + Configure the device counter quadrature modes:
> > > >>> +
> > > >>> + channel_A:
> > > >>> + Encoder A input servers as the count input and B as
> > > >>> + the UP/DOWN direction control input.
> > > >>> +
> > > >>> + channel_B:
> > > >>> + Encoder B input serves as the count input and A as
> > > >>> + the UP/DOWN direction control input.
> > > >>> +
> > > >>> + quadrature:
> > > >>> + Encoder A and B inputs are mixed to get direction
> > > >>> + and count with a scale of 0.25.
> > > >>> +
> > > >>
> > > >
> > > > Hi Fabrice,
> > > >
> > > >> I just noticed that since Jonathan question in v1.
> > > >>
> > > >> Above ABI has been moved in the past as discussed in [1]. You can take a
> > > >> look at:
> > > >> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
> > > >>
> > > >> Could you please remove the above chunk ?
> > > >>
> > > >> With that, for the stm32 part:
> > > >> Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> > > >
> > > >
> > > > Hmm... probably those were re-introduced due to a rebase. This
> > > > series were originally written about 1,5 years ago.
> > > >
> > > > I'll drop those hunks.
> > >
> > > Hi Mauro, Greg,
> > >
> > > I just figured out this patch has been applied with above hunk.
> > >
> > > This should be dropped: is there a fix on its way already ?
> > > (I may have missed it)
> >
> > Can you send a fix for just this hunk?
>
> Hmm...
>
> $ git grep /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
>
> Even re-doing the changes from
> changeset b299d00420e2 ("IIO: stm32: Remove quadrature related functions from trigger driver")
> at Documentation/ABI/testing/sysfs-bus-iio-timer-stm32, there's still
> a third duplicate of some of those, as reported by the script:
>
> $ ./scripts/get_abi.pl validate 2>&1|grep quadra
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
>
> As in_count_quadrature_mode_available is also defined at:
> Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2
>
> The best here seems to have a patch that will also drop the other
> duplication of this, probably moving in_count_quadrature_mode_available
> to a generic node probably placing it inside
> Documentation/ABI/testing/sysfs-bus-iio.
In this particular case it may be valid to do that, but it's not in
general without loosing information - see below.
>
> Comments?
>
> Thanks,
> Mauro
>
> PS.: the IIO subsystem is the one that currently has more duplicated
> ABI entries:
That was intentional. Often these provide more information on the
ABI for a particular device than is present in the base ABI doc.
A bit like when we have additional description for dt binding properties
for a particular device, even though they are standard properties.
Often a standard property allows for more values than the specific
one for a particular device. There can also be obscuring coupling
between sysfs attributes due to hardware restrictions that we would
like to provide some explanatory info on.
I suppose we could add all this information to the parent doc but
that is pretty ugly and will make that doc very nasty to read.
Jonathan
>
> $ ./scripts/get_abi.pl validate 2>&1|grep iio
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 Documentation/ABI/testing/sysfs-bus-iio:394
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 Documentation/ABI/testing/sysfs-bus-iio:395
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 Documentation/ABI/testing/sysfs-bus-iio:396
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 Documentation/ABI/testing/sysfs-bus-iio:397
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 Documentation/ABI/testing/sysfs-bus-iio:398
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 Documentation/ABI/testing/sysfs-bus-iio:399
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 Documentation/ABI/testing/sysfs-bus-iio:599
> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 Documentation/ABI/testing/sysfs-bus-iio:588
> Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:45
^ permalink raw reply [flat|nested] 19+ messages in thread
* Duplicated ABI entries - Was: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-11-08 16:56 ` Jonathan Cameron
@ 2020-11-10 7:26 ` Mauro Carvalho Chehab
2020-11-10 18:18 ` Randy Dunlap
2020-11-14 15:27 ` Jonathan Cameron
0 siblings, 2 replies; 19+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-10 7:26 UTC (permalink / raw)
To: Jonathan Cameron
Cc: Greg Kroah-Hartman, Fabrice Gasnier, Linux Doc Mailing List,
Gautham R. Shenoy, Jason A. Donenfeld, Javier González,
Jonathan Corbet, Martin K. Petersen, Rafael J. Wysocki,
Alexander Shishkin, Alexandre Belloni, Alexandre Torgue,
Andrew Donnellan, Andy Shevchenko, Baolin Wang, Benson Leung,
Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang, Dan Murphy,
Dan Williams, Enric Balletbo i Serra, Felipe Balbi,
Frederic Barrat, Guenter Roeck, Hanjun Guo, Heikki Krogerus,
Jens Axboe, Johannes Thumshirn, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
Hi Jonathan,
Em Sun, 8 Nov 2020 16:56:21 +0000
Jonathan Cameron <jic23@kernel.org> escreveu:
> > PS.: the IIO subsystem is the one that currently has more duplicated
> > ABI entries:
> > $ ./scripts/get_abi.pl validate 2>&1|grep iio
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 Documentation/ABI/testing/sysfs-bus-iio:394
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 Documentation/ABI/testing/sysfs-bus-iio:395
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 Documentation/ABI/testing/sysfs-bus-iio:396
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 Documentation/ABI/testing/sysfs-bus-iio:397
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 Documentation/ABI/testing/sysfs-bus-iio:398
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 Documentation/ABI/testing/sysfs-bus-iio:399
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 Documentation/ABI/testing/sysfs-bus-iio:599
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 Documentation/ABI/testing/sysfs-bus-iio:588
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:45
>
> That was intentional. Often these provide more information on the
> ABI for a particular device than is present in the base ABI doc.
FYI, right now, there are 20 duplicated entries, being 16 of them
from IIO, on those files:
$ ./scripts/get_abi.pl validate 2>&1|perl -ne 'if (m,(Documentation/\S+)\:,g) { print "$1\n" }'|sort|uniq
Documentation/ABI/stable/sysfs-driver-w1_ds28e04
Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8
Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371
Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
Documentation/ABI/testing/sysfs-bus-iio-icm42600
Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als
Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
Documentation/ABI/testing/sysfs-class-backlight-adp8860
Documentation/ABI/testing/sysfs-class-led-trigger-pattern
Documentation/ABI/testing/sysfs-kernel-iommu_groups
>
> A bit like when we have additional description for dt binding properties
> for a particular device, even though they are standard properties.
>
> Often a standard property allows for more values than the specific
> one for a particular device. There can also be obscuring coupling
> between sysfs attributes due to hardware restrictions that we would
> like to provide some explanatory info on.
>
> I suppose we could add all this information to the parent doc but
> that is pretty ugly and will make that doc very nasty to read.
I understand what you meant to do, but right now, it is is actually
a lot uglier than merging into a single entry ;-)
Let's view ABI from the PoV of a system admin that doesn't know
yet about a certain ABI symbol.
He'll try to seek for the symbol, more likely using the HTML
documentation. Only very senior system admins might try to take
a look at the Kernel.
This is what happens when one would seek for a duplicated symbol
via command line:
$ ./scripts/get_abi.pl search /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency$
/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency
----------------------------------------------------------
Kernel version: 3.4.0
Contact: linux-iio@vger.kernel.org
Defined on file(s): Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371 Documentation/ABI/testing/sysfs-bus-iio
Description:
Stores the PLL frequency in Hz for channel Y.
Reading returns the actual frequency in Hz.
The ADF4371 has an integrated VCO with fundamendal output
frequency ranging from 4000000000 Hz 8000000000 Hz.
out_altvoltage0_frequency:
A divide by 1, 2, 4, 8, 16, 32 or circuit generates
frequencies from 62500000 Hz to 8000000000 Hz.
out_altvoltage1_frequency:
This channel duplicates the channel 0 frequency
out_altvoltage2_frequency:
A frequency doubler generates frequencies from
8000000000 Hz to 16000000000 Hz.
out_altvoltage3_frequency:
A frequency quadrupler generates frequencies from
16000000000 Hz to 32000000000 Hz.
Note: writes to one of the channels will affect the frequency of
all the other channels, since it involves changing the VCO
fundamental output frequency.
Output frequency for channel Y in Hz. The number must always be
specified and unique if the output corresponds to a single
channel.
As the "What:" field is identical on both sysfs-bus-iio-frequency-adf4371
and sysfs-bus-iio, those entries are merged, which produces an ABI
documentation mixing both the generic one and the board specific one
into a single output.
Worse than that, the "generic" content is at the end.
The same happens when generating the HTML output.
See, entries at the HTML output are ordered by the What: field,
which is considered within the script as an unique key, as it is
unique (except for IIO and a couple of other cases).
-
As I commented on an e-mail I sent to Greg, I see a few ways
to solve it.
The most trivial one (which I used to solve a few conflicts on
other places), is to place driver-specific details on a separate
file under Documentation/driver-api, and mention it at the
generic entries. The docs building system will generate cross
references for Documentation/.../foo.rst files, so, everything
should be OK.
The second alternative that I also used on a couple of places
is to modify the generic entry for it to contain the generic
definition first, followed by per-device details.
There is a third possible alternative: add a new optional field
(something like Scope:) which would be part of the unique key,
if present. Implementing support for it could be tricky, as the
produced output would likely need to create cross-references
between the generic field (if present) and the per-device details.
Thanks,
Mauro
PS.: I'm taking a few days of PTO during this week. So, it
could take a while for me to reply again to this thread.
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: Duplicated ABI entries - Was: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-11-10 7:26 ` Duplicated ABI entries - Was: " Mauro Carvalho Chehab
@ 2020-11-10 18:18 ` Randy Dunlap
2020-11-14 15:27 ` Jonathan Cameron
1 sibling, 0 replies; 19+ messages in thread
From: Randy Dunlap @ 2020-11-10 18:18 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Jonathan Cameron
Cc: Greg Kroah-Hartman, Fabrice Gasnier, Linux Doc Mailing List,
Gautham R. Shenoy, Jason A. Donenfeld, Javier González,
Jonathan Corbet, Martin K. Petersen, Rafael J. Wysocki,
Alexander Shishkin, Alexandre Belloni, Alexandre Torgue,
Andrew Donnellan, Andy Shevchenko, Baolin Wang, Benson Leung,
Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang, Dan Murphy,
Dan Williams, Enric Balletbo i Serra, Felipe Balbi,
Frederic Barrat, Guenter Roeck, Hanjun Guo, Heikki Krogerus,
Jens Axboe, Johannes Thumshirn, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
On 11/9/20 11:26 PM, Mauro Carvalho Chehab wrote:
> Hi Jonathan,
>
> Let's view ABI from the PoV of a system admin that doesn't know
> yet about a certain ABI symbol.
>
> He'll try to seek for the symbol, more likely using the HTML
> documentation. Only very senior system admins might try to take
> a look at the Kernel.
FWIW, I think that the likely search methods are $search_engine
and 'grep'.
Have a good few days off.
--
~Randy
^ permalink raw reply [flat|nested] 19+ messages in thread
* Re: Duplicated ABI entries - Was: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
2020-11-10 7:26 ` Duplicated ABI entries - Was: " Mauro Carvalho Chehab
2020-11-10 18:18 ` Randy Dunlap
@ 2020-11-14 15:27 ` Jonathan Cameron
1 sibling, 0 replies; 19+ messages in thread
From: Jonathan Cameron @ 2020-11-14 15:27 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Greg Kroah-Hartman, Fabrice Gasnier, Linux Doc Mailing List,
Gautham R. Shenoy, Jason A. Donenfeld, Javier González,
Jonathan Corbet, Martin K. Petersen, Rafael J. Wysocki,
Alexander Shishkin, Alexandre Belloni, Alexandre Torgue,
Andrew Donnellan, Andy Shevchenko, Baolin Wang, Benson Leung,
Boris Ostrovsky, Bruno Meneguele, Chunyan Zhang, Dan Murphy,
Dan Williams, Enric Balletbo i Serra, Felipe Balbi,
Frederic Barrat, Guenter Roeck, Hanjun Guo, Heikki Krogerus,
Jens Axboe, Johannes Thumshirn, Juergen Gross,
Konstantin Khlebnikov, Kranthi Kuntala, Lakshmi Ramasubramanian,
Lars-Peter Clausen, Len Brown, Leonid Maksymchuk,
Ludovic Desroches, Mario Limonciello, Mark Gross,
Maxime Coquelin, Michael Ellerman, Mika Westerberg, Mike Kravetz,
Mimi Zohar, Nayna Jain, Nicolas Ferre, Niklas Cassel,
Oded Gabbay, Oleh Kravchenko, Orson Zhai, Pavel Machek,
Pawan Gupta, Peter Meerwald-Stadler, Peter Rosin, Petr Mladek,
Philippe Bergheaud, Richard Cochran, Sebastian Reichel,
Sergey Senozhatsky, Stefano Stabellini, Thinh Nguyen,
Thomas Gleixner, Tom Rix, Vaibhav Jain, Vineela Tummalapalli,
Vishal Verma, linux-acpi, linux-arm-kernel, linux-iio,
linux-kernel, linux-mm, linux-pm, linux-stm32, linux-usb,
linuxppc-dev, netdev, xen-devel, Jonathan Cameron
On Tue, 10 Nov 2020 08:26:58 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> Hi Jonathan,
>
> Em Sun, 8 Nov 2020 16:56:21 +0000
> Jonathan Cameron <jic23@kernel.org> escreveu:
>
> > > PS.: the IIO subsystem is the one that currently has more duplicated
> > > ABI entries:
> > > $ ./scripts/get_abi.pl validate 2>&1|grep iio
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 Documentation/ABI/testing/sysfs-bus-iio:394
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 Documentation/ABI/testing/sysfs-bus-iio:395
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 Documentation/ABI/testing/sysfs-bus-iio:396
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 Documentation/ABI/testing/sysfs-bus-iio:397
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 Documentation/ABI/testing/sysfs-bus-iio:398
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 Documentation/ABI/testing/sysfs-bus-iio:399
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 Documentation/ABI/testing/sysfs-bus-iio:599
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 Documentation/ABI/testing/sysfs-bus-iio:588
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> > > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 Documentation/ABI/testing/sysfs-bus-iio:45
>
> >
> > That was intentional. Often these provide more information on the
> > ABI for a particular device than is present in the base ABI doc.
>
> FYI, right now, there are 20 duplicated entries, being 16 of them
> from IIO, on those files:
>
> $ ./scripts/get_abi.pl validate 2>&1|perl -ne 'if (m,(Documentation/\S+)\:,g) { print "$1\n" }'|sort|uniq
> Documentation/ABI/stable/sysfs-driver-w1_ds28e04
> Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8
> Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
> Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371
> Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
> Documentation/ABI/testing/sysfs-bus-iio-icm42600
> Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als
> Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> Documentation/ABI/testing/sysfs-class-backlight-adp8860
> Documentation/ABI/testing/sysfs-class-led-trigger-pattern
> Documentation/ABI/testing/sysfs-kernel-iommu_groups
>
> >
> > A bit like when we have additional description for dt binding properties
> > for a particular device, even though they are standard properties.
> >
> > Often a standard property allows for more values than the specific
> > one for a particular device. There can also be obscuring coupling
> > between sysfs attributes due to hardware restrictions that we would
> > like to provide some explanatory info on.
> >
> > I suppose we could add all this information to the parent doc but
> > that is pretty ugly and will make that doc very nasty to read.
>
> I understand what you meant to do, but right now, it is is actually
> a lot uglier than merging into a single entry ;-)
>
> Let's view ABI from the PoV of a system admin that doesn't know
> yet about a certain ABI symbol.
I'd be surprised if a sys admin is looking at these at all. They
tend to be used only by userspace software writers. But I guess the
point stands.
>
> He'll try to seek for the symbol, more likely using the HTML
> documentation. Only very senior system admins might try to take
> a look at the Kernel.
Sad truth here is that before these were in the html docs, they'd
have grepped and the right option would fairly obvious as it
would be the more specific file. Ah well, sometimes progress bites :)
>
> This is what happens when one would seek for a duplicated symbol
> via command line:
>
> $ ./scripts/get_abi.pl search /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency$
>
> /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency
> ----------------------------------------------------------
>
> Kernel version: 3.4.0
> Contact: linux-iio@vger.kernel.org
> Defined on file(s): Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371 Documentation/ABI/testing/sysfs-bus-iio
>
> Description:
>
> Stores the PLL frequency in Hz for channel Y.
> Reading returns the actual frequency in Hz.
> The ADF4371 has an integrated VCO with fundamendal output
> frequency ranging from 4000000000 Hz 8000000000 Hz.
>
> out_altvoltage0_frequency:
> A divide by 1, 2, 4, 8, 16, 32 or circuit generates
> frequencies from 62500000 Hz to 8000000000 Hz.
> out_altvoltage1_frequency:
> This channel duplicates the channel 0 frequency
> out_altvoltage2_frequency:
> A frequency doubler generates frequencies from
> 8000000000 Hz to 16000000000 Hz.
> out_altvoltage3_frequency:
> A frequency quadrupler generates frequencies from
> 16000000000 Hz to 32000000000 Hz.
>
> Note: writes to one of the channels will affect the frequency of
> all the other channels, since it involves changing the VCO
> fundamental output frequency.
>
> Output frequency for channel Y in Hz. The number must always be
> specified and unique if the output corresponds to a single
> channel.
>
> As the "What:" field is identical on both sysfs-bus-iio-frequency-adf4371
> and sysfs-bus-iio, those entries are merged, which produces an ABI
> documentation mixing both the generic one and the board specific one
> into a single output.
>
> Worse than that, the "generic" content is at the end.
>
> The same happens when generating the HTML output.
>
> See, entries at the HTML output are ordered by the What: field,
> which is considered within the script as an unique key, as it is
> unique (except for IIO and a couple of other cases).
>
> -
>
> As I commented on an e-mail I sent to Greg, I see a few ways
> to solve it.
>
> The most trivial one (which I used to solve a few conflicts on
> other places), is to place driver-specific details on a separate
> file under Documentation/driver-api, and mention it at the
> generic entries. The docs building system will generate cross
> references for Documentation/.../foo.rst files, so, everything
> should be OK.
Hmm. That might work out OK. These devices tend to be weird enough
that they probably could do with some additional explanation anyway.
>
> The second alternative that I also used on a couple of places
> is to modify the generic entry for it to contain the generic
> definition first, followed by per-device details.
I'll do an audit of what we actually have here. Perhaps we end
up with a mixture of these two options.
Might take a little while though.
>
> There is a third possible alternative: add a new optional field
> (something like Scope:) which would be part of the unique key,
> if present. Implementing support for it could be tricky, as the
> produced output would likely need to create cross-references
> between the generic field (if present) and the per-device details.
That would be lovely but probably not worth the effort for something
that occurs so rarely currently.
Jonathan
>
> Thanks,
> Mauro
>
> PS.: I'm taking a few days of PTO during this week. So, it
> could take a while for me to reply again to this thread.
^ permalink raw reply [flat|nested] 19+ messages in thread
end of thread, other threads:[~2020-11-14 15:28 UTC | newest]
Thread overview: 19+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <cover.1604042072.git.mchehab+huawei@kernel.org>
2020-10-30 7:40 ` [PATCH v2 28/39] docs: ABI: fix syntax to be parsed using ReST notation Mauro Carvalho Chehab
2020-10-30 14:39 ` Rafael J. Wysocki
2020-11-02 5:50 ` Jinpu Wang
2020-11-02 18:39 ` Joseph, Jithu
2020-10-30 7:40 ` [PATCH v2 35/39] docs: ABI: sysfs-class-power: unify duplicated properties Mauro Carvalho Chehab
[not found] ` <58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org>
[not found] ` <5326488b-4185-9d67-fc09-79b911fbb3b8@st.com>
2020-10-30 10:09 ` [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output Mauro Carvalho Chehab
2020-11-02 11:04 ` Fabrice Gasnier
2020-11-02 12:46 ` Greg Kroah-Hartman
2020-11-02 14:42 ` Mauro Carvalho Chehab
2020-11-08 16:56 ` Jonathan Cameron
2020-11-10 7:26 ` Duplicated ABI entries - Was: " Mauro Carvalho Chehab
2020-11-10 18:18 ` Randy Dunlap
2020-11-14 15:27 ` Jonathan Cameron
2020-10-30 17:26 ` Frederic Barrat
[not found] ` <5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org>
2020-10-30 8:27 ` [PATCH v2 31/39] docs: ABI: cleanup several ABI documents Rojewski, Cezary
2020-10-30 9:49 ` Suzuki K Poulose
2020-10-30 11:11 ` Ilya Dryomov
2020-10-30 16:42 ` Mathieu Poirier
2020-10-30 23:23 ` Peter Chen
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).