1 // SPDX-License-Identifier: GPL-2.0-only
3 * This file contains functions used in USB interface module.
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8 #include <linux/delay.h>
9 #include <linux/module.h>
10 #include <linux/firmware.h>
11 #include <linux/netdevice.h>
12 #include <linux/slab.h>
13 #include <linux/usb.h>
14 #include <linux/olpc-ec.h>
20 #define DRV_NAME "usb8xxx"
30 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
32 #define MESSAGE_HEADER_LEN 4
42 /* table of firmware file names */
43 static const struct lbs_fw_table fw_table[] = {
44 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
45 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
46 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
47 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
48 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
49 { MODEL_8682, "/*(DEBLOBBED)*/", NULL },
53 static const struct usb_device_id if_usb_table[] = {
54 /* Enter the device signature inside */
55 { USB_DEVICE(0x1286, 0x2001), .driver_info = MODEL_8388 },
56 { USB_DEVICE(0x05a3, 0x8388), .driver_info = MODEL_8388 },
57 {} /* Terminating entry */
60 MODULE_DEVICE_TABLE(usb, if_usb_table);
62 static void if_usb_receive(struct urb *urb);
63 static void if_usb_receive_fwload(struct urb *urb);
64 static void if_usb_prog_firmware(struct lbs_private *priv, int ret,
65 const struct firmware *fw,
66 const struct firmware *unused);
67 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
68 uint8_t *payload, uint16_t nb);
69 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
71 static void if_usb_free(struct if_usb_card *cardp);
72 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
73 static int if_usb_reset_device(struct if_usb_card *cardp);
76 * if_usb_write_bulk_callback - callback function to handle the status
78 * @urb: pointer to &urb structure
81 static void if_usb_write_bulk_callback(struct urb *urb)
83 struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
85 /* handle the transmission complete validations */
87 if (urb->status == 0) {
88 struct lbs_private *priv = cardp->priv;
90 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
91 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
94 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
95 * passed up to the lbs level.
97 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT)
98 lbs_host_to_card_done(priv);
100 /* print the failure status number for debug */
101 pr_info("URB in failure status: %d\n", urb->status);
106 * if_usb_free - free tx/rx urb, skb and rx buffer
107 * @cardp: pointer to &if_usb_card
110 static void if_usb_free(struct if_usb_card *cardp)
112 /* Unlink tx & rx urb */
113 usb_kill_urb(cardp->tx_urb);
114 usb_kill_urb(cardp->rx_urb);
116 usb_free_urb(cardp->tx_urb);
117 cardp->tx_urb = NULL;
119 usb_free_urb(cardp->rx_urb);
120 cardp->rx_urb = NULL;
122 kfree(cardp->ep_out_buf);
123 cardp->ep_out_buf = NULL;
126 static void if_usb_setup_firmware(struct lbs_private *priv)
128 struct if_usb_card *cardp = priv->card;
129 struct cmd_ds_set_boot2_ver b2_cmd;
130 struct cmd_ds_802_11_fw_wake_method wake_method;
132 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
134 b2_cmd.version = cardp->boot2_version;
136 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
137 lbs_deb_usb("Setting boot2 version failed\n");
139 priv->wol_gpio = 2; /* Wake via GPIO2... */
140 priv->wol_gap = 20; /* ... after 20ms */
141 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
142 (struct wol_config *) NULL);
144 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
145 wake_method.action = cpu_to_le16(CMD_ACT_GET);
146 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
147 netdev_info(priv->dev, "Firmware does not seem to support PS mode\n");
148 priv->fwcapinfo &= ~FW_CAPINFO_PS;
150 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
151 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
153 /* The versions which boot up this way don't seem to
154 work even if we set it to the command interrupt */
155 priv->fwcapinfo &= ~FW_CAPINFO_PS;
156 netdev_info(priv->dev,
157 "Firmware doesn't wake via command interrupt; disabling PS mode\n");
162 static void if_usb_fw_timeo(struct timer_list *t)
164 struct if_usb_card *cardp = from_timer(cardp, t, fw_timeout);
166 if (cardp->fwdnldover) {
167 lbs_deb_usb("Download complete, no event. Assuming success\n");
169 pr_err("Download timed out\n");
170 cardp->surprise_removed = 1;
172 wake_up(&cardp->fw_wq);
176 static void if_usb_reset_olpc_card(struct lbs_private *priv)
178 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
179 olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
184 * if_usb_probe - sets the configuration values
185 * @intf: &usb_interface pointer
186 * @id: pointer to usb_device_id
187 * returns: 0 on success, error code on failure
189 static int if_usb_probe(struct usb_interface *intf,
190 const struct usb_device_id *id)
192 struct usb_device *udev;
193 struct usb_host_interface *iface_desc;
194 struct usb_endpoint_descriptor *endpoint;
195 struct lbs_private *priv;
196 struct if_usb_card *cardp;
200 udev = interface_to_usbdev(intf);
202 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
206 timer_setup(&cardp->fw_timeout, if_usb_fw_timeo, 0);
207 init_waitqueue_head(&cardp->fw_wq);
210 cardp->model = (uint32_t) id->driver_info;
211 iface_desc = intf->cur_altsetting;
213 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
214 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
215 le16_to_cpu(udev->descriptor.bcdUSB),
216 udev->descriptor.bDeviceClass,
217 udev->descriptor.bDeviceSubClass,
218 udev->descriptor.bDeviceProtocol);
220 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
221 endpoint = &iface_desc->endpoint[i].desc;
222 if (usb_endpoint_is_bulk_in(endpoint)) {
223 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
224 cardp->ep_in = usb_endpoint_num(endpoint);
226 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
227 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
229 } else if (usb_endpoint_is_bulk_out(endpoint)) {
230 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
231 cardp->ep_out = usb_endpoint_num(endpoint);
233 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
234 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
237 if (!cardp->ep_out_size || !cardp->ep_in_size) {
238 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
241 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
242 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
245 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
246 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
249 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
250 if (!cardp->ep_out_buf) {
251 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
255 priv = lbs_add_card(cardp, &intf->dev);
263 priv->hw_host_to_card = if_usb_host_to_card;
264 priv->enter_deep_sleep = NULL;
265 priv->exit_deep_sleep = NULL;
266 priv->reset_deep_sleep_wakeup = NULL;
267 priv->is_polling = false;
269 if (machine_is_olpc())
270 priv->reset_card = if_usb_reset_olpc_card;
273 cardp->boot2_version = udev->descriptor.bcdDevice;
276 usb_set_intfdata(intf, cardp);
278 r = lbs_get_firmware_async(priv, &udev->dev, cardp->model,
279 fw_table, if_usb_prog_firmware);
286 lbs_remove_card(priv);
288 if_usb_reset_device(cardp);
298 * if_usb_disconnect - free resource and cleanup
299 * @intf: USB interface structure
302 static void if_usb_disconnect(struct usb_interface *intf)
304 struct if_usb_card *cardp = usb_get_intfdata(intf);
305 struct lbs_private *priv = cardp->priv;
307 cardp->surprise_removed = 1;
311 lbs_remove_card(priv);
314 /* Unlink and free urb */
318 usb_set_intfdata(intf, NULL);
319 usb_put_dev(interface_to_usbdev(intf));
323 * if_usb_send_fw_pkt - download FW
324 * @cardp: pointer to &struct if_usb_card
327 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
329 struct fwdata *fwdata = cardp->ep_out_buf;
330 const uint8_t *firmware = cardp->fw->data;
332 /* If we got a CRC failure on the last block, back
334 if (!cardp->CRC_OK) {
335 cardp->totalbytes = cardp->fwlastblksent;
339 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
342 /* struct fwdata (which we sent to the card) has an
343 extra __le32 field in between the header and the data,
344 which is not in the struct fwheader in the actual
345 firmware binary. Insert the seqnum in the middle... */
346 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
347 sizeof(struct fwheader));
349 cardp->fwlastblksent = cardp->totalbytes;
350 cardp->totalbytes += sizeof(struct fwheader);
352 memcpy(fwdata->data, &firmware[cardp->totalbytes],
353 le32_to_cpu(fwdata->hdr.datalength));
355 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
356 le32_to_cpu(fwdata->hdr.datalength));
358 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
359 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
361 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
362 le32_to_cpu(fwdata->hdr.datalength));
364 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
365 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
366 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
367 cardp->fwseqnum, cardp->totalbytes);
368 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
369 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
370 lbs_deb_usb2(&cardp->udev->dev, "Downloading FW JUMP BLOCK\n");
372 cardp->fwfinalblk = 1;
375 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
381 static int if_usb_reset_device(struct if_usb_card *cardp)
383 struct cmd_header *cmd = cardp->ep_out_buf + 4;
386 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
388 cmd->command = cpu_to_le16(CMD_802_11_RESET);
389 cmd->size = cpu_to_le16(sizeof(cmd));
390 cmd->result = cpu_to_le16(0);
391 cmd->seqnum = cpu_to_le16(0x5a5a);
392 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
395 ret = usb_reset_device(cardp->udev);
399 if (ret && machine_is_olpc())
400 if_usb_reset_olpc_card(NULL);
407 * usb_tx_block - transfer the data to the device
408 * @cardp: pointer to &struct if_usb_card
409 * @payload: pointer to payload data
411 * returns: 0 for success or negative error code
413 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
417 /* check if device is removed */
418 if (cardp->surprise_removed) {
419 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
424 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
425 usb_sndbulkpipe(cardp->udev,
427 payload, nb, if_usb_write_bulk_callback, cardp);
429 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
431 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
432 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
434 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
442 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
443 void (*callbackfn)(struct urb *urb))
448 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
449 pr_err("No free skb\n");
455 /* Fill the receive configuration URB and initialise the Rx call back */
456 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
457 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
458 skb->data + IPFIELD_ALIGN_OFFSET,
459 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
462 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
463 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
464 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
466 cardp->rx_skb = NULL;
469 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
477 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
479 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
482 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
484 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
487 static void if_usb_receive_fwload(struct urb *urb)
489 struct if_usb_card *cardp = urb->context;
490 struct sk_buff *skb = cardp->rx_skb;
491 struct fwsyncheader *syncfwheader;
492 struct bootcmdresp bootcmdresp;
495 lbs_deb_usbd(&cardp->udev->dev,
496 "URB status is failed during fw load\n");
501 if (cardp->fwdnldover) {
502 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
504 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
505 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
506 pr_info("Firmware ready event received\n");
507 wake_up(&cardp->fw_wq);
509 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
510 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
511 if_usb_submit_rx_urb_fwload(cardp);
516 if (cardp->bootcmdresp <= 0) {
517 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
518 sizeof(bootcmdresp));
520 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
522 if_usb_submit_rx_urb_fwload(cardp);
523 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
524 lbs_deb_usbd(&cardp->udev->dev,
525 "Received valid boot command response\n");
528 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
529 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
530 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
531 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
532 if (!cardp->bootcmdresp)
533 pr_info("Firmware already seems alive; resetting\n");
534 cardp->bootcmdresp = -1;
536 pr_info("boot cmd response wrong magic number (0x%x)\n",
537 le32_to_cpu(bootcmdresp.magic));
539 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
540 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
541 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
542 pr_info("boot cmd response cmd_tag error (%d)\n",
544 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
545 pr_info("boot cmd response result error (%d)\n",
548 cardp->bootcmdresp = 1;
549 lbs_deb_usbd(&cardp->udev->dev,
550 "Received valid boot command response\n");
553 if_usb_submit_rx_urb_fwload(cardp);
557 syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET,
558 sizeof(struct fwsyncheader), GFP_ATOMIC);
560 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
565 if (!syncfwheader->cmd) {
566 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
567 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
568 le32_to_cpu(syncfwheader->seqnum));
571 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
577 /* Give device 5s to either write firmware to its RAM or eeprom */
578 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
580 if (cardp->fwfinalblk) {
581 cardp->fwdnldover = 1;
585 if_usb_send_fw_pkt(cardp);
588 if_usb_submit_rx_urb_fwload(cardp);
593 #define MRVDRV_MIN_PKT_LEN 30
595 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
596 struct if_usb_card *cardp,
597 struct lbs_private *priv)
599 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
600 || recvlength < MRVDRV_MIN_PKT_LEN) {
601 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
606 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
607 skb_put(skb, recvlength);
608 skb_pull(skb, MESSAGE_HEADER_LEN);
610 lbs_process_rxed_packet(priv, skb);
613 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
615 struct if_usb_card *cardp,
616 struct lbs_private *priv)
621 if (recvlength > LBS_CMD_BUFFER_SIZE) {
622 lbs_deb_usbd(&cardp->udev->dev,
623 "The receive buffer is too large\n");
628 spin_lock_irqsave(&priv->driver_lock, flags);
630 i = (priv->resp_idx == 0) ? 1 : 0;
631 BUG_ON(priv->resp_len[i]);
632 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
633 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
636 lbs_notify_command_response(priv, i);
638 spin_unlock_irqrestore(&priv->driver_lock, flags);
640 lbs_deb_usbd(&cardp->udev->dev,
641 "Wake up main thread to handle cmd response\n");
645 * if_usb_receive - read the packet into the upload buffer,
646 * wake up the main thread and initialise the Rx callack
648 * @urb: pointer to &struct urb
651 static void if_usb_receive(struct urb *urb)
653 struct if_usb_card *cardp = urb->context;
654 struct sk_buff *skb = cardp->rx_skb;
655 struct lbs_private *priv = cardp->priv;
656 int recvlength = urb->actual_length;
657 uint8_t *recvbuff = NULL;
658 uint32_t recvtype = 0;
659 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
664 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
670 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
671 recvtype = le32_to_cpu(pkt[0]);
672 lbs_deb_usbd(&cardp->udev->dev,
673 "Recv length = 0x%x, Recv type = 0x%X\n",
674 recvlength, recvtype);
675 } else if (urb->status) {
682 process_cmdtypedata(recvlength, skb, cardp, priv);
685 case CMD_TYPE_REQUEST:
686 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
689 case CMD_TYPE_INDICATION:
691 event = le32_to_cpu(pkt[1]);
692 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
695 /* Icky undocumented magic special case */
696 if (event & 0xffff0000) {
697 u32 trycount = (event & 0xffff0000) >> 16;
699 lbs_send_tx_feedback(priv, trycount);
701 lbs_queue_event(priv, event & 0xFF);
705 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
712 if_usb_submit_rx_urb(cardp);
716 * if_usb_host_to_card - downloads data to FW
717 * @priv: pointer to &struct lbs_private structure
718 * @type: type of data
719 * @payload: pointer to data buffer
720 * @nb: number of bytes
721 * returns: 0 for success or negative error code
723 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
724 uint8_t *payload, uint16_t nb)
726 struct if_usb_card *cardp = priv->card;
728 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
729 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
731 if (type == MVMS_CMD) {
732 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
733 priv->dnld_sent = DNLD_CMD_SENT;
735 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
736 priv->dnld_sent = DNLD_DATA_SENT;
739 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
741 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
745 * if_usb_issue_boot_command - issues Boot command to the Boot2 code
746 * @cardp: pointer to &if_usb_card
747 * @ivalue: 1:Boot from FW by USB-Download
748 * 2:Boot from FW in EEPROM
749 * returns: 0 for success or negative error code
751 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
753 struct bootcmd *bootcmd = cardp->ep_out_buf;
755 /* Prepare command */
756 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
757 bootcmd->cmd = ivalue;
758 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
761 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
768 * check_fwfile_format - check the validity of Boot2/FW image
770 * @data: pointer to image
771 * @totlen: image length
772 * returns: 0 (good) or 1 (failure)
774 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
776 uint32_t bincmd, exit;
777 uint32_t blksize, offset, len;
784 struct fwheader *fwh = (void *)data;
786 bincmd = le32_to_cpu(fwh->dnldcmd);
787 blksize = le32_to_cpu(fwh->datalength);
789 case FW_HAS_DATA_TO_RECV:
790 offset = sizeof(struct fwheader) + blksize;
796 case FW_HAS_LAST_BLOCK:
807 pr_err("firmware file format check FAIL\n");
809 lbs_deb_fw("firmware file format check PASS\n");
814 static void if_usb_prog_firmware(struct lbs_private *priv, int ret,
815 const struct firmware *fw,
816 const struct firmware *unused)
818 struct if_usb_card *cardp = priv->card;
820 static int reset_count = 10;
823 pr_err("failed to find firmware (%d)\n", ret);
828 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
833 /* Cancel any pending usb business */
834 usb_kill_urb(cardp->rx_urb);
835 usb_kill_urb(cardp->tx_urb);
837 cardp->fwlastblksent = 0;
838 cardp->fwdnldover = 0;
839 cardp->totalbytes = 0;
840 cardp->fwfinalblk = 0;
841 cardp->bootcmdresp = 0;
844 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
845 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
850 cardp->bootcmdresp = 0;
854 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
855 /* wait for command response */
858 msleep_interruptible(100);
859 } while (cardp->bootcmdresp == 0 && j < 10);
860 } while (cardp->bootcmdresp == 0 && i < 5);
862 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
863 /* Return to normal operation */
865 usb_kill_urb(cardp->rx_urb);
866 usb_kill_urb(cardp->tx_urb);
867 if (if_usb_submit_rx_urb(cardp) < 0)
870 } else if (cardp->bootcmdresp <= 0) {
871 if (--reset_count >= 0) {
872 if_usb_reset_device(cardp);
881 cardp->totalbytes = 0;
882 cardp->fwlastblksent = 0;
884 cardp->fwdnldover = 0;
885 cardp->fwseqnum = -1;
886 cardp->totalbytes = 0;
887 cardp->fwfinalblk = 0;
889 /* Send the first firmware packet... */
890 if_usb_send_fw_pkt(cardp);
892 /* ... and wait for the process to complete */
893 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
895 del_timer_sync(&cardp->fw_timeout);
896 usb_kill_urb(cardp->rx_urb);
898 if (!cardp->fwdnldover) {
899 pr_info("failed to load fw, resetting device!\n");
900 if (--reset_count >= 0) {
901 if_usb_reset_device(cardp);
905 pr_info("FW download failure, time = %d ms\n", i * 100);
910 cardp->priv->fw_ready = 1;
911 if_usb_submit_rx_urb(cardp);
913 if (lbs_start_card(priv))
916 if_usb_setup_firmware(priv);
919 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware.
921 priv->wol_criteria = EHS_REMOVE_WAKEUP;
922 if (lbs_host_sleep_cfg(priv, priv->wol_criteria, NULL))
923 priv->ehs_remove_supported = false;
931 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
933 struct if_usb_card *cardp = usb_get_intfdata(intf);
934 struct lbs_private *priv = cardp->priv;
937 if (priv->psstate != PS_STATE_FULL_POWER) {
943 if (machine_is_olpc()) {
944 if (priv->wol_criteria == EHS_REMOVE_WAKEUP)
945 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN);
947 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN);
951 ret = lbs_suspend(priv);
955 /* Unlink tx & rx urb */
956 usb_kill_urb(cardp->tx_urb);
957 usb_kill_urb(cardp->rx_urb);
963 static int if_usb_resume(struct usb_interface *intf)
965 struct if_usb_card *cardp = usb_get_intfdata(intf);
966 struct lbs_private *priv = cardp->priv;
968 if_usb_submit_rx_urb(cardp);
975 #define if_usb_suspend NULL
976 #define if_usb_resume NULL
979 static struct usb_driver if_usb_driver = {
981 .probe = if_usb_probe,
982 .disconnect = if_usb_disconnect,
983 .id_table = if_usb_table,
984 .suspend = if_usb_suspend,
985 .resume = if_usb_resume,
986 .reset_resume = if_usb_resume,
987 .disable_hub_initiated_lpm = 1,
990 module_usb_driver(if_usb_driver);
992 MODULE_DESCRIPTION("8388 USB WLAN Driver");
993 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
994 MODULE_LICENSE("GPL");