include/linux/usb/composite.h

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