xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/microchip/wilc1000/netdev.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2012 - 2018 Microchip Technology Inc., and its subsidiaries.
4*4882a593Smuzhiyun  * All rights reserved.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef WILC_NETDEV_H
8*4882a593Smuzhiyun #define WILC_NETDEV_H
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/tcp.h>
11*4882a593Smuzhiyun #include <linux/ieee80211.h>
12*4882a593Smuzhiyun #include <net/cfg80211.h>
13*4882a593Smuzhiyun #include <net/ieee80211_radiotap.h>
14*4882a593Smuzhiyun #include <linux/if_arp.h>
15*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #include "hif.h"
18*4882a593Smuzhiyun #include "wlan.h"
19*4882a593Smuzhiyun #include "wlan_cfg.h"
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define FLOW_CONTROL_LOWER_THRESHOLD		128
22*4882a593Smuzhiyun #define FLOW_CONTROL_UPPER_THRESHOLD		256
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #define PMKID_FOUND				1
25*4882a593Smuzhiyun #define NUM_STA_ASSOCIATED			8
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #define TCP_ACK_FILTER_LINK_SPEED_THRESH	54
28*4882a593Smuzhiyun #define DEFAULT_LINK_SPEED			72
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun struct wilc_wfi_stats {
31*4882a593Smuzhiyun 	unsigned long rx_packets;
32*4882a593Smuzhiyun 	unsigned long tx_packets;
33*4882a593Smuzhiyun 	unsigned long rx_bytes;
34*4882a593Smuzhiyun 	unsigned long tx_bytes;
35*4882a593Smuzhiyun 	u64 rx_time;
36*4882a593Smuzhiyun 	u64 tx_time;
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun struct wilc_wfi_key {
41*4882a593Smuzhiyun 	u8 *key;
42*4882a593Smuzhiyun 	u8 *seq;
43*4882a593Smuzhiyun 	int key_len;
44*4882a593Smuzhiyun 	int seq_len;
45*4882a593Smuzhiyun 	u32 cipher;
46*4882a593Smuzhiyun };
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun struct wilc_wfi_wep_key {
49*4882a593Smuzhiyun 	u8 *key;
50*4882a593Smuzhiyun 	u8 key_len;
51*4882a593Smuzhiyun 	u8 key_idx;
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun struct sta_info {
55*4882a593Smuzhiyun 	u8 sta_associated_bss[WILC_MAX_NUM_STA][ETH_ALEN];
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun /* Parameters needed for host interface for remaining on channel */
59*4882a593Smuzhiyun struct wilc_wfi_p2p_listen_params {
60*4882a593Smuzhiyun 	struct ieee80211_channel *listen_ch;
61*4882a593Smuzhiyun 	u32 listen_duration;
62*4882a593Smuzhiyun 	u64 listen_cookie;
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun static const u32 wilc_cipher_suites[] = {
66*4882a593Smuzhiyun 	WLAN_CIPHER_SUITE_WEP40,
67*4882a593Smuzhiyun 	WLAN_CIPHER_SUITE_WEP104,
68*4882a593Smuzhiyun 	WLAN_CIPHER_SUITE_TKIP,
69*4882a593Smuzhiyun 	WLAN_CIPHER_SUITE_CCMP,
70*4882a593Smuzhiyun 	WLAN_CIPHER_SUITE_AES_CMAC
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #define CHAN2G(_channel, _freq, _flags) {	 \
74*4882a593Smuzhiyun 	.band             = NL80211_BAND_2GHZ, \
75*4882a593Smuzhiyun 	.center_freq      = (_freq),		 \
76*4882a593Smuzhiyun 	.hw_value         = (_channel),		 \
77*4882a593Smuzhiyun 	.flags            = (_flags),		 \
78*4882a593Smuzhiyun 	.max_antenna_gain = 0,			 \
79*4882a593Smuzhiyun 	.max_power        = 30,			 \
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun static const struct ieee80211_channel wilc_2ghz_channels[] = {
83*4882a593Smuzhiyun 	CHAN2G(1,  2412, 0),
84*4882a593Smuzhiyun 	CHAN2G(2,  2417, 0),
85*4882a593Smuzhiyun 	CHAN2G(3,  2422, 0),
86*4882a593Smuzhiyun 	CHAN2G(4,  2427, 0),
87*4882a593Smuzhiyun 	CHAN2G(5,  2432, 0),
88*4882a593Smuzhiyun 	CHAN2G(6,  2437, 0),
89*4882a593Smuzhiyun 	CHAN2G(7,  2442, 0),
90*4882a593Smuzhiyun 	CHAN2G(8,  2447, 0),
91*4882a593Smuzhiyun 	CHAN2G(9,  2452, 0),
92*4882a593Smuzhiyun 	CHAN2G(10, 2457, 0),
93*4882a593Smuzhiyun 	CHAN2G(11, 2462, 0),
94*4882a593Smuzhiyun 	CHAN2G(12, 2467, 0),
95*4882a593Smuzhiyun 	CHAN2G(13, 2472, 0),
96*4882a593Smuzhiyun 	CHAN2G(14, 2484, 0)
97*4882a593Smuzhiyun };
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun #define RATETAB_ENT(_rate, _hw_value, _flags) {	\
100*4882a593Smuzhiyun 	.bitrate  = (_rate),			\
101*4882a593Smuzhiyun 	.hw_value = (_hw_value),		\
102*4882a593Smuzhiyun 	.flags    = (_flags),			\
103*4882a593Smuzhiyun }
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun static struct ieee80211_rate wilc_bitrates[] = {
106*4882a593Smuzhiyun 	RATETAB_ENT(10,  0,  0),
107*4882a593Smuzhiyun 	RATETAB_ENT(20,  1,  0),
108*4882a593Smuzhiyun 	RATETAB_ENT(55,  2,  0),
109*4882a593Smuzhiyun 	RATETAB_ENT(110, 3,  0),
110*4882a593Smuzhiyun 	RATETAB_ENT(60,  9,  0),
111*4882a593Smuzhiyun 	RATETAB_ENT(90,  6,  0),
112*4882a593Smuzhiyun 	RATETAB_ENT(120, 7,  0),
113*4882a593Smuzhiyun 	RATETAB_ENT(180, 8,  0),
114*4882a593Smuzhiyun 	RATETAB_ENT(240, 9,  0),
115*4882a593Smuzhiyun 	RATETAB_ENT(360, 10, 0),
116*4882a593Smuzhiyun 	RATETAB_ENT(480, 11, 0),
117*4882a593Smuzhiyun 	RATETAB_ENT(540, 12, 0)
118*4882a593Smuzhiyun };
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun struct wilc_priv {
121*4882a593Smuzhiyun 	struct wireless_dev wdev;
122*4882a593Smuzhiyun 	struct cfg80211_scan_request *scan_req;
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 	struct wilc_wfi_p2p_listen_params remain_on_ch_params;
125*4882a593Smuzhiyun 	u64 tx_cookie;
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun 	bool cfg_scanning;
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	u8 associated_bss[ETH_ALEN];
130*4882a593Smuzhiyun 	struct sta_info assoc_stainfo;
131*4882a593Smuzhiyun 	struct sk_buff *skb;
132*4882a593Smuzhiyun 	struct net_device *dev;
133*4882a593Smuzhiyun 	struct host_if_drv *hif_drv;
134*4882a593Smuzhiyun 	struct wilc_pmkid_attr pmkid_list;
135*4882a593Smuzhiyun 	u8 wep_key[4][WLAN_KEY_LEN_WEP104];
136*4882a593Smuzhiyun 	u8 wep_key_len[4];
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	/* The real interface that the monitor is on */
139*4882a593Smuzhiyun 	struct net_device *real_ndev;
140*4882a593Smuzhiyun 	struct wilc_wfi_key *wilc_gtk[WILC_MAX_NUM_STA];
141*4882a593Smuzhiyun 	struct wilc_wfi_key *wilc_ptk[WILC_MAX_NUM_STA];
142*4882a593Smuzhiyun 	u8 wilc_groupkey;
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun 	/* mutexes */
145*4882a593Smuzhiyun 	struct mutex scan_req_lock;
146*4882a593Smuzhiyun 	bool p2p_listen_state;
147*4882a593Smuzhiyun 	int scanned_cnt;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	u64 inc_roc_cookie;
150*4882a593Smuzhiyun };
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun #define MAX_TCP_SESSION                25
153*4882a593Smuzhiyun #define MAX_PENDING_ACKS               256
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun struct ack_session_info {
156*4882a593Smuzhiyun 	u32 seq_num;
157*4882a593Smuzhiyun 	u32 bigger_ack_num;
158*4882a593Smuzhiyun 	u16 src_port;
159*4882a593Smuzhiyun 	u16 dst_port;
160*4882a593Smuzhiyun 	u16 status;
161*4882a593Smuzhiyun };
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun struct pending_acks {
164*4882a593Smuzhiyun 	u32 ack_num;
165*4882a593Smuzhiyun 	u32 session_index;
166*4882a593Smuzhiyun 	struct txq_entry_t  *txqe;
167*4882a593Smuzhiyun };
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun struct tcp_ack_filter {
170*4882a593Smuzhiyun 	struct ack_session_info ack_session_info[2 * MAX_TCP_SESSION];
171*4882a593Smuzhiyun 	struct pending_acks pending_acks[MAX_PENDING_ACKS];
172*4882a593Smuzhiyun 	u32 pending_base;
173*4882a593Smuzhiyun 	u32 tcp_session;
174*4882a593Smuzhiyun 	u32 pending_acks_idx;
175*4882a593Smuzhiyun 	bool enabled;
176*4882a593Smuzhiyun };
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun struct wilc_vif {
179*4882a593Smuzhiyun 	u8 idx;
180*4882a593Smuzhiyun 	u8 iftype;
181*4882a593Smuzhiyun 	int monitor_flag;
182*4882a593Smuzhiyun 	int mac_opened;
183*4882a593Smuzhiyun 	u32 mgmt_reg_stypes;
184*4882a593Smuzhiyun 	struct net_device_stats netstats;
185*4882a593Smuzhiyun 	struct wilc *wilc;
186*4882a593Smuzhiyun 	u8 bssid[ETH_ALEN];
187*4882a593Smuzhiyun 	struct host_if_drv *hif_drv;
188*4882a593Smuzhiyun 	struct net_device *ndev;
189*4882a593Smuzhiyun 	u8 mode;
190*4882a593Smuzhiyun 	struct timer_list during_ip_timer;
191*4882a593Smuzhiyun 	struct timer_list periodic_rssi;
192*4882a593Smuzhiyun 	struct rf_info periodic_stat;
193*4882a593Smuzhiyun 	struct tcp_ack_filter ack_filter;
194*4882a593Smuzhiyun 	bool connecting;
195*4882a593Smuzhiyun 	struct wilc_priv priv;
196*4882a593Smuzhiyun 	struct list_head list;
197*4882a593Smuzhiyun 	struct cfg80211_bss *bss;
198*4882a593Smuzhiyun };
199*4882a593Smuzhiyun 
200*4882a593Smuzhiyun struct wilc {
201*4882a593Smuzhiyun 	struct wiphy *wiphy;
202*4882a593Smuzhiyun 	const struct wilc_hif_func *hif_func;
203*4882a593Smuzhiyun 	int io_type;
204*4882a593Smuzhiyun 	s8 mac_status;
205*4882a593Smuzhiyun 	struct clk *rtc_clk;
206*4882a593Smuzhiyun 	bool initialized;
207*4882a593Smuzhiyun 	int dev_irq_num;
208*4882a593Smuzhiyun 	int close;
209*4882a593Smuzhiyun 	u8 vif_num;
210*4882a593Smuzhiyun 	struct list_head vif_list;
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	/* protect vif list */
213*4882a593Smuzhiyun 	struct mutex vif_mutex;
214*4882a593Smuzhiyun 	struct srcu_struct srcu;
215*4882a593Smuzhiyun 	u8 open_ifcs;
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun 	/* protect head of transmit queue */
218*4882a593Smuzhiyun 	struct mutex txq_add_to_head_cs;
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun 	/* protect txq_entry_t transmit queue */
221*4882a593Smuzhiyun 	spinlock_t txq_spinlock;
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 	/* protect rxq_entry_t receiver queue */
224*4882a593Smuzhiyun 	struct mutex rxq_cs;
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun 	/* lock to protect hif access */
227*4882a593Smuzhiyun 	struct mutex hif_cs;
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun 	struct completion cfg_event;
230*4882a593Smuzhiyun 	struct completion sync_event;
231*4882a593Smuzhiyun 	struct completion txq_event;
232*4882a593Smuzhiyun 	struct completion txq_thread_started;
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	struct task_struct *txq_thread;
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 	int quit;
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 	/* lock to protect issue of wid command to firmware */
239*4882a593Smuzhiyun 	struct mutex cfg_cmd_lock;
240*4882a593Smuzhiyun 	struct wilc_cfg_frame cfg_frame;
241*4882a593Smuzhiyun 	u32 cfg_frame_offset;
242*4882a593Smuzhiyun 	u8 cfg_seq_no;
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun 	u8 *rx_buffer;
245*4882a593Smuzhiyun 	u32 rx_buffer_offset;
246*4882a593Smuzhiyun 	u8 *tx_buffer;
247*4882a593Smuzhiyun 
248*4882a593Smuzhiyun 	struct txq_entry_t txq_head;
249*4882a593Smuzhiyun 	int txq_entries;
250*4882a593Smuzhiyun 
251*4882a593Smuzhiyun 	struct rxq_entry_t rxq_head;
252*4882a593Smuzhiyun 
253*4882a593Smuzhiyun 	const struct firmware *firmware;
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun 	struct device *dev;
256*4882a593Smuzhiyun 	bool suspend_event;
257*4882a593Smuzhiyun 
258*4882a593Smuzhiyun 	int clients_count;
259*4882a593Smuzhiyun 	struct workqueue_struct *hif_workqueue;
260*4882a593Smuzhiyun 	enum chip_ps_states chip_ps_state;
261*4882a593Smuzhiyun 	struct wilc_cfg cfg;
262*4882a593Smuzhiyun 	void *bus_data;
263*4882a593Smuzhiyun 	struct net_device *monitor_dev;
264*4882a593Smuzhiyun 
265*4882a593Smuzhiyun 	/* deinit lock */
266*4882a593Smuzhiyun 	struct mutex deinit_lock;
267*4882a593Smuzhiyun 	u8 sta_ch;
268*4882a593Smuzhiyun 	u8 op_ch;
269*4882a593Smuzhiyun 	struct ieee80211_channel channels[ARRAY_SIZE(wilc_2ghz_channels)];
270*4882a593Smuzhiyun 	struct ieee80211_rate bitrates[ARRAY_SIZE(wilc_bitrates)];
271*4882a593Smuzhiyun 	struct ieee80211_supported_band band;
272*4882a593Smuzhiyun 	u32 cipher_suites[ARRAY_SIZE(wilc_cipher_suites)];
273*4882a593Smuzhiyun };
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun struct wilc_wfi_mon_priv {
276*4882a593Smuzhiyun 	struct net_device *real_ndev;
277*4882a593Smuzhiyun };
278*4882a593Smuzhiyun 
279*4882a593Smuzhiyun void wilc_frmw_to_host(struct wilc *wilc, u8 *buff, u32 size, u32 pkt_offset);
280*4882a593Smuzhiyun void wilc_mac_indicate(struct wilc *wilc);
281*4882a593Smuzhiyun void wilc_netdev_cleanup(struct wilc *wilc);
282*4882a593Smuzhiyun void wilc_wfi_mgmt_rx(struct wilc *wilc, u8 *buff, u32 size);
283*4882a593Smuzhiyun void wilc_wlan_set_bssid(struct net_device *wilc_netdev, u8 *bssid, u8 mode);
284*4882a593Smuzhiyun struct wilc_vif *wilc_netdev_ifc_init(struct wilc *wl, const char *name,
285*4882a593Smuzhiyun 				      int vif_type, enum nl80211_iftype type,
286*4882a593Smuzhiyun 				      bool rtnl_locked);
287*4882a593Smuzhiyun #endif
288