aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/ABI/testing/sysfs-wusb_cbaf
blob: a99c5f86a37a7fdf7b165cc8b9c62a708ce018cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_*
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                Various files for managing Cable Based Association of
                (wireless) USB devices.

                The sequence of operations should be:

                1. Device is plugged in.

                2. The connection manager (CM) sees a device with CBA capability.
                   (the wusb_chid etc. files in /sys/devices/blah/OURDEVICE).

                3. The CM writes the host name, supported band groups,
                   and the CHID (host ID) into the wusb_host_name,
                   wusb_host_band_groups and wusb_chid files. These
                   get sent to the device and the CDID (if any) for
                   this host is requested.

                4. The CM can verify that the device's supported band
                   groups (wusb_device_band_groups) are compatible
                   with the host.

                5. The CM reads the wusb_cdid file.

                6. The CM looks it up its database.

                   - If it has a matching CHID,CDID entry, the device
                     has been authorized before and nothing further
                     needs to be done.

                   - If the CDID is zero (or the CM doesn't find a
                     matching CDID in its database), the device is
                     assumed to be not known.  The CM may associate
                     the host with device by: writing a randomly
                     generated CDID to wusb_cdid and then a random CK
                     to wusb_ck (this uploads the new CC to the
                     device).

                     CMD may choose to prompt the user before
                     associating with a new device.

                7. Device is unplugged.

                References:
                  [WUSB-AM] Association Models Supplement to the
                            Certified Wireless Universal Serial Bus
                            Specification, version 1.0.

What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_chid
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                The CHID of the host formatted as 16 space-separated
                hex octets.

                Writes fetches device's supported band groups and the
                the CDID for any existing association with this host.

What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_name
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                A friendly name for the host as a UTF-8 encoded string.

What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_band_groups
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                The band groups supported by the host, in the format
                defined in [WUSB-AM].

What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_device_band_groups
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                The band groups supported by the device, in the format
                defined in [WUSB-AM].

What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_cdid
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                The device's CDID formatted as 16 space-separated hex
                octets.

What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_ck
Date:           August 2008
KernelVersion:  2.6.27
Contact:        David Vrabel <david.vrabel@csr.com>
Description:
                Write 16 space-separated random, hex octets to
                associate with the device.