libertas_tf: usb specific functions

/*

 *  Copyright (C) 2008, cozybit Inc.

 *  Copyright (C) 2003-2006, Marvell International Ltd.

 *

 *  This program is free software; you can redistribute it and/or modify

 *  it under the terms of the GNU General Public License as published by

 *  the Free Software Foundation; either version 2 of the License, or (at

 *  your option) any later version.

 */

#include <linux/delay.h>

#include <linux/moduleparam.h>

#include <linux/firmware.h>

#include <linux/netdevice.h>

#include <linux/usb.h>

#define DRV_NAME "lbtf_usb"

#include "libertas_tf.h"

#include "if_usb.h"

#define MESSAGE_HEADER_LEN	4

static char *lbtf_fw_name = "lbtf_usb.bin";

module_param_named(fw_name, lbtf_fw_name, charp, 0644);

static struct usb_device_id if_usb_table[] = {

	/* Enter the device signature inside */

	{ USB_DEVICE(0x1286, 0x2001) },

	{ USB_DEVICE(0x05a3, 0x8388) },

	{}	/* Terminating entry */

};

MODULE_DEVICE_TABLE(usb, if_usb_table);

static void if_usb_receive(struct urb *urb);

static void if_usb_receive_fwload(struct urb *urb);

static int if_usb_prog_firmware(struct if_usb_card *cardp);

static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,

			       uint8_t *payload, uint16_t nb);

static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,

			uint16_t nb, u8 data);

static void if_usb_free(struct if_usb_card *cardp);

static int if_usb_submit_rx_urb(struct if_usb_card *cardp);

static int if_usb_reset_device(struct if_usb_card *cardp);

/**

 *  if_usb_wrike_bulk_callback -  call back to handle URB status

 *

 *  @param urb 		pointer to urb structure

 */

static void if_usb_write_bulk_callback(struct urb *urb)

{

	if (urb->status != 0)

		printk(KERN_INFO "libertastf: URB in failure status: %d\n",

		       urb->status);

}

/**

 *  if_usb_free - free tx/rx urb, skb and rx buffer

 *

 *  @param cardp	pointer if_usb_card

 */

static void if_usb_free(struct if_usb_card *cardp)

{

	/* Unlink tx & rx urb */

	usb_kill_urb(cardp->tx_urb);

	usb_kill_urb(cardp->rx_urb);

	usb_kill_urb(cardp->cmd_urb);

	usb_free_urb(cardp->tx_urb);

	cardp->tx_urb = NULL;

	usb_free_urb(cardp->rx_urb);

	cardp->rx_urb = NULL;

	usb_free_urb(cardp->cmd_urb);

	cardp->cmd_urb = NULL;

	kfree(cardp->ep_out_buf);

	cardp->ep_out_buf = NULL;

}

static void if_usb_setup_firmware(struct lbtf_private *priv)

{

	struct if_usb_card *cardp = priv->card;

	struct cmd_ds_set_boot2_ver b2_cmd;

	if_usb_submit_rx_urb(cardp);

	b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));

	b2_cmd.action = 0;

	b2_cmd.version = cardp->boot2_version;

	if (lbtf_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))

		printk(KERN_INFO "libertastf: setting boot2 version failed\n");

}

static void if_usb_fw_timeo(unsigned long priv)

{

	struct if_usb_card *cardp = (void *)priv;

	if (!cardp->fwdnldover)

		/* Download timed out */

		cardp->priv->surpriseremoved = 1;

	wake_up(&cardp->fw_wq);

}

/**

 *  if_usb_probe - sets the configuration values

 *

 *  @ifnum	interface number

 *  @id		pointer to usb_device_id

 *

 *  Returns: 0 on success, error code on failure

 */

static int if_usb_probe(struct usb_interface *intf,

			const struct usb_device_id *id)

