xref: /linux/drivers/net/wireless/intel/iwlwifi/fw/api/power.h (revision 90d32e92011eaae8e70a9169b4e7acf4ca8f9d3a)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2012-2014, 2018-2024 Intel Corporation
4  * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
5  * Copyright (C) 2015-2017 Intel Deutschland GmbH
6  */
7 #ifndef __iwl_fw_api_power_h__
8 #define __iwl_fw_api_power_h__
9 
10 /* Power Management Commands, Responses, Notifications */
11 
12 /**
13  * enum iwl_ltr_config_flags - masks for LTR config command flags
14  * @LTR_CFG_FLAG_FEATURE_ENABLE: Feature operational status
15  * @LTR_CFG_FLAG_HW_DIS_ON_SHADOW_REG_ACCESS: allow LTR change on shadow
16  *	memory access
17  * @LTR_CFG_FLAG_HW_EN_SHRT_WR_THROUGH: allow LTR msg send on ANY LTR
18  *	reg change
19  * @LTR_CFG_FLAG_HW_DIS_ON_D0_2_D3: allow LTR msg send on transition from
20  *	D0 to D3
21  * @LTR_CFG_FLAG_SW_SET_SHORT: fixed static short LTR register
22  * @LTR_CFG_FLAG_SW_SET_LONG: fixed static short LONG register
23  * @LTR_CFG_FLAG_DENIE_C10_ON_PD: allow going into C10 on PD
24  * @LTR_CFG_FLAG_UPDATE_VALUES: update config values and short
25  *	idle timeout
26  */
27 enum iwl_ltr_config_flags {
28 	LTR_CFG_FLAG_FEATURE_ENABLE = BIT(0),
29 	LTR_CFG_FLAG_HW_DIS_ON_SHADOW_REG_ACCESS = BIT(1),
30 	LTR_CFG_FLAG_HW_EN_SHRT_WR_THROUGH = BIT(2),
31 	LTR_CFG_FLAG_HW_DIS_ON_D0_2_D3 = BIT(3),
32 	LTR_CFG_FLAG_SW_SET_SHORT = BIT(4),
33 	LTR_CFG_FLAG_SW_SET_LONG = BIT(5),
34 	LTR_CFG_FLAG_DENIE_C10_ON_PD = BIT(6),
35 	LTR_CFG_FLAG_UPDATE_VALUES = BIT(7),
36 };
37 
38 /**
39  * struct iwl_ltr_config_cmd_v1 - configures the LTR
40  * @flags: See &enum iwl_ltr_config_flags
41  * @static_long: static LTR Long register value.
42  * @static_short: static LTR Short register value.
43  */
44 struct iwl_ltr_config_cmd_v1 {
45 	__le32 flags;
46 	__le32 static_long;
47 	__le32 static_short;
48 } __packed; /* LTR_CAPABLE_API_S_VER_1 */
49 
50 #define LTR_VALID_STATES_NUM 4
51 
52 /**
53  * struct iwl_ltr_config_cmd - configures the LTR
54  * @flags: See &enum iwl_ltr_config_flags
55  * @static_long: static LTR Long register value.
56  * @static_short: static LTR Short register value.
57  * @ltr_cfg_values: LTR parameters table values (in usec) in folowing order:
58  *	TX, RX, Short Idle, Long Idle. Used only if %LTR_CFG_FLAG_UPDATE_VALUES
59  *	is set.
60  * @ltr_short_idle_timeout: LTR Short Idle timeout (in usec). Used only if
61  *	%LTR_CFG_FLAG_UPDATE_VALUES is set.
62  */
63 struct iwl_ltr_config_cmd {
64 	__le32 flags;
65 	__le32 static_long;
66 	__le32 static_short;
67 	__le32 ltr_cfg_values[LTR_VALID_STATES_NUM];
68 	__le32 ltr_short_idle_timeout;
69 } __packed; /* LTR_CAPABLE_API_S_VER_2 */
70 
71 /* Radio LP RX Energy Threshold measured in dBm */
72 #define POWER_LPRX_RSSI_THRESHOLD	75
73 #define POWER_LPRX_RSSI_THRESHOLD_MAX	94
74 #define POWER_LPRX_RSSI_THRESHOLD_MIN	30
75 
76 /**
77  * enum iwl_power_flags - masks for power table command flags
78  * @POWER_FLAGS_POWER_SAVE_ENA_MSK: '1' Allow to save power by turning off
79  *		receiver and transmitter. '0' - does not allow.
80  * @POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK: '0' Driver disables power management,
81  *		'1' Driver enables PM (use rest of parameters)
82  * @POWER_FLAGS_SKIP_OVER_DTIM_MSK: '0' PM have to walk up every DTIM,
83  *		'1' PM could sleep over DTIM till listen Interval.
84  * @POWER_FLAGS_SNOOZE_ENA_MSK: Enable snoozing only if uAPSD is enabled and all
85  *		access categories are both delivery and trigger enabled.
86  * @POWER_FLAGS_BT_SCO_ENA: Enable BT SCO coex only if uAPSD and
87  *		PBW Snoozing enabled
88  * @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask
89  * @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable.
90  * @POWER_FLAGS_UAPSD_MISBEHAVING_ENA_MSK: AP/GO's uAPSD misbehaving
91  *		detection enablement
92 */
93 enum iwl_power_flags {
94 	POWER_FLAGS_POWER_SAVE_ENA_MSK		= BIT(0),
95 	POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK	= BIT(1),
96 	POWER_FLAGS_SKIP_OVER_DTIM_MSK		= BIT(2),
97 	POWER_FLAGS_SNOOZE_ENA_MSK		= BIT(5),
98 	POWER_FLAGS_BT_SCO_ENA			= BIT(8),
99 	POWER_FLAGS_ADVANCE_PM_ENA_MSK		= BIT(9),
100 	POWER_FLAGS_LPRX_ENA_MSK		= BIT(11),
101 	POWER_FLAGS_UAPSD_MISBEHAVING_ENA_MSK	= BIT(12),
102 };
103 
104 #define IWL_POWER_VEC_SIZE 5
105 
106 /**
107  * struct iwl_powertable_cmd - legacy power command. Beside old API support this
108  *	is used also with a new	power API for device wide power settings.
109  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
110  *
111  * @flags:		Power table command flags from POWER_FLAGS_*
112  * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
113  *			Minimum allowed:- 3 * DTIM. Keep alive period must be
114  *			set regardless of power scheme or current power state.
115  *			FW use this value also when PM is disabled.
116  * @debug_flags:	debug flags
117  * @rx_data_timeout:    Minimum time (usec) from last Rx packet for AM to
118  *			PSM transition - legacy PM
119  * @tx_data_timeout:    Minimum time (usec) from last Tx packet for AM to
120  *			PSM transition - legacy PM
121  * @sleep_interval:	not in use
122  * @skip_dtim_periods:	Number of DTIM periods to skip if Skip over DTIM flag
123  *			is set. For example, if it is required to skip over
124  *			one DTIM, this value need to be set to 2 (DTIM periods).
125  * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
126  *			Default: 80dbm
127  */
128 struct iwl_powertable_cmd {
129 	/* PM_POWER_TABLE_CMD_API_S_VER_6 */
130 	__le16 flags;
131 	u8 keep_alive_seconds;
132 	u8 debug_flags;
133 	__le32 rx_data_timeout;
134 	__le32 tx_data_timeout;
135 	__le32 sleep_interval[IWL_POWER_VEC_SIZE];
136 	__le32 skip_dtim_periods;
137 	__le32 lprx_rssi_threshold;
138 } __packed;
139 
140 /**
141  * enum iwl_device_power_flags - masks for device power command flags
142  * @DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK:
143  *	'1' Allow to save power by turning off
144  *	receiver and transmitter. '0' - does not allow.
145  * @DEVICE_POWER_FLAGS_ALLOW_MEM_RETENTION_MSK:
146  *	Device Retention indication, '1' indicate retention is enabled.
147  * @DEVICE_POWER_FLAGS_NO_SLEEP_TILL_D3_MSK:
148  *	Prevent power save until entering d3 is completed.
149  * @DEVICE_POWER_FLAGS_32K_CLK_VALID_MSK:
150  *	32Khz external slow clock valid indication, '1' indicate cloack is
151  *	valid.
152 */
153 enum iwl_device_power_flags {
154 	DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK		= BIT(0),
155 	DEVICE_POWER_FLAGS_ALLOW_MEM_RETENTION_MSK	= BIT(1),
156 	DEVICE_POWER_FLAGS_NO_SLEEP_TILL_D3_MSK		= BIT(7),
157 	DEVICE_POWER_FLAGS_32K_CLK_VALID_MSK		= BIT(12),
158 };
159 
160 /**
161  * struct iwl_device_power_cmd - device wide power command.
162  * DEVICE_POWER_CMD = 0x77 (command, has simple generic response)
163  *
164  * @flags:	Power table command flags from &enum iwl_device_power_flags
165  * @reserved: reserved (padding)
166  */
167 struct iwl_device_power_cmd {
168 	/* PM_POWER_TABLE_CMD_API_S_VER_7 */
169 	__le16 flags;
170 	__le16 reserved;
171 } __packed;
172 
173 /**
174  * struct iwl_mac_power_cmd - New power command containing uAPSD support
175  * MAC_PM_POWER_TABLE = 0xA9 (command, has simple generic response)
176  * @id_and_color:	MAC contex identifier, &enum iwl_ctxt_id_and_color
177  * @flags:		Power table command flags from POWER_FLAGS_*
178  * @keep_alive_seconds:	Keep alive period in seconds. Default - 25 sec.
179  *			Minimum allowed:- 3 * DTIM. Keep alive period must be
180  *			set regardless of power scheme or current power state.
181  *			FW use this value also when PM is disabled.
182  * @rx_data_timeout:    Minimum time (usec) from last Rx packet for AM to
183  *			PSM transition - legacy PM
184  * @tx_data_timeout:    Minimum time (usec) from last Tx packet for AM to
185  *			PSM transition - legacy PM
186  * @skip_dtim_periods:	Number of DTIM periods to skip if Skip over DTIM flag
187  *			is set. For example, if it is required to skip over
188  *			one DTIM, this value need to be set to 2 (DTIM periods).
189  * @rx_data_timeout_uapsd: Minimum time (usec) from last Rx packet for AM to
190  *			PSM transition - uAPSD
191  * @tx_data_timeout_uapsd: Minimum time (usec) from last Tx packet for AM to
192  *			PSM transition - uAPSD
193  * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
194  *			Default: 80dbm
195  * @snooze_interval:	Maximum time between attempts to retrieve buffered data
196  *			from the AP [msec]
197  * @snooze_window:	A window of time in which PBW snoozing insures that all
198  *			packets received. It is also the minimum time from last
199  *			received unicast RX packet, before client stops snoozing
200  *			for data. [msec]
201  * @snooze_step:	TBD
202  * @qndp_tid:		TID client shall use for uAPSD QNDP triggers
203  * @uapsd_ac_flags:	Set trigger-enabled and delivery-enabled indication for
204  *			each corresponding AC.
205  *			Use IEEE80211_WMM_IE_STA_QOSINFO_AC* for correct values.
206  * @uapsd_max_sp:	Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct
207  *			values.
208  * @heavy_tx_thld_packets:	TX threshold measured in number of packets
209  * @heavy_rx_thld_packets:	RX threshold measured in number of packets
210  * @heavy_tx_thld_percentage:	TX threshold measured in load's percentage
211  * @heavy_rx_thld_percentage:	RX threshold measured in load's percentage
212  * @limited_ps_threshold: (unused)
213  * @reserved: reserved (padding)
214  */
215 struct iwl_mac_power_cmd {
216 	/* CONTEXT_DESC_API_T_VER_1 */
217 	__le32 id_and_color;
218 
219 	/* CLIENT_PM_POWER_TABLE_S_VER_1 */
220 	__le16 flags;
221 	__le16 keep_alive_seconds;
222 	__le32 rx_data_timeout;
223 	__le32 tx_data_timeout;
224 	__le32 rx_data_timeout_uapsd;
225 	__le32 tx_data_timeout_uapsd;
226 	u8 lprx_rssi_threshold;
227 	u8 skip_dtim_periods;
228 	__le16 snooze_interval;
229 	__le16 snooze_window;
230 	u8 snooze_step;
231 	u8 qndp_tid;
232 	u8 uapsd_ac_flags;
233 	u8 uapsd_max_sp;
234 	u8 heavy_tx_thld_packets;
235 	u8 heavy_rx_thld_packets;
236 	u8 heavy_tx_thld_percentage;
237 	u8 heavy_rx_thld_percentage;
238 	u8 limited_ps_threshold;
239 	u8 reserved;
240 } __packed;
241 
242 /*
243  * struct iwl_uapsd_misbehaving_ap_notif - FW sends this notification when
244  * associated AP is identified as improperly implementing uAPSD protocol.
245  * PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78
246  * @sta_id: index of station in uCode's station table - associated AP ID in
247  *	    this context.
248  */
249 struct iwl_uapsd_misbehaving_ap_notif {
250 	__le32 sta_id;
251 	u8 mac_id;
252 	u8 reserved[3];
253 } __packed;
254 
255 /**
256  * struct iwl_reduce_tx_power_cmd - TX power reduction command
257  * REDUCE_TX_POWER_CMD = 0x9f
258  * @flags: (reserved for future implementation)
259  * @mac_context_id: id of the mac ctx for which we are reducing TX power.
260  * @pwr_restriction: TX power restriction in dBms.
261  */
262 struct iwl_reduce_tx_power_cmd {
263 	u8 flags;
264 	u8 mac_context_id;
265 	__le16 pwr_restriction;
266 } __packed; /* TX_REDUCED_POWER_API_S_VER_1 */
267 
268 enum iwl_dev_tx_power_cmd_mode {
269 	IWL_TX_POWER_MODE_SET_MAC = 0,
270 	IWL_TX_POWER_MODE_SET_DEVICE = 1,
271 	IWL_TX_POWER_MODE_SET_CHAINS = 2,
272 	IWL_TX_POWER_MODE_SET_ACK = 3,
273 	IWL_TX_POWER_MODE_SET_SAR_TIMER = 4,
274 	IWL_TX_POWER_MODE_SET_SAR_TIMER_DEFAULT_TABLE = 5,
275 }; /* TX_POWER_REDUCED_FLAGS_TYPE_API_E_VER_5 */;
276 
277 #define IWL_NUM_CHAIN_TABLES	1
278 #define IWL_NUM_CHAIN_TABLES_V2	2
279 #define IWL_NUM_CHAIN_LIMITS	2
280 #define IWL_NUM_SUB_BANDS_V1	5
281 #define IWL_NUM_SUB_BANDS_V2	11
282 
283 /**
284  * struct iwl_dev_tx_power_common - Common part of the TX power reduction cmd
285  * @set_mode: see &enum iwl_dev_tx_power_cmd_mode
286  * @mac_context_id: id of the mac ctx for which we are reducing TX power.
287  * @pwr_restriction: TX power restriction in 1/8 dBms.
288  * @dev_24: device TX power restriction in 1/8 dBms
289  * @dev_52_low: device TX power restriction upper band - low
290  * @dev_52_high: device TX power restriction upper band - high
291  */
292 struct iwl_dev_tx_power_common {
293 	__le32 set_mode;
294 	__le32 mac_context_id;
295 	__le16 pwr_restriction;
296 	__le16 dev_24;
297 	__le16 dev_52_low;
298 	__le16 dev_52_high;
299 };
300 
301 /**
302  * struct iwl_dev_tx_power_cmd_v3 - TX power reduction command version 3
303  * @per_chain: per chain restrictions
304  */
305 struct iwl_dev_tx_power_cmd_v3 {
306 	__le16 per_chain[IWL_NUM_CHAIN_TABLES][IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V1];
307 } __packed; /* TX_REDUCED_POWER_API_S_VER_3 */
308 
309 #define IWL_DEV_MAX_TX_POWER 0x7FFF
310 
311 /**
312  * struct iwl_dev_tx_power_cmd_v4 - TX power reduction command version 4
313  * @per_chain: per chain restrictions
314  * @enable_ack_reduction: enable or disable close range ack TX power
315  *	reduction.
316  * @reserved: reserved (padding)
317  */
318 struct iwl_dev_tx_power_cmd_v4 {
319 	__le16 per_chain[IWL_NUM_CHAIN_TABLES][IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V1];
320 	u8 enable_ack_reduction;
321 	u8 reserved[3];
322 } __packed; /* TX_REDUCED_POWER_API_S_VER_4 */
323 
324 /**
325  * struct iwl_dev_tx_power_cmd_v5 - TX power reduction command version 5
326  * @per_chain: per chain restrictions
327  * @enable_ack_reduction: enable or disable close range ack TX power
328  *	reduction.
329  * @per_chain_restriction_changed: is per_chain_restriction has changed
330  *	from last command. used if set_mode is
331  *	IWL_TX_POWER_MODE_SET_SAR_TIMER.
332  *	note: if not changed, the command is used for keep alive only.
333  * @reserved: reserved (padding)
334  * @timer_period: timer in milliseconds. if expires FW will change to default
335  *	BIOS values. relevant if setMode is IWL_TX_POWER_MODE_SET_SAR_TIMER
336  */
337 struct iwl_dev_tx_power_cmd_v5 {
338 	__le16 per_chain[IWL_NUM_CHAIN_TABLES][IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V1];
339 	u8 enable_ack_reduction;
340 	u8 per_chain_restriction_changed;
341 	u8 reserved[2];
342 	__le32 timer_period;
343 } __packed; /* TX_REDUCED_POWER_API_S_VER_5 */
344 
345 /**
346  * struct iwl_dev_tx_power_cmd_v6 - TX power reduction command version 6
347  * @per_chain: per chain restrictions
348  * @enable_ack_reduction: enable or disable close range ack TX power
349  *	reduction.
350  * @per_chain_restriction_changed: is per_chain_restriction has changed
351  *	from last command. used if set_mode is
352  *	IWL_TX_POWER_MODE_SET_SAR_TIMER.
353  *	note: if not changed, the command is used for keep alive only.
354  * @reserved: reserved (padding)
355  * @timer_period: timer in milliseconds. if expires FW will change to default
356  *	BIOS values. relevant if setMode is IWL_TX_POWER_MODE_SET_SAR_TIMER
357  */
358 struct iwl_dev_tx_power_cmd_v6 {
359 	__le16 per_chain[IWL_NUM_CHAIN_TABLES_V2][IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V2];
360 	u8 enable_ack_reduction;
361 	u8 per_chain_restriction_changed;
362 	u8 reserved[2];
363 	__le32 timer_period;
364 } __packed; /* TX_REDUCED_POWER_API_S_VER_6 */
365 
366 /**
367  * struct iwl_dev_tx_power_cmd_v7 - TX power reduction command version 7
368  * @per_chain: per chain restrictions
369  * @enable_ack_reduction: enable or disable close range ack TX power
370  *	reduction.
371  * @per_chain_restriction_changed: is per_chain_restriction has changed
372  *	from last command. used if set_mode is
373  *	IWL_TX_POWER_MODE_SET_SAR_TIMER.
374  *	note: if not changed, the command is used for keep alive only.
375  * @reserved: reserved (padding)
376  * @timer_period: timer in milliseconds. if expires FW will change to default
377  *	BIOS values. relevant if setMode is IWL_TX_POWER_MODE_SET_SAR_TIMER
378  * @flags: reduce power flags.
379  */
380 struct iwl_dev_tx_power_cmd_v7 {
381 	__le16 per_chain[IWL_NUM_CHAIN_TABLES_V2][IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V2];
382 	u8 enable_ack_reduction;
383 	u8 per_chain_restriction_changed;
384 	u8 reserved[2];
385 	__le32 timer_period;
386 	__le32 flags;
387 } __packed; /* TX_REDUCED_POWER_API_S_VER_7 */
388 
389 /**
390  * struct iwl_dev_tx_power_cmd_v8 - TX power reduction command version 8
391  * @per_chain: per chain restrictions
392  * @enable_ack_reduction: enable or disable close range ack TX power
393  *	reduction.
394  * @per_chain_restriction_changed: is per_chain_restriction has changed
395  *	from last command. used if set_mode is
396  *	IWL_TX_POWER_MODE_SET_SAR_TIMER.
397  *	note: if not changed, the command is used for keep alive only.
398  * @reserved: reserved (padding)
399  * @timer_period: timer in milliseconds. if expires FW will change to default
400  *	BIOS values. relevant if setMode is IWL_TX_POWER_MODE_SET_SAR_TIMER
401  * @flags: reduce power flags.
402  * @tpc_vlp_backoff_level: user backoff of UNII5,7 VLP channels in USA.
403  *	Not in use.
404  */
405 struct iwl_dev_tx_power_cmd_v8 {
406 	__le16 per_chain[IWL_NUM_CHAIN_TABLES_V2][IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V2];
407 	u8 enable_ack_reduction;
408 	u8 per_chain_restriction_changed;
409 	u8 reserved[2];
410 	__le32 timer_period;
411 	__le32 flags;
412 	__le32 tpc_vlp_backoff_level;
413 } __packed; /* TX_REDUCED_POWER_API_S_VER_8 */
414 
415 /**
416  * struct iwl_dev_tx_power_cmd - TX power reduction command (multiversion)
417  * @common: common part of the command
418  * @v3: version 3 part of the command
419  * @v4: version 4 part of the command
420  * @v5: version 5 part of the command
421  * @v6: version 6 part of the command
422  * @v7: version 7 part of the command
423  * @v8: version 8 part of the command
424  */
425 struct iwl_dev_tx_power_cmd {
426 	struct iwl_dev_tx_power_common common;
427 	union {
428 		struct iwl_dev_tx_power_cmd_v3 v3;
429 		struct iwl_dev_tx_power_cmd_v4 v4;
430 		struct iwl_dev_tx_power_cmd_v5 v5;
431 		struct iwl_dev_tx_power_cmd_v6 v6;
432 		struct iwl_dev_tx_power_cmd_v7 v7;
433 		struct iwl_dev_tx_power_cmd_v8 v8;
434 	};
435 };
436 
437 #define IWL_NUM_GEO_PROFILES		3
438 #define IWL_NUM_GEO_PROFILES_V3		8
439 #define IWL_NUM_BANDS_PER_CHAIN_V1	2
440 #define IWL_NUM_BANDS_PER_CHAIN_V2	3
441 
442 /**
443  * enum iwl_geo_per_chain_offset_operation - type of operation
444  * @IWL_PER_CHAIN_OFFSET_SET_TABLES: send the tables from the host to the FW.
445  * @IWL_PER_CHAIN_OFFSET_GET_CURRENT_TABLE: retrieve the last configured table.
446  */
447 enum iwl_geo_per_chain_offset_operation {
448 	IWL_PER_CHAIN_OFFSET_SET_TABLES,
449 	IWL_PER_CHAIN_OFFSET_GET_CURRENT_TABLE,
450 };  /* PER_CHAIN_OFFSET_OPERATION_E */
451 
452 /**
453  * struct iwl_per_chain_offset - embedded struct for PER_CHAIN_LIMIT_OFFSET_CMD.
454  * @max_tx_power: maximum allowed tx power.
455  * @chain_a: tx power offset for chain a.
456  * @chain_b: tx power offset for chain b.
457  */
458 struct iwl_per_chain_offset {
459 	__le16 max_tx_power;
460 	u8 chain_a;
461 	u8 chain_b;
462 } __packed; /* PER_CHAIN_LIMIT_OFFSET_PER_CHAIN_S_VER_1 */
463 
464 /**
465  * struct iwl_geo_tx_power_profile_cmd_v1 - struct for PER_CHAIN_LIMIT_OFFSET_CMD cmd.
466  * @ops: operations, value from &enum iwl_geo_per_chain_offset_operation
467  * @table: offset profile per band.
468  */
469 struct iwl_geo_tx_power_profiles_cmd_v1 {
470 	__le32 ops;
471 	struct iwl_per_chain_offset table[IWL_NUM_GEO_PROFILES][IWL_NUM_BANDS_PER_CHAIN_V1];
472 } __packed; /* PER_CHAIN_LIMIT_OFFSET_CMD_VER_1 */
473 
474 /**
475  * struct iwl_geo_tx_power_profile_cmd_v2 - struct for PER_CHAIN_LIMIT_OFFSET_CMD cmd.
476  * @ops: operations, value from &enum iwl_geo_per_chain_offset_operation
477  * @table: offset profile per band.
478  * @table_revision: 0 for not-South Korea, 1 for South Korea (the name is misleading)
479  */
480 struct iwl_geo_tx_power_profiles_cmd_v2 {
481 	__le32 ops;
482 	struct iwl_per_chain_offset table[IWL_NUM_GEO_PROFILES][IWL_NUM_BANDS_PER_CHAIN_V1];
483 	__le32 table_revision;
484 } __packed; /* PER_CHAIN_LIMIT_OFFSET_CMD_VER_2 */
485 
486 /**
487  * struct iwl_geo_tx_power_profile_cmd_v3 - struct for PER_CHAIN_LIMIT_OFFSET_CMD cmd.
488  * @ops: operations, value from &enum iwl_geo_per_chain_offset_operation
489  * @table: offset profile per band.
490  * @table_revision: 0 for not-South Korea, 1 for South Korea (the name is misleading)
491  */
492 struct iwl_geo_tx_power_profiles_cmd_v3 {
493 	__le32 ops;
494 	struct iwl_per_chain_offset table[IWL_NUM_GEO_PROFILES][IWL_NUM_BANDS_PER_CHAIN_V2];
495 	__le32 table_revision;
496 } __packed; /* PER_CHAIN_LIMIT_OFFSET_CMD_VER_3 */
497 
498 /**
499  * struct iwl_geo_tx_power_profile_cmd_v4 - struct for PER_CHAIN_LIMIT_OFFSET_CMD cmd.
500  * @ops: operations, value from &enum iwl_geo_per_chain_offset_operation
501  * @table: offset profile per band.
502  * @table_revision: 0 for not-South Korea, 1 for South Korea (the name is misleading)
503  */
504 struct iwl_geo_tx_power_profiles_cmd_v4 {
505 	__le32 ops;
506 	struct iwl_per_chain_offset table[IWL_NUM_GEO_PROFILES_V3][IWL_NUM_BANDS_PER_CHAIN_V1];
507 	__le32 table_revision;
508 } __packed; /* PER_CHAIN_LIMIT_OFFSET_CMD_VER_4 */
509 
510 /**
511  * struct iwl_geo_tx_power_profile_cmd_v5 - struct for PER_CHAIN_LIMIT_OFFSET_CMD cmd.
512  * @ops: operations, value from &enum iwl_geo_per_chain_offset_operation
513  * @table: offset profile per band.
514  * @table_revision: 0 for not-South Korea, 1 for South Korea (the name is misleading)
515  */
516 struct iwl_geo_tx_power_profiles_cmd_v5 {
517 	__le32 ops;
518 	struct iwl_per_chain_offset table[IWL_NUM_GEO_PROFILES_V3][IWL_NUM_BANDS_PER_CHAIN_V2];
519 	__le32 table_revision;
520 } __packed; /* PER_CHAIN_LIMIT_OFFSET_CMD_VER_5 */
521 
522 union iwl_geo_tx_power_profiles_cmd {
523 	struct iwl_geo_tx_power_profiles_cmd_v1 v1;
524 	struct iwl_geo_tx_power_profiles_cmd_v2 v2;
525 	struct iwl_geo_tx_power_profiles_cmd_v3 v3;
526 	struct iwl_geo_tx_power_profiles_cmd_v4 v4;
527 	struct iwl_geo_tx_power_profiles_cmd_v5 v5;
528 };
529 
530 /**
531  * struct iwl_geo_tx_power_profiles_resp -  response to PER_CHAIN_LIMIT_OFFSET_CMD cmd
532  * @profile_idx: current geo profile in use
533  */
534 struct iwl_geo_tx_power_profiles_resp {
535 	__le32 profile_idx;
536 } __packed; /* PER_CHAIN_LIMIT_OFFSET_RSP */
537 
538 /**
539  * enum iwl_ppag_flags - PPAG enable masks
540  * @IWL_PPAG_ETSI_MASK: enable PPAG in ETSI
541  * @IWL_PPAG_CHINA_MASK: enable PPAG in China
542  * @IWL_PPAG_ETSI_LPI_UHB_MASK: enable LPI in ETSI for UHB
543  * @IWL_PPAG_ETSI_VLP_UHB_MASK: enable VLP in ETSI for UHB
544  * @IWL_PPAG_ETSI_SP_UHB_MASK: enable SP in ETSI for UHB
545  * @IWL_PPAG_USA_LPI_UHB_MASK: enable LPI in USA for UHB
546  * @IWL_PPAG_USA_VLP_UHB_MASK: enable VLP in USA for UHB
547  * @IWL_PPAG_USA_SP_UHB_MASK: enable SP in USA for UHB
548  * @IWL_PPAG_CANADA_LPI_UHB_MASK: enable LPI in CANADA for UHB
549  * @IWL_PPAG_CANADA_VLP_UHB_MASK: enable VLP in CANADA for UHB
550  * @IWL_PPAG_CANADA_SP_UHB_MASK: enable SP in CANADA for UHB
551  */
552 enum iwl_ppag_flags {
553 	IWL_PPAG_ETSI_MASK = BIT(0),
554 	IWL_PPAG_CHINA_MASK = BIT(1),
555 	IWL_PPAG_ETSI_LPI_UHB_MASK = BIT(2),
556 	IWL_PPAG_ETSI_VLP_UHB_MASK = BIT(3),
557 	IWL_PPAG_ETSI_SP_UHB_MASK = BIT(4),
558 	IWL_PPAG_USA_LPI_UHB_MASK = BIT(5),
559 	IWL_PPAG_USA_VLP_UHB_MASK = BIT(6),
560 	IWL_PPAG_USA_SP_UHB_MASK = BIT(7),
561 	IWL_PPAG_CANADA_LPI_UHB_MASK = BIT(8),
562 	IWL_PPAG_CANADA_VLP_UHB_MASK = BIT(9),
563 	IWL_PPAG_CANADA_SP_UHB_MASK = BIT(10),
564 };
565 
566 /**
567  * union iwl_ppag_table_cmd - union for all versions of PPAG command
568  * @v1: version 1
569  * @v2: version 2
570  * version 3, 4, 5 and 6 are the same structure as v2,
571  *	but has a different format of the flags bitmap
572  * @flags: values from &enum iwl_ppag_flags
573  * @gain: table of antenna gain values per chain and sub-band
574  * @reserved: reserved
575  */
576 union iwl_ppag_table_cmd {
577 	struct {
578 		__le32 flags;
579 		s8 gain[IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V1];
580 		s8 reserved[2];
581 	} v1;
582 	struct {
583 		__le32 flags;
584 		s8 gain[IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS_V2];
585 		s8 reserved[2];
586 	} v2;
587 } __packed;
588 
589 #define IWL_PPAG_CMD_V4_MASK (IWL_PPAG_ETSI_MASK | IWL_PPAG_CHINA_MASK)
590 #define IWL_PPAG_CMD_V5_MASK (IWL_PPAG_CMD_V4_MASK | \
591 			      IWL_PPAG_ETSI_LPI_UHB_MASK | \
592 			      IWL_PPAG_USA_LPI_UHB_MASK)
593 
594 #define MCC_TO_SAR_OFFSET_TABLE_ROW_SIZE	26
595 #define MCC_TO_SAR_OFFSET_TABLE_COL_SIZE	13
596 
597 /**
598  * struct iwl_sar_offset_mapping_cmd - struct for SAR_OFFSET_MAPPING_TABLE_CMD
599  * @offset_map: mapping a mcc to a geo sar group
600  * @reserved: reserved
601  */
602 struct iwl_sar_offset_mapping_cmd {
603 	u8 offset_map[MCC_TO_SAR_OFFSET_TABLE_ROW_SIZE]
604 		[MCC_TO_SAR_OFFSET_TABLE_COL_SIZE];
605 	__le16 reserved;
606 } __packed; /*SAR_OFFSET_MAPPING_TABLE_CMD_API_S*/
607 
608 /**
609  * struct iwl_beacon_filter_cmd
610  * REPLY_BEACON_FILTERING_CMD = 0xd2 (command)
611  * @bf_energy_delta: Used for RSSI filtering, if in 'normal' state. Send beacon
612  *      to driver if delta in Energy values calculated for this and last
613  *      passed beacon is greater than this threshold. Zero value means that
614  *      the Energy change is ignored for beacon filtering, and beacon will
615  *      not be forced to be sent to driver regardless of this delta. Typical
616  *      energy delta 5dB.
617  * @bf_roaming_energy_delta: Used for RSSI filtering, if in 'roaming' state.
618  *      Send beacon to driver if delta in Energy values calculated for this
619  *      and last passed beacon is greater than this threshold. Zero value
620  *      means that the Energy change is ignored for beacon filtering while in
621  *      Roaming state, typical energy delta 1dB.
622  * @bf_roaming_state: Used for RSSI filtering. If absolute Energy values
623  *      calculated for current beacon is less than the threshold, use
624  *      Roaming Energy Delta Threshold, otherwise use normal Energy Delta
625  *      Threshold. Typical energy threshold is -72dBm.
626  * @bf_temp_threshold: This threshold determines the type of temperature
627  *	filtering (Slow or Fast) that is selected (Units are in Celsuis):
628  *	If the current temperature is above this threshold - Fast filter
629  *	will be used, If the current temperature is below this threshold -
630  *	Slow filter will be used.
631  * @bf_temp_fast_filter: Send Beacon to driver if delta in temperature values
632  *      calculated for this and the last passed beacon is greater than this
633  *      threshold. Zero value means that the temperature change is ignored for
634  *      beacon filtering; beacons will not be  forced to be sent to driver
635  *      regardless of whether its temerature has been changed.
636  * @bf_temp_slow_filter: Send Beacon to driver if delta in temperature values
637  *      calculated for this and the last passed beacon is greater than this
638  *      threshold. Zero value means that the temperature change is ignored for
639  *      beacon filtering; beacons will not be forced to be sent to driver
640  *      regardless of whether its temerature has been changed.
641  * @bf_enable_beacon_filter: 1, beacon filtering is enabled; 0, disabled.
642  * @bf_debug_flag: beacon filtering debug configuration
643  * @bf_escape_timer: Send beacons to to driver if no beacons were passed
644  *      for a specific period of time. Units: Beacons.
645  * @ba_escape_timer: Fully receive and parse beacon if no beacons were passed
646  *      for a longer period of time then this escape-timeout. Units: Beacons.
647  * @ba_enable_beacon_abort: 1, beacon abort is enabled; 0, disabled.
648  * @bf_threshold_absolute_low: See below.
649  * @bf_threshold_absolute_high: Send Beacon to driver if Energy value calculated
650  *      for this beacon crossed this absolute threshold. For the 'Increase'
651  *      direction the bf_energy_absolute_low[i] is used. For the 'Decrease'
652  *      direction the bf_energy_absolute_high[i] is used. Zero value means
653  *      that this specific threshold is ignored for beacon filtering, and
654  *      beacon will not be forced to be sent to driver due to this setting.
655  */
656 struct iwl_beacon_filter_cmd {
657 	__le32 bf_energy_delta;
658 	__le32 bf_roaming_energy_delta;
659 	__le32 bf_roaming_state;
660 	__le32 bf_temp_threshold;
661 	__le32 bf_temp_fast_filter;
662 	__le32 bf_temp_slow_filter;
663 	__le32 bf_enable_beacon_filter;
664 	__le32 bf_debug_flag;
665 	__le32 bf_escape_timer;
666 	__le32 ba_escape_timer;
667 	__le32 ba_enable_beacon_abort;
668 	__le32 bf_threshold_absolute_low[2];
669 	__le32 bf_threshold_absolute_high[2];
670 } __packed; /* BEACON_FILTER_CONFIG_API_S_VER_4 */
671 
672 /* Beacon filtering and beacon abort */
673 #define IWL_BF_ENERGY_DELTA_DEFAULT 5
674 #define IWL_BF_ENERGY_DELTA_D0I3 20
675 #define IWL_BF_ENERGY_DELTA_MAX 255
676 #define IWL_BF_ENERGY_DELTA_MIN 0
677 
678 #define IWL_BF_ROAMING_ENERGY_DELTA_DEFAULT 1
679 #define IWL_BF_ROAMING_ENERGY_DELTA_D0I3 20
680 #define IWL_BF_ROAMING_ENERGY_DELTA_MAX 255
681 #define IWL_BF_ROAMING_ENERGY_DELTA_MIN 0
682 
683 #define IWL_BF_ROAMING_STATE_DEFAULT 72
684 #define IWL_BF_ROAMING_STATE_D0I3 72
685 #define IWL_BF_ROAMING_STATE_MAX 255
686 #define IWL_BF_ROAMING_STATE_MIN 0
687 
688 #define IWL_BF_TEMP_THRESHOLD_DEFAULT 112
689 #define IWL_BF_TEMP_THRESHOLD_D0I3 112
690 #define IWL_BF_TEMP_THRESHOLD_MAX 255
691 #define IWL_BF_TEMP_THRESHOLD_MIN 0
692 
693 #define IWL_BF_TEMP_FAST_FILTER_DEFAULT 1
694 #define IWL_BF_TEMP_FAST_FILTER_D0I3 1
695 #define IWL_BF_TEMP_FAST_FILTER_MAX 255
696 #define IWL_BF_TEMP_FAST_FILTER_MIN 0
697 
698 #define IWL_BF_TEMP_SLOW_FILTER_DEFAULT 5
699 #define IWL_BF_TEMP_SLOW_FILTER_D0I3 20
700 #define IWL_BF_TEMP_SLOW_FILTER_MAX 255
701 #define IWL_BF_TEMP_SLOW_FILTER_MIN 0
702 
703 #define IWL_BF_ENABLE_BEACON_FILTER_DEFAULT 1
704 
705 #define IWL_BF_DEBUG_FLAG_DEFAULT 0
706 #define IWL_BF_DEBUG_FLAG_D0I3 0
707 
708 #define IWL_BF_ESCAPE_TIMER_DEFAULT 0
709 #define IWL_BF_ESCAPE_TIMER_D0I3 0
710 #define IWL_BF_ESCAPE_TIMER_MAX 1024
711 #define IWL_BF_ESCAPE_TIMER_MIN 0
712 
713 #define IWL_BA_ESCAPE_TIMER_DEFAULT 6
714 #define IWL_BA_ESCAPE_TIMER_D0I3 6
715 #define IWL_BA_ESCAPE_TIMER_D3 9
716 #define IWL_BA_ESCAPE_TIMER_MAX 1024
717 #define IWL_BA_ESCAPE_TIMER_MIN 0
718 
719 #define IWL_BA_ENABLE_BEACON_ABORT_DEFAULT 1
720 
721 #define IWL_BF_CMD_CONFIG(mode)					     \
722 	.bf_energy_delta = cpu_to_le32(IWL_BF_ENERGY_DELTA ## mode),	      \
723 	.bf_roaming_energy_delta =					      \
724 		cpu_to_le32(IWL_BF_ROAMING_ENERGY_DELTA ## mode),	      \
725 	.bf_roaming_state = cpu_to_le32(IWL_BF_ROAMING_STATE ## mode),	      \
726 	.bf_temp_threshold = cpu_to_le32(IWL_BF_TEMP_THRESHOLD ## mode),      \
727 	.bf_temp_fast_filter = cpu_to_le32(IWL_BF_TEMP_FAST_FILTER ## mode),  \
728 	.bf_temp_slow_filter = cpu_to_le32(IWL_BF_TEMP_SLOW_FILTER ## mode),  \
729 	.bf_debug_flag = cpu_to_le32(IWL_BF_DEBUG_FLAG ## mode),	      \
730 	.bf_escape_timer = cpu_to_le32(IWL_BF_ESCAPE_TIMER ## mode),	      \
731 	.ba_escape_timer = cpu_to_le32(IWL_BA_ESCAPE_TIMER ## mode)
732 
733 #define IWL_BF_CMD_CONFIG_DEFAULTS IWL_BF_CMD_CONFIG(_DEFAULT)
734 #define IWL_BF_CMD_CONFIG_D0I3 IWL_BF_CMD_CONFIG(_D0I3)
735 
736 #define DEFAULT_TPE_TX_POWER 0x7F
737 
738 /*
739  *  Bandwidth: 20/40/80/(160/80+80)/320
740  */
741 #define IWL_MAX_TX_EIRP_PWR_MAX_SIZE 5
742 #define IWL_MAX_TX_EIRP_PSD_PWR_MAX_SIZE 16
743 
744 enum iwl_6ghz_ap_type {
745 	IWL_6GHZ_AP_TYPE_LPI,
746 	IWL_6GHZ_AP_TYPE_SP,
747 	IWL_6GHZ_AP_TYPE_VLP,
748 }; /* PHY_AP_TYPE_API_E_VER_1 */
749 
750 /**
751  * struct iwl_txpower_constraints_cmd
752  * AP_TX_POWER_CONSTRAINTS_CMD
753  * Used for VLP/LPI/AFC Access Point power constraints for 6GHz channels
754  * @link_id: linkId
755  * @ap_type: see &enum iwl_ap_type
756  * @eirp_pwr: 8-bit 2s complement signed integer in the range
757  *	-64 dBm to 63 dBm with a 0.5 dB step
758  *	default &DEFAULT_TPE_TX_POWER (no maximum limit)
759  * @psd_pwr: 8-bit 2s complement signed integer in the range
760  *	-63.5 to +63 dBm/MHz with a 0.5 step
761  *	value - 128 indicates that the corresponding 20
762  *	MHz channel cannot be used for transmission.
763  *	value +127 indicates that no maximum PSD limit
764  *	is specified for the corresponding 20 MHz channel
765  *	default &DEFAULT_TPE_TX_POWER (no maximum limit)
766  * @reserved: reserved (padding)
767  */
768 struct iwl_txpower_constraints_cmd {
769 	__le16 link_id;
770 	__le16 ap_type;
771 	__s8 eirp_pwr[IWL_MAX_TX_EIRP_PWR_MAX_SIZE];
772 	__s8 psd_pwr[IWL_MAX_TX_EIRP_PSD_PWR_MAX_SIZE];
773 	u8 reserved[3];
774 } __packed; /* PHY_AP_TX_POWER_CONSTRAINTS_CMD_API_S_VER_1 */
775 #endif /* __iwl_fw_api_power_h__ */
776