| .. | .. |
|---|
| 1 | | -/* SPDX-License-Identifier: GPL-2.0 */ |
|---|
| 2 | 1 | /* |
|---|
| 3 | 2 | * Indices for 802.11 a/b/g/n/ac 1-3 chain symmetric transmit rates |
|---|
| 4 | 3 | * |
|---|
| 5 | | - * Copyright (C) 1999-2019, Broadcom Corporation |
|---|
| 6 | | - * |
|---|
| 4 | + * Portions of this code are copyright (c) 2022 Cypress Semiconductor Corporation |
|---|
| 5 | + * |
|---|
| 6 | + * Copyright (C) 1999-2017, Broadcom Corporation |
|---|
| 7 | + * |
|---|
| 7 | 8 | * Unless you and Broadcom execute a separate written software license |
|---|
| 8 | 9 | * agreement governing use of this software, this software is licensed to you |
|---|
| 9 | 10 | * under the terms of the GNU General Public License version 2 (the "GPL"), |
|---|
| 10 | 11 | * available at http://www.broadcom.com/licenses/GPLv2.php, with the |
|---|
| 11 | 12 | * following added to such license: |
|---|
| 12 | | - * |
|---|
| 13 | + * |
|---|
| 13 | 14 | * As a special exception, the copyright holders of this software give you |
|---|
| 14 | 15 | * permission to link this software with independent modules, and to copy and |
|---|
| 15 | 16 | * distribute the resulting executable under terms of your choice, provided that |
|---|
| .. | .. |
|---|
| 17 | 18 | * the license of that module. An independent module is a module which is not |
|---|
| 18 | 19 | * derived from this software. The special exception does not apply to any |
|---|
| 19 | 20 | * modifications of the software. |
|---|
| 20 | | - * |
|---|
| 21 | + * |
|---|
| 21 | 22 | * Notwithstanding the above, under no circumstances may you combine this |
|---|
| 22 | 23 | * software in any way with any other Broadcom software provided under a license |
|---|
| 23 | 24 | * other than the GPL, without Broadcom's express prior written consent. |
|---|
| .. | .. |
|---|
| 25 | 26 | * |
|---|
| 26 | 27 | * <<Broadcom-WL-IPTag/Open:>> |
|---|
| 27 | 28 | * |
|---|
| 28 | | - * $Id: bcmwifi_rates.h 5187 2012-06-29 06:17:50Z $ |
|---|
| 29 | + * $Id: bcmwifi_rates.h 697006 2017-05-01 19:13:40Z $ |
|---|
| 29 | 30 | */ |
|---|
| 30 | 31 | |
|---|
| 31 | 32 | #ifndef _bcmwifi_rates_h_ |
|---|
| 32 | 33 | #define _bcmwifi_rates_h_ |
|---|
| 33 | 34 | |
|---|
| 35 | +#include <typedefs.h> |
|---|
| 36 | + |
|---|
| 34 | 37 | #ifdef __cplusplus |
|---|
| 35 | 38 | extern "C" { |
|---|
| 36 | 39 | #endif /* __cplusplus */ |
|---|
| 37 | 40 | |
|---|
| 38 | | - |
|---|
| 39 | 41 | #define WL_RATESET_SZ_DSSS 4 |
|---|
| 40 | 42 | #define WL_RATESET_SZ_OFDM 8 |
|---|
| 41 | | -#define WL_RATESET_SZ_VHT_MCS 10 |
|---|
| 42 | | -#define WL_RATESET_SZ_VHT_MCS_P 12 |
|---|
| 43 | +#define WL_RATESET_SZ_VHT_MCS 10 |
|---|
| 44 | +#define WL_RATESET_SZ_VHT_MCS_P 12 /* 10 VHT rates + 2 proprietary rates */ |
|---|
| 45 | +#define WL_RATESET_SZ_HE_MCS 12 /* 12 HE rates (mcs 0-11) */ |
|---|
| 43 | 46 | |
|---|
| 44 | | -#if defined(WLPROPRIETARY_11N_RATES) |
|---|
| 45 | | -#define WL_RATESET_SZ_HT_MCS WL_RATESET_SZ_VHT_MCS |
|---|
| 46 | | -#else |
|---|
| 47 | 47 | #define WL_RATESET_SZ_HT_MCS 8 |
|---|
| 48 | | -#endif |
|---|
| 49 | 48 | |
|---|
| 50 | 49 | #define WL_RATESET_SZ_HT_IOCTL 8 /* MAC histogram, compatibility with wl utility */ |
|---|
| 51 | 50 | |
|---|
| .. | .. |
|---|
| 76 | 75 | WL_TX_BW_10 |
|---|
| 77 | 76 | } wl_tx_bw_t; |
|---|
| 78 | 77 | |
|---|
| 79 | | - |
|---|
| 80 | 78 | /* |
|---|
| 81 | 79 | * Transmit modes. |
|---|
| 82 | 80 | * Not all modes are listed here, only those required for disambiguation. e.g. SPEXP is not listed |
|---|
| .. | .. |
|---|
| 89 | 87 | WL_NUM_TX_MODES |
|---|
| 90 | 88 | } wl_tx_mode_t; |
|---|
| 91 | 89 | |
|---|
| 92 | | - |
|---|
| 93 | 90 | /* Number of transmit chains */ |
|---|
| 94 | 91 | typedef enum wl_tx_chains { |
|---|
| 95 | 92 | WL_TX_CHAINS_1 = 1, |
|---|
| .. | .. |
|---|
| 97 | 94 | WL_TX_CHAINS_3, |
|---|
| 98 | 95 | WL_TX_CHAINS_4 |
|---|
| 99 | 96 | } wl_tx_chains_t; |
|---|
| 100 | | - |
|---|
| 101 | 97 | |
|---|
| 102 | 98 | /* Number of transmit streams */ |
|---|
| 103 | 99 | typedef enum wl_tx_nss { |
|---|
| .. | .. |
|---|
| 107 | 103 | WL_TX_NSS_4 |
|---|
| 108 | 104 | } wl_tx_nss_t; |
|---|
| 109 | 105 | |
|---|
| 110 | | - |
|---|
| 111 | 106 | /* This enum maps each rate to a CLM index */ |
|---|
| 112 | 107 | |
|---|
| 113 | 108 | typedef enum clm_rates { |
|---|
| 114 | | -#ifdef WL_OLDPPR |
|---|
| 115 | | - /************ |
|---|
| 116 | | - * 1 chain * |
|---|
| 117 | | - ************ |
|---|
| 118 | | - */ |
|---|
| 119 | | - |
|---|
| 120 | | - CLM_RATE_1X1_DSSS_1 = 0, |
|---|
| 121 | | - CLM_RATE_1X1_DSSS_2 = 1, |
|---|
| 122 | | - CLM_RATE_1X1_DSSS_5_5 = 2, |
|---|
| 123 | | - CLM_RATE_1X1_DSSS_11 = 3, |
|---|
| 124 | | - |
|---|
| 125 | | - CLM_RATE_1X1_OFDM_6 = 4, |
|---|
| 126 | | - CLM_RATE_1X1_OFDM_9 = 5, |
|---|
| 127 | | - CLM_RATE_1X1_OFDM_12 = 6, |
|---|
| 128 | | - CLM_RATE_1X1_OFDM_18 = 7, |
|---|
| 129 | | - CLM_RATE_1X1_OFDM_24 = 8, |
|---|
| 130 | | - CLM_RATE_1X1_OFDM_36 = 9, |
|---|
| 131 | | - CLM_RATE_1X1_OFDM_48 = 10, |
|---|
| 132 | | - CLM_RATE_1X1_OFDM_54 = 11, |
|---|
| 133 | | - |
|---|
| 134 | | - CLM_RATE_1X1_MCS0 = 12, |
|---|
| 135 | | - CLM_RATE_1X1_MCS1 = 13, |
|---|
| 136 | | - CLM_RATE_1X1_MCS2 = 14, |
|---|
| 137 | | - CLM_RATE_1X1_MCS3 = 15, |
|---|
| 138 | | - CLM_RATE_1X1_MCS4 = 16, |
|---|
| 139 | | - CLM_RATE_1X1_MCS5 = 17, |
|---|
| 140 | | - CLM_RATE_1X1_MCS6 = 18, |
|---|
| 141 | | - CLM_RATE_1X1_MCS7 = 19, |
|---|
| 142 | | - |
|---|
| 143 | | - /************ |
|---|
| 144 | | - * 2 chains * |
|---|
| 145 | | - ************ |
|---|
| 146 | | - */ |
|---|
| 147 | | - |
|---|
| 148 | | - /* 1 Stream expanded + 1 */ |
|---|
| 149 | | - CLM_RATE_1X2_DSSS_1 = 20, |
|---|
| 150 | | - CLM_RATE_1X2_DSSS_2 = 21, |
|---|
| 151 | | - CLM_RATE_1X2_DSSS_5_5 = 22, |
|---|
| 152 | | - CLM_RATE_1X2_DSSS_11 = 23, |
|---|
| 153 | | - |
|---|
| 154 | | - CLM_RATE_1X2_CDD_OFDM_6 = 24, |
|---|
| 155 | | - CLM_RATE_1X2_CDD_OFDM_9 = 25, |
|---|
| 156 | | - CLM_RATE_1X2_CDD_OFDM_12 = 26, |
|---|
| 157 | | - CLM_RATE_1X2_CDD_OFDM_18 = 27, |
|---|
| 158 | | - CLM_RATE_1X2_CDD_OFDM_24 = 28, |
|---|
| 159 | | - CLM_RATE_1X2_CDD_OFDM_36 = 29, |
|---|
| 160 | | - CLM_RATE_1X2_CDD_OFDM_48 = 30, |
|---|
| 161 | | - CLM_RATE_1X2_CDD_OFDM_54 = 31, |
|---|
| 162 | | - |
|---|
| 163 | | - CLM_RATE_1X2_CDD_MCS0 = 32, |
|---|
| 164 | | - CLM_RATE_1X2_CDD_MCS1 = 33, |
|---|
| 165 | | - CLM_RATE_1X2_CDD_MCS2 = 34, |
|---|
| 166 | | - CLM_RATE_1X2_CDD_MCS3 = 35, |
|---|
| 167 | | - CLM_RATE_1X2_CDD_MCS4 = 36, |
|---|
| 168 | | - CLM_RATE_1X2_CDD_MCS5 = 37, |
|---|
| 169 | | - CLM_RATE_1X2_CDD_MCS6 = 38, |
|---|
| 170 | | - CLM_RATE_1X2_CDD_MCS7 = 39, |
|---|
| 171 | | - |
|---|
| 172 | | - /* 2 Streams */ |
|---|
| 173 | | - CLM_RATE_2X2_STBC_MCS0 = 40, |
|---|
| 174 | | - CLM_RATE_2X2_STBC_MCS1 = 41, |
|---|
| 175 | | - CLM_RATE_2X2_STBC_MCS2 = 42, |
|---|
| 176 | | - CLM_RATE_2X2_STBC_MCS3 = 43, |
|---|
| 177 | | - CLM_RATE_2X2_STBC_MCS4 = 44, |
|---|
| 178 | | - CLM_RATE_2X2_STBC_MCS5 = 45, |
|---|
| 179 | | - CLM_RATE_2X2_STBC_MCS6 = 46, |
|---|
| 180 | | - CLM_RATE_2X2_STBC_MCS7 = 47, |
|---|
| 181 | | - |
|---|
| 182 | | - CLM_RATE_2X2_SDM_MCS8 = 48, |
|---|
| 183 | | - CLM_RATE_2X2_SDM_MCS9 = 49, |
|---|
| 184 | | - CLM_RATE_2X2_SDM_MCS10 = 50, |
|---|
| 185 | | - CLM_RATE_2X2_SDM_MCS11 = 51, |
|---|
| 186 | | - CLM_RATE_2X2_SDM_MCS12 = 52, |
|---|
| 187 | | - CLM_RATE_2X2_SDM_MCS13 = 53, |
|---|
| 188 | | - CLM_RATE_2X2_SDM_MCS14 = 54, |
|---|
| 189 | | - CLM_RATE_2X2_SDM_MCS15 = 55, |
|---|
| 190 | | - |
|---|
| 191 | | - |
|---|
| 192 | | - /************ |
|---|
| 193 | | - * 3 chains * |
|---|
| 194 | | - ************ |
|---|
| 195 | | - */ |
|---|
| 196 | | - |
|---|
| 197 | | - /* 1 Stream expanded + 2 */ |
|---|
| 198 | | - CLM_RATE_1X3_DSSS_1 = 56, |
|---|
| 199 | | - CLM_RATE_1X3_DSSS_2 = 57, |
|---|
| 200 | | - CLM_RATE_1X3_DSSS_5_5 = 58, |
|---|
| 201 | | - CLM_RATE_1X3_DSSS_11 = 59, |
|---|
| 202 | | - |
|---|
| 203 | | - CLM_RATE_1X3_CDD_OFDM_6 = 60, |
|---|
| 204 | | - CLM_RATE_1X3_CDD_OFDM_9 = 61, |
|---|
| 205 | | - CLM_RATE_1X3_CDD_OFDM_12 = 62, |
|---|
| 206 | | - CLM_RATE_1X3_CDD_OFDM_18 = 63, |
|---|
| 207 | | - CLM_RATE_1X3_CDD_OFDM_24 = 64, |
|---|
| 208 | | - CLM_RATE_1X3_CDD_OFDM_36 = 65, |
|---|
| 209 | | - CLM_RATE_1X3_CDD_OFDM_48 = 66, |
|---|
| 210 | | - CLM_RATE_1X3_CDD_OFDM_54 = 67, |
|---|
| 211 | | - |
|---|
| 212 | | - CLM_RATE_1X3_CDD_MCS0 = 68, |
|---|
| 213 | | - CLM_RATE_1X3_CDD_MCS1 = 69, |
|---|
| 214 | | - CLM_RATE_1X3_CDD_MCS2 = 70, |
|---|
| 215 | | - CLM_RATE_1X3_CDD_MCS3 = 71, |
|---|
| 216 | | - CLM_RATE_1X3_CDD_MCS4 = 72, |
|---|
| 217 | | - CLM_RATE_1X3_CDD_MCS5 = 73, |
|---|
| 218 | | - CLM_RATE_1X3_CDD_MCS6 = 74, |
|---|
| 219 | | - CLM_RATE_1X3_CDD_MCS7 = 75, |
|---|
| 220 | | - |
|---|
| 221 | | - /* 2 Streams expanded + 1 */ |
|---|
| 222 | | - CLM_RATE_2X3_STBC_MCS0 = 76, |
|---|
| 223 | | - CLM_RATE_2X3_STBC_MCS1 = 77, |
|---|
| 224 | | - CLM_RATE_2X3_STBC_MCS2 = 78, |
|---|
| 225 | | - CLM_RATE_2X3_STBC_MCS3 = 79, |
|---|
| 226 | | - CLM_RATE_2X3_STBC_MCS4 = 80, |
|---|
| 227 | | - CLM_RATE_2X3_STBC_MCS5 = 81, |
|---|
| 228 | | - CLM_RATE_2X3_STBC_MCS6 = 82, |
|---|
| 229 | | - CLM_RATE_2X3_STBC_MCS7 = 83, |
|---|
| 230 | | - |
|---|
| 231 | | - CLM_RATE_2X3_SDM_MCS8 = 84, |
|---|
| 232 | | - CLM_RATE_2X3_SDM_MCS9 = 85, |
|---|
| 233 | | - CLM_RATE_2X3_SDM_MCS10 = 86, |
|---|
| 234 | | - CLM_RATE_2X3_SDM_MCS11 = 87, |
|---|
| 235 | | - CLM_RATE_2X3_SDM_MCS12 = 88, |
|---|
| 236 | | - CLM_RATE_2X3_SDM_MCS13 = 89, |
|---|
| 237 | | - CLM_RATE_2X3_SDM_MCS14 = 90, |
|---|
| 238 | | - CLM_RATE_2X3_SDM_MCS15 = 91, |
|---|
| 239 | | - |
|---|
| 240 | | - /* 3 Streams */ |
|---|
| 241 | | - CLM_RATE_3X3_SDM_MCS16 = 92, |
|---|
| 242 | | - CLM_RATE_3X3_SDM_MCS17 = 93, |
|---|
| 243 | | - CLM_RATE_3X3_SDM_MCS18 = 94, |
|---|
| 244 | | - CLM_RATE_3X3_SDM_MCS19 = 95, |
|---|
| 245 | | - CLM_RATE_3X3_SDM_MCS20 = 96, |
|---|
| 246 | | - CLM_RATE_3X3_SDM_MCS21 = 97, |
|---|
| 247 | | - CLM_RATE_3X3_SDM_MCS22 = 98, |
|---|
| 248 | | - CLM_RATE_3X3_SDM_MCS23 = 99, |
|---|
| 249 | | -#endif /* WL_OLDPPR */ |
|---|
| 250 | | - |
|---|
| 251 | 109 | /************ |
|---|
| 252 | 110 | * 1 chain * |
|---|
| 253 | 111 | ************ |
|---|
| .. | .. |
|---|
| 291 | 149 | WL_RATE_1X1_VHT9SS1 = 21, |
|---|
| 292 | 150 | WL_RATE_P_1X1_VHT10SS1 = 22, |
|---|
| 293 | 151 | WL_RATE_P_1X1_VHT11SS1 = 23, |
|---|
| 294 | | - |
|---|
| 295 | 152 | |
|---|
| 296 | 153 | /************ |
|---|
| 297 | 154 | * 2 chains * |
|---|
| .. | .. |
|---|
| 450 | 307 | WL_RATE_P_2X2_TXBF_VHT10SS2 = 102, |
|---|
| 451 | 308 | WL_RATE_P_2X2_TXBF_VHT11SS2 = 103, |
|---|
| 452 | 309 | |
|---|
| 453 | | - |
|---|
| 454 | 310 | /************ |
|---|
| 455 | 311 | * 3 chains * |
|---|
| 456 | 312 | ************ |
|---|
| .. | .. |
|---|
| 569 | 425 | WL_RATE_P_3X3_VHT10SS3 = 162, |
|---|
| 570 | 426 | WL_RATE_P_3X3_VHT11SS3 = 163, |
|---|
| 571 | 427 | |
|---|
| 572 | | - |
|---|
| 573 | 428 | /**************************** |
|---|
| 574 | 429 | * TX Beamforming, 3 chains * |
|---|
| 575 | 430 | **************************** |
|---|
| .. | .. |
|---|
| 658 | 513 | WL_RATE_3X3_TXBF_VHT9SS3 = 205, |
|---|
| 659 | 514 | WL_RATE_P_3X3_TXBF_VHT10SS3 = 206, |
|---|
| 660 | 515 | WL_RATE_P_3X3_TXBF_VHT11SS3 = 207, |
|---|
| 661 | | - |
|---|
| 662 | 516 | |
|---|
| 663 | 517 | /************ |
|---|
| 664 | 518 | * 4 chains * |
|---|
| .. | .. |
|---|
| 778 | 632 | WL_RATE_P_3X4_VHT10SS3 = 266, |
|---|
| 779 | 633 | WL_RATE_P_3X4_VHT11SS3 = 267, |
|---|
| 780 | 634 | |
|---|
| 781 | | - |
|---|
| 782 | 635 | /* 4 Streams */ |
|---|
| 783 | 636 | WL_RATE_4X4_SDM_MCS24 = 268, |
|---|
| 784 | 637 | WL_RATE_4X4_SDM_MCS25 = 269, |
|---|
| .. | .. |
|---|
| 803 | 656 | WL_RATE_4X4_VHT9SS4 = 277, |
|---|
| 804 | 657 | WL_RATE_P_4X4_VHT10SS4 = 278, |
|---|
| 805 | 658 | WL_RATE_P_4X4_VHT11SS4 = 279, |
|---|
| 806 | | - |
|---|
| 807 | 659 | |
|---|
| 808 | 660 | /**************************** |
|---|
| 809 | 661 | * TX Beamforming, 4 chains * |
|---|
| .. | .. |
|---|
| 924 | 776 | /* Number of rate codes */ |
|---|
| 925 | 777 | #define WL_NUMRATES 336 |
|---|
| 926 | 778 | |
|---|
| 779 | +/* MCS rates */ |
|---|
| 780 | +#define WLC_MAX_VHT_MCS 11 /**< Std VHT MCS 0-9 plus prop VHT MCS 10-11 */ |
|---|
| 781 | +#define WLC_MAX_HE_MCS 11 /**< Std HE MCS 0-11 */ |
|---|
| 782 | + |
|---|
| 783 | +/* Convert encoded rate value in plcp header to numerical rates in 500 KHz increments */ |
|---|
| 784 | +#define OFDM_PHY2MAC_RATE(rlpt) plcp_ofdm_rate_tbl[(rlpt) & 0x7] |
|---|
| 785 | +#define CCK_PHY2MAC_RATE(signal) ((signal)/5) |
|---|
| 786 | + |
|---|
| 787 | +/* given a proprietary MCS, get number of spatial streams */ |
|---|
| 788 | +#define GET_PROPRIETARY_11N_MCS_NSS(mcs) (1 + ((mcs) - 85) / 8) |
|---|
| 789 | + |
|---|
| 790 | +#define GET_11N_MCS_NSS(mcs) ((mcs) < 32 ? (1 + ((mcs) / 8)) : \ |
|---|
| 791 | + ((mcs) == 32 ? 1 : GET_PROPRIETARY_11N_MCS_NSS(mcs))) |
|---|
| 792 | + |
|---|
| 793 | +#define IS_PROPRIETARY_11N_MCS(mcs) FALSE |
|---|
| 794 | +#define IS_PROPRIETARY_11N_SS_MCS(mcs) FALSE /**< is proprietary HT single stream MCS */ |
|---|
| 795 | + |
|---|
| 796 | +/* Store HE mcs map for all NSS in a compact form: |
|---|
| 797 | + * |
|---|
| 798 | + * bit[0:2] mcs code for NSS 1 |
|---|
| 799 | + * bit[3:5] mcs code for NSS 2 |
|---|
| 800 | + * ... |
|---|
| 801 | + * bit[21:23] mcs code for NSS 8 |
|---|
| 802 | + */ |
|---|
| 803 | + |
|---|
| 804 | +/** |
|---|
| 805 | + * 3 bits are used for encoding each NSS mcs map (HE MCS MAP is 24 bits) |
|---|
| 806 | + */ |
|---|
| 807 | +#define HE_CAP_MCS_CODE_NONE 7 |
|---|
| 808 | + |
|---|
| 809 | +/* macros to access above compact format */ |
|---|
| 810 | +#define HE_CAP_MCS_NSS_SET_MASK 0x00ffffff /* Field is to be 24 bits long */ |
|---|
| 811 | +#define HE_CAP_MCS_NSS_GET_SS_IDX(nss) (((nss)-1) * HE_CAP_MCS_CODE_SIZE) |
|---|
| 812 | +#define HE_CAP_MCS_NSS_GET_MCS(nss, mcs_nss_map) \ |
|---|
| 813 | + (((mcs_nss_map) >> HE_CAP_MCS_NSS_GET_SS_IDX(nss)) & HE_CAP_MCS_CODE_MASK) |
|---|
| 814 | +#define HE_CAP_MCS_NSS_SET_MCS(nss, mcs_code, mcs_nss_map) \ |
|---|
| 815 | + do { \ |
|---|
| 816 | + (mcs_nss_map) &= (~(HE_CAP_MCS_CODE_MASK << HE_CAP_MCS_NSS_GET_SS_IDX(nss))); \ |
|---|
| 817 | + (mcs_nss_map) |= (((mcs_code) & HE_CAP_MCS_CODE_MASK) << HE_CAP_MCS_NSS_GET_SS_IDX(nss)); \ |
|---|
| 818 | + (mcs_nss_map) &= (HE_CAP_MCS_NSS_SET_MASK); \ |
|---|
| 819 | + } while (0) |
|---|
| 820 | + |
|---|
| 821 | +extern const uint8 plcp_ofdm_rate_tbl[]; |
|---|
| 822 | + |
|---|
| 823 | +uint8 wf_get_single_stream_mcs(uint mcs); |
|---|
| 824 | + |
|---|
| 825 | +uint8 wf_vht_plcp_to_rate(uint8 *plcp); |
|---|
| 826 | +uint wf_mcs_to_rate(uint mcs, uint nss, uint bw, int sgi); |
|---|
| 827 | +uint wf_he_mcs_to_rate(uint mcs, uint nss, uint bw, uint gi, bool dcm); |
|---|
| 828 | +uint wf_mcs_to_Ndbps(uint mcs, uint nss, uint bw); |
|---|
| 927 | 829 | #ifdef __cplusplus |
|---|
| 928 | 830 | } |
|---|
| 929 | 831 | #endif /* __cplusplus */ |
|---|