1 /* 2 * Copyright (c) 2017-2018 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 49 /** 50 * typedef struct qcom_ie_age - age ie 51 * 52 * @element_id: Element id 53 * @len: Length 54 * @oui_1: OUI 1 55 * @oui_2: OUI 2 56 * @oui_3: OUI 3 57 * @type: Type 58 * @age: Age 59 * @tsf_delta: tsf delta from FW 60 * @beacon_tsf: original beacon TSF 61 * @seq_ctrl: sequence control field 62 */ 63 typedef struct { 64 u8 element_id; 65 u8 len; 66 u8 oui_1; 67 u8 oui_2; 68 u8 oui_3; 69 u32 type; 70 u32 age; 71 u32 tsf_delta; 72 u64 beacon_tsf; 73 u16 seq_ctrl; 74 } __attribute__ ((packed)) qcom_ie_age; 75 76 /** 77 * struct osif_scan_pdev - OS scan private strcutre 78 * scan_req_q: Scan request queue 79 * scan_req_q_lock: Protect scan request queue 80 * req_id: Scan request Id 81 * runtime_pm_lock: Runtime suspend lock 82 */ 83 struct osif_scan_pdev{ 84 qdf_list_t scan_req_q; 85 qdf_mutex_t scan_req_q_lock; 86 wlan_scan_requester req_id; 87 qdf_runtime_lock_t runtime_pm_lock; 88 }; 89 90 /* 91 * enum scan_source - scan request source 92 * @NL_SCAN: Scan initiated from NL 93 * @VENDOR_SCAN: Scan intiated from vendor command 94 */ 95 enum scan_source { 96 NL_SCAN, 97 VENDOR_SCAN, 98 }; 99 100 /** 101 * struct scan_req - Scan Request entry 102 * @node : List entry element 103 * @scan_request: scan request holder 104 * @scan_id: scan identifier used across host layers which is generated at WMI 105 * @source: scan request originator (NL/Vendor scan) 106 * @dev: net device (same as what is in scan_request) 107 * 108 * Scan request linked list element 109 */ 110 struct scan_req { 111 qdf_list_node_t node; 112 struct cfg80211_scan_request *scan_request; 113 uint32_t scan_id; 114 uint8_t source; 115 struct net_device *dev; 116 }; 117 118 /** 119 * struct scan_params - Scan params 120 * @source: scan request source 121 * @default_ie: default scan ie 122 * @half_rate: Half rate flag 123 * @quarter_rate: Quarter rate flag 124 * @strict_pscan: strict passive scan flag 125 */ 126 struct scan_params { 127 uint8_t source; 128 struct element_info default_ie; 129 bool half_rate; 130 bool quarter_rate; 131 bool strict_pscan; 132 }; 133 134 /** 135 * struct wlan_cfg80211_inform_bss - BSS inform data 136 * @chan: channel the frame was received on 137 * @mgmt: beacon/probe resp frame 138 * @frame_len: frame length 139 * @rssi: signal strength in mBm (100*dBm) 140 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was received. 141 * @per_chain_rssi: per chain rssi received 142 */ 143 struct wlan_cfg80211_inform_bss { 144 struct ieee80211_channel *chan; 145 struct ieee80211_mgmt *mgmt; 146 size_t frame_len; 147 int rssi; 148 uint64_t boottime_ns; 149 uint8_t per_chain_rssi[WLAN_MGMT_TXRX_HOST_MAX_ANTENNA]; 150 }; 151 152 153 #ifdef FEATURE_WLAN_SCAN_PNO 154 /** 155 * wlan_cfg80211_sched_scan_start() - cfg80211 scheduled scan(pno) start 156 * @vdev: vdev pointer 157 * @request: Pointer to cfg80211 scheduled scan start request 158 * @scan_backoff_multiplier: multiply scan period by this after max cycles 159 * 160 * Return: 0 for success, non zero for failure 161 */ 162 int wlan_cfg80211_sched_scan_start(struct wlan_objmgr_vdev *vdev, 163 struct cfg80211_sched_scan_request *request, 164 uint8_t scan_backoff_multiplier); 165 166 /** 167 * wlan_cfg80211_sched_scan_stop() - cfg80211 scheduled scan(pno) stop 168 * @vdev: vdev pointer 169 * 170 * Return: 0 for success, non zero for failure 171 */ 172 int wlan_cfg80211_sched_scan_stop(struct wlan_objmgr_vdev *vdev); 173 #endif 174 175 /** 176 * wlan_scan_runtime_pm_init() - API to initialize runtime pm context for scan 177 * @pdev: Pointer to pdev 178 * 179 * This will help to initialize scan runtime pm context separately. 180 * 181 * Return: QDF_STATUS 182 */ 183 QDF_STATUS wlan_scan_runtime_pm_init(struct wlan_objmgr_pdev *pdev); 184 185 /** 186 * wlan_scan_runtime_pm_deinit() - API to deinitialize runtime pm 187 * for scan. 188 * @pdev: Pointer to pdev 189 * 190 * This will help to deinitialize scan runtime pm before deinitialize 191 * HIF 192 * 193 * Return: void 194 */ 195 void wlan_scan_runtime_pm_deinit(struct wlan_objmgr_pdev *pdev); 196 197 /** 198 * wlan_cfg80211_scan_priv_init() - API to initialize cfg80211 scan 199 * @pdev: Pointer to net device 200 * 201 * API to initialize cfg80211 scan module. 202 * 203 * Return: QDF_STATUS 204 */ 205 QDF_STATUS wlan_cfg80211_scan_priv_init(struct wlan_objmgr_pdev *pdev); 206 207 /** 208 * wlan_cfg80211_scan_priv_deinit() - API to deinitialize cfg80211 scan 209 * @pdev: Pointer to net device 210 * 211 * API to deinitialize cfg80211 scan module. 212 * 213 * Return: QDF_STATUS 214 */ 215 QDF_STATUS wlan_cfg80211_scan_priv_deinit( 216 struct wlan_objmgr_pdev *pdev); 217 218 /** 219 * wlan_cfg80211_scan() - API to process cfg80211 scan request 220 * @vdev: Pointer to vdev 221 * @request: Pointer to scan request 222 * @params: scan params 223 * 224 * API to trigger scan and update cfg80211 scan database. 225 * scan dump command can be used to fetch scan results 226 * on receipt of scan complete event. 227 * 228 * Return: 0 for success, non zero for failure 229 */ 230 int wlan_cfg80211_scan(struct wlan_objmgr_vdev *vdev, 231 struct cfg80211_scan_request *request, 232 struct scan_params *params); 233 234 /** 235 * wlan_cfg80211_inform_bss_frame_data() - API to inform beacon to cfg80211 236 * @wiphy: wiphy 237 * @bss_data: bss data 238 * 239 * API to inform beacon to cfg80211 240 * 241 * Return: pointer to bss entry 242 */ 243 struct cfg80211_bss * 244 wlan_cfg80211_inform_bss_frame_data(struct wiphy *wiphy, 245 struct wlan_cfg80211_inform_bss *bss); 246 247 /** 248 * wlan_cfg80211_inform_bss_frame() - API to inform beacon to cfg80211 249 * @pdev: Pointer to pdev 250 * @scan_params: scan entry 251 * @request: Pointer to scan request 252 * 253 * API to inform beacon to cfg80211 254 * 255 * Return: void 256 */ 257 void wlan_cfg80211_inform_bss_frame(struct wlan_objmgr_pdev *pdev, 258 struct scan_cache_entry *scan_params); 259 260 /** 261 * wlan_vendor_abort_scan() - API to vendor abort scan 262 * @pdev: Pointer to pdev 263 * @data: pointer to data 264 * @data_len: Data length 265 * 266 * API to abort scan through vendor command 267 * 268 * Return: 0 for success, non zero for failure 269 */ 270 int wlan_vendor_abort_scan(struct wlan_objmgr_pdev *pdev, 271 const void *data, int data_len); 272 273 /** 274 * wlan_cfg80211_abort_scan() - API to abort scan through cfg80211 275 * @pdev: Pointer to pdev 276 * 277 * API to abort scan through cfg80211 request 278 * 279 * Return: 0 for success, non zero for failure 280 */ 281 int wlan_cfg80211_abort_scan(struct wlan_objmgr_pdev *pdev); 282 283 /** 284 * wlan_abort_scan() - Generic API to abort scan request 285 * @pdev: Pointer to pdev 286 * @pdev_id: pdev id 287 * @vdev_id: vdev id 288 * @scan_id: scan id 289 * @sync: if wait for scan complete is required 290 * 291 * Generic API to abort scans 292 * 293 * Return: 0 for success, non zero for failure 294 */ 295 QDF_STATUS wlan_abort_scan(struct wlan_objmgr_pdev *pdev, 296 uint32_t pdev_id, 297 uint32_t vdev_id, 298 wlan_scan_id scan_id, 299 bool sync); 300 301 /** 302 * wlan_cfg80211_cleanup_scan_queue() - remove entries in scan queue 303 * @pdev: pdev pointer 304 * @dev: net device pointer 305 * 306 * Removes entries in scan queue depending on dev provided and sends scan 307 * complete event to NL. 308 * Removes all entries in scan queue, if dev provided is NULL 309 * 310 * Return: None 311 */ 312 void wlan_cfg80211_cleanup_scan_queue(struct wlan_objmgr_pdev *pdev, 313 struct net_device *dev); 314 315 316 #endif 317