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