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 /* old firmware images */
21 #define FIRMWARE_AR7010_1_1     "htc_7010.fw"
22 #define FIRMWARE_AR9271         "htc_9271.fw"
23 
24 /* supported Major FW version */
25 #define MAJOR_VERSION_REQ 1
26 #define MINOR_VERSION_REQ 3
27 /* minimal and maximal supported Minor FW version. */
28 #define FIRMWARE_MINOR_IDX_MAX  4
29 #define FIRMWARE_MINOR_IDX_MIN  3
30 #define HTC_FW_PATH	"ath9k_htc"
31 
32 #define HTC_9271_MODULE_FW  HTC_FW_PATH "/htc_9271-" \
33 			__stringify(MAJOR_VERSION_REQ) \
34 			"." __stringify(FIRMWARE_MINOR_IDX_MAX) ".0.fw"
35 #define HTC_7010_MODULE_FW  HTC_FW_PATH "/htc_7010-" \
36 			__stringify(MAJOR_VERSION_REQ) \
37 			"." __stringify(FIRMWARE_MINOR_IDX_MAX) ".0.fw"
38 
39 extern int htc_use_dev_fw;
40 
41 #define IS_AR7010_DEVICE(_v) (((_v) == AR9280_USB) || ((_v) == AR9287_USB))
42 
43 #define AR9271_FIRMWARE       0x501000
44 #define AR9271_FIRMWARE_TEXT  0x903000
45 #define AR7010_FIRMWARE_TEXT  0x906000
46 
47 #define FIRMWARE_DOWNLOAD       0x30
48 #define FIRMWARE_DOWNLOAD_COMP  0x31
49 
50 #define ATH_USB_RX_STREAM_MODE_TAG 0x4e00
51 #define ATH_USB_TX_STREAM_MODE_TAG 0x697e
52 
53 /* FIXME: Verify these numbers (with Windows) */
54 #define MAX_TX_URB_NUM  8
55 #define MAX_TX_BUF_NUM  256
56 #define MAX_TX_BUF_SIZE 32768
57 #define MAX_TX_AGGR_NUM 20
58 
59 #define MAX_RX_URB_NUM  8
60 #define MAX_RX_BUF_SIZE 16384
61 #define MAX_PKT_NUM_IN_TRANSFER 10
62 
63 #define MAX_REG_OUT_URB_NUM  1
64 #define MAX_REG_IN_URB_NUM   64
65 
66 #define MAX_REG_IN_BUF_SIZE 64
67 
68 /* USB Endpoint definition */
69 #define USB_WLAN_TX_PIPE  1
70 #define USB_WLAN_RX_PIPE  2
71 #define USB_REG_IN_PIPE   3
72 #define USB_REG_OUT_PIPE  4
73 
74 #define USB_MSG_TIMEOUT 1000 /* (ms) */
75 
76 #define HIF_USB_MAX_RXPIPES 2
77 #define HIF_USB_MAX_TXPIPES 4
78 
79 struct tx_buf {
80 	u8 *buf;
81 	u16 len;
82 	u16 offset;
83 	struct urb *urb;
84 	struct sk_buff_head skb_queue;
85 	struct hif_device_usb *hif_dev;
86 	struct list_head list;
87 };
88 
89 #define HIF_USB_TX_STOP  BIT(0)
90 #define HIF_USB_TX_FLUSH BIT(1)
91 
92 struct hif_usb_tx {
93 	u8 flags;
94 	u8 tx_buf_cnt;
95 	u16 tx_skb_cnt;
96 	struct sk_buff_head tx_skb_queue;
97 	struct list_head tx_buf;
98 	struct list_head tx_pending;
99 	spinlock_t tx_lock;
100 };
101 
102 struct cmd_buf {
103 	struct sk_buff *skb;
104 	struct hif_device_usb *hif_dev;
105 };
106 
107 #define HIF_USB_START BIT(0)
108 #define HIF_USB_READY BIT(1)
109 
110 struct hif_device_usb {
111 	struct usb_device *udev;
112 	struct usb_interface *interface;
113 	const struct usb_device_id *usb_device_id;
114 	const void *fw_data;
115 	size_t fw_size;
116 	struct completion fw_done;
117 	struct htc_target *htc_handle;
118 	struct hif_usb_tx tx;
119 	struct usb_anchor regout_submitted;
120 	struct usb_anchor rx_submitted;
121 	struct usb_anchor reg_in_submitted;
122 	struct usb_anchor mgmt_submitted;
123 	struct sk_buff *remain_skb;
124 	char fw_name[32];
125 	int fw_minor_index;
126 	int rx_remain_len;
127 	int rx_pkt_len;
128 	int rx_transfer_len;
129 	int rx_pad_len;
130 	spinlock_t rx_lock;
131 	u8 flags; /* HIF_USB_* */
132 };
133 
134 int ath9k_hif_usb_init(void);
135 void ath9k_hif_usb_exit(void);
136 
137 #endif /* HTC_USB_H */
138