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;
85 spinlock_t tx_flowblock_lock;
87 struct brcmf_usbreq *tx_reqs;
88 struct brcmf_usbreq *rx_reqs;
90 u8 *image; /* buffer for combine fw and nvram */
93 struct usb_device *usbdev;
96 int ctl_in_pipe, ctl_out_pipe;
97 struct urb *ctl_urb; /* URB for control endpoint */
98 struct usb_ctrlrequest ctl_write;
99 struct usb_ctrlrequest ctl_read;
100 u32 ctl_urb_actual_length;
103 wait_queue_head_t ioctl_resp_wait;
106 struct urb *bulk_urb; /* used for FW download */
107 struct urb *intr_urb; /* URB for interrupt endpoint */
108 int intr_size; /* Size of interrupt message */
109 int interval; /* Interrupt polling interval */
110 struct intr_transfer_buf intr; /* Data buffer for interrupt endpoint */
113 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
114 struct brcmf_usbreq *req);
116 static struct brcmf_usbdev *brcmf_usb_get_buspub(struct device *dev)
118 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
119 return bus_if->bus_priv.usb;
122 static struct brcmf_usbdev_info *brcmf_usb_get_businfo(struct device *dev)
124 return brcmf_usb_get_buspub(dev)->devinfo;
127 static int brcmf_usb_ioctl_resp_wait(struct brcmf_usbdev_info *devinfo)
129 return wait_event_timeout(devinfo->ioctl_resp_wait,
130 devinfo->ctl_completed,
131 msecs_to_jiffies(IOCTL_RESP_TIMEOUT));
134 static void brcmf_usb_ioctl_resp_wake(struct brcmf_usbdev_info *devinfo)
136 if (waitqueue_active(&devinfo->ioctl_resp_wait))
137 wake_up(&devinfo->ioctl_resp_wait);
141 brcmf_usb_ctl_complete(struct brcmf_usbdev_info *devinfo, int type, int status)
143 brcmf_dbg(USB, "Enter, status=%d\n", status);
145 if (unlikely(devinfo == NULL))
148 if (type == BRCMF_USB_CBCTL_READ) {
150 devinfo->bus_pub.stats.rx_ctlpkts++;
152 devinfo->bus_pub.stats.rx_ctlerrs++;
153 } else if (type == BRCMF_USB_CBCTL_WRITE) {
155 devinfo->bus_pub.stats.tx_ctlpkts++;
157 devinfo->bus_pub.stats.tx_ctlerrs++;
160 devinfo->ctl_urb_status = status;
161 devinfo->ctl_completed = true;
162 brcmf_usb_ioctl_resp_wake(devinfo);
166 brcmf_usb_ctlread_complete(struct urb *urb)
168 struct brcmf_usbdev_info *devinfo =
169 (struct brcmf_usbdev_info *)urb->context;
171 brcmf_dbg(USB, "Enter\n");
172 devinfo->ctl_urb_actual_length = urb->actual_length;
173 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_READ,
178 brcmf_usb_ctlwrite_complete(struct urb *urb)
180 struct brcmf_usbdev_info *devinfo =
181 (struct brcmf_usbdev_info *)urb->context;
183 brcmf_dbg(USB, "Enter\n");
184 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_WRITE,
189 brcmf_usb_send_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
194 brcmf_dbg(USB, "Enter\n");
195 if (devinfo == NULL || buf == NULL ||
196 len == 0 || devinfo->ctl_urb == NULL)
200 devinfo->ctl_write.wLength = cpu_to_le16p(&size);
201 devinfo->ctl_urb->transfer_buffer_length = size;
202 devinfo->ctl_urb_status = 0;
203 devinfo->ctl_urb_actual_length = 0;
205 usb_fill_control_urb(devinfo->ctl_urb,
207 devinfo->ctl_out_pipe,
208 (unsigned char *) &devinfo->ctl_write,
210 (usb_complete_t)brcmf_usb_ctlwrite_complete,
213 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
215 brcmf_err("usb_submit_urb failed %d\n", ret);
221 brcmf_usb_recv_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
226 brcmf_dbg(USB, "Enter\n");
227 if ((devinfo == NULL) || (buf == NULL) || (len == 0)
228 || (devinfo->ctl_urb == NULL))
232 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
233 devinfo->ctl_urb->transfer_buffer_length = size;
235 devinfo->ctl_read.bRequestType = USB_DIR_IN
236 | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
237 devinfo->ctl_read.bRequest = 1;
239 usb_fill_control_urb(devinfo->ctl_urb,
241 devinfo->ctl_in_pipe,
242 (unsigned char *) &devinfo->ctl_read,
244 (usb_complete_t)brcmf_usb_ctlread_complete,
247 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
249 brcmf_err("usb_submit_urb failed %d\n", ret);
254 static int brcmf_usb_tx_ctlpkt(struct device *dev, u8 *buf, u32 len)
258 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
260 brcmf_dbg(USB, "Enter\n");
261 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
264 if (test_and_set_bit(0, &devinfo->ctl_op))
267 devinfo->ctl_completed = false;
268 err = brcmf_usb_send_ctl(devinfo, buf, len);
270 brcmf_err("fail %d bytes: %d\n", err, len);
271 clear_bit(0, &devinfo->ctl_op);
274 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
275 clear_bit(0, &devinfo->ctl_op);
277 brcmf_err("Txctl wait timed out\n");
283 static int brcmf_usb_rx_ctlpkt(struct device *dev, u8 *buf, u32 len)
287 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
289 brcmf_dbg(USB, "Enter\n");
290 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
293 if (test_and_set_bit(0, &devinfo->ctl_op))
296 devinfo->ctl_completed = false;
297 err = brcmf_usb_recv_ctl(devinfo, buf, len);
299 brcmf_err("fail %d bytes: %d\n", err, len);
300 clear_bit(0, &devinfo->ctl_op);
303 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
304 err = devinfo->ctl_urb_status;
305 clear_bit(0, &devinfo->ctl_op);
307 brcmf_err("rxctl wait timed out\n");
311 return devinfo->ctl_urb_actual_length;
316 static struct brcmf_usbreq *brcmf_usb_deq(struct brcmf_usbdev_info *devinfo,
317 struct list_head *q, int *counter)
320 struct brcmf_usbreq *req;
321 spin_lock_irqsave(&devinfo->qlock, flags);
323 spin_unlock_irqrestore(&devinfo->qlock, flags);
326 req = list_entry(q->next, struct brcmf_usbreq, list);
327 list_del_init(q->next);
330 spin_unlock_irqrestore(&devinfo->qlock, flags);
335 static void brcmf_usb_enq(struct brcmf_usbdev_info *devinfo,
336 struct list_head *q, struct brcmf_usbreq *req,
340 spin_lock_irqsave(&devinfo->qlock, flags);
341 list_add_tail(&req->list, q);
344 spin_unlock_irqrestore(&devinfo->qlock, flags);
347 static struct brcmf_usbreq *
348 brcmf_usbdev_qinit(struct list_head *q, int qsize)
351 struct brcmf_usbreq *req, *reqs;
353 reqs = kcalloc(qsize, sizeof(struct brcmf_usbreq), GFP_ATOMIC);
359 for (i = 0; i < qsize; i++) {
360 req->urb = usb_alloc_urb(0, GFP_ATOMIC);
364 INIT_LIST_HEAD(&req->list);
365 list_add_tail(&req->list, q);
370 brcmf_err("fail!\n");
371 while (!list_empty(q)) {
372 req = list_entry(q->next, struct brcmf_usbreq, list);
374 usb_free_urb(req->urb);
381 static void brcmf_usb_free_q(struct list_head *q, bool pending)
383 struct brcmf_usbreq *req, *next;
385 list_for_each_entry_safe(req, next, q, list) {
387 brcmf_err("bad req\n");
392 usb_kill_urb(req->urb);
394 usb_free_urb(req->urb);
395 list_del_init(&req->list);
400 static void brcmf_usb_del_fromq(struct brcmf_usbdev_info *devinfo,
401 struct brcmf_usbreq *req)
405 spin_lock_irqsave(&devinfo->qlock, flags);
406 list_del_init(&req->list);
407 spin_unlock_irqrestore(&devinfo->qlock, flags);
411 static void brcmf_usb_tx_complete(struct urb *urb)
413 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
414 struct brcmf_usbdev_info *devinfo = req->devinfo;
417 brcmf_dbg(USB, "Enter, urb->status=%d, skb=%p\n", urb->status,
419 brcmf_usb_del_fromq(devinfo, req);
421 brcmf_txcomplete(devinfo->dev, req->skb, urb->status == 0);
423 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req, &devinfo->tx_freecount);
424 spin_lock_irqsave(&devinfo->tx_flowblock_lock, flags);
425 if (devinfo->tx_freecount > devinfo->tx_high_watermark &&
426 devinfo->tx_flowblock) {
427 brcmf_txflowblock(devinfo->dev, false);
428 devinfo->tx_flowblock = false;
430 spin_unlock_irqrestore(&devinfo->tx_flowblock_lock, flags);
433 static void brcmf_usb_rx_complete(struct urb *urb)
435 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
436 struct brcmf_usbdev_info *devinfo = req->devinfo;
438 struct sk_buff_head skbq;
440 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
441 brcmf_usb_del_fromq(devinfo, req);
445 /* zero lenght packets indicate usb "failure". Do not refill */
446 if (urb->status != 0 || !urb->actual_length) {
447 brcmu_pkt_buf_free_skb(skb);
448 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
452 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
453 skb_queue_head_init(&skbq);
454 skb_queue_tail(&skbq, skb);
455 skb_put(skb, urb->actual_length);
456 brcmf_rx_frames(devinfo->dev, &skbq);
457 brcmf_usb_rx_refill(devinfo, req);
459 brcmu_pkt_buf_free_skb(skb);
460 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
466 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
467 struct brcmf_usbreq *req)
472 if (!req || !devinfo)
475 skb = dev_alloc_skb(devinfo->bus_pub.bus_mtu);
477 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
482 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->rx_pipe,
483 skb->data, skb_tailroom(skb), brcmf_usb_rx_complete,
485 req->devinfo = devinfo;
486 brcmf_usb_enq(devinfo, &devinfo->rx_postq, req, NULL);
488 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
490 brcmf_usb_del_fromq(devinfo, req);
491 brcmu_pkt_buf_free_skb(req->skb);
493 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
498 static void brcmf_usb_rx_fill_all(struct brcmf_usbdev_info *devinfo)
500 struct brcmf_usbreq *req;
502 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
503 brcmf_err("bus is not up=%d\n", devinfo->bus_pub.state);
506 while ((req = brcmf_usb_deq(devinfo, &devinfo->rx_freeq, NULL)) != NULL)
507 brcmf_usb_rx_refill(devinfo, req);
511 brcmf_usb_state_change(struct brcmf_usbdev_info *devinfo, int state)
513 struct brcmf_bus *bcmf_bus = devinfo->bus_pub.bus;
516 brcmf_dbg(USB, "Enter, current state=%d, new state=%d\n",
517 devinfo->bus_pub.state, state);
519 if (devinfo->bus_pub.state == state)
522 old_state = devinfo->bus_pub.state;
523 devinfo->bus_pub.state = state;
525 /* update state of upper layer */
526 if (state == BRCMFMAC_USB_STATE_DOWN) {
527 brcmf_dbg(USB, "DBUS is down\n");
528 bcmf_bus->state = BRCMF_BUS_DOWN;
529 } else if (state == BRCMFMAC_USB_STATE_UP) {
530 brcmf_dbg(USB, "DBUS is up\n");
531 bcmf_bus->state = BRCMF_BUS_DATA;
533 brcmf_dbg(USB, "DBUS current state=%d\n", state);
538 brcmf_usb_intr_complete(struct urb *urb)
540 struct brcmf_usbdev_info *devinfo =
541 (struct brcmf_usbdev_info *)urb->context;
544 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
549 if (unlikely(urb->status)) {
550 if (urb->status == -ENOENT ||
551 urb->status == -ESHUTDOWN ||
552 urb->status == -ENODEV) {
553 brcmf_usb_state_change(devinfo,
554 BRCMFMAC_USB_STATE_DOWN);
558 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN) {
559 brcmf_err("intr cb when DBUS down, ignoring\n");
563 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
564 err = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
566 brcmf_err("usb_submit_urb, err=%d\n", err);
570 static int brcmf_usb_tx(struct device *dev, struct sk_buff *skb)
572 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
573 struct brcmf_usbreq *req;
577 brcmf_dbg(USB, "Enter, skb=%p\n", skb);
578 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
583 req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
584 &devinfo->tx_freecount);
586 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);
602 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
603 &devinfo->tx_freecount);
607 spin_lock_irqsave(&devinfo->tx_flowblock_lock, flags);
608 if (devinfo->tx_freecount < devinfo->tx_low_watermark &&
609 !devinfo->tx_flowblock) {
610 brcmf_txflowblock(dev, true);
611 devinfo->tx_flowblock = true;
613 spin_unlock_irqrestore(&devinfo->tx_flowblock_lock, flags);
617 brcmf_txcomplete(dev, skb, false);
622 static int brcmf_usb_up(struct device *dev)
624 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
628 brcmf_dbg(USB, "Enter\n");
629 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
632 /* Success, indicate devinfo is fully up */
633 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
635 if (devinfo->intr_urb) {
636 usb_fill_int_urb(devinfo->intr_urb, devinfo->usbdev,
640 (usb_complete_t)brcmf_usb_intr_complete,
644 ret = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
646 brcmf_err("USB_SUBMIT_URB failed with status %d\n",
652 if (devinfo->ctl_urb) {
653 devinfo->ctl_in_pipe = usb_rcvctrlpipe(devinfo->usbdev, 0);
654 devinfo->ctl_out_pipe = usb_sndctrlpipe(devinfo->usbdev, 0);
656 ifnum = IFDESC(devinfo->usbdev, CONTROL_IF).bInterfaceNumber;
659 devinfo->ctl_write.bRequestType =
660 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
661 devinfo->ctl_write.bRequest = 0;
662 devinfo->ctl_write.wValue = cpu_to_le16(0);
663 devinfo->ctl_write.wIndex = cpu_to_le16p(&ifnum);
666 devinfo->ctl_read.bRequestType =
667 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
668 devinfo->ctl_read.bRequest = 1;
669 devinfo->ctl_read.wValue = cpu_to_le16(0);
670 devinfo->ctl_read.wIndex = cpu_to_le16p(&ifnum);
672 brcmf_usb_rx_fill_all(devinfo);
676 static void brcmf_usb_down(struct device *dev)
678 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
680 brcmf_dbg(USB, "Enter\n");
684 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
687 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
688 if (devinfo->intr_urb)
689 usb_kill_urb(devinfo->intr_urb);
691 if (devinfo->ctl_urb)
692 usb_kill_urb(devinfo->ctl_urb);
694 if (devinfo->bulk_urb)
695 usb_kill_urb(devinfo->bulk_urb);
696 brcmf_usb_free_q(&devinfo->tx_postq, true);
698 brcmf_usb_free_q(&devinfo->rx_postq, true);
702 brcmf_usb_sync_complete(struct urb *urb)
704 struct brcmf_usbdev_info *devinfo =
705 (struct brcmf_usbdev_info *)urb->context;
707 devinfo->ctl_completed = true;
708 brcmf_usb_ioctl_resp_wake(devinfo);
711 static bool brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
712 void *buffer, int buflen)
718 if ((!devinfo) || (devinfo->ctl_urb == NULL))
721 tmpbuf = kmalloc(buflen, GFP_ATOMIC);
726 devinfo->ctl_urb->transfer_buffer_length = size;
728 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
729 devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
731 devinfo->ctl_read.bRequest = cmd;
733 usb_fill_control_urb(devinfo->ctl_urb,
735 usb_rcvctrlpipe(devinfo->usbdev, 0),
736 (unsigned char *) &devinfo->ctl_read,
737 (void *) tmpbuf, size,
738 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
740 devinfo->ctl_completed = false;
741 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
743 brcmf_err("usb_submit_urb failed %d\n", ret);
748 ret = brcmf_usb_ioctl_resp_wait(devinfo);
749 memcpy(buffer, tmpbuf, buflen);
756 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
758 struct bootrom_id_le id;
761 brcmf_dbg(USB, "Enter\n");
766 /* Check if firmware downloaded already by querying runtime ID */
767 id.chip = cpu_to_le32(0xDEAD);
768 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
770 chipid = le32_to_cpu(id.chip);
771 chiprev = le32_to_cpu(id.chiprev);
773 if ((chipid & 0x4300) == 0x4300)
774 brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
776 brcmf_dbg(USB, "chip %d rev 0x%x\n", chipid, chiprev);
777 if (chipid == BRCMF_POSTBOOT_ID) {
778 brcmf_dbg(USB, "firmware already downloaded\n");
779 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
782 devinfo->bus_pub.devid = chipid;
783 devinfo->bus_pub.chiprev = chiprev;
789 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
791 struct bootrom_id_le id;
794 brcmf_dbg(USB, "Enter\n");
798 mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
800 id.chip = cpu_to_le32(0xDEAD); /* Get the ID */
801 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
802 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
804 } while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
806 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID)) {
807 brcmf_dbg(USB, "postboot chip 0x%x/rev 0x%x\n",
808 le32_to_cpu(id.chip), le32_to_cpu(id.chiprev));
810 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
813 brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
814 BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
821 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
825 if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
828 /* Prepare the URB */
829 usb_fill_bulk_urb(devinfo->bulk_urb, devinfo->usbdev,
830 devinfo->tx_pipe, buffer, len,
831 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
833 devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
835 devinfo->ctl_completed = false;
836 ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
838 brcmf_err("usb_submit_urb failed %d\n", ret);
841 ret = brcmf_usb_ioctl_resp_wait(devinfo);
846 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
848 unsigned int sendlen, sent, dllen;
849 char *bulkchunk = NULL, *dlpos;
850 struct rdl_state_le state;
851 u32 rdlstate, rdlbytes;
854 brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
856 bulkchunk = kmalloc(RDL_CHUNK, GFP_ATOMIC);
857 if (bulkchunk == NULL) {
862 /* 1) Prepare USB boot loader for runtime image */
863 brcmf_usb_dl_cmd(devinfo, DL_START, &state,
864 sizeof(struct rdl_state_le));
866 rdlstate = le32_to_cpu(state.state);
867 rdlbytes = le32_to_cpu(state.bytes);
869 /* 2) Check we are in the Waiting state */
870 if (rdlstate != DL_WAITING) {
871 brcmf_err("Failed to DL_START\n");
879 /* Get chip id and rev */
880 while (rdlbytes != dllen) {
881 /* Wait until the usb device reports it received all
882 * the bytes we sent */
883 if ((rdlbytes == sent) && (rdlbytes != dllen)) {
884 if ((dllen-sent) < RDL_CHUNK)
885 sendlen = dllen-sent;
889 /* simply avoid having to send a ZLP by ensuring we
897 memcpy(bulkchunk, dlpos, sendlen);
898 if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
900 brcmf_err("send_bulk failed\n");
908 if (!brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
909 sizeof(struct rdl_state_le))) {
910 brcmf_err("DL_GETSTATE Failed xxxx\n");
915 rdlstate = le32_to_cpu(state.state);
916 rdlbytes = le32_to_cpu(state.bytes);
918 /* restart if an error is reported */
919 if (rdlstate == DL_BAD_HDR || rdlstate == DL_BAD_CRC) {
920 brcmf_err("Bad Hdr or Bad CRC state %d\n",
929 brcmf_dbg(USB, "Exit, err=%d\n", err);
933 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
937 brcmf_dbg(USB, "Enter\n");
942 if (devinfo->bus_pub.devid == 0xDEAD)
945 err = brcmf_usb_dl_writeimage(devinfo, fw, len);
947 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
949 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
950 brcmf_dbg(USB, "Exit, err=%d\n", err);
955 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
957 struct rdl_state_le state;
959 brcmf_dbg(USB, "Enter\n");
963 if (devinfo->bus_pub.devid == 0xDEAD)
966 /* Check we are runnable */
967 brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
968 sizeof(struct rdl_state_le));
970 /* Start the image */
971 if (state.state == cpu_to_le32(DL_RUNNABLE)) {
972 if (!brcmf_usb_dl_cmd(devinfo, DL_GO, &state,
973 sizeof(struct rdl_state_le)))
975 if (brcmf_usb_resetcfg(devinfo))
977 /* The Dongle may go for re-enumeration. */
979 brcmf_err("Dongle not runnable\n");
982 brcmf_dbg(USB, "Exit\n");
986 static bool brcmf_usb_chip_support(int chipid, int chiprev)
994 return (chiprev == 3);
1004 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
1009 brcmf_dbg(USB, "Enter\n");
1010 if (devinfo == NULL)
1013 devid = devinfo->bus_pub.devid;
1014 chiprev = devinfo->bus_pub.chiprev;
1016 if (!brcmf_usb_chip_support(devid, chiprev)) {
1017 brcmf_err("unsupported chip %d rev %d\n",
1022 if (!devinfo->image) {
1023 brcmf_err("No firmware!\n");
1027 err = brcmf_usb_dlstart(devinfo,
1028 devinfo->image, devinfo->image_len);
1030 err = brcmf_usb_dlrun(devinfo);
1035 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1037 brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1040 brcmf_usb_free_q(&devinfo->rx_freeq, false);
1041 brcmf_usb_free_q(&devinfo->tx_freeq, false);
1043 usb_free_urb(devinfo->intr_urb);
1044 usb_free_urb(devinfo->ctl_urb);
1045 usb_free_urb(devinfo->bulk_urb);
1047 kfree(devinfo->tx_reqs);
1048 kfree(devinfo->rx_reqs);
1051 #define TRX_MAGIC 0x30524448 /* "HDR0" */
1052 #define TRX_VERSION 1 /* Version 1 */
1053 #define TRX_MAX_LEN 0x3B0000 /* Max length */
1054 #define TRX_NO_HEADER 1 /* Do not write TRX header */
1055 #define TRX_MAX_OFFSET 3 /* Max number of individual files */
1056 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed image */
1058 struct trx_header_le {
1059 __le32 magic; /* "HDR0" */
1060 __le32 len; /* Length of file including header */
1061 __le32 crc32; /* CRC from flag_version to end of file */
1062 __le32 flag_version; /* 0:15 flags, 16:31 version */
1063 __le32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of
1067 static int check_file(const u8 *headers)
1069 struct trx_header_le *trx;
1070 int actual_len = -1;
1072 brcmf_dbg(USB, "Enter\n");
1073 /* Extract trx header */
1074 trx = (struct trx_header_le *) headers;
1075 if (trx->magic != cpu_to_le32(TRX_MAGIC))
1078 headers += sizeof(struct trx_header_le);
1080 if (le32_to_cpu(trx->flag_version) & TRX_UNCOMP_IMAGE) {
1081 actual_len = le32_to_cpu(trx->offsets[TRX_OFFSETS_DLFWLEN_IDX]);
1082 return actual_len + sizeof(struct trx_header_le);
1087 static int brcmf_usb_get_fw(struct brcmf_usbdev_info *devinfo)
1090 const struct firmware *fw;
1091 struct brcmf_usb_image *fw_image;
1094 brcmf_dbg(USB, "Enter\n");
1095 switch (devinfo->bus_pub.devid) {
1097 fwname = BRCMF_USB_43143_FW_NAME;
1102 fwname = BRCMF_USB_43236_FW_NAME;
1105 fwname = BRCMF_USB_43242_FW_NAME;
1111 brcmf_dbg(USB, "Loading FW %s\n", fwname);
1112 list_for_each_entry(fw_image, &fw_image_list, list) {
1113 if (fw_image->fwname == fwname) {
1114 devinfo->image = fw_image->image;
1115 devinfo->image_len = fw_image->image_len;
1119 /* fw image not yet loaded. Load it now and add to list */
1120 err = request_firmware(&fw, fwname, devinfo->dev);
1122 brcmf_err("fail to request firmware %s\n", fwname);
1125 if (check_file(fw->data) < 0) {
1126 brcmf_err("invalid firmware %s\n", fwname);
1130 fw_image = kzalloc(sizeof(*fw_image), GFP_ATOMIC);
1133 INIT_LIST_HEAD(&fw_image->list);
1134 list_add_tail(&fw_image->list, &fw_image_list);
1135 fw_image->fwname = fwname;
1136 fw_image->image = vmalloc(fw->size);
1137 if (!fw_image->image)
1140 memcpy(fw_image->image, fw->data, fw->size);
1141 fw_image->image_len = fw->size;
1143 release_firmware(fw);
1145 devinfo->image = fw_image->image;
1146 devinfo->image_len = fw_image->image_len;
1153 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1156 brcmf_dbg(USB, "Enter\n");
1158 devinfo->bus_pub.nrxq = nrxq;
1159 devinfo->rx_low_watermark = nrxq / 2;
1160 devinfo->bus_pub.devinfo = devinfo;
1161 devinfo->bus_pub.ntxq = ntxq;
1162 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DOWN;
1164 /* flow control when too many tx urbs posted */
1165 devinfo->tx_low_watermark = ntxq / 4;
1166 devinfo->tx_high_watermark = devinfo->tx_low_watermark * 3;
1167 devinfo->bus_pub.bus_mtu = BRCMF_USB_MAX_PKT_SIZE;
1169 /* Initialize other structure content */
1170 init_waitqueue_head(&devinfo->ioctl_resp_wait);
1172 /* Initialize the spinlocks */
1173 spin_lock_init(&devinfo->qlock);
1174 spin_lock_init(&devinfo->tx_flowblock_lock);
1176 INIT_LIST_HEAD(&devinfo->rx_freeq);
1177 INIT_LIST_HEAD(&devinfo->rx_postq);
1179 INIT_LIST_HEAD(&devinfo->tx_freeq);
1180 INIT_LIST_HEAD(&devinfo->tx_postq);
1182 devinfo->tx_flowblock = false;
1184 devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1185 if (!devinfo->rx_reqs)
1188 devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1189 if (!devinfo->tx_reqs)
1191 devinfo->tx_freecount = ntxq;
1193 devinfo->intr_urb = usb_alloc_urb(0, GFP_ATOMIC);
1194 if (!devinfo->intr_urb) {
1195 brcmf_err("usb_alloc_urb (intr) failed\n");
1198 devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1199 if (!devinfo->ctl_urb) {
1200 brcmf_err("usb_alloc_urb (ctl) failed\n");
1203 devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1204 if (!devinfo->bulk_urb) {
1205 brcmf_err("usb_alloc_urb (bulk) failed\n");
1209 if (!brcmf_usb_dlneeded(devinfo))
1210 return &devinfo->bus_pub;
1212 brcmf_dbg(USB, "Start fw downloading\n");
1213 if (brcmf_usb_get_fw(devinfo))
1216 if (brcmf_usb_fw_download(devinfo))
1219 return &devinfo->bus_pub;
1222 brcmf_err("failed!\n");
1223 brcmf_usb_detach(devinfo);
1227 static struct brcmf_bus_ops brcmf_usb_bus_ops = {
1228 .txdata = brcmf_usb_tx,
1229 .init = brcmf_usb_up,
1230 .stop = brcmf_usb_down,
1231 .txctl = brcmf_usb_tx_ctlpkt,
1232 .rxctl = brcmf_usb_rx_ctlpkt,
1235 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1237 struct brcmf_bus *bus = NULL;
1238 struct brcmf_usbdev *bus_pub = NULL;
1240 struct device *dev = devinfo->dev;
1242 brcmf_dbg(USB, "Enter\n");
1243 bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1247 bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1255 bus->bus_priv.usb = bus_pub;
1256 dev_set_drvdata(dev, bus);
1257 bus->ops = &brcmf_usb_bus_ops;
1258 bus->chip = bus_pub->devid;
1259 bus->chiprev = bus_pub->chiprev;
1261 /* Attach to the common driver interface */
1262 ret = brcmf_attach(0, dev);
1264 brcmf_err("brcmf_attach failed\n");
1268 ret = brcmf_bus_start(dev);
1270 brcmf_err("dongle is not responding\n");
1277 /* Release resources in reverse order */
1279 brcmf_usb_detach(devinfo);
1284 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1288 brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1290 brcmf_detach(devinfo->dev);
1291 kfree(devinfo->bus_pub.bus);
1292 brcmf_usb_detach(devinfo);
1296 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1299 struct usb_endpoint_descriptor *endpoint;
1301 struct usb_device *usb = interface_to_usbdev(intf);
1304 struct brcmf_usbdev_info *devinfo;
1306 brcmf_dbg(USB, "Enter\n");
1308 devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1309 if (devinfo == NULL)
1312 devinfo->usbdev = usb;
1313 devinfo->dev = &usb->dev;
1315 usb_set_intfdata(intf, devinfo);
1317 /* Check that the device supports only one configuration */
1318 if (usb->descriptor.bNumConfigurations != 1) {
1323 if (usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) {
1329 * Only the BDC interface configuration is supported:
1330 * Device class: USB_CLASS_VENDOR_SPEC
1331 * if0 class: USB_CLASS_VENDOR_SPEC
1334 * if0/ep2: bulk out (ok if swapped with bulk in)
1336 if (CONFIGDESC(usb)->bNumInterfaces != 1) {
1341 /* Check interface */
1342 if (IFDESC(usb, CONTROL_IF).bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
1343 IFDESC(usb, CONTROL_IF).bInterfaceSubClass != 2 ||
1344 IFDESC(usb, CONTROL_IF).bInterfaceProtocol != 0xff) {
1345 brcmf_err("invalid control interface: class %d, subclass %d, proto %d\n",
1346 IFDESC(usb, CONTROL_IF).bInterfaceClass,
1347 IFDESC(usb, CONTROL_IF).bInterfaceSubClass,
1348 IFDESC(usb, CONTROL_IF).bInterfaceProtocol);
1353 /* Check control endpoint */
1354 endpoint = &IFEPDESC(usb, CONTROL_IF, 0);
1355 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1356 != USB_ENDPOINT_XFER_INT) {
1357 brcmf_err("invalid control endpoint %d\n",
1358 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
1363 endpoint_num = endpoint->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1364 devinfo->intr_pipe = usb_rcvintpipe(usb, endpoint_num);
1366 devinfo->rx_pipe = 0;
1367 devinfo->rx_pipe2 = 0;
1368 devinfo->tx_pipe = 0;
1369 num_of_eps = IFDESC(usb, BULK_IF).bNumEndpoints - 1;
1371 /* Check data endpoints and get pipes */
1372 for (ep = 1; ep <= num_of_eps; ep++) {
1373 endpoint = &IFEPDESC(usb, BULK_IF, ep);
1374 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1375 USB_ENDPOINT_XFER_BULK) {
1376 brcmf_err("invalid data endpoint %d\n", ep);
1381 endpoint_num = endpoint->bEndpointAddress &
1382 USB_ENDPOINT_NUMBER_MASK;
1383 if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1385 if (!devinfo->rx_pipe) {
1387 usb_rcvbulkpipe(usb, endpoint_num);
1390 usb_rcvbulkpipe(usb, endpoint_num);
1393 devinfo->tx_pipe = usb_sndbulkpipe(usb, endpoint_num);
1397 /* Allocate interrupt URB and data buffer */
1398 /* RNDIS says 8-byte intr, our old drivers used 4-byte */
1399 if (IFEPDESC(usb, CONTROL_IF, 0).wMaxPacketSize == cpu_to_le16(16))
1400 devinfo->intr_size = 8;
1402 devinfo->intr_size = 4;
1404 devinfo->interval = IFEPDESC(usb, CONTROL_IF, 0).bInterval;
1406 if (usb->speed == USB_SPEED_HIGH)
1407 brcmf_dbg(USB, "Broadcom high speed USB wireless device detected\n");
1409 brcmf_dbg(USB, "Broadcom full speed USB wireless device detected\n");
1411 ret = brcmf_usb_probe_cb(devinfo);
1419 brcmf_err("failed with errno %d\n", ret);
1421 usb_set_intfdata(intf, NULL);
1427 brcmf_usb_disconnect(struct usb_interface *intf)
1429 struct brcmf_usbdev_info *devinfo;
1431 brcmf_dbg(USB, "Enter\n");
1432 devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1433 brcmf_usb_disconnect_cb(devinfo);
1435 brcmf_dbg(USB, "Exit\n");
1439 * only need to signal the bus being down and update the state.
1441 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1443 struct usb_device *usb = interface_to_usbdev(intf);
1444 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1446 brcmf_dbg(USB, "Enter\n");
1447 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1448 brcmf_detach(&usb->dev);
1453 * (re-) start the bus.
1455 static int brcmf_usb_resume(struct usb_interface *intf)
1457 struct usb_device *usb = interface_to_usbdev(intf);
1458 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1460 brcmf_dbg(USB, "Enter\n");
1461 if (!brcmf_attach(0, devinfo->dev))
1462 return brcmf_bus_start(&usb->dev);
1467 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1469 struct usb_device *usb = interface_to_usbdev(intf);
1470 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1472 brcmf_dbg(USB, "Enter\n");
1474 if (!brcmf_usb_fw_download(devinfo))
1475 return brcmf_usb_resume(intf);
1480 #define BRCMF_USB_VENDOR_ID_BROADCOM 0x0a5c
1481 #define BRCMF_USB_DEVICE_ID_43143 0xbd1e
1482 #define BRCMF_USB_DEVICE_ID_43236 0xbd17
1483 #define BRCMF_USB_DEVICE_ID_43242 0xbd1f
1484 #define BRCMF_USB_DEVICE_ID_BCMFW 0x0bdc
1486 static struct usb_device_id brcmf_usb_devid_table[] = {
1487 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43143) },
1488 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43236) },
1489 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43242) },
1490 /* special entry for device with firmware loaded and running */
1491 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_BCMFW) },
1495 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1496 MODULE_FIRMWARE(BRCMF_USB_43143_FW_NAME);
1497 MODULE_FIRMWARE(BRCMF_USB_43236_FW_NAME);
1498 MODULE_FIRMWARE(BRCMF_USB_43242_FW_NAME);
1500 static struct usb_driver brcmf_usbdrvr = {
1501 .name = KBUILD_MODNAME,
1502 .probe = brcmf_usb_probe,
1503 .disconnect = brcmf_usb_disconnect,
1504 .id_table = brcmf_usb_devid_table,
1505 .suspend = brcmf_usb_suspend,
1506 .resume = brcmf_usb_resume,
1507 .reset_resume = brcmf_usb_reset_resume,
1508 .supports_autosuspend = 1,
1509 .disable_hub_initiated_lpm = 1,
1512 static void brcmf_release_fw(struct list_head *q)
1514 struct brcmf_usb_image *fw_image, *next;
1516 list_for_each_entry_safe(fw_image, next, q, list) {
1517 vfree(fw_image->image);
1518 list_del_init(&fw_image->list);
1522 static int brcmf_usb_reset_device(struct device *dev, void *notused)
1524 /* device past is the usb interface so we
1525 * need to use parent here.
1527 brcmf_dev_reset(dev->parent);
1531 void brcmf_usb_exit(void)
1533 struct device_driver *drv = &brcmf_usbdrvr.drvwrap.driver;
1536 brcmf_dbg(USB, "Enter\n");
1537 ret = driver_for_each_device(drv, NULL, NULL,
1538 brcmf_usb_reset_device);
1539 usb_deregister(&brcmf_usbdrvr);
1540 brcmf_release_fw(&fw_image_list);
1543 void brcmf_usb_init(void)
1545 brcmf_dbg(USB, "Enter\n");
1546 INIT_LIST_HEAD(&fw_image_list);
1547 usb_register(&brcmf_usbdrvr);