ABI testing symbols

Documents interfaces that are felt to be stable, as the main development of this interface has been completed.

The interface can be changed to add new features, but the current interface will not break by doing this, unless grave errors or security problems are found in them.

Userspace programs can start to rely on these interfaces, but they must be aware of changes that can occur before these interfaces move to be marked stable.

Programs that use these interfaces are strongly encouraged to add their name to the description of these interfaces, so that the kernel developers can easily notify them if any changes occur.

Symbols under /config/acpi

/config/acpi

Defined on file configfs-acpi

This represents the ACPI subsystem entry point directory. It contains sub-groups corresponding to ACPI configurable options.

/config/acpi/table

Defined on file configfs-acpi

This group contains the configuration for user defined ACPI tables. The attributes of a user define table are:

aml

• a binary attribute that the user can use to fill in the ACPI aml definitions. Once the aml data is written to this file and the file is closed the table will be loaded and ACPI devices will be enumerated. To check if the operation is successful the user must check the error code for close(). If the operation is successful, subsequent writes to this attribute will fail.

The rest of the attributes are read-only and are valid only after the table has been loaded by filling the aml entry:

signature

• ASCII table signature

length

• length of table in bytes, including the header

revision

• ACPI Specification minor version number

oem_id

• ASCII OEM identification

oem_table_id

• ASCII OEM table identification

oem_revision

• OEM revision number

asl_compiler_id

• ASCII ASL compiler vendor ID

asl_compiler_revision

• ASL compiler version

Symbols under /config/iio

/config/iio

Defined on file configfs-iio

This represents Industrial IO configuration entry point directory. It contains sub-groups corresponding to IIO objects.

/config/iio/devices

Defined on file configfs-iio

Industrial IO software devices directory.

/config/iio/devices/dummy

Defined on file configfs-iio

Dummy IIO devices directory. Creating a directory here will result in creating a dummy IIO device in the IIO subystem.

/config/iio/triggers

Defined on file configfs-iio

Industrial IO software triggers directory.

/config/iio/triggers/hrtimers

Defined on file configfs-iio

High resolution timers directory. Creating a directory here will result in creating a hrtimer trigger in the IIO subsystem.

Symbols under /config/pcie-gadget

/config/pcie-gadget

Defined on file configfs-spear-pcie-gadget

Interface is used to configure selected dual mode PCIe controller as device and then program its various registers to configure it as a particular device type. This interfaces can be used to show spear’s PCIe device capability.

Nodes are only visible when configfs is mounted. To mount configfs in /config directory use:

# mount -t configfs none /config/

For nth PCIe Device Controller /config/pcie-gadget.n/:

link	used to enable ltssm and read its status.
int_type	used to configure and read type of supported interrupt
no_of_msi	used to configure number of MSI vector needed and to read no of MSI granted.
inta	write 1 to assert INTA and 0 to de-assert.
send_msi	write MSI vector to be sent.
vendor_id	used to write and read vendor id (hex)
device_id	used to write and read device id (hex)
bar0_size	used to write and read bar0_size
bar0_address	used to write and read bar0 mapped area in hex.
bar0_rw_offset	used to write and read offset of bar0 where bar0_data will be written or read.
bar0_data	used to write and read data at bar0_rw_offset.

Symbols under /config/rdma_cm

/config/rdma_cm

Defined on file configfs-rdma_cm

Interface is used to configure RDMA-cable HCAs in respect to RDMA-CM attributes.

Attributes are visible only when configfs is mounted. To mount configfs in /config directory use: # mount -t configfs none /config/

In order to set parameters related to a specific HCA, a directory for this HCA has to be created: mkdir -p /config/rdma_cm/<hca>

/config/rdma_cm/<hca>/ports/<port-num>/default_roce_mode

Defined on file configfs-rdma_cm

RDMA-CM based connections from HCA <hca> at port <port-num> will be initiated with this RoCE type as default. The possible RoCE types are either “IB/RoCE v1” or “RoCE v2”. This parameter has RW access.

/config/rdma_cm/<hca>/ports/<port-num>/default_roce_tos

Defined on file configfs-rdma_cm

RDMA-CM QPs from HCA <hca> at port <port-num> will be created with this TOS as default. This can be overridden by using the rdma_set_option API. The possible RoCE TOS values are 0-255.

Symbols under /config/stp-policy

/config/stp-policy

Defined on file configfs-stp-policy

This group contains policies mandating Master/Channel allocation for software sources wishing to send trace data over an STM device.

/config/stp-policy/<device>.<policy>

Defined on file configfs-stp-policy

This group is the root of a policy; its name is a concatenation of an stm device name to which this policy applies and an arbitrary string. If <device> part doesn’t match an existing stm device, mkdir will fail with ENODEV; if that device already has a policy assigned to it, mkdir will fail with EBUSY.

/config/stp-policy/<device>.<policy>/<node>

Defined on file configfs-stp-policy

Policy node is a string identifier that software clients will use to request a master/channel to be allocated and assigned to them.

/config/stp-policy/<device>.<policy>/<node>/channels

Defined on file configfs-stp-policy

Range of channels from which to allocate for users of this node. Write two numbers: the first channel and the last channel number.

/config/stp-policy/<device>.<policy>/<node>/masters

Defined on file configfs-stp-policy

Range of masters from which to allocate for users of this node. Write two numbers: the first master and the last master number.

/config/stp-policy/<device>.<policy>/device

Defined on file configfs-stp-policy

STM device to which this policy applies, read only. Same as the <device> component of its parent directory.

/config/stp-policy/<device>:p_sys-t.<policy>/<node>/clocksync_interval

Defined on file configfs-stp-policy-p_sys-t

Time interval in milliseconds. Send a CLOCKSYNC packet if this many milliseconds have passed since the previous CLOCKSYNC packet from this source. Zero is the default and stands for “never send the CLOCKSYNC”. It makes sense to use this option with sources that generate constant and/or periodic data, like stm_heartbeat.

/config/stp-policy/<device>:p_sys-t.<policy>/<node>/do_len

Defined on file configfs-stp-policy-p_sys-t

Include payload length in the MIPI SyS-T header, boolean. If enabled, the SyS-T protocol encoder will include payload length in each packet’s metadata. This is normally redundant if the underlying transport protocol supports marking message boundaries (which STP does), so this is off by default.

/config/stp-policy/<device>:p_sys-t.<policy>/<node>/ts_interval

Defined on file configfs-stp-policy-p_sys-t

Time interval in milliseconds. Include a timestamp in the MIPI SyS-T packet metadata, if this many milliseconds have passed since the previous packet from this source. Zero is the default and stands for “never send the timestamp”.

/config/stp-policy/<device>:p_sys-t.<policy>/<node>/uuid

Defined on file configfs-stp-policy-p_sys-t

UUID source identifier string, RW. Default value is randomly generated at the mkdir <node> time. Data coming from trace sources that use this <node> will be tagged with this UUID in the MIPI SyS-T packet stream, to allow the decoder to discern between different sources within the same master/channel range, and identify the higher level decoders that may be needed for each source.

Symbols under /config/usb-gadget

/config/usb-gadget

Defined on file configfs-usb-gadget

This group contains sub-groups corresponding to created USB gadgets.

/config/usb-gadget/gadget

Defined on file configfs-usb-gadget

The attributes of a gadget:

UDC	bind a gadget to UDC/unbind a gadget; write UDC’s name found in /sys/class/udc/* to bind a gadget, empty string “” to unbind.
max_speed	maximum speed the driver supports. Valid names are super-speed-plus, super-speed, high-speed, full-speed, and low-speed.
bDeviceClass	USB device class code
bDeviceSubClass	USB device subclass code
bDeviceProtocol	USB device protocol code
bMaxPacketSize0	maximum endpoint 0 packet size
bcdDevice	bcd device release number
bcdUSB	bcd USB specification version number
idProduct	product ID
idVendor	vendor ID

/config/usb-gadget/gadget/configs

Defined on file configfs-usb-gadget

This group contains a USB gadget’s configurations

/config/usb-gadget/gadget/configs/config

Defined on file configfs-usb-gadget

The attributes of a configuration:

bmAttributes	configuration characteristics
MaxPower	maximum power consumption from the bus

/config/usb-gadget/gadget/configs/config/strings

Defined on file configfs-usb-gadget

This group contains subdirectories for language-specific strings for this configuration.

/config/usb-gadget/gadget/configs/config/strings/language

Defined on file configfs-usb-gadget

The attributes:

configuration

configuration description

/config/usb-gadget/gadget/functions

Defined on file configfs-usb-gadget

This group contains functions available to this USB gadget.

/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>

Defined on file configfs-usb-gadget

This group contains “Feature Descriptors” specific for one gadget’s USB interface or one interface group described by an IAD.

The attributes:

compatible_id	8-byte string for “Compatible ID”
sub_compatible_id	8-byte string for “Sub Compatible ID”

/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>

Defined on file configfs-usb-gadget

This group contains “Extended Property Descriptors” specific for one gadget’s USB interface or one interface group described by an IAD.

The attributes:

type	value 1..7 for interpreting the data 1: unicode string 2: unicode string with environment variable 3: binary 4: little-endian 32-bit 5: big-endian 32-bit 6: unicode string with a symbolic link 7: multiple unicode strings
data	blob of data to be interpreted depending on type

/config/usb-gadget/gadget/functions/Loopback.name

Defined on file configfs-usb-gadget-loopback

The attributes:

qlen	depth of loopback queue
buflen	buffer length

/config/usb-gadget/gadget/functions/SourceSink.name

Defined on file configfs-usb-gadget-sourcesink

The attributes:

pattern	0 (all zeros), 1 (mod63), 2 (none)
isoc_interval	1..16
isoc_maxpacket	0 - 1023 (fs), 0 - 1024 (hs/ss)
isoc_mult	0..2 (hs/ss only)
isoc_maxburst	0..15 (ss only)
buflen	buffer length
bulk_qlen	depth of queue for bulk
iso_qlen	depth of queue for iso

/config/usb-gadget/gadget/functions/acm.name

Defined on file configfs-usb-gadget-acm

This item contains just one readonly attribute: port_num. It contains the port number of the /dev/ttyGS<n> device associated with acm function’s instance “name”.

/config/usb-gadget/gadget/functions/ecm.name

Defined on file configfs-usb-gadget-ecm

The attributes:

ifname

• network device interface name associated with this function instance

qmult

• queue length multiplier for high and super speed

host_addr

• MAC address of host’s end of this Ethernet over USB link

dev_addr

• MAC address of device’s end of this Ethernet over USB link

/config/usb-gadget/gadget/functions/eem.name

Defined on file configfs-usb-gadget-eem

The attributes:

ifname	network device interface name associated with this function instance
qmult	queue length multiplier for high and super speed
host_addr	MAC address of host’s end of this Ethernet over USB link
dev_addr	MAC address of device’s end of this Ethernet over USB link

/config/usb-gadget/gadget/functions/ffs.name

Defined on file configfs-usb-gadget-ffs

The purpose of this directory is to create and remove it.

A corresponding USB function instance is created/removed. There are no attributes here.

All parameters are set through FunctionFS.

/config/usb-gadget/gadget/functions/geth.name

Defined on file configfs-usb-gadget-subset

The attributes:

ifname	network device interface name associated with this function instance
qmult	queue length multiplier for high and super speed
host_addr	MAC address of host’s end of this Ethernet over USB link
dev_addr	MAC address of device’s end of this Ethernet over USB link

/config/usb-gadget/gadget/functions/gser.name

Defined on file configfs-usb-gadget-serial

This item contains just one readonly attribute: port_num. It contains the port number of the /dev/ttyGS<n> device associated with gser function’s instance “name”.

/config/usb-gadget/gadget/functions/hid.name

Defined on file configfs-usb-gadget-hid

The attributes:

protocol	HID protocol to use
report_desc	blob corresponding to HID report descriptors except the data passed through /dev/hidg<N>
report_length	HID report length
subclass	HID device subclass to use

/config/usb-gadget/gadget/functions/mass_storage.name

Defined on file configfs-usb-gadget-mass-storage

The attributes:

stall	Set to permit function to halt bulk endpoints. Disabled on some USB devices known not to work correctly. You should set it to true.
num_buffers	Number of pipeline buffers. Valid numbers are 2..4. Available only if CONFIG_USB_GADGET_DEBUG_FILES is set.

/config/usb-gadget/gadget/functions/mass_storage.name/lun.name

Defined on file configfs-usb-gadget-mass-storage

The attributes:

file	The path to the backing file for the LUN. Required if LUN is not marked as removable.
ro	Flag specifying access to the LUN shall be read-only. This is implied if CD-ROM emulation is enabled as well as when it was impossible to open “filename” in R/W mode.
removable	Flag specifying that LUN shall be indicated as being removable.
cdrom	Flag specifying that LUN shall be reported as being a CD-ROM.
nofua	Flag specifying that FUA flag in SCSI WRITE(10,12)

/config/usb-gadget/gadget/functions/midi.name

Defined on file configfs-usb-gadget-midi

The attributes:

index	index value for the USB MIDI adapter
id	ID string for the USB MIDI adapter
buflen	MIDI buffer length
qlen	USB read request queue length
in_ports	number of MIDI input ports
out_ports	number of MIDI output ports

/config/usb-gadget/gadget/functions/ncm.name

Defined on file configfs-usb-gadget-ncm

The attributes:

ifname - network device interface name associated with

this function instance

qmult - queue length multiplier for high and

super speed

host_addr - MAC address of host’s end of this

Ethernet over USB link

dev_addr - MAC address of device’s end of this

Ethernet over USB link

/config/usb-gadget/gadget/functions/obex.name

Defined on file configfs-usb-gadget-obex

This item contains just one readonly attribute: port_num. It contains the port number of the /dev/ttyGS<n> device associated with obex function’s instance “name”.

/config/usb-gadget/gadget/functions/phonet.name

Defined on file configfs-usb-gadget-phonet

This item contains just one readonly attribute: ifname. It contains the network interface name assigned during network device registration.

/config/usb-gadget/gadget/functions/printer.name

Defined on file configfs-usb-gadget-printer

The attributes:

pnp_string	Data to be passed to the host in pnp string
q_len	Number of requests per endpoint

/config/usb-gadget/gadget/functions/rndis.name

Defined on file configfs-usb-gadget-rndis

The attributes:

ifname	network device interface name associated with this function instance
qmult	queue length multiplier for high and super speed
host_addr	MAC address of host’s end of this Ethernet over USB link
dev_addr	MAC address of device’s end of this Ethernet over USB link
class	USB interface class, default is 02 (hex)
subclass	USB interface subclass, default is 06 (hex)
protocol	USB interface protocol, default is 00 (hex)

/config/usb-gadget/gadget/functions/tcm.name

Defined on file configfs-usb-gadget-tcm

There are no attributes because all the configuration is performed in the “target” subsystem of configfs.

/config/usb-gadget/gadget/functions/uac1.name

Defined on file configfs-usb-gadget-uac1

The attributes:

c_chmask	capture channel mask
c_srate	capture sampling rate
c_ssize	capture sample size (bytes)
p_chmask	playback channel mask
p_srate	playback sampling rate
p_ssize	playback sample size (bytes)
req_number	the number of pre-allocated request for both capture and playback

/config/usb-gadget/gadget/functions/uac1_legacy.name

Defined on file configfs-usb-gadget-uac1_legacy

The attributes:

audio_buf_size - audio buffer size fn_cap - capture pcm device file name fn_cntl - control device file name fn_play - playback pcm device file name req_buf_size - ISO OUT endpoint request buffer size req_count - ISO OUT endpoint request count

/config/usb-gadget/gadget/functions/uac2.name

Defined on file configfs-usb-gadget-uac2

The attributes:

c_chmask	capture channel mask
c_srate	capture sampling rate
c_ssize	capture sample size (bytes)
p_chmask	playback channel mask
p_srate	playback sampling rate
p_ssize	playback sample size (bytes)

/config/usb-gadget/gadget/functions/uvc.name

Defined on file configfs-usb-gadget-uvc

UVC function directory

streaming_maxburst	0..15 (ss only)
streaming_maxpacket	1..1023 (fs), 1..3072 (hs/ss)
streaming_interval	1..16

/config/usb-gadget/gadget/functions/uvc.name/control

Defined on file configfs-usb-gadget-uvc

Control descriptors

All attributes read only:

bInterfaceNumber

USB interface number for this streaming interface

/config/usb-gadget/gadget/functions/uvc.name/control/class

Defined on file configfs-usb-gadget-uvc

Class descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/class/fs

Defined on file configfs-usb-gadget-uvc

Full speed control class descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/class/ss

Defined on file configfs-usb-gadget-uvc

Super speed control class descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/header

Defined on file configfs-usb-gadget-uvc

Control header descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/header/name

Defined on file configfs-usb-gadget-uvc

Specific control header descriptors

dwClockFrequency bcdUVC

/config/usb-gadget/gadget/functions/uvc.name/control/processing

Defined on file configfs-usb-gadget-uvc

Processing unit descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/processing/default

Defined on file configfs-usb-gadget-uvc

Default processing unit descriptors

All attributes read only:

iProcessing	index of string descriptor
bmControls	bitmap specifying which controls are supported for the video stream
wMaxMultiplier	maximum digital magnification x100
bSourceID	id of the terminal to which this unit is connected
bUnitID	a non-zero id of this unit

/config/usb-gadget/gadget/functions/uvc.name/control/terminal

Defined on file configfs-usb-gadget-uvc

Terminal descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera

Defined on file configfs-usb-gadget-uvc

Camera terminal descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera/default

Defined on file configfs-usb-gadget-uvc

Default camera terminal descriptors

All attributes read only:

bmControls	bitmap specifying which controls are supported for the video stream
wOcularFocalLength	the value of Locular
wObjectiveFocalLengthMax	the value of Lmin
wObjectiveFocalLengthMin	the value of Lmax
iTerminal	index of string descriptor
bAssocTerminal	id of the output terminal to which this terminal is connected
wTerminalType	terminal type
bTerminalID	a non-zero id of this terminal

/config/usb-gadget/gadget/functions/uvc.name/control/terminal/output

Defined on file configfs-usb-gadget-uvc

Output terminal descriptors

/config/usb-gadget/gadget/functions/uvc.name/control/terminal/output/default

Defined on file configfs-usb-gadget-uvc

Default output terminal descriptors

All attributes read only:

iTerminal	index of string descriptor
bSourceID	id of the terminal to which this terminal is connected
bAssocTerminal	id of the input terminal to which this output terminal is associated
wTerminalType	terminal type
bTerminalID	a non-zero id of this terminal

/config/usb-gadget/gadget/functions/uvc.name/streaming

Defined on file configfs-usb-gadget-uvc

Streaming descriptors

All attributes read only:

bInterfaceNumber

USB interface number for this streaming interface

/config/usb-gadget/gadget/functions/uvc.name/streaming/class

Defined on file configfs-usb-gadget-uvc

Streaming class descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/class/fs

Defined on file configfs-usb-gadget-uvc

Full speed streaming class descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/class/hs

Defined on file configfs-usb-gadget-uvc

High speed streaming class descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/class/ss

Defined on file configfs-usb-gadget-uvc

Super speed streaming class descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching

Defined on file configfs-usb-gadget-uvc

Color matching descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching/default

Defined on file configfs-usb-gadget-uvc

Default color matching descriptors

All attributes read only:

bMatrixCoefficients	matrix used to compute luma and chroma values from the color primaries
bTransferCharacteristics	optoelectronic transfer characteristic of the source picutre, also called the gamma function
bColorPrimaries	color primaries and the reference white

/config/usb-gadget/gadget/functions/uvc.name/streaming/header

Defined on file configfs-usb-gadget-uvc

Streaming header descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/header/name

Defined on file configfs-usb-gadget-uvc

Specific streaming header descriptors

All attributes read only:

bTriggerUsage	how the host software will respond to a hardware trigger interrupt event
bTriggerSupport	flag specifying if hardware triggering is supported
bStillCaptureMethod	method of still image caputre supported
bTerminalLink	id of the output terminal to which the video endpoint of this interface is connected
bmInfo	capabilities of this video streaming interface

/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg

Defined on file configfs-usb-gadget-uvc

MJPEG format descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name

Defined on file configfs-usb-gadget-uvc

Specific MJPEG format descriptors

All attributes read only, except bmaControls and bDefaultFrameIndex:

bFormatIndex	unique id for this format descriptor; only defined after parent header is linked into the streaming class; read-only
bmaControls	this format’s data for bmaControls in the streaming header
bmInterfaceFlags	specifies interlace information, read-only
bAspectRatioY	the X dimension of the picture aspect ratio, read-only
bAspectRatioX	the Y dimension of the picture aspect ratio, read-only
bmFlags	characteristics of this format, read-only
bDefaultFrameIndex	optimum frame index for this stream

/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name

Defined on file configfs-usb-gadget-uvc

Specific MJPEG frame descriptors

bFrameIndex	unique id for this framedescriptor; only defined after parent format is linked into the streaming header; read-only
dwFrameInterval	indicates how frame interval can be programmed; a number of values separated by newline can be specified
dwDefaultFrameInterval	the frame interval the device would like to use as default
dwMaxVideoFrameBufferSize	the maximum number of bytes the compressor will produce for a video frame or still image
dwMaxBitRate	the maximum bit rate at the shortest frame interval in bps
dwMinBitRate	the minimum bit rate at the longest frame interval in bps
wHeight	height of decoded bitmap frame in px
wWidth	width of decoded bitmam frame in px
bmCapabilities	still image support, fixed frame-rate support

/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed

Defined on file configfs-usb-gadget-uvc

Uncompressed format descriptors

/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name

Defined on file configfs-usb-gadget-uvc

Specific uncompressed format descriptors

bFormatIndex	unique id for this format descriptor; only defined after parent header is linked into the streaming class; read-only
bmaControls	this format’s data for bmaControls in the streaming header
bmInterfaceFlags	specifies interlace information, read-only
bAspectRatioY	the X dimension of the picture aspect ratio, read-only
bAspectRatioX	the Y dimension of the picture aspect ratio, read-only
bDefaultFrameIndex	optimum frame index for this stream
bBitsPerPixel	number of bits per pixel used to specify color in the decoded video frame
guidFormat	globally unique id used to identify stream-encoding format

/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name

Defined on file configfs-usb-gadget-uvc

Specific uncompressed frame descriptors

bFrameIndex	unique id for this framedescriptor; only defined after parent format is linked into the streaming header; read-only
dwFrameInterval	indicates how frame interval can be programmed; a number of values separated by newline can be specified
dwDefaultFrameInterval	the frame interval the device would like to use as default
dwMaxVideoFrameBufferSize	the maximum number of bytes the compressor will produce for a video frame or still image
dwMaxBitRate	the maximum bit rate at the shortest frame interval in bps
dwMinBitRate	the minimum bit rate at the longest frame interval in bps
wHeight	height of decoded bitmap frame in px
wWidth	width of decoded bitmam frame in px
bmCapabilities	still image support, fixed frame-rate support

/config/usb-gadget/gadget/os_desc

Defined on file configfs-usb-gadget

This group contains “OS String” extension handling attributes.

use	flag turning “OS Desctiptors” support on/off
b_vendor_code	one-byte value used for custom per-device and per-interface requests
qw_sign	an identifier to be reported as “OS String” proper

/config/usb-gadget/gadget/strings

Defined on file configfs-usb-gadget

This group contains subdirectories for language-specific strings for this gadget.

/config/usb-gadget/gadget/strings/language

Defined on file configfs-usb-gadget

The attributes:

serialnumber	gadget’s serial number (string)
product	gadget’s product description
manufacturer	gadget’s manufacturer description

Symbols under /dev/gpiochip

/dev/gpiochip[0-9]+

Defined on file gpio-cdev

The character device files /dev/gpiochip* are the interface between GPIO chips and userspace.

The ioctl(2)-based ABI is defined and documented in [include/uapi]<linux/gpio.h>.

The following file operations are supported:

open(2)

Currently the only useful flags are O_RDWR.

ioctl(2)

Initiate various actions.

See the inline documentation in [include/uapi]<linux/gpio.h> for descriptions of all ioctls.

close(2)

Stops and free up the I/O contexts that was associated with the file descriptor.

Users: TBD

Symbols under /dev/kmsg

/dev/kmsg

Defined on file dev-kmsg

The /dev/kmsg character device node provides userspace access to the kernel’s printk buffer.

Injecting messages:

Every write() to the opened device node places a log entry in the kernel’s printk buffer.

The logged line can be prefixed with a <N> syslog prefix, which carries the syslog priority and facility. The single decimal prefix number is composed of the 3 lowest bits being the syslog priority and the next 8 bits the syslog facility number.

If no prefix is given, the priority number is the default kernel log priority and the facility number is set to LOG_USER (1). It is not possible to inject messages from userspace with the facility number LOG_KERN (0), to make sure that the origin of the messages can always be reliably determined.

Accessing the buffer:

Every read() from the opened device node receives one record of the kernel’s printk buffer.

The first read() directly following an open() always returns first message in the buffer; there is no kernel-internal persistent state; many readers can concurrently open the device and read from it, without affecting other readers.

Every read() will receive the next available record. If no more records are available read() will block, or if O_NONBLOCK is used -EAGAIN returned.

Messages in the record ring buffer get overwritten as whole, there are never partial messages received by read().

In case messages get overwritten in the circular buffer while the device is kept open, the next read() will return -EPIPE, and the seek position be updated to the next available record. Subsequent reads() will return available records again.

Unlike the classic syslog() interface, the 64 bit record sequence numbers allow to calculate the amount of lost messages, in case the buffer gets overwritten. And they allow to reconnect to the buffer and reconstruct the read position if needed, without limiting the interface to a single reader.

The device supports seek with the following parameters:

SEEK_SET, 0

seek to the first entry in the buffer

SEEK_END, 0

seek after the last entry in the buffer

SEEK_DATA, 0

seek after the last record available at the time the last SYSLOG_ACTION_CLEAR was issued.

Other seek operations or offsets are not supported because of the special behavior this device has. The device allows to read or write only whole variable length messages (records) that are stored in a ring buffer.

Because of the non-standard behavior also the error values are non-standard. -ESPIPE is returned for non-zero offset. -EINVAL is returned for other operations, e.g. SEEK_CUR. This behavior and values are historical and could not be modified without the risk of breaking userspace.

The output format consists of a prefix carrying the syslog prefix including priority and facility, the 64 bit message sequence number and the monotonic timestamp in microseconds, and a flag field. All fields are separated by a ‘,’.

Future extensions might add more comma separated values before the terminating ‘;’. Unknown fields and values should be gracefully ignored.

The human readable text string starts directly after the ‘;’ and is terminated by a ‘n’. Untrusted values derived from hardware or other facilities are printed, therefore all non-printable characters and ‘’ itself in the log message are escaped by “x00” C-style hex encoding.

A line starting with ‘ ‘, is a continuation line, adding key/value pairs to the log message, which provide the machine readable context of the message, for reliable processing in userspace.

Example:

7,160,424069,-;pci_root PNP0A03:00: host bridge window [io  0x0000-0x0cf7] (ignored)
 SUBSYSTEM=acpi
 DEVICE=+acpi:PNP0A03:00
6,339,5140900,-;NET: Registered protocol family 10
30,340,5690716,-;udevd[80]: starting version 181

The DEVICE= key uniquely identifies devices the following way:

b12:8	block dev_t
c127:3	char dev_t
n8	netdev ifindex
+sound:card0	subsystem:devname

The flags field carries ‘-‘ by default. A ‘c’ indicates a fragment of a line. Note, that these hints about continuation lines are not necessarily correct, and the stream could be interleaved with unrelated messages, but merging the lines in the output usually produces better human readable results. A similar logic is used internally when messages are printed to the console, /proc/kmsg or the syslog() syscall.

By default, kernel tries to avoid fragments by concatenating when it can and fragments are rare; however, when extended console support is enabled, the in-kernel concatenation is disabled and /dev/kmsg output will contain more fragments. If the log consumer performs concatenation, the end result should be the same. In the future, the in-kernel concatenation may be removed entirely and /dev/kmsg users are recommended to implement fragment handling.

Users: dmesg(1), userspace kernel log consumers

Symbols under /dev/rtcX

/dev/rtcX

Defined on file rtc-cdev

The ioctl interface to drivers for real-time clocks (RTCs). Following actions are supported:

• RTC_RD_TIME, RTC_SET_TIME: Read or set the RTC time. Time format is a Gregorian calendar date and 24 hour wall clock time.

• RTC_AIE_ON, RTC_AIE_OFF: Enable or disable the alarm interrupt for RTCs that support alarms

• RTC_ALM_READ, RTC_ALM_SET: Read or set the alarm time for RTCs that support alarms. Can be set upto 24 hours in the future. Requires a separate RTC_AIE_ON call to enable the alarm interrupt. (Prefer to use RTC_WKALM_*)

• RTC_WKALM_RD, RTC_WKALM_SET: For RTCs that support a more powerful interface, which can issue alarms beyond 24 hours and enable IRQs in the same request.

• RTC_PIE_ON, RTC_PIE_OFF: Enable or disable the periodic interrupt for RTCs that support periodic interrupts.

• RTC_UIE_ON, RTC_UIE_OFF: Enable or disable the update interrupt for RTCs that support it.

• RTC_IRQP_READ, RTC_IRQP_SET: Read or set the frequency for periodic interrupts for RTCs that support periodic interrupts. Requires a separate RTC_PIE_ON call to enable the periodic interrupts.

• RTC_VL_READ: Read the voltage inputs status of the RTC when supported. The value is a bit field of RTC_VL_*, giving the status of the main and backup voltages.

• RTC_VL_CLEAR: Clear the voltage status of the RTC. Some RTCs need user interaction when the backup power provider is replaced or charged to be able to clear the status.

The ioctl() calls supported by the older /dev/rtc interface are also supported by the newer RTC class framework. However, because the chips and systems are not standardized, some PC/AT functionality might not be provided. And in the same way, some newer features – including those enabled by ACPI – are exposed by the RTC class framework, but can’t be supported by the older driver.

Symbols under /dev/wmi

/dev/wmi/dell-smbios

Defined on file dell-smbios-wmi

Perform SMBIOS calls on supported Dell machines. through the Dell ACPI-WMI interface.

IOCTL’s and buffer formats are defined in: <uapi/linux/wmi.h>

1. To perform an SMBIOS call from userspace, you’ll need to first determine the minimum size of the calling interface buffer for your machine. Platforms that contain larger buffers can return larger objects from the system firmware. Commonly this size is either 4k or 32k.

   To determine the size of the buffer read() a u64 dword from the WMI character device /dev/wmi/dell-smbios.

2. After you’ve determined the minimum size of the calling interface buffer, you can allocate a structure that represents the structure documented above.

3. In the ‘length’ object store the size of the buffer you determined above and allocated.

4. In this buffer object, prepare as necessary for the SMBIOS call you’re interested in. Typically SMBIOS buffers have “class”, “select”, and “input” defined to values that coincide with the data you are interested in. Documenting class/select/input values is outside of the scope of this documentation. Check with the libsmbios project for further documentation on these values.

6. Run the call by using ioctl() as described in the header.

7. The output will be returned in the buffer object.

8. Be sure to free up your allocated object.

Symbols under /kvd

/kvd/

Defined on file devlink-resource-mlxsw

The main database in the Spectrum device is a centralized KVD database used for many of the tables used to configure the chip including L2 FDB, L3 LPM, ECMP and more. The KVD is divided into two sections, the first is hash-based table and the second is a linear access table. The division between the linear and hash-based sections is static and require reload before the changes take effect.

Symbols under /kvd/hash_double

/kvd/hash_double

Defined on file devlink-resource-mlxsw

The hash based section of the KVD is managed by the switch device. Used in case the key is larger than 64 bit.

Symbols under /kvd/hash_single

/kvd/hash_single

Defined on file devlink-resource-mlxsw

The hash based section of the KVD is managed by the switch device. Used in case the key size is smaller or equal to 64bit.

Symbols under /kvd/linear

/kvd/linear

Defined on file devlink-resource-mlxsw

The linear section of the KVD is managed by software as a flat memory accessed using an index.

Symbols under /proc

/proc/*/attr/current

Defined on file procfs-attr-current

The current security information used by a Linux security module (LSM) that is active on the system. The details of permissions required to read from this interface and hence obtain the security state of the task identified is LSM dependent. A process cannot write to this interface unless it refers to itself. The other details of permissions required to write to this interface and hence change the security state of the task identified are LSM dependent. The format of the data used by this interface is LSM dependent. SELinux, Smack and AppArmor provide this interface.

Users: SELinux user-space Smack user-space AppArmor user-space

/proc/*/attr/exec

Defined on file procfs-attr-exec

The security information to be used on the process by a Linux security module (LSM) active on the system after a subsequent exec() call. The details of permissions required to read from this interface and hence obtain the security state of the task identified is LSM dependent. A process cannot write to this interface unless it refers to itself. The other details of permissions required to write to this interface and hence change the security state of the task identified are LSM dependent. The format of the data used by this interface is LSM dependent. SELinux and AppArmor provide this interface.

Users: SELinux user-space AppArmor user-space

/proc/*/attr/prev

Defined on file procfs-attr-prev

The security information used on the process by a Linux security module (LSM) active on the system prior to the most recent exec() call. The details of permissions required to read from this interface is LSM dependent. A process cannot write to this interface unless it refers to itself. The other details of permissions required to write to this interface are LSM dependent. The format of the data used by this interface is LSM dependent. SELinux and AppArmor provide this interface.

Users: SELinux user-space AppArmor user-space

Symbols under /proc/diskstats

/proc/diskstats

Defined on file procfs-diskstats

The /proc/diskstats file displays the I/O statistics of block devices. Each line contains the following 14 fields:

1	major number
2	minor mumber
3	device name
4	reads completed successfully
5	reads merged
6	sectors read
7	time spent reading (ms)
8	writes completed
9	writes merged
10	sectors written
11	time spent writing (ms)
12	I/Os currently in progress
13	time spent doing I/Os (ms)
14	weighted time spent doing I/Os (ms)

Kernel 4.18+ appends four more fields for discard tracking putting the total at 18:

15	discards completed successfully
16	discards merged
17	sectors discarded
18	time spent discarding

Kernel 5.5+ appends two more fields for flush requests:

19	flush requests completed successfully
20	time spent flushing

For more details refer to I/O statistics fields

Symbols under /proc/pid

/proc/pid/smaps_rollup

Defined on file procfs-smaps_rollup

This file provides pre-summed memory information for a process. The format is almost identical to /proc/pid/smaps, except instead of an entry for each VMA in a process, smaps_rollup has a single entry (tagged “[rollup]”) for which each field is the sum of the corresponding fields from all the maps in /proc/pid/smaps. Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem are not present in /proc/pid/smaps. These fields represent the sum of the Pss field of each type (anon, file, shmem). For more details, see The /proc Filesystem and the procfs man page.

Typical output looks like this:

00100000-ff709000 ---p 00000000 00:00 0          [rollup]
Size:               1192 kB
KernelPageSize:        4 kB
MMUPageSize:           4 kB
Rss:                 884 kB
Pss:                 385 kB
Pss_Anon:            301 kB
Pss_File:             80 kB
Pss_Shmem:             4 kB
Shared_Clean:        696 kB
Shared_Dirty:          0 kB
Private_Clean:       120 kB
Private_Dirty:        68 kB
Referenced:          884 kB
Anonymous:            68 kB
LazyFree:              0 kB
AnonHugePages:         0 kB
ShmemPmdMapped:        0 kB
Shared_Hugetlb:        0 kB
Private_Hugetlb:       0 kB
Swap:                  0 kB
SwapPss:               0 kB
Locked:              385 kB

Symbols under /sys

/sys/…/<device>/<UUID>/

Defined on file sysfs-bus-vfio-mdev

This directory represents device directory of mediated device. It contains all the attributes related to mediated device.

/sys/…/<device>/<UUID>/mdev_type

Defined on file sysfs-bus-vfio-mdev

This is symbolic link pointing to supported type, <type-id> directory of which this mediated device is created.

/sys/…/<device>/<UUID>/remove

Defined on file sysfs-bus-vfio-mdev

Writing ‘1’ to this file destroys the mediated device. The vendor driver can fail the remove() callback if that device is active and the vendor driver doesn’t support hot unplug. Example:

# echo 1 > /sys/bus/mdev/devices/<UUID>/remove

/sys/…/<device>/mdev_supported_types/

Defined on file sysfs-bus-vfio-mdev

This directory contains list of directories of currently supported mediated device types and their details for <device>. Supported type attributes are defined by the vendor driver who registers with Mediated device framework. Each supported type is a directory whose name is created by adding the device driver string as a prefix to the string provided by the vendor driver.

/sys/…/<device>/mdev_supported_types/<type-id>/

Defined on file sysfs-bus-vfio-mdev

This directory gives details of supported type, like name, description, available_instances, device_api etc. ‘device_api’ and ‘available_instances’ are mandatory attributes to be provided by vendor driver. ‘name’, ‘description’ and other vendor driver specific attributes are optional.

/sys/…/events/illuminance_threshY_falling_value

/sys/…/events/illuminance_threshY_raising_value

Defined on file sysfs-bus-iio-light-lm3533-als

Specifies the value of threshold that the device is comparing against for the events enabled by in_illuminance0_thresh_either_en (0..255), where Y in 0..3.

Note that threshY_falling must be less than or equal to threshY_raising.

These thresholds correspond to the eight zone-boundary registers (boundaryY_{low,high}) and define the five light zones.

/sys/…/events/in_accel_raw_mag_value

/sys/…/events/in_accel_x_raw_mag_rising_value

/sys/…/events/in_accel_y_raw_mag_rising_value

/sys/…/events/in_accel_z_raw_mag_rising_value

Defined on file sysfs-bus-iio

The value to which the magnitude of the channel is compared. If number or direction is not specified, applies to all channels of this type.

/sys/…/events/in_accel_scale

/sys/…/events/in_accel_peak_scale

/sys/…/events/in_anglvel_scale

/sys/…/events/in_magn_scale

/sys/…/events/in_rot_from_north_magnetic_scale

/sys/…/events/in_rot_from_north_true_scale

/sys/…/events/in_voltage_scale

/sys/…/events/in_voltage_supply_scale

/sys/…/events/in_temp_scale

/sys/…/events/in_illuminance_scale

/sys/…/events/in_proximity_scale

Defined on file sysfs-bus-iio

Specifies the conversion factor from the standard units to device specific units used to set the event trigger threshold.

/sys/…/events/in_accel_thresh_rising_high_pass_filter_3db

/sys/…/events/in_anglvel_thresh_rising_high_pass_filter_3db

/sys/…/events/in_magn_thresh_rising_high_pass_filter_3db

Defined on file sysfs-bus-iio

If a high pass filter can be applied to the event generation this property gives its 3db frequency in Hz. A value of zero disables the filter.

/sys/…/events/in_accel_thresh_rising_low_pass_filter_3db

/sys/…/events/in_anglvel_thresh_rising_low_pass_filter_3db

/sys/…/events/in_magn_thresh_rising_low_pass_filter_3db

Defined on file sysfs-bus-iio

If a low pass filter can be applied to the event generation this property gives its 3db frequency in Hz. A value of zero disables the filter.

/sys/…/events/in_accel_thresh_rising_value

/sys/…/events/in_accel_thresh_falling_value

/sys/…/events/in_accel_x_raw_thresh_rising_value

/sys/…/events/in_accel_x_raw_thresh_falling_value

/sys/…/events/in_accel_y_raw_thresh_rising_value

/sys/…/events/in_accel_y_raw_thresh_falling_value

/sys/…/events/in_accel_z_raw_thresh_rising_value

/sys/…/events/in_accel_z_raw_thresh_falling_value

/sys/…/events/in_anglvel_x_raw_thresh_rising_value

/sys/…/events/in_anglvel_x_raw_thresh_falling_value

/sys/…/events/in_anglvel_y_raw_thresh_rising_value

/sys/…/events/in_anglvel_y_raw_thresh_falling_value

/sys/…/events/in_anglvel_z_raw_thresh_rising_value

/sys/…/events/in_anglvel_z_raw_thresh_falling_value

/sys/…/events/in_magn_x_raw_thresh_rising_value

/sys/…/events/in_magn_x_raw_thresh_falling_value

/sys/…/events/in_magn_y_raw_thresh_rising_value

/sys/…/events/in_magn_y_raw_thresh_falling_value

/sys/…/events/in_magn_z_raw_thresh_rising_value

/sys/…/events/in_magn_z_raw_thresh_falling_value

/sys/…/events/in_rot_from_north_magnetic_raw_thresh_rising_value

/sys/…/events/in_rot_from_north_magnetic_raw_thresh_falling_value

/sys/…/events/in_rot_from_north_true_raw_thresh_rising_value

/sys/…/events/in_rot_from_north_true_raw_thresh_falling_value

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_raw_thresh_rising_value

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_raw_thresh_falling_value

/sys/…/events/in_rot_from_north_true_tilt_comp_raw_thresh_rising_value

/sys/…/events/in_rot_from_north_true_tilt_comp_raw_thresh_falling_value

/sys/…/events/in_voltageY_supply_raw_thresh_rising_value

/sys/…/events/in_voltageY_supply_raw_thresh_falling_value

/sys/…/events/in_voltageY_raw_thresh_rising_value

/sys/…/events/in_voltageY_raw_thresh_falling_value

/sys/…/events/in_tempY_raw_thresh_rising_value

/sys/…/events/in_tempY_raw_thresh_falling_value

/sys/…/events/in_illuminance0_thresh_falling_value

/sys/…/events/in_illuminance0_thresh_rising_value

/sys/…/events/in_proximity0_thresh_falling_value

/sys/…/events/in_proximity0_thresh_rising_value

/sys/…/events/in_illuminance_thresh_rising_value

/sys/…/events/in_illuminance_thresh_falling_value

/sys/…/events/in_capacitanceY_thresh_rising_value

/sys/…/events/in_capacitanceY_thresh_falling_value

/sys/…/events/in_capacitanceY_thresh_adaptive_rising_value

/sys/…/events/in_capacitanceY_thresh_falling_rising_value

Defined on file sysfs-bus-iio

Specifies the value of threshold that the device is comparing against for the events enabled by <type>Y[_name]_thresh[_rising|falling]_en.

If separate attributes exist for the two directions, but direction is not specified for this attribute, then a single threshold value applies to both directions.

The raw or input element of the name indicates whether the value is in raw device units or in processed units (as _raw and _input do on sysfs direct channel read attributes).

/sys/…/events/in_accel_x_raw_roc_rising_value

/sys/…/events/in_accel_x_raw_roc_falling_value

/sys/…/events/in_accel_y_raw_roc_rising_value

/sys/…/events/in_accel_y_raw_roc_falling_value

/sys/…/events/in_accel_z_raw_roc_rising_value

/sys/…/events/in_accel_z_raw_roc_falling_value

/sys/…/events/in_anglvel_x_raw_roc_rising_value

/sys/…/events/in_anglvel_x_raw_roc_falling_value

/sys/…/events/in_anglvel_y_raw_roc_rising_value

/sys/…/events/in_anglvel_y_raw_roc_falling_value

/sys/…/events/in_anglvel_z_raw_roc_rising_value

/sys/…/events/in_anglvel_z_raw_roc_falling_value

/sys/…/events/in_magn_x_raw_roc_rising_value

/sys/…/events/in_magn_x_raw_roc_falling_value

/sys/…/events/in_magn_y_raw_roc_rising_value

/sys/…/events/in_magn_y_raw_roc_falling_value

/sys/…/events/in_magn_z_raw_roc_rising_value

/sys/…/events/in_magn_z_raw_roc_falling_value

/sys/…/events/in_rot_from_north_magnetic_raw_roc_rising_value

/sys/…/events/in_rot_from_north_magnetic_raw_roc_falling_value

/sys/…/events/in_rot_from_north_true_raw_roc_rising_value

/sys/…/events/in_rot_from_north_true_raw_roc_falling_value

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_raw_roc_rising_value

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_raw_roc_falling_value

/sys/…/events/in_rot_from_north_true_tilt_comp_raw_roc_rising_value

/sys/…/events/in_rot_from_north_true_tilt_comp_raw_roc_falling_value

/sys/…/events/in_voltageY_supply_raw_roc_rising_value

/sys/…/events/in_voltageY_supply_raw_roc_falling_value

/sys/…/events/in_voltageY_raw_roc_rising_value

/sys/…/events/in_voltageY_raw_roc_falling_value

/sys/…/events/in_tempY_raw_roc_rising_value

/sys/…/events/in_tempY_raw_roc_falling_value

Defined on file sysfs-bus-iio

Specifies the value of rate of change threshold that the device is comparing against for the events enabled by <type>[Y][_name]_roc[_rising|falling]_en.

If separate attributes exist for the two directions, but direction is not specified for this attribute, then a single threshold value applies to both directions. The raw or input element of the name indicates whether the value is in raw device units or in processed units (as _raw and _input do on sysfs direct channel read attributes).

/sys/…/events/in_accel_x_thresh_rising_hysteresis

/sys/…/events/in_accel_x_thresh_falling_hysteresis

/sys/…/events/in_accel_x_thresh_either_hysteresis

/sys/…/events/in_accel_y_thresh_rising_hysteresis

/sys/…/events/in_accel_y_thresh_falling_hysteresis

/sys/…/events/in_accel_y_thresh_either_hysteresis

/sys/…/events/in_accel_z_thresh_rising_hysteresis

/sys/…/events/in_accel_z_thresh_falling_hysteresis

/sys/…/events/in_accel_z_thresh_either_hysteresis

/sys/…/events/in_anglvel_x_thresh_rising_hysteresis

/sys/…/events/in_anglvel_x_thresh_falling_hysteresis

/sys/…/events/in_anglvel_x_thresh_either_hysteresis

/sys/…/events/in_anglvel_y_thresh_rising_hysteresis

/sys/…/events/in_anglvel_y_thresh_falling_hysteresis

/sys/…/events/in_anglvel_y_thresh_either_hysteresis

/sys/…/events/in_anglvel_z_thresh_rising_hysteresis

/sys/…/events/in_anglvel_z_thresh_falling_hysteresis

/sys/…/events/in_anglvel_z_thresh_either_hysteresis

/sys/…/events/in_magn_x_thresh_rising_hysteresis

/sys/…/events/in_magn_x_thresh_falling_hysteresis

/sys/…/events/in_magn_x_thresh_either_hysteresis

/sys/…/events/in_magn_y_thresh_rising_hysteresis

/sys/…/events/in_magn_y_thresh_falling_hysteresis

/sys/…/events/in_magn_y_thresh_either_hysteresis

/sys/…/events/in_magn_z_thresh_rising_hysteresis

/sys/…/events/in_magn_z_thresh_falling_hysteresis

/sys/…/events/in_magn_z_thresh_either_hysteresis

/sys/…/events/in_rot_from_north_magnetic_thresh_rising_hysteresis

/sys/…/events/in_rot_from_north_magnetic_thresh_falling_hysteresis

/sys/…/events/in_rot_from_north_magnetic_thresh_either_hysteresis

/sys/…/events/in_rot_from_north_true_thresh_rising_hysteresis

/sys/…/events/in_rot_from_north_true_thresh_falling_hysteresis

/sys/…/events/in_rot_from_north_true_thresh_either_hysteresis

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_thresh_rising_hysteresis

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_thresh_falling_hysteresis

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_thresh_either_hysteresis

/sys/…/events/in_rot_from_north_true_tilt_comp_thresh_rising_hysteresis

/sys/…/events/in_rot_from_north_true_tilt_comp_thresh_falling_hysteresis

/sys/…/events/in_rot_from_north_true_tilt_comp_thresh_either_hysteresis

/sys/…/events/in_voltageY_thresh_rising_hysteresis

/sys/…/events/in_voltageY_thresh_falling_hysteresis

/sys/…/events/in_voltageY_thresh_either_hysteresis

/sys/…/events/in_tempY_thresh_rising_hysteresis

/sys/…/events/in_tempY_thresh_falling_hysteresis

/sys/…/events/in_tempY_thresh_either_hysteresis

/sys/…/events/in_illuminance0_thresh_falling_hysteresis

/sys/…/events/in_illuminance0_thresh_rising_hysteresis

/sys/…/events/in_illuminance0_thresh_either_hysteresis

/sys/…/events/in_proximity0_thresh_falling_hysteresis

/sys/…/events/in_proximity0_thresh_rising_hysteresis

/sys/…/events/in_proximity0_thresh_either_hysteresis

Defined on file sysfs-bus-iio

Specifies the hysteresis of threshold that the device is comparing against for the events enabled by <type>Y[_name]_thresh[_(rising|falling)]_hysteresis. If separate attributes exist for the two directions, but direction is not specified for this attribute, then a single hysteresis value applies to both directions.

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 normal, for rising events the hysteresis is subtracted from the _value attribute. E.g. if in_voltage0_raw_thresh_rising_value is set to 1200 and in_voltage0_raw_thresh_rising_hysteresis is set to 50. The event will get activated once in_voltage0_raw goes above 1200 and will become deactivated again once the value falls below 1150.

/sys/…/events/in_accel_x_thresh_rising_period

/sys/…/events/in_accel_x_thresh_falling_period

/sys/…/events/in_accel_x_roc_rising_period

/sys/…/events/in_accel_x_roc_falling_period

/sys/…/events/in_accel_y_thresh_rising_period

/sys/…/events/in_accel_y_thresh_falling_period

/sys/…/events/in_accel_y_roc_rising_period

/sys/…/events/in_accel_y_roc_falling_period

/sys/…/events/in_accel_z_thresh_rising_period

/sys/…/events/in_accel_z_thresh_falling_period

/sys/…/events/in_accel_z_roc_rising_period

/sys/…/events/in_accel_z_roc_falling_period

/sys/…/events/in_anglvel_x_thresh_rising_period

/sys/…/events/in_anglvel_x_thresh_falling_period

/sys/…/events/in_anglvel_x_roc_rising_period

/sys/…/events/in_anglvel_x_roc_falling_period

/sys/…/events/in_anglvel_y_thresh_rising_period

/sys/…/events/in_anglvel_y_thresh_falling_period

/sys/…/events/in_anglvel_y_roc_rising_period

/sys/…/events/in_anglvel_y_roc_falling_period

/sys/…/events/in_anglvel_z_thresh_rising_period

/sys/…/events/in_anglvel_z_thresh_falling_period

/sys/…/events/in_anglvel_z_roc_rising_period

/sys/…/events/in_anglvel_z_roc_falling_period

/sys/…/events/in_magn_x_thresh_rising_period

/sys/…/events/in_magn_x_thresh_falling_period

/sys/…/events/in_magn_x_roc_rising_period

/sys/…/events/in_magn_x_roc_falling_period

/sys/…/events/in_magn_y_thresh_rising_period

/sys/…/events/in_magn_y_thresh_falling_period

/sys/…/events/in_magn_y_roc_rising_period

/sys/…/events/in_magn_y_roc_falling_period

/sys/…/events/in_magn_z_thresh_rising_period

/sys/…/events/in_magn_z_thresh_falling_period

/sys/…/events/in_magn_z_roc_rising_period

/sys/…/events/in_magn_z_roc_falling_period

/sys/…/events/in_rot_from_north_magnetic_thresh_rising_period

/sys/…/events/in_rot_from_north_magnetic_thresh_falling_period

/sys/…/events/in_rot_from_north_magnetic_roc_rising_period

/sys/…/events/in_rot_from_north_magnetic_roc_falling_period

/sys/…/events/in_rot_from_north_true_thresh_rising_period

/sys/…/events/in_rot_from_north_true_thresh_falling_period

/sys/…/events/in_rot_from_north_true_roc_rising_period

/sys/…/events/in_rot_from_north_true_roc_falling_period

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_thresh_rising_period

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_thresh_falling_period

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_roc_rising_period

/sys/…/events/in_rot_from_north_magnetic_tilt_comp_roc_falling_period

/sys/…/events/in_rot_from_north_true_tilt_comp_thresh_rising_period

/sys/…/events/in_rot_from_north_true_tilt_comp_thresh_falling_period

/sys/…/events/in_rot_from_north_true_tilt_comp_roc_rising_period

/sys/…/events/in_rot_from_north_true_tilt_comp_roc_falling_period

/sys/…/events/in_voltageY_supply_thresh_rising_period

/sys/…/events/in_voltageY_supply_thresh_falling_period

/sys/…/events/in_voltageY_supply_roc_rising_period

/sys/…/events/in_voltageY_supply_roc_falling_period

/sys/…/events/in_voltageY_thresh_rising_period

/sys/…/events/in_voltageY_thresh_falling_period

/sys/…/events/in_voltageY_roc_rising_period

/sys/…/events/in_voltageY_roc_falling_period

/sys/…/events/in_tempY_thresh_rising_period

/sys/…/events/in_tempY_thresh_falling_period

/sys/…/events/in_tempY_roc_rising_period

/sys/…/events/in_tempY_roc_falling_period

/sys/…/events/in_accel_x&y&z_mag_falling_period

/sys/…/events/in_intensity0_thresh_period

/sys/…/events/in_proximity0_thresh_period

/sys/…/events/in_activity_still_thresh_rising_period

/sys/…/events/in_activity_still_thresh_falling_period

/sys/…/events/in_activity_walking_thresh_rising_period

/sys/…/events/in_activity_walking_thresh_falling_period

/sys/…/events/in_activity_jogging_thresh_rising_period

/sys/…/events/in_activity_jogging_thresh_falling_period

/sys/…/events/in_activity_running_thresh_rising_period

/sys/…/events/in_activity_running_thresh_falling_period

/sys/…/events/in_illuminance_thresh_either_period

Defined on file sysfs-bus-iio

Period of time (in seconds) for which the condition must be met before an event is generated. If direction is not specified then this period applies to both directions.

/sys/…/events/in_activity_still_thresh_rising_en

/sys/…/events/in_activity_still_thresh_falling_en

/sys/…/events/in_activity_walking_thresh_rising_en

/sys/…/events/in_activity_walking_thresh_falling_en

/sys/…/events/in_activity_jogging_thresh_rising_en

/sys/…/events/in_activity_jogging_thresh_falling_en

/sys/…/events/in_activity_running_thresh_rising_en

/sys/…/events/in_activity_running_thresh_falling_en

Defined on file sysfs-bus-iio

Enables or disables activity events. Depending on direction an event is generated when sensor ENTERS or LEAVES a given state.

/sys/…/events/in_activity_still_thresh_rising_value

/sys/…/events/in_activity_still_thresh_falling_value

/sys/…/events/in_activity_walking_thresh_rising_value

/sys/…/events/in_activity_walking_thresh_falling_value

/sys/…/events/in_activity_jogging_thresh_rising_value

/sys/…/events/in_activity_jogging_thresh_falling_value

/sys/…/events/in_activity_running_thresh_rising_value

/sys/…/events/in_activity_running_thresh_falling_value

Defined on file sysfs-bus-iio

Confidence value (in units as percentage) to be used for deciding when an event should be generated. E.g for running: If the confidence value reported by the sensor is greater than in_activity_running_thresh_rising_value then the sensor ENTERS running state. Conversely, if the confidence value reported by the sensor is lower than in_activity_running_thresh_falling_value then the sensor is LEAVING running state.

/sys/…/events/in_capacitanceY_adaptive_thresh_rising_en

/sys/…/events/in_capacitanceY_adaptive_thresh_falling_en

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/…/events/in_capacitanceY_adaptive_thresh_rising_en, /sys/…/events/in_capacitanceY_adaptive_thresh_falling_en

/sys/…/events/in_illuminance0_threshY_hysteresis

Defined on file sysfs-bus-iio-light-lm3533-als

Get the hysteresis for thresholds Y, that is, threshY_hysteresis = threshY_raising - threshY_falling

/sys/…/events/in_illuminance0_thresh_either_en

Defined on file sysfs-bus-iio-light-lm3533-als

Event generated when channel passes one of the four thresholds in each direction (rising|falling) and a zone change occurs. The corresponding light zone can be read from in_illuminance0_zone.

/sys/…/events/in_steps_change_en

Defined on file sysfs-bus-iio

Event generated when channel passes a threshold on the absolute change in value. E.g. for steps: a step change event is generated each time the user takes N steps, where N is set using in_steps_change_value.

/sys/…/events/in_steps_change_value

Defined on file sysfs-bus-iio

Specifies the value of change threshold that the device is comparing against for the events enabled by <type>[Y][_name]_roc[_rising|falling|]_en. E.g. for steps: if set to 3, a step change event will be generated every 3 steps.

/sys/…/iio:deviceX/bufferY/in_accel_type

/sys/…/iio:deviceX/bufferY/in_anglvel_type

/sys/…/iio:deviceX/bufferY/in_magn_type

/sys/…/iio:deviceX/bufferY/in_incli_type

/sys/…/iio:deviceX/bufferY/in_voltageY_type

/sys/…/iio:deviceX/bufferY/in_voltage_type

/sys/…/iio:deviceX/bufferY/in_voltageY_supply_type

/sys/…/iio:deviceX/bufferY/in_voltageY_i_type

/sys/…/iio:deviceX/bufferY/in_voltageY_q_type

/sys/…/iio:deviceX/bufferY/in_voltage_i_type

/sys/…/iio:deviceX/bufferY/in_voltage_q_type

/sys/…/iio:deviceX/bufferY/in_timestamp_type

/sys/…/iio:deviceX/bufferY/in_pressureY_type

/sys/…/iio:deviceX/bufferY/in_pressure_type

/sys/…/iio:deviceX/bufferY/in_rot_quaternion_type

/sys/…/iio:deviceX/bufferY/in_proximity_type

Defined on file sysfs-bus-iio

Description of the scan element data storage within the buffer and hence the form in which it is read from user-space. Form is [be|le]:[s|u]bits/storagebits[>>shift]. be or le specifies big or little endian. s or u specifies if signed (2’s complement) or unsigned. bits is the number of bits of data and storagebits is the space (after padding) that it occupies in the buffer. shift if specified, is the shift that needs to be applied prior to masking out unused bits. Some devices put their data in the middle of the transferred elements with additional information on both sides. Note that some devices will have additional information in the unused bits so to get a clean value, the bits value must be used to mask the buffer output value appropriately. The storagebits value also specifies the data alignment. So s48/64>>2 will be a signed 48 bit integer stored in a 64 bit location aligned to a 64 bit boundary. To obtain the clean value, shift right 2 and apply a mask to zero the top 16 bits of the result. For other storage combinations this attribute will be extended appropriately.

/sys/…/iio:deviceX/bufferY/in_accel_x_en

/sys/…/iio:deviceX/bufferY/in_accel_y_en

/sys/…/iio:deviceX/bufferY/in_accel_z_en

/sys/…/iio:deviceX/bufferY/in_anglvel_x_en

/sys/…/iio:deviceX/bufferY/in_anglvel_y_en

/sys/…/iio:deviceX/bufferY/in_anglvel_z_en

/sys/…/iio:deviceX/bufferY/in_magn_x_en

/sys/…/iio:deviceX/bufferY/in_magn_y_en

/sys/…/iio:deviceX/bufferY/in_magn_z_en

/sys/…/iio:deviceX/bufferY/in_rot_from_north_magnetic_en

/sys/…/iio:deviceX/bufferY/in_rot_from_north_true_en

/sys/…/iio:deviceX/bufferY/in_rot_from_north_magnetic_tilt_comp_en

/sys/…/iio:deviceX/bufferY/in_rot_from_north_true_tilt_comp_en

/sys/…/iio:deviceX/bufferY/in_timestamp_en

/sys/…/iio:deviceX/bufferY/in_voltageY_supply_en

/sys/…/iio:deviceX/bufferY/in_voltageY_en

/sys/…/iio:deviceX/bufferY/in_voltageY-voltageZ_en

/sys/…/iio:deviceX/bufferY/in_voltageY_i_en

/sys/…/iio:deviceX/bufferY/in_voltageY_q_en

/sys/…/iio:deviceX/bufferY/in_voltage_i_en

/sys/…/iio:deviceX/bufferY/in_voltage_q_en

/sys/…/iio:deviceX/bufferY/in_incli_x_en

/sys/…/iio:deviceX/bufferY/in_incli_y_en

/sys/…/iio:deviceX/bufferY/in_pressureY_en

/sys/…/iio:deviceX/bufferY/in_pressure_en

/sys/…/iio:deviceX/bufferY/in_rot_quaternion_en

/sys/…/iio:deviceX/bufferY/in_proximity_en

Defined on file sysfs-bus-iio

Scan element control for triggered data capture.

/sys/…/iio:deviceX/bufferY/in_voltageY_index

/sys/…/iio:deviceX/bufferY/in_voltageY_supply_index

/sys/…/iio:deviceX/bufferY/in_voltageY_i_index

/sys/…/iio:deviceX/bufferY/in_voltageY_q_index

/sys/…/iio:deviceX/bufferY/in_voltage_i_index

/sys/…/iio:deviceX/bufferY/in_voltage_q_index

/sys/…/iio:deviceX/bufferY/in_accel_x_index

/sys/…/iio:deviceX/bufferY/in_accel_y_index

/sys/…/iio:deviceX/bufferY/in_accel_z_index

/sys/…/iio:deviceX/bufferY/in_anglvel_x_index

/sys/…/iio:deviceX/bufferY/in_anglvel_y_index

/sys/…/iio:deviceX/bufferY/in_anglvel_z_index

/sys/…/iio:deviceX/bufferY/in_magn_x_index

/sys/…/iio:deviceX/bufferY/in_magn_y_index

/sys/…/iio:deviceX/bufferY/in_magn_z_index

/sys/…/iio:deviceX/bufferY/in_rot_from_north_magnetic_index

/sys/…/iio:deviceX/bufferY/in_rot_from_north_true_index

/sys/…/iio:deviceX/bufferY/in_rot_from_north_magnetic_tilt_comp_index

/sys/…/iio:deviceX/bufferY/in_rot_from_north_true_tilt_comp_index

/sys/…/iio:deviceX/bufferY/in_incli_x_index

/sys/…/iio:deviceX/bufferY/in_incli_y_index

/sys/…/iio:deviceX/bufferY/in_timestamp_index

/sys/…/iio:deviceX/bufferY/in_pressureY_index

/sys/…/iio:deviceX/bufferY/in_pressure_index

/sys/…/iio:deviceX/bufferY/in_rot_quaternion_index

/sys/…/iio:deviceX/bufferY/in_proximity_index

Defined on file sysfs-bus-iio

A single positive integer specifying the position of this scan element in the buffer. Note these are not dependent on what is enabled and may not be contiguous. Thus for user-space to establish the full layout these must be used in conjunction with all _en attributes to establish which channels are present, and the relevant _type attributes to establish the data storage format.

/sys/…/iio:deviceX/events/in_accel_mag_en

/sys/…/iio:deviceX/events/in_accel_mag_rising_en

/sys/…/iio:deviceX/events/in_accel_mag_falling_en

/sys/…/iio:deviceX/events/in_accel_x_mag_en

/sys/…/iio:deviceX/events/in_accel_x_mag_rising_en

/sys/…/iio:deviceX/events/in_accel_x_mag_falling_en

/sys/…/iio:deviceX/events/in_accel_y_mag_en

/sys/…/iio:deviceX/events/in_accel_y_mag_rising_en

/sys/…/iio:deviceX/events/in_accel_y_mag_falling_en

/sys/…/iio:deviceX/events/in_accel_z_mag_en

/sys/…/iio:deviceX/events/in_accel_z_mag_rising_en

/sys/…/iio:deviceX/events/in_accel_z_mag_falling_en

/sys/…/iio:deviceX/events/in_accel_x&y&z_mag_rising_en

/sys/…/iio:deviceX/events/in_accel_x&y&z_mag_falling_en

Defined on file sysfs-bus-iio

Similar to in_accel_x_thresh[_rising|_falling]_en, but here the magnitude of the channel is compared to the threshold, not its signed value.

/sys/…/iio:deviceX/events/in_accel_x_roc_rising_en

/sys/…/iio:deviceX/events/in_accel_x_roc_falling_en

/sys/…/iio:deviceX/events/in_accel_y_roc_rising_en

/sys/…/iio:deviceX/events/in_accel_y_roc_falling_en

/sys/…/iio:deviceX/events/in_accel_z_roc_rising_en

/sys/…/iio:deviceX/events/in_accel_z_roc_falling_en

/sys/…/iio:deviceX/events/in_anglvel_x_roc_rising_en

/sys/…/iio:deviceX/events/in_anglvel_x_roc_falling_en

/sys/…/iio:deviceX/events/in_anglvel_y_roc_rising_en

/sys/…/iio:deviceX/events/in_anglvel_y_roc_falling_en

/sys/…/iio:deviceX/events/in_anglvel_z_roc_rising_en

/sys/…/iio:deviceX/events/in_anglvel_z_roc_falling_en

/sys/…/iio:deviceX/events/in_magn_x_roc_rising_en

/sys/…/iio:deviceX/events/in_magn_x_roc_falling_en

/sys/…/iio:deviceX/events/in_magn_y_roc_rising_en

/sys/…/iio:deviceX/events/in_magn_y_roc_falling_en

/sys/…/iio:deviceX/events/in_magn_z_roc_rising_en

/sys/…/iio:deviceX/events/in_magn_z_roc_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_roc_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_roc_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_roc_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_roc_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_roc_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_roc_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_tilt_comp_roc_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_tilt_comp_roc_falling_en

/sys/…/iio:deviceX/events/in_voltageY_supply_roc_rising_en

/sys/…/iio:deviceX/events/in_voltageY_supply_roc_falling_en

/sys/…/iio:deviceX/events/in_voltageY_roc_rising_en

/sys/…/iio:deviceX/events/in_voltageY_roc_falling_en

/sys/…/iio:deviceX/events/in_tempY_roc_rising_en

/sys/…/iio:deviceX/events/in_tempY_roc_falling_en

Defined on file sysfs-bus-iio

Event generated when channel passes a threshold on the rate of change (1st differential) in the specified (_rising|_falling) direction. If the direction is not specified, then either the device will report an event which ever direction a single threshold value is passed in (e.g. <type>[Y][_name]_<raw|input>_roc_value) or <type>[Y][_name]_<raw|input>_roc_rising_value and <type>[Y][_name]_<raw|input>_roc_falling_value may take different values, but the device can only enable both rate of change thresholds or neither.

Note the driver will assume the last p events requested are 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 sure you have set what you think you have, check the contents of these attributes after everything is configured. Drivers may have to buffer any parameters so that they are consistent when a given event type is enabled a future point (and not those for whatever event was previously enabled).

/sys/…/iio:deviceX/events/in_accel_x_thresh_rising_en

/sys/…/iio:deviceX/events/in_accel_x_thresh_falling_en

/sys/…/iio:deviceX/events/in_accel_y_thresh_rising_en

/sys/…/iio:deviceX/events/in_accel_y_thresh_falling_en

/sys/…/iio:deviceX/events/in_accel_z_thresh_rising_en

/sys/…/iio:deviceX/events/in_accel_z_thresh_falling_en

/sys/…/iio:deviceX/events/in_anglvel_x_thresh_rising_en

/sys/…/iio:deviceX/events/in_anglvel_x_thresh_falling_en

/sys/…/iio:deviceX/events/in_anglvel_y_thresh_rising_en

/sys/…/iio:deviceX/events/in_anglvel_y_thresh_falling_en

/sys/…/iio:deviceX/events/in_anglvel_z_thresh_rising_en

/sys/…/iio:deviceX/events/in_anglvel_z_thresh_falling_en

/sys/…/iio:deviceX/events/in_magn_x_thresh_rising_en

/sys/…/iio:deviceX/events/in_magn_x_thresh_falling_en

/sys/…/iio:deviceX/events/in_magn_y_thresh_rising_en

/sys/…/iio:deviceX/events/in_magn_y_thresh_falling_en

/sys/…/iio:deviceX/events/in_magn_z_thresh_rising_en

/sys/…/iio:deviceX/events/in_magn_z_thresh_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_thresh_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_thresh_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_thresh_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_thresh_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_thresh_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_thresh_falling_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_tilt_comp_thresh_rising_en

/sys/…/iio:deviceX/events/in_rot_from_north_true_tilt_comp_thresh_falling_en

/sys/…/iio:deviceX/events/in_voltageY_supply_thresh_rising_en

/sys/…/iio:deviceX/events/in_voltageY_supply_thresh_falling_en

/sys/…/iio:deviceX/events/in_voltageY_thresh_rising_en

/sys/…/iio:deviceX/events/in_voltageY_thresh_falling_en

/sys/…/iio:deviceX/events/in_voltageY_thresh_either_en

/sys/…/iio:deviceX/events/in_tempY_thresh_rising_en

/sys/…/iio:deviceX/events/in_tempY_thresh_falling_en

/sys/…/iio:deviceX/events/in_capacitanceY_thresh_rising_en

/sys/…/iio:deviceX/events/in_capacitanceY_thresh_falling_en

Defined on file sysfs-bus-iio

Event generated when channel passes a threshold in the specified (_rising|_falling) direction. If the direction is not specified, then either the device will report an event which ever direction a single threshold value is passed in (e.g. <type>[Y][_name]_<raw|input>_thresh_value) or <type>[Y][_name]_<raw|input>_thresh_rising_value and <type>[Y][_name]_<raw|input>_thresh_falling_value may take different values, but the device can only enable both thresholds or neither.

Note the driver will assume the last p events requested are 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 sure you have set what you think you have, check the contents of these attributes after everything is configured. Drivers may have to buffer any parameters so that they are consistent when a given event type is enabled at a future point (and not those for whatever event was previously enabled).

/sys/…/iio:deviceX/in_accelX_power_mode

Defined on file sysfs-bus-iio

Specifies the chip power mode. low_noise: reduce noise level from ADC, low_power: enable low current consumption. For a list of available output power modes read in_accel_power_mode_available.

/sys/…/iio:deviceX/in_activity_still_input

/sys/…/iio:deviceX/in_activity_walking_input

/sys/…/iio:deviceX/in_activity_jogging_input

/sys/…/iio:deviceX/in_activity_running_input

Defined on file sysfs-bus-iio

This attribute is used to read the confidence for an activity expressed in units as percentage.

/sys/…/iio:deviceX/in_anglvel_z_quadrature_correction_raw

Defined on file sysfs-bus-iio

This attribute is used to read the amount of quadrature error present in the device at a given time.

/sys/…/iio:deviceX/in_capacitanceY-in_capacitanceZ_raw

Defined on file sysfs-bus-iio

Raw differential capacitance measurement equivalent to channel Y - channel Z where these channel numbers apply to the physically equivalent inputs when non differential readings are separately available. In differential only parts, then all that is required is a consistent labeling. Units after application of scale and offset are nanofarads.

/sys/…/iio:deviceX/in_distance_input

/sys/…/iio:deviceX/in_distance_raw

Defined on file sysfs-bus-iio

This attribute is used to read the measured distance to an object or the distance covered by the user since the last reboot while activated. Units after application of scale are meters.

/sys/…/iio:deviceX/in_energy_en

/sys/…/iio:deviceX/in_distance_en

/sys/…/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_en

/sys/…/iio:deviceX/in_steps_en

Defined on file sysfs-bus-iio

Activates a device feature that runs in firmware/hardware. E.g. for steps: the pedometer saves power while not used; when activated, it will count the steps taken by the user in firmware and export them through in_steps_input.

/sys/…/iio:deviceX/in_energy_input

/sys/…/iio:deviceX/in_energy_raw

Defined on file sysfs-bus-iio

This attribute is used to read the energy value reported by the device (e.g.: human activity sensors report energy burnt by the user). Units after application of scale are Joules.

/sys/…/iio:deviceX/in_illuminance_input

/sys/…/iio:deviceX/in_illuminance_raw

/sys/…/iio:deviceX/in_illuminanceY_input

/sys/…/iio:deviceX/in_illuminanceY_raw

/sys/…/iio:deviceX/in_illuminanceY_mean_raw

/sys/…/iio:deviceX/in_illuminance_ir_raw

/sys/…/iio:deviceX/in_illuminance_clear_raw

Defined on file sysfs-bus-iio

Illuminance measurement, units after application of scale and offset are lux.

/sys/…/iio:deviceX/in_intensityY_raw

/sys/…/iio:deviceX/in_intensityY_ir_raw

/sys/…/iio:deviceX/in_intensityY_both_raw

/sys/…/iio:deviceX/in_intensityY_uv_raw

/sys/…/iio:deviceX/in_intensityY_duv_raw

Defined on file sysfs-bus-iio

Unit-less light intensity. Modifiers both and ir indicate that measurements contain visible and infrared light components or just infrared light, respectively. Modifier uv indicates that measurements contain ultraviolet light components. Modifier duv indicates that measurements contain deep ultraviolet light components.

/sys/…/iio:deviceX/in_intensity_integration_time

/sys/…/iio:deviceX/in_intensity_red_integration_time

/sys/…/iio:deviceX/in_intensity_green_integration_time

/sys/…/iio:deviceX/in_intensity_blue_integration_time

/sys/…/iio:deviceX/in_intensity_clear_integration_time

/sys/…/iio:deviceX/in_illuminance_integration_time

Defined on file sysfs-bus-iio

This attribute is used to get/set the integration time in seconds. If shared across all channels of a given type, <type>_integration_time is used.

/sys/…/iio:deviceX/in_proximity_raw

/sys/…/iio:deviceX/in_proximity_input

/sys/…/iio:deviceX/in_proximityY_raw

Defined on file sysfs-bus-iio

Proximity measurement indicating that some object is near the sensor, usually by observing reflectivity of infrared or ultrasound emitted.

Often these sensors are unit less and as such conversion to SI units is not possible. Higher proximity measurements indicate closer objects, and vice versa. Units after application of scale and offset are meters.

/sys/…/iio:deviceX/in_steps_debounce_count

Defined on file sysfs-bus-iio

Specifies the number of steps that must occur within in_steps_filter_debounce_time for the pedometer to decide the consumer is making steps.

/sys/…/iio:deviceX/in_steps_debounce_time

Defined on file sysfs-bus-iio

Specifies number of seconds in which we compute the steps that occur in order to decide if the consumer is making steps.

/sys/…/iio:deviceX/in_steps_input

Defined on file sysfs-bus-iio

This attribute is used to read the number of steps taken by the user since the last reboot while activated.

/sys/…/iio:deviceX/in_uvindex_input

Defined on file sysfs-bus-iio

UV light intensity index measuring the human skin’s response to different wavelength of sunlight weighted according to the standardised CIE Erythemal Action Spectrum. UV index values range from 0 (low) to >=11 (extreme).

/sys/…/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_input

/sys/…/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_raw

Defined on file sysfs-bus-iio

This attribute is used to read the current speed value of the user (which is the norm or magnitude of the velocity vector). Units after application of scale are m/s.

/sys/…/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_integration_time

Defined on file sysfs-bus-iio

Number of seconds in which to compute speed.

/sys/…/iio:deviceX/out_voltageY_powerdown_mode_available

/sys/…/iio:deviceX/out_voltage_powerdown_mode_available

/sys/…/iio:deviceX/out_altvoltageY_powerdown_mode_available

/sys/…/iio:deviceX/out_altvoltage_powerdown_mode_available

Defined on file sysfs-bus-iio

Lists all available output power down modes. If Y is not present the mode is shared across all outputs.

/sys/…/iio:deviceX/scan_elements/in_accel_type

/sys/…/iio:deviceX/scan_elements/in_anglvel_type

/sys/…/iio:deviceX/scan_elements/in_magn_type

/sys/…/iio:deviceX/scan_elements/in_incli_type

/sys/…/iio:deviceX/scan_elements/in_voltageY_type

/sys/…/iio:deviceX/scan_elements/in_voltage_type

/sys/…/iio:deviceX/scan_elements/in_voltageY_supply_type

/sys/…/iio:deviceX/scan_elements/in_voltageY_i_type

/sys/…/iio:deviceX/scan_elements/in_voltageY_q_type

/sys/…/iio:deviceX/scan_elements/in_voltage_i_type

/sys/…/iio:deviceX/scan_elements/in_voltage_q_type

/sys/…/iio:deviceX/scan_elements/in_timestamp_type

/sys/…/iio:deviceX/scan_elements/in_pressureY_type

/sys/…/iio:deviceX/scan_elements/in_pressure_type

/sys/…/iio:deviceX/scan_elements/in_rot_quaternion_type

/sys/…/iio:deviceX/scan_elements/in_proximity_type

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/…/iio:deviceX/scan_elements/in_accel_type, /sys/…/iio:deviceX/scan_elements/in_anglvel_type, /sys/…/iio:deviceX/scan_elements/in_magn_type, /sys/…/iio:deviceX/scan_elements/in_incli_type, /sys/…/iio:deviceX/scan_elements/in_voltageY_type, /sys/…/iio:deviceX/scan_elements/in_voltage_type, /sys/…/iio:deviceX/scan_elements/in_voltageY_supply_type, /sys/…/iio:deviceX/scan_elements/in_voltageY_i_type, /sys/…/iio:deviceX/scan_elements/in_voltageY_q_type, /sys/…/iio:deviceX/scan_elements/in_voltage_i_type, /sys/…/iio:deviceX/scan_elements/in_voltage_q_type, /sys/…/iio:deviceX/scan_elements/in_timestamp_type, /sys/…/iio:deviceX/scan_elements/in_pressureY_type, /sys/…/iio:deviceX/scan_elements/in_pressure_type, /sys/…/iio:deviceX/scan_elements/in_rot_quaternion_type, /sys/…/iio:deviceX/scan_elements/in_proximity_type

/sys/…/iio:deviceX/scan_elements/in_accel_type_available

Defined on file sysfs-bus-iio

If the type parameter can take one of a small set of values, this attribute lists them.

/sys/…/iio:deviceX/scan_elements/in_accel_x_en

/sys/…/iio:deviceX/scan_elements/in_accel_y_en

/sys/…/iio:deviceX/scan_elements/in_accel_z_en

/sys/…/iio:deviceX/scan_elements/in_anglvel_x_en

/sys/…/iio:deviceX/scan_elements/in_anglvel_y_en

/sys/…/iio:deviceX/scan_elements/in_anglvel_z_en

/sys/…/iio:deviceX/scan_elements/in_magn_x_en

/sys/…/iio:deviceX/scan_elements/in_magn_y_en

/sys/…/iio:deviceX/scan_elements/in_magn_z_en

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_en

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_en

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_en

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_en

/sys/…/iio:deviceX/scan_elements/in_timestamp_en

/sys/…/iio:deviceX/scan_elements/in_voltageY_supply_en

/sys/…/iio:deviceX/scan_elements/in_voltageY_en

/sys/…/iio:deviceX/scan_elements/in_voltageY-voltageZ_en

/sys/…/iio:deviceX/scan_elements/in_voltageY_i_en

/sys/…/iio:deviceX/scan_elements/in_voltageY_q_en

/sys/…/iio:deviceX/scan_elements/in_voltage_i_en

/sys/…/iio:deviceX/scan_elements/in_voltage_q_en

/sys/…/iio:deviceX/scan_elements/in_incli_x_en

/sys/…/iio:deviceX/scan_elements/in_incli_y_en

/sys/…/iio:deviceX/scan_elements/in_pressureY_en

/sys/…/iio:deviceX/scan_elements/in_pressure_en

/sys/…/iio:deviceX/scan_elements/in_rot_quaternion_en

/sys/…/iio:deviceX/scan_elements/in_proximity_en

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/…/iio:deviceX/scan_elements/in_accel_x_en, /sys/…/iio:deviceX/scan_elements/in_accel_y_en, /sys/…/iio:deviceX/scan_elements/in_accel_z_en, /sys/…/iio:deviceX/scan_elements/in_anglvel_x_en, /sys/…/iio:deviceX/scan_elements/in_anglvel_y_en, /sys/…/iio:deviceX/scan_elements/in_anglvel_z_en, /sys/…/iio:deviceX/scan_elements/in_magn_x_en, /sys/…/iio:deviceX/scan_elements/in_magn_y_en, /sys/…/iio:deviceX/scan_elements/in_magn_z_en, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_en, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_en, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_en, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_en, /sys/…/iio:deviceX/scan_elements/in_timestamp_en, /sys/…/iio:deviceX/scan_elements/in_voltageY_supply_en, /sys/…/iio:deviceX/scan_elements/in_voltageY_en, /sys/…/iio:deviceX/scan_elements/in_voltageY-voltageZ_en, /sys/…/iio:deviceX/scan_elements/in_voltageY_i_en, /sys/…/iio:deviceX/scan_elements/in_voltageY_q_en, /sys/…/iio:deviceX/scan_elements/in_voltage_i_en, /sys/…/iio:deviceX/scan_elements/in_voltage_q_en, /sys/…/iio:deviceX/scan_elements/in_incli_x_en, /sys/…/iio:deviceX/scan_elements/in_incli_y_en, /sys/…/iio:deviceX/scan_elements/in_pressureY_en, /sys/…/iio:deviceX/scan_elements/in_pressure_en, /sys/…/iio:deviceX/scan_elements/in_rot_quaternion_en, /sys/…/iio:deviceX/scan_elements/in_proximity_en

/sys/…/iio:deviceX/scan_elements/in_voltageY_index

/sys/…/iio:deviceX/scan_elements/in_voltageY_supply_index

/sys/…/iio:deviceX/scan_elements/in_voltageY_i_index

/sys/…/iio:deviceX/scan_elements/in_voltageY_q_index

/sys/…/iio:deviceX/scan_elements/in_voltage_i_index

/sys/…/iio:deviceX/scan_elements/in_voltage_q_index

/sys/…/iio:deviceX/scan_elements/in_accel_x_index

/sys/…/iio:deviceX/scan_elements/in_accel_y_index

/sys/…/iio:deviceX/scan_elements/in_accel_z_index

/sys/…/iio:deviceX/scan_elements/in_anglvel_x_index

/sys/…/iio:deviceX/scan_elements/in_anglvel_y_index

/sys/…/iio:deviceX/scan_elements/in_anglvel_z_index

/sys/…/iio:deviceX/scan_elements/in_magn_x_index

/sys/…/iio:deviceX/scan_elements/in_magn_y_index

/sys/…/iio:deviceX/scan_elements/in_magn_z_index

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_index

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_index

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_index

/sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_index

/sys/…/iio:deviceX/scan_elements/in_incli_x_index

/sys/…/iio:deviceX/scan_elements/in_incli_y_index

/sys/…/iio:deviceX/scan_elements/in_timestamp_index

/sys/…/iio:deviceX/scan_elements/in_pressureY_index

/sys/…/iio:deviceX/scan_elements/in_pressure_index

/sys/…/iio:deviceX/scan_elements/in_rot_quaternion_index

/sys/…/iio:deviceX/scan_elements/in_proximity_index

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/…/iio:deviceX/scan_elements/in_voltageY_index, /sys/…/iio:deviceX/scan_elements/in_voltageY_supply_index, /sys/…/iio:deviceX/scan_elements/in_voltageY_i_index, /sys/…/iio:deviceX/scan_elements/in_voltageY_q_index, /sys/…/iio:deviceX/scan_elements/in_voltage_i_index, /sys/…/iio:deviceX/scan_elements/in_voltage_q_index, /sys/…/iio:deviceX/scan_elements/in_accel_x_index, /sys/…/iio:deviceX/scan_elements/in_accel_y_index, /sys/…/iio:deviceX/scan_elements/in_accel_z_index, /sys/…/iio:deviceX/scan_elements/in_anglvel_x_index, /sys/…/iio:deviceX/scan_elements/in_anglvel_y_index, /sys/…/iio:deviceX/scan_elements/in_anglvel_z_index, /sys/…/iio:deviceX/scan_elements/in_magn_x_index, /sys/…/iio:deviceX/scan_elements/in_magn_y_index, /sys/…/iio:deviceX/scan_elements/in_magn_z_index, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_index, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_index, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_index, /sys/…/iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_index, /sys/…/iio:deviceX/scan_elements/in_incli_x_index, /sys/…/iio:deviceX/scan_elements/in_incli_y_index, /sys/…/iio:deviceX/scan_elements/in_timestamp_index, /sys/…/iio:deviceX/scan_elements/in_pressureY_index, /sys/…/iio:deviceX/scan_elements/in_pressure_index, /sys/…/iio:deviceX/scan_elements/in_rot_quaternion_index, /sys/…/iio:deviceX/scan_elements/in_proximity_index

/sys/…/in_accel_filter_high_pass_3db_frequency

/sys/…/in_anglvel_filter_high_pass_3db_frequency

/sys/…/in_magn_filter_high_pass_3db_frequency

Defined on file sysfs-bus-iio

If a known or controllable high pass filter is applied to the underlying data channel, then this parameter gives the 3dB frequency of the filter in Hz.

/sys/…/in_accel_filter_low_pass_3db_frequency

/sys/…/in_magn_filter_low_pass_3db_frequency

/sys/…/in_anglvel_filter_low_pass_3db_frequency

Defined on file sysfs-bus-iio

If a known or controllable low pass filter is applied to the underlying data channel, then this parameter gives the 3dB frequency of the filter in Hz.

/sys/…/in_capacitanceY_adaptive_thresh_rising_timeout

/sys/…/in_capacitanceY_adaptive_thresh_falling_timeout

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/…/in_capacitanceY_adaptive_thresh_rising_timeout, /sys/…/in_capacitanceY_adaptive_thresh_falling_timeout

/sys/…/mdev_supported_types/<type-id>/available_instances

Defined on file sysfs-bus-vfio-mdev

Reading this attribute will show the number of mediated devices of type <type-id> that can be created. This is a readonly file.

Users:

Userspace applications interested in creating mediated device of that type. Userspace application should check the number of available instances could be created before creating mediated device of this type.

/sys/…/mdev_supported_types/<type-id>/create

Defined on file sysfs-bus-vfio-mdev

Writing UUID to this file will create mediated device of type <type-id> for parent device <device>. This is a write-only file. For example:

# echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" >       \
     /sys/devices/foo/mdev_supported_types/foo-1/create

/sys/…/mdev_supported_types/<type-id>/description

Defined on file sysfs-bus-vfio-mdev

Reading this attribute will show description of the type of mediated device that will get created of type <type-id>. This is optional attribute. For example: “2 heads, 512M FB, 2560x1600 maximum resolution”

Users:

Userspace applications interested in knowing the details of a particular <type-id> that can help in understanding the features provided by that type of mediated device.

/sys/…/mdev_supported_types/<type-id>/device_api

Defined on file sysfs-bus-vfio-mdev

Reading this attribute will show VFIO device API supported by this type. For example, “vfio-pci” for a PCI device, “vfio-platform” for platform device.

/sys/…/mdev_supported_types/<type-id>/devices/

Defined on file sysfs-bus-vfio-mdev

This directory contains symbolic links pointing to mdev devices sysfs entries which are created of this <type-id>.

/sys/…/mdev_supported_types/<type-id>/name

Defined on file sysfs-bus-vfio-mdev

Reading this attribute will show human readable name of the mediated device that will get created of type <type-id>. This is optional attribute. For example: “Grid M60-0Q”

Users:

Userspace applications interested in knowing the name of a particular <type-id> that can help in understanding the type of mediated device.

/sys/…/uevent

Defined on file sysfs-uevent

Enable passing additional variables for synthetic uevents that are generated by writing /sys/…/uevent file.

Recognized extended format is:

ACTION [UUID [KEY=VALUE ...]

The ACTION is compulsory - it is the name of the uevent action (add, change, remove). There is no change compared to previous functionality here. The rest of the extended format is optional.

You need to pass UUID first before any KEY=VALUE pairs. The UUID must be in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format where ‘x’ is a hex digit. The UUID is considered to be a transaction identifier so it’s possible to use the same UUID value for one or more synthetic uevents in which case we logically group these uevents together for any userspace listeners. The UUID value appears in uevent as SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx environment variable.

If UUID is not passed in, the generated synthetic uevent gains SYNTH_UUID=0 environment variable automatically.

The KEY=VALUE pairs can contain alphanumeric characters only.

It’s possible to define zero or more pairs - each pair is then delimited by a space character ‘ ‘. Each pair appears in synthetic uevent as SYNTH_ARG_KEY=VALUE. That means the KEY name gains SYNTH_ARG_ prefix to avoid possible collisions with existing variables.

Example of valid sequence written to the uevent file:

add fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed A=1 B=abc

This generates synthetic uevent including these variables:

ACTION=add
SYNTH_ARG_A=1
SYNTH_ARG_B=abc
SYNTH_UUID=fe4d7c9d-b8c6-4a70-9ef1-3d8a58d18eed

Users:

udev, userspace tools generating synthetic uevents

Symbols under /sys/block

/sys/block/*/device/ncq_prio_enable

Defined on file sysfs-block-device

(RW) Write to the file to turn on or off the SATA ncq (native command queueing) support. By default this feature is turned off.

/sys/block/*/device/sw_activity

Defined on file sysfs-block-device

(RW) Used by drivers which support software controlled activity LEDs.

It has the following valid values:

0	OFF - the LED is not activated on activity
1	BLINK_ON - the LED blinks on every 10ms when activity is detected.
2	BLINK_OFF - the LED is on when idle, and blinks off every 10ms when activity is detected.

Note that the user must turn sw_activity OFF it they wish to control the activity LED via the em_message file.

/sys/block/*/device/unload_heads

Defined on file sysfs-block-device

(RW) Hard disk shock protection

Writing an integer value to this file will take the heads of the respective drive off the platter and block all I/O operations for the specified number of milliseconds.

• If the device does not support the unload heads feature, access is denied with -EOPNOTSUPP.

• The maximal value accepted for a timeout is 30000 milliseconds.

• A previously set timeout can be cancelled and disk can resume normal operation immediately by specifying a timeout of 0.

• Some hard drives only comply with an earlier version of the ATA standard, but support the unload feature nonetheless. There is no safe way Linux can detect these devices, so this is not enabled by default. If it is known that your device does support the unload feature, then you can tell the kernel to enable it by writing -1. It can be disabled again by writing -2.

• Values below -2 are rejected with -EINVAL

For more information, see Hard disk shock protection

/sys/block/<device>/iosched/target_latency

Defined on file sysfs-cfq-target-latency

The /sys/block/<device>/iosched/target_latency only exists when the user sets cfq to /sys/block/<device>/scheduler. It contains an estimated latency time for the cfq. cfq will use it to calculate the time slice used for every task.

/sys/block/<disk>/<part>/stat

Defined on file sysfs-block

The /sys/block/<disk>/<part>/stat files display the I/O statistics of partition <part>. The format is the same as the above-written /sys/block/<disk>/stat format.

/sys/block/<disk>/<partition>/alignment_offset

Defined on file sysfs-block

Storage devices may report a physical block size that is bigger than the logical block size (for instance a drive with 4KB physical sectors exposing 512-byte logical blocks to the operating system). This parameter indicates how many bytes the beginning of the partition is offset from the disk’s natural alignment.

/sys/block/<disk>/<partition>/discard_alignment

Defined on file sysfs-block

Devices that support discard functionality may internally allocate space in units that are bigger than the exported logical block size. The discard_alignment parameter indicates how many bytes the beginning of the partition is offset from the internal allocation unit’s natural alignment.

/sys/block/<disk>/alignment_offset

Defined on file sysfs-block

Storage devices may report a physical block size that is bigger than the logical block size (for instance a drive with 4KB physical sectors exposing 512-byte logical blocks to the operating system). This parameter indicates how many bytes the beginning of the device is offset from the disk’s natural alignment.

/sys/block/<disk>/bcache/btree_cache_size

Defined on file sysfs-block-bcache

Number of btree buckets/nodes that are currently cached in memory; cache dynamically grows and shrinks in response to memory pressure from the rest of the system.

/sys/block/<disk>/bcache/btree_written

Defined on file sysfs-block-bcache

For a cache, sum of all btree writes in human readable units.

/sys/block/<disk>/bcache/bucket_size

Defined on file sysfs-block-bcache

For a cache, bucket size in human readable units, as set at cache creation time; should match the erase block size of the SSD for optimal performance.

/sys/block/<disk>/bcache/bypassed

Defined on file sysfs-block-bcache

Sum of all reads and writes that have bypassed the cache (due to the sequential cutoff). Expressed as bytes in human readable units.

/sys/block/<disk>/bcache/cache

Defined on file sysfs-block-bcache

For a backing device that has cache, a symlink to the bcache/ dir of that cache.

/sys/block/<disk>/bcache/cache_hit_ratio

Defined on file sysfs-block-bcache

For backing devices: cache hits as a percentage.

/sys/block/<disk>/bcache/cache_hits

Defined on file sysfs-block-bcache

For backing devices: integer number of full cache hits, counted per bio. A partial cache hit counts as a miss.

/sys/block/<disk>/bcache/cache_misses

Defined on file sysfs-block-bcache

For backing devices: integer number of cache misses.

/sys/block/<disk>/bcache/clear_stats

Defined on file sysfs-block-bcache

Writing to this file resets all the statistics for the device.

/sys/block/<disk>/bcache/discard

Defined on file sysfs-block-bcache

For a cache, a boolean allowing discard/TRIM to be turned off or back on if the device supports it.

/sys/block/<disk>/bcache/nbuckets

Defined on file sysfs-block-bcache

For a cache, the number of usable buckets.

/sys/block/<disk>/bcache/sequential_cutoff

Defined on file sysfs-block-bcache

For backing devices: Threshold past which sequential IO will skip the cache. Read and written as bytes in human readable units (i.e. echo 10M > sequntial_cutoff).

/sys/block/<disk>/bcache/synchronous

Defined on file sysfs-block-bcache

For a cache, a boolean that allows synchronous mode to be switched on and off. In synchronous mode all writes are ordered such that the cache can reliably recover from unclean shutdown; if disabled bcache will not generally wait for writes to complete but if the cache is not shut down cleanly all data will be discarded from the cache. Should not be turned off with writeback caching enabled.

/sys/block/<disk>/bcache/tree_depth

Defined on file sysfs-block-bcache

For a cache, height of the btree excluding leaf nodes (i.e. a one node tree will have a depth of 0).

/sys/block/<disk>/bcache/unregister

Defined on file sysfs-block-bcache

A write to this file causes the backing device or cache to be unregistered. If a backing device had dirty data in the cache, writeback mode is automatically disabled and all dirty data is flushed before the device is unregistered. Caches unregister all associated backing devices before unregistering themselves.

/sys/block/<disk>/bcache/writeback

Defined on file sysfs-block-bcache

For backing devices: When on, writeback caching is enabled and writes will be buffered in the cache. When off, caching is in writethrough mode; reads and writes will be added to the cache but no write buffering will take place.

/sys/block/<disk>/bcache/writeback_delay

Defined on file sysfs-block-bcache

For backing devices: In writeback mode, when dirty data is written to the cache and the cache held no dirty data for that backing device, writeback from cache to backing device starts after this delay, expressed as an integer number of seconds.

/sys/block/<disk>/bcache/writeback_percent

Defined on file sysfs-block-bcache

For backing devices: If nonzero, writeback from cache to backing device only takes place when more than this percentage of the cache is used, allowing more write coalescing to take place and reducing total number of writes sent to the backing device. Integer between 0 and 40.

/sys/block/<disk>/bcache/writeback_running

Defined on file sysfs-block-bcache

For backing devices: when off, dirty data will not be written from the cache to the backing device. The cache will still be used to buffer writes until it is mostly full, at which point writes transparently revert to writethrough mode. Intended only for benchmarking/testing.

/sys/block/<disk>/bcache/written

Defined on file sysfs-block-bcache

For a cache, total amount of data in human readable units written to the cache, excluding all metadata.

/sys/block/<disk>/discard_alignment

Defined on file sysfs-block

Devices that support discard functionality may internally allocate space in units that are bigger than the exported logical block size. The discard_alignment parameter indicates how many bytes the beginning of the device is offset from the internal allocation unit’s natural alignment.

/sys/block/<disk>/integrity/device_is_integrity_capable

Defined on file sysfs-block

Indicates whether a storage device is capable of storing integrity metadata. Set if the device is T10 PI-capable.

/sys/block/<disk>/integrity/format

Defined on file sysfs-block

Metadata format for integrity capable block device. E.g. T10-DIF-TYPE1-CRC.

/sys/block/<disk>/integrity/protection_interval_bytes

Defined on file sysfs-block

Describes the number of data bytes which are protected by one integrity tuple. Typically the device’s logical block size.

/sys/block/<disk>/integrity/read_verify

Defined on file sysfs-block

Indicates whether the block layer should verify the integrity of read requests serviced by devices that support sending integrity metadata.

/sys/block/<disk>/integrity/tag_size

Defined on file sysfs-block

Number of bytes of integrity tag space available per 512 bytes of data.

/sys/block/<disk>/integrity/write_generate

Defined on file sysfs-block

Indicates whether the block layer should automatically generate checksums for write requests bound for devices that support receiving integrity metadata.

/sys/block/<disk>/queue/chunk_sectors

Defined on file sysfs-block

chunk_sectors has different meaning depending on the type of the disk. For a RAID device (dm-raid), chunk_sectors indicates the size in 512B sectors of the RAID volume stripe segment. For a zoned block device, either host-aware or host-managed, chunk_sectors indicates the size in 512B sectors of the zones of the device, with the eventual exception of the last zone of the device which may be smaller.

/sys/block/<disk>/queue/discard_granularity

Defined on file sysfs-block

Devices that support discard functionality may internally allocate space using units that are bigger than the logical block size. The discard_granularity parameter indicates the size of the internal allocation unit in bytes if reported by the device. Otherwise the discard_granularity will be set to match the device’s physical block size. A discard_granularity of 0 means that the device does not support discard functionality.

/sys/block/<disk>/queue/discard_max_bytes

Defined on file sysfs-block

Devices that support discard functionality may have internal limits on the number of bytes that can be trimmed or unmapped in a single operation. Some storage protocols also have inherent limits on the number of blocks that can be described in a single command. The discard_max_bytes parameter is set by the device driver to the maximum number of bytes that can be discarded in a single operation. Discard requests issued to the device must not exceed this limit. A discard_max_bytes value of 0 means that the device does not support discard functionality.

/sys/block/<disk>/queue/discard_zeroes_data

Defined on file sysfs-block

Will always return 0. Don’t rely on any specific behavior for discards, and don’t read this file.

/sys/block/<disk>/queue/io_timeout

Defined on file sysfs-block

io_timeout is the request timeout in milliseconds. If a request does not complete in this time then the block driver timeout handler is invoked. That timeout handler can decide to retry the request, to fail it or to start a device recovery strategy.

/sys/block/<disk>/queue/logical_block_size

Defined on file sysfs-block

This is the smallest unit the storage device can address. It is typically 512 bytes.

/sys/block/<disk>/queue/max_active_zones

Defined on file sysfs-block

For zoned block devices (zoned attribute indicating “host-managed” or “host-aware”), the sum of zones belonging to any of the zone states: EXPLICIT OPEN, IMPLICIT OPEN or CLOSED, is limited by this value. If this value is 0, there is no limit.

/sys/block/<disk>/queue/max_open_zones

Defined on file sysfs-block

For zoned block devices (zoned attribute indicating “host-managed” or “host-aware”), the sum of zones belonging to any of the zone states: EXPLICIT OPEN or IMPLICIT OPEN, is limited by this value. If this value is 0, there is no limit.

/sys/block/<disk>/queue/minimum_io_size

Defined on file sysfs-block

Storage devices may report a granularity or preferred minimum I/O size which is the smallest request the device can perform without incurring a performance penalty. For disk drives this is often the physical block size. For RAID arrays it is often the stripe chunk size. A properly aligned multiple of minimum_io_size is the preferred request size for workloads where a high number of I/O operations is desired.

/sys/block/<disk>/queue/nomerges

Defined on file sysfs-block

Standard I/O elevator operations include attempts to merge contiguous I/Os. For known random I/O loads these attempts will always fail and result in extra cycles being spent in the kernel. This allows one to turn off this behavior on one of two ways: When set to 1, complex merge checks are disabled, but the simple one-shot merges with the previous I/O request are enabled. When set to 2, all merge tries are disabled. The default value is 0 - which enables all types of merge tries.

/sys/block/<disk>/queue/nr_zones

Defined on file sysfs-block

nr_zones indicates the total number of zones of a zoned block device (“host-aware” or “host-managed” zone model). For regular block devices, the value is always 0.

/sys/block/<disk>/queue/optimal_io_size

Defined on file sysfs-block

Storage devices may report an optimal I/O size, which is the device’s preferred unit for sustained I/O. This is rarely reported for disk drives. For RAID arrays it is usually the stripe width or the internal track size. A properly aligned multiple of optimal_io_size is the preferred request size for workloads where sustained throughput is desired. If no optimal I/O size is reported this file contains 0.

/sys/block/<disk>/queue/physical_block_size

Defined on file sysfs-block

This is the smallest unit a physical storage device can write atomically. It is usually the same as the logical block size but may be bigger. One example is SATA drives with 4KB sectors that expose a 512-byte logical block size to the operating system. For stacked block devices the physical_block_size variable contains the maximum physical_block_size of the component devices.

/sys/block/<disk>/queue/write_same_max_bytes

Defined on file sysfs-block

Some devices support a write same operation in which a single data block can be written to a range of several contiguous blocks on storage. This can be used to wipe areas on disk or to initialize drives in a RAID configuration. write_same_max_bytes indicates how many bytes can be written in a single write same command. If write_same_max_bytes is 0, write same is not supported by the device.

/sys/block/<disk>/queue/write_zeroes_max_bytes

Defined on file sysfs-block

Devices that support write zeroes operation in which a single request can be issued to zero out the range of contiguous blocks on storage without having any payload in the request. This can be used to optimize writing zeroes to the devices. write_zeroes_max_bytes indicates how many bytes can be written in a single write zeroes command. If write_zeroes_max_bytes is 0, write zeroes is not supported by the device.

/sys/block/<disk>/queue/zoned

Defined on file sysfs-block

zoned indicates if the device is a zoned block device and the zone model of the device if it is indeed zoned. The possible values indicated by zoned are “none” for regular block devices and “host-aware” or “host-managed” for zoned block devices. The characteristics of host-aware and host-managed zoned block devices are described in the ZBC (Zoned Block Commands) and ZAC (Zoned Device ATA Command Set) standards. These standards also define the “drive-managed” zone model. However, since drive-managed zoned block devices do not support zone commands, they will be treated as regular block devices and zoned will report “none”.

/sys/block/<disk>/stat

Defined on file sysfs-block

The /sys/block/<disk>/stat files displays the I/O statistics of disk <disk>. They contain 11 fields:

1	reads completed successfully
2	reads merged
3	sectors read
4	time spent reading (ms)
5	writes completed
6	writes merged
7	sectors written
8	time spent writing (ms)
9	I/Os currently in progress
10	time spent doing I/Os (ms)
11	weighted time spent doing I/Os (ms)
12	discards completed
13	discards merged
14	sectors discarded
15	time spent discarding (ms)
16	flush requests completed
17	time spent flushing (ms)

For more details refer I/O statistics fields

/sys/block/dm-<num>/dm/name

Defined on file sysfs-block-dm

Device-mapper device name. Read-only string containing mapped device name.

Users: util-linux, device-mapper udev rules

/sys/block/dm-<num>/dm/rq_based_seq_io_merge_deadline

Defined on file sysfs-block-dm

Allow control over how long a request that is a reasonable merge candidate can be queued on the request queue. The resolution of this deadline is in microseconds (ranging from 1 to 100000 usecs). Setting this attribute to 0 (the default) will disable request-based DM’s merge heuristic and associated extra accounting. This attribute is not applicable to bio-based DM devices so it will only ever report 0 for them.

/sys/block/dm-<num>/dm/suspended

Defined on file sysfs-block-dm

Device-mapper device suspend state. Contains the value 1 while the device is suspended. Otherwise it contains 0. Read-only attribute.

Users: util-linux, device-mapper udev rules

/sys/block/dm-<num>/dm/use_blk_mq

Defined on file sysfs-block-dm

Request-based Device-mapper blk-mq I/O path mode. Contains the value 1 if the device is using blk-mq. Otherwise it contains 0. Read-only attribute.

/sys/block/dm-<num>/dm/uuid

Defined on file sysfs-block-dm

Device-mapper device UUID. Read-only string containing DM-UUID or empty string if DM-UUID is not set.

Users: util-linux, device-mapper udev rules

/sys/block/etherd*/firmware-version

Defined on file sysfs-block-aoe

(RO) Version of the firmware in the target.

/sys/block/etherd*/mac

Defined on file sysfs-block-aoe

(RO) The ethernet address of the remote Ata over Ethernet (AoE) device.

/sys/block/etherd*/netif

Defined on file sysfs-block-aoe

(RO) The names of the network interfaces on the localhost (comma separated) through which we are communicating with the remote AoE device.

/sys/block/etherd*/payload

Defined on file sysfs-block-aoe

(RO) The amount of user data transferred (in bytes) inside each AoE command on the network, network headers excluded.

/sys/block/etherd*/state

Defined on file sysfs-block-aoe

(RO) Device status. The state attribute is “up” when the device is ready for I/O and “down” if detected but unusable. The “down,closewait” state shows that the device is still open and cannot come up again until it has been closed. The “up,kickme” state means that the driver wants to send more commands to the target but found out there were already the max number of commands waiting for a response. It will retry again after being kicked by the periodic timer handler routine.

/sys/block/loopX/loop/autoclear

Defined on file sysfs-block-loop

(RO) Shows if the device is in autoclear mode or not ( “1” or “0”). Autoclear (if set) indicates that the loopback device will self-distruct after last close.

/sys/block/loopX/loop/backing_file

Defined on file sysfs-block-loop

(RO) The path of the backing file that the loop device maps its data blocks to.

/sys/block/loopX/loop/dio

Defined on file sysfs-block-loop

(RO) Shows if direct IO is being used to access backing file or not (“1 or “0”).

/sys/block/loopX/loop/offset

Defined on file sysfs-block-loop

(RO) Start offset (in bytes).

/sys/block/loopX/loop/partscan

Defined on file sysfs-block-loop

(RO) Shows if automatic partition scanning is enabled for the device or not (“1” or “0”). This can be requested individually per loop device during its setup by setting LO_FLAGS_PARTSCAN in in the ioctl request. By default, no partition tables are scanned.

/sys/block/loopX/loop/sizelimit

Defined on file sysfs-block-loop

(RO) The size (in bytes) that the block device maps, starting from the offset.

/sys/block/rnbd<N>/rnbd/access_mode

Defined on file sysfs-block-rnbd

Contains the device access mode: ro, rw or migration.

/sys/block/rnbd<N>/rnbd/mapping_path

Defined on file sysfs-block-rnbd

Contains the path that was passed as “device_path” to the map_device operation.

/sys/block/rnbd<N>/rnbd/nr_poll_queues

Defined on file sysfs-block-rnbd

Contains the number of poll-mode queues

/sys/block/rnbd<N>/rnbd/remap_device

Defined on file sysfs-block-rnbd

Remap the disconnected device if the session is not destroyed yet.

/sys/block/rnbd<N>/rnbd/resize

Defined on file sysfs-block-rnbd

Write the number of sectors to change the size of the disk.

/sys/block/rnbd<N>/rnbd/session

Defined on file sysfs-block-rnbd

RNBD uses RTRS session to transport the data between client and server. The entry “session” contains the name of the session, that was used to establish the RTRS session. It’s the same name that was passed as server parameter to the map_device entry.

/sys/block/rnbd<N>/rnbd/state

Defined on file sysfs-block-rnbd

The file contains the current state of the block device. The state file returns “open” when the device is successfully mapped from the server and accepting I/O requests. When the connection to the server gets disconnected in case of an error (e.g. link failure), the state file returns “closed” and all I/O requests submitted to it will fail with -EIO.

/sys/block/rnbd<N>/rnbd/unmap_device

Defined on file sysfs-block-rnbd

To unmap a volume, “normal” or “force” has to be written to: /sys/block/rnbd<N>/rnbd/unmap_device

When “normal” is used, the operation will fail with EBUSY if any process 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.

Example:

# echo "normal" > /sys/block/rnbd0/rnbd/unmap_device

/sys/block/rssd*/status

Defined on file sysfs-block-rssd

This is a read-only file. Indicates the status of the device.

/sys/block/zram<id>/backing_dev

Defined on file sysfs-block-zram

The backing_dev file is read-write and set up backing device for zram to write incompressible pages. For using, user should enable CONFIG_ZRAM_WRITEBACK.

/sys/block/zram<id>/bd_stat

Defined on file sysfs-block-zram

The bd_stat file is read-only and represents backing device’s statistics (bd_count, bd_reads, bd_writes) in a format similar to block layer statistics file format.

/sys/block/zram<id>/comp_algorithm

Defined on file sysfs-block-zram

The comp_algorithm file is read-write and lets to show available and selected compression algorithms, change compression algorithm selection.

/sys/block/zram<id>/compact

Defined on file sysfs-block-zram

The compact file is write-only and trigger compaction for allocator zrm uses. The allocator moves some objects so that it could free fragment space.

/sys/block/zram<id>/debug_stat

Defined on file sysfs-block-zram

The debug_stat file is read-only and represents various device’s debugging info useful for kernel developers. Its format is not documented intentionally and may change anytime without any notice.

/sys/block/zram<id>/disksize

Defined on file sysfs-block-zram

The disksize file is read-write and specifies the disk size which represents the limit on the uncompressed worth of data that can be stored in this disk. Unit: bytes

/sys/block/zram<id>/idle

Defined on file sysfs-block-zram

idle file is write-only and mark zram slot as idle. If system has mounted debugfs, user can see which slots are idle via /sys/kernel/debug/zram/zram<id>/block_state

/sys/block/zram<id>/initstate

Defined on file sysfs-block-zram

The initstate file is read-only and shows the initialization state of the device.

/sys/block/zram<id>/io_stat

Defined on file sysfs-block-zram

The io_stat file is read-only and accumulates device’s I/O statistics not accounted by block layer. For example, failed_reads, failed_writes, etc. File format is similar to block layer statistics file format.

/sys/block/zram<id>/max_comp_streams

Defined on file sysfs-block-zram

The max_comp_streams file is read-write and specifies the number of backend’s zcomp_strm compression streams (number of concurrent compress operations).

/sys/block/zram<id>/mem_limit

Defined on file sysfs-block-zram

The mem_limit file is write-only and specifies the maximum amount of memory ZRAM can use to store the compressed data. The limit could be changed in run time and “0” means disable the limit. No limit is the initial state. Unit: bytes

/sys/block/zram<id>/mem_used_max

Defined on file sysfs-block-zram

The mem_used_max file is write-only and is used to reset the counter of maximum memory zram have consumed to store compressed data. For resetting the value, you should write “0”. Otherwise, you could see -EINVAL. Unit: bytes

/sys/block/zram<id>/mm_stat

Defined on file sysfs-block-zram

The mm_stat file is read-only and represents device’s mm statistics (orig_data_size, compr_data_size, etc.) in a format similar to block layer statistics file format.

/sys/block/zram<id>/reset

Defined on file sysfs-block-zram

The reset file is write-only and allows resetting the device. The reset operation frees all the memory associated with this device.

/sys/block/zram<id>/writeback

Defined on file sysfs-block-zram

The writeback file is write-only and trigger idle and/or huge page writeback to backing device.

/sys/block/zram<id>/writeback_limit

Defined on file sysfs-block-zram

The writeback_limit file is read-write and specifies the maximum amount of writeback ZRAM can do. The limit could be changed in run time.

/sys/block/zram<id>/writeback_limit_enable

Defined on file sysfs-block-zram

The writeback_limit_enable file is read-write and specifies eanbe of writeback_limit feature. “1” means eable the feature. No limit “0” is the initial state.

Symbols under /sys/bus

/sys/bus/*/drivers/ufshcd/*/auto_hibern8

Defined on file sysfs-driver-ufs

This file contains the auto-hibernate idle timer setting of a UFS host controller. A value of ‘0’ means auto-hibernate is not enabled. Otherwise the value is the number of microseconds of idle time before the UFS host controller will autonomously put the link into hibernate state. That will save power at the expense of increased latency. Note that the hardware supports 10-bit values with a power-of-ten multiplier which allows a maximum value of 102300000. Refer to the UFS Host Controller Interface specification for more details.

/sys/bus/acpi/devices/…/adr

Defined on file sysfs-bus-acpi

This attribute contains the output of the device object’s _ADR control method, which is present for ACPI device objects representing devices having standard enumeration algorithms, such as PCI.

/sys/bus/acpi/devices/…/description

Defined on file sysfs-bus-acpi

This attribute contains the output of the device object’s _STR control method, if present.

/sys/bus/acpi/devices/…/eject

Defined on file sysfs-bus-acpi

Writing 1 to this attribute will trigger hot removal of this device object. This file exists for every device object that has _EJ0 method.

/sys/bus/acpi/devices/…/hid

Defined on file sysfs-bus-acpi

This attribute indicates the hardware ID (_HID) of the device object. For example, PNP0103. This file is present for device objects having the _HID control method.

/sys/bus/acpi/devices/…/hrv

Defined on file sysfs-bus-acpi

(RO) Allows users to read the hardware version of non-PCI hardware, if the _HRV control method is present. It is mostly useful for non-PCI devices because lspci can list the hardware version for PCI devices.

/sys/bus/acpi/devices/…/modalias

Defined on file sysfs-bus-acpi

This attribute indicates the PNP IDs of the device object. That is acpi:HHHHHHHH:[CCCCCCC:]. Where each HHHHHHHH or CCCCCCCC contains device object’s PNPID (_HID or _CID).

/sys/bus/acpi/devices/…/path

Defined on file sysfs-bus-acpi

This attribute indicates the full path of ACPI namespace object associated with the device object. For example, _SB_.PCI0.

This file is not present for device objects representing fixed ACPI hardware features (like power and sleep buttons).

/sys/bus/acpi/devices/…/status

Defined on file sysfs-bus-acpi

(RO) Returns the ACPI device status: enabled, disabled or functioning or present, if the method _STA is present.

The return value is a decimal integer representing the device’s status bitmap:

Bit [0]	Set if the device is present.
Bit [1]	Set if the device is enabled and decoding its resources.
Bit [2]	Set if the device should be shown in the UI.
Bit [3]	Set if the device is functioning properly (cleared if device failed its diagnostics).
Bit [4]	Set if the battery is present.
Bits [31:5]	Reserved (must be cleared)

If bit [0] is clear, then bit 1 must also be clear (a device that is not present cannot be enabled).

Bit 0 can be clear (not present) with bit [3] set (device is functional). This case is used to indicate a valid device for which no device driver should be loaded.

More special cases are covered in the ACPI specification.

/sys/bus/acpi/devices/…/uid

Defined on file sysfs-bus-acpi

This attribute contains the output of the device object’s _UID control method, if present.

/sys/bus/acpi/intel-rapid-start/wakeup_events

Defined on file sysfs-driver-intel-rapid-start

An integer representing a set of wakeup events as follows: 1: Wake to enter hibernation when the wakeup timer expires 2: Wake to enter hibernation when the battery reaches a critical level

These values are ORed together. For example, a value of 3 indicates that the system will wake to enter hibernation when either the wakeup timer expires or the battery reaches a critical level.

/sys/bus/acpi/intel-rapid-start/wakeup_time

Defined on file sysfs-driver-intel-rapid-start

An integer representing the length of time the system will remain asleep before waking up to enter hibernation. This value is in minutes.

/sys/bus/amba/devices/…/driver_override

Defined on file sysfs-bus-amba

This file allows the driver for a device to be specified which will override standard OF, ACPI, ID table, and name matching. When specified, only a driver with a name matching the value written to driver_override will have an opportunity to bind to the device. The override is specified by writing a string to the driver_override file (echo vfio-amba > driver_override) and may be cleared with an empty string (echo > driver_override). This returns the device to standard matching rules binding. Writing to driver_override does not automatically unbind the device from its current driver or make any attempt to automatically load the specified driver. If no driver with a matching name is currently loaded in the kernel, the device will not bind to any driver. This also allows devices to opt-out of driver binding using a driver_override name such as “none”. Only a single driver may be specified in the override, there is no support for parsing delimiters.

/sys/bus/bcma/devices/…/class

Defined on file sysfs-bus-bcma

Each BCMA core is identified by few fields, including class it belongs to. See include/linux/bcma/bcma.h for possible values.

/sys/bus/bcma/devices/…/id

Defined on file sysfs-bus-bcma

There are a few types of BCMA cores, they can be identified by id field.

/sys/bus/bcma/devices/…/manuf

Defined on file sysfs-bus-bcma

Each BCMA core has it’s manufacturer id. See include/linux/bcma/bcma.h for possible values.

/sys/bus/bcma/devices/…/rev

Defined on file sysfs-bus-bcma

BCMA cores of the same type can still slightly differ depending on their revision. Use it for detailed programming.

/sys/bus/coresight/devices/<cti-name>/channels/chan_clear

Defined on file sysfs-bus-coresight-devices-cti

(Write) Deactivate a single channel.

/sys/bus/coresight/devices/<cti-name>/channels/chan_free

Defined on file sysfs-bus-coresight-devices-cti

(Read) show channels with no attached trigger signals.

/sys/bus/coresight/devices/<cti-name>/channels/chan_gate_disable

Defined on file sysfs-bus-coresight-devices-cti

(Write) Disable CTIGATE for single channel.

/sys/bus/coresight/devices/<cti-name>/channels/chan_gate_enable

Defined on file sysfs-bus-coresight-devices-cti

(RW) Enable CTIGATE for single channel (Write) or list enabled channels through the gate (R).

/sys/bus/coresight/devices/<cti-name>/channels/chan_inuse

Defined on file sysfs-bus-coresight-devices-cti

(Read) show channels with at least one attached trigger signal.

/sys/bus/coresight/devices/<cti-name>/channels/chan_pulse

Defined on file sysfs-bus-coresight-devices-cti

(Write) Pulse a single channel - activate for a single clock cycle.

/sys/bus/coresight/devices/<cti-name>/channels/chan_set

Defined on file sysfs-bus-coresight-devices-cti

(Write) Activate a single channel.

/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_in

Defined on file sysfs-bus-coresight-devices-cti

(Read) Read to see input triggers connected to selected view channel.

/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_out

Defined on file sysfs-bus-coresight-devices-cti

(Read) Read to see output triggers connected to selected view channel.

/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_reset

Defined on file sysfs-bus-coresight-devices-cti

(Write) Clear all channel / trigger programming.

/sys/bus/coresight/devices/<cti-name>/channels/chan_xtrigs_sel

Defined on file sysfs-bus-coresight-devices-cti

(RW) Write channel number to select a channel to view, read to see selected channel number.

/sys/bus/coresight/devices/<cti-name>/channels/trig_filter_enable

Defined on file sysfs-bus-coresight-devices-cti

(RW) Enable or disable trigger output signal filtering.

/sys/bus/coresight/devices/<cti-name>/channels/trigin_attach

Defined on file sysfs-bus-coresight-devices-cti

(Write) Attach a CTI input trigger to a CTM channel.

/sys/bus/coresight/devices/<cti-name>/channels/trigin_detach

Defined on file sysfs-bus-coresight-devices-cti

(Write) Detach a CTI input trigger from a CTM channel.

/sys/bus/coresight/devices/<cti-name>/channels/trigout_attach

Defined on file sysfs-bus-coresight-devices-cti

(Write) Attach a CTI output trigger to a CTM channel.

/sys/bus/coresight/devices/<cti-name>/channels/trigout_detach

Defined on file sysfs-bus-coresight-devices-cti

(Write) Detach a CTI output trigger from a CTM channel.

/sys/bus/coresight/devices/<cti-name>/channels/trigout_filtered

Defined on file sysfs-bus-coresight-devices-cti

(Read) List of output triggers filtered across all connections.

/sys/bus/coresight/devices/<cti-name>/ctmid

Defined on file sysfs-bus-coresight-devices-cti

(Read) Display the associated CTM ID

/sys/bus/coresight/devices/<cti-name>/enable

Defined on file sysfs-bus-coresight-devices-cti

(RW) Enable/Disable the CTI hardware.

/sys/bus/coresight/devices/<cti-name>/nr_trigger_cons

Defined on file sysfs-bus-coresight-devices-cti

(Read) Number of devices connected to triggers on this CTI

/sys/bus/coresight/devices/<cti-name>/powered

Defined on file sysfs-bus-coresight-devices-cti

(Read) Indicate if the CTI hardware is powered.

/sys/bus/coresight/devices/<cti-name>/regs/appclear

Defined on file sysfs-bus-coresight-devices-cti

(Write) Write APPCLEAR register to deactivate channel.

/sys/bus/coresight/devices/<cti-name>/regs/apppulse

Defined on file sysfs-bus-coresight-devices-cti

(Write) Write APPPULSE to pulse a channel active for one clock cycle.

/sys/bus/coresight/devices/<cti-name>/regs/appset

Defined on file sysfs-bus-coresight-devices-cti

(RW) Set CTIAPPSET register to activate channel. Read back to determine current value of register.

/sys/bus/coresight/devices/<cti-name>/regs/asicctl

Defined on file sysfs-bus-coresight-devices-cti

(RW) Read or write ASICCTL register.

/sys/bus/coresight/devices/<cti-name>/regs/chinstatus

Defined on file sysfs-bus-coresight-devices-cti

(Read) Read current status of channel inputs.

/sys/bus/coresight/devices/<cti-name>/regs/choutstatus

Defined on file sysfs-bus-coresight-devices-cti

(Read) read current status of channel outputs.

/sys/bus/coresight/devices/<cti-name>/regs/gate

Defined on file sysfs-bus-coresight-devices-cti

(RW) Read or write CTIGATE register.

/sys/bus/coresight/devices/<cti-name>/regs/inen

Defined on file sysfs-bus-coresight-devices-cti

(RW) Read or write the CTIINEN register selected by inout_sel.

/sys/bus/coresight/devices/<cti-name>/regs/inout_sel

Defined on file sysfs-bus-coresight-devices-cti

(RW) Select the index for inen and outen registers.

/sys/bus/coresight/devices/<cti-name>/regs/intack

Defined on file sysfs-bus-coresight-devices-cti

(Write) Write the INTACK register.

/sys/bus/coresight/devices/<cti-name>/regs/outen

Defined on file sysfs-bus-coresight-devices-cti

(RW) Read or write the CTIOUTEN register selected by inout_sel.

/sys/bus/coresight/devices/<cti-name>/regs/triginstatus

Defined on file sysfs-bus-coresight-devices-cti

(Read) read current status of input trigger signals

/sys/bus/coresight/devices/<cti-name>/regs/trigoutstatus

Defined on file sysfs-bus-coresight-devices-cti

(Read) read current status of output trigger signals.

/sys/bus/coresight/devices/<cti-name>/triggers<N>/in_signals

Defined on file sysfs-bus-coresight-devices-cti

(Read) Input trigger signals from connected device <N>

/sys/bus/coresight/devices/<cti-name>/triggers<N>/in_types

Defined on file sysfs-bus-coresight-devices-cti

(Read) Functional types for the input trigger signals from connected device <N>

/sys/bus/coresight/devices/<cti-name>/triggers<N>/name

Defined on file sysfs-bus-coresight-devices-cti

(Read) Name of connected device <N>

/sys/bus/coresight/devices/<cti-name>/triggers<N>/out_signals

Defined on file sysfs-bus-coresight-devices-cti

(Read) Output trigger signals to connected device <N>

/sys/bus/coresight/devices/<cti-name>/triggers<N>/out_types

Defined on file sysfs-bus-coresight-devices-cti

(Read) Functional types for the output trigger signals to connected device <N>

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_acctype

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with @addr_idx. Specifies characteristics about the address comparator being configure, for example the access type, the kind of instruction to trace, processor contect ID to trigger on, etc. Individual fields in the access type register may vary on the version of the trace entity.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_idx

Defined on file sysfs-bus-coresight-devices-etm3x

Select which address comparator or pair (of comparators) to work with.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_range

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with @addr_idx. Specifies the range of addresses to trigger on. Inclusion or exclusion is specificed in the corresponding access type register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with @addr_idx. Specifies the single address to trigger on, highly influenced by the configuration options of the corresponding access type register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_start

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with @addr_idx. Specifies the single address to start tracing on, highly influenced by the configuration options of the corresponding access type register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_stop

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with @addr_idx. Specifies the single address to stop tracing on, highly influenced by the configuration options of the corresponding access type register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with cntr_idx, give access to the counter event register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_idx

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Specifies the counter to work on.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_rld_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with cntr_idx, give access to the counter reload event register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_rld_val

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with cntr_idx, give access to the counter reload value register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_val

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used in conjunction with cntr_idx, give access to the counter value register.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cpu

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Holds the cpu number this tracer is affined to.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/ctxid_idx

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Specifies the index of the context ID register to be selected.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/ctxid_mask

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Mask to apply to all the context ID comparator.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/ctxid_pid

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Used with the ctxid_idx, specify with context ID to trigger on.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/curr_seq_state

Defined on file sysfs-bus-coresight-devices-etm3x

(Read) Holds the current state of the sequencer.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/enable_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines which event triggers a trace.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/enable_source

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Enable/disable tracing on this specific trace entiry. Enabling a source implies the source has been configured properly and a sink has been identidifed for it. The path of coresight components linking the source to the sink is configured and managed automatically by the coresight framework.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/etmsr

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Gives access to the ETM status register, which holds programming information and status on certains events.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/fifofull_level

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Number of byte left in the fifo before considering it full. Depending on the tracer’s version, can also hold threshold for data suppression.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmccer

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Configuration Code Extension register (0x1e8). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmccr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Configuration Code register (0x004). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmcr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Main Control register (0x000). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmidr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM ID register (0x1e4). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmscr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM System Configuration register (0x014). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr1

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Enable Conrol #1 register (0x024). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr2

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Enable Conrol #2 register (0x01c). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmteevr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Trace Enable Event register (0x020). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtraceidr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Trace ID register (0x200). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtsscr

Defined on file sysfs-bus-coresight-devices-etm3x

(RO) Print the content of the ETM Trace Start/Stop Conrol register (0x018). The value is read directly from the HW.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mode

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Interface with the driver’s ‘mode’ field, controlling various aspect of the trace entity such as time stamping, context ID size and cycle accurate tracing. Driver specific and bound to change depending on the driver.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_addr_cmp

Defined on file sysfs-bus-coresight-devices-etm3x

(Read) Provides the number of address comparators pairs accessible on a trace unit, as specified by bit 3:0 of register ETMCCR.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_cntr

Defined on file sysfs-bus-coresight-devices-etm3x

(Read) Provides the number of counters accessible on a trace unit, as specified by bit 15:13 of register ETMCCR.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_ctxid_cmp

Defined on file sysfs-bus-coresight-devices-etm3x

(Read) Provides the number of context ID comparator available on a trace unit, as specified by bit 25:24 of register ETMCCR.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/reset

Defined on file sysfs-bus-coresight-devices-etm3x

(Write) Cancels all configuration on a trace unit and set it back to its boot configuration.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_12_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines the event that causes the sequencer to transition from state 1 to state 2.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_13_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines the event that causes the sequencer to transition from state 1 to state 3.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_21_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines the event that causes the sequencer to transition from state 2 to state 1.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_23_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines the event that causes the sequencer to transition from state 2 to state 3.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_31_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines the event that causes the sequencer to transition from state 3 to state 1.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_32_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines the event that causes the sequencer to transition from state 3 to state 2.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/sync_freq

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Holds the trace synchronization frequency value - must be programmed with the various implementation behavior in mind.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/timestamp_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Defines an event that requests the insertion of a timestamp into the trace stream.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/traceid

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Holds the trace ID that will appear in the trace stream coming from this trace entity.

/sys/bus/coresight/devices/<memory_map>.[etm|ptm]/trigger_event

Defined on file sysfs-bus-coresight-devices-etm3x

(RW) Define the event that controls the trigger.

/sys/bus/coresight/devices/<memory_map>.etb/enable_sink

Defined on file sysfs-bus-coresight-devices-etb10

(RW) Add/remove a sink from a trace path. There can be multiple source for a single sink.

ex:

echo 1 > /sys/bus/coresight/devices/20010000.etb/enable_sink

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/ctl

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Shows the value held by the ETB Control register. The value is read directly from HW register CTL, 0x020.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/ffcr

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Shows the value held by the ETB Formatter and Flush Control register. The value is read directly from HW register FFCR, 0x304.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/ffsr

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Shows the value held by the ETB Formatter and Flush Status register. The value is read directly from HW register FFSR, 0x300.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/rdp

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Defines the depth, in words, of the trace RAM in powers of 2. The value is read directly from HW register RDP, 0x004.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/rrp

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Shows the value held by the ETB RAM Read Pointer register that is used to read entries from the Trace RAM over the APB interface. The value is read directly from HW register RRP, 0x014.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/rwp

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Shows the value held by the ETB RAM Write Pointer register that is used to sets the write pointer to write entries from the CoreSight bus into the Trace RAM. The value is read directly from HW register RWP, 0x018.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/sts

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Shows the value held by the ETB status register. The value is read directly from HW register STS, 0x00C.

/sys/bus/coresight/devices/<memory_map>.etb/mgmt/trg

Defined on file sysfs-bus-coresight-devices-etb10

(Read) Similar to “trigger_cntr” above except that this value is read directly from HW register TRG, 0x01C.

/sys/bus/coresight/devices/<memory_map>.etb/trigger_cntr

Defined on file sysfs-bus-coresight-devices-etb10

(RW) Disables write access to the Trace RAM by stopping the formatter after a defined number of words have been stored following the trigger event. The number of 32-bit words written into the Trace RAM following the trigger event is equal to the value stored in this register+1 (from ARM ETB-TRM).

/sys/bus/coresight/devices/<memory_map>.funnel/funnel_ctrl

Defined on file sysfs-bus-coresight-devices-funnel

(RW) Enables the slave ports and defines the hold time of the slave ports.

/sys/bus/coresight/devices/<memory_map>.funnel/priority

Defined on file sysfs-bus-coresight-devices-funnel

(RW) Defines input port priority order.

/sys/bus/coresight/devices/<memory_map>.stm/enable_source

Defined on file sysfs-bus-coresight-devices-stm

(RW) Enable/disable tracing on this specific trace macrocell. Enabling the trace macrocell implies it has been configured properly and a sink has been identified for it. The path of coresight components linking the source to the sink is configured and managed automatically by the coresight framework.

/sys/bus/coresight/devices/<memory_map>.stm/hwevent_enable

Defined on file sysfs-bus-coresight-devices-stm

(RW) Provides access to the HW event enable register, used in conjunction with HW event bank select register.

/sys/bus/coresight/devices/<memory_map>.stm/hwevent_select

Defined on file sysfs-bus-coresight-devices-stm

(RW) Gives access to the HW event block select register (STMHEBSR) in order to configure up to 256 channels. Used in conjunction with “hwevent_enable” register as described above.

/sys/bus/coresight/devices/<memory_map>.stm/port_enable

Defined on file sysfs-bus-coresight-devices-stm

(RW) Provides access to the stimulus port enable register (STMSPER). Used in conjunction with “port_select” described below.

/sys/bus/coresight/devices/<memory_map>.stm/port_select

Defined on file sysfs-bus-coresight-devices-stm

(RW) Used to determine which bank of stimulus port bit in register STMSPER (see above) apply to.

/sys/bus/coresight/devices/<memory_map>.stm/status

Defined on file sysfs-bus-coresight-devices-stm

(Read) List various control and status registers. The specific layout and content is driver specific.

/sys/bus/coresight/devices/<memory_map>.stm/traceid

Defined on file sysfs-bus-coresight-devices-stm

(RW) Holds the trace ID that will appear in the trace stream coming from this trace entity.

/sys/bus/coresight/devices/<memory_map>.tmc/buffer_size

Defined on file sysfs-bus-coresight-devices-tmc

(RW) Size of the trace buffer for TMC-ETR when used in SYSFS mode. Writable only for TMC-ETR configurations. The value should be aligned to the kernel pagesize.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/ctl

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC Control register. The value is read directly from HW register CTL, 0x020.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/devid

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Indicates the capabilities of the Coresight TMC. The value is read directly from the DEVID register, 0xFC8,

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/ffcr

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC Formatter and Flush Control register. The value is read directly from HW register FFCR, 0x304.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/ffsr

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC Formatter and Flush Status register. The value is read directly from HW register FFSR, 0x300.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/mode

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC Mode register, which indicate the mode the device has been configured to enact. The The value is read directly from the MODE register, 0x028.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/rrp

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC RAM Read Pointer register that is used to read entries from the Trace RAM over the APB interface. The value is read directly from HW register RRP, 0x014.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/rsz

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Defines the size, in 32-bit words, of the local RAM buffer. The value is read directly from HW register RSZ, 0x004.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/rwp

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC RAM Write Pointer register that is used to sets the write pointer to write entries from the CoreSight bus into the Trace RAM. The value is read directly from HW register RWP, 0x018.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/sts

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Shows the value held by the TMC status register. The value is read directly from HW register STS, 0x00C.

/sys/bus/coresight/devices/<memory_map>.tmc/mgmt/trg

Defined on file sysfs-bus-coresight-devices-tmc

(Read) Similar to “trigger_cntr” above except that this value is read directly from HW register TRG, 0x01C.

/sys/bus/coresight/devices/<memory_map>.tmc/trigger_cntr

Defined on file sysfs-bus-coresight-devices-tmc

(RW) Disables write access to the Trace RAM by stopping the formatter after a defined number of words have been stored following the trigger event. Additional interface for this driver are expected to be added as it matures.

/sys/bus/coresight/devices/etm<N>/addr_cmp_view

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the current settings for the selected address comparator.

/sys/bus/coresight/devices/etm<N>/addr_exlevel_s_ns

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Set the Exception Level matching bits for secure and non-secure exception levels.

/sys/bus/coresight/devices/etm<N>/addr_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select which address comparator or pair (of comparators) to work with.

/sys/bus/coresight/devices/etm<N>/addr_instdatatype

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls what type of comparison the trace unit performs.

/sys/bus/coresight/devices/etm<N>/addr_range

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Used to setup address range comparator values.

/sys/bus/coresight/devices/etm<N>/addr_single

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Used to setup single address comparator values.

/sys/bus/coresight/devices/etm<N>/bb_ctrl

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls which regions in the memory map are enabled to use branch broadcasting.

/sys/bus/coresight/devices/etm<N>/cntr_ctrl

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls the operation of the selected counter.

/sys/bus/coresight/devices/etm<N>/cntr_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select which counter unit to work with.

/sys/bus/coresight/devices/etm<N>/cntr_val

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) This sets or returns the current count value of the specific counter.

/sys/bus/coresight/devices/etm<N>/cntrldvr

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) This sets or returns the reload count value of the specific counter.

/sys/bus/coresight/devices/etm<N>/cpu

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) The CPU this tracing entity is associated with.

/sys/bus/coresight/devices/etm<N>/ctxid_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select which context ID comparator to work with.

/sys/bus/coresight/devices/etm<N>/ctxid_masks

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Mask for all 8 context ID comparator value registers (if implemented).

/sys/bus/coresight/devices/etm<N>/ctxid_pid

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Get/Set the context ID comparator value to trigger on.

/sys/bus/coresight/devices/etm<N>/cyc_threshold

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Sets the threshold value for cycle counting.

/sys/bus/coresight/devices/etm<N>/enable_source

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Enable/disable tracing on this specific trace entiry. Enabling a source implies the source has been configured properly and a sink has been identidifed for it. The path of coresight components linking the source to the sink is configured and managed automatically by the coresight framework.

/sys/bus/coresight/devices/etm<N>/event

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls the tracing of arbitrary events from bank 0 to 3.

/sys/bus/coresight/devices/etm<N>/event_instren

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls the behavior of the events in bank 0 to 3.

/sys/bus/coresight/devices/etm<N>/event_ts

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls the insertion of global timestamps in the trace streams.

/sys/bus/coresight/devices/etm<N>/event_vinst

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls instruction trace filtering.

/sys/bus/coresight/devices/etm<N>/mgmt/trcauthstatus

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Authentication Status Register (0xFB8). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcconfig

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the trace configuration register (0x010) as currently set by SW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcdevarch

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Device Architecture Register (offset 0xFBC). The value is taken directly read from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcdevid

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Device ID Register (0xFC8). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcdevtype

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Device Type Register (0xFCC). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trclsr

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the SW Lock Status Register (0xFB4). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcoslsr

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the OS Lock Status Register (0x304). The value it taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcpdcr

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Power Down Control Register (0x310). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcpdsr

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Power Down Status Register (0x314). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcpidr0

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Peripheral ID0 Register (0xFE0). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcpidr1

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Peripheral ID1 Register (0xFE4). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcpidr2

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Peripheral ID2 Register (0xFE8). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trcpidr3

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the Peripheral ID3 Register (0xFEC). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/mgmt/trctraceid

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the content of the trace ID register (0x040).

/sys/bus/coresight/devices/etm<N>/mode

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls various modes supported by this ETM, for example P0 instruction tracing, branch broadcast, cycle counting and context ID tracing.

/sys/bus/coresight/devices/etm<N>/nr_addr_cmp

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of address comparator pairs that are available for tracing.

/sys/bus/coresight/devices/etm<N>/nr_cntr

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of counters that are available for tracing.

/sys/bus/coresight/devices/etm<N>/nr_ext_inp

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates how many external inputs are implemented.

/sys/bus/coresight/devices/etm<N>/nr_pe_cmp

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of PE comparator inputs that are available for tracing.

/sys/bus/coresight/devices/etm<N>/nr_resource

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of resource selection pairs that are available for tracing.

/sys/bus/coresight/devices/etm<N>/nr_ss_cmp

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of single-shot comparator controls that are available for tracing.

/sys/bus/coresight/devices/etm<N>/nrseqstate

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of sequencer states that are implemented.

/sys/bus/coresight/devices/etm<N>/ns_exlevel_vinst

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) In non-secure state, each bit controls whether instruction tracing is enabled for the corresponding exception level.

/sys/bus/coresight/devices/etm<N>/numcidc

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of Context ID comparators that are available for tracing.

/sys/bus/coresight/devices/etm<N>/numvmidc

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Indicates the number of VMID comparators that are available for tracing.

/sys/bus/coresight/devices/etm<N>/pe

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls which PE to trace.

/sys/bus/coresight/devices/etm<N>/res_ctrl

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls the selection of the resources in the trace unit.

/sys/bus/coresight/devices/etm<N>/res_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select which resource selection unit to work with.

/sys/bus/coresight/devices/etm<N>/reset

Defined on file sysfs-bus-coresight-devices-etm4x

(Write) Cancels all configuration on a trace unit and set it back to its boot configuration.

/sys/bus/coresight/devices/etm<N>/s_exlevel_vinst

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) In Secure state, each bit controls whether instruction tracing is enabled for the corresponding exception level.

/sys/bus/coresight/devices/etm<N>/seq_event

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Moves the sequencer state to a specific state.

/sys/bus/coresight/devices/etm<N>/seq_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select which sequensor.

/sys/bus/coresight/devices/etm<N>/seq_reset_event

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Moves the sequencer to state 0 when a programmed event occurs.

/sys/bus/coresight/devices/etm<N>/seq_state

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Use this to set, or read, the sequencer state.

/sys/bus/coresight/devices/etm<N>/sshot_ctrl

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Access the selected single shot control register.

/sys/bus/coresight/devices/etm<N>/sshot_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select the single shot control register to access.

/sys/bus/coresight/devices/etm<N>/sshot_pe_ctrl

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Access the selected single show PE comparator control register.

/sys/bus/coresight/devices/etm<N>/sshot_status

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Print the current value of the selected single shot status register.

/sys/bus/coresight/devices/etm<N>/syncfreq

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Controls how often trace synchronization requests occur.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr0

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the tracing capabilities of the trace unit (0x1E0). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr1

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the tracing capabilities of the trace unit (0x1E4). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr10

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the number of P1 right-hand keys that the trace unit can use (0x188). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr11

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the number of special P1 right-hand keys that the trace unit can use (0x18C). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr12

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the number of conditional P1 right-hand keys that the trace unit can use (0x190). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr13

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the number of special conditional P1 right-hand keys that the trace unit can use (0x194). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr2

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the maximum size of the data value, data address, VMID, context ID and instuction address in the trace unit (0x1E8). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr3

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the value associated with various resources available to the trace unit. See the Trace Macrocell architecture specification for more details (0x1E8). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr4

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns how many resources the trace unit supports (0x1F0). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr5

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns how many resources the trace unit supports (0x1F4). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr8

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the maximum speculation depth of the instruction trace stream. (0x180). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/trcidr/trcidr9

Defined on file sysfs-bus-coresight-devices-etm4x

(Read) Returns the number of P0 right-hand keys that the trace unit can use (0x184). The value is taken directly from the HW.

/sys/bus/coresight/devices/etm<N>/vinst_pe_cmp_start_stop

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Access the start stop control register for PE input comparators.

/sys/bus/coresight/devices/etm<N>/vmid_idx

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Select which virtual machine ID comparator to work with.

/sys/bus/coresight/devices/etm<N>/vmid_masks

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Mask for all 8 virtual machine ID comparator value registers (if implemented).

/sys/bus/coresight/devices/etm<N>/vmid_val

Defined on file sysfs-bus-coresight-devices-etm4x

(RW) Get/Set the virtual machine ID comparator value to trigger on.

/sys/bus/coresight/devices/trbe<cpu>/align

Defined on file sysfs-bus-coresight-devices-trbe

(Read) Shows the TRBE write pointer alignment. This value is fetched from the TRBIDR register.

/sys/bus/coresight/devices/trbe<cpu>/flag

Defined on file sysfs-bus-coresight-devices-trbe

(Read) Shows if TRBE updates in the memory are with access and dirty flag updates as well. This value is fetched from the TRBIDR register.

/sys/bus/counter/devices/counterX/countY/ceiling

Defined on file sysfs-bus-counter

Count value ceiling for Count Y. This is the upper limit for the respective counter.

/sys/bus/counter/devices/counterX/countY/count

Defined on file sysfs-bus-counter

Count data of Count Y represented as a string.

/sys/bus/counter/devices/counterX/countY/count_mode

Defined on file sysfs-bus-counter

Count mode for channel Y. The ceiling and floor values for Count Y are used by the count mode where required. The following count modes are available:

normal:

Counting is continuous in either direction.

range limit:

An upper or lower limit is set, mimicking limit switches in the mechanical counterpart. The upper limit is set to the Count Y ceiling value, while the lower limit is set to the Count Y floor value. The counter freezes at count = ceiling when counting up, and at count = floor when counting down. At either of these limits, the counting is resumed only when the count direction is reversed.

non-recycle:

The counter is disabled whenever a counter overflow or underflow takes place. The counter is re-enabled when a new count value is loaded to the counter via a preset operation or direct write.

modulo-n:

A count value boundary is set between the Count Y floor value and the Count Y ceiling value. The counter is reset to the Count Y floor value at count = ceiling when counting up, while the counter is set to the Count Y ceiling value at count = floor when counting down; the counter does not freeze at the boundary points, but counts continuously throughout.

/sys/bus/counter/devices/counterX/countY/count_mode_available

/sys/bus/counter/devices/counterX/countY/error_noise_available

/sys/bus/counter/devices/counterX/countY/function_available

/sys/bus/counter/devices/counterX/countY/signalZ_action_available

Defined on file sysfs-bus-counter

Discrete set of available values for the respective Count Y configuration are listed in this file. Values are delimited by newline characters.

/sys/bus/counter/devices/counterX/countY/direction

Defined on file sysfs-bus-counter

Read-only attribute that indicates the count direction of Count Y. Two count directions are available: forward and backward.

Some counter devices are able to determine the direction of their counting. For example, quadrature encoding counters can determine the direction of movement by evaluating the leading phase of the respective A and B quadrature encoding signals. This attribute exposes such count directions.

/sys/bus/counter/devices/counterX/countY/enable

Defined on file sysfs-bus-counter

Whether channel Y counter is enabled. Valid attribute values are boolean.

This attribute is intended to serve as a pause/unpause mechanism for Count Y. Suppose a counter device is used to count the total movement of a conveyor belt: this attribute allows an operator to temporarily pause the counter, service the conveyor belt, and then finally unpause the counter to continue where it had left off.

/sys/bus/counter/devices/counterX/countY/error_noise

Defined on file sysfs-bus-counter

Read-only attribute that indicates whether excessive noise is present at the channel Y counter inputs.

/sys/bus/counter/devices/counterX/countY/floor

Defined on file sysfs-bus-counter

Count value floor for Count Y. This is the lower limit for the respective counter.

/sys/bus/counter/devices/counterX/countY/function

Defined on file sysfs-bus-counter

Count function mode of Count Y; count function evaluation is triggered by conditions specified by the Count Y signalZ_action attributes. The following count functions are available:

increase:

Accumulated count is incremented.

decrease:

Accumulated count is decremented.

pulse-direction:

Rising edges on signal A updates the respective count. The input level of signal B determines direction.

quadrature x1 a:

If direction is forward, rising edges on quadrature pair signal A updates the respective count; if the direction is backward, falling edges on quadrature pair signal A updates the respective count. Quadrature encoding determines the direction.

quadrature x1 b:

If direction is forward, rising edges on quadrature pair signal B updates the respective count; if the direction is backward, falling edges on quadrature pair signal B updates the respective count. Quadrature encoding determines the direction.

quadrature x2 a:

Any state transition on quadrature pair signal A updates the respective count. Quadrature encoding determines the direction.

quadrature x2 b:

Any state transition on quadrature pair signal B updates the respective count. Quadrature encoding determines the direction.

quadrature x4:

Any state transition on either quadrature pair signals updates the respective count. Quadrature encoding determines the direction.

/sys/bus/counter/devices/counterX/countY/name

Defined on file sysfs-bus-counter

Read-only attribute that indicates the device-specific name of Count Y. If possible, this should match the name of the respective channel as it appears in the device datasheet.

/sys/bus/counter/devices/counterX/countY/prescaler

Defined on file sysfs-bus-counter-ftm-quaddec

Configure the prescaler value associated with Count Y. On the FlexTimer, the counter clock source passes through a prescaler (i.e. a counter). This acts like a clock divider.

/sys/bus/counter/devices/counterX/countY/prescaler_available

Defined on file sysfs-bus-counter-ftm-quaddec

Discrete set of available values for the respective Count Y configuration are listed in this file. Values are delimited by newline characters.

/sys/bus/counter/devices/counterX/countY/preset

Defined on file sysfs-bus-counter

If the counter device supports preset registers – registers used to load counter channels to a set count upon device-defined preset operation trigger events – the preset count for channel Y is provided by this attribute.

/sys/bus/counter/devices/counterX/countY/preset_enable

Defined on file sysfs-bus-counter

Whether channel Y counter preset operation is enabled. Valid attribute values are boolean.

/sys/bus/counter/devices/counterX/countY/signalZ_action

Defined on file sysfs-bus-counter

Action mode of Count Y for Signal Z. This attribute indicates the condition of Signal Z that triggers the count function evaluation for Count Y. The following action modes are available:

none:

Signal does not trigger the count function. In Pulse-Direction count function mode, this Signal is evaluated as Direction.

rising edge:

Low state transitions to high state.

falling edge:

High state transitions to low state.

both edges:

Any state transition.

/sys/bus/counter/devices/counterX/name

Defined on file sysfs-bus-counter

Read-only attribute that indicates the device-specific name of the Counter. This should match the name of the device as it appears in its respective datasheet.

/sys/bus/counter/devices/counterX/num_counts

Defined on file sysfs-bus-counter

Read-only attribute that indicates the total number of Counts belonging to the Counter.

/sys/bus/counter/devices/counterX/num_signals

Defined on file sysfs-bus-counter

Read-only attribute that indicates the total number of Signals belonging to the Counter.

/sys/bus/counter/devices/counterX/signalY/cable_fault

Defined on file sysfs-bus-counter-104-quad-8

Read-only attribute that indicates whether a differential encoder cable fault (not connected or loose wires) is detected for the respective channel of Signal Y. Valid attribute values are boolean. Detection must first be enabled via the corresponding cable_fault_enable attribute.

/sys/bus/counter/devices/counterX/signalY/cable_fault_enable

Defined on file sysfs-bus-counter-104-quad-8

Whether detection of differential encoder cable faults for the respective channel of Signal Y is enabled. Valid attribute values are boolean.

/sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler

Defined on file sysfs-bus-counter-104-quad-8

Filter clock factor for input Signal Y. This prescaler value affects the inputs of both quadrature pair signals.

/sys/bus/counter/devices/counterX/signalY/index_polarity

Defined on file sysfs-bus-counter-104-quad-8

Active level of index input Signal Y; irrelevant in non-synchronous load mode.

/sys/bus/counter/devices/counterX/signalY/index_polarity_available

/sys/bus/counter/devices/counterX/signalY/synchronous_mode_available

Defined on file sysfs-bus-counter-104-quad-8

Discrete set of available values for the respective Signal Y configuration are listed in this file.

/sys/bus/counter/devices/counterX/signalY/name

Defined on file sysfs-bus-counter

Read-only attribute that indicates the device-specific name of Signal Y. If possible, this should match the name of the respective signal as it appears in the device datasheet.

/sys/bus/counter/devices/counterX/signalY/signal

Defined on file sysfs-bus-counter

Signal data of Signal Y represented as a string.

/sys/bus/counter/devices/counterX/signalY/synchronous_mode

Defined on file sysfs-bus-counter-104-quad-8

Configure the counter associated with Signal Y for non-synchronous or synchronous load mode. Synchronous load mode cannot be selected in non-quadrature (Pulse-Direction) clock mode.

non-synchronous:

A logic low level is the active level at this index input. The index function (as enabled via preset_enable) is performed directly on the active level of the index input.

synchronous:

Intended for interfacing with encoder Index output in quadrature clock mode. The active level is configured via index_polarity. The index function (as enabled via preset_enable) is performed synchronously with the quadrature clock on the active level of the index input.

/sys/bus/css/devices/…/driver_override

Defined on file sysfs-bus-css

This file allows the driver for a device to be specified. When specified, only a driver with a name matching the value written to driver_override will have an opportunity to bind to the device. The override is specified by writing a string to the driver_override file (echo vfio-ccw > driver_override) and may be cleared with an empty string (echo > driver_override). This returns the device to standard matching rules binding. Writing to driver_override does not automatically unbind the device from its current driver or make any attempt to automatically load the specified driver. If no driver with a matching name is currently loaded in the kernel, the device will not bind to any driver. This also allows devices to opt-out of driver binding using a driver_override name such as “none”. Only a single driver may be specified in the override, there is no support for parsing delimiters.

Note that unlike the mechanism of the same name for pci, this file does not allow to override basic matching rules. I.e., the driver must still match the subchannel type of the device.

/sys/bus/css/devices/…/modalias

Defined on file sysfs-bus-css

Contains the module alias as reported with uevents. It is of the format css:t<type> and present for all subchannel types.

/sys/bus/css/devices/…/type

Defined on file sysfs-bus-css

Contains the subchannel type, as reported by the hardware. This attribute is present for all subchannel types.

/sys/bus/css/drivers/io_subchannel/…/chpids

Defined on file sysfs-bus-css

Contains the ids of the channel paths used by this subchannel, as reported by the channel subsystem during subchannel recognition.

Note: This is an I/O-subchannel specific attribute.

Users: s390-tools, HAL

/sys/bus/css/drivers/io_subchannel/…/pimpampom

Defined on file sysfs-bus-css

Contains the PIM/PAM/POM values, as reported by the channel subsystem when last queried by the common I/O layer (this implies that this attribute is not necessarily in sync with the values current in the channel subsystem).

Note: This is an I/O-subchannel specific attribute.

Users: s390-tools, HAL

/sys/bus/cxl/devices/memX/firmware_version

Defined on file sysfs-bus-cxl

(RO) “FW Revision” string as reported by the Identify Memory Device Output Payload in the CXL-2.0 specification.

/sys/bus/cxl/devices/memX/pmem/size

Defined on file sysfs-bus-cxl

(RO) “Persistent Only Capacity” as bytes. Represents the identically named field in the Identify Memory Device Output Payload in the CXL-2.0 specification.

/sys/bus/cxl/devices/memX/ram/size

Defined on file sysfs-bus-cxl

(RO) “Volatile Only Capacity” as bytes. Represents the identically named field in the Identify Memory Device Output Payload in the CXL-2.0 specification.

/sys/bus/dfl/devices/dfl_dev.X/feature_id

Defined on file sysfs-bus-dfl

Read-only. It returns feature identifier local to its DFL FIU type.

Format: 0x%x

/sys/bus/dfl/devices/dfl_dev.X/fec_mode

Defined on file sysfs-bus-dfl-devices-n3000-nios

Read-only. Returns the FEC mode of the 25G links of the ethernet retimers configured by Nios firmware. “rs” for Reed Solomon FEC, “kr” for Fire Code FEC, “no” for NO FEC. “not supported” if the FEC mode setting is not supported, this happens when the Nios firmware version major < 3, or no link is configured to 25G. Format: string

/sys/bus/dfl/devices/dfl_dev.X/infX_cal_fail

Defined on file sysfs-bus-dfl-devices-emif

Read-only. It indicates if the calibration failed on this memory interface. “1” for calibration failure, “0” for OK. Format: %u

/sys/bus/dfl/devices/dfl_dev.X/infX_clear

Defined on file sysfs-bus-dfl-devices-emif

Write-only. Writing “1” to this file will zero out all memory data in this memory interface. Writing of other values is invalid. Format: %u

/sys/bus/dfl/devices/dfl_dev.X/infX_init_done

Defined on file sysfs-bus-dfl-devices-emif

Read-only. It indicates if the initialization completed on this memory interface. “1” for initialization complete, “0” for not yet. Format: %u

/sys/bus/dfl/devices/dfl_dev.X/nios_fw_version

Defined on file sysfs-bus-dfl-devices-n3000-nios

Read-only. Returns the version of the Nios firmware in the FPGA. Its format is “major.minor.patch”. Format: %x.%x.%x

/sys/bus/dfl/devices/dfl_dev.X/retimer_A_mode

Defined on file sysfs-bus-dfl-devices-n3000-nios

Read-only. Returns the enumeration value of the working mode of the retimer A configured by the Nios firmware. The value is read out from shared registers filled by the Nios firmware. Now the values could be:

• “0”: Reset

• “1”: 4x10G

• “2”: 4x25G

• “3”: 2x25G

• “4”: 2x25G+2x10G

• “5”: 1x25G

If the Nios firmware is updated in future to support more retimer modes, more enumeration value is expected. Format: 0x%x

/sys/bus/dfl/devices/dfl_dev.X/retimer_B_mode

Defined on file sysfs-bus-dfl-devices-n3000-nios

Read-only. Returns the enumeration value of the working mode of the retimer B configured by the Nios firmware. The value format is the same as retimer_A_mode.

/sys/bus/dfl/devices/dfl_dev.X/type

Defined on file sysfs-bus-dfl

Read-only. It returns type of DFL FIU of the device. Now DFL supports 2 FIU types, 0 for FME, 1 for PORT.

Format: 0x%x

/sys/bus/drivers/corsair/<dev>/current_profile

Defined on file sysfs-driver-hid-corsair

Get/set the current selected profile. Values are from 1 to 3.

/sys/bus/drivers/corsair/<dev>/macro_mode

Defined on file sysfs-driver-hid-corsair

Get/set the current playback mode. “SW” for software mode where G-keys triggers their regular key codes. “HW” for hardware playback mode where the G-keys play their macro from the on-board memory.

/sys/bus/event_source/devices/<dev>/format

Defined on file sysfs-bus-event_source-devices-format

Attribute group to describe the magic bits that go into perf_event_attr::config[012] for a particular pmu. Each attribute of this group defines the ‘hardware’ bitmask we want to export, so that userspace can deal with sane name/value pairs.

Userspace must be prepared for the possibility that attributes define overlapping bit ranges. For example:

attr1 = 'config:0-23'
attr2 = 'config:0-7'
attr3 = 'config:12-35'

Example: ‘config1:1,6-10,44’ Defines contents of attribute that occupies bits 1,6-10,44 of perf_event_attr::config1.

/sys/bus/event_source/devices/<pmu>/events/<event>

Defined on file sysfs-bus-event_source-devices-events

Per-pmu performance monitoring events specific to the running system

Each file (except for some of those with a ‘.’ in them, ‘.unit’ and ‘.scale’) in the ‘events’ directory describes a single performance monitoring event supported by the <pmu>. The name of the file is the name of the event.

File contents:

<term>[=<value>][,<term>[=<value>]]…

Where <term> is one of the terms listed under /sys/bus/event_source/devices/<pmu>/format/ and <value> is a number is base-16 format with a ‘0x’ prefix (lowercase only). If a <term> is specified alone (without an assigned value), it is implied that 0x1 is assigned to that <term>.

Examples (each of these lines would be in a seperate file):

event=0x2abc event=0x423,inv,cmask=0x3 domain=0x1,offset=0x8,starting_index=0xffff domain=0x1,offset=0x8,core=?

Each of the assignments indicates a value to be assigned to a particular set of bits (as defined by the format file corresponding to the <term>) in the perf_event structure passed to the perf_open syscall.

In the case of the last example, a value replacing “?” would need to be provided by the user selecting the particular event. This is referred to as “event parameterization”. Event parameters have the format ‘param=?’.

/sys/bus/event_source/devices/<pmu>/events/<event>.scale

Defined on file sysfs-bus-event_source-devices-events

Perf event scaling factors

A string representing a floating point value expressed in scientific notation to be multiplied by the event count recieved from the kernel to match the unit specified in the <event>.unit file.

Example:

2.3283064365386962890625e-10

This is provided to avoid performing floating point arithmetic in the kernel.

/sys/bus/event_source/devices/<pmu>/events/<event>.unit

Defined on file sysfs-bus-event_source-devices-events

Perf event units

A string specifying the English plural numerical unit that <event> (once multiplied by <event>.scale) represents.

Example:

Joules

/sys/bus/event_source/devices/dfl_fmeX/cpumask

Defined on file sysfs-bus-event_source-devices-dfl_fme

Read-only. This file always returns cpu which the PMU is bound for access to all fme pmu performance monitoring events.

/sys/bus/event_source/devices/dfl_fmeX/events

Defined on file sysfs-bus-event_source-devices-dfl_fme

Read-only. Attribute group to describe performance monitoring events specific to fme. Each attribute in this group describes a single performance monitoring event supported by this fme pmu. The name of the file is the name of the event. (See ABI/testing/sysfs-bus-event_source-devices-events).

All supported performance monitoring events are listed below.

Basic events (evtype=0x00):

clock = "event=0x00,evtype=0x00,portid=0xff"

Cache events (evtype=0x01):

cache_read_hit      = "event=0x00,evtype=0x01,portid=0xff"
cache_read_miss     = "event=0x01,evtype=0x01,portid=0xff"
cache_write_hit     = "event=0x02,evtype=0x01,portid=0xff"
cache_write_miss    = "event=0x03,evtype=0x01,portid=0xff"
cache_hold_request  = "event=0x05,evtype=0x01,portid=0xff"
cache_data_write_port_contention =
                      "event=0x06,evtype=0x01,portid=0xff"
cache_tag_write_port_contention =
                      "event=0x07,evtype=0x01,portid=0xff"
cache_tx_req_stall  = "event=0x08,evtype=0x01,portid=0xff"
cache_rx_req_stall  = "event=0x09,evtype=0x01,portid=0xff"
cache_eviction      = "event=0x0a,evtype=0x01,portid=0xff"

Fabric events (evtype=0x02):

fab_pcie0_read       = "event=0x00,evtype=0x02,portid=0xff"
fab_pcie0_write      = "event=0x01,evtype=0x02,portid=0xff"
fab_pcie1_read       = "event=0x02,evtype=0x02,portid=0xff"
fab_pcie1_write      = "event=0x03,evtype=0x02,portid=0xff"
fab_upi_read         = "event=0x04,evtype=0x02,portid=0xff"
fab_upi_write        = "event=0x05,evtype=0x02,portid=0xff"
fab_mmio_read        = "event=0x06,evtype=0x02,portid=0xff"
fab_mmio_write       = "event=0x07,evtype=0x02,portid=0xff"
fab_port_pcie0_read  = "event=0x00,evtype=0x02,portid=?"
fab_port_pcie0_write = "event=0x01,evtype=0x02,portid=?"
fab_port_pcie1_read  = "event=0x02,evtype=0x02,portid=?"
fab_port_pcie1_write = "event=0x03,evtype=0x02,portid=?"
fab_port_upi_read    = "event=0x04,evtype=0x02,portid=?"
fab_port_upi_write   = "event=0x05,evtype=0x02,portid=?"
fab_port_mmio_read   = "event=0x06,evtype=0x02,portid=?"
fab_port_mmio_write  = "event=0x07,evtype=0x02,portid=?"

VTD events (evtype=0x03):

vtd_port_read_transaction  = "event=0x00,evtype=0x03,portid=?"
vtd_port_write_transaction = "event=0x01,evtype=0x03,portid=?"
vtd_port_devtlb_read_hit   = "event=0x02,evtype=0x03,portid=?"
vtd_port_devtlb_write_hit  = "event=0x03,evtype=0x03,portid=?"
vtd_port_devtlb_4k_fill    = "event=0x04,evtype=0x03,portid=?"
vtd_port_devtlb_2m_fill    = "event=0x05,evtype=0x03,portid=?"
vtd_port_devtlb_1g_fill    = "event=0x06,evtype=0x03,portid=?"

VTD SIP events (evtype=0x04):

vtd_sip_iotlb_4k_hit  = "event=0x00,evtype=0x04,portid=0xff"
vtd_sip_iotlb_2m_hit  = "event=0x01,evtype=0x04,portid=0xff"
vtd_sip_iotlb_1g_hit  = "event=0x02,evtype=0x04,portid=0xff"
vtd_sip_slpwc_l3_hit  = "event=0x03,evtype=0x04,portid=0xff"
vtd_sip_slpwc_l4_hit  = "event=0x04,evtype=0x04,portid=0xff"
vtd_sip_rcc_hit       = "event=0x05,evtype=0x04,portid=0xff"
vtd_sip_iotlb_4k_miss = "event=0x06,evtype=0x04,portid=0xff"
vtd_sip_iotlb_2m_miss = "event=0x07,evtype=0x04,portid=0xff"
vtd_sip_iotlb_1g_miss = "event=0x08,evtype=0x04,portid=0xff"
vtd_sip_slpwc_l3_miss = "event=0x09,evtype=0x04,portid=0xff"
vtd_sip_slpwc_l4_miss = "event=0x0a,evtype=0x04,portid=0xff"
vtd_sip_rcc_miss      = "event=0x0b,evtype=0x04,portid=0xff"

/sys/bus/event_source/devices/dfl_fmeX/format

Defined on file sysfs-bus-event_source-devices-dfl_fme

Read-only. Attribute group to describe the magic bits that go into perf_event_attr.config for a particular pmu. (See ABI/testing/sysfs-bus-event_source-devices-format).

Each attribute under this group defines a bit range of the perf_event_attr.config. All supported attributes are listed below:

event  = "config:0-11"  - event ID
evtype = "config:12-15" - event type
portid = "config:16-23" - event source

For example:

fab_mmio_read = "event=0x06,evtype=0x02,portid=0xff"

It shows this fab_mmio_read is a fabric type (0x02) event with 0x06 local event id for overall monitoring (portid=0xff).

/sys/bus/event_source/devices/dsa*/cpumask

Defined on file sysfs-bus-event_source-devices-dsa

Read-only. This file always returns the cpu to which the IDXD DSA pmu is bound for access to all dsa pmu performance monitoring events.

/sys/bus/event_source/devices/dsa*/format

Defined on file sysfs-bus-event_source-devices-dsa

Read-only. Attribute group to describe the magic bits that go into perf_event_attr.config or perf_event_attr.config1 for the IDXD DSA pmu. (See also ABI/testing/sysfs-bus-event_source-devices-format).

Each attribute in this group defines a bit range in perf_event_attr.config or perf_event_attr.config1. All supported attributes are listed below (See the IDXD DSA Spec for possible attribute values):

event_category = "config:0-3"    - event category
event          = "config:4-31"   - event ID

filter_wq      = "config1:0-31"  - workqueue filter
filter_tc      = "config1:32-39" - traffic class filter
filter_pgsz    = "config1:40-43" - page size filter
filter_sz      = "config1:44-51" - transfer size filter
filter_eng     = "config1:52-59" - engine filter

/sys/bus/event_source/devices/hv_24x7/event_descs/<event-name>

Defined on file sysfs-bus-event_source-devices-hv_24x7

Provides the description of a particular event as provided by the firmware. If firmware does not provide a description, no file will be created.

Note that the event-name lacks the domain suffix appended for events in the events/ dir.

/sys/bus/event_source/devices/hv_24x7/event_long_descs/<event-name>

Defined on file sysfs-bus-event_source-devices-hv_24x7

Provides the “long” description of a particular event as provided by the firmware. If firmware does not provide a description, no file will be created.

Note that the event-name lacks the domain suffix appended for events in the events/ dir.

/sys/bus/event_source/devices/hv_24x7/format

Defined on file sysfs-bus-event_source-devices-hv_24x7

Read-only. Attribute group to describe the magic bits that go into perf_event_attr.config for a particular pmu. (See ABI/testing/sysfs-bus-event_source-devices-format).

Each attribute under this group defines a bit range of the perf_event_attr.config. All supported attributes are listed below:

chip = "config:16-31"
core  = "config:16-31"
domain = "config:0-3"
lpar = "config:0-15"
offset = "config:32-63"
vcpu = "config:16-31"

For example:

PM_PB_CYC =  "domain=1,offset=0x80,chip=?,lpar=0x0"

In this event, ‘?’ after chip specifies that this value will be provided by user while running this event.

/sys/bus/event_source/devices/hv_24x7/interface/catalog

Defined on file sysfs-bus-event_source-devices-hv_24x7

Provides access to the binary “24x7 catalog” provided by the hypervisor on POWER7 and 8 systems. This catalog lists events available from the powerpc “hv_24x7” pmu. Its format is documented here: https://raw.githubusercontent.com/jmesmon/catalog-24x7/master/hv-24x7-catalog.h

/sys/bus/event_source/devices/hv_24x7/interface/catalog_length

Defined on file sysfs-bus-event_source-devices-hv_24x7

A number equal to the length in bytes of the catalog. This is also extractable from the provided binary “catalog” sysfs entry.

/sys/bus/event_source/devices/hv_24x7/interface/catalog_version

Defined on file sysfs-bus-event_source-devices-hv_24x7

Exposes the “version” field of the 24x7 catalog. This is also extractable from the provided binary “catalog” sysfs entry.

/sys/bus/event_source/devices/hv_gpci/format

Defined on file sysfs-bus-event_source-devices-hv_gpci

Read-only. Attribute group to describe the magic bits that go into perf_event_attr.config for a particular pmu. (See ABI/testing/sysfs-bus-event_source-devices-format).

Each attribute under this group defines a bit range of the perf_event_attr.config. All supported attributes are listed below:

counter_info_version  = "config:16-23"
length  = "config:24-31"
partition_id  = "config:32-63"
request = "config:0-31"
sibling_part_id = "config:32-63"
hw_chip_id = "config:32-63"
offset = "config:32-63"
phys_processor_idx = "config:32-63"
secondary_index = "config:0-15"
starting_index = "config:32-63"

For example:

processor_core_utilization_instructions_completed = "request=0x94,
                      phys_processor_idx=?,counter_info_version=0x8,
                      length=8,offset=0x18"

In this event, ‘?’ after phys_processor_idx specifies this value this value will be provided by user while running this event.

/sys/bus/event_source/devices/hv_gpci/interface/collect_privileged

Defined on file sysfs-bus-event_source-devices-hv_gpci

‘0’ if the hypervisor is configured to forbid access to event counters being accumulated by other guests and to physical domain event counters.

‘1’ if that access is allowed.

/sys/bus/event_source/devices/hv_gpci/interface/expanded

Defined on file sysfs-bus-event_source-devices-hv_gpci

0 or 1. Indicates whether we have access to “EXPANDED” events (listed in arch/powerpc/perf/hv-gpci.h).

/sys/bus/event_source/devices/hv_gpci/interface/ga

Defined on file sysfs-bus-event_source-devices-hv_gpci

0 or 1. Indicates whether we have access to “GA” events (listed in arch/powerpc/perf/hv-gpci.h).

/sys/bus/event_source/devices/hv_gpci/interface/kernel_version

Defined on file sysfs-bus-event_source-devices-hv_gpci

A number indicating the latest version of the gpci interface that the kernel is aware of.

/sys/bus/event_source/devices/hv_gpci/interface/lab

Defined on file sysfs-bus-event_source-devices-hv_gpci

0 or 1. Indicates whether we have access to “LAB” events (listed in arch/powerpc/perf/hv-gpci.h).

/sys/bus/event_source/devices/hv_gpci/interface/version

Defined on file sysfs-bus-event_source-devices-hv_gpci

A number indicating the version of the gpci interface that the hypervisor reports supporting.

/sys/bus/fcoe/

Defined on file sysfs-bus-fcoe

The FCoE bus. Attributes in this directory are control interfaces.

Attributes:

ctlr_create:

‘FCoE Controller’ instance creation interface. Writing an <ifname> to this file will allocate and populate sysfs with a fcoe_ctlr_device (ctlr_X). The user can then configure any per-port settings and finally write to the fcoe_ctlr_device’s ‘start’ attribute to begin the kernel’s discovery and login process.

ctlr_destroy:

‘FCoE Controller’ instance removal interface. Writing a fcoe_ctlr_device’s sysfs name to this file will log the fcoe_ctlr_device out of the fabric or otherwise connected FCoE devices. It will also free all kernel memory allocated for this fcoe_ctlr_device and any structures associated with it, this includes the scsi_host.

/sys/bus/fcoe/devices/ctlr_X

Defined on file sysfs-bus-fcoe

‘FCoE Controller’ instances on the fcoe bus. The FCoE Controller now has a three stage creation process. 1) Write interface name to ctlr_create 2) Configure the FCoE Controller (ctlr_X) 3) Enable the FCoE Controller to begin discovery and login. The FCoE Controller is destroyed by writing it’s name, i.e. ctlr_X to the ctlr_delete file.

Attributes:

fcf_dev_loss_tmo:

Device loss timeout period (see below). Changing this value will change the dev_loss_tmo for all FCFs discovered by this controller.

mode:

Display or change the FCoE Controller’s mode. Possible modes are ‘Fabric’ and ‘VN2VN’. If a FCoE Controller is started in ‘Fabric’ mode then FIP FCF discovery is initiated and ultimately a fabric login is attempted. If a FCoE Controller is started in ‘VN2VN’ mode then FIP VN2VN discovery and login is performed. A FCoE Controller only supports one mode at a time.

enabled:

Whether an FCoE controller is enabled or disabled. 0 if disabled, 1 if enabled. Writing either 0 or 1 to this file will enable or disable the FCoE controller.

lesb/link_fail:

Link Error Status Block (LESB) link failure count.

lesb/vlink_fail:

Link Error Status Block (LESB) virtual link failure count.

lesb/miss_fka:

Link Error Status Block (LESB) missed FCoE Initialization Protocol (FIP) Keep-Alives (FKA).

lesb/symb_err:

Link Error Status Block (LESB) symbolic error count.

lesb/err_block:

Link Error Status Block (LESB) block error count.

lesb/fcs_error:

Link Error Status Block (LESB) Fibre Channel Services error count.

Notes: ctlr_X (global increment starting at 0)

/sys/bus/fcoe/devices/fcf_X

Defined on file sysfs-bus-fcoe

‘FCoE FCF’ instances on the fcoe bus. A FCF is a Fibre Channel Forwarder, which is a FCoE switch that can accept FCoE (Ethernet) packets, unpack them, and forward the embedded Fibre Channel frames into a FC fabric. It can also take outbound FC frames and pack them in Ethernet packets to be sent to their destination on the Ethernet segment.

Attributes:

fabric_name:

Identifies the fabric that the FCF services.

switch_name:

Identifies the FCF.

priority:

The switch’s priority amongst other FCFs on the same fabric.

selected:

1 indicates that the switch has been selected for use; 0 indicates that the switch will not be used.

fc_map:

The Fibre Channel MAP

vfid:

The Virtual Fabric ID

mac:

The FCF’s MAC address

fka_period:

The FIP Keep-Alive period

fabric_state: The internal kernel state

• “Unknown” - Initialization value

• “Disconnected” - No link to the FCF/fabric

• “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.

Notes: A device loss infrastructure similar to the FC Transport’s

is present in fcoe_sysfs. It is nice to have so that a link flapping adapter doesn’t continually advance the count used to identify the discovered FCF. FCFs will exist in a “Disconnected” state until either the timer expires and the FCF becomes “Deleted” or the FCF is rediscovered and becomes “Connected.”

Users: The first user of this interface will be the fcoeadm application, which is commonly packaged in the fcoe-utils package.

/sys/bus/fsl-mc/drivers/…/bind

Defined on file sysfs-bus-fsl-mc

Writing a device location to this file will cause the driver to attempt to bind to the device found at this location. The format for the location is Object.Id 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

/sys/bus/fsl-mc/drivers/…/unbind

Defined on file sysfs-bus-fsl-mc

Writing a device location to this file will cause the driver to attempt to unbind from the device found at this location. The format for the location is Object.Id 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

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed

Defined on file sysfs-driver-wacom

The /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed file controls reporting speed of Wacom bluetooth tablet. Reading from this file returns 1 if tablet reports in high speed mode or 0 otherwise. Writing to this file one of these values switches reporting speed.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/button<n>_rawimg

Defined on file sysfs-driver-wacom

When writing a 1024 byte raw image in Wacom Intuos 4 interleaving format to the file, the image shows up on Button N of the device. The image is a 64x32 pixel 4-bit gray image. The 1024 byte binary is split up into 16x 64 byte chunks. Each 64 byte chunk encodes the image data for two consecutive lines on the display. The low nibble of each byte contains the first line, and the high nibble contains the second line. When the Wacom Intuos 4 is connected over Bluetooth, the image has to contain 256 bytes (64x32 px 1 bit colour). The format is also scrambled, like in the USB mode, and it can be summarized by converting:

76543210 into GECA6420.
HGFEDCBA      HFDB7531

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/buttons_luminance

Defined on file sysfs-driver-wacom

Writing to this file sets the overall luminance level (0..15) of all eight button OLED displays.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/led

Defined on file sysfs-driver-wacom

Attribute group for control of the status LEDs and the OLEDs. This attribute group is only available for Intuos 4 M, L, and XL (with LEDs and OLEDs), Intuos 4 WL, Intuos 5 (LEDs only), Intuos Pro (LEDs only) and Cintiq 21UX2 and Cintiq 24HD (LEDs only). Therefore its presence implicitly signifies the presence of said LEDs and OLEDs on the tablet device.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status0_luminance

Defined on file sysfs-driver-wacom

<obsoleted by the LED class API now exported by the driver> Writing to this file sets the status LED luminance (1..127) when the stylus does not touch the tablet surface, and no button is pressed on the stylus. This luminance level is normally lower than the level when a button is pressed.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status1_luminance

Defined on file sysfs-driver-wacom

<obsoleted by the LED class API now exported by the driver> Writing to this file sets the status LED luminance (1..127) when the stylus touches the tablet surface, or any button is pressed on the stylus.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led0_select

Defined on file sysfs-driver-wacom

<obsoleted by the LED class API now exported by the driver> Writing to this file sets which one of the four (for Intuos 4 and Intuos 5) or of the right four (for Cintiq 21UX2 and Cintiq 24HD) status LEDs is active (0..3). The other three LEDs on the same side are always inactive.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led1_select

Defined on file sysfs-driver-wacom

<obsoleted by the LED class API now exported by the driver> Writing to this file sets which one of the left four (for Cintiq 21UX2 and Cintiq 24HD) status LEDs is active (0..3). The other three LEDs on the left are always inactive.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/<serial_number>/remote_mode

Defined on file sysfs-driver-wacom

<obsoleted by the LED class API now exported by the driver> Reading from this file reports the mode status of the remote as indicated by the LED lights on the device. If no reports have been received from the paired device, reading from this file will report ‘-1’. The mode is read-only and cannot be set through the driver.

/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote

Defined on file sysfs-driver-wacom

Writing the character sequence ‘*’ followed by a newline to this file will delete all of the current pairings on the device. Other character sequences are reserved. This file is write only.

/sys/bus/hid/drivers/logitech-hidpp-device/<dev>/builtin_power_supply

Defined on file sysfs-driver-hid-logitech-hidpp

Presence of this file indicates that HID++ driver is capable of handling battery properties in the kernel. This way, upower can add a udev rule to decide whether or not it should use the internal unifying support or the generic kernel one.

/sys/bus/hid/drivers/logitech-hidpp-device/<dev>/range

Defined on file sysfs-driver-hid-logitech-hidpp

(RW) This attribute controls the amount of ‘turn’ permitted in Logitech G920 wheel. Reading from the file shows the current range of the steering wheel. Writing a value within the min and max boundary sets the range of the wheel.

/sys/bus/hid/drivers/logitech/<dev>/alternate_modes

Defined on file sysfs-driver-hid-logitech-lg4ff

Displays a set of alternate modes supported by a wheel. Each mode is listed as follows:

Tag: Mode Name

Currently active mode is marked with an asterisk. List also contains an abstract item “native” which always denotes the native mode of the wheel. Echoing the mode tag switches the wheel into the corresponding mode. Depending on the exact model of the wheel not all listed modes might always be selectable. If a wheel cannot be switched into the desired mode, -EINVAL is returned accompanied with an explanatory message in the kernel log. This entry is not created for devices that have only one mode.

Currently supported mode switches:

Driving Force Pro:

DF-EX --> DFP

G25:

DF-EX --> DFP --> G25

G27:

DF-EX <*> DFP <-> G25 <-> G27
DF-EX <*--------> G25 <-> G27
DF-EX <*----------------> G27

G29:

DF-EX <*> DFP <-> G25 <-> G27 <-> G29
DF-EX <*--------> G25 <-> G27 <-> G29
DF-EX <*----------------> G27 <-> G29
DF-EX <*------------------------> G29

DFGT:

DF-EX <*> DFP <-> DFGT
DF-EX <*--------> DFGT

• hid_logitech module must be loaded with lg4ff_no_autoswitch=1 parameter set in order for the switch to DF-EX mode to work.

/sys/bus/hid/drivers/logitech/<dev>/combine_pedals

Defined on file sysfs-driver-hid-logitech-lg4ff

Controls whether a combined value of accelerator and brake is reported on the Y axis of the controller. Useful for older games which can do not work with separate accelerator/brake axis. Off (‘0’) by default, enabled by setting ‘1’.

/sys/bus/hid/drivers/logitech/<dev>/range

Defined on file sysfs-driver-hid-logitech-lg4ff

Display minimum, maximum and current range of the steering wheel. Writing a value within min and max boundaries sets the range of the wheel.

/sys/bus/hid/drivers/logitech/<dev>/real_id

Defined on file sysfs-driver-hid-logitech-lg4ff

Displays the real model of the wheel regardless of any alternate mode the wheel might be switched to. It is a read-only value. This entry is not created for devices that have only one mode.

/sys/bus/hid/drivers/ntrig/<dev>/activate_slack

Defined on file sysfs-driver-hid-ntrig

(RW) Number of contact frames ignored before acknowledging the start of activity (activating touch).

/sys/bus/hid/drivers/ntrig/<dev>/activation_width

/sys/bus/hid/drivers/ntrig/<dev>/activation_height

Defined on file sysfs-driver-hid-ntrig

Threholds to override activation slack.

activation_width	(RW) Width threshold to immediately start processing touch events.
activation_height	(RW) Height threshold to immediately start processing touch events.

/sys/bus/hid/drivers/ntrig/<dev>/decativate_slack

Defined on file sysfs-driver-hid-ntrig

(RW) Number of empty (no contact) frames ignored before acknowledging the end of activity (deactivating touch).

When the last finger is removed from the device, it sends a number of empty frames. By holding off on deactivation for a few frames false erroneous disconnects can be tolerated, where the sensor may mistakenly not detect a finger that is still present.

/sys/bus/hid/drivers/ntrig/<dev>/min_width

/sys/bus/hid/drivers/ntrig/<dev>/min_height

Defined on file sysfs-driver-hid-ntrig

Minimum size contact accepted.

min_width	(RW) Minimum touch contact width to decide activation and activity.
min_height	(RW) Minimum touch contact height to decide activation and activity.

/sys/bus/hid/drivers/ntrig/<dev>/sensor_logical_width

/sys/bus/hid/drivers/ntrig/<dev>/sensor_logical_height

Defined on file sysfs-driver-hid-ntrig

(RO) The range for positions reported during activity.

/sys/bus/hid/drivers/ntrig/<dev>/sensor_physical_width

/sys/bus/hid/drivers/ntrig/<dev>/sensor_physical_height

Defined on file sysfs-driver-hid-ntrig

(RO) These are internal ranges not used for normal events but useful for tuning.

/sys/bus/hid/drivers/prodikeys/…/channel

Defined on file sysfs-driver-hid-prodikeys

Allows control (via software) the midi channel to which that the pc-midi keyboard will output.midi data. Range: 0..15 Type: Read/write

/sys/bus/hid/drivers/prodikeys/…/octave

Defined on file sysfs-driver-hid-prodikeys

Controls the octave shift modifier in the pc-midi driver. The octave can be shifted via software up/down 2 octaves. 0 means the no ocatve shift. Range: -2..2 (minus 2 to plus 2) Type: Read/Write

/sys/bus/hid/drivers/prodikeys/…/sustain

Defined on file sysfs-driver-hid-prodikeys

Allows control (via software) the sustain duration of a note held by the pc-midi driver. 0 means sustain mode is disabled. Range: 0..5000 (milliseconds) Type: Read/write

/sys/bus/hid/drivers/wiimote/<dev>/bboard_calib

Defined on file sysfs-driver-hid-wiimote

This attribute is only provided if the device was detected as a balance board. It provides a single line with 3 calibration values for all 4 sensors. The values are separated by colons and are each 2 bytes long (encoded as 4 digit hexadecimal value). First, 0kg values for all 4 sensors are written, followed by the 17kg values for all 4 sensors and last the 34kg values for all 4 sensors.

Calibration data is already applied by the kernel to all input values but may be used by user-space to perform other transformations.

/sys/bus/hid/drivers/wiimote/<dev>/devtype

Defined on file sysfs-driver-hid-wiimote

While a device is initialized by the wiimote driver, we perform a device detection and signal a “change” uevent after it is done. This file shows the detected device type. “pending” means that the detection is still ongoing, “unknown” means, that the device couldn’t be detected or loaded. “generic” means, that the device couldn’t be detected but supports basic Wii Remote features and can be used. Other strings for each device-type are available and may be added if new device-specific detections are added. Currently supported are:

gen10:	First Wii Remote generation
gen20:	Second Wii Remote Plus generation (builtin MP)
balanceboard:	Wii Balance Board

/sys/bus/hid/drivers/wiimote/<dev>/extension

Defined on file sysfs-driver-hid-wiimote

This file contains the currently connected and initialized extensions. It can be one of: none, motionp, nunchuck, classic, motionp+nunchuck, motionp+classic motionp is the official Nintendo Motion+ extension, nunchuck is the official Nintendo Nunchuck extension and classic is the Nintendo Classic Controller extension. The motionp extension can be combined with the other two.

Starting with kernel-version 3.11 Motion Plus hotplugging is supported and if detected, it’s no longer reported as static extension. You will get uevent notifications for the motion-plus device then.

/sys/bus/hid/drivers/wiimote/<dev>/led1

/sys/bus/hid/drivers/wiimote/<dev>/led2

/sys/bus/hid/drivers/wiimote/<dev>/led3

/sys/bus/hid/drivers/wiimote/<dev>/led4

Defined on file sysfs-driver-hid-wiimote

Make it possible to set/get current led state. Reading from it returns 0 if led is off and 1 if it is on. Writing 0 to it disables the led, writing 1 enables it.

/sys/bus/hid/drivers/wiimote/<dev>/pro_calib

Defined on file sysfs-driver-hid-wiimote

This attribute is only provided if the device was detected as a pro-controller. It provides a single line with 4 calibration values for all 4 analog sticks. Format is: “x1:y1 x2:y2”. Data is prefixed with a +/-. Each value is a signed 16bit number. Data is encoded as decimal numbers and specifies the offsets of the analog sticks of the pro-controller.

Calibration data is already applied by the kernel to all input values but may be used by user-space to perform other transformations.

Calibration data is detected by the kernel during device setup. You can write “scann” into this file to re-trigger calibration. You can also write data directly in the form “x1:y1 x2:y2” to set the calibration values manually.

/sys/bus/hsi

Defined on file sysfs-bus-hsi

High Speed Synchronous Serial Interface (HSI) is a serial interface mainly used for connecting application engines (APE) with cellular modem engines (CMT) in cellular handsets. The bus will be populated with devices (hsi_clients) representing the protocols available in the system. Bus drivers implement those protocols.

/sys/bus/hsi/devices/…/modalias

Defined on file sysfs-bus-hsi

Stores the same MODALIAS value emitted by uevent Format: hsi:<hsi_client device name>

/sys/bus/i2c/…/idle_state

Defined on file sysfs-bus-i2c-devices-pca954x

Value that exists only for mux devices that can be written to control the behaviour of the multiplexer on idle. Possible values:

-2	disconnect on idle, i.e. deselect the last used channel, which is useful when there is a device with an address that conflicts with another device on another mux on the same parent bus.
-1	leave the mux as-is, which is the most optimal setting in terms of I2C operations and is the default mode.
0..<nchans>	set the mux to a predetermined channel, which is useful if there is one channel that is used almost always, and you want to reduce the latency for normal operations after rare transactions on other channels

/sys/bus/i2c/devices/…/bd9571mwv-regulator.*.auto/backup_mode

Defined on file sysfs-driver-bd9571mwv-regulator

Read/write the current state of DDR Backup Mode, which controls if DDR power rails will be kept powered during system suspend. (“on”/”1” = enabled, “off”/”0” = disabled). Two types of power switches (or control signals) can be used:

1. With a momentary power switch (or pulse signal), DDR Backup Mode is enabled by default when available, as the PMIC will be configured only during system suspend.

2. With a toggle power switch (or level signal), the following steps must be followed exactly:

   1. Configure PMIC for backup mode, to change the role of the accessory power switch from a power switch to a wake-up switch,

   2. Switch accessory power switch off, to prepare for system suspend, which is a manual step not controlled by software,

   3. Suspend system,

   4. Switch accessory power switch on, to resume the system.

   DDR Backup Mode must be explicitly enabled by the user, to invoke step 1.

See also Documentation/devicetree/bindings/mfd/bd9571mwv.txt.

Users: User space applications for embedded boards equipped with a BD9571MWV PMIC.

/sys/bus/i2c/devices/…/calibration

Defined on file sysfs-bus-i2c-devices-hm6352

Sets the calibration on or off (1 = on, 0 = off). See the chip data sheet.

/sys/bus/i2c/devices/…/device

Defined on file sysfs-bus-i2c-devices-fsa9480

show what device is attached

NONE	no device
USB	USB device is attached
UART	UART is attached
CHARGER	Charger is attaced
JIG	JIG is attached

/sys/bus/i2c/devices/…/heading0_input

Defined on file sysfs-bus-i2c-devices-hm6352

Reports the current heading from the compass as a floating point value in degrees.

/sys/bus/i2c/devices/…/output_hvled[n]

Defined on file sysfs-bus-i2c-devices-lm3533

Set the controlling backlight device for high-voltage current sink HVLED[n] (n = 1, 2) (0, 1).

/sys/bus/i2c/devices/…/output_lvled[n]

Defined on file sysfs-bus-i2c-devices-lm3533

Set the controlling led device for low-voltage current sink LVLED[n] (n = 1..5) (0..3).

/sys/bus/i2c/devices/…/power_state

Defined on file sysfs-bus-i2c-devices-hm6352

Sets the power state of the device. 0 sets the device into sleep mode, 1 wakes it up.

/sys/bus/i2c/devices/…/switch

Defined on file sysfs-bus-i2c-devices-fsa9480

show or set the state of manual switch

VAUDIO	switch to VAUDIO path
UART	switch to UART path
AUDIO	switch to AUDIO path
DHOST	switch to DHOST path
AUTO	switch automatically by device

/sys/bus/i2c/devices/…/trickle_charge_bypass

Defined on file sysfs-bus-i2c-devices-bq32k

Attribute for enable/disable the trickle charge bypass The trickle_charge_bypass attribute allows the userspace to enable/disable the Trickle charge FET bypass.

/sys/bus/i2c/devices/xxx/fw_version

Defined on file sysfs-driver-input-exc3000

Reports the firmware version provided by the touchscreen, for example “00_T6” on a EXC80H60

Access: Read

Valid values: Represented as string

/sys/bus/i2c/devices/xxx/model

Defined on file sysfs-driver-input-exc3000

Reports the model identification provided by the touchscreen, for example “Orion_1320” on a EXC80H60

Access: Read

Valid values: Represented as string

/sys/bus/i2c/devices/xxx/type

Defined on file sysfs-driver-input-exc3000

Reports the type identification provided by the touchscreen, for example “PCAP82H80 Series”

Access: Read

Valid values: Represented as string

/sys/bus/i2c/drivers/ucsi_ccg/…/do_flash

Defined on file sysfs-driver-ucsi-ccg

Tell the driver for Cypress CCGx Type-C controller to attempt firmware upgrade by writing [Yy1] to the file.

/sys/bus/i3c/devices/<bus-id>-<device-pid>

Defined on file sysfs-bus-i3c

These directories are just symbolic links to /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>.

/sys/bus/i3c/devices/i3c-<bus-id>

Defined on file sysfs-bus-i3c

An I3C bus. This directory will contain one sub-directory per I3C device present on the bus.

/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>

Defined on file sysfs-bus-i3c

An I3C device present on I3C bus identified by <bus-id>. Note that all devices are represented including the master driving the bus.

/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/bcr

Defined on file sysfs-bus-i3c

BCR stands for Bus Characteristics Register and express the device capabilities in term of speed, maximum read/write length, etc. See the I3C specification for more details.

/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dcr

Defined on file sysfs-bus-i3c

DCR stands for Device Characteristics Register and express the device capabilities in term of exposed features. See the I3C specification for more details.

/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dynamic_address

Defined on file sysfs-bus-i3c

Dynamic address assigned to device <bus-id>-<device-pid>. This address may change if the bus is re-initialized.

/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/hdrcap

Defined on file sysfs-bus-i3c

Expose the HDR (High Data Rate) capabilities of a device. Returns a list of supported HDR mode, each element is separated by space. Modes can be “hdr-ddr”, “hdr-tsp” and “hdr-tsl”.

See the I3C specification for more details about these HDR modes.

/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/pid

Defined on file sysfs-bus-i3c

PID stands for Provisional ID and is used to uniquely identify a device on a bus. This PID contains information about the vendor, the part and an instance ID so that several devices of the same type can be connected on the same bus. See the I3C specification for more details.

/sys/bus/i3c/devices/i3c-<bus-id>/bcr

Defined on file sysfs-bus-i3c

BCR stands for Bus Characteristics Register and express the device capabilities in term of speed, maximum read/write length, etc. See the I3C specification for more details. This entry describes the BCR of the master controller driving the bus.

/sys/bus/i3c/devices/i3c-<bus-id>/current_master

Defined on file sysfs-bus-i3c

Expose the master that owns the bus (<bus-id>-<master-pid>) at the time this file is read. Note that bus ownership can change overtime, so there’s no guarantee that when the read() call returns, the value returned is still valid.

/sys/bus/i3c/devices/i3c-<bus-id>/dcr

Defined on file sysfs-bus-i3c

DCR stands for Device Characteristics Register and express the device capabilities in term of exposed features. See the I3C specification for more details. This entry describes the DCR of the master controller driving the bus.

/sys/bus/i3c/devices/i3c-<bus-id>/dynamic_address

Defined on file sysfs-bus-i3c

Dynamic address assigned to the master controller. This address may change if the bus is re-initialized.

/sys/bus/i3c/devices/i3c-<bus-id>/hdrcap

Defined on file sysfs-bus-i3c

Expose the HDR (High Data Rate) capabilities of a device. Returns a list of supported HDR mode, each element is separated by space. Modes can be “hdr-ddr”, “hdr-tsp” and “hdr-tsl”. See the I3C specification for more details about these HDR modes.

This entry describes the HDRCAP of the master controller driving the bus.

/sys/bus/i3c/devices/i3c-<bus-id>/i2c_scl_frequency

Defined on file sysfs-bus-i3c

The frequency (expressed in Hz) of the SCL signal when operating in I2C mode.

/sys/bus/i3c/devices/i3c-<bus-id>/i3c_scl_frequency

Defined on file sysfs-bus-i3c

The frequency (expressed in Hz) of the SCL signal when operating in I3C SDR mode.

/sys/bus/i3c/devices/i3c-<bus-id>/mode

Defined on file sysfs-bus-i3c

I3C bus mode. Can be “pure”, “mixed-fast” or “mixed-slow”. See the I3C specification for a detailed description of what each of these modes implies.

/sys/bus/i3c/devices/i3c-<bus-id>/pid

Defined on file sysfs-bus-i3c

PID stands for Provisional ID and is used to uniquely identify a device on a bus. This PID contains information about the vendor, the part and an instance ID so that several devices of the same type can be connected on the same bus. See the I3C specification for more details. This entry describes the PID of the master controller driving the bus.

/sys/bus/iio/devices/device[n]/in_illuminance0_calibrate

Defined on file sysfs-bus-iio-light-tsl2772

Causes an internal calibration of the als gain trim value which is later used in calculating illuminance in lux.

/sys/bus/iio/devices/device[n]/in_illuminance_calibrate

Defined on file sysfs-bus-iio-light-tsl2583

This property causes an internal calibration of the als gain trim value which is later used in calculating illuminance in lux.

/sys/bus/iio/devices/device[n]/in_illuminance_input_target

Defined on file sysfs-bus-iio-light-tsl2583

This property is the known externally illuminance (in lux). It is used in the process of calibrating the device accuracy.

/sys/bus/iio/devices/device[n]/in_illuminance_lux_table

Defined on file sysfs-bus-iio-light-tsl2583

This property gets/sets the table of coefficients used in calculating illuminance in lux.

/sys/bus/iio/devices/device[n]/in_proximity0_calibrate

Defined on file sysfs-bus-iio-light-tsl2772

Causes a recalculation and adjustment to the proximity_thresh_rising_value.

/sys/bus/iio/devices/iio:device*/buffer/hwfifo_timeout

Defined on file sysfs-bus-iio

A read/write property to provide capability to delay reporting of samples till a timeout is reached. This allows host processors to sleep, while the sensor is storing samples in its internal fifo. The maximum timeout in seconds can be specified by setting hwfifo_timeout.The current delay can be read by reading hwfifo_timeout. A value of 0 means that there is no timeout.

/sys/bus/iio/devices/iio:deviceX

Defined on file sysfs-bus-iio

Hardware chip or device accessed by one communication port. Corresponds to a grouping of sensor channels. X is the IIO index of the device.

/sys/bus/iio/devices/iio:deviceX/ac_excitation_en

Defined on file sysfs-bus-iio-adc-ad7192

This attribute, if available, is used to enable the AC excitation mode found on some converters. In ac excitation mode, the polarity of the excitation voltage is reversed on alternate cycles, to eliminate DC errors.

/sys/bus/iio/devices/iio:deviceX/battery_low

Defined on file sysfs-bus-iio-meas-spec

Reading returns either ‘1’ or ‘0’. ‘1’ means that the battery level supplied to sensor is below 2.25V. This ABI is available for tsys02d, htu21, ms8607

/sys/bus/iio/devices/iio:deviceX/bridge_switch_en

Defined on file sysfs-bus-iio-adc-ad7192

This attribute, if available, is used to close or open the bridge power down switch found on some converters. In bridge applications, such as strain gauges and load cells, the bridge itself consumes the majority of the current in the system. To minimize the current consumption of the system, the bridge can be disconnected (when it is not being used using the bridge_switch_en attribute.

/sys/bus/iio/devices/iio:deviceX/buffer

Defined on file sysfs-bus-iio

Directory of attributes relating to the buffer for the device.

/sys/bus/iio/devices/iio:deviceX/buffer/data_available

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/bus/iio/devices/iio:deviceX/buffer/data_available

/sys/bus/iio/devices/iio:deviceX/buffer/enable

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/bus/iio/devices/iio:deviceX/buffer/enable

/sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_enabled

Defined on file sysfs-bus-iio

A read-only boolean value that indicates if the hardware fifo is currently enabled or disabled. If the device does not have a hardware fifo this entry is not present. The hardware fifo is enabled when the buffer is enabled if the current hardware fifo watermark level is set and other current device settings allows it (e.g. if a trigger is set that samples data differently that the hardware fifo does then hardware fifo will not enabled).

If the hardware fifo is enabled and the level of the hardware fifo reaches the hardware fifo watermark level the device will flush its hardware fifo to the device buffer. Doing a non blocking read on the device when no samples are present in the device buffer will also force a flush.

When the hardware fifo is enabled there is no need to use a trigger to use buffer mode since the watermark settings guarantees that the hardware fifo is flushed to the device buffer.

/sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark

Defined on file sysfs-bus-iio

Read-only entry that contains a single integer specifying the current watermark level for the hardware fifo. If the device does not have a hardware fifo this entry is not present. The watermark level for the hardware fifo is set by the driver based on the value set by the user in buffer/watermark but taking into account hardware limitations (e.g. most hardware buffers are limited to 32-64 samples, some hardware buffers watermarks are fixed or have minimum levels). A value of 0 means that the hardware watermark is unset.

/sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark_available

Defined on file sysfs-bus-iio

A list of positive integers specifying the available watermark levels for the hardware fifo. This entry is optional and if it is not present it means that all the values between hwfifo_watermark_min and hwfifo_watermark_max are supported.

If the user sets buffer/watermark to a value greater than hwfifo_watermak_min but not equal to any of the values in this list, the driver will chose an appropriate value for the hardware fifo watermark level.

/sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark_max

Defined on file sysfs-bus-iio

A single positive integer specifying the maximum watermark level for the hardware fifo of this device. If the device does not have a hardware fifo this entry is not present.

If the user sets buffer/watermark to a value greater than this one, then the hardware watermark will be capped at this value.

/sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark_min

Defined on file sysfs-bus-iio

A single positive integer specifying the minimum watermark level for the hardware fifo of this device. If the device does not have a hardware fifo this entry is not present.

If the user sets buffer/watermark to a value less than this one, then the hardware watermark will remain unset.

/sys/bus/iio/devices/iio:deviceX/buffer/length

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/bus/iio/devices/iio:deviceX/buffer/length

/sys/bus/iio/devices/iio:deviceX/buffer/length_align_bytes

Defined on file sysfs-bus-iio-dma-buffer

DMA buffers tend to have a alignment requirement for the buffers. If this alignment requirement is not met samples might be dropped from the buffer.

This property reports the alignment requirements in bytes. This means that the buffer size in bytes needs to be a integer multiple of the number reported by this file.

The alignment requirements in number of sample sets will depend on the enabled channels and the bytes per channel. This means that the alignment requirement in samples sets might change depending on which and how many channels are enabled. Whereas the alignment requirement reported in bytes by this property will remain static and does not depend on which channels are enabled.

/sys/bus/iio/devices/iio:deviceX/buffer/watermark

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/bus/iio/devices/iio:deviceX/buffer/watermark

/sys/bus/iio/devices/iio:deviceX/bufferY

Defined on file sysfs-bus-iio

Directory containing interfaces for elements that will be captured for a single triggered sample set in the buffer.

Since kernel 5.11 the scan_elements attributes are merged into the bufferY directory, to be configurable per buffer.

/sys/bus/iio/devices/iio:deviceX/bufferY/data_available

Defined on file sysfs-bus-iio

A read-only value indicating the bytes of data available in the buffer. In the case of an output buffer, this indicates the amount of empty space available to write data to. In the case of an input buffer, this indicates the amount of data available for reading.

/sys/bus/iio/devices/iio:deviceX/bufferY/enable

Defined on file sysfs-bus-iio

Actually start the buffer capture up. Will start trigger if first device and appropriate.

/sys/bus/iio/devices/iio:deviceX/bufferY/length

Defined on file sysfs-bus-iio

Number of scans contained by the buffer.

/sys/bus/iio/devices/iio:deviceX/bufferY/watermark

Defined on file sysfs-bus-iio

A single positive integer specifying the maximum number of scan elements to wait for.

Poll will block until the watermark is reached.

Blocking read will wait until the minimum between the requested read amount or the low water mark is available.

Non-blocking read will retrieve the available samples from the buffer even if there are less samples then watermark level. This allows the application to block on poll with a timeout and read the available samples after the timeout expires and thus have a maximum delay guarantee.

/sys/bus/iio/devices/iio:deviceX/calibrate

Defined on file sysfs-bus-iio-cros-ec

Writing ‘1’ will perform a FOC (Fast Online Calibration). The corresponding calibration offsets can be read from *_calibbias entries.

/sys/bus/iio/devices/iio:deviceX/calibration_auto_enable

Defined on file sysfs-bus-iio-scd30

Contaminants build-up in the measurement chamber or optical elements deterioration leads to sensor drift.

One can compensate for sensor drift by using automatic self calibration procedure (asc).

Writing 1 or 0 to this attribute will respectively activate or deactivate asc.

Upon reading current asc status is returned.

/sys/bus/iio/devices/iio:deviceX/calibration_forced_value

Defined on file sysfs-bus-iio-scd30

Contaminants build-up in the measurement chamber or optical elements deterioration leads to sensor drift.

One can compensate for sensor drift by using forced recalibration (frc). This is useful in case there’s known co2 reference available nearby the sensor.

Picking value from the range [400 1 2000] and writing it to the sensor will set frc.

Upon reading current frc value is returned. Note that after power cycling default value (i.e 400) is returned even though internally sensor had recalibrated itself.

/sys/bus/iio/devices/iio:deviceX/cleaning_period

Defined on file sysfs-bus-iio-sps30

Sensor is capable of triggering self cleaning periodically. Period can be changed by writing a new value here. Upon reading the current one is returned. Units are seconds.

Writing 0 disables periodical self cleaning entirely.

/sys/bus/iio/devices/iio:deviceX/cleaning_period_available

Defined on file sysfs-bus-iio-sps30

The range of available values in seconds represented as the minimum value, the step and the maximum value, all enclosed in square brackets.

/sys/bus/iio/devices/iio:deviceX/conversion_mode

Defined on file sysfs-bus-iio-vf610

Specifies the hardware conversion mode used. The three available modes are “normal”, “high-speed” and “low-power”, where the last is the default mode.

/sys/bus/iio/devices/iio:deviceX/current_timestamp_clock

Defined on file sysfs-bus-iio

String identifying current posix clock used to timestamp buffered samples and events for device X.

/sys/bus/iio/devices/iio:deviceX/events

Defined on file sysfs-bus-iio

Configuration of which hardware generated events are passed up to user-space.

/sys/bus/iio/devices/iio:deviceX/events/in_illuminance_period_available

Defined on file sysfs-bus-iio

List of valid periods (in seconds) for which the light intensity must be above the threshold level before interrupt is asserted.

/sys/bus/iio/devices/iio:deviceX/events/in_voltageY_thresh_falling_value

Defined on file sysfs-bus-iio-adc-hi8435

Channel Y low voltage threshold. If sensor input voltage goes lower then this value then the threshold falling event is pushed. Depending on in_voltageY_sensing_mode the low voltage threshold is separately set for “GND-Open” and “Supply-Open” modes. Channels 0..31 have common low threshold values, but could have different sensing_modes.

The low voltage threshold range is between 2..21V. Hysteresis between low and high thresholds can not be lower then 2 and can not be odd.

If falling threshold results hysteresis to odd value then rising threshold is automatically subtracted by one.

/sys/bus/iio/devices/iio:deviceX/events/in_voltageY_thresh_rising_value

Defined on file sysfs-bus-iio-adc-hi8435

Channel Y high voltage threshold. If sensor input voltage goes higher then this value then the threshold rising event is pushed. Depending on in_voltageY_sensing_mode the high voltage threshold is separately set for “GND-Open” and “Supply-Open” modes.

Channels 0..31 have common high threshold values, but could have different sensing_modes.

The high voltage threshold range is between 3..22V. Hysteresis between low and high thresholds can not be lower then 2 and can not be odd.

If rising threshold results hysteresis to odd value then falling threshold is automatically appended by one.

/sys/bus/iio/devices/iio:deviceX/fault_oc

Defined on file sysfs-bus-iio-temperature-max31856

Open-circuit fault. The detection of open-circuit faults, such as those caused by broken thermocouple wires. Reading returns either ‘1’ or ‘0’.

‘1’	An open circuit such as broken thermocouple wires has been detected.
‘0’	No open circuit or broken thermocouple wires are detected

/sys/bus/iio/devices/iio:deviceX/fault_ovuv

Defined on file sysfs-bus-iio-temperature-max31856

Overvoltage or Undervoltage Input Fault. The internal circuitry is protected from excessive voltages applied to the thermocouple cables by integrated MOSFETs at the T+ and T- inputs, and the BIAS output. These MOSFETs turn off when the input voltage is negative or greater than VDD.

Reading returns either ‘1’ or ‘0’.

‘1’	The input voltage is negative or greater than VDD.
‘0’	The input voltage is positive and less than VDD (normal state).

/sys/bus/iio/devices/iio:deviceX/heater_enable

Defined on file sysfs-bus-iio

‘1’ (enable) or ‘0’ (disable) specifying the enable of heater function. Same reading values apply.

This ABI is especially applicable for humidity sensors to heatup the device and get rid of any condensation in some humidity environment

/sys/bus/iio/devices/iio:deviceX/id

Defined on file sysfs-bus-iio-cros-ec

This attribute is exposed by the CrOS EC sensors driver and represents the sensor ID as exposed by the EC. This ID is used by the Android sensor service hardware abstraction layer (sensor HAL) through the Android container on ChromeOS.

/sys/bus/iio/devices/iio:deviceX/in_X_mean_raw

Defined on file sysfs-bus-iio

Averaged raw measurement from channel X. The number of values used for averaging is device specific. The converting rules for normal raw values also applies to the averaged raw values.

/sys/bus/iio/devices/iio:deviceX/in_accel_calibbias_available

/sys/bus/iio/devices/iio:deviceX/in_anglvel_calibbias_available

Defined on file sysfs-bus-iio-icm42600

Range of available values for hardware offset. Values in SI units (m/s^2 for accelerometer and rad/s for gyroscope).

/sys/bus/iio/devices/iio:deviceX/in_accel_offset

/sys/bus/iio/devices/iio:deviceX/in_accel_x_offset

/sys/bus/iio/devices/iio:deviceX/in_accel_y_offset

/sys/bus/iio/devices/iio:deviceX/in_accel_z_offset

/sys/bus/iio/devices/iio:deviceX/in_voltageY_offset

/sys/bus/iio/devices/iio:deviceX/in_voltage_offset

/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_offset

/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_offset

/sys/bus/iio/devices/iio:deviceX/in_voltage_q_offset

/sys/bus/iio/devices/iio:deviceX/in_voltage_i_offset

/sys/bus/iio/devices/iio:deviceX/in_currentY_offset

/sys/bus/iio/devices/iio:deviceX/in_current_offset

/sys/bus/iio/devices/iio:deviceX/in_currentY_i_offset

/sys/bus/iio/devices/iio:deviceX/in_currentY_q_offset

/sys/bus/iio/devices/iio:deviceX/in_current_q_offset

/sys/bus/iio/devices/iio:deviceX/in_current_i_offset

/sys/bus/iio/devices/iio:deviceX/in_tempY_offset

/sys/bus/iio/devices/iio:deviceX/in_temp_offset

/sys/bus/iio/devices/iio:deviceX/in_pressureY_offset

/sys/bus/iio/devices/iio:deviceX/in_pressure_offset

/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_offset

/sys/bus/iio/devices/iio:deviceX/in_magn_offset

/sys/bus/iio/devices/iio:deviceX/in_rot_offset

/sys/bus/iio/devices/iio:deviceX/in_angl_offset

/sys/bus/iio/devices/iio:deviceX/in_capacitanceX_offset

Defined on file sysfs-bus-iio

If known for a device, offset to be added to <type>[Y]_raw prior to scaling by <type>[Y]_scale in order to obtain value in the <type> units as specified in <type>[Y]_raw documentation. Not present if the offset is always 0 or unknown. If Y or axis <x|y|z> is not present, then the offset applies to all in channels of <type>. May be writable if a variable offset can be applied on the device. Note that this is different to calibbias which is for devices (or drivers) that apply offsets to compensate for variation between different instances of the part, typically adjusted by using some hardware supported calibration procedure. Calibbias is applied internally, offset is applied in userspace to the _raw output.

/sys/bus/iio/devices/iio:deviceX/in_accel_scale_available

/sys/…/iio:deviceX/in_anglvel_scale_available

/sys/…/iio:deviceX/in_magn_scale_available

/sys/…/iio:deviceX/in_illuminance_scale_available

/sys/…/iio:deviceX/in_intensity_scale_available

/sys/…/iio:deviceX/in_proximity_scale_available

/sys/…/iio:deviceX/in_voltageX_scale_available

/sys/…/iio:deviceX/in_voltage-voltage_scale_available

/sys/…/iio:deviceX/out_voltageX_scale_available

/sys/…/iio:deviceX/out_altvoltageX_scale_available

/sys/…/iio:deviceX/in_capacitance_scale_available

/sys/…/iio:deviceX/in_pressure_scale_available

/sys/…/iio:deviceX/in_pressureY_scale_available

Defined on file sysfs-bus-iio

If a discrete set of scale values is available, they are listed in this attribute.

/sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias

/sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias

/sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias

/sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias

/sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias

/sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias

Defined on file sysfs-bus-iio-icm42600

Hardware applied calibration offset (assumed to fix production inaccuracies). Values represent a real physical offset expressed in SI units (m/s^2 for accelerometer and rad/s for gyroscope).

/sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias

/sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias

/sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias

/sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias

/sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias

/sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias

/sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibbias

/sys/bus/iio/devices/iio:deviceX/in_proximity0_calibbias

/sys/bus/iio/devices/iio:deviceX/in_pressureY_calibbias

/sys/bus/iio/devices/iio:deviceX/in_pressure_calibbias

Defined on file sysfs-bus-iio

Hardware applied calibration offset (assumed to fix production inaccuracies).

/sys/bus/iio/devices/iio:deviceX/in_accel_x_peak_raw

/sys/bus/iio/devices/iio:deviceX/in_accel_y_peak_raw

/sys/bus/iio/devices/iio:deviceX/in_accel_z_peak_raw

Defined on file sysfs-bus-iio

Highest value since some reset condition. These attributes allow access to this and are otherwise the direct equivalent of the <type>Y[_name]_raw attributes.

/sys/bus/iio/devices/iio:deviceX/in_accel_x_raw

/sys/bus/iio/devices/iio:deviceX/in_accel_y_raw

/sys/bus/iio/devices/iio:deviceX/in_accel_z_raw

Defined on file sysfs-bus-iio

Acceleration in direction x, y or z (may be arbitrarily assigned but should match other such assignments on device). Has all of the equivalent parameters as per voltageY. Units after application of scale and offset are m/s^2.

/sys/bus/iio/devices/iio:deviceX/in_accel_xyz_squared_peak_raw

Defined on file sysfs-bus-iio

A computed peak value based on the sum squared magnitude of the underlying value in the specified directions.

/sys/bus/iio/devices/iio:deviceX/in_activity_calibgender

/sys/bus/iio/devices/iio:deviceX/in_energy_calibgender

/sys/bus/iio/devices/iio:deviceX/in_distance_calibgender

/sys/bus/iio/devices/iio:deviceX/in_velocity_calibgender

Defined on file sysfs-bus-iio

Gender of the user (e.g.: male, female) used by some pedometers to compute the stride length, distance, speed and activity type.

/sys/bus/iio/devices/iio:deviceX/in_activity_calibgender_available

/sys/bus/iio/devices/iio:deviceX/in_energy_calibgender_available

/sys/bus/iio/devices/iio:deviceX/in_distance_calibgender_available

/sys/bus/iio/devices/iio:deviceX/in_velocity_calibgender_available

Defined on file sysfs-bus-iio

Lists all available gender values (e.g.: male, female).

/sys/bus/iio/devices/iio:deviceX/in_activity_calibheight

/sys/bus/iio/devices/iio:deviceX/in_energy_calibheight

/sys/bus/iio/devices/iio:deviceX/in_distance_calibheight

/sys/bus/iio/devices/iio:deviceX/in_velocity_calibheight

Defined on file sysfs-bus-iio

Height of the user (in meters) used by some pedometers to compute the stride length, distance, speed and activity type.

/sys/bus/iio/devices/iio:deviceX/in_allow_async_readout

Defined on file sysfs-bus-iio-ina2xx-adc

By default (value ‘0’), the capture thread checks for the Conversion Ready Flag to being set prior to committing a new value to the sample buffer. This synchronizes the in-chip conversion rate with the in-driver readout rate at the cost of an additional register read.

Writing ‘1’ will remove the polling for the Conversion Ready Flags to save the additional i2c transaction, which will improve the bandwidth available for reading data. However, samples can be occasionally skipped or repeated, depending on the beat between the capture and conversion rates.

/sys/bus/iio/devices/iio:deviceX/in_altvoltageY_compare_interval

Defined on file sysfs-bus-iio-adc-envelope-detector

Number of milliseconds to wait for the comparator in each step of the binary search for the input peak level. Needs to relate to the frequency of the input signal.

/sys/bus/iio/devices/iio:deviceX/in_altvoltageY_invert

Defined on file sysfs-bus-iio-adc-envelope-detector

The DAC is used to find the peak level of an alternating voltage input signal by a binary search using the output of a comparator wired to an interrupt pin. Like so:

                      _
                     | \
input +------>-------|+ \
                     |   \
       .-------.     |    }---.
       |       |     |   /    |
       |    dac|-->--|- /     |
       |       |     |_/      |
       |       |              |
       |       |              |
       |    irq|------<-------'
       |       |
       '-------'

The boolean invert attribute (0/1) should be set when the input signal is centered around the maximum value of the dac instead of zero. The envelope detector will search from below in this case and will also invert the result.

The edge/level of the interrupt is also switched to its opposite value.

/sys/bus/iio/devices/iio:deviceX/in_anglY_label

Defined on file sysfs-bus-iio

Optional symbolic label for channel Y. For Intel hid hinge sensor, the label values are: hinge, keyboard, screen. It means the three channels each correspond respectively to hinge angle, keyboard angle, and screen angle.

/sys/bus/iio/devices/iio:deviceX/in_angl_raw

/sys/bus/iio/devices/iio:deviceX/in_anglY_raw

Defined on file sysfs-bus-iio

Angle of rotation. Units after application of scale and offset are radians.

/sys/bus/iio/devices/iio:deviceX/in_anglvel_x_raw

/sys/bus/iio/devices/iio:deviceX/in_anglvel_y_raw

/sys/bus/iio/devices/iio:deviceX/in_anglvel_z_raw

Defined on file sysfs-bus-iio

Angular velocity about axis x, y or z (may be arbitrarily assigned). Has all the equivalent parameters as per voltageY. Units after application of scale and offset are radians per second.

/sys/bus/iio/devices/iio:deviceX/in_capacitanceY_raw

Defined on file sysfs-bus-iio

Raw capacitance measurement from channel Y. Units after application of scale and offset are nanofarads.

/sys/bus/iio/devices/iio:deviceX/in_concentration_VOC_short_raw

Defined on file sysfs-bus-iio-chemical-vz89x

Get the raw calibration VOC value from the sensor. This value has little application outside of calibration.

/sys/bus/iio/devices/iio:deviceX/in_concentration_raw

/sys/bus/iio/devices/iio:deviceX/in_concentrationX_raw

/sys/bus/iio/devices/iio:deviceX/in_concentration_co2_raw

/sys/bus/iio/devices/iio:deviceX/in_concentrationX_co2_raw

/sys/bus/iio/devices/iio:deviceX/in_concentration_ethanol_raw

/sys/bus/iio/devices/iio:deviceX/in_concentrationX_ethanol_raw

/sys/bus/iio/devices/iio:deviceX/in_concentration_h2_raw

/sys/bus/iio/devices/iio:deviceX/in_concentrationX_h2_raw

/sys/bus/iio/devices/iio:deviceX/in_concentration_o2_raw

/sys/bus/iio/devices/iio:deviceX/in_concentrationX_o2_raw

/sys/bus/iio/devices/iio:deviceX/in_concentration_voc_raw

/sys/bus/iio/devices/iio:deviceX/in_concentrationX_voc_raw

Defined on file sysfs-bus-iio

Raw (unscaled no offset etc.) reading of a substance. Units after application of scale and offset are percents.

/sys/bus/iio/devices/iio:deviceX/in_count0_enable_mode

Defined on file sysfs-bus-iio-timer-stm32

Configure the device counter enable modes, in all case counting direction is set by in_count0_count_direction attribute and the counter is clocked by the internal clock.

always:

Counter is always ON.

gated:

Counting is enabled when connected trigger signal level is high else counting is disabled.

triggered:

Counting is enabled on rising edge of the connected trigger, and remains enabled for the duration of this selected mode.

/sys/bus/iio/devices/iio:deviceX/in_count0_preset

Defined on file sysfs-bus-iio-timer-stm32

Reading returns the current preset value. Writing sets the preset value. When counting up the counter starts from 0 and fires an event when reach preset value. When counting down the counter start from preset value and fire event when reach 0.

/sys/bus/iio/devices/iio:deviceX/in_count0_trigger_mode

Defined on file sysfs-bus-iio-timer-stm32

Configure the device counter trigger mode counting direction is set by in_count0_count_direction attribute and the counter is clocked by the connected trigger rising edges.

/sys/bus/iio/devices/iio:deviceX/in_countY_count_direction

Defined on file sysfs-bus-iio

This interface is deprecated; please use the Counter subsystem.

Raw counter device counters direction for channel Y.

/sys/bus/iio/devices/iio:deviceX/in_countY_raw

Defined on file sysfs-bus-iio

This interface is deprecated; please use the Counter subsystem.

Raw counter device counts from channel Y. For quadrature counters, multiplication by an available [Y]_scale results in the counts of a single quadrature signal phase from channel Y.

/sys/bus/iio/devices/iio:deviceX/in_count_count_direction_available

Defined on file sysfs-bus-iio

This interface is deprecated; please use the Counter subsystem.

A list of possible counting directions which are:

• “up” : counter device is increasing.

• “down”: counter device is decreasing.

/sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available

Defined on file sysfs-bus-iio-timer-stm32

Reading returns the list possible enable modes.

/sys/bus/iio/devices/iio:deviceX/in_count_trigger_mode_available

Defined on file sysfs-bus-iio-timer-stm32

Reading returns the list possible trigger modes.

/sys/bus/iio/devices/iio:deviceX/in_current5_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 IBUS ADC Calculating with scale and offset returns voltage in uA

/sys/bus/iio/devices/iio:deviceX/in_current6_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 IBAT ADC Calculating with scale and offset returns voltage in uA

/sys/bus/iio/devices/iio:deviceX/in_current7_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 CHG_VDDP ADC Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_currentX_raw

/sys/bus/iio/devices/iio:deviceX/in_currentX_i_raw

/sys/bus/iio/devices/iio:deviceX/in_currentX_q_raw

Defined on file sysfs-bus-iio

Raw current measurement from channel X. Units are in milliamps after application of scale and offset. If no offset or scale is present, output should be considered as processed with the unit in milliamps.

Channels with ‘i’ and ‘q’ modifiers always exist in pairs and both channels refer to the same signal. The ‘i’ channel contains the in-phase component of the signal while the ‘q’ channel contains the quadrature component.

/sys/bus/iio/devices/iio:deviceX/in_currentY_raw

/sys/bus/iio/devices/iio:deviceX/in_currentY_supply_raw

Defined on file sysfs-bus-iio

Raw (unscaled no bias removal etc.) current measurement from channel Y. In special cases where the channel does not correspond to externally available input one of the named versions may be used. The number must always be specified and unique to allow association with event codes. Units after application of scale and offset are milliamps.

/sys/bus/iio/devices/iio:deviceX/in_current_shunt_resistor

Defined on file sysfs-bus-iio-adc-max9611

The value of the shunt resistor used to compute current flowing between RS+ and RS- voltage sense inputs. In Ohms.

These attributes describe a single physical component, exposed as two distinct attributes as it is used to calculate two different values: power load and current flowing between RS+ and RS- inputs.

/sys/bus/iio/devices/iio:deviceX/in_electricalconductivity_raw

Defined on file sysfs-bus-iio

Raw (unscaled no offset etc.) electric conductivity reading that can be processed to siemens per meter.

/sys/bus/iio/devices/iio:deviceX/in_energy_calibweight

Defined on file sysfs-bus-iio

Weight of the user (in kg). It is needed by some pedometers to compute the calories burnt by the user.

/sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency

Defined on file sysfs-bus-iio

Center frequency in Hz for a notch filter. Used i.e. for line noise suppression.

/sys/bus/iio/devices/iio:deviceX/in_gravity_x_raw

/sys/bus/iio/devices/iio:deviceX/in_gravity_y_raw

/sys/bus/iio/devices/iio:deviceX/in_gravity_z_raw

Defined on file sysfs-bus-iio

Gravity in direction x, y or z (may be arbitrarily assigned but should match other such assignments on device). Units after application of scale and offset are m/s^2.

/sys/bus/iio/devices/iio:deviceX/in_gyro_matrix

/sys/bus/iio/devices/iio:deviceX/in_accel_matrix

/sys/bus/iio/devices/iio:deviceX/in_magn_matrix

Defined on file sysfs-bus-iio-mpu6050

This is mounting matrix for motion sensors. Mounting matrix is a 3x3 unitary matrix. A typical mounting matrix would look like [0, 1, 0; 1, 0, 0; 0, 0, -1]. Using this information, it would be easy to tell the relative positions among sensors as well as their positions relative to the board that holds these sensors. Identity matrix [1, 0, 0; 0, 1, 0; 0, 0, 1] means sensor chip and device are perfectly aligned with each other. All axes are exactly the same.

/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_input

Defined on file sysfs-bus-iio

Scaled humidity measurement in milli percent.

/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_raw

Defined on file sysfs-bus-iio

Raw humidity measurement of air. Units after application of scale and offset are milli percent.

/sys/bus/iio/devices/iio:deviceX/in_illuminance0_zone

Defined on file sysfs-bus-iio-light-lm3533-als

Get the current light zone (0..4) as defined by the in_illuminance0_threshY_{falling,rising} thresholds.

/sys/bus/iio/devices/iio:deviceX/in_illuminance_hysteresis_relative

/sys/bus/iio/devices/iio:deviceX/in_intensity_hysteresis_relative

Defined on file sysfs-bus-iio

Specify the percent for light sensor relative to the channel absolute value that a data field should change before an event is generated. Units are a percentage of the prior reading.

/sys/bus/iio/devices/iio:deviceX/in_incli_x_raw

/sys/bus/iio/devices/iio:deviceX/in_incli_y_raw

/sys/bus/iio/devices/iio:deviceX/in_incli_z_raw

Defined on file sysfs-bus-iio

Inclination raw reading about axis x, y or z (may be arbitrarily assigned). Data converted by application of offset and scale to degrees.

/sys/bus/iio/devices/iio:deviceX/in_indexY_raw

Defined on file sysfs-bus-iio

This interface is deprecated; please use the Counter subsystem.

Raw counter device index value from channel Y. This attribute provides an absolute positional reference (e.g. a pulse once per revolution) which may be used to home positional systems as required.

/sys/bus/iio/devices/iio:deviceX/in_intensityY_offset

Defined on file sysfs-bus-iio-health-afe440x

Get and set the offset cancellation DAC setting for these stages. The values are expressed in 5-bit sign-magnitude.

/sys/bus/iio/devices/iio:deviceX/in_intensityY_raw

Defined on file sysfs-bus-iio-health-afe440x

Get measured values from the ADC for these stages. Y is the specific stage number corresponding to datasheet stage names as follows:

1	LED2
2	ALED2/LED3
3	LED1
4	ALED1/LED4

Note that channels 5 and 6 represent LED2-ALED2 and LED1-ALED1 respectively which simply helper channels containing the calculated difference in the value of stage 1 - 2 and 3 - 4. The values are expressed in 24-bit twos complement.

/sys/bus/iio/devices/iio:deviceX/in_intensityY_resistance

/sys/bus/iio/devices/iio:deviceX/in_intensityY_capacitance

Defined on file sysfs-bus-iio-health-afe440x

Get and set the resistance and the capacitance settings for the Transimpedance Amplifier during the associated stage.

/sys/bus/iio/devices/iio:deviceX/in_intensity_hardwaregain_available

Defined on file sysfs-bus-iio

Lists all available hardware applied gain factors. Shared across all channels.

/sys/bus/iio/devices/iio:deviceX/in_intensity_ir_large_raw

Defined on file sysfs-bus-iio-light-si1133

Unit-less infrared intensity. The intensity is measured from 4 dark photodiodes. “large” indicate the surface area capturing infrared.

/sys/bus/iio/devices/iio:deviceX/in_intensity_ir_small_raw

Defined on file sysfs-bus-iio-light-si1133

Unit-less infrared intensity. The intensity is measured from 1 dark photodiode. “small” indicate the surface area capturing infrared.

/sys/bus/iio/devices/iio:deviceX/in_intensity_large_raw

Defined on file sysfs-bus-iio-light-si1133

Unit-less light intensity with more diodes.

/sys/bus/iio/devices/iio:deviceX/in_intensity_x_raw

/sys/bus/iio/devices/iio:deviceX/in_intensity_y_raw

/sys/bus/iio/devices/iio:deviceX/in_intensity_z_raw

Defined on file sysfs-bus-iio

Unscaled light intensity according to CIE 1931/DIN 5033 color space. Units after application of scale are nano nanowatts per square meter.

/sys/bus/iio/devices/iio:deviceX/in_magn_x_oversampling_ratio

/sys/bus/iio/devices/iio:deviceX/in_magn_y_oversampling_ratio

/sys/bus/iio/devices/iio:deviceX/in_magn_z_oversampling_ratio

Defined on file sysfs-bus-iio

Hardware applied number of measurements for acquiring one data point. The HW will do <type>[_name]_oversampling_ratio measurements and return the average value as output data. Each value resulted from <type>[_name]_oversampling_ratio measurements is considered as one sample for <type>[_name]_sampling_frequency.

/sys/bus/iio/devices/iio:deviceX/in_magn_x_raw

/sys/bus/iio/devices/iio:deviceX/in_magn_y_raw

/sys/bus/iio/devices/iio:deviceX/in_magn_z_raw

Defined on file sysfs-bus-iio

Magnetic field along axis x, y or z (may be arbitrarily assigned). Data converted by application of offset then scale to Gauss.

/sys/bus/iio/devices/iio:deviceX/in_massconcentration_pm1_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentrationY_pm1_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentration_pm2p5_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentrationY_pm2p5_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentration_pm4_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentrationY_pm4_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentration_pm10_input

/sys/bus/iio/devices/iio:deviceX/in_massconcentrationY_pm10_input

Defined on file sysfs-bus-iio

Mass concentration reading of particulate matter in ug / m3. pmX consists of particles with aerodynamic diameter less or equal to X micrometers.

/sys/bus/iio/devices/iio:deviceX/in_ph_raw

Defined on file sysfs-bus-iio

Raw (unscaled no offset etc.) pH reading of a substance as a negative base-10 logarithm of hydrodium ions in a litre of water.

/sys/bus/iio/devices/iio:deviceX/in_phaseY_raw

Defined on file sysfs-bus-iio

Raw (unscaled) phase difference reading from channel Y that can be processed to radians.

/sys/bus/iio/devices/iio:deviceX/in_positionrelative_x_raw

/sys/bus/iio/devices/iio:deviceX/in_positionrelative_y_raw

Defined on file sysfs-bus-iio

Relative position in direction x or y on a pad (may be arbitrarily assigned but should match other such assignments on device). Units after application of scale and offset are milli percents from the pad’s size in both directions. Should be calibrated by the consumer.

/sys/bus/iio/devices/iio:deviceX/in_powerY_raw

Defined on file sysfs-bus-iio

Raw (unscaled no bias removal etc.) power measurement from channel Y. The number must always be specified and unique to allow association with event codes. Units after application of scale and offset are milliwatts.

/sys/bus/iio/devices/iio:deviceX/in_power_shunt_resistor

Defined on file sysfs-bus-iio-adc-max9611

The value of the shunt resistor used to compute power drain on common input voltage pin (RS+). In Ohms.

/sys/bus/iio/devices/iio:deviceX/in_pressureY_input

/sys/bus/iio/devices/iio:deviceX/in_pressure_input

Defined on file sysfs-bus-iio

Scaled pressure measurement from channel Y, in kilopascal.

/sys/bus/iio/devices/iio:deviceX/in_pressureY_raw

/sys/bus/iio/devices/iio:deviceX/in_pressure_raw

Defined on file sysfs-bus-iio

Raw pressure measurement from channel Y. Units after application of scale and offset are kilopascal.

/sys/bus/iio/devices/iio:deviceX/in_proximity0_agc_gain

/sys/bus/iio/devices/iio:deviceX/in_proximity0_agc_gain_bias

Defined on file sysfs-bus-iio-isl29501

This sensor has an automatic gain control (agc) loop which sets the analog signal levels at an optimum level by controlling programmable gain amplifiers. The criteria for optimal gain is determined by the sensor.

Return the actual gain value as an integer in [0; 65536] range when read from.

The agc gain read when measuring crosstalk shall be written into in_proximity0_agc_gain_bias.

/sys/bus/iio/devices/iio:deviceX/in_proximity0_calib_phase_temp_a

/sys/bus/iio/devices/iio:deviceX/in_proximity0_calib_phase_temp_b

/sys/bus/iio/devices/iio:deviceX/in_proximity0_calib_phase_light_a

/sys/bus/iio/devices/iio:deviceX/in_proximity0_calib_phase_light_b

Defined on file sysfs-bus-iio-isl29501

The sensor is able to perform correction of distance measurements due to changing temperature and ambient light conditions. It can be programmed to correct for a second order error polynomial.

Phase data has to be collected when temperature and ambient light are modulated independently.

Then a least squares curve fit to a second order polynomial has to be generated from the data. The resultant curves have the form ax^2 + bx + c.

From those two curves, a and b coefficients shall be stored in in_proximity0_calib_phase_temp_a and in_proximity0_calib_phase_temp_b for temperature and in in_proximity0_calib_phase_light_a and in_proximity0_calib_phase_light_b for ambient light.

Those values must be integer in [0; 8355840] range.

Finally, the c constant is set by the sensor internally.

The value stored in sensor is displayed when read from.

/sys/bus/iio/devices/iio:deviceX/in_proximity3_comb_raw

Defined on file sysfs-bus-iio-sx9310

Proximity measurement indicating that some object is near the combined sensor. The combined sensor presents proximity measurements constructed by hardware by combining measurements taken from a given set of physical sensors.

/sys/bus/iio/devices/iio:deviceX/in_proximity_input

Defined on file sysfs-bus-iio-proximity-as3935

Get the current distance in meters of storm (1km steps) 1000-40000 = distance in meters

What /sys/bus/iio/devices/iio:deviceX/noise_level_tripped When 1 the noise level is over the trip level and not reporting valid data

/sys/bus/iio/devices/iio:deviceX/in_proximity_nearlevel

Defined on file sysfs-bus-iio-proximity

Near level for proximity sensors. This is a single integer value that tells user space when an object should be considered close to the device. If the value read from the sensor is above or equal to the value in this file an object should typically be considered near.

/sys/bus/iio/devices/iio:deviceX/in_resistance_raw

/sys/bus/iio/devices/iio:deviceX/in_resistanceX_raw

/sys/bus/iio/devices/iio:deviceX/out_resistance_raw

/sys/bus/iio/devices/iio:deviceX/out_resistanceX_raw

Defined on file sysfs-bus-iio

Raw (unscaled no offset etc.) resistance reading that can be processed into an ohm value.

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_tilt_comp_raw

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_tilt_comp_raw

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_raw

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_raw

Defined on file sysfs-bus-iio

Raw value of rotation from true/magnetic north measured with or without compensation from tilt sensors.

/sys/bus/iio/devices/iio:deviceX/in_rot_quaternion_raw

Defined on file sysfs-bus-iio

Raw value of quaternion components using a format x y z w. Here x, y, and z component represents the axis about which a rotation will occur and w component represents the amount of rotation.

/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor

Defined on file sysfs-bus-iio-ina2xx-adc

The value of the shunt resistor may be known only at runtime fom an eeprom content read by a client application. This attribute allows to set its value in ohms.

/sys/bus/iio/devices/iio:deviceX/in_temp8_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 IC junction temperature Calculating with scale and offset returns temperature in degree

/sys/bus/iio/devices/iio:deviceX/in_tempX_input

Defined on file sysfs-bus-iio

Scaled temperature measurement in milli degrees Celsius.

/sys/bus/iio/devices/iio:deviceX/in_temp_calibemissivity

/sys/bus/iio/devices/iio:deviceX/in_tempX_calibemissivity

/sys/bus/iio/devices/iio:deviceX/in_temp_object_calibemissivity

/sys/bus/iio/devices/iio:deviceX/in_tempX_object_calibemissivity

Defined on file sysfs-bus-iio

The emissivity ratio of the surface in the field of view of the contactless temperature sensor. Emissivity varies from 0 to 1, with 1 being the emissivity of a black body.

/sys/bus/iio/devices/iio:deviceX/in_temp_object_calibambient

/sys/bus/iio/devices/iio:deviceX/in_tempX_object_calibambient

Defined on file sysfs-bus-iio

Calibrated ambient temperature for object temperature calculation in milli degrees Celsius.

/sys/bus/iio/devices/iio:deviceX/in_temp_raw

/sys/bus/iio/devices/iio:deviceX/in_tempX_raw

/sys/bus/iio/devices/iio:deviceX/in_temp_x_raw

/sys/bus/iio/devices/iio:deviceX/in_temp_y_raw

/sys/bus/iio/devices/iio:deviceX/in_temp_ambient_raw

/sys/bus/iio/devices/iio:deviceX/in_temp_object_raw

Defined on file sysfs-bus-iio

Raw (unscaled no bias removal etc.) temperature measurement. If an axis is specified it generally means that the temperature sensor is associated with one part of a compound device (e.g. a gyroscope axis). The ambient and object modifiers distinguish between ambient (reference) and distant temperature for contact- less measurements. Units after application of scale and offset are milli degrees Celsius.

/sys/bus/iio/devices/iio:deviceX/in_temp_thermocouple_type

Defined on file sysfs-bus-iio

One of the following thermocouple types: B, E, J, K, N, R, S, T.

/sys/bus/iio/devices/iio:deviceX/in_voltage0_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 USBID ADC which connected to connector ID pin. Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltage10_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 TS ADC Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltage1_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 VBUS ADC with lower accuracy(+-75mA) higher measure range(1~22mV) Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltage2-voltage2_shorted_raw

Defined on file sysfs-bus-iio-adc-ad7192

Measure voltage from AIN2 pin connected to AIN(+) and AIN(-) shorted.

/sys/bus/iio/devices/iio:deviceX/in_voltage2_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 VBUS ADC with higher accuracy(+-30mA) lower measure range(1~9.76V) Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltage3_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 VSYS ADC Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltage4_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 VBAT ADC Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltage9_raw

Defined on file sysfs-bus-iio-adc-mt6360

Indicated MT6360 VREF_TS ADC Calculating with scale and offset returns voltage in uV

/sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_raw

Defined on file sysfs-bus-iio

Raw (unscaled) differential voltage measurement equivalent to channel Y - channel Z where these channel numbers apply to the physically equivalent inputs when non differential readings are separately available. In differential only parts, then all that is required is a consistent labeling. Units after application of scale and offset are millivolts.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale

/sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_calibscale

/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_calibscale

/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_calibscale

/sys/bus/iio/devices/iio:deviceX/in_voltage_i_calibscale

/sys/bus/iio/devices/iio:deviceX/in_voltage_q_calibscale

/sys/bus/iio/devices/iio:deviceX/in_voltage_calibscale

/sys/bus/iio/devices/iio:deviceX/in_accel_x_calibscale

/sys/bus/iio/devices/iio:deviceX/in_accel_y_calibscale

/sys/bus/iio/devices/iio:deviceX/in_accel_z_calibscale

/sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibscale

/sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibscale

/sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibscale

/sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibscale

/sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale

/sys/bus/iio/devices/iio:deviceX/in_pressureY_calibscale

/sys/bus/iio/devices/iio:deviceX/in_pressure_calibscale

/sys/bus/iio/devices/iio:deviceX/in_illuminance_calibscale

Defined on file sysfs-bus-iio

Hardware applied calibration scale factor (assumed to fix production inaccuracies). If shared across all channels, <type>_calibscale is used.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_enable

Defined on file sysfs-bus-iio-dac-ad5766

Dither enable. Write 1 to enable dither or 0 to disable it.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_invert

Defined on file sysfs-bus-iio-dac-ad5766

Inverts the dither applied to the selected DAC channel. Dither is not inverted by default. Write “1” to invert dither.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_scale

Defined on file sysfs-bus-iio-dac-ad5766

Scales the dither before it is applied to the selected channel.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_scale_available

Defined on file sysfs-bus-iio-dac-ad5766

Returns possible scalings available for the current channel.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_dither_source

Defined on file sysfs-bus-iio-dac-ad5766

Selects dither source applied to the selected channel. Write “0” to select N0 source, write “1” to select N1 source.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_label

/sys/bus/iio/devices/iio:deviceX/out_voltageY_label

Defined on file sysfs-bus-iio

Optional symbolic label to a device channel. If a label is defined for this channel add that to the channel specific attributes. This is useful for userspace to be able to better identify an individual channel.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_raw

/sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw

/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_raw

/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_raw

Defined on file sysfs-bus-iio

Raw (unscaled no bias removal etc.) voltage measurement from channel Y. In special cases where the channel does not correspond to externally available input one of the named versions may be used. The number must always be specified and unique to allow association with event codes. Units after application of scale and offset are millivolts.

Channels with ‘i’ and ‘q’ modifiers always exist in pairs and both channels refer to the same signal. The ‘i’ channel contains the in-phase component of the signal while the ‘q’ channel contains the quadrature component.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_scale

/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_scale

/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_scale

/sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_scale

/sys/bus/iio/devices/iio:deviceX/in_voltage_scale

/sys/bus/iio/devices/iio:deviceX/in_voltage_i_scale

/sys/bus/iio/devices/iio:deviceX/in_voltage_q_scale

/sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_scale

/sys/bus/iio/devices/iio:deviceX/out_voltageY_scale

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_scale

/sys/bus/iio/devices/iio:deviceX/in_currentY_scale

/sys/bus/iio/devices/iio:deviceX/in_currentY_supply_scale

/sys/bus/iio/devices/iio:deviceX/in_current_scale

/sys/bus/iio/devices/iio:deviceX/in_currentY_i_scale

/sys/bus/iio/devices/iio:deviceX/in_currentY_q_scale

/sys/bus/iio/devices/iio:deviceX/in_current_i_scale

/sys/bus/iio/devices/iio:deviceX/in_current_q_scale

/sys/bus/iio/devices/iio:deviceX/in_accel_scale

/sys/bus/iio/devices/iio:deviceX/in_accel_peak_scale

/sys/bus/iio/devices/iio:deviceX/in_anglvel_scale

/sys/bus/iio/devices/iio:deviceX/in_energy_scale

/sys/bus/iio/devices/iio:deviceX/in_distance_scale

/sys/bus/iio/devices/iio:deviceX/in_magn_scale

/sys/bus/iio/devices/iio:deviceX/in_magn_x_scale

/sys/bus/iio/devices/iio:deviceX/in_magn_y_scale

/sys/bus/iio/devices/iio:deviceX/in_magn_z_scale

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_scale

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_scale

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_tilt_comp_scale

/sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_tilt_comp_scale

/sys/bus/iio/devices/iio:deviceX/in_pressureY_scale

/sys/bus/iio/devices/iio:deviceX/in_pressure_scale

/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_scale

/sys/bus/iio/devices/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_scale

/sys/bus/iio/devices/iio:deviceX/in_illuminance_scale

/sys/bus/iio/devices/iio:deviceX/in_countY_scale

/sys/bus/iio/devices/iio:deviceX/in_angl_scale

/sys/bus/iio/devices/iio:deviceX/in_intensity_x_scale

/sys/bus/iio/devices/iio:deviceX/in_intensity_y_scale

/sys/bus/iio/devices/iio:deviceX/in_intensity_z_scale

Defined on file sysfs-bus-iio

If known for a device, scale to be applied to <type>Y[_name]_raw post addition of <type>[Y][_name]_offset in order to obtain the measured value in <type> units as specified in <type>[Y][_name]_raw documentation. If shared across all in channels then Y and <x|y|z> are not present and the value is called <type>[Y][_name]_scale. The peak modifier means this value is applied to <type>Y[_name]_peak_raw values.

/sys/bus/iio/devices/iio:deviceX/in_voltageY_sensing_mode

Defined on file sysfs-bus-iio-adc-hi8435

Program sensor type for threshold detector inputs. Could be either “GND-Open” or “Supply-Open” mode. Y is a threshold detector input channel. Channels 0..7, 8..15, 16..23 and 24..31 has common sensor types.

/sys/bus/iio/devices/iio:deviceX/in_voltage_spi_clk_freq

Defined on file sysfs-bus-iio-dfsdm-adc-stm32

For audio purpose only.

Used by audio driver to set/get the spi input frequency.

This is mandatory if DFSDM is slave on SPI bus, to provide information on the SPI clock frequency during runtime Notice that the SPI frequency should be a multiple of sample frequency to ensure the precision.

if DFSDM input is SPI master:

Reading SPI clkout frequency, error on writing

If DFSDM input is SPI Slave:

Reading returns value previously set. Writing value before starting conversions.

/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration

Defined on file sysfs-bus-iio-adc-ad7192

Initiates the system calibration procedure. This is done on a single channel at a time. Write ‘1’ to start the calibration.

/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration_mode

Defined on file sysfs-bus-iio-adc-ad7192

Sets up the calibration mode used in the system calibration procedure. Reading returns the current calibration mode. Writing sets the system calibration mode.

/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration_mode_available

Defined on file sysfs-bus-iio-adc-ad7192

Reading returns a list with the possible calibration modes. There are two available options: “zero_scale” - calibrate to zero scale “full_scale” - calibrate to full scale

/sys/bus/iio/devices/iio:deviceX/label

Defined on file sysfs-bus-iio

Optional symbolic label for a device. This is useful for userspace to be able to better identify an individual device.

The contents of the label are free-form, but there are some standardized uses:

For proximity sensors which give the proximity (of a person) to a certain wlan or wwan antenna the following standardized labels are used:

• “proximity-wifi”

• “proximity-lte”

• “proximity-wifi-lte”

• “proximity-wifi-left”

• “proximity-wifi-right”

These are used to indicate to userspace that these proximity sensors may be used to tune transmit power to ensure that Specific Absorption Rate (SAR) limits are honored. The “-left” and “-right” labels are for devices with multiple antennas.

In some laptops/tablets the standardized proximity sensor labels instead indicate proximity to a specific part of the device:

• “proximity-palmrest” indicates proximity to the keyboard’s palmrest

• “proximity-palmrest-left” indicates proximity to the left part of the palmrest

• “proximity-palmrest-right” indicates proximity to the right part of the palmrest

• “proximity-lap” indicates the device is being used on someone’s lap

Note “proximity-lap” is special in that its value may be calculated by firmware from other sensor readings, rather then being a raw sensor reading.

For accelerometers used in 2-in-1s with 360° (yoga-style) hinges, which have an accelerometer in both their base and their display, the following standardized labels are used:

• “accel-base”

• “accel-display”

/sys/bus/iio/devices/iio:deviceX/location

Defined on file sysfs-bus-iio-cros-ec

This attribute returns a string with the physical location where the motion sensor is placed. For example, in a laptop a motion sensor can be located on the base or on the lid. Current valid values are ‘base’ and ‘lid’.

/sys/bus/iio/devices/iio:deviceX/meas_conf

/sys/bus/iio/devices/iio:deviceX/meas_conf_available

Defined on file sysfs-bus-iio-magnetometer-hmc5843

Current configuration and available configurations for the bias current.

normal	Normal measurement configurations (default)
positivebias	Positive bias configuration
negativebias	Negative bias configuration
disabled	Only available on HMC5983. Disables magnetic sensor and enables temperature sensor.

Note:

The effect of this configuration may vary according to the device. For exact documentation check the device’s datasheet.

/sys/bus/iio/devices/iio:deviceX/mount_matrix

/sys/bus/iio/devices/iio:deviceX/in_mount_matrix

/sys/bus/iio/devices/iio:deviceX/out_mount_matrix

/sys/bus/iio/devices/iio:deviceX/in_anglvel_mount_matrix

/sys/bus/iio/devices/iio:deviceX/in_accel_mount_matrix

Defined on file sysfs-bus-iio

Mounting matrix for IIO sensors. This is a rotation matrix which informs userspace about sensor chip’s placement relative to the main hardware it is mounted on.

Main hardware placement is defined according to the local reference frame related to the physical quantity the sensor measures.

Given that the rotation matrix is defined in a board specific way (platform data and / or device-tree), the main hardware reference frame definition is left to the implementor’s choice (see below for a magnetometer example).

Applications should apply this rotation matrix to samples so that when main hardware reference frame is aligned onto local reference frame, then sensor chip reference frame is also perfectly aligned with it.

Matrix is a 3x3 unitary matrix and typically looks like [0, 1, 0; 1, 0, 0; 0, 0, -1]. Identity matrix [1, 0, 0; 0, 1, 0; 0, 0, 1] means sensor chip and main hardware are perfectly aligned with each other.

For example, a mounting matrix for a magnetometer sensor informs userspace about sensor chip’s ORIENTATION relative to the main hardware.

More specifically, main hardware orientation is defined with respect to the LOCAL EARTH GEOMAGNETIC REFERENCE FRAME where :

• Y is in the ground plane and positive towards magnetic North ;

• X is in the ground plane, perpendicular to the North axis and positive towards the East ;

• Z is perpendicular to the ground plane and positive upwards.

An implementor might consider that for a hand-held device, a ‘natural’ orientation would be ‘front facing camera at the top’. The main hardware reference frame could then be described as :

• Y is in the plane of the screen and is positive towards the top of the screen ;

• X is in the plane of the screen, perpendicular to Y axis, and positive towards the right hand side of the screen ;

• Z is perpendicular to the screen plane and positive out of the screen.

Another example for a quadrotor UAV might be :

• Y is in the plane of the propellers and positive towards the front-view camera;

• X is in the plane of the propellers, perpendicular to Y axis, and positive towards the starboard side of the UAV ;

• Z is perpendicular to propellers plane and positive upwards.

/sys/bus/iio/devices/iio:deviceX/name

Defined on file sysfs-bus-iio

Description of the physical chip / device for device X. Typically a part number.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency

Defined on file sysfs-bus-iio

Defined on file sysfs-bus-iio-frequency-adf4371

Output frequency for channel Y in Hz. The number must always be specified and unique if the output corresponds to a single channel.

Stores the PLL frequency in Hz for channel Y. Reading returns the actual frequency in Hz. The ADF4371 has an integrated VCO with fundamendal output frequency ranging from 4000000000 Hz 8000000000 Hz.

out_altvoltage0_frequency:

A divide by 1, 2, 4, 8, 16, 32 or circuit generates frequencies from 62500000 Hz to 8000000000 Hz.

out_altvoltage1_frequency:

This channel duplicates the channel 0 frequency

out_altvoltage2_frequency:

A frequency doubler generates frequencies from 8000000000 Hz to 16000000000 Hz.

out_altvoltage3_frequency:

A frequency quadrupler generates frequencies from 16000000000 Hz to 32000000000 Hz.

Note: writes to one of the channels will affect the frequency of all the other channels, since it involves changing the VCO fundamental output frequency.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_increment

Defined on file sysfs-bus-iio-impedance-analyzer-ad5933

Frequency increment in Hz (step size) between consecutive frequency points along the sweep.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_points

Defined on file sysfs-bus-iio-impedance-analyzer-ad5933

Number of frequency points (steps) in the frequency sweep. This value, in conjunction with the out_altvoltageY_frequency_start and the out_altvoltageY_frequency_increment, determines the frequency sweep range for the sweep operation.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_resolution

Defined on file sysfs-bus-iio-frequency-adf4350

Stores channel Y frequency resolution/channel spacing in Hz. The value given directly influences the MODULUS used by the fractional-N PLL. It is assumed that the algorithm that is used to compute the various dividers, is able to generate proper values for multiples of channel spacing.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_start

Defined on file sysfs-bus-iio-impedance-analyzer-ad5933

Frequency sweep start frequency in Hz.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_name

Defined on file sysfs-bus-iio-frequency-adf4371

Reading returns the datasheet name for channel Y:

out_altvoltage0_name: RF8x
out_altvoltage1_name: RFAUX8x
out_altvoltage2_name: RF16x
out_altvoltage3_name: RF32x

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_phase

Defined on file sysfs-bus-iio

Phase in radians of one frequency/clock output Y (out_altvoltageY) relative to another frequency/clock output (out_altvoltageZ) of the device X. The number must always be specified and unique if the output corresponds to a single channel.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown

Defined on file sysfs-bus-iio-frequency-adf4371

This attribute allows the user to power down the PLL and it’s RFOut buffers. Writing 1 causes the specified channel to power down. Clearing returns to normal operation.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_refin_frequency

Defined on file sysfs-bus-iio-frequency-adf4350

Sets channel Y REFin frequency in Hz. In some clock chained applications, the reference frequency used by the PLL may change during runtime. This attribute allows the user to adjust the reference frequency accordingly. The value written has no effect until out_altvoltageY_frequency is updated. Consider to use out_altvoltageY_powerdown to power down the PLL and its RFOut buffers during REFin changes.

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_settling_cycles

Defined on file sysfs-bus-iio-impedance-analyzer-ad5933

Number of output excitation cycles (settling time cycles) that are allowed to pass through the unknown impedance, after each frequency increment, and before the ADC is triggered to perform a conversion sequence of the response signal.

/sys/bus/iio/devices/iio:deviceX/out_conversion_mode

Defined on file sysfs-bus-iio-vf610

Specifies the hardware conversion mode used within DAC. The two available modes are “high-power” and “low-power”, where “low-power” mode is the default mode.

/sys/bus/iio/devices/iio:deviceX/out_currentY_currentZ_raw

Defined on file sysfs-bus-iio-light-lm3533-als

Set the output current for channel out_currentY when in zone Z (0..255), where Y in 0..2 and Z in 0..4.

These values correspond to the ALS-mapper target registers for ALS-mapper Y + 1.

/sys/bus/iio/devices/iio:deviceX/out_currentY_raw

Defined on file sysfs-bus-iio-health-afe440x

Defined on file sysfs-bus-iio-light-lm3533-als

Get and set the LED current for the specified LED active during this stage. Y is the specific stage number. Get output current for channel Y (0..255), that is, out_currentY_currentZ_raw, where Z is the current zone.

/sys/bus/iio/devices/iio:deviceX/out_current_heater_raw

/sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available

Defined on file sysfs-bus-iio-humidity

Controls the heater device within the humidity sensor to get rid of excess condensation.

In some devices, this is just a switch in which case 0 = OFF, and 1 = ON.

/sys/bus/iio/devices/iio:deviceX/out_resistance_raw_available

Defined on file sysfs-bus-iio-potentiometer-mcp4531

The range of available values represented as the minimum value, the step and the maximum value, all enclosed in square brackets. Example: [0 1 256]

/sys/bus/iio/devices/iio:deviceX/out_voltageY&Z_raw

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY&Z_raw

Defined on file sysfs-bus-iio

Raw (unscaled, no bias etc.) output voltage for an aggregate of channel Y, channel Z, etc. This interface is available in cases where a single output sets the value for multiple channels simultaneously.

/sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain

/sys/bus/iio/devices/iio:deviceX/in_intensity_hardwaregain

/sys/bus/iio/devices/iio:deviceX/in_intensity_red_hardwaregain

/sys/bus/iio/devices/iio:deviceX/in_intensity_green_hardwaregain

/sys/bus/iio/devices/iio:deviceX/in_intensity_blue_hardwaregain

/sys/bus/iio/devices/iio:deviceX/in_intensity_clear_hardwaregain

Defined on file sysfs-bus-iio

Hardware applied gain factor. If shared across all channels, <type>_hardwaregain is used.

/sys/bus/iio/devices/iio:deviceX/out_voltageY_powerdown

/sys/bus/iio/devices/iio:deviceX/out_voltage_powerdown

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown

/sys/bus/iio/devices/iio:deviceX/out_altvoltage_powerdown

Defined on file sysfs-bus-iio

Writing 1 causes output Y to enter the power down mode specified by the corresponding outY_powerdown_mode. DAC output stage is disconnected from the amplifier. Clearing returns to normal operation. Y may be suppressed if all outputs are controlled together.

/sys/bus/iio/devices/iio:deviceX/out_voltageY_powerdown_mode

/sys/bus/iio/devices/iio:deviceX/out_voltage_powerdown_mode

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown_mode

/sys/bus/iio/devices/iio:deviceX/out_altvoltage_powerdown_mode

Defined on file sysfs-bus-iio

Specifies the output powerdown mode. DAC output stage is disconnected from the amplifier and 1kohm_to_gnd: connected to ground via an 1kOhm resistor, 2.5kohm_to_gnd: connected to ground via a 2.5kOhm resistor, 6kohm_to_gnd: connected to ground via a 6kOhm resistor, 20kohm_to_gnd: connected to ground via a 20kOhm resistor, 90kohm_to_gnd: connected to ground via a 90kOhm resistor, 100kohm_to_gnd: connected to ground via an 100kOhm resistor, 125kohm_to_gnd: connected to ground via an 125kOhm resistor, 500kohm_to_gnd: connected to ground via a 500kOhm resistor, 640kohm_to_gnd: connected to ground via a 640kOhm resistor, three_state: left floating. For a list of available output power down options read outX_powerdown_mode_available. If Y is not present the mode is shared across all outputs.

/sys/bus/iio/devices/iio:deviceX/out_voltageY_raw

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_raw

Defined on file sysfs-bus-iio

Raw (unscaled, no bias etc.) output voltage for channel Y. The number must always be specified and unique if the output corresponds to a single channel. While DAC like devices typically use out_voltage, a continuous frequency generating device, such as a DDS or PLL should use out_altvoltage.

/sys/bus/iio/devices/iio:deviceX/out_voltageY_raw_available

Defined on file sysfs-bus-iio-dac-dpot-dac

The range of available values represented as the minimum value, the step and the maximum value, all enclosed in square brackets. Example: [0 1 256]

/sys/bus/iio/devices/iio:deviceX/oversampling_ratio

Defined on file sysfs-bus-iio

Hardware dependent ADC oversampling. Controls the sampling ratio of the digital filter if available.

/sys/bus/iio/devices/iio:deviceX/oversampling_ratio_available

Defined on file sysfs-bus-iio

Hardware dependent values supported by the oversampling filter.

/sys/bus/iio/devices/iio:deviceX/pll2_feedback_clk_present

/sys/bus/iio/devices/iio:deviceX/pll2_reference_clk_present

/sys/bus/iio/devices/iio:deviceX/pll1_reference_clk_a_present

/sys/bus/iio/devices/iio:deviceX/pll1_reference_clk_b_present

/sys/bus/iio/devices/iio:deviceX/pll1_reference_clk_test_present

/sys/bus/iio/devices/iio:deviceX/vcxo_clk_present

Defined on file sysfs-bus-iio-frequency-ad9523

Reading returns either ‘1’ or ‘0’.

‘1’ means that the clock in question is present.

‘0’ means that the clock is missing.

/sys/bus/iio/devices/iio:deviceX/pllY_locked

Defined on file sysfs-bus-iio-frequency-ad9523

Reading returns either ‘1’ or ‘0’. ‘1’ means that the pllY is locked.

/sys/bus/iio/devices/iio:deviceX/proximity_on_chip_ambient_infrared_suppression

Defined on file sysfs-bus-iio-light-isl29018

From ISL29018 Data Sheet (FN6619.4, Oct 8, 2012) regarding the infrared suppression:

Scheme 0, makes full n (4, 8, 12, 16) bits (unsigned) proximity detection. The range of Scheme 0 proximity count is from 0 to 2^n. Logic 1 of this bit, Scheme 1, makes n-1 (3, 7, 11, 15) bits (2’s complementary) proximity_less_ambient detection. The range of Scheme 1 proximity count is from -2^(n-1) to 2^(n-1). The sign bit is extended for resolutions less than 16. While Scheme 0 has wider dynamic range, Scheme 1 proximity detection 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

/sys/bus/iio/devices/iio:deviceX/sampling_frequency

/sys/bus/iio/devices/iio:deviceX/in_intensity_sampling_frequency

/sys/bus/iio/devices/iio:deviceX/buffer/sampling_frequency

/sys/bus/iio/devices/triggerX/sampling_frequency

Defined on file sysfs-bus-iio

Some devices have internal clocks. This parameter sets the resulting sampling frequency. In many devices this parameter has an effect on input filters etc. rather than simply controlling when the input is sampled. As this affects data ready triggers, hardware buffers and the sysfs direct access interfaces, it may be found in any of the relevant directories. If it affects all of the above then it is to be found in the base device directory.

/sys/bus/iio/devices/iio:deviceX/sampling_frequency_available

/sys/bus/iio/devices/iio:deviceX/in_intensity_sampling_frequency_available

/sys/bus/iio/devices/iio:deviceX/in_proximity_sampling_frequency_available

/sys/…/iio:deviceX/buffer/sampling_frequency_available

/sys/bus/iio/devices/triggerX/sampling_frequency_available

Defined on file sysfs-bus-iio

When the internal sampling clock can only take a specific set of frequencies, we can specify the available values with:

• a small discrete set of values like “0 2 4 6 8”

• a range with minimum, step and maximum frequencies like “[min step max]”

/sys/bus/iio/devices/iio:deviceX/scan_elements

Defined on file sysfs-bus-iio

DESCRIPTION MISSING for /sys/bus/iio/devices/iio:deviceX/scan_elements

/sys/bus/iio/devices/iio:deviceX/sensor_max_range

Defined on file sysfs-bus-iio-distance-srf08

Show or set the maximum range between the sensor and the first object echoed in meters. Default value is 6.020. This setting limits the time the driver is waiting for a echo.

Showing the range of available values is represented as the minimum value, the step and the maximum value, all enclosed in square brackets.

Example:

[0.043 0.043 11.008]

/sys/bus/iio/devices/iio:deviceX/sensor_sensitivity

Defined on file sysfs-bus-iio-proximity

Proximity sensors sometimes have a controllable amplifier on the signal from which time of flight measurements are taken. The appropriate values to take is dependent on both the sensor and it’s operating environment: * as3935 (0-31 range) 18 = indoors (default) 14 = outdoors

/sys/bus/iio/devices/iio:deviceX/start_cleaning

Defined on file sysfs-bus-iio-sps30

Writing 1 starts sensor self cleaning. Internal fan accelerates to its maximum speed and keeps spinning for about 10 seconds in order to blow out accumulated dust.

/sys/bus/iio/devices/iio:deviceX/store_eeprom

Defined on file sysfs-bus-iio

Writing ‘1’ stores the current device configuration into on-chip EEPROM. After power-up or chip reset the device will automatically load the saved configuration.

/sys/bus/iio/devices/iio:deviceX/sync_dividers

Defined on file sysfs-bus-iio-frequency-ad9523

Writing ‘1’ triggers the clock distribution synchronization functionality. All dividers are reset and the channels start with their predefined phase offsets (out_altvoltageY_phase). Writing this file has the effect as driving the external /SYNC pin low.

/sys/bus/iio/devices/iio:deviceX/trigger/current_trigger

Defined on file sysfs-bus-iio

The name of the trigger source being used, as per string given in /sys/class/iio/triggerY/name.

/sys/bus/iio/devices/iio_sysfs_trigger/add_trigger

Defined on file sysfs-bus-iio-trigger-sysfs

This attribute is provided by the iio-trig-sysfs stand-alone driver and it is used to activate the creation of a new trigger. In order to achieve this, one should write a positive integer into the associated file, which will serve as the id of the trigger. If the trigger with the specified id is already present in the system, an invalid argument message will be returned.

/sys/bus/iio/devices/iio_sysfs_trigger/remove_trigger

Defined on file sysfs-bus-iio-trigger-sysfs

This attribute is used to unregister and delete a previously created trigger from the list of available triggers. In order to achieve this, one should write a positive integer into the associated file, representing the id of the trigger that needs to be removed. If the trigger can’t be found, an invalid argument message will be returned to the user.

/sys/bus/iio/devices/triggerX

Defined on file sysfs-bus-iio

An event driven driver of data capture to an in kernel buffer. May be provided by a device driver that also has an IIO device based on hardware generated events (e.g. data ready) or provided by a separate driver for other hardware (e.g. periodic timer, GPIO or high resolution timer).

Contains trigger type specific elements. These do not generalize well and hence are not documented in this file. X is the IIO index of the trigger.

/sys/bus/iio/devices/triggerX/master_mode

Defined on file sysfs-bus-iio-timer-stm32

Reading returns the current master modes. Writing set the master mode

/sys/bus/iio/devices/triggerX/master_mode_available

Defined on file sysfs-bus-iio-timer-stm32

Reading returns the list possible master modes which are:

• “reset”

  The UG bit from the TIMx_EGR register is used as trigger output (TRGO).

• “enable”

  The Counter Enable signal CNT_EN is used as trigger output.

• “update”

  The update event is selected as trigger output. For instance a master timer can then be used as a prescaler for a slave timer.

• “compare_pulse”

  The trigger output send a positive pulse when the CC1IF flag is to be set.

• “OC1REF”

  OC1REF signal is used as trigger output.

• “OC2REF”

  OC2REF signal is used as trigger output.

• “OC3REF”

  OC3REF signal is used as trigger output.

• “OC4REF”

  OC4REF signal is used as trigger output.

Additional modes (on TRGO2 only):

• “OC5REF”

  OC5REF signal is used as trigger output.

• “OC6REF”

  OC6REF signal is used as trigger output.

• “compare_pulse_OC4REF”:

  OC4REF rising or falling edges generate pulses.

• “compare_pulse_OC6REF”:

  OC6REF rising or falling edges generate pulses.

• “compare_pulse_OC4REF_r_or_OC6REF_r”:

  OC4REF or OC6REF rising edges generate pulses.

• “compare_pulse_OC4REF_r_or_OC6REF_f”:

  OC4REF rising or OC6REF falling edges generate pulses.

• “compare_pulse_OC5REF_r_or_OC6REF_r”:

  OC5REF or OC6REF rising edges generate pulses.

• “compare_pulse_OC5REF_r_or_OC6REF_f”:

  OC5REF rising or OC6REF falling edges generate pulses.

+-----------+   +-------------+            +---------+
| Prescaler +-> | Counter     |        +-> | Master  | TRGO(2)
+-----------+   +--+--------+-+        |-> | Control +-->
                   |        |          ||  +---------+
                +--v--------+-+ OCxREF ||  +---------+
                | Chx compare +----------> | Output  | ChX
                +-----------+-+         |  | Control +-->
                      .     |           |  +---------+
                      .     |           |    .
                +-----------v-+ OC6REF  |    .
                | Ch6 compare +---------+>
                +-------------+

Example with: “compare_pulse_OC4REF_r_or_OC6REF_r”:

                X
              X   X
            X .   . X
          X   .   .   X
        X     .   .     X
count X .     .   .     . X
        .     .   .     .
        .     .   .     .
        +---------------+
OC4REF  |     .   .     |
      +-+     .   .     +-+
        .     +---+     .
OC6REF  .     |   |     .
      +-------+   +-------+
        +-+   +-+
TRGO2   | |   | |
      +-+ +---+ +---------+

/sys/bus/iio/devices/triggerX/name

Defined on file sysfs-bus-iio-trigger-sysfs

The name attribute holds a description string for the current trigger. In order to associate the trigger with an IIO device one should write this name string to /sys/bus/iio/devices/iio:deviceY/trigger/current_trigger.

/sys/bus/iio/devices/triggerX/name = “adxl372-devX-peak”

Defined on file sysfs-bus-iio-accel-adxl372

The adxl372 accelerometer kernel module provides an additional trigger, which sets the device in a mode in which it will record only the peak acceleration sensed over the set period of time in the events sysfs.

/sys/bus/iio/devices/triggerX/name = “bmc150_accel-any-motion-devX”

Defined on file sysfs-bus-iio-accel-bmc150

The BMC150 accelerometer kernel module provides an additional trigger, which sets driver in a mode, where data is pushed to the buffer only when there is any motion.

/sys/bus/iio/devices/triggerX/name = “bmg160-any-motion-devX”

Defined on file sysfs-bus-iio-gyro-bmg160

The BMG160 gyro kernel module provides an additional trigger, which sets driver in a mode, where data is pushed to the buffer only when there is any motion.

/sys/bus/iio/devices/triggerX/sampling_frequency

Defined on file sysfs-bus-iio-timer-stm32

Reading returns the current sampling frequency. Writing an value different of 0 set and start sampling. Writing 0 stop sampling.

/sys/bus/iio/devices/triggerX/trigger_now

Defined on file sysfs-bus-iio-trigger-sysfs

This file is provided by the iio-trig-sysfs stand-alone trigger driver. Writing this file with any value triggers an event driven driver, associated with this trigger, to capture data into an in kernel buffer. This approach can be valuable during automated testing or in situations, where other trigger methods are not applicable. For example no RTC or spare GPIOs. X is the IIO index of the trigger.

/sys/bus/iio/devices/triggerX/trigger_polarity

Defined on file sysfs-bus-iio-adc-stm32

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 conversions on external trigger by either:

• “rising-edge”

• “falling-edge”

• “both-edges”.

Reading returns current trigger polarity.

Writing value before enabling conversions sets trigger polarity.

/sys/bus/iio/devices/triggerX/trigger_polarity_available

Defined on file sysfs-bus-iio-adc-stm32

List all available trigger_polarity settings.

/sys/bus/intel_th/devices/<intel_th_id>-<device><id>/active

Defined on file sysfs-bus-intel_th-output-devices

(RW) Writes of 1 or 0 enable or disable trace output to this output device. Reads return current status. Requires that the correstponding output port driver be loaded.

/sys/bus/intel_th/devices/<intel_th_id>-gth/masters/*

Defined on file sysfs-bus-intel_th-devices-gth

(RW) Configure output ports for STP masters. Writing -1 disables a master; any

/sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_drop

Defined on file sysfs-bus-intel_th-devices-gth

(RW) Data retention policy setting: keep (0) or drop (1) incoming data while output port is in reset.

/sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_flush

Defined on file sysfs-bus-intel_th-devices-gth

(RW) Force flush data from byte packing buffer for the output port.

/sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_null

Defined on file sysfs-bus-intel_th-devices-gth

(RW) STP NULL packet generation: enabled (1) or disabled (0).

/sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_port

Defined on file sysfs-bus-intel_th-devices-gth

(RO) Output port type:

0	not present,
1	MSU (Memory Storage Unit)
2	CTP (Common Trace Port)
4	PTI (MIPI PTI).

/sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_reset

Defined on file sysfs-bus-intel_th-devices-gth

(RO) Output port is in reset (1).

/sys/bus/intel_th/devices/<intel_th_id>-gth/outputs/[0-7]_smcfreq

Defined on file sysfs-bus-intel_th-devices-gth

(RW) STP sync packet frequency for the port. Specifies the number of clocks between mainenance packets.

/sys/bus/intel_th/devices/<intel_th_id>-msc<msc-id>/mode

Defined on file sysfs-bus-intel_th-devices-msc

(RW) Configure MSC operating mode:

• “single”, for contiguous buffer mode (high-order alloc);

• “multi”, for multiblock mode;

• “ExI”, for DCI handler mode;

• “debug”, for debug mode;

• any of the currently loaded buffer sinks.

If operating mode changes, existing buffer is deallocated, provided there are no active users and tracing is not enabled, otherwise the write will fail.

/sys/bus/intel_th/devices/<intel_th_id>-msc<msc-id>/nr_pages

Defined on file sysfs-bus-intel_th-devices-msc

(RW) Configure MSC buffer size for “single” or “multi” modes.

In single mode, this is a single number of pages, has to be power of 2. In multiblock mode, this is a comma-separated list of numbers of pages for each window to be allocated. Number of windows is not limited.

Writing to this file deallocates existing buffer (provided there are no active users and tracing is not enabled) and then allocates a new one.

/sys/bus/intel_th/devices/<intel_th_id>-msc<msc-id>/port

Defined on file sysfs-bus-intel_th-output-devices

(RO) Port number, corresponding to this output device on the switch (GTH) or “unassigned” if the corresponding output port driver is not loaded.

/sys/bus/intel_th/devices/<intel_th_id>-msc<msc-id>/stop_on_full

Defined on file sysfs-bus-intel_th-devices-msc

(RW) Configure whether trace stops when the last available window becomes full (1/y/Y) or wraps around and continues until the next window becomes available again (0/n/N).

/sys/bus/intel_th/devices/<intel_th_id>-msc<msc-id>/win_switch

Defined on file sysfs-bus-intel_th-devices-msc

(RW) Trigger window switch for the MSC’s buffer, in multi-window mode. In “multi” mode, accepts writes of “1”, thereby triggering a window switch for the buffer. Returns an error in any other operating mode or attempts to write something other than “1”.

/sys/bus/intel_th/devices/<intel_th_id>-msc<msc-id>/wrap

Defined on file sysfs-bus-intel_th-devices-msc

(RW) Configure MSC buffer wrapping. 1 == wrapping enabled.

/sys/bus/intel_th/devices/<intel_th_id>-pti/clock_divider

Defined on file sysfs-bus-intel_th-devices-pti

(RW) Configure PTI port clock divider:

• 0: Intel TH clock rate,

• 1: 1/2 Intel TH clock rate,

• 2: 1/4 Intel TH clock rate,

• 3: 1/8 Intel TH clock rate.

/sys/bus/intel_th/devices/<intel_th_id>-pti/freerunning_clock

Defined on file sysfs-bus-intel_th-devices-pti

(RW) 0: PTI trace clock acts as a strobe which only toggles when there is trace data to send. 1: PTI trace clock is a free-running clock.

/sys/bus/intel_th/devices/<intel_th_id>-pti/mode

Defined on file sysfs-bus-intel_th-devices-pti

(RW) Configure PTI output width. Currently supported values are 4, 8, 12, 16.

/sys/bus/mcb/devices/mcb:X

Defined on file sysfs-bus-mcb

Hardware chip or device hosting the MEN chameleon bus

/sys/bus/mcb/devices/mcb:X/minor

Defined on file sysfs-bus-mcb

The FPGA’s minor number

/sys/bus/mcb/devices/mcb:X/model

Defined on file sysfs-bus-mcb

The FPGA’s model number

/sys/bus/mcb/devices/mcb:X/name

Defined on file sysfs-bus-mcb

The FPGA’s name

/sys/bus/mcb/devices/mcb:X/revision

Defined on file sysfs-bus-mcb

The FPGA’s revision number

/sys/bus/mdio_bus/devices/…/statistics/

Defined on file sysfs-bus-mdio

This folder contains statistics about global and per MDIO bus address statistics.

/sys/bus/mdio_bus/devices/…/statistics/errors

Defined on file sysfs-bus-mdio

Total number of transfer errors for this MDIO bus.

/sys/bus/mdio_bus/devices/…/statistics/errors_<addr>

Defined on file sysfs-bus-mdio

Total number of transfer errors for this MDIO bus address.

/sys/bus/mdio_bus/devices/…/statistics/reads

Defined on file sysfs-bus-mdio

Total number of read transactions for this MDIO bus.

/sys/bus/mdio_bus/devices/…/statistics/reads_<addr>

Defined on file sysfs-bus-mdio

Total number of read transactions for this MDIO bus address.

/sys/bus/mdio_bus/devices/…/statistics/transfers

Defined on file sysfs-bus-mdio

Total number of transfers for this MDIO bus.

/sys/bus/mdio_bus/devices/…/statistics/transfers_<addr>

Defined on file sysfs-bus-mdio

Total number of transfers for this MDIO bus address.

/sys/bus/mdio_bus/devices/…/statistics/writes

Defined on file sysfs-bus-mdio

Total number of write transactions for this MDIO bus.

/sys/bus/mdio_bus/devices/…/statistics/writes_<addr>

Defined on file sysfs-bus-mdio

Total number of write transactions for this MDIO bus address.

/sys/bus/media/devices/…/model

Defined on file sysfs-bus-media

Contains the device model name in UTF-8. The device version is is not be appended to the model name.

/sys/bus/mei/devices/…/fixed

Defined on file sysfs-bus-mei

Stores mei client fixed address, if any Format: %d

/sys/bus/mei/devices/…/max_conn

Defined on file sysfs-bus-mei

Stores mei client maximum number of connections Format: %d

/sys/bus/mei/devices/…/max_len

Defined on file sysfs-bus-mei

Stores mei client maximum message length Format: %d

/sys/bus/mei/devices/…/modalias

Defined on file sysfs-bus-mei

Stores the same MODALIAS value emitted by uevent Format: mei:<mei device name>:<device uuid>:<protocol version>

/sys/bus/mei/devices/…/name

Defined on file sysfs-bus-mei

Stores mei client device name Format: string

/sys/bus/mei/devices/…/uuid

Defined on file sysfs-bus-mei

Stores mei client device uuid Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

/sys/bus/mei/devices/…/version

Defined on file sysfs-bus-mei

Stores mei client protocol version Format: %d

/sys/bus/mei/devices/…/vtag

Defined on file sysfs-bus-mei

Stores mei client vtag support status Format: %d

/sys/bus/mmc/devices/…/rev

Defined on file sysfs-bus-mmc

Extended CSD revision number

/sys/bus/most/devices/<dev>/<channel>/

Defined on file sysfs-bus-most

For every channel of the device a directory is created, whose name is dictated by the HDM. This enables an application to collect information about the channel’s capabilities and configure it.

/sys/bus/most/devices/<dev>/<channel>/available_datatypes

Defined on file sysfs-bus-most

Indicates the data types the channel can transport.

/sys/bus/most/devices/<dev>/<channel>/available_directions

Defined on file sysfs-bus-most

Indicates the directions the channel is capable of.

/sys/bus/most/devices/<dev>/<channel>/channel_starving

Defined on file sysfs-bus-most

Indicates whether channel ran out of buffers.

/sys/bus/most/devices/<dev>/<channel>/number_of_packet_buffers

Defined on file sysfs-bus-most

Indicates the number of packet buffers the channel can handle.

/sys/bus/most/devices/<dev>/<channel>/number_of_stream_buffers

Defined on file sysfs-bus-most

Indicates the number of streaming buffers the channel can handle.

/sys/bus/most/devices/<dev>/<channel>/set_buffer_size

Defined on file sysfs-bus-most

This is to read back the configured buffer size of the channel.

/sys/bus/most/devices/<dev>/<channel>/set_datatype

Defined on file sysfs-bus-most

This is to read back the configured data type of the channel. The following strings will be accepted:

'control',
'async',
'sync',
'isoc_avp'

/sys/bus/most/devices/<dev>/<channel>/set_direction

Defined on file sysfs-bus-most

This is to read back the configured direction of the channel. The following strings will be accepted:

'tx',
'rx'

/sys/bus/most/devices/<dev>/<channel>/set_number_of_buffers

Defined on file sysfs-bus-most

This is to read back the configured number of buffers of the channel.

/sys/bus/most/devices/<dev>/<channel>/set_packets_per_xact

Defined on file sysfs-bus-most

This is to read back the configured number of packets per transaction of the channel. This is only applicable when connected via USB.

/sys/bus/most/devices/<dev>/<channel>/set_subbuffer_size

Defined on file sysfs-bus-most

This is to read back the configured subbuffer size of the channel.

/sys/bus/most/devices/<dev>/<channel>/size_of_packet_buffer

Defined on file sysfs-bus-most

Indicates the size of a packet buffer the channel can handle.

/sys/bus/most/devices/<dev>/<channel>/size_of_stream_buffer

Defined on file sysfs-bus-most

Indicates the size of a streaming buffer the channel can handle.

/sys/bus/most/devices/<dev>/dci

Defined on file sysfs-bus-most

If the network interface controller is attached via USB, a dci directory is created that allows applications to read and write the controller’s DCI registers.

/sys/bus/most/devices/<dev>/dci/arb_address

Defined on file sysfs-bus-most

This is used to set an arbitrary DCI register address an application wants to read from or write to.

/sys/bus/most/devices/<dev>/dci/arb_value

Defined on file sysfs-bus-most

This is used to read and write the DCI register whose address is stored in arb_address.

/sys/bus/most/devices/<dev>/dci/mep_eui48_hi

Defined on file sysfs-bus-most

This is used to check and configure the MAC address.

/sys/bus/most/devices/<dev>/dci/mep_eui48_lo

Defined on file sysfs-bus-most

This is used to check and configure the MAC address.

/sys/bus/most/devices/<dev>/dci/mep_eui48_mi

Defined on file sysfs-bus-most

This is used to check and configure the MAC address.

/sys/bus/most/devices/<dev>/dci/mep_filter

Defined on file sysfs-bus-most

This is used to check and configure the MEP filter address.

/sys/bus/most/devices/<dev>/dci/mep_hash0

Defined on file sysfs-bus-most

This is used to check and configure the MEP hash table.

/sys/bus/most/devices/<dev>/dci/mep_hash1

Defined on file sysfs-bus-most

This is used to check and configure the MEP hash table.

/sys/bus/most/devices/<dev>/dci/mep_hash2

Defined on file sysfs-bus-most

This is used to check and configure the MEP hash table.

/sys/bus/most/devices/<dev>/dci/mep_hash3

Defined on file sysfs-bus-most

This is used to check and configure the MEP hash table.

/sys/bus/most/devices/<dev>/dci/ni_state

Defined on file sysfs-bus-most

Indicates the current network interface state.

/sys/bus/most/devices/<dev>/dci/node_address

Defined on file sysfs-bus-most

Indicates the current node address.

/sys/bus/most/devices/<dev>/dci/node_position

Defined on file sysfs-bus-most

Indicates the current node position.

/sys/bus/most/devices/<dev>/dci/packet_bandwidth

Defined on file sysfs-bus-most

Indicates the configured packet bandwidth.

/sys/bus/most/devices/<dev>/dci/sync_ep

Defined on file sysfs-bus-most

Triggers the controller’s synchronization process for a certain endpoint.

/sys/bus/most/devices/<dev>/description

Defined on file sysfs-bus-most

Provides information about the physical location of the device. Hardware attached via USB, for instance, might return <1-1.1:1.0>

/sys/bus/most/devices/<dev>/interface

Defined on file sysfs-bus-most

Indicates the type of peripheral interface the device uses.

/sys/bus/most/drivers/most_core/components

Defined on file sysfs-bus-most

This is used to retrieve a list of registered components.

/sys/bus/most/drivers/most_core/links

Defined on file sysfs-bus-most

This is used to retrieve a list of established links.

/sys/bus/moxtet/devices/moxtet-<name>.<addr>/module_description

Defined on file sysfs-bus-moxtet-devices

(Read) Moxtet module description. Format: string

/sys/bus/moxtet/devices/moxtet-<name>.<addr>/module_id

Defined on file sysfs-bus-moxtet-devices

(Read) Moxtet module ID. Format: %x

/sys/bus/moxtet/devices/moxtet-<name>.<addr>/module_name

Defined on file sysfs-bus-moxtet-devices

(Read) Moxtet module name. Format: string

/sys/bus/nd/devices/ndbusX/nfit/dsm_mask

Defined on file sysfs-bus-nfit

(RO) The bitmask indicates the supported bus specific control functions. See the section named ‘NVDIMM Root Device _DSMs’ in the ACPI specification.

/sys/bus/nd/devices/ndbusX/nfit/firmware_activate_noidle

Defined on file sysfs-bus-nfit

(RW) The Intel platform implementation of firmware activate support exposes an option let the platform force idle devices in the system over the activation event, or trust that the OS will do it. The safe default is to let the platform force idle devices since the kernel is already in a suspend state, and on the chance that a driver does not properly quiesce bus-mastering after a suspend callback the platform will handle it. However, the activation might abort if, for example, platform firmware determines that the activation time exceeds the max PCI-E completion timeout. Since the platform does not know whether the OS is running the activation from a suspend context it aborts, but if the system owner trusts driver suspend callback to be sufficient then ‘firmware_activation_noidle’ can be enabled to bypass the activation abort.

/sys/bus/nd/devices/ndbusX/nfit/hw_error_scrub

Defined on file sysfs-bus-nfit

(RW) Provides a way to toggle the behavior between just adding the address (cache line) where the MCE happened to the poison list and doing a full scrub. The former (selective insertion of the address) is done unconditionally.

This attribute can have the following values written to it:

‘0’: Switch to the default mode where an exception will only insert the address of the memory error into the poison and badblocks lists. ‘1’: Enable a full scrub to happen if an exception for a memory error is received.

/sys/bus/nd/devices/ndbusX/nfit/revision

Defined on file sysfs-bus-nfit

(RO) ACPI NFIT table revision number.

/sys/bus/nd/devices/ndbusX/nfit/scrub

Defined on file sysfs-bus-nfit

(RW) This shows the number of full Address Range Scrubs (ARS) that have been completed since driver load time. Userspace can wait on this using select/poll etc. A ‘+’ at the end indicates an ARS is in progress

Writing a value of 1 triggers an ARS scan.

/sys/bus/nd/devices/nmemX/nfit/device

Defined on file sysfs-bus-nfit

(RO) Device id for the NVDIMM, assigned by the module vendor.

/sys/bus/nd/devices/nmemX/nfit/dsm_mask

Defined on file sysfs-bus-nfit

(RO) The bitmask indicates the supported device specific control functions relative to the NVDIMM command family supported by the device

/sys/bus/nd/devices/nmemX/nfit/family

Defined on file sysfs-bus-nfit

(RO) Displays the NVDIMM family command sets. Values 0, 1, 2 and 3 correspond to NVDIMM_FAMILY_INTEL, NVDIMM_FAMILY_HPE1, NVDIMM_FAMILY_HPE2 and NVDIMM_FAMILY_MSFT respectively.

See the specifications for these command families here: http://pmem.io/documents/NVDIMM_DSM_Interface-V1.6.pdf https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ https://msdn.microsoft.com/library/windows/hardware/mt604741”

/sys/bus/nd/devices/nmemX/nfit/flags

Defined on file sysfs-bus-nfit

(RO) The flags in the NFIT memory device sub-structure indicate the state of the data on the nvdimm relative to its energy source or last “flush to persistence”.

The attribute is a translation of the ‘NVDIMM State Flags’ field in section 5.2.25.3 ‘NVDIMM Region Mapping’ Structure of the ACPI specification 6.2.

The health states are “save_fail”, “restore_fail”, “flush_fail”, “not_armed”, “smart_event”, “map_fail” and “smart_notify”.

/sys/bus/nd/devices/nmemX/nfit/format

/sys/bus/nd/devices/nmemX/nfit/format1

/sys/bus/nd/devices/nmemX/nfit/formats

Defined on file sysfs-bus-nfit

(RO) The interface codes indicate support for persistent memory mapped directly into system physical address space and / or a block aperture access mechanism to the NVDIMM media. The ‘formats’ attribute displays the number of supported interfaces.

This layout is compatible with existing libndctl binaries that only expect one code per-dimm as they will ignore nmemX/nfit/formats and nmemX/nfit/formatN.

/sys/bus/nd/devices/nmemX/nfit/handle

Defined on file sysfs-bus-nfit

(RO) The address (given by the _ADR object) of the device on its parent bus of the NVDIMM device containing the NVDIMM region.

/sys/bus/nd/devices/nmemX/nfit/id

Defined on file sysfs-bus-nfit

(RO) ACPI specification 6.2 section 5.2.25.9, defines an identifier for an NVDIMM, which refelects the id attribute.

/sys/bus/nd/devices/nmemX/nfit/phys_id

Defined on file sysfs-bus-nfit

(RO) Handle (i.e., instance number) for the SMBIOS (system management BIOS) Memory Device structure describing the NVDIMM containing the NVDIMM region.

/sys/bus/nd/devices/nmemX/nfit/rev_id

Defined on file sysfs-bus-nfit

(RO) Revision of the NVDIMM, assigned by the module vendor.

/sys/bus/nd/devices/nmemX/nfit/serial

Defined on file sysfs-bus-nfit

(RO) Serial number of the NVDIMM (non-volatile dual in-line memory module), assigned by the module vendor.

/sys/bus/nd/devices/nmemX/nfit/subsystem_device

Defined on file sysfs-bus-nfit

(RO) Sub-system device id for the NVDIMM non-volatile memory subsystem controller, assigned by the non-volatile memory subsystem controller vendor.

/sys/bus/nd/devices/nmemX/nfit/subsystem_rev_id

Defined on file sysfs-bus-nfit

(RO) Sub-system revision id of the NVDIMM non-volatile memory subsystem controller, assigned by the non-volatile memory subsystem controller vendor.

/sys/bus/nd/devices/nmemX/nfit/subsystem_vendor

Defined on file sysfs-bus-nfit

(RO) Sub-system vendor id of the NVDIMM non-volatile memory subsystem controller.

/sys/bus/nd/devices/nmemX/nfit/vendor

Defined on file sysfs-bus-nfit

(RO) Vendor id of the NVDIMM.

/sys/bus/nd/devices/nmemX/papr/flags

Defined on file sysfs-bus-papr-pmem

(RO) Report flags indicating various states of a papr-pmem NVDIMM device. Each flag maps to a one or more bits set in the dimm-health-bitmap retrieved in response to H_SCM_HEALTH hcall. The details of the bit flags returned in response to this hcall is available at ‘Hypercall Op-codes (hcalls)’ . Below are the flags reported in this sysfs file:

• “not_armed”

  Indicates that NVDIMM contents will not survive a power cycle.

• “flush_fail”

  Indicates that NVDIMM contents couldn’t be flushed during last shut-down event.

• “restore_fail”

  Indicates that NVDIMM contents couldn’t be restored during NVDIMM initialization.

• “encrypted”

  NVDIMM contents are encrypted.

• “smart_notify”

  There is health event for the NVDIMM.

• “scrubbed”

  Indicating that contents of the NVDIMM have been scrubbed.

• “locked”

  Indicating that NVDIMM contents cant be modified until next power cycle.

/sys/bus/nd/devices/nmemX/papr/perf_stats

Defined on file sysfs-bus-papr-pmem

(RO) Report various performance stats related to papr-scm NVDIMM device. Each stat is reported on a new line with each line composed of a stat-identifier followed by it value. Below are currently known dimm performance stats which are reported:

• “CtlResCt” : Controller Reset Count

• “CtlResTm” : Controller Reset Elapsed Time

• “PonSecs ” : Power-on Seconds

• “MemLife ” : Life Remaining

• “CritRscU” : Critical Resource Utilization

• “HostLCnt” : Host Load Count

• “HostSCnt” : Host Store Count

• “HostSDur” : Host Store Duration

• “HostLDur” : Host Load Duration

• “MedRCnt ” : Media Read Count

• “MedWCnt ” : Media Write Count

• “MedRDur ” : Media Read Duration

• “MedWDur ” : Media Write Duration

• “CchRHCnt” : Cache Read Hit Count

• “CchWHCnt” : Cache Write Hit Count

• “FastWCnt” : Fast Write Count

/sys/bus/nd/devices/regionX/nfit/range_index

Defined on file sysfs-bus-nfit

(RO) A unique number provided by the BIOS to identify an address range. Used by NVDIMM Region Mapping Structure to uniquely refer to this structure. Value of 0 is reserved and not used as an index.

/sys/bus/pci/devices/…/acpi_index

Defined on file sysfs-bus-pci

Reading this attribute will provide the firmware given instance (ACPI _DSM instance number) of the PCI device. The attribute will be created only if the firmware has given an instance number to the PCI device. ACPI _DSM instance number will be given priority if the system firmware provides SMBIOS type 41 device type instance also.

Users:

Userspace applications interested in knowing the firmware assigned instance number of the PCI device that can help in understanding the firmware intended order of the PCI device.

/sys/bus/pci/devices/…/d3cold_allowed

Defined on file sysfs-bus-pci

d3cold_allowed is bit to control whether the corresponding PCI device can be put into D3Cold state. If it is cleared, the device will never be put into D3Cold state. If it is set, the device may be put into D3Cold state if other requirements are satisfied too. Reading this attribute will show the current value of d3cold_allowed bit. Writing this attribute will set the value of d3cold_allowed bit.

/sys/bus/pci/devices/…/dep_link

Defined on file sysfs-bus-pci

This symbolic link appears when hardware supports the SR-IOV capability and the Physical Function driver has enabled it, and this device has vendor specific dependencies with others. The symbolic link points to the PCI device sysfs entry of Physical Function this device depends on.

/sys/bus/pci/devices/…/driver_override

Defined on file sysfs-bus-pci

This file allows the driver for a device to be specified which will override standard static and dynamic ID matching. When specified, only a driver with a name matching the value written to driver_override will have an opportunity to bind to the device. The override is specified by writing a string to the driver_override file (echo pci-stub > driver_override) and may be cleared with an empty string (echo > driver_override). This returns the device to standard matching rules binding. Writing to driver_override does not automatically unbind the device from its current driver or make any attempt to automatically load the specified driver. If no driver with a matching name is currently loaded in the kernel, the device will not bind to any driver. This also allows devices to opt-out of driver binding using a driver_override name such as “none”. Only a single driver may be specified in the override, there is no support for parsing delimiters.

/sys/bus/pci/devices/…/index

Defined on file sysfs-bus-pci

Reading this attribute will provide the firmware given instance number of the PCI device. Depending on the platform this can be for example the SMBIOS type 41 device type instance or the user-defined ID (UID) on s390. The attribute will be created only if the firmware has given an instance number to the PCI device and that number is guaranteed to uniquely identify the device in the system.

Users:

Userspace applications interested in knowing the firmware assigned device type instance of the PCI device that can help in understanding the firmware intended order of the PCI device.

/sys/bus/pci/devices/…/label

Defined on file sysfs-bus-pci

Reading this attribute will provide the firmware given name (SMBIOS type 41 string or ACPI _DSM string) of the PCI device. The attribute will be created only if the firmware has given a name to the PCI device. ACPI _DSM string name will be given priority if the system firmware provides SMBIOS type 41 string also.

Users:

Userspace applications interested in knowing the firmware assigned name of the PCI device.

/sys/bus/pci/devices/…/link/clkpm

Defined on file sysfs-bus-pci

If ASPM is supported for an endpoint, these files can be used to disable or enable the individual power management states. Write y/1/on to enable, n/0/off to disable.

/sys/bus/pci/devices/…/msi_bus

Defined on file sysfs-bus-pci

Writing a zero value to this attribute disallows MSI and MSI-X for any future drivers of the device. If the device is a bridge, MSI and MSI-X will be disallowed for future drivers of all child devices under the bridge. Drivers must be reloaded for the new setting to take effect.

/sys/bus/pci/devices/…/msi_irqs/

Defined on file sysfs-bus-pci

The /sys/devices/…/msi_irqs directory contains a variable set of files, with each file being named after a corresponding msi irq vector allocated to that device.

/sys/bus/pci/devices/…/msi_irqs/<N>

Defined on file sysfs-bus-pci

This attribute indicates the mode that the irq vector named by the file is in (msi vs. msix)

/sys/bus/pci/devices/…/numa_node

Defined on file sysfs-bus-pci

This file contains the NUMA node to which the PCI device is attached, or -1 if the node is unknown. The initial value comes from an ACPI _PXM method or a similar firmware source. If that is missing or incorrect, this file can be written to override the node. In that case, please report a firmware bug to the system vendor. Writing to this file taints the kernel with TAINT_FIRMWARE_WORKAROUND, which reduces the supportability of your system.

/sys/bus/pci/devices/…/p2pmem/available

Defined on file sysfs-bus-pci

If the device has any Peer-to-Peer memory registered, this file contains the amount of memory that has not been allocated (in decimal).

/sys/bus/pci/devices/…/p2pmem/published

Defined on file sysfs-bus-pci

If the device has any Peer-to-Peer memory registered, this file contains a ‘1’ if the memory has been published for use outside the driver that owns the device.

/sys/bus/pci/devices/…/p2pmem/size

Defined on file sysfs-bus-pci

If the device has any Peer-to-Peer memory registered, this file contains the total amount of memory that the device provides (in decimal).

/sys/bus/pci/devices/…/pci_bus/…/rescan

Defined on file sysfs-bus-pci

Writing a non-zero value to this attribute will force a rescan of the bus and all child buses, and re-discover devices removed earlier from this part of the device tree.

/sys/bus/pci/devices/…/physfn

Defined on file sysfs-bus-pci

This symbolic link appears when a device is a Virtual Function. The symbolic link points to the PCI device sysfs entry of the Physical Function this device associates with.

/sys/bus/pci/devices/…/power_state

Defined on file sysfs-bus-pci

This file contains the current PCI power state of the device. The value comes from the PCI kernel device state and can be one of: “unknown”, “error”, “D0”, D1”, “D2”, “D3hot”, “D3cold”. The file is read only.

/sys/bus/pci/devices/…/remove

Defined on file sysfs-bus-pci

Writing a non-zero value to this attribute will hot-remove the PCI device and any of its children.

/sys/bus/pci/devices/…/rescan

Defined on file sysfs-bus-pci

Writing a non-zero value to this attribute will force a rescan of the device’s parent bus and all child buses, and re-discover devices removed earlier from this part of the device tree.

/sys/bus/pci/devices/…/reset

Defined on file sysfs-bus-pci

Some devices allow an individual function to be reset without affecting other functions in the same device. For devices that have this support, a file named reset will be present in sysfs. Writing 1 to this file will perform reset.

/sys/bus/pci/devices/…/revision

Defined on file sysfs-bus-pci

This file contains the revision field of the PCI device. The value comes from device config space. The file is read only.

/sys/bus/pci/devices/…/sriov_drivers_autoprobe

Defined on file sysfs-bus-pci

This file is associated with the PF of a device that supports SR-IOV. It determines whether newly-enabled VFs are immediately bound to a driver. It initially contains 1, which means the kernel automatically binds VFs to a compatible driver immediately after they are enabled. If an application writes 0 to the file before enabling VFs, the kernel will not bind VFs to a driver.

A typical use case is to write 0 to this file, then enable VFs, then assign the newly-created VFs to virtual machines. Note that changing this file does not affect already- enabled VFs. In this scenario, the user must first disable the VFs, write 0 to sriov_drivers_autoprobe, then re-enable the VFs.

This is similar to /sys/bus/pci/drivers_autoprobe, but affects only the VFs associated with a specific PF.

/sys/bus/pci/devices/…/sriov_numvfs

Defined on file sysfs-bus-pci

This file appears when a physical PCIe device supports SR-IOV. Userspace applications can read and write to this file to determine and control the enablement or disablement of Virtual Functions (VFs) on the physical function (PF). A read of this file will return the number of VFs that are enabled on this PF. A number written to this file will enable the specified number of VFs. A userspace application would typically read the file and check that the value is zero, and then write the number of VFs that should be enabled on the PF; the value written should be less than or equal to the value in the sriov_totalvfs file. A userspace application wanting to disable the VFs would write a zero to this file. The core ensures that valid values are written to this file, and returns errors when values are not valid. For example, writing a 2 to this file when sriov_numvfs is not 0 and not 2 already will return an error. Writing a 10 when the value of sriov_totalvfs is 8 will return an error.

/sys/bus/pci/devices/…/sriov_totalvfs

Defined on file sysfs-bus-pci

This file appears when a physical PCIe device supports SR-IOV. Userspace applications can read this file to determine the maximum number of Virtual Functions (VFs) a PCIe physical function (PF) can support. Typically, this is the value reported in the PF’s SR-IOV extended capability structure’s TotalVFs element. Drivers have the ability at probe time to reduce the value read from this file via the pci_sriov_set_totalvfs() function.

/sys/bus/pci/devices/…/sriov_vf_msix_count

Defined on file sysfs-bus-pci

This file is associated with a SR-IOV virtual function (VF). It allows configuration of the number of MSI-X vectors for the VF. This allows devices that have a global pool of MSI-X vectors to optimally divide them between VFs based on VF usage.

The values accepted are:

• > 0 - this number will be reported as the Table Size in the

  VF’s MSI-X capability

• < 0 - not valid

• = 0 - will reset to the device default value

The file is writable if the PF is bound to a driver that implements ->sriov_set_msix_vec_count().

/sys/bus/pci/devices/…/sriov_vf_total_msix

Defined on file sysfs-bus-pci

This file is associated with a SR-IOV physical function (PF). It contains the total number of MSI-X vectors available for assignment to all virtual functions (VFs) associated with PF. The value will be zero if the device doesn’t support this functionality. For supported devices, the value will be constant and won’t be changed after MSI-X vectors assignment.

/sys/bus/pci/devices/…/virtfnN

Defined on file sysfs-bus-pci

This symbolic link appears when hardware supports the SR-IOV capability and the Physical Function driver has enabled it. The symbolic link points to the PCI device sysfs entry of the Virtual Function whose index is N (0…MaxVFs-1).

/sys/bus/pci/devices/…/vpd

Defined on file sysfs-bus-pci

A file named vpd in a device directory will be a binary file containing the Vital Product Data for the device. It should follow the VPD format defined in PCI Specification 2.1 or 2.2, but users should consider that some devices may have malformatted data. If the underlying VPD has a writable section then the corresponding section of this file will be writable.

/sys/bus/pci/devices/<dev>/aer_dev_correctable

Defined on file sysfs-bus-pci-devices-aer_stats

List of correctable errors seen and reported by this PCI device using ERR_COR. Note that since multiple errors may be reported using a single ERR_COR message, thus TOTAL_ERR_COR at the end of the file may not match the actual total of all the errors in the file. Sample output:

localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_correctable
Receiver Error 2
Bad TLP 0
Bad DLLP 0
RELAY_NUM Rollover 0
Replay Timer Timeout 0
Advisory Non-Fatal 0
Corrected Internal Error 0
Header Log Overflow 0
TOTAL_ERR_COR 2

/sys/bus/pci/devices/<dev>/aer_dev_fatal

Defined on file sysfs-bus-pci-devices-aer_stats

List of uncorrectable fatal errors seen and reported by this PCI device using ERR_FATAL. Note that since multiple errors may be reported using a single ERR_FATAL message, thus TOTAL_ERR_FATAL at the end of the file may not match the actual total of all the errors in the file. Sample output:

localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_fatal
Undefined 0
Data Link Protocol 0
Surprise Down Error 0
Poisoned TLP 0
Flow Control Protocol 0
Completion Timeout 0
Completer Abort 0
Unexpected Completion 0
Receiver Overflow 0
Malformed TLP 0
ECRC 0
Unsupported Request 0
ACS Violation 0
Uncorrectable Internal Error 0
MC Blocked TLP 0
AtomicOp Egress Blocked 0
TLP Prefix Blocked Error 0
TOTAL_ERR_FATAL 0

/sys/bus/pci/devices/<dev>/aer_dev_nonfatal

Defined on file sysfs-bus-pci-devices-aer_stats

List of uncorrectable nonfatal errors seen and reported by this PCI device using ERR_NONFATAL. Note that since multiple errors may be reported using a single ERR_FATAL message, thus TOTAL_ERR_NONFATAL at the end of the file may not match the actual total of all the errors in the file. Sample output:

localhost /sys/devices/pci0000:00/0000:00:1c.0 # cat aer_dev_nonfatal
Undefined 0
Data Link Protocol 0
Surprise Down Error 0
Poisoned TLP 0
Flow Control Protocol 0
Completion Timeout 0
Completer Abort 0
Unexpected Completion 0
Receiver Overflow 0
Malformed TLP 0
ECRC 0
Unsupported Request 0
ACS Violation 0
Uncorrectable Internal Error 0
MC Blocked TLP 0
AtomicOp Egress Blocked 0
TLP Prefix Blocked Error 0
TOTAL_ERR_NONFATAL 0

PCIe Rootport AER statistics

These attributes show up under only the rootports (or root complex event collectors) that are AER capable. These indicate the number of error messages as “reported to” the rootport. Please note that the rootports also transmit (internally) the ERR_* messages for errors seen by the internal rootport PCI device, so these counters include them and are thus cumulative of all the error messages on the PCI hierarchy originating at that root port.

/sys/bus/pci/devices/<dev>/aer_stats/aer_rootport_total_err_cor

Defined on file sysfs-bus-pci-devices-aer_stats

Total number of ERR_COR messages reported to rootport.

/sys/bus/pci/devices/<dev>/aer_stats/aer_rootport_total_err_fatal

Defined on file sysfs-bus-pci-devices-aer_stats

Total number of ERR_FATAL messages reported to rootport.

/sys/bus/pci/devices/<dev>/aer_stats/aer_rootport_total_err_nonfatal

Defined on file sysfs-bus-pci-devices-aer_stats

Total number of ERR_NONFATAL messages reported to rootport.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/block:cciss!cXdY

Defined on file sysfs-bus-pci-devices-cciss

A symbolic link to /sys/block/cciss!cXdY

/sys/bus/pci/devices/<dev>/ccissX/cXdY/lunid

Defined on file sysfs-bus-pci-devices-cciss

Displays the 8-byte LUN ID used to address logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/model

Defined on file sysfs-bus-pci-devices-cciss

Displays the SCSI INQUIRY page 0 model for logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/raid_level

Defined on file sysfs-bus-pci-devices-cciss

Displays the RAID level of logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/rev

Defined on file sysfs-bus-pci-devices-cciss

Displays the SCSI INQUIRY page 0 revision for logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/unique_id

Defined on file sysfs-bus-pci-devices-cciss

Displays the SCSI INQUIRY page 83 serial number for logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/usage_count

Defined on file sysfs-bus-pci-devices-cciss

Displays the usage count (number of opens) of logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/cXdY/vendor

Defined on file sysfs-bus-pci-devices-cciss

Displays the SCSI INQUIRY page 0 vendor for logical drive Y of controller X.

/sys/bus/pci/devices/<dev>/ccissX/rescan

Defined on file sysfs-bus-pci-devices-cciss

Kicks of a rescan of the controller to discover logical drive topology changes.

/sys/bus/pci/devices/<dev>/ccissX/resettable

Defined on file sysfs-bus-pci-devices-cciss

Value of 1 indicates the controller can honor the reset_devices kernel parameter. Value of 0 indicates reset_devices cannot be honored. This is to allow, for example, kexec tools to be able to warn the user if they designate an unresettable device as a dump device, as kdump requires resetting the device in order to work reliably.

/sys/bus/pci/devices/<dev>/ccissX/transport_mode

Defined on file sysfs-bus-pci-devices-cciss

Value of “simple” indicates that the controller has been placed in “simple mode”. Value of “performant” indicates that the controller has been placed in “performant mode”.

/sys/bus/pci/drivers/…/bind

Defined on file sysfs-bus-pci

Writing a device location to this file will cause the driver to attempt to bind to the device found at this location. This is useful for overriding default bindings. The format for the location is: DDDD:BB:DD.F. That is Domain:Bus:Device.Function and is the same as found in /sys/bus/pci/devices/. For example:

# echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/bind

(Note: kernels before 2.6.28 may require echo -n).

/sys/bus/pci/drivers/…/new_id

Defined on file sysfs-bus-pci

Writing a device ID to this file will attempt to dynamically add a new device ID to a PCI device driver. This may allow the driver to support more hardware than was included in the driver’s static device ID support table at compile time. The format for the device ID is: VVVV DDDD SVVV SDDD CCCC MMMM PPPP. That is Vendor ID, Device ID, Subsystem Vendor ID, Subsystem Device ID, Class, Class Mask, and Private Driver Data. The Vendor ID and Device ID fields are required, the rest are optional. Upon successfully adding an ID, the driver will probe for the device and attempt to bind to it. For example:

# echo "8086 10f5" > /sys/bus/pci/drivers/foo/new_id

/sys/bus/pci/drivers/…/remove_id

Defined on file sysfs-bus-pci

Writing a device ID to this file will remove an ID that was dynamically added via the new_id sysfs entry. The format for the device ID is: VVVV DDDD SVVV SDDD CCCC MMMM. That is Vendor ID, Device ID, Subsystem Vendor ID, Subsystem Device ID, Class, and Class Mask. The Vendor ID and Device ID fields are required, the rest are optional. After successfully removing an ID, the driver will no longer support the device. This is useful to ensure auto probing won’t match the driver to the device. For example:

# echo "8086 10f5" > /sys/bus/pci/drivers/foo/remove_id

/sys/bus/pci/drivers/…/unbind

Defined on file sysfs-bus-pci

Writing a device location to this file will cause the driver to attempt to unbind from the device found at this location. This may be useful when overriding default bindings. The format for the location is: DDDD:BB:DD.F. That is Domain:Bus:Device.Function and is the same as found in /sys/bus/pci/devices/. For example:

# echo 0000:00:19.0 > /sys/bus/pci/drivers/foo/unbind

(Note: kernels before 2.6.28 may require echo -n).

/sys/bus/pci/drivers/altera-cvp/chkcfg

Defined on file sysfs-driver-altera-cvp

Contains either 1 or 0 and controls if configuration error checking in altera-cvp driver is turned on or off.

/sys/bus/pci/drivers/ehci_hcd/…/companion

Defined on file sysfs-bus-pci-drivers-ehci_hcd

PCI-based EHCI USB controllers (i.e., high-speed USB-2.0 controllers) are often implemented along with a set of “companion” full/low-speed USB-1.1 controllers. When a high-speed device is plugged in, the connection is routed to the EHCI controller; when a full- or low-speed device is plugged in, the connection is routed to the companion controller.

Sometimes you want to force a high-speed device to connect at full speed, which can be accomplished by forcing the connection to be routed to the companion controller. That’s what this file does. Writing a port number to the file causes connections on that port to be routed to the companion controller, and writing the negative of a port number returns the port to normal operation.

For example: To force the high-speed device attached to port 4 on bus 2 to run at full speed:

echo 4 >/sys/bus/usb/devices/usb2/../companion

To return the port to high-speed operation:

echo -4 >/sys/bus/usb/devices/usb2/../companion

Reading the file gives the list of ports currently forced to the companion controller.

Note: Some EHCI controllers do not have companions; they may contain an internal “transaction translator” or they may be attached directly to a “rate-matching hub”. This mechanism will not work with such controllers. Also, it cannot be used to force a port on a high-speed hub to connect at full speed.

Note: When this file was first added, it appeared in a different sysfs directory. The location given above is correct for 2.6.35 (and probably several earlier kernel versions as well).

/sys/bus/pci/drivers/janz-cmodio/…/modulbus_number

Defined on file sysfs-bus-pci-drivers-janz-cmodio

Value representing the HEX switch S2 of the janz carrier board CMOD-IO or CAN-PCI2

Read-only: value of the configuration switch (0..15)

/sys/bus/pci/drivers/pciback/allow_interrupt_control

Defined on file sysfs-driver-pciback

List of devices which can have interrupt control flag (INTx, MSI, MSI-X) set by a connected guest. It is meant to be set only when the guest is a stubdomain hosting device model (qemu) and the actual device is assigned to a HVM. It is not safe (similar to permissive attribute) to set for a devices assigned to a PV guest. The device is automatically removed from this list when the connected pcifront terminates.

/sys/bus/pci/drivers/pciback/quirks

Defined on file sysfs-driver-pciback

If the permissive attribute is set, then writing a string in the format of DDDD:BB:DD.F-REG:SIZE:MASK will allow the guest to write and read from the PCI device. That is Domain:Bus: Device.Function-Register:Size:Mask (Domain is optional). For example:

#echo 00:19.0-E0:2:FF > /sys/bus/pci/drivers/pciback/quirks

will allow the guest to read and write to the configuration register 0x0E.

/sys/bus/pci/drivers/xhci_hcd/…/dbc

Defined on file sysfs-bus-pci-drivers-xhci_hcd

xHCI compatible USB host controllers (i.e. super-speed USB3 controllers) are often implemented with the Debug Capability (DbC). It can present a debug device which is fully compliant with the USB framework and provides the equivalent of a very high performance full-duplex serial link for debug purpose.

The DbC debug device shares a root port with xHCI host. When the DbC is enabled, the root port will be assigned to the Debug Capability. Otherwise, it will be assigned to xHCI.

Writing “enable” to this attribute will enable the DbC functionality and the shared root port will be assigned to the DbC device. Writing “disable” to this attribute will disable the DbC functionality and the shared root port will roll back to the xHCI.

Reading this attribute gives the state of the DbC. It can be one of the following states: disabled, enabled, initialized, connected, configured and stalled.

/sys/bus/pci/rescan

Defined on file sysfs-bus-pci

Writing a non-zero value to this attribute will force a rescan of all PCI buses in the system, and re-discover previously removed devices.

/sys/bus/pci/slots/…/module

Defined on file sysfs-bus-pci

This symbolic link points to the PCI hotplug controller driver module that manages the hotplug slot.

/sys/bus/platform/devices/*twl4030-usb/vbus

Defined on file sysfs-platform-twl4030-usb

Read-only status reporting if VBUS (approx 5V) is being supplied by the USB bus.

Possible values: “on”, “off”.

Changes are notified via select/poll.

/sys/bus/platform/devices/…/driver_override

Defined on file sysfs-bus-platform

This file allows the driver for a device to be specified which will override standard OF, ACPI, ID table, and name matching. When specified, only a driver with a name matching the value written to driver_override will have an opportunity to bind to the device. The override is specified by writing a string to the driver_override file (echo vfio-platform > driver_override) and may be cleared with an empty string (echo > driver_override). This returns the device to standard matching rules binding. Writing to driver_override does not automatically unbind the device from its current driver or make any attempt to automatically load the specified driver. If no driver with a matching name is currently loaded in the kernel, the device will not bind to any driver. This also allows devices to opt-out of driver binding using a driver_override name such as “none”. Only a single driver may be specified in the override, there is no support for parsing delimiters.

/sys/bus/platform/devices/…/numa_node

Defined on file sysfs-bus-platform

This file contains the NUMA node to which the platform device is attached. It won’t be visible if the node is unknown. The value comes from an ACPI _PXM method or a similar firmware source. Initial users for this file would be devices like arm smmu which are populated by arm64 acpi_iort.

/sys/bus/platform/devices/../cfam_reset

Defined on file sysfs-bus-fsi

Provides a means of resetting the cfam that is attached to the FSI device.

/sys/bus/platform/devices/../fsi-master/fsi0/break

Defined on file sysfs-bus-fsi

Sends an FSI BREAK command on a master’s communication link to any connnected slaves. A BREAK resets connected device’s logic and preps it to receive further commands from the master.

/sys/bus/platform/devices/../fsi-master/fsi0/rescan

Defined on file sysfs-bus-fsi

Initiates a FSI master scan for all connected slave devices on its links.

/sys/bus/platform/devices/../fsi-master/fsi0/slave@00:00/raw

Defined on file sysfs-bus-fsi

Provides a means of reading/writing a 32 bit value from/to a specified FSI bus address.

/sys/bus/platform/devices/../fsi-master/fsi0/slave@00:00/term

Defined on file sysfs-bus-fsi

Sends an FSI terminate command from the master to its connected slave. A terminate resets the slave’s state machines that control access to the internally connected engines. In addition the slave freezes its internal error register for debugging purposes. This command is also needed to abort any ongoing operation in case of an expired ‘Master Time Out’ timer.

/sys/bus/platform/devices/ACPI000E:00/ac_alarm

Defined on file sysfs-devices-platform-ACPI-TAD

(RW) The AC alarm timer value.

Reads return the current AC alarm timer value in seconds or “disabled”, if the AC alarm is not set to wake up the system.

Write a new AC alarm timer value in seconds or “disabled” to it to set the AC alarm timer or to disable it, respectively.

If the AC alarm timer is set through this attribute and it expires, it will immediately wake up the system from the S3 sleep state (and from S4/S5 too if supported) until its status is explicitly cleared via the ac_status attribute.

/sys/bus/platform/devices/ACPI000E:00/ac_policy

Defined on file sysfs-devices-platform-ACPI-TAD

(RW) The AC alarm expired timer wake policy (see ACPI 6.2, Section 9.18 for details).

Reads return the current expired timer wake delay for the AC alarm timer or “never”, if the policy is to discard AC timer wakeups if the system is on DC power.

Write a new expired timer wake delay for the AC alarm timer in seconds or “never” to it to set the expired timer wake delay for the AC alarm timer or to set its expired wake policy to discard wakeups if the system is on DC power, respectively.

/sys/bus/platform/devices/ACPI000E:00/ac_status

Defined on file sysfs-devices-platform-ACPI-TAD

(RW) The AC alarm status.

Reads return a hexadecimal bitmask representing the AC alarm timer status with the following meaning of bits (see ACPI 6.2, Section 9.18.5):

Bit(0):	The timer has expired if set.
Bit(1):	The timer has woken up the system from a sleep state (S3 or S4/S5 if supported) if set.

The other bits are reserved.

Reads also cause the AC alarm timer status to be reset.

Another way to reset the the status of the AC alarm timer is to write (the number) 0 to this file.

If the status return value indicates that the timer has expired, it will immediately wake up the system from the S3 sleep state (and from S4/S5 too if supported) until its status is explicitly cleared through this attribute.

/sys/bus/platform/devices/ACPI000E:00/caps

Defined on file sysfs-devices-platform-ACPI-TAD

(RO) Hexadecimal bitmask of the TAD attributes are reported by the platform firmware (see ACPI 6.2, section 9.18.2):

BIT(0):	AC wakeup implemented if set
BIT(1):	DC wakeup implemented if set
BIT(2):	Get/set real time features implemented if set
BIT(3):	Real time accuracy in milliseconds if set
BIT(4):	Correct status reported for wakeups from S4/S5 if set
BIT(5):	The AC timer wakes up from S4 if set
BIT(6):	The AC timer wakes up from S5 if set
BIT(7):	The DC timer wakes up from S4 if set
BIT(8):	The DC timer wakes up from S5 if set

The other bits are reserved.

/sys/bus/platform/devices/ACPI000E:00/dc_alarm

Defined on file sysfs-devices-platform-ACPI-TAD

(RW,optional) The DC alarm timer value.

This attribute is only present if the TAD supports a separate DC timer.

It is analogous to the ac_alarm attribute.

/sys/bus/platform/devices/ACPI000E:00/dc_policy

Defined on file sysfs-devices-platform-ACPI-TAD

(RW,optional) The DC alarm expired timer wake policy.

This attribute is only present if the TAD supports a separate DC timer.

It is analogous to the ac_policy attribute.

/sys/bus/platform/devices/ACPI000E:00/dc_status

Defined on file sysfs-devices-platform-ACPI-TAD

(RW,optional) The DC alarm status.

This attribute is only present if the TAD supports a separate DC timer.

It is analogous to the ac_status attribute.

/sys/bus/platform/devices/GOOG000C\:00/boot_on_ac

Defined on file sysfs-platform-wilco-ec

Boot on AC is a policy which makes the device boot from S5 when AC power is connected. This is useful for users who want to run their device headless or with a dock.

Input should be parseable by kstrtou8() to 0 or 1.

/sys/bus/platform/devices/GOOG000C\:00/build_date

Defined on file sysfs-platform-wilco-ec

Display Wilco Embedded Controller firmware build date. Output will a MM/DD/YY string.

/sys/bus/platform/devices/GOOG000C\:00/build_revision

Defined on file sysfs-platform-wilco-ec

Display Wilco Embedded Controller build revision. Output will a version string be similar to the example below: d2592cae0

/sys/bus/platform/devices/GOOG000C\:00/model_number

Defined on file sysfs-platform-wilco-ec

Display Wilco Embedded Controller model number. Output will a version string be similar to the example below: 08B6

/sys/bus/platform/devices/GOOG000C\:00/usb_charge

Defined on file sysfs-platform-wilco-ec

Control the USB PowerShare Policy. USB PowerShare is a policy which affects charging via the special USB PowerShare port (marked with a small lightning bolt or battery icon) when in low power states:

• In S0, the port will always provide power.

• In S0ix, if usb_charge is enabled, then power will be supplied to the port when on AC or if battery is > 50%. Else no power is supplied.

• In S5, if usb_charge is enabled, then power will be supplied to the port when on AC. Else no power is supplied.

Input should be either “0” or “1”.

/sys/bus/platform/devices/GOOG000C\:00/version

Defined on file sysfs-platform-wilco-ec

Display Wilco Embedded Controller firmware version. The format of the string is x.y.z. Where x is major, y is minor and z is the build number. For example: 95.00.06

/sys/bus/platform/devices/INT3407:00/dptf_power/adapter_rating_mw

Defined on file sysfs-platform-dptf

(RO) Adapter rating in milliwatts (the maximum Adapter power). Must be 0 if no AC Adaptor is plugged in.

/sys/bus/platform/devices/INT3407:00/dptf_power/battery_steady_power

Defined on file sysfs-platform-dptf

(RO) The maximum sustained power for battery in milliwatts.

/sys/bus/platform/devices/INT3407:00/dptf_power/charger_type

Defined on file sysfs-platform-dptf

(RO) The charger type - Traditional, Hybrid or NVDC.

/sys/bus/platform/devices/INT3407:00/dptf_power/max_platform_power_mw

Defined on file sysfs-platform-dptf

(RO) Maximum platform power that can be supported by the battery in milliwatts.

/sys/bus/platform/devices/INT3407:00/dptf_power/platform_power_source

Defined on file sysfs-platform-dptf

(RO) Display the platform power source

bits[3:0]	Current power source - 0x00 = DC - 0x01 = AC - 0x02 = USB - 0x03 = Wireless Charger
bits[7:4]	Power source sequence number

/sys/bus/platform/devices/INT3407:00/dptf_power/prochot_confirm

Defined on file sysfs-platform-dptf

(WO) Confirm embedded controller about a prochot notification.

/sys/bus/platform/devices/INT3407:00/dptf_power/rest_of_platform_power_mw

Defined on file sysfs-platform-dptf

(RO) Shows the rest (outside of SoC) of worst-case platform power.

/sys/bus/platform/devices/INT3532:00/dptf_battery/current_discharge_capbility_ma

Defined on file sysfs-platform-dptf

(RO) The battery discharge current capability obtained from battery fuel gauge in milli Amps.

/sys/bus/platform/devices/INT3532:00/dptf_battery/high_freq_impedance_mohm

Defined on file sysfs-platform-dptf

(RO) The high frequency impedance value that can be obtained from battery fuel gauge in milli Ohms.

/sys/bus/platform/devices/INT3532:00/dptf_battery/max_platform_power_mw

Defined on file sysfs-platform-dptf

(RO) The maximum platform power that can be supported by the battery in milli watts.

/sys/bus/platform/devices/INT3532:00/dptf_battery/max_steady_state_power_mw

Defined on file sysfs-platform-dptf

(RO) The maximum sustained power for battery in milli watts.

/sys/bus/platform/devices/INT3532:00/dptf_battery/no_load_voltage_mv

Defined on file sysfs-platform-dptf

(RO) The no-load voltage that can be obtained from battery fuel gauge in milli volts.

/sys/bus/platform/devices/INTC1045:00/pch_fivr_switch_frequency/freq_mhz_high_clock

Defined on file sysfs-platform-dptf

(RW) The PCH FIVR (Fully Integrated Voltage Regulator) switching frequency in MHz, when FIVR clock is 38.4MHz.

/sys/bus/platform/devices/INTC1045:00/pch_fivr_switch_frequency/freq_mhz_low_clock

Defined on file sysfs-platform-dptf

(RW) The PCH FIVR (Fully Integrated Voltage Regulator) switching frequency in MHz, when FIVR clock is 19.2MHz or 24MHz.

/sys/bus/platform/devices/MLNXBF04:00/lifecycle_state

Defined on file sysfs-platform-mellanox-bootctl

The Life-cycle state of the SoC, which could be one of the following values.

Production	Production state and can be updated to secure
GA Secured	Secure chip and not able to change state
GA Non-Secured	Non-Secure chip and not able to change state
RMA	Return Merchandise Authorization

/sys/bus/platform/devices/MLNXBF04:00/post_reset_wdog

Defined on file sysfs-platform-mellanox-bootctl

The watchdog setting in seconds for the next booting. It’s used to reboot the chip and recover it to the old state if the new boot partition fails.

/sys/bus/platform/devices/MLNXBF04:00/reset_action

Defined on file sysfs-platform-mellanox-bootctl

The source of the boot stream for the next reset. It could be one of the following values:

external	boot from external source (USB or PCIe)
emmc	boot from the onchip eMMC
emmc_legacy	boot from the onchip eMMC in legacy (slow) mode

/sys/bus/platform/devices/MLNXBF04:00/second_reset_action

Defined on file sysfs-platform-mellanox-bootctl

Update the source of the boot stream after next reset. It could be one of the following values and will be applied after next reset.

external	boot from external source (USB or PCIe)
emmc	boot from the onchip eMMC
emmc_legacy	boot from the onchip eMMC in legacy (slow) mode
swap_emmc	swap the primary / secondary boot partition
none	cancel the action

/sys/bus/platform/devices/MLNXBF04:00/secure_boot_fuse_state

Defined on file sysfs-platform-mellanox-bootctl

The state of eFuse versions with the following values.

InUse	burnt, valid and currently in use
Used	burnt and valid
Free	not burnt and free to use
Skipped	not burnt but not free (skipped)
Wasted	burnt and invalid
Invalid	not burnt but marked as valid (error state).

/sys/bus/platform/devices/VPC2004:*/camera_power

Defined on file sysfs-platform-ideapad-laptop

Control the power of camera module. 1 means on, 0 means off.

/sys/bus/platform/devices/VPC2004:*/conservation_mode

Defined on file sysfs-platform-ideapad-laptop

Controls whether the conservation mode is enabled or not. This feature limits the maximum battery charge percentage to around 50-60% in order to prolong the lifetime of the battery.

/sys/bus/platform/devices/VPC2004:*/fan_mode

Defined on file sysfs-platform-ideapad-laptop

Change fan mode There are four available modes:

• 0 -> Super Silent Mode

• 1 -> Standard Mode

• 2 -> Dust Cleaning

• 4 -> Efficient Thermal Dissipation Mode

/sys/bus/platform/devices/VPC2004:*/fn_lock

Defined on file sysfs-platform-ideapad-laptop

Control fn-lock mode.

• 1 -> Switched On

• 0 -> Switched Off

For example:

# echo "0" >  \
/sys/bus/pci/devices/0000:00:1f.0/PNP0C09:00/VPC2004:00/fn_lock

/sys/bus/platform/devices/VPC2004:*/touchpad

Defined on file sysfs-platform-ideapad-laptop

Control touchpad mode.

• 1 -> Switched On

• 0 -> Switched Off

/sys/bus/platform/devices/VPC2004:*/usb_charging

Defined on file sysfs-platform-ideapad-laptop

Controls whether the “always on USB charging” feature is enabled or not. This feature enables charging USB devices even if the computer is not turned on.

/sys/bus/platform/devices/[..]/fsi-master-gpio/external_mode

Defined on file sysfs-driver-fsi-master-gpio

Controls access arbitration for GPIO-based FSI master. A value of 0 (the default) sets normal mode, where the driver performs FSI bus transactions, 1 sets external mode, where the FSI bus is driven externally (for example, by a debug device).

/sys/bus/platform/devices/ci_hdrc.0/inputs/a_bus_drop

Defined on file sysfs-platform-chipidea-usb-otg

Can be set and read The a_bus_drop(A-device bus drop) input is 1 when the application running on the A-device wants to power down the bus, and is 0 otherwise, When a_bus_drop is 1, then the a_bus_req shall be 0.

Valid values are “1” and “0”.

Reading: returns 1 if the bus is off(vbus is turned off) by

A-device, otherwise 0.

/sys/bus/platform/devices/ci_hdrc.0/inputs/a_bus_req

Defined on file sysfs-platform-chipidea-usb-otg

Can be set and read. Set a_bus_req(A-device bus request) input to be 1 if the application running on the A-device wants to use the bus, and to be 0 when the application no longer wants to use the bus(or wants to work as peripheral). a_bus_req can also be set to 1 by kernel in response to remote wakeup signaling from the B-device, the A-device should decide to resume the bus.

Valid values are “1” and “0”.

Reading: returns 1 if the application running on the A-device is using the bus as host role, otherwise 0.

/sys/bus/platform/devices/ci_hdrc.0/inputs/a_clr_err

Defined on file sysfs-platform-chipidea-usb-otg

Only can be set. The a_clr_err(A-device Vbus error clear) input is used to clear vbus error, then A-device will power down the bus.

Valid value is “1”

/sys/bus/platform/devices/ci_hdrc.0/inputs/b_bus_req

Defined on file sysfs-platform-chipidea-usb-otg

Can be set and read. The b_bus_req(B-device bus request) input is 1 during the time that the application running on the B-device wants to use the bus as host, and is 0 when the application no longer wants to work as host and decides to switch back to be peripheral.

Valid values are “1” and “0”.

Reading: returns if the application running on the B device is using the bus as host role, otherwise 0.

/sys/bus/platform/devices/ci_hdrc.0/role

Defined on file sysfs-platform-chipidea-usb2

It returns string “gadget” or “host” when read it, it indicates current controller role.

It will do role switch when write “gadget” or “host” to it. Only controller at dual-role configuration supports writing.

/sys/bus/platform/devices/dfl-fme.0/bitstream_id

Defined on file sysfs-platform-dfl-fme

Read-only. It returns Bitstream (static FPGA region) identifier number, which includes the detailed version and other information of this static FPGA region.

/sys/bus/platform/devices/dfl-fme.0/bitstream_metadata

Defined on file sysfs-platform-dfl-fme

Read-only. It returns Bitstream (static FPGA region) meta data, which includes the synthesis date, seed and other information of this static FPGA region.

/sys/bus/platform/devices/dfl-fme.0/cache_size

Defined on file sysfs-platform-dfl-fme

Read-only. It returns cache size of this FPGA device.

/sys/bus/platform/devices/dfl-fme.0/errors/catfatal_errors

Defined on file sysfs-platform-dfl-fme

Read-only. It returns catastrophic and fatal errors detected.

/sys/bus/platform/devices/dfl-fme.0/errors/first_error

Defined on file sysfs-platform-dfl-fme

Read-only. Read this file to get the first error detected by hardware.

/sys/bus/platform/devices/dfl-fme.0/errors/fme_errors

Defined on file sysfs-platform-dfl-fme

Read-Write. Read this file to get errors detected on FME. Write this file to clear errors logged in fme_errors. Write fials with -EINVAL if input parsing fails or input error code doesn’t match.

/sys/bus/platform/devices/dfl-fme.0/errors/inject_errors

Defined on file sysfs-platform-dfl-fme

Read-Write. Read this file to check errors injected. Write this file to inject errors for testing purpose. Write fails with -EINVAL if input parsing fails or input inject error code isn’t supported.

/sys/bus/platform/devices/dfl-fme.0/errors/next_error

Defined on file sysfs-platform-dfl-fme

Read-only. Read this file to get the second error detected by hardware.

/sys/bus/platform/devices/dfl-fme.0/errors/nonfatal_errors

Defined on file sysfs-platform-dfl-fme

Read-only. It returns non-fatal errors detected.

/sys/bus/platform/devices/dfl-fme.0/errors/pcie0_errors

Defined on file sysfs-platform-dfl-fme

Read-Write. Read this file for errors detected on pcie0 link. Write this file to clear errors logged in pcie0_errors. Write fails with -EINVAL if input parsing fails or input error code doesn’t match.

/sys/bus/platform/devices/dfl-fme.0/errors/pcie1_errors

Defined on file sysfs-platform-dfl-fme

Read-Write. Read this file for errors detected on pcie1 link. Write this file to clear errors logged in pcie1_errors. Write fails with -EINVAL if input parsing fails or input error code doesn’t match.

/sys/bus/platform/devices/dfl-fme.0/fabric_version

Defined on file sysfs-platform-dfl-fme

Read-only. It returns fabric version of this FPGA device. Userspace applications need this information to select best data channels per different fabric design.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/name

Defined on file sysfs-platform-dfl-fme

Read-Only. Read this file to get the name of hwmon device, it supports values:

‘dfl_fme_thermal’	thermal hwmon device name
‘dfl_fme_power’	power hwmon device name

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_crit

Defined on file sysfs-platform-dfl-fme

Read-Write. Read this file to get current hardware power threshold2 in uW. If power consumption rises at or above this threshold, hardware starts 90% throttling. Write this file to set current hardware power threshold2 in uW. As hardware only accepts values in Watts, so input value will be round down per Watts (< 1 watts part will be discarded) and clamped within the range from 0 to 127 Watts. Write fails with -EINVAL if input parsing fails.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_crit_alarm

Defined on file sysfs-platform-dfl-fme

Read-only. It returns 1 if power consumption is currently at or above hardware threshold2 (see ‘power1_crit’), otherwise 0.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_fpga_limit

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns power limit for FPGA in uW.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_input

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns current FPGA power consumption in uW.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_ltr

Defined on file sysfs-platform-dfl-fme

Read-only. Read this file to get current Latency Tolerance Reporting (ltr) value. It returns 1 if all Accelerated Function Units (AFUs) can tolerate latency >= 40us for memory access or 0 if any AFU is latency sensitive (< 40us).

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_max

Defined on file sysfs-platform-dfl-fme

Read-Write. Read this file to get current hardware power threshold1 in uW. If power consumption rises at or above this threshold, hardware starts 50% throttling. Write this file to set current hardware power threshold1 in uW. As hardware only accepts values in Watts, so input value will be round down per Watts (< 1 watts part will be discarded) and clamped within the range from 0 to 127 Watts. Write fails with -EINVAL if input parsing fails.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_max_alarm

Defined on file sysfs-platform-dfl-fme

Read-only. It returns 1 if power consumption is currently at or above hardware threshold1 (see ‘power1_max’), otherwise 0.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/power1_xeon_limit

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns power limit for XEON in uW.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_crit

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns hardware threshold2 temperature in millidegrees Celsius. If temperature rises at or above this threshold, hardware starts 100% throttling.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_crit_alarm

Defined on file sysfs-platform-dfl-fme

Read-only. It returns 1 if temperature is currently at or above hardware threshold2 (see ‘temp1_crit’), otherwise 0.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_emergency

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns hardware trip threshold temperature in millidegrees Celsius. If temperature rises at or above this threshold, a fatal event will be triggered to board management controller (BMC) to shutdown FPGA.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_input

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns FPGA device temperature in millidegrees Celsius.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max

Defined on file sysfs-platform-dfl-fme

Read-Only. It returns hardware threshold1 temperature in millidegrees Celsius. If temperature rises at or above this threshold, hardware starts 50% or 90% throttling (see ‘temp1_max_policy’).

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max_alarm

Defined on file sysfs-platform-dfl-fme

Read-only. It returns 1 if temperature is currently at or above hardware threshold1 (see ‘temp1_max’), otherwise 0.

/sys/bus/platform/devices/dfl-fme.0/hwmon/hwmonX/temp1_max_policy

Defined on file sysfs-platform-dfl-fme

Read-Only. Read this file to get the policy of hardware threshold1 (see ‘temp1_max’). It only supports two values (policies):

0	AP2 state (90% throttling)
1	AP1 state (50% throttling)

/sys/bus/platform/devices/dfl-fme.0/ports_num

Defined on file sysfs-platform-dfl-fme

Read-only. One DFL FPGA device may have more than 1 port/Accelerator Function Unit (AFU). It returns the number of ports on the FPGA device when read it.

/sys/bus/platform/devices/dfl-fme.0/socket_id

Defined on file sysfs-platform-dfl-fme

Read-only. It returns socket_id to indicate which socket this FPGA belongs to, only valid for integrated solution. User only needs this information, in case standard numa node can’t provide correct information.

/sys/bus/platform/devices/dfl-port.0/afu_id

Defined on file sysfs-platform-dfl-port

Read-only. User can program different PR bitstreams to FPGA Accelerator Function Unit (AFU) for different functions. It returns uuid which could be used to identify which PR bitstream is programmed in this AFU.

/sys/bus/platform/devices/dfl-port.0/ap1_event

Defined on file sysfs-platform-dfl-port

Read-write. Read this file for AP1 (AFU Power State 1) event. It’s used to indicate transient AP1 state. Write 1 to this file to clear AP1 event.

/sys/bus/platform/devices/dfl-port.0/ap2_event

Defined on file sysfs-platform-dfl-port

Read-write. Read this file for AP2 (AFU Power State 2) event. It’s used to indicate transient AP2 state. Write 1 to this file to clear AP2 event.

/sys/bus/platform/devices/dfl-port.0/errors/errors

Defined on file sysfs-platform-dfl-port

Read-Write. Read this file to get errors detected on port and Accelerated Function Unit (AFU). Write error code to this file to clear errors. Write fails with -EINVAL if input parsing fails or input error code doesn’t match. Write fails with -EBUSY or -ETIMEDOUT if error can’t be cleared as hardware in low power state (-EBUSY) or not respoding (-ETIMEDOUT).

/sys/bus/platform/devices/dfl-port.0/errors/first_error

Defined on file sysfs-platform-dfl-port

Read-only. Read this file to get the first error detected by hardware.

/sys/bus/platform/devices/dfl-port.0/errors/first_malformed_req

Defined on file sysfs-platform-dfl-port

Read-only. Read this file to get the first malformed request captured by hardware.

/sys/bus/platform/devices/dfl-port.0/id

Defined on file sysfs-platform-dfl-port

Read-only. It returns id of this port. One DFL FPGA device may have more than one port. Userspace could use this id to distinguish different ports under same FPGA device.

/sys/bus/platform/devices/dfl-port.0/ltr

Defined on file sysfs-platform-dfl-port

Read-write. Read or set AFU latency tolerance reporting value. Set ltr to 1 if the AFU can tolerate latency >= 40us or set it to 0 if it is latency sensitive.

/sys/bus/platform/devices/dfl-port.0/power_state

Defined on file sysfs-platform-dfl-port

Read-only. It reports the APx (AFU Power) state, different APx means different throttling level. When reading this file, it returns “0” - Normal / “1” - AP1 / “2” - AP2 / “6” - AP6.

/sys/bus/platform/devices/dfl-port.0/userclk_freqcmd

Defined on file sysfs-platform-dfl-port

Write-only. User writes command to this interface to set userclock to AFU.

/sys/bus/platform/devices/dfl-port.0/userclk_freqcntrcmd

Defined on file sysfs-platform-dfl-port

Write-only. User writes command to this interface to set userclock counter.

/sys/bus/platform/devices/dfl-port.0/userclk_freqcntrsts

Defined on file sysfs-platform-dfl-port

Read-only. Read this file to get the status of issued command to userclck_freqcntrcmd.

/sys/bus/platform/devices/dfl-port.0/userclk_freqsts

Defined on file sysfs-platform-dfl-port

Read-only. Read this file to get the status of issued command to userclck_freqcmd.

/sys/bus/platform/devices/tahvo-usb/otg_mode

Defined on file sysfs-platform-tahvo-usb

Set or read the current OTG mode. Valid values are “host” and “peripheral”.

Reading: returns the current mode.

/sys/bus/platform/devices/tahvo-usb/vbus

Defined on file sysfs-platform-tahvo-usb

Read the current VBUS state.

Reading: returns “on” or “off”.

/sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level

Defined on file sysfs-driver-ufs

This file provides the active icc level UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status

Defined on file sysfs-driver-ufs

This file provides the background operations status UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled

Defined on file sysfs-driver-ufs

This file provides the boot lun enabled UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock

Defined on file sysfs-driver-ufs

This file shows whether the configuration descriptor is locked. The full information about the attribute could be found at UFS specifications 2.1. The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode

Defined on file sysfs-driver-ufs

This file provides the current power mode UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control

Defined on file sysfs-driver-ufs

This file provides the exception event control UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status

Defined on file sysfs-driver-ufs

This file provides the exception event status UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status

Defined on file sysfs-driver-ufs

This file provides the ffu status UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size

Defined on file sysfs-driver-ufs

This file shows the maximum data size in a DATA IN UPIU. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size

Defined on file sysfs-driver-ufs

This file shows the maximum number of bytes that can be requested with a READY TO TRANSFER UPIU. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt

Defined on file sysfs-driver-ufs

This file provides the maximum current number of outstanding RTTs in device that is allowed. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled

Defined on file sysfs-driver-ufs

This file provides the out of order data transfer enabled UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size

Defined on file sysfs-driver-ufs

This file shows the amount of data that the host plans to load to all logical units in pre-soldering state. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/psa_state

Defined on file sysfs-driver-ufs

This file show the PSA feature status. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/purge_status

Defined on file sysfs-driver-ufs

This file provides the purge operation status UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency

Defined on file sysfs-driver-ufs

This file provides the reference clock frequency UFS device attribute. The full information about the attribute could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf

Defined on file sysfs-driver-ufs

This entry shows the amount of unused WriteBooster buffer available.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf

Defined on file sysfs-driver-ufs

This entry shows the amount of unused current buffer.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status

Defined on file sysfs-driver-ufs

This entry shows the flush operation status.

00h	idle
01h	Flush operation in progress
02h	Flush operation stopped prematurely.
03h	Flush operation completed successfully
04h	Flush operation general failure

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est

Defined on file sysfs-driver-ufs

This entry shows an indication of the WriteBooster Buffer lifetime based on the amount of performed program/erase cycles

01h	0% - 10% WriteBooster Buffer life time used
…
0Ah	90% - 100% WriteBooster Buffer life time used

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency

Defined on file sysfs-driver-ufs

This file shows the background operations termination latency. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable

Defined on file sysfs-driver-ufs

This file shows value that indicates whether the device is enabled for boot. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable

Defined on file sysfs-driver-ufs

This file shows value that indicates whether the device descriptor could be read after partial initialization phase of the boot sequence. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class

Defined on file sysfs-driver-ufs

This file shows the device class. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class

Defined on file sysfs-driver-ufs

This file shows the UFS storage subclass. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_type

Defined on file sysfs-driver-ufs

This file shows the device type. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version

Defined on file sysfs-driver-ufs

This file shows the device version. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout

Defined on file sysfs-driver-ufs

This file shows the FFU timeout. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun

Defined on file sysfs-driver-ufs

This file shows the high priority lun. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level

Defined on file sysfs-driver-ufs

This file shows the initial active ICC level. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode

Defined on file sysfs-driver-ufs

This file shows value that defines the power mode after device initialization or hardware reset. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id

Defined on file sysfs-driver-ufs

This file shows the manufacturee ID. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date

Defined on file sysfs-driver-ufs

This file shows the manufacturing date in BCD format. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns

Defined on file sysfs-driver-ufs

This file shows number of logical units. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa

Defined on file sysfs-driver-ufs

This file shows number of secure write protect areas supported by the device. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns

Defined on file sysfs-driver-ufs

This file shows number of well known logical units. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol

Defined on file sysfs-driver-ufs

This file shows the protocol supported by an UFS device. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size

Defined on file sysfs-driver-ufs

This file shows the maximum amount of data that may be written during the pre-soldering phase of the PSA flow. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout

Defined on file sysfs-driver-ufs

This file shows the command maximum timeout for a change in PSA state. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth

Defined on file sysfs-driver-ufs

This file shows the device queue depth. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update

Defined on file sysfs-driver-ufs

This file shows the frequency and method of the realtime clock update. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability

Defined on file sysfs-driver-ufs

This file shows the maximum number of outstanding RTTs supported by the device. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type

Defined on file sysfs-driver-ufs

This file shows the secure removal type. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version

Defined on file sysfs-driver-ufs

This file shows the specification version. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun

Defined on file sysfs-driver-ufs

This file shows whether the security lun is supported. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features

Defined on file sysfs-driver-ufs

This file shows which features are supported by the device. This is one of the UFS device descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en

Defined on file sysfs-driver-ufs

This entry shows if preserve user-space was configured

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units

Defined on file sysfs-driver-ufs

This entry shows the shared allocated units of WB buffer

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type

Defined on file sysfs-driver-ufs

This entry shows the configured WB type. 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable

Defined on file sysfs-driver-ufs

This file shows whether the device background operations are enabled. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc

Defined on file sysfs-driver-ufs

This file shows whether the device is executing internal operation related to real time clock. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/device_init

Defined on file sysfs-driver-ufs

This file shows the device init status. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update

Defined on file sysfs-driver-ufs

This file shows whether the device FW update is permanently disabled. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable

Defined on file sysfs-driver-ufs

This file shows whether the device life span mode is enabled. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe

Defined on file sysfs-driver-ufs

This file shows whether permanent write protection is enabled. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal

Defined on file sysfs-driver-ufs

This file shows whether physical resource removal is enable. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe

Defined on file sysfs-driver-ufs

This file shows whether write protection is enabled on all logical units configured as power on write protected. The full information about the flag could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/wb_enable

Defined on file sysfs-driver-ufs

This entry shows the status of WriteBooster.

0	WriteBooster is not enabled.
1	WriteBooster is enabled

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8

Defined on file sysfs-driver-ufs

Flush WriteBooster Buffer during hibernate state.

0	Device is not allowed to flush the WriteBooster Buffer during link hibernate state.
1	Device is allowed to flush the WriteBooster Buffer during link hibernate state.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en

Defined on file sysfs-driver-ufs

This entry shows if flush is enabled.

0	Flush operation is not performed.
1	Flush operation is performed.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor

Defined on file sysfs-driver-ufs

This file shows the memory capacity adjustment factor for different memory types (system code, non persistent, enhanced type 1-4). This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units

Defined on file sysfs-driver-ufs

This file shows the maximum number of allocation units for different memory types (system code, non persistent, enhanced type 1-4). This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size

Defined on file sysfs-driver-ufs

This file shows the allocation unit size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering

Defined on file sysfs-driver-ufs

This file shows support for out-of-order data transfer. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy

Defined on file sysfs-driver-ufs

This file shows the dynamic capacity resource policy. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size

Defined on file sysfs-driver-ufs

This file shows the maximum data-in buffer size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts

Defined on file sysfs-driver-ufs

This file shows maximum available number of contexts which are supported by the device. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns

Defined on file sysfs-driver-ufs

This file shows the maximum number of logical units supported by the UFS device. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size

Defined on file sysfs-driver-ufs

This file shows the maximum data-out buffer size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types

Defined on file sysfs-driver-ufs

This file shows supported memory types. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size

Defined on file sysfs-driver-ufs

This file shows the minimum addressable block size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size

Defined on file sysfs-driver-ufs

This file shows the optimal read block size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size

Defined on file sysfs-driver-ufs

This file shows the optimal write block size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity

Defined on file sysfs-driver-ufs

This file shows the total memory quantity available to the user to configure the device logical units. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size

Defined on file sysfs-driver-ufs

This file shows the maximum number of RPMB frames allowed in Security Protocol In/Out. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types

Defined on file sysfs-driver-ufs

This file shows supported secure removal types. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size

Defined on file sysfs-driver-ufs

This file shows the segment size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size

Defined on file sysfs-driver-ufs

This file shows maximum storage area size allocated by the device to handle system data by the tagging mechanism. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size

Defined on file sysfs-driver-ufs

This file shows system data tag unit size. This is one of the UFS geometry descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj

Defined on file sysfs-driver-ufs

This entry shows the total user-space decrease in shared buffer mode. The value of this parameter is 3 for TLC NAND when SLC mode is used as WriteBooster Buffer. 2 for MLC NAND.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units

Defined on file sysfs-driver-ufs

This entry shows the Maximum total WriteBooster Buffer size which is supported by the entire device.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns

Defined on file sysfs-driver-ufs

This entry shows the maximum number of luns that can support WriteBooster.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type

Defined on file sysfs-driver-ufs

The supportability of user space reduction mode and preserve user space mode. 00h: WriteBooster Buffer can be configured only in user space reduction type. 01h: WriteBooster Buffer can be configured only in preserve user space type. 02h: Device can be configured in either user space reduction type or preserve user space type.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type

Defined on file sysfs-driver-ufs

The supportability of WriteBooster Buffer type.

00h	LU based WriteBooster Buffer configuration
01h	Single shared WriteBooster Buffer configuration
02h	Supporting both LU based WriteBooster. Buffer and Single shared WriteBooster Buffer configuration

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info

Defined on file sysfs-driver-ufs

This file shows preend of life information. This is one of the UFS health descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a

Defined on file sysfs-driver-ufs

This file shows indication of the device life time (method a). This is one of the UFS health descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b

Defined on file sysfs-driver-ufs

This file shows indication of the device life time (method b). This is one of the UFS health descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version

Defined on file sysfs-driver-ufs

This file shows the MIPI M-PHY version number in BCD format. This is one of the UFS interconnect descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version

Defined on file sysfs-driver-ufs

This file shows the MIPI UniPro version number in BCD format. This is one of the UFS interconnect descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc*

Defined on file sysfs-driver-ufs

This file shows maximum VCC, VCCQ and VCCQ2 value for active ICC levels from 0 to 15. This is one of the UFS power descriptor parameters. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/rpm_lvl

Defined on file sysfs-driver-ufs

This entry could be used to set or show the UFS device runtime power management level. The current driver implementation supports 7 levels with next target states:

0	UFS device will stay active, UIC link will stay active
1	UFS device will stay active, UIC link will hibernate
2	UFS device will be moved to sleep, UIC link will stay active
3	UFS device will be moved to sleep, UIC link will hibernate
4	UFS device will be powered off, UIC link will hibernate
5	UFS device will be powered off, UIC link will be powered off
6	UFS device will be moved to deep sleep, UIC link will be powered off. Note, deep sleep might not be supported in which case this value will not be accepted

/sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state

Defined on file sysfs-driver-ufs

This entry shows the target power mode of an UFS device for the chosen runtime power management level.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state

Defined on file sysfs-driver-ufs

This entry shows the target state of an UFS UIC link for the chosen runtime power management level.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/spm_lvl

Defined on file sysfs-driver-ufs

This entry could be used to set or show the UFS device system power management level. The current driver implementation supports 7 levels with next target states:

0	UFS device will stay active, UIC link will stay active
1	UFS device will stay active, UIC link will hibernate
2	UFS device will be moved to sleep, UIC link will stay active
3	UFS device will be moved to sleep, UIC link will hibernate
4	UFS device will be powered off, UIC link will hibernate
5	UFS device will be powered off, UIC link will be powered off
6	UFS device will be moved to deep sleep, UIC link will be powered off. Note, deep sleep might not be supported in which case this value will not be accepted

/sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state

Defined on file sysfs-driver-ufs

This entry shows the target power mode of an UFS device for the chosen system power management level.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/spm_target_link_state

Defined on file sysfs-driver-ufs

This entry shows the target state of an UFS UIC link for the chosen system power management level.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name

Defined on file sysfs-driver-ufs

This file contains a device manufactureer name string. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id

Defined on file sysfs-driver-ufs

This file contains a OEM ID string. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name

Defined on file sysfs-driver-ufs

This file contains a product name string. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision

Defined on file sysfs-driver-ufs

This file contains a product revision string. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number

Defined on file sysfs-driver-ufs

This file contains a device serial number string. The full information about the descriptor could be found at UFS specifications 2.1.

The file is read only.

/sys/bus/platform/drivers/ufshcd/*/wb_on

Defined on file sysfs-driver-ufs

This node is used to set or display whether UFS WriteBooster is enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to enable it. The WriteBooster is enabled after power-on/reset, however, it will be disabled/enable while CLK scaling down/up (if the platform supports UFSHCD_CAP_CLK_SCALING). For a platform that doesn’t support UFSHCD_CAP_CLK_SCALING, we can disable/enable WriteBooster through this sysfs node.

/sys/bus/rapidio/devices/nn:d:iiii

Defined on file sysfs-bus-rapidio

For each RapidIO device, the RapidIO subsystem creates files in an individual subdirectory with the following name format of device_name “nn:d:iiii”, where:

nn	two-digit hexadecimal ID of RapidIO network where the device resides
d	device type: ‘e’ - for endpoint or ‘s’ - for switch
iiii	four-digit device destID for endpoints, or switchID for switches

For example, below is a list of device directories that represents a typical RapidIO network with one switch, one host, and two agent endpoints, as it is seen by the enumerating host (with destID = 1):

/sys/bus/rapidio/devices/00:e:0000
/sys/bus/rapidio/devices/00:e:0002
/sys/bus/rapidio/devices/00:s:0001

NOTE:

An enumerating or discovering endpoint does not create a sysfs entry for itself, this is why an endpoint with destID=1 is not shown in the list.

Attributes Common for All RapidIO Devices

/sys/bus/rapidio/devices/nn:d:iiii/asm_did

Defined on file sysfs-bus-rapidio

(RO) returns identifier for the assembly containing the device

/sys/bus/rapidio/devices/nn:d:iiii/asm_rev

Defined on file sysfs-bus-rapidio

(RO) returns revision level of the assembly containing the device

/sys/bus/rapidio/devices/nn:d:iiii/asm_vid

Defined on file sysfs-bus-rapidio

(RO) returns vendor identifier of the assembly containing the device

/sys/bus/rapidio/devices/nn:d:iiii/config

Defined on file sysfs-bus-rapidio

(RW) Binary attribute to read from and write to the device configuration registers using the RapidIO maintenance transactions. This attribute is similar in behaviour to the “config” attribute of PCI devices and provides an access to the RapidIO device registers using standard file read and write operations.

RapidIO Switch Device Attributes

RapidIO switches have additional attributes in sysfs. RapidIO subsystem supports common and device-specific sysfs attributes for switches. Because switches are integrated into the RapidIO subsystem, it offers a method to create device-specific sysfs attributes by specifying a callback function that may be set by the switch initialization routine during enumeration or discovery process.

/sys/bus/rapidio/devices/nn:d:iiii/destid

Defined on file sysfs-bus-rapidio

(RO) returns device destination ID assigned by the enumeration routine

/sys/bus/rapidio/devices/nn:d:iiii/device_rev

Defined on file sysfs-bus-rapidio

(RO) returns the device revision level

/sys/bus/rapidio/devices/nn:d:iiii/did

Defined on file sysfs-bus-rapidio

(RO) returns the device identifier

/sys/bus/rapidio/devices/nn:d:iiii/lprev

Defined on file sysfs-bus-rapidio

(RO) returns name of previous device (switch) on the path to the device that that owns this attribute

/sys/bus/rapidio/devices/nn:d:iiii/modalias

Defined on file sysfs-bus-rapidio

(RO) returns the device modalias

/sys/bus/rapidio/devices/nn:d:iiii/vid

Defined on file sysfs-bus-rapidio

(RO) returns the device vendor identifier

/sys/bus/rapidio/devices/nn:s:iiii/destid

Defined on file sysfs-bus-rapidio

(RO) device destination ID of the associated device that defines a route to the switch

/sys/bus/rapidio/devices/nn:s:iiii/errlog

Defined on file sysfs-bus-rapidio

(RO) reads contents of device error log until it is empty.

RapidIO Bus Attributes

/sys/bus/rapidio/devices/nn:s:iiii/hopcount

Defined on file sysfs-bus-rapidio

(RO) number of hops on the path to the switch

/sys/bus/rapidio/devices/nn:s:iiii/lnext

Defined on file sysfs-bus-rapidio

(RO) returns names of devices linked to the switch except one of a device linked to the ingress port (reported as “lprev”). This is an array names with number of lines equal to number of ports in switch. If a switch port has no attached device, returns “null” instead of a device name.

Device-specific Switch Attributes

IDT_GEN2-

/sys/bus/rapidio/devices/nn:s:iiii/routes

Defined on file sysfs-bus-rapidio

(RO) reports switch routing information in “destID port” format. This attribute reports only valid routing table entries, one line for each entry.

/sys/bus/rapidio/scan

Defined on file sysfs-bus-rapidio

(WO) Allows to trigger enumeration discovery process from user space. To initiate an enumeration or discovery process on specific mport device, a user needs to write mport_ID (not RapidIO destination ID) into this file. The mport_ID is a sequential number (0 … RIO_MAX_MPORTS) assigned to the mport device. For example, for a machine with a single RapidIO controller, mport_ID for that controller always will be 0. To initiate RapidIO enumeration/discovery on all available mports a user must write ‘-1’ (or RIO_MPORT_ANY) into this attribute file.

/sys/bus/rbd/add

Defined on file sysfs-bus-rbd

(WO) Add rbd block device.

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

The snapshot name can be “-” or omitted to map the image read/write. A <dev-id> will be assigned for any registered block device. If snapshot is used, it will be mapped read-only.

/sys/bus/rbd/add_single_major

Defined on file sysfs-bus-rbd

(WO) Available only if rbd module is inserted with single_major parameter set to true.

Usage is the same as for /sys/bus/rbd/add. If present, this should be used instead of the latter: any attempts to use /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available will fail for backwards compatibility reasons.

/sys/bus/rbd/devices/<dev-id>/image_id

/sys/bus/rbd/devices/<dev-id>/features

Defined on file sysfs-bus-rbd

image_id	(RO) The unique id for the rbd image. (For rbd image format 1 this is empty.)
features	(RO) A hexadecimal encoding of the feature bits for this image.

/sys/bus/rbd/devices/<dev-id>/minor

Defined on file sysfs-bus-rbd

(RO) The block device minor number.

/sys/bus/rbd/devices/<dev-id>/parent

Defined on file sysfs-bus-rbd

(RO) Information identifying the chain of parent images in a layered rbd image. Entries are separated by empty lines.

/sys/bus/rbd/devices/<dev-id>/pool_id

Defined on file sysfs-bus-rbd

(RO) The unique identifier for the rbd image’s pool. This is a permanent attribute of the pool. A pool’s id will never change.

/sys/bus/rbd/devices/<dev-id>/size

/sys/bus/rbd/devices/<dev-id>/major

/sys/bus/rbd/devices/<dev-id>/client_id

/sys/bus/rbd/devices/<dev-id>/pool

/sys/bus/rbd/devices/<dev-id>/name

/sys/bus/rbd/devices/<dev-id>/refresh

/sys/bus/rbd/devices/<dev-id>/current_snap

Defined on file sysfs-bus-rbd

size	(RO) The size (in bytes) of the mapped block device.
major	(RO) The block device major number.
client_id	(RO) The ceph unique client id that was assigned for this specific session.
pool	(RO) The name of the storage pool where this rbd image resides. An rbd image name is unique within its pool.
name	(RO) The name of the rbd image.
refresh	(WO) Writing to this file will reread the image header data and set all relevant data structures accordingly.
current_snap	(RO) The current snapshot for which the device is mapped.

/sys/bus/rbd/devices/<dev-id>/snap_id

/sys/bus/rbd/devices/<dev-id>/config_info

/sys/bus/rbd/devices/<dev-id>/cluster_fsid

/sys/bus/rbd/devices/<dev-id>/client_addr

Defined on file sysfs-bus-rbd

snap_id	(RO) The current snapshot’s id.
config_info	(RO) The string written into /sys/bus/rbd/add{,_single_major}.
cluster_fsid	(RO) The ceph cluster UUID.
client_addr	(RO) The ceph unique client entity_addr_t (address + nonce). The format is <address>:<port>/<nonce>: ‘1.2.3.4:1234/5678’ or ‘[1:2:3:4:5:6:7:8]:1234/5678’.

/sys/bus/rbd/remove

Defined on file sysfs-bus-rbd

(WO) Remove rbd block device.

Usage: <dev-id> [force]

Example:

$ echo 2 > /sys/bus/rbd/remove

Optional “force” argument which when passed will wait for running requests and then unmap the image. Requests sent to the driver after initiating the removal will be failed. (August 2016, since 4.9.)

/sys/bus/rbd/remove_single_major

Defined on file sysfs-bus-rbd

(WO) Available only if rbd module is inserted with single_major parameter set to true.

Usage is the same as for /sys/bus/rbd/remove. If present, this should be used instead of the latter: any attempts to use /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is available will fail for backwards compatibility reasons.

/sys/bus/rbd/supported_features

Defined on file sysfs-bus-rbd

(RO) Displays the features supported by the rbd module so that userspace can generate meaningful error messages and spell out unsupported features that need to be disabled.

/sys/bus/rpmsg/devices/…/announce

Defined on file sysfs-bus-rpmsg

Every rpmsg device is a communication channel with a remote processor. Channels are identified by a textual name (see /sys/bus/rpmsg/devices/…/name above) and have a local (“source”) rpmsg address, and remote (“destination”) rpmsg address.

A channel is first created when an entity, whether local or remote, starts listening on it for messages (and is thus called an rpmsg server).

When that happens, a “name service” announcement is sent to the other processor, in order to let it know about the creation of the channel (this way remote clients know they can start sending messages).

This sysfs entry tells us whether the channel is a local server channel that is announced (values are either true or false).

/sys/bus/rpmsg/devices/…/driver_override

Defined on file sysfs-bus-rpmsg

Every rpmsg device is a communication channel with a remote processor. Channels are identified by a textual name (see /sys/bus/rpmsg/devices/…/name above) and have a local (“source”) rpmsg address, and remote (“destination”) rpmsg address.

The listening entity (or client) which communicates with a remote processor is referred as rpmsg driver. The rpmsg device and rpmsg driver are matched based on rpmsg device name and rpmsg driver ID table.

This sysfs entry allows the rpmsg driver for a rpmsg device to be specified which will override standard OF, ID table and name matching.

/sys/bus/rpmsg/devices/…/dst

Defined on file sysfs-bus-rpmsg

Every rpmsg device is a communication channel with a remote processor. Channels have a local (“source”) rpmsg address, and remote (“destination”) rpmsg address. When an entity starts listening on one end of a channel, it assigns it with a unique rpmsg address (a 32 bits integer). This way when inbound messages arrive to this address, the rpmsg core dispatches them to the listening entity.

This sysfs entry contains the dst (remote) rpmsg address of this channel. If it contains 0xffffffff, then an address wasn’t assigned (can happen if the kernel driver that is attached to this channel is exposing a service to the remote processor. This make it a local rpmsg server, and it is listening for inbound messages that may be sent from any remote rpmsg client; it is not bound to a single remote entity).

/sys/bus/rpmsg/devices/…/name

Defined on file sysfs-bus-rpmsg

Every rpmsg device is a communication channel with a remote processor. Channels are identified with a (textual) name, which is maximum 32 bytes long (defined as RPMSG_NAME_SIZE in rpmsg.h).

This sysfs entry contains the name of this channel.

/sys/bus/rpmsg/devices/…/src

Defined on file sysfs-bus-rpmsg

Every rpmsg device is a communication channel with a remote processor. Channels have a local (“source”) rpmsg address, and remote (“destination”) rpmsg address. When an entity starts listening on one end of a channel, it assigns it with a unique rpmsg address (a 32 bits integer). This way when inbound messages arrive to this address, the rpmsg core dispatches them to the listening entity (a kernel driver).

This sysfs entry contains the src (local) rpmsg address of this channel. If it contains 0xffffffff, then an address wasn’t assigned (can happen if no driver exists for this channel).

/sys/bus/scsi/drivers/st/debug_flag

Defined on file sysfs-driver-st

This file allows you to turn debug output from the st driver off if you write a ‘0’ to the file or on if you write a ‘1’. Note that debug output requires that the module be compiled with the #define DEBUG set to a non-zero value (this is the default). If DEBUG is set to 0 then this file will not appear in sysfs as its presence is conditional upon debug output support being compiled into the module.

/sys/bus/siox/devices/siox-X-Y/connected

Defined on file sysfs-bus-siox

Read-only value. “0” means the Yth device on siox bus X isn’t “connected” i.e. communication with it is not ensured. “1” signals a working connection.

/sys/bus/siox/devices/siox-X-Y/inbytes

Defined on file sysfs-bus-siox

Read-only value reporting the inbytes value provided to siox-X/device_add

/sys/bus/siox/devices/siox-X-Y/outbytes

Defined on file sysfs-bus-siox

Read-only value reporting the outbytes value provided to siox-X/device_add.

/sys/bus/siox/devices/siox-X-Y/status_errors

Defined on file sysfs-bus-siox

Counts the number of time intervals when the read status byte doesn’t yield the expected value.

/sys/bus/siox/devices/siox-X-Y/type

Defined on file sysfs-bus-siox

Read-only value reporting the type value provided to siox-X/device_add.

/sys/bus/siox/devices/siox-X-Y/watchdog

Defined on file sysfs-bus-siox

Read-only value reporting if the watchdog of the siox device is active. “0” means the watchdog is not active and the device is expected to be operational. “1” means the watchdog keeps the device in reset.