]> rtime.felk.cvut.cz Git - linux-imx.git/blob - drivers/net/wireless/iwlwifi/mvm/fw-api-scan.h
Merge branch 'v4l_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[linux-imx.git] / drivers / net / wireless / iwlwifi / mvm / fw-api-scan.h
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 - 2013 Intel Corporation. All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of version 2 of the GNU General Public License as
12  * published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22  * USA
23  *
24  * The full GNU General Public License is included in this distribution
25  * in the file called COPYING.
26  *
27  * Contact Information:
28  *  Intel Linux Wireless <ilw@linux.intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  *
40  *  * Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  *  * Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in
44  *    the documentation and/or other materials provided with the
45  *    distribution.
46  *  * Neither the name Intel Corporation nor the names of its
47  *    contributors may be used to endorse or promote products derived
48  *    from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  *
62  *****************************************************************************/
63
64 #ifndef __fw_api_scan_h__
65 #define __fw_api_scan_h__
66
67 #include "fw-api.h"
68
69 /* Scan Commands, Responses, Notifications */
70
71 /* Masks for iwl_scan_channel.type flags */
72 #define SCAN_CHANNEL_TYPE_PASSIVE       0
73 #define SCAN_CHANNEL_TYPE_ACTIVE        BIT(0)
74 #define SCAN_CHANNEL_NARROW_BAND        BIT(22)
75
76 /* Max number of IEs for direct SSID scans in a command */
77 #define PROBE_OPTION_MAX                20
78
79 /**
80  * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
81  * @channel: band is selected by iwl_scan_cmd "flags" field
82  * @tx_gain: gain for analog radio
83  * @dsp_atten: gain for DSP
84  * @active_dwell: dwell time for active scan in TU, typically 5-50
85  * @passive_dwell: dwell time for passive scan in TU, typically 20-500
86  * @type: type is broken down to these bits:
87  *      bit 0: 0 = passive, 1 = active
88  *      bits 1-20: SSID direct bit map. If any of these bits is set then
89  *              the corresponding SSID IE is transmitted in probe request
90  *              (bit i adds IE in position i to the probe request)
91  *      bit 22: channel width, 0 = regular, 1 = TGj narrow channel
92  *
93  * @iteration_count:
94  * @iteration_interval:
95  * This struct is used once for each channel in the scan list.
96  * Each channel can independently select:
97  * 1)  SSID for directed active scans
98  * 2)  Txpower setting (for rate specified within Tx command)
99  * 3)  How long to stay on-channel (behavior may be modified by quiet_time,
100  *     quiet_plcp_th, good_CRC_th)
101  *
102  * To avoid uCode errors, make sure the following are true (see comments
103  * under struct iwl_scan_cmd about max_out_time and quiet_time):
104  * 1)  If using passive_dwell (i.e. passive_dwell != 0):
105  *     active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
106  * 2)  quiet_time <= active_dwell
107  * 3)  If restricting off-channel time (i.e. max_out_time !=0):
108  *     passive_dwell < max_out_time
109  *     active_dwell < max_out_time
110  */
111 struct iwl_scan_channel {
112         __le32 type;
113         __le16 channel;
114         __le16 iteration_count;
115         __le32 iteration_interval;
116         __le16 active_dwell;
117         __le16 passive_dwell;
118 } __packed; /* SCAN_CHANNEL_CONTROL_API_S_VER_1 */
119
120 /**
121  * struct iwl_ssid_ie - directed scan network information element
122  *
123  * Up to 20 of these may appear in REPLY_SCAN_CMD,
124  * selected by "type" bit field in struct iwl_scan_channel;
125  * each channel may select different ssids from among the 20 entries.
126  * SSID IEs get transmitted in reverse order of entry.
127  */
128 struct iwl_ssid_ie {
129         u8 id;
130         u8 len;
131         u8 ssid[IEEE80211_MAX_SSID_LEN];
132 } __packed; /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
133
134 /**
135  * iwl_scan_flags - masks for scan command flags
136  *@SCAN_FLAGS_PERIODIC_SCAN:
137  *@SCAN_FLAGS_P2P_PUBLIC_ACTION_FRAME_TX:
138  *@SCAN_FLAGS_DELAYED_SCAN_LOWBAND:
139  *@SCAN_FLAGS_DELAYED_SCAN_HIGHBAND:
140  *@SCAN_FLAGS_FRAGMENTED_SCAN:
141  */
142 enum iwl_scan_flags {
143         SCAN_FLAGS_PERIODIC_SCAN                = BIT(0),
144         SCAN_FLAGS_P2P_PUBLIC_ACTION_FRAME_TX   = BIT(1),
145         SCAN_FLAGS_DELAYED_SCAN_LOWBAND         = BIT(2),
146         SCAN_FLAGS_DELAYED_SCAN_HIGHBAND        = BIT(3),
147         SCAN_FLAGS_FRAGMENTED_SCAN              = BIT(4),
148 };
149
150 /**
151  * enum iwl_scan_type - Scan types for scan command
152  * @SCAN_TYPE_FORCED:
153  * @SCAN_TYPE_BACKGROUND:
154  * @SCAN_TYPE_OS:
155  * @SCAN_TYPE_ROAMING:
156  * @SCAN_TYPE_ACTION:
157  * @SCAN_TYPE_DISCOVERY:
158  * @SCAN_TYPE_DISCOVERY_FORCED:
159  */
160 enum iwl_scan_type {
161         SCAN_TYPE_FORCED                = 0,
162         SCAN_TYPE_BACKGROUND            = 1,
163         SCAN_TYPE_OS                    = 2,
164         SCAN_TYPE_ROAMING               = 3,
165         SCAN_TYPE_ACTION                = 4,
166         SCAN_TYPE_DISCOVERY             = 5,
167         SCAN_TYPE_DISCOVERY_FORCED      = 6,
168 }; /* SCAN_ACTIVITY_TYPE_E_VER_1 */
169
170 /* Maximal number of channels to scan */
171 #define MAX_NUM_SCAN_CHANNELS 0x24
172
173 /**
174  * struct iwl_scan_cmd - scan request command
175  * ( SCAN_REQUEST_CMD = 0x80 )
176  * @len: command length in bytes
177  * @scan_flags: scan flags from SCAN_FLAGS_*
178  * @channel_count: num of channels in channel list (1 - MAX_NUM_SCAN_CHANNELS)
179  * @quiet_time: in msecs, dwell this time for active scan on quiet channels
180  * @quiet_plcp_th: quiet PLCP threshold (channel is quiet if less than
181  *      this number of packets were received (typically 1)
182  * @passive2active: is auto switching from passive to active allowed (0 or 1)
183  * @rxchain_sel_flags: RXON_RX_CHAIN_*
184  * @max_out_time: in usecs, max out of serving channel time
185  * @suspend_time: how long to pause scan when returning to service channel:
186  *      bits 0-19: beacon interal in usecs (suspend before executing)
187  *      bits 20-23: reserved
188  *      bits 24-31: number of beacons (suspend between channels)
189  * @rxon_flags: RXON_FLG_*
190  * @filter_flags: RXON_FILTER_*
191  * @tx_cmd: for active scans (zero for passive), w/o payload,
192  *      no RS so specify TX rate
193  * @direct_scan: direct scan SSIDs
194  * @type: one of SCAN_TYPE_*
195  * @repeats: how many time to repeat the scan
196  */
197 struct iwl_scan_cmd {
198         __le16 len;
199         u8 scan_flags;
200         u8 channel_count;
201         __le16 quiet_time;
202         __le16 quiet_plcp_th;
203         __le16 passive2active;
204         __le16 rxchain_sel_flags;
205         __le32 max_out_time;
206         __le32 suspend_time;
207         /* RX_ON_FLAGS_API_S_VER_1 */
208         __le32 rxon_flags;
209         __le32 filter_flags;
210         struct iwl_tx_cmd tx_cmd;
211         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
212         __le32 type;
213         __le32 repeats;
214
215         /*
216          * Probe request frame, followed by channel list.
217          *
218          * Size of probe request frame is specified by byte count in tx_cmd.
219          * Channel list follows immediately after probe request frame.
220          * Number of channels in list is specified by channel_count.
221          * Each channel in list is of type:
222          *
223          * struct iwl_scan_channel channels[0];
224          *
225          * NOTE:  Only one band of channels can be scanned per pass.  You
226          * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
227          * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
228          * before requesting another scan.
229          */
230         u8 data[0];
231 } __packed; /* SCAN_REQUEST_FIXED_PART_API_S_VER_5 */
232
233 /* Response to scan request contains only status with one of these values */
234 #define SCAN_RESPONSE_OK        0x1
235 #define SCAN_RESPONSE_ERROR     0x2
236
237 /*
238  * SCAN_ABORT_CMD = 0x81
239  * When scan abort is requested, the command has no fields except the common
240  * header. The response contains only a status with one of these values.
241  */
242 #define SCAN_ABORT_POSSIBLE     0x1
243 #define SCAN_ABORT_IGNORED      0x2 /* no pending scans */
244
245 /* TODO: complete documentation */
246 #define  SCAN_OWNER_STATUS 0x1
247 #define  MEASURE_OWNER_STATUS 0x2
248
249 /**
250  * struct iwl_scan_start_notif - notifies start of scan in the device
251  * ( SCAN_START_NOTIFICATION = 0x82 )
252  * @tsf_low: TSF timer (lower half) in usecs
253  * @tsf_high: TSF timer (higher half) in usecs
254  * @beacon_timer: structured as follows:
255  *      bits 0:19 - beacon interval in usecs
256  *      bits 20:23 - reserved (0)
257  *      bits 24:31 - number of beacons
258  * @channel: which channel is scanned
259  * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
260  * @status: one of *_OWNER_STATUS
261  */
262 struct iwl_scan_start_notif {
263         __le32 tsf_low;
264         __le32 tsf_high;
265         __le32 beacon_timer;
266         u8 channel;
267         u8 band;
268         u8 reserved[2];
269         __le32 status;
270 } __packed; /* SCAN_START_NTF_API_S_VER_1 */
271
272 /* scan results probe_status first bit indicates success */
273 #define SCAN_PROBE_STATUS_OK            0
274 #define SCAN_PROBE_STATUS_TX_FAILED     BIT(0)
275 /* error statuses combined with TX_FAILED */
276 #define SCAN_PROBE_STATUS_FAIL_TTL      BIT(1)
277 #define SCAN_PROBE_STATUS_FAIL_BT       BIT(2)
278
279 /* How many statistics are gathered for each channel */
280 #define SCAN_RESULTS_STATISTICS 1
281
282 /**
283  * enum iwl_scan_complete_status - status codes for scan complete notifications
284  * @SCAN_COMP_STATUS_OK:  scan completed successfully
285  * @SCAN_COMP_STATUS_ABORT: scan was aborted by user
286  * @SCAN_COMP_STATUS_ERR_SLEEP: sending null sleep packet failed
287  * @SCAN_COMP_STATUS_ERR_CHAN_TIMEOUT: timeout before channel is ready
288  * @SCAN_COMP_STATUS_ERR_PROBE: sending probe request failed
289  * @SCAN_COMP_STATUS_ERR_WAKEUP: sending null wakeup packet failed
290  * @SCAN_COMP_STATUS_ERR_ANTENNAS: invalid antennas chosen at scan command
291  * @SCAN_COMP_STATUS_ERR_INTERNAL: internal error caused scan abort
292  * @SCAN_COMP_STATUS_ERR_COEX: medium was lost ot WiMax
293  * @SCAN_COMP_STATUS_P2P_ACTION_OK: P2P public action frame TX was successful
294  *      (not an error!)
295  * @SCAN_COMP_STATUS_ITERATION_END: indicates end of one repeatition the driver
296  *      asked for
297  * @SCAN_COMP_STATUS_ERR_ALLOC_TE: scan could not allocate time events
298 */
299 enum iwl_scan_complete_status {
300         SCAN_COMP_STATUS_OK = 0x1,
301         SCAN_COMP_STATUS_ABORT = 0x2,
302         SCAN_COMP_STATUS_ERR_SLEEP = 0x3,
303         SCAN_COMP_STATUS_ERR_CHAN_TIMEOUT = 0x4,
304         SCAN_COMP_STATUS_ERR_PROBE = 0x5,
305         SCAN_COMP_STATUS_ERR_WAKEUP = 0x6,
306         SCAN_COMP_STATUS_ERR_ANTENNAS = 0x7,
307         SCAN_COMP_STATUS_ERR_INTERNAL = 0x8,
308         SCAN_COMP_STATUS_ERR_COEX = 0x9,
309         SCAN_COMP_STATUS_P2P_ACTION_OK = 0xA,
310         SCAN_COMP_STATUS_ITERATION_END = 0x0B,
311         SCAN_COMP_STATUS_ERR_ALLOC_TE = 0x0C,
312 };
313
314 /**
315  * struct iwl_scan_results_notif - scan results for one channel
316  * ( SCAN_RESULTS_NOTIFICATION = 0x83 )
317  * @channel: which channel the results are from
318  * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
319  * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
320  * @num_probe_not_sent: # of request that weren't sent due to not enough time
321  * @duration: duration spent in channel, in usecs
322  * @statistics: statistics gathered for this channel
323  */
324 struct iwl_scan_results_notif {
325         u8 channel;
326         u8 band;
327         u8 probe_status;
328         u8 num_probe_not_sent;
329         __le32 duration;
330         __le32 statistics[SCAN_RESULTS_STATISTICS];
331 } __packed; /* SCAN_RESULT_NTF_API_S_VER_2 */
332
333 /**
334  * struct iwl_scan_complete_notif - notifies end of scanning (all channels)
335  * ( SCAN_COMPLETE_NOTIFICATION = 0x84 )
336  * @scanned_channels: number of channels scanned (and number of valid results)
337  * @status: one of SCAN_COMP_STATUS_*
338  * @bt_status: BT on/off status
339  * @last_channel: last channel that was scanned
340  * @tsf_low: TSF timer (lower half) in usecs
341  * @tsf_high: TSF timer (higher half) in usecs
342  * @results: all scan results, only "scanned_channels" of them are valid
343  */
344 struct iwl_scan_complete_notif {
345         u8 scanned_channels;
346         u8 status;
347         u8 bt_status;
348         u8 last_channel;
349         __le32 tsf_low;
350         __le32 tsf_high;
351         struct iwl_scan_results_notif results[MAX_NUM_SCAN_CHANNELS];
352 } __packed; /* SCAN_COMPLETE_NTF_API_S_VER_2 */
353
354 /* scan offload */
355 #define IWL_MAX_SCAN_CHANNELS           40
356 #define IWL_SCAN_MAX_BLACKLIST_LEN      64
357 #define IWL_SCAN_MAX_PROFILES           11
358 #define SCAN_OFFLOAD_PROBE_REQ_SIZE     512
359
360 /* Default watchdog (in MS) for scheduled scan iteration */
361 #define IWL_SCHED_SCAN_WATCHDOG cpu_to_le16(15000)
362
363 #define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
364 #define CAN_ABORT_STATUS 1
365
366 #define IWL_FULL_SCAN_MULTIPLIER 5
367 #define IWL_FAST_SCHED_SCAN_ITERATIONS 3
368
369 /**
370  * struct iwl_scan_offload_cmd - SCAN_REQUEST_FIXED_PART_API_S_VER_6
371  * @scan_flags:         see enum iwl_scan_flags
372  * @channel_count:      channels in channel list
373  * @quiet_time:         dwell time, in milisiconds, on quiet channel
374  * @quiet_plcp_th:      quiet channel num of packets threshold
375  * @good_CRC_th:        passive to active promotion threshold
376  * @rx_chain:           RXON rx chain.
377  * @max_out_time:       max uSec to be out of assoceated channel
378  * @suspend_time:       pause scan this long when returning to service channel
379  * @flags:              RXON flags
380  * @filter_flags:       RXONfilter
381  * @tx_cmd:             tx command for active scan; for 2GHz and for 5GHz.
382  * @direct_scan:        list of SSIDs for directed active scan
383  * @scan_type:          see enum iwl_scan_type.
384  * @rep_count:          repetition count for each scheduled scan iteration.
385  */
386 struct iwl_scan_offload_cmd {
387         __le16 len;
388         u8 scan_flags;
389         u8 channel_count;
390         __le16 quiet_time;
391         __le16 quiet_plcp_th;
392         __le16 good_CRC_th;
393         __le16 rx_chain;
394         __le32 max_out_time;
395         __le32 suspend_time;
396         /* RX_ON_FLAGS_API_S_VER_1 */
397         __le32 flags;
398         __le32 filter_flags;
399         struct iwl_tx_cmd tx_cmd[2];
400         /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
401         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
402         __le32 scan_type;
403         __le32 rep_count;
404 } __packed;
405
406 enum iwl_scan_offload_channel_flags {
407         IWL_SCAN_OFFLOAD_CHANNEL_ACTIVE         = BIT(0),
408         IWL_SCAN_OFFLOAD_CHANNEL_NARROW         = BIT(22),
409         IWL_SCAN_OFFLOAD_CHANNEL_FULL           = BIT(24),
410         IWL_SCAN_OFFLOAD_CHANNEL_PARTIAL        = BIT(25),
411 };
412
413 /**
414  * iwl_scan_channel_cfg - SCAN_CHANNEL_CFG_S
415  * @type:               bitmap - see enum iwl_scan_offload_channel_flags.
416  *                      0:      passive (0) or active (1) scan.
417  *                      1-20:   directed scan to i'th ssid.
418  *                      22:     channel width configuation - 1 for narrow.
419  *                      24:     full scan.
420  *                      25:     partial scan.
421  * @channel_number:     channel number 1-13 etc.
422  * @iter_count:         repetition count for the channel.
423  * @iter_interval:      interval between two innteration on one channel.
424  * @dwell_time: entry 0 - active scan, entry 1 - passive scan.
425  */
426 struct iwl_scan_channel_cfg {
427         __le32 type[IWL_MAX_SCAN_CHANNELS];
428         __le16 channel_number[IWL_MAX_SCAN_CHANNELS];
429         __le16 iter_count[IWL_MAX_SCAN_CHANNELS];
430         __le32 iter_interval[IWL_MAX_SCAN_CHANNELS];
431         u8 dwell_time[IWL_MAX_SCAN_CHANNELS][2];
432 } __packed;
433
434 /**
435  * iwl_scan_offload_cfg - SCAN_OFFLOAD_CONFIG_API_S
436  * @scan_cmd:           scan command fixed part
437  * @channel_cfg:        scan channel configuration
438  * @data:               probe request frames (one per band)
439  */
440 struct iwl_scan_offload_cfg {
441         struct iwl_scan_offload_cmd scan_cmd;
442         struct iwl_scan_channel_cfg channel_cfg;
443         u8 data[0];
444 } __packed;
445
446 /**
447  * iwl_scan_offload_blacklist - SCAN_OFFLOAD_BLACKLIST_S
448  * @ssid:               MAC address to filter out
449  * @reported_rssi:      AP rssi reported to the host
450  */
451 struct iwl_scan_offload_blacklist {
452         u8 ssid[ETH_ALEN];
453         u8 reported_rssi;
454         u8 reserved;
455 } __packed;
456
457 enum iwl_scan_offload_network_type {
458         IWL_NETWORK_TYPE_BSS    = 1,
459         IWL_NETWORK_TYPE_IBSS   = 2,
460         IWL_NETWORK_TYPE_ANY    = 3,
461 };
462
463 enum iwl_scan_offload_band_selection {
464         IWL_SCAN_OFFLOAD_SELECT_2_4     = 0x4,
465         IWL_SCAN_OFFLOAD_SELECT_5_2     = 0x8,
466         IWL_SCAN_OFFLOAD_SELECT_ANY     = 0xc,
467 };
468
469 /**
470  * iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
471  * @ssid_index:         index to ssid list in fixed part
472  * @unicast_cipher:     encryption olgorithm to match - bitmap
473  * @aut_alg:            authentication olgorithm to match - bitmap
474  * @network_type:       enum iwl_scan_offload_network_type
475  * @band_selection:     enum iwl_scan_offload_band_selection
476  */
477 struct iwl_scan_offload_profile {
478         u8 ssid_index;
479         u8 unicast_cipher;
480         u8 auth_alg;
481         u8 network_type;
482         u8 band_selection;
483         u8 reserved[3];
484 } __packed;
485
486 /**
487  * iwl_scan_offload_profile_cfg - SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1
488  * @blaclist:           AP list to filter off from scan results
489  * @profiles:           profiles to search for match
490  * @blacklist_len:      length of blacklist
491  * @num_profiles:       num of profiles in the list
492  */
493 struct iwl_scan_offload_profile_cfg {
494         struct iwl_scan_offload_blacklist blacklist[IWL_SCAN_MAX_BLACKLIST_LEN];
495         struct iwl_scan_offload_profile profiles[IWL_SCAN_MAX_PROFILES];
496         u8 blacklist_len;
497         u8 num_profiles;
498         u8 reserved[2];
499 } __packed;
500
501 /**
502  * iwl_scan_offload_schedule - schedule of scan offload
503  * @delay:              delay between iterations, in seconds.
504  * @iterations:         num of scan iterations
505  * @full_scan_mul:      number of partial scans before each full scan
506  */
507 struct iwl_scan_offload_schedule {
508         u16 delay;
509         u8 iterations;
510         u8 full_scan_mul;
511 } __packed;
512
513 /*
514  * iwl_scan_offload_flags
515  *
516  * IWL_SCAN_OFFLOAD_FLAG_FILTER_SSID: filter mode - upload every beacon or match
517  *      ssid list.
518  * IWL_SCAN_OFFLOAD_FLAG_CACHED_CHANNEL: add cached channels to partial scan.
519  * IWL_SCAN_OFFLOAD_FLAG_ENERGY_SCAN: use energy based scan before partial scan
520  *      on A band.
521  */
522 enum iwl_scan_offload_flags {
523         IWL_SCAN_OFFLOAD_FLAG_FILTER_SSID       = BIT(0),
524         IWL_SCAN_OFFLOAD_FLAG_CACHED_CHANNEL    = BIT(2),
525         IWL_SCAN_OFFLOAD_FLAG_ENERGY_SCAN       = BIT(3),
526 };
527
528 /**
529  * iwl_scan_offload_req - scan offload request command
530  * @flags:              bitmap - enum iwl_scan_offload_flags.
531  * @watchdog:           maximum scan duration in TU.
532  * @delay:              delay in seconds before first iteration.
533  * @schedule_line:      scan offload schedule, for fast and regular scan.
534  */
535 struct iwl_scan_offload_req {
536         __le16 flags;
537         __le16 watchdog;
538         __le16 delay;
539         __le16 reserved;
540         struct iwl_scan_offload_schedule schedule_line[2];
541 } __packed;
542
543 enum iwl_scan_offload_compleate_status {
544         IWL_SCAN_OFFLOAD_COMPLETED      = 1,
545         IWL_SCAN_OFFLOAD_ABORTED        = 2,
546 };
547
548 /**
549  * iwl_scan_offload_complete - SCAN_OFFLOAD_COMPLETE_NTF_API_S_VER_1
550  * @last_schedule_line:         last schedule line executed (fast or regular)
551  * @last_schedule_iteration:    last scan iteration executed before scan abort
552  * @status:                     enum iwl_scan_offload_compleate_status
553  */
554 struct iwl_scan_offload_complete {
555         u8 last_schedule_line;
556         u8 last_schedule_iteration;
557         u8 status;
558         u8 reserved;
559 } __packed;
560
561 #endif