aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/ABI/testing/sysfs-bus-i3c
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/ABI/testing/sysfs-bus-i3c')
-rw-r--r--Documentation/ABI/testing/sysfs-bus-i3c146
1 files changed, 146 insertions, 0 deletions
diff --git a/Documentation/ABI/testing/sysfs-bus-i3c b/Documentation/ABI/testing/sysfs-bus-i3c
new file mode 100644
index 000000000000..2f332ec36f82
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-i3c
@@ -0,0 +1,146 @@
1What: /sys/bus/i3c/devices/i3c-<bus-id>
2KernelVersion: 5.0
3Contact: linux-i3c@vger.kernel.org
4Description:
5 An I3C bus. This directory will contain one sub-directory per
6 I3C device present on the bus.
7
8What: /sys/bus/i3c/devices/i3c-<bus-id>/current_master
9KernelVersion: 5.0
10Contact: linux-i3c@vger.kernel.org
11Description:
12 Expose the master that owns the bus (<bus-id>-<master-pid>) at
13 the time this file is read. Note that bus ownership can change
14 overtime, so there's no guarantee that when the read() call
15 returns, the value returned is still valid.
16
17What: /sys/bus/i3c/devices/i3c-<bus-id>/mode
18KernelVersion: 5.0
19Contact: linux-i3c@vger.kernel.org
20Description:
21 I3C bus mode. Can be "pure", "mixed-fast" or "mixed-slow". See
22 the I3C specification for a detailed description of what each
23 of these modes implies.
24
25What: /sys/bus/i3c/devices/i3c-<bus-id>/i3c_scl_frequency
26KernelVersion: 5.0
27Contact: linux-i3c@vger.kernel.org
28Description:
29 The frequency (expressed in Hz) of the SCL signal when
30 operating in I3C SDR mode.
31
32What: /sys/bus/i3c/devices/i3c-<bus-id>/i2c_scl_frequency
33KernelVersion: 5.0
34Contact: linux-i3c@vger.kernel.org
35Description:
36 The frequency (expressed in Hz) of the SCL signal when
37 operating in I2C mode.
38
39What: /sys/bus/i3c/devices/i3c-<bus-id>/dynamic_address
40KernelVersion: 5.0
41Contact: linux-i3c@vger.kernel.org
42Description:
43 Dynamic address assigned to the master controller. This
44 address may change if the bus is re-initialized.
45
46What: /sys/bus/i3c/devices/i3c-<bus-id>/bcr
47KernelVersion: 5.0
48Contact: linux-i3c@vger.kernel.org
49Description:
50 BCR stands for Bus Characteristics Register and express the
51 device capabilities in term of speed, maximum read/write
52 length, etc. See the I3C specification for more details.
53 This entry describes the BCR of the master controller driving
54 the bus.
55
56What: /sys/bus/i3c/devices/i3c-<bus-id>/dcr
57KernelVersion: 5.0
58Contact: linux-i3c@vger.kernel.org
59Description:
60 DCR stands for Device Characteristics Register and express the
61 device capabilities in term of exposed features. See the I3C
62 specification for more details.
63 This entry describes the DCR of the master controller driving
64 the bus.
65
66What: /sys/bus/i3c/devices/i3c-<bus-id>/pid
67KernelVersion: 5.0
68Contact: linux-i3c@vger.kernel.org
69Description:
70 PID stands for Provisional ID and is used to uniquely identify
71 a device on a bus. This PID contains information about the
72 vendor, the part and an instance ID so that several devices of
73 the same type can be connected on the same bus.
74 See the I3C specification for more details.
75 This entry describes the PID of the master controller driving
76 the bus.
77
78What: /sys/bus/i3c/devices/i3c-<bus-id>/hdrcap
79KernelVersion: 5.0
80Contact: linux-i3c@vger.kernel.org
81Description:
82 Expose the HDR (High Data Rate) capabilities of a device.
83 Returns a list of supported HDR mode, each element is separated
84 by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
85 See the I3C specification for more details about these HDR
86 modes.
87 This entry describes the HDRCAP of the master controller
88 driving the bus.
89
90What: /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>
91KernelVersion: 5.0
92Contact: linux-i3c@vger.kernel.org
93Description:
94 An I3C device present on I3C bus identified by <bus-id>. Note
95 that all devices are represented including the master driving
96 the bus.
97
98What: /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dynamic_address
99KernelVersion: 5.0
100Contact: linux-i3c@vger.kernel.org
101Description:
102 Dynamic address assigned to device <bus-id>-<device-pid>. This
103 address may change if the bus is re-initialized.
104
105What: /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/bcr
106KernelVersion: 5.0
107Contact: linux-i3c@vger.kernel.org
108Description:
109 BCR stands for Bus Characteristics Register and express the
110 device capabilities in term of speed, maximum read/write
111 length, etc. See the I3C specification for more details.
112
113What: /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dcr
114KernelVersion: 5.0
115Contact: linux-i3c@vger.kernel.org
116Description:
117 DCR stands for Device Characteristics Register and express the
118 device capabilities in term of exposed features. See the I3C
119 specification for more details.
120
121What: /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/pid
122KernelVersion: 5.0
123Contact: linux-i3c@vger.kernel.org
124Description:
125 PID stands for Provisional ID and is used to uniquely identify
126 a device on a bus. This PID contains information about the
127 vendor, the part and an instance ID so that several devices of
128 the same type can be connected on the same bus.
129 See the I3C specification for more details.
130
131What: /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/hdrcap
132KernelVersion: 5.0
133Contact: linux-i3c@vger.kernel.org
134Description:
135 Expose the HDR (High Data Rate) capabilities of a device.
136 Returns a list of supported HDR mode, each element is separated
137 by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
138 See the I3C specification for more details about these HDR
139 modes.
140
141What: /sys/bus/i3c/devices/<bus-id>-<device-pid>
142KernelVersion: 5.0
143Contact: linux-i3c@vger.kernel.org
144Description:
145 These directories are just symbolic links to
146 /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>.
generated by cgit v1.2.2 (git 2.25.0) at 2025-04-26 09:27:16 -0400