drivers/net/wireless/iwlwifi/mvm/fw-api-coex.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) 2013 - 2014 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) 2013 - 2014 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 #ifndef __fw_api_bt_coex_h__
  64 #define __fw_api_bt_coex_h__
  65
  66 #include <linux/types.h>
  67 #include <linux/bitops.h>
  68
  69 #define BITS(nb) (BIT(nb) - 1)
  70
  71 /**
  72  * enum iwl_bt_coex_flags - flags for BT_COEX command
  73  * @BT_COEX_MODE_POS:
  74  * @BT_COEX_MODE_MSK:
  75  * @BT_COEX_DISABLE:
  76  * @BT_COEX_2W:
  77  * @BT_COEX_3W:
  78  * @BT_COEX_NW:
  79  * @BT_COEX_SYNC2SCO:
  80  * @BT_COEX_CORUNNING:
  81  * @BT_COEX_MPLUT:
  82  *
  83  * The COEX_MODE must be set for each command. Even if it is not changed.
  84  */
  85 enum iwl_bt_coex_flags {
  86         BT_COEX_MODE_POS                = 3,
  87         BT_COEX_MODE_MSK                = BITS(3) << BT_COEX_MODE_POS,
  88         BT_COEX_DISABLE                 = 0x0 << BT_COEX_MODE_POS,
  89         BT_COEX_2W                      = 0x1 << BT_COEX_MODE_POS,
  90         BT_COEX_3W                      = 0x2 << BT_COEX_MODE_POS,
  91         BT_COEX_NW                      = 0x3 << BT_COEX_MODE_POS,
  92         BT_COEX_SYNC2SCO                = BIT(7),
  93         BT_COEX_CORUNNING               = BIT(8),
  94         BT_COEX_MPLUT                   = BIT(9),
  95 };
  96
  97 /*
  98  * indicates what has changed in the BT_COEX command.
  99  * BT_VALID_ENABLE must be set for each command. Commands without this bit will
 100  * discarded by the firmware
 101  */
 102 enum iwl_bt_coex_valid_bit_msk {
 103         BT_VALID_ENABLE                 = BIT(0),
 104         BT_VALID_BT_PRIO_BOOST          = BIT(1),
 105         BT_VALID_MAX_KILL               = BIT(2),
 106         BT_VALID_3W_TMRS                = BIT(3),
 107         BT_VALID_KILL_ACK               = BIT(4),
 108         BT_VALID_KILL_CTS               = BIT(5),
 109         BT_VALID_REDUCED_TX_POWER       = BIT(6),
 110         BT_VALID_LUT                    = BIT(7),
 111         BT_VALID_WIFI_RX_SW_PRIO_BOOST  = BIT(8),
 112         BT_VALID_WIFI_TX_SW_PRIO_BOOST  = BIT(9),
 113         BT_VALID_MULTI_PRIO_LUT         = BIT(10),
 114         BT_VALID_TRM_KICK_FILTER        = BIT(11),
 115         BT_VALID_CORUN_LUT_20           = BIT(12),
 116         BT_VALID_CORUN_LUT_40           = BIT(13),
 117         BT_VALID_ANT_ISOLATION          = BIT(14),
 118         BT_VALID_ANT_ISOLATION_THRS     = BIT(15),
 119         BT_VALID_TXTX_DELTA_FREQ_THRS   = BIT(16),
 120         BT_VALID_TXRX_MAX_FREQ_0        = BIT(17),
 121         BT_VALID_SYNC_TO_SCO            = BIT(18),
 122 };
 123
 124 /**
 125  * enum iwl_bt_reduced_tx_power - allows to reduce txpower for WiFi frames.
 126  * @BT_REDUCED_TX_POWER_CTL: reduce Tx power for control frames
 127  * @BT_REDUCED_TX_POWER_DATA: reduce Tx power for data frames
 128  *
 129  * This mechanism allows to have BT and WiFi run concurrently. Since WiFi
 130  * reduces its Tx power, it can work along with BT, hence reducing the amount
 131  * of WiFi frames being killed by BT.
 132  */
 133 enum iwl_bt_reduced_tx_power {
 134         BT_REDUCED_TX_POWER_CTL         = BIT(0),
 135         BT_REDUCED_TX_POWER_DATA        = BIT(1),
 136 };
 137
 138 enum iwl_bt_coex_lut_type {
 139         BT_COEX_TIGHT_LUT = 0,
 140         BT_COEX_LOOSE_LUT,
 141         BT_COEX_TX_DIS_LUT,
 142
 143         BT_COEX_MAX_LUT,
 144         BT_COEX_INVALID_LUT = 0xff,
 145 }; /* BT_COEX_DECISION_LUT_INDEX_API_E_VER_1 */
 146
 147 #define BT_COEX_LUT_SIZE (12)
 148 #define BT_COEX_CORUN_LUT_SIZE (32)
 149 #define BT_COEX_MULTI_PRIO_LUT_SIZE (2)
 150 #define BT_COEX_BOOST_SIZE (4)
 151 #define BT_REDUCED_TX_POWER_BIT BIT(7)
 152
 153 /**
 154  * struct iwl_bt_coex_cmd - bt coex configuration command
 155  * @flags:&enum iwl_bt_coex_flags
 156  * @max_kill:
 157  * @bt_reduced_tx_power: enum %iwl_bt_reduced_tx_power
 158  * @override_primary_lut: enum %iwl_bt_coex_lut_type: BT_COEX_INVALID_LUT
 159  *      should be set by default
 160  * @override_secondary_lut: enum %iwl_bt_coex_lut_type: BT_COEX_INVALID_LUT
 161  *      should be set by default
 162  * @bt4_antenna_isolation: antenna isolation
 163  * @bt4_antenna_isolation_thr: antenna threshold value
 164  * @bt4_tx_tx_delta_freq_thr: TxTx delta frequency
 165  * @bt4_tx_rx_max_freq0: TxRx max frequency
 166  * @bt_prio_boost: BT priority boost registers
 167  * @wifi_tx_prio_boost: SW boost of wifi tx priority
 168  * @wifi_rx_prio_boost: SW boost of wifi rx priority
 169  * @kill_ack_msk: kill ACK mask. 1 - Tx ACK, 0 - kill Tx of ACK.
 170  * @kill_cts_msk: kill CTS mask. 1 - Tx CTS, 0 - kill Tx of CTS.
 171  * @decision_lut: PTA decision LUT, per Prio-Ch
 172  * @bt4_multiprio_lut: multi priority LUT configuration
 173  * @bt4_corun_lut20: co-running 20 MHz LUT configuration
 174  * @bt4_corun_lut40: co-running 40 MHz LUT configuration
 175  * @valid_bit_msk: enum %iwl_bt_coex_valid_bit_msk
 176  *
 177  * The structure is used for the BT_COEX command.
 178  */
 179 struct iwl_bt_coex_cmd {
 180         __le32 flags;
 181         u8 max_kill;
 182         u8 bt_reduced_tx_power;
 183         u8 override_primary_lut;
 184         u8 override_secondary_lut;
 185
 186         u8 bt4_antenna_isolation;
 187         u8 bt4_antenna_isolation_thr;
 188         u8 bt4_tx_tx_delta_freq_thr;
 189         u8 bt4_tx_rx_max_freq0;
 190
 191         __le32 bt_prio_boost[BT_COEX_BOOST_SIZE];
 192         __le32 wifi_tx_prio_boost;
 193         __le32 wifi_rx_prio_boost;
 194         __le32 kill_ack_msk;
 195         __le32 kill_cts_msk;
 196
 197         __le32 decision_lut[BT_COEX_MAX_LUT][BT_COEX_LUT_SIZE];
 198         __le32 bt4_multiprio_lut[BT_COEX_MULTI_PRIO_LUT_SIZE];
 199         __le32 bt4_corun_lut20[BT_COEX_CORUN_LUT_SIZE];
 200         __le32 bt4_corun_lut40[BT_COEX_CORUN_LUT_SIZE];
 201
 202         __le32 valid_bit_msk;
 203 } __packed; /* BT_COEX_CMD_API_S_VER_5 */
 204
 205 /**
 206  * struct iwl_bt_coex_ci_cmd - bt coex channel inhibition command
 207  * @bt_primary_ci:
 208  * @bt_secondary_ci:
 209  * @co_run_bw_primary:
 210  * @co_run_bw_secondary:
 211  * @primary_ch_phy_id:
 212  * @secondary_ch_phy_id:
 213  *
 214  * Used for BT_COEX_CI command
 215  */
 216 struct iwl_bt_coex_ci_cmd {
 217         __le64 bt_primary_ci;
 218         __le64 bt_secondary_ci;
 219
 220         u8 co_run_bw_primary;
 221         u8 co_run_bw_secondary;
 222         u8 primary_ch_phy_id;
 223         u8 secondary_ch_phy_id;
 224 } __packed; /* BT_CI_MSG_API_S_VER_1 */
 225
 226 #define BT_MBOX(n_dw, _msg, _pos, _nbits)       \
 227         BT_MBOX##n_dw##_##_msg##_POS = (_pos),  \
 228         BT_MBOX##n_dw##_##_msg = BITS(_nbits) << BT_MBOX##n_dw##_##_msg##_POS
 229
 230 enum iwl_bt_mxbox_dw0 {
 231         BT_MBOX(0, LE_SLAVE_LAT, 0, 3),
 232         BT_MBOX(0, LE_PROF1, 3, 1),
 233         BT_MBOX(0, LE_PROF2, 4, 1),
 234         BT_MBOX(0, LE_PROF_OTHER, 5, 1),
 235         BT_MBOX(0, CHL_SEQ_N, 8, 4),
 236         BT_MBOX(0, INBAND_S, 13, 1),
 237         BT_MBOX(0, LE_MIN_RSSI, 16, 4),
 238         BT_MBOX(0, LE_SCAN, 20, 1),
 239         BT_MBOX(0, LE_ADV, 21, 1),
 240         BT_MBOX(0, LE_MAX_TX_POWER, 24, 4),
 241         BT_MBOX(0, OPEN_CON_1, 28, 2),
 242 };
 243
 244 enum iwl_bt_mxbox_dw1 {
 245         BT_MBOX(1, BR_MAX_TX_POWER, 0, 4),
 246         BT_MBOX(1, IP_SR, 4, 1),
 247         BT_MBOX(1, LE_MSTR, 5, 1),
 248         BT_MBOX(1, AGGR_TRFC_LD, 8, 6),
 249         BT_MBOX(1, MSG_TYPE, 16, 3),
 250         BT_MBOX(1, SSN, 19, 2),
 251 };
 252
 253 enum iwl_bt_mxbox_dw2 {
 254         BT_MBOX(2, SNIFF_ACT, 0, 3),
 255         BT_MBOX(2, PAG, 3, 1),
 256         BT_MBOX(2, INQUIRY, 4, 1),
 257         BT_MBOX(2, CONN, 5, 1),
 258         BT_MBOX(2, SNIFF_INTERVAL, 8, 5),
 259         BT_MBOX(2, DISC, 13, 1),
 260         BT_MBOX(2, SCO_TX_ACT, 16, 2),
 261         BT_MBOX(2, SCO_RX_ACT, 18, 2),
 262         BT_MBOX(2, ESCO_RE_TX, 20, 2),
 263         BT_MBOX(2, SCO_DURATION, 24, 6),
 264 };
 265
 266 enum iwl_bt_mxbox_dw3 {
 267         BT_MBOX(3, SCO_STATE, 0, 1),
 268         BT_MBOX(3, SNIFF_STATE, 1, 1),
 269         BT_MBOX(3, A2DP_STATE, 2, 1),
 270         BT_MBOX(3, ACL_STATE, 3, 1),
 271         BT_MBOX(3, MSTR_STATE, 4, 1),
 272         BT_MBOX(3, OBX_STATE, 5, 1),
 273         BT_MBOX(3, OPEN_CON_2, 8, 2),
 274         BT_MBOX(3, TRAFFIC_LOAD, 10, 2),
 275         BT_MBOX(3, CHL_SEQN_LSB, 12, 1),
 276         BT_MBOX(3, INBAND_P, 13, 1),
 277         BT_MBOX(3, MSG_TYPE_2, 16, 3),
 278         BT_MBOX(3, SSN_2, 19, 2),
 279         BT_MBOX(3, UPDATE_REQUEST, 21, 1),
 280 };
 281
 282 #define BT_MBOX_MSG(_notif, _num, _field)                                    \
 283         ((le32_to_cpu((_notif)->mbox_msg[(_num)]) & BT_MBOX##_num##_##_field)\
 284         >> BT_MBOX##_num##_##_field##_POS)
 285
 286 enum iwl_bt_activity_grading {
 287         BT_OFF                  = 0,
 288         BT_ON_NO_CONNECTION     = 1,
 289         BT_LOW_TRAFFIC          = 2,
 290         BT_HIGH_TRAFFIC         = 3,
 291 }; /* BT_COEX_BT_ACTIVITY_GRADING_API_E_VER_1 */
 292
 293 /**
 294  * struct iwl_bt_coex_profile_notif - notification about BT coex
 295  * @mbox_msg: message from BT to WiFi
 296  * @msg_idx: the index of the message
 297  * @bt_status: 0 - off, 1 - on
 298  * @bt_open_conn: number of BT connections open
 299  * @bt_traffic_load: load of BT traffic
 300  * @bt_agg_traffic_load: aggregated load of BT traffic
 301  * @bt_ci_compliance: 0 - no CI compliance, 1 - CI compliant
 302  * @primary_ch_lut: LUT used for primary channel
 303  * @secondary_ch_lut: LUT used for secondary channel
 304  * @bt_activity_grading: the activity of BT enum %iwl_bt_activity_grading
 305  */
 306 struct iwl_bt_coex_profile_notif {
 307         __le32 mbox_msg[4];
 308         __le32 msg_idx;
 309         u8 bt_status;
 310         u8 bt_open_conn;
 311         u8 bt_traffic_load;
 312         u8 bt_agg_traffic_load;
 313         u8 bt_ci_compliance;
 314         u8 reserved[3];
 315
 316         __le32 primary_ch_lut;
 317         __le32 secondary_ch_lut;
 318         __le32 bt_activity_grading;
 319 } __packed; /* BT_COEX_PROFILE_NTFY_API_S_VER_3 */
 320
 321 enum iwl_bt_coex_prio_table_event {
 322         BT_COEX_PRIO_TBL_EVT_INIT_CALIB1                = 0,
 323         BT_COEX_PRIO_TBL_EVT_INIT_CALIB2                = 1,
 324         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW1        = 2,
 325         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW2        = 3,
 326         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH1       = 4,
 327         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH2       = 5,
 328         BT_COEX_PRIO_TBL_EVT_DTIM                       = 6,
 329         BT_COEX_PRIO_TBL_EVT_SCAN52                     = 7,
 330         BT_COEX_PRIO_TBL_EVT_SCAN24                     = 8,
 331         BT_COEX_PRIO_TBL_EVT_IDLE                       = 9,
 332         BT_COEX_PRIO_TBL_EVT_MAX                        = 16,
 333 }; /* BT_COEX_PRIO_TABLE_EVENTS_API_E_VER_1 */
 334
 335 enum iwl_bt_coex_prio_table_prio {
 336         BT_COEX_PRIO_TBL_DISABLED       = 0,
 337         BT_COEX_PRIO_TBL_PRIO_LOW       = 1,
 338         BT_COEX_PRIO_TBL_PRIO_HIGH      = 2,
 339         BT_COEX_PRIO_TBL_PRIO_BYPASS    = 3,
 340         BT_COEX_PRIO_TBL_PRIO_COEX_OFF  = 4,
 341         BT_COEX_PRIO_TBL_PRIO_COEX_ON   = 5,
 342         BT_COEX_PRIO_TBL_PRIO_COEX_IDLE = 6,
 343         BT_COEX_PRIO_TBL_MAX            = 8,
 344 }; /* BT_COEX_PRIO_TABLE_PRIORITIES_API_E_VER_1 */
 345
 346 #define BT_COEX_PRIO_TBL_SHRD_ANT_POS     (0)
 347 #define BT_COEX_PRIO_TBL_PRIO_POS         (1)
 348 #define BT_COEX_PRIO_TBL_RESERVED_POS     (4)
 349
 350 /**
 351  * struct iwl_bt_coex_prio_tbl_cmd - priority table for BT coex
 352  * @prio_tbl:
 353  */
 354 struct iwl_bt_coex_prio_tbl_cmd {
 355         u8 prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX];
 356 } __packed;
 357
 358 #endif /* __fw_api_bt_coex_h__ */