Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: ABI: fix syntax to be parsed using ReST notation

There are a number of new changes at the ABI files that cause
them to produce warnings when generating ABI output.

Fix them.

Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/55a89f423cf122982c462d257722e44d6ece4b36.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Mauro Carvalho Chehab and committed by
Greg Kroah-Hartman
002a9c2f b1faa368

+271 -161
+37 -25
Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
··· 12 12 resets. Three registers are used by the FSBL and 13 13 other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}. 14 14 15 - Usage: 16 - # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 17 - # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 15 + Usage:: 18 16 19 - Example: 20 - # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 21 - # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 17 + # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 18 + # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 19 + 20 + Example:: 21 + 22 + # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 23 + # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0 22 24 23 25 Users: Xilinx 24 26 ··· 41 39 software products: PERS_GLOB_GEN_STORAGE{4:7}. 42 40 Register is reset only by a POR reset. 43 41 44 - Usage: 45 - # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 46 - # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 42 + Usage:: 47 43 48 - Example: 49 - # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 50 - # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 44 + # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 45 + # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 46 + 47 + Example:: 48 + 49 + # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 50 + # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0 51 51 52 52 Users: Xilinx 53 53 ··· 65 61 66 62 Following are available shutdown scopes(subtypes): 67 63 68 - subsystem: Only the APU along with all of its peripherals 64 + subsystem: 65 + Only the APU along with all of its peripherals 69 66 not used by other processing units will be 70 67 shut down. This may result in the FPD power 71 68 domain being shut down provided that no other 72 69 processing unit uses FPD peripherals or DRAM. 73 - ps_only: The complete PS will be shut down, including the 70 + ps_only: 71 + The complete PS will be shut down, including the 74 72 RPU, PMU, etc. Only the PL domain (FPGA) 75 73 remains untouched. 76 - system: The complete system/device is shut down. 74 + system: 75 + The complete system/device is shut down. 77 76 78 - Usage: 79 - # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 80 - # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 77 + Usage:: 81 78 82 - Example: 83 - # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 84 - # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 79 + # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 80 + # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 81 + 82 + Example:: 83 + 84 + # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 85 + # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope 85 86 86 87 Users: Xilinx 87 88 ··· 103 94 system restart. 104 95 105 96 Usage: 106 - Set healthy bit 107 - # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status 108 97 109 - Unset healthy bit 110 - # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status 98 + Set healthy bit:: 99 + 100 + # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status 101 + 102 + Unset healthy bit:: 103 + 104 + # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status 111 105 112 106 Users: Xilinx
+20 -8
Documentation/ABI/testing/debugfs-moxtet
··· 5 5 Description: (R) Read input from the shift registers, in hexadecimal. 6 6 Returns N+1 bytes, where N is the number of Moxtet connected 7 7 modules. The first byte is from the CPU board itself. 8 - Example: 101214 9 - 10: CPU board with SD card 10 - 12: 2 = PCIe module, 1 = IRQ not active 11 - 14: 4 = Peridot module, 1 = IRQ not active 8 + 9 + Example:: 10 + 11 + 101214 12 + 13 + == ======================================= 14 + 10 CPU board with SD card 15 + 12 2 = PCIe module, 1 = IRQ not active 16 + 14 4 = Peridot module, 1 = IRQ not active 17 + == ======================================= 12 18 13 19 What: /sys/kernel/debug/moxtet/output 14 20 Date: March 2019 ··· 23 17 Description: (RW) Read last written value to the shift registers, in 24 18 hexadecimal, or write values to the shift registers, also 25 19 in hexadecimal. 26 - Example: 0102 27 - 01: 01 was last written, or is to be written, to the 28 - first module's shift register 29 - 02: the same for second module 20 + 21 + Example:: 22 + 23 + 0102 24 + 25 + == ================================================ 26 + 01 01 was last written, or is to be written, to the 27 + first module's shift register 28 + 02 the same for second module 29 + == ================================================
+4 -2
Documentation/ABI/testing/debugfs-turris-mox-rwtm
··· 2 2 Date: Jun 2020 3 3 KernelVersion: 5.8 4 4 Contact: Marek Behún <marek.behun@nic.cz> 5 - Description: (W) Message to sign with the ECDSA private key stored in 5 + Description: (W) 6 + Message to sign with the ECDSA private key stored in 6 7 device's OTP. The message must be exactly 64 bytes (since 7 8 this is intended for SHA-512 hashes). 8 - (R) The resulting signature, 136 bytes. This contains the R and 9 + (R) 10 + The resulting signature, 136 bytes. This contains the R and 9 11 S values of the ECDSA signature, both in big-endian format.
+7 -7
Documentation/ABI/testing/sysfs-bus-event_source-devices-dfl_fme
··· 8 8 9 9 Each attribute under this group defines a bit range of the 10 10 perf_event_attr.config. All supported attributes are listed 11 - below. 11 + below:: 12 12 13 13 event = "config:0-11" - event ID 14 14 evtype = "config:12-15" - event type 15 15 portid = "config:16-23" - event source 16 16 17 - For example, 17 + For example:: 18 18 19 19 fab_mmio_read = "event=0x06,evtype=0x02,portid=0xff" 20 20 ··· 40 40 41 41 All supported performance monitoring events are listed below. 42 42 43 - Basic events (evtype=0x00) 43 + Basic events (evtype=0x00):: 44 44 45 45 clock = "event=0x00,evtype=0x00,portid=0xff" 46 46 47 - Cache events (evtype=0x01) 47 + Cache events (evtype=0x01):: 48 48 49 49 cache_read_hit = "event=0x00,evtype=0x01,portid=0xff" 50 50 cache_read_miss = "event=0x01,evtype=0x01,portid=0xff" ··· 59 59 cache_rx_req_stall = "event=0x09,evtype=0x01,portid=0xff" 60 60 cache_eviction = "event=0x0a,evtype=0x01,portid=0xff" 61 61 62 - Fabric events (evtype=0x02) 62 + Fabric events (evtype=0x02):: 63 63 64 64 fab_pcie0_read = "event=0x00,evtype=0x02,portid=0xff" 65 65 fab_pcie0_write = "event=0x01,evtype=0x02,portid=0xff" ··· 78 78 fab_port_mmio_read = "event=0x06,evtype=0x02,portid=?" 79 79 fab_port_mmio_write = "event=0x07,evtype=0x02,portid=?" 80 80 81 - VTD events (evtype=0x03) 81 + VTD events (evtype=0x03):: 82 82 83 83 vtd_port_read_transaction = "event=0x00,evtype=0x03,portid=?" 84 84 vtd_port_write_transaction = "event=0x01,evtype=0x03,portid=?" ··· 88 88 vtd_port_devtlb_2m_fill = "event=0x05,evtype=0x03,portid=?" 89 89 vtd_port_devtlb_1g_fill = "event=0x06,evtype=0x03,portid=?" 90 90 91 - VTD SIP events (evtype=0x04) 91 + VTD SIP events (evtype=0x04):: 92 92 93 93 vtd_sip_iotlb_4k_hit = "event=0x00,evtype=0x04,portid=0xff" 94 94 vtd_sip_iotlb_2m_hit = "event=0x01,evtype=0x04,portid=0xff"
+4 -2
Documentation/ABI/testing/sysfs-bus-most
··· 235 235 Contact: Christian Gromm <christian.gromm@microchip.com> 236 236 Description: 237 237 This is to read back the configured direction of the channel. 238 - The following strings will be accepted: 238 + The following strings will be accepted:: 239 + 239 240 'tx', 240 241 'rx' 241 242 Users: ··· 247 246 Contact: Christian Gromm <christian.gromm@microchip.com> 248 247 Description: 249 248 This is to read back the configured data type of the channel. 250 - The following strings will be accepted: 249 + The following strings will be accepted:: 250 + 251 251 'control', 252 252 'async', 253 253 'sync',
+4 -2
Documentation/ABI/testing/sysfs-class-devfreq
··· 62 62 driver should provide the list of available frequencies 63 63 with its profile. If need to reset the statistics of devfreq 64 64 behavior on a specific device, enter 0(zero) to 'trans_stat' 65 - as following: 65 + as following:: 66 + 66 67 echo 0 > /sys/class/devfreq/.../trans_stat 67 68 68 69 What: /sys/class/devfreq/.../userspace/set_freq ··· 118 117 This work timer is used by devfreq workqueue in order to 119 118 monitor the device status such as utilization. The user 120 119 can change the work timer on runtime according to their demand 121 - as following: 120 + as following:: 121 + 122 122 echo deferrable > /sys/class/devfreq/.../timer 123 123 echo delayed > /sys/class/devfreq/.../timer
+8 -6
Documentation/ABI/testing/sysfs-class-ocxl
··· 13 13 where: 14 14 15 15 ==== =============================================== 16 - n: number of currently active contexts, for debug 17 - max: maximum number of contexts supported by the AFU 16 + n number of currently active contexts, for debug 17 + max maximum number of contexts supported by the AFU 18 18 ==== =============================================== 19 19 20 20 What: /sys/class/ocxl/<afu name>/pp_mmio_size ··· 43 43 Description: read/write 44 44 Control whether the FPGA is reloaded on a link reset. Enabled 45 45 through a vendor-specific logic block on the FPGA. 46 - 0 Do not reload FPGA image from flash 47 - 1 Reload FPGA image from flash 48 - unavailable 49 - The device does not support this capability 46 + 47 + =========== =========================================== 48 + 0 Do not reload FPGA image from flash 49 + 1 Reload FPGA image from flash 50 + unavailable The device does not support this capability 51 + =========== ===========================================
+12 -6
Documentation/ABI/testing/sysfs-class-power-wilco
··· 4 4 Description: 5 5 What charging algorithm to use: 6 6 7 - Standard: Fully charges battery at a standard rate. 8 - Adaptive: Battery settings adaptively optimized based on 7 + Standard: 8 + Fully charges battery at a standard rate. 9 + Adaptive: 10 + Battery settings adaptively optimized based on 9 11 typical battery usage pattern. 10 - Fast: Battery charges over a shorter period. 11 - Trickle: Extends battery lifespan, intended for users who 12 + Fast: 13 + Battery charges over a shorter period. 14 + Trickle: 15 + Extends battery lifespan, intended for users who 12 16 primarily use their Chromebook while connected to AC. 13 - Custom: A low and high threshold percentage is specified. 17 + Custom: 18 + A low and high threshold percentage is specified. 14 19 Charging begins when level drops below 15 20 charge_control_start_threshold, and ceases when 16 21 level is above charge_control_end_threshold. 17 - Long Life: Customized charge rate for last longer battery life. 22 + Long Life: 23 + Customized charge rate for last longer battery life. 18 24 On Wilco device this mode is pre-configured in the factory 19 25 through EC's private PID. Swiching to a different mode will 20 26 be denied by Wilco EC when Long Life mode is enabled.
+51 -42
Documentation/ABI/testing/sysfs-class-rnbd-client
··· 5 5 Description: Provide information about RNBD-client. 6 6 All sysfs files that are not read-only provide the usage information on read: 7 7 8 - Example: 9 - # cat /sys/class/rnbd-client/ctl/map_device 8 + Example:: 10 9 11 - > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr> 12 - > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side> 13 - > [access_mode=<ro|rw|migration>] > map_device 14 - > 15 - > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ] 10 + # cat /sys/class/rnbd-client/ctl/map_device 11 + 12 + > Usage: echo "sessname=<name of the rtrs session> path=<[srcaddr,]dstaddr> 13 + > [path=<[srcaddr,]dstaddr>] device_path=<full path on remote side> 14 + > [access_mode=<ro|rw|migration>] > map_device 15 + > 16 + > addr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ] 16 17 17 18 What: /sys/class/rnbd-client/ctl/map_device 18 19 Date: Feb 2020 19 20 KernelVersion: 5.7 20 21 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com> 21 - Description: Expected format is the following: 22 + Description: Expected format is the following:: 22 23 23 - sessname=<name of the rtrs session> 24 - path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...] 25 - device_path=<full path on remote side> 26 - [access_mode=<ro|rw|migration>] 24 + sessname=<name of the rtrs session> 25 + path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...] 26 + device_path=<full path on remote side> 27 + [access_mode=<ro|rw|migration>] 27 28 28 29 Where: 29 30 30 - sessname: accepts a string not bigger than 256 chars, which identifies 31 - a given session on the client and on the server. 32 - I.e. "clt_hostname-srv_hostname" could be a natural choice. 31 + sessname: 32 + accepts a string not bigger than 256 chars, which identifies 33 + a given session on the client and on the server. 34 + I.e. "clt_hostname-srv_hostname" could be a natural choice. 33 35 34 - path: describes a connection between the client and the server by 35 - specifying destination and, when required, the source address. 36 - The addresses are to be provided in the following format: 36 + path: 37 + describes a connection between the client and the server by 38 + specifying destination and, when required, the source address. 39 + The addresses are to be provided in the following format:: 37 40 38 - ip:<IPv6> 39 - ip:<IPv4> 40 - gid:<GID> 41 + ip:<IPv6> 42 + ip:<IPv4> 43 + gid:<GID> 41 44 42 - for example: 45 + for example:: 43 46 44 - path=ip:10.0.0.66 47 + path=ip:10.0.0.66 48 + 45 49 The single addr is treated as the destination. 46 50 The connection will be established to this server from any client IP address. 47 51 48 - path=ip:10.0.0.66,ip:10.0.1.66 52 + :: 53 + 54 + path=ip:10.0.0.66,ip:10.0.1.66 55 + 49 56 First addr is the source address and the second is the destination. 50 57 51 58 If multiple "path=" options are specified multiple connection 52 59 will be established and data will be sent according to 53 60 the selected multipath policy (see RTRS mp_policy sysfs entry description). 54 61 55 - device_path: Path to the block device on the server side. Path is specified 56 - relative to the directory on server side configured in the 57 - 'dev_search_path' module parameter of the rnbd_server. 58 - The rnbd_server prepends the <device_path> received from client 59 - with <dev_search_path> and tries to open the 60 - <dev_search_path>/<device_path> block device. On success, 61 - a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/ 62 - directory and an entry in /sys/class/rnbd-client/ctl/devices 63 - will be created. 62 + device_path: 63 + Path to the block device on the server side. Path is specified 64 + relative to the directory on server side configured in the 65 + 'dev_search_path' module parameter of the rnbd_server. 66 + The rnbd_server prepends the <device_path> received from client 67 + with <dev_search_path> and tries to open the 68 + <dev_search_path>/<device_path> block device. On success, 69 + a /dev/rnbd<N> device file, a /sys/block/rnbd_client/rnbd<N>/ 70 + directory and an entry in /sys/class/rnbd-client/ctl/devices 71 + will be created. 64 72 65 73 If 'dev_search_path' contains '%SESSNAME%', then each session can 66 74 have different devices namespace, e.g. server was configured with ··· 76 68 client has this string "sessname=blya device_path=sda", then server 77 69 will try to open: /run/rnbd-devs/blya/sda. 78 70 79 - access_mode: the access_mode parameter specifies if the device is to be 80 - mapped as "ro" read-only or "rw" read-write. The server allows 81 - a device to be exported in rw mode only once. The "migration" 82 - access mode has to be specified if a second mapping in read-write 83 - mode is desired. 71 + access_mode: 72 + the access_mode parameter specifies if the device is to be 73 + mapped as "ro" read-only or "rw" read-write. The server allows 74 + a device to be exported in rw mode only once. The "migration" 75 + access mode has to be specified if a second mapping in read-write 76 + mode is desired. 84 77 85 78 By default "rw" is used. 86 79 ··· 100 91 is the same as the device name. By extracting the last part of the 101 92 path the path to the device /dev/<dev-name> can be build. 102 93 103 - o /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev) 94 + * /dev/block/$(cat /sys/class/rnbd-client/ctl/devices/<device_id>/dev) 104 95 105 96 How to find the <device_id> of the device is described on the next 106 97 section. ··· 115 106 The <device_id> of each device is created as follows: 116 107 117 108 - If the 'device_path' provided during mapping contains slashes ("/"), 118 - they are replaced by exclamation mark ("!") and used as as the 119 - <device_id>. Otherwise, the <device_id> will be the same as the 120 - "device_path" provided. 109 + they are replaced by exclamation mark ("!") and used as as the 110 + <device_id>. Otherwise, the <device_id> will be the same as the 111 + "device_path" provided.
+13 -10
Documentation/ABI/testing/sysfs-class-rtrs-client
··· 10 10 KernelVersion: 5.7 11 11 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com> 12 12 Description: RW, adds a new path (connection) to an existing session. Expected format is the 13 - following: 13 + following:: 14 14 15 - <[source addr,]destination addr> 16 - *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ] 15 + <[source addr,]destination addr> 16 + *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ] 17 17 18 18 What: /sys/class/rtrs-client/<session-name>/max_reconnect_attempts 19 19 Date: Feb 2020 ··· 29 29 Description: Multipath policy specifies which path should be selected on each IO: 30 30 31 31 round-robin (0): 32 - select path in per CPU round-robin manner. 32 + select path in per CPU round-robin manner. 33 33 34 34 min-inflight (1): 35 - select path with minimum inflights. 35 + select path with minimum inflights. 36 36 37 37 What: /sys/class/rtrs-client/<session-name>/paths/ 38 38 Date: Feb 2020 ··· 109 109 not the case, the processing of an I/O response could be processed on a 110 110 different CPU than where it was originally submitted. This file shows 111 111 how many interrupts where generated on a non expected CPU. 112 - "from:" is the CPU on which the IRQ was expected, but not generated. 113 - "to:" is the CPU on which the IRQ was generated, but not expected. 112 + 113 + "from:" 114 + is the CPU on which the IRQ was expected, but not generated. 115 + "to:" 116 + is the CPU on which the IRQ was generated, but not expected. 114 117 115 118 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reconnects 116 119 Date: Feb 2020 ··· 128 125 KernelVersion: 5.7 129 126 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com> 130 127 Description: Contains statistics regarding rdma operations and inflight operations. 131 - The output consists of 6 values: 128 + The output consists of 6 values:: 132 129 133 - <read-count> <read-total-size> <write-count> <write-total-size> \ 134 - <inflights> <failovered> 130 + <read-count> <read-total-size> <write-count> \ 131 + <write-total-size> <inflights> <failovered>
+10
Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu
··· 102 102 b[15:0] 103 103 inform firmware the current software execution 104 104 stage. 105 + 106 + == =========================================== 105 107 0 the first stage bootloader didn't run or 106 108 didn't reach the point of launching second 107 109 stage bootloader. ··· 113 111 2 both first and second stage bootloader ran 114 112 and the operating system launch was 115 113 attempted. 114 + == =========================================== 116 115 117 116 b[16] 117 + == =========================================== 118 118 1 firmware to reset current image retry 119 119 counter. 120 120 0 no action. 121 + == =========================================== 121 122 122 123 b[17] 124 + == =========================================== 123 125 1 firmware to clear RSU log 124 126 0 no action. 127 + == =========================================== 125 128 126 129 b[18] 127 130 this is negative logic 131 + 132 + == =========================================== 128 133 1 no action 129 134 0 firmware record the notify code defined 130 135 in b[15:0]. 136 + == =========================================== 131 137 132 138 What: /sys/devices/platform/stratix10-rsu.0/dcmf0 133 139 Date: June 2020
+51 -24
Documentation/ABI/testing/sysfs-driver-w1_therm
··· 22 22 device data to its embedded EEPROM, either restore data 23 23 embedded in device EEPROM. Be aware that devices support 24 24 limited EEPROM writing cycles (typical 50k) 25 + 25 26 * 'save': save device RAM to EEPROM 26 27 * 'restore': restore EEPROM data in device RAM 28 + 27 29 Users: any user space application which wants to communicate with 28 30 w1_term device 29 31 ··· 35 33 Contact: Akira Shimahara <akira215corp@gmail.com> 36 34 Description: 37 35 (RO) return the power status by asking the device 36 + 38 37 * '0': device parasite powered 39 38 * '1': device externally powered 40 39 * '-xx': xx is kernel error when reading power status 40 + 41 41 Users: any user space application which wants to communicate with 42 42 w1_term device 43 43 ··· 53 49 will be changed only in device RAM, so it will be cleared when 54 50 power is lost. Trigger a 'save' to EEPROM command to keep 55 51 values after power-on. Read or write are : 52 + 56 53 * '9..14': device resolution in bit 57 - or resolution to set in bit 54 + or resolution to set in bit 58 55 * '-xx': xx is kernel error when reading the resolution 59 56 * Anything else: do nothing 57 + 60 58 Some DS18B20 clones are fixed in 12-bit resolution, so the 61 59 actual resolution is read back from the chip and verified. Error 62 60 is reported if the results differ. ··· 71 65 Contact: Akira Shimahara <akira215corp@gmail.com> 72 66 Description: 73 67 (RO) return the temperature in 1/1000 degC. 68 + 74 69 * If a bulk read has been triggered, it will directly 75 - return the temperature computed when the bulk read 76 - occurred, if available. If not yet available, nothing 77 - is returned (a debug kernel message is sent), you 78 - should retry later on. 70 + return the temperature computed when the bulk read 71 + occurred, if available. If not yet available, nothing 72 + is returned (a debug kernel message is sent), you 73 + should retry later on. 79 74 * If no bulk read has been triggered, it will trigger 80 - a conversion and send the result. Note that the 81 - conversion duration depend on the resolution (if 82 - device support this feature). It takes 94ms in 9bits 83 - resolution, 750ms for 12bits. 75 + a conversion and send the result. Note that the 76 + conversion duration depend on the resolution (if 77 + device support this feature). It takes 94ms in 9bits 78 + resolution, 750ms for 12bits. 79 + 84 80 Users: any user space application which wants to communicate with 85 81 w1_term device 86 82 ··· 94 86 (RW) return the temperature in 1/1000 degC. 95 87 *read*: return 2 lines with the hexa output data sent on the 96 88 bus, return the CRC check and temperature in 1/1000 degC 97 - *write* : 89 + *write*: 90 + 98 91 * '0' : save the 2 or 3 bytes to the device EEPROM 99 - (i.e. TH, TL and config register) 92 + (i.e. TH, TL and config register) 100 93 * '9..14' : set the device resolution in RAM 101 - (if supported) 94 + (if supported) 102 95 * Anything else: do nothing 96 + 103 97 refer to Documentation/w1/slaves/w1_therm.rst for detailed 104 98 information. 105 99 Users: any user space application which wants to communicate with ··· 113 103 Contact: Akira Shimahara <akira215corp@gmail.com> 114 104 Description: 115 105 (RW) trigger a bulk read conversion. read the status 106 + 116 107 *read*: 117 - * '-1': conversion in progress on at least 1 sensor 118 - * '1' : conversion complete but at least one sensor 108 + * '-1': 109 + conversion in progress on at least 1 sensor 110 + * '1' : 111 + conversion complete but at least one sensor 119 112 value has not been read yet 120 - * '0' : no bulk operation. Reading temperature will 113 + * '0' : 114 + no bulk operation. Reading temperature will 121 115 trigger a conversion on each device 122 - *write*: 'trigger': trigger a bulk read on all supporting 116 + 117 + *write*: 118 + 'trigger': trigger a bulk read on all supporting 123 119 devices on the bus 120 + 124 121 Note that if a bulk read is sent but one sensor is not read 125 122 immediately, the next access to temperature on this device 126 123 will return the temperature measured at the time of issue ··· 145 128 reset to default (datasheet) conversion time for a new 146 129 resolution. 147 130 148 - *read*: Actual conversion time in milliseconds. *write*: 149 - '0': Set the default conversion time from the datasheet. 150 - '1': Measure and set the conversion time. Make a single 131 + *read*: 132 + Actual conversion time in milliseconds. 133 + 134 + *write*: 135 + * '0': 136 + Set the default conversion time from the datasheet. 137 + * '1': 138 + Measure and set the conversion time. Make a single 151 139 temperature conversion, measure an actual value. 152 140 Increase it by 20% for temperature range. A new 153 141 conversion time can be obtained by reading this 154 142 same attribute. 155 - other positive value: 143 + * other positive value: 156 144 Set the conversion time in milliseconds. 157 145 158 146 Users: An application using the w1_term device ··· 170 148 (RW) Control optional driver settings. 171 149 Bit masks to read/write (bitwise OR): 172 150 173 - 1: Enable check for conversion success. If byte 6 of 151 + == ============================================================ 152 + 1 Enable check for conversion success. If byte 6 of 174 153 scratchpad memory is 0xC after conversion, and 175 154 temperature reads 85.00 (powerup value) or 127.94 176 155 (insufficient power) - return a conversion error. 177 156 178 - 2: Enable poll for conversion completion. Generate read cycles 157 + 2 Enable poll for conversion completion. Generate read cycles 179 158 after the conversion start and wait for 1's. In parasite 180 159 power mode this feature is not available. 160 + == ============================================================ 181 161 182 - *read*: Currently selected features. 183 - *write*: Select features. 162 + *read*: 163 + Currently selected features. 164 + 165 + *write*: 166 + Select features. 184 167 185 168 Users: An application using the w1_term device
+10 -4
Documentation/ABI/testing/sysfs-platform-dfl-fme
··· 113 113 Contact: Wu Hao <hao.wu@intel.com> 114 114 Description: Read-Only. Read this file to get the name of hwmon device, it 115 115 supports values: 116 - 'dfl_fme_thermal' - thermal hwmon device name 117 - 'dfl_fme_power' - power hwmon device name 116 + 117 + ================= ========================= 118 + 'dfl_fme_thermal' thermal hwmon device name 119 + 'dfl_fme_power' power hwmon device name 120 + ================= ========================= 118 121 119 122 What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input 120 123 Date: October 2019 ··· 172 169 Contact: Wu Hao <hao.wu@intel.com> 173 170 Description: Read-Only. Read this file to get the policy of hardware threshold1 174 171 (see 'temp1_max'). It only supports two values (policies): 175 - 0 - AP2 state (90% throttling) 176 - 1 - AP1 state (50% throttling) 172 + 173 + == ========================== 174 + 0 AP2 state (90% throttling) 175 + 1 AP1 state (50% throttling) 176 + == ========================== 177 177 178 178 What: /sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_input 179 179 Date: October 2019
+7 -4
Documentation/ABI/testing/sysfs-platform-dptf
··· 27 27 Contact: linux-acpi@vger.kernel.org 28 28 Description: 29 29 (RO) Display the platform power source 30 + 31 + ========= ============================ 30 32 bits[3:0] Current power source 31 - 0x00 = DC 32 - 0x01 = AC 33 - 0x02 = USB 34 - 0x03 = Wireless Charger 33 + - 0x00 = DC 34 + - 0x01 = AC 35 + - 0x02 = USB 36 + - 0x03 = Wireless Charger 35 37 bits[7:4] Power source sequence number 38 + ========= ============================ 36 39 37 40 What: /sys/bus/platform/devices/INT3407:00/dptf_power/battery_steady_power 38 41 Date: Jul, 2016
+1
Documentation/ABI/testing/sysfs-platform-intel-wmi-sbl-fw-update
··· 8 8 of 0 and userspace can signal SBL to update firmware, 9 9 on next reboot, by writing a value of 1. 10 10 There are two available states: 11 + 11 12 * 0 -> Skip firmware update while rebooting 12 13 * 1 -> Attempt firmware update on next reboot
+31 -19
Documentation/ABI/testing/sysfs-platform-mellanox-bootctl
··· 5 5 Description: 6 6 The Life-cycle state of the SoC, which could be one of the 7 7 following values. 8 - Production - Production state and can be updated to secure 9 - GA Secured - Secure chip and not able to change state 10 - GA Non-Secured - Non-Secure chip and not able to change state 11 - RMA - Return Merchandise Authorization 8 + 9 + ============== ============================================= 10 + Production Production state and can be updated to secure 11 + GA Secured Secure chip and not able to change state 12 + GA Non-Secured Non-Secure chip and not able to change state 13 + RMA Return Merchandise Authorization 14 + ============== ============================================= 12 15 13 16 What: /sys/bus/platform/devices/MLNXBF04:00/post_reset_wdog 14 17 Date: Oct 2019 ··· 28 25 Contact: "Liming Sun <lsun@mellanox.com>" 29 26 Description: 30 27 The source of the boot stream for the next reset. It could be 31 - one of the following values. 32 - external - boot from external source (USB or PCIe) 33 - emmc - boot from the onchip eMMC 34 - emmc_legacy - boot from the onchip eMMC in legacy (slow) mode 28 + one of the following values: 29 + 30 + =========== =============================================== 31 + external boot from external source (USB or PCIe) 32 + emmc boot from the onchip eMMC 33 + emmc_legacy boot from the onchip eMMC in legacy (slow) mode 34 + =========== =============================================== 35 35 36 36 What: /sys/bus/platform/devices/MLNXBF04:00/second_reset_action 37 37 Date: Oct 2019 ··· 44 38 Update the source of the boot stream after next reset. It could 45 39 be one of the following values and will be applied after next 46 40 reset. 47 - external - boot from external source (USB or PCIe) 48 - emmc - boot from the onchip eMMC 49 - emmc_legacy - boot from the onchip eMMC in legacy (slow) mode 50 - swap_emmc - swap the primary / secondary boot partition 51 - none - cancel the action 41 + 42 + =========== =============================================== 43 + external boot from external source (USB or PCIe) 44 + emmc boot from the onchip eMMC 45 + emmc_legacy boot from the onchip eMMC in legacy (slow) mode 46 + swap_emmc swap the primary / secondary boot partition 47 + none cancel the action 48 + =========== =============================================== 52 49 53 50 What: /sys/bus/platform/devices/MLNXBF04:00/secure_boot_fuse_state 54 51 Date: Oct 2019 ··· 59 50 Contact: "Liming Sun <lsun@mellanox.com>" 60 51 Description: 61 52 The state of eFuse versions with the following values. 62 - InUse - burnt, valid and currently in use 63 - Used - burnt and valid 64 - Free - not burnt and free to use 65 - Skipped - not burnt but not free (skipped) 66 - Wasted - burnt and invalid 67 - Invalid - not burnt but marked as valid (error state). 53 + 54 + ======= =============================================== 55 + InUse burnt, valid and currently in use 56 + Used burnt and valid 57 + Free not burnt and free to use 58 + Skipped not burnt but not free (skipped) 59 + Wasted burnt and invalid 60 + Invalid not burnt but marked as valid (error state). 61 + ======= ===============================================
+1
Documentation/ABI/testing/sysfs-platform-wilco-ec
··· 39 39 which affects charging via the special USB PowerShare port 40 40 (marked with a small lightning bolt or battery icon) when in 41 41 low power states: 42 + 42 43 - In S0, the port will always provide power. 43 44 - In S0ix, if usb_charge is enabled, then power will be 44 45 supplied to the port when on AC or if battery is > 50%.