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>
This commit is contained in:
Mauro Carvalho Chehab 2020-10-30 08:40:39 +01:00 committed by Greg Kroah-Hartman
parent 98913408c5
commit 3443333284
74 changed files with 1306 additions and 849 deletions

View File

@ -10,22 +10,24 @@ Description:
This interfaces can be used to show spear's PCIe device capability. This interfaces can be used to show spear's PCIe device capability.
Nodes are only visible when configfs is mounted. To mount configfs Nodes are only visible when configfs is mounted. To mount configfs
in /config directory use: in /config directory use::
# mount -t configfs none /config/
For nth PCIe Device Controller # mount -t configfs none /config/
/config/pcie-gadget.n/
link ... used to enable ltssm and read its status. For nth PCIe Device Controller /config/pcie-gadget.n/:
int_type ...used to configure and read type of supported
interrupt =============== ======================================================
no_of_msi ... used to configure number of MSI vector needed and link used to enable ltssm and read its status.
int_type used to configure and read type of supported interrupt
no_of_msi used to configure number of MSI vector needed and
to read no of MSI granted. to read no of MSI granted.
inta ... write 1 to assert INTA and 0 to de-assert. inta write 1 to assert INTA and 0 to de-assert.
send_msi ... write MSI vector to be sent. send_msi write MSI vector to be sent.
vendor_id ... used to write and read vendor id (hex) vendor_id used to write and read vendor id (hex)
device_id ... used to write and read device id (hex) device_id used to write and read device id (hex)
bar0_size ... used to write and read bar0_size bar0_size used to write and read bar0_size
bar0_address ... used to write and read bar0 mapped area in hex. bar0_address used to write and read bar0 mapped area in hex.
bar0_rw_offset ... used to write and read offset of bar0 where bar0_rw_offset used to write and read offset of bar0 where bar0_data
bar0_data will be written or read. will be written or read.
bar0_data ... used to write and read data at bar0_rw_offset. bar0_data used to write and read data at bar0_rw_offset.
=============== ======================================================

View File

@ -12,22 +12,24 @@ Description:
The attributes of a gadget: The attributes of a gadget:
UDC - bind a gadget to UDC/unbind a gadget; ================ ============================================
write UDC's name found in /sys/class/udc/* UDC bind a gadget to UDC/unbind a gadget;
to bind a gadget, empty string "" to unbind. write UDC's name found in /sys/class/udc/*
to bind a gadget, empty string "" to unbind.
max_speed - maximum speed the driver supports. Valid max_speed maximum speed the driver supports. Valid
names are super-speed-plus, super-speed, names are super-speed-plus, super-speed,
high-speed, full-speed, and low-speed. high-speed, full-speed, and low-speed.
bDeviceClass - USB device class code bDeviceClass USB device class code
bDeviceSubClass - USB device subclass code bDeviceSubClass USB device subclass code
bDeviceProtocol - USB device protocol code bDeviceProtocol USB device protocol code
bMaxPacketSize0 - maximum endpoint 0 packet size bMaxPacketSize0 maximum endpoint 0 packet size
bcdDevice - bcd device release number bcdDevice bcd device release number
bcdUSB - bcd USB specification version number bcdUSB bcd USB specification version number
idProduct - product ID idProduct product ID
idVendor - vendor ID idVendor vendor ID
================ ============================================
What: /config/usb-gadget/gadget/configs What: /config/usb-gadget/gadget/configs
Date: Jun 2013 Date: Jun 2013
@ -41,8 +43,10 @@ KernelVersion: 3.11
Description: Description:
The attributes of a configuration: The attributes of a configuration:
bmAttributes - configuration characteristics ================ ======================================
MaxPower - maximum power consumption from the bus bmAttributes configuration characteristics
MaxPower maximum power consumption from the bus
================ ======================================
What: /config/usb-gadget/gadget/configs/config/strings What: /config/usb-gadget/gadget/configs/config/strings
Date: Jun 2013 Date: Jun 2013
@ -57,7 +61,9 @@ KernelVersion: 3.11
Description: Description:
The attributes: The attributes:
configuration - configuration description ================ =========================
configuration configuration description
================ =========================
What: /config/usb-gadget/gadget/functions What: /config/usb-gadget/gadget/functions
@ -76,8 +82,10 @@ Description:
The attributes: The attributes:
compatible_id - 8-byte string for "Compatible ID" ================= =====================================
sub_compatible_id - 8-byte string for "Sub Compatible ID" compatible_id 8-byte string for "Compatible ID"
sub_compatible_id 8-byte string for "Sub Compatible ID"
================= =====================================
What: /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property> What: /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
Date: May 2014 Date: May 2014
@ -89,16 +97,19 @@ Description:
The attributes: The attributes:
type - value 1..7 for interpreting the data ===== ===============================================
1: unicode string type value 1..7 for interpreting the data
2: unicode string with environment variable
3: binary - 1: unicode string
4: little-endian 32-bit - 2: unicode string with environment variable
5: big-endian 32-bit - 3: binary
6: unicode string with a symbolic link - 4: little-endian 32-bit
7: multiple unicode strings - 5: big-endian 32-bit
data - blob of data to be interpreted depending on - 6: unicode string with a symbolic link
- 7: multiple unicode strings
data blob of data to be interpreted depending on
type type
===== ===============================================
What: /config/usb-gadget/gadget/strings What: /config/usb-gadget/gadget/strings
Date: Jun 2013 Date: Jun 2013
@ -113,9 +124,11 @@ KernelVersion: 3.11
Description: Description:
The attributes: The attributes:
serialnumber - gadget's serial number (string) ============ =================================
product - gadget's product description serialnumber gadget's serial number (string)
manufacturer - gadget's manufacturer description product gadget's product description
manufacturer gadget's manufacturer description
============ =================================
What: /config/usb-gadget/gadget/os_desc What: /config/usb-gadget/gadget/os_desc
Date: May 2014 Date: May 2014
@ -123,8 +136,10 @@ KernelVersion: 3.16
Description: Description:
This group contains "OS String" extension handling attributes. This group contains "OS String" extension handling attributes.
use - flag turning "OS Desctiptors" support on/off ============= ===============================================
b_vendor_code - one-byte value used for custom per-device and use flag turning "OS Desctiptors" support on/off
b_vendor_code one-byte value used for custom per-device and
per-interface requests per-interface requests
qw_sign - an identifier to be reported as "OS String" qw_sign an identifier to be reported as "OS String"
proper proper
============= ===============================================

View File

@ -4,8 +4,10 @@ KernelVersion: 3.19
Description: Description:
The attributes: The attributes:
protocol - HID protocol to use ============= ============================================
report_desc - blob corresponding to HID report descriptors protocol HID protocol to use
report_desc blob corresponding to HID report descriptors
except the data passed through /dev/hidg<N> except the data passed through /dev/hidg<N>
report_length - HID report length report_length HID report length
subclass - HID device subclass to use subclass HID device subclass to use
============= ============================================

View File

@ -4,14 +4,16 @@ KernelVersion: 3.11
Description: Description:
The attributes: The attributes:
ifname - network device interface name associated with ========= =============================================
ifname network device interface name associated with
this function instance this function instance
qmult - queue length multiplier for high and qmult queue length multiplier for high and
super speed super speed
host_addr - MAC address of host's end of this host_addr MAC address of host's end of this
Ethernet over USB link Ethernet over USB link
dev_addr - MAC address of device's end of this dev_addr MAC address of device's end of this
Ethernet over USB link Ethernet over USB link
class - USB interface class, default is 02 (hex) class USB interface class, default is 02 (hex)
subclass - USB interface subclass, default is 06 (hex) subclass USB interface subclass, default is 06 (hex)
protocol - USB interface protocol, default is 00 (hex) protocol USB interface protocol, default is 00 (hex)
========= =============================================

View File

@ -4,11 +4,13 @@ KernelVersion: 4.14
Description: Description:
The attributes: The attributes:
c_chmask - capture channel mask ========== ===================================
c_srate - capture sampling rate c_chmask capture channel mask
c_ssize - capture sample size (bytes) c_srate capture sampling rate
p_chmask - playback channel mask c_ssize capture sample size (bytes)
p_srate - playback sampling rate p_chmask playback channel mask
p_ssize - playback sample size (bytes) p_srate playback sampling rate
req_number - the number of pre-allocated request p_ssize playback sample size (bytes)
for both capture and playback req_number the number of pre-allocated request
for both capture and playback
========== ===================================

View File

@ -3,9 +3,11 @@ Date: Dec 2014
KernelVersion: 4.0 KernelVersion: 4.0
Description: UVC function directory Description: UVC function directory
streaming_maxburst - 0..15 (ss only) =================== =============================
streaming_maxpacket - 1..1023 (fs), 1..3072 (hs/ss) streaming_maxburst 0..15 (ss only)
streaming_interval - 1..16 streaming_maxpacket 1..1023 (fs), 1..3072 (hs/ss)
streaming_interval 1..16
=================== =============================
What: /config/usb-gadget/gadget/functions/uvc.name/control What: /config/usb-gadget/gadget/functions/uvc.name/control
Date: Dec 2014 Date: Dec 2014
@ -13,8 +15,11 @@ KernelVersion: 4.0
Description: Control descriptors Description: Control descriptors
All attributes read only: All attributes read only:
bInterfaceNumber - USB interface number for this
streaming interface ================ =============================
bInterfaceNumber USB interface number for this
streaming interface
================ =============================
What: /config/usb-gadget/gadget/functions/uvc.name/control/class What: /config/usb-gadget/gadget/functions/uvc.name/control/class
Date: Dec 2014 Date: Dec 2014
@ -47,13 +52,16 @@ KernelVersion: 4.0
Description: Default output terminal descriptors Description: Default output terminal descriptors
All attributes read only: All attributes read only:
iTerminal - index of string descriptor
bSourceID - id of the terminal to which this terminal ============== =============================================
iTerminal index of string descriptor
bSourceID id of the terminal to which this terminal
is connected is connected
bAssocTerminal - id of the input terminal to which this output bAssocTerminal id of the input terminal to which this output
terminal is associated terminal is associated
wTerminalType - terminal type wTerminalType terminal type
bTerminalID - a non-zero id of this terminal bTerminalID a non-zero id of this terminal
============== =============================================
What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
Date: Dec 2014 Date: Dec 2014
@ -66,16 +74,19 @@ KernelVersion: 4.0
Description: Default camera terminal descriptors Description: Default camera terminal descriptors
All attributes read only: All attributes read only:
bmControls - bitmap specifying which controls are
supported for the video stream ======================== ====================================
wOcularFocalLength - the value of Locular bmControls bitmap specifying which controls are
wObjectiveFocalLengthMax- the value of Lmin supported for the video stream
wObjectiveFocalLengthMin- the value of Lmax wOcularFocalLength the value of Locular
iTerminal - index of string descriptor wObjectiveFocalLengthMax the value of Lmin
bAssocTerminal - id of the output terminal to which wObjectiveFocalLengthMin the value of Lmax
this terminal is connected iTerminal index of string descriptor
wTerminalType - terminal type bAssocTerminal id of the output terminal to which
bTerminalID - a non-zero id of this terminal this terminal is connected
wTerminalType terminal type
bTerminalID a non-zero id of this terminal
======================== ====================================
What: /config/usb-gadget/gadget/functions/uvc.name/control/processing What: /config/usb-gadget/gadget/functions/uvc.name/control/processing
Date: Dec 2014 Date: Dec 2014
@ -88,13 +99,16 @@ KernelVersion: 4.0
Description: Default processing unit descriptors Description: Default processing unit descriptors
All attributes read only: All attributes read only:
iProcessing - index of string descriptor
bmControls - bitmap specifying which controls are =============== ========================================
iProcessing index of string descriptor
bmControls bitmap specifying which controls are
supported for the video stream supported for the video stream
wMaxMultiplier - maximum digital magnification x100 wMaxMultiplier maximum digital magnification x100
bSourceID - id of the terminal to which this unit is bSourceID id of the terminal to which this unit is
connected connected
bUnitID - a non-zero id of this unit bUnitID a non-zero id of this unit
=============== ========================================
What: /config/usb-gadget/gadget/functions/uvc.name/control/header What: /config/usb-gadget/gadget/functions/uvc.name/control/header
Date: Dec 2014 Date: Dec 2014
@ -114,8 +128,11 @@ KernelVersion: 4.0
Description: Streaming descriptors Description: Streaming descriptors
All attributes read only: All attributes read only:
bInterfaceNumber - USB interface number for this
streaming interface ================ =============================
bInterfaceNumber USB interface number for this
streaming interface
================ =============================
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class
Date: Dec 2014 Date: Dec 2014
@ -148,13 +165,16 @@ KernelVersion: 4.0
Description: Default color matching descriptors Description: Default color matching descriptors
All attributes read only: All attributes read only:
bMatrixCoefficients - matrix used to compute luma and
chroma values from the color primaries ======================== ======================================
bTransferCharacteristics- optoelectronic transfer bMatrixCoefficients matrix used to compute luma and
characteristic of the source picutre, chroma values from the color primaries
also called the gamma function bTransferCharacteristics optoelectronic transfer
bColorPrimaries - color primaries and the reference characteristic of the source picutre,
white also called the gamma function
bColorPrimaries color primaries and the reference
white
======================== ======================================
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
Date: Dec 2014 Date: Dec 2014
@ -168,47 +188,52 @@ Description: Specific MJPEG format descriptors
All attributes read only, All attributes read only,
except bmaControls and bDefaultFrameIndex: except bmaControls and bDefaultFrameIndex:
bFormatIndex - unique id for this format descriptor;
=================== =====================================
bFormatIndex unique id for this format descriptor;
only defined after parent header is only defined after parent header is
linked into the streaming class; linked into the streaming class;
read-only read-only
bmaControls - this format's data for bmaControls in bmaControls this format's data for bmaControls in
the streaming header the streaming header
bmInterfaceFlags - specifies interlace information, bmInterfaceFlags specifies interlace information,
read-only read-only
bAspectRatioY - the X dimension of the picture aspect bAspectRatioY the X dimension of the picture aspect
ratio, read-only ratio, read-only
bAspectRatioX - the Y dimension of the picture aspect bAspectRatioX the Y dimension of the picture aspect
ratio, read-only ratio, read-only
bmFlags - characteristics of this format, bmFlags characteristics of this format,
read-only read-only
bDefaultFrameIndex - optimum frame index for this stream bDefaultFrameIndex optimum frame index for this stream
=================== =====================================
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
Date: Dec 2014 Date: Dec 2014
KernelVersion: 4.0 KernelVersion: 4.0
Description: Specific MJPEG frame descriptors Description: Specific MJPEG frame descriptors
bFrameIndex - unique id for this framedescriptor; ========================= =====================================
only defined after parent format is bFrameIndex unique id for this framedescriptor;
linked into the streaming header; only defined after parent format is
read-only linked into the streaming header;
dwFrameInterval - indicates how frame interval can be read-only
programmed; a number of values dwFrameInterval indicates how frame interval can be
separated by newline can be specified programmed; a number of values
dwDefaultFrameInterval - the frame interval the device would separated by newline can be specified
like to use as default dwDefaultFrameInterval the frame interval the device would
dwMaxVideoFrameBufferSize- the maximum number of bytes the like to use as default
compressor will produce for a video dwMaxVideoFrameBufferSize the maximum number of bytes the
frame or still image compressor will produce for a video
dwMaxBitRate - the maximum bit rate at the shortest frame or still image
frame interval in bps dwMaxBitRate the maximum bit rate at the shortest
dwMinBitRate - the minimum bit rate at the longest frame interval in bps
frame interval in bps dwMinBitRate the minimum bit rate at the longest
wHeight - height of decoded bitmap frame in px frame interval in bps
wWidth - width of decoded bitmam frame in px wHeight height of decoded bitmap frame in px
bmCapabilities - still image support, fixed frame-rate wWidth width of decoded bitmam frame in px
support bmCapabilities still image support, fixed frame-rate
support
========================= =====================================
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
Date: Dec 2014 Date: Dec 2014
@ -220,50 +245,54 @@ Date: Dec 2014
KernelVersion: 4.0 KernelVersion: 4.0
Description: Specific uncompressed format descriptors Description: Specific uncompressed format descriptors
bFormatIndex - unique id for this format descriptor; ================== =======================================
bFormatIndex unique id for this format descriptor;
only defined after parent header is only defined after parent header is
linked into the streaming class; linked into the streaming class;
read-only read-only
bmaControls - this format's data for bmaControls in bmaControls this format's data for bmaControls in
the streaming header the streaming header
bmInterfaceFlags - specifies interlace information, bmInterfaceFlags specifies interlace information,
read-only read-only
bAspectRatioY - the X dimension of the picture aspect bAspectRatioY the X dimension of the picture aspect
ratio, read-only ratio, read-only
bAspectRatioX - the Y dimension of the picture aspect bAspectRatioX the Y dimension of the picture aspect
ratio, read-only ratio, read-only
bDefaultFrameIndex - optimum frame index for this stream bDefaultFrameIndex optimum frame index for this stream
bBitsPerPixel - number of bits per pixel used to bBitsPerPixel number of bits per pixel used to
specify color in the decoded video specify color in the decoded video
frame frame
guidFormat - globally unique id used to identify guidFormat globally unique id used to identify
stream-encoding format stream-encoding format
================== =======================================
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
Date: Dec 2014 Date: Dec 2014
KernelVersion: 4.0 KernelVersion: 4.0
Description: Specific uncompressed frame descriptors Description: Specific uncompressed frame descriptors
bFrameIndex - unique id for this framedescriptor; ========================= =====================================
only defined after parent format is bFrameIndex unique id for this framedescriptor;
linked into the streaming header; only defined after parent format is
read-only linked into the streaming header;
dwFrameInterval - indicates how frame interval can be read-only
programmed; a number of values dwFrameInterval indicates how frame interval can be
separated by newline can be specified programmed; a number of values
dwDefaultFrameInterval - the frame interval the device would separated by newline can be specified
like to use as default dwDefaultFrameInterval the frame interval the device would
dwMaxVideoFrameBufferSize- the maximum number of bytes the like to use as default
compressor will produce for a video dwMaxVideoFrameBufferSize the maximum number of bytes the
frame or still image compressor will produce for a video
dwMaxBitRate - the maximum bit rate at the shortest frame or still image
frame interval in bps dwMaxBitRate the maximum bit rate at the shortest
dwMinBitRate - the minimum bit rate at the longest frame interval in bps
frame interval in bps dwMinBitRate the minimum bit rate at the longest
wHeight - height of decoded bitmap frame in px frame interval in bps
wWidth - width of decoded bitmam frame in px wHeight height of decoded bitmap frame in px
bmCapabilities - still image support, fixed frame-rate wWidth width of decoded bitmam frame in px
support bmCapabilities still image support, fixed frame-rate
support
========================= =====================================
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header
Date: Dec 2014 Date: Dec 2014
@ -276,17 +305,20 @@ KernelVersion: 4.0
Description: Specific streaming header descriptors Description: Specific streaming header descriptors
All attributes read only: All attributes read only:
bTriggerUsage - how the host software will respond to
==================== =====================================
bTriggerUsage how the host software will respond to
a hardware trigger interrupt event a hardware trigger interrupt event
bTriggerSupport - flag specifying if hardware bTriggerSupport flag specifying if hardware
triggering is supported triggering is supported
bStillCaptureMethod - method of still image caputre bStillCaptureMethod method of still image caputre
supported supported
bTerminalLink - id of the output terminal to which bTerminalLink id of the output terminal to which
the video endpoint of this interface the video endpoint of this interface
is connected is connected
bmInfo - capabilities of this video streaming bmInfo capabilities of this video streaming
interface interface
==================== =====================================
What: /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name What: /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
Date: May 2018 Date: May 2018

