1 /******************************************************************************
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
10 * Copyright(c) 2015 Intel Deutschland GmbH
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
26 * The full GNU General Public License is included in this distribution
27 * in the file called COPYING.
29 * Contact Information:
30 * Intel Linux Wireless <ilw@linux.intel.com>
31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
35 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
36 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
37 * Copyright(c) 2015 Intel Deutschland GmbH
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
44 * * Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * * Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in
48 * the documentation and/or other materials provided with the
50 * * Neither the name Intel Corporation nor the names of its
51 * contributors may be used to endorse or promote products derived
52 * from this software without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 *****************************************************************************/
68 #ifndef __fw_api_power_h__
69 #define __fw_api_power_h__
71 /* Power Management Commands, Responses, Notifications */
74 * enum iwl_ltr_config_flags - masks for LTR config command flags
75 * @LTR_CFG_FLAG_FEATURE_ENABLE: Feature operational status
76 * @LTR_CFG_FLAG_HW_DIS_ON_SHADOW_REG_ACCESS: allow LTR change on shadow
78 * @LTR_CFG_FLAG_HW_EN_SHRT_WR_THROUGH: allow LTR msg send on ANY LTR
80 * @LTR_CFG_FLAG_HW_DIS_ON_D0_2_D3: allow LTR msg send on transition from
82 * @LTR_CFG_FLAG_SW_SET_SHORT: fixed static short LTR register
83 * @LTR_CFG_FLAG_SW_SET_LONG: fixed static short LONG register
84 * @LTR_CFG_FLAG_DENIE_C10_ON_PD: allow going into C10 on PD
86 enum iwl_ltr_config_flags {
87 LTR_CFG_FLAG_FEATURE_ENABLE = BIT(0),
88 LTR_CFG_FLAG_HW_DIS_ON_SHADOW_REG_ACCESS = BIT(1),
89 LTR_CFG_FLAG_HW_EN_SHRT_WR_THROUGH = BIT(2),
90 LTR_CFG_FLAG_HW_DIS_ON_D0_2_D3 = BIT(3),
91 LTR_CFG_FLAG_SW_SET_SHORT = BIT(4),
92 LTR_CFG_FLAG_SW_SET_LONG = BIT(5),
93 LTR_CFG_FLAG_DENIE_C10_ON_PD = BIT(6),
97 * struct iwl_ltr_config_cmd_v1 - configures the LTR
98 * @flags: See %enum iwl_ltr_config_flags
100 struct iwl_ltr_config_cmd_v1 {
104 } __packed; /* LTR_CAPABLE_API_S_VER_1 */
106 #define LTR_VALID_STATES_NUM 4
109 * struct iwl_ltr_config_cmd - configures the LTR
110 * @flags: See %enum iwl_ltr_config_flags
114 * @ltr_short_idle_timeout:
116 struct iwl_ltr_config_cmd {
120 __le32 ltr_cfg_values[LTR_VALID_STATES_NUM];
121 __le32 ltr_short_idle_timeout;
122 } __packed; /* LTR_CAPABLE_API_S_VER_2 */
124 /* Radio LP RX Energy Threshold measured in dBm */
125 #define POWER_LPRX_RSSI_THRESHOLD 75
126 #define POWER_LPRX_RSSI_THRESHOLD_MAX 94
127 #define POWER_LPRX_RSSI_THRESHOLD_MIN 30
130 * enum iwl_power_flags - masks for power table command flags
131 * @POWER_FLAGS_POWER_SAVE_ENA_MSK: '1' Allow to save power by turning off
132 * receiver and transmitter. '0' - does not allow.
133 * @POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK: '0' Driver disables power management,
134 * '1' Driver enables PM (use rest of parameters)
135 * @POWER_FLAGS_SKIP_OVER_DTIM_MSK: '0' PM have to walk up every DTIM,
136 * '1' PM could sleep over DTIM till listen Interval.
137 * @POWER_FLAGS_SNOOZE_ENA_MSK: Enable snoozing only if uAPSD is enabled and all
138 * access categories are both delivery and trigger enabled.
139 * @POWER_FLAGS_BT_SCO_ENA: Enable BT SCO coex only if uAPSD and
140 * PBW Snoozing enabled
141 * @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask
142 * @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable.
143 * @POWER_FLAGS_AP_UAPSD_MISBEHAVING_ENA_MSK: AP/GO's uAPSD misbehaving
144 * detection enablement
146 enum iwl_power_flags {
147 POWER_FLAGS_POWER_SAVE_ENA_MSK = BIT(0),
148 POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK = BIT(1),
149 POWER_FLAGS_SKIP_OVER_DTIM_MSK = BIT(2),
150 POWER_FLAGS_SNOOZE_ENA_MSK = BIT(5),
151 POWER_FLAGS_BT_SCO_ENA = BIT(8),
152 POWER_FLAGS_ADVANCE_PM_ENA_MSK = BIT(9),
153 POWER_FLAGS_LPRX_ENA_MSK = BIT(11),
154 POWER_FLAGS_UAPSD_MISBEHAVING_ENA_MSK = BIT(12),
157 #define IWL_POWER_VEC_SIZE 5
160 * struct iwl_powertable_cmd - legacy power command. Beside old API support this
161 * is used also with a new power API for device wide power settings.
162 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
164 * @flags: Power table command flags from POWER_FLAGS_*
165 * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
166 * Minimum allowed:- 3 * DTIM. Keep alive period must be
167 * set regardless of power scheme or current power state.
168 * FW use this value also when PM is disabled.
169 * @rx_data_timeout: Minimum time (usec) from last Rx packet for AM to
170 * PSM transition - legacy PM
171 * @tx_data_timeout: Minimum time (usec) from last Tx packet for AM to
172 * PSM transition - legacy PM
173 * @sleep_interval: not in use
174 * @skip_dtim_periods: Number of DTIM periods to skip if Skip over DTIM flag
175 * is set. For example, if it is required to skip over
176 * one DTIM, this value need to be set to 2 (DTIM periods).
177 * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
180 struct iwl_powertable_cmd {
181 /* PM_POWER_TABLE_CMD_API_S_VER_6 */
183 u8 keep_alive_seconds;
185 __le32 rx_data_timeout;
186 __le32 tx_data_timeout;
187 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
188 __le32 skip_dtim_periods;
189 __le32 lprx_rssi_threshold;
193 * enum iwl_device_power_flags - masks for device power command flags
194 * @DEVIC_POWER_FLAGS_POWER_SAVE_ENA_MSK: '1' Allow to save power by turning off
195 * receiver and transmitter. '0' - does not allow. This flag should be
196 * always set to '1' unless one need to disable actual power down for debug
198 * @DEVICE_POWER_FLAGS_CAM_MSK: '1' CAM (Continuous Active Mode) is set, meaning
199 * that power management is disabled. '0' Power management is enabled, one
200 * of power schemes is applied.
202 enum iwl_device_power_flags {
203 DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK = BIT(0),
204 DEVICE_POWER_FLAGS_CAM_MSK = BIT(13),
208 * struct iwl_device_power_cmd - device wide power command.
209 * DEVICE_POWER_CMD = 0x77 (command, has simple generic response)
211 * @flags: Power table command flags from DEVICE_POWER_FLAGS_*
213 struct iwl_device_power_cmd {
214 /* PM_POWER_TABLE_CMD_API_S_VER_6 */
220 * struct iwl_mac_power_cmd - New power command containing uAPSD support
221 * MAC_PM_POWER_TABLE = 0xA9 (command, has simple generic response)
222 * @id_and_color: MAC contex identifier
223 * @flags: Power table command flags from POWER_FLAGS_*
224 * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
225 * Minimum allowed:- 3 * DTIM. Keep alive period must be
226 * set regardless of power scheme or current power state.
227 * FW use this value also when PM is disabled.
228 * @rx_data_timeout: Minimum time (usec) from last Rx packet for AM to
229 * PSM transition - legacy PM
230 * @tx_data_timeout: Minimum time (usec) from last Tx packet for AM to
231 * PSM transition - legacy PM
232 * @sleep_interval: not in use
233 * @skip_dtim_periods: Number of DTIM periods to skip if Skip over DTIM flag
234 * is set. For example, if it is required to skip over
235 * one DTIM, this value need to be set to 2 (DTIM periods).
236 * @rx_data_timeout_uapsd: Minimum time (usec) from last Rx packet for AM to
237 * PSM transition - uAPSD
238 * @tx_data_timeout_uapsd: Minimum time (usec) from last Tx packet for AM to
239 * PSM transition - uAPSD
240 * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
242 * @num_skip_dtim: Number of DTIMs to skip if Skip over DTIM flag is set
243 * @snooze_interval: Maximum time between attempts to retrieve buffered data
245 * @snooze_window: A window of time in which PBW snoozing insures that all
246 * packets received. It is also the minimum time from last
247 * received unicast RX packet, before client stops snoozing
250 * @qndp_tid: TID client shall use for uAPSD QNDP triggers
251 * @uapsd_ac_flags: Set trigger-enabled and delivery-enabled indication for
252 * each corresponding AC.
253 * Use IEEE80211_WMM_IE_STA_QOSINFO_AC* for correct values.
254 * @uapsd_max_sp: Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct
256 * @heavy_tx_thld_packets: TX threshold measured in number of packets
257 * @heavy_rx_thld_packets: RX threshold measured in number of packets
258 * @heavy_tx_thld_percentage: TX threshold measured in load's percentage
259 * @heavy_rx_thld_percentage: RX threshold measured in load's percentage
260 * @limited_ps_threshold:
262 struct iwl_mac_power_cmd {
263 /* CONTEXT_DESC_API_T_VER_1 */
266 /* CLIENT_PM_POWER_TABLE_S_VER_1 */
268 __le16 keep_alive_seconds;
269 __le32 rx_data_timeout;
270 __le32 tx_data_timeout;
271 __le32 rx_data_timeout_uapsd;
272 __le32 tx_data_timeout_uapsd;
273 u8 lprx_rssi_threshold;
274 u8 skip_dtim_periods;
275 __le16 snooze_interval;
276 __le16 snooze_window;
281 u8 heavy_tx_thld_packets;
282 u8 heavy_rx_thld_packets;
283 u8 heavy_tx_thld_percentage;
284 u8 heavy_rx_thld_percentage;
285 u8 limited_ps_threshold;
290 * struct iwl_uapsd_misbehaving_ap_notif - FW sends this notification when
291 * associated AP is identified as improperly implementing uAPSD protocol.
292 * PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78
293 * @sta_id: index of station in uCode's station table - associated AP ID in
296 struct iwl_uapsd_misbehaving_ap_notif {
303 * struct iwl_reduce_tx_power_cmd - TX power reduction command
304 * REDUCE_TX_POWER_CMD = 0x9f
305 * @flags: (reserved for future implementation)
306 * @mac_context_id: id of the mac ctx for which we are reducing TX power.
307 * @pwr_restriction: TX power restriction in dBms.
309 struct iwl_reduce_tx_power_cmd {
312 __le16 pwr_restriction;
313 } __packed; /* TX_REDUCED_POWER_API_S_VER_1 */
315 enum iwl_dev_tx_power_cmd_mode {
316 IWL_TX_POWER_MODE_SET_MAC = 0,
317 IWL_TX_POWER_MODE_SET_DEVICE = 1,
318 IWL_TX_POWER_MODE_SET_CHAINS = 2,
319 }; /* TX_POWER_REDUCED_FLAGS_TYPE_API_E_VER_2 */;
322 * struct iwl_dev_tx_power_cmd_v2 - TX power reduction command
323 * @set_mode: see &enum iwl_dev_tx_power_cmd_mode
324 * @mac_context_id: id of the mac ctx for which we are reducing TX power.
325 * @pwr_restriction: TX power restriction in 1/8 dBms.
326 * @dev_24: device TX power restriction in 1/8 dBms
327 * @dev_52_low: device TX power restriction upper band - low
328 * @dev_52_high: device TX power restriction upper band - high
330 struct iwl_dev_tx_power_cmd_v2 {
332 __le32 mac_context_id;
333 __le16 pwr_restriction;
337 } __packed; /* TX_REDUCED_POWER_API_S_VER_2 */
339 #define IWL_NUM_CHAIN_LIMITS 2
340 #define IWL_NUM_SUB_BANDS 5
343 * struct iwl_dev_tx_power_cmd - TX power reduction command
344 * @v2: version 2 of the command, embedded here for easier software handling
345 * @per_chain_restriction: per chain restrictions
347 struct iwl_dev_tx_power_cmd {
348 /* v3 is just an extension of v2 - keep this here */
349 struct iwl_dev_tx_power_cmd_v2 v2;
350 __le16 per_chain_restriction[IWL_NUM_CHAIN_LIMITS][IWL_NUM_SUB_BANDS];
351 } __packed; /* TX_REDUCED_POWER_API_S_VER_3 */
353 #define IWL_DEV_MAX_TX_POWER 0x7FFF
356 * struct iwl_beacon_filter_cmd
357 * REPLY_BEACON_FILTERING_CMD = 0xd2 (command)
358 * @id_and_color: MAC contex identifier
359 * @bf_energy_delta: Used for RSSI filtering, if in 'normal' state. Send beacon
360 * to driver if delta in Energy values calculated for this and last
361 * passed beacon is greater than this threshold. Zero value means that
362 * the Energy change is ignored for beacon filtering, and beacon will
363 * not be forced to be sent to driver regardless of this delta. Typical
365 * @bf_roaming_energy_delta: Used for RSSI filtering, if in 'roaming' state.
366 * Send beacon to driver if delta in Energy values calculated for this
367 * and last passed beacon is greater than this threshold. Zero value
368 * means that the Energy change is ignored for beacon filtering while in
369 * Roaming state, typical energy delta 1dB.
370 * @bf_roaming_state: Used for RSSI filtering. If absolute Energy values
371 * calculated for current beacon is less than the threshold, use
372 * Roaming Energy Delta Threshold, otherwise use normal Energy Delta
373 * Threshold. Typical energy threshold is -72dBm.
374 * @bf_temp_threshold: This threshold determines the type of temperature
375 * filtering (Slow or Fast) that is selected (Units are in Celsuis):
376 * If the current temperature is above this threshold - Fast filter
377 * will be used, If the current temperature is below this threshold -
378 * Slow filter will be used.
379 * @bf_temp_fast_filter: Send Beacon to driver if delta in temperature values
380 * calculated for this and the last passed beacon is greater than this
381 * threshold. Zero value means that the temperature change is ignored for
382 * beacon filtering; beacons will not be forced to be sent to driver
383 * regardless of whether its temerature has been changed.
384 * @bf_temp_slow_filter: Send Beacon to driver if delta in temperature values
385 * calculated for this and the last passed beacon is greater than this
386 * threshold. Zero value means that the temperature change is ignored for
387 * beacon filtering; beacons will not be forced to be sent to driver
388 * regardless of whether its temerature has been changed.
389 * @bf_enable_beacon_filter: 1, beacon filtering is enabled; 0, disabled.
390 * @bf_filter_escape_timer: Send beacons to to driver if no beacons were passed
391 * for a specific period of time. Units: Beacons.
392 * @ba_escape_timer: Fully receive and parse beacon if no beacons were passed
393 * for a longer period of time then this escape-timeout. Units: Beacons.
394 * @ba_enable_beacon_abort: 1, beacon abort is enabled; 0, disabled.
396 struct iwl_beacon_filter_cmd {
397 __le32 bf_energy_delta;
398 __le32 bf_roaming_energy_delta;
399 __le32 bf_roaming_state;
400 __le32 bf_temp_threshold;
401 __le32 bf_temp_fast_filter;
402 __le32 bf_temp_slow_filter;
403 __le32 bf_enable_beacon_filter;
404 __le32 bf_debug_flag;
405 __le32 bf_escape_timer;
406 __le32 ba_escape_timer;
407 __le32 ba_enable_beacon_abort;
410 /* Beacon filtering and beacon abort */
411 #define IWL_BF_ENERGY_DELTA_DEFAULT 5
412 #define IWL_BF_ENERGY_DELTA_D0I3 20
413 #define IWL_BF_ENERGY_DELTA_MAX 255
414 #define IWL_BF_ENERGY_DELTA_MIN 0
416 #define IWL_BF_ROAMING_ENERGY_DELTA_DEFAULT 1
417 #define IWL_BF_ROAMING_ENERGY_DELTA_D0I3 20
418 #define IWL_BF_ROAMING_ENERGY_DELTA_MAX 255
419 #define IWL_BF_ROAMING_ENERGY_DELTA_MIN 0
421 #define IWL_BF_ROAMING_STATE_DEFAULT 72
422 #define IWL_BF_ROAMING_STATE_D0I3 72
423 #define IWL_BF_ROAMING_STATE_MAX 255
424 #define IWL_BF_ROAMING_STATE_MIN 0
426 #define IWL_BF_TEMP_THRESHOLD_DEFAULT 112
427 #define IWL_BF_TEMP_THRESHOLD_D0I3 112
428 #define IWL_BF_TEMP_THRESHOLD_MAX 255
429 #define IWL_BF_TEMP_THRESHOLD_MIN 0
431 #define IWL_BF_TEMP_FAST_FILTER_DEFAULT 1
432 #define IWL_BF_TEMP_FAST_FILTER_D0I3 1
433 #define IWL_BF_TEMP_FAST_FILTER_MAX 255
434 #define IWL_BF_TEMP_FAST_FILTER_MIN 0
436 #define IWL_BF_TEMP_SLOW_FILTER_DEFAULT 5
437 #define IWL_BF_TEMP_SLOW_FILTER_D0I3 20
438 #define IWL_BF_TEMP_SLOW_FILTER_MAX 255
439 #define IWL_BF_TEMP_SLOW_FILTER_MIN 0
441 #define IWL_BF_ENABLE_BEACON_FILTER_DEFAULT 1
443 #define IWL_BF_DEBUG_FLAG_DEFAULT 0
444 #define IWL_BF_DEBUG_FLAG_D0I3 0
446 #define IWL_BF_ESCAPE_TIMER_DEFAULT 0
447 #define IWL_BF_ESCAPE_TIMER_D0I3 0
448 #define IWL_BF_ESCAPE_TIMER_MAX 1024
449 #define IWL_BF_ESCAPE_TIMER_MIN 0
451 #define IWL_BA_ESCAPE_TIMER_DEFAULT 6
452 #define IWL_BA_ESCAPE_TIMER_D0I3 6
453 #define IWL_BA_ESCAPE_TIMER_D3 9
454 #define IWL_BA_ESCAPE_TIMER_MAX 1024
455 #define IWL_BA_ESCAPE_TIMER_MIN 0
457 #define IWL_BA_ENABLE_BEACON_ABORT_DEFAULT 1
459 #define IWL_BF_CMD_CONFIG(mode) \
460 .bf_energy_delta = cpu_to_le32(IWL_BF_ENERGY_DELTA ## mode), \
461 .bf_roaming_energy_delta = \
462 cpu_to_le32(IWL_BF_ROAMING_ENERGY_DELTA ## mode), \
463 .bf_roaming_state = cpu_to_le32(IWL_BF_ROAMING_STATE ## mode), \
464 .bf_temp_threshold = cpu_to_le32(IWL_BF_TEMP_THRESHOLD ## mode), \
465 .bf_temp_fast_filter = cpu_to_le32(IWL_BF_TEMP_FAST_FILTER ## mode), \
466 .bf_temp_slow_filter = cpu_to_le32(IWL_BF_TEMP_SLOW_FILTER ## mode), \
467 .bf_debug_flag = cpu_to_le32(IWL_BF_DEBUG_FLAG ## mode), \
468 .bf_escape_timer = cpu_to_le32(IWL_BF_ESCAPE_TIMER ## mode), \
469 .ba_escape_timer = cpu_to_le32(IWL_BA_ESCAPE_TIMER ## mode)
471 #define IWL_BF_CMD_CONFIG_DEFAULTS IWL_BF_CMD_CONFIG(_DEFAULT)
472 #define IWL_BF_CMD_CONFIG_D0I3 IWL_BF_CMD_CONFIG(_D0I3)