sys/netgraph/bluetooth/drivers/ubt/ng_ubt_var.h

   1 /*
   2  * ng_ubt_var.h
   3  */
   4
   5 /*-
   6  * Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $Id: ng_ubt_var.h,v 1.2 2003/03/22 23:44:36 max Exp $
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _NG_UBT_VAR_H_
  35 #define _NG_UBT_VAR_H_
  36
  37 /* pullup wrapper */
  38 #define NG_UBT_M_PULLUP(m, s) \
  39         do { \
  40                 if ((m)->m_len < (s)) \
  41                         (m) = m_pullup((m), (s)); \
  42                 if ((m) == NULL) \
  43                         NG_UBT_ALERT("%s: %s - m_pullup(%d) failed\n", \
  44                                 __func__, device_get_nameunit(sc->sc_dev), (s)); \
  45         } while (0)
  46
  47 /* Debug printf's */
  48 #define NG_UBT_ALERT    if (sc->sc_debug >= NG_UBT_ALERT_LEVEL) printf
  49 #define NG_UBT_ERR      if (sc->sc_debug >= NG_UBT_ERR_LEVEL)   printf
  50 #define NG_UBT_WARN     if (sc->sc_debug >= NG_UBT_WARN_LEVEL)  printf
  51 #define NG_UBT_INFO     if (sc->sc_debug >= NG_UBT_INFO_LEVEL)  printf
  52
  53 /* Bluetooth USB control request type */
  54 #define UBT_HCI_REQUEST         0x20
  55 #define UBT_DEFAULT_QLEN        12
  56
  57 /* USB device softc structure */
  58 struct ubt_softc {
  59         /* State */
  60         ng_ubt_node_debug_ep     sc_debug;      /* debug level */
  61         u_int32_t                sc_flags;      /* device flags */
  62 #define UBT_NEED_FRAME_TYPE     (1 << 0)        /* device required frame type */
  63 #define UBT_HAVE_FRAME_TYPE UBT_NEED_FRAME_TYPE
  64 #define UBT_CMD_XMIT            (1 << 1)        /* CMD xmit in progress */
  65 #define UBT_ACL_XMIT            (1 << 2)        /* ACL xmit in progress */
  66 #define UBT_SCO_XMIT            (1 << 3)        /* SCO xmit in progress */
  67 #define UBT_EVT_RECV            (1 << 4)        /* EVN recv in progress */
  68 #define UBT_ACL_RECV            (1 << 5)        /* ACL recv in progress */
  69 #define UBT_SCO_RECV            (1 << 6)        /* SCO recv in progress */
  70 #define UBT_CTRL_DEV            (1 << 7)        /* ctrl device is open */
  71 #define UBT_INTR_DEV            (1 << 8)        /* intr device is open */
  72 #define UBT_BULK_DEV            (1 << 9)        /* bulk device is open */
  73 #define UBT_ANY_DEV             (UBT_CTRL_DEV|UBT_INTR_DEV|UBT_BULK_DEV)
  74
  75         ng_ubt_node_stat_ep      sc_stat;       /* statistic */
  76 #define NG_UBT_STAT_PCKTS_SENT(s)       (s).pckts_sent ++
  77 #define NG_UBT_STAT_BYTES_SENT(s, n)    (s).bytes_sent += (n)
  78 #define NG_UBT_STAT_PCKTS_RECV(s)       (s).pckts_recv ++
  79 #define NG_UBT_STAT_BYTES_RECV(s, n)    (s).bytes_recv += (n)
  80 #define NG_UBT_STAT_OERROR(s)           (s).oerrors ++
  81 #define NG_UBT_STAT_IERROR(s)           (s).ierrors ++
  82 #define NG_UBT_STAT_RESET(s)            bzero(&(s), sizeof((s)))
  83
  84         /* USB device specific */
  85         device_t                 sc_dev;        /* pointer back to USB device */
  86         usbd_device_handle       sc_udev;       /* USB device handle */
  87
  88         usbd_interface_handle    sc_iface0;     /* USB interface 0 */
  89         usbd_interface_handle    sc_iface1;     /* USB interface 1 */
  90
  91         /* Interrupt pipe (HCI events) */
  92         int                      sc_intr_ep;    /* interrupt endpoint */
  93         usbd_pipe_handle         sc_intr_pipe;  /* interrupt pipe handle */
  94         usbd_xfer_handle         sc_intr_xfer;  /* intr xfer */
  95         struct mbuf             *sc_intr_buffer; /* interrupt buffer */
  96
  97         /* Control pipe (HCI commands) */
  98         usbd_xfer_handle         sc_ctrl_xfer;  /* control xfer handle */
  99         void                    *sc_ctrl_buffer; /* control buffer */
 100         struct ng_bt_mbufq       sc_cmdq;       /* HCI command queue */
 101 #define UBT_CTRL_BUFFER_SIZE \
 102                 (sizeof(ng_hci_cmd_pkt_t) + NG_HCI_CMD_PKT_SIZE)
 103
 104         /* Bulk in pipe (ACL data) */
 105         int                      sc_bulk_in_ep; /* bulk-in enpoint */
 106         usbd_pipe_handle         sc_bulk_in_pipe; /* bulk-in pipe */
 107         usbd_xfer_handle         sc_bulk_in_xfer; /* bulk-in xfer */
 108         struct mbuf             *sc_bulk_in_buffer; /* bulk-in buffer */
 109
 110         /* Bulk out pipe (ACL data) */
 111         int                      sc_bulk_out_ep; /* bulk-out endpoint */
 112         usbd_pipe_handle         sc_bulk_out_pipe; /* bulk-out pipe */
 113         usbd_xfer_handle         sc_bulk_out_xfer; /* bulk-out xfer */
 114         void                    *sc_bulk_out_buffer; /* bulk-out buffer */
 115         struct ng_bt_mbufq       sc_aclq;       /* ACL data queue */
 116 #define UBT_BULK_BUFFER_SIZE \
 117                 MCLBYTES /* XXX should be big enough to hold one frame */
 118
 119         /* Isoc. in pipe (SCO data) */
 120         int                      sc_isoc_in_ep; /* isoc-in endpoint */
 121         usbd_pipe_handle         sc_isoc_in_pipe; /* isoc-in pipe */
 122         usbd_xfer_handle         sc_isoc_in_xfer; /* isoc-in xfer */
 123         void                    *sc_isoc_in_buffer; /* isoc-in buffer */
 124         u_int16_t               *sc_isoc_in_frlen; /* isoc-in. frame length */
 125
 126         /* Isoc. out pipe (ACL data) */
 127         int                      sc_isoc_out_ep; /* isoc-out endpoint */
 128         usbd_pipe_handle         sc_isoc_out_pipe; /* isoc-out pipe */
 129         usbd_xfer_handle         sc_isoc_out_xfer; /* isoc-out xfer */
 130         void                    *sc_isoc_out_buffer; /* isoc-in buffer */
 131         u_int16_t               *sc_isoc_out_frlen; /* isoc-out. frame length */
 132         struct ng_bt_mbufq       sc_scoq;       /* SCO data queue */
 133
 134         int                      sc_isoc_size; /* max. size of isoc. packet */
 135         u_int32_t                sc_isoc_nframes; /* num. isoc. frames */
 136 #define UBT_ISOC_BUFFER_SIZE \
 137                 (sizeof(ng_hci_scodata_pkt_t) + NG_HCI_SCO_PKT_SIZE)
 138
 139         /* Netgraph specific */
 140         node_p                   sc_node;       /* pointer back to node */
 141         hook_p                   sc_hook;       /* upstream hook */
 142 };
 143 typedef struct ubt_softc        ubt_softc_t;
 144 typedef struct ubt_softc *      ubt_softc_p;
 145
 146 #endif /* ndef _NG_UBT_VAR_H_ */
 147