Documentation/ABI/testing/sysfs-class-uwb_rc

   1 What:           /sys/class/uwb_rc
   2 Date:           July 2008
   3 KernelVersion:  2.6.27
   4 Contact:        linux-usb@vger.kernel.org
   5 Description:
   6                 Interfaces for WiMedia Ultra Wideband Common Radio
   7                 Platform (UWB) radio controllers.
   8
   9                 Familiarity with the ECMA-368 'High Rate Ultra
  10                 Wideband MAC and PHY Specification' is assumed.
  11
  12 What:           /sys/class/uwb_rc/beacon_timeout_ms
  13 Date:           July 2008
  14 KernelVersion:  2.6.27
  15 Description:
  16                 If no beacons are received from a device for at least
  17                 this time, the device will be considered to have gone
  18                 and it will be removed.  The default is 3 superframes
  19                 (~197 ms) as required by the specification.
  20
  21 What:           /sys/class/uwb_rc/uwbN/
  22 Date:           July 2008
  23 KernelVersion:  2.6.27
  24 Contact:        linux-usb@vger.kernel.org
  25 Description:
  26                 An individual UWB radio controller.
  27
  28 What:           /sys/class/uwb_rc/uwbN/beacon
  29 Date:           July 2008
  30 KernelVersion:  2.6.27
  31 Contact:        linux-usb@vger.kernel.org
  32 Description:
  33                 Write:
  34
  35                 <channel>
  36
  37                 to force a specific channel to be used when beaconing,
  38                 or, if <channel> is -1, to prohibit beaconing.  If
  39                 <channel> is 0, then the default channel selection
  40                 algorithm will be used.  Valid channels depends on the
  41                 radio controller's supported band groups.
  42
  43                 Reading returns the currently active channel, or -1 if
  44                 the radio controller is not beaconing.
  45
  46 What:           /sys/class/uwb_rc/uwbN/ASIE
  47 Date:           August 2014
  48 KernelVersion:  3.18
  49 Contact:        linux-usb@vger.kernel.org
  50 Description:
  51
  52                 The application-specific information element (ASIE)
  53                 included in this device's beacon, in space separated
  54                 hex octets.
  55
  56                 Reading returns the current ASIE.  Writing replaces
  57                 the current ASIE with the one written.
  58
  59 What:           /sys/class/uwb_rc/uwbN/scan
  60 Date:           July 2008
  61 KernelVersion:  2.6.27
  62 Contact:        linux-usb@vger.kernel.org
  63 Description:
  64                 Write:
  65
  66                 <channel> <type> [<bpst offset>]
  67
  68                 to start (or stop) scanning on a channel.  <type> is one of:
  69                     0 - scan
  70                     1 - scan outside BP
  71                     2 - scan while inactive
  72                     3 - scanning disabled
  73                     4 - scan (with start time of <bpst offset>)
  74
  75 What:           /sys/class/uwb_rc/uwbN/mac_address
  76 Date:           July 2008
  77 KernelVersion:  2.6.27
  78 Contact:        linux-usb@vger.kernel.org
  79 Description:
  80                 The EUI-48, in colon-separated hex octets, for this
  81                 radio controller.  A write will change the radio
  82                 controller's EUI-48 but only do so while the device is
  83                 not beaconing or scanning.
  84
  85 What:           /sys/class/uwb_rc/uwbN/wusbhc
  86 Date:           July 2008
  87 KernelVersion:  2.6.27
  88 Contact:        linux-usb@vger.kernel.org
  89 Description:
  90                 A symlink to the device (if any) of the WUSB Host
  91                 Controller PAL using this radio controller.
  92
  93 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/
  94 Date:           July 2008
  95 KernelVersion:  2.6.27
  96 Contact:        linux-usb@vger.kernel.org
  97 Description:
  98                 A neighbour UWB device that has either been detected
  99                 as part of a scan or is a member of the radio
 100                 controllers beacon group.
 101
 102 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/BPST
 103 Date:           July 2008
 104 KernelVersion:  2.6.27
 105 Contact:        linux-usb@vger.kernel.org
 106 Description:
 107                 The time (using the radio controllers internal 1 ms
 108                 interval superframe timer) of the last beacon from
 109                 this device was received.
 110
 111 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/DevAddr
 112 Date:           July 2008
 113 KernelVersion:  2.6.27
 114 Contact:        linux-usb@vger.kernel.org
 115 Description:
 116                 The current DevAddr of this device in colon separated
 117                 hex octets.
 118
 119 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/EUI_48
 120 Date:           July 2008
 121 KernelVersion:  2.6.27
 122 Contact:        linux-usb@vger.kernel.org
 123 Description:
 124
 125                 The EUI-48 of this device in colon separated hex
 126                 octets.
 127
 128 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/BPST
 129 Date:           July 2008
 130 KernelVersion:  2.6.27
 131 Contact:        linux-usb@vger.kernel.org
 132 Description:
 133
 134 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/IEs
 135 Date:           July 2008
 136 KernelVersion:  2.6.27
 137 Contact:        linux-usb@vger.kernel.org
 138 Description:
 139                 The latest IEs included in this device's beacon, in
 140                 space separated hex octets with one IE per line.
 141
 142 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/LQE
 143 Date:           July 2008
 144 KernelVersion:  2.6.27
 145 Contact:        linux-usb@vger.kernel.org
 146 Description:
 147                 Link Quality Estimate - the Signal to Noise Ratio
 148                 (SNR) of all packets received from this device in dB.
 149                 This gives an estimate on a suitable PHY rate. Refer
 150                 to [ECMA-368] section 13.3 for more details.
 151
 152 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/RSSI
 153 Date:           July 2008
 154 KernelVersion:  2.6.27
 155 Contact:        linux-usb@vger.kernel.org
 156 Description:
 157                 Received Signal Strength Indication - the strength of
 158                 the received signal in dB.  LQE is a more useful
 159                 measure of the radio link quality.