source: rtems-libbsd/freebsd/sys/dev/usb/usbdi.h @ 7eeb079

4.1155-freebsd-126-freebsd-12freebsd-9.3
Last change on this file since 7eeb079 was 7eeb079, checked in by Sebastian Huber <sebastian.huber@…>, on 02/02/15 at 13:27:13

Update to FreeBSD 9.3
  • Property mode set to 100644
File size: 21.4 KB
Line 
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
29struct usb_fifo;
30struct usb_xfer;
31struct usb_device;
32struct usb_attach_arg;
33struct usb_interface;
34struct usb_endpoint;
35struct usb_page_cache;
36struct usb_page_search;
37struct usb_process;
38struct usb_proc_msg;
39struct usb_mbuf;
40struct usb_fs_privdata;
41struct mbuf;
42
43typedef 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
92typedef void (usb_callback_t)(struct usb_xfer *, usb_error_t);
93typedef void (usb_proc_callback_t)(struct usb_proc_msg *);
94typedef usb_error_t (usb_handle_req_t)(struct usb_device *,
95    struct usb_device_request *, const void **, uint16_t *);
96
97typedef int (usb_fifo_open_t)(struct usb_fifo *fifo, int fflags);
98typedef void (usb_fifo_close_t)(struct usb_fifo *fifo, int fflags);
99typedef int (usb_fifo_ioctl_t)(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags);
100typedef void (usb_fifo_cmd_t)(struct usb_fifo *fifo);
101typedef void (usb_fifo_filter_t)(struct usb_fifo *fifo, struct usb_mbuf *m);
102
103
104/* USB events */
105#include <sys/eventhandler.h>
106typedef void (*usb_dev_configured_t)(void *, struct usb_device *,
107    struct usb_attach_arg *);
108EVENTHANDLER_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 */
123struct 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 */
135struct 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 */
164struct 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 */
183struct 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 */
215struct 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#ifndef __rtems__
237#define STRUCT_USB_HOST_ID \
238    struct usb_device_id __section("usb_host_id")
239#define STRUCT_USB_DEVICE_ID \
240    struct usb_device_id __section("usb_device_id")
241#define STRUCT_USB_DUAL_ID \
242    struct usb_device_id __section("usb_dual_id")
243#else /* __rtems__ */
244#define STRUCT_USB_HOST_ID \
245    struct usb_device_id
246#define STRUCT_USB_DEVICE_ID \
247    struct usb_device_id
248#define STRUCT_USB_DUAL_ID \
249    struct usb_device_id
250#endif /* __rtems__ */
251
252/*
253 * The following structure is used when looking up an USB driver for
254 * an USB device. It is inspired by the Linux structure called
255 * "usb_device_id".
256 */
257struct usb_device_id {
258
259        /* Hook for driver specific information */
260        unsigned long driver_info;
261
262        /* Used for product specific matches; the BCD range is inclusive */
263        uint16_t idVendor;
264        uint16_t idProduct;
265        uint16_t bcdDevice_lo;
266        uint16_t bcdDevice_hi;
267
268        /* Used for device class matches */
269        uint8_t bDeviceClass;
270        uint8_t bDeviceSubClass;
271        uint8_t bDeviceProtocol;
272
273        /* Used for interface class matches */
274        uint8_t bInterfaceClass;
275        uint8_t bInterfaceSubClass;
276        uint8_t bInterfaceProtocol;
277
278        /* Select which fields to match against */
279        uint8_t match_flag_vendor:1;
280        uint8_t match_flag_product:1;
281        uint8_t match_flag_dev_lo:1;
282        uint8_t match_flag_dev_hi:1;
283
284        uint8_t match_flag_dev_class:1;
285        uint8_t match_flag_dev_subclass:1;
286        uint8_t match_flag_dev_protocol:1;
287        uint8_t match_flag_int_class:1;
288
289        uint8_t match_flag_int_subclass:1;
290        uint8_t match_flag_int_protocol:1;
291        uint8_t match_flag_unused:6;
292
293#if USB_HAVE_COMPAT_LINUX
294        /* which fields to match against */
295        uint16_t match_flags;
296#define USB_DEVICE_ID_MATCH_VENDOR              0x0001
297#define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
298#define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
299#define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
300#define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
301#define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
302#define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
303#define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
304#define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
305#define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
306#endif
307} __aligned(32);
308
309/* check that the size of the structure above is correct */
310extern char usb_device_id_assert[(sizeof(struct usb_device_id) == 32) ? 1 : -1];
311
312#define USB_VENDOR(vend)                        \
313  .match_flag_vendor = 1, .idVendor = (vend)
314
315#define USB_PRODUCT(prod)                       \
316  .match_flag_product = 1, .idProduct = (prod)
317
318#define USB_VP(vend,prod)                       \
319  USB_VENDOR(vend), USB_PRODUCT(prod)
320
321#define USB_VPI(vend,prod,info)                 \
322  USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
323
324#define USB_DEV_BCD_GTEQ(lo)    /* greater than or equal */ \
325  .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
326
327#define USB_DEV_BCD_LTEQ(hi)    /* less than or equal */ \
328  .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
329
330#define USB_DEV_CLASS(dc)                       \
331  .match_flag_dev_class = 1, .bDeviceClass = (dc)
332
333#define USB_DEV_SUBCLASS(dsc)                   \
334  .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
335
336#define USB_DEV_PROTOCOL(dp)                    \
337  .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
338
339#define USB_IFACE_CLASS(ic)                     \
340  .match_flag_int_class = 1, .bInterfaceClass = (ic)
341
342#define USB_IFACE_SUBCLASS(isc)                 \
343  .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
344
345#define USB_IFACE_PROTOCOL(ip)                  \
346  .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
347
348#define USB_IF_CSI(class,subclass,info)                 \
349  USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
350
351#define USB_DRIVER_INFO(n)                      \
352  .driver_info = (n)
353
354#define USB_GET_DRIVER_INFO(did)                \
355  (did)->driver_info
356
357/*
358 * The following structure keeps information that is used to match
359 * against an array of "usb_device_id" elements.
360 */
361struct usbd_lookup_info {
362        uint16_t idVendor;
363        uint16_t idProduct;
364        uint16_t bcdDevice;
365        uint8_t bDeviceClass;
366        uint8_t bDeviceSubClass;
367        uint8_t bDeviceProtocol;
368        uint8_t bInterfaceClass;
369        uint8_t bInterfaceSubClass;
370        uint8_t bInterfaceProtocol;
371        uint8_t bIfaceIndex;
372        uint8_t bIfaceNum;
373        uint8_t bConfigIndex;
374        uint8_t bConfigNum;
375};
376
377/* Structure used by probe and attach */
378
379struct usb_attach_arg {
380        struct usbd_lookup_info info;
381        device_t temp_dev;              /* for internal use */
382        unsigned long driver_info;      /* for internal use */
383        void *driver_ivar;
384        struct usb_device *device;      /* current device */
385        struct usb_interface *iface;    /* current interface */
386        enum usb_hc_mode usb_mode;      /* host or device mode */
387        uint8_t port;
388        uint8_t dev_state;
389#define UAA_DEV_READY           0
390#define UAA_DEV_DISABLED        1
391#define UAA_DEV_EJECTING        2
392};
393
394/*
395 * The following is a wrapper for the callout structure to ease
396 * porting the code to other platforms.
397 */
398struct usb_callout {
399        struct callout co;
400};
401#define usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f)
402#define usb_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d)
403#define usb_callout_stop(c) callout_stop(&(c)->co)
404#define usb_callout_drain(c) callout_drain(&(c)->co)
405#define usb_callout_pending(c) callout_pending(&(c)->co)
406
407/* USB transfer states */
408
409#define USB_ST_SETUP       0
410#define USB_ST_TRANSFERRED 1
411#define USB_ST_ERROR       2
412
413/* USB handle request states */
414#define USB_HR_NOT_COMPLETE     0
415#define USB_HR_COMPLETE_OK      1
416#define USB_HR_COMPLETE_ERR     2
417
418/*
419 * The following macro will return the current state of an USB
420 * transfer like defined by the "USB_ST_XXX" enums.
421 */
422#define USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
423
424/*
425 * The following structure defines the USB process message header.
426 */
427struct usb_proc_msg {
428        TAILQ_ENTRY(usb_proc_msg) pm_qentry;
429        usb_proc_callback_t *pm_callback;
430        usb_size_t pm_num;
431};
432
433#define USB_FIFO_TX 0
434#define USB_FIFO_RX 1
435
436/*
437 * Locking note for the following functions.  All the
438 * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
439 * locked. The others are called unlocked.
440 */
441struct usb_fifo_methods {
442        usb_fifo_open_t *f_open;
443        usb_fifo_close_t *f_close;
444        usb_fifo_ioctl_t *f_ioctl;
445        /*
446         * NOTE: The post-ioctl callback is called after the USB reference
447         * gets locked in the IOCTL handler:
448         */
449        usb_fifo_ioctl_t *f_ioctl_post;
450        usb_fifo_cmd_t *f_start_read;
451        usb_fifo_cmd_t *f_stop_read;
452        usb_fifo_cmd_t *f_start_write;
453        usb_fifo_cmd_t *f_stop_write;
454        usb_fifo_filter_t *f_filter_read;
455        usb_fifo_filter_t *f_filter_write;
456        const char *basename[4];
457        const char *postfix[4];
458};
459
460struct usb_fifo_sc {
461        struct usb_fifo *fp[2];
462        struct usb_fs_privdata *dev;
463};
464
465const char *usbd_errstr(usb_error_t error);
466void    *usbd_find_descriptor(struct usb_device *udev, void *id,
467            uint8_t iface_index, uint8_t type, uint8_t type_mask,
468            uint8_t subtype, uint8_t subtype_mask);
469struct usb_config_descriptor *usbd_get_config_descriptor(
470            struct usb_device *udev);
471struct usb_device_descriptor *usbd_get_device_descriptor(
472            struct usb_device *udev);
473struct usb_interface *usbd_get_iface(struct usb_device *udev,
474            uint8_t iface_index);
475struct usb_interface_descriptor *usbd_get_interface_descriptor(
476            struct usb_interface *iface);
477struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
478                    const struct usb_config *setup);
479struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
480usb_error_t     usbd_interface_count(struct usb_device *udev, uint8_t *count);
481enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
482enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
483void    device_set_usb_desc(device_t dev);
484void    usb_pause_mtx(struct mtx *mtx, int _ticks);
485usb_error_t     usbd_set_pnpinfo(struct usb_device *udev,
486                        uint8_t iface_index, const char *pnpinfo);
487usb_error_t     usbd_add_dynamic_quirk(struct usb_device *udev,
488                        uint16_t quirk);
489
490const struct usb_device_id *usbd_lookup_id_by_info(
491            const struct usb_device_id *id, usb_size_t sizeof_id,
492            const struct usbd_lookup_info *info);
493int     usbd_lookup_id_by_uaa(const struct usb_device_id *id,
494            usb_size_t sizeof_id, struct usb_attach_arg *uaa);
495
496usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
497                    struct usb_device_request *req, void *data, uint16_t flags,
498                    uint16_t *actlen, usb_timeout_t timeout);
499#define usbd_do_request(u,m,r,d) \
500  usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
501
502uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1,
503            struct usb_xfer *xfer2);
504uint8_t usbd_get_interface_altindex(struct usb_interface *iface);
505usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
506            uint8_t iface_index, uint8_t alt_index);
507uint32_t usbd_get_isoc_fps(struct usb_device *udev);
508usb_error_t usbd_transfer_setup(struct usb_device *udev,
509            const uint8_t *ifaces, struct usb_xfer **pxfer,
510            const struct usb_config *setup_start, uint16_t n_setup,
511            void *priv_sc, struct mtx *priv_mtx);
512void    usbd_transfer_submit(struct usb_xfer *xfer);
513void    usbd_transfer_clear_stall(struct usb_xfer *xfer);
514void    usbd_transfer_drain(struct usb_xfer *xfer);
515uint8_t usbd_transfer_pending(struct usb_xfer *xfer);
516void    usbd_transfer_start(struct usb_xfer *xfer);
517void    usbd_transfer_stop(struct usb_xfer *xfer);
518void    usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
519void    usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
520void    usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
521            uint8_t parent_index);
522uint8_t usbd_get_bus_index(struct usb_device *udev);
523uint8_t usbd_get_device_index(struct usb_device *udev);
524void    usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
525uint8_t usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode);
526uint8_t usbd_device_attached(struct usb_device *udev);
527
528usb_frlength_t
529        usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex);
530void    usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
531            int *aframes, int *nframes);
532struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *xfer,
533            usb_frcount_t frindex);
534void    *usbd_xfer_get_frame_buffer(struct usb_xfer *, usb_frcount_t);
535void    *usbd_xfer_softc(struct usb_xfer *xfer);
536void    *usbd_xfer_get_priv(struct usb_xfer *xfer);
537void    usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
538void    usbd_xfer_set_interval(struct usb_xfer *xfer, int);
539uint8_t usbd_xfer_state(struct usb_xfer *xfer);
540void    usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
541            void *ptr, usb_frlength_t len);
542void    usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
543            void **ptr, int *len);
544void    usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
545            usb_frcount_t frindex);
546usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
547usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
548usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
549uint8_t usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
550usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
551            usb_frcount_t frindex);
552void    usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
553            usb_frlength_t len);
554void    usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
555void    usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
556void    usbd_xfer_set_stall(struct usb_xfer *xfer);
557int     usbd_xfer_is_stalled(struct usb_xfer *xfer);
558void    usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
559void    usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
560uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
561uint8_t usbd_xfer_maxp_was_clamped(struct usb_xfer *xfer);
562
563void    usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
564            const void *ptr, usb_frlength_t len);
565int     usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
566            const void *ptr, usb_frlength_t len);
567void    usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
568            void *ptr, usb_frlength_t len);
569int     usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
570            void *ptr, usb_frlength_t len);
571void    usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
572            struct usb_page_search *res);
573void    usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
574            struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
575void    usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
576            usb_frlength_t len);
577void    usbd_start_re_enumerate(struct usb_device *udev);
578usb_error_t
579        usbd_start_set_config(struct usb_device *, uint8_t);
580
581int     usb_fifo_attach(struct usb_device *udev, void *priv_sc,
582            struct mtx *priv_mtx, struct usb_fifo_methods *pm,
583            struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
584            uint8_t iface_index, uid_t uid, gid_t gid, int mode);
585void    usb_fifo_detach(struct usb_fifo_sc *f_sc);
586int     usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
587            uint16_t nbuf);
588void    usb_fifo_free_buffer(struct usb_fifo *f);
589uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
590void    usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
591            usb_frlength_t offset, usb_frlength_t len, uint8_t what);
592void    usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
593            usb_size_t len, uint8_t what);
594uint8_t usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
595void    usb_fifo_put_data_error(struct usb_fifo *fifo);
596uint8_t usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
597            usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
598            uint8_t what);
599uint8_t usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
600            usb_size_t len, usb_size_t *actlen, uint8_t what);
601uint8_t usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
602            usb_size_t *plen);
603void    usb_fifo_reset(struct usb_fifo *f);
604void    usb_fifo_wakeup(struct usb_fifo *f);
605void    usb_fifo_get_data_error(struct usb_fifo *fifo);
606void    *usb_fifo_softc(struct usb_fifo *fifo);
607void    usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
608void    usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
609void    usb_fifo_free(struct usb_fifo *f);
610#endif /* _KERNEL */
611#endif /* _USB_USBDI_H_ */
Note: See TracBrowser for help on using the repository browser.