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