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