blob: 74f97cee3051893a70914a0f94aa00aef2426a2e [file] [log] [blame]
David Brownell40982be2008-06-19 17:52:58 -07001/*
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 Siewiored9cbda2012-09-10 09:16:07 +020037#include <linux/bcd.h>
38#include <linux/version.h>
David Brownell40982be2008-06-19 17:52:58 -070039#include <linux/usb/ch9.h>
40#include <linux/usb/gadget.h>
Sebastian Andrzej Siewiorbcb2f992012-10-22 22:14:57 +020041#include <linux/log2.h>
Sebastian Andrzej Siewior88af8bb2012-12-23 21:10:24 +010042#include <linux/configfs.h>
David Brownell40982be2008-06-19 17:52:58 -070043
Roger Quadros1b9ba002011-05-09 13:08:06 +030044/*
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 Brownell40982be2008-06-19 17:52:58 -070052
Sebastian Andrzej Siewiore13f17f2012-09-10 15:01:51 +020053/* big enough to hold our biggest descriptor */
54#define USB_COMP_EP0_BUFSIZ 1024
55
Chris Dickensbf54f312017-12-31 18:59:42 -080056/* OS feature descriptor length <= 4kB */
57#define USB_COMP_EP0_OS_DESC_BUFSIZ 4096
58
Sebastian Andrzej Siewiorbcb2f992012-10-22 22:14:57 +020059#define USB_MS_TO_HS_INTERVAL(x) (ilog2((x * 1000 / 125)) + 1)
David Brownell40982be2008-06-19 17:52:58 -070060struct usb_configuration;
61
62/**
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020063 * struct usb_os_desc_ext_prop - describes one "Extended Property"
64 * @entry: used to keep a list of extended properties
65 * @type: Extended Property type
66 * @name_len: Extended Property unicode name length, including terminating '\0'
67 * @name: Extended Property name
68 * @data_len: Length of Extended Property blob (for unicode store double len)
69 * @data: Extended Property blob
Andrzej Pietrasiewicz74194852014-05-08 14:06:28 +020070 * @item: Represents this Extended Property in configfs
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020071 */
72struct usb_os_desc_ext_prop {
73 struct list_head entry;
74 u8 type;
75 int name_len;
76 char *name;
77 int data_len;
78 char *data;
Andrzej Pietrasiewicz74194852014-05-08 14:06:28 +020079 struct config_item item;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020080};
81
82/**
83 * struct usb_os_desc - describes OS descriptors associated with one interface
84 * @ext_compat_id: 16 bytes of "Compatible ID" and "Subcompatible ID"
85 * @ext_prop: Extended Properties list
86 * @ext_prop_len: Total length of Extended Properties blobs
87 * @ext_prop_count: Number of Extended Properties
Andrzej Pietrasiewiczda424312014-05-08 14:06:26 +020088 * @opts_mutex: Optional mutex protecting config data of a usb_function_instance
89 * @group: Represents OS descriptors associated with an interface in configfs
Andrzej Pietrasiewicz74194852014-05-08 14:06:28 +020090 * @owner: Module associated with this OS descriptor
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020091 */
92struct usb_os_desc {
93 char *ext_compat_id;
94 struct list_head ext_prop;
95 int ext_prop_len;
96 int ext_prop_count;
Andrzej Pietrasiewiczda424312014-05-08 14:06:26 +020097 struct mutex *opts_mutex;
98 struct config_group group;
Andrzej Pietrasiewicz74194852014-05-08 14:06:28 +020099 struct module *owner;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200100};
101
102/**
103 * struct usb_os_desc_table - describes OS descriptors associated with one
104 * interface of a usb_function
105 * @if_id: Interface id
106 * @os_desc: "Extended Compatibility ID" and "Extended Properties" of the
107 * interface
108 *
109 * Each interface can have at most one "Extended Compatibility ID" and a
110 * number of "Extended Properties".
111 */
112struct usb_os_desc_table {
113 int if_id;
114 struct usb_os_desc *os_desc;
115};
116
117/**
David Brownell40982be2008-06-19 17:52:58 -0700118 * struct usb_function - describes one function of a configuration
119 * @name: For diagnostics, identifies the function.
120 * @strings: tables of strings, keyed by identifiers assigned during bind()
121 * and by language IDs provided in control requests
Nishanth Menon43febb22013-03-04 16:52:38 -0600122 * @fs_descriptors: Table of full (or low) speed descriptors, using interface and
David Brownell40982be2008-06-19 17:52:58 -0700123 * string identifiers assigned during @bind(). If this pointer is null,
124 * the function will not be available at full speed (or at low speed).
125 * @hs_descriptors: Table of high speed descriptors, using interface and
126 * string identifiers assigned during @bind(). If this pointer is null,
127 * the function will not be available at high speed.
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300128 * @ss_descriptors: Table of super speed descriptors, using interface and
129 * string identifiers assigned during @bind(). If this
130 * pointer is null after initiation, the function will not
131 * be available at super speed.
John Younf5c61222016-02-05 17:06:21 -0800132 * @ssp_descriptors: Table of super speed plus descriptors, using
133 * interface and string identifiers assigned during @bind(). If
134 * this pointer is null after initiation, the function will not
135 * be available at super speed plus.
David Brownell40982be2008-06-19 17:52:58 -0700136 * @config: assigned when @usb_add_function() is called; this is the
137 * configuration with which this function is associated.
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200138 * @os_desc_table: Table of (interface id, os descriptors) pairs. The function
139 * can expose more than one interface. If an interface is a member of
140 * an IAD, only the first interface of IAD has its entry in the table.
141 * @os_desc_n: Number of entries in os_desc_table
David Brownell40982be2008-06-19 17:52:58 -0700142 * @bind: Before the gadget can register, all of its functions bind() to the
143 * available resources including string and interface identifiers used
144 * in interface or class descriptors; endpoints; I/O buffers; and so on.
145 * @unbind: Reverses @bind; called as a side effect of unregistering the
146 * driver which added this function.
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100147 * @free_func: free the struct usb_function.
148 * @mod: (internal) points to the module that created this structure.
David Brownell40982be2008-06-19 17:52:58 -0700149 * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may
150 * initialize usb_ep.driver data at this time (when it is used).
151 * Note that setting an interface to its current altsetting resets
152 * interface state, and that all interfaces have a disabled state.
153 * @get_alt: Returns the active altsetting. If this is not provided,
154 * then only altsetting zero is supported.
155 * @disable: (REQUIRED) Indicates the function should be disabled. Reasons
156 * include host resetting or reconfiguring the gadget, and disconnection.
157 * @setup: Used for interface-specific control requests.
Andrzej Pietrasiewiczf563d232015-03-03 10:52:23 +0100158 * @req_match: Tests if a given class request can be handled by this function.
David Brownell40982be2008-06-19 17:52:58 -0700159 * @suspend: Notifies functions when the host stops sending USB traffic.
160 * @resume: Notifies functions when the host restarts USB traffic.
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300161 * @get_status: Returns function status as a reply to
Masanari Iidae2278672014-02-18 22:54:36 +0900162 * GetStatus() request when the recipient is Interface.
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300163 * @func_suspend: callback to be called when
164 * SetFeature(FUNCTION_SUSPEND) is reseived
David Brownell40982be2008-06-19 17:52:58 -0700165 *
166 * A single USB function uses one or more interfaces, and should in most
167 * cases support operation at both full and high speeds. Each function is
168 * associated by @usb_add_function() with a one configuration; that function
169 * causes @bind() to be called so resources can be allocated as part of
170 * setting up a gadget driver. Those resources include endpoints, which
171 * should be allocated using @usb_ep_autoconfig().
172 *
173 * To support dual speed operation, a function driver provides descriptors
174 * for both high and full speed operation. Except in rare cases that don't
175 * involve bulk endpoints, each speed needs different endpoint descriptors.
176 *
177 * Function drivers choose their own strategies for managing instance data.
178 * The simplest strategy just declares it "static', which means the function
179 * can only be activated once. If the function needs to be exposed in more
180 * than one configuration at a given speed, it needs to support multiple
181 * usb_function structures (one for each configuration).
182 *
183 * A more complex strategy might encapsulate a @usb_function structure inside
184 * a driver-specific instance structure to allows multiple activations. An
185 * example of multiple activations might be a CDC ACM function that supports
186 * two or more distinct instances within the same configuration, providing
187 * several independent logical data links to a USB host.
188 */
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100189
David Brownell40982be2008-06-19 17:52:58 -0700190struct usb_function {
191 const char *name;
192 struct usb_gadget_strings **strings;
Sebastian Andrzej Siewior10287ba2012-10-22 22:15:06 +0200193 struct usb_descriptor_header **fs_descriptors;
David Brownell40982be2008-06-19 17:52:58 -0700194 struct usb_descriptor_header **hs_descriptors;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300195 struct usb_descriptor_header **ss_descriptors;
John Younf5c61222016-02-05 17:06:21 -0800196 struct usb_descriptor_header **ssp_descriptors;
David Brownell40982be2008-06-19 17:52:58 -0700197
198 struct usb_configuration *config;
199
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200200 struct usb_os_desc_table *os_desc_table;
201 unsigned os_desc_n;
202
David Brownell40982be2008-06-19 17:52:58 -0700203 /* REVISIT: bind() functions can be marked __init, which
204 * makes trouble for section mismatch analysis. See if
205 * we can't restructure things to avoid mismatching.
206 * Related: unbind() may kfree() but bind() won't...
207 */
208
209 /* configuration management: bind/unbind */
210 int (*bind)(struct usb_configuration *,
211 struct usb_function *);
212 void (*unbind)(struct usb_configuration *,
213 struct usb_function *);
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100214 void (*free_func)(struct usb_function *f);
215 struct module *mod;
David Brownell40982be2008-06-19 17:52:58 -0700216
217 /* runtime state management */
218 int (*set_alt)(struct usb_function *,
219 unsigned interface, unsigned alt);
220 int (*get_alt)(struct usb_function *,
221 unsigned interface);
222 void (*disable)(struct usb_function *);
223 int (*setup)(struct usb_function *,
224 const struct usb_ctrlrequest *);
Andrzej Pietrasiewiczf563d232015-03-03 10:52:23 +0100225 bool (*req_match)(struct usb_function *,
Felix Hädicke1a00b452016-06-22 01:12:08 +0200226 const struct usb_ctrlrequest *,
227 bool config0);
David Brownell40982be2008-06-19 17:52:58 -0700228 void (*suspend)(struct usb_function *);
229 void (*resume)(struct usb_function *);
230
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300231 /* USB 3.0 additions */
232 int (*get_status)(struct usb_function *);
233 int (*func_suspend)(struct usb_function *,
234 u8 suspend_opt);
Randy Dunlapcac85a82009-04-29 21:04:19 -0700235 /* private: */
David Brownell40982be2008-06-19 17:52:58 -0700236 /* internals */
237 struct list_head list;
Laurent Pinchart52426582009-10-21 00:03:38 +0200238 DECLARE_BITMAP(endpoints, 32);
Sebastian Andrzej Siewior0062f6e2012-12-23 21:10:15 +0100239 const struct usb_function_instance *fi;
Robert Baldygad5bb9b82015-05-04 14:55:13 +0200240
241 unsigned int bind_deactivated:1;
David Brownell40982be2008-06-19 17:52:58 -0700242};
243
244int usb_add_function(struct usb_configuration *, struct usb_function *);
245
David Brownell60beed92008-08-18 17:38:22 -0700246int usb_function_deactivate(struct usb_function *);
247int usb_function_activate(struct usb_function *);
248
David Brownell40982be2008-06-19 17:52:58 -0700249int usb_interface_id(struct usb_configuration *, struct usb_function *);
250
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300251int config_ep_by_speed(struct usb_gadget *g, struct usb_function *f,
252 struct usb_ep *_ep);
253
David Brownell40982be2008-06-19 17:52:58 -0700254#define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */
255
256/**
257 * struct usb_configuration - represents one gadget configuration
258 * @label: For diagnostics, describes the configuration.
259 * @strings: Tables of strings, keyed by identifiers assigned during @bind()
260 * and by language IDs provided in control requests.
261 * @descriptors: Table of descriptors preceding all function descriptors.
262 * Examples include OTG and vendor-specific descriptors.
David Brownell40982be2008-06-19 17:52:58 -0700263 * @unbind: Reverses @bind; called as a side effect of unregistering the
264 * driver which added this configuration.
265 * @setup: Used to delegate control requests that aren't handled by standard
266 * device infrastructure or directed at a specific interface.
267 * @bConfigurationValue: Copied into configuration descriptor.
268 * @iConfiguration: Copied into configuration descriptor.
269 * @bmAttributes: Copied into configuration descriptor.
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100270 * @MaxPower: Power consumtion in mA. Used to compute bMaxPower in the
271 * configuration descriptor after considering the bus speed.
David Brownell40982be2008-06-19 17:52:58 -0700272 * @cdev: assigned by @usb_add_config() before calling @bind(); this is
273 * the device associated with this configuration.
274 *
275 * Configurations are building blocks for gadget drivers structured around
276 * function drivers. Simple USB gadgets require only one function and one
277 * configuration, and handle dual-speed hardware by always providing the same
278 * functionality. Slightly more complex gadgets may have more than one
279 * single-function configuration at a given speed; or have configurations
280 * that only work at one speed.
281 *
282 * Composite devices are, by definition, ones with configurations which
283 * include more than one function.
284 *
285 * The lifecycle of a usb_configuration includes allocation, initialization
286 * of the fields described above, and calling @usb_add_config() to set up
287 * internal data and bind it to a specific device. The configuration's
288 * @bind() method is then used to initialize all the functions and then
289 * call @usb_add_function() for them.
290 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300291 * Those functions would normally be independent of each other, but that's
David Brownell40982be2008-06-19 17:52:58 -0700292 * not mandatory. CDC WMC devices are an example where functions often
293 * depend on other functions, with some functions subsidiary to others.
294 * Such interdependency may be managed in any way, so long as all of the
295 * descriptors complete by the time the composite driver returns from
296 * its bind() routine.
297 */
298struct usb_configuration {
299 const char *label;
300 struct usb_gadget_strings **strings;
301 const struct usb_descriptor_header **descriptors;
302
303 /* REVISIT: bind() functions can be marked __init, which
304 * makes trouble for section mismatch analysis. See if
305 * we can't restructure things to avoid mismatching...
306 */
307
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200308 /* configuration management: unbind/setup */
David Brownell40982be2008-06-19 17:52:58 -0700309 void (*unbind)(struct usb_configuration *);
310 int (*setup)(struct usb_configuration *,
311 const struct usb_ctrlrequest *);
312
313 /* fields in the config descriptor */
314 u8 bConfigurationValue;
315 u8 iConfiguration;
316 u8 bmAttributes;
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100317 u16 MaxPower;
David Brownell40982be2008-06-19 17:52:58 -0700318
319 struct usb_composite_dev *cdev;
320
Randy Dunlapcac85a82009-04-29 21:04:19 -0700321 /* private: */
David Brownell40982be2008-06-19 17:52:58 -0700322 /* internals */
323 struct list_head list;
324 struct list_head functions;
325 u8 next_interface_id;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300326 unsigned superspeed:1;
David Brownell40982be2008-06-19 17:52:58 -0700327 unsigned highspeed:1;
328 unsigned fullspeed:1;
John Youn554eead2016-02-05 17:06:35 -0800329 unsigned superspeed_plus:1;
David Brownell40982be2008-06-19 17:52:58 -0700330 struct usb_function *interface[MAX_CONFIG_INTERFACES];
331};
332
333int usb_add_config(struct usb_composite_dev *,
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200334 struct usb_configuration *,
335 int (*)(struct usb_configuration *));
David Brownell40982be2008-06-19 17:52:58 -0700336
Benoit Goby51cce6f2012-05-10 10:07:57 +0200337void usb_remove_config(struct usb_composite_dev *,
338 struct usb_configuration *);
339
Sebastian Andrzej Siewior276e2e42012-09-06 20:11:21 +0200340/* predefined index for usb_composite_driver */
341enum {
342 USB_GADGET_MANUFACTURER_IDX = 0,
343 USB_GADGET_PRODUCT_IDX,
344 USB_GADGET_SERIAL_IDX,
345 USB_GADGET_FIRST_AVAIL_IDX,
346};
347
David Brownell40982be2008-06-19 17:52:58 -0700348/**
349 * struct usb_composite_driver - groups configurations into a gadget
350 * @name: For diagnostics, identifies the driver.
351 * @dev: Template descriptor for the device, including default device
352 * identifiers.
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200353 * @strings: tables of strings, keyed by identifiers assigned during @bind
Sebastian Andrzej Siewior276e2e42012-09-06 20:11:21 +0200354 * and language IDs provided in control requests. Note: The first entries
355 * are predefined. The first entry that may be used is
356 * USB_GADGET_FIRST_AVAIL_IDX
Tatyana Brokhman35a0e0b2011-06-29 16:41:49 +0300357 * @max_speed: Highest speed the driver supports.
Michal Nazarewiczad1a8102010-08-12 17:43:46 +0200358 * @needs_serial: set to 1 if the gadget needs userspace to provide
359 * a serial number. If one is not provided, warning will be printed.
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200360 * @bind: (REQUIRED) Used to allocate resources that are shared across the
361 * whole device, such as string IDs, and add its configurations using
362 * @usb_add_config(). This may fail by returning a negative errno
363 * value; it should return zero on successful initialization.
364 * @unbind: Reverses @bind; called as a side effect of unregistering
David Brownell40982be2008-06-19 17:52:58 -0700365 * this driver.
Randy Dunlapd187abb2010-08-11 12:07:13 -0700366 * @disconnect: optional driver disconnect method
David Brownell89429392009-03-19 14:14:17 -0700367 * @suspend: Notifies when the host stops sending USB traffic,
368 * after function notifications
369 * @resume: Notifies configuration when the host restarts USB traffic,
370 * before function notifications
Nishanth Menon43febb22013-03-04 16:52:38 -0600371 * @gadget_driver: Gadget driver controlling this driver
David Brownell40982be2008-06-19 17:52:58 -0700372 *
373 * Devices default to reporting self powered operation. Devices which rely
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200374 * on bus powered operation should report this in their @bind method.
David Brownell40982be2008-06-19 17:52:58 -0700375 *
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200376 * Before returning from @bind, various fields in the template descriptor
David Brownell40982be2008-06-19 17:52:58 -0700377 * may be overridden. These include the idVendor/idProduct/bcdDevice values
378 * normally to bind the appropriate host side driver, and the three strings
379 * (iManufacturer, iProduct, iSerialNumber) normally used to provide user
380 * meaningful device identifiers. (The strings will not be defined unless
381 * they are defined in @dev and @strings.) The correct ep0 maxpacket size
382 * is also reported, as defined by the underlying controller driver.
383 */
384struct usb_composite_driver {
385 const char *name;
386 const struct usb_device_descriptor *dev;
387 struct usb_gadget_strings **strings;
Tatyana Brokhman35a0e0b2011-06-29 16:41:49 +0300388 enum usb_device_speed max_speed;
Michal Nazarewiczad1a8102010-08-12 17:43:46 +0200389 unsigned needs_serial:1;
David Brownell40982be2008-06-19 17:52:58 -0700390
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200391 int (*bind)(struct usb_composite_dev *cdev);
David Brownell40982be2008-06-19 17:52:58 -0700392 int (*unbind)(struct usb_composite_dev *);
David Brownell89429392009-03-19 14:14:17 -0700393
Michal Nazarewicz3f3e12d2010-06-21 13:57:08 +0200394 void (*disconnect)(struct usb_composite_dev *);
395
David Brownell89429392009-03-19 14:14:17 -0700396 /* global suspend hooks */
397 void (*suspend)(struct usb_composite_dev *);
398 void (*resume)(struct usb_composite_dev *);
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +0200399 struct usb_gadget_driver gadget_driver;
David Brownell40982be2008-06-19 17:52:58 -0700400};
401
Sebastian Andrzej Siewior03e42bd2012-09-06 20:11:04 +0200402extern int usb_composite_probe(struct usb_composite_driver *driver);
Michal Nazarewicz07a18bd2010-08-12 17:43:54 +0200403extern void usb_composite_unregister(struct usb_composite_driver *driver);
Tobias Klauser7ec3ea12014-07-09 18:09:55 +0200404
405/**
406 * module_usb_composite_driver() - Helper macro for registering a USB gadget
407 * composite driver
408 * @__usb_composite_driver: usb_composite_driver struct
409 *
410 * Helper macro for USB gadget composite drivers which do not do anything
411 * special in module init/exit. This eliminates a lot of boilerplate. Each
412 * module may only use this macro once, and calling it replaces module_init()
413 * and module_exit()
414 */
415#define module_usb_composite_driver(__usb_composite_driver) \
416 module_driver(__usb_composite_driver, usb_composite_probe, \
417 usb_composite_unregister)
418
Roger Quadros1b9ba002011-05-09 13:08:06 +0300419extern void usb_composite_setup_continue(struct usb_composite_dev *cdev);
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +0100420extern int composite_dev_prepare(struct usb_composite_driver *composite,
421 struct usb_composite_dev *cdev);
Andrzej Pietrasiewiczda424312014-05-08 14:06:26 +0200422extern int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
423 struct usb_ep *ep0);
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +0100424void composite_dev_cleanup(struct usb_composite_dev *cdev);
David Brownell40982be2008-06-19 17:52:58 -0700425
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +0100426static inline struct usb_composite_driver *to_cdriver(
427 struct usb_gadget_driver *gdrv)
428{
429 return container_of(gdrv, struct usb_composite_driver, gadget_driver);
430}
David Brownell40982be2008-06-19 17:52:58 -0700431
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200432#define OS_STRING_QW_SIGN_LEN 14
433#define OS_STRING_IDX 0xEE
434
David Brownell40982be2008-06-19 17:52:58 -0700435/**
436 * struct usb_composite_device - represents one composite usb gadget
437 * @gadget: read-only, abstracts the gadget's usb peripheral controller
438 * @req: used for control responses; buffer is pre-allocated
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200439 * @os_desc_req: used for OS descriptors responses; buffer is pre-allocated
David Brownell40982be2008-06-19 17:52:58 -0700440 * @config: the currently active configuration
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200441 * @qw_sign: qwSignature part of the OS string
442 * @b_vendor_code: bMS_VendorCode part of the OS string
443 * @use_os_string: false by default, interested gadgets set it
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200444 * @os_desc_config: the configuration to be used with OS descriptors
Felipe Balbi6c93b532014-09-18 09:51:23 -0500445 * @setup_pending: true when setup request is queued but not completed
446 * @os_desc_pending: true when os_desc request is queued but not completed
David Brownell40982be2008-06-19 17:52:58 -0700447 *
448 * One of these devices is allocated and initialized before the
449 * associated device driver's bind() is called.
450 *
451 * OPEN ISSUE: it appears that some WUSB devices will need to be
452 * built by combining a normal (wired) gadget with a wireless one.
453 * This revision of the gadget framework should probably try to make
454 * sure doing that won't hurt too much.
455 *
456 * One notion for how to handle Wireless USB devices involves:
457 * (a) a second gadget here, discovery mechanism TBD, but likely
458 * needing separate "register/unregister WUSB gadget" calls;
459 * (b) updates to usb_gadget to include flags "is it wireless",
460 * "is it wired", plus (presumably in a wrapper structure)
461 * bandgroup and PHY info;
462 * (c) presumably a wireless_ep wrapping a usb_ep, and reporting
463 * wireless-specific parameters like maxburst and maxsequence;
464 * (d) configurations that are specific to wireless links;
465 * (e) function drivers that understand wireless configs and will
466 * support wireless for (additional) function instances;
467 * (f) a function to support association setup (like CBAF), not
468 * necessarily requiring a wireless adapter;
469 * (g) composite device setup that can create one or more wireless
470 * configs, including appropriate association setup support;
471 * (h) more, TBD.
472 */
473struct usb_composite_dev {
474 struct usb_gadget *gadget;
475 struct usb_request *req;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200476 struct usb_request *os_desc_req;
David Brownell40982be2008-06-19 17:52:58 -0700477
478 struct usb_configuration *config;
479
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200480 /* OS String is a custom (yet popular) extension to the USB standard. */
481 u8 qw_sign[OS_STRING_QW_SIGN_LEN];
482 u8 b_vendor_code;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200483 struct usb_configuration *os_desc_config;
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200484 unsigned int use_os_string:1;
485
Randy Dunlapcac85a82009-04-29 21:04:19 -0700486 /* private: */
David Brownell40982be2008-06-19 17:52:58 -0700487 /* internals */
Fabien Chouteauf48cf802010-04-23 14:21:26 +0200488 unsigned int suspended:1;
David Brownell40982be2008-06-19 17:52:58 -0700489 struct usb_device_descriptor desc;
490 struct list_head configs;
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +0100491 struct list_head gstrings;
David Brownell40982be2008-06-19 17:52:58 -0700492 struct usb_composite_driver *driver;
493 u8 next_string_id;
Sebastian Andrzej Siewiorcc2683c2012-09-10 15:01:58 +0200494 char *def_manufacturer;
David Brownell40982be2008-06-19 17:52:58 -0700495
David Brownell60beed92008-08-18 17:38:22 -0700496 /* the gadget driver won't enable the data pullup
497 * while the deactivation count is nonzero.
498 */
499 unsigned deactivations;
David Brownell40982be2008-06-19 17:52:58 -0700500
Roger Quadros1b9ba002011-05-09 13:08:06 +0300501 /* the composite driver won't complete the control transfer's
502 * data/status stages till delayed_status is zero.
503 */
504 int delayed_status;
505
506 /* protects deactivations and delayed_status counts*/
David Brownell60beed92008-08-18 17:38:22 -0700507 spinlock_t lock;
Felipe Balbi6c93b532014-09-18 09:51:23 -0500508
509 unsigned setup_pending:1;
510 unsigned os_desc_pending:1;
David Brownell40982be2008-06-19 17:52:58 -0700511};
512
513extern int usb_string_id(struct usb_composite_dev *c);
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +0200514extern int usb_string_ids_tab(struct usb_composite_dev *c,
515 struct usb_string *str);
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +0100516extern struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev,
517 struct usb_gadget_strings **sp, unsigned n_strings);
518
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +0200519extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n);
520
Sebastian Andrzej Siewior2d5a8892012-12-23 21:10:21 +0100521extern void composite_disconnect(struct usb_gadget *gadget);
522extern int composite_setup(struct usb_gadget *gadget,
523 const struct usb_ctrlrequest *ctrl);
Andrzej Pietrasiewicz3a571872014-10-08 12:03:36 +0200524extern void composite_suspend(struct usb_gadget *gadget);
525extern void composite_resume(struct usb_gadget *gadget);
Sebastian Andrzej Siewior2d5a8892012-12-23 21:10:21 +0100526
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +0200527/*
528 * Some systems will need runtime overrides for the product identifiers
529 * published in the device descriptor, either numbers or strings or both.
530 * String parameters are in UTF-8 (superset of ASCII's 7 bit characters).
531 */
532struct usb_composite_overwrite {
533 u16 idVendor;
534 u16 idProduct;
535 u16 bcdDevice;
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +0200536 char *serial_number;
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +0200537 char *manufacturer;
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +0200538 char *product;
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +0200539};
540#define USB_GADGET_COMPOSITE_OPTIONS() \
541 static struct usb_composite_overwrite coverwrite; \
542 \
543 module_param_named(idVendor, coverwrite.idVendor, ushort, S_IRUGO); \
544 MODULE_PARM_DESC(idVendor, "USB Vendor ID"); \
545 \
546 module_param_named(idProduct, coverwrite.idProduct, ushort, S_IRUGO); \
547 MODULE_PARM_DESC(idProduct, "USB Product ID"); \
548 \
549 module_param_named(bcdDevice, coverwrite.bcdDevice, ushort, S_IRUGO); \
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +0200550 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)"); \
551 \
552 module_param_named(iSerialNumber, coverwrite.serial_number, charp, \
553 S_IRUGO); \
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +0200554 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string"); \
555 \
556 module_param_named(iManufacturer, coverwrite.manufacturer, charp, \
557 S_IRUGO); \
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +0200558 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string"); \
559 \
560 module_param_named(iProduct, coverwrite.product, charp, S_IRUGO); \
561 MODULE_PARM_DESC(iProduct, "USB Product string")
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +0200562
563void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
564 struct usb_composite_overwrite *covr);
David Brownell40982be2008-06-19 17:52:58 -0700565
Sebastian Andrzej Siewiored9cbda2012-09-10 09:16:07 +0200566static inline u16 get_default_bcdDevice(void)
567{
568 u16 bcdDevice;
569
570 bcdDevice = bin2bcd((LINUX_VERSION_CODE >> 16 & 0xff)) << 8;
571 bcdDevice |= bin2bcd((LINUX_VERSION_CODE >> 8 & 0xff));
572 return bcdDevice;
573}
574
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100575struct usb_function_driver {
576 const char *name;
577 struct module *mod;
578 struct list_head list;
579 struct usb_function_instance *(*alloc_inst)(void);
580 struct usb_function *(*alloc_func)(struct usb_function_instance *inst);
581};
582
583struct usb_function_instance {
Sebastian Andrzej Siewior88af8bb2012-12-23 21:10:24 +0100584 struct config_group group;
585 struct list_head cfs_list;
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100586 struct usb_function_driver *fd;
Badhri Jagan Sridharan26cf9892014-12-15 16:42:27 -0800587 struct usb_function *f;
Andrzej Pietrasiewicz19338612013-12-03 15:15:21 +0100588 int (*set_inst_name)(struct usb_function_instance *inst,
589 const char *name);
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100590 void (*free_func_inst)(struct usb_function_instance *inst);
591};
592
593void usb_function_unregister(struct usb_function_driver *f);
594int usb_function_register(struct usb_function_driver *newf);
595void usb_put_function_instance(struct usb_function_instance *fi);
596void usb_put_function(struct usb_function *f);
597struct usb_function_instance *usb_get_function_instance(const char *name);
598struct usb_function *usb_get_function(struct usb_function_instance *fi);
599
600struct usb_configuration *usb_get_config(struct usb_composite_dev *cdev,
601 int val);
602int usb_add_config_only(struct usb_composite_dev *cdev,
603 struct usb_configuration *config);
Sebastian Andrzej Siewiorb47357782012-12-23 21:10:05 +0100604void usb_remove_function(struct usb_configuration *c, struct usb_function *f);
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100605
606#define DECLARE_USB_FUNCTION(_name, _inst_alloc, _func_alloc) \
607 static struct usb_function_driver _name ## usb_func = { \
608 .name = __stringify(_name), \
609 .mod = THIS_MODULE, \
610 .alloc_inst = _inst_alloc, \
611 .alloc_func = _func_alloc, \
612 }; \
613 MODULE_ALIAS("usbfunc:"__stringify(_name));
614
615#define DECLARE_USB_FUNCTION_INIT(_name, _inst_alloc, _func_alloc) \
616 DECLARE_USB_FUNCTION(_name, _inst_alloc, _func_alloc) \
617 static int __init _name ## mod_init(void) \
618 { \
619 return usb_function_register(&_name ## usb_func); \
620 } \
621 static void __exit _name ## mod_exit(void) \
622 { \
623 usb_function_unregister(&_name ## usb_func); \
624 } \
625 module_init(_name ## mod_init); \
626 module_exit(_name ## mod_exit)
627
David Brownell40982be2008-06-19 17:52:58 -0700628/* messaging utils */
629#define DBG(d, fmt, args...) \
630 dev_dbg(&(d)->gadget->dev , fmt , ## args)
631#define VDBG(d, fmt, args...) \
632 dev_vdbg(&(d)->gadget->dev , fmt , ## args)
633#define ERROR(d, fmt, args...) \
634 dev_err(&(d)->gadget->dev , fmt , ## args)
Arjan van de Venb6c63932008-07-25 01:45:52 -0700635#define WARNING(d, fmt, args...) \
David Brownell40982be2008-06-19 17:52:58 -0700636 dev_warn(&(d)->gadget->dev , fmt , ## args)
637#define INFO(d, fmt, args...) \
638 dev_info(&(d)->gadget->dev , fmt , ## args)
639
640#endif /* __LINUX_USB_COMPOSITE_H */