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 = NULL;
30 module_param_named(fw_name, lbs_fw_name, charp, 0644);
32 MODULE_FIRMWARE("libertas/usb8388_v9.bin");
33 MODULE_FIRMWARE("libertas/usb8388_v5.bin");
34 MODULE_FIRMWARE("libertas/usb8388.bin");
35 MODULE_FIRMWARE("libertas/usb8682.bin");
36 MODULE_FIRMWARE("usb8388.bin");
44 static struct usb_device_id if_usb_table[] = {
45 /* Enter the device signature inside */
46 { USB_DEVICE(0x1286, 0x2001), .driver_info = MODEL_8388 },
47 { USB_DEVICE(0x05a3, 0x8388), .driver_info = MODEL_8388 },
48 {} /* Terminating entry */
51 MODULE_DEVICE_TABLE(usb, if_usb_table);
53 static void if_usb_receive(struct urb *urb);
54 static void if_usb_receive_fwload(struct urb *urb);
55 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
56 const char *fwname, int cmd);
57 static int if_usb_prog_firmware(struct if_usb_card *cardp,
58 const char *fwname, int cmd);
59 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
60 uint8_t *payload, uint16_t nb);
61 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
63 static void if_usb_free(struct if_usb_card *cardp);
64 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
65 static int if_usb_reset_device(struct if_usb_card *cardp);
70 * Set function to write firmware to device's persistent memory
72 static ssize_t if_usb_firmware_set(struct device *dev,
73 struct device_attribute *attr, const char *buf, size_t count)
75 struct lbs_private *priv = to_net_dev(dev)->ml_priv;
76 struct if_usb_card *cardp = priv->card;
81 ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_FW);
89 * lbs_flash_fw attribute to be exported per ethX interface through sysfs
90 * (/sys/class/net/ethX/lbs_flash_fw). Use this like so to write firmware to
91 * the device's persistent memory:
92 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_fw
94 static DEVICE_ATTR(lbs_flash_fw, 0200, NULL, if_usb_firmware_set);
97 * Set function to write firmware to device's persistent memory
99 static ssize_t if_usb_boot2_set(struct device *dev,
100 struct device_attribute *attr, const char *buf, size_t count)
102 struct lbs_private *priv = to_net_dev(dev)->ml_priv;
103 struct if_usb_card *cardp = priv->card;
108 ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_BOOT2);
116 * lbs_flash_boot2 attribute to be exported per ethX interface through sysfs
117 * (/sys/class/net/ethX/lbs_flash_boot2). Use this like so to write firmware
118 * to the device's persistent memory:
119 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_boot2
121 static DEVICE_ATTR(lbs_flash_boot2, 0200, NULL, if_usb_boot2_set);
124 * @brief call back function to handle the status of the URB
125 * @param urb pointer to urb structure
128 static void if_usb_write_bulk_callback(struct urb *urb)
130 struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
132 /* handle the transmission complete validations */
134 if (urb->status == 0) {
135 struct lbs_private *priv = cardp->priv;
137 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
138 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
141 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
142 * passed up to the lbs level.
144 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT)
145 lbs_host_to_card_done(priv);
147 /* print the failure status number for debug */
148 lbs_pr_info("URB in failure status: %d\n", urb->status);
153 * @brief free tx/rx urb, skb and rx buffer
154 * @param cardp pointer if_usb_card
157 static void if_usb_free(struct if_usb_card *cardp)
159 lbs_deb_enter(LBS_DEB_USB);
161 /* Unlink tx & rx urb */
162 usb_kill_urb(cardp->tx_urb);
163 usb_kill_urb(cardp->rx_urb);
165 usb_free_urb(cardp->tx_urb);
166 cardp->tx_urb = NULL;
168 usb_free_urb(cardp->rx_urb);
169 cardp->rx_urb = NULL;
171 kfree(cardp->ep_out_buf);
172 cardp->ep_out_buf = NULL;
174 lbs_deb_leave(LBS_DEB_USB);
177 static void if_usb_setup_firmware(struct lbs_private *priv)
179 struct if_usb_card *cardp = priv->card;
180 struct cmd_ds_set_boot2_ver b2_cmd;
181 struct cmd_ds_802_11_fw_wake_method wake_method;
183 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
185 b2_cmd.version = cardp->boot2_version;
187 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
188 lbs_deb_usb("Setting boot2 version failed\n");
190 priv->wol_gpio = 2; /* Wake via GPIO2... */
191 priv->wol_gap = 20; /* ... after 20ms */
192 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
193 (struct wol_config *) NULL);
195 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
196 wake_method.action = cpu_to_le16(CMD_ACT_GET);
197 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
198 lbs_pr_info("Firmware does not seem to support PS mode\n");
199 priv->fwcapinfo &= ~FW_CAPINFO_PS;
201 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
202 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
204 /* The versions which boot up this way don't seem to
205 work even if we set it to the command interrupt */
206 priv->fwcapinfo &= ~FW_CAPINFO_PS;
207 lbs_pr_info("Firmware doesn't wake via command interrupt; disabling PS mode\n");
212 static void if_usb_fw_timeo(unsigned long priv)
214 struct if_usb_card *cardp = (void *)priv;
216 if (cardp->fwdnldover) {
217 lbs_deb_usb("Download complete, no event. Assuming success\n");
219 lbs_pr_err("Download timed out\n");
220 cardp->surprise_removed = 1;
222 wake_up(&cardp->fw_wq);
226 static void if_usb_reset_olpc_card(struct lbs_private *priv)
228 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
229 olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
234 * @brief sets the configuration values
235 * @param ifnum interface number
236 * @param id pointer to usb_device_id
237 * @return 0 on success, error code on failure
239 static int if_usb_probe(struct usb_interface *intf,
240 const struct usb_device_id *id)
242 struct usb_device *udev;
243 struct usb_host_interface *iface_desc;
244 struct usb_endpoint_descriptor *endpoint;
245 struct lbs_private *priv;
246 struct if_usb_card *cardp;
249 udev = interface_to_usbdev(intf);
251 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
253 lbs_pr_err("Out of memory allocating private data.\n");
257 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
258 init_waitqueue_head(&cardp->fw_wq);
261 cardp->model = (uint32_t) id->driver_info;
262 iface_desc = intf->cur_altsetting;
264 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
265 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
266 le16_to_cpu(udev->descriptor.bcdUSB),
267 udev->descriptor.bDeviceClass,
268 udev->descriptor.bDeviceSubClass,
269 udev->descriptor.bDeviceProtocol);
271 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
272 endpoint = &iface_desc->endpoint[i].desc;
273 if (usb_endpoint_is_bulk_in(endpoint)) {
274 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
275 cardp->ep_in = usb_endpoint_num(endpoint);
277 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
278 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
280 } else if (usb_endpoint_is_bulk_out(endpoint)) {
281 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
282 cardp->ep_out = usb_endpoint_num(endpoint);
284 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
285 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
288 if (!cardp->ep_out_size || !cardp->ep_in_size) {
289 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
292 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
293 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
296 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
297 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
300 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
301 if (!cardp->ep_out_buf) {
302 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
306 /* Upload firmware */
307 kparam_block_sysfs_write(fw_name);
308 if (__if_usb_prog_firmware(cardp, lbs_fw_name, BOOT_CMD_FW_BY_USB)) {
309 kparam_unblock_sysfs_write(fw_name);
310 lbs_deb_usbd(&udev->dev, "FW upload failed\n");
311 goto err_prog_firmware;
313 kparam_unblock_sysfs_write(fw_name);
315 if (!(priv = lbs_add_card(cardp, &udev->dev)))
316 goto err_prog_firmware;
319 cardp->priv->fw_ready = 1;
321 priv->hw_host_to_card = if_usb_host_to_card;
322 priv->enter_deep_sleep = NULL;
323 priv->exit_deep_sleep = NULL;
324 priv->reset_deep_sleep_wakeup = NULL;
326 if (machine_is_olpc())
327 priv->reset_card = if_usb_reset_olpc_card;
330 cardp->boot2_version = udev->descriptor.bcdDevice;
332 if_usb_submit_rx_urb(cardp);
334 if (lbs_start_card(priv))
337 if_usb_setup_firmware(priv);
340 usb_set_intfdata(intf, cardp);
342 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_fw))
343 lbs_pr_err("cannot register lbs_flash_fw attribute\n");
345 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2))
346 lbs_pr_err("cannot register lbs_flash_boot2 attribute\n");
351 lbs_remove_card(priv);
353 if_usb_reset_device(cardp);
362 * @brief free resource and cleanup
363 * @param intf USB interface structure
366 static void if_usb_disconnect(struct usb_interface *intf)
368 struct if_usb_card *cardp = usb_get_intfdata(intf);
369 struct lbs_private *priv = (struct lbs_private *) cardp->priv;
371 lbs_deb_enter(LBS_DEB_MAIN);
373 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2);
374 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_fw);
376 cardp->surprise_removed = 1;
379 priv->surpriseremoved = 1;
381 lbs_remove_card(priv);
384 /* Unlink and free urb */
387 usb_set_intfdata(intf, NULL);
388 usb_put_dev(interface_to_usbdev(intf));
390 lbs_deb_leave(LBS_DEB_MAIN);
394 * @brief This function download FW
395 * @param priv pointer to struct lbs_private
398 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
400 struct fwdata *fwdata = cardp->ep_out_buf;
401 const uint8_t *firmware = cardp->fw->data;
403 /* If we got a CRC failure on the last block, back
405 if (!cardp->CRC_OK) {
406 cardp->totalbytes = cardp->fwlastblksent;
410 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
413 /* struct fwdata (which we sent to the card) has an
414 extra __le32 field in between the header and the data,
415 which is not in the struct fwheader in the actual
416 firmware binary. Insert the seqnum in the middle... */
417 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
418 sizeof(struct fwheader));
420 cardp->fwlastblksent = cardp->totalbytes;
421 cardp->totalbytes += sizeof(struct fwheader);
423 memcpy(fwdata->data, &firmware[cardp->totalbytes],
424 le32_to_cpu(fwdata->hdr.datalength));
426 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
427 le32_to_cpu(fwdata->hdr.datalength));
429 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
430 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
432 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
433 le32_to_cpu(fwdata->hdr.datalength));
435 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
436 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
437 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
438 cardp->fwseqnum, cardp->totalbytes);
439 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
440 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
441 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
443 cardp->fwfinalblk = 1;
446 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
452 static int if_usb_reset_device(struct if_usb_card *cardp)
454 struct cmd_header *cmd = cardp->ep_out_buf + 4;
457 lbs_deb_enter(LBS_DEB_USB);
459 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
461 cmd->command = cpu_to_le16(CMD_802_11_RESET);
462 cmd->size = cpu_to_le16(sizeof(cmd));
463 cmd->result = cpu_to_le16(0);
464 cmd->seqnum = cpu_to_le16(0x5a5a);
465 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
468 ret = usb_reset_device(cardp->udev);
472 if (ret && machine_is_olpc())
473 if_usb_reset_olpc_card(NULL);
476 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
482 * @brief This function transfer the data to the device.
483 * @param priv pointer to struct lbs_private
484 * @param payload pointer to payload data
485 * @param nb data length
488 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
492 /* check if device is removed */
493 if (cardp->surprise_removed) {
494 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
498 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
499 usb_sndbulkpipe(cardp->udev,
501 payload, nb, if_usb_write_bulk_callback, cardp);
503 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
505 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
506 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
509 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
517 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
518 void (*callbackfn)(struct urb *urb))
523 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
524 lbs_pr_err("No free skb\n");
530 /* Fill the receive configuration URB and initialise the Rx call back */
531 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
532 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
533 skb->data + IPFIELD_ALIGN_OFFSET,
534 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
537 cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
539 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
540 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
541 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
543 cardp->rx_skb = NULL;
546 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
554 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
556 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
559 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
561 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
564 static void if_usb_receive_fwload(struct urb *urb)
566 struct if_usb_card *cardp = urb->context;
567 struct sk_buff *skb = cardp->rx_skb;
568 struct fwsyncheader *syncfwheader;
569 struct bootcmdresp bootcmdresp;
572 lbs_deb_usbd(&cardp->udev->dev,
573 "URB status is failed during fw load\n");
578 if (cardp->fwdnldover) {
579 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
581 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
582 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
583 lbs_pr_info("Firmware ready event received\n");
584 wake_up(&cardp->fw_wq);
586 lbs_deb_usb("Waiting for confirmation; got %x %x\n",
587 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
588 if_usb_submit_rx_urb_fwload(cardp);
593 if (cardp->bootcmdresp <= 0) {
594 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
595 sizeof(bootcmdresp));
597 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
599 if_usb_submit_rx_urb_fwload(cardp);
600 cardp->bootcmdresp = BOOT_CMD_RESP_OK;
601 lbs_deb_usbd(&cardp->udev->dev,
602 "Received valid boot command response\n");
605 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
606 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
607 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
608 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
609 if (!cardp->bootcmdresp)
610 lbs_pr_info("Firmware already seems alive; resetting\n");
611 cardp->bootcmdresp = -1;
613 lbs_pr_info("boot cmd response wrong magic number (0x%x)\n",
614 le32_to_cpu(bootcmdresp.magic));
616 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
617 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
618 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
619 lbs_pr_info("boot cmd response cmd_tag error (%d)\n",
621 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
622 lbs_pr_info("boot cmd response result error (%d)\n",
625 cardp->bootcmdresp = 1;
626 lbs_deb_usbd(&cardp->udev->dev,
627 "Received valid boot command response\n");
630 if_usb_submit_rx_urb_fwload(cardp);
634 syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET,
635 sizeof(struct fwsyncheader), GFP_ATOMIC);
637 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
642 if (!syncfwheader->cmd) {
643 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
644 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
645 le32_to_cpu(syncfwheader->seqnum));
648 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
654 /* Give device 5s to either write firmware to its RAM or eeprom */
655 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
657 if (cardp->fwfinalblk) {
658 cardp->fwdnldover = 1;
662 if_usb_send_fw_pkt(cardp);
665 if_usb_submit_rx_urb_fwload(cardp);
670 #define MRVDRV_MIN_PKT_LEN 30
672 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
673 struct if_usb_card *cardp,
674 struct lbs_private *priv)
676 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
677 || recvlength < MRVDRV_MIN_PKT_LEN) {
678 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
683 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
684 skb_put(skb, recvlength);
685 skb_pull(skb, MESSAGE_HEADER_LEN);
687 lbs_process_rxed_packet(priv, skb);
690 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
692 struct if_usb_card *cardp,
693 struct lbs_private *priv)
697 if (recvlength > LBS_CMD_BUFFER_SIZE) {
698 lbs_deb_usbd(&cardp->udev->dev,
699 "The receive buffer is too large\n");
704 BUG_ON(!in_interrupt());
706 spin_lock(&priv->driver_lock);
708 i = (priv->resp_idx == 0) ? 1 : 0;
709 BUG_ON(priv->resp_len[i]);
710 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN);
711 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN,
714 lbs_notify_command_response(priv, i);
716 spin_unlock(&priv->driver_lock);
718 lbs_deb_usbd(&cardp->udev->dev,
719 "Wake up main thread to handle cmd response\n");
723 * @brief This function reads of the packet into the upload buff,
724 * wake up the main thread and initialise the Rx callack.
726 * @param urb pointer to struct urb
729 static void if_usb_receive(struct urb *urb)
731 struct if_usb_card *cardp = urb->context;
732 struct sk_buff *skb = cardp->rx_skb;
733 struct lbs_private *priv = cardp->priv;
734 int recvlength = urb->actual_length;
735 uint8_t *recvbuff = NULL;
736 uint32_t recvtype = 0;
737 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
740 lbs_deb_enter(LBS_DEB_USB);
744 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
750 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
751 recvtype = le32_to_cpu(pkt[0]);
752 lbs_deb_usbd(&cardp->udev->dev,
753 "Recv length = 0x%x, Recv type = 0x%X\n",
754 recvlength, recvtype);
755 } else if (urb->status) {
762 process_cmdtypedata(recvlength, skb, cardp, priv);
765 case CMD_TYPE_REQUEST:
766 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
769 case CMD_TYPE_INDICATION:
771 event = le32_to_cpu(pkt[1]);
772 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event);
775 /* Icky undocumented magic special case */
776 if (event & 0xffff0000) {
777 u32 trycount = (event & 0xffff0000) >> 16;
779 lbs_send_tx_feedback(priv, trycount);
781 lbs_queue_event(priv, event & 0xFF);
785 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
792 if_usb_submit_rx_urb(cardp);
794 lbs_deb_leave(LBS_DEB_USB);
798 * @brief This function downloads data to FW
799 * @param priv pointer to struct lbs_private structure
800 * @param type type of data
801 * @param buf pointer to data buffer
802 * @param len number of bytes
805 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
806 uint8_t *payload, uint16_t nb)
808 struct if_usb_card *cardp = priv->card;
810 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
811 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
813 if (type == MVMS_CMD) {
814 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
815 priv->dnld_sent = DNLD_CMD_SENT;
817 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
818 priv->dnld_sent = DNLD_DATA_SENT;
821 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
823 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN);
827 * @brief This function issues Boot command to the Boot2 code
828 * @param ivalue 1:Boot from FW by USB-Download
829 * 2:Boot from FW in EEPROM
832 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
834 struct bootcmd *bootcmd = cardp->ep_out_buf;
836 /* Prepare command */
837 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
838 bootcmd->cmd = ivalue;
839 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
842 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd));
849 * @brief This function checks the validity of Boot2/FW image.
851 * @param data pointer to image
855 static int check_fwfile_format(const uint8_t *data, uint32_t totlen)
857 uint32_t bincmd, exit;
858 uint32_t blksize, offset, len;
865 struct fwheader *fwh = (void *)data;
867 bincmd = le32_to_cpu(fwh->dnldcmd);
868 blksize = le32_to_cpu(fwh->datalength);
870 case FW_HAS_DATA_TO_RECV:
871 offset = sizeof(struct fwheader) + blksize;
877 case FW_HAS_LAST_BLOCK:
888 lbs_pr_err("firmware file format check FAIL\n");
890 lbs_deb_fw("firmware file format check PASS\n");
897 * @brief This function programs the firmware subject to cmd
899 * @param cardp the if_usb_card descriptor
900 * fwname firmware or boot2 image file name
901 * cmd either BOOT_CMD_FW_BY_USB, BOOT_CMD_UPDATE_FW,
902 * or BOOT_CMD_UPDATE_BOOT2.
903 * @return 0 or error code
905 static int if_usb_prog_firmware(struct if_usb_card *cardp,
906 const char *fwname, int cmd)
908 struct lbs_private *priv = cardp->priv;
909 unsigned long flags, caps;
912 caps = priv->fwcapinfo;
913 if (((cmd == BOOT_CMD_UPDATE_FW) && !(caps & FW_CAPINFO_FIRMWARE_UPGRADE)) ||
914 ((cmd == BOOT_CMD_UPDATE_BOOT2) && !(caps & FW_CAPINFO_BOOT2_UPGRADE)))
917 /* Ensure main thread is idle. */
918 spin_lock_irqsave(&priv->driver_lock, flags);
919 while (priv->cur_cmd != NULL || priv->dnld_sent != DNLD_RES_RECEIVED) {
920 spin_unlock_irqrestore(&priv->driver_lock, flags);
921 if (wait_event_interruptible(priv->waitq,
922 (priv->cur_cmd == NULL &&
923 priv->dnld_sent == DNLD_RES_RECEIVED))) {
926 spin_lock_irqsave(&priv->driver_lock, flags);
928 priv->dnld_sent = DNLD_BOOTCMD_SENT;
929 spin_unlock_irqrestore(&priv->driver_lock, flags);
931 ret = __if_usb_prog_firmware(cardp, fwname, cmd);
933 spin_lock_irqsave(&priv->driver_lock, flags);
934 priv->dnld_sent = DNLD_RES_RECEIVED;
935 spin_unlock_irqrestore(&priv->driver_lock, flags);
937 wake_up_interruptible(&priv->waitq);
942 /* table of firmware file names */
943 static const struct {
947 { MODEL_8388, "libertas/usb8388_v9.bin" },
948 { MODEL_8388, "libertas/usb8388_v5.bin" },
949 { MODEL_8388, "libertas/usb8388.bin" },
950 { MODEL_8388, "usb8388.bin" },
951 { MODEL_8682, "libertas/usb8682.bin" }
954 static int get_fw(struct if_usb_card *cardp, const char *fwname)
958 /* Try user-specified firmware first */
960 return request_firmware(&cardp->fw, fwname, &cardp->udev->dev);
962 /* Otherwise search for firmware to use */
963 for (i = 0; i < ARRAY_SIZE(fw_table); i++) {
964 if (fw_table[i].model != cardp->model)
966 if (request_firmware(&cardp->fw, fw_table[i].fwname,
967 &cardp->udev->dev) == 0)
974 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
975 const char *fwname, int cmd)
978 static int reset_count = 10;
981 lbs_deb_enter(LBS_DEB_USB);
983 ret = get_fw(cardp, fwname);
985 lbs_pr_err("failed to find firmware (%d)\n", ret);
989 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) {
994 /* Cancel any pending usb business */
995 usb_kill_urb(cardp->rx_urb);
996 usb_kill_urb(cardp->tx_urb);
998 cardp->fwlastblksent = 0;
999 cardp->fwdnldover = 0;
1000 cardp->totalbytes = 0;
1001 cardp->fwfinalblk = 0;
1002 cardp->bootcmdresp = 0;
1005 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
1006 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
1011 cardp->bootcmdresp = 0;
1015 if_usb_issue_boot_command(cardp, cmd);
1016 /* wait for command response */
1019 msleep_interruptible(100);
1020 } while (cardp->bootcmdresp == 0 && j < 10);
1021 } while (cardp->bootcmdresp == 0 && i < 5);
1023 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) {
1024 /* Return to normal operation */
1026 usb_kill_urb(cardp->rx_urb);
1027 usb_kill_urb(cardp->tx_urb);
1028 if (if_usb_submit_rx_urb(cardp) < 0)
1031 } else if (cardp->bootcmdresp <= 0) {
1032 if (--reset_count >= 0) {
1033 if_usb_reset_device(cardp);
1042 cardp->totalbytes = 0;
1043 cardp->fwlastblksent = 0;
1045 cardp->fwdnldover = 0;
1046 cardp->fwseqnum = -1;
1047 cardp->totalbytes = 0;
1048 cardp->fwfinalblk = 0;
1050 /* Send the first firmware packet... */
1051 if_usb_send_fw_pkt(cardp);
1053 /* ... and wait for the process to complete */
1054 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover);
1056 del_timer_sync(&cardp->fw_timeout);
1057 usb_kill_urb(cardp->rx_urb);
1059 if (!cardp->fwdnldover) {
1060 lbs_pr_info("failed to load fw, resetting device!\n");
1061 if (--reset_count >= 0) {
1062 if_usb_reset_device(cardp);
1066 lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
1072 release_firmware(cardp->fw);
1076 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
1082 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
1084 struct if_usb_card *cardp = usb_get_intfdata(intf);
1085 struct lbs_private *priv = cardp->priv;
1088 lbs_deb_enter(LBS_DEB_USB);
1090 if (priv->psstate != PS_STATE_FULL_POWER)
1093 if (priv->wol_criteria == EHS_REMOVE_WAKEUP) {
1094 lbs_pr_info("Suspend attempt without "
1095 "configuring wake params!\n");
1099 ret = lbs_suspend(priv);
1103 /* Unlink tx & rx urb */
1104 usb_kill_urb(cardp->tx_urb);
1105 usb_kill_urb(cardp->rx_urb);
1108 lbs_deb_leave(LBS_DEB_USB);
1112 static int if_usb_resume(struct usb_interface *intf)
1114 struct if_usb_card *cardp = usb_get_intfdata(intf);
1115 struct lbs_private *priv = cardp->priv;
1117 lbs_deb_enter(LBS_DEB_USB);
1119 if_usb_submit_rx_urb(cardp);
1123 lbs_deb_leave(LBS_DEB_USB);
1127 #define if_usb_suspend NULL
1128 #define if_usb_resume NULL
1131 static struct usb_driver if_usb_driver = {
1133 .probe = if_usb_probe,
1134 .disconnect = if_usb_disconnect,
1135 .id_table = if_usb_table,
1136 .suspend = if_usb_suspend,
1137 .resume = if_usb_resume,
1138 .reset_resume = if_usb_resume,
1141 static int __init if_usb_init_module(void)
1145 lbs_deb_enter(LBS_DEB_MAIN);
1147 ret = usb_register(&if_usb_driver);
1149 lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
1153 static void __exit if_usb_exit_module(void)
1155 lbs_deb_enter(LBS_DEB_MAIN);
1157 usb_deregister(&if_usb_driver);
1159 lbs_deb_leave(LBS_DEB_MAIN);
1162 module_init(if_usb_init_module);
1163 module_exit(if_usb_exit_module);
1165 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1166 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1167 MODULE_LICENSE("GPL");