Name

struct usb_composite_driver — groups configurations into a gadget

Synopsis

struct usb_composite_driver {
  const char * name;
  const char * iProduct;
  const char * iManufacturer;
  const struct usb_device_descriptor * dev;
  struct usb_gadget_strings ** strings;
  unsigned needs_serial:1;
  int (* unbind) (struct usb_composite_dev *);
  void (* disconnect) (struct usb_composite_dev *);
  void (* suspend) (struct usb_composite_dev *);
  void (* resume) (struct usb_composite_dev *);
};  

Members

name

For diagnostics, identifies the driver.

iProduct

Used as iProduct override if dev->iProduct is not set. If NULL value of name is taken.

iManufacturer

Used as iManufacturer override if dev->iManufacturer is not set. If NULL a default <system> <release> with <udc> value will be used.

dev

Template descriptor for the device, including default device identifiers.

strings

tables of strings, keyed by identifiers assigned during bind and language IDs provided in control requests

needs_serial

set to 1 if the gadget needs userspace to provide a serial number. If one is not provided, warning will be printed.

unbind

Reverses bind; called as a side effect of unregistering this driver.

disconnect

optional driver disconnect method

suspend

Notifies when the host stops sending USB traffic, after function notifications

resume

Notifies configuration when the host restarts USB traffic, before function notifications

Description

Devices default to reporting self powered operation. Devices which rely on bus powered operation should report this in their bind() method.

Before returning from bind, various fields in the template descriptor may be overridden. These include the idVendor/idProduct/bcdDevice values normally to bind the appropriate host side driver, and the three strings (iManufacturer, iProduct, iSerialNumber) normally used to provide user meaningful device identifiers. (The strings will not be defined unless they are defined in dev and strings.) The correct ep0 maxpacket size is also reported, as defined by the underlying controller driver.