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;
28 static struct usb_device_id mwifiex_usb_table[] = {
30 {USB_DEVICE(USB8XXX_VID, USB8766_PID_1)},
31 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8766_PID_2,
32 USB_CLASS_VENDOR_SPEC,
33 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
35 {USB_DEVICE(USB8XXX_VID, USB8797_PID_1)},
36 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8797_PID_2,
37 USB_CLASS_VENDOR_SPEC,
38 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
40 {USB_DEVICE(USB8XXX_VID, USB8801_PID_1)},
41 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8801_PID_2,
42 USB_CLASS_VENDOR_SPEC,
43 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
45 {USB_DEVICE(USB8XXX_VID, USB8997_PID_1)},
46 {USB_DEVICE_AND_INTERFACE_INFO(USB8XXX_VID, USB8997_PID_2,
47 USB_CLASS_VENDOR_SPEC,
48 USB_SUBCLASS_VENDOR_SPEC, 0xff)},
49 { } /* Terminating entry */
52 MODULE_DEVICE_TABLE(usb, mwifiex_usb_table);
54 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size);
56 /* This function handles received packet. Necessary action is taken based on
59 static int mwifiex_usb_recv(struct mwifiex_adapter *adapter,
60 struct sk_buff *skb, u8 ep)
66 if (adapter->hs_activated)
67 mwifiex_process_hs_config(adapter);
69 if (skb->len < INTF_HEADER_LEN) {
70 mwifiex_dbg(adapter, ERROR,
71 "%s: invalid skb->len\n", __func__);
76 case MWIFIEX_USB_EP_CMD_EVENT:
77 mwifiex_dbg(adapter, EVENT,
78 "%s: EP_CMD_EVENT\n", __func__);
79 skb_copy_from_linear_data(skb, &tmp, INTF_HEADER_LEN);
80 recv_type = le32_to_cpu(tmp);
81 skb_pull(skb, INTF_HEADER_LEN);
84 case MWIFIEX_USB_TYPE_CMD:
85 if (skb->len > MWIFIEX_SIZE_OF_CMD_BUFFER) {
86 mwifiex_dbg(adapter, ERROR,
87 "CMD: skb->len too large\n");
89 goto exit_restore_skb;
90 } else if (!adapter->curr_cmd) {
91 mwifiex_dbg(adapter, WARN, "CMD: no curr_cmd\n");
92 if (adapter->ps_state == PS_STATE_SLEEP_CFM) {
93 mwifiex_process_sleep_confirm_resp(
97 goto exit_restore_skb;
100 goto exit_restore_skb;
103 adapter->curr_cmd->resp_skb = skb;
104 adapter->cmd_resp_received = true;
106 case MWIFIEX_USB_TYPE_EVENT:
107 if (skb->len < sizeof(u32)) {
108 mwifiex_dbg(adapter, ERROR,
109 "EVENT: skb->len too small\n");
111 goto exit_restore_skb;
113 skb_copy_from_linear_data(skb, &tmp, sizeof(u32));
114 adapter->event_cause = le32_to_cpu(tmp);
115 mwifiex_dbg(adapter, EVENT,
116 "event_cause %#x\n", adapter->event_cause);
118 if (skb->len > MAX_EVENT_SIZE) {
119 mwifiex_dbg(adapter, ERROR,
120 "EVENT: event body too large\n");
122 goto exit_restore_skb;
125 memcpy(adapter->event_body, skb->data +
126 MWIFIEX_EVENT_HEADER_LEN, skb->len);
128 adapter->event_received = true;
129 adapter->event_skb = skb;
132 mwifiex_dbg(adapter, ERROR,
133 "unknown recv_type %#x\n", recv_type);
137 case MWIFIEX_USB_EP_DATA:
138 mwifiex_dbg(adapter, DATA, "%s: EP_DATA\n", __func__);
139 if (skb->len > MWIFIEX_RX_DATA_BUF_SIZE) {
140 mwifiex_dbg(adapter, ERROR,
141 "DATA: skb->len too large\n");
145 skb_queue_tail(&adapter->rx_data_q, skb);
146 adapter->data_received = true;
147 atomic_inc(&adapter->rx_pending);
150 mwifiex_dbg(adapter, ERROR,
151 "%s: unknown endport %#x\n", __func__, ep);
158 /* The buffer will be reused for further cmds/events */
159 skb_push(skb, INTF_HEADER_LEN);
164 static void mwifiex_usb_rx_complete(struct urb *urb)
166 struct urb_context *context = (struct urb_context *)urb->context;
167 struct mwifiex_adapter *adapter = context->adapter;
168 struct sk_buff *skb = context->skb;
169 struct usb_card_rec *card;
170 int recv_length = urb->actual_length;
173 if (!adapter || !adapter->card) {
174 pr_err("mwifiex adapter or card structure is not valid\n");
178 card = (struct usb_card_rec *)adapter->card;
179 if (card->rx_cmd_ep == context->ep)
180 atomic_dec(&card->rx_cmd_urb_pending);
182 atomic_dec(&card->rx_data_urb_pending);
185 if (urb->status || (adapter->surprise_removed)) {
186 mwifiex_dbg(adapter, ERROR,
187 "URB status is failed: %d\n", urb->status);
188 /* Do not free skb in case of command ep */
189 if (card->rx_cmd_ep != context->ep)
190 dev_kfree_skb_any(skb);
193 if (skb->len > recv_length)
194 skb_trim(skb, recv_length);
196 skb_put(skb, recv_length - skb->len);
198 status = mwifiex_usb_recv(adapter, skb, context->ep);
200 mwifiex_dbg(adapter, INFO,
201 "info: recv_length=%d, status=%d\n",
202 recv_length, status);
203 if (status == -EINPROGRESS) {
204 mwifiex_queue_main_work(adapter);
206 /* urb for data_ep is re-submitted now;
207 * urb for cmd_ep will be re-submitted in callback
208 * mwifiex_usb_recv_complete
210 if (card->rx_cmd_ep == context->ep)
214 mwifiex_dbg(adapter, ERROR,
215 "received data processing failed!\n");
217 /* Do not free skb in case of command ep */
218 if (card->rx_cmd_ep != context->ep)
219 dev_kfree_skb_any(skb);
221 } else if (urb->status) {
222 if (!adapter->is_suspended) {
223 mwifiex_dbg(adapter, FATAL,
224 "Card is removed: %d\n", urb->status);
225 adapter->surprise_removed = true;
227 dev_kfree_skb_any(skb);
230 /* Do not free skb in case of command ep */
231 if (card->rx_cmd_ep != context->ep)
232 dev_kfree_skb_any(skb);
234 /* fall through setup_for_next */
238 if (card->rx_cmd_ep == context->ep)
239 size = MWIFIEX_RX_CMD_BUF_SIZE;
241 size = MWIFIEX_RX_DATA_BUF_SIZE;
243 if (card->rx_cmd_ep == context->ep) {
244 mwifiex_usb_submit_rx_urb(context, size);
246 if (atomic_read(&adapter->rx_pending) <= HIGH_RX_PENDING) {
247 mwifiex_usb_submit_rx_urb(context, size);
256 static void mwifiex_usb_tx_complete(struct urb *urb)
258 struct urb_context *context = (struct urb_context *)(urb->context);
259 struct mwifiex_adapter *adapter = context->adapter;
260 struct usb_card_rec *card = adapter->card;
261 struct usb_tx_data_port *port;
264 mwifiex_dbg(adapter, INFO,
265 "%s: status: %d\n", __func__, urb->status);
267 if (context->ep == card->tx_cmd_ep) {
268 mwifiex_dbg(adapter, CMD,
269 "%s: CMD\n", __func__);
270 atomic_dec(&card->tx_cmd_urb_pending);
271 adapter->cmd_sent = false;
273 mwifiex_dbg(adapter, DATA,
274 "%s: DATA\n", __func__);
275 mwifiex_write_data_complete(adapter, context->skb, 0,
276 urb->status ? -1 : 0);
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;
288 if (card->mc_resync_flag)
289 mwifiex_multi_chan_resync(adapter);
291 mwifiex_queue_main_work(adapter);
296 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size)
298 struct mwifiex_adapter *adapter = ctx->adapter;
299 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
301 if (card->rx_cmd_ep != ctx->ep) {
302 ctx->skb = dev_alloc_skb(size);
304 mwifiex_dbg(adapter, ERROR,
305 "%s: dev_alloc_skb failed\n", __func__);
310 usb_fill_bulk_urb(ctx->urb, card->udev,
311 usb_rcvbulkpipe(card->udev, ctx->ep), ctx->skb->data,
312 size, mwifiex_usb_rx_complete, (void *)ctx);
314 if (card->rx_cmd_ep == ctx->ep)
315 atomic_inc(&card->rx_cmd_urb_pending);
317 atomic_inc(&card->rx_data_urb_pending);
319 if (usb_submit_urb(ctx->urb, GFP_ATOMIC)) {
320 mwifiex_dbg(adapter, ERROR, "usb_submit_urb failed\n");
321 dev_kfree_skb_any(ctx->skb);
324 if (card->rx_cmd_ep == ctx->ep)
325 atomic_dec(&card->rx_cmd_urb_pending);
327 atomic_dec(&card->rx_data_urb_pending);
335 static void mwifiex_usb_free(struct usb_card_rec *card)
337 struct usb_tx_data_port *port;
340 if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
341 usb_kill_urb(card->rx_cmd.urb);
343 usb_free_urb(card->rx_cmd.urb);
344 card->rx_cmd.urb = NULL;
346 if (atomic_read(&card->rx_data_urb_pending))
347 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
348 if (card->rx_data_list[i].urb)
349 usb_kill_urb(card->rx_data_list[i].urb);
351 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
352 usb_free_urb(card->rx_data_list[i].urb);
353 card->rx_data_list[i].urb = NULL;
356 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
357 port = &card->port[i];
358 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
359 usb_free_urb(port->tx_data_list[j].urb);
360 port->tx_data_list[j].urb = NULL;
364 usb_free_urb(card->tx_cmd.urb);
365 card->tx_cmd.urb = NULL;
370 /* This function probes an mwifiex device and registers it. It allocates
371 * the card structure, initiates the device registration and initialization
372 * procedure by adding a logical interface.
374 static int mwifiex_usb_probe(struct usb_interface *intf,
375 const struct usb_device_id *id)
377 struct usb_device *udev = interface_to_usbdev(intf);
378 struct usb_host_interface *iface_desc = intf->cur_altsetting;
379 struct usb_endpoint_descriptor *epd;
381 struct usb_card_rec *card;
382 u16 id_vendor, id_product, bcd_device, bcd_usb;
384 card = devm_kzalloc(&intf->dev, sizeof(*card), GFP_KERNEL);
388 init_completion(&card->fw_done);
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 usb_set_intfdata(intf, card);
479 ret = mwifiex_add_card(card, &card->fw_done, &usb_ops,
480 MWIFIEX_USB, &card->udev->dev);
482 pr_err("%s: mwifiex_add_card failed: %d\n", __func__, ret);
483 usb_reset_device(udev);
492 /* Kernel needs to suspend all functions separately. Therefore all
493 * registered functions must have drivers with suspend and resume
494 * methods. Failing that the kernel simply removes the whole card.
496 * If already not suspended, this function allocates and sends a
497 * 'host sleep activate' request to the firmware and turns off the traffic.
499 static int mwifiex_usb_suspend(struct usb_interface *intf, pm_message_t message)
501 struct usb_card_rec *card = usb_get_intfdata(intf);
502 struct mwifiex_adapter *adapter;
503 struct usb_tx_data_port *port;
506 if (!card || !card->adapter) {
507 pr_err("%s: card or card->adapter is NULL\n", __func__);
510 adapter = card->adapter;
512 if (unlikely(adapter->is_suspended))
513 mwifiex_dbg(adapter, WARN,
514 "Device already suspended\n");
516 mwifiex_enable_hs(adapter);
518 /* 'is_suspended' flag indicates device is suspended.
519 * It must be set here before the usb_kill_urb() calls. Reason
520 * is in the complete handlers, urb->status(= -ENOENT) and
521 * this flag is used in combination to distinguish between a
522 * 'suspended' state and a 'disconnect' one.
524 adapter->is_suspended = true;
525 adapter->hs_enabling = false;
527 if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
528 usb_kill_urb(card->rx_cmd.urb);
530 if (atomic_read(&card->rx_data_urb_pending))
531 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
532 if (card->rx_data_list[i].urb)
533 usb_kill_urb(card->rx_data_list[i].urb);
535 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
536 port = &card->port[i];
537 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
538 if (port->tx_data_list[j].urb)
539 usb_kill_urb(port->tx_data_list[j].urb);
543 if (card->tx_cmd.urb)
544 usb_kill_urb(card->tx_cmd.urb);
549 /* Kernel needs to suspend all functions separately. Therefore all
550 * registered functions must have drivers with suspend and resume
551 * methods. Failing that the kernel simply removes the whole card.
553 * If already not resumed, this function turns on the traffic and
554 * sends a 'host sleep cancel' request to the firmware.
556 static int mwifiex_usb_resume(struct usb_interface *intf)
558 struct usb_card_rec *card = usb_get_intfdata(intf);
559 struct mwifiex_adapter *adapter;
562 if (!card || !card->adapter) {
563 pr_err("%s: card or card->adapter is NULL\n", __func__);
566 adapter = card->adapter;
568 if (unlikely(!adapter->is_suspended)) {
569 mwifiex_dbg(adapter, WARN,
570 "Device already resumed\n");
574 /* Indicate device resumed. The netdev queue will be resumed only
575 * after the urbs have been re-submitted
577 adapter->is_suspended = false;
579 if (!atomic_read(&card->rx_data_urb_pending))
580 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
581 mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
582 MWIFIEX_RX_DATA_BUF_SIZE);
584 if (!atomic_read(&card->rx_cmd_urb_pending)) {
585 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
586 if (card->rx_cmd.skb)
587 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
588 MWIFIEX_RX_CMD_BUF_SIZE);
591 /* Disable Host Sleep */
592 if (adapter->hs_activated)
593 mwifiex_cancel_hs(mwifiex_get_priv(adapter,
594 MWIFIEX_BSS_ROLE_ANY),
600 static void mwifiex_usb_disconnect(struct usb_interface *intf)
602 struct usb_card_rec *card = usb_get_intfdata(intf);
603 struct mwifiex_adapter *adapter;
606 dev_err(&intf->dev, "%s: card is NULL\n", __func__);
610 wait_for_completion(&card->fw_done);
612 adapter = card->adapter;
613 if (!adapter || !adapter->priv_num)
616 if (user_rmmod && !adapter->mfg_mode) {
618 if (adapter->is_suspended)
619 mwifiex_usb_resume(intf);
622 mwifiex_deauthenticate_all(adapter);
624 mwifiex_init_shutdown_fw(mwifiex_get_priv(adapter,
625 MWIFIEX_BSS_ROLE_ANY),
626 MWIFIEX_FUNC_SHUTDOWN);
629 mwifiex_usb_free(card);
631 mwifiex_dbg(adapter, FATAL,
632 "%s: removing card\n", __func__);
633 mwifiex_remove_card(adapter);
635 usb_put_dev(interface_to_usbdev(intf));
638 static struct usb_driver mwifiex_usb_driver = {
639 .name = "mwifiex_usb",
640 .probe = mwifiex_usb_probe,
641 .disconnect = mwifiex_usb_disconnect,
642 .id_table = mwifiex_usb_table,
643 .suspend = mwifiex_usb_suspend,
644 .resume = mwifiex_usb_resume,
648 static int mwifiex_usb_tx_init(struct mwifiex_adapter *adapter)
650 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
651 struct usb_tx_data_port *port;
654 card->tx_cmd.adapter = adapter;
655 card->tx_cmd.ep = card->tx_cmd_ep;
657 card->tx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
658 if (!card->tx_cmd.urb)
661 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
662 port = &card->port[i];
663 if (!port->tx_data_ep)
665 port->tx_data_ix = 0;
666 if (port->tx_data_ep == MWIFIEX_USB_EP_DATA)
667 port->block_status = false;
669 port->block_status = true;
670 for (j = 0; j < MWIFIEX_TX_DATA_URB; j++) {
671 port->tx_data_list[j].adapter = adapter;
672 port->tx_data_list[j].ep = port->tx_data_ep;
673 port->tx_data_list[j].urb =
674 usb_alloc_urb(0, GFP_KERNEL);
675 if (!port->tx_data_list[j].urb)
683 static int mwifiex_usb_rx_init(struct mwifiex_adapter *adapter)
685 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
688 card->rx_cmd.adapter = adapter;
689 card->rx_cmd.ep = card->rx_cmd_ep;
691 card->rx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
692 if (!card->rx_cmd.urb)
695 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
696 if (!card->rx_cmd.skb)
699 if (mwifiex_usb_submit_rx_urb(&card->rx_cmd, MWIFIEX_RX_CMD_BUF_SIZE))
702 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
703 card->rx_data_list[i].adapter = adapter;
704 card->rx_data_list[i].ep = card->rx_data_ep;
706 card->rx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
707 if (!card->rx_data_list[i].urb)
709 if (mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
710 MWIFIEX_RX_DATA_BUF_SIZE))
717 static int mwifiex_write_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
718 u32 *len, u8 ep, u32 timeout)
720 struct usb_card_rec *card = adapter->card;
721 int actual_length, ret;
723 if (!(*len % card->bulk_out_maxpktsize))
726 /* Send the data block */
727 ret = usb_bulk_msg(card->udev, usb_sndbulkpipe(card->udev, ep), pbuf,
728 *len, &actual_length, timeout);
730 mwifiex_dbg(adapter, ERROR,
731 "usb_bulk_msg for tx failed: %d\n", ret);
735 *len = actual_length;
740 static int mwifiex_read_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
741 u32 *len, u8 ep, u32 timeout)
743 struct usb_card_rec *card = adapter->card;
744 int actual_length, ret;
746 /* Receive the data response */
747 ret = usb_bulk_msg(card->udev, usb_rcvbulkpipe(card->udev, ep), pbuf,
748 *len, &actual_length, timeout);
750 mwifiex_dbg(adapter, ERROR,
751 "usb_bulk_msg for rx failed: %d\n", ret);
755 *len = actual_length;
760 static void mwifiex_usb_port_resync(struct mwifiex_adapter *adapter)
762 struct usb_card_rec *card = adapter->card;
763 u8 active_port = MWIFIEX_USB_EP_DATA;
764 struct mwifiex_private *priv = NULL;
767 if (adapter->usb_mc_status) {
768 for (i = 0; i < adapter->priv_num; i++) {
769 priv = adapter->priv[i];
772 if ((priv->bss_role == MWIFIEX_BSS_ROLE_UAP &&
773 !priv->bss_started) ||
774 (priv->bss_role == MWIFIEX_BSS_ROLE_STA &&
775 !priv->media_connected))
776 priv->usb_port = MWIFIEX_USB_EP_DATA;
778 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++)
779 card->port[i].block_status = false;
781 for (i = 0; i < adapter->priv_num; i++) {
782 priv = adapter->priv[i];
785 if ((priv->bss_role == MWIFIEX_BSS_ROLE_UAP &&
786 priv->bss_started) ||
787 (priv->bss_role == MWIFIEX_BSS_ROLE_STA &&
788 priv->media_connected)) {
789 active_port = priv->usb_port;
793 for (i = 0; i < adapter->priv_num; i++) {
794 priv = adapter->priv[i];
796 priv->usb_port = active_port;
798 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++) {
799 if (active_port == card->port[i].tx_data_ep)
800 card->port[i].block_status = false;
802 card->port[i].block_status = true;
807 static bool mwifiex_usb_is_port_ready(struct mwifiex_private *priv)
809 struct usb_card_rec *card = priv->adapter->card;
812 for (idx = 0; idx < MWIFIEX_TX_DATA_PORT; idx++) {
813 if (priv->usb_port == card->port[idx].tx_data_ep)
814 return !card->port[idx].block_status;
820 static inline u8 mwifiex_usb_data_sent(struct mwifiex_adapter *adapter)
822 struct usb_card_rec *card = adapter->card;
825 for (i = 0; i < MWIFIEX_TX_DATA_PORT; i++)
826 if (!card->port[i].block_status)
832 /* This function write a command/data packet to card. */
833 static int mwifiex_usb_host_to_card(struct mwifiex_adapter *adapter, u8 ep,
835 struct mwifiex_tx_param *tx_param)
837 struct usb_card_rec *card = adapter->card;
838 struct urb_context *context = NULL;
839 struct usb_tx_data_port *port = NULL;
840 u8 *data = (u8 *)skb->data;
842 int idx, ret = -EINPROGRESS;
844 if (adapter->is_suspended) {
845 mwifiex_dbg(adapter, ERROR,
846 "%s: not allowed while suspended\n", __func__);
850 if (adapter->surprise_removed) {
851 mwifiex_dbg(adapter, ERROR, "%s: device removed\n", __func__);
855 mwifiex_dbg(adapter, INFO, "%s: ep=%d\n", __func__, ep);
857 if (ep == card->tx_cmd_ep) {
858 context = &card->tx_cmd;
860 for (idx = 0; idx < MWIFIEX_TX_DATA_PORT; idx++) {
861 if (ep == card->port[idx].tx_data_ep) {
862 port = &card->port[idx];
863 if (atomic_read(&port->tx_data_urb_pending)
864 >= MWIFIEX_TX_DATA_URB) {
865 port->block_status = true;
867 mwifiex_usb_data_sent(adapter);
870 if (port->tx_data_ix >= MWIFIEX_TX_DATA_URB)
871 port->tx_data_ix = 0;
873 &port->tx_data_list[port->tx_data_ix++];
878 mwifiex_dbg(adapter, ERROR, "Wrong usb tx data port\n");
883 context->adapter = adapter;
886 tx_urb = context->urb;
888 usb_fill_bulk_urb(tx_urb, card->udev, usb_sndbulkpipe(card->udev, ep),
889 data, skb->len, mwifiex_usb_tx_complete,
892 tx_urb->transfer_flags |= URB_ZERO_PACKET;
894 if (ep == card->tx_cmd_ep)
895 atomic_inc(&card->tx_cmd_urb_pending);
897 atomic_inc(&port->tx_data_urb_pending);
899 if (ep != card->tx_cmd_ep &&
900 atomic_read(&port->tx_data_urb_pending) ==
901 MWIFIEX_TX_DATA_URB) {
902 port->block_status = true;
903 adapter->data_sent = mwifiex_usb_data_sent(adapter);
907 if (usb_submit_urb(tx_urb, GFP_ATOMIC)) {
908 mwifiex_dbg(adapter, ERROR,
909 "%s: usb_submit_urb failed\n", __func__);
910 if (ep == card->tx_cmd_ep) {
911 atomic_dec(&card->tx_cmd_urb_pending);
913 atomic_dec(&port->tx_data_urb_pending);
914 port->block_status = false;
915 adapter->data_sent = false;
916 if (port->tx_data_ix)
919 port->tx_data_ix = MWIFIEX_TX_DATA_URB;
927 /* This function register usb device and initialize parameter. */
928 static int mwifiex_register_dev(struct mwifiex_adapter *adapter)
930 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
932 card->adapter = adapter;
934 switch (le16_to_cpu(card->udev->descriptor.idProduct)) {
937 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_4K;
938 strcpy(adapter->fw_name, USB8997_DEFAULT_FW_NAME);
939 adapter->ext_scan = true;
943 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
944 strcpy(adapter->fw_name, USB8766_DEFAULT_FW_NAME);
945 adapter->ext_scan = true;
949 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
950 strcpy(adapter->fw_name, USB8801_DEFAULT_FW_NAME);
951 adapter->ext_scan = false;
956 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
957 strcpy(adapter->fw_name, USB8797_DEFAULT_FW_NAME);
961 adapter->usb_mc_status = false;
962 adapter->usb_mc_setup = false;
967 static void mwifiex_unregister_dev(struct mwifiex_adapter *adapter)
969 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
971 card->adapter = NULL;
974 static int mwifiex_prog_fw_w_helper(struct mwifiex_adapter *adapter,
975 struct mwifiex_fw_image *fw)
978 u8 *firmware = fw->fw_buf, *recv_buff;
979 u32 retries = USB8XXX_FW_MAX_RETRY + 1;
981 u32 fw_seqnum = 0, tlen = 0, dnld_cmd = 0;
982 struct fw_data *fwdata;
983 struct fw_sync_header sync_fw;
987 mwifiex_dbg(adapter, ERROR,
988 "No firmware image found! Terminating download\n");
993 /* Allocate memory for transmit */
994 fwdata = kzalloc(FW_DNLD_TX_BUF_SIZE, GFP_KERNEL);
1000 /* Allocate memory for receive */
1001 recv_buff = kzalloc(FW_DNLD_RX_BUF_SIZE, GFP_KERNEL);
1008 /* Send pseudo data to check winner status first */
1010 memset(&fwdata->fw_hdr, 0, sizeof(struct fw_header));
1013 /* copy the header of the fw_data to get the length */
1014 memcpy(&fwdata->fw_hdr, &firmware[tlen],
1015 sizeof(struct fw_header));
1017 dlen = le32_to_cpu(fwdata->fw_hdr.data_len);
1018 dnld_cmd = le32_to_cpu(fwdata->fw_hdr.dnld_cmd);
1019 tlen += sizeof(struct fw_header);
1021 /* Command 7 doesn't have data length field */
1022 if (dnld_cmd == FW_CMD_7)
1025 memcpy(fwdata->data, &firmware[tlen], dlen);
1027 fwdata->seq_num = cpu_to_le32(fw_seqnum);
1031 /* If the send/receive fails or CRC occurs then retry */
1033 u8 *buf = (u8 *)fwdata;
1034 u32 len = FW_DATA_XMIT_SIZE;
1036 /* send the firmware block */
1037 ret = mwifiex_write_data_sync(adapter, buf, &len,
1038 MWIFIEX_USB_EP_CMD_EVENT,
1039 MWIFIEX_USB_TIMEOUT);
1041 mwifiex_dbg(adapter, ERROR,
1042 "write_data_sync: failed: %d\n",
1048 len = FW_DNLD_RX_BUF_SIZE;
1050 /* Receive the firmware block response */
1051 ret = mwifiex_read_data_sync(adapter, buf, &len,
1052 MWIFIEX_USB_EP_CMD_EVENT,
1053 MWIFIEX_USB_TIMEOUT);
1055 mwifiex_dbg(adapter, ERROR,
1056 "read_data_sync: failed: %d\n",
1061 memcpy(&sync_fw, recv_buff,
1062 sizeof(struct fw_sync_header));
1064 /* check 1st firmware block resp for highest bit set */
1066 if (le32_to_cpu(sync_fw.cmd) & 0x80000000) {
1067 mwifiex_dbg(adapter, WARN,
1068 "USB is not the winner %#x\n",
1071 /* returning success */
1076 mwifiex_dbg(adapter, MSG,
1077 "start to download FW...\n");
1083 /* check the firmware block response for CRC errors */
1085 mwifiex_dbg(adapter, ERROR,
1086 "FW received block with CRC %#x\n",
1092 retries = USB8XXX_FW_MAX_RETRY + 1;
1096 } while ((dnld_cmd != FW_HAS_LAST_BLOCK) && retries);
1099 mwifiex_dbg(adapter, MSG,
1100 "info: FW download over, size %d bytes\n", tlen);
1111 static int mwifiex_usb_dnld_fw(struct mwifiex_adapter *adapter,
1112 struct mwifiex_fw_image *fw)
1115 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1117 if (card->usb_boot_state == USB8XXX_FW_DNLD) {
1118 ret = mwifiex_prog_fw_w_helper(adapter, fw);
1122 /* Boot state changes after successful firmware download */
1123 if (card->usb_boot_state == USB8XXX_FW_DNLD)
1127 ret = mwifiex_usb_rx_init(adapter);
1129 ret = mwifiex_usb_tx_init(adapter);
1134 static void mwifiex_submit_rx_urb(struct mwifiex_adapter *adapter, u8 ep)
1136 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1138 skb_push(card->rx_cmd.skb, INTF_HEADER_LEN);
1139 if ((ep == card->rx_cmd_ep) &&
1140 (!atomic_read(&card->rx_cmd_urb_pending)))
1141 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
1142 MWIFIEX_RX_CMD_BUF_SIZE);
1147 static int mwifiex_usb_cmd_event_complete(struct mwifiex_adapter *adapter,
1148 struct sk_buff *skb)
1150 mwifiex_submit_rx_urb(adapter, MWIFIEX_USB_EP_CMD_EVENT);
1155 /* This function wakes up the card. */
1156 static int mwifiex_pm_wakeup_card(struct mwifiex_adapter *adapter)
1158 /* Simulation of HS_AWAKE event */
1159 adapter->pm_wakeup_fw_try = false;
1160 del_timer(&adapter->wakeup_timer);
1161 adapter->pm_wakeup_card_req = false;
1162 adapter->ps_state = PS_STATE_AWAKE;
1167 static void mwifiex_usb_submit_rem_rx_urbs(struct mwifiex_adapter *adapter)
1169 struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
1171 struct urb_context *ctx;
1173 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
1174 if (card->rx_data_list[i].skb)
1176 ctx = &card->rx_data_list[i];
1177 mwifiex_usb_submit_rx_urb(ctx, MWIFIEX_RX_DATA_BUF_SIZE);
1181 /* This function is called after the card has woken up. */
1183 mwifiex_pm_wakeup_card_complete(struct mwifiex_adapter *adapter)
1188 static struct mwifiex_if_ops usb_ops = {
1189 .register_dev = mwifiex_register_dev,
1190 .unregister_dev = mwifiex_unregister_dev,
1191 .wakeup = mwifiex_pm_wakeup_card,
1192 .wakeup_complete = mwifiex_pm_wakeup_card_complete,
1195 .dnld_fw = mwifiex_usb_dnld_fw,
1196 .cmdrsp_complete = mwifiex_usb_cmd_event_complete,
1197 .event_complete = mwifiex_usb_cmd_event_complete,
1198 .host_to_card = mwifiex_usb_host_to_card,
1199 .submit_rem_rx_urbs = mwifiex_usb_submit_rem_rx_urbs,
1200 .multi_port_resync = mwifiex_usb_port_resync,
1201 .is_port_ready = mwifiex_usb_is_port_ready,
1204 /* This function initializes the USB driver module.
1206 * This registers the device with USB bus.
1208 static int mwifiex_usb_init_module(void)
1212 pr_debug("Marvell USB8797 Driver\n");
1214 ret = usb_register(&mwifiex_usb_driver);
1216 pr_err("Driver register failed!\n");
1218 pr_debug("info: Driver registered successfully!\n");
1223 /* This function cleans up the USB driver.
1225 * The following major steps are followed in .disconnect for cleanup:
1226 * - Resume the device if its suspended
1227 * - Disconnect the device if connected
1228 * - Shutdown the firmware
1229 * - Unregister the device from USB bus.
1231 static void mwifiex_usb_cleanup_module(void)
1233 /* set the flag as user is removing this module */
1236 usb_deregister(&mwifiex_usb_driver);
1239 module_init(mwifiex_usb_init_module);
1240 module_exit(mwifiex_usb_cleanup_module);
1242 MODULE_AUTHOR("Marvell International Ltd.");
1243 MODULE_DESCRIPTION("Marvell WiFi-Ex USB Driver version" USB_VERSION);
1244 MODULE_VERSION(USB_VERSION);
1245 MODULE_LICENSE("GPL v2");
1246 MODULE_FIRMWARE(USB8766_DEFAULT_FW_NAME);
1247 MODULE_FIRMWARE(USB8797_DEFAULT_FW_NAME);
1248 MODULE_FIRMWARE(USB8801_DEFAULT_FW_NAME);
1249 MODULE_FIRMWARE(USB8997_DEFAULT_FW_NAME);