2 * Copyright (C) 2008, cozybit Inc.
3 * Copyright (C) 2003-2006, Marvell International Ltd.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or (at
8 * your option) any later version.
10 #include <linux/delay.h>
11 #include <linux/moduleparam.h>
12 #include <linux/firmware.h>
13 #include <linux/netdevice.h>
14 #include <linux/slab.h>
15 #include <linux/usb.h>
17 #define DRV_NAME "lbtf_usb"
19 #include "libertas_tf.h"
22 #define MESSAGE_HEADER_LEN 4
24 static char *lbtf_fw_name = "lbtf_usb.bin";
25 module_param_named(fw_name, lbtf_fw_name, charp, 0644);
27 MODULE_FIRMWARE("lbtf_usb.bin");
29 static struct usb_device_id if_usb_table[] = {
30 /* Enter the device signature inside */
31 { USB_DEVICE(0x1286, 0x2001) },
32 { USB_DEVICE(0x05a3, 0x8388) },
33 {} /* Terminating entry */
36 MODULE_DEVICE_TABLE(usb, if_usb_table);
38 static void if_usb_receive(struct urb *urb);
39 static void if_usb_receive_fwload(struct urb *urb);
40 static int if_usb_prog_firmware(struct if_usb_card *cardp);
41 static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,
42 uint8_t *payload, uint16_t nb);
43 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
44 uint16_t nb, u8 data);
45 static void if_usb_free(struct if_usb_card *cardp);
46 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
47 static int if_usb_reset_device(struct if_usb_card *cardp);
50 * if_usb_wrike_bulk_callback - call back to handle URB status
52 * @param urb pointer to urb structure
54 static void if_usb_write_bulk_callback(struct urb *urb)
57 printk(KERN_INFO "libertastf: URB in failure status: %d\n",
62 * if_usb_free - free tx/rx urb, skb and rx buffer
64 * @param cardp pointer if_usb_card
66 static void if_usb_free(struct if_usb_card *cardp)
68 /* Unlink tx & rx urb */
69 usb_kill_urb(cardp->tx_urb);
70 usb_kill_urb(cardp->rx_urb);
71 usb_kill_urb(cardp->cmd_urb);
73 usb_free_urb(cardp->tx_urb);
76 usb_free_urb(cardp->rx_urb);
79 usb_free_urb(cardp->cmd_urb);
80 cardp->cmd_urb = NULL;
82 kfree(cardp->ep_out_buf);
83 cardp->ep_out_buf = NULL;
86 static void if_usb_setup_firmware(struct lbtf_private *priv)
88 struct if_usb_card *cardp = priv->card;
89 struct cmd_ds_set_boot2_ver b2_cmd;
91 if_usb_submit_rx_urb(cardp);
92 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
94 b2_cmd.version = cardp->boot2_version;
96 if (lbtf_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
97 printk(KERN_INFO "libertastf: setting boot2 version failed\n");
100 static void if_usb_fw_timeo(unsigned long priv)
102 struct if_usb_card *cardp = (void *)priv;
104 if (!cardp->fwdnldover)
105 /* Download timed out */
106 cardp->priv->surpriseremoved = 1;
107 wake_up(&cardp->fw_wq);
111 * if_usb_probe - sets the configuration values
113 * @ifnum interface number
114 * @id pointer to usb_device_id
116 * Returns: 0 on success, error code on failure
118 static int if_usb_probe(struct usb_interface *intf,
119 const struct usb_device_id *id)
121 struct usb_device *udev;
122 struct usb_host_interface *iface_desc;
123 struct usb_endpoint_descriptor *endpoint;
124 struct lbtf_private *priv;
125 struct if_usb_card *cardp;
128 udev = interface_to_usbdev(intf);
130 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
134 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
135 init_waitqueue_head(&cardp->fw_wq);
138 iface_desc = intf->cur_altsetting;
140 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
141 endpoint = &iface_desc->endpoint[i].desc;
142 if (usb_endpoint_is_bulk_in(endpoint)) {
144 le16_to_cpu(endpoint->wMaxPacketSize);
145 cardp->ep_in = usb_endpoint_num(endpoint);
146 } else if (usb_endpoint_is_bulk_out(endpoint)) {
148 le16_to_cpu(endpoint->wMaxPacketSize);
149 cardp->ep_out = usb_endpoint_num(endpoint);
152 if (!cardp->ep_out_size || !cardp->ep_in_size)
153 /* Endpoints not found */
156 cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
160 cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
164 cardp->cmd_urb = usb_alloc_urb(0, GFP_KERNEL);
168 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE,
170 if (!cardp->ep_out_buf)
173 priv = lbtf_add_card(cardp, &udev->dev);
179 priv->hw_host_to_card = if_usb_host_to_card;
180 priv->hw_prog_firmware = if_usb_prog_firmware;
181 priv->hw_reset_device = if_usb_reset_device;
182 cardp->boot2_version = udev->descriptor.bcdDevice;
185 usb_set_intfdata(intf, cardp);
196 * if_usb_disconnect - free resource and cleanup
198 * @intf USB interface structure
200 static void if_usb_disconnect(struct usb_interface *intf)
202 struct if_usb_card *cardp = usb_get_intfdata(intf);
203 struct lbtf_private *priv = (struct lbtf_private *) cardp->priv;
205 if_usb_reset_device(cardp);
208 lbtf_remove_card(priv);
210 /* Unlink and free urb */
213 usb_set_intfdata(intf, NULL);
214 usb_put_dev(interface_to_usbdev(intf));
218 * if_usb_send_fw_pkt - This function downloads the FW
220 * @priv pointer to struct lbtf_private
224 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
226 struct fwdata *fwdata = cardp->ep_out_buf;
227 u8 *firmware = (u8 *) cardp->fw->data;
229 /* If we got a CRC failure on the last block, back
231 if (!cardp->CRC_OK) {
232 cardp->totalbytes = cardp->fwlastblksent;
236 /* struct fwdata (which we sent to the card) has an
237 extra __le32 field in between the header and the data,
238 which is not in the struct fwheader in the actual
239 firmware binary. Insert the seqnum in the middle... */
240 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
241 sizeof(struct fwheader));
243 cardp->fwlastblksent = cardp->totalbytes;
244 cardp->totalbytes += sizeof(struct fwheader);
246 memcpy(fwdata->data, &firmware[cardp->totalbytes],
247 le32_to_cpu(fwdata->hdr.datalength));
249 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
250 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
252 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
253 le32_to_cpu(fwdata->hdr.datalength), 0);
255 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK))
256 /* Host has finished FW downloading
257 * Donwloading FW JUMP BLOCK
259 cardp->fwfinalblk = 1;
264 static int if_usb_reset_device(struct if_usb_card *cardp)
266 struct cmd_ds_802_11_reset *cmd = cardp->ep_out_buf + 4;
269 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
271 cmd->hdr.command = cpu_to_le16(CMD_802_11_RESET);
272 cmd->hdr.size = cpu_to_le16(sizeof(struct cmd_ds_802_11_reset));
273 cmd->hdr.result = cpu_to_le16(0);
274 cmd->hdr.seqnum = cpu_to_le16(0x5a5a);
275 cmd->action = cpu_to_le16(CMD_ACT_HALT);
276 usb_tx_block(cardp, cardp->ep_out_buf,
277 4 + sizeof(struct cmd_ds_802_11_reset), 0);
280 ret = usb_reset_device(cardp->udev);
285 EXPORT_SYMBOL_GPL(if_usb_reset_device);
288 * usb_tx_block - transfer data to the device
290 * @priv pointer to struct lbtf_private
291 * @payload pointer to payload data
293 * @data non-zero for data, zero for commands
295 * Returns: 0 on success, nonzero otherwise.
297 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
298 uint16_t nb, u8 data)
302 /* check if device is removed */
303 if (cardp->priv->surpriseremoved)
309 urb = cardp->cmd_urb;
311 usb_fill_bulk_urb(urb, cardp->udev,
312 usb_sndbulkpipe(cardp->udev,
314 payload, nb, if_usb_write_bulk_callback, cardp);
316 urb->transfer_flags |= URB_ZERO_PACKET;
318 if (usb_submit_urb(urb, GFP_ATOMIC))
323 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
324 void (*callbackfn)(struct urb *urb))
328 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
334 /* Fill the receive configuration URB and initialise the Rx call back */
335 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
336 usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
337 skb_tail_pointer(skb),
338 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn, cardp);
340 cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
342 if (usb_submit_urb(cardp->rx_urb, GFP_ATOMIC)) {
344 cardp->rx_skb = NULL;
350 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
352 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
355 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
357 return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
360 static void if_usb_receive_fwload(struct urb *urb)
362 struct if_usb_card *cardp = urb->context;
363 struct sk_buff *skb = cardp->rx_skb;
364 struct fwsyncheader *syncfwheader;
365 struct bootcmdresp bcmdresp;
372 if (cardp->fwdnldover) {
373 __le32 *tmp = (__le32 *)(skb->data);
375 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
376 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY))
377 /* Firmware ready event received */
378 wake_up(&cardp->fw_wq);
380 if_usb_submit_rx_urb_fwload(cardp);
384 if (cardp->bootcmdresp <= 0) {
385 memcpy(&bcmdresp, skb->data, sizeof(bcmdresp));
387 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
389 if_usb_submit_rx_urb_fwload(cardp);
390 cardp->bootcmdresp = 1;
391 /* Received valid boot command response */
394 if (bcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
395 if (bcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
396 bcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
397 bcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION))
398 cardp->bootcmdresp = -1;
399 } else if (bcmdresp.cmd == BOOT_CMD_FW_BY_USB &&
400 bcmdresp.result == BOOT_CMD_RESP_OK)
401 cardp->bootcmdresp = 1;
404 if_usb_submit_rx_urb_fwload(cardp);
408 syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
414 memcpy(syncfwheader, skb->data, sizeof(struct fwsyncheader));
416 if (!syncfwheader->cmd)
422 /* reschedule timer for 200ms hence */
423 mod_timer(&cardp->fw_timeout, jiffies + (HZ/5));
425 if (cardp->fwfinalblk) {
426 cardp->fwdnldover = 1;
430 if_usb_send_fw_pkt(cardp);
433 if_usb_submit_rx_urb_fwload(cardp);
440 #define MRVDRV_MIN_PKT_LEN 30
442 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
443 struct if_usb_card *cardp,
444 struct lbtf_private *priv)
446 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
447 || recvlength < MRVDRV_MIN_PKT_LEN) {
452 skb_put(skb, recvlength);
453 skb_pull(skb, MESSAGE_HEADER_LEN);
457 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
459 struct if_usb_card *cardp,
460 struct lbtf_private *priv)
462 if (recvlength > LBS_CMD_BUFFER_SIZE) {
467 BUG_ON(!in_interrupt());
469 spin_lock(&priv->driver_lock);
470 memcpy(priv->cmd_resp_buff, recvbuff + MESSAGE_HEADER_LEN,
471 recvlength - MESSAGE_HEADER_LEN);
473 lbtf_cmd_response_rx(priv);
474 spin_unlock(&priv->driver_lock);
478 * if_usb_receive - read data received from the device.
480 * @urb pointer to struct urb
482 static void if_usb_receive(struct urb *urb)
484 struct if_usb_card *cardp = urb->context;
485 struct sk_buff *skb = cardp->rx_skb;
486 struct lbtf_private *priv = cardp->priv;
487 int recvlength = urb->actual_length;
488 uint8_t *recvbuff = NULL;
489 uint32_t recvtype = 0;
490 __le32 *pkt = (__le32 *) skb->data;
498 recvbuff = skb->data;
499 recvtype = le32_to_cpu(pkt[0]);
500 } else if (urb->status) {
507 process_cmdtypedata(recvlength, skb, cardp, priv);
510 case CMD_TYPE_REQUEST:
511 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
514 case CMD_TYPE_INDICATION:
516 /* Event cause handling */
517 u32 event_cause = le32_to_cpu(pkt[1]);
519 /* Icky undocumented magic special case */
520 if (event_cause & 0xffff0000) {
525 tmp = event_cause >> 16;
526 retrycnt = tmp & 0x00ff;
527 failure = (tmp & 0xff00) >> 8;
528 lbtf_send_tx_feedback(priv, retrycnt, failure);
529 } else if (event_cause == LBTF_EVENT_BCN_SENT)
533 "Unsupported notification %d received\n",
539 printk(KERN_DEBUG "libertastf: unknown command type 0x%X\n",
546 if_usb_submit_rx_urb(cardp);
550 * if_usb_host_to_card - Download data to the device
552 * @priv pointer to struct lbtf_private structure
554 * @buf pointer to data buffer
555 * @len number of bytes
557 * Returns: 0 on success, nonzero otherwise
559 static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,
560 uint8_t *payload, uint16_t nb)
562 struct if_usb_card *cardp = priv->card;
565 if (type == MVMS_CMD) {
566 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
568 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
572 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
574 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN,
579 * if_usb_issue_boot_command - Issue boot command to Boot2.
581 * @ivalue 1 boots from FW by USB-Download, 2 boots from FW in EEPROM.
585 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
587 struct bootcmd *bootcmd = cardp->ep_out_buf;
589 /* Prepare command */
590 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
591 bootcmd->cmd = ivalue;
592 memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
595 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd), 0);
602 * check_fwfile_format - Check the validity of Boot2/FW image.
604 * @data pointer to image
605 * @totlen image length
607 * Returns: 0 if the image is valid, nonzero otherwise.
609 static int check_fwfile_format(const u8 *data, u32 totlen)
612 u32 blksize, offset, len;
619 struct fwheader *fwh = (void *) data;
621 bincmd = le32_to_cpu(fwh->dnldcmd);
622 blksize = le32_to_cpu(fwh->datalength);
624 case FW_HAS_DATA_TO_RECV:
625 offset = sizeof(struct fwheader) + blksize;
631 case FW_HAS_LAST_BLOCK:
643 "libertastf: firmware file format check failed\n");
648 static int if_usb_prog_firmware(struct if_usb_card *cardp)
651 static int reset_count = 10;
654 ret = request_firmware(&cardp->fw, lbtf_fw_name, &cardp->udev->dev);
656 printk(KERN_INFO "libertastf: firmware %s not found\n",
661 if (check_fwfile_format(cardp->fw->data, cardp->fw->size))
665 if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
670 cardp->bootcmdresp = 0;
674 /* Issue Boot command = 1, Boot from Download-FW */
675 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
676 /* wait for command response */
679 msleep_interruptible(100);
680 } while (cardp->bootcmdresp == 0 && j < 10);
681 } while (cardp->bootcmdresp == 0 && i < 5);
683 if (cardp->bootcmdresp <= 0) {
684 if (--reset_count >= 0) {
685 if_usb_reset_device(cardp);
693 cardp->totalbytes = 0;
694 cardp->fwlastblksent = 0;
696 cardp->fwdnldover = 0;
697 cardp->fwseqnum = -1;
698 cardp->totalbytes = 0;
699 cardp->fwfinalblk = 0;
701 /* Send the first firmware packet... */
702 if_usb_send_fw_pkt(cardp);
704 /* ... and wait for the process to complete */
705 wait_event_interruptible(cardp->fw_wq, cardp->priv->surpriseremoved ||
708 del_timer_sync(&cardp->fw_timeout);
709 usb_kill_urb(cardp->rx_urb);
711 if (!cardp->fwdnldover) {
712 printk(KERN_INFO "libertastf: failed to load fw,"
713 " resetting device!\n");
714 if (--reset_count >= 0) {
715 if_usb_reset_device(cardp);
719 printk(KERN_INFO "libertastf: fw download failure\n");
724 cardp->priv->fw_ready = 1;
727 release_firmware(cardp->fw);
730 if_usb_setup_firmware(cardp->priv);
735 EXPORT_SYMBOL_GPL(if_usb_prog_firmware);
738 #define if_usb_suspend NULL
739 #define if_usb_resume NULL
741 static struct usb_driver if_usb_driver = {
743 .probe = if_usb_probe,
744 .disconnect = if_usb_disconnect,
745 .id_table = if_usb_table,
746 .suspend = if_usb_suspend,
747 .resume = if_usb_resume,
750 static int __init if_usb_init_module(void)
754 ret = usb_register(&if_usb_driver);
758 static void __exit if_usb_exit_module(void)
760 usb_deregister(&if_usb_driver);
763 module_init(if_usb_init_module);
764 module_exit(if_usb_exit_module);
766 MODULE_DESCRIPTION("8388 USB WLAN Thinfirm Driver");
767 MODULE_AUTHOR("Cozybit Inc.");
768 MODULE_LICENSE("GPL");