include/linux/usb/gadget.h

   1 /*
   2  * <linux/usb/gadget.h>
   3  *
   4  * We call the USB code inside a Linux-based peripheral device a "gadget"
   5  * driver, except for the hardware-specific bus glue.  One USB host can
   6  * master many USB gadgets, but the gadgets are only slaved to one host.
   7  *
   8  *
   9  * (C) Copyright 2002-2004 by David Brownell
  10  * All Rights Reserved.
  11  *
  12  * This software is licensed under the GNU GPL version 2.
  13  */
  14
  15 #ifndef __LINUX_USB_GADGET_H
  16 #define __LINUX_USB_GADGET_H
  17
  18 #include <linux/device.h>
  19 #include <linux/errno.h>
  20 #include <linux/init.h>
  21 #include <linux/list.h>
  22 #include <linux/slab.h>
  23 #include <linux/scatterlist.h>
  24 #include <linux/types.h>
  25 #include <linux/workqueue.h>
  26 #include <linux/usb/ch9.h>
  27
  28 struct usb_ep;
  29
  30 /**
  31  * struct usb_request - describes one i/o request
  32  * @buf: Buffer used for data.  Always provide this; some controllers
  33  *      only use PIO, or don't use DMA for some endpoints.
  34  * @dma: DMA address corresponding to 'buf'.  If you don't set this
  35  *      field, and the usb controller needs one, it is responsible
  36  *      for mapping and unmapping the buffer.
  37  * @sg: a scatterlist for SG-capable controllers.
  38  * @num_sgs: number of SG entries
  39  * @num_mapped_sgs: number of SG entries mapped to DMA (internal)
  40  * @length: Length of that data
  41  * @stream_id: The stream id, when USB3.0 bulk streams are being used
  42  * @no_interrupt: If true, hints that no completion irq is needed.
  43  *      Helpful sometimes with deep request queues that are handled
  44  *      directly by DMA controllers.
  45  * @zero: If true, when writing data, makes the last packet be "short"
  46  *     by adding a zero length packet as needed;
  47  * @short_not_ok: When reading data, makes short packets be
  48  *     treated as errors (queue stops advancing till cleanup).
  49  * @complete: Function called when request completes, so this request and
  50  *      its buffer may be re-used.  The function will always be called with
  51  *      interrupts disabled, and it must not sleep.
  52  *      Reads terminate with a short packet, or when the buffer fills,
  53  *      whichever comes first.  When writes terminate, some data bytes
  54  *      will usually still be in flight (often in a hardware fifo).
  55  *      Errors (for reads or writes) stop the queue from advancing
  56  *      until the completion function returns, so that any transfers
  57  *      invalidated by the error may first be dequeued.
  58  * @context: For use by the completion callback
  59  * @list: For use by the gadget driver.
  60  * @status: Reports completion code, zero or a negative errno.
  61  *      Normally, faults block the transfer queue from advancing until
  62  *      the completion callback returns.
  63  *      Code "-ESHUTDOWN" indicates completion caused by device disconnect,
  64  *      or when the driver disabled the endpoint.
  65  * @actual: Reports bytes transferred to/from the buffer.  For reads (OUT
  66  *      transfers) this may be less than the requested length.  If the
  67  *      short_not_ok flag is set, short reads are treated as errors
  68  *      even when status otherwise indicates successful completion.
  69  *      Note that for writes (IN transfers) some data bytes may still
  70  *      reside in a device-side FIFO when the request is reported as
  71  *      complete.
  72  *
  73  * These are allocated/freed through the endpoint they're used with.  The
  74  * hardware's driver can add extra per-request data to the memory it returns,
  75  * which often avoids separate memory allocations (potential failures),
  76  * later when the request is queued.
  77  *
  78  * Request flags affect request handling, such as whether a zero length
  79  * packet is written (the "zero" flag), whether a short read should be
  80  * treated as an error (blocking request queue advance, the "short_not_ok"
  81  * flag), or hinting that an interrupt is not required (the "no_interrupt"
  82  * flag, for use with deep request queues).
  83  *
  84  * Bulk endpoints can use any size buffers, and can also be used for interrupt
  85  * transfers. interrupt-only endpoints can be much less functional.
  86  *
  87  * NOTE:  this is analogous to 'struct urb' on the host side, except that
  88  * it's thinner and promotes more pre-allocation.
  89  */
  90
  91 struct usb_request {
  92         void                    *buf;
  93         unsigned                length;
  94         dma_addr_t              dma;
  95
  96         struct scatterlist      *sg;
  97         unsigned                num_sgs;
  98         unsigned                num_mapped_sgs;
  99
 100         unsigned                stream_id:16;
 101         unsigned                no_interrupt:1;
 102         unsigned                zero:1;
 103         unsigned                short_not_ok:1;
 104
 105         void                    (*complete)(struct usb_ep *ep,
 106                                         struct usb_request *req);
 107         void                    *context;
 108         struct list_head        list;
 109
 110         int                     status;
 111         unsigned                actual;
 112 };
 113
 114 /*-------------------------------------------------------------------------*/
 115
 116 /* endpoint-specific parts of the api to the usb controller hardware.
 117  * unlike the urb model, (de)multiplexing layers are not required.
 118  * (so this api could slash overhead if used on the host side...)
 119  *
 120  * note that device side usb controllers commonly differ in how many
 121  * endpoints they support, as well as their capabilities.
 122  */
 123 struct usb_ep_ops {
 124         int (*enable) (struct usb_ep *ep,
 125                 const struct usb_endpoint_descriptor *desc);
 126         int (*disable) (struct usb_ep *ep);
 127
 128         struct usb_request *(*alloc_request) (struct usb_ep *ep,
 129                 gfp_t gfp_flags);
 130         void (*free_request) (struct usb_ep *ep, struct usb_request *req);
 131
 132         int (*queue) (struct usb_ep *ep, struct usb_request *req,
 133                 gfp_t gfp_flags);
 134         int (*dequeue) (struct usb_ep *ep, struct usb_request *req);
 135
 136         int (*set_halt) (struct usb_ep *ep, int value);
 137         int (*set_wedge) (struct usb_ep *ep);
 138
 139         int (*fifo_status) (struct usb_ep *ep);
 140         void (*fifo_flush) (struct usb_ep *ep);
 141 };
 142
 143 /**
 144  * struct usb_ep_caps - endpoint capabilities description
 145  * @type_control:Endpoint supports control type (reserved for ep0).
 146  * @type_iso:Endpoint supports isochronous transfers.
 147  * @type_bulk:Endpoint supports bulk transfers.
 148  * @type_int:Endpoint supports interrupt transfers.
 149  * @dir_in:Endpoint supports IN direction.
 150  * @dir_out:Endpoint supports OUT direction.
 151  */
 152 struct usb_ep_caps {
 153         unsigned type_control:1;
 154         unsigned type_iso:1;
 155         unsigned type_bulk:1;
 156         unsigned type_int:1;
 157         unsigned dir_in:1;
 158         unsigned dir_out:1;
 159 };
 160
 161 #define USB_EP_CAPS_TYPE_CONTROL     0x01
 162 #define USB_EP_CAPS_TYPE_ISO         0x02
 163 #define USB_EP_CAPS_TYPE_BULK        0x04
 164 #define USB_EP_CAPS_TYPE_INT         0x08
 165 #define USB_EP_CAPS_TYPE_ALL \
 166         (USB_EP_CAPS_TYPE_ISO | USB_EP_CAPS_TYPE_BULK | USB_EP_CAPS_TYPE_INT)
 167 #define USB_EP_CAPS_DIR_IN           0x01
 168 #define USB_EP_CAPS_DIR_OUT          0x02
 169 #define USB_EP_CAPS_DIR_ALL  (USB_EP_CAPS_DIR_IN | USB_EP_CAPS_DIR_OUT)
 170
 171 #define USB_EP_CAPS(_type, _dir) \
 172         { \
 173                 .type_control = !!(_type & USB_EP_CAPS_TYPE_CONTROL), \
 174                 .type_iso = !!(_type & USB_EP_CAPS_TYPE_ISO), \
 175                 .type_bulk = !!(_type & USB_EP_CAPS_TYPE_BULK), \
 176                 .type_int = !!(_type & USB_EP_CAPS_TYPE_INT), \
 177                 .dir_in = !!(_dir & USB_EP_CAPS_DIR_IN), \
 178                 .dir_out = !!(_dir & USB_EP_CAPS_DIR_OUT), \
 179         }
 180
 181 /**
 182  * struct usb_ep - device side representation of USB endpoint
 183  * @name:identifier for the endpoint, such as "ep-a" or "ep9in-bulk"
 184  * @ops: Function pointers used to access hardware-specific operations.
 185  * @ep_list:the gadget's ep_list holds all of its endpoints
 186  * @caps:The structure describing types and directions supported by endoint.
 187  * @maxpacket:The maximum packet size used on this endpoint.  The initial
 188  *      value can sometimes be reduced (hardware allowing), according to
 189  *      the endpoint descriptor used to configure the endpoint.
 190  * @maxpacket_limit:The maximum packet size value which can be handled by this
 191  *      endpoint. It's set once by UDC driver when endpoint is initialized, and
 192  *      should not be changed. Should not be confused with maxpacket.
 193  * @max_streams: The maximum number of streams supported
 194  *      by this EP (0 - 16, actual number is 2^n)
 195  * @mult: multiplier, 'mult' value for SS Isoc EPs
 196  * @maxburst: the maximum number of bursts supported by this EP (for usb3)
 197  * @driver_data:for use by the gadget driver.
 198  * @address: used to identify the endpoint when finding descriptor that
 199  *      matches connection speed
 200  * @desc: endpoint descriptor.  This pointer is set before the endpoint is
 201  *      enabled and remains valid until the endpoint is disabled.
 202  * @comp_desc: In case of SuperSpeed support, this is the endpoint companion
 203  *      descriptor that is used to configure the endpoint
 204  *
 205  * the bus controller driver lists all the general purpose endpoints in
 206  * gadget->ep_list.  the control endpoint (gadget->ep0) is not in that list,
 207  * and is accessed only in response to a driver setup() callback.
 208  */
 209
 210 struct usb_ep {
 211         void                    *driver_data;
 212
 213         const char              *name;
 214         const struct usb_ep_ops *ops;
 215         struct list_head        ep_list;
 216         struct usb_ep_caps      caps;
 217         bool                    claimed;
 218         bool                    enabled;
 219         unsigned                maxpacket:16;
 220         unsigned                maxpacket_limit:16;
 221         unsigned                max_streams:16;
 222         unsigned                mult:2;
 223         unsigned                maxburst:5;
 224         u8                      address;
 225         const struct usb_endpoint_descriptor    *desc;
 226         const struct usb_ss_ep_comp_descriptor  *comp_desc;
 227 };
 228
 229 /*-------------------------------------------------------------------------*/
 230
 231 #if IS_ENABLED(CONFIG_USB_GADGET)
 232 void usb_ep_set_maxpacket_limit(struct usb_ep *ep, unsigned maxpacket_limit);
 233 int usb_ep_enable(struct usb_ep *ep);
 234 int usb_ep_disable(struct usb_ep *ep);
 235 struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags);
 236 void usb_ep_free_request(struct usb_ep *ep, struct usb_request *req);
 237 int usb_ep_queue(struct usb_ep *ep, struct usb_request *req, gfp_t gfp_flags);
 238 int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req);
 239 int usb_ep_set_halt(struct usb_ep *ep);
 240 int usb_ep_clear_halt(struct usb_ep *ep);
 241 int usb_ep_set_wedge(struct usb_ep *ep);
 242 int usb_ep_fifo_status(struct usb_ep *ep);
 243 void usb_ep_fifo_flush(struct usb_ep *ep);
 244 #else
 245 static inline void usb_ep_set_maxpacket_limit(struct usb_ep *ep,
 246                 unsigned maxpacket_limit)
 247 { }
 248 static inline int usb_ep_enable(struct usb_ep *ep)
 249 { return 0; }
 250 static inline int usb_ep_disable(struct usb_ep *ep)
 251 { return 0; }
 252 static inline struct usb_request *usb_ep_alloc_request(struct usb_ep *ep,
 253                 gfp_t gfp_flags)
 254 { return NULL; }
 255 static inline void usb_ep_free_request(struct usb_ep *ep,
 256                 struct usb_request *req)
 257 { }
 258 static inline int usb_ep_queue(struct usb_ep *ep, struct usb_request *req,
 259                 gfp_t gfp_flags)
 260 { return 0; }
 261 static inline int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req)
 262 { return 0; }
 263 static inline int usb_ep_set_halt(struct usb_ep *ep)
 264 { return 0; }
 265 static inline int usb_ep_clear_halt(struct usb_ep *ep)
 266 { return 0; }
 267 static inline int usb_ep_set_wedge(struct usb_ep *ep)
 268 { return 0; }
 269 static inline int usb_ep_fifo_status(struct usb_ep *ep)
 270 { return 0; }
 271 static inline void usb_ep_fifo_flush(struct usb_ep *ep)
 272 { }
 273 #endif /* USB_GADGET */
 274
 275 /*-------------------------------------------------------------------------*/
 276
 277 struct usb_dcd_config_params {
 278         __u8  bU1devExitLat;    /* U1 Device exit Latency */
 279 #define USB_DEFAULT_U1_DEV_EXIT_LAT     0x01    /* Less then 1 microsec */
 280         __le16 bU2DevExitLat;   /* U2 Device exit Latency */
 281 #define USB_DEFAULT_U2_DEV_EXIT_LAT     0x1F4   /* Less then 500 microsec */
 282 };
 283
 284
 285 struct usb_gadget;
 286 struct usb_gadget_driver;
 287 struct usb_udc;
 288
 289 /* the rest of the api to the controller hardware: device operations,
 290  * which don't involve endpoints (or i/o).
 291  */
 292 struct usb_gadget_ops {
 293         int     (*get_frame)(struct usb_gadget *);
 294         int     (*wakeup)(struct usb_gadget *);
 295         int     (*set_selfpowered) (struct usb_gadget *, int is_selfpowered);
 296         int     (*vbus_session) (struct usb_gadget *, int is_active);
 297         int     (*vbus_draw) (struct usb_gadget *, unsigned mA);
 298         int     (*pullup) (struct usb_gadget *, int is_on);
 299         int     (*ioctl)(struct usb_gadget *,
 300                                 unsigned code, unsigned long param);
 301         void    (*get_config_params)(struct usb_dcd_config_params *);
 302         int     (*udc_start)(struct usb_gadget *,
 303                         struct usb_gadget_driver *);
 304         int     (*udc_stop)(struct usb_gadget *);
 305         struct usb_ep *(*match_ep)(struct usb_gadget *,
 306                         struct usb_endpoint_descriptor *,
 307                         struct usb_ss_ep_comp_descriptor *);
 308 };
 309
 310 /**
 311  * struct usb_gadget - represents a usb slave device
 312  * @work: (internal use) Workqueue to be used for sysfs_notify()
 313  * @udc: struct usb_udc pointer for this gadget
 314  * @ops: Function pointers used to access hardware-specific operations.
 315  * @ep0: Endpoint zero, used when reading or writing responses to
 316  *      driver setup() requests
 317  * @ep_list: List of other endpoints supported by the device.
 318  * @speed: Speed of current connection to USB host.
 319  * @max_speed: Maximal speed the UDC can handle.  UDC must support this
 320  *      and all slower speeds.
 321  * @state: the state we are now (attached, suspended, configured, etc)
 322  * @name: Identifies the controller hardware type.  Used in diagnostics
 323  *      and sometimes configuration.
 324  * @dev: Driver model state for this abstract device.
 325  * @out_epnum: last used out ep number
 326  * @in_epnum: last used in ep number
 327  * @otg_caps: OTG capabilities of this gadget.
 328  * @sg_supported: true if we can handle scatter-gather
 329  * @is_otg: True if the USB device port uses a Mini-AB jack, so that the
 330  *      gadget driver must provide a USB OTG descriptor.
 331  * @is_a_peripheral: False unless is_otg, the "A" end of a USB cable
 332  *      is in the Mini-AB jack, and HNP has been used to switch roles
 333  *      so that the "A" device currently acts as A-Peripheral, not A-Host.
 334  * @a_hnp_support: OTG device feature flag, indicating that the A-Host
 335  *      supports HNP at this port.
 336  * @a_alt_hnp_support: OTG device feature flag, indicating that the A-Host
 337  *      only supports HNP on a different root port.
 338  * @b_hnp_enable: OTG device feature flag, indicating that the A-Host
 339  *      enabled HNP support.
 340  * @hnp_polling_support: OTG device feature flag, indicating if the OTG device
 341  *      in peripheral mode can support HNP polling.
 342  * @host_request_flag: OTG device feature flag, indicating if A-Peripheral
 343  *      or B-Peripheral wants to take host role.
 344  * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to
 345  *      MaxPacketSize.
 346  * @is_selfpowered: if the gadget is self-powered.
 347  * @deactivated: True if gadget is deactivated - in deactivated state it cannot
 348  *      be connected.
 349  * @connected: True if gadget is connected.
 350  *
 351  * Gadgets have a mostly-portable "gadget driver" implementing device
 352  * functions, handling all usb configurations and interfaces.  Gadget
 353  * drivers talk to hardware-specific code indirectly, through ops vectors.
 354  * That insulates the gadget driver from hardware details, and packages
 355  * the hardware endpoints through generic i/o queues.  The "usb_gadget"
 356  * and "usb_ep" interfaces provide that insulation from the hardware.
 357  *
 358  * Except for the driver data, all fields in this structure are
 359  * read-only to the gadget driver.  That driver data is part of the
 360  * "driver model" infrastructure in 2.6 (and later) kernels, and for
 361  * earlier systems is grouped in a similar structure that's not known
 362  * to the rest of the kernel.
 363  *
 364  * Values of the three OTG device feature flags are updated before the
 365  * setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before
 366  * driver suspend() calls.  They are valid only when is_otg, and when the
 367  * device is acting as a B-Peripheral (so is_a_peripheral is false).
 368  */
 369 struct usb_gadget {
 370         struct work_struct              work;
 371         struct usb_udc                  *udc;
 372         /* readonly to gadget driver */
 373         const struct usb_gadget_ops     *ops;
 374         struct usb_ep                   *ep0;
 375         struct list_head                ep_list;        /* of usb_ep */
 376         enum usb_device_speed           speed;
 377         enum usb_device_speed           max_speed;
 378         enum usb_device_state           state;
 379         const char                      *name;
 380         struct device                   dev;
 381         unsigned                        out_epnum;
 382         unsigned                        in_epnum;
 383         struct usb_otg_caps             *otg_caps;
 384
 385         unsigned                        sg_supported:1;
 386         unsigned                        is_otg:1;
 387         unsigned                        is_a_peripheral:1;
 388         unsigned                        b_hnp_enable:1;
 389         unsigned                        a_hnp_support:1;
 390         unsigned                        a_alt_hnp_support:1;
 391         unsigned                        hnp_polling_support:1;
 392         unsigned                        host_request_flag:1;
 393         unsigned                        quirk_ep_out_aligned_size:1;
 394         unsigned                        quirk_altset_not_supp:1;
 395         unsigned                        quirk_stall_not_supp:1;
 396         unsigned                        quirk_zlp_not_supp:1;
 397         unsigned                        is_selfpowered:1;
 398         unsigned                        deactivated:1;
 399         unsigned                        connected:1;
 400 };
 401 #define work_to_gadget(w)       (container_of((w), struct usb_gadget, work))
 402
 403 static inline void set_gadget_data(struct usb_gadget *gadget, void *data)
 404         { dev_set_drvdata(&gadget->dev, data); }
 405 static inline void *get_gadget_data(struct usb_gadget *gadget)
 406         { return dev_get_drvdata(&gadget->dev); }
 407 static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev)
 408 {
 409         return container_of(dev, struct usb_gadget, dev);
 410 }
 411
 412 /* iterates the non-control endpoints; 'tmp' is a struct usb_ep pointer */
 413 #define gadget_for_each_ep(tmp, gadget) \
 414         list_for_each_entry(tmp, &(gadget)->ep_list, ep_list)
 415
 416 /**
 417  * usb_ep_align_maybe - returns @len aligned to ep's maxpacketsize if gadget
 418  *      requires quirk_ep_out_aligned_size, otherwise reguens len.
 419  * @g: controller to check for quirk
 420  * @ep: the endpoint whose maxpacketsize is used to align @len
 421  * @len: buffer size's length to align to @ep's maxpacketsize
 422  *
 423  * This helper is used in case it's required for any reason to check and maybe
 424  * align buffer's size to an ep's maxpacketsize.
 425  */
 426 static inline size_t
 427 usb_ep_align_maybe(struct usb_gadget *g, struct usb_ep *ep, size_t len)
 428 {
 429         return !g->quirk_ep_out_aligned_size ? len :
 430                         round_up(len, (size_t)ep->desc->wMaxPacketSize);
 431 }
 432
 433 /**
 434  * gadget_is_altset_supported - return true iff the hardware supports
 435  *      altsettings
 436  * @g: controller to check for quirk
 437  */
 438 static inline int gadget_is_altset_supported(struct usb_gadget *g)
 439 {
 440         return !g->quirk_altset_not_supp;
 441 }
 442
 443 /**
 444  * gadget_is_stall_supported - return true iff the hardware supports stalling
 445  * @g: controller to check for quirk
 446  */
 447 static inline int gadget_is_stall_supported(struct usb_gadget *g)
 448 {
 449         return !g->quirk_stall_not_supp;
 450 }
 451
 452 /**
 453  * gadget_is_zlp_supported - return true iff the hardware supports zlp
 454  * @g: controller to check for quirk
 455  */
 456 static inline int gadget_is_zlp_supported(struct usb_gadget *g)
 457 {
 458         return !g->quirk_zlp_not_supp;
 459 }
 460
 461 /**
 462  * gadget_is_dualspeed - return true iff the hardware handles high speed
 463  * @g: controller that might support both high and full speeds
 464  */
 465 static inline int gadget_is_dualspeed(struct usb_gadget *g)
 466 {
 467         return g->max_speed >= USB_SPEED_HIGH;
 468 }
 469
 470 /**
 471  * gadget_is_superspeed() - return true if the hardware handles superspeed
 472  * @g: controller that might support superspeed
 473  */
 474 static inline int gadget_is_superspeed(struct usb_gadget *g)
 475 {
 476         return g->max_speed >= USB_SPEED_SUPER;
 477 }
 478
 479 /**
 480  * gadget_is_superspeed_plus() - return true if the hardware handles
 481  *      superspeed plus
 482  * @g: controller that might support superspeed plus
 483  */
 484 static inline int gadget_is_superspeed_plus(struct usb_gadget *g)
 485 {
 486         return g->max_speed >= USB_SPEED_SUPER_PLUS;
 487 }
 488
 489 /**
 490  * gadget_is_otg - return true iff the hardware is OTG-ready
 491  * @g: controller that might have a Mini-AB connector
 492  *
 493  * This is a runtime test, since kernels with a USB-OTG stack sometimes
 494  * run on boards which only have a Mini-B (or Mini-A) connector.
 495  */
 496 static inline int gadget_is_otg(struct usb_gadget *g)
 497 {
 498 #ifdef CONFIG_USB_OTG
 499         return g->is_otg;
 500 #else
 501         return 0;
 502 #endif
 503 }
 504
 505 /*-------------------------------------------------------------------------*/
 506
 507 #if IS_ENABLED(CONFIG_USB_GADGET)
 508 int usb_gadget_frame_number(struct usb_gadget *gadget);
 509 int usb_gadget_wakeup(struct usb_gadget *gadget);
 510 int usb_gadget_set_selfpowered(struct usb_gadget *gadget);
 511 int usb_gadget_clear_selfpowered(struct usb_gadget *gadget);
 512 int usb_gadget_vbus_connect(struct usb_gadget *gadget);
 513 int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA);
 514 int usb_gadget_vbus_disconnect(struct usb_gadget *gadget);
 515 int usb_gadget_connect(struct usb_gadget *gadget);
 516 int usb_gadget_disconnect(struct usb_gadget *gadget);
 517 int usb_gadget_deactivate(struct usb_gadget *gadget);
 518 int usb_gadget_activate(struct usb_gadget *gadget);
 519 #else
 520 static inline int usb_gadget_frame_number(struct usb_gadget *gadget)
 521 { return 0; }
 522 static inline int usb_gadget_wakeup(struct usb_gadget *gadget)
 523 { return 0; }
 524 static inline int usb_gadget_set_selfpowered(struct usb_gadget *gadget)
 525 { return 0; }
 526 static inline int usb_gadget_clear_selfpowered(struct usb_gadget *gadget)
 527 { return 0; }
 528 static inline int usb_gadget_vbus_connect(struct usb_gadget *gadget)
 529 { return 0; }
 530 static inline int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA)
 531 { return 0; }
 532 static inline int usb_gadget_vbus_disconnect(struct usb_gadget *gadget)
 533 { return 0; }
 534 static inline int usb_gadget_connect(struct usb_gadget *gadget)
 535 { return 0; }
 536 static inline int usb_gadget_disconnect(struct usb_gadget *gadget)
 537 { return 0; }
 538 static inline int usb_gadget_deactivate(struct usb_gadget *gadget)
 539 { return 0; }
 540 static inline int usb_gadget_activate(struct usb_gadget *gadget)
 541 { return 0; }
 542 #endif /* CONFIG_USB_GADGET */
 543
 544 /*-------------------------------------------------------------------------*/
 545
 546 /**
 547  * struct usb_gadget_driver - driver for usb 'slave' devices
 548  * @function: String describing the gadget's function
 549  * @max_speed: Highest speed the driver handles.
 550  * @setup: Invoked for ep0 control requests that aren't handled by
 551  *      the hardware level driver. Most calls must be handled by
 552  *      the gadget driver, including descriptor and configuration
 553  *      management.  The 16 bit members of the setup data are in
 554  *      USB byte order. Called in_interrupt; this may not sleep.  Driver
 555  *      queues a response to ep0, or returns negative to stall.
 556  * @disconnect: Invoked after all transfers have been stopped,
 557  *      when the host is disconnected.  May be called in_interrupt; this
 558  *      may not sleep.  Some devices can't detect disconnect, so this might
 559  *      not be called except as part of controller shutdown.
 560  * @bind: the driver's bind callback
 561  * @unbind: Invoked when the driver is unbound from a gadget,
 562  *      usually from rmmod (after a disconnect is reported).
 563  *      Called in a context that permits sleeping.
 564  * @suspend: Invoked on USB suspend.  May be called in_interrupt.
 565  * @resume: Invoked on USB resume.  May be called in_interrupt.
 566  * @reset: Invoked on USB bus reset. It is mandatory for all gadget drivers
 567  *      and should be called in_interrupt.
 568  * @driver: Driver model state for this driver.
 569  * @udc_name: A name of UDC this driver should be bound to. If udc_name is NULL,
 570  *      this driver will be bound to any available UDC.
 571  * @pending: UDC core private data used for deferred probe of this driver.
 572  * @match_existing_only: If udc is not found, return an error and don't add this
 573  *      gadget driver to list of pending driver
 574  *
 575  * Devices are disabled till a gadget driver successfully bind()s, which
 576  * means the driver will handle setup() requests needed to enumerate (and
 577  * meet "chapter 9" requirements) then do some useful work.
 578  *
 579  * If gadget->is_otg is true, the gadget driver must provide an OTG
 580  * descriptor during enumeration, or else fail the bind() call.  In such
 581  * cases, no USB traffic may flow until both bind() returns without
 582  * having called usb_gadget_disconnect(), and the USB host stack has
 583  * initialized.
 584  *
 585  * Drivers use hardware-specific knowledge to configure the usb hardware.
 586  * endpoint addressing is only one of several hardware characteristics that
 587  * are in descriptors the ep0 implementation returns from setup() calls.
 588  *
 589  * Except for ep0 implementation, most driver code shouldn't need change to
 590  * run on top of different usb controllers.  It'll use endpoints set up by
 591  * that ep0 implementation.
 592  *
 593  * The usb controller driver handles a few standard usb requests.  Those
 594  * include set_address, and feature flags for devices, interfaces, and
 595  * endpoints (the get_status, set_feature, and clear_feature requests).
 596  *
 597  * Accordingly, the driver's setup() callback must always implement all
 598  * get_descriptor requests, returning at least a device descriptor and
 599  * a configuration descriptor.  Drivers must make sure the endpoint
 600  * descriptors match any hardware constraints. Some hardware also constrains
 601  * other descriptors. (The pxa250 allows only configurations 1, 2, or 3).
 602  *
 603  * The driver's setup() callback must also implement set_configuration,
 604  * and should also implement set_interface, get_configuration, and
 605  * get_interface.  Setting a configuration (or interface) is where
 606  * endpoints should be activated or (config 0) shut down.
 607  *
 608  * (Note that only the default control endpoint is supported.  Neither
 609  * hosts nor devices generally support control traffic except to ep0.)
 610  *
 611  * Most devices will ignore USB suspend/resume operations, and so will
 612  * not provide those callbacks.  However, some may need to change modes
 613  * when the host is not longer directing those activities.  For example,
 614  * local controls (buttons, dials, etc) may need to be re-enabled since
 615  * the (remote) host can't do that any longer; or an error state might
 616  * be cleared, to make the device behave identically whether or not
 617  * power is maintained.
 618  */
 619 struct usb_gadget_driver {
 620         char                    *function;
 621         enum usb_device_speed   max_speed;
 622         int                     (*bind)(struct usb_gadget *gadget,
 623                                         struct usb_gadget_driver *driver);
 624         void                    (*unbind)(struct usb_gadget *);
 625         int                     (*setup)(struct usb_gadget *,
 626                                         const struct usb_ctrlrequest *);
 627         void                    (*disconnect)(struct usb_gadget *);
 628         void                    (*suspend)(struct usb_gadget *);
 629         void                    (*resume)(struct usb_gadget *);
 630         void                    (*reset)(struct usb_gadget *);
 631
 632         /* FIXME support safe rmmod */
 633         struct device_driver    driver;
 634
 635         char                    *udc_name;
 636         struct list_head        pending;
 637         unsigned                match_existing_only:1;
 638 };
 639
 640
 641
 642 /*-------------------------------------------------------------------------*/
 643
 644 /* driver modules register and unregister, as usual.
 645  * these calls must be made in a context that can sleep.
 646  *
 647  * these will usually be implemented directly by the hardware-dependent
 648  * usb bus interface driver, which will only support a single driver.
 649  */
 650
 651 /**
 652  * usb_gadget_probe_driver - probe a gadget driver
 653  * @driver: the driver being registered
 654  * Context: can sleep
 655  *
 656  * Call this in your gadget driver's module initialization function,
 657  * to tell the underlying usb controller driver about your driver.
 658  * The @bind() function will be called to bind it to a gadget before this
 659  * registration call returns.  It's expected that the @bind() function will
 660  * be in init sections.
 661  */
 662 int usb_gadget_probe_driver(struct usb_gadget_driver *driver);
 663
 664 /**
 665  * usb_gadget_unregister_driver - unregister a gadget driver
 666  * @driver:the driver being unregistered
 667  * Context: can sleep
 668  *
 669  * Call this in your gadget driver's module cleanup function,
 670  * to tell the underlying usb controller that your driver is
 671  * going away.  If the controller is connected to a USB host,
 672  * it will first disconnect().  The driver is also requested
 673  * to unbind() and clean up any device state, before this procedure
 674  * finally returns.  It's expected that the unbind() functions
 675  * will in in exit sections, so may not be linked in some kernels.
 676  */
 677 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver);
 678
 679 extern int usb_add_gadget_udc_release(struct device *parent,
 680                 struct usb_gadget *gadget, void (*release)(struct device *dev));
 681 extern int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget);
 682 extern void usb_del_gadget_udc(struct usb_gadget *gadget);
 683 extern char *usb_get_gadget_udc_name(void);
 684
 685 /*-------------------------------------------------------------------------*/
 686
 687 /* utility to simplify dealing with string descriptors */
 688
 689 /**
 690  * struct usb_string - wraps a C string and its USB id
 691  * @id:the (nonzero) ID for this string
 692  * @s:the string, in UTF-8 encoding
 693  *
 694  * If you're using usb_gadget_get_string(), use this to wrap a string
 695  * together with its ID.
 696  */
 697 struct usb_string {
 698         u8                      id;
 699         const char              *s;
 700 };
 701
 702 /**
 703  * struct usb_gadget_strings - a set of USB strings in a given language
 704  * @language:identifies the strings' language (0x0409 for en-us)
 705  * @strings:array of strings with their ids
 706  *
 707  * If you're using usb_gadget_get_string(), use this to wrap all the
 708  * strings for a given language.
 709  */
 710 struct usb_gadget_strings {
 711         u16                     language;       /* 0x0409 for en-us */
 712         struct usb_string       *strings;
 713 };
 714
 715 struct usb_gadget_string_container {
 716         struct list_head        list;
 717         u8                      *stash[0];
 718 };
 719
 720 /* put descriptor for string with that id into buf (buflen >= 256) */
 721 int usb_gadget_get_string(struct usb_gadget_strings *table, int id, u8 *buf);
 722
 723 /*-------------------------------------------------------------------------*/
 724
 725 /* utility to simplify managing config descriptors */
 726
 727 /* write vector of descriptors into buffer */
 728 int usb_descriptor_fillbuf(void *, unsigned,
 729                 const struct usb_descriptor_header **);
 730
 731 /* build config descriptor from single descriptor vector */
 732 int usb_gadget_config_buf(const struct usb_config_descriptor *config,
 733         void *buf, unsigned buflen, const struct usb_descriptor_header **desc);
 734
 735 /* copy a NULL-terminated vector of descriptors */
 736 struct usb_descriptor_header **usb_copy_descriptors(
 737                 struct usb_descriptor_header **);
 738
 739 /**
 740  * usb_free_descriptors - free descriptors returned by usb_copy_descriptors()
 741  * @v: vector of descriptors
 742  */
 743 static inline void usb_free_descriptors(struct usb_descriptor_header **v)
 744 {
 745         kfree(v);
 746 }
 747
 748 struct usb_function;
 749 int usb_assign_descriptors(struct usb_function *f,
 750                 struct usb_descriptor_header **fs,
 751                 struct usb_descriptor_header **hs,
 752                 struct usb_descriptor_header **ss,
 753                 struct usb_descriptor_header **ssp);
 754 void usb_free_all_descriptors(struct usb_function *f);
 755
 756 struct usb_descriptor_header *usb_otg_descriptor_alloc(
 757                                 struct usb_gadget *gadget);
 758 int usb_otg_descriptor_init(struct usb_gadget *gadget,
 759                 struct usb_descriptor_header *otg_desc);
 760 /*-------------------------------------------------------------------------*/
 761
 762 /* utility to simplify map/unmap of usb_requests to/from DMA */
 763
 764 extern int usb_gadget_map_request_by_dev(struct device *dev,
 765                 struct usb_request *req, int is_in);
 766 extern int usb_gadget_map_request(struct usb_gadget *gadget,
 767                 struct usb_request *req, int is_in);
 768
 769 extern void usb_gadget_unmap_request_by_dev(struct device *dev,
 770                 struct usb_request *req, int is_in);
 771 extern void usb_gadget_unmap_request(struct usb_gadget *gadget,
 772                 struct usb_request *req, int is_in);
 773
 774 /*-------------------------------------------------------------------------*/
 775
 776 /* utility to set gadget state properly */
 777
 778 extern void usb_gadget_set_state(struct usb_gadget *gadget,
 779                 enum usb_device_state state);
 780
 781 /*-------------------------------------------------------------------------*/
 782
 783 /* utility to tell udc core that the bus reset occurs */
 784 extern void usb_gadget_udc_reset(struct usb_gadget *gadget,
 785                 struct usb_gadget_driver *driver);
 786
 787 /*-------------------------------------------------------------------------*/
 788
 789 /* utility to give requests back to the gadget layer */
 790
 791 extern void usb_gadget_giveback_request(struct usb_ep *ep,
 792                 struct usb_request *req);
 793
 794 /*-------------------------------------------------------------------------*/
 795
 796 /* utility to find endpoint by name */
 797
 798 extern struct usb_ep *gadget_find_ep_by_name(struct usb_gadget *g,
 799                 const char *name);
 800
 801 /*-------------------------------------------------------------------------*/
 802
 803 /* utility to check if endpoint caps match descriptor needs */
 804
 805 extern int usb_gadget_ep_match_desc(struct usb_gadget *gadget,
 806                 struct usb_ep *ep, struct usb_endpoint_descriptor *desc,
 807                 struct usb_ss_ep_comp_descriptor *ep_comp);
 808
 809 /*-------------------------------------------------------------------------*/
 810
 811 /* utility to update vbus status for udc core, it may be scheduled */
 812 extern void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status);
 813
 814 /*-------------------------------------------------------------------------*/
 815
 816 /* utility wrapping a simple endpoint selection policy */
 817
 818 extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *,
 819                         struct usb_endpoint_descriptor *);
 820
 821
 822 extern struct usb_ep *usb_ep_autoconfig_ss(struct usb_gadget *,
 823                         struct usb_endpoint_descriptor *,
 824                         struct usb_ss_ep_comp_descriptor *);
 825
 826 extern void usb_ep_autoconfig_release(struct usb_ep *);
 827
 828 extern void usb_ep_autoconfig_reset(struct usb_gadget *);
 829
 830 #endif /* __LINUX_USB_GADGET_H */