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