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