Merge tag 'asm-generic' of git://git.kernel.org/pub/scm/linux/kernel/git/arnd/asm...
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / sysfs-bus-rapidio
1 What:           /sys/bus/rapidio/devices/nn:d:iiii
2 Description:
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
26 Attributes Common for All RapidIO Devices
27 -----------------------------------------
28
29 What:           /sys/bus/rapidio/devices/nn:d:iiii/did
30 Date:           Nov, 2005
31 KernelVersion:  v2.6.15
32 Contact:        Matt Porter <mporter@kernel.crashing.org>,
33                 Alexandre Bounine <alexandre.bounine@idt.com>
34 Description:
35                 (RO) returns the device identifier
36
37 What:           /sys/bus/rapidio/devices/nn:d:iiii/vid
38 Date:           Nov, 2005
39 KernelVersion:  v2.6.15
40 Contact:        Matt Porter <mporter@kernel.crashing.org>,
41                 Alexandre Bounine <alexandre.bounine@idt.com>
42 Description:
43                 (RO) returns the device vendor identifier
44
45 What:           /sys/bus/rapidio/devices/nn:d:iiii/device_rev
46 Date:           Nov, 2005
47 KernelVersion:  v2.6.15
48 Contact:        Matt Porter <mporter@kernel.crashing.org>,
49                 Alexandre Bounine <alexandre.bounine@idt.com>
50 Description:
51                 (RO) returns the device revision level
52
53 What:           /sys/bus/rapidio/devices/nn:d:iiii/asm_did
54 Date:           Nov, 2005
55 KernelVersion:  v2.6.15
56 Contact:        Matt Porter <mporter@kernel.crashing.org>,
57                 Alexandre Bounine <alexandre.bounine@idt.com>
58 Description:
59                 (RO) returns identifier for the assembly containing the device
60
61 What:           /sys/bus/rapidio/devices/nn:d:iiii/asm_rev
62 Date:           Nov, 2005
63 KernelVersion:  v2.6.15
64 Contact:        Matt Porter <mporter@kernel.crashing.org>,
65                 Alexandre Bounine <alexandre.bounine@idt.com>
66 Description:
67                 (RO) returns revision level of the assembly containing the
68                 device
69
70 What:           /sys/bus/rapidio/devices/nn:d:iiii/asm_vid
71 Date:           Nov, 2005
72 KernelVersion:  v2.6.15
73 Contact:        Matt Porter <mporter@kernel.crashing.org>,
74                 Alexandre Bounine <alexandre.bounine@idt.com>
75 Description:
76                 (RO) returns vendor identifier of the assembly containing the
77                 device
78
79 What:           /sys/bus/rapidio/devices/nn:d:iiii/destid
80 Date:           Mar, 2011
81 KernelVersion:  v2.6.3
82 Contact:        Matt Porter <mporter@kernel.crashing.org>,
83                 Alexandre Bounine <alexandre.bounine@idt.com>
84 Description:
85                 (RO) returns device destination ID assigned by the enumeration
86                 routine
87
88 What:           /sys/bus/rapidio/devices/nn:d:iiii/lprev
89 Date:           Mar, 2011
90 KernelVersion:  v2.6.39
91 Contact:        Matt Porter <mporter@kernel.crashing.org>,
92                 Alexandre Bounine <alexandre.bounine@idt.com>
93 Description:
94                 (RO) returns name of previous device (switch) on the path to the
95                 device that that owns this attribute
96
97 What:           /sys/bus/rapidio/devices/nn:d:iiii/modalias
98 Date:           Jul, 2013
99 KernelVersion:  v3.11
100 Contact:        Matt Porter <mporter@kernel.crashing.org>,
101                 Alexandre Bounine <alexandre.bounine@idt.com>
102 Description:
103                 (RO) returns the device modalias
104
105 What:           /sys/bus/rapidio/devices/nn:d:iiii/config
106 Date:           Nov, 2005
107 KernelVersion:  v2.6.15
108 Contact:        Matt Porter <mporter@kernel.crashing.org>,
109                 Alexandre Bounine <alexandre.bounine@idt.com>
110 Description:
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
118 RapidIO Switch Device Attributes
119 --------------------------------
120
121 RapidIO switches have additional attributes in sysfs. RapidIO subsystem supports
122 common and device-specific sysfs attributes for switches. Because switches are
123 integrated into the RapidIO subsystem, it offers a method to create
124 device-specific sysfs attributes by specifying a callback function that may be
125 set by the switch initialization routine during enumeration or discovery
126 process.
127
128 What:           /sys/bus/rapidio/devices/nn:s:iiii/routes
129 Date:           Nov, 2005
130 KernelVersion:  v2.6.15
131 Contact:        Matt Porter <mporter@kernel.crashing.org>,
132                 Alexandre Bounine <alexandre.bounine@idt.com>
133 Description:
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
138 What:           /sys/bus/rapidio/devices/nn:s:iiii/destid
139 Date:           Mar, 2011
140 KernelVersion:  v2.6.3
141 Contact:        Matt Porter <mporter@kernel.crashing.org>,
142                 Alexandre Bounine <alexandre.bounine@idt.com>
143 Description:
144                 (RO) device destination ID of the associated device that defines
145                 a route to the switch
146
147 What:           /sys/bus/rapidio/devices/nn:s:iiii/hopcount
148 Date:           Mar, 2011
149 KernelVersion:  v2.6.39
150 Contact:        Matt Porter <mporter@kernel.crashing.org>,
151                 Alexandre Bounine <alexandre.bounine@idt.com>
152 Description:
153                 (RO) number of hops on the path to the switch
154
155 What:           /sys/bus/rapidio/devices/nn:s:iiii/lnext
156 Date:           Mar, 2011
157 KernelVersion:  v2.6.39
158 Contact:        Matt Porter <mporter@kernel.crashing.org>,
159                 Alexandre Bounine <alexandre.bounine@idt.com>
160 Description:
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
167 Device-specific Switch Attributes
168 ---------------------------------
169
170 IDT_GEN2-
171
172 What:           /sys/bus/rapidio/devices/nn:s:iiii/errlog
173 Date:           Oct, 2010
174 KernelVersion:  v2.6.37
175 Contact:        Matt Porter <mporter@kernel.crashing.org>,
176                 Alexandre Bounine <alexandre.bounine@idt.com>
177 Description:
178                 (RO) reads contents of device error log until it is empty.
179
180 RapidIO Bus Attributes
181 ----------------------
182
183 What:           /sys/bus/rapidio/scan
184 Date:           May, 2013
185 KernelVersion:  v3.11
186 Contact:        Matt Porter <mporter@kernel.crashing.org>,
187                 Alexandre Bounine <alexandre.bounine@idt.com>
188 Description:
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.