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

docs: ABI: testing: make the files compatible with ReST output

Some files over there won't parse well by Sphinx.

Fix them.

Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO
Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/58cf3c2d611e0197fb215652719ebd82ca2658db.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
34433332 98913408

+1306 -849
+19 -17
Documentation/ABI/testing/configfs-spear-pcie-gadget
··· 10 10 This interfaces can be used to show spear's PCIe device capability. 11 11 12 12 Nodes are only visible when configfs is mounted. To mount configfs 13 - in /config directory use: 14 - # mount -t configfs none /config/ 13 + in /config directory use:: 15 14 16 - For nth PCIe Device Controller 17 - /config/pcie-gadget.n/ 18 - link ... used to enable ltssm and read its status. 19 - int_type ...used to configure and read type of supported 20 - interrupt 21 - no_of_msi ... used to configure number of MSI vector needed and 15 + # mount -t configfs none /config/ 16 + 17 + For nth PCIe Device Controller /config/pcie-gadget.n/: 18 + 19 + =============== ====================================================== 20 + link used to enable ltssm and read its status. 21 + int_type used to configure and read type of supported interrupt 22 + no_of_msi used to configure number of MSI vector needed and 22 23 to read no of MSI granted. 23 - inta ... write 1 to assert INTA and 0 to de-assert. 24 - send_msi ... write MSI vector to be sent. 25 - vendor_id ... used to write and read vendor id (hex) 26 - device_id ... used to write and read device id (hex) 27 - bar0_size ... used to write and read bar0_size 28 - bar0_address ... used to write and read bar0 mapped area in hex. 29 - bar0_rw_offset ... used to write and read offset of bar0 where 30 - bar0_data will be written or read. 31 - bar0_data ... used to write and read data at bar0_rw_offset. 24 + inta write 1 to assert INTA and 0 to de-assert. 25 + send_msi write MSI vector to be sent. 26 + vendor_id used to write and read vendor id (hex) 27 + device_id used to write and read device id (hex) 28 + bar0_size used to write and read bar0_size 29 + bar0_address used to write and read bar0 mapped area in hex. 30 + bar0_rw_offset used to write and read offset of bar0 where bar0_data 31 + will be written or read. 32 + bar0_data used to write and read data at bar0_rw_offset. 33 + =============== ======================================================
+49 -34
Documentation/ABI/testing/configfs-usb-gadget
··· 12 12 13 13 The attributes of a gadget: 14 14 15 - UDC - bind a gadget to UDC/unbind a gadget; 16 - write UDC's name found in /sys/class/udc/* 17 - to bind a gadget, empty string "" to unbind. 15 + ================ ============================================ 16 + UDC bind a gadget to UDC/unbind a gadget; 17 + write UDC's name found in /sys/class/udc/* 18 + to bind a gadget, empty string "" to unbind. 18 19 19 - max_speed - maximum speed the driver supports. Valid 20 - names are super-speed-plus, super-speed, 21 - high-speed, full-speed, and low-speed. 20 + max_speed maximum speed the driver supports. Valid 21 + names are super-speed-plus, super-speed, 22 + high-speed, full-speed, and low-speed. 22 23 23 - bDeviceClass - USB device class code 24 - bDeviceSubClass - USB device subclass code 25 - bDeviceProtocol - USB device protocol code 26 - bMaxPacketSize0 - maximum endpoint 0 packet size 27 - bcdDevice - bcd device release number 28 - bcdUSB - bcd USB specification version number 29 - idProduct - product ID 30 - idVendor - vendor ID 24 + bDeviceClass USB device class code 25 + bDeviceSubClass USB device subclass code 26 + bDeviceProtocol USB device protocol code 27 + bMaxPacketSize0 maximum endpoint 0 packet size 28 + bcdDevice bcd device release number 29 + bcdUSB bcd USB specification version number 30 + idProduct product ID 31 + idVendor vendor ID 32 + ================ ============================================ 31 33 32 34 What: /config/usb-gadget/gadget/configs 33 35 Date: Jun 2013 ··· 43 41 Description: 44 42 The attributes of a configuration: 45 43 46 - bmAttributes - configuration characteristics 47 - MaxPower - maximum power consumption from the bus 44 + ================ ====================================== 45 + bmAttributes configuration characteristics 46 + MaxPower maximum power consumption from the bus 47 + ================ ====================================== 48 48 49 49 What: /config/usb-gadget/gadget/configs/config/strings 50 50 Date: Jun 2013 ··· 61 57 Description: 62 58 The attributes: 63 59 64 - configuration - configuration description 60 + ================ ========================= 61 + configuration configuration description 62 + ================ ========================= 65 63 66 64 67 65 What: /config/usb-gadget/gadget/functions ··· 82 76 83 77 The attributes: 84 78 85 - compatible_id - 8-byte string for "Compatible ID" 86 - sub_compatible_id - 8-byte string for "Sub Compatible ID" 79 + ================= ===================================== 80 + compatible_id 8-byte string for "Compatible ID" 81 + sub_compatible_id 8-byte string for "Sub Compatible ID" 82 + ================= ===================================== 87 83 88 84 What: /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property> 89 85 Date: May 2014 ··· 97 89 98 90 The attributes: 99 91 100 - type - value 1..7 for interpreting the data 101 - 1: unicode string 102 - 2: unicode string with environment variable 103 - 3: binary 104 - 4: little-endian 32-bit 105 - 5: big-endian 32-bit 106 - 6: unicode string with a symbolic link 107 - 7: multiple unicode strings 108 - data - blob of data to be interpreted depending on 92 + ===== =============================================== 93 + type value 1..7 for interpreting the data 94 + 95 + - 1: unicode string 96 + - 2: unicode string with environment variable 97 + - 3: binary 98 + - 4: little-endian 32-bit 99 + - 5: big-endian 32-bit 100 + - 6: unicode string with a symbolic link 101 + - 7: multiple unicode strings 102 + data blob of data to be interpreted depending on 109 103 type 104 + ===== =============================================== 110 105 111 106 What: /config/usb-gadget/gadget/strings 112 107 Date: Jun 2013 ··· 124 113 Description: 125 114 The attributes: 126 115 127 - serialnumber - gadget's serial number (string) 128 - product - gadget's product description 129 - manufacturer - gadget's manufacturer description 116 + ============ ================================= 117 + serialnumber gadget's serial number (string) 118 + product gadget's product description 119 + manufacturer gadget's manufacturer description 120 + ============ ================================= 130 121 131 122 What: /config/usb-gadget/gadget/os_desc 132 123 Date: May 2014 ··· 136 123 Description: 137 124 This group contains "OS String" extension handling attributes. 138 125 139 - use - flag turning "OS Desctiptors" support on/off 140 - b_vendor_code - one-byte value used for custom per-device and 126 + ============= =============================================== 127 + use flag turning "OS Desctiptors" support on/off 128 + b_vendor_code one-byte value used for custom per-device and 141 129 per-interface requests 142 - qw_sign - an identifier to be reported as "OS String" 130 + qw_sign an identifier to be reported as "OS String" 143 131 proper 132 + ============= ===============================================
+6 -4
Documentation/ABI/testing/configfs-usb-gadget-hid
··· 4 4 Description: 5 5 The attributes: 6 6 7 - protocol - HID protocol to use 8 - report_desc - blob corresponding to HID report descriptors 7 + ============= ============================================ 8 + protocol HID protocol to use 9 + report_desc blob corresponding to HID report descriptors 9 10 except the data passed through /dev/hidg<N> 10 - report_length - HID report length 11 - subclass - HID device subclass to use 11 + report_length HID report length 12 + subclass HID device subclass to use 13 + ============= ============================================
+9 -7
Documentation/ABI/testing/configfs-usb-gadget-rndis
··· 4 4 Description: 5 5 The attributes: 6 6 7 - ifname - network device interface name associated with 7 + ========= ============================================= 8 + ifname network device interface name associated with 8 9 this function instance 9 - qmult - queue length multiplier for high and 10 + qmult queue length multiplier for high and 10 11 super speed 11 - host_addr - MAC address of host's end of this 12 + host_addr MAC address of host's end of this 12 13 Ethernet over USB link 13 - dev_addr - MAC address of device's end of this 14 + dev_addr MAC address of device's end of this 14 15 Ethernet over USB link 15 - class - USB interface class, default is 02 (hex) 16 - subclass - USB interface subclass, default is 06 (hex) 17 - protocol - USB interface protocol, default is 00 (hex) 16 + class USB interface class, default is 02 (hex) 17 + subclass USB interface subclass, default is 06 (hex) 18 + protocol USB interface protocol, default is 00 (hex) 19 + ========= =============================================
+10 -8
Documentation/ABI/testing/configfs-usb-gadget-uac1
··· 4 4 Description: 5 5 The attributes: 6 6 7 - c_chmask - capture channel mask 8 - c_srate - capture sampling rate 9 - c_ssize - capture sample size (bytes) 10 - p_chmask - playback channel mask 11 - p_srate - playback sampling rate 12 - p_ssize - playback sample size (bytes) 13 - req_number - the number of pre-allocated request 14 - for both capture and playback 7 + ========== =================================== 8 + c_chmask capture channel mask 9 + c_srate capture sampling rate 10 + c_ssize capture sample size (bytes) 11 + p_chmask playback channel mask 12 + p_srate playback sampling rate 13 + p_ssize playback sample size (bytes) 14 + req_number the number of pre-allocated request 15 + for both capture and playback 16 + ========== ===================================
+126 -94
Documentation/ABI/testing/configfs-usb-gadget-uvc
··· 3 3 KernelVersion: 4.0 4 4 Description: UVC function directory 5 5 6 - streaming_maxburst - 0..15 (ss only) 7 - streaming_maxpacket - 1..1023 (fs), 1..3072 (hs/ss) 8 - streaming_interval - 1..16 6 + =================== ============================= 7 + streaming_maxburst 0..15 (ss only) 8 + streaming_maxpacket 1..1023 (fs), 1..3072 (hs/ss) 9 + streaming_interval 1..16 10 + =================== ============================= 9 11 10 12 What: /config/usb-gadget/gadget/functions/uvc.name/control 11 13 Date: Dec 2014 ··· 15 13 Description: Control descriptors 16 14 17 15 All attributes read only: 18 - bInterfaceNumber - USB interface number for this 19 - streaming interface 16 + 17 + ================ ============================= 18 + bInterfaceNumber USB interface number for this 19 + streaming interface 20 + ================ ============================= 20 21 21 22 What: /config/usb-gadget/gadget/functions/uvc.name/control/class 22 23 Date: Dec 2014 ··· 52 47 Description: Default output terminal descriptors 53 48 54 49 All attributes read only: 55 - iTerminal - index of string descriptor 56 - bSourceID - id of the terminal to which this terminal 50 + 51 + ============== ============================================= 52 + iTerminal index of string descriptor 53 + bSourceID id of the terminal to which this terminal 57 54 is connected 58 - bAssocTerminal - id of the input terminal to which this output 55 + bAssocTerminal id of the input terminal to which this output 59 56 terminal is associated 60 - wTerminalType - terminal type 61 - bTerminalID - a non-zero id of this terminal 57 + wTerminalType terminal type 58 + bTerminalID a non-zero id of this terminal 59 + ============== ============================================= 62 60 63 61 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera 64 62 Date: Dec 2014 ··· 74 66 Description: Default camera terminal descriptors 75 67 76 68 All attributes read only: 77 - bmControls - bitmap specifying which controls are 78 - supported for the video stream 79 - wOcularFocalLength - the value of Locular 80 - wObjectiveFocalLengthMax- the value of Lmin 81 - wObjectiveFocalLengthMin- the value of Lmax 82 - iTerminal - index of string descriptor 83 - bAssocTerminal - id of the output terminal to which 84 - this terminal is connected 85 - wTerminalType - terminal type 86 - bTerminalID - a non-zero id of this terminal 69 + 70 + ======================== ==================================== 71 + bmControls bitmap specifying which controls are 72 + supported for the video stream 73 + wOcularFocalLength the value of Locular 74 + wObjectiveFocalLengthMax the value of Lmin 75 + wObjectiveFocalLengthMin the value of Lmax 76 + iTerminal index of string descriptor 77 + bAssocTerminal id of the output terminal to which 78 + this terminal is connected 79 + wTerminalType terminal type 80 + bTerminalID a non-zero id of this terminal 81 + ======================== ==================================== 87 82 88 83 What: /config/usb-gadget/gadget/functions/uvc.name/control/processing 89 84 Date: Dec 2014 ··· 99 88 Description: Default processing unit descriptors 100 89 101 90 All attributes read only: 102 - iProcessing - index of string descriptor 103 - bmControls - bitmap specifying which controls are 91 + 92 + =============== ======================================== 93 + iProcessing index of string descriptor 94 + bmControls bitmap specifying which controls are 104 95 supported for the video stream 105 - wMaxMultiplier - maximum digital magnification x100 106 - bSourceID - id of the terminal to which this unit is 96 + wMaxMultiplier maximum digital magnification x100 97 + bSourceID id of the terminal to which this unit is 107 98 connected 108 - bUnitID - a non-zero id of this unit 99 + bUnitID a non-zero id of this unit 100 + =============== ======================================== 109 101 110 102 What: /config/usb-gadget/gadget/functions/uvc.name/control/header 111 103 Date: Dec 2014 ··· 128 114 Description: Streaming descriptors 129 115 130 116 All attributes read only: 131 - bInterfaceNumber - USB interface number for this 132 - streaming interface 117 + 118 + ================ ============================= 119 + bInterfaceNumber USB interface number for this 120 + streaming interface 121 + ================ ============================= 133 122 134 123 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class 135 124 Date: Dec 2014 ··· 165 148 Description: Default color matching descriptors 166 149 167 150 All attributes read only: 168 - bMatrixCoefficients - matrix used to compute luma and 169 - chroma values from the color primaries 170 - bTransferCharacteristics- optoelectronic transfer 171 - characteristic of the source picutre, 172 - also called the gamma function 173 - bColorPrimaries - color primaries and the reference 174 - white 151 + 152 + ======================== ====================================== 153 + bMatrixCoefficients matrix used to compute luma and 154 + chroma values from the color primaries 155 + bTransferCharacteristics optoelectronic transfer 156 + characteristic of the source picutre, 157 + also called the gamma function 158 + bColorPrimaries color primaries and the reference 159 + white 160 + ======================== ====================================== 175 161 176 162 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg 177 163 Date: Dec 2014 ··· 188 168 189 169 All attributes read only, 190 170 except bmaControls and bDefaultFrameIndex: 191 - bFormatIndex - unique id for this format descriptor; 171 + 172 + =================== ===================================== 173 + bFormatIndex unique id for this format descriptor; 192 174 only defined after parent header is 193 175 linked into the streaming class; 194 176 read-only 195 - bmaControls - this format's data for bmaControls in 177 + bmaControls this format's data for bmaControls in 196 178 the streaming header 197 - bmInterfaceFlags - specifies interlace information, 179 + bmInterfaceFlags specifies interlace information, 198 180 read-only 199 - bAspectRatioY - the X dimension of the picture aspect 181 + bAspectRatioY the X dimension of the picture aspect 200 182 ratio, read-only 201 - bAspectRatioX - the Y dimension of the picture aspect 183 + bAspectRatioX the Y dimension of the picture aspect 202 184 ratio, read-only 203 - bmFlags - characteristics of this format, 185 + bmFlags characteristics of this format, 204 186 read-only 205 - bDefaultFrameIndex - optimum frame index for this stream 187 + bDefaultFrameIndex optimum frame index for this stream 188 + =================== ===================================== 206 189 207 190 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name 208 191 Date: Dec 2014 209 192 KernelVersion: 4.0 210 193 Description: Specific MJPEG frame descriptors 211 194 212 - bFrameIndex - unique id for this framedescriptor; 213 - only defined after parent format is 214 - linked into the streaming header; 215 - read-only 216 - dwFrameInterval - indicates how frame interval can be 217 - programmed; a number of values 218 - separated by newline can be specified 219 - dwDefaultFrameInterval - the frame interval the device would 220 - like to use as default 221 - dwMaxVideoFrameBufferSize- the maximum number of bytes the 222 - compressor will produce for a video 223 - frame or still image 224 - dwMaxBitRate - the maximum bit rate at the shortest 225 - frame interval in bps 226 - dwMinBitRate - the minimum bit rate at the longest 227 - frame interval in bps 228 - wHeight - height of decoded bitmap frame in px 229 - wWidth - width of decoded bitmam frame in px 230 - bmCapabilities - still image support, fixed frame-rate 231 - support 195 + ========================= ===================================== 196 + bFrameIndex unique id for this framedescriptor; 197 + only defined after parent format is 198 + linked into the streaming header; 199 + read-only 200 + dwFrameInterval indicates how frame interval can be 201 + programmed; a number of values 202 + separated by newline can be specified 203 + dwDefaultFrameInterval the frame interval the device would 204 + like to use as default 205 + dwMaxVideoFrameBufferSize the maximum number of bytes the 206 + compressor will produce for a video 207 + frame or still image 208 + dwMaxBitRate the maximum bit rate at the shortest 209 + frame interval in bps 210 + dwMinBitRate the minimum bit rate at the longest 211 + frame interval in bps 212 + wHeight height of decoded bitmap frame in px 213 + wWidth width of decoded bitmam frame in px 214 + bmCapabilities still image support, fixed frame-rate 215 + support 216 + ========================= ===================================== 232 217 233 218 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed 234 219 Date: Dec 2014 ··· 245 220 KernelVersion: 4.0 246 221 Description: Specific uncompressed format descriptors 247 222 248 - bFormatIndex - unique id for this format descriptor; 223 + ================== ======================================= 224 + bFormatIndex unique id for this format descriptor; 249 225 only defined after parent header is 250 226 linked into the streaming class; 251 227 read-only 252 - bmaControls - this format's data for bmaControls in 228 + bmaControls this format's data for bmaControls in 253 229 the streaming header 254 - bmInterfaceFlags - specifies interlace information, 230 + bmInterfaceFlags specifies interlace information, 255 231 read-only 256 - bAspectRatioY - the X dimension of the picture aspect 232 + bAspectRatioY the X dimension of the picture aspect 257 233 ratio, read-only 258 - bAspectRatioX - the Y dimension of the picture aspect 234 + bAspectRatioX the Y dimension of the picture aspect 259 235 ratio, read-only 260 - bDefaultFrameIndex - optimum frame index for this stream 261 - bBitsPerPixel - number of bits per pixel used to 236 + bDefaultFrameIndex optimum frame index for this stream 237 + bBitsPerPixel number of bits per pixel used to 262 238 specify color in the decoded video 263 239 frame 264 - guidFormat - globally unique id used to identify 240 + guidFormat globally unique id used to identify 265 241 stream-encoding format 242 + ================== ======================================= 266 243 267 244 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name 268 245 Date: Dec 2014 269 246 KernelVersion: 4.0 270 247 Description: Specific uncompressed frame descriptors 271 248 272 - bFrameIndex - unique id for this framedescriptor; 273 - only defined after parent format is 274 - linked into the streaming header; 275 - read-only 276 - dwFrameInterval - indicates how frame interval can be 277 - programmed; a number of values 278 - separated by newline can be specified 279 - dwDefaultFrameInterval - the frame interval the device would 280 - like to use as default 281 - dwMaxVideoFrameBufferSize- the maximum number of bytes the 282 - compressor will produce for a video 283 - frame or still image 284 - dwMaxBitRate - the maximum bit rate at the shortest 285 - frame interval in bps 286 - dwMinBitRate - the minimum bit rate at the longest 287 - frame interval in bps 288 - wHeight - height of decoded bitmap frame in px 289 - wWidth - width of decoded bitmam frame in px 290 - bmCapabilities - still image support, fixed frame-rate 291 - support 249 + ========================= ===================================== 250 + bFrameIndex unique id for this framedescriptor; 251 + only defined after parent format is 252 + linked into the streaming header; 253 + read-only 254 + dwFrameInterval indicates how frame interval can be 255 + programmed; a number of values 256 + separated by newline can be specified 257 + dwDefaultFrameInterval the frame interval the device would 258 + like to use as default 259 + dwMaxVideoFrameBufferSize the maximum number of bytes the 260 + compressor will produce for a video 261 + frame or still image 262 + dwMaxBitRate the maximum bit rate at the shortest 263 + frame interval in bps 264 + dwMinBitRate the minimum bit rate at the longest 265 + frame interval in bps 266 + wHeight height of decoded bitmap frame in px 267 + wWidth width of decoded bitmam frame in px 268 + bmCapabilities still image support, fixed frame-rate 269 + support 270 + ========================= ===================================== 292 271 293 272 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header 294 273 Date: Dec 2014 ··· 305 276 Description: Specific streaming header descriptors 306 277 307 278 All attributes read only: 308 - bTriggerUsage - how the host software will respond to 279 + 280 + ==================== ===================================== 281 + bTriggerUsage how the host software will respond to 309 282 a hardware trigger interrupt event 310 - bTriggerSupport - flag specifying if hardware 283 + bTriggerSupport flag specifying if hardware 311 284 triggering is supported 312 - bStillCaptureMethod - method of still image caputre 285 + bStillCaptureMethod method of still image caputre 313 286 supported 314 - bTerminalLink - id of the output terminal to which 287 + bTerminalLink id of the output terminal to which 315 288 the video endpoint of this interface 316 289 is connected 317 - bmInfo - capabilities of this video streaming 290 + bmInfo capabilities of this video streaming 318 291 interface 292 + ==================== ===================================== 319 293 320 294 What: /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name 321 295 Date: May 2018
+6 -5
Documentation/ABI/testing/debugfs-ec
··· 6 6 General information like which GPE is assigned to the EC and whether 7 7 the global lock should get used. 8 8 Knowing the EC GPE one can watch the amount of HW events related to 9 - the EC here (XY -> GPE number from /sys/kernel/debug/ec/*/gpe): 9 + the EC here (XY -> GPE number from `/sys/kernel/debug/ec/*/gpe`): 10 10 /sys/firmware/acpi/interrupts/gpeXY 11 11 12 12 The io file is binary and a userspace tool located here: ··· 14 14 should get used to read out the 256 Embedded Controller registers 15 15 or writing to them. 16 16 17 - CAUTION: Do not write to the Embedded Controller if you don't know 18 - what you are doing! Rebooting afterwards also is a good idea. 19 - This can influence the way your machine is cooled and fans may 20 - not get switched on again after you did a wrong write. 17 + CAUTION: 18 + Do not write to the Embedded Controller if you don't know 19 + what you are doing! Rebooting afterwards also is a good idea. 20 + This can influence the way your machine is cooled and fans may 21 + not get switched on again after you did a wrong write.
+5 -6
Documentation/ABI/testing/debugfs-pktcdvd
··· 4 4 Contact: Thomas Maier <balagi@justmail.de> 5 5 Description: 6 6 7 - debugfs interface 8 - ----------------- 9 - 10 7 The pktcdvd module (packet writing driver) creates 11 8 these files in debugfs: 12 9 13 10 /sys/kernel/debug/pktcdvd/pktcdvd[0-7]/ 11 + 12 + ==== ====== ==================================== 14 13 info (0444) Lots of driver statistics and infos. 14 + ==== ====== ==================================== 15 15 16 - Example: 17 - ------- 16 + Example:: 18 17 19 - cat /sys/kernel/debug/pktcdvd/pktcdvd0/info 18 + cat /sys/kernel/debug/pktcdvd/pktcdvd0/info
+17 -10
Documentation/ABI/testing/dev-kmsg
··· 6 6 to the kernel's printk buffer. 7 7 8 8 Injecting messages: 9 + 9 10 Every write() to the opened device node places a log entry in 10 11 the kernel's printk buffer. 11 12 ··· 22 21 the messages can always be reliably determined. 23 22 24 23 Accessing the buffer: 24 + 25 25 Every read() from the opened device node receives one record 26 26 of the kernel's printk buffer. 27 27 ··· 50 48 if needed, without limiting the interface to a single reader. 51 49 52 50 The device supports seek with the following parameters: 51 + 53 52 SEEK_SET, 0 54 53 seek to the first entry in the buffer 55 54 SEEK_END, 0 ··· 90 87 readable context of the message, for reliable processing in 91 88 userspace. 92 89 93 - Example: 94 - 7,160,424069,-;pci_root PNP0A03:00: host bridge window [io 0x0000-0x0cf7] (ignored) 95 - SUBSYSTEM=acpi 96 - DEVICE=+acpi:PNP0A03:00 97 - 6,339,5140900,-;NET: Registered protocol family 10 98 - 30,340,5690716,-;udevd[80]: starting version 181 90 + Example:: 91 + 92 + 7,160,424069,-;pci_root PNP0A03:00: host bridge window [io 0x0000-0x0cf7] (ignored) 93 + SUBSYSTEM=acpi 94 + DEVICE=+acpi:PNP0A03:00 95 + 6,339,5140900,-;NET: Registered protocol family 10 96 + 30,340,5690716,-;udevd[80]: starting version 181 99 97 100 98 The DEVICE= key uniquely identifies devices the following way: 101 - b12:8 - block dev_t 102 - c127:3 - char dev_t 103 - n8 - netdev ifindex 104 - +sound:card0 - subsystem:devname 99 + 100 + ============ ================= 101 + b12:8 block dev_t 102 + c127:3 char dev_t 103 + n8 netdev ifindex 104 + +sound:card0 subsystem:devname 105 + ============ ================= 105 106 106 107 The flags field carries '-' by default. A 'c' indicates a 107 108 fragment of a line. Note, that these hints about continuation
+12 -5
Documentation/ABI/testing/evm
··· 17 17 echoing a value to <securityfs>/evm made up of the 18 18 following bits: 19 19 20 + === ================================================== 20 21 Bit Effect 22 + === ================================================== 21 23 0 Enable HMAC validation and creation 22 24 1 Enable digital signature validation 23 25 2 Permit modification of EVM-protected metadata at 24 26 runtime. Not supported if HMAC validation and 25 27 creation is enabled. 26 28 31 Disable further runtime modification of EVM policy 29 + === ================================================== 27 30 28 - For example: 31 + For example:: 29 32 30 - echo 1 ><securityfs>/evm 33 + echo 1 ><securityfs>/evm 31 34 32 35 will enable HMAC validation and creation 33 36 34 - echo 0x80000003 ><securityfs>/evm 37 + :: 38 + 39 + echo 0x80000003 ><securityfs>/evm 35 40 36 41 will enable HMAC and digital signature validation and 37 42 HMAC creation and disable all further modification of policy. 38 43 39 - echo 0x80000006 ><securityfs>/evm 44 + :: 45 + 46 + echo 0x80000006 ><securityfs>/evm 40 47 41 48 will enable digital signature validation, permit 42 49 modification of EVM-protected metadata and ··· 72 65 Shows the set of extended attributes used to calculate or 73 66 validate the EVM signature, and allows additional attributes 74 67 to be added at runtime. Any signatures generated after 75 - additional attributes are added (and on files posessing those 68 + additional attributes are added (and on files possessing those 76 69 additional attributes) will only be valid if the same 77 70 additional attributes are configured on system boot. Writing 78 71 a single period (.) will lock the xattr list from any further
+18 -12
Documentation/ABI/testing/ima_policy
··· 15 15 IMA appraisal, if configured, uses these file measurements 16 16 for local measurement appraisal. 17 17 18 - rule format: action [condition ...] 18 + :: 19 19 20 - action: measure | dont_measure | appraise | dont_appraise | 21 - audit | hash | dont_hash 22 - condition:= base | lsm [option] 20 + rule format: action [condition ...] 21 + 22 + action: measure | dont_measure | appraise | dont_appraise | 23 + audit | hash | dont_hash 24 + condition:= base | lsm [option] 23 25 base: [[func=] [mask=] [fsmagic=] [fsuuid=] [uid=] 24 26 [euid=] [fowner=] [fsname=]] 25 27 lsm: [[subj_user=] [subj_role=] [subj_type=] 26 28 [obj_user=] [obj_role=] [obj_type=]] 27 29 option: [[appraise_type=]] [template=] [permit_directio] 28 30 [appraise_flag=] [keyrings=] 29 - base: func:= [BPRM_CHECK][MMAP_CHECK][CREDS_CHECK][FILE_CHECK][MODULE_CHECK] 30 - [FIRMWARE_CHECK] 31 + base: 32 + func:= [BPRM_CHECK][MMAP_CHECK][CREDS_CHECK][FILE_CHECK]MODULE_CHECK] 33 + [FIRMWARE_CHECK] 31 34 [KEXEC_KERNEL_CHECK] [KEXEC_INITRAMFS_CHECK] 32 35 [KEXEC_CMDLINE] [KEY_CHECK] 33 36 mask:= [[^]MAY_READ] [[^]MAY_WRITE] [[^]MAY_APPEND] ··· 40 37 uid:= decimal value 41 38 euid:= decimal value 42 39 fowner:= decimal value 43 - lsm: are LSM specific 44 - option: appraise_type:= [imasig] [imasig|modsig] 40 + lsm: are LSM specific 41 + option: 42 + appraise_type:= [imasig] [imasig|modsig] 45 43 appraise_flag:= [check_blacklist] 46 44 Currently, blacklist check is only for files signed with appended 47 45 signature. ··· 53 49 (eg, ima-ng). Only valid when action is "measure". 54 50 pcr:= decimal value 55 51 56 - default policy: 52 + default policy: 57 53 # PROC_SUPER_MAGIC 58 54 dont_measure fsmagic=0x9fa0 59 55 dont_appraise fsmagic=0x9fa0 ··· 101 97 102 98 Examples of LSM specific definitions: 103 99 104 - SELinux: 100 + SELinux:: 101 + 105 102 dont_measure obj_type=var_log_t 106 103 dont_appraise obj_type=var_log_t 107 104 dont_measure obj_type=auditd_log_t ··· 110 105 measure subj_user=system_u func=FILE_CHECK mask=MAY_READ 111 106 measure subj_role=system_r func=FILE_CHECK mask=MAY_READ 112 107 113 - Smack: 108 + Smack:: 109 + 114 110 measure subj_user=_ func=FILE_CHECK mask=MAY_READ 115 111 116 - Example of measure rules using alternate PCRs: 112 + Example of measure rules using alternate PCRs:: 117 113 118 114 measure func=KEXEC_KERNEL_CHECK pcr=4 119 115 measure func=KEXEC_INITRAMFS_CHECK pcr=5
+22 -18
Documentation/ABI/testing/procfs-diskstats
··· 6 6 of block devices. Each line contains the following 14 7 7 fields: 8 8 9 - 1 - major number 10 - 2 - minor mumber 11 - 3 - device name 12 - 4 - reads completed successfully 13 - 5 - reads merged 14 - 6 - sectors read 15 - 7 - time spent reading (ms) 16 - 8 - writes completed 17 - 9 - writes merged 18 - 10 - sectors written 19 - 11 - time spent writing (ms) 20 - 12 - I/Os currently in progress 21 - 13 - time spent doing I/Os (ms) 22 - 14 - weighted time spent doing I/Os (ms) 9 + == =================================== 10 + 1 major number 11 + 2 minor mumber 12 + 3 device name 13 + 4 reads completed successfully 14 + 5 reads merged 15 + 6 sectors read 16 + 7 time spent reading (ms) 17 + 8 writes completed 18 + 9 writes merged 19 + 10 sectors written 20 + 11 time spent writing (ms) 21 + 12 I/Os currently in progress 22 + 13 time spent doing I/Os (ms) 23 + 14 weighted time spent doing I/Os (ms) 24 + == =================================== 23 25 24 26 Kernel 4.18+ appends four more fields for discard 25 27 tracking putting the total at 18: 26 28 27 - 15 - discards completed successfully 28 - 16 - discards merged 29 - 17 - sectors discarded 30 - 18 - time spent discarding 29 + == =================================== 30 + 15 discards completed successfully 31 + 16 discards merged 32 + 17 sectors discarded 33 + 18 time spent discarding 34 + == =================================== 31 35 32 36 Kernel 5.5+ appends two more fields for flush requests: 33 37
+21 -17
Documentation/ABI/testing/sysfs-block
··· 4 4 Description: 5 5 The /sys/block/<disk>/stat files displays the I/O 6 6 statistics of disk <disk>. They contain 11 fields: 7 - 1 - reads completed successfully 8 - 2 - reads merged 9 - 3 - sectors read 10 - 4 - time spent reading (ms) 11 - 5 - writes completed 12 - 6 - writes merged 13 - 7 - sectors written 14 - 8 - time spent writing (ms) 15 - 9 - I/Os currently in progress 16 - 10 - time spent doing I/Os (ms) 17 - 11 - weighted time spent doing I/Os (ms) 18 - 12 - discards completed 19 - 13 - discards merged 20 - 14 - sectors discarded 21 - 15 - time spent discarding (ms) 22 - 16 - flush requests completed 23 - 17 - time spent flushing (ms) 7 + 8 + == ============================================== 9 + 1 reads completed successfully 10 + 2 reads merged 11 + 3 sectors read 12 + 4 time spent reading (ms) 13 + 5 writes completed 14 + 6 writes merged 15 + 7 sectors written 16 + 8 time spent writing (ms) 17 + 9 I/Os currently in progress 18 + 10 time spent doing I/Os (ms) 19 + 11 weighted time spent doing I/Os (ms) 20 + 12 discards completed 21 + 13 discards merged 22 + 14 sectors discarded 23 + 15 time spent discarding (ms) 24 + 16 flush requests completed 25 + 17 time spent flushing (ms) 26 + == ============================================== 27 + 24 28 For more details refer Documentation/admin-guide/iostats.rst 25 29 26 30
+2
Documentation/ABI/testing/sysfs-block-device
··· 8 8 9 9 It has the following valid values: 10 10 11 + == ======================================================== 11 12 0 OFF - the LED is not activated on activity 12 13 1 BLINK_ON - the LED blinks on every 10ms when activity is 13 14 detected. 14 15 2 BLINK_OFF - the LED is on when idle, and blinks off 15 16 every 10ms when activity is detected. 17 + == ======================================================== 16 18 17 19 Note that the user must turn sw_activity OFF it they wish to 18 20 control the activity LED via the em_message file.
+10 -8
Documentation/ABI/testing/sysfs-bus-acpi
··· 67 67 The return value is a decimal integer representing the device's 68 68 status bitmap: 69 69 70 - Bit [0] – Set if the device is present. 71 - Bit [1] – Set if the device is enabled and decoding its 72 - resources. 73 - Bit [2] – Set if the device should be shown in the UI. 74 - Bit [3] – Set if the device is functioning properly (cleared if 75 - device failed its diagnostics). 76 - Bit [4] – Set if the battery is present. 77 - Bits [31:5] – Reserved (must be cleared) 70 + =========== ================================================== 71 + Bit [0] Set if the device is present. 72 + Bit [1] Set if the device is enabled and decoding its 73 + resources. 74 + Bit [2] Set if the device should be shown in the UI. 75 + Bit [3] Set if the device is functioning properly (cleared 76 + if device failed its diagnostics). 77 + Bit [4] Set if the battery is present. 78 + Bits [31:5] Reserved (must be cleared) 79 + =========== ================================================== 78 80 79 81 If bit [0] is clear, then bit 1 must also be clear (a device 80 82 that is not present cannot be enabled).
+2 -1
Documentation/ABI/testing/sysfs-bus-event_source-devices-format
··· 10 10 name/value pairs. 11 11 12 12 Userspace must be prepared for the possibility that attributes 13 - define overlapping bit ranges. For example: 13 + define overlapping bit ranges. For example:: 14 + 14 15 attr1 = 'config:0-23' 15 16 attr2 = 'config:0-7' 16 17 attr3 = 'config:12-35'
+15 -12
Documentation/ABI/testing/sysfs-bus-i2c-devices-pca954x
··· 6 6 Value that exists only for mux devices that can be 7 7 written to control the behaviour of the multiplexer on 8 8 idle. Possible values: 9 - -2 - disconnect on idle, i.e. deselect the last used 10 - channel, which is useful when there is a device 11 - with an address that conflicts with another 12 - device on another mux on the same parent bus. 13 - -1 - leave the mux as-is, which is the most optimal 14 - setting in terms of I2C operations and is the 15 - default mode. 16 - 0..<nchans> - set the mux to a predetermined channel, 17 - which is useful if there is one channel that is 18 - used almost always, and you want to reduce the 19 - latency for normal operations after rare 20 - transactions on other channels 9 + 10 + =========== =============================================== 11 + -2 disconnect on idle, i.e. deselect the last used 12 + channel, which is useful when there is a device 13 + with an address that conflicts with another 14 + device on another mux on the same parent bus. 15 + -1 leave the mux as-is, which is the most optimal 16 + setting in terms of I2C operations and is the 17 + default mode. 18 + 0..<nchans> set the mux to a predetermined channel, 19 + which is useful if there is one channel that is 20 + used almost always, and you want to reduce the 21 + latency for normal operations after rare 22 + transactions on other channels 23 + =========== ===============================================
+11
Documentation/ABI/testing/sysfs-bus-iio
··· 65 65 Description: 66 66 When the internal sampling clock can only take a specific set of 67 67 frequencies, we can specify the available values with: 68 + 68 69 - a small discrete set of values like "0 2 4 6 8" 69 70 - a range with minimum, step and maximum frequencies like 70 71 "[min step max]" ··· 1628 1627 Mounting matrix for IIO sensors. This is a rotation matrix which 1629 1628 informs userspace about sensor chip's placement relative to the 1630 1629 main hardware it is mounted on. 1630 + 1631 1631 Main hardware placement is defined according to the local 1632 1632 reference frame related to the physical quantity the sensor 1633 1633 measures. 1634 + 1634 1635 Given that the rotation matrix is defined in a board specific 1635 1636 way (platform data and / or device-tree), the main hardware 1636 1637 reference frame definition is left to the implementor's choice 1637 1638 (see below for a magnetometer example). 1639 + 1638 1640 Applications should apply this rotation matrix to samples so 1639 1641 that when main hardware reference frame is aligned onto local 1640 1642 reference frame, then sensor chip reference frame is also 1641 1643 perfectly aligned with it. 1644 + 1642 1645 Matrix is a 3x3 unitary matrix and typically looks like 1643 1646 [0, 1, 0; 1, 0, 0; 0, 0, -1]. Identity matrix 1644 1647 [1, 0, 0; 0, 1, 0; 0, 0, 1] means sensor chip and main hardware ··· 1651 1646 For example, a mounting matrix for a magnetometer sensor informs 1652 1647 userspace about sensor chip's ORIENTATION relative to the main 1653 1648 hardware. 1649 + 1654 1650 More specifically, main hardware orientation is defined with 1655 1651 respect to the LOCAL EARTH GEOMAGNETIC REFERENCE FRAME where : 1652 + 1656 1653 * Y is in the ground plane and positive towards magnetic North ; 1657 1654 * X is in the ground plane, perpendicular to the North axis and 1658 1655 positive towards the East ; ··· 1663 1656 An implementor might consider that for a hand-held device, a 1664 1657 'natural' orientation would be 'front facing camera at the top'. 1665 1658 The main hardware reference frame could then be described as : 1659 + 1666 1660 * Y is in the plane of the screen and is positive towards the 1667 1661 top of the screen ; 1668 1662 * X is in the plane of the screen, perpendicular to Y axis, and 1669 1663 positive towards the right hand side of the screen ; 1670 1664 * Z is perpendicular to the screen plane and positive out of the 1671 1665 screen. 1666 + 1672 1667 Another example for a quadrotor UAV might be : 1668 + 1673 1669 * Y is in the plane of the propellers and positive towards the 1674 1670 front-view camera; 1675 1671 * X is in the plane of the propellers, perpendicular to Y axis, ··· 1714 1704 This interface is deprecated; please use the Counter subsystem. 1715 1705 1716 1706 A list of possible counting directions which are: 1707 + 1717 1708 - "up" : counter device is increasing. 1718 1709 - "down": counter device is decreasing. 1719 1710
+4 -1
Documentation/ABI/testing/sysfs-bus-iio-adc-envelope-detector
··· 5 5 Description: 6 6 The DAC is used to find the peak level of an alternating 7 7 voltage input signal by a binary search using the output 8 - of a comparator wired to an interrupt pin. Like so: 8 + of a comparator wired to an interrupt pin. Like so:: 9 + 9 10 _ 10 11 | \ 11 12 input +------>-------|+ \ ··· 20 19 | irq|------<-------' 21 20 | | 22 21 '-------' 22 + 23 23 The boolean invert attribute (0/1) should be set when the 24 24 input signal is centered around the maximum value of the 25 25 dac instead of zero. The envelope detector will search 26 26 from below in this case and will also invert the result. 27 + 27 28 The edge/level of the interrupt is also switched to its 28 29 opposite value. 29 30
+1 -1
Documentation/ABI/testing/sysfs-bus-iio-cros-ec
··· 4 4 Contact: linux-iio@vger.kernel.org 5 5 Description: 6 6 Writing '1' will perform a FOC (Fast Online Calibration). The 7 - corresponding calibration offsets can be read from *_calibbias 7 + corresponding calibration offsets can be read from `*_calibbias` 8 8 entries. 9 9 10 10 What: /sys/bus/iio/devices/iio:deviceX/location
+7 -1
Documentation/ABI/testing/sysfs-bus-iio-dfsdm-adc-stm32
··· 3 3 Contact: arnaud.pouliquen@st.com 4 4 Description: 5 5 For audio purpose only. 6 + 6 7 Used by audio driver to set/get the spi input frequency. 8 + 7 9 This is mandatory if DFSDM is slave on SPI bus, to 8 10 provide information on the SPI clock frequency during runtime 9 11 Notice that the SPI frequency should be a multiple of sample 10 12 frequency to ensure the precision. 11 - if DFSDM input is SPI master 13 + 14 + if DFSDM input is SPI master: 15 + 12 16 Reading SPI clkout frequency, 13 17 error on writing 18 + 14 19 If DFSDM input is SPI Slave: 20 + 15 21 Reading returns value previously set. 16 22 Writing value before starting conversions.
+17 -12
Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32
··· 17 17 Contact: fabrice.gasnier@st.com 18 18 Description: 19 19 Configure the device counter quadrature modes: 20 + 20 21 - non-quadrature: 21 22 Encoder IN1 input servers as the count input (up 22 23 direction). 24 + 23 25 - quadrature: 24 26 Encoder IN1 and IN2 inputs are mixed to get direction 25 27 and count. ··· 37 35 Contact: fabrice.gasnier@st.com 38 36 Description: 39 37 Configure the device encoder/counter active edge: 38 + 40 39 - rising-edge 41 40 - falling-edge 42 41 - both-edges 43 42 44 43 In non-quadrature mode, device counts up on active edge. 44 + 45 45 In quadrature mode, encoder counting scenarios are as follows: 46 - ---------------------------------------------------------------- 46 + 47 + +---------+----------+--------------------+--------------------+ 47 48 | Active | Level on | IN1 signal | IN2 signal | 48 - | edge | opposite |------------------------------------------ 49 + | edge | opposite +----------+---------+----------+---------+ 49 50 | | signal | Rising | Falling | Rising | Falling | 50 - ---------------------------------------------------------------- 51 - | Rising | High -> | Down | - | Up | - | 52 - | edge | Low -> | Up | - | Down | - | 53 - ---------------------------------------------------------------- 54 - | Falling | High -> | - | Up | - | Down | 55 - | edge | Low -> | - | Down | - | Up | 56 - ---------------------------------------------------------------- 57 - | Both | High -> | Down | Up | Up | Down | 58 - | edges | Low -> | Up | Down | Down | Up | 59 - ---------------------------------------------------------------- 51 + +---------+----------+----------+---------+----------+---------+ 52 + | Rising | High -> | Down | - | Up | - | 53 + | edge | Low -> | Up | - | Down | - | 54 + +---------+----------+----------+---------+----------+---------+ 55 + | Falling | High -> | - | Up | - | Down | 56 + | edge | Low -> | - | Down | - | Up | 57 + +---------+----------+----------+---------+----------+---------+ 58 + | Both | High -> | Down | Up | Up | Down | 59 + | edges | Low -> | Up | Down | Down | Up | 60 + +---------+----------+----------+---------+----------+---------+
+12 -7
Documentation/ABI/testing/sysfs-bus-iio-magnetometer-hmc5843
··· 5 5 Description: 6 6 Current configuration and available configurations 7 7 for the bias current. 8 - normal - Normal measurement configurations (default) 9 - positivebias - Positive bias configuration 10 - negativebias - Negative bias configuration 11 - disabled - Only available on HMC5983. Disables magnetic 8 + 9 + ============ ============================================ 10 + normal Normal measurement configurations (default) 11 + positivebias Positive bias configuration 12 + negativebias Negative bias configuration 13 + disabled Only available on HMC5983. Disables magnetic 12 14 sensor and enables temperature sensor. 13 - Note: The effect of this configuration may vary 14 - according to the device. For exact documentation 15 - check the device's datasheet. 15 + ============ ============================================ 16 + 17 + Note: 18 + The effect of this configuration may vary 19 + according to the device. For exact documentation 20 + check the device's datasheet.
+13 -6
Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856
··· 5 5 Open-circuit fault. The detection of open-circuit faults, 6 6 such as those caused by broken thermocouple wires. 7 7 Reading returns either '1' or '0'. 8 - '1' = An open circuit such as broken thermocouple wires 9 - has been detected. 10 - '0' = No open circuit or broken thermocouple wires are detected 8 + 9 + === ======================================================= 10 + '1' An open circuit such as broken thermocouple wires 11 + has been detected. 12 + '0' No open circuit or broken thermocouple wires are detected 13 + === ======================================================= 11 14 12 15 What: /sys/bus/iio/devices/iio:deviceX/fault_ovuv 13 16 KernelVersion: 5.1 ··· 21 18 cables by integrated MOSFETs at the T+ and T- inputs, and the 22 19 BIAS output. These MOSFETs turn off when the input voltage is 23 20 negative or greater than VDD. 21 + 24 22 Reading returns either '1' or '0'. 25 - '1' = The input voltage is negative or greater than VDD. 26 - '0' = The input voltage is positive and less than VDD (normal 27 - state). 23 + 24 + === ======================================================= 25 + '1' The input voltage is negative or greater than VDD. 26 + '0' The input voltage is positive and less than VDD (normal 27 + state). 28 + === =======================================================
+90 -47
Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
··· 3 3 Contact: benjamin.gaignard@st.com 4 4 Description: 5 5 Reading returns the list possible master modes which are: 6 - - "reset" : The UG bit from the TIMx_EGR register is 6 + 7 + 8 + - "reset" 9 + The UG bit from the TIMx_EGR register is 7 10 used as trigger output (TRGO). 8 - - "enable" : The Counter Enable signal CNT_EN is used 11 + - "enable" 12 + The Counter Enable signal CNT_EN is used 9 13 as trigger output. 10 - - "update" : The update event is selected as trigger output. 14 + - "update" 15 + The update event is selected as trigger output. 11 16 For instance a master timer can then be used 12 17 as a prescaler for a slave timer. 13 - - "compare_pulse" : The trigger output send a positive pulse 14 - when the CC1IF flag is to be set. 15 - - "OC1REF" : OC1REF signal is used as trigger output. 16 - - "OC2REF" : OC2REF signal is used as trigger output. 17 - - "OC3REF" : OC3REF signal is used as trigger output. 18 - - "OC4REF" : OC4REF signal is used as trigger output. 18 + - "compare_pulse" 19 + The trigger output send a positive pulse 20 + when the CC1IF flag is to be set. 21 + - "OC1REF" 22 + OC1REF signal is used as trigger output. 23 + - "OC2REF" 24 + OC2REF signal is used as trigger output. 25 + - "OC3REF" 26 + OC3REF signal is used as trigger output. 27 + - "OC4REF" 28 + OC4REF signal is used as trigger output. 29 + 19 30 Additional modes (on TRGO2 only): 20 - - "OC5REF" : OC5REF signal is used as trigger output. 21 - - "OC6REF" : OC6REF signal is used as trigger output. 31 + 32 + - "OC5REF" 33 + OC5REF signal is used as trigger output. 34 + - "OC6REF" 35 + OC6REF signal is used as trigger output. 22 36 - "compare_pulse_OC4REF": 23 - OC4REF rising or falling edges generate pulses. 37 + OC4REF rising or falling edges generate pulses. 24 38 - "compare_pulse_OC6REF": 25 - OC6REF rising or falling edges generate pulses. 39 + OC6REF rising or falling edges generate pulses. 26 40 - "compare_pulse_OC4REF_r_or_OC6REF_r": 27 - OC4REF or OC6REF rising edges generate pulses. 41 + OC4REF or OC6REF rising edges generate pulses. 28 42 - "compare_pulse_OC4REF_r_or_OC6REF_f": 29 - OC4REF rising or OC6REF falling edges generate pulses. 43 + OC4REF rising or OC6REF falling edges generate 44 + pulses. 30 45 - "compare_pulse_OC5REF_r_or_OC6REF_r": 31 - OC5REF or OC6REF rising edges generate pulses. 46 + OC5REF or OC6REF rising edges generate pulses. 32 47 - "compare_pulse_OC5REF_r_or_OC6REF_f": 33 - OC5REF rising or OC6REF falling edges generate pulses. 48 + OC5REF rising or OC6REF falling edges generate 49 + pulses. 34 50 35 - +-----------+ +-------------+ +---------+ 36 - | Prescaler +-> | Counter | +-> | Master | TRGO(2) 37 - +-----------+ +--+--------+-+ |-> | Control +--> 38 - | | || +---------+ 39 - +--v--------+-+ OCxREF || +---------+ 40 - | Chx compare +----------> | Output | ChX 41 - +-----------+-+ | | Control +--> 42 - . | | +---------+ 43 - . | | . 44 - +-----------v-+ OC6REF | . 45 - | Ch6 compare +---------+> 46 - +-------------+ 51 + :: 47 52 48 - Example with: "compare_pulse_OC4REF_r_or_OC6REF_r": 53 + +-----------+ +-------------+ +---------+ 54 + | Prescaler +-> | Counter | +-> | Master | TRGO(2) 55 + +-----------+ +--+--------+-+ |-> | Control +--> 56 + | | || +---------+ 57 + +--v--------+-+ OCxREF || +---------+ 58 + | Chx compare +----------> | Output | ChX 59 + +-----------+-+ | | Control +--> 60 + . | | +---------+ 61 + . | | . 62 + +-----------v-+ OC6REF | . 63 + | Ch6 compare +---------+> 64 + +-------------+ 49 65 50 - X 51 - X X 52 - X . . X 53 - X . . X 54 - X . . X 55 - count X . . . . X 56 - . . . . 57 - . . . . 58 - +---------------+ 59 - OC4REF | . . | 60 - +-+ . . +-+ 61 - . +---+ . 62 - OC6REF . | | . 63 - +-------+ +-------+ 64 - +-+ +-+ 65 - TRGO2 | | | | 66 - +-+ +---+ +---------+ 66 + Example with: "compare_pulse_OC4REF_r_or_OC6REF_r":: 67 + 68 + X 69 + X X 70 + X . . X 71 + X . . X 72 + X . . X 73 + count X . . . . X 74 + . . . . 75 + . . . . 76 + +---------------+ 77 + OC4REF | . . | 78 + +-+ . . +-+ 79 + . +---+ . 80 + OC6REF . | | . 81 + +-------+ +-------+ 82 + +-+ +-+ 83 + TRGO2 | | | | 84 + +-+ +---+ +---------+ 67 85 68 86 What: /sys/bus/iio/devices/triggerX/master_mode 69 87 KernelVersion: 4.11 ··· 109 91 When counting down the counter start from preset value 110 92 and fire event when reach 0. 111 93 94 + What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available 95 + KernelVersion: 4.12 96 + Contact: benjamin.gaignard@st.com 97 + Description: 98 + Reading returns the list possible quadrature modes. 99 + 100 + What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode 101 + KernelVersion: 4.12 102 + Contact: benjamin.gaignard@st.com 103 + Description: 104 + Configure the device counter quadrature modes: 105 + 106 + channel_A: 107 + Encoder A input servers as the count input and B as 108 + the UP/DOWN direction control input. 109 + 110 + channel_B: 111 + Encoder B input serves as the count input and A as 112 + the UP/DOWN direction control input. 113 + 114 + quadrature: 115 + Encoder A and B inputs are mixed to get direction 116 + and count with a scale of 0.25. 117 + 112 118 What: /sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available 113 119 KernelVersion: 4.12 114 120 Contact: benjamin.gaignard@st.com ··· 146 104 Configure the device counter enable modes, in all case 147 105 counting direction is set by in_count0_count_direction 148 106 attribute and the counter is clocked by the internal clock. 107 + 149 108 always: 150 109 Counter is always ON. 151 110
+4
Documentation/ABI/testing/sysfs-bus-intel_th-devices-msc
··· 9 9 KernelVersion: 4.3 10 10 Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com> 11 11 Description: (RW) Configure MSC operating mode: 12 + 12 13 - "single", for contiguous buffer mode (high-order alloc); 13 14 - "multi", for multiblock mode; 14 15 - "ExI", for DCI handler mode; 15 16 - "debug", for debug mode; 16 17 - any of the currently loaded buffer sinks. 18 + 17 19 If operating mode changes, existing buffer is deallocated, 18 20 provided there are no active users and tracing is not enabled, 19 21 otherwise the write will fail. ··· 25 23 KernelVersion: 4.3 26 24 Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com> 27 25 Description: (RW) Configure MSC buffer size for "single" or "multi" modes. 26 + 28 27 In single mode, this is a single number of pages, has to be 29 28 power of 2. In multiblock mode, this is a comma-separated list 30 29 of numbers of pages for each window to be allocated. Number of 31 30 windows is not limited. 31 + 32 32 Writing to this file deallocates existing buffer (provided 33 33 there are no active users and tracing is not enabled) and then 34 34 allocates a new one.
+1 -1
Documentation/ABI/testing/sysfs-bus-nfit
··· 1 - For all of the nmem device attributes under nfit/*, see the 'NVDIMM Firmware 1 + For all of the nmem device attributes under ``nfit/*``, see the 'NVDIMM Firmware 2 2 Interface Table (NFIT)' section in the ACPI specification 3 3 (http://www.uefi.org/specifications) for more details. 4 4
+58 -61
Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats
··· 1 - ========================== 2 1 PCIe Device AER statistics 3 - ========================== 2 + -------------------------- 3 + 4 4 These attributes show up under all the devices that are AER capable. These 5 5 statistical counters indicate the errors "as seen/reported by the device". 6 6 Note that this may mean that if an endpoint is causing problems, the AER ··· 17 17 PCI device using ERR_COR. Note that since multiple errors may 18 18 be reported using a single ERR_COR message, thus 19 19 TOTAL_ERR_COR at the end of the file may not match the actual 20 - total of all the errors in the file. Sample output: 21 - ------------------------------------------------------------------------- 22 - localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable 23 - Receiver Error 2 24 - Bad TLP 0 25 - Bad DLLP 0 26 - RELAY_NUM Rollover 0 27 - Replay Timer Timeout 0 28 - Advisory Non-Fatal 0 29 - Corrected Internal Error 0 30 - Header Log Overflow 0 31 - TOTAL_ERR_COR 2 32 - ------------------------------------------------------------------------- 20 + total of all the errors in the file. Sample output:: 21 + 22 + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable 23 + Receiver Error 2 24 + Bad TLP 0 25 + Bad DLLP 0 26 + RELAY_NUM Rollover 0 27 + Replay Timer Timeout 0 28 + Advisory Non-Fatal 0 29 + Corrected Internal Error 0 30 + Header Log Overflow 0 31 + TOTAL_ERR_COR 2 33 32 34 33 What: /sys/bus/pci/devices/<dev>/aer_dev_fatal 35 34 Date: July 2018 ··· 38 39 PCI device using ERR_FATAL. Note that since multiple errors may 39 40 be reported using a single ERR_FATAL message, thus 40 41 TOTAL_ERR_FATAL at the end of the file may not match the actual 41 - total of all the errors in the file. Sample output: 42 - ------------------------------------------------------------------------- 43 - localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal 44 - Undefined 0 45 - Data Link Protocol 0 46 - Surprise Down Error 0 47 - Poisoned TLP 0 48 - Flow Control Protocol 0 49 - Completion Timeout 0 50 - Completer Abort 0 51 - Unexpected Completion 0 52 - Receiver Overflow 0 53 - Malformed TLP 0 54 - ECRC 0 55 - Unsupported Request 0 56 - ACS Violation 0 57 - Uncorrectable Internal Error 0 58 - MC Blocked TLP 0 59 - AtomicOp Egress Blocked 0 60 - TLP Prefix Blocked Error 0 61 - TOTAL_ERR_FATAL 0 62 - ------------------------------------------------------------------------- 42 + total of all the errors in the file. Sample output:: 43 + 44 + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal 45 + Undefined 0 46 + Data Link Protocol 0 47 + Surprise Down Error 0 48 + Poisoned TLP 0 49 + Flow Control Protocol 0 50 + Completion Timeout 0 51 + Completer Abort 0 52 + Unexpected Completion 0 53 + Receiver Overflow 0 54 + Malformed TLP 0 55 + ECRC 0 56 + Unsupported Request 0 57 + ACS Violation 0 58 + Uncorrectable Internal Error 0 59 + MC Blocked TLP 0 60 + AtomicOp Egress Blocked 0 61 + TLP Prefix Blocked Error 0 62 + TOTAL_ERR_FATAL 0 63 63 64 64 What: /sys/bus/pci/devices/<dev>/aer_dev_nonfatal 65 65 Date: July 2018 ··· 68 70 PCI device using ERR_NONFATAL. Note that since multiple errors 69 71 may be reported using a single ERR_FATAL message, thus 70 72 TOTAL_ERR_NONFATAL at the end of the file may not match the 71 - actual total of all the errors in the file. Sample output: 72 - ------------------------------------------------------------------------- 73 - localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal 74 - Undefined 0 75 - Data Link Protocol 0 76 - Surprise Down Error 0 77 - Poisoned TLP 0 78 - Flow Control Protocol 0 79 - Completion Timeout 0 80 - Completer Abort 0 81 - Unexpected Completion 0 82 - Receiver Overflow 0 83 - Malformed TLP 0 84 - ECRC 0 85 - Unsupported Request 0 86 - ACS Violation 0 87 - Uncorrectable Internal Error 0 88 - MC Blocked TLP 0 89 - AtomicOp Egress Blocked 0 90 - TLP Prefix Blocked Error 0 91 - TOTAL_ERR_NONFATAL 0 92 - ------------------------------------------------------------------------- 73 + actual total of all the errors in the file. Sample output:: 93 74 94 - ============================ 75 + localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal 76 + Undefined 0 77 + Data Link Protocol 0 78 + Surprise Down Error 0 79 + Poisoned TLP 0 80 + Flow Control Protocol 0 81 + Completion Timeout 0 82 + Completer Abort 0 83 + Unexpected Completion 0 84 + Receiver Overflow 0 85 + Malformed TLP 0 86 + ECRC 0 87 + Unsupported Request 0 88 + ACS Violation 0 89 + Uncorrectable Internal Error 0 90 + MC Blocked TLP 0 91 + AtomicOp Egress Blocked 0 92 + TLP Prefix Blocked Error 0 93 + TOTAL_ERR_NONFATAL 0 94 + 95 95 PCIe Rootport AER statistics 96 - ============================ 96 + ---------------------------- 97 + 97 98 These attributes show up under only the rootports (or root complex event 98 99 collectors) that are AER capable. These indicate the number of error messages as 99 100 "reported to" the rootport. Please note that the rootports also transmit
+13 -10
Documentation/ABI/testing/sysfs-bus-rapidio
··· 4 4 an individual subdirectory with the following name format of 5 5 device_name "nn:d:iiii", where: 6 6 7 - nn - two-digit hexadecimal ID of RapidIO network where the 7 + ==== ======================================================== 8 + nn two-digit hexadecimal ID of RapidIO network where the 8 9 device resides 9 - d - device type: 'e' - for endpoint or 's' - for switch 10 - iiii - four-digit device destID for endpoints, or switchID for 10 + d device type: 'e' - for endpoint or 's' - for switch 11 + iiii four-digit device destID for endpoints, or switchID for 11 12 switches 13 + ==== ======================================================== 12 14 13 15 For example, below is a list of device directories that 14 16 represents a typical RapidIO network with one switch, one host, 15 17 and two agent endpoints, as it is seen by the enumerating host 16 - (with destID = 1): 18 + (with destID = 1):: 17 19 18 - /sys/bus/rapidio/devices/00:e:0000 19 - /sys/bus/rapidio/devices/00:e:0002 20 - /sys/bus/rapidio/devices/00:s:0001 20 + /sys/bus/rapidio/devices/00:e:0000 21 + /sys/bus/rapidio/devices/00:e:0002 22 + /sys/bus/rapidio/devices/00:s:0001 21 23 22 - NOTE: An enumerating or discovering endpoint does not create a 23 - sysfs entry for itself, this is why an endpoint with destID=1 is 24 - not shown in the list. 24 + NOTE: 25 + An enumerating or discovering endpoint does not create a 26 + sysfs entry for itself, this is why an endpoint with destID=1 27 + is not shown in the list. 25 28 26 29 Attributes Common for All RapidIO Devices 27 30 -----------------------------------------
+24 -16
Documentation/ABI/testing/sysfs-bus-thunderbolt
··· 37 37 Description: This attribute holds current Thunderbolt security level 38 38 set by the system BIOS. Possible values are: 39 39 40 - none: All devices are automatically authorized 41 - user: Devices are only authorized based on writing 42 - appropriate value to the authorized attribute 43 - secure: Require devices that support secure connect at 44 - minimum. User needs to authorize each device. 45 - dponly: Automatically tunnel Display port (and USB). No 46 - PCIe tunnels are created. 47 - usbonly: Automatically tunnel USB controller of the 40 + ======= ================================================== 41 + none All devices are automatically authorized 42 + user Devices are only authorized based on writing 43 + appropriate value to the authorized attribute 44 + secure Require devices that support secure connect at 45 + minimum. User needs to authorize each device. 46 + dponly Automatically tunnel Display port (and USB). No 47 + PCIe tunnels are created. 48 + usbonly Automatically tunnel USB controller of the 48 49 connected Thunderbolt dock (and Display Port). All 49 50 PCIe links downstream of the dock are removed. 51 + ======= ================================================== 50 52 51 53 What: /sys/bus/thunderbolt/devices/.../authorized 52 54 Date: Sep 2017 ··· 63 61 yet authorized. 64 62 65 63 Possible values are supported: 66 - 1: The device will be authorized and connected 64 + 65 + == =========================================== 66 + 1 The device will be authorized and connected 67 + == =========================================== 67 68 68 69 When key attribute contains 32 byte hex string the possible 69 70 values are: 70 - 1: The 32 byte hex string is added to the device NVM and 71 - the device is authorized. 72 - 2: Send a challenge based on the 32 byte hex string. If the 73 - challenge response from device is valid, the device is 74 - authorized. In case of failure errno will be ENOKEY if 75 - the device did not contain a key at all, and 76 - EKEYREJECTED if the challenge response did not match. 71 + 72 + == ======================================================== 73 + 1 The 32 byte hex string is added to the device NVM and 74 + the device is authorized. 75 + 2 Send a challenge based on the 32 byte hex string. If the 76 + challenge response from device is valid, the device is 77 + authorized. In case of failure errno will be ENOKEY if 78 + the device did not contain a key at all, and 79 + EKEYREJECTED if the challenge response did not match. 80 + == ======================================================== 77 81 78 82 What: /sys/bus/thunderbolt/devices/.../boot 79 83 Date: Jun 2018
+17 -13
Documentation/ABI/testing/sysfs-bus-usb
··· 72 72 table at compile time. The format for the device ID is: 73 73 idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct 74 74 The vendor ID and device ID fields are required, the 75 - rest is optional. The Ref* tuple can be used to tell the 75 + rest is optional. The `Ref*` tuple can be used to tell the 76 76 driver to use the same driver_data for the new device as 77 77 it is used for the reference device. 78 78 Upon successfully adding an ID, the driver will probe 79 - for the device and attempt to bind to it. For example: 80 - # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id 79 + for the device and attempt to bind to it. For example:: 80 + 81 + # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id 81 82 82 83 Here add a new device (0458:7045) using driver_data from 83 - an already supported device (0458:704c): 84 - # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id 84 + an already supported device (0458:704c):: 85 + 86 + # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id 85 87 86 88 Reading from this file will list all dynamically added 87 89 device IDs in the same format, with one entry per 88 - line. For example: 89 - # cat /sys/bus/usb/drivers/foo/new_id 90 - 8086 10f5 91 - dead beef 06 92 - f00d cafe 90 + line. For example:: 91 + 92 + # cat /sys/bus/usb/drivers/foo/new_id 93 + 8086 10f5 94 + dead beef 06 95 + f00d cafe 93 96 94 97 The list will be truncated at PAGE_SIZE bytes due to 95 98 sysfs restrictions. ··· 212 209 advance, and behaves well according to the specification. 213 210 This attribute is a bit-field that controls the behavior of 214 211 a specific port: 212 + 215 213 - Bit 0 of this field selects the "old" enumeration scheme, 216 214 as it is considerably faster (it only causes one USB reset 217 215 instead of 2). ··· 237 233 poll() for monitoring changes to this value in user space. 238 234 239 235 Any time this value changes the corresponding hub device will send a 240 - udev event with the following attributes: 236 + udev event with the following attributes:: 241 237 242 - OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX 243 - OVER_CURRENT_COUNT=[current value of this sysfs attribute] 238 + OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX 239 + OVER_CURRENT_COUNT=[current value of this sysfs attribute] 244 240 245 241 What: /sys/bus/usb/devices/.../(hub interface)/portX/usb3_lpm_permit 246 242 Date: November 2015
+5 -2
Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
··· 12 12 Contact: Harrison Metzger <harrisonmetz@gmail.com> 13 13 Description: Controls the devices display mode. 14 14 For a 6 character display the values are 15 + 15 16 MSB 0x06; LSB 0x3F, and 17 + 16 18 for an 8 character display the values are 19 + 17 20 MSB 0x08; LSB 0xFF. 18 21 19 22 What: /sys/bus/usb/.../textmode ··· 40 37 Contact: Harrison Metzger <harrisonmetz@gmail.com> 41 38 Description: Controls the decimal places on the device. 42 39 To set the nth decimal place, give this field 43 - the value of 10 ** n. Assume this field has 40 + the value of ``10 ** n``. Assume this field has 44 41 the value k and has 1 or more decimal places set, 45 42 to set the mth place (where m is not already set), 46 - change this fields value to k + 10 ** m. 43 + change this fields value to ``k + 10 ** m``.
+6 -4
Documentation/ABI/testing/sysfs-bus-vfio-mdev
··· 28 28 Writing UUID to this file will create mediated device of 29 29 type <type-id> for parent device <device>. This is a 30 30 write-only file. 31 - For example: 32 - # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \ 31 + For example:: 32 + 33 + # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \ 33 34 /sys/devices/foo/mdev_supported_types/foo-1/create 34 35 35 36 What: /sys/.../mdev_supported_types/<type-id>/devices/ ··· 108 107 Writing '1' to this file destroys the mediated device. The 109 108 vendor driver can fail the remove() callback if that device 110 109 is active and the vendor driver doesn't support hot unplug. 111 - Example: 112 - # echo 1 > /sys/bus/mdev/devices/<UUID>/remove 110 + Example:: 111 + 112 + # echo 1 > /sys/bus/mdev/devices/<UUID>/remove
+10 -5
Documentation/ABI/testing/sysfs-class-cxl
··· 72 72 when performing the START_WORK ioctl. Only applicable when 73 73 running under hashed page table mmu. 74 74 Possible values: 75 - none: No prefaulting (default) 76 - work_element_descriptor: Treat the work element 77 - descriptor as an effective address and 78 - prefault what it points to. 79 - all: all segments process calling START_WORK maps. 75 + 76 + ======================= ====================================== 77 + none No prefaulting (default) 78 + work_element_descriptor Treat the work element 79 + descriptor as an effective address and 80 + prefault what it points to. 81 + all all segments process calling 82 + START_WORK maps. 83 + ======================= ====================================== 84 + 80 85 Users: https://github.com/ibm-capi/libcxl 81 86 82 87 What: /sys/class/cxl/<afu>/reset
+1 -1
Documentation/ABI/testing/sysfs-class-led
··· 50 50 You can change triggers in a similar manner to the way an IO 51 51 scheduler is chosen. Trigger specific parameters can appear in 52 52 /sys/class/leds/<led> once a given trigger is selected. For 53 - their documentation see sysfs-class-led-trigger-*. 53 + their documentation see `sysfs-class-led-trigger-*`. 54 54 55 55 What: /sys/class/leds/<led>/inverted 56 56 Date: January 2011
+117 -112
Documentation/ABI/testing/sysfs-class-led-driver-el15203000
··· 6 6 The LEDs board supports only predefined patterns by firmware 7 7 for specific LEDs. 8 8 9 - Breathing mode for Screen frame light tube: 10 - "0 4000 1 4000" 9 + Breathing mode for Screen frame light tube:: 11 10 12 - ^ 13 - | 14 - Max-| --- 15 - | / \ 16 - | / \ 17 - | / \ / 18 - | / \ / 19 - Min-|- --- 20 - | 21 - 0------4------8--> time (sec) 11 + "0 4000 1 4000" 22 12 23 - Cascade mode for Pipe LED: 24 - "1 800 2 800 4 800 8 800 16 800" 13 + ^ 14 + | 15 + Max-| --- 16 + | / \ 17 + | / \ 18 + | / \ / 19 + | / \ / 20 + Min-|- --- 21 + | 22 + 0------4------8--> time (sec) 25 23 26 - ^ 27 - | 28 - 0 On -|----+ +----+ +--- 29 - | | | | | 30 - Off-| +-------------------+ +-------------------+ 31 - | 32 - 1 On -| +----+ +----+ 33 - | | | | | 34 - Off |----+ +-------------------+ +------------------ 35 - | 36 - 2 On -| +----+ +----+ 37 - | | | | | 38 - Off-|---------+ +-------------------+ +------------- 39 - | 40 - 3 On -| +----+ +----+ 41 - | | | | | 42 - Off-|--------------+ +-------------------+ +-------- 43 - | 44 - 4 On -| +----+ +----+ 45 - | | | | | 46 - Off-|-------------------+ +-------------------+ +--- 47 - | 48 - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 24 + Cascade mode for Pipe LED:: 49 25 50 - Inverted cascade mode for Pipe LED: 51 - "30 800 29 800 27 800 23 800 15 800" 26 + "1 800 2 800 4 800 8 800 16 800" 52 27 53 - ^ 54 - | 55 - 0 On -| +-------------------+ +-------------------+ 56 - | | | | | 57 - Off-|----+ +----+ +--- 58 - | 59 - 1 On -|----+ +-------------------+ +------------------ 60 - | | | | | 61 - Off | +----+ +----+ 62 - | 63 - 2 On -|---------+ +-------------------+ +------------- 64 - | | | | | 65 - Off-| +----+ +----+ 66 - | 67 - 3 On -|--------------+ +-------------------+ +-------- 68 - | | | | | 69 - Off-| +----+ +----+ 70 - | 71 - 4 On -|-------------------+ +-------------------+ +--- 72 - | | | | | 73 - Off-| +----+ +----+ 74 - | 75 - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 28 + ^ 29 + | 30 + 0 On -|----+ +----+ +--- 31 + | | | | | 32 + Off-| +-------------------+ +-------------------+ 33 + | 34 + 1 On -| +----+ +----+ 35 + | | | | | 36 + Off |----+ +-------------------+ +------------------ 37 + | 38 + 2 On -| +----+ +----+ 39 + | | | | | 40 + Off-|---------+ +-------------------+ +------------- 41 + | 42 + 3 On -| +----+ +----+ 43 + | | | | | 44 + Off-|--------------+ +-------------------+ +-------- 45 + | 46 + 4 On -| +----+ +----+ 47 + | | | | | 48 + Off-|-------------------+ +-------------------+ +--- 49 + | 50 + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 76 51 77 - Bounce mode for Pipe LED: 78 - "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800" 52 + Inverted cascade mode for Pipe LED:: 79 53 80 - ^ 81 - | 82 - 0 On -|----+ +-------- 83 - | | | 84 - Off-| +---------------------------------------+ 85 - | 86 - 1 On -| +----+ +----+ 87 - | | | | | 88 - Off |----+ +-----------------------------+ +-------- 89 - | 90 - 2 On -| +----+ +----+ 91 - | | | | | 92 - Off-|---------+ +-------------------+ +------------- 93 - | 94 - 3 On -| +----+ +----+ 95 - | | | | | 96 - Off-|--------------+ +---------+ +------------------ 97 - | 98 - 4 On -| +---------+ 99 - | | | 100 - Off-|-------------------+ +----------------------- 101 - | 102 - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 54 + "30 800 29 800 27 800 23 800 15 800" 103 55 104 - Inverted bounce mode for Pipe LED: 105 - "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800" 56 + ^ 57 + | 58 + 0 On -| +-------------------+ +-------------------+ 59 + | | | | | 60 + Off-|----+ +----+ +--- 61 + | 62 + 1 On -|----+ +-------------------+ +------------------ 63 + | | | | | 64 + Off | +----+ +----+ 65 + | 66 + 2 On -|---------+ +-------------------+ +------------- 67 + | | | | | 68 + Off-| +----+ +----+ 69 + | 70 + 3 On -|--------------+ +-------------------+ +-------- 71 + | | | | | 72 + Off-| +----+ +----+ 73 + | 74 + 4 On -|-------------------+ +-------------------+ +--- 75 + | | | | | 76 + Off-| +----+ +----+ 77 + | 78 + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 106 79 107 - ^ 108 - | 109 - 0 On -| +---------------------------------------+ 110 - | | | 111 - Off-|----+ +-------- 112 - | 113 - 1 On -|----+ +-----------------------------+ +-------- 114 - | | | | | 115 - Off | +----+ +----+ 116 - | 117 - 2 On -|---------+ +-------------------+ +------------- 118 - | | | | | 119 - Off-| +----+ +----+ 120 - | 121 - 3 On -|--------------+ +---------+ +------------------ 122 - | | | | | 123 - Off-| +----+ +----+ 124 - | 125 - 4 On -|-------------------+ +----------------------- 126 - | | | 127 - Off-| +---------+ 128 - | 129 - 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 80 + Bounce mode for Pipe LED:: 81 + 82 + "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800" 83 + 84 + ^ 85 + | 86 + 0 On -|----+ +-------- 87 + | | | 88 + Off-| +---------------------------------------+ 89 + | 90 + 1 On -| +----+ +----+ 91 + | | | | | 92 + Off |----+ +-----------------------------+ +-------- 93 + | 94 + 2 On -| +----+ +----+ 95 + | | | | | 96 + Off-|---------+ +-------------------+ +------------- 97 + | 98 + 3 On -| +----+ +----+ 99 + | | | | | 100 + Off-|--------------+ +---------+ +------------------ 101 + | 102 + 4 On -| +---------+ 103 + | | | 104 + Off-|-------------------+ +----------------------- 105 + | 106 + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 107 + 108 + Inverted bounce mode for Pipe LED:: 109 + 110 + "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800" 111 + 112 + ^ 113 + | 114 + 0 On -| +---------------------------------------+ 115 + | | | 116 + Off-|----+ +-------- 117 + | 118 + 1 On -|----+ +-----------------------------+ +-------- 119 + | | | | | 120 + Off | +----+ +----+ 121 + | 122 + 2 On -|---------+ +-------------------+ +------------- 123 + | | | | | 124 + Off-| +----+ +----+ 125 + | 126 + 3 On -|--------------+ +---------+ +------------------ 127 + | | | | | 128 + Off-| +----+ +----+ 129 + | 130 + 4 On -|-------------------+ +----------------------- 131 + | | | 132 + Off-| +---------+ 133 + | 134 + 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 130 135 131 136 What: /sys/class/leds/<led>/repeat 132 137 Date: September 2019
+2 -2
Documentation/ABI/testing/sysfs-class-led-driver-sc27xx
··· 12 12 format, we should set brightness as 0 for rise stage, fall 13 13 stage and low stage. 14 14 15 - Min stage duration: 125 ms 16 - Max stage duration: 31875 ms 15 + - Min stage duration: 125 ms 16 + - Max stage duration: 31875 ms 17 17 18 18 Since the stage duration step is 125 ms, the duration should be 19 19 a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.
+32 -20
Documentation/ABI/testing/sysfs-class-mic
··· 41 41 When read, this entry provides the current state of an Intel 42 42 MIC device in the context of the card OS. Possible values that 43 43 will be read are: 44 - "ready" - The MIC device is ready to boot the card OS. On 45 - reading this entry after an OSPM resume, a "boot" has to be 46 - written to this entry if the card was previously shutdown 47 - during OSPM suspend. 48 - "booting" - The MIC device has initiated booting a card OS. 49 - "online" - The MIC device has completed boot and is online 50 - "shutting_down" - The card OS is shutting down. 51 - "resetting" - A reset has been initiated for the MIC device 52 - "reset_failed" - The MIC device has failed to reset. 44 + 45 + 46 + =============== =============================================== 47 + "ready" The MIC device is ready to boot the card OS. 48 + On reading this entry after an OSPM resume, 49 + a "boot" has to be written to this entry if 50 + the card was previously shutdown during OSPM 51 + suspend. 52 + "booting" The MIC device has initiated booting a card OS. 53 + "online" The MIC device has completed boot and is online 54 + "shutting_down" The card OS is shutting down. 55 + "resetting" A reset has been initiated for the MIC device 56 + "reset_failed" The MIC device has failed to reset. 57 + =============== =============================================== 53 58 54 59 When written, this sysfs entry triggers different state change 55 60 operations depending upon the current state of the card OS. 56 61 Acceptable values are: 57 - "boot" - Boot the card OS image specified by the combination 58 - of firmware, ramdisk, cmdline and bootmode 59 - sysfs entries. 60 - "reset" - Initiates device reset. 61 - "shutdown" - Initiates card OS shutdown. 62 + 63 + 64 + ========== =================================================== 65 + "boot" Boot the card OS image specified by the combination 66 + of firmware, ramdisk, cmdline and bootmode 67 + sysfs entries. 68 + "reset" Initiates device reset. 69 + "shutdown" Initiates card OS shutdown. 70 + ========== =================================================== 62 71 63 72 What: /sys/class/mic/mic(x)/shutdown_status 64 73 Date: October 2013 ··· 78 69 OS can shutdown because of various reasons. When read, this 79 70 entry provides the status on why the card OS was shutdown. 80 71 Possible values are: 81 - "nop" - shutdown status is not applicable, when the card OS is 82 - "online" 83 - "crashed" - Shutdown because of a HW or SW crash. 84 - "halted" - Shutdown because of a halt command. 85 - "poweroff" - Shutdown because of a poweroff command. 86 - "restart" - Shutdown because of a restart command. 72 + 73 + ========== =================================================== 74 + "nop" shutdown status is not applicable, when the card OS 75 + is "online" 76 + "crashed" Shutdown because of a HW or SW crash. 77 + "halted" Shutdown because of a halt command. 78 + "poweroff" Shutdown because of a poweroff command. 79 + "restart" Shutdown because of a restart command. 80 + ========== =================================================== 87 81 88 82 What: /sys/class/mic/mic(x)/cmdline 89 83 Date: October 2013
+3
Documentation/ABI/testing/sysfs-class-ocxl
··· 11 11 Description: read only 12 12 Number of contexts for the AFU, in the format <n>/<max> 13 13 where: 14 + 15 + ==== =============================================== 14 16 n: number of currently active contexts, for debug 15 17 max: maximum number of contexts supported by the AFU 18 + ==== =============================================== 16 19 17 20 What: /sys/class/ocxl/<afu name>/pp_mmio_size 18 21 Date: January 2018
+64 -9
Documentation/ABI/testing/sysfs-class-power
··· 1 - ===== General Properties ===== 1 + **General Properties** 2 2 3 3 What: /sys/class/power_supply/<supply_name>/manufacturer 4 4 Date: May 2007 ··· 72 72 critically low). 73 73 74 74 Access: Read, Write 75 + 75 76 Valid values: 0 - 100 (percent) 76 77 77 78 What: /sys/class/power_supply/<supply_name>/capacity_error_margin ··· 97 96 Coarse representation of battery capacity. 98 97 99 98 Access: Read 100 - Valid values: "Unknown", "Critical", "Low", "Normal", "High", 99 + 100 + Valid values: 101 + "Unknown", "Critical", "Low", "Normal", "High", 101 102 "Full" 102 103 103 104 What: /sys/class/power_supply/<supply_name>/current_avg ··· 142 139 throttling for thermal cooling or improving battery health. 143 140 144 141 Access: Read, Write 142 + 145 143 Valid values: Represented in microamps 146 144 147 145 What: /sys/class/power_supply/<supply_name>/charge_control_limit_max ··· 152 148 Maximum legal value for the charge_control_limit property. 153 149 154 150 Access: Read 151 + 155 152 Valid values: Represented in microamps 156 153 157 154 What: /sys/class/power_supply/<supply_name>/charge_control_start_threshold ··· 173 168 stop. 174 169 175 170 Access: Read, Write 171 + 176 172 Valid values: 0 - 100 (percent) 177 173 178 174 What: /sys/class/power_supply/<supply_name>/charge_type ··· 189 183 different algorithm. 190 184 191 185 Access: Read, Write 192 - Valid values: "Unknown", "N/A", "Trickle", "Fast", "Standard", 186 + 187 + Valid values: 188 + "Unknown", "N/A", "Trickle", "Fast", "Standard", 193 189 "Adaptive", "Custom" 194 190 195 191 What: /sys/class/power_supply/<supply_name>/charge_term_current ··· 202 194 when the battery is considered full and charging should end. 203 195 204 196 Access: Read 197 + 205 198 Valid values: Represented in microamps 206 199 207 200 What: /sys/class/power_supply/<supply_name>/health ··· 213 204 functionality. 214 205 215 206 Access: Read 216 - Valid values: "Unknown", "Good", "Overheat", "Dead", 207 + 208 + Valid values: 209 + "Unknown", "Good", "Overheat", "Dead", 217 210 "Over voltage", "Unspecified failure", "Cold", 218 211 "Watchdog timer expire", "Safety timer expire", 219 212 "Over current", "Calibration required", "Warm", ··· 229 218 for a battery charge cycle. 230 219 231 220 Access: Read 221 + 232 222 Valid values: Represented in microamps 233 223 234 224 What: /sys/class/power_supply/<supply_name>/present ··· 239 227 Reports whether a battery is present or not in the system. 240 228 241 229 Access: Read 230 + 242 231 Valid values: 232 + 233 + == ======= 243 234 0: Absent 244 235 1: Present 236 + == ======= 245 237 246 238 What: /sys/class/power_supply/<supply_name>/status 247 239 Date: May 2007 ··· 256 240 used to enable/disable charging to the battery. 257 241 258 242 Access: Read, Write 259 - Valid values: "Unknown", "Charging", "Discharging", 243 + 244 + Valid values: 245 + "Unknown", "Charging", "Discharging", 260 246 "Not charging", "Full" 261 247 262 248 What: /sys/class/power_supply/<supply_name>/technology ··· 268 250 Describes the battery technology supported by the supply. 269 251 270 252 Access: Read 271 - Valid values: "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", 253 + 254 + Valid values: 255 + "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe", 272 256 "NiCd", "LiMn" 273 257 274 258 What: /sys/class/power_supply/<supply_name>/temp ··· 280 260 Reports the current TBAT battery temperature reading. 281 261 282 262 Access: Read 263 + 283 264 Valid values: Represented in 1/10 Degrees Celsius 284 265 285 266 What: /sys/class/power_supply/<supply_name>/temp_alert_max ··· 295 274 critically high, and charging has stopped). 296 275 297 276 Access: Read 277 + 298 278 Valid values: Represented in 1/10 Degrees Celsius 299 279 300 280 What: /sys/class/power_supply/<supply_name>/temp_alert_min ··· 311 289 remedy the situation). 312 290 313 291 Access: Read 292 + 314 293 Valid values: Represented in 1/10 Degrees Celsius 315 294 316 295 What: /sys/class/power_supply/<supply_name>/temp_max ··· 322 299 charging. 323 300 324 301 Access: Read 302 + 325 303 Valid values: Represented in 1/10 Degrees Celsius 326 304 327 305 What: /sys/class/power_supply/<supply_name>/temp_min ··· 333 309 charging. 334 310 335 311 Access: Read 312 + 336 313 Valid values: Represented in 1/10 Degrees Celsius 337 314 338 315 What: /sys/class/power_supply/<supply_name>/voltage_avg, ··· 345 320 which they average readings to smooth out the reported value. 346 321 347 322 Access: Read 323 + 348 324 Valid values: Represented in microvolts 349 325 350 326 What: /sys/class/power_supply/<supply_name>/voltage_max, ··· 356 330 during charging. 357 331 358 332 Access: Read 333 + 359 334 Valid values: Represented in microvolts 360 335 361 336 What: /sys/class/power_supply/<supply_name>/voltage_min, ··· 367 340 during discharging. 368 341 369 342 Access: Read 343 + 370 344 Valid values: Represented in microvolts 371 345 372 346 What: /sys/class/power_supply/<supply_name>/voltage_now, ··· 378 350 This value is not averaged/smoothed. 379 351 380 352 Access: Read 353 + 381 354 Valid values: Represented in microvolts 382 355 383 - ===== USB Properties ===== 356 + **USB Properties** 384 357 385 358 What: /sys/class/power_supply/<supply_name>/current_avg 386 359 Date: May 2007 ··· 392 363 average readings to smooth out the reported value. 393 364 394 365 Access: Read 366 + 395 367 Valid values: Represented in microamps 396 368 397 369 ··· 403 373 Reports the maximum IBUS current the supply can support. 404 374 405 375 Access: Read 376 + 406 377 Valid values: Represented in microamps 407 378 408 379 What: /sys/class/power_supply/<supply_name>/current_now ··· 416 385 within the reported min/max range. 417 386 418 387 Access: Read, Write 388 + 419 389 Valid values: Represented in microamps 420 390 421 391 What: /sys/class/power_supply/<supply_name>/input_current_limit ··· 431 399 solved using power limit use input_current_limit. 432 400 433 401 Access: Read, Write 402 + 434 403 Valid values: Represented in microamps 435 404 436 405 What: /sys/class/power_supply/<supply_name>/input_voltage_limit ··· 474 441 USB supply so voltage and current can be controlled). 475 442 476 443 Access: Read, Write 444 + 477 445 Valid values: 446 + 447 + == ================================================== 478 448 0: Offline 479 449 1: Online Fixed - Fixed Voltage Supply 480 450 2: Online Programmable - Programmable Voltage Supply 451 + == ================================================== 481 452 482 453 What: /sys/class/power_supply/<supply_name>/temp 483 454 Date: May 2007 ··· 492 455 TJUNC temperature of an IC) 493 456 494 457 Access: Read 458 + 495 459 Valid values: Represented in 1/10 Degrees Celsius 496 460 497 461 What: /sys/class/power_supply/<supply_name>/temp_alert_max ··· 508 470 remedy the situation). 509 471 510 472 Access: Read 473 + 511 474 Valid values: Represented in 1/10 Degrees Celsius 512 475 513 476 What: /sys/class/power_supply/<supply_name>/temp_alert_min ··· 524 485 accordingly to remedy the situation). 525 486 526 487 Access: Read 488 + 527 489 Valid values: Represented in 1/10 Degrees Celsius 528 490 529 491 What: /sys/class/power_supply/<supply_name>/temp_max ··· 534 494 Reports the maximum allowed supply temperature for operation. 535 495 536 496 Access: Read 497 + 537 498 Valid values: Represented in 1/10 Degrees Celsius 538 499 539 500 What: /sys/class/power_supply/<supply_name>/temp_min ··· 544 503 Reports the mainimum allowed supply temperature for operation. 545 504 546 505 Access: Read 506 + 547 507 Valid values: Represented in 1/10 Degrees Celsius 548 508 549 509 What: /sys/class/power_supply/<supply_name>/usb_type ··· 556 514 is attached. 557 515 558 516 Access: Read-Only 559 - Valid values: "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD", 517 + 518 + Valid values: 519 + "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD", 560 520 "PD_DRP", "PD_PPS", "BrickID" 561 521 562 522 What: /sys/class/power_supply/<supply_name>/voltage_max ··· 568 524 Reports the maximum VBUS voltage the supply can support. 569 525 570 526 Access: Read 527 + 571 528 Valid values: Represented in microvolts 572 529 573 530 What: /sys/class/power_supply/<supply_name>/voltage_min ··· 578 533 Reports the minimum VBUS voltage the supply can support. 579 534 580 535 Access: Read 536 + 581 537 Valid values: Represented in microvolts 582 538 583 539 What: /sys/class/power_supply/<supply_name>/voltage_now ··· 591 545 within the reported min/max range. 592 546 593 547 Access: Read, Write 548 + 594 549 Valid values: Represented in microvolts 595 550 596 - ===== Device Specific Properties ===== 551 + **Device Specific Properties** 597 552 598 553 What: /sys/class/power/ds2760-battery.*/charge_now 599 554 Date: May 2010 ··· 628 581 will drop to 0 A) and will trigger interrupt. 629 582 630 583 Valid values: 584 + 631 585 - 5, 6 or 7 (hours), 632 586 - 0: disabled. 633 587 ··· 643 595 will drop to 0 A) and will trigger interrupt. 644 596 645 597 Valid values: 598 + 646 599 - 4 - 16 (hours), step by 2 (rounded down) 647 600 - 0: disabled. 648 601 ··· 658 609 interrupt and start top-off charging mode. 659 610 660 611 Valid values: 612 + 661 613 - 100000 - 200000 (microamps), step by 25000 (rounded down) 662 614 - 200000 - 350000 (microamps), step by 50000 (rounded down) 663 615 - 0: disabled. ··· 674 624 will drop to 0 A) and will trigger interrupt. 675 625 676 626 Valid values: 627 + 677 628 - 0 - 70 (minutes), step by 10 (rounded down) 678 629 679 630 What: /sys/class/power_supply/bq24257-charger/ovp_voltage ··· 688 637 device datasheet for details. 689 638 690 639 Valid values: 640 + 691 641 - 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000, 692 642 10500000 (all uV) 693 643 ··· 704 652 lower than the set value. See device datasheet for details. 705 653 706 654 Valid values: 655 + 707 656 - 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000, 708 657 4760000 (all uV) 709 658 ··· 719 666 the charger operates normally. See device datasheet for details. 720 667 721 668 Valid values: 669 + 722 670 - 1: enabled 723 671 - 0: disabled 724 672 ··· 735 681 from the system. See device datasheet for details. 736 682 737 683 Valid values: 684 + 738 685 - 1: enabled 739 686 - 0: disabled 740 687
+19 -14
Documentation/ABI/testing/sysfs-class-power-twl4030
··· 4 4 Writing to this can disable charging. 5 5 6 6 Possible values are: 7 - "auto" - draw power as appropriate for detected 8 - power source and battery status. 9 - "off" - do not draw any power. 10 - "continuous" 11 - - activate mode described as "linear" in 12 - TWL data sheets. This uses whatever 13 - current is available and doesn't switch off 14 - when voltage drops. 15 7 16 - This is useful for unstable power sources 17 - such as bicycle dynamo, but care should 18 - be taken that battery is not over-charged. 8 + ============= =========================================== 9 + "auto" draw power as appropriate for detected 10 + power source and battery status. 11 + "off" do not draw any power. 12 + "continuous" activate mode described as "linear" in 13 + TWL data sheets. This uses whatever 14 + current is available and doesn't switch off 15 + when voltage drops. 16 + 17 + This is useful for unstable power sources 18 + such as bicycle dynamo, but care should 19 + be taken that battery is not over-charged. 20 + ============= =========================================== 19 21 20 22 What: /sys/class/power_supply/twl4030_ac/mode 21 23 Description: ··· 25 23 Writing to this can disable charging. 26 24 27 25 Possible values are: 28 - "auto" - draw power as appropriate for detected 29 - power source and battery status. 30 - "off" - do not draw any power. 26 + 27 + ====== =========================================== 28 + "auto" draw power as appropriate for detected 29 + power source and battery status. 30 + "off" do not draw any power. 31 + ====== ===========================================
+28 -2
Documentation/ABI/testing/sysfs-class-rc
··· 21 21 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 22 22 Description: 23 23 Reading this file returns a list of available protocols, 24 - something like: 24 + something like:: 25 + 25 26 "rc5 [rc6] nec jvc [sony]" 27 + 26 28 Enabled protocols are shown in [] brackets. 29 + 27 30 Writing "+proto" will add a protocol to the list of enabled 28 31 protocols. 32 + 29 33 Writing "-proto" will remove a protocol from the list of enabled 30 34 protocols. 35 + 31 36 Writing "proto" will enable only "proto". 37 + 32 38 Writing "none" will disable all protocols. 39 + 33 40 Write fails with EINVAL if an invalid protocol combination or 34 41 unknown protocol name is used. 35 42 ··· 46 39 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 47 40 Description: 48 41 Sets the scancode filter expected value. 42 + 49 43 Use in combination with /sys/class/rc/rcN/filter_mask to set the 50 44 expected value of the bits set in the filter mask. 51 45 If the hardware supports it then scancodes which do not match 52 46 the filter will be ignored. Otherwise the write will fail with 53 47 an error. 48 + 54 49 This value may be reset to 0 if the current protocol is altered. 55 50 56 51 What: /sys/class/rc/rcN/filter_mask ··· 65 56 of the scancode which should be compared against the expected 66 57 value. A value of 0 disables the filter to allow all valid 67 58 scancodes to be processed. 59 + 68 60 If the hardware supports it then scancodes which do not match 69 61 the filter will be ignored. Otherwise the write will fail with 70 62 an error. 63 + 71 64 This value may be reset to 0 if the current protocol is altered. 72 65 73 66 What: /sys/class/rc/rcN/wakeup_protocols ··· 78 67 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 79 68 Description: 80 69 Reading this file returns a list of available protocols to use 81 - for the wakeup filter, something like: 70 + for the wakeup filter, something like:: 71 + 82 72 "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce" 73 + 83 74 Note that protocol variants are listed, so "nec", "sony", 84 75 "rc-5", "rc-6" have their different bit length encodings 85 76 listed if available. 77 + 86 78 The enabled wakeup protocol is shown in [] brackets. 79 + 87 80 Only one protocol can be selected at a time. 81 + 88 82 Writing "proto" will use "proto" for wakeup events. 83 + 89 84 Writing "none" will disable wakeup. 85 + 90 86 Write fails with EINVAL if an invalid protocol combination or 91 87 unknown protocol name is used, or if wakeup is not supported by 92 88 the hardware. ··· 104 86 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 105 87 Description: 106 88 Sets the scancode wakeup filter expected value. 89 + 107 90 Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to 108 91 set the expected value of the bits set in the wakeup filter mask 109 92 to trigger a system wake event. 93 + 110 94 If the hardware supports it and wakeup_filter_mask is not 0 then 111 95 scancodes which match the filter will wake the system from e.g. 112 96 suspend to RAM or power off. 97 + 113 98 Otherwise the write will fail with an error. 99 + 114 100 This value may be reset to 0 if the wakeup protocol is altered. 115 101 116 102 What: /sys/class/rc/rcN/wakeup_filter_mask ··· 123 101 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 124 102 Description: 125 103 Sets the scancode wakeup filter mask of bits to compare. 104 + 126 105 Use in combination with /sys/class/rc/rcN/wakeup_filter to set 127 106 the bits of the scancode which should be compared against the 128 107 expected value to trigger a system wake event. 108 + 129 109 If the hardware supports it and wakeup_filter_mask is not 0 then 130 110 scancodes which match the filter will wake the system from e.g. 131 111 suspend to RAM or power off. 112 + 132 113 Otherwise the write will fail with an error. 114 + 133 115 This value may be reset to 0 if the wakeup protocol is altered.
+4 -3
Documentation/ABI/testing/sysfs-class-scsi_host
··· 56 56 management) on top, which makes it match the Windows IRST (Intel 57 57 Rapid Storage Technology) driver settings. This setting is also 58 58 close to min_power, except that: 59 + 59 60 a) It does not use host-initiated slumber mode, but it does 60 - allow device-initiated slumber 61 + allow device-initiated slumber 61 62 b) It does not enable low power device sleep mode (DevSlp). 62 63 63 64 What: /sys/class/scsi_host/hostX/em_message ··· 71 70 protocol, writes and reads correspond to the LED message format 72 71 as defined in the AHCI spec. 73 72 74 - The user must turn sw_activity (under /sys/block/*/device/) OFF 75 - it they wish to control the activity LED via the em_message 73 + The user must turn sw_activity (under `/sys/block/*/device/`) 74 + OFF it they wish to control the activity LED via the em_message 76 75 file. 77 76 78 77 em_message_type: (RO) Displays the current enclosure management
+9 -3
Documentation/ABI/testing/sysfs-class-typec
··· 40 40 attribute will not return until the operation has finished. 41 41 42 42 Valid values: 43 - - source (The port will behave as source only DFP port) 44 - - sink (The port will behave as sink only UFP port) 45 - - dual (The port will behave as dual-role-data and 43 + 44 + ====== ============================================== 45 + source (The port will behave as source only DFP port) 46 + sink (The port will behave as sink only UFP port) 47 + dual (The port will behave as dual-role-data and 46 48 dual-role-power port) 49 + ====== ============================================== 47 50 48 51 What: /sys/class/typec/<port>/vconn_source 49 52 Date: April 2017 ··· 62 59 generates uevent KOBJ_CHANGE. 63 60 64 61 Valid values: 62 + 65 63 - "no" when the port is not the VCONN Source 66 64 - "yes" when the port is the VCONN Source 67 65 ··· 76 72 power operation mode should show "usb_power_delivery". 77 73 78 74 Valid values: 75 + 79 76 - default 80 77 - 1.5A 81 78 - 3.0A ··· 196 191 Contact: Heikki Krogerus <heikki.krogerus@linux.intel.com> 197 192 Description: 198 193 Shows type of the plug on the cable: 194 + 199 195 - type-a - Standard A 200 196 - type-b - Standard B 201 197 - type-c
+4
Documentation/ABI/testing/sysfs-devices-platform-ACPI-TAD
··· 7 7 (RO) Hexadecimal bitmask of the TAD attributes are reported by 8 8 the platform firmware (see ACPI 6.2, section 9.18.2): 9 9 10 + ======= ====================================================== 10 11 BIT(0): AC wakeup implemented if set 11 12 BIT(1): DC wakeup implemented if set 12 13 BIT(2): Get/set real time features implemented if set ··· 17 16 BIT(6): The AC timer wakes up from S5 if set 18 17 BIT(7): The DC timer wakes up from S4 if set 19 18 BIT(8): The DC timer wakes up from S5 if set 19 + ======= ====================================================== 20 20 21 21 The other bits are reserved. 22 22 ··· 64 62 timer status with the following meaning of bits (see ACPI 6.2, 65 63 Section 9.18.5): 66 64 65 + ======= ====================================================== 67 66 Bit(0): The timer has expired if set. 68 67 Bit(1): The timer has woken up the system from a sleep state 69 68 (S3 or S4/S5 if supported) if set. 69 + ======= ====================================================== 70 70 71 71 The other bits are reserved. 72 72
+8 -2
Documentation/ABI/testing/sysfs-devices-platform-docg3
··· 9 9 The protection has information embedded whether it blocks reads, 10 10 writes or both. 11 11 The result is: 12 - 0 -> the DPS is not keylocked 13 - 1 -> the DPS is keylocked 12 + 13 + - 0 -> the DPS is not keylocked 14 + - 1 -> the DPS is keylocked 15 + 14 16 Users: None identified so far. 15 17 16 18 What: /sys/devices/platform/docg3/f[0-3]_dps[01]_protection_key ··· 29 27 Entering the correct value toggle the lock, and can be observed 30 28 through f[0-3]_dps[01]_is_keylocked. 31 29 Possible values are: 30 + 32 31 - 8 bytes 32 + 33 33 Typical values are: 34 + 34 35 - "00000000" 35 36 - "12345678" 37 + 36 38 Users: None identified so far.
+4 -4
Documentation/ABI/testing/sysfs-devices-platform-sh_mobile_lcdc_fb
··· 17 17 to overlay planes. 18 18 19 19 Selects the composition mode for the overlay. Possible values 20 - are 20 + are: 21 21 22 - 0 - Alpha Blending 23 - 1 - ROP3 22 + - 0 - Alpha Blending 23 + - 1 - ROP3 24 24 25 25 What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_position 26 26 Date: May 2012 ··· 30 30 to overlay planes. 31 31 32 32 Stores the x,y overlay position on the display in pixels. The 33 - position format is `[0-9]+,[0-9]+'. 33 + position format is `[0-9]+,[0-9]+`. 34 34 35 35 What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_rop3 36 36 Date: May 2012
+62 -37
Documentation/ABI/testing/sysfs-devices-system-cpu
··· 151 151 The processor idle states which are available for use have the 152 152 following attributes: 153 153 154 - name: (RO) Name of the idle state (string). 154 + ======== ==== ================================================= 155 + name: (RO) Name of the idle state (string). 155 156 156 157 latency: (RO) The latency to exit out of this idle state (in 157 - microseconds). 158 + microseconds). 158 159 159 - power: (RO) The power consumed while in this idle state (in 160 - milliwatts). 160 + power: (RO) The power consumed while in this idle state (in 161 + milliwatts). 161 162 162 - time: (RO) The total time spent in this idle state (in microseconds). 163 + time: (RO) The total time spent in this idle state 164 + (in microseconds). 163 165 164 - usage: (RO) Number of times this state was entered (a count). 166 + usage: (RO) Number of times this state was entered (a count). 165 167 166 - above: (RO) Number of times this state was entered, but the 167 - observed CPU idle duration was too short for it (a count). 168 + above: (RO) Number of times this state was entered, but the 169 + observed CPU idle duration was too short for it 170 + (a count). 168 171 169 - below: (RO) Number of times this state was entered, but the 170 - observed CPU idle duration was too long for it (a count). 172 + below: (RO) Number of times this state was entered, but the 173 + observed CPU idle duration was too long for it 174 + (a count). 175 + ======== ==== ================================================= 171 176 172 177 What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc 173 178 Date: February 2008 ··· 295 290 This switch controls the boost setting for the whole system. 296 291 Boosting allows the CPU and the firmware to run at a frequency 297 292 beyound it's nominal limit. 293 + 298 294 More details can be found in 299 295 Documentation/admin-guide/pm/cpufreq.rst 300 296 ··· 343 337 Description: Parameters for the CPU cache attributes 344 338 345 339 allocation_policy: 346 - - WriteAllocate: allocate a memory location to a cache line 347 - on a cache miss because of a write 348 - - ReadAllocate: allocate a memory location to a cache line 340 + - WriteAllocate: 341 + allocate a memory location to a cache line 342 + on a cache miss because of a write 343 + - ReadAllocate: 344 + allocate a memory location to a cache line 349 345 on a cache miss because of a read 350 - - ReadWriteAllocate: both writeallocate and readallocate 346 + - ReadWriteAllocate: 347 + both writeallocate and readallocate 351 348 352 - attributes: LEGACY used only on IA64 and is same as write_policy 349 + attributes: 350 + LEGACY used only on IA64 and is same as write_policy 353 351 354 - coherency_line_size: the minimum amount of data in bytes that gets 352 + coherency_line_size: 353 + the minimum amount of data in bytes that gets 355 354 transferred from memory to cache 356 355 357 - level: the cache hierarchy in the multi-level cache configuration 356 + level: 357 + the cache hierarchy in the multi-level cache configuration 358 358 359 - number_of_sets: total number of sets in the cache, a set is a 359 + number_of_sets: 360 + total number of sets in the cache, a set is a 360 361 collection of cache lines with the same cache index 361 362 362 - physical_line_partition: number of physical cache line per cache tag 363 + physical_line_partition: 364 + number of physical cache line per cache tag 363 365 364 - shared_cpu_list: the list of logical cpus sharing the cache 366 + shared_cpu_list: 367 + the list of logical cpus sharing the cache 365 368 366 - shared_cpu_map: logical cpu mask containing the list of cpus sharing 369 + shared_cpu_map: 370 + logical cpu mask containing the list of cpus sharing 367 371 the cache 368 372 369 - size: the total cache size in kB 373 + size: 374 + the total cache size in kB 370 375 371 376 type: 372 377 - Instruction: cache that only holds instructions 373 378 - Data: cache that only caches data 374 379 - Unified: cache that holds both data and instructions 375 380 376 - ways_of_associativity: degree of freedom in placing a particular block 377 - of memory in the cache 381 + ways_of_associativity: 382 + degree of freedom in placing a particular block 383 + of memory in the cache 378 384 379 385 write_policy: 380 - - WriteThrough: data is written to both the cache line 386 + - WriteThrough: 387 + data is written to both the cache line 381 388 and to the block in the lower-level memory 382 - - WriteBack: data is written only to the cache line and 389 + - WriteBack: 390 + data is written only to the cache line and 383 391 the modified cache line is written to main 384 392 memory only when it is replaced 385 393 ··· 434 414 throttle attributes exported in the 'throttle_stats' directory: 435 415 436 416 - turbo_stat : This file gives the total number of times the max 437 - frequency is throttled to lower frequency in turbo (at and above 438 - nominal frequency) range of frequencies. 417 + frequency is throttled to lower frequency in turbo (at and above 418 + nominal frequency) range of frequencies. 439 419 440 420 - sub_turbo_stat : This file gives the total number of times the 441 - max frequency is throttled to lower frequency in sub-turbo(below 442 - nominal frequency) range of frequencies. 421 + max frequency is throttled to lower frequency in sub-turbo(below 422 + nominal frequency) range of frequencies. 443 423 444 424 - unthrottle : This file gives the total number of times the max 445 - frequency is unthrottled after being throttled. 425 + frequency is unthrottled after being throttled. 446 426 447 427 - powercap : This file gives the total number of times the max 448 - frequency is throttled due to 'Power Capping'. 428 + frequency is throttled due to 'Power Capping'. 449 429 450 430 - overtemp : This file gives the total number of times the max 451 - frequency is throttled due to 'CPU Over Temperature'. 431 + frequency is throttled due to 'CPU Over Temperature'. 452 432 453 433 - supply_fault : This file gives the total number of times the 454 - max frequency is throttled due to 'Power Supply Failure'. 434 + max frequency is throttled due to 'Power Supply Failure'. 455 435 456 436 - overcurrent : This file gives the total number of times the 457 - max frequency is throttled due to 'Overcurrent'. 437 + max frequency is throttled due to 'Overcurrent'. 458 438 459 439 - occ_reset : This file gives the total number of times the max 460 - frequency is throttled due to 'OCC Reset'. 440 + frequency is throttled due to 'OCC Reset'. 461 441 462 442 The sysfs attributes representing different throttle reasons like 463 443 powercap, overtemp, supply_fault, overcurrent and occ_reset map to ··· 489 469 Date: June 2016 490 470 Contact: Linux ARM Kernel Mailing list <linux-arm-kernel@lists.infradead.org> 491 471 Description: AArch64 CPU registers 472 + 492 473 'identification' directory exposes the CPU ID registers for 493 - identifying model and revision of the CPU. 474 + identifying model and revision of the CPU. 494 475 495 476 What: /sys/devices/system/cpu/cpu#/cpu_capacity 496 477 Date: December 2016 ··· 518 497 vulnerabilities. The output of those files reflects the 519 498 state of the CPUs in the system. Possible output values: 520 499 500 + ================ ============================================== 521 501 "Not affected" CPU is not affected by the vulnerability 522 502 "Vulnerable" CPU is affected and no mitigation in effect 523 503 "Mitigation: $M" CPU is affected and mitigation $M is in effect 504 + ================ ============================================== 524 505 525 506 See also: Documentation/admin-guide/hw-vuln/index.rst 526 507 ··· 538 515 control: Read/write interface to control SMT. Possible 539 516 values: 540 517 518 + ================ ========================================= 541 519 "on" SMT is enabled 542 520 "off" SMT is disabled 543 521 "forceoff" SMT is force disabled. Cannot be changed. 544 522 "notsupported" SMT is not supported by the CPU 545 523 "notimplemented" SMT runtime toggling is not 546 524 implemented for the architecture 525 + ================ ========================================= 547 526 548 527 If control status is "forceoff" or "notsupported" writes 549 528 are rejected.
+4 -2
Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
··· 5 5 Description: The state file allows a means by which to change in and 6 6 out of Premium Real-Time Mode (PRTM), as well as the 7 7 ability to query the current state. 8 - 0 => PRTM off 9 - 1 => PRTM enabled 8 + 9 + - 0 => PRTM off 10 + - 1 => PRTM enabled 11 + 10 12 Users: The ibm-prtm userspace daemon uses this interface. 11 13 12 14
+4
Documentation/ABI/testing/sysfs-driver-bd9571mwv-regulator
··· 6 6 if DDR power rails will be kept powered during system suspend. 7 7 ("on"/"1" = enabled, "off"/"0" = disabled). 8 8 Two types of power switches (or control signals) can be used: 9 + 9 10 A. With a momentary power switch (or pulse signal), DDR 10 11 Backup Mode is enabled by default when available, as the 11 12 PMIC will be configured only during system suspend. 12 13 B. With a toggle power switch (or level signal), the 13 14 following steps must be followed exactly: 15 + 14 16 1. Configure PMIC for backup mode, to change the role of 15 17 the accessory power switch from a power switch to a 16 18 wake-up switch, ··· 22 20 3. Suspend system, 23 21 4. Switch accessory power switch on, to resume the 24 22 system. 23 + 25 24 DDR Backup Mode must be explicitly enabled by the user, 26 25 to invoke step 1. 26 + 27 27 See also Documentation/devicetree/bindings/mfd/bd9571mwv.txt. 28 28 Users: User space applications for embedded boards equipped with a 29 29 BD9571MWV PMIC.
+9 -2
Documentation/ABI/testing/sysfs-driver-genwqe
··· 29 29 Date: May 2014 30 30 Contact: klebers@linux.vnet.ibm.com 31 31 Description: Interface to trigger a PCIe card reset to reload the bitstream. 32 + 33 + :: 34 + 32 35 sudo sh -c 'echo 1 > \ 33 36 /sys/class/genwqe/genwqe0_card/reload_bitstream' 37 + 34 38 If successfully, the card will come back with the bitstream set 35 39 on 'next_bitstream'. 36 40 ··· 68 64 What: /sys/class/genwqe/genwqe<n>_card/device/sriov_numvfs 69 65 Date: Oct 2013 70 66 Contact: haver@linux.vnet.ibm.com 71 - Description: Enable VFs (1..15): 67 + Description: Enable VFs (1..15):: 68 + 72 69 sudo sh -c 'echo 15 > \ 73 70 /sys/bus/pci/devices/0000\:1b\:00.0/sriov_numvfs' 74 - Disable VFs: 71 + 72 + Disable VFs:: 73 + 75 74 Write a 0 into the same sysfs entry.
+13 -5
Documentation/ABI/testing/sysfs-driver-hid-logitech-lg4ff
··· 12 12 Contact: Michal Malý <madcatxster@devoid-pointer.net> 13 13 Description: Displays a set of alternate modes supported by a wheel. Each 14 14 mode is listed as follows: 15 + 15 16 Tag: Mode Name 17 + 16 18 Currently active mode is marked with an asterisk. List also 17 19 contains an abstract item "native" which always denotes the 18 20 native mode of the wheel. Echoing the mode tag switches the ··· 26 24 This entry is not created for devices that have only one mode. 27 25 28 26 Currently supported mode switches: 29 - Driving Force Pro: 27 + 28 + Driving Force Pro:: 29 + 30 30 DF-EX --> DFP 31 31 32 - G25: 32 + G25:: 33 + 33 34 DF-EX --> DFP --> G25 34 35 35 - G27: 36 + G27:: 37 + 36 38 DF-EX <*> DFP <-> G25 <-> G27 37 39 DF-EX <*--------> G25 <-> G27 38 40 DF-EX <*----------------> G27 39 41 40 - G29: 42 + G29:: 43 + 41 44 DF-EX <*> DFP <-> G25 <-> G27 <-> G29 42 45 DF-EX <*--------> G25 <-> G27 <-> G29 43 46 DF-EX <*----------------> G27 <-> G29 44 47 DF-EX <*------------------------> G29 45 48 46 - DFGT: 49 + DFGT:: 50 + 47 51 DF-EX <*> DFP <-> DFGT 48 52 DF-EX <*--------> DFGT 49 53
+9 -2
Documentation/ABI/testing/sysfs-driver-hid-wiimote
··· 39 39 Other strings for each device-type are available and may be 40 40 added if new device-specific detections are added. 41 41 Currently supported are: 42 - gen10: First Wii Remote generation 43 - gen20: Second Wii Remote Plus generation (builtin MP) 42 + 43 + ============= ======================================= 44 + gen10: First Wii Remote generation 45 + gen20: Second Wii Remote Plus generation 46 + (builtin MP) 44 47 balanceboard: Wii Balance Board 48 + ============= ======================================= 45 49 46 50 What: /sys/bus/hid/drivers/wiimote/<dev>/bboard_calib 47 51 Date: May 2013 ··· 58 54 First, 0kg values for all 4 sensors are written, followed by the 59 55 17kg values for all 4 sensors and last the 34kg values for all 4 60 56 sensors. 57 + 61 58 Calibration data is already applied by the kernel to all input 62 59 values but may be used by user-space to perform other 63 60 transformations. ··· 73 68 is prefixed with a +/-. Each value is a signed 16bit number. 74 69 Data is encoded as decimal numbers and specifies the offsets of 75 70 the analog sticks of the pro-controller. 71 + 76 72 Calibration data is already applied by the kernel to all input 77 73 values but may be used by user-space to perform other 78 74 transformations. 75 + 79 76 Calibration data is detected by the kernel during device setup. 80 77 You can write "scan\n" into this file to re-trigger calibration. 81 78 You can also write data directly in the form "x1:y1 x2:y2" to
+8 -5
Documentation/ABI/testing/sysfs-driver-samsung-laptop
··· 9 9 their fans quiet at all costs. Reading from this file 10 10 will show the current performance level. Writing to the 11 11 file can change this value. 12 + 12 13 Valid options: 13 - "silent" 14 - "normal" 15 - "overclock" 14 + - "silent" 15 + - "normal" 16 + - "overclock" 17 + 16 18 Note that not all laptops support all of these options. 17 19 Specifically, not all support the "overclock" option, 18 20 and it's still unknown if this value even changes ··· 27 25 Description: Max battery charge level can be modified, battery cycle 28 26 life can be extended by reducing the max battery charge 29 27 level. 30 - 0 means normal battery mode (100% charge) 31 - 1 means battery life extender mode (80% charge) 28 + 29 + - 0 means normal battery mode (100% charge) 30 + - 1 means battery life extender mode (80% charge) 32 31 33 32 What: /sys/devices/platform/samsung/usb_charge 34 33 Date: December 1, 2011
+26
Documentation/ABI/testing/sysfs-driver-toshiba_acpi
··· 4 4 Contact: Azael Avalos <coproscefalo@gmail.com> 5 5 Description: This file controls the keyboard backlight operation mode, valid 6 6 values are: 7 + 7 8 * 0x1 -> FN-Z 8 9 * 0x2 -> AUTO (also called TIMER) 9 10 * 0x8 -> ON 10 11 * 0x10 -> OFF 12 + 11 13 Note that from kernel 3.16 onwards this file accepts all listed 12 14 parameters, kernel 3.15 only accepts the first two (FN-Z and 13 15 AUTO). ··· 43 41 Contact: Azael Avalos <coproscefalo@gmail.com> 44 42 Description: This files controls the status of the touchpad and pointing 45 43 stick (if available), valid values are: 44 + 46 45 * 0 -> OFF 47 46 * 1 -> ON 47 + 48 48 Users: KToshiba 49 49 50 50 What: /sys/devices/LNXSYSTM:00/LNXSYBUS:00/TOS{1900,620{0,7,8}}:00/available_kbd_modes ··· 55 51 Contact: Azael Avalos <coproscefalo@gmail.com> 56 52 Description: This file shows the supported keyboard backlight modes 57 53 the system supports, which can be: 54 + 58 55 * 0x1 -> FN-Z 59 56 * 0x2 -> AUTO (also called TIMER) 60 57 * 0x8 -> ON 61 58 * 0x10 -> OFF 59 + 62 60 Note that not all keyboard types support the listed modes. 63 61 See the entry named "available_kbd_modes" 64 62 Users: KToshiba ··· 71 65 Contact: Azael Avalos <coproscefalo@gmail.com> 72 66 Description: This file shows the current keyboard backlight type, 73 67 which can be: 68 + 74 69 * 1 -> Type 1, supporting modes FN-Z and AUTO 75 70 * 2 -> Type 2, supporting modes TIMER, ON and OFF 76 71 Users: KToshiba ··· 82 75 Contact: Azael Avalos <coproscefalo@gmail.com> 83 76 Description: This file controls the USB Sleep & Charge charging mode, which 84 77 can be: 78 + 85 79 * 0 -> Disabled (0x00) 86 80 * 1 -> Alternate (0x09) 87 81 * 2 -> Auto (0x21) 88 82 * 3 -> Typical (0x11) 83 + 89 84 Note that from kernel 4.1 onwards this file accepts all listed 90 85 values, kernel 4.0 only supports the first three. 91 86 Note that this feature only works when connected to power, if ··· 102 93 Description: This file controls the USB Sleep Functions under battery, and 103 94 set the level at which point they will be disabled, accepted 104 95 values can be: 96 + 105 97 * 0 -> Disabled 106 98 * 1-100 -> Battery level to disable sleep functions 99 + 107 100 Currently it prints two values, the first one indicates if the 108 101 feature is enabled or disabled, while the second one shows the 109 102 current battery level set. ··· 118 107 KernelVersion: 4.0 119 108 Contact: Azael Avalos <coproscefalo@gmail.com> 120 109 Description: This file controls the USB Rapid Charge state, which can be: 110 + 121 111 * 0 -> Disabled 122 112 * 1 -> Enabled 113 + 123 114 Note that toggling this value requires a reboot for changes to 124 115 take effect. 125 116 Users: KToshiba ··· 131 118 KernelVersion: 4.0 132 119 Contact: Azael Avalos <coproscefalo@gmail.com> 133 120 Description: This file controls the Sleep & Music state, which values can be: 121 + 134 122 * 0 -> Disabled 135 123 * 1 -> Enabled 124 + 136 125 Note that this feature only works when connected to power, if 137 126 you want to use it under battery, see the entry named 138 127 "sleep_functions_on_battery" ··· 153 138 Contact: Azael Avalos <coproscefalo@gmail.com> 154 139 Description: This file controls the state of the internal fan, valid 155 140 values are: 141 + 156 142 * 0 -> OFF 157 143 * 1 -> ON 158 144 ··· 163 147 Contact: Azael Avalos <coproscefalo@gmail.com> 164 148 Description: This file controls the Special Functions (hotkeys) operation 165 149 mode, valid values are: 150 + 166 151 * 0 -> Normal Operation 167 152 * 1 -> Special Functions 153 + 168 154 In the "Normal Operation" mode, the F{1-12} keys are as usual 169 155 and the hotkeys are accessed via FN-F{1-12}. 170 156 In the "Special Functions" mode, the F{1-12} keys trigger the ··· 181 163 Contact: Azael Avalos <coproscefalo@gmail.com> 182 164 Description: This file controls whether the laptop should turn ON whenever 183 165 the LID is opened, valid values are: 166 + 184 167 * 0 -> Disabled 185 168 * 1 -> Enabled 169 + 186 170 Note that toggling this value requires a reboot for changes to 187 171 take effect. 188 172 Users: KToshiba ··· 194 174 KernelVersion: 4.0 195 175 Contact: Azael Avalos <coproscefalo@gmail.com> 196 176 Description: This file controls the USB 3 functionality, valid values are: 177 + 197 178 * 0 -> Disabled (Acts as a regular USB 2) 198 179 * 1 -> Enabled (Full USB 3 functionality) 180 + 199 181 Note that toggling this value requires a reboot for changes to 200 182 take effect. 201 183 Users: KToshiba ··· 210 188 Reading this file prints two values, the first is the actual cooling method 211 189 and the second is the maximum cooling method supported. 212 190 When the maximum cooling method is ONE, valid values are: 191 + 213 192 * 0 -> Maximum Performance 214 193 * 1 -> Battery Optimized 194 + 215 195 When the maximum cooling method is TWO, valid values are: 196 + 216 197 * 0 -> Maximum Performance 217 198 * 1 -> Performance 218 199 * 2 -> Battery Optimized 200 + 219 201 Users: KToshiba
+2
Documentation/ABI/testing/sysfs-driver-toshiba_haps
··· 4 4 Contact: Azael Avalos <coproscefalo@gmail.com> 5 5 Description: This file controls the built-in accelerometer protection level, 6 6 valid values are: 7 + 7 8 * 0 -> Disabled 8 9 * 1 -> Low 9 10 * 2 -> Medium 10 11 * 3 -> High 12 + 11 13 The default potection value is set to 2 (Medium). 12 14 Users: KToshiba 13 15
+3 -1
Documentation/ABI/testing/sysfs-driver-wacom
··· 79 79 When the Wacom Intuos 4 is connected over Bluetooth, the 80 80 image has to contain 256 bytes (64x32 px 1 bit colour). 81 81 The format is also scrambled, like in the USB mode, and it can 82 - be summarized by converting 76543210 into GECA6420. 82 + be summarized by converting:: 83 + 84 + 76543210 into GECA6420. 83 85 HGFEDCBA HFDB7531 84 86 85 87 What: /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote
+108 -97
Documentation/ABI/testing/sysfs-firmware-acpi
··· 12 12 image: The image bitmap. Currently a 32-bit BMP. 13 13 status: 1 if the image is valid, 0 if firmware invalidated it. 14 14 type: 0 indicates image is in BMP format. 15 + 16 + ======== =================================================== 15 17 version: The version of the BGRT. Currently 1. 16 18 xoffset: The number of pixels between the left of the screen 17 19 and the left edge of the image. 18 20 yoffset: The number of pixels between the top of the screen 19 21 and the top edge of the image. 22 + ======== =================================================== 20 23 21 24 What: /sys/firmware/acpi/hotplug/ 22 25 Date: February 2013 ··· 36 33 The following setting is available to user space for each 37 34 hotplug profile: 38 35 36 + ======== ======================================================= 39 37 enabled: If set, the ACPI core will handle notifications of 40 - hotplug events associated with the given class of 41 - devices and will allow those devices to be ejected with 42 - the help of the _EJ0 control method. Unsetting it 43 - effectively disables hotplug for the correspoinding 44 - class of devices. 38 + hotplug events associated with the given class of 39 + devices and will allow those devices to be ejected with 40 + the help of the _EJ0 control method. Unsetting it 41 + effectively disables hotplug for the correspoinding 42 + class of devices. 43 + ======== ======================================================= 45 44 46 45 The value of the above attribute is an integer number: 1 (set) 47 46 or 0 (unset). Attempts to write any other values to it will ··· 76 71 To figure out where all the SCI's are coming from, 77 72 /sys/firmware/acpi/interrupts contains a file listing 78 73 every possible source, and the count of how many 79 - times it has triggered. 74 + times it has triggered:: 80 75 81 - $ cd /sys/firmware/acpi/interrupts 82 - $ grep . * 83 - error: 0 84 - ff_gbl_lock: 0 enable 85 - ff_pmtimer: 0 invalid 86 - ff_pwr_btn: 0 enable 87 - ff_rt_clk: 2 disable 88 - ff_slp_btn: 0 invalid 89 - gpe00: 0 invalid 90 - gpe01: 0 enable 91 - gpe02: 108 enable 92 - gpe03: 0 invalid 93 - gpe04: 0 invalid 94 - gpe05: 0 invalid 95 - gpe06: 0 enable 96 - gpe07: 0 enable 97 - gpe08: 0 invalid 98 - gpe09: 0 invalid 99 - gpe0A: 0 invalid 100 - gpe0B: 0 invalid 101 - gpe0C: 0 invalid 102 - gpe0D: 0 invalid 103 - gpe0E: 0 invalid 104 - gpe0F: 0 invalid 105 - gpe10: 0 invalid 106 - gpe11: 0 invalid 107 - gpe12: 0 invalid 108 - gpe13: 0 invalid 109 - gpe14: 0 invalid 110 - gpe15: 0 invalid 111 - gpe16: 0 invalid 112 - gpe17: 1084 enable 113 - gpe18: 0 enable 114 - gpe19: 0 invalid 115 - gpe1A: 0 invalid 116 - gpe1B: 0 invalid 117 - gpe1C: 0 invalid 118 - gpe1D: 0 invalid 119 - gpe1E: 0 invalid 120 - gpe1F: 0 invalid 121 - gpe_all: 1192 122 - sci: 1194 123 - sci_not: 0 76 + $ cd /sys/firmware/acpi/interrupts 77 + $ grep . * 78 + error: 0 79 + ff_gbl_lock: 0 enable 80 + ff_pmtimer: 0 invalid 81 + ff_pwr_btn: 0 enable 82 + ff_rt_clk: 2 disable 83 + ff_slp_btn: 0 invalid 84 + gpe00: 0 invalid 85 + gpe01: 0 enable 86 + gpe02: 108 enable 87 + gpe03: 0 invalid 88 + gpe04: 0 invalid 89 + gpe05: 0 invalid 90 + gpe06: 0 enable 91 + gpe07: 0 enable 92 + gpe08: 0 invalid 93 + gpe09: 0 invalid 94 + gpe0A: 0 invalid 95 + gpe0B: 0 invalid 96 + gpe0C: 0 invalid 97 + gpe0D: 0 invalid 98 + gpe0E: 0 invalid 99 + gpe0F: 0 invalid 100 + gpe10: 0 invalid 101 + gpe11: 0 invalid 102 + gpe12: 0 invalid 103 + gpe13: 0 invalid 104 + gpe14: 0 invalid 105 + gpe15: 0 invalid 106 + gpe16: 0 invalid 107 + gpe17: 1084 enable 108 + gpe18: 0 enable 109 + gpe19: 0 invalid 110 + gpe1A: 0 invalid 111 + gpe1B: 0 invalid 112 + gpe1C: 0 invalid 113 + gpe1D: 0 invalid 114 + gpe1E: 0 invalid 115 + gpe1F: 0 invalid 116 + gpe_all: 1192 117 + sci: 1194 118 + sci_not: 0 124 119 125 - sci - The number of times the ACPI SCI 126 - has been called and claimed an interrupt. 120 + =========== ================================================== 121 + sci The number of times the ACPI SCI 122 + has been called and claimed an interrupt. 127 123 128 - sci_not - The number of times the ACPI SCI 129 - has been called and NOT claimed an interrupt. 124 + sci_not The number of times the ACPI SCI 125 + has been called and NOT claimed an interrupt. 130 126 131 - gpe_all - count of SCI caused by GPEs. 127 + gpe_all count of SCI caused by GPEs. 132 128 133 - gpeXX - count for individual GPE source 129 + gpeXX count for individual GPE source 134 130 135 - ff_gbl_lock - Global Lock 131 + ff_gbl_lock Global Lock 136 132 137 - ff_pmtimer - PM Timer 133 + ff_pmtimer PM Timer 138 134 139 - ff_pwr_btn - Power Button 135 + ff_pwr_btn Power Button 140 136 141 - ff_rt_clk - Real Time Clock 137 + ff_rt_clk Real Time Clock 142 138 143 - ff_slp_btn - Sleep Button 139 + ff_slp_btn Sleep Button 144 140 145 - error - an interrupt that can't be accounted for above. 141 + error an interrupt that can't be accounted for above. 146 142 147 - invalid: it's either a GPE or a Fixed Event that 148 - doesn't have an event handler. 143 + invalid it's either a GPE or a Fixed Event that 144 + doesn't have an event handler. 149 145 150 - disable: the GPE/Fixed Event is valid but disabled. 146 + disable the GPE/Fixed Event is valid but disabled. 151 147 152 - enable: the GPE/Fixed Event is valid and enabled. 148 + enable the GPE/Fixed Event is valid and enabled. 149 + =========== ================================================== 153 150 154 - Root has permission to clear any of these counters. Eg. 155 - # echo 0 > gpe11 151 + Root has permission to clear any of these counters. Eg.:: 156 152 157 - All counters can be cleared by clearing the total "sci": 158 - # echo 0 > sci 153 + # echo 0 > gpe11 154 + 155 + All counters can be cleared by clearing the total "sci":: 156 + 157 + # echo 0 > sci 159 158 160 159 None of these counters has an effect on the function 161 160 of the system, they are simply statistics. ··· 174 165 175 166 Let's take power button fixed event for example, please kill acpid 176 167 and other user space applications so that the machine won't shutdown 177 - when pressing the power button. 178 - # cat ff_pwr_btn 179 - 0 enabled 180 - # press the power button for 3 times; 181 - # cat ff_pwr_btn 182 - 3 enabled 183 - # echo disable > ff_pwr_btn 184 - # cat ff_pwr_btn 185 - 3 disabled 186 - # press the power button for 3 times; 187 - # cat ff_pwr_btn 188 - 3 disabled 189 - # echo enable > ff_pwr_btn 190 - # cat ff_pwr_btn 191 - 4 enabled 192 - /* 193 - * this is because the status bit is set even if the enable bit is cleared, 194 - * and it triggers an ACPI fixed event when the enable bit is set again 195 - */ 196 - # press the power button for 3 times; 197 - # cat ff_pwr_btn 198 - 7 enabled 199 - # echo disable > ff_pwr_btn 200 - # press the power button for 3 times; 201 - # echo clear > ff_pwr_btn /* clear the status bit */ 202 - # echo disable > ff_pwr_btn 203 - # cat ff_pwr_btn 204 - 7 enabled 168 + when pressing the power button:: 169 + 170 + # cat ff_pwr_btn 171 + 0 enabled 172 + # press the power button for 3 times; 173 + # cat ff_pwr_btn 174 + 3 enabled 175 + # echo disable > ff_pwr_btn 176 + # cat ff_pwr_btn 177 + 3 disabled 178 + # press the power button for 3 times; 179 + # cat ff_pwr_btn 180 + 3 disabled 181 + # echo enable > ff_pwr_btn 182 + # cat ff_pwr_btn 183 + 4 enabled 184 + /* 185 + * this is because the status bit is set even if the enable 186 + * bit is cleared, and it triggers an ACPI fixed event when 187 + * the enable bit is set again 188 + */ 189 + # press the power button for 3 times; 190 + # cat ff_pwr_btn 191 + 7 enabled 192 + # echo disable > ff_pwr_btn 193 + # press the power button for 3 times; 194 + # echo clear > ff_pwr_btn /* clear the status bit */ 195 + # echo disable > ff_pwr_btn 196 + # cat ff_pwr_btn 197 + 7 enabled 205 198
+27 -23
Documentation/ABI/testing/sysfs-firmware-dmi-entries
··· 33 33 doesn't matter), they will be represented in sysfs as 34 34 entries "T-0" through "T-(N-1)": 35 35 36 - Example entry directories: 36 + Example entry directories:: 37 37 38 38 /sys/firmware/dmi/entries/17-0 39 39 /sys/firmware/dmi/entries/17-1 ··· 50 50 Each DMI entry in sysfs has the common header values 51 51 exported as attributes: 52 52 53 - handle : The 16bit 'handle' that is assigned to this 53 + ======== ================================================= 54 + handle The 16bit 'handle' that is assigned to this 54 55 entry by the firmware. This handle may be 55 56 referred to by other entries. 56 - length : The length of the entry, as presented in the 57 + length The length of the entry, as presented in the 57 58 entry itself. Note that this is _not the 58 59 total count of bytes associated with the 59 - entry_. This value represents the length of 60 + entry. This value represents the length of 60 61 the "formatted" portion of the entry. This 61 62 "formatted" region is sometimes followed by 62 63 the "unformatted" region composed of nul 63 64 terminated strings, with termination signalled 64 65 by a two nul characters in series. 65 - raw : The raw bytes of the entry. This includes the 66 + raw The raw bytes of the entry. This includes the 66 67 "formatted" portion of the entry, the 67 68 "unformatted" strings portion of the entry, 68 69 and the two terminating nul characters. 69 - type : The type of the entry. This value is the same 70 + type The type of the entry. This value is the same 70 71 as found in the directory name. It indicates 71 72 how the rest of the entry should be interpreted. 72 - instance: The instance ordinal of the entry for the 73 + instance The instance ordinal of the entry for the 73 74 given type. This value is the same as found 74 75 in the parent directory name. 75 - position: The ordinal position (zero-based) of the entry 76 + position The ordinal position (zero-based) of the entry 76 77 within the entirety of the DMI entry table. 78 + ======== ================================================= 77 79 78 - === Entry Specialization === 80 + **Entry Specialization** 79 81 80 82 Some entry types may have other information available in 81 83 sysfs. Not all types are specialized. 82 84 83 - --- Type 15 - System Event Log --- 85 + **Type 15 - System Event Log** 84 86 85 87 This entry allows the firmware to export a log of 86 88 events the system has taken. This information is 87 89 typically backed by nvram, but the implementation 88 90 details are abstracted by this table. This entry's data 89 - is exported in the directory: 91 + is exported in the directory:: 90 92 91 - /sys/firmware/dmi/entries/15-0/system_event_log 93 + /sys/firmware/dmi/entries/15-0/system_event_log 92 94 93 95 and has the following attributes (documented in the 94 96 SMBIOS / DMI specification under "System Event Log (Type 15)": 95 97 96 - area_length 97 - header_start_offset 98 - data_start_offset 99 - access_method 100 - status 101 - change_token 102 - access_method_address 103 - header_format 104 - per_log_type_descriptor_length 105 - type_descriptors_supported_count 98 + - area_length 99 + - header_start_offset 100 + - data_start_offset 101 + - access_method 102 + - status 103 + - change_token 104 + - access_method_address 105 + - header_format 106 + - per_log_type_descriptor_length 107 + - type_descriptors_supported_count 106 108 107 109 As well, the kernel exports the binary attribute: 108 110 109 - raw_event_log : The raw binary bits of the event log 111 + ============= ==================================== 112 + raw_event_log The raw binary bits of the event log 110 113 as described by the DMI entry. 114 + ============= ====================================
+1 -1
Documentation/ABI/testing/sysfs-firmware-gsmi
··· 20 20 21 21 This directory has the same layout (and 22 22 underlying implementation as /sys/firmware/efi/vars. 23 - See Documentation/ABI/*/sysfs-firmware-efi-vars 23 + See `Documentation/ABI/*/sysfs-firmware-efi-vars` 24 24 for more information on how to interact with 25 25 this structure. 26 26
+8 -8
Documentation/ABI/testing/sysfs-firmware-memmap
··· 20 20 the raw memory map to userspace. 21 21 22 22 The structure is as follows: Under /sys/firmware/memmap there 23 - are subdirectories with the number of the entry as their name: 23 + are subdirectories with the number of the entry as their name:: 24 24 25 25 /sys/firmware/memmap/0 26 26 /sys/firmware/memmap/1 ··· 34 34 35 35 Each directory contains three files: 36 36 37 - start : The start address (as hexadecimal number with the 37 + ======== ===================================================== 38 + start The start address (as hexadecimal number with the 38 39 '0x' prefix). 39 - end : The end address, inclusive (regardless whether the 40 + end The end address, inclusive (regardless whether the 40 41 firmware provides inclusive or exclusive ranges). 41 - type : Type of the entry as string. See below for a list of 42 + type Type of the entry as string. See below for a list of 42 43 valid types. 44 + ======== ===================================================== 43 45 44 - So, for example: 46 + So, for example:: 45 47 46 48 /sys/firmware/memmap/0/start 47 49 /sys/firmware/memmap/0/end ··· 59 57 - reserved 60 58 61 59 Following shell snippet can be used to display that memory 62 - map in a human-readable format: 60 + map in a human-readable format:: 63 61 64 - -------------------- 8< ---------------------------------------- 65 62 #!/bin/bash 66 63 cd /sys/firmware/memmap 67 64 for dir in * ; do ··· 69 68 type=$(cat $dir/type) 70 69 printf "%016x-%016x (%s)\n" $start $[ $end +1] "$type" 71 70 done 72 - -------------------- >8 ----------------------------------------
+2 -2
Documentation/ABI/testing/sysfs-fs-ext4
··· 45 45 parameter will have their blocks allocated out of a 46 46 block group specific preallocation pool, so that small 47 47 files are packed closely together. Each large file 48 - will have its blocks allocated out of its own unique 49 - preallocation pool. 48 + will have its blocks allocated out of its own unique 49 + preallocation pool. 50 50 51 51 What: /sys/fs/ext4/<disk>/inode_readahead_blks 52 52 Date: March 2008
+8 -5
Documentation/ABI/testing/sysfs-hypervisor-xen
··· 15 15 Contact: Boris Ostrovsky <boris.ostrovsky@oracle.com> 16 16 Description: If running under Xen: 17 17 Describes mode that Xen's performance-monitoring unit (PMU) 18 - uses. Accepted values are 19 - "off" -- PMU is disabled 20 - "self" -- The guest can profile itself 21 - "hv" -- The guest can profile itself and, if it is 18 + uses. Accepted values are: 19 + 20 + ====== ============================================ 21 + "off" PMU is disabled 22 + "self" The guest can profile itself 23 + "hv" The guest can profile itself and, if it is 22 24 privileged (e.g. dom0), the hypervisor 23 - "all" -- The guest can profile itself, the hypervisor 25 + "all" The guest can profile itself, the hypervisor 24 26 and all other guests. Only available to 25 27 privileged guests. 28 + ====== ============================================ 26 29 27 30 What: /sys/hypervisor/pmu/pmu_features 28 31 Date: August 2015
+12 -11
Documentation/ABI/testing/sysfs-kernel-boot_params
··· 23 23 representation of setup_data type. "data" file is the binary 24 24 representation of setup_data payload. 25 25 26 - The whole boot_params directory structure is like below: 27 - /sys/kernel/boot_params 28 - |__ data 29 - |__ setup_data 30 - | |__ 0 31 - | | |__ data 32 - | | |__ type 33 - | |__ 1 34 - | |__ data 35 - | |__ type 36 - |__ version 26 + The whole boot_params directory structure is like below:: 27 + 28 + /sys/kernel/boot_params 29 + |__ data 30 + |__ setup_data 31 + | |__ 0 32 + | | |__ data 33 + | | |__ type 34 + | |__ 1 35 + | |__ data 36 + | |__ type 37 + |__ version 37 38 38 39 Users: Kexec
+7 -5
Documentation/ABI/testing/sysfs-kernel-mm-hugepages
··· 7 7 of the hugepages supported by the kernel/CPU combination. 8 8 9 9 Under these directories are a number of files: 10 - nr_hugepages 11 - nr_overcommit_hugepages 12 - free_hugepages 13 - surplus_hugepages 14 - resv_hugepages 10 + 11 + - nr_hugepages 12 + - nr_overcommit_hugepages 13 + - free_hugepages 14 + - surplus_hugepages 15 + - resv_hugepages 16 + 15 17 See Documentation/admin-guide/mm/hugetlbpage.rst for details.
+13 -8
Documentation/ABI/testing/sysfs-platform-asus-laptop
··· 4 4 Contact: "Corentin Chary" <corentincj@iksaif.net> 5 5 Description: 6 6 This file allows display switching. The value 7 - is composed by 4 bits and defined as follow: 8 - 4321 9 - |||`- LCD 10 - ||`-- CRT 11 - |`--- TV 12 - `---- DVI 13 - Ex: - 0 (0000b) means no display 7 + is composed by 4 bits and defined as follow:: 8 + 9 + 4321 10 + |||`- LCD 11 + ||`-- CRT 12 + |`--- TV 13 + `---- DVI 14 + 15 + Ex: 16 + - 0 (0000b) means no display 14 17 - 3 (0011b) CRT+LCD. 15 18 16 19 What: /sys/devices/platform/asus_laptop/gps ··· 31 28 Description: 32 29 Some models like the W1N have a LED display that can be 33 30 used to display several items of information. 34 - To control the LED display, use the following : 31 + To control the LED display, use the following:: 32 + 35 33 echo 0x0T000DDD > /sys/devices/platform/asus_laptop/ 34 + 36 35 where T control the 3 letters display, and DDD the 3 digits display. 37 36 The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst 38 37
+1
Documentation/ABI/testing/sysfs-platform-asus-wmi
··· 5 5 Description: 6 6 Change CPU clock configuration (write-only). 7 7 There are three available clock configuration: 8 + 8 9 * 0 -> Super Performance Mode 9 10 * 1 -> High Performance Mode 10 11 * 2 -> Power Saving Mode
+6 -4
Documentation/ABI/testing/sysfs-platform-at91
··· 18 18 In order to use an extended can_id add the 19 19 CAN_EFF_FLAG (0x80000000U) to the can_id. Example: 20 20 21 - - standard id 0x7ff: 22 - echo 0x7ff > /sys/class/net/can0/mb0_id 21 + - standard id 0x7ff:: 23 22 24 - - extended id 0x1fffffff: 25 - echo 0x9fffffff > /sys/class/net/can0/mb0_id 23 + echo 0x7ff > /sys/class/net/can0/mb0_id 24 + 25 + - extended id 0x1fffffff:: 26 + 27 + echo 0x9fffffff > /sys/class/net/can0/mb0_id
+10 -4
Documentation/ABI/testing/sysfs-platform-eeepc-laptop
··· 4 4 Contact: "Corentin Chary" <corentincj@iksaif.net> 5 5 Description: 6 6 This file allows display switching. 7 + 7 8 - 1 = LCD 8 9 - 2 = CRT 9 10 - 3 = LCD+CRT 11 + 10 12 If you run X11, you should use xrandr instead. 11 13 12 14 What: /sys/devices/platform/eeepc/camera ··· 32 30 Description: 33 31 Change CPU clock configuration. 34 32 On the Eee PC 1000H there are three available clock configuration: 33 + 35 34 * 0 -> Super Performance Mode 36 35 * 1 -> High Performance Mode 37 36 * 2 -> Power Saving Mode 37 + 38 38 On Eee PC 701 there is only 2 available clock configurations. 39 39 Available configuration are listed in available_cpufv file. 40 40 Reading this file will show the raw hexadecimal value which 41 - is defined as follow: 42 - | 8 bit | 8 bit | 43 - | `---- Current mode 44 - `------------ Availables modes 41 + is defined as follow:: 42 + 43 + | 8 bit | 8 bit | 44 + | `---- Current mode 45 + `------------ Availables modes 46 + 45 47 For example, 0x301 means: mode 1 selected, 3 available modes. 46 48 47 49 What: /sys/devices/platform/eeepc/available_cpufv
+6 -3
Documentation/ABI/testing/sysfs-platform-ideapad-laptop
··· 12 12 Description: 13 13 Change fan mode 14 14 There are four available modes: 15 + 15 16 * 0 -> Super Silent Mode 16 17 * 1 -> Standard Mode 17 18 * 2 -> Dust Cleaning ··· 33 32 Contact: "Oleg Keri <ezhi99@gmail.com>" 34 33 Description: 35 34 Control fn-lock mode. 35 + 36 36 * 1 -> Switched On 37 37 * 0 -> Switched Off 38 38 39 - For example: 40 - # echo "0" > \ 41 - /sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock 39 + For example:: 40 + 41 + # echo "0" > \ 42 + /sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock
+1
Documentation/ABI/testing/sysfs-platform-intel-wmi-thunderbolt
··· 7 7 Thunderbolt controllers to turn on or off when no 8 8 devices are connected (write-only) 9 9 There are two available states: 10 + 10 11 * 0 -> Force power disabled 11 12 * 1 -> Force power enabled
+11 -2
Documentation/ABI/testing/sysfs-platform-sst-atom
··· 5 5 Description: 6 6 LPE Firmware version for SST driver on all atom 7 7 plaforms (BYT/CHT/Merrifield/BSW). 8 - If the FW has never been loaded it will display: 8 + If the FW has never been loaded it will display:: 9 + 9 10 "FW not yet loaded" 10 - If FW has been loaded it will display: 11 + 12 + If FW has been loaded it will display:: 13 + 11 14 "v01.aa.bb.cc" 15 + 12 16 aa: Major version is reflecting SoC version: 17 + 18 + === ============= 13 19 0d: BYT FW 14 20 0b: BSW FW 15 21 07: Merrifield FW 22 + === ============= 23 + 16 24 bb: Minor version 25 + 17 26 cc: Build version
+7 -4
Documentation/ABI/testing/sysfs-platform-usbip-vudc
··· 16 16 Description: 17 17 Current status of the device. 18 18 Allowed values: 19 - 1 - Device is available and can be exported 20 - 2 - Device is currently exported 21 - 3 - Fatal error occurred during communication 22 - with peer 19 + 20 + == ========================================== 21 + 1 Device is available and can be exported 22 + 2 Device is currently exported 23 + 3 Fatal error occurred during communication 24 + with peer 25 + == ========================================== 23 26 24 27 What: /sys/devices/platform/usbip-vudc.%d/usbip_sockfd 25 28 Date: April 2016
+1 -1
Documentation/ABI/testing/sysfs-ptp
··· 69 69 pin offered by the PTP hardware clock. The file name 70 70 is the hardware dependent pin name. Reading from this 71 71 file produces two numbers, the assigned function (see 72 - the PTP_PF_ enumeration values in linux/ptp_clock.h) 72 + the `PTP_PF_` enumeration values in linux/ptp_clock.h) 73 73 and the channel number. The function and channel 74 74 assignment may be changed by two writing numbers into 75 75 the file.