xref: /linux/drivers/net/wireless/intel/iwlwifi/fw/api/datapath.h (revision af2d6148d2a159e1a0862bce5a2c88c1618a2b27)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2024-2025 Intel Corporation
4  * Copyright (C) 2012-2014, 2018-2022 Intel Corporation
5  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
6  * Copyright (C) 2016-2017 Intel Deutschland GmbH
7  */
8 #ifndef __iwl_fw_api_datapath_h__
9 #define __iwl_fw_api_datapath_h__
10 
11 /**
12  * enum iwl_data_path_subcmd_ids - data path group commands
13  */
14 enum iwl_data_path_subcmd_ids {
15 	/**
16 	 * @DQA_ENABLE_CMD: &struct iwl_dqa_enable_cmd
17 	 */
18 	DQA_ENABLE_CMD = 0x0,
19 
20 	/**
21 	 * @UPDATE_MU_GROUPS_CMD: &struct iwl_mu_group_mgmt_cmd
22 	 */
23 	UPDATE_MU_GROUPS_CMD = 0x1,
24 
25 	/**
26 	 * @TRIGGER_RX_QUEUES_NOTIF_CMD: &struct iwl_rxq_sync_cmd
27 	 */
28 	TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
29 
30 	/**
31 	 * @WNM_PLATFORM_PTM_REQUEST_CMD: &struct iwl_time_sync_cfg_cmd
32 	 */
33 	WNM_PLATFORM_PTM_REQUEST_CMD = 0x3,
34 
35 	/**
36 	 * @WNM_80211V_TIMING_MEASUREMENT_CONFIG_CMD:
37 	 *	&struct iwl_time_sync_cfg_cmd
38 	 */
39 	WNM_80211V_TIMING_MEASUREMENT_CONFIG_CMD = 0x4,
40 
41 	/**
42 	 * @STA_HE_CTXT_CMD: &struct iwl_he_sta_context_cmd_v1,
43 	 *	&struct iwl_he_sta_context_cmd_v2 or
44 	 *	&struct iwl_he_sta_context_cmd_v3
45 	 */
46 	STA_HE_CTXT_CMD = 0x7,
47 
48 	/**
49 	 * @RLC_CONFIG_CMD: &struct iwl_rlc_config_cmd
50 	 */
51 	RLC_CONFIG_CMD = 0x8,
52 
53 	/**
54 	 * @RFH_QUEUE_CONFIG_CMD: &struct iwl_rfh_queue_config
55 	 */
56 	RFH_QUEUE_CONFIG_CMD = 0xD,
57 
58 	/**
59 	 * @TLC_MNG_CONFIG_CMD: &struct iwl_tlc_config_cmd_v4
60 	 */
61 	TLC_MNG_CONFIG_CMD = 0xF,
62 
63 	/**
64 	 * @HE_AIR_SNIFFER_CONFIG_CMD: &struct iwl_he_monitor_cmd
65 	 */
66 	HE_AIR_SNIFFER_CONFIG_CMD = 0x13,
67 
68 	/**
69 	 * @CHEST_COLLECTOR_FILTER_CONFIG_CMD: Configure the CSI
70 	 *	matrix collection, uses &struct iwl_channel_estimation_cfg
71 	 */
72 	CHEST_COLLECTOR_FILTER_CONFIG_CMD = 0x14,
73 
74 	/**
75 	 * @RX_BAID_ALLOCATION_CONFIG_CMD: Allocate/deallocate a BAID for an RX
76 	 *	blockack session, uses &struct iwl_rx_baid_cfg_cmd for the
77 	 *	command, and &struct iwl_rx_baid_cfg_resp as a response.
78 	 */
79 	RX_BAID_ALLOCATION_CONFIG_CMD = 0x16,
80 
81 	/**
82 	 * @SCD_QUEUE_CONFIG_CMD: new scheduler queue allocation/config/removal
83 	 *	command, uses &struct iwl_scd_queue_cfg_cmd and the response
84 	 *	is (same as before) &struct iwl_tx_queue_cfg_rsp.
85 	 */
86 	SCD_QUEUE_CONFIG_CMD = 0x17,
87 
88 	/**
89 	 * @SEC_KEY_CMD: security key command, uses &struct iwl_sec_key_cmd
90 	 */
91 	SEC_KEY_CMD = 0x18,
92 
93 	/**
94 	 * @OMI_SEND_STATUS_NOTIF: notification after OMI was sent
95 	 *	uses &struct iwl_omi_send_status_notif
96 	 */
97 	OMI_SEND_STATUS_NOTIF = 0xF2,
98 
99 	/**
100 	 * @ESR_MODE_NOTIF: notification to recommend/force a wanted esr mode,
101 	 *	uses &struct iwl_esr_mode_notif or &struct iwl_esr_mode_notif_v1
102 	 */
103 	ESR_MODE_NOTIF = 0xF3,
104 
105 	/**
106 	 * @MONITOR_NOTIF: Datapath monitoring notification, using
107 	 *	&struct iwl_datapath_monitor_notif
108 	 */
109 	MONITOR_NOTIF = 0xF4,
110 
111 	/**
112 	 * @RX_NO_DATA_NOTIF: &struct iwl_rx_no_data or &struct iwl_rx_no_data_ver_3
113 	 */
114 	RX_NO_DATA_NOTIF = 0xF5,
115 
116 	/**
117 	 * @THERMAL_DUAL_CHAIN_REQUEST: firmware request for SMPS mode,
118 	 *	&struct iwl_thermal_dual_chain_request
119 	 */
120 	THERMAL_DUAL_CHAIN_REQUEST = 0xF6,
121 
122 	/**
123 	 * @TLC_MNG_UPDATE_NOTIF: &struct iwl_tlc_update_notif
124 	 */
125 	TLC_MNG_UPDATE_NOTIF = 0xF7,
126 
127 	/**
128 	 * @BEACON_FILTER_IN_NOTIF: &struct iwl_beacon_filter_notif
129 	 */
130 	BEACON_FILTER_IN_NOTIF = 0xF8,
131 
132 	/**
133 	 * @STA_PM_NOTIF: &struct iwl_mvm_pm_state_notification
134 	 */
135 	STA_PM_NOTIF = 0xFD,
136 
137 	/**
138 	 * @MU_GROUP_MGMT_NOTIF: &struct iwl_mu_group_mgmt_notif
139 	 */
140 	MU_GROUP_MGMT_NOTIF = 0xFE,
141 
142 	/**
143 	 * @RX_QUEUES_NOTIFICATION: &struct iwl_rxq_sync_notification
144 	 */
145 	RX_QUEUES_NOTIFICATION = 0xFF,
146 };
147 
148 /**
149  * struct iwl_mu_group_mgmt_cmd - VHT MU-MIMO group configuration
150  *
151  * @reserved: reserved
152  * @membership_status: a bitmap of MU groups
153  * @user_position:the position of station in a group. If the station is in the
154  *	group then bits (group * 2) is the position -1
155  */
156 struct iwl_mu_group_mgmt_cmd {
157 	__le32 reserved;
158 	__le32 membership_status[2];
159 	__le32 user_position[4];
160 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
161 
162 /**
163  * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
164  *
165  * @membership_status: a bitmap of MU groups
166  * @user_position: the position of station in a group. If the station is in the
167  *	group then bits (group * 2) is the position -1
168  */
169 struct iwl_mu_group_mgmt_notif {
170 	__le32 membership_status[2];
171 	__le32 user_position[4];
172 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
173 
174 enum iwl_channel_estimation_flags {
175 	IWL_CHANNEL_ESTIMATION_ENABLE	= BIT(0),
176 	IWL_CHANNEL_ESTIMATION_TIMER	= BIT(1),
177 	IWL_CHANNEL_ESTIMATION_COUNTER	= BIT(2),
178 };
179 
180 enum iwl_time_sync_protocol_type {
181 	IWL_TIME_SYNC_PROTOCOL_TM	= BIT(0),
182 	IWL_TIME_SYNC_PROTOCOL_FTM	= BIT(1),
183 }; /* WNM_TIMING_ENABLED_PROTOCOL_API_E_VER_1 */
184 
185 /**
186  * struct iwl_time_sync_cfg_cmd - TM/FTM time sync measurement configuration
187  *
188  * @protocols: The type of frames to raise notifications for. A bitmap
189  *	of @iwl_time_sync_protocol_type
190  * @peer_addr: peer address with which TM/FTM measurements are required
191  * @reserved: for alignment
192  */
193 struct iwl_time_sync_cfg_cmd {
194 	__le32 protocols;
195 	u8 peer_addr[ETH_ALEN];
196 	u8 reserved[2];
197 } __packed; /* WNM_80211V_TIMING_MEASUREMENT_CONFIG_CMD_API_S_VER_1 */
198 
199 /**
200  * enum iwl_synced_time_operation - PTM request options
201  *
202  * @IWL_SYNCED_TIME_OPERATION_READ_ARTB: read only the ARTB time
203  * @IWL_SYNCED_TIME_OPERATION_READ_GP2: read only the GP2 time
204  * @IWL_SYNCED_TIME_OPERATION_READ_BOTH: latch the ARTB and GP2 clocks and
205  *	provide timestamps from both clocks for the same time point
206  */
207 enum iwl_synced_time_operation {
208 	IWL_SYNCED_TIME_OPERATION_READ_ARTB = 1,
209 	IWL_SYNCED_TIME_OPERATION_READ_GP2,
210 	IWL_SYNCED_TIME_OPERATION_READ_BOTH,
211 };
212 
213 /**
214  * struct iwl_synced_time_cmd - request synced GP2/ARTB timestamps
215  *
216  * @operation: one of &enum iwl_synced_time_operation
217  */
218 struct iwl_synced_time_cmd {
219 	__le32 operation;
220 } __packed; /* WNM_80211V_TIMING_CMD_API_S_VER_1 */
221 
222 /**
223  * struct iwl_synced_time_rsp - response to iwl_synced_time_cmd
224  *
225  * @operation: one of &enum iwl_synced_time_operation
226  * @platform_timestamp_hi: high DWORD of the ARTB clock timestamp in nanoseconds
227  * @platform_timestamp_lo: low DWORD of the ARTB clock timestamp in nanoseconds
228  * @gp2_timestamp_hi: high DWORD of the GP2 clock timestamp in 10's of
229  *	nanoseconds
230  * @gp2_timestamp_lo: low DWORD of the GP2 clock timestamp in 10's of
231  *	nanoseconds
232  */
233 struct iwl_synced_time_rsp {
234 	__le32 operation;
235 	__le32 platform_timestamp_hi;
236 	__le32 platform_timestamp_lo;
237 	__le32 gp2_timestamp_hi;
238 	__le32 gp2_timestamp_lo;
239 } __packed; /* WNM_80211V_TIMING_RSP_API_S_VER_1 */
240 
241 /* PTP_CTX_MAX_DATA_SIZE_IN_API_D_VER_1 */
242 #define PTP_CTX_MAX_DATA_SIZE   128
243 
244 /**
245  * struct iwl_time_msmt_ptp_ctx - Vendor specific element
246  * to allow a space for flexibility for the userspace App
247  *
248  * @ftm: FTM specific vendor element
249  * @ftm.element_id: element id of vendor specific ie
250  * @ftm.length: length of vendor specific ie
251  * @ftm.reserved: for alignment
252  * @ftm.data: vendor specific data blob
253  * @tm: TM specific vendor element
254  * @tm.element_id: element id of vendor specific ie
255  * @tm.length: length of vendor specific ie
256  * @tm.data: vendor specific data blob
257  */
258 struct iwl_time_msmt_ptp_ctx {
259 	/* Differentiate between FTM and TM specific Vendor elements */
260 	union {
261 		struct {
262 			u8 element_id;
263 			u8 length;
264 			__le16 reserved;
265 			u8 data[PTP_CTX_MAX_DATA_SIZE];
266 		} ftm;
267 		struct {
268 			u8 element_id;
269 			u8 length;
270 			u8 data[PTP_CTX_MAX_DATA_SIZE];
271 		} tm;
272 	};
273 } __packed /* PTP_CTX_VER_1 */;
274 
275 /**
276  * struct iwl_time_msmt_notify - Time Sync measurement notification
277  * for TM/FTM, along with additional meta data.
278  *
279  * @peer_addr: peer address
280  * @reserved: for alignment
281  * @dialog_token: measurement flow dialog token number
282  * @followup_dialog_token: Measurement flow previous dialog token number
283  * @t1_hi: high dword of t1-time of the Tx'ed action frame departure on
284  *	sender side in units of 10 nano seconds
285  * @t1_lo: low dword of t1-time of the Tx'ed action frame departure on
286  *	sender side in units of 10 nano seconds
287  * @t1_max_err: maximum t1-time error in units of 10 nano seconds
288  * @t4_hi: high dword of t4-time of the Rx'ed action frame's Ack arrival on
289  *	sender side in units of 10 nano seconds
290  * @t4_lo: low dword of t4-time of the Rx'ed action frame's Ack arrival on
291  *	sender side in units of 10 nano seconds
292  * @t4_max_err: maximum t4-time error in units of 10 nano seconds
293  * @t2_hi: high dword of t2-time of the Rx'ed action frame arrival on
294  *	receiver side in units of 10 nano seconds
295  * @t2_lo: low dword of t2-time of the Rx'ed action frame arrival on
296  *	receiver side in units of 10 nano seconds
297  * @t2_max_err: maximum t2-time error in units of 10 nano seconds
298  * @t3_hi: high dword of t3-time of the Tx'ed action frame's Ack departure on
299  *	receiver side in units of 10 nano seconds
300  * @t3_lo: low dword of t3-time of the Tx'ed action frame's Ack departure on
301  *	receiver side in units of 10 nano seconds
302  * @t3_max_err: maximum t3-time error in units of 10 nano seconds
303  * @ptp: vendor specific information element
304  */
305 struct iwl_time_msmt_notify {
306 	u8 peer_addr[ETH_ALEN];
307 	u8 reserved[2];
308 	__le32 dialog_token;
309 	__le32 followup_dialog_token;
310 	__le32 t1_hi;
311 	__le32 t1_lo;
312 	__le32 t1_max_err;
313 	__le32 t4_hi;
314 	__le32 t4_lo;
315 	__le32 t4_max_err;
316 	__le32 t2_hi;
317 	__le32 t2_lo;
318 	__le32 t2_max_err;
319 	__le32 t3_hi;
320 	__le32 t3_lo;
321 	__le32 t3_max_err;
322 	struct iwl_time_msmt_ptp_ctx ptp;
323 } __packed; /* WNM_80211V_TIMING_MEASUREMENT_NTFY_API_S_VER_1 */
324 
325 /**
326  * struct iwl_time_msmt_cfm_notify - Time Sync measurement confirmation
327  * notification for TM/FTM. Sent on receipt of 802.11 Ack from peer for the
328  * Tx'ed TM/FTM measurement action frame.
329  *
330  * @peer_addr: peer address
331  * @reserved: for alignment
332  * @dialog_token: measurement flow dialog token number
333  * @t1_hi: high dword of t1-time of the Tx'ed action frame departure on
334  *	sender side in units of 10 nano seconds
335  * @t1_lo: low dword of t1-time of the Tx'ed action frame departure on
336  *	sender side in units of 10 nano seconds
337  * @t1_max_err: maximum t1-time error in units of 10 nano seconds
338  * @t4_hi: high dword of t4-time of the Rx'ed action frame's Ack arrival on
339  *	sender side in units of 10 nano seconds
340  * @t4_lo: low dword of t4-time of the Rx'ed action frame's Ack arrival on
341  *	sender side in units of 10 nano seconds
342  * @t4_max_err: maximum t4-time error in units of 10 nano seconds
343  */
344 struct iwl_time_msmt_cfm_notify {
345 	u8 peer_addr[ETH_ALEN];
346 	u8 reserved[2];
347 	__le32 dialog_token;
348 	__le32 t1_hi;
349 	__le32 t1_lo;
350 	__le32 t1_max_err;
351 	__le32 t4_hi;
352 	__le32 t4_lo;
353 	__le32 t4_max_err;
354 } __packed; /* WNM_80211V_TIMING_MEASUREMENT_CONFIRM_NTFY_API_S_VER_1 */
355 
356 /**
357  * struct iwl_channel_estimation_cfg - channel estimation reporting config
358  */
359 struct iwl_channel_estimation_cfg {
360 	/**
361 	 * @flags: flags, see &enum iwl_channel_estimation_flags
362 	 */
363 	__le32 flags;
364 	/**
365 	 * @timer: if enabled via flags, automatically disable after this many
366 	 *	microseconds
367 	 */
368 	__le32 timer;
369 	/**
370 	 * @count: if enabled via flags, automatically disable after this many
371 	 *	frames with channel estimation matrix were captured
372 	 */
373 	__le32 count;
374 	/**
375 	 * @rate_n_flags_mask: only try to record the channel estimation matrix
376 	 *	if the rate_n_flags value for the received frame (let's call
377 	 *	that rx_rnf) matches the mask/value given here like this:
378 	 *	(rx_rnf & rate_n_flags_mask) == rate_n_flags_val.
379 	 */
380 	__le32 rate_n_flags_mask;
381 	/**
382 	 * @rate_n_flags_val: see @rate_n_flags_mask
383 	 */
384 	__le32 rate_n_flags_val;
385 	/**
386 	 * @reserved: reserved (for alignment)
387 	 */
388 	__le32 reserved;
389 	/**
390 	 * @frame_types: bitmap of frame types to capture, the received frame's
391 	 *	subtype|type takes 6 bits in the frame and the corresponding bit
392 	 *	in this field must be set to 1 to capture channel estimation for
393 	 *	that frame type. Set to all-ones to enable capturing for all
394 	 *	frame types.
395 	 */
396 	__le64 frame_types;
397 } __packed; /* CHEST_COLLECTOR_FILTER_CMD_API_S_VER_1 */
398 
399 enum iwl_datapath_monitor_notif_type {
400 	IWL_DP_MON_NOTIF_TYPE_EXT_CCA,
401 };
402 
403 struct iwl_datapath_monitor_notif {
404 	__le32 type;
405 	u8 link_id;
406 	u8 reserved[3];
407 } __packed; /* MONITOR_NTF_API_S_VER_1 */
408 
409 /**
410  * enum iwl_thermal_dual_chain_req_events - firmware SMPS request event
411  * @THERMAL_DUAL_CHAIN_REQ_ENABLE: (re-)enable dual-chain operation
412  *	(subject to other constraints)
413  * @THERMAL_DUAL_CHAIN_REQ_DISABLE: disable dual-chain operation
414  *	(static SMPS)
415  */
416 enum iwl_thermal_dual_chain_req_events {
417 	THERMAL_DUAL_CHAIN_REQ_ENABLE,
418 	THERMAL_DUAL_CHAIN_REQ_DISABLE,
419 }; /* THERMAL_DUAL_CHAIN_DISABLE_STATE_API_E_VER_1 */
420 
421 /**
422  * struct iwl_thermal_dual_chain_request - SMPS request
423  * @event: the type of request, see &enum iwl_thermal_dual_chain_req_events
424  */
425 struct iwl_thermal_dual_chain_request {
426 	__le32 event;
427 } __packed; /* THERMAL_DUAL_CHAIN_DISABLE_REQ_NTFY_API_S_VER_1 */
428 
429 enum iwl_rlc_chain_info {
430 	IWL_RLC_CHAIN_INFO_DRIVER_FORCE		= BIT(0),
431 	IWL_RLC_CHAIN_INFO_VALID		= 0x000e,
432 	IWL_RLC_CHAIN_INFO_FORCE		= 0x0070,
433 	IWL_RLC_CHAIN_INFO_FORCE_MIMO		= 0x0380,
434 	IWL_RLC_CHAIN_INFO_COUNT		= 0x0c00,
435 	IWL_RLC_CHAIN_INFO_MIMO_COUNT		= 0x3000,
436 };
437 
438 /**
439  * struct iwl_rlc_properties - RLC properties
440  * @rx_chain_info: RX chain info, &enum iwl_rlc_chain_info
441  * @reserved: reserved
442  */
443 struct iwl_rlc_properties {
444 	__le32 rx_chain_info;
445 	__le32 reserved;
446 } __packed; /* RLC_PROPERTIES_S_VER_1 */
447 
448 enum iwl_sad_mode {
449 	IWL_SAD_MODE_ENABLED		= BIT(0),
450 	IWL_SAD_MODE_DEFAULT_ANT_MSK	= 0x6,
451 	IWL_SAD_MODE_DEFAULT_ANT_FW	= 0x0,
452 	IWL_SAD_MODE_DEFAULT_ANT_A	= 0x2,
453 	IWL_SAD_MODE_DEFAULT_ANT_B	= 0x4,
454 };
455 
456 /**
457  * struct iwl_sad_properties - SAD properties
458  * @chain_a_sad_mode: chain A SAD mode, &enum iwl_sad_mode
459  * @chain_b_sad_mode: chain B SAD mode, &enum iwl_sad_mode
460  * @mac_id: MAC index
461  * @reserved: reserved
462  */
463 struct iwl_sad_properties {
464 	__le32 chain_a_sad_mode;
465 	__le32 chain_b_sad_mode;
466 	__le32 mac_id;
467 	__le32 reserved;
468 } __packed;
469 
470 /**
471  * struct iwl_rlc_config_cmd - RLC configuration
472  * @phy_id: PHY index
473  * @rlc: RLC properties, &struct iwl_rlc_properties
474  * @sad: SAD (single antenna diversity) options, &struct iwl_sad_properties
475  * @flags: flags (unused)
476  * @reserved: reserved
477  */
478 struct iwl_rlc_config_cmd {
479 	__le32 phy_id;
480 	struct iwl_rlc_properties rlc;
481 	struct iwl_sad_properties sad;
482 	u8 flags;
483 	u8 reserved[3];
484 } __packed; /* RLC_CONFIG_CMD_API_S_VER_2 */
485 
486 #define IWL_MAX_BAID_OLD	16 /* MAX_IMMEDIATE_BA_API_D_VER_2 */
487 #define IWL_MAX_BAID		32 /* MAX_IMMEDIATE_BA_API_D_VER_3 */
488 
489 /**
490  * enum iwl_rx_baid_action - BAID allocation/config action
491  * @IWL_RX_BAID_ACTION_ADD: add a new BAID session
492  * @IWL_RX_BAID_ACTION_MODIFY: modify the BAID session
493  * @IWL_RX_BAID_ACTION_REMOVE: remove the BAID session
494  */
495 enum iwl_rx_baid_action {
496 	IWL_RX_BAID_ACTION_ADD,
497 	IWL_RX_BAID_ACTION_MODIFY,
498 	IWL_RX_BAID_ACTION_REMOVE,
499 }; /*  RX_BAID_ALLOCATION_ACTION_E_VER_1 */
500 
501 /**
502  * struct iwl_rx_baid_cfg_cmd_alloc - BAID allocation data
503  * @sta_id_mask: station ID mask
504  * @tid: the TID for this session
505  * @reserved: reserved
506  * @ssn: the starting sequence number
507  * @win_size: RX BA session window size
508  */
509 struct iwl_rx_baid_cfg_cmd_alloc {
510 	__le32 sta_id_mask;
511 	u8 tid;
512 	u8 reserved[3];
513 	__le16 ssn;
514 	__le16 win_size;
515 } __packed; /* RX_BAID_ALLOCATION_ADD_CMD_API_S_VER_1 */
516 
517 /**
518  * struct iwl_rx_baid_cfg_cmd_modify - BAID modification data
519  * @old_sta_id_mask: old station ID mask
520  * @new_sta_id_mask: new station ID mask
521  * @tid: TID of the BAID
522  */
523 struct iwl_rx_baid_cfg_cmd_modify {
524 	__le32 old_sta_id_mask;
525 	__le32 new_sta_id_mask;
526 	__le32 tid;
527 } __packed; /* RX_BAID_ALLOCATION_MODIFY_CMD_API_S_VER_2 */
528 
529 /**
530  * struct iwl_rx_baid_cfg_cmd_remove_v1 - BAID removal data
531  * @baid: the BAID to remove
532  */
533 struct iwl_rx_baid_cfg_cmd_remove_v1 {
534 	__le32 baid;
535 } __packed; /* RX_BAID_ALLOCATION_REMOVE_CMD_API_S_VER_1 */
536 
537 /**
538  * struct iwl_rx_baid_cfg_cmd_remove - BAID removal data
539  * @sta_id_mask: the station mask of the BAID to remove
540  * @tid: the TID of the BAID to remove
541  */
542 struct iwl_rx_baid_cfg_cmd_remove {
543 	__le32 sta_id_mask;
544 	__le32 tid;
545 } __packed; /* RX_BAID_ALLOCATION_REMOVE_CMD_API_S_VER_2 */
546 
547 /**
548  * struct iwl_rx_baid_cfg_cmd - BAID allocation/config command
549  * @action: the action, from &enum iwl_rx_baid_action
550  * @alloc: allocation data
551  * @modify: modify data
552  * @remove_v1: remove data (version 1)
553  * @remove: remove data
554  */
555 struct iwl_rx_baid_cfg_cmd {
556 	__le32 action;
557 	union {
558 		struct iwl_rx_baid_cfg_cmd_alloc alloc;
559 		struct iwl_rx_baid_cfg_cmd_modify modify;
560 		struct iwl_rx_baid_cfg_cmd_remove_v1 remove_v1;
561 		struct iwl_rx_baid_cfg_cmd_remove remove;
562 	}; /* RX_BAID_ALLOCATION_OPERATION_API_U_VER_2 */
563 } __packed; /* RX_BAID_ALLOCATION_CONFIG_CMD_API_S_VER_2 */
564 
565 /**
566  * struct iwl_rx_baid_cfg_resp - BAID allocation response
567  * @baid: the allocated BAID
568  */
569 struct iwl_rx_baid_cfg_resp {
570 	__le32 baid;
571 }; /* RX_BAID_ALLOCATION_RESPONSE_API_S_VER_1 */
572 
573 /**
574  * enum iwl_scd_queue_cfg_operation - scheduler queue operation
575  * @IWL_SCD_QUEUE_ADD: allocate a new queue
576  * @IWL_SCD_QUEUE_REMOVE: remove a queue
577  * @IWL_SCD_QUEUE_MODIFY: modify a queue
578  */
579 enum iwl_scd_queue_cfg_operation {
580 	IWL_SCD_QUEUE_ADD = 0,
581 	IWL_SCD_QUEUE_REMOVE = 1,
582 	IWL_SCD_QUEUE_MODIFY = 2,
583 };
584 
585 /**
586  * struct iwl_scd_queue_cfg_cmd - scheduler queue allocation command
587  * @operation: the operation, see &enum iwl_scd_queue_cfg_operation
588  * @u: union depending on command usage
589  * @u.add.sta_mask: station mask
590  * @u.add.tid: TID
591  * @u.add.reserved: reserved
592  * @u.add.flags: flags from &enum iwl_tx_queue_cfg_actions, except
593  *	%TX_QUEUE_CFG_ENABLE_QUEUE is not valid
594  * @u.add.cb_size: size code
595  * @u.add.bc_dram_addr: byte-count table IOVA
596  * @u.add.tfdq_dram_addr: TFD queue IOVA
597  * @u.remove.sta_mask: station mask of queue to remove
598  * @u.remove.tid: TID of queue to remove
599  * @u.modify.old_sta_mask: old station mask for modify
600  * @u.modify.tid: TID of queue to modify
601  * @u.modify.new_sta_mask: new station mask for modify
602  */
603 struct iwl_scd_queue_cfg_cmd {
604 	__le32 operation;
605 	union {
606 		struct {
607 			__le32 sta_mask;
608 			u8 tid;
609 			u8 reserved[3];
610 			__le32 flags;
611 			__le32 cb_size;
612 			__le64 bc_dram_addr;
613 			__le64 tfdq_dram_addr;
614 		} __packed add; /* TX_QUEUE_CFG_CMD_ADD_API_S_VER_1 */
615 		struct {
616 			__le32 sta_mask;
617 			__le32 tid;
618 		} __packed remove; /* TX_QUEUE_CFG_CMD_REMOVE_API_S_VER_1 */
619 		struct {
620 			__le32 old_sta_mask;
621 			__le32 tid;
622 			__le32 new_sta_mask;
623 		} __packed modify; /* TX_QUEUE_CFG_CMD_MODIFY_API_S_VER_1 */
624 	} __packed u; /* TX_QUEUE_CFG_CMD_OPERATION_API_U_VER_1 */
625 } __packed; /* TX_QUEUE_CFG_CMD_API_S_VER_3 */
626 
627 /**
628  * enum iwl_sec_key_flags - security key command key flags
629  * @IWL_SEC_KEY_FLAG_CIPHER_MASK: cipher mask
630  * @IWL_SEC_KEY_FLAG_CIPHER_WEP: WEP cipher
631  * @IWL_SEC_KEY_FLAG_CIPHER_CCMP: CCMP/CMAC cipher
632  * @IWL_SEC_KEY_FLAG_CIPHER_TKIP: TKIP cipher
633  * @IWL_SEC_KEY_FLAG_CIPHER_GCMP: GCMP/GMAC cipher
634  * @IWL_SEC_KEY_FLAG_NO_TX: don't install for TX
635  * @IWL_SEC_KEY_FLAG_KEY_SIZE: large key size (WEP-104, GCMP-256, GMAC-256)
636  * @IWL_SEC_KEY_FLAG_MFP: MFP is in used for this key
637  * @IWL_SEC_KEY_FLAG_MCAST_KEY: this is a multicast key
638  * @IWL_SEC_KEY_FLAG_SPP_AMSDU: SPP A-MSDU should be used
639  */
640 enum iwl_sec_key_flags {
641 	IWL_SEC_KEY_FLAG_CIPHER_MASK	= 0x07,
642 	IWL_SEC_KEY_FLAG_CIPHER_WEP	= 0x01,
643 	IWL_SEC_KEY_FLAG_CIPHER_CCMP	= 0x02,
644 	IWL_SEC_KEY_FLAG_CIPHER_TKIP	= 0x03,
645 	IWL_SEC_KEY_FLAG_CIPHER_GCMP	= 0x05,
646 	IWL_SEC_KEY_FLAG_NO_TX		= 0x08,
647 	IWL_SEC_KEY_FLAG_KEY_SIZE	= 0x10,
648 	IWL_SEC_KEY_FLAG_MFP		= 0x20,
649 	IWL_SEC_KEY_FLAG_MCAST_KEY	= 0x40,
650 	IWL_SEC_KEY_FLAG_SPP_AMSDU	= 0x80,
651 };
652 
653 #define IWL_SEC_WEP_KEY_OFFSET	3
654 
655 /**
656  * struct iwl_sec_key_cmd - security key command
657  * @action: action from &enum iwl_ctxt_action
658  * @u: union depending on command type
659  * @u.add.sta_mask: station mask for the new key
660  * @u.add.key_id: key ID (0-7) for the new key
661  * @u.add.key_flags: key flags per &enum iwl_sec_key_flags
662  * @u.add.key: key material. WEP keys should start from &IWL_SEC_WEP_KEY_OFFSET.
663  * @u.add.tkip_mic_rx_key: TKIP MIC RX key
664  * @u.add.tkip_mic_tx_key: TKIP MIC TX key
665  * @u.add.rx_seq: RX sequence counter value
666  * @u.add.tx_seq: TX sequence counter value
667  * @u.modify.old_sta_mask: old station mask
668  * @u.modify.new_sta_mask: new station mask
669  * @u.modify.key_id: key ID
670  * @u.modify.key_flags: new key flags
671  * @u.remove.sta_mask: station mask
672  * @u.remove.key_id: key ID
673  * @u.remove.key_flags: key flags
674  */
675 struct iwl_sec_key_cmd {
676 	__le32 action;
677 	union {
678 		struct {
679 			__le32 sta_mask;
680 			__le32 key_id;
681 			__le32 key_flags;
682 			u8 key[32];
683 			u8 tkip_mic_rx_key[8];
684 			u8 tkip_mic_tx_key[8];
685 			__le64 rx_seq;
686 			__le64 tx_seq;
687 		} __packed add; /* SEC_KEY_ADD_CMD_API_S_VER_1 */
688 		struct {
689 			__le32 old_sta_mask;
690 			__le32 new_sta_mask;
691 			__le32 key_id;
692 			__le32 key_flags;
693 		} __packed modify; /* SEC_KEY_MODIFY_CMD_API_S_VER_1 */
694 		struct {
695 			__le32 sta_mask;
696 			__le32 key_id;
697 			__le32 key_flags;
698 		} __packed remove; /* SEC_KEY_REMOVE_CMD_API_S_VER_1 */
699 	} __packed u; /* SEC_KEY_OPERATION_API_U_VER_1 */
700 } __packed; /* SEC_KEY_CMD_API_S_VER_1 */
701 
702 /**
703  * struct iwl_omi_send_status_notif_v1 - OMI status notification
704  * @success: indicates that the OMI was sent successfully
705  *	(currently always set)
706  */
707 struct iwl_omi_send_status_notif_v1 {
708 	__le32 success;
709 } __packed; /* OMI_SEND_STATUS_NTFY_API_S_VER_1 */
710 
711 /**
712  * struct iwl_omi_send_status_notif - OMI status notification
713  * @success: indicates that the OMI was sent successfully
714  *	(currently always set)
715  * @sta_id: sta_id to which the OMI was sent
716  */
717 struct iwl_omi_send_status_notif {
718 	__le32 success;
719 	__le32 sta_id;
720 } __packed; /* OMI_SEND_STATUS_NTFY_API_S_VER_2 */
721 
722 #endif /* __iwl_fw_api_datapath_h__ */
723