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 static struct brcmf_usbdev *brcmf_usb_get_buspub(struct device *dev)
117 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
118 return bus_if->bus_priv.usb;
121 static struct brcmf_usbdev_info *brcmf_usb_get_businfo(struct device *dev)
123 return brcmf_usb_get_buspub(dev)->devinfo;
126 static int brcmf_usb_ioctl_resp_wait(struct brcmf_usbdev_info *devinfo)
128 return wait_event_timeout(devinfo->ioctl_resp_wait,
129 devinfo->ctl_completed,
130 msecs_to_jiffies(IOCTL_RESP_TIMEOUT));
133 static void brcmf_usb_ioctl_resp_wake(struct brcmf_usbdev_info *devinfo)
135 if (waitqueue_active(&devinfo->ioctl_resp_wait))
136 wake_up(&devinfo->ioctl_resp_wait);
140 brcmf_usb_ctl_complete(struct brcmf_usbdev_info *devinfo, int type, int status)
142 brcmf_dbg(USB, "Enter, status=%d\n", status);
144 if (unlikely(devinfo == NULL))
147 if (type == BRCMF_USB_CBCTL_READ) {
149 devinfo->bus_pub.stats.rx_ctlpkts++;
151 devinfo->bus_pub.stats.rx_ctlerrs++;
152 } else if (type == BRCMF_USB_CBCTL_WRITE) {
154 devinfo->bus_pub.stats.tx_ctlpkts++;
156 devinfo->bus_pub.stats.tx_ctlerrs++;
159 devinfo->ctl_urb_status = status;
160 devinfo->ctl_completed = true;
161 brcmf_usb_ioctl_resp_wake(devinfo);
165 brcmf_usb_ctlread_complete(struct urb *urb)
167 struct brcmf_usbdev_info *devinfo =
168 (struct brcmf_usbdev_info *)urb->context;
170 brcmf_dbg(USB, "Enter\n");
171 devinfo->ctl_urb_actual_length = urb->actual_length;
172 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_READ,
177 brcmf_usb_ctlwrite_complete(struct urb *urb)
179 struct brcmf_usbdev_info *devinfo =
180 (struct brcmf_usbdev_info *)urb->context;
182 brcmf_dbg(USB, "Enter\n");
183 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_WRITE,
188 brcmf_usb_send_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
193 brcmf_dbg(USB, "Enter\n");
194 if (devinfo == NULL || buf == NULL ||
195 len == 0 || devinfo->ctl_urb == NULL)
199 devinfo->ctl_write.wLength = cpu_to_le16p(&size);
200 devinfo->ctl_urb->transfer_buffer_length = size;
201 devinfo->ctl_urb_status = 0;
202 devinfo->ctl_urb_actual_length = 0;
204 usb_fill_control_urb(devinfo->ctl_urb,
206 devinfo->ctl_out_pipe,
207 (unsigned char *) &devinfo->ctl_write,
209 (usb_complete_t)brcmf_usb_ctlwrite_complete,
212 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
214 brcmf_err("usb_submit_urb failed %d\n", ret);
220 brcmf_usb_recv_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
225 brcmf_dbg(USB, "Enter\n");
226 if ((devinfo == NULL) || (buf == NULL) || (len == 0)
227 || (devinfo->ctl_urb == NULL))
231 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
232 devinfo->ctl_urb->transfer_buffer_length = size;
234 devinfo->ctl_read.bRequestType = USB_DIR_IN
235 | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
236 devinfo->ctl_read.bRequest = 1;
238 usb_fill_control_urb(devinfo->ctl_urb,
240 devinfo->ctl_in_pipe,
241 (unsigned char *) &devinfo->ctl_read,
243 (usb_complete_t)brcmf_usb_ctlread_complete,
246 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
248 brcmf_err("usb_submit_urb failed %d\n", ret);
253 static int brcmf_usb_tx_ctlpkt(struct device *dev, u8 *buf, u32 len)
257 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
259 brcmf_dbg(USB, "Enter\n");
260 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
263 if (test_and_set_bit(0, &devinfo->ctl_op))
266 devinfo->ctl_completed = false;
267 err = brcmf_usb_send_ctl(devinfo, buf, len);
269 brcmf_err("fail %d bytes: %d\n", err, len);
270 clear_bit(0, &devinfo->ctl_op);
273 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
274 clear_bit(0, &devinfo->ctl_op);
276 brcmf_err("Txctl wait timed out\n");
282 static int brcmf_usb_rx_ctlpkt(struct device *dev, u8 *buf, u32 len)
286 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
288 brcmf_dbg(USB, "Enter\n");
289 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
292 if (test_and_set_bit(0, &devinfo->ctl_op))
295 devinfo->ctl_completed = false;
296 err = brcmf_usb_recv_ctl(devinfo, buf, len);
298 brcmf_err("fail %d bytes: %d\n", err, len);
299 clear_bit(0, &devinfo->ctl_op);
302 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
303 err = devinfo->ctl_urb_status;
304 clear_bit(0, &devinfo->ctl_op);
306 brcmf_err("rxctl wait timed out\n");
310 return devinfo->ctl_urb_actual_length;
315 static struct brcmf_usbreq *brcmf_usb_deq(struct brcmf_usbdev_info *devinfo,
316 struct list_head *q, int *counter)
319 struct brcmf_usbreq *req;
320 spin_lock_irqsave(&devinfo->qlock, flags);
322 spin_unlock_irqrestore(&devinfo->qlock, flags);
325 req = list_entry(q->next, struct brcmf_usbreq, list);
326 list_del_init(q->next);
329 spin_unlock_irqrestore(&devinfo->qlock, flags);
334 static void brcmf_usb_enq(struct brcmf_usbdev_info *devinfo,
335 struct list_head *q, struct brcmf_usbreq *req,
339 spin_lock_irqsave(&devinfo->qlock, flags);
340 list_add_tail(&req->list, q);
343 spin_unlock_irqrestore(&devinfo->qlock, flags);
346 static struct brcmf_usbreq *
347 brcmf_usbdev_qinit(struct list_head *q, int qsize)
350 struct brcmf_usbreq *req, *reqs;
352 reqs = kcalloc(qsize, sizeof(struct brcmf_usbreq), GFP_ATOMIC);
358 for (i = 0; i < qsize; i++) {
359 req->urb = usb_alloc_urb(0, GFP_ATOMIC);
363 INIT_LIST_HEAD(&req->list);
364 list_add_tail(&req->list, q);
369 brcmf_err("fail!\n");
370 while (!list_empty(q)) {
371 req = list_entry(q->next, struct brcmf_usbreq, list);
373 usb_free_urb(req->urb);
380 static void brcmf_usb_free_q(struct list_head *q, bool pending)
382 struct brcmf_usbreq *req, *next;
384 list_for_each_entry_safe(req, next, q, list) {
386 brcmf_err("bad req\n");
391 usb_kill_urb(req->urb);
393 usb_free_urb(req->urb);
394 list_del_init(&req->list);
399 static void brcmf_usb_del_fromq(struct brcmf_usbdev_info *devinfo,
400 struct brcmf_usbreq *req)
404 spin_lock_irqsave(&devinfo->qlock, flags);
405 list_del_init(&req->list);
406 spin_unlock_irqrestore(&devinfo->qlock, flags);
410 static void brcmf_usb_tx_complete(struct urb *urb)
412 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
413 struct brcmf_usbdev_info *devinfo = req->devinfo;
415 brcmf_dbg(USB, "Enter, urb->status=%d, skb=%p\n", urb->status,
417 brcmf_usb_del_fromq(devinfo, req);
419 brcmf_txcomplete(devinfo->dev, req->skb, urb->status == 0);
421 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req, &devinfo->tx_freecount);
422 if (devinfo->tx_freecount > devinfo->tx_high_watermark &&
423 devinfo->tx_flowblock) {
424 brcmf_txflowblock(devinfo->dev, false);
425 devinfo->tx_flowblock = false;
429 static void brcmf_usb_rx_complete(struct urb *urb)
431 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
432 struct brcmf_usbdev_info *devinfo = req->devinfo;
434 struct sk_buff_head skbq;
436 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
437 brcmf_usb_del_fromq(devinfo, req);
441 /* zero lenght packets indicate usb "failure". Do not refill */
442 if (urb->status != 0 || !urb->actual_length) {
443 brcmu_pkt_buf_free_skb(skb);
444 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
448 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
449 skb_queue_head_init(&skbq);
450 skb_queue_tail(&skbq, skb);
451 skb_put(skb, urb->actual_length);
452 brcmf_rx_frames(devinfo->dev, &skbq);
453 brcmf_usb_rx_refill(devinfo, req);
455 brcmu_pkt_buf_free_skb(skb);
456 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
462 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
463 struct brcmf_usbreq *req)
468 if (!req || !devinfo)
471 skb = dev_alloc_skb(devinfo->bus_pub.bus_mtu);
473 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
478 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->rx_pipe,
479 skb->data, skb_tailroom(skb), brcmf_usb_rx_complete,
481 req->devinfo = devinfo;
482 brcmf_usb_enq(devinfo, &devinfo->rx_postq, req, NULL);
484 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
486 brcmf_usb_del_fromq(devinfo, req);
487 brcmu_pkt_buf_free_skb(req->skb);
489 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
494 static void brcmf_usb_rx_fill_all(struct brcmf_usbdev_info *devinfo)
496 struct brcmf_usbreq *req;
498 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
499 brcmf_err("bus is not up=%d\n", devinfo->bus_pub.state);
502 while ((req = brcmf_usb_deq(devinfo, &devinfo->rx_freeq, NULL)) != NULL)
503 brcmf_usb_rx_refill(devinfo, req);
507 brcmf_usb_state_change(struct brcmf_usbdev_info *devinfo, int state)
509 struct brcmf_bus *bcmf_bus = devinfo->bus_pub.bus;
512 brcmf_dbg(USB, "Enter, current state=%d, new state=%d\n",
513 devinfo->bus_pub.state, state);
515 if (devinfo->bus_pub.state == state)
518 old_state = devinfo->bus_pub.state;
519 devinfo->bus_pub.state = state;
521 /* update state of upper layer */
522 if (state == BRCMFMAC_USB_STATE_DOWN) {
523 brcmf_dbg(USB, "DBUS is down\n");
524 bcmf_bus->state = BRCMF_BUS_DOWN;
525 } else if (state == BRCMFMAC_USB_STATE_UP) {
526 brcmf_dbg(USB, "DBUS is up\n");
527 bcmf_bus->state = BRCMF_BUS_DATA;
529 brcmf_dbg(USB, "DBUS current state=%d\n", state);
534 brcmf_usb_intr_complete(struct urb *urb)
536 struct brcmf_usbdev_info *devinfo =
537 (struct brcmf_usbdev_info *)urb->context;
540 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
545 if (unlikely(urb->status)) {
546 if (urb->status == -ENOENT ||
547 urb->status == -ESHUTDOWN ||
548 urb->status == -ENODEV) {
549 brcmf_usb_state_change(devinfo,
550 BRCMFMAC_USB_STATE_DOWN);
554 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN) {
555 brcmf_err("intr cb when DBUS down, ignoring\n");
559 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
560 err = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
562 brcmf_err("usb_submit_urb, err=%d\n", err);
566 static int brcmf_usb_tx(struct device *dev, struct sk_buff *skb)
568 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
569 struct brcmf_usbreq *req;
572 brcmf_dbg(USB, "Enter, skb=%p\n", skb);
573 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
578 req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
579 &devinfo->tx_freecount);
581 brcmf_err("no req to send\n");
587 req->devinfo = devinfo;
588 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->tx_pipe,
589 skb->data, skb->len, brcmf_usb_tx_complete, req);
590 req->urb->transfer_flags |= URB_ZERO_PACKET;
591 brcmf_usb_enq(devinfo, &devinfo->tx_postq, req, NULL);
592 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
594 brcmf_err("brcmf_usb_tx usb_submit_urb FAILED\n");
595 brcmf_usb_del_fromq(devinfo, req);
597 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
598 &devinfo->tx_freecount);
602 if (devinfo->tx_freecount < devinfo->tx_low_watermark &&
603 !devinfo->tx_flowblock) {
604 brcmf_txflowblock(dev, true);
605 devinfo->tx_flowblock = true;
610 brcmf_txcomplete(dev, skb, false);
615 static int brcmf_usb_up(struct device *dev)
617 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
621 brcmf_dbg(USB, "Enter\n");
622 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
625 /* Success, indicate devinfo is fully up */
626 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
628 if (devinfo->intr_urb) {
629 usb_fill_int_urb(devinfo->intr_urb, devinfo->usbdev,
633 (usb_complete_t)brcmf_usb_intr_complete,
637 ret = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
639 brcmf_err("USB_SUBMIT_URB failed with status %d\n",
645 if (devinfo->ctl_urb) {
646 devinfo->ctl_in_pipe = usb_rcvctrlpipe(devinfo->usbdev, 0);
647 devinfo->ctl_out_pipe = usb_sndctrlpipe(devinfo->usbdev, 0);
649 ifnum = IFDESC(devinfo->usbdev, CONTROL_IF).bInterfaceNumber;
652 devinfo->ctl_write.bRequestType =
653 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
654 devinfo->ctl_write.bRequest = 0;
655 devinfo->ctl_write.wValue = cpu_to_le16(0);
656 devinfo->ctl_write.wIndex = cpu_to_le16p(&ifnum);
659 devinfo->ctl_read.bRequestType =
660 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
661 devinfo->ctl_read.bRequest = 1;
662 devinfo->ctl_read.wValue = cpu_to_le16(0);
663 devinfo->ctl_read.wIndex = cpu_to_le16p(&ifnum);
665 brcmf_usb_rx_fill_all(devinfo);
669 static void brcmf_usb_down(struct device *dev)
671 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
673 brcmf_dbg(USB, "Enter\n");
677 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
680 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
681 if (devinfo->intr_urb)
682 usb_kill_urb(devinfo->intr_urb);
684 if (devinfo->ctl_urb)
685 usb_kill_urb(devinfo->ctl_urb);
687 if (devinfo->bulk_urb)
688 usb_kill_urb(devinfo->bulk_urb);
689 brcmf_usb_free_q(&devinfo->tx_postq, true);
691 brcmf_usb_free_q(&devinfo->rx_postq, true);
695 brcmf_usb_sync_complete(struct urb *urb)
697 struct brcmf_usbdev_info *devinfo =
698 (struct brcmf_usbdev_info *)urb->context;
700 devinfo->ctl_completed = true;
701 brcmf_usb_ioctl_resp_wake(devinfo);
704 static bool brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
705 void *buffer, int buflen)
711 if ((!devinfo) || (devinfo->ctl_urb == NULL))
714 tmpbuf = kmalloc(buflen, GFP_ATOMIC);
719 devinfo->ctl_urb->transfer_buffer_length = size;
721 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
722 devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
724 devinfo->ctl_read.bRequest = cmd;
726 usb_fill_control_urb(devinfo->ctl_urb,
728 usb_rcvctrlpipe(devinfo->usbdev, 0),
729 (unsigned char *) &devinfo->ctl_read,
730 (void *) tmpbuf, size,
731 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
733 devinfo->ctl_completed = false;
734 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
736 brcmf_err("usb_submit_urb failed %d\n", ret);
741 ret = brcmf_usb_ioctl_resp_wait(devinfo);
742 memcpy(buffer, tmpbuf, buflen);
749 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
751 struct bootrom_id_le id;
754 brcmf_dbg(USB, "Enter\n");
759 /* Check if firmware downloaded already by querying runtime ID */
760 id.chip = cpu_to_le32(0xDEAD);
761 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
763 chipid = le32_to_cpu(id.chip);
764 chiprev = le32_to_cpu(id.chiprev);
766 if ((chipid & 0x4300) == 0x4300)
767 brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
769 brcmf_dbg(USB, "chip %d rev 0x%x\n", chipid, chiprev);
770 if (chipid == BRCMF_POSTBOOT_ID) {
771 brcmf_dbg(USB, "firmware already downloaded\n");
772 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
775 devinfo->bus_pub.devid = chipid;
776 devinfo->bus_pub.chiprev = chiprev;
782 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
784 struct bootrom_id_le id;
787 brcmf_dbg(USB, "Enter\n");
791 mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
793 id.chip = cpu_to_le32(0xDEAD); /* Get the ID */
794 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
795 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
797 } while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
799 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID)) {
800 brcmf_dbg(USB, "postboot chip 0x%x/rev 0x%x\n",
801 le32_to_cpu(id.chip), le32_to_cpu(id.chiprev));
803 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
806 brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
807 BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
814 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
818 if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
821 /* Prepare the URB */
822 usb_fill_bulk_urb(devinfo->bulk_urb, devinfo->usbdev,
823 devinfo->tx_pipe, buffer, len,
824 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
826 devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
828 devinfo->ctl_completed = false;
829 ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
831 brcmf_err("usb_submit_urb failed %d\n", ret);
834 ret = brcmf_usb_ioctl_resp_wait(devinfo);
839 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
841 unsigned int sendlen, sent, dllen;
842 char *bulkchunk = NULL, *dlpos;
843 struct rdl_state_le state;
844 u32 rdlstate, rdlbytes;
847 brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
849 bulkchunk = kmalloc(RDL_CHUNK, GFP_ATOMIC);
850 if (bulkchunk == NULL) {
855 /* 1) Prepare USB boot loader for runtime image */
856 brcmf_usb_dl_cmd(devinfo, DL_START, &state,
857 sizeof(struct rdl_state_le));
859 rdlstate = le32_to_cpu(state.state);
860 rdlbytes = le32_to_cpu(state.bytes);
862 /* 2) Check we are in the Waiting state */
863 if (rdlstate != DL_WAITING) {
864 brcmf_err("Failed to DL_START\n");
872 /* Get chip id and rev */
873 while (rdlbytes != dllen) {
874 /* Wait until the usb device reports it received all
875 * the bytes we sent */
876 if ((rdlbytes == sent) && (rdlbytes != dllen)) {
877 if ((dllen-sent) < RDL_CHUNK)
878 sendlen = dllen-sent;
882 /* simply avoid having to send a ZLP by ensuring we
890 memcpy(bulkchunk, dlpos, sendlen);
891 if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
893 brcmf_err("send_bulk failed\n");
901 if (!brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
902 sizeof(struct rdl_state_le))) {
903 brcmf_err("DL_GETSTATE Failed xxxx\n");
908 rdlstate = le32_to_cpu(state.state);
909 rdlbytes = le32_to_cpu(state.bytes);
911 /* restart if an error is reported */
912 if (rdlstate == DL_BAD_HDR || rdlstate == DL_BAD_CRC) {
913 brcmf_err("Bad Hdr or Bad CRC state %d\n",
922 brcmf_dbg(USB, "Exit, err=%d\n", err);
926 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
930 brcmf_dbg(USB, "Enter\n");
935 if (devinfo->bus_pub.devid == 0xDEAD)
938 err = brcmf_usb_dl_writeimage(devinfo, fw, len);
940 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
942 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
943 brcmf_dbg(USB, "Exit, err=%d\n", err);
948 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
950 struct rdl_state_le state;
952 brcmf_dbg(USB, "Enter\n");
956 if (devinfo->bus_pub.devid == 0xDEAD)
959 /* Check we are runnable */
960 brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
961 sizeof(struct rdl_state_le));
963 /* Start the image */
964 if (state.state == cpu_to_le32(DL_RUNNABLE)) {
965 if (!brcmf_usb_dl_cmd(devinfo, DL_GO, &state,
966 sizeof(struct rdl_state_le)))
968 if (brcmf_usb_resetcfg(devinfo))
970 /* The Dongle may go for re-enumeration. */
972 brcmf_err("Dongle not runnable\n");
975 brcmf_dbg(USB, "Exit\n");
979 static bool brcmf_usb_chip_support(int chipid, int chiprev)
987 return (chiprev == 3);
997 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
1002 brcmf_dbg(USB, "Enter\n");
1003 if (devinfo == NULL)
1006 devid = devinfo->bus_pub.devid;
1007 chiprev = devinfo->bus_pub.chiprev;
1009 if (!brcmf_usb_chip_support(devid, chiprev)) {
1010 brcmf_err("unsupported chip %d rev %d\n",
1015 if (!devinfo->image) {
1016 brcmf_err("No firmware!\n");
1020 err = brcmf_usb_dlstart(devinfo,
1021 devinfo->image, devinfo->image_len);
1023 err = brcmf_usb_dlrun(devinfo);
1028 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1030 brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1033 brcmf_usb_free_q(&devinfo->rx_freeq, false);
1034 brcmf_usb_free_q(&devinfo->tx_freeq, false);
1036 usb_free_urb(devinfo->intr_urb);
1037 usb_free_urb(devinfo->ctl_urb);
1038 usb_free_urb(devinfo->bulk_urb);
1040 kfree(devinfo->tx_reqs);
1041 kfree(devinfo->rx_reqs);
1044 #define TRX_MAGIC 0x30524448 /* "HDR0" */
1045 #define TRX_VERSION 1 /* Version 1 */
1046 #define TRX_MAX_LEN 0x3B0000 /* Max length */
1047 #define TRX_NO_HEADER 1 /* Do not write TRX header */
1048 #define TRX_MAX_OFFSET 3 /* Max number of individual files */
1049 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed image */
1051 struct trx_header_le {
1052 __le32 magic; /* "HDR0" */
1053 __le32 len; /* Length of file including header */
1054 __le32 crc32; /* CRC from flag_version to end of file */
1055 __le32 flag_version; /* 0:15 flags, 16:31 version */
1056 __le32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of
1060 static int check_file(const u8 *headers)
1062 struct trx_header_le *trx;
1063 int actual_len = -1;
1065 brcmf_dbg(USB, "Enter\n");
1066 /* Extract trx header */
1067 trx = (struct trx_header_le *) headers;
1068 if (trx->magic != cpu_to_le32(TRX_MAGIC))
1071 headers += sizeof(struct trx_header_le);
1073 if (le32_to_cpu(trx->flag_version) & TRX_UNCOMP_IMAGE) {
1074 actual_len = le32_to_cpu(trx->offsets[TRX_OFFSETS_DLFWLEN_IDX]);
1075 return actual_len + sizeof(struct trx_header_le);
1080 static int brcmf_usb_get_fw(struct brcmf_usbdev_info *devinfo)
1083 const struct firmware *fw;
1084 struct brcmf_usb_image *fw_image;
1087 brcmf_dbg(USB, "Enter\n");
1088 switch (devinfo->bus_pub.devid) {
1090 fwname = BRCMF_USB_43143_FW_NAME;
1095 fwname = BRCMF_USB_43236_FW_NAME;
1098 fwname = BRCMF_USB_43242_FW_NAME;
1104 brcmf_dbg(USB, "Loading FW %s\n", fwname);
1105 list_for_each_entry(fw_image, &fw_image_list, list) {
1106 if (fw_image->fwname == fwname) {
1107 devinfo->image = fw_image->image;
1108 devinfo->image_len = fw_image->image_len;
1112 /* fw image not yet loaded. Load it now and add to list */
1113 err = request_firmware(&fw, fwname, devinfo->dev);
1115 brcmf_err("fail to request firmware %s\n", fwname);
1118 if (check_file(fw->data) < 0) {
1119 brcmf_err("invalid firmware %s\n", fwname);
1123 fw_image = kzalloc(sizeof(*fw_image), GFP_ATOMIC);
1126 INIT_LIST_HEAD(&fw_image->list);
1127 list_add_tail(&fw_image->list, &fw_image_list);
1128 fw_image->fwname = fwname;
1129 fw_image->image = vmalloc(fw->size);
1130 if (!fw_image->image)
1133 memcpy(fw_image->image, fw->data, fw->size);
1134 fw_image->image_len = fw->size;
1136 release_firmware(fw);
1138 devinfo->image = fw_image->image;
1139 devinfo->image_len = fw_image->image_len;
1146 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1149 brcmf_dbg(USB, "Enter\n");
1151 devinfo->bus_pub.nrxq = nrxq;
1152 devinfo->rx_low_watermark = nrxq / 2;
1153 devinfo->bus_pub.devinfo = devinfo;
1154 devinfo->bus_pub.ntxq = ntxq;
1155 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DOWN;
1157 /* flow control when too many tx urbs posted */
1158 devinfo->tx_low_watermark = ntxq / 4;
1159 devinfo->tx_high_watermark = devinfo->tx_low_watermark * 3;
1160 devinfo->bus_pub.bus_mtu = BRCMF_USB_MAX_PKT_SIZE;
1162 /* Initialize other structure content */
1163 init_waitqueue_head(&devinfo->ioctl_resp_wait);
1165 /* Initialize the spinlocks */
1166 spin_lock_init(&devinfo->qlock);
1168 INIT_LIST_HEAD(&devinfo->rx_freeq);
1169 INIT_LIST_HEAD(&devinfo->rx_postq);
1171 INIT_LIST_HEAD(&devinfo->tx_freeq);
1172 INIT_LIST_HEAD(&devinfo->tx_postq);
1174 devinfo->tx_flowblock = false;
1176 devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1177 if (!devinfo->rx_reqs)
1180 devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1181 if (!devinfo->tx_reqs)
1183 devinfo->tx_freecount = ntxq;
1185 devinfo->intr_urb = usb_alloc_urb(0, GFP_ATOMIC);
1186 if (!devinfo->intr_urb) {
1187 brcmf_err("usb_alloc_urb (intr) failed\n");
1190 devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1191 if (!devinfo->ctl_urb) {
1192 brcmf_err("usb_alloc_urb (ctl) failed\n");
1195 devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1196 if (!devinfo->bulk_urb) {
1197 brcmf_err("usb_alloc_urb (bulk) failed\n");
1201 if (!brcmf_usb_dlneeded(devinfo))
1202 return &devinfo->bus_pub;
1204 brcmf_dbg(USB, "Start fw downloading\n");
1205 if (brcmf_usb_get_fw(devinfo))
1208 if (brcmf_usb_fw_download(devinfo))
1211 return &devinfo->bus_pub;
1214 brcmf_err("failed!\n");
1215 brcmf_usb_detach(devinfo);
1219 static struct brcmf_bus_ops brcmf_usb_bus_ops = {
1220 .txdata = brcmf_usb_tx,
1221 .init = brcmf_usb_up,
1222 .stop = brcmf_usb_down,
1223 .txctl = brcmf_usb_tx_ctlpkt,
1224 .rxctl = brcmf_usb_rx_ctlpkt,
1227 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1229 struct brcmf_bus *bus = NULL;
1230 struct brcmf_usbdev *bus_pub = NULL;
1232 struct device *dev = devinfo->dev;
1234 brcmf_dbg(USB, "Enter\n");
1235 bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1239 bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1247 bus->bus_priv.usb = bus_pub;
1248 dev_set_drvdata(dev, bus);
1249 bus->ops = &brcmf_usb_bus_ops;
1250 bus->chip = bus_pub->devid;
1251 bus->chiprev = bus_pub->chiprev;
1253 /* Attach to the common driver interface */
1254 ret = brcmf_attach(0, dev);
1256 brcmf_err("brcmf_attach failed\n");
1260 ret = brcmf_bus_start(dev);
1262 brcmf_err("dongle is not responding\n");
1269 /* Release resources in reverse order */
1271 brcmf_usb_detach(devinfo);
1276 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1280 brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1282 brcmf_detach(devinfo->dev);
1283 kfree(devinfo->bus_pub.bus);
1284 brcmf_usb_detach(devinfo);
1288 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1291 struct usb_endpoint_descriptor *endpoint;
1293 struct usb_device *usb = interface_to_usbdev(intf);
1296 struct brcmf_usbdev_info *devinfo;
1298 brcmf_dbg(USB, "Enter\n");
1300 devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1301 if (devinfo == NULL)
1304 devinfo->usbdev = usb;
1305 devinfo->dev = &usb->dev;
1307 usb_set_intfdata(intf, devinfo);
1309 /* Check that the device supports only one configuration */
1310 if (usb->descriptor.bNumConfigurations != 1) {
1315 if (usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) {
1321 * Only the BDC interface configuration is supported:
1322 * Device class: USB_CLASS_VENDOR_SPEC
1323 * if0 class: USB_CLASS_VENDOR_SPEC
1326 * if0/ep2: bulk out (ok if swapped with bulk in)
1328 if (CONFIGDESC(usb)->bNumInterfaces != 1) {
1333 /* Check interface */
1334 if (IFDESC(usb, CONTROL_IF).bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
1335 IFDESC(usb, CONTROL_IF).bInterfaceSubClass != 2 ||
1336 IFDESC(usb, CONTROL_IF).bInterfaceProtocol != 0xff) {
1337 brcmf_err("invalid control interface: class %d, subclass %d, proto %d\n",
1338 IFDESC(usb, CONTROL_IF).bInterfaceClass,
1339 IFDESC(usb, CONTROL_IF).bInterfaceSubClass,
1340 IFDESC(usb, CONTROL_IF).bInterfaceProtocol);
1345 /* Check control endpoint */
1346 endpoint = &IFEPDESC(usb, CONTROL_IF, 0);
1347 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1348 != USB_ENDPOINT_XFER_INT) {
1349 brcmf_err("invalid control endpoint %d\n",
1350 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
1355 endpoint_num = endpoint->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1356 devinfo->intr_pipe = usb_rcvintpipe(usb, endpoint_num);
1358 devinfo->rx_pipe = 0;
1359 devinfo->rx_pipe2 = 0;
1360 devinfo->tx_pipe = 0;
1361 num_of_eps = IFDESC(usb, BULK_IF).bNumEndpoints - 1;
1363 /* Check data endpoints and get pipes */
1364 for (ep = 1; ep <= num_of_eps; ep++) {
1365 endpoint = &IFEPDESC(usb, BULK_IF, ep);
1366 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1367 USB_ENDPOINT_XFER_BULK) {
1368 brcmf_err("invalid data endpoint %d\n", ep);
1373 endpoint_num = endpoint->bEndpointAddress &
1374 USB_ENDPOINT_NUMBER_MASK;
1375 if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1377 if (!devinfo->rx_pipe) {
1379 usb_rcvbulkpipe(usb, endpoint_num);
1382 usb_rcvbulkpipe(usb, endpoint_num);
1385 devinfo->tx_pipe = usb_sndbulkpipe(usb, endpoint_num);
1389 /* Allocate interrupt URB and data buffer */
1390 /* RNDIS says 8-byte intr, our old drivers used 4-byte */
1391 if (IFEPDESC(usb, CONTROL_IF, 0).wMaxPacketSize == cpu_to_le16(16))
1392 devinfo->intr_size = 8;
1394 devinfo->intr_size = 4;
1396 devinfo->interval = IFEPDESC(usb, CONTROL_IF, 0).bInterval;
1398 if (usb->speed == USB_SPEED_HIGH)
1399 brcmf_dbg(USB, "Broadcom high speed USB wireless device detected\n");
1401 brcmf_dbg(USB, "Broadcom full speed USB wireless device detected\n");
1403 ret = brcmf_usb_probe_cb(devinfo);
1411 brcmf_err("failed with errno %d\n", ret);
1413 usb_set_intfdata(intf, NULL);
1419 brcmf_usb_disconnect(struct usb_interface *intf)
1421 struct brcmf_usbdev_info *devinfo;
1423 brcmf_dbg(USB, "Enter\n");
1424 devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1425 brcmf_usb_disconnect_cb(devinfo);
1427 brcmf_dbg(USB, "Exit\n");
1431 * only need to signal the bus being down and update the state.
1433 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1435 struct usb_device *usb = interface_to_usbdev(intf);
1436 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1438 brcmf_dbg(USB, "Enter\n");
1439 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1440 brcmf_detach(&usb->dev);
1445 * (re-) start the bus.
1447 static int brcmf_usb_resume(struct usb_interface *intf)
1449 struct usb_device *usb = interface_to_usbdev(intf);
1450 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1452 brcmf_dbg(USB, "Enter\n");
1453 if (!brcmf_attach(0, devinfo->dev))
1454 return brcmf_bus_start(&usb->dev);
1459 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1461 struct usb_device *usb = interface_to_usbdev(intf);
1462 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1464 brcmf_dbg(USB, "Enter\n");
1466 if (!brcmf_usb_fw_download(devinfo))
1467 return brcmf_usb_resume(intf);
1472 #define BRCMF_USB_VENDOR_ID_BROADCOM 0x0a5c
1473 #define BRCMF_USB_DEVICE_ID_43143 0xbd1e
1474 #define BRCMF_USB_DEVICE_ID_43236 0xbd17
1475 #define BRCMF_USB_DEVICE_ID_43242 0xbd1f
1476 #define BRCMF_USB_DEVICE_ID_BCMFW 0x0bdc
1478 static struct usb_device_id brcmf_usb_devid_table[] = {
1479 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43143) },
1480 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43236) },
1481 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43242) },
1482 /* special entry for device with firmware loaded and running */
1483 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_BCMFW) },
1487 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1488 MODULE_FIRMWARE(BRCMF_USB_43143_FW_NAME);
1489 MODULE_FIRMWARE(BRCMF_USB_43236_FW_NAME);
1490 MODULE_FIRMWARE(BRCMF_USB_43242_FW_NAME);
1492 static struct usb_driver brcmf_usbdrvr = {
1493 .name = KBUILD_MODNAME,
1494 .probe = brcmf_usb_probe,
1495 .disconnect = brcmf_usb_disconnect,
1496 .id_table = brcmf_usb_devid_table,
1497 .suspend = brcmf_usb_suspend,
1498 .resume = brcmf_usb_resume,
1499 .reset_resume = brcmf_usb_reset_resume,
1500 .supports_autosuspend = 1,
1501 .disable_hub_initiated_lpm = 1,
1504 static void brcmf_release_fw(struct list_head *q)
1506 struct brcmf_usb_image *fw_image, *next;
1508 list_for_each_entry_safe(fw_image, next, q, list) {
1509 vfree(fw_image->image);
1510 list_del_init(&fw_image->list);
1514 static int brcmf_usb_reset_device(struct device *dev, void *notused)
1516 /* device past is the usb interface so we
1517 * need to use parent here.
1519 brcmf_dev_reset(dev->parent);
1523 void brcmf_usb_exit(void)
1525 struct device_driver *drv = &brcmf_usbdrvr.drvwrap.driver;
1528 brcmf_dbg(USB, "Enter\n");
1529 ret = driver_for_each_device(drv, NULL, NULL,
1530 brcmf_usb_reset_device);
1531 usb_deregister(&brcmf_usbdrvr);
1532 brcmf_release_fw(&fw_image_list);
1535 void brcmf_usb_init(void)
1537 brcmf_dbg(USB, "Enter\n");
1538 INIT_LIST_HEAD(&fw_image_list);
1539 usb_register(&brcmf_usbdrvr);