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);
138 case MWIFIEX_USB_EP_DATA:
139 mwifiex_dbg(adapter, DATA, "%s: EP_DATA\n", __func__);
140 if (skb->len > MWIFIEX_RX_DATA_BUF_SIZE) {
141 mwifiex_dbg(adapter, ERROR,
142 "DATA: skb->len too large\n");
146 skb_queue_tail(&adapter->rx_data_q, skb);
147 adapter->data_received = true;
148 atomic_inc(&adapter->rx_pending);
151 mwifiex_dbg(adapter, ERROR,
152 "%s: unknown endport %#x\n", __func__, ep);
159 /* The buffer will be reused for further cmds/events */
160 skb_push(skb, INTF_HEADER_LEN);
165 static void mwifiex_usb_rx_complete(struct urb *urb)
167 struct urb_context *context = (struct urb_context *)urb->context;
168 struct mwifiex_adapter *adapter = context->adapter;
169 struct sk_buff *skb = context->skb;
170 struct usb_card_rec *card;
171 int recv_length = urb->actual_length;
174 if (!adapter || !adapter->card) {
175 pr_err("mwifiex adapter or card structure is not valid\n");
179 card = (struct usb_card_rec *)adapter->card;
180 if (card->rx_cmd_ep == context->ep)
181 atomic_dec(&card->rx_cmd_urb_pending);
183 atomic_dec(&card->rx_data_urb_pending);
186 if (urb->status || (adapter->surprise_removed)) {
187 mwifiex_dbg(adapter, ERROR,
188 "URB status is failed: %d\n", urb->status);
189 /* Do not free skb in case of command ep */
190 if (card->rx_cmd_ep != context->ep)
191 dev_kfree_skb_any(skb);
194 if (skb->len > recv_length)
195 skb_trim(skb, recv_length);
197 skb_put(skb, recv_length - skb->len);
199 status = mwifiex_usb_recv(adapter, skb, context->ep);
201 mwifiex_dbg(adapter, INFO,
202 "info: recv_length=%d, status=%d\n",
203 recv_length, status);
204 if (status == -EINPROGRESS) {
205 mwifiex_queue_main_work(adapter);
207 /* urb for data_ep is re-submitted now;
208 * urb for cmd_ep will be re-submitted in callback
209 * mwifiex_usb_recv_complete
211 if (card->rx_cmd_ep == context->ep)
215 mwifiex_dbg(adapter, ERROR,
216 "received data processing failed!\n");
218 /* Do not free skb in case of command ep */
219 if (card->rx_cmd_ep != context->ep)
220 dev_kfree_skb_any(skb);
222 } else if (urb->status) {
223 if (!adapter->is_suspended) {
224 mwifiex_dbg(adapter, FATAL,
225 "Card is removed: %d\n", urb->status);
226 adapter->surprise_removed = true;
228 dev_kfree_skb_any(skb);
231 /* Do not free skb in case of command ep */
232 if (card->rx_cmd_ep != context->ep)
233 dev_kfree_skb_any(skb);
235 /* fall through setup_for_next */
239 if (card->rx_cmd_ep == context->ep)
240 size = MWIFIEX_RX_CMD_BUF_SIZE;
242 size = MWIFIEX_RX_DATA_BUF_SIZE;
244 if (card->rx_cmd_ep == context->ep) {
245 mwifiex_usb_submit_rx_urb(context, size);
247 if (atomic_read(&adapter->rx_pending) <= HIGH_RX_PENDING) {
248 mwifiex_usb_submit_rx_urb(context, size);
257 static void mwifiex_usb_tx_complete(struct urb *urb)
259 struct urb_context *context = (struct urb_context *)(urb->context);
260 struct mwifiex_adapter *adapter = context->adapter;
261 struct usb_card_rec *card = adapter->card;
262 struct usb_tx_data_port *port;
265 mwifiex_dbg(adapter, INFO,
266 "%s: status: %d\n", __func__, urb->status);
268 if (context->ep == card->tx_cmd_ep) {
269 mwifiex_dbg(adapter, CMD,
270 "%s: CMD\n", __func__);
271 atomic_dec(&card->tx_cmd_urb_pending);
272 adapter->cmd_sent = false;
274 mwifiex_dbg(adapter, DATA,
275 "%s: DATA\n", __func__);
276 mwifiex_write_data_complete(adapter, context->skb, 0,
277 urb->status ? -1 : 0);
278 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
279 port = &card->port[i];
280 if (context->ep == port->tx_data_ep) {
281 atomic_dec(&port->tx_data_urb_pending);
282 port->block_status = false;
286 adapter->data_sent = false;
289 if (card->mc_resync_flag)
290 mwifiex_multi_chan_resync(adapter);
292 mwifiex_queue_main_work(adapter);
297 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size)
299 struct mwifiex_adapter *adapter = ctx->adapter;
300 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
302 if (card->rx_cmd_ep != ctx->ep) {
303 ctx->skb = dev_alloc_skb(size);
305 mwifiex_dbg(adapter, ERROR,
306 "%s: dev_alloc_skb failed\n", __func__);
311 usb_fill_bulk_urb(ctx->urb, card->udev,
312 usb_rcvbulkpipe(card->udev, ctx->ep), ctx->skb->data,
313 size, mwifiex_usb_rx_complete, (void *)ctx);
315 if (card->rx_cmd_ep == ctx->ep)
316 atomic_inc(&card->rx_cmd_urb_pending);
318 atomic_inc(&card->rx_data_urb_pending);
320 if (usb_submit_urb(ctx->urb, GFP_ATOMIC)) {
321 mwifiex_dbg(adapter, ERROR, "usb_submit_urb failed\n");
322 dev_kfree_skb_any(ctx->skb);
325 if (card->rx_cmd_ep == ctx->ep)
326 atomic_dec(&card->rx_cmd_urb_pending);
328 atomic_dec(&card->rx_data_urb_pending);
336 static void mwifiex_usb_free(struct usb_card_rec *card)
338 struct usb_tx_data_port *port;
341 if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
342 usb_kill_urb(card->rx_cmd.urb);
344 usb_free_urb(card->rx_cmd.urb);
345 card->rx_cmd.urb = NULL;
347 if (atomic_read(&card->rx_data_urb_pending))
348 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
349 if (card->rx_data_list[i].urb)
350 usb_kill_urb(card->rx_data_list[i].urb);
352 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
353 usb_free_urb(card->rx_data_list[i].urb);
354 card->rx_data_list[i].urb = NULL;
357 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
358 port = &card->port[i];
359 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
360 usb_free_urb(port->tx_data_list[j].urb);
361 port->tx_data_list[j].urb = NULL;
365 usb_free_urb(card->tx_cmd.urb);
366 card->tx_cmd.urb = NULL;
371 /* This function probes an mwifiex device and registers it. It allocates
372 * the card structure, initiates the device registration and initialization
373 * procedure by adding a logical interface.
375 static int mwifiex_usb_probe(struct usb_interface *intf,
376 const struct usb_device_id *id)
378 struct usb_device *udev = interface_to_usbdev(intf);
379 struct usb_host_interface *iface_desc = intf->cur_altsetting;
380 struct usb_endpoint_descriptor *epd;
382 struct usb_card_rec *card;
383 u16 id_vendor, id_product, bcd_device, bcd_usb;
385 card = kzalloc(sizeof(struct usb_card_rec), GFP_KERNEL);
389 id_vendor = le16_to_cpu(udev->descriptor.idVendor);
390 id_product = le16_to_cpu(udev->descriptor.idProduct);
391 bcd_device = le16_to_cpu(udev->descriptor.bcdDevice);
392 bcd_usb = le16_to_cpu(udev->descriptor.bcdUSB);
393 pr_debug("info: VID/PID = %X/%X, Boot2 version = %X\n",
394 id_vendor, id_product, bcd_device);
396 /* PID_1 is used for firmware downloading only */
397 switch (id_product) {
402 card->usb_boot_state = USB8XXX_FW_DNLD;
408 card->usb_boot_state = USB8XXX_FW_READY;
411 pr_warn("unknown id_product %#x\n", id_product);
412 card->usb_boot_state = USB8XXX_FW_DNLD;
419 pr_debug("info: bcdUSB=%#x Device Class=%#x SubClass=%#x Protocol=%#x\n",
420 udev->descriptor.bcdUSB, udev->descriptor.bDeviceClass,
421 udev->descriptor.bDeviceSubClass,
422 udev->descriptor.bDeviceProtocol);
424 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
425 epd = &iface_desc->endpoint[i].desc;
426 if (usb_endpoint_dir_in(epd) &&
427 usb_endpoint_num(epd) == MWIFIEX_USB_EP_CMD_EVENT &&
428 usb_endpoint_xfer_bulk(epd)) {
429 pr_debug("info: bulk IN: max pkt size: %d, addr: %d\n",
430 le16_to_cpu(epd->wMaxPacketSize),
431 epd->bEndpointAddress);
432 card->rx_cmd_ep = usb_endpoint_num(epd);
433 atomic_set(&card->rx_cmd_urb_pending, 0);
435 if (usb_endpoint_dir_in(epd) &&
436 usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA &&
437 usb_endpoint_xfer_bulk(epd)) {
438 pr_debug("info: bulk IN: max pkt size: %d, addr: %d\n",
439 le16_to_cpu(epd->wMaxPacketSize),
440 epd->bEndpointAddress);
441 card->rx_data_ep = usb_endpoint_num(epd);
442 atomic_set(&card->rx_data_urb_pending, 0);
444 if (usb_endpoint_dir_out(epd) &&
445 usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA &&
446 usb_endpoint_xfer_bulk(epd)) {
447 pr_debug("info: bulk OUT: max pkt size: %d, addr: %d\n",
448 le16_to_cpu(epd->wMaxPacketSize),
449 epd->bEndpointAddress);
450 card->port[0].tx_data_ep = usb_endpoint_num(epd);
451 atomic_set(&card->port[0].tx_data_urb_pending, 0);
453 if (usb_endpoint_dir_out(epd) &&
454 usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA_CH2 &&
455 usb_endpoint_xfer_bulk(epd)) {
456 pr_debug("info: bulk OUT chan2:\t"
457 "max pkt size: %d, addr: %d\n",
458 le16_to_cpu(epd->wMaxPacketSize),
459 epd->bEndpointAddress);
460 card->port[1].tx_data_ep = usb_endpoint_num(epd);
461 atomic_set(&card->port[1].tx_data_urb_pending, 0);
463 if (usb_endpoint_dir_out(epd) &&
464 usb_endpoint_num(epd) == MWIFIEX_USB_EP_CMD_EVENT &&
465 usb_endpoint_xfer_bulk(epd)) {
466 pr_debug("info: bulk OUT: max pkt size: %d, addr: %d\n",
467 le16_to_cpu(epd->wMaxPacketSize),
468 epd->bEndpointAddress);
469 card->tx_cmd_ep = usb_endpoint_num(epd);
470 atomic_set(&card->tx_cmd_urb_pending, 0);
471 card->bulk_out_maxpktsize =
472 le16_to_cpu(epd->wMaxPacketSize);
476 switch (card->usb_boot_state) {
477 case USB8XXX_FW_DNLD:
478 /* Reject broken descriptors. */
479 if (!card->rx_cmd_ep || !card->tx_cmd_ep)
481 if (card->bulk_out_maxpktsize == 0)
484 case USB8XXX_FW_READY:
485 /* Assume the driver can handle missing endpoints for now. */
492 usb_set_intfdata(intf, card);
494 ret = mwifiex_add_card(card, &add_remove_card_sem, &usb_ops,
497 pr_err("%s: mwifiex_add_card failed: %d\n", __func__, ret);
498 usb_reset_device(udev);
508 /* Kernel needs to suspend all functions separately. Therefore all
509 * registered functions must have drivers with suspend and resume
510 * methods. Failing that the kernel simply removes the whole card.
512 * If already not suspended, this function allocates and sends a
513 * 'host sleep activate' request to the firmware and turns off the traffic.
515 static int mwifiex_usb_suspend(struct usb_interface *intf, pm_message_t message)
517 struct usb_card_rec *card = usb_get_intfdata(intf);
518 struct mwifiex_adapter *adapter;
519 struct usb_tx_data_port *port;
522 if (!card || !card->adapter) {
523 pr_err("%s: card or card->adapter is NULL\n", __func__);
526 adapter = card->adapter;
528 if (unlikely(adapter->is_suspended))
529 mwifiex_dbg(adapter, WARN,
530 "Device already suspended\n");
532 mwifiex_enable_hs(adapter);
534 /* 'is_suspended' flag indicates device is suspended.
535 * It must be set here before the usb_kill_urb() calls. Reason
536 * is in the complete handlers, urb->status(= -ENOENT) and
537 * this flag is used in combination to distinguish between a
538 * 'suspended' state and a 'disconnect' one.
540 adapter->is_suspended = true;
541 adapter->hs_enabling = false;
543 if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
544 usb_kill_urb(card->rx_cmd.urb);
546 if (atomic_read(&card->rx_data_urb_pending))
547 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
548 if (card->rx_data_list[i].urb)
549 usb_kill_urb(card->rx_data_list[i].urb);
551 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
552 port = &card->port[i];
553 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
554 if (port->tx_data_list[j].urb)
555 usb_kill_urb(port->tx_data_list[j].urb);
559 if (card->tx_cmd.urb)
560 usb_kill_urb(card->tx_cmd.urb);
565 /* Kernel needs to suspend all functions separately. Therefore all
566 * registered functions must have drivers with suspend and resume
567 * methods. Failing that the kernel simply removes the whole card.
569 * If already not resumed, this function turns on the traffic and
570 * sends a 'host sleep cancel' request to the firmware.
572 static int mwifiex_usb_resume(struct usb_interface *intf)
574 struct usb_card_rec *card = usb_get_intfdata(intf);
575 struct mwifiex_adapter *adapter;
578 if (!card || !card->adapter) {
579 pr_err("%s: card or card->adapter is NULL\n", __func__);
582 adapter = card->adapter;
584 if (unlikely(!adapter->is_suspended)) {
585 mwifiex_dbg(adapter, WARN,
586 "Device already resumed\n");
590 /* Indicate device resumed. The netdev queue will be resumed only
591 * after the urbs have been re-submitted
593 adapter->is_suspended = false;
595 if (!atomic_read(&card->rx_data_urb_pending))
596 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
597 mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
598 MWIFIEX_RX_DATA_BUF_SIZE);
600 if (!atomic_read(&card->rx_cmd_urb_pending)) {
601 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
602 if (card->rx_cmd.skb)
603 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
604 MWIFIEX_RX_CMD_BUF_SIZE);
607 /* Disable Host Sleep */
608 if (adapter->hs_activated)
609 mwifiex_cancel_hs(mwifiex_get_priv(adapter,
610 MWIFIEX_BSS_ROLE_ANY),
616 static void mwifiex_usb_disconnect(struct usb_interface *intf)
618 struct usb_card_rec *card = usb_get_intfdata(intf);
619 struct mwifiex_adapter *adapter;
621 if (!card || !card->adapter) {
622 pr_err("%s: card or card->adapter is NULL\n", __func__);
626 adapter = card->adapter;
627 if (!adapter->priv_num)
630 if (user_rmmod && !adapter->mfg_mode) {
632 if (adapter->is_suspended)
633 mwifiex_usb_resume(intf);
636 mwifiex_deauthenticate_all(adapter);
638 mwifiex_init_shutdown_fw(mwifiex_get_priv(adapter,
639 MWIFIEX_BSS_ROLE_ANY),
640 MWIFIEX_FUNC_SHUTDOWN);
643 if (adapter->workqueue)
644 flush_workqueue(adapter->workqueue);
646 mwifiex_usb_free(card);
648 mwifiex_dbg(adapter, FATAL,
649 "%s: removing card\n", __func__);
650 mwifiex_remove_card(adapter, &add_remove_card_sem);
652 usb_set_intfdata(intf, NULL);
653 usb_put_dev(interface_to_usbdev(intf));
659 static struct usb_driver mwifiex_usb_driver = {
660 .name = "mwifiex_usb",
661 .probe = mwifiex_usb_probe,
662 .disconnect = mwifiex_usb_disconnect,
663 .id_table = mwifiex_usb_table,
664 .suspend = mwifiex_usb_suspend,
665 .resume = mwifiex_usb_resume,
669 static int mwifiex_usb_tx_init(struct mwifiex_adapter *adapter)
671 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
672 struct usb_tx_data_port *port;
675 card->tx_cmd.adapter = adapter;
676 card->tx_cmd.ep = card->tx_cmd_ep;
678 card->tx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
679 if (!card->tx_cmd.urb)
682 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
683 port = &card->port[i];
684 if (!port->tx_data_ep)
686 port->tx_data_ix = 0;
687 if (port->tx_data_ep == MWIFIEX_USB_EP_DATA)
688 port->block_status = false;
690 port->block_status = true;
691 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
692 port->tx_data_list[j].adapter = adapter;
693 port->tx_data_list[j].ep = port->tx_data_ep;
694 port->tx_data_list[j].urb =
695 usb_alloc_urb(0, GFP_KERNEL);
696 if (!port->tx_data_list[j].urb)
704 static int mwifiex_usb_rx_init(struct mwifiex_adapter *adapter)
706 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
709 card->rx_cmd.adapter = adapter;
710 card->rx_cmd.ep = card->rx_cmd_ep;
712 card->rx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
713 if (!card->rx_cmd.urb)
716 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
717 if (!card->rx_cmd.skb)
720 if (mwifiex_usb_submit_rx_urb(&card->rx_cmd, MWIFIEX_RX_CMD_BUF_SIZE))
723 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
724 card->rx_data_list[i].adapter = adapter;
725 card->rx_data_list[i].ep = card->rx_data_ep;
727 card->rx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
728 if (!card->rx_data_list[i].urb)
730 if (mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
731 MWIFIEX_RX_DATA_BUF_SIZE))
738 static int mwifiex_write_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
739 u32 *len, u8 ep, u32 timeout)
741 struct usb_card_rec *card = adapter->card;
742 int actual_length, ret;
744 if (!(*len % card->bulk_out_maxpktsize))
747 /* Send the data block */
748 ret = usb_bulk_msg(card->udev, usb_sndbulkpipe(card->udev, ep), pbuf,
749 *len, &actual_length, timeout);
751 mwifiex_dbg(adapter, ERROR,
752 "usb_bulk_msg for tx failed: %d\n", ret);
756 *len = actual_length;
761 static int mwifiex_read_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
762 u32 *len, u8 ep, u32 timeout)
764 struct usb_card_rec *card = adapter->card;
765 int actual_length, ret;
767 /* Receive the data response */
768 ret = usb_bulk_msg(card->udev, usb_rcvbulkpipe(card->udev, ep), pbuf,
769 *len, &actual_length, timeout);
771 mwifiex_dbg(adapter, ERROR,
772 "usb_bulk_msg for rx failed: %d\n", ret);
776 *len = actual_length;
781 static void mwifiex_usb_port_resync(struct mwifiex_adapter *adapter)
783 struct usb_card_rec *card = adapter->card;
784 u8 active_port = MWIFIEX_USB_EP_DATA;
785 struct mwifiex_private *priv = NULL;
788 if (adapter->usb_mc_status) {
789 for (i = 0; i < adapter->priv_num; i++) {
790 priv = adapter->priv[i];
793 if ((priv->bss_role == MWIFIEX_BSS_ROLE_UAP &&
794 !priv->bss_started) ||
795 (priv->bss_role == MWIFIEX_BSS_ROLE_STA &&
796 !priv->media_connected))
797 priv->usb_port = MWIFIEX_USB_EP_DATA;
799 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++)
800 card->port[i].block_status = false;
802 for (i = 0; i < adapter->priv_num; i++) {
803 priv = adapter->priv[i];
806 if ((priv->bss_role == MWIFIEX_BSS_ROLE_UAP &&
807 priv->bss_started) ||
808 (priv->bss_role == MWIFIEX_BSS_ROLE_STA &&
809 priv->media_connected)) {
810 active_port = priv->usb_port;
814 for (i = 0; i < adapter->priv_num; i++) {
815 priv = adapter->priv[i];
817 priv->usb_port = active_port;
819 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
820 if (active_port == card->port[i].tx_data_ep)
821 card->port[i].block_status = false;
823 card->port[i].block_status = true;
828 static bool mwifiex_usb_is_port_ready(struct mwifiex_private *priv)
830 struct usb_card_rec *card = priv->adapter->card;
833 for (idx = 0; idx < MWIFIEX_TX_DATA_PORT; idx++) {
834 if (priv->usb_port == card->port[idx].tx_data_ep)
835 return !card->port[idx].block_status;
841 static inline u8 mwifiex_usb_data_sent(struct mwifiex_adapter *adapter)
843 struct usb_card_rec *card = adapter->card;
846 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++)
847 if (!card->port[i].block_status)
853 /* This function write a command/data packet to card. */
854 static int mwifiex_usb_host_to_card(struct mwifiex_adapter *adapter, u8 ep,
856 struct mwifiex_tx_param *tx_param)
858 struct usb_card_rec *card = adapter->card;
859 struct urb_context *context = NULL;
860 struct usb_tx_data_port *port = NULL;
861 u8 *data = (u8 *)skb->data;
863 int idx, ret = -EINPROGRESS;
865 if (adapter->is_suspended) {
866 mwifiex_dbg(adapter, ERROR,
867 "%s: not allowed while suspended\n", __func__);
871 if (adapter->surprise_removed) {
872 mwifiex_dbg(adapter, ERROR, "%s: device removed\n", __func__);
876 mwifiex_dbg(adapter, INFO, "%s: ep=%d\n", __func__, ep);
878 if (ep == card->tx_cmd_ep) {
879 context = &card->tx_cmd;
881 for (idx = 0; idx < MWIFIEX_TX_DATA_PORT; idx++) {
882 if (ep == card->port[idx].tx_data_ep) {
883 port = &card->port[idx];
884 if (atomic_read(&port->tx_data_urb_pending)
885 >= MWIFIEX_TX_DATA_URB) {
886 port->block_status = true;
888 mwifiex_usb_data_sent(adapter);
891 if (port->tx_data_ix >= MWIFIEX_TX_DATA_URB)
892 port->tx_data_ix = 0;
894 &port->tx_data_list[port->tx_data_ix++];
899 mwifiex_dbg(adapter, ERROR, "Wrong usb tx data port\n");
904 context->adapter = adapter;
907 tx_urb = context->urb;
909 usb_fill_bulk_urb(tx_urb, card->udev, usb_sndbulkpipe(card->udev, ep),
910 data, skb->len, mwifiex_usb_tx_complete,
913 tx_urb->transfer_flags |= URB_ZERO_PACKET;
915 if (ep == card->tx_cmd_ep)
916 atomic_inc(&card->tx_cmd_urb_pending);
918 atomic_inc(&port->tx_data_urb_pending);
920 if (ep != card->tx_cmd_ep &&
921 atomic_read(&port->tx_data_urb_pending) ==
922 MWIFIEX_TX_DATA_URB) {
923 port->block_status = true;
924 adapter->data_sent = mwifiex_usb_data_sent(adapter);
928 if (usb_submit_urb(tx_urb, GFP_ATOMIC)) {
929 mwifiex_dbg(adapter, ERROR,
930 "%s: usb_submit_urb failed\n", __func__);
931 if (ep == card->tx_cmd_ep) {
932 atomic_dec(&card->tx_cmd_urb_pending);
934 atomic_dec(&port->tx_data_urb_pending);
935 port->block_status = false;
936 adapter->data_sent = false;
937 if (port->tx_data_ix)
940 port->tx_data_ix = MWIFIEX_TX_DATA_URB;
948 /* This function register usb device and initialize parameter. */
949 static int mwifiex_register_dev(struct mwifiex_adapter *adapter)
951 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
953 card->adapter = adapter;
954 adapter->dev = &card->udev->dev;
956 switch (le16_to_cpu(card->udev->descriptor.idProduct)) {
959 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_4K;
960 strcpy(adapter->fw_name, USB8997_DEFAULT_FW_NAME);
961 adapter->ext_scan = true;
965 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
966 strcpy(adapter->fw_name, USB8766_DEFAULT_FW_NAME);
967 adapter->ext_scan = true;
971 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
972 strcpy(adapter->fw_name, USB8801_DEFAULT_FW_NAME);
973 adapter->ext_scan = false;
978 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
979 strcpy(adapter->fw_name, USB8797_DEFAULT_FW_NAME);
983 adapter->usb_mc_status = false;
984 adapter->usb_mc_setup = false;
989 static void mwifiex_unregister_dev(struct mwifiex_adapter *adapter)
991 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
993 card->adapter = NULL;
996 static int mwifiex_prog_fw_w_helper(struct mwifiex_adapter *adapter,
997 struct mwifiex_fw_image *fw)
1000 u8 *firmware = fw->fw_buf, *recv_buff;
1001 u32 retries = USB8XXX_FW_MAX_RETRY + 1;
1003 u32 fw_seqnum = 0, tlen = 0, dnld_cmd = 0;
1004 struct fw_data *fwdata;
1005 struct fw_sync_header sync_fw;
1006 u8 check_winner = 1;
1009 mwifiex_dbg(adapter, ERROR,
1010 "No firmware image found! Terminating download\n");
1015 /* Allocate memory for transmit */
1016 fwdata = kzalloc(FW_DNLD_TX_BUF_SIZE, GFP_KERNEL);
1022 /* Allocate memory for receive */
1023 recv_buff = kzalloc(FW_DNLD_RX_BUF_SIZE, GFP_KERNEL);
1030 /* Send pseudo data to check winner status first */
1032 memset(&fwdata->fw_hdr, 0, sizeof(struct fw_header));
1035 /* copy the header of the fw_data to get the length */
1036 memcpy(&fwdata->fw_hdr, &firmware[tlen],
1037 sizeof(struct fw_header));
1039 dlen = le32_to_cpu(fwdata->fw_hdr.data_len);
1040 dnld_cmd = le32_to_cpu(fwdata->fw_hdr.dnld_cmd);
1041 tlen += sizeof(struct fw_header);
1043 /* Command 7 doesn't have data length field */
1044 if (dnld_cmd == FW_CMD_7)
1047 memcpy(fwdata->data, &firmware[tlen], dlen);
1049 fwdata->seq_num = cpu_to_le32(fw_seqnum);
1053 /* If the send/receive fails or CRC occurs then retry */
1055 u8 *buf = (u8 *)fwdata;
1056 u32 len = FW_DATA_XMIT_SIZE;
1058 /* send the firmware block */
1059 ret = mwifiex_write_data_sync(adapter, buf, &len,
1060 MWIFIEX_USB_EP_CMD_EVENT,
1061 MWIFIEX_USB_TIMEOUT);
1063 mwifiex_dbg(adapter, ERROR,
1064 "write_data_sync: failed: %d\n",
1070 len = FW_DNLD_RX_BUF_SIZE;
1072 /* Receive the firmware block response */
1073 ret = mwifiex_read_data_sync(adapter, buf, &len,
1074 MWIFIEX_USB_EP_CMD_EVENT,
1075 MWIFIEX_USB_TIMEOUT);
1077 mwifiex_dbg(adapter, ERROR,
1078 "read_data_sync: failed: %d\n",
1083 memcpy(&sync_fw, recv_buff,
1084 sizeof(struct fw_sync_header));
1086 /* check 1st firmware block resp for highest bit set */
1088 if (le32_to_cpu(sync_fw.cmd) & 0x80000000) {
1089 mwifiex_dbg(adapter, WARN,
1090 "USB is not the winner %#x\n",
1093 /* returning success */
1098 mwifiex_dbg(adapter, MSG,
1099 "start to download FW...\n");
1105 /* check the firmware block response for CRC errors */
1107 mwifiex_dbg(adapter, ERROR,
1108 "FW received block with CRC %#x\n",
1114 retries = USB8XXX_FW_MAX_RETRY + 1;
1118 } while ((dnld_cmd != FW_HAS_LAST_BLOCK) && retries);
1121 mwifiex_dbg(adapter, MSG,
1122 "info: FW download over, size %d bytes\n", tlen);
1133 static int mwifiex_usb_dnld_fw(struct mwifiex_adapter *adapter,
1134 struct mwifiex_fw_image *fw)
1137 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1139 if (card->usb_boot_state == USB8XXX_FW_DNLD) {
1140 ret = mwifiex_prog_fw_w_helper(adapter, fw);
1144 /* Boot state changes after successful firmware download */
1145 if (card->usb_boot_state == USB8XXX_FW_DNLD)
1149 ret = mwifiex_usb_rx_init(adapter);
1151 ret = mwifiex_usb_tx_init(adapter);
1156 static void mwifiex_submit_rx_urb(struct mwifiex_adapter *adapter, u8 ep)
1158 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1160 skb_push(card->rx_cmd.skb, INTF_HEADER_LEN);
1161 if ((ep == card->rx_cmd_ep) &&
1162 (!atomic_read(&card->rx_cmd_urb_pending)))
1163 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
1164 MWIFIEX_RX_CMD_BUF_SIZE);
1169 static int mwifiex_usb_cmd_event_complete(struct mwifiex_adapter *adapter,
1170 struct sk_buff *skb)
1172 mwifiex_submit_rx_urb(adapter, MWIFIEX_USB_EP_CMD_EVENT);
1177 /* This function wakes up the card. */
1178 static int mwifiex_pm_wakeup_card(struct mwifiex_adapter *adapter)
1180 /* Simulation of HS_AWAKE event */
1181 adapter->pm_wakeup_fw_try = false;
1182 del_timer(&adapter->wakeup_timer);
1183 adapter->pm_wakeup_card_req = false;
1184 adapter->ps_state = PS_STATE_AWAKE;
1189 static void mwifiex_usb_submit_rem_rx_urbs(struct mwifiex_adapter *adapter)
1191 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1193 struct urb_context *ctx;
1195 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
1196 if (card->rx_data_list[i].skb)
1198 ctx = &card->rx_data_list[i];
1199 mwifiex_usb_submit_rx_urb(ctx, MWIFIEX_RX_DATA_BUF_SIZE);
1203 /* This function is called after the card has woken up. */
1205 mwifiex_pm_wakeup_card_complete(struct mwifiex_adapter *adapter)
1210 static struct mwifiex_if_ops usb_ops = {
1211 .register_dev = mwifiex_register_dev,
1212 .unregister_dev = mwifiex_unregister_dev,
1213 .wakeup = mwifiex_pm_wakeup_card,
1214 .wakeup_complete = mwifiex_pm_wakeup_card_complete,
1217 .dnld_fw = mwifiex_usb_dnld_fw,
1218 .cmdrsp_complete = mwifiex_usb_cmd_event_complete,
1219 .event_complete = mwifiex_usb_cmd_event_complete,
1220 .host_to_card = mwifiex_usb_host_to_card,
1221 .submit_rem_rx_urbs = mwifiex_usb_submit_rem_rx_urbs,
1222 .multi_port_resync = mwifiex_usb_port_resync,
1223 .is_port_ready = mwifiex_usb_is_port_ready,
1226 /* This function initializes the USB driver module.
1228 * This initiates the semaphore and registers the device with
1231 static int mwifiex_usb_init_module(void)
1235 pr_debug("Marvell USB8797 Driver\n");
1237 sema_init(&add_remove_card_sem, 1);
1239 ret = usb_register(&mwifiex_usb_driver);
1241 pr_err("Driver register failed!\n");
1243 pr_debug("info: Driver registered successfully!\n");
1248 /* This function cleans up the USB driver.
1250 * The following major steps are followed in .disconnect for cleanup:
1251 * - Resume the device if its suspended
1252 * - Disconnect the device if connected
1253 * - Shutdown the firmware
1254 * - Unregister the device from USB bus.
1256 static void mwifiex_usb_cleanup_module(void)
1258 if (!down_interruptible(&add_remove_card_sem))
1259 up(&add_remove_card_sem);
1261 /* set the flag as user is removing this module */
1264 usb_deregister(&mwifiex_usb_driver);
1267 module_init(mwifiex_usb_init_module);
1268 module_exit(mwifiex_usb_cleanup_module);
1270 MODULE_AUTHOR("Marvell International Ltd.");
1271 MODULE_DESCRIPTION("Marvell WiFi-Ex USB Driver version" USB_VERSION);
1272 MODULE_VERSION(USB_VERSION);
1273 MODULE_LICENSE("GPL v2");