usb_gstrings_attach(9) [centos man page]

USB_GSTRINGS_ATTACH(9)					      Kernel Mode Gadget API					    USB_GSTRINGS_ATTACH(9)

NAME

       usb_gstrings_attach - attach gadget strings to a cdev and assign ids

SYNOPSIS

       struct usb_string * usb_gstrings_attach(struct usb_composite_dev * cdev, struct usb_gadget_strings ** sp, unsigned n_strings);

ARGUMENTS

       cdev
	   the device whose string descriptor IDs are being allocated and attached.

       sp
	   an array of usb_gadget_strings to attach.

       n_strings
	   number of entries in each usb_strings array (sp[]->strings)

DESCRIPTION

       This function will create a deep copy of usb_gadget_strings and usb_string and attach it to the cdev. The actual string (usb_string.s) will
       not be copied but only a referenced will be made. The struct usb_gadget_strings array may contain multiple languges and should be NULL
       terminated. The ->language pointer of each struct usb_gadget_strings has to contain the same amount of entries.

FOR INSTANCE

       sp[0] is en-US, sp[1] is es-ES. It is expected that the first usb_string entry of es-ES containts the translation of the first usb_string
       entry of en-US. Therefore both entries become the same id assign.

AUTHOR

       David Brownell <dbrownell@users.sourceforge.net>
	   Author.

COPYRIGHT

Kernel Hackers Manual 3.10					     June 2014						    USB_GSTRINGS_ATTACH(9)

STRUCT 
USB_COMPOSITE(9) 				      Kernel Mode Gadget API					   STRUCT USB_COMPOSITE(9)

NAME

       struct_usb_composite_driver - groups configurations into a gadget

SYNOPSIS

       struct usb_composite_driver {
	 const char * name;
	 const struct usb_device_descriptor * dev;
	 struct usb_gadget_strings ** strings;
	 int (* bind) (struct usb_composite_dev *);
	 int (* unbind) (struct usb_composite_dev *);
	 void (* suspend) (struct usb_composite_dev *);
	 void (* resume) (struct usb_composite_dev *);
       };

MEMBERS

       name
	   For diagnostics, identifies the driver.

       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

       bind
	   (REQUIRED) Used to allocate resources that are shared across the whole device, such as string IDs, and add its configurations using
	   usb_add_config(). This may fail by returning a negative errno value; it should return zero on successful initialization.

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

       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.

AUTHOR

       David Brownell <dbrownell@users.sourceforge.net>
	   Author.

COPYRIGHT

Kernel Hackers Manual 2.6.					     July 2010						   STRUCT USB_COMPOSITE(9)