1 /*
2 * ubtbcmfw.c
3 */
4
5 /*-
6 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
7 *
8 * Copyright (c) 2003-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: ubtbcmfw.c,v 1.3 2003/10/10 19:15:08 max Exp $
33 * $FreeBSD: stable/12/sys/netgraph/bluetooth/drivers/ubtbcmfw/ubtbcmfw.c 326272 2017-11-27 15:23:17Z pfg $
34 */
35
36 #include <sys/stdint.h>
37 #include <sys/stddef.h>
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/types.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/bus.h>
44 #include <sys/module.h>
45 #include <sys/lock.h>
46 #include <sys/mutex.h>
47 #include <sys/condvar.h>
48 #include <sys/sysctl.h>
49 #include <sys/sx.h>
50 #include <sys/unistd.h>
51 #include <sys/callout.h>
52 #include <sys/malloc.h>
53 #include <sys/priv.h>
54 #include <sys/conf.h>
55 #include <sys/fcntl.h>
56
57 #include "usbdevs.h"
58 #include <dev/usb/usb.h>
59 #include <dev/usb/usbdi.h>
60 #include <dev/usb/usb_ioctl.h>
61
62 #define USB_DEBUG_VAR usb_debug
63 #include <dev/usb/usb_debug.h>
64 #include <dev/usb/usb_dev.h>
65
66 /*
67 * Download firmware to BCM2033.
68 */
69
70 #define UBTBCMFW_CONFIG_NO 1 /* Config number */
71 #define UBTBCMFW_IFACE_IDX 0 /* Control interface */
72
73 #define UBTBCMFW_BSIZE 1024
74 #define UBTBCMFW_IFQ_MAXLEN 2
75
76 enum {
77 UBTBCMFW_BULK_DT_WR = 0,
78 UBTBCMFW_INTR_DT_RD,
79 UBTBCMFW_N_TRANSFER,
80 };
81
82 struct ubtbcmfw_softc {
83 struct usb_device *sc_udev;
84 struct mtx sc_mtx;
85 struct usb_xfer *sc_xfer[UBTBCMFW_N_TRANSFER];
86 struct usb_fifo_sc sc_fifo;
87 };
88
89 /*
90 * Prototypes
91 */
92
93 static device_probe_t ubtbcmfw_probe;
94 static device_attach_t ubtbcmfw_attach;
95 static device_detach_t ubtbcmfw_detach;
96
97 static usb_callback_t ubtbcmfw_write_callback;
98 static usb_callback_t ubtbcmfw_read_callback;
99
100 static usb_fifo_close_t ubtbcmfw_close;
101 static usb_fifo_cmd_t ubtbcmfw_start_read;
102 static usb_fifo_cmd_t ubtbcmfw_start_write;
103 static usb_fifo_cmd_t ubtbcmfw_stop_read;
104 static usb_fifo_cmd_t ubtbcmfw_stop_write;
105 static usb_fifo_ioctl_t ubtbcmfw_ioctl;
106 static usb_fifo_open_t ubtbcmfw_open;
107
108 static struct usb_fifo_methods ubtbcmfw_fifo_methods =
109 {
110 .f_close = &ubtbcmfw_close,
111 .f_ioctl = &ubtbcmfw_ioctl,
112 .f_open = &ubtbcmfw_open,
113 .f_start_read = &ubtbcmfw_start_read,
114 .f_start_write = &ubtbcmfw_start_write,
115 .f_stop_read = &ubtbcmfw_stop_read,
116 .f_stop_write = &ubtbcmfw_stop_write,
117 .basename[0] = "ubtbcmfw",
118 .basename[1] = "ubtbcmfw",
119 .basename[2] = "ubtbcmfw",
120 .postfix[0] = "",
121 .postfix[1] = ".1",
122 .postfix[2] = ".2",
123 };
124
125 /*
126 * Device's config structure
127 */
128
129 static const struct usb_config ubtbcmfw_config[UBTBCMFW_N_TRANSFER] =
130 {
131 [UBTBCMFW_BULK_DT_WR] = {
132 .type = UE_BULK,
133 .endpoint = 0x02, /* fixed */
134 .direction = UE_DIR_OUT,
135 .if_index = UBTBCMFW_IFACE_IDX,
136 .bufsize = UBTBCMFW_BSIZE,
137 .flags = { .pipe_bof = 1, .force_short_xfer = 1,
138 .proxy_buffer = 1, },
139 .callback = &ubtbcmfw_write_callback,
140 },
141
142 [UBTBCMFW_INTR_DT_RD] = {
143 .type = UE_INTERRUPT,
144 .endpoint = 0x01, /* fixed */
145 .direction = UE_DIR_IN,
146 .if_index = UBTBCMFW_IFACE_IDX,
147 .bufsize = UBTBCMFW_BSIZE,
148 .flags = { .pipe_bof = 1, .short_xfer_ok = 1,
149 .proxy_buffer = 1, },
150 .callback = &ubtbcmfw_read_callback,
151 },
152 };
153
154 /*
155 * Module
156 */
157
158 static devclass_t ubtbcmfw_devclass;
159
160 static device_method_t ubtbcmfw_methods[] =
161 {
162 DEVMETHOD(device_probe, ubtbcmfw_probe),
163 DEVMETHOD(device_attach, ubtbcmfw_attach),
164 DEVMETHOD(device_detach, ubtbcmfw_detach),
165 {0, 0}
166 };
167
168 static driver_t ubtbcmfw_driver =
169 {
170 .name = "ubtbcmfw",
171 .methods = ubtbcmfw_methods,
172 .size = sizeof(struct ubtbcmfw_softc),
173 };
174
175 static const STRUCT_USB_HOST_ID ubtbcmfw_devs[] = {
176 /* Broadcom BCM2033 devices only */
177 { USB_VPI(USB_VENDOR_BROADCOM, USB_PRODUCT_BROADCOM_BCM2033, 0) },
178 };
179
180
181 DRIVER_MODULE(ubtbcmfw, uhub, ubtbcmfw_driver, ubtbcmfw_devclass, NULL, 0);
182 MODULE_DEPEND(ubtbcmfw, usb, 1, 1, 1);
183 USB_PNP_HOST_INFO(ubtbcmfw_devs);
184
185 /*
186 * Probe for a USB Bluetooth device
187 */
188
189 static int
ubtbcmfw_probe(device_t dev)190 ubtbcmfw_probe(device_t dev)
191 {
192 struct usb_attach_arg *uaa = device_get_ivars(dev);
193
194 if (uaa->usb_mode != USB_MODE_HOST)
195 return (ENXIO);
196
197 if (uaa->info.bIfaceIndex != 0)
198 return (ENXIO);
199
200 return (usbd_lookup_id_by_uaa(ubtbcmfw_devs, sizeof(ubtbcmfw_devs), uaa));
201 } /* ubtbcmfw_probe */
202
203 /*
204 * Attach the device
205 */
206
207 static int
ubtbcmfw_attach(device_t dev)208 ubtbcmfw_attach(device_t dev)
209 {
210 struct usb_attach_arg *uaa = device_get_ivars(dev);
211 struct ubtbcmfw_softc *sc = device_get_softc(dev);
212 uint8_t iface_index;
213 int error;
214
215 sc->sc_udev = uaa->device;
216
217 device_set_usb_desc(dev);
218
219 mtx_init(&sc->sc_mtx, "ubtbcmfw lock", NULL, MTX_DEF | MTX_RECURSE);
220
221 iface_index = UBTBCMFW_IFACE_IDX;
222 error = usbd_transfer_setup(uaa->device, &iface_index, sc->sc_xfer,
223 ubtbcmfw_config, UBTBCMFW_N_TRANSFER,
224 sc, &sc->sc_mtx);
225 if (error != 0) {
226 device_printf(dev, "allocating USB transfers failed. %s\n",
227 usbd_errstr(error));
228 goto detach;
229 }
230
231 error = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx,
232 &ubtbcmfw_fifo_methods, &sc->sc_fifo,
233 device_get_unit(dev), 0 - 1, uaa->info.bIfaceIndex,
234 UID_ROOT, GID_OPERATOR, 0644);
235 if (error != 0) {
236 device_printf(dev, "could not attach fifo. %s\n",
237 usbd_errstr(error));
238 goto detach;
239 }
240
241 return (0); /* success */
242
243 detach:
244 ubtbcmfw_detach(dev);
245
246 return (ENXIO); /* failure */
247 } /* ubtbcmfw_attach */
248
249 /*
250 * Detach the device
251 */
252
253 static int
ubtbcmfw_detach(device_t dev)254 ubtbcmfw_detach(device_t dev)
255 {
256 struct ubtbcmfw_softc *sc = device_get_softc(dev);
257
258 usb_fifo_detach(&sc->sc_fifo);
259
260 usbd_transfer_unsetup(sc->sc_xfer, UBTBCMFW_N_TRANSFER);
261
262 mtx_destroy(&sc->sc_mtx);
263
264 return (0);
265 } /* ubtbcmfw_detach */
266
267 /*
268 * USB write callback
269 */
270
271 static void
ubtbcmfw_write_callback(struct usb_xfer * xfer,usb_error_t error)272 ubtbcmfw_write_callback(struct usb_xfer *xfer, usb_error_t error)
273 {
274 struct ubtbcmfw_softc *sc = usbd_xfer_softc(xfer);
275 struct usb_fifo *f = sc->sc_fifo.fp[USB_FIFO_TX];
276 struct usb_page_cache *pc;
277 uint32_t actlen;
278
279 switch (USB_GET_STATE(xfer)) {
280 case USB_ST_SETUP:
281 case USB_ST_TRANSFERRED:
282 setup_next:
283 pc = usbd_xfer_get_frame(xfer, 0);
284 if (usb_fifo_get_data(f, pc, 0, usbd_xfer_max_len(xfer),
285 &actlen, 0)) {
286 usbd_xfer_set_frame_len(xfer, 0, actlen);
287 usbd_transfer_submit(xfer);
288 }
289 break;
290
291 default: /* Error */
292 if (error != USB_ERR_CANCELLED) {
293 /* try to clear stall first */
294 usbd_xfer_set_stall(xfer);
295 goto setup_next;
296 }
297 break;
298 }
299 } /* ubtbcmfw_write_callback */
300
301 /*
302 * USB read callback
303 */
304
305 static void
ubtbcmfw_read_callback(struct usb_xfer * xfer,usb_error_t error)306 ubtbcmfw_read_callback(struct usb_xfer *xfer, usb_error_t error)
307 {
308 struct ubtbcmfw_softc *sc = usbd_xfer_softc(xfer);
309 struct usb_fifo *fifo = sc->sc_fifo.fp[USB_FIFO_RX];
310 struct usb_page_cache *pc;
311 int actlen;
312
313 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
314
315 switch (USB_GET_STATE(xfer)) {
316 case USB_ST_TRANSFERRED:
317 pc = usbd_xfer_get_frame(xfer, 0);
318 usb_fifo_put_data(fifo, pc, 0, actlen, 1);
319 /* FALLTHROUGH */
320
321 case USB_ST_SETUP:
322 setup_next:
323 if (usb_fifo_put_bytes_max(fifo) > 0) {
324 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
325 usbd_transfer_submit(xfer);
326 }
327 break;
328
329 default: /* Error */
330 if (error != USB_ERR_CANCELLED) {
331 /* try to clear stall first */
332 usbd_xfer_set_stall(xfer);
333 goto setup_next;
334 }
335 break;
336 }
337 } /* ubtbcmfw_read_callback */
338
339 /*
340 * Called when we about to start read()ing from the device
341 */
342
343 static void
ubtbcmfw_start_read(struct usb_fifo * fifo)344 ubtbcmfw_start_read(struct usb_fifo *fifo)
345 {
346 struct ubtbcmfw_softc *sc = usb_fifo_softc(fifo);
347
348 usbd_transfer_start(sc->sc_xfer[UBTBCMFW_INTR_DT_RD]);
349 } /* ubtbcmfw_start_read */
350
351 /*
352 * Called when we about to stop reading (i.e. closing fifo)
353 */
354
355 static void
ubtbcmfw_stop_read(struct usb_fifo * fifo)356 ubtbcmfw_stop_read(struct usb_fifo *fifo)
357 {
358 struct ubtbcmfw_softc *sc = usb_fifo_softc(fifo);
359
360 usbd_transfer_stop(sc->sc_xfer[UBTBCMFW_INTR_DT_RD]);
361 } /* ubtbcmfw_stop_read */
362
363 /*
364 * Called when we about to start write()ing to the device, poll()ing
365 * for write or flushing fifo
366 */
367
368 static void
ubtbcmfw_start_write(struct usb_fifo * fifo)369 ubtbcmfw_start_write(struct usb_fifo *fifo)
370 {
371 struct ubtbcmfw_softc *sc = usb_fifo_softc(fifo);
372
373 usbd_transfer_start(sc->sc_xfer[UBTBCMFW_BULK_DT_WR]);
374 } /* ubtbcmfw_start_write */
375
376 /*
377 * Called when we about to stop writing (i.e. closing fifo)
378 */
379
380 static void
ubtbcmfw_stop_write(struct usb_fifo * fifo)381 ubtbcmfw_stop_write(struct usb_fifo *fifo)
382 {
383 struct ubtbcmfw_softc *sc = usb_fifo_softc(fifo);
384
385 usbd_transfer_stop(sc->sc_xfer[UBTBCMFW_BULK_DT_WR]);
386 } /* ubtbcmfw_stop_write */
387
388 /*
389 * Called when fifo is open
390 */
391
392 static int
ubtbcmfw_open(struct usb_fifo * fifo,int fflags)393 ubtbcmfw_open(struct usb_fifo *fifo, int fflags)
394 {
395 struct ubtbcmfw_softc *sc = usb_fifo_softc(fifo);
396 struct usb_xfer *xfer;
397
398 /*
399 * f_open fifo method can only be called with either FREAD
400 * or FWRITE flag set at one time.
401 */
402
403 if (fflags & FREAD)
404 xfer = sc->sc_xfer[UBTBCMFW_INTR_DT_RD];
405 else if (fflags & FWRITE)
406 xfer = sc->sc_xfer[UBTBCMFW_BULK_DT_WR];
407 else
408 return (EINVAL); /* should not happen */
409
410 if (usb_fifo_alloc_buffer(fifo, usbd_xfer_max_len(xfer),
411 UBTBCMFW_IFQ_MAXLEN) != 0)
412 return (ENOMEM);
413
414 return (0);
415 } /* ubtbcmfw_open */
416
417 /*
418 * Called when fifo is closed
419 */
420
421 static void
ubtbcmfw_close(struct usb_fifo * fifo,int fflags)422 ubtbcmfw_close(struct usb_fifo *fifo, int fflags)
423 {
424 if (fflags & (FREAD | FWRITE))
425 usb_fifo_free_buffer(fifo);
426 } /* ubtbcmfw_close */
427
428 /*
429 * Process ioctl() on USB device
430 */
431
432 static int
ubtbcmfw_ioctl(struct usb_fifo * fifo,u_long cmd,void * data,int fflags)433 ubtbcmfw_ioctl(struct usb_fifo *fifo, u_long cmd, void *data,
434 int fflags)
435 {
436 struct ubtbcmfw_softc *sc = usb_fifo_softc(fifo);
437 int error = 0;
438
439 switch (cmd) {
440 case USB_GET_DEVICE_DESC:
441 memcpy(data, usbd_get_device_descriptor(sc->sc_udev),
442 sizeof(struct usb_device_descriptor));
443 break;
444
445 default:
446 error = EINVAL;
447 break;
448 }
449
450 return (error);
451 } /* ubtbcmfw_ioctl */
452