include/linux/usb/gadget.h

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