xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/marvell/mwifiex/usb.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * This file contains definitions for mwifiex USB interface driver.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright 2011-2020 NXP
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * This software file (the "File") is distributed by NXP
7*4882a593Smuzhiyun  * under the terms of the GNU General Public License Version 2, June 1991
8*4882a593Smuzhiyun  * (the "License").  You may use, redistribute and/or modify this File in
9*4882a593Smuzhiyun  * accordance with the terms and conditions of the License, a copy of which
10*4882a593Smuzhiyun  * is available by writing to the Free Software Foundation, Inc.,
11*4882a593Smuzhiyun  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12*4882a593Smuzhiyun  * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
15*4882a593Smuzhiyun  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
16*4882a593Smuzhiyun  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
17*4882a593Smuzhiyun  * this warranty disclaimer.
18*4882a593Smuzhiyun  */
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #ifndef _MWIFIEX_USB_H
21*4882a593Smuzhiyun #define _MWIFIEX_USB_H
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #include <linux/completion.h>
24*4882a593Smuzhiyun #include <linux/usb.h>
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #define USB8XXX_VID		0x1286
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #define USB8766_PID_1		0x2041
29*4882a593Smuzhiyun #define USB8766_PID_2		0x2042
30*4882a593Smuzhiyun #define USB8797_PID_1		0x2043
31*4882a593Smuzhiyun #define USB8797_PID_2		0x2044
32*4882a593Smuzhiyun #define USB8801_PID_1		0x2049
33*4882a593Smuzhiyun #define USB8801_PID_2		0x204a
34*4882a593Smuzhiyun #define USB8997_PID_1		0x2052
35*4882a593Smuzhiyun #define USB8997_PID_2		0x204e
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #define USB8XXX_FW_DNLD		1
39*4882a593Smuzhiyun #define USB8XXX_FW_READY	2
40*4882a593Smuzhiyun #define USB8XXX_FW_MAX_RETRY	3
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun #define MWIFIEX_TX_DATA_PORT	2
43*4882a593Smuzhiyun #define MWIFIEX_TX_DATA_URB	6
44*4882a593Smuzhiyun #define MWIFIEX_RX_DATA_URB	6
45*4882a593Smuzhiyun #define MWIFIEX_USB_TIMEOUT	100
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun #define USB8766_DEFAULT_FW_NAME	"mrvl/usb8766_uapsta.bin"
48*4882a593Smuzhiyun #define USB8797_DEFAULT_FW_NAME	"mrvl/usb8797_uapsta.bin"
49*4882a593Smuzhiyun #define USB8801_DEFAULT_FW_NAME	"mrvl/usb8801_uapsta.bin"
50*4882a593Smuzhiyun #define USB8997_DEFAULT_FW_NAME	"mrvl/usbusb8997_combo_v4.bin"
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun #define FW_DNLD_TX_BUF_SIZE	620
53*4882a593Smuzhiyun #define FW_DNLD_RX_BUF_SIZE	2048
54*4882a593Smuzhiyun #define FW_HAS_LAST_BLOCK	0x00000004
55*4882a593Smuzhiyun #define FW_CMD_7		0x00000007
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #define FW_DATA_XMIT_SIZE \
58*4882a593Smuzhiyun 	(sizeof(struct fw_header) + dlen + sizeof(u32))
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun struct urb_context {
61*4882a593Smuzhiyun 	struct mwifiex_adapter *adapter;
62*4882a593Smuzhiyun 	struct sk_buff *skb;
63*4882a593Smuzhiyun 	struct urb *urb;
64*4882a593Smuzhiyun 	u8 ep;
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun #define MWIFIEX_USB_TX_AGGR_TMO_MIN	1
68*4882a593Smuzhiyun #define MWIFIEX_USB_TX_AGGR_TMO_MAX	4
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun struct tx_aggr_tmr_cnxt {
71*4882a593Smuzhiyun 	struct mwifiex_adapter *adapter;
72*4882a593Smuzhiyun 	struct usb_tx_data_port *port;
73*4882a593Smuzhiyun 	struct timer_list hold_timer;
74*4882a593Smuzhiyun 	bool is_hold_timer_set;
75*4882a593Smuzhiyun 	u32 hold_tmo_msecs;
76*4882a593Smuzhiyun };
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun struct usb_tx_aggr {
79*4882a593Smuzhiyun 	struct sk_buff_head aggr_list;
80*4882a593Smuzhiyun 	int aggr_len;
81*4882a593Smuzhiyun 	int aggr_num;
82*4882a593Smuzhiyun 	struct tx_aggr_tmr_cnxt timer_cnxt;
83*4882a593Smuzhiyun };
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun struct usb_tx_data_port {
86*4882a593Smuzhiyun 	u8 tx_data_ep;
87*4882a593Smuzhiyun 	u8 block_status;
88*4882a593Smuzhiyun 	atomic_t tx_data_urb_pending;
89*4882a593Smuzhiyun 	int tx_data_ix;
90*4882a593Smuzhiyun 	struct urb_context tx_data_list[MWIFIEX_TX_DATA_URB];
91*4882a593Smuzhiyun 	/* usb tx aggregation*/
92*4882a593Smuzhiyun 	struct usb_tx_aggr tx_aggr;
93*4882a593Smuzhiyun 	struct sk_buff *skb_aggr[MWIFIEX_TX_DATA_URB];
94*4882a593Smuzhiyun 	/* lock for protect tx aggregation data path*/
95*4882a593Smuzhiyun 	spinlock_t tx_aggr_lock;
96*4882a593Smuzhiyun };
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun struct usb_card_rec {
99*4882a593Smuzhiyun 	struct mwifiex_adapter *adapter;
100*4882a593Smuzhiyun 	struct usb_device *udev;
101*4882a593Smuzhiyun 	struct usb_interface *intf;
102*4882a593Smuzhiyun 	struct completion fw_done;
103*4882a593Smuzhiyun 	u8 rx_cmd_ep;
104*4882a593Smuzhiyun 	struct urb_context rx_cmd;
105*4882a593Smuzhiyun 	atomic_t rx_cmd_urb_pending;
106*4882a593Smuzhiyun 	struct urb_context rx_data_list[MWIFIEX_RX_DATA_URB];
107*4882a593Smuzhiyun 	u8 usb_boot_state;
108*4882a593Smuzhiyun 	u8 rx_data_ep;
109*4882a593Smuzhiyun 	atomic_t rx_data_urb_pending;
110*4882a593Smuzhiyun 	u8 tx_cmd_ep;
111*4882a593Smuzhiyun 	atomic_t tx_cmd_urb_pending;
112*4882a593Smuzhiyun 	int bulk_out_maxpktsize;
113*4882a593Smuzhiyun 	struct urb_context tx_cmd;
114*4882a593Smuzhiyun 	u8 mc_resync_flag;
115*4882a593Smuzhiyun 	struct usb_tx_data_port port[MWIFIEX_TX_DATA_PORT];
116*4882a593Smuzhiyun 	int rx_cmd_ep_type;
117*4882a593Smuzhiyun 	u8 rx_cmd_interval;
118*4882a593Smuzhiyun 	int tx_cmd_ep_type;
119*4882a593Smuzhiyun 	u8 tx_cmd_interval;
120*4882a593Smuzhiyun };
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun struct fw_header {
123*4882a593Smuzhiyun 	__le32 dnld_cmd;
124*4882a593Smuzhiyun 	__le32 base_addr;
125*4882a593Smuzhiyun 	__le32 data_len;
126*4882a593Smuzhiyun 	__le32 crc;
127*4882a593Smuzhiyun };
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun struct fw_sync_header {
130*4882a593Smuzhiyun 	__le32 cmd;
131*4882a593Smuzhiyun 	__le32 seq_num;
132*4882a593Smuzhiyun } __packed;
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun struct fw_data {
135*4882a593Smuzhiyun 	struct fw_header fw_hdr;
136*4882a593Smuzhiyun 	__le32 seq_num;
137*4882a593Smuzhiyun 	u8 data[1];
138*4882a593Smuzhiyun } __packed;
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun #endif /*_MWIFIEX_USB_H */
141