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