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