lib/libusb/libusb10.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #ifndef __LIBUSB10_H__
  28 #define __LIBUSB10_H__
  29
  30 #include <sys/queue.h>
  31
  32 #define GET_CONTEXT(ctx) (((ctx) == NULL) ? usbi_default_context : (ctx))
  33 #define UNEXPORTED __attribute__((__visibility__("hidden")))
  34 #define CTX_LOCK(ctx) pthread_mutex_lock(&(ctx)->ctx_lock)
  35 #define CTX_TRYLOCK(ctx) pthread_mutex_trylock(&(ctx)->ctx_lock)
  36 #define CTX_UNLOCK(ctx) pthread_mutex_unlock(&(ctx)->ctx_lock)
  37 #define HOTPLUG_LOCK(ctx) pthread_mutex_lock(&(ctx)->hotplug_lock)
  38 #define HOTPLUG_UNLOCK(ctx) pthread_mutex_unlock(&(ctx)->hotplug_lock)
  39
  40 #define DPRINTF(ctx, dbg, format, args...) do { \
  41     if ((ctx)->debug == dbg) {                  \
  42         switch (dbg) {                          \
  43         case LIBUSB_DEBUG_FUNCTION:             \
  44                 printf("LIBUSB_FUNCTION: "      \
  45                     format "\n", ## args);      \
  46                 break;                          \
  47         case LIBUSB_DEBUG_TRANSFER:             \
  48                 printf("LIBUSB_TRANSFER: "      \
  49                     format "\n", ## args);      \
  50                 break;                          \
  51         default:                                \
  52                 break;                          \
  53         }                                       \
  54     }                                           \
  55 } while(0)
  56
  57 /* internal structures */
  58
  59 struct libusb_super_pollfd {
  60         TAILQ_ENTRY(libusb_super_pollfd) entry;
  61         struct libusb20_device *pdev;
  62         struct libusb_pollfd pollfd;
  63 };
  64
  65 struct libusb_super_transfer {
  66         TAILQ_ENTRY(libusb_super_transfer) entry;
  67         uint8_t *curr_data;
  68         uint32_t rem_len;
  69         uint32_t last_len;
  70         uint32_t stream_id;
  71         uint8_t state;
  72 #define LIBUSB_SUPER_XFER_ST_NONE 0
  73 #define LIBUSB_SUPER_XFER_ST_PEND 1
  74 };
  75
  76 struct libusb_hotplug_callback_handle_struct {
  77         TAILQ_ENTRY(libusb_hotplug_callback_handle_struct) entry;
  78         int events;
  79         int vendor;
  80         int product;
  81         int devclass;
  82         libusb_hotplug_callback_fn fn;
  83         void *user_data;
  84 };
  85
  86 struct libusb_context {
  87         int     debug;
  88         int     debug_fixed;
  89         int     ctrl_pipe[2];
  90         int     tr_done_ref;
  91         int     tr_done_gen;
  92
  93         pthread_mutex_t ctx_lock;
  94         pthread_mutex_t hotplug_lock;
  95         pthread_cond_t ctx_cond;
  96         pthread_t hotplug_handler;
  97         pthread_t ctx_handler;
  98 #define NO_THREAD ((pthread_t)-1)
  99
 100         TAILQ_HEAD(, libusb_super_pollfd) pollfds;
 101         TAILQ_HEAD(, libusb_super_transfer) tr_done;
 102         TAILQ_HEAD(, libusb_hotplug_callback_handle_struct) hotplug_cbh;
 103         TAILQ_HEAD(, libusb_device) hotplug_devs;
 104
 105         struct libusb_super_pollfd ctx_poll;
 106
 107         libusb_pollfd_added_cb fd_added_cb;
 108         libusb_pollfd_removed_cb fd_removed_cb;
 109         void   *fd_cb_user_data;
 110 };
 111
 112 struct libusb_device {
 113         int     refcnt;
 114
 115         int     device_is_gone;
 116
 117         uint32_t claimed_interfaces;
 118
 119         struct libusb_super_pollfd dev_poll;
 120
 121         struct libusb_context *ctx;
 122
 123         TAILQ_ENTRY(libusb_device) hotplug_entry;
 124
 125         TAILQ_HEAD(, libusb_super_transfer) tr_head;
 126
 127         struct libusb20_device *os_priv;
 128 };
 129
 130 extern struct libusb_context *usbi_default_context;
 131
 132 void    libusb10_add_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd, struct libusb20_device *pdev, int fd, short events);
 133 void    libusb10_remove_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd);
 134 void    libusb10_cancel_all_transfer(libusb_device *dev);
 135 void    libusb10_cancel_all_transfer_locked(struct libusb20_device *pdev, struct libusb_device *dev);
 136
 137 #endif                                  /* __LIBUSB10_H__ */