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