OSDN Git Service

b0671e16e1ce
[uclinux-h8/linux.git] /
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) 2008 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11  * Copyright(c) 2018 Intel Corporation
12  * Copyright(c) 2019 Intel Corporation
13  *
14  * This program is free software; you can redistribute it and/or modify
15  * it under the terms of version 2 of the GNU General Public License as
16  * published by the Free Software Foundation.
17  *
18  * This program is distributed in the hope that it will be useful, but
19  * WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21  * General Public License for more details.
22  *
23  * The full GNU General Public License is included in this distribution
24  * in the file called COPYING.
25  *
26  * Contact Information:
27  *  Intel Linux Wireless <linuxwifi@intel.com>
28  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
29  *
30  * BSD LICENSE
31  *
32  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
33  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
34  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
35  * Copyright(c) 2018 Intel Corporation
36  * Copyright(c) 2019 Intel Corporation
37  * All rights reserved.
38  *
39  * Redistribution and use in source and binary forms, with or without
40  * modification, are permitted provided that the following conditions
41  * are met:
42  *
43  *  * Redistributions of source code must retain the above copyright
44  *    notice, this list of conditions and the following disclaimer.
45  *  * Redistributions in binary form must reproduce the above copyright
46  *    notice, this list of conditions and the following disclaimer in
47  *    the documentation and/or other materials provided with the
48  *    distribution.
49  *  * Neither the name Intel Corporation nor the names of its
50  *    contributors may be used to endorse or promote products derived
51  *    from this software without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
54  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
55  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
56  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
57  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
58  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
59  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
60  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
61  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
62  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
63  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64  *****************************************************************************/
65
66 #ifndef __iwl_fw_file_h__
67 #define __iwl_fw_file_h__
68
69 #include <linux/netdevice.h>
70 #include <linux/nl80211.h>
71
72 /* v1/v2 uCode file layout */
73 struct iwl_ucode_header {
74         __le32 ver;     /* major/minor/API/serial */
75         union {
76                 struct {
77                         __le32 inst_size;       /* bytes of runtime code */
78                         __le32 data_size;       /* bytes of runtime data */
79                         __le32 init_size;       /* bytes of init code */
80                         __le32 init_data_size;  /* bytes of init data */
81                         __le32 boot_size;       /* bytes of bootstrap code */
82                         u8 data[0];             /* in same order as sizes */
83                 } v1;
84                 struct {
85                         __le32 build;           /* build number */
86                         __le32 inst_size;       /* bytes of runtime code */
87                         __le32 data_size;       /* bytes of runtime data */
88                         __le32 init_size;       /* bytes of init code */
89                         __le32 init_data_size;  /* bytes of init data */
90                         __le32 boot_size;       /* bytes of bootstrap code */
91                         u8 data[0];             /* in same order as sizes */
92                 } v2;
93         } u;
94 };
95
96 #define IWL_UCODE_INI_TLV_GROUP BIT(24)
97
98 /*
99  * new TLV uCode file layout
100  *
101  * The new TLV file format contains TLVs, that each specify
102  * some piece of data.
103  */
104
105 enum iwl_ucode_tlv_type {
106         IWL_UCODE_TLV_INVALID           = 0, /* unused */
107         IWL_UCODE_TLV_INST              = 1,
108         IWL_UCODE_TLV_DATA              = 2,
109         IWL_UCODE_TLV_INIT              = 3,
110         IWL_UCODE_TLV_INIT_DATA         = 4,
111         IWL_UCODE_TLV_BOOT              = 5,
112         IWL_UCODE_TLV_PROBE_MAX_LEN     = 6, /* a u32 value */
113         IWL_UCODE_TLV_PAN               = 7,
114         IWL_UCODE_TLV_RUNT_EVTLOG_PTR   = 8,
115         IWL_UCODE_TLV_RUNT_EVTLOG_SIZE  = 9,
116         IWL_UCODE_TLV_RUNT_ERRLOG_PTR   = 10,
117         IWL_UCODE_TLV_INIT_EVTLOG_PTR   = 11,
118         IWL_UCODE_TLV_INIT_EVTLOG_SIZE  = 12,
119         IWL_UCODE_TLV_INIT_ERRLOG_PTR   = 13,
120         IWL_UCODE_TLV_ENHANCE_SENS_TBL  = 14,
121         IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
122         IWL_UCODE_TLV_WOWLAN_INST       = 16,
123         IWL_UCODE_TLV_WOWLAN_DATA       = 17,
124         IWL_UCODE_TLV_FLAGS             = 18,
125         IWL_UCODE_TLV_SEC_RT            = 19,
126         IWL_UCODE_TLV_SEC_INIT          = 20,
127         IWL_UCODE_TLV_SEC_WOWLAN        = 21,
128         IWL_UCODE_TLV_DEF_CALIB         = 22,
129         IWL_UCODE_TLV_PHY_SKU           = 23,
130         IWL_UCODE_TLV_SECURE_SEC_RT     = 24,
131         IWL_UCODE_TLV_SECURE_SEC_INIT   = 25,
132         IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
133         IWL_UCODE_TLV_NUM_OF_CPU        = 27,
134         IWL_UCODE_TLV_CSCHEME           = 28,
135         IWL_UCODE_TLV_API_CHANGES_SET   = 29,
136         IWL_UCODE_TLV_ENABLED_CAPABILITIES      = 30,
137         IWL_UCODE_TLV_N_SCAN_CHANNELS           = 31,
138         IWL_UCODE_TLV_PAGING            = 32,
139         IWL_UCODE_TLV_SEC_RT_USNIFFER   = 34,
140         /* 35 is unused */
141         IWL_UCODE_TLV_FW_VERSION        = 36,
142         IWL_UCODE_TLV_FW_DBG_DEST       = 38,
143         IWL_UCODE_TLV_FW_DBG_CONF       = 39,
144         IWL_UCODE_TLV_FW_DBG_TRIGGER    = 40,
145         IWL_UCODE_TLV_CMD_VERSIONS      = 48,
146         IWL_UCODE_TLV_FW_GSCAN_CAPA     = 50,
147         IWL_UCODE_TLV_FW_MEM_SEG        = 51,
148         IWL_UCODE_TLV_IML               = 52,
149         IWL_UCODE_TLV_UMAC_DEBUG_ADDRS  = 54,
150         IWL_UCODE_TLV_LMAC_DEBUG_ADDRS  = 55,
151         IWL_UCODE_TLV_FW_RECOVERY_INFO  = 57,
152         IWL_UCODE_TLV_FW_FSEQ_VERSION           = 60,
153
154         IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION    = IWL_UCODE_INI_TLV_GROUP + 0x1,
155         IWL_UCODE_TLV_DEBUG_BASE = IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION,
156         IWL_UCODE_TLV_TYPE_HCMD                 = IWL_UCODE_INI_TLV_GROUP + 0x2,
157         IWL_UCODE_TLV_TYPE_REGIONS              = IWL_UCODE_INI_TLV_GROUP + 0x3,
158         IWL_UCODE_TLV_TYPE_TRIGGERS             = IWL_UCODE_INI_TLV_GROUP + 0x4,
159         IWL_UCODE_TLV_TYPE_DEBUG_FLOW           = IWL_UCODE_INI_TLV_GROUP + 0x5,
160         IWL_UCODE_TLV_DEBUG_MAX = IWL_UCODE_TLV_TYPE_DEBUG_FLOW,
161
162         /* TLVs 0x1000-0x2000 are for internal driver usage */
163         IWL_UCODE_TLV_FW_DBG_DUMP_LST   = 0x1000,
164 };
165
166 struct iwl_ucode_tlv {
167         __le32 type;            /* see above */
168         __le32 length;          /* not including type/length fields */
169         u8 data[0];
170 };
171
172 #define IWL_TLV_UCODE_MAGIC             0x0a4c5749
173 #define FW_VER_HUMAN_READABLE_SZ        64
174
175 struct iwl_tlv_ucode_header {
176         /*
177          * The TLV style ucode header is distinguished from
178          * the v1/v2 style header by first four bytes being
179          * zero, as such is an invalid combination of
180          * major/minor/API/serial versions.
181          */
182         __le32 zero;
183         __le32 magic;
184         u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
185         /* major/minor/API/serial or major in new format */
186         __le32 ver;
187         __le32 build;
188         __le64 ignore;
189         /*
190          * The data contained herein has a TLV layout,
191          * see above for the TLV header and types.
192          * Note that each TLV is padded to a length
193          * that is a multiple of 4 for alignment.
194          */
195         u8 data[0];
196 };
197
198 /*
199  * ucode TLVs
200  *
201  * ability to get extension for: flags & capabilities from ucode binaries files
202  */
203 struct iwl_ucode_api {
204         __le32 api_index;
205         __le32 api_flags;
206 } __packed;
207
208 struct iwl_ucode_capa {
209         __le32 api_index;
210         __le32 api_capa;
211 } __packed;
212
213 /**
214  * enum iwl_ucode_tlv_flag - ucode API flags
215  * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
216  *      was a separate TLV but moved here to save space.
217  * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
218  *      treats good CRC threshold as a boolean
219  * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
220  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
221  * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
222  *      offload profile config command.
223  * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
224  *      (rather than two) IPv6 addresses
225  * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
226  *      from the probe request template.
227  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
228  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
229  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
230  * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
231  * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
232  * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
233  */
234 enum iwl_ucode_tlv_flag {
235         IWL_UCODE_TLV_FLAGS_PAN                 = BIT(0),
236         IWL_UCODE_TLV_FLAGS_NEWSCAN             = BIT(1),
237         IWL_UCODE_TLV_FLAGS_MFP                 = BIT(2),
238         IWL_UCODE_TLV_FLAGS_SHORT_BL            = BIT(7),
239         IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS     = BIT(10),
240         IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID       = BIT(12),
241         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL    = BIT(15),
242         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE    = BIT(16),
243         IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT       = BIT(24),
244         IWL_UCODE_TLV_FLAGS_EBS_SUPPORT         = BIT(25),
245         IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD        = BIT(26),
246         IWL_UCODE_TLV_FLAGS_BCAST_FILTERING     = BIT(29),
247 };
248
249 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
250
251 /**
252  * enum iwl_ucode_tlv_api - ucode api
253  * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
254  *      longer than the passive one, which is essential for fragmented scan.
255  * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
256  * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
257  * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
258  * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
259  *      iteration complete notification, and the timestamp reported for RX
260  *      received during scan, are reported in TSF of the mac specified in the
261  *      scan request.
262  * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
263  *      ADD_MODIFY_STA_KEY_API_S_VER_2.
264  * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
265  * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
266  * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
267  * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field
268  *      indicating low latency direction.
269  * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
270  *      deprecated.
271  * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8
272  *      of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8
273  * @IWL_UCODE_TLV_API_FRAG_EBS: This ucode supports fragmented EBS
274  * @IWL_UCODE_TLV_API_REDUCE_TX_POWER: This ucode supports v5 of
275  *      the REDUCE_TX_POWER_CMD.
276  * @IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF: This ucode supports the short
277  *      version of the beacon notification.
278  * @IWL_UCODE_TLV_API_BEACON_FILTER_V4: This ucode supports v4 of
279  *      BEACON_FILTER_CONFIG_API_S_VER_4.
280  * @IWL_UCODE_TLV_API_REGULATORY_NVM_INFO: This ucode supports v4 of
281  *      REGULATORY_NVM_GET_INFO_RSP_API_S.
282  * @IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ: This ucode supports v7 of
283  *      LOCATION_RANGE_REQ_CMD_API_S and v6 of LOCATION_RANGE_RESP_NTFY_API_S.
284  * @IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS: This ucode supports v2 of
285  *      SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S and v3 of
286  *      SCAN_OFFLOAD_PROFILES_QUERY_RSP_S.
287  * @IWL_UCODE_TLV_API_MBSSID_HE: This ucode supports v2 of
288  *      STA_CONTEXT_DOT11AX_API_S
289  *
290  * @NUM_IWL_UCODE_TLV_API: number of bits used
291  */
292 enum iwl_ucode_tlv_api {
293         /* API Set 0 */
294         IWL_UCODE_TLV_API_FRAGMENTED_SCAN       = (__force iwl_ucode_tlv_api_t)8,
295         IWL_UCODE_TLV_API_WIFI_MCC_UPDATE       = (__force iwl_ucode_tlv_api_t)9,
296         IWL_UCODE_TLV_API_LQ_SS_PARAMS          = (__force iwl_ucode_tlv_api_t)18,
297         IWL_UCODE_TLV_API_NEW_VERSION           = (__force iwl_ucode_tlv_api_t)20,
298         IWL_UCODE_TLV_API_SCAN_TSF_REPORT       = (__force iwl_ucode_tlv_api_t)28,
299         IWL_UCODE_TLV_API_TKIP_MIC_KEYS         = (__force iwl_ucode_tlv_api_t)29,
300         IWL_UCODE_TLV_API_STA_TYPE              = (__force iwl_ucode_tlv_api_t)30,
301         IWL_UCODE_TLV_API_NAN2_VER2             = (__force iwl_ucode_tlv_api_t)31,
302         /* API Set 1 */
303         IWL_UCODE_TLV_API_ADAPTIVE_DWELL        = (__force iwl_ucode_tlv_api_t)32,
304         IWL_UCODE_TLV_API_OCE                   = (__force iwl_ucode_tlv_api_t)33,
305         IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE   = (__force iwl_ucode_tlv_api_t)34,
306         IWL_UCODE_TLV_API_NEW_RX_STATS          = (__force iwl_ucode_tlv_api_t)35,
307         IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL   = (__force iwl_ucode_tlv_api_t)36,
308         IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY     = (__force iwl_ucode_tlv_api_t)38,
309         IWL_UCODE_TLV_API_DEPRECATE_TTAK        = (__force iwl_ucode_tlv_api_t)41,
310         IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2     = (__force iwl_ucode_tlv_api_t)42,
311         IWL_UCODE_TLV_API_FRAG_EBS              = (__force iwl_ucode_tlv_api_t)44,
312         IWL_UCODE_TLV_API_REDUCE_TX_POWER       = (__force iwl_ucode_tlv_api_t)45,
313         IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF    = (__force iwl_ucode_tlv_api_t)46,
314         IWL_UCODE_TLV_API_BEACON_FILTER_V4      = (__force iwl_ucode_tlv_api_t)47,
315         IWL_UCODE_TLV_API_REGULATORY_NVM_INFO   = (__force iwl_ucode_tlv_api_t)48,
316         IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ     = (__force iwl_ucode_tlv_api_t)49,
317         IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS    = (__force iwl_ucode_tlv_api_t)50,
318         IWL_UCODE_TLV_API_MBSSID_HE             = (__force iwl_ucode_tlv_api_t)52,
319         IWL_UCODE_TLV_API_WOWLAN_TCP_SYN_WAKE   = (__force iwl_ucode_tlv_api_t)53,
320         IWL_UCODE_TLV_API_FTM_RTT_ACCURACY      = (__force iwl_ucode_tlv_api_t)54,
321
322         NUM_IWL_UCODE_TLV_API
323 #ifdef __CHECKER__
324                 /* sparse says it cannot increment the previous enum member */
325                 = 128
326 #endif
327 };
328
329 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
330
331 /**
332  * enum iwl_ucode_tlv_capa - ucode capabilities
333  * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
334  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
335  * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
336  * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
337  * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
338  * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
339  *      tx power value into TPC Report action frame and Link Measurement Report
340  *      action frame
341  * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
342  *      channel in DS parameter set element in probe requests.
343  * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
344  *      probe requests.
345  * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
346  * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
347  *      which also implies support for the scheduler configuration command
348  * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
349  * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
350  * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
351  * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
352  * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
353  * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
354  * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
355  *      is standalone or with a BSS station interface in the same binding.
356  * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
357  * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
358  *      sources for the MCC. This TLV bit is a future replacement to
359  *      IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
360  *      is supported.
361  * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
362  * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan (no longer used)
363  * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
364  * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
365  * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
366  * @IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2: firmware implements Coex Schema 2
367  * IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD: firmware supports CSA command
368  * @IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS: firmware supports ultra high band
369  *      (6 GHz).
370  * @IWL_UCODE_TLV_CAPA_CS_MODIFY: firmware supports modify action CSA command
371  * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
372  * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
373  * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
374  * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
375  *      countdown offloading. Beacon notifications are not sent to the host.
376  *      The fw also offloads TBTT alignment.
377  * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
378  *      antenna the beacon should be transmitted
379  * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
380  *      from AP and will send it upon d0i3 exit.
381  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3: support LAR API V3
382  * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
383  * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
384  *      thresholds reporting
385  * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
386  * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
387  *      regular image.
388  * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
389  *      memory addresses from the firmware.
390  * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
391  * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
392  *      command size (command version 4) that supports toggling ACK TX
393  *      power reduction.
394  * @IWL_UCODE_TLV_CAPA_D3_DEBUG: supports debug recording during D3
395  * @IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT: MCC response support 11ax
396  *      capability.
397  * @IWL_UCODE_TLV_CAPA_CSI_REPORTING: firmware is capable of being configured
398  *      to report the CSI information with (certain) RX frames
399  * @IWL_UCODE_TLV_CAPA_FTM_CALIBRATED: has FTM calibrated and thus supports both
400  *      initiator and responder
401  *
402  * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
403  *
404  * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
405  */
406 enum iwl_ucode_tlv_capa {
407         /* set 0 */
408         IWL_UCODE_TLV_CAPA_D0I3_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)0,
409         IWL_UCODE_TLV_CAPA_LAR_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)1,
410         IWL_UCODE_TLV_CAPA_UMAC_SCAN                    = (__force iwl_ucode_tlv_capa_t)2,
411         IWL_UCODE_TLV_CAPA_BEAMFORMER                   = (__force iwl_ucode_tlv_capa_t)3,
412         IWL_UCODE_TLV_CAPA_TDLS_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)6,
413         IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = (__force iwl_ucode_tlv_capa_t)8,
414         IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT      = (__force iwl_ucode_tlv_capa_t)9,
415         IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT       = (__force iwl_ucode_tlv_capa_t)10,
416         IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT         = (__force iwl_ucode_tlv_capa_t)11,
417         IWL_UCODE_TLV_CAPA_DQA_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)12,
418         IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH          = (__force iwl_ucode_tlv_capa_t)13,
419         IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG            = (__force iwl_ucode_tlv_capa_t)17,
420         IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT              = (__force iwl_ucode_tlv_capa_t)18,
421         IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT         = (__force iwl_ucode_tlv_capa_t)19,
422         IWL_UCODE_TLV_CAPA_CSUM_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)21,
423         IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS           = (__force iwl_ucode_tlv_capa_t)22,
424         IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD                = (__force iwl_ucode_tlv_capa_t)26,
425         IWL_UCODE_TLV_CAPA_BT_COEX_PLCR                 = (__force iwl_ucode_tlv_capa_t)28,
426         IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC                = (__force iwl_ucode_tlv_capa_t)29,
427         IWL_UCODE_TLV_CAPA_BT_COEX_RRC                  = (__force iwl_ucode_tlv_capa_t)30,
428         IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT                = (__force iwl_ucode_tlv_capa_t)31,
429
430         /* set 1 */
431         IWL_UCODE_TLV_CAPA_STA_PM_NOTIF                 = (__force iwl_ucode_tlv_capa_t)38,
432         IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT          = (__force iwl_ucode_tlv_capa_t)39,
433         IWL_UCODE_TLV_CAPA_CDB_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)40,
434         IWL_UCODE_TLV_CAPA_D0I3_END_FIRST               = (__force iwl_ucode_tlv_capa_t)41,
435         IWL_UCODE_TLV_CAPA_TLC_OFFLOAD                  = (__force iwl_ucode_tlv_capa_t)43,
436         IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA                = (__force iwl_ucode_tlv_capa_t)44,
437         IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2                = (__force iwl_ucode_tlv_capa_t)45,
438         IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD           = (__force iwl_ucode_tlv_capa_t)46,
439         IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS            = (__force iwl_ucode_tlv_capa_t)48,
440         IWL_UCODE_TLV_CAPA_FTM_CALIBRATED               = (__force iwl_ucode_tlv_capa_t)47,
441         IWL_UCODE_TLV_CAPA_CS_MODIFY                    = (__force iwl_ucode_tlv_capa_t)49,
442
443         /* set 2 */
444         IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE         = (__force iwl_ucode_tlv_capa_t)64,
445         IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS            = (__force iwl_ucode_tlv_capa_t)65,
446         IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT             = (__force iwl_ucode_tlv_capa_t)67,
447         IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT       = (__force iwl_ucode_tlv_capa_t)68,
448         IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD         = (__force iwl_ucode_tlv_capa_t)70,
449         IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION         = (__force iwl_ucode_tlv_capa_t)71,
450         IWL_UCODE_TLV_CAPA_BEACON_STORING               = (__force iwl_ucode_tlv_capa_t)72,
451         IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3               = (__force iwl_ucode_tlv_capa_t)73,
452         IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW                = (__force iwl_ucode_tlv_capa_t)74,
453         IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT      = (__force iwl_ucode_tlv_capa_t)75,
454         IWL_UCODE_TLV_CAPA_CTDP_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)76,
455         IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED             = (__force iwl_ucode_tlv_capa_t)77,
456         IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG        = (__force iwl_ucode_tlv_capa_t)80,
457         IWL_UCODE_TLV_CAPA_LQM_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)81,
458         IWL_UCODE_TLV_CAPA_TX_POWER_ACK                 = (__force iwl_ucode_tlv_capa_t)84,
459         IWL_UCODE_TLV_CAPA_D3_DEBUG                     = (__force iwl_ucode_tlv_capa_t)87,
460         IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT              = (__force iwl_ucode_tlv_capa_t)88,
461         IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT      = (__force iwl_ucode_tlv_capa_t)89,
462         IWL_UCODE_TLV_CAPA_CSI_REPORTING                = (__force iwl_ucode_tlv_capa_t)90,
463
464         /* set 3 */
465         IWL_UCODE_TLV_CAPA_MLME_OFFLOAD                 = (__force iwl_ucode_tlv_capa_t)96,
466
467         NUM_IWL_UCODE_TLV_CAPA
468 #ifdef __CHECKER__
469                 /* sparse says it cannot increment the previous enum member */
470                 = 128
471 #endif
472 };
473
474 /* The default calibrate table size if not specified by firmware file */
475 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
476 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
477 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
478
479 /* The default max probe length if not specified by the firmware file */
480 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
481
482 /*
483  * For 16.0 uCode and above, there is no differentiation between sections,
484  * just an offset to the HW address.
485  */
486 #define CPU1_CPU2_SEPARATOR_SECTION     0xFFFFCCCC
487 #define PAGING_SEPARATOR_SECTION        0xAAAABBBB
488
489 /* uCode version contains 4 values: Major/Minor/API/Serial */
490 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
491 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
492 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
493 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
494
495 /**
496  * struct iwl_tlv_calib_ctrl - Calibration control struct.
497  * Sent as part of the phy configuration command.
498  * @flow_trigger: bitmap for which calibrations to perform according to
499  *              flow triggers.
500  * @event_trigger: bitmap for which calibrations to perform according to
501  *              event triggers.
502  */
503 struct iwl_tlv_calib_ctrl {
504         __le32 flow_trigger;
505         __le32 event_trigger;
506 } __packed;
507
508 enum iwl_fw_phy_cfg {
509         FW_PHY_CFG_RADIO_TYPE_POS = 0,
510         FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
511         FW_PHY_CFG_RADIO_STEP_POS = 2,
512         FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
513         FW_PHY_CFG_RADIO_DASH_POS = 4,
514         FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
515         FW_PHY_CFG_TX_CHAIN_POS = 16,
516         FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
517         FW_PHY_CFG_RX_CHAIN_POS = 20,
518         FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
519         FW_PHY_CFG_SHARED_CLK = BIT(31),
520 };
521
522 #define IWL_UCODE_MAX_CS                1
523
524 /**
525  * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
526  * @cipher: a cipher suite selector
527  * @flags: cipher scheme flags (currently reserved for a future use)
528  * @hdr_len: a size of MPDU security header
529  * @pn_len: a size of PN
530  * @pn_off: an offset of pn from the beginning of the security header
531  * @key_idx_off: an offset of key index byte in the security header
532  * @key_idx_mask: a bit mask of key_idx bits
533  * @key_idx_shift: bit shift needed to get key_idx
534  * @mic_len: mic length in bytes
535  * @hw_cipher: a HW cipher index used in host commands
536  */
537 struct iwl_fw_cipher_scheme {
538         __le32 cipher;
539         u8 flags;
540         u8 hdr_len;
541         u8 pn_len;
542         u8 pn_off;
543         u8 key_idx_off;
544         u8 key_idx_mask;
545         u8 key_idx_shift;
546         u8 mic_len;
547         u8 hw_cipher;
548 } __packed;
549
550 enum iwl_fw_dbg_reg_operator {
551         CSR_ASSIGN,
552         CSR_SETBIT,
553         CSR_CLEARBIT,
554
555         PRPH_ASSIGN,
556         PRPH_SETBIT,
557         PRPH_CLEARBIT,
558
559         INDIRECT_ASSIGN,
560         INDIRECT_SETBIT,
561         INDIRECT_CLEARBIT,
562
563         PRPH_BLOCKBIT,
564 };
565
566 /**
567  * struct iwl_fw_dbg_reg_op - an operation on a register
568  *
569  * @op: &enum iwl_fw_dbg_reg_operator
570  * @addr: offset of the register
571  * @val: value
572  */
573 struct iwl_fw_dbg_reg_op {
574         u8 op;
575         u8 reserved[3];
576         __le32 addr;
577         __le32 val;
578 } __packed;
579
580 /**
581  * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
582  *
583  * @SMEM_MODE: monitor stores the data in SMEM
584  * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
585  * @MARBH_MODE: monitor stores the data in MARBH buffer
586  * @MIPI_MODE: monitor outputs the data through the MIPI interface
587  */
588 enum iwl_fw_dbg_monitor_mode {
589         SMEM_MODE = 0,
590         EXTERNAL_MODE = 1,
591         MARBH_MODE = 2,
592         MIPI_MODE = 3,
593 };
594
595 /**
596  * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
597  *
598  * @data_type: the memory segment type to record
599  * @ofs: the memory segment offset
600  * @len: the memory segment length, in bytes
601  *
602  * This parses IWL_UCODE_TLV_FW_MEM_SEG
603  */
604 struct iwl_fw_dbg_mem_seg_tlv {
605         __le32 data_type;
606         __le32 ofs;
607         __le32 len;
608 } __packed;
609
610 /**
611  * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
612  *
613  * @version: version of the TLV - currently 0
614  * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
615  * @size_power: buffer size will be 2^(size_power + 11)
616  * @base_reg: addr of the base addr register (PRPH)
617  * @end_reg:  addr of the end addr register (PRPH)
618  * @write_ptr_reg: the addr of the reg of the write pointer
619  * @wrap_count: the addr of the reg of the wrap_count
620  * @base_shift: shift right of the base addr reg
621  * @end_shift: shift right of the end addr reg
622  * @reg_ops: array of registers operations
623  *
624  * This parses IWL_UCODE_TLV_FW_DBG_DEST
625  */
626 struct iwl_fw_dbg_dest_tlv_v1 {
627         u8 version;
628         u8 monitor_mode;
629         u8 size_power;
630         u8 reserved;
631         __le32 base_reg;
632         __le32 end_reg;
633         __le32 write_ptr_reg;
634         __le32 wrap_count;
635         u8 base_shift;
636         u8 end_shift;
637         struct iwl_fw_dbg_reg_op reg_ops[0];
638 } __packed;
639
640 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
641 #define IWL_LDBG_M2S_BUF_SIZE_MSK       0x0fff0000
642 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
643 #define IWL_LDBG_M2S_BUF_BA_MSK         0x00000fff
644 /* The smem buffer chunks are in units of 256 bits */
645 #define IWL_M2S_UNIT_SIZE                       0x100
646
647 struct iwl_fw_dbg_dest_tlv {
648         u8 version;
649         u8 monitor_mode;
650         u8 size_power;
651         u8 reserved;
652         __le32 cfg_reg;
653         __le32 write_ptr_reg;
654         __le32 wrap_count;
655         u8 base_shift;
656         u8 size_shift;
657         struct iwl_fw_dbg_reg_op reg_ops[0];
658 } __packed;
659
660 struct iwl_fw_dbg_conf_hcmd {
661         u8 id;
662         u8 reserved;
663         __le16 len;
664         u8 data[0];
665 } __packed;
666
667 /**
668  * enum iwl_fw_dbg_trigger_mode - triggers functionalities
669  *
670  * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
671  * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
672  * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
673  *      collect only monitor data
674  */
675 enum iwl_fw_dbg_trigger_mode {
676         IWL_FW_DBG_TRIGGER_START = BIT(0),
677         IWL_FW_DBG_TRIGGER_STOP = BIT(1),
678         IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
679 };
680
681 /**
682  * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers
683  * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart
684  */
685 enum iwl_fw_dbg_trigger_flags {
686         IWL_FW_DBG_FORCE_RESTART = BIT(0),
687 };
688
689 /**
690  * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
691  * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
692  * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
693  * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
694  * @IWL_FW_DBG_CONF_VIF_AP: AP mode
695  * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
696  * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
697  * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
698  */
699 enum iwl_fw_dbg_trigger_vif_type {
700         IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
701         IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
702         IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
703         IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
704         IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
705         IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
706         IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
707 };
708
709 /**
710  * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
711  * @id: &enum iwl_fw_dbg_trigger
712  * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
713  * @stop_conf_ids: bitmap of configurations this trigger relates to.
714  *      if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
715  *      to the currently running configuration is set, the data should be
716  *      collected.
717  * @stop_delay: how many milliseconds to wait before collecting the data
718  *      after the STOP trigger fires.
719  * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
720  * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
721  *      configuration should be applied when the triggers kicks in.
722  * @occurrences: number of occurrences. 0 means the trigger will never fire.
723  * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
724  *      trigger in which another occurrence should be ignored.
725  * @flags: &enum iwl_fw_dbg_trigger_flags
726  */
727 struct iwl_fw_dbg_trigger_tlv {
728         __le32 id;
729         __le32 vif_type;
730         __le32 stop_conf_ids;
731         __le32 stop_delay;
732         u8 mode;
733         u8 start_conf_id;
734         __le16 occurrences;
735         __le16 trig_dis_ms;
736         u8 flags;
737         u8 reserved[5];
738
739         u8 data[0];
740 } __packed;
741
742 #define FW_DBG_START_FROM_ALIVE 0
743 #define FW_DBG_CONF_MAX         32
744 #define FW_DBG_INVALID          0xff
745
746 /**
747  * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
748  * @stop_consec_missed_bcon: stop recording if threshold is crossed.
749  * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
750  * @start_consec_missed_bcon: start recording if threshold is crossed.
751  * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
752  * @reserved1: reserved
753  * @reserved2: reserved
754  */
755 struct iwl_fw_dbg_trigger_missed_bcon {
756         __le32 stop_consec_missed_bcon;
757         __le32 stop_consec_missed_bcon_since_rx;
758         __le32 reserved2[2];
759         __le32 start_consec_missed_bcon;
760         __le32 start_consec_missed_bcon_since_rx;
761         __le32 reserved1[2];
762 } __packed;
763
764 /**
765  * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
766  * cmds: the list of commands to trigger the collection on
767  */
768 struct iwl_fw_dbg_trigger_cmd {
769         struct cmd {
770                 u8 cmd_id;
771                 u8 group_id;
772         } __packed cmds[16];
773 } __packed;
774
775 /**
776  * iwl_fw_dbg_trigger_stats - configures trigger for statistics
777  * @stop_offset: the offset of the value to be monitored
778  * @stop_threshold: the threshold above which to collect
779  * @start_offset: the offset of the value to be monitored
780  * @start_threshold: the threshold above which to start recording
781  */
782 struct iwl_fw_dbg_trigger_stats {
783         __le32 stop_offset;
784         __le32 stop_threshold;
785         __le32 start_offset;
786         __le32 start_threshold;
787 } __packed;
788
789 /**
790  * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
791  * @rssi: RSSI value to trigger at
792  */
793 struct iwl_fw_dbg_trigger_low_rssi {
794         __le32 rssi;
795 } __packed;
796
797 /**
798  * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
799  * @stop_auth_denied: number of denied authentication to collect
800  * @stop_auth_timeout: number of authentication timeout to collect
801  * @stop_rx_deauth: number of Rx deauth before to collect
802  * @stop_tx_deauth: number of Tx deauth before to collect
803  * @stop_assoc_denied: number of denied association to collect
804  * @stop_assoc_timeout: number of association timeout to collect
805  * @stop_connection_loss: number of connection loss to collect
806  * @start_auth_denied: number of denied authentication to start recording
807  * @start_auth_timeout: number of authentication timeout to start recording
808  * @start_rx_deauth: number of Rx deauth to start recording
809  * @start_tx_deauth: number of Tx deauth to start recording
810  * @start_assoc_denied: number of denied association to start recording
811  * @start_assoc_timeout: number of association timeout to start recording
812  * @start_connection_loss: number of connection loss to start recording
813  */
814 struct iwl_fw_dbg_trigger_mlme {
815         u8 stop_auth_denied;
816         u8 stop_auth_timeout;
817         u8 stop_rx_deauth;
818         u8 stop_tx_deauth;
819
820         u8 stop_assoc_denied;
821         u8 stop_assoc_timeout;
822         u8 stop_connection_loss;
823         u8 reserved;
824
825         u8 start_auth_denied;
826         u8 start_auth_timeout;
827         u8 start_rx_deauth;
828         u8 start_tx_deauth;
829
830         u8 start_assoc_denied;
831         u8 start_assoc_timeout;
832         u8 start_connection_loss;
833         u8 reserved2;
834 } __packed;
835
836 /**
837  * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
838  * @command_queue: timeout for the command queue in ms
839  * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
840  * @softap: timeout for the queues of a softAP in ms
841  * @p2p_go: timeout for the queues of a P2P GO in ms
842  * @p2p_client: timeout for the queues of a P2P client in ms
843  * @p2p_device: timeout for the queues of a P2P device in ms
844  * @ibss: timeout for the queues of an IBSS in ms
845  * @tdls: timeout for the queues of a TDLS station in ms
846  */
847 struct iwl_fw_dbg_trigger_txq_timer {
848         __le32 command_queue;
849         __le32 bss;
850         __le32 softap;
851         __le32 p2p_go;
852         __le32 p2p_client;
853         __le32 p2p_device;
854         __le32 ibss;
855         __le32 tdls;
856         __le32 reserved[4];
857 } __packed;
858
859 /**
860  * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
861  * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
862  *      trigger each time a time event notification that relates to time event
863  *      id with one of the actions in the bitmap is received and
864  *      BIT(notif->status) is set in status_bitmap.
865  *
866  */
867 struct iwl_fw_dbg_trigger_time_event {
868         struct {
869                 __le32 id;
870                 __le32 action_bitmap;
871                 __le32 status_bitmap;
872         } __packed time_events[16];
873 } __packed;
874
875 /**
876  * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
877  * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
878  *      when an Rx BlockAck session is started.
879  * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
880  *      when an Rx BlockAck session is stopped.
881  * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
882  *      when a Tx BlockAck session is started.
883  * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
884  *      when a Tx BlockAck session is stopped.
885  * rx_bar: tid bitmap to configure on what tid the trigger should occur
886  *      when a BAR is received (for a Tx BlockAck session).
887  * tx_bar: tid bitmap to configure on what tid the trigger should occur
888  *      when a BAR is send (for an Rx BlocAck session).
889  * frame_timeout: tid bitmap to configure on what tid the trigger should occur
890  *      when a frame times out in the reodering buffer.
891  */
892 struct iwl_fw_dbg_trigger_ba {
893         __le16 rx_ba_start;
894         __le16 rx_ba_stop;
895         __le16 tx_ba_start;
896         __le16 tx_ba_stop;
897         __le16 rx_bar;
898         __le16 tx_bar;
899         __le16 frame_timeout;
900 } __packed;
901
902 /**
903  * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
904  * @action_bitmap: the TDLS action to trigger the collection upon
905  * @peer_mode: trigger on specific peer or all
906  * @peer: the TDLS peer to trigger the collection on
907  */
908 struct iwl_fw_dbg_trigger_tdls {
909         u8 action_bitmap;
910         u8 peer_mode;
911         u8 peer[ETH_ALEN];
912         u8 reserved[4];
913 } __packed;
914
915 /**
916  * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
917  *  status.
918  * @statuses: the list of statuses to trigger the collection on
919  */
920 struct iwl_fw_dbg_trigger_tx_status {
921         struct tx_status {
922                 u8 status;
923                 u8 reserved[3];
924         } __packed statuses[16];
925         __le32 reserved[2];
926 } __packed;
927
928 /**
929  * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
930  * @id: conf id
931  * @usniffer: should the uSniffer image be used
932  * @num_of_hcmds: how many HCMDs to send are present here
933  * @hcmd: a variable length host command to be sent to apply the configuration.
934  *      If there is more than one HCMD to send, they will appear one after the
935  *      other and be sent in the order that they appear in.
936  * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
937  * %FW_DBG_CONF_MAX configuration per run.
938  */
939 struct iwl_fw_dbg_conf_tlv {
940         u8 id;
941         u8 usniffer;
942         u8 reserved;
943         u8 num_of_hcmds;
944         struct iwl_fw_dbg_conf_hcmd hcmd;
945 } __packed;
946
947 #define IWL_FW_CMD_VER_UNKNOWN 99
948
949 /**
950  * struct iwl_fw_cmd_version - firmware command version entry
951  * @cmd: command ID
952  * @group: group ID
953  * @cmd_ver: command version
954  * @notif_ver: notification version
955  */
956 struct iwl_fw_cmd_version {
957         u8 cmd;
958         u8 group;
959         u8 cmd_ver;
960         u8 notif_ver;
961 } __packed;
962
963 #endif  /* __iwl_fw_file_h__ */