2 * This file contains functions used in USB interface module.
4 #include <linux/delay.h>
5 #include <linux/moduleparam.h>
6 #include <linux/firmware.h>
7 #include <linux/netdevice.h>
14 #define DRV_NAME "usb8xxx"
24 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
26 #define MESSAGE_HEADER_LEN 4
28 static char *lbs_fw_name = "usb8388.bin";
29 module_param_named(fw_name, lbs_fw_name, charp, 0644);
31 MODULE_FIRMWARE("usb8388.bin");
33 static struct usb_device_id if_usb_table[] = {
34 /* Enter the device signature inside */
35 { USB_DEVICE(0x1286, 0x2001) },
36 { USB_DEVICE(0x05a3, 0x8388) },
37 {} /* Terminating entry */
40 MODULE_DEVICE_TABLE(usb, if_usb_table);
42 static void if_usb_receive(struct urb *urb);
43 static void if_usb_receive_fwload(struct urb *urb);
44 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
45 const char *fwname, int cmd);
46 static int if_usb_prog_firmware(struct if_usb_card *cardp,
47 const char *fwname, int cmd);
48 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
49 uint8_t *payload, uint16_t nb);
50 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
52 static void if_usb_free(struct if_usb_card *cardp);
53 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
54 static int if_usb_reset_device(struct if_usb_card *cardp);
59 * Set function to write firmware to device's persistent memory
61 static ssize_t if_usb_firmware_set(struct device *dev,
62 struct device_attribute *attr, const char *buf, size_t count)
64 struct lbs_private *priv = to_net_dev(dev)->ml_priv;
65 struct if_usb_card *cardp = priv->card;
68 ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_FW);
76 * lbs_flash_fw attribute to be exported per ethX interface through sysfs
77 * (/sys/class/net/ethX/lbs_flash_fw). Use this like so to write firmware to
78 * the device's persistent memory:
79 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_fw
81 static DEVICE_ATTR(lbs_flash_fw, 0200, NULL, if_usb_firmware_set);
84 * Set function to write firmware to device's persistent memory
86 static ssize_t if_usb_boot2_set(struct device *dev,
87 struct device_attribute *attr, const char *buf, size_t count)
89 struct lbs_private *priv = to_net_dev(dev)->ml_priv;
90 struct if_usb_card *cardp = priv->card;
93 ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_BOOT2);
101 * lbs_flash_boot2 attribute to be exported per ethX interface through sysfs
102 * (/sys/class/net/ethX/lbs_flash_boot2). Use this like so to write firmware
103 * to the device's persistent memory:
104 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_boot2
106 static DEVICE_ATTR(lbs_flash_boot2, 0200, NULL, if_usb_boot2_set);
109 * @brief call back function to handle the status of the URB
110 * @param urb pointer to urb structure
113 static void if_usb_write_bulk_callback(struct urb *urb)
115 struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
117 /* handle the transmission complete validations */
119 if (urb->status == 0) {
120 struct lbs_private *priv = cardp->priv;
122 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
123 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
126 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
127 * passed up to the lbs level.
129 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT)
130 lbs_host_to_card_done(priv);
132 /* print the failure status number for debug */
133 lbs_pr_info("URB in failure status: %d\n", urb->status);
140 * @brief free tx/rx urb, skb and rx buffer
141 * @param cardp pointer if_usb_card
144 static void if_usb_free(struct if_usb_card *cardp)
146 lbs_deb_enter(LBS_DEB_USB);
148 /* Unlink tx & rx urb */
149 usb_kill_urb(cardp->tx_urb);
150 usb_kill_urb(cardp->rx_urb);
152 usb_free_urb(cardp->tx_urb);
153 cardp->tx_urb = NULL;
155 usb_free_urb(cardp->rx_urb);
156 cardp->rx_urb = NULL;
158 kfree(cardp->ep_out_buf);
159 cardp->ep_out_buf = NULL;
161 lbs_deb_leave(LBS_DEB_USB);
164 static void if_usb_setup_firmware(struct lbs_private *priv)
166 struct if_usb_card *cardp = priv->card;
167 struct cmd_ds_set_boot2_ver b2_cmd;
168 struct cmd_ds_802_11_fw_wake_method wake_method;
170 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
172 b2_cmd.version = cardp->boot2_version;
174 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
175 lbs_deb_usb("Setting boot2 version failed\n");
177 priv->wol_gpio = 2; /* Wake via GPIO2... */
178 priv->wol_gap = 20; /* ... after 20ms */
179 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
180 (struct wol_config *) NULL);
182 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
183 wake_method.action = cpu_to_le16(CMD_ACT_GET);
184 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
185 lbs_pr_info("Firmware does not seem to support PS mode\n");
186 priv->fwcapinfo &= ~FW_CAPINFO_PS;
188 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
189 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
191 /* The versions which boot up this way don't seem to
192 work even if we set it to the command interrupt */
193 priv->fwcapinfo &= ~FW_CAPINFO_PS;
194 lbs_pr_info("Firmware doesn't wake via command interrupt; disabling PS mode\n");
199 static void if_usb_fw_timeo(unsigned long priv)
201 struct if_usb_card *cardp = (void *)priv;
203 if (cardp->fwdnldover) {
204 lbs_deb_usb("Download complete, no event. Assuming success\n");
206 lbs_pr_err("Download timed out\n");
207 cardp->surprise_removed = 1;
209 wake_up(&cardp->fw_wq);
213 static void if_usb_reset_olpc_card(struct lbs_private *priv)
215 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
216 olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
221 * @brief sets the configuration values
222 * @param ifnum interface number
223 * @param id pointer to usb_device_id
224 * @return 0 on success, error code on failure
226 static int if_usb_probe(struct usb_interface *intf,
227 const struct usb_device_id *id)
229 struct usb_device *udev;
230 struct usb_host_interface *iface_desc;
231 struct usb_endpoint_descriptor *endpoint;
232 struct lbs_private *priv;
233 struct if_usb_card *cardp;
236 udev = interface_to_usbdev(intf);
238 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
240 lbs_pr_err("Out of memory allocating private data.\n");
244 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
245 init_waitqueue_head(&cardp->fw_wq);
248 iface_desc = intf->cur_altsetting;
250 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
251 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
252 le16_to_cpu(udev->descriptor.bcdUSB),
253 udev->descriptor.bDeviceClass,
254 udev->descriptor.bDeviceSubClass,
255 udev->descriptor.bDeviceProtocol);
257 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
258 endpoint = &iface_desc->endpoint[i].desc;
259 if (usb_endpoint_is_bulk_in(endpoint)) {
260 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
261 cardp->ep_in = usb_endpoint_num(endpoint);
263 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
264 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
266 } else if (usb_endpoint_is_bulk_out(endpoint)) {
267 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
268 cardp->ep_out = usb_endpoint_num(endpoint);
270 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
271 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
274 if (!cardp->ep_out_size || !cardp->ep_in_size) {
275 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
278 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
279 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
282 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
283 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
286 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
287 if (!cardp->ep_out_buf) {
288 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
292 /* Upload firmware */
293 if (__if_usb_prog_firmware(cardp, lbs_fw_name, BOOT_CMD_FW_BY_USB)) {
294 lbs_deb_usbd(&udev->dev, "FW upload failed\n");
295 goto err_prog_firmware;
298 if (!(priv = lbs_add_card(cardp, &udev->dev)))
299 goto err_prog_firmware;
302 cardp->priv->fw_ready = 1;
304 priv->hw_host_to_card = if_usb_host_to_card;
305 priv->enter_deep_sleep = NULL;
306 priv->exit_deep_sleep = NULL;
307 priv->reset_deep_sleep_wakeup = NULL;
309 if (machine_is_olpc())
310 priv->reset_card = if_usb_reset_olpc_card;
313 cardp->boot2_version = udev->descriptor.bcdDevice;
315 if_usb_submit_rx_urb(cardp);
317 if (lbs_start_card(priv))
320 if_usb_setup_firmware(priv);
323 usb_set_intfdata(intf, cardp);
325 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_fw))
326 lbs_pr_err("cannot register lbs_flash_fw attribute\n");
328 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2))
329 lbs_pr_err("cannot register lbs_flash_boot2 attribute\n");
334 lbs_remove_card(priv);
336 if_usb_reset_device(cardp);
345 * @brief free resource and cleanup
346 * @param intf USB interface structure
349 static void if_usb_disconnect(struct usb_interface *intf)
351 struct if_usb_card *cardp = usb_get_intfdata(intf);
352 struct lbs_private *priv = (struct lbs_private *) cardp->priv;
354 lbs_deb_enter(LBS_DEB_MAIN);
356 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2);
357 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_fw);
359 cardp->surprise_removed = 1;
362 priv->surpriseremoved = 1;
364 lbs_remove_card(priv);
367 /* Unlink and free urb */
370 usb_set_intfdata(intf, NULL);
371 usb_put_dev(interface_to_usbdev(intf));
373 lbs_deb_leave(LBS_DEB_MAIN);
377 * @brief This function download FW
378 * @param priv pointer to struct lbs_private
381 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
383 struct fwdata *fwdata = cardp->ep_out_buf;
384 const uint8_t *firmware = cardp->fw->data;
386 /* If we got a CRC failure on the last block, back
388 if (!cardp->CRC_OK) {
389 cardp->totalbytes = cardp->fwlastblksent;
393 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
396 /* struct fwdata (which we sent to the card) has an
397 extra __le32 field in between the header and the data,
398 which is not in the struct fwheader in the actual
399 firmware binary. Insert the seqnum in the middle... */
400 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
401 sizeof(struct fwheader));
403 cardp->fwlastblksent = cardp->totalbytes;
404 cardp->totalbytes += sizeof(struct fwheader);
406 memcpy(fwdata->data, &firmware[cardp->totalbytes],
407 le32_to_cpu(fwdata->hdr.datalength));
409 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
410 le32_to_cpu(fwdata->hdr.datalength));
412 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
413 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
415 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
416 le32_to_cpu(fwdata->hdr.datalength));
418 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
419 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
420 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
421 cardp->fwseqnum, cardp->totalbytes);
422 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
423 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
424 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
426 cardp->fwfinalblk = 1;
429 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
435 static int if_usb_reset_device(struct if_usb_card *cardp)
437 struct cmd_ds_command *cmd = cardp->ep_out_buf + 4;
440 lbs_deb_enter(LBS_DEB_USB);
442 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
444 cmd->command = cpu_to_le16(CMD_802_11_RESET);
445 cmd->size = cpu_to_le16(sizeof(struct cmd_header));
446 cmd->result = cpu_to_le16(0);
447 cmd->seqnum = cpu_to_le16(0x5a5a);
448 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
451 ret = usb_reset_device(cardp->udev);
455 if (ret && machine_is_olpc())
456 if_usb_reset_olpc_card(NULL);
459 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
465 * @brief This function transfer the data to the device.
466 * @param priv pointer to struct lbs_private
467 * @param payload pointer to payload data
468 * @param nb data length
471 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
475 /* check if device is removed */
476 if (cardp->surprise_removed) {
477 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
481 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
482 usb_sndbulkpipe(cardp->udev,
484 payload, nb, if_usb_write_bulk_callback, cardp);
486 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
488 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
489 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
492 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
500 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
501 void (*callbackfn)(struct urb *urb))
506 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
507 lbs_pr_err("No free skb\n");
513 /* Fill the receive configuration URB and initialise the Rx call back */
514 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
515 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
516 skb->data + IPFIELD_ALIGN_OFFSET,
517 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
520 cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
522 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
523 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
524 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
526 cardp->rx_skb = NULL;
529 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
537 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
539 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
542 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
544 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
547 static void if_usb_receive_fwload(struct urb *urb)
549 struct if_usb_card *cardp = urb->context;
550 struct sk_buff *skb = cardp->rx_skb;
551 struct fwsyncheader *syncfwheader;
552 struct bootcmdresp bootcmdresp;
555 lbs_deb_usbd(&cardp->udev->dev,
556 "URB status is failed during fw load\n");
561 if (cardp->fwdnldover) {
562 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
564 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
565 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
566 lbs_pr_info("Firmware ready event received\n");
567 wake_up(&cardp->fw_wq);
569 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
570 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
571 if_usb_submit_rx_urb_fwload(cardp);
576 if (cardp->bootcmdresp <= 0) {
577 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
578 sizeof(bootcmdresp));
580 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
582 if_usb_submit_rx_urb_fwload(cardp);
583 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
584 lbs_deb_usbd(&cardp->udev->dev,
585 "Received valid boot command response\n");
588 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
589 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
590 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
591 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
592 if (!cardp->bootcmdresp)
593 lbs_pr_info("Firmware already seems alive; resetting\n");
594 cardp->bootcmdresp = -1;
596 lbs_pr_info("boot cmd response wrong magic number (0x%x)\n",
597 le32_to_cpu(bootcmdresp.magic));
599 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
600 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
601 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
602 lbs_pr_info("boot cmd response cmd_tag error (%d)\n",
604 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
605 lbs_pr_info("boot cmd response result error (%d)\n",
608 cardp->bootcmdresp = 1;
609 lbs_deb_usbd(&cardp->udev->dev,
610 "Received valid boot command response\n");
613 if_usb_submit_rx_urb_fwload(cardp);
617 syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
619 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
624 memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET,
625 sizeof(struct fwsyncheader));
627 if (!syncfwheader->cmd) {
628 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
629 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
630 le32_to_cpu(syncfwheader->seqnum));
633 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
639 /* Give device 5s to either write firmware to its RAM or eeprom */
640 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
642 if (cardp->fwfinalblk) {
643 cardp->fwdnldover = 1;
647 if_usb_send_fw_pkt(cardp);
650 if_usb_submit_rx_urb_fwload(cardp);
657 #define MRVDRV_MIN_PKT_LEN 30
659 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
660 struct if_usb_card *cardp,
661 struct lbs_private *priv)
663 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
664 || recvlength < MRVDRV_MIN_PKT_LEN) {
665 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
670 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
671 skb_put(skb, recvlength);
672 skb_pull(skb, MESSAGE_HEADER_LEN);
674 lbs_process_rxed_packet(priv, skb);
677 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
679 struct if_usb_card *cardp,
680 struct lbs_private *priv)
684 if (recvlength > LBS_CMD_BUFFER_SIZE) {
685 lbs_deb_usbd(&cardp->udev->dev,
686 "The receive buffer is too large\n");
691 BUG_ON(!in_interrupt());
693 spin_lock(&priv->driver_lock);
695 i = (priv->resp_idx == 0) ? 1 : 0;
696 BUG_ON(priv->resp_len[i]);
697 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
698 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
701 lbs_notify_command_response(priv, i);
703 spin_unlock(&priv->driver_lock);
705 lbs_deb_usbd(&cardp->udev->dev,
706 "Wake up main thread to handle cmd response\n");
710 * @brief This function reads of the packet into the upload buff,
711 * wake up the main thread and initialise the Rx callack.
713 * @param urb pointer to struct urb
716 static void if_usb_receive(struct urb *urb)
718 struct if_usb_card *cardp = urb->context;
719 struct sk_buff *skb = cardp->rx_skb;
720 struct lbs_private *priv = cardp->priv;
721 int recvlength = urb->actual_length;
722 uint8_t *recvbuff = NULL;
723 uint32_t recvtype = 0;
724 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
727 lbs_deb_enter(LBS_DEB_USB);
731 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
737 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
738 recvtype = le32_to_cpu(pkt[0]);
739 lbs_deb_usbd(&cardp->udev->dev,
740 "Recv length = 0x%x, Recv type = 0x%X\n",
741 recvlength, recvtype);
742 } else if (urb->status) {
749 process_cmdtypedata(recvlength, skb, cardp, priv);
752 case CMD_TYPE_REQUEST:
753 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
756 case CMD_TYPE_INDICATION:
758 event = le32_to_cpu(pkt[1]);
759 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
762 /* Icky undocumented magic special case */
763 if (event & 0xffff0000) {
764 u32 trycount = (event & 0xffff0000) >> 16;
766 lbs_send_tx_feedback(priv, trycount);
768 lbs_queue_event(priv, event & 0xFF);
772 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
779 if_usb_submit_rx_urb(cardp);
781 lbs_deb_leave(LBS_DEB_USB);
785 * @brief This function downloads data to FW
786 * @param priv pointer to struct lbs_private structure
787 * @param type type of data
788 * @param buf pointer to data buffer
789 * @param len number of bytes
792 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
793 uint8_t *payload, uint16_t nb)
795 struct if_usb_card *cardp = priv->card;
797 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
798 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
800 if (type == MVMS_CMD) {
801 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
802 priv->dnld_sent = DNLD_CMD_SENT;
804 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
805 priv->dnld_sent = DNLD_DATA_SENT;
808 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
810 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
814 * @brief This function issues Boot command to the Boot2 code
815 * @param ivalue 1:Boot from FW by USB-Download
816 * 2:Boot from FW in EEPROM
819 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
821 struct bootcmd *bootcmd = cardp->ep_out_buf;
823 /* Prepare command */
824 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
825 bootcmd->cmd = ivalue;
826 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
829 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
836 * @brief This function checks the validity of Boot2/FW image.
838 * @param data pointer to image
842 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
844 uint32_t bincmd, exit;
845 uint32_t blksize, offset, len;
852 struct fwheader *fwh = (void *)data;
854 bincmd = le32_to_cpu(fwh->dnldcmd);
855 blksize = le32_to_cpu(fwh->datalength);
857 case FW_HAS_DATA_TO_RECV:
858 offset = sizeof(struct fwheader) + blksize;
864 case FW_HAS_LAST_BLOCK:
875 lbs_pr_err("firmware file format check FAIL\n");
877 lbs_deb_fw("firmware file format check PASS\n");
884 * @brief This function programs the firmware subject to cmd
886 * @param cardp the if_usb_card descriptor
887 * fwname firmware or boot2 image file name
888 * cmd either BOOT_CMD_FW_BY_USB, BOOT_CMD_UPDATE_FW,
889 * or BOOT_CMD_UPDATE_BOOT2.
890 * @return 0 or error code
892 static int if_usb_prog_firmware(struct if_usb_card *cardp,
893 const char *fwname, int cmd)
895 struct lbs_private *priv = cardp->priv;
896 unsigned long flags, caps;
899 caps = priv->fwcapinfo;
900 if (((cmd == BOOT_CMD_UPDATE_FW) && !(caps & FW_CAPINFO_FIRMWARE_UPGRADE)) ||
901 ((cmd == BOOT_CMD_UPDATE_BOOT2) && !(caps & FW_CAPINFO_BOOT2_UPGRADE)))
904 /* Ensure main thread is idle. */
905 spin_lock_irqsave(&priv->driver_lock, flags);
906 while (priv->cur_cmd != NULL || priv->dnld_sent != DNLD_RES_RECEIVED) {
907 spin_unlock_irqrestore(&priv->driver_lock, flags);
908 if (wait_event_interruptible(priv->waitq,
909 (priv->cur_cmd == NULL &&
910 priv->dnld_sent == DNLD_RES_RECEIVED))) {
913 spin_lock_irqsave(&priv->driver_lock, flags);
915 priv->dnld_sent = DNLD_BOOTCMD_SENT;
916 spin_unlock_irqrestore(&priv->driver_lock, flags);
918 ret = __if_usb_prog_firmware(cardp, fwname, cmd);
920 spin_lock_irqsave(&priv->driver_lock, flags);
921 priv->dnld_sent = DNLD_RES_RECEIVED;
922 spin_unlock_irqrestore(&priv->driver_lock, flags);
924 wake_up_interruptible(&priv->waitq);
929 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
930 const char *fwname, int cmd)
933 static int reset_count = 10;
936 lbs_deb_enter(LBS_DEB_USB);
938 ret = request_firmware(&cardp->fw, fwname, &cardp->udev->dev);
940 lbs_pr_err("request_firmware() failed with %#x\n", ret);
941 lbs_pr_err("firmware %s not found\n", fwname);
945 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
950 /* Cancel any pending usb business */
951 usb_kill_urb(cardp->rx_urb);
952 usb_kill_urb(cardp->tx_urb);
954 cardp->fwlastblksent = 0;
955 cardp->fwdnldover = 0;
956 cardp->totalbytes = 0;
957 cardp->fwfinalblk = 0;
958 cardp->bootcmdresp = 0;
961 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
962 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
967 cardp->bootcmdresp = 0;
971 if_usb_issue_boot_command(cardp, cmd);
972 /* wait for command response */
975 msleep_interruptible(100);
976 } while (cardp->bootcmdresp == 0 && j < 10);
977 } while (cardp->bootcmdresp == 0 && i < 5);
979 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
980 /* Return to normal operation */
982 usb_kill_urb(cardp->rx_urb);
983 usb_kill_urb(cardp->tx_urb);
984 if (if_usb_submit_rx_urb(cardp) < 0)
987 } else if (cardp->bootcmdresp <= 0) {
988 if (--reset_count >= 0) {
989 if_usb_reset_device(cardp);
998 cardp->totalbytes = 0;
999 cardp->fwlastblksent = 0;
1001 cardp->fwdnldover = 0;
1002 cardp->fwseqnum = -1;
1003 cardp->totalbytes = 0;
1004 cardp->fwfinalblk = 0;
1006 /* Send the first firmware packet... */
1007 if_usb_send_fw_pkt(cardp);
1009 /* ... and wait for the process to complete */
1010 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
1012 del_timer_sync(&cardp->fw_timeout);
1013 usb_kill_urb(cardp->rx_urb);
1015 if (!cardp->fwdnldover) {
1016 lbs_pr_info("failed to load fw, resetting device!\n");
1017 if (--reset_count >= 0) {
1018 if_usb_reset_device(cardp);
1022 lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
1028 release_firmware(cardp->fw);
1032 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
1038 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
1040 struct if_usb_card *cardp = usb_get_intfdata(intf);
1041 struct lbs_private *priv = cardp->priv;
1044 lbs_deb_enter(LBS_DEB_USB);
1046 if (priv->psstate != PS_STATE_FULL_POWER)
1049 ret = lbs_suspend(priv);
1053 /* Unlink tx & rx urb */
1054 usb_kill_urb(cardp->tx_urb);
1055 usb_kill_urb(cardp->rx_urb);
1058 lbs_deb_leave(LBS_DEB_USB);
1062 static int if_usb_resume(struct usb_interface *intf)
1064 struct if_usb_card *cardp = usb_get_intfdata(intf);
1065 struct lbs_private *priv = cardp->priv;
1067 lbs_deb_enter(LBS_DEB_USB);
1069 if_usb_submit_rx_urb(cardp);
1073 lbs_deb_leave(LBS_DEB_USB);
1077 #define if_usb_suspend NULL
1078 #define if_usb_resume NULL
1081 static struct usb_driver if_usb_driver = {
1083 .probe = if_usb_probe,
1084 .disconnect = if_usb_disconnect,
1085 .id_table = if_usb_table,
1086 .suspend = if_usb_suspend,
1087 .resume = if_usb_resume,
1088 .reset_resume = if_usb_resume,
1091 static int __init if_usb_init_module(void)
1095 lbs_deb_enter(LBS_DEB_MAIN);
1097 ret = usb_register(&if_usb_driver);
1099 lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
1103 static void __exit if_usb_exit_module(void)
1105 lbs_deb_enter(LBS_DEB_MAIN);
1107 usb_deregister(&if_usb_driver);
1109 lbs_deb_leave(LBS_DEB_MAIN);
1112 module_init(if_usb_init_module);
1113 module_exit(if_usb_exit_module);
1115 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1116 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1117 MODULE_LICENSE("GPL");