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