tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
uwb: document UWB and WUSB sysfs files
Add some brief documentation on the UWB and WUSB related sysfs files.
Signed-off-by: David Vrabel <david.vrabel@csr.com>
authored by
David Vrabel
and committed by
David Vrabel
c8cf2465
b60066c1
+340
+28
Documentation/ABI/testing/sysfs-bus-umc
+28
Documentation/ABI/testing/sysfs-bus-umc
···
1
+
What: /sys/bus/umc/
2
+
Date: July 2008
3
+
KernelVersion: 2.6.27
4
+
Contact: David Vrabel <david.vrabel@csr.com>
5
+
Description:
6
+
The Wireless Host Controller Interface (WHCI)
7
+
specification describes a PCI-based device with
8
+
multiple capabilities; the UWB Multi-interface
9
+
Controller (UMC).
10
+
11
+
The umc bus presents each of the individual
12
+
capabilties as a device.
13
+
14
+
What: /sys/bus/umc/devices/.../capability_id
15
+
Date: July 2008
16
+
KernelVersion: 2.6.27
17
+
Contact: David Vrabel <david.vrabel@csr.com>
18
+
Description:
19
+
The ID of this capability, with 0 being the radio
20
+
controller capability.
21
+
22
+
What: /sys/bus/umc/devices/.../version
23
+
Date: July 2008
24
+
KernelVersion: 2.6.27
25
+
Contact: David Vrabel <david.vrabel@csr.com>
26
+
Description:
27
+
The specification version this capability's hardware
28
+
interface complies with.
+43
Documentation/ABI/testing/sysfs-bus-usb
+43
Documentation/ABI/testing/sysfs-bus-usb
···
85
85
Users:
86
86
PowerTOP <power@bughost.org>
87
87
http://www.lesswatts.org/projects/powertop/
88
+
89
+
What: /sys/bus/usb/device/.../authorized
90
+
Date: July 2008
91
+
KernelVersion: 2.6.26
92
+
Contact: David Vrabel <david.vrabel@csr.com>
93
+
Description:
94
+
Authorized devices are available for use by device
95
+
drivers, non-authorized one are not. By default, wired
96
+
USB devices are authorized.
97
+
98
+
Certified Wireless USB devices are not authorized
99
+
initially and should be (by writing 1) after the
100
+
device has been authenticated.
101
+
102
+
What: /sys/bus/usb/device/.../wusb_cdid
103
+
Date: July 2008
104
+
KernelVersion: 2.6.27
105
+
Contact: David Vrabel <david.vrabel@csr.com>
106
+
Description:
107
+
For Certified Wireless USB devices only.
108
+
109
+
A devices's CDID, as 16 space-separated hex octets.
110
+
111
+
What: /sys/bus/usb/device/.../wusb_ck
112
+
Date: July 2008
113
+
KernelVersion: 2.6.27
114
+
Contact: David Vrabel <david.vrabel@csr.com>
115
+
Description:
116
+
For Certified Wireless USB devices only.
117
+
118
+
Write the device's connection key (CK) to start the
119
+
authentication of the device. The CK is 16
120
+
space-separated hex octets.
121
+
122
+
What: /sys/bus/usb/device/.../wusb_disconnect
123
+
Date: July 2008
124
+
KernelVersion: 2.6.27
125
+
Contact: David Vrabel <david.vrabel@csr.com>
126
+
Description:
127
+
For Certified Wireless USB devices only.
128
+
129
+
Write a 1 to force the device to disconnect
130
+
(equivalent to unplugging a wired USB device).
+25
Documentation/ABI/testing/sysfs-class-usb_host
+25
Documentation/ABI/testing/sysfs-class-usb_host
···
1
+
What: /sys/class/usb_host/usb_hostN/wusb_chid
2
+
Date: July 2008
3
+
KernelVersion: 2.6.27
4
+
Contact: David Vrabel <david.vrabel@csr.com>
5
+
Description:
6
+
Write the CHID (16 space-separated hex octets) for this host controller.
7
+
This starts the host controller, allowing it to accept connection from
8
+
WUSB devices.
9
+
10
+
Set an all zero CHID to stop the host controller.
11
+
12
+
What: /sys/class/usb_host/usb_hostN/wusb_trust_timeout
13
+
Date: July 2008
14
+
KernelVersion: 2.6.27
15
+
Contact: David Vrabel <david.vrabel@csr.com>
16
+
Description:
17
+
Devices that haven't sent a WUSB packet to the host
18
+
within 'wusb_trust_timeout' ms are considered to have
19
+
disconnected and are removed. The default value of
20
+
4000 ms is the value required by the WUSB
21
+
specification.
22
+
23
+
Since this relates to security (specifically, the
24
+
lifetime of PTKs and GTKs) it should not be changed
25
+
from the default.
+144
Documentation/ABI/testing/sysfs-class-uwb_rc
+144
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.
+100
Documentation/ABI/testing/sysfs-wusb_cbaf
+100
Documentation/ABI/testing/sysfs-wusb_cbaf
···
1
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_*
2
+
Date: August 2008
3
+
KernelVersion: 2.6.27
4
+
Contact: David Vrabel <david.vrabel@csr.com>
5
+
Description:
6
+
Various files for managing Cable Based Association of
7
+
(wireless) USB devices.
8
+
9
+
The sequence of operations should be:
10
+
11
+
1. Device is plugged in.
12
+
13
+
2. The connection manager (CM) sees a device with CBA capability.
14
+
(the wusb_chid etc. files in /sys/devices/blah/OURDEVICE).
15
+
16
+
3. The CM writes the host name, supported band groups,
17
+
and the CHID (host ID) into the wusb_host_name,
18
+
wusb_host_band_groups and wusb_chid files. These
19
+
get sent to the device and the CDID (if any) for
20
+
this host is requested.
21
+
22
+
4. The CM can verify that the device's supported band
23
+
groups (wusb_device_band_groups) are compatible
24
+
with the host.
25
+
26
+
5. The CM reads the wusb_cdid file.
27
+
28
+
6. The CM looks it up its database.
29
+
30
+
- If it has a matching CHID,CDID entry, the device
31
+
has been authorized before and nothing further
32
+
needs to be done.
33
+
34
+
- If the CDID is zero (or the CM doesn't find a
35
+
matching CDID in its database), the device is
36
+
assumed to be not known. The CM may associate
37
+
the host with device by: writing a randomly
38
+
generated CDID to wusb_cdid and then a random CK
39
+
to wusb_ck (this uploads the new CC to the
40
+
device).
41
+
42
+
CMD may choose to prompt the user before
43
+
associating with a new device.
44
+
45
+
7. Device is unplugged.
46
+
47
+
References:
48
+
[WUSB-AM] Association Models Supplement to the
49
+
Certified Wireless Universal Serial Bus
50
+
Specification, version 1.0.
51
+
52
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_chid
53
+
Date: August 2008
54
+
KernelVersion: 2.6.27
55
+
Contact: David Vrabel <david.vrabel@csr.com>
56
+
Description:
57
+
The CHID of the host formatted as 16 space-separated
58
+
hex octets.
59
+
60
+
Writes fetches device's supported band groups and the
61
+
the CDID for any existing association with this host.
62
+
63
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_name
64
+
Date: August 2008
65
+
KernelVersion: 2.6.27
66
+
Contact: David Vrabel <david.vrabel@csr.com>
67
+
Description:
68
+
A friendly name for the host as a UTF-8 encoded string.
69
+
70
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_band_groups
71
+
Date: August 2008
72
+
KernelVersion: 2.6.27
73
+
Contact: David Vrabel <david.vrabel@csr.com>
74
+
Description:
75
+
The band groups supported by the host, in the format
76
+
defined in [WUSB-AM].
77
+
78
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_device_band_groups
79
+
Date: August 2008
80
+
KernelVersion: 2.6.27
81
+
Contact: David Vrabel <david.vrabel@csr.com>
82
+
Description:
83
+
The band groups supported by the device, in the format
84
+
defined in [WUSB-AM].
85
+
86
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_cdid
87
+
Date: August 2008
88
+
KernelVersion: 2.6.27
89
+
Contact: David Vrabel <david.vrabel@csr.com>
90
+
Description:
91
+
The device's CDID formatted as 16 space-separated hex
92
+
octets.
93
+
94
+
What: /sys/bus/usb/drivers/wusb_cbaf/.../wusb_ck
95
+
Date: August 2008
96
+
KernelVersion: 2.6.27
97
+
Contact: David Vrabel <david.vrabel@csr.com>
98
+
Description:
99
+
Write 16 space-separated random, hex octets to
100
+
associate with the device.