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 /**
  70  * enum iwl_scan_flags - masks for power table command flags
  71  * @POWER_FLAGS_POWER_SAVE_ENA_MSK: '1' Allow to save power by turning off
  72  *              receiver and transmitter. '0' - does not allow.
  73  * @POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK: '0' Driver disables power management,
  74  *              '1' Driver enables PM (use rest of parameters)
  75  * @POWER_FLAGS_SKIP_OVER_DTIM_MSK: '0' PM have to walk up every DTIM,
  76  *              '1' PM could sleep over DTIM till listen Interval.
  77  * @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask
  78  * @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable.
  79 */
  80 enum iwl_power_flags {
  81         POWER_FLAGS_POWER_SAVE_ENA_MSK          = BIT(0),
  82         POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK    = BIT(1),
  83         POWER_FLAGS_SKIP_OVER_DTIM_MSK          = BIT(2),
  84         POWER_FLAGS_ADVANCE_PM_ENA_MSK          = BIT(9),
  85         POWER_FLAGS_LPRX_ENA_MSK                = BIT(11),
  86 };
  87
  88 #define IWL_POWER_VEC_SIZE 5
  89
  90 /**
  91  * struct iwl_powertable_cmd - Power Table Command
  92  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
  93  *
  94  * @flags:              Power table command flags from POWER_FLAGS_*
  95  * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
  96  *                      Minimum allowed:- 3 * DTIM. Keep alive period must be
  97  *                      set regardless of power scheme or current power state.
  98  *                      FW use this value also when PM is disabled.
  99  * @rx_data_timeout:    Minimum time (usec) from last Rx packet for AM to
 100  *                      PSM transition - legacy PM
 101  * @tx_data_timeout:    Minimum time (usec) from last Tx packet for AM to
 102  *                      PSM transition - legacy PM
 103  * @sleep_interval:     not in use
 104  * @keep_alive_beacons: not in use
 105  * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
 106  *                      Default: 80dbm
 107  */
 108 struct iwl_powertable_cmd {
 109         /* PM_POWER_TABLE_CMD_API_S_VER_5 */
 110         __le16 flags;
 111         u8 keep_alive_seconds;
 112         u8 debug_flags;
 113         __le32 rx_data_timeout;
 114         __le32 tx_data_timeout;
 115         __le32 sleep_interval[IWL_POWER_VEC_SIZE];
 116         __le32 keep_alive_beacons;
 117         __le32 lprx_rssi_threshold;
 118 } __packed;
 119
 120 #endif