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 <brcm_hw_ids.h>
25 #include <brcmu_wifi.h>
35 #define IOCTL_RESP_TIMEOUT msecs_to_jiffies(2000)
37 #define BRCMF_USB_RESET_GETVER_SPINWAIT 100 /* in unit of ms */
38 #define BRCMF_USB_RESET_GETVER_LOOP_CNT 10
40 #define BRCMF_POSTBOOT_ID 0xA123 /* ID to detect if dongle
42 #define BRCMF_USB_NRXQ 50
43 #define BRCMF_USB_NTXQ 50
45 #define BRCMF_USB_CBCTL_WRITE 0
46 #define BRCMF_USB_CBCTL_READ 1
47 #define BRCMF_USB_MAX_PKT_SIZE 1600
49 BRCMF_FW_DEF(43143, "brcmfmac43143.bin");
50 BRCMF_FW_DEF(43236B, "brcmfmac43236b.bin");
51 BRCMF_FW_DEF(43242A, "brcmfmac43242a.bin");
52 BRCMF_FW_DEF(43569, "brcmfmac43569.bin");
54 static struct brcmf_firmware_mapping brcmf_usb_fwnames[] = {
55 BRCMF_FW_ENTRY(BRCM_CC_43143_CHIP_ID, 0xFFFFFFFF, 43143),
56 BRCMF_FW_ENTRY(BRCM_CC_43235_CHIP_ID, 0x00000008, 43236B),
57 BRCMF_FW_ENTRY(BRCM_CC_43236_CHIP_ID, 0x00000008, 43236B),
58 BRCMF_FW_ENTRY(BRCM_CC_43238_CHIP_ID, 0x00000008, 43236B),
59 BRCMF_FW_ENTRY(BRCM_CC_43242_CHIP_ID, 0xFFFFFFFF, 43242A),
60 BRCMF_FW_ENTRY(BRCM_CC_43566_CHIP_ID, 0xFFFFFFFF, 43569),
61 BRCMF_FW_ENTRY(BRCM_CC_43569_CHIP_ID, 0xFFFFFFFF, 43569)
64 #define TRX_MAGIC 0x30524448 /* "HDR0" */
65 #define TRX_MAX_OFFSET 3 /* Max number of file offsets */
66 #define TRX_UNCOMP_IMAGE 0x20 /* Trx holds uncompressed img */
67 #define TRX_RDL_CHUNK 1500 /* size of each dl transfer */
68 #define TRX_OFFSETS_DLFWLEN_IDX 0
70 /* Control messages: bRequest values */
71 #define DL_GETSTATE 0 /* returns the rdl_state_t struct */
72 #define DL_CHECK_CRC 1 /* currently unused */
73 #define DL_GO 2 /* execute downloaded image */
74 #define DL_START 3 /* initialize dl state */
75 #define DL_REBOOT 4 /* reboot the device in 2 seconds */
76 #define DL_GETVER 5 /* returns the bootrom_id_t struct */
77 #define DL_GO_PROTECTED 6 /* execute the downloaded code and set reset
78 * event to occur in 2 seconds. It is the
79 * responsibility of the downloaded code to
82 #define DL_EXEC 7 /* jump to a supplied address */
83 #define DL_RESETCFG 8 /* To support single enum on dongle
84 * - Not used by bootloader
86 #define DL_DEFER_RESP_OK 9 /* Potentially defer the response to setup
91 #define DL_WAITING 0 /* waiting to rx first pkt */
92 #define DL_READY 1 /* hdr was good, waiting for more of the
95 #define DL_BAD_HDR 2 /* hdr was corrupted */
96 #define DL_BAD_CRC 3 /* compressed image was corrupted */
97 #define DL_RUNNABLE 4 /* download was successful,waiting for go cmd */
98 #define DL_START_FAIL 5 /* failed to initialize correctly */
99 #define DL_NVRAM_TOOBIG 6 /* host specified nvram data exceeds DL_NVRAM
102 #define DL_IMAGE_TOOBIG 7 /* firmware image too big */
105 struct trx_header_le {
106 __le32 magic; /* "HDR0" */
107 __le32 len; /* Length of file including header */
108 __le32 crc32; /* CRC from flag_version to end of file */
109 __le32 flag_version; /* 0:15 flags, 16:31 version */
110 __le32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of
115 struct rdl_state_le {
120 struct bootrom_id_le {
121 __le32 chip; /* Chip id */
122 __le32 chiprev; /* Chip rev */
123 __le32 ramsize; /* Size of RAM */
124 __le32 remapbase; /* Current remap base address */
125 __le32 boardtype; /* Type of board */
126 __le32 boardrev; /* Board revision */
129 struct brcmf_usb_image {
130 struct list_head list;
136 struct brcmf_usbdev_info {
137 struct brcmf_usbdev bus_pub; /* MUST BE FIRST */
139 struct list_head rx_freeq;
140 struct list_head rx_postq;
141 struct list_head tx_freeq;
142 struct list_head tx_postq;
143 uint rx_pipe, tx_pipe;
145 int rx_low_watermark;
146 int tx_low_watermark;
147 int tx_high_watermark;
150 spinlock_t tx_flowblock_lock;
152 struct brcmf_usbreq *tx_reqs;
153 struct brcmf_usbreq *rx_reqs;
155 char fw_name[BRCMF_FW_NAME_LEN];
156 const u8 *image; /* buffer for combine fw and nvram */
159 struct usb_device *usbdev;
161 struct mutex dev_init_lock;
163 int ctl_in_pipe, ctl_out_pipe;
164 struct urb *ctl_urb; /* URB for control endpoint */
165 struct usb_ctrlrequest ctl_write;
166 struct usb_ctrlrequest ctl_read;
167 u32 ctl_urb_actual_length;
170 wait_queue_head_t ioctl_resp_wait;
174 struct urb *bulk_urb; /* used for FW download */
177 struct brcmf_mp_device *settings;
180 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
181 struct brcmf_usbreq *req);
183 static struct brcmf_usbdev *brcmf_usb_get_buspub(struct device *dev)
185 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
186 return bus_if->bus_priv.usb;
189 static struct brcmf_usbdev_info *brcmf_usb_get_businfo(struct device *dev)
191 return brcmf_usb_get_buspub(dev)->devinfo;
194 static int brcmf_usb_ioctl_resp_wait(struct brcmf_usbdev_info *devinfo)
196 return wait_event_timeout(devinfo->ioctl_resp_wait,
197 devinfo->ctl_completed, IOCTL_RESP_TIMEOUT);
200 static void brcmf_usb_ioctl_resp_wake(struct brcmf_usbdev_info *devinfo)
202 wake_up(&devinfo->ioctl_resp_wait);
206 brcmf_usb_ctl_complete(struct brcmf_usbdev_info *devinfo, int type, int status)
208 brcmf_dbg(USB, "Enter, status=%d\n", status);
210 if (unlikely(devinfo == NULL))
213 if (type == BRCMF_USB_CBCTL_READ) {
215 devinfo->bus_pub.stats.rx_ctlpkts++;
217 devinfo->bus_pub.stats.rx_ctlerrs++;
218 } else if (type == BRCMF_USB_CBCTL_WRITE) {
220 devinfo->bus_pub.stats.tx_ctlpkts++;
222 devinfo->bus_pub.stats.tx_ctlerrs++;
225 devinfo->ctl_urb_status = status;
226 devinfo->ctl_completed = true;
227 brcmf_usb_ioctl_resp_wake(devinfo);
231 brcmf_usb_ctlread_complete(struct urb *urb)
233 struct brcmf_usbdev_info *devinfo =
234 (struct brcmf_usbdev_info *)urb->context;
236 brcmf_dbg(USB, "Enter\n");
237 devinfo->ctl_urb_actual_length = urb->actual_length;
238 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_READ,
243 brcmf_usb_ctlwrite_complete(struct urb *urb)
245 struct brcmf_usbdev_info *devinfo =
246 (struct brcmf_usbdev_info *)urb->context;
248 brcmf_dbg(USB, "Enter\n");
249 brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_WRITE,
254 brcmf_usb_send_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
259 brcmf_dbg(USB, "Enter\n");
260 if (devinfo == NULL || buf == NULL ||
261 len == 0 || devinfo->ctl_urb == NULL)
265 devinfo->ctl_write.wLength = cpu_to_le16p(&size);
266 devinfo->ctl_urb->transfer_buffer_length = size;
267 devinfo->ctl_urb_status = 0;
268 devinfo->ctl_urb_actual_length = 0;
270 usb_fill_control_urb(devinfo->ctl_urb,
272 devinfo->ctl_out_pipe,
273 (unsigned char *) &devinfo->ctl_write,
275 (usb_complete_t)brcmf_usb_ctlwrite_complete,
278 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
280 brcmf_err("usb_submit_urb failed %d\n", ret);
286 brcmf_usb_recv_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
291 brcmf_dbg(USB, "Enter\n");
292 if ((devinfo == NULL) || (buf == NULL) || (len == 0)
293 || (devinfo->ctl_urb == NULL))
297 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
298 devinfo->ctl_urb->transfer_buffer_length = size;
300 devinfo->ctl_read.bRequestType = USB_DIR_IN
301 | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
302 devinfo->ctl_read.bRequest = 1;
304 usb_fill_control_urb(devinfo->ctl_urb,
306 devinfo->ctl_in_pipe,
307 (unsigned char *) &devinfo->ctl_read,
309 (usb_complete_t)brcmf_usb_ctlread_complete,
312 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
314 brcmf_err("usb_submit_urb failed %d\n", ret);
319 static int brcmf_usb_tx_ctlpkt(struct device *dev, u8 *buf, u32 len)
323 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
325 brcmf_dbg(USB, "Enter\n");
326 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
329 if (test_and_set_bit(0, &devinfo->ctl_op))
332 devinfo->ctl_completed = false;
333 err = brcmf_usb_send_ctl(devinfo, buf, len);
335 brcmf_err("fail %d bytes: %d\n", err, len);
336 clear_bit(0, &devinfo->ctl_op);
339 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
340 clear_bit(0, &devinfo->ctl_op);
342 brcmf_err("Txctl wait timed out\n");
348 static int brcmf_usb_rx_ctlpkt(struct device *dev, u8 *buf, u32 len)
352 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
354 brcmf_dbg(USB, "Enter\n");
355 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
358 if (test_and_set_bit(0, &devinfo->ctl_op))
361 devinfo->ctl_completed = false;
362 err = brcmf_usb_recv_ctl(devinfo, buf, len);
364 brcmf_err("fail %d bytes: %d\n", err, len);
365 clear_bit(0, &devinfo->ctl_op);
368 timeout = brcmf_usb_ioctl_resp_wait(devinfo);
369 err = devinfo->ctl_urb_status;
370 clear_bit(0, &devinfo->ctl_op);
372 brcmf_err("rxctl wait timed out\n");
376 return devinfo->ctl_urb_actual_length;
381 static struct brcmf_usbreq *brcmf_usb_deq(struct brcmf_usbdev_info *devinfo,
382 struct list_head *q, int *counter)
385 struct brcmf_usbreq *req;
386 spin_lock_irqsave(&devinfo->qlock, flags);
388 spin_unlock_irqrestore(&devinfo->qlock, flags);
391 req = list_entry(q->next, struct brcmf_usbreq, list);
392 list_del_init(q->next);
395 spin_unlock_irqrestore(&devinfo->qlock, flags);
400 static void brcmf_usb_enq(struct brcmf_usbdev_info *devinfo,
401 struct list_head *q, struct brcmf_usbreq *req,
405 spin_lock_irqsave(&devinfo->qlock, flags);
406 list_add_tail(&req->list, q);
409 spin_unlock_irqrestore(&devinfo->qlock, flags);
412 static struct brcmf_usbreq *
413 brcmf_usbdev_qinit(struct list_head *q, int qsize)
416 struct brcmf_usbreq *req, *reqs;
418 reqs = kcalloc(qsize, sizeof(struct brcmf_usbreq), GFP_ATOMIC);
424 for (i = 0; i < qsize; i++) {
425 req->urb = usb_alloc_urb(0, GFP_ATOMIC);
429 INIT_LIST_HEAD(&req->list);
430 list_add_tail(&req->list, q);
435 brcmf_err("fail!\n");
436 while (!list_empty(q)) {
437 req = list_entry(q->next, struct brcmf_usbreq, list);
439 usb_free_urb(req->urb);
446 static void brcmf_usb_free_q(struct list_head *q, bool pending)
448 struct brcmf_usbreq *req, *next;
450 list_for_each_entry_safe(req, next, q, list) {
452 brcmf_err("bad req\n");
457 usb_kill_urb(req->urb);
459 usb_free_urb(req->urb);
460 list_del_init(&req->list);
465 static void brcmf_usb_del_fromq(struct brcmf_usbdev_info *devinfo,
466 struct brcmf_usbreq *req)
470 spin_lock_irqsave(&devinfo->qlock, flags);
471 list_del_init(&req->list);
472 spin_unlock_irqrestore(&devinfo->qlock, flags);
476 static void brcmf_usb_tx_complete(struct urb *urb)
478 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
479 struct brcmf_usbdev_info *devinfo = req->devinfo;
482 brcmf_dbg(USB, "Enter, urb->status=%d, skb=%p\n", urb->status,
484 brcmf_usb_del_fromq(devinfo, req);
486 brcmf_proto_bcdc_txcomplete(devinfo->dev, req->skb, urb->status == 0);
488 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req, &devinfo->tx_freecount);
489 spin_lock_irqsave(&devinfo->tx_flowblock_lock, flags);
490 if (devinfo->tx_freecount > devinfo->tx_high_watermark &&
491 devinfo->tx_flowblock) {
492 brcmf_proto_bcdc_txflowblock(devinfo->dev, false);
493 devinfo->tx_flowblock = false;
495 spin_unlock_irqrestore(&devinfo->tx_flowblock_lock, flags);
498 static void brcmf_usb_rx_complete(struct urb *urb)
500 struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
501 struct brcmf_usbdev_info *devinfo = req->devinfo;
504 brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
505 brcmf_usb_del_fromq(devinfo, req);
509 /* zero lenght packets indicate usb "failure". Do not refill */
510 if (urb->status != 0 || !urb->actual_length) {
511 brcmu_pkt_buf_free_skb(skb);
512 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
516 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
517 skb_put(skb, urb->actual_length);
518 brcmf_rx_frame(devinfo->dev, skb, true);
519 brcmf_usb_rx_refill(devinfo, req);
521 brcmu_pkt_buf_free_skb(skb);
522 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
528 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
529 struct brcmf_usbreq *req)
534 if (!req || !devinfo)
537 skb = dev_alloc_skb(devinfo->bus_pub.bus_mtu);
539 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
544 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->rx_pipe,
545 skb->data, skb_tailroom(skb), brcmf_usb_rx_complete,
547 req->devinfo = devinfo;
548 brcmf_usb_enq(devinfo, &devinfo->rx_postq, req, NULL);
550 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
552 brcmf_usb_del_fromq(devinfo, req);
553 brcmu_pkt_buf_free_skb(req->skb);
555 brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
560 static void brcmf_usb_rx_fill_all(struct brcmf_usbdev_info *devinfo)
562 struct brcmf_usbreq *req;
564 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
565 brcmf_err("bus is not up=%d\n", devinfo->bus_pub.state);
568 while ((req = brcmf_usb_deq(devinfo, &devinfo->rx_freeq, NULL)) != NULL)
569 brcmf_usb_rx_refill(devinfo, req);
573 brcmf_usb_state_change(struct brcmf_usbdev_info *devinfo, int state)
575 struct brcmf_bus *bcmf_bus = devinfo->bus_pub.bus;
578 brcmf_dbg(USB, "Enter, current state=%d, new state=%d\n",
579 devinfo->bus_pub.state, state);
581 if (devinfo->bus_pub.state == state)
584 old_state = devinfo->bus_pub.state;
585 devinfo->bus_pub.state = state;
587 /* update state of upper layer */
588 if (state == BRCMFMAC_USB_STATE_DOWN) {
589 brcmf_dbg(USB, "DBUS is down\n");
590 brcmf_bus_change_state(bcmf_bus, BRCMF_BUS_DOWN);
591 } else if (state == BRCMFMAC_USB_STATE_UP) {
592 brcmf_dbg(USB, "DBUS is up\n");
593 brcmf_bus_change_state(bcmf_bus, BRCMF_BUS_UP);
595 brcmf_dbg(USB, "DBUS current state=%d\n", state);
599 static int brcmf_usb_tx(struct device *dev, struct sk_buff *skb)
601 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
602 struct brcmf_usbreq *req;
606 brcmf_dbg(USB, "Enter, skb=%p\n", skb);
607 if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
612 req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
613 &devinfo->tx_freecount);
615 brcmf_err("no req to send\n");
621 req->devinfo = devinfo;
622 usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->tx_pipe,
623 skb->data, skb->len, brcmf_usb_tx_complete, req);
624 req->urb->transfer_flags |= URB_ZERO_PACKET;
625 brcmf_usb_enq(devinfo, &devinfo->tx_postq, req, NULL);
626 ret = usb_submit_urb(req->urb, GFP_ATOMIC);
628 brcmf_err("brcmf_usb_tx usb_submit_urb FAILED\n");
629 brcmf_usb_del_fromq(devinfo, req);
631 brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
632 &devinfo->tx_freecount);
636 spin_lock_irqsave(&devinfo->tx_flowblock_lock, flags);
637 if (devinfo->tx_freecount < devinfo->tx_low_watermark &&
638 !devinfo->tx_flowblock) {
639 brcmf_proto_bcdc_txflowblock(dev, true);
640 devinfo->tx_flowblock = true;
642 spin_unlock_irqrestore(&devinfo->tx_flowblock_lock, flags);
650 static int brcmf_usb_up(struct device *dev)
652 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
654 brcmf_dbg(USB, "Enter\n");
655 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
658 /* Success, indicate devinfo is fully up */
659 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
661 if (devinfo->ctl_urb) {
662 devinfo->ctl_in_pipe = usb_rcvctrlpipe(devinfo->usbdev, 0);
663 devinfo->ctl_out_pipe = usb_sndctrlpipe(devinfo->usbdev, 0);
666 devinfo->ctl_write.bRequestType =
667 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
668 devinfo->ctl_write.bRequest = 0;
669 devinfo->ctl_write.wValue = cpu_to_le16(0);
670 devinfo->ctl_write.wIndex = cpu_to_le16(devinfo->ifnum);
673 devinfo->ctl_read.bRequestType =
674 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
675 devinfo->ctl_read.bRequest = 1;
676 devinfo->ctl_read.wValue = cpu_to_le16(0);
677 devinfo->ctl_read.wIndex = cpu_to_le16(devinfo->ifnum);
679 brcmf_usb_rx_fill_all(devinfo);
683 static void brcmf_cancel_all_urbs(struct brcmf_usbdev_info *devinfo)
685 if (devinfo->ctl_urb)
686 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);
690 brcmf_usb_free_q(&devinfo->rx_postq, true);
693 static void brcmf_usb_down(struct device *dev)
695 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
697 brcmf_dbg(USB, "Enter\n");
701 if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
704 brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
706 brcmf_cancel_all_urbs(devinfo);
710 brcmf_usb_sync_complete(struct urb *urb)
712 struct brcmf_usbdev_info *devinfo =
713 (struct brcmf_usbdev_info *)urb->context;
715 devinfo->ctl_completed = true;
716 brcmf_usb_ioctl_resp_wake(devinfo);
719 static int brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
720 void *buffer, int buflen)
726 if ((!devinfo) || (devinfo->ctl_urb == NULL))
729 tmpbuf = kmalloc(buflen, GFP_ATOMIC);
734 devinfo->ctl_urb->transfer_buffer_length = size;
736 devinfo->ctl_read.wLength = cpu_to_le16p(&size);
737 devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
739 devinfo->ctl_read.bRequest = cmd;
741 usb_fill_control_urb(devinfo->ctl_urb,
743 usb_rcvctrlpipe(devinfo->usbdev, 0),
744 (unsigned char *) &devinfo->ctl_read,
745 (void *) tmpbuf, size,
746 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
748 devinfo->ctl_completed = false;
749 ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
751 brcmf_err("usb_submit_urb failed %d\n", ret);
755 if (!brcmf_usb_ioctl_resp_wait(devinfo)) {
756 usb_kill_urb(devinfo->ctl_urb);
759 memcpy(buffer, tmpbuf, buflen);
768 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
770 struct bootrom_id_le id;
773 brcmf_dbg(USB, "Enter\n");
778 /* Check if firmware downloaded already by querying runtime ID */
779 id.chip = cpu_to_le32(0xDEAD);
780 brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
782 chipid = le32_to_cpu(id.chip);
783 chiprev = le32_to_cpu(id.chiprev);
785 if ((chipid & 0x4300) == 0x4300)
786 brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
788 brcmf_dbg(USB, "chip %d rev 0x%x\n", chipid, chiprev);
789 if (chipid == BRCMF_POSTBOOT_ID) {
790 brcmf_dbg(USB, "firmware already downloaded\n");
791 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
794 devinfo->bus_pub.devid = chipid;
795 devinfo->bus_pub.chiprev = chiprev;
801 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
803 struct bootrom_id_le id;
807 brcmf_dbg(USB, "Enter\n");
811 mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
813 id.chip = cpu_to_le32(0xDEAD); /* Get the ID */
814 err = brcmf_usb_dl_cmd(devinfo, DL_GETVER, &id, sizeof(id));
815 if ((err) && (err != -ETIMEDOUT))
817 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
819 } while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
821 if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID)) {
822 brcmf_dbg(USB, "postboot chip 0x%x/rev 0x%x\n",
823 le32_to_cpu(id.chip), le32_to_cpu(id.chiprev));
825 brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
828 brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
829 BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
836 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
840 if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
843 /* Prepare the URB */
844 usb_fill_bulk_urb(devinfo->bulk_urb, devinfo->usbdev,
845 devinfo->tx_pipe, buffer, len,
846 (usb_complete_t)brcmf_usb_sync_complete, devinfo);
848 devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
850 devinfo->ctl_completed = false;
851 ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
853 brcmf_err("usb_submit_urb failed %d\n", ret);
856 ret = brcmf_usb_ioctl_resp_wait(devinfo);
861 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
863 unsigned int sendlen, sent, dllen;
864 char *bulkchunk = NULL, *dlpos;
865 struct rdl_state_le state;
866 u32 rdlstate, rdlbytes;
869 brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
871 bulkchunk = kmalloc(TRX_RDL_CHUNK, GFP_ATOMIC);
872 if (bulkchunk == NULL) {
877 /* 1) Prepare USB boot loader for runtime image */
878 brcmf_usb_dl_cmd(devinfo, DL_START, &state, sizeof(state));
880 rdlstate = le32_to_cpu(state.state);
881 rdlbytes = le32_to_cpu(state.bytes);
883 /* 2) Check we are in the Waiting state */
884 if (rdlstate != DL_WAITING) {
885 brcmf_err("Failed to DL_START\n");
893 /* Get chip id and rev */
894 while (rdlbytes != dllen) {
895 /* Wait until the usb device reports it received all
896 * the bytes we sent */
897 if ((rdlbytes == sent) && (rdlbytes != dllen)) {
898 if ((dllen-sent) < TRX_RDL_CHUNK)
899 sendlen = dllen-sent;
901 sendlen = TRX_RDL_CHUNK;
903 /* simply avoid having to send a ZLP by ensuring we
911 memcpy(bulkchunk, dlpos, sendlen);
912 if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
914 brcmf_err("send_bulk failed\n");
922 err = brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
925 brcmf_err("DL_GETSTATE Failed\n");
929 rdlstate = le32_to_cpu(state.state);
930 rdlbytes = le32_to_cpu(state.bytes);
932 /* restart if an error is reported */
933 if (rdlstate == DL_BAD_HDR || rdlstate == DL_BAD_CRC) {
934 brcmf_err("Bad Hdr or Bad CRC state %d\n",
943 brcmf_dbg(USB, "Exit, err=%d\n", err);
947 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
951 brcmf_dbg(USB, "Enter\n");
956 if (devinfo->bus_pub.devid == 0xDEAD)
959 err = brcmf_usb_dl_writeimage(devinfo, fw, len);
961 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
963 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
964 brcmf_dbg(USB, "Exit, err=%d\n", err);
969 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
971 struct rdl_state_le state;
973 brcmf_dbg(USB, "Enter\n");
977 if (devinfo->bus_pub.devid == 0xDEAD)
980 /* Check we are runnable */
982 brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state, sizeof(state));
984 /* Start the image */
985 if (state.state == cpu_to_le32(DL_RUNNABLE)) {
986 if (brcmf_usb_dl_cmd(devinfo, DL_GO, &state, sizeof(state)))
988 if (brcmf_usb_resetcfg(devinfo))
990 /* The Dongle may go for re-enumeration. */
992 brcmf_err("Dongle not runnable\n");
995 brcmf_dbg(USB, "Exit\n");
1000 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
1004 brcmf_dbg(USB, "Enter\n");
1005 if (devinfo == NULL)
1008 if (!devinfo->image) {
1009 brcmf_err("No firmware!\n");
1013 err = brcmf_usb_dlstart(devinfo,
1014 (u8 *)devinfo->image, devinfo->image_len);
1016 err = brcmf_usb_dlrun(devinfo);
1021 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1023 brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1026 brcmf_usb_free_q(&devinfo->rx_freeq, false);
1027 brcmf_usb_free_q(&devinfo->tx_freeq, false);
1029 usb_free_urb(devinfo->ctl_urb);
1030 usb_free_urb(devinfo->bulk_urb);
1032 kfree(devinfo->tx_reqs);
1033 kfree(devinfo->rx_reqs);
1035 if (devinfo->settings)
1036 brcmf_release_module_param(devinfo->settings);
1040 static int check_file(const u8 *headers)
1042 struct trx_header_le *trx;
1043 int actual_len = -1;
1045 brcmf_dbg(USB, "Enter\n");
1046 /* Extract trx header */
1047 trx = (struct trx_header_le *) headers;
1048 if (trx->magic != cpu_to_le32(TRX_MAGIC))
1051 headers += sizeof(struct trx_header_le);
1053 if (le32_to_cpu(trx->flag_version) & TRX_UNCOMP_IMAGE) {
1054 actual_len = le32_to_cpu(trx->offsets[TRX_OFFSETS_DLFWLEN_IDX]);
1055 return actual_len + sizeof(struct trx_header_le);
1062 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1065 brcmf_dbg(USB, "Enter\n");
1067 devinfo->bus_pub.nrxq = nrxq;
1068 devinfo->rx_low_watermark = nrxq / 2;
1069 devinfo->bus_pub.devinfo = devinfo;
1070 devinfo->bus_pub.ntxq = ntxq;
1071 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DOWN;
1073 /* flow control when too many tx urbs posted */
1074 devinfo->tx_low_watermark = ntxq / 4;
1075 devinfo->tx_high_watermark = devinfo->tx_low_watermark * 3;
1076 devinfo->bus_pub.bus_mtu = BRCMF_USB_MAX_PKT_SIZE;
1078 /* Initialize other structure content */
1079 init_waitqueue_head(&devinfo->ioctl_resp_wait);
1081 /* Initialize the spinlocks */
1082 spin_lock_init(&devinfo->qlock);
1083 spin_lock_init(&devinfo->tx_flowblock_lock);
1085 INIT_LIST_HEAD(&devinfo->rx_freeq);
1086 INIT_LIST_HEAD(&devinfo->rx_postq);
1088 INIT_LIST_HEAD(&devinfo->tx_freeq);
1089 INIT_LIST_HEAD(&devinfo->tx_postq);
1091 devinfo->tx_flowblock = false;
1093 devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1094 if (!devinfo->rx_reqs)
1097 devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1098 if (!devinfo->tx_reqs)
1100 devinfo->tx_freecount = ntxq;
1102 devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1103 if (!devinfo->ctl_urb)
1105 devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1106 if (!devinfo->bulk_urb)
1109 return &devinfo->bus_pub;
1112 brcmf_err("failed!\n");
1113 brcmf_usb_detach(devinfo);
1117 static void brcmf_usb_wowl_config(struct device *dev, bool enabled)
1119 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
1121 brcmf_dbg(USB, "Configuring WOWL, enabled=%d\n", enabled);
1122 devinfo->wowl_enabled = enabled;
1124 device_set_wakeup_enable(devinfo->dev, true);
1126 device_set_wakeup_enable(devinfo->dev, false);
1129 static const struct brcmf_bus_ops brcmf_usb_bus_ops = {
1130 .txdata = brcmf_usb_tx,
1131 .stop = brcmf_usb_down,
1132 .txctl = brcmf_usb_tx_ctlpkt,
1133 .rxctl = brcmf_usb_rx_ctlpkt,
1134 .wowl_config = brcmf_usb_wowl_config,
1137 static int brcmf_usb_bus_setup(struct brcmf_usbdev_info *devinfo)
1141 /* Attach to the common driver interface */
1142 ret = brcmf_attach(devinfo->dev, devinfo->settings);
1144 brcmf_err("brcmf_attach failed\n");
1148 ret = brcmf_usb_up(devinfo->dev);
1152 ret = brcmf_bus_started(devinfo->dev);
1158 brcmf_detach(devinfo->dev);
1162 static void brcmf_usb_probe_phase2(struct device *dev, int ret,
1163 const struct firmware *fw,
1164 void *nvram, u32 nvlen)
1166 struct brcmf_bus *bus = dev_get_drvdata(dev);
1167 struct brcmf_usbdev_info *devinfo = bus->bus_priv.usb->devinfo;
1172 brcmf_dbg(USB, "Start fw downloading\n");
1174 ret = check_file(fw->data);
1176 brcmf_err("invalid firmware\n");
1177 release_firmware(fw);
1181 devinfo->image = fw->data;
1182 devinfo->image_len = fw->size;
1184 ret = brcmf_usb_fw_download(devinfo);
1185 release_firmware(fw);
1189 ret = brcmf_usb_bus_setup(devinfo);
1193 mutex_unlock(&devinfo->dev_init_lock);
1196 brcmf_dbg(TRACE, "failed: dev=%s, err=%d\n", dev_name(dev), ret);
1197 mutex_unlock(&devinfo->dev_init_lock);
1198 device_release_driver(dev);
1201 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1203 struct brcmf_bus *bus = NULL;
1204 struct brcmf_usbdev *bus_pub = NULL;
1205 struct device *dev = devinfo->dev;
1208 brcmf_dbg(USB, "Enter\n");
1209 bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1213 bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1221 bus->bus_priv.usb = bus_pub;
1222 dev_set_drvdata(dev, bus);
1223 bus->ops = &brcmf_usb_bus_ops;
1224 bus->proto_type = BRCMF_PROTO_BCDC;
1225 bus->always_use_fws_queue = true;
1227 bus->wowl_supported = true;
1230 devinfo->settings = brcmf_get_module_param(bus->dev, BRCMF_BUSTYPE_USB,
1233 if (!devinfo->settings) {
1238 if (!brcmf_usb_dlneeded(devinfo)) {
1239 ret = brcmf_usb_bus_setup(devinfo);
1243 mutex_unlock(&devinfo->dev_init_lock);
1246 bus->chip = bus_pub->devid;
1247 bus->chiprev = bus_pub->chiprev;
1249 ret = brcmf_fw_map_chip_to_name(bus_pub->devid, bus_pub->chiprev,
1251 ARRAY_SIZE(brcmf_usb_fwnames),
1252 devinfo->fw_name, NULL);
1256 /* request firmware here */
1257 ret = brcmf_fw_get_firmwares(dev, 0, devinfo->fw_name, NULL,
1258 brcmf_usb_probe_phase2);
1260 brcmf_err("firmware request failed: %d\n", ret);
1267 /* Release resources in reverse order */
1269 brcmf_usb_detach(devinfo);
1274 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1278 brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1280 brcmf_detach(devinfo->dev);
1281 kfree(devinfo->bus_pub.bus);
1282 brcmf_usb_detach(devinfo);
1286 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1288 struct usb_device *usb = interface_to_usbdev(intf);
1289 struct brcmf_usbdev_info *devinfo;
1290 struct usb_interface_descriptor *desc;
1291 struct usb_endpoint_descriptor *endpoint;
1294 u8 endpoint_num, ep;
1296 brcmf_dbg(USB, "Enter 0x%04x:0x%04x\n", id->idVendor, id->idProduct);
1298 devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1299 if (devinfo == NULL)
1302 devinfo->usbdev = usb;
1303 devinfo->dev = &usb->dev;
1304 /* Take an init lock, to protect for disconnect while still loading.
1305 * Necessary because of the asynchronous firmware load construction
1307 mutex_init(&devinfo->dev_init_lock);
1308 mutex_lock(&devinfo->dev_init_lock);
1310 usb_set_intfdata(intf, devinfo);
1312 /* Check that the device supports only one configuration */
1313 if (usb->descriptor.bNumConfigurations != 1) {
1314 brcmf_err("Number of configurations: %d not supported\n",
1315 usb->descriptor.bNumConfigurations);
1320 if ((usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) &&
1321 (usb->descriptor.bDeviceClass != USB_CLASS_MISC) &&
1322 (usb->descriptor.bDeviceClass != USB_CLASS_WIRELESS_CONTROLLER)) {
1323 brcmf_err("Device class: 0x%x not supported\n",
1324 usb->descriptor.bDeviceClass);
1329 desc = &intf->altsetting[0].desc;
1330 if ((desc->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
1331 (desc->bInterfaceSubClass != 2) ||
1332 (desc->bInterfaceProtocol != 0xff)) {
1333 brcmf_err("non WLAN interface %d: 0x%x:0x%x:0x%x\n",
1334 desc->bInterfaceNumber, desc->bInterfaceClass,
1335 desc->bInterfaceSubClass, desc->bInterfaceProtocol);
1340 num_of_eps = desc->bNumEndpoints;
1341 for (ep = 0; ep < num_of_eps; ep++) {
1342 endpoint = &intf->altsetting[0].endpoint[ep].desc;
1343 endpoint_num = usb_endpoint_num(endpoint);
1344 if (!usb_endpoint_xfer_bulk(endpoint))
1346 if (usb_endpoint_dir_in(endpoint)) {
1347 if (!devinfo->rx_pipe)
1349 usb_rcvbulkpipe(usb, endpoint_num);
1351 if (!devinfo->tx_pipe)
1353 usb_sndbulkpipe(usb, endpoint_num);
1356 if (devinfo->rx_pipe == 0) {
1357 brcmf_err("No RX (in) Bulk EP found\n");
1361 if (devinfo->tx_pipe == 0) {
1362 brcmf_err("No TX (out) Bulk EP found\n");
1367 devinfo->ifnum = desc->bInterfaceNumber;
1369 if (usb->speed == USB_SPEED_SUPER_PLUS)
1370 brcmf_dbg(USB, "Broadcom super speed plus USB WLAN interface detected\n");
1371 else if (usb->speed == USB_SPEED_SUPER)
1372 brcmf_dbg(USB, "Broadcom super speed USB WLAN interface detected\n");
1373 else if (usb->speed == USB_SPEED_HIGH)
1374 brcmf_dbg(USB, "Broadcom high speed USB WLAN interface detected\n");
1376 brcmf_dbg(USB, "Broadcom full speed USB WLAN interface detected\n");
1378 ret = brcmf_usb_probe_cb(devinfo);
1386 mutex_unlock(&devinfo->dev_init_lock);
1388 usb_set_intfdata(intf, NULL);
1393 brcmf_usb_disconnect(struct usb_interface *intf)
1395 struct brcmf_usbdev_info *devinfo;
1397 brcmf_dbg(USB, "Enter\n");
1398 devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1401 mutex_lock(&devinfo->dev_init_lock);
1402 /* Make sure that devinfo still exists. Firmware probe routines
1403 * may have released the device and cleared the intfdata.
1405 if (!usb_get_intfdata(intf))
1408 brcmf_usb_disconnect_cb(devinfo);
1412 brcmf_dbg(USB, "Exit\n");
1416 * only need to signal the bus being down and update the state.
1418 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1420 struct usb_device *usb = interface_to_usbdev(intf);
1421 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1423 brcmf_dbg(USB, "Enter\n");
1424 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1425 if (devinfo->wowl_enabled)
1426 brcmf_cancel_all_urbs(devinfo);
1428 brcmf_detach(&usb->dev);
1433 * (re-) start the bus.
1435 static int brcmf_usb_resume(struct usb_interface *intf)
1437 struct usb_device *usb = interface_to_usbdev(intf);
1438 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1440 brcmf_dbg(USB, "Enter\n");
1441 if (!devinfo->wowl_enabled)
1442 return brcmf_usb_bus_setup(devinfo);
1444 devinfo->bus_pub.state = BRCMFMAC_USB_STATE_UP;
1445 brcmf_usb_rx_fill_all(devinfo);
1449 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1451 struct usb_device *usb = interface_to_usbdev(intf);
1452 struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1454 brcmf_dbg(USB, "Enter\n");
1456 return brcmf_fw_get_firmwares(&usb->dev, 0, devinfo->fw_name, NULL,
1457 brcmf_usb_probe_phase2);
1460 #define BRCMF_USB_DEVICE(dev_id) \
1461 { USB_DEVICE(BRCM_USB_VENDOR_ID_BROADCOM, dev_id) }
1463 #define LINKSYS_USB_DEVICE(dev_id) \
1464 { USB_DEVICE(BRCM_USB_VENDOR_ID_LINKSYS, dev_id) }
1466 static struct usb_device_id brcmf_usb_devid_table[] = {
1467 BRCMF_USB_DEVICE(BRCM_USB_43143_DEVICE_ID),
1468 BRCMF_USB_DEVICE(BRCM_USB_43236_DEVICE_ID),
1469 BRCMF_USB_DEVICE(BRCM_USB_43242_DEVICE_ID),
1470 BRCMF_USB_DEVICE(BRCM_USB_43569_DEVICE_ID),
1471 LINKSYS_USB_DEVICE(BRCM_USB_43235_LINKSYS_DEVICE_ID),
1472 { USB_DEVICE(BRCM_USB_VENDOR_ID_LG, BRCM_USB_43242_LG_DEVICE_ID) },
1473 /* special entry for device with firmware loaded and running */
1474 BRCMF_USB_DEVICE(BRCM_USB_BCMFW_DEVICE_ID),
1475 { /* end: all zeroes */ }
1478 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1480 static struct usb_driver brcmf_usbdrvr = {
1481 .name = KBUILD_MODNAME,
1482 .probe = brcmf_usb_probe,
1483 .disconnect = brcmf_usb_disconnect,
1484 .id_table = brcmf_usb_devid_table,
1485 .suspend = brcmf_usb_suspend,
1486 .resume = brcmf_usb_resume,
1487 .reset_resume = brcmf_usb_reset_resume,
1488 .disable_hub_initiated_lpm = 1,
1491 static int brcmf_usb_reset_device(struct device *dev, void *notused)
1493 /* device past is the usb interface so we
1494 * need to use parent here.
1496 brcmf_dev_reset(dev->parent);
1500 void brcmf_usb_exit(void)
1502 struct device_driver *drv = &brcmf_usbdrvr.drvwrap.driver;
1505 brcmf_dbg(USB, "Enter\n");
1506 ret = driver_for_each_device(drv, NULL, NULL,
1507 brcmf_usb_reset_device);
1508 usb_deregister(&brcmf_usbdrvr);
1511 void brcmf_usb_register(void)
1513 brcmf_dbg(USB, "Enter\n");
1514 usb_register(&brcmf_usbdrvr);