Commit 54a19b4d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman

docs: ABI: cleanup several ABI documents

There are some ABI documents that, while they don't generate
any warnings, they have issues when parsed by get_abi.pl script
on its output result.

Address them, in order to provide a clean output.

Reviewed-by: Tom Rix <trix@redhat.com> # for fpga-manager
Reviewed-By: Kajol Jain<kjain@linux.ibm.com> # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
Acked-by: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt
Acked-by: default avatarSuzuki K Poulose <suzuki.poulose@arm.com>
Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ed8c39d4
...@@ -8,11 +8,11 @@ Description: Device DAX is the device-centric analogue of Filesystem ...@@ -8,11 +8,11 @@ Description: Device DAX is the device-centric analogue of Filesystem
system. Device DAX is strict, precise and predictable. system. Device DAX is strict, precise and predictable.
Specifically this interface: Specifically this interface:
1/ Guarantees fault granularity with respect to a given 1. Guarantees fault granularity with respect to a given
page size (pte, pmd, or pud) set at configuration time. page size (pte, pmd, or pud) set at configuration time.
2/ Enforces deterministic behavior by being strict about 2. Enforces deterministic behavior by being strict about
what fault scenarios are supported. what fault scenarios are supported.
The /sys/class/dax/ interface enumerates all the The /sys/class/dax/ interface enumerates all the
device-dax instances in the system. The ABI is device-dax instances in the system. The ABI is
......
...@@ -7,10 +7,13 @@ Description: It is possible to switch the cpi setting of the mouse with the ...@@ -7,10 +7,13 @@ Description: It is possible to switch the cpi setting of the mouse with the
setting reported by the mouse. This number has to be further setting reported by the mouse. This number has to be further
processed to receive the real dpi value: processed to receive the real dpi value:
===== ====
VALUE DPI VALUE DPI
===== ====
1 400 1 400
2 800 2 800
4 1600 4 1600
===== ====
This file is readonly. This file is readonly.
Has never been used. If bookkeeping is done, it's done in userland tools. Has never been used. If bookkeeping is done, it's done in userland tools.
......
...@@ -5,6 +5,7 @@ Description: ...@@ -5,6 +5,7 @@ Description:
devfs has been unmaintained for a number of years, has unfixable devfs has been unmaintained for a number of years, has unfixable
races, contains a naming policy within the kernel that is races, contains a naming policy within the kernel that is
against the LSB, and can be replaced by using udev. against the LSB, and can be replaced by using udev.
The files fs/devfs/*, include/linux/devfs_fs*.h were removed, The files fs/devfs/*, include/linux/devfs_fs*.h were removed,
along with the assorted devfs function calls throughout the along with the assorted devfs function calls throughout the
kernel tree. kernel tree.
......
...@@ -7,6 +7,7 @@ Description: ...@@ -7,6 +7,7 @@ Description:
to implement sensible device security policies, and its low level to implement sensible device security policies, and its low level
of abstraction that required userspace clients to duplicate much of abstraction that required userspace clients to duplicate much
of the kernel's ieee1394 core functionality. of the kernel's ieee1394 core functionality.
Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of
firewire-core. firewire-core.
......
...@@ -10,4 +10,4 @@ Description: This file was deprecated because there no longer was a way to ...@@ -10,4 +10,4 @@ Description: This file was deprecated because there no longer was a way to
claim just control over a single rfkill instance. claim just control over a single rfkill instance.
This file was scheduled to be removed in 2012, and was removed This file was scheduled to be removed in 2012, and was removed
in 2016. in 2016.
Values: 0: Kernel handles events Values: 0: Kernel handles events
...@@ -8,6 +8,7 @@ Description: ...@@ -8,6 +8,7 @@ Description:
performance issues in its first generation. Any video1394 user had performance issues in its first generation. Any video1394 user had
to use raw1394 + libraw1394 too because video1394 did not provide to use raw1394 + libraw1394 too because video1394 did not provide
asynchronous I/O for device discovery and configuration. asynchronous I/O for device discovery and configuration.
Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of
firewire-core. firewire-core.
......
...@@ -16,6 +16,7 @@ Description: ...@@ -16,6 +16,7 @@ Description:
different scope: different scope:
- The 1394 node which is associated with the file: - The 1394 node which is associated with the file:
- Asynchronous request transmission - Asynchronous request transmission
- Get the Configuration ROM - Get the Configuration ROM
- Query node ID - Query node ID
...@@ -23,6 +24,7 @@ Description: ...@@ -23,6 +24,7 @@ Description:
and local node and local node
- The 1394 bus (i.e. "card") to which the node is attached to: - The 1394 bus (i.e. "card") to which the node is attached to:
- Isochronous stream transmission and reception - Isochronous stream transmission and reception
- Asynchronous stream transmission and reception - Asynchronous stream transmission and reception
- Asynchronous broadcast request transmission - Asynchronous broadcast request transmission
...@@ -35,6 +37,7 @@ Description: ...@@ -35,6 +37,7 @@ Description:
- Bus reset initiation, bus reset event reception - Bus reset initiation, bus reset event reception
- All 1394 buses: - All 1394 buses:
- Allocation of IEEE 1212 address ranges on the local - Allocation of IEEE 1212 address ranges on the local
link layers, reception of inbound requests to such link layers, reception of inbound requests to such
an address range, asynchronous response transmission an address range, asynchronous response transmission
...@@ -59,50 +62,50 @@ Description: ...@@ -59,50 +62,50 @@ Description:
The following file operations are supported: The following file operations are supported:
open(2) open(2)
Currently the only useful flags are O_RDWR. Currently the only useful flags are O_RDWR.
ioctl(2) ioctl(2)
Initiate various actions. Some take immediate effect, others Initiate various actions. Some take immediate effect, others
are performed asynchronously while or after the ioctl returns. are performed asynchronously while or after the ioctl returns.
See the inline documentation in <linux/firewire-cdev.h> for See the inline documentation in <linux/firewire-cdev.h> for
descriptions of all ioctls. descriptions of all ioctls.
poll(2), select(2), epoll_wait(2) etc. poll(2), select(2), epoll_wait(2) etc.
Watch for events to become available to be read. Watch for events to become available to be read.
read(2) read(2)
Receive various events. There are solicited events like Receive various events. There are solicited events like
outbound asynchronous transaction completion or isochronous outbound asynchronous transaction completion or isochronous
buffer completion, and unsolicited events such as bus resets, buffer completion, and unsolicited events such as bus resets,
request reception, or PHY packet reception. Always use a read request reception, or PHY packet reception. Always use a read
buffer which is large enough to receive the largest event that buffer which is large enough to receive the largest event that
could ever arrive. See <linux/firewire-cdev.h> for descriptions could ever arrive. See <linux/firewire-cdev.h> for descriptions
of all event types and for which ioctls affect reception of of all event types and for which ioctls affect reception of
events. events.
mmap(2) mmap(2)
Allocate a DMA buffer for isochronous reception or transmission Allocate a DMA buffer for isochronous reception or transmission
and map it into the process address space. The arguments should and map it into the process address space. The arguments should
be used as follows: addr = NULL, length = the desired buffer be used as follows: addr = NULL, length = the desired buffer
size, i.e. number of packets times size of largest packet, size, i.e. number of packets times size of largest packet,
prot = at least PROT_READ for reception and at least PROT_WRITE prot = at least PROT_READ for reception and at least PROT_WRITE
for transmission, flags = MAP_SHARED, fd = the handle to the for transmission, flags = MAP_SHARED, fd = the handle to the
/dev/fw*, offset = 0. /dev/fw*, offset = 0.
Isochronous reception works in packet-per-buffer fashion except Isochronous reception works in packet-per-buffer fashion except
for multichannel reception which works in buffer-fill mode. for multichannel reception which works in buffer-fill mode.
munmap(2) munmap(2)
Unmap the isochronous I/O buffer from the process address space. Unmap the isochronous I/O buffer from the process address space.
close(2) close(2)
Besides stopping and freeing I/O contexts that were associated Besides stopping and freeing I/O contexts that were associated
with the file descriptor, back out any changes to the local with the file descriptor, back out any changes to the local
nodes' Configuration ROM. Deallocate isochronous channels and nodes' Configuration ROM. Deallocate isochronous channels and
bandwidth at the IRM that were marked for kernel-assisted bandwidth at the IRM that were marked for kernel-assisted
re- and deallocation. re- and deallocation.
Users: libraw1394 Users: libraw1394;
libdc1394 libdc1394;
libhinawa libhinawa;
tools like linux-firewire-utils, fwhack, ... tools like linux-firewire-utils, fwhack, ...
What: /sys/firmware/acpi/pm_profile What: /sys/firmware/acpi/pm_profile
Date: 03-Nov-2011 Date: 03-Nov-2011
KernelVersion: v3.2 KernelVersion: v3.2
Contact: linux-acpi@vger.kernel.org Contact: linux-acpi@vger.kernel.org
Description: The ACPI pm_profile sysfs interface exports the platform Description: The ACPI pm_profile sysfs interface exports the platform
power management (and performance) requirement expectations power management (and performance) requirement expectations
as provided by BIOS. The integer value is directly passed as as provided by BIOS. The integer value is directly passed as
retrieved from the FADT ACPI table. retrieved from the FADT ACPI table.
......
...@@ -6,6 +6,7 @@ Description: Bus scanning interval, microseconds component. ...@@ -6,6 +6,7 @@ Description: Bus scanning interval, microseconds component.
control systems are attached/generate presence for as short as control systems are attached/generate presence for as short as
100 ms - hence the tens-to-hundreds milliseconds scan intervals 100 ms - hence the tens-to-hundreds milliseconds scan intervals
are required. are required.
see Documentation/w1/w1-generic.rst for detailed information. see Documentation/w1/w1-generic.rst for detailed information.
Users: any user space application which wants to know bus scanning Users: any user space application which wants to know bus scanning
interval interval
...@@ -191,6 +191,6 @@ Contact: linux-integrity@vger.kernel.org ...@@ -191,6 +191,6 @@ Contact: linux-integrity@vger.kernel.org
Description: The "tpm_version_major" property shows the TCG spec major version Description: The "tpm_version_major" property shows the TCG spec major version
implemented by the TPM device. implemented by the TPM device.
Example output: Example output::
2 2
...@@ -69,6 +69,7 @@ Description: Controls if typing interrupts output from speakup. With ...@@ -69,6 +69,7 @@ Description: Controls if typing interrupts output from speakup. With
speakup if for example speakup if for example
the say screen command is used before the the say screen command is used before the
entire screen is read. entire screen is read.
With no_interrupt set to one, if the say With no_interrupt set to one, if the say
screen command is used, and one then types on the keyboard, screen command is used, and one then types on the keyboard,
speakup will continue to say the whole screen regardless until speakup will continue to say the whole screen regardless until
...@@ -215,8 +216,10 @@ Description: This file contains names for key states. ...@@ -215,8 +216,10 @@ Description: This file contains names for key states.
Again, these are part of the help system. For instance, if you Again, these are part of the help system. For instance, if you
had pressed speakup + keypad 3, you would hear: had pressed speakup + keypad 3, you would hear:
"speakup keypad 3 is go to bottom edge." "speakup keypad 3 is go to bottom edge."
The speakup key is depressed, so the name of the key state is The speakup key is depressed, so the name of the key state is
speakup. speakup.
This part of the message comes from the states collection. This part of the message comes from the states collection.
What: /sys/accessibility/speakup/i18n/characters What: /sys/accessibility/speakup/i18n/characters
...@@ -297,6 +300,7 @@ KernelVersion: 2.6 ...@@ -297,6 +300,7 @@ KernelVersion: 2.6
Contact: speakup@linux-speakup.org Contact: speakup@linux-speakup.org
Description: Controls if punctuation is spoken by speakup, or by the Description: Controls if punctuation is spoken by speakup, or by the
synthesizer. synthesizer.
For example, speakup speaks ">" as "greater", while For example, speakup speaks ">" as "greater", while
the espeak synthesizer used by the soft driver speaks "greater the espeak synthesizer used by the soft driver speaks "greater
than". Zero lets speakup speak the punctuation. One lets the than". Zero lets speakup speak the punctuation. One lets the
......
...@@ -15,22 +15,28 @@ KernelVersion: 5.2 ...@@ -15,22 +15,28 @@ KernelVersion: 5.2
Description: Description:
The attributes: The attributes:
buffer_size configure the buffer size for this channel buffer_size
configure the buffer size for this channel
subbuffer_size configure the sub-buffer size for this channel subbuffer_size
configure the sub-buffer size for this channel
(needed for synchronous and isochrnous data) (needed for synchronous and isochrnous data)
num_buffers configure number of buffers used for this num_buffers
configure number of buffers used for this
channel channel
datatype configure type of data that will travel over datatype
configure type of data that will travel over
this channel this channel
direction configure whether this link will be an input direction
configure whether this link will be an input
or output or output
dbr_size configure DBR data buffer size (this is used dbr_size
configure DBR data buffer size (this is used
for MediaLB communication only) for MediaLB communication only)
packets_per_xact packets_per_xact
...@@ -39,18 +45,23 @@ Description: ...@@ -39,18 +45,23 @@ Description:
transmitted via USB (this is used for USB transmitted via USB (this is used for USB
communication only) communication only)
device name of the device the link is to be attached to device
name of the device the link is to be attached to
channel name of the channel the link is to be attached to channel
name of the channel the link is to be attached to
comp_params pass parameters needed by some components comp_params
pass parameters needed by some components
create_link write '1' to this attribute to trigger the create_link
write '1' to this attribute to trigger the
creation of the link. In case of speculative creation of the link. In case of speculative
configuration, the creation is post-poned until configuration, the creation is post-poned until
a physical device is being attached to the bus. a physical device is being attached to the bus.
destroy_link write '1' to this attribute to destroy an destroy_link
write '1' to this attribute to destroy an
active link active link
What: /sys/kernel/config/most_video/<link> What: /sys/kernel/config/most_video/<link>
...@@ -59,22 +70,28 @@ KernelVersion: 5.2 ...@@ -59,22 +70,28 @@ KernelVersion: 5.2
Description: Description:
The attributes: The attributes:
buffer_size configure the buffer size for this channel buffer_size
configure the buffer size for this channel
subbuffer_size configure the sub-buffer size for this channel subbuffer_size
configure the sub-buffer size for this channel
(needed for synchronous and isochrnous data) (needed for synchronous and isochrnous data)
num_buffers configure number of buffers used for this num_buffers
configure number of buffers used for this
channel channel
datatype configure type of data that will travel over datatype
configure type of data that will travel over
this channel this channel
direction configure whether this link will be an input direction
configure whether this link will be an input
or output or output
dbr_size configure DBR data buffer size (this is used dbr_size
configure DBR data buffer size (this is used
for MediaLB communication only) for MediaLB communication only)
packets_per_xact packets_per_xact
...@@ -83,18 +100,23 @@ Description: ...@@ -83,18 +100,23 @@ Description:
transmitted via USB (this is used for USB transmitted via USB (this is used for USB
communication only) communication only)
device name of the device the link is to be attached to device
name of the device the link is to be attached to
channel name of the channel the link is to be attached to channel
name of the channel the link is to be attached to
comp_params pass parameters needed by some components comp_params
pass parameters needed by some components
create_link write '1' to this attribute to trigger the create_link
write '1' to this attribute to trigger the
creation of the link. In case of speculative creation of the link. In case of speculative
configuration, the creation is post-poned until configuration, the creation is post-poned until
a physical device is being attached to the bus. a physical device is being attached to the bus.
destroy_link write '1' to this attribute to destroy an destroy_link
write '1' to this attribute to destroy an
active link active link
What: /sys/kernel/config/most_net/<link> What: /sys/kernel/config/most_net/<link>
...@@ -103,22 +125,28 @@ KernelVersion: 5.2 ...@@ -103,22 +125,28 @@ KernelVersion: 5.2
Description: Description:
The attributes: The attributes:
buffer_size configure the buffer size for this channel buffer_size
configure the buffer size for this channel
subbuffer_size configure the sub-buffer size for this channel subbuffer_size
configure the sub-buffer size for this channel
(needed for synchronous and isochrnous data) (needed for synchronous and isochrnous data)
num_buffers configure number of buffers used for this num_buffers
configure number of buffers used for this
channel channel
datatype configure type of data that will travel over datatype
configure type of data that will travel over
this channel this channel
direction configure whether this link will be an input direction
configure whether this link will be an input
or output or output
dbr_size configure DBR data buffer size (this is used dbr_size
configure DBR data buffer size (this is used
for MediaLB communication only) for MediaLB communication only)
packets_per_xact packets_per_xact
...@@ -127,18 +155,23 @@ Description: ...@@ -127,18 +155,23 @@ Description:
transmitted via USB (this is used for USB transmitted via USB (this is used for USB
communication only) communication only)
device name of the device the link is to be attached to device
name of the device the link is to be attached to
channel name of the channel the link is to be attached to channel
name of the channel the link is to be attached to
comp_params pass parameters needed by some components comp_params
pass parameters needed by some components
create_link write '1' to this attribute to trigger the create_link
write '1' to this attribute to trigger the
creation of the link. In case of speculative creation of the link. In case of speculative
configuration, the creation is post-poned until configuration, the creation is post-poned until
a physical device is being attached to the bus. a physical device is being attached to the bus.
destroy_link write '1' to this attribute to destroy an destroy_link
write '1' to this attribute to destroy an
active link active link
What: /sys/kernel/config/most_sound/<card> What: /sys/kernel/config/most_sound/<card>
...@@ -147,7 +180,8 @@ KernelVersion: 5.2 ...@@ -147,7 +180,8 @@ KernelVersion: 5.2
Description: Description:
The attributes: The attributes:
create_card write '1' to this attribute to trigger the create_card
write '1' to this attribute to trigger the
registration of the sound card with the ALSA registration of the sound card with the ALSA
subsystem. subsystem.
...@@ -157,22 +191,28 @@ KernelVersion: 5.2 ...@@ -157,22 +191,28 @@ KernelVersion: 5.2
Description: Description:
The attributes: The attributes:
buffer_size configure the buffer size for this channel buffer_size
configure the buffer size for this channel
subbuffer_size configure the sub-buffer size for this channel subbuffer_size
configure the sub-buffer size for this channel
(needed for synchronous and isochrnous data) (needed for synchronous and isochrnous data)
num_buffers configure number of buffers used for this num_buffers
configure number of buffers used for this
channel channel
datatype configure type of data that will travel over datatype
configure type of data that will travel over
this channel this channel
direction configure whether this link will be an input direction
configure whether this link will be an input
or output or output
dbr_size configure DBR data buffer size (this is used dbr_size
configure DBR data buffer size (this is used
for MediaLB communication only) for MediaLB communication only)
packets_per_xact packets_per_xact
...@@ -181,16 +221,21 @@ Description: ...@@ -181,16 +221,21 @@ Description:
transmitted via USB (this is used for USB transmitted via USB (this is used for USB
communication only) communication only)
device name of the device the link is to be attached to device
name of the device the link is to be attached to
channel name of the channel the link is to be attached to channel
name of the channel the link is to be attached to
comp_params pass parameters needed by some components comp_params
pass parameters needed by some components
create_link write '1' to this attribute to trigger the create_link
write '1' to this attribute to trigger the
creation of the link. In case of speculative creation of the link. In case of speculative
configuration, the creation is post-poned until configuration, the creation is post-poned until
a physical device is being attached to the bus. a physical device is being attached to the bus.
destroy_link write '1' to this attribute to destroy an destroy_link
write '1' to this attribute to destroy an
active link active link
...@@ -4,13 +4,17 @@ KernelVersion: 3.11 ...@@ -4,13 +4,17 @@ 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
...@@ -4,11 +4,13 @@ KernelVersion: 3.11 ...@@ -4,11 +4,13 @@ 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
========== =============================================
...@@ -4,5 +4,7 @@ KernelVersion: 3.13 ...@@ -4,5 +4,7 @@ KernelVersion: 3.13
Description: Description:
The attributes: The attributes:
qlen - depth of loopback queue ======= =======================
buflen - buffer length qlen depth of loopback queue
buflen buffer length
======= =======================
...@@ -4,12 +4,14 @@ KernelVersion: 3.13 ...@@ -4,12 +4,14 @@ KernelVersion: 3.13
Description: Description:
The attributes: The attributes:
stall - Set to permit function to halt bulk endpoints. =========== ==============================================
stall Set to permit function to halt bulk endpoints.
Disabled on some USB devices known not to work Disabled on some USB devices known not to work
correctly. You should set it to true. correctly. You should set it to true.
num_buffers - Number of pipeline buffers. Valid numbers num_buffers Number of pipeline buffers. Valid numbers
are 2..4. Available only if are 2..4. Available only if
CONFIG_USB_GADGET_DEBUG_FILES is set. CONFIG_USB_GADGET_DEBUG_FILES is set.
=========== ==============================================
What: /config/usb-gadget/gadget/functions/mass_storage.name/lun.name What: /config/usb-gadget/gadget/functions/mass_storage.name/lun.name
Date: Oct 2013 Date: Oct 2013
...@@ -17,15 +19,17 @@ KernelVersion: 3.13 ...@@ -17,15 +19,17 @@ KernelVersion: 3.13
Description: Description:
The attributes: The attributes:
file - The path to the backing file for the LUN. =========== ==============================================
file The path to the backing file for the LUN.
Required if LUN is not marked as removable. Required if LUN is not marked as removable.
ro - Flag specifying access to the LUN shall be ro Flag specifying access to the LUN shall be
read-only. This is implied if CD-ROM emulation read-only. This is implied if CD-ROM emulation
is enabled as well as when it was impossible is enabled as well as when it was impossible
to open "filename" in R/W mode. to open "filename" in R/W mode.
removable - Flag specifying that LUN shall be indicated as removable Flag specifying that LUN shall be indicated as
being removable. being removable.
cdrom - Flag specifying that LUN shall be reported as cdrom Flag specifying that LUN shall be reported as
being a CD-ROM. being a CD-ROM.
nofua - Flag specifying that FUA flag nofua Flag specifying that FUA flag
in SCSI WRITE(10,12) in SCSI WRITE(10,12)
=========== ==============================================
...@@ -4,9 +4,11 @@ KernelVersion: 3.19 ...@@ -4,9 +4,11 @@ KernelVersion: 3.19
Description: Description:
The attributes: The attributes:
index - index value for the USB MIDI adapter ========== ====================================
id - ID string for the USB MIDI adapter index index value for the USB MIDI adapter
buflen - MIDI buffer length id ID string for the USB MIDI adapter
qlen - USB read request queue length buflen MIDI buffer length
in_ports - number of MIDI input ports qlen USB read request queue length
out_ports - number of MIDI output ports in_ports number of MIDI input ports
out_ports number of MIDI output ports
========== ====================================
...@@ -4,6 +4,8 @@ KernelVersion: 4.1 ...@@ -4,6 +4,8 @@ KernelVersion: 4.1
Description: Description:
The attributes: The attributes:
pnp_string - Data to be passed to the host in pnp string ========== ===========================================
q_len - Number of requests per endpoint pnp_string Data to be passed to the host in pnp string
q_len Number of requests per endpoint
========== ===========================================
...@@ -4,11 +4,13 @@ KernelVersion: 3.13 ...@@ -4,11 +4,13 @@ KernelVersion: 3.13
Description: Description:
The attributes: The attributes:
pattern - 0 (all zeros), 1 (mod63), 2 (none) ============== ==================================
isoc_interval - 1..16 pattern 0 (all zeros), 1 (mod63), 2 (none)
isoc_maxpacket - 0 - 1023 (fs), 0 - 1024 (hs/ss) isoc_interval 1..16
isoc_mult - 0..2 (hs/ss only) isoc_maxpacket 0 - 1023 (fs), 0 - 1024 (hs/ss)
isoc_maxburst - 0..15 (ss only) isoc_mult 0..2 (hs/ss only)
buflen - buffer length isoc_maxburst 0..15 (ss only)
bulk_qlen - depth of queue for bulk buflen buffer length
iso_qlen - depth of queue for iso bulk_qlen depth of queue for bulk
iso_qlen depth of queue for iso
============== ==================================
...@@ -4,11 +4,13 @@ KernelVersion: 3.11 ...@@ -4,11 +4,13 @@ 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
========== =============================================
...@@ -4,9 +4,11 @@ KernelVersion: 3.18 ...@@ -4,9 +4,11 @@ KernelVersion: 3.18
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
p_ssize playback sample size (bytes)
========= ============================
...@@ -55,7 +55,7 @@ Description: Default output terminal descriptors ...@@ -55,7 +55,7 @@ Description: Default output terminal descriptors
============== ============================================= ============== =============================================
iTerminal index of string descriptor iTerminal index of string descriptor
bSourceID id of the terminal to which this terminal bSourceID id of the terminal to which this terminal
is connected 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
......
...@@ -23,7 +23,7 @@ error injections without having to know the details of the driver-specific ...@@ -23,7 +23,7 @@ error injections without having to know the details of the driver-specific
commands. commands.
Note that the output of 'error-inj' shall be valid as input to 'error-inj'. Note that the output of 'error-inj' shall be valid as input to 'error-inj'.
So this must work: So this must work::
$ cat error-inj >einj.txt $ cat error-inj >einj.txt
$ cat einj.txt >error-inj $ cat einj.txt >error-inj
......
...@@ -20,9 +20,13 @@ Description: Allow the root user to disable/enable in runtime the clock ...@@ -20,9 +20,13 @@ Description: Allow the root user to disable/enable in runtime the clock
The user can supply a bitmask value, each bit represents The user can supply a bitmask value, each bit represents
a different engine to disable/enable its clock gating feature. a different engine to disable/enable its clock gating feature.
The bitmask is composed of 20 bits: The bitmask is composed of 20 bits:
0 - 7 : DMA channels
8 - 11 : MME engines ======= ============
12 - 19 : TPC engines 0 - 7 DMA channels
8 - 11 MME engines
12 - 19 TPC engines
======= ============
The bit's location of a specific engine can be determined The bit's location of a specific engine can be determined
using (1 << GAUDI_ENGINE_ID_*). GAUDI_ENGINE_ID_* values using (1 << GAUDI_ENGINE_ID_*). GAUDI_ENGINE_ID_* values
are defined in uapi habanalabs.h file in enum gaudi_engine_id are defined in uapi habanalabs.h file in enum gaudi_engine_id
...@@ -59,6 +63,7 @@ Description: Allows the root user to read or write directly through the ...@@ -59,6 +63,7 @@ Description: Allows the root user to read or write directly through the
the generic Linux user-space PCI mapping) because the DDR bar the generic Linux user-space PCI mapping) because the DDR bar
is very small compared to the DDR memory and only the driver can is very small compared to the DDR memory and only the driver can
move the bar before and after the transaction. move the bar before and after the transaction.
If the IOMMU is disabled, it also allows the root user to read If the IOMMU is disabled, it also allows the root user to read
or write from the host a device VA of a host mapped memory or write from the host a device VA of a host mapped memory
...@@ -73,6 +78,7 @@ Description: Allows the root user to read or write 64 bit data directly ...@@ -73,6 +78,7 @@ Description: Allows the root user to read or write 64 bit data directly
the generic Linux user-space PCI mapping) because the DDR bar the generic Linux user-space PCI mapping) because the DDR bar
is very small compared to the DDR memory and only the driver can is very small compared to the DDR memory and only the driver can
move the bar before and after the transaction. move the bar before and after the transaction.
If the IOMMU is disabled, it also allows the root user to read If the IOMMU is disabled, it also allows the root user to read
or write from the host a device VA of a host mapped memory or write from the host a device VA of a host mapped memory
......
...@@ -4,42 +4,42 @@ KernelVersion: 3.4 ...@@ -4,42 +4,42 @@ KernelVersion: 3.4
Contact: Kent Yoder <key@linux.vnet.ibm.com> Contact: Kent Yoder <key@linux.vnet.ibm.com>
Description: Description:
These debugfs interfaces are built by the nx-crypto driver, built in These debugfs interfaces are built by the nx-crypto driver, built in
arch/powerpc/crypto/nx. arch/powerpc/crypto/nx.
Error Detection Error Detection
=============== ===============
errors: errors:
- A u32 providing a total count of errors since the driver was loaded. The A u32 providing a total count of errors since the driver was loaded. The
only errors counted here are those returned from the hcall, H_COP_OP. only errors counted here are those returned from the hcall, H_COP_OP.
last_error: last_error:
- The most recent non-zero return code from the H_COP_OP hcall. -EBUSY is not The most recent non-zero return code from the H_COP_OP hcall. -EBUSY is not
recorded here (the hcall will retry until -EBUSY goes away). recorded here (the hcall will retry until -EBUSY goes away).
last_error_pid: last_error_pid:
- The process ID of the process who received the most recent error from the The process ID of the process who received the most recent error from the
hcall. hcall.
Device Use Device Use
========== ==========
aes_bytes: aes_bytes:
- The total number of bytes encrypted using AES in any of the driver's The total number of bytes encrypted using AES in any of the driver's
supported modes. supported modes.
aes_ops: aes_ops:
- The total number of AES operations submitted to the hardware. The total number of AES operations submitted to the hardware.
sha256_bytes: sha256_bytes:
- The total number of bytes hashed by the hardware using SHA-256. The total number of bytes hashed by the hardware using SHA-256.
sha256_ops: sha256_ops:
- The total number of SHA-256 operations submitted to the hardware. The total number of SHA-256 operations submitted to the hardware.
sha512_bytes: sha512_bytes:
- The total number of bytes hashed by the hardware using SHA-512. The total number of bytes hashed by the hardware using SHA-512.
sha512_ops: sha512_ops:
- The total number of SHA-512 operations submitted to the hardware. The total number of SHA-512 operations submitted to the hardware.
...@@ -10,7 +10,7 @@ these files in debugfs: ...@@ -10,7 +10,7 @@ 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::
......
...@@ -2,10 +2,12 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign ...@@ -2,10 +2,12 @@ What: /sys/kernel/debug/turris-mox-rwtm/do_sign
Date: Jun 2020 Date: Jun 2020
KernelVersion: 5.8 KernelVersion: 5.8
Contact: Marek Behún <marek.behun@nic.cz> Contact: Marek Behún <marek.behun@nic.cz>
Description: (W) Description:
Message to sign with the ECDSA private key stored in
=== ===========================================================
(W) Message to sign with the ECDSA private key stored in
device's OTP. The message must be exactly 64 bytes (since device's OTP. The message must be exactly 64 bytes (since
this is intended for SHA-512 hashes). this is intended for SHA-512 hashes).
(R) (R) The resulting signature, 136 bytes. This contains the R and
The resulting signature, 136 bytes. This contains the R and
S values of the ECDSA signature, both in big-endian format. S values of the ECDSA signature, both in big-endian format.
=== ===========================================================
...@@ -27,16 +27,17 @@ Description: ...@@ -27,16 +27,17 @@ Description:
for writing, two for the type and at least a single byte of for writing, two for the type and at least a single byte of
data. data.
Example: Example::
// Request EC info type 3 (EC firmware build date)
// Corresponds with sending type 0x00f0 with // Request EC info type 3 (EC firmware build date)
// MBOX = [38, 00, 03, 00] // Corresponds with sending type 0x00f0 with
$ echo 00 f0 38 00 03 00 > /sys/kernel/debug/wilco_ec/raw // MBOX = [38, 00, 03, 00]
// View the result. The decoded ASCII result "12/21/18" is $ echo 00 f0 38 00 03 00 > /sys/kernel/debug/wilco_ec/raw
// included after the raw hex. // View the result. The decoded ASCII result "12/21/18" is
// Corresponds with MBOX = [00, 00, 31, 32, 2f, 32, 31, 38, ...] // included after the raw hex.
$ cat /sys/kernel/debug/wilco_ec/raw // Corresponds with MBOX = [00, 00, 31, 32, 2f, 32, 31, 38, ...]
00 00 31 32 2f 32 31 2f 31 38 00 38 00 01 00 2f 00 ..12/21/18.8... $ cat /sys/kernel/debug/wilco_ec/raw
00 00 31 32 2f 32 31 2f 31 38 00 38 00 01 00 2f 00 ..12/21/18.8...
Note that the first 16 bytes of the received MBOX[] will be Note that the first 16 bytes of the received MBOX[] will be
printed, even if some of the data is junk, and skipping bytes printed, even if some of the data is junk, and skipping bytes
......
...@@ -10,29 +10,29 @@ Description: ...@@ -10,29 +10,29 @@ Description:
<uapi/linux/wmi.h> <uapi/linux/wmi.h>
1) To perform an SMBIOS call from userspace, you'll need to 1) To perform an SMBIOS call from userspace, you'll need to
first determine the minimum size of the calling interface first determine the minimum size of the calling interface
buffer for your machine. buffer for your machine.
Platforms that contain larger buffers can return larger Platforms that contain larger buffers can return larger
objects from the system firmware. objects from the system firmware.
Commonly this size is either 4k or 32k. Commonly this size is either 4k or 32k.
To determine the size of the buffer read() a u64 dword from To determine the size of the buffer read() a u64 dword from
the WMI character device /dev/wmi/dell-smbios. the WMI character device /dev/wmi/dell-smbios.
2) After you've determined the minimum size of the calling 2) After you've determined the minimum size of the calling
interface buffer, you can allocate a structure that represents interface buffer, you can allocate a structure that represents
the structure documented above. the structure documented above.
3) In the 'length' object store the size of the buffer you 3) In the 'length' object store the size of the buffer you
determined above and allocated. determined above and allocated.
4) In this buffer object, prepare as necessary for the SMBIOS 4) In this buffer object, prepare as necessary for the SMBIOS
call you're interested in. Typically SMBIOS buffers have call you're interested in. Typically SMBIOS buffers have
"class", "select", and "input" defined to values that coincide "class", "select", and "input" defined to values that coincide
with the data you are interested in. with the data you are interested in.
Documenting class/select/input values is outside of the scope Documenting class/select/input values is outside of the scope
of this documentation. Check with the libsmbios project for of this documentation. Check with the libsmbios project for
further documentation on these values. further documentation on these values.
6) Run the call by using ioctl() as described in the header. 6) Run the call by using ioctl() as described in the header.
......
...@@ -12,15 +12,16 @@ Description: ...@@ -12,15 +12,16 @@ Description:
The following file operations are supported: The following file operations are supported:
open(2) open(2)
Currently the only useful flags are O_RDWR. Currently the only useful flags are O_RDWR.
ioctl(2) ioctl(2)
Initiate various actions. Initiate various actions.
See the inline documentation in [include/uapi]<linux/gpio.h>
for descriptions of all ioctls. See the inline documentation in [include/uapi]<linux/gpio.h>
for descriptions of all ioctls.
close(2) close(2)
Stops and free up the I/O contexts that was associated Stops and free up the I/O contexts that was associated
with the file descriptor. with the file descriptor.
Users: TBD Users: TBD
...@@ -35,7 +35,9 @@ Description: ...@@ -35,7 +35,9 @@ Description:
Kernel 5.5+ appends two more fields for flush requests: Kernel 5.5+ appends two more fields for flush requests:
19 - flush requests completed successfully == =====================================
20 - time spent flushing 19 flush requests completed successfully
20 time spent flushing
== =====================================
For more details refer to Documentation/admin-guide/iostats.rst For more details refer to Documentation/admin-guide/iostats.rst
...@@ -14,28 +14,28 @@ Description: ...@@ -14,28 +14,28 @@ Description:
For more details, see Documentation/filesystems/proc.rst For more details, see Documentation/filesystems/proc.rst
and the procfs man page. and the procfs man page.
Typical output looks like this: Typical output looks like this::
00100000-ff709000 ---p 00000000 00:00 0 [rollup] 00100000-ff709000 ---p 00000000 00:00 0 [rollup]
Size: 1192 kB Size: 1192 kB
KernelPageSize: 4 kB KernelPageSize: 4 kB
MMUPageSize: 4 kB MMUPageSize: 4 kB
Rss: 884 kB Rss: 884 kB
Pss: 385 kB Pss: 385 kB
Pss_Anon: 301 kB Pss_Anon: 301 kB
Pss_File: 80 kB Pss_File: 80 kB
Pss_Shmem: 4 kB Pss_Shmem: 4 kB
Shared_Clean: 696 kB Shared_Clean: 696 kB
Shared_Dirty: 0 kB Shared_Dirty: 0 kB
Private_Clean: 120 kB Private_Clean: 120 kB
Private_Dirty: 68 kB Private_Dirty: 68 kB
Referenced: 884 kB Referenced: 884 kB
Anonymous: 68 kB Anonymous: 68 kB
LazyFree: 0 kB LazyFree: 0 kB
AnonHugePages: 0 kB AnonHugePages: 0 kB
ShmemPmdMapped: 0 kB ShmemPmdMapped: 0 kB
Shared_Hugetlb: 0 kB Shared_Hugetlb: 0 kB
Private_Hugetlb: 0 kB Private_Hugetlb: 0 kB
Swap: 0 kB Swap: 0 kB
SwapPss: 0 kB SwapPss: 0 kB
Locked: 385 kB Locked: 385 kB
...@@ -9,25 +9,25 @@ Description: Generic interface to platform dependent persistent storage. ...@@ -9,25 +9,25 @@ Description: Generic interface to platform dependent persistent storage.
provide a generic interface to show records captured in provide a generic interface to show records captured in
the dying moments. In the case of a panic the last part the dying moments. In the case of a panic the last part
of the console log is captured, but other interesting of the console log is captured, but other interesting
data can also be saved. data can also be saved::
# mount -t pstore -o kmsg_bytes=8000 - /sys/fs/pstore # mount -t pstore -o kmsg_bytes=8000 - /sys/fs/pstore
$ ls -l /sys/fs/pstore/ $ ls -l /sys/fs/pstore/
total 0 total 0
-r--r--r-- 1 root root 7896 Nov 30 15:38 dmesg-erst-1 -r--r--r-- 1 root root 7896 Nov 30 15:38 dmesg-erst-1
Different users of this interface will result in different Different users of this interface will result in different
filename prefixes. Currently two are defined: filename prefixes. Currently two are defined:
"dmesg" - saved console log - "dmesg" - saved console log
"mce" - architecture dependent data from fatal h/w error - "mce" - architecture dependent data from fatal h/w error
Once the information in a file has been read, removing Once the information in a file has been read, removing
the file will signal to the underlying persistent storage the file will signal to the underlying persistent storage
device that it can reclaim the space for later re-use. device that it can reclaim the space for later re-use::
$ rm /sys/fs/pstore/dmesg-erst-1 $ rm /sys/fs/pstore/dmesg-erst-1
The expectation is that all files in /sys/fs/pstore/ The expectation is that all files in /sys/fs/pstore/
will be saved elsewhere and erased from persistent store will be saved elsewhere and erased from persistent store
...@@ -44,4 +44,3 @@ Description: Generic interface to platform dependent persistent storage. ...@@ -44,4 +44,3 @@ Description: Generic interface to platform dependent persistent storage.
backends are available, the preferred backend may be backends are available, the preferred backend may be
set by passing the pstore.backend= argument to the kernel at set by passing the pstore.backend= argument to the kernel at
boot time. boot time.
...@@ -9,9 +9,9 @@ Description: To unmap a volume, "normal" or "force" has to be written to: ...@@ -9,9 +9,9 @@ Description: To unmap a volume, "normal" or "force" has to be written to:
is using the device. When "force" is used, the device is also unmapped is using the device. When "force" is used, the device is also unmapped
when device is in use. All I/Os that are in progress will fail. when device is in use. All I/Os that are in progress will fail.
Example: Example::
# echo "normal" > /sys/block/rnbd0/rnbd/unmap_device # echo "normal" > /sys/block/rnbd0/rnbd/unmap_device
What: /sys/block/rnbd<N>/rnbd/state What: /sys/block/rnbd<N>/rnbd/state
Date: Feb 2020 Date: Feb 2020
......
...@@ -5,6 +5,7 @@ Description: ...@@ -5,6 +5,7 @@ Description:
This attribute indicates the full path of ACPI namespace This attribute indicates the full path of ACPI namespace
object associated with the device object. For example, object associated with the device object. For example,
\_SB_.PCI0. \_SB_.PCI0.
This file is not present for device objects representing This file is not present for device objects representing
fixed ACPI hardware features (like power and sleep fixed ACPI hardware features (like power and sleep
buttons). buttons).
......
...@@ -4,7 +4,10 @@ KernelVersion: 3.19 ...@@ -4,7 +4,10 @@ KernelVersion: 3.19
Contact: Mathieu Poirier <mathieu.poirier@linaro.org> Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
Description: (RW) Add/remove a sink from a trace path. There can be multiple Description: (RW) Add/remove a sink from a trace path. There can be multiple
source for a single sink. source for a single sink.
ex: echo 1 > /sys/bus/coresight/devices/20010000.etb/enable_sink
ex::
echo 1 > /sys/bus/coresight/devices/20010000.etb/enable_sink
What: /sys/bus/coresight/devices/<memory_map>.etb/trigger_cntr What: /sys/bus/coresight/devices/<memory_map>.etb/trigger_cntr
Date: November 2014 Date: November 2014
......
...@@ -20,6 +20,7 @@ Contact: Cornelia Huck <cornelia.huck@de.ibm.com> ...@@ -20,6 +20,7 @@ Contact: Cornelia Huck <cornelia.huck@de.ibm.com>
Description: Contains the ids of the channel paths used by this Description: Contains the ids of the channel paths used by this
subchannel, as reported by the channel subsystem subchannel, as reported by the channel subsystem
during subchannel recognition. during subchannel recognition.
Note: This is an I/O-subchannel specific attribute. Note: This is an I/O-subchannel specific attribute.
Users: s390-tools, HAL Users: s390-tools, HAL
...@@ -31,6 +32,7 @@ Description: Contains the PIM/PAM/POM values, as reported by the ...@@ -31,6 +32,7 @@ Description: Contains the PIM/PAM/POM values, as reported by the
channel subsystem when last queried by the common I/O channel subsystem when last queried by the common I/O
layer (this implies that this attribute is not necessarily layer (this implies that this attribute is not necessarily
in sync with the values current in the channel subsystem). in sync with the values current in the channel subsystem).
Note: This is an I/O-subchannel specific attribute. Note: This is an I/O-subchannel specific attribute.
Users: s390-tools, HAL Users: s390-tools, HAL
...@@ -53,6 +55,7 @@ Description: This file allows the driver for a device to be specified. When ...@@ -53,6 +55,7 @@ Description: This file allows the driver for a device to be specified. When
opt-out of driver binding using a driver_override name such as opt-out of driver binding using a driver_override name such as
"none". Only a single driver may be specified in the override, "none". Only a single driver may be specified in the override,
there is no support for parsing delimiters. there is no support for parsing delimiters.
Note that unlike the mechanism of the same name for pci, this Note that unlike the mechanism of the same name for pci, this
file does not allow to override basic matching rules. I.e., file does not allow to override basic matching rules. I.e.,
the driver must still match the subchannel type of the device. the driver must still match the subchannel type of the device.
...@@ -4,6 +4,7 @@ KernelVersion: 5.10 ...@@ -4,6 +4,7 @@ KernelVersion: 5.10
Contact: Xu Yilun <yilun.xu@intel.com> Contact: Xu Yilun <yilun.xu@intel.com>
Description: Read-only. It returns type of DFL FIU of the device. Now DFL Description: Read-only. It returns type of DFL FIU of the device. Now DFL
supports 2 FIU types, 0 for FME, 1 for PORT. supports 2 FIU types, 0 for FME, 1 for PORT.
Format: 0x%x Format: 0x%x
What: /sys/bus/dfl/devices/dfl_dev.X/feature_id What: /sys/bus/dfl/devices/dfl_dev.X/feature_id
...@@ -12,4 +13,5 @@ KernelVersion: 5.10 ...@@ -12,4 +13,5 @@ KernelVersion: 5.10
Contact: Xu Yilun <yilun.xu@intel.com> Contact: Xu Yilun <yilun.xu@intel.com>
Description: Read-only. It returns feature identifier local to its DFL FIU Description: Read-only. It returns feature identifier local to its DFL FIU
type. type.
Format: 0x%x Format: 0x%x
...@@ -7,7 +7,7 @@ Description: Read-only. Attribute group to describe the magic bits ...@@ -7,7 +7,7 @@ Description: Read-only. Attribute group to describe the magic bits
Each attribute under this group defines a bit range of the Each attribute under this group defines a bit range of the
perf_event_attr.config. All supported attributes are listed perf_event_attr.config. All supported attributes are listed
below. below::
chip = "config:16-31" chip = "config:16-31"
core = "config:16-31" core = "config:16-31"
...@@ -16,9 +16,9 @@ Description: Read-only. Attribute group to describe the magic bits ...@@ -16,9 +16,9 @@ Description: Read-only. Attribute group to describe the magic bits
offset = "config:32-63" offset = "config:32-63"
vcpu = "config:16-31" vcpu = "config:16-31"
For example, For example::
PM_PB_CYC = "domain=1,offset=0x80,chip=?,lpar=0x0" PM_PB_CYC = "domain=1,offset=0x80,chip=?,lpar=0x0"
In this event, '?' after chip specifies that In this event, '?' after chip specifies that
this value will be provided by user while running this event. this value will be provided by user while running this event.
......
...@@ -7,7 +7,7 @@ Description: Read-only. Attribute group to describe the magic bits ...@@ -7,7 +7,7 @@ Description: Read-only. Attribute group to describe the magic bits
Each attribute under this group defines a bit range of the Each attribute under this group defines a bit range of the
perf_event_attr.config. All supported attributes are listed perf_event_attr.config. All supported attributes are listed
below. below::
counter_info_version = "config:16-23" counter_info_version = "config:16-23"
length = "config:24-31" length = "config:24-31"
...@@ -20,9 +20,9 @@ Description: Read-only. Attribute group to describe the magic bits ...@@ -20,9 +20,9 @@ Description: Read-only. Attribute group to describe the magic bits
secondary_index = "config:0-15" secondary_index = "config:0-15"
starting_index = "config:32-63" starting_index = "config:32-63"
For example, For example::
processor_core_utilization_instructions_completed = "request=0x94, processor_core_utilization_instructions_completed = "request=0x94,
phys_processor_idx=?,counter_info_version=0x8, phys_processor_idx=?,counter_info_version=0x8,
length=8,offset=0x18" length=8,offset=0x18"
...@@ -36,6 +36,7 @@ Description: ...@@ -36,6 +36,7 @@ Description:
'0' if the hypervisor is configured to forbid access to event '0' if the hypervisor is configured to forbid access to event
counters being accumulated by other guests and to physical counters being accumulated by other guests and to physical
domain event counters. domain event counters.
'1' if that access is allowed. '1' if that access is allowed.
What: /sys/bus/event_source/devices/hv_gpci/interface/ga What: /sys/bus/event_source/devices/hv_gpci/interface/ga
......
...@@ -3,16 +3,19 @@ Date: August 2012 ...@@ -3,16 +3,19 @@ Date: August 2012
KernelVersion: TBD KernelVersion: TBD
Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
Description: The FCoE bus. Attributes in this directory are control interfaces. Description: The FCoE bus. Attributes in this directory are control interfaces.
Attributes: Attributes:
ctlr_create: 'FCoE Controller' instance creation interface. Writing an ctlr_create:
'FCoE Controller' instance creation interface. Writing an
<ifname> to this file will allocate and populate sysfs with a <ifname> to this file will allocate and populate sysfs with a
fcoe_ctlr_device (ctlr_X). The user can then configure any fcoe_ctlr_device (ctlr_X). The user can then configure any
per-port settings and finally write to the fcoe_ctlr_device's per-port settings and finally write to the fcoe_ctlr_device's
'start' attribute to begin the kernel's discovery and login 'start' attribute to begin the kernel's discovery and login
process. process.
ctlr_destroy: 'FCoE Controller' instance removal interface. Writing a ctlr_destroy:
'FCoE Controller' instance removal interface. Writing a
fcoe_ctlr_device's sysfs name to this file will log the fcoe_ctlr_device's sysfs name to this file will log the
fcoe_ctlr_device out of the fabric or otherwise connected fcoe_ctlr_device out of the fabric or otherwise connected
FCoE devices. It will also free all kernel memory allocated FCoE devices. It will also free all kernel memory allocated
...@@ -32,11 +35,13 @@ Description: 'FCoE Controller' instances on the fcoe bus. ...@@ -32,11 +35,13 @@ Description: 'FCoE Controller' instances on the fcoe bus.
Attributes: Attributes:
fcf_dev_loss_tmo: Device loss timeout period (see below). Changing fcf_dev_loss_tmo:
Device loss timeout period (see below). Changing
this value will change the dev_loss_tmo for all this value will change the dev_loss_tmo for all
FCFs discovered by this controller. FCFs discovered by this controller.
mode: Display or change the FCoE Controller's mode. Possible mode:
Display or change the FCoE Controller's mode. Possible
modes are 'Fabric' and 'VN2VN'. If a FCoE Controller modes are 'Fabric' and 'VN2VN'. If a FCoE Controller
is started in 'Fabric' mode then FIP FCF discovery is is started in 'Fabric' mode then FIP FCF discovery is
initiated and ultimately a fabric login is attempted. initiated and ultimately a fabric login is attempted.
...@@ -44,23 +49,30 @@ Attributes: ...@@ -44,23 +49,30 @@ Attributes:
FIP VN2VN discovery and login is performed. A FCoE FIP VN2VN discovery and login is performed. A FCoE
Controller only supports one mode at a time. Controller only supports one mode at a time.
enabled: Whether an FCoE controller is enabled or disabled. enabled:
Whether an FCoE controller is enabled or disabled.
0 if disabled, 1 if enabled. Writing either 0 or 1 0 if disabled, 1 if enabled. Writing either 0 or 1
to this file will enable or disable the FCoE controller. to this file will enable or disable the FCoE controller.
lesb/link_fail: Link Error Status Block (LESB) link failure count. lesb/link_fail:
Link Error Status Block (LESB) link failure count.
lesb/vlink_fail: Link Error Status Block (LESB) virtual link lesb/vlink_fail:
Link Error Status Block (LESB) virtual link
failure count. failure count.
lesb/miss_fka: Link Error Status Block (LESB) missed FCoE lesb/miss_fka:
Link Error Status Block (LESB) missed FCoE
Initialization Protocol (FIP) Keep-Alives (FKA). Initialization Protocol (FIP) Keep-Alives (FKA).
lesb/symb_err: Link Error Status Block (LESB) symbolic error count. lesb/symb_err:
Link Error Status Block (LESB) symbolic error count.
lesb/err_block: Link Error Status Block (LESB) block error count. lesb/err_block:
Link Error Status Block (LESB) block error count.
lesb/fcs_error: Link Error Status Block (LESB) Fibre Channel lesb/fcs_error:
Link Error Status Block (LESB) Fibre Channel
Services error count. Services error count.
Notes: ctlr_X (global increment starting at 0) Notes: ctlr_X (global increment starting at 0)
...@@ -75,31 +87,41 @@ Description: 'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel ...@@ -75,31 +87,41 @@ Description: 'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel
Fibre Channel frames into a FC fabric. It can also take Fibre Channel frames into a FC fabric. It can also take
outbound FC frames and pack them in Ethernet packets to outbound FC frames and pack them in Ethernet packets to
be sent to their destination on the Ethernet segment. be sent to their destination on the Ethernet segment.
Attributes: Attributes:
fabric_name: Identifies the fabric that the FCF services. fabric_name:
Identifies the fabric that the FCF services.
switch_name: Identifies the FCF. switch_name:
Identifies the FCF.
priority: The switch's priority amongst other FCFs on the same priority:
The switch's priority amongst other FCFs on the same
fabric. fabric.
selected: 1 indicates that the switch has been selected for use; selected:
1 indicates that the switch has been selected for use;
0 indicates that the switch will not be used. 0 indicates that the switch will not be used.
fc_map: The Fibre Channel MAP fc_map:
The Fibre Channel MAP
vfid: The Virtual Fabric ID vfid:
The Virtual Fabric ID
mac: The FCF's MAC address mac:
The FCF's MAC address
fka_period: The FIP Keep-Alive period fka_period:
The FIP Keep-Alive period
fabric_state: The internal kernel state fabric_state: The internal kernel state
"Unknown" - Initialization value
"Disconnected" - No link to the FCF/fabric - "Unknown" - Initialization value
"Connected" - Host is connected to the FCF - "Disconnected" - No link to the FCF/fabric
"Deleted" - FCF is being removed from the system - "Connected" - Host is connected to the FCF
- "Deleted" - FCF is being removed from the system
dev_loss_tmo: The device loss timeout period for this FCF. dev_loss_tmo: The device loss timeout period for this FCF.
......
...@@ -6,8 +6,10 @@ Description: ...@@ -6,8 +6,10 @@ Description:
the driver to attempt to bind to the device found at the driver to attempt to bind to the device found at
this location. The format for the location is Object.Id this location. The format for the location is Object.Id
and is the same as found in /sys/bus/fsl-mc/devices/. and is the same as found in /sys/bus/fsl-mc/devices/.
For example:
# echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/bind For example::
# echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/bind
What: /sys/bus/fsl-mc/drivers/.../unbind What: /sys/bus/fsl-mc/drivers/.../unbind
Date: December 2016 Date: December 2016
...@@ -17,5 +19,7 @@ Description: ...@@ -17,5 +19,7 @@ Description:
driver to attempt to unbind from the device found at driver to attempt to unbind from the device found at
this location. The format for the location is Object.Id this location. The format for the location is Object.Id
and is the same as found in /sys/bus/fsl-mc/devices/. and is the same as found in /sys/bus/fsl-mc/devices/.
For example:
# echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/unbind For example::
# echo dpni.2 > /sys/bus/fsl-mc/drivers/fsl_dpaa2_eth/unbind
...@@ -3,19 +3,25 @@ Date: February 2011 ...@@ -3,19 +3,25 @@ Date: February 2011
Contact: Minkyu Kang <mk7.kang@samsung.com> Contact: Minkyu Kang <mk7.kang@samsung.com>
Description: Description:
show what device is attached show what device is attached
NONE - no device
USB - USB device is attached ======= ======================
UART - UART is attached NONE no device
CHARGER - Charger is attaced USB USB device is attached
JIG - JIG is attached UART UART is attached
CHARGER Charger is attaced
JIG JIG is attached
======= ======================
What: /sys/bus/i2c/devices/.../switch What: /sys/bus/i2c/devices/.../switch
Date: February 2011 Date: February 2011
Contact: Minkyu Kang <mk7.kang@samsung.com> Contact: Minkyu Kang <mk7.kang@samsung.com>
Description: Description:
show or set the state of manual switch show or set the state of manual switch
VAUDIO - switch to VAUDIO path
UART - switch to UART path ======= ==============================
AUDIO - switch to AUDIO path VAUDIO switch to VAUDIO path
DHOST - switch to DHOST path UART switch to UART path
AUTO - switch automatically by device AUDIO switch to AUDIO path
DHOST switch to DHOST path
AUTO switch automatically by device
======= ==============================
...@@ -84,6 +84,7 @@ Description: ...@@ -84,6 +84,7 @@ Description:
by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl". by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
See the I3C specification for more details about these HDR See the I3C specification for more details about these HDR
modes. modes.
This entry describes the HDRCAP of the master controller This entry describes the HDRCAP of the master controller
driving the bus. driving the bus.
...@@ -135,6 +136,7 @@ Description: ...@@ -135,6 +136,7 @@ Description:
Expose the HDR (High Data Rate) capabilities of a device. Expose the HDR (High Data Rate) capabilities of a device.
Returns a list of supported HDR mode, each element is separated Returns a list of supported HDR mode, each element is separated
by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl". by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
See the I3C specification for more details about these HDR See the I3C specification for more details about these HDR
modes. modes.
......
...@@ -15,6 +15,7 @@ Description: ...@@ -15,6 +15,7 @@ Description:
based on hardware generated events (e.g. data ready) or based on hardware generated events (e.g. data ready) or
provided by a separate driver for other hardware (e.g. provided by a separate driver for other hardware (e.g.
periodic timer, GPIO or high resolution timer). periodic timer, GPIO or high resolution timer).
Contains trigger type specific elements. These do not Contains trigger type specific elements. These do not
generalize well and hence are not documented in this file. generalize well and hence are not documented in this file.
X is the IIO index of the trigger. X is the IIO index of the trigger.
...@@ -666,6 +667,7 @@ Description: ...@@ -666,6 +667,7 @@ Description:
<type>[Y][_name]_<raw|input>_thresh_falling_value may take <type>[Y][_name]_<raw|input>_thresh_falling_value may take
different values, but the device can only enable both thresholds different values, but the device can only enable both thresholds
or neither. or neither.
Note the driver will assume the last p events requested are Note the driver will assume the last p events requested are
to be enabled where p is how many it supports (which may vary to be enabled where p is how many it supports (which may vary
depending on the exact set requested. So if you want to be depending on the exact set requested. So if you want to be
...@@ -720,6 +722,7 @@ Description: ...@@ -720,6 +722,7 @@ Description:
<type>[Y][_name]_<raw|input>_roc_falling_value may take <type>[Y][_name]_<raw|input>_roc_falling_value may take
different values, but the device can only enable both rate of different values, but the device can only enable both rate of
change thresholds or neither. change thresholds or neither.
Note the driver will assume the last p events requested are Note the driver will assume the last p events requested are
to be enabled where p is however many it supports (which may to be enabled where p is however many it supports (which may
vary depending on the exact set requested. So if you want to be vary depending on the exact set requested. So if you want to be
...@@ -775,9 +778,11 @@ Description: ...@@ -775,9 +778,11 @@ Description:
Specifies the value of threshold that the device is comparing Specifies the value of threshold that the device is comparing
against for the events enabled by against for the events enabled by
<type>Y[_name]_thresh[_rising|falling]_en. <type>Y[_name]_thresh[_rising|falling]_en.
If separate attributes exist for the two directions, but If separate attributes exist for the two directions, but
direction is not specified for this attribute, then a single direction is not specified for this attribute, then a single
threshold value applies to both directions. threshold value applies to both directions.
The raw or input element of the name indicates whether the The raw or input element of the name indicates whether the
value is in raw device units or in processed units (as _raw value is in raw device units or in processed units (as _raw
and _input do on sysfs direct channel read attributes). and _input do on sysfs direct channel read attributes).
...@@ -860,6 +865,7 @@ Description: ...@@ -860,6 +865,7 @@ Description:
If separate attributes exist for the two directions, but If separate attributes exist for the two directions, but
direction is not specified for this attribute, then a single direction is not specified for this attribute, then a single
hysteresis value applies to both directions. hysteresis value applies to both directions.
For falling events the hysteresis is added to the _value attribute for For falling events the hysteresis is added to the _value attribute for
this event to get the upper threshold for when the event goes back to this event to get the upper threshold for when the event goes back to
normal, for rising events the hysteresis is subtracted from the _value normal, for rising events the hysteresis is subtracted from the _value
...@@ -906,6 +912,7 @@ Description: ...@@ -906,6 +912,7 @@ Description:
Specifies the value of rate of change threshold that the Specifies the value of rate of change threshold that the
device is comparing against for the events enabled by device is comparing against for the events enabled by
<type>[Y][_name]_roc[_rising|falling]_en. <type>[Y][_name]_roc[_rising|falling]_en.
If separate attributes exist for the two directions, If separate attributes exist for the two directions,
but direction is not specified for this attribute, but direction is not specified for this attribute,
then a single threshold value applies to both directions. then a single threshold value applies to both directions.
...@@ -1305,6 +1312,7 @@ Description: ...@@ -1305,6 +1312,7 @@ Description:
Proximity measurement indicating that some Proximity measurement indicating that some
object is near the sensor, usually by observing object is near the sensor, usually by observing
reflectivity of infrared or ultrasound emitted. reflectivity of infrared or ultrasound emitted.
Often these sensors are unit less and as such conversion Often these sensors are unit less and as such conversion
to SI units is not possible. Higher proximity measurements to SI units is not possible. Higher proximity measurements
indicate closer objects, and vice versa. Units after indicate closer objects, and vice versa. Units after
...@@ -1450,9 +1458,12 @@ Contact: linux-iio@vger.kernel.org ...@@ -1450,9 +1458,12 @@ Contact: linux-iio@vger.kernel.org
Description: Description:
A single positive integer specifying the maximum number of scan A single positive integer specifying the maximum number of scan
elements to wait for. elements to wait for.
Poll will block until the watermark is reached. Poll will block until the watermark is reached.
Blocking read will wait until the minimum between the requested Blocking read will wait until the minimum between the requested
read amount or the low water mark is available. read amount or the low water mark is available.
Non-blocking read will retrieve the available samples from the Non-blocking read will retrieve the available samples from the
buffer even if there are less samples then watermark level. This buffer even if there are less samples then watermark level. This
allows the application to block on poll with a timeout and read allows the application to block on poll with a timeout and read
...@@ -1481,11 +1492,13 @@ Description: ...@@ -1481,11 +1492,13 @@ Description:
device settings allows it (e.g. if a trigger is set that samples device settings allows it (e.g. if a trigger is set that samples
data differently that the hardware fifo does then hardware fifo data differently that the hardware fifo does then hardware fifo
will not enabled). will not enabled).
If the hardware fifo is enabled and the level of the hardware If the hardware fifo is enabled and the level of the hardware
fifo reaches the hardware fifo watermark level the device will fifo reaches the hardware fifo watermark level the device will
flush its hardware fifo to the device buffer. Doing a non flush its hardware fifo to the device buffer. Doing a non
blocking read on the device when no samples are present in the blocking read on the device when no samples are present in the
device buffer will also force a flush. device buffer will also force a flush.
When the hardware fifo is enabled there is no need to use a When the hardware fifo is enabled there is no need to use a
trigger to use buffer mode since the watermark settings trigger to use buffer mode since the watermark settings
guarantees that the hardware fifo is flushed to the device guarantees that the hardware fifo is flushed to the device
...@@ -1523,6 +1536,7 @@ Description: ...@@ -1523,6 +1536,7 @@ Description:
A single positive integer specifying the minimum watermark level A single positive integer specifying the minimum watermark level
for the hardware fifo of this device. If the device does not for the hardware fifo of this device. If the device does not
have a hardware fifo this entry is not present. have a hardware fifo this entry is not present.
If the user sets buffer/watermark to a value less than this one, If the user sets buffer/watermark to a value less than this one,
then the hardware watermark will remain unset. then the hardware watermark will remain unset.
...@@ -1533,6 +1547,7 @@ Description: ...@@ -1533,6 +1547,7 @@ Description:
A single positive integer specifying the maximum watermark level A single positive integer specifying the maximum watermark level
for the hardware fifo of this device. If the device does not for the hardware fifo of this device. If the device does not
have a hardware fifo this entry is not present. have a hardware fifo this entry is not present.
If the user sets buffer/watermark to a value greater than this If the user sets buffer/watermark to a value greater than this
one, then the hardware watermark will be capped at this value. one, then the hardware watermark will be capped at this value.
...@@ -1544,6 +1559,7 @@ Description: ...@@ -1544,6 +1559,7 @@ Description:
levels for the hardware fifo. This entry is optional and if it levels for the hardware fifo. This entry is optional and if it
is not present it means that all the values between is not present it means that all the values between
hwfifo_watermark_min and hwfifo_watermark_max are supported. hwfifo_watermark_min and hwfifo_watermark_max are supported.
If the user sets buffer/watermark to a value greater than If the user sets buffer/watermark to a value greater than
hwfifo_watermak_min but not equal to any of the values in this hwfifo_watermak_min but not equal to any of the values in this
list, the driver will chose an appropriate value for the list, the driver will chose an appropriate value for the
...@@ -1605,7 +1621,8 @@ KernelVersion: 4.1.0 ...@@ -1605,7 +1621,8 @@ KernelVersion: 4.1.0
Contact: linux-iio@vger.kernel.org Contact: linux-iio@vger.kernel.org
Description: Description:
'1' (enable) or '0' (disable) specifying the enable '1' (enable) or '0' (disable) specifying the enable
of heater function. Same reading values apply of heater function. Same reading values apply.
This ABI is especially applicable for humidity sensors This ABI is especially applicable for humidity sensors
to heatup the device and get rid of any condensation to heatup the device and get rid of any condensation
in some humidity environment in some humidity environment
......
...@@ -19,9 +19,11 @@ Description: ...@@ -19,9 +19,11 @@ Description:
is separately set for "GND-Open" and "Supply-Open" modes. is separately set for "GND-Open" and "Supply-Open" modes.
Channels 0..31 have common low threshold values, but could have different Channels 0..31 have common low threshold values, but could have different
sensing_modes. sensing_modes.
The low voltage threshold range is between 2..21V. The low voltage threshold range is between 2..21V.
Hysteresis between low and high thresholds can not be lower then 2 and Hysteresis between low and high thresholds can not be lower then 2 and
can not be odd. can not be odd.
If falling threshold results hysteresis to odd value then rising If falling threshold results hysteresis to odd value then rising
threshold is automatically subtracted by one. threshold is automatically subtracted by one.
...@@ -34,10 +36,13 @@ Description: ...@@ -34,10 +36,13 @@ Description:
this value then the threshold rising event is pushed. this value then the threshold rising event is pushed.
Depending on in_voltageY_sensing_mode the high voltage threshold Depending on in_voltageY_sensing_mode the high voltage threshold
is separately set for "GND-Open" and "Supply-Open" modes. is separately set for "GND-Open" and "Supply-Open" modes.
Channels 0..31 have common high threshold values, but could have different Channels 0..31 have common high threshold values, but could have different
sensing_modes. sensing_modes.
The high voltage threshold range is between 3..22V. The high voltage threshold range is between 3..22V.
Hysteresis between low and high thresholds can not be lower then 2 and Hysteresis between low and high thresholds can not be lower then 2 and
can not be odd. can not be odd.
If rising threshold results hysteresis to odd value then falling If rising threshold results hysteresis to odd value then falling
threshold is automatically appended by one. threshold is automatically appended by one.
...@@ -5,10 +5,13 @@ Description: ...@@ -5,10 +5,13 @@ Description:
The STM32 ADC can be configured to use external trigger sources The STM32 ADC can be configured to use external trigger sources
(e.g. timers, pwm or exti gpio). Then, it can be tuned to start (e.g. timers, pwm or exti gpio). Then, it can be tuned to start
conversions on external trigger by either: conversions on external trigger by either:
- "rising-edge" - "rising-edge"
- "falling-edge" - "falling-edge"
- "both-edges". - "both-edges".
Reading returns current trigger polarity. Reading returns current trigger polarity.
Writing value before enabling conversions sets trigger polarity. Writing value before enabling conversions sets trigger polarity.
What: /sys/bus/iio/devices/triggerX/trigger_polarity_available What: /sys/bus/iio/devices/triggerX/trigger_polarity_available
......
...@@ -15,8 +15,11 @@ Description: ...@@ -15,8 +15,11 @@ Description:
first object echoed in meters. Default value is 6.020. first object echoed in meters. Default value is 6.020.
This setting limits the time the driver is waiting for a This setting limits the time the driver is waiting for a
echo. echo.
Showing the range of available values is represented as the Showing the range of available values is represented as the
minimum value, the step and the maximum value, all enclosed minimum value, the step and the maximum value, all enclosed
in square brackets. in square brackets.
Example:
[0.043 0.043 11.008] Example::
[0.043 0.043 11.008]
...@@ -8,7 +8,9 @@ KernelVersion: 3.4.0 ...@@ -8,7 +8,9 @@ KernelVersion: 3.4.0
Contact: linux-iio@vger.kernel.org Contact: linux-iio@vger.kernel.org
Description: Description:
Reading returns either '1' or '0'. Reading returns either '1' or '0'.
'1' means that the clock in question is present. '1' means that the clock in question is present.
'0' means that the clock is missing. '0' means that the clock is missing.
What: /sys/bus/iio/devices/iio:deviceX/pllY_locked What: /sys/bus/iio/devices/iio:deviceX/pllY_locked
......
...@@ -27,12 +27,12 @@ What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_name ...@@ -27,12 +27,12 @@ What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_name
KernelVersion: KernelVersion:
Contact: linux-iio@vger.kernel.org Contact: linux-iio@vger.kernel.org
Description: Description:
Reading returns the datasheet name for channel Y: Reading returns the datasheet name for channel Y::
out_altvoltage0_name: RF8x out_altvoltage0_name: RF8x
out_altvoltage1_name: RFAUX8x out_altvoltage1_name: RFAUX8x
out_altvoltage2_name: RF16x out_altvoltage2_name: RF16x
out_altvoltage3_name: RF32x out_altvoltage3_name: RF32x
What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown
KernelVersion: KernelVersion:
......
...@@ -6,10 +6,14 @@ Description: ...@@ -6,10 +6,14 @@ Description:
Get measured values from the ADC for these stages. Y is the Get measured values from the ADC for these stages. Y is the
specific stage number corresponding to datasheet stage names specific stage number corresponding to datasheet stage names
as follows: as follows:
1 -> LED2
2 -> ALED2/LED3 == ==========
3 -> LED1 1 LED2
4 -> ALED1/LED4 2 ALED2/LED3
3 LED1
4 ALED1/LED4
== ==========
Note that channels 5 and 6 represent LED2-ALED2 and LED1-ALED1 Note that channels 5 and 6 represent LED2-ALED2 and LED1-ALED1
respectively which simply helper channels containing the respectively which simply helper channels containing the
calculated difference in the value of stage 1 - 2 and 3 - 4. calculated difference in the value of stage 1 - 2 and 3 - 4.
......
...@@ -15,5 +15,7 @@ Description: ...@@ -15,5 +15,7 @@ Description:
Scheme 0 has wider dynamic range, Scheme 1 proximity detection Scheme 0 has wider dynamic range, Scheme 1 proximity detection
is less affected by the ambient IR noise variation. is less affected by the ambient IR noise variation.
0 Sensing IR from LED and ambient == =============================================
1 Sensing IR from LED with ambient IR rejection 0 Sensing IR from LED and ambient
1 Sensing IR from LED with ambient IR rejection
== =============================================
...@@ -10,10 +10,13 @@ Date: June 2015 ...@@ -10,10 +10,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: (RO) Output port type: Description: (RO) Output port type:
0: not present,
1: MSU (Memory Storage Unit) == =========================
2: CTP (Common Trace Port) 0 not present,
4: PTI (MIPI PTI). 1 MSU (Memory Storage Unit)
2 CTP (Common Trace Port)
4 PTI (MIPI PTI).
== =========================
What: /sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_drop What: /sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_drop
Date: June 2015 Date: June 2015
......
...@@ -11,19 +11,26 @@ Description: ...@@ -11,19 +11,26 @@ Description:
at 'Documentation/powerpc/papr_hcalls.rst' . Below are at 'Documentation/powerpc/papr_hcalls.rst' . Below are
the flags reported in this sysfs file: the flags reported in this sysfs file:
* "not_armed" : Indicates that NVDIMM contents will not * "not_armed"
Indicates that NVDIMM contents will not
survive a power cycle. survive a power cycle.
* "flush_fail" : Indicates that NVDIMM contents * "flush_fail"
Indicates that NVDIMM contents
couldn't be flushed during last couldn't be flushed during last
shut-down event. shut-down event.
* "restore_fail": Indicates that NVDIMM contents * "restore_fail"
Indicates that NVDIMM contents
couldn't be restored during NVDIMM couldn't be restored during NVDIMM
initialization. initialization.
* "encrypted" : NVDIMM contents are encrypted. * "encrypted"
* "smart_notify": There is health event for the NVDIMM. NVDIMM contents are encrypted.
* "scrubbed" : Indicating that contents of the * "smart_notify"
There is health event for the NVDIMM.
* "scrubbed"
Indicating that contents of the
NVDIMM have been scrubbed. NVDIMM have been scrubbed.
* "locked" : Indicating that NVDIMM contents cant * "locked"
Indicating that NVDIMM contents cant
be modified until next power cycle. be modified until next power cycle.
What: /sys/bus/nd/devices/nmemX/papr/perf_stats What: /sys/bus/nd/devices/nmemX/papr/perf_stats
...@@ -51,4 +58,4 @@ Description: ...@@ -51,4 +58,4 @@ Description:
* "MedWDur " : Media Write Duration * "MedWDur " : Media Write Duration
* "CchRHCnt" : Cache Read Hit Count * "CchRHCnt" : Cache Read Hit Count
* "CchWHCnt" : Cache Write Hit Count * "CchWHCnt" : Cache Write Hit Count
* "FastWCnt" : Fast Write Count * "FastWCnt" : Fast Write Count
\ No newline at end of file
...@@ -7,8 +7,10 @@ Description: ...@@ -7,8 +7,10 @@ Description:
this location. This is useful for overriding default this location. This is useful for overriding default
bindings. The format for the location is: DDDD:BB:DD.F. bindings. The format for the location is: DDDD:BB:DD.F.
That is Domain:Bus:Device.Function and is the same as That is Domain:Bus:Device.Function and is the same as
found in /sys/bus/pci/devices/. For example: found in /sys/bus/pci/devices/. For example::
# echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/bind
# echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/bind
(Note: kernels before 2.6.28 may require echo -n). (Note: kernels before 2.6.28 may require echo -n).
What: /sys/bus/pci/drivers/.../unbind What: /sys/bus/pci/drivers/.../unbind
...@@ -20,8 +22,10 @@ Description: ...@@ -20,8 +22,10 @@ Description:
this location. This may be useful when overriding default this location. This may be useful when overriding default
bindings. The format for the location is: DDDD:BB:DD.F. bindings. The format for the location is: DDDD:BB:DD.F.
That is Domain:Bus:Device.Function and is the same as That is Domain:Bus:Device.Function and is the same as
found in /sys/bus/pci/devices/. For example: found in /sys/bus/pci/devices/. For example::
# echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/unbind
# echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/unbind
(Note: kernels before 2.6.28 may require echo -n). (Note: kernels before 2.6.28 may require echo -n).
What: /sys/bus/pci/drivers/.../new_id What: /sys/bus/pci/drivers/.../new_id
...@@ -38,8 +42,9 @@ Description: ...@@ -38,8 +42,9 @@ Description:
Class, Class Mask, and Private Driver Data. The Vendor ID Class, Class Mask, and Private Driver Data. The Vendor ID
and Device ID fields are required, the rest are optional. and Device ID fields are required, the rest are optional.
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/pci/drivers/foo/new_id
# echo "8086 10f5" > /sys/bus/pci/drivers/foo/new_id
What: /sys/bus/pci/drivers/.../remove_id What: /sys/bus/pci/drivers/.../remove_id
Date: February 2009 Date: February 2009
...@@ -54,8 +59,9 @@ Description: ...@@ -54,8 +59,9 @@ Description:
required, the rest are optional. After successfully required, the rest are optional. After successfully
removing an ID, the driver will no longer support the removing an ID, the driver will no longer support the
device. This is useful to ensure auto probing won't device. This is useful to ensure auto probing won't
match the driver to the device. For example: match the driver to the device. For example::
# echo "8086 10f5" > /sys/bus/pci/drivers/foo/remove_id
# echo "8086 10f5" > /sys/bus/pci/drivers/foo/remove_id
What: /sys/bus/pci/rescan What: /sys/bus/pci/rescan
Date: January 2009 Date: January 2009
......
...@@ -4,6 +4,7 @@ Contact: Cezary Rojewski <cezary.rojewski@intel.com> ...@@ -4,6 +4,7 @@ Contact: Cezary Rojewski <cezary.rojewski@intel.com>
Description: Description:
Version of AudioDSP firmware ASoC catpt driver is Version of AudioDSP firmware ASoC catpt driver is
communicating with. communicating with.
Format: %d.%d.%d.%d, type:major:minor:build. Format: %d.%d.%d.%d, type:major:minor:build.
What: /sys/devices/pci0000:00/<dev>/fw_info What: /sys/devices/pci0000:00/<dev>/fw_info
......
...@@ -21,11 +21,11 @@ Description: ...@@ -21,11 +21,11 @@ Description:
number returns the port to normal operation. number returns the port to normal operation.
For example: To force the high-speed device attached to For example: To force the high-speed device attached to
port 4 on bus 2 to run at full speed: port 4 on bus 2 to run at full speed::
echo 4 >/sys/bus/usb/devices/usb2/../companion echo 4 >/sys/bus/usb/devices/usb2/../companion
To return the port to high-speed operation: To return the port to high-speed operation::
echo -4 >/sys/bus/usb/devices/usb2/../companion echo -4 >/sys/bus/usb/devices/usb2/../companion
......
...@@ -7,6 +7,8 @@ Description: ...@@ -7,6 +7,8 @@ Description:
Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>] Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
Example::
$ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
The snapshot name can be "-" or omitted to map the image The snapshot name can be "-" or omitted to map the image
...@@ -23,6 +25,8 @@ Description: ...@@ -23,6 +25,8 @@ Description:
Usage: <dev-id> [force] Usage: <dev-id> [force]
Example::
$ echo 2 > /sys/bus/rbd/remove $ echo 2 > /sys/bus/rbd/remove
Optional "force" argument which when passed will wait for Optional "force" argument which when passed will wait for
...@@ -80,26 +84,29 @@ Date: Oct, 2010 ...@@ -80,26 +84,29 @@ Date: Oct, 2010
KernelVersion: v2.6.37 KernelVersion: v2.6.37
Contact: Sage Weil <sage@newdream.net> Contact: Sage Weil <sage@newdream.net>
Description: Description:
size: (RO) The size (in bytes) of the mapped block
============== ================================================
size (RO) The size (in bytes) of the mapped block
device. device.
major: (RO) The block device major number. major (RO) The block device major number.
client_id: (RO) The ceph unique client id that was assigned client_id (RO) The ceph unique client id that was assigned
for this specific session. for this specific session.
pool: (RO) The name of the storage pool where this rbd pool (RO) The name of the storage pool where this rbd
image resides. An rbd image name is unique image resides. An rbd image name is unique
within its pool. within its pool.
name: (RO) The name of the rbd image. name (RO) The name of the rbd image.
refresh: (WO) Writing to this file will reread the image refresh (WO) Writing to this file will reread the image
header data and set all relevant data structures header data and set all relevant data structures
accordingly. accordingly.
current_snap: (RO) The current snapshot for which the device current_snap (RO) The current snapshot for which the device
is mapped. is mapped.
============== ================================================
What: /sys/bus/rbd/devices/<dev-id>/pool_id What: /sys/bus/rbd/devices/<dev-id>/pool_id
...@@ -117,11 +124,13 @@ Date: Oct, 2012 ...@@ -117,11 +124,13 @@ Date: Oct, 2012
KernelVersion: v3.7 KernelVersion: v3.7
Contact: Sage Weil <sage@newdream.net> Contact: Sage Weil <sage@newdream.net>
Description: Description:
image_id: (RO) The unique id for the rbd image. (For rbd ========= ===============================================
image_id (RO) The unique id for the rbd image. (For rbd
image format 1 this is empty.) image format 1 this is empty.)
features: (RO) A hexadecimal encoding of the feature bits features (RO) A hexadecimal encoding of the feature bits
for this image. for this image.
========= ===============================================
What: /sys/bus/rbd/devices/<dev-id>/parent What: /sys/bus/rbd/devices/<dev-id>/parent
...@@ -149,14 +158,16 @@ Date: Aug, 2016 ...@@ -149,14 +158,16 @@ Date: Aug, 2016
KernelVersion: v4.9 KernelVersion: v4.9
Contact: Sage Weil <sage@newdream.net> Contact: Sage Weil <sage@newdream.net>
Description: Description:
snap_id: (RO) The current snapshot's id. ============ ================================================
snap_id (RO) The current snapshot's id.
config_info: (RO) The string written into config_info (RO) The string written into
/sys/bus/rbd/add{,_single_major}. /sys/bus/rbd/add{,_single_major}.
cluster_fsid: (RO) The ceph cluster UUID. cluster_fsid (RO) The ceph cluster UUID.
client_addr: (RO) The ceph unique client client_addr (RO) The ceph unique client
entity_addr_t (address + nonce). The format is entity_addr_t (address + nonce). The format is
<address>:<port>/<nonce>: '1.2.3.4:1234/5678' or <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
'[1:2:3:4:5:6:7:8]:1234/5678'. '[1:2:3:4:5:6:7:8]:1234/5678'.
============ ================================================
...@@ -8,6 +8,7 @@ Description: ...@@ -8,6 +8,7 @@ Description:
When the file contains a "1" the bus is operated and periodically When the file contains a "1" the bus is operated and periodically
does a push-pull cycle to write and read data from the does a push-pull cycle to write and read data from the
connected devices. connected devices.
When writing a "0" or "1" the bus moves to the described state. When writing a "0" or "1" the bus moves to the described state.
What: /sys/bus/siox/devices/siox-X/device_add What: /sys/bus/siox/devices/siox-X/device_add
...@@ -21,8 +22,10 @@ Description: ...@@ -21,8 +22,10 @@ Description:
to add a new device dynamically. <type> is the name that is used to match to add a new device dynamically. <type> is the name that is used to match
to a driver (similar to the platform bus). <inbytes> and <outbytes> define to a driver (similar to the platform bus). <inbytes> and <outbytes> define
the length of the input and output shift register in bytes respectively. the length of the input and output shift register in bytes respectively.
<statustype> defines the 4 bit device type that is check to identify connection <statustype> defines the 4 bit device type that is check to identify connection
problems. problems.
The new device is added to the end of the existing chain. The new device is added to the end of the existing chain.
What: /sys/bus/siox/devices/siox-X/device_remove What: /sys/bus/siox/devices/siox-X/device_remove
......
...@@ -193,10 +193,11 @@ Description: When new NVM image is written to the non-active NVM ...@@ -193,10 +193,11 @@ Description: When new NVM image is written to the non-active NVM
verification fails an error code is returned instead. verification fails an error code is returned instead.
This file will accept writing values "1" or "2" This file will accept writing values "1" or "2"
- Writing "1" will flush the image to the storage - Writing "1" will flush the image to the storage
area and authenticate the image in one action. area and authenticate the image in one action.
- Writing "2" will run some basic validation on the image - Writing "2" will run some basic validation on the image
and flush it to the storage area. and flush it to the storage area.
When read holds status of the last authentication When read holds status of the last authentication
operation if an error occurred during the process. This operation if an error occurred during the process. This
...@@ -213,9 +214,11 @@ Description: This contains name of the property directory the XDomain ...@@ -213,9 +214,11 @@ Description: This contains name of the property directory the XDomain
question. Following directories are already reserved by question. Following directories are already reserved by
the Apple XDomain specification: the Apple XDomain specification:
network: IP/ethernet over Thunderbolt ======== ===============================================
targetdm: Target disk mode protocol over Thunderbolt network IP/ethernet over Thunderbolt
extdisp: External display mode protocol over Thunderbolt targetdm Target disk mode protocol over Thunderbolt
extdisp External display mode protocol over Thunderbolt
======== ===============================================
What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/modalias What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/modalias
Date: Jan 2018 Date: Jan 2018
...@@ -293,7 +296,8 @@ Description: For supported devices, automatically authenticate the new Thunderbo ...@@ -293,7 +296,8 @@ Description: For supported devices, automatically authenticate the new Thunderbo
image when the device is disconnected from the host system. image when the device is disconnected from the host system.
This file will accept writing values "1" or "2" This file will accept writing values "1" or "2"
- Writing "1" will flush the image to the storage - Writing "1" will flush the image to the storage
area and prepare the device for authentication on disconnect. area and prepare the device for authentication on disconnect.
- Writing "2" will run some basic validation on the image - Writing "2" will run some basic validation on the image
and flush it to the storage area. and flush it to the storage area.
...@@ -9,6 +9,7 @@ Description: ...@@ -9,6 +9,7 @@ Description:
by writing INTERFACE to /sys/bus/usb/drivers_probe by writing INTERFACE to /sys/bus/usb/drivers_probe
This allows to avoid side-effects with drivers This allows to avoid side-effects with drivers
that need multiple interfaces. that need multiple interfaces.
A deauthorized interface cannot be probed or claimed. A deauthorized interface cannot be probed or claimed.
What: /sys/bus/usb/devices/usbX/interface_authorized_default What: /sys/bus/usb/devices/usbX/interface_authorized_default
...@@ -216,6 +217,7 @@ Description: ...@@ -216,6 +217,7 @@ Description:
- 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).
The old enumeration scheme can also be selected globally The old enumeration scheme can also be selected globally
using /sys/module/usbcore/parameters/old_scheme_first, but using /sys/module/usbcore/parameters/old_scheme_first, but
it is often not desirable as the new scheme was introduced to it is often not desirable as the new scheme was introduced to
......
...@@ -6,8 +6,10 @@ Description: ...@@ -6,8 +6,10 @@ Description:
Get the ALS output channel used as input in Get the ALS output channel used as input in
ALS-current-control mode (0, 1), where: ALS-current-control mode (0, 1), where:
0 - out_current0 (backlight 0) == ==========================
1 - out_current1 (backlight 1) 0 out_current0 (backlight 0)
1 out_current1 (backlight 1)
== ==========================
What: /sys/class/backlight/<backlight>/als_en What: /sys/class/backlight/<backlight>/als_en
Date: May 2012 Date: May 2012
...@@ -30,8 +32,10 @@ Contact: Johan Hovold <jhovold@gmail.com> ...@@ -30,8 +32,10 @@ Contact: Johan Hovold <jhovold@gmail.com>
Description: Description:
Set the brightness-mapping mode (0, 1), where: Set the brightness-mapping mode (0, 1), where:
0 - exponential mode == ================
1 - linear mode 0 exponential mode
1 linear mode
== ================
What: /sys/class/backlight/<backlight>/pwm What: /sys/class/backlight/<backlight>/pwm
Date: April 2012 Date: April 2012
...@@ -40,9 +44,11 @@ Contact: Johan Hovold <jhovold@gmail.com> ...@@ -40,9 +44,11 @@ Contact: Johan Hovold <jhovold@gmail.com>
Description: Description:
Set the PWM-input control mask (5 bits), where: Set the PWM-input control mask (5 bits), where:
bit 5 - PWM-input enabled in Zone 4 ===== ===========================
bit 4 - PWM-input enabled in Zone 3 bit 5 PWM-input enabled in Zone 4
bit 3 - PWM-input enabled in Zone 2 bit 4 PWM-input enabled in Zone 3
bit 2 - PWM-input enabled in Zone 1 bit 3 PWM-input enabled in Zone 2
bit 1 - PWM-input enabled in Zone 0 bit 2 PWM-input enabled in Zone 1
bit 0 - PWM-input enabled bit 1 PWM-input enabled in Zone 0
bit 0 PWM-input enabled
===== ===========================
...@@ -24,7 +24,6 @@ default ...@@ -24,7 +24,6 @@ default
filesystems which do not provide their own BDI. filesystems which do not provide their own BDI.
Files under /sys/class/bdi/<bdi>/ Files under /sys/class/bdi/<bdi>/
---------------------------------
read_ahead_kb (read-write) read_ahead_kb (read-write)
......
...@@ -17,13 +17,14 @@ Date: August 2015 ...@@ -17,13 +17,14 @@ Date: August 2015
KernelVersion: 4.2 KernelVersion: 4.2
Description: Description:
Tell the EC to reboot in various ways. Options are: Tell the EC to reboot in various ways. Options are:
"cancel": Cancel a pending reboot.
"ro": Jump to RO without rebooting. - "cancel": Cancel a pending reboot.
"rw": Jump to RW without rebooting. - "ro": Jump to RO without rebooting.
"cold": Cold reboot. - "rw": Jump to RW without rebooting.
"disable-jump": Disable jump until next reboot. - "cold": Cold reboot.
"hibernate": Hibernate the EC. - "disable-jump": Disable jump until next reboot.
"at-shutdown": Reboot after an AP shutdown. - "hibernate": Hibernate the EC.
- "at-shutdown": Reboot after an AP shutdown.
What: /sys/class/chromeos/<ec-device-name>/version What: /sys/class/chromeos/<ec-device-name>/version
Date: August 2015 Date: August 2015
......
...@@ -217,6 +217,7 @@ Description: read/write ...@@ -217,6 +217,7 @@ Description: read/write
card. A power cycle is required to load the image. card. A power cycle is required to load the image.
"none" could be useful for debugging because the trace arrays "none" could be useful for debugging because the trace arrays
are preserved. are preserved.
"user" and "factory" means PERST will cause either the user or "user" and "factory" means PERST will cause either the user or
user or factory image to be loaded. user or factory image to be loaded.
Default is to reload on PERST whichever image the card has Default is to reload on PERST whichever image the card has
...@@ -240,8 +241,11 @@ Contact: linuxppc-dev@lists.ozlabs.org ...@@ -240,8 +241,11 @@ Contact: linuxppc-dev@lists.ozlabs.org
Description: read/write Description: read/write
Trust that when an image is reloaded via PERST, it will not Trust that when an image is reloaded via PERST, it will not
have changed. have changed.
0 = don't trust, the image may be different (default)
1 = trust that the image will not change. == =================================================
0 don't trust, the image may be different (default)
1 trust that the image will not change.
== =================================================
Users: https://github.com/ibm-capi/libcxl Users: https://github.com/ibm-capi/libcxl
What: /sys/class/cxl/<card>/psl_timebase_synced What: /sys/class/cxl/<card>/psl_timebase_synced
......
...@@ -18,9 +18,9 @@ Description: ...@@ -18,9 +18,9 @@ Description:
This will be one of the following strings: This will be one of the following strings:
'consumer unbind' - 'consumer unbind'
'supplier unbind' - 'supplier unbind'
'never' - 'never'
'consumer unbind' means the device link will be removed when 'consumer unbind' means the device link will be removed when
the consumer's driver is unbound from the consumer device. the consumer's driver is unbound from the consumer device.
...@@ -49,8 +49,10 @@ Description: ...@@ -49,8 +49,10 @@ Description:
This will be one of the following strings: This will be one of the following strings:
'0' - Does not affect runtime power management === ========================================
'1' - Affects runtime power management '0' Does not affect runtime power management
'1' Affects runtime power management
=== ========================================
What: /sys/class/devlink/.../status What: /sys/class/devlink/.../status
Date: May 2020 Date: May 2020
...@@ -68,13 +70,13 @@ Description: ...@@ -68,13 +70,13 @@ Description:
This will be one of the following strings: This will be one of the following strings:
'not tracked' - 'not tracked'
'dormant' - 'dormant'
'available' - 'available'
'consumer probing' - 'consumer probing'
'active' - 'active'
'supplier unbinding' - 'supplier unbinding'
'unknown' - 'unknown'
'not tracked' means this device link does not track the status 'not tracked' means this device link does not track the status
and has no impact on the binding, unbinding and syncing the and has no impact on the binding, unbinding and syncing the
...@@ -114,8 +116,10 @@ Description: ...@@ -114,8 +116,10 @@ Description:
This will be one of the following strings: This will be one of the following strings:
=== ================================
'0' '0'
'1' - Affects runtime power management '1' Affects runtime power management
=== ================================
'0' means the device link can affect other device behaviors '0' means the device link can affect other device behaviors
like binding/unbinding, suspend/resume, runtime power like binding/unbinding, suspend/resume, runtime power
......
...@@ -39,19 +39,22 @@ Description: ...@@ -39,19 +39,22 @@ Description:
callback. callback.
If the default callback for showing function is used, the If the default callback for showing function is used, the
format is like this: format is like this::
# cat state
USB_OTG=1 # cat state
HDMI=0 USB_OTG=1
TA=1 HDMI=0
EAR_JACK=0 TA=1
# EAR_JACK=0
#
In this example, the extcon device has USB_OTG and TA In this example, the extcon device has USB_OTG and TA
cables attached and HDMI and EAR_JACK cables detached. cables attached and HDMI and EAR_JACK cables detached.
In order to update the state of an extcon device, enter a hex In order to update the state of an extcon device, enter a hex
state number starting with 0x: state number starting with 0x::
# echo 0xHEX > state
# echo 0xHEX > state
This updates the whole state of the extcon device. This updates the whole state of the extcon device.
Inputs of all the methods are required to meet the Inputs of all the methods are required to meet the
...@@ -84,12 +87,13 @@ Contact: MyungJoo Ham <myungjoo.ham@samsung.com> ...@@ -84,12 +87,13 @@ Contact: MyungJoo Ham <myungjoo.ham@samsung.com>
Description: Description:
Shows the relations of mutually exclusiveness. For example, Shows the relations of mutually exclusiveness. For example,
if the mutually_exclusive array of extcon device is if the mutually_exclusive array of extcon device is
{0x3, 0x5, 0xC, 0x0}, then the output is: {0x3, 0x5, 0xC, 0x0}, then the output is::
# ls mutually_exclusive/
0x3 # ls mutually_exclusive/
0x5 0x3
0xc 0x5
# 0xc
#
Note that mutually_exclusive is a sub-directory of the extcon Note that mutually_exclusive is a sub-directory of the extcon
device and the file names under the mutually_exclusive device and the file names under the mutually_exclusive
......
...@@ -28,8 +28,7 @@ Description: Read fpga manager state as a string. ...@@ -28,8 +28,7 @@ Description: Read fpga manager state as a string.
* firmware request = firmware class request in progress * firmware request = firmware class request in progress
* firmware request error = firmware request failed * firmware request error = firmware request failed
* write init = preparing FPGA for programming * write init = preparing FPGA for programming
* write init error = Error while preparing FPGA for * write init error = Error while preparing FPGA for programming
programming
* write = FPGA ready to receive image data * write = FPGA ready to receive image data
* write error = Error while programming * write error = Error while programming
* write complete = Doing post programming steps * write complete = Doing post programming steps
...@@ -47,7 +46,7 @@ Description: Read fpga manager status as a string. ...@@ -47,7 +46,7 @@ Description: Read fpga manager status as a string.
programming errors to userspace. This is a list of strings for programming errors to userspace. This is a list of strings for
the supported status. the supported status.
* reconfig operation error - invalid operations detected by * reconfig operation error - invalid operations detected by
reconfiguration hardware. reconfiguration hardware.
e.g. start reconfiguration e.g. start reconfiguration
with errors not cleared with errors not cleared
......
...@@ -6,9 +6,11 @@ Description: ...@@ -6,9 +6,11 @@ Description:
The GNSS receiver type. The currently identified types reflect The GNSS receiver type. The currently identified types reflect
the protocol(s) supported by the receiver: the protocol(s) supported by the receiver:
====== ===========
"NMEA" NMEA 0183 "NMEA" NMEA 0183
"SiRF" SiRF Binary "SiRF" SiRF Binary
"UBX" UBX "UBX" UBX
====== ===========
Note that also non-"NMEA" type receivers typically support a Note that also non-"NMEA" type receivers typically support a
subset of NMEA 0183 with vendor extensions (e.g. to allow subset of NMEA 0183 with vendor extensions (e.g. to allow
......
...@@ -47,6 +47,7 @@ Contact: Richard Purdie <rpurdie@rpsys.net> ...@@ -47,6 +47,7 @@ Contact: Richard Purdie <rpurdie@rpsys.net>
Description: Description:
Set the trigger for this LED. A trigger is a kernel based source Set the trigger for this LED. A trigger is a kernel based source
of LED events. of LED events.
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
......
...@@ -27,23 +27,23 @@ Description: ...@@ -27,23 +27,23 @@ Description:
^ ^
| |
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-|-------------------+ +-------------------+ +---
| |
...@@ -55,23 +55,23 @@ Description: ...@@ -55,23 +55,23 @@ Description:
^ ^
| |
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-| +----+ +----+
| |
...@@ -83,23 +83,23 @@ Description: ...@@ -83,23 +83,23 @@ Description:
^ ^
| |
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-|-------------------+ +-----------------------
| |
......
...@@ -6,8 +6,10 @@ Description: ...@@ -6,8 +6,10 @@ Description:
Set the ALS output channel to use as input in Set the ALS output channel to use as input in
ALS-current-control mode (1, 2), where: ALS-current-control mode (1, 2), where:
1 - out_current1 == ============
2 - out_current2 1 out_current1
2 out_current2
== ============
What: /sys/class/leds/<led>/als_en What: /sys/class/leds/<led>/als_en
Date: May 2012 Date: May 2012
...@@ -24,14 +26,16 @@ Contact: Johan Hovold <jhovold@gmail.com> ...@@ -24,14 +26,16 @@ Contact: Johan Hovold <jhovold@gmail.com>
Description: Description:
Set the pattern generator fall and rise times (0..7), where: Set the pattern generator fall and rise times (0..7), where:
0 - 2048 us == =======
1 - 262 ms 0 2048 us
2 - 524 ms 1 262 ms
3 - 1.049 s 2 524 ms
4 - 2.097 s 3 1.049 s
5 - 4.194 s 4 2.097 s
6 - 8.389 s 5 4.194 s
7 - 16.78 s 6 8.389 s
7 16.78 s
== =======
What: /sys/class/leds/<led>/id What: /sys/class/leds/<led>/id
Date: April 2012 Date: April 2012
...@@ -47,8 +51,10 @@ Contact: Johan Hovold <jhovold@gmail.com> ...@@ -47,8 +51,10 @@ Contact: Johan Hovold <jhovold@gmail.com>
Description: Description:
Set the brightness-mapping mode (0, 1), where: Set the brightness-mapping mode (0, 1), where:
0 - exponential mode == ================
1 - linear mode 0 exponential mode
1 linear mode
== ================
What: /sys/class/leds/<led>/pwm What: /sys/class/leds/<led>/pwm
Date: April 2012 Date: April 2012
...@@ -57,9 +63,11 @@ Contact: Johan Hovold <jhovold@gmail.com> ...@@ -57,9 +63,11 @@ Contact: Johan Hovold <jhovold@gmail.com>
Description: Description:
Set the PWM-input control mask (5 bits), where: Set the PWM-input control mask (5 bits), where:
bit 5 - PWM-input enabled in Zone 4 ===== ===========================
bit 4 - PWM-input enabled in Zone 3 bit 5 PWM-input enabled in Zone 4
bit 3 - PWM-input enabled in Zone 2 bit 4 PWM-input enabled in Zone 3
bit 2 - PWM-input enabled in Zone 1 bit 3 PWM-input enabled in Zone 2
bit 1 - PWM-input enabled in Zone 0 bit 2 PWM-input enabled in Zone 1
bit 0 - PWM-input enabled bit 1 PWM-input enabled in Zone 0
bit 0 PWM-input enabled
===== ===========================
...@@ -55,26 +55,35 @@ Description: read only ...@@ -55,26 +55,35 @@ Description: read only
Flash faults are re-read after strobing the flash. Possible Flash faults are re-read after strobing the flash. Possible
flash faults: flash faults:
* led-over-voltage - flash controller voltage to the flash LED * led-over-voltage
flash controller voltage to the flash LED
has exceeded the limit specific to the flash controller has exceeded the limit specific to the flash controller
* flash-timeout-exceeded - the flash strobe was still on when * flash-timeout-exceeded
the flash strobe was still on when
the timeout set by the user has expired; not all flash the timeout set by the user has expired; not all flash
controllers may set this in all such conditions controllers may set this in all such conditions
* controller-over-temperature - the flash controller has * controller-over-temperature
the flash controller has
overheated overheated
* controller-short-circuit - the short circuit protection * controller-short-circuit
the short circuit protection
of the flash controller has been triggered of the flash controller has been triggered
* led-power-supply-over-current - current in the LED power * led-power-supply-over-current
current in the LED power
supply has exceeded the limit specific to the flash supply has exceeded the limit specific to the flash
controller controller
* indicator-led-fault - the flash controller has detected * indicator-led-fault
the flash controller has detected
a short or open circuit condition on the indicator LED a short or open circuit condition on the indicator LED
* led-under-voltage - flash controller voltage to the flash * led-under-voltage
flash controller voltage to the flash
LED has been below the minimum limit specific to LED has been below the minimum limit specific to
the flash the flash
* controller-under-voltage - the input voltage of the flash * controller-under-voltage
the input voltage of the flash
controller is below the limit under which strobing the controller is below the limit under which strobing the
flash at full current will not be possible; flash at full current will not be possible;
the condition persists until this flag is no longer set the condition persists until this flag is no longer set
* led-over-temperature - the temperature of the LED has exceeded * led-over-temperature
the temperature of the LED has exceeded
its allowed upper limit its allowed upper limit
...@@ -19,18 +19,23 @@ KernelVersion: 4.16 ...@@ -19,18 +19,23 @@ KernelVersion: 4.16
Contact: linux-leds@vger.kernel.org Contact: linux-leds@vger.kernel.org
Description: Description:
Signal the link state of the named network device. Signal the link state of the named network device.
If set to 0 (default), the LED's normal state is off. If set to 0 (default), the LED's normal state is off.
If set to 1, the LED's normal state reflects the link state If set to 1, the LED's normal state reflects the link state
of the named network device. of the named network device.
Setting this value also immediately changes the LED state. Setting this value also immediately changes the LED state.
What: /sys/class/leds/<led>/tx What: /sys/class/leds/<led>/tx
Date: Dec 2017 Date: Dec 2017
KernelVersion: 4.16 KernelVersion: 4.16
Contact: linux-leds@vger.kernel.org Contact: linux-leds@vger.kernel.org
Description: Description:
Signal transmission of data on the named network device. Signal transmission of data on the named network device.
If set to 0 (default), the LED will not blink on transmission. If set to 0 (default), the LED will not blink on transmission.
If set to 1, the LED will blink for the milliseconds specified If set to 1, the LED will blink for the milliseconds specified
in interval to signal transmission. in interval to signal transmission.
...@@ -40,6 +45,8 @@ KernelVersion: 4.16 ...@@ -40,6 +45,8 @@ KernelVersion: 4.16
Contact: linux-leds@vger.kernel.org Contact: linux-leds@vger.kernel.org
Description: Description:
Signal reception of data on the named network device. Signal reception of data on the named network device.
If set to 0 (default), the LED will not blink on reception. If set to 0 (default), the LED will not blink on reception.
If set to 1, the LED will blink for the milliseconds specified If set to 1, the LED will blink for the milliseconds specified
in interval to signal reception. in interval to signal reception.
...@@ -8,5 +8,6 @@ Description: ...@@ -8,5 +8,6 @@ Description:
selected for the USB port trigger. Selecting ports makes trigger selected for the USB port trigger. Selecting ports makes trigger
observing them for any connected devices and lighting on LED if observing them for any connected devices and lighting on LED if
there are any. there are any.
Echoing "1" value selects USB port. Echoing "0" unselects it. Echoing "1" value selects USB port. Echoing "0" unselects it.
Current state can be also read. Current state can be also read.
...@@ -7,9 +7,11 @@ Description: ...@@ -7,9 +7,11 @@ Description:
of one LED will update the mode of its two sibling devices as of one LED will update the mode of its two sibling devices as
well. Possible values are: well. Possible values are:
0 - normal == =========
1 - audio 0 normal
2 - breathing 1 audio
2 breathing
== =========
Normal: LEDs are fully on when enabled Normal: LEDs are fully on when enabled
Audio: LEDs brightness depends on sound level Audio: LEDs brightness depends on sound level
......
...@@ -4,10 +4,13 @@ KernelVersion: 3.17 ...@@ -4,10 +4,13 @@ KernelVersion: 3.17
Contact: netdev@vger.kernel.org Contact: netdev@vger.kernel.org
Description: Description:
Indicates the name assignment type. Possible values are: Indicates the name assignment type. Possible values are:
1: enumerated by the kernel, possibly in an unpredictable way
2: predictably named by the kernel == ==========================================================
3: named by userspace 1 enumerated by the kernel, possibly in an unpredictable way
4: renamed 2 predictably named by the kernel
3 named by userspace
4 renamed
== ==========================================================
What: /sys/class/net/<iface>/addr_assign_type What: /sys/class/net/<iface>/addr_assign_type
Date: July 2010 Date: July 2010
...@@ -15,10 +18,13 @@ KernelVersion: 3.2 ...@@ -15,10 +18,13 @@ KernelVersion: 3.2
Contact: netdev@vger.kernel.org Contact: netdev@vger.kernel.org
Description: Description:
Indicates the address assignment type. Possible values are: Indicates the address assignment type. Possible values are:
0: permanent address
1: randomly generated == =============================
2: stolen from another device 0 permanent address
3: set using dev_set_mac_address 1 randomly generated
2 stolen from another device
3 set using dev_set_mac_address
== =============================
What: /sys/class/net/<iface>/addr_len What: /sys/class/net/<iface>/addr_len
Date: April 2005 Date: April 2005
...@@ -51,9 +57,12 @@ Description: ...@@ -51,9 +57,12 @@ Description:
Default value 0 does not forward any link local frames. Default value 0 does not forward any link local frames.
Restricted bits: Restricted bits:
0: 01-80-C2-00-00-00 Bridge Group Address used for STP
1: 01-80-C2-00-00-01 (MAC Control) 802.3 used for MAC PAUSE == ========================================================
2: 01-80-C2-00-00-02 (Link Aggregation) 802.3ad 0 01-80-C2-00-00-00 Bridge Group Address used for STP
1 01-80-C2-00-00-01 (MAC Control) 802.3 used for MAC PAUSE
2 01-80-C2-00-00-02 (Link Aggregation) 802.3ad
== ========================================================
Any values not setting these bits can be used. Take special Any values not setting these bits can be used. Take special
care when forwarding control frames e.g. 802.1X-PAE or LLDP. care when forwarding control frames e.g. 802.1X-PAE or LLDP.
...@@ -74,8 +83,11 @@ Contact: netdev@vger.kernel.org ...@@ -74,8 +83,11 @@ Contact: netdev@vger.kernel.org
Description: Description:
Indicates the current physical link state of the interface. Indicates the current physical link state of the interface.
Posssible values are: Posssible values are:
0: physical link is down
1: physical link is up == =====================
0 physical link is down
1 physical link is up
== =====================
Note: some special devices, e.g: bonding and team drivers will Note: some special devices, e.g: bonding and team drivers will
allow this attribute to be written to force a link state for allow this attribute to be written to force a link state for
...@@ -131,8 +143,11 @@ Contact: netdev@vger.kernel.org ...@@ -131,8 +143,11 @@ Contact: netdev@vger.kernel.org
Description: Description:
Indicates whether the interface is under test. Possible Indicates whether the interface is under test. Possible
values are: values are:
0: interface is not being tested
1: interface is being tested == =============================
0 interface is not being tested
1 interface is being tested
== =============================
When an interface is under test, it cannot be expected When an interface is under test, it cannot be expected
to pass packets as normal. to pass packets as normal.
...@@ -144,8 +159,11 @@ Contact: netdev@vger.kernel.org ...@@ -144,8 +159,11 @@ Contact: netdev@vger.kernel.org
Description: Description:
Indicates the interface latest or current duplex value. Possible Indicates the interface latest or current duplex value. Possible
values are: values are:
half: half duplex
full: full duplex ==== ===========
half half duplex
full full duplex
==== ===========
Note: This attribute is only valid for interfaces that implement Note: This attribute is only valid for interfaces that implement
the ethtool get_link_ksettings method (mostly Ethernet). the ethtool get_link_ksettings method (mostly Ethernet).
...@@ -196,8 +214,11 @@ Description: ...@@ -196,8 +214,11 @@ Description:
Indicates the interface link mode, as a decimal number. This Indicates the interface link mode, as a decimal number. This
attribute should be used in conjunction with 'dormant' attribute attribute should be used in conjunction with 'dormant' attribute
to determine the interface usability. Possible values: to determine the interface usability. Possible values:
0: default link mode
1: dormant link mode == =================
0 default link mode
1 dormant link mode
== =================
What: /sys/class/net/<iface>/mtu What: /sys/class/net/<iface>/mtu
Date: April 2005 Date: April 2005
...@@ -226,7 +247,9 @@ KernelVersion: 2.6.17 ...@@ -226,7 +247,9 @@ KernelVersion: 2.6.17
Contact: netdev@vger.kernel.org Contact: netdev@vger.kernel.org
Description: Description:
Indicates the interface RFC2863 operational state as a string. Indicates the interface RFC2863 operational state as a string.
Possible values are: Possible values are:
"unknown", "notpresent", "down", "lowerlayerdown", "testing", "unknown", "notpresent", "down", "lowerlayerdown", "testing",
"dormant", "up". "dormant", "up".
......
...@@ -91,9 +91,9 @@ Date: May 2014 ...@@ -91,9 +91,9 @@ Date: May 2014
KernelVersion: 3.16 KernelVersion: 3.16
Contact: Bjørn Mork <bjorn@mork.no> Contact: Bjørn Mork <bjorn@mork.no>
Description: Description:
Bit 0: 16-bit NTB supported (set to 1) - Bit 0: 16-bit NTB supported (set to 1)
Bit 1: 32-bit NTB supported - Bit 1: 32-bit NTB supported
Bits 2 – 15: reserved (reset to zero; must be ignored by host) - Bits 2 – 15: reserved (reset to zero; must be ignored by host)
What: /sys/class/net/<iface>/cdc_ncm/dwNtbInMaxSize What: /sys/class/net/<iface>/cdc_ncm/dwNtbInMaxSize
Date: May 2014 Date: May 2014
......
...@@ -35,7 +35,9 @@ Description: ...@@ -35,7 +35,9 @@ Description:
Ethernet driver during bus enumeration, encoded in string. Ethernet driver during bus enumeration, encoded in string.
This interface mode is used to configure the Ethernet MAC with the This interface mode is used to configure the Ethernet MAC with the
appropriate mode for its data lines to the PHY hardware. appropriate mode for its data lines to the PHY hardware.
Possible values are: Possible values are:
<empty> (not available), mii, gmii, sgmii, tbi, rev-mii, <empty> (not available), mii, gmii, sgmii, tbi, rev-mii,
rmii, rgmii, rgmii-id, rgmii-rxid, rgmii-txid, rtbi, smii rmii, rgmii, rgmii-id, rgmii-rxid, rgmii-txid, rtbi, smii
xgmii, moca, qsgmii, trgmii, 1000base-x, 2500base-x, rxaui, xgmii, moca, qsgmii, trgmii, 1000base-x, 2500base-x, rxaui,
......
...@@ -11,15 +11,17 @@ KernelVersion: 2.6.20 ...@@ -11,15 +11,17 @@ KernelVersion: 2.6.20
Contact: Thomas Maier <balagi@justmail.de> Contact: Thomas Maier <balagi@justmail.de>
Description: Description:
add: (WO) Write a block device id (major:minor) to ========== ==============================================
add (WO) Write a block device id (major:minor) to
create a new pktcdvd device and map it to the create a new pktcdvd device and map it to the
block device. block device.
remove: (WO) Write the pktcdvd device id (major:minor) remove (WO) Write the pktcdvd device id (major:minor)
to remove the pktcdvd device. to remove the pktcdvd device.
device_map: (RO) Shows the device mapping in format: device_map (RO) Shows the device mapping in format:
pktcdvd[0-7] <pktdevid> <blkdevid> pktcdvd[0-7] <pktdevid> <blkdevid>
========== ==============================================
What: /sys/class/pktcdvd/pktcdvd[0-7]/dev What: /sys/class/pktcdvd/pktcdvd[0-7]/dev
...@@ -65,29 +67,31 @@ Date: Oct. 2006 ...@@ -65,29 +67,31 @@ Date: Oct. 2006
KernelVersion: 2.6.20 KernelVersion: 2.6.20
Contact: Thomas Maier <balagi@justmail.de> Contact: Thomas Maier <balagi@justmail.de>
Description: Description:
size: (RO) Contains the size of the bio write queue. ============== ================================================
size (RO) Contains the size of the bio write queue.
congestion_off: (RW) If bio write queue size is below this mark, congestion_off (RW) If bio write queue size is below this mark,
accept new bio requests from the block layer. accept new bio requests from the block layer.
congestion_on: (RW) If bio write queue size is higher as this congestion_on (RW) If bio write queue size is higher as this
mark, do no longer accept bio write requests mark, do no longer accept bio write requests
from the block layer and wait till the pktcdvd from the block layer and wait till the pktcdvd
device has processed enough bio's so that bio device has processed enough bio's so that bio
write queue size is below congestion off mark. write queue size is below congestion off mark.
A value of <= 0 disables congestion control. A value of <= 0 disables congestion control.
============== ================================================
Example: Example:
-------- --------
To use the pktcdvd sysfs interface directly, you can do: To use the pktcdvd sysfs interface directly, you can do::
# create a new pktcdvd device mapped to /dev/hdc # create a new pktcdvd device mapped to /dev/hdc
echo "22:0" >/sys/class/pktcdvd/add echo "22:0" >/sys/class/pktcdvd/add
cat /sys/class/pktcdvd/device_map cat /sys/class/pktcdvd/device_map
# assuming device pktcdvd0 was created, look at stat's # assuming device pktcdvd0 was created, look at stat's
cat /sys/class/pktcdvd/pktcdvd0/stat/kb_written cat /sys/class/pktcdvd/pktcdvd0/stat/kb_written
# print the device id of the mapped block device # print the device id of the mapped block device
fgrep pktcdvd0 /sys/class/pktcdvd/device_map fgrep pktcdvd0 /sys/class/pktcdvd/device_map
# remove device, using pktcdvd0 device id 253:0 # remove device, using pktcdvd0 device id 253:0
echo "253:0" >/sys/class/pktcdvd/remove echo "253:0" >/sys/class/pktcdvd/remove
...@@ -43,7 +43,9 @@ Date: May 2007 ...@@ -43,7 +43,9 @@ Date: May 2007
Contact: linux-pm@vger.kernel.org Contact: linux-pm@vger.kernel.org
Description: Description:
Fine grain representation of battery capacity. Fine grain representation of battery capacity.
Access: Read Access: Read
Valid values: 0 - 100 (percent) Valid values: 0 - 100 (percent)
What: /sys/class/power_supply/<supply_name>/capacity_alert_max What: /sys/class/power_supply/<supply_name>/capacity_alert_max
...@@ -58,6 +60,7 @@ Description: ...@@ -58,6 +60,7 @@ Description:
low). 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_alert_min What: /sys/class/power_supply/<supply_name>/capacity_alert_min
...@@ -88,6 +91,7 @@ Description: ...@@ -88,6 +91,7 @@ Description:
completely useless. completely useless.
Access: Read Access: Read
Valid values: 0 - 100 (percent) Valid values: 0 - 100 (percent)
What: /sys/class/power_supply/<supply_name>/capacity_level What: /sys/class/power_supply/<supply_name>/capacity_level
...@@ -111,6 +115,7 @@ Description: ...@@ -111,6 +115,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 microamps. Negative values are used Valid values: Represented in microamps. Negative values are used
for discharging batteries, positive values for charging batteries. for discharging batteries, positive values for charging batteries.
...@@ -131,6 +136,7 @@ Description: ...@@ -131,6 +136,7 @@ Description:
This value is not averaged/smoothed. This value is not averaged/smoothed.
Access: Read Access: Read
Valid values: Represented in microamps. Negative values are used Valid values: Represented in microamps. Negative values are used
for discharging batteries, positive values for charging batteries. for discharging batteries, positive values for charging batteries.
...@@ -383,7 +389,7 @@ Description: ...@@ -383,7 +389,7 @@ Description:
**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
Contact: linux-pm@vger.kernel.org Contact: linux-pm@vger.kernel.org
Description: Description:
...@@ -449,6 +455,7 @@ Description: ...@@ -449,6 +455,7 @@ Description:
solved using power limit use input_voltage_limit. solved using power limit use input_voltage_limit.
Access: Read, Write Access: Read, Write
Valid values: Represented in microvolts Valid values: Represented in microvolts
What: /sys/class/power_supply/<supply_name>/input_power_limit What: /sys/class/power_supply/<supply_name>/input_power_limit
...@@ -462,6 +469,7 @@ Description: ...@@ -462,6 +469,7 @@ Description:
limit only for problems that can be solved using power limit. limit only for problems that can be solved using power limit.
Access: Read, Write Access: Read, Write
Valid values: Represented in microwatts Valid values: Represented in microwatts
What: /sys/class/power_supply/<supply_name>/online, What: /sys/class/power_supply/<supply_name>/online,
...@@ -747,6 +755,7 @@ Description: ...@@ -747,6 +755,7 @@ Description:
manufactured. manufactured.
Access: Read Access: Read
Valid values: Reported as integer Valid values: Reported as integer
What: /sys/class/power_supply/<supply_name>/manufacture_month What: /sys/class/power_supply/<supply_name>/manufacture_month
...@@ -756,6 +765,7 @@ Description: ...@@ -756,6 +765,7 @@ Description:
Reports the month when the device has been manufactured. Reports the month when the device has been manufactured.
Access: Read Access: Read
Valid values: 1-12 Valid values: 1-12
What: /sys/class/power_supply/<supply_name>/manufacture_day What: /sys/class/power_supply/<supply_name>/manufacture_day
......
...@@ -5,4 +5,5 @@ Description: ...@@ -5,4 +5,5 @@ Description:
Represents a battery impedance compensation to accelerate charging. Represents a battery impedance compensation to accelerate charging.
Access: Read, Write Access: Read, Write
Valid values: Represented in milli-ohms. Valid range is [0, 140]. Valid values: Represented in milli-ohms. Valid range is [0, 140].
...@@ -6,9 +6,9 @@ Description: ...@@ -6,9 +6,9 @@ Description:
Possible values are: Possible values are:
============= =========================================== ============= ===========================================
"auto" draw power as appropriate for detected "auto" draw power as appropriate for detected
power source and battery status. power source and battery status.
"off" do not draw any power. "off" do not draw any power.
"continuous" activate mode described as "linear" in "continuous" activate mode described as "linear" in
TWL data sheets. This uses whatever TWL data sheets. This uses whatever
current is available and doesn't switch off current is available and doesn't switch off
......
...@@ -6,6 +6,7 @@ Description: ...@@ -6,6 +6,7 @@ Description:
The /sys/class/rapidio_port subdirectory contains individual The /sys/class/rapidio_port subdirectory contains individual
subdirectories named as "rapidioN" where N = mport ID registered subdirectories named as "rapidioN" where N = mport ID registered
with RapidIO subsystem. with RapidIO subsystem.
NOTE: An mport ID is not a RapidIO destination ID assigned to a NOTE: An mport ID is not a RapidIO destination ID assigned to a
given local mport device. given local mport device.
...@@ -16,7 +17,9 @@ Contact: Matt Porter <mporter@kernel.crashing.org>, ...@@ -16,7 +17,9 @@ Contact: Matt Porter <mporter@kernel.crashing.org>,
Alexandre Bounine <alexandre.bounine@idt.com> Alexandre Bounine <alexandre.bounine@idt.com>
Description: Description:
(RO) reports RapidIO common transport system size: (RO) reports RapidIO common transport system size:
0 = small (8-bit destination ID, max. 256 devices), 0 = small (8-bit destination ID, max. 256 devices),
1 = large (16-bit destination ID, max. 65536 devices). 1 = large (16-bit destination ID, max. 65536 devices).
What: /sys/class/rapidio_port/rapidioN/port_destid What: /sys/class/rapidio_port/rapidioN/port_destid
...@@ -25,31 +28,32 @@ KernelVersion: v3.15 ...@@ -25,31 +28,32 @@ KernelVersion: v3.15
Contact: Matt Porter <mporter@kernel.crashing.org>, Contact: Matt Porter <mporter@kernel.crashing.org>,
Alexandre Bounine <alexandre.bounine@idt.com> Alexandre Bounine <alexandre.bounine@idt.com>
Description: Description:
(RO) reports RapidIO destination ID assigned to the given
RapidIO mport device. If value 0xFFFFFFFF is returned this means (RO) reports RapidIO destination ID assigned to the given
that no valid destination ID have been assigned to the mport RapidIO mport device. If value 0xFFFFFFFF is returned this means
(yet). Normally, before enumeration/discovery have been executed that no valid destination ID have been assigned to the mport
only fabric enumerating mports have a valid destination ID (yet). Normally, before enumeration/discovery have been executed
assigned to them using "hdid=..." rapidio module parameter. only fabric enumerating mports have a valid destination ID
assigned to them using "hdid=..." rapidio module parameter.
After enumeration or discovery was performed for a given mport device, After enumeration or discovery was performed for a given mport device,
the corresponding subdirectory will also contain subdirectories for each the corresponding subdirectory will also contain subdirectories for each
child RapidIO device connected to the mport. child RapidIO device connected to the mport.
The example below shows mport device subdirectory with several child RapidIO The example below shows mport device subdirectory with several child RapidIO
devices attached to it. devices attached to it::
[rio@rapidio ~]$ ls /sys/class/rapidio_port/rapidio0/ -l [rio@rapidio ~]$ ls /sys/class/rapidio_port/rapidio0/ -l
total 0 total 0
drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0001 drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0001
drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0004 drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0004
drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0007 drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0007
drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0002 drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0002
drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0003 drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0003
drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0005 drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0005
lrwxrwxrwx 1 root root 0 Feb 11 15:11 device -> ../../../0000:01:00.0 lrwxrwxrwx 1 root root 0 Feb 11 15:11 device -> ../../../0000:01:00.0
-r--r--r-- 1 root root 4096 Feb 11 15:11 port_destid -r--r--r-- 1 root root 4096 Feb 11 15:11 port_destid
drwxr-xr-x 2 root root 0 Feb 11 15:11 power drwxr-xr-x 2 root root 0 Feb 11 15:11 power
lrwxrwxrwx 1 root root 0 Feb 11 15:04 subsystem -> ../../../../../../class/rapidio_port lrwxrwxrwx 1 root root 0 Feb 11 15:04 subsystem -> ../../../../../../class/rapidio_port
-r--r--r-- 1 root root 4096 Feb 11 15:11 sys_size -r--r--r-- 1 root root 4096 Feb 11 15:11 sys_size
-rw-r--r-- 1 root root 4096 Feb 11 15:04 uevent -rw-r--r-- 1 root root 4096 Feb 11 15:04 uevent
...@@ -35,13 +35,13 @@ Description: ...@@ -35,13 +35,13 @@ Description:
This will be one of the following strings: This will be one of the following strings:
off - off
on - on
error - error
fast - fast
normal - normal
idle - idle
standby - standby
"off" means the regulator is not supplying power to the "off" means the regulator is not supplying power to the
system. system.
...@@ -74,9 +74,9 @@ Description: ...@@ -74,9 +74,9 @@ Description:
This will be one of the following strings: This will be one of the following strings:
'voltage' - 'voltage'
'current' - 'current'
'unknown' - 'unknown'
'voltage' means the regulator output voltage can be controlled 'voltage' means the regulator output voltage can be controlled
by software. by software.
...@@ -129,11 +129,11 @@ Description: ...@@ -129,11 +129,11 @@ Description:
The opmode value can be one of the following strings: The opmode value can be one of the following strings:
'fast' - 'fast'
'normal' - 'normal'
'idle' - 'idle'
'standby' - 'standby'
'unknown' - 'unknown'
The modes are described in include/linux/regulator/consumer.h The modes are described in include/linux/regulator/consumer.h
...@@ -360,9 +360,9 @@ Description: ...@@ -360,9 +360,9 @@ Description:
This will be one of the following strings: This will be one of the following strings:
'enabled' - 'enabled'
'disabled' - 'disabled'
'unknown' - 'unknown'
'enabled' means the regulator is in bypass mode. 'enabled' means the regulator is in bypass mode.
......
...@@ -16,11 +16,11 @@ Description: Remote processor state ...@@ -16,11 +16,11 @@ Description: Remote processor state
Reports the state of the remote processor, which will be one of: Reports the state of the remote processor, which will be one of:
"offline" - "offline"
"suspended" - "suspended"
"running" - "running"
"crashed" - "crashed"
"invalid" - "invalid"
"offline" means the remote processor is powered off. "offline" means the remote processor is powered off.
...@@ -38,8 +38,8 @@ Description: Remote processor state ...@@ -38,8 +38,8 @@ Description: Remote processor state
Writing this file controls the state of the remote processor. Writing this file controls the state of the remote processor.
The following states can be written: The following states can be written:
"start" - "start"
"stop" - "stop"
Writing "start" will attempt to start the processor running the Writing "start" will attempt to start the processor running the
firmware indicated by, or written to, firmware indicated by, or written to,
......
...@@ -7,6 +7,7 @@ Description: Attribute for calibrating ST-Ericsson AB8500 Real Time Clock ...@@ -7,6 +7,7 @@ Description: Attribute for calibrating ST-Ericsson AB8500 Real Time Clock
calibrate the AB8500.s 32KHz Real Time Clock. calibrate the AB8500.s 32KHz Real Time Clock.
Every 60 seconds the AB8500 will correct the RTC's value Every 60 seconds the AB8500 will correct the RTC's value
by adding to it the value of this attribute. by adding to it the value of this attribute.
The range of the attribute is -127 to +127 in units of The range of the attribute is -127 to +127 in units of
30.5 micro-seconds (half-parts-per-million of the 32KHz clock) 30.5 micro-seconds (half-parts-per-million of the 32KHz clock)
Users: The /vendor/st-ericsson/base_utilities/core/rtc_calibration Users: The /vendor/st-ericsson/base_utilities/core/rtc_calibration
......
...@@ -66,11 +66,14 @@ Description: ...@@ -66,11 +66,14 @@ Description:
<channel> <type> [<bpst offset>] <channel> <type> [<bpst offset>]
to start (or stop) scanning on a channel. <type> is one of: to start (or stop) scanning on a channel. <type> is one of:
0 - scan
1 - scan outside BP == =======================================
2 - scan while inactive 0 scan
3 - scanning disabled 1 scan outside BP
4 - scan (with start time of <bpst offset>) 2 scan while inactive
3 scanning disabled
4 scan (with start time of <bpst offset>)
== =======================================
What: /sys/class/uwb_rc/uwbN/mac_address What: /sys/class/uwb_rc/uwbN/mac_address
Date: July 2008 Date: July 2008
......
...@@ -91,10 +91,13 @@ Description: ...@@ -91,10 +91,13 @@ Description:
h/w strapping (for WDT2 only). h/w strapping (for WDT2 only).
At alternate flash the 'access_cs0' sysfs node provides: At alternate flash the 'access_cs0' sysfs node provides:
ast2400: a way to get access to the primary SPI flash
ast2400:
a way to get access to the primary SPI flash
chip at CS0 after booting from the alternate chip at CS0 after booting from the alternate
chip at CS1. chip at CS1.
ast2500: a way to restore the normal address mapping ast2500:
a way to restore the normal address mapping
from (CS0->CS1, CS1->CS0) to (CS0->CS0, from (CS0->CS1, CS1->CS0) to (CS0->CS0,
CS1->CS1). CS1->CS1).
......
...@@ -9,9 +9,10 @@ Description: The /sys/dev tree provides a method to look up the sysfs ...@@ -9,9 +9,10 @@ Description: The /sys/dev tree provides a method to look up the sysfs
the form "<major>:<minor>". These links point to the the form "<major>:<minor>". These links point to the
corresponding sysfs path for the given device. corresponding sysfs path for the given device.
Example: Example::
$ readlink /sys/dev/block/8:32
../../block/sdc $ readlink /sys/dev/block/8:32
../../block/sdc
Entries in /sys/dev/char and /sys/dev/block will be Entries in /sys/dev/char and /sys/dev/block will be
dynamically created and destroyed as devices enter and dynamically created and destroyed as devices enter and
......
...@@ -8,26 +8,27 @@ Description: ...@@ -8,26 +8,27 @@ Description:
block. block.
For example, on 4-die Xeon platform with up to 6 IIO stacks per For example, on 4-die Xeon platform with up to 6 IIO stacks per
die and, therefore, 6 IIO PMON blocks per die, the mapping of die and, therefore, 6 IIO PMON blocks per die, the mapping of
IIO PMON block 0 exposes as the following: IIO PMON block 0 exposes as the following::
$ ls /sys/devices/uncore_iio_0/die* $ ls /sys/devices/uncore_iio_0/die*
-r--r--r-- /sys/devices/uncore_iio_0/die0 -r--r--r-- /sys/devices/uncore_iio_0/die0
-r--r--r-- /sys/devices/uncore_iio_0/die1 -r--r--r-- /sys/devices/uncore_iio_0/die1
-r--r--r-- /sys/devices/uncore_iio_0/die2 -r--r--r-- /sys/devices/uncore_iio_0/die2
-r--r--r-- /sys/devices/uncore_iio_0/die3 -r--r--r-- /sys/devices/uncore_iio_0/die3
$ tail /sys/devices/uncore_iio_0/die* $ tail /sys/devices/uncore_iio_0/die*
==> /sys/devices/uncore_iio_0/die0 <== ==> /sys/devices/uncore_iio_0/die0 <==
0000:00 0000:00
==> /sys/devices/uncore_iio_0/die1 <== ==> /sys/devices/uncore_iio_0/die1 <==
0000:40 0000:40
==> /sys/devices/uncore_iio_0/die2 <== ==> /sys/devices/uncore_iio_0/die2 <==
0000:80 0000:80
==> /sys/devices/uncore_iio_0/die3 <== ==> /sys/devices/uncore_iio_0/die3 <==
0000:c0 0000:c0
Which means: Which means::
IIO PMU 0 on die 0 belongs to PCI RP on bus 0x00, domain 0x0000
IIO PMU 0 on die 1 belongs to PCI RP on bus 0x40, domain 0x0000 IIO PMU 0 on die 0 belongs to PCI RP on bus 0x00, domain 0x0000
IIO PMU 0 on die 2 belongs to PCI RP on bus 0x80, domain 0x0000 IIO PMU 0 on die 1 belongs to PCI RP on bus 0x40, domain 0x0000
IIO PMU 0 on die 3 belongs to PCI RP on bus 0xc0, domain 0x0000 IIO PMU 0 on die 2 belongs to PCI RP on bus 0x80, domain 0x0000
IIO PMU 0 on die 3 belongs to PCI RP on bus 0xc0, domain 0x0000
...@@ -47,16 +47,19 @@ Description: ...@@ -47,16 +47,19 @@ Description:
online/offline state of the memory section. When written, online/offline state of the memory section. When written,
root can toggle the the online/offline state of a removable root can toggle the the online/offline state of a removable
memory section (see removable file description above) memory section (see removable file description above)
using the following commands. using the following commands::
# echo online > /sys/devices/system/memory/memoryX/state
# echo offline > /sys/devices/system/memory/memoryX/state # echo online > /sys/devices/system/memory/memoryX/state
# echo offline > /sys/devices/system/memory/memoryX/state
For example, if /sys/devices/system/memory/memory22/removable For example, if /sys/devices/system/memory/memory22/removable
contains a value of 1 and contains a value of 1 and
/sys/devices/system/memory/memory22/state contains the /sys/devices/system/memory/memory22/state contains the
string "online" the following command can be executed by string "online" the following command can be executed by
by root to offline that section. by root to offline that section::
# echo offline > /sys/devices/system/memory/memory22/state
# echo offline > /sys/devices/system/memory/memory22/state
Users: hotplug memory remove tools Users: hotplug memory remove tools
http://www.ibm.com/developerworks/wikis/display/LinuxP/powerpc-utils http://www.ibm.com/developerworks/wikis/display/LinuxP/powerpc-utils
...@@ -78,6 +81,7 @@ Description: ...@@ -78,6 +81,7 @@ Description:
For example, the following symbolic link is created for For example, the following symbolic link is created for
memory section 9 on node0: memory section 9 on node0:
/sys/devices/system/memory/memory9/node0 -> ../../node/node0 /sys/devices/system/memory/memory9/node0 -> ../../node/node0
...@@ -90,4 +94,5 @@ Description: ...@@ -90,4 +94,5 @@ Description:
points to the corresponding /sys/devices/system/memory/memoryY points to the corresponding /sys/devices/system/memory/memoryY
memory section directory. For example, the following symbolic memory section directory. For example, the following symbolic
link is created for memory section 9 on node0. link is created for memory section 9 on node0.
/sys/devices/system/node/node0/memory9 -> ../../memory/memory9 /sys/devices/system/node/node0/memory9 -> ../../memory/memory9
...@@ -3,8 +3,9 @@ Date: April 2010 ...@@ -3,8 +3,9 @@ Date: April 2010
Contact: Fabien Chouteau <fabien.chouteau@barco.com> Contact: Fabien Chouteau <fabien.chouteau@barco.com>
Description: Description:
Show the suspend state of an USB composite gadget. Show the suspend state of an USB composite gadget.
1 -> suspended
0 -> resumed - 1 -> suspended
- 0 -> resumed
(_UDC_ is the name of the USB Device Controller driver) (_UDC_ is the name of the USB Device Controller driver)
...@@ -17,5 +18,6 @@ Description: ...@@ -17,5 +18,6 @@ Description:
Storage mode. Storage mode.
Possible values are: Possible values are:
1 -> ignore the FUA flag
0 -> obey the FUA flag - 1 -> ignore the FUA flag
- 0 -> obey the FUA flag
...@@ -123,38 +123,40 @@ KernelVersion: v4.15 ...@@ -123,38 +123,40 @@ KernelVersion: v4.15
Contact: openipmi-developer@lists.sourceforge.net Contact: openipmi-developer@lists.sourceforge.net
Description: Description:
idles: (RO) Number of times the interface was ====================== ========================================
idles (RO) Number of times the interface was
idle while being polled. idle while being polled.
watchdog_pretimeouts: (RO) Number of watchdog pretimeouts. watchdog_pretimeouts (RO) Number of watchdog pretimeouts.
complete_transactions: (RO) Number of completed messages. complete_transactions (RO) Number of completed messages.
events: (RO) Number of IPMI events received from events (RO) Number of IPMI events received from
the hardware. the hardware.
interrupts: (RO) Number of interrupts the driver interrupts (RO) Number of interrupts the driver
handled. handled.
hosed_count: (RO) Number of times the hardware didn't hosed_count (RO) Number of times the hardware didn't
follow the state machine. follow the state machine.
long_timeouts: (RO) Number of times the driver long_timeouts (RO) Number of times the driver
requested a timer while nothing was in requested a timer while nothing was in
progress. progress.
flag_fetches: (RO) Number of times the driver flag_fetches (RO) Number of times the driver
requested flags from the hardware. requested flags from the hardware.
attentions: (RO) Number of time the driver got an attentions (RO) Number of time the driver got an
ATTN from the hardware. ATTN from the hardware.
incoming_messages: (RO) Number of asynchronous messages incoming_messages (RO) Number of asynchronous messages
received. received.
short_timeouts: (RO) Number of times the driver short_timeouts (RO) Number of times the driver
requested a timer while an operation was requested a timer while an operation was
in progress. in progress.
====================== ========================================
What: /sys/devices/platform/ipmi_si.*/interrupts_enabled What: /sys/devices/platform/ipmi_si.*/interrupts_enabled
...@@ -201,38 +203,40 @@ Date: Sep, 2017 ...@@ -201,38 +203,40 @@ Date: Sep, 2017
KernelVersion: v4.15 KernelVersion: v4.15
Contact: openipmi-developer@lists.sourceforge.net Contact: openipmi-developer@lists.sourceforge.net
Description: Description:
hosed: (RO) Number of times the hardware didn't ====================== ========================================
hosed (RO) Number of times the hardware didn't
follow the state machine. follow the state machine.
alerts: (RO) Number of alerts received. alerts (RO) Number of alerts received.
sent_messages: (RO) Number of total messages sent. sent_messages (RO) Number of total messages sent.
sent_message_parts: (RO) Number of message parts sent. sent_message_parts (RO) Number of message parts sent.
Messages may be broken into parts if Messages may be broken into parts if
they are long. they are long.
received_messages: (RO) Number of message responses received_messages (RO) Number of message responses
received. received.
received_message_parts: (RO) Number of message fragments received_message_parts (RO) Number of message fragments
received. received.
events: (RO) Number of received events. events (RO) Number of received events.
watchdog_pretimeouts: (RO) Number of watchdog pretimeouts. watchdog_pretimeouts (RO) Number of watchdog pretimeouts.
flag_fetches: (RO) Number of times a flag fetch was flag_fetches (RO) Number of times a flag fetch was
requested. requested.
send_retries: (RO) Number of time a message was send_retries (RO) Number of time a message was
retried. retried.
receive_retries: (RO) Number of times the receive of a receive_retries (RO) Number of times the receive of a
message was retried. message was retried.
send_errors: (RO) Number of times the send of a send_errors (RO) Number of times the send of a
message failed. message failed.
receive_errors: (RO) Number of errors in receiving receive_errors (RO) Number of errors in receiving
messages. messages.
====================== ========================================
...@@ -169,7 +169,7 @@ Description: ...@@ -169,7 +169,7 @@ Description:
observed CPU idle duration was too short for it observed CPU idle duration was too short for it
(a count). (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 observed CPU idle duration was too long for it
(a count). (a count).
======== ==== ================================================= ======== ==== =================================================
...@@ -601,7 +601,7 @@ Description: Secure Virtual Machine ...@@ -601,7 +601,7 @@ Description: Secure Virtual Machine
Facility in POWER9 and newer processors. i.e., it is a Secure Facility in POWER9 and newer processors. i.e., it is a Secure
Virtual Machine. Virtual Machine.
What: /sys/devices/system/cpu/cpuX/purr What: /sys/devices/system/cpu/cpuX/purr
Date: Apr 2005 Date: Apr 2005
Contact: Linux for PowerPC mailing list <linuxppc-dev@ozlabs.org> Contact: Linux for PowerPC mailing list <linuxppc-dev@ozlabs.org>
Description: PURR ticks for this CPU since the system boot. Description: PURR ticks for this CPU since the system boot.
......
...@@ -3,14 +3,18 @@ Date: July 2011 ...@@ -3,14 +3,18 @@ Date: July 2011
Contact: linux-input@vger.kernel.org Contact: linux-input@vger.kernel.org
Description: This controls if mouse clicks should be generated if the trackpoint is quickly pressed. How fast this press has to be Description: This controls if mouse clicks should be generated if the trackpoint is quickly pressed. How fast this press has to be
is being controlled by press_speed. is being controlled by press_speed.
Values are 0 or 1. Values are 0 or 1.
Applies to Thinkpad USB Keyboard with TrackPoint. Applies to Thinkpad USB Keyboard with TrackPoint.
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/dragging What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/dragging
Date: July 2011 Date: July 2011
Contact: linux-input@vger.kernel.org Contact: linux-input@vger.kernel.org
Description: If this setting is enabled, it is possible to do dragging by pressing the trackpoint. This requires press_to_select to be enabled. Description: If this setting is enabled, it is possible to do dragging by pressing the trackpoint. This requires press_to_select to be enabled.
Values are 0 or 1. Values are 0 or 1.
Applies to Thinkpad USB Keyboard with TrackPoint. Applies to Thinkpad USB Keyboard with TrackPoint.
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/release_to_select What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/release_to_select
...@@ -25,7 +29,9 @@ Date: July 2011 ...@@ -25,7 +29,9 @@ Date: July 2011
Contact: linux-input@vger.kernel.org Contact: linux-input@vger.kernel.org
Description: This setting controls if the mouse click events generated by pressing the trackpoint (if press_to_select is enabled) generate Description: This setting controls if the mouse click events generated by pressing the trackpoint (if press_to_select is enabled) generate
a left or right mouse button click. a left or right mouse button click.
Values are 0 or 1. Values are 0 or 1.
Applies to Thinkpad USB Keyboard with TrackPoint. Applies to Thinkpad USB Keyboard with TrackPoint.
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/sensitivity What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/sensitivity
...@@ -39,12 +45,16 @@ What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid- ...@@ -39,12 +45,16 @@ What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
Date: July 2011 Date: July 2011
Contact: linux-input@vger.kernel.org Contact: linux-input@vger.kernel.org
Description: This setting controls how fast the trackpoint needs to be pressed to generate a mouse click if press_to_select is enabled. Description: This setting controls how fast the trackpoint needs to be pressed to generate a mouse click if press_to_select is enabled.
Values are decimal integers from 1 (slowest) to 255 (fastest). Values are decimal integers from 1 (slowest) to 255 (fastest).
Applies to Thinkpad USB Keyboard with TrackPoint. Applies to Thinkpad USB Keyboard with TrackPoint.
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/fn_lock What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/fn_lock
Date: July 2014 Date: July 2014
Contact: linux-input@vger.kernel.org Contact: linux-input@vger.kernel.org
Description: This setting controls whether Fn Lock is enabled on the keyboard (i.e. if F1 is Mute or F1) Description: This setting controls whether Fn Lock is enabled on the keyboard (i.e. if F1 is Mute or F1)
Values are 0 or 1 Values are 0 or 1
Applies to ThinkPad Compact (USB|Bluetooth) Keyboard with TrackPoint. Applies to ThinkPad Compact (USB|Bluetooth) Keyboard with TrackPoint.
...@@ -29,12 +29,13 @@ Contact: linux-input@vger.kernel.org ...@@ -29,12 +29,13 @@ Contact: linux-input@vger.kernel.org
Description: Description:
Threholds to override activation slack. Threholds to override activation slack.
activation_width: (RW) Width threshold to immediately ================= =====================================
activation_width (RW) Width threshold to immediately
start processing touch events. start processing touch events.
activation_height: (RW) Height threshold to immediately activation_height (RW) Height threshold to immediately
start processing touch events. start processing touch events.
================= =====================================
What: /sys/bus/hid/drivers/ntrig/<dev>/min_width What: /sys/bus/hid/drivers/ntrig/<dev>/min_width
What: /sys/bus/hid/drivers/ntrig/<dev>/min_height What: /sys/bus/hid/drivers/ntrig/<dev>/min_height
...@@ -44,11 +45,13 @@ Contact: linux-input@vger.kernel.org ...@@ -44,11 +45,13 @@ Contact: linux-input@vger.kernel.org
Description: Description:
Minimum size contact accepted. Minimum size contact accepted.
min_width: (RW) Minimum touch contact width to decide ========== ===========================================
min_width (RW) Minimum touch contact width to decide
activation and activity. activation and activity.
min_height: (RW) Minimum touch contact height to decide min_height (RW) Minimum touch contact height to decide
activation and activity. activation and activity.
========== ===========================================
What: /sys/bus/hid/drivers/ntrig/<dev>/sensor_physical_width What: /sys/bus/hid/drivers/ntrig/<dev>/sensor_physical_width
......
...@@ -3,17 +3,21 @@ Date: March 2010 ...@@ -3,17 +3,21 @@ Date: March 2010
Contact: Stefan Achatz <erazor_de@users.sourceforge.net> Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
Description: It is possible to switch the dpi setting of the mouse with the Description: It is possible to switch the dpi setting of the mouse with the
press of a button. press of a button.
When read, this file returns the raw number of the actual dpi When read, this file returns the raw number of the actual dpi
setting reported by the mouse. This number has to be further setting reported by the mouse. This number has to be further
processed to receive the real dpi value: processed to receive the real dpi value:
===== =====
VALUE DPI VALUE DPI
===== =====
1 800 1 800
2 1200 2 1200
3 1600 3 1600
4 2000 4 2000
5 2400 5 2400
6 3200 6 3200
===== =====
This file is readonly. This file is readonly.
Users: http://roccat.sourceforge.net Users: http://roccat.sourceforge.net
...@@ -22,6 +26,7 @@ What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid- ...@@ -22,6 +26,7 @@ What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
Date: March 2010 Date: March 2010
Contact: Stefan Achatz <erazor_de@users.sourceforge.net> Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
Description: When read, this file returns the number of the actual profile. Description: When read, this file returns the number of the actual profile.
This file is readonly. This file is readonly.
Users: http://roccat.sourceforge.net Users: http://roccat.sourceforge.net
...@@ -33,6 +38,7 @@ Description: When read, this file returns the raw integer version number of the ...@@ -33,6 +38,7 @@ Description: When read, this file returns the raw integer version number of the
further usage in other programs. To receive the real version further usage in other programs. To receive the real version
number the decimal point has to be shifted 2 positions to the number the decimal point has to be shifted 2 positions to the
left. E.g. a returned value of 138 means 1.38 left. E.g. a returned value of 138 means 1.38
This file is readonly. This file is readonly.
Users: http://roccat.sourceforge.net Users: http://roccat.sourceforge.net
...@@ -43,10 +49,13 @@ Description: The mouse can store 5 profiles which can be switched by the ...@@ -43,10 +49,13 @@ Description: The mouse can store 5 profiles which can be switched by the
press of a button. A profile holds information like button press of a button. A profile holds information like button
mappings, sensitivity, the colors of the 5 leds and light mappings, sensitivity, the colors of the 5 leds and light
effects. effects.
When read, these files return the respective profile. The When read, these files return the respective profile. The
returned data is 975 bytes in size. returned data is 975 bytes in size.
When written, this file lets one write the respective profile When written, this file lets one write the respective profile
data back to the mouse. The data has to be 975 bytes long. data back to the mouse. The data has to be 975 bytes long.
The mouse will reject invalid data, whereas the profile number The mouse will reject invalid data, whereas the profile number
stored in the profile doesn't need to fit the number of the stored in the profile doesn't need to fit the number of the
store. store.
...@@ -58,6 +67,7 @@ Contact: Stefan Achatz <erazor_de@users.sourceforge.net> ...@@ -58,6 +67,7 @@ Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
Description: When read, this file returns the settings stored in the mouse. Description: When read, this file returns the settings stored in the mouse.
The size of the data is 36 bytes and holds information like the The size of the data is 36 bytes and holds information like the
startup_profile, tcu state and calibration_data. startup_profile, tcu state and calibration_data.
When written, this file lets write settings back to the mouse. When written, this file lets write settings back to the mouse.
The data has to be 36 bytes long. The mouse will reject invalid The data has to be 36 bytes long. The mouse will reject invalid
data. data.
...@@ -67,8 +77,10 @@ What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid- ...@@ -67,8 +77,10 @@ What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
Date: March 2010 Date: March 2010
Contact: Stefan Achatz <erazor_de@users.sourceforge.net> Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
Description: The integer value of this attribute ranges from 1 to 5. Description: The integer value of this attribute ranges from 1 to 5.
When read, this attribute returns the number of the profile When read, this attribute returns the number of the profile
that's active when the mouse is powered on. that's active when the mouse is powered on.
When written, this file sets the number of the startup profile When written, this file sets the number of the startup profile
and the mouse activates this profile immediately. and the mouse activates this profile immediately.
Users: http://roccat.sourceforge.net Users: http://roccat.sourceforge.net
...@@ -80,9 +92,12 @@ Description: The mouse has a "Tracking Control Unit" which lets the user ...@@ -80,9 +92,12 @@ Description: The mouse has a "Tracking Control Unit" which lets the user
calibrate the laser power to fit the mousepad surface. calibrate the laser power to fit the mousepad surface.
When read, this file returns the current state of the TCU, When read, this file returns the current state of the TCU,
where 0 means off and 1 means on. where 0 means off and 1 means on.
Writing 0 in this file will switch the TCU off. Writing 0 in this file will switch the TCU off.
Writing 1 in this file will start the calibration which takes Writing 1 in this file will start the calibration which takes
around 6 seconds to complete and activates the TCU. around 6 seconds to complete and activates the TCU.
Users: http://roccat.sourceforge.net Users: http://roccat.sourceforge.net
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight
...@@ -93,14 +108,18 @@ Description: The mouse can be equipped with one of four supplied weights ...@@ -93,14 +108,18 @@ Description: The mouse can be equipped with one of four supplied weights
and its value can be read out. When read, this file returns the and its value can be read out. When read, this file returns the
raw value returned by the mouse which eases further processing raw value returned by the mouse which eases further processing
in other software. in other software.
The values map to the weights as follows: The values map to the weights as follows:
===== ======
VALUE WEIGHT VALUE WEIGHT
===== ======
0 none 0 none
1 5g 1 5g
2 10g 2 10g
3 15g 3 15g
4 20g 4 20g
===== ======
This file is readonly. This file is readonly.
Users: http://roccat.sourceforge.net Users: http://roccat.sourceforge.net
...@@ -20,6 +20,7 @@ Description: This file contains the currently connected and initialized ...@@ -20,6 +20,7 @@ Description: This file contains the currently connected and initialized
the official Nintendo Nunchuck extension and classic is the the official Nintendo Nunchuck extension and classic is the
Nintendo Classic Controller extension. The motionp extension can Nintendo Classic Controller extension. The motionp extension can
be combined with the other two. be combined with the other two.
Starting with kernel-version 3.11 Motion Plus hotplugging is Starting with kernel-version 3.11 Motion Plus hotplugging is
supported and if detected, it's no longer reported as static supported and if detected, it's no longer reported as static
extension. You will get uevent notifications for the motion-plus extension. You will get uevent notifications for the motion-plus
......
...@@ -4,6 +4,7 @@ Contact: linux-input@vger.kernel.org ...@@ -4,6 +4,7 @@ Contact: linux-input@vger.kernel.org
Description: Reports the firmware version provided by the touchscreen, for example "00_T6" on a EXC80H60 Description: Reports the firmware version provided by the touchscreen, for example "00_T6" on a EXC80H60
Access: Read Access: Read
Valid values: Represented as string Valid values: Represented as string
What: /sys/bus/i2c/devices/xxx/model What: /sys/bus/i2c/devices/xxx/model
...@@ -12,4 +13,5 @@ Contact: linux-input@vger.kernel.org ...@@ -12,4 +13,5 @@ Contact: linux-input@vger.kernel.org
Description: Reports the model identification provided by the touchscreen, for example "Orion_1320" on a EXC80H60 Description: Reports the model identification provided by the touchscreen, for example "Orion_1320" on a EXC80H60
Access: Read Access: Read
Valid values: Represented as string Valid values: Represented as string
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment