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
  70                    ==   =======================================
  71                     0   scan
  72                     1   scan outside BP
  73                     2   scan while inactive
  74                     3   scanning disabled
  75                     4   scan (with start time of <bpst offset>)
  76                    ==   =======================================
  77
  78 What:           /sys/class/uwb_rc/uwbN/mac_address
  79 Date:           July 2008
  80 KernelVersion:  2.6.27
  81 Contact:        linux-usb@vger.kernel.org
  82 Description:
  83                 The EUI-48, in colon-separated hex octets, for this
  84                 radio controller.  A write will change the radio
  85                 controller's EUI-48 but only do so while the device is
  86                 not beaconing or scanning.
  87
  88 What:           /sys/class/uwb_rc/uwbN/wusbhc
  89 Date:           July 2008
  90 KernelVersion:  2.6.27
  91 Contact:        linux-usb@vger.kernel.org
  92 Description:
  93                 A symlink to the device (if any) of the WUSB Host
  94                 Controller PAL using this radio controller.
  95
  96 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/
  97 Date:           July 2008
  98 KernelVersion:  2.6.27
  99 Contact:        linux-usb@vger.kernel.org
 100 Description:
 101                 A neighbour UWB device that has either been detected
 102                 as part of a scan or is a member of the radio
 103                 controllers beacon group.
 104
 105 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/BPST
 106 Date:           July 2008
 107 KernelVersion:  2.6.27
 108 Contact:        linux-usb@vger.kernel.org
 109 Description:
 110                 The time (using the radio controllers internal 1 ms
 111                 interval superframe timer) of the last beacon from
 112                 this device was received.
 113
 114 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/DevAddr
 115 Date:           July 2008
 116 KernelVersion:  2.6.27
 117 Contact:        linux-usb@vger.kernel.org
 118 Description:
 119                 The current DevAddr of this device in colon separated
 120                 hex octets.
 121
 122 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/EUI_48
 123 Date:           July 2008
 124 KernelVersion:  2.6.27
 125 Contact:        linux-usb@vger.kernel.org
 126 Description:
 127
 128                 The EUI-48 of this device in colon separated hex
 129                 octets.
 130
 131 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/IEs
 132 Date:           July 2008
 133 KernelVersion:  2.6.27
 134 Contact:        linux-usb@vger.kernel.org
 135 Description:
 136                 The latest IEs included in this device's beacon, in
 137                 space separated hex octets with one IE per line.
 138
 139 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/LQE
 140 Date:           July 2008
 141 KernelVersion:  2.6.27
 142 Contact:        linux-usb@vger.kernel.org
 143 Description:
 144                 Link Quality Estimate - the Signal to Noise Ratio
 145                 (SNR) of all packets received from this device in dB.
 146                 This gives an estimate on a suitable PHY rate. Refer
 147                 to [ECMA-368] section 13.3 for more details.
 148
 149 What:           /sys/class/uwb_rc/uwbN/<EUI-48>/RSSI
 150 Date:           July 2008
 151 KernelVersion:  2.6.27
 152 Contact:        linux-usb@vger.kernel.org
 153 Description:
 154                 Received Signal Strength Indication - the strength of
 155                 the received signal in dB.  LQE is a more useful
 156                 measure of the radio link quality.