projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Linux 2.6.39-rc1
[deliverable/linux.git] / drivers / bluetooth / btusb.c
CommitLineData
5e23b923
MH		 1/*
2 *
3 * Generic Bluetooth USB driver
4 *
9bfa35fe 5 * Copyright (C) 2005-2008 Marcel Holtmann <marcel@holtmann.org>
5e23b923
MH		 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/kernel.h>
25#include <linux/module.h>
26#include <linux/init.h>
27#include <linux/slab.h>
28#include <linux/types.h>
29#include <linux/sched.h>
30#include <linux/errno.h>
31#include <linux/skbuff.h>
32
33#include <linux/usb.h>
34
35#include <net/bluetooth/bluetooth.h>
36#include <net/bluetooth/hci_core.h>
37
7bee549e 38#define VERSION "0.6"
cfeb4145
MH		 39
40static int ignore_dga;
41static int ignore_csr;
42static int ignore_sniffer;
43static int disable_scofix;
44static int force_scofix;
7a9d4020
MH		 45
46static int reset = 1;
cfeb4145
MH		 47
48static struct usb_driver btusb_driver;
49
50#define BTUSB_IGNORE 0x01
7a9d4020
MH		 51#define BTUSB_DIGIANSWER 0x02
52#define BTUSB_CSR 0x04
53#define BTUSB_SNIFFER 0x08
54#define BTUSB_BCM92035 0x10
55#define BTUSB_BROKEN_ISOC 0x20
56#define BTUSB_WRONG_SCO_MTU 0x40
5e23b923
MH		 57
58static struct usb_device_id btusb_table[] = {
59 /* Generic Bluetooth USB device */
60 { USB_DEVICE_INFO(0xe0, 0x01, 0x01) },
61
3cd01976
NI		 62 /* Apple MacBookPro 7,1 */
63 { USB_DEVICE(0x05ac, 0x8213) },
64
0a79f674
CL		 65 /* Apple iMac11,1 */
66 { USB_DEVICE(0x05ac, 0x8215) },
67
9c047157
NI		 68 /* Apple MacBookPro6,2 */
69 { USB_DEVICE(0x05ac, 0x8218) },
70
3e3ede7d
EH		 71 /* Apple MacBookAir3,1, MacBookAir3,2 */
72 { USB_DEVICE(0x05ac, 0x821b) },
73
cfeb4145
MH		 74 /* AVM BlueFRITZ! USB v2.0 */
75 { USB_DEVICE(0x057c, 0x3800) },
76
77 /* Bluetooth Ultraport Module from IBM */
78 { USB_DEVICE(0x04bf, 0x030a) },
79
80 /* ALPS Modules with non-standard id */
81 { USB_DEVICE(0x044e, 0x3001) },
82 { USB_DEVICE(0x044e, 0x3002) },
83
84 /* Ericsson with non-standard id */
85 { USB_DEVICE(0x0bdb, 0x1002) },
86
87 /* Canyon CN-BTU1 with HID interfaces */
7a9d4020 88 { USB_DEVICE(0x0c10, 0x0000) },
cfeb4145 89
5e23b923
MH		 90 { } /* Terminating entry */
91};
92
93MODULE_DEVICE_TABLE(usb, btusb_table);
94
95static struct usb_device_id blacklist_table[] = {
cfeb4145
MH		 96 /* CSR BlueCore devices */
97 { USB_DEVICE(0x0a12, 0x0001), .driver_info = BTUSB_CSR },
98
99 /* Broadcom BCM2033 without firmware */
100 { USB_DEVICE(0x0a5c, 0x2033), .driver_info = BTUSB_IGNORE },
101
be93112a
BS		 102 /* Atheros 3011 with sflash firmware */
103 { USB_DEVICE(0x0cf3, 0x3002), .driver_info = BTUSB_IGNORE },
104
509e7861
CYC		 105 /* Atheros AR9285 Malbec with sflash firmware */
106 { USB_DEVICE(0x03f0, 0x311d), .driver_info = BTUSB_IGNORE },
107
d9f51b51
BS		 108 /* Atheros 3012 with sflash firmware */
109 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_IGNORE },
110
e9036e33
CYC		 111 /* Atheros AR5BBU12 with sflash firmware */
112 { USB_DEVICE(0x0489, 0xe02c), .driver_info = BTUSB_IGNORE },
113
cfeb4145 114 /* Broadcom BCM2035 */
7a9d4020
MH		 115 { USB_DEVICE(0x0a5c, 0x2035), .driver_info = BTUSB_WRONG_SCO_MTU },
116 { USB_DEVICE(0x0a5c, 0x200a), .driver_info = BTUSB_WRONG_SCO_MTU },
117 { USB_DEVICE(0x0a5c, 0x2009), .driver_info = BTUSB_BCM92035 },
cfeb4145
MH		 118
119 /* Broadcom BCM2045 */
7a9d4020
MH		 120 { USB_DEVICE(0x0a5c, 0x2039), .driver_info = BTUSB_WRONG_SCO_MTU },
121 { USB_DEVICE(0x0a5c, 0x2101), .driver_info = BTUSB_WRONG_SCO_MTU },
bdbef3d6 122
cfeb4145 123 /* IBM/Lenovo ThinkPad with Broadcom chip */
7a9d4020
MH		 124 { USB_DEVICE(0x0a5c, 0x201e), .driver_info = BTUSB_WRONG_SCO_MTU },
125 { USB_DEVICE(0x0a5c, 0x2110), .driver_info = BTUSB_WRONG_SCO_MTU },
cfeb4145
MH		 126
127 /* HP laptop with Broadcom chip */
7a9d4020 128 { USB_DEVICE(0x03f0, 0x171d), .driver_info = BTUSB_WRONG_SCO_MTU },
cfeb4145
MH		 129
130 /* Dell laptop with Broadcom chip */
7a9d4020 131 { USB_DEVICE(0x413c, 0x8126), .driver_info = BTUSB_WRONG_SCO_MTU },
cfeb4145 132
5ddd4a60 133 /* Dell Wireless 370 and 410 devices */
7a9d4020 134 { USB_DEVICE(0x413c, 0x8152), .driver_info = BTUSB_WRONG_SCO_MTU },
5ddd4a60 135 { USB_DEVICE(0x413c, 0x8156), .driver_info = BTUSB_WRONG_SCO_MTU },
cfeb4145 136
7a9d4020
MH		 137 /* Belkin F8T012 and F8T013 devices */
138 { USB_DEVICE(0x050d, 0x0012), .driver_info = BTUSB_WRONG_SCO_MTU },
139 { USB_DEVICE(0x050d, 0x0013), .driver_info = BTUSB_WRONG_SCO_MTU },
cfeb4145 140
5ddd4a60
MH		 141 /* Asus WL-BTD202 device */
142 { USB_DEVICE(0x0b05, 0x1715), .driver_info = BTUSB_WRONG_SCO_MTU },
143
144 /* Kensington Bluetooth USB adapter */
145 { USB_DEVICE(0x047d, 0x105e), .driver_info = BTUSB_WRONG_SCO_MTU },
146
cfeb4145
MH		 147 /* RTX Telecom based adapters with buggy SCO support */
148 { USB_DEVICE(0x0400, 0x0807), .driver_info = BTUSB_BROKEN_ISOC },
149 { USB_DEVICE(0x0400, 0x080a), .driver_info = BTUSB_BROKEN_ISOC },
150
151 /* CONWISE Technology based adapters with buggy SCO support */
152 { USB_DEVICE(0x0e5e, 0x6622), .driver_info = BTUSB_BROKEN_ISOC },
153
cfeb4145
MH		 154 /* Digianswer devices */
155 { USB_DEVICE(0x08fd, 0x0001), .driver_info = BTUSB_DIGIANSWER },
156 { USB_DEVICE(0x08fd, 0x0002), .driver_info = BTUSB_IGNORE },
157
158 /* CSR BlueCore Bluetooth Sniffer */
159 { USB_DEVICE(0x0a12, 0x0002), .driver_info = BTUSB_SNIFFER },
160
161 /* Frontline ComProbe Bluetooth Sniffer */
162 { USB_DEVICE(0x16d3, 0x0002), .driver_info = BTUSB_SNIFFER },
163
5e23b923
MH		 164 { } /* Terminating entry */
165};
166
9bfa35fe
MH		 167#define BTUSB_MAX_ISOC_FRAMES 10
168
5e23b923
MH		 169#define BTUSB_INTR_RUNNING 0
170#define BTUSB_BULK_RUNNING 1
9bfa35fe 171#define BTUSB_ISOC_RUNNING 2
7bee549e 172#define BTUSB_SUSPENDING 3
08b8b6c4 173#define BTUSB_DID_ISO_RESUME 4
5e23b923
MH		 174
175struct btusb_data {
176 struct hci_dev *hdev;
177 struct usb_device *udev;
5fbcd260 178 struct usb_interface *intf;
9bfa35fe 179 struct usb_interface *isoc;
5e23b923
MH		 180
181 spinlock_t lock;
182
183 unsigned long flags;
184
185 struct work_struct work;
7bee549e 186 struct work_struct waker;
5e23b923
MH		 187
188 struct usb_anchor tx_anchor;
189 struct usb_anchor intr_anchor;
190 struct usb_anchor bulk_anchor;
9bfa35fe 191 struct usb_anchor isoc_anchor;
7bee549e
ON		 192 struct usb_anchor deferred;
193 int tx_in_flight;
194 spinlock_t txlock;
5e23b923
MH		 195
196 struct usb_endpoint_descriptor *intr_ep;
197 struct usb_endpoint_descriptor *bulk_tx_ep;
198 struct usb_endpoint_descriptor *bulk_rx_ep;
9bfa35fe
MH		 199 struct usb_endpoint_descriptor *isoc_tx_ep;
200 struct usb_endpoint_descriptor *isoc_rx_ep;
201
7a9d4020
MH		 202 __u8 cmdreq_type;
203
43c2e57f 204 unsigned int sco_num;
9bfa35fe 205 int isoc_altsetting;
6a88adf2 206 int suspend_count;
5e23b923
MH		 207};
208
7bee549e
ON		 209static int inc_tx(struct btusb_data *data)
210{
211 unsigned long flags;
212 int rv;
213
214 spin_lock_irqsave(&data->txlock, flags);
215 rv = test_bit(BTUSB_SUSPENDING, &data->flags);
216 if (!rv)
217 data->tx_in_flight++;
218 spin_unlock_irqrestore(&data->txlock, flags);
219
220 return rv;
221}
222
5e23b923
MH		 223static void btusb_intr_complete(struct urb *urb)
224{
225 struct hci_dev *hdev = urb->context;
226 struct btusb_data *data = hdev->driver_data;
227 int err;
228
229 BT_DBG("%s urb %p status %d count %d", hdev->name,
230 urb, urb->status, urb->actual_length);
231
232 if (!test_bit(HCI_RUNNING, &hdev->flags))
233 return;
234
235 if (urb->status == 0) {
9bfa35fe
MH		 236 hdev->stat.byte_rx += urb->actual_length;
237
5e23b923
MH		 238 if (hci_recv_fragment(hdev, HCI_EVENT_PKT,
239 urb->transfer_buffer,
240 urb->actual_length) < 0) {
241 BT_ERR("%s corrupted event packet", hdev->name);
242 hdev->stat.err_rx++;
243 }
244 }
245
246 if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
247 return;
248
7bee549e 249 usb_mark_last_busy(data->udev);
5e23b923
MH		 250 usb_anchor_urb(urb, &data->intr_anchor);
251
252 err = usb_submit_urb(urb, GFP_ATOMIC);
253 if (err < 0) {
61faddf6
SS		 254 if (err != -EPERM)
255 BT_ERR("%s urb %p failed to resubmit (%d)",
5e23b923
MH		 256 hdev->name, urb, -err);
257 usb_unanchor_urb(urb);
258 }
259}
260
2eda66f4 261static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
5e23b923
MH		 262{
263 struct btusb_data *data = hdev->driver_data;
264 struct urb *urb;
265 unsigned char *buf;
266 unsigned int pipe;
267 int err, size;
268
269 BT_DBG("%s", hdev->name);
270
9bfa35fe
MH		 271 if (!data->intr_ep)
272 return -ENODEV;
273
2eda66f4 274 urb = usb_alloc_urb(0, mem_flags);
5e23b923
MH		 275 if (!urb)
276 return -ENOMEM;
277
278 size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
279
2eda66f4 280 buf = kmalloc(size, mem_flags);
5e23b923
MH		 281 if (!buf) {
282 usb_free_urb(urb);
283 return -ENOMEM;
284 }
285
286 pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
287
288 usb_fill_int_urb(urb, data->udev, pipe, buf, size,
289 btusb_intr_complete, hdev,
290 data->intr_ep->bInterval);
291
292 urb->transfer_flags |= URB_FREE_BUFFER;
293
294 usb_anchor_urb(urb, &data->intr_anchor);
295
2eda66f4 296 err = usb_submit_urb(urb, mem_flags);
5e23b923
MH		 297 if (err < 0) {
298 BT_ERR("%s urb %p submission failed (%d)",
299 hdev->name, urb, -err);
300 usb_unanchor_urb(urb);
5e23b923
MH		 301 }
302
303 usb_free_urb(urb);
304
305 return err;
306}
307
308static void btusb_bulk_complete(struct urb *urb)
309{
310 struct hci_dev *hdev = urb->context;
311 struct btusb_data *data = hdev->driver_data;
312 int err;
313
314 BT_DBG("%s urb %p status %d count %d", hdev->name,
315 urb, urb->status, urb->actual_length);
316
317 if (!test_bit(HCI_RUNNING, &hdev->flags))
318 return;
319
320 if (urb->status == 0) {
9bfa35fe
MH		 321 hdev->stat.byte_rx += urb->actual_length;
322
5e23b923
MH		 323 if (hci_recv_fragment(hdev, HCI_ACLDATA_PKT,
324 urb->transfer_buffer,
325 urb->actual_length) < 0) {
326 BT_ERR("%s corrupted ACL packet", hdev->name);
327 hdev->stat.err_rx++;
328 }
329 }
330
331 if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
332 return;
333
334 usb_anchor_urb(urb, &data->bulk_anchor);
652fd781 335 usb_mark_last_busy(data->udev);
5e23b923
MH		 336
337 err = usb_submit_urb(urb, GFP_ATOMIC);
338 if (err < 0) {
61faddf6
SS		 339 if (err != -EPERM)
340 BT_ERR("%s urb %p failed to resubmit (%d)",
5e23b923
MH		 341 hdev->name, urb, -err);
342 usb_unanchor_urb(urb);
343 }
344}
345
2eda66f4 346static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
5e23b923
MH		 347{
348 struct btusb_data *data = hdev->driver_data;
349 struct urb *urb;
350 unsigned char *buf;
351 unsigned int pipe;
290ba200 352 int err, size = HCI_MAX_FRAME_SIZE;
5e23b923
MH		 353
354 BT_DBG("%s", hdev->name);
355
9bfa35fe
MH		 356 if (!data->bulk_rx_ep)
357 return -ENODEV;
358
2eda66f4 359 urb = usb_alloc_urb(0, mem_flags);
5e23b923
MH		 360 if (!urb)
361 return -ENOMEM;
362
2eda66f4 363 buf = kmalloc(size, mem_flags);
5e23b923
MH		 364 if (!buf) {
365 usb_free_urb(urb);
366 return -ENOMEM;
367 }
368
369 pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
370
371 usb_fill_bulk_urb(urb, data->udev, pipe,
372 buf, size, btusb_bulk_complete, hdev);
373
374 urb->transfer_flags |= URB_FREE_BUFFER;
375
7bee549e 376 usb_mark_last_busy(data->udev);
5e23b923
MH		 377 usb_anchor_urb(urb, &data->bulk_anchor);
378
2eda66f4 379 err = usb_submit_urb(urb, mem_flags);
5e23b923
MH		 380 if (err < 0) {
381 BT_ERR("%s urb %p submission failed (%d)",
382 hdev->name, urb, -err);
383 usb_unanchor_urb(urb);
5e23b923
MH		 384 }
385
386 usb_free_urb(urb);
387
388 return err;
389}
390
9bfa35fe
MH		 391static void btusb_isoc_complete(struct urb *urb)
392{
393 struct hci_dev *hdev = urb->context;
394 struct btusb_data *data = hdev->driver_data;
395 int i, err;
396
397 BT_DBG("%s urb %p status %d count %d", hdev->name,
398 urb, urb->status, urb->actual_length);
399
400 if (!test_bit(HCI_RUNNING, &hdev->flags))
401 return;
402
403 if (urb->status == 0) {
404 for (i = 0; i < urb->number_of_packets; i++) {
405 unsigned int offset = urb->iso_frame_desc[i].offset;
406 unsigned int length = urb->iso_frame_desc[i].actual_length;
407
408 if (urb->iso_frame_desc[i].status)
409 continue;
410
411 hdev->stat.byte_rx += length;
412
413 if (hci_recv_fragment(hdev, HCI_SCODATA_PKT,
414 urb->transfer_buffer + offset,
415 length) < 0) {
416 BT_ERR("%s corrupted SCO packet", hdev->name);
417 hdev->stat.err_rx++;
418 }
419 }
420 }
421
422 if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
423 return;
424
425 usb_anchor_urb(urb, &data->isoc_anchor);
426
427 err = usb_submit_urb(urb, GFP_ATOMIC);
428 if (err < 0) {
61faddf6
SS		 429 if (err != -EPERM)
430 BT_ERR("%s urb %p failed to resubmit (%d)",
9bfa35fe
MH		 431 hdev->name, urb, -err);
432 usb_unanchor_urb(urb);
433 }
434}
435
42b16b3f 436static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
9bfa35fe
MH		 437{
438 int i, offset = 0;
439
440 BT_DBG("len %d mtu %d", len, mtu);
441
442 for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
443 i++, offset += mtu, len -= mtu) {
444 urb->iso_frame_desc[i].offset = offset;
445 urb->iso_frame_desc[i].length = mtu;
446 }
447
448 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
449 urb->iso_frame_desc[i].offset = offset;
450 urb->iso_frame_desc[i].length = len;
451 i++;
452 }
453
454 urb->number_of_packets = i;
455}
456
2eda66f4 457static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
9bfa35fe
MH		 458{
459 struct btusb_data *data = hdev->driver_data;
460 struct urb *urb;
461 unsigned char *buf;
462 unsigned int pipe;
463 int err, size;
464
465 BT_DBG("%s", hdev->name);
466
467 if (!data->isoc_rx_ep)
468 return -ENODEV;
469
2eda66f4 470 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
9bfa35fe
MH		 471 if (!urb)
472 return -ENOMEM;
473
474 size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
475 BTUSB_MAX_ISOC_FRAMES;
476
2eda66f4 477 buf = kmalloc(size, mem_flags);
9bfa35fe
MH		 478 if (!buf) {
479 usb_free_urb(urb);
480 return -ENOMEM;
481 }
482
483 pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
484
485 urb->dev = data->udev;
486 urb->pipe = pipe;
487 urb->context = hdev;
488 urb->complete = btusb_isoc_complete;
489 urb->interval = data->isoc_rx_ep->bInterval;
490
491 urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
492 urb->transfer_buffer = buf;
493 urb->transfer_buffer_length = size;
494
495 __fill_isoc_descriptor(urb, size,
496 le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
497
498 usb_anchor_urb(urb, &data->isoc_anchor);
499
2eda66f4 500 err = usb_submit_urb(urb, mem_flags);
9bfa35fe
MH		 501 if (err < 0) {
502 BT_ERR("%s urb %p submission failed (%d)",
503 hdev->name, urb, -err);
504 usb_unanchor_urb(urb);
9bfa35fe
MH		 505 }
506
507 usb_free_urb(urb);
508
509 return err;
510}
511
5e23b923 512static void btusb_tx_complete(struct urb *urb)
7bee549e
ON		 513{
514 struct sk_buff *skb = urb->context;
515 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
516 struct btusb_data *data = hdev->driver_data;
517
518 BT_DBG("%s urb %p status %d count %d", hdev->name,
519 urb, urb->status, urb->actual_length);
520
521 if (!test_bit(HCI_RUNNING, &hdev->flags))
522 goto done;
523
524 if (!urb->status)
525 hdev->stat.byte_tx += urb->transfer_buffer_length;
526 else
527 hdev->stat.err_tx++;
528
529done:
530 spin_lock(&data->txlock);
531 data->tx_in_flight--;
532 spin_unlock(&data->txlock);
533
534 kfree(urb->setup_packet);
535
536 kfree_skb(skb);
537}
538
539static void btusb_isoc_tx_complete(struct urb *urb)
5e23b923
MH		 540{
541 struct sk_buff *skb = urb->context;
542 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
543
544 BT_DBG("%s urb %p status %d count %d", hdev->name,
545 urb, urb->status, urb->actual_length);
546
547 if (!test_bit(HCI_RUNNING, &hdev->flags))
548 goto done;
549
550 if (!urb->status)
551 hdev->stat.byte_tx += urb->transfer_buffer_length;
552 else
553 hdev->stat.err_tx++;
554
555done:
556 kfree(urb->setup_packet);
557
558 kfree_skb(skb);
559}
560
561static int btusb_open(struct hci_dev *hdev)
562{
563 struct btusb_data *data = hdev->driver_data;
564 int err;
565
566 BT_DBG("%s", hdev->name);
567
7bee549e
ON		 568 err = usb_autopm_get_interface(data->intf);
569 if (err < 0)
570 return err;
571
572 data->intf->needs_remote_wakeup = 1;
573
5e23b923 574 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
7bee549e 575 goto done;
5e23b923
MH		 576
577 if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
7bee549e 578 goto done;
5e23b923 579
2eda66f4 580 err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
43c2e57f
MH		 581 if (err < 0)
582 goto failed;
583
584 err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
5e23b923 585 if (err < 0) {
43c2e57f
MH		 586 usb_kill_anchored_urbs(&data->intr_anchor);
587 goto failed;
5e23b923
MH		 588 }
589
43c2e57f
MH		 590 set_bit(BTUSB_BULK_RUNNING, &data->flags);
591 btusb_submit_bulk_urb(hdev, GFP_KERNEL);
592
7bee549e
ON		 593done:
594 usb_autopm_put_interface(data->intf);
43c2e57f
MH		 595 return 0;
596
597failed:
598 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
599 clear_bit(HCI_RUNNING, &hdev->flags);
7bee549e 600 usb_autopm_put_interface(data->intf);
5e23b923
MH		 601 return err;
602}
603
7bee549e
ON		 604static void btusb_stop_traffic(struct btusb_data *data)
605{
606 usb_kill_anchored_urbs(&data->intr_anchor);
607 usb_kill_anchored_urbs(&data->bulk_anchor);
608 usb_kill_anchored_urbs(&data->isoc_anchor);
609}
610
5e23b923
MH		 611static int btusb_close(struct hci_dev *hdev)
612{
613 struct btusb_data *data = hdev->driver_data;
7bee549e 614 int err;
5e23b923
MH		 615
616 BT_DBG("%s", hdev->name);
617
618 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
619 return 0;
620
e8c3c3d2 621 cancel_work_sync(&data->work);
404291ac 622 cancel_work_sync(&data->waker);
e8c3c3d2 623
9bfa35fe 624 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
5e23b923 625 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
5e23b923 626 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
7bee549e
ON		 627
628 btusb_stop_traffic(data);
629 err = usb_autopm_get_interface(data->intf);
630 if (err < 0)
7b8e2c1d 631 goto failed;
7bee549e
ON		 632
633 data->intf->needs_remote_wakeup = 0;
634 usb_autopm_put_interface(data->intf);
5e23b923 635
7b8e2c1d
ON		 636failed:
637 usb_scuttle_anchored_urbs(&data->deferred);
5e23b923
MH		 638 return 0;
639}
640
641static int btusb_flush(struct hci_dev *hdev)
642{
643 struct btusb_data *data = hdev->driver_data;
644
645 BT_DBG("%s", hdev->name);
646
647 usb_kill_anchored_urbs(&data->tx_anchor);
648
649 return 0;
650}
651
652static int btusb_send_frame(struct sk_buff *skb)
653{
654 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
655 struct btusb_data *data = hdev->driver_data;
656 struct usb_ctrlrequest *dr;
657 struct urb *urb;
658 unsigned int pipe;
659 int err;
660
661 BT_DBG("%s", hdev->name);
662
663 if (!test_bit(HCI_RUNNING, &hdev->flags))
664 return -EBUSY;
665
666 switch (bt_cb(skb)->pkt_type) {
667 case HCI_COMMAND_PKT:
668 urb = usb_alloc_urb(0, GFP_ATOMIC);
669 if (!urb)
670 return -ENOMEM;
671
672 dr = kmalloc(sizeof(*dr), GFP_ATOMIC);
673 if (!dr) {
674 usb_free_urb(urb);
675 return -ENOMEM;
676 }
677
7a9d4020 678 dr->bRequestType = data->cmdreq_type;
5e23b923
MH		 679 dr->bRequest = 0;
680 dr->wIndex = 0;
681 dr->wValue = 0;
682 dr->wLength = __cpu_to_le16(skb->len);
683
684 pipe = usb_sndctrlpipe(data->udev, 0x00);
685
686 usb_fill_control_urb(urb, data->udev, pipe, (void *) dr,
687 skb->data, skb->len, btusb_tx_complete, skb);
688
689 hdev->stat.cmd_tx++;
690 break;
691
692 case HCI_ACLDATA_PKT:
9bfa35fe
MH		 693 if (!data->bulk_tx_ep || hdev->conn_hash.acl_num < 1)
694 return -ENODEV;
695
5e23b923
MH		 696 urb = usb_alloc_urb(0, GFP_ATOMIC);
697 if (!urb)
698 return -ENOMEM;
699
700 pipe = usb_sndbulkpipe(data->udev,
701 data->bulk_tx_ep->bEndpointAddress);
702
703 usb_fill_bulk_urb(urb, data->udev, pipe,
704 skb->data, skb->len, btusb_tx_complete, skb);
705
706 hdev->stat.acl_tx++;
707 break;
708
709 case HCI_SCODATA_PKT:
9bfa35fe
MH		 710 if (!data->isoc_tx_ep || hdev->conn_hash.sco_num < 1)
711 return -ENODEV;
712
713 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_ATOMIC);
714 if (!urb)
715 return -ENOMEM;
716
717 pipe = usb_sndisocpipe(data->udev,
718 data->isoc_tx_ep->bEndpointAddress);
719
03c2d0e8
GP		 720 usb_fill_int_urb(urb, data->udev, pipe,
721 skb->data, skb->len, btusb_isoc_tx_complete,
722 skb, data->isoc_tx_ep->bInterval);
9bfa35fe
MH		 723
724 urb->transfer_flags = URB_ISO_ASAP;
9bfa35fe
MH		 725
726 __fill_isoc_descriptor(urb, skb->len,
727 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
728
5e23b923 729 hdev->stat.sco_tx++;
7bee549e 730 goto skip_waking;
5e23b923
MH		 731
732 default:
733 return -EILSEQ;
734 }
735
7bee549e
ON		 736 err = inc_tx(data);
737 if (err) {
738 usb_anchor_urb(urb, &data->deferred);
739 schedule_work(&data->waker);
740 err = 0;
741 goto done;
742 }
743
744skip_waking:
5e23b923
MH		 745 usb_anchor_urb(urb, &data->tx_anchor);
746
747 err = usb_submit_urb(urb, GFP_ATOMIC);
748 if (err < 0) {
749 BT_ERR("%s urb %p submission failed", hdev->name, urb);
750 kfree(urb->setup_packet);
751 usb_unanchor_urb(urb);
7bee549e
ON		 752 } else {
753 usb_mark_last_busy(data->udev);
5e23b923
MH		 754 }
755
756 usb_free_urb(urb);
757
7bee549e 758done:
5e23b923
MH		 759 return err;
760}
761
762static void btusb_destruct(struct hci_dev *hdev)
763{
764 struct btusb_data *data = hdev->driver_data;
765
766 BT_DBG("%s", hdev->name);
767
768 kfree(data);
769}
770
771static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
772{
773 struct btusb_data *data = hdev->driver_data;
774
775 BT_DBG("%s evt %d", hdev->name, evt);
776
43c2e57f
MH		 777 if (hdev->conn_hash.sco_num != data->sco_num) {
778 data->sco_num = hdev->conn_hash.sco_num;
779 schedule_work(&data->work);
a780efa8 780 }
5e23b923
MH		 781}
782
42b16b3f 783static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
9bfa35fe
MH		 784{
785 struct btusb_data *data = hdev->driver_data;
786 struct usb_interface *intf = data->isoc;
787 struct usb_endpoint_descriptor *ep_desc;
788 int i, err;
789
790 if (!data->isoc)
791 return -ENODEV;
792
793 err = usb_set_interface(data->udev, 1, altsetting);
794 if (err < 0) {
795 BT_ERR("%s setting interface failed (%d)", hdev->name, -err);
796 return err;
797 }
798
799 data->isoc_altsetting = altsetting;
800
801 data->isoc_tx_ep = NULL;
802 data->isoc_rx_ep = NULL;
803
804 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
805 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
806
807 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
808 data->isoc_tx_ep = ep_desc;
809 continue;
810 }
811
812 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
813 data->isoc_rx_ep = ep_desc;
814 continue;
815 }
816 }
817
818 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
819 BT_ERR("%s invalid SCO descriptors", hdev->name);
820 return -ENODEV;
821 }
822
823 return 0;
824}
825
5e23b923
MH		 826static void btusb_work(struct work_struct *work)
827{
828 struct btusb_data *data = container_of(work, struct btusb_data, work);
829 struct hci_dev *hdev = data->hdev;
7bee549e 830 int err;
5e23b923 831
9bfa35fe 832 if (hdev->conn_hash.sco_num > 0) {
08b8b6c4 833 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
8efdd0cd 834 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
7bee549e
ON		 835 if (err < 0) {
836 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
837 usb_kill_anchored_urbs(&data->isoc_anchor);
838 return;
839 }
840
08b8b6c4 841 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
7bee549e 842 }
9bfa35fe
MH		 843 if (data->isoc_altsetting != 2) {
844 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
845 usb_kill_anchored_urbs(&data->isoc_anchor);
846
847 if (__set_isoc_interface(hdev, 2) < 0)
848 return;
849 }
850
851 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
2eda66f4 852 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
9bfa35fe
MH		 853 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
854 else
2eda66f4 855 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
9bfa35fe
MH		 856 }
857 } else {
858 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
859 usb_kill_anchored_urbs(&data->isoc_anchor);
860
861 __set_isoc_interface(hdev, 0);
08b8b6c4 862 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
8efdd0cd 863 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
5e23b923
MH		 864 }
865}
866
7bee549e
ON		 867static void btusb_waker(struct work_struct *work)
868{
869 struct btusb_data *data = container_of(work, struct btusb_data, waker);
870 int err;
871
872 err = usb_autopm_get_interface(data->intf);
873 if (err < 0)
874 return;
875
876 usb_autopm_put_interface(data->intf);
877}
878
5e23b923
MH		 879static int btusb_probe(struct usb_interface *intf,
880 const struct usb_device_id *id)
881{
882 struct usb_endpoint_descriptor *ep_desc;
883 struct btusb_data *data;
884 struct hci_dev *hdev;
885 int i, err;
886
887 BT_DBG("intf %p id %p", intf, id);
888
cfeb4145 889 /* interface numbers are hardcoded in the spec */
5e23b923
MH		 890 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
891 return -ENODEV;
892
893 if (!id->driver_info) {
894 const struct usb_device_id *match;
895 match = usb_match_id(intf, blacklist_table);
896 if (match)
897 id = match;
898 }
899
cfeb4145
MH		 900 if (id->driver_info == BTUSB_IGNORE)
901 return -ENODEV;
902
903 if (ignore_dga && id->driver_info & BTUSB_DIGIANSWER)
904 return -ENODEV;
905
906 if (ignore_csr && id->driver_info & BTUSB_CSR)
907 return -ENODEV;
908
909 if (ignore_sniffer && id->driver_info & BTUSB_SNIFFER)
910 return -ENODEV;
911
5e23b923
MH		 912 data = kzalloc(sizeof(*data), GFP_KERNEL);
913 if (!data)
914 return -ENOMEM;
915
916 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
917 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
918
919 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
920 data->intr_ep = ep_desc;
921 continue;
922 }
923
924 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
925 data->bulk_tx_ep = ep_desc;
926 continue;
927 }
928
929 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
930 data->bulk_rx_ep = ep_desc;
931 continue;
932 }
933 }
934
935 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep) {
936 kfree(data);
937 return -ENODEV;
938 }
939
7a9d4020
MH		 940 data->cmdreq_type = USB_TYPE_CLASS;
941
5e23b923 942 data->udev = interface_to_usbdev(intf);
5fbcd260 943 data->intf = intf;
5e23b923
MH		 944
945 spin_lock_init(&data->lock);
946
947 INIT_WORK(&data->work, btusb_work);
7bee549e
ON		 948 INIT_WORK(&data->waker, btusb_waker);
949 spin_lock_init(&data->txlock);
5e23b923
MH		 950
951 init_usb_anchor(&data->tx_anchor);
952 init_usb_anchor(&data->intr_anchor);
953 init_usb_anchor(&data->bulk_anchor);
9bfa35fe 954 init_usb_anchor(&data->isoc_anchor);
7bee549e 955 init_usb_anchor(&data->deferred);
5e23b923
MH		 956
957 hdev = hci_alloc_dev();
958 if (!hdev) {
959 kfree(data);
960 return -ENOMEM;
961 }
962
c13854ce 963 hdev->bus = HCI_USB;
5e23b923
MH		 964 hdev->driver_data = data;
965
966 data->hdev = hdev;
967
968 SET_HCIDEV_DEV(hdev, &intf->dev);
969
970 hdev->open = btusb_open;
971 hdev->close = btusb_close;
972 hdev->flush = btusb_flush;
973 hdev->send = btusb_send_frame;
974 hdev->destruct = btusb_destruct;
975 hdev->notify = btusb_notify;
976
977 hdev->owner = THIS_MODULE;
978
7a9d4020 979 /* Interface numbers are hardcoded in the specification */
9bfa35fe
MH		 980 data->isoc = usb_ifnum_to_if(data->udev, 1);
981
7a9d4020
MH		 982 if (!reset)
983 set_bit(HCI_QUIRK_NO_RESET, &hdev->quirks);
cfeb4145
MH		 984
985 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
986 if (!disable_scofix)
987 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
988 }
989
9bfa35fe
MH		 990 if (id->driver_info & BTUSB_BROKEN_ISOC)
991 data->isoc = NULL;
992
7a9d4020
MH		 993 if (id->driver_info & BTUSB_DIGIANSWER) {
994 data->cmdreq_type = USB_TYPE_VENDOR;
995 set_bit(HCI_QUIRK_NO_RESET, &hdev->quirks);
996 }
997
998 if (id->driver_info & BTUSB_CSR) {
999 struct usb_device *udev = data->udev;
1000
1001 /* Old firmware would otherwise execute USB reset */
1002 if (le16_to_cpu(udev->descriptor.bcdDevice) < 0x117)
1003 set_bit(HCI_QUIRK_NO_RESET, &hdev->quirks);
1004 }
1005
cfeb4145 1006 if (id->driver_info & BTUSB_SNIFFER) {
9bfa35fe 1007 struct usb_device *udev = data->udev;
cfeb4145 1008
7a9d4020 1009 /* New sniffer firmware has crippled HCI interface */
cfeb4145
MH		 1010 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
1011 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
9bfa35fe
MH		 1012
1013 data->isoc = NULL;
cfeb4145
MH		 1014 }
1015
1016 if (id->driver_info & BTUSB_BCM92035) {
1017 unsigned char cmd[] = { 0x3b, 0xfc, 0x01, 0x00 };
1018 struct sk_buff *skb;
1019
1020 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
1021 if (skb) {
1022 memcpy(skb_put(skb, sizeof(cmd)), cmd, sizeof(cmd));
1023 skb_queue_tail(&hdev->driver_init, skb);
1024 }
1025 }
5e23b923 1026
9bfa35fe
MH		 1027 if (data->isoc) {
1028 err = usb_driver_claim_interface(&btusb_driver,
5fbcd260 1029 data->isoc, data);
9bfa35fe
MH		 1030 if (err < 0) {
1031 hci_free_dev(hdev);
1032 kfree(data);
1033 return err;
1034 }
1035 }
1036
5e23b923
MH		 1037 err = hci_register_dev(hdev);
1038 if (err < 0) {
1039 hci_free_dev(hdev);
1040 kfree(data);
1041 return err;
1042 }
1043
1044 usb_set_intfdata(intf, data);
1045
1046 return 0;
1047}
1048
1049static void btusb_disconnect(struct usb_interface *intf)
1050{
1051 struct btusb_data *data = usb_get_intfdata(intf);
1052 struct hci_dev *hdev;
1053
1054 BT_DBG("intf %p", intf);
1055
1056 if (!data)
1057 return;
1058
1059 hdev = data->hdev;
1060
5fbcd260 1061 __hci_dev_hold(hdev);
9bfa35fe 1062
5fbcd260
MH		 1063 usb_set_intfdata(data->intf, NULL);
1064
1065 if (data->isoc)
1066 usb_set_intfdata(data->isoc, NULL);
5e23b923
MH		 1067
1068 hci_unregister_dev(hdev);
1069
5fbcd260
MH		 1070 if (intf == data->isoc)
1071 usb_driver_release_interface(&btusb_driver, data->intf);
1072 else if (data->isoc)
1073 usb_driver_release_interface(&btusb_driver, data->isoc);
1074
1075 __hci_dev_put(hdev);
1076
5e23b923
MH		 1077 hci_free_dev(hdev);
1078}
1079
7bee549e 1080#ifdef CONFIG_PM
6a88adf2
MH		 1081static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
1082{
1083 struct btusb_data *data = usb_get_intfdata(intf);
1084
1085 BT_DBG("intf %p", intf);
1086
1087 if (data->suspend_count++)
1088 return 0;
1089
7bee549e 1090 spin_lock_irq(&data->txlock);
fb34d537 1091 if (!((message.event & PM_EVENT_AUTO) && data->tx_in_flight)) {
7bee549e
ON		 1092 set_bit(BTUSB_SUSPENDING, &data->flags);
1093 spin_unlock_irq(&data->txlock);
1094 } else {
1095 spin_unlock_irq(&data->txlock);
1096 data->suspend_count--;
1097 return -EBUSY;
1098 }
1099
6a88adf2
MH		 1100 cancel_work_sync(&data->work);
1101
7bee549e 1102 btusb_stop_traffic(data);
6a88adf2
MH		 1103 usb_kill_anchored_urbs(&data->tx_anchor);
1104
6a88adf2
MH		 1105 return 0;
1106}
1107
7bee549e
ON		 1108static void play_deferred(struct btusb_data *data)
1109{
1110 struct urb *urb;
1111 int err;
1112
1113 while ((urb = usb_get_from_anchor(&data->deferred))) {
1114 err = usb_submit_urb(urb, GFP_ATOMIC);
1115 if (err < 0)
1116 break;
1117
1118 data->tx_in_flight++;
1119 }
1120 usb_scuttle_anchored_urbs(&data->deferred);
1121}
1122
6a88adf2
MH		 1123static int btusb_resume(struct usb_interface *intf)
1124{
1125 struct btusb_data *data = usb_get_intfdata(intf);
1126 struct hci_dev *hdev = data->hdev;
7bee549e 1127 int err = 0;
6a88adf2
MH		 1128
1129 BT_DBG("intf %p", intf);
1130
1131 if (--data->suspend_count)
1132 return 0;
1133
1134 if (!test_bit(HCI_RUNNING, &hdev->flags))
7bee549e 1135 goto done;
6a88adf2
MH		 1136
1137 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
1138 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
1139 if (err < 0) {
1140 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
7bee549e 1141 goto failed;
6a88adf2
MH		 1142 }
1143 }
1144
1145 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
43c2e57f
MH		 1146 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
1147 if (err < 0) {
6a88adf2 1148 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
7bee549e
ON		 1149 goto failed;
1150 }
1151
1152 btusb_submit_bulk_urb(hdev, GFP_NOIO);
6a88adf2
MH		 1153 }
1154
1155 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1156 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
1157 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1158 else
1159 btusb_submit_isoc_urb(hdev, GFP_NOIO);
1160 }
1161
7bee549e
ON		 1162 spin_lock_irq(&data->txlock);
1163 play_deferred(data);
1164 clear_bit(BTUSB_SUSPENDING, &data->flags);
1165 spin_unlock_irq(&data->txlock);
1166 schedule_work(&data->work);
1167
6a88adf2 1168 return 0;
7bee549e
ON		 1169
1170failed:
1171 usb_scuttle_anchored_urbs(&data->deferred);
1172done:
1173 spin_lock_irq(&data->txlock);
1174 clear_bit(BTUSB_SUSPENDING, &data->flags);
1175 spin_unlock_irq(&data->txlock);
1176
1177 return err;
6a88adf2 1178}
7bee549e 1179#endif
6a88adf2 1180
5e23b923
MH		 1181static struct usb_driver btusb_driver = {
1182 .name = "btusb",
1183 .probe = btusb_probe,
1184 .disconnect = btusb_disconnect,
7bee549e 1185#ifdef CONFIG_PM
6a88adf2
MH		 1186 .suspend = btusb_suspend,
1187 .resume = btusb_resume,
7bee549e 1188#endif
5e23b923 1189 .id_table = btusb_table,
7bee549e 1190 .supports_autosuspend = 1,
5e23b923
MH		 1191};
1192
1193static int __init btusb_init(void)
1194{
1195 BT_INFO("Generic Bluetooth USB driver ver %s", VERSION);
1196
1197 return usb_register(&btusb_driver);
1198}
1199
1200static void __exit btusb_exit(void)
1201{
1202 usb_deregister(&btusb_driver);
1203}
1204
1205module_init(btusb_init);
1206module_exit(btusb_exit);
1207
cfeb4145
MH		 1208module_param(ignore_dga, bool, 0644);
1209MODULE_PARM_DESC(ignore_dga, "Ignore devices with id 08fd:0001");
1210
1211module_param(ignore_csr, bool, 0644);
1212MODULE_PARM_DESC(ignore_csr, "Ignore devices with id 0a12:0001");
1213
1214module_param(ignore_sniffer, bool, 0644);
1215MODULE_PARM_DESC(ignore_sniffer, "Ignore devices with id 0a12:0002");
1216
1217module_param(disable_scofix, bool, 0644);
1218MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
1219
1220module_param(force_scofix, bool, 0644);
1221MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
1222
1223module_param(reset, bool, 0644);
1224MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
1225
5e23b923
MH		 1226MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
1227MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
1228MODULE_VERSION(VERSION);
1229MODULE_LICENSE("GPL");
Linux kernel - Deliverables
This page took 0.430366 seconds and 5 git commands to generate.