1 /* 2 * Copyright (c) 2017-2019 The Linux Foundation. All rights reserved. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for 5 * any purpose with or without fee is hereby granted, provided that the 6 * above copyright notice and this permission notice appear in all 7 * copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 10 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 11 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 12 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 13 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 14 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 15 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 16 * PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 /** 20 * DOC: declares driver functions interfacing with linux kernel 21 */ 22 23 24 #ifndef _WLAN_CFG80211_SCAN_H_ 25 #define _WLAN_CFG80211_SCAN_H_ 26 27 #include <linux/version.h> 28 #include <linux/netdevice.h> 29 #include <net/cfg80211.h> 30 #include <qca_vendor.h> 31 #include <wlan_scan_public_structs.h> 32 #include <qdf_list.h> 33 #include <qdf_types.h> 34 #include <wlan_scan_ucfg_api.h> 35 #include <wlan_mgmt_txrx_utils_api.h> 36 37 /* Max number of scans allowed from userspace */ 38 #define WLAN_MAX_SCAN_COUNT 8 39 40 /* GPS application requirement */ 41 #define QCOM_VENDOR_IE_ID 221 42 #define QCOM_OUI1 0x00 43 #define QCOM_OUI2 0xA0 44 #define QCOM_OUI3 0xC6 45 #define QCOM_VENDOR_IE_AGE_TYPE 0x100 46 #define QCOM_VENDOR_IE_AGE_LEN (sizeof(qcom_ie_age) - 2) 47 #define SCAN_DONE_EVENT_BUF_SIZE 4096 48 #define SCAN_WAKE_LOCK_CONNECT_DURATION (1 * 1000) /* in msec */ 49 #define SCAN_WAKE_LOCK_SCAN_DURATION (5 * 1000) /* in msec */ 50 51 /** 52 * typedef struct qcom_ie_age - age ie 53 * 54 * @element_id: Element id 55 * @len: Length 56 * @oui_1: OUI 1 57 * @oui_2: OUI 2 58 * @oui_3: OUI 3 59 * @type: Type 60 * @age: Age 61 * @tsf_delta: tsf delta from FW 62 * @beacon_tsf: original beacon TSF 63 * @seq_ctrl: sequence control field 64 */ 65 typedef struct { 66 u8 element_id; 67 u8 len; 68 u8 oui_1; 69 u8 oui_2; 70 u8 oui_3; 71 u32 type; 72 u32 age; 73 u32 tsf_delta; 74 u64 beacon_tsf; 75 u16 seq_ctrl; 76 } __attribute__ ((packed)) qcom_ie_age; 77 78 /** 79 * struct osif_scan_pdev - OS scan private strcutre 80 * scan_req_q: Scan request queue 81 * scan_req_q_lock: Protect scan request queue 82 * req_id: Scan request Id 83 * runtime_pm_lock: Runtime suspend lock 84 * scan_wake_lock: Scan wake lock 85 */ 86 struct osif_scan_pdev{ 87 qdf_list_t scan_req_q; 88 qdf_mutex_t scan_req_q_lock; 89 wlan_scan_requester req_id; 90 qdf_runtime_lock_t runtime_pm_lock; 91 qdf_wake_lock_t scan_wake_lock; 92 }; 93 94 /* 95 * enum scan_source - scan request source 96 * @NL_SCAN: Scan initiated from NL 97 * @VENDOR_SCAN: Scan intiated from vendor command 98 */ 99 enum scan_source { 100 NL_SCAN, 101 VENDOR_SCAN, 102 }; 103 104 /** 105 * struct scan_req - Scan Request entry 106 * @node : List entry element 107 * @scan_request: scan request holder 108 * @scan_id: scan identifier used across host layers which is generated at WMI 109 * @source: scan request originator (NL/Vendor scan) 110 * @dev: net device (same as what is in scan_request) 111 * 112 * Scan request linked list element 113 */ 114 struct scan_req { 115 qdf_list_node_t node; 116 struct cfg80211_scan_request *scan_request; 117 uint32_t scan_id; 118 uint8_t source; 119 struct net_device *dev; 120 }; 121 122 /** 123 * struct scan_params - Scan params 124 * @source: scan request source 125 * @default_ie: default scan ie 126 * @vendor_ie: vendor ie 127 * @priority: scan priority 128 * @half_rate: Half rate flag 129 * @quarter_rate: Quarter rate flag 130 * @strict_pscan: strict passive scan flag 131 */ 132 struct scan_params { 133 uint8_t source; 134 struct element_info default_ie; 135 struct element_info vendor_ie; 136 enum scan_priority priority; 137 bool half_rate; 138 bool quarter_rate; 139 bool strict_pscan; 140 }; 141 142 /** 143 * struct wlan_cfg80211_inform_bss - BSS inform data 144 * @chan: channel the frame was received on 145 * @mgmt: beacon/probe resp frame 146 * @frame_len: frame length 147 * @rssi: signal strength in mBm (100*dBm) 148 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was received. 149 * @per_chain_rssi: per chain rssi received 150 */ 151 struct wlan_cfg80211_inform_bss { 152 struct ieee80211_channel *chan; 153 struct ieee80211_mgmt *mgmt; 154 size_t frame_len; 155 int rssi; 156 uint64_t boottime_ns; 157 uint8_t per_chain_rssi[WLAN_MGMT_TXRX_HOST_MAX_ANTENNA]; 158 }; 159 160 161 #ifdef FEATURE_WLAN_SCAN_PNO 162 /** 163 * wlan_cfg80211_sched_scan_start() - cfg80211 scheduled scan(pno) start 164 * @vdev: vdev pointer 165 * @request: Pointer to cfg80211 scheduled scan start request 166 * @scan_backoff_multiplier: multiply scan period by this after max cycles 167 * 168 * Return: 0 for success, non zero for failure 169 */ 170 int wlan_cfg80211_sched_scan_start(struct wlan_objmgr_vdev *vdev, 171 struct cfg80211_sched_scan_request *request, 172 uint8_t scan_backoff_multiplier); 173 174 /** 175 * wlan_cfg80211_sched_scan_stop() - cfg80211 scheduled scan(pno) stop 176 * @vdev: vdev pointer 177 * 178 * Return: 0 for success, non zero for failure 179 */ 180 int wlan_cfg80211_sched_scan_stop(struct wlan_objmgr_vdev *vdev); 181 #endif 182 183 /** 184 * wlan_scan_runtime_pm_init() - API to initialize runtime pm context for scan 185 * @pdev: Pointer to pdev 186 * 187 * This will help to initialize scan runtime pm context separately. 188 * 189 * Return: QDF_STATUS 190 */ 191 QDF_STATUS wlan_scan_runtime_pm_init(struct wlan_objmgr_pdev *pdev); 192 193 /** 194 * wlan_scan_runtime_pm_deinit() - API to deinitialize runtime pm 195 * for scan. 196 * @pdev: Pointer to pdev 197 * 198 * This will help to deinitialize scan runtime pm before deinitialize 199 * HIF 200 * 201 * Return: void 202 */ 203 void wlan_scan_runtime_pm_deinit(struct wlan_objmgr_pdev *pdev); 204 205 /** 206 * wlan_cfg80211_scan_priv_init() - API to initialize cfg80211 scan 207 * @pdev: Pointer to net device 208 * 209 * API to initialize cfg80211 scan module. 210 * 211 * Return: QDF_STATUS 212 */ 213 QDF_STATUS wlan_cfg80211_scan_priv_init(struct wlan_objmgr_pdev *pdev); 214 215 /** 216 * wlan_cfg80211_scan_priv_deinit() - API to deinitialize cfg80211 scan 217 * @pdev: Pointer to net device 218 * 219 * API to deinitialize cfg80211 scan module. 220 * 221 * Return: QDF_STATUS 222 */ 223 QDF_STATUS wlan_cfg80211_scan_priv_deinit( 224 struct wlan_objmgr_pdev *pdev); 225 226 /** 227 * wlan_cfg80211_scan() - API to process cfg80211 scan request 228 * @vdev: Pointer to vdev 229 * @request: Pointer to scan request 230 * @params: scan params 231 * 232 * API to trigger scan and update cfg80211 scan database. 233 * scan dump command can be used to fetch scan results 234 * on receipt of scan complete event. 235 * 236 * Return: 0 for success, non zero for failure 237 */ 238 int wlan_cfg80211_scan(struct wlan_objmgr_vdev *vdev, 239 struct cfg80211_scan_request *request, 240 struct scan_params *params); 241 242 /** 243 * wlan_cfg80211_inform_bss_frame_data() - API to inform beacon to cfg80211 244 * @wiphy: wiphy 245 * @bss_data: bss data 246 * 247 * API to inform beacon to cfg80211 248 * 249 * Return: pointer to bss entry 250 */ 251 struct cfg80211_bss * 252 wlan_cfg80211_inform_bss_frame_data(struct wiphy *wiphy, 253 struct wlan_cfg80211_inform_bss *bss); 254 255 /** 256 * wlan_cfg80211_inform_bss_frame() - API to inform beacon to cfg80211 257 * @pdev: Pointer to pdev 258 * @scan_params: scan entry 259 * @request: Pointer to scan request 260 * 261 * API to inform beacon to cfg80211 262 * 263 * Return: void 264 */ 265 void wlan_cfg80211_inform_bss_frame(struct wlan_objmgr_pdev *pdev, 266 struct scan_cache_entry *scan_params); 267 268 /** 269 * __wlan_cfg80211_unlink_bss_list() - flush bss from the kernel cache 270 * @wiphy: wiphy 271 * @bssid: bssid of the BSS to find 272 * @ssid: ssid of the BSS to find 273 * @ssid_len: ssid len of of the BSS to find 274 * 275 * Return: None 276 */ 277 void __wlan_cfg80211_unlink_bss_list(struct wiphy *wiphy, uint8_t *bssid, 278 uint8_t *ssid, uint8_t ssid_len); 279 280 /** 281 * wlan_cfg80211_get_bss() - Get the bss entry matching the chan, bssid and ssid 282 * @wiphy: wiphy 283 * @channel: channel of the BSS to find 284 * @bssid: bssid of the BSS to find 285 * @ssid: ssid of the BSS to find 286 * @ssid_len: ssid len of of the BSS to find 287 * 288 * The API is a wrapper to get bss from kernel matching the chan, 289 * bssid and ssid 290 * 291 * Return: bss structure if found else NULL 292 */ 293 struct cfg80211_bss *wlan_cfg80211_get_bss(struct wiphy *wiphy, 294 struct ieee80211_channel *channel, 295 const u8 *bssid, 296 const u8 *ssid, size_t ssid_len); 297 298 /* 299 * wlan_cfg80211_unlink_bss_list : flush bss from the kernel cache 300 * @pdev: Pointer to pdev 301 * @scan_entry: scan entry 302 * 303 * Return: bss which is unlinked from kernel cache 304 */ 305 void wlan_cfg80211_unlink_bss_list(struct wlan_objmgr_pdev *pdev, 306 struct scan_cache_entry *scan_entry); 307 308 /** 309 * wlan_vendor_abort_scan() - API to vendor abort scan 310 * @pdev: Pointer to pdev 311 * @data: pointer to data 312 * @data_len: Data length 313 * 314 * API to abort scan through vendor command 315 * 316 * Return: 0 for success, non zero for failure 317 */ 318 int wlan_vendor_abort_scan(struct wlan_objmgr_pdev *pdev, 319 const void *data, int data_len); 320 321 /** 322 * wlan_cfg80211_abort_scan() - API to abort scan through cfg80211 323 * @pdev: Pointer to pdev 324 * 325 * API to abort scan through cfg80211 request 326 * 327 * Return: 0 for success, non zero for failure 328 */ 329 int wlan_cfg80211_abort_scan(struct wlan_objmgr_pdev *pdev); 330 331 /** 332 * wlan_abort_scan() - Generic API to abort scan request 333 * @pdev: Pointer to pdev 334 * @pdev_id: pdev id 335 * @vdev_id: vdev id 336 * @scan_id: scan id 337 * @sync: if wait for scan complete is required 338 * 339 * Generic API to abort scans 340 * 341 * Return: 0 for success, non zero for failure 342 */ 343 QDF_STATUS wlan_abort_scan(struct wlan_objmgr_pdev *pdev, 344 uint32_t pdev_id, 345 uint32_t vdev_id, 346 wlan_scan_id scan_id, 347 bool sync); 348 349 /** 350 * wlan_cfg80211_cleanup_scan_queue() - remove entries in scan queue 351 * @pdev: pdev pointer 352 * @dev: net device pointer 353 * 354 * Removes entries in scan queue depending on dev provided and sends scan 355 * complete event to NL. 356 * Removes all entries in scan queue, if dev provided is NULL 357 * 358 * Return: None 359 */ 360 void wlan_cfg80211_cleanup_scan_queue(struct wlan_objmgr_pdev *pdev, 361 struct net_device *dev); 362 363 /** 364 * wlan_hdd_cfg80211_add_connected_pno_support() - Set connected PNO support 365 * @wiphy: Pointer to wireless phy 366 * 367 * This function is used to set connected PNO support to kernel 368 * 369 * Return: None 370 */ 371 #if defined(CFG80211_REPORT_BETTER_BSS_IN_SCHED_SCAN) || \ 372 (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0)) 373 void wlan_scan_cfg80211_add_connected_pno_support(struct wiphy *wiphy); 374 375 #else 376 static inline 377 void wlan_scan_cfg80211_add_connected_pno_support(struct wiphy *wiphy) 378 { 379 } 380 #endif 381 382 #if ((LINUX_VERSION_CODE > KERNEL_VERSION(4, 4, 0)) || \ 383 defined(CFG80211_MULTI_SCAN_PLAN_BACKPORT)) && \ 384 defined(FEATURE_WLAN_SCAN_PNO) 385 /** 386 * hdd_config_sched_scan_plans_to_wiphy() - configure sched scan plans to wiphy 387 * @wiphy: pointer to wiphy 388 * @config: pointer to config 389 * 390 * Return: None 391 */ 392 void wlan_config_sched_scan_plans_to_wiphy(struct wiphy *wiphy, 393 struct wlan_objmgr_psoc *psoc); 394 #else 395 static inline 396 void wlan_config_sched_scan_plans_to_wiphy(struct wiphy *wiphy, 397 struct wlan_objmgr_psoc *psoc) 398 { 399 } 400 #endif /* FEATURE_WLAN_SCAN_PNO */ 401 402 #endif 403