David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 1 | /* |
| 2 | * composite.h -- framework for usb gadgets which are composite devices |
| 3 | * |
| 4 | * Copyright (C) 2006-2008 David Brownell |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 19 | */ |
| 20 | |
| 21 | #ifndef __LINUX_USB_COMPOSITE_H |
| 22 | #define __LINUX_USB_COMPOSITE_H |
| 23 | |
| 24 | /* |
| 25 | * This framework is an optional layer on top of the USB Gadget interface, |
| 26 | * making it easier to build (a) Composite devices, supporting multiple |
| 27 | * functions within any single configuration, and (b) Multi-configuration |
| 28 | * devices, also supporting multiple functions but without necessarily |
| 29 | * having more than one function per configuration. |
| 30 | * |
| 31 | * Example: a device with a single configuration supporting both network |
| 32 | * link and mass storage functions is a composite device. Those functions |
| 33 | * might alternatively be packaged in individual configurations, but in |
| 34 | * the composite model the host can use both functions at the same time. |
| 35 | */ |
| 36 | |
Sebastian Andrzej Siewior | ed9cbda | 2012-09-10 09:16:07 +0200 | [diff] [blame] | 37 | #include <linux/bcd.h> |
| 38 | #include <linux/version.h> |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 39 | #include <linux/usb/ch9.h> |
| 40 | #include <linux/usb/gadget.h> |
Sebastian Andrzej Siewior | bcb2f99 | 2012-10-22 22:14:57 +0200 | [diff] [blame] | 41 | #include <linux/log2.h> |
Sebastian Andrzej Siewior | 88af8bb | 2012-12-23 21:10:24 +0100 | [diff] [blame] | 42 | #include <linux/configfs.h> |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 43 | |
Roger Quadros | 1b9ba00 | 2011-05-09 13:08:06 +0300 | [diff] [blame] | 44 | /* |
| 45 | * USB function drivers should return USB_GADGET_DELAYED_STATUS if they |
| 46 | * wish to delay the data/status stages of the control transfer till they |
| 47 | * are ready. The control transfer will then be kept from completing till |
| 48 | * all the function drivers that requested for USB_GADGET_DELAYED_STAUS |
| 49 | * invoke usb_composite_setup_continue(). |
| 50 | */ |
| 51 | #define USB_GADGET_DELAYED_STATUS 0x7fff /* Impossibly large value */ |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 52 | |
Sebastian Andrzej Siewior | e13f17f | 2012-09-10 15:01:51 +0200 | [diff] [blame] | 53 | /* big enough to hold our biggest descriptor */ |
| 54 | #define USB_COMP_EP0_BUFSIZ 1024 |
| 55 | |
Sebastian Andrzej Siewior | bcb2f99 | 2012-10-22 22:14:57 +0200 | [diff] [blame] | 56 | #define USB_MS_TO_HS_INTERVAL(x) (ilog2((x * 1000 / 125)) + 1) |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 57 | struct usb_configuration; |
| 58 | |
| 59 | /** |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 60 | * struct usb_os_desc_ext_prop - describes one "Extended Property" |
| 61 | * @entry: used to keep a list of extended properties |
| 62 | * @type: Extended Property type |
| 63 | * @name_len: Extended Property unicode name length, including terminating '\0' |
| 64 | * @name: Extended Property name |
| 65 | * @data_len: Length of Extended Property blob (for unicode store double len) |
| 66 | * @data: Extended Property blob |
Andrzej Pietrasiewicz | 7419485 | 2014-05-08 14:06:28 +0200 | [diff] [blame] | 67 | * @item: Represents this Extended Property in configfs |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 68 | */ |
| 69 | struct usb_os_desc_ext_prop { |
| 70 | struct list_head entry; |
| 71 | u8 type; |
| 72 | int name_len; |
| 73 | char *name; |
| 74 | int data_len; |
| 75 | char *data; |
Andrzej Pietrasiewicz | 7419485 | 2014-05-08 14:06:28 +0200 | [diff] [blame] | 76 | struct config_item item; |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 77 | }; |
| 78 | |
| 79 | /** |
| 80 | * struct usb_os_desc - describes OS descriptors associated with one interface |
| 81 | * @ext_compat_id: 16 bytes of "Compatible ID" and "Subcompatible ID" |
| 82 | * @ext_prop: Extended Properties list |
| 83 | * @ext_prop_len: Total length of Extended Properties blobs |
| 84 | * @ext_prop_count: Number of Extended Properties |
Andrzej Pietrasiewicz | da42431 | 2014-05-08 14:06:26 +0200 | [diff] [blame] | 85 | * @opts_mutex: Optional mutex protecting config data of a usb_function_instance |
| 86 | * @group: Represents OS descriptors associated with an interface in configfs |
Andrzej Pietrasiewicz | 7419485 | 2014-05-08 14:06:28 +0200 | [diff] [blame] | 87 | * @owner: Module associated with this OS descriptor |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 88 | */ |
| 89 | struct usb_os_desc { |
| 90 | char *ext_compat_id; |
| 91 | struct list_head ext_prop; |
| 92 | int ext_prop_len; |
| 93 | int ext_prop_count; |
Andrzej Pietrasiewicz | da42431 | 2014-05-08 14:06:26 +0200 | [diff] [blame] | 94 | struct mutex *opts_mutex; |
| 95 | struct config_group group; |
Andrzej Pietrasiewicz | 7419485 | 2014-05-08 14:06:28 +0200 | [diff] [blame] | 96 | struct module *owner; |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 97 | }; |
| 98 | |
| 99 | /** |
| 100 | * struct usb_os_desc_table - describes OS descriptors associated with one |
| 101 | * interface of a usb_function |
| 102 | * @if_id: Interface id |
| 103 | * @os_desc: "Extended Compatibility ID" and "Extended Properties" of the |
| 104 | * interface |
| 105 | * |
| 106 | * Each interface can have at most one "Extended Compatibility ID" and a |
| 107 | * number of "Extended Properties". |
| 108 | */ |
| 109 | struct usb_os_desc_table { |
| 110 | int if_id; |
| 111 | struct usb_os_desc *os_desc; |
| 112 | }; |
| 113 | |
| 114 | /** |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 115 | * struct usb_function - describes one function of a configuration |
| 116 | * @name: For diagnostics, identifies the function. |
| 117 | * @strings: tables of strings, keyed by identifiers assigned during bind() |
| 118 | * and by language IDs provided in control requests |
Nishanth Menon | 43febb2 | 2013-03-04 16:52:38 -0600 | [diff] [blame] | 119 | * @fs_descriptors: Table of full (or low) speed descriptors, using interface and |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 120 | * string identifiers assigned during @bind(). If this pointer is null, |
| 121 | * the function will not be available at full speed (or at low speed). |
| 122 | * @hs_descriptors: Table of high speed descriptors, using interface and |
| 123 | * string identifiers assigned during @bind(). If this pointer is null, |
| 124 | * the function will not be available at high speed. |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 125 | * @ss_descriptors: Table of super speed descriptors, using interface and |
| 126 | * string identifiers assigned during @bind(). If this |
| 127 | * pointer is null after initiation, the function will not |
| 128 | * be available at super speed. |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 129 | * @config: assigned when @usb_add_function() is called; this is the |
| 130 | * configuration with which this function is associated. |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 131 | * @os_desc_table: Table of (interface id, os descriptors) pairs. The function |
| 132 | * can expose more than one interface. If an interface is a member of |
| 133 | * an IAD, only the first interface of IAD has its entry in the table. |
| 134 | * @os_desc_n: Number of entries in os_desc_table |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 135 | * @bind: Before the gadget can register, all of its functions bind() to the |
| 136 | * available resources including string and interface identifiers used |
| 137 | * in interface or class descriptors; endpoints; I/O buffers; and so on. |
| 138 | * @unbind: Reverses @bind; called as a side effect of unregistering the |
| 139 | * driver which added this function. |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 140 | * @free_func: free the struct usb_function. |
| 141 | * @mod: (internal) points to the module that created this structure. |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 142 | * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may |
| 143 | * initialize usb_ep.driver data at this time (when it is used). |
| 144 | * Note that setting an interface to its current altsetting resets |
| 145 | * interface state, and that all interfaces have a disabled state. |
| 146 | * @get_alt: Returns the active altsetting. If this is not provided, |
| 147 | * then only altsetting zero is supported. |
| 148 | * @disable: (REQUIRED) Indicates the function should be disabled. Reasons |
| 149 | * include host resetting or reconfiguring the gadget, and disconnection. |
| 150 | * @setup: Used for interface-specific control requests. |
| 151 | * @suspend: Notifies functions when the host stops sending USB traffic. |
| 152 | * @resume: Notifies functions when the host restarts USB traffic. |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 153 | * @get_status: Returns function status as a reply to |
Masanari Iida | e227867 | 2014-02-18 22:54:36 +0900 | [diff] [blame] | 154 | * GetStatus() request when the recipient is Interface. |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 155 | * @func_suspend: callback to be called when |
| 156 | * SetFeature(FUNCTION_SUSPEND) is reseived |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 157 | * |
| 158 | * A single USB function uses one or more interfaces, and should in most |
| 159 | * cases support operation at both full and high speeds. Each function is |
| 160 | * associated by @usb_add_function() with a one configuration; that function |
| 161 | * causes @bind() to be called so resources can be allocated as part of |
| 162 | * setting up a gadget driver. Those resources include endpoints, which |
| 163 | * should be allocated using @usb_ep_autoconfig(). |
| 164 | * |
| 165 | * To support dual speed operation, a function driver provides descriptors |
| 166 | * for both high and full speed operation. Except in rare cases that don't |
| 167 | * involve bulk endpoints, each speed needs different endpoint descriptors. |
| 168 | * |
| 169 | * Function drivers choose their own strategies for managing instance data. |
| 170 | * The simplest strategy just declares it "static', which means the function |
| 171 | * can only be activated once. If the function needs to be exposed in more |
| 172 | * than one configuration at a given speed, it needs to support multiple |
| 173 | * usb_function structures (one for each configuration). |
| 174 | * |
| 175 | * A more complex strategy might encapsulate a @usb_function structure inside |
| 176 | * a driver-specific instance structure to allows multiple activations. An |
| 177 | * example of multiple activations might be a CDC ACM function that supports |
| 178 | * two or more distinct instances within the same configuration, providing |
| 179 | * several independent logical data links to a USB host. |
| 180 | */ |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 181 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 182 | struct usb_function { |
| 183 | const char *name; |
| 184 | struct usb_gadget_strings **strings; |
Sebastian Andrzej Siewior | 10287ba | 2012-10-22 22:15:06 +0200 | [diff] [blame] | 185 | struct usb_descriptor_header **fs_descriptors; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 186 | struct usb_descriptor_header **hs_descriptors; |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 187 | struct usb_descriptor_header **ss_descriptors; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 188 | |
| 189 | struct usb_configuration *config; |
| 190 | |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 191 | struct usb_os_desc_table *os_desc_table; |
| 192 | unsigned os_desc_n; |
| 193 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 194 | /* REVISIT: bind() functions can be marked __init, which |
| 195 | * makes trouble for section mismatch analysis. See if |
| 196 | * we can't restructure things to avoid mismatching. |
| 197 | * Related: unbind() may kfree() but bind() won't... |
| 198 | */ |
| 199 | |
| 200 | /* configuration management: bind/unbind */ |
| 201 | int (*bind)(struct usb_configuration *, |
| 202 | struct usb_function *); |
| 203 | void (*unbind)(struct usb_configuration *, |
| 204 | struct usb_function *); |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 205 | void (*free_func)(struct usb_function *f); |
| 206 | struct module *mod; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 207 | |
| 208 | /* runtime state management */ |
| 209 | int (*set_alt)(struct usb_function *, |
| 210 | unsigned interface, unsigned alt); |
| 211 | int (*get_alt)(struct usb_function *, |
| 212 | unsigned interface); |
| 213 | void (*disable)(struct usb_function *); |
| 214 | int (*setup)(struct usb_function *, |
| 215 | const struct usb_ctrlrequest *); |
| 216 | void (*suspend)(struct usb_function *); |
| 217 | void (*resume)(struct usb_function *); |
| 218 | |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 219 | /* USB 3.0 additions */ |
| 220 | int (*get_status)(struct usb_function *); |
| 221 | int (*func_suspend)(struct usb_function *, |
| 222 | u8 suspend_opt); |
Randy Dunlap | cac85a8 | 2009-04-29 21:04:19 -0700 | [diff] [blame] | 223 | /* private: */ |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 224 | /* internals */ |
| 225 | struct list_head list; |
Laurent Pinchart | 5242658 | 2009-10-21 00:03:38 +0200 | [diff] [blame] | 226 | DECLARE_BITMAP(endpoints, 32); |
Sebastian Andrzej Siewior | 0062f6e | 2012-12-23 21:10:15 +0100 | [diff] [blame] | 227 | const struct usb_function_instance *fi; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 228 | }; |
| 229 | |
| 230 | int usb_add_function(struct usb_configuration *, struct usb_function *); |
| 231 | |
David Brownell | 60beed9 | 2008-08-18 17:38:22 -0700 | [diff] [blame] | 232 | int usb_function_deactivate(struct usb_function *); |
| 233 | int usb_function_activate(struct usb_function *); |
| 234 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 235 | int usb_interface_id(struct usb_configuration *, struct usb_function *); |
| 236 | |
Tatyana Brokhman | 48767a4 | 2011-06-28 16:33:49 +0300 | [diff] [blame] | 237 | int config_ep_by_speed(struct usb_gadget *g, struct usb_function *f, |
| 238 | struct usb_ep *_ep); |
| 239 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 240 | #define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */ |
| 241 | |
| 242 | /** |
| 243 | * struct usb_configuration - represents one gadget configuration |
| 244 | * @label: For diagnostics, describes the configuration. |
| 245 | * @strings: Tables of strings, keyed by identifiers assigned during @bind() |
| 246 | * and by language IDs provided in control requests. |
| 247 | * @descriptors: Table of descriptors preceding all function descriptors. |
| 248 | * Examples include OTG and vendor-specific descriptors. |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 249 | * @unbind: Reverses @bind; called as a side effect of unregistering the |
| 250 | * driver which added this configuration. |
| 251 | * @setup: Used to delegate control requests that aren't handled by standard |
| 252 | * device infrastructure or directed at a specific interface. |
| 253 | * @bConfigurationValue: Copied into configuration descriptor. |
| 254 | * @iConfiguration: Copied into configuration descriptor. |
| 255 | * @bmAttributes: Copied into configuration descriptor. |
Sebastian Andrzej Siewior | 8f900a9 | 2012-12-03 20:07:05 +0100 | [diff] [blame] | 256 | * @MaxPower: Power consumtion in mA. Used to compute bMaxPower in the |
| 257 | * configuration descriptor after considering the bus speed. |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 258 | * @cdev: assigned by @usb_add_config() before calling @bind(); this is |
| 259 | * the device associated with this configuration. |
| 260 | * |
| 261 | * Configurations are building blocks for gadget drivers structured around |
| 262 | * function drivers. Simple USB gadgets require only one function and one |
| 263 | * configuration, and handle dual-speed hardware by always providing the same |
| 264 | * functionality. Slightly more complex gadgets may have more than one |
| 265 | * single-function configuration at a given speed; or have configurations |
| 266 | * that only work at one speed. |
| 267 | * |
| 268 | * Composite devices are, by definition, ones with configurations which |
| 269 | * include more than one function. |
| 270 | * |
| 271 | * The lifecycle of a usb_configuration includes allocation, initialization |
| 272 | * of the fields described above, and calling @usb_add_config() to set up |
| 273 | * internal data and bind it to a specific device. The configuration's |
| 274 | * @bind() method is then used to initialize all the functions and then |
| 275 | * call @usb_add_function() for them. |
| 276 | * |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 277 | * Those functions would normally be independent of each other, but that's |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 278 | * not mandatory. CDC WMC devices are an example where functions often |
| 279 | * depend on other functions, with some functions subsidiary to others. |
| 280 | * Such interdependency may be managed in any way, so long as all of the |
| 281 | * descriptors complete by the time the composite driver returns from |
| 282 | * its bind() routine. |
| 283 | */ |
| 284 | struct usb_configuration { |
| 285 | const char *label; |
| 286 | struct usb_gadget_strings **strings; |
| 287 | const struct usb_descriptor_header **descriptors; |
| 288 | |
| 289 | /* REVISIT: bind() functions can be marked __init, which |
| 290 | * makes trouble for section mismatch analysis. See if |
| 291 | * we can't restructure things to avoid mismatching... |
| 292 | */ |
| 293 | |
Uwe Kleine-König | c9bfff9 | 2010-08-12 17:43:55 +0200 | [diff] [blame] | 294 | /* configuration management: unbind/setup */ |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 295 | void (*unbind)(struct usb_configuration *); |
| 296 | int (*setup)(struct usb_configuration *, |
| 297 | const struct usb_ctrlrequest *); |
| 298 | |
| 299 | /* fields in the config descriptor */ |
| 300 | u8 bConfigurationValue; |
| 301 | u8 iConfiguration; |
| 302 | u8 bmAttributes; |
Sebastian Andrzej Siewior | 8f900a9 | 2012-12-03 20:07:05 +0100 | [diff] [blame] | 303 | u16 MaxPower; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 304 | |
| 305 | struct usb_composite_dev *cdev; |
| 306 | |
Randy Dunlap | cac85a8 | 2009-04-29 21:04:19 -0700 | [diff] [blame] | 307 | /* private: */ |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 308 | /* internals */ |
| 309 | struct list_head list; |
| 310 | struct list_head functions; |
| 311 | u8 next_interface_id; |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 312 | unsigned superspeed:1; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 313 | unsigned highspeed:1; |
| 314 | unsigned fullspeed:1; |
| 315 | struct usb_function *interface[MAX_CONFIG_INTERFACES]; |
| 316 | }; |
| 317 | |
| 318 | int usb_add_config(struct usb_composite_dev *, |
Uwe Kleine-König | c9bfff9 | 2010-08-12 17:43:55 +0200 | [diff] [blame] | 319 | struct usb_configuration *, |
| 320 | int (*)(struct usb_configuration *)); |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 321 | |
Benoit Goby | 51cce6f | 2012-05-10 10:07:57 +0200 | [diff] [blame] | 322 | void usb_remove_config(struct usb_composite_dev *, |
| 323 | struct usb_configuration *); |
| 324 | |
Sebastian Andrzej Siewior | 276e2e4 | 2012-09-06 20:11:21 +0200 | [diff] [blame] | 325 | /* predefined index for usb_composite_driver */ |
| 326 | enum { |
| 327 | USB_GADGET_MANUFACTURER_IDX = 0, |
| 328 | USB_GADGET_PRODUCT_IDX, |
| 329 | USB_GADGET_SERIAL_IDX, |
| 330 | USB_GADGET_FIRST_AVAIL_IDX, |
| 331 | }; |
| 332 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 333 | /** |
| 334 | * struct usb_composite_driver - groups configurations into a gadget |
| 335 | * @name: For diagnostics, identifies the driver. |
| 336 | * @dev: Template descriptor for the device, including default device |
| 337 | * identifiers. |
Sebastian Andrzej Siewior | fac3a43 | 2012-09-06 20:11:01 +0200 | [diff] [blame] | 338 | * @strings: tables of strings, keyed by identifiers assigned during @bind |
Sebastian Andrzej Siewior | 276e2e4 | 2012-09-06 20:11:21 +0200 | [diff] [blame] | 339 | * and language IDs provided in control requests. Note: The first entries |
| 340 | * are predefined. The first entry that may be used is |
| 341 | * USB_GADGET_FIRST_AVAIL_IDX |
Tatyana Brokhman | 35a0e0b | 2011-06-29 16:41:49 +0300 | [diff] [blame] | 342 | * @max_speed: Highest speed the driver supports. |
Michal Nazarewicz | ad1a810 | 2010-08-12 17:43:46 +0200 | [diff] [blame] | 343 | * @needs_serial: set to 1 if the gadget needs userspace to provide |
| 344 | * a serial number. If one is not provided, warning will be printed. |
Sebastian Andrzej Siewior | fac3a43 | 2012-09-06 20:11:01 +0200 | [diff] [blame] | 345 | * @bind: (REQUIRED) Used to allocate resources that are shared across the |
| 346 | * whole device, such as string IDs, and add its configurations using |
| 347 | * @usb_add_config(). This may fail by returning a negative errno |
| 348 | * value; it should return zero on successful initialization. |
| 349 | * @unbind: Reverses @bind; called as a side effect of unregistering |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 350 | * this driver. |
Randy Dunlap | d187abb | 2010-08-11 12:07:13 -0700 | [diff] [blame] | 351 | * @disconnect: optional driver disconnect method |
David Brownell | 8942939 | 2009-03-19 14:14:17 -0700 | [diff] [blame] | 352 | * @suspend: Notifies when the host stops sending USB traffic, |
| 353 | * after function notifications |
| 354 | * @resume: Notifies configuration when the host restarts USB traffic, |
| 355 | * before function notifications |
Nishanth Menon | 43febb2 | 2013-03-04 16:52:38 -0600 | [diff] [blame] | 356 | * @gadget_driver: Gadget driver controlling this driver |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 357 | * |
| 358 | * Devices default to reporting self powered operation. Devices which rely |
Sebastian Andrzej Siewior | fac3a43 | 2012-09-06 20:11:01 +0200 | [diff] [blame] | 359 | * on bus powered operation should report this in their @bind method. |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 360 | * |
Sebastian Andrzej Siewior | fac3a43 | 2012-09-06 20:11:01 +0200 | [diff] [blame] | 361 | * Before returning from @bind, various fields in the template descriptor |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 362 | * may be overridden. These include the idVendor/idProduct/bcdDevice values |
| 363 | * normally to bind the appropriate host side driver, and the three strings |
| 364 | * (iManufacturer, iProduct, iSerialNumber) normally used to provide user |
| 365 | * meaningful device identifiers. (The strings will not be defined unless |
| 366 | * they are defined in @dev and @strings.) The correct ep0 maxpacket size |
| 367 | * is also reported, as defined by the underlying controller driver. |
| 368 | */ |
| 369 | struct usb_composite_driver { |
| 370 | const char *name; |
| 371 | const struct usb_device_descriptor *dev; |
| 372 | struct usb_gadget_strings **strings; |
Tatyana Brokhman | 35a0e0b | 2011-06-29 16:41:49 +0300 | [diff] [blame] | 373 | enum usb_device_speed max_speed; |
Michal Nazarewicz | ad1a810 | 2010-08-12 17:43:46 +0200 | [diff] [blame] | 374 | unsigned needs_serial:1; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 375 | |
Sebastian Andrzej Siewior | fac3a43 | 2012-09-06 20:11:01 +0200 | [diff] [blame] | 376 | int (*bind)(struct usb_composite_dev *cdev); |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 377 | int (*unbind)(struct usb_composite_dev *); |
David Brownell | 8942939 | 2009-03-19 14:14:17 -0700 | [diff] [blame] | 378 | |
Michal Nazarewicz | 3f3e12d | 2010-06-21 13:57:08 +0200 | [diff] [blame] | 379 | void (*disconnect)(struct usb_composite_dev *); |
| 380 | |
David Brownell | 8942939 | 2009-03-19 14:14:17 -0700 | [diff] [blame] | 381 | /* global suspend hooks */ |
| 382 | void (*suspend)(struct usb_composite_dev *); |
| 383 | void (*resume)(struct usb_composite_dev *); |
Sebastian Andrzej Siewior | ffe0b33 | 2012-09-07 09:53:17 +0200 | [diff] [blame] | 384 | struct usb_gadget_driver gadget_driver; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 385 | }; |
| 386 | |
Sebastian Andrzej Siewior | 03e42bd | 2012-09-06 20:11:04 +0200 | [diff] [blame] | 387 | extern int usb_composite_probe(struct usb_composite_driver *driver); |
Michal Nazarewicz | 07a18bd | 2010-08-12 17:43:54 +0200 | [diff] [blame] | 388 | extern void usb_composite_unregister(struct usb_composite_driver *driver); |
Roger Quadros | 1b9ba00 | 2011-05-09 13:08:06 +0300 | [diff] [blame] | 389 | extern void usb_composite_setup_continue(struct usb_composite_dev *cdev); |
Sebastian Andrzej Siewior | a592334 | 2012-12-23 21:10:20 +0100 | [diff] [blame] | 390 | extern int composite_dev_prepare(struct usb_composite_driver *composite, |
| 391 | struct usb_composite_dev *cdev); |
Andrzej Pietrasiewicz | da42431 | 2014-05-08 14:06:26 +0200 | [diff] [blame] | 392 | extern int composite_os_desc_req_prepare(struct usb_composite_dev *cdev, |
| 393 | struct usb_ep *ep0); |
Sebastian Andrzej Siewior | a592334 | 2012-12-23 21:10:20 +0100 | [diff] [blame] | 394 | void composite_dev_cleanup(struct usb_composite_dev *cdev); |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 395 | |
Sebastian Andrzej Siewior | a592334 | 2012-12-23 21:10:20 +0100 | [diff] [blame] | 396 | static inline struct usb_composite_driver *to_cdriver( |
| 397 | struct usb_gadget_driver *gdrv) |
| 398 | { |
| 399 | return container_of(gdrv, struct usb_composite_driver, gadget_driver); |
| 400 | } |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 401 | |
Andrzej Pietrasiewicz | 19824d5 | 2014-05-08 14:06:22 +0200 | [diff] [blame] | 402 | #define OS_STRING_QW_SIGN_LEN 14 |
| 403 | #define OS_STRING_IDX 0xEE |
| 404 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 405 | /** |
| 406 | * struct usb_composite_device - represents one composite usb gadget |
| 407 | * @gadget: read-only, abstracts the gadget's usb peripheral controller |
| 408 | * @req: used for control responses; buffer is pre-allocated |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 409 | * @os_desc_req: used for OS descriptors responses; buffer is pre-allocated |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 410 | * @config: the currently active configuration |
Andrzej Pietrasiewicz | 19824d5 | 2014-05-08 14:06:22 +0200 | [diff] [blame] | 411 | * @qw_sign: qwSignature part of the OS string |
| 412 | * @b_vendor_code: bMS_VendorCode part of the OS string |
| 413 | * @use_os_string: false by default, interested gadgets set it |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 414 | * @os_desc_config: the configuration to be used with OS descriptors |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 415 | * |
| 416 | * One of these devices is allocated and initialized before the |
| 417 | * associated device driver's bind() is called. |
| 418 | * |
| 419 | * OPEN ISSUE: it appears that some WUSB devices will need to be |
| 420 | * built by combining a normal (wired) gadget with a wireless one. |
| 421 | * This revision of the gadget framework should probably try to make |
| 422 | * sure doing that won't hurt too much. |
| 423 | * |
| 424 | * One notion for how to handle Wireless USB devices involves: |
| 425 | * (a) a second gadget here, discovery mechanism TBD, but likely |
| 426 | * needing separate "register/unregister WUSB gadget" calls; |
| 427 | * (b) updates to usb_gadget to include flags "is it wireless", |
| 428 | * "is it wired", plus (presumably in a wrapper structure) |
| 429 | * bandgroup and PHY info; |
| 430 | * (c) presumably a wireless_ep wrapping a usb_ep, and reporting |
| 431 | * wireless-specific parameters like maxburst and maxsequence; |
| 432 | * (d) configurations that are specific to wireless links; |
| 433 | * (e) function drivers that understand wireless configs and will |
| 434 | * support wireless for (additional) function instances; |
| 435 | * (f) a function to support association setup (like CBAF), not |
| 436 | * necessarily requiring a wireless adapter; |
| 437 | * (g) composite device setup that can create one or more wireless |
| 438 | * configs, including appropriate association setup support; |
| 439 | * (h) more, TBD. |
| 440 | */ |
| 441 | struct usb_composite_dev { |
| 442 | struct usb_gadget *gadget; |
| 443 | struct usb_request *req; |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 444 | struct usb_request *os_desc_req; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 445 | |
| 446 | struct usb_configuration *config; |
| 447 | |
Andrzej Pietrasiewicz | 19824d5 | 2014-05-08 14:06:22 +0200 | [diff] [blame] | 448 | /* OS String is a custom (yet popular) extension to the USB standard. */ |
| 449 | u8 qw_sign[OS_STRING_QW_SIGN_LEN]; |
| 450 | u8 b_vendor_code; |
Andrzej Pietrasiewicz | 37a3a53 | 2014-05-08 14:06:23 +0200 | [diff] [blame] | 451 | struct usb_configuration *os_desc_config; |
Andrzej Pietrasiewicz | 19824d5 | 2014-05-08 14:06:22 +0200 | [diff] [blame] | 452 | unsigned int use_os_string:1; |
| 453 | |
Randy Dunlap | cac85a8 | 2009-04-29 21:04:19 -0700 | [diff] [blame] | 454 | /* private: */ |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 455 | /* internals */ |
Fabien Chouteau | f48cf80 | 2010-04-23 14:21:26 +0200 | [diff] [blame] | 456 | unsigned int suspended:1; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 457 | struct usb_device_descriptor desc; |
| 458 | struct list_head configs; |
Sebastian Andrzej Siewior | 9bb2859 | 2012-12-23 21:10:22 +0100 | [diff] [blame] | 459 | struct list_head gstrings; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 460 | struct usb_composite_driver *driver; |
| 461 | u8 next_string_id; |
Sebastian Andrzej Siewior | cc2683c | 2012-09-10 15:01:58 +0200 | [diff] [blame] | 462 | char *def_manufacturer; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 463 | |
David Brownell | 60beed9 | 2008-08-18 17:38:22 -0700 | [diff] [blame] | 464 | /* the gadget driver won't enable the data pullup |
| 465 | * while the deactivation count is nonzero. |
| 466 | */ |
| 467 | unsigned deactivations; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 468 | |
Roger Quadros | 1b9ba00 | 2011-05-09 13:08:06 +0300 | [diff] [blame] | 469 | /* the composite driver won't complete the control transfer's |
| 470 | * data/status stages till delayed_status is zero. |
| 471 | */ |
| 472 | int delayed_status; |
| 473 | |
| 474 | /* protects deactivations and delayed_status counts*/ |
David Brownell | 60beed9 | 2008-08-18 17:38:22 -0700 | [diff] [blame] | 475 | spinlock_t lock; |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 476 | }; |
| 477 | |
| 478 | extern int usb_string_id(struct usb_composite_dev *c); |
Michal Nazarewicz | f2adc4f | 2010-06-16 12:07:59 +0200 | [diff] [blame] | 479 | extern int usb_string_ids_tab(struct usb_composite_dev *c, |
| 480 | struct usb_string *str); |
Sebastian Andrzej Siewior | 9bb2859 | 2012-12-23 21:10:22 +0100 | [diff] [blame] | 481 | extern struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev, |
| 482 | struct usb_gadget_strings **sp, unsigned n_strings); |
| 483 | |
Michal Nazarewicz | f2adc4f | 2010-06-16 12:07:59 +0200 | [diff] [blame] | 484 | extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n); |
| 485 | |
Sebastian Andrzej Siewior | 2d5a889 | 2012-12-23 21:10:21 +0100 | [diff] [blame] | 486 | extern void composite_disconnect(struct usb_gadget *gadget); |
| 487 | extern int composite_setup(struct usb_gadget *gadget, |
| 488 | const struct usb_ctrlrequest *ctrl); |
| 489 | |
Sebastian Andrzej Siewior | 7d16e8d | 2012-09-10 15:01:53 +0200 | [diff] [blame] | 490 | /* |
| 491 | * Some systems will need runtime overrides for the product identifiers |
| 492 | * published in the device descriptor, either numbers or strings or both. |
| 493 | * String parameters are in UTF-8 (superset of ASCII's 7 bit characters). |
| 494 | */ |
| 495 | struct usb_composite_overwrite { |
| 496 | u16 idVendor; |
| 497 | u16 idProduct; |
| 498 | u16 bcdDevice; |
Sebastian Andrzej Siewior | 1cf0d26 | 2012-09-10 15:01:54 +0200 | [diff] [blame] | 499 | char *serial_number; |
Sebastian Andrzej Siewior | 03de9bf | 2012-09-10 15:01:55 +0200 | [diff] [blame] | 500 | char *manufacturer; |
Sebastian Andrzej Siewior | 2d35ee4 | 2012-09-10 15:01:56 +0200 | [diff] [blame] | 501 | char *product; |
Sebastian Andrzej Siewior | 7d16e8d | 2012-09-10 15:01:53 +0200 | [diff] [blame] | 502 | }; |
| 503 | #define USB_GADGET_COMPOSITE_OPTIONS() \ |
| 504 | static struct usb_composite_overwrite coverwrite; \ |
| 505 | \ |
| 506 | module_param_named(idVendor, coverwrite.idVendor, ushort, S_IRUGO); \ |
| 507 | MODULE_PARM_DESC(idVendor, "USB Vendor ID"); \ |
| 508 | \ |
| 509 | module_param_named(idProduct, coverwrite.idProduct, ushort, S_IRUGO); \ |
| 510 | MODULE_PARM_DESC(idProduct, "USB Product ID"); \ |
| 511 | \ |
| 512 | module_param_named(bcdDevice, coverwrite.bcdDevice, ushort, S_IRUGO); \ |
Sebastian Andrzej Siewior | 1cf0d26 | 2012-09-10 15:01:54 +0200 | [diff] [blame] | 513 | MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)"); \ |
| 514 | \ |
| 515 | module_param_named(iSerialNumber, coverwrite.serial_number, charp, \ |
| 516 | S_IRUGO); \ |
Sebastian Andrzej Siewior | 03de9bf | 2012-09-10 15:01:55 +0200 | [diff] [blame] | 517 | MODULE_PARM_DESC(iSerialNumber, "SerialNumber string"); \ |
| 518 | \ |
| 519 | module_param_named(iManufacturer, coverwrite.manufacturer, charp, \ |
| 520 | S_IRUGO); \ |
Sebastian Andrzej Siewior | 2d35ee4 | 2012-09-10 15:01:56 +0200 | [diff] [blame] | 521 | MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string"); \ |
| 522 | \ |
| 523 | module_param_named(iProduct, coverwrite.product, charp, S_IRUGO); \ |
| 524 | MODULE_PARM_DESC(iProduct, "USB Product string") |
Sebastian Andrzej Siewior | 7d16e8d | 2012-09-10 15:01:53 +0200 | [diff] [blame] | 525 | |
| 526 | void usb_composite_overwrite_options(struct usb_composite_dev *cdev, |
| 527 | struct usb_composite_overwrite *covr); |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 528 | |
Sebastian Andrzej Siewior | ed9cbda | 2012-09-10 09:16:07 +0200 | [diff] [blame] | 529 | static inline u16 get_default_bcdDevice(void) |
| 530 | { |
| 531 | u16 bcdDevice; |
| 532 | |
| 533 | bcdDevice = bin2bcd((LINUX_VERSION_CODE >> 16 & 0xff)) << 8; |
| 534 | bcdDevice |= bin2bcd((LINUX_VERSION_CODE >> 8 & 0xff)); |
| 535 | return bcdDevice; |
| 536 | } |
| 537 | |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 538 | struct usb_function_driver { |
| 539 | const char *name; |
| 540 | struct module *mod; |
| 541 | struct list_head list; |
| 542 | struct usb_function_instance *(*alloc_inst)(void); |
| 543 | struct usb_function *(*alloc_func)(struct usb_function_instance *inst); |
| 544 | }; |
| 545 | |
| 546 | struct usb_function_instance { |
Sebastian Andrzej Siewior | 88af8bb | 2012-12-23 21:10:24 +0100 | [diff] [blame] | 547 | struct config_group group; |
| 548 | struct list_head cfs_list; |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 549 | struct usb_function_driver *fd; |
Andrzej Pietrasiewicz | 1933861 | 2013-12-03 15:15:21 +0100 | [diff] [blame] | 550 | int (*set_inst_name)(struct usb_function_instance *inst, |
| 551 | const char *name); |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 552 | void (*free_func_inst)(struct usb_function_instance *inst); |
| 553 | }; |
| 554 | |
| 555 | void usb_function_unregister(struct usb_function_driver *f); |
| 556 | int usb_function_register(struct usb_function_driver *newf); |
| 557 | void usb_put_function_instance(struct usb_function_instance *fi); |
| 558 | void usb_put_function(struct usb_function *f); |
| 559 | struct usb_function_instance *usb_get_function_instance(const char *name); |
| 560 | struct usb_function *usb_get_function(struct usb_function_instance *fi); |
| 561 | |
| 562 | struct usb_configuration *usb_get_config(struct usb_composite_dev *cdev, |
| 563 | int val); |
| 564 | int usb_add_config_only(struct usb_composite_dev *cdev, |
| 565 | struct usb_configuration *config); |
Sebastian Andrzej Siewior | b4735778 | 2012-12-23 21:10:05 +0100 | [diff] [blame] | 566 | void usb_remove_function(struct usb_configuration *c, struct usb_function *f); |
Sebastian Andrzej Siewior | de53c25 | 2012-12-23 21:10:00 +0100 | [diff] [blame] | 567 | |
| 568 | #define DECLARE_USB_FUNCTION(_name, _inst_alloc, _func_alloc) \ |
| 569 | static struct usb_function_driver _name ## usb_func = { \ |
| 570 | .name = __stringify(_name), \ |
| 571 | .mod = THIS_MODULE, \ |
| 572 | .alloc_inst = _inst_alloc, \ |
| 573 | .alloc_func = _func_alloc, \ |
| 574 | }; \ |
| 575 | MODULE_ALIAS("usbfunc:"__stringify(_name)); |
| 576 | |
| 577 | #define DECLARE_USB_FUNCTION_INIT(_name, _inst_alloc, _func_alloc) \ |
| 578 | DECLARE_USB_FUNCTION(_name, _inst_alloc, _func_alloc) \ |
| 579 | static int __init _name ## mod_init(void) \ |
| 580 | { \ |
| 581 | return usb_function_register(&_name ## usb_func); \ |
| 582 | } \ |
| 583 | static void __exit _name ## mod_exit(void) \ |
| 584 | { \ |
| 585 | usb_function_unregister(&_name ## usb_func); \ |
| 586 | } \ |
| 587 | module_init(_name ## mod_init); \ |
| 588 | module_exit(_name ## mod_exit) |
| 589 | |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 590 | /* messaging utils */ |
| 591 | #define DBG(d, fmt, args...) \ |
| 592 | dev_dbg(&(d)->gadget->dev , fmt , ## args) |
| 593 | #define VDBG(d, fmt, args...) \ |
| 594 | dev_vdbg(&(d)->gadget->dev , fmt , ## args) |
| 595 | #define ERROR(d, fmt, args...) \ |
| 596 | dev_err(&(d)->gadget->dev , fmt , ## args) |
Arjan van de Ven | b6c6393 | 2008-07-25 01:45:52 -0700 | [diff] [blame] | 597 | #define WARNING(d, fmt, args...) \ |
David Brownell | 40982be | 2008-06-19 17:52:58 -0700 | [diff] [blame] | 598 | dev_warn(&(d)->gadget->dev , fmt , ## args) |
| 599 | #define INFO(d, fmt, args...) \ |
| 600 | dev_info(&(d)->gadget->dev , fmt , ## args) |
| 601 | |
| 602 | #endif /* __LINUX_USB_COMPOSITE_H */ |