xref: /OK3568_Linux_fs/kernel/Documentation/ABI/testing/sysfs-wusb_cbaf (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_*
2*4882a593SmuzhiyunDate:           August 2008
3*4882a593SmuzhiyunKernelVersion:  2.6.27
4*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
5*4882a593SmuzhiyunDescription:
6*4882a593Smuzhiyun                Various files for managing Cable Based Association of
7*4882a593Smuzhiyun                (wireless) USB devices.
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun                The sequence of operations should be:
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun                1. Device is plugged in.
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun                2. The connection manager (CM) sees a device with CBA capability.
14*4882a593Smuzhiyun                   (the wusb_chid etc. files in /sys/devices/blah/OURDEVICE).
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun                3. The CM writes the host name, supported band groups,
17*4882a593Smuzhiyun                   and the CHID (host ID) into the wusb_host_name,
18*4882a593Smuzhiyun                   wusb_host_band_groups and wusb_chid files. These
19*4882a593Smuzhiyun                   get sent to the device and the CDID (if any) for
20*4882a593Smuzhiyun                   this host is requested.
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun                4. The CM can verify that the device's supported band
23*4882a593Smuzhiyun                   groups (wusb_device_band_groups) are compatible
24*4882a593Smuzhiyun                   with the host.
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun                5. The CM reads the wusb_cdid file.
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun                6. The CM looks it up its database.
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun                   - If it has a matching CHID,CDID entry, the device
31*4882a593Smuzhiyun                     has been authorized before and nothing further
32*4882a593Smuzhiyun                     needs to be done.
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun                   - If the CDID is zero (or the CM doesn't find a
35*4882a593Smuzhiyun                     matching CDID in its database), the device is
36*4882a593Smuzhiyun                     assumed to be not known.  The CM may associate
37*4882a593Smuzhiyun                     the host with device by: writing a randomly
38*4882a593Smuzhiyun                     generated CDID to wusb_cdid and then a random CK
39*4882a593Smuzhiyun                     to wusb_ck (this uploads the new CC to the
40*4882a593Smuzhiyun                     device).
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun                     CMD may choose to prompt the user before
43*4882a593Smuzhiyun                     associating with a new device.
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun                7. Device is unplugged.
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun                References:
48*4882a593Smuzhiyun                  [WUSB-AM]
49*4882a593Smuzhiyun			    Association Models Supplement to the
50*4882a593Smuzhiyun                            Certified Wireless Universal Serial Bus
51*4882a593Smuzhiyun                            Specification, version 1.0.
52*4882a593Smuzhiyun
53*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_chid
54*4882a593SmuzhiyunDate:           August 2008
55*4882a593SmuzhiyunKernelVersion:  2.6.27
56*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
57*4882a593SmuzhiyunDescription:
58*4882a593Smuzhiyun                The CHID of the host formatted as 16 space-separated
59*4882a593Smuzhiyun                hex octets.
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun                Writes fetches device's supported band groups and the
62*4882a593Smuzhiyun                the CDID for any existing association with this host.
63*4882a593Smuzhiyun
64*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_name
65*4882a593SmuzhiyunDate:           August 2008
66*4882a593SmuzhiyunKernelVersion:  2.6.27
67*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
68*4882a593SmuzhiyunDescription:
69*4882a593Smuzhiyun                A friendly name for the host as a UTF-8 encoded string.
70*4882a593Smuzhiyun
71*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_band_groups
72*4882a593SmuzhiyunDate:           August 2008
73*4882a593SmuzhiyunKernelVersion:  2.6.27
74*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
75*4882a593SmuzhiyunDescription:
76*4882a593Smuzhiyun                The band groups supported by the host, in the format
77*4882a593Smuzhiyun                defined in [WUSB-AM].
78*4882a593Smuzhiyun
79*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_device_band_groups
80*4882a593SmuzhiyunDate:           August 2008
81*4882a593SmuzhiyunKernelVersion:  2.6.27
82*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
83*4882a593SmuzhiyunDescription:
84*4882a593Smuzhiyun                The band groups supported by the device, in the format
85*4882a593Smuzhiyun                defined in [WUSB-AM].
86*4882a593Smuzhiyun
87*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_cdid
88*4882a593SmuzhiyunDate:           August 2008
89*4882a593SmuzhiyunKernelVersion:  2.6.27
90*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
91*4882a593SmuzhiyunDescription:
92*4882a593Smuzhiyun                The device's CDID formatted as 16 space-separated hex
93*4882a593Smuzhiyun                octets.
94*4882a593Smuzhiyun
95*4882a593SmuzhiyunWhat:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_ck
96*4882a593SmuzhiyunDate:           August 2008
97*4882a593SmuzhiyunKernelVersion:  2.6.27
98*4882a593SmuzhiyunContact:        David Vrabel <david.vrabel@csr.com>
99*4882a593SmuzhiyunDescription:
100*4882a593Smuzhiyun                Write 16 space-separated random, hex octets to
101*4882a593Smuzhiyun                associate with the device.
102