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]
  49                             Association Models Supplement to the
  50                             Certified Wireless Universal Serial Bus
  51                             Specification, version 1.0.
  52
  53 What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_chid
  54 Date:           August 2008
  55 KernelVersion:  2.6.27
  56 Contact:        David Vrabel <david.vrabel@csr.com>
  57 Description:
  58                 The CHID of the host formatted as 16 space-separated
  59                 hex octets.
  60
  61                 Writes fetches device's supported band groups and the
  62                 the CDID for any existing association with this host.
  63
  64 What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_name
  65 Date:           August 2008
  66 KernelVersion:  2.6.27
  67 Contact:        David Vrabel <david.vrabel@csr.com>
  68 Description:
  69                 A friendly name for the host as a UTF-8 encoded string.
  70
  71 What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_host_band_groups
  72 Date:           August 2008
  73 KernelVersion:  2.6.27
  74 Contact:        David Vrabel <david.vrabel@csr.com>
  75 Description:
  76                 The band groups supported by the host, in the format
  77                 defined in [WUSB-AM].
  78
  79 What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_device_band_groups
  80 Date:           August 2008
  81 KernelVersion:  2.6.27
  82 Contact:        David Vrabel <david.vrabel@csr.com>
  83 Description:
  84                 The band groups supported by the device, in the format
  85                 defined in [WUSB-AM].
  86
  87 What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_cdid
  88 Date:           August 2008
  89 KernelVersion:  2.6.27
  90 Contact:        David Vrabel <david.vrabel@csr.com>
  91 Description:
  92                 The device's CDID formatted as 16 space-separated hex
  93                 octets.
  94
  95 What:           /sys/bus/usb/drivers/wusb_cbaf/.../wusb_ck
  96 Date:           August 2008
  97 KernelVersion:  2.6.27
  98 Contact:        David Vrabel <david.vrabel@csr.com>
  99 Description:
 100                 Write 16 space-separated random, hex octets to
 101                 associate with the device.