[deliverable/linux.git] / drivers / net / wireless / ath / ath9k / hif_usb.h

/*
 * Copyright (c) 2010-2011 Atheros Communications Inc.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef HTC_USB_H
#define HTC_USB_H

#define MAJOR_VERSION_REQ 1
#define MINOR_VERSION_REQ 3

#define IS_AR7010_DEVICE(_v) (((_v) == AR9280_USB) || ((_v) == AR9287_USB))

#define AR9271_FIRMWARE       0x501000
#define AR9271_FIRMWARE_TEXT  0x903000
#define AR7010_FIRMWARE_TEXT  0x906000

#define FIRMWARE_DOWNLOAD       0x30
#define FIRMWARE_DOWNLOAD_COMP  0x31

#define ATH_USB_RX_STREAM_MODE_TAG 0x4e00
#define ATH_USB_TX_STREAM_MODE_TAG 0x697e

/* FIXME: Verify these numbers (with Windows) */
#define MAX_TX_URB_NUM  8
#define MAX_TX_BUF_NUM  256
#define MAX_TX_BUF_SIZE 32768
#define MAX_TX_AGGR_NUM 20

#define MAX_RX_URB_NUM  8
#define MAX_RX_BUF_SIZE 16384
#define MAX_PKT_NUM_IN_TRANSFER 10

#define MAX_REG_OUT_URB_NUM  1
#define MAX_REG_IN_URB_NUM   64

#define MAX_REG_IN_BUF_SIZE 64

/* USB Endpoint definition */
#define USB_WLAN_TX_PIPE  1
#define USB_WLAN_RX_PIPE  2
#define USB_REG_IN_PIPE   3
#define USB_REG_OUT_PIPE  4

#define HIF_USB_MAX_RXPIPES 2
#define HIF_USB_MAX_TXPIPES 4

struct tx_buf {
	u8 *buf;
	u16 len;
	u16 offset;
	struct urb *urb;
	struct sk_buff_head skb_queue;
	struct hif_device_usb *hif_dev;
	struct list_head list;
};

#define HIF_USB_TX_STOP  BIT(0)
#define HIF_USB_TX_FLUSH BIT(1)

struct hif_usb_tx {
	u8 flags;
	u8 tx_buf_cnt;
	u16 tx_skb_cnt;
	struct sk_buff_head tx_skb_queue;
	struct list_head tx_buf;
	struct list_head tx_pending;
	spinlock_t tx_lock;
};

struct cmd_buf {
	struct sk_buff *skb;
	struct hif_device_usb *hif_dev;
};

#define HIF_USB_START BIT(0)
#define HIF_USB_READY BIT(1)

struct hif_device_usb {
	struct usb_device *udev;
	struct usb_interface *interface;
	const struct usb_device_id *usb_device_id;
	const void *fw_data;
	size_t fw_size;
	struct completion fw_done;
	struct htc_target *htc_handle;
	struct hif_usb_tx tx;
	struct usb_anchor regout_submitted;
	struct usb_anchor rx_submitted;
	struct usb_anchor reg_in_submitted;
	struct usb_anchor mgmt_submitted;
	struct sk_buff *remain_skb;
	const char *fw_name;
	int rx_remain_len;
	int rx_pkt_len;
	int rx_transfer_len;
	int rx_pad_len;
	spinlock_t rx_lock;
	u8 flags; /* HIF_USB_* */
};

int ath9k_hif_usb_init(void);
void ath9k_hif_usb_exit(void);

#endif /* HTC_USB_H */
Commit	Line	Data
fb9987d0	1	/*
5b68138e	2	* Copyright (c) 2010-2011 Atheros Communications Inc.
fb9987d0 S	3	*
	4	* Permission to use, copy, modify, and/or distribute this software for any
	5	* purpose with or without fee is hereby granted, provided that the above
	6	* copyright notice and this permission notice appear in all copies.
	7	*
	8	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	9	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	10	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	11	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	12	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	13	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	14	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	15	*/
	16
	17	#ifndef HTC_USB_H
	18	#define HTC_USB_H
	19
3a0593ef	20	#define MAJOR_VERSION_REQ 1
c75197a7	21	#define MINOR_VERSION_REQ 3
3a0593ef	22
0b5ead91 SM	23	#define IS_AR7010_DEVICE(_v) (((_v) == AR9280_USB) \|\| ((_v) == AR9287_USB))
0b5ead91 SM	24
fb9987d0 S	25	#define AR9271_FIRMWARE 0x501000
fb9987d0 S	26	#define AR9271_FIRMWARE_TEXT 0x903000
b1762862	27	#define AR7010_FIRMWARE_TEXT 0x906000
fb9987d0 S	28
	29	#define FIRMWARE_DOWNLOAD 0x30
	30	#define FIRMWARE_DOWNLOAD_COMP 0x31
	31
	32	#define ATH_USB_RX_STREAM_MODE_TAG 0x4e00
	33	#define ATH_USB_TX_STREAM_MODE_TAG 0x697e
	34
	35	/* FIXME: Verify these numbers (with Windows) */
	36	#define MAX_TX_URB_NUM 8
15f6d6d5	37	#define MAX_TX_BUF_NUM 256
fb9987d0 S	38	#define MAX_TX_BUF_SIZE 32768
	39	#define MAX_TX_AGGR_NUM 20
	40
	41	#define MAX_RX_URB_NUM 8
	42	#define MAX_RX_BUF_SIZE 16384
c503269a	43	#define MAX_PKT_NUM_IN_TRANSFER 10
fb9987d0 S	44
fb9987d0 S	45	#define MAX_REG_OUT_URB_NUM 1
3deff760	46	#define MAX_REG_IN_URB_NUM 64
fb9987d0 S	47
	48	#define MAX_REG_IN_BUF_SIZE 64
	49
	50	/* USB Endpoint definition */
	51	#define USB_WLAN_TX_PIPE 1
	52	#define USB_WLAN_RX_PIPE 2
	53	#define USB_REG_IN_PIPE 3
	54	#define USB_REG_OUT_PIPE 4
	55
	56	#define HIF_USB_MAX_RXPIPES 2
	57	#define HIF_USB_MAX_TXPIPES 4
	58
	59	struct tx_buf {
	60	u8 *buf;
	61	u16 len;
	62	u16 offset;
	63	struct urb *urb;
	64	struct sk_buff_head skb_queue;
	65	struct hif_device_usb *hif_dev;
	66	struct list_head list;
	67	};
	68
	69	#define HIF_USB_TX_STOP BIT(0)
ff8f59b5	70	#define HIF_USB_TX_FLUSH BIT(1)
fb9987d0 S	71
	72	struct hif_usb_tx {
	73	u8 flags;
	74	u8 tx_buf_cnt;
	75	u16 tx_skb_cnt;
	76	struct sk_buff_head tx_skb_queue;
	77	struct list_head tx_buf;
	78	struct list_head tx_pending;
	79	spinlock_t tx_lock;
	80	};
	81
	82	struct cmd_buf {
	83	struct sk_buff *skb;
	84	struct hif_device_usb *hif_dev;
	85	};
	86
	87	#define HIF_USB_START BIT(0)
32e31de5	88	#define HIF_USB_READY BIT(1)
fb9987d0 S	89
fb9987d0 S	90	struct hif_device_usb {
fb9987d0 S	91	struct usb_device *udev;
fb9987d0 S	92	struct usb_interface *interface;
0ed7b93e	93	const struct usb_device_id *usb_device_id;
32e31de5 ML	94	const void *fw_data;
32e31de5 ML	95	size_t fw_size;
0ed7b93e	96	struct completion fw_done;
fb9987d0	97	struct htc_target *htc_handle;
fb9987d0	98	struct hif_usb_tx tx;
6f0f2669	99	struct usb_anchor regout_submitted;
6335ed0f	100	struct usb_anchor rx_submitted;
3deff760	101	struct usb_anchor reg_in_submitted;
2f80194c	102	struct usb_anchor mgmt_submitted;
fb9987d0	103	struct sk_buff *remain_skb;
ce43cee5	104	const char *fw_name;
fb9987d0 S	105	int rx_remain_len;
	106	int rx_pkt_len;
	107	int rx_transfer_len;
	108	int rx_pad_len;
46baa1a2	109	spinlock_t rx_lock;
6335ed0f	110	u8 flags; /* HIF_USB_* */
fb9987d0 S	111	};
	112
	113	int ath9k_hif_usb_init(void);
	114	void ath9k_hif_usb_exit(void);
	115
	116	#endif /* HTC_USB_H */