{

	struct usb_device *udev;

	struct usb_host_interface *iface_desc;

	struct usb_endpoint_descriptor *endpoint;

	struct lbtf_private *priv;

	struct if_usb_card *cardp;

	int i;

	udev = interface_to_usbdev(intf);

	cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);

	if (!cardp)

		goto error;

	setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);

	init_waitqueue_head(&cardp->fw_wq);

	cardp->udev = udev;

	iface_desc = intf->cur_altsetting;

	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {

		endpoint = &iface_desc->endpoint[i].desc;

		if (usb_endpoint_is_bulk_in(endpoint)) {

			cardp->ep_in_size =

				le16_to_cpu(endpoint->wMaxPacketSize);

			cardp->ep_in = usb_endpoint_num(endpoint);

		} else if (usb_endpoint_is_bulk_out(endpoint)) {

			cardp->ep_out_size =

				le16_to_cpu(endpoint->wMaxPacketSize);

			cardp->ep_out = usb_endpoint_num(endpoint);

		}

	}

	if (!cardp->ep_out_size || !cardp->ep_in_size)

		/* Endpoints not found */

		goto dealloc;

	cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL);

	if (!cardp->rx_urb)

		goto dealloc;

	cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL);

	if (!cardp->tx_urb)

		goto dealloc;

	cardp->cmd_urb = usb_alloc_urb(0, GFP_KERNEL);

	if (!cardp->cmd_urb)

		goto dealloc;

	cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE,

				    GFP_KERNEL);

	if (!cardp->ep_out_buf)

		goto dealloc;

	priv = lbtf_add_card(cardp, &udev->dev);

	if (!priv)

		goto dealloc;

	cardp->priv = priv;

	priv->hw_host_to_card = if_usb_host_to_card;

	priv->hw_prog_firmware = if_usb_prog_firmware;

	priv->hw_reset_device = if_usb_reset_device;

	cardp->boot2_version = udev->descriptor.bcdDevice;

	usb_get_dev(udev);

	usb_set_intfdata(intf, cardp);

	return 0;

dealloc:

	if_usb_free(cardp);

error:

	return -ENOMEM;

}

/**

 *  if_usb_disconnect -  free resource and cleanup

 *

 *  @intf	USB interface structure

 */

static void if_usb_disconnect(struct usb_interface *intf)

{

	struct if_usb_card *cardp = usb_get_intfdata(intf);

	struct lbtf_private *priv = (struct lbtf_private *) cardp->priv;

	if_usb_reset_device(cardp);

	if (priv)

		lbtf_remove_card(priv);

	/* Unlink and free urb */

	if_usb_free(cardp);

	usb_set_intfdata(intf, NULL);

	usb_put_dev(interface_to_usbdev(intf));

}

/**

 *  if_usb_send_fw_pkt -  This function downloads the FW

 *

 *  @priv	pointer to struct lbtf_private

 *

 *  Returns: 0

 */

static int if_usb_send_fw_pkt(struct if_usb_card *cardp)

{

	struct fwdata *fwdata = cardp->ep_out_buf;

	u8 *firmware = (u8 *) cardp->fw->data;

	/* If we got a CRC failure on the last block, back

	   up and retry it */

	if (!cardp->CRC_OK) {

		cardp->totalbytes = cardp->fwlastblksent;

		cardp->fwseqnum--;

	}

	/* struct fwdata (which we sent to the card) has an

	   extra __le32 field in between the header and the data,

	   which is not in the struct fwheader in the actual

	   firmware binary. Insert the seqnum in the middle... */

	memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],

	       sizeof(struct fwheader));

	cardp->fwlastblksent = cardp->totalbytes;

	cardp->totalbytes += sizeof(struct fwheader);

	memcpy(fwdata->data, &firmware[cardp->totalbytes],

	       le32_to_cpu(fwdata->hdr.datalength));

	fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);

	cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);

	usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +

		     le32_to_cpu(fwdata->hdr.datalength), 0);

	if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK))

		/* Host has finished FW downloading

		 * Donwloading FW JUMP BLOCK

		 */

		cardp->fwfinalblk = 1;

	return 0;

}

static int if_usb_reset_device(struct if_usb_card *cardp)

{

	struct cmd_ds_802_11_reset *cmd = cardp->ep_out_buf + 4;

	int ret;

	*(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);

	cmd->hdr.command = cpu_to_le16(CMD_802_11_RESET);

	cmd->hdr.size = cpu_to_le16(sizeof(struct cmd_ds_802_11_reset));

	cmd->hdr.result = cpu_to_le16(0);

	cmd->hdr.seqnum = cpu_to_le16(0x5a5a);

	cmd->action = cpu_to_le16(CMD_ACT_HALT);

	usb_tx_block(cardp, cardp->ep_out_buf,

		     4 + sizeof(struct cmd_ds_802_11_reset), 0);

	msleep(100);

	ret = usb_reset_device(cardp->udev);

	msleep(100);

	return ret;

}

EXPORT_SYMBOL_GPL(if_usb_reset_device);

/**

 *  usb_tx_block - transfer data to the device

 *

 *  @priv 	pointer to struct lbtf_private

 *  @payload	pointer to payload data

 *  @nb		data length

 *  @data	non-zero for data, zero for commands

 *

 *  Returns: 0 on success, nonzero otherwise.

 */

static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,

			uint16_t nb, u8 data)

