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>
8 #include <linux/slab.h>
15 #define DRV_NAME "usb8xxx"
25 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
27 #define MESSAGE_HEADER_LEN 4
29 static char *lbs_fw_name = "usb8388.bin";
30 module_param_named(fw_name, lbs_fw_name, charp, 0644);
32 MODULE_FIRMWARE("usb8388.bin");
34 static struct usb_device_id if_usb_table[] = {
35 /* Enter the device signature inside */
36 { USB_DEVICE(0x1286, 0x2001) },
37 { USB_DEVICE(0x05a3, 0x8388) },
38 {} /* Terminating entry */
41 MODULE_DEVICE_TABLE(usb, if_usb_table);
43 static void if_usb_receive(struct urb *urb);
44 static void if_usb_receive_fwload(struct urb *urb);
45 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
46 const char *fwname, int cmd);
47 static int if_usb_prog_firmware(struct if_usb_card *cardp,
48 const char *fwname, int cmd);
49 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
50 uint8_t *payload, uint16_t nb);
51 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
53 static void if_usb_free(struct if_usb_card *cardp);
54 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
55 static int if_usb_reset_device(struct if_usb_card *cardp);
60 * Set function to write firmware to device's persistent memory
62 static ssize_t if_usb_firmware_set(struct device *dev,
63 struct device_attribute *attr, const char *buf, size_t count)
65 struct lbs_private *priv = to_net_dev(dev)->ml_priv;
66 struct if_usb_card *cardp = priv->card;
69 ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_FW);
77 * lbs_flash_fw attribute to be exported per ethX interface through sysfs
78 * (/sys/class/net/ethX/lbs_flash_fw). Use this like so to write firmware to
79 * the device's persistent memory:
80 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_fw
82 static DEVICE_ATTR(lbs_flash_fw, 0200, NULL, if_usb_firmware_set);
85 * Set function to write firmware to device's persistent memory
87 static ssize_t if_usb_boot2_set(struct device *dev,
88 struct device_attribute *attr, const char *buf, size_t count)
90 struct lbs_private *priv = to_net_dev(dev)->ml_priv;
91 struct if_usb_card *cardp = priv->card;
94 ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_BOOT2);
102 * lbs_flash_boot2 attribute to be exported per ethX interface through sysfs
103 * (/sys/class/net/ethX/lbs_flash_boot2). Use this like so to write firmware
104 * to the device's persistent memory:
105 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_boot2
107 static DEVICE_ATTR(lbs_flash_boot2, 0200, NULL, if_usb_boot2_set);
110 * @brief call back function to handle the status of the URB
111 * @param urb pointer to urb structure
114 static void if_usb_write_bulk_callback(struct urb *urb)
116 struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
118 /* handle the transmission complete validations */
120 if (urb->status == 0) {
121 struct lbs_private *priv = cardp->priv;
123 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
124 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
127 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
128 * passed up to the lbs level.
130 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT)
131 lbs_host_to_card_done(priv);
133 /* print the failure status number for debug */
134 lbs_pr_info("URB in failure status: %d\n", urb->status);
139 * @brief free tx/rx urb, skb and rx buffer
140 * @param cardp pointer if_usb_card
143 static void if_usb_free(struct if_usb_card *cardp)
145 lbs_deb_enter(LBS_DEB_USB);
147 /* Unlink tx & rx urb */
148 usb_kill_urb(cardp->tx_urb);
149 usb_kill_urb(cardp->rx_urb);
151 usb_free_urb(cardp->tx_urb);
152 cardp->tx_urb = NULL;
154 usb_free_urb(cardp->rx_urb);
155 cardp->rx_urb = NULL;
157 kfree(cardp->ep_out_buf);
158 cardp->ep_out_buf = NULL;
160 lbs_deb_leave(LBS_DEB_USB);
163 static void if_usb_setup_firmware(struct lbs_private *priv)
165 struct if_usb_card *cardp = priv->card;
166 struct cmd_ds_set_boot2_ver b2_cmd;
167 struct cmd_ds_802_11_fw_wake_method wake_method;
169 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
171 b2_cmd.version = cardp->boot2_version;
173 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
174 lbs_deb_usb("Setting boot2 version failed\n");
176 priv->wol_gpio = 2; /* Wake via GPIO2... */
177 priv->wol_gap = 20; /* ... after 20ms */
178 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
179 (struct wol_config *) NULL);
181 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
182 wake_method.action = cpu_to_le16(CMD_ACT_GET);
183 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
184 lbs_pr_info("Firmware does not seem to support PS mode\n");
185 priv->fwcapinfo &= ~FW_CAPINFO_PS;
187 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
188 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
190 /* The versions which boot up this way don't seem to
191 work even if we set it to the command interrupt */
192 priv->fwcapinfo &= ~FW_CAPINFO_PS;
193 lbs_pr_info("Firmware doesn't wake via command interrupt; disabling PS mode\n");
198 static void if_usb_fw_timeo(unsigned long priv)
200 struct if_usb_card *cardp = (void *)priv;
202 if (cardp->fwdnldover) {
203 lbs_deb_usb("Download complete, no event. Assuming success\n");
205 lbs_pr_err("Download timed out\n");
206 cardp->surprise_removed = 1;
208 wake_up(&cardp->fw_wq);
212 static void if_usb_reset_olpc_card(struct lbs_private *priv)
214 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
215 olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
220 * @brief sets the configuration values
221 * @param ifnum interface number
222 * @param id pointer to usb_device_id
223 * @return 0 on success, error code on failure
225 static int if_usb_probe(struct usb_interface *intf,
226 const struct usb_device_id *id)
228 struct usb_device *udev;
229 struct usb_host_interface *iface_desc;
230 struct usb_endpoint_descriptor *endpoint;
231 struct lbs_private *priv;
232 struct if_usb_card *cardp;
235 udev = interface_to_usbdev(intf);
237 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
239 lbs_pr_err("Out of memory allocating private data.\n");
243 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
244 init_waitqueue_head(&cardp->fw_wq);
247 iface_desc = intf->cur_altsetting;
249 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
250 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
251 le16_to_cpu(udev->descriptor.bcdUSB),
252 udev->descriptor.bDeviceClass,
253 udev->descriptor.bDeviceSubClass,
254 udev->descriptor.bDeviceProtocol);
256 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
257 endpoint = &iface_desc->endpoint[i].desc;
258 if (usb_endpoint_is_bulk_in(endpoint)) {
259 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
260 cardp->ep_in = usb_endpoint_num(endpoint);
262 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
263 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
265 } else if (usb_endpoint_is_bulk_out(endpoint)) {
266 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
267 cardp->ep_out = usb_endpoint_num(endpoint);
269 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
270 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
273 if (!cardp->ep_out_size || !cardp->ep_in_size) {
274 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
277 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
278 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
281 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
282 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
285 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
286 if (!cardp->ep_out_buf) {
287 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
291 /* Upload firmware */
292 if (__if_usb_prog_firmware(cardp, lbs_fw_name, BOOT_CMD_FW_BY_USB)) {
293 lbs_deb_usbd(&udev->dev, "FW upload failed\n");
294 goto err_prog_firmware;
297 if (!(priv = lbs_add_card(cardp, &udev->dev)))
298 goto err_prog_firmware;
301 cardp->priv->fw_ready = 1;
303 priv->hw_host_to_card = if_usb_host_to_card;
304 priv->enter_deep_sleep = NULL;
305 priv->exit_deep_sleep = NULL;
306 priv->reset_deep_sleep_wakeup = NULL;
308 if (machine_is_olpc())
309 priv->reset_card = if_usb_reset_olpc_card;
312 cardp->boot2_version = udev->descriptor.bcdDevice;
314 if_usb_submit_rx_urb(cardp);
316 if (lbs_start_card(priv))
319 if_usb_setup_firmware(priv);
322 usb_set_intfdata(intf, cardp);
324 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_fw))
325 lbs_pr_err("cannot register lbs_flash_fw attribute\n");
327 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2))
328 lbs_pr_err("cannot register lbs_flash_boot2 attribute\n");
333 lbs_remove_card(priv);
335 if_usb_reset_device(cardp);
344 * @brief free resource and cleanup
345 * @param intf USB interface structure
348 static void if_usb_disconnect(struct usb_interface *intf)
350 struct if_usb_card *cardp = usb_get_intfdata(intf);
351 struct lbs_private *priv = (struct lbs_private *) cardp->priv;
353 lbs_deb_enter(LBS_DEB_MAIN);
355 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2);
356 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_fw);
358 cardp->surprise_removed = 1;
361 priv->surpriseremoved = 1;
363 lbs_remove_card(priv);
366 /* Unlink and free urb */
369 usb_set_intfdata(intf, NULL);
370 usb_put_dev(interface_to_usbdev(intf));
372 lbs_deb_leave(LBS_DEB_MAIN);
376 * @brief This function download FW
377 * @param priv pointer to struct lbs_private
380 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
382 struct fwdata *fwdata = cardp->ep_out_buf;
383 const uint8_t *firmware = cardp->fw->data;
385 /* If we got a CRC failure on the last block, back
387 if (!cardp->CRC_OK) {
388 cardp->totalbytes = cardp->fwlastblksent;
392 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
395 /* struct fwdata (which we sent to the card) has an
396 extra __le32 field in between the header and the data,
397 which is not in the struct fwheader in the actual
398 firmware binary. Insert the seqnum in the middle... */
399 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
400 sizeof(struct fwheader));
402 cardp->fwlastblksent = cardp->totalbytes;
403 cardp->totalbytes += sizeof(struct fwheader);
405 memcpy(fwdata->data, &firmware[cardp->totalbytes],
406 le32_to_cpu(fwdata->hdr.datalength));
408 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
409 le32_to_cpu(fwdata->hdr.datalength));
411 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
412 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
414 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
415 le32_to_cpu(fwdata->hdr.datalength));
417 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
418 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
419 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
420 cardp->fwseqnum, cardp->totalbytes);
421 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
422 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
423 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
425 cardp->fwfinalblk = 1;
428 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
434 static int if_usb_reset_device(struct if_usb_card *cardp)
436 struct cmd_ds_command *cmd = cardp->ep_out_buf + 4;
439 lbs_deb_enter(LBS_DEB_USB);
441 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
443 cmd->command = cpu_to_le16(CMD_802_11_RESET);
444 cmd->size = cpu_to_le16(sizeof(struct cmd_header));
445 cmd->result = cpu_to_le16(0);
446 cmd->seqnum = cpu_to_le16(0x5a5a);
447 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
450 ret = usb_reset_device(cardp->udev);
454 if (ret && machine_is_olpc())
455 if_usb_reset_olpc_card(NULL);
458 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
464 * @brief This function transfer the data to the device.
465 * @param priv pointer to struct lbs_private
466 * @param payload pointer to payload data
467 * @param nb data length
470 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
474 /* check if device is removed */
475 if (cardp->surprise_removed) {
476 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
480 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
481 usb_sndbulkpipe(cardp->udev,
483 payload, nb, if_usb_write_bulk_callback, cardp);
485 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
487 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
488 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
491 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
499 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
500 void (*callbackfn)(struct urb *urb))
505 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
506 lbs_pr_err("No free skb\n");
512 /* Fill the receive configuration URB and initialise the Rx call back */
513 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
514 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
515 skb->data + IPFIELD_ALIGN_OFFSET,
516 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
519 cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
521 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
522 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
523 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
525 cardp->rx_skb = NULL;
528 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
536 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
538 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
541 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
543 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
546 static void if_usb_receive_fwload(struct urb *urb)
548 struct if_usb_card *cardp = urb->context;
549 struct sk_buff *skb = cardp->rx_skb;
550 struct fwsyncheader *syncfwheader;
551 struct bootcmdresp bootcmdresp;
554 lbs_deb_usbd(&cardp->udev->dev,
555 "URB status is failed during fw load\n");
560 if (cardp->fwdnldover) {
561 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
563 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
564 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
565 lbs_pr_info("Firmware ready event received\n");
566 wake_up(&cardp->fw_wq);
568 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
569 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
570 if_usb_submit_rx_urb_fwload(cardp);
575 if (cardp->bootcmdresp <= 0) {
576 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
577 sizeof(bootcmdresp));
579 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
581 if_usb_submit_rx_urb_fwload(cardp);
582 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
583 lbs_deb_usbd(&cardp->udev->dev,
584 "Received valid boot command response\n");
587 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
588 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
589 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
590 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
591 if (!cardp->bootcmdresp)
592 lbs_pr_info("Firmware already seems alive; resetting\n");
593 cardp->bootcmdresp = -1;
595 lbs_pr_info("boot cmd response wrong magic number (0x%x)\n",
596 le32_to_cpu(bootcmdresp.magic));
598 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
599 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
600 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
601 lbs_pr_info("boot cmd response cmd_tag error (%d)\n",
603 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
604 lbs_pr_info("boot cmd response result error (%d)\n",
607 cardp->bootcmdresp = 1;
608 lbs_deb_usbd(&cardp->udev->dev,
609 "Received valid boot command response\n");
612 if_usb_submit_rx_urb_fwload(cardp);
616 syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
618 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
623 memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET,
624 sizeof(struct fwsyncheader));
626 if (!syncfwheader->cmd) {
627 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
628 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
629 le32_to_cpu(syncfwheader->seqnum));
632 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
638 /* Give device 5s to either write firmware to its RAM or eeprom */
639 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
641 if (cardp->fwfinalblk) {
642 cardp->fwdnldover = 1;
646 if_usb_send_fw_pkt(cardp);
649 if_usb_submit_rx_urb_fwload(cardp);
654 #define MRVDRV_MIN_PKT_LEN 30
656 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
657 struct if_usb_card *cardp,
658 struct lbs_private *priv)
660 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
661 || recvlength < MRVDRV_MIN_PKT_LEN) {
662 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
667 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
668 skb_put(skb, recvlength);
669 skb_pull(skb, MESSAGE_HEADER_LEN);
671 lbs_process_rxed_packet(priv, skb);
674 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
676 struct if_usb_card *cardp,
677 struct lbs_private *priv)
681 if (recvlength > LBS_CMD_BUFFER_SIZE) {
682 lbs_deb_usbd(&cardp->udev->dev,
683 "The receive buffer is too large\n");
688 BUG_ON(!in_interrupt());
690 spin_lock(&priv->driver_lock);
692 i = (priv->resp_idx == 0) ? 1 : 0;
693 BUG_ON(priv->resp_len[i]);
694 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
695 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
698 lbs_notify_command_response(priv, i);
700 spin_unlock(&priv->driver_lock);
702 lbs_deb_usbd(&cardp->udev->dev,
703 "Wake up main thread to handle cmd response\n");
707 * @brief This function reads of the packet into the upload buff,
708 * wake up the main thread and initialise the Rx callack.
710 * @param urb pointer to struct urb
713 static void if_usb_receive(struct urb *urb)
715 struct if_usb_card *cardp = urb->context;
716 struct sk_buff *skb = cardp->rx_skb;
717 struct lbs_private *priv = cardp->priv;
718 int recvlength = urb->actual_length;
719 uint8_t *recvbuff = NULL;
720 uint32_t recvtype = 0;
721 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
724 lbs_deb_enter(LBS_DEB_USB);
728 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
734 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
735 recvtype = le32_to_cpu(pkt[0]);
736 lbs_deb_usbd(&cardp->udev->dev,
737 "Recv length = 0x%x, Recv type = 0x%X\n",
738 recvlength, recvtype);
739 } else if (urb->status) {
746 process_cmdtypedata(recvlength, skb, cardp, priv);
749 case CMD_TYPE_REQUEST:
750 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
753 case CMD_TYPE_INDICATION:
755 event = le32_to_cpu(pkt[1]);
756 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
759 /* Icky undocumented magic special case */
760 if (event & 0xffff0000) {
761 u32 trycount = (event & 0xffff0000) >> 16;
763 lbs_send_tx_feedback(priv, trycount);
765 lbs_queue_event(priv, event & 0xFF);
769 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
776 if_usb_submit_rx_urb(cardp);
778 lbs_deb_leave(LBS_DEB_USB);
782 * @brief This function downloads data to FW
783 * @param priv pointer to struct lbs_private structure
784 * @param type type of data
785 * @param buf pointer to data buffer
786 * @param len number of bytes
789 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
790 uint8_t *payload, uint16_t nb)
792 struct if_usb_card *cardp = priv->card;
794 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
795 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
797 if (type == MVMS_CMD) {
798 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
799 priv->dnld_sent = DNLD_CMD_SENT;
801 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
802 priv->dnld_sent = DNLD_DATA_SENT;
805 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
807 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
811 * @brief This function issues Boot command to the Boot2 code
812 * @param ivalue 1:Boot from FW by USB-Download
813 * 2:Boot from FW in EEPROM
816 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
818 struct bootcmd *bootcmd = cardp->ep_out_buf;
820 /* Prepare command */
821 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
822 bootcmd->cmd = ivalue;
823 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
826 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
833 * @brief This function checks the validity of Boot2/FW image.
835 * @param data pointer to image
839 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
841 uint32_t bincmd, exit;
842 uint32_t blksize, offset, len;
849 struct fwheader *fwh = (void *)data;
851 bincmd = le32_to_cpu(fwh->dnldcmd);
852 blksize = le32_to_cpu(fwh->datalength);
854 case FW_HAS_DATA_TO_RECV:
855 offset = sizeof(struct fwheader) + blksize;
861 case FW_HAS_LAST_BLOCK:
872 lbs_pr_err("firmware file format check FAIL\n");
874 lbs_deb_fw("firmware file format check PASS\n");
881 * @brief This function programs the firmware subject to cmd
883 * @param cardp the if_usb_card descriptor
884 * fwname firmware or boot2 image file name
885 * cmd either BOOT_CMD_FW_BY_USB, BOOT_CMD_UPDATE_FW,
886 * or BOOT_CMD_UPDATE_BOOT2.
887 * @return 0 or error code
889 static int if_usb_prog_firmware(struct if_usb_card *cardp,
890 const char *fwname, int cmd)
892 struct lbs_private *priv = cardp->priv;
893 unsigned long flags, caps;
896 caps = priv->fwcapinfo;
897 if (((cmd == BOOT_CMD_UPDATE_FW) && !(caps & FW_CAPINFO_FIRMWARE_UPGRADE)) ||
898 ((cmd == BOOT_CMD_UPDATE_BOOT2) && !(caps & FW_CAPINFO_BOOT2_UPGRADE)))
901 /* Ensure main thread is idle. */
902 spin_lock_irqsave(&priv->driver_lock, flags);
903 while (priv->cur_cmd != NULL || priv->dnld_sent != DNLD_RES_RECEIVED) {
904 spin_unlock_irqrestore(&priv->driver_lock, flags);
905 if (wait_event_interruptible(priv->waitq,
906 (priv->cur_cmd == NULL &&
907 priv->dnld_sent == DNLD_RES_RECEIVED))) {
910 spin_lock_irqsave(&priv->driver_lock, flags);
912 priv->dnld_sent = DNLD_BOOTCMD_SENT;
913 spin_unlock_irqrestore(&priv->driver_lock, flags);
915 ret = __if_usb_prog_firmware(cardp, fwname, cmd);
917 spin_lock_irqsave(&priv->driver_lock, flags);
918 priv->dnld_sent = DNLD_RES_RECEIVED;
919 spin_unlock_irqrestore(&priv->driver_lock, flags);
921 wake_up_interruptible(&priv->waitq);
926 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
927 const char *fwname, int cmd)
930 static int reset_count = 10;
933 lbs_deb_enter(LBS_DEB_USB);
935 ret = request_firmware(&cardp->fw, fwname, &cardp->udev->dev);
937 lbs_pr_err("request_firmware() failed with %#x\n", ret);
938 lbs_pr_err("firmware %s not found\n", fwname);
942 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
947 /* Cancel any pending usb business */
948 usb_kill_urb(cardp->rx_urb);
949 usb_kill_urb(cardp->tx_urb);
951 cardp->fwlastblksent = 0;
952 cardp->fwdnldover = 0;
953 cardp->totalbytes = 0;
954 cardp->fwfinalblk = 0;
955 cardp->bootcmdresp = 0;
958 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
959 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
964 cardp->bootcmdresp = 0;
968 if_usb_issue_boot_command(cardp, cmd);
969 /* wait for command response */
972 msleep_interruptible(100);
973 } while (cardp->bootcmdresp == 0 && j < 10);
974 } while (cardp->bootcmdresp == 0 && i < 5);
976 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
977 /* Return to normal operation */
979 usb_kill_urb(cardp->rx_urb);
980 usb_kill_urb(cardp->tx_urb);
981 if (if_usb_submit_rx_urb(cardp) < 0)
984 } else if (cardp->bootcmdresp <= 0) {
985 if (--reset_count >= 0) {
986 if_usb_reset_device(cardp);
995 cardp->totalbytes = 0;
996 cardp->fwlastblksent = 0;
998 cardp->fwdnldover = 0;
999 cardp->fwseqnum = -1;
1000 cardp->totalbytes = 0;
1001 cardp->fwfinalblk = 0;
1003 /* Send the first firmware packet... */
1004 if_usb_send_fw_pkt(cardp);
1006 /* ... and wait for the process to complete */
1007 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
1009 del_timer_sync(&cardp->fw_timeout);
1010 usb_kill_urb(cardp->rx_urb);
1012 if (!cardp->fwdnldover) {
1013 lbs_pr_info("failed to load fw, resetting device!\n");
1014 if (--reset_count >= 0) {
1015 if_usb_reset_device(cardp);
1019 lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
1025 release_firmware(cardp->fw);
1029 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
1035 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
1037 struct if_usb_card *cardp = usb_get_intfdata(intf);
1038 struct lbs_private *priv = cardp->priv;
1041 lbs_deb_enter(LBS_DEB_USB);
1043 if (priv->psstate != PS_STATE_FULL_POWER)
1046 ret = lbs_suspend(priv);
1050 /* Unlink tx & rx urb */
1051 usb_kill_urb(cardp->tx_urb);
1052 usb_kill_urb(cardp->rx_urb);
1055 lbs_deb_leave(LBS_DEB_USB);
1059 static int if_usb_resume(struct usb_interface *intf)
1061 struct if_usb_card *cardp = usb_get_intfdata(intf);
1062 struct lbs_private *priv = cardp->priv;
1064 lbs_deb_enter(LBS_DEB_USB);
1066 if_usb_submit_rx_urb(cardp);
1070 lbs_deb_leave(LBS_DEB_USB);
1074 #define if_usb_suspend NULL
1075 #define if_usb_resume NULL
1078 static struct usb_driver if_usb_driver = {
1080 .probe = if_usb_probe,
1081 .disconnect = if_usb_disconnect,
1082 .id_table = if_usb_table,
1083 .suspend = if_usb_suspend,
1084 .resume = if_usb_resume,
1085 .reset_resume = if_usb_resume,
1088 static int __init if_usb_init_module(void)
1092 lbs_deb_enter(LBS_DEB_MAIN);
1094 ret = usb_register(&if_usb_driver);
1096 lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
1100 static void __exit if_usb_exit_module(void)
1102 lbs_deb_enter(LBS_DEB_MAIN);
1104 usb_deregister(&if_usb_driver);
1106 lbs_deb_leave(LBS_DEB_MAIN);
1109 module_init(if_usb_init_module);
1110 module_exit(if_usb_exit_module);
1112 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1113 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1114 MODULE_LICENSE("GPL");