2 * Copyright (c) 2011 Broadcom Corporation
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/firmware.h>
20 #include <linux/usb.h>
21 #include <linux/vmalloc.h>
23 #include <brcmu_utils.h>
24 #include <brcmu_wifi.h>
31 #define IOCTL_RESP_TIMEOUT 2000
33 #define BRCMF_USB_RESET_GETVER_SPINWAIT 100 /* in unit of ms */
34 #define BRCMF_USB_RESET_GETVER_LOOP_CNT 10
36 #define BRCMF_POSTBOOT_ID 0xA123 /* ID to detect if dongle
38 #define BRCMF_USB_NRXQ 50
39 #define BRCMF_USB_NTXQ 50
41 #define CONFIGDESC(usb) (&((usb)->actconfig)->desc)
42 #define IFPTR(usb, idx) ((usb)->actconfig->interface[(idx)])
43 #define IFALTS(usb, idx) (IFPTR((usb), (idx))->altsetting[0])
44 #define IFDESC(usb, idx) IFALTS((usb), (idx)).desc
45 #define IFEPDESC(usb, idx, ep) (IFALTS((usb), (idx)).endpoint[(ep)]).desc
50 #define BRCMF_USB_CBCTL_WRITE 0
51 #define BRCMF_USB_CBCTL_READ 1
52 #define BRCMF_USB_MAX_PKT_SIZE 1600
54 #define BRCMF_USB_43143_FW_NAME "brcm/brcmfmac43143.bin"
55 #define BRCMF_USB_43236_FW_NAME "brcm/brcmfmac43236b.bin"
56 #define BRCMF_USB_43242_FW_NAME "brcm/brcmfmac43242a.bin"
58 struct brcmf_usb_image {
59 struct list_head list;
64 static struct list_head fw_image_list;
66 struct intr_transfer_buf {
71 struct brcmf_usbdev_info {
72 struct brcmf_usbdev bus_pub; /* MUST BE FIRST */
74 struct list_head rx_freeq;
75 struct list_head rx_postq;
76 struct list_head tx_freeq;
77 struct list_head tx_postq;
78 uint rx_pipe, tx_pipe, intr_pipe, rx_pipe2;
82 int tx_high_watermark;
86 struct brcmf_usbreq *tx_reqs;
87 struct brcmf_usbreq *rx_reqs;
89 u8 *image; /* buffer for combine fw and nvram */
92 struct usb_device *usbdev;
95 int ctl_in_pipe, ctl_out_pipe;
96 struct urb *ctl_urb; /* URB for control endpoint */
97 struct usb_ctrlrequest ctl_write;
98 struct usb_ctrlrequest ctl_read;
99 u32 ctl_urb_actual_length;
102 wait_queue_head_t ioctl_resp_wait;
105 struct urb *bulk_urb; /* used for FW download */
106 struct urb *intr_urb; /* URB for interrupt endpoint */
107 int intr_size; /* Size of interrupt message */
108 int interval; /* Interrupt polling interval */
109 struct intr_transfer_buf intr; /* Data buffer for interrupt endpoint */
112 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
113 struct brcmf_usbreq *req);
115 MODULE_AUTHOR("Broadcom Corporation");
116 MODULE_DESCRIPTION("Broadcom 802.11n wireless LAN fullmac usb driver.");
117 MODULE_SUPPORTED_DEVICE("Broadcom 802.11n WLAN fullmac usb cards");
118 MODULE_LICENSE("Dual BSD/GPL");
120 static struct brcmf_usbdev *brcmf_usb_get_buspub(struct device *dev)
122 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
123 return bus_if->bus_priv.usb;
126 static struct brcmf_usbdev_info *brcmf_usb_get_businfo(struct device *dev)
128 return brcmf_usb_get_buspub(dev)->devinfo;
131 static int brcmf_usb_ioctl_resp_wait(struct brcmf_usbdev_info *devinfo)
133 return wait_event_timeout(devinfo->ioctl_resp_wait,
134 devinfo->ctl_completed,
135 msecs_to_jiffies(IOCTL_RESP_TIMEOUT));
138 static void brcmf_usb_ioctl_resp_wake(struct brcmf_usbdev_info *devinfo)
140 if (waitqueue_active(&devinfo->ioctl_resp_wait))
141 wake_up(&devinfo->ioctl_resp_wait);
145 brcmf_usb_ctl_complete(struct brcmf_usbdev_info *devinfo, int type, int status)
147 brcmf_dbg(USB, "Enter, status=%d\n", status);
149 if (unlikely(devinfo == NULL))
152 if (type == BRCMF_USB_CBCTL_READ) {
154 devinfo->bus_pub.stats.rx_ctlpkts++;
156 devinfo->bus_pub.stats.rx_ctlerrs++;
157 } else if (type == BRCMF_USB_CBCTL_WRITE) {
159 devinfo->bus_pub.stats.tx_ctlpkts++;
161 devinfo->bus_pub.stats.tx_ctlerrs++;
164 devinfo->ctl_urb_status = status;
165 devinfo->ctl_completed = true;
166 brcmf_usb_ioctl_resp_wake(devinfo);
170 brcmf_usb_ctlread_complete(struct urb *urb)
172 struct brcmf_usbdev_info *devinfo =
173 (struct brcmf_usbdev_info *)urb->context;
175 brcmf_dbg(USB, "Enter\n");
176 devinfo->ctl_urb_actual_length = urb->actual_length;
177 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_READ,
182 brcmf_usb_ctlwrite_complete(struct urb *urb)
184 struct brcmf_usbdev_info *devinfo =
185 (struct brcmf_usbdev_info *)urb->context;
187 brcmf_dbg(USB, "Enter\n");
188 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_WRITE,
193 brcmf_usb_send_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
198 brcmf_dbg(USB, "Enter\n");
199 if (devinfo == NULL || buf == NULL ||
200 len == 0 || devinfo->ctl_urb == NULL)
204 devinfo->ctl_write.wLength = cpu_to_le16p(&size);
205 devinfo->ctl_urb->transfer_buffer_length = size;
206 devinfo->ctl_urb_status = 0;
207 devinfo->ctl_urb_actual_length = 0;
209 usb_fill_control_urb(devinfo->ctl_urb,
211 devinfo->ctl_out_pipe,
212 (unsigned char *) &devinfo->ctl_write,
214 (usb_complete_t)brcmf_usb_ctlwrite_complete,
217 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
219 brcmf_err("usb_submit_urb failed %d\n", ret);
225 brcmf_usb_recv_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
230 brcmf_dbg(USB, "Enter\n");
231 if ((devinfo == NULL) || (buf == NULL) || (len == 0)
232 || (devinfo->ctl_urb == NULL))
236 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
237 devinfo->ctl_urb->transfer_buffer_length = size;
239 devinfo->ctl_read.bRequestType = USB_DIR_IN
240 | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
241 devinfo->ctl_read.bRequest = 1;
243 usb_fill_control_urb(devinfo->ctl_urb,
245 devinfo->ctl_in_pipe,
246 (unsigned char *) &devinfo->ctl_read,
248 (usb_complete_t)brcmf_usb_ctlread_complete,
251 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
253 brcmf_err("usb_submit_urb failed %d\n", ret);
258 static int brcmf_usb_tx_ctlpkt(struct device *dev, u8 *buf, u32 len)
262 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
264 brcmf_dbg(USB, "Enter\n");
265 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
268 if (test_and_set_bit(0, &devinfo->ctl_op))
271 devinfo->ctl_completed = false;
272 err = brcmf_usb_send_ctl(devinfo, buf, len);
274 brcmf_err("fail %d bytes: %d\n", err, len);
275 clear_bit(0, &devinfo->ctl_op);
278 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
279 clear_bit(0, &devinfo->ctl_op);
281 brcmf_err("Txctl wait timed out\n");
287 static int brcmf_usb_rx_ctlpkt(struct device *dev, u8 *buf, u32 len)
291 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
293 brcmf_dbg(USB, "Enter\n");
294 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
297 if (test_and_set_bit(0, &devinfo->ctl_op))
300 devinfo->ctl_completed = false;
301 err = brcmf_usb_recv_ctl(devinfo, buf, len);
303 brcmf_err("fail %d bytes: %d\n", err, len);
304 clear_bit(0, &devinfo->ctl_op);
307 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
308 err = devinfo->ctl_urb_status;
309 clear_bit(0, &devinfo->ctl_op);
311 brcmf_err("rxctl wait timed out\n");
315 return devinfo->ctl_urb_actual_length;
320 static struct brcmf_usbreq *brcmf_usb_deq(struct brcmf_usbdev_info *devinfo,
321 struct list_head *q, int *counter)
324 struct brcmf_usbreq *req;
325 spin_lock_irqsave(&devinfo->qlock, flags);
327 spin_unlock_irqrestore(&devinfo->qlock, flags);
330 req = list_entry(q->next, struct brcmf_usbreq, list);
331 list_del_init(q->next);
334 spin_unlock_irqrestore(&devinfo->qlock, flags);
339 static void brcmf_usb_enq(struct brcmf_usbdev_info *devinfo,
340 struct list_head *q, struct brcmf_usbreq *req,
344 spin_lock_irqsave(&devinfo->qlock, flags);
345 list_add_tail(&req->list, q);
348 spin_unlock_irqrestore(&devinfo->qlock, flags);
351 static struct brcmf_usbreq *
352 brcmf_usbdev_qinit(struct list_head *q, int qsize)
355 struct brcmf_usbreq *req, *reqs;
357 reqs = kcalloc(qsize, sizeof(struct brcmf_usbreq), GFP_ATOMIC);
363 for (i = 0; i < qsize; i++) {
364 req->urb = usb_alloc_urb(0, GFP_ATOMIC);
368 INIT_LIST_HEAD(&req->list);
369 list_add_tail(&req->list, q);
374 brcmf_err("fail!\n");
375 while (!list_empty(q)) {
376 req = list_entry(q->next, struct brcmf_usbreq, list);
378 usb_free_urb(req->urb);
385 static void brcmf_usb_free_q(struct list_head *q, bool pending)
387 struct brcmf_usbreq *req, *next;
389 list_for_each_entry_safe(req, next, q, list) {
391 brcmf_err("bad req\n");
396 usb_kill_urb(req->urb);
398 usb_free_urb(req->urb);
399 list_del_init(&req->list);
404 static void brcmf_usb_del_fromq(struct brcmf_usbdev_info *devinfo,
405 struct brcmf_usbreq *req)
409 spin_lock_irqsave(&devinfo->qlock, flags);
410 list_del_init(&req->list);
411 spin_unlock_irqrestore(&devinfo->qlock, flags);
415 static void brcmf_usb_tx_complete(struct urb *urb)
417 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
418 struct brcmf_usbdev_info *devinfo = req->devinfo;
420 brcmf_dbg(USB, "Enter, urb->status=%d, skb=%p\n", urb->status,
422 brcmf_usb_del_fromq(devinfo, req);
424 brcmf_txcomplete(devinfo->dev, req->skb, urb->status == 0);
426 brcmu_pkt_buf_free_skb(req->skb);
428 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req, &devinfo->tx_freecount);
429 if (devinfo->tx_freecount > devinfo->tx_high_watermark &&
430 devinfo->tx_flowblock) {
431 brcmf_txflowblock(devinfo->dev, false);
432 devinfo->tx_flowblock = false;
436 static void brcmf_usb_rx_complete(struct urb *urb)
438 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
439 struct brcmf_usbdev_info *devinfo = req->devinfo;
441 struct sk_buff_head skbq;
443 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
444 brcmf_usb_del_fromq(devinfo, req);
448 /* zero lenght packets indicate usb "failure". Do not refill */
449 if (urb->status != 0 || !urb->actual_length) {
450 brcmu_pkt_buf_free_skb(skb);
451 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
455 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
456 skb_queue_head_init(&skbq);
457 skb_queue_tail(&skbq, skb);
458 skb_put(skb, urb->actual_length);
459 brcmf_rx_frames(devinfo->dev, &skbq);
460 brcmf_usb_rx_refill(devinfo, req);
462 brcmu_pkt_buf_free_skb(skb);
463 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
469 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
470 struct brcmf_usbreq *req)
475 if (!req || !devinfo)
478 skb = dev_alloc_skb(devinfo->bus_pub.bus_mtu);
480 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
485 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->rx_pipe,
486 skb->data, skb_tailroom(skb), brcmf_usb_rx_complete,
488 req->devinfo = devinfo;
489 brcmf_usb_enq(devinfo, &devinfo->rx_postq, req, NULL);
491 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
493 brcmf_usb_del_fromq(devinfo, req);
494 brcmu_pkt_buf_free_skb(req->skb);
496 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
501 static void brcmf_usb_rx_fill_all(struct brcmf_usbdev_info *devinfo)
503 struct brcmf_usbreq *req;
505 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
506 brcmf_err("bus is not up=%d\n", devinfo->bus_pub.state);
509 while ((req = brcmf_usb_deq(devinfo, &devinfo->rx_freeq, NULL)) != NULL)
510 brcmf_usb_rx_refill(devinfo, req);
514 brcmf_usb_state_change(struct brcmf_usbdev_info *devinfo, int state)
516 struct brcmf_bus *bcmf_bus = devinfo->bus_pub.bus;
519 brcmf_dbg(USB, "Enter, current state=%d, new state=%d\n",
520 devinfo->bus_pub.state, state);
522 if (devinfo->bus_pub.state == state)
525 old_state = devinfo->bus_pub.state;
526 devinfo->bus_pub.state = state;
528 /* update state of upper layer */
529 if (state == BRCMFMAC_USB_STATE_DOWN) {
530 brcmf_dbg(USB, "DBUS is down\n");
531 bcmf_bus->state = BRCMF_BUS_DOWN;
532 } else if (state == BRCMFMAC_USB_STATE_UP) {
533 brcmf_dbg(USB, "DBUS is up\n");
534 bcmf_bus->state = BRCMF_BUS_DATA;
536 brcmf_dbg(USB, "DBUS current state=%d\n", state);
541 brcmf_usb_intr_complete(struct urb *urb)
543 struct brcmf_usbdev_info *devinfo =
544 (struct brcmf_usbdev_info *)urb->context;
547 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
552 if (unlikely(urb->status)) {
553 if (urb->status == -ENOENT ||
554 urb->status == -ESHUTDOWN ||
555 urb->status == -ENODEV) {
556 brcmf_usb_state_change(devinfo,
557 BRCMFMAC_USB_STATE_DOWN);
561 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN) {
562 brcmf_err("intr cb when DBUS down, ignoring\n");
566 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
567 err = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
569 brcmf_err("usb_submit_urb, err=%d\n", err);
573 static int brcmf_usb_tx(struct device *dev, struct sk_buff *skb)
575 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
576 struct brcmf_usbreq *req;
579 brcmf_dbg(USB, "Enter, skb=%p\n", skb);
580 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
583 req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
584 &devinfo->tx_freecount);
586 brcmu_pkt_buf_free_skb(skb);
587 brcmf_err("no req to send\n");
592 req->devinfo = devinfo;
593 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->tx_pipe,
594 skb->data, skb->len, brcmf_usb_tx_complete, req);
595 req->urb->transfer_flags |= URB_ZERO_PACKET;
596 brcmf_usb_enq(devinfo, &devinfo->tx_postq, req, NULL);
597 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
599 brcmf_err("brcmf_usb_tx usb_submit_urb FAILED\n");
600 brcmf_usb_del_fromq(devinfo, req);
601 brcmu_pkt_buf_free_skb(req->skb);
603 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
604 &devinfo->tx_freecount);
606 if (devinfo->tx_freecount < devinfo->tx_low_watermark &&
607 !devinfo->tx_flowblock) {
608 brcmf_txflowblock(dev, true);
609 devinfo->tx_flowblock = true;
617 static int brcmf_usb_up(struct device *dev)
619 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
623 brcmf_dbg(USB, "Enter\n");
624 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
627 /* Success, indicate devinfo is fully up */
628 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
630 if (devinfo->intr_urb) {
631 usb_fill_int_urb(devinfo->intr_urb, devinfo->usbdev,
635 (usb_complete_t)brcmf_usb_intr_complete,
639 ret = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
641 brcmf_err("USB_SUBMIT_URB failed with status %d\n",
647 if (devinfo->ctl_urb) {
648 devinfo->ctl_in_pipe = usb_rcvctrlpipe(devinfo->usbdev, 0);
649 devinfo->ctl_out_pipe = usb_sndctrlpipe(devinfo->usbdev, 0);
651 ifnum = IFDESC(devinfo->usbdev, CONTROL_IF).bInterfaceNumber;
654 devinfo->ctl_write.bRequestType =
655 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
656 devinfo->ctl_write.bRequest = 0;
657 devinfo->ctl_write.wValue = cpu_to_le16(0);
658 devinfo->ctl_write.wIndex = cpu_to_le16p(&ifnum);
661 devinfo->ctl_read.bRequestType =
662 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
663 devinfo->ctl_read.bRequest = 1;
664 devinfo->ctl_read.wValue = cpu_to_le16(0);
665 devinfo->ctl_read.wIndex = cpu_to_le16p(&ifnum);
667 brcmf_usb_rx_fill_all(devinfo);
671 static void brcmf_usb_down(struct device *dev)
673 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
675 brcmf_dbg(USB, "Enter\n");
679 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
682 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
683 if (devinfo->intr_urb)
684 usb_kill_urb(devinfo->intr_urb);
686 if (devinfo->ctl_urb)
687 usb_kill_urb(devinfo->ctl_urb);
689 if (devinfo->bulk_urb)
690 usb_kill_urb(devinfo->bulk_urb);
691 brcmf_usb_free_q(&devinfo->tx_postq, true);
693 brcmf_usb_free_q(&devinfo->rx_postq, true);
697 brcmf_usb_sync_complete(struct urb *urb)
699 struct brcmf_usbdev_info *devinfo =
700 (struct brcmf_usbdev_info *)urb->context;
702 devinfo->ctl_completed = true;
703 brcmf_usb_ioctl_resp_wake(devinfo);
706 static bool brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
707 void *buffer, int buflen)
713 if ((!devinfo) || (devinfo->ctl_urb == NULL))
716 tmpbuf = kmalloc(buflen, GFP_ATOMIC);
721 devinfo->ctl_urb->transfer_buffer_length = size;
723 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
724 devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
726 devinfo->ctl_read.bRequest = cmd;
728 usb_fill_control_urb(devinfo->ctl_urb,
730 usb_rcvctrlpipe(devinfo->usbdev, 0),
731 (unsigned char *) &devinfo->ctl_read,
732 (void *) tmpbuf, size,
733 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
735 devinfo->ctl_completed = false;
736 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
738 brcmf_err("usb_submit_urb failed %d\n", ret);
743 ret = brcmf_usb_ioctl_resp_wait(devinfo);
744 memcpy(buffer, tmpbuf, buflen);
751 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
753 struct bootrom_id_le id;
756 brcmf_dbg(USB, "Enter\n");
761 /* Check if firmware downloaded already by querying runtime ID */
762 id.chip = cpu_to_le32(0xDEAD);
763 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
765 chipid = le32_to_cpu(id.chip);
766 chiprev = le32_to_cpu(id.chiprev);
768 if ((chipid & 0x4300) == 0x4300)
769 brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
771 brcmf_dbg(USB, "chip %d rev 0x%x\n", chipid, chiprev);
772 if (chipid == BRCMF_POSTBOOT_ID) {
773 brcmf_dbg(USB, "firmware already downloaded\n");
774 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
777 devinfo->bus_pub.devid = chipid;
778 devinfo->bus_pub.chiprev = chiprev;
784 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
786 struct bootrom_id_le id;
789 brcmf_dbg(USB, "Enter\n");
793 mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
795 id.chip = cpu_to_le32(0xDEAD); /* Get the ID */
796 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
797 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
799 } while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
801 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID)) {
802 brcmf_dbg(USB, "postboot chip 0x%x/rev 0x%x\n",
803 le32_to_cpu(id.chip), le32_to_cpu(id.chiprev));
805 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
808 brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
809 BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
816 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
820 if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
823 /* Prepare the URB */
824 usb_fill_bulk_urb(devinfo->bulk_urb, devinfo->usbdev,
825 devinfo->tx_pipe, buffer, len,
826 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
828 devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
830 devinfo->ctl_completed = false;
831 ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
833 brcmf_err("usb_submit_urb failed %d\n", ret);
836 ret = brcmf_usb_ioctl_resp_wait(devinfo);
841 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
843 unsigned int sendlen, sent, dllen;
844 char *bulkchunk = NULL, *dlpos;
845 struct rdl_state_le state;
846 u32 rdlstate, rdlbytes;
849 brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
851 bulkchunk = kmalloc(RDL_CHUNK, GFP_ATOMIC);
852 if (bulkchunk == NULL) {
857 /* 1) Prepare USB boot loader for runtime image */
858 brcmf_usb_dl_cmd(devinfo, DL_START, &state,
859 sizeof(struct rdl_state_le));
861 rdlstate = le32_to_cpu(state.state);
862 rdlbytes = le32_to_cpu(state.bytes);
864 /* 2) Check we are in the Waiting state */
865 if (rdlstate != DL_WAITING) {
866 brcmf_err("Failed to DL_START\n");
874 /* Get chip id and rev */
875 while (rdlbytes != dllen) {
876 /* Wait until the usb device reports it received all
877 * the bytes we sent */
878 if ((rdlbytes == sent) && (rdlbytes != dllen)) {
879 if ((dllen-sent) < RDL_CHUNK)
880 sendlen = dllen-sent;
884 /* simply avoid having to send a ZLP by ensuring we
892 memcpy(bulkchunk, dlpos, sendlen);
893 if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
895 brcmf_err("send_bulk failed\n");
903 if (!brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
904 sizeof(struct rdl_state_le))) {
905 brcmf_err("DL_GETSTATE Failed xxxx\n");
910 rdlstate = le32_to_cpu(state.state);
911 rdlbytes = le32_to_cpu(state.bytes);
913 /* restart if an error is reported */
914 if (rdlstate == DL_BAD_HDR || rdlstate == DL_BAD_CRC) {
915 brcmf_err("Bad Hdr or Bad CRC state %d\n",
924 brcmf_dbg(USB, "Exit, err=%d\n", err);
928 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
932 brcmf_dbg(USB, "Enter\n");
937 if (devinfo->bus_pub.devid == 0xDEAD)
940 err = brcmf_usb_dl_writeimage(devinfo, fw, len);
942 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
944 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
945 brcmf_dbg(USB, "Exit, err=%d\n", err);
950 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
952 struct rdl_state_le state;
954 brcmf_dbg(USB, "Enter\n");
958 if (devinfo->bus_pub.devid == 0xDEAD)
961 /* Check we are runnable */
962 brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
963 sizeof(struct rdl_state_le));
965 /* Start the image */
966 if (state.state == cpu_to_le32(DL_RUNNABLE)) {
967 if (!brcmf_usb_dl_cmd(devinfo, DL_GO, &state,
968 sizeof(struct rdl_state_le)))
970 if (brcmf_usb_resetcfg(devinfo))
972 /* The Dongle may go for re-enumeration. */
974 brcmf_err("Dongle not runnable\n");
977 brcmf_dbg(USB, "Exit\n");
981 static bool brcmf_usb_chip_support(int chipid, int chiprev)
989 return (chiprev == 3);
999 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
1004 brcmf_dbg(USB, "Enter\n");
1005 if (devinfo == NULL)
1008 devid = devinfo->bus_pub.devid;
1009 chiprev = devinfo->bus_pub.chiprev;
1011 if (!brcmf_usb_chip_support(devid, chiprev)) {
1012 brcmf_err("unsupported chip %d rev %d\n",
1017 if (!devinfo->image) {
1018 brcmf_err("No firmware!\n");
1022 err = brcmf_usb_dlstart(devinfo,
1023 devinfo->image, devinfo->image_len);
1025 err = brcmf_usb_dlrun(devinfo);
1030 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1032 brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1035 brcmf_usb_free_q(&devinfo->rx_freeq, false);
1036 brcmf_usb_free_q(&devinfo->tx_freeq, false);
1038 usb_free_urb(devinfo->intr_urb);
1039 usb_free_urb(devinfo->ctl_urb);
1040 usb_free_urb(devinfo->bulk_urb);
1042 kfree(devinfo->tx_reqs);
1043 kfree(devinfo->rx_reqs);
1046 #define TRX_MAGIC 0x30524448 /* "HDR0" */
1047 #define TRX_VERSION 1 /* Version 1 */
1048 #define TRX_MAX_LEN 0x3B0000 /* Max length */
1049 #define TRX_NO_HEADER 1 /* Do not write TRX header */
1050 #define TRX_MAX_OFFSET 3 /* Max number of individual files */
1051 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed image */
1053 struct trx_header_le {
1054 __le32 magic; /* "HDR0" */
1055 __le32 len; /* Length of file including header */
1056 __le32 crc32; /* CRC from flag_version to end of file */
1057 __le32 flag_version; /* 0:15 flags, 16:31 version */
1058 __le32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of
1062 static int check_file(const u8 *headers)
1064 struct trx_header_le *trx;
1065 int actual_len = -1;
1067 brcmf_dbg(USB, "Enter\n");
1068 /* Extract trx header */
1069 trx = (struct trx_header_le *) headers;
1070 if (trx->magic != cpu_to_le32(TRX_MAGIC))
1073 headers += sizeof(struct trx_header_le);
1075 if (le32_to_cpu(trx->flag_version) & TRX_UNCOMP_IMAGE) {
1076 actual_len = le32_to_cpu(trx->offsets[TRX_OFFSETS_DLFWLEN_IDX]);
1077 return actual_len + sizeof(struct trx_header_le);
1082 static int brcmf_usb_get_fw(struct brcmf_usbdev_info *devinfo)
1085 const struct firmware *fw;
1086 struct brcmf_usb_image *fw_image;
1089 brcmf_dbg(USB, "Enter\n");
1090 switch (devinfo->bus_pub.devid) {
1092 fwname = BRCMF_USB_43143_FW_NAME;
1097 fwname = BRCMF_USB_43236_FW_NAME;
1100 fwname = BRCMF_USB_43242_FW_NAME;
1106 brcmf_dbg(USB, "Loading FW %s\n", fwname);
1107 list_for_each_entry(fw_image, &fw_image_list, list) {
1108 if (fw_image->fwname == fwname) {
1109 devinfo->image = fw_image->image;
1110 devinfo->image_len = fw_image->image_len;
1114 /* fw image not yet loaded. Load it now and add to list */
1115 err = request_firmware(&fw, fwname, devinfo->dev);
1117 brcmf_err("fail to request firmware %s\n", fwname);
1120 if (check_file(fw->data) < 0) {
1121 brcmf_err("invalid firmware %s\n", fwname);
1125 fw_image = kzalloc(sizeof(*fw_image), GFP_ATOMIC);
1128 INIT_LIST_HEAD(&fw_image->list);
1129 list_add_tail(&fw_image->list, &fw_image_list);
1130 fw_image->fwname = fwname;
1131 fw_image->image = vmalloc(fw->size);
1132 if (!fw_image->image)
1135 memcpy(fw_image->image, fw->data, fw->size);
1136 fw_image->image_len = fw->size;
1138 release_firmware(fw);
1140 devinfo->image = fw_image->image;
1141 devinfo->image_len = fw_image->image_len;
1148 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1151 brcmf_dbg(USB, "Enter\n");
1153 devinfo->bus_pub.nrxq = nrxq;
1154 devinfo->rx_low_watermark = nrxq / 2;
1155 devinfo->bus_pub.devinfo = devinfo;
1156 devinfo->bus_pub.ntxq = ntxq;
1157 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DOWN;
1159 /* flow control when too many tx urbs posted */
1160 devinfo->tx_low_watermark = ntxq / 4;
1161 devinfo->tx_high_watermark = devinfo->tx_low_watermark * 3;
1162 devinfo->bus_pub.bus_mtu = BRCMF_USB_MAX_PKT_SIZE;
1164 /* Initialize other structure content */
1165 init_waitqueue_head(&devinfo->ioctl_resp_wait);
1167 /* Initialize the spinlocks */
1168 spin_lock_init(&devinfo->qlock);
1170 INIT_LIST_HEAD(&devinfo->rx_freeq);
1171 INIT_LIST_HEAD(&devinfo->rx_postq);
1173 INIT_LIST_HEAD(&devinfo->tx_freeq);
1174 INIT_LIST_HEAD(&devinfo->tx_postq);
1176 devinfo->tx_flowblock = false;
1178 devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1179 if (!devinfo->rx_reqs)
1182 devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1183 if (!devinfo->tx_reqs)
1185 devinfo->tx_freecount = ntxq;
1187 devinfo->intr_urb = usb_alloc_urb(0, GFP_ATOMIC);
1188 if (!devinfo->intr_urb) {
1189 brcmf_err("usb_alloc_urb (intr) failed\n");
1192 devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1193 if (!devinfo->ctl_urb) {
1194 brcmf_err("usb_alloc_urb (ctl) failed\n");
1197 devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1198 if (!devinfo->bulk_urb) {
1199 brcmf_err("usb_alloc_urb (bulk) failed\n");
1203 if (!brcmf_usb_dlneeded(devinfo))
1204 return &devinfo->bus_pub;
1206 brcmf_dbg(USB, "Start fw downloading\n");
1207 if (brcmf_usb_get_fw(devinfo))
1210 if (brcmf_usb_fw_download(devinfo))
1213 return &devinfo->bus_pub;
1216 brcmf_err("failed!\n");
1217 brcmf_usb_detach(devinfo);
1221 static struct brcmf_bus_ops brcmf_usb_bus_ops = {
1222 .txdata = brcmf_usb_tx,
1223 .init = brcmf_usb_up,
1224 .stop = brcmf_usb_down,
1225 .txctl = brcmf_usb_tx_ctlpkt,
1226 .rxctl = brcmf_usb_rx_ctlpkt,
1229 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1231 struct brcmf_bus *bus = NULL;
1232 struct brcmf_usbdev *bus_pub = NULL;
1234 struct device *dev = devinfo->dev;
1236 brcmf_dbg(USB, "Enter\n");
1237 bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1241 bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1249 bus->bus_priv.usb = bus_pub;
1250 dev_set_drvdata(dev, bus);
1251 bus->ops = &brcmf_usb_bus_ops;
1252 bus->chip = bus_pub->devid;
1253 bus->chiprev = bus_pub->chiprev;
1255 /* Attach to the common driver interface */
1256 ret = brcmf_attach(0, dev);
1258 brcmf_err("brcmf_attach failed\n");
1262 ret = brcmf_bus_start(dev);
1264 brcmf_err("dongle is not responding\n");
1271 /* Release resources in reverse order */
1273 brcmf_usb_detach(devinfo);
1278 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1282 brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1284 brcmf_detach(devinfo->dev);
1285 kfree(devinfo->bus_pub.bus);
1286 brcmf_usb_detach(devinfo);
1290 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1293 struct usb_endpoint_descriptor *endpoint;
1295 struct usb_device *usb = interface_to_usbdev(intf);
1298 struct brcmf_usbdev_info *devinfo;
1300 brcmf_dbg(USB, "Enter\n");
1302 devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1303 if (devinfo == NULL)
1306 devinfo->usbdev = usb;
1307 devinfo->dev = &usb->dev;
1309 usb_set_intfdata(intf, devinfo);
1311 /* Check that the device supports only one configuration */
1312 if (usb->descriptor.bNumConfigurations != 1) {
1317 if (usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) {
1323 * Only the BDC interface configuration is supported:
1324 * Device class: USB_CLASS_VENDOR_SPEC
1325 * if0 class: USB_CLASS_VENDOR_SPEC
1328 * if0/ep2: bulk out (ok if swapped with bulk in)
1330 if (CONFIGDESC(usb)->bNumInterfaces != 1) {
1335 /* Check interface */
1336 if (IFDESC(usb, CONTROL_IF).bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
1337 IFDESC(usb, CONTROL_IF).bInterfaceSubClass != 2 ||
1338 IFDESC(usb, CONTROL_IF).bInterfaceProtocol != 0xff) {
1339 brcmf_err("invalid control interface: class %d, subclass %d, proto %d\n",
1340 IFDESC(usb, CONTROL_IF).bInterfaceClass,
1341 IFDESC(usb, CONTROL_IF).bInterfaceSubClass,
1342 IFDESC(usb, CONTROL_IF).bInterfaceProtocol);
1347 /* Check control endpoint */
1348 endpoint = &IFEPDESC(usb, CONTROL_IF, 0);
1349 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1350 != USB_ENDPOINT_XFER_INT) {
1351 brcmf_err("invalid control endpoint %d\n",
1352 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
1357 endpoint_num = endpoint->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1358 devinfo->intr_pipe = usb_rcvintpipe(usb, endpoint_num);
1360 devinfo->rx_pipe = 0;
1361 devinfo->rx_pipe2 = 0;
1362 devinfo->tx_pipe = 0;
1363 num_of_eps = IFDESC(usb, BULK_IF).bNumEndpoints - 1;
1365 /* Check data endpoints and get pipes */
1366 for (ep = 1; ep <= num_of_eps; ep++) {
1367 endpoint = &IFEPDESC(usb, BULK_IF, ep);
1368 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1369 USB_ENDPOINT_XFER_BULK) {
1370 brcmf_err("invalid data endpoint %d\n", ep);
1375 endpoint_num = endpoint->bEndpointAddress &
1376 USB_ENDPOINT_NUMBER_MASK;
1377 if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1379 if (!devinfo->rx_pipe) {
1381 usb_rcvbulkpipe(usb, endpoint_num);
1384 usb_rcvbulkpipe(usb, endpoint_num);
1387 devinfo->tx_pipe = usb_sndbulkpipe(usb, endpoint_num);
1391 /* Allocate interrupt URB and data buffer */
1392 /* RNDIS says 8-byte intr, our old drivers used 4-byte */
1393 if (IFEPDESC(usb, CONTROL_IF, 0).wMaxPacketSize == cpu_to_le16(16))
1394 devinfo->intr_size = 8;
1396 devinfo->intr_size = 4;
1398 devinfo->interval = IFEPDESC(usb, CONTROL_IF, 0).bInterval;
1400 if (usb->speed == USB_SPEED_HIGH)
1401 brcmf_dbg(USB, "Broadcom high speed USB wireless device detected\n");
1403 brcmf_dbg(USB, "Broadcom full speed USB wireless device detected\n");
1405 ret = brcmf_usb_probe_cb(devinfo);
1413 brcmf_err("failed with errno %d\n", ret);
1415 usb_set_intfdata(intf, NULL);
1421 brcmf_usb_disconnect(struct usb_interface *intf)
1423 struct brcmf_usbdev_info *devinfo;
1425 brcmf_dbg(USB, "Enter\n");
1426 devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1427 brcmf_usb_disconnect_cb(devinfo);
1429 brcmf_dbg(USB, "Exit\n");
1433 * only need to signal the bus being down and update the state.
1435 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1437 struct usb_device *usb = interface_to_usbdev(intf);
1438 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1440 brcmf_dbg(USB, "Enter\n");
1441 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1442 brcmf_detach(&usb->dev);
1447 * (re-) start the bus.
1449 static int brcmf_usb_resume(struct usb_interface *intf)
1451 struct usb_device *usb = interface_to_usbdev(intf);
1452 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1454 brcmf_dbg(USB, "Enter\n");
1455 if (!brcmf_attach(0, devinfo->dev))
1456 return brcmf_bus_start(&usb->dev);
1461 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1463 struct usb_device *usb = interface_to_usbdev(intf);
1464 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1466 brcmf_dbg(USB, "Enter\n");
1468 if (!brcmf_usb_fw_download(devinfo))
1469 return brcmf_usb_resume(intf);
1474 #define BRCMF_USB_VENDOR_ID_BROADCOM 0x0a5c
1475 #define BRCMF_USB_DEVICE_ID_43143 0xbd1e
1476 #define BRCMF_USB_DEVICE_ID_43236 0xbd17
1477 #define BRCMF_USB_DEVICE_ID_43242 0xbd1f
1478 #define BRCMF_USB_DEVICE_ID_BCMFW 0x0bdc
1480 static struct usb_device_id brcmf_usb_devid_table[] = {
1481 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43143) },
1482 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43236) },
1483 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43242) },
1484 /* special entry for device with firmware loaded and running */
1485 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_BCMFW) },
1488 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1489 MODULE_FIRMWARE(BRCMF_USB_43143_FW_NAME);
1490 MODULE_FIRMWARE(BRCMF_USB_43236_FW_NAME);
1491 MODULE_FIRMWARE(BRCMF_USB_43242_FW_NAME);
1493 static struct usb_driver brcmf_usbdrvr = {
1494 .name = KBUILD_MODNAME,
1495 .probe = brcmf_usb_probe,
1496 .disconnect = brcmf_usb_disconnect,
1497 .id_table = brcmf_usb_devid_table,
1498 .suspend = brcmf_usb_suspend,
1499 .resume = brcmf_usb_resume,
1500 .reset_resume = brcmf_usb_reset_resume,
1501 .supports_autosuspend = 1,
1502 .disable_hub_initiated_lpm = 1,
1505 static void brcmf_release_fw(struct list_head *q)
1507 struct brcmf_usb_image *fw_image, *next;
1509 list_for_each_entry_safe(fw_image, next, q, list) {
1510 vfree(fw_image->image);
1511 list_del_init(&fw_image->list);
1515 static int brcmf_usb_reset_device(struct device *dev, void *notused)
1517 /* device past is the usb interface so we
1518 * need to use parent here.
1520 brcmf_dev_reset(dev->parent);
1524 void brcmf_usb_exit(void)
1526 struct device_driver *drv = &brcmf_usbdrvr.drvwrap.driver;
1529 brcmf_dbg(USB, "Enter\n");
1530 ret = driver_for_each_device(drv, NULL, NULL,
1531 brcmf_usb_reset_device);
1532 usb_deregister(&brcmf_usbdrvr);
1533 brcmf_release_fw(&fw_image_list);
1536 void brcmf_usb_init(void)
1538 brcmf_dbg(USB, "Enter\n");
1539 INIT_LIST_HEAD(&fw_image_list);
1540 usb_register(&brcmf_usbdrvr);