struct_usbdrv_wrap – wrapper for driver-model structure Synopsis struct usbdrv_wrap { struct device_driver driver; int for_devices; }; Members driver The driver-model core driver structure. for_devices Non-zero for device drivers, 0 for interface drivers. Copyright
struct_usb_string – wraps a C string and its USB id Synopsis struct usb_string { u8 id; const char *s; }; Members id the (nonzero) ID for this string s the string, in UTF-8 encoding Description If you’re using usb_gadget_get_string, use this to wrap a string together with its ID. Author David Brownell <dbrownell [at] users.sourceforge.net>…
struct_usb_sg_request – support for scatter/gather I/O Synopsis struct usb_sg_request { int status; size_t bytes; }; Members status zero indicates success, else negative errno bytes counts bytes transferred. Description These requests are initialized using usb_sg_init, and then are used as request handles passed to usb_sg_wait or usb_sg_cancel. Most members of the request object aren’t for driver…
struct_usb_request – describes one i/o request Synopsis struct usb_request { void *buf; unsigned length; dma_addr_t dma; struct scatterlist *sg; unsigned num_sgs; unsigned num_mapped_sgs; unsigned stream_id : 16; unsigned no_interrupt : 1; unsigned zero : 1; unsigned short_not_ok : 1; void (*complete)(struct usb_ep *ep, struct usb_request *req); void *context; struct list_head list; int status; unsigned actual;…
struct_usb_os_desc_table – describes OS descriptors associated with one interface of a usb_function Synopsis struct usb_os_desc_table { int if_id; struct usb_os_desc *os_desc; }; Members if_id Interface id os_desc "Extended Compatibility ID” and “Extended Properties" of the interface Description Each interface can have at most one “Extended Compatibility ID” and a number of “Extended Properties”. Author David…
struct_usb_os_desc_ext_prop – describes one “Extended Property” Synopsis struct usb_os_desc_ext_prop { struct list_head entry; u8 type; int name_len; char *name; int data_len; char *data; struct config_item item; }; Members entry used to keep a list of extended properties type Extended Property type name_len Extended Property unicode name length, including terminating ‘\0’ name Extended Property name data_len…
struct_usb_os_desc – describes OS descriptors associated with one interface Synopsis struct usb_os_desc { char *ext_compat_id; struct list_head ext_prop; int ext_prop_len; int ext_prop_count; struct mutex *opts_mutex; struct config_group group; struct module *owner; }; Members ext_compat_id 16 bytes of “Compatible ID” and “Subcompatible ID” ext_prop Extended Properties list ext_prop_len Total length of Extended Properties blobs ext_prop_count Number…
struct_usb_interface_cache – long-term representation of a device interface Synopsis struct usb_interface_cache { unsigned num_altsetting; struct kref ref; struct usb_host_interface altsetting[0]; }; Members num_altsetting number of altsettings defined. ref reference counter. altsetting[0] variable-length array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will…
struct_usb_interface – what usb device drivers talk to Synopsis struct usb_interface { struct usb_host_interface *altsetting; struct usb_host_interface *cur_altsetting; unsigned num_altsetting; struct usb_interface_assoc_descriptor *intf_assoc; int minor; enum usb_interface_condition condition; unsigned sysfs_files_created : 1; unsigned ep_devs_created : 1; unsigned unregistering : 1; unsigned needs_remote_wakeup : 1; unsigned needs_altsetting0 : 1; unsigned needs_binding : 1; unsigned resetting_device :…
struct_usb_host_endpoint – host-side endpoint descriptor and queue Synopsis struct usb_host_endpoint { struct usb_endpoint_descriptor desc; struct usb_ss_ep_comp_descriptor ss_ep_comp; struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp; struct list_head urb_list; void *hcpriv; struct ep_device *ep_dev; unsigned char *extra; int extralen; int enabled; int streams; }; Members desc descriptor for this endpoint, wMaxPacketSize in native byteorder ss_ep_comp SuperSpeed companion descriptor for this endpoint…
struct_usb_host_config – representation of a device’s configuration Synopsis struct usb_host_config { struct usb_config_descriptor desc; char *string; struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS]; struct usb_interface *interface[USB_MAXINTERFACES]; struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; unsigned char *extra; int extralen; }; Members desc the device’s configuration descriptor. string pointer to the cached version of the iConfiguration string, if present for this configuration. intf_assoc[USB_MAXIADS] list of…
struct_usb_gadget_strings – a set of USB strings in a given language Synopsis struct usb_gadget_strings { u16 language; struct usb_string *strings; }; Members language identifies the strings’ language (0x0409 for en-us) strings array of strings with their ids Description If you’re using usb_gadget_get_string, use this to wrap all the strings for a given language. Author David…
struct_usb_gadget_driver – driver for usb ‘slave’ devices Synopsis struct usb_gadget_driver { char *function; enum usb_device_speed max_speed; int (*bind)(struct usb_gadget *gadget, struct usb_gadget_driver *driver); void (*unbind)(struct usb_gadget *); int (*setup)(struct usb_gadget *, const struct usb_ctrlrequest *); void (*disconnect)(struct usb_gadget *); void (*suspend)(struct usb_gadget *); void (*resume)(struct usb_gadget *); void (*reset)(struct usb_gadget *); struct device_driver driver; char…
struct_usb_gadget – represents a usb slave device Synopsis struct usb_gadget { struct work_struct work; struct usb_udc *udc; const struct usb_gadget_ops *ops; struct usb_ep *ep0; struct list_head ep_list; enum usb_device_speed speed; enum usb_device_speed max_speed; enum usb_device_state state; const char *name; struct device dev; unsigned out_epnum; unsigned in_epnum; unsigned mA; struct usb_otg_caps *otg_caps; unsigned sg_supported : 1;…
struct_usb_function – describes one function of a configuration Synopsis struct usb_function { const char *name; struct usb_gadget_strings **strings; struct usb_descriptor_header **fs_descriptors; struct usb_descriptor_header **hs_descriptors; struct usb_descriptor_header **ss_descriptors; struct usb_descriptor_header **ssp_descriptors; struct usb_configuration *config; struct usb_os_desc_table *os_desc_table; unsigned os_desc_n; int (*bind)(struct usb_configuration *, struct usb_function *); void (*unbind)(struct usb_configuration *, struct usb_function *); void (*free_func)(struct usb_function…
struct_usb_ep_caps – endpoint capabilities description Synopsis struct usb_ep_caps { unsigned type_control : 1; unsigned type_iso : 1; unsigned type_bulk : 1; unsigned type_int : 1; unsigned dir_in : 1; unsigned dir_out : 1; }; Members type_control Endpoint supports control type (reserved for ep0). type_iso Endpoint supports isochronous transfers. type_bulk Endpoint supports bulk transfers. type_int Endpoint…
struct_usb_ep – device side representation of USB endpoint Synopsis struct usb_ep { void *driver_data; const char *name; const struct usb_ep_ops *ops; struct list_head ep_list; struct usb_ep_caps caps; unsigned maxpacket : 16; unsigned maxpacket_limit : 16; unsigned max_streams : 16; unsigned mult : 2; unsigned maxburst : 5; u8 address; const struct usb_endpoint_descriptor *desc; const struct…
struct_usb_driver – identifies USB interface driver to usbcore Synopsis struct usb_driver { const char *name; int (*probe)(struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect)(struct usb_interface *intf); int (*unlocked_ioctl)(struct usb_interface *intf, unsigned int code, void *buf); int (*suspend)(struct usb_interface *intf, pm_message_t message); int (*resume)(struct usb_interface *intf); int (*reset_resume)(struct usb_interface *intf); int (*pre_reset)(struct usb_interface *intf); int…
struct_usb_device_driver – identifies USB device driver to usbcore Synopsis struct usb_device_driver { const char *name; int (*probe)(struct usb_device *udev); void (*disconnect)(struct usb_device *udev); int (*suspend)(struct usb_device *udev, pm_message_t message); int (*resume)(struct usb_device *udev, pm_message_t message); struct usbdrv_wrap drvwrap; unsigned int supports_autosuspend : 1; }; Members name The driver name should be unique among USB drivers,…
struct_usb_device – kernel’s representation of a USB device Synopsis struct usb_device { int devnum; char devpath[16]; u32 route; enum usb_device_state state; enum usb_device_speed speed; struct usb_tt *tt; int ttport; unsigned int toggle[2]; struct usb_device *parent; struct usb_bus *bus; struct usb_host_endpoint ep0; struct device dev; struct usb_device_descriptor descriptor; struct usb_host_bos *bos; struct usb_host_config *config; struct usb_host_config…