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