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 - 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 <linuxwifi@intel.com> 29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 30 * 31 * BSD LICENSE 32 * 33 * Copyright(c) 2012 - 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_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 * TODO: avoid overlap between legacy and HT rates 72 */ 73enum { 74 IWL_RATE_1M_INDEX = 0, 75 IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX, 76 IWL_RATE_2M_INDEX, 77 IWL_RATE_5M_INDEX, 78 IWL_RATE_11M_INDEX, 79 IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX, 80 IWL_RATE_6M_INDEX, 81 IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX, 82 IWL_RATE_MCS_0_INDEX = IWL_RATE_6M_INDEX, 83 IWL_FIRST_HT_RATE = IWL_RATE_MCS_0_INDEX, 84 IWL_FIRST_VHT_RATE = IWL_RATE_MCS_0_INDEX, 85 IWL_RATE_9M_INDEX, 86 IWL_RATE_12M_INDEX, 87 IWL_RATE_MCS_1_INDEX = IWL_RATE_12M_INDEX, 88 IWL_RATE_18M_INDEX, 89 IWL_RATE_MCS_2_INDEX = IWL_RATE_18M_INDEX, 90 IWL_RATE_24M_INDEX, 91 IWL_RATE_MCS_3_INDEX = IWL_RATE_24M_INDEX, 92 IWL_RATE_36M_INDEX, 93 IWL_RATE_MCS_4_INDEX = IWL_RATE_36M_INDEX, 94 IWL_RATE_48M_INDEX, 95 IWL_RATE_MCS_5_INDEX = IWL_RATE_48M_INDEX, 96 IWL_RATE_54M_INDEX, 97 IWL_RATE_MCS_6_INDEX = IWL_RATE_54M_INDEX, 98 IWL_LAST_NON_HT_RATE = IWL_RATE_54M_INDEX, 99 IWL_RATE_60M_INDEX, 100 IWL_RATE_MCS_7_INDEX = IWL_RATE_60M_INDEX, 101 IWL_LAST_HT_RATE = IWL_RATE_MCS_7_INDEX, 102 IWL_RATE_MCS_8_INDEX, 103 IWL_RATE_MCS_9_INDEX, 104 IWL_LAST_VHT_RATE = IWL_RATE_MCS_9_INDEX, 105 IWL_RATE_COUNT_LEGACY = IWL_LAST_NON_HT_RATE + 1, 106 IWL_RATE_COUNT = IWL_LAST_VHT_RATE + 1, 107}; 108 109#define IWL_RATE_BIT_MSK(r) BIT(IWL_RATE_##r##M_INDEX) 110 111/* fw API values for legacy bit rates, both OFDM and CCK */ 112enum { 113 IWL_RATE_6M_PLCP = 13, 114 IWL_RATE_9M_PLCP = 15, 115 IWL_RATE_12M_PLCP = 5, 116 IWL_RATE_18M_PLCP = 7, 117 IWL_RATE_24M_PLCP = 9, 118 IWL_RATE_36M_PLCP = 11, 119 IWL_RATE_48M_PLCP = 1, 120 IWL_RATE_54M_PLCP = 3, 121 IWL_RATE_1M_PLCP = 10, 122 IWL_RATE_2M_PLCP = 20, 123 IWL_RATE_5M_PLCP = 55, 124 IWL_RATE_11M_PLCP = 110, 125 IWL_RATE_INVM_PLCP = -1, 126}; 127 128/* 129 * rate_n_flags bit fields 130 * 131 * The 32-bit value has different layouts in the low 8 bites depending on the 132 * format. There are three formats, HT, VHT and legacy (11abg, with subformats 133 * for CCK and OFDM). 134 * 135 * High-throughput (HT) rate format 136 * bit 8 is 1, bit 26 is 0, bit 9 is 0 (OFDM) 137 * Very High-throughput (VHT) rate format 138 * bit 8 is 0, bit 26 is 1, bit 9 is 0 (OFDM) 139 * Legacy OFDM rate format for bits 7:0 140 * bit 8 is 0, bit 26 is 0, bit 9 is 0 (OFDM) 141 * Legacy CCK rate format for bits 7:0: 142 * bit 8 is 0, bit 26 is 0, bit 9 is 1 (CCK) 143 */ 144 145/* Bit 8: (1) HT format, (0) legacy or VHT format */ 146#define RATE_MCS_HT_POS 8 147#define RATE_MCS_HT_MSK (1 << RATE_MCS_HT_POS) 148 149/* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */ 150#define RATE_MCS_CCK_POS 9 151#define RATE_MCS_CCK_MSK (1 << RATE_MCS_CCK_POS) 152 153/* Bit 26: (1) VHT format, (0) legacy format in bits 8:0 */ 154#define RATE_MCS_VHT_POS 26 155#define RATE_MCS_VHT_MSK (1 << RATE_MCS_VHT_POS) 156 157 158/* 159 * High-throughput (HT) rate format for bits 7:0 160 * 161 * 2-0: MCS rate base 162 * 0) 6 Mbps 163 * 1) 12 Mbps 164 * 2) 18 Mbps 165 * 3) 24 Mbps 166 * 4) 36 Mbps 167 * 5) 48 Mbps 168 * 6) 54 Mbps 169 * 7) 60 Mbps 170 * 4-3: 0) Single stream (SISO) 171 * 1) Dual stream (MIMO) 172 * 2) Triple stream (MIMO) 173 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data 174 * (bits 7-6 are zero) 175 * 176 * Together the low 5 bits work out to the MCS index because we don't 177 * support MCSes above 15/23, and 0-7 have one stream, 8-15 have two 178 * streams and 16-23 have three streams. We could also support MCS 32 179 * which is the duplicate 20 MHz MCS (bit 5 set, all others zero.) 180 */ 181#define RATE_HT_MCS_RATE_CODE_MSK 0x7 182#define RATE_HT_MCS_NSS_POS 3 183#define RATE_HT_MCS_NSS_MSK (3 << RATE_HT_MCS_NSS_POS) 184 185/* Bit 10: (1) Use Green Field preamble */ 186#define RATE_HT_MCS_GF_POS 10 187#define RATE_HT_MCS_GF_MSK (1 << RATE_HT_MCS_GF_POS) 188 189#define RATE_HT_MCS_INDEX_MSK 0x3f 190 191/* 192 * Very High-throughput (VHT) rate format for bits 7:0 193 * 194 * 3-0: VHT MCS (0-9) 195 * 5-4: number of streams - 1: 196 * 0) Single stream (SISO) 197 * 1) Dual stream (MIMO) 198 * 2) Triple stream (MIMO) 199 */ 200 201/* Bit 4-5: (0) SISO, (1) MIMO2 (2) MIMO3 */ 202#define RATE_VHT_MCS_RATE_CODE_MSK 0xf 203#define RATE_VHT_MCS_NSS_POS 4 204#define RATE_VHT_MCS_NSS_MSK (3 << RATE_VHT_MCS_NSS_POS) 205 206/* 207 * Legacy OFDM rate format for bits 7:0 208 * 209 * 3-0: 0xD) 6 Mbps 210 * 0xF) 9 Mbps 211 * 0x5) 12 Mbps 212 * 0x7) 18 Mbps 213 * 0x9) 24 Mbps 214 * 0xB) 36 Mbps 215 * 0x1) 48 Mbps 216 * 0x3) 54 Mbps 217 * (bits 7-4 are 0) 218 * 219 * Legacy CCK rate format for bits 7:0: 220 * bit 8 is 0, bit 26 is 0, bit 9 is 1 (CCK): 221 * 222 * 6-0: 10) 1 Mbps 223 * 20) 2 Mbps 224 * 55) 5.5 Mbps 225 * 110) 11 Mbps 226 * (bit 7 is 0) 227 */ 228#define RATE_LEGACY_RATE_MSK 0xff 229 230 231/* 232 * Bit 11-12: (0) 20MHz, (1) 40MHz, (2) 80MHz, (3) 160MHz 233 * 0 and 1 are valid for HT and VHT, 2 and 3 only for VHT 234 */ 235#define RATE_MCS_CHAN_WIDTH_POS 11 236#define RATE_MCS_CHAN_WIDTH_MSK (3 << RATE_MCS_CHAN_WIDTH_POS) 237#define RATE_MCS_CHAN_WIDTH_20 (0 << RATE_MCS_CHAN_WIDTH_POS) 238#define RATE_MCS_CHAN_WIDTH_40 (1 << RATE_MCS_CHAN_WIDTH_POS) 239#define RATE_MCS_CHAN_WIDTH_80 (2 << RATE_MCS_CHAN_WIDTH_POS) 240#define RATE_MCS_CHAN_WIDTH_160 (3 << RATE_MCS_CHAN_WIDTH_POS) 241 242/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */ 243#define RATE_MCS_SGI_POS 13 244#define RATE_MCS_SGI_MSK (1 << RATE_MCS_SGI_POS) 245 246/* Bit 14-16: Antenna selection (1) Ant A, (2) Ant B, (4) Ant C */ 247#define RATE_MCS_ANT_POS 14 248#define RATE_MCS_ANT_A_MSK (1 << RATE_MCS_ANT_POS) 249#define RATE_MCS_ANT_B_MSK (2 << RATE_MCS_ANT_POS) 250#define RATE_MCS_ANT_C_MSK (4 << RATE_MCS_ANT_POS) 251#define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | \ 252 RATE_MCS_ANT_B_MSK) 253#define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | \ 254 RATE_MCS_ANT_C_MSK) 255#define RATE_MCS_ANT_MSK RATE_MCS_ANT_ABC_MSK 256#define RATE_MCS_ANT_NUM 3 257 258/* Bit 17-18: (0) SS, (1) SS*2 */ 259#define RATE_MCS_STBC_POS 17 260#define RATE_MCS_HT_STBC_MSK (3 << RATE_MCS_STBC_POS) 261#define RATE_MCS_VHT_STBC_MSK (1 << RATE_MCS_STBC_POS) 262 263/* Bit 19: (0) Beamforming is off, (1) Beamforming is on */ 264#define RATE_MCS_BF_POS 19 265#define RATE_MCS_BF_MSK (1 << RATE_MCS_BF_POS) 266 267/* Bit 20: (0) ZLF is off, (1) ZLF is on */ 268#define RATE_MCS_ZLF_POS 20 269#define RATE_MCS_ZLF_MSK (1 << RATE_MCS_ZLF_POS) 270 271/* Bit 24-25: (0) 20MHz (no dup), (1) 2x20MHz, (2) 4x20MHz, 3 8x20MHz */ 272#define RATE_MCS_DUP_POS 24 273#define RATE_MCS_DUP_MSK (3 << RATE_MCS_DUP_POS) 274 275/* Bit 27: (1) LDPC enabled, (0) LDPC disabled */ 276#define RATE_MCS_LDPC_POS 27 277#define RATE_MCS_LDPC_MSK (1 << RATE_MCS_LDPC_POS) 278 279 280/* Link Quality definitions */ 281 282/* # entries in rate scale table to support Tx retries */ 283#define LQ_MAX_RETRY_NUM 16 284 285/* Link quality command flags bit fields */ 286 287/* Bit 0: (0) Don't use RTS (1) Use RTS */ 288#define LQ_FLAG_USE_RTS_POS 0 289#define LQ_FLAG_USE_RTS_MSK (1 << LQ_FLAG_USE_RTS_POS) 290 291/* Bit 1-3: LQ command color. Used to match responses to LQ commands */ 292#define LQ_FLAG_COLOR_POS 1 293#define LQ_FLAG_COLOR_MSK (7 << LQ_FLAG_COLOR_POS) 294 295/* Bit 4-5: Tx RTS BW Signalling 296 * (0) No RTS BW signalling 297 * (1) Static BW signalling 298 * (2) Dynamic BW signalling 299 */ 300#define LQ_FLAG_RTS_BW_SIG_POS 4 301#define LQ_FLAG_RTS_BW_SIG_NONE (0 << LQ_FLAG_RTS_BW_SIG_POS) 302#define LQ_FLAG_RTS_BW_SIG_STATIC (1 << LQ_FLAG_RTS_BW_SIG_POS) 303#define LQ_FLAG_RTS_BW_SIG_DYNAMIC (2 << LQ_FLAG_RTS_BW_SIG_POS) 304 305/* Bit 6: (0) No dynamic BW selection (1) Allow dynamic BW selection 306 * Dyanmic BW selection allows Tx with narrower BW then requested in rates 307 */ 308#define LQ_FLAG_DYNAMIC_BW_POS 6 309#define LQ_FLAG_DYNAMIC_BW_MSK (1 << LQ_FLAG_DYNAMIC_BW_POS) 310 311/* Single Stream Tx Parameters (lq_cmd->ss_params) 312 * Flags to control a smart FW decision about whether BFER/STBC/SISO will be 313 * used for single stream Tx. 314 */ 315 316/* Bit 0-1: Max STBC streams allowed. Can be 0-3. 317 * (0) - No STBC allowed 318 * (1) - 2x1 STBC allowed (HT/VHT) 319 * (2) - 4x2 STBC allowed (HT/VHT) 320 * (3) - 3x2 STBC allowed (HT only) 321 * All our chips are at most 2 antennas so only (1) is valid for now. 322 */ 323#define LQ_SS_STBC_ALLOWED_POS 0 324#define LQ_SS_STBC_ALLOWED_MSK (3 << LQ_SS_STBC_ALLOWED_MSK) 325 326/* 2x1 STBC is allowed */ 327#define LQ_SS_STBC_1SS_ALLOWED (1 << LQ_SS_STBC_ALLOWED_POS) 328 329/* Bit 2: Beamformer (VHT only) is allowed */ 330#define LQ_SS_BFER_ALLOWED_POS 2 331#define LQ_SS_BFER_ALLOWED (1 << LQ_SS_BFER_ALLOWED_POS) 332 333/* Bit 3: Force BFER or STBC for testing 334 * If this is set: 335 * If BFER is allowed then force the ucode to choose BFER else 336 * If STBC is allowed then force the ucode to choose STBC over SISO 337 */ 338#define LQ_SS_FORCE_POS 3 339#define LQ_SS_FORCE (1 << LQ_SS_FORCE_POS) 340 341/* Bit 31: ss_params field is valid. Used for FW backward compatibility 342 * with other drivers which don't support the ss_params API yet 343 */ 344#define LQ_SS_PARAMS_VALID_POS 31 345#define LQ_SS_PARAMS_VALID (1 << LQ_SS_PARAMS_VALID_POS) 346 347/** 348 * struct iwl_lq_cmd - link quality command 349 * @sta_id: station to update 350 * @control: not used 351 * @flags: combination of LQ_FLAG_* 352 * @mimo_delim: the first SISO index in rs_table, which separates MIMO 353 * and SISO rates 354 * @single_stream_ant_msk: best antenna for SISO (can be dual in CDD). 355 * Should be ANT_[ABC] 356 * @dual_stream_ant_msk: best antennas for MIMO, combination of ANT_[ABC] 357 * @initial_rate_index: first index from rs_table per AC category 358 * @agg_time_limit: aggregation max time threshold in usec/100, meaning 359 * value of 100 is one usec. Range is 100 to 8000 360 * @agg_disable_start_th: try-count threshold for starting aggregation. 361 * If a frame has higher try-count, it should not be selected for 362 * starting an aggregation sequence. 363 * @agg_frame_cnt_limit: max frame count in an aggregation. 364 * 0: no limit 365 * 1: no aggregation (one frame per aggregation) 366 * 2 - 0x3f: maximal number of frames (up to 3f == 63) 367 * @rs_table: array of rates for each TX try, each is rate_n_flags, 368 * meaning it is a combination of RATE_MCS_* and IWL_RATE_*_PLCP 369 * @ss_params: single stream features. declare whether STBC or BFER are allowed. 370 */ 371struct iwl_lq_cmd { 372 u8 sta_id; 373 u8 reduced_tpc; 374 u16 control; 375 /* LINK_QUAL_GENERAL_PARAMS_API_S_VER_1 */ 376 u8 flags; 377 u8 mimo_delim; 378 u8 single_stream_ant_msk; 379 u8 dual_stream_ant_msk; 380 u8 initial_rate_index[AC_NUM]; 381 /* LINK_QUAL_AGG_PARAMS_API_S_VER_1 */ 382 __le16 agg_time_limit; 383 u8 agg_disable_start_th; 384 u8 agg_frame_cnt_limit; 385 __le32 reserved2; 386 __le32 rs_table[LQ_MAX_RETRY_NUM]; 387 __le32 ss_params; 388}; /* LINK_QUALITY_CMD_API_S_VER_1 */ 389#endif /* __fw_api_rs_h__ */ 390