drivers/net/wireless/iwlwifi/mvm/fw-api-power.h

   1 /******************************************************************************
   2  *
   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.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63
  64 #ifndef __fw_api_power_h__
  65 #define __fw_api_power_h__
  66
  67 /* Power Management Commands, Responses, Notifications */
  68
  69 /* Radio LP RX Energy Threshold measured in dBm */
  70 #define POWER_LPRX_RSSI_THRESHOLD       75
  71 #define POWER_LPRX_RSSI_THRESHOLD_MAX   94
  72 #define POWER_LPRX_RSSI_THRESHOLD_MIN   30
  73
  74 /**
  75  * enum iwl_scan_flags - masks for power table command flags
  76  * @POWER_FLAGS_POWER_SAVE_ENA_MSK: '1' Allow to save power by turning off
  77  *              receiver and transmitter. '0' - does not allow.
  78  * @POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK: '0' Driver disables power management,
  79  *              '1' Driver enables PM (use rest of parameters)
  80  * @POWER_FLAGS_SKIP_OVER_DTIM_MSK: '0' PM have to walk up every DTIM,
  81  *              '1' PM could sleep over DTIM till listen Interval.
  82  * @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask
  83  * @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable.
  84 */
  85 enum iwl_power_flags {
  86         POWER_FLAGS_POWER_SAVE_ENA_MSK          = BIT(0),
  87         POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK    = BIT(1),
  88         POWER_FLAGS_SKIP_OVER_DTIM_MSK          = BIT(2),
  89         POWER_FLAGS_ADVANCE_PM_ENA_MSK          = BIT(9),
  90         POWER_FLAGS_LPRX_ENA_MSK                = BIT(11),
  91 };
  92
  93 #define IWL_POWER_VEC_SIZE 5
  94
  95 /**
  96  * struct iwl_powertable_cmd - Power Table Command
  97  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
  98  *
  99  * @flags:              Power table command flags from POWER_FLAGS_*
 100  * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
 101  *                      Minimum allowed:- 3 * DTIM. Keep alive period must be
 102  *                      set regardless of power scheme or current power state.
 103  *                      FW use this value also when PM is disabled.
 104  * @rx_data_timeout:    Minimum time (usec) from last Rx packet for AM to
 105  *                      PSM transition - legacy PM
 106  * @tx_data_timeout:    Minimum time (usec) from last Tx packet for AM to
 107  *                      PSM transition - legacy PM
 108  * @sleep_interval:     not in use
 109  * @skip_dtim_periods:  Number of DTIM periods to skip if Skip over DTIM flag
 110  *                      is set. For example, if it is required to skip over
 111  *                      one DTIM, this value need to be set to 2 (DTIM periods).
 112  * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
 113  *                      Default: 80dbm
 114  */
 115 struct iwl_powertable_cmd {
 116         /* PM_POWER_TABLE_CMD_API_S_VER_6 */
 117         __le16 flags;
 118         u8 keep_alive_seconds;
 119         u8 debug_flags;
 120         __le32 rx_data_timeout;
 121         __le32 tx_data_timeout;
 122         __le32 sleep_interval[IWL_POWER_VEC_SIZE];
 123         __le32 skip_dtim_periods;
 124         __le32 lprx_rssi_threshold;
 125 } __packed;
 126
 127 /**
 128  * struct iwl_beacon_filter_cmd
 129  * REPLY_BEACON_FILTERING_CMD = 0xd2 (command)
 130  * @id_and_color: MAC contex identifier
 131  * @bf_energy_delta: Used for RSSI filtering, if in 'normal' state. Send beacon
 132  *      to driver if delta in Energy values calculated for this and last
 133  *      passed beacon is greater than this threshold. Zero value means that
 134  *      the Energy change is ignored for beacon filtering, and beacon will
 135  *      not be forced to be sent to driver regardless of this delta. Typical
 136  *      energy delta 5dB.
 137  * @bf_roaming_energy_delta: Used for RSSI filtering, if in 'roaming' state.
 138  *      Send beacon to driver if delta in Energy values calculated for this
 139  *      and last passed beacon is greater than this threshold. Zero value
 140  *      means that the Energy change is ignored for beacon filtering while in
 141  *      Roaming state, typical energy delta 1dB.
 142  * @bf_roaming_state: Used for RSSI filtering. If absolute Energy values
 143  *      calculated for current beacon is less than the threshold, use
 144  *      Roaming Energy Delta Threshold, otherwise use normal Energy Delta
 145  *      Threshold. Typical energy threshold is -72dBm.
 146  * @bf_temperature_delta: Send Beacon to driver if delta in temperature values
 147  *      calculated for this and the last passed beacon is greater than  this
 148  *      threshold. Zero value means that the temperature changeis ignored for
 149  *      beacon filtering; beacons will not be  forced to be sent to driver
 150  *      regardless of whether its temerature has been changed.
 151  * @bf_enable_beacon_filter: 1, beacon filtering is enabled; 0, disabled.
 152  * @bf_filter_escape_timer: Send beacons to to driver if no beacons were passed
 153  *      for a specific period of time. Units: Beacons.
 154  * @ba_escape_timer: Fully receive and parse beacon if no beacons were passed
 155  *      for a longer period of time then this escape-timeout. Units: Beacons.
 156  * @ba_enable_beacon_abort: 1, beacon abort is enabled; 0, disabled.
 157  */
 158 struct iwl_beacon_filter_cmd {
 159         u8 bf_energy_delta;
 160         u8 bf_roaming_energy_delta;
 161         u8 bf_roaming_state;
 162         u8 bf_temperature_delta;
 163         u8 bf_enable_beacon_filter;
 164         u8 bf_debug_flag;
 165         __le16 reserved1;
 166         __le32 bf_escape_timer;
 167         __le32 ba_escape_timer;
 168         u8 ba_enable_beacon_abort;
 169         u8 reserved2[3];
 170 } __packed;
 171
 172 /* Beacon filtering and beacon abort */
 173 #define IWL_BF_ENERGY_DELTA_DEFAULT 5
 174 #define IWL_BF_ENERGY_DELTA_MAX 255
 175 #define IWL_BF_ENERGY_DELTA_MIN 0
 176
 177 #define IWL_BF_ROAMING_ENERGY_DELTA_DEFAULT 1
 178 #define IWL_BF_ROAMING_ENERGY_DELTA_MAX 255
 179 #define IWL_BF_ROAMING_ENERGY_DELTA_MIN 0
 180
 181 #define IWL_BF_ROAMING_STATE_DEFAULT 72
 182 #define IWL_BF_ROAMING_STATE_MAX 255
 183 #define IWL_BF_ROAMING_STATE_MIN 0
 184
 185 #define IWL_BF_TEMPERATURE_DELTA_DEFAULT 5
 186 #define IWL_BF_TEMPERATURE_DELTA_MAX 255
 187 #define IWL_BF_TEMPERATURE_DELTA_MIN 0
 188
 189 #define IWL_BF_ENABLE_BEACON_FILTER_DEFAULT 1
 190
 191 #define IWL_BF_DEBUG_FLAG_DEFAULT 0
 192
 193 #define IWL_BF_ESCAPE_TIMER_DEFAULT 50
 194 #define IWL_BF_ESCAPE_TIMER_MAX 1024
 195 #define IWL_BF_ESCAPE_TIMER_MIN 0
 196
 197 #define IWL_BA_ESCAPE_TIMER_DEFAULT 3
 198 #define IWL_BA_ESCAPE_TIMER_MAX 1024
 199 #define IWL_BA_ESCAPE_TIMER_MIN 0
 200
 201 #define IWL_BA_ENABLE_BEACON_ABORT_DEFAULT 1
 202
 203 #define IWL_BF_CMD_CONFIG_DEFAULTS                                      \
 204         .bf_energy_delta = IWL_BF_ENERGY_DELTA_DEFAULT,                 \
 205         .bf_roaming_energy_delta = IWL_BF_ROAMING_ENERGY_DELTA_DEFAULT, \
 206         .bf_roaming_state = IWL_BF_ROAMING_STATE_DEFAULT,               \
 207         .bf_temperature_delta = IWL_BF_TEMPERATURE_DELTA_DEFAULT,       \
 208         .bf_debug_flag = IWL_BF_DEBUG_FLAG_DEFAULT,                     \
 209         .bf_escape_timer = cpu_to_le32(IWL_BF_ESCAPE_TIMER_DEFAULT),    \
 210         .ba_escape_timer = cpu_to_le32(IWL_BA_ESCAPE_TIMER_DEFAULT)
 211
 212 #endif