Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
David Brownell | 9454a57 | 2007-10-04 18:05:17 -0700 | [diff] [blame] | 2 | * <linux/usb/gadget.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Sergei Shtylyov | e9c23a2 | 2011-06-15 21:10:37 +0300 | [diff] [blame] | 18 | #include <linux/device.h> |
| 19 | #include <linux/errno.h> |
| 20 | #include <linux/init.h> |
| 21 | #include <linux/list.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 22 | #include <linux/slab.h> |
Felipe Balbi | 898c608 | 2011-11-22 11:11:50 +0200 | [diff] [blame] | 23 | #include <linux/scatterlist.h> |
Sergei Shtylyov | e9c23a2 | 2011-06-15 21:10:37 +0300 | [diff] [blame] | 24 | #include <linux/types.h> |
Felipe Balbi | 5702f75 | 2013-07-17 11:09:49 +0300 | [diff] [blame] | 25 | #include <linux/workqueue.h> |
Mark Brown | 325fd18 | 2011-06-07 15:39:18 +0100 | [diff] [blame] | 26 | #include <linux/usb/ch9.h> |
Hemant Kumar | 1127b9f | 2016-12-06 16:23:47 -0800 | [diff] [blame] | 27 | #include <linux/pm_runtime.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 28 | |
Felipe Balbi | 5e42d71 | 2016-05-31 13:39:21 +0300 | [diff] [blame] | 29 | #define UDC_TRACE_STR_MAX 512 |
| 30 | |
Mayank Rana | 83ad582 | 2016-08-09 14:17:22 -0700 | [diff] [blame] | 31 | /* |
| 32 | * The following are bit fields describing the usb_request.udc_priv word. |
| 33 | * These bit fields are set by function drivers that wish to queue |
| 34 | * usb_requests with sps/bam parameters. |
| 35 | */ |
| 36 | #define MSM_PIPE_ID_MASK (0x1F) |
| 37 | #define MSM_TX_PIPE_ID_OFS (16) |
| 38 | #define MSM_SPS_MODE BIT(5) |
| 39 | #define MSM_IS_FINITE_TRANSFER BIT(6) |
| 40 | #define MSM_PRODUCER BIT(7) |
| 41 | #define MSM_DISABLE_WB BIT(8) |
| 42 | #define MSM_ETD_IOC BIT(9) |
| 43 | #define MSM_INTERNAL_MEM BIT(10) |
| 44 | #define MSM_VENDOR_ID BIT(16) |
| 45 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | struct usb_ep; |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 47 | struct usb_gadget; |
| 48 | |
| 49 | enum ep_type { |
| 50 | EP_TYPE_NORMAL = 0, |
| 51 | EP_TYPE_GSI, |
| 52 | }; |
| 53 | |
| 54 | /* Operations codes for GSI enabled EPs */ |
| 55 | enum gsi_ep_op { |
| 56 | GSI_EP_OP_CONFIG = 0, |
| 57 | GSI_EP_OP_STARTXFER, |
| 58 | GSI_EP_OP_STORE_DBL_INFO, |
| 59 | GSI_EP_OP_ENABLE_GSI, |
| 60 | GSI_EP_OP_UPDATEXFER, |
Mayank Rana | 64d136b | 2016-11-01 21:01:34 -0700 | [diff] [blame] | 61 | GSI_EP_OP_RING_DB, |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 62 | GSI_EP_OP_ENDXFER, |
| 63 | GSI_EP_OP_GET_CH_INFO, |
| 64 | GSI_EP_OP_GET_XFER_IDX, |
| 65 | GSI_EP_OP_PREPARE_TRBS, |
| 66 | GSI_EP_OP_FREE_TRBS, |
| 67 | GSI_EP_OP_SET_CLR_BLOCK_DBL, |
| 68 | GSI_EP_OP_CHECK_FOR_SUSPEND, |
| 69 | GSI_EP_OP_DISABLE, |
| 70 | }; |
| 71 | |
| 72 | /* |
| 73 | * @buf_base_addr: Base pointer to buffer allocated for each GSI enabled EP. |
| 74 | * TRBs point to buffers that are split from this pool. The size of the |
| 75 | * buffer is num_bufs times buf_len. num_bufs and buf_len are determined |
| 76 | based on desired performance and aggregation size. |
| 77 | * @dma: DMA address corresponding to buf_base_addr. |
| 78 | * @num_bufs: Number of buffers associated with the GSI enabled EP. This |
| 79 | * corresponds to the number of non-zlp TRBs allocated for the EP. |
| 80 | * The value is determined based on desired performance for the EP. |
| 81 | * @buf_len: Size of each individual buffer is determined based on aggregation |
| 82 | * negotiated as per the protocol. In case of no aggregation supported by |
| 83 | * the protocol, we use default values. |
| 84 | */ |
| 85 | struct usb_gsi_request { |
| 86 | void *buf_base_addr; |
| 87 | dma_addr_t dma; |
| 88 | size_t num_bufs; |
| 89 | size_t buf_len; |
| 90 | }; |
| 91 | |
| 92 | /* |
| 93 | * @last_trb_addr: Address (LSB - based on alignment restrictions) of |
| 94 | * last TRB in queue. Used to identify rollover case. |
| 95 | * @const_buffer_size: TRB buffer size in KB (similar to IPA aggregation |
| 96 | * configuration). Must be aligned to Max USB Packet Size. |
| 97 | * Should be 1 <= const_buffer_size <= 31. |
| 98 | * @depcmd_low_addr: Used by GSI hardware to write "Update Transfer" cmd |
| 99 | * @depcmd_hi_addr: Used to write "Update Transfer" command. |
| 100 | * @gevntcount_low_addr: GEVNCOUNT low address for GSI hardware to read and |
| 101 | * clear processed events. |
| 102 | * @gevntcount_hi_addr: GEVNCOUNT high address. |
| 103 | * @xfer_ring_len: length of transfer ring in bytes (must be integral |
| 104 | * multiple of TRB size - 16B for xDCI). |
| 105 | * @xfer_ring_base_addr: physical base address of transfer ring. Address must |
| 106 | * be aligned to xfer_ring_len rounded to power of two. |
| 107 | * @ch_req: Used to pass request specific info for certain operations on GSI EP |
| 108 | */ |
| 109 | struct gsi_channel_info { |
| 110 | u16 last_trb_addr; |
| 111 | u8 const_buffer_size; |
| 112 | u32 depcmd_low_addr; |
| 113 | u8 depcmd_hi_addr; |
| 114 | u32 gevntcount_low_addr; |
| 115 | u8 gevntcount_hi_addr; |
| 116 | u16 xfer_ring_len; |
| 117 | u64 xfer_ring_base_addr; |
| 118 | struct usb_gsi_request *ch_req; |
| 119 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | |
| 121 | /** |
| 122 | * struct usb_request - describes one i/o request |
| 123 | * @buf: Buffer used for data. Always provide this; some controllers |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 124 | * only use PIO, or don't use DMA for some endpoints. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | * @dma: DMA address corresponding to 'buf'. If you don't set this |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 126 | * field, and the usb controller needs one, it is responsible |
| 127 | * for mapping and unmapping the buffer. |
Felipe Balbi | 898c608 | 2011-11-22 11:11:50 +0200 | [diff] [blame] | 128 | * @sg: a scatterlist for SG-capable controllers. |
| 129 | * @num_sgs: number of SG entries |
| 130 | * @num_mapped_sgs: number of SG entries mapped to DMA (internal) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | * @length: Length of that data |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 132 | * @stream_id: The stream id, when USB3.0 bulk streams are being used |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 133 | * @no_interrupt: If true, hints that no completion irq is needed. |
| 134 | * Helpful sometimes with deep request queues that are handled |
| 135 | * directly by DMA controllers. |
| 136 | * @zero: If true, when writing data, makes the last packet be "short" |
| 137 | * by adding a zero length packet as needed; |
| 138 | * @short_not_ok: When reading data, makes short packets be |
| 139 | * treated as errors (queue stops advancing till cleanup). |
| 140 | * @complete: Function called when request completes, so this request and |
Alan Stern | f579c2b | 2008-06-02 16:26:48 -0400 | [diff] [blame] | 141 | * its buffer may be re-used. The function will always be called with |
| 142 | * interrupts disabled, and it must not sleep. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | * Reads terminate with a short packet, or when the buffer fills, |
| 144 | * whichever comes first. When writes terminate, some data bytes |
| 145 | * will usually still be in flight (often in a hardware fifo). |
| 146 | * Errors (for reads or writes) stop the queue from advancing |
| 147 | * until the completion function returns, so that any transfers |
| 148 | * invalidated by the error may first be dequeued. |
| 149 | * @context: For use by the completion callback |
| 150 | * @list: For use by the gadget driver. |
| 151 | * @status: Reports completion code, zero or a negative errno. |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 152 | * Normally, faults block the transfer queue from advancing until |
| 153 | * the completion callback returns. |
| 154 | * Code "-ESHUTDOWN" indicates completion caused by device disconnect, |
| 155 | * or when the driver disabled the endpoint. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | * @actual: Reports bytes transferred to/from the buffer. For reads (OUT |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 157 | * transfers) this may be less than the requested length. If the |
| 158 | * short_not_ok flag is set, short reads are treated as errors |
| 159 | * even when status otherwise indicates successful completion. |
| 160 | * Note that for writes (IN transfers) some data bytes may still |
| 161 | * reside in a device-side FIFO when the request is reported as |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | * complete. |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 163 | * @udc_priv: Vendor private data in usage by the UDC. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | * |
| 165 | * These are allocated/freed through the endpoint they're used with. The |
| 166 | * hardware's driver can add extra per-request data to the memory it returns, |
| 167 | * which often avoids separate memory allocations (potential failures), |
| 168 | * later when the request is queued. |
| 169 | * |
| 170 | * Request flags affect request handling, such as whether a zero length |
| 171 | * packet is written (the "zero" flag), whether a short read should be |
| 172 | * treated as an error (blocking request queue advance, the "short_not_ok" |
| 173 | * flag), or hinting that an interrupt is not required (the "no_interrupt" |
| 174 | * flag, for use with deep request queues). |
| 175 | * |
| 176 | * Bulk endpoints can use any size buffers, and can also be used for interrupt |
| 177 | * transfers. interrupt-only endpoints can be much less functional. |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 178 | * |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 179 | * NOTE: this is analogous to 'struct urb' on the host side, except that |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 180 | * it's thinner and promotes more pre-allocation. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 181 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | |
| 183 | struct usb_request { |
| 184 | void *buf; |
| 185 | unsigned length; |
| 186 | dma_addr_t dma; |
| 187 | |
Felipe Balbi | 898c608 | 2011-11-22 11:11:50 +0200 | [diff] [blame] | 188 | struct scatterlist *sg; |
| 189 | unsigned num_sgs; |
| 190 | unsigned num_mapped_sgs; |
| 191 | |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 192 | unsigned stream_id:16; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | unsigned no_interrupt:1; |
| 194 | unsigned zero:1; |
| 195 | unsigned short_not_ok:1; |
| 196 | |
| 197 | void (*complete)(struct usb_ep *ep, |
| 198 | struct usb_request *req); |
| 199 | void *context; |
| 200 | struct list_head list; |
| 201 | |
| 202 | int status; |
| 203 | unsigned actual; |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 204 | unsigned int udc_priv; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 205 | }; |
| 206 | |
| 207 | /*-------------------------------------------------------------------------*/ |
| 208 | |
| 209 | /* endpoint-specific parts of the api to the usb controller hardware. |
| 210 | * unlike the urb model, (de)multiplexing layers are not required. |
| 211 | * (so this api could slash overhead if used on the host side...) |
| 212 | * |
| 213 | * note that device side usb controllers commonly differ in how many |
| 214 | * endpoints they support, as well as their capabilities. |
| 215 | */ |
| 216 | struct usb_ep_ops { |
| 217 | int (*enable) (struct usb_ep *ep, |
| 218 | const struct usb_endpoint_descriptor *desc); |
| 219 | int (*disable) (struct usb_ep *ep); |
| 220 | |
| 221 | struct usb_request *(*alloc_request) (struct usb_ep *ep, |
Al Viro | 55016f1 | 2005-10-21 03:21:58 -0400 | [diff] [blame] | 222 | gfp_t gfp_flags); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | void (*free_request) (struct usb_ep *ep, struct usb_request *req); |
| 224 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 225 | int (*queue) (struct usb_ep *ep, struct usb_request *req, |
Al Viro | 55016f1 | 2005-10-21 03:21:58 -0400 | [diff] [blame] | 226 | gfp_t gfp_flags); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | int (*dequeue) (struct usb_ep *ep, struct usb_request *req); |
| 228 | |
| 229 | int (*set_halt) (struct usb_ep *ep, int value); |
David Lopo | a5e54b0 | 2008-04-29 10:12:37 +0100 | [diff] [blame] | 230 | int (*set_wedge) (struct usb_ep *ep); |
| 231 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | int (*fifo_status) (struct usb_ep *ep); |
| 233 | void (*fifo_flush) (struct usb_ep *ep); |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 234 | int (*gsi_ep_op)(struct usb_ep *ep, void *op_data, |
| 235 | enum gsi_ep_op op); |
| 236 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 237 | }; |
| 238 | |
| 239 | /** |
Robert Baldyga | 734b5a2 | 2015-07-31 16:00:14 +0200 | [diff] [blame] | 240 | * struct usb_ep_caps - endpoint capabilities description |
| 241 | * @type_control:Endpoint supports control type (reserved for ep0). |
| 242 | * @type_iso:Endpoint supports isochronous transfers. |
| 243 | * @type_bulk:Endpoint supports bulk transfers. |
| 244 | * @type_int:Endpoint supports interrupt transfers. |
| 245 | * @dir_in:Endpoint supports IN direction. |
| 246 | * @dir_out:Endpoint supports OUT direction. |
| 247 | */ |
| 248 | struct usb_ep_caps { |
| 249 | unsigned type_control:1; |
| 250 | unsigned type_iso:1; |
| 251 | unsigned type_bulk:1; |
| 252 | unsigned type_int:1; |
| 253 | unsigned dir_in:1; |
| 254 | unsigned dir_out:1; |
| 255 | }; |
| 256 | |
Robert Baldyga | 80e6e38 | 2015-07-31 16:00:15 +0200 | [diff] [blame] | 257 | #define USB_EP_CAPS_TYPE_CONTROL 0x01 |
| 258 | #define USB_EP_CAPS_TYPE_ISO 0x02 |
| 259 | #define USB_EP_CAPS_TYPE_BULK 0x04 |
| 260 | #define USB_EP_CAPS_TYPE_INT 0x08 |
| 261 | #define USB_EP_CAPS_TYPE_ALL \ |
| 262 | (USB_EP_CAPS_TYPE_ISO | USB_EP_CAPS_TYPE_BULK | USB_EP_CAPS_TYPE_INT) |
| 263 | #define USB_EP_CAPS_DIR_IN 0x01 |
| 264 | #define USB_EP_CAPS_DIR_OUT 0x02 |
| 265 | #define USB_EP_CAPS_DIR_ALL (USB_EP_CAPS_DIR_IN | USB_EP_CAPS_DIR_OUT) |
| 266 | |
| 267 | #define USB_EP_CAPS(_type, _dir) \ |
| 268 | { \ |
| 269 | .type_control = !!(_type & USB_EP_CAPS_TYPE_CONTROL), \ |
| 270 | .type_iso = !!(_type & USB_EP_CAPS_TYPE_ISO), \ |
| 271 | .type_bulk = !!(_type & USB_EP_CAPS_TYPE_BULK), \ |
| 272 | .type_int = !!(_type & USB_EP_CAPS_TYPE_INT), \ |
| 273 | .dir_in = !!(_dir & USB_EP_CAPS_DIR_IN), \ |
| 274 | .dir_out = !!(_dir & USB_EP_CAPS_DIR_OUT), \ |
| 275 | } |
| 276 | |
Robert Baldyga | 734b5a2 | 2015-07-31 16:00:14 +0200 | [diff] [blame] | 277 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 278 | * struct usb_ep - device side representation of USB endpoint |
| 279 | * @name:identifier for the endpoint, such as "ep-a" or "ep9in-bulk" |
| 280 | * @ops: Function pointers used to access hardware-specific operations. |
| 281 | * @ep_list:the gadget's ep_list holds all of its endpoints |
Robert Baldyga | 734b5a2 | 2015-07-31 16:00:14 +0200 | [diff] [blame] | 282 | * @caps:The structure describing types and directions supported by endoint. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 283 | * @maxpacket:The maximum packet size used on this endpoint. The initial |
| 284 | * value can sometimes be reduced (hardware allowing), according to |
| 285 | * the endpoint descriptor used to configure the endpoint. |
Robert Baldyga | e117e74 | 2013-12-13 12:23:38 +0100 | [diff] [blame] | 286 | * @maxpacket_limit:The maximum packet size value which can be handled by this |
| 287 | * endpoint. It's set once by UDC driver when endpoint is initialized, and |
| 288 | * should not be changed. Should not be confused with maxpacket. |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 289 | * @max_streams: The maximum number of streams supported |
| 290 | * by this EP (0 - 16, actual number is 2^n) |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 291 | * @mult: multiplier, 'mult' value for SS Isoc EPs |
| 292 | * @maxburst: the maximum number of bursts supported by this EP (for usb3) |
Tatyana Brokhman | 72c973d | 2011-06-28 16:33:48 +0300 | [diff] [blame] | 293 | * @driver_data:for use by the gadget driver. |
Tatyana Brokhman | 48767a4 | 2011-06-28 16:33:49 +0300 | [diff] [blame] | 294 | * @address: used to identify the endpoint when finding descriptor that |
| 295 | * matches connection speed |
Tatyana Brokhman | 72c973d | 2011-06-28 16:33:48 +0300 | [diff] [blame] | 296 | * @desc: endpoint descriptor. This pointer is set before the endpoint is |
| 297 | * enabled and remains valid until the endpoint is disabled. |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 298 | * @comp_desc: In case of SuperSpeed support, this is the endpoint companion |
| 299 | * descriptor that is used to configure the endpoint |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 300 | * @ep_type: Used to specify type of EP eg. normal vs h/w accelerated. |
Devdutt Patnaik | 5477b05 | 2016-12-06 16:09:30 -0800 | [diff] [blame] | 301 | * @ep_num: Used EP number |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 302 | * @ep_intr_num: Interrupter number for EP. |
Mayank Rana | ae5ca3c | 2016-09-21 12:21:01 -0700 | [diff] [blame] | 303 | * @endless: In case where endless transfer is being initiated, this is set |
| 304 | * to disable usb event interrupt for few events. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 305 | * |
| 306 | * the bus controller driver lists all the general purpose endpoints in |
| 307 | * gadget->ep_list. the control endpoint (gadget->ep0) is not in that list, |
| 308 | * and is accessed only in response to a driver setup() callback. |
| 309 | */ |
Robert Baldyga | 734b5a2 | 2015-07-31 16:00:14 +0200 | [diff] [blame] | 310 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 311 | struct usb_ep { |
| 312 | void *driver_data; |
| 313 | |
| 314 | const char *name; |
| 315 | const struct usb_ep_ops *ops; |
| 316 | struct list_head ep_list; |
Robert Baldyga | 734b5a2 | 2015-07-31 16:00:14 +0200 | [diff] [blame] | 317 | struct usb_ep_caps caps; |
Robert Baldyga | cc476b4 | 2015-07-31 16:00:13 +0200 | [diff] [blame] | 318 | bool claimed; |
Robert Baldyga | b0bac25 | 2015-09-16 12:10:42 +0200 | [diff] [blame] | 319 | bool enabled; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 320 | unsigned maxpacket:16; |
Robert Baldyga | e117e74 | 2013-12-13 12:23:38 +0100 | [diff] [blame] | 321 | unsigned maxpacket_limit:16; |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 322 | unsigned max_streams:16; |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 323 | unsigned mult:2; |
Yu Xu | a7250db | 2011-12-19 17:33:03 +0800 | [diff] [blame] | 324 | unsigned maxburst:5; |
Tatyana Brokhman | 48767a4 | 2011-06-28 16:33:49 +0300 | [diff] [blame] | 325 | u8 address; |
Tatyana Brokhman | 72c973d | 2011-06-28 16:33:48 +0300 | [diff] [blame] | 326 | const struct usb_endpoint_descriptor *desc; |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 327 | const struct usb_ss_ep_comp_descriptor *comp_desc; |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 328 | enum ep_type ep_type; |
Devdutt Patnaik | 5477b05 | 2016-12-06 16:09:30 -0800 | [diff] [blame] | 329 | u8 ep_num; |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 330 | u8 ep_intr_num; |
Mayank Rana | ae5ca3c | 2016-09-21 12:21:01 -0700 | [diff] [blame] | 331 | bool endless; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 332 | }; |
| 333 | |
| 334 | /*-------------------------------------------------------------------------*/ |
| 335 | |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 336 | #if IS_ENABLED(CONFIG_USB_GADGET) |
| 337 | void usb_ep_set_maxpacket_limit(struct usb_ep *ep, unsigned maxpacket_limit); |
| 338 | int usb_ep_enable(struct usb_ep *ep); |
| 339 | int usb_ep_disable(struct usb_ep *ep); |
| 340 | struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags); |
| 341 | void usb_ep_free_request(struct usb_ep *ep, struct usb_request *req); |
| 342 | int usb_ep_queue(struct usb_ep *ep, struct usb_request *req, gfp_t gfp_flags); |
| 343 | int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req); |
| 344 | int usb_ep_set_halt(struct usb_ep *ep); |
| 345 | int usb_ep_clear_halt(struct usb_ep *ep); |
| 346 | int usb_ep_set_wedge(struct usb_ep *ep); |
| 347 | int usb_ep_fifo_status(struct usb_ep *ep); |
| 348 | void usb_ep_fifo_flush(struct usb_ep *ep); |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 349 | int usb_gsi_ep_op(struct usb_ep *ep, |
| 350 | struct usb_gsi_request *req, enum gsi_ep_op op); |
| 351 | int usb_gadget_restart(struct usb_gadget *gadget); |
| 352 | int usb_gadget_func_wakeup(struct usb_gadget *gadget, int interface_id); |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 353 | #else |
Robert Baldyga | e117e74 | 2013-12-13 12:23:38 +0100 | [diff] [blame] | 354 | static inline void usb_ep_set_maxpacket_limit(struct usb_ep *ep, |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 355 | unsigned maxpacket_limit) |
| 356 | { } |
Tatyana Brokhman | 72c973d | 2011-06-28 16:33:48 +0300 | [diff] [blame] | 357 | static inline int usb_ep_enable(struct usb_ep *ep) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 358 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 359 | static inline int usb_ep_disable(struct usb_ep *ep) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 360 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 361 | static inline struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 362 | gfp_t gfp_flags) |
| 363 | { return NULL; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 364 | static inline void usb_ep_free_request(struct usb_ep *ep, |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 365 | struct usb_request *req) |
| 366 | { } |
| 367 | static inline int usb_ep_queue(struct usb_ep *ep, struct usb_request *req, |
| 368 | gfp_t gfp_flags) |
| 369 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 370 | static inline int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 371 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 372 | static inline int usb_ep_set_halt(struct usb_ep *ep) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 373 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 374 | static inline int usb_ep_clear_halt(struct usb_ep *ep) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 375 | { return 0; } |
| 376 | static inline int usb_ep_set_wedge(struct usb_ep *ep) |
| 377 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 378 | static inline int usb_ep_fifo_status(struct usb_ep *ep) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 379 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 380 | static inline void usb_ep_fifo_flush(struct usb_ep *ep) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 381 | { } |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 382 | |
| 383 | static int usb_gsi_ep_op(struct usb_ep *ep, |
| 384 | struct usb_gsi_request *req, enum gsi_ep_op op) |
| 385 | { return 0; } |
| 386 | static int usb_gadget_restart(struct usb_gadget *gadget) |
| 387 | { return 0; } |
| 388 | static int usb_gadget_func_wakeup(struct usb_gadget *gadget, int interface_id) |
| 389 | { return 0; } |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 390 | #endif /* USB_GADGET */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 391 | |
| 392 | /*-------------------------------------------------------------------------*/ |
| 393 | |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 394 | struct usb_dcd_config_params { |
| 395 | __u8 bU1devExitLat; /* U1 Device exit Latency */ |
Felipe Balbi | 089b837 | 2011-10-10 09:43:44 +0300 | [diff] [blame] | 396 | #define USB_DEFAULT_U1_DEV_EXIT_LAT 0x01 /* Less then 1 microsec */ |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 397 | __le16 bU2DevExitLat; /* U2 Device exit Latency */ |
Felipe Balbi | 089b837 | 2011-10-10 09:43:44 +0300 | [diff] [blame] | 398 | #define USB_DEFAULT_U2_DEV_EXIT_LAT 0x1F4 /* Less then 500 microsec */ |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 399 | }; |
| 400 | |
| 401 | |
Felipe Balbi | 2ccea03 | 2011-06-28 16:33:46 +0300 | [diff] [blame] | 402 | struct usb_gadget_driver; |
Peter Chen | dfea9c9 | 2015-03-06 10:36:02 +0800 | [diff] [blame] | 403 | struct usb_udc; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 404 | |
| 405 | /* the rest of the api to the controller hardware: device operations, |
| 406 | * which don't involve endpoints (or i/o). |
| 407 | */ |
| 408 | struct usb_gadget_ops { |
| 409 | int (*get_frame)(struct usb_gadget *); |
| 410 | int (*wakeup)(struct usb_gadget *); |
Danny Segal | f83e451 | 2016-12-06 15:35:24 -0800 | [diff] [blame] | 411 | int (*func_wakeup)(struct usb_gadget *, int interface_id); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 412 | int (*set_selfpowered) (struct usb_gadget *, int is_selfpowered); |
| 413 | int (*vbus_session) (struct usb_gadget *, int is_active); |
| 414 | int (*vbus_draw) (struct usb_gadget *, unsigned mA); |
| 415 | int (*pullup) (struct usb_gadget *, int is_on); |
| 416 | int (*ioctl)(struct usb_gadget *, |
| 417 | unsigned code, unsigned long param); |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 418 | void (*get_config_params)(struct usb_dcd_config_params *); |
Sebastian Andrzej Siewior | 352c2dc | 2011-06-23 14:26:15 +0200 | [diff] [blame] | 419 | int (*udc_start)(struct usb_gadget *, |
| 420 | struct usb_gadget_driver *); |
Felipe Balbi | 22835b8 | 2014-10-17 12:05:12 -0500 | [diff] [blame] | 421 | int (*udc_stop)(struct usb_gadget *); |
Robert Baldyga | 596c154 | 2015-08-06 14:11:10 +0200 | [diff] [blame] | 422 | struct usb_ep *(*match_ep)(struct usb_gadget *, |
| 423 | struct usb_endpoint_descriptor *, |
| 424 | struct usb_ss_ep_comp_descriptor *); |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 425 | int (*restart)(struct usb_gadget *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 426 | }; |
| 427 | |
| 428 | /** |
| 429 | * struct usb_gadget - represents a usb slave device |
Felipe Balbi | 5702f75 | 2013-07-17 11:09:49 +0300 | [diff] [blame] | 430 | * @work: (internal use) Workqueue to be used for sysfs_notify() |
Peter Chen | dfea9c9 | 2015-03-06 10:36:02 +0800 | [diff] [blame] | 431 | * @udc: struct usb_udc pointer for this gadget |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 432 | * @ops: Function pointers used to access hardware-specific operations. |
| 433 | * @ep0: Endpoint zero, used when reading or writing responses to |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 434 | * driver setup() requests |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 435 | * @ep_list: List of other endpoints supported by the device. |
| 436 | * @speed: Speed of current connection to USB host. |
Michal Nazarewicz | d327ab5 | 2011-11-19 18:27:37 +0100 | [diff] [blame] | 437 | * @max_speed: Maximal speed the UDC can handle. UDC must support this |
| 438 | * and all slower speeds. |
Felipe Balbi | 49401f4 | 2011-12-19 12:57:04 +0200 | [diff] [blame] | 439 | * @state: the state we are now (attached, suspended, configured, etc) |
David Cohen | d8318d7 | 2013-12-09 15:55:34 -0800 | [diff] [blame] | 440 | * @name: Identifies the controller hardware type. Used in diagnostics |
| 441 | * and sometimes configuration. |
| 442 | * @dev: Driver model state for this abstract device. |
| 443 | * @out_epnum: last used out ep number |
| 444 | * @in_epnum: last used in ep number |
Felipe Balbi | 5e42d71 | 2016-05-31 13:39:21 +0300 | [diff] [blame] | 445 | * @mA: last set mA value |
Macpaul Lin | 84704bb | 2015-07-09 15:18:41 +0800 | [diff] [blame] | 446 | * @otg_caps: OTG capabilities of this gadget. |
Felipe Balbi | 898c608 | 2011-11-22 11:11:50 +0200 | [diff] [blame] | 447 | * @sg_supported: true if we can handle scatter-gather |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 448 | * @is_otg: True if the USB device port uses a Mini-AB jack, so that the |
| 449 | * gadget driver must provide a USB OTG descriptor. |
| 450 | * @is_a_peripheral: False unless is_otg, the "A" end of a USB cable |
| 451 | * is in the Mini-AB jack, and HNP has been used to switch roles |
| 452 | * so that the "A" device currently acts as A-Peripheral, not A-Host. |
| 453 | * @a_hnp_support: OTG device feature flag, indicating that the A-Host |
| 454 | * supports HNP at this port. |
| 455 | * @a_alt_hnp_support: OTG device feature flag, indicating that the A-Host |
| 456 | * only supports HNP on a different root port. |
| 457 | * @b_hnp_enable: OTG device feature flag, indicating that the A-Host |
| 458 | * enabled HNP support. |
Li Jun | 75a9c82 | 2016-02-19 10:04:40 +0800 | [diff] [blame] | 459 | * @hnp_polling_support: OTG device feature flag, indicating if the OTG device |
| 460 | * in peripheral mode can support HNP polling. |
| 461 | * @host_request_flag: OTG device feature flag, indicating if A-Peripheral |
| 462 | * or B-Peripheral wants to take host role. |
David Cohen | 0b2d2bb | 2013-12-09 15:55:35 -0800 | [diff] [blame] | 463 | * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to |
| 464 | * MaxPacketSize. |
Yoshihiro Shimoda | 60e7396 | 2016-08-22 17:48:25 +0900 | [diff] [blame] | 465 | * @quirk_avoids_skb_reserve: udc/platform wants to avoid skb_reserve() in |
| 466 | * u_ether.c to improve performance. |
Peter Chen | 80b2502 | 2015-01-28 16:32:24 +0800 | [diff] [blame] | 467 | * @is_selfpowered: if the gadget is self-powered. |
Robert Baldyga | ccdf138 | 2015-05-04 14:55:11 +0200 | [diff] [blame] | 468 | * @deactivated: True if gadget is deactivated - in deactivated state it cannot |
| 469 | * be connected. |
| 470 | * @connected: True if gadget is connected. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 471 | * |
| 472 | * Gadgets have a mostly-portable "gadget driver" implementing device |
| 473 | * functions, handling all usb configurations and interfaces. Gadget |
| 474 | * drivers talk to hardware-specific code indirectly, through ops vectors. |
| 475 | * That insulates the gadget driver from hardware details, and packages |
| 476 | * the hardware endpoints through generic i/o queues. The "usb_gadget" |
| 477 | * and "usb_ep" interfaces provide that insulation from the hardware. |
| 478 | * |
| 479 | * Except for the driver data, all fields in this structure are |
| 480 | * read-only to the gadget driver. That driver data is part of the |
| 481 | * "driver model" infrastructure in 2.6 (and later) kernels, and for |
| 482 | * earlier systems is grouped in a similar structure that's not known |
| 483 | * to the rest of the kernel. |
| 484 | * |
| 485 | * Values of the three OTG device feature flags are updated before the |
| 486 | * setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before |
| 487 | * driver suspend() calls. They are valid only when is_otg, and when the |
| 488 | * device is acting as a B-Peripheral (so is_a_peripheral is false). |
| 489 | */ |
| 490 | struct usb_gadget { |
Felipe Balbi | 5702f75 | 2013-07-17 11:09:49 +0300 | [diff] [blame] | 491 | struct work_struct work; |
Peter Chen | dfea9c9 | 2015-03-06 10:36:02 +0800 | [diff] [blame] | 492 | struct usb_udc *udc; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 493 | /* readonly to gadget driver */ |
| 494 | const struct usb_gadget_ops *ops; |
| 495 | struct usb_ep *ep0; |
| 496 | struct list_head ep_list; /* of usb_ep */ |
| 497 | enum usb_device_speed speed; |
Michal Nazarewicz | d327ab5 | 2011-11-19 18:27:37 +0100 | [diff] [blame] | 498 | enum usb_device_speed max_speed; |
Felipe Balbi | 49401f4 | 2011-12-19 12:57:04 +0200 | [diff] [blame] | 499 | enum usb_device_state state; |
David Cohen | d8318d7 | 2013-12-09 15:55:34 -0800 | [diff] [blame] | 500 | const char *name; |
| 501 | struct device dev; |
| 502 | unsigned out_epnum; |
| 503 | unsigned in_epnum; |
Felipe Balbi | 5e42d71 | 2016-05-31 13:39:21 +0300 | [diff] [blame] | 504 | unsigned mA; |
Macpaul Lin | 84704bb | 2015-07-09 15:18:41 +0800 | [diff] [blame] | 505 | struct usb_otg_caps *otg_caps; |
David Cohen | d8318d7 | 2013-12-09 15:55:34 -0800 | [diff] [blame] | 506 | |
Felipe Balbi | 898c608 | 2011-11-22 11:11:50 +0200 | [diff] [blame] | 507 | unsigned sg_supported:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 508 | unsigned is_otg:1; |
| 509 | unsigned is_a_peripheral:1; |
| 510 | unsigned b_hnp_enable:1; |
| 511 | unsigned a_hnp_support:1; |
| 512 | unsigned a_alt_hnp_support:1; |
Li Jun | 75a9c82 | 2016-02-19 10:04:40 +0800 | [diff] [blame] | 513 | unsigned hnp_polling_support:1; |
| 514 | unsigned host_request_flag:1; |
David Cohen | 0b2d2bb | 2013-12-09 15:55:35 -0800 | [diff] [blame] | 515 | unsigned quirk_ep_out_aligned_size:1; |
Robert Baldyga | ffd9a0f | 2015-07-28 07:19:58 +0200 | [diff] [blame] | 516 | unsigned quirk_altset_not_supp:1; |
Robert Baldyga | 02ded1b | 2015-07-28 07:19:59 +0200 | [diff] [blame] | 517 | unsigned quirk_stall_not_supp:1; |
Robert Baldyga | ca1023c | 2015-07-28 07:20:00 +0200 | [diff] [blame] | 518 | unsigned quirk_zlp_not_supp:1; |
Yoshihiro Shimoda | 60e7396 | 2016-08-22 17:48:25 +0900 | [diff] [blame] | 519 | unsigned quirk_avoids_skb_reserve:1; |
Peter Chen | 80b2502 | 2015-01-28 16:32:24 +0800 | [diff] [blame] | 520 | unsigned is_selfpowered:1; |
Robert Baldyga | ccdf138 | 2015-05-04 14:55:11 +0200 | [diff] [blame] | 521 | unsigned deactivated:1; |
| 522 | unsigned connected:1; |
Mayank Rana | a99689a | 2016-08-10 17:39:47 -0700 | [diff] [blame] | 523 | bool remote_wakeup; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 524 | }; |
Felipe Balbi | 5702f75 | 2013-07-17 11:09:49 +0300 | [diff] [blame] | 525 | #define work_to_gadget(w) (container_of((w), struct usb_gadget, work)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 526 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 527 | static inline void set_gadget_data(struct usb_gadget *gadget, void *data) |
| 528 | { dev_set_drvdata(&gadget->dev, data); } |
| 529 | static inline void *get_gadget_data(struct usb_gadget *gadget) |
| 530 | { return dev_get_drvdata(&gadget->dev); } |
Fabien Chouteau | f48cf80 | 2010-04-23 14:21:26 +0200 | [diff] [blame] | 531 | static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev) |
| 532 | { |
| 533 | return container_of(dev, struct usb_gadget, dev); |
| 534 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 535 | |
| 536 | /* iterates the non-control endpoints; 'tmp' is a struct usb_ep pointer */ |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 537 | #define gadget_for_each_ep(tmp, gadget) \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 538 | list_for_each_entry(tmp, &(gadget)->ep_list, ep_list) |
| 539 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 540 | /** |
Felipe F. Tonello | 16b114a | 2016-08-08 21:30:04 +0100 | [diff] [blame] | 541 | * usb_ep_align - returns @len aligned to ep's maxpacketsize. |
| 542 | * @ep: the endpoint whose maxpacketsize is used to align @len |
| 543 | * @len: buffer size's length to align to @ep's maxpacketsize |
| 544 | * |
| 545 | * This helper is used to align buffer's size to an ep's maxpacketsize. |
| 546 | */ |
| 547 | static inline size_t usb_ep_align(struct usb_ep *ep, size_t len) |
| 548 | { |
Peter Chen | a10a1b7 | 2016-11-08 10:08:24 +0800 | [diff] [blame] | 549 | int max_packet_size = (size_t)usb_endpoint_maxp(ep->desc) & 0x7ff; |
| 550 | |
| 551 | return round_up(len, max_packet_size); |
Felipe F. Tonello | 16b114a | 2016-08-08 21:30:04 +0100 | [diff] [blame] | 552 | } |
| 553 | |
| 554 | /** |
David Cohen | 0b2d2bb | 2013-12-09 15:55:35 -0800 | [diff] [blame] | 555 | * usb_ep_align_maybe - returns @len aligned to ep's maxpacketsize if gadget |
Felipe F. Tonello | 16b114a | 2016-08-08 21:30:04 +0100 | [diff] [blame] | 556 | * requires quirk_ep_out_aligned_size, otherwise returns len. |
David Cohen | 0b2d2bb | 2013-12-09 15:55:35 -0800 | [diff] [blame] | 557 | * @g: controller to check for quirk |
| 558 | * @ep: the endpoint whose maxpacketsize is used to align @len |
| 559 | * @len: buffer size's length to align to @ep's maxpacketsize |
| 560 | * |
| 561 | * This helper is used in case it's required for any reason to check and maybe |
| 562 | * align buffer's size to an ep's maxpacketsize. |
| 563 | */ |
| 564 | static inline size_t |
| 565 | usb_ep_align_maybe(struct usb_gadget *g, struct usb_ep *ep, size_t len) |
| 566 | { |
Felipe F. Tonello | 16b114a | 2016-08-08 21:30:04 +0100 | [diff] [blame] | 567 | return g->quirk_ep_out_aligned_size ? usb_ep_align(ep, len) : len; |
David Cohen | 0b2d2bb | 2013-12-09 15:55:35 -0800 | [diff] [blame] | 568 | } |
| 569 | |
| 570 | /** |
Robert Baldyga | ffd9a0f | 2015-07-28 07:19:58 +0200 | [diff] [blame] | 571 | * gadget_is_altset_supported - return true iff the hardware supports |
| 572 | * altsettings |
| 573 | * @g: controller to check for quirk |
| 574 | */ |
| 575 | static inline int gadget_is_altset_supported(struct usb_gadget *g) |
| 576 | { |
| 577 | return !g->quirk_altset_not_supp; |
| 578 | } |
| 579 | |
| 580 | /** |
Robert Baldyga | 02ded1b | 2015-07-28 07:19:59 +0200 | [diff] [blame] | 581 | * gadget_is_stall_supported - return true iff the hardware supports stalling |
| 582 | * @g: controller to check for quirk |
| 583 | */ |
| 584 | static inline int gadget_is_stall_supported(struct usb_gadget *g) |
| 585 | { |
| 586 | return !g->quirk_stall_not_supp; |
| 587 | } |
| 588 | |
| 589 | /** |
Robert Baldyga | ca1023c | 2015-07-28 07:20:00 +0200 | [diff] [blame] | 590 | * gadget_is_zlp_supported - return true iff the hardware supports zlp |
| 591 | * @g: controller to check for quirk |
| 592 | */ |
| 593 | static inline int gadget_is_zlp_supported(struct usb_gadget *g) |
| 594 | { |
| 595 | return !g->quirk_zlp_not_supp; |
| 596 | } |
| 597 | |
| 598 | /** |
Yoshihiro Shimoda | 60e7396 | 2016-08-22 17:48:25 +0900 | [diff] [blame] | 599 | * gadget_avoids_skb_reserve - return true iff the hardware would like to avoid |
| 600 | * skb_reserve to improve performance. |
| 601 | * @g: controller to check for quirk |
| 602 | */ |
| 603 | static inline int gadget_avoids_skb_reserve(struct usb_gadget *g) |
| 604 | { |
| 605 | return g->quirk_avoids_skb_reserve; |
| 606 | } |
| 607 | |
| 608 | /** |
David Brownell | a4e3ef5 | 2007-08-01 23:58:22 -0700 | [diff] [blame] | 609 | * gadget_is_dualspeed - return true iff the hardware handles high speed |
Randy Dunlap | fd39c86 | 2007-10-15 17:30:02 -0700 | [diff] [blame] | 610 | * @g: controller that might support both high and full speeds |
David Brownell | a4e3ef5 | 2007-08-01 23:58:22 -0700 | [diff] [blame] | 611 | */ |
| 612 | static inline int gadget_is_dualspeed(struct usb_gadget *g) |
| 613 | { |
Michal Nazarewicz | 85b8614 | 2012-08-24 20:46:18 +0200 | [diff] [blame] | 614 | return g->max_speed >= USB_SPEED_HIGH; |
David Brownell | a4e3ef5 | 2007-08-01 23:58:22 -0700 | [diff] [blame] | 615 | } |
| 616 | |
| 617 | /** |
Robert P. J. Day | de97f25 | 2013-05-02 09:51:44 -0400 | [diff] [blame] | 618 | * gadget_is_superspeed() - return true if the hardware handles superspeed |
| 619 | * @g: controller that might support superspeed |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 620 | */ |
| 621 | static inline int gadget_is_superspeed(struct usb_gadget *g) |
| 622 | { |
Michal Nazarewicz | 85b8614 | 2012-08-24 20:46:18 +0200 | [diff] [blame] | 623 | return g->max_speed >= USB_SPEED_SUPER; |
Tatyana Brokhman | bdb64d7 | 2011-06-29 16:41:50 +0300 | [diff] [blame] | 624 | } |
| 625 | |
| 626 | /** |
John Youn | 1ca1b6a | 2016-02-05 17:05:26 -0800 | [diff] [blame] | 627 | * gadget_is_superspeed_plus() - return true if the hardware handles |
| 628 | * superspeed plus |
| 629 | * @g: controller that might support superspeed plus |
| 630 | */ |
| 631 | static inline int gadget_is_superspeed_plus(struct usb_gadget *g) |
| 632 | { |
| 633 | return g->max_speed >= USB_SPEED_SUPER_PLUS; |
| 634 | } |
| 635 | |
| 636 | /** |
David Brownell | a4e3ef5 | 2007-08-01 23:58:22 -0700 | [diff] [blame] | 637 | * gadget_is_otg - return true iff the hardware is OTG-ready |
Randy Dunlap | fd39c86 | 2007-10-15 17:30:02 -0700 | [diff] [blame] | 638 | * @g: controller that might have a Mini-AB connector |
David Brownell | a4e3ef5 | 2007-08-01 23:58:22 -0700 | [diff] [blame] | 639 | * |
| 640 | * This is a runtime test, since kernels with a USB-OTG stack sometimes |
| 641 | * run on boards which only have a Mini-B (or Mini-A) connector. |
| 642 | */ |
| 643 | static inline int gadget_is_otg(struct usb_gadget *g) |
| 644 | { |
| 645 | #ifdef CONFIG_USB_OTG |
| 646 | return g->is_otg; |
| 647 | #else |
| 648 | return 0; |
| 649 | #endif |
| 650 | } |
| 651 | |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 652 | /*-------------------------------------------------------------------------*/ |
| 653 | |
| 654 | #if IS_ENABLED(CONFIG_USB_GADGET) |
| 655 | int usb_gadget_frame_number(struct usb_gadget *gadget); |
| 656 | int usb_gadget_wakeup(struct usb_gadget *gadget); |
| 657 | int usb_gadget_set_selfpowered(struct usb_gadget *gadget); |
| 658 | int usb_gadget_clear_selfpowered(struct usb_gadget *gadget); |
| 659 | int usb_gadget_vbus_connect(struct usb_gadget *gadget); |
| 660 | int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA); |
| 661 | int usb_gadget_vbus_disconnect(struct usb_gadget *gadget); |
| 662 | int usb_gadget_connect(struct usb_gadget *gadget); |
| 663 | int usb_gadget_disconnect(struct usb_gadget *gadget); |
| 664 | int usb_gadget_deactivate(struct usb_gadget *gadget); |
| 665 | int usb_gadget_activate(struct usb_gadget *gadget); |
| 666 | #else |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 667 | static inline int usb_gadget_frame_number(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 668 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 669 | static inline int usb_gadget_wakeup(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 670 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 671 | static inline int usb_gadget_set_selfpowered(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 672 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 673 | static inline int usb_gadget_clear_selfpowered(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 674 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 675 | static inline int usb_gadget_vbus_connect(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 676 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 677 | static inline int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 678 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 679 | static inline int usb_gadget_vbus_disconnect(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 680 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 681 | static inline int usb_gadget_connect(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 682 | { return 0; } |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 683 | static inline int usb_gadget_disconnect(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 684 | { return 0; } |
Robert Baldyga | ccdf138 | 2015-05-04 14:55:11 +0200 | [diff] [blame] | 685 | static inline int usb_gadget_deactivate(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 686 | { return 0; } |
Robert Baldyga | ccdf138 | 2015-05-04 14:55:11 +0200 | [diff] [blame] | 687 | static inline int usb_gadget_activate(struct usb_gadget *gadget) |
Felipe Balbi | 5a8d651 | 2016-05-31 13:07:47 +0300 | [diff] [blame] | 688 | { return 0; } |
| 689 | #endif /* CONFIG_USB_GADGET */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 690 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 691 | /*-------------------------------------------------------------------------*/ |
| 692 | |
| 693 | /** |
| 694 | * struct usb_gadget_driver - driver for usb 'slave' devices |
| 695 | * @function: String describing the gadget's function |
Michal Nazarewicz | 7177aed | 2011-11-19 18:27:38 +0100 | [diff] [blame] | 696 | * @max_speed: Highest speed the driver handles. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 697 | * @setup: Invoked for ep0 control requests that aren't handled by |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 698 | * the hardware level driver. Most calls must be handled by |
| 699 | * the gadget driver, including descriptor and configuration |
| 700 | * management. The 16 bit members of the setup data are in |
| 701 | * USB byte order. Called in_interrupt; this may not sleep. Driver |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 702 | * queues a response to ep0, or returns negative to stall. |
| 703 | * @disconnect: Invoked after all transfers have been stopped, |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 704 | * when the host is disconnected. May be called in_interrupt; this |
| 705 | * may not sleep. Some devices can't detect disconnect, so this might |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 706 | * not be called except as part of controller shutdown. |
Sebastian Andrzej Siewior | 9395295 | 2012-09-06 20:11:05 +0200 | [diff] [blame] | 707 | * @bind: the driver's bind callback |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 708 | * @unbind: Invoked when the driver is unbound from a gadget, |
David Brownell | efc9052 | 2007-08-01 16:04:53 -0700 | [diff] [blame] | 709 | * usually from rmmod (after a disconnect is reported). |
| 710 | * Called in a context that permits sleeping. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 711 | * @suspend: Invoked on USB suspend. May be called in_interrupt. |
| 712 | * @resume: Invoked on USB resume. May be called in_interrupt. |
Peter Chen | ef979a2 | 2014-09-09 08:56:48 +0800 | [diff] [blame] | 713 | * @reset: Invoked on USB bus reset. It is mandatory for all gadget drivers |
| 714 | * and should be called in_interrupt. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 715 | * @driver: Driver model state for this driver. |
Ruslan Bilovol | 2284b29 | 2015-11-23 09:56:35 +0100 | [diff] [blame] | 716 | * @udc_name: A name of UDC this driver should be bound to. If udc_name is NULL, |
| 717 | * this driver will be bound to any available UDC. |
Ruslan Bilovol | 855ed04 | 2015-11-23 09:56:38 +0100 | [diff] [blame] | 718 | * @pending: UDC core private data used for deferred probe of this driver. |
Krzysztof Opasiak | f1bddbb | 2016-05-05 10:46:05 +0200 | [diff] [blame] | 719 | * @match_existing_only: If udc is not found, return an error and don't add this |
| 720 | * gadget driver to list of pending driver |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 721 | * |
| 722 | * Devices are disabled till a gadget driver successfully bind()s, which |
| 723 | * means the driver will handle setup() requests needed to enumerate (and |
| 724 | * meet "chapter 9" requirements) then do some useful work. |
| 725 | * |
| 726 | * If gadget->is_otg is true, the gadget driver must provide an OTG |
| 727 | * descriptor during enumeration, or else fail the bind() call. In such |
| 728 | * cases, no USB traffic may flow until both bind() returns without |
| 729 | * having called usb_gadget_disconnect(), and the USB host stack has |
| 730 | * initialized. |
| 731 | * |
| 732 | * Drivers use hardware-specific knowledge to configure the usb hardware. |
| 733 | * endpoint addressing is only one of several hardware characteristics that |
| 734 | * are in descriptors the ep0 implementation returns from setup() calls. |
| 735 | * |
| 736 | * Except for ep0 implementation, most driver code shouldn't need change to |
| 737 | * run on top of different usb controllers. It'll use endpoints set up by |
| 738 | * that ep0 implementation. |
| 739 | * |
| 740 | * The usb controller driver handles a few standard usb requests. Those |
| 741 | * include set_address, and feature flags for devices, interfaces, and |
| 742 | * endpoints (the get_status, set_feature, and clear_feature requests). |
| 743 | * |
| 744 | * Accordingly, the driver's setup() callback must always implement all |
| 745 | * get_descriptor requests, returning at least a device descriptor and |
| 746 | * a configuration descriptor. Drivers must make sure the endpoint |
| 747 | * descriptors match any hardware constraints. Some hardware also constrains |
| 748 | * other descriptors. (The pxa250 allows only configurations 1, 2, or 3). |
| 749 | * |
| 750 | * The driver's setup() callback must also implement set_configuration, |
| 751 | * and should also implement set_interface, get_configuration, and |
| 752 | * get_interface. Setting a configuration (or interface) is where |
| 753 | * endpoints should be activated or (config 0) shut down. |
| 754 | * |
| 755 | * (Note that only the default control endpoint is supported. Neither |
| 756 | * hosts nor devices generally support control traffic except to ep0.) |
| 757 | * |
| 758 | * Most devices will ignore USB suspend/resume operations, and so will |
| 759 | * not provide those callbacks. However, some may need to change modes |
| 760 | * when the host is not longer directing those activities. For example, |
| 761 | * local controls (buttons, dials, etc) may need to be re-enabled since |
| 762 | * the (remote) host can't do that any longer; or an error state might |
| 763 | * be cleared, to make the device behave identically whether or not |
| 764 | * power is maintained. |
| 765 | */ |
| 766 | struct usb_gadget_driver { |
| 767 | char *function; |
Michal Nazarewicz | 7177aed | 2011-11-19 18:27:38 +0100 | [diff] [blame] | 768 | enum usb_device_speed max_speed; |
Sebastian Andrzej Siewior | ffe0b33 | 2012-09-07 09:53:17 +0200 | [diff] [blame] | 769 | int (*bind)(struct usb_gadget *gadget, |
| 770 | struct usb_gadget_driver *driver); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 771 | void (*unbind)(struct usb_gadget *); |
| 772 | int (*setup)(struct usb_gadget *, |
| 773 | const struct usb_ctrlrequest *); |
| 774 | void (*disconnect)(struct usb_gadget *); |
| 775 | void (*suspend)(struct usb_gadget *); |
| 776 | void (*resume)(struct usb_gadget *); |
Peter Chen | ef979a2 | 2014-09-09 08:56:48 +0800 | [diff] [blame] | 777 | void (*reset)(struct usb_gadget *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 778 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 779 | /* FIXME support safe rmmod */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 780 | struct device_driver driver; |
Ruslan Bilovol | 2284b29 | 2015-11-23 09:56:35 +0100 | [diff] [blame] | 781 | |
| 782 | char *udc_name; |
Ruslan Bilovol | 855ed04 | 2015-11-23 09:56:38 +0100 | [diff] [blame] | 783 | struct list_head pending; |
Krzysztof Opasiak | f1bddbb | 2016-05-05 10:46:05 +0200 | [diff] [blame] | 784 | unsigned match_existing_only:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 785 | }; |
| 786 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 787 | /*-------------------------------------------------------------------------*/ |
| 788 | |
| 789 | /* driver modules register and unregister, as usual. |
| 790 | * these calls must be made in a context that can sleep. |
| 791 | * |
| 792 | * these will usually be implemented directly by the hardware-dependent |
| 793 | * usb bus interface driver, which will only support a single driver. |
| 794 | */ |
| 795 | |
| 796 | /** |
Uwe Kleine-König | b0fca50 | 2010-08-12 17:43:53 +0200 | [diff] [blame] | 797 | * usb_gadget_probe_driver - probe a gadget driver |
| 798 | * @driver: the driver being registered |
Robert Jarzmik | c2344f1 | 2009-01-24 23:54:31 -0800 | [diff] [blame] | 799 | * Context: can sleep |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 800 | * |
| 801 | * Call this in your gadget driver's module initialization function, |
| 802 | * to tell the underlying usb controller driver about your driver. |
Uwe Kleine-König | b0fca50 | 2010-08-12 17:43:53 +0200 | [diff] [blame] | 803 | * The @bind() function will be called to bind it to a gadget before this |
| 804 | * registration call returns. It's expected that the @bind() function will |
| 805 | * be in init sections. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 806 | */ |
Sebastian Andrzej Siewior | 9395295 | 2012-09-06 20:11:05 +0200 | [diff] [blame] | 807 | int usb_gadget_probe_driver(struct usb_gadget_driver *driver); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 808 | |
| 809 | /** |
| 810 | * usb_gadget_unregister_driver - unregister a gadget driver |
| 811 | * @driver:the driver being unregistered |
Robert Jarzmik | c2344f1 | 2009-01-24 23:54:31 -0800 | [diff] [blame] | 812 | * Context: can sleep |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 813 | * |
| 814 | * Call this in your gadget driver's module cleanup function, |
| 815 | * to tell the underlying usb controller that your driver is |
| 816 | * going away. If the controller is connected to a USB host, |
| 817 | * it will first disconnect(). The driver is also requested |
| 818 | * to unbind() and clean up any device state, before this procedure |
David Brownell | 329af28 | 2006-02-18 12:31:05 -0800 | [diff] [blame] | 819 | * finally returns. It's expected that the unbind() functions |
| 820 | * will in in exit sections, so may not be linked in some kernels. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 821 | */ |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 822 | int usb_gadget_unregister_driver(struct usb_gadget_driver *driver); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 823 | |
Felipe Balbi | 792bfcf | 2013-02-26 14:47:44 +0200 | [diff] [blame] | 824 | extern int usb_add_gadget_udc_release(struct device *parent, |
| 825 | struct usb_gadget *gadget, void (*release)(struct device *dev)); |
Felipe Balbi | 2ccea03 | 2011-06-28 16:33:46 +0300 | [diff] [blame] | 826 | extern int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget); |
| 827 | extern void usb_del_gadget_udc(struct usb_gadget *gadget); |
Marek Szyprowski | 175f712 | 2016-02-18 11:34:43 +0100 | [diff] [blame] | 828 | extern char *usb_get_gadget_udc_name(void); |
Felipe Balbi | 2ccea03 | 2011-06-28 16:33:46 +0300 | [diff] [blame] | 829 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 830 | /*-------------------------------------------------------------------------*/ |
| 831 | |
| 832 | /* utility to simplify dealing with string descriptors */ |
| 833 | |
| 834 | /** |
| 835 | * struct usb_string - wraps a C string and its USB id |
| 836 | * @id:the (nonzero) ID for this string |
| 837 | * @s:the string, in UTF-8 encoding |
| 838 | * |
| 839 | * If you're using usb_gadget_get_string(), use this to wrap a string |
| 840 | * together with its ID. |
| 841 | */ |
| 842 | struct usb_string { |
| 843 | u8 id; |
| 844 | const char *s; |
| 845 | }; |
| 846 | |
| 847 | /** |
| 848 | * struct usb_gadget_strings - a set of USB strings in a given language |
| 849 | * @language:identifies the strings' language (0x0409 for en-us) |
| 850 | * @strings:array of strings with their ids |
| 851 | * |
| 852 | * If you're using usb_gadget_get_string(), use this to wrap all the |
| 853 | * strings for a given language. |
| 854 | */ |
| 855 | struct usb_gadget_strings { |
| 856 | u16 language; /* 0x0409 for en-us */ |
| 857 | struct usb_string *strings; |
| 858 | }; |
| 859 | |
Sebastian Andrzej Siewior | 9bb2859 | 2012-12-23 21:10:22 +0100 | [diff] [blame] | 860 | struct usb_gadget_string_container { |
| 861 | struct list_head list; |
| 862 | u8 *stash[0]; |
| 863 | }; |
| 864 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 865 | /* put descriptor for string with that id into buf (buflen >= 256) */ |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 866 | int usb_gadget_get_string(struct usb_gadget_strings *table, int id, u8 *buf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 867 | |
| 868 | /*-------------------------------------------------------------------------*/ |
| 869 | |
| 870 | /* utility to simplify managing config descriptors */ |
| 871 | |
| 872 | /* write vector of descriptors into buffer */ |
| 873 | int usb_descriptor_fillbuf(void *, unsigned, |
| 874 | const struct usb_descriptor_header **); |
| 875 | |
| 876 | /* build config descriptor from single descriptor vector */ |
| 877 | int usb_gadget_config_buf(const struct usb_config_descriptor *config, |
| 878 | void *buf, unsigned buflen, const struct usb_descriptor_header **desc); |
| 879 | |
David Brownell | a4c39c4 | 2008-06-19 17:52:25 -0700 | [diff] [blame] | 880 | /* copy a NULL-terminated vector of descriptors */ |
| 881 | struct usb_descriptor_header **usb_copy_descriptors( |
| 882 | struct usb_descriptor_header **); |
| 883 | |
David Brownell | a4c39c4 | 2008-06-19 17:52:25 -0700 | [diff] [blame] | 884 | /** |
| 885 | * usb_free_descriptors - free descriptors returned by usb_copy_descriptors() |
| 886 | * @v: vector of descriptors |
| 887 | */ |
| 888 | static inline void usb_free_descriptors(struct usb_descriptor_header **v) |
| 889 | { |
| 890 | kfree(v); |
| 891 | } |
| 892 | |
Sebastian Andrzej Siewior | 10287ba | 2012-10-22 22:15:06 +0200 | [diff] [blame] | 893 | struct usb_function; |
| 894 | int usb_assign_descriptors(struct usb_function *f, |
| 895 | struct usb_descriptor_header **fs, |
| 896 | struct usb_descriptor_header **hs, |
John Youn | eaef50c | 2016-02-05 17:06:07 -0800 | [diff] [blame] | 897 | struct usb_descriptor_header **ss, |
| 898 | struct usb_descriptor_header **ssp); |
Sebastian Andrzej Siewior | 10287ba | 2012-10-22 22:15:06 +0200 | [diff] [blame] | 899 | void usb_free_all_descriptors(struct usb_function *f); |
| 900 | |
Li Jun | d1606df | 2015-07-09 15:18:47 +0800 | [diff] [blame] | 901 | struct usb_descriptor_header *usb_otg_descriptor_alloc( |
| 902 | struct usb_gadget *gadget); |
| 903 | int usb_otg_descriptor_init(struct usb_gadget *gadget, |
| 904 | struct usb_descriptor_header *otg_desc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 905 | /*-------------------------------------------------------------------------*/ |
| 906 | |
Danny Segal | f83e451 | 2016-12-06 15:35:24 -0800 | [diff] [blame] | 907 | /** |
| 908 | * usb_func_ep_queue - queues (submits) an I/O request to a function endpoint. |
| 909 | * This function is similar to the usb_ep_queue function, but in addition it |
| 910 | * also checks whether the function is in Super Speed USB Function Suspend |
| 911 | * state, and if so a Function Wake notification is sent to the host |
| 912 | * (USB 3.0 spec, section 9.2.5.2). |
| 913 | * @func: the function which issues the USB I/O request. |
| 914 | * @ep:the endpoint associated with the request |
| 915 | * @req:the request being submitted |
| 916 | * @gfp_flags: GFP_* flags to use in case the lower level driver couldn't |
| 917 | * pre-allocate all necessary memory with the request. |
| 918 | * |
| 919 | */ |
| 920 | int usb_func_ep_queue(struct usb_function *func, struct usb_ep *ep, |
| 921 | struct usb_request *req, gfp_t gfp_flags); |
| 922 | |
| 923 | /*-------------------------------------------------------------------------*/ |
| 924 | |
Felipe Balbi | a698908 | 2011-12-15 13:31:48 +0200 | [diff] [blame] | 925 | /* utility to simplify map/unmap of usb_requests to/from DMA */ |
| 926 | |
Yoshihiro Shimoda | 679ca39 | 2016-04-18 16:53:39 +0900 | [diff] [blame] | 927 | extern int usb_gadget_map_request_by_dev(struct device *dev, |
| 928 | struct usb_request *req, int is_in); |
Felipe Balbi | a698908 | 2011-12-15 13:31:48 +0200 | [diff] [blame] | 929 | extern int usb_gadget_map_request(struct usb_gadget *gadget, |
| 930 | struct usb_request *req, int is_in); |
| 931 | |
Yoshihiro Shimoda | 679ca39 | 2016-04-18 16:53:39 +0900 | [diff] [blame] | 932 | extern void usb_gadget_unmap_request_by_dev(struct device *dev, |
| 933 | struct usb_request *req, int is_in); |
Felipe Balbi | a698908 | 2011-12-15 13:31:48 +0200 | [diff] [blame] | 934 | extern void usb_gadget_unmap_request(struct usb_gadget *gadget, |
| 935 | struct usb_request *req, int is_in); |
| 936 | |
| 937 | /*-------------------------------------------------------------------------*/ |
| 938 | |
Felipe Balbi | 49401f4 | 2011-12-19 12:57:04 +0200 | [diff] [blame] | 939 | /* utility to set gadget state properly */ |
| 940 | |
| 941 | extern void usb_gadget_set_state(struct usb_gadget *gadget, |
| 942 | enum usb_device_state state); |
| 943 | |
| 944 | /*-------------------------------------------------------------------------*/ |
| 945 | |
Peter Chen | 974a70b | 2014-09-12 09:32:41 +0800 | [diff] [blame] | 946 | /* utility to tell udc core that the bus reset occurs */ |
| 947 | extern void usb_gadget_udc_reset(struct usb_gadget *gadget, |
| 948 | struct usb_gadget_driver *driver); |
| 949 | |
| 950 | /*-------------------------------------------------------------------------*/ |
| 951 | |
Michal Sojka | 3fc2aa5 | 2014-09-24 22:43:18 +0200 | [diff] [blame] | 952 | /* utility to give requests back to the gadget layer */ |
| 953 | |
| 954 | extern void usb_gadget_giveback_request(struct usb_ep *ep, |
| 955 | struct usb_request *req); |
| 956 | |
Peter Chen | 628ef0d | 2015-03-06 10:36:03 +0800 | [diff] [blame] | 957 | /*-------------------------------------------------------------------------*/ |
| 958 | |
Robert Baldyga | b0aea00 | 2015-08-06 14:11:12 +0200 | [diff] [blame] | 959 | /* utility to find endpoint by name */ |
| 960 | |
| 961 | extern struct usb_ep *gadget_find_ep_by_name(struct usb_gadget *g, |
| 962 | const char *name); |
| 963 | |
| 964 | /*-------------------------------------------------------------------------*/ |
| 965 | |
Robert Baldyga | 4278c68 | 2015-08-06 14:11:11 +0200 | [diff] [blame] | 966 | /* utility to check if endpoint caps match descriptor needs */ |
| 967 | |
| 968 | extern int usb_gadget_ep_match_desc(struct usb_gadget *gadget, |
| 969 | struct usb_ep *ep, struct usb_endpoint_descriptor *desc, |
| 970 | struct usb_ss_ep_comp_descriptor *ep_comp); |
| 971 | |
| 972 | /*-------------------------------------------------------------------------*/ |
| 973 | |
Peter Chen | 628ef0d | 2015-03-06 10:36:03 +0800 | [diff] [blame] | 974 | /* utility to update vbus status for udc core, it may be scheduled */ |
| 975 | extern void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status); |
Michal Sojka | 3fc2aa5 | 2014-09-24 22:43:18 +0200 | [diff] [blame] | 976 | |
Hemant Kumar | 1127b9f | 2016-12-06 16:23:47 -0800 | [diff] [blame] | 977 | /** |
| 978 | * usb_gadget_autopm_get - increment PM-usage counter of usb gadget's parent |
| 979 | * device. |
| 980 | * @gadget: usb gadget whose parent device counter is incremented |
| 981 | * |
| 982 | * This routine should be called by function driver when it wants to use |
| 983 | * gadget's parent device and needs to guarantee that it is not suspended. In |
| 984 | * addition, the routine prevents subsequent autosuspends of gadget's parent |
| 985 | * device. However if the autoresume fails then the counter is re-decremented. |
| 986 | * |
| 987 | * This routine can run only in process context. |
| 988 | */ |
| 989 | static inline int usb_gadget_autopm_get(struct usb_gadget *gadget) |
| 990 | { |
| 991 | int status = -ENODEV; |
| 992 | |
| 993 | if (!gadget || !gadget->dev.parent) |
| 994 | return status; |
| 995 | |
| 996 | status = pm_runtime_get_sync(gadget->dev.parent); |
| 997 | if (status < 0) |
| 998 | pm_runtime_put_sync(gadget->dev.parent); |
| 999 | |
| 1000 | if (status > 0) |
| 1001 | status = 0; |
| 1002 | return status; |
| 1003 | } |
| 1004 | |
| 1005 | /** |
| 1006 | * usb_gadget_autopm_get_async - increment PM-usage counter of usb gadget's |
| 1007 | * parent device. |
| 1008 | * @gadget: usb gadget whose parent device counter is incremented |
| 1009 | * |
| 1010 | * This routine increments @gadget parent device PM usage counter and queue an |
| 1011 | * autoresume request if the device is suspended. It does not autoresume device |
| 1012 | * directly (it only queues a request). After a successful call, the device may |
| 1013 | * not yet be resumed. |
| 1014 | * |
| 1015 | * This routine can run in atomic context. |
| 1016 | */ |
| 1017 | static inline int usb_gadget_autopm_get_async(struct usb_gadget *gadget) |
| 1018 | { |
| 1019 | int status = -ENODEV; |
| 1020 | |
| 1021 | if (!gadget || !gadget->dev.parent) |
| 1022 | return status; |
| 1023 | |
| 1024 | status = pm_runtime_get(gadget->dev.parent); |
| 1025 | if (status < 0 && status != -EINPROGRESS) |
| 1026 | pm_runtime_put_noidle(gadget->dev.parent); |
| 1027 | |
| 1028 | if (status > 0 || status == -EINPROGRESS) |
| 1029 | status = 0; |
| 1030 | return status; |
| 1031 | } |
| 1032 | |
| 1033 | /** |
| 1034 | * usb_gadget_autopm_get_noresume - increment PM-usage counter of usb gadget's |
| 1035 | * parent device. |
| 1036 | * @gadget: usb gadget whose parent device counter is incremented |
| 1037 | * |
| 1038 | * This routine increments PM-usage count of @gadget parent device but does not |
| 1039 | * carry out an autoresume. |
| 1040 | * |
| 1041 | * This routine can run in atomic context. |
| 1042 | */ |
| 1043 | static inline void usb_gadget_autopm_get_noresume(struct usb_gadget *gadget) |
| 1044 | { |
| 1045 | if (gadget && gadget->dev.parent) |
| 1046 | pm_runtime_get_noresume(gadget->dev.parent); |
| 1047 | } |
| 1048 | |
| 1049 | /** |
| 1050 | * usb_gadget_autopm_put - decrement PM-usage counter of usb gadget's parent |
| 1051 | * device. |
| 1052 | * @gadget: usb gadget whose parent device counter is decremented. |
| 1053 | * |
| 1054 | * This routine should be called by function driver when it is finished using |
| 1055 | * @gadget parent device and wants to allow it to autosuspend. It decrements |
| 1056 | * PM-usage counter of @gadget parent device, when the counter reaches 0, a |
| 1057 | * delayed autosuspend request is attempted. |
| 1058 | * |
| 1059 | * This routine can run only in process context. |
| 1060 | */ |
| 1061 | static inline void usb_gadget_autopm_put(struct usb_gadget *gadget) |
| 1062 | { |
| 1063 | if (gadget && gadget->dev.parent) |
| 1064 | pm_runtime_put_sync(gadget->dev.parent); |
| 1065 | } |
| 1066 | |
| 1067 | /** |
| 1068 | * usb_gadget_autopm_put_async - decrement PM-usage counter of usb gadget's |
| 1069 | * parent device. |
| 1070 | * @gadget: usb gadget whose parent device counter is decremented. |
| 1071 | * |
| 1072 | * This routine decrements PM-usage counter of @gadget parent device and |
| 1073 | * schedules a delayed autosuspend request if the counter is <= 0. |
| 1074 | * |
| 1075 | * This routine can run in atomic context. |
| 1076 | */ |
| 1077 | static inline void usb_gadget_autopm_put_async(struct usb_gadget *gadget) |
| 1078 | { |
| 1079 | if (gadget && gadget->dev.parent) |
| 1080 | pm_runtime_put(gadget->dev.parent); |
| 1081 | } |
| 1082 | |
| 1083 | /** |
| 1084 | * usb_gadget_autopm_put_no_suspend - decrement PM-usage counter of usb gadget |
| 1085 | 's |
| 1086 | * parent device. |
| 1087 | * @gadget: usb gadget whose parent device counter is decremented. |
| 1088 | * |
| 1089 | * This routine decrements PM-usage counter of @gadget parent device but does |
| 1090 | * not carry out an autosuspend. |
| 1091 | * |
| 1092 | * This routine can run in atomic context. |
| 1093 | */ |
| 1094 | static inline void usb_gadget_autopm_put_no_suspend(struct usb_gadget *gadget) |
| 1095 | { |
| 1096 | if (gadget && gadget->dev.parent) |
| 1097 | pm_runtime_put_noidle(gadget->dev.parent); |
| 1098 | } |
| 1099 | |
Michal Sojka | 3fc2aa5 | 2014-09-24 22:43:18 +0200 | [diff] [blame] | 1100 | /*-------------------------------------------------------------------------*/ |
| 1101 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1102 | /* utility wrapping a simple endpoint selection policy */ |
| 1103 | |
Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 1104 | extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *, |
Randy Dunlap | 3ab810f | 2011-04-01 11:24:30 -0700 | [diff] [blame] | 1105 | struct usb_endpoint_descriptor *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1106 | |
Tatyana Brokhman | a59d6b9 | 2011-06-28 16:33:53 +0300 | [diff] [blame] | 1107 | |
| 1108 | extern struct usb_ep *usb_ep_autoconfig_ss(struct usb_gadget *, |
| 1109 | struct usb_endpoint_descriptor *, |
| 1110 | struct usb_ss_ep_comp_descriptor *); |
| 1111 | |
Robert Baldyga | b67f628 | 2015-09-16 12:10:41 +0200 | [diff] [blame] | 1112 | extern void usb_ep_autoconfig_release(struct usb_ep *); |
| 1113 | |
Randy Dunlap | 3ab810f | 2011-04-01 11:24:30 -0700 | [diff] [blame] | 1114 | extern void usb_ep_autoconfig_reset(struct usb_gadget *); |
Devdutt Patnaik | 5477b05 | 2016-12-06 16:09:30 -0800 | [diff] [blame] | 1115 | extern struct usb_ep *usb_ep_autoconfig_by_name(struct usb_gadget *gadget, |
| 1116 | struct usb_endpoint_descriptor *desc, |
| 1117 | const char *ep_name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1118 | |
Mayank Rana | 83ad582 | 2016-08-09 14:17:22 -0700 | [diff] [blame] | 1119 | #ifdef CONFIG_USB_DWC3_MSM |
| 1120 | int msm_ep_config(struct usb_ep *ep); |
| 1121 | int msm_ep_unconfig(struct usb_ep *ep); |
| 1122 | void dwc3_tx_fifo_resize_request(struct usb_ep *ep, bool qdss_enable); |
| 1123 | int msm_data_fifo_config(struct usb_ep *ep, phys_addr_t addr, u32 size, |
| 1124 | u8 dst_pipe_idx); |
| 1125 | bool msm_dwc3_reset_ep_after_lpm(struct usb_gadget *gadget); |
| 1126 | int msm_dwc3_reset_dbm_ep(struct usb_ep *ep); |
| 1127 | #else |
| 1128 | static inline int msm_data_fifo_config(struct usb_ep *ep, phys_addr_t addr, |
| 1129 | u32 size, u8 dst_pipe_idx) |
| 1130 | { return -ENODEV; } |
| 1131 | |
| 1132 | static inline int msm_ep_config(struct usb_ep *ep) |
| 1133 | { return -ENODEV; } |
| 1134 | |
| 1135 | static inline int msm_ep_unconfig(struct usb_ep *ep) |
| 1136 | { return -ENODEV; } |
| 1137 | |
| 1138 | static inline void dwc3_tx_fifo_resize_request(struct usb_ep *ep, |
| 1139 | bool qdss_enable) |
| 1140 | { } |
| 1141 | |
| 1142 | static inline bool msm_dwc3_reset_ep_after_lpm(struct usb_gadget *gadget) |
| 1143 | { return false; } |
| 1144 | |
| 1145 | static inline int msm_dwc3_reset_dbm_ep(struct usb_ep *ep) |
| 1146 | { return -ENODEV; } |
| 1147 | #endif |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 1148 | #endif /* __LINUX_USB_GADGET_H */ |