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