1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2012-2014, 2018-2022 Intel Corporation 4 * Copyright (C) 2017 Intel Deutschland GmbH 5 */ 6 #ifndef __iwl_fw_api_rs_h__ 7 #define __iwl_fw_api_rs_h__ 8 9 #include "mac.h" 10 11 /** 12 * enum iwl_tlc_mng_cfg_flags_enum - options for TLC config flags 13 * @IWL_TLC_MNG_CFG_FLAGS_STBC_MSK: enable STBC. For HE this enables STBC for 14 * bandwidths <= 80MHz 15 * @IWL_TLC_MNG_CFG_FLAGS_LDPC_MSK: enable LDPC 16 * @IWL_TLC_MNG_CFG_FLAGS_HE_STBC_160MHZ_MSK: enable STBC in HE at 160MHz 17 * bandwidth 18 * @IWL_TLC_MNG_CFG_FLAGS_HE_DCM_NSS_1_MSK: enable HE Dual Carrier Modulation 19 * for BPSK (MCS 0) with 1 spatial 20 * stream 21 * @IWL_TLC_MNG_CFG_FLAGS_HE_DCM_NSS_2_MSK: enable HE Dual Carrier Modulation 22 * for BPSK (MCS 0) with 2 spatial 23 * streams 24 */ 25 enum iwl_tlc_mng_cfg_flags { 26 IWL_TLC_MNG_CFG_FLAGS_STBC_MSK = BIT(0), 27 IWL_TLC_MNG_CFG_FLAGS_LDPC_MSK = BIT(1), 28 IWL_TLC_MNG_CFG_FLAGS_HE_STBC_160MHZ_MSK = BIT(2), 29 IWL_TLC_MNG_CFG_FLAGS_HE_DCM_NSS_1_MSK = BIT(3), 30 IWL_TLC_MNG_CFG_FLAGS_HE_DCM_NSS_2_MSK = BIT(4), 31 }; 32 33 /** 34 * enum iwl_tlc_mng_cfg_cw - channel width options 35 * @IWL_TLC_MNG_CH_WIDTH_20MHZ: 20MHZ channel 36 * @IWL_TLC_MNG_CH_WIDTH_40MHZ: 40MHZ channel 37 * @IWL_TLC_MNG_CH_WIDTH_80MHZ: 80MHZ channel 38 * @IWL_TLC_MNG_CH_WIDTH_160MHZ: 160MHZ channel 39 * @IWL_TLC_MNG_CH_WIDTH_320MHZ: 320MHZ channel 40 */ 41 enum iwl_tlc_mng_cfg_cw { 42 IWL_TLC_MNG_CH_WIDTH_20MHZ, 43 IWL_TLC_MNG_CH_WIDTH_40MHZ, 44 IWL_TLC_MNG_CH_WIDTH_80MHZ, 45 IWL_TLC_MNG_CH_WIDTH_160MHZ, 46 IWL_TLC_MNG_CH_WIDTH_320MHZ, 47 }; 48 49 /** 50 * enum iwl_tlc_mng_cfg_chains - possible chains 51 * @IWL_TLC_MNG_CHAIN_A_MSK: chain A 52 * @IWL_TLC_MNG_CHAIN_B_MSK: chain B 53 */ 54 enum iwl_tlc_mng_cfg_chains { 55 IWL_TLC_MNG_CHAIN_A_MSK = BIT(0), 56 IWL_TLC_MNG_CHAIN_B_MSK = BIT(1), 57 }; 58 59 /** 60 * enum iwl_tlc_mng_cfg_mode - supported modes 61 * @IWL_TLC_MNG_MODE_CCK: enable CCK 62 * @IWL_TLC_MNG_MODE_OFDM_NON_HT: enable OFDM (non HT) 63 * @IWL_TLC_MNG_MODE_NON_HT: enable non HT 64 * @IWL_TLC_MNG_MODE_HT: enable HT 65 * @IWL_TLC_MNG_MODE_VHT: enable VHT 66 * @IWL_TLC_MNG_MODE_HE: enable HE 67 * @IWL_TLC_MNG_MODE_EHT: enable EHT 68 */ 69 enum iwl_tlc_mng_cfg_mode { 70 IWL_TLC_MNG_MODE_CCK = 0, 71 IWL_TLC_MNG_MODE_OFDM_NON_HT = IWL_TLC_MNG_MODE_CCK, 72 IWL_TLC_MNG_MODE_NON_HT = IWL_TLC_MNG_MODE_CCK, 73 IWL_TLC_MNG_MODE_HT, 74 IWL_TLC_MNG_MODE_VHT, 75 IWL_TLC_MNG_MODE_HE, 76 IWL_TLC_MNG_MODE_EHT, 77 }; 78 79 /** 80 * enum iwl_tlc_mng_ht_rates - HT/VHT/HE rates 81 * @IWL_TLC_MNG_HT_RATE_MCS0: index of MCS0 82 * @IWL_TLC_MNG_HT_RATE_MCS1: index of MCS1 83 * @IWL_TLC_MNG_HT_RATE_MCS2: index of MCS2 84 * @IWL_TLC_MNG_HT_RATE_MCS3: index of MCS3 85 * @IWL_TLC_MNG_HT_RATE_MCS4: index of MCS4 86 * @IWL_TLC_MNG_HT_RATE_MCS5: index of MCS5 87 * @IWL_TLC_MNG_HT_RATE_MCS6: index of MCS6 88 * @IWL_TLC_MNG_HT_RATE_MCS7: index of MCS7 89 * @IWL_TLC_MNG_HT_RATE_MCS8: index of MCS8 90 * @IWL_TLC_MNG_HT_RATE_MCS9: index of MCS9 91 * @IWL_TLC_MNG_HT_RATE_MCS10: index of MCS10 92 * @IWL_TLC_MNG_HT_RATE_MCS11: index of MCS11 93 * @IWL_TLC_MNG_HT_RATE_MAX: maximal rate for HT/VHT 94 */ 95 enum iwl_tlc_mng_ht_rates { 96 IWL_TLC_MNG_HT_RATE_MCS0 = 0, 97 IWL_TLC_MNG_HT_RATE_MCS1, 98 IWL_TLC_MNG_HT_RATE_MCS2, 99 IWL_TLC_MNG_HT_RATE_MCS3, 100 IWL_TLC_MNG_HT_RATE_MCS4, 101 IWL_TLC_MNG_HT_RATE_MCS5, 102 IWL_TLC_MNG_HT_RATE_MCS6, 103 IWL_TLC_MNG_HT_RATE_MCS7, 104 IWL_TLC_MNG_HT_RATE_MCS8, 105 IWL_TLC_MNG_HT_RATE_MCS9, 106 IWL_TLC_MNG_HT_RATE_MCS10, 107 IWL_TLC_MNG_HT_RATE_MCS11, 108 IWL_TLC_MNG_HT_RATE_MAX = IWL_TLC_MNG_HT_RATE_MCS11, 109 }; 110 111 enum IWL_TLC_MNG_NSS { 112 IWL_TLC_NSS_1, 113 IWL_TLC_NSS_2, 114 IWL_TLC_NSS_MAX 115 }; 116 117 /** 118 * enum IWL_TLC_MCS_PER_BW - mcs index per BW 119 * @IWL_TLC_MCS_PER_BW_80: mcs for bw - 20Hhz, 40Hhz, 80Hhz 120 * @IWL_TLC_MCS_PER_BW_160: mcs for bw - 160Mhz 121 * @IWL_TLC_MCS_PER_BW_320: mcs for bw - 320Mhz 122 * @IWL_TLC_MCS_PER_BW_NUM_V3: number of entries up to version 3 123 * @IWL_TLC_MCS_PER_BW_NUM_V4: number of entries from version 4 124 */ 125 enum IWL_TLC_MCS_PER_BW { 126 IWL_TLC_MCS_PER_BW_80, 127 IWL_TLC_MCS_PER_BW_160, 128 IWL_TLC_MCS_PER_BW_320, 129 IWL_TLC_MCS_PER_BW_NUM_V3 = IWL_TLC_MCS_PER_BW_160 + 1, 130 IWL_TLC_MCS_PER_BW_NUM_V4 = IWL_TLC_MCS_PER_BW_320 + 1, 131 }; 132 133 /** 134 * struct iwl_tlc_config_cmd_v3 - TLC configuration 135 * @sta_id: station id 136 * @reserved1: reserved 137 * @max_ch_width: max supported channel width from @enum iwl_tlc_mng_cfg_cw 138 * @mode: &enum iwl_tlc_mng_cfg_mode 139 * @chains: bitmask of &enum iwl_tlc_mng_cfg_chains 140 * @amsdu: TX amsdu is supported 141 * @flags: bitmask of &enum iwl_tlc_mng_cfg_flags 142 * @non_ht_rates: bitmap of supported legacy rates 143 * @ht_rates: bitmap of &enum iwl_tlc_mng_ht_rates, per &enum IWL_TLC_MCS_PER_BW 144 * <nss, channel-width> pair (0 - 80mhz width and below, 1 - 160mhz). 145 * @max_mpdu_len: max MPDU length, in bytes 146 * @sgi_ch_width_supp: bitmap of SGI support per channel width 147 * use BIT(@enum iwl_tlc_mng_cfg_cw) 148 * @reserved2: reserved 149 * @max_tx_op: max TXOP in uSecs for all AC (BK, BE, VO, VI), 150 * set zero for no limit. 151 */ 152 struct iwl_tlc_config_cmd_v3 { 153 u8 sta_id; 154 u8 reserved1[3]; 155 u8 max_ch_width; 156 u8 mode; 157 u8 chains; 158 u8 amsdu; 159 __le16 flags; 160 __le16 non_ht_rates; 161 __le16 ht_rates[IWL_TLC_NSS_MAX][IWL_TLC_MCS_PER_BW_NUM_V3]; 162 __le16 max_mpdu_len; 163 u8 sgi_ch_width_supp; 164 u8 reserved2; 165 __le32 max_tx_op; 166 } __packed; /* TLC_MNG_CONFIG_CMD_API_S_VER_3 */ 167 168 /** 169 * struct iwl_tlc_config_cmd_v4 - TLC configuration 170 * @sta_id: station id 171 * @reserved1: reserved 172 * @max_ch_width: max supported channel width from &enum iwl_tlc_mng_cfg_cw 173 * @mode: &enum iwl_tlc_mng_cfg_mode 174 * @chains: bitmask of &enum iwl_tlc_mng_cfg_chains 175 * @sgi_ch_width_supp: bitmap of SGI support per channel width 176 * use BIT(&enum iwl_tlc_mng_cfg_cw) 177 * @flags: bitmask of &enum iwl_tlc_mng_cfg_flags 178 * @non_ht_rates: bitmap of supported legacy rates 179 * @ht_rates: bitmap of &enum iwl_tlc_mng_ht_rates, per <nss, channel-width> 180 * pair (0 - 80mhz width and below, 1 - 160mhz, 2 - 320mhz). 181 * @max_mpdu_len: max MPDU length, in bytes 182 * @max_tx_op: max TXOP in uSecs for all AC (BK, BE, VO, VI), 183 * set zero for no limit. 184 */ 185 struct iwl_tlc_config_cmd_v4 { 186 u8 sta_id; 187 u8 reserved1[3]; 188 u8 max_ch_width; 189 u8 mode; 190 u8 chains; 191 u8 sgi_ch_width_supp; 192 __le16 flags; 193 __le16 non_ht_rates; 194 __le16 ht_rates[IWL_TLC_NSS_MAX][IWL_TLC_MCS_PER_BW_NUM_V4]; 195 __le16 max_mpdu_len; 196 __le16 max_tx_op; 197 } __packed; /* TLC_MNG_CONFIG_CMD_API_S_VER_4 */ 198 199 /** 200 * enum iwl_tlc_update_flags - updated fields 201 * @IWL_TLC_NOTIF_FLAG_RATE: last initial rate update 202 * @IWL_TLC_NOTIF_FLAG_AMSDU: umsdu parameters update 203 */ 204 enum iwl_tlc_update_flags { 205 IWL_TLC_NOTIF_FLAG_RATE = BIT(0), 206 IWL_TLC_NOTIF_FLAG_AMSDU = BIT(1), 207 }; 208 209 /** 210 * struct iwl_tlc_update_notif - TLC notification from FW 211 * @sta_id: station id 212 * @reserved: reserved 213 * @flags: bitmap of notifications reported 214 * @rate: current initial rate 215 * @amsdu_size: Max AMSDU size, in bytes 216 * @amsdu_enabled: bitmap for per-TID AMSDU enablement 217 */ 218 struct iwl_tlc_update_notif { 219 u8 sta_id; 220 u8 reserved[3]; 221 __le32 flags; 222 __le32 rate; 223 __le32 amsdu_size; 224 __le32 amsdu_enabled; 225 } __packed; /* TLC_MNG_UPDATE_NTFY_API_S_VER_2 */ 226 227 228 #define IWL_MAX_MCS_DISPLAY_SIZE 12 229 230 struct iwl_rate_mcs_info { 231 char mbps[IWL_MAX_MCS_DISPLAY_SIZE]; 232 char mcs[IWL_MAX_MCS_DISPLAY_SIZE]; 233 }; 234 235 /* 236 * These serve as indexes into 237 * struct iwl_rate_info fw_rate_idx_to_plcp[IWL_RATE_COUNT]; 238 * TODO: avoid overlap between legacy and HT rates 239 */ 240 enum { 241 IWL_RATE_1M_INDEX = 0, 242 IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX, 243 IWL_RATE_2M_INDEX, 244 IWL_RATE_5M_INDEX, 245 IWL_RATE_11M_INDEX, 246 IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX, 247 IWL_RATE_6M_INDEX, 248 IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX, 249 IWL_RATE_MCS_0_INDEX = IWL_RATE_6M_INDEX, 250 IWL_FIRST_HT_RATE = IWL_RATE_MCS_0_INDEX, 251 IWL_FIRST_VHT_RATE = IWL_RATE_MCS_0_INDEX, 252 IWL_RATE_9M_INDEX, 253 IWL_RATE_12M_INDEX, 254 IWL_RATE_MCS_1_INDEX = IWL_RATE_12M_INDEX, 255 IWL_RATE_18M_INDEX, 256 IWL_RATE_MCS_2_INDEX = IWL_RATE_18M_INDEX, 257 IWL_RATE_24M_INDEX, 258 IWL_RATE_MCS_3_INDEX = IWL_RATE_24M_INDEX, 259 IWL_RATE_36M_INDEX, 260 IWL_RATE_MCS_4_INDEX = IWL_RATE_36M_INDEX, 261 IWL_RATE_48M_INDEX, 262 IWL_RATE_MCS_5_INDEX = IWL_RATE_48M_INDEX, 263 IWL_RATE_54M_INDEX, 264 IWL_RATE_MCS_6_INDEX = IWL_RATE_54M_INDEX, 265 IWL_LAST_NON_HT_RATE = IWL_RATE_54M_INDEX, 266 IWL_RATE_60M_INDEX, 267 IWL_RATE_MCS_7_INDEX = IWL_RATE_60M_INDEX, 268 IWL_LAST_HT_RATE = IWL_RATE_MCS_7_INDEX, 269 IWL_RATE_MCS_8_INDEX, 270 IWL_RATE_MCS_9_INDEX, 271 IWL_LAST_VHT_RATE = IWL_RATE_MCS_9_INDEX, 272 IWL_RATE_MCS_10_INDEX, 273 IWL_RATE_MCS_11_INDEX, 274 IWL_LAST_HE_RATE = IWL_RATE_MCS_11_INDEX, 275 IWL_RATE_COUNT_LEGACY = IWL_LAST_NON_HT_RATE + 1, 276 IWL_RATE_COUNT = IWL_LAST_HE_RATE + 1, 277 IWL_RATE_INVM_INDEX = IWL_RATE_COUNT, 278 IWL_RATE_INVALID = IWL_RATE_COUNT, 279 }; 280 281 #define IWL_RATE_BIT_MSK(r) BIT(IWL_RATE_##r##M_INDEX) 282 283 /* fw API values for legacy bit rates, both OFDM and CCK */ 284 enum { 285 IWL_RATE_6M_PLCP = 13, 286 IWL_RATE_9M_PLCP = 15, 287 IWL_RATE_12M_PLCP = 5, 288 IWL_RATE_18M_PLCP = 7, 289 IWL_RATE_24M_PLCP = 9, 290 IWL_RATE_36M_PLCP = 11, 291 IWL_RATE_48M_PLCP = 1, 292 IWL_RATE_54M_PLCP = 3, 293 IWL_RATE_1M_PLCP = 10, 294 IWL_RATE_2M_PLCP = 20, 295 IWL_RATE_5M_PLCP = 55, 296 IWL_RATE_11M_PLCP = 110, 297 IWL_RATE_INVM_PLCP = -1, 298 }; 299 300 /* 301 * rate_n_flags bit fields version 1 302 * 303 * The 32-bit value has different layouts in the low 8 bites depending on the 304 * format. There are three formats, HT, VHT and legacy (11abg, with subformats 305 * for CCK and OFDM). 306 * 307 * High-throughput (HT) rate format 308 * bit 8 is 1, bit 26 is 0, bit 9 is 0 (OFDM) 309 * Very High-throughput (VHT) rate format 310 * bit 8 is 0, bit 26 is 1, bit 9 is 0 (OFDM) 311 * Legacy OFDM rate format for bits 7:0 312 * bit 8 is 0, bit 26 is 0, bit 9 is 0 (OFDM) 313 * Legacy CCK rate format for bits 7:0: 314 * bit 8 is 0, bit 26 is 0, bit 9 is 1 (CCK) 315 */ 316 317 /* Bit 8: (1) HT format, (0) legacy or VHT format */ 318 #define RATE_MCS_HT_POS 8 319 #define RATE_MCS_HT_MSK_V1 BIT(RATE_MCS_HT_POS) 320 321 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */ 322 #define RATE_MCS_CCK_POS_V1 9 323 #define RATE_MCS_CCK_MSK_V1 BIT(RATE_MCS_CCK_POS_V1) 324 325 /* Bit 26: (1) VHT format, (0) legacy format in bits 8:0 */ 326 #define RATE_MCS_VHT_POS_V1 26 327 #define RATE_MCS_VHT_MSK_V1 BIT(RATE_MCS_VHT_POS_V1) 328 329 330 /* 331 * High-throughput (HT) rate format for bits 7:0 332 * 333 * 2-0: MCS rate base 334 * 0) 6 Mbps 335 * 1) 12 Mbps 336 * 2) 18 Mbps 337 * 3) 24 Mbps 338 * 4) 36 Mbps 339 * 5) 48 Mbps 340 * 6) 54 Mbps 341 * 7) 60 Mbps 342 * 4-3: 0) Single stream (SISO) 343 * 1) Dual stream (MIMO) 344 * 2) Triple stream (MIMO) 345 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data 346 * (bits 7-6 are zero) 347 * 348 * Together the low 5 bits work out to the MCS index because we don't 349 * support MCSes above 15/23, and 0-7 have one stream, 8-15 have two 350 * streams and 16-23 have three streams. We could also support MCS 32 351 * which is the duplicate 20 MHz MCS (bit 5 set, all others zero.) 352 */ 353 #define RATE_HT_MCS_RATE_CODE_MSK_V1 0x7 354 #define RATE_HT_MCS_NSS_POS_V1 3 355 #define RATE_HT_MCS_NSS_MSK_V1 (3 << RATE_HT_MCS_NSS_POS_V1) 356 #define RATE_HT_MCS_MIMO2_MSK BIT(RATE_HT_MCS_NSS_POS_V1) 357 358 /* Bit 10: (1) Use Green Field preamble */ 359 #define RATE_HT_MCS_GF_POS 10 360 #define RATE_HT_MCS_GF_MSK (1 << RATE_HT_MCS_GF_POS) 361 362 #define RATE_HT_MCS_INDEX_MSK_V1 0x3f 363 364 /* 365 * Very High-throughput (VHT) rate format for bits 7:0 366 * 367 * 3-0: VHT MCS (0-9) 368 * 5-4: number of streams - 1: 369 * 0) Single stream (SISO) 370 * 1) Dual stream (MIMO) 371 * 2) Triple stream (MIMO) 372 */ 373 374 /* Bit 4-5: (0) SISO, (1) MIMO2 (2) MIMO3 */ 375 #define RATE_VHT_MCS_RATE_CODE_MSK 0xf 376 #define RATE_VHT_MCS_NSS_POS 4 377 #define RATE_VHT_MCS_NSS_MSK (3 << RATE_VHT_MCS_NSS_POS) 378 #define RATE_VHT_MCS_MIMO2_MSK BIT(RATE_VHT_MCS_NSS_POS) 379 380 /* 381 * Legacy OFDM rate format for bits 7:0 382 * 383 * 3-0: 0xD) 6 Mbps 384 * 0xF) 9 Mbps 385 * 0x5) 12 Mbps 386 * 0x7) 18 Mbps 387 * 0x9) 24 Mbps 388 * 0xB) 36 Mbps 389 * 0x1) 48 Mbps 390 * 0x3) 54 Mbps 391 * (bits 7-4 are 0) 392 * 393 * Legacy CCK rate format for bits 7:0: 394 * bit 8 is 0, bit 26 is 0, bit 9 is 1 (CCK): 395 * 396 * 6-0: 10) 1 Mbps 397 * 20) 2 Mbps 398 * 55) 5.5 Mbps 399 * 110) 11 Mbps 400 * (bit 7 is 0) 401 */ 402 #define RATE_LEGACY_RATE_MSK_V1 0xff 403 404 /* Bit 10 - OFDM HE */ 405 #define RATE_MCS_HE_POS_V1 10 406 #define RATE_MCS_HE_MSK_V1 BIT(RATE_MCS_HE_POS_V1) 407 408 /* 409 * Bit 11-12: (0) 20MHz, (1) 40MHz, (2) 80MHz, (3) 160MHz 410 * 0 and 1 are valid for HT and VHT, 2 and 3 only for VHT 411 */ 412 #define RATE_MCS_CHAN_WIDTH_POS 11 413 #define RATE_MCS_CHAN_WIDTH_MSK_V1 (3 << RATE_MCS_CHAN_WIDTH_POS) 414 415 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */ 416 #define RATE_MCS_SGI_POS_V1 13 417 #define RATE_MCS_SGI_MSK_V1 BIT(RATE_MCS_SGI_POS_V1) 418 419 /* Bit 14-16: Antenna selection (1) Ant A, (2) Ant B, (4) Ant C */ 420 #define RATE_MCS_ANT_POS 14 421 #define RATE_MCS_ANT_A_MSK (1 << RATE_MCS_ANT_POS) 422 #define RATE_MCS_ANT_B_MSK (2 << RATE_MCS_ANT_POS) 423 #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | \ 424 RATE_MCS_ANT_B_MSK) 425 #define RATE_MCS_ANT_MSK RATE_MCS_ANT_AB_MSK 426 427 /* Bit 17: (0) SS, (1) SS*2 */ 428 #define RATE_MCS_STBC_POS 17 429 #define RATE_MCS_STBC_MSK BIT(RATE_MCS_STBC_POS) 430 431 /* Bit 18: OFDM-HE dual carrier mode */ 432 #define RATE_HE_DUAL_CARRIER_MODE 18 433 #define RATE_HE_DUAL_CARRIER_MODE_MSK BIT(RATE_HE_DUAL_CARRIER_MODE) 434 435 /* Bit 19: (0) Beamforming is off, (1) Beamforming is on */ 436 #define RATE_MCS_BF_POS 19 437 #define RATE_MCS_BF_MSK (1 << RATE_MCS_BF_POS) 438 439 /* 440 * Bit 20-21: HE LTF type and guard interval 441 * HE (ext) SU: 442 * 0 1xLTF+0.8us 443 * 1 2xLTF+0.8us 444 * 2 2xLTF+1.6us 445 * 3 & SGI (bit 13) clear 4xLTF+3.2us 446 * 3 & SGI (bit 13) set 4xLTF+0.8us 447 * HE MU: 448 * 0 4xLTF+0.8us 449 * 1 2xLTF+0.8us 450 * 2 2xLTF+1.6us 451 * 3 4xLTF+3.2us 452 * HE TRIG: 453 * 0 1xLTF+1.6us 454 * 1 2xLTF+1.6us 455 * 2 4xLTF+3.2us 456 * 3 (does not occur) 457 */ 458 #define RATE_MCS_HE_GI_LTF_POS 20 459 #define RATE_MCS_HE_GI_LTF_MSK_V1 (3 << RATE_MCS_HE_GI_LTF_POS) 460 461 /* Bit 22-23: HE type. (0) SU, (1) SU_EXT, (2) MU, (3) trigger based */ 462 #define RATE_MCS_HE_TYPE_POS_V1 22 463 #define RATE_MCS_HE_TYPE_SU_V1 (0 << RATE_MCS_HE_TYPE_POS_V1) 464 #define RATE_MCS_HE_TYPE_EXT_SU_V1 BIT(RATE_MCS_HE_TYPE_POS_V1) 465 #define RATE_MCS_HE_TYPE_MU_V1 (2 << RATE_MCS_HE_TYPE_POS_V1) 466 #define RATE_MCS_HE_TYPE_TRIG_V1 (3 << RATE_MCS_HE_TYPE_POS_V1) 467 #define RATE_MCS_HE_TYPE_MSK_V1 (3 << RATE_MCS_HE_TYPE_POS_V1) 468 469 /* Bit 24-25: (0) 20MHz (no dup), (1) 2x20MHz, (2) 4x20MHz, 3 8x20MHz */ 470 #define RATE_MCS_DUP_POS_V1 24 471 #define RATE_MCS_DUP_MSK_V1 (3 << RATE_MCS_DUP_POS_V1) 472 473 /* Bit 27: (1) LDPC enabled, (0) LDPC disabled */ 474 #define RATE_MCS_LDPC_POS_V1 27 475 #define RATE_MCS_LDPC_MSK_V1 BIT(RATE_MCS_LDPC_POS_V1) 476 477 /* Bit 28: (1) 106-tone RX (8 MHz RU), (0) normal bandwidth */ 478 #define RATE_MCS_HE_106T_POS_V1 28 479 #define RATE_MCS_HE_106T_MSK_V1 BIT(RATE_MCS_HE_106T_POS_V1) 480 481 /* Bit 30-31: (1) RTS, (2) CTS */ 482 #define RATE_MCS_RTS_REQUIRED_POS (30) 483 #define RATE_MCS_RTS_REQUIRED_MSK (0x1 << RATE_MCS_RTS_REQUIRED_POS) 484 485 #define RATE_MCS_CTS_REQUIRED_POS (31) 486 #define RATE_MCS_CTS_REQUIRED_MSK (0x1 << RATE_MCS_CTS_REQUIRED_POS) 487 488 /* rate_n_flags bit field version 2 489 * 490 * The 32-bit value has different layouts in the low 8 bits depending on the 491 * format. There are three formats, HT, VHT and legacy (11abg, with subformats 492 * for CCK and OFDM). 493 * 494 */ 495 496 /* Bits 10-8: rate format 497 * (0) Legacy CCK (1) Legacy OFDM (2) High-throughput (HT) 498 * (3) Very High-throughput (VHT) (4) High-efficiency (HE) 499 * (5) Extremely High-throughput (EHT) 500 */ 501 #define RATE_MCS_MOD_TYPE_POS 8 502 #define RATE_MCS_MOD_TYPE_MSK (0x7 << RATE_MCS_MOD_TYPE_POS) 503 #define RATE_MCS_CCK_MSK (0 << RATE_MCS_MOD_TYPE_POS) 504 #define RATE_MCS_LEGACY_OFDM_MSK (1 << RATE_MCS_MOD_TYPE_POS) 505 #define RATE_MCS_HT_MSK (2 << RATE_MCS_MOD_TYPE_POS) 506 #define RATE_MCS_VHT_MSK (3 << RATE_MCS_MOD_TYPE_POS) 507 #define RATE_MCS_HE_MSK (4 << RATE_MCS_MOD_TYPE_POS) 508 #define RATE_MCS_EHT_MSK (5 << RATE_MCS_MOD_TYPE_POS) 509 510 /* 511 * Legacy CCK rate format for bits 0:3: 512 * 513 * (0) 0xa - 1 Mbps 514 * (1) 0x14 - 2 Mbps 515 * (2) 0x37 - 5.5 Mbps 516 * (3) 0x6e - 11 nbps 517 * 518 * Legacy OFDM rate format for bis 3:0: 519 * 520 * (0) 6 Mbps 521 * (1) 9 Mbps 522 * (2) 12 Mbps 523 * (3) 18 Mbps 524 * (4) 24 Mbps 525 * (5) 36 Mbps 526 * (6) 48 Mbps 527 * (7) 54 Mbps 528 * 529 */ 530 #define RATE_LEGACY_RATE_MSK 0x7 531 532 /* 533 * HT, VHT, HE, EHT rate format for bits 3:0 534 * 3-0: MCS 535 * 536 */ 537 #define RATE_HT_MCS_CODE_MSK 0x7 538 #define RATE_MCS_NSS_POS 4 539 #define RATE_MCS_NSS_MSK (1 << RATE_MCS_NSS_POS) 540 #define RATE_MCS_CODE_MSK 0xf 541 #define RATE_HT_MCS_INDEX(r) ((((r) & RATE_MCS_NSS_MSK) >> 1) | \ 542 ((r) & RATE_HT_MCS_CODE_MSK)) 543 544 /* Bits 7-5: reserved */ 545 546 /* 547 * Bits 13-11: (0) 20MHz, (1) 40MHz, (2) 80MHz, (3) 160MHz, (4) 320MHz 548 */ 549 #define RATE_MCS_CHAN_WIDTH_MSK (0x7 << RATE_MCS_CHAN_WIDTH_POS) 550 #define RATE_MCS_CHAN_WIDTH_20 (0 << RATE_MCS_CHAN_WIDTH_POS) 551 #define RATE_MCS_CHAN_WIDTH_40 (1 << RATE_MCS_CHAN_WIDTH_POS) 552 #define RATE_MCS_CHAN_WIDTH_80 (2 << RATE_MCS_CHAN_WIDTH_POS) 553 #define RATE_MCS_CHAN_WIDTH_160 (3 << RATE_MCS_CHAN_WIDTH_POS) 554 #define RATE_MCS_CHAN_WIDTH_320 (4 << RATE_MCS_CHAN_WIDTH_POS) 555 556 /* Bit 15-14: Antenna selection: 557 * Bit 14: Ant A active 558 * Bit 15: Ant B active 559 * 560 * All relevant definitions are same as in v1 561 */ 562 563 /* Bit 16 (1) LDPC enables, (0) LDPC disabled */ 564 #define RATE_MCS_LDPC_POS 16 565 #define RATE_MCS_LDPC_MSK (1 << RATE_MCS_LDPC_POS) 566 567 /* Bit 17: (0) SS, (1) SS*2 (same as v1) */ 568 569 /* Bit 18: OFDM-HE dual carrier mode (same as v1) */ 570 571 /* Bit 19: (0) Beamforming is off, (1) Beamforming is on (same as v1) */ 572 573 /* 574 * Bit 22-20: HE LTF type and guard interval 575 * CCK: 576 * 0 long preamble 577 * 1 short preamble 578 * HT/VHT: 579 * 0 0.8us 580 * 1 0.4us 581 * HE (ext) SU: 582 * 0 1xLTF+0.8us 583 * 1 2xLTF+0.8us 584 * 2 2xLTF+1.6us 585 * 3 4xLTF+3.2us 586 * 4 4xLTF+0.8us 587 * HE MU: 588 * 0 4xLTF+0.8us 589 * 1 2xLTF+0.8us 590 * 2 2xLTF+1.6us 591 * 3 4xLTF+3.2us 592 * HE TRIG: 593 * 0 1xLTF+1.6us 594 * 1 2xLTF+1.6us 595 * 2 4xLTF+3.2us 596 * */ 597 #define RATE_MCS_HE_GI_LTF_MSK (0x7 << RATE_MCS_HE_GI_LTF_POS) 598 #define RATE_MCS_SGI_POS RATE_MCS_HE_GI_LTF_POS 599 #define RATE_MCS_SGI_MSK (1 << RATE_MCS_SGI_POS) 600 #define RATE_MCS_HE_SU_4_LTF 3 601 #define RATE_MCS_HE_SU_4_LTF_08_GI 4 602 603 /* Bit 24-23: HE type. (0) SU, (1) SU_EXT, (2) MU, (3) trigger based */ 604 #define RATE_MCS_HE_TYPE_POS 23 605 #define RATE_MCS_HE_TYPE_SU (0 << RATE_MCS_HE_TYPE_POS) 606 #define RATE_MCS_HE_TYPE_EXT_SU (1 << RATE_MCS_HE_TYPE_POS) 607 #define RATE_MCS_HE_TYPE_MU (2 << RATE_MCS_HE_TYPE_POS) 608 #define RATE_MCS_HE_TYPE_TRIG (3 << RATE_MCS_HE_TYPE_POS) 609 #define RATE_MCS_HE_TYPE_MSK (3 << RATE_MCS_HE_TYPE_POS) 610 611 /* Bit 25: duplicate channel enabled 612 * 613 * if this bit is set, duplicate is according to BW (bits 11-13): 614 * 615 * CCK: 2x 20MHz 616 * OFDM Legacy: N x 20Mhz, (N = BW \ 2 , either 2, 4, 8, 16) 617 * EHT: 2 x BW/2, (80 - 2x40, 160 - 2x80, 320 - 2x160) 618 * */ 619 #define RATE_MCS_DUP_POS 25 620 #define RATE_MCS_DUP_MSK (1 << RATE_MCS_DUP_POS) 621 622 /* Bit 26: (1) 106-tone RX (8 MHz RU), (0) normal bandwidth */ 623 #define RATE_MCS_HE_106T_POS 26 624 #define RATE_MCS_HE_106T_MSK (1 << RATE_MCS_HE_106T_POS) 625 626 /* Bit 27: EHT extra LTF: 627 * instead of 1 LTF for SISO use 2 LTFs, 628 * instead of 2 LTFs for NSTS=2 use 4 LTFs*/ 629 #define RATE_MCS_EHT_EXTRA_LTF_POS 27 630 #define RATE_MCS_EHT_EXTRA_LTF_MSK (1 << RATE_MCS_EHT_EXTRA_LTF_POS) 631 632 /* Bit 31-28: reserved */ 633 634 /* Link Quality definitions */ 635 636 /* # entries in rate scale table to support Tx retries */ 637 #define LQ_MAX_RETRY_NUM 16 638 639 /* Link quality command flags bit fields */ 640 641 /* Bit 0: (0) Don't use RTS (1) Use RTS */ 642 #define LQ_FLAG_USE_RTS_POS 0 643 #define LQ_FLAG_USE_RTS_MSK (1 << LQ_FLAG_USE_RTS_POS) 644 645 /* Bit 1-3: LQ command color. Used to match responses to LQ commands */ 646 #define LQ_FLAG_COLOR_POS 1 647 #define LQ_FLAG_COLOR_MSK (7 << LQ_FLAG_COLOR_POS) 648 #define LQ_FLAG_COLOR_GET(_f) (((_f) & LQ_FLAG_COLOR_MSK) >>\ 649 LQ_FLAG_COLOR_POS) 650 #define LQ_FLAGS_COLOR_INC(_c) ((((_c) + 1) << LQ_FLAG_COLOR_POS) &\ 651 LQ_FLAG_COLOR_MSK) 652 #define LQ_FLAG_COLOR_SET(_f, _c) ((_c) | ((_f) & ~LQ_FLAG_COLOR_MSK)) 653 654 /* Bit 4-5: Tx RTS BW Signalling 655 * (0) No RTS BW signalling 656 * (1) Static BW signalling 657 * (2) Dynamic BW signalling 658 */ 659 #define LQ_FLAG_RTS_BW_SIG_POS 4 660 #define LQ_FLAG_RTS_BW_SIG_NONE (0 << LQ_FLAG_RTS_BW_SIG_POS) 661 #define LQ_FLAG_RTS_BW_SIG_STATIC (1 << LQ_FLAG_RTS_BW_SIG_POS) 662 #define LQ_FLAG_RTS_BW_SIG_DYNAMIC (2 << LQ_FLAG_RTS_BW_SIG_POS) 663 664 /* Bit 6: (0) No dynamic BW selection (1) Allow dynamic BW selection 665 * Dyanmic BW selection allows Tx with narrower BW then requested in rates 666 */ 667 #define LQ_FLAG_DYNAMIC_BW_POS 6 668 #define LQ_FLAG_DYNAMIC_BW_MSK (1 << LQ_FLAG_DYNAMIC_BW_POS) 669 670 /* Single Stream Tx Parameters (lq_cmd->ss_params) 671 * Flags to control a smart FW decision about whether BFER/STBC/SISO will be 672 * used for single stream Tx. 673 */ 674 675 /* Bit 0-1: Max STBC streams allowed. Can be 0-3. 676 * (0) - No STBC allowed 677 * (1) - 2x1 STBC allowed (HT/VHT) 678 * (2) - 4x2 STBC allowed (HT/VHT) 679 * (3) - 3x2 STBC allowed (HT only) 680 * All our chips are at most 2 antennas so only (1) is valid for now. 681 */ 682 #define LQ_SS_STBC_ALLOWED_POS 0 683 #define LQ_SS_STBC_ALLOWED_MSK (3 << LQ_SS_STBC_ALLOWED_MSK) 684 685 /* 2x1 STBC is allowed */ 686 #define LQ_SS_STBC_1SS_ALLOWED (1 << LQ_SS_STBC_ALLOWED_POS) 687 688 /* Bit 2: Beamformer (VHT only) is allowed */ 689 #define LQ_SS_BFER_ALLOWED_POS 2 690 #define LQ_SS_BFER_ALLOWED (1 << LQ_SS_BFER_ALLOWED_POS) 691 692 /* Bit 3: Force BFER or STBC for testing 693 * If this is set: 694 * If BFER is allowed then force the ucode to choose BFER else 695 * If STBC is allowed then force the ucode to choose STBC over SISO 696 */ 697 #define LQ_SS_FORCE_POS 3 698 #define LQ_SS_FORCE (1 << LQ_SS_FORCE_POS) 699 700 /* Bit 31: ss_params field is valid. Used for FW backward compatibility 701 * with other drivers which don't support the ss_params API yet 702 */ 703 #define LQ_SS_PARAMS_VALID_POS 31 704 #define LQ_SS_PARAMS_VALID (1 << LQ_SS_PARAMS_VALID_POS) 705 706 /** 707 * struct iwl_lq_cmd - link quality command 708 * @sta_id: station to update 709 * @reduced_tpc: reduced transmit power control value 710 * @control: not used 711 * @flags: combination of LQ_FLAG_* 712 * @mimo_delim: the first SISO index in rs_table, which separates MIMO 713 * and SISO rates 714 * @single_stream_ant_msk: best antenna for SISO (can be dual in CDD). 715 * Should be ANT_[ABC] 716 * @dual_stream_ant_msk: best antennas for MIMO, combination of ANT_[ABC] 717 * @initial_rate_index: first index from rs_table per AC category 718 * @agg_time_limit: aggregation max time threshold in usec/100, meaning 719 * value of 100 is one usec. Range is 100 to 8000 720 * @agg_disable_start_th: try-count threshold for starting aggregation. 721 * If a frame has higher try-count, it should not be selected for 722 * starting an aggregation sequence. 723 * @agg_frame_cnt_limit: max frame count in an aggregation. 724 * 0: no limit 725 * 1: no aggregation (one frame per aggregation) 726 * 2 - 0x3f: maximal number of frames (up to 3f == 63) 727 * @reserved2: reserved 728 * @rs_table: array of rates for each TX try, each is rate_n_flags, 729 * meaning it is a combination of RATE_MCS_* and IWL_RATE_*_PLCP 730 * @ss_params: single stream features. declare whether STBC or BFER are allowed. 731 */ 732 struct iwl_lq_cmd { 733 u8 sta_id; 734 u8 reduced_tpc; 735 __le16 control; 736 /* LINK_QUAL_GENERAL_PARAMS_API_S_VER_1 */ 737 u8 flags; 738 u8 mimo_delim; 739 u8 single_stream_ant_msk; 740 u8 dual_stream_ant_msk; 741 u8 initial_rate_index[AC_NUM]; 742 /* LINK_QUAL_AGG_PARAMS_API_S_VER_1 */ 743 __le16 agg_time_limit; 744 u8 agg_disable_start_th; 745 u8 agg_frame_cnt_limit; 746 __le32 reserved2; 747 __le32 rs_table[LQ_MAX_RETRY_NUM]; 748 __le32 ss_params; 749 }; /* LINK_QUALITY_CMD_API_S_VER_1 */ 750 751 u8 iwl_fw_rate_idx_to_plcp(int idx); 752 u32 iwl_new_rate_from_v1(u32 rate_v1); 753 const struct iwl_rate_mcs_info *iwl_rate_mcs(int idx); 754 const char *iwl_rs_pretty_ant(u8 ant); 755 const char *iwl_rs_pretty_bw(int bw); 756 int rs_pretty_print_rate(char *buf, int bufsz, const u32 rate); 757 bool iwl_he_is_sgi(u32 rate_n_flags); 758 759 #endif /* __iwl_fw_api_rs_h__ */ 760