Merge tag 'ntb-5.11' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-bus-i3c
1 What:           /sys/bus/i3c/devices/i3c-<bus-id>
2 KernelVersion:  5.0
3 Contact:        linux-i3c@vger.kernel.org
4 Description:
5                 An I3C bus. This directory will contain one sub-directory per
6                 I3C device present on the bus.
7
8 What:           /sys/bus/i3c/devices/i3c-<bus-id>/current_master
9 KernelVersion:  5.0
10 Contact:        linux-i3c@vger.kernel.org
11 Description:
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
17 What:           /sys/bus/i3c/devices/i3c-<bus-id>/mode
18 KernelVersion:  5.0
19 Contact:        linux-i3c@vger.kernel.org
20 Description:
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
25 What:           /sys/bus/i3c/devices/i3c-<bus-id>/i3c_scl_frequency
26 KernelVersion:  5.0
27 Contact:        linux-i3c@vger.kernel.org
28 Description:
29                 The frequency (expressed in Hz) of the SCL signal when
30                 operating in I3C SDR mode.
31
32 What:           /sys/bus/i3c/devices/i3c-<bus-id>/i2c_scl_frequency
33 KernelVersion:  5.0
34 Contact:        linux-i3c@vger.kernel.org
35 Description:
36                 The frequency (expressed in Hz) of the SCL signal when
37                 operating in I2C mode.
38
39 What:           /sys/bus/i3c/devices/i3c-<bus-id>/dynamic_address
40 KernelVersion:  5.0
41 Contact:        linux-i3c@vger.kernel.org
42 Description:
43                 Dynamic address assigned to the master controller. This
44                 address may change if the bus is re-initialized.
45
46 What:           /sys/bus/i3c/devices/i3c-<bus-id>/bcr
47 KernelVersion:  5.0
48 Contact:        linux-i3c@vger.kernel.org
49 Description:
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
56 What:           /sys/bus/i3c/devices/i3c-<bus-id>/dcr
57 KernelVersion:  5.0
58 Contact:        linux-i3c@vger.kernel.org
59 Description:
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
66 What:           /sys/bus/i3c/devices/i3c-<bus-id>/pid
67 KernelVersion:  5.0
68 Contact:        linux-i3c@vger.kernel.org
69 Description:
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
78 What:           /sys/bus/i3c/devices/i3c-<bus-id>/hdrcap
79 KernelVersion:  5.0
80 Contact:        linux-i3c@vger.kernel.org
81 Description:
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
88                 This entry describes the HDRCAP of the master controller
89                 driving the bus.
90
91 What:           /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>
92 KernelVersion:  5.0
93 Contact:        linux-i3c@vger.kernel.org
94 Description:
95                 An I3C device present on I3C bus identified by <bus-id>. Note
96                 that all devices are represented including the master driving
97                 the bus.
98
99 What:           /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dynamic_address
100 KernelVersion:  5.0
101 Contact:        linux-i3c@vger.kernel.org
102 Description:
103                 Dynamic address assigned to device <bus-id>-<device-pid>. This
104                 address may change if the bus is re-initialized.
105
106 What:           /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/bcr
107 KernelVersion:  5.0
108 Contact:        linux-i3c@vger.kernel.org
109 Description:
110                 BCR stands for Bus Characteristics Register and express the
111                 device capabilities in term of speed, maximum read/write
112                 length, etc. See the I3C specification for more details.
113
114 What:           /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dcr
115 KernelVersion:  5.0
116 Contact:        linux-i3c@vger.kernel.org
117 Description:
118                 DCR stands for Device Characteristics Register and express the
119                 device capabilities in term of exposed features. See the I3C
120                 specification for more details.
121
122 What:           /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/pid
123 KernelVersion:  5.0
124 Contact:        linux-i3c@vger.kernel.org
125 Description:
126                 PID stands for Provisional ID and is used to uniquely identify
127                 a device on a bus. This PID contains information about the
128                 vendor, the part and an instance ID so that several devices of
129                 the same type can be connected on the same bus.
130                 See the I3C specification for more details.
131
132 What:           /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/hdrcap
133 KernelVersion:  5.0
134 Contact:        linux-i3c@vger.kernel.org
135 Description:
136                 Expose the HDR (High Data Rate) capabilities of a device.
137                 Returns a list of supported HDR mode, each element is separated
138                 by space. Modes can be "hdr-ddr", "hdr-tsp" and "hdr-tsl".
139
140                 See the I3C specification for more details about these HDR
141                 modes.
142
143 What:           /sys/bus/i3c/devices/<bus-id>-<device-pid>
144 KernelVersion:  5.0
145 Contact:        linux-i3c@vger.kernel.org
146 Description:
147                 These directories are just symbolic links to
148                 /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>.