1 /* 2 * ng_ubt_var.h 3 */ 4 5 /*- 6 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 7 * 8 * Copyright (c) 2001-2009 Maksim Yevmenkin <m_evmenkin@yahoo.com> 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $Id: ng_ubt_var.h,v 1.2 2003/03/22 23:44:36 max Exp $ 33 * $FreeBSD$ 34 */ 35 36 #ifndef _NG_UBT_VAR_H_ 37 #define _NG_UBT_VAR_H_ 1 38 39 /* Debug printf's */ 40 #define UBT_DEBUG(level, sc, fmt, ...) \ 41 do { \ 42 if ((sc)->sc_debug >= (level)) \ 43 device_printf((sc)->sc_dev, "%s:%d: " fmt, \ 44 __FUNCTION__, __LINE__,## __VA_ARGS__); \ 45 } while (0) 46 47 #define UBT_ALERT(...) UBT_DEBUG(NG_UBT_ALERT_LEVEL, __VA_ARGS__) 48 #define UBT_ERR(...) UBT_DEBUG(NG_UBT_ERR_LEVEL, __VA_ARGS__) 49 #define UBT_WARN(...) UBT_DEBUG(NG_UBT_WARN_LEVEL, __VA_ARGS__) 50 #define UBT_INFO(...) UBT_DEBUG(NG_UBT_INFO_LEVEL, __VA_ARGS__) 51 52 #define UBT_NG_LOCK(sc) mtx_lock(&(sc)->sc_ng_mtx) 53 #define UBT_NG_UNLOCK(sc) mtx_unlock(&(sc)->sc_ng_mtx) 54 55 /* Bluetooth USB control request type */ 56 #define UBT_HCI_REQUEST 0x20 57 #define UBT_DEFAULT_QLEN 64 58 #define UBT_ISOC_NFRAMES 32 /* should be factor of 8 */ 59 60 /* Bluetooth USB defines */ 61 enum { 62 /* Interface #0 transfers */ 63 UBT_IF_0_BULK_DT_WR = 0, 64 UBT_IF_0_BULK_DT_RD, 65 UBT_IF_0_INTR_DT_RD, 66 UBT_IF_0_CTRL_DT_WR, 67 68 /* Interface #1 transfers */ 69 UBT_IF_1_ISOC_DT_RD1, 70 UBT_IF_1_ISOC_DT_RD2, 71 UBT_IF_1_ISOC_DT_WR1, 72 UBT_IF_1_ISOC_DT_WR2, 73 74 UBT_N_TRANSFER, /* total number of transfers */ 75 }; 76 77 /* USB control request (HCI command) structure */ 78 struct ubt_hci_cmd { 79 uint16_t opcode; 80 uint8_t length; 81 uint8_t data[]; 82 } __attribute__ ((packed)); 83 #define UBT_HCI_CMD_SIZE(cmd) \ 84 ((cmd)->length + offsetof(struct ubt_hci_cmd, data)) 85 86 /* USB interrupt transfer HCI event header structure */ 87 struct ubt_hci_evhdr { 88 uint8_t event; 89 uint8_t length; 90 } __attribute__ ((packed)); 91 /* USB interrupt transfer (generic HCI event) structure */ 92 struct ubt_hci_event { 93 struct ubt_hci_evhdr header; 94 uint8_t data[]; 95 } __attribute__ ((packed)); 96 /* USB interrupt transfer (HCI command completion event) structure */ 97 struct ubt_hci_event_command_compl { 98 struct ubt_hci_evhdr header; 99 uint8_t numpkt; 100 uint16_t opcode; 101 uint8_t data[]; 102 } __attribute__ ((packed)); 103 #define UBT_HCI_EVENT_SIZE(evt) \ 104 ((evt)->header.length + offsetof(struct ubt_hci_event, data)) 105 106 /* USB device softc structure */ 107 struct ubt_softc { 108 device_t sc_dev; /* for debug printf */ 109 110 /* State */ 111 ng_ubt_node_debug_ep sc_debug; /* debug level */ 112 113 ng_ubt_node_stat_ep sc_stat; /* statistic */ 114 #define UBT_STAT_PCKTS_SENT(sc) (sc)->sc_stat.pckts_sent ++ 115 #define UBT_STAT_BYTES_SENT(sc, n) (sc)->sc_stat.bytes_sent += (n) 116 #define UBT_STAT_PCKTS_RECV(sc) (sc)->sc_stat.pckts_recv ++ 117 #define UBT_STAT_BYTES_RECV(sc, n) (sc)->sc_stat.bytes_recv += (n) 118 #define UBT_STAT_OERROR(sc) (sc)->sc_stat.oerrors ++ 119 #define UBT_STAT_IERROR(sc) (sc)->sc_stat.ierrors ++ 120 #define UBT_STAT_RESET(sc) bzero(&(sc)->sc_stat, sizeof((sc)->sc_stat)) 121 122 /* USB device specific */ 123 struct mtx sc_if_mtx; /* interfaces lock */ 124 struct usb_xfer *sc_xfer[UBT_N_TRANSFER]; 125 126 struct mtx sc_ng_mtx; /* lock for shared NG data */ 127 128 /* HCI commands */ 129 struct ng_bt_mbufq sc_cmdq; /* HCI command queue */ 130 #define UBT_CTRL_BUFFER_SIZE (sizeof(struct usb_device_request) + \ 131 sizeof(ng_hci_cmd_pkt_t) + NG_HCI_CMD_PKT_SIZE) 132 #define UBT_INTR_BUFFER_SIZE (MCLBYTES-1) /* reserve 1 byte for ID-tag */ 133 134 /* ACL data */ 135 struct ng_bt_mbufq sc_aclq; /* ACL data queue */ 136 #define UBT_BULK_READ_BUFFER_SIZE (MCLBYTES-1) /* reserve 1 byte for ID-tag */ 137 #define UBT_BULK_WRITE_BUFFER_SIZE (MCLBYTES) 138 139 /* SCO data */ 140 struct ng_bt_mbufq sc_scoq; /* SCO data queue */ 141 struct mbuf *sc_isoc_in_buffer; /* SCO reassembly buffer */ 142 143 /* Netgraph specific */ 144 node_p sc_node; /* pointer back to node */ 145 hook_p sc_hook; /* upstream hook */ 146 147 /* Glue */ 148 int sc_task_flags; /* task flags */ 149 #define UBT_FLAG_T_PENDING (1 << 0) /* task pending */ 150 #define UBT_FLAG_T_STOP_ALL (1 << 1) /* stop all xfers */ 151 #define UBT_FLAG_T_START_ALL (1 << 2) /* start all read and isoc 152 write xfers */ 153 #define UBT_FLAG_T_START_CTRL (1 << 3) /* start control xfer (write) */ 154 #define UBT_FLAG_T_START_BULK (1 << 4) /* start bulk xfer (write) */ 155 156 struct task sc_task; 157 }; 158 typedef struct ubt_softc ubt_softc_t; 159 typedef struct ubt_softc * ubt_softc_p; 160 161 usb_error_t ubt_do_hci_request(struct usb_device *, struct ubt_hci_cmd *, 162 void *, usb_timeout_t); 163 164 extern devclass_t ubt_devclass; 165 extern driver_t ubt_driver; 166 167 #endif /* ndef _NG_UBT_VAR_H_ */ 168 169