{

	struct urb *urb;

	/* check if device is removed */

	if (cardp->priv->surpriseremoved)

		return -1;

	if (data)

		urb = cardp->tx_urb;

	else

		urb = cardp->cmd_urb;

	usb_fill_bulk_urb(urb, cardp->udev,

			  usb_sndbulkpipe(cardp->udev,

					  cardp->ep_out),

			  payload, nb, if_usb_write_bulk_callback, cardp);

	urb->transfer_flags |= URB_ZERO_PACKET;

	if (usb_submit_urb(urb, GFP_ATOMIC))

		return -1;

	return 0;

}

static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,

				  void (*callbackfn)(struct urb *urb))

{

	struct sk_buff *skb;

	skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);

	if (!skb)

		return -1;

	cardp->rx_skb = skb;

	/* Fill the receive configuration URB and initialise the Rx call back */

	usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,

			  usb_rcvbulkpipe(cardp->udev, cardp->ep_in),

			  (void *) (skb->tail),

			  MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn, cardp);

	cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;

	if (usb_submit_urb(cardp->rx_urb, GFP_ATOMIC)) {

		kfree_skb(skb);

		cardp->rx_skb = NULL;

		return -1;

	} else

		return 0;

}

static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)

{

	return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);

}

static int if_usb_submit_rx_urb(struct if_usb_card *cardp)

{

	return __if_usb_submit_rx_urb(cardp, &if_usb_receive);

}

static void if_usb_receive_fwload(struct urb *urb)

{

	struct if_usb_card *cardp = urb->context;

	struct sk_buff *skb = cardp->rx_skb;

	struct fwsyncheader *syncfwheader;

	struct bootcmdresp bcmdresp;

	if (urb->status) {

		kfree_skb(skb);

		return;

	}

	if (cardp->fwdnldover) {

		__le32 *tmp = (__le32 *)(skb->data);

		if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&

		    tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY))

			/* Firmware ready event received */

			wake_up(&cardp->fw_wq);

		else

			if_usb_submit_rx_urb_fwload(cardp);

		kfree_skb(skb);

		return;

	}

	if (cardp->bootcmdresp <= 0) {

		memcpy(&bcmdresp, skb->data, sizeof(bcmdresp));

		if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {

			kfree_skb(skb);

			if_usb_submit_rx_urb_fwload(cardp);

			cardp->bootcmdresp = 1;

			/* Received valid boot command response */

			return;

		}

		if (bcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {

			if (bcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||

			    bcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||

			    bcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION))

				cardp->bootcmdresp = -1;

		} else if (bcmdresp.cmd == BOOT_CMD_FW_BY_USB &&

			   bcmdresp.result == BOOT_CMD_RESP_OK)

			cardp->bootcmdresp = 1;

		kfree_skb(skb);

		if_usb_submit_rx_urb_fwload(cardp);

		return;

	}

	syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);

	if (!syncfwheader) {

		kfree_skb(skb);

		return;

	}

	memcpy(syncfwheader, skb->data, sizeof(struct fwsyncheader));

	if (!syncfwheader->cmd)

		cardp->CRC_OK = 1;

	else

		cardp->CRC_OK = 0;

	kfree_skb(skb);

	/* reschedule timer for 200ms hence */

	mod_timer(&cardp->fw_timeout, jiffies + (HZ/5));

	if (cardp->fwfinalblk) {

		cardp->fwdnldover = 1;

		goto exit;

	}

	if_usb_send_fw_pkt(cardp);

 exit:

	if_usb_submit_rx_urb_fwload(cardp);

	kfree(syncfwheader);

	return;

}

#define MRVDRV_MIN_PKT_LEN	30

static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,

				       struct if_usb_card *cardp,

				       struct lbtf_private *priv)

{

	if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN

	    || recvlength < MRVDRV_MIN_PKT_LEN) {

		kfree_skb(skb);

		return;

	}

	skb_put(skb, recvlength);

	skb_pull(skb, MESSAGE_HEADER_LEN);

	lbtf_rx(priv, skb);

}

static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,

				      struct sk_buff *skb,

				      struct if_usb_card *cardp,

				      struct lbtf_private *priv)

{

	if (recvlength > LBS_CMD_BUFFER_SIZE) {

		kfree_skb(skb);

		return;

	}

	if (!in_interrupt())

		BUG();

	spin_lock(&priv->driver_lock);

	memcpy(priv->cmd_resp_buff, recvbuff + MESSAGE_HEADER_LEN,

	       recvlength - MESSAGE_HEADER_LEN);

	kfree_skb(skb);

	lbtf_cmd_response_rx(priv);

	spin_unlock(&priv->driver_lock);

}

