composite.h 25 KB

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