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)
576 req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
577 &devinfo->tx_freecount);
579 brcmu_pkt_buf_free_skb(skb);
580 brcmf_err("no req to send\n");
585 req->devinfo = devinfo;
586 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->tx_pipe,
587 skb->data, skb->len, brcmf_usb_tx_complete, req);
588 req->urb->transfer_flags |= URB_ZERO_PACKET;
589 brcmf_usb_enq(devinfo, &devinfo->tx_postq, req, NULL);
590 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
592 brcmf_err("brcmf_usb_tx usb_submit_urb FAILED\n");
593 brcmf_usb_del_fromq(devinfo, req);
594 brcmu_pkt_buf_free_skb(req->skb);
596 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
597 &devinfo->tx_freecount);
599 if (devinfo->tx_freecount < devinfo->tx_low_watermark &&
600 !devinfo->tx_flowblock) {
601 brcmf_txflowblock(dev, true);
602 devinfo->tx_flowblock = true;
610 static int brcmf_usb_up(struct device *dev)
612 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
616 brcmf_dbg(USB, "Enter\n");
617 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
620 /* Success, indicate devinfo is fully up */
621 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
623 if (devinfo->intr_urb) {
624 usb_fill_int_urb(devinfo->intr_urb, devinfo->usbdev,
628 (usb_complete_t)brcmf_usb_intr_complete,
632 ret = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
634 brcmf_err("USB_SUBMIT_URB failed with status %d\n",
640 if (devinfo->ctl_urb) {
641 devinfo->ctl_in_pipe = usb_rcvctrlpipe(devinfo->usbdev, 0);
642 devinfo->ctl_out_pipe = usb_sndctrlpipe(devinfo->usbdev, 0);
644 ifnum = IFDESC(devinfo->usbdev, CONTROL_IF).bInterfaceNumber;
647 devinfo->ctl_write.bRequestType =
648 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
649 devinfo->ctl_write.bRequest = 0;
650 devinfo->ctl_write.wValue = cpu_to_le16(0);
651 devinfo->ctl_write.wIndex = cpu_to_le16p(&ifnum);
654 devinfo->ctl_read.bRequestType =
655 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
656 devinfo->ctl_read.bRequest = 1;
657 devinfo->ctl_read.wValue = cpu_to_le16(0);
658 devinfo->ctl_read.wIndex = cpu_to_le16p(&ifnum);
660 brcmf_usb_rx_fill_all(devinfo);
664 static void brcmf_usb_down(struct device *dev)
666 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
668 brcmf_dbg(USB, "Enter\n");
672 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
675 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
676 if (devinfo->intr_urb)
677 usb_kill_urb(devinfo->intr_urb);
679 if (devinfo->ctl_urb)
680 usb_kill_urb(devinfo->ctl_urb);
682 if (devinfo->bulk_urb)
683 usb_kill_urb(devinfo->bulk_urb);
684 brcmf_usb_free_q(&devinfo->tx_postq, true);
686 brcmf_usb_free_q(&devinfo->rx_postq, true);
690 brcmf_usb_sync_complete(struct urb *urb)
692 struct brcmf_usbdev_info *devinfo =
693 (struct brcmf_usbdev_info *)urb->context;
695 devinfo->ctl_completed = true;
696 brcmf_usb_ioctl_resp_wake(devinfo);
699 static bool brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
700 void *buffer, int buflen)
706 if ((!devinfo) || (devinfo->ctl_urb == NULL))
709 tmpbuf = kmalloc(buflen, GFP_ATOMIC);
714 devinfo->ctl_urb->transfer_buffer_length = size;
716 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
717 devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
719 devinfo->ctl_read.bRequest = cmd;
721 usb_fill_control_urb(devinfo->ctl_urb,
723 usb_rcvctrlpipe(devinfo->usbdev, 0),
724 (unsigned char *) &devinfo->ctl_read,
725 (void *) tmpbuf, size,
726 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
728 devinfo->ctl_completed = false;
729 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
731 brcmf_err("usb_submit_urb failed %d\n", ret);
736 ret = brcmf_usb_ioctl_resp_wait(devinfo);
737 memcpy(buffer, tmpbuf, buflen);
744 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
746 struct bootrom_id_le id;
749 brcmf_dbg(USB, "Enter\n");
754 /* Check if firmware downloaded already by querying runtime ID */
755 id.chip = cpu_to_le32(0xDEAD);
756 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
758 chipid = le32_to_cpu(id.chip);
759 chiprev = le32_to_cpu(id.chiprev);
761 if ((chipid & 0x4300) == 0x4300)
762 brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
764 brcmf_dbg(USB, "chip %d rev 0x%x\n", chipid, chiprev);
765 if (chipid == BRCMF_POSTBOOT_ID) {
766 brcmf_dbg(USB, "firmware already downloaded\n");
767 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
770 devinfo->bus_pub.devid = chipid;
771 devinfo->bus_pub.chiprev = chiprev;
777 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
779 struct bootrom_id_le id;
782 brcmf_dbg(USB, "Enter\n");
786 mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
788 id.chip = cpu_to_le32(0xDEAD); /* Get the ID */
789 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
790 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
792 } while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
794 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID)) {
795 brcmf_dbg(USB, "postboot chip 0x%x/rev 0x%x\n",
796 le32_to_cpu(id.chip), le32_to_cpu(id.chiprev));
798 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
801 brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
802 BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
809 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
813 if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
816 /* Prepare the URB */
817 usb_fill_bulk_urb(devinfo->bulk_urb, devinfo->usbdev,
818 devinfo->tx_pipe, buffer, len,
819 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
821 devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
823 devinfo->ctl_completed = false;
824 ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
826 brcmf_err("usb_submit_urb failed %d\n", ret);
829 ret = brcmf_usb_ioctl_resp_wait(devinfo);
834 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
836 unsigned int sendlen, sent, dllen;
837 char *bulkchunk = NULL, *dlpos;
838 struct rdl_state_le state;
839 u32 rdlstate, rdlbytes;
842 brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
844 bulkchunk = kmalloc(RDL_CHUNK, GFP_ATOMIC);
845 if (bulkchunk == NULL) {
850 /* 1) Prepare USB boot loader for runtime image */
851 brcmf_usb_dl_cmd(devinfo, DL_START, &state,
852 sizeof(struct rdl_state_le));
854 rdlstate = le32_to_cpu(state.state);
855 rdlbytes = le32_to_cpu(state.bytes);
857 /* 2) Check we are in the Waiting state */
858 if (rdlstate != DL_WAITING) {
859 brcmf_err("Failed to DL_START\n");
867 /* Get chip id and rev */
868 while (rdlbytes != dllen) {
869 /* Wait until the usb device reports it received all
870 * the bytes we sent */
871 if ((rdlbytes == sent) && (rdlbytes != dllen)) {
872 if ((dllen-sent) < RDL_CHUNK)
873 sendlen = dllen-sent;
877 /* simply avoid having to send a ZLP by ensuring we
885 memcpy(bulkchunk, dlpos, sendlen);
886 if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
888 brcmf_err("send_bulk failed\n");
896 if (!brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
897 sizeof(struct rdl_state_le))) {
898 brcmf_err("DL_GETSTATE Failed xxxx\n");
903 rdlstate = le32_to_cpu(state.state);
904 rdlbytes = le32_to_cpu(state.bytes);
906 /* restart if an error is reported */
907 if (rdlstate == DL_BAD_HDR || rdlstate == DL_BAD_CRC) {
908 brcmf_err("Bad Hdr or Bad CRC state %d\n",
917 brcmf_dbg(USB, "Exit, err=%d\n", err);
921 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
925 brcmf_dbg(USB, "Enter\n");
930 if (devinfo->bus_pub.devid == 0xDEAD)
933 err = brcmf_usb_dl_writeimage(devinfo, fw, len);
935 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
937 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
938 brcmf_dbg(USB, "Exit, err=%d\n", err);
943 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
945 struct rdl_state_le state;
947 brcmf_dbg(USB, "Enter\n");
951 if (devinfo->bus_pub.devid == 0xDEAD)
954 /* Check we are runnable */
955 brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
956 sizeof(struct rdl_state_le));
958 /* Start the image */
959 if (state.state == cpu_to_le32(DL_RUNNABLE)) {
960 if (!brcmf_usb_dl_cmd(devinfo, DL_GO, &state,
961 sizeof(struct rdl_state_le)))
963 if (brcmf_usb_resetcfg(devinfo))
965 /* The Dongle may go for re-enumeration. */
967 brcmf_err("Dongle not runnable\n");
970 brcmf_dbg(USB, "Exit\n");
974 static bool brcmf_usb_chip_support(int chipid, int chiprev)
982 return (chiprev == 3);
992 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
997 brcmf_dbg(USB, "Enter\n");
1001 devid = devinfo->bus_pub.devid;
1002 chiprev = devinfo->bus_pub.chiprev;
1004 if (!brcmf_usb_chip_support(devid, chiprev)) {
1005 brcmf_err("unsupported chip %d rev %d\n",
1010 if (!devinfo->image) {
1011 brcmf_err("No firmware!\n");
1015 err = brcmf_usb_dlstart(devinfo,
1016 devinfo->image, devinfo->image_len);
1018 err = brcmf_usb_dlrun(devinfo);
1023 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1025 brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1028 brcmf_usb_free_q(&devinfo->rx_freeq, false);
1029 brcmf_usb_free_q(&devinfo->tx_freeq, false);
1031 usb_free_urb(devinfo->intr_urb);
1032 usb_free_urb(devinfo->ctl_urb);
1033 usb_free_urb(devinfo->bulk_urb);
1035 kfree(devinfo->tx_reqs);
1036 kfree(devinfo->rx_reqs);
1039 #define TRX_MAGIC 0x30524448 /* "HDR0" */
1040 #define TRX_VERSION 1 /* Version 1 */
1041 #define TRX_MAX_LEN 0x3B0000 /* Max length */
1042 #define TRX_NO_HEADER 1 /* Do not write TRX header */
1043 #define TRX_MAX_OFFSET 3 /* Max number of individual files */
1044 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed image */
1046 struct trx_header_le {
1047 __le32 magic; /* "HDR0" */
1048 __le32 len; /* Length of file including header */
1049 __le32 crc32; /* CRC from flag_version to end of file */
1050 __le32 flag_version; /* 0:15 flags, 16:31 version */
1051 __le32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of
1055 static int check_file(const u8 *headers)
1057 struct trx_header_le *trx;
1058 int actual_len = -1;
1060 brcmf_dbg(USB, "Enter\n");
1061 /* Extract trx header */
1062 trx = (struct trx_header_le *) headers;
1063 if (trx->magic != cpu_to_le32(TRX_MAGIC))
1066 headers += sizeof(struct trx_header_le);
1068 if (le32_to_cpu(trx->flag_version) & TRX_UNCOMP_IMAGE) {
1069 actual_len = le32_to_cpu(trx->offsets[TRX_OFFSETS_DLFWLEN_IDX]);
1070 return actual_len + sizeof(struct trx_header_le);
1075 static int brcmf_usb_get_fw(struct brcmf_usbdev_info *devinfo)
1078 const struct firmware *fw;
1079 struct brcmf_usb_image *fw_image;
1082 brcmf_dbg(USB, "Enter\n");
1083 switch (devinfo->bus_pub.devid) {
1085 fwname = BRCMF_USB_43143_FW_NAME;
1090 fwname = BRCMF_USB_43236_FW_NAME;
1093 fwname = BRCMF_USB_43242_FW_NAME;
1099 brcmf_dbg(USB, "Loading FW %s\n", fwname);
1100 list_for_each_entry(fw_image, &fw_image_list, list) {
1101 if (fw_image->fwname == fwname) {
1102 devinfo->image = fw_image->image;
1103 devinfo->image_len = fw_image->image_len;
1107 /* fw image not yet loaded. Load it now and add to list */
1108 err = request_firmware(&fw, fwname, devinfo->dev);
1110 brcmf_err("fail to request firmware %s\n", fwname);
1113 if (check_file(fw->data) < 0) {
1114 brcmf_err("invalid firmware %s\n", fwname);
1118 fw_image = kzalloc(sizeof(*fw_image), GFP_ATOMIC);
1121 INIT_LIST_HEAD(&fw_image->list);
1122 list_add_tail(&fw_image->list, &fw_image_list);
1123 fw_image->fwname = fwname;
1124 fw_image->image = vmalloc(fw->size);
1125 if (!fw_image->image)
1128 memcpy(fw_image->image, fw->data, fw->size);
1129 fw_image->image_len = fw->size;
1131 release_firmware(fw);
1133 devinfo->image = fw_image->image;
1134 devinfo->image_len = fw_image->image_len;
1141 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1144 brcmf_dbg(USB, "Enter\n");
1146 devinfo->bus_pub.nrxq = nrxq;
1147 devinfo->rx_low_watermark = nrxq / 2;
1148 devinfo->bus_pub.devinfo = devinfo;
1149 devinfo->bus_pub.ntxq = ntxq;
1150 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DOWN;
1152 /* flow control when too many tx urbs posted */
1153 devinfo->tx_low_watermark = ntxq / 4;
1154 devinfo->tx_high_watermark = devinfo->tx_low_watermark * 3;
1155 devinfo->bus_pub.bus_mtu = BRCMF_USB_MAX_PKT_SIZE;
1157 /* Initialize other structure content */
1158 init_waitqueue_head(&devinfo->ioctl_resp_wait);
1160 /* Initialize the spinlocks */
1161 spin_lock_init(&devinfo->qlock);
1163 INIT_LIST_HEAD(&devinfo->rx_freeq);
1164 INIT_LIST_HEAD(&devinfo->rx_postq);
1166 INIT_LIST_HEAD(&devinfo->tx_freeq);
1167 INIT_LIST_HEAD(&devinfo->tx_postq);
1169 devinfo->tx_flowblock = false;
1171 devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1172 if (!devinfo->rx_reqs)
1175 devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1176 if (!devinfo->tx_reqs)
1178 devinfo->tx_freecount = ntxq;
1180 devinfo->intr_urb = usb_alloc_urb(0, GFP_ATOMIC);
1181 if (!devinfo->intr_urb) {
1182 brcmf_err("usb_alloc_urb (intr) failed\n");
1185 devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1186 if (!devinfo->ctl_urb) {
1187 brcmf_err("usb_alloc_urb (ctl) failed\n");
1190 devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1191 if (!devinfo->bulk_urb) {
1192 brcmf_err("usb_alloc_urb (bulk) failed\n");
1196 if (!brcmf_usb_dlneeded(devinfo))
1197 return &devinfo->bus_pub;
1199 brcmf_dbg(USB, "Start fw downloading\n");
1200 if (brcmf_usb_get_fw(devinfo))
1203 if (brcmf_usb_fw_download(devinfo))
1206 return &devinfo->bus_pub;
1209 brcmf_err("failed!\n");
1210 brcmf_usb_detach(devinfo);
1214 static struct brcmf_bus_ops brcmf_usb_bus_ops = {
1215 .txdata = brcmf_usb_tx,
1216 .init = brcmf_usb_up,
1217 .stop = brcmf_usb_down,
1218 .txctl = brcmf_usb_tx_ctlpkt,
1219 .rxctl = brcmf_usb_rx_ctlpkt,
1222 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1224 struct brcmf_bus *bus = NULL;
1225 struct brcmf_usbdev *bus_pub = NULL;
1227 struct device *dev = devinfo->dev;
1229 brcmf_dbg(USB, "Enter\n");
1230 bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1234 bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1242 bus->bus_priv.usb = bus_pub;
1243 dev_set_drvdata(dev, bus);
1244 bus->ops = &brcmf_usb_bus_ops;
1245 bus->chip = bus_pub->devid;
1246 bus->chiprev = bus_pub->chiprev;
1248 /* Attach to the common driver interface */
1249 ret = brcmf_attach(0, dev);
1251 brcmf_err("brcmf_attach failed\n");
1255 ret = brcmf_bus_start(dev);
1257 brcmf_err("dongle is not responding\n");
1264 /* Release resources in reverse order */
1266 brcmf_usb_detach(devinfo);
1271 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1275 brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1277 brcmf_detach(devinfo->dev);
1278 kfree(devinfo->bus_pub.bus);
1279 brcmf_usb_detach(devinfo);
1283 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1286 struct usb_endpoint_descriptor *endpoint;
1288 struct usb_device *usb = interface_to_usbdev(intf);
1291 struct brcmf_usbdev_info *devinfo;
1293 brcmf_dbg(USB, "Enter\n");
1295 devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1296 if (devinfo == NULL)
1299 devinfo->usbdev = usb;
1300 devinfo->dev = &usb->dev;
1302 usb_set_intfdata(intf, devinfo);
1304 /* Check that the device supports only one configuration */
1305 if (usb->descriptor.bNumConfigurations != 1) {
1310 if (usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) {
1316 * Only the BDC interface configuration is supported:
1317 * Device class: USB_CLASS_VENDOR_SPEC
1318 * if0 class: USB_CLASS_VENDOR_SPEC
1321 * if0/ep2: bulk out (ok if swapped with bulk in)
1323 if (CONFIGDESC(usb)->bNumInterfaces != 1) {
1328 /* Check interface */
1329 if (IFDESC(usb, CONTROL_IF).bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
1330 IFDESC(usb, CONTROL_IF).bInterfaceSubClass != 2 ||
1331 IFDESC(usb, CONTROL_IF).bInterfaceProtocol != 0xff) {
1332 brcmf_err("invalid control interface: class %d, subclass %d, proto %d\n",
1333 IFDESC(usb, CONTROL_IF).bInterfaceClass,
1334 IFDESC(usb, CONTROL_IF).bInterfaceSubClass,
1335 IFDESC(usb, CONTROL_IF).bInterfaceProtocol);
1340 /* Check control endpoint */
1341 endpoint = &IFEPDESC(usb, CONTROL_IF, 0);
1342 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1343 != USB_ENDPOINT_XFER_INT) {
1344 brcmf_err("invalid control endpoint %d\n",
1345 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
1350 endpoint_num = endpoint->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1351 devinfo->intr_pipe = usb_rcvintpipe(usb, endpoint_num);
1353 devinfo->rx_pipe = 0;
1354 devinfo->rx_pipe2 = 0;
1355 devinfo->tx_pipe = 0;
1356 num_of_eps = IFDESC(usb, BULK_IF).bNumEndpoints - 1;
1358 /* Check data endpoints and get pipes */
1359 for (ep = 1; ep <= num_of_eps; ep++) {
1360 endpoint = &IFEPDESC(usb, BULK_IF, ep);
1361 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1362 USB_ENDPOINT_XFER_BULK) {
1363 brcmf_err("invalid data endpoint %d\n", ep);
1368 endpoint_num = endpoint->bEndpointAddress &
1369 USB_ENDPOINT_NUMBER_MASK;
1370 if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1372 if (!devinfo->rx_pipe) {
1374 usb_rcvbulkpipe(usb, endpoint_num);
1377 usb_rcvbulkpipe(usb, endpoint_num);
1380 devinfo->tx_pipe = usb_sndbulkpipe(usb, endpoint_num);
1384 /* Allocate interrupt URB and data buffer */
1385 /* RNDIS says 8-byte intr, our old drivers used 4-byte */
1386 if (IFEPDESC(usb, CONTROL_IF, 0).wMaxPacketSize == cpu_to_le16(16))
1387 devinfo->intr_size = 8;
1389 devinfo->intr_size = 4;
1391 devinfo->interval = IFEPDESC(usb, CONTROL_IF, 0).bInterval;
1393 if (usb->speed == USB_SPEED_HIGH)
1394 brcmf_dbg(USB, "Broadcom high speed USB wireless device detected\n");
1396 brcmf_dbg(USB, "Broadcom full speed USB wireless device detected\n");
1398 ret = brcmf_usb_probe_cb(devinfo);
1406 brcmf_err("failed with errno %d\n", ret);
1408 usb_set_intfdata(intf, NULL);
1414 brcmf_usb_disconnect(struct usb_interface *intf)
1416 struct brcmf_usbdev_info *devinfo;
1418 brcmf_dbg(USB, "Enter\n");
1419 devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1420 brcmf_usb_disconnect_cb(devinfo);
1422 brcmf_dbg(USB, "Exit\n");
1426 * only need to signal the bus being down and update the state.
1428 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1430 struct usb_device *usb = interface_to_usbdev(intf);
1431 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1433 brcmf_dbg(USB, "Enter\n");
1434 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1435 brcmf_detach(&usb->dev);
1440 * (re-) start the bus.
1442 static int brcmf_usb_resume(struct usb_interface *intf)
1444 struct usb_device *usb = interface_to_usbdev(intf);
1445 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1447 brcmf_dbg(USB, "Enter\n");
1448 if (!brcmf_attach(0, devinfo->dev))
1449 return brcmf_bus_start(&usb->dev);
1454 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1456 struct usb_device *usb = interface_to_usbdev(intf);
1457 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1459 brcmf_dbg(USB, "Enter\n");
1461 if (!brcmf_usb_fw_download(devinfo))
1462 return brcmf_usb_resume(intf);
1467 #define BRCMF_USB_VENDOR_ID_BROADCOM 0x0a5c
1468 #define BRCMF_USB_DEVICE_ID_43143 0xbd1e
1469 #define BRCMF_USB_DEVICE_ID_43236 0xbd17
1470 #define BRCMF_USB_DEVICE_ID_43242 0xbd1f
1471 #define BRCMF_USB_DEVICE_ID_BCMFW 0x0bdc
1473 static struct usb_device_id brcmf_usb_devid_table[] = {
1474 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43143) },
1475 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43236) },
1476 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43242) },
1477 /* special entry for device with firmware loaded and running */
1478 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_BCMFW) },
1482 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1483 MODULE_FIRMWARE(BRCMF_USB_43143_FW_NAME);
1484 MODULE_FIRMWARE(BRCMF_USB_43236_FW_NAME);
1485 MODULE_FIRMWARE(BRCMF_USB_43242_FW_NAME);
1487 static struct usb_driver brcmf_usbdrvr = {
1488 .name = KBUILD_MODNAME,
1489 .probe = brcmf_usb_probe,
1490 .disconnect = brcmf_usb_disconnect,
1491 .id_table = brcmf_usb_devid_table,
1492 .suspend = brcmf_usb_suspend,
1493 .resume = brcmf_usb_resume,
1494 .reset_resume = brcmf_usb_reset_resume,
1495 .supports_autosuspend = 1,
1496 .disable_hub_initiated_lpm = 1,
1499 static void brcmf_release_fw(struct list_head *q)
1501 struct brcmf_usb_image *fw_image, *next;
1503 list_for_each_entry_safe(fw_image, next, q, list) {
1504 vfree(fw_image->image);
1505 list_del_init(&fw_image->list);
1509 static int brcmf_usb_reset_device(struct device *dev, void *notused)
1511 /* device past is the usb interface so we
1512 * need to use parent here.
1514 brcmf_dev_reset(dev->parent);
1518 void brcmf_usb_exit(void)
1520 struct device_driver *drv = &brcmf_usbdrvr.drvwrap.driver;
1523 brcmf_dbg(USB, "Enter\n");
1524 ret = driver_for_each_device(drv, NULL, NULL,
1525 brcmf_usb_reset_device);
1526 usb_deregister(&brcmf_usbdrvr);
1527 brcmf_release_fw(&fw_image_list);
1530 void brcmf_usb_init(void)
1532 brcmf_dbg(USB, "Enter\n");
1533 INIT_LIST_HEAD(&fw_image_list);
1534 usb_register(&brcmf_usbdrvr);