2 * This file contains functions used in USB interface module.
5 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 #include <linux/delay.h>
8 #include <linux/module.h>
9 #include <linux/firmware.h>
10 #include <linux/netdevice.h>
11 #include <linux/slab.h>
12 #include <linux/usb.h>
13 #include <linux/olpc-ec.h>
19 #define DRV_NAME "usb8xxx"
29 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
31 #define MESSAGE_HEADER_LEN 4
41 /* table of firmware file names */
42 static const struct lbs_fw_table fw_table[] = {
43 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
44 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
45 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
46 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
47 { MODEL_8388, "/*(DEBLOBBED)*/", NULL },
48 { MODEL_8682, "/*(DEBLOBBED)*/", NULL },
52 static const struct usb_device_id if_usb_table[] = {
53 /* Enter the device signature inside */
54 { USB_DEVICE(0x1286, 0x2001), .driver_info = MODEL_8388 },
55 { USB_DEVICE(0x05a3, 0x8388), .driver_info = MODEL_8388 },
56 {} /* Terminating entry */
59 MODULE_DEVICE_TABLE(usb, if_usb_table);
61 static void if_usb_receive(struct urb *urb);
62 static void if_usb_receive_fwload(struct urb *urb);
63 static void if_usb_prog_firmware(struct lbs_private *priv, int ret,
64 const struct firmware *fw,
65 const struct firmware *unused);
66 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
67 uint8_t *payload, uint16_t nb);
68 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
70 static void if_usb_free(struct if_usb_card *cardp);
71 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
72 static int if_usb_reset_device(struct if_usb_card *cardp);
75 * if_usb_write_bulk_callback - callback function to handle the status
77 * @urb: pointer to &urb structure
80 static void if_usb_write_bulk_callback(struct urb *urb)
82 struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
84 /* handle the transmission complete validations */
86 if (urb->status == 0) {
87 struct lbs_private *priv = cardp->priv;
89 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
90 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
93 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
94 * passed up to the lbs level.
96 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT)
97 lbs_host_to_card_done(priv);
99 /* print the failure status number for debug */
100 pr_info("URB in failure status: %d\n", urb->status);
105 * if_usb_free - free tx/rx urb, skb and rx buffer
106 * @cardp: pointer to &if_usb_card
109 static void if_usb_free(struct if_usb_card *cardp)
111 /* Unlink tx & rx urb */
112 usb_kill_urb(cardp->tx_urb);
113 usb_kill_urb(cardp->rx_urb);
115 usb_free_urb(cardp->tx_urb);
116 cardp->tx_urb = NULL;
118 usb_free_urb(cardp->rx_urb);
119 cardp->rx_urb = NULL;
121 kfree(cardp->ep_out_buf);
122 cardp->ep_out_buf = NULL;
125 static void if_usb_setup_firmware(struct lbs_private *priv)
127 struct if_usb_card *cardp = priv->card;
128 struct cmd_ds_set_boot2_ver b2_cmd;
129 struct cmd_ds_802_11_fw_wake_method wake_method;
131 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
133 b2_cmd.version = cardp->boot2_version;
135 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
136 lbs_deb_usb("Setting boot2 version failed\n");
138 priv->wol_gpio = 2; /* Wake via GPIO2... */
139 priv->wol_gap = 20; /* ... after 20ms */
140 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
141 (struct wol_config *) NULL);
143 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
144 wake_method.action = cpu_to_le16(CMD_ACT_GET);
145 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
146 netdev_info(priv->dev, "Firmware does not seem to support PS mode\n");
147 priv->fwcapinfo &= ~FW_CAPINFO_PS;
149 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
150 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
152 /* The versions which boot up this way don't seem to
153 work even if we set it to the command interrupt */
154 priv->fwcapinfo &= ~FW_CAPINFO_PS;
155 netdev_info(priv->dev,
156 "Firmware doesn't wake via command interrupt; disabling PS mode\n");
161 static void if_usb_fw_timeo(unsigned long priv)
163 struct if_usb_card *cardp = (void *)priv;
165 if (cardp->fwdnldover) {
166 lbs_deb_usb("Download complete, no event. Assuming success\n");
168 pr_err("Download timed out\n");
169 cardp->surprise_removed = 1;
171 wake_up(&cardp->fw_wq);
175 static void if_usb_reset_olpc_card(struct lbs_private *priv)
177 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
178 olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
183 * if_usb_probe - sets the configuration values
184 * @intf: &usb_interface pointer
185 * @id: pointer to usb_device_id
186 * returns: 0 on success, error code on failure
188 static int if_usb_probe(struct usb_interface *intf,
189 const struct usb_device_id *id)
191 struct usb_device *udev;
192 struct usb_host_interface *iface_desc;
193 struct usb_endpoint_descriptor *endpoint;
194 struct lbs_private *priv;
195 struct if_usb_card *cardp;
199 udev = interface_to_usbdev(intf);
201 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
205 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
206 init_waitqueue_head(&cardp->fw_wq);
209 cardp->model = (uint32_t) id->driver_info;
210 iface_desc = intf->cur_altsetting;
212 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
213 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
214 le16_to_cpu(udev->descriptor.bcdUSB),
215 udev->descriptor.bDeviceClass,
216 udev->descriptor.bDeviceSubClass,
217 udev->descriptor.bDeviceProtocol);
219 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
220 endpoint = &iface_desc->endpoint[i].desc;
221 if (usb_endpoint_is_bulk_in(endpoint)) {
222 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
223 cardp->ep_in = usb_endpoint_num(endpoint);
225 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
226 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
228 } else if (usb_endpoint_is_bulk_out(endpoint)) {
229 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
230 cardp->ep_out = usb_endpoint_num(endpoint);
232 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
233 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
236 if (!cardp->ep_out_size || !cardp->ep_in_size) {
237 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
240 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
241 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
244 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
245 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
248 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
249 if (!cardp->ep_out_buf) {
250 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
254 if (!(priv = lbs_add_card(cardp, &intf->dev)))
259 priv->hw_host_to_card = if_usb_host_to_card;
260 priv->enter_deep_sleep = NULL;
261 priv->exit_deep_sleep = NULL;
262 priv->reset_deep_sleep_wakeup = NULL;
263 priv->is_polling = false;
265 if (machine_is_olpc())
266 priv->reset_card = if_usb_reset_olpc_card;
269 cardp->boot2_version = udev->descriptor.bcdDevice;
272 usb_set_intfdata(intf, cardp);
274 r = lbs_get_firmware_async(priv, &udev->dev, cardp->model,
275 fw_table, if_usb_prog_firmware);
282 lbs_remove_card(priv);
284 if_usb_reset_device(cardp);
293 * if_usb_disconnect - free resource and cleanup
294 * @intf: USB interface structure
297 static void if_usb_disconnect(struct usb_interface *intf)
299 struct if_usb_card *cardp = usb_get_intfdata(intf);
300 struct lbs_private *priv = cardp->priv;
302 cardp->surprise_removed = 1;
306 lbs_remove_card(priv);
309 /* Unlink and free urb */
312 usb_set_intfdata(intf, NULL);
313 usb_put_dev(interface_to_usbdev(intf));
317 * if_usb_send_fw_pkt - download FW
318 * @cardp: pointer to &struct if_usb_card
321 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
323 struct fwdata *fwdata = cardp->ep_out_buf;
324 const uint8_t *firmware = cardp->fw->data;
326 /* If we got a CRC failure on the last block, back
328 if (!cardp->CRC_OK) {
329 cardp->totalbytes = cardp->fwlastblksent;
333 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
336 /* struct fwdata (which we sent to the card) has an
337 extra __le32 field in between the header and the data,
338 which is not in the struct fwheader in the actual
339 firmware binary. Insert the seqnum in the middle... */
340 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
341 sizeof(struct fwheader));
343 cardp->fwlastblksent = cardp->totalbytes;
344 cardp->totalbytes += sizeof(struct fwheader);
346 memcpy(fwdata->data, &firmware[cardp->totalbytes],
347 le32_to_cpu(fwdata->hdr.datalength));
349 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
350 le32_to_cpu(fwdata->hdr.datalength));
352 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
353 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
355 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
356 le32_to_cpu(fwdata->hdr.datalength));
358 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
359 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
360 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
361 cardp->fwseqnum, cardp->totalbytes);
362 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
363 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
364 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
366 cardp->fwfinalblk = 1;
369 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
375 static int if_usb_reset_device(struct if_usb_card *cardp)
377 struct cmd_header *cmd = cardp->ep_out_buf + 4;
380 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
382 cmd->command = cpu_to_le16(CMD_802_11_RESET);
383 cmd->size = cpu_to_le16(sizeof(cmd));
384 cmd->result = cpu_to_le16(0);
385 cmd->seqnum = cpu_to_le16(0x5a5a);
386 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
389 ret = usb_reset_device(cardp->udev);
393 if (ret && machine_is_olpc())
394 if_usb_reset_olpc_card(NULL);
401 * usb_tx_block - transfer the data to the device
402 * @cardp: pointer to &struct if_usb_card
403 * @payload: pointer to payload data
405 * returns: 0 for success or negative error code
407 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
411 /* check if device is removed */
412 if (cardp->surprise_removed) {
413 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
418 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
419 usb_sndbulkpipe(cardp->udev,
421 payload, nb, if_usb_write_bulk_callback, cardp);
423 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
425 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
426 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
428 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
436 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
437 void (*callbackfn)(struct urb *urb))
442 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
443 pr_err("No free skb\n");
449 /* Fill the receive configuration URB and initialise the Rx call back */
450 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
451 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
452 skb->data + IPFIELD_ALIGN_OFFSET,
453 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
456 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
457 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
458 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
460 cardp->rx_skb = NULL;
463 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
471 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
473 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
476 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
478 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
481 static void if_usb_receive_fwload(struct urb *urb)
483 struct if_usb_card *cardp = urb->context;
484 struct sk_buff *skb = cardp->rx_skb;
485 struct fwsyncheader *syncfwheader;
486 struct bootcmdresp bootcmdresp;
489 lbs_deb_usbd(&cardp->udev->dev,
490 "URB status is failed during fw load\n");
495 if (cardp->fwdnldover) {
496 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
498 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
499 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
500 pr_info("Firmware ready event received\n");
501 wake_up(&cardp->fw_wq);
503 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
504 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
505 if_usb_submit_rx_urb_fwload(cardp);
510 if (cardp->bootcmdresp <= 0) {
511 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
512 sizeof(bootcmdresp));
514 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
516 if_usb_submit_rx_urb_fwload(cardp);
517 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
518 lbs_deb_usbd(&cardp->udev->dev,
519 "Received valid boot command response\n");
522 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
523 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
524 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
525 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
526 if (!cardp->bootcmdresp)
527 pr_info("Firmware already seems alive; resetting\n");
528 cardp->bootcmdresp = -1;
530 pr_info("boot cmd response wrong magic number (0x%x)\n",
531 le32_to_cpu(bootcmdresp.magic));
533 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
534 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
535 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
536 pr_info("boot cmd response cmd_tag error (%d)\n",
538 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
539 pr_info("boot cmd response result error (%d)\n",
542 cardp->bootcmdresp = 1;
543 lbs_deb_usbd(&cardp->udev->dev,
544 "Received valid boot command response\n");
547 if_usb_submit_rx_urb_fwload(cardp);
551 syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET,
552 sizeof(struct fwsyncheader), GFP_ATOMIC);
554 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
559 if (!syncfwheader->cmd) {
560 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
561 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
562 le32_to_cpu(syncfwheader->seqnum));
565 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
571 /* Give device 5s to either write firmware to its RAM or eeprom */
572 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
574 if (cardp->fwfinalblk) {
575 cardp->fwdnldover = 1;
579 if_usb_send_fw_pkt(cardp);
582 if_usb_submit_rx_urb_fwload(cardp);
587 #define MRVDRV_MIN_PKT_LEN 30
589 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
590 struct if_usb_card *cardp,
591 struct lbs_private *priv)
593 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
594 || recvlength < MRVDRV_MIN_PKT_LEN) {
595 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
600 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
601 skb_put(skb, recvlength);
602 skb_pull(skb, MESSAGE_HEADER_LEN);
604 lbs_process_rxed_packet(priv, skb);
607 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
609 struct if_usb_card *cardp,
610 struct lbs_private *priv)
614 if (recvlength > LBS_CMD_BUFFER_SIZE) {
615 lbs_deb_usbd(&cardp->udev->dev,
616 "The receive buffer is too large\n");
621 BUG_ON(!in_interrupt());
623 spin_lock(&priv->driver_lock);
625 i = (priv->resp_idx == 0) ? 1 : 0;
626 BUG_ON(priv->resp_len[i]);
627 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
628 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
631 lbs_notify_command_response(priv, i);
633 spin_unlock(&priv->driver_lock);
635 lbs_deb_usbd(&cardp->udev->dev,
636 "Wake up main thread to handle cmd response\n");
640 * if_usb_receive - read the packet into the upload buffer,
641 * wake up the main thread and initialise the Rx callack
643 * @urb: pointer to &struct urb
646 static void if_usb_receive(struct urb *urb)
648 struct if_usb_card *cardp = urb->context;
649 struct sk_buff *skb = cardp->rx_skb;
650 struct lbs_private *priv = cardp->priv;
651 int recvlength = urb->actual_length;
652 uint8_t *recvbuff = NULL;
653 uint32_t recvtype = 0;
654 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
659 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
665 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
666 recvtype = le32_to_cpu(pkt[0]);
667 lbs_deb_usbd(&cardp->udev->dev,
668 "Recv length = 0x%x, Recv type = 0x%X\n",
669 recvlength, recvtype);
670 } else if (urb->status) {
677 process_cmdtypedata(recvlength, skb, cardp, priv);
680 case CMD_TYPE_REQUEST:
681 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
684 case CMD_TYPE_INDICATION:
686 event = le32_to_cpu(pkt[1]);
687 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
690 /* Icky undocumented magic special case */
691 if (event & 0xffff0000) {
692 u32 trycount = (event & 0xffff0000) >> 16;
694 lbs_send_tx_feedback(priv, trycount);
696 lbs_queue_event(priv, event & 0xFF);
700 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
707 if_usb_submit_rx_urb(cardp);
711 * if_usb_host_to_card - downloads data to FW
712 * @priv: pointer to &struct lbs_private structure
713 * @type: type of data
714 * @payload: pointer to data buffer
715 * @nb: number of bytes
716 * returns: 0 for success or negative error code
718 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
719 uint8_t *payload, uint16_t nb)
721 struct if_usb_card *cardp = priv->card;
723 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
724 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
726 if (type == MVMS_CMD) {
727 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
728 priv->dnld_sent = DNLD_CMD_SENT;
730 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
731 priv->dnld_sent = DNLD_DATA_SENT;
734 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
736 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
740 * if_usb_issue_boot_command - issues Boot command to the Boot2 code
741 * @cardp: pointer to &if_usb_card
742 * @ivalue: 1:Boot from FW by USB-Download
743 * 2:Boot from FW in EEPROM
744 * returns: 0 for success or negative error code
746 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
748 struct bootcmd *bootcmd = cardp->ep_out_buf;
750 /* Prepare command */
751 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
752 bootcmd->cmd = ivalue;
753 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
756 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
763 * check_fwfile_format - check the validity of Boot2/FW image
765 * @data: pointer to image
766 * @totlen: image length
767 * returns: 0 (good) or 1 (failure)
769 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
771 uint32_t bincmd, exit;
772 uint32_t blksize, offset, len;
779 struct fwheader *fwh = (void *)data;
781 bincmd = le32_to_cpu(fwh->dnldcmd);
782 blksize = le32_to_cpu(fwh->datalength);
784 case FW_HAS_DATA_TO_RECV:
785 offset = sizeof(struct fwheader) + blksize;
791 case FW_HAS_LAST_BLOCK:
802 pr_err("firmware file format check FAIL\n");
804 lbs_deb_fw("firmware file format check PASS\n");
809 static void if_usb_prog_firmware(struct lbs_private *priv, int ret,
810 const struct firmware *fw,
811 const struct firmware *unused)
813 struct if_usb_card *cardp = priv->card;
815 static int reset_count = 10;
818 pr_err("failed to find firmware (%d)\n", ret);
823 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
828 /* Cancel any pending usb business */
829 usb_kill_urb(cardp->rx_urb);
830 usb_kill_urb(cardp->tx_urb);
832 cardp->fwlastblksent = 0;
833 cardp->fwdnldover = 0;
834 cardp->totalbytes = 0;
835 cardp->fwfinalblk = 0;
836 cardp->bootcmdresp = 0;
839 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
840 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
845 cardp->bootcmdresp = 0;
849 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
850 /* wait for command response */
853 msleep_interruptible(100);
854 } while (cardp->bootcmdresp == 0 && j < 10);
855 } while (cardp->bootcmdresp == 0 && i < 5);
857 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
858 /* Return to normal operation */
860 usb_kill_urb(cardp->rx_urb);
861 usb_kill_urb(cardp->tx_urb);
862 if (if_usb_submit_rx_urb(cardp) < 0)
865 } else if (cardp->bootcmdresp <= 0) {
866 if (--reset_count >= 0) {
867 if_usb_reset_device(cardp);
876 cardp->totalbytes = 0;
877 cardp->fwlastblksent = 0;
879 cardp->fwdnldover = 0;
880 cardp->fwseqnum = -1;
881 cardp->totalbytes = 0;
882 cardp->fwfinalblk = 0;
884 /* Send the first firmware packet... */
885 if_usb_send_fw_pkt(cardp);
887 /* ... and wait for the process to complete */
888 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
890 del_timer_sync(&cardp->fw_timeout);
891 usb_kill_urb(cardp->rx_urb);
893 if (!cardp->fwdnldover) {
894 pr_info("failed to load fw, resetting device!\n");
895 if (--reset_count >= 0) {
896 if_usb_reset_device(cardp);
900 pr_info("FW download failure, time = %d ms\n", i * 100);
905 cardp->priv->fw_ready = 1;
906 if_usb_submit_rx_urb(cardp);
908 if (lbs_start_card(priv))
911 if_usb_setup_firmware(priv);
914 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware.
916 priv->wol_criteria = EHS_REMOVE_WAKEUP;
917 if (lbs_host_sleep_cfg(priv, priv->wol_criteria, NULL))
918 priv->ehs_remove_supported = false;
926 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
928 struct if_usb_card *cardp = usb_get_intfdata(intf);
929 struct lbs_private *priv = cardp->priv;
932 if (priv->psstate != PS_STATE_FULL_POWER) {
938 if (machine_is_olpc()) {
939 if (priv->wol_criteria == EHS_REMOVE_WAKEUP)
940 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN);
942 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN);
946 ret = lbs_suspend(priv);
950 /* Unlink tx & rx urb */
951 usb_kill_urb(cardp->tx_urb);
952 usb_kill_urb(cardp->rx_urb);
958 static int if_usb_resume(struct usb_interface *intf)
960 struct if_usb_card *cardp = usb_get_intfdata(intf);
961 struct lbs_private *priv = cardp->priv;
963 if_usb_submit_rx_urb(cardp);
970 #define if_usb_suspend NULL
971 #define if_usb_resume NULL
974 static struct usb_driver if_usb_driver = {
976 .probe = if_usb_probe,
977 .disconnect = if_usb_disconnect,
978 .id_table = if_usb_table,
979 .suspend = if_usb_suspend,
980 .resume = if_usb_resume,
981 .reset_resume = if_usb_resume,
982 .disable_hub_initiated_lpm = 1,
985 module_usb_driver(if_usb_driver);
987 MODULE_DESCRIPTION("8388 USB WLAN Driver");
988 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
989 MODULE_LICENSE("GPL");