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