blob: 2b81b24eb5aa30d852046d7ab8ef39d46145250d [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
Sebastian Andrzej Siewiorbcb2f992012-10-22 22:14:57 +020056#define USB_MS_TO_HS_INTERVAL(x) (ilog2((x * 1000 / 125)) + 1)
David Brownell40982be2008-06-19 17:52:58 -070057struct usb_configuration;
58
59/**
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020060 * 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 Pietrasiewicz74194852014-05-08 14:06:28 +020067 * @item: Represents this Extended Property in configfs
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020068 */
69struct 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 Pietrasiewicz74194852014-05-08 14:06:28 +020076 struct config_item item;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020077};
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 Pietrasiewiczda424312014-05-08 14:06:26 +020085 * @opts_mutex: Optional mutex protecting config data of a usb_function_instance
86 * @group: Represents OS descriptors associated with an interface in configfs
Andrzej Pietrasiewicz74194852014-05-08 14:06:28 +020087 * @owner: Module associated with this OS descriptor
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020088 */
89struct 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 Pietrasiewiczda424312014-05-08 14:06:26 +020094 struct mutex *opts_mutex;
95 struct config_group group;
Andrzej Pietrasiewicz74194852014-05-08 14:06:28 +020096 struct module *owner;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020097};
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 */
109struct usb_os_desc_table {
110 int if_id;
111 struct usb_os_desc *os_desc;
112};
113
114/**
David Brownell40982be2008-06-19 17:52:58 -0700115 * 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 Menon43febb22013-03-04 16:52:38 -0600119 * @fs_descriptors: Table of full (or low) speed descriptors, using interface and
David Brownell40982be2008-06-19 17:52:58 -0700120 * 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 Brokhmanbdb64d72011-06-29 16:41:50 +0300125 * @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.
John Younf5c61222016-02-05 17:06:21 -0800129 * @ssp_descriptors: Table of super speed plus descriptors, using
130 * interface and string identifiers assigned during @bind(). If
131 * this pointer is null after initiation, the function will not
132 * be available at super speed plus.
David Brownell40982be2008-06-19 17:52:58 -0700133 * @config: assigned when @usb_add_function() is called; this is the
134 * configuration with which this function is associated.
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200135 * @os_desc_table: Table of (interface id, os descriptors) pairs. The function
136 * can expose more than one interface. If an interface is a member of
137 * an IAD, only the first interface of IAD has its entry in the table.
138 * @os_desc_n: Number of entries in os_desc_table
David Brownell40982be2008-06-19 17:52:58 -0700139 * @bind: Before the gadget can register, all of its functions bind() to the
140 * available resources including string and interface identifiers used
141 * in interface or class descriptors; endpoints; I/O buffers; and so on.
142 * @unbind: Reverses @bind; called as a side effect of unregistering the
143 * driver which added this function.
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100144 * @free_func: free the struct usb_function.
145 * @mod: (internal) points to the module that created this structure.
David Brownell40982be2008-06-19 17:52:58 -0700146 * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may
147 * initialize usb_ep.driver data at this time (when it is used).
148 * Note that setting an interface to its current altsetting resets
149 * interface state, and that all interfaces have a disabled state.
150 * @get_alt: Returns the active altsetting. If this is not provided,
151 * then only altsetting zero is supported.
152 * @disable: (REQUIRED) Indicates the function should be disabled. Reasons
153 * include host resetting or reconfiguring the gadget, and disconnection.
154 * @setup: Used for interface-specific control requests.
Andrzej Pietrasiewiczf563d232015-03-03 10:52:23 +0100155 * @req_match: Tests if a given class request can be handled by this function.
David Brownell40982be2008-06-19 17:52:58 -0700156 * @suspend: Notifies functions when the host stops sending USB traffic.
157 * @resume: Notifies functions when the host restarts USB traffic.
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300158 * @get_status: Returns function status as a reply to
Masanari Iidae2278672014-02-18 22:54:36 +0900159 * GetStatus() request when the recipient is Interface.
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300160 * @func_suspend: callback to be called when
161 * SetFeature(FUNCTION_SUSPEND) is reseived
David Brownell40982be2008-06-19 17:52:58 -0700162 *
163 * A single USB function uses one or more interfaces, and should in most
164 * cases support operation at both full and high speeds. Each function is
165 * associated by @usb_add_function() with a one configuration; that function
166 * causes @bind() to be called so resources can be allocated as part of
167 * setting up a gadget driver. Those resources include endpoints, which
168 * should be allocated using @usb_ep_autoconfig().
169 *
170 * To support dual speed operation, a function driver provides descriptors
171 * for both high and full speed operation. Except in rare cases that don't
172 * involve bulk endpoints, each speed needs different endpoint descriptors.
173 *
174 * Function drivers choose their own strategies for managing instance data.
175 * The simplest strategy just declares it "static', which means the function
176 * can only be activated once. If the function needs to be exposed in more
177 * than one configuration at a given speed, it needs to support multiple
178 * usb_function structures (one for each configuration).
179 *
180 * A more complex strategy might encapsulate a @usb_function structure inside
181 * a driver-specific instance structure to allows multiple activations. An
182 * example of multiple activations might be a CDC ACM function that supports
183 * two or more distinct instances within the same configuration, providing
184 * several independent logical data links to a USB host.
185 */
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100186
David Brownell40982be2008-06-19 17:52:58 -0700187struct usb_function {
188 const char *name;
189 struct usb_gadget_strings **strings;
Sebastian Andrzej Siewior10287ba2012-10-22 22:15:06 +0200190 struct usb_descriptor_header **fs_descriptors;
David Brownell40982be2008-06-19 17:52:58 -0700191 struct usb_descriptor_header **hs_descriptors;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300192 struct usb_descriptor_header **ss_descriptors;
John Younf5c61222016-02-05 17:06:21 -0800193 struct usb_descriptor_header **ssp_descriptors;
David Brownell40982be2008-06-19 17:52:58 -0700194
195 struct usb_configuration *config;
196
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200197 struct usb_os_desc_table *os_desc_table;
198 unsigned os_desc_n;
199
David Brownell40982be2008-06-19 17:52:58 -0700200 /* REVISIT: bind() functions can be marked __init, which
201 * makes trouble for section mismatch analysis. See if
202 * we can't restructure things to avoid mismatching.
203 * Related: unbind() may kfree() but bind() won't...
204 */
205
206 /* configuration management: bind/unbind */
207 int (*bind)(struct usb_configuration *,
208 struct usb_function *);
209 void (*unbind)(struct usb_configuration *,
210 struct usb_function *);
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100211 void (*free_func)(struct usb_function *f);
212 struct module *mod;
David Brownell40982be2008-06-19 17:52:58 -0700213
214 /* runtime state management */
215 int (*set_alt)(struct usb_function *,
216 unsigned interface, unsigned alt);
217 int (*get_alt)(struct usb_function *,
218 unsigned interface);
219 void (*disable)(struct usb_function *);
220 int (*setup)(struct usb_function *,
221 const struct usb_ctrlrequest *);
Andrzej Pietrasiewiczf563d232015-03-03 10:52:23 +0100222 bool (*req_match)(struct usb_function *,
223 const struct usb_ctrlrequest *);
David Brownell40982be2008-06-19 17:52:58 -0700224 void (*suspend)(struct usb_function *);
225 void (*resume)(struct usb_function *);
226
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300227 /* USB 3.0 additions */
228 int (*get_status)(struct usb_function *);
229 int (*func_suspend)(struct usb_function *,
230 u8 suspend_opt);
Randy Dunlapcac85a82009-04-29 21:04:19 -0700231 /* private: */
David Brownell40982be2008-06-19 17:52:58 -0700232 /* internals */
233 struct list_head list;
Laurent Pinchart52426582009-10-21 00:03:38 +0200234 DECLARE_BITMAP(endpoints, 32);
Sebastian Andrzej Siewior0062f6e2012-12-23 21:10:15 +0100235 const struct usb_function_instance *fi;
Robert Baldygad5bb9b82015-05-04 14:55:13 +0200236
237 unsigned int bind_deactivated:1;
David Brownell40982be2008-06-19 17:52:58 -0700238};
239
240int usb_add_function(struct usb_configuration *, struct usb_function *);
241
David Brownell60beed92008-08-18 17:38:22 -0700242int usb_function_deactivate(struct usb_function *);
243int usb_function_activate(struct usb_function *);
244
David Brownell40982be2008-06-19 17:52:58 -0700245int usb_interface_id(struct usb_configuration *, struct usb_function *);
246
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300247int config_ep_by_speed(struct usb_gadget *g, struct usb_function *f,
248 struct usb_ep *_ep);
249
David Brownell40982be2008-06-19 17:52:58 -0700250#define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */
251
252/**
253 * struct usb_configuration - represents one gadget configuration
254 * @label: For diagnostics, describes the configuration.
255 * @strings: Tables of strings, keyed by identifiers assigned during @bind()
256 * and by language IDs provided in control requests.
257 * @descriptors: Table of descriptors preceding all function descriptors.
258 * Examples include OTG and vendor-specific descriptors.
David Brownell40982be2008-06-19 17:52:58 -0700259 * @unbind: Reverses @bind; called as a side effect of unregistering the
260 * driver which added this configuration.
261 * @setup: Used to delegate control requests that aren't handled by standard
262 * device infrastructure or directed at a specific interface.
263 * @bConfigurationValue: Copied into configuration descriptor.
264 * @iConfiguration: Copied into configuration descriptor.
265 * @bmAttributes: Copied into configuration descriptor.
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100266 * @MaxPower: Power consumtion in mA. Used to compute bMaxPower in the
267 * configuration descriptor after considering the bus speed.
David Brownell40982be2008-06-19 17:52:58 -0700268 * @cdev: assigned by @usb_add_config() before calling @bind(); this is
269 * the device associated with this configuration.
270 *
271 * Configurations are building blocks for gadget drivers structured around
272 * function drivers. Simple USB gadgets require only one function and one
273 * configuration, and handle dual-speed hardware by always providing the same
274 * functionality. Slightly more complex gadgets may have more than one
275 * single-function configuration at a given speed; or have configurations
276 * that only work at one speed.
277 *
278 * Composite devices are, by definition, ones with configurations which
279 * include more than one function.
280 *
281 * The lifecycle of a usb_configuration includes allocation, initialization
282 * of the fields described above, and calling @usb_add_config() to set up
283 * internal data and bind it to a specific device. The configuration's
284 * @bind() method is then used to initialize all the functions and then
285 * call @usb_add_function() for them.
286 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300287 * Those functions would normally be independent of each other, but that's
David Brownell40982be2008-06-19 17:52:58 -0700288 * not mandatory. CDC WMC devices are an example where functions often
289 * depend on other functions, with some functions subsidiary to others.
290 * Such interdependency may be managed in any way, so long as all of the
291 * descriptors complete by the time the composite driver returns from
292 * its bind() routine.
293 */
294struct usb_configuration {
295 const char *label;
296 struct usb_gadget_strings **strings;
297 const struct usb_descriptor_header **descriptors;
298
299 /* REVISIT: bind() functions can be marked __init, which
300 * makes trouble for section mismatch analysis. See if
301 * we can't restructure things to avoid mismatching...
302 */
303
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200304 /* configuration management: unbind/setup */
David Brownell40982be2008-06-19 17:52:58 -0700305 void (*unbind)(struct usb_configuration *);
306 int (*setup)(struct usb_configuration *,
307 const struct usb_ctrlrequest *);
308
309 /* fields in the config descriptor */
310 u8 bConfigurationValue;
311 u8 iConfiguration;
312 u8 bmAttributes;
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100313 u16 MaxPower;
David Brownell40982be2008-06-19 17:52:58 -0700314
315 struct usb_composite_dev *cdev;
316
Randy Dunlapcac85a82009-04-29 21:04:19 -0700317 /* private: */
David Brownell40982be2008-06-19 17:52:58 -0700318 /* internals */
319 struct list_head list;
320 struct list_head functions;
321 u8 next_interface_id;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300322 unsigned superspeed:1;
David Brownell40982be2008-06-19 17:52:58 -0700323 unsigned highspeed:1;
324 unsigned fullspeed:1;
John Youn554eead2016-02-05 17:06:35 -0800325 unsigned superspeed_plus:1;
David Brownell40982be2008-06-19 17:52:58 -0700326 struct usb_function *interface[MAX_CONFIG_INTERFACES];
327};
328
329int usb_add_config(struct usb_composite_dev *,
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200330 struct usb_configuration *,
331 int (*)(struct usb_configuration *));
David Brownell40982be2008-06-19 17:52:58 -0700332
Benoit Goby51cce6f2012-05-10 10:07:57 +0200333void usb_remove_config(struct usb_composite_dev *,
334 struct usb_configuration *);
335
Sebastian Andrzej Siewior276e2e42012-09-06 20:11:21 +0200336/* predefined index for usb_composite_driver */
337enum {
338 USB_GADGET_MANUFACTURER_IDX = 0,
339 USB_GADGET_PRODUCT_IDX,
340 USB_GADGET_SERIAL_IDX,
341 USB_GADGET_FIRST_AVAIL_IDX,
342};
343
David Brownell40982be2008-06-19 17:52:58 -0700344/**
345 * struct usb_composite_driver - groups configurations into a gadget
346 * @name: For diagnostics, identifies the driver.
347 * @dev: Template descriptor for the device, including default device
348 * identifiers.
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200349 * @strings: tables of strings, keyed by identifiers assigned during @bind
Sebastian Andrzej Siewior276e2e42012-09-06 20:11:21 +0200350 * and language IDs provided in control requests. Note: The first entries
351 * are predefined. The first entry that may be used is
352 * USB_GADGET_FIRST_AVAIL_IDX
Tatyana Brokhman35a0e0b2011-06-29 16:41:49 +0300353 * @max_speed: Highest speed the driver supports.
Michal Nazarewiczad1a8102010-08-12 17:43:46 +0200354 * @needs_serial: set to 1 if the gadget needs userspace to provide
355 * a serial number. If one is not provided, warning will be printed.
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200356 * @bind: (REQUIRED) Used to allocate resources that are shared across the
357 * whole device, such as string IDs, and add its configurations using
358 * @usb_add_config(). This may fail by returning a negative errno
359 * value; it should return zero on successful initialization.
360 * @unbind: Reverses @bind; called as a side effect of unregistering
David Brownell40982be2008-06-19 17:52:58 -0700361 * this driver.
Randy Dunlapd187abb2010-08-11 12:07:13 -0700362 * @disconnect: optional driver disconnect method
David Brownell89429392009-03-19 14:14:17 -0700363 * @suspend: Notifies when the host stops sending USB traffic,
364 * after function notifications
365 * @resume: Notifies configuration when the host restarts USB traffic,
366 * before function notifications
Nishanth Menon43febb22013-03-04 16:52:38 -0600367 * @gadget_driver: Gadget driver controlling this driver
David Brownell40982be2008-06-19 17:52:58 -0700368 *
369 * Devices default to reporting self powered operation. Devices which rely
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200370 * on bus powered operation should report this in their @bind method.
David Brownell40982be2008-06-19 17:52:58 -0700371 *
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200372 * Before returning from @bind, various fields in the template descriptor
David Brownell40982be2008-06-19 17:52:58 -0700373 * may be overridden. These include the idVendor/idProduct/bcdDevice values
374 * normally to bind the appropriate host side driver, and the three strings
375 * (iManufacturer, iProduct, iSerialNumber) normally used to provide user
376 * meaningful device identifiers. (The strings will not be defined unless
377 * they are defined in @dev and @strings.) The correct ep0 maxpacket size
378 * is also reported, as defined by the underlying controller driver.
379 */
380struct usb_composite_driver {
381 const char *name;
382 const struct usb_device_descriptor *dev;
383 struct usb_gadget_strings **strings;
Tatyana Brokhman35a0e0b2011-06-29 16:41:49 +0300384 enum usb_device_speed max_speed;
Michal Nazarewiczad1a8102010-08-12 17:43:46 +0200385 unsigned needs_serial:1;
David Brownell40982be2008-06-19 17:52:58 -0700386
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +0200387 int (*bind)(struct usb_composite_dev *cdev);
David Brownell40982be2008-06-19 17:52:58 -0700388 int (*unbind)(struct usb_composite_dev *);
David Brownell89429392009-03-19 14:14:17 -0700389
Michal Nazarewicz3f3e12d2010-06-21 13:57:08 +0200390 void (*disconnect)(struct usb_composite_dev *);
391
David Brownell89429392009-03-19 14:14:17 -0700392 /* global suspend hooks */
393 void (*suspend)(struct usb_composite_dev *);
394 void (*resume)(struct usb_composite_dev *);
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +0200395 struct usb_gadget_driver gadget_driver;
David Brownell40982be2008-06-19 17:52:58 -0700396};
397
Sebastian Andrzej Siewior03e42bd2012-09-06 20:11:04 +0200398extern int usb_composite_probe(struct usb_composite_driver *driver);
Michal Nazarewicz07a18bd2010-08-12 17:43:54 +0200399extern void usb_composite_unregister(struct usb_composite_driver *driver);
Tobias Klauser7ec3ea12014-07-09 18:09:55 +0200400
401/**
402 * module_usb_composite_driver() - Helper macro for registering a USB gadget
403 * composite driver
404 * @__usb_composite_driver: usb_composite_driver struct
405 *
406 * Helper macro for USB gadget composite drivers which do not do anything
407 * special in module init/exit. This eliminates a lot of boilerplate. Each
408 * module may only use this macro once, and calling it replaces module_init()
409 * and module_exit()
410 */
411#define module_usb_composite_driver(__usb_composite_driver) \
412 module_driver(__usb_composite_driver, usb_composite_probe, \
413 usb_composite_unregister)
414
Roger Quadros1b9ba002011-05-09 13:08:06 +0300415extern void usb_composite_setup_continue(struct usb_composite_dev *cdev);
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +0100416extern int composite_dev_prepare(struct usb_composite_driver *composite,
417 struct usb_composite_dev *cdev);
Andrzej Pietrasiewiczda424312014-05-08 14:06:26 +0200418extern int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
419 struct usb_ep *ep0);
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +0100420void composite_dev_cleanup(struct usb_composite_dev *cdev);
David Brownell40982be2008-06-19 17:52:58 -0700421
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +0100422static inline struct usb_composite_driver *to_cdriver(
423 struct usb_gadget_driver *gdrv)
424{
425 return container_of(gdrv, struct usb_composite_driver, gadget_driver);
426}
David Brownell40982be2008-06-19 17:52:58 -0700427
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200428#define OS_STRING_QW_SIGN_LEN 14
429#define OS_STRING_IDX 0xEE
430
David Brownell40982be2008-06-19 17:52:58 -0700431/**
432 * struct usb_composite_device - represents one composite usb gadget
433 * @gadget: read-only, abstracts the gadget's usb peripheral controller
434 * @req: used for control responses; buffer is pre-allocated
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200435 * @os_desc_req: used for OS descriptors responses; buffer is pre-allocated
David Brownell40982be2008-06-19 17:52:58 -0700436 * @config: the currently active configuration
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200437 * @qw_sign: qwSignature part of the OS string
438 * @b_vendor_code: bMS_VendorCode part of the OS string
439 * @use_os_string: false by default, interested gadgets set it
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200440 * @os_desc_config: the configuration to be used with OS descriptors
Felipe Balbi6c93b532014-09-18 09:51:23 -0500441 * @setup_pending: true when setup request is queued but not completed
442 * @os_desc_pending: true when os_desc request is queued but not completed
David Brownell40982be2008-06-19 17:52:58 -0700443 *
444 * One of these devices is allocated and initialized before the
445 * associated device driver's bind() is called.
446 *
447 * OPEN ISSUE: it appears that some WUSB devices will need to be
448 * built by combining a normal (wired) gadget with a wireless one.
449 * This revision of the gadget framework should probably try to make
450 * sure doing that won't hurt too much.
451 *
452 * One notion for how to handle Wireless USB devices involves:
453 * (a) a second gadget here, discovery mechanism TBD, but likely
454 * needing separate "register/unregister WUSB gadget" calls;
455 * (b) updates to usb_gadget to include flags "is it wireless",
456 * "is it wired", plus (presumably in a wrapper structure)
457 * bandgroup and PHY info;
458 * (c) presumably a wireless_ep wrapping a usb_ep, and reporting
459 * wireless-specific parameters like maxburst and maxsequence;
460 * (d) configurations that are specific to wireless links;
461 * (e) function drivers that understand wireless configs and will
462 * support wireless for (additional) function instances;
463 * (f) a function to support association setup (like CBAF), not
464 * necessarily requiring a wireless adapter;
465 * (g) composite device setup that can create one or more wireless
466 * configs, including appropriate association setup support;
467 * (h) more, TBD.
468 */
469struct usb_composite_dev {
470 struct usb_gadget *gadget;
471 struct usb_request *req;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200472 struct usb_request *os_desc_req;
David Brownell40982be2008-06-19 17:52:58 -0700473
474 struct usb_configuration *config;
475
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200476 /* OS String is a custom (yet popular) extension to the USB standard. */
477 u8 qw_sign[OS_STRING_QW_SIGN_LEN];
478 u8 b_vendor_code;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200479 struct usb_configuration *os_desc_config;
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +0200480 unsigned int use_os_string:1;
481
Randy Dunlapcac85a82009-04-29 21:04:19 -0700482 /* private: */
David Brownell40982be2008-06-19 17:52:58 -0700483 /* internals */
Fabien Chouteauf48cf802010-04-23 14:21:26 +0200484 unsigned int suspended:1;
David Brownell40982be2008-06-19 17:52:58 -0700485 struct usb_device_descriptor desc;
486 struct list_head configs;
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +0100487 struct list_head gstrings;
David Brownell40982be2008-06-19 17:52:58 -0700488 struct usb_composite_driver *driver;
489 u8 next_string_id;
Sebastian Andrzej Siewiorcc2683c2012-09-10 15:01:58 +0200490 char *def_manufacturer;
David Brownell40982be2008-06-19 17:52:58 -0700491
David Brownell60beed92008-08-18 17:38:22 -0700492 /* the gadget driver won't enable the data pullup
493 * while the deactivation count is nonzero.
494 */
495 unsigned deactivations;
David Brownell40982be2008-06-19 17:52:58 -0700496
Roger Quadros1b9ba002011-05-09 13:08:06 +0300497 /* the composite driver won't complete the control transfer's
498 * data/status stages till delayed_status is zero.
499 */
500 int delayed_status;
501
502 /* protects deactivations and delayed_status counts*/
David Brownell60beed92008-08-18 17:38:22 -0700503 spinlock_t lock;
Felipe Balbi6c93b532014-09-18 09:51:23 -0500504
505 unsigned setup_pending:1;
506 unsigned os_desc_pending:1;
David Brownell40982be2008-06-19 17:52:58 -0700507};
508
509extern int usb_string_id(struct usb_composite_dev *c);
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +0200510extern int usb_string_ids_tab(struct usb_composite_dev *c,
511 struct usb_string *str);
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +0100512extern struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev,
513 struct usb_gadget_strings **sp, unsigned n_strings);
514
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +0200515extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n);
516
Sebastian Andrzej Siewior2d5a8892012-12-23 21:10:21 +0100517extern void composite_disconnect(struct usb_gadget *gadget);
518extern int composite_setup(struct usb_gadget *gadget,
519 const struct usb_ctrlrequest *ctrl);
Andrzej Pietrasiewicz3a571872014-10-08 12:03:36 +0200520extern void composite_suspend(struct usb_gadget *gadget);
521extern void composite_resume(struct usb_gadget *gadget);
Sebastian Andrzej Siewior2d5a8892012-12-23 21:10:21 +0100522
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +0200523/*
524 * Some systems will need runtime overrides for the product identifiers
525 * published in the device descriptor, either numbers or strings or both.
526 * String parameters are in UTF-8 (superset of ASCII's 7 bit characters).
527 */
528struct usb_composite_overwrite {
529 u16 idVendor;
530 u16 idProduct;
531 u16 bcdDevice;
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +0200532 char *serial_number;
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +0200533 char *manufacturer;
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +0200534 char *product;
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +0200535};
536#define USB_GADGET_COMPOSITE_OPTIONS() \
537 static struct usb_composite_overwrite coverwrite; \
538 \
539 module_param_named(idVendor, coverwrite.idVendor, ushort, S_IRUGO); \
540 MODULE_PARM_DESC(idVendor, "USB Vendor ID"); \
541 \
542 module_param_named(idProduct, coverwrite.idProduct, ushort, S_IRUGO); \
543 MODULE_PARM_DESC(idProduct, "USB Product ID"); \
544 \
545 module_param_named(bcdDevice, coverwrite.bcdDevice, ushort, S_IRUGO); \
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +0200546 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)"); \
547 \
548 module_param_named(iSerialNumber, coverwrite.serial_number, charp, \
549 S_IRUGO); \
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +0200550 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string"); \
551 \
552 module_param_named(iManufacturer, coverwrite.manufacturer, charp, \
553 S_IRUGO); \
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +0200554 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string"); \
555 \
556 module_param_named(iProduct, coverwrite.product, charp, S_IRUGO); \
557 MODULE_PARM_DESC(iProduct, "USB Product string")
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +0200558
559void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
560 struct usb_composite_overwrite *covr);
David Brownell40982be2008-06-19 17:52:58 -0700561
Sebastian Andrzej Siewiored9cbda2012-09-10 09:16:07 +0200562static inline u16 get_default_bcdDevice(void)
563{
564 u16 bcdDevice;
565
566 bcdDevice = bin2bcd((LINUX_VERSION_CODE >> 16 & 0xff)) << 8;
567 bcdDevice |= bin2bcd((LINUX_VERSION_CODE >> 8 & 0xff));
568 return bcdDevice;
569}
570
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100571struct usb_function_driver {
572 const char *name;
573 struct module *mod;
574 struct list_head list;
575 struct usb_function_instance *(*alloc_inst)(void);
576 struct usb_function *(*alloc_func)(struct usb_function_instance *inst);
577};
578
579struct usb_function_instance {
Sebastian Andrzej Siewior88af8bb2012-12-23 21:10:24 +0100580 struct config_group group;
581 struct list_head cfs_list;
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100582 struct usb_function_driver *fd;
Andrzej Pietrasiewicz19338612013-12-03 15:15:21 +0100583 int (*set_inst_name)(struct usb_function_instance *inst,
584 const char *name);
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100585 void (*free_func_inst)(struct usb_function_instance *inst);
586};
587
588void usb_function_unregister(struct usb_function_driver *f);
589int usb_function_register(struct usb_function_driver *newf);
590void usb_put_function_instance(struct usb_function_instance *fi);
591void usb_put_function(struct usb_function *f);
592struct usb_function_instance *usb_get_function_instance(const char *name);
593struct usb_function *usb_get_function(struct usb_function_instance *fi);
594
595struct usb_configuration *usb_get_config(struct usb_composite_dev *cdev,
596 int val);
597int usb_add_config_only(struct usb_composite_dev *cdev,
598 struct usb_configuration *config);
Sebastian Andrzej Siewiorb47357782012-12-23 21:10:05 +0100599void usb_remove_function(struct usb_configuration *c, struct usb_function *f);
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100600
601#define DECLARE_USB_FUNCTION(_name, _inst_alloc, _func_alloc) \
602 static struct usb_function_driver _name ## usb_func = { \
603 .name = __stringify(_name), \
604 .mod = THIS_MODULE, \
605 .alloc_inst = _inst_alloc, \
606 .alloc_func = _func_alloc, \
607 }; \
608 MODULE_ALIAS("usbfunc:"__stringify(_name));
609
610#define DECLARE_USB_FUNCTION_INIT(_name, _inst_alloc, _func_alloc) \
611 DECLARE_USB_FUNCTION(_name, _inst_alloc, _func_alloc) \
612 static int __init _name ## mod_init(void) \
613 { \
614 return usb_function_register(&_name ## usb_func); \
615 } \
616 static void __exit _name ## mod_exit(void) \
617 { \
618 usb_function_unregister(&_name ## usb_func); \
619 } \
620 module_init(_name ## mod_init); \
621 module_exit(_name ## mod_exit)
622
David Brownell40982be2008-06-19 17:52:58 -0700623/* messaging utils */
624#define DBG(d, fmt, args...) \
625 dev_dbg(&(d)->gadget->dev , fmt , ## args)
626#define VDBG(d, fmt, args...) \
627 dev_vdbg(&(d)->gadget->dev , fmt , ## args)
628#define ERROR(d, fmt, args...) \
629 dev_err(&(d)->gadget->dev , fmt , ## args)
Arjan van de Venb6c63932008-07-25 01:45:52 -0700630#define WARNING(d, fmt, args...) \
David Brownell40982be2008-06-19 17:52:58 -0700631 dev_warn(&(d)->gadget->dev , fmt , ## args)
632#define INFO(d, fmt, args...) \
633 dev_info(&(d)->gadget->dev , fmt , ## args)
634
635#endif /* __LINUX_USB_COMPOSITE_H */