887f6d8fc8a7c65915334af1d3ee9b002ea115ce
[sfrench/cifs-2.6.git] / drivers / net / wireless / intel / iwlwifi / 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_UAPSD_SUPPORT: This uCode image supports uAPSD
203  * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
204  *      offload profile config command.
205  * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
206  *      (rather than two) IPv6 addresses
207  * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
208  *      from the probe request template.
209  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
210  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
211  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
212  * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
213  * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
214  * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
215  */
216 enum iwl_ucode_tlv_flag {
217         IWL_UCODE_TLV_FLAGS_PAN                 = BIT(0),
218         IWL_UCODE_TLV_FLAGS_NEWSCAN             = BIT(1),
219         IWL_UCODE_TLV_FLAGS_MFP                 = BIT(2),
220         IWL_UCODE_TLV_FLAGS_SHORT_BL            = BIT(7),
221         IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS     = BIT(10),
222         IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID       = BIT(12),
223         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL    = BIT(15),
224         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE    = BIT(16),
225         IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT       = BIT(24),
226         IWL_UCODE_TLV_FLAGS_EBS_SUPPORT         = BIT(25),
227         IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD        = BIT(26),
228         IWL_UCODE_TLV_FLAGS_BCAST_FILTERING     = BIT(29),
229 };
230
231 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
232
233 /**
234  * enum iwl_ucode_tlv_api - ucode api
235  * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
236  *      longer than the passive one, which is essential for fragmented scan.
237  * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
238  * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
239  * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
240  * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
241  *      iteration complete notification, and the timestamp reported for RX
242  *      received during scan, are reported in TSF of the mac specified in the
243  *      scan request.
244  * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
245  *      ADD_MODIFY_STA_KEY_API_S_VER_2.
246  * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
247  * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
248  * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
249  * @IWL_UCODE_TLV_API_ATS_COEX_EXTERNAL: the coex notification is enlared to
250  *      include information about ACL time sharing.
251  *
252  * @NUM_IWL_UCODE_TLV_API: number of bits used
253  */
254 enum iwl_ucode_tlv_api {
255         /* API Set 0 */
256         IWL_UCODE_TLV_API_FRAGMENTED_SCAN       = (__force iwl_ucode_tlv_api_t)8,
257         IWL_UCODE_TLV_API_WIFI_MCC_UPDATE       = (__force iwl_ucode_tlv_api_t)9,
258         IWL_UCODE_TLV_API_LQ_SS_PARAMS          = (__force iwl_ucode_tlv_api_t)18,
259         IWL_UCODE_TLV_API_NEW_VERSION           = (__force iwl_ucode_tlv_api_t)20,
260         IWL_UCODE_TLV_API_SCAN_TSF_REPORT       = (__force iwl_ucode_tlv_api_t)28,
261         IWL_UCODE_TLV_API_TKIP_MIC_KEYS         = (__force iwl_ucode_tlv_api_t)29,
262         IWL_UCODE_TLV_API_STA_TYPE              = (__force iwl_ucode_tlv_api_t)30,
263         IWL_UCODE_TLV_API_NAN2_VER2             = (__force iwl_ucode_tlv_api_t)31,
264         /* API Set 1 */
265         IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE   = (__force iwl_ucode_tlv_api_t)34,
266         IWL_UCODE_TLV_API_NEW_RX_STATS          = (__force iwl_ucode_tlv_api_t)35,
267         IWL_UCODE_TLV_API_COEX_ATS_EXTERNAL     = (__force iwl_ucode_tlv_api_t)37,
268
269         NUM_IWL_UCODE_TLV_API
270 #ifdef __CHECKER__
271                 /* sparse says it cannot increment the previous enum member */
272                 = 128
273 #endif
274 };
275
276 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
277
278 /**
279  * enum iwl_ucode_tlv_capa - ucode capabilities
280  * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
281  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
282  * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
283  * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
284  * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
285  * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
286  * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
287  *      tx power value into TPC Report action frame and Link Measurement Report
288  *      action frame
289  * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
290  *      channel in DS parameter set element in probe requests.
291  * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
292  *      probe requests.
293  * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
294  * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
295  *      which also implies support for the scheduler configuration command
296  * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
297  * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
298  * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
299  * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
300  * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
301  * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
302  * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
303  *      is standalone or with a BSS station interface in the same binding.
304  * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
305  * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
306  *      sources for the MCC. This TLV bit is a future replacement to
307  *      IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
308  *      is supported.
309  * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
310  * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan
311  * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
312  * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
313  * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
314  * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
315  * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
316  *      countdown offloading. Beacon notifications are not sent to the host.
317  *      The fw also offloads TBTT alignment.
318  * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
319  *      antenna the beacon should be transmitted
320  * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
321  *      from AP and will send it upon d0i3 exit.
322  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2
323  * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
324  * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
325  *      thresholds reporting
326  * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
327  * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
328  *      regular image.
329  * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
330  *      memory addresses from the firmware.
331  * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
332  * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
333  *      command size (command version 4) that supports toggling ACK TX
334  *      power reduction.
335  * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
336  *
337  * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
338  */
339 enum iwl_ucode_tlv_capa {
340         IWL_UCODE_TLV_CAPA_D0I3_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)0,
341         IWL_UCODE_TLV_CAPA_LAR_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)1,
342         IWL_UCODE_TLV_CAPA_UMAC_SCAN                    = (__force iwl_ucode_tlv_capa_t)2,
343         IWL_UCODE_TLV_CAPA_BEAMFORMER                   = (__force iwl_ucode_tlv_capa_t)3,
344         IWL_UCODE_TLV_CAPA_TOF_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)5,
345         IWL_UCODE_TLV_CAPA_TDLS_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)6,
346         IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = (__force iwl_ucode_tlv_capa_t)8,
347         IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT      = (__force iwl_ucode_tlv_capa_t)9,
348         IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT       = (__force iwl_ucode_tlv_capa_t)10,
349         IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT         = (__force iwl_ucode_tlv_capa_t)11,
350         IWL_UCODE_TLV_CAPA_DQA_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)12,
351         IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH          = (__force iwl_ucode_tlv_capa_t)13,
352         IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG            = (__force iwl_ucode_tlv_capa_t)17,
353         IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT              = (__force iwl_ucode_tlv_capa_t)18,
354         IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT         = (__force iwl_ucode_tlv_capa_t)19,
355         IWL_UCODE_TLV_CAPA_CSUM_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)21,
356         IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS           = (__force iwl_ucode_tlv_capa_t)22,
357         IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD                = (__force iwl_ucode_tlv_capa_t)26,
358         IWL_UCODE_TLV_CAPA_BT_COEX_PLCR                 = (__force iwl_ucode_tlv_capa_t)28,
359         IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC                = (__force iwl_ucode_tlv_capa_t)29,
360         IWL_UCODE_TLV_CAPA_BT_COEX_RRC                  = (__force iwl_ucode_tlv_capa_t)30,
361         IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT                = (__force iwl_ucode_tlv_capa_t)31,
362         IWL_UCODE_TLV_CAPA_STA_PM_NOTIF                 = (__force iwl_ucode_tlv_capa_t)38,
363         IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT          = (__force iwl_ucode_tlv_capa_t)39,
364         IWL_UCODE_TLV_CAPA_CDB_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)40,
365         IWL_UCODE_TLV_CAPA_D0I3_END_FIRST               = (__force iwl_ucode_tlv_capa_t)41,
366         IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE         = (__force iwl_ucode_tlv_capa_t)64,
367         IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS            = (__force iwl_ucode_tlv_capa_t)65,
368         IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT             = (__force iwl_ucode_tlv_capa_t)67,
369         IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT       = (__force iwl_ucode_tlv_capa_t)68,
370         IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD         = (__force iwl_ucode_tlv_capa_t)70,
371         IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION         = (__force iwl_ucode_tlv_capa_t)71,
372         IWL_UCODE_TLV_CAPA_BEACON_STORING               = (__force iwl_ucode_tlv_capa_t)72,
373         IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2               = (__force iwl_ucode_tlv_capa_t)73,
374         IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW                = (__force iwl_ucode_tlv_capa_t)74,
375         IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT      = (__force iwl_ucode_tlv_capa_t)75,
376         IWL_UCODE_TLV_CAPA_CTDP_SUPPORT                 = (__force iwl_ucode_tlv_capa_t)76,
377         IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED             = (__force iwl_ucode_tlv_capa_t)77,
378         IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG        = (__force iwl_ucode_tlv_capa_t)80,
379         IWL_UCODE_TLV_CAPA_LQM_SUPPORT                  = (__force iwl_ucode_tlv_capa_t)81,
380         IWL_UCODE_TLV_CAPA_TX_POWER_ACK                 = (__force iwl_ucode_tlv_capa_t)84,
381         IWL_UCODE_TLV_CAPA_MLME_OFFLOAD                 = (__force iwl_ucode_tlv_capa_t)96,
382
383         NUM_IWL_UCODE_TLV_CAPA
384 #ifdef __CHECKER__
385                 /* sparse says it cannot increment the previous enum member */
386                 = 128
387 #endif
388 };
389
390 /* The default calibrate table size if not specified by firmware file */
391 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
392 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
393 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
394
395 /* The default max probe length if not specified by the firmware file */
396 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
397
398 /*
399  * For 16.0 uCode and above, there is no differentiation between sections,
400  * just an offset to the HW address.
401  */
402 #define CPU1_CPU2_SEPARATOR_SECTION     0xFFFFCCCC
403 #define PAGING_SEPARATOR_SECTION        0xAAAABBBB
404
405 /* uCode version contains 4 values: Major/Minor/API/Serial */
406 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
407 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
408 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
409 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
410
411 /**
412  * struct iwl_tlv_calib_ctrl - Calibration control struct.
413  * Sent as part of the phy configuration command.
414  * @flow_trigger: bitmap for which calibrations to perform according to
415  *              flow triggers.
416  * @event_trigger: bitmap for which calibrations to perform according to
417  *              event triggers.
418  */
419 struct iwl_tlv_calib_ctrl {
420         __le32 flow_trigger;
421         __le32 event_trigger;
422 } __packed;
423
424 enum iwl_fw_phy_cfg {
425         FW_PHY_CFG_RADIO_TYPE_POS = 0,
426         FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
427         FW_PHY_CFG_RADIO_STEP_POS = 2,
428         FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
429         FW_PHY_CFG_RADIO_DASH_POS = 4,
430         FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
431         FW_PHY_CFG_TX_CHAIN_POS = 16,
432         FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
433         FW_PHY_CFG_RX_CHAIN_POS = 20,
434         FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
435 };
436
437 #define IWL_UCODE_MAX_CS                1
438
439 /**
440  * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
441  * @cipher: a cipher suite selector
442  * @flags: cipher scheme flags (currently reserved for a future use)
443  * @hdr_len: a size of MPDU security header
444  * @pn_len: a size of PN
445  * @pn_off: an offset of pn from the beginning of the security header
446  * @key_idx_off: an offset of key index byte in the security header
447  * @key_idx_mask: a bit mask of key_idx bits
448  * @key_idx_shift: bit shift needed to get key_idx
449  * @mic_len: mic length in bytes
450  * @hw_cipher: a HW cipher index used in host commands
451  */
452 struct iwl_fw_cipher_scheme {
453         __le32 cipher;
454         u8 flags;
455         u8 hdr_len;
456         u8 pn_len;
457         u8 pn_off;
458         u8 key_idx_off;
459         u8 key_idx_mask;
460         u8 key_idx_shift;
461         u8 mic_len;
462         u8 hw_cipher;
463 } __packed;
464
465 enum iwl_fw_dbg_reg_operator {
466         CSR_ASSIGN,
467         CSR_SETBIT,
468         CSR_CLEARBIT,
469
470         PRPH_ASSIGN,
471         PRPH_SETBIT,
472         PRPH_CLEARBIT,
473
474         INDIRECT_ASSIGN,
475         INDIRECT_SETBIT,
476         INDIRECT_CLEARBIT,
477
478         PRPH_BLOCKBIT,
479 };
480
481 /**
482  * struct iwl_fw_dbg_reg_op - an operation on a register
483  *
484  * @op: &enum iwl_fw_dbg_reg_operator
485  * @addr: offset of the register
486  * @val: value
487  */
488 struct iwl_fw_dbg_reg_op {
489         u8 op;
490         u8 reserved[3];
491         __le32 addr;
492         __le32 val;
493 } __packed;
494
495 /**
496  * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
497  *
498  * @SMEM_MODE: monitor stores the data in SMEM
499  * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
500  * @MARBH_MODE: monitor stores the data in MARBH buffer
501  * @MIPI_MODE: monitor outputs the data through the MIPI interface
502  */
503 enum iwl_fw_dbg_monitor_mode {
504         SMEM_MODE = 0,
505         EXTERNAL_MODE = 1,
506         MARBH_MODE = 2,
507         MIPI_MODE = 3,
508 };
509
510 /**
511  * enum iwl_fw_mem_seg_type - memory segment type
512  * @FW_DBG_MEM_TYPE_MASK: mask for the type indication
513  * @FW_DBG_MEM_TYPE_REGULAR: regular memory
514  * @FW_DBG_MEM_TYPE_PRPH: periphery memory (requires special reading)
515  */
516 enum iwl_fw_mem_seg_type {
517         FW_DBG_MEM_TYPE_MASK    = 0xff000000,
518         FW_DBG_MEM_TYPE_REGULAR = 0x00000000,
519         FW_DBG_MEM_TYPE_PRPH    = 0x01000000,
520 };
521
522 /**
523  * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
524  *
525  * @data_type: the memory segment type to record, see &enum iwl_fw_mem_seg_type
526  *      for what we care about
527  * @ofs: the memory segment offset
528  * @len: the memory segment length, in bytes
529  *
530  * This parses IWL_UCODE_TLV_FW_MEM_SEG
531  */
532 struct iwl_fw_dbg_mem_seg_tlv {
533         __le32 data_type;
534         __le32 ofs;
535         __le32 len;
536 } __packed;
537
538 /**
539  * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
540  *
541  * @version: version of the TLV - currently 0
542  * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
543  * @size_power: buffer size will be 2^(size_power + 11)
544  * @base_reg: addr of the base addr register (PRPH)
545  * @end_reg:  addr of the end addr register (PRPH)
546  * @write_ptr_reg: the addr of the reg of the write pointer
547  * @wrap_count: the addr of the reg of the wrap_count
548  * @base_shift: shift right of the base addr reg
549  * @end_shift: shift right of the end addr reg
550  * @reg_ops: array of registers operations
551  *
552  * This parses IWL_UCODE_TLV_FW_DBG_DEST
553  */
554 struct iwl_fw_dbg_dest_tlv {
555         u8 version;
556         u8 monitor_mode;
557         u8 size_power;
558         u8 reserved;
559         __le32 base_reg;
560         __le32 end_reg;
561         __le32 write_ptr_reg;
562         __le32 wrap_count;
563         u8 base_shift;
564         u8 end_shift;
565         struct iwl_fw_dbg_reg_op reg_ops[0];
566 } __packed;
567
568 struct iwl_fw_dbg_conf_hcmd {
569         u8 id;
570         u8 reserved;
571         __le16 len;
572         u8 data[0];
573 } __packed;
574
575 /**
576  * enum iwl_fw_dbg_trigger_mode - triggers functionalities
577  *
578  * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
579  * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
580  * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
581  *      collect only monitor data
582  */
583 enum iwl_fw_dbg_trigger_mode {
584         IWL_FW_DBG_TRIGGER_START = BIT(0),
585         IWL_FW_DBG_TRIGGER_STOP = BIT(1),
586         IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
587 };
588
589 /**
590  * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
591  * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
592  * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
593  * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
594  * @IWL_FW_DBG_CONF_VIF_AP: AP mode
595  * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
596  * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
597  * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
598  */
599 enum iwl_fw_dbg_trigger_vif_type {
600         IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
601         IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
602         IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
603         IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
604         IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
605         IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
606         IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
607 };
608
609 /**
610  * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
611  * @id: &enum iwl_fw_dbg_trigger
612  * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
613  * @stop_conf_ids: bitmap of configurations this trigger relates to.
614  *      if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
615  *      to the currently running configuration is set, the data should be
616  *      collected.
617  * @stop_delay: how many milliseconds to wait before collecting the data
618  *      after the STOP trigger fires.
619  * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
620  * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
621  *      configuration should be applied when the triggers kicks in.
622  * @occurrences: number of occurrences. 0 means the trigger will never fire.
623  * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
624  *      trigger in which another occurrence should be ignored.
625  */
626 struct iwl_fw_dbg_trigger_tlv {
627         __le32 id;
628         __le32 vif_type;
629         __le32 stop_conf_ids;
630         __le32 stop_delay;
631         u8 mode;
632         u8 start_conf_id;
633         __le16 occurrences;
634         __le16 trig_dis_ms;
635         __le16 reserved[3];
636
637         u8 data[0];
638 } __packed;
639
640 #define FW_DBG_START_FROM_ALIVE 0
641 #define FW_DBG_CONF_MAX         32
642 #define FW_DBG_INVALID          0xff
643
644 /**
645  * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
646  * @stop_consec_missed_bcon: stop recording if threshold is crossed.
647  * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
648  * @start_consec_missed_bcon: start recording if threshold is crossed.
649  * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
650  * @reserved1: reserved
651  * @reserved2: reserved
652  */
653 struct iwl_fw_dbg_trigger_missed_bcon {
654         __le32 stop_consec_missed_bcon;
655         __le32 stop_consec_missed_bcon_since_rx;
656         __le32 reserved2[2];
657         __le32 start_consec_missed_bcon;
658         __le32 start_consec_missed_bcon_since_rx;
659         __le32 reserved1[2];
660 } __packed;
661
662 /**
663  * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
664  * cmds: the list of commands to trigger the collection on
665  */
666 struct iwl_fw_dbg_trigger_cmd {
667         struct cmd {
668                 u8 cmd_id;
669                 u8 group_id;
670         } __packed cmds[16];
671 } __packed;
672
673 /**
674  * iwl_fw_dbg_trigger_stats - configures trigger for statistics
675  * @stop_offset: the offset of the value to be monitored
676  * @stop_threshold: the threshold above which to collect
677  * @start_offset: the offset of the value to be monitored
678  * @start_threshold: the threshold above which to start recording
679  */
680 struct iwl_fw_dbg_trigger_stats {
681         __le32 stop_offset;
682         __le32 stop_threshold;
683         __le32 start_offset;
684         __le32 start_threshold;
685 } __packed;
686
687 /**
688  * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
689  * @rssi: RSSI value to trigger at
690  */
691 struct iwl_fw_dbg_trigger_low_rssi {
692         __le32 rssi;
693 } __packed;
694
695 /**
696  * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
697  * @stop_auth_denied: number of denied authentication to collect
698  * @stop_auth_timeout: number of authentication timeout to collect
699  * @stop_rx_deauth: number of Rx deauth before to collect
700  * @stop_tx_deauth: number of Tx deauth before to collect
701  * @stop_assoc_denied: number of denied association to collect
702  * @stop_assoc_timeout: number of association timeout to collect
703  * @stop_connection_loss: number of connection loss to collect
704  * @start_auth_denied: number of denied authentication to start recording
705  * @start_auth_timeout: number of authentication timeout to start recording
706  * @start_rx_deauth: number of Rx deauth to start recording
707  * @start_tx_deauth: number of Tx deauth to start recording
708  * @start_assoc_denied: number of denied association to start recording
709  * @start_assoc_timeout: number of association timeout to start recording
710  * @start_connection_loss: number of connection loss to start recording
711  */
712 struct iwl_fw_dbg_trigger_mlme {
713         u8 stop_auth_denied;
714         u8 stop_auth_timeout;
715         u8 stop_rx_deauth;
716         u8 stop_tx_deauth;
717
718         u8 stop_assoc_denied;
719         u8 stop_assoc_timeout;
720         u8 stop_connection_loss;
721         u8 reserved;
722
723         u8 start_auth_denied;
724         u8 start_auth_timeout;
725         u8 start_rx_deauth;
726         u8 start_tx_deauth;
727
728         u8 start_assoc_denied;
729         u8 start_assoc_timeout;
730         u8 start_connection_loss;
731         u8 reserved2;
732 } __packed;
733
734 /**
735  * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
736  * @command_queue: timeout for the command queue in ms
737  * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
738  * @softap: timeout for the queues of a softAP in ms
739  * @p2p_go: timeout for the queues of a P2P GO in ms
740  * @p2p_client: timeout for the queues of a P2P client in ms
741  * @p2p_device: timeout for the queues of a P2P device in ms
742  * @ibss: timeout for the queues of an IBSS in ms
743  * @tdls: timeout for the queues of a TDLS station in ms
744  */
745 struct iwl_fw_dbg_trigger_txq_timer {
746         __le32 command_queue;
747         __le32 bss;
748         __le32 softap;
749         __le32 p2p_go;
750         __le32 p2p_client;
751         __le32 p2p_device;
752         __le32 ibss;
753         __le32 tdls;
754         __le32 reserved[4];
755 } __packed;
756
757 /**
758  * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
759  * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
760  *      trigger each time a time event notification that relates to time event
761  *      id with one of the actions in the bitmap is received and
762  *      BIT(notif->status) is set in status_bitmap.
763  *
764  */
765 struct iwl_fw_dbg_trigger_time_event {
766         struct {
767                 __le32 id;
768                 __le32 action_bitmap;
769                 __le32 status_bitmap;
770         } __packed time_events[16];
771 } __packed;
772
773 /**
774  * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
775  * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
776  *      when an Rx BlockAck session is started.
777  * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
778  *      when an Rx BlockAck session is stopped.
779  * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
780  *      when a Tx BlockAck session is started.
781  * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
782  *      when a Tx BlockAck session is stopped.
783  * rx_bar: tid bitmap to configure on what tid the trigger should occur
784  *      when a BAR is received (for a Tx BlockAck session).
785  * tx_bar: tid bitmap to configure on what tid the trigger should occur
786  *      when a BAR is send (for an Rx BlocAck session).
787  * frame_timeout: tid bitmap to configure on what tid the trigger should occur
788  *      when a frame times out in the reodering buffer.
789  */
790 struct iwl_fw_dbg_trigger_ba {
791         __le16 rx_ba_start;
792         __le16 rx_ba_stop;
793         __le16 tx_ba_start;
794         __le16 tx_ba_stop;
795         __le16 rx_bar;
796         __le16 tx_bar;
797         __le16 frame_timeout;
798 } __packed;
799
800 /**
801  * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
802  * @action_bitmap: the TDLS action to trigger the collection upon
803  * @peer_mode: trigger on specific peer or all
804  * @peer: the TDLS peer to trigger the collection on
805  */
806 struct iwl_fw_dbg_trigger_tdls {
807         u8 action_bitmap;
808         u8 peer_mode;
809         u8 peer[ETH_ALEN];
810         u8 reserved[4];
811 } __packed;
812
813 /**
814  * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
815  *  status.
816  * @statuses: the list of statuses to trigger the collection on
817  */
818 struct iwl_fw_dbg_trigger_tx_status {
819         struct tx_status {
820                 u8 status;
821                 u8 reserved[3];
822         } __packed statuses[16];
823         __le32 reserved[2];
824 } __packed;
825
826 /**
827  * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
828  * @id: conf id
829  * @usniffer: should the uSniffer image be used
830  * @num_of_hcmds: how many HCMDs to send are present here
831  * @hcmd: a variable length host command to be sent to apply the configuration.
832  *      If there is more than one HCMD to send, they will appear one after the
833  *      other and be sent in the order that they appear in.
834  * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
835  * %FW_DBG_CONF_MAX configuration per run.
836  */
837 struct iwl_fw_dbg_conf_tlv {
838         u8 id;
839         u8 usniffer;
840         u8 reserved;
841         u8 num_of_hcmds;
842         struct iwl_fw_dbg_conf_hcmd hcmd;
843 } __packed;
844
845 /**
846  * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
847  * @max_scan_cache_size: total space allocated for scan results (in bytes).
848  * @max_scan_buckets: maximum number of channel buckets.
849  * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
850  * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
851  * @max_scan_reporting_threshold: max possible report threshold. in percentage.
852  * @max_hotlist_aps: maximum number of entries for hotlist APs.
853  * @max_significant_change_aps: maximum number of entries for significant
854  *      change APs.
855  * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
856  *      hold.
857  * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
858  * @max_number_epno_networks: max number of epno entries.
859  * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
860  *      specified.
861  * @max_number_of_white_listed_ssid: max number of white listed SSIDs.
862  * @max_number_of_black_listed_ssid: max number of black listed SSIDs.
863  */
864 struct iwl_fw_gscan_capabilities {
865         __le32 max_scan_cache_size;
866         __le32 max_scan_buckets;
867         __le32 max_ap_cache_per_scan;
868         __le32 max_rssi_sample_size;
869         __le32 max_scan_reporting_threshold;
870         __le32 max_hotlist_aps;
871         __le32 max_significant_change_aps;
872         __le32 max_bssid_history_entries;
873         __le32 max_hotlist_ssids;
874         __le32 max_number_epno_networks;
875         __le32 max_number_epno_networks_by_ssid;
876         __le32 max_number_of_white_listed_ssid;
877         __le32 max_number_of_black_listed_ssid;
878 } __packed;
879
880 #endif  /* __iwl_fw_file_h__ */