xref: /freebsd/sys/contrib/dev/iwlwifi/fw/api/mac-cfg.h (revision a4128aad8503277614f2d214011ef60a19447b83)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2012-2014, 2018-2019, 2021-2024 Intel Corporation
4  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5  * Copyright (C) 2016-2017 Intel Deutschland GmbH
6  */
7 #ifndef __iwl_fw_api_mac_cfg_h__
8 #define __iwl_fw_api_mac_cfg_h__
9 
10 #include "mac.h"
11 
12 /**
13  * enum iwl_mac_conf_subcmd_ids - mac configuration command IDs
14  */
15 enum iwl_mac_conf_subcmd_ids {
16 	/**
17 	 * @LOW_LATENCY_CMD: &struct iwl_mac_low_latency_cmd
18 	 */
19 	LOW_LATENCY_CMD = 0x3,
20 	/**
21 	 * @CHANNEL_SWITCH_TIME_EVENT_CMD: &struct iwl_chan_switch_te_cmd
22 	 */
23 	CHANNEL_SWITCH_TIME_EVENT_CMD = 0x4,
24 	/**
25 	 * @MISSED_VAP_NOTIF: &struct iwl_missed_vap_notif
26 	 */
27 	MISSED_VAP_NOTIF = 0xFA,
28 	/**
29 	 * @SESSION_PROTECTION_CMD: &struct iwl_mvm_session_prot_cmd
30 	 */
31 	SESSION_PROTECTION_CMD = 0x5,
32 	/**
33 	 * @CANCEL_CHANNEL_SWITCH_CMD: &struct iwl_cancel_channel_switch_cmd
34 	 */
35 	CANCEL_CHANNEL_SWITCH_CMD = 0x6,
36 	/**
37 	 * @MAC_CONFIG_CMD: &struct iwl_mac_config_cmd
38 	 */
39 	MAC_CONFIG_CMD = 0x8,
40 	/**
41 	 * @LINK_CONFIG_CMD: &struct iwl_link_config_cmd
42 	 */
43 	LINK_CONFIG_CMD = 0x9,
44 	/**
45 	 * @STA_CONFIG_CMD: &struct iwl_mvm_sta_cfg_cmd
46 	 */
47 	STA_CONFIG_CMD = 0xA,
48 	/**
49 	 * @AUX_STA_CMD: &struct iwl_mvm_aux_sta_cmd
50 	 */
51 	AUX_STA_CMD = 0xB,
52 	/**
53 	 * @STA_REMOVE_CMD: &struct iwl_mvm_remove_sta_cmd
54 	 */
55 	STA_REMOVE_CMD = 0xC,
56 	/**
57 	 * @STA_DISABLE_TX_CMD: &struct iwl_mvm_sta_disable_tx_cmd
58 	 */
59 	STA_DISABLE_TX_CMD = 0xD,
60 	/**
61 	 * @ROC_CMD: &struct iwl_roc_req
62 	 */
63 	ROC_CMD = 0xE,
64 	/**
65 	 * @ROC_NOTIF: &struct iwl_roc_notif
66 	 */
67 	ROC_NOTIF = 0xF8,
68 	/**
69 	 * @SESSION_PROTECTION_NOTIF: &struct iwl_mvm_session_prot_notif
70 	 */
71 	SESSION_PROTECTION_NOTIF = 0xFB,
72 
73 	/**
74 	 * @PROBE_RESPONSE_DATA_NOTIF: &struct iwl_probe_resp_data_notif
75 	 */
76 	PROBE_RESPONSE_DATA_NOTIF = 0xFC,
77 
78 	/**
79 	 * @CHANNEL_SWITCH_START_NOTIF: &struct iwl_channel_switch_start_notif
80 	 */
81 	CHANNEL_SWITCH_START_NOTIF = 0xFF,
82 
83 	/**
84 	 *@CHANNEL_SWITCH_ERROR_NOTIF: &struct iwl_channel_switch_error_notif
85 	 */
86 	CHANNEL_SWITCH_ERROR_NOTIF = 0xF9,
87 };
88 
89 #define IWL_P2P_NOA_DESC_COUNT	(2)
90 
91 /**
92  * struct iwl_p2p_noa_attr - NOA attr contained in probe resp FW notification
93  *
94  * @id: attribute id
95  * @len_low: length low half
96  * @len_high: length high half
97  * @idx: instance of NoA timing
98  * @ctwin: GO's ct window and pwer save capability
99  * @desc: NoA descriptor
100  * @reserved: reserved for alignment purposes
101  */
102 struct iwl_p2p_noa_attr {
103 	u8 id;
104 	u8 len_low;
105 	u8 len_high;
106 	u8 idx;
107 	u8 ctwin;
108 	struct ieee80211_p2p_noa_desc desc[IWL_P2P_NOA_DESC_COUNT];
109 	u8 reserved;
110 } __packed;
111 
112 #define IWL_PROBE_RESP_DATA_NO_CSA (0xff)
113 
114 /**
115  * struct iwl_probe_resp_data_notif - notification with NOA and CSA counter
116  *
117  * @mac_id: the mac which should send the probe response
118  * @noa_active: notifies if the noa attribute should be handled
119  * @noa_attr: P2P NOA attribute
120  * @csa_counter: current csa counter
121  * @reserved: reserved for alignment purposes
122  */
123 struct iwl_probe_resp_data_notif {
124 	__le32 mac_id;
125 	__le32 noa_active;
126 	struct iwl_p2p_noa_attr noa_attr;
127 	u8 csa_counter;
128 	u8 reserved[3];
129 } __packed; /* PROBE_RESPONSE_DATA_NTFY_API_S_VER_1 */
130 
131 /**
132  * struct iwl_missed_vap_notif - notification of missing vap detection
133  *
134  * @mac_id: the mac for which the ucode sends the notification for
135  * @num_beacon_intervals_elapsed: beacons elpased with no vap profile inside
136  * @profile_periodicity: beacons period to have our profile inside
137  * @reserved: reserved for alignment purposes
138  */
139 struct iwl_missed_vap_notif {
140 	__le32 mac_id;
141 	u8 num_beacon_intervals_elapsed;
142 	u8 profile_periodicity;
143 	u8 reserved[2];
144 } __packed; /* MISSED_VAP_NTFY_API_S_VER_1 */
145 
146 /**
147  * struct iwl_channel_switch_start_notif_v1 - Channel switch start notification
148  *
149  * @id_and_color: ID and color of the MAC
150  */
151 struct iwl_channel_switch_start_notif_v1 {
152 	__le32 id_and_color;
153 } __packed; /* CHANNEL_SWITCH_START_NTFY_API_S_VER_1 */
154 
155 /**
156  * struct iwl_channel_switch_start_notif - Channel switch start notification
157  *
158  * @link_id: FW link id
159  */
160 struct iwl_channel_switch_start_notif {
161 	__le32 link_id;
162 } __packed; /* CHANNEL_SWITCH_START_NTFY_API_S_VER_3 */
163 
164 #define CS_ERR_COUNT_ERROR BIT(0)
165 #define CS_ERR_LONG_DELAY_AFTER_CS BIT(1)
166 #define CS_ERR_LONG_TX_BLOCK BIT(2)
167 #define CS_ERR_TX_BLOCK_TIMER_EXPIRED BIT(3)
168 
169 /**
170  * struct iwl_channel_switch_error_notif_v1 - Channel switch error notification
171  *
172  * @mac_id: the mac for which the ucode sends the notification for
173  * @csa_err_mask: mask of channel switch error that can occur
174  */
175 struct iwl_channel_switch_error_notif_v1 {
176 	__le32 mac_id;
177 	__le32 csa_err_mask;
178 } __packed; /* CHANNEL_SWITCH_ERROR_NTFY_API_S_VER_1 */
179 
180 /**
181  * struct iwl_channel_switch_error_notif - Channel switch error notification
182  *
183  * @link_id: FW link id
184  * @csa_err_mask: mask of channel switch error that can occur
185  */
186 struct iwl_channel_switch_error_notif {
187 	__le32 link_id;
188 	__le32 csa_err_mask;
189 } __packed; /* CHANNEL_SWITCH_ERROR_NTFY_API_S_VER_2 */
190 
191 /**
192  * struct iwl_cancel_channel_switch_cmd - Cancel Channel Switch command
193  *
194  * @id: the id of the link or mac that should cancel the channel switch
195  */
196 struct iwl_cancel_channel_switch_cmd {
197 	__le32 id;
198 } __packed; /* MAC_CANCEL_CHANNEL_SWITCH_S_VER_1 */
199 
200 /**
201  * struct iwl_chan_switch_te_cmd - Channel Switch Time Event command
202  *
203  * @mac_id: MAC ID for channel switch
204  * @action: action to perform, see &enum iwl_ctxt_action
205  * @tsf: beacon tsf
206  * @cs_count: channel switch count from CSA/eCSA IE
207  * @cs_delayed_bcn_count: if set to N (!= 0) GO/AP can delay N beacon intervals
208  *	at the new channel after the channel switch, otherwise (N == 0) expect
209  *	beacon right after the channel switch.
210  * @cs_mode: 1 - quiet, 0 - otherwise
211  * @reserved: reserved for alignment purposes
212  */
213 struct iwl_chan_switch_te_cmd {
214 	__le32 mac_id;
215 	__le32 action;
216 	__le32 tsf;
217 	u8 cs_count;
218 	u8 cs_delayed_bcn_count;
219 	u8 cs_mode;
220 	u8 reserved;
221 } __packed; /* MAC_CHANNEL_SWITCH_TIME_EVENT_S_VER_2 */
222 
223 /**
224  * struct iwl_mac_low_latency_cmd - set/clear mac to 'low-latency mode'
225  *
226  * @mac_id: MAC ID to whom to apply the low-latency configurations
227  * @low_latency_rx: 1/0 to set/clear Rx low latency direction
228  * @low_latency_tx: 1/0 to set/clear Tx low latency direction
229  * @reserved: reserved for alignment purposes
230  */
231 struct iwl_mac_low_latency_cmd {
232 	__le32 mac_id;
233 	u8 low_latency_rx;
234 	u8 low_latency_tx;
235 	__le16 reserved;
236 } __packed; /* MAC_LOW_LATENCY_API_S_VER_1 */
237 
238 /**
239  * struct iwl_mac_client_data - configuration data for client MAC context
240  *
241  * @is_assoc: 1 for associated state, 0 otherwise
242  * @esr_transition_timeout: the timeout required by the AP for the
243  *	eSR transition.
244  *	Available only from version 2 of the command.
245  *	This value comes from the EMLSR transition delay in the EML
246  *	Capabilities subfield.
247  * @medium_sync_delay: the value as it appears in P802.11be_D2.2 Figure 9-1002j.
248  * @assoc_id: unique ID assigned by the AP during association
249  * @reserved1: alignment
250  * @data_policy: see &enum iwl_mac_data_policy
251  * @reserved2: alignment
252  * @ctwin: client traffic window in TU (period after TBTT when GO is present).
253  *	0 indicates that there is no CT window.
254  */
255 struct iwl_mac_client_data {
256 	u8 is_assoc;
257 	u8 esr_transition_timeout;
258 	__le16 medium_sync_delay;
259 
260 	__le16 assoc_id;
261 	__le16 reserved1;
262 	__le16 data_policy;
263 	__le16 reserved2;
264 	__le32 ctwin;
265 } __packed; /* MAC_CONTEXT_CONFIG_CLIENT_DATA_API_S_VER_2 */
266 
267 /**
268  * struct iwl_mac_p2p_dev_data  - configuration data for P2P device MAC context
269  *
270  * @is_disc_extended: if set to true, P2P Device discoverability is enabled on
271  *	other channels as well. This should be to true only in case that the
272  *	device is discoverable and there is an active GO. Note that setting this
273  *	field when not needed, will increase the number of interrupts and have
274  *	effect on the platform power, as this setting opens the Rx filters on
275  *	all macs.
276  */
277 struct iwl_mac_p2p_dev_data {
278 	__le32 is_disc_extended;
279 } __packed; /* MAC_CONTEXT_CONFIG_P2P_DEV_DATA_API_S_VER_1 */
280 
281 /**
282  * enum iwl_mac_config_filter_flags - MAC context configuration filter flags
283  *
284  * @MAC_CFG_FILTER_PROMISC: accept all data frames
285  * @MAC_CFG_FILTER_ACCEPT_CONTROL_AND_MGMT: pass all management and
286  *	control frames to the host
287  * @MAC_CFG_FILTER_ACCEPT_GRP: accept multicast frames
288  * @MAC_CFG_FILTER_ACCEPT_BEACON: accept beacon frames
289  * @MAC_CFG_FILTER_ACCEPT_BCAST_PROBE_RESP: accept broadcast probe response
290  * @MAC_CFG_FILTER_ACCEPT_PROBE_REQ: accept probe requests
291  */
292 enum iwl_mac_config_filter_flags {
293 	MAC_CFG_FILTER_PROMISC			= BIT(0),
294 	MAC_CFG_FILTER_ACCEPT_CONTROL_AND_MGMT	= BIT(1),
295 	MAC_CFG_FILTER_ACCEPT_GRP		= BIT(2),
296 	MAC_CFG_FILTER_ACCEPT_BEACON		= BIT(3),
297 	MAC_CFG_FILTER_ACCEPT_BCAST_PROBE_RESP	= BIT(4),
298 	MAC_CFG_FILTER_ACCEPT_PROBE_REQ		= BIT(5),
299 }; /* MAC_FILTER_FLAGS_MASK_E_VER_1 */
300 
301 /**
302  * struct iwl_mac_config_cmd - command structure to configure MAC contexts in
303  *	MLD API
304  * ( MAC_CONTEXT_CONFIG_CMD = 0x8 )
305  *
306  * @id_and_color: ID and color of the MAC
307  * @action: action to perform, see &enum iwl_ctxt_action
308  * @mac_type: one of &enum iwl_mac_types
309  * @local_mld_addr: mld address
310  * @reserved_for_local_mld_addr: reserved
311  * @filter_flags: combination of &enum iwl_mac_config_filter_flags
312  * @he_support: does this MAC support HE
313  * @he_ap_support: HE AP enabled, "pseudo HE", no trigger frame handling
314  * @eht_support: does this MAC support EHT. Requires he_support
315  * @nic_not_ack_enabled: mark that the NIC doesn't support receiving
316  *	ACK-enabled AGG, (i.e. both BACK and non-BACK frames in single AGG).
317  *	If the NIC is not ACK_ENABLED it may use the EOF-bit in first non-0
318  *	len delim to determine if AGG or single.
319  * @client: client mac data
320  * @p2p_dev: mac data for p2p device
321  */
322 struct iwl_mac_config_cmd {
323 	/* COMMON_INDEX_HDR_API_S_VER_1 */
324 	__le32 id_and_color;
325 	__le32 action;
326 	/* MAC_CONTEXT_TYPE_API_E */
327 	__le32 mac_type;
328 	u8 local_mld_addr[6];
329 	__le16 reserved_for_local_mld_addr;
330 	__le32 filter_flags;
331 	__le16 he_support;
332 	__le16 he_ap_support;
333 	__le32 eht_support;
334 	__le32 nic_not_ack_enabled;
335 	/* MAC_CONTEXT_CONFIG_SPECIFIC_DATA_API_U_VER_2 */
336 	union {
337 		struct iwl_mac_client_data client;
338 		struct iwl_mac_p2p_dev_data p2p_dev;
339 	};
340 } __packed; /* MAC_CONTEXT_CONFIG_CMD_API_S_VER_2 */
341 
342 /**
343  * enum iwl_link_ctx_modify_flags - indicate to the fw what fields are being
344  *	modified in &iwl_link_ctx_cfg_cmd
345  *
346  * @LINK_CONTEXT_MODIFY_ACTIVE: covers iwl_link_ctx_cfg_cmd::active
347  * @LINK_CONTEXT_MODIFY_RATES_INFO: covers iwl_link_ctx_cfg_cmd::cck_rates,
348  *	iwl_link_ctx_cfg_cmd::ofdm_rates,
349  *	iwl_link_ctx_cfg_cmd::cck_short_preamble,
350  *	iwl_link_ctx_cfg_cmd::short_slot
351  * @LINK_CONTEXT_MODIFY_PROTECT_FLAGS: covers
352  *	iwl_link_ctx_cfg_cmd::protection_flags
353  * @LINK_CONTEXT_MODIFY_QOS_PARAMS: covers iwl_link_ctx_cfg_cmd::qos_flags,
354  *	iwl_link_ctx_cfg_cmd::ac,
355  * @LINK_CONTEXT_MODIFY_BEACON_TIMING: covers iwl_link_ctx_cfg_cmd::bi,
356  *	iwl_link_ctx_cfg_cmd::dtim_interval,
357  *	iwl_link_ctx_cfg_cmd::dtim_time,
358  *	iwl_link_ctx_cfg_cmd::dtim_tsf,
359  *	iwl_link_ctx_cfg_cmd::assoc_beacon_arrive_time.
360  *	This flag can be set only once after assoc.
361  * @LINK_CONTEXT_MODIFY_HE_PARAMS: covers
362  *	iwl_link_ctx_cfg_cmd::htc_trig_based_pkt_ext
363  *	iwl_link_ctx_cfg_cmd::rand_alloc_ecwmin,
364  *	iwl_link_ctx_cfg_cmd::rand_alloc_ecwmax,
365  *	iwl_link_ctx_cfg_cmd::trig_based_txf,
366  *	iwl_link_ctx_cfg_cmd::bss_color,
367  *	iwl_link_ctx_cfg_cmd::ndp_fdbk_buff_th_exp,
368  *	iwl_link_ctx_cfg_cmd::ref_bssid_addr
369  *	iwl_link_ctx_cfg_cmd::bssid_index,
370  *	iwl_link_ctx_cfg_cmd::frame_time_rts_th.
371  *	This flag can be set any time.
372  * @LINK_CONTEXT_MODIFY_BSS_COLOR_DISABLE: covers
373  *	iwl_link_ctx_cfg_cmd::bss_color_disable
374  * @LINK_CONTEXT_MODIFY_EHT_PARAMS: covers iwl_link_ctx_cfg_cmd::puncture_mask.
375  *	This flag can be set only if the MAC that this link relates to has
376  *	eht_support set to true. No longer used since _VER_3 of this command.
377  * @LINK_CONTEXT_MODIFY_ALL: set all above flags
378  */
379 enum iwl_link_ctx_modify_flags {
380 	LINK_CONTEXT_MODIFY_ACTIVE		= BIT(0),
381 	LINK_CONTEXT_MODIFY_RATES_INFO		= BIT(1),
382 	LINK_CONTEXT_MODIFY_PROTECT_FLAGS	= BIT(2),
383 	LINK_CONTEXT_MODIFY_QOS_PARAMS		= BIT(3),
384 	LINK_CONTEXT_MODIFY_BEACON_TIMING	= BIT(4),
385 	LINK_CONTEXT_MODIFY_HE_PARAMS		= BIT(5),
386 	LINK_CONTEXT_MODIFY_BSS_COLOR_DISABLE	= BIT(6),
387 	LINK_CONTEXT_MODIFY_EHT_PARAMS		= BIT(7),
388 	LINK_CONTEXT_MODIFY_ALL			= 0xff,
389 }; /* LINK_CONTEXT_MODIFY_MASK_E_VER_1 */
390 
391 /**
392  * enum iwl_link_ctx_protection_flags - link protection flags
393  * @LINK_PROT_FLG_TGG_PROTECT: 11g protection when transmitting OFDM frames,
394  *	this will require CCK RTS/CTS2self.
395  *	RTS/CTS will protect full burst time.
396  * @LINK_PROT_FLG_HT_PROT: enable HT protection
397  * @LINK_PROT_FLG_FAT_PROT: protect 40 MHz transmissions
398  * @LINK_PROT_FLG_SELF_CTS_EN: allow CTS2self
399  */
400 enum iwl_link_ctx_protection_flags {
401 	LINK_PROT_FLG_TGG_PROTECT	= BIT(0),
402 	LINK_PROT_FLG_HT_PROT		= BIT(1),
403 	LINK_PROT_FLG_FAT_PROT		= BIT(2),
404 	LINK_PROT_FLG_SELF_CTS_EN	= BIT(3),
405 }; /* LINK_PROTECT_FLAGS_E_VER_1 */
406 
407 /**
408  * enum iwl_link_ctx_flags - link context flags
409  *
410  * @LINK_FLG_BSS_COLOR_DIS: BSS color disable, don't use the BSS
411  *	color for RX filter but use MAC header
412  *	enabled AGG, i.e. both BACK and non-BACK frames in a single AGG
413  * @LINK_FLG_MU_EDCA_CW: indicates that there is an element of MU EDCA
414  *	parameter set, i.e. the backoff counters for trig-based ACs
415  * @LINK_FLG_RU_2MHZ_BLOCK: indicates that 26-tone RU OFDMA transmission are
416  *      not allowed (as there are OBSS that might classify such transmissions as
417  *      radar pulses).
418  * @LINK_FLG_NDP_FEEDBACK_ENABLED: mark support for NDP feedback and change
419  *	of threshold
420  */
421 enum iwl_link_ctx_flags {
422 	LINK_FLG_BSS_COLOR_DIS		= BIT(0),
423 	LINK_FLG_MU_EDCA_CW		= BIT(1),
424 	LINK_FLG_RU_2MHZ_BLOCK		= BIT(2),
425 	LINK_FLG_NDP_FEEDBACK_ENABLED	= BIT(3),
426 }; /* LINK_CONTEXT_FLAG_E_VER_1 */
427 
428 /**
429  * struct iwl_link_config_cmd - command structure to configure the LINK context
430  *	in MLD API
431  * ( LINK_CONFIG_CMD =0x9 )
432  *
433  * @action: action to perform, see &enum iwl_ctxt_action
434  * @link_id: the id of the link that this cmd configures
435  * @mac_id: interface ID. Relevant only if action is FW_CTXT_ACTION_ADD
436  * @phy_id: PHY index. Can be changed only if the link was inactive
437  *	(and stays inactive). If the link is active (or becomes active),
438  *	this field is ignored.
439  * @local_link_addr: the links MAC address. Can be changed only if the link was
440  *	inactive (and stays inactive). If the link is active
441  *	(or becomes active), this field is ignored.
442  * @reserved_for_local_link_addr: reserved
443  * @modify_mask: from &enum iwl_link_ctx_modify_flags, selects what to change.
444  *	Relevant only if action is FW_CTXT_ACTION_MODIFY
445  * @active: indicates whether the link is active or not
446  * @listen_lmac: indicates whether the link should be allocated on the Listen
447  *	Lmac or on the Main Lmac. Cannot be changed on an active Link.
448  *	Relevant only for eSR.
449  * @reserved1: in version 2, listen_lmac became reserved
450  * @cck_rates: basic rates available for CCK
451  * @ofdm_rates: basic rates available for OFDM
452  * @cck_short_preamble: 1 for enabling short preamble, 0 otherwise
453  * @short_slot: 1 for enabling short slots, 0 otherwise
454  * @protection_flags: combination of &enum iwl_link_ctx_protection_flags
455  * @qos_flags: from &enum iwl_mac_qos_flags
456  * @ac: one iwl_mac_qos configuration for each AC
457  * @htc_trig_based_pkt_ext: default PE in 4us units
458  * @rand_alloc_ecwmin: random CWmin = 2**ECWmin-1
459  * @rand_alloc_ecwmax: random CWmax = 2**ECWmax-1
460  * @ndp_fdbk_buff_th_exp: set exponent for the NDP feedback buffered threshold
461  * @trig_based_txf: MU EDCA Parameter set for the trigger based traffic queues
462  * @bi: beacon interval in TU, applicable only when associated
463  * @dtim_interval: DTIM interval in TU.
464  *	Relevant only for GO, otherwise this is offloaded.
465  * @puncture_mask: puncture mask for EHT (removed in VER_3)
466  * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
467  * @flags: a combination from &enum iwl_link_ctx_flags
468  * @flags_mask: what of %flags have changed. Also &enum iwl_link_ctx_flags
469  * Below fields are for multi-bssid:
470  * @ref_bssid_addr: reference BSSID used by the AP
471  * @reserved_for_ref_bssid_addr: reserved
472  * @bssid_index: index of the associated VAP
473  * @bss_color: 11ax AP ID that is used in the HE SIG-A to mark inter BSS frame
474  * @spec_link_id: link_id as the AP knows it
475  * @reserved2: alignment
476  * @ibss_bssid_addr: bssid for ibss
477  * @reserved_for_ibss_bssid_addr: reserved
478  * @reserved3: reserved for future use
479  */
480 struct iwl_link_config_cmd {
481 	__le32 action;
482 	__le32 link_id;
483 	__le32 mac_id;
484 	__le32 phy_id;
485 	u8 local_link_addr[6];
486 	__le16 reserved_for_local_link_addr;
487 	__le32 modify_mask;
488 	__le32 active;
489 	union {
490 		__le32 listen_lmac;
491 		__le32 reserved1;
492 	};
493 	__le32 cck_rates;
494 	__le32 ofdm_rates;
495 	__le32 cck_short_preamble;
496 	__le32 short_slot;
497 	__le32 protection_flags;
498 	/* MAC_QOS_PARAM_API_S_VER_1 */
499 	__le32 qos_flags;
500 	struct iwl_ac_qos ac[AC_NUM + 1];
501 	u8 htc_trig_based_pkt_ext;
502 	u8 rand_alloc_ecwmin;
503 	u8 rand_alloc_ecwmax;
504 	u8 ndp_fdbk_buff_th_exp;
505 	struct iwl_he_backoff_conf trig_based_txf[AC_NUM];
506 	__le32 bi;
507 	__le32 dtim_interval;
508 	__le16 puncture_mask; /* removed in _VER_3 */
509 	__le16 frame_time_rts_th;
510 	__le32 flags;
511 	__le32 flags_mask;
512 	/* The below fields are for multi-bssid */
513 	u8 ref_bssid_addr[6];
514 	__le16 reserved_for_ref_bssid_addr;
515 	u8 bssid_index;
516 	u8 bss_color;
517 	u8 spec_link_id;
518 	u8 reserved2;
519 	u8 ibss_bssid_addr[6];
520 	__le16 reserved_for_ibss_bssid_addr;
521 	__le32 reserved3[8];
522 } __packed; /* LINK_CONTEXT_CONFIG_CMD_API_S_VER_1, _VER_2, _VER_3 */
523 
524 /* Currently FW supports link ids in the range 0-3 and can have
525  * at most two active links for each vif.
526  */
527 #define IWL_MVM_FW_MAX_ACTIVE_LINKS_NUM 2
528 #define IWL_MVM_FW_MAX_LINK_ID 3
529 
530 /**
531  * enum iwl_fw_sta_type - FW station types
532  * @STATION_TYPE_PEER: represents a peer - AP in BSS, a TDLS sta, a client in
533  *	P2P.
534  * @STATION_TYPE_BCAST_MGMT: The station used to send beacons and
535  *	probe responses. Also used for traffic injection in sniffer mode
536  * @STATION_TYPE_MCAST: the station used for BCAST / MCAST in GO. Will be
537  *	suspended / resumed at the right timing depending on the clients'
538  *	power save state and the DTIM timing
539  * @STATION_TYPE_AUX: aux sta. In the FW there is no need for a special type
540  *	for the aux sta, so this type is only for driver - internal use.
541  */
542 enum iwl_fw_sta_type {
543 	STATION_TYPE_PEER,
544 	STATION_TYPE_BCAST_MGMT,
545 	STATION_TYPE_MCAST,
546 	STATION_TYPE_AUX,
547 }; /* STATION_TYPE_E_VER_1 */
548 
549 /**
550  * struct iwl_mvm_sta_cfg_cmd - cmd structure to add a peer sta to the uCode's
551  *	station table
552  * ( STA_CONFIG_CMD = 0xA )
553  *
554  * @sta_id: index of station in uCode's station table
555  * @link_id: the id of the link that is used to communicate with this sta
556  * @peer_mld_address: the peers mld address
557  * @reserved_for_peer_mld_address: reserved
558  * @peer_link_address: the address of the link that is used to communicate
559  *	with this sta
560  * @reserved_for_peer_link_address: reserved
561  * @station_type: type of this station. See &enum iwl_fw_sta_type
562  * @assoc_id: for GO only
563  * @beamform_flags: beam forming controls
564  * @mfp: indicates whether the STA uses management frame protection or not.
565  * @mimo: indicates whether the sta uses mimo or not
566  * @mimo_protection: indicates whether the sta uses mimo protection or not
567  * @ack_enabled: indicates that the AP supports receiving ACK-
568  *	enabled AGG, i.e. both BACK and non-BACK frames in a single AGG
569  * @trig_rnd_alloc: indicates that trigger based random allocation
570  *	is enabled according to UORA element existence
571  * @tx_ampdu_spacing: minimum A-MPDU spacing:
572  *	4 - 2us density, 5 - 4us density, 6 - 8us density, 7 - 16us density
573  * @tx_ampdu_max_size: maximum A-MPDU length: 0 - 8K, 1 - 16K, 2 - 32K,
574  *	3 - 64K, 4 - 128K, 5 - 256K, 6 - 512K, 7 - 1024K.
575  * @sp_length: the size of the SP in actual number of frames
576  * @uapsd_acs:  4 LS bits are trigger enabled ACs, 4 MS bits are the deliver
577  *	enabled ACs.
578  * @pkt_ext: optional, exists according to PPE-present bit in the HE/EHT-PHY
579  *	capa
580  * @htc_flags: which features are supported in HTC
581  */
582 struct iwl_mvm_sta_cfg_cmd {
583 	__le32 sta_id;
584 	__le32 link_id;
585 	u8 peer_mld_address[ETH_ALEN];
586 	__le16 reserved_for_peer_mld_address;
587 	u8 peer_link_address[ETH_ALEN];
588 	__le16 reserved_for_peer_link_address;
589 	__le32 station_type;
590 	__le32 assoc_id;
591 	__le32 beamform_flags;
592 	__le32 mfp;
593 	__le32 mimo;
594 	__le32 mimo_protection;
595 	__le32 ack_enabled;
596 	__le32 trig_rnd_alloc;
597 	__le32 tx_ampdu_spacing;
598 	__le32 tx_ampdu_max_size;
599 	__le32 sp_length;
600 	__le32 uapsd_acs;
601 	struct iwl_he_pkt_ext_v2 pkt_ext;
602 	__le32 htc_flags;
603 } __packed; /* STA_CMD_API_S_VER_1 */
604 
605 /**
606  * struct iwl_mvm_aux_sta_cmd - command for AUX STA configuration
607  * ( AUX_STA_CMD = 0xB )
608  *
609  * @sta_id: index of aux sta to configure
610  * @lmac_id: ?
611  * @mac_addr: mac addr of the auxilary sta
612  * @reserved_for_mac_addr: reserved
613  */
614 struct iwl_mvm_aux_sta_cmd {
615 	__le32 sta_id;
616 	__le32 lmac_id;
617 	u8 mac_addr[ETH_ALEN];
618 	__le16 reserved_for_mac_addr;
619 
620 } __packed; /* AUX_STA_CMD_API_S_VER_1 */
621 
622 /**
623  * struct iwl_mvm_remove_sta_cmd - a cmd structure to remove a sta added by
624  *	STA_CONFIG_CMD or AUX_STA_CONFIG_CMD
625  * ( STA_REMOVE_CMD = 0xC )
626  *
627  * @sta_id: index of station to remove
628  */
629 struct iwl_mvm_remove_sta_cmd {
630 	__le32 sta_id;
631 } __packed; /* REMOVE_STA_API_S_VER_1 */
632 
633 /**
634  * struct iwl_mvm_sta_disable_tx_cmd - disable / re-enable tx to a sta
635  * ( STA_DISABLE_TX_CMD = 0xD )
636  *
637  * @sta_id: index of the station to disable tx to
638  * @disable: indicates if to disable or re-enable tx
639  */
640 struct iwl_mvm_sta_disable_tx_cmd {
641 	__le32 sta_id;
642 	__le32 disable;
643 } __packed; /* STA_DISABLE_TX_API_S_VER_1 */
644 
645 /**
646  * enum iwl_mvm_fw_esr_recommendation - FW recommendation code
647  * @ESR_RECOMMEND_LEAVE: recommendation to leave esr
648  * @ESR_FORCE_LEAVE: force exiting esr
649  * @ESR_RECOMMEND_ENTER: recommendation to enter esr
650  */
651 enum iwl_mvm_fw_esr_recommendation {
652 	ESR_RECOMMEND_LEAVE,
653 	ESR_FORCE_LEAVE,
654 	ESR_RECOMMEND_ENTER,
655 }; /* ESR_MODE_RECOMMENDATION_CODE_API_E_VER_1 */
656 
657 /**
658  * struct iwl_mvm_esr_mode_notif - FWs recommendation/force for esr mode
659  *
660  * @action: the action to apply on esr state. See &iwl_mvm_fw_esr_recommendation
661  */
662 struct iwl_mvm_esr_mode_notif {
663 	__le32 action;
664 } __packed; /* ESR_MODE_RECOMMENDATION_NTFY_API_S_VER_1 */
665 
666 #endif /* __iwl_fw_api_mac_cfg_h__ */
667