View File

@ -6,7 +6,7 @@ Description:
General information like which GPE is assigned to the EC and whether General information like which GPE is assigned to the EC and whether
the global lock should get used. the global lock should get used.
Knowing the EC GPE one can watch the amount of HW events related to Knowing the EC GPE one can watch the amount of HW events related to
the EC here (XY -> GPE number from /sys/kernel/debug/ec/*/gpe): the EC here (XY -> GPE number from `/sys/kernel/debug/ec/*/gpe`):
/sys/firmware/acpi/interrupts/gpeXY /sys/firmware/acpi/interrupts/gpeXY
The io file is binary and a userspace tool located here: The io file is binary and a userspace tool located here:
@ -14,7 +14,8 @@ ftp://ftp.suse.com/pub/people/trenn/sources/ec/
should get used to read out the 256 Embedded Controller registers should get used to read out the 256 Embedded Controller registers
or writing to them. or writing to them.
CAUTION: Do not write to the Embedded Controller if you don't know CAUTION:
what you are doing! Rebooting afterwards also is a good idea. Do not write to the Embedded Controller if you don't know
This can influence the way your machine is cooled and fans may what you are doing! Rebooting afterwards also is a good idea.
not get switched on again after you did a wrong write. This can influence the way your machine is cooled and fans may
not get switched on again after you did a wrong write.

View File

@ -4,16 +4,15 @@ KernelVersion: 2.6.20
Contact: Thomas Maier <balagi@justmail.de> Contact: Thomas Maier <balagi@justmail.de>
Description: Description:
debugfs interface
-----------------
The pktcdvd module (packet writing driver) creates The pktcdvd module (packet writing driver) creates
these files in debugfs: these files in debugfs:
/sys/kernel/debug/pktcdvd/pktcdvd[0-7]/ /sys/kernel/debug/pktcdvd/pktcdvd[0-7]/
==== ====== ====================================
info (0444) Lots of driver statistics and infos. info (0444) Lots of driver statistics and infos.
==== ====== ====================================
Example: Example::
-------
cat /sys/kernel/debug/pktcdvd/pktcdvd0/info cat /sys/kernel/debug/pktcdvd/pktcdvd0/info

View File

@ -6,6 +6,7 @@ Description: The /dev/kmsg character device node provides userspace access
to the kernel's printk buffer. to the kernel's printk buffer.
Injecting messages: Injecting messages:
Every write() to the opened device node places a log entry in Every write() to the opened device node places a log entry in
the kernel's printk buffer. the kernel's printk buffer.
@ -21,6 +22,7 @@ Description: The /dev/kmsg character device node provides userspace access
the messages can always be reliably determined. the messages can always be reliably determined.
Accessing the buffer: Accessing the buffer:
Every read() from the opened device node receives one record Every read() from the opened device node receives one record
of the kernel's printk buffer. of the kernel's printk buffer.
@ -48,6 +50,7 @@ Description: The /dev/kmsg character device node provides userspace access
if needed, without limiting the interface to a single reader. if needed, without limiting the interface to a single reader.
The device supports seek with the following parameters: The device supports seek with the following parameters:
SEEK_SET, 0 SEEK_SET, 0
seek to the first entry in the buffer seek to the first entry in the buffer
SEEK_END, 0 SEEK_END, 0
@ -87,18 +90,22 @@ Description: The /dev/kmsg character device node provides userspace access
readable context of the message, for reliable processing in readable context of the message, for reliable processing in
userspace. userspace.
Example: Example::
7,160,424069,-;pci_root PNP0A03:00: host bridge window [io 0x0000-0x0cf7] (ignored)
SUBSYSTEM=acpi 7,160,424069,-;pci_root PNP0A03:00: host bridge window [io 0x0000-0x0cf7] (ignored)
DEVICE=+acpi:PNP0A03:00 SUBSYSTEM=acpi
6,339,5140900,-;NET: Registered protocol family 10 DEVICE=+acpi:PNP0A03:00
30,340,5690716,-;udevd[80]: starting version 181 6,339,5140900,-;NET: Registered protocol family 10
30,340,5690716,-;udevd[80]: starting version 181
The DEVICE= key uniquely identifies devices the following way: The DEVICE= key uniquely identifies devices the following way:
b12:8 - block dev_t
c127:3 - char dev_t ============ =================
n8 - netdev ifindex b12:8 block dev_t
+sound:card0 - subsystem:devname c127:3 char dev_t
n8 netdev ifindex
+sound:card0 subsystem:devname
============ =================
The flags field carries '-' by default. A 'c' indicates a The flags field carries '-' by default. A 'c' indicates a
fragment of a line. Note, that these hints about continuation fragment of a line. Note, that these hints about continuation

View File

@ -17,26 +17,33 @@ Description:
echoing a value to <securityfs>/evm made up of the echoing a value to <securityfs>/evm made up of the
following bits: following bits:
=== ==================================================
Bit Effect Bit Effect
=== ==================================================
0 Enable HMAC validation and creation 0 Enable HMAC validation and creation
1 Enable digital signature validation 1 Enable digital signature validation
2 Permit modification of EVM-protected metadata at 2 Permit modification of EVM-protected metadata at
runtime. Not supported if HMAC validation and runtime. Not supported if HMAC validation and
creation is enabled. creation is enabled.
31 Disable further runtime modification of EVM policy 31 Disable further runtime modification of EVM policy
=== ==================================================
For example: For example::
echo 1 ><securityfs>/evm echo 1 ><securityfs>/evm
will enable HMAC validation and creation will enable HMAC validation and creation
echo 0x80000003 ><securityfs>/evm ::
echo 0x80000003 ><securityfs>/evm
will enable HMAC and digital signature validation and will enable HMAC and digital signature validation and
HMAC creation and disable all further modification of policy. HMAC creation and disable all further modification of policy.
echo 0x80000006 ><securityfs>/evm ::
echo 0x80000006 ><securityfs>/evm
will enable digital signature validation, permit will enable digital signature validation, permit
modification of EVM-protected metadata and modification of EVM-protected metadata and
@ -65,7 +72,7 @@ Description:
Shows the set of extended attributes used to calculate or Shows the set of extended attributes used to calculate or
validate the EVM signature, and allows additional attributes validate the EVM signature, and allows additional attributes
to be added at runtime. Any signatures generated after to be added at runtime. Any signatures generated after
additional attributes are added (and on files posessing those additional attributes are added (and on files possessing those
additional attributes) will only be valid if the same additional attributes) will only be valid if the same
additional attributes are configured on system boot. Writing additional attributes are configured on system boot. Writing
a single period (.) will lock the xattr list from any further a single period (.) will lock the xattr list from any further

View File

@ -15,19 +15,22 @@ Description:
IMA appraisal, if configured, uses these file measurements IMA appraisal, if configured, uses these file measurements
for local measurement appraisal. for local measurement appraisal.
rule format: action [condition ...] ::
action: measure | dont_measure | appraise | dont_appraise | rule format: action [condition ...]
audit | hash | dont_hash
condition:= base | lsm [option] action: measure | dont_measure | appraise | dont_appraise |
audit | hash | dont_hash
condition:= base | lsm [option]
base: [[func=] [mask=] [fsmagic=] [fsuuid=] [uid=] base: [[func=] [mask=] [fsmagic=] [fsuuid=] [uid=]
[euid=] [fowner=] [fsname=]] [euid=] [fowner=] [fsname=]]
lsm: [[subj_user=] [subj_role=] [subj_type=] lsm: [[subj_user=] [subj_role=] [subj_type=]
[obj_user=] [obj_role=] [obj_type=]] [obj_user=] [obj_role=] [obj_type=]]
option: [[appraise_type=]] [template=] [permit_directio] option: [[appraise_type=]] [template=] [permit_directio]
[appraise_flag=] [keyrings=] [appraise_flag=] [keyrings=]
base: func:= [BPRM_CHECK][MMAP_CHECK][CREDS_CHECK][FILE_CHECK][MODULE_CHECK] base:
[FIRMWARE_CHECK] func:= [BPRM_CHECK][MMAP_CHECK][CREDS_CHECK][FILE_CHECK]MODULE_CHECK]
[FIRMWARE_CHECK]
[KEXEC_KERNEL_CHECK] [KEXEC_INITRAMFS_CHECK] [KEXEC_KERNEL_CHECK] [KEXEC_INITRAMFS_CHECK]
[KEXEC_CMDLINE] [KEY_CHECK] [KEXEC_CMDLINE] [KEY_CHECK]
mask:= [[^]MAY_READ] [[^]MAY_WRITE] [[^]MAY_APPEND] mask:= [[^]MAY_READ] [[^]MAY_WRITE] [[^]MAY_APPEND]
@ -37,8 +40,9 @@ Description:
uid:= decimal value uid:= decimal value
euid:= decimal value euid:= decimal value
fowner:= decimal value fowner:= decimal value
lsm: are LSM specific lsm: are LSM specific
option: appraise_type:= [imasig] [imasig|modsig] option:
appraise_type:= [imasig] [imasig|modsig]
appraise_flag:= [check_blacklist] appraise_flag:= [check_blacklist]
Currently, blacklist check is only for files signed with appended Currently, blacklist check is only for files signed with appended
signature. signature.
@ -49,7 +53,7 @@ Description:
(eg, ima-ng). Only valid when action is "measure". (eg, ima-ng). Only valid when action is "measure".
pcr:= decimal value pcr:= decimal value
default policy: default policy:
# PROC_SUPER_MAGIC # PROC_SUPER_MAGIC
dont_measure fsmagic=0x9fa0 dont_measure fsmagic=0x9fa0
dont_appraise fsmagic=0x9fa0 dont_appraise fsmagic=0x9fa0
@ -97,7 +101,8 @@ Description:
Examples of LSM specific definitions: Examples of LSM specific definitions:
SELinux: SELinux::
dont_measure obj_type=var_log_t dont_measure obj_type=var_log_t
dont_appraise obj_type=var_log_t dont_appraise obj_type=var_log_t
dont_measure obj_type=auditd_log_t dont_measure obj_type=auditd_log_t
@ -105,10 +110,11 @@ Description:
measure subj_user=system_u func=FILE_CHECK mask=MAY_READ measure subj_user=system_u func=FILE_CHECK mask=MAY_READ
measure subj_role=system_r func=FILE_CHECK mask=MAY_READ measure subj_role=system_r func=FILE_CHECK mask=MAY_READ
Smack: Smack::
measure subj_user=_ func=FILE_CHECK mask=MAY_READ measure subj_user=_ func=FILE_CHECK mask=MAY_READ
Example of measure rules using alternate PCRs: Example of measure rules using alternate PCRs::
measure func=KEXEC_KERNEL_CHECK pcr=4 measure func=KEXEC_KERNEL_CHECK pcr=4
measure func=KEXEC_INITRAMFS_CHECK pcr=5 measure func=KEXEC_INITRAMFS_CHECK pcr=5

View File

@ -6,28 +6,32 @@ Description:
of block devices. Each line contains the following 14 of block devices. Each line contains the following 14
fields: fields:
1 - major number == ===================================
2 - minor mumber 1 major number
3 - device name 2 minor mumber
4 - reads completed successfully 3 device name
5 - reads merged 4 reads completed successfully
6 - sectors read 5 reads merged
7 - time spent reading (ms) 6 sectors read
8 - writes completed 7 time spent reading (ms)
9 - writes merged 8 writes completed
10 - sectors written 9 writes merged
11 - time spent writing (ms) 10 sectors written
12 - I/Os currently in progress 11 time spent writing (ms)
13 - time spent doing I/Os (ms) 12 I/Os currently in progress
14 - weighted time spent doing I/Os (ms) 13 time spent doing I/Os (ms)
14 weighted time spent doing I/Os (ms)
== ===================================
Kernel 4.18+ appends four more fields for discard Kernel 4.18+ appends four more fields for discard
tracking putting the total at 18: tracking putting the total at 18:
15 - discards completed successfully == ===================================
16 - discards merged 15 discards completed successfully
17 - sectors discarded 16 discards merged
18 - time spent discarding 17 sectors discarded
18 time spent discarding
== ===================================
Kernel 5.5+ appends two more fields for flush requests: Kernel 5.5+ appends two more fields for flush requests:

View File

@ -4,23 +4,27 @@ Contact: Jerome Marchand <jmarchan@redhat.com>
Description: Description:
The /sys/block/<disk>/stat files displays the I/O The /sys/block/<disk>/stat files displays the I/O
statistics of disk <disk>. They contain 11 fields: statistics of disk <disk>. They contain 11 fields:
1 - reads completed successfully
2 - reads merged == ==============================================
3 - sectors read 1 reads completed successfully
4 - time spent reading (ms) 2 reads merged
5 - writes completed 3 sectors read
6 - writes merged 4 time spent reading (ms)
7 - sectors written 5 writes completed
8 - time spent writing (ms) 6 writes merged
9 - I/Os currently in progress 7 sectors written
10 - time spent doing I/Os (ms) 8 time spent writing (ms)
11 - weighted time spent doing I/Os (ms) 9 I/Os currently in progress
12 - discards completed 10 time spent doing I/Os (ms)
13 - discards merged 11 weighted time spent doing I/Os (ms)
14 - sectors discarded 12 discards completed
15 - time spent discarding (ms) 13 discards merged
16 - flush requests completed 14 sectors discarded
17 - time spent flushing (ms) 15 time spent discarding (ms)
16 flush requests completed
17 time spent flushing (ms)
== ==============================================
For more details refer Documentation/admin-guide/iostats.rst For more details refer Documentation/admin-guide/iostats.rst

View File

@ -8,11 +8,13 @@ Description:
It has the following valid values: It has the following valid values:
== ========================================================
0 OFF - the LED is not activated on activity 0 OFF - the LED is not activated on activity
1 BLINK_ON - the LED blinks on every 10ms when activity is 1 BLINK_ON - the LED blinks on every 10ms when activity is
detected. detected.
2 BLINK_OFF - the LED is on when idle, and blinks off 2 BLINK_OFF - the LED is on when idle, and blinks off
every 10ms when activity is detected. every 10ms when activity is detected.
== ========================================================
Note that the user must turn sw_activity OFF it they wish to Note that the user must turn sw_activity OFF it they wish to
control the activity LED via the em_message file. control the activity LED via the em_message file.

View File

@ -67,14 +67,16 @@ Description:
The return value is a decimal integer representing the device's The return value is a decimal integer representing the device's
status bitmap: status bitmap:
Bit [0] Set if the device is present. =========== ==================================================
Bit [1] Set if the device is enabled and decoding its Bit [0] Set if the device is present.
resources. Bit [1] Set if the device is enabled and decoding its
Bit [2] Set if the device should be shown in the UI. resources.
Bit [3] Set if the device is functioning properly (cleared if Bit [2] Set if the device should be shown in the UI.
device failed its diagnostics). Bit [3] Set if the device is functioning properly (cleared
Bit [4] Set if the battery is present. if device failed its diagnostics).
Bits [31:5] Reserved (must be cleared) Bit [4] Set if the battery is present.
Bits [31:5] Reserved (must be cleared)
=========== ==================================================
If bit [0] is clear, then bit 1 must also be clear (a device If bit [0] is clear, then bit 1 must also be clear (a device
that is not present cannot be enabled). that is not present cannot be enabled).

View File

@ -10,7 +10,8 @@ Description:
name/value pairs. name/value pairs.
Userspace must be prepared for the possibility that attributes Userspace must be prepared for the possibility that attributes
define overlapping bit ranges. For example: define overlapping bit ranges. For example::
attr1 = 'config:0-23' attr1 = 'config:0-23'
attr2 = 'config:0-7' attr2 = 'config:0-7'
attr3 = 'config:12-35' attr3 = 'config:12-35'

View File

@ -6,15 +6,18 @@ Description:
Value that exists only for mux devices that can be Value that exists only for mux devices that can be
written to control the behaviour of the multiplexer on written to control the behaviour of the multiplexer on
idle. Possible values: idle. Possible values:
-2 - disconnect on idle, i.e. deselect the last used
channel, which is useful when there is a device =========== ===============================================
with an address that conflicts with another -2 disconnect on idle, i.e. deselect the last used
device on another mux on the same parent bus. channel, which is useful when there is a device
-1 - leave the mux as-is, which is the most optimal with an address that conflicts with another
setting in terms of I2C operations and is the device on another mux on the same parent bus.
default mode. -1 leave the mux as-is, which is the most optimal
0..<nchans> - set the mux to a predetermined channel, setting in terms of I2C operations and is the
which is useful if there is one channel that is default mode.
used almost always, and you want to reduce the 0..<nchans> set the mux to a predetermined channel,
latency for normal operations after rare which is useful if there is one channel that is
transactions on other channels used almost always, and you want to reduce the
latency for normal operations after rare
transactions on other channels
=========== ===============================================

View File

@ -65,6 +65,7 @@ Contact: linux-iio@vger.kernel.org
Description: Description:
When the internal sampling clock can only take a specific set of When the internal sampling clock can only take a specific set of
frequencies, we can specify the available values with: frequencies, we can specify the available values with:
- a small discrete set of values like "0 2 4 6 8" - a small discrete set of values like "0 2 4 6 8"
- a range with minimum, step and maximum frequencies like - a range with minimum, step and maximum frequencies like
"[min step max]" "[min step max]"
@ -1627,17 +1628,21 @@ Description:
Mounting matrix for IIO sensors. This is a rotation matrix which Mounting matrix for IIO sensors. This is a rotation matrix which
informs userspace about sensor chip's placement relative to the informs userspace about sensor chip's placement relative to the
main hardware it is mounted on. main hardware it is mounted on.
Main hardware placement is defined according to the local Main hardware placement is defined according to the local
reference frame related to the physical quantity the sensor reference frame related to the physical quantity the sensor
measures. measures.
Given that the rotation matrix is defined in a board specific Given that the rotation matrix is defined in a board specific
way (platform data and / or device-tree), the main hardware way (platform data and / or device-tree), the main hardware
reference frame definition is left to the implementor's choice reference frame definition is left to the implementor's choice
(see below for a magnetometer example). (see below for a magnetometer example).
Applications should apply this rotation matrix to samples so Applications should apply this rotation matrix to samples so
that when main hardware reference frame is aligned onto local that when main hardware reference frame is aligned onto local
reference frame, then sensor chip reference frame is also reference frame, then sensor chip reference frame is also
perfectly aligned with it. perfectly aligned with it.
Matrix is a 3x3 unitary matrix and typically looks like Matrix is a 3x3 unitary matrix and typically looks like
[0, 1, 0; 1, 0, 0; 0, 0, -1]. Identity matrix [0, 1, 0; 1, 0, 0; 0, 0, -1]. Identity matrix
[1, 0, 0; 0, 1, 0; 0, 0, 1] means sensor chip and main hardware [1, 0, 0; 0, 1, 0; 0, 0, 1] means sensor chip and main hardware
@ -1646,8 +1651,10 @@ Description:
For example, a mounting matrix for a magnetometer sensor informs For example, a mounting matrix for a magnetometer sensor informs
userspace about sensor chip's ORIENTATION relative to the main userspace about sensor chip's ORIENTATION relative to the main
hardware. hardware.
More specifically, main hardware orientation is defined with More specifically, main hardware orientation is defined with
respect to the LOCAL EARTH GEOMAGNETIC REFERENCE FRAME where : respect to the LOCAL EARTH GEOMAGNETIC REFERENCE FRAME where :
* Y is in the ground plane and positive towards magnetic North ; * Y is in the ground plane and positive towards magnetic North ;
* X is in the ground plane, perpendicular to the North axis and * X is in the ground plane, perpendicular to the North axis and
positive towards the East ; positive towards the East ;
@ -1656,13 +1663,16 @@ Description:
An implementor might consider that for a hand-held device, a An implementor might consider that for a hand-held device, a
'natural' orientation would be 'front facing camera at the top'. 'natural' orientation would be 'front facing camera at the top'.
The main hardware reference frame could then be described as : The main hardware reference frame could then be described as :
* Y is in the plane of the screen and is positive towards the * Y is in the plane of the screen and is positive towards the
top of the screen ; top of the screen ;
* X is in the plane of the screen, perpendicular to Y axis, and * X is in the plane of the screen, perpendicular to Y axis, and
positive towards the right hand side of the screen ; positive towards the right hand side of the screen ;
* Z is perpendicular to the screen plane and positive out of the * Z is perpendicular to the screen plane and positive out of the
screen. screen.
Another example for a quadrotor UAV might be : Another example for a quadrotor UAV might be :
* Y is in the plane of the propellers and positive towards the * Y is in the plane of the propellers and positive towards the
front-view camera; front-view camera;
* X is in the plane of the propellers, perpendicular to Y axis, * X is in the plane of the propellers, perpendicular to Y axis,
@ -1704,6 +1714,7 @@ Description:
This interface is deprecated; please use the Counter subsystem. This interface is deprecated; please use the Counter subsystem.
A list of possible counting directions which are: A list of possible counting directions which are:
- "up" : counter device is increasing. - "up" : counter device is increasing.
- "down": counter device is decreasing. - "down": counter device is decreasing.

View File

@ -5,7 +5,8 @@ Contact: Peter Rosin <peda@axentia.se>
Description: Description:
The DAC is used to find the peak level of an alternating The DAC is used to find the peak level of an alternating
voltage input signal by a binary search using the output voltage input signal by a binary search using the output
of a comparator wired to an interrupt pin. Like so: of a comparator wired to an interrupt pin. Like so::
_ _
| \ | \
input +------>-------|+ \ input +------>-------|+ \
@ -19,10 +20,12 @@ Description:
| irq|------<-------' | irq|------<-------'
| | | |
'-------' '-------'
The boolean invert attribute (0/1) should be set when the The boolean invert attribute (0/1) should be set when the
input signal is centered around the maximum value of the input signal is centered around the maximum value of the
dac instead of zero. The envelope detector will search dac instead of zero. The envelope detector will search
from below in this case and will also invert the result. from below in this case and will also invert the result.
The edge/level of the interrupt is also switched to its The edge/level of the interrupt is also switched to its
opposite value. opposite value.

View File

@ -4,7 +4,7 @@ KernelVersion: 4.7
Contact: linux-iio@vger.kernel.org Contact: linux-iio@vger.kernel.org
Description: Description:
Writing '1' will perform a FOC (Fast Online Calibration). The Writing '1' will perform a FOC (Fast Online Calibration). The
corresponding calibration offsets can be read from *_calibbias corresponding calibration offsets can be read from `*_calibbias`
entries. entries.
What: /sys/bus/iio/devices/iio:deviceX/location What: /sys/bus/iio/devices/iio:deviceX/location

View File

@ -3,14 +3,20 @@ KernelVersion: 4.14
Contact: arnaud.pouliquen@st.com Contact: arnaud.pouliquen@st.com
Description: Description:
For audio purpose only. For audio purpose only.
Used by audio driver to set/get the spi input frequency. Used by audio driver to set/get the spi input frequency.
This is mandatory if DFSDM is slave on SPI bus, to This is mandatory if DFSDM is slave on SPI bus, to
provide information on the SPI clock frequency during runtime provide information on the SPI clock frequency during runtime
Notice that the SPI frequency should be a multiple of sample Notice that the SPI frequency should be a multiple of sample
frequency to ensure the precision. frequency to ensure the precision.
if DFSDM input is SPI master
if DFSDM input is SPI master:
Reading SPI clkout frequency, Reading SPI clkout frequency,
error on writing error on writing
If DFSDM input is SPI Slave: If DFSDM input is SPI Slave:
Reading returns value previously set. Reading returns value previously set.
Writing value before starting conversions. Writing value before starting conversions.

View File

@ -17,9 +17,11 @@ KernelVersion: 4.13
Contact: fabrice.gasnier@st.com Contact: fabrice.gasnier@st.com
Description: Description:
Configure the device counter quadrature modes: Configure the device counter quadrature modes:
- non-quadrature: - non-quadrature:
Encoder IN1 input servers as the count input (up Encoder IN1 input servers as the count input (up
direction). direction).
- quadrature: - quadrature:
Encoder IN1 and IN2 inputs are mixed to get direction Encoder IN1 and IN2 inputs are mixed to get direction
and count. and count.
@ -35,23 +37,26 @@ KernelVersion: 4.13
Contact: fabrice.gasnier@st.com Contact: fabrice.gasnier@st.com
Description: Description:
Configure the device encoder/counter active edge: Configure the device encoder/counter active edge:
- rising-edge - rising-edge
- falling-edge - falling-edge
- both-edges - both-edges
In non-quadrature mode, device counts up on active edge. In non-quadrature mode, device counts up on active edge.
In quadrature mode, encoder counting scenarios are as follows: In quadrature mode, encoder counting scenarios are as follows:
----------------------------------------------------------------
+---------+----------+--------------------+--------------------+
| Active | Level on | IN1 signal | IN2 signal | | Active | Level on | IN1 signal | IN2 signal |
| edge | opposite |------------------------------------------ | edge | opposite +----------+---------+----------+---------+
| | signal | Rising | Falling | Rising | Falling | | | signal | Rising | Falling | Rising | Falling |
---------------------------------------------------------------- +---------+----------+----------+---------+----------+---------+
| Rising | High -> | Down | - | Up | - | | Rising | High -> | Down | - | Up | - |
| edge | Low -> | Up | - | Down | - | | edge | Low -> | Up | - | Down | - |
---------------------------------------------------------------- +---------+----------+----------+---------+----------+---------+
| Falling | High -> | - | Up | - | Down | | Falling | High -> | - | Up | - | Down |
| edge | Low -> | - | Down | - | Up | | edge | Low -> | - | Down | - | Up |
---------------------------------------------------------------- +---------+----------+----------+---------+----------+---------+
| Both | High -> | Down | Up | Up | Down | | Both | High -> | Down | Up | Up | Down |
| edges | Low -> | Up | Down | Down | Up | | edges | Low -> | Up | Down | Down | Up |
---------------------------------------------------------------- +---------+----------+----------+---------+----------+---------+

View File

@ -5,11 +5,16 @@ Contact: linux-iio@vger.kernel.org
Description: Description:
Current configuration and available configurations Current configuration and available configurations
for the bias current. for the bias current.
normal - Normal measurement configurations (default)
positivebias - Positive bias configuration ============ ============================================
negativebias - Negative bias configuration normal Normal measurement configurations (default)
disabled - Only available on HMC5983. Disables magnetic positivebias Positive bias configuration
negativebias Negative bias configuration
disabled Only available on HMC5983. Disables magnetic
sensor and enables temperature sensor. sensor and enables temperature sensor.
Note: The effect of this configuration may vary ============ ============================================
according to the device. For exact documentation
check the device's datasheet. Note:
The effect of this configuration may vary
according to the device. For exact documentation
check the device's datasheet.

View File

@ -5,9 +5,12 @@ Description:
Open-circuit fault. The detection of open-circuit faults, Open-circuit fault. The detection of open-circuit faults,
such as those caused by broken thermocouple wires. such as those caused by broken thermocouple wires.
Reading returns either '1' or '0'. Reading returns either '1' or '0'.
'1' = An open circuit such as broken thermocouple wires
has been detected. === =======================================================
'0' = No open circuit or broken thermocouple wires are detected '1' An open circuit such as broken thermocouple wires
has been detected.
'0' No open circuit or broken thermocouple wires are detected
=== =======================================================
What: /sys/bus/iio/devices/iio:deviceX/fault_ovuv What: /sys/bus/iio/devices/iio:deviceX/fault_ovuv
KernelVersion: 5.1 KernelVersion: 5.1
@ -18,7 +21,11 @@ Description:
cables by integrated MOSFETs at the T+ and T- inputs, and the cables by integrated MOSFETs at the T+ and T- inputs, and the
BIAS output. These MOSFETs turn off when the input voltage is BIAS output. These MOSFETs turn off when the input voltage is
negative or greater than VDD. negative or greater than VDD.
Reading returns either '1' or '0'. Reading returns either '1' or '0'.
'1' = The input voltage is negative or greater than VDD.
'0' = The input voltage is positive and less than VDD (normal === =======================================================
state). '1' The input voltage is negative or greater than VDD.
'0' The input voltage is positive and less than VDD (normal
state).
=== =======================================================

View File

@ -3,67 +3,85 @@ KernelVersion: 4.11
Contact: benjamin.gaignard@st.com Contact: benjamin.gaignard@st.com
Description: Description:
Reading returns the list possible master modes which are: Reading returns the list possible master modes which are:
- "reset" : The UG bit from the TIMx_EGR register is
- "reset"
The UG bit from the TIMx_EGR register is
used as trigger output (TRGO). used as trigger output (TRGO).
- "enable" : The Counter Enable signal CNT_EN is used - "enable"
The Counter Enable signal CNT_EN is used
as trigger output. as trigger output.
- "update" : The update event is selected as trigger output. - "update"
The update event is selected as trigger output.
For instance a master timer can then be used For instance a master timer can then be used
as a prescaler for a slave timer. as a prescaler for a slave timer.
- "compare_pulse" : The trigger output send a positive pulse - "compare_pulse"
when the CC1IF flag is to be set. The trigger output send a positive pulse
- "OC1REF" : OC1REF signal is used as trigger output. when the CC1IF flag is to be set.
- "OC2REF" : OC2REF signal is used as trigger output. - "OC1REF"
- "OC3REF" : OC3REF signal is used as trigger output. OC1REF signal is used as trigger output.
- "OC4REF" : OC4REF signal is used as trigger output. - "OC2REF"
OC2REF signal is used as trigger output.
- "OC3REF"
OC3REF signal is used as trigger output.
- "OC4REF"
OC4REF signal is used as trigger output.
Additional modes (on TRGO2 only): Additional modes (on TRGO2 only):
- "OC5REF" : OC5REF signal is used as trigger output.
- "OC6REF" : OC6REF signal is used as trigger output. - "OC5REF"
OC5REF signal is used as trigger output.
- "OC6REF"
OC6REF signal is used as trigger output.
- "compare_pulse_OC4REF": - "compare_pulse_OC4REF":
OC4REF rising or falling edges generate pulses. OC4REF rising or falling edges generate pulses.
- "compare_pulse_OC6REF": - "compare_pulse_OC6REF":
OC6REF rising or falling edges generate pulses. OC6REF rising or falling edges generate pulses.
- "compare_pulse_OC4REF_r_or_OC6REF_r": - "compare_pulse_OC4REF_r_or_OC6REF_r":
OC4REF or OC6REF rising edges generate pulses. OC4REF or OC6REF rising edges generate pulses.
- "compare_pulse_OC4REF_r_or_OC6REF_f": - "compare_pulse_OC4REF_r_or_OC6REF_f":
OC4REF rising or OC6REF falling edges generate pulses. OC4REF rising or OC6REF falling edges generate
pulses.
- "compare_pulse_OC5REF_r_or_OC6REF_r": - "compare_pulse_OC5REF_r_or_OC6REF_r":
OC5REF or OC6REF rising edges generate pulses. OC5REF or OC6REF rising edges generate pulses.
- "compare_pulse_OC5REF_r_or_OC6REF_f": - "compare_pulse_OC5REF_r_or_OC6REF_f":
OC5REF rising or OC6REF falling edges generate pulses. OC5REF rising or OC6REF falling edges generate
pulses.
+-----------+ +-------------+ +---------+ ::
| Prescaler +-> | Counter | +-> | Master | TRGO(2)
+-----------+ +--+--------+-+ |-> | Control +-->
| | || +---------+
+--v--------+-+ OCxREF || +---------+
| Chx compare +----------> | Output | ChX
+-----------+-+ | | Control +-->
. | | +---------+
. | | .
+-----------v-+ OC6REF | .
| Ch6 compare +---------+>
+-------------+
Example with: "compare_pulse_OC4REF_r_or_OC6REF_r": +-----------+ +-------------+ +---------+
| Prescaler +-> | Counter | +-> | Master | TRGO(2)
+-----------+ +--+--------+-+ |-> | Control +-->
| | || +---------+
+--v--------+-+ OCxREF || +---------+
| Chx compare +----------> | Output | ChX
+-----------+-+ | | Control +-->
. | | +---------+
. | | .
+-----------v-+ OC6REF | .
| Ch6 compare +---------+>
+-------------+
X Example with: "compare_pulse_OC4REF_r_or_OC6REF_r"::
X X
X . . X X
X . . X X X
X . . X X . . X
count X . . . . X X . . X
. . . . X . . X
. . . . count X . . . . X
+---------------+ . . . .
OC4REF | . . | . . . .
+-+ . . +-+ +---------------+
. +---+ . OC4REF | . . |
OC6REF . | | . +-+ . . +-+
+-------+ +-------+ . +---+ .
+-+ +-+ OC6REF . | | .
TRGO2 | | | | +-------+ +-------+
+-+ +---+ +---------+ +-+ +-+
TRGO2 | | | |
+-+ +---+ +---------+
What: /sys/bus/iio/devices/triggerX/master_mode What: /sys/bus/iio/devices/triggerX/master_mode
KernelVersion: 4.11 KernelVersion: 4.11
@ -91,6 +109,30 @@ Description:
When counting down the counter start from preset value When counting down the counter start from preset value
and fire event when reach 0. and fire event when reach 0.
What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
KernelVersion: 4.12
Contact: benjamin.gaignard@st.com
Description:
Reading returns the list possible quadrature modes.
What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
KernelVersion: 4.12
Contact: benjamin.gaignard@st.com
Description:
Configure the device counter quadrature modes:
channel_A:
Encoder A input servers as the count input and B as
the UP/DOWN direction control input.
channel_B:
Encoder B input serves as the count input and A as
the UP/DOWN direction control input.
quadrature:
Encoder A and B inputs are mixed to get direction
and count with a scale of 0.25.
What: /sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available What: /sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available
KernelVersion: 4.12 KernelVersion: 4.12
Contact: benjamin.gaignard@st.com Contact: benjamin.gaignard@st.com
@ -104,6 +146,7 @@ Description:
Configure the device counter enable modes, in all case Configure the device counter enable modes, in all case
counting direction is set by in_count0_count_direction counting direction is set by in_count0_count_direction
attribute and the counter is clocked by the internal clock. attribute and the counter is clocked by the internal clock.
always: always:
Counter is always ON. Counter is always ON.

View File

@ -9,11 +9,13 @@ Date: June 2015
KernelVersion: 4.3 KernelVersion: 4.3
Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com> Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Description: (RW) Configure MSC operating mode: Description: (RW) Configure MSC operating mode:
- "single", for contiguous buffer mode (high-order alloc); - "single", for contiguous buffer mode (high-order alloc);
- "multi", for multiblock mode; - "multi", for multiblock mode;
- "ExI", for DCI handler mode; - "ExI", for DCI handler mode;
- "debug", for debug mode; - "debug", for debug mode;
- any of the currently loaded buffer sinks. - any of the currently loaded buffer sinks.
If operating mode changes, existing buffer is deallocated, If operating mode changes, existing buffer is deallocated,
provided there are no active users and tracing is not enabled, provided there are no active users and tracing is not enabled,
otherwise the write will fail. otherwise the write will fail.
@ -23,10 +25,12 @@ Date: June 2015
KernelVersion: 4.3 KernelVersion: 4.3
Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com> Contact: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Description: (RW) Configure MSC buffer size for "single" or "multi" modes. Description: (RW) Configure MSC buffer size for "single" or "multi" modes.
In single mode, this is a single number of pages, has to be In single mode, this is a single number of pages, has to be
power of 2. In multiblock mode, this is a comma-separated list power of 2. In multiblock mode, this is a comma-separated list
of numbers of pages for each window to be allocated. Number of of numbers of pages for each window to be allocated. Number of
windows is not limited. windows is not limited.
Writing to this file deallocates existing buffer (provided Writing to this file deallocates existing buffer (provided
there are no active users and tracing is not enabled) and then there are no active users and tracing is not enabled) and then
allocates a new one. allocates a new one.

View File

@ -1,4 +1,4 @@
For all of the nmem device attributes under nfit/*, see the 'NVDIMM Firmware For all of the nmem device attributes under ``nfit/*``, see the 'NVDIMM Firmware
Interface Table (NFIT)' section in the ACPI specification Interface Table (NFIT)' section in the ACPI specification
(http://www.uefi.org/specifications) for more details. (http://www.uefi.org/specifications) for more details.

View File

@ -1,6 +1,6 @@
==========================
PCIe Device AER statistics PCIe Device AER statistics
========================== --------------------------
These attributes show up under all the devices that are AER capable. These These attributes show up under all the devices that are AER capable. These
statistical counters indicate the errors "as seen/reported by the device". statistical counters indicate the errors "as seen/reported by the device".
Note that this may mean that if an endpoint is causing problems, the AER Note that this may mean that if an endpoint is causing problems, the AER
@ -17,19 +17,18 @@ Description: List of correctable errors seen and reported by this
PCI device using ERR_COR. Note that since multiple errors may PCI device using ERR_COR. Note that since multiple errors may
be reported using a single ERR_COR message, thus be reported using a single ERR_COR message, thus
TOTAL_ERR_COR at the end of the file may not match the actual TOTAL_ERR_COR at the end of the file may not match the actual
total of all the errors in the file. Sample output: total of all the errors in the file. Sample output::
-------------------------------------------------------------------------
localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable
Receiver Error 2 Receiver Error 2
Bad TLP 0 Bad TLP 0
Bad DLLP 0 Bad DLLP 0
RELAY_NUM Rollover 0 RELAY_NUM Rollover 0
Replay Timer Timeout 0 Replay Timer Timeout 0
Advisory Non-Fatal 0 Advisory Non-Fatal 0
Corrected Internal Error 0 Corrected Internal Error 0
Header Log Overflow 0 Header Log Overflow 0
TOTAL_ERR_COR 2 TOTAL_ERR_COR 2
-------------------------------------------------------------------------
What: /sys/bus/pci/devices/<dev>/aer_dev_fatal What: /sys/bus/pci/devices/<dev>/aer_dev_fatal
Date: July 2018 Date: July 2018
@ -39,28 +38,27 @@ Description: List of uncorrectable fatal errors seen and reported by this
PCI device using ERR_FATAL. Note that since multiple errors may PCI device using ERR_FATAL. Note that since multiple errors may
be reported using a single ERR_FATAL message, thus be reported using a single ERR_FATAL message, thus
TOTAL_ERR_FATAL at the end of the file may not match the actual TOTAL_ERR_FATAL at the end of the file may not match the actual
total of all the errors in the file. Sample output: total of all the errors in the file. Sample output::
-------------------------------------------------------------------------
localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal
Undefined 0 Undefined 0
Data Link Protocol 0 Data Link Protocol 0
Surprise Down Error 0 Surprise Down Error 0
Poisoned TLP 0 Poisoned TLP 0
Flow Control Protocol 0 Flow Control Protocol 0
Completion Timeout 0 Completion Timeout 0
Completer Abort 0 Completer Abort 0
Unexpected Completion 0 Unexpected Completion 0
Receiver Overflow 0 Receiver Overflow 0
Malformed TLP 0 Malformed TLP 0
ECRC 0 ECRC 0
Unsupported Request 0 Unsupported Request 0
ACS Violation 0 ACS Violation 0
Uncorrectable Internal Error 0 Uncorrectable Internal Error 0
MC Blocked TLP 0 MC Blocked TLP 0
AtomicOp Egress Blocked 0 AtomicOp Egress Blocked 0
TLP Prefix Blocked Error 0 TLP Prefix Blocked Error 0
TOTAL_ERR_FATAL 0 TOTAL_ERR_FATAL 0
-------------------------------------------------------------------------
What: /sys/bus/pci/devices/<dev>/aer_dev_nonfatal What: /sys/bus/pci/devices/<dev>/aer_dev_nonfatal
Date: July 2018 Date: July 2018
@ -70,32 +68,31 @@ Description: List of uncorrectable nonfatal errors seen and reported by this
PCI device using ERR_NONFATAL. Note that since multiple errors PCI device using ERR_NONFATAL. Note that since multiple errors
may be reported using a single ERR_FATAL message, thus may be reported using a single ERR_FATAL message, thus
TOTAL_ERR_NONFATAL at the end of the file may not match the TOTAL_ERR_NONFATAL at the end of the file may not match the
actual total of all the errors in the file. Sample output: actual total of all the errors in the file. Sample output::
-------------------------------------------------------------------------
localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal
Undefined 0 Undefined 0
Data Link Protocol 0 Data Link Protocol 0
Surprise Down Error 0 Surprise Down Error 0
Poisoned TLP 0 Poisoned TLP 0
Flow Control Protocol 0 Flow Control Protocol 0
Completion Timeout 0 Completion Timeout 0
Completer Abort 0 Completer Abort 0
Unexpected Completion 0 Unexpected Completion 0
Receiver Overflow 0 Receiver Overflow 0
Malformed TLP 0 Malformed TLP 0
ECRC 0 ECRC 0
Unsupported Request 0 Unsupported Request 0
ACS Violation 0 ACS Violation 0
Uncorrectable Internal Error 0 Uncorrectable Internal Error 0
MC Blocked TLP 0 MC Blocked TLP 0
AtomicOp Egress Blocked 0 AtomicOp Egress Blocked 0
TLP Prefix Blocked Error 0 TLP Prefix Blocked Error 0
TOTAL_ERR_NONFATAL 0 TOTAL_ERR_NONFATAL 0
-------------------------------------------------------------------------
============================
PCIe Rootport AER statistics PCIe Rootport AER statistics
============================ ----------------------------
These attributes show up under only the rootports (or root complex event These attributes show up under only the rootports (or root complex event
collectors) that are AER capable. These indicate the number of error messages as collectors) that are AER capable. These indicate the number of error messages as
"reported to" the rootport. Please note that the rootports also transmit "reported to" the rootport. Please note that the rootports also transmit

View File

@ -4,24 +4,27 @@ Description:
an individual subdirectory with the following name format of an individual subdirectory with the following name format of
device_name "nn:d:iiii", where: device_name "nn:d:iiii", where:
nn - two-digit hexadecimal ID of RapidIO network where the ==== ========================================================
nn two-digit hexadecimal ID of RapidIO network where the
device resides device resides
d - device type: 'e' - for endpoint or 's' - for switch d device type: 'e' - for endpoint or 's' - for switch
iiii - four-digit device destID for endpoints, or switchID for iiii four-digit device destID for endpoints, or switchID for
switches switches
==== ========================================================
For example, below is a list of device directories that For example, below is a list of device directories that
represents a typical RapidIO network with one switch, one host, represents a typical RapidIO network with one switch, one host,
and two agent endpoints, as it is seen by the enumerating host and two agent endpoints, as it is seen by the enumerating host
(with destID = 1): (with destID = 1)::
/sys/bus/rapidio/devices/00:e:0000 /sys/bus/rapidio/devices/00:e:0000
/sys/bus/rapidio/devices/00:e:0002 /sys/bus/rapidio/devices/00:e:0002
/sys/bus/rapidio/devices/00:s:0001 /sys/bus/rapidio/devices/00:s:0001
NOTE: An enumerating or discovering endpoint does not create a NOTE:
sysfs entry for itself, this is why an endpoint with destID=1 is An enumerating or discovering endpoint does not create a
not shown in the list. sysfs entry for itself, this is why an endpoint with destID=1
is not shown in the list.
Attributes Common for All RapidIO Devices Attributes Common for All RapidIO Devices
----------------------------------------- -----------------------------------------

View File

@ -37,16 +37,18 @@ Contact: thunderbolt-software@lists.01.org
Description: This attribute holds current Thunderbolt security level Description: This attribute holds current Thunderbolt security level
set by the system BIOS. Possible values are: set by the system BIOS. Possible values are:
none: All devices are automatically authorized ======= ==================================================
user: Devices are only authorized based on writing none All devices are automatically authorized
appropriate value to the authorized attribute user Devices are only authorized based on writing
secure: Require devices that support secure connect at appropriate value to the authorized attribute
minimum. User needs to authorize each device. secure Require devices that support secure connect at
dponly: Automatically tunnel Display port (and USB). No minimum. User needs to authorize each device.
PCIe tunnels are created. dponly Automatically tunnel Display port (and USB). No
usbonly: Automatically tunnel USB controller of the PCIe tunnels are created.
usbonly Automatically tunnel USB controller of the
connected Thunderbolt dock (and Display Port). All connected Thunderbolt dock (and Display Port). All
PCIe links downstream of the dock are removed. PCIe links downstream of the dock are removed.
======= ==================================================
What: /sys/bus/thunderbolt/devices/.../authorized What: /sys/bus/thunderbolt/devices/.../authorized
Date: Sep 2017 Date: Sep 2017
@ -61,17 +63,23 @@ Description: This attribute is used to authorize Thunderbolt devices
yet authorized. yet authorized.
Possible values are supported: Possible values are supported:
1: The device will be authorized and connected
== ===========================================
1 The device will be authorized and connected
== ===========================================
When key attribute contains 32 byte hex string the possible When key attribute contains 32 byte hex string the possible
values are: values are:
1: The 32 byte hex string is added to the device NVM and
the device is authorized. == ========================================================
2: Send a challenge based on the 32 byte hex string. If the 1 The 32 byte hex string is added to the device NVM and
challenge response from device is valid, the device is the device is authorized.
authorized. In case of failure errno will be ENOKEY if 2 Send a challenge based on the 32 byte hex string. If the
the device did not contain a key at all, and challenge response from device is valid, the device is
EKEYREJECTED if the challenge response did not match. authorized. In case of failure errno will be ENOKEY if
the device did not contain a key at all, and
EKEYREJECTED if the challenge response did not match.
== ========================================================
What: /sys/bus/thunderbolt/devices/.../boot What: /sys/bus/thunderbolt/devices/.../boot
Date: Jun 2018 Date: Jun 2018

View File

@ -72,24 +72,27 @@ Description:
table at compile time. The format for the device ID is: table at compile time. The format for the device ID is:
idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct
The vendor ID and device ID fields are required, the The vendor ID and device ID fields are required, the
rest is optional. The Ref* tuple can be used to tell the rest is optional. The `Ref*` tuple can be used to tell the
driver to use the same driver_data for the new device as driver to use the same driver_data for the new device as
it is used for the reference device. it is used for the reference device.
Upon successfully adding an ID, the driver will probe Upon successfully adding an ID, the driver will probe
for the device and attempt to bind to it. For example: for the device and attempt to bind to it. For example::
# echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
# echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
Here add a new device (0458:7045) using driver_data from Here add a new device (0458:7045) using driver_data from
an already supported device (0458:704c): an already supported device (0458:704c)::
# echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
# echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
Reading from this file will list all dynamically added Reading from this file will list all dynamically added
device IDs in the same format, with one entry per device IDs in the same format, with one entry per
line. For example: line. For example::
# cat /sys/bus/usb/drivers/foo/new_id
8086 10f5 # cat /sys/bus/usb/drivers/foo/new_id
dead beef 06 8086 10f5
f00d cafe dead beef 06
f00d cafe
The list will be truncated at PAGE_SIZE bytes due to The list will be truncated at PAGE_SIZE bytes due to
sysfs restrictions. sysfs restrictions.
@ -209,6 +212,7 @@ Description:
advance, and behaves well according to the specification. advance, and behaves well according to the specification.
This attribute is a bit-field that controls the behavior of This attribute is a bit-field that controls the behavior of
a specific port: a specific port:
- Bit 0 of this field selects the "old" enumeration scheme, - Bit 0 of this field selects the "old" enumeration scheme,
as it is considerably faster (it only causes one USB reset as it is considerably faster (it only causes one USB reset
instead of 2). instead of 2).
@ -233,10 +237,10 @@ Description:
poll() for monitoring changes to this value in user space. poll() for monitoring changes to this value in user space.
Any time this value changes the corresponding hub device will send a Any time this value changes the corresponding hub device will send a
udev event with the following attributes: udev event with the following attributes::
OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX
OVER_CURRENT_COUNT=[current value of this sysfs attribute] OVER_CURRENT_COUNT=[current value of this sysfs attribute]
What: /sys/bus/usb/devices/.../(hub interface)/portX/usb3_lpm_permit What: /sys/bus/usb/devices/.../(hub interface)/portX/usb3_lpm_permit
Date: November 2015 Date: November 2015

View File

@ -12,8 +12,11 @@ KernelVersion: 2.6.26
Contact: Harrison Metzger <harrisonmetz@gmail.com> Contact: Harrison Metzger <harrisonmetz@gmail.com>
Description: Controls the devices display mode. Description: Controls the devices display mode.
For a 6 character display the values are For a 6 character display the values are
MSB 0x06; LSB 0x3F, and MSB 0x06; LSB 0x3F, and
for an 8 character display the values are for an 8 character display the values are
MSB 0x08; LSB 0xFF. MSB 0x08; LSB 0xFF.
What: /sys/bus/usb/.../textmode What: /sys/bus/usb/.../textmode
@ -37,7 +40,7 @@ KernelVersion: 2.6.26
Contact: Harrison Metzger <harrisonmetz@gmail.com> Contact: Harrison Metzger <harrisonmetz@gmail.com>
Description: Controls the decimal places on the device. Description: Controls the decimal places on the device.
To set the nth decimal place, give this field To set the nth decimal place, give this field
the value of 10 ** n. Assume this field has the value of ``10 ** n``. Assume this field has
the value k and has 1 or more decimal places set, the value k and has 1 or more decimal places set,
to set the mth place (where m is not already set), to set the mth place (where m is not already set),
change this fields value to k + 10 ** m. change this fields value to ``k + 10 ** m``.

View File

@ -28,8 +28,9 @@ Description:
Writing UUID to this file will create mediated device of Writing UUID to this file will create mediated device of
type <type-id> for parent device <device>. This is a type <type-id> for parent device <device>. This is a
write-only file. write-only file.
For example: For example::
# echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
# echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
/sys/devices/foo/mdev_supported_types/foo-1/create /sys/devices/foo/mdev_supported_types/foo-1/create
What: /sys/.../mdev_supported_types/<type-id>/devices/ What: /sys/.../mdev_supported_types/<type-id>/devices/
@ -107,5 +108,6 @@ Description:
Writing '1' to this file destroys the mediated device. The Writing '1' to this file destroys the mediated device. The
vendor driver can fail the remove() callback if that device vendor driver can fail the remove() callback if that device
is active and the vendor driver doesn't support hot unplug. is active and the vendor driver doesn't support hot unplug.
Example: Example::
# echo 1 > /sys/bus/mdev/devices/<UUID>/remove
# echo 1 > /sys/bus/mdev/devices/<UUID>/remove

View File

@ -72,11 +72,16 @@ Description: read/write
when performing the START_WORK ioctl. Only applicable when when performing the START_WORK ioctl. Only applicable when
running under hashed page table mmu. running under hashed page table mmu.
Possible values: Possible values:
none: No prefaulting (default)
work_element_descriptor: Treat the work element ======================= ======================================
descriptor as an effective address and none No prefaulting (default)
prefault what it points to. work_element_descriptor Treat the work element
all: all segments process calling START_WORK maps. descriptor as an effective address and
prefault what it points to.
all all segments process calling
START_WORK maps.
======================= ======================================
Users: https://github.com/ibm-capi/libcxl Users: https://github.com/ibm-capi/libcxl
What: /sys/class/cxl/<afu>/reset What: /sys/class/cxl/<afu>/reset

View File

@ -50,7 +50,7 @@ Description:
You can change triggers in a similar manner to the way an IO You can change triggers in a similar manner to the way an IO
scheduler is chosen. Trigger specific parameters can appear in scheduler is chosen. Trigger specific parameters can appear in
/sys/class/leds/<led> once a given trigger is selected. For /sys/class/leds/<led> once a given trigger is selected. For
their documentation see sysfs-class-led-trigger-*. their documentation see `sysfs-class-led-trigger-*`.
What: /sys/class/leds/<led>/inverted What: /sys/class/leds/<led>/inverted
Date: January 2011 Date: January 2011

View File

@ -6,127 +6,132 @@ Description:
The LEDs board supports only predefined patterns by firmware The LEDs board supports only predefined patterns by firmware
for specific LEDs. for specific LEDs.
Breathing mode for Screen frame light tube: Breathing mode for Screen frame light tube::
"0 4000 1 4000"
^ "0 4000 1 4000"
|
Max-| ---
| / \
| / \
| / \ /
| / \ /
Min-|- ---
|
0------4------8--> time (sec)
Cascade mode for Pipe LED: ^
"1 800 2 800 4 800 8 800 16 800" |
Max-| ---
| / \
| / \
| / \ /
| / \ /
Min-|- ---
|
0------4------8--> time (sec)
^ Cascade mode for Pipe LED::
|
0 On -|----+ +----+ +---
| | | | |
Off-| +-------------------+ +-------------------+
|
1 On -| +----+ +----+
| | | | |
Off |----+ +-------------------+ +------------------
|
2 On -| +----+ +----+
| | | | |
Off-|---------+ +-------------------+ +-------------
|
3 On -| +----+ +----+
| | | | |
Off-|--------------+ +-------------------+ +--------
|
4 On -| +----+ +----+
| | | | |
Off-|-------------------+ +-------------------+ +---
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
Inverted cascade mode for Pipe LED: "1 800 2 800 4 800 8 800 16 800"
"30 800 29 800 27 800 23 800 15 800"
^ ^
| |
0 On -| +-------------------+ +-------------------+ 0 On -|----+ +----+ +---
| | | | | | | | | |
Off-|----+ +----+ +--- Off-| +-------------------+ +-------------------+
| |
1 On -|----+ +-------------------+ +------------------ 1 On -| +----+ +----+
| | | | | | | | | |
Off | +----+ +----+ Off |----+ +-------------------+ +------------------
| |
2 On -|---------+ +-------------------+ +------------- 2 On -| +----+ +----+
| | | | | | | | | |
Off-| +----+ +----+ Off-|---------+ +-------------------+ +-------------
| |
3 On -|--------------+ +-------------------+ +-------- 3 On -| +----+ +----+
| | | | | | | | | |
Off-| +----+ +----+ Off-|--------------+ +-------------------+ +--------
| |
4 On -|-------------------+ +-------------------+ +--- 4 On -| +----+ +----+
| | | | | | | | | |
Off-| +----+ +----+ Off-|-------------------+ +-------------------+ +---
| |
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
Bounce mode for Pipe LED: Inverted cascade mode for Pipe LED::
"1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
^ "30 800 29 800 27 800 23 800 15 800"
|
0 On -|----+ +--------
| | |
Off-| +---------------------------------------+
|
1 On -| +----+ +----+
| | | | |
Off |----+ +-----------------------------+ +--------
|
2 On -| +----+ +----+
| | | | |
Off-|---------+ +-------------------+ +-------------
|
3 On -| +----+ +----+
| | | | |
Off-|--------------+ +---------+ +------------------
|
4 On -| +---------+
| | |
Off-|-------------------+ +-----------------------
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
Inverted bounce mode for Pipe LED: ^
"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800" |
0 On -| +-------------------+ +-------------------+
| | | | |
Off-|----+ +----+ +---
|
1 On -|----+ +-------------------+ +------------------
| | | | |
Off | +----+ +----+
|
2 On -|---------+ +-------------------+ +-------------
| | | | |
Off-| +----+ +----+
|
3 On -|--------------+ +-------------------+ +--------
| | | | |
Off-| +----+ +----+
|
4 On -|-------------------+ +-------------------+ +---
| | | | |
Off-| +----+ +----+
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
^ Bounce mode for Pipe LED::
|
0 On -| +---------------------------------------+ "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
| | |
Off-|----+ +-------- ^
| |
1 On -|----+ +-----------------------------+ +-------- 0 On -|----+ +--------
| | | | | | | |
Off | +----+ +----+ Off-| +---------------------------------------+
| |
2 On -|---------+ +-------------------+ +------------- 1 On -| +----+ +----+
| | | | | | | | | |
Off-| +----+ +----+ Off |----+ +-----------------------------+ +--------
| |
3 On -|--------------+ +---------+ +------------------ 2 On -| +----+ +----+
| | | | | | | | | |
Off-| +----+ +----+ Off-|---------+ +-------------------+ +-------------
| |
4 On -|-------------------+ +----------------------- 3 On -| +----+ +----+
| | | | | | | |
Off-| +---------+ Off-|--------------+ +---------+ +------------------
| |
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec) 4 On -| +---------+
| | |
Off-|-------------------+ +-----------------------
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
Inverted bounce mode for Pipe LED::
"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
^
|
0 On -| +---------------------------------------+
| | |
Off-|----+ +--------
|
1 On -|----+ +-----------------------------+ +--------
| | | | |
Off | +----+ +----+
|
2 On -|---------+ +-------------------+ +-------------
| | | | |
Off-| +----+ +----+
|
3 On -|--------------+ +---------+ +------------------
| | | | |
Off-| +----+ +----+
|
4 On -|-------------------+ +-----------------------
| | |
Off-| +---------+
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
What: /sys/class/leds/<led>/repeat What: /sys/class/leds/<led>/repeat
Date: September 2019 Date: September 2019

View File

@ -12,8 +12,8 @@ Description:
format, we should set brightness as 0 for rise stage, fall format, we should set brightness as 0 for rise stage, fall
stage and low stage. stage and low stage.
Min stage duration: 125 ms - Min stage duration: 125 ms
Max stage duration: 31875 ms - Max stage duration: 31875 ms
Since the stage duration step is 125 ms, the duration should be Since the stage duration step is 125 ms, the duration should be
a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms. a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.

View File

@ -41,24 +41,33 @@ Description:
When read, this entry provides the current state of an Intel When read, this entry provides the current state of an Intel
MIC device in the context of the card OS. Possible values that MIC device in the context of the card OS. Possible values that
will be read are: will be read are:
"ready" - The MIC device is ready to boot the card OS. On
reading this entry after an OSPM resume, a "boot" has to be
written to this entry if the card was previously shutdown =============== ===============================================
during OSPM suspend. "ready" The MIC device is ready to boot the card OS.
"booting" - The MIC device has initiated booting a card OS. On reading this entry after an OSPM resume,
"online" - The MIC device has completed boot and is online a "boot" has to be written to this entry if
"shutting_down" - The card OS is shutting down. the card was previously shutdown during OSPM
"resetting" - A reset has been initiated for the MIC device suspend.
"reset_failed" - The MIC device has failed to reset. "booting" The MIC device has initiated booting a card OS.
"online" The MIC device has completed boot and is online
"shutting_down" The card OS is shutting down.
"resetting" A reset has been initiated for the MIC device
"reset_failed" The MIC device has failed to reset.
=============== ===============================================
When written, this sysfs entry triggers different state change When written, this sysfs entry triggers different state change
operations depending upon the current state of the card OS. operations depending upon the current state of the card OS.
Acceptable values are: Acceptable values are:
"boot" - Boot the card OS image specified by the combination
of firmware, ramdisk, cmdline and bootmode
sysfs entries. ========== ===================================================
"reset" - Initiates device reset. "boot" Boot the card OS image specified by the combination
"shutdown" - Initiates card OS shutdown. of firmware, ramdisk, cmdline and bootmode
sysfs entries.
"reset" Initiates device reset.
"shutdown" Initiates card OS shutdown.
========== ===================================================
What: /sys/class/mic/mic(x)/shutdown_status What: /sys/class/mic/mic(x)/shutdown_status
Date: October 2013 Date: October 2013
@ -69,12 +78,15 @@ Description:
OS can shutdown because of various reasons. When read, this OS can shutdown because of various reasons. When read, this
entry provides the status on why the card OS was shutdown. entry provides the status on why the card OS was shutdown.
Possible values are: Possible values are:
"nop" - shutdown status is not applicable, when the card OS is
"online" ========== ===================================================
"crashed" - Shutdown because of a HW or SW crash. "nop" shutdown status is not applicable, when the card OS
"halted" - Shutdown because of a halt command. is "online"
"poweroff" - Shutdown because of a poweroff command. "crashed" Shutdown because of a HW or SW crash.
"restart" - Shutdown because of a restart command. "halted" Shutdown because of a halt command.
"poweroff" Shutdown because of a poweroff command.
"restart" Shutdown because of a restart command.
========== ===================================================
What: /sys/class/mic/mic(x)/cmdline What: /sys/class/mic/mic(x)/cmdline
Date: October 2013 Date: October 2013

View File

@ -11,8 +11,11 @@ Contact: linuxppc-dev@lists.ozlabs.org
Description: read only Description: read only
Number of contexts for the AFU, in the format <n>/<max> Number of contexts for the AFU, in the format <n>/<max>
where: where:
==== ===============================================
n: number of currently active contexts, for debug n: number of currently active contexts, for debug
max: maximum number of contexts supported by the AFU max: maximum number of contexts supported by the AFU
==== ===============================================
What: /sys/class/ocxl/<afu name>/pp_mmio_size What: /sys/class/ocxl/<afu name>/pp_mmio_size
Date: January 2018 Date: January 2018

View File

@ -1,4 +1,4 @@
===== General Properties ===== **General Properties**
What: /sys/class/power_supply/<supply_name>/manufacturer What: /sys/class/power_supply/<supply_name>/manufacturer
Date: May 2007 Date: May 2007
@ -72,6 +72,7 @@ Description:
critically low). critically low).
Access: Read, Write Access: Read, Write
Valid values: 0 - 100 (percent) Valid values: 0 - 100 (percent)
What: /sys/class/power_supply/<supply_name>/capacity_error_margin What: /sys/class/power_supply/<supply_name>/capacity_error_margin
@ -96,7 +97,9 @@ Description:
Coarse representation of battery capacity. Coarse representation of battery capacity.
Access: Read Access: Read
Valid values: "Unknown", "Critical", "Low", "Normal", "High",
Valid values:
"Unknown", "Critical", "Low", "Normal", "High",
"Full" "Full"
What: /sys/class/power_supply/<supply_name>/current_avg What: /sys/class/power_supply/<supply_name>/current_avg
@ -139,6 +142,7 @@ Description:
throttling for thermal cooling or improving battery health. throttling for thermal cooling or improving battery health.
Access: Read, Write Access: Read, Write
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/charge_control_limit_max What: /sys/class/power_supply/<supply_name>/charge_control_limit_max
@ -148,6 +152,7 @@ Description:
Maximum legal value for the charge_control_limit property. Maximum legal value for the charge_control_limit property.
Access: Read Access: Read
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/charge_control_start_threshold What: /sys/class/power_supply/<supply_name>/charge_control_start_threshold
@ -168,6 +173,7 @@ Description:
stop. stop.
Access: Read, Write Access: Read, Write
Valid values: 0 - 100 (percent) Valid values: 0 - 100 (percent)
What: /sys/class/power_supply/<supply_name>/charge_type What: /sys/class/power_supply/<supply_name>/charge_type
@ -183,7 +189,9 @@ Description:
different algorithm. different algorithm.
Access: Read, Write Access: Read, Write
Valid values: "Unknown", "N/A", "Trickle", "Fast", "Standard",
Valid values:
"Unknown", "N/A", "Trickle", "Fast", "Standard",
"Adaptive", "Custom" "Adaptive", "Custom"
What: /sys/class/power_supply/<supply_name>/charge_term_current What: /sys/class/power_supply/<supply_name>/charge_term_current
@ -194,6 +202,7 @@ Description:
when the battery is considered full and charging should end. when the battery is considered full and charging should end.
Access: Read Access: Read
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/health What: /sys/class/power_supply/<supply_name>/health
@ -204,7 +213,9 @@ Description:
functionality. functionality.
Access: Read Access: Read
Valid values: "Unknown", "Good", "Overheat", "Dead",
Valid values:
"Unknown", "Good", "Overheat", "Dead",
"Over voltage", "Unspecified failure", "Cold", "Over voltage", "Unspecified failure", "Cold",
"Watchdog timer expire", "Safety timer expire", "Watchdog timer expire", "Safety timer expire",
"Over current", "Calibration required", "Warm", "Over current", "Calibration required", "Warm",
@ -218,6 +229,7 @@ Description:
for a battery charge cycle. for a battery charge cycle.
Access: Read Access: Read
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/present What: /sys/class/power_supply/<supply_name>/present
@ -227,9 +239,13 @@ Description:
Reports whether a battery is present or not in the system. Reports whether a battery is present or not in the system.
Access: Read Access: Read
Valid values: Valid values:
== =======
0: Absent 0: Absent
1: Present 1: Present
== =======
What: /sys/class/power_supply/<supply_name>/status What: /sys/class/power_supply/<supply_name>/status
Date: May 2007 Date: May 2007
@ -240,7 +256,9 @@ Description:
used to enable/disable charging to the battery. used to enable/disable charging to the battery.
Access: Read, Write Access: Read, Write
Valid values: "Unknown", "Charging", "Discharging",
Valid values:
"Unknown", "Charging", "Discharging",
"Not charging", "Full" "Not charging", "Full"
What: /sys/class/power_supply/<supply_name>/technology What: /sys/class/power_supply/<supply_name>/technology
@ -250,7 +268,9 @@ Description:
Describes the battery technology supported by the supply. Describes the battery technology supported by the supply.
Access: Read Access: Read
Valid values: "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
Valid values:
"Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
"NiCd", "LiMn" "NiCd", "LiMn"
What: /sys/class/power_supply/<supply_name>/temp What: /sys/class/power_supply/<supply_name>/temp
@ -260,6 +280,7 @@ Description:
Reports the current TBAT battery temperature reading. Reports the current TBAT battery temperature reading.
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_alert_max What: /sys/class/power_supply/<supply_name>/temp_alert_max
@ -274,6 +295,7 @@ Description:
critically high, and charging has stopped). critically high, and charging has stopped).
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_alert_min What: /sys/class/power_supply/<supply_name>/temp_alert_min
@ -289,6 +311,7 @@ Description:
remedy the situation). remedy the situation).
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_max What: /sys/class/power_supply/<supply_name>/temp_max
@ -299,6 +322,7 @@ Description:
charging. charging.
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_min What: /sys/class/power_supply/<supply_name>/temp_min
@ -309,6 +333,7 @@ Description:
charging. charging.
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/voltage_avg, What: /sys/class/power_supply/<supply_name>/voltage_avg,
@ -320,6 +345,7 @@ Description:
which they average readings to smooth out the reported value. which they average readings to smooth out the reported value.
Access: Read Access: Read
Valid values: Represented in microvolts Valid values: Represented in microvolts
What: /sys/class/power_supply/<supply_name>/voltage_max, What: /sys/class/power_supply/<supply_name>/voltage_max,
@ -330,6 +356,7 @@ Description:
during charging. during charging.
Access: Read Access: Read
Valid values: Represented in microvolts Valid values: Represented in microvolts
What: /sys/class/power_supply/<supply_name>/voltage_min, What: /sys/class/power_supply/<supply_name>/voltage_min,
@ -340,6 +367,7 @@ Description:
during discharging. during discharging.
Access: Read Access: Read
Valid values: Represented in microvolts Valid values: Represented in microvolts
What: /sys/class/power_supply/<supply_name>/voltage_now, What: /sys/class/power_supply/<supply_name>/voltage_now,
@ -350,9 +378,10 @@ Description:
This value is not averaged/smoothed. This value is not averaged/smoothed.
Access: Read Access: Read
Valid values: Represented in microvolts Valid values: Represented in microvolts
===== USB Properties ===== **USB Properties**
What: /sys/class/power_supply/<supply_name>/current_avg What: /sys/class/power_supply/<supply_name>/current_avg
Date: May 2007 Date: May 2007
@ -363,6 +392,7 @@ Description:
average readings to smooth out the reported value. average readings to smooth out the reported value.
Access: Read Access: Read
Valid values: Represented in microamps Valid values: Represented in microamps
@ -373,6 +403,7 @@ Description:
Reports the maximum IBUS current the supply can support. Reports the maximum IBUS current the supply can support.
Access: Read Access: Read
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/current_now What: /sys/class/power_supply/<supply_name>/current_now
@ -385,6 +416,7 @@ Description:
within the reported min/max range. within the reported min/max range.
Access: Read, Write Access: Read, Write
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/input_current_limit What: /sys/class/power_supply/<supply_name>/input_current_limit
@ -399,6 +431,7 @@ Description:
solved using power limit use input_current_limit. solved using power limit use input_current_limit.
Access: Read, Write Access: Read, Write
Valid values: Represented in microamps Valid values: Represented in microamps
What: /sys/class/power_supply/<supply_name>/input_voltage_limit What: /sys/class/power_supply/<supply_name>/input_voltage_limit
@ -441,10 +474,14 @@ Description:
USB supply so voltage and current can be controlled). USB supply so voltage and current can be controlled).
Access: Read, Write Access: Read, Write
Valid values: Valid values:
== ==================================================
0: Offline 0: Offline
1: Online Fixed - Fixed Voltage Supply 1: Online Fixed - Fixed Voltage Supply
2: Online Programmable - Programmable Voltage Supply 2: Online Programmable - Programmable Voltage Supply
== ==================================================
What: /sys/class/power_supply/<supply_name>/temp What: /sys/class/power_supply/<supply_name>/temp
Date: May 2007 Date: May 2007
@ -455,6 +492,7 @@ Description:
TJUNC temperature of an IC) TJUNC temperature of an IC)
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_alert_max What: /sys/class/power_supply/<supply_name>/temp_alert_max
@ -470,6 +508,7 @@ Description:
remedy the situation). remedy the situation).
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_alert_min What: /sys/class/power_supply/<supply_name>/temp_alert_min
@ -485,6 +524,7 @@ Description:
accordingly to remedy the situation). accordingly to remedy the situation).
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_max What: /sys/class/power_supply/<supply_name>/temp_max
@ -494,6 +534,7 @@ Description:
Reports the maximum allowed supply temperature for operation. Reports the maximum allowed supply temperature for operation.
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/temp_min What: /sys/class/power_supply/<supply_name>/temp_min
@ -503,6 +544,7 @@ Description:
Reports the mainimum allowed supply temperature for operation. Reports the mainimum allowed supply temperature for operation.
Access: Read Access: Read
Valid values: Represented in 1/10 Degrees Celsius Valid values: Represented in 1/10 Degrees Celsius
What: /sys/class/power_supply/<supply_name>/usb_type What: /sys/class/power_supply/<supply_name>/usb_type
@ -514,7 +556,9 @@ Description:
is attached. is attached.
Access: Read-Only Access: Read-Only
Valid values: "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
Valid values:
"Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
"PD_DRP", "PD_PPS", "BrickID" "PD_DRP", "PD_PPS", "BrickID"
What: /sys/class/power_supply/<supply_name>/voltage_max What: /sys/class/power_supply/<supply_name>/voltage_max
@ -524,6 +568,7 @@ Description:
Reports the maximum VBUS voltage the supply can support. Reports the maximum VBUS voltage the supply can support.
Access: Read Access: Read
Valid values: Represented in microvolts Valid values: Represented in microvolts
What: /sys/class/power_supply/<supply_name>/voltage_min What: /sys/class/power_supply/<supply_name>/voltage_min
@ -533,6 +578,7 @@ Description:
Reports the minimum VBUS voltage the supply can support. Reports the minimum VBUS voltage the supply can support.
Access: Read Access: Read
Valid values: Represented in microvolts Valid values: Represented in microvolts
What: /sys/class/power_supply/<supply_name>/voltage_now What: /sys/class/power_supply/<supply_name>/voltage_now
@ -545,9 +591,10 @@ Description:
within the reported min/max range. within the reported min/max range.
Access: Read, Write Access: Read, Write
Valid values: Represented in microvolts Valid values: Represented in microvolts
===== Device Specific Properties ===== **Device Specific Properties**
What: /sys/class/power/ds2760-battery.*/charge_now What: /sys/class/power/ds2760-battery.*/charge_now
Date: May 2010 Date: May 2010
@ -581,6 +628,7 @@ Description:
will drop to 0 A) and will trigger interrupt. will drop to 0 A) and will trigger interrupt.
Valid values: Valid values:
- 5, 6 or 7 (hours), - 5, 6 or 7 (hours),
- 0: disabled. - 0: disabled.
@ -595,6 +643,7 @@ Description:
will drop to 0 A) and will trigger interrupt. will drop to 0 A) and will trigger interrupt.
Valid values: Valid values:
- 4 - 16 (hours), step by 2 (rounded down) - 4 - 16 (hours), step by 2 (rounded down)
- 0: disabled. - 0: disabled.
@ -609,6 +658,7 @@ Description:
interrupt and start top-off charging mode. interrupt and start top-off charging mode.
Valid values: Valid values:
- 100000 - 200000 (microamps), step by 25000 (rounded down) - 100000 - 200000 (microamps), step by 25000 (rounded down)
- 200000 - 350000 (microamps), step by 50000 (rounded down) - 200000 - 350000 (microamps), step by 50000 (rounded down)
- 0: disabled. - 0: disabled.
@ -624,6 +674,7 @@ Description:
will drop to 0 A) and will trigger interrupt. will drop to 0 A) and will trigger interrupt.
Valid values: Valid values:
- 0 - 70 (minutes), step by 10 (rounded down) - 0 - 70 (minutes), step by 10 (rounded down)
What: /sys/class/power_supply/bq24257-charger/ovp_voltage What: /sys/class/power_supply/bq24257-charger/ovp_voltage
@ -637,6 +688,7 @@ Description:
device datasheet for details. device datasheet for details.
Valid values: Valid values:
- 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000, - 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000,
10500000 (all uV) 10500000 (all uV)
@ -652,6 +704,7 @@ Description:
lower than the set value. See device datasheet for details. lower than the set value. See device datasheet for details.
Valid values: Valid values:
- 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000, - 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000,
4760000 (all uV) 4760000 (all uV)
@ -666,6 +719,7 @@ Description:
the charger operates normally. See device datasheet for details. the charger operates normally. See device datasheet for details.
Valid values: Valid values:
- 1: enabled - 1: enabled
- 0: disabled - 0: disabled
@ -681,6 +735,7 @@ Description:
from the system. See device datasheet for details. from the system. See device datasheet for details.
Valid values: Valid values:
- 1: enabled - 1: enabled
- 0: disabled - 0: disabled

View File

@ -4,18 +4,20 @@ Description:
Writing to this can disable charging. Writing to this can disable charging.
Possible values are: Possible values are:
"auto" - draw power as appropriate for detected
power source and battery status.
"off" - do not draw any power.
"continuous"
- activate mode described as "linear" in
TWL data sheets. This uses whatever
current is available and doesn't switch off
when voltage drops.
This is useful for unstable power sources ============= ===========================================
such as bicycle dynamo, but care should "auto" draw power as appropriate for detected
be taken that battery is not over-charged. power source and battery status.
"off" do not draw any power.
"continuous" activate mode described as "linear" in
TWL data sheets. This uses whatever
current is available and doesn't switch off
when voltage drops.
This is useful for unstable power sources
such as bicycle dynamo, but care should
be taken that battery is not over-charged.
============= ===========================================
What: /sys/class/power_supply/twl4030_ac/mode What: /sys/class/power_supply/twl4030_ac/mode
Description: Description:
@ -23,6 +25,9 @@ Description:
Writing to this can disable charging. Writing to this can disable charging.
Possible values are: Possible values are:
"auto" - draw power as appropriate for detected
power source and battery status. ====== ===========================================
"off" - do not draw any power. "auto" draw power as appropriate for detected
power source and battery status.
"off" do not draw any power.
====== ===========================================

View File

@ -21,15 +21,22 @@ KernelVersion: 2.6.36
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Description: Description:
Reading this file returns a list of available protocols, Reading this file returns a list of available protocols,
something like: something like::
"rc5 [rc6] nec jvc [sony]" "rc5 [rc6] nec jvc [sony]"
Enabled protocols are shown in [] brackets. Enabled protocols are shown in [] brackets.
Writing "+proto" will add a protocol to the list of enabled Writing "+proto" will add a protocol to the list of enabled
protocols. protocols.
Writing "-proto" will remove a protocol from the list of enabled Writing "-proto" will remove a protocol from the list of enabled
protocols. protocols.
Writing "proto" will enable only "proto". Writing "proto" will enable only "proto".
Writing "none" will disable all protocols. Writing "none" will disable all protocols.
Write fails with EINVAL if an invalid protocol combination or Write fails with EINVAL if an invalid protocol combination or
unknown protocol name is used. unknown protocol name is used.
@ -39,11 +46,13 @@ KernelVersion: 3.15
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Description: Description:
Sets the scancode filter expected value. Sets the scancode filter expected value.
Use in combination with /sys/class/rc/rcN/filter_mask to set the Use in combination with /sys/class/rc/rcN/filter_mask to set the
expected value of the bits set in the filter mask. expected value of the bits set in the filter mask.
If the hardware supports it then scancodes which do not match If the hardware supports it then scancodes which do not match
the filter will be ignored. Otherwise the write will fail with the filter will be ignored. Otherwise the write will fail with
an error. an error.
This value may be reset to 0 if the current protocol is altered. This value may be reset to 0 if the current protocol is altered.
What: /sys/class/rc/rcN/filter_mask What: /sys/class/rc/rcN/filter_mask
@ -56,9 +65,11 @@ Description:
of the scancode which should be compared against the expected of the scancode which should be compared against the expected
value. A value of 0 disables the filter to allow all valid value. A value of 0 disables the filter to allow all valid
scancodes to be processed. scancodes to be processed.
If the hardware supports it then scancodes which do not match If the hardware supports it then scancodes which do not match
the filter will be ignored. Otherwise the write will fail with the filter will be ignored. Otherwise the write will fail with
an error. an error.
This value may be reset to 0 if the current protocol is altered. This value may be reset to 0 if the current protocol is altered.
What: /sys/class/rc/rcN/wakeup_protocols What: /sys/class/rc/rcN/wakeup_protocols
@ -67,15 +78,22 @@ KernelVersion: 4.11
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Description: Description:
Reading this file returns a list of available protocols to use Reading this file returns a list of available protocols to use
for the wakeup filter, something like: for the wakeup filter, something like::
"rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce" "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
Note that protocol variants are listed, so "nec", "sony", Note that protocol variants are listed, so "nec", "sony",
"rc-5", "rc-6" have their different bit length encodings "rc-5", "rc-6" have their different bit length encodings
listed if available. listed if available.
The enabled wakeup protocol is shown in [] brackets. The enabled wakeup protocol is shown in [] brackets.
Only one protocol can be selected at a time. Only one protocol can be selected at a time.
Writing "proto" will use "proto" for wakeup events. Writing "proto" will use "proto" for wakeup events.
Writing "none" will disable wakeup. Writing "none" will disable wakeup.
Write fails with EINVAL if an invalid protocol combination or Write fails with EINVAL if an invalid protocol combination or
unknown protocol name is used, or if wakeup is not supported by unknown protocol name is used, or if wakeup is not supported by
the hardware. the hardware.
@ -86,13 +104,17 @@ KernelVersion: 3.15
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Description: Description:
Sets the scancode wakeup filter expected value. Sets the scancode wakeup filter expected value.
Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
set the expected value of the bits set in the wakeup filter mask set the expected value of the bits set in the wakeup filter mask
to trigger a system wake event. to trigger a system wake event.
If the hardware supports it and wakeup_filter_mask is not 0 then If the hardware supports it and wakeup_filter_mask is not 0 then
scancodes which match the filter will wake the system from e.g. scancodes which match the filter will wake the system from e.g.
suspend to RAM or power off. suspend to RAM or power off.
Otherwise the write will fail with an error. Otherwise the write will fail with an error.
This value may be reset to 0 if the wakeup protocol is altered. This value may be reset to 0 if the wakeup protocol is altered.
What: /sys/class/rc/rcN/wakeup_filter_mask What: /sys/class/rc/rcN/wakeup_filter_mask
@ -101,11 +123,15 @@ KernelVersion: 3.15
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Description: Description:
Sets the scancode wakeup filter mask of bits to compare. Sets the scancode wakeup filter mask of bits to compare.
Use in combination with /sys/class/rc/rcN/wakeup_filter to set Use in combination with /sys/class/rc/rcN/wakeup_filter to set
the bits of the scancode which should be compared against the the bits of the scancode which should be compared against the
expected value to trigger a system wake event. expected value to trigger a system wake event.
If the hardware supports it and wakeup_filter_mask is not 0 then If the hardware supports it and wakeup_filter_mask is not 0 then
scancodes which match the filter will wake the system from e.g. scancodes which match the filter will wake the system from e.g.
suspend to RAM or power off. suspend to RAM or power off.
Otherwise the write will fail with an error. Otherwise the write will fail with an error.
This value may be reset to 0 if the wakeup protocol is altered. This value may be reset to 0 if the wakeup protocol is altered.

View File

@ -56,8 +56,9 @@ Description:
management) on top, which makes it match the Windows IRST (Intel management) on top, which makes it match the Windows IRST (Intel
Rapid Storage Technology) driver settings. This setting is also Rapid Storage Technology) driver settings. This setting is also
close to min_power, except that: close to min_power, except that:
a) It does not use host-initiated slumber mode, but it does a) It does not use host-initiated slumber mode, but it does
allow device-initiated slumber allow device-initiated slumber
b) It does not enable low power device sleep mode (DevSlp). b) It does not enable low power device sleep mode (DevSlp).
What: /sys/class/scsi_host/hostX/em_message What: /sys/class/scsi_host/hostX/em_message
@ -70,8 +71,8 @@ Description:
protocol, writes and reads correspond to the LED message format protocol, writes and reads correspond to the LED message format
as defined in the AHCI spec. as defined in the AHCI spec.
The user must turn sw_activity (under /sys/block/*/device/) OFF The user must turn sw_activity (under `/sys/block/*/device/`)
it they wish to control the activity LED via the em_message OFF it they wish to control the activity LED via the em_message
file. file.
em_message_type: (RO) Displays the current enclosure management em_message_type: (RO) Displays the current enclosure management

View File

@ -40,10 +40,13 @@ Description:
attribute will not return until the operation has finished. attribute will not return until the operation has finished.
Valid values: Valid values:
- source (The port will behave as source only DFP port)
- sink (The port will behave as sink only UFP port) ====== ==============================================
- dual (The port will behave as dual-role-data and source (The port will behave as source only DFP port)
sink (The port will behave as sink only UFP port)
dual (The port will behave as dual-role-data and
dual-role-power port) dual-role-power port)
====== ==============================================
What: /sys/class/typec/<port>/vconn_source What: /sys/class/typec/<port>/vconn_source
Date: April 2017 Date: April 2017
@ -59,6 +62,7 @@ Description:
generates uevent KOBJ_CHANGE. generates uevent KOBJ_CHANGE.
Valid values: Valid values:
- "no" when the port is not the VCONN Source - "no" when the port is not the VCONN Source
- "yes" when the port is the VCONN Source - "yes" when the port is the VCONN Source
@ -72,6 +76,7 @@ Description:
power operation mode should show "usb_power_delivery". power operation mode should show "usb_power_delivery".
Valid values: Valid values:
- default - default
- 1.5A - 1.5A
- 3.0A - 3.0A
@ -191,6 +196,7 @@ Date: April 2017
Contact: Heikki Krogerus <heikki.krogerus@linux.intel.com> Contact: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Description: Description:
Shows type of the plug on the cable: Shows type of the plug on the cable:
- type-a - Standard A - type-a - Standard A
- type-b - Standard B - type-b - Standard B
- type-c - type-c

View File

@ -7,6 +7,7 @@ Description:
(RO) Hexadecimal bitmask of the TAD attributes are reported by (RO) Hexadecimal bitmask of the TAD attributes are reported by
the platform firmware (see ACPI 6.2, section 9.18.2): the platform firmware (see ACPI 6.2, section 9.18.2):
======= ======================================================
BIT(0): AC wakeup implemented if set BIT(0): AC wakeup implemented if set
BIT(1): DC wakeup implemented if set BIT(1): DC wakeup implemented if set
BIT(2): Get/set real time features implemented if set BIT(2): Get/set real time features implemented if set
@ -16,6 +17,7 @@ Description:
BIT(6): The AC timer wakes up from S5 if set BIT(6): The AC timer wakes up from S5 if set
BIT(7): The DC timer wakes up from S4 if set BIT(7): The DC timer wakes up from S4 if set
BIT(8): The DC timer wakes up from S5 if set BIT(8): The DC timer wakes up from S5 if set
======= ======================================================
The other bits are reserved. The other bits are reserved.
@ -62,9 +64,11 @@ Description:
timer status with the following meaning of bits (see ACPI 6.2, timer status with the following meaning of bits (see ACPI 6.2,
Section 9.18.5): Section 9.18.5):
======= ======================================================
Bit(0): The timer has expired if set. Bit(0): The timer has expired if set.
Bit(1): The timer has woken up the system from a sleep state Bit(1): The timer has woken up the system from a sleep state
(S3 or S4/S5 if supported) if set. (S3 or S4/S5 if supported) if set.
======= ======================================================
The other bits are reserved. The other bits are reserved.

View File

@ -9,8 +9,10 @@ Description:
The protection has information embedded whether it blocks reads, The protection has information embedded whether it blocks reads,
writes or both. writes or both.
The result is: The result is:
0 -> the DPS is not keylocked
1 -> the DPS is keylocked - 0 -> the DPS is not keylocked
- 1 -> the DPS is keylocked
Users: None identified so far. Users: None identified so far.
What: /sys/devices/platform/docg3/f[0-3]_dps[01]_protection_key What: /sys/devices/platform/docg3/f[0-3]_dps[01]_protection_key
@ -27,8 +29,12 @@ Description:
Entering the correct value toggle the lock, and can be observed Entering the correct value toggle the lock, and can be observed
through f[0-3]_dps[01]_is_keylocked. through f[0-3]_dps[01]_is_keylocked.
Possible values are: Possible values are:
- 8 bytes - 8 bytes
Typical values are: Typical values are:
- "00000000" - "00000000"
- "12345678" - "12345678"
Users: None identified so far. Users: None identified so far.

View File

@ -17,10 +17,10 @@ Description:
to overlay planes. to overlay planes.
Selects the composition mode for the overlay. Possible values Selects the composition mode for the overlay. Possible values
are are:
0 - Alpha Blending - 0 - Alpha Blending
1 - ROP3 - 1 - ROP3
What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_position What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_position
Date: May 2012 Date: May 2012
@ -30,7 +30,7 @@ Description:
to overlay planes. to overlay planes.
Stores the x,y overlay position on the display in pixels. The Stores the x,y overlay position on the display in pixels. The
position format is `[0-9]+,[0-9]+'. position format is `[0-9]+,[0-9]+`.
What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_rop3 What: /sys/devices/platform/sh_mobile_lcdc_fb.[0-3]/graphics/fb[0-9]/ovl_rop3
Date: May 2012 Date: May 2012

View File

@ -151,23 +151,28 @@ Description:
The processor idle states which are available for use have the The processor idle states which are available for use have the
following attributes: following attributes:
name: (RO) Name of the idle state (string). ======== ==== =================================================
name: (RO) Name of the idle state (string).
latency: (RO) The latency to exit out of this idle state (in latency: (RO) The latency to exit out of this idle state (in
microseconds). microseconds).
power: (RO) The power consumed while in this idle state (in power: (RO) The power consumed while in this idle state (in
milliwatts). milliwatts).
time: (RO) The total time spent in this idle state (in microseconds). time: (RO) The total time spent in this idle state
(in microseconds).
usage: (RO) Number of times this state was entered (a count). usage: (RO) Number of times this state was entered (a count).
above: (RO) Number of times this state was entered, but the above: (RO) Number of times this state was entered, but the
observed CPU idle duration was too short for it (a count). observed CPU idle duration was too short for it
(a count).
below: (RO) Number of times this state was entered, but the below: (RO) Number of times this state was entered, but the
observed CPU idle duration was too long for it (a count). observed CPU idle duration was too long for it
(a count).
======== ==== =================================================
What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc
Date: February 2008 Date: February 2008
@ -290,6 +295,7 @@ Description: Processor frequency boosting control
This switch controls the boost setting for the whole system. This switch controls the boost setting for the whole system.
Boosting allows the CPU and the firmware to run at a frequency Boosting allows the CPU and the firmware to run at a frequency
beyound it's nominal limit. beyound it's nominal limit.
More details can be found in More details can be found in
Documentation/admin-guide/pm/cpufreq.rst Documentation/admin-guide/pm/cpufreq.rst
@ -337,43 +343,57 @@ Contact: Sudeep Holla <sudeep.holla@arm.com>
Description: Parameters for the CPU cache attributes Description: Parameters for the CPU cache attributes
allocation_policy: allocation_policy:
- WriteAllocate: allocate a memory location to a cache line - WriteAllocate:
on a cache miss because of a write allocate a memory location to a cache line
- ReadAllocate: allocate a memory location to a cache line on a cache miss because of a write
- ReadAllocate:
allocate a memory location to a cache line
on a cache miss because of a read on a cache miss because of a read
- ReadWriteAllocate: both writeallocate and readallocate - ReadWriteAllocate:
both writeallocate and readallocate
attributes: LEGACY used only on IA64 and is same as write_policy attributes:
LEGACY used only on IA64 and is same as write_policy
coherency_line_size: the minimum amount of data in bytes that gets coherency_line_size:
the minimum amount of data in bytes that gets
transferred from memory to cache transferred from memory to cache
level: the cache hierarchy in the multi-level cache configuration level:
the cache hierarchy in the multi-level cache configuration
number_of_sets: total number of sets in the cache, a set is a number_of_sets:
total number of sets in the cache, a set is a
collection of cache lines with the same cache index collection of cache lines with the same cache index
physical_line_partition: number of physical cache line per cache tag physical_line_partition:
number of physical cache line per cache tag
shared_cpu_list: the list of logical cpus sharing the cache shared_cpu_list:
the list of logical cpus sharing the cache
shared_cpu_map: logical cpu mask containing the list of cpus sharing shared_cpu_map:
logical cpu mask containing the list of cpus sharing
the cache the cache
size: the total cache size in kB size:
the total cache size in kB
type: type:
- Instruction: cache that only holds instructions - Instruction: cache that only holds instructions
- Data: cache that only caches data - Data: cache that only caches data
- Unified: cache that holds both data and instructions - Unified: cache that holds both data and instructions
ways_of_associativity: degree of freedom in placing a particular block ways_of_associativity:
of memory in the cache degree of freedom in placing a particular block
of memory in the cache
write_policy: write_policy:
- WriteThrough: data is written to both the cache line - WriteThrough:
data is written to both the cache line
and to the block in the lower-level memory and to the block in the lower-level memory
- WriteBack: data is written only to the cache line and - WriteBack:
data is written only to the cache line and
the modified cache line is written to main the modified cache line is written to main
memory only when it is replaced memory only when it is replaced
@ -414,30 +434,30 @@ Description: POWERNV CPUFreq driver's frequency throttle stats directory and
throttle attributes exported in the 'throttle_stats' directory: throttle attributes exported in the 'throttle_stats' directory:
- turbo_stat : This file gives the total number of times the max - turbo_stat : This file gives the total number of times the max
frequency is throttled to lower frequency in turbo (at and above frequency is throttled to lower frequency in turbo (at and above
nominal frequency) range of frequencies. nominal frequency) range of frequencies.
- sub_turbo_stat : This file gives the total number of times the - sub_turbo_stat : This file gives the total number of times the
max frequency is throttled to lower frequency in sub-turbo(below max frequency is throttled to lower frequency in sub-turbo(below
nominal frequency) range of frequencies. nominal frequency) range of frequencies.
- unthrottle : This file gives the total number of times the max - unthrottle : This file gives the total number of times the max
frequency is unthrottled after being throttled. frequency is unthrottled after being throttled.
- powercap : This file gives the total number of times the max - powercap : This file gives the total number of times the max
frequency is throttled due to 'Power Capping'. frequency is throttled due to 'Power Capping'.
- overtemp : This file gives the total number of times the max - overtemp : This file gives the total number of times the max
frequency is throttled due to 'CPU Over Temperature'. frequency is throttled due to 'CPU Over Temperature'.
- supply_fault : This file gives the total number of times the - supply_fault : This file gives the total number of times the
max frequency is throttled due to 'Power Supply Failure'. max frequency is throttled due to 'Power Supply Failure'.
- overcurrent : This file gives the total number of times the - overcurrent : This file gives the total number of times the
max frequency is throttled due to 'Overcurrent'. max frequency is throttled due to 'Overcurrent'.
- occ_reset : This file gives the total number of times the max - occ_reset : This file gives the total number of times the max
frequency is throttled due to 'OCC Reset'. frequency is throttled due to 'OCC Reset'.
The sysfs attributes representing different throttle reasons like The sysfs attributes representing different throttle reasons like
powercap, overtemp, supply_fault, overcurrent and occ_reset map to powercap, overtemp, supply_fault, overcurrent and occ_reset map to
@ -469,8 +489,9 @@ What: /sys/devices/system/cpu/cpuX/regs/
Date: June 2016 Date: June 2016
Contact: Linux ARM Kernel Mailing list <linux-arm-kernel@lists.infradead.org> Contact: Linux ARM Kernel Mailing list <linux-arm-kernel@lists.infradead.org>
Description: AArch64 CPU registers Description: AArch64 CPU registers
'identification' directory exposes the CPU ID registers for 'identification' directory exposes the CPU ID registers for
identifying model and revision of the CPU. identifying model and revision of the CPU.
What: /sys/devices/system/cpu/cpu#/cpu_capacity What: /sys/devices/system/cpu/cpu#/cpu_capacity
Date: December 2016 Date: December 2016
@ -497,9 +518,11 @@ Description: Information about CPU vulnerabilities
vulnerabilities. The output of those files reflects the vulnerabilities. The output of those files reflects the
state of the CPUs in the system. Possible output values: state of the CPUs in the system. Possible output values:
================ ==============================================
"Not affected" CPU is not affected by the vulnerability "Not affected" CPU is not affected by the vulnerability
"Vulnerable" CPU is affected and no mitigation in effect "Vulnerable" CPU is affected and no mitigation in effect
"Mitigation: $M" CPU is affected and mitigation $M is in effect "Mitigation: $M" CPU is affected and mitigation $M is in effect
================ ==============================================
See also: Documentation/admin-guide/hw-vuln/index.rst See also: Documentation/admin-guide/hw-vuln/index.rst
@ -515,12 +538,14 @@ Description: Control Symetric Multi Threading (SMT)
control: Read/write interface to control SMT. Possible control: Read/write interface to control SMT. Possible
values: values:
================ =========================================
"on" SMT is enabled "on" SMT is enabled
"off" SMT is disabled "off" SMT is disabled
"forceoff" SMT is force disabled. Cannot be changed. "forceoff" SMT is force disabled. Cannot be changed.
"notsupported" SMT is not supported by the CPU "notsupported" SMT is not supported by the CPU
"notimplemented" SMT runtime toggling is not "notimplemented" SMT runtime toggling is not
implemented for the architecture implemented for the architecture
================ =========================================
If control status is "forceoff" or "notsupported" writes If control status is "forceoff" or "notsupported" writes
are rejected. are rejected.

View File

@ -5,8 +5,10 @@ Contact: Vernon Mauery <vernux@us.ibm.com>
Description: The state file allows a means by which to change in and Description: The state file allows a means by which to change in and
out of Premium Real-Time Mode (PRTM), as well as the out of Premium Real-Time Mode (PRTM), as well as the
ability to query the current state. ability to query the current state.
0 => PRTM off
1 => PRTM enabled - 0 => PRTM off
- 1 => PRTM enabled
Users: The ibm-prtm userspace daemon uses this interface. Users: The ibm-prtm userspace daemon uses this interface.

View File

@ -6,11 +6,13 @@ Description: Read/write the current state of DDR Backup Mode, which controls
if DDR power rails will be kept powered during system suspend. if DDR power rails will be kept powered during system suspend.
("on"/"1" = enabled, "off"/"0" = disabled). ("on"/"1" = enabled, "off"/"0" = disabled).
Two types of power switches (or control signals) can be used: Two types of power switches (or control signals) can be used:
A. With a momentary power switch (or pulse signal), DDR A. With a momentary power switch (or pulse signal), DDR
Backup Mode is enabled by default when available, as the Backup Mode is enabled by default when available, as the
PMIC will be configured only during system suspend. PMIC will be configured only during system suspend.
B. With a toggle power switch (or level signal), the B. With a toggle power switch (or level signal), the
following steps must be followed exactly: following steps must be followed exactly:
1. Configure PMIC for backup mode, to change the role of 1. Configure PMIC for backup mode, to change the role of
the accessory power switch from a power switch to a the accessory power switch from a power switch to a
wake-up switch, wake-up switch,
@ -20,8 +22,10 @@ Description: Read/write the current state of DDR Backup Mode, which controls
3. Suspend system, 3. Suspend system,
4. Switch accessory power switch on, to resume the 4. Switch accessory power switch on, to resume the
system. system.
DDR Backup Mode must be explicitly enabled by the user, DDR Backup Mode must be explicitly enabled by the user,
to invoke step 1. to invoke step 1.
See also Documentation/devicetree/bindings/mfd/bd9571mwv.txt. See also Documentation/devicetree/bindings/mfd/bd9571mwv.txt.
Users: User space applications for embedded boards equipped with a Users: User space applications for embedded boards equipped with a
BD9571MWV PMIC. BD9571MWV PMIC.

View File

@ -29,8 +29,12 @@ What: /sys/class/genwqe/genwqe<n>_card/reload_bitstream
Date: May 2014 Date: May 2014
Contact: klebers@linux.vnet.ibm.com Contact: klebers@linux.vnet.ibm.com
Description: Interface to trigger a PCIe card reset to reload the bitstream. Description: Interface to trigger a PCIe card reset to reload the bitstream.
::
sudo sh -c 'echo 1 > \ sudo sh -c 'echo 1 > \
/sys/class/genwqe/genwqe0_card/reload_bitstream' /sys/class/genwqe/genwqe0_card/reload_bitstream'
If successfully, the card will come back with the bitstream set If successfully, the card will come back with the bitstream set
on 'next_bitstream'. on 'next_bitstream'.
@ -64,8 +68,11 @@ Description: Base clock frequency of the card.
What: /sys/class/genwqe/genwqe<n>_card/device/sriov_numvfs What: /sys/class/genwqe/genwqe<n>_card/device/sriov_numvfs
Date: Oct 2013 Date: Oct 2013
Contact: haver@linux.vnet.ibm.com Contact: haver@linux.vnet.ibm.com
Description: Enable VFs (1..15): Description: Enable VFs (1..15)::
sudo sh -c 'echo 15 > \ sudo sh -c 'echo 15 > \
/sys/bus/pci/devices/0000\:1b\:00.0/sriov_numvfs' /sys/bus/pci/devices/0000\:1b\:00.0/sriov_numvfs'
Disable VFs:
Disable VFs::
Write a 0 into the same sysfs entry. Write a 0 into the same sysfs entry.

View File

@ -12,7 +12,9 @@ KernelVersion: 4.1
Contact: Michal Malý <madcatxster@devoid-pointer.net> Contact: Michal Malý <madcatxster@devoid-pointer.net>
Description: Displays a set of alternate modes supported by a wheel. Each Description: Displays a set of alternate modes supported by a wheel. Each
mode is listed as follows: mode is listed as follows:
Tag: Mode Name Tag: Mode Name
Currently active mode is marked with an asterisk. List also Currently active mode is marked with an asterisk. List also
contains an abstract item "native" which always denotes the contains an abstract item "native" which always denotes the
native mode of the wheel. Echoing the mode tag switches the native mode of the wheel. Echoing the mode tag switches the
@ -24,24 +26,30 @@ Description: Displays a set of alternate modes supported by a wheel. Each
This entry is not created for devices that have only one mode. This entry is not created for devices that have only one mode.
Currently supported mode switches: Currently supported mode switches:
Driving Force Pro:
Driving Force Pro::
DF-EX --> DFP DF-EX --> DFP
G25: G25::
DF-EX --> DFP --> G25 DF-EX --> DFP --> G25
G27: G27::
DF-EX <*> DFP <-> G25 <-> G27 DF-EX <*> DFP <-> G25 <-> G27
DF-EX <*--------> G25 <-> G27 DF-EX <*--------> G25 <-> G27
DF-EX <*----------------> G27 DF-EX <*----------------> G27
G29: G29::
DF-EX <*> DFP <-> G25 <-> G27 <-> G29 DF-EX <*> DFP <-> G25 <-> G27 <-> G29
DF-EX <*--------> G25 <-> G27 <-> G29 DF-EX <*--------> G25 <-> G27 <-> G29
DF-EX <*----------------> G27 <-> G29 DF-EX <*----------------> G27 <-> G29
DF-EX <*------------------------> G29 DF-EX <*------------------------> G29
DFGT: DFGT::
DF-EX <*> DFP <-> DFGT DF-EX <*> DFP <-> DFGT
DF-EX <*--------> DFGT DF-EX <*--------> DFGT

View File

@ -39,9 +39,13 @@ Description: While a device is initialized by the wiimote driver, we perform
Other strings for each device-type are available and may be Other strings for each device-type are available and may be
added if new device-specific detections are added. added if new device-specific detections are added.
Currently supported are: Currently supported are:
gen10: First Wii Remote generation
gen20: Second Wii Remote Plus generation (builtin MP) ============= =======================================
gen10: First Wii Remote generation
gen20: Second Wii Remote Plus generation
(builtin MP)
balanceboard: Wii Balance Board balanceboard: Wii Balance Board
============= =======================================
What: /sys/bus/hid/drivers/wiimote/<dev>/bboard_calib What: /sys/bus/hid/drivers/wiimote/<dev>/bboard_calib
Date: May 2013 Date: May 2013
@ -54,6 +58,7 @@ Description: This attribute is only provided if the device was detected as a
First, 0kg values for all 4 sensors are written, followed by the First, 0kg values for all 4 sensors are written, followed by the
17kg values for all 4 sensors and last the 34kg values for all 4 17kg values for all 4 sensors and last the 34kg values for all 4
sensors. sensors.
Calibration data is already applied by the kernel to all input Calibration data is already applied by the kernel to all input
values but may be used by user-space to perform other values but may be used by user-space to perform other
transformations. transformations.
@ -68,9 +73,11 @@ Description: This attribute is only provided if the device was detected as a
is prefixed with a +/-. Each value is a signed 16bit number. is prefixed with a +/-. Each value is a signed 16bit number.
Data is encoded as decimal numbers and specifies the offsets of Data is encoded as decimal numbers and specifies the offsets of
the analog sticks of the pro-controller. the analog sticks of the pro-controller.
Calibration data is already applied by the kernel to all input Calibration data is already applied by the kernel to all input
values but may be used by user-space to perform other values but may be used by user-space to perform other
transformations. transformations.
Calibration data is detected by the kernel during device setup. Calibration data is detected by the kernel during device setup.
You can write "scan\n" into this file to re-trigger calibration. You can write "scan\n" into this file to re-trigger calibration.
You can also write data directly in the form "x1:y1 x2:y2" to You can also write data directly in the form "x1:y1 x2:y2" to

View File

@ -9,10 +9,12 @@ Description: Some Samsung laptops have different "performance levels"
their fans quiet at all costs. Reading from this file their fans quiet at all costs. Reading from this file
will show the current performance level. Writing to the will show the current performance level. Writing to the
file can change this value. file can change this value.
Valid options: Valid options:
"silent" - "silent"
"normal" - "normal"
"overclock" - "overclock"
Note that not all laptops support all of these options. Note that not all laptops support all of these options.
Specifically, not all support the "overclock" option, Specifically, not all support the "overclock" option,
and it's still unknown if this value even changes and it's still unknown if this value even changes
@ -25,8 +27,9 @@ Contact: Corentin Chary <corentin.chary@gmail.com>
Description: Max battery charge level can be modified, battery cycle Description: Max battery charge level can be modified, battery cycle
life can be extended by reducing the max battery charge life can be extended by reducing the max battery charge
level. level.
0 means normal battery mode (100% charge)
1 means battery life extender mode (80% charge) - 0 means normal battery mode (100% charge)
- 1 means battery life extender mode (80% charge)
What: /sys/devices/platform/samsung/usb_charge What: /sys/devices/platform/samsung/usb_charge
Date: December 1, 2011 Date: December 1, 2011

View File

@ -4,10 +4,12 @@ KernelVersion: 3.15
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the keyboard backlight operation mode, valid Description: This file controls the keyboard backlight operation mode, valid
values are: values are:
* 0x1 -> FN-Z * 0x1 -> FN-Z
* 0x2 -> AUTO (also called TIMER) * 0x2 -> AUTO (also called TIMER)
* 0x8 -> ON * 0x8 -> ON
* 0x10 -> OFF * 0x10 -> OFF
Note that from kernel 3.16 onwards this file accepts all listed Note that from kernel 3.16 onwards this file accepts all listed
parameters, kernel 3.15 only accepts the first two (FN-Z and parameters, kernel 3.15 only accepts the first two (FN-Z and
AUTO). AUTO).
@ -41,8 +43,10 @@ KernelVersion: 3.15
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This files controls the status of the touchpad and pointing Description: This files controls the status of the touchpad and pointing
stick (if available), valid values are: stick (if available), valid values are:
* 0 -> OFF * 0 -> OFF
* 1 -> ON * 1 -> ON
Users: KToshiba Users: KToshiba
What: /sys/devices/LNXSYSTM:00/LNXSYBUS:00/TOS{1900,620{0,7,8}}:00/available_kbd_modes What: /sys/devices/LNXSYSTM:00/LNXSYBUS:00/TOS{1900,620{0,7,8}}:00/available_kbd_modes
@ -51,10 +55,12 @@ KernelVersion: 3.16
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file shows the supported keyboard backlight modes Description: This file shows the supported keyboard backlight modes
the system supports, which can be: the system supports, which can be:
* 0x1 -> FN-Z * 0x1 -> FN-Z
* 0x2 -> AUTO (also called TIMER) * 0x2 -> AUTO (also called TIMER)
* 0x8 -> ON * 0x8 -> ON
* 0x10 -> OFF * 0x10 -> OFF
Note that not all keyboard types support the listed modes. Note that not all keyboard types support the listed modes.
See the entry named "available_kbd_modes" See the entry named "available_kbd_modes"
Users: KToshiba Users: KToshiba
@ -65,6 +71,7 @@ KernelVersion: 3.16
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file shows the current keyboard backlight type, Description: This file shows the current keyboard backlight type,
which can be: which can be:
* 1 -> Type 1, supporting modes FN-Z and AUTO * 1 -> Type 1, supporting modes FN-Z and AUTO
* 2 -> Type 2, supporting modes TIMER, ON and OFF * 2 -> Type 2, supporting modes TIMER, ON and OFF
Users: KToshiba Users: KToshiba
@ -75,10 +82,12 @@ KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the USB Sleep & Charge charging mode, which Description: This file controls the USB Sleep & Charge charging mode, which
can be: can be:
* 0 -> Disabled (0x00) * 0 -> Disabled (0x00)
* 1 -> Alternate (0x09) * 1 -> Alternate (0x09)
* 2 -> Auto (0x21) * 2 -> Auto (0x21)
* 3 -> Typical (0x11) * 3 -> Typical (0x11)
Note that from kernel 4.1 onwards this file accepts all listed Note that from kernel 4.1 onwards this file accepts all listed
values, kernel 4.0 only supports the first three. values, kernel 4.0 only supports the first three.
Note that this feature only works when connected to power, if Note that this feature only works when connected to power, if
@ -93,8 +102,10 @@ Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the USB Sleep Functions under battery, and Description: This file controls the USB Sleep Functions under battery, and
set the level at which point they will be disabled, accepted set the level at which point they will be disabled, accepted
values can be: values can be:
* 0 -> Disabled * 0 -> Disabled
* 1-100 -> Battery level to disable sleep functions * 1-100 -> Battery level to disable sleep functions
Currently it prints two values, the first one indicates if the Currently it prints two values, the first one indicates if the
feature is enabled or disabled, while the second one shows the feature is enabled or disabled, while the second one shows the
current battery level set. current battery level set.
@ -107,8 +118,10 @@ Date: January 23, 2015
KernelVersion: 4.0 KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the USB Rapid Charge state, which can be: Description: This file controls the USB Rapid Charge state, which can be:
* 0 -> Disabled * 0 -> Disabled
* 1 -> Enabled * 1 -> Enabled
Note that toggling this value requires a reboot for changes to Note that toggling this value requires a reboot for changes to
take effect. take effect.
Users: KToshiba Users: KToshiba
@ -118,8 +131,10 @@ Date: January 23, 2015
KernelVersion: 4.0 KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the Sleep & Music state, which values can be: Description: This file controls the Sleep & Music state, which values can be:
* 0 -> Disabled * 0 -> Disabled
* 1 -> Enabled * 1 -> Enabled
Note that this feature only works when connected to power, if Note that this feature only works when connected to power, if
you want to use it under battery, see the entry named you want to use it under battery, see the entry named
"sleep_functions_on_battery" "sleep_functions_on_battery"
@ -138,6 +153,7 @@ KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the state of the internal fan, valid Description: This file controls the state of the internal fan, valid
values are: values are:
* 0 -> OFF * 0 -> OFF
* 1 -> ON * 1 -> ON
@ -147,8 +163,10 @@ KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the Special Functions (hotkeys) operation Description: This file controls the Special Functions (hotkeys) operation
mode, valid values are: mode, valid values are:
* 0 -> Normal Operation * 0 -> Normal Operation
* 1 -> Special Functions * 1 -> Special Functions
In the "Normal Operation" mode, the F{1-12} keys are as usual In the "Normal Operation" mode, the F{1-12} keys are as usual
and the hotkeys are accessed via FN-F{1-12}. and the hotkeys are accessed via FN-F{1-12}.
In the "Special Functions" mode, the F{1-12} keys trigger the In the "Special Functions" mode, the F{1-12} keys trigger the
@ -163,8 +181,10 @@ KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls whether the laptop should turn ON whenever Description: This file controls whether the laptop should turn ON whenever
the LID is opened, valid values are: the LID is opened, valid values are:
* 0 -> Disabled * 0 -> Disabled
* 1 -> Enabled * 1 -> Enabled
Note that toggling this value requires a reboot for changes to Note that toggling this value requires a reboot for changes to
take effect. take effect.
Users: KToshiba Users: KToshiba
@ -174,8 +194,10 @@ Date: February 12, 2015
KernelVersion: 4.0 KernelVersion: 4.0
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the USB 3 functionality, valid values are: Description: This file controls the USB 3 functionality, valid values are:
* 0 -> Disabled (Acts as a regular USB 2) * 0 -> Disabled (Acts as a regular USB 2)
* 1 -> Enabled (Full USB 3 functionality) * 1 -> Enabled (Full USB 3 functionality)
Note that toggling this value requires a reboot for changes to Note that toggling this value requires a reboot for changes to
take effect. take effect.
Users: KToshiba Users: KToshiba
@ -188,10 +210,14 @@ Description: This file controls the Cooling Method feature.
Reading this file prints two values, the first is the actual cooling method Reading this file prints two values, the first is the actual cooling method
and the second is the maximum cooling method supported. and the second is the maximum cooling method supported.
When the maximum cooling method is ONE, valid values are: When the maximum cooling method is ONE, valid values are:
* 0 -> Maximum Performance * 0 -> Maximum Performance
* 1 -> Battery Optimized * 1 -> Battery Optimized
When the maximum cooling method is TWO, valid values are: When the maximum cooling method is TWO, valid values are:
* 0 -> Maximum Performance * 0 -> Maximum Performance
* 1 -> Performance * 1 -> Performance
* 2 -> Battery Optimized * 2 -> Battery Optimized
Users: KToshiba Users: KToshiba

View File

@ -4,10 +4,12 @@ KernelVersion: 3.17
Contact: Azael Avalos <coproscefalo@gmail.com> Contact: Azael Avalos <coproscefalo@gmail.com>
Description: This file controls the built-in accelerometer protection level, Description: This file controls the built-in accelerometer protection level,
valid values are: valid values are:
* 0 -> Disabled * 0 -> Disabled
* 1 -> Low * 1 -> Low
* 2 -> Medium * 2 -> Medium
* 3 -> High * 3 -> High
The default potection value is set to 2 (Medium). The default potection value is set to 2 (Medium).
Users: KToshiba Users: KToshiba

View File

@ -79,7 +79,9 @@ Description:
When the Wacom Intuos 4 is connected over Bluetooth, the When the Wacom Intuos 4 is connected over Bluetooth, the
image has to contain 256 bytes (64x32 px 1 bit colour). image has to contain 256 bytes (64x32 px 1 bit colour).
The format is also scrambled, like in the USB mode, and it can The format is also scrambled, like in the USB mode, and it can
be summarized by converting 76543210 into GECA6420. be summarized by converting::
76543210 into GECA6420.
HGFEDCBA HFDB7531 HGFEDCBA HFDB7531
What: /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote What: /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote

View File

@ -12,11 +12,14 @@ Description:
image: The image bitmap. Currently a 32-bit BMP. image: The image bitmap. Currently a 32-bit BMP.
status: 1 if the image is valid, 0 if firmware invalidated it. status: 1 if the image is valid, 0 if firmware invalidated it.
type: 0 indicates image is in BMP format. type: 0 indicates image is in BMP format.
======== ===================================================
version: The version of the BGRT. Currently 1. version: The version of the BGRT. Currently 1.
xoffset: The number of pixels between the left of the screen xoffset: The number of pixels between the left of the screen
and the left edge of the image. and the left edge of the image.
yoffset: The number of pixels between the top of the screen yoffset: The number of pixels between the top of the screen
and the top edge of the image. and the top edge of the image.
======== ===================================================
What: /sys/firmware/acpi/hotplug/ What: /sys/firmware/acpi/hotplug/
Date: February 2013 Date: February 2013
@ -33,12 +36,14 @@ Description:
The following setting is available to user space for each The following setting is available to user space for each
hotplug profile: hotplug profile:
======== =======================================================
enabled: If set, the ACPI core will handle notifications of enabled: If set, the ACPI core will handle notifications of
hotplug events associated with the given class of hotplug events associated with the given class of
devices and will allow those devices to be ejected with devices and will allow those devices to be ejected with
the help of the _EJ0 control method. Unsetting it the help of the _EJ0 control method. Unsetting it
effectively disables hotplug for the correspoinding effectively disables hotplug for the correspoinding
class of devices. class of devices.
======== =======================================================
The value of the above attribute is an integer number: 1 (set) The value of the above attribute is an integer number: 1 (set)
or 0 (unset). Attempts to write any other values to it will or 0 (unset). Attempts to write any other values to it will
@ -71,86 +76,90 @@ Description:
To figure out where all the SCI's are coming from, To figure out where all the SCI's are coming from,
/sys/firmware/acpi/interrupts contains a file listing /sys/firmware/acpi/interrupts contains a file listing
every possible source, and the count of how many every possible source, and the count of how many
times it has triggered. times it has triggered::
$ cd /sys/firmware/acpi/interrupts $ cd /sys/firmware/acpi/interrupts
$ grep . * $ grep . *
error: 0 error: 0
ff_gbl_lock: 0 enable ff_gbl_lock: 0 enable
ff_pmtimer: 0 invalid ff_pmtimer: 0 invalid
ff_pwr_btn: 0 enable ff_pwr_btn: 0 enable
ff_rt_clk: 2 disable ff_rt_clk: 2 disable
ff_slp_btn: 0 invalid ff_slp_btn: 0 invalid
gpe00: 0 invalid gpe00: 0 invalid
gpe01: 0 enable gpe01: 0 enable
gpe02: 108 enable gpe02: 108 enable
gpe03: 0 invalid gpe03: 0 invalid
gpe04: 0 invalid gpe04: 0 invalid
gpe05: 0 invalid gpe05: 0 invalid
gpe06: 0 enable gpe06: 0 enable
gpe07: 0 enable gpe07: 0 enable
gpe08: 0 invalid gpe08: 0 invalid
gpe09: 0 invalid gpe09: 0 invalid
gpe0A: 0 invalid gpe0A: 0 invalid
gpe0B: 0 invalid gpe0B: 0 invalid
gpe0C: 0 invalid gpe0C: 0 invalid
gpe0D: 0 invalid gpe0D: 0 invalid
gpe0E: 0 invalid gpe0E: 0 invalid
gpe0F: 0 invalid gpe0F: 0 invalid
gpe10: 0 invalid gpe10: 0 invalid
gpe11: 0 invalid gpe11: 0 invalid
gpe12: 0 invalid gpe12: 0 invalid
gpe13: 0 invalid gpe13: 0 invalid
gpe14: 0 invalid gpe14: 0 invalid
gpe15: 0 invalid gpe15: 0 invalid
gpe16: 0 invalid gpe16: 0 invalid
gpe17: 1084 enable gpe17: 1084 enable
gpe18: 0 enable gpe18: 0 enable
gpe19: 0 invalid gpe19: 0 invalid
gpe1A: 0 invalid gpe1A: 0 invalid
gpe1B: 0 invalid gpe1B: 0 invalid
gpe1C: 0 invalid gpe1C: 0 invalid
gpe1D: 0 invalid gpe1D: 0 invalid
gpe1E: 0 invalid gpe1E: 0 invalid
gpe1F: 0 invalid gpe1F: 0 invalid
gpe_all: 1192 gpe_all: 1192
sci: 1194 sci: 1194
sci_not: 0 sci_not: 0
sci - The number of times the ACPI SCI =========== ==================================================
has been called and claimed an interrupt. sci The number of times the ACPI SCI
has been called and claimed an interrupt.
sci_not - The number of times the ACPI SCI sci_not The number of times the ACPI SCI
has been called and NOT claimed an interrupt. has been called and NOT claimed an interrupt.
gpe_all - count of SCI caused by GPEs. gpe_all count of SCI caused by GPEs.
gpeXX - count for individual GPE source gpeXX count for individual GPE source
ff_gbl_lock - Global Lock ff_gbl_lock Global Lock
ff_pmtimer - PM Timer ff_pmtimer PM Timer
ff_pwr_btn - Power Button ff_pwr_btn Power Button
ff_rt_clk - Real Time Clock ff_rt_clk Real Time Clock
ff_slp_btn - Sleep Button ff_slp_btn Sleep Button
error - an interrupt that can't be accounted for above. error an interrupt that can't be accounted for above.
invalid: it's either a GPE or a Fixed Event that invalid it's either a GPE or a Fixed Event that
doesn't have an event handler. doesn't have an event handler.
disable: the GPE/Fixed Event is valid but disabled. disable the GPE/Fixed Event is valid but disabled.
enable: the GPE/Fixed Event is valid and enabled. enable the GPE/Fixed Event is valid and enabled.
=========== ==================================================
Root has permission to clear any of these counters. Eg. Root has permission to clear any of these counters. Eg.::
# echo 0 > gpe11
All counters can be cleared by clearing the total "sci": # echo 0 > gpe11
# echo 0 > sci
All counters can be cleared by clearing the total "sci"::
# echo 0 > sci
None of these counters has an effect on the function None of these counters has an effect on the function
of the system, they are simply statistics. of the system, they are simply statistics.
@ -165,32 +174,34 @@ Description:
Let's take power button fixed event for example, please kill acpid Let's take power button fixed event for example, please kill acpid
and other user space applications so that the machine won't shutdown and other user space applications so that the machine won't shutdown
when pressing the power button. when pressing the power button::
# cat ff_pwr_btn
0 enabled # cat ff_pwr_btn
# press the power button for 3 times; 0 enabled
# cat ff_pwr_btn # press the power button for 3 times;
3 enabled # cat ff_pwr_btn
# echo disable > ff_pwr_btn 3 enabled
# cat ff_pwr_btn # echo disable > ff_pwr_btn
3 disabled # cat ff_pwr_btn
# press the power button for 3 times; 3 disabled
# cat ff_pwr_btn # press the power button for 3 times;
3 disabled # cat ff_pwr_btn
# echo enable > ff_pwr_btn 3 disabled
# cat ff_pwr_btn # echo enable > ff_pwr_btn
4 enabled # cat ff_pwr_btn
/* 4 enabled
* this is because the status bit is set even if the enable bit is cleared, /*
* and it triggers an ACPI fixed event when the enable bit is set again * this is because the status bit is set even if the enable
*/ * bit is cleared, and it triggers an ACPI fixed event when
# press the power button for 3 times; * the enable bit is set again
# cat ff_pwr_btn */
7 enabled # press the power button for 3 times;
# echo disable > ff_pwr_btn # cat ff_pwr_btn
# press the power button for 3 times; 7 enabled
# echo clear > ff_pwr_btn /* clear the status bit */ # echo disable > ff_pwr_btn
# echo disable > ff_pwr_btn # press the power button for 3 times;
# cat ff_pwr_btn # echo clear > ff_pwr_btn /* clear the status bit */
7 enabled # echo disable > ff_pwr_btn
# cat ff_pwr_btn
7 enabled

View File

@ -33,7 +33,7 @@ Description:
doesn't matter), they will be represented in sysfs as doesn't matter), they will be represented in sysfs as
entries "T-0" through "T-(N-1)": entries "T-0" through "T-(N-1)":
Example entry directories: Example entry directories::
/sys/firmware/dmi/entries/17-0 /sys/firmware/dmi/entries/17-0
/sys/firmware/dmi/entries/17-1 /sys/firmware/dmi/entries/17-1
@ -50,61 +50,65 @@ Description:
Each DMI entry in sysfs has the common header values Each DMI entry in sysfs has the common header values
exported as attributes: exported as attributes:
handle : The 16bit 'handle' that is assigned to this ======== =================================================
handle The 16bit 'handle' that is assigned to this
entry by the firmware. This handle may be entry by the firmware. This handle may be
referred to by other entries. referred to by other entries.
length : The length of the entry, as presented in the length The length of the entry, as presented in the
entry itself. Note that this is _not the entry itself. Note that this is _not the
total count of bytes associated with the total count of bytes associated with the
entry_. This value represents the length of entry. This value represents the length of
the "formatted" portion of the entry. This the "formatted" portion of the entry. This
"formatted" region is sometimes followed by "formatted" region is sometimes followed by
the "unformatted" region composed of nul the "unformatted" region composed of nul
terminated strings, with termination signalled terminated strings, with termination signalled
by a two nul characters in series. by a two nul characters in series.
raw : The raw bytes of the entry. This includes the raw The raw bytes of the entry. This includes the
"formatted" portion of the entry, the "formatted" portion of the entry, the
"unformatted" strings portion of the entry, "unformatted" strings portion of the entry,
and the two terminating nul characters. and the two terminating nul characters.
type : The type of the entry. This value is the same type The type of the entry. This value is the same
as found in the directory name. It indicates as found in the directory name. It indicates
how the rest of the entry should be interpreted. how the rest of the entry should be interpreted.
instance: The instance ordinal of the entry for the instance The instance ordinal of the entry for the
given type. This value is the same as found given type. This value is the same as found
in the parent directory name. in the parent directory name.
position: The ordinal position (zero-based) of the entry position The ordinal position (zero-based) of the entry
within the entirety of the DMI entry table. within the entirety of the DMI entry table.
======== =================================================
=== Entry Specialization === **Entry Specialization**
Some entry types may have other information available in Some entry types may have other information available in
sysfs. Not all types are specialized. sysfs. Not all types are specialized.
--- Type 15 - System Event Log --- **Type 15 - System Event Log**
This entry allows the firmware to export a log of This entry allows the firmware to export a log of
events the system has taken. This information is events the system has taken. This information is
typically backed by nvram, but the implementation typically backed by nvram, but the implementation
details are abstracted by this table. This entry's data details are abstracted by this table. This entry's data
is exported in the directory: is exported in the directory::
/sys/firmware/dmi/entries/15-0/system_event_log /sys/firmware/dmi/entries/15-0/system_event_log
and has the following attributes (documented in the and has the following attributes (documented in the
SMBIOS / DMI specification under "System Event Log (Type 15)": SMBIOS / DMI specification under "System Event Log (Type 15)":
area_length - area_length
header_start_offset - header_start_offset
data_start_offset - data_start_offset
access_method - access_method
status - status
change_token - change_token
access_method_address - access_method_address
header_format - header_format
per_log_type_descriptor_length - per_log_type_descriptor_length
type_descriptors_supported_count - type_descriptors_supported_count
As well, the kernel exports the binary attribute: As well, the kernel exports the binary attribute:
raw_event_log : The raw binary bits of the event log ============= ====================================
raw_event_log The raw binary bits of the event log
as described by the DMI entry. as described by the DMI entry.
============= ====================================

View File

@ -20,7 +20,7 @@ Description:
This directory has the same layout (and This directory has the same layout (and
underlying implementation as /sys/firmware/efi/vars. underlying implementation as /sys/firmware/efi/vars.
See Documentation/ABI/*/sysfs-firmware-efi-vars See `Documentation/ABI/*/sysfs-firmware-efi-vars`
for more information on how to interact with for more information on how to interact with
this structure. this structure.

View File

@ -20,7 +20,7 @@ Description:
the raw memory map to userspace. the raw memory map to userspace.
The structure is as follows: Under /sys/firmware/memmap there The structure is as follows: Under /sys/firmware/memmap there
are subdirectories with the number of the entry as their name: are subdirectories with the number of the entry as their name::
/sys/firmware/memmap/0 /sys/firmware/memmap/0
/sys/firmware/memmap/1 /sys/firmware/memmap/1
@ -34,14 +34,16 @@ Description:
Each directory contains three files: Each directory contains three files:
start : The start address (as hexadecimal number with the ======== =====================================================
start The start address (as hexadecimal number with the
'0x' prefix). '0x' prefix).
end : The end address, inclusive (regardless whether the end The end address, inclusive (regardless whether the
firmware provides inclusive or exclusive ranges). firmware provides inclusive or exclusive ranges).
type : Type of the entry as string. See below for a list of type Type of the entry as string. See below for a list of
valid types. valid types.
======== =====================================================
So, for example: So, for example::
/sys/firmware/memmap/0/start /sys/firmware/memmap/0/start
/sys/firmware/memmap/0/end /sys/firmware/memmap/0/end
@ -57,9 +59,8 @@ Description:
- reserved - reserved
Following shell snippet can be used to display that memory Following shell snippet can be used to display that memory
map in a human-readable format: map in a human-readable format::
-------------------- 8< ----------------------------------------
#!/bin/bash #!/bin/bash
cd /sys/firmware/memmap cd /sys/firmware/memmap
for dir in * ; do for dir in * ; do
@ -68,4 +69,3 @@ Description:
type=$(cat $dir/type) type=$(cat $dir/type)
printf "%016x-%016x (%s)\n" $start $[ $end +1] "$type" printf "%016x-%016x (%s)\n" $start $[ $end +1] "$type"
done done
-------------------- >8 ----------------------------------------

View File

@ -45,8 +45,8 @@ Description:
parameter will have their blocks allocated out of a parameter will have their blocks allocated out of a
block group specific preallocation pool, so that small block group specific preallocation pool, so that small
files are packed closely together. Each large file files are packed closely together. Each large file
will have its blocks allocated out of its own unique will have its blocks allocated out of its own unique
preallocation pool. preallocation pool.
What: /sys/fs/ext4/<disk>/inode_readahead_blks What: /sys/fs/ext4/<disk>/inode_readahead_blks
Date: March 2008 Date: March 2008

View File

@ -15,14 +15,17 @@ KernelVersion: 4.3
Contact: Boris Ostrovsky <boris.ostrovsky@oracle.com> Contact: Boris Ostrovsky <boris.ostrovsky@oracle.com>
Description: If running under Xen: Description: If running under Xen:
Describes mode that Xen's performance-monitoring unit (PMU) Describes mode that Xen's performance-monitoring unit (PMU)
uses. Accepted values are uses. Accepted values are:
"off" -- PMU is disabled
"self" -- The guest can profile itself ====== ============================================
"hv" -- The guest can profile itself and, if it is "off" PMU is disabled
"self" The guest can profile itself
"hv" The guest can profile itself and, if it is
privileged (e.g. dom0), the hypervisor privileged (e.g. dom0), the hypervisor
"all" -- The guest can profile itself, the hypervisor "all" The guest can profile itself, the hypervisor
and all other guests. Only available to and all other guests. Only available to
privileged guests. privileged guests.
====== ============================================
What: /sys/hypervisor/pmu/pmu_features What: /sys/hypervisor/pmu/pmu_features
Date: August 2015 Date: August 2015

View File

@ -23,16 +23,17 @@ Description: The /sys/kernel/boot_params directory contains two
representation of setup_data type. "data" file is the binary representation of setup_data type. "data" file is the binary
representation of setup_data payload. representation of setup_data payload.
The whole boot_params directory structure is like below: The whole boot_params directory structure is like below::
/sys/kernel/boot_params
|__ data /sys/kernel/boot_params
|__ setup_data |__ data
| |__ 0 |__ setup_data
| | |__ data | |__ 0
| | |__ type | | |__ data
| |__ 1 | | |__ type
| |__ data | |__ 1
| |__ type | |__ data
|__ version | |__ type
|__ version
Users: Kexec Users: Kexec

View File

@ -7,9 +7,11 @@ Description:
of the hugepages supported by the kernel/CPU combination. of the hugepages supported by the kernel/CPU combination.
Under these directories are a number of files: Under these directories are a number of files:
nr_hugepages
nr_overcommit_hugepages - nr_hugepages
free_hugepages - nr_overcommit_hugepages
surplus_hugepages - free_hugepages
resv_hugepages - surplus_hugepages
- resv_hugepages
See Documentation/admin-guide/mm/hugetlbpage.rst for details. See Documentation/admin-guide/mm/hugetlbpage.rst for details.

View File

@ -4,13 +4,16 @@ KernelVersion: 2.6.20
Contact: "Corentin Chary" <corentincj@iksaif.net> Contact: "Corentin Chary" <corentincj@iksaif.net>
Description: Description:
This file allows display switching. The value This file allows display switching. The value
is composed by 4 bits and defined as follow: is composed by 4 bits and defined as follow::
4321
|||`- LCD 4321
||`-- CRT |||`- LCD
|`--- TV ||`-- CRT
`---- DVI |`--- TV
Ex: - 0 (0000b) means no display `---- DVI
Ex:
- 0 (0000b) means no display
- 3 (0011b) CRT+LCD. - 3 (0011b) CRT+LCD.
What: /sys/devices/platform/asus_laptop/gps What: /sys/devices/platform/asus_laptop/gps
@ -28,8 +31,10 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
Description: Description:
Some models like the W1N have a LED display that can be Some models like the W1N have a LED display that can be
used to display several items of information. used to display several items of information.
To control the LED display, use the following : To control the LED display, use the following::
echo 0x0T000DDD > /sys/devices/platform/asus_laptop/ echo 0x0T000DDD > /sys/devices/platform/asus_laptop/
where T control the 3 letters display, and DDD the 3 digits display. where T control the 3 letters display, and DDD the 3 digits display.
The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst

View File

@ -5,6 +5,7 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
Description: Description:
Change CPU clock configuration (write-only). Change CPU clock configuration (write-only).
There are three available clock configuration: There are three available clock configuration:
* 0 -> Super Performance Mode * 0 -> Super Performance Mode
* 1 -> High Performance Mode * 1 -> High Performance Mode
* 2 -> Power Saving Mode * 2 -> Power Saving Mode

View File

@ -18,8 +18,10 @@ Description:
In order to use an extended can_id add the In order to use an extended can_id add the
CAN_EFF_FLAG (0x80000000U) to the can_id. Example: CAN_EFF_FLAG (0x80000000U) to the can_id. Example:
- standard id 0x7ff: - standard id 0x7ff::
echo 0x7ff > /sys/class/net/can0/mb0_id
- extended id 0x1fffffff: echo 0x7ff > /sys/class/net/can0/mb0_id
echo 0x9fffffff > /sys/class/net/can0/mb0_id
- extended id 0x1fffffff::
echo 0x9fffffff > /sys/class/net/can0/mb0_id

View File

@ -4,9 +4,11 @@ KernelVersion: 2.6.26
Contact: "Corentin Chary" <corentincj@iksaif.net> Contact: "Corentin Chary" <corentincj@iksaif.net>
Description: Description:
This file allows display switching. This file allows display switching.
- 1 = LCD - 1 = LCD
- 2 = CRT - 2 = CRT
- 3 = LCD+CRT - 3 = LCD+CRT
If you run X11, you should use xrandr instead. If you run X11, you should use xrandr instead.
What: /sys/devices/platform/eeepc/camera What: /sys/devices/platform/eeepc/camera
@ -30,16 +32,20 @@ Contact: "Corentin Chary" <corentincj@iksaif.net>
Description: Description:
Change CPU clock configuration. Change CPU clock configuration.
On the Eee PC 1000H there are three available clock configuration: On the Eee PC 1000H there are three available clock configuration:
* 0 -> Super Performance Mode * 0 -> Super Performance Mode
* 1 -> High Performance Mode * 1 -> High Performance Mode
* 2 -> Power Saving Mode * 2 -> Power Saving Mode
On Eee PC 701 there is only 2 available clock configurations. On Eee PC 701 there is only 2 available clock configurations.
Available configuration are listed in available_cpufv file. Available configuration are listed in available_cpufv file.
Reading this file will show the raw hexadecimal value which Reading this file will show the raw hexadecimal value which
is defined as follow: is defined as follow::
| 8 bit | 8 bit |
| `---- Current mode | 8 bit | 8 bit |
`------------ Availables modes | `---- Current mode
`------------ Availables modes
For example, 0x301 means: mode 1 selected, 3 available modes. For example, 0x301 means: mode 1 selected, 3 available modes.
What: /sys/devices/platform/eeepc/available_cpufv What: /sys/devices/platform/eeepc/available_cpufv

View File

@ -12,6 +12,7 @@ Contact: "Maxim Mikityanskiy <maxtram95@gmail.com>"
Description: Description:
Change fan mode Change fan mode
There are four available modes: There are four available modes:
* 0 -> Super Silent Mode * 0 -> Super Silent Mode
* 1 -> Standard Mode * 1 -> Standard Mode
* 2 -> Dust Cleaning * 2 -> Dust Cleaning
@ -32,9 +33,11 @@ KernelVersion: 4.18
Contact: "Oleg Keri <ezhi99@gmail.com>" Contact: "Oleg Keri <ezhi99@gmail.com>"
Description: Description:
Control fn-lock mode. Control fn-lock mode.
* 1 -> Switched On * 1 -> Switched On
* 0 -> Switched Off * 0 -> Switched Off
For example: For example::
# echo "0" > \
/sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock # echo "0" > \
/sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock

View File

@ -7,5 +7,6 @@ Description:
Thunderbolt controllers to turn on or off when no Thunderbolt controllers to turn on or off when no
devices are connected (write-only) devices are connected (write-only)
There are two available states: There are two available states:
* 0 -> Force power disabled * 0 -> Force power disabled
* 1 -> Force power enabled * 1 -> Force power enabled

View File

@ -5,13 +5,22 @@ Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com>
Description: Description:
LPE Firmware version for SST driver on all atom LPE Firmware version for SST driver on all atom
plaforms (BYT/CHT/Merrifield/BSW). plaforms (BYT/CHT/Merrifield/BSW).
If the FW has never been loaded it will display: If the FW has never been loaded it will display::
"FW not yet loaded" "FW not yet loaded"
If FW has been loaded it will display:
If FW has been loaded it will display::
"v01.aa.bb.cc" "v01.aa.bb.cc"
aa: Major version is reflecting SoC version: aa: Major version is reflecting SoC version:
=== =============
0d: BYT FW 0d: BYT FW
0b: BSW FW 0b: BSW FW
07: Merrifield FW 07: Merrifield FW
=== =============
bb: Minor version bb: Minor version
cc: Build version cc: Build version

View File

@ -16,10 +16,13 @@ Contact: Krzysztof Opasiak <k.opasiak@samsung.com>
Description: Description:
Current status of the device. Current status of the device.
Allowed values: Allowed values:
1 - Device is available and can be exported
2 - Device is currently exported == ==========================================
3 - Fatal error occurred during communication 1 Device is available and can be exported
with peer 2 Device is currently exported
3 Fatal error occurred during communication
with peer
== ==========================================
What: /sys/devices/platform/usbip-vudc.%d/usbip_sockfd What: /sys/devices/platform/usbip-vudc.%d/usbip_sockfd
Date: April 2016 Date: April 2016

View File

@ -69,7 +69,7 @@ Description:
pin offered by the PTP hardware clock. The file name pin offered by the PTP hardware clock. The file name
is the hardware dependent pin name. Reading from this is the hardware dependent pin name. Reading from this
file produces two numbers, the assigned function (see file produces two numbers, the assigned function (see
the PTP_PF_ enumeration values in linux/ptp_clock.h) the `PTP_PF_` enumeration values in linux/ptp_clock.h)
and the channel number. The function and channel and the channel number. The function and channel
assignment may be changed by two writing numbers into assignment may be changed by two writing numbers into
the file. the file.