diff options
Diffstat (limited to 'Documentation/rapidio/sysfs.txt')
-rw-r--r-- | Documentation/rapidio/sysfs.txt | 66 |
1 files changed, 58 insertions, 8 deletions
diff --git a/Documentation/rapidio/sysfs.txt b/Documentation/rapidio/sysfs.txt index 271438c0617f..47ce9a5336e1 100644 --- a/Documentation/rapidio/sysfs.txt +++ b/Documentation/rapidio/sysfs.txt | |||
@@ -2,8 +2,8 @@ | |||
2 | 2 | ||
3 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 3 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
4 | 4 | ||
5 | 1. Device Subdirectories | 5 | 1. RapidIO Device Subdirectories |
6 | ------------------------ | 6 | -------------------------------- |
7 | 7 | ||
8 | For each RapidIO device, the RapidIO subsystem creates files in an individual | 8 | For each RapidIO device, the RapidIO subsystem creates files in an individual |
9 | subdirectory with the following name, /sys/bus/rapidio/devices/<device_name>. | 9 | subdirectory with the following name, /sys/bus/rapidio/devices/<device_name>. |
@@ -25,8 +25,8 @@ seen by the enumerating host (destID = 1): | |||
25 | NOTE: An enumerating or discovering endpoint does not create a sysfs entry for | 25 | NOTE: An enumerating or discovering endpoint does not create a sysfs entry for |
26 | itself, this is why an endpoint with destID=1 is not shown in the list. | 26 | itself, this is why an endpoint with destID=1 is not shown in the list. |
27 | 27 | ||
28 | 2. Attributes Common for All Devices | 28 | 2. Attributes Common for All RapidIO Devices |
29 | ------------------------------------ | 29 | -------------------------------------------- |
30 | 30 | ||
31 | Each device subdirectory contains the following informational read-only files: | 31 | Each device subdirectory contains the following informational read-only files: |
32 | 32 | ||
@@ -52,16 +52,16 @@ This attribute is similar in behavior to the "config" attribute of PCI devices | |||
52 | and provides an access to the RapidIO device registers using standard file read | 52 | and provides an access to the RapidIO device registers using standard file read |
53 | and write operations. | 53 | and write operations. |
54 | 54 | ||
55 | 3. Endpoint Device Attributes | 55 | 3. RapidIO Endpoint Device Attributes |
56 | ----------------------------- | 56 | ------------------------------------- |
57 | 57 | ||
58 | Currently Linux RapidIO subsystem does not create any endpoint specific sysfs | 58 | Currently Linux RapidIO subsystem does not create any endpoint specific sysfs |
59 | attributes. It is possible that RapidIO master port drivers and endpoint device | 59 | attributes. It is possible that RapidIO master port drivers and endpoint device |
60 | drivers will add their device-specific sysfs attributes but such attributes are | 60 | drivers will add their device-specific sysfs attributes but such attributes are |
61 | outside the scope of this document. | 61 | outside the scope of this document. |
62 | 62 | ||
63 | 4. Switch Device Attributes | 63 | 4. RapidIO Switch Device Attributes |
64 | --------------------------- | 64 | ----------------------------------- |
65 | 65 | ||
66 | RapidIO switches have additional attributes in sysfs. RapidIO subsystem supports | 66 | RapidIO switches have additional attributes in sysfs. RapidIO subsystem supports |
67 | common and device-specific sysfs attributes for switches. Because switches are | 67 | common and device-specific sysfs attributes for switches. Because switches are |
@@ -106,3 +106,53 @@ attribute: | |||
106 | for that controller always will be 0. | 106 | for that controller always will be 0. |
107 | To initiate RapidIO enumeration/discovery on all available mports | 107 | To initiate RapidIO enumeration/discovery on all available mports |
108 | a user must write '-1' (or RIO_MPORT_ANY) into this attribute file. | 108 | a user must write '-1' (or RIO_MPORT_ANY) into this attribute file. |
109 | |||
110 | |||
111 | 6. RapidIO Bus Controllers/Ports | ||
112 | -------------------------------- | ||
113 | |||
114 | On-chip RapidIO controllers and PCIe-to-RapidIO bridges (referenced as | ||
115 | "Master Port" or "mport") are presented in sysfs as the special class of | ||
116 | devices: "rapidio_port". | ||
117 | |||
118 | The /sys/class/rapidio_port subdirectory contains individual subdirectories | ||
119 | named as "rapidioN" where N = mport ID registered with RapidIO subsystem. | ||
120 | |||
121 | NOTE: An mport ID is not a RapidIO destination ID assigned to a given local | ||
122 | mport device. | ||
123 | |||
124 | Each mport device subdirectory in addition to standard entries contains the | ||
125 | following device-specific attributes: | ||
126 | |||
127 | port_destid - reports RapidIO destination ID assigned to the given RapidIO | ||
128 | mport device. If value 0xFFFFFFFF is returned this means that | ||
129 | no valid destination ID have been assigned to the mport (yet). | ||
130 | Normally, before enumeration/discovery have been executed only | ||
131 | fabric enumerating mports have a valid destination ID assigned | ||
132 | to them using "hdid=..." rapidio module parameter. | ||
133 | sys_size - reports RapidIO common transport system size: | ||
134 | 0 = small (8-bit destination ID, max. 256 devices), | ||
135 | 1 = large (16-bit destination ID, max. 65536 devices). | ||
136 | |||
137 | After enumeration or discovery was performed for a given mport device, | ||
138 | the corresponding subdirectory will also contain subdirectories for each | ||
139 | child RapidIO device connected to the mport. Naming conventions for RapidIO | ||
140 | devices are described in Section 1 above. | ||
141 | |||
142 | The example below shows mport device subdirectory with several child RapidIO | ||
143 | devices attached to it. | ||
144 | |||
145 | [rio@rapidio ~]$ ls /sys/class/rapidio_port/rapidio0/ -l | ||
146 | total 0 | ||
147 | drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0001 | ||
148 | drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0004 | ||
149 | drwxr-xr-x 3 root root 0 Feb 11 15:10 00:e:0007 | ||
150 | drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0002 | ||
151 | drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0003 | ||
152 | drwxr-xr-x 3 root root 0 Feb 11 15:10 00:s:0005 | ||
153 | lrwxrwxrwx 1 root root 0 Feb 11 15:11 device -> ../../../0000:01:00.0 | ||
154 | -r--r--r-- 1 root root 4096 Feb 11 15:11 port_destid | ||
155 | drwxr-xr-x 2 root root 0 Feb 11 15:11 power | ||
156 | lrwxrwxrwx 1 root root 0 Feb 11 15:04 subsystem -> ../../../../../../class/rapidio_port | ||
157 | -r--r--r-- 1 root root 4096 Feb 11 15:11 sys_size | ||
158 | -rw-r--r-- 1 root root 4096 Feb 11 15:04 uevent | ||