xref: /openbmc/linux/drivers/net/wireless/broadcom/brcm80211/brcmfmac/usb.c (revision 8f8d5745bb520c76b81abef4a2cb3023d0313bfd)
1 /*
2  * Copyright (c) 2011 Broadcom Corporation
3  *
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.
7  *
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.
15  */
16 
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>
22 
23 #include <brcmu_utils.h>
24 #include <brcm_hw_ids.h>
25 #include <brcmu_wifi.h>
26 #include "bus.h"
27 #include "debug.h"
28 #include "firmware.h"
29 #include "usb.h"
30 #include "core.h"
31 #include "common.h"
32 #include "bcdc.h"
33 
34 
35 #define IOCTL_RESP_TIMEOUT		msecs_to_jiffies(2000)
36 
37 #define BRCMF_USB_RESET_GETVER_SPINWAIT	100	/* in unit of ms */
38 #define BRCMF_USB_RESET_GETVER_LOOP_CNT	10
39 
40 #define BRCMF_POSTBOOT_ID		0xA123  /* ID to detect if dongle
41 						   has boot up */
42 #define BRCMF_USB_NRXQ			50
43 #define BRCMF_USB_NTXQ			50
44 
45 #define BRCMF_USB_CBCTL_WRITE		0
46 #define BRCMF_USB_CBCTL_READ		1
47 #define BRCMF_USB_MAX_PKT_SIZE		1600
48 
49 BRCMF_FW_DEF(43143, "brcmfmac43143");
50 BRCMF_FW_DEF(43236B, "brcmfmac43236b");
51 BRCMF_FW_DEF(43242A, "brcmfmac43242a");
52 BRCMF_FW_DEF(43569, "brcmfmac43569");
53 BRCMF_FW_DEF(4373, "brcmfmac4373");
54 
55 static const struct brcmf_firmware_mapping brcmf_usb_fwnames[] = {
56 	BRCMF_FW_ENTRY(BRCM_CC_43143_CHIP_ID, 0xFFFFFFFF, 43143),
57 	BRCMF_FW_ENTRY(BRCM_CC_43235_CHIP_ID, 0x00000008, 43236B),
58 	BRCMF_FW_ENTRY(BRCM_CC_43236_CHIP_ID, 0x00000008, 43236B),
59 	BRCMF_FW_ENTRY(BRCM_CC_43238_CHIP_ID, 0x00000008, 43236B),
60 	BRCMF_FW_ENTRY(BRCM_CC_43242_CHIP_ID, 0xFFFFFFFF, 43242A),
61 	BRCMF_FW_ENTRY(BRCM_CC_43566_CHIP_ID, 0xFFFFFFFF, 43569),
62 	BRCMF_FW_ENTRY(BRCM_CC_43569_CHIP_ID, 0xFFFFFFFF, 43569),
63 	BRCMF_FW_ENTRY(CY_CC_4373_CHIP_ID, 0xFFFFFFFF, 4373)
64 };
65 
66 #define TRX_MAGIC		0x30524448	/* "HDR0" */
67 #define TRX_MAX_OFFSET		3		/* Max number of file offsets */
68 #define TRX_UNCOMP_IMAGE	0x20		/* Trx holds uncompressed img */
69 #define TRX_RDL_CHUNK		1500		/* size of each dl transfer */
70 #define TRX_OFFSETS_DLFWLEN_IDX	0
71 
72 /* Control messages: bRequest values */
73 #define DL_GETSTATE	0	/* returns the rdl_state_t struct */
74 #define DL_CHECK_CRC	1	/* currently unused */
75 #define DL_GO		2	/* execute downloaded image */
76 #define DL_START	3	/* initialize dl state */
77 #define DL_REBOOT	4	/* reboot the device in 2 seconds */
78 #define DL_GETVER	5	/* returns the bootrom_id_t struct */
79 #define DL_GO_PROTECTED	6	/* execute the downloaded code and set reset
80 				 * event to occur in 2 seconds.  It is the
81 				 * responsibility of the downloaded code to
82 				 * clear this event
83 				 */
84 #define DL_EXEC		7	/* jump to a supplied address */
85 #define DL_RESETCFG	8	/* To support single enum on dongle
86 				 * - Not used by bootloader
87 				 */
88 #define DL_DEFER_RESP_OK 9	/* Potentially defer the response to setup
89 				 * if resp unavailable
90 				 */
91 
92 /* states */
93 #define DL_WAITING	0	/* waiting to rx first pkt */
94 #define DL_READY	1	/* hdr was good, waiting for more of the
95 				 * compressed image
96 				 */
97 #define DL_BAD_HDR	2	/* hdr was corrupted */
98 #define DL_BAD_CRC	3	/* compressed image was corrupted */
99 #define DL_RUNNABLE	4	/* download was successful,waiting for go cmd */
100 #define DL_START_FAIL	5	/* failed to initialize correctly */
101 #define DL_NVRAM_TOOBIG	6	/* host specified nvram data exceeds DL_NVRAM
102 				 * value
103 				 */
104 #define DL_IMAGE_TOOBIG	7	/* firmware image too big */
105 
106 
107 struct trx_header_le {
108 	__le32 magic;		/* "HDR0" */
109 	__le32 len;		/* Length of file including header */
110 	__le32 crc32;		/* CRC from flag_version to end of file */
111 	__le32 flag_version;	/* 0:15 flags, 16:31 version */
112 	__le32 offsets[TRX_MAX_OFFSET];	/* Offsets of partitions from start of
113 					 * header
114 					 */
115 };
116 
117 struct rdl_state_le {
118 	__le32 state;
119 	__le32 bytes;
120 };
121 
122 struct bootrom_id_le {
123 	__le32 chip;		/* Chip id */
124 	__le32 chiprev;		/* Chip rev */
125 	__le32 ramsize;		/* Size of  RAM */
126 	__le32 remapbase;	/* Current remap base address */
127 	__le32 boardtype;	/* Type of board */
128 	__le32 boardrev;	/* Board revision */
129 };
130 
131 struct brcmf_usb_image {
132 	struct list_head list;
133 	s8 *fwname;
134 	u8 *image;
135 	int image_len;
136 };
137 
138 struct brcmf_usbdev_info {
139 	struct brcmf_usbdev bus_pub; /* MUST BE FIRST */
140 	spinlock_t qlock;
141 	struct list_head rx_freeq;
142 	struct list_head rx_postq;
143 	struct list_head tx_freeq;
144 	struct list_head tx_postq;
145 	uint rx_pipe, tx_pipe;
146 
147 	int rx_low_watermark;
148 	int tx_low_watermark;
149 	int tx_high_watermark;
150 	int tx_freecount;
151 	bool tx_flowblock;
152 	spinlock_t tx_flowblock_lock;
153 
154 	struct brcmf_usbreq *tx_reqs;
155 	struct brcmf_usbreq *rx_reqs;
156 
157 	char fw_name[BRCMF_FW_NAME_LEN];
158 	const u8 *image;	/* buffer for combine fw and nvram */
159 	int image_len;
160 
161 	struct usb_device *usbdev;
162 	struct device *dev;
163 	struct mutex dev_init_lock;
164 
165 	int ctl_in_pipe, ctl_out_pipe;
166 	struct urb *ctl_urb; /* URB for control endpoint */
167 	struct usb_ctrlrequest ctl_write;
168 	struct usb_ctrlrequest ctl_read;
169 	u32 ctl_urb_actual_length;
170 	int ctl_urb_status;
171 	int ctl_completed;
172 	wait_queue_head_t ioctl_resp_wait;
173 	ulong ctl_op;
174 	u8 ifnum;
175 
176 	struct urb *bulk_urb; /* used for FW download */
177 
178 	bool wowl_enabled;
179 	struct brcmf_mp_device *settings;
180 };
181 
182 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
183 				struct brcmf_usbreq  *req);
184 
185 static struct brcmf_usbdev *brcmf_usb_get_buspub(struct device *dev)
186 {
187 	struct brcmf_bus *bus_if = dev_get_drvdata(dev);
188 	return bus_if->bus_priv.usb;
189 }
190 
191 static struct brcmf_usbdev_info *brcmf_usb_get_businfo(struct device *dev)
192 {
193 	return brcmf_usb_get_buspub(dev)->devinfo;
194 }
195 
196 static int brcmf_usb_ioctl_resp_wait(struct brcmf_usbdev_info *devinfo)
197 {
198 	return wait_event_timeout(devinfo->ioctl_resp_wait,
199 				  devinfo->ctl_completed, IOCTL_RESP_TIMEOUT);
200 }
201 
202 static void brcmf_usb_ioctl_resp_wake(struct brcmf_usbdev_info *devinfo)
203 {
204 	wake_up(&devinfo->ioctl_resp_wait);
205 }
206 
207 static void
208 brcmf_usb_ctl_complete(struct brcmf_usbdev_info *devinfo, int type, int status)
209 {
210 	brcmf_dbg(USB, "Enter, status=%d\n", status);
211 
212 	if (unlikely(devinfo == NULL))
213 		return;
214 
215 	if (type == BRCMF_USB_CBCTL_READ) {
216 		if (status == 0)
217 			devinfo->bus_pub.stats.rx_ctlpkts++;
218 		else
219 			devinfo->bus_pub.stats.rx_ctlerrs++;
220 	} else if (type == BRCMF_USB_CBCTL_WRITE) {
221 		if (status == 0)
222 			devinfo->bus_pub.stats.tx_ctlpkts++;
223 		else
224 			devinfo->bus_pub.stats.tx_ctlerrs++;
225 	}
226 
227 	devinfo->ctl_urb_status = status;
228 	devinfo->ctl_completed = true;
229 	brcmf_usb_ioctl_resp_wake(devinfo);
230 }
231 
232 static void
233 brcmf_usb_ctlread_complete(struct urb *urb)
234 {
235 	struct brcmf_usbdev_info *devinfo =
236 		(struct brcmf_usbdev_info *)urb->context;
237 
238 	brcmf_dbg(USB, "Enter\n");
239 	devinfo->ctl_urb_actual_length = urb->actual_length;
240 	brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_READ,
241 		urb->status);
242 }
243 
244 static void
245 brcmf_usb_ctlwrite_complete(struct urb *urb)
246 {
247 	struct brcmf_usbdev_info *devinfo =
248 		(struct brcmf_usbdev_info *)urb->context;
249 
250 	brcmf_dbg(USB, "Enter\n");
251 	brcmf_usb_ctl_complete(devinfo, BRCMF_USB_CBCTL_WRITE,
252 		urb->status);
253 }
254 
255 static int
256 brcmf_usb_send_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
257 {
258 	int ret;
259 	u16 size;
260 
261 	brcmf_dbg(USB, "Enter\n");
262 	if (devinfo == NULL || buf == NULL ||
263 	    len == 0 || devinfo->ctl_urb == NULL)
264 		return -EINVAL;
265 
266 	size = len;
267 	devinfo->ctl_write.wLength = cpu_to_le16p(&size);
268 	devinfo->ctl_urb->transfer_buffer_length = size;
269 	devinfo->ctl_urb_status = 0;
270 	devinfo->ctl_urb_actual_length = 0;
271 
272 	usb_fill_control_urb(devinfo->ctl_urb,
273 		devinfo->usbdev,
274 		devinfo->ctl_out_pipe,
275 		(unsigned char *) &devinfo->ctl_write,
276 		buf, size,
277 		(usb_complete_t)brcmf_usb_ctlwrite_complete,
278 		devinfo);
279 
280 	ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
281 	if (ret < 0)
282 		brcmf_err("usb_submit_urb failed %d\n", ret);
283 
284 	return ret;
285 }
286 
287 static int
288 brcmf_usb_recv_ctl(struct brcmf_usbdev_info *devinfo, u8 *buf, int len)
289 {
290 	int ret;
291 	u16 size;
292 
293 	brcmf_dbg(USB, "Enter\n");
294 	if ((devinfo == NULL) || (buf == NULL) || (len == 0)
295 		|| (devinfo->ctl_urb == NULL))
296 		return -EINVAL;
297 
298 	size = len;
299 	devinfo->ctl_read.wLength = cpu_to_le16p(&size);
300 	devinfo->ctl_urb->transfer_buffer_length = size;
301 
302 	devinfo->ctl_read.bRequestType = USB_DIR_IN
303 		| USB_TYPE_CLASS | USB_RECIP_INTERFACE;
304 	devinfo->ctl_read.bRequest = 1;
305 
306 	usb_fill_control_urb(devinfo->ctl_urb,
307 		devinfo->usbdev,
308 		devinfo->ctl_in_pipe,
309 		(unsigned char *) &devinfo->ctl_read,
310 		buf, size,
311 		(usb_complete_t)brcmf_usb_ctlread_complete,
312 		devinfo);
313 
314 	ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
315 	if (ret < 0)
316 		brcmf_err("usb_submit_urb failed %d\n", ret);
317 
318 	return ret;
319 }
320 
321 static int brcmf_usb_tx_ctlpkt(struct device *dev, u8 *buf, u32 len)
322 {
323 	int err = 0;
324 	int timeout = 0;
325 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
326 
327 	brcmf_dbg(USB, "Enter\n");
328 	if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
329 		return -EIO;
330 
331 	if (test_and_set_bit(0, &devinfo->ctl_op))
332 		return -EIO;
333 
334 	devinfo->ctl_completed = false;
335 	err = brcmf_usb_send_ctl(devinfo, buf, len);
336 	if (err) {
337 		brcmf_err("fail %d bytes: %d\n", err, len);
338 		clear_bit(0, &devinfo->ctl_op);
339 		return err;
340 	}
341 	timeout = brcmf_usb_ioctl_resp_wait(devinfo);
342 	clear_bit(0, &devinfo->ctl_op);
343 	if (!timeout) {
344 		brcmf_err("Txctl wait timed out\n");
345 		err = -EIO;
346 	}
347 	return err;
348 }
349 
350 static int brcmf_usb_rx_ctlpkt(struct device *dev, u8 *buf, u32 len)
351 {
352 	int err = 0;
353 	int timeout = 0;
354 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
355 
356 	brcmf_dbg(USB, "Enter\n");
357 	if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP)
358 		return -EIO;
359 
360 	if (test_and_set_bit(0, &devinfo->ctl_op))
361 		return -EIO;
362 
363 	devinfo->ctl_completed = false;
364 	err = brcmf_usb_recv_ctl(devinfo, buf, len);
365 	if (err) {
366 		brcmf_err("fail %d bytes: %d\n", err, len);
367 		clear_bit(0, &devinfo->ctl_op);
368 		return err;
369 	}
370 	timeout = brcmf_usb_ioctl_resp_wait(devinfo);
371 	err = devinfo->ctl_urb_status;
372 	clear_bit(0, &devinfo->ctl_op);
373 	if (!timeout) {
374 		brcmf_err("rxctl wait timed out\n");
375 		err = -EIO;
376 	}
377 	if (!err)
378 		return devinfo->ctl_urb_actual_length;
379 	else
380 		return err;
381 }
382 
383 static struct brcmf_usbreq *brcmf_usb_deq(struct brcmf_usbdev_info *devinfo,
384 					  struct list_head *q, int *counter)
385 {
386 	unsigned long flags;
387 	struct brcmf_usbreq  *req;
388 	spin_lock_irqsave(&devinfo->qlock, flags);
389 	if (list_empty(q)) {
390 		spin_unlock_irqrestore(&devinfo->qlock, flags);
391 		return NULL;
392 	}
393 	req = list_entry(q->next, struct brcmf_usbreq, list);
394 	list_del_init(q->next);
395 	if (counter)
396 		(*counter)--;
397 	spin_unlock_irqrestore(&devinfo->qlock, flags);
398 	return req;
399 
400 }
401 
402 static void brcmf_usb_enq(struct brcmf_usbdev_info *devinfo,
403 			  struct list_head *q, struct brcmf_usbreq *req,
404 			  int *counter)
405 {
406 	unsigned long flags;
407 	spin_lock_irqsave(&devinfo->qlock, flags);
408 	list_add_tail(&req->list, q);
409 	if (counter)
410 		(*counter)++;
411 	spin_unlock_irqrestore(&devinfo->qlock, flags);
412 }
413 
414 static struct brcmf_usbreq *
415 brcmf_usbdev_qinit(struct list_head *q, int qsize)
416 {
417 	int i;
418 	struct brcmf_usbreq *req, *reqs;
419 
420 	reqs = kcalloc(qsize, sizeof(struct brcmf_usbreq), GFP_ATOMIC);
421 	if (reqs == NULL)
422 		return NULL;
423 
424 	req = reqs;
425 
426 	for (i = 0; i < qsize; i++) {
427 		req->urb = usb_alloc_urb(0, GFP_ATOMIC);
428 		if (!req->urb)
429 			goto fail;
430 
431 		INIT_LIST_HEAD(&req->list);
432 		list_add_tail(&req->list, q);
433 		req++;
434 	}
435 	return reqs;
436 fail:
437 	brcmf_err("fail!\n");
438 	while (!list_empty(q)) {
439 		req = list_entry(q->next, struct brcmf_usbreq, list);
440 		if (req)
441 			usb_free_urb(req->urb);
442 		list_del(q->next);
443 	}
444 	return NULL;
445 
446 }
447 
448 static void brcmf_usb_free_q(struct list_head *q, bool pending)
449 {
450 	struct brcmf_usbreq *req, *next;
451 	int i = 0;
452 	list_for_each_entry_safe(req, next, q, list) {
453 		if (!req->urb) {
454 			brcmf_err("bad req\n");
455 			break;
456 		}
457 		i++;
458 		if (pending) {
459 			usb_kill_urb(req->urb);
460 		} else {
461 			usb_free_urb(req->urb);
462 			list_del_init(&req->list);
463 		}
464 	}
465 }
466 
467 static void brcmf_usb_del_fromq(struct brcmf_usbdev_info *devinfo,
468 				struct brcmf_usbreq *req)
469 {
470 	unsigned long flags;
471 
472 	spin_lock_irqsave(&devinfo->qlock, flags);
473 	list_del_init(&req->list);
474 	spin_unlock_irqrestore(&devinfo->qlock, flags);
475 }
476 
477 
478 static void brcmf_usb_tx_complete(struct urb *urb)
479 {
480 	struct brcmf_usbreq *req = (struct brcmf_usbreq *)urb->context;
481 	struct brcmf_usbdev_info *devinfo = req->devinfo;
482 	unsigned long flags;
483 
484 	brcmf_dbg(USB, "Enter, urb->status=%d, skb=%p\n", urb->status,
485 		  req->skb);
486 	brcmf_usb_del_fromq(devinfo, req);
487 
488 	brcmf_proto_bcdc_txcomplete(devinfo->dev, req->skb, urb->status == 0);
489 	req->skb = NULL;
490 	brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req, &devinfo->tx_freecount);
491 	spin_lock_irqsave(&devinfo->tx_flowblock_lock, flags);
492 	if (devinfo->tx_freecount > devinfo->tx_high_watermark &&
493 		devinfo->tx_flowblock) {
494 		brcmf_proto_bcdc_txflowblock(devinfo->dev, false);
495 		devinfo->tx_flowblock = false;
496 	}
497 	spin_unlock_irqrestore(&devinfo->tx_flowblock_lock, flags);
498 }
499 
500 static void brcmf_usb_rx_complete(struct urb *urb)
501 {
502 	struct brcmf_usbreq  *req = (struct brcmf_usbreq *)urb->context;
503 	struct brcmf_usbdev_info *devinfo = req->devinfo;
504 	struct sk_buff *skb;
505 
506 	brcmf_dbg(USB, "Enter, urb->status=%d\n", urb->status);
507 	brcmf_usb_del_fromq(devinfo, req);
508 	skb = req->skb;
509 	req->skb = NULL;
510 
511 	/* zero length packets indicate usb "failure". Do not refill */
512 	if (urb->status != 0 || !urb->actual_length) {
513 		brcmu_pkt_buf_free_skb(skb);
514 		brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
515 		return;
516 	}
517 
518 	if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP) {
519 		skb_put(skb, urb->actual_length);
520 		brcmf_rx_frame(devinfo->dev, skb, true);
521 		brcmf_usb_rx_refill(devinfo, req);
522 	} else {
523 		brcmu_pkt_buf_free_skb(skb);
524 		brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
525 	}
526 	return;
527 
528 }
529 
530 static void brcmf_usb_rx_refill(struct brcmf_usbdev_info *devinfo,
531 				struct brcmf_usbreq  *req)
532 {
533 	struct sk_buff *skb;
534 	int ret;
535 
536 	if (!req || !devinfo)
537 		return;
538 
539 	skb = dev_alloc_skb(devinfo->bus_pub.bus_mtu);
540 	if (!skb) {
541 		brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
542 		return;
543 	}
544 	req->skb = skb;
545 
546 	usb_fill_bulk_urb(req->urb, devinfo->usbdev, devinfo->rx_pipe,
547 			  skb->data, skb_tailroom(skb), brcmf_usb_rx_complete,
548 			  req);
549 	req->devinfo = devinfo;
550 	brcmf_usb_enq(devinfo, &devinfo->rx_postq, req, NULL);
551 
552 	ret = usb_submit_urb(req->urb, GFP_ATOMIC);
553 	if (ret) {
554 		brcmf_usb_del_fromq(devinfo, req);
555 		brcmu_pkt_buf_free_skb(req->skb);
556 		req->skb = NULL;
557 		brcmf_usb_enq(devinfo, &devinfo->rx_freeq, req, NULL);
558 	}
559 	return;
560 }
561 
562 static void brcmf_usb_rx_fill_all(struct brcmf_usbdev_info *devinfo)
563 {
564 	struct brcmf_usbreq *req;
565 
566 	if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
567 		brcmf_err("bus is not up=%d\n", devinfo->bus_pub.state);
568 		return;
569 	}
570 	while ((req = brcmf_usb_deq(devinfo, &devinfo->rx_freeq, NULL)) != NULL)
571 		brcmf_usb_rx_refill(devinfo, req);
572 }
573 
574 static void
575 brcmf_usb_state_change(struct brcmf_usbdev_info *devinfo, int state)
576 {
577 	struct brcmf_bus *bcmf_bus = devinfo->bus_pub.bus;
578 
579 	brcmf_dbg(USB, "Enter, current state=%d, new state=%d\n",
580 		  devinfo->bus_pub.state, state);
581 
582 	if (devinfo->bus_pub.state == state)
583 		return;
584 
585 	devinfo->bus_pub.state = state;
586 
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);
594 	} else {
595 		brcmf_dbg(USB, "DBUS current state=%d\n", state);
596 	}
597 }
598 
599 static int brcmf_usb_tx(struct device *dev, struct sk_buff *skb)
600 {
601 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
602 	struct brcmf_usbreq  *req;
603 	int ret;
604 	unsigned long flags;
605 
606 	brcmf_dbg(USB, "Enter, skb=%p\n", skb);
607 	if (devinfo->bus_pub.state != BRCMFMAC_USB_STATE_UP) {
608 		ret = -EIO;
609 		goto fail;
610 	}
611 
612 	req = brcmf_usb_deq(devinfo, &devinfo->tx_freeq,
613 					&devinfo->tx_freecount);
614 	if (!req) {
615 		brcmf_err("no req to send\n");
616 		ret = -ENOMEM;
617 		goto fail;
618 	}
619 
620 	req->skb = skb;
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);
627 	if (ret) {
628 		brcmf_err("brcmf_usb_tx usb_submit_urb FAILED\n");
629 		brcmf_usb_del_fromq(devinfo, req);
630 		req->skb = NULL;
631 		brcmf_usb_enq(devinfo, &devinfo->tx_freeq, req,
632 			      &devinfo->tx_freecount);
633 		goto fail;
634 	}
635 
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;
641 	}
642 	spin_unlock_irqrestore(&devinfo->tx_flowblock_lock, flags);
643 	return 0;
644 
645 fail:
646 	return ret;
647 }
648 
649 
650 static int brcmf_usb_up(struct device *dev)
651 {
652 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
653 
654 	brcmf_dbg(USB, "Enter\n");
655 	if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_UP)
656 		return 0;
657 
658 	/* Success, indicate devinfo is fully up */
659 	brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_UP);
660 
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);
664 
665 		/* CTL Write */
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);
671 
672 		/* CTL Read */
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);
678 	}
679 	brcmf_usb_rx_fill_all(devinfo);
680 	return 0;
681 }
682 
683 static void brcmf_cancel_all_urbs(struct brcmf_usbdev_info *devinfo)
684 {
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);
691 }
692 
693 static void brcmf_usb_down(struct device *dev)
694 {
695 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
696 
697 	brcmf_dbg(USB, "Enter\n");
698 	if (devinfo == NULL)
699 		return;
700 
701 	if (devinfo->bus_pub.state == BRCMFMAC_USB_STATE_DOWN)
702 		return;
703 
704 	brcmf_usb_state_change(devinfo, BRCMFMAC_USB_STATE_DOWN);
705 
706 	brcmf_cancel_all_urbs(devinfo);
707 }
708 
709 static void
710 brcmf_usb_sync_complete(struct urb *urb)
711 {
712 	struct brcmf_usbdev_info *devinfo =
713 			(struct brcmf_usbdev_info *)urb->context;
714 
715 	devinfo->ctl_completed = true;
716 	brcmf_usb_ioctl_resp_wake(devinfo);
717 }
718 
719 static int brcmf_usb_dl_cmd(struct brcmf_usbdev_info *devinfo, u8 cmd,
720 			    void *buffer, int buflen)
721 {
722 	int ret;
723 	char *tmpbuf;
724 	u16 size;
725 
726 	if ((!devinfo) || (devinfo->ctl_urb == NULL))
727 		return -EINVAL;
728 
729 	tmpbuf = kmalloc(buflen, GFP_ATOMIC);
730 	if (!tmpbuf)
731 		return -ENOMEM;
732 
733 	size = buflen;
734 	devinfo->ctl_urb->transfer_buffer_length = size;
735 
736 	devinfo->ctl_read.wLength = cpu_to_le16p(&size);
737 	devinfo->ctl_read.bRequestType = USB_DIR_IN | USB_TYPE_VENDOR |
738 		USB_RECIP_INTERFACE;
739 	devinfo->ctl_read.bRequest = cmd;
740 
741 	usb_fill_control_urb(devinfo->ctl_urb,
742 		devinfo->usbdev,
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);
747 
748 	devinfo->ctl_completed = false;
749 	ret = usb_submit_urb(devinfo->ctl_urb, GFP_ATOMIC);
750 	if (ret < 0) {
751 		brcmf_err("usb_submit_urb failed %d\n", ret);
752 		goto finalize;
753 	}
754 
755 	if (!brcmf_usb_ioctl_resp_wait(devinfo)) {
756 		usb_kill_urb(devinfo->ctl_urb);
757 		ret = -ETIMEDOUT;
758 	} else {
759 		memcpy(buffer, tmpbuf, buflen);
760 	}
761 
762 finalize:
763 	kfree(tmpbuf);
764 	return ret;
765 }
766 
767 static bool
768 brcmf_usb_dlneeded(struct brcmf_usbdev_info *devinfo)
769 {
770 	struct bootrom_id_le id;
771 	u32 chipid, chiprev;
772 
773 	brcmf_dbg(USB, "Enter\n");
774 
775 	if (devinfo == NULL)
776 		return false;
777 
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));
781 
782 	chipid = le32_to_cpu(id.chip);
783 	chiprev = le32_to_cpu(id.chiprev);
784 
785 	if ((chipid & 0x4300) == 0x4300)
786 		brcmf_dbg(USB, "chip %x rev 0x%x\n", chipid, chiprev);
787 	else
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));
792 		return false;
793 	} else {
794 		devinfo->bus_pub.devid = chipid;
795 		devinfo->bus_pub.chiprev = chiprev;
796 	}
797 	return true;
798 }
799 
800 static int
801 brcmf_usb_resetcfg(struct brcmf_usbdev_info *devinfo)
802 {
803 	struct bootrom_id_le id;
804 	u32 loop_cnt;
805 	int err;
806 
807 	brcmf_dbg(USB, "Enter\n");
808 
809 	loop_cnt = 0;
810 	do {
811 		mdelay(BRCMF_USB_RESET_GETVER_SPINWAIT);
812 		loop_cnt++;
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))
816 			return err;
817 		if (id.chip == cpu_to_le32(BRCMF_POSTBOOT_ID))
818 			break;
819 	} while (loop_cnt < BRCMF_USB_RESET_GETVER_LOOP_CNT);
820 
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));
824 
825 		brcmf_usb_dl_cmd(devinfo, DL_RESETCFG, &id, sizeof(id));
826 		return 0;
827 	} else {
828 		brcmf_err("Cannot talk to Dongle. Firmware is not UP, %d ms\n",
829 			  BRCMF_USB_RESET_GETVER_SPINWAIT * loop_cnt);
830 		return -EINVAL;
831 	}
832 }
833 
834 
835 static int
836 brcmf_usb_dl_send_bulk(struct brcmf_usbdev_info *devinfo, void *buffer, int len)
837 {
838 	int ret;
839 
840 	if ((devinfo == NULL) || (devinfo->bulk_urb == NULL))
841 		return -EINVAL;
842 
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);
847 
848 	devinfo->bulk_urb->transfer_flags |= URB_ZERO_PACKET;
849 
850 	devinfo->ctl_completed = false;
851 	ret = usb_submit_urb(devinfo->bulk_urb, GFP_ATOMIC);
852 	if (ret) {
853 		brcmf_err("usb_submit_urb failed %d\n", ret);
854 		return ret;
855 	}
856 	ret = brcmf_usb_ioctl_resp_wait(devinfo);
857 	return (ret == 0);
858 }
859 
860 static int
861 brcmf_usb_dl_writeimage(struct brcmf_usbdev_info *devinfo, u8 *fw, int fwlen)
862 {
863 	unsigned int sendlen, sent, dllen;
864 	char *bulkchunk = NULL, *dlpos;
865 	struct rdl_state_le state;
866 	u32 rdlstate, rdlbytes;
867 	int err = 0;
868 
869 	brcmf_dbg(USB, "Enter, fw %p, len %d\n", fw, fwlen);
870 
871 	bulkchunk = kmalloc(TRX_RDL_CHUNK, GFP_ATOMIC);
872 	if (bulkchunk == NULL) {
873 		err = -ENOMEM;
874 		goto fail;
875 	}
876 
877 	/* 1) Prepare USB boot loader for runtime image */
878 	brcmf_usb_dl_cmd(devinfo, DL_START, &state, sizeof(state));
879 
880 	rdlstate = le32_to_cpu(state.state);
881 	rdlbytes = le32_to_cpu(state.bytes);
882 
883 	/* 2) Check we are in the Waiting state */
884 	if (rdlstate != DL_WAITING) {
885 		brcmf_err("Failed to DL_START\n");
886 		err = -EINVAL;
887 		goto fail;
888 	}
889 	sent = 0;
890 	dlpos = fw;
891 	dllen = fwlen;
892 
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;
900 			else
901 				sendlen = TRX_RDL_CHUNK;
902 
903 			/* simply avoid having to send a ZLP by ensuring we
904 			 * never have an even
905 			 * multiple of 64
906 			 */
907 			if (!(sendlen % 64))
908 				sendlen -= 4;
909 
910 			/* send data */
911 			memcpy(bulkchunk, dlpos, sendlen);
912 			if (brcmf_usb_dl_send_bulk(devinfo, bulkchunk,
913 						   sendlen)) {
914 				brcmf_err("send_bulk failed\n");
915 				err = -EINVAL;
916 				goto fail;
917 			}
918 
919 			dlpos += sendlen;
920 			sent += sendlen;
921 		}
922 		err = brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state,
923 				       sizeof(state));
924 		if (err) {
925 			brcmf_err("DL_GETSTATE Failed\n");
926 			goto fail;
927 		}
928 
929 		rdlstate = le32_to_cpu(state.state);
930 		rdlbytes = le32_to_cpu(state.bytes);
931 
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",
935 				  rdlstate);
936 			err = -EINVAL;
937 			goto fail;
938 		}
939 	}
940 
941 fail:
942 	kfree(bulkchunk);
943 	brcmf_dbg(USB, "Exit, err=%d\n", err);
944 	return err;
945 }
946 
947 static int brcmf_usb_dlstart(struct brcmf_usbdev_info *devinfo, u8 *fw, int len)
948 {
949 	int err;
950 
951 	brcmf_dbg(USB, "Enter\n");
952 
953 	if (devinfo == NULL)
954 		return -EINVAL;
955 
956 	if (devinfo->bus_pub.devid == 0xDEAD)
957 		return -EINVAL;
958 
959 	err = brcmf_usb_dl_writeimage(devinfo, fw, len);
960 	if (err == 0)
961 		devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_DONE;
962 	else
963 		devinfo->bus_pub.state = BRCMFMAC_USB_STATE_DL_FAIL;
964 	brcmf_dbg(USB, "Exit, err=%d\n", err);
965 
966 	return err;
967 }
968 
969 static int brcmf_usb_dlrun(struct brcmf_usbdev_info *devinfo)
970 {
971 	struct rdl_state_le state;
972 
973 	brcmf_dbg(USB, "Enter\n");
974 	if (!devinfo)
975 		return -EINVAL;
976 
977 	if (devinfo->bus_pub.devid == 0xDEAD)
978 		return -EINVAL;
979 
980 	/* Check we are runnable */
981 	state.state = 0;
982 	brcmf_usb_dl_cmd(devinfo, DL_GETSTATE, &state, sizeof(state));
983 
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)))
987 			return -ENODEV;
988 		if (brcmf_usb_resetcfg(devinfo))
989 			return -ENODEV;
990 		/* The Dongle may go for re-enumeration. */
991 	} else {
992 		brcmf_err("Dongle not runnable\n");
993 		return -EINVAL;
994 	}
995 	brcmf_dbg(USB, "Exit\n");
996 	return 0;
997 }
998 
999 static int
1000 brcmf_usb_fw_download(struct brcmf_usbdev_info *devinfo)
1001 {
1002 	int err;
1003 
1004 	brcmf_dbg(USB, "Enter\n");
1005 	if (devinfo == NULL)
1006 		return -ENODEV;
1007 
1008 	if (!devinfo->image) {
1009 		brcmf_err("No firmware!\n");
1010 		return -ENOENT;
1011 	}
1012 
1013 	err = brcmf_usb_dlstart(devinfo,
1014 		(u8 *)devinfo->image, devinfo->image_len);
1015 	if (err == 0)
1016 		err = brcmf_usb_dlrun(devinfo);
1017 	return err;
1018 }
1019 
1020 
1021 static void brcmf_usb_detach(struct brcmf_usbdev_info *devinfo)
1022 {
1023 	brcmf_dbg(USB, "Enter, devinfo %p\n", devinfo);
1024 
1025 	/* free the URBS */
1026 	brcmf_usb_free_q(&devinfo->rx_freeq, false);
1027 	brcmf_usb_free_q(&devinfo->tx_freeq, false);
1028 
1029 	usb_free_urb(devinfo->ctl_urb);
1030 	usb_free_urb(devinfo->bulk_urb);
1031 
1032 	kfree(devinfo->tx_reqs);
1033 	kfree(devinfo->rx_reqs);
1034 
1035 	if (devinfo->settings)
1036 		brcmf_release_module_param(devinfo->settings);
1037 }
1038 
1039 
1040 static int check_file(const u8 *headers)
1041 {
1042 	struct trx_header_le *trx;
1043 	int actual_len = -1;
1044 
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))
1049 		return -1;
1050 
1051 	headers += sizeof(struct trx_header_le);
1052 
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);
1056 	}
1057 	return -1;
1058 }
1059 
1060 
1061 static
1062 struct brcmf_usbdev *brcmf_usb_attach(struct brcmf_usbdev_info *devinfo,
1063 				      int nrxq, int ntxq)
1064 {
1065 	brcmf_dbg(USB, "Enter\n");
1066 
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;
1072 
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;
1077 
1078 	/* Initialize other structure content */
1079 	init_waitqueue_head(&devinfo->ioctl_resp_wait);
1080 
1081 	/* Initialize the spinlocks */
1082 	spin_lock_init(&devinfo->qlock);
1083 	spin_lock_init(&devinfo->tx_flowblock_lock);
1084 
1085 	INIT_LIST_HEAD(&devinfo->rx_freeq);
1086 	INIT_LIST_HEAD(&devinfo->rx_postq);
1087 
1088 	INIT_LIST_HEAD(&devinfo->tx_freeq);
1089 	INIT_LIST_HEAD(&devinfo->tx_postq);
1090 
1091 	devinfo->tx_flowblock = false;
1092 
1093 	devinfo->rx_reqs = brcmf_usbdev_qinit(&devinfo->rx_freeq, nrxq);
1094 	if (!devinfo->rx_reqs)
1095 		goto error;
1096 
1097 	devinfo->tx_reqs = brcmf_usbdev_qinit(&devinfo->tx_freeq, ntxq);
1098 	if (!devinfo->tx_reqs)
1099 		goto error;
1100 	devinfo->tx_freecount = ntxq;
1101 
1102 	devinfo->ctl_urb = usb_alloc_urb(0, GFP_ATOMIC);
1103 	if (!devinfo->ctl_urb)
1104 		goto error;
1105 	devinfo->bulk_urb = usb_alloc_urb(0, GFP_ATOMIC);
1106 	if (!devinfo->bulk_urb)
1107 		goto error;
1108 
1109 	return &devinfo->bus_pub;
1110 
1111 error:
1112 	brcmf_err("failed!\n");
1113 	brcmf_usb_detach(devinfo);
1114 	return NULL;
1115 }
1116 
1117 static void brcmf_usb_wowl_config(struct device *dev, bool enabled)
1118 {
1119 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(dev);
1120 
1121 	brcmf_dbg(USB, "Configuring WOWL, enabled=%d\n", enabled);
1122 	devinfo->wowl_enabled = enabled;
1123 	if (enabled)
1124 		device_set_wakeup_enable(devinfo->dev, true);
1125 	else
1126 		device_set_wakeup_enable(devinfo->dev, false);
1127 }
1128 
1129 static
1130 int brcmf_usb_get_fwname(struct device *dev, const char *ext, u8 *fw_name)
1131 {
1132 	struct brcmf_bus *bus = dev_get_drvdata(dev);
1133 	struct brcmf_fw_request *fwreq;
1134 	struct brcmf_fw_name fwnames[] = {
1135 		{ ext, fw_name },
1136 	};
1137 
1138 	fwreq = brcmf_fw_alloc_request(bus->chip, bus->chiprev,
1139 				       brcmf_usb_fwnames,
1140 				       ARRAY_SIZE(brcmf_usb_fwnames),
1141 				       fwnames, ARRAY_SIZE(fwnames));
1142 	if (!fwreq)
1143 		return -ENOMEM;
1144 
1145 	kfree(fwreq);
1146 	return 0;
1147 }
1148 
1149 static const struct brcmf_bus_ops brcmf_usb_bus_ops = {
1150 	.preinit = brcmf_usb_up,
1151 	.stop = brcmf_usb_down,
1152 	.txdata = brcmf_usb_tx,
1153 	.txctl = brcmf_usb_tx_ctlpkt,
1154 	.rxctl = brcmf_usb_rx_ctlpkt,
1155 	.wowl_config = brcmf_usb_wowl_config,
1156 	.get_fwname = brcmf_usb_get_fwname,
1157 };
1158 
1159 #define BRCMF_USB_FW_CODE	0
1160 
1161 static void brcmf_usb_probe_phase2(struct device *dev, int ret,
1162 				   struct brcmf_fw_request *fwreq)
1163 {
1164 	struct brcmf_bus *bus = dev_get_drvdata(dev);
1165 	struct brcmf_usbdev_info *devinfo = bus->bus_priv.usb->devinfo;
1166 	const struct firmware *fw;
1167 
1168 	if (ret)
1169 		goto error;
1170 
1171 	brcmf_dbg(USB, "Start fw downloading\n");
1172 
1173 	fw = fwreq->items[BRCMF_USB_FW_CODE].binary;
1174 	kfree(fwreq);
1175 
1176 	ret = check_file(fw->data);
1177 	if (ret < 0) {
1178 		brcmf_err("invalid firmware\n");
1179 		release_firmware(fw);
1180 		goto error;
1181 	}
1182 
1183 	devinfo->image = fw->data;
1184 	devinfo->image_len = fw->size;
1185 
1186 	ret = brcmf_usb_fw_download(devinfo);
1187 	release_firmware(fw);
1188 	if (ret)
1189 		goto error;
1190 
1191 	/* Attach to the common driver interface */
1192 	ret = brcmf_attach(devinfo->dev, devinfo->settings);
1193 	if (ret)
1194 		goto error;
1195 
1196 	mutex_unlock(&devinfo->dev_init_lock);
1197 	return;
1198 error:
1199 	brcmf_dbg(TRACE, "failed: dev=%s, err=%d\n", dev_name(dev), ret);
1200 	mutex_unlock(&devinfo->dev_init_lock);
1201 	device_release_driver(dev);
1202 }
1203 
1204 static struct brcmf_fw_request *
1205 brcmf_usb_prepare_fw_request(struct brcmf_usbdev_info *devinfo)
1206 {
1207 	struct brcmf_fw_request *fwreq;
1208 	struct brcmf_fw_name fwnames[] = {
1209 		{ ".bin", devinfo->fw_name },
1210 	};
1211 
1212 	fwreq = brcmf_fw_alloc_request(devinfo->bus_pub.devid,
1213 				       devinfo->bus_pub.chiprev,
1214 				       brcmf_usb_fwnames,
1215 				       ARRAY_SIZE(brcmf_usb_fwnames),
1216 				       fwnames, ARRAY_SIZE(fwnames));
1217 	if (!fwreq)
1218 		return NULL;
1219 
1220 	fwreq->items[BRCMF_USB_FW_CODE].type = BRCMF_FW_TYPE_BINARY;
1221 
1222 	return fwreq;
1223 }
1224 
1225 static int brcmf_usb_probe_cb(struct brcmf_usbdev_info *devinfo)
1226 {
1227 	struct brcmf_bus *bus = NULL;
1228 	struct brcmf_usbdev *bus_pub = NULL;
1229 	struct device *dev = devinfo->dev;
1230 	struct brcmf_fw_request *fwreq;
1231 	int ret;
1232 
1233 	brcmf_dbg(USB, "Enter\n");
1234 	bus_pub = brcmf_usb_attach(devinfo, BRCMF_USB_NRXQ, BRCMF_USB_NTXQ);
1235 	if (!bus_pub)
1236 		return -ENODEV;
1237 
1238 	bus = kzalloc(sizeof(struct brcmf_bus), GFP_ATOMIC);
1239 	if (!bus) {
1240 		ret = -ENOMEM;
1241 		goto fail;
1242 	}
1243 
1244 	bus->dev = dev;
1245 	bus_pub->bus = bus;
1246 	bus->bus_priv.usb = bus_pub;
1247 	dev_set_drvdata(dev, bus);
1248 	bus->ops = &brcmf_usb_bus_ops;
1249 	bus->proto_type = BRCMF_PROTO_BCDC;
1250 	bus->always_use_fws_queue = true;
1251 #ifdef CONFIG_PM
1252 	bus->wowl_supported = true;
1253 #endif
1254 
1255 	devinfo->settings = brcmf_get_module_param(bus->dev, BRCMF_BUSTYPE_USB,
1256 						   bus_pub->devid,
1257 						   bus_pub->chiprev);
1258 	if (!devinfo->settings) {
1259 		ret = -ENOMEM;
1260 		goto fail;
1261 	}
1262 
1263 	if (!brcmf_usb_dlneeded(devinfo)) {
1264 		ret = brcmf_attach(devinfo->dev, devinfo->settings);
1265 		if (ret)
1266 			goto fail;
1267 		/* we are done */
1268 		mutex_unlock(&devinfo->dev_init_lock);
1269 		return 0;
1270 	}
1271 	bus->chip = bus_pub->devid;
1272 	bus->chiprev = bus_pub->chiprev;
1273 
1274 	fwreq = brcmf_usb_prepare_fw_request(devinfo);
1275 	if (!fwreq) {
1276 		ret = -ENOMEM;
1277 		goto fail;
1278 	}
1279 
1280 	/* request firmware here */
1281 	ret = brcmf_fw_get_firmwares(dev, fwreq, brcmf_usb_probe_phase2);
1282 	if (ret) {
1283 		brcmf_err("firmware request failed: %d\n", ret);
1284 		kfree(fwreq);
1285 		goto fail;
1286 	}
1287 
1288 	return 0;
1289 
1290 fail:
1291 	/* Release resources in reverse order */
1292 	kfree(bus);
1293 	brcmf_usb_detach(devinfo);
1294 	return ret;
1295 }
1296 
1297 static void
1298 brcmf_usb_disconnect_cb(struct brcmf_usbdev_info *devinfo)
1299 {
1300 	if (!devinfo)
1301 		return;
1302 	brcmf_dbg(USB, "Enter, bus_pub %p\n", devinfo);
1303 
1304 	brcmf_detach(devinfo->dev);
1305 	kfree(devinfo->bus_pub.bus);
1306 	brcmf_usb_detach(devinfo);
1307 }
1308 
1309 static int
1310 brcmf_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1311 {
1312 	struct usb_device *usb = interface_to_usbdev(intf);
1313 	struct brcmf_usbdev_info *devinfo;
1314 	struct usb_interface_descriptor	*desc;
1315 	struct usb_endpoint_descriptor *endpoint;
1316 	int ret = 0;
1317 	u32 num_of_eps;
1318 	u8 endpoint_num, ep;
1319 
1320 	brcmf_dbg(USB, "Enter 0x%04x:0x%04x\n", id->idVendor, id->idProduct);
1321 
1322 	devinfo = kzalloc(sizeof(*devinfo), GFP_ATOMIC);
1323 	if (devinfo == NULL)
1324 		return -ENOMEM;
1325 
1326 	devinfo->usbdev = usb;
1327 	devinfo->dev = &usb->dev;
1328 	/* Take an init lock, to protect for disconnect while still loading.
1329 	 * Necessary because of the asynchronous firmware load construction
1330 	 */
1331 	mutex_init(&devinfo->dev_init_lock);
1332 	mutex_lock(&devinfo->dev_init_lock);
1333 
1334 	usb_set_intfdata(intf, devinfo);
1335 
1336 	/* Check that the device supports only one configuration */
1337 	if (usb->descriptor.bNumConfigurations != 1) {
1338 		brcmf_err("Number of configurations: %d not supported\n",
1339 			  usb->descriptor.bNumConfigurations);
1340 		ret = -ENODEV;
1341 		goto fail;
1342 	}
1343 
1344 	if ((usb->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) &&
1345 	    (usb->descriptor.bDeviceClass != USB_CLASS_MISC) &&
1346 	    (usb->descriptor.bDeviceClass != USB_CLASS_WIRELESS_CONTROLLER)) {
1347 		brcmf_err("Device class: 0x%x not supported\n",
1348 			  usb->descriptor.bDeviceClass);
1349 		ret = -ENODEV;
1350 		goto fail;
1351 	}
1352 
1353 	desc = &intf->altsetting[0].desc;
1354 	if ((desc->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
1355 	    (desc->bInterfaceSubClass != 2) ||
1356 	    (desc->bInterfaceProtocol != 0xff)) {
1357 		brcmf_err("non WLAN interface %d: 0x%x:0x%x:0x%x\n",
1358 			  desc->bInterfaceNumber, desc->bInterfaceClass,
1359 			  desc->bInterfaceSubClass, desc->bInterfaceProtocol);
1360 		ret = -ENODEV;
1361 		goto fail;
1362 	}
1363 
1364 	num_of_eps = desc->bNumEndpoints;
1365 	for (ep = 0; ep < num_of_eps; ep++) {
1366 		endpoint = &intf->altsetting[0].endpoint[ep].desc;
1367 		endpoint_num = usb_endpoint_num(endpoint);
1368 		if (!usb_endpoint_xfer_bulk(endpoint))
1369 			continue;
1370 		if (usb_endpoint_dir_in(endpoint)) {
1371 			if (!devinfo->rx_pipe)
1372 				devinfo->rx_pipe =
1373 					usb_rcvbulkpipe(usb, endpoint_num);
1374 		} else {
1375 			if (!devinfo->tx_pipe)
1376 				devinfo->tx_pipe =
1377 					usb_sndbulkpipe(usb, endpoint_num);
1378 		}
1379 	}
1380 	if (devinfo->rx_pipe == 0) {
1381 		brcmf_err("No RX (in) Bulk EP found\n");
1382 		ret = -ENODEV;
1383 		goto fail;
1384 	}
1385 	if (devinfo->tx_pipe == 0) {
1386 		brcmf_err("No TX (out) Bulk EP found\n");
1387 		ret = -ENODEV;
1388 		goto fail;
1389 	}
1390 
1391 	devinfo->ifnum = desc->bInterfaceNumber;
1392 
1393 	if (usb->speed == USB_SPEED_SUPER_PLUS)
1394 		brcmf_dbg(USB, "Broadcom super speed plus USB WLAN interface detected\n");
1395 	else if (usb->speed == USB_SPEED_SUPER)
1396 		brcmf_dbg(USB, "Broadcom super speed USB WLAN interface detected\n");
1397 	else if (usb->speed == USB_SPEED_HIGH)
1398 		brcmf_dbg(USB, "Broadcom high speed USB WLAN interface detected\n");
1399 	else
1400 		brcmf_dbg(USB, "Broadcom full speed USB WLAN interface detected\n");
1401 
1402 	ret = brcmf_usb_probe_cb(devinfo);
1403 	if (ret)
1404 		goto fail;
1405 
1406 	/* Success */
1407 	return 0;
1408 
1409 fail:
1410 	mutex_unlock(&devinfo->dev_init_lock);
1411 	kfree(devinfo);
1412 	usb_set_intfdata(intf, NULL);
1413 	return ret;
1414 }
1415 
1416 static void
1417 brcmf_usb_disconnect(struct usb_interface *intf)
1418 {
1419 	struct brcmf_usbdev_info *devinfo;
1420 
1421 	brcmf_dbg(USB, "Enter\n");
1422 	devinfo = (struct brcmf_usbdev_info *)usb_get_intfdata(intf);
1423 
1424 	if (devinfo) {
1425 		mutex_lock(&devinfo->dev_init_lock);
1426 		/* Make sure that devinfo still exists. Firmware probe routines
1427 		 * may have released the device and cleared the intfdata.
1428 		 */
1429 		if (!usb_get_intfdata(intf))
1430 			goto done;
1431 
1432 		brcmf_usb_disconnect_cb(devinfo);
1433 		kfree(devinfo);
1434 	}
1435 done:
1436 	brcmf_dbg(USB, "Exit\n");
1437 }
1438 
1439 /*
1440  * only need to signal the bus being down and update the state.
1441  */
1442 static int brcmf_usb_suspend(struct usb_interface *intf, pm_message_t state)
1443 {
1444 	struct usb_device *usb = interface_to_usbdev(intf);
1445 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1446 
1447 	brcmf_dbg(USB, "Enter\n");
1448 	devinfo->bus_pub.state = BRCMFMAC_USB_STATE_SLEEP;
1449 	if (devinfo->wowl_enabled)
1450 		brcmf_cancel_all_urbs(devinfo);
1451 	else
1452 		brcmf_detach(&usb->dev);
1453 	return 0;
1454 }
1455 
1456 /*
1457  * (re-) start the bus.
1458  */
1459 static int brcmf_usb_resume(struct usb_interface *intf)
1460 {
1461 	struct usb_device *usb = interface_to_usbdev(intf);
1462 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1463 
1464 	brcmf_dbg(USB, "Enter\n");
1465 	if (!devinfo->wowl_enabled)
1466 		return brcmf_attach(devinfo->dev, devinfo->settings);
1467 
1468 	devinfo->bus_pub.state = BRCMFMAC_USB_STATE_UP;
1469 	brcmf_usb_rx_fill_all(devinfo);
1470 	return 0;
1471 }
1472 
1473 static int brcmf_usb_reset_resume(struct usb_interface *intf)
1474 {
1475 	struct usb_device *usb = interface_to_usbdev(intf);
1476 	struct brcmf_usbdev_info *devinfo = brcmf_usb_get_businfo(&usb->dev);
1477 	struct brcmf_fw_request *fwreq;
1478 	int ret;
1479 
1480 	brcmf_dbg(USB, "Enter\n");
1481 
1482 	fwreq = brcmf_usb_prepare_fw_request(devinfo);
1483 	if (!fwreq)
1484 		return -ENOMEM;
1485 
1486 	ret = brcmf_fw_get_firmwares(&usb->dev, fwreq, brcmf_usb_probe_phase2);
1487 	if (ret < 0)
1488 		kfree(fwreq);
1489 
1490 	return ret;
1491 }
1492 
1493 #define BRCMF_USB_DEVICE(dev_id)	\
1494 	{ USB_DEVICE(BRCM_USB_VENDOR_ID_BROADCOM, dev_id) }
1495 
1496 #define LINKSYS_USB_DEVICE(dev_id)	\
1497 	{ USB_DEVICE(BRCM_USB_VENDOR_ID_LINKSYS, dev_id) }
1498 
1499 #define CYPRESS_USB_DEVICE(dev_id)	\
1500 	{ USB_DEVICE(CY_USB_VENDOR_ID_CYPRESS, dev_id) }
1501 
1502 static const struct usb_device_id brcmf_usb_devid_table[] = {
1503 	BRCMF_USB_DEVICE(BRCM_USB_43143_DEVICE_ID),
1504 	BRCMF_USB_DEVICE(BRCM_USB_43236_DEVICE_ID),
1505 	BRCMF_USB_DEVICE(BRCM_USB_43242_DEVICE_ID),
1506 	BRCMF_USB_DEVICE(BRCM_USB_43569_DEVICE_ID),
1507 	LINKSYS_USB_DEVICE(BRCM_USB_43235_LINKSYS_DEVICE_ID),
1508 	CYPRESS_USB_DEVICE(CY_USB_4373_DEVICE_ID),
1509 	{ USB_DEVICE(BRCM_USB_VENDOR_ID_LG, BRCM_USB_43242_LG_DEVICE_ID) },
1510 	/* special entry for device with firmware loaded and running */
1511 	BRCMF_USB_DEVICE(BRCM_USB_BCMFW_DEVICE_ID),
1512 	CYPRESS_USB_DEVICE(BRCM_USB_BCMFW_DEVICE_ID),
1513 	{ /* end: all zeroes */ }
1514 };
1515 
1516 MODULE_DEVICE_TABLE(usb, brcmf_usb_devid_table);
1517 
1518 static struct usb_driver brcmf_usbdrvr = {
1519 	.name = KBUILD_MODNAME,
1520 	.probe = brcmf_usb_probe,
1521 	.disconnect = brcmf_usb_disconnect,
1522 	.id_table = brcmf_usb_devid_table,
1523 	.suspend = brcmf_usb_suspend,
1524 	.resume = brcmf_usb_resume,
1525 	.reset_resume = brcmf_usb_reset_resume,
1526 	.disable_hub_initiated_lpm = 1,
1527 };
1528 
1529 static int brcmf_usb_reset_device(struct device *dev, void *notused)
1530 {
1531 	/* device past is the usb interface so we
1532 	 * need to use parent here.
1533 	 */
1534 	brcmf_dev_reset(dev->parent);
1535 	return 0;
1536 }
1537 
1538 void brcmf_usb_exit(void)
1539 {
1540 	struct device_driver *drv = &brcmf_usbdrvr.drvwrap.driver;
1541 	int ret;
1542 
1543 	brcmf_dbg(USB, "Enter\n");
1544 	ret = driver_for_each_device(drv, NULL, NULL,
1545 				     brcmf_usb_reset_device);
1546 	usb_deregister(&brcmf_usbdrvr);
1547 }
1548 
1549 void brcmf_usb_register(void)
1550 {
1551 	int ret;
1552 
1553 	brcmf_dbg(USB, "Enter\n");
1554 	ret = usb_register(&brcmf_usbdrvr);
1555 	if (ret)
1556 		brcmf_err("usb_register failed %d\n", ret);
1557 }
1558