Merge git://git.kernel.org/pub/scm/linux/kernel/git/steve/gfs2-3.0-fixes
[deliverable/linux.git] / Documentation / ABI / testing / sysfs-class-uwb_rc
CommitLineData
c8cf2465
DV
1What: /sys/class/uwb_rc
2Date: July 2008
3KernelVersion: 2.6.27
4Contact: linux-usb@vger.kernel.org
5Description:
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
12What: /sys/class/uwb_rc/beacon_timeout_ms
13Date: July 2008
14KernelVersion: 2.6.27
15Description:
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
21What: /sys/class/uwb_rc/uwbN/
22Date: July 2008
23KernelVersion: 2.6.27
24Contact: linux-usb@vger.kernel.org
25Description:
26 An individual UWB radio controller.
27
28What: /sys/class/uwb_rc/uwbN/beacon
29Date: July 2008
30KernelVersion: 2.6.27
31Contact: linux-usb@vger.kernel.org
32Description:
33 Write:
34
6fae35f9 35 <channel>
c8cf2465 36
6fae35f9
DV
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.
c8cf2465 42
6fae35f9
DV
43 Reading returns the currently active channel, or -1 if
44 the radio controller is not beaconing.
c8cf2465
DV
45
46What: /sys/class/uwb_rc/uwbN/scan
47Date: July 2008
48KernelVersion: 2.6.27
49Contact: linux-usb@vger.kernel.org
50Description:
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
62What: /sys/class/uwb_rc/uwbN/mac_address
63Date: July 2008
64KernelVersion: 2.6.27
65Contact: linux-usb@vger.kernel.org
66Description:
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
72What: /sys/class/uwb_rc/uwbN/wusbhc
73Date: July 2008
74KernelVersion: 2.6.27
75Contact: linux-usb@vger.kernel.org
76Description:
77 A symlink to the device (if any) of the WUSB Host
78 Controller PAL using this radio controller.
79
80What: /sys/class/uwb_rc/uwbN/<EUI-48>/
81Date: July 2008
82KernelVersion: 2.6.27
83Contact: linux-usb@vger.kernel.org
84Description:
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
89What: /sys/class/uwb_rc/uwbN/<EUI-48>/BPST
90Date: July 2008
91KernelVersion: 2.6.27
92Contact: linux-usb@vger.kernel.org
93Description:
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
98What: /sys/class/uwb_rc/uwbN/<EUI-48>/DevAddr
99Date: July 2008
100KernelVersion: 2.6.27
101Contact: linux-usb@vger.kernel.org
102Description:
103 The current DevAddr of this device in colon separated
104 hex octets.
105
106What: /sys/class/uwb_rc/uwbN/<EUI-48>/EUI_48
107Date: July 2008
108KernelVersion: 2.6.27
109Contact: linux-usb@vger.kernel.org
110Description:
111
112 The EUI-48 of this device in colon separated hex
113 octets.
114
115What: /sys/class/uwb_rc/uwbN/<EUI-48>/BPST
116Date: July 2008
117KernelVersion: 2.6.27
118Contact: linux-usb@vger.kernel.org
119Description:
120
121What: /sys/class/uwb_rc/uwbN/<EUI-48>/IEs
122Date: July 2008
123KernelVersion: 2.6.27
124Contact: linux-usb@vger.kernel.org
125Description:
126 The latest IEs included in this device's beacon, in
127 space separated hex octets with one IE per line.
128
129What: /sys/class/uwb_rc/uwbN/<EUI-48>/LQE
130Date: July 2008
131KernelVersion: 2.6.27
132Contact: linux-usb@vger.kernel.org
133Description:
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
139What: /sys/class/uwb_rc/uwbN/<EUI-48>/RSSI
140Date: July 2008
141KernelVersion: 2.6.27
142Contact: linux-usb@vger.kernel.org
143Description:
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.
This page took 0.328834 seconds and 5 git commands to generate.