Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
9454a57a | 2 | * <linux/usb/gadget.h> |
1da177e4 LT |
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 | ||
e9c23a25 SS |
18 | #include <linux/device.h> |
19 | #include <linux/errno.h> | |
20 | #include <linux/init.h> | |
21 | #include <linux/list.h> | |
5a0e3ad6 | 22 | #include <linux/slab.h> |
898c6086 | 23 | #include <linux/scatterlist.h> |
e9c23a25 | 24 | #include <linux/types.h> |
5702f753 | 25 | #include <linux/workqueue.h> |
325fd182 | 26 | #include <linux/usb/ch9.h> |
5a0e3ad6 | 27 | |
1da177e4 LT |
28 | struct usb_ep; |
29 | ||
30 | /** | |
31 | * struct usb_request - describes one i/o request | |
32 | * @buf: Buffer used for data. Always provide this; some controllers | |
efc9052e | 33 | * only use PIO, or don't use DMA for some endpoints. |
1da177e4 | 34 | * @dma: DMA address corresponding to 'buf'. If you don't set this |
efc9052e DB |
35 | * field, and the usb controller needs one, it is responsible |
36 | * for mapping and unmapping the buffer. | |
898c6086 FB |
37 | * @sg: a scatterlist for SG-capable controllers. |
38 | * @num_sgs: number of SG entries | |
39 | * @num_mapped_sgs: number of SG entries mapped to DMA (internal) | |
1da177e4 | 40 | * @length: Length of that data |
a59d6b91 | 41 | * @stream_id: The stream id, when USB3.0 bulk streams are being used |
1da177e4 LT |
42 | * @no_interrupt: If true, hints that no completion irq is needed. |
43 | * Helpful sometimes with deep request queues that are handled | |
44 | * directly by DMA controllers. | |
45 | * @zero: If true, when writing data, makes the last packet be "short" | |
46 | * by adding a zero length packet as needed; | |
47 | * @short_not_ok: When reading data, makes short packets be | |
48 | * treated as errors (queue stops advancing till cleanup). | |
49 | * @complete: Function called when request completes, so this request and | |
f579c2b4 AS |
50 | * its buffer may be re-used. The function will always be called with |
51 | * interrupts disabled, and it must not sleep. | |
1da177e4 LT |
52 | * Reads terminate with a short packet, or when the buffer fills, |
53 | * whichever comes first. When writes terminate, some data bytes | |
54 | * will usually still be in flight (often in a hardware fifo). | |
55 | * Errors (for reads or writes) stop the queue from advancing | |
56 | * until the completion function returns, so that any transfers | |
57 | * invalidated by the error may first be dequeued. | |
58 | * @context: For use by the completion callback | |
59 | * @list: For use by the gadget driver. | |
60 | * @status: Reports completion code, zero or a negative errno. | |
efc9052e DB |
61 | * Normally, faults block the transfer queue from advancing until |
62 | * the completion callback returns. | |
63 | * Code "-ESHUTDOWN" indicates completion caused by device disconnect, | |
64 | * or when the driver disabled the endpoint. | |
1da177e4 | 65 | * @actual: Reports bytes transferred to/from the buffer. For reads (OUT |
efc9052e DB |
66 | * transfers) this may be less than the requested length. If the |
67 | * short_not_ok flag is set, short reads are treated as errors | |
68 | * even when status otherwise indicates successful completion. | |
69 | * Note that for writes (IN transfers) some data bytes may still | |
70 | * reside in a device-side FIFO when the request is reported as | |
1da177e4 LT |
71 | * complete. |
72 | * | |
73 | * These are allocated/freed through the endpoint they're used with. The | |
74 | * hardware's driver can add extra per-request data to the memory it returns, | |
75 | * which often avoids separate memory allocations (potential failures), | |
76 | * later when the request is queued. | |
77 | * | |
78 | * Request flags affect request handling, such as whether a zero length | |
79 | * packet is written (the "zero" flag), whether a short read should be | |
80 | * treated as an error (blocking request queue advance, the "short_not_ok" | |
81 | * flag), or hinting that an interrupt is not required (the "no_interrupt" | |
82 | * flag, for use with deep request queues). | |
83 | * | |
84 | * Bulk endpoints can use any size buffers, and can also be used for interrupt | |
85 | * transfers. interrupt-only endpoints can be much less functional. | |
41dceed5 | 86 | * |
25985edc | 87 | * NOTE: this is analogous to 'struct urb' on the host side, except that |
41dceed5 | 88 | * it's thinner and promotes more pre-allocation. |
1da177e4 | 89 | */ |
1da177e4 LT |
90 | |
91 | struct usb_request { | |
92 | void *buf; | |
93 | unsigned length; | |
94 | dma_addr_t dma; | |
95 | ||
898c6086 FB |
96 | struct scatterlist *sg; |
97 | unsigned num_sgs; | |
98 | unsigned num_mapped_sgs; | |
99 | ||
a59d6b91 | 100 | unsigned stream_id:16; |
1da177e4 LT |
101 | unsigned no_interrupt:1; |
102 | unsigned zero:1; | |
103 | unsigned short_not_ok:1; | |
104 | ||
105 | void (*complete)(struct usb_ep *ep, | |
106 | struct usb_request *req); | |
107 | void *context; | |
108 | struct list_head list; | |
109 | ||
110 | int status; | |
111 | unsigned actual; | |
112 | }; | |
113 | ||
114 | /*-------------------------------------------------------------------------*/ | |
115 | ||
116 | /* endpoint-specific parts of the api to the usb controller hardware. | |
117 | * unlike the urb model, (de)multiplexing layers are not required. | |
118 | * (so this api could slash overhead if used on the host side...) | |
119 | * | |
120 | * note that device side usb controllers commonly differ in how many | |
121 | * endpoints they support, as well as their capabilities. | |
122 | */ | |
123 | struct usb_ep_ops { | |
124 | int (*enable) (struct usb_ep *ep, | |
125 | const struct usb_endpoint_descriptor *desc); | |
126 | int (*disable) (struct usb_ep *ep); | |
127 | ||
128 | struct usb_request *(*alloc_request) (struct usb_ep *ep, | |
55016f10 | 129 | gfp_t gfp_flags); |
1da177e4 LT |
130 | void (*free_request) (struct usb_ep *ep, struct usb_request *req); |
131 | ||
1da177e4 | 132 | int (*queue) (struct usb_ep *ep, struct usb_request *req, |
55016f10 | 133 | gfp_t gfp_flags); |
1da177e4 LT |
134 | int (*dequeue) (struct usb_ep *ep, struct usb_request *req); |
135 | ||
136 | int (*set_halt) (struct usb_ep *ep, int value); | |
a5e54b0d DL |
137 | int (*set_wedge) (struct usb_ep *ep); |
138 | ||
1da177e4 LT |
139 | int (*fifo_status) (struct usb_ep *ep); |
140 | void (*fifo_flush) (struct usb_ep *ep); | |
141 | }; | |
142 | ||
143 | /** | |
144 | * struct usb_ep - device side representation of USB endpoint | |
145 | * @name:identifier for the endpoint, such as "ep-a" or "ep9in-bulk" | |
146 | * @ops: Function pointers used to access hardware-specific operations. | |
147 | * @ep_list:the gadget's ep_list holds all of its endpoints | |
148 | * @maxpacket:The maximum packet size used on this endpoint. The initial | |
149 | * value can sometimes be reduced (hardware allowing), according to | |
150 | * the endpoint descriptor used to configure the endpoint. | |
e117e742 RB |
151 | * @maxpacket_limit:The maximum packet size value which can be handled by this |
152 | * endpoint. It's set once by UDC driver when endpoint is initialized, and | |
153 | * should not be changed. Should not be confused with maxpacket. | |
a59d6b91 TB |
154 | * @max_streams: The maximum number of streams supported |
155 | * by this EP (0 - 16, actual number is 2^n) | |
bdb64d72 TB |
156 | * @mult: multiplier, 'mult' value for SS Isoc EPs |
157 | * @maxburst: the maximum number of bursts supported by this EP (for usb3) | |
72c973dd | 158 | * @driver_data:for use by the gadget driver. |
48767a4e TB |
159 | * @address: used to identify the endpoint when finding descriptor that |
160 | * matches connection speed | |
72c973dd TB |
161 | * @desc: endpoint descriptor. This pointer is set before the endpoint is |
162 | * enabled and remains valid until the endpoint is disabled. | |
a59d6b91 TB |
163 | * @comp_desc: In case of SuperSpeed support, this is the endpoint companion |
164 | * descriptor that is used to configure the endpoint | |
1da177e4 LT |
165 | * |
166 | * the bus controller driver lists all the general purpose endpoints in | |
167 | * gadget->ep_list. the control endpoint (gadget->ep0) is not in that list, | |
168 | * and is accessed only in response to a driver setup() callback. | |
169 | */ | |
170 | struct usb_ep { | |
171 | void *driver_data; | |
172 | ||
173 | const char *name; | |
174 | const struct usb_ep_ops *ops; | |
175 | struct list_head ep_list; | |
cc476b42 | 176 | bool claimed; |
1da177e4 | 177 | unsigned maxpacket:16; |
e117e742 | 178 | unsigned maxpacket_limit:16; |
a59d6b91 | 179 | unsigned max_streams:16; |
bdb64d72 | 180 | unsigned mult:2; |
a7250db3 | 181 | unsigned maxburst:5; |
48767a4e | 182 | u8 address; |
72c973dd | 183 | const struct usb_endpoint_descriptor *desc; |
a59d6b91 | 184 | const struct usb_ss_ep_comp_descriptor *comp_desc; |
1da177e4 LT |
185 | }; |
186 | ||
187 | /*-------------------------------------------------------------------------*/ | |
188 | ||
e117e742 RB |
189 | /** |
190 | * usb_ep_set_maxpacket_limit - set maximum packet size limit for endpoint | |
191 | * @ep:the endpoint being configured | |
192 | * @maxpacket_limit:value of maximum packet size limit | |
193 | * | |
06ed0de5 | 194 | * This function should be used only in UDC drivers to initialize endpoint |
e117e742 RB |
195 | * (usually in probe function). |
196 | */ | |
197 | static inline void usb_ep_set_maxpacket_limit(struct usb_ep *ep, | |
198 | unsigned maxpacket_limit) | |
199 | { | |
200 | ep->maxpacket_limit = maxpacket_limit; | |
201 | ep->maxpacket = maxpacket_limit; | |
202 | } | |
203 | ||
1da177e4 LT |
204 | /** |
205 | * usb_ep_enable - configure endpoint, making it usable | |
206 | * @ep:the endpoint being configured. may not be the endpoint named "ep0". | |
efc9052e | 207 | * drivers discover endpoints through the ep_list of a usb_gadget. |
1da177e4 | 208 | * |
72c973dd | 209 | * When configurations are set, or when interface settings change, the driver |
1da177e4 LT |
210 | * will enable or disable the relevant endpoints. while it is enabled, an |
211 | * endpoint may be used for i/o until the driver receives a disconnect() from | |
212 | * the host or until the endpoint is disabled. | |
213 | * | |
214 | * the ep0 implementation (which calls this routine) must ensure that the | |
215 | * hardware capabilities of each endpoint match the descriptor provided | |
216 | * for it. for example, an endpoint named "ep2in-bulk" would be usable | |
217 | * for interrupt transfers as well as bulk, but it likely couldn't be used | |
218 | * for iso transfers or for endpoint 14. some endpoints are fully | |
219 | * configurable, with more generic names like "ep-a". (remember that for | |
220 | * USB, "in" means "towards the USB master".) | |
221 | * | |
222 | * returns zero, or a negative error code. | |
223 | */ | |
72c973dd | 224 | static inline int usb_ep_enable(struct usb_ep *ep) |
1da177e4 | 225 | { |
72c973dd | 226 | return ep->ops->enable(ep, ep->desc); |
1da177e4 LT |
227 | } |
228 | ||
229 | /** | |
230 | * usb_ep_disable - endpoint is no longer usable | |
231 | * @ep:the endpoint being unconfigured. may not be the endpoint named "ep0". | |
232 | * | |
233 | * no other task may be using this endpoint when this is called. | |
234 | * any pending and uncompleted requests will complete with status | |
235 | * indicating disconnect (-ESHUTDOWN) before this call returns. | |
236 | * gadget drivers must call usb_ep_enable() again before queueing | |
237 | * requests to the endpoint. | |
238 | * | |
239 | * returns zero, or a negative error code. | |
240 | */ | |
41dceed5 | 241 | static inline int usb_ep_disable(struct usb_ep *ep) |
1da177e4 | 242 | { |
41dceed5 | 243 | return ep->ops->disable(ep); |
1da177e4 LT |
244 | } |
245 | ||
246 | /** | |
247 | * usb_ep_alloc_request - allocate a request object to use with this endpoint | |
248 | * @ep:the endpoint to be used with with the request | |
249 | * @gfp_flags:GFP_* flags to use | |
250 | * | |
251 | * Request objects must be allocated with this call, since they normally | |
252 | * need controller-specific setup and may even need endpoint-specific | |
253 | * resources such as allocation of DMA descriptors. | |
254 | * Requests may be submitted with usb_ep_queue(), and receive a single | |
255 | * completion callback. Free requests with usb_ep_free_request(), when | |
256 | * they are no longer needed. | |
257 | * | |
258 | * Returns the request, or null if one could not be allocated. | |
259 | */ | |
41dceed5 GKH |
260 | static inline struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, |
261 | gfp_t gfp_flags) | |
1da177e4 | 262 | { |
41dceed5 | 263 | return ep->ops->alloc_request(ep, gfp_flags); |
1da177e4 LT |
264 | } |
265 | ||
266 | /** | |
267 | * usb_ep_free_request - frees a request object | |
268 | * @ep:the endpoint associated with the request | |
269 | * @req:the request being freed | |
270 | * | |
271 | * Reverses the effect of usb_ep_alloc_request(). | |
272 | * Caller guarantees the request is not queued, and that it will | |
273 | * no longer be requeued (or otherwise used). | |
274 | */ | |
41dceed5 GKH |
275 | static inline void usb_ep_free_request(struct usb_ep *ep, |
276 | struct usb_request *req) | |
1da177e4 | 277 | { |
41dceed5 | 278 | ep->ops->free_request(ep, req); |
1da177e4 LT |
279 | } |
280 | ||
1da177e4 LT |
281 | /** |
282 | * usb_ep_queue - queues (submits) an I/O request to an endpoint. | |
283 | * @ep:the endpoint associated with the request | |
284 | * @req:the request being submitted | |
285 | * @gfp_flags: GFP_* flags to use in case the lower level driver couldn't | |
efc9052e | 286 | * pre-allocate all necessary memory with the request. |
1da177e4 LT |
287 | * |
288 | * This tells the device controller to perform the specified request through | |
289 | * that endpoint (reading or writing a buffer). When the request completes, | |
290 | * including being canceled by usb_ep_dequeue(), the request's completion | |
291 | * routine is called to return the request to the driver. Any endpoint | |
292 | * (except control endpoints like ep0) may have more than one transfer | |
293 | * request queued; they complete in FIFO order. Once a gadget driver | |
294 | * submits a request, that request may not be examined or modified until it | |
295 | * is given back to that driver through the completion callback. | |
296 | * | |
297 | * Each request is turned into one or more packets. The controller driver | |
298 | * never merges adjacent requests into the same packet. OUT transfers | |
299 | * will sometimes use data that's already buffered in the hardware. | |
300 | * Drivers can rely on the fact that the first byte of the request's buffer | |
301 | * always corresponds to the first byte of some USB packet, for both | |
302 | * IN and OUT transfers. | |
303 | * | |
304 | * Bulk endpoints can queue any amount of data; the transfer is packetized | |
305 | * automatically. The last packet will be short if the request doesn't fill it | |
306 | * out completely. Zero length packets (ZLPs) should be avoided in portable | |
307 | * protocols since not all usb hardware can successfully handle zero length | |
308 | * packets. (ZLPs may be explicitly written, and may be implicitly written if | |
309 | * the request 'zero' flag is set.) Bulk endpoints may also be used | |
310 | * for interrupt transfers; but the reverse is not true, and some endpoints | |
311 | * won't support every interrupt transfer. (Such as 768 byte packets.) | |
312 | * | |
313 | * Interrupt-only endpoints are less functional than bulk endpoints, for | |
314 | * example by not supporting queueing or not handling buffers that are | |
315 | * larger than the endpoint's maxpacket size. They may also treat data | |
316 | * toggle differently. | |
317 | * | |
318 | * Control endpoints ... after getting a setup() callback, the driver queues | |
319 | * one response (even if it would be zero length). That enables the | |
25985edc | 320 | * status ack, after transferring data as specified in the response. Setup |
1da177e4 LT |
321 | * functions may return negative error codes to generate protocol stalls. |
322 | * (Note that some USB device controllers disallow protocol stall responses | |
323 | * in some cases.) When control responses are deferred (the response is | |
324 | * written after the setup callback returns), then usb_ep_set_halt() may be | |
f579c2b4 AS |
325 | * used on ep0 to trigger protocol stalls. Depending on the controller, |
326 | * it may not be possible to trigger a status-stage protocol stall when the | |
327 | * data stage is over, that is, from within the response's completion | |
328 | * routine. | |
1da177e4 LT |
329 | * |
330 | * For periodic endpoints, like interrupt or isochronous ones, the usb host | |
331 | * arranges to poll once per interval, and the gadget driver usually will | |
332 | * have queued some data to transfer at that time. | |
333 | * | |
334 | * Returns zero, or a negative error code. Endpoints that are not enabled | |
335 | * report errors; errors will also be | |
336 | * reported when the usb peripheral is disconnected. | |
337 | */ | |
41dceed5 GKH |
338 | static inline int usb_ep_queue(struct usb_ep *ep, |
339 | struct usb_request *req, gfp_t gfp_flags) | |
1da177e4 | 340 | { |
41dceed5 | 341 | return ep->ops->queue(ep, req, gfp_flags); |
1da177e4 LT |
342 | } |
343 | ||
344 | /** | |
345 | * usb_ep_dequeue - dequeues (cancels, unlinks) an I/O request from an endpoint | |
346 | * @ep:the endpoint associated with the request | |
347 | * @req:the request being canceled | |
348 | * | |
8913dc0b | 349 | * If the request is still active on the endpoint, it is dequeued and its |
1da177e4 | 350 | * completion routine is called (with status -ECONNRESET); else a negative |
8913dc0b PZ |
351 | * error code is returned. This is guaranteed to happen before the call to |
352 | * usb_ep_dequeue() returns. | |
1da177e4 | 353 | * |
8913dc0b PZ |
354 | * Note that some hardware can't clear out write fifos (to unlink the request |
355 | * at the head of the queue) except as part of disconnecting from usb. Such | |
1da177e4 LT |
356 | * restrictions prevent drivers from supporting configuration changes, |
357 | * even to configuration zero (a "chapter 9" requirement). | |
358 | */ | |
41dceed5 | 359 | static inline int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req) |
1da177e4 | 360 | { |
41dceed5 | 361 | return ep->ops->dequeue(ep, req); |
1da177e4 LT |
362 | } |
363 | ||
364 | /** | |
365 | * usb_ep_set_halt - sets the endpoint halt feature. | |
366 | * @ep: the non-isochronous endpoint being stalled | |
367 | * | |
368 | * Use this to stall an endpoint, perhaps as an error report. | |
369 | * Except for control endpoints, | |
370 | * the endpoint stays halted (will not stream any data) until the host | |
371 | * clears this feature; drivers may need to empty the endpoint's request | |
372 | * queue first, to make sure no inappropriate transfers happen. | |
373 | * | |
374 | * Note that while an endpoint CLEAR_FEATURE will be invisible to the | |
375 | * gadget driver, a SET_INTERFACE will not be. To reset endpoints for the | |
376 | * current altsetting, see usb_ep_clear_halt(). When switching altsettings, | |
377 | * it's simplest to use usb_ep_enable() or usb_ep_disable() for the endpoints. | |
378 | * | |
379 | * Returns zero, or a negative error code. On success, this call sets | |
380 | * underlying hardware state that blocks data transfers. | |
381 | * Attempts to halt IN endpoints will fail (returning -EAGAIN) if any | |
382 | * transfer requests are still queued, or if the controller hardware | |
383 | * (usually a FIFO) still holds bytes that the host hasn't collected. | |
384 | */ | |
41dceed5 | 385 | static inline int usb_ep_set_halt(struct usb_ep *ep) |
1da177e4 | 386 | { |
41dceed5 | 387 | return ep->ops->set_halt(ep, 1); |
1da177e4 LT |
388 | } |
389 | ||
390 | /** | |
391 | * usb_ep_clear_halt - clears endpoint halt, and resets toggle | |
392 | * @ep:the bulk or interrupt endpoint being reset | |
393 | * | |
394 | * Use this when responding to the standard usb "set interface" request, | |
395 | * for endpoints that aren't reconfigured, after clearing any other state | |
396 | * in the endpoint's i/o queue. | |
397 | * | |
398 | * Returns zero, or a negative error code. On success, this call clears | |
399 | * the underlying hardware state reflecting endpoint halt and data toggle. | |
400 | * Note that some hardware can't support this request (like pxa2xx_udc), | |
401 | * and accordingly can't correctly implement interface altsettings. | |
402 | */ | |
41dceed5 | 403 | static inline int usb_ep_clear_halt(struct usb_ep *ep) |
1da177e4 | 404 | { |
41dceed5 | 405 | return ep->ops->set_halt(ep, 0); |
1da177e4 LT |
406 | } |
407 | ||
a5e54b0d DL |
408 | /** |
409 | * usb_ep_set_wedge - sets the halt feature and ignores clear requests | |
410 | * @ep: the endpoint being wedged | |
411 | * | |
412 | * Use this to stall an endpoint and ignore CLEAR_FEATURE(HALT_ENDPOINT) | |
413 | * requests. If the gadget driver clears the halt status, it will | |
414 | * automatically unwedge the endpoint. | |
415 | * | |
416 | * Returns zero on success, else negative errno. | |
417 | */ | |
418 | static inline int | |
419 | usb_ep_set_wedge(struct usb_ep *ep) | |
420 | { | |
421 | if (ep->ops->set_wedge) | |
422 | return ep->ops->set_wedge(ep); | |
423 | else | |
424 | return ep->ops->set_halt(ep, 1); | |
425 | } | |
426 | ||
1da177e4 LT |
427 | /** |
428 | * usb_ep_fifo_status - returns number of bytes in fifo, or error | |
429 | * @ep: the endpoint whose fifo status is being checked. | |
430 | * | |
431 | * FIFO endpoints may have "unclaimed data" in them in certain cases, | |
432 | * such as after aborted transfers. Hosts may not have collected all | |
433 | * the IN data written by the gadget driver (and reported by a request | |
434 | * completion). The gadget driver may not have collected all the data | |
435 | * written OUT to it by the host. Drivers that need precise handling for | |
436 | * fault reporting or recovery may need to use this call. | |
437 | * | |
438 | * This returns the number of such bytes in the fifo, or a negative | |
439 | * errno if the endpoint doesn't use a FIFO or doesn't support such | |
440 | * precise handling. | |
441 | */ | |
41dceed5 | 442 | static inline int usb_ep_fifo_status(struct usb_ep *ep) |
1da177e4 LT |
443 | { |
444 | if (ep->ops->fifo_status) | |
41dceed5 | 445 | return ep->ops->fifo_status(ep); |
1da177e4 LT |
446 | else |
447 | return -EOPNOTSUPP; | |
448 | } | |
449 | ||
450 | /** | |
451 | * usb_ep_fifo_flush - flushes contents of a fifo | |
452 | * @ep: the endpoint whose fifo is being flushed. | |
453 | * | |
454 | * This call may be used to flush the "unclaimed data" that may exist in | |
455 | * an endpoint fifo after abnormal transaction terminations. The call | |
456 | * must never be used except when endpoint is not being used for any | |
457 | * protocol translation. | |
458 | */ | |
41dceed5 | 459 | static inline void usb_ep_fifo_flush(struct usb_ep *ep) |
1da177e4 LT |
460 | { |
461 | if (ep->ops->fifo_flush) | |
41dceed5 | 462 | ep->ops->fifo_flush(ep); |
1da177e4 LT |
463 | } |
464 | ||
465 | ||
466 | /*-------------------------------------------------------------------------*/ | |
467 | ||
bdb64d72 TB |
468 | struct usb_dcd_config_params { |
469 | __u8 bU1devExitLat; /* U1 Device exit Latency */ | |
089b837a | 470 | #define USB_DEFAULT_U1_DEV_EXIT_LAT 0x01 /* Less then 1 microsec */ |
bdb64d72 | 471 | __le16 bU2DevExitLat; /* U2 Device exit Latency */ |
089b837a | 472 | #define USB_DEFAULT_U2_DEV_EXIT_LAT 0x1F4 /* Less then 500 microsec */ |
bdb64d72 TB |
473 | }; |
474 | ||
475 | ||
1da177e4 | 476 | struct usb_gadget; |
2ccea03a | 477 | struct usb_gadget_driver; |
dfea9c94 | 478 | struct usb_udc; |
1da177e4 LT |
479 | |
480 | /* the rest of the api to the controller hardware: device operations, | |
481 | * which don't involve endpoints (or i/o). | |
482 | */ | |
483 | struct usb_gadget_ops { | |
484 | int (*get_frame)(struct usb_gadget *); | |
485 | int (*wakeup)(struct usb_gadget *); | |
486 | int (*set_selfpowered) (struct usb_gadget *, int is_selfpowered); | |
487 | int (*vbus_session) (struct usb_gadget *, int is_active); | |
488 | int (*vbus_draw) (struct usb_gadget *, unsigned mA); | |
489 | int (*pullup) (struct usb_gadget *, int is_on); | |
490 | int (*ioctl)(struct usb_gadget *, | |
491 | unsigned code, unsigned long param); | |
bdb64d72 | 492 | void (*get_config_params)(struct usb_dcd_config_params *); |
352c2dc8 SAS |
493 | int (*udc_start)(struct usb_gadget *, |
494 | struct usb_gadget_driver *); | |
22835b80 | 495 | int (*udc_stop)(struct usb_gadget *); |
1da177e4 LT |
496 | }; |
497 | ||
498 | /** | |
499 | * struct usb_gadget - represents a usb slave device | |
5702f753 | 500 | * @work: (internal use) Workqueue to be used for sysfs_notify() |
dfea9c94 | 501 | * @udc: struct usb_udc pointer for this gadget |
1da177e4 LT |
502 | * @ops: Function pointers used to access hardware-specific operations. |
503 | * @ep0: Endpoint zero, used when reading or writing responses to | |
efc9052e | 504 | * driver setup() requests |
1da177e4 LT |
505 | * @ep_list: List of other endpoints supported by the device. |
506 | * @speed: Speed of current connection to USB host. | |
d327ab5b MN |
507 | * @max_speed: Maximal speed the UDC can handle. UDC must support this |
508 | * and all slower speeds. | |
49401f41 | 509 | * @state: the state we are now (attached, suspended, configured, etc) |
d8318d7f DC |
510 | * @name: Identifies the controller hardware type. Used in diagnostics |
511 | * and sometimes configuration. | |
512 | * @dev: Driver model state for this abstract device. | |
513 | * @out_epnum: last used out ep number | |
514 | * @in_epnum: last used in ep number | |
84704bb3 | 515 | * @otg_caps: OTG capabilities of this gadget. |
898c6086 | 516 | * @sg_supported: true if we can handle scatter-gather |
1da177e4 LT |
517 | * @is_otg: True if the USB device port uses a Mini-AB jack, so that the |
518 | * gadget driver must provide a USB OTG descriptor. | |
519 | * @is_a_peripheral: False unless is_otg, the "A" end of a USB cable | |
520 | * is in the Mini-AB jack, and HNP has been used to switch roles | |
521 | * so that the "A" device currently acts as A-Peripheral, not A-Host. | |
522 | * @a_hnp_support: OTG device feature flag, indicating that the A-Host | |
523 | * supports HNP at this port. | |
524 | * @a_alt_hnp_support: OTG device feature flag, indicating that the A-Host | |
525 | * only supports HNP on a different root port. | |
526 | * @b_hnp_enable: OTG device feature flag, indicating that the A-Host | |
527 | * enabled HNP support. | |
0b2d2bba DC |
528 | * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to |
529 | * MaxPacketSize. | |
80b2502c | 530 | * @is_selfpowered: if the gadget is self-powered. |
ccdf138f RB |
531 | * @deactivated: True if gadget is deactivated - in deactivated state it cannot |
532 | * be connected. | |
533 | * @connected: True if gadget is connected. | |
1da177e4 LT |
534 | * |
535 | * Gadgets have a mostly-portable "gadget driver" implementing device | |
536 | * functions, handling all usb configurations and interfaces. Gadget | |
537 | * drivers talk to hardware-specific code indirectly, through ops vectors. | |
538 | * That insulates the gadget driver from hardware details, and packages | |
539 | * the hardware endpoints through generic i/o queues. The "usb_gadget" | |
540 | * and "usb_ep" interfaces provide that insulation from the hardware. | |
541 | * | |
542 | * Except for the driver data, all fields in this structure are | |
543 | * read-only to the gadget driver. That driver data is part of the | |
544 | * "driver model" infrastructure in 2.6 (and later) kernels, and for | |
545 | * earlier systems is grouped in a similar structure that's not known | |
546 | * to the rest of the kernel. | |
547 | * | |
548 | * Values of the three OTG device feature flags are updated before the | |
549 | * setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before | |
550 | * driver suspend() calls. They are valid only when is_otg, and when the | |
551 | * device is acting as a B-Peripheral (so is_a_peripheral is false). | |
552 | */ | |
553 | struct usb_gadget { | |
5702f753 | 554 | struct work_struct work; |
dfea9c94 | 555 | struct usb_udc *udc; |
1da177e4 LT |
556 | /* readonly to gadget driver */ |
557 | const struct usb_gadget_ops *ops; | |
558 | struct usb_ep *ep0; | |
559 | struct list_head ep_list; /* of usb_ep */ | |
560 | enum usb_device_speed speed; | |
d327ab5b | 561 | enum usb_device_speed max_speed; |
49401f41 | 562 | enum usb_device_state state; |
d8318d7f DC |
563 | const char *name; |
564 | struct device dev; | |
565 | unsigned out_epnum; | |
566 | unsigned in_epnum; | |
84704bb3 | 567 | struct usb_otg_caps *otg_caps; |
d8318d7f | 568 | |
898c6086 | 569 | unsigned sg_supported:1; |
1da177e4 LT |
570 | unsigned is_otg:1; |
571 | unsigned is_a_peripheral:1; | |
572 | unsigned b_hnp_enable:1; | |
573 | unsigned a_hnp_support:1; | |
574 | unsigned a_alt_hnp_support:1; | |
0b2d2bba | 575 | unsigned quirk_ep_out_aligned_size:1; |
ffd9a0fc | 576 | unsigned quirk_altset_not_supp:1; |
02ded1b0 | 577 | unsigned quirk_stall_not_supp:1; |
ca1023c8 | 578 | unsigned quirk_zlp_not_supp:1; |
80b2502c | 579 | unsigned is_selfpowered:1; |
ccdf138f RB |
580 | unsigned deactivated:1; |
581 | unsigned connected:1; | |
1da177e4 | 582 | }; |
5702f753 | 583 | #define work_to_gadget(w) (container_of((w), struct usb_gadget, work)) |
1da177e4 | 584 | |
41dceed5 GKH |
585 | static inline void set_gadget_data(struct usb_gadget *gadget, void *data) |
586 | { dev_set_drvdata(&gadget->dev, data); } | |
587 | static inline void *get_gadget_data(struct usb_gadget *gadget) | |
588 | { return dev_get_drvdata(&gadget->dev); } | |
f48cf80f FC |
589 | static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev) |
590 | { | |
591 | return container_of(dev, struct usb_gadget, dev); | |
592 | } | |
1da177e4 LT |
593 | |
594 | /* iterates the non-control endpoints; 'tmp' is a struct usb_ep pointer */ | |
0858a3a5 | 595 | #define gadget_for_each_ep(tmp, gadget) \ |
1da177e4 LT |
596 | list_for_each_entry(tmp, &(gadget)->ep_list, ep_list) |
597 | ||
598 | ||
0b2d2bba DC |
599 | /** |
600 | * usb_ep_align_maybe - returns @len aligned to ep's maxpacketsize if gadget | |
601 | * requires quirk_ep_out_aligned_size, otherwise reguens len. | |
602 | * @g: controller to check for quirk | |
603 | * @ep: the endpoint whose maxpacketsize is used to align @len | |
604 | * @len: buffer size's length to align to @ep's maxpacketsize | |
605 | * | |
606 | * This helper is used in case it's required for any reason to check and maybe | |
607 | * align buffer's size to an ep's maxpacketsize. | |
608 | */ | |
609 | static inline size_t | |
610 | usb_ep_align_maybe(struct usb_gadget *g, struct usb_ep *ep, size_t len) | |
611 | { | |
612 | return !g->quirk_ep_out_aligned_size ? len : | |
613 | round_up(len, (size_t)ep->desc->wMaxPacketSize); | |
614 | } | |
615 | ||
ffd9a0fc RB |
616 | /** |
617 | * gadget_is_altset_supported - return true iff the hardware supports | |
618 | * altsettings | |
619 | * @g: controller to check for quirk | |
620 | */ | |
621 | static inline int gadget_is_altset_supported(struct usb_gadget *g) | |
622 | { | |
623 | return !g->quirk_altset_not_supp; | |
624 | } | |
625 | ||
02ded1b0 RB |
626 | /** |
627 | * gadget_is_stall_supported - return true iff the hardware supports stalling | |
628 | * @g: controller to check for quirk | |
629 | */ | |
630 | static inline int gadget_is_stall_supported(struct usb_gadget *g) | |
631 | { | |
632 | return !g->quirk_stall_not_supp; | |
633 | } | |
634 | ||
ca1023c8 RB |
635 | /** |
636 | * gadget_is_zlp_supported - return true iff the hardware supports zlp | |
637 | * @g: controller to check for quirk | |
638 | */ | |
639 | static inline int gadget_is_zlp_supported(struct usb_gadget *g) | |
640 | { | |
641 | return !g->quirk_zlp_not_supp; | |
642 | } | |
643 | ||
a4e3ef55 DB |
644 | /** |
645 | * gadget_is_dualspeed - return true iff the hardware handles high speed | |
fd39c86b | 646 | * @g: controller that might support both high and full speeds |
a4e3ef55 DB |
647 | */ |
648 | static inline int gadget_is_dualspeed(struct usb_gadget *g) | |
649 | { | |
85b8614d | 650 | return g->max_speed >= USB_SPEED_HIGH; |
a4e3ef55 DB |
651 | } |
652 | ||
bdb64d72 | 653 | /** |
de97f250 RD |
654 | * gadget_is_superspeed() - return true if the hardware handles superspeed |
655 | * @g: controller that might support superspeed | |
bdb64d72 TB |
656 | */ |
657 | static inline int gadget_is_superspeed(struct usb_gadget *g) | |
658 | { | |
85b8614d | 659 | return g->max_speed >= USB_SPEED_SUPER; |
bdb64d72 TB |
660 | } |
661 | ||
a4e3ef55 DB |
662 | /** |
663 | * gadget_is_otg - return true iff the hardware is OTG-ready | |
fd39c86b | 664 | * @g: controller that might have a Mini-AB connector |
a4e3ef55 DB |
665 | * |
666 | * This is a runtime test, since kernels with a USB-OTG stack sometimes | |
667 | * run on boards which only have a Mini-B (or Mini-A) connector. | |
668 | */ | |
669 | static inline int gadget_is_otg(struct usb_gadget *g) | |
670 | { | |
671 | #ifdef CONFIG_USB_OTG | |
672 | return g->is_otg; | |
673 | #else | |
674 | return 0; | |
675 | #endif | |
676 | } | |
677 | ||
1da177e4 LT |
678 | /** |
679 | * usb_gadget_frame_number - returns the current frame number | |
680 | * @gadget: controller that reports the frame number | |
681 | * | |
682 | * Returns the usb frame number, normally eleven bits from a SOF packet, | |
683 | * or negative errno if this device doesn't support this capability. | |
684 | */ | |
41dceed5 | 685 | static inline int usb_gadget_frame_number(struct usb_gadget *gadget) |
1da177e4 | 686 | { |
41dceed5 | 687 | return gadget->ops->get_frame(gadget); |
1da177e4 LT |
688 | } |
689 | ||
690 | /** | |
691 | * usb_gadget_wakeup - tries to wake up the host connected to this gadget | |
692 | * @gadget: controller used to wake up the host | |
693 | * | |
694 | * Returns zero on success, else negative error code if the hardware | |
695 | * doesn't support such attempts, or its support has not been enabled | |
696 | * by the usb host. Drivers must return device descriptors that report | |
697 | * their ability to support this, or hosts won't enable it. | |
698 | * | |
699 | * This may also try to use SRP to wake the host and start enumeration, | |
700 | * even if OTG isn't otherwise in use. OTG devices may also start | |
701 | * remote wakeup even when hosts don't explicitly enable it. | |
702 | */ | |
41dceed5 | 703 | static inline int usb_gadget_wakeup(struct usb_gadget *gadget) |
1da177e4 LT |
704 | { |
705 | if (!gadget->ops->wakeup) | |
706 | return -EOPNOTSUPP; | |
41dceed5 | 707 | return gadget->ops->wakeup(gadget); |
1da177e4 LT |
708 | } |
709 | ||
710 | /** | |
711 | * usb_gadget_set_selfpowered - sets the device selfpowered feature. | |
712 | * @gadget:the device being declared as self-powered | |
713 | * | |
714 | * this affects the device status reported by the hardware driver | |
715 | * to reflect that it now has a local power supply. | |
716 | * | |
717 | * returns zero on success, else negative errno. | |
718 | */ | |
41dceed5 | 719 | static inline int usb_gadget_set_selfpowered(struct usb_gadget *gadget) |
1da177e4 LT |
720 | { |
721 | if (!gadget->ops->set_selfpowered) | |
722 | return -EOPNOTSUPP; | |
41dceed5 | 723 | return gadget->ops->set_selfpowered(gadget, 1); |
1da177e4 LT |
724 | } |
725 | ||
726 | /** | |
727 | * usb_gadget_clear_selfpowered - clear the device selfpowered feature. | |
728 | * @gadget:the device being declared as bus-powered | |
729 | * | |
730 | * this affects the device status reported by the hardware driver. | |
731 | * some hardware may not support bus-powered operation, in which | |
732 | * case this feature's value can never change. | |
733 | * | |
734 | * returns zero on success, else negative errno. | |
735 | */ | |
41dceed5 | 736 | static inline int usb_gadget_clear_selfpowered(struct usb_gadget *gadget) |
1da177e4 LT |
737 | { |
738 | if (!gadget->ops->set_selfpowered) | |
739 | return -EOPNOTSUPP; | |
41dceed5 | 740 | return gadget->ops->set_selfpowered(gadget, 0); |
1da177e4 LT |
741 | } |
742 | ||
743 | /** | |
744 | * usb_gadget_vbus_connect - Notify controller that VBUS is powered | |
745 | * @gadget:The device which now has VBUS power. | |
c2344f13 | 746 | * Context: can sleep |
1da177e4 LT |
747 | * |
748 | * This call is used by a driver for an external transceiver (or GPIO) | |
749 | * that detects a VBUS power session starting. Common responses include | |
750 | * resuming the controller, activating the D+ (or D-) pullup to let the | |
751 | * host detect that a USB device is attached, and starting to draw power | |
752 | * (8mA or possibly more, especially after SET_CONFIGURATION). | |
753 | * | |
754 | * Returns zero on success, else negative errno. | |
755 | */ | |
41dceed5 | 756 | static inline int usb_gadget_vbus_connect(struct usb_gadget *gadget) |
1da177e4 LT |
757 | { |
758 | if (!gadget->ops->vbus_session) | |
759 | return -EOPNOTSUPP; | |
41dceed5 | 760 | return gadget->ops->vbus_session(gadget, 1); |
1da177e4 LT |
761 | } |
762 | ||
763 | /** | |
764 | * usb_gadget_vbus_draw - constrain controller's VBUS power usage | |
765 | * @gadget:The device whose VBUS usage is being described | |
766 | * @mA:How much current to draw, in milliAmperes. This should be twice | |
767 | * the value listed in the configuration descriptor bMaxPower field. | |
768 | * | |
769 | * This call is used by gadget drivers during SET_CONFIGURATION calls, | |
770 | * reporting how much power the device may consume. For example, this | |
771 | * could affect how quickly batteries are recharged. | |
772 | * | |
773 | * Returns zero on success, else negative errno. | |
774 | */ | |
41dceed5 | 775 | static inline int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA) |
1da177e4 LT |
776 | { |
777 | if (!gadget->ops->vbus_draw) | |
778 | return -EOPNOTSUPP; | |
41dceed5 | 779 | return gadget->ops->vbus_draw(gadget, mA); |
1da177e4 LT |
780 | } |
781 | ||
782 | /** | |
783 | * usb_gadget_vbus_disconnect - notify controller about VBUS session end | |
784 | * @gadget:the device whose VBUS supply is being described | |
c2344f13 | 785 | * Context: can sleep |
1da177e4 LT |
786 | * |
787 | * This call is used by a driver for an external transceiver (or GPIO) | |
788 | * that detects a VBUS power session ending. Common responses include | |
789 | * reversing everything done in usb_gadget_vbus_connect(). | |
790 | * | |
791 | * Returns zero on success, else negative errno. | |
792 | */ | |
41dceed5 | 793 | static inline int usb_gadget_vbus_disconnect(struct usb_gadget *gadget) |
1da177e4 LT |
794 | { |
795 | if (!gadget->ops->vbus_session) | |
796 | return -EOPNOTSUPP; | |
41dceed5 | 797 | return gadget->ops->vbus_session(gadget, 0); |
1da177e4 LT |
798 | } |
799 | ||
800 | /** | |
801 | * usb_gadget_connect - software-controlled connect to USB host | |
802 | * @gadget:the peripheral being connected | |
803 | * | |
804 | * Enables the D+ (or potentially D-) pullup. The host will start | |
805 | * enumerating this gadget when the pullup is active and a VBUS session | |
806 | * is active (the link is powered). This pullup is always enabled unless | |
807 | * usb_gadget_disconnect() has been used to disable it. | |
808 | * | |
809 | * Returns zero on success, else negative errno. | |
810 | */ | |
41dceed5 | 811 | static inline int usb_gadget_connect(struct usb_gadget *gadget) |
1da177e4 | 812 | { |
ccdf138f RB |
813 | int ret; |
814 | ||
1da177e4 LT |
815 | if (!gadget->ops->pullup) |
816 | return -EOPNOTSUPP; | |
ccdf138f RB |
817 | |
818 | if (gadget->deactivated) { | |
819 | /* | |
820 | * If gadget is deactivated we only save new state. | |
821 | * Gadget will be connected automatically after activation. | |
822 | */ | |
823 | gadget->connected = true; | |
824 | return 0; | |
825 | } | |
826 | ||
827 | ret = gadget->ops->pullup(gadget, 1); | |
828 | if (!ret) | |
829 | gadget->connected = 1; | |
830 | return ret; | |
1da177e4 LT |
831 | } |
832 | ||
833 | /** | |
834 | * usb_gadget_disconnect - software-controlled disconnect from USB host | |
835 | * @gadget:the peripheral being disconnected | |
836 | * | |
837 | * Disables the D+ (or potentially D-) pullup, which the host may see | |
838 | * as a disconnect (when a VBUS session is active). Not all systems | |
839 | * support software pullup controls. | |
840 | * | |
ccdf138f RB |
841 | * Returns zero on success, else negative errno. |
842 | */ | |
843 | static inline int usb_gadget_disconnect(struct usb_gadget *gadget) | |
844 | { | |
845 | int ret; | |
846 | ||
847 | if (!gadget->ops->pullup) | |
848 | return -EOPNOTSUPP; | |
849 | ||
850 | if (gadget->deactivated) { | |
851 | /* | |
852 | * If gadget is deactivated we only save new state. | |
853 | * Gadget will stay disconnected after activation. | |
854 | */ | |
855 | gadget->connected = false; | |
856 | return 0; | |
857 | } | |
858 | ||
859 | ret = gadget->ops->pullup(gadget, 0); | |
860 | if (!ret) | |
861 | gadget->connected = 0; | |
862 | return ret; | |
863 | } | |
864 | ||
865 | /** | |
866 | * usb_gadget_deactivate - deactivate function which is not ready to work | |
867 | * @gadget: the peripheral being deactivated | |
868 | * | |
1da177e4 LT |
869 | * This routine may be used during the gadget driver bind() call to prevent |
870 | * the peripheral from ever being visible to the USB host, unless later | |
ccdf138f | 871 | * usb_gadget_activate() is called. For example, user mode components may |
1da177e4 LT |
872 | * need to be activated before the system can talk to hosts. |
873 | * | |
874 | * Returns zero on success, else negative errno. | |
875 | */ | |
ccdf138f | 876 | static inline int usb_gadget_deactivate(struct usb_gadget *gadget) |
1da177e4 | 877 | { |
ccdf138f RB |
878 | int ret; |
879 | ||
880 | if (gadget->deactivated) | |
881 | return 0; | |
882 | ||
883 | if (gadget->connected) { | |
884 | ret = usb_gadget_disconnect(gadget); | |
885 | if (ret) | |
886 | return ret; | |
887 | /* | |
888 | * If gadget was being connected before deactivation, we want | |
889 | * to reconnect it in usb_gadget_activate(). | |
890 | */ | |
891 | gadget->connected = true; | |
892 | } | |
893 | gadget->deactivated = true; | |
894 | ||
895 | return 0; | |
1da177e4 LT |
896 | } |
897 | ||
ccdf138f RB |
898 | /** |
899 | * usb_gadget_activate - activate function which is not ready to work | |
900 | * @gadget: the peripheral being activated | |
901 | * | |
902 | * This routine activates gadget which was previously deactivated with | |
903 | * usb_gadget_deactivate() call. It calls usb_gadget_connect() if needed. | |
904 | * | |
905 | * Returns zero on success, else negative errno. | |
906 | */ | |
907 | static inline int usb_gadget_activate(struct usb_gadget *gadget) | |
908 | { | |
909 | if (!gadget->deactivated) | |
910 | return 0; | |
911 | ||
912 | gadget->deactivated = false; | |
913 | ||
914 | /* | |
915 | * If gadget has been connected before deactivation, or became connected | |
916 | * while it was being deactivated, we call usb_gadget_connect(). | |
917 | */ | |
918 | if (gadget->connected) | |
919 | return usb_gadget_connect(gadget); | |
920 | ||
921 | return 0; | |
922 | } | |
1da177e4 | 923 | |
1da177e4 LT |
924 | /*-------------------------------------------------------------------------*/ |
925 | ||
926 | /** | |
927 | * struct usb_gadget_driver - driver for usb 'slave' devices | |
928 | * @function: String describing the gadget's function | |
7177aed4 | 929 | * @max_speed: Highest speed the driver handles. |
1da177e4 | 930 | * @setup: Invoked for ep0 control requests that aren't handled by |
efc9052e DB |
931 | * the hardware level driver. Most calls must be handled by |
932 | * the gadget driver, including descriptor and configuration | |
933 | * management. The 16 bit members of the setup data are in | |
934 | * USB byte order. Called in_interrupt; this may not sleep. Driver | |
1da177e4 LT |
935 | * queues a response to ep0, or returns negative to stall. |
936 | * @disconnect: Invoked after all transfers have been stopped, | |
efc9052e DB |
937 | * when the host is disconnected. May be called in_interrupt; this |
938 | * may not sleep. Some devices can't detect disconnect, so this might | |
1da177e4 | 939 | * not be called except as part of controller shutdown. |
93952956 | 940 | * @bind: the driver's bind callback |
1da177e4 | 941 | * @unbind: Invoked when the driver is unbound from a gadget, |
efc9052e DB |
942 | * usually from rmmod (after a disconnect is reported). |
943 | * Called in a context that permits sleeping. | |
1da177e4 LT |
944 | * @suspend: Invoked on USB suspend. May be called in_interrupt. |
945 | * @resume: Invoked on USB resume. May be called in_interrupt. | |
ef979a26 PC |
946 | * @reset: Invoked on USB bus reset. It is mandatory for all gadget drivers |
947 | * and should be called in_interrupt. | |
1da177e4 LT |
948 | * @driver: Driver model state for this driver. |
949 | * | |
950 | * Devices are disabled till a gadget driver successfully bind()s, which | |
951 | * means the driver will handle setup() requests needed to enumerate (and | |
952 | * meet "chapter 9" requirements) then do some useful work. | |
953 | * | |
954 | * If gadget->is_otg is true, the gadget driver must provide an OTG | |
955 | * descriptor during enumeration, or else fail the bind() call. In such | |
956 | * cases, no USB traffic may flow until both bind() returns without | |
957 | * having called usb_gadget_disconnect(), and the USB host stack has | |
958 | * initialized. | |
959 | * | |
960 | * Drivers use hardware-specific knowledge to configure the usb hardware. | |
961 | * endpoint addressing is only one of several hardware characteristics that | |
962 | * are in descriptors the ep0 implementation returns from setup() calls. | |
963 | * | |
964 | * Except for ep0 implementation, most driver code shouldn't need change to | |
965 | * run on top of different usb controllers. It'll use endpoints set up by | |
966 | * that ep0 implementation. | |
967 | * | |
968 | * The usb controller driver handles a few standard usb requests. Those | |
969 | * include set_address, and feature flags for devices, interfaces, and | |
970 | * endpoints (the get_status, set_feature, and clear_feature requests). | |
971 | * | |
972 | * Accordingly, the driver's setup() callback must always implement all | |
973 | * get_descriptor requests, returning at least a device descriptor and | |
974 | * a configuration descriptor. Drivers must make sure the endpoint | |
975 | * descriptors match any hardware constraints. Some hardware also constrains | |
976 | * other descriptors. (The pxa250 allows only configurations 1, 2, or 3). | |
977 | * | |
978 | * The driver's setup() callback must also implement set_configuration, | |
979 | * and should also implement set_interface, get_configuration, and | |
980 | * get_interface. Setting a configuration (or interface) is where | |
981 | * endpoints should be activated or (config 0) shut down. | |
982 | * | |
983 | * (Note that only the default control endpoint is supported. Neither | |
984 | * hosts nor devices generally support control traffic except to ep0.) | |
985 | * | |
986 | * Most devices will ignore USB suspend/resume operations, and so will | |
987 | * not provide those callbacks. However, some may need to change modes | |
988 | * when the host is not longer directing those activities. For example, | |
989 | * local controls (buttons, dials, etc) may need to be re-enabled since | |
990 | * the (remote) host can't do that any longer; or an error state might | |
991 | * be cleared, to make the device behave identically whether or not | |
992 | * power is maintained. | |
993 | */ | |
994 | struct usb_gadget_driver { | |
995 | char *function; | |
7177aed4 | 996 | enum usb_device_speed max_speed; |
ffe0b335 SAS |
997 | int (*bind)(struct usb_gadget *gadget, |
998 | struct usb_gadget_driver *driver); | |
1da177e4 LT |
999 | void (*unbind)(struct usb_gadget *); |
1000 | int (*setup)(struct usb_gadget *, | |
1001 | const struct usb_ctrlrequest *); | |
1002 | void (*disconnect)(struct usb_gadget *); | |
1003 | void (*suspend)(struct usb_gadget *); | |
1004 | void (*resume)(struct usb_gadget *); | |
ef979a26 | 1005 | void (*reset)(struct usb_gadget *); |
1da177e4 | 1006 | |
41dceed5 | 1007 | /* FIXME support safe rmmod */ |
1da177e4 LT |
1008 | struct device_driver driver; |
1009 | }; | |
1010 | ||
1011 | ||
1012 | ||
1013 | /*-------------------------------------------------------------------------*/ | |
1014 | ||
1015 | /* driver modules register and unregister, as usual. | |
1016 | * these calls must be made in a context that can sleep. | |
1017 | * | |
1018 | * these will usually be implemented directly by the hardware-dependent | |
1019 | * usb bus interface driver, which will only support a single driver. | |
1020 | */ | |
1021 | ||
1022 | /** | |
b0fca50f UKK |
1023 | * usb_gadget_probe_driver - probe a gadget driver |
1024 | * @driver: the driver being registered | |
c2344f13 | 1025 | * Context: can sleep |
1da177e4 LT |
1026 | * |
1027 | * Call this in your gadget driver's module initialization function, | |
1028 | * to tell the underlying usb controller driver about your driver. | |
b0fca50f UKK |
1029 | * The @bind() function will be called to bind it to a gadget before this |
1030 | * registration call returns. It's expected that the @bind() function will | |
1031 | * be in init sections. | |
1da177e4 | 1032 | */ |
93952956 | 1033 | int usb_gadget_probe_driver(struct usb_gadget_driver *driver); |
1da177e4 LT |
1034 | |
1035 | /** | |
1036 | * usb_gadget_unregister_driver - unregister a gadget driver | |
1037 | * @driver:the driver being unregistered | |
c2344f13 | 1038 | * Context: can sleep |
1da177e4 LT |
1039 | * |
1040 | * Call this in your gadget driver's module cleanup function, | |
1041 | * to tell the underlying usb controller that your driver is | |
1042 | * going away. If the controller is connected to a USB host, | |
1043 | * it will first disconnect(). The driver is also requested | |
1044 | * to unbind() and clean up any device state, before this procedure | |
329af28b DB |
1045 | * finally returns. It's expected that the unbind() functions |
1046 | * will in in exit sections, so may not be linked in some kernels. | |
1da177e4 | 1047 | */ |
41dceed5 | 1048 | int usb_gadget_unregister_driver(struct usb_gadget_driver *driver); |
1da177e4 | 1049 | |
792bfcf7 FB |
1050 | extern int usb_add_gadget_udc_release(struct device *parent, |
1051 | struct usb_gadget *gadget, void (*release)(struct device *dev)); | |
2ccea03a FB |
1052 | extern int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget); |
1053 | extern void usb_del_gadget_udc(struct usb_gadget *gadget); | |
02e8c966 | 1054 | extern int usb_udc_attach_driver(const char *name, |
4c49a5f0 | 1055 | struct usb_gadget_driver *driver); |
2ccea03a | 1056 | |
1da177e4 LT |
1057 | /*-------------------------------------------------------------------------*/ |
1058 | ||
1059 | /* utility to simplify dealing with string descriptors */ | |
1060 | ||
1061 | /** | |
1062 | * struct usb_string - wraps a C string and its USB id | |
1063 | * @id:the (nonzero) ID for this string | |
1064 | * @s:the string, in UTF-8 encoding | |
1065 | * | |
1066 | * If you're using usb_gadget_get_string(), use this to wrap a string | |
1067 | * together with its ID. | |
1068 | */ | |
1069 | struct usb_string { | |
1070 | u8 id; | |
1071 | const char *s; | |
1072 | }; | |
1073 | ||
1074 | /** | |
1075 | * struct usb_gadget_strings - a set of USB strings in a given language | |
1076 | * @language:identifies the strings' language (0x0409 for en-us) | |
1077 | * @strings:array of strings with their ids | |
1078 | * | |
1079 | * If you're using usb_gadget_get_string(), use this to wrap all the | |
1080 | * strings for a given language. | |
1081 | */ | |
1082 | struct usb_gadget_strings { | |
1083 | u16 language; /* 0x0409 for en-us */ | |
1084 | struct usb_string *strings; | |
1085 | }; | |
1086 | ||
9bb2859f SAS |
1087 | struct usb_gadget_string_container { |
1088 | struct list_head list; | |
1089 | u8 *stash[0]; | |
1090 | }; | |
1091 | ||
1da177e4 | 1092 | /* put descriptor for string with that id into buf (buflen >= 256) */ |
41dceed5 | 1093 | int usb_gadget_get_string(struct usb_gadget_strings *table, int id, u8 *buf); |
1da177e4 LT |
1094 | |
1095 | /*-------------------------------------------------------------------------*/ | |
1096 | ||
1097 | /* utility to simplify managing config descriptors */ | |
1098 | ||
1099 | /* write vector of descriptors into buffer */ | |
1100 | int usb_descriptor_fillbuf(void *, unsigned, | |
1101 | const struct usb_descriptor_header **); | |
1102 | ||
1103 | /* build config descriptor from single descriptor vector */ | |
1104 | int usb_gadget_config_buf(const struct usb_config_descriptor *config, | |
1105 | void *buf, unsigned buflen, const struct usb_descriptor_header **desc); | |
1106 | ||
a4c39c41 DB |
1107 | /* copy a NULL-terminated vector of descriptors */ |
1108 | struct usb_descriptor_header **usb_copy_descriptors( | |
1109 | struct usb_descriptor_header **); | |
1110 | ||
a4c39c41 DB |
1111 | /** |
1112 | * usb_free_descriptors - free descriptors returned by usb_copy_descriptors() | |
1113 | * @v: vector of descriptors | |
1114 | */ | |
1115 | static inline void usb_free_descriptors(struct usb_descriptor_header **v) | |
1116 | { | |
1117 | kfree(v); | |
1118 | } | |
1119 | ||
10287bae SAS |
1120 | struct usb_function; |
1121 | int usb_assign_descriptors(struct usb_function *f, | |
1122 | struct usb_descriptor_header **fs, | |
1123 | struct usb_descriptor_header **hs, | |
1124 | struct usb_descriptor_header **ss); | |
1125 | void usb_free_all_descriptors(struct usb_function *f); | |
1126 | ||
d1606dfb LJ |
1127 | struct usb_descriptor_header *usb_otg_descriptor_alloc( |
1128 | struct usb_gadget *gadget); | |
1129 | int usb_otg_descriptor_init(struct usb_gadget *gadget, | |
1130 | struct usb_descriptor_header *otg_desc); | |
1da177e4 LT |
1131 | /*-------------------------------------------------------------------------*/ |
1132 | ||
a698908d FB |
1133 | /* utility to simplify map/unmap of usb_requests to/from DMA */ |
1134 | ||
1135 | extern int usb_gadget_map_request(struct usb_gadget *gadget, | |
1136 | struct usb_request *req, int is_in); | |
1137 | ||
1138 | extern void usb_gadget_unmap_request(struct usb_gadget *gadget, | |
1139 | struct usb_request *req, int is_in); | |
1140 | ||
1141 | /*-------------------------------------------------------------------------*/ | |
1142 | ||
49401f41 FB |
1143 | /* utility to set gadget state properly */ |
1144 | ||
1145 | extern void usb_gadget_set_state(struct usb_gadget *gadget, | |
1146 | enum usb_device_state state); | |
1147 | ||
1148 | /*-------------------------------------------------------------------------*/ | |
1149 | ||
974a70bd PC |
1150 | /* utility to tell udc core that the bus reset occurs */ |
1151 | extern void usb_gadget_udc_reset(struct usb_gadget *gadget, | |
1152 | struct usb_gadget_driver *driver); | |
1153 | ||
1154 | /*-------------------------------------------------------------------------*/ | |
1155 | ||
3fc2aa55 MS |
1156 | /* utility to give requests back to the gadget layer */ |
1157 | ||
1158 | extern void usb_gadget_giveback_request(struct usb_ep *ep, | |
1159 | struct usb_request *req); | |
1160 | ||
628ef0d2 PC |
1161 | /*-------------------------------------------------------------------------*/ |
1162 | ||
1163 | /* utility to update vbus status for udc core, it may be scheduled */ | |
1164 | extern void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status); | |
3fc2aa55 MS |
1165 | |
1166 | /*-------------------------------------------------------------------------*/ | |
1167 | ||
1da177e4 LT |
1168 | /* utility wrapping a simple endpoint selection policy */ |
1169 | ||
41dceed5 | 1170 | extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *, |
3ab810f1 | 1171 | struct usb_endpoint_descriptor *); |
1da177e4 | 1172 | |
a59d6b91 TB |
1173 | |
1174 | extern struct usb_ep *usb_ep_autoconfig_ss(struct usb_gadget *, | |
1175 | struct usb_endpoint_descriptor *, | |
1176 | struct usb_ss_ep_comp_descriptor *); | |
1177 | ||
3ab810f1 | 1178 | extern void usb_ep_autoconfig_reset(struct usb_gadget *); |
1da177e4 | 1179 | |
dda43a0e | 1180 | #endif /* __LINUX_USB_GADGET_H */ |