mirror of
https://github.com/linux-msm/laptops-kernel.git
synced 2026-08-13 14:19:53 -07:00
docs: ABI: testing: make the files compatible with ReST output
Some files over there won't parse well by Sphinx. Fix them. Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com> Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Mauro Carvalho Chehab
committed by
Greg Kroah-Hartman
Greg Kroah-Hartman
parent
98913408c5
commit
3443333284
@@ -10,22 +10,24 @@ Description:
|
||||
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/
|
||||
in /config directory use::
|
||||
|
||||
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
|
||||
# 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.
|
||||
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.
|
||||
=============== ======================================================
|
||||
|
||||
@@ -12,22 +12,24 @@ Description:
|
||||
|
||||
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.
|
||||
================ ============================================
|
||||
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.
|
||||
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
|
||||
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
|
||||
================ ============================================
|
||||
|
||||
What: /config/usb-gadget/gadget/configs
|
||||
Date: Jun 2013
|
||||
@@ -41,8 +43,10 @@ KernelVersion: 3.11
|
||||
Description:
|
||||
The attributes of a configuration:
|
||||
|
||||
bmAttributes - configuration characteristics
|
||||
MaxPower - maximum power consumption from the bus
|
||||
================ ======================================
|
||||
bmAttributes configuration characteristics
|
||||
MaxPower maximum power consumption from the bus
|
||||
================ ======================================
|
||||
|
||||
What: /config/usb-gadget/gadget/configs/config/strings
|
||||
Date: Jun 2013
|
||||
@@ -57,7 +61,9 @@ KernelVersion: 3.11
|
||||
Description:
|
||||
The attributes:
|
||||
|
||||
configuration - configuration description
|
||||
================ =========================
|
||||
configuration configuration description
|
||||
================ =========================
|
||||
|
||||
|
||||
What: /config/usb-gadget/gadget/functions
|
||||
@@ -76,8 +82,10 @@ Description:
|
||||
|
||||
The attributes:
|
||||
|
||||
compatible_id - 8-byte string for "Compatible ID"
|
||||
sub_compatible_id - 8-byte string for "Sub Compatible ID"
|
||||
================= =====================================
|
||||
compatible_id 8-byte string for "Compatible ID"
|
||||
sub_compatible_id 8-byte string for "Sub Compatible ID"
|
||||
================= =====================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
|
||||
Date: May 2014
|
||||
@@ -89,16 +97,19 @@ Description:
|
||||
|
||||
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 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
|
||||
===== ===============================================
|
||||
|
||||
What: /config/usb-gadget/gadget/strings
|
||||
Date: Jun 2013
|
||||
@@ -113,9 +124,11 @@ KernelVersion: 3.11
|
||||
Description:
|
||||
The attributes:
|
||||
|
||||
serialnumber - gadget's serial number (string)
|
||||
product - gadget's product description
|
||||
manufacturer - gadget's manufacturer description
|
||||
============ =================================
|
||||
serialnumber gadget's serial number (string)
|
||||
product gadget's product description
|
||||
manufacturer gadget's manufacturer description
|
||||
============ =================================
|
||||
|
||||
What: /config/usb-gadget/gadget/os_desc
|
||||
Date: May 2014
|
||||
@@ -123,8 +136,10 @@ KernelVersion: 3.16
|
||||
Description:
|
||||
This group contains "OS String" extension handling attributes.
|
||||
|
||||
use - flag turning "OS Desctiptors" support on/off
|
||||
b_vendor_code - one-byte value used for custom per-device and
|
||||
============= ===============================================
|
||||
use flag turning "OS Desctiptors" support on/off
|
||||
b_vendor_code one-byte value used for custom per-device and
|
||||
per-interface requests
|
||||
qw_sign - an identifier to be reported as "OS String"
|
||||
qw_sign an identifier to be reported as "OS String"
|
||||
proper
|
||||
============= ===============================================
|
||||
|
||||
@@ -4,8 +4,10 @@ KernelVersion: 3.19
|
||||
Description:
|
||||
The attributes:
|
||||
|
||||
protocol - HID protocol to use
|
||||
report_desc - blob corresponding to HID report descriptors
|
||||
============= ============================================
|
||||
protocol HID protocol to use
|
||||
report_desc blob corresponding to HID report descriptors
|
||||
except the data passed through /dev/hidg<N>
|
||||
report_length - HID report length
|
||||
subclass - HID device subclass to use
|
||||
report_length HID report length
|
||||
subclass HID device subclass to use
|
||||
============= ============================================
|
||||
|
||||
@@ -4,14 +4,16 @@ KernelVersion: 3.11
|
||||
Description:
|
||||
The attributes:
|
||||
|
||||
ifname - network device interface name associated with
|
||||
========= =============================================
|
||||
ifname network device interface name associated with
|
||||
this function instance
|
||||
qmult - queue length multiplier for high and
|
||||
qmult queue length multiplier for high and
|
||||
super speed
|
||||
host_addr - MAC address of host's end of this
|
||||
host_addr MAC address of host's end of this
|
||||
Ethernet over USB link
|
||||
dev_addr - MAC address of device's end of this
|
||||
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)
|
||||
class USB interface class, default is 02 (hex)
|
||||
subclass USB interface subclass, default is 06 (hex)
|
||||
protocol USB interface protocol, default is 00 (hex)
|
||||
========= =============================================
|
||||
|
||||
@@ -4,11 +4,13 @@ KernelVersion: 4.14
|
||||
Description:
|
||||
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
|
||||
========== ===================================
|
||||
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
|
||||
========== ===================================
|
||||
|
||||
@@ -3,9 +3,11 @@ Date: Dec 2014
|
||||
KernelVersion: 4.0
|
||||
Description: UVC function directory
|
||||
|
||||
streaming_maxburst - 0..15 (ss only)
|
||||
streaming_maxpacket - 1..1023 (fs), 1..3072 (hs/ss)
|
||||
streaming_interval - 1..16
|
||||
=================== =============================
|
||||
streaming_maxburst 0..15 (ss only)
|
||||
streaming_maxpacket 1..1023 (fs), 1..3072 (hs/ss)
|
||||
streaming_interval 1..16
|
||||
=================== =============================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/control
|
||||
Date: Dec 2014
|
||||
@@ -13,8 +15,11 @@ KernelVersion: 4.0
|
||||
Description: Control descriptors
|
||||
|
||||
All attributes read only:
|
||||
bInterfaceNumber - USB interface number for this
|
||||
streaming interface
|
||||
|
||||
================ =============================
|
||||
bInterfaceNumber USB interface number for this
|
||||
streaming interface
|
||||
================ =============================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/control/class
|
||||
Date: Dec 2014
|
||||
@@ -47,13 +52,16 @@ KernelVersion: 4.0
|
||||
Description: Default output terminal descriptors
|
||||
|
||||
All attributes read only:
|
||||
iTerminal - index of string descriptor
|
||||
bSourceID - id of the terminal to which this terminal
|
||||
|
||||
============== =============================================
|
||||
iTerminal index of string descriptor
|
||||
bSourceID id of the terminal to which this terminal
|
||||
is connected
|
||||
bAssocTerminal - id of the input terminal to which this output
|
||||
bAssocTerminal id of the input terminal to which this output
|
||||
terminal is associated
|
||||
wTerminalType - terminal type
|
||||
bTerminalID - a non-zero id of this terminal
|
||||
wTerminalType terminal type
|
||||
bTerminalID a non-zero id of this terminal
|
||||
============== =============================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
|
||||
Date: Dec 2014
|
||||
@@ -66,16 +74,19 @@ KernelVersion: 4.0
|
||||
Description: 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
|
||||
|
||||
======================== ====================================
|
||||
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
|
||||
======================== ====================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/control/processing
|
||||
Date: Dec 2014
|
||||
@@ -88,13 +99,16 @@ KernelVersion: 4.0
|
||||
Description: Default processing unit descriptors
|
||||
|
||||
All attributes read only:
|
||||
iProcessing - index of string descriptor
|
||||
bmControls - bitmap specifying which controls are
|
||||
|
||||
=============== ========================================
|
||||
iProcessing index of string descriptor
|
||||
bmControls bitmap specifying which controls are
|
||||
supported for the video stream
|
||||
wMaxMultiplier - maximum digital magnification x100
|
||||
bSourceID - id of the terminal to which this unit is
|
||||
wMaxMultiplier maximum digital magnification x100
|
||||
bSourceID id of the terminal to which this unit is
|
||||
connected
|
||||
bUnitID - a non-zero id of this unit
|
||||
bUnitID a non-zero id of this unit
|
||||
=============== ========================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/control/header
|
||||
Date: Dec 2014
|
||||
@@ -114,8 +128,11 @@ KernelVersion: 4.0
|
||||
Description: Streaming descriptors
|
||||
|
||||
All attributes read only:
|
||||
bInterfaceNumber - USB interface number for this
|
||||
streaming interface
|
||||
|
||||
================ =============================
|
||||
bInterfaceNumber USB interface number for this
|
||||
streaming interface
|
||||
================ =============================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class
|
||||
Date: Dec 2014
|
||||
@@ -148,13 +165,16 @@ KernelVersion: 4.0
|
||||
Description: 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
|
||||
|
||||
======================== ======================================
|
||||
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
|
||||
======================== ======================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
|
||||
Date: Dec 2014
|
||||
@@ -168,47 +188,52 @@ Description: Specific MJPEG format descriptors
|
||||
|
||||
All attributes read only,
|
||||
except bmaControls and bDefaultFrameIndex:
|
||||
bFormatIndex - unique id for this format descriptor;
|
||||
|
||||
=================== =====================================
|
||||
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
|
||||
bmaControls this format's data for bmaControls in
|
||||
the streaming header
|
||||
bmInterfaceFlags - specifies interlace information,
|
||||
bmInterfaceFlags specifies interlace information,
|
||||
read-only
|
||||
bAspectRatioY - the X dimension of the picture aspect
|
||||
bAspectRatioY the X dimension of the picture aspect
|
||||
ratio, read-only
|
||||
bAspectRatioX - the Y dimension of the picture aspect
|
||||
bAspectRatioX the Y dimension of the picture aspect
|
||||
ratio, read-only
|
||||
bmFlags - characteristics of this format,
|
||||
bmFlags characteristics of this format,
|
||||
read-only
|
||||
bDefaultFrameIndex - optimum frame index for this stream
|
||||
bDefaultFrameIndex optimum frame index for this stream
|
||||
=================== =====================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
|
||||
Date: Dec 2014
|
||||
KernelVersion: 4.0
|
||||
Description: 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
|
||||
========================= =====================================
|
||||
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
|
||||
========================= =====================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
|
||||
Date: Dec 2014
|
||||
@@ -220,50 +245,54 @@ Date: Dec 2014
|
||||
KernelVersion: 4.0
|
||||
Description: Specific uncompressed format descriptors
|
||||
|
||||
bFormatIndex - unique id for this format descriptor;
|
||||
================== =======================================
|
||||
bFormatIndex unique id for this format descriptor;
|
||||
only defined after parent header is
|
||||
linked into the streaming class;
|
||||
read-only
|
||||
bmaControls - this format's data for bmaControls in
|
||||
bmaControls this format's data for bmaControls in
|
||||
the streaming header
|
||||
bmInterfaceFlags - specifies interlace information,
|
||||
bmInterfaceFlags specifies interlace information,
|
||||
read-only
|
||||
bAspectRatioY - the X dimension of the picture aspect
|
||||
bAspectRatioY the X dimension of the picture aspect
|
||||
ratio, read-only
|
||||
bAspectRatioX - the Y dimension of the picture aspect
|
||||
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
|
||||
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
|
||||
guidFormat globally unique id used to identify
|
||||
stream-encoding format
|
||||
================== =======================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
|
||||
Date: Dec 2014
|
||||
KernelVersion: 4.0
|
||||
Description: 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
|
||||
========================= =====================================
|
||||
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
|
||||
========================= =====================================
|
||||
|
||||
What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header
|
||||
Date: Dec 2014
|
||||
@@ -276,17 +305,20 @@ KernelVersion: 4.0
|
||||
Description: Specific streaming header descriptors
|
||||
|
||||
All attributes read only:
|
||||
bTriggerUsage - how the host software will respond to
|
||||
|
||||
==================== =====================================
|
||||
bTriggerUsage how the host software will respond to
|
||||
a hardware trigger interrupt event
|
||||
bTriggerSupport - flag specifying if hardware
|
||||
bTriggerSupport flag specifying if hardware
|
||||
triggering is supported
|
||||
bStillCaptureMethod - method of still image caputre
|
||||
bStillCaptureMethod method of still image caputre
|
||||
supported
|
||||
bTerminalLink - id of the output terminal to which
|
||||
bTerminalLink id of the output terminal to which
|
||||
the video endpoint of this interface
|
||||
is connected
|
||||
bmInfo - capabilities of this video streaming
|
||||
bmInfo capabilities of this video streaming
|
||||
interface
|
||||
==================== =====================================
|
||||
|
||||
What: /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
|
||||
Date: May 2018
|
||||
|
||||
@@ -6,7 +6,7 @@ Description:
|
||||
General information like which GPE is assigned to the EC and whether
|
||||
the global lock should get used.
|
||||
Knowing the EC GPE one can watch the amount of HW events related to
|
||||
the EC here (XY -> GPE number from /sys/kernel/debug/ec/*/gpe):
|
||||
the EC here (XY -> GPE number from `/sys/kernel/debug/ec/*/gpe`):
|
||||
/sys/firmware/acpi/interrupts/gpeXY
|
||||
|
||||
The io file is binary and a userspace tool located here:
|
||||
@@ -14,7 +14,8 @@ ftp://ftp.suse.com/pub/people/trenn/sources/ec/
|
||||
should get used to read out the 256 Embedded Controller registers
|
||||
or writing to them.
|
||||
|
||||
CAUTION: Do not write to the Embedded Controller if you don't know
|
||||
what you are doing! Rebooting afterwards also is a good idea.
|
||||
This can influence the way your machine is cooled and fans may
|
||||
not get switched on again after you did a wrong write.
|
||||
CAUTION:
|
||||
Do not write to the Embedded Controller if you don't know
|
||||
what you are doing! Rebooting afterwards also is a good idea.
|
||||
This can influence the way your machine is cooled and fans may
|
||||
not get switched on again after you did a wrong write.
|
||||
|
||||
@@ -4,16 +4,15 @@ KernelVersion: 2.6.20
|
||||
Contact: Thomas Maier <balagi@justmail.de>
|
||||
Description:
|
||||
|
||||
debugfs interface
|
||||
-----------------
|
||||
|
||||
The pktcdvd module (packet writing driver) creates
|
||||
these files in debugfs:
|
||||
|
||||
/sys/kernel/debug/pktcdvd/pktcdvd[0-7]/
|
||||
|
||||
==== ====== ====================================
|
||||
info (0444) Lots of driver statistics and infos.
|
||||
==== ====== ====================================
|
||||
|
||||
Example:
|
||||
-------
|
||||
Example::
|
||||
|
||||
cat /sys/kernel/debug/pktcdvd/pktcdvd0/info
|
||||
cat /sys/kernel/debug/pktcdvd/pktcdvd0/info
|
||||
|
||||
@@ -6,6 +6,7 @@ Description: 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.
|
||||
|
||||
@@ -21,6 +22,7 @@ Description: The /dev/kmsg character device node provides userspace access
|
||||
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.
|
||||
|
||||
@@ -48,6 +50,7 @@ Description: The /dev/kmsg character device node provides userspace access
|
||||
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
|
||||
@@ -87,18 +90,22 @@ Description: The /dev/kmsg character device node provides userspace access
|
||||
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
|
||||
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
|
||||
|
||||
============ =================
|
||||
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
|
||||
|
||||
@@ -17,26 +17,33 @@ Description:
|
||||
echoing a value to <securityfs>/evm made up of the
|
||||
following bits:
|
||||
|
||||
=== ==================================================
|
||||
Bit Effect
|
||||
=== ==================================================
|
||||
0 Enable HMAC validation and creation
|
||||
1 Enable digital signature validation
|
||||
2 Permit modification of EVM-protected metadata at
|
||||
runtime. Not supported if HMAC validation and
|
||||
creation is enabled.
|
||||
31 Disable further runtime modification of EVM policy
|
||||
=== ==================================================
|
||||
|
||||
For example:
|
||||
For example::
|
||||
|
||||
echo 1 ><securityfs>/evm
|
||||
echo 1 ><securityfs>/evm
|
||||
|
||||
will enable HMAC validation and creation
|
||||
|
||||
echo 0x80000003 ><securityfs>/evm
|
||||
::
|
||||
|
||||
echo 0x80000003 ><securityfs>/evm
|
||||
|
||||
will enable HMAC and digital signature validation and
|
||||
HMAC creation and disable all further modification of policy.
|
||||
|
||||
echo 0x80000006 ><securityfs>/evm
|
||||
::
|
||||
|
||||
echo 0x80000006 ><securityfs>/evm
|
||||
|
||||
will enable digital signature validation, permit
|
||||
modification of EVM-protected metadata and
|
||||
@@ -65,7 +72,7 @@ Description:
|
||||
Shows the set of extended attributes used to calculate or
|
||||
validate the EVM signature, and allows additional attributes
|
||||
to be added at runtime. Any signatures generated after
|
||||
additional attributes are added (and on files posessing those
|
||||
additional attributes are added (and on files possessing those
|
||||
additional attributes) will only be valid if the same
|
||||
additional attributes are configured on system boot. Writing
|
||||
a single period (.) will lock the xattr list from any further
|
||||
|
||||
@@ -15,19 +15,22 @@ Description:
|
||||
IMA appraisal, if configured, uses these file measurements
|
||||
for local measurement appraisal.
|
||||
|
||||
rule format: action [condition ...]
|
||||
::
|
||||
|
||||
action: measure | dont_measure | appraise | dont_appraise |
|
||||
audit | hash | dont_hash
|
||||
condition:= base | lsm [option]
|
||||
rule format: action [condition ...]
|
||||
|
||||
action: measure | dont_measure | appraise | dont_appraise |
|
||||
audit | hash | dont_hash
|
||||
condition:= base | lsm [option]
|
||||
base: [[func=] [mask=] [fsmagic=] [fsuuid=] [uid=]
|
||||
[euid=] [fowner=] [fsname=]]
|
||||
lsm: [[subj_user=] [subj_role=] [subj_type=]
|
||||
[obj_user=] [obj_role=] [obj_type=]]
|
||||
option: [[appraise_type=]] [template=] [permit_directio]
|
||||
[appraise_flag=] [keyrings=]
|
||||
base: func:= [BPRM_CHECK][MMAP_CHECK][CREDS_CHECK][FILE_CHECK][MODULE_CHECK]
|
||||
[FIRMWARE_CHECK]
|
||||
base:
|
||||
func:= [BPRM_CHECK][MMAP_CHECK][CREDS_CHECK][FILE_CHECK]MODULE_CHECK]
|
||||
[FIRMWARE_CHECK]
|
||||
[KEXEC_KERNEL_CHECK] [KEXEC_INITRAMFS_CHECK]
|
||||
[KEXEC_CMDLINE] [KEY_CHECK]
|
||||
mask:= [[^]MAY_READ] [[^]MAY_WRITE] [[^]MAY_APPEND]
|
||||
@@ -37,8 +40,9 @@ Description:
|
||||
uid:= decimal value
|
||||
euid:= decimal value
|
||||
fowner:= decimal value
|
||||
lsm: are LSM specific
|
||||
option: appraise_type:= [imasig] [imasig|modsig]
|
||||
lsm: are LSM specific
|
||||
option:
|
||||
appraise_type:= [imasig] [imasig|modsig]
|
||||
appraise_flag:= [check_blacklist]
|
||||
Currently, blacklist check is only for files signed with appended
|
||||
signature.
|
||||
@@ -49,7 +53,7 @@ Description:
|
||||
(eg, ima-ng). Only valid when action is "measure".
|
||||
pcr:= decimal value
|
||||
|
||||
default policy:
|
||||
default policy:
|
||||
# PROC_SUPER_MAGIC
|
||||
dont_measure fsmagic=0x9fa0
|
||||
dont_appraise fsmagic=0x9fa0
|
||||
@@ -97,7 +101,8 @@ Description:
|
||||
|
||||
Examples of LSM specific definitions:
|
||||
|
||||
SELinux:
|
||||
SELinux::
|
||||
|
||||
dont_measure obj_type=var_log_t
|
||||
dont_appraise obj_type=var_log_t
|
||||
dont_measure obj_type=auditd_log_t
|
||||
@@ -105,10 +110,11 @@ Description:
|
||||
measure subj_user=system_u func=FILE_CHECK mask=MAY_READ
|
||||
measure subj_role=system_r func=FILE_CHECK mask=MAY_READ
|
||||
|
||||
Smack:
|
||||
Smack::
|
||||
|
||||
measure subj_user=_ func=FILE_CHECK mask=MAY_READ
|
||||
|
||||
Example of measure rules using alternate PCRs:
|
||||
Example of measure rules using alternate PCRs::
|
||||
|
||||
measure func=KEXEC_KERNEL_CHECK pcr=4
|
||||
measure func=KEXEC_INITRAMFS_CHECK pcr=5
|
||||
|
||||
@@ -6,28 +6,32 @@ Description:
|
||||
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)
|
||||
== ===================================
|
||||
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
|
||||
== ===================================
|
||||
15 discards completed successfully
|
||||
16 discards merged
|
||||
17 sectors discarded
|
||||
18 time spent discarding
|
||||
== ===================================
|
||||
|
||||
Kernel 5.5+ appends two more fields for flush requests:
|
||||
|
||||
|
||||
@@ -4,23 +4,27 @@ Contact: Jerome Marchand <jmarchan@redhat.com>
|
||||
Description:
|
||||
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)
|
||||
|
||||
== ==============================================
|
||||
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 Documentation/admin-guide/iostats.rst
|
||||
|
||||
|
||||
|
||||
@@ -8,11 +8,13 @@ Description:
|
||||
|
||||
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.
|
||||
|
||||
@@ -67,14 +67,16 @@ Description:
|
||||
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)
|
||||
=========== ==================================================
|
||||
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).
|
||||
|
||||
@@ -10,7 +10,8 @@ Description:
|
||||
name/value pairs.
|
||||
|
||||
Userspace must be prepared for the possibility that attributes
|
||||
define overlapping bit ranges. For example:
|
||||
define overlapping bit ranges. For example::
|
||||
|
||||
attr1 = 'config:0-23'
|
||||
attr2 = 'config:0-7'
|
||||
attr3 = 'config:12-35'
|
||||
|
||||
@@ -6,15 +6,18 @@ Description:
|
||||
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
|
||||
|
||||
=========== ===============================================
|
||||
-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
|
||||
=========== ===============================================
|
||||
|
||||
@@ -65,6 +65,7 @@ Contact: linux-iio@vger.kernel.org
|
||||
Description:
|
||||
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]"
|
||||
@@ -1627,17 +1628,21 @@ Description:
|
||||
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
|
||||
@@ -1646,8 +1651,10 @@ Description:
|
||||
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 ;
|
||||
@@ -1656,13 +1663,16 @@ Description:
|
||||
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,
|
||||
@@ -1704,6 +1714,7 @@ Description:
|
||||
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.
|
||||
|
||||
|
||||
@@ -5,7 +5,8 @@ Contact: Peter Rosin <peda@axentia.se>
|
||||
Description:
|
||||
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:
|
||||
of a comparator wired to an interrupt pin. Like so::
|
||||
|
||||
_
|
||||
| \
|
||||
input +------>-------|+ \
|
||||
@@ -19,10 +20,12 @@ Description:
|
||||
| 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.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ KernelVersion: 4.7
|
||||
Contact: linux-iio@vger.kernel.org
|
||||
Description:
|
||||
Writing '1' will perform a FOC (Fast Online Calibration). The
|
||||
corresponding calibration offsets can be read from *_calibbias
|
||||
corresponding calibration offsets can be read from `*_calibbias`
|
||||
entries.
|
||||
|
||||
What: /sys/bus/iio/devices/iio:deviceX/location
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user