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