/**

 *  if_usb_receive - read data received from the device.

 *

 *  @urb		pointer to struct urb

 */

static void if_usb_receive(struct urb *urb)

{

	struct if_usb_card *cardp = urb->context;

	struct sk_buff *skb = cardp->rx_skb;

	struct lbtf_private *priv = cardp->priv;

	int recvlength = urb->actual_length;

	uint8_t *recvbuff = NULL;

	uint32_t recvtype = 0;

	__le32 *pkt = (__le32 *) skb->data;

	if (recvlength) {

		if (urb->status) {

			kfree_skb(skb);

			goto setup_for_next;

		}

		recvbuff = skb->data;

		recvtype = le32_to_cpu(pkt[0]);

	} else if (urb->status) {

		kfree_skb(skb);

		return;

	}

	switch (recvtype) {

	case CMD_TYPE_DATA:

		process_cmdtypedata(recvlength, skb, cardp, priv);

		break;

	case CMD_TYPE_REQUEST:

		process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);

		break;

	case CMD_TYPE_INDICATION:

	{

		/* Event cause handling */

		u32 event_cause = le32_to_cpu(pkt[1]);

		/* Icky undocumented magic special case */

		if (event_cause & 0xffff0000) {

			u16 tmp;

			u8 retrycnt;

			u8 failure;

			tmp = event_cause >> 16;

			retrycnt = tmp & 0x00ff;

			failure = (tmp & 0xff00) >> 8;

			lbtf_send_tx_feedback(priv, retrycnt, failure);

		} else if (event_cause == LBTF_EVENT_BCN_SENT)

			lbtf_bcn_sent(priv);

		else

			printk(KERN_DEBUG

			       "Unsupported notification %d received\n",

			       event_cause);

		kfree_skb(skb);

		break;

	}

	default:

		printk(KERN_DEBUG "libertastf: unknown command type 0x%X\n",

			     recvtype);

		kfree_skb(skb);

		break;

	}

setup_for_next:

	if_usb_submit_rx_urb(cardp);

}

/**

 *  if_usb_host_to_card -  Download data to the device

 *

 *  @priv		pointer to struct lbtf_private structure

 *  @type		type of data

 *  @buf		pointer to data buffer

 *  @len		number of bytes

 *

 *  Returns: 0 on success, nonzero otherwise

 */

static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,

			       uint8_t *payload, uint16_t nb)

{

	struct if_usb_card *cardp = priv->card;

	u8 data = 0;

	if (type == MVMS_CMD) {

		*(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);

	} else {

		*(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);

		data = 1;

	}

	memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);

	return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN,

			    data);

}

/**

 *  if_usb_issue_boot_command - Issue boot command to Boot2.

 *

 *  @ivalue   1 boots from FW by USB-Download, 2 boots from FW in EEPROM.

 *

 *  Returns: 0

 */

static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)

{

	struct bootcmd *bootcmd = cardp->ep_out_buf;

	/* Prepare command */

	bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);

	bootcmd->cmd = ivalue;

	memset(bootcmd->pad, 0, sizeof(bootcmd->pad));

	/* Issue command */

	usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd), 0);

	return 0;

}

/**

 *  check_fwfile_format - Check the validity of Boot2/FW image.

 *

 *  @data	pointer to image

 *  @totlen	image length

 *

 *  Returns: 0 if the image is valid, nonzero otherwise.

 */

static int check_fwfile_format(const u8 *data, u32 totlen)

{

	u32 bincmd, exit;

	u32 blksize, offset, len;

	int ret;

	ret = 1;

	exit = len = 0;

	do {

		struct fwheader *fwh = (void *) data;

		bincmd = le32_to_cpu(fwh->dnldcmd);

		blksize = le32_to_cpu(fwh->datalength);

		switch (bincmd) {

		case FW_HAS_DATA_TO_RECV:

			offset = sizeof(struct fwheader) + blksize;

			data += offset;

			len += offset;

			if (len >= totlen)

				exit = 1;

			break;

		case FW_HAS_LAST_BLOCK:

			exit = 1;

			ret = 0;

			break;

		default:

			exit = 1;

			break;

		}

	} while (!exit);

	if (ret)

		printk(KERN_INFO

		       "libertastf: firmware file format check failed\n");

	return ret;

}

static int if_usb_prog_firmware(struct if_usb_card *cardp)

{

	int i = 0;

	static int reset_count = 10;

	int ret = 0;

	ret = request_firmware(&cardp->fw, lbtf_fw_name, &cardp->udev->dev);

	if (ret < 0) {

		printk(KERN_INFO "libertastf: firmware %s not found\n",

		       lbtf_fw_name);

		goto done;