xref: /linux/Documentation/ABI/testing/sysfs-bus-rapidio (revision 71e2f4dd5a65bd8dbca0b77661e75eea471168f8)
1What:		/sys/bus/rapidio/devices/nn:d:iiii
2Description:
3		For each RapidIO device, the RapidIO subsystem creates files in
4		an individual subdirectory with the following name format of
5		device_name "nn:d:iiii", where:
6
7		nn   - two-digit hexadecimal ID of RapidIO network where the
8		       device resides
9		d    - device type: 'e' - for endpoint or 's' - for switch
10		iiii - four-digit device destID for endpoints, or switchID for
11		       switches
12
13		For example, below is a list of device directories that
14		represents a typical RapidIO network with one switch, one host,
15		and two agent endpoints, as it is seen by the enumerating host
16		(with destID = 1):
17
18		/sys/bus/rapidio/devices/00:e:0000
19		/sys/bus/rapidio/devices/00:e:0002
20		/sys/bus/rapidio/devices/00:s:0001
21
22		NOTE: An enumerating or discovering endpoint does not create a
23		sysfs entry for itself, this is why an endpoint with destID=1 is
24		not shown in the list.
25
26Attributes Common for All RapidIO Devices
27-----------------------------------------
28
29What:		/sys/bus/rapidio/devices/nn:d:iiii/did
30Date:		Nov, 2005
31KernelVersion:	v2.6.15
32Contact:	Matt Porter <mporter@kernel.crashing.org>,
33		Alexandre Bounine <alexandre.bounine@idt.com>
34Description:
35		(RO) returns the device identifier
36
37What:		/sys/bus/rapidio/devices/nn:d:iiii/vid
38Date:		Nov, 2005
39KernelVersion:	v2.6.15
40Contact:	Matt Porter <mporter@kernel.crashing.org>,
41		Alexandre Bounine <alexandre.bounine@idt.com>
42Description:
43		(RO) returns the device vendor identifier
44
45What:		/sys/bus/rapidio/devices/nn:d:iiii/device_rev
46Date:		Nov, 2005
47KernelVersion:	v2.6.15
48Contact:	Matt Porter <mporter@kernel.crashing.org>,
49		Alexandre Bounine <alexandre.bounine@idt.com>
50Description:
51		(RO) returns the device revision level
52
53What:		/sys/bus/rapidio/devices/nn:d:iiii/asm_did
54Date:		Nov, 2005
55KernelVersion:	v2.6.15
56Contact:	Matt Porter <mporter@kernel.crashing.org>,
57		Alexandre Bounine <alexandre.bounine@idt.com>
58Description:
59		(RO) returns identifier for the assembly containing the device
60
61What:		/sys/bus/rapidio/devices/nn:d:iiii/asm_rev
62Date:		Nov, 2005
63KernelVersion:	v2.6.15
64Contact:	Matt Porter <mporter@kernel.crashing.org>,
65		Alexandre Bounine <alexandre.bounine@idt.com>
66Description:
67		(RO) returns revision level of the assembly containing the
68		device
69
70What:		/sys/bus/rapidio/devices/nn:d:iiii/asm_vid
71Date:		Nov, 2005
72KernelVersion:	v2.6.15
73Contact:	Matt Porter <mporter@kernel.crashing.org>,
74		Alexandre Bounine <alexandre.bounine@idt.com>
75Description:
76		(RO) returns vendor identifier of the assembly containing the
77		device
78
79What:		/sys/bus/rapidio/devices/nn:d:iiii/destid
80Date:		Mar, 2011
81KernelVersion:	v2.6.3
82Contact:	Matt Porter <mporter@kernel.crashing.org>,
83		Alexandre Bounine <alexandre.bounine@idt.com>
84Description:
85		(RO) returns device destination ID assigned by the enumeration
86		routine
87
88What:		/sys/bus/rapidio/devices/nn:d:iiii/lprev
89Date:		Mar, 2011
90KernelVersion:	v2.6.39
91Contact:	Matt Porter <mporter@kernel.crashing.org>,
92		Alexandre Bounine <alexandre.bounine@idt.com>
93Description:
94		(RO) returns name of previous device (switch) on the path to the
95		device that that owns this attribute
96
97What:		/sys/bus/rapidio/devices/nn:d:iiii/modalias
98Date:		Jul, 2013
99KernelVersion:	v3.11
100Contact:	Matt Porter <mporter@kernel.crashing.org>,
101		Alexandre Bounine <alexandre.bounine@idt.com>
102Description:
103		(RO) returns the device modalias
104
105What:		/sys/bus/rapidio/devices/nn:d:iiii/config
106Date:		Nov, 2005
107KernelVersion:	v2.6.15
108Contact:	Matt Porter <mporter@kernel.crashing.org>,
109		Alexandre Bounine <alexandre.bounine@idt.com>
110Description:
111		(RW) Binary attribute to read from and write to the device
112		configuration registers using the RapidIO maintenance
113		transactions. This attribute is similar in behaviour to the
114		"config" attribute of PCI devices and provides an access to the
115		RapidIO device registers using standard file read and write
116		operations.
117
118RapidIO Switch Device Attributes
119--------------------------------
120
121RapidIO switches have additional attributes in sysfs. RapidIO subsystem supports
122common and device-specific sysfs attributes for switches. Because switches are
123integrated into the RapidIO subsystem, it offers a method to create
124device-specific sysfs attributes by specifying a callback function that may be
125set by the switch initialization routine during enumeration or discovery
126process.
127
128What:		/sys/bus/rapidio/devices/nn:s:iiii/routes
129Date:		Nov, 2005
130KernelVersion:	v2.6.15
131Contact:	Matt Porter <mporter@kernel.crashing.org>,
132		Alexandre Bounine <alexandre.bounine@idt.com>
133Description:
134		(RO) reports switch routing information in "destID port" format.
135		This attribute reports only valid routing table entries, one
136		line for each entry.
137
138What:		/sys/bus/rapidio/devices/nn:s:iiii/destid
139Date:		Mar, 2011
140KernelVersion:	v2.6.3
141Contact:	Matt Porter <mporter@kernel.crashing.org>,
142		Alexandre Bounine <alexandre.bounine@idt.com>
143Description:
144		(RO) device destination ID of the associated device that defines
145		a route to the switch
146
147What:		/sys/bus/rapidio/devices/nn:s:iiii/hopcount
148Date:		Mar, 2011
149KernelVersion:	v2.6.39
150Contact:	Matt Porter <mporter@kernel.crashing.org>,
151		Alexandre Bounine <alexandre.bounine@idt.com>
152Description:
153		(RO) number of hops on the path to the switch
154
155What:		/sys/bus/rapidio/devices/nn:s:iiii/lnext
156Date:		Mar, 2011
157KernelVersion:	v2.6.39
158Contact:	Matt Porter <mporter@kernel.crashing.org>,
159		Alexandre Bounine <alexandre.bounine@idt.com>
160Description:
161		(RO) returns names of devices linked to the switch except one of
162		a device linked to the ingress port (reported as "lprev"). This
163		is an array names with number of lines equal to number of ports
164		in switch. If a switch port has no attached device, returns
165		"null" instead of a device name.
166
167Device-specific Switch Attributes
168---------------------------------
169
170IDT_GEN2-
171
172What:		/sys/bus/rapidio/devices/nn:s:iiii/errlog
173Date:		Oct, 2010
174KernelVersion:	v2.6.37
175Contact:	Matt Porter <mporter@kernel.crashing.org>,
176		Alexandre Bounine <alexandre.bounine@idt.com>
177Description:
178		(RO) reads contents of device error log until it is empty.
179
180RapidIO Bus Attributes
181----------------------
182
183What:		/sys/bus/rapidio/scan
184Date:		May, 2013
185KernelVersion:	v3.11
186Contact:	Matt Porter <mporter@kernel.crashing.org>,
187		Alexandre Bounine <alexandre.bounine@idt.com>
188Description:
189		(WO) Allows to trigger enumeration discovery process from user
190		space. To initiate an enumeration or discovery process on
191		specific mport device, a user needs to write mport_ID (not
192		RapidIO destination ID) into this file. The mport_ID is a
193		sequential number (0 ...  RIO_MAX_MPORTS) assigned to the mport
194		device. For example, for a machine with a single RapidIO
195		controller, mport_ID for that controller always will be 0. To
196		initiate RapidIO enumeration/discovery on all available mports a
197		user must write '-1' (or RIO_MPORT_ANY) into this attribute
198		file.
199