MFC r267240:
[freebsd:freebsd.git] / sys / dev / usb / usbdi.h
1 /*-
2  * Copyright (c) 2009 Andrew Thompson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  *
24  * $FreeBSD$
25  */
26 #ifndef _USB_USBDI_H_
27 #define _USB_USBDI_H_
28
29 struct usb_fifo;
30 struct usb_xfer;
31 struct usb_device;
32 struct usb_attach_arg;
33 struct usb_interface;
34 struct usb_endpoint;
35 struct usb_page_cache;
36 struct usb_page_search;
37 struct usb_process;
38 struct usb_proc_msg;
39 struct usb_mbuf;
40 struct usb_fs_privdata;
41 struct mbuf;
42
43 typedef enum {  /* keep in sync with usb_errstr_table */
44         USB_ERR_NORMAL_COMPLETION = 0,
45         USB_ERR_PENDING_REQUESTS,       /* 1 */
46         USB_ERR_NOT_STARTED,            /* 2 */
47         USB_ERR_INVAL,                  /* 3 */
48         USB_ERR_NOMEM,                  /* 4 */
49         USB_ERR_CANCELLED,              /* 5 */
50         USB_ERR_BAD_ADDRESS,            /* 6 */
51         USB_ERR_BAD_BUFSIZE,            /* 7 */
52         USB_ERR_BAD_FLAG,               /* 8 */
53         USB_ERR_NO_CALLBACK,            /* 9 */
54         USB_ERR_IN_USE,                 /* 10 */
55         USB_ERR_NO_ADDR,                /* 11 */
56         USB_ERR_NO_PIPE,                /* 12 */
57         USB_ERR_ZERO_NFRAMES,           /* 13 */
58         USB_ERR_ZERO_MAXP,              /* 14 */
59         USB_ERR_SET_ADDR_FAILED,        /* 15 */
60         USB_ERR_NO_POWER,               /* 16 */
61         USB_ERR_TOO_DEEP,               /* 17 */
62         USB_ERR_IOERROR,                /* 18 */
63         USB_ERR_NOT_CONFIGURED,         /* 19 */
64         USB_ERR_TIMEOUT,                /* 20 */
65         USB_ERR_SHORT_XFER,             /* 21 */
66         USB_ERR_STALLED,                /* 22 */
67         USB_ERR_INTERRUPTED,            /* 23 */
68         USB_ERR_DMA_LOAD_FAILED,        /* 24 */
69         USB_ERR_BAD_CONTEXT,            /* 25 */
70         USB_ERR_NO_ROOT_HUB,            /* 26 */
71         USB_ERR_NO_INTR_THREAD,         /* 27 */
72         USB_ERR_NOT_LOCKED,             /* 28 */
73         USB_ERR_MAX
74 } usb_error_t;
75
76 /*
77  * Flags for transfers
78  */
79 #define USB_FORCE_SHORT_XFER    0x0001  /* force a short transmit last */
80 #define USB_SHORT_XFER_OK       0x0004  /* allow short reads */
81 #define USB_DELAY_STATUS_STAGE  0x0010  /* insert delay before STATUS stage */
82 #define USB_USER_DATA_PTR       0x0020  /* internal flag */
83 #define USB_MULTI_SHORT_OK      0x0040  /* allow multiple short frames */
84 #define USB_MANUAL_STATUS       0x0080  /* manual ctrl status */
85
86 #define USB_NO_TIMEOUT 0
87 #define USB_DEFAULT_TIMEOUT 5000        /* 5000 ms = 5 seconds */
88
89 #if defined(_KERNEL)
90 /* typedefs */
91
92 typedef void (usb_callback_t)(struct usb_xfer *, usb_error_t);
93 typedef void (usb_proc_callback_t)(struct usb_proc_msg *);
94 typedef usb_error_t (usb_handle_req_t)(struct usb_device *,
95     struct usb_device_request *, const void **, uint16_t *);
96
97 typedef int (usb_fifo_open_t)(struct usb_fifo *fifo, int fflags);
98 typedef void (usb_fifo_close_t)(struct usb_fifo *fifo, int fflags);
99 typedef int (usb_fifo_ioctl_t)(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags);
100 typedef void (usb_fifo_cmd_t)(struct usb_fifo *fifo);
101 typedef void (usb_fifo_filter_t)(struct usb_fifo *fifo, struct usb_mbuf *m);
102
103
104 /* USB events */
105 #include <sys/eventhandler.h>
106 typedef void (*usb_dev_configured_t)(void *, struct usb_device *,
107     struct usb_attach_arg *);
108 EVENTHANDLER_DECLARE(usb_dev_configured, usb_dev_configured_t);
109
110 /*
111  * The following macros are used used to convert milliseconds into
112  * HZ. We use 1024 instead of 1000 milliseconds per second to save a
113  * full division.
114  */
115 #define USB_MS_HZ 1024
116
117 #define USB_MS_TO_TICKS(ms) \
118   (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ)
119
120 /*
121  * Common queue structure for USB transfers.
122  */
123 struct usb_xfer_queue {
124         TAILQ_HEAD(, usb_xfer) head;
125         struct usb_xfer *curr;          /* current USB transfer processed */
126         void    (*command) (struct usb_xfer_queue *pq);
127         uint8_t recurse_1:1;
128         uint8_t recurse_2:1;
129 };
130
131 /*
132  * The following structure defines an USB endpoint
133  * USB endpoint.
134  */
135 struct usb_endpoint {
136         struct usb_xfer_queue endpoint_q;       /* queue of USB transfers */
137
138         struct usb_endpoint_descriptor *edesc;
139         struct usb_endpoint_ss_comp_descriptor *ecomp;
140         struct usb_pipe_methods *methods;       /* set by HC driver */
141
142         uint16_t isoc_next;
143
144         uint8_t toggle_next:1;          /* next data toggle value */
145         uint8_t is_stalled:1;           /* set if endpoint is stalled */
146         uint8_t is_synced:1;            /* set if we a synchronised */
147         uint8_t unused:5;
148         uint8_t iface_index;            /* not used by "default endpoint" */
149
150         uint8_t refcount_alloc;         /* allocation refcount */
151         uint8_t refcount_bw;            /* bandwidth refcount */
152 #define USB_EP_REF_MAX 0x3f
153
154         /* High-Speed resource allocation (valid if "refcount_bw" > 0) */
155
156         uint8_t usb_smask;              /* USB start mask */
157         uint8_t usb_cmask;              /* USB complete mask */
158         uint8_t usb_uframe;             /* USB microframe */
159 };
160
161 /*
162  * The following structure defines an USB interface.
163  */
164 struct usb_interface {
165         struct usb_interface_descriptor *idesc;
166         device_t subdev;
167         uint8_t alt_index;
168         uint8_t parent_iface_index;
169
170         /* Linux compat */
171         struct usb_host_interface *altsetting;
172         struct usb_host_interface *cur_altsetting;
173         struct usb_device *linux_udev;
174         void   *bsd_priv_sc;            /* device specific information */
175         char   *pnpinfo;                /* additional PnP-info for this interface */
176         uint8_t num_altsetting;         /* number of alternate settings */
177         uint8_t bsd_iface_index;
178 };
179
180 /*
181  * The following structure defines a set of USB transfer flags.
182  */
183 struct usb_xfer_flags {
184         uint8_t force_short_xfer:1;     /* force a short transmit transfer
185                                          * last */
186         uint8_t short_xfer_ok:1;        /* allow short receive transfers */
187         uint8_t short_frames_ok:1;      /* allow short frames */
188         uint8_t pipe_bof:1;             /* block pipe on failure */
189         uint8_t proxy_buffer:1;         /* makes buffer size a factor of
190                                          * "max_frame_size" */
191         uint8_t ext_buffer:1;           /* uses external DMA buffer */
192         uint8_t manual_status:1;        /* non automatic status stage on
193                                          * control transfers */
194         uint8_t no_pipe_ok:1;           /* set if "USB_ERR_NO_PIPE" error can
195                                          * be ignored */
196         uint8_t stall_pipe:1;           /* set if the endpoint belonging to
197                                          * this USB transfer should be stalled
198                                          * before starting this transfer! */
199         uint8_t pre_scale_frames:1;     /* "usb_config->frames" is
200                                          * assumed to give the
201                                          * buffering time in
202                                          * milliseconds and is
203                                          * converted into the nearest
204                                          * number of frames when the
205                                          * USB transfer is setup. This
206                                          * option only has effect for
207                                          * ISOCHRONOUS transfers.
208                                          */
209 };
210
211 /*
212  * The following structure define an USB configuration, that basically
213  * is used when setting up an USB transfer.
214  */
215 struct usb_config {
216         usb_callback_t *callback;       /* USB transfer callback */
217         usb_frlength_t bufsize; /* total pipe buffer size in bytes */
218         usb_frcount_t frames;           /* maximum number of USB frames */
219         usb_timeout_t interval; /* interval in milliseconds */
220 #define USB_DEFAULT_INTERVAL    0
221         usb_timeout_t timeout;          /* transfer timeout in milliseconds */
222         struct usb_xfer_flags flags;    /* transfer flags */
223         enum usb_hc_mode usb_mode;      /* host or device mode */
224         uint8_t type;                   /* pipe type */
225         uint8_t endpoint;               /* pipe number */
226         uint8_t direction;              /* pipe direction */
227         uint8_t ep_index;               /* pipe index match to use */
228         uint8_t if_index;               /* "ifaces" index to use */
229 };
230
231 /*
232  * Use these macro when defining USB device ID arrays if you want to
233  * have your driver module automatically loaded in host, device or
234  * both modes respectivly:
235  */
236 #define STRUCT_USB_HOST_ID \
237     struct usb_device_id __section("usb_host_id")
238 #define STRUCT_USB_DEVICE_ID \
239     struct usb_device_id __section("usb_device_id")
240 #define STRUCT_USB_DUAL_ID \
241     struct usb_device_id __section("usb_dual_id")
242
243 /*
244  * The following structure is used when looking up an USB driver for
245  * an USB device. It is inspired by the Linux structure called
246  * "usb_device_id".
247  */
248 struct usb_device_id {
249
250         /* Hook for driver specific information */
251         unsigned long driver_info;
252
253         /* Used for product specific matches; the BCD range is inclusive */
254         uint16_t idVendor;
255         uint16_t idProduct;
256         uint16_t bcdDevice_lo;
257         uint16_t bcdDevice_hi;
258
259         /* Used for device class matches */
260         uint8_t bDeviceClass;
261         uint8_t bDeviceSubClass;
262         uint8_t bDeviceProtocol;
263
264         /* Used for interface class matches */
265         uint8_t bInterfaceClass;
266         uint8_t bInterfaceSubClass;
267         uint8_t bInterfaceProtocol;
268
269         /* Select which fields to match against */
270         uint8_t match_flag_vendor:1;
271         uint8_t match_flag_product:1;
272         uint8_t match_flag_dev_lo:1;
273         uint8_t match_flag_dev_hi:1;
274
275         uint8_t match_flag_dev_class:1;
276         uint8_t match_flag_dev_subclass:1;
277         uint8_t match_flag_dev_protocol:1;
278         uint8_t match_flag_int_class:1;
279
280         uint8_t match_flag_int_subclass:1;
281         uint8_t match_flag_int_protocol:1;
282         uint8_t match_flag_unused:6;
283
284 #if USB_HAVE_COMPAT_LINUX
285         /* which fields to match against */
286         uint16_t match_flags;
287 #define USB_DEVICE_ID_MATCH_VENDOR              0x0001
288 #define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
289 #define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
290 #define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
291 #define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
292 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
293 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
294 #define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
295 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
296 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
297 #endif
298 } __aligned(32);
299
300 /* check that the size of the structure above is correct */
301 extern char usb_device_id_assert[(sizeof(struct usb_device_id) == 32) ? 1 : -1];
302
303 #define USB_VENDOR(vend)                        \
304   .match_flag_vendor = 1, .idVendor = (vend)
305
306 #define USB_PRODUCT(prod)                       \
307   .match_flag_product = 1, .idProduct = (prod)
308
309 #define USB_VP(vend,prod)                       \
310   USB_VENDOR(vend), USB_PRODUCT(prod)
311
312 #define USB_VPI(vend,prod,info)                 \
313   USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
314
315 #define USB_DEV_BCD_GTEQ(lo)    /* greater than or equal */ \
316   .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
317
318 #define USB_DEV_BCD_LTEQ(hi)    /* less than or equal */ \
319   .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
320
321 #define USB_DEV_CLASS(dc)                       \
322   .match_flag_dev_class = 1, .bDeviceClass = (dc)
323
324 #define USB_DEV_SUBCLASS(dsc)                   \
325   .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
326
327 #define USB_DEV_PROTOCOL(dp)                    \
328   .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
329
330 #define USB_IFACE_CLASS(ic)                     \
331   .match_flag_int_class = 1, .bInterfaceClass = (ic)
332
333 #define USB_IFACE_SUBCLASS(isc)                 \
334   .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
335
336 #define USB_IFACE_PROTOCOL(ip)                  \
337   .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
338
339 #define USB_IF_CSI(class,subclass,info)                 \
340   USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
341
342 #define USB_DRIVER_INFO(n)                      \
343   .driver_info = (n)
344
345 #define USB_GET_DRIVER_INFO(did)                \
346   (did)->driver_info
347
348 /*
349  * The following structure keeps information that is used to match
350  * against an array of "usb_device_id" elements.
351  */
352 struct usbd_lookup_info {
353         uint16_t idVendor;
354         uint16_t idProduct;
355         uint16_t bcdDevice;
356         uint8_t bDeviceClass;
357         uint8_t bDeviceSubClass;
358         uint8_t bDeviceProtocol;
359         uint8_t bInterfaceClass;
360         uint8_t bInterfaceSubClass;
361         uint8_t bInterfaceProtocol;
362         uint8_t bIfaceIndex;
363         uint8_t bIfaceNum;
364         uint8_t bConfigIndex;
365         uint8_t bConfigNum;
366 };
367
368 /* Structure used by probe and attach */
369
370 struct usb_attach_arg {
371         struct usbd_lookup_info info;
372         device_t temp_dev;              /* for internal use */
373         unsigned long driver_info;      /* for internal use */
374         void *driver_ivar;
375         struct usb_device *device;      /* current device */
376         struct usb_interface *iface;    /* current interface */
377         enum usb_hc_mode usb_mode;      /* host or device mode */
378         uint8_t port;
379         uint8_t dev_state;
380 #define UAA_DEV_READY           0
381 #define UAA_DEV_DISABLED        1
382 #define UAA_DEV_EJECTING        2
383 };
384
385 /*
386  * The following is a wrapper for the callout structure to ease
387  * porting the code to other platforms.
388  */
389 struct usb_callout {
390         struct callout co;
391 };
392 #define usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f)
393 #define usb_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d)
394 #define usb_callout_stop(c) callout_stop(&(c)->co)
395 #define usb_callout_drain(c) callout_drain(&(c)->co)
396 #define usb_callout_pending(c) callout_pending(&(c)->co)
397
398 /* USB transfer states */
399
400 #define USB_ST_SETUP       0
401 #define USB_ST_TRANSFERRED 1
402 #define USB_ST_ERROR       2
403
404 /* USB handle request states */
405 #define USB_HR_NOT_COMPLETE     0
406 #define USB_HR_COMPLETE_OK      1
407 #define USB_HR_COMPLETE_ERR     2
408
409 /*
410  * The following macro will return the current state of an USB
411  * transfer like defined by the "USB_ST_XXX" enums.
412  */
413 #define USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
414
415 /*
416  * The following structure defines the USB process message header.
417  */
418 struct usb_proc_msg {
419         TAILQ_ENTRY(usb_proc_msg) pm_qentry;
420         usb_proc_callback_t *pm_callback;
421         usb_size_t pm_num;
422 };
423
424 #define USB_FIFO_TX 0
425 #define USB_FIFO_RX 1
426
427 /*
428  * Locking note for the following functions.  All the
429  * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
430  * locked. The others are called unlocked.
431  */
432 struct usb_fifo_methods {
433         usb_fifo_open_t *f_open;
434         usb_fifo_close_t *f_close;
435         usb_fifo_ioctl_t *f_ioctl;
436         /*
437          * NOTE: The post-ioctl callback is called after the USB reference
438          * gets locked in the IOCTL handler:
439          */
440         usb_fifo_ioctl_t *f_ioctl_post;
441         usb_fifo_cmd_t *f_start_read;
442         usb_fifo_cmd_t *f_stop_read;
443         usb_fifo_cmd_t *f_start_write;
444         usb_fifo_cmd_t *f_stop_write;
445         usb_fifo_filter_t *f_filter_read;
446         usb_fifo_filter_t *f_filter_write;
447         const char *basename[4];
448         const char *postfix[4];
449 };
450
451 struct usb_fifo_sc {
452         struct usb_fifo *fp[2];
453         struct usb_fs_privdata *dev;
454 };
455
456 const char *usbd_errstr(usb_error_t error);
457 void    *usbd_find_descriptor(struct usb_device *udev, void *id,
458             uint8_t iface_index, uint8_t type, uint8_t type_mask,
459             uint8_t subtype, uint8_t subtype_mask);
460 struct usb_config_descriptor *usbd_get_config_descriptor(
461             struct usb_device *udev);
462 struct usb_device_descriptor *usbd_get_device_descriptor(
463             struct usb_device *udev);
464 struct usb_interface *usbd_get_iface(struct usb_device *udev,
465             uint8_t iface_index);
466 struct usb_interface_descriptor *usbd_get_interface_descriptor(
467             struct usb_interface *iface);
468 struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
469                     const struct usb_config *setup);
470 struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
471 usb_error_t     usbd_interface_count(struct usb_device *udev, uint8_t *count);
472 enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
473 enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
474 void    device_set_usb_desc(device_t dev);
475 void    usb_pause_mtx(struct mtx *mtx, int _ticks);
476 usb_error_t     usbd_set_pnpinfo(struct usb_device *udev,
477                         uint8_t iface_index, const char *pnpinfo);
478 usb_error_t     usbd_add_dynamic_quirk(struct usb_device *udev,
479                         uint16_t quirk);
480
481 const struct usb_device_id *usbd_lookup_id_by_info(
482             const struct usb_device_id *id, usb_size_t sizeof_id,
483             const struct usbd_lookup_info *info);
484 int     usbd_lookup_id_by_uaa(const struct usb_device_id *id,
485             usb_size_t sizeof_id, struct usb_attach_arg *uaa);
486
487 usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
488                     struct usb_device_request *req, void *data, uint16_t flags,
489                     uint16_t *actlen, usb_timeout_t timeout);
490 #define usbd_do_request(u,m,r,d) \
491   usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
492
493 uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1,
494             struct usb_xfer *xfer2);
495 uint8_t usbd_get_interface_altindex(struct usb_interface *iface);
496 usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
497             uint8_t iface_index, uint8_t alt_index);
498 uint32_t usbd_get_isoc_fps(struct usb_device *udev);
499 usb_error_t usbd_transfer_setup(struct usb_device *udev,
500             const uint8_t *ifaces, struct usb_xfer **pxfer,
501             const struct usb_config *setup_start, uint16_t n_setup,
502             void *priv_sc, struct mtx *priv_mtx);
503 void    usbd_transfer_submit(struct usb_xfer *xfer);
504 void    usbd_transfer_clear_stall(struct usb_xfer *xfer);
505 void    usbd_transfer_drain(struct usb_xfer *xfer);
506 uint8_t usbd_transfer_pending(struct usb_xfer *xfer);
507 void    usbd_transfer_start(struct usb_xfer *xfer);
508 void    usbd_transfer_stop(struct usb_xfer *xfer);
509 void    usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
510 void    usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
511 void    usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
512             uint8_t parent_index);
513 uint8_t usbd_get_bus_index(struct usb_device *udev);
514 uint8_t usbd_get_device_index(struct usb_device *udev);
515 void    usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
516 uint8_t usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode);
517 uint8_t usbd_device_attached(struct usb_device *udev);
518
519 usb_frlength_t
520         usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex);
521 void    usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
522             int *aframes, int *nframes);
523 struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *xfer,
524             usb_frcount_t frindex);
525 void    *usbd_xfer_get_frame_buffer(struct usb_xfer *, usb_frcount_t);
526 void    *usbd_xfer_softc(struct usb_xfer *xfer);
527 void    *usbd_xfer_get_priv(struct usb_xfer *xfer);
528 void    usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
529 void    usbd_xfer_set_interval(struct usb_xfer *xfer, int);
530 uint8_t usbd_xfer_state(struct usb_xfer *xfer);
531 void    usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
532             void *ptr, usb_frlength_t len);
533 void    usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
534             void **ptr, int *len);
535 void    usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
536             usb_frcount_t frindex);
537 usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
538 usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
539 usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
540 uint8_t usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
541 usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
542             usb_frcount_t frindex);
543 void    usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
544             usb_frlength_t len);
545 void    usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
546 void    usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
547 void    usbd_xfer_set_stall(struct usb_xfer *xfer);
548 int     usbd_xfer_is_stalled(struct usb_xfer *xfer);
549 void    usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
550 void    usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
551 uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
552 uint8_t usbd_xfer_maxp_was_clamped(struct usb_xfer *xfer);
553
554 void    usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
555             const void *ptr, usb_frlength_t len);
556 int     usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
557             const void *ptr, usb_frlength_t len);
558 void    usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
559             void *ptr, usb_frlength_t len);
560 int     usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
561             void *ptr, usb_frlength_t len);
562 void    usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
563             struct usb_page_search *res);
564 void    usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
565             struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
566 void    usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
567             usb_frlength_t len);
568 void    usbd_start_re_enumerate(struct usb_device *udev);
569 usb_error_t
570         usbd_start_set_config(struct usb_device *, uint8_t);
571
572 int     usb_fifo_attach(struct usb_device *udev, void *priv_sc,
573             struct mtx *priv_mtx, struct usb_fifo_methods *pm,
574             struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
575             uint8_t iface_index, uid_t uid, gid_t gid, int mode);
576 void    usb_fifo_detach(struct usb_fifo_sc *f_sc);
577 int     usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
578             uint16_t nbuf);
579 void    usb_fifo_free_buffer(struct usb_fifo *f);
580 uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
581 void    usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
582             usb_frlength_t offset, usb_frlength_t len, uint8_t what);
583 void    usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
584             usb_size_t len, uint8_t what);
585 uint8_t usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
586 void    usb_fifo_put_data_error(struct usb_fifo *fifo);
587 uint8_t usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
588             usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
589             uint8_t what);
590 uint8_t usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
591             usb_size_t len, usb_size_t *actlen, uint8_t what);
592 uint8_t usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
593             usb_size_t *plen);
594 void    usb_fifo_reset(struct usb_fifo *f);
595 void    usb_fifo_wakeup(struct usb_fifo *f);
596 void    usb_fifo_get_data_error(struct usb_fifo *fifo);
597 void    *usb_fifo_softc(struct usb_fifo *fifo);
598 void    usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
599 void    usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
600 void    usb_fifo_free(struct usb_fifo *f);
601 #endif /* _KERNEL */
602 #endif /* _USB_USBDI_H_ */