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_MANAGEMENT_ENA_MSK: '0' Driver disables power management,
  72  *              '1' Driver enables PM (use rest of parameters)
  73  * @POWER_FLAGS_SLEEP_OVER_DTIM_MSK: '0' PM have to walk up every DTIM,
  74  *              '1' PM could sleep over DTIM till listen Interval.
  75  * @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable.
  76  * @POWER_FLAGS_SNOOZE_ENA_MSK: Enable snoozing only if uAPSD is enabled and all
  77  *              access categories are both delivery and trigger enabled.
  78  * @POWER_FLAGS_BT_SCO_ENA: Enable BT SCO coex only if uAPSD and
  79  *              PBW Snoozing enabled
  80  * @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask
  81 */
  82 enum iwl_power_flags {
  83         POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK    = BIT(0),
  84         POWER_FLAGS_SLEEP_OVER_DTIM_MSK         = BIT(1),
  85         POWER_FLAGS_LPRX_ENA_MSK                = BIT(2),
  86         POWER_FLAGS_SNOOZE_ENA_MSK              = BIT(3),
  87         POWER_FLAGS_BT_SCO_ENA                  = BIT(4),
  88         POWER_FLAGS_ADVANCE_PM_ENA_MSK          = BIT(5)
  89 };
  90
  91 /**
  92  * struct iwl_powertable_cmd - Power Table Command
  93  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
  94  *
  95  * @id_and_color:       MAC contex identifier
  96  * @action:             Action on context - no action, add new,
  97  *                      modify existent, remove
  98  * @flags:              Power table command flags from POWER_FLAGS_*
  99  * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
 100  *                      Minimum allowed:- 3 * DTIM
 101  * @rx_data_timeout:    Minimum time (usec) from last Rx packet for AM to
 102  *                      PSM transition - legacy PM
 103  * @tx_data_timeout:    Minimum time (usec) from last Tx packet for AM to
 104  *                      PSM transition - legacy PM
 105  * @rx_data_timeout_uapsd: Minimum time (usec) from last Rx packet for AM to
 106  *                      PSM transition - uAPSD
 107  * @tx_data_timeout_uapsd: Minimum time (usec) from last Tx packet for AM to
 108  *                      PSM transition - uAPSD
 109  * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
 110  *                      Default: 80dbm
 111  * @num_skip_dtim:      Number of DTIMs to skip if Skip over DTIM flag is set
 112  * @snooze_interval:    TBD
 113  * @snooze_window:      TBD
 114  * @snooze_step:        TBD
 115  * @qndp_tid:           TBD
 116  * @uapsd_ac_flags:     TBD
 117  * @uapsd_max_sp:       TBD
 118  */
 119 struct iwl_powertable_cmd {
 120         /* COMMON_INDEX_HDR_API_S_VER_1 */
 121         __le32 id_and_color;
 122         __le32 action;
 123         __le16 flags;
 124         u8 reserved;
 125         __le16 keep_alive_seconds;
 126         __le32 rx_data_timeout;
 127         __le32 tx_data_timeout;
 128         __le32 rx_data_timeout_uapsd;
 129         __le32 tx_data_timeout_uapsd;
 130         u8 lprx_rssi_threshold;
 131         u8 num_skip_dtim;
 132         __le16 snooze_interval;
 133         __le16 snooze_window;
 134         u8 snooze_step;
 135         u8 qndp_tid;
 136         u8 uapsd_ac_flags;
 137         u8 uapsd_max_sp;
 138 } __packed;
 139
 140 #endif