xref: /OK3568_Linux_fs/external/rkwifibt/drivers/bcmdhd/dhd_pno.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Header file of Broadcom Dongle Host Driver (DHD)
3*4882a593Smuzhiyun  * Prefered Network Offload code and Wi-Fi Location Service(WLS) code.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2020, Broadcom.
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  *      Unless you and Broadcom execute a separate written software license
8*4882a593Smuzhiyun  * agreement governing use of this software, this software is licensed to you
9*4882a593Smuzhiyun  * under the terms of the GNU General Public License version 2 (the "GPL"),
10*4882a593Smuzhiyun  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
11*4882a593Smuzhiyun  * following added to such license:
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  *      As a special exception, the copyright holders of this software give you
14*4882a593Smuzhiyun  * permission to link this software with independent modules, and to copy and
15*4882a593Smuzhiyun  * distribute the resulting executable under terms of your choice, provided that
16*4882a593Smuzhiyun  * you also meet, for each linked independent module, the terms and conditions of
17*4882a593Smuzhiyun  * the license of that module.  An independent module is a module which is not
18*4882a593Smuzhiyun  * derived from this software.  The special exception does not apply to any
19*4882a593Smuzhiyun  * modifications of the software.
20*4882a593Smuzhiyun  *
21*4882a593Smuzhiyun  *
22*4882a593Smuzhiyun  * <<Broadcom-WL-IPTag/Dual:>>
23*4882a593Smuzhiyun  */
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #ifndef __DHD_PNO_H__
26*4882a593Smuzhiyun #define __DHD_PNO_H__
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #if defined(OEM_ANDROID) && defined(PNO_SUPPORT)
29*4882a593Smuzhiyun #define PNO_TLV_PREFIX			'S'
30*4882a593Smuzhiyun #define PNO_TLV_VERSION			'1'
31*4882a593Smuzhiyun #define PNO_TLV_SUBTYPE_LEGACY_PNO '2'
32*4882a593Smuzhiyun #define PNO_TLV_RESERVED		'0'
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #define PNO_BATCHING_SET "SET"
35*4882a593Smuzhiyun #define PNO_BATCHING_GET "GET"
36*4882a593Smuzhiyun #define PNO_BATCHING_STOP "STOP"
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #define PNO_PARAMS_DELIMETER " "
39*4882a593Smuzhiyun #define PNO_PARAM_CHANNEL_DELIMETER ","
40*4882a593Smuzhiyun #define PNO_PARAM_VALUE_DELLIMETER '='
41*4882a593Smuzhiyun #define PNO_PARAM_SCANFREQ "SCANFREQ"
42*4882a593Smuzhiyun #define PNO_PARAM_BESTN	"BESTN"
43*4882a593Smuzhiyun #define PNO_PARAM_MSCAN "MSCAN"
44*4882a593Smuzhiyun #define PNO_PARAM_CHANNEL "CHANNEL"
45*4882a593Smuzhiyun #define PNO_PARAM_RTT "RTT"
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun #define PNO_TLV_TYPE_SSID_IE		'S'
48*4882a593Smuzhiyun #define PNO_TLV_TYPE_TIME		'T'
49*4882a593Smuzhiyun #define PNO_TLV_FREQ_REPEAT		'R'
50*4882a593Smuzhiyun #define PNO_TLV_FREQ_EXPO_MAX		'M'
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun #define MAXNUM_SSID_PER_ADD	16
53*4882a593Smuzhiyun #define MAXNUM_PNO_PARAMS 2
54*4882a593Smuzhiyun #define PNO_TLV_COMMON_LENGTH	1
55*4882a593Smuzhiyun #define DEFAULT_BATCH_MSCAN 16
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #define RESULTS_END_MARKER "----\n"
58*4882a593Smuzhiyun #define SCAN_END_MARKER "####\n"
59*4882a593Smuzhiyun #define AP_END_MARKER "====\n"
60*4882a593Smuzhiyun #define PNO_RSSI_MARGIN_DBM          30
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun #define CSCAN_COMMAND			"CSCAN "
63*4882a593Smuzhiyun #define CSCAN_TLV_PREFIX		'S'
64*4882a593Smuzhiyun #define CSCAN_TLV_VERSION		1
65*4882a593Smuzhiyun #define CSCAN_TLV_SUBVERSION		0
66*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_SSID_IE		'S'
67*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_CHANNEL_IE	'C'
68*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_NPROBE_IE	'N'
69*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_ACTIVE_IE	'A'
70*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_PASSIVE_IE	'P'
71*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_HOME_IE		'H'
72*4882a593Smuzhiyun #define CSCAN_TLV_TYPE_STYPE_IE		'T'
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun #define WL_SCAN_PARAMS_SSID_MAX         10
75*4882a593Smuzhiyun #define GET_SSID                        "SSID="
76*4882a593Smuzhiyun #define GET_CHANNEL                     "CH="
77*4882a593Smuzhiyun #define GET_NPROBE                      "NPROBE="
78*4882a593Smuzhiyun #define GET_ACTIVE_ASSOC_DWELL          "ACTIVE="
79*4882a593Smuzhiyun #define GET_PASSIVE_ASSOC_DWELL         "PASSIVE="
80*4882a593Smuzhiyun #define GET_HOME_DWELL                  "HOME="
81*4882a593Smuzhiyun #define GET_SCAN_TYPE                   "TYPE="
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun #if defined(GSCAN_SUPPORT) || defined(DHD_GET_VALID_CHANNELS)
84*4882a593Smuzhiyun #define GSCAN_MAX_CH_BUCKETS             8
85*4882a593Smuzhiyun #define GSCAN_MAX_CHANNELS_IN_BUCKET     32
86*4882a593Smuzhiyun #define GSCAN_MAX_AP_CACHE_PER_SCAN      32
87*4882a593Smuzhiyun #define GSCAN_MAX_AP_CACHE               320
88*4882a593Smuzhiyun #define GSCAN_BG_BAND_MASK             (1 << 0)
89*4882a593Smuzhiyun #define GSCAN_A_BAND_MASK              (1 << 1)
90*4882a593Smuzhiyun #define GSCAN_DFS_MASK                 (1 << 2)
91*4882a593Smuzhiyun #define GSCAN_ABG_BAND_MASK            (GSCAN_A_BAND_MASK | GSCAN_BG_BAND_MASK)
92*4882a593Smuzhiyun #define GSCAN_BAND_MASK                (GSCAN_ABG_BAND_MASK | GSCAN_DFS_MASK)
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun #define GSCAN_FLUSH_HOTLIST_CFG      (1 << 0)
95*4882a593Smuzhiyun #define GSCAN_FLUSH_SIGNIFICANT_CFG  (1 << 1)
96*4882a593Smuzhiyun #define GSCAN_FLUSH_SCAN_CFG         (1 << 2)
97*4882a593Smuzhiyun #define GSCAN_FLUSH_EPNO_CFG         (1 << 3)
98*4882a593Smuzhiyun #define GSCAN_FLUSH_ALL_CFG     (GSCAN_FLUSH_SCAN_CFG | \
99*4882a593Smuzhiyun 								GSCAN_FLUSH_SIGNIFICANT_CFG | \
100*4882a593Smuzhiyun 								GSCAN_FLUSH_HOTLIST_CFG  | \
101*4882a593Smuzhiyun 								GSCAN_FLUSH_EPNO_CFG)
102*4882a593Smuzhiyun #define DHD_EPNO_HIDDEN_SSID          (1 << 0)
103*4882a593Smuzhiyun #define DHD_EPNO_A_BAND_TRIG          (1 << 1)
104*4882a593Smuzhiyun #define DHD_EPNO_BG_BAND_TRIG         (1 << 2)
105*4882a593Smuzhiyun #define DHD_EPNO_STRICT_MATCH         (1 << 3)
106*4882a593Smuzhiyun #define DHD_EPNO_SAME_NETWORK         (1 << 4)
107*4882a593Smuzhiyun #define DHD_PNO_USE_SSID              (DHD_EPNO_HIDDEN_SSID | DHD_EPNO_STRICT_MATCH)
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun /* Do not change GSCAN_BATCH_RETRIEVAL_COMPLETE */
110*4882a593Smuzhiyun #define GSCAN_BATCH_RETRIEVAL_COMPLETE      0
111*4882a593Smuzhiyun #define GSCAN_BATCH_RETRIEVAL_IN_PROGRESS   1
112*4882a593Smuzhiyun #define GSCAN_BATCH_NO_THR_SET              101
113*4882a593Smuzhiyun #define GSCAN_LOST_AP_WINDOW_DEFAULT        4
114*4882a593Smuzhiyun #define GSCAN_MIN_BSSID_TIMEOUT             90
115*4882a593Smuzhiyun #define GSCAN_BATCH_GET_MAX_WAIT            500
116*4882a593Smuzhiyun #define CHANNEL_BUCKET_EMPTY_INDEX                      0xFFFF
117*4882a593Smuzhiyun #define GSCAN_RETRY_THRESHOLD              3
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun #define MAX_EPNO_SSID_NUM                   64
120*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT || DHD_GET_VALID_CHANNELS */
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun enum scan_status {
123*4882a593Smuzhiyun 	/* SCAN ABORT by other scan */
124*4882a593Smuzhiyun 	PNO_STATUS_ABORT,
125*4882a593Smuzhiyun 	/* RTT is presence or not */
126*4882a593Smuzhiyun 	PNO_STATUS_RTT_PRESENCE,
127*4882a593Smuzhiyun 	/* Disable PNO by Driver */
128*4882a593Smuzhiyun 	PNO_STATUS_DISABLE,
129*4882a593Smuzhiyun 	/* NORMAL BATCHING GET */
130*4882a593Smuzhiyun 	PNO_STATUS_NORMAL,
131*4882a593Smuzhiyun 	/* WLC_E_PFN_BEST_BATCHING */
132*4882a593Smuzhiyun 	PNO_STATUS_EVENT,
133*4882a593Smuzhiyun 	PNO_STATUS_MAX
134*4882a593Smuzhiyun };
135*4882a593Smuzhiyun #define PNO_STATUS_ABORT_MASK 0x0001
136*4882a593Smuzhiyun #define PNO_STATUS_RTT_MASK 0x0002
137*4882a593Smuzhiyun #define PNO_STATUS_DISABLE_MASK 0x0004
138*4882a593Smuzhiyun #define PNO_STATUS_OOM_MASK 0x0010
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun enum index_mode {
141*4882a593Smuzhiyun 	INDEX_OF_LEGACY_PARAMS,
142*4882a593Smuzhiyun 	INDEX_OF_BATCH_PARAMS,
143*4882a593Smuzhiyun 	INDEX_OF_HOTLIST_PARAMS,
144*4882a593Smuzhiyun 	/* GSCAN includes hotlist scan and they do not run
145*4882a593Smuzhiyun 	 * independent of each other
146*4882a593Smuzhiyun 	 */
147*4882a593Smuzhiyun 	INDEX_OF_GSCAN_PARAMS = INDEX_OF_HOTLIST_PARAMS,
148*4882a593Smuzhiyun 	INDEX_MODE_MAX
149*4882a593Smuzhiyun };
150*4882a593Smuzhiyun enum dhd_pno_status {
151*4882a593Smuzhiyun 	DHD_PNO_DISABLED,
152*4882a593Smuzhiyun 	DHD_PNO_ENABLED,
153*4882a593Smuzhiyun 	DHD_PNO_SUSPEND
154*4882a593Smuzhiyun };
155*4882a593Smuzhiyun typedef struct cmd_tlv {
156*4882a593Smuzhiyun 	char prefix;
157*4882a593Smuzhiyun 	char version;
158*4882a593Smuzhiyun 	char subtype;
159*4882a593Smuzhiyun 	char reserved;
160*4882a593Smuzhiyun } cmd_tlv_t;
161*4882a593Smuzhiyun #if defined(GSCAN_SUPPORT) || defined(DHD_GET_VALID_CHANNELS)
162*4882a593Smuzhiyun typedef enum {
163*4882a593Smuzhiyun 	HOTLIST_LOST,
164*4882a593Smuzhiyun 	HOTLIST_FOUND
165*4882a593Smuzhiyun } hotlist_type_t;
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun typedef enum dhd_pno_gscan_cmd_cfg {
168*4882a593Smuzhiyun 	DHD_PNO_BATCH_SCAN_CFG_ID = 0,
169*4882a593Smuzhiyun 	DHD_PNO_GEOFENCE_SCAN_CFG_ID,
170*4882a593Smuzhiyun 	DHD_PNO_SIGNIFICANT_SCAN_CFG_ID,
171*4882a593Smuzhiyun 	DHD_PNO_SCAN_CFG_ID,
172*4882a593Smuzhiyun 	DHD_PNO_GET_CAPABILITIES,
173*4882a593Smuzhiyun 	DHD_PNO_GET_BATCH_RESULTS,
174*4882a593Smuzhiyun 	DHD_PNO_GET_CHANNEL_LIST,
175*4882a593Smuzhiyun 	DHD_PNO_GET_NEW_EPNO_SSID_ELEM,
176*4882a593Smuzhiyun 	DHD_PNO_EPNO_CFG_ID,
177*4882a593Smuzhiyun 	DHD_PNO_GET_AUTOJOIN_CAPABILITIES,
178*4882a593Smuzhiyun 	DHD_PNO_EPNO_PARAMS_ID
179*4882a593Smuzhiyun } dhd_pno_gscan_cmd_cfg_t;
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun typedef enum dhd_pno_mode {
182*4882a593Smuzhiyun 	/* Wi-Fi Legacy PNO Mode */
183*4882a593Smuzhiyun 	DHD_PNO_NONE_MODE   = 0,
184*4882a593Smuzhiyun 	DHD_PNO_LEGACY_MODE = (1 << (0)),
185*4882a593Smuzhiyun 	/* Wi-Fi Android BATCH SCAN Mode */
186*4882a593Smuzhiyun 	DHD_PNO_BATCH_MODE = (1 << (1)),
187*4882a593Smuzhiyun 	/* Wi-Fi Android Hotlist SCAN Mode */
188*4882a593Smuzhiyun 	DHD_PNO_HOTLIST_MODE = (1 << (2)),
189*4882a593Smuzhiyun 	/* Wi-Fi Google Android SCAN Mode */
190*4882a593Smuzhiyun 	DHD_PNO_GSCAN_MODE = (1 << (3))
191*4882a593Smuzhiyun } dhd_pno_mode_t;
192*4882a593Smuzhiyun #else
193*4882a593Smuzhiyun typedef enum dhd_pno_mode {
194*4882a593Smuzhiyun 	/* Wi-Fi Legacy PNO Mode */
195*4882a593Smuzhiyun 	DHD_PNO_NONE_MODE   = 0,
196*4882a593Smuzhiyun 	DHD_PNO_LEGACY_MODE = (1 << (0)),
197*4882a593Smuzhiyun 	/* Wi-Fi Android BATCH SCAN Mode */
198*4882a593Smuzhiyun 	DHD_PNO_BATCH_MODE = (1 << (1)),
199*4882a593Smuzhiyun 	/* Wi-Fi Android Hotlist SCAN Mode */
200*4882a593Smuzhiyun 	DHD_PNO_HOTLIST_MODE = (1 << (2))
201*4882a593Smuzhiyun } dhd_pno_mode_t;
202*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT || DHD_GET_VALID_CHANNELS */
203*4882a593Smuzhiyun 
204*4882a593Smuzhiyun typedef struct dhd_pno_ssid {
205*4882a593Smuzhiyun 	bool		hidden;
206*4882a593Smuzhiyun 	int8		rssi_thresh;
207*4882a593Smuzhiyun 	uint8		dummy;
208*4882a593Smuzhiyun 	uint16		SSID_len;
209*4882a593Smuzhiyun 	uint32		flags;
210*4882a593Smuzhiyun 	int32		wpa_auth;
211*4882a593Smuzhiyun 	uchar		SSID[DOT11_MAX_SSID_LEN];
212*4882a593Smuzhiyun 	struct list_head list;
213*4882a593Smuzhiyun } dhd_pno_ssid_t;
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun struct dhd_pno_bssid {
216*4882a593Smuzhiyun 	struct ether_addr	macaddr;
217*4882a593Smuzhiyun 	/* Bit4: suppress_lost, Bit3: suppress_found */
218*4882a593Smuzhiyun 	uint16			flags;
219*4882a593Smuzhiyun 	struct list_head list;
220*4882a593Smuzhiyun };
221*4882a593Smuzhiyun 
222*4882a593Smuzhiyun typedef struct dhd_pno_bestnet_entry {
223*4882a593Smuzhiyun 	struct ether_addr BSSID;
224*4882a593Smuzhiyun 	uint8	SSID_len;
225*4882a593Smuzhiyun 	uint8	SSID[DOT11_MAX_SSID_LEN];
226*4882a593Smuzhiyun 	int8	RSSI;
227*4882a593Smuzhiyun 	uint8	channel;
228*4882a593Smuzhiyun 	uint32	timestamp;
229*4882a593Smuzhiyun 	uint16	rtt0; /* distance_cm based on RTT */
230*4882a593Smuzhiyun 	uint16	rtt1; /* distance_cm based on sample standard deviation */
231*4882a593Smuzhiyun 	unsigned long recorded_time;
232*4882a593Smuzhiyun 	struct list_head list;
233*4882a593Smuzhiyun } dhd_pno_bestnet_entry_t;
234*4882a593Smuzhiyun #define BESTNET_ENTRY_SIZE (sizeof(dhd_pno_bestnet_entry_t))
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun typedef struct dhd_pno_bestnet_header {
237*4882a593Smuzhiyun 	struct dhd_pno_bestnet_header *next;
238*4882a593Smuzhiyun 	uint8 reason;
239*4882a593Smuzhiyun 	uint32 tot_cnt;
240*4882a593Smuzhiyun 	uint32 tot_size;
241*4882a593Smuzhiyun 	struct list_head entry_list;
242*4882a593Smuzhiyun } dhd_pno_best_header_t;
243*4882a593Smuzhiyun #define BEST_HEADER_SIZE (sizeof(dhd_pno_best_header_t))
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun typedef struct dhd_pno_scan_results {
246*4882a593Smuzhiyun 	dhd_pno_best_header_t *bestnetheader;
247*4882a593Smuzhiyun 	uint8 cnt_header;
248*4882a593Smuzhiyun 	struct list_head list;
249*4882a593Smuzhiyun } dhd_pno_scan_results_t;
250*4882a593Smuzhiyun #define SCAN_RESULTS_SIZE (sizeof(dhd_pno_scan_results_t))
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun struct dhd_pno_get_batch_info {
253*4882a593Smuzhiyun 	/* info related to get batch */
254*4882a593Smuzhiyun 	char *buf;
255*4882a593Smuzhiyun 	bool batch_started;
256*4882a593Smuzhiyun 	uint32 tot_scan_cnt;
257*4882a593Smuzhiyun 	uint32 expired_tot_scan_cnt;
258*4882a593Smuzhiyun 	uint32 top_node_cnt;
259*4882a593Smuzhiyun 	uint32 bufsize;
260*4882a593Smuzhiyun 	uint32 bytes_written;
261*4882a593Smuzhiyun 	int reason;
262*4882a593Smuzhiyun 	struct list_head scan_results_list;
263*4882a593Smuzhiyun 	struct list_head expired_scan_results_list;
264*4882a593Smuzhiyun };
265*4882a593Smuzhiyun struct dhd_pno_legacy_params {
266*4882a593Smuzhiyun 	uint16 scan_fr;
267*4882a593Smuzhiyun 	uint16 chan_list[WL_NUMCHANNELS];
268*4882a593Smuzhiyun 	uint16 nchan;
269*4882a593Smuzhiyun 	int pno_repeat;
270*4882a593Smuzhiyun 	int pno_freq_expo_max;
271*4882a593Smuzhiyun 	int nssid;
272*4882a593Smuzhiyun 	struct list_head ssid_list;
273*4882a593Smuzhiyun };
274*4882a593Smuzhiyun struct dhd_pno_batch_params {
275*4882a593Smuzhiyun 	int32 scan_fr;
276*4882a593Smuzhiyun 	uint8 bestn;
277*4882a593Smuzhiyun 	uint8 mscan;
278*4882a593Smuzhiyun 	uint8 band;
279*4882a593Smuzhiyun 	uint16 chan_list[WL_NUMCHANNELS];
280*4882a593Smuzhiyun 	uint16 nchan;
281*4882a593Smuzhiyun 	uint16 rtt;
282*4882a593Smuzhiyun 	struct dhd_pno_get_batch_info get_batch;
283*4882a593Smuzhiyun };
284*4882a593Smuzhiyun struct dhd_pno_hotlist_params {
285*4882a593Smuzhiyun 	uint8 band;
286*4882a593Smuzhiyun 	int32 scan_fr;
287*4882a593Smuzhiyun 	uint16 chan_list[WL_NUMCHANNELS];
288*4882a593Smuzhiyun 	uint16 nchan;
289*4882a593Smuzhiyun 	uint16 nbssid;
290*4882a593Smuzhiyun 	struct list_head bssid_list;
291*4882a593Smuzhiyun };
292*4882a593Smuzhiyun 
293*4882a593Smuzhiyun #define DHD_PNO_CHSPEC_SUPPORT_VER	14
294*4882a593Smuzhiyun 
295*4882a593Smuzhiyun #if defined(GSCAN_SUPPORT) || defined(DHD_GET_VALID_CHANNELS)
296*4882a593Smuzhiyun #define DHD_PNO_REPORT_NO_BATCH      (1 << 2)
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun typedef struct dhd_pno_gscan_channel_bucket {
299*4882a593Smuzhiyun 	uint16 bucket_freq_multiple;
300*4882a593Smuzhiyun 	/* band = 1 All bg band channels,
301*4882a593Smuzhiyun 	 * band = 2 All a band channels,
302*4882a593Smuzhiyun 	 * band = 0 chan_list channels
303*4882a593Smuzhiyun 	 */
304*4882a593Smuzhiyun 	uint16 band;
305*4882a593Smuzhiyun 	uint8 report_flag;
306*4882a593Smuzhiyun 	uint8 num_channels;
307*4882a593Smuzhiyun 	uint16 repeat;
308*4882a593Smuzhiyun 	uint16 bucket_max_multiple;
309*4882a593Smuzhiyun 	uint16 chan_list[GSCAN_MAX_CHANNELS_IN_BUCKET];
310*4882a593Smuzhiyun } dhd_pno_gscan_channel_bucket_t;
311*4882a593Smuzhiyun 
312*4882a593Smuzhiyun #define DHD_PNO_AUTH_CODE_OPEN  1 /*  Open   */
313*4882a593Smuzhiyun #define DHD_PNO_AUTH_CODE_PSK   2 /* WPA_PSK or WPA2PSK */
314*4882a593Smuzhiyun #define DHD_PNO_AUTH_CODE_EAPOL 4 /* any EAPOL    */
315*4882a593Smuzhiyun 
316*4882a593Smuzhiyun #define DHD_EPNO_DEFAULT_INDEX     0xFFFFFFFF
317*4882a593Smuzhiyun 
318*4882a593Smuzhiyun typedef struct dhd_epno_params {
319*4882a593Smuzhiyun 	uint8 ssid[DOT11_MAX_SSID_LEN];
320*4882a593Smuzhiyun 	uint8 ssid_len;
321*4882a593Smuzhiyun 	int8 rssi_thresh;
322*4882a593Smuzhiyun 	uint8 flags;
323*4882a593Smuzhiyun 	uint8 auth;
324*4882a593Smuzhiyun 	/* index required only for visble ssid */
325*4882a593Smuzhiyun 	uint32 index;
326*4882a593Smuzhiyun 	struct list_head list;
327*4882a593Smuzhiyun } dhd_epno_params_t;
328*4882a593Smuzhiyun 
329*4882a593Smuzhiyun typedef struct dhd_epno_results {
330*4882a593Smuzhiyun 	uint8 ssid[DOT11_MAX_SSID_LEN];
331*4882a593Smuzhiyun 	uint8 ssid_len;
332*4882a593Smuzhiyun 	int8 rssi;
333*4882a593Smuzhiyun 	uint16 channel;
334*4882a593Smuzhiyun 	uint16 flags;
335*4882a593Smuzhiyun 	struct ether_addr bssid;
336*4882a593Smuzhiyun } dhd_epno_results_t;
337*4882a593Smuzhiyun 
338*4882a593Smuzhiyun typedef struct dhd_pno_swc_evt_param {
339*4882a593Smuzhiyun 	uint16 results_rxed_so_far;
340*4882a593Smuzhiyun 	wl_pfn_significant_net_t *change_array;
341*4882a593Smuzhiyun } dhd_pno_swc_evt_param_t;
342*4882a593Smuzhiyun 
343*4882a593Smuzhiyun typedef struct wifi_gscan_result {
344*4882a593Smuzhiyun 	uint64 ts;			/* Time of discovery           */
345*4882a593Smuzhiyun 	char ssid[DOT11_MAX_SSID_LEN+1]; /* null terminated		*/
346*4882a593Smuzhiyun 	struct ether_addr macaddr;	/* BSSID                      */
347*4882a593Smuzhiyun 	uint32 channel;			/* channel frequency in MHz    */
348*4882a593Smuzhiyun 	int32 rssi;			/* in db                       */
349*4882a593Smuzhiyun 	uint64 rtt;			/* in nanoseconds              */
350*4882a593Smuzhiyun 	uint64 rtt_sd;			/* standard deviation in rtt   */
351*4882a593Smuzhiyun 	uint16 beacon_period;		/* units are Kusec             */
352*4882a593Smuzhiyun 	uint16 capability;		/* Capability information       */
353*4882a593Smuzhiyun 	uint32 pad;
354*4882a593Smuzhiyun } wifi_gscan_result_t;
355*4882a593Smuzhiyun 
356*4882a593Smuzhiyun typedef struct wifi_gscan_full_result {
357*4882a593Smuzhiyun     wifi_gscan_result_t fixed;
358*4882a593Smuzhiyun     uint32 scan_ch_bucket;
359*4882a593Smuzhiyun     uint32 ie_length;		/* byte length of Information Elements */
360*4882a593Smuzhiyun     char  ie_data[1];		/* IE  data to follow       */
361*4882a593Smuzhiyun } wifi_gscan_full_result_t;
362*4882a593Smuzhiyun 
363*4882a593Smuzhiyun typedef struct gscan_results_cache {
364*4882a593Smuzhiyun 	struct gscan_results_cache *next;
365*4882a593Smuzhiyun 	uint8  scan_id;
366*4882a593Smuzhiyun 	uint8  flag;
367*4882a593Smuzhiyun 	uint8  tot_count;
368*4882a593Smuzhiyun 	uint8  tot_consumed;
369*4882a593Smuzhiyun 	uint32 scan_ch_bucket;
370*4882a593Smuzhiyun 	wifi_gscan_result_t results[1];
371*4882a593Smuzhiyun } gscan_results_cache_t;
372*4882a593Smuzhiyun 
373*4882a593Smuzhiyun typedef struct dhd_pno_gscan_capabilities {
374*4882a593Smuzhiyun 	int max_scan_cache_size;
375*4882a593Smuzhiyun 	int max_scan_buckets;
376*4882a593Smuzhiyun 	int max_ap_cache_per_scan;
377*4882a593Smuzhiyun 	int max_rssi_sample_size;
378*4882a593Smuzhiyun 	int max_scan_reporting_threshold;
379*4882a593Smuzhiyun 	int max_hotlist_bssids;
380*4882a593Smuzhiyun 	int max_hotlist_ssids;
381*4882a593Smuzhiyun 	int max_significant_wifi_change_aps;
382*4882a593Smuzhiyun 	int max_bssid_history_entries;
383*4882a593Smuzhiyun 	int max_epno_ssid_crc32;
384*4882a593Smuzhiyun 	int max_epno_hidden_ssid;
385*4882a593Smuzhiyun 	int max_white_list_ssid;
386*4882a593Smuzhiyun } dhd_pno_gscan_capabilities_t;
387*4882a593Smuzhiyun 
388*4882a593Smuzhiyun typedef struct dhd_epno_ssid_cfg {
389*4882a593Smuzhiyun 	wl_ssid_ext_params_t params;
390*4882a593Smuzhiyun 	uint32 num_epno_ssid;
391*4882a593Smuzhiyun 	struct list_head epno_ssid_list;
392*4882a593Smuzhiyun } dhd_epno_ssid_cfg_t;
393*4882a593Smuzhiyun 
394*4882a593Smuzhiyun struct dhd_pno_gscan_params {
395*4882a593Smuzhiyun 	int32 scan_fr;
396*4882a593Smuzhiyun 	uint8 bestn;
397*4882a593Smuzhiyun 	uint8 mscan;
398*4882a593Smuzhiyun 	uint8 buffer_threshold;
399*4882a593Smuzhiyun 	uint8 swc_nbssid_threshold;
400*4882a593Smuzhiyun 	uint8 swc_rssi_window_size;
401*4882a593Smuzhiyun 	uint8 lost_ap_window;
402*4882a593Smuzhiyun 	uint8 nchannel_buckets;
403*4882a593Smuzhiyun 	uint8 reason;
404*4882a593Smuzhiyun 	uint8 get_batch_flag;
405*4882a593Smuzhiyun 	uint8 send_all_results_flag;
406*4882a593Smuzhiyun 	uint16 max_ch_bucket_freq;
407*4882a593Smuzhiyun 	gscan_results_cache_t *gscan_batch_cache;
408*4882a593Smuzhiyun 	gscan_results_cache_t *gscan_hotlist_found;
409*4882a593Smuzhiyun 	gscan_results_cache_t*gscan_hotlist_lost;
410*4882a593Smuzhiyun 	uint16 nbssid_significant_change;
411*4882a593Smuzhiyun 	uint16 nbssid_hotlist;
412*4882a593Smuzhiyun 	struct dhd_pno_swc_evt_param param_significant;
413*4882a593Smuzhiyun 	struct dhd_pno_gscan_channel_bucket channel_bucket[GSCAN_MAX_CH_BUCKETS];
414*4882a593Smuzhiyun 	struct list_head hotlist_bssid_list;
415*4882a593Smuzhiyun 	struct list_head significant_bssid_list;
416*4882a593Smuzhiyun 	dhd_epno_ssid_cfg_t epno_cfg;
417*4882a593Smuzhiyun 	uint32 scan_id;
418*4882a593Smuzhiyun };
419*4882a593Smuzhiyun 
420*4882a593Smuzhiyun typedef struct gscan_scan_params {
421*4882a593Smuzhiyun 	int32 scan_fr;
422*4882a593Smuzhiyun 	uint16 nchannel_buckets;
423*4882a593Smuzhiyun 	struct dhd_pno_gscan_channel_bucket channel_bucket[GSCAN_MAX_CH_BUCKETS];
424*4882a593Smuzhiyun } gscan_scan_params_t;
425*4882a593Smuzhiyun 
426*4882a593Smuzhiyun typedef struct gscan_batch_params {
427*4882a593Smuzhiyun 	uint8 bestn;
428*4882a593Smuzhiyun 	uint8 mscan;
429*4882a593Smuzhiyun 	uint8 buffer_threshold;
430*4882a593Smuzhiyun } gscan_batch_params_t;
431*4882a593Smuzhiyun 
432*4882a593Smuzhiyun struct bssid_t {
433*4882a593Smuzhiyun 	struct ether_addr	macaddr;
434*4882a593Smuzhiyun 	int16 rssi_reporting_threshold;  /* 0 -> no reporting threshold */
435*4882a593Smuzhiyun };
436*4882a593Smuzhiyun 
437*4882a593Smuzhiyun typedef struct gscan_hotlist_scan_params {
438*4882a593Smuzhiyun 	uint16 lost_ap_window; /* number of scans to declare LOST */
439*4882a593Smuzhiyun 	uint16 nbssid;   /* number of bssids  */
440*4882a593Smuzhiyun 	struct bssid_t bssid[1];  /* n bssids to follow */
441*4882a593Smuzhiyun } gscan_hotlist_scan_params_t;
442*4882a593Smuzhiyun 
443*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT || DHD_GET_VALID_CHANNELS */
444*4882a593Smuzhiyun 
445*4882a593Smuzhiyun typedef union dhd_pno_params {
446*4882a593Smuzhiyun 	struct dhd_pno_legacy_params params_legacy;
447*4882a593Smuzhiyun 	struct dhd_pno_batch_params params_batch;
448*4882a593Smuzhiyun 	struct dhd_pno_hotlist_params params_hotlist;
449*4882a593Smuzhiyun #if defined(GSCAN_SUPPORT) || defined(DHD_GET_VALID_CHANNELS)
450*4882a593Smuzhiyun 	struct dhd_pno_gscan_params params_gscan;
451*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT || DHD_GET_VALID_CHANNELS */
452*4882a593Smuzhiyun } dhd_pno_params_t;
453*4882a593Smuzhiyun 
454*4882a593Smuzhiyun typedef struct dhd_pno_status_info {
455*4882a593Smuzhiyun 	dhd_pub_t *dhd;
456*4882a593Smuzhiyun 	struct work_struct work;
457*4882a593Smuzhiyun 	struct mutex pno_mutex;
458*4882a593Smuzhiyun #ifdef GSCAN_SUPPORT
459*4882a593Smuzhiyun 	wait_queue_head_t batch_get_wait;
460*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT */
461*4882a593Smuzhiyun #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 7, 0))
462*4882a593Smuzhiyun 	wait_queue_head_t get_batch_done;
463*4882a593Smuzhiyun 	bool batch_recvd;
464*4882a593Smuzhiyun #else
465*4882a593Smuzhiyun 	struct completion get_batch_done;
466*4882a593Smuzhiyun #endif
467*4882a593Smuzhiyun 	bool wls_supported; /* wifi location service supported or not */
468*4882a593Smuzhiyun 	enum dhd_pno_status pno_status;
469*4882a593Smuzhiyun 	enum dhd_pno_mode pno_mode;
470*4882a593Smuzhiyun 	dhd_pno_params_t pno_params_arr[INDEX_MODE_MAX];
471*4882a593Smuzhiyun 	struct list_head head_list;
472*4882a593Smuzhiyun } dhd_pno_status_info_t;
473*4882a593Smuzhiyun 
474*4882a593Smuzhiyun /* wrapper functions */
475*4882a593Smuzhiyun extern int
476*4882a593Smuzhiyun dhd_dev_pno_enable(struct net_device *dev, int enable);
477*4882a593Smuzhiyun 
478*4882a593Smuzhiyun extern int
479*4882a593Smuzhiyun dhd_dev_pno_stop_for_ssid(struct net_device *dev);
480*4882a593Smuzhiyun 
481*4882a593Smuzhiyun extern int
482*4882a593Smuzhiyun dhd_dev_pno_set_for_ssid(struct net_device *dev, wlc_ssid_ext_t* ssids_local, int nssid,
483*4882a593Smuzhiyun 	uint16 scan_fr, int pno_repeat, int pno_freq_expo_max, uint16 *channel_list, int nchan);
484*4882a593Smuzhiyun 
485*4882a593Smuzhiyun extern int
486*4882a593Smuzhiyun dhd_dev_pno_set_for_batch(struct net_device *dev,
487*4882a593Smuzhiyun 	struct dhd_pno_batch_params *batch_params);
488*4882a593Smuzhiyun 
489*4882a593Smuzhiyun extern int
490*4882a593Smuzhiyun dhd_dev_pno_get_for_batch(struct net_device *dev, char *buf, int bufsize);
491*4882a593Smuzhiyun 
492*4882a593Smuzhiyun extern int
493*4882a593Smuzhiyun dhd_dev_pno_stop_for_batch(struct net_device *dev);
494*4882a593Smuzhiyun 
495*4882a593Smuzhiyun extern int
496*4882a593Smuzhiyun dhd_dev_pno_set_for_hotlist(struct net_device *dev, wl_pfn_bssid_t *p_pfn_bssid,
497*4882a593Smuzhiyun 	struct dhd_pno_hotlist_params *hotlist_params);
498*4882a593Smuzhiyun extern bool dhd_dev_is_legacy_pno_enabled(struct net_device *dev);
499*4882a593Smuzhiyun #if defined (GSCAN_SUPPORT) || defined(DHD_GET_VALID_CHANNELS)
500*4882a593Smuzhiyun extern void *
501*4882a593Smuzhiyun dhd_dev_pno_get_gscan(struct net_device *dev, dhd_pno_gscan_cmd_cfg_t type, void *info,
502*4882a593Smuzhiyun         uint32 *len);
503*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT || DHD_GET_VALID_CHANNELS */
504*4882a593Smuzhiyun #ifdef GSCAN_SUPPORT
505*4882a593Smuzhiyun extern int
506*4882a593Smuzhiyun dhd_dev_pno_set_cfg_gscan(struct net_device *dev, dhd_pno_gscan_cmd_cfg_t type,
507*4882a593Smuzhiyun               void *buf, bool flush);
508*4882a593Smuzhiyun int dhd_dev_pno_lock_access_batch_results(struct net_device *dev);
509*4882a593Smuzhiyun void dhd_dev_pno_unlock_access_batch_results(struct net_device *dev);
510*4882a593Smuzhiyun extern int dhd_dev_pno_run_gscan(struct net_device *dev, bool run, bool flush);
511*4882a593Smuzhiyun extern int dhd_dev_pno_enable_full_scan_result(struct net_device *dev, bool real_time);
512*4882a593Smuzhiyun int dhd_retreive_batch_scan_results(dhd_pub_t *dhd);
513*4882a593Smuzhiyun extern void * dhd_dev_hotlist_scan_event(struct net_device *dev,
514*4882a593Smuzhiyun             const void  *data, int *send_evt_bytes, hotlist_type_t type, u32 *buf_len);
515*4882a593Smuzhiyun void * dhd_dev_process_full_gscan_result(struct net_device *dev,
516*4882a593Smuzhiyun             const void  *data, uint32 len, int *send_evt_bytes);
517*4882a593Smuzhiyun extern int dhd_dev_gscan_batch_cache_cleanup(struct net_device *dev);
518*4882a593Smuzhiyun extern void dhd_dev_gscan_hotlist_cache_cleanup(struct net_device *dev, hotlist_type_t type);
519*4882a593Smuzhiyun extern int dhd_dev_wait_batch_results_complete(struct net_device *dev);
520*4882a593Smuzhiyun extern void * dhd_dev_process_epno_result(struct net_device *dev,
521*4882a593Smuzhiyun 		const void  *data, uint32 event, int *send_evt_bytes);
522*4882a593Smuzhiyun extern int dhd_dev_set_epno(struct net_device *dev);
523*4882a593Smuzhiyun extern int dhd_dev_flush_fw_epno(struct net_device *dev);
524*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT */
525*4882a593Smuzhiyun /* dhd pno fuctions */
526*4882a593Smuzhiyun extern int dhd_pno_stop_for_ssid(dhd_pub_t *dhd);
527*4882a593Smuzhiyun extern int dhd_pno_enable(dhd_pub_t *dhd, int enable);
528*4882a593Smuzhiyun extern int dhd_pno_set_for_ssid(dhd_pub_t *dhd, wlc_ssid_ext_t* ssid_list, int nssid,
529*4882a593Smuzhiyun 	uint16  scan_fr, int pno_repeat, int pno_freq_expo_max, uint16 *channel_list, int nchan);
530*4882a593Smuzhiyun 
531*4882a593Smuzhiyun extern int dhd_pno_set_for_batch(dhd_pub_t *dhd, struct dhd_pno_batch_params *batch_params);
532*4882a593Smuzhiyun 
533*4882a593Smuzhiyun extern int dhd_pno_get_for_batch(dhd_pub_t *dhd, char *buf, int bufsize, int reason);
534*4882a593Smuzhiyun 
535*4882a593Smuzhiyun extern int dhd_pno_stop_for_batch(dhd_pub_t *dhd);
536*4882a593Smuzhiyun 
537*4882a593Smuzhiyun extern int dhd_pno_set_for_hotlist(dhd_pub_t *dhd, wl_pfn_bssid_t *p_pfn_bssid,
538*4882a593Smuzhiyun 	struct dhd_pno_hotlist_params *hotlist_params);
539*4882a593Smuzhiyun 
540*4882a593Smuzhiyun extern int dhd_pno_stop_for_hotlist(dhd_pub_t *dhd);
541*4882a593Smuzhiyun 
542*4882a593Smuzhiyun extern int dhd_pno_event_handler(dhd_pub_t *dhd, wl_event_msg_t *event, void *event_data);
543*4882a593Smuzhiyun extern int dhd_pno_init(dhd_pub_t *dhd);
544*4882a593Smuzhiyun extern int dhd_pno_deinit(dhd_pub_t *dhd);
545*4882a593Smuzhiyun extern bool dhd_is_pno_supported(dhd_pub_t *dhd);
546*4882a593Smuzhiyun extern bool dhd_is_legacy_pno_enabled(dhd_pub_t *dhd);
547*4882a593Smuzhiyun #if defined (GSCAN_SUPPORT) || defined(DHD_GET_VALID_CHANNELS)
548*4882a593Smuzhiyun extern void * dhd_pno_get_gscan(dhd_pub_t *dhd, dhd_pno_gscan_cmd_cfg_t type, void *info,
549*4882a593Smuzhiyun                        uint32 *len);
550*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT || DHD_GET_VALID_CHANNELS */
551*4882a593Smuzhiyun #ifdef GSCAN_SUPPORT
552*4882a593Smuzhiyun extern int dhd_pno_set_cfg_gscan(dhd_pub_t *dhd, dhd_pno_gscan_cmd_cfg_t type,
553*4882a593Smuzhiyun                        void *buf, bool flush);
554*4882a593Smuzhiyun extern int dhd_pno_lock_batch_results(dhd_pub_t *dhd);
555*4882a593Smuzhiyun extern void dhd_pno_unlock_batch_results(dhd_pub_t *dhd);
556*4882a593Smuzhiyun extern int dhd_pno_initiate_gscan_request(dhd_pub_t *dhd, bool run, bool flush);
557*4882a593Smuzhiyun extern int dhd_pno_enable_full_scan_result(dhd_pub_t *dhd, bool real_time_flag);
558*4882a593Smuzhiyun extern int dhd_pno_cfg_gscan(dhd_pub_t *dhd, dhd_pno_gscan_cmd_cfg_t type, void *buf);
559*4882a593Smuzhiyun extern int dhd_dev_retrieve_batch_scan(struct net_device *dev);
560*4882a593Smuzhiyun extern void *dhd_handle_hotlist_scan_evt(dhd_pub_t *dhd, const void *event_data,
561*4882a593Smuzhiyun                        int *send_evt_bytes, hotlist_type_t type, u32 *buf_len);
562*4882a593Smuzhiyun extern void *dhd_process_full_gscan_result(dhd_pub_t *dhd, const void *event_data,
563*4882a593Smuzhiyun                        uint32 len, int *send_evt_bytes);
564*4882a593Smuzhiyun extern int dhd_gscan_batch_cache_cleanup(dhd_pub_t *dhd);
565*4882a593Smuzhiyun extern void dhd_gscan_hotlist_cache_cleanup(dhd_pub_t *dhd, hotlist_type_t type);
566*4882a593Smuzhiyun extern int dhd_wait_batch_results_complete(dhd_pub_t *dhd);
567*4882a593Smuzhiyun extern void * dhd_pno_process_epno_result(dhd_pub_t *dhd, const void *data,
568*4882a593Smuzhiyun          uint32 event, int *size);
569*4882a593Smuzhiyun extern void dhd_pno_translate_epno_fw_flags(uint32 *flags);
570*4882a593Smuzhiyun extern int dhd_pno_set_epno(dhd_pub_t *dhd);
571*4882a593Smuzhiyun extern int dhd_pno_flush_fw_epno(dhd_pub_t *dhd);
572*4882a593Smuzhiyun extern void dhd_pno_set_epno_auth_flag(uint32 *wpa_auth);
573*4882a593Smuzhiyun #endif /* GSCAN_SUPPORT */
574*4882a593Smuzhiyun #endif /* #if defined(OEM_ANDROID) && defined(PNO_SUPPORT) */
575*4882a593Smuzhiyun 
576*4882a593Smuzhiyun #if defined(NDIS)
577*4882a593Smuzhiyun #if defined(PNO_SUPPORT)
578*4882a593Smuzhiyun extern int dhd_pno_cfg(dhd_pub_t *dhd, wl_pfn_cfg_t *pcfg);
579*4882a593Smuzhiyun extern int dhd_pno_suspend(dhd_pub_t *dhd, int pfn_suspend);
580*4882a593Smuzhiyun extern int dhd_pno_set_add(dhd_pub_t *dhd, wl_pfn_t *netinfo, int nssid, ushort scan_fr,
581*4882a593Smuzhiyun 	ushort slowscan_fr, uint8 pno_repeat, uint8 pno_freq_expo_max, int16 flags);
582*4882a593Smuzhiyun extern int dhd_pno_enable(dhd_pub_t *dhd, int pfn_enabled);
583*4882a593Smuzhiyun extern int dhd_pno_clean(dhd_pub_t *dhd);
584*4882a593Smuzhiyun #endif /* #if defined(PNO_SUPPORT) */
585*4882a593Smuzhiyun #endif /* #if defined(NDIS) */
586*4882a593Smuzhiyun #endif /* __DHD_PNO_H__ */
587