composite.h 25 KB

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