summaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/sysfs-bus-i3c
blob: 1f4a2662335bb1a68cd401c1a6b85056994eb94b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
What:		/sys/bus/i3c/devices/i3c-<bus-id>
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		An I3C bus. This directory will contain one sub-directory per
		I3C device present on the bus.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/current_master
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/mode
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/i3c_scl_frequency
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		The frequency (expressed in Hz) of the SCL signal when
		operating in I3C SDR mode.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/i2c_scl_frequency
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		The frequency (expressed in Hz) of the SCL signal when
		operating in I2C mode.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/dynamic_address
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		Dynamic address assigned to the master controller. This
		address may change if the bus is re-initialized.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/bcr
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/dcr
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/pid
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/hdrcap
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		An I3C device present on I3C bus identified by <bus-id>. Note
		that all devices are represented including the master driving
		the bus.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dynamic_address
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		Dynamic address assigned to device <bus-id>-<device-pid>. This
		address may change if the bus is re-initialized.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/bcr
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/dcr
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		DCR stands for Device Characteristics Register and express the
		device capabilities in term of exposed features. See the I3C
		specification for more details.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/pid
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>/hdrcap
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		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.

What:		/sys/bus/i3c/devices/<bus-id>-<device-pid>
KernelVersion:  5.0
Contact:	linux-i3c@vger.kernel.org
Description:
		These directories are just symbolic links to
		/sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>.