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 * @half_rate: Half rate flag 127 * @quarter_rate: Quarter rate flag 128 * @strict_pscan: strict passive scan flag 129 */ 130 struct scan_params { 131 uint8_t source; 132 struct element_info default_ie; 133 bool half_rate; 134 bool quarter_rate; 135 bool strict_pscan; 136 }; 137 138 /** 139 * struct wlan_cfg80211_inform_bss - BSS inform data 140 * @chan: channel the frame was received on 141 * @mgmt: beacon/probe resp frame 142 * @frame_len: frame length 143 * @rssi: signal strength in mBm (100*dBm) 144 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was received. 145 * @per_chain_rssi: per chain rssi received 146 */ 147 struct wlan_cfg80211_inform_bss { 148 struct ieee80211_channel *chan; 149 struct ieee80211_mgmt *mgmt; 150 size_t frame_len; 151 int rssi; 152 uint64_t boottime_ns; 153 uint8_t per_chain_rssi[WLAN_MGMT_TXRX_HOST_MAX_ANTENNA]; 154 }; 155 156 157 #ifdef FEATURE_WLAN_SCAN_PNO 158 /** 159 * wlan_cfg80211_sched_scan_start() - cfg80211 scheduled scan(pno) start 160 * @vdev: vdev pointer 161 * @request: Pointer to cfg80211 scheduled scan start request 162 * @scan_backoff_multiplier: multiply scan period by this after max cycles 163 * 164 * Return: 0 for success, non zero for failure 165 */ 166 int wlan_cfg80211_sched_scan_start(struct wlan_objmgr_vdev *vdev, 167 struct cfg80211_sched_scan_request *request, 168 uint8_t scan_backoff_multiplier); 169 170 /** 171 * wlan_cfg80211_sched_scan_stop() - cfg80211 scheduled scan(pno) stop 172 * @vdev: vdev pointer 173 * 174 * Return: 0 for success, non zero for failure 175 */ 176 int wlan_cfg80211_sched_scan_stop(struct wlan_objmgr_vdev *vdev); 177 #endif 178 179 /** 180 * wlan_scan_runtime_pm_init() - API to initialize runtime pm context for scan 181 * @pdev: Pointer to pdev 182 * 183 * This will help to initialize scan runtime pm context separately. 184 * 185 * Return: QDF_STATUS 186 */ 187 QDF_STATUS wlan_scan_runtime_pm_init(struct wlan_objmgr_pdev *pdev); 188 189 /** 190 * wlan_scan_runtime_pm_deinit() - API to deinitialize runtime pm 191 * for scan. 192 * @pdev: Pointer to pdev 193 * 194 * This will help to deinitialize scan runtime pm before deinitialize 195 * HIF 196 * 197 * Return: void 198 */ 199 void wlan_scan_runtime_pm_deinit(struct wlan_objmgr_pdev *pdev); 200 201 /** 202 * wlan_cfg80211_scan_priv_init() - API to initialize cfg80211 scan 203 * @pdev: Pointer to net device 204 * 205 * API to initialize cfg80211 scan module. 206 * 207 * Return: QDF_STATUS 208 */ 209 QDF_STATUS wlan_cfg80211_scan_priv_init(struct wlan_objmgr_pdev *pdev); 210 211 /** 212 * wlan_cfg80211_scan_priv_deinit() - API to deinitialize cfg80211 scan 213 * @pdev: Pointer to net device 214 * 215 * API to deinitialize cfg80211 scan module. 216 * 217 * Return: QDF_STATUS 218 */ 219 QDF_STATUS wlan_cfg80211_scan_priv_deinit( 220 struct wlan_objmgr_pdev *pdev); 221 222 /** 223 * wlan_cfg80211_scan() - API to process cfg80211 scan request 224 * @vdev: Pointer to vdev 225 * @request: Pointer to scan request 226 * @params: scan params 227 * 228 * API to trigger scan and update cfg80211 scan database. 229 * scan dump command can be used to fetch scan results 230 * on receipt of scan complete event. 231 * 232 * Return: 0 for success, non zero for failure 233 */ 234 int wlan_cfg80211_scan(struct wlan_objmgr_vdev *vdev, 235 struct cfg80211_scan_request *request, 236 struct scan_params *params); 237 238 /** 239 * wlan_cfg80211_inform_bss_frame_data() - API to inform beacon to cfg80211 240 * @wiphy: wiphy 241 * @bss_data: bss data 242 * 243 * API to inform beacon to cfg80211 244 * 245 * Return: pointer to bss entry 246 */ 247 struct cfg80211_bss * 248 wlan_cfg80211_inform_bss_frame_data(struct wiphy *wiphy, 249 struct wlan_cfg80211_inform_bss *bss); 250 251 /** 252 * wlan_cfg80211_inform_bss_frame() - API to inform beacon to cfg80211 253 * @pdev: Pointer to pdev 254 * @scan_params: scan entry 255 * @request: Pointer to scan request 256 * 257 * API to inform beacon to cfg80211 258 * 259 * Return: void 260 */ 261 void wlan_cfg80211_inform_bss_frame(struct wlan_objmgr_pdev *pdev, 262 struct scan_cache_entry *scan_params); 263 264 /** 265 * wlan_vendor_abort_scan() - API to vendor abort scan 266 * @pdev: Pointer to pdev 267 * @data: pointer to data 268 * @data_len: Data length 269 * 270 * API to abort scan through vendor command 271 * 272 * Return: 0 for success, non zero for failure 273 */ 274 int wlan_vendor_abort_scan(struct wlan_objmgr_pdev *pdev, 275 const void *data, int data_len); 276 277 /** 278 * wlan_cfg80211_abort_scan() - API to abort scan through cfg80211 279 * @pdev: Pointer to pdev 280 * 281 * API to abort scan through cfg80211 request 282 * 283 * Return: 0 for success, non zero for failure 284 */ 285 int wlan_cfg80211_abort_scan(struct wlan_objmgr_pdev *pdev); 286 287 /** 288 * wlan_abort_scan() - Generic API to abort scan request 289 * @pdev: Pointer to pdev 290 * @pdev_id: pdev id 291 * @vdev_id: vdev id 292 * @scan_id: scan id 293 * @sync: if wait for scan complete is required 294 * 295 * Generic API to abort scans 296 * 297 * Return: 0 for success, non zero for failure 298 */ 299 QDF_STATUS wlan_abort_scan(struct wlan_objmgr_pdev *pdev, 300 uint32_t pdev_id, 301 uint32_t vdev_id, 302 wlan_scan_id scan_id, 303 bool sync); 304 305 /** 306 * wlan_cfg80211_cleanup_scan_queue() - remove entries in scan queue 307 * @pdev: pdev pointer 308 * @dev: net device pointer 309 * 310 * Removes entries in scan queue depending on dev provided and sends scan 311 * complete event to NL. 312 * Removes all entries in scan queue, if dev provided is NULL 313 * 314 * Return: None 315 */ 316 void wlan_cfg80211_cleanup_scan_queue(struct wlan_objmgr_pdev *pdev, 317 struct net_device *dev); 318 319 /** 320 * wlan_hdd_cfg80211_add_connected_pno_support() - Set connected PNO support 321 * @wiphy: Pointer to wireless phy 322 * 323 * This function is used to set connected PNO support to kernel 324 * 325 * Return: None 326 */ 327 #if defined(CFG80211_REPORT_BETTER_BSS_IN_SCHED_SCAN) || \ 328 (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0)) 329 void wlan_scan_cfg80211_add_connected_pno_support(struct wiphy *wiphy); 330 331 #else 332 static inline 333 void wlan_scan_cfg80211_add_connected_pno_support(struct wiphy *wiphy) 334 { 335 } 336 #endif 337 338 #if ((LINUX_VERSION_CODE > KERNEL_VERSION(4, 4, 0)) || \ 339 defined(CFG80211_MULTI_SCAN_PLAN_BACKPORT)) && \ 340 defined(FEATURE_WLAN_SCAN_PNO) 341 /** 342 * hdd_config_sched_scan_plans_to_wiphy() - configure sched scan plans to wiphy 343 * @wiphy: pointer to wiphy 344 * @config: pointer to config 345 * 346 * Return: None 347 */ 348 void wlan_config_sched_scan_plans_to_wiphy(struct wiphy *wiphy, 349 struct wlan_objmgr_psoc *psoc); 350 #else 351 static inline 352 void wlan_config_sched_scan_plans_to_wiphy(struct wiphy *wiphy, 353 struct wlan_objmgr_psoc *psoc) 354 { 355 } 356 #endif /* FEATURE_WLAN_SCAN_PNO */ 357 358 #endif 359