drivers/net/wireless/iwlwifi/mvm/fw-api-rs.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 LICENSE.GPL.
  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 #ifndef __fw_api_rs_h__
  64 #define __fw_api_rs_h__
  65
  66 #include "fw-api-mac.h"
  67
  68 /*
  69  * These serve as indexes into
  70  * struct iwl_rate_info fw_rate_idx_to_plcp[IWL_RATE_COUNT];
  71  */
  72 enum {
  73         IWL_RATE_1M_INDEX = 0,
  74         IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
  75         IWL_RATE_2M_INDEX,
  76         IWL_RATE_5M_INDEX,
  77         IWL_RATE_11M_INDEX,
  78         IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
  79         IWL_RATE_6M_INDEX,
  80         IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
  81         IWL_RATE_9M_INDEX,
  82         IWL_RATE_12M_INDEX,
  83         IWL_RATE_18M_INDEX,
  84         IWL_RATE_24M_INDEX,
  85         IWL_RATE_36M_INDEX,
  86         IWL_RATE_48M_INDEX,
  87         IWL_RATE_54M_INDEX,
  88         IWL_LAST_NON_HT_RATE = IWL_RATE_54M_INDEX,
  89         IWL_RATE_60M_INDEX,
  90         IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
  91         IWL_RATE_COUNT_LEGACY = IWL_LAST_NON_HT_RATE + 1,
  92         IWL_RATE_COUNT,
  93 };
  94
  95 #define IWL_RATE_BIT_MSK(r) BIT(IWL_RATE_##r##M_INDEX)
  96
  97 /* fw API values for legacy bit rates, both OFDM and CCK */
  98 enum {
  99         IWL_RATE_6M_PLCP  = 13,
 100         IWL_RATE_9M_PLCP  = 15,
 101         IWL_RATE_12M_PLCP = 5,
 102         IWL_RATE_18M_PLCP = 7,
 103         IWL_RATE_24M_PLCP = 9,
 104         IWL_RATE_36M_PLCP = 11,
 105         IWL_RATE_48M_PLCP = 1,
 106         IWL_RATE_54M_PLCP = 3,
 107         IWL_RATE_1M_PLCP  = 10,
 108         IWL_RATE_2M_PLCP  = 20,
 109         IWL_RATE_5M_PLCP  = 55,
 110         IWL_RATE_11M_PLCP = 110,
 111 };
 112
 113 /*
 114  * rate_n_flags bit fields
 115  *
 116  * The 32-bit value has different layouts in the low 8 bites depending on the
 117  * format. There are three formats, HT, VHT and legacy (11abg, with subformats
 118  * for CCK and OFDM).
 119  *
 120  * High-throughput (HT) rate format
 121  *      bit 8 is 1, bit 26 is 0, bit 9 is 0 (OFDM)
 122  * Very High-throughput (VHT) rate format
 123  *      bit 8 is 0, bit 26 is 1, bit 9 is 0 (OFDM)
 124  * Legacy OFDM rate format for bits 7:0
 125  *      bit 8 is 0, bit 26 is 0, bit 9 is 0 (OFDM)
 126  * Legacy CCK rate format for bits 7:0:
 127  *      bit 8 is 0, bit 26 is 0, bit 9 is 1 (CCK)
 128  */
 129
 130 /* Bit 8: (1) HT format, (0) legacy or VHT format */
 131 #define RATE_MCS_HT_POS 8
 132 #define RATE_MCS_HT_MSK (1 << RATE_MCS_HT_POS)
 133
 134 /* Bit 9: (1) CCK, (0) OFDM.  HT (bit 8) must be "0" for this bit to be valid */
 135 #define RATE_MCS_CCK_POS 9
 136 #define RATE_MCS_CCK_MSK (1 << RATE_MCS_CCK_POS)
 137
 138 /* Bit 26: (1) VHT format, (0) legacy format in bits 8:0 */
 139 #define RATE_MCS_VHT_POS 26
 140 #define RATE_MCS_VHT_MSK (1 << RATE_MCS_VHT_POS)
 141
 142
 143 /*
 144  * High-throughput (HT) rate format for bits 7:0
 145  *
 146  *  2-0:  MCS rate base
 147  *        0)   6 Mbps
 148  *        1)  12 Mbps
 149  *        2)  18 Mbps
 150  *        3)  24 Mbps
 151  *        4)  36 Mbps
 152  *        5)  48 Mbps
 153  *        6)  54 Mbps
 154  *        7)  60 Mbps
 155  *  4-3:  0)  Single stream (SISO)
 156  *        1)  Dual stream (MIMO)
 157  *        2)  Triple stream (MIMO)
 158  *    5:  Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
 159  *  (bits 7-6 are zero)
 160  *
 161  * Together the low 5 bits work out to the MCS index because we don't
 162  * support MCSes above 15/23, and 0-7 have one stream, 8-15 have two
 163  * streams and 16-23 have three streams. We could also support MCS 32
 164  * which is the duplicate 20 MHz MCS (bit 5 set, all others zero.)
 165  */
 166 #define RATE_HT_MCS_RATE_CODE_MSK       0x7
 167
 168 /* Bit 10: (1) Use Green Field preamble */
 169 #define RATE_HT_MCS_GF_POS              10
 170 #define RATE_HT_MCS_GF_MSK              (1 << RATE_HT_MCS_GF_POS)
 171
 172 #define RATE_HT_MCS_INDEX_MSK           0x3f
 173
 174 /*
 175  * Very High-throughput (VHT) rate format for bits 7:0
 176  *
 177  *  3-0:  VHT MCS (0-9)
 178  *  5-4:  number of streams - 1:
 179  *        0)  Single stream (SISO)
 180  *        1)  Dual stream (MIMO)
 181  *        2)  Triple stream (MIMO)
 182  */
 183
 184 /* Bit 4-5: (0) SISO, (1) MIMO2 (2) MIMO3 */
 185 #define RATE_VHT_MCS_RATE_CODE_MSK      0xf
 186 #define RATE_VHT_MCS_NSS_POS            4
 187 #define RATE_VHT_MCS_NSS_MSK            (3 << RATE_VHT_MCS_NSS_POS)
 188
 189 /*
 190  * Legacy OFDM rate format for bits 7:0
 191  *
 192  *  3-0:  0xD)   6 Mbps
 193  *        0xF)   9 Mbps
 194  *        0x5)  12 Mbps
 195  *        0x7)  18 Mbps
 196  *        0x9)  24 Mbps
 197  *        0xB)  36 Mbps
 198  *        0x1)  48 Mbps
 199  *        0x3)  54 Mbps
 200  * (bits 7-4 are 0)
 201  *
 202  * Legacy CCK rate format for bits 7:0:
 203  * bit 8 is 0, bit 26 is 0, bit 9 is 1 (CCK):
 204  *
 205  *  6-0:   10)  1 Mbps
 206  *         20)  2 Mbps
 207  *         55)  5.5 Mbps
 208  *        110)  11 Mbps
 209  * (bit 7 is 0)
 210  */
 211 #define RATE_LEGACY_RATE_MSK 0xff
 212
 213
 214 /*
 215  * Bit 11-12: (0) 20MHz, (1) 40MHz, (2) 80MHz, (3) 160MHz
 216  * 0 and 1 are valid for HT and VHT, 2 and 3 only for VHT
 217  */
 218 #define RATE_MCS_CHAN_WIDTH_POS         11
 219 #define RATE_MCS_CHAN_WIDTH_MSK         (3 << RATE_MCS_CHAN_WIDTH_POS)
 220 #define RATE_MCS_CHAN_WIDTH_20          (0 << RATE_MCS_CHAN_WIDTH_POS)
 221 #define RATE_MCS_CHAN_WIDTH_40          (1 << RATE_MCS_CHAN_WIDTH_POS)
 222 #define RATE_MCS_CHAN_WIDTH_80          (2 << RATE_MCS_CHAN_WIDTH_POS)
 223 #define RATE_MCS_CHAN_WIDTH_160         (3 << RATE_MCS_CHAN_WIDTH_POS)
 224
 225 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
 226 #define RATE_MCS_SGI_POS                13
 227 #define RATE_MCS_SGI_MSK                (1 << RATE_MCS_SGI_POS)
 228
 229 /* Bit 14-16: Antenna selection (1) Ant A, (2) Ant B, (4) Ant C */
 230 #define RATE_MCS_ANT_POS                14
 231 #define RATE_MCS_ANT_A_MSK              (1 << RATE_MCS_ANT_POS)
 232 #define RATE_MCS_ANT_B_MSK              (2 << RATE_MCS_ANT_POS)
 233 #define RATE_MCS_ANT_C_MSK              (4 << RATE_MCS_ANT_POS)
 234 #define RATE_MCS_ANT_AB_MSK             (RATE_MCS_ANT_A_MSK | \
 235                                          RATE_MCS_ANT_B_MSK)
 236 #define RATE_MCS_ANT_ABC_MSK            (RATE_MCS_ANT_AB_MSK | \
 237                                          RATE_MCS_ANT_C_MSK)
 238 #define RATE_MCS_ANT_MSK                RATE_MCS_ANT_ABC_MSK
 239 #define RATE_MCS_ANT_NUM 3
 240
 241 /* Bit 17-18: (0) SS, (1) SS*2 */
 242 #define RATE_MCS_STBC_POS               17
 243 #define RATE_MCS_STBC_MSK               (1 << RATE_MCS_STBC_POS)
 244
 245 /* Bit 19: (0) Beamforming is off, (1) Beamforming is on */
 246 #define RATE_MCS_BF_POS                 19
 247 #define RATE_MCS_BF_MSK                 (1 << RATE_MCS_BF_POS)
 248
 249 /* Bit 20: (0) ZLF is off, (1) ZLF is on */
 250 #define RATE_MCS_ZLF_POS                20
 251 #define RATE_MCS_ZLF_MSK                (1 << RATE_MCS_ZLF_POS)
 252
 253 /* Bit 24-25: (0) 20MHz (no dup), (1) 2x20MHz, (2) 4x20MHz, 3 8x20MHz */
 254 #define RATE_MCS_DUP_POS                24
 255 #define RATE_MCS_DUP_MSK                (3 << RATE_MCS_DUP_POS)
 256
 257 /* Bit 27: (1) LDPC enabled, (0) LDPC disabled */
 258 #define RATE_MCS_LDPC_POS               27
 259 #define RATE_MCS_LDPC_MSK               (1 << RATE_MCS_LDPC_POS)
 260
 261
 262 /* Link Quality definitions */
 263
 264 /* # entries in rate scale table to support Tx retries */
 265 #define  LQ_MAX_RETRY_NUM 16
 266
 267 /* Link quality command flags, only this one is available */
 268 #define  LQ_FLAG_SET_STA_TLC_RTS_MSK    BIT(0)
 269
 270 /**
 271  * struct iwl_lq_cmd - link quality command
 272  * @sta_id: station to update
 273  * @control: not used
 274  * @flags: combination of LQ_FLAG_*
 275  * @mimo_delim: the first SISO index in rs_table, which separates MIMO
 276  *      and SISO rates
 277  * @single_stream_ant_msk: best antenna for SISO (can be dual in CDD).
 278  *      Should be ANT_[ABC]
 279  * @dual_stream_ant_msk: best antennas for MIMO, combination of ANT_[ABC]
 280  * @initial_rate_index: first index from rs_table per AC category
 281  * @agg_time_limit: aggregation max time threshold in usec/100, meaning
 282  *      value of 100 is one usec. Range is 100 to 8000
 283  * @agg_disable_start_th: try-count threshold for starting aggregation.
 284  *      If a frame has higher try-count, it should not be selected for
 285  *      starting an aggregation sequence.
 286  * @agg_frame_cnt_limit: max frame count in an aggregation.
 287  *      0: no limit
 288  *      1: no aggregation (one frame per aggregation)
 289  *      2 - 0x3f: maximal number of frames (up to 3f == 63)
 290  * @rs_table: array of rates for each TX try, each is rate_n_flags,
 291  *      meaning it is a combination of RATE_MCS_* and IWL_RATE_*_PLCP
 292  * @bf_params: beam forming params, currently not used
 293  */
 294 struct iwl_lq_cmd {
 295         u8 sta_id;
 296         u8 reserved1;
 297         u16 control;
 298         /* LINK_QUAL_GENERAL_PARAMS_API_S_VER_1 */
 299         u8 flags;
 300         u8 mimo_delim;
 301         u8 single_stream_ant_msk;
 302         u8 dual_stream_ant_msk;
 303         u8 initial_rate_index[AC_NUM];
 304         /* LINK_QUAL_AGG_PARAMS_API_S_VER_1 */
 305         __le16 agg_time_limit;
 306         u8 agg_disable_start_th;
 307         u8 agg_frame_cnt_limit;
 308         __le32 reserved2;
 309         __le32 rs_table[LQ_MAX_RETRY_NUM];
 310         __le32 bf_params;
 311 }; /* LINK_QUALITY_CMD_API_S_VER_1 */
 312 #endif /* __fw_api_rs_h__ */