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