1 // SPDX-License-Identifier: ISC
2 /*
3  * Copyright (c) 2010 Broadcom Corporation
4  */
5 
6 #ifndef BRCMFMAC_CFG80211_H
7 #define BRCMFMAC_CFG80211_H
8 
9 /* for brcmu_d11inf */
10 #include <brcmu_d11.h>
11 
12 #include "core.h"
13 #include "fwil_types.h"
14 #include "p2p.h"
15 
16 #define BRCMF_SCAN_IE_LEN_MAX		2048
17 
18 #define WL_NUM_SCAN_MAX			10
19 #define WL_TLV_INFO_MAX			1024
20 #define WL_BSS_INFO_MAX			2048
21 #define WL_ASSOC_INFO_MAX		512	/* assoc related fil max buf */
22 #define WL_EXTRA_BUF_MAX		2048
23 #define WL_ROAM_TRIGGER_LEVEL		-75
24 #define WL_ROAM_DELTA			20
25 
26 /* Keep BRCMF_ESCAN_BUF_SIZE below 64K (65536). Allocing over 64K can be
27  * problematic on some systems and should be avoided.
28  */
29 #define BRCMF_ESCAN_BUF_SIZE		65000
30 #define BRCMF_ESCAN_TIMER_INTERVAL_MS	10000	/* E-Scan timeout */
31 
32 #define WL_ESCAN_ACTION_START		1
33 #define WL_ESCAN_ACTION_CONTINUE	2
34 #define WL_ESCAN_ACTION_ABORT		3
35 
36 #define WL_AUTH_SHARED_KEY		1	/* d11 shared authentication */
37 #define IE_MAX_LEN			512
38 
39 /* IE TLV processing */
40 #define TLV_LEN_OFF			1	/* length offset */
41 #define TLV_HDR_LEN			2	/* header length */
42 #define TLV_BODY_OFF			2	/* body offset */
43 #define TLV_OUI_LEN			3	/* oui id length */
44 
45 /* 802.11 Mgmt Packet flags */
46 #define BRCMF_VNDR_IE_BEACON_FLAG	0x1
47 #define BRCMF_VNDR_IE_PRBRSP_FLAG	0x2
48 #define BRCMF_VNDR_IE_ASSOCRSP_FLAG	0x4
49 #define BRCMF_VNDR_IE_AUTHRSP_FLAG	0x8
50 #define BRCMF_VNDR_IE_PRBREQ_FLAG	0x10
51 #define BRCMF_VNDR_IE_ASSOCREQ_FLAG	0x20
52 /* vendor IE in IW advertisement protocol ID field */
53 #define BRCMF_VNDR_IE_IWAPID_FLAG	0x40
54 /* allow custom IE id */
55 #define BRCMF_VNDR_IE_CUSTOM_FLAG	0x100
56 
57 /* P2P Action Frames flags (spec ordered) */
58 #define BRCMF_VNDR_IE_GONREQ_FLAG     0x001000
59 #define BRCMF_VNDR_IE_GONRSP_FLAG     0x002000
60 #define BRCMF_VNDR_IE_GONCFM_FLAG     0x004000
61 #define BRCMF_VNDR_IE_INVREQ_FLAG     0x008000
62 #define BRCMF_VNDR_IE_INVRSP_FLAG     0x010000
63 #define BRCMF_VNDR_IE_DISREQ_FLAG     0x020000
64 #define BRCMF_VNDR_IE_DISRSP_FLAG     0x040000
65 #define BRCMF_VNDR_IE_PRDREQ_FLAG     0x080000
66 #define BRCMF_VNDR_IE_PRDRSP_FLAG     0x100000
67 
68 #define BRCMF_VNDR_IE_P2PAF_SHIFT	12
69 
70 #define BRCMF_MAX_DEFAULT_KEYS		6
71 
72 /* beacon loss timeout defaults */
73 #define BRCMF_DEFAULT_BCN_TIMEOUT_ROAM_ON	2
74 #define BRCMF_DEFAULT_BCN_TIMEOUT_ROAM_OFF	4
75 
76 #define BRCMF_VIF_EVENT_TIMEOUT		msecs_to_jiffies(1500)
77 
78 /**
79  * enum brcmf_scan_status - scan engine status
80  *
81  * @BRCMF_SCAN_STATUS_BUSY: scanning in progress on dongle.
82  * @BRCMF_SCAN_STATUS_ABORT: scan being aborted on dongle.
83  * @BRCMF_SCAN_STATUS_SUPPRESS: scanning is suppressed in driver.
84  */
85 enum brcmf_scan_status {
86 	BRCMF_SCAN_STATUS_BUSY,
87 	BRCMF_SCAN_STATUS_ABORT,
88 	BRCMF_SCAN_STATUS_SUPPRESS,
89 };
90 
91 /* dongle configuration */
92 struct brcmf_cfg80211_conf {
93 	u32 frag_threshold;
94 	u32 rts_threshold;
95 	u32 retry_short;
96 	u32 retry_long;
97 };
98 
99 /* security information with currently associated ap */
100 struct brcmf_cfg80211_security {
101 	u32 wpa_versions;
102 	u32 auth_type;
103 	u32 cipher_pairwise;
104 	u32 cipher_group;
105 };
106 
107 enum brcmf_profile_fwsup {
108 	BRCMF_PROFILE_FWSUP_NONE,
109 	BRCMF_PROFILE_FWSUP_PSK,
110 	BRCMF_PROFILE_FWSUP_1X,
111 	BRCMF_PROFILE_FWSUP_SAE
112 };
113 
114 /**
115  * struct brcmf_cfg80211_profile - profile information.
116  *
117  * @bssid: bssid of joined/joining ibss.
118  * @sec: security information.
119  * @key: key information
120  */
121 struct brcmf_cfg80211_profile {
122 	u8 bssid[ETH_ALEN];
123 	struct brcmf_cfg80211_security sec;
124 	struct brcmf_wsec_key key[BRCMF_MAX_DEFAULT_KEYS];
125 	enum brcmf_profile_fwsup use_fwsup;
126 	bool is_ft;
127 };
128 
129 /**
130  * enum brcmf_vif_status - bit indices for vif status.
131  *
132  * @BRCMF_VIF_STATUS_READY: ready for operation.
133  * @BRCMF_VIF_STATUS_CONNECTING: connect/join in progress.
134  * @BRCMF_VIF_STATUS_CONNECTED: connected/joined successfully.
135  * @BRCMF_VIF_STATUS_DISCONNECTING: disconnect/disable in progress.
136  * @BRCMF_VIF_STATUS_AP_CREATED: AP operation started.
137  * @BRCMF_VIF_STATUS_EAP_SUCCUSS: EAPOL handshake successful.
138  * @BRCMF_VIF_STATUS_ASSOC_SUCCESS: successful SET_SSID received.
139  */
140 enum brcmf_vif_status {
141 	BRCMF_VIF_STATUS_READY,
142 	BRCMF_VIF_STATUS_CONNECTING,
143 	BRCMF_VIF_STATUS_CONNECTED,
144 	BRCMF_VIF_STATUS_DISCONNECTING,
145 	BRCMF_VIF_STATUS_AP_CREATED,
146 	BRCMF_VIF_STATUS_EAP_SUCCESS,
147 	BRCMF_VIF_STATUS_ASSOC_SUCCESS,
148 };
149 
150 /**
151  * struct vif_saved_ie - holds saved IEs for a virtual interface.
152  *
153  * @probe_req_ie: IE info for probe request.
154  * @probe_res_ie: IE info for probe response.
155  * @beacon_ie: IE info for beacon frame.
156  * @probe_req_ie_len: IE info length for probe request.
157  * @probe_res_ie_len: IE info length for probe response.
158  * @beacon_ie_len: IE info length for beacon frame.
159  */
160 struct vif_saved_ie {
161 	u8  probe_req_ie[IE_MAX_LEN];
162 	u8  probe_res_ie[IE_MAX_LEN];
163 	u8  beacon_ie[IE_MAX_LEN];
164 	u8  assoc_req_ie[IE_MAX_LEN];
165 	u32 probe_req_ie_len;
166 	u32 probe_res_ie_len;
167 	u32 beacon_ie_len;
168 	u32 assoc_req_ie_len;
169 };
170 
171 /**
172  * struct brcmf_cfg80211_vif - virtual interface specific information.
173  *
174  * @ifp: lower layer interface pointer
175  * @wdev: wireless device.
176  * @profile: profile information.
177  * @sme_state: SME state using enum brcmf_vif_status bits.
178  * @list: linked list.
179  * @mgmt_rx_reg: registered rx mgmt frame types.
180  * @mbss: Multiple BSS type, set if not first AP (not relevant for P2P).
181  */
182 struct brcmf_cfg80211_vif {
183 	struct brcmf_if *ifp;
184 	struct wireless_dev wdev;
185 	struct brcmf_cfg80211_profile profile;
186 	unsigned long sme_state;
187 	struct vif_saved_ie saved_ie;
188 	struct list_head list;
189 	u16 mgmt_rx_reg;
190 	bool mbss;
191 	int is_11d;
192 };
193 
194 /* association inform */
195 struct brcmf_cfg80211_connect_info {
196 	u8 *req_ie;
197 	s32 req_ie_len;
198 	u8 *resp_ie;
199 	s32 resp_ie_len;
200 };
201 
202 /* assoc ie length */
203 struct brcmf_cfg80211_assoc_ielen_le {
204 	__le32 req_len;
205 	__le32 resp_len;
206 };
207 
208 /* dongle escan state */
209 enum wl_escan_state {
210 	WL_ESCAN_STATE_IDLE,
211 	WL_ESCAN_STATE_SCANNING
212 };
213 
214 struct escan_info {
215 	u32 escan_state;
216 	u8 *escan_buf;
217 	struct wiphy *wiphy;
218 	struct brcmf_if *ifp;
219 	s32 (*run)(struct brcmf_cfg80211_info *cfg, struct brcmf_if *ifp,
220 		   struct cfg80211_scan_request *request);
221 };
222 
223 /**
224  * struct brcmf_cfg80211_vif_event - virtual interface event information.
225  *
226  * @vif_wq: waitqueue awaiting interface event from firmware.
227  * @vif_event_lock: protects other members in this structure.
228  * @vif_complete: completion for net attach.
229  * @action: either add, change, or delete.
230  * @vif: virtual interface object related to the event.
231  */
232 struct brcmf_cfg80211_vif_event {
233 	wait_queue_head_t vif_wq;
234 	spinlock_t vif_event_lock;
235 	u8 action;
236 	struct brcmf_cfg80211_vif *vif;
237 };
238 
239 /**
240  * struct brcmf_cfg80211_wowl - wowl related information.
241  *
242  * @active: set on suspend, cleared on resume.
243  * @pre_pmmode: firmware PM mode at entering suspend.
244  * @nd: net dectect data.
245  * @nd_info: helper struct to pass to cfg80211.
246  * @nd_data_wait: wait queue to sync net detect data.
247  * @nd_data_completed: completion for net detect data.
248  * @nd_enabled: net detect enabled.
249  */
250 struct brcmf_cfg80211_wowl {
251 	bool active;
252 	u32 pre_pmmode;
253 	struct cfg80211_wowlan_nd_match *nd;
254 	struct cfg80211_wowlan_nd_info *nd_info;
255 	wait_queue_head_t nd_data_wait;
256 	bool nd_data_completed;
257 	bool nd_enabled;
258 };
259 
260 /**
261  * struct brcmf_cfg80211_info - dongle private data of cfg80211 interface
262  *
263  * @wiphy: wiphy object for cfg80211 interface.
264  * @ops: pointer to copy of ops as registered with wiphy object.
265  * @conf: dongle configuration.
266  * @p2p: peer-to-peer specific information.
267  * @btcoex: Bluetooth coexistence information.
268  * @scan_request: cfg80211 scan request object.
269  * @usr_sync: mainly for dongle up/down synchronization.
270  * @bss_list: bss_list holding scanned ap information.
271  * @bss_info: bss information for cfg80211 layer.
272  * @conn_info: association info.
273  * @pmk_list: wpa2 pmk list.
274  * @scan_status: scan activity on the dongle.
275  * @pub: common driver information.
276  * @channel: current channel.
277  * @int_escan_map: bucket map for which internal e-scan is done.
278  * @ibss_starter: indicates this sta is ibss starter.
279  * @pwr_save: indicate whether dongle to support power save mode.
280  * @dongle_up: indicate whether dongle up or not.
281  * @roam_on: on/off switch for dongle self-roaming.
282  * @scan_tried: indicates if first scan attempted.
283  * @dcmd_buf: dcmd buffer.
284  * @extra_buf: mainly to grab assoc information.
285  * @debugfsdir: debugfs folder for this device.
286  * @escan_info: escan information.
287  * @escan_timeout: Timer for catch scan timeout.
288  * @escan_timeout_work: scan timeout worker.
289  * @vif_list: linked list of vif instances.
290  * @vif_cnt: number of vif instances.
291  * @vif_event: vif event signalling.
292  * @wowl: wowl related information.
293  * @pno: information of pno module.
294  */
295 struct brcmf_cfg80211_info {
296 	struct wiphy *wiphy;
297 	struct brcmf_cfg80211_conf *conf;
298 	struct brcmf_p2p_info p2p;
299 	struct brcmf_btcoex_info *btcoex;
300 	struct cfg80211_scan_request *scan_request;
301 	struct mutex usr_sync;
302 	struct wl_cfg80211_bss_info *bss_info;
303 	struct brcmf_cfg80211_connect_info conn_info;
304 	struct brcmf_pmk_list_le pmk_list;
305 	unsigned long scan_status;
306 	struct brcmf_pub *pub;
307 	u32 channel;
308 	u32 int_escan_map;
309 	bool ibss_starter;
310 	bool pwr_save;
311 	bool dongle_up;
312 	bool scan_tried;
313 	u8 *dcmd_buf;
314 	u8 *extra_buf;
315 	struct dentry *debugfsdir;
316 	struct escan_info escan_info;
317 	struct timer_list escan_timeout;
318 	struct work_struct escan_timeout_work;
319 	struct list_head vif_list;
320 	struct brcmf_cfg80211_vif_event vif_event;
321 	struct completion vif_disabled;
322 	struct brcmu_d11inf d11inf;
323 	struct brcmf_assoclist_le assoclist;
324 	struct brcmf_cfg80211_wowl wowl;
325 	struct brcmf_pno_info *pno;
326 };
327 
328 /**
329  * struct brcmf_tlv - tag_ID/length/value_buffer tuple.
330  *
331  * @id: tag identifier.
332  * @len: number of bytes in value buffer.
333  * @data: value buffer.
334  */
335 struct brcmf_tlv {
336 	u8 id;
337 	u8 len;
338 	u8 data[1];
339 };
340 
341 static inline struct wiphy *cfg_to_wiphy(struct brcmf_cfg80211_info *cfg)
342 {
343 	return cfg->wiphy;
344 }
345 
346 static inline struct brcmf_cfg80211_info *wiphy_to_cfg(struct wiphy *w)
347 {
348 	struct brcmf_pub *drvr = wiphy_priv(w);
349 	return drvr->config;
350 }
351 
352 static inline struct brcmf_cfg80211_info *wdev_to_cfg(struct wireless_dev *wd)
353 {
354 	return wiphy_to_cfg(wd->wiphy);
355 }
356 
357 static inline struct brcmf_cfg80211_vif *wdev_to_vif(struct wireless_dev *wdev)
358 {
359 	return container_of(wdev, struct brcmf_cfg80211_vif, wdev);
360 }
361 
362 static inline
363 struct net_device *cfg_to_ndev(struct brcmf_cfg80211_info *cfg)
364 {
365 	return brcmf_get_ifp(cfg->pub, 0)->ndev;
366 }
367 
368 static inline struct brcmf_cfg80211_info *ndev_to_cfg(struct net_device *ndev)
369 {
370 	return wdev_to_cfg(ndev->ieee80211_ptr);
371 }
372 
373 static inline struct brcmf_cfg80211_profile *ndev_to_prof(struct net_device *nd)
374 {
375 	struct brcmf_if *ifp = netdev_priv(nd);
376 	return &ifp->vif->profile;
377 }
378 
379 static inline struct brcmf_cfg80211_vif *ndev_to_vif(struct net_device *ndev)
380 {
381 	struct brcmf_if *ifp = netdev_priv(ndev);
382 	return ifp->vif;
383 }
384 
385 static inline struct
386 brcmf_cfg80211_connect_info *cfg_to_conn(struct brcmf_cfg80211_info *cfg)
387 {
388 	return &cfg->conn_info;
389 }
390 
391 struct brcmf_cfg80211_info *brcmf_cfg80211_attach(struct brcmf_pub *drvr,
392 						  struct cfg80211_ops *ops,
393 						  bool p2pdev_forced);
394 void brcmf_cfg80211_detach(struct brcmf_cfg80211_info *cfg);
395 s32 brcmf_cfg80211_up(struct net_device *ndev);
396 s32 brcmf_cfg80211_down(struct net_device *ndev);
397 struct cfg80211_ops *brcmf_cfg80211_get_ops(struct brcmf_mp_device *settings);
398 enum nl80211_iftype brcmf_cfg80211_get_iftype(struct brcmf_if *ifp);
399 
400 struct brcmf_cfg80211_vif *brcmf_alloc_vif(struct brcmf_cfg80211_info *cfg,
401 					   enum nl80211_iftype type);
402 void brcmf_free_vif(struct brcmf_cfg80211_vif *vif);
403 
404 s32 brcmf_vif_set_mgmt_ie(struct brcmf_cfg80211_vif *vif, s32 pktflag,
405 			  const u8 *vndr_ie_buf, u32 vndr_ie_len);
406 s32 brcmf_vif_clear_mgmt_ies(struct brcmf_cfg80211_vif *vif);
407 u16 channel_to_chanspec(struct brcmu_d11inf *d11inf,
408 			struct ieee80211_channel *ch);
409 bool brcmf_get_vif_state_any(struct brcmf_cfg80211_info *cfg,
410 			     unsigned long state);
411 void brcmf_cfg80211_arm_vif_event(struct brcmf_cfg80211_info *cfg,
412 				  struct brcmf_cfg80211_vif *vif);
413 bool brcmf_cfg80211_vif_event_armed(struct brcmf_cfg80211_info *cfg);
414 int brcmf_cfg80211_wait_vif_event(struct brcmf_cfg80211_info *cfg,
415 				  u8 action, ulong timeout);
416 s32 brcmf_notify_escan_complete(struct brcmf_cfg80211_info *cfg,
417 				struct brcmf_if *ifp, bool aborted,
418 				bool fw_abort);
419 void brcmf_set_mpc(struct brcmf_if *ndev, int mpc);
420 void brcmf_abort_scanning(struct brcmf_cfg80211_info *cfg);
421 void brcmf_cfg80211_free_netdev(struct net_device *ndev);
422 
423 #endif /* BRCMFMAC_CFG80211_H */
424