drivers/staging/most/Documentation/ABI/sysfs-class-most.txt

   1 What:           /sys/class/most/mostcore/aims
   2 Date:           June 2015
   3 KernelVersion:  4.3
   4 Contact:        Christian Gromm <christian.gromm@microchip.com>
   5 Description:
   6                 List of AIMs that have been loaded.
   7 Users:
   8
   9 What:           /sys/class/most/mostcore/aims/<aim>/add_link
  10 Date:           June 2015
  11 KernelVersion:  4.3
  12 Contact:        Christian Gromm <christian.gromm@microchip.com>
  13 Description:
  14                 This is used to establish a connection of a channel and the
  15                 current AIM.
  16 Users:
  17
  18 What:           /sys/class/most/mostcore/aims/<aim>/remove_link
  19 Date:           June 2015
  20 KernelVersion:  4.3
  21 Contact:        Christian Gromm <christian.gromm@microchip.com>
  22 Description:
  23                 This is used to remove a connected channel from the
  24                 current AIM.
  25 Users:
  26
  27 What:           /sys/class/most/mostcore/devices
  28 Date:           June 2015
  29 KernelVersion:  4.3
  30 Contact:        Christian Gromm <christian.gromm@microchip.com>
  31 Description:
  32                 List of attached MOST interfaces.
  33 Users:
  34
  35 What:           /sys/class/most/mostcore/devices/<mdev>/description
  36 Date:           June 2015
  37 KernelVersion:  4.3
  38 Contact:        Christian Gromm <christian.gromm@microchip.com>
  39 Description:
  40                 Provides information about the interface type and the physical
  41                 location of the device. Hardware attached via USB, for instance,
  42                 might return <usb_device 1-1.1:1.0>
  43 Users:
  44
  45 What:           /sys/class/most/mostcore/devices/<mdev>/interface
  46 Date:           June 2015
  47 KernelVersion:  4.3
  48 Contact:        Christian Gromm <christian.gromm@microchip.com>
  49 Description:
  50                 Indicates the type of peripheral interface the current device
  51                 uses.
  52 Users:
  53
  54 What:           /sys/class/most/mostcore/devices/<mdev>/dci
  55 Date:           June 2016
  56 KernelVersion:  4.9
  57 Contact:        Christian Gromm <christian.gromm@microchip.com>
  58 Description:
  59                 If the network interface controller is attached via USB, a dci
  60                 directory is created that allows applications to use the
  61                 controller's direct communication interface (DCI) to exchange
  62                 information.
  63 Users:
  64
  65 What:           /sys/class/most/mostcore/devices/<mdev>/dci/arb_address
  66 Date:           June 2016
  67 KernelVersion:  4.9
  68 Contact:        Christian Gromm <christian.gromm@microchip.com>
  69 Description:
  70                 This is used to set an arbitrary DCI register address an
  71                 application wants to read from or write to.
  72 Users:
  73
  74 What:           /sys/class/most/mostcore/devices/<mdev>/dci/arb_value
  75 Date:           June 2016
  76 KernelVersion:  4.9
  77 Contact:        Christian Gromm <christian.gromm@microchip.com>
  78 Description:
  79                 This is used to read from or write to the arbitrary DCI register
  80                 whose address is stored in arb_address.
  81 Users:
  82
  83 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_eui48_hi
  84 Date:           June 2016
  85 KernelVersion:  4.9
  86 Contact:        Christian Gromm <christian.gromm@microchip.com>
  87 Description:
  88                 This is used to check and configure the MAC address.
  89 Users:
  90
  91 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_eui48_lo
  92 Date:           June 2016
  93 KernelVersion:  4.9
  94 Contact:        Christian Gromm <christian.gromm@microchip.com>
  95 Description:
  96                 This is used to check and configure the MAC address.
  97 Users:
  98
  99 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_eui48_mi
 100 Date:           June 2016
 101 KernelVersion:  4.9
 102 Contact:        Christian Gromm <christian.gromm@microchip.com>
 103 Description:
 104                 This is used to check and configure the MAC address.
 105 Users:
 106
 107 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_filter
 108 Date:           June 2016
 109 KernelVersion:  4.9
 110 Contact:        Christian Gromm <christian.gromm@microchip.com>
 111 Description:
 112                 This is used to check and configure the MEP filter address.
 113 Users:
 114
 115 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_hash0
 116 Date:           June 2016
 117 KernelVersion:  4.9
 118 Contact:        Christian Gromm <christian.gromm@microchip.com>
 119 Description:
 120                 This is used to check and configure the MEP hash table.
 121 Users:
 122
 123 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_hash1
 124 Date:           June 2016
 125 KernelVersion:  4.9
 126 Contact:        Christian Gromm <christian.gromm@microchip.com>
 127 Description:
 128                 This is used to check and configure the MEP hash table.
 129 Users:
 130
 131 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_hash2
 132 Date:           June 2016
 133 KernelVersion:  4.9
 134 Contact:        Christian Gromm <christian.gromm@microchip.com>
 135 Description:
 136                 This is used to check and configure the MEP hash table.
 137 Users:
 138
 139 What:           /sys/class/most/mostcore/devices/<mdev>/dci/mep_hash3
 140 Date:           June 2016
 141 KernelVersion:  4.9
 142 Contact:        Christian Gromm <christian.gromm@microchip.com>
 143 Description:
 144                 This is used to check and configure the MEP hash table.
 145 Users:
 146
 147 What:           /sys/class/most/mostcore/devices/<mdev>/dci/ni_state
 148 Date:           June 2016
 149 KernelVersion:  4.9
 150 Contact:        Christian Gromm <christian.gromm@microchip.com>
 151 Description:
 152                 Indicates the current network interface state.
 153 Users:
 154
 155 What:           /sys/class/most/mostcore/devices/<mdev>/dci/node_address
 156 Date:           June 2016
 157 KernelVersion:  4.9
 158 Contact:        Christian Gromm <christian.gromm@microchip.com>
 159 Description:
 160                 Indicates the current node address.
 161 Users:
 162
 163 What:           /sys/class/most/mostcore/devices/<mdev>/dci/node_position
 164 Date:           June 2016
 165 KernelVersion:  4.9
 166 Contact:        Christian Gromm <christian.gromm@microchip.com>
 167 Description:
 168                 Indicates the current node position.
 169 Users:
 170
 171 What:           /sys/class/most/mostcore/devices/<mdev>/dci/packet_bandwidth
 172 Date:           June 2016
 173 KernelVersion:  4.9
 174 Contact:        Christian Gromm <christian.gromm@microchip.com>
 175 Description:
 176                 Indicates the configured packet bandwidth.
 177 Users:
 178
 179 What:           /sys/class/most/mostcore/devices/<mdev>/dci/sync_ep
 180 Date:           June 2016
 181 KernelVersion:  4.9
 182 Contact:        Christian Gromm <christian.gromm@microchip.com>
 183 Description:
 184                 Triggers the controller's synchronization process for a certain
 185                 endpoint.
 186 Users:
 187
 188 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/
 189 Date:           June 2015
 190 KernelVersion:  4.3
 191 Contact:        Christian Gromm <christian.gromm@microchip.com>
 192 Description:
 193                 For every channel of the device a directory is created, whose
 194                 name is dictated by the HDM. This enables an application to
 195                 collect information about the channel's capabilities and
 196                 configure it.
 197 Users:
 198
 199 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/available_datatypes
 200 Date:           June 2015
 201 KernelVersion:  4.3
 202 Contact:        Christian Gromm <christian.gromm@microchip.com>
 203 Description:
 204                 Indicates the data types the current channel can transport.
 205 Users:
 206
 207 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/available_directions
 208 Date:           June 2015
 209 KernelVersion:  4.3
 210 Contact:        Christian Gromm <christian.gromm@microchip.com>
 211 Description:
 212                 Indicates the directions the current channel is capable of.
 213 Users:
 214
 215 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/number_of_packet_buffers
 216 Date:           June 2015
 217 KernelVersion:  4.3
 218 Contact:        Christian Gromm <christian.gromm@microchip.com>
 219 Description:
 220                 Indicates the number of packet buffers the current channel can
 221                 handle.
 222 Users:
 223
 224 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/number_of_stream_buffers
 225 Date:           June 2015
 226 KernelVersion:  4.3
 227 Contact:        Christian Gromm <christian.gromm@microchip.com>
 228 Description:
 229                 Indicates the number of streaming buffers the current channel can
 230                 handle.
 231 Users:
 232
 233 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/size_of_packet_buffer
 234 Date:           June 2015
 235 KernelVersion:  4.3
 236 Contact:        Christian Gromm <christian.gromm@microchip.com>
 237 Description:
 238                 Indicates the size of a packet buffer the current channel can
 239                 handle.
 240 Users:
 241
 242 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/size_of_stream_buffer
 243 Date:           June 2015
 244 KernelVersion:  4.3
 245 Contact:        Christian Gromm <christian.gromm@microchip.com>
 246 Description:
 247                 Indicates the size of a streaming buffer the current channel can
 248                 handle.
 249 Users:
 250
 251 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_number_of_buffers
 252 Date:           June 2015
 253 KernelVersion:  4.3
 254 Contact:        Christian Gromm <christian.gromm@microchip.com>
 255 Description:
 256                 This is to configure the number of buffers of the current channel.
 257 Users:
 258
 259 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_buffer_size
 260 Date:           June 2015
 261 KernelVersion:  4.3
 262 Contact:        Christian Gromm <christian.gromm@microchip.com>
 263 Description:
 264                 This is to configure the size of a buffer of the current channel.
 265 Users:
 266
 267 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_direction
 268 Date:           June 2015
 269 KernelVersion:  4.3
 270 Contact:        Christian Gromm <christian.gromm@microchip.com>
 271 Description:
 272                 This is to configure the direction of the current channel.
 273                 The following strings will be accepted:
 274                         'dir_tx',
 275                         'dir_rx'
 276 Users:
 277
 278 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_datatype
 279 Date:           June 2015
 280 KernelVersion:  4.3
 281 Contact:        Christian Gromm <christian.gromm@microchip.com>
 282 Description:
 283                 This is to configure the data type of the current channel.
 284                 The following strings will be accepted:
 285                         'control',
 286                         'async',
 287                         'sync',
 288                         'isoc_avp'
 289 Users:
 290
 291 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_subbuffer_size
 292 Date:           June 2015
 293 KernelVersion:  4.3
 294 Contact:        Christian Gromm <christian.gromm@microchip.com>
 295 Description:
 296                 This is to configure the subbuffer size of the current channel.
 297 Users:
 298
 299 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_packets_per_xact
 300 Date:           June 2015
 301 KernelVersion:  4.3
 302 Contact:        Christian Gromm <christian.gromm@microchip.com>
 303 Description:
 304                 This is to configure the number of packets per transaction of
 305                 the current channel. This is only needed network interface
 306                 controller is attached via USB.
 307 Users:
 308
 309 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/channel_starving
 310 Date:           June 2015
 311 KernelVersion:  4.3
 312 Contact:        Christian Gromm <christian.gromm@microchip.com>
 313 Description:
 314                 Indicates whether current channel ran out of buffers.
 315 Users: