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