| David Vrabel | c8cf246 | 2008-09-17 16:34:41 +0100 | [diff] [blame] | 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. |