Linux Audio

Check our new training course

Loading...
v6.13.7
  1// SPDX-License-Identifier: GPL-2.0-or-later
  2/*
  3 *
  4 *  AVM BlueFRITZ! USB driver
  5 *
  6 *  Copyright (C) 2003-2006  Marcel Holtmann <marcel@holtmann.org>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  7 */
  8
  9#include <linux/module.h>
 10
 11#include <linux/kernel.h>
 12#include <linux/init.h>
 13#include <linux/slab.h>
 14#include <linux/types.h>
 15#include <linux/errno.h>
 16#include <linux/skbuff.h>
 17
 18#include <linux/device.h>
 19#include <linux/firmware.h>
 20
 21#include <linux/usb.h>
 22
 23#include <net/bluetooth/bluetooth.h>
 24#include <net/bluetooth/hci_core.h>
 25
 26#define VERSION "1.2"
 27
 28static struct usb_driver bfusb_driver;
 29
 30static const struct usb_device_id bfusb_table[] = {
 31	/* AVM BlueFRITZ! USB */
 32	{ USB_DEVICE(0x057c, 0x2200) },
 33
 34	{ }	/* Terminating entry */
 35};
 36
 37MODULE_DEVICE_TABLE(usb, bfusb_table);
 38
 39#define BFUSB_MAX_BLOCK_SIZE	256
 40
 41#define BFUSB_BLOCK_TIMEOUT	3000
 42
 43#define BFUSB_TX_PROCESS	1
 44#define BFUSB_TX_WAKEUP		2
 45
 46#define BFUSB_MAX_BULK_TX	2
 47#define BFUSB_MAX_BULK_RX	2
 48
 49struct bfusb_data {
 50	struct hci_dev		*hdev;
 51
 52	unsigned long		state;
 53
 54	struct usb_device	*udev;
 55
 56	unsigned int		bulk_in_ep;
 57	unsigned int		bulk_out_ep;
 58	unsigned int		bulk_pkt_size;
 59
 60	rwlock_t		lock;
 61
 62	struct sk_buff_head	transmit_q;
 63
 64	struct sk_buff		*reassembly;
 65
 66	atomic_t		pending_tx;
 67	struct sk_buff_head	pending_q;
 68	struct sk_buff_head	completed_q;
 69};
 70
 71struct bfusb_data_scb {
 72	struct urb *urb;
 73};
 74
 75static void bfusb_tx_complete(struct urb *urb);
 76static void bfusb_rx_complete(struct urb *urb);
 77
 78static struct urb *bfusb_get_completed(struct bfusb_data *data)
 79{
 80	struct sk_buff *skb;
 81	struct urb *urb = NULL;
 82
 83	BT_DBG("bfusb %p", data);
 84
 85	skb = skb_dequeue(&data->completed_q);
 86	if (skb) {
 87		urb = ((struct bfusb_data_scb *) skb->cb)->urb;
 88		kfree_skb(skb);
 89	}
 90
 91	return urb;
 92}
 93
 94static void bfusb_unlink_urbs(struct bfusb_data *data)
 95{
 96	struct sk_buff *skb;
 97	struct urb *urb;
 98
 99	BT_DBG("bfusb %p", data);
100
101	while ((skb = skb_dequeue(&data->pending_q))) {
102		urb = ((struct bfusb_data_scb *) skb->cb)->urb;
103		usb_kill_urb(urb);
104		skb_queue_tail(&data->completed_q, skb);
105	}
106
107	while ((urb = bfusb_get_completed(data)))
108		usb_free_urb(urb);
109}
110
111static int bfusb_send_bulk(struct bfusb_data *data, struct sk_buff *skb)
112{
113	struct bfusb_data_scb *scb = (void *) skb->cb;
114	struct urb *urb = bfusb_get_completed(data);
115	int err, pipe;
116
117	BT_DBG("bfusb %p skb %p len %d", data, skb, skb->len);
118
119	if (!urb) {
120		urb = usb_alloc_urb(0, GFP_ATOMIC);
121		if (!urb)
122			return -ENOMEM;
123	}
124
125	pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
126
127	usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, skb->len,
128			bfusb_tx_complete, skb);
129
130	scb->urb = urb;
131
132	skb_queue_tail(&data->pending_q, skb);
133
134	err = usb_submit_urb(urb, GFP_ATOMIC);
135	if (err) {
136		bt_dev_err(data->hdev, "bulk tx submit failed urb %p err %d",
137			   urb, err);
138		skb_unlink(skb, &data->pending_q);
139		usb_free_urb(urb);
140	} else
141		atomic_inc(&data->pending_tx);
142
143	return err;
144}
145
146static void bfusb_tx_wakeup(struct bfusb_data *data)
147{
148	struct sk_buff *skb;
149
150	BT_DBG("bfusb %p", data);
151
152	if (test_and_set_bit(BFUSB_TX_PROCESS, &data->state)) {
153		set_bit(BFUSB_TX_WAKEUP, &data->state);
154		return;
155	}
156
157	do {
158		clear_bit(BFUSB_TX_WAKEUP, &data->state);
159
160		while ((atomic_read(&data->pending_tx) < BFUSB_MAX_BULK_TX) &&
161				(skb = skb_dequeue(&data->transmit_q))) {
162			if (bfusb_send_bulk(data, skb) < 0) {
163				skb_queue_head(&data->transmit_q, skb);
164				break;
165			}
166		}
167
168	} while (test_bit(BFUSB_TX_WAKEUP, &data->state));
169
170	clear_bit(BFUSB_TX_PROCESS, &data->state);
171}
172
173static void bfusb_tx_complete(struct urb *urb)
174{
175	struct sk_buff *skb = (struct sk_buff *) urb->context;
176	struct bfusb_data *data = (struct bfusb_data *) skb->dev;
177
178	BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
179
180	atomic_dec(&data->pending_tx);
181
182	if (!test_bit(HCI_RUNNING, &data->hdev->flags))
183		return;
184
185	if (!urb->status)
186		data->hdev->stat.byte_tx += skb->len;
187	else
188		data->hdev->stat.err_tx++;
189
190	read_lock(&data->lock);
191
192	skb_unlink(skb, &data->pending_q);
193	skb_queue_tail(&data->completed_q, skb);
194
195	bfusb_tx_wakeup(data);
196
197	read_unlock(&data->lock);
198}
199
200
201static int bfusb_rx_submit(struct bfusb_data *data, struct urb *urb)
202{
203	struct bfusb_data_scb *scb;
204	struct sk_buff *skb;
205	int err, pipe, size = HCI_MAX_FRAME_SIZE + 32;
206
207	BT_DBG("bfusb %p urb %p", data, urb);
208
209	if (!urb) {
210		urb = usb_alloc_urb(0, GFP_ATOMIC);
211		if (!urb)
212			return -ENOMEM;
213	}
214
215	skb = bt_skb_alloc(size, GFP_ATOMIC);
216	if (!skb) {
217		usb_free_urb(urb);
218		return -ENOMEM;
219	}
220
221	skb->dev = (void *) data;
222
223	scb = (struct bfusb_data_scb *) skb->cb;
224	scb->urb = urb;
225
226	pipe = usb_rcvbulkpipe(data->udev, data->bulk_in_ep);
227
228	usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, size,
229			bfusb_rx_complete, skb);
230
231	skb_queue_tail(&data->pending_q, skb);
232
233	err = usb_submit_urb(urb, GFP_ATOMIC);
234	if (err) {
235		bt_dev_err(data->hdev, "bulk rx submit failed urb %p err %d",
236			   urb, err);
237		skb_unlink(skb, &data->pending_q);
238		kfree_skb(skb);
239		usb_free_urb(urb);
240	}
241
242	return err;
243}
244
245static inline int bfusb_recv_block(struct bfusb_data *data, int hdr, unsigned char *buf, int len)
246{
247	BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data, hdr, buf, len);
248
249	if (hdr & 0x10) {
250		bt_dev_err(data->hdev, "error in block");
251		kfree_skb(data->reassembly);
252		data->reassembly = NULL;
253		return -EIO;
254	}
255
256	if (hdr & 0x04) {
257		struct sk_buff *skb;
258		unsigned char pkt_type;
259		int pkt_len = 0;
260
261		if (data->reassembly) {
262			bt_dev_err(data->hdev, "unexpected start block");
263			kfree_skb(data->reassembly);
264			data->reassembly = NULL;
265		}
266
267		if (len < 1) {
268			bt_dev_err(data->hdev, "no packet type found");
269			return -EPROTO;
270		}
271
272		pkt_type = *buf++; len--;
273
274		switch (pkt_type) {
275		case HCI_EVENT_PKT:
276			if (len >= HCI_EVENT_HDR_SIZE) {
277				struct hci_event_hdr *hdr = (struct hci_event_hdr *) buf;
278				pkt_len = HCI_EVENT_HDR_SIZE + hdr->plen;
279			} else {
280				bt_dev_err(data->hdev, "event block is too short");
281				return -EILSEQ;
282			}
283			break;
284
285		case HCI_ACLDATA_PKT:
286			if (len >= HCI_ACL_HDR_SIZE) {
287				struct hci_acl_hdr *hdr = (struct hci_acl_hdr *) buf;
288				pkt_len = HCI_ACL_HDR_SIZE + __le16_to_cpu(hdr->dlen);
289			} else {
290				bt_dev_err(data->hdev, "data block is too short");
291				return -EILSEQ;
292			}
293			break;
294
295		case HCI_SCODATA_PKT:
296			if (len >= HCI_SCO_HDR_SIZE) {
297				struct hci_sco_hdr *hdr = (struct hci_sco_hdr *) buf;
298				pkt_len = HCI_SCO_HDR_SIZE + hdr->dlen;
299			} else {
300				bt_dev_err(data->hdev, "audio block is too short");
301				return -EILSEQ;
302			}
303			break;
304		}
305
306		skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
307		if (!skb) {
308			bt_dev_err(data->hdev, "no memory for the packet");
309			return -ENOMEM;
310		}
311
312		hci_skb_pkt_type(skb) = pkt_type;
 
313
314		data->reassembly = skb;
315	} else {
316		if (!data->reassembly) {
317			bt_dev_err(data->hdev, "unexpected continuation block");
318			return -EIO;
319		}
320	}
321
322	if (len > 0)
323		skb_put_data(data->reassembly, buf, len);
324
325	if (hdr & 0x08) {
326		hci_recv_frame(data->hdev, data->reassembly);
327		data->reassembly = NULL;
328	}
329
330	return 0;
331}
332
333static void bfusb_rx_complete(struct urb *urb)
334{
335	struct sk_buff *skb = (struct sk_buff *) urb->context;
336	struct bfusb_data *data = (struct bfusb_data *) skb->dev;
337	unsigned char *buf = urb->transfer_buffer;
338	int count = urb->actual_length;
339	int err, hdr, len;
340
341	BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
342
343	read_lock(&data->lock);
344
345	if (!test_bit(HCI_RUNNING, &data->hdev->flags))
346		goto unlock;
347
348	if (urb->status || !count)
349		goto resubmit;
350
351	data->hdev->stat.byte_rx += count;
352
353	skb_put(skb, count);
354
355	while (count) {
356		hdr = buf[0] | (buf[1] << 8);
357
358		if (hdr & 0x4000) {
359			len = 0;
360			count -= 2;
361			buf   += 2;
362		} else {
363			len = (buf[2] == 0) ? 256 : buf[2];
364			count -= 3;
365			buf   += 3;
366		}
367
368		if (count < len) {
369			bt_dev_err(data->hdev, "block extends over URB buffer ranges");
 
370		}
371
372		if ((hdr & 0xe1) == 0xc1)
373			bfusb_recv_block(data, hdr, buf, len);
374
375		count -= len;
376		buf   += len;
377	}
378
379	skb_unlink(skb, &data->pending_q);
380	kfree_skb(skb);
381
382	bfusb_rx_submit(data, urb);
383
384	read_unlock(&data->lock);
385
386	return;
387
388resubmit:
389	urb->dev = data->udev;
390
391	err = usb_submit_urb(urb, GFP_ATOMIC);
392	if (err) {
393		bt_dev_err(data->hdev, "bulk resubmit failed urb %p err %d",
394			   urb, err);
395	}
396
397unlock:
398	read_unlock(&data->lock);
399}
400
401static int bfusb_open(struct hci_dev *hdev)
402{
403	struct bfusb_data *data = hci_get_drvdata(hdev);
404	unsigned long flags;
405	int i, err;
406
407	BT_DBG("hdev %p bfusb %p", hdev, data);
408
 
 
 
409	write_lock_irqsave(&data->lock, flags);
410
411	err = bfusb_rx_submit(data, NULL);
412	if (!err) {
413		for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
414			bfusb_rx_submit(data, NULL);
 
 
415	}
416
417	write_unlock_irqrestore(&data->lock, flags);
418
419	return err;
420}
421
422static int bfusb_flush(struct hci_dev *hdev)
423{
424	struct bfusb_data *data = hci_get_drvdata(hdev);
425
426	BT_DBG("hdev %p bfusb %p", hdev, data);
427
428	skb_queue_purge(&data->transmit_q);
429
430	return 0;
431}
432
433static int bfusb_close(struct hci_dev *hdev)
434{
435	struct bfusb_data *data = hci_get_drvdata(hdev);
436	unsigned long flags;
437
438	BT_DBG("hdev %p bfusb %p", hdev, data);
439
 
 
 
440	write_lock_irqsave(&data->lock, flags);
441	write_unlock_irqrestore(&data->lock, flags);
442
443	bfusb_unlink_urbs(data);
444	bfusb_flush(hdev);
445
446	return 0;
447}
448
449static int bfusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
450{
451	struct bfusb_data *data = hci_get_drvdata(hdev);
 
452	struct sk_buff *nskb;
453	unsigned char buf[3];
454	int sent = 0, size, count;
455
456	BT_DBG("hdev %p skb %p type %d len %d", hdev, skb,
457	       hci_skb_pkt_type(skb), skb->len);
458
459	switch (hci_skb_pkt_type(skb)) {
 
 
 
 
 
 
 
 
 
 
460	case HCI_COMMAND_PKT:
461		hdev->stat.cmd_tx++;
462		break;
463	case HCI_ACLDATA_PKT:
464		hdev->stat.acl_tx++;
465		break;
466	case HCI_SCODATA_PKT:
467		hdev->stat.sco_tx++;
468		break;
469	}
470
471	/* Prepend skb with frame type */
472	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
473
474	count = skb->len;
475
476	/* Max HCI frame size seems to be 1511 + 1 */
477	nskb = bt_skb_alloc(count + 32, GFP_KERNEL);
478	if (!nskb) {
479		bt_dev_err(hdev, "Can't allocate memory for new packet");
480		return -ENOMEM;
481	}
482
483	nskb->dev = (void *) data;
484
485	while (count) {
486		size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
487
488		buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
489		buf[1] = 0x00;
490		buf[2] = (size == BFUSB_MAX_BLOCK_SIZE) ? 0 : size;
491
492		skb_put_data(nskb, buf, 3);
493		skb_copy_from_linear_data_offset(skb, sent, skb_put(nskb, size), size);
494
495		sent  += size;
496		count -= size;
497	}
498
499	/* Don't send frame with multiple size of bulk max packet */
500	if ((nskb->len % data->bulk_pkt_size) == 0) {
501		buf[0] = 0xdd;
502		buf[1] = 0x00;
503		skb_put_data(nskb, buf, 2);
504	}
505
506	read_lock(&data->lock);
507
508	skb_queue_tail(&data->transmit_q, nskb);
509	bfusb_tx_wakeup(data);
510
511	read_unlock(&data->lock);
512
513	kfree_skb(skb);
514
515	return 0;
516}
517
 
 
 
 
 
 
 
 
 
 
 
 
 
 
518static int bfusb_load_firmware(struct bfusb_data *data,
519			       const unsigned char *firmware, int count)
520{
521	unsigned char *buf;
522	int err, pipe, len, size, sent = 0;
523
524	BT_DBG("bfusb %p udev %p", data, data->udev);
525
526	BT_INFO("BlueFRITZ! USB loading firmware");
527
528	buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_KERNEL);
529	if (!buf) {
530		BT_ERR("Can't allocate memory chunk for firmware");
531		return -ENOMEM;
532	}
533
534	pipe = usb_sndctrlpipe(data->udev, 0);
535
536	if (usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
537				0, 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT) < 0) {
538		BT_ERR("Can't change to loading configuration");
539		kfree(buf);
540		return -EBUSY;
541	}
542
543	data->udev->toggle[0] = data->udev->toggle[1] = 0;
544
 
 
 
 
 
 
545	pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
546
547	while (count) {
548		size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
549
550		memcpy(buf, firmware + sent, size);
551
552		err = usb_bulk_msg(data->udev, pipe, buf, size,
553					&len, BFUSB_BLOCK_TIMEOUT);
554
555		if (err || (len != size)) {
556			BT_ERR("Error in firmware loading");
557			goto error;
558		}
559
560		sent  += size;
561		count -= size;
562	}
563
564	err = usb_bulk_msg(data->udev, pipe, NULL, 0,
565					&len, BFUSB_BLOCK_TIMEOUT);
566	if (err < 0) {
567		BT_ERR("Error in null packet request");
568		goto error;
569	}
570
571	pipe = usb_sndctrlpipe(data->udev, 0);
572
573	err = usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
574				0, 2, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
575	if (err < 0) {
576		BT_ERR("Can't change to running configuration");
577		goto error;
578	}
579
580	data->udev->toggle[0] = data->udev->toggle[1] = 0;
581
582	BT_INFO("BlueFRITZ! USB device ready");
583
584	kfree(buf);
585	return 0;
586
587error:
588	kfree(buf);
589
590	pipe = usb_sndctrlpipe(data->udev, 0);
591
592	usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
593				0, 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
594
595	return err;
596}
597
598static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
599{
600	const struct firmware *firmware;
601	struct usb_device *udev = interface_to_usbdev(intf);
602	struct usb_host_endpoint *bulk_out_ep;
603	struct usb_host_endpoint *bulk_in_ep;
604	struct hci_dev *hdev;
605	struct bfusb_data *data;
606
607	BT_DBG("intf %p id %p", intf, id);
608
609	/* Check number of endpoints */
610	if (intf->cur_altsetting->desc.bNumEndpoints < 2)
611		return -EIO;
612
613	bulk_out_ep = &intf->cur_altsetting->endpoint[0];
614	bulk_in_ep  = &intf->cur_altsetting->endpoint[1];
615
616	if (!bulk_out_ep || !bulk_in_ep) {
617		BT_ERR("Bulk endpoints not found");
618		goto done;
619	}
620
621	/* Initialize control structure and load firmware */
622	data = devm_kzalloc(&intf->dev, sizeof(struct bfusb_data), GFP_KERNEL);
623	if (!data)
624		return -ENOMEM;
 
 
625
626	data->udev = udev;
627	data->bulk_in_ep    = bulk_in_ep->desc.bEndpointAddress;
628	data->bulk_out_ep   = bulk_out_ep->desc.bEndpointAddress;
629	data->bulk_pkt_size = le16_to_cpu(bulk_out_ep->desc.wMaxPacketSize);
630
631	if (!data->bulk_pkt_size)
632		goto done;
633
634	rwlock_init(&data->lock);
635
636	data->reassembly = NULL;
637
638	skb_queue_head_init(&data->transmit_q);
639	skb_queue_head_init(&data->pending_q);
640	skb_queue_head_init(&data->completed_q);
641
642	if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
643		BT_ERR("Firmware request failed");
644		goto done;
645	}
646
647	BT_DBG("firmware data %p size %zu", firmware->data, firmware->size);
648
649	if (bfusb_load_firmware(data, firmware->data, firmware->size) < 0) {
650		BT_ERR("Firmware loading failed");
651		goto release;
652	}
653
654	release_firmware(firmware);
655
656	/* Initialize and register HCI device */
657	hdev = hci_alloc_dev();
658	if (!hdev) {
659		BT_ERR("Can't allocate HCI device");
660		goto done;
661	}
662
663	data->hdev = hdev;
664
665	hdev->bus = HCI_USB;
666	hci_set_drvdata(hdev, data);
667	SET_HCIDEV_DEV(hdev, &intf->dev);
668
669	hdev->open  = bfusb_open;
670	hdev->close = bfusb_close;
671	hdev->flush = bfusb_flush;
672	hdev->send  = bfusb_send_frame;
 
 
673
674	set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
675
676	if (hci_register_dev(hdev) < 0) {
677		BT_ERR("Can't register HCI device");
678		hci_free_dev(hdev);
679		goto done;
680	}
681
682	usb_set_intfdata(intf, data);
683
684	return 0;
685
686release:
687	release_firmware(firmware);
688
 
 
 
689done:
690	return -EIO;
691}
692
693static void bfusb_disconnect(struct usb_interface *intf)
694{
695	struct bfusb_data *data = usb_get_intfdata(intf);
696	struct hci_dev *hdev = data->hdev;
697
698	BT_DBG("intf %p", intf);
699
700	if (!hdev)
701		return;
702
703	usb_set_intfdata(intf, NULL);
704
705	bfusb_close(hdev);
706
707	hci_unregister_dev(hdev);
 
 
708	hci_free_dev(hdev);
709}
710
711static struct usb_driver bfusb_driver = {
712	.name		= "bfusb",
713	.probe		= bfusb_probe,
714	.disconnect	= bfusb_disconnect,
715	.id_table	= bfusb_table,
716	.disable_hub_initiated_lpm = 1,
717};
718
719module_usb_driver(bfusb_driver);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
720
721MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
722MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
723MODULE_VERSION(VERSION);
724MODULE_LICENSE("GPL");
725MODULE_FIRMWARE("bfubase.frm");
v3.1
 
  1/*
  2 *
  3 *  AVM BlueFRITZ! USB driver
  4 *
  5 *  Copyright (C) 2003-2006  Marcel Holtmann <marcel@holtmann.org>
  6 *
  7 *
  8 *  This program is free software; you can redistribute it and/or modify
  9 *  it under the terms of the GNU General Public License as published by
 10 *  the Free Software Foundation; either version 2 of the License, or
 11 *  (at your option) any later version.
 12 *
 13 *  This program is distributed in the hope that it will be useful,
 14 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 15 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 16 *  GNU General Public License for more details.
 17 *
 18 *  You should have received a copy of the GNU General Public License
 19 *  along with this program; if not, write to the Free Software
 20 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 21 *
 22 */
 23
 24#include <linux/module.h>
 25
 26#include <linux/kernel.h>
 27#include <linux/init.h>
 28#include <linux/slab.h>
 29#include <linux/types.h>
 30#include <linux/errno.h>
 31#include <linux/skbuff.h>
 32
 33#include <linux/device.h>
 34#include <linux/firmware.h>
 35
 36#include <linux/usb.h>
 37
 38#include <net/bluetooth/bluetooth.h>
 39#include <net/bluetooth/hci_core.h>
 40
 41#define VERSION "1.2"
 42
 43static struct usb_driver bfusb_driver;
 44
 45static struct usb_device_id bfusb_table[] = {
 46	/* AVM BlueFRITZ! USB */
 47	{ USB_DEVICE(0x057c, 0x2200) },
 48
 49	{ }	/* Terminating entry */
 50};
 51
 52MODULE_DEVICE_TABLE(usb, bfusb_table);
 53
 54#define BFUSB_MAX_BLOCK_SIZE	256
 55
 56#define BFUSB_BLOCK_TIMEOUT	3000
 57
 58#define BFUSB_TX_PROCESS	1
 59#define BFUSB_TX_WAKEUP		2
 60
 61#define BFUSB_MAX_BULK_TX	2
 62#define BFUSB_MAX_BULK_RX	2
 63
 64struct bfusb_data {
 65	struct hci_dev		*hdev;
 66
 67	unsigned long		state;
 68
 69	struct usb_device	*udev;
 70
 71	unsigned int		bulk_in_ep;
 72	unsigned int		bulk_out_ep;
 73	unsigned int		bulk_pkt_size;
 74
 75	rwlock_t		lock;
 76
 77	struct sk_buff_head	transmit_q;
 78
 79	struct sk_buff		*reassembly;
 80
 81	atomic_t		pending_tx;
 82	struct sk_buff_head	pending_q;
 83	struct sk_buff_head	completed_q;
 84};
 85
 86struct bfusb_data_scb {
 87	struct urb *urb;
 88};
 89
 90static void bfusb_tx_complete(struct urb *urb);
 91static void bfusb_rx_complete(struct urb *urb);
 92
 93static struct urb *bfusb_get_completed(struct bfusb_data *data)
 94{
 95	struct sk_buff *skb;
 96	struct urb *urb = NULL;
 97
 98	BT_DBG("bfusb %p", data);
 99
100	skb = skb_dequeue(&data->completed_q);
101	if (skb) {
102		urb = ((struct bfusb_data_scb *) skb->cb)->urb;
103		kfree_skb(skb);
104	}
105
106	return urb;
107}
108
109static void bfusb_unlink_urbs(struct bfusb_data *data)
110{
111	struct sk_buff *skb;
112	struct urb *urb;
113
114	BT_DBG("bfusb %p", data);
115
116	while ((skb = skb_dequeue(&data->pending_q))) {
117		urb = ((struct bfusb_data_scb *) skb->cb)->urb;
118		usb_kill_urb(urb);
119		skb_queue_tail(&data->completed_q, skb);
120	}
121
122	while ((urb = bfusb_get_completed(data)))
123		usb_free_urb(urb);
124}
125
126static int bfusb_send_bulk(struct bfusb_data *data, struct sk_buff *skb)
127{
128	struct bfusb_data_scb *scb = (void *) skb->cb;
129	struct urb *urb = bfusb_get_completed(data);
130	int err, pipe;
131
132	BT_DBG("bfusb %p skb %p len %d", data, skb, skb->len);
133
134	if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
135		return -ENOMEM;
 
 
 
136
137	pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
138
139	usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, skb->len,
140			bfusb_tx_complete, skb);
141
142	scb->urb = urb;
143
144	skb_queue_tail(&data->pending_q, skb);
145
146	err = usb_submit_urb(urb, GFP_ATOMIC);
147	if (err) {
148		BT_ERR("%s bulk tx submit failed urb %p err %d", 
149					data->hdev->name, urb, err);
150		skb_unlink(skb, &data->pending_q);
151		usb_free_urb(urb);
152	} else
153		atomic_inc(&data->pending_tx);
154
155	return err;
156}
157
158static void bfusb_tx_wakeup(struct bfusb_data *data)
159{
160	struct sk_buff *skb;
161
162	BT_DBG("bfusb %p", data);
163
164	if (test_and_set_bit(BFUSB_TX_PROCESS, &data->state)) {
165		set_bit(BFUSB_TX_WAKEUP, &data->state);
166		return;
167	}
168
169	do {
170		clear_bit(BFUSB_TX_WAKEUP, &data->state);
171
172		while ((atomic_read(&data->pending_tx) < BFUSB_MAX_BULK_TX) &&
173				(skb = skb_dequeue(&data->transmit_q))) {
174			if (bfusb_send_bulk(data, skb) < 0) {
175				skb_queue_head(&data->transmit_q, skb);
176				break;
177			}
178		}
179
180	} while (test_bit(BFUSB_TX_WAKEUP, &data->state));
181
182	clear_bit(BFUSB_TX_PROCESS, &data->state);
183}
184
185static void bfusb_tx_complete(struct urb *urb)
186{
187	struct sk_buff *skb = (struct sk_buff *) urb->context;
188	struct bfusb_data *data = (struct bfusb_data *) skb->dev;
189
190	BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
191
192	atomic_dec(&data->pending_tx);
193
194	if (!test_bit(HCI_RUNNING, &data->hdev->flags))
195		return;
196
197	if (!urb->status)
198		data->hdev->stat.byte_tx += skb->len;
199	else
200		data->hdev->stat.err_tx++;
201
202	read_lock(&data->lock);
203
204	skb_unlink(skb, &data->pending_q);
205	skb_queue_tail(&data->completed_q, skb);
206
207	bfusb_tx_wakeup(data);
208
209	read_unlock(&data->lock);
210}
211
212
213static int bfusb_rx_submit(struct bfusb_data *data, struct urb *urb)
214{
215	struct bfusb_data_scb *scb;
216	struct sk_buff *skb;
217	int err, pipe, size = HCI_MAX_FRAME_SIZE + 32;
218
219	BT_DBG("bfusb %p urb %p", data, urb);
220
221	if (!urb && !(urb = usb_alloc_urb(0, GFP_ATOMIC)))
222		return -ENOMEM;
 
 
 
223
224	skb = bt_skb_alloc(size, GFP_ATOMIC);
225	if (!skb) {
226		usb_free_urb(urb);
227		return -ENOMEM;
228	}
229
230	skb->dev = (void *) data;
231
232	scb = (struct bfusb_data_scb *) skb->cb;
233	scb->urb = urb;
234
235	pipe = usb_rcvbulkpipe(data->udev, data->bulk_in_ep);
236
237	usb_fill_bulk_urb(urb, data->udev, pipe, skb->data, size,
238			bfusb_rx_complete, skb);
239
240	skb_queue_tail(&data->pending_q, skb);
241
242	err = usb_submit_urb(urb, GFP_ATOMIC);
243	if (err) {
244		BT_ERR("%s bulk rx submit failed urb %p err %d",
245					data->hdev->name, urb, err);
246		skb_unlink(skb, &data->pending_q);
247		kfree_skb(skb);
248		usb_free_urb(urb);
249	}
250
251	return err;
252}
253
254static inline int bfusb_recv_block(struct bfusb_data *data, int hdr, unsigned char *buf, int len)
255{
256	BT_DBG("bfusb %p hdr 0x%02x data %p len %d", data, hdr, buf, len);
257
258	if (hdr & 0x10) {
259		BT_ERR("%s error in block", data->hdev->name);
260		kfree_skb(data->reassembly);
261		data->reassembly = NULL;
262		return -EIO;
263	}
264
265	if (hdr & 0x04) {
266		struct sk_buff *skb;
267		unsigned char pkt_type;
268		int pkt_len = 0;
269
270		if (data->reassembly) {
271			BT_ERR("%s unexpected start block", data->hdev->name);
272			kfree_skb(data->reassembly);
273			data->reassembly = NULL;
274		}
275
276		if (len < 1) {
277			BT_ERR("%s no packet type found", data->hdev->name);
278			return -EPROTO;
279		}
280
281		pkt_type = *buf++; len--;
282
283		switch (pkt_type) {
284		case HCI_EVENT_PKT:
285			if (len >= HCI_EVENT_HDR_SIZE) {
286				struct hci_event_hdr *hdr = (struct hci_event_hdr *) buf;
287				pkt_len = HCI_EVENT_HDR_SIZE + hdr->plen;
288			} else {
289				BT_ERR("%s event block is too short", data->hdev->name);
290				return -EILSEQ;
291			}
292			break;
293
294		case HCI_ACLDATA_PKT:
295			if (len >= HCI_ACL_HDR_SIZE) {
296				struct hci_acl_hdr *hdr = (struct hci_acl_hdr *) buf;
297				pkt_len = HCI_ACL_HDR_SIZE + __le16_to_cpu(hdr->dlen);
298			} else {
299				BT_ERR("%s data block is too short", data->hdev->name);
300				return -EILSEQ;
301			}
302			break;
303
304		case HCI_SCODATA_PKT:
305			if (len >= HCI_SCO_HDR_SIZE) {
306				struct hci_sco_hdr *hdr = (struct hci_sco_hdr *) buf;
307				pkt_len = HCI_SCO_HDR_SIZE + hdr->dlen;
308			} else {
309				BT_ERR("%s audio block is too short", data->hdev->name);
310				return -EILSEQ;
311			}
312			break;
313		}
314
315		skb = bt_skb_alloc(pkt_len, GFP_ATOMIC);
316		if (!skb) {
317			BT_ERR("%s no memory for the packet", data->hdev->name);
318			return -ENOMEM;
319		}
320
321		skb->dev = (void *) data->hdev;
322		bt_cb(skb)->pkt_type = pkt_type;
323
324		data->reassembly = skb;
325	} else {
326		if (!data->reassembly) {
327			BT_ERR("%s unexpected continuation block", data->hdev->name);
328			return -EIO;
329		}
330	}
331
332	if (len > 0)
333		memcpy(skb_put(data->reassembly, len), buf, len);
334
335	if (hdr & 0x08) {
336		hci_recv_frame(data->reassembly);
337		data->reassembly = NULL;
338	}
339
340	return 0;
341}
342
343static void bfusb_rx_complete(struct urb *urb)
344{
345	struct sk_buff *skb = (struct sk_buff *) urb->context;
346	struct bfusb_data *data = (struct bfusb_data *) skb->dev;
347	unsigned char *buf = urb->transfer_buffer;
348	int count = urb->actual_length;
349	int err, hdr, len;
350
351	BT_DBG("bfusb %p urb %p skb %p len %d", data, urb, skb, skb->len);
352
353	read_lock(&data->lock);
354
355	if (!test_bit(HCI_RUNNING, &data->hdev->flags))
356		goto unlock;
357
358	if (urb->status || !count)
359		goto resubmit;
360
361	data->hdev->stat.byte_rx += count;
362
363	skb_put(skb, count);
364
365	while (count) {
366		hdr = buf[0] | (buf[1] << 8);
367
368		if (hdr & 0x4000) {
369			len = 0;
370			count -= 2;
371			buf   += 2;
372		} else {
373			len = (buf[2] == 0) ? 256 : buf[2];
374			count -= 3;
375			buf   += 3;
376		}
377
378		if (count < len) {
379			BT_ERR("%s block extends over URB buffer ranges",
380					data->hdev->name);
381		}
382
383		if ((hdr & 0xe1) == 0xc1)
384			bfusb_recv_block(data, hdr, buf, len);
385
386		count -= len;
387		buf   += len;
388	}
389
390	skb_unlink(skb, &data->pending_q);
391	kfree_skb(skb);
392
393	bfusb_rx_submit(data, urb);
394
395	read_unlock(&data->lock);
396
397	return;
398
399resubmit:
400	urb->dev = data->udev;
401
402	err = usb_submit_urb(urb, GFP_ATOMIC);
403	if (err) {
404		BT_ERR("%s bulk resubmit failed urb %p err %d",
405					data->hdev->name, urb, err);
406	}
407
408unlock:
409	read_unlock(&data->lock);
410}
411
412static int bfusb_open(struct hci_dev *hdev)
413{
414	struct bfusb_data *data = hdev->driver_data;
415	unsigned long flags;
416	int i, err;
417
418	BT_DBG("hdev %p bfusb %p", hdev, data);
419
420	if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
421		return 0;
422
423	write_lock_irqsave(&data->lock, flags);
424
425	err = bfusb_rx_submit(data, NULL);
426	if (!err) {
427		for (i = 1; i < BFUSB_MAX_BULK_RX; i++)
428			bfusb_rx_submit(data, NULL);
429	} else {
430		clear_bit(HCI_RUNNING, &hdev->flags);
431	}
432
433	write_unlock_irqrestore(&data->lock, flags);
434
435	return err;
436}
437
438static int bfusb_flush(struct hci_dev *hdev)
439{
440	struct bfusb_data *data = hdev->driver_data;
441
442	BT_DBG("hdev %p bfusb %p", hdev, data);
443
444	skb_queue_purge(&data->transmit_q);
445
446	return 0;
447}
448
449static int bfusb_close(struct hci_dev *hdev)
450{
451	struct bfusb_data *data = hdev->driver_data;
452	unsigned long flags;
453
454	BT_DBG("hdev %p bfusb %p", hdev, data);
455
456	if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
457		return 0;
458
459	write_lock_irqsave(&data->lock, flags);
460	write_unlock_irqrestore(&data->lock, flags);
461
462	bfusb_unlink_urbs(data);
463	bfusb_flush(hdev);
464
465	return 0;
466}
467
468static int bfusb_send_frame(struct sk_buff *skb)
469{
470	struct hci_dev *hdev = (struct hci_dev *) skb->dev;
471	struct bfusb_data *data;
472	struct sk_buff *nskb;
473	unsigned char buf[3];
474	int sent = 0, size, count;
475
476	BT_DBG("hdev %p skb %p type %d len %d", hdev, skb, bt_cb(skb)->pkt_type, skb->len);
 
477
478	if (!hdev) {
479		BT_ERR("Frame for unknown HCI device (hdev=NULL)");
480		return -ENODEV;
481	}
482
483	if (!test_bit(HCI_RUNNING, &hdev->flags))
484		return -EBUSY;
485
486	data = hdev->driver_data;
487
488	switch (bt_cb(skb)->pkt_type) {
489	case HCI_COMMAND_PKT:
490		hdev->stat.cmd_tx++;
491		break;
492	case HCI_ACLDATA_PKT:
493		hdev->stat.acl_tx++;
494		break;
495	case HCI_SCODATA_PKT:
496		hdev->stat.sco_tx++;
497		break;
498	};
499
500	/* Prepend skb with frame type */
501	memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
502
503	count = skb->len;
504
505	/* Max HCI frame size seems to be 1511 + 1 */
506	nskb = bt_skb_alloc(count + 32, GFP_ATOMIC);
507	if (!nskb) {
508		BT_ERR("Can't allocate memory for new packet");
509		return -ENOMEM;
510	}
511
512	nskb->dev = (void *) data;
513
514	while (count) {
515		size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE);
516
517		buf[0] = 0xc1 | ((sent == 0) ? 0x04 : 0) | ((count == size) ? 0x08 : 0);
518		buf[1] = 0x00;
519		buf[2] = (size == BFUSB_MAX_BLOCK_SIZE) ? 0 : size;
520
521		memcpy(skb_put(nskb, 3), buf, 3);
522		skb_copy_from_linear_data_offset(skb, sent, skb_put(nskb, size), size);
523
524		sent  += size;
525		count -= size;
526	}
527
528	/* Don't send frame with multiple size of bulk max packet */
529	if ((nskb->len % data->bulk_pkt_size) == 0) {
530		buf[0] = 0xdd;
531		buf[1] = 0x00;
532		memcpy(skb_put(nskb, 2), buf, 2);
533	}
534
535	read_lock(&data->lock);
536
537	skb_queue_tail(&data->transmit_q, nskb);
538	bfusb_tx_wakeup(data);
539
540	read_unlock(&data->lock);
541
542	kfree_skb(skb);
543
544	return 0;
545}
546
547static void bfusb_destruct(struct hci_dev *hdev)
548{
549	struct bfusb_data *data = hdev->driver_data;
550
551	BT_DBG("hdev %p bfusb %p", hdev, data);
552
553	kfree(data);
554}
555
556static int bfusb_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
557{
558	return -ENOIOCTLCMD;
559}
560
561static int bfusb_load_firmware(struct bfusb_data *data,
562			       const unsigned char *firmware, int count)
563{
564	unsigned char *buf;
565	int err, pipe, len, size, sent = 0;
566
567	BT_DBG("bfusb %p udev %p", data, data->udev);
568
569	BT_INFO("BlueFRITZ! USB loading firmware");
570
 
 
 
 
 
 
571	pipe = usb_sndctrlpipe(data->udev, 0);
572
573	if (usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
574				0, 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT) < 0) {
575		BT_ERR("Can't change to loading configuration");
 
576		return -EBUSY;
577	}
578
579	data->udev->toggle[0] = data->udev->toggle[1] = 0;
580
581	buf = kmalloc(BFUSB_MAX_BLOCK_SIZE + 3, GFP_ATOMIC);
582	if (!buf) {
583		BT_ERR("Can't allocate memory chunk for firmware");
584		return -ENOMEM;
585	}
586
587	pipe = usb_sndbulkpipe(data->udev, data->bulk_out_ep);
588
589	while (count) {
590		size = min_t(uint, count, BFUSB_MAX_BLOCK_SIZE + 3);
591
592		memcpy(buf, firmware + sent, size);
593
594		err = usb_bulk_msg(data->udev, pipe, buf, size,
595					&len, BFUSB_BLOCK_TIMEOUT);
596
597		if (err || (len != size)) {
598			BT_ERR("Error in firmware loading");
599			goto error;
600		}
601
602		sent  += size;
603		count -= size;
604	}
605
606	err = usb_bulk_msg(data->udev, pipe, NULL, 0,
607					&len, BFUSB_BLOCK_TIMEOUT);
608	if (err < 0) {
609		BT_ERR("Error in null packet request");
610		goto error;
611	}
612
613	pipe = usb_sndctrlpipe(data->udev, 0);
614
615	err = usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
616				0, 2, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
617	if (err < 0) {
618		BT_ERR("Can't change to running configuration");
619		goto error;
620	}
621
622	data->udev->toggle[0] = data->udev->toggle[1] = 0;
623
624	BT_INFO("BlueFRITZ! USB device ready");
625
626	kfree(buf);
627	return 0;
628
629error:
630	kfree(buf);
631
632	pipe = usb_sndctrlpipe(data->udev, 0);
633
634	usb_control_msg(data->udev, pipe, USB_REQ_SET_CONFIGURATION,
635				0, 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
636
637	return err;
638}
639
640static int bfusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
641{
642	const struct firmware *firmware;
643	struct usb_device *udev = interface_to_usbdev(intf);
644	struct usb_host_endpoint *bulk_out_ep;
645	struct usb_host_endpoint *bulk_in_ep;
646	struct hci_dev *hdev;
647	struct bfusb_data *data;
648
649	BT_DBG("intf %p id %p", intf, id);
650
651	/* Check number of endpoints */
652	if (intf->cur_altsetting->desc.bNumEndpoints < 2)
653		return -EIO;
654
655	bulk_out_ep = &intf->cur_altsetting->endpoint[0];
656	bulk_in_ep  = &intf->cur_altsetting->endpoint[1];
657
658	if (!bulk_out_ep || !bulk_in_ep) {
659		BT_ERR("Bulk endpoints not found");
660		goto done;
661	}
662
663	/* Initialize control structure and load firmware */
664	data = kzalloc(sizeof(struct bfusb_data), GFP_KERNEL);
665	if (!data) {
666		BT_ERR("Can't allocate memory for control structure");
667		goto done;
668	}
669
670	data->udev = udev;
671	data->bulk_in_ep    = bulk_in_ep->desc.bEndpointAddress;
672	data->bulk_out_ep   = bulk_out_ep->desc.bEndpointAddress;
673	data->bulk_pkt_size = le16_to_cpu(bulk_out_ep->desc.wMaxPacketSize);
674
 
 
 
675	rwlock_init(&data->lock);
676
677	data->reassembly = NULL;
678
679	skb_queue_head_init(&data->transmit_q);
680	skb_queue_head_init(&data->pending_q);
681	skb_queue_head_init(&data->completed_q);
682
683	if (request_firmware(&firmware, "bfubase.frm", &udev->dev) < 0) {
684		BT_ERR("Firmware request failed");
685		goto error;
686	}
687
688	BT_DBG("firmware data %p size %zu", firmware->data, firmware->size);
689
690	if (bfusb_load_firmware(data, firmware->data, firmware->size) < 0) {
691		BT_ERR("Firmware loading failed");
692		goto release;
693	}
694
695	release_firmware(firmware);
696
697	/* Initialize and register HCI device */
698	hdev = hci_alloc_dev();
699	if (!hdev) {
700		BT_ERR("Can't allocate HCI device");
701		goto error;
702	}
703
704	data->hdev = hdev;
705
706	hdev->bus = HCI_USB;
707	hdev->driver_data = data;
708	SET_HCIDEV_DEV(hdev, &intf->dev);
709
710	hdev->open     = bfusb_open;
711	hdev->close    = bfusb_close;
712	hdev->flush    = bfusb_flush;
713	hdev->send     = bfusb_send_frame;
714	hdev->destruct = bfusb_destruct;
715	hdev->ioctl    = bfusb_ioctl;
716
717	hdev->owner = THIS_MODULE;
718
719	if (hci_register_dev(hdev) < 0) {
720		BT_ERR("Can't register HCI device");
721		hci_free_dev(hdev);
722		goto error;
723	}
724
725	usb_set_intfdata(intf, data);
726
727	return 0;
728
729release:
730	release_firmware(firmware);
731
732error:
733	kfree(data);
734
735done:
736	return -EIO;
737}
738
739static void bfusb_disconnect(struct usb_interface *intf)
740{
741	struct bfusb_data *data = usb_get_intfdata(intf);
742	struct hci_dev *hdev = data->hdev;
743
744	BT_DBG("intf %p", intf);
745
746	if (!hdev)
747		return;
748
749	usb_set_intfdata(intf, NULL);
750
751	bfusb_close(hdev);
752
753	if (hci_unregister_dev(hdev) < 0)
754		BT_ERR("Can't unregister HCI device %s", hdev->name);
755
756	hci_free_dev(hdev);
757}
758
759static struct usb_driver bfusb_driver = {
760	.name		= "bfusb",
761	.probe		= bfusb_probe,
762	.disconnect	= bfusb_disconnect,
763	.id_table	= bfusb_table,
 
764};
765
766static int __init bfusb_init(void)
767{
768	int err;
769
770	BT_INFO("BlueFRITZ! USB driver ver %s", VERSION);
771
772	err = usb_register(&bfusb_driver);
773	if (err < 0)
774		BT_ERR("Failed to register BlueFRITZ! USB driver");
775
776	return err;
777}
778
779static void __exit bfusb_exit(void)
780{
781	usb_deregister(&bfusb_driver);
782}
783
784module_init(bfusb_init);
785module_exit(bfusb_exit);
786
787MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
788MODULE_DESCRIPTION("BlueFRITZ! USB driver ver " VERSION);
789MODULE_VERSION(VERSION);
790MODULE_LICENSE("GPL");
791MODULE_FIRMWARE("bfubase.frm");