2 * Copyright (c) 2011 Broadcom Corporation
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/firmware.h>
20 #include <linux/usb.h>
21 #include <linux/vmalloc.h>
23 #include <brcmu_utils.h>
24 #include <brcmu_wifi.h>
31 #define IOCTL_RESP_TIMEOUT 2000
33 #define BRCMF_USB_RESET_GETVER_SPINWAIT 100 /* in unit of ms */
34 #define BRCMF_USB_RESET_GETVER_LOOP_CNT 10
36 #define BRCMF_POSTBOOT_ID 0xA123 /* ID to detect if dongle
38 #define BRCMF_USB_NRXQ 50
39 #define BRCMF_USB_NTXQ 50
41 #define CONFIGDESC(usb) (&((usb)->actconfig)->desc)
42 #define IFPTR(usb, idx) ((usb)->actconfig->interface[(idx)])
43 #define IFALTS(usb, idx) (IFPTR((usb), (idx))->altsetting[0])
44 #define IFDESC(usb, idx) IFALTS((usb), (idx)).desc
45 #define IFEPDESC(usb, idx, ep) (IFALTS((usb), (idx)).endpoint[(ep)]).desc
50 #define BRCMF_USB_CBCTL_WRITE 0
51 #define BRCMF_USB_CBCTL_READ 1
52 #define BRCMF_USB_MAX_PKT_SIZE 1600
54 #define BRCMF_USB_43143_FW_NAME "brcm/brcmfmac43143.bin"
55 #define BRCMF_USB_43236_FW_NAME "brcm/brcmfmac43236b.bin"
56 #define BRCMF_USB_43242_FW_NAME "brcm/brcmfmac43242a.bin"
58 struct brcmf_usb_image {
59 struct list_head list;
64 static struct list_head fw_image_list;
66 struct intr_transfer_buf {
71 struct brcmf_usbdev_info {
72 struct brcmf_usbdev bus_pub; /* MUST BE FIRST */
74 struct list_head rx_freeq;
75 struct list_head rx_postq;
76 struct list_head tx_freeq;
77 struct list_head tx_postq;
78 uint rx_pipe, tx_pipe, intr_pipe, rx_pipe2;
82 int tx_high_watermark;
86 struct brcmf_usbreq *tx_reqs;
87 struct brcmf_usbreq *rx_reqs;
89 u8 *image; /* buffer for combine fw and nvram */
92 struct usb_device *usbdev;
95 int ctl_in_pipe, ctl_out_pipe;
96 struct urb *ctl_urb; /* URB for control endpoint */
97 struct usb_ctrlrequest ctl_write;
98 struct usb_ctrlrequest ctl_read;
99 u32 ctl_urb_actual_length;
102 wait_queue_head_t ioctl_resp_wait;
105 struct urb *bulk_urb; /* used for FW download */
106 struct urb *intr_urb; /* URB for interrupt endpoint */
107 int intr_size; /* Size of interrupt message */
108 int interval; /* Interrupt polling interval */
109 struct intr_transfer_buf intr; /* Data buffer for interrupt endpoint */
112 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
113 struct brcmf_usbreq *req);
115 MODULE_AUTHOR("Broadcom Corporation");
116 MODULE_DESCRIPTION("Broadcom 802.11n wireless LAN fullmac usb driver.");
117 MODULE_SUPPORTED_DEVICE("Broadcom 802.11n WLAN fullmac usb cards");
118 MODULE_LICENSE("Dual BSD/GPL");
120 static struct brcmf_usbdev *brcmf_usb_get_buspub(struct device *dev)
122 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
123 return bus_if->bus_priv.usb;
126 static struct brcmf_usbdev_info *brcmf_usb_get_businfo(struct device *dev)
128 return brcmf_usb_get_buspub(dev)->devinfo;
131 static int brcmf_usb_ioctl_resp_wait(struct brcmf_usbdev_info *devinfo)
133 return wait_event_timeout(devinfo->ioctl_resp_wait,
134 devinfo->ctl_completed,
135 msecs_to_jiffies(IOCTL_RESP_TIMEOUT));
138 static void brcmf_usb_ioctl_resp_wake(struct brcmf_usbdev_info *devinfo)
140 if (waitqueue_active(&devinfo->ioctl_resp_wait))
141 wake_up(&devinfo->ioctl_resp_wait);
145 brcmf_usb_ctl_complete(struct brcmf_usbdev_info *devinfo, int type, int status)
147 brcmf_dbg(USB, "Enter, status=%d\n", status);
149 if (unlikely(devinfo == NULL))
152 if (type == BRCMF_USB_CBCTL_READ) {
154 devinfo->bus_pub.stats.rx_ctlpkts++;
156 devinfo->bus_pub.stats.rx_ctlerrs++;
157 } else if (type == BRCMF_USB_CBCTL_WRITE) {
159 devinfo->bus_pub.stats.tx_ctlpkts++;
161 devinfo->bus_pub.stats.tx_ctlerrs++;
164 devinfo->ctl_urb_status = status;
165 devinfo->ctl_completed = true;
166 brcmf_usb_ioctl_resp_wake(devinfo);
170 brcmf_usb_ctlread_complete(struct urb *urb)
172 struct brcmf_usbdev_info *devinfo =
173 (struct brcmf_usbdev_info *)urb->context;
175 brcmf_dbg(USB, "Enter\n");
176 devinfo->ctl_urb_actual_length = urb->actual_length;
177 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_READ,
182 brcmf_usb_ctlwrite_complete(struct urb *urb)
184 struct brcmf_usbdev_info *devinfo =
185 (struct brcmf_usbdev_info *)urb->context;
187 brcmf_dbg(USB, "Enter\n");
188 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_WRITE,
193 brcmf_usb_send_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
198 brcmf_dbg(USB, "Enter\n");
199 if (devinfo == NULL || buf == NULL ||
200 len == 0 || devinfo->ctl_urb == NULL)
204 devinfo->ctl_write.wLength = cpu_to_le16p(&size);
205 devinfo->ctl_urb->transfer_buffer_length = size;
206 devinfo->ctl_urb_status = 0;
207 devinfo->ctl_urb_actual_length = 0;
209 usb_fill_control_urb(devinfo->ctl_urb,
211 devinfo->ctl_out_pipe,
212 (unsigned char *) &devinfo->ctl_write,
214 (usb_complete_t)brcmf_usb_ctlwrite_complete,
217 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
219 brcmf_err("usb_submit_urb failed %d\n", ret);
225 brcmf_usb_recv_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
230 brcmf_dbg(USB, "Enter\n");
231 if ((devinfo == NULL) || (buf == NULL) || (len == 0)
232 || (devinfo->ctl_urb == NULL))
236 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
237 devinfo->ctl_urb->transfer_buffer_length = size;
239 devinfo->ctl_read.bRequestType = USB_DIR_IN
240 | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
241 devinfo->ctl_read.bRequest = 1;
243 usb_fill_control_urb(devinfo->ctl_urb,
245 devinfo->ctl_in_pipe,
246 (unsigned char *) &devinfo->ctl_read,
248 (usb_complete_t)brcmf_usb_ctlread_complete,
251 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
253 brcmf_err("usb_submit_urb failed %d\n", ret);
258 static int brcmf_usb_tx_ctlpkt(struct device *dev, u8 *buf, u32 len)
262 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
264 brcmf_dbg(USB, "Enter\n");
265 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
268 if (test_and_set_bit(0, &devinfo->ctl_op))
271 devinfo->ctl_completed = false;
272 err = brcmf_usb_send_ctl(devinfo, buf, len);
274 brcmf_err("fail %d bytes: %d\n", err, len);
275 clear_bit(0, &devinfo->ctl_op);
278 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
279 clear_bit(0, &devinfo->ctl_op);
281 brcmf_err("Txctl wait timed out\n");
287 static int brcmf_usb_rx_ctlpkt(struct device *dev, u8 *buf, u32 len)
291 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
293 brcmf_dbg(USB, "Enter\n");
294 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
297 if (test_and_set_bit(0, &devinfo->ctl_op))
300 devinfo->ctl_completed = false;
301 err = brcmf_usb_recv_ctl(devinfo, buf, len);
303 brcmf_err("fail %d bytes: %d\n", err, len);
304 clear_bit(0, &devinfo->ctl_op);
307 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
308 err = devinfo->ctl_urb_status;
309 clear_bit(0, &devinfo->ctl_op);
311 brcmf_err("rxctl wait timed out\n");
315 return devinfo->ctl_urb_actual_length;
320 static struct brcmf_usbreq *brcmf_usb_deq(struct brcmf_usbdev_info *devinfo,
321 struct list_head *q, int *counter)
324 struct brcmf_usbreq *req;
325 spin_lock_irqsave(&devinfo->qlock, flags);
327 spin_unlock_irqrestore(&devinfo->qlock, flags);
330 req = list_entry(q->next, struct brcmf_usbreq, list);
331 list_del_init(q->next);
334 spin_unlock_irqrestore(&devinfo->qlock, flags);
339 static void brcmf_usb_enq(struct brcmf_usbdev_info *devinfo,
340 struct list_head *q, struct brcmf_usbreq *req,
344 spin_lock_irqsave(&devinfo->qlock, flags);
345 list_add_tail(&req->list, q);
348 spin_unlock_irqrestore(&devinfo->qlock, flags);
351 static struct brcmf_usbreq *
352 brcmf_usbdev_qinit(struct list_head *q, int qsize)
355 struct brcmf_usbreq *req, *reqs;
357 reqs = kzalloc(sizeof(struct brcmf_usbreq) * qsize, GFP_ATOMIC);
359 brcmf_err("fail to allocate memory!\n");
364 for (i = 0; i < qsize; i++) {
365 req->urb = usb_alloc_urb(0, GFP_ATOMIC);
369 INIT_LIST_HEAD(&req->list);
370 list_add_tail(&req->list, q);
375 brcmf_err("fail!\n");
376 while (!list_empty(q)) {
377 req = list_entry(q->next, struct brcmf_usbreq, list);
379 usb_free_urb(req->urb);
386 static void brcmf_usb_free_q(struct list_head *q, bool pending)
388 struct brcmf_usbreq *req, *next;
390 list_for_each_entry_safe(req, next, q, list) {
392 brcmf_err("bad req\n");
397 usb_kill_urb(req->urb);
399 usb_free_urb(req->urb);
400 list_del_init(&req->list);
405 static void brcmf_usb_del_fromq(struct brcmf_usbdev_info *devinfo,
406 struct brcmf_usbreq *req)
410 spin_lock_irqsave(&devinfo->qlock, flags);
411 list_del_init(&req->list);
412 spin_unlock_irqrestore(&devinfo->qlock, flags);
416 static void brcmf_usb_tx_complete(struct urb *urb)
418 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
419 struct brcmf_usbdev_info *devinfo = req->devinfo;
421 brcmf_dbg(USB, "Enter, urb->status=%d, skb=%p\n", urb->status,
423 brcmf_usb_del_fromq(devinfo, req);
424 if (urb->status == 0)
425 devinfo->bus_pub.bus->dstats.tx_packets++;
427 devinfo->bus_pub.bus->dstats.tx_errors++;
429 brcmf_txcomplete(devinfo->dev, req->skb, urb->status == 0);
431 brcmu_pkt_buf_free_skb(req->skb);
433 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req, &devinfo->tx_freecount);
434 if (devinfo->tx_freecount > devinfo->tx_high_watermark &&
435 devinfo->tx_flowblock) {
436 brcmf_txflowblock(devinfo->dev, false);
437 devinfo->tx_flowblock = false;
441 static void brcmf_usb_rx_complete(struct urb *urb)
443 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
444 struct brcmf_usbdev_info *devinfo = req->devinfo;
448 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
449 brcmf_usb_del_fromq(devinfo, req);
453 if (urb->status == 0) {
454 devinfo->bus_pub.bus->dstats.rx_packets++;
456 devinfo->bus_pub.bus->dstats.rx_errors++;
457 brcmu_pkt_buf_free_skb(skb);
458 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
462 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
463 skb_put(skb, urb->actual_length);
464 if (brcmf_proto_hdrpull(devinfo->dev, &ifidx, skb) != 0) {
465 brcmf_err("rx protocol error\n");
466 brcmu_pkt_buf_free_skb(skb);
467 devinfo->bus_pub.bus->dstats.rx_errors++;
469 brcmf_rx_packet(devinfo->dev, ifidx, skb);
470 brcmf_usb_rx_refill(devinfo, req);
472 brcmu_pkt_buf_free_skb(skb);
473 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
479 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
480 struct brcmf_usbreq *req)
485 if (!req || !devinfo)
488 skb = dev_alloc_skb(devinfo->bus_pub.bus_mtu);
490 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
495 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->rx_pipe,
496 skb->data, skb_tailroom(skb), brcmf_usb_rx_complete,
498 req->devinfo = devinfo;
499 brcmf_usb_enq(devinfo, &devinfo->rx_postq, req, NULL);
501 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
503 brcmf_usb_del_fromq(devinfo, req);
504 brcmu_pkt_buf_free_skb(req->skb);
506 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
511 static void brcmf_usb_rx_fill_all(struct brcmf_usbdev_info *devinfo)
513 struct brcmf_usbreq *req;
515 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
516 brcmf_err("bus is not up=%d\n", devinfo->bus_pub.state);
519 while ((req = brcmf_usb_deq(devinfo, &devinfo->rx_freeq, NULL)) != NULL)
520 brcmf_usb_rx_refill(devinfo, req);
524 brcmf_usb_state_change(struct brcmf_usbdev_info *devinfo, int state)
526 struct brcmf_bus *bcmf_bus = devinfo->bus_pub.bus;
529 brcmf_dbg(USB, "Enter, current state=%d, new state=%d\n",
530 devinfo->bus_pub.state, state);
532 if (devinfo->bus_pub.state == state)
535 old_state = devinfo->bus_pub.state;
536 devinfo->bus_pub.state = state;
538 /* update state of upper layer */
539 if (state == BRCMFMAC_USB_STATE_DOWN) {
540 brcmf_dbg(USB, "DBUS is down\n");
541 bcmf_bus->state = BRCMF_BUS_DOWN;
542 } else if (state == BRCMFMAC_USB_STATE_UP) {
543 brcmf_dbg(USB, "DBUS is up\n");
544 bcmf_bus->state = BRCMF_BUS_DATA;
546 brcmf_dbg(USB, "DBUS current state=%d\n", state);
551 brcmf_usb_intr_complete(struct urb *urb)
553 struct brcmf_usbdev_info *devinfo =
554 (struct brcmf_usbdev_info *)urb->context;
557 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
562 if (unlikely(urb->status)) {
563 if (urb->status == -ENOENT ||
564 urb->status == -ESHUTDOWN ||
565 urb->status == -ENODEV) {
566 brcmf_usb_state_change(devinfo,
567 BRCMFMAC_USB_STATE_DOWN);
571 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN) {
572 brcmf_err("intr cb when DBUS down, ignoring\n");
576 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
577 err = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
579 brcmf_err("usb_submit_urb, err=%d\n", err);
583 static int brcmf_usb_tx(struct device *dev, struct sk_buff *skb)
585 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
586 struct brcmf_usbreq *req;
589 brcmf_dbg(USB, "Enter, skb=%p\n", skb);
590 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
593 req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
594 &devinfo->tx_freecount);
596 brcmu_pkt_buf_free_skb(skb);
597 brcmf_err("no req to send\n");
602 req->devinfo = devinfo;
603 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->tx_pipe,
604 skb->data, skb->len, brcmf_usb_tx_complete, req);
605 req->urb->transfer_flags |= URB_ZERO_PACKET;
606 brcmf_usb_enq(devinfo, &devinfo->tx_postq, req, NULL);
607 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
609 brcmf_err("brcmf_usb_tx usb_submit_urb FAILED\n");
610 brcmf_usb_del_fromq(devinfo, req);
611 brcmu_pkt_buf_free_skb(req->skb);
613 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
614 &devinfo->tx_freecount);
616 if (devinfo->tx_freecount < devinfo->tx_low_watermark &&
617 !devinfo->tx_flowblock) {
618 brcmf_txflowblock(dev, true);
619 devinfo->tx_flowblock = true;
627 static int brcmf_usb_up(struct device *dev)
629 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
633 brcmf_dbg(USB, "Enter\n");
634 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
637 /* Success, indicate devinfo is fully up */
638 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
640 if (devinfo->intr_urb) {
641 usb_fill_int_urb(devinfo->intr_urb, devinfo->usbdev,
645 (usb_complete_t)brcmf_usb_intr_complete,
649 ret = usb_submit_urb(devinfo->intr_urb, GFP_ATOMIC);
651 brcmf_err("USB_SUBMIT_URB failed with status %d\n",
657 if (devinfo->ctl_urb) {
658 devinfo->ctl_in_pipe = usb_rcvctrlpipe(devinfo->usbdev, 0);
659 devinfo->ctl_out_pipe = usb_sndctrlpipe(devinfo->usbdev, 0);
661 ifnum = IFDESC(devinfo->usbdev, CONTROL_IF).bInterfaceNumber;
664 devinfo->ctl_write.bRequestType =
665 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
666 devinfo->ctl_write.bRequest = 0;
667 devinfo->ctl_write.wValue = cpu_to_le16(0);
668 devinfo->ctl_write.wIndex = cpu_to_le16p(&ifnum);
671 devinfo->ctl_read.bRequestType =
672 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
673 devinfo->ctl_read.bRequest = 1;
674 devinfo->ctl_read.wValue = cpu_to_le16(0);
675 devinfo->ctl_read.wIndex = cpu_to_le16p(&ifnum);
677 brcmf_usb_rx_fill_all(devinfo);
681 static void brcmf_usb_down(struct device *dev)
683 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
685 brcmf_dbg(USB, "Enter\n");
689 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
692 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
693 if (devinfo->intr_urb)
694 usb_kill_urb(devinfo->intr_urb);
696 if (devinfo->ctl_urb)
697 usb_kill_urb(devinfo->ctl_urb);
699 if (devinfo->bulk_urb)
700 usb_kill_urb(devinfo->bulk_urb);
701 brcmf_usb_free_q(&devinfo->tx_postq, true);
703 brcmf_usb_free_q(&devinfo->rx_postq, true);
707 brcmf_usb_sync_complete(struct urb *urb)
709 struct brcmf_usbdev_info *devinfo =
710 (struct brcmf_usbdev_info *)urb->context;
712 devinfo->ctl_completed = true;
713 brcmf_usb_ioctl_resp_wake(devinfo);
716 static bool brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
717 void *buffer, int buflen)
723 if ((!devinfo) || (devinfo->ctl_urb == NULL))
726 tmpbuf = kmalloc(buflen, GFP_ATOMIC);
731 devinfo->ctl_urb->transfer_buffer_length = size;
733 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
734 devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
736 devinfo->ctl_read.bRequest = cmd;
738 usb_fill_control_urb(devinfo->ctl_urb,
740 usb_rcvctrlpipe(devinfo->usbdev, 0),
741 (unsigned char *) &devinfo->ctl_read,
742 (void *) tmpbuf, size,
743 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
745 devinfo->ctl_completed = false;
746 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
748 brcmf_err("usb_submit_urb failed %d\n", ret);
753 ret = brcmf_usb_ioctl_resp_wait(devinfo);
754 memcpy(buffer, tmpbuf, buflen);
761 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
763 struct bootrom_id_le id;
766 brcmf_dbg(USB, "Enter\n");
771 /* Check if firmware downloaded already by querying runtime ID */
772 id.chip = cpu_to_le32(0xDEAD);
773 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
775 chipid = le32_to_cpu(id.chip);
776 chiprev = le32_to_cpu(id.chiprev);
778 if ((chipid & 0x4300) == 0x4300)
779 brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
781 brcmf_dbg(USB, "chip %d rev 0x%x\n", chipid, chiprev);
782 if (chipid == BRCMF_POSTBOOT_ID) {
783 brcmf_dbg(USB, "firmware already downloaded\n");
784 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
787 devinfo->bus_pub.devid = chipid;
788 devinfo->bus_pub.chiprev = chiprev;
794 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
796 struct bootrom_id_le id;
799 brcmf_dbg(USB, "Enter\n");
803 mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
805 id.chip = cpu_to_le32(0xDEAD); /* Get the ID */
806 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
807 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
809 } while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
811 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID)) {
812 brcmf_dbg(USB, "postboot chip 0x%x/rev 0x%x\n",
813 le32_to_cpu(id.chip), le32_to_cpu(id.chiprev));
815 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
818 brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
819 BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
826 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
830 if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
833 /* Prepare the URB */
834 usb_fill_bulk_urb(devinfo->bulk_urb, devinfo->usbdev,
835 devinfo->tx_pipe, buffer, len,
836 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
838 devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
840 devinfo->ctl_completed = false;
841 ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
843 brcmf_err("usb_submit_urb failed %d\n", ret);
846 ret = brcmf_usb_ioctl_resp_wait(devinfo);
851 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
853 unsigned int sendlen, sent, dllen;
854 char *bulkchunk = NULL, *dlpos;
855 struct rdl_state_le state;
856 u32 rdlstate, rdlbytes;
859 brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
861 bulkchunk = kmalloc(RDL_CHUNK, GFP_ATOMIC);
862 if (bulkchunk == NULL) {
867 /* 1) Prepare USB boot loader for runtime image */
868 brcmf_usb_dl_cmd(devinfo, DL_START, &state,
869 sizeof(struct rdl_state_le));
871 rdlstate = le32_to_cpu(state.state);
872 rdlbytes = le32_to_cpu(state.bytes);
874 /* 2) Check we are in the Waiting state */
875 if (rdlstate != DL_WAITING) {
876 brcmf_err("Failed to DL_START\n");
884 /* Get chip id and rev */
885 while (rdlbytes != dllen) {
886 /* Wait until the usb device reports it received all
887 * the bytes we sent */
888 if ((rdlbytes == sent) && (rdlbytes != dllen)) {
889 if ((dllen-sent) < RDL_CHUNK)
890 sendlen = dllen-sent;
894 /* simply avoid having to send a ZLP by ensuring we
902 memcpy(bulkchunk, dlpos, sendlen);
903 if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
905 brcmf_err("send_bulk failed\n");
913 if (!brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
914 sizeof(struct rdl_state_le))) {
915 brcmf_err("DL_GETSTATE Failed xxxx\n");
920 rdlstate = le32_to_cpu(state.state);
921 rdlbytes = le32_to_cpu(state.bytes);
923 /* restart if an error is reported */
924 if (rdlstate == DL_BAD_HDR || rdlstate == DL_BAD_CRC) {
925 brcmf_err("Bad Hdr or Bad CRC state %d\n",
934 brcmf_dbg(USB, "Exit, err=%d\n", err);
938 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
942 brcmf_dbg(USB, "Enter\n");
947 if (devinfo->bus_pub.devid == 0xDEAD)
950 err = brcmf_usb_dl_writeimage(devinfo, fw, len);
952 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
954 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
955 brcmf_dbg(USB, "Exit, err=%d\n", err);
960 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
962 struct rdl_state_le state;
964 brcmf_dbg(USB, "Enter\n");
968 if (devinfo->bus_pub.devid == 0xDEAD)
971 /* Check we are runnable */
972 brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
973 sizeof(struct rdl_state_le));
975 /* Start the image */
976 if (state.state == cpu_to_le32(DL_RUNNABLE)) {
977 if (!brcmf_usb_dl_cmd(devinfo, DL_GO, &state,
978 sizeof(struct rdl_state_le)))
980 if (brcmf_usb_resetcfg(devinfo))
982 /* The Dongle may go for re-enumeration. */
984 brcmf_err("Dongle not runnable\n");
987 brcmf_dbg(USB, "Exit\n");
991 static bool brcmf_usb_chip_support(int chipid, int chiprev)
999 return (chiprev == 3);
1009 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
1014 brcmf_dbg(USB, "Enter\n");
1015 if (devinfo == NULL)
1018 devid = devinfo->bus_pub.devid;
1019 chiprev = devinfo->bus_pub.chiprev;
1021 if (!brcmf_usb_chip_support(devid, chiprev)) {
1022 brcmf_err("unsupported chip %d rev %d\n",
1027 if (!devinfo->image) {
1028 brcmf_err("No firmware!\n");
1032 err = brcmf_usb_dlstart(devinfo,
1033 devinfo->image, devinfo->image_len);
1035 err = brcmf_usb_dlrun(devinfo);
1040 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1042 brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1045 brcmf_usb_free_q(&devinfo->rx_freeq, false);
1046 brcmf_usb_free_q(&devinfo->tx_freeq, false);
1048 usb_free_urb(devinfo->intr_urb);
1049 usb_free_urb(devinfo->ctl_urb);
1050 usb_free_urb(devinfo->bulk_urb);
1052 kfree(devinfo->tx_reqs);
1053 kfree(devinfo->rx_reqs);
1056 #define TRX_MAGIC 0x30524448 /* "HDR0" */
1057 #define TRX_VERSION 1 /* Version 1 */
1058 #define TRX_MAX_LEN 0x3B0000 /* Max length */
1059 #define TRX_NO_HEADER 1 /* Do not write TRX header */
1060 #define TRX_MAX_OFFSET 3 /* Max number of individual files */
1061 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed image */
1063 struct trx_header_le {
1064 __le32 magic; /* "HDR0" */
1065 __le32 len; /* Length of file including header */
1066 __le32 crc32; /* CRC from flag_version to end of file */
1067 __le32 flag_version; /* 0:15 flags, 16:31 version */
1068 __le32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of
1072 static int check_file(const u8 *headers)
1074 struct trx_header_le *trx;
1075 int actual_len = -1;
1077 brcmf_dbg(USB, "Enter\n");
1078 /* Extract trx header */
1079 trx = (struct trx_header_le *) headers;
1080 if (trx->magic != cpu_to_le32(TRX_MAGIC))
1083 headers += sizeof(struct trx_header_le);
1085 if (le32_to_cpu(trx->flag_version) & TRX_UNCOMP_IMAGE) {
1086 actual_len = le32_to_cpu(trx->offsets[TRX_OFFSETS_DLFWLEN_IDX]);
1087 return actual_len + sizeof(struct trx_header_le);
1092 static int brcmf_usb_get_fw(struct brcmf_usbdev_info *devinfo)
1095 const struct firmware *fw;
1096 struct brcmf_usb_image *fw_image;
1099 brcmf_dbg(USB, "Enter\n");
1100 switch (devinfo->bus_pub.devid) {
1102 fwname = BRCMF_USB_43143_FW_NAME;
1107 fwname = BRCMF_USB_43236_FW_NAME;
1110 fwname = BRCMF_USB_43242_FW_NAME;
1116 brcmf_dbg(USB, "Loading FW %s\n", fwname);
1117 list_for_each_entry(fw_image, &fw_image_list, list) {
1118 if (fw_image->fwname == fwname) {
1119 devinfo->image = fw_image->image;
1120 devinfo->image_len = fw_image->image_len;
1124 /* fw image not yet loaded. Load it now and add to list */
1125 err = request_firmware(&fw, fwname, devinfo->dev);
1127 brcmf_err("fail to request firmware %s\n", fwname);
1130 if (check_file(fw->data) < 0) {
1131 brcmf_err("invalid firmware %s\n", fwname);
1135 fw_image = kzalloc(sizeof(*fw_image), GFP_ATOMIC);
1138 INIT_LIST_HEAD(&fw_image->list);
1139 list_add_tail(&fw_image->list, &fw_image_list);
1140 fw_image->fwname = fwname;
1141 fw_image->image = vmalloc(fw->size);
1142 if (!fw_image->image)
1145 memcpy(fw_image->image, fw->data, fw->size);
1146 fw_image->image_len = fw->size;
1148 release_firmware(fw);
1150 devinfo->image = fw_image->image;
1151 devinfo->image_len = fw_image->image_len;
1158 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1161 brcmf_dbg(USB, "Enter\n");
1163 devinfo->bus_pub.nrxq = nrxq;
1164 devinfo->rx_low_watermark = nrxq / 2;
1165 devinfo->bus_pub.devinfo = devinfo;
1166 devinfo->bus_pub.ntxq = ntxq;
1167 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DOWN;
1169 /* flow control when too many tx urbs posted */
1170 devinfo->tx_low_watermark = ntxq / 4;
1171 devinfo->tx_high_watermark = devinfo->tx_low_watermark * 3;
1172 devinfo->bus_pub.bus_mtu = BRCMF_USB_MAX_PKT_SIZE;
1174 /* Initialize other structure content */
1175 init_waitqueue_head(&devinfo->ioctl_resp_wait);
1177 /* Initialize the spinlocks */
1178 spin_lock_init(&devinfo->qlock);
1180 INIT_LIST_HEAD(&devinfo->rx_freeq);
1181 INIT_LIST_HEAD(&devinfo->rx_postq);
1183 INIT_LIST_HEAD(&devinfo->tx_freeq);
1184 INIT_LIST_HEAD(&devinfo->tx_postq);
1186 devinfo->tx_flowblock = false;
1188 devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1189 if (!devinfo->rx_reqs)
1192 devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1193 if (!devinfo->tx_reqs)
1195 devinfo->tx_freecount = ntxq;
1197 devinfo->intr_urb = usb_alloc_urb(0, GFP_ATOMIC);
1198 if (!devinfo->intr_urb) {
1199 brcmf_err("usb_alloc_urb (intr) failed\n");
1202 devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1203 if (!devinfo->ctl_urb) {
1204 brcmf_err("usb_alloc_urb (ctl) failed\n");
1207 devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1208 if (!devinfo->bulk_urb) {
1209 brcmf_err("usb_alloc_urb (bulk) failed\n");
1213 if (!brcmf_usb_dlneeded(devinfo))
1214 return &devinfo->bus_pub;
1216 brcmf_dbg(USB, "Start fw downloading\n");
1217 if (brcmf_usb_get_fw(devinfo))
1220 if (brcmf_usb_fw_download(devinfo))
1223 return &devinfo->bus_pub;
1226 brcmf_err("failed!\n");
1227 brcmf_usb_detach(devinfo);
1231 static struct brcmf_bus_ops brcmf_usb_bus_ops = {
1232 .txdata = brcmf_usb_tx,
1233 .init = brcmf_usb_up,
1234 .stop = brcmf_usb_down,
1235 .txctl = brcmf_usb_tx_ctlpkt,
1236 .rxctl = brcmf_usb_rx_ctlpkt,
1239 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1241 struct brcmf_bus *bus = NULL;
1242 struct brcmf_usbdev *bus_pub = NULL;
1244 struct device *dev = devinfo->dev;
1246 brcmf_dbg(USB, "Enter\n");
1247 bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1251 bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1259 bus->bus_priv.usb = bus_pub;
1260 dev_set_drvdata(dev, bus);
1261 bus->ops = &brcmf_usb_bus_ops;
1263 /* Attach to the common driver interface */
1264 ret = brcmf_attach(0, dev);
1266 brcmf_err("brcmf_attach failed\n");
1270 ret = brcmf_bus_start(dev);
1272 brcmf_err("dongle is not responding\n");
1279 /* Release resources in reverse order */
1281 brcmf_usb_detach(devinfo);
1286 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1290 brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1292 brcmf_detach(devinfo->dev);
1293 kfree(devinfo->bus_pub.bus);
1294 brcmf_usb_detach(devinfo);
1298 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1301 struct usb_endpoint_descriptor *endpoint;
1303 struct usb_device *usb = interface_to_usbdev(intf);
1306 struct brcmf_usbdev_info *devinfo;
1308 brcmf_dbg(USB, "Enter\n");
1310 devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1311 if (devinfo == NULL)
1314 devinfo->usbdev = usb;
1315 devinfo->dev = &usb->dev;
1317 usb_set_intfdata(intf, devinfo);
1319 /* Check that the device supports only one configuration */
1320 if (usb->descriptor.bNumConfigurations != 1) {
1325 if (usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) {
1331 * Only the BDC interface configuration is supported:
1332 * Device class: USB_CLASS_VENDOR_SPEC
1333 * if0 class: USB_CLASS_VENDOR_SPEC
1336 * if0/ep2: bulk out (ok if swapped with bulk in)
1338 if (CONFIGDESC(usb)->bNumInterfaces != 1) {
1343 /* Check interface */
1344 if (IFDESC(usb, CONTROL_IF).bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
1345 IFDESC(usb, CONTROL_IF).bInterfaceSubClass != 2 ||
1346 IFDESC(usb, CONTROL_IF).bInterfaceProtocol != 0xff) {
1347 brcmf_err("invalid control interface: class %d, subclass %d, proto %d\n",
1348 IFDESC(usb, CONTROL_IF).bInterfaceClass,
1349 IFDESC(usb, CONTROL_IF).bInterfaceSubClass,
1350 IFDESC(usb, CONTROL_IF).bInterfaceProtocol);
1355 /* Check control endpoint */
1356 endpoint = &IFEPDESC(usb, CONTROL_IF, 0);
1357 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1358 != USB_ENDPOINT_XFER_INT) {
1359 brcmf_err("invalid control endpoint %d\n",
1360 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
1365 endpoint_num = endpoint->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1366 devinfo->intr_pipe = usb_rcvintpipe(usb, endpoint_num);
1368 devinfo->rx_pipe = 0;
1369 devinfo->rx_pipe2 = 0;
1370 devinfo->tx_pipe = 0;
1371 num_of_eps = IFDESC(usb, BULK_IF).bNumEndpoints - 1;
1373 /* Check data endpoints and get pipes */
1374 for (ep = 1; ep <= num_of_eps; ep++) {
1375 endpoint = &IFEPDESC(usb, BULK_IF, ep);
1376 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1377 USB_ENDPOINT_XFER_BULK) {
1378 brcmf_err("invalid data endpoint %d\n", ep);
1383 endpoint_num = endpoint->bEndpointAddress &
1384 USB_ENDPOINT_NUMBER_MASK;
1385 if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1387 if (!devinfo->rx_pipe) {
1389 usb_rcvbulkpipe(usb, endpoint_num);
1392 usb_rcvbulkpipe(usb, endpoint_num);
1395 devinfo->tx_pipe = usb_sndbulkpipe(usb, endpoint_num);
1399 /* Allocate interrupt URB and data buffer */
1400 /* RNDIS says 8-byte intr, our old drivers used 4-byte */
1401 if (IFEPDESC(usb, CONTROL_IF, 0).wMaxPacketSize == cpu_to_le16(16))
1402 devinfo->intr_size = 8;
1404 devinfo->intr_size = 4;
1406 devinfo->interval = IFEPDESC(usb, CONTROL_IF, 0).bInterval;
1408 if (usb->speed == USB_SPEED_HIGH)
1409 brcmf_dbg(USB, "Broadcom high speed USB wireless device detected\n");
1411 brcmf_dbg(USB, "Broadcom full speed USB wireless device detected\n");
1413 ret = brcmf_usb_probe_cb(devinfo);
1421 brcmf_err("failed with errno %d\n", ret);
1423 usb_set_intfdata(intf, NULL);
1429 brcmf_usb_disconnect(struct usb_interface *intf)
1431 struct brcmf_usbdev_info *devinfo;
1433 brcmf_dbg(USB, "Enter\n");
1434 devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1435 brcmf_usb_disconnect_cb(devinfo);
1437 brcmf_dbg(USB, "Exit\n");
1441 * only need to signal the bus being down and update the state.
1443 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1445 struct usb_device *usb = interface_to_usbdev(intf);
1446 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1448 brcmf_dbg(USB, "Enter\n");
1449 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1450 brcmf_detach(&usb->dev);
1455 * (re-) start the bus.
1457 static int brcmf_usb_resume(struct usb_interface *intf)
1459 struct usb_device *usb = interface_to_usbdev(intf);
1460 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1462 brcmf_dbg(USB, "Enter\n");
1463 if (!brcmf_attach(0, devinfo->dev))
1464 return brcmf_bus_start(&usb->dev);
1469 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1471 struct usb_device *usb = interface_to_usbdev(intf);
1472 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1474 brcmf_dbg(USB, "Enter\n");
1476 if (!brcmf_usb_fw_download(devinfo))
1477 return brcmf_usb_resume(intf);
1482 #define BRCMF_USB_VENDOR_ID_BROADCOM 0x0a5c
1483 #define BRCMF_USB_DEVICE_ID_43143 0xbd1e
1484 #define BRCMF_USB_DEVICE_ID_43236 0xbd17
1485 #define BRCMF_USB_DEVICE_ID_43242 0xbd1f
1486 #define BRCMF_USB_DEVICE_ID_BCMFW 0x0bdc
1488 static struct usb_device_id brcmf_usb_devid_table[] = {
1489 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43143) },
1490 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43236) },
1491 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_43242) },
1492 /* special entry for device with firmware loaded and running */
1493 { USB_DEVICE(BRCMF_USB_VENDOR_ID_BROADCOM, BRCMF_USB_DEVICE_ID_BCMFW) },
1496 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1497 MODULE_FIRMWARE(BRCMF_USB_43143_FW_NAME);
1498 MODULE_FIRMWARE(BRCMF_USB_43236_FW_NAME);
1499 MODULE_FIRMWARE(BRCMF_USB_43242_FW_NAME);
1501 static struct usb_driver brcmf_usbdrvr = {
1502 .name = KBUILD_MODNAME,
1503 .probe = brcmf_usb_probe,
1504 .disconnect = brcmf_usb_disconnect,
1505 .id_table = brcmf_usb_devid_table,
1506 .suspend = brcmf_usb_suspend,
1507 .resume = brcmf_usb_resume,
1508 .reset_resume = brcmf_usb_reset_resume,
1509 .supports_autosuspend = 1,
1510 .disable_hub_initiated_lpm = 1,
1513 static void brcmf_release_fw(struct list_head *q)
1515 struct brcmf_usb_image *fw_image, *next;
1517 list_for_each_entry_safe(fw_image, next, q, list) {
1518 vfree(fw_image->image);
1519 list_del_init(&fw_image->list);
1524 void brcmf_usb_exit(void)
1526 brcmf_dbg(USB, "Enter\n");
1527 usb_deregister(&brcmf_usbdrvr);
1528 brcmf_release_fw(&fw_image_list);
1531 void brcmf_usb_init(void)
1533 brcmf_dbg(USB, "Enter\n");
1534 INIT_LIST_HEAD(&fw_image_list);
1535 usb_register(&brcmf_usbdrvr);