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 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 lbs_deb_enter(LBS_DEB_USB);
113 /* Unlink tx & rx urb */
114 usb_kill_urb(cardp->tx_urb);
115 usb_kill_urb(cardp->rx_urb);
117 usb_free_urb(cardp->tx_urb);
118 cardp->tx_urb = NULL;
120 usb_free_urb(cardp->rx_urb);
121 cardp->rx_urb = NULL;
123 kfree(cardp->ep_out_buf);
124 cardp->ep_out_buf = NULL;
126 lbs_deb_leave(LBS_DEB_USB);
129 static void if_usb_setup_firmware(struct lbs_private *priv)
131 struct if_usb_card *cardp = priv->card;
132 struct cmd_ds_set_boot2_ver b2_cmd;
133 struct cmd_ds_802_11_fw_wake_method wake_method;
135 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
137 b2_cmd.version = cardp->boot2_version;
139 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
140 lbs_deb_usb("Setting boot2 version failed\n");
142 priv->wol_gpio = 2; /* Wake via GPIO2... */
143 priv->wol_gap = 20; /* ... after 20ms */
144 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
145 (struct wol_config *) NULL);
147 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
148 wake_method.action = cpu_to_le16(CMD_ACT_GET);
149 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
150 netdev_info(priv->dev, "Firmware does not seem to support PS mode\n");
151 priv->fwcapinfo &= ~FW_CAPINFO_PS;
153 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
154 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
156 /* The versions which boot up this way don't seem to
157 work even if we set it to the command interrupt */
158 priv->fwcapinfo &= ~FW_CAPINFO_PS;
159 netdev_info(priv->dev,
160 "Firmware doesn't wake via command interrupt; disabling PS mode\n");
165 static void if_usb_fw_timeo(unsigned long priv)
167 struct if_usb_card *cardp = (void *)priv;
169 if (cardp->fwdnldover) {
170 lbs_deb_usb("Download complete, no event. Assuming success\n");
172 pr_err("Download timed out\n");
173 cardp->surprise_removed = 1;
175 wake_up(&cardp->fw_wq);
179 static void if_usb_reset_olpc_card(struct lbs_private *priv)
181 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
182 olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
187 * if_usb_probe - sets the configuration values
188 * @intf: &usb_interface pointer
189 * @id: pointer to usb_device_id
190 * returns: 0 on success, error code on failure
192 static int if_usb_probe(struct usb_interface *intf,
193 const struct usb_device_id *id)
195 struct usb_device *udev;
196 struct usb_host_interface *iface_desc;
197 struct usb_endpoint_descriptor *endpoint;
198 struct lbs_private *priv;
199 struct if_usb_card *cardp;
203 udev = interface_to_usbdev(intf);
205 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
209 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
210 init_waitqueue_head(&cardp->fw_wq);
213 cardp->model = (uint32_t) id->driver_info;
214 iface_desc = intf->cur_altsetting;
216 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
217 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
218 le16_to_cpu(udev->descriptor.bcdUSB),
219 udev->descriptor.bDeviceClass,
220 udev->descriptor.bDeviceSubClass,
221 udev->descriptor.bDeviceProtocol);
223 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
224 endpoint = &iface_desc->endpoint[i].desc;
225 if (usb_endpoint_is_bulk_in(endpoint)) {
226 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
227 cardp->ep_in = usb_endpoint_num(endpoint);
229 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
230 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
232 } else if (usb_endpoint_is_bulk_out(endpoint)) {
233 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
234 cardp->ep_out = usb_endpoint_num(endpoint);
236 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
237 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
240 if (!cardp->ep_out_size || !cardp->ep_in_size) {
241 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
244 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
245 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
248 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
249 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
252 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
253 if (!cardp->ep_out_buf) {
254 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
258 if (!(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 lbs_deb_enter(LBS_DEB_MAIN);
309 cardp->surprise_removed = 1;
313 lbs_remove_card(priv);
316 /* Unlink and free urb */
320 usb_set_intfdata(intf, NULL);
321 usb_put_dev(interface_to_usbdev(intf));
323 lbs_deb_leave(LBS_DEB_MAIN);
327 * if_usb_send_fw_pkt - download FW
328 * @cardp: pointer to &struct if_usb_card
331 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
333 struct fwdata *fwdata = cardp->ep_out_buf;
334 const uint8_t *firmware = cardp->fw->data;
336 /* If we got a CRC failure on the last block, back
338 if (!cardp->CRC_OK) {
339 cardp->totalbytes = cardp->fwlastblksent;
343 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
346 /* struct fwdata (which we sent to the card) has an
347 extra __le32 field in between the header and the data,
348 which is not in the struct fwheader in the actual
349 firmware binary. Insert the seqnum in the middle... */
350 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
351 sizeof(struct fwheader));
353 cardp->fwlastblksent = cardp->totalbytes;
354 cardp->totalbytes += sizeof(struct fwheader);
356 memcpy(fwdata->data, &firmware[cardp->totalbytes],
357 le32_to_cpu(fwdata->hdr.datalength));
359 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
360 le32_to_cpu(fwdata->hdr.datalength));
362 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
363 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
365 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
366 le32_to_cpu(fwdata->hdr.datalength));
368 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
369 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
370 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
371 cardp->fwseqnum, cardp->totalbytes);
372 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
373 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
374 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
376 cardp->fwfinalblk = 1;
379 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
385 static int if_usb_reset_device(struct if_usb_card *cardp)
387 struct cmd_header *cmd = cardp->ep_out_buf + 4;
390 lbs_deb_enter(LBS_DEB_USB);
392 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
394 cmd->command = cpu_to_le16(CMD_802_11_RESET);
395 cmd->size = cpu_to_le16(sizeof(cmd));
396 cmd->result = cpu_to_le16(0);
397 cmd->seqnum = cpu_to_le16(0x5a5a);
398 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
401 ret = usb_reset_device(cardp->udev);
405 if (ret && machine_is_olpc())
406 if_usb_reset_olpc_card(NULL);
409 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
415 * usb_tx_block - transfer the data to the device
416 * @cardp: pointer to &struct if_usb_card
417 * @payload: pointer to payload data
419 * returns: 0 for success or negative error code
421 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
425 /* check if device is removed */
426 if (cardp->surprise_removed) {
427 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
432 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
433 usb_sndbulkpipe(cardp->udev,
435 payload, nb, if_usb_write_bulk_callback, cardp);
437 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
439 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
440 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
442 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
450 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
451 void (*callbackfn)(struct urb *urb))
456 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
457 pr_err("No free skb\n");
463 /* Fill the receive configuration URB and initialise the Rx call back */
464 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
465 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
466 skb->data + IPFIELD_ALIGN_OFFSET,
467 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
470 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
471 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
472 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
474 cardp->rx_skb = NULL;
477 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
485 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
487 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
490 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
492 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
495 static void if_usb_receive_fwload(struct urb *urb)
497 struct if_usb_card *cardp = urb->context;
498 struct sk_buff *skb = cardp->rx_skb;
499 struct fwsyncheader *syncfwheader;
500 struct bootcmdresp bootcmdresp;
503 lbs_deb_usbd(&cardp->udev->dev,
504 "URB status is failed during fw load\n");
509 if (cardp->fwdnldover) {
510 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
512 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
513 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
514 pr_info("Firmware ready event received\n");
515 wake_up(&cardp->fw_wq);
517 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
518 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
519 if_usb_submit_rx_urb_fwload(cardp);
524 if (cardp->bootcmdresp <= 0) {
525 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
526 sizeof(bootcmdresp));
528 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
530 if_usb_submit_rx_urb_fwload(cardp);
531 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
532 lbs_deb_usbd(&cardp->udev->dev,
533 "Received valid boot command response\n");
536 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
537 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
538 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
539 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
540 if (!cardp->bootcmdresp)
541 pr_info("Firmware already seems alive; resetting\n");
542 cardp->bootcmdresp = -1;
544 pr_info("boot cmd response wrong magic number (0x%x)\n",
545 le32_to_cpu(bootcmdresp.magic));
547 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
548 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
549 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
550 pr_info("boot cmd response cmd_tag error (%d)\n",
552 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
553 pr_info("boot cmd response result error (%d)\n",
556 cardp->bootcmdresp = 1;
557 lbs_deb_usbd(&cardp->udev->dev,
558 "Received valid boot command response\n");
561 if_usb_submit_rx_urb_fwload(cardp);
565 syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET,
566 sizeof(struct fwsyncheader), GFP_ATOMIC);
568 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
573 if (!syncfwheader->cmd) {
574 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
575 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
576 le32_to_cpu(syncfwheader->seqnum));
579 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
585 /* Give device 5s to either write firmware to its RAM or eeprom */
586 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
588 if (cardp->fwfinalblk) {
589 cardp->fwdnldover = 1;
593 if_usb_send_fw_pkt(cardp);
596 if_usb_submit_rx_urb_fwload(cardp);
601 #define MRVDRV_MIN_PKT_LEN 30
603 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
604 struct if_usb_card *cardp,
605 struct lbs_private *priv)
607 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
608 || recvlength < MRVDRV_MIN_PKT_LEN) {
609 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
614 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
615 skb_put(skb, recvlength);
616 skb_pull(skb, MESSAGE_HEADER_LEN);
618 lbs_process_rxed_packet(priv, skb);
621 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
623 struct if_usb_card *cardp,
624 struct lbs_private *priv)
628 if (recvlength > LBS_CMD_BUFFER_SIZE) {
629 lbs_deb_usbd(&cardp->udev->dev,
630 "The receive buffer is too large\n");
635 BUG_ON(!in_interrupt());
637 spin_lock(&priv->driver_lock);
639 i = (priv->resp_idx == 0) ? 1 : 0;
640 BUG_ON(priv->resp_len[i]);
641 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
642 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
645 lbs_notify_command_response(priv, i);
647 spin_unlock(&priv->driver_lock);
649 lbs_deb_usbd(&cardp->udev->dev,
650 "Wake up main thread to handle cmd response\n");
654 * if_usb_receive - read the packet into the upload buffer,
655 * wake up the main thread and initialise the Rx callack
657 * @urb: pointer to &struct urb
660 static void if_usb_receive(struct urb *urb)
662 struct if_usb_card *cardp = urb->context;
663 struct sk_buff *skb = cardp->rx_skb;
664 struct lbs_private *priv = cardp->priv;
665 int recvlength = urb->actual_length;
666 uint8_t *recvbuff = NULL;
667 uint32_t recvtype = 0;
668 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
671 lbs_deb_enter(LBS_DEB_USB);
675 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
681 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
682 recvtype = le32_to_cpu(pkt[0]);
683 lbs_deb_usbd(&cardp->udev->dev,
684 "Recv length = 0x%x, Recv type = 0x%X\n",
685 recvlength, recvtype);
686 } else if (urb->status) {
693 process_cmdtypedata(recvlength, skb, cardp, priv);
696 case CMD_TYPE_REQUEST:
697 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
700 case CMD_TYPE_INDICATION:
702 event = le32_to_cpu(pkt[1]);
703 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
706 /* Icky undocumented magic special case */
707 if (event & 0xffff0000) {
708 u32 trycount = (event & 0xffff0000) >> 16;
710 lbs_send_tx_feedback(priv, trycount);
712 lbs_queue_event(priv, event & 0xFF);
716 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
723 if_usb_submit_rx_urb(cardp);
725 lbs_deb_leave(LBS_DEB_USB);
729 * if_usb_host_to_card - downloads data to FW
730 * @priv: pointer to &struct lbs_private structure
731 * @type: type of data
732 * @payload: pointer to data buffer
733 * @nb: number of bytes
734 * returns: 0 for success or negative error code
736 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
737 uint8_t *payload, uint16_t nb)
739 struct if_usb_card *cardp = priv->card;
741 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
742 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
744 if (type == MVMS_CMD) {
745 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
746 priv->dnld_sent = DNLD_CMD_SENT;
748 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
749 priv->dnld_sent = DNLD_DATA_SENT;
752 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
754 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
758 * if_usb_issue_boot_command - issues Boot command to the Boot2 code
759 * @cardp: pointer to &if_usb_card
760 * @ivalue: 1:Boot from FW by USB-Download
761 * 2:Boot from FW in EEPROM
762 * returns: 0 for success or negative error code
764 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
766 struct bootcmd *bootcmd = cardp->ep_out_buf;
768 /* Prepare command */
769 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
770 bootcmd->cmd = ivalue;
771 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
774 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
781 * check_fwfile_format - check the validity of Boot2/FW image
783 * @data: pointer to image
784 * @totlen: image length
785 * returns: 0 (good) or 1 (failure)
787 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
789 uint32_t bincmd, exit;
790 uint32_t blksize, offset, len;
797 struct fwheader *fwh = (void *)data;
799 bincmd = le32_to_cpu(fwh->dnldcmd);
800 blksize = le32_to_cpu(fwh->datalength);
802 case FW_HAS_DATA_TO_RECV:
803 offset = sizeof(struct fwheader) + blksize;
809 case FW_HAS_LAST_BLOCK:
820 pr_err("firmware file format check FAIL\n");
822 lbs_deb_fw("firmware file format check PASS\n");
827 static void if_usb_prog_firmware(struct lbs_private *priv, int ret,
828 const struct firmware *fw,
829 const struct firmware *unused)
831 struct if_usb_card *cardp = priv->card;
833 static int reset_count = 10;
835 lbs_deb_enter(LBS_DEB_USB);
838 pr_err("failed to find firmware (%d)\n", ret);
843 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
848 /* Cancel any pending usb business */
849 usb_kill_urb(cardp->rx_urb);
850 usb_kill_urb(cardp->tx_urb);
852 cardp->fwlastblksent = 0;
853 cardp->fwdnldover = 0;
854 cardp->totalbytes = 0;
855 cardp->fwfinalblk = 0;
856 cardp->bootcmdresp = 0;
859 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
860 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
865 cardp->bootcmdresp = 0;
869 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
870 /* wait for command response */
873 msleep_interruptible(100);
874 } while (cardp->bootcmdresp == 0 && j < 10);
875 } while (cardp->bootcmdresp == 0 && i < 5);
877 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
878 /* Return to normal operation */
880 usb_kill_urb(cardp->rx_urb);
881 usb_kill_urb(cardp->tx_urb);
882 if (if_usb_submit_rx_urb(cardp) < 0)
885 } else if (cardp->bootcmdresp <= 0) {
886 if (--reset_count >= 0) {
887 if_usb_reset_device(cardp);
896 cardp->totalbytes = 0;
897 cardp->fwlastblksent = 0;
899 cardp->fwdnldover = 0;
900 cardp->fwseqnum = -1;
901 cardp->totalbytes = 0;
902 cardp->fwfinalblk = 0;
904 /* Send the first firmware packet... */
905 if_usb_send_fw_pkt(cardp);
907 /* ... and wait for the process to complete */
908 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
910 del_timer_sync(&cardp->fw_timeout);
911 usb_kill_urb(cardp->rx_urb);
913 if (!cardp->fwdnldover) {
914 pr_info("failed to load fw, resetting device!\n");
915 if (--reset_count >= 0) {
916 if_usb_reset_device(cardp);
920 pr_info("FW download failure, time = %d ms\n", i * 100);
925 cardp->priv->fw_ready = 1;
926 if_usb_submit_rx_urb(cardp);
928 if (lbs_start_card(priv))
931 if_usb_setup_firmware(priv);
934 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware.
936 priv->wol_criteria = EHS_REMOVE_WAKEUP;
937 if (lbs_host_sleep_cfg(priv, priv->wol_criteria, NULL))
938 priv->ehs_remove_supported = false;
942 lbs_deb_leave(LBS_DEB_USB);
947 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
949 struct if_usb_card *cardp = usb_get_intfdata(intf);
950 struct lbs_private *priv = cardp->priv;
953 lbs_deb_enter(LBS_DEB_USB);
955 if (priv->psstate != PS_STATE_FULL_POWER) {
961 if (machine_is_olpc()) {
962 if (priv->wol_criteria == EHS_REMOVE_WAKEUP)
963 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN);
965 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN);
969 ret = lbs_suspend(priv);
973 /* Unlink tx & rx urb */
974 usb_kill_urb(cardp->tx_urb);
975 usb_kill_urb(cardp->rx_urb);
978 lbs_deb_leave(LBS_DEB_USB);
982 static int if_usb_resume(struct usb_interface *intf)
984 struct if_usb_card *cardp = usb_get_intfdata(intf);
985 struct lbs_private *priv = cardp->priv;
987 lbs_deb_enter(LBS_DEB_USB);
989 if_usb_submit_rx_urb(cardp);
993 lbs_deb_leave(LBS_DEB_USB);
997 #define if_usb_suspend NULL
998 #define if_usb_resume NULL
1001 static struct usb_driver if_usb_driver = {
1003 .probe = if_usb_probe,
1004 .disconnect = if_usb_disconnect,
1005 .id_table = if_usb_table,
1006 .suspend = if_usb_suspend,
1007 .resume = if_usb_resume,
1008 .reset_resume = if_usb_resume,
1009 .disable_hub_initiated_lpm = 1,
1012 module_usb_driver(if_usb_driver);
1014 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1015 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1016 MODULE_LICENSE("GPL");