linux-imx/Documentation/ABI/testing/sysfs-wusb_cbaf
Mauro Carvalho Chehab 54a19b4d3f docs: ABI: cleanup several ABI documents
There are some ABI documents that, while they don't generate
any warnings, they have issues when parsed by get_abi.pl script
on its output result.

Address them, in order to provide a clean output.

Reviewed-by: Tom Rix <trix@redhat.com> # for fpga-manager
Reviewed-By: Kajol Jain<kjain@linux.ibm.com> # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
Acked-by: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt
Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com>
Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd
Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2020-10-30 13:14:29 +01:00

3.9 KiB

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.