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