2 * Marvell Wireless LAN device driver: USB specific handling
4 * Copyright (C) 2012-2014, Marvell International Ltd.
6 * This software file (the "File") is distributed by Marvell International
7 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8 * (the "License"). You may use, redistribute and/or modify this File in
9 * accordance with the terms and conditions of the License, a copy of which
10 * is available by writing to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
14 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
16 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
17 * this warranty disclaimer.
23 #define USB_VERSION "1.0"
26 static struct mwifiex_if_ops usb_ops;
27 static struct semaphore add_remove_card_sem;
29 static struct usb_device_id mwifiex_usb_table[] = {
31 {USB_DEVICE(USB8XXX_VID, USB8766_PID_1)},
32 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8766_PID_2,
33 USB_CLASS_VENDOR_SPEC,
34 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
36 {USB_DEVICE(USB8XXX_VID, USB8797_PID_1)},
37 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8797_PID_2,
38 USB_CLASS_VENDOR_SPEC,
39 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
41 {USB_DEVICE(USB8XXX_VID, USB8801_PID_1)},
42 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8801_PID_2,
43 USB_CLASS_VENDOR_SPEC,
44 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
46 {USB_DEVICE(USB8XXX_VID, USB8997_PID_1)},
47 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8997_PID_2,
48 USB_CLASS_VENDOR_SPEC,
49 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
50 { } /* Terminating entry */
53 MODULE_DEVICE_TABLE(usb, mwifiex_usb_table);
55 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size);
57 /* This function handles received packet. Necessary action is taken based on
60 static int mwifiex_usb_recv(struct mwifiex_adapter *adapter,
61 struct sk_buff *skb, u8 ep)
67 if (adapter->hs_activated)
68 mwifiex_process_hs_config(adapter);
70 if (skb->len < INTF_HEADER_LEN) {
71 mwifiex_dbg(adapter, ERROR,
72 "%s: invalid skb->len\n", __func__);
77 case MWIFIEX_USB_EP_CMD_EVENT:
78 mwifiex_dbg(adapter, EVENT,
79 "%s: EP_CMD_EVENT\n", __func__);
80 skb_copy_from_linear_data(skb, &tmp, INTF_HEADER_LEN);
81 recv_type = le32_to_cpu(tmp);
82 skb_pull(skb, INTF_HEADER_LEN);
85 case MWIFIEX_USB_TYPE_CMD:
86 if (skb->len > MWIFIEX_SIZE_OF_CMD_BUFFER) {
87 mwifiex_dbg(adapter, ERROR,
88 "CMD: skb->len too large\n");
90 goto exit_restore_skb;
91 } else if (!adapter->curr_cmd) {
92 mwifiex_dbg(adapter, WARN, "CMD: no curr_cmd\n");
93 if (adapter->ps_state == PS_STATE_SLEEP_CFM) {
94 mwifiex_process_sleep_confirm_resp(
98 goto exit_restore_skb;
101 goto exit_restore_skb;
104 adapter->curr_cmd->resp_skb = skb;
105 adapter->cmd_resp_received = true;
107 case MWIFIEX_USB_TYPE_EVENT:
108 if (skb->len < sizeof(u32)) {
109 mwifiex_dbg(adapter, ERROR,
110 "EVENT: skb->len too small\n");
112 goto exit_restore_skb;
114 skb_copy_from_linear_data(skb, &tmp, sizeof(u32));
115 adapter->event_cause = le32_to_cpu(tmp);
116 mwifiex_dbg(adapter, EVENT,
117 "event_cause %#x\n", adapter->event_cause);
119 if (skb->len > MAX_EVENT_SIZE) {
120 mwifiex_dbg(adapter, ERROR,
121 "EVENT: event body too large\n");
123 goto exit_restore_skb;
126 memcpy(adapter->event_body, skb->data +
127 MWIFIEX_EVENT_HEADER_LEN, skb->len);
129 adapter->event_received = true;
130 adapter->event_skb = skb;
133 mwifiex_dbg(adapter, ERROR,
134 "unknown recv_type %#x\n", recv_type);
136 goto exit_restore_skb;
139 case MWIFIEX_USB_EP_DATA:
140 mwifiex_dbg(adapter, DATA, "%s: EP_DATA\n", __func__);
141 if (skb->len > MWIFIEX_RX_DATA_BUF_SIZE) {
142 mwifiex_dbg(adapter, ERROR,
143 "DATA: skb->len too large\n");
147 skb_queue_tail(&adapter->rx_data_q, skb);
148 adapter->data_received = true;
149 atomic_inc(&adapter->rx_pending);
152 mwifiex_dbg(adapter, ERROR,
153 "%s: unknown endport %#x\n", __func__, ep);
160 /* The buffer will be reused for further cmds/events */
161 skb_push(skb, INTF_HEADER_LEN);
166 static void mwifiex_usb_rx_complete(struct urb *urb)
168 struct urb_context *context = (struct urb_context *)urb->context;
169 struct mwifiex_adapter *adapter = context->adapter;
170 struct sk_buff *skb = context->skb;
171 struct usb_card_rec *card;
172 int recv_length = urb->actual_length;
175 if (!adapter || !adapter->card) {
176 pr_err("mwifiex adapter or card structure is not valid\n");
180 card = (struct usb_card_rec *)adapter->card;
181 if (card->rx_cmd_ep == context->ep)
182 atomic_dec(&card->rx_cmd_urb_pending);
184 atomic_dec(&card->rx_data_urb_pending);
187 if (urb->status || (adapter->surprise_removed)) {
188 mwifiex_dbg(adapter, ERROR,
189 "URB status is failed: %d\n", urb->status);
190 /* Do not free skb in case of command ep */
191 if (card->rx_cmd_ep != context->ep)
192 dev_kfree_skb_any(skb);
195 if (skb->len > recv_length)
196 skb_trim(skb, recv_length);
198 skb_put(skb, recv_length - skb->len);
200 status = mwifiex_usb_recv(adapter, skb, context->ep);
202 mwifiex_dbg(adapter, INFO,
203 "info: recv_length=%d, status=%d\n",
204 recv_length, status);
205 if (status == -EINPROGRESS) {
206 mwifiex_queue_main_work(adapter);
208 /* urb for data_ep is re-submitted now;
209 * urb for cmd_ep will be re-submitted in callback
210 * mwifiex_usb_recv_complete
212 if (card->rx_cmd_ep == context->ep)
216 mwifiex_dbg(adapter, ERROR,
217 "received data processing failed!\n");
219 /* Do not free skb in case of command ep */
220 if (card->rx_cmd_ep != context->ep)
221 dev_kfree_skb_any(skb);
223 } else if (urb->status) {
224 if (!adapter->is_suspended) {
225 mwifiex_dbg(adapter, FATAL,
226 "Card is removed: %d\n", urb->status);
227 adapter->surprise_removed = true;
229 dev_kfree_skb_any(skb);
232 /* Do not free skb in case of command ep */
233 if (card->rx_cmd_ep != context->ep)
234 dev_kfree_skb_any(skb);
236 /* fall through setup_for_next */
240 if (card->rx_cmd_ep == context->ep)
241 size = MWIFIEX_RX_CMD_BUF_SIZE;
243 size = MWIFIEX_RX_DATA_BUF_SIZE;
245 if (card->rx_cmd_ep == context->ep) {
246 mwifiex_usb_submit_rx_urb(context, size);
248 if (atomic_read(&adapter->rx_pending) <= HIGH_RX_PENDING){
249 mwifiex_usb_submit_rx_urb(context, size);
258 static void mwifiex_usb_tx_complete(struct urb *urb)
260 struct urb_context *context = (struct urb_context *)(urb->context);
261 struct mwifiex_adapter *adapter = context->adapter;
262 struct usb_card_rec *card = adapter->card;
263 struct usb_tx_data_port *port;
266 mwifiex_dbg(adapter, INFO,
267 "%s: status: %d\n", __func__, urb->status);
269 if (context->ep == card->tx_cmd_ep) {
270 mwifiex_dbg(adapter, CMD,
271 "%s: CMD\n", __func__);
272 atomic_dec(&card->tx_cmd_urb_pending);
273 adapter->cmd_sent = false;
275 mwifiex_dbg(adapter, DATA,
276 "%s: DATA\n", __func__);
277 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
278 port = &card->port[i];
279 if (context->ep == port->tx_data_ep) {
280 atomic_dec(&port->tx_data_urb_pending);
281 port->block_status = false;
285 adapter->data_sent = false;
286 mwifiex_write_data_complete(adapter, context->skb, 0,
287 urb->status ? -1 : 0);
290 if (card->mc_resync_flag)
291 mwifiex_multi_chan_resync(adapter);
293 mwifiex_queue_main_work(adapter);
298 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size)
300 struct mwifiex_adapter *adapter = ctx->adapter;
301 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
303 if (card->rx_cmd_ep != ctx->ep) {
304 ctx->skb = dev_alloc_skb(size);
306 mwifiex_dbg(adapter, ERROR,
307 "%s: dev_alloc_skb failed\n", __func__);
312 usb_fill_bulk_urb(ctx->urb, card->udev,
313 usb_rcvbulkpipe(card->udev, ctx->ep), ctx->skb->data,
314 size, mwifiex_usb_rx_complete, (void *)ctx);
316 if (card->rx_cmd_ep == ctx->ep)
317 atomic_inc(&card->rx_cmd_urb_pending);
319 atomic_inc(&card->rx_data_urb_pending);
321 if (usb_submit_urb(ctx->urb, GFP_ATOMIC)) {
322 mwifiex_dbg(adapter, ERROR, "usb_submit_urb failed\n");
323 dev_kfree_skb_any(ctx->skb);
326 if (card->rx_cmd_ep == ctx->ep)
327 atomic_dec(&card->rx_cmd_urb_pending);
329 atomic_dec(&card->rx_data_urb_pending);
337 static void mwifiex_usb_free(struct usb_card_rec *card)
339 struct usb_tx_data_port *port;
342 if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
343 usb_kill_urb(card->rx_cmd.urb);
345 usb_free_urb(card->rx_cmd.urb);
346 card->rx_cmd.urb = NULL;
348 if (atomic_read(&card->rx_data_urb_pending))
349 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
350 if (card->rx_data_list[i].urb)
351 usb_kill_urb(card->rx_data_list[i].urb);
353 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
354 usb_free_urb(card->rx_data_list[i].urb);
355 card->rx_data_list[i].urb = NULL;
358 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
359 port = &card->port[i];
360 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
361 usb_free_urb(port->tx_data_list[j].urb);
362 port->tx_data_list[j].urb = NULL;
366 usb_free_urb(card->tx_cmd.urb);
367 card->tx_cmd.urb = NULL;
372 /* This function probes an mwifiex device and registers it. It allocates
373 * the card structure, initiates the device registration and initialization
374 * procedure by adding a logical interface.
376 static int mwifiex_usb_probe(struct usb_interface *intf,
377 const struct usb_device_id *id)
379 struct usb_device *udev = interface_to_usbdev(intf);
380 struct usb_host_interface *iface_desc = intf->cur_altsetting;
381 struct usb_endpoint_descriptor *epd;
383 struct usb_card_rec *card;
384 u16 id_vendor, id_product, bcd_device, bcd_usb;
386 card = kzalloc(sizeof(struct usb_card_rec), GFP_KERNEL);
390 id_vendor = le16_to_cpu(udev->descriptor.idVendor);
391 id_product = le16_to_cpu(udev->descriptor.idProduct);
392 bcd_device = le16_to_cpu(udev->descriptor.bcdDevice);
393 bcd_usb = le16_to_cpu(udev->descriptor.bcdUSB);
394 pr_debug("info: VID/PID = %X/%X, Boot2 version = %X\n",
395 id_vendor, id_product, bcd_device);
397 /* PID_1 is used for firmware downloading only */
398 switch (id_product) {
403 card->usb_boot_state = USB8XXX_FW_DNLD;
409 card->usb_boot_state = USB8XXX_FW_READY;
412 pr_warn("unknown id_product %#x\n", id_product);
413 card->usb_boot_state = USB8XXX_FW_DNLD;
420 pr_debug("info: bcdUSB=%#x Device Class=%#x SubClass=%#x Protocol=%#x\n",
421 udev->descriptor.bcdUSB, udev->descriptor.bDeviceClass,
422 udev->descriptor.bDeviceSubClass,
423 udev->descriptor.bDeviceProtocol);
425 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
426 epd = &iface_desc->endpoint[i].desc;
427 if (usb_endpoint_dir_in(epd) &&
428 usb_endpoint_num(epd) == MWIFIEX_USB_EP_CMD_EVENT &&
429 usb_endpoint_xfer_bulk(epd)) {
430 pr_debug("info: bulk IN: max pkt size: %d, addr: %d\n",
431 le16_to_cpu(epd->wMaxPacketSize),
432 epd->bEndpointAddress);
433 card->rx_cmd_ep = usb_endpoint_num(epd);
434 atomic_set(&card->rx_cmd_urb_pending, 0);
436 if (usb_endpoint_dir_in(epd) &&
437 usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA &&
438 usb_endpoint_xfer_bulk(epd)) {
439 pr_debug("info: bulk IN: max pkt size: %d, addr: %d\n",
440 le16_to_cpu(epd->wMaxPacketSize),
441 epd->bEndpointAddress);
442 card->rx_data_ep = usb_endpoint_num(epd);
443 atomic_set(&card->rx_data_urb_pending, 0);
445 if (usb_endpoint_dir_out(epd) &&
446 usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA &&
447 usb_endpoint_xfer_bulk(epd)) {
448 pr_debug("info: bulk OUT: max pkt size: %d, addr: %d\n",
449 le16_to_cpu(epd->wMaxPacketSize),
450 epd->bEndpointAddress);
451 card->port[0].tx_data_ep = usb_endpoint_num(epd);
452 atomic_set(&card->port[0].tx_data_urb_pending, 0);
454 if (usb_endpoint_dir_out(epd) &&
455 usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA_CH2 &&
456 usb_endpoint_xfer_bulk(epd)) {
457 pr_debug("info: bulk OUT chan2:\t"
458 "max pkt size: %d, addr: %d\n",
459 le16_to_cpu(epd->wMaxPacketSize),
460 epd->bEndpointAddress);
461 card->port[1].tx_data_ep = usb_endpoint_num(epd);
462 atomic_set(&card->port[1].tx_data_urb_pending, 0);
464 if (usb_endpoint_dir_out(epd) &&
465 usb_endpoint_num(epd) == MWIFIEX_USB_EP_CMD_EVENT &&
466 usb_endpoint_xfer_bulk(epd)) {
467 pr_debug("info: bulk OUT: max pkt size: %d, addr: %d\n",
468 le16_to_cpu(epd->wMaxPacketSize),
469 epd->bEndpointAddress);
470 card->tx_cmd_ep = usb_endpoint_num(epd);
471 atomic_set(&card->tx_cmd_urb_pending, 0);
472 card->bulk_out_maxpktsize =
473 le16_to_cpu(epd->wMaxPacketSize);
477 switch (card->usb_boot_state) {
478 case USB8XXX_FW_DNLD:
479 /* Reject broken descriptors. */
480 if (!card->rx_cmd_ep || !card->tx_cmd_ep)
482 if (card->bulk_out_maxpktsize == 0)
485 case USB8XXX_FW_READY:
486 /* Assume the driver can handle missing endpoints for now. */
493 usb_set_intfdata(intf, card);
495 ret = mwifiex_add_card(card, &add_remove_card_sem, &usb_ops,
498 pr_err("%s: mwifiex_add_card failed: %d\n", __func__, ret);
499 usb_reset_device(udev);
509 /* Kernel needs to suspend all functions separately. Therefore all
510 * registered functions must have drivers with suspend and resume
511 * methods. Failing that the kernel simply removes the whole card.
513 * If already not suspended, this function allocates and sends a
514 * 'host sleep activate' request to the firmware and turns off the traffic.
516 static int mwifiex_usb_suspend(struct usb_interface *intf, pm_message_t message)
518 struct usb_card_rec *card = usb_get_intfdata(intf);
519 struct mwifiex_adapter *adapter;
520 struct usb_tx_data_port *port;
523 if (!card || !card->adapter) {
524 pr_err("%s: card or card->adapter is NULL\n", __func__);
527 adapter = card->adapter;
529 if (unlikely(adapter->is_suspended))
530 mwifiex_dbg(adapter, WARN,
531 "Device already suspended\n");
533 mwifiex_enable_hs(adapter);
535 /* 'is_suspended' flag indicates device is suspended.
536 * It must be set here before the usb_kill_urb() calls. Reason
537 * is in the complete handlers, urb->status(= -ENOENT) and
538 * this flag is used in combination to distinguish between a
539 * 'suspended' state and a 'disconnect' one.
541 adapter->is_suspended = true;
542 adapter->hs_enabling = false;
544 if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
545 usb_kill_urb(card->rx_cmd.urb);
547 if (atomic_read(&card->rx_data_urb_pending))
548 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
549 if (card->rx_data_list[i].urb)
550 usb_kill_urb(card->rx_data_list[i].urb);
552 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
553 port = &card->port[i];
554 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
555 if (port->tx_data_list[j].urb)
556 usb_kill_urb(port->tx_data_list[j].urb);
560 if (card->tx_cmd.urb)
561 usb_kill_urb(card->tx_cmd.urb);
566 /* Kernel needs to suspend all functions separately. Therefore all
567 * registered functions must have drivers with suspend and resume
568 * methods. Failing that the kernel simply removes the whole card.
570 * If already not resumed, this function turns on the traffic and
571 * sends a 'host sleep cancel' request to the firmware.
573 static int mwifiex_usb_resume(struct usb_interface *intf)
575 struct usb_card_rec *card = usb_get_intfdata(intf);
576 struct mwifiex_adapter *adapter;
579 if (!card || !card->adapter) {
580 pr_err("%s: card or card->adapter is NULL\n", __func__);
583 adapter = card->adapter;
585 if (unlikely(!adapter->is_suspended)) {
586 mwifiex_dbg(adapter, WARN,
587 "Device already resumed\n");
591 /* Indicate device resumed. The netdev queue will be resumed only
592 * after the urbs have been re-submitted
594 adapter->is_suspended = false;
596 if (!atomic_read(&card->rx_data_urb_pending))
597 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
598 mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
599 MWIFIEX_RX_DATA_BUF_SIZE);
601 if (!atomic_read(&card->rx_cmd_urb_pending)) {
602 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
603 if (card->rx_cmd.skb)
604 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
605 MWIFIEX_RX_CMD_BUF_SIZE);
608 /* Disable Host Sleep */
609 if (adapter->hs_activated)
610 mwifiex_cancel_hs(mwifiex_get_priv(adapter,
611 MWIFIEX_BSS_ROLE_ANY),
617 static void mwifiex_usb_disconnect(struct usb_interface *intf)
619 struct usb_card_rec *card = usb_get_intfdata(intf);
620 struct mwifiex_adapter *adapter;
622 if (!card || !card->adapter) {
623 pr_err("%s: card or card->adapter is NULL\n", __func__);
627 adapter = card->adapter;
628 if (!adapter->priv_num)
633 if (adapter->is_suspended)
634 mwifiex_usb_resume(intf);
637 mwifiex_deauthenticate_all(adapter);
639 mwifiex_init_shutdown_fw(mwifiex_get_priv(adapter,
640 MWIFIEX_BSS_ROLE_ANY),
641 MWIFIEX_FUNC_SHUTDOWN);
644 if (adapter->workqueue)
645 flush_workqueue(adapter->workqueue);
647 mwifiex_usb_free(card);
649 mwifiex_dbg(adapter, FATAL,
650 "%s: removing card\n", __func__);
651 mwifiex_remove_card(adapter, &add_remove_card_sem);
653 usb_set_intfdata(intf, NULL);
654 usb_put_dev(interface_to_usbdev(intf));
660 static struct usb_driver mwifiex_usb_driver = {
661 .name = "mwifiex_usb",
662 .probe = mwifiex_usb_probe,
663 .disconnect = mwifiex_usb_disconnect,
664 .id_table = mwifiex_usb_table,
665 .suspend = mwifiex_usb_suspend,
666 .resume = mwifiex_usb_resume,
670 static int mwifiex_usb_tx_init(struct mwifiex_adapter *adapter)
672 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
673 struct usb_tx_data_port *port;
676 card->tx_cmd.adapter = adapter;
677 card->tx_cmd.ep = card->tx_cmd_ep;
679 card->tx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
680 if (!card->tx_cmd.urb) {
681 mwifiex_dbg(adapter, ERROR,
682 "tx_cmd.urb allocation failed\n");
686 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
687 port = &card->port[i];
688 if (!port->tx_data_ep)
690 port->tx_data_ix = 0;
691 if (port->tx_data_ep == MWIFIEX_USB_EP_DATA)
692 port->block_status = false;
694 port->block_status = true;
695 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
696 port->tx_data_list[j].adapter = adapter;
697 port->tx_data_list[j].ep = port->tx_data_ep;
698 port->tx_data_list[j].urb =
699 usb_alloc_urb(0, GFP_KERNEL);
700 if (!port->tx_data_list[j].urb) {
701 mwifiex_dbg(adapter, ERROR,
702 "urb allocation failed\n");
711 static int mwifiex_usb_rx_init(struct mwifiex_adapter *adapter)
713 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
716 card->rx_cmd.adapter = adapter;
717 card->rx_cmd.ep = card->rx_cmd_ep;
719 card->rx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
720 if (!card->rx_cmd.urb) {
721 mwifiex_dbg(adapter, ERROR, "rx_cmd.urb allocation failed\n");
725 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
726 if (!card->rx_cmd.skb)
729 if (mwifiex_usb_submit_rx_urb(&card->rx_cmd, MWIFIEX_RX_CMD_BUF_SIZE))
732 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
733 card->rx_data_list[i].adapter = adapter;
734 card->rx_data_list[i].ep = card->rx_data_ep;
736 card->rx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
737 if (!card->rx_data_list[i].urb) {
738 mwifiex_dbg(adapter, ERROR,
739 "rx_data_list[] urb allocation failed\n");
742 if (mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
743 MWIFIEX_RX_DATA_BUF_SIZE))
750 static int mwifiex_write_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
751 u32 *len, u8 ep, u32 timeout)
753 struct usb_card_rec *card = adapter->card;
754 int actual_length, ret;
756 if (!(*len % card->bulk_out_maxpktsize))
759 /* Send the data block */
760 ret = usb_bulk_msg(card->udev, usb_sndbulkpipe(card->udev, ep), pbuf,
761 *len, &actual_length, timeout);
763 mwifiex_dbg(adapter, ERROR,
764 "usb_bulk_msg for tx failed: %d\n", ret);
768 *len = actual_length;
773 static int mwifiex_read_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
774 u32 *len, u8 ep, u32 timeout)
776 struct usb_card_rec *card = adapter->card;
777 int actual_length, ret;
779 /* Receive the data response */
780 ret = usb_bulk_msg(card->udev, usb_rcvbulkpipe(card->udev, ep), pbuf,
781 *len, &actual_length, timeout);
783 mwifiex_dbg(adapter, ERROR,
784 "usb_bulk_msg for rx failed: %d\n", ret);
788 *len = actual_length;
793 static void mwifiex_usb_port_resync(struct mwifiex_adapter *adapter)
795 struct usb_card_rec *card = adapter->card;
796 u8 active_port = MWIFIEX_USB_EP_DATA;
797 struct mwifiex_private *priv = NULL;
800 if (adapter->usb_mc_status) {
801 for (i = 0; i < adapter->priv_num; i++) {
802 priv = adapter->priv[i];
805 if ((priv->bss_role == MWIFIEX_BSS_ROLE_UAP &&
806 !priv->bss_started) ||
807 (priv->bss_role == MWIFIEX_BSS_ROLE_STA &&
808 !priv->media_connected))
809 priv->usb_port = MWIFIEX_USB_EP_DATA;
811 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++)
812 card->port[i].block_status = false;
814 for (i = 0; i < adapter->priv_num; i++) {
815 priv = adapter->priv[i];
818 if ((priv->bss_role == MWIFIEX_BSS_ROLE_UAP &&
819 priv->bss_started) ||
820 (priv->bss_role == MWIFIEX_BSS_ROLE_STA &&
821 priv->media_connected)) {
822 active_port = priv->usb_port;
826 for (i = 0; i < adapter->priv_num; i++) {
827 priv = adapter->priv[i];
829 priv->usb_port = active_port;
831 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
832 if (active_port == card->port[i].tx_data_ep)
833 card->port[i].block_status = false;
835 card->port[i].block_status = true;
840 static bool mwifiex_usb_is_port_ready(struct mwifiex_private *priv)
842 struct usb_card_rec *card = priv->adapter->card;
845 for (idx = 0; idx < MWIFIEX_TX_DATA_PORT; idx++) {
846 if (priv->usb_port == card->port[idx].tx_data_ep)
847 return !card->port[idx].block_status;
853 static inline u8 mwifiex_usb_data_sent(struct mwifiex_adapter *adapter)
855 struct usb_card_rec *card = adapter->card;
858 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++)
859 if (!card->port[i].block_status)
865 /* This function write a command/data packet to card. */
866 static int mwifiex_usb_host_to_card(struct mwifiex_adapter *adapter, u8 ep,
868 struct mwifiex_tx_param *tx_param)
870 struct usb_card_rec *card = adapter->card;
871 struct urb_context *context = NULL;
872 struct usb_tx_data_port *port = NULL;
873 u8 *data = (u8 *)skb->data;
877 if (adapter->is_suspended) {
878 mwifiex_dbg(adapter, ERROR,
879 "%s: not allowed while suspended\n", __func__);
883 if (adapter->surprise_removed) {
884 mwifiex_dbg(adapter, ERROR, "%s: device removed\n", __func__);
888 mwifiex_dbg(adapter, INFO, "%s: ep=%d\n", __func__, ep);
890 if (ep == card->tx_cmd_ep) {
891 context = &card->tx_cmd;
893 for (idx = 0; idx < MWIFIEX_TX_DATA_PORT; idx++) {
894 if (ep == card->port[idx].tx_data_ep) {
895 port = &card->port[idx];
896 if (atomic_read(&port->tx_data_urb_pending)
897 >= MWIFIEX_TX_DATA_URB) {
898 port->block_status = true;
902 if (port->tx_data_ix >= MWIFIEX_TX_DATA_URB)
903 port->tx_data_ix = 0;
905 &port->tx_data_list[port->tx_data_ix++];
910 mwifiex_dbg(adapter, ERROR, "Wrong usb tx data port\n");
915 context->adapter = adapter;
918 tx_urb = context->urb;
920 usb_fill_bulk_urb(tx_urb, card->udev, usb_sndbulkpipe(card->udev, ep),
921 data, skb->len, mwifiex_usb_tx_complete,
924 tx_urb->transfer_flags |= URB_ZERO_PACKET;
926 if (ep == card->tx_cmd_ep)
927 atomic_inc(&card->tx_cmd_urb_pending);
929 atomic_inc(&port->tx_data_urb_pending);
931 if (usb_submit_urb(tx_urb, GFP_ATOMIC)) {
932 mwifiex_dbg(adapter, ERROR,
933 "%s: usb_submit_urb failed\n", __func__);
934 if (ep == card->tx_cmd_ep) {
935 atomic_dec(&card->tx_cmd_urb_pending);
937 atomic_dec(&port->tx_data_urb_pending);
938 port->block_status = false;
939 if (port->tx_data_ix)
942 port->tx_data_ix = MWIFIEX_TX_DATA_URB;
947 if (ep != card->tx_cmd_ep &&
948 atomic_read(&port->tx_data_urb_pending) ==
949 MWIFIEX_TX_DATA_URB) {
950 port->block_status = true;
959 if (ep != card->tx_cmd_ep)
960 adapter->data_sent = mwifiex_usb_data_sent(adapter);
965 /* This function register usb device and initialize parameter. */
966 static int mwifiex_register_dev(struct mwifiex_adapter *adapter)
968 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
970 card->adapter = adapter;
971 adapter->dev = &card->udev->dev;
973 switch (le16_to_cpu(card->udev->descriptor.idProduct)) {
976 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_4K;
977 strcpy(adapter->fw_name, USB8997_DEFAULT_FW_NAME);
978 adapter->ext_scan = true;
982 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
983 strcpy(adapter->fw_name, USB8766_DEFAULT_FW_NAME);
984 adapter->ext_scan = true;
988 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
989 strcpy(adapter->fw_name, USB8801_DEFAULT_FW_NAME);
990 adapter->ext_scan = false;
995 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
996 strcpy(adapter->fw_name, USB8797_DEFAULT_FW_NAME);
1000 adapter->usb_mc_status = false;
1001 adapter->usb_mc_setup = false;
1006 static void mwifiex_unregister_dev(struct mwifiex_adapter *adapter)
1008 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1010 card->adapter = NULL;
1013 static int mwifiex_prog_fw_w_helper(struct mwifiex_adapter *adapter,
1014 struct mwifiex_fw_image *fw)
1017 u8 *firmware = fw->fw_buf, *recv_buff;
1018 u32 retries = USB8XXX_FW_MAX_RETRY, dlen;
1019 u32 fw_seqnum = 0, tlen = 0, dnld_cmd = 0;
1020 struct fw_data *fwdata;
1021 struct fw_sync_header sync_fw;
1022 u8 check_winner = 1;
1025 mwifiex_dbg(adapter, ERROR,
1026 "No firmware image found! Terminating download\n");
1031 /* Allocate memory for transmit */
1032 fwdata = kzalloc(FW_DNLD_TX_BUF_SIZE, GFP_KERNEL);
1038 /* Allocate memory for receive */
1039 recv_buff = kzalloc(FW_DNLD_RX_BUF_SIZE, GFP_KERNEL);
1044 /* Send pseudo data to check winner status first */
1046 memset(&fwdata->fw_hdr, 0, sizeof(struct fw_header));
1049 /* copy the header of the fw_data to get the length */
1050 memcpy(&fwdata->fw_hdr, &firmware[tlen],
1051 sizeof(struct fw_header));
1053 dlen = le32_to_cpu(fwdata->fw_hdr.data_len);
1054 dnld_cmd = le32_to_cpu(fwdata->fw_hdr.dnld_cmd);
1055 tlen += sizeof(struct fw_header);
1057 memcpy(fwdata->data, &firmware[tlen], dlen);
1059 fwdata->seq_num = cpu_to_le32(fw_seqnum);
1063 /* If the send/receive fails or CRC occurs then retry */
1065 u8 *buf = (u8 *)fwdata;
1066 u32 len = FW_DATA_XMIT_SIZE;
1068 /* send the firmware block */
1069 ret = mwifiex_write_data_sync(adapter, buf, &len,
1070 MWIFIEX_USB_EP_CMD_EVENT,
1071 MWIFIEX_USB_TIMEOUT);
1073 mwifiex_dbg(adapter, ERROR,
1074 "write_data_sync: failed: %d\n",
1080 len = FW_DNLD_RX_BUF_SIZE;
1082 /* Receive the firmware block response */
1083 ret = mwifiex_read_data_sync(adapter, buf, &len,
1084 MWIFIEX_USB_EP_CMD_EVENT,
1085 MWIFIEX_USB_TIMEOUT);
1087 mwifiex_dbg(adapter, ERROR,
1088 "read_data_sync: failed: %d\n",
1093 memcpy(&sync_fw, recv_buff,
1094 sizeof(struct fw_sync_header));
1096 /* check 1st firmware block resp for highest bit set */
1098 if (le32_to_cpu(sync_fw.cmd) & 0x80000000) {
1099 mwifiex_dbg(adapter, WARN,
1100 "USB is not the winner %#x\n",
1103 /* returning success */
1108 mwifiex_dbg(adapter, MSG,
1109 "start to download FW...\n");
1115 /* check the firmware block response for CRC errors */
1117 mwifiex_dbg(adapter, ERROR,
1118 "FW received block with CRC %#x\n",
1124 retries = USB8XXX_FW_MAX_RETRY;
1128 } while ((dnld_cmd != FW_HAS_LAST_BLOCK) && retries);
1131 mwifiex_dbg(adapter, MSG,
1132 "info: FW download over, size %d bytes\n", tlen);
1143 static int mwifiex_usb_dnld_fw(struct mwifiex_adapter *adapter,
1144 struct mwifiex_fw_image *fw)
1147 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1149 if (card->usb_boot_state == USB8XXX_FW_DNLD) {
1150 ret = mwifiex_prog_fw_w_helper(adapter, fw);
1154 /* Boot state changes after successful firmware download */
1155 if (card->usb_boot_state == USB8XXX_FW_DNLD)
1159 ret = mwifiex_usb_rx_init(adapter);
1161 ret = mwifiex_usb_tx_init(adapter);
1166 static void mwifiex_submit_rx_urb(struct mwifiex_adapter *adapter, u8 ep)
1168 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1170 skb_push(card->rx_cmd.skb, INTF_HEADER_LEN);
1171 if ((ep == card->rx_cmd_ep) &&
1172 (!atomic_read(&card->rx_cmd_urb_pending)))
1173 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
1174 MWIFIEX_RX_CMD_BUF_SIZE);
1179 static int mwifiex_usb_cmd_event_complete(struct mwifiex_adapter *adapter,
1180 struct sk_buff *skb)
1182 mwifiex_submit_rx_urb(adapter, MWIFIEX_USB_EP_CMD_EVENT);
1187 /* This function wakes up the card. */
1188 static int mwifiex_pm_wakeup_card(struct mwifiex_adapter *adapter)
1190 /* Simulation of HS_AWAKE event */
1191 adapter->pm_wakeup_fw_try = false;
1192 del_timer(&adapter->wakeup_timer);
1193 adapter->pm_wakeup_card_req = false;
1194 adapter->ps_state = PS_STATE_AWAKE;
1199 static void mwifiex_usb_submit_rem_rx_urbs(struct mwifiex_adapter *adapter)
1201 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1203 struct urb_context *ctx;
1205 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
1206 if (card->rx_data_list[i].skb)
1208 ctx = &card->rx_data_list[i];
1209 mwifiex_usb_submit_rx_urb(ctx, MWIFIEX_RX_DATA_BUF_SIZE);
1213 /* This function is called after the card has woken up. */
1215 mwifiex_pm_wakeup_card_complete(struct mwifiex_adapter *adapter)
1220 static struct mwifiex_if_ops usb_ops = {
1221 .register_dev = mwifiex_register_dev,
1222 .unregister_dev = mwifiex_unregister_dev,
1223 .wakeup = mwifiex_pm_wakeup_card,
1224 .wakeup_complete = mwifiex_pm_wakeup_card_complete,
1227 .dnld_fw = mwifiex_usb_dnld_fw,
1228 .cmdrsp_complete = mwifiex_usb_cmd_event_complete,
1229 .event_complete = mwifiex_usb_cmd_event_complete,
1230 .host_to_card = mwifiex_usb_host_to_card,
1231 .submit_rem_rx_urbs = mwifiex_usb_submit_rem_rx_urbs,
1232 .multi_port_resync = mwifiex_usb_port_resync,
1233 .is_port_ready = mwifiex_usb_is_port_ready,
1236 /* This function initializes the USB driver module.
1238 * This initiates the semaphore and registers the device with
1241 static int mwifiex_usb_init_module(void)
1245 pr_debug("Marvell USB8797 Driver\n");
1247 sema_init(&add_remove_card_sem, 1);
1249 ret = usb_register(&mwifiex_usb_driver);
1251 pr_err("Driver register failed!\n");
1253 pr_debug("info: Driver registered successfully!\n");
1258 /* This function cleans up the USB driver.
1260 * The following major steps are followed in .disconnect for cleanup:
1261 * - Resume the device if its suspended
1262 * - Disconnect the device if connected
1263 * - Shutdown the firmware
1264 * - Unregister the device from USB bus.
1266 static void mwifiex_usb_cleanup_module(void)
1268 if (!down_interruptible(&add_remove_card_sem))
1269 up(&add_remove_card_sem);
1271 /* set the flag as user is removing this module */
1274 usb_deregister(&mwifiex_usb_driver);
1277 module_init(mwifiex_usb_init_module);
1278 module_exit(mwifiex_usb_cleanup_module);
1280 MODULE_AUTHOR("Marvell International Ltd.");
1281 MODULE_DESCRIPTION("Marvell WiFi-Ex USB Driver version" USB_VERSION);
1282 MODULE_VERSION(USB_VERSION);
1283 MODULE_LICENSE("GPL v2");