1 /*
2  * Copyright (c) 2010-2011 Atheros Communications Inc.
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 
20 #define MAJOR_VERSION_REQ 1
21 #define MINOR_VERSION_REQ 3
22 
23 #define IS_AR7010_DEVICE(_v) (((_v) == AR9280_USB) || ((_v) == AR9287_USB))
24 
25 #define AR9271_FIRMWARE       0x501000
26 #define AR9271_FIRMWARE_TEXT  0x903000
27 #define AR7010_FIRMWARE_TEXT  0x906000
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
37 #define MAX_TX_BUF_NUM  256
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
43 #define MAX_PKT_NUM_IN_TRANSFER 10
44 
45 #define MAX_REG_OUT_URB_NUM  1
46 #define MAX_REG_IN_URB_NUM   64
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)
70 #define HIF_USB_TX_FLUSH BIT(1)
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)
88 
89 struct hif_device_usb {
90 	struct usb_device *udev;
91 	struct usb_interface *interface;
92 	const struct usb_device_id *usb_device_id;
93 	const struct firmware *firmware;
94 	struct completion fw_done;
95 	struct htc_target *htc_handle;
96 	struct hif_usb_tx tx;
97 	struct usb_anchor regout_submitted;
98 	struct usb_anchor rx_submitted;
99 	struct usb_anchor reg_in_submitted;
100 	struct usb_anchor mgmt_submitted;
101 	struct sk_buff *remain_skb;
102 	const char *fw_name;
103 	int rx_remain_len;
104 	int rx_pkt_len;
105 	int rx_transfer_len;
106 	int rx_pad_len;
107 	spinlock_t rx_lock;
108 	u8 flags; /* HIF_USB_* */
109 };
110 
111 int ath9k_hif_usb_init(void);
112 void ath9k_hif_usb_exit(void);
113 
114 #endif /* HTC_USB_H */
115