1 /******************************************************************************
2  *
3  * This file is provided under a dual BSD/GPLv2 license.  When using or
4  * redistributing this file, you may do so under either license.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2012 - 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) 2012 - 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 
68 #ifndef __fw_api_h__
69 #define __fw_api_h__
70 
71 #include "fw-api-rs.h"
72 #include "fw-api-rx.h"
73 #include "fw-api-tx.h"
74 #include "fw-api-sta.h"
75 #include "fw-api-mac.h"
76 #include "fw-api-power.h"
77 #include "fw-api-d3.h"
78 #include "fw-api-coex.h"
79 #include "fw-api-scan.h"
80 #include "fw-api-stats.h"
81 #include "fw-api-tof.h"
82 
83 /* Tx queue numbers for non-DQA mode */
84 enum {
85 	IWL_MVM_OFFCHANNEL_QUEUE = 8,
86 	IWL_MVM_CMD_QUEUE = 9,
87 };
88 
89 /*
90  * DQA queue numbers
91  *
92  * @IWL_MVM_DQA_CMD_QUEUE: a queue reserved for sending HCMDs to the FW
93  * @IWL_MVM_DQA_AUX_QUEUE: a queue reserved for aux frames
94  * @IWL_MVM_DQA_P2P_DEVICE_QUEUE: a queue reserved for P2P device frames
95  * @IWL_MVM_DQA_GCAST_QUEUE: a queue reserved for P2P GO/SoftAP GCAST frames
96  * @IWL_MVM_DQA_BSS_CLIENT_QUEUE: a queue reserved for BSS activity, to ensure
97  *	that we are never left without the possibility to connect to an AP.
98  * @IWL_MVM_DQA_MIN_MGMT_QUEUE: first TXQ in pool for MGMT and non-QOS frames.
99  *	Each MGMT queue is mapped to a single STA
100  *	MGMT frames are frames that return true on ieee80211_is_mgmt()
101  * @IWL_MVM_DQA_MAX_MGMT_QUEUE: last TXQ in pool for MGMT frames
102  * @IWL_MVM_DQA_AP_PROBE_RESP_QUEUE: a queue reserved for P2P GO/SoftAP probe
103  *	responses
104  * @IWL_MVM_DQA_MIN_DATA_QUEUE: first TXQ in pool for DATA frames.
105  *	DATA frames are intended for !ieee80211_is_mgmt() frames, but if
106  *	the MGMT TXQ pool is exhausted, mgmt frames can be sent on DATA queues
107  *	as well
108  * @IWL_MVM_DQA_MAX_DATA_QUEUE: last TXQ in pool for DATA frames
109  */
110 enum iwl_mvm_dqa_txq {
111 	IWL_MVM_DQA_CMD_QUEUE = 0,
112 	IWL_MVM_DQA_AUX_QUEUE = 1,
113 	IWL_MVM_DQA_P2P_DEVICE_QUEUE = 2,
114 	IWL_MVM_DQA_GCAST_QUEUE = 3,
115 	IWL_MVM_DQA_BSS_CLIENT_QUEUE = 4,
116 	IWL_MVM_DQA_MIN_MGMT_QUEUE = 5,
117 	IWL_MVM_DQA_MAX_MGMT_QUEUE = 8,
118 	IWL_MVM_DQA_AP_PROBE_RESP_QUEUE = 9,
119 	IWL_MVM_DQA_MIN_DATA_QUEUE = 10,
120 	IWL_MVM_DQA_MAX_DATA_QUEUE = 31,
121 };
122 
123 enum iwl_mvm_tx_fifo {
124 	IWL_MVM_TX_FIFO_BK = 0,
125 	IWL_MVM_TX_FIFO_BE,
126 	IWL_MVM_TX_FIFO_VI,
127 	IWL_MVM_TX_FIFO_VO,
128 	IWL_MVM_TX_FIFO_MCAST = 5,
129 	IWL_MVM_TX_FIFO_CMD = 7,
130 };
131 
132 
133 /* commands */
134 enum {
135 	MVM_ALIVE = 0x1,
136 	REPLY_ERROR = 0x2,
137 	ECHO_CMD = 0x3,
138 
139 	INIT_COMPLETE_NOTIF = 0x4,
140 
141 	/* PHY context commands */
142 	PHY_CONTEXT_CMD = 0x8,
143 	DBG_CFG = 0x9,
144 	ANTENNA_COUPLING_NOTIFICATION = 0xa,
145 
146 	/* UMAC scan commands */
147 	SCAN_ITERATION_COMPLETE_UMAC = 0xb5,
148 	SCAN_CFG_CMD = 0xc,
149 	SCAN_REQ_UMAC = 0xd,
150 	SCAN_ABORT_UMAC = 0xe,
151 	SCAN_COMPLETE_UMAC = 0xf,
152 
153 	BA_WINDOW_STATUS_NOTIFICATION_ID = 0x13,
154 
155 	/* station table */
156 	ADD_STA_KEY = 0x17,
157 	ADD_STA = 0x18,
158 	REMOVE_STA = 0x19,
159 
160 	/* paging get item */
161 	FW_GET_ITEM_CMD = 0x1a,
162 
163 	/* TX */
164 	TX_CMD = 0x1c,
165 	TXPATH_FLUSH = 0x1e,
166 	MGMT_MCAST_KEY = 0x1f,
167 
168 	/* scheduler config */
169 	SCD_QUEUE_CFG = 0x1d,
170 
171 	/* global key */
172 	WEP_KEY = 0x20,
173 
174 	/* Memory */
175 	SHARED_MEM_CFG = 0x25,
176 
177 	/* TDLS */
178 	TDLS_CHANNEL_SWITCH_CMD = 0x27,
179 	TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
180 	TDLS_CONFIG_CMD = 0xa7,
181 
182 	/* MAC and Binding commands */
183 	MAC_CONTEXT_CMD = 0x28,
184 	TIME_EVENT_CMD = 0x29, /* both CMD and response */
185 	TIME_EVENT_NOTIFICATION = 0x2a,
186 	BINDING_CONTEXT_CMD = 0x2b,
187 	TIME_QUOTA_CMD = 0x2c,
188 	NON_QOS_TX_COUNTER_CMD = 0x2d,
189 
190 	LQ_CMD = 0x4e,
191 
192 	/* paging block to FW cpu2 */
193 	FW_PAGING_BLOCK_CMD = 0x4f,
194 
195 	/* Scan offload */
196 	SCAN_OFFLOAD_REQUEST_CMD = 0x51,
197 	SCAN_OFFLOAD_ABORT_CMD = 0x52,
198 	HOT_SPOT_CMD = 0x53,
199 	SCAN_OFFLOAD_COMPLETE = 0x6D,
200 	SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
201 	SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
202 	MATCH_FOUND_NOTIFICATION = 0xd9,
203 	SCAN_ITERATION_COMPLETE = 0xe7,
204 
205 	/* Phy */
206 	PHY_CONFIGURATION_CMD = 0x6a,
207 	CALIB_RES_NOTIF_PHY_DB = 0x6b,
208 	PHY_DB_CMD = 0x6c,
209 
210 	/* ToF - 802.11mc FTM */
211 	TOF_CMD = 0x10,
212 	TOF_NOTIFICATION = 0x11,
213 
214 	/* Power - legacy power table command */
215 	POWER_TABLE_CMD = 0x77,
216 	PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
217 	LTR_CONFIG = 0xee,
218 
219 	/* Thermal Throttling*/
220 	REPLY_THERMAL_MNG_BACKOFF = 0x7e,
221 
222 	/* Set/Get DC2DC frequency tune */
223 	DC2DC_CONFIG_CMD = 0x83,
224 
225 	/* NVM */
226 	NVM_ACCESS_CMD = 0x88,
227 
228 	SET_CALIB_DEFAULT_CMD = 0x8e,
229 
230 	BEACON_NOTIFICATION = 0x90,
231 	BEACON_TEMPLATE_CMD = 0x91,
232 	TX_ANT_CONFIGURATION_CMD = 0x98,
233 	STATISTICS_CMD = 0x9c,
234 	STATISTICS_NOTIFICATION = 0x9d,
235 	EOSP_NOTIFICATION = 0x9e,
236 	REDUCE_TX_POWER_CMD = 0x9f,
237 
238 	/* RF-KILL commands and notifications */
239 	CARD_STATE_CMD = 0xa0,
240 	CARD_STATE_NOTIFICATION = 0xa1,
241 
242 	MISSED_BEACONS_NOTIFICATION = 0xa2,
243 
244 	/* Power - new power table command */
245 	MAC_PM_POWER_TABLE = 0xa9,
246 
247 	MFUART_LOAD_NOTIFICATION = 0xb1,
248 
249 	RSS_CONFIG_CMD = 0xb3,
250 
251 	REPLY_RX_PHY_CMD = 0xc0,
252 	REPLY_RX_MPDU_CMD = 0xc1,
253 	FRAME_RELEASE = 0xc3,
254 	BA_NOTIF = 0xc5,
255 
256 	/* Location Aware Regulatory */
257 	MCC_UPDATE_CMD = 0xc8,
258 	MCC_CHUB_UPDATE_CMD = 0xc9,
259 
260 	MARKER_CMD = 0xcb,
261 
262 	/* BT Coex */
263 	BT_COEX_PRIO_TABLE = 0xcc,
264 	BT_COEX_PROT_ENV = 0xcd,
265 	BT_PROFILE_NOTIFICATION = 0xce,
266 	BT_CONFIG = 0x9b,
267 	BT_COEX_UPDATE_SW_BOOST = 0x5a,
268 	BT_COEX_UPDATE_CORUN_LUT = 0x5b,
269 	BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
270 	BT_COEX_CI = 0x5d,
271 
272 	REPLY_SF_CFG_CMD = 0xd1,
273 	REPLY_BEACON_FILTERING_CMD = 0xd2,
274 
275 	/* DTS measurements */
276 	CMD_DTS_MEASUREMENT_TRIGGER = 0xdc,
277 	DTS_MEASUREMENT_NOTIFICATION = 0xdd,
278 
279 	REPLY_DEBUG_CMD = 0xf0,
280 	LDBG_CONFIG_CMD = 0xf6,
281 	DEBUG_LOG_MSG = 0xf7,
282 
283 	BCAST_FILTER_CMD = 0xcf,
284 	MCAST_FILTER_CMD = 0xd0,
285 
286 	/* D3 commands/notifications */
287 	D3_CONFIG_CMD = 0xd3,
288 	PROT_OFFLOAD_CONFIG_CMD = 0xd4,
289 	OFFLOADS_QUERY_CMD = 0xd5,
290 	REMOTE_WAKE_CONFIG_CMD = 0xd6,
291 	D0I3_END_CMD = 0xed,
292 
293 	/* for WoWLAN in particular */
294 	WOWLAN_PATTERNS = 0xe0,
295 	WOWLAN_CONFIGURATION = 0xe1,
296 	WOWLAN_TSC_RSC_PARAM = 0xe2,
297 	WOWLAN_TKIP_PARAM = 0xe3,
298 	WOWLAN_KEK_KCK_MATERIAL = 0xe4,
299 	WOWLAN_GET_STATUSES = 0xe5,
300 	WOWLAN_TX_POWER_PER_DB = 0xe6,
301 
302 	/* and for NetDetect */
303 	SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
304 	SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58,
305 	SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59,
306 
307 	REPLY_MAX = 0xff,
308 };
309 
310 /* Please keep this enum *SORTED* by hex value.
311  * Needed for binary search, otherwise a warning will be triggered.
312  */
313 enum iwl_mac_conf_subcmd_ids {
314 	LINK_QUALITY_MEASUREMENT_CMD = 0x1,
315 	LINK_QUALITY_MEASUREMENT_COMPLETE_NOTIF = 0xFE,
316 	CHANNEL_SWITCH_NOA_NOTIF = 0xFF,
317 };
318 
319 enum iwl_phy_ops_subcmd_ids {
320 	CMD_DTS_MEASUREMENT_TRIGGER_WIDE = 0x0,
321 	CTDP_CONFIG_CMD = 0x03,
322 	TEMP_REPORTING_THRESHOLDS_CMD = 0x04,
323 	CT_KILL_NOTIFICATION = 0xFE,
324 	DTS_MEASUREMENT_NOTIF_WIDE = 0xFF,
325 };
326 
327 enum iwl_system_subcmd_ids {
328 	SHARED_MEM_CFG_CMD = 0x0,
329 };
330 
331 enum iwl_data_path_subcmd_ids {
332 	DQA_ENABLE_CMD = 0x0,
333 	UPDATE_MU_GROUPS_CMD = 0x1,
334 	TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
335 	STA_PM_NOTIF = 0xFD,
336 	MU_GROUP_MGMT_NOTIF = 0xFE,
337 	RX_QUEUES_NOTIFICATION = 0xFF,
338 };
339 
340 enum iwl_prot_offload_subcmd_ids {
341 	STORED_BEACON_NTF = 0xFF,
342 };
343 
344 enum iwl_regulatory_and_nvm_subcmd_ids {
345 	NVM_ACCESS_COMPLETE = 0x0,
346 };
347 
348 enum iwl_fmac_debug_cmds {
349 	LMAC_RD_WR = 0x0,
350 	UMAC_RD_WR = 0x1,
351 };
352 
353 /* command groups */
354 enum {
355 	LEGACY_GROUP = 0x0,
356 	LONG_GROUP = 0x1,
357 	SYSTEM_GROUP = 0x2,
358 	MAC_CONF_GROUP = 0x3,
359 	PHY_OPS_GROUP = 0x4,
360 	DATA_PATH_GROUP = 0x5,
361 	PROT_OFFLOAD_GROUP = 0xb,
362 	REGULATORY_AND_NVM_GROUP = 0xc,
363 	DEBUG_GROUP = 0xf,
364 };
365 
366 /**
367  * struct iwl_cmd_response - generic response struct for most commands
368  * @status: status of the command asked, changes for each one
369  */
370 struct iwl_cmd_response {
371 	__le32 status;
372 };
373 
374 /*
375  * struct iwl_dqa_enable_cmd
376  * @cmd_queue: the TXQ number of the command queue
377  */
378 struct iwl_dqa_enable_cmd {
379 	__le32 cmd_queue;
380 } __packed; /* DQA_CONTROL_CMD_API_S_VER_1 */
381 
382 /*
383  * struct iwl_tx_ant_cfg_cmd
384  * @valid: valid antenna configuration
385  */
386 struct iwl_tx_ant_cfg_cmd {
387 	__le32 valid;
388 } __packed;
389 
390 /*
391  * Calibration control struct.
392  * Sent as part of the phy configuration command.
393  * @flow_trigger: bitmap for which calibrations to perform according to
394  *		flow triggers.
395  * @event_trigger: bitmap for which calibrations to perform according to
396  *		event triggers.
397  */
398 struct iwl_calib_ctrl {
399 	__le32 flow_trigger;
400 	__le32 event_trigger;
401 } __packed;
402 
403 /* This enum defines the bitmap of various calibrations to enable in both
404  * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
405  */
406 enum iwl_calib_cfg {
407 	IWL_CALIB_CFG_XTAL_IDX			= BIT(0),
408 	IWL_CALIB_CFG_TEMPERATURE_IDX		= BIT(1),
409 	IWL_CALIB_CFG_VOLTAGE_READ_IDX		= BIT(2),
410 	IWL_CALIB_CFG_PAPD_IDX			= BIT(3),
411 	IWL_CALIB_CFG_TX_PWR_IDX		= BIT(4),
412 	IWL_CALIB_CFG_DC_IDX			= BIT(5),
413 	IWL_CALIB_CFG_BB_FILTER_IDX		= BIT(6),
414 	IWL_CALIB_CFG_LO_LEAKAGE_IDX		= BIT(7),
415 	IWL_CALIB_CFG_TX_IQ_IDX			= BIT(8),
416 	IWL_CALIB_CFG_TX_IQ_SKEW_IDX		= BIT(9),
417 	IWL_CALIB_CFG_RX_IQ_IDX			= BIT(10),
418 	IWL_CALIB_CFG_RX_IQ_SKEW_IDX		= BIT(11),
419 	IWL_CALIB_CFG_SENSITIVITY_IDX		= BIT(12),
420 	IWL_CALIB_CFG_CHAIN_NOISE_IDX		= BIT(13),
421 	IWL_CALIB_CFG_DISCONNECTED_ANT_IDX	= BIT(14),
422 	IWL_CALIB_CFG_ANT_COUPLING_IDX		= BIT(15),
423 	IWL_CALIB_CFG_DAC_IDX			= BIT(16),
424 	IWL_CALIB_CFG_ABS_IDX			= BIT(17),
425 	IWL_CALIB_CFG_AGC_IDX			= BIT(18),
426 };
427 
428 /*
429  * Phy configuration command.
430  */
431 struct iwl_phy_cfg_cmd {
432 	__le32	phy_cfg;
433 	struct iwl_calib_ctrl calib_control;
434 } __packed;
435 
436 #define PHY_CFG_RADIO_TYPE	(BIT(0) | BIT(1))
437 #define PHY_CFG_RADIO_STEP	(BIT(2) | BIT(3))
438 #define PHY_CFG_RADIO_DASH	(BIT(4) | BIT(5))
439 #define PHY_CFG_PRODUCT_NUMBER	(BIT(6) | BIT(7))
440 #define PHY_CFG_TX_CHAIN_A	BIT(8)
441 #define PHY_CFG_TX_CHAIN_B	BIT(9)
442 #define PHY_CFG_TX_CHAIN_C	BIT(10)
443 #define PHY_CFG_RX_CHAIN_A	BIT(12)
444 #define PHY_CFG_RX_CHAIN_B	BIT(13)
445 #define PHY_CFG_RX_CHAIN_C	BIT(14)
446 
447 
448 /* Target of the NVM_ACCESS_CMD */
449 enum {
450 	NVM_ACCESS_TARGET_CACHE = 0,
451 	NVM_ACCESS_TARGET_OTP = 1,
452 	NVM_ACCESS_TARGET_EEPROM = 2,
453 };
454 
455 /* Section types for NVM_ACCESS_CMD */
456 enum {
457 	NVM_SECTION_TYPE_SW = 1,
458 	NVM_SECTION_TYPE_REGULATORY = 3,
459 	NVM_SECTION_TYPE_CALIBRATION = 4,
460 	NVM_SECTION_TYPE_PRODUCTION = 5,
461 	NVM_SECTION_TYPE_MAC_OVERRIDE = 11,
462 	NVM_SECTION_TYPE_PHY_SKU = 12,
463 	NVM_MAX_NUM_SECTIONS = 13,
464 };
465 
466 /**
467  * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
468  * @op_code: 0 - read, 1 - write
469  * @target: NVM_ACCESS_TARGET_*
470  * @type: NVM_SECTION_TYPE_*
471  * @offset: offset in bytes into the section
472  * @length: in bytes, to read/write
473  * @data: if write operation, the data to write. On read its empty
474  */
475 struct iwl_nvm_access_cmd {
476 	u8 op_code;
477 	u8 target;
478 	__le16 type;
479 	__le16 offset;
480 	__le16 length;
481 	u8 data[];
482 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
483 
484 #define NUM_OF_FW_PAGING_BLOCKS	33 /* 32 for data and 1 block for CSS */
485 
486 /*
487  * struct iwl_fw_paging_cmd - paging layout
488  *
489  * (FW_PAGING_BLOCK_CMD = 0x4f)
490  *
491  * Send to FW the paging layout in the driver.
492  *
493  * @flags: various flags for the command
494  * @block_size: the block size in powers of 2
495  * @block_num: number of blocks specified in the command.
496  * @device_phy_addr: virtual addresses from device side
497  *	32 bit address for API version 1, 64 bit address for API version 2.
498 */
499 struct iwl_fw_paging_cmd {
500 	__le32 flags;
501 	__le32 block_size;
502 	__le32 block_num;
503 	union {
504 		__le32 addr32[NUM_OF_FW_PAGING_BLOCKS];
505 		__le64 addr64[NUM_OF_FW_PAGING_BLOCKS];
506 	} device_phy_addr;
507 } __packed; /* FW_PAGING_BLOCK_CMD_API_S_VER_2 */
508 
509 /*
510  * Fw items ID's
511  *
512  * @IWL_FW_ITEM_ID_PAGING: Address of the pages that the FW will upload
513  *	download
514  */
515 enum iwl_fw_item_id {
516 	IWL_FW_ITEM_ID_PAGING = 3,
517 };
518 
519 /*
520  * struct iwl_fw_get_item_cmd - get an item from the fw
521  */
522 struct iwl_fw_get_item_cmd {
523 	__le32 item_id;
524 } __packed; /* FW_GET_ITEM_CMD_API_S_VER_1 */
525 
526 #define CONT_REC_COMMAND_SIZE	80
527 #define ENABLE_CONT_RECORDING	0x15
528 #define DISABLE_CONT_RECORDING	0x16
529 
530 /*
531  * struct iwl_continuous_record_mode - recording mode
532  */
533 struct iwl_continuous_record_mode {
534 	__le16 enable_recording;
535 } __packed;
536 
537 /*
538  * struct iwl_continuous_record_cmd - enable/disable continuous recording
539  */
540 struct iwl_continuous_record_cmd {
541 	struct iwl_continuous_record_mode record_mode;
542 	u8 pad[CONT_REC_COMMAND_SIZE -
543 		sizeof(struct iwl_continuous_record_mode)];
544 } __packed;
545 
546 struct iwl_fw_get_item_resp {
547 	__le32 item_id;
548 	__le32 item_byte_cnt;
549 	__le32 item_val;
550 } __packed; /* FW_GET_ITEM_RSP_S_VER_1 */
551 
552 /**
553  * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
554  * @offset: offset in bytes into the section
555  * @length: in bytes, either how much was written or read
556  * @type: NVM_SECTION_TYPE_*
557  * @status: 0 for success, fail otherwise
558  * @data: if read operation, the data returned. Empty on write.
559  */
560 struct iwl_nvm_access_resp {
561 	__le16 offset;
562 	__le16 length;
563 	__le16 type;
564 	__le16 status;
565 	u8 data[];
566 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
567 
568 /* MVM_ALIVE 0x1 */
569 
570 /* alive response is_valid values */
571 #define ALIVE_RESP_UCODE_OK	BIT(0)
572 #define ALIVE_RESP_RFKILL	BIT(1)
573 
574 /* alive response ver_type values */
575 enum {
576 	FW_TYPE_HW = 0,
577 	FW_TYPE_PROT = 1,
578 	FW_TYPE_AP = 2,
579 	FW_TYPE_WOWLAN = 3,
580 	FW_TYPE_TIMING = 4,
581 	FW_TYPE_WIPAN = 5
582 };
583 
584 /* alive response ver_subtype values */
585 enum {
586 	FW_SUBTYPE_FULL_FEATURE = 0,
587 	FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
588 	FW_SUBTYPE_REDUCED = 2,
589 	FW_SUBTYPE_ALIVE_ONLY = 3,
590 	FW_SUBTYPE_WOWLAN = 4,
591 	FW_SUBTYPE_AP_SUBTYPE = 5,
592 	FW_SUBTYPE_WIPAN = 6,
593 	FW_SUBTYPE_INITIALIZE = 9
594 };
595 
596 #define IWL_ALIVE_STATUS_ERR 0xDEAD
597 #define IWL_ALIVE_STATUS_OK 0xCAFE
598 
599 #define IWL_ALIVE_FLG_RFKILL	BIT(0)
600 
601 struct iwl_lmac_alive {
602 	__le32 ucode_minor;
603 	__le32 ucode_major;
604 	u8 ver_subtype;
605 	u8 ver_type;
606 	u8 mac;
607 	u8 opt;
608 	__le32 timestamp;
609 	__le32 error_event_table_ptr;	/* SRAM address for error log */
610 	__le32 log_event_table_ptr;	/* SRAM address for LMAC event log */
611 	__le32 cpu_register_ptr;
612 	__le32 dbgm_config_ptr;
613 	__le32 alive_counter_ptr;
614 	__le32 scd_base_ptr;		/* SRAM address for SCD */
615 	__le32 st_fwrd_addr;		/* pointer to Store and forward */
616 	__le32 st_fwrd_size;
617 } __packed; /* UCODE_ALIVE_NTFY_API_S_VER_3 */
618 
619 struct iwl_umac_alive {
620 	__le32 umac_minor;		/* UMAC version: minor */
621 	__le32 umac_major;		/* UMAC version: major */
622 	__le32 error_info_addr;		/* SRAM address for UMAC error log */
623 	__le32 dbg_print_buff_addr;
624 } __packed; /* UMAC_ALIVE_DATA_API_S_VER_2 */
625 
626 struct mvm_alive_resp_v3 {
627 	__le16 status;
628 	__le16 flags;
629 	struct iwl_lmac_alive lmac_data;
630 	struct iwl_umac_alive umac_data;
631 } __packed; /* ALIVE_RES_API_S_VER_3 */
632 
633 struct mvm_alive_resp {
634 	__le16 status;
635 	__le16 flags;
636 	struct iwl_lmac_alive lmac_data[2];
637 	struct iwl_umac_alive umac_data;
638 } __packed; /* ALIVE_RES_API_S_VER_4 */
639 
640 /* Error response/notification */
641 enum {
642 	FW_ERR_UNKNOWN_CMD = 0x0,
643 	FW_ERR_INVALID_CMD_PARAM = 0x1,
644 	FW_ERR_SERVICE = 0x2,
645 	FW_ERR_ARC_MEMORY = 0x3,
646 	FW_ERR_ARC_CODE = 0x4,
647 	FW_ERR_WATCH_DOG = 0x5,
648 	FW_ERR_WEP_GRP_KEY_INDX = 0x10,
649 	FW_ERR_WEP_KEY_SIZE = 0x11,
650 	FW_ERR_OBSOLETE_FUNC = 0x12,
651 	FW_ERR_UNEXPECTED = 0xFE,
652 	FW_ERR_FATAL = 0xFF
653 };
654 
655 /**
656  * struct iwl_error_resp - FW error indication
657  * ( REPLY_ERROR = 0x2 )
658  * @error_type: one of FW_ERR_*
659  * @cmd_id: the command ID for which the error occured
660  * @bad_cmd_seq_num: sequence number of the erroneous command
661  * @error_service: which service created the error, applicable only if
662  *	error_type = 2, otherwise 0
663  * @timestamp: TSF in usecs.
664  */
665 struct iwl_error_resp {
666 	__le32 error_type;
667 	u8 cmd_id;
668 	u8 reserved1;
669 	__le16 bad_cmd_seq_num;
670 	__le32 error_service;
671 	__le64 timestamp;
672 } __packed;
673 
674 
675 /* Common PHY, MAC and Bindings definitions */
676 
677 #define MAX_MACS_IN_BINDING	(3)
678 #define MAX_BINDINGS		(4)
679 #define AUX_BINDING_INDEX	(3)
680 
681 /* Used to extract ID and color from the context dword */
682 #define FW_CTXT_ID_POS	  (0)
683 #define FW_CTXT_ID_MSK	  (0xff << FW_CTXT_ID_POS)
684 #define FW_CTXT_COLOR_POS (8)
685 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
686 #define FW_CTXT_INVALID	  (0xffffffff)
687 
688 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
689 					  (_color << FW_CTXT_COLOR_POS))
690 
691 /* Possible actions on PHYs, MACs and Bindings */
692 enum {
693 	FW_CTXT_ACTION_STUB = 0,
694 	FW_CTXT_ACTION_ADD,
695 	FW_CTXT_ACTION_MODIFY,
696 	FW_CTXT_ACTION_REMOVE,
697 	FW_CTXT_ACTION_NUM
698 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
699 
700 /* Time Events */
701 
702 /* Time Event types, according to MAC type */
703 enum iwl_time_event_type {
704 	/* BSS Station Events */
705 	TE_BSS_STA_AGGRESSIVE_ASSOC,
706 	TE_BSS_STA_ASSOC,
707 	TE_BSS_EAP_DHCP_PROT,
708 	TE_BSS_QUIET_PERIOD,
709 
710 	/* P2P Device Events */
711 	TE_P2P_DEVICE_DISCOVERABLE,
712 	TE_P2P_DEVICE_LISTEN,
713 	TE_P2P_DEVICE_ACTION_SCAN,
714 	TE_P2P_DEVICE_FULL_SCAN,
715 
716 	/* P2P Client Events */
717 	TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
718 	TE_P2P_CLIENT_ASSOC,
719 	TE_P2P_CLIENT_QUIET_PERIOD,
720 
721 	/* P2P GO Events */
722 	TE_P2P_GO_ASSOC_PROT,
723 	TE_P2P_GO_REPETITIVET_NOA,
724 	TE_P2P_GO_CT_WINDOW,
725 
726 	/* WiDi Sync Events */
727 	TE_WIDI_TX_SYNC,
728 
729 	/* Channel Switch NoA */
730 	TE_CHANNEL_SWITCH_PERIOD,
731 
732 	TE_MAX
733 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
734 
735 
736 
737 /* Time event - defines for command API v1 */
738 
739 /*
740  * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
741  * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
742  *	the first fragment is scheduled.
743  * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
744  *	the first 2 fragments are scheduled.
745  * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
746  *	number of fragments are valid.
747  *
748  * Other than the constant defined above, specifying a fragmentation value 'x'
749  * means that the event can be fragmented but only the first 'x' will be
750  * scheduled.
751  */
752 enum {
753 	TE_V1_FRAG_NONE = 0,
754 	TE_V1_FRAG_SINGLE = 1,
755 	TE_V1_FRAG_DUAL = 2,
756 	TE_V1_FRAG_ENDLESS = 0xffffffff
757 };
758 
759 /* If a Time Event can be fragmented, this is the max number of fragments */
760 #define TE_V1_FRAG_MAX_MSK	0x0fffffff
761 /* Repeat the time event endlessly (until removed) */
762 #define TE_V1_REPEAT_ENDLESS	0xffffffff
763 /* If a Time Event has bounded repetitions, this is the maximal value */
764 #define TE_V1_REPEAT_MAX_MSK_V1	0x0fffffff
765 
766 /* Time Event dependencies: none, on another TE, or in a specific time */
767 enum {
768 	TE_V1_INDEPENDENT		= 0,
769 	TE_V1_DEP_OTHER			= BIT(0),
770 	TE_V1_DEP_TSF			= BIT(1),
771 	TE_V1_EVENT_SOCIOPATHIC		= BIT(2),
772 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
773 
774 /*
775  * @TE_V1_NOTIF_NONE: no notifications
776  * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
777  * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
778  * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
779  * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
780  * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
781  * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
782  * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
783  * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
784  *
785  * Supported Time event notifications configuration.
786  * A notification (both event and fragment) includes a status indicating weather
787  * the FW was able to schedule the event or not. For fragment start/end
788  * notification the status is always success. There is no start/end fragment
789  * notification for monolithic events.
790  */
791 enum {
792 	TE_V1_NOTIF_NONE = 0,
793 	TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
794 	TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
795 	TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
796 	TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
797 	TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
798 	TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
799 	TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
800 	TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
801 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
802 
803 /* Time event - defines for command API */
804 
805 /*
806  * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
807  * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
808  *  the first fragment is scheduled.
809  * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
810  *  the first 2 fragments are scheduled.
811  * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
812  *  number of fragments are valid.
813  *
814  * Other than the constant defined above, specifying a fragmentation value 'x'
815  * means that the event can be fragmented but only the first 'x' will be
816  * scheduled.
817  */
818 enum {
819 	TE_V2_FRAG_NONE = 0,
820 	TE_V2_FRAG_SINGLE = 1,
821 	TE_V2_FRAG_DUAL = 2,
822 	TE_V2_FRAG_MAX = 0xfe,
823 	TE_V2_FRAG_ENDLESS = 0xff
824 };
825 
826 /* Repeat the time event endlessly (until removed) */
827 #define TE_V2_REPEAT_ENDLESS	0xff
828 /* If a Time Event has bounded repetitions, this is the maximal value */
829 #define TE_V2_REPEAT_MAX	0xfe
830 
831 #define TE_V2_PLACEMENT_POS	12
832 #define TE_V2_ABSENCE_POS	15
833 
834 /* Time event policy values
835  * A notification (both event and fragment) includes a status indicating weather
836  * the FW was able to schedule the event or not. For fragment start/end
837  * notification the status is always success. There is no start/end fragment
838  * notification for monolithic events.
839  *
840  * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
841  * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
842  * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
843  * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
844  * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
845  * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
846  * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
847  * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
848  * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
849  * @TE_V2_DEP_OTHER: depends on another time event
850  * @TE_V2_DEP_TSF: depends on a specific time
851  * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
852  * @TE_V2_ABSENCE: are we present or absent during the Time Event.
853  */
854 enum {
855 	TE_V2_DEFAULT_POLICY = 0x0,
856 
857 	/* notifications (event start/stop, fragment start/stop) */
858 	TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
859 	TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
860 	TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
861 	TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
862 
863 	TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
864 	TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
865 	TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
866 	TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
867 	T2_V2_START_IMMEDIATELY = BIT(11),
868 
869 	TE_V2_NOTIF_MSK = 0xff,
870 
871 	/* placement characteristics */
872 	TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
873 	TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
874 	TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
875 
876 	/* are we present or absent during the Time Event. */
877 	TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
878 };
879 
880 /**
881  * struct iwl_time_event_cmd_api - configuring Time Events
882  * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
883  * with version 1. determined by IWL_UCODE_TLV_FLAGS)
884  * ( TIME_EVENT_CMD = 0x29 )
885  * @id_and_color: ID and color of the relevant MAC
886  * @action: action to perform, one of FW_CTXT_ACTION_*
887  * @id: this field has two meanings, depending on the action:
888  *	If the action is ADD, then it means the type of event to add.
889  *	For all other actions it is the unique event ID assigned when the
890  *	event was added by the FW.
891  * @apply_time: When to start the Time Event (in GP2)
892  * @max_delay: maximum delay to event's start (apply time), in TU
893  * @depends_on: the unique ID of the event we depend on (if any)
894  * @interval: interval between repetitions, in TU
895  * @duration: duration of event in TU
896  * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
897  * @max_frags: maximal number of fragments the Time Event can be divided to
898  * @policy: defines whether uCode shall notify the host or other uCode modules
899  *	on event and/or fragment start and/or end
900  *	using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
901  *	TE_EVENT_SOCIOPATHIC
902  *	using TE_ABSENCE and using TE_NOTIF_*
903  */
904 struct iwl_time_event_cmd {
905 	/* COMMON_INDEX_HDR_API_S_VER_1 */
906 	__le32 id_and_color;
907 	__le32 action;
908 	__le32 id;
909 	/* MAC_TIME_EVENT_DATA_API_S_VER_2 */
910 	__le32 apply_time;
911 	__le32 max_delay;
912 	__le32 depends_on;
913 	__le32 interval;
914 	__le32 duration;
915 	u8 repeat;
916 	u8 max_frags;
917 	__le16 policy;
918 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
919 
920 /**
921  * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
922  * @status: bit 0 indicates success, all others specify errors
923  * @id: the Time Event type
924  * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
925  * @id_and_color: ID and color of the relevant MAC
926  */
927 struct iwl_time_event_resp {
928 	__le32 status;
929 	__le32 id;
930 	__le32 unique_id;
931 	__le32 id_and_color;
932 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
933 
934 /**
935  * struct iwl_time_event_notif - notifications of time event start/stop
936  * ( TIME_EVENT_NOTIFICATION = 0x2a )
937  * @timestamp: action timestamp in GP2
938  * @session_id: session's unique id
939  * @unique_id: unique id of the Time Event itself
940  * @id_and_color: ID and color of the relevant MAC
941  * @action: one of TE_NOTIF_START or TE_NOTIF_END
942  * @status: true if scheduled, false otherwise (not executed)
943  */
944 struct iwl_time_event_notif {
945 	__le32 timestamp;
946 	__le32 session_id;
947 	__le32 unique_id;
948 	__le32 id_and_color;
949 	__le32 action;
950 	__le32 status;
951 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
952 
953 
954 /* Bindings and Time Quota */
955 
956 /**
957  * struct iwl_binding_cmd - configuring bindings
958  * ( BINDING_CONTEXT_CMD = 0x2b )
959  * @id_and_color: ID and color of the relevant Binding
960  * @action: action to perform, one of FW_CTXT_ACTION_*
961  * @macs: array of MAC id and colors which belong to the binding
962  * @phy: PHY id and color which belongs to the binding
963  */
964 struct iwl_binding_cmd {
965 	/* COMMON_INDEX_HDR_API_S_VER_1 */
966 	__le32 id_and_color;
967 	__le32 action;
968 	/* BINDING_DATA_API_S_VER_1 */
969 	__le32 macs[MAX_MACS_IN_BINDING];
970 	__le32 phy;
971 } __packed; /* BINDING_CMD_API_S_VER_1 */
972 
973 /* The maximal number of fragments in the FW's schedule session */
974 #define IWL_MVM_MAX_QUOTA 128
975 
976 /**
977  * struct iwl_time_quota_data - configuration of time quota per binding
978  * @id_and_color: ID and color of the relevant Binding
979  * @quota: absolute time quota in TU. The scheduler will try to divide the
980  *	remainig quota (after Time Events) according to this quota.
981  * @max_duration: max uninterrupted context duration in TU
982  */
983 struct iwl_time_quota_data {
984 	__le32 id_and_color;
985 	__le32 quota;
986 	__le32 max_duration;
987 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
988 
989 /**
990  * struct iwl_time_quota_cmd - configuration of time quota between bindings
991  * ( TIME_QUOTA_CMD = 0x2c )
992  * @quotas: allocations per binding
993  */
994 struct iwl_time_quota_cmd {
995 	struct iwl_time_quota_data quotas[MAX_BINDINGS];
996 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
997 
998 
999 /* PHY context */
1000 
1001 /* Supported bands */
1002 #define PHY_BAND_5  (0)
1003 #define PHY_BAND_24 (1)
1004 
1005 /* Supported channel width, vary if there is VHT support */
1006 #define PHY_VHT_CHANNEL_MODE20	(0x0)
1007 #define PHY_VHT_CHANNEL_MODE40	(0x1)
1008 #define PHY_VHT_CHANNEL_MODE80	(0x2)
1009 #define PHY_VHT_CHANNEL_MODE160	(0x3)
1010 
1011 /*
1012  * Control channel position:
1013  * For legacy set bit means upper channel, otherwise lower.
1014  * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
1015  *   bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
1016  *                                   center_freq
1017  *                                        |
1018  * 40Mhz                          |_______|_______|
1019  * 80Mhz                  |_______|_______|_______|_______|
1020  * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
1021  * code      011     010     001     000  |  100     101     110    111
1022  */
1023 #define PHY_VHT_CTRL_POS_1_BELOW  (0x0)
1024 #define PHY_VHT_CTRL_POS_2_BELOW  (0x1)
1025 #define PHY_VHT_CTRL_POS_3_BELOW  (0x2)
1026 #define PHY_VHT_CTRL_POS_4_BELOW  (0x3)
1027 #define PHY_VHT_CTRL_POS_1_ABOVE  (0x4)
1028 #define PHY_VHT_CTRL_POS_2_ABOVE  (0x5)
1029 #define PHY_VHT_CTRL_POS_3_ABOVE  (0x6)
1030 #define PHY_VHT_CTRL_POS_4_ABOVE  (0x7)
1031 
1032 /*
1033  * @band: PHY_BAND_*
1034  * @channel: channel number
1035  * @width: PHY_[VHT|LEGACY]_CHANNEL_*
1036  * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
1037  */
1038 struct iwl_fw_channel_info {
1039 	u8 band;
1040 	u8 channel;
1041 	u8 width;
1042 	u8 ctrl_pos;
1043 } __packed;
1044 
1045 #define PHY_RX_CHAIN_DRIVER_FORCE_POS	(0)
1046 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
1047 	(0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
1048 #define PHY_RX_CHAIN_VALID_POS		(1)
1049 #define PHY_RX_CHAIN_VALID_MSK \
1050 	(0x7 << PHY_RX_CHAIN_VALID_POS)
1051 #define PHY_RX_CHAIN_FORCE_SEL_POS	(4)
1052 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
1053 	(0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
1054 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS	(7)
1055 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
1056 	(0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
1057 #define PHY_RX_CHAIN_CNT_POS		(10)
1058 #define PHY_RX_CHAIN_CNT_MSK \
1059 	(0x3 << PHY_RX_CHAIN_CNT_POS)
1060 #define PHY_RX_CHAIN_MIMO_CNT_POS	(12)
1061 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
1062 	(0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
1063 #define PHY_RX_CHAIN_MIMO_FORCE_POS	(14)
1064 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
1065 	(0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
1066 
1067 /* TODO: fix the value, make it depend on firmware at runtime? */
1068 #define NUM_PHY_CTX	3
1069 
1070 /* TODO: complete missing documentation */
1071 /**
1072  * struct iwl_phy_context_cmd - config of the PHY context
1073  * ( PHY_CONTEXT_CMD = 0x8 )
1074  * @id_and_color: ID and color of the relevant Binding
1075  * @action: action to perform, one of FW_CTXT_ACTION_*
1076  * @apply_time: 0 means immediate apply and context switch.
1077  *	other value means apply new params after X usecs
1078  * @tx_param_color: ???
1079  * @channel_info:
1080  * @txchain_info: ???
1081  * @rxchain_info: ???
1082  * @acquisition_data: ???
1083  * @dsp_cfg_flags: set to 0
1084  */
1085 struct iwl_phy_context_cmd {
1086 	/* COMMON_INDEX_HDR_API_S_VER_1 */
1087 	__le32 id_and_color;
1088 	__le32 action;
1089 	/* PHY_CONTEXT_DATA_API_S_VER_1 */
1090 	__le32 apply_time;
1091 	__le32 tx_param_color;
1092 	struct iwl_fw_channel_info ci;
1093 	__le32 txchain_info;
1094 	__le32 rxchain_info;
1095 	__le32 acquisition_data;
1096 	__le32 dsp_cfg_flags;
1097 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
1098 
1099 /*
1100  * Aux ROC command
1101  *
1102  * Command requests the firmware to create a time event for a certain duration
1103  * and remain on the given channel. This is done by using the Aux framework in
1104  * the FW.
1105  * The command was first used for Hot Spot issues - but can be used regardless
1106  * to Hot Spot.
1107  *
1108  * ( HOT_SPOT_CMD 0x53 )
1109  *
1110  * @id_and_color: ID and color of the MAC
1111  * @action: action to perform, one of FW_CTXT_ACTION_*
1112  * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
1113  *	event_unique_id should be the id of the time event assigned by ucode.
1114  *	Otherwise ignore the event_unique_id.
1115  * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
1116  *	activity.
1117  * @channel_info: channel info
1118  * @node_addr: Our MAC Address
1119  * @reserved: reserved for alignment
1120  * @apply_time: GP2 value to start (should always be the current GP2 value)
1121  * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
1122  *	time by which start of the event is allowed to be postponed.
1123  * @duration: event duration in TU To calculate event duration:
1124  *	timeEventDuration = min(duration, remainingQuota)
1125  */
1126 struct iwl_hs20_roc_req {
1127 	/* COMMON_INDEX_HDR_API_S_VER_1 hdr */
1128 	__le32 id_and_color;
1129 	__le32 action;
1130 	__le32 event_unique_id;
1131 	__le32 sta_id_and_color;
1132 	struct iwl_fw_channel_info channel_info;
1133 	u8 node_addr[ETH_ALEN];
1134 	__le16 reserved;
1135 	__le32 apply_time;
1136 	__le32 apply_time_max_delay;
1137 	__le32 duration;
1138 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */
1139 
1140 /*
1141  * values for AUX ROC result values
1142  */
1143 enum iwl_mvm_hot_spot {
1144 	HOT_SPOT_RSP_STATUS_OK,
1145 	HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS,
1146 	HOT_SPOT_MAX_NUM_OF_SESSIONS,
1147 };
1148 
1149 /*
1150  * Aux ROC command response
1151  *
1152  * In response to iwl_hs20_roc_req the FW sends this command to notify the
1153  * driver the uid of the timevent.
1154  *
1155  * ( HOT_SPOT_CMD 0x53 )
1156  *
1157  * @event_unique_id: Unique ID of time event assigned by ucode
1158  * @status: Return status 0 is success, all the rest used for specific errors
1159  */
1160 struct iwl_hs20_roc_res {
1161 	__le32 event_unique_id;
1162 	__le32 status;
1163 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */
1164 
1165 /**
1166  * struct iwl_radio_version_notif - information on the radio version
1167  * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1168  * @radio_flavor:
1169  * @radio_step:
1170  * @radio_dash:
1171  */
1172 struct iwl_radio_version_notif {
1173 	__le32 radio_flavor;
1174 	__le32 radio_step;
1175 	__le32 radio_dash;
1176 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1177 
1178 enum iwl_card_state_flags {
1179 	CARD_ENABLED		= 0x00,
1180 	HW_CARD_DISABLED	= 0x01,
1181 	SW_CARD_DISABLED	= 0x02,
1182 	CT_KILL_CARD_DISABLED	= 0x04,
1183 	HALT_CARD_DISABLED	= 0x08,
1184 	CARD_DISABLED_MSK	= 0x0f,
1185 	CARD_IS_RX_ON		= 0x10,
1186 };
1187 
1188 /**
1189  * struct iwl_radio_version_notif - information on the radio version
1190  * ( CARD_STATE_NOTIFICATION = 0xa1 )
1191  * @flags: %iwl_card_state_flags
1192  */
1193 struct iwl_card_state_notif {
1194 	__le32 flags;
1195 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1196 
1197 /**
1198  * struct iwl_missed_beacons_notif - information on missed beacons
1199  * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1200  * @mac_id: interface ID
1201  * @consec_missed_beacons_since_last_rx: number of consecutive missed
1202  *	beacons since last RX.
1203  * @consec_missed_beacons: number of consecutive missed beacons
1204  * @num_expected_beacons:
1205  * @num_recvd_beacons:
1206  */
1207 struct iwl_missed_beacons_notif {
1208 	__le32 mac_id;
1209 	__le32 consec_missed_beacons_since_last_rx;
1210 	__le32 consec_missed_beacons;
1211 	__le32 num_expected_beacons;
1212 	__le32 num_recvd_beacons;
1213 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1214 
1215 /**
1216  * struct iwl_mfuart_load_notif - mfuart image version & status
1217  * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1218  * @installed_ver: installed image version
1219  * @external_ver: external image version
1220  * @status: MFUART loading status
1221  * @duration: MFUART loading time
1222  * @image_size: MFUART image size in bytes
1223 */
1224 struct iwl_mfuart_load_notif {
1225 	__le32 installed_ver;
1226 	__le32 external_ver;
1227 	__le32 status;
1228 	__le32 duration;
1229 	/* image size valid only in v2 of the command */
1230 	__le32 image_size;
1231 } __packed; /*MFU_LOADER_NTFY_API_S_VER_2*/
1232 
1233 /**
1234  * struct iwl_set_calib_default_cmd - set default value for calibration.
1235  * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1236  * @calib_index: the calibration to set value for
1237  * @length: of data
1238  * @data: the value to set for the calibration result
1239  */
1240 struct iwl_set_calib_default_cmd {
1241 	__le16 calib_index;
1242 	__le16 length;
1243 	u8 data[0];
1244 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1245 
1246 #define MAX_PORT_ID_NUM	2
1247 #define MAX_MCAST_FILTERING_ADDRESSES 256
1248 
1249 /**
1250  * struct iwl_mcast_filter_cmd - configure multicast filter.
1251  * @filter_own: Set 1 to filter out multicast packets sent by station itself
1252  * @port_id:	Multicast MAC addresses array specifier. This is a strange way
1253  *		to identify network interface adopted in host-device IF.
1254  *		It is used by FW as index in array of addresses. This array has
1255  *		MAX_PORT_ID_NUM members.
1256  * @count:	Number of MAC addresses in the array
1257  * @pass_all:	Set 1 to pass all multicast packets.
1258  * @bssid:	current association BSSID.
1259  * @addr_list:	Place holder for array of MAC addresses.
1260  *		IMPORTANT: add padding if necessary to ensure DWORD alignment.
1261  */
1262 struct iwl_mcast_filter_cmd {
1263 	u8 filter_own;
1264 	u8 port_id;
1265 	u8 count;
1266 	u8 pass_all;
1267 	u8 bssid[6];
1268 	u8 reserved[2];
1269 	u8 addr_list[0];
1270 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1271 
1272 #define MAX_BCAST_FILTERS 8
1273 #define MAX_BCAST_FILTER_ATTRS 2
1274 
1275 /**
1276  * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1277  * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1278  * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1279  *	start of ip payload).
1280  */
1281 enum iwl_mvm_bcast_filter_attr_offset {
1282 	BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1283 	BCAST_FILTER_OFFSET_IP_END = 1,
1284 };
1285 
1286 /**
1287  * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1288  * @offset_type:	&enum iwl_mvm_bcast_filter_attr_offset.
1289  * @offset:	starting offset of this pattern.
1290  * @val:		value to match - big endian (MSB is the first
1291  *		byte to match from offset pos).
1292  * @mask:	mask to match (big endian).
1293  */
1294 struct iwl_fw_bcast_filter_attr {
1295 	u8 offset_type;
1296 	u8 offset;
1297 	__le16 reserved1;
1298 	__be32 val;
1299 	__be32 mask;
1300 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1301 
1302 /**
1303  * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1304  * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1305  * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1306  */
1307 enum iwl_mvm_bcast_filter_frame_type {
1308 	BCAST_FILTER_FRAME_TYPE_ALL = 0,
1309 	BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1310 };
1311 
1312 /**
1313  * struct iwl_fw_bcast_filter - broadcast filter
1314  * @discard: discard frame (1) or let it pass (0).
1315  * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1316  * @num_attrs: number of valid attributes in this filter.
1317  * @attrs: attributes of this filter. a filter is considered matched
1318  *	only when all its attributes are matched (i.e. AND relationship)
1319  */
1320 struct iwl_fw_bcast_filter {
1321 	u8 discard;
1322 	u8 frame_type;
1323 	u8 num_attrs;
1324 	u8 reserved1;
1325 	struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1326 } __packed; /* BCAST_FILTER_S_VER_1 */
1327 
1328 #define BA_WINDOW_STREAMS_MAX		16
1329 #define BA_WINDOW_STATUS_TID_MSK	0x000F
1330 #define BA_WINDOW_STATUS_STA_ID_POS	4
1331 #define BA_WINDOW_STATUS_STA_ID_MSK	0x01F0
1332 #define BA_WINDOW_STATUS_VALID_MSK	BIT(9)
1333 
1334 /**
1335  * struct iwl_ba_window_status_notif - reordering window's status notification
1336  * @bitmap: bitmap of received frames [start_seq_num + 0]..[start_seq_num + 63]
1337  * @ra_tid: bit 3:0 - TID, bit 8:4 - STA_ID, bit 9 - valid
1338  * @start_seq_num: the start sequence number of the bitmap
1339  * @mpdu_rx_count: the number of received MPDUs since entering D0i3
1340  */
1341 struct iwl_ba_window_status_notif {
1342 	__le64 bitmap[BA_WINDOW_STREAMS_MAX];
1343 	__le16 ra_tid[BA_WINDOW_STREAMS_MAX];
1344 	__le32 start_seq_num[BA_WINDOW_STREAMS_MAX];
1345 	__le16 mpdu_rx_count[BA_WINDOW_STREAMS_MAX];
1346 } __packed; /* BA_WINDOW_STATUS_NTFY_API_S_VER_1 */
1347 
1348 /**
1349  * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1350  * @default_discard: default action for this mac (discard (1) / pass (0)).
1351  * @attached_filters: bitmap of relevant filters for this mac.
1352  */
1353 struct iwl_fw_bcast_mac {
1354 	u8 default_discard;
1355 	u8 reserved1;
1356 	__le16 attached_filters;
1357 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1358 
1359 /**
1360  * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1361  * @disable: enable (0) / disable (1)
1362  * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1363  * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1364  * @filters: broadcast filters
1365  * @macs: broadcast filtering configuration per-mac
1366  */
1367 struct iwl_bcast_filter_cmd {
1368 	u8 disable;
1369 	u8 max_bcast_filters;
1370 	u8 max_macs;
1371 	u8 reserved1;
1372 	struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1373 	struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1374 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1375 
1376 /*
1377  * enum iwl_mvm_marker_id - maker ids
1378  *
1379  * The ids for different type of markers to insert into the usniffer logs
1380  */
1381 enum iwl_mvm_marker_id {
1382 	MARKER_ID_TX_FRAME_LATENCY = 1,
1383 }; /* MARKER_ID_API_E_VER_1 */
1384 
1385 /**
1386  * struct iwl_mvm_marker - mark info into the usniffer logs
1387  *
1388  * (MARKER_CMD = 0xcb)
1389  *
1390  * Mark the UTC time stamp into the usniffer logs together with additional
1391  * metadata, so the usniffer output can be parsed.
1392  * In the command response the ucode will return the GP2 time.
1393  *
1394  * @dw_len: The amount of dwords following this byte including this byte.
1395  * @marker_id: A unique marker id (iwl_mvm_marker_id).
1396  * @reserved: reserved.
1397  * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1398  * @metadata: additional meta data that will be written to the unsiffer log
1399  */
1400 struct iwl_mvm_marker {
1401 	u8 dwLen;
1402 	u8 markerId;
1403 	__le16 reserved;
1404 	__le64 timestamp;
1405 	__le32 metadata[0];
1406 } __packed; /* MARKER_API_S_VER_1 */
1407 
1408 /*
1409  * enum iwl_dc2dc_config_id - flag ids
1410  *
1411  * Ids of dc2dc configuration flags
1412  */
1413 enum iwl_dc2dc_config_id {
1414 	DCDC_LOW_POWER_MODE_MSK_SET  = 0x1, /* not used */
1415 	DCDC_FREQ_TUNE_SET = 0x2,
1416 }; /* MARKER_ID_API_E_VER_1 */
1417 
1418 /**
1419  * struct iwl_dc2dc_config_cmd - configure dc2dc values
1420  *
1421  * (DC2DC_CONFIG_CMD = 0x83)
1422  *
1423  * Set/Get & configure dc2dc values.
1424  * The command always returns the current dc2dc values.
1425  *
1426  * @flags: set/get dc2dc
1427  * @enable_low_power_mode: not used.
1428  * @dc2dc_freq_tune0: frequency divider - digital domain
1429  * @dc2dc_freq_tune1: frequency divider - analog domain
1430  */
1431 struct iwl_dc2dc_config_cmd {
1432 	__le32 flags;
1433 	__le32 enable_low_power_mode; /* not used */
1434 	__le32 dc2dc_freq_tune0;
1435 	__le32 dc2dc_freq_tune1;
1436 } __packed; /* DC2DC_CONFIG_CMD_API_S_VER_1 */
1437 
1438 /**
1439  * struct iwl_dc2dc_config_resp - response for iwl_dc2dc_config_cmd
1440  *
1441  * Current dc2dc values returned by the FW.
1442  *
1443  * @dc2dc_freq_tune0: frequency divider - digital domain
1444  * @dc2dc_freq_tune1: frequency divider - analog domain
1445  */
1446 struct iwl_dc2dc_config_resp {
1447 	__le32 dc2dc_freq_tune0;
1448 	__le32 dc2dc_freq_tune1;
1449 } __packed; /* DC2DC_CONFIG_RESP_API_S_VER_1 */
1450 
1451 /***********************************
1452  * Smart Fifo API
1453  ***********************************/
1454 /* Smart Fifo state */
1455 enum iwl_sf_state {
1456 	SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1457 	SF_FULL_ON,
1458 	SF_UNINIT,
1459 	SF_INIT_OFF,
1460 	SF_HW_NUM_STATES
1461 };
1462 
1463 /* Smart Fifo possible scenario */
1464 enum iwl_sf_scenario {
1465 	SF_SCENARIO_SINGLE_UNICAST,
1466 	SF_SCENARIO_AGG_UNICAST,
1467 	SF_SCENARIO_MULTICAST,
1468 	SF_SCENARIO_BA_RESP,
1469 	SF_SCENARIO_TX_RESP,
1470 	SF_NUM_SCENARIO
1471 };
1472 
1473 #define SF_TRANSIENT_STATES_NUMBER 2	/* SF_LONG_DELAY_ON and SF_FULL_ON */
1474 #define SF_NUM_TIMEOUT_TYPES 2		/* Aging timer and Idle timer */
1475 
1476 /* smart FIFO default values */
1477 #define SF_W_MARK_SISO 6144
1478 #define SF_W_MARK_MIMO2 8192
1479 #define SF_W_MARK_MIMO3 6144
1480 #define SF_W_MARK_LEGACY 4096
1481 #define SF_W_MARK_SCAN 4096
1482 
1483 /* SF Scenarios timers for default configuration (aligned to 32 uSec) */
1484 #define SF_SINGLE_UNICAST_IDLE_TIMER_DEF 160	/* 150 uSec  */
1485 #define SF_SINGLE_UNICAST_AGING_TIMER_DEF 400	/* 0.4 mSec */
1486 #define SF_AGG_UNICAST_IDLE_TIMER_DEF 160		/* 150 uSec */
1487 #define SF_AGG_UNICAST_AGING_TIMER_DEF 400		/* 0.4 mSec */
1488 #define SF_MCAST_IDLE_TIMER_DEF 160		/* 150 mSec */
1489 #define SF_MCAST_AGING_TIMER_DEF 400		/* 0.4 mSec */
1490 #define SF_BA_IDLE_TIMER_DEF 160			/* 150 uSec */
1491 #define SF_BA_AGING_TIMER_DEF 400			/* 0.4 mSec */
1492 #define SF_TX_RE_IDLE_TIMER_DEF 160			/* 150 uSec */
1493 #define SF_TX_RE_AGING_TIMER_DEF 400		/* 0.4 mSec */
1494 
1495 /* SF Scenarios timers for BSS MAC configuration (aligned to 32 uSec) */
1496 #define SF_SINGLE_UNICAST_IDLE_TIMER 320	/* 300 uSec  */
1497 #define SF_SINGLE_UNICAST_AGING_TIMER 2016	/* 2 mSec */
1498 #define SF_AGG_UNICAST_IDLE_TIMER 320		/* 300 uSec */
1499 #define SF_AGG_UNICAST_AGING_TIMER 2016		/* 2 mSec */
1500 #define SF_MCAST_IDLE_TIMER 2016		/* 2 mSec */
1501 #define SF_MCAST_AGING_TIMER 10016		/* 10 mSec */
1502 #define SF_BA_IDLE_TIMER 320			/* 300 uSec */
1503 #define SF_BA_AGING_TIMER 2016			/* 2 mSec */
1504 #define SF_TX_RE_IDLE_TIMER 320			/* 300 uSec */
1505 #define SF_TX_RE_AGING_TIMER 2016		/* 2 mSec */
1506 
1507 #define SF_LONG_DELAY_AGING_TIMER 1000000	/* 1 Sec */
1508 
1509 #define SF_CFG_DUMMY_NOTIF_OFF	BIT(16)
1510 
1511 /**
1512  * Smart Fifo configuration command.
1513  * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1514  * @watermark: Minimum allowed availabe free space in RXF for transient state.
1515  * @long_delay_timeouts: aging and idle timer values for each scenario
1516  * in long delay state.
1517  * @full_on_timeouts: timer values for each scenario in full on state.
1518  */
1519 struct iwl_sf_cfg_cmd {
1520 	__le32 state;
1521 	__le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1522 	__le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1523 	__le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1524 } __packed; /* SF_CFG_API_S_VER_2 */
1525 
1526 /***********************************
1527  * Location Aware Regulatory (LAR) API - MCC updates
1528  ***********************************/
1529 
1530 /**
1531  * struct iwl_mcc_update_cmd_v1 - Request the device to update geographic
1532  * regulatory profile according to the given MCC (Mobile Country Code).
1533  * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1534  * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1535  * MCC in the cmd response will be the relevant MCC in the NVM.
1536  * @mcc: given mobile country code
1537  * @source_id: the source from where we got the MCC, see iwl_mcc_source
1538  * @reserved: reserved for alignment
1539  */
1540 struct iwl_mcc_update_cmd_v1 {
1541 	__le16 mcc;
1542 	u8 source_id;
1543 	u8 reserved;
1544 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_1 */
1545 
1546 /**
1547  * struct iwl_mcc_update_cmd - Request the device to update geographic
1548  * regulatory profile according to the given MCC (Mobile Country Code).
1549  * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1550  * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1551  * MCC in the cmd response will be the relevant MCC in the NVM.
1552  * @mcc: given mobile country code
1553  * @source_id: the source from where we got the MCC, see iwl_mcc_source
1554  * @reserved: reserved for alignment
1555  * @key: integrity key for MCC API OEM testing
1556  * @reserved2: reserved
1557  */
1558 struct iwl_mcc_update_cmd {
1559 	__le16 mcc;
1560 	u8 source_id;
1561 	u8 reserved;
1562 	__le32 key;
1563 	__le32 reserved2[5];
1564 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_2 */
1565 
1566 /**
1567  * iwl_mcc_update_resp_v1  - response to MCC_UPDATE_CMD.
1568  * Contains the new channel control profile map, if changed, and the new MCC
1569  * (mobile country code).
1570  * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1571  * @status: see &enum iwl_mcc_update_status
1572  * @mcc: the new applied MCC
1573  * @cap: capabilities for all channels which matches the MCC
1574  * @source_id: the MCC source, see iwl_mcc_source
1575  * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1576  *		channels, depending on platform)
1577  * @channels: channel control data map, DWORD for each channel. Only the first
1578  *	16bits are used.
1579  */
1580 struct iwl_mcc_update_resp_v1  {
1581 	__le32 status;
1582 	__le16 mcc;
1583 	u8 cap;
1584 	u8 source_id;
1585 	__le32 n_channels;
1586 	__le32 channels[0];
1587 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_1 */
1588 
1589 /**
1590  * iwl_mcc_update_resp - response to MCC_UPDATE_CMD.
1591  * Contains the new channel control profile map, if changed, and the new MCC
1592  * (mobile country code).
1593  * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1594  * @status: see &enum iwl_mcc_update_status
1595  * @mcc: the new applied MCC
1596  * @cap: capabilities for all channels which matches the MCC
1597  * @source_id: the MCC source, see iwl_mcc_source
1598  * @time: time elapsed from the MCC test start (in 30 seconds TU)
1599  * @reserved: reserved.
1600  * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1601  *		channels, depending on platform)
1602  * @channels: channel control data map, DWORD for each channel. Only the first
1603  *	16bits are used.
1604  */
1605 struct iwl_mcc_update_resp {
1606 	__le32 status;
1607 	__le16 mcc;
1608 	u8 cap;
1609 	u8 source_id;
1610 	__le16 time;
1611 	__le16 reserved;
1612 	__le32 n_channels;
1613 	__le32 channels[0];
1614 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_2 */
1615 
1616 /**
1617  * struct iwl_mcc_chub_notif - chub notifies of mcc change
1618  * (MCC_CHUB_UPDATE_CMD = 0xc9)
1619  * The Chub (Communication Hub, CommsHUB) is a HW component that connects to
1620  * the cellular and connectivity cores that gets updates of the mcc, and
1621  * notifies the ucode directly of any mcc change.
1622  * The ucode requests the driver to request the device to update geographic
1623  * regulatory  profile according to the given MCC (Mobile Country Code).
1624  * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1625  * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1626  * MCC in the cmd response will be the relevant MCC in the NVM.
1627  * @mcc: given mobile country code
1628  * @source_id: identity of the change originator, see iwl_mcc_source
1629  * @reserved1: reserved for alignment
1630  */
1631 struct iwl_mcc_chub_notif {
1632 	u16 mcc;
1633 	u8 source_id;
1634 	u8 reserved1;
1635 } __packed; /* LAR_MCC_NOTIFY_S */
1636 
1637 enum iwl_mcc_update_status {
1638 	MCC_RESP_NEW_CHAN_PROFILE,
1639 	MCC_RESP_SAME_CHAN_PROFILE,
1640 	MCC_RESP_INVALID,
1641 	MCC_RESP_NVM_DISABLED,
1642 	MCC_RESP_ILLEGAL,
1643 	MCC_RESP_LOW_PRIORITY,
1644 	MCC_RESP_TEST_MODE_ACTIVE,
1645 	MCC_RESP_TEST_MODE_NOT_ACTIVE,
1646 	MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE,
1647 };
1648 
1649 enum iwl_mcc_source {
1650 	MCC_SOURCE_OLD_FW = 0,
1651 	MCC_SOURCE_ME = 1,
1652 	MCC_SOURCE_BIOS = 2,
1653 	MCC_SOURCE_3G_LTE_HOST = 3,
1654 	MCC_SOURCE_3G_LTE_DEVICE = 4,
1655 	MCC_SOURCE_WIFI = 5,
1656 	MCC_SOURCE_RESERVED = 6,
1657 	MCC_SOURCE_DEFAULT = 7,
1658 	MCC_SOURCE_UNINITIALIZED = 8,
1659 	MCC_SOURCE_MCC_API = 9,
1660 	MCC_SOURCE_GET_CURRENT = 0x10,
1661 	MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11,
1662 };
1663 
1664 /* DTS measurements */
1665 
1666 enum iwl_dts_measurement_flags {
1667 	DTS_TRIGGER_CMD_FLAGS_TEMP	= BIT(0),
1668 	DTS_TRIGGER_CMD_FLAGS_VOLT	= BIT(1),
1669 };
1670 
1671 /**
1672  * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1673  *
1674  * @flags: indicates which measurements we want as specified in &enum
1675  *	   iwl_dts_measurement_flags
1676  */
1677 struct iwl_dts_measurement_cmd {
1678 	__le32 flags;
1679 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1680 
1681 /**
1682 * enum iwl_dts_control_measurement_mode - DTS measurement type
1683 * @DTS_AUTOMATIC: Automatic mode (full SW control). Provide temperature read
1684 *                 back (latest value. Not waiting for new value). Use automatic
1685 *                 SW DTS configuration.
1686 * @DTS_REQUEST_READ: Request DTS read. Configure DTS with manual settings,
1687 *                    trigger DTS reading and provide read back temperature read
1688 *                    when available.
1689 * @DTS_OVER_WRITE: over-write the DTS temperatures in the SW until next read
1690 * @DTS_DIRECT_WITHOUT_MEASURE: DTS returns its latest temperature result,
1691 *                              without measurement trigger.
1692 */
1693 enum iwl_dts_control_measurement_mode {
1694 	DTS_AUTOMATIC			= 0,
1695 	DTS_REQUEST_READ		= 1,
1696 	DTS_OVER_WRITE			= 2,
1697 	DTS_DIRECT_WITHOUT_MEASURE	= 3,
1698 };
1699 
1700 /**
1701 * enum iwl_dts_used - DTS to use or used for measurement in the DTS request
1702 * @DTS_USE_TOP: Top
1703 * @DTS_USE_CHAIN_A: chain A
1704 * @DTS_USE_CHAIN_B: chain B
1705 * @DTS_USE_CHAIN_C: chain C
1706 * @XTAL_TEMPERATURE - read temperature from xtal
1707 */
1708 enum iwl_dts_used {
1709 	DTS_USE_TOP		= 0,
1710 	DTS_USE_CHAIN_A		= 1,
1711 	DTS_USE_CHAIN_B		= 2,
1712 	DTS_USE_CHAIN_C		= 3,
1713 	XTAL_TEMPERATURE	= 4,
1714 };
1715 
1716 /**
1717 * enum iwl_dts_bit_mode - bit-mode to use in DTS request read mode
1718 * @DTS_BIT6_MODE: bit 6 mode
1719 * @DTS_BIT8_MODE: bit 8 mode
1720 */
1721 enum iwl_dts_bit_mode {
1722 	DTS_BIT6_MODE	= 0,
1723 	DTS_BIT8_MODE	= 1,
1724 };
1725 
1726 /**
1727  * iwl_ext_dts_measurement_cmd - request extended DTS temperature measurements
1728  * @control_mode: see &enum iwl_dts_control_measurement_mode
1729  * @temperature: used when over write DTS mode is selected
1730  * @sensor: set temperature sensor to use. See &enum iwl_dts_used
1731  * @avg_factor: average factor to DTS in request DTS read mode
1732  * @bit_mode: value defines the DTS bit mode to use. See &enum iwl_dts_bit_mode
1733  * @step_duration: step duration for the DTS
1734  */
1735 struct iwl_ext_dts_measurement_cmd {
1736 	__le32 control_mode;
1737 	__le32 temperature;
1738 	__le32 sensor;
1739 	__le32 avg_factor;
1740 	__le32 bit_mode;
1741 	__le32 step_duration;
1742 } __packed; /* XVT_FW_DTS_CONTROL_MEASUREMENT_REQUEST_API_S */
1743 
1744 /**
1745  * struct iwl_dts_measurement_notif_v1 - measurements notification
1746  *
1747  * @temp: the measured temperature
1748  * @voltage: the measured voltage
1749  */
1750 struct iwl_dts_measurement_notif_v1 {
1751 	__le32 temp;
1752 	__le32 voltage;
1753 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_1*/
1754 
1755 /**
1756  * struct iwl_dts_measurement_notif_v2 - measurements notification
1757  *
1758  * @temp: the measured temperature
1759  * @voltage: the measured voltage
1760  * @threshold_idx: the trip index that was crossed
1761  */
1762 struct iwl_dts_measurement_notif_v2 {
1763 	__le32 temp;
1764 	__le32 voltage;
1765 	__le32 threshold_idx;
1766 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_2 */
1767 
1768 /**
1769  * struct ct_kill_notif - CT-kill entry notification
1770  *
1771  * @temperature: the current temperature in celsius
1772  * @reserved: reserved
1773  */
1774 struct ct_kill_notif {
1775 	__le16 temperature;
1776 	__le16 reserved;
1777 } __packed; /* GRP_PHY_CT_KILL_NTF */
1778 
1779 /**
1780 * enum ctdp_cmd_operation - CTDP command operations
1781 * @CTDP_CMD_OPERATION_START: update the current budget
1782 * @CTDP_CMD_OPERATION_STOP: stop ctdp
1783 * @CTDP_CMD_OPERATION_REPORT: get the avgerage budget
1784 */
1785 enum iwl_mvm_ctdp_cmd_operation {
1786 	CTDP_CMD_OPERATION_START	= 0x1,
1787 	CTDP_CMD_OPERATION_STOP		= 0x2,
1788 	CTDP_CMD_OPERATION_REPORT	= 0x4,
1789 };/* CTDP_CMD_OPERATION_TYPE_E */
1790 
1791 /**
1792  * struct iwl_mvm_ctdp_cmd - track and manage the FW power consumption budget
1793  *
1794  * @operation: see &enum iwl_mvm_ctdp_cmd_operation
1795  * @budget: the budget in milliwatt
1796  * @window_size: defined in API but not used
1797  */
1798 struct iwl_mvm_ctdp_cmd {
1799 	__le32 operation;
1800 	__le32 budget;
1801 	__le32 window_size;
1802 } __packed;
1803 
1804 #define IWL_MAX_DTS_TRIPS	8
1805 
1806 /**
1807  * struct iwl_temp_report_ths_cmd - set temperature thresholds
1808  *
1809  * @num_temps: number of temperature thresholds passed
1810  * @thresholds: array with the thresholds to be configured
1811  */
1812 struct temp_report_ths_cmd {
1813 	__le32 num_temps;
1814 	__le16 thresholds[IWL_MAX_DTS_TRIPS];
1815 } __packed; /* GRP_PHY_TEMP_REPORTING_THRESHOLDS_CMD */
1816 
1817 /***********************************
1818  * TDLS API
1819  ***********************************/
1820 
1821 /* Type of TDLS request */
1822 enum iwl_tdls_channel_switch_type {
1823 	TDLS_SEND_CHAN_SW_REQ = 0,
1824 	TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH,
1825 	TDLS_MOVE_CH,
1826 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1827 
1828 /**
1829  * Switch timing sub-element in a TDLS channel-switch command
1830  * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1831  *	received from peer
1832  * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1833  *	to the TDLS off-channel communication. For instance if the DTIM is
1834  *	200TU and the TDLS peer is to be given 25% of the time, the value
1835  *	given will be 50TU, or 50 * 1024 if translated into microseconds.
1836  * @switch_time: switch time the peer sent in its channel switch timing IE
1837  * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1838  */
1839 struct iwl_tdls_channel_switch_timing {
1840 	__le32 frame_timestamp; /* GP2 time of peer packet Rx */
1841 	__le32 max_offchan_duration; /* given in micro-seconds */
1842 	__le32 switch_time; /* given in micro-seconds */
1843 	__le32 switch_timeout; /* given in micro-seconds */
1844 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1845 
1846 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1847 
1848 /**
1849  * TDLS channel switch frame template
1850  *
1851  * A template representing a TDLS channel-switch request or response frame
1852  *
1853  * @switch_time_offset: offset to the channel switch timing IE in the template
1854  * @tx_cmd: Tx parameters for the frame
1855  * @data: frame data
1856  */
1857 struct iwl_tdls_channel_switch_frame {
1858 	__le32 switch_time_offset;
1859 	struct iwl_tx_cmd tx_cmd;
1860 	u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE];
1861 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1862 
1863 /**
1864  * TDLS channel switch command
1865  *
1866  * The command is sent to initiate a channel switch and also in response to
1867  * incoming TDLS channel-switch request/response packets from remote peers.
1868  *
1869  * @switch_type: see &enum iwl_tdls_channel_switch_type
1870  * @peer_sta_id: station id of TDLS peer
1871  * @ci: channel we switch to
1872  * @timing: timing related data for command
1873  * @frame: channel-switch request/response template, depending to switch_type
1874  */
1875 struct iwl_tdls_channel_switch_cmd {
1876 	u8 switch_type;
1877 	__le32 peer_sta_id;
1878 	struct iwl_fw_channel_info ci;
1879 	struct iwl_tdls_channel_switch_timing timing;
1880 	struct iwl_tdls_channel_switch_frame frame;
1881 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1882 
1883 /**
1884  * TDLS channel switch start notification
1885  *
1886  * @status: non-zero on success
1887  * @offchannel_duration: duration given in microseconds
1888  * @sta_id: peer currently performing the channel-switch with
1889  */
1890 struct iwl_tdls_channel_switch_notif {
1891 	__le32 status;
1892 	__le32 offchannel_duration;
1893 	__le32 sta_id;
1894 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1895 
1896 /**
1897  * TDLS station info
1898  *
1899  * @sta_id: station id of the TDLS peer
1900  * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1901  * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1902  * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1903  */
1904 struct iwl_tdls_sta_info {
1905 	u8 sta_id;
1906 	u8 tx_to_peer_tid;
1907 	__le16 tx_to_peer_ssn;
1908 	__le32 is_initiator;
1909 } __packed; /* TDLS_STA_INFO_VER_1 */
1910 
1911 /**
1912  * TDLS basic config command
1913  *
1914  * @id_and_color: MAC id and color being configured
1915  * @tdls_peer_count: amount of currently connected TDLS peers
1916  * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1917  * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1918  * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1919  * @pti_req_data_offset: offset of network-level data for the PTI template
1920  * @pti_req_tx_cmd: Tx parameters for PTI request template
1921  * @pti_req_template: PTI request template data
1922  */
1923 struct iwl_tdls_config_cmd {
1924 	__le32 id_and_color; /* mac id and color */
1925 	u8 tdls_peer_count;
1926 	u8 tx_to_ap_tid;
1927 	__le16 tx_to_ap_ssn;
1928 	struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT];
1929 
1930 	__le32 pti_req_data_offset;
1931 	struct iwl_tx_cmd pti_req_tx_cmd;
1932 	u8 pti_req_template[0];
1933 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1934 
1935 /**
1936  * TDLS per-station config information from FW
1937  *
1938  * @sta_id: station id of the TDLS peer
1939  * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1940  *	the peer
1941  */
1942 struct iwl_tdls_config_sta_info_res {
1943 	__le16 sta_id;
1944 	__le16 tx_to_peer_last_seq;
1945 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */
1946 
1947 /**
1948  * TDLS config information from FW
1949  *
1950  * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1951  * @sta_info: per-station TDLS config information
1952  */
1953 struct iwl_tdls_config_res {
1954 	__le32 tx_to_ap_last_seq;
1955 	struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT];
1956 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1957 
1958 #define TX_FIFO_MAX_NUM_9000		8
1959 #define TX_FIFO_MAX_NUM			15
1960 #define RX_FIFO_MAX_NUM			2
1961 #define TX_FIFO_INTERNAL_MAX_NUM	6
1962 
1963 /**
1964  * Shared memory configuration information from the FW
1965  *
1966  * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
1967  *	accessible)
1968  * @shared_mem_size: shared memory size
1969  * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
1970  *	0x0 as accessible only via DBGM RDAT)
1971  * @sample_buff_size: internal sample buff size
1972  * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
1973  *	8000 HW set to 0x0 as not accessible)
1974  * @txfifo_size: size of TXF0 ... TXF7
1975  * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
1976  * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
1977  *	when paging is not supported this should be 0
1978  * @page_buff_size: size of %page_buff_addr
1979  * @rxfifo_addr: Start address of rxFifo
1980  * @internal_txfifo_addr: start address of internalFifo
1981  * @internal_txfifo_size: internal fifos' size
1982  *
1983  * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
1984  *	 set, the last 3 members don't exist.
1985  */
1986 struct iwl_shared_mem_cfg_v1 {
1987 	__le32 shared_mem_addr;
1988 	__le32 shared_mem_size;
1989 	__le32 sample_buff_addr;
1990 	__le32 sample_buff_size;
1991 	__le32 txfifo_addr;
1992 	__le32 txfifo_size[TX_FIFO_MAX_NUM_9000];
1993 	__le32 rxfifo_size[RX_FIFO_MAX_NUM];
1994 	__le32 page_buff_addr;
1995 	__le32 page_buff_size;
1996 	__le32 rxfifo_addr;
1997 	__le32 internal_txfifo_addr;
1998 	__le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
1999 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */
2000 
2001 struct iwl_shared_mem_cfg {
2002 	__le32 shared_mem_addr;
2003 	__le32 shared_mem_size;
2004 	__le32 sample_buff_addr;
2005 	__le32 sample_buff_size;
2006 	__le32 txfifo_addr;
2007 	__le32 txfifo_size[TX_FIFO_MAX_NUM];
2008 	__le32 rxfifo_size[RX_FIFO_MAX_NUM];
2009 	__le32 page_buff_addr;
2010 	__le32 page_buff_size;
2011 	__le32 rxfifo_addr;
2012 	__le32 internal_txfifo_addr;
2013 	__le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
2014 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_3 */
2015 
2016 /**
2017  * VHT MU-MIMO group configuration
2018  *
2019  * @membership_status: a bitmap of MU groups
2020  * @user_position:the position of station in a group. If the station is in the
2021  *	group then bits (group * 2) is the position -1
2022  */
2023 struct iwl_mu_group_mgmt_cmd {
2024 	__le32 reserved;
2025 	__le32 membership_status[2];
2026 	__le32 user_position[4];
2027 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
2028 
2029 /**
2030  * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
2031  *
2032  * @membership_status: a bitmap of MU groups
2033  * @user_position: the position of station in a group. If the station is in the
2034  *	group then bits (group * 2) is the position -1
2035  */
2036 struct iwl_mu_group_mgmt_notif {
2037 	__le32 membership_status[2];
2038 	__le32 user_position[4];
2039 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
2040 
2041 #define MAX_STORED_BEACON_SIZE 600
2042 
2043 /**
2044  * Stored beacon notification
2045  *
2046  * @system_time: system time on air rise
2047  * @tsf: TSF on air rise
2048  * @beacon_timestamp: beacon on air rise
2049  * @band: band, matches &RX_RES_PHY_FLAGS_BAND_24 definition
2050  * @channel: channel this beacon was received on
2051  * @rates: rate in ucode internal format
2052  * @byte_count: frame's byte count
2053  */
2054 struct iwl_stored_beacon_notif {
2055 	__le32 system_time;
2056 	__le64 tsf;
2057 	__le32 beacon_timestamp;
2058 	__le16 band;
2059 	__le16 channel;
2060 	__le32 rates;
2061 	__le32 byte_count;
2062 	u8 data[MAX_STORED_BEACON_SIZE];
2063 } __packed; /* WOWLAN_STROED_BEACON_INFO_S_VER_2 */
2064 
2065 #define LQM_NUMBER_OF_STATIONS_IN_REPORT 16
2066 
2067 enum iwl_lqm_cmd_operatrions {
2068 	LQM_CMD_OPERATION_START_MEASUREMENT = 0x01,
2069 	LQM_CMD_OPERATION_STOP_MEASUREMENT = 0x02,
2070 };
2071 
2072 enum iwl_lqm_status {
2073 	LQM_STATUS_SUCCESS = 0,
2074 	LQM_STATUS_TIMEOUT = 1,
2075 	LQM_STATUS_ABORT = 2,
2076 };
2077 
2078 /**
2079  * Link Quality Measurement command
2080  * @cmd_operatrion: command operation to be performed (start or stop)
2081  *	as defined above.
2082  * @mac_id: MAC ID the measurement applies to.
2083  * @measurement_time: time of the total measurement to be performed, in uSec.
2084  * @timeout: maximum time allowed until a response is sent, in uSec.
2085  */
2086 struct iwl_link_qual_msrmnt_cmd {
2087 	__le32 cmd_operation;
2088 	__le32 mac_id;
2089 	__le32 measurement_time;
2090 	__le32 timeout;
2091 } __packed /* LQM_CMD_API_S_VER_1 */;
2092 
2093 /**
2094  * Link Quality Measurement notification
2095  *
2096  * @frequent_stations_air_time: an array containing the total air time
2097  *	(in uSec) used by the most frequently transmitting stations.
2098  * @number_of_stations: the number of uniqe stations included in the array
2099  *	(a number between 0 to 16)
2100  * @total_air_time_other_stations: the total air time (uSec) used by all the
2101  *	stations which are not included in the above report.
2102  * @time_in_measurement_window: the total time in uSec in which a measurement
2103  *	took place.
2104  * @tx_frame_dropped: the number of TX frames dropped due to retry limit during
2105  *	measurement
2106  * @mac_id: MAC ID the measurement applies to.
2107  * @status: return status. may be one of the LQM_STATUS_* defined above.
2108  * @reserved: reserved.
2109  */
2110 struct iwl_link_qual_msrmnt_notif {
2111 	__le32 frequent_stations_air_time[LQM_NUMBER_OF_STATIONS_IN_REPORT];
2112 	__le32 number_of_stations;
2113 	__le32 total_air_time_other_stations;
2114 	__le32 time_in_measurement_window;
2115 	__le32 tx_frame_dropped;
2116 	__le32 mac_id;
2117 	__le32 status;
2118 	__le32 reserved[3];
2119 } __packed; /* LQM_MEASUREMENT_COMPLETE_NTF_API_S_VER1 */
2120 
2121 /**
2122  * Channel switch NOA notification
2123  *
2124  * @id_and_color: ID and color of the MAC
2125  */
2126 struct iwl_channel_switch_noa_notif {
2127 	__le32 id_and_color;
2128 } __packed; /* CHANNEL_SWITCH_START_NTFY_API_S_VER_1 */
2129 
2130 /* Operation types for the debug mem access */
2131 enum {
2132 	DEBUG_MEM_OP_READ = 0,
2133 	DEBUG_MEM_OP_WRITE = 1,
2134 	DEBUG_MEM_OP_WRITE_BYTES = 2,
2135 };
2136 
2137 #define DEBUG_MEM_MAX_SIZE_DWORDS 32
2138 
2139 /**
2140  * struct iwl_dbg_mem_access_cmd - Request the device to read/write memory
2141  * @op: DEBUG_MEM_OP_*
2142  * @addr: address to read/write from/to
2143  * @len: in dwords, to read/write
2144  * @data: for write opeations, contains the source buffer
2145  */
2146 struct iwl_dbg_mem_access_cmd {
2147 	__le32 op;
2148 	__le32 addr;
2149 	__le32 len;
2150 	__le32 data[];
2151 } __packed; /* DEBUG_(U|L)MAC_RD_WR_CMD_API_S_VER_1 */
2152 
2153 /* Status responses for the debug mem access */
2154 enum {
2155 	DEBUG_MEM_STATUS_SUCCESS = 0x0,
2156 	DEBUG_MEM_STATUS_FAILED = 0x1,
2157 	DEBUG_MEM_STATUS_LOCKED = 0x2,
2158 	DEBUG_MEM_STATUS_HIDDEN = 0x3,
2159 	DEBUG_MEM_STATUS_LENGTH = 0x4,
2160 };
2161 
2162 /**
2163  * struct iwl_dbg_mem_access_rsp - Response to debug mem commands
2164  * @status: DEBUG_MEM_STATUS_*
2165  * @len: read dwords (0 for write operations)
2166  * @data: contains the read DWs
2167  */
2168 struct iwl_dbg_mem_access_rsp {
2169 	__le32 status;
2170 	__le32 len;
2171 	__le32 data[];
2172 } __packed; /* DEBUG_(U|L)MAC_RD_WR_RSP_API_S_VER_1 */
2173 
2174 /**
2175  * struct iwl_nvm_access_complete_cmd - NVM_ACCESS commands are completed
2176  */
2177 struct iwl_nvm_access_complete_cmd {
2178 	__le32 reserved;
2179 } __packed; /* NVM_ACCESS_COMPLETE_CMD_API_S_VER_1 */
2180 
2181 #endif /* __fw_api_h__ */
2182