fw-api-scan.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736
  1. /******************************************************************************
  2. *
  3. * This file is provided under a dual BSD/GPLv2 license. When using or
  4. * redistributing this file, you may do so under either license.
  5. *
  6. * GPL LICENSE SUMMARY
  7. *
  8. * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  9. * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of version 2 of the GNU General Public License as
  13. * published by the Free Software Foundation.
  14. *
  15. * This program is distributed in the hope that it will be useful, but
  16. * WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18. * General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU General Public License
  21. * along with this program; if not, write to the Free Software
  22. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23. * USA
  24. *
  25. * The full GNU General Public License is included in this distribution
  26. * in the file called COPYING.
  27. *
  28. * Contact Information:
  29. * Intel Linux Wireless <linuxwifi@intel.com>
  30. * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31. *
  32. * BSD LICENSE
  33. *
  34. * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  35. * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  36. * All rights reserved.
  37. *
  38. * Redistribution and use in source and binary forms, with or without
  39. * modification, are permitted provided that the following conditions
  40. * are met:
  41. *
  42. * * Redistributions of source code must retain the above copyright
  43. * notice, this list of conditions and the following disclaimer.
  44. * * Redistributions in binary form must reproduce the above copyright
  45. * notice, this list of conditions and the following disclaimer in
  46. * the documentation and/or other materials provided with the
  47. * distribution.
  48. * * Neither the name Intel Corporation nor the names of its
  49. * contributors may be used to endorse or promote products derived
  50. * from this software without specific prior written permission.
  51. *
  52. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63. *
  64. *****************************************************************************/
  65. #ifndef __fw_api_scan_h__
  66. #define __fw_api_scan_h__
  67. #include "fw-api.h"
  68. /* Scan Commands, Responses, Notifications */
  69. /* Max number of IEs for direct SSID scans in a command */
  70. #define PROBE_OPTION_MAX 20
  71. /**
  72. * struct iwl_ssid_ie - directed scan network information element
  73. *
  74. * Up to 20 of these may appear in REPLY_SCAN_CMD,
  75. * selected by "type" bit field in struct iwl_scan_channel;
  76. * each channel may select different ssids from among the 20 entries.
  77. * SSID IEs get transmitted in reverse order of entry.
  78. */
  79. struct iwl_ssid_ie {
  80. u8 id;
  81. u8 len;
  82. u8 ssid[IEEE80211_MAX_SSID_LEN];
  83. } __packed; /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
  84. /* scan offload */
  85. #define IWL_SCAN_MAX_BLACKLIST_LEN 64
  86. #define IWL_SCAN_SHORT_BLACKLIST_LEN 16
  87. #define IWL_SCAN_MAX_PROFILES 11
  88. #define SCAN_OFFLOAD_PROBE_REQ_SIZE 512
  89. /* Default watchdog (in MS) for scheduled scan iteration */
  90. #define IWL_SCHED_SCAN_WATCHDOG cpu_to_le16(15000)
  91. #define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
  92. #define CAN_ABORT_STATUS 1
  93. #define IWL_FULL_SCAN_MULTIPLIER 5
  94. #define IWL_FAST_SCHED_SCAN_ITERATIONS 3
  95. #define IWL_MAX_SCHED_SCAN_PLANS 2
  96. enum scan_framework_client {
  97. SCAN_CLIENT_SCHED_SCAN = BIT(0),
  98. SCAN_CLIENT_NETDETECT = BIT(1),
  99. SCAN_CLIENT_ASSET_TRACKING = BIT(2),
  100. };
  101. /**
  102. * iwl_scan_offload_blacklist - SCAN_OFFLOAD_BLACKLIST_S
  103. * @ssid: MAC address to filter out
  104. * @reported_rssi: AP rssi reported to the host
  105. * @client_bitmap: clients ignore this entry - enum scan_framework_client
  106. */
  107. struct iwl_scan_offload_blacklist {
  108. u8 ssid[ETH_ALEN];
  109. u8 reported_rssi;
  110. u8 client_bitmap;
  111. } __packed;
  112. enum iwl_scan_offload_network_type {
  113. IWL_NETWORK_TYPE_BSS = 1,
  114. IWL_NETWORK_TYPE_IBSS = 2,
  115. IWL_NETWORK_TYPE_ANY = 3,
  116. };
  117. enum iwl_scan_offload_band_selection {
  118. IWL_SCAN_OFFLOAD_SELECT_2_4 = 0x4,
  119. IWL_SCAN_OFFLOAD_SELECT_5_2 = 0x8,
  120. IWL_SCAN_OFFLOAD_SELECT_ANY = 0xc,
  121. };
  122. /**
  123. * iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
  124. * @ssid_index: index to ssid list in fixed part
  125. * @unicast_cipher: encryption algorithm to match - bitmap
  126. * @aut_alg: authentication algorithm to match - bitmap
  127. * @network_type: enum iwl_scan_offload_network_type
  128. * @band_selection: enum iwl_scan_offload_band_selection
  129. * @client_bitmap: clients waiting for match - enum scan_framework_client
  130. */
  131. struct iwl_scan_offload_profile {
  132. u8 ssid_index;
  133. u8 unicast_cipher;
  134. u8 auth_alg;
  135. u8 network_type;
  136. u8 band_selection;
  137. u8 client_bitmap;
  138. u8 reserved[2];
  139. } __packed;
  140. /**
  141. * iwl_scan_offload_profile_cfg - SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1
  142. * @blaclist: AP list to filter off from scan results
  143. * @profiles: profiles to search for match
  144. * @blacklist_len: length of blacklist
  145. * @num_profiles: num of profiles in the list
  146. * @match_notify: clients waiting for match found notification
  147. * @pass_match: clients waiting for the results
  148. * @active_clients: active clients bitmap - enum scan_framework_client
  149. * @any_beacon_notify: clients waiting for match notification without match
  150. */
  151. struct iwl_scan_offload_profile_cfg {
  152. struct iwl_scan_offload_profile profiles[IWL_SCAN_MAX_PROFILES];
  153. u8 blacklist_len;
  154. u8 num_profiles;
  155. u8 match_notify;
  156. u8 pass_match;
  157. u8 active_clients;
  158. u8 any_beacon_notify;
  159. u8 reserved[2];
  160. } __packed;
  161. /**
  162. * iwl_scan_schedule_lmac - schedule of scan offload
  163. * @delay: delay between iterations, in seconds.
  164. * @iterations: num of scan iterations
  165. * @full_scan_mul: number of partial scans before each full scan
  166. */
  167. struct iwl_scan_schedule_lmac {
  168. __le16 delay;
  169. u8 iterations;
  170. u8 full_scan_mul;
  171. } __packed; /* SCAN_SCHEDULE_API_S */
  172. enum iwl_scan_offload_complete_status {
  173. IWL_SCAN_OFFLOAD_COMPLETED = 1,
  174. IWL_SCAN_OFFLOAD_ABORTED = 2,
  175. };
  176. enum iwl_scan_ebs_status {
  177. IWL_SCAN_EBS_SUCCESS,
  178. IWL_SCAN_EBS_FAILED,
  179. IWL_SCAN_EBS_CHAN_NOT_FOUND,
  180. IWL_SCAN_EBS_INACTIVE,
  181. };
  182. /**
  183. * iwl_scan_req_tx_cmd - SCAN_REQ_TX_CMD_API_S
  184. * @tx_flags: combination of TX_CMD_FLG_*
  185. * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
  186. * cleared. Combination of RATE_MCS_*
  187. * @sta_id: index of destination station in FW station table
  188. * @reserved: for alignment and future use
  189. */
  190. struct iwl_scan_req_tx_cmd {
  191. __le32 tx_flags;
  192. __le32 rate_n_flags;
  193. u8 sta_id;
  194. u8 reserved[3];
  195. } __packed;
  196. enum iwl_scan_channel_flags_lmac {
  197. IWL_UNIFIED_SCAN_CHANNEL_FULL = BIT(27),
  198. IWL_UNIFIED_SCAN_CHANNEL_PARTIAL = BIT(28),
  199. };
  200. /**
  201. * iwl_scan_channel_cfg_lmac - SCAN_CHANNEL_CFG_S_VER2
  202. * @flags: bits 1-20: directed scan to i'th ssid
  203. * other bits &enum iwl_scan_channel_flags_lmac
  204. * @channel_number: channel number 1-13 etc
  205. * @iter_count: scan iteration on this channel
  206. * @iter_interval: interval in seconds between iterations on one channel
  207. */
  208. struct iwl_scan_channel_cfg_lmac {
  209. __le32 flags;
  210. __le16 channel_num;
  211. __le16 iter_count;
  212. __le32 iter_interval;
  213. } __packed;
  214. /*
  215. * iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1
  216. * @offset: offset in the data block
  217. * @len: length of the segment
  218. */
  219. struct iwl_scan_probe_segment {
  220. __le16 offset;
  221. __le16 len;
  222. } __packed;
  223. /* iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_2
  224. * @mac_header: first (and common) part of the probe
  225. * @band_data: band specific data
  226. * @common_data: last (and common) part of the probe
  227. * @buf: raw data block
  228. */
  229. struct iwl_scan_probe_req {
  230. struct iwl_scan_probe_segment mac_header;
  231. struct iwl_scan_probe_segment band_data[2];
  232. struct iwl_scan_probe_segment common_data;
  233. u8 buf[SCAN_OFFLOAD_PROBE_REQ_SIZE];
  234. } __packed;
  235. enum iwl_scan_channel_flags {
  236. IWL_SCAN_CHANNEL_FLAG_EBS = BIT(0),
  237. IWL_SCAN_CHANNEL_FLAG_EBS_ACCURATE = BIT(1),
  238. IWL_SCAN_CHANNEL_FLAG_CACHE_ADD = BIT(2),
  239. };
  240. /* iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S
  241. * @flags: enum iwl_scan_channel_flags
  242. * @non_ebs_ratio: defines the ratio of number of scan iterations where EBS is
  243. * involved.
  244. * 1 - EBS is disabled.
  245. * 2 - every second scan will be full scan(and so on).
  246. */
  247. struct iwl_scan_channel_opt {
  248. __le16 flags;
  249. __le16 non_ebs_ratio;
  250. } __packed;
  251. /**
  252. * iwl_mvm_lmac_scan_flags
  253. * @IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL: pass all beacons and probe responses
  254. * without filtering.
  255. * @IWL_MVM_LMAC_SCAN_FLAG_PASSIVE: force passive scan on all channels
  256. * @IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION: single channel scan
  257. * @IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE: send iteration complete notification
  258. * @IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS multiple SSID matching
  259. * @IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED: all passive scans will be fragmented
  260. * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
  261. * and DS parameter set IEs into probe requests.
  262. * @IWL_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL: use extended dwell time on channels
  263. * 1, 6 and 11.
  264. * @IWL_MVM_LMAC_SCAN_FLAG_MATCH: Send match found notification on matches
  265. */
  266. enum iwl_mvm_lmac_scan_flags {
  267. IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL = BIT(0),
  268. IWL_MVM_LMAC_SCAN_FLAG_PASSIVE = BIT(1),
  269. IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION = BIT(2),
  270. IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE = BIT(3),
  271. IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS = BIT(4),
  272. IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED = BIT(5),
  273. IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED = BIT(6),
  274. IWL_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL = BIT(7),
  275. IWL_MVM_LMAC_SCAN_FLAG_MATCH = BIT(9),
  276. };
  277. enum iwl_scan_priority {
  278. IWL_SCAN_PRIORITY_LOW,
  279. IWL_SCAN_PRIORITY_MEDIUM,
  280. IWL_SCAN_PRIORITY_HIGH,
  281. };
  282. enum iwl_scan_priority_ext {
  283. IWL_SCAN_PRIORITY_EXT_0_LOWEST,
  284. IWL_SCAN_PRIORITY_EXT_1,
  285. IWL_SCAN_PRIORITY_EXT_2,
  286. IWL_SCAN_PRIORITY_EXT_3,
  287. IWL_SCAN_PRIORITY_EXT_4,
  288. IWL_SCAN_PRIORITY_EXT_5,
  289. IWL_SCAN_PRIORITY_EXT_6,
  290. IWL_SCAN_PRIORITY_EXT_7_HIGHEST,
  291. };
  292. /**
  293. * iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
  294. * @reserved1: for alignment and future use
  295. * @channel_num: num of channels to scan
  296. * @active-dwell: dwell time for active channels
  297. * @passive-dwell: dwell time for passive channels
  298. * @fragmented-dwell: dwell time for fragmented passive scan
  299. * @extended_dwell: dwell time for channels 1, 6 and 11 (in certain cases)
  300. * @reserved2: for alignment and future use
  301. * @rx_chain_selct: PHY_RX_CHAIN_* flags
  302. * @scan_flags: &enum iwl_mvm_lmac_scan_flags
  303. * @max_out_time: max time (in TU) to be out of associated channel
  304. * @suspend_time: pause scan this long (TUs) when returning to service channel
  305. * @flags: RXON flags
  306. * @filter_flags: RXON filter
  307. * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
  308. * @direct_scan: list of SSIDs for directed active scan
  309. * @scan_prio: enum iwl_scan_priority
  310. * @iter_num: number of scan iterations
  311. * @delay: delay in seconds before first iteration
  312. * @schedule: two scheduling plans. The first one is finite, the second one can
  313. * be infinite.
  314. * @channel_opt: channel optimization options, for full and partial scan
  315. * @data: channel configuration and probe request packet.
  316. */
  317. struct iwl_scan_req_lmac {
  318. /* SCAN_REQUEST_FIXED_PART_API_S_VER_7 */
  319. __le32 reserved1;
  320. u8 n_channels;
  321. u8 active_dwell;
  322. u8 passive_dwell;
  323. u8 fragmented_dwell;
  324. u8 extended_dwell;
  325. u8 reserved2;
  326. __le16 rx_chain_select;
  327. __le32 scan_flags;
  328. __le32 max_out_time;
  329. __le32 suspend_time;
  330. /* RX_ON_FLAGS_API_S_VER_1 */
  331. __le32 flags;
  332. __le32 filter_flags;
  333. struct iwl_scan_req_tx_cmd tx_cmd[2];
  334. struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
  335. __le32 scan_prio;
  336. /* SCAN_REQ_PERIODIC_PARAMS_API_S */
  337. __le32 iter_num;
  338. __le32 delay;
  339. struct iwl_scan_schedule_lmac schedule[IWL_MAX_SCHED_SCAN_PLANS];
  340. struct iwl_scan_channel_opt channel_opt[2];
  341. u8 data[];
  342. } __packed;
  343. /**
  344. * struct iwl_scan_results_notif - scan results for one channel -
  345. * SCAN_RESULT_NTF_API_S_VER_3
  346. * @channel: which channel the results are from
  347. * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
  348. * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
  349. * @num_probe_not_sent: # of request that weren't sent due to not enough time
  350. * @duration: duration spent in channel, in usecs
  351. */
  352. struct iwl_scan_results_notif {
  353. u8 channel;
  354. u8 band;
  355. u8 probe_status;
  356. u8 num_probe_not_sent;
  357. __le32 duration;
  358. } __packed;
  359. /**
  360. * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
  361. * SCAN_COMPLETE_NTF_API_S_VER_3
  362. * @scanned_channels: number of channels scanned (and number of valid results)
  363. * @status: one of SCAN_COMP_STATUS_*
  364. * @bt_status: BT on/off status
  365. * @last_channel: last channel that was scanned
  366. * @tsf_low: TSF timer (lower half) in usecs
  367. * @tsf_high: TSF timer (higher half) in usecs
  368. * @results: an array of scan results, only "scanned_channels" of them are valid
  369. */
  370. struct iwl_lmac_scan_complete_notif {
  371. u8 scanned_channels;
  372. u8 status;
  373. u8 bt_status;
  374. u8 last_channel;
  375. __le32 tsf_low;
  376. __le32 tsf_high;
  377. struct iwl_scan_results_notif results[];
  378. } __packed;
  379. /**
  380. * iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
  381. * @last_schedule_line: last schedule line executed (fast or regular)
  382. * @last_schedule_iteration: last scan iteration executed before scan abort
  383. * @status: enum iwl_scan_offload_complete_status
  384. * @ebs_status: EBS success status &enum iwl_scan_ebs_status
  385. * @time_after_last_iter; time in seconds elapsed after last iteration
  386. */
  387. struct iwl_periodic_scan_complete {
  388. u8 last_schedule_line;
  389. u8 last_schedule_iteration;
  390. u8 status;
  391. u8 ebs_status;
  392. __le32 time_after_last_iter;
  393. __le32 reserved;
  394. } __packed;
  395. /* UMAC Scan API */
  396. /* The maximum of either of these cannot exceed 8, because we use an
  397. * 8-bit mask (see IWL_MVM_SCAN_MASK in mvm.h).
  398. */
  399. #define IWL_MVM_MAX_UMAC_SCANS 8
  400. #define IWL_MVM_MAX_LMAC_SCANS 1
  401. enum scan_config_flags {
  402. SCAN_CONFIG_FLAG_ACTIVATE = BIT(0),
  403. SCAN_CONFIG_FLAG_DEACTIVATE = BIT(1),
  404. SCAN_CONFIG_FLAG_FORBID_CHUB_REQS = BIT(2),
  405. SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS = BIT(3),
  406. SCAN_CONFIG_FLAG_SET_TX_CHAINS = BIT(8),
  407. SCAN_CONFIG_FLAG_SET_RX_CHAINS = BIT(9),
  408. SCAN_CONFIG_FLAG_SET_AUX_STA_ID = BIT(10),
  409. SCAN_CONFIG_FLAG_SET_ALL_TIMES = BIT(11),
  410. SCAN_CONFIG_FLAG_SET_EFFECTIVE_TIMES = BIT(12),
  411. SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS = BIT(13),
  412. SCAN_CONFIG_FLAG_SET_LEGACY_RATES = BIT(14),
  413. SCAN_CONFIG_FLAG_SET_MAC_ADDR = BIT(15),
  414. SCAN_CONFIG_FLAG_SET_FRAGMENTED = BIT(16),
  415. SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED = BIT(17),
  416. SCAN_CONFIG_FLAG_SET_CAM_MODE = BIT(18),
  417. SCAN_CONFIG_FLAG_CLEAR_CAM_MODE = BIT(19),
  418. SCAN_CONFIG_FLAG_SET_PROMISC_MODE = BIT(20),
  419. SCAN_CONFIG_FLAG_CLEAR_PROMISC_MODE = BIT(21),
  420. /* Bits 26-31 are for num of channels in channel_array */
  421. #define SCAN_CONFIG_N_CHANNELS(n) ((n) << 26)
  422. };
  423. enum scan_config_rates {
  424. /* OFDM basic rates */
  425. SCAN_CONFIG_RATE_6M = BIT(0),
  426. SCAN_CONFIG_RATE_9M = BIT(1),
  427. SCAN_CONFIG_RATE_12M = BIT(2),
  428. SCAN_CONFIG_RATE_18M = BIT(3),
  429. SCAN_CONFIG_RATE_24M = BIT(4),
  430. SCAN_CONFIG_RATE_36M = BIT(5),
  431. SCAN_CONFIG_RATE_48M = BIT(6),
  432. SCAN_CONFIG_RATE_54M = BIT(7),
  433. /* CCK basic rates */
  434. SCAN_CONFIG_RATE_1M = BIT(8),
  435. SCAN_CONFIG_RATE_2M = BIT(9),
  436. SCAN_CONFIG_RATE_5M = BIT(10),
  437. SCAN_CONFIG_RATE_11M = BIT(11),
  438. /* Bits 16-27 are for supported rates */
  439. #define SCAN_CONFIG_SUPPORTED_RATE(rate) ((rate) << 16)
  440. };
  441. enum iwl_channel_flags {
  442. IWL_CHANNEL_FLAG_EBS = BIT(0),
  443. IWL_CHANNEL_FLAG_ACCURATE_EBS = BIT(1),
  444. IWL_CHANNEL_FLAG_EBS_ADD = BIT(2),
  445. IWL_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE = BIT(3),
  446. };
  447. /**
  448. * struct iwl_scan_config
  449. * @flags: enum scan_config_flags
  450. * @tx_chains: valid_tx antenna - ANT_* definitions
  451. * @rx_chains: valid_rx antenna - ANT_* definitions
  452. * @legacy_rates: default legacy rates - enum scan_config_rates
  453. * @out_of_channel_time: default max out of serving channel time
  454. * @suspend_time: default max suspend time
  455. * @dwell_active: default dwell time for active scan
  456. * @dwell_passive: default dwell time for passive scan
  457. * @dwell_fragmented: default dwell time for fragmented scan
  458. * @dwell_extended: default dwell time for channels 1, 6 and 11
  459. * @mac_addr: default mac address to be used in probes
  460. * @bcast_sta_id: the index of the station in the fw
  461. * @channel_flags: default channel flags - enum iwl_channel_flags
  462. * scan_config_channel_flag
  463. * @channel_array: default supported channels
  464. */
  465. struct iwl_scan_config {
  466. __le32 flags;
  467. __le32 tx_chains;
  468. __le32 rx_chains;
  469. __le32 legacy_rates;
  470. __le32 out_of_channel_time;
  471. __le32 suspend_time;
  472. u8 dwell_active;
  473. u8 dwell_passive;
  474. u8 dwell_fragmented;
  475. u8 dwell_extended;
  476. u8 mac_addr[ETH_ALEN];
  477. u8 bcast_sta_id;
  478. u8 channel_flags;
  479. u8 channel_array[];
  480. } __packed; /* SCAN_CONFIG_DB_CMD_API_S */
  481. /**
  482. * iwl_umac_scan_flags
  483. *@IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
  484. * can be preempted by other scan requests with higher priority.
  485. * The low priority scan will be resumed when the higher proirity scan is
  486. * completed.
  487. *@IWL_UMAC_SCAN_FLAG_START_NOTIF: notification will be sent to the driver
  488. * when scan starts.
  489. */
  490. enum iwl_umac_scan_flags {
  491. IWL_UMAC_SCAN_FLAG_PREEMPTIVE = BIT(0),
  492. IWL_UMAC_SCAN_FLAG_START_NOTIF = BIT(1),
  493. };
  494. enum iwl_umac_scan_uid_offsets {
  495. IWL_UMAC_SCAN_UID_TYPE_OFFSET = 0,
  496. IWL_UMAC_SCAN_UID_SEQ_OFFSET = 8,
  497. };
  498. enum iwl_umac_scan_general_flags {
  499. IWL_UMAC_SCAN_GEN_FLAGS_PERIODIC = BIT(0),
  500. IWL_UMAC_SCAN_GEN_FLAGS_OVER_BT = BIT(1),
  501. IWL_UMAC_SCAN_GEN_FLAGS_PASS_ALL = BIT(2),
  502. IWL_UMAC_SCAN_GEN_FLAGS_PASSIVE = BIT(3),
  503. IWL_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT = BIT(4),
  504. IWL_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE = BIT(5),
  505. IWL_UMAC_SCAN_GEN_FLAGS_MULTIPLE_SSID = BIT(6),
  506. IWL_UMAC_SCAN_GEN_FLAGS_FRAGMENTED = BIT(7),
  507. IWL_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED = BIT(8),
  508. IWL_UMAC_SCAN_GEN_FLAGS_MATCH = BIT(9),
  509. IWL_UMAC_SCAN_GEN_FLAGS_EXTENDED_DWELL = BIT(10),
  510. };
  511. /**
  512. * struct iwl_scan_channel_cfg_umac
  513. * @flags: bitmap - 0-19: directed scan to i'th ssid.
  514. * @channel_num: channel number 1-13 etc.
  515. * @iter_count: repetition count for the channel.
  516. * @iter_interval: interval between two scan iterations on one channel.
  517. */
  518. struct iwl_scan_channel_cfg_umac {
  519. __le32 flags;
  520. u8 channel_num;
  521. u8 iter_count;
  522. __le16 iter_interval;
  523. } __packed; /* SCAN_CHANNEL_CFG_S_VER2 */
  524. /**
  525. * struct iwl_scan_umac_schedule
  526. * @interval: interval in seconds between scan iterations
  527. * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
  528. * @reserved: for alignment and future use
  529. */
  530. struct iwl_scan_umac_schedule {
  531. __le16 interval;
  532. u8 iter_count;
  533. u8 reserved;
  534. } __packed; /* SCAN_SCHED_PARAM_API_S_VER_1 */
  535. /**
  536. * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
  537. * parameters following channels configuration array.
  538. * @schedule: two scheduling plans.
  539. * @delay: delay in TUs before starting the first scan iteration
  540. * @reserved: for future use and alignment
  541. * @preq: probe request with IEs blocks
  542. * @direct_scan: list of SSIDs for directed active scan
  543. */
  544. struct iwl_scan_req_umac_tail {
  545. /* SCAN_PERIODIC_PARAMS_API_S_VER_1 */
  546. struct iwl_scan_umac_schedule schedule[IWL_MAX_SCHED_SCAN_PLANS];
  547. __le16 delay;
  548. __le16 reserved;
  549. /* SCAN_PROBE_PARAMS_API_S_VER_1 */
  550. struct iwl_scan_probe_req preq;
  551. struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
  552. } __packed;
  553. /**
  554. * struct iwl_scan_req_umac
  555. * @flags: &enum iwl_umac_scan_flags
  556. * @uid: scan id, &enum iwl_umac_scan_uid_offsets
  557. * @ooc_priority: out of channel priority - &enum iwl_scan_priority
  558. * @general_flags: &enum iwl_umac_scan_general_flags
  559. * @extended_dwell: dwell time for channels 1, 6 and 11
  560. * @active_dwell: dwell time for active scan
  561. * @passive_dwell: dwell time for passive scan
  562. * @fragmented_dwell: dwell time for fragmented passive scan
  563. * @max_out_time: max out of serving channel time
  564. * @suspend_time: max suspend time
  565. * @scan_priority: scan internal prioritization &enum iwl_scan_priority
  566. * @channel_flags: &enum iwl_scan_channel_flags
  567. * @n_channels: num of channels in scan request
  568. * @reserved: for future use and alignment
  569. * @data: &struct iwl_scan_channel_cfg_umac and
  570. * &struct iwl_scan_req_umac_tail
  571. */
  572. struct iwl_scan_req_umac {
  573. __le32 flags;
  574. __le32 uid;
  575. __le32 ooc_priority;
  576. /* SCAN_GENERAL_PARAMS_API_S_VER_1 */
  577. __le32 general_flags;
  578. u8 extended_dwell;
  579. u8 active_dwell;
  580. u8 passive_dwell;
  581. u8 fragmented_dwell;
  582. __le32 max_out_time;
  583. __le32 suspend_time;
  584. __le32 scan_priority;
  585. /* SCAN_CHANNEL_PARAMS_API_S_VER_1 */
  586. u8 channel_flags;
  587. u8 n_channels;
  588. __le16 reserved;
  589. u8 data[];
  590. } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_1 */
  591. /**
  592. * struct iwl_umac_scan_abort
  593. * @uid: scan id, &enum iwl_umac_scan_uid_offsets
  594. * @flags: reserved
  595. */
  596. struct iwl_umac_scan_abort {
  597. __le32 uid;
  598. __le32 flags;
  599. } __packed; /* SCAN_ABORT_CMD_UMAC_API_S_VER_1 */
  600. /**
  601. * struct iwl_umac_scan_complete
  602. * @uid: scan id, &enum iwl_umac_scan_uid_offsets
  603. * @last_schedule: last scheduling line
  604. * @last_iter: last scan iteration number
  605. * @scan status: &enum iwl_scan_offload_complete_status
  606. * @ebs_status: &enum iwl_scan_ebs_status
  607. * @time_from_last_iter: time elapsed from last iteration
  608. * @reserved: for future use
  609. */
  610. struct iwl_umac_scan_complete {
  611. __le32 uid;
  612. u8 last_schedule;
  613. u8 last_iter;
  614. u8 status;
  615. u8 ebs_status;
  616. __le32 time_from_last_iter;
  617. __le32 reserved;
  618. } __packed; /* SCAN_COMPLETE_NTF_UMAC_API_S_VER_1 */
  619. #define SCAN_OFFLOAD_MATCHING_CHANNELS_LEN 5
  620. /**
  621. * struct iwl_scan_offload_profile_match - match information
  622. * @bssid: matched bssid
  623. * @channel: channel where the match occurred
  624. * @energy:
  625. * @matching_feature:
  626. * @matching_channels: bitmap of channels that matched, referencing
  627. * the channels passed in tue scan offload request
  628. */
  629. struct iwl_scan_offload_profile_match {
  630. u8 bssid[ETH_ALEN];
  631. __le16 reserved;
  632. u8 channel;
  633. u8 energy;
  634. u8 matching_feature;
  635. u8 matching_channels[SCAN_OFFLOAD_MATCHING_CHANNELS_LEN];
  636. } __packed; /* SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S_VER_1 */
  637. /**
  638. * struct iwl_scan_offload_profiles_query - match results query response
  639. * @matched_profiles: bitmap of matched profiles, referencing the
  640. * matches passed in the scan offload request
  641. * @last_scan_age: age of the last offloaded scan
  642. * @n_scans_done: number of offloaded scans done
  643. * @gp2_d0u: GP2 when D0U occurred
  644. * @gp2_invoked: GP2 when scan offload was invoked
  645. * @resume_while_scanning: not used
  646. * @self_recovery: obsolete
  647. * @reserved: reserved
  648. * @matches: array of match information, one for each match
  649. */
  650. struct iwl_scan_offload_profiles_query {
  651. __le32 matched_profiles;
  652. __le32 last_scan_age;
  653. __le32 n_scans_done;
  654. __le32 gp2_d0u;
  655. __le32 gp2_invoked;
  656. u8 resume_while_scanning;
  657. u8 self_recovery;
  658. __le16 reserved;
  659. struct iwl_scan_offload_profile_match matches[IWL_SCAN_MAX_PROFILES];
  660. } __packed; /* SCAN_OFFLOAD_PROFILES_QUERY_RSP_S_VER_2 */
  661. /**
  662. * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
  663. * @uid: scan id, &enum iwl_umac_scan_uid_offsets
  664. * @scanned_channels: number of channels scanned and number of valid elements in
  665. * results array
  666. * @status: one of SCAN_COMP_STATUS_*
  667. * @bt_status: BT on/off status
  668. * @last_channel: last channel that was scanned
  669. * @tsf_low: TSF timer (lower half) in usecs
  670. * @tsf_high: TSF timer (higher half) in usecs
  671. * @results: array of scan results, only "scanned_channels" of them are valid
  672. */
  673. struct iwl_umac_scan_iter_complete_notif {
  674. __le32 uid;
  675. u8 scanned_channels;
  676. u8 status;
  677. u8 bt_status;
  678. u8 last_channel;
  679. __le32 tsf_low;
  680. __le32 tsf_high;
  681. struct iwl_scan_results_notif results[];
  682. } __packed; /* SCAN_ITER_COMPLETE_NTF_UMAC_API_S_VER_1 */
  683. #endif