drivers/net/wireless/rockchip_wlan/rtl8723cs/include/rtw_ht.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  *
  19  ******************************************************************************/
  20 #ifndef _RTW_HT_H_
  21 #define _RTW_HT_H_
  22
  23
  24 struct ht_priv {
  25         u8      ht_option;
  26         u8      ampdu_enable;/* for enable Tx A-MPDU */
  27         u8      tx_amsdu_enable;/* for enable Tx A-MSDU */
  28         u8      bss_coexist;/* for 20/40 Bss coexist */
  29
  30         /* u8   baddbareq_issued[16]; */
  31         u32     tx_amsdu_maxlen; /* 1: 8k, 0:4k ; default:8k, for tx */
  32         u32     rx_ampdu_maxlen; /* for rx reordering ctrl win_sz, updated when join_callback. */
  33
  34         u8      rx_ampdu_min_spacing;
  35
  36         u8      ch_offset;/* PRIME_CHNL_OFFSET */
  37         u8      sgi_20m;
  38         u8      sgi_40m;
  39
  40         /* for processing Tx A-MPDU */
  41         u8      agg_enable_bitmap;
  42         /* u8   ADDBA_retry_count; */
  43         u8      candidate_tid_bitmap;
  44
  45         u8      ldpc_cap;
  46         u8      stbc_cap;
  47         u8      beamform_cap;
  48         u8      smps_cap; /*spatial multiplexing power save mode. 0:static SMPS, 1:dynamic SMPS, 3:SMPS disabled, 2:reserved*/
  49
  50         struct rtw_ieee80211_ht_cap ht_cap;
  51
  52 };
  53
  54 typedef enum AGGRE_SIZE {
  55         HT_AGG_SIZE_8K = 0,
  56         HT_AGG_SIZE_16K = 1,
  57         HT_AGG_SIZE_32K = 2,
  58         HT_AGG_SIZE_64K = 3,
  59         VHT_AGG_SIZE_128K = 4,
  60         VHT_AGG_SIZE_256K = 5,
  61         VHT_AGG_SIZE_512K = 6,
  62         VHT_AGG_SIZE_1024K = 7,
  63 } AGGRE_SIZE_E, *PAGGRE_SIZE_E;
  64
  65 typedef enum _RT_HT_INF0_CAP {
  66         RT_HT_CAP_USE_TURBO_AGGR = 0x01,
  67         RT_HT_CAP_USE_LONG_PREAMBLE = 0x02,
  68         RT_HT_CAP_USE_AMPDU = 0x04,
  69         RT_HT_CAP_USE_WOW = 0x8,
  70         RT_HT_CAP_USE_SOFTAP = 0x10,
  71         RT_HT_CAP_USE_92SE = 0x20,
  72         RT_HT_CAP_USE_88C_92C = 0x40,
  73         RT_HT_CAP_USE_AP_CLIENT_MODE = 0x80,    /* AP team request to reserve this bit, by Emily */
  74 } RT_HT_INF0_CAPBILITY, *PRT_HT_INF0_CAPBILITY;
  75
  76 typedef enum _RT_HT_INF1_CAP {
  77         RT_HT_CAP_USE_VIDEO_CLIENT = 0x01,
  78         RT_HT_CAP_USE_JAGUAR_BCUT = 0x02,
  79         RT_HT_CAP_USE_JAGUAR_CCUT = 0x04,
  80 } RT_HT_INF1_CAPBILITY, *PRT_HT_INF1_CAPBILITY;
  81
  82 #define LDPC_HT_ENABLE_RX                       BIT0
  83 #define LDPC_HT_ENABLE_TX                       BIT1
  84 #define LDPC_HT_TEST_TX_ENABLE          BIT2
  85 #define LDPC_HT_CAP_TX                          BIT3
  86
  87 #define STBC_HT_ENABLE_RX                       BIT0
  88 #define STBC_HT_ENABLE_TX                       BIT1
  89 #define STBC_HT_TEST_TX_ENABLE          BIT2
  90 #define STBC_HT_CAP_TX                          BIT3
  91
  92 #define BEAMFORMING_HT_BEAMFORMER_ENABLE        BIT0    /* Declare our NIC supports beamformer */
  93 #define BEAMFORMING_HT_BEAMFORMEE_ENABLE        BIT1    /* Declare our NIC supports beamformee */
  94 #define BEAMFORMING_HT_BEAMFORMER_TEST          BIT2    /* Transmiting Beamforming no matter the target supports it or not */
  95 #define BEAMFORMING_HT_BEAMFORMER_STEER_NUM             (BIT4 | BIT5)
  96 #define BEAMFORMING_HT_BEAMFORMEE_CHNL_EST_CAP  (BIT6 | BIT7)
  97
  98 /* ------------------------------------------------------------
  99  * The HT Control field
 100  * ------------------------------------------------------------ */
 101 #define SET_HT_CTRL_CSI_STEERING(_pEleStart, _val)                      SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart))+2, 6, 2, _val)
 102 #define SET_HT_CTRL_NDP_ANNOUNCEMENT(_pEleStart, _val)          SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart))+3, 0, 1, _val)
 103 #define GET_HT_CTRL_NDP_ANNOUNCEMENT(_pEleStart)                        LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+3, 0, 1)
 104
 105 /* 20/40 BSS Coexist */
 106 #define SET_EXT_CAPABILITY_ELE_BSS_COEXIST(_pEleStart, _val)    SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 0, 1, _val)
 107 #define GET_EXT_CAPABILITY_ELE_BSS_COEXIST(_pEleStart)                  LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 0, 1)
 108
 109 /* HT Capabilities Info field */
 110 #define HT_CAP_ELE_CAP_INFO(_pEleStart)                                 ((u8 *)(_pEleStart))
 111 #define GET_HT_CAP_ELE_LDPC_CAP(_pEleStart)                             LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 0, 1)
 112 #define GET_HT_CAP_ELE_CHL_WIDTH(_pEleStart)                    LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 1, 1)
 113 #define GET_HT_CAP_ELE_SM_PS(_pEleStart)                                LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 2, 2)
 114 #define GET_HT_CAP_ELE_GREENFIELD(_pEleStart)                   LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 4, 1)
 115 #define GET_HT_CAP_ELE_SHORT_GI20M(_pEleStart)                  LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 5, 1)
 116 #define GET_HT_CAP_ELE_SHORT_GI40M(_pEleStart)                  LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 6, 1)
 117 #define GET_HT_CAP_ELE_TX_STBC(_pEleStart)                              LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 7, 1)
 118 #define GET_HT_CAP_ELE_RX_STBC(_pEleStart)                              LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+1, 0, 2)
 119 #define GET_HT_CAP_ELE_DELAYED_BA(_pEleStart)                   LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+1, 2, 1)
 120 #define GET_HT_CAP_ELE_MAX_AMSDU_LENGTH(_pEleStart)             LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+1, 3, 1)
 121 #define GET_HT_CAP_ELE_DSSS_CCK_40M(_pEleStart)                 LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+1, 4, 1)
 122 #define GET_HT_CAP_ELE_FORTY_INTOLERANT(_pEleStart)             LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+1, 6, 1)
 123 #define GET_HT_CAP_ELE_LSIG_TXOP_PROTECT(_pEleStart)    LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+1, 7, 1)
 124
 125 #define SET_HT_CAP_ELE_LDPC_CAP(_pEleStart, _val)                       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 0, 1, _val)
 126 #define SET_HT_CAP_ELE_CHL_WIDTH(_pEleStart, _val)                      SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 1, 1, _val)
 127 #define SET_HT_CAP_ELE_SM_PS(_pEleStart, _val)                          SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 2, 2, _val)
 128 #define SET_HT_CAP_ELE_GREENFIELD(_pEleStart, _val)                     SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 4, 1, _val)
 129 #define SET_HT_CAP_ELE_SHORT_GI20M(_pEleStart, _val)            SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 5, 1, _val)
 130 #define SET_HT_CAP_ELE_SHORT_GI40M(_pEleStart, _val)            SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 6, 1, _val)
 131 #define SET_HT_CAP_ELE_TX_STBC(_pEleStart, _val)                        SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 7, 1, _val)
 132 #define SET_HT_CAP_ELE_RX_STBC(_pEleStart, _val)                        SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 0, 2, _val)
 133 #define SET_HT_CAP_ELE_DELAYED_BA(_pEleStart, _val)                     SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 2, 1, _val)
 134 #define SET_HT_CAP_ELE_MAX_AMSDU_LENGTH(_pEleStart, _val)       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 3, 1, _val)
 135 #define SET_HT_CAP_ELE_DSSS_CCK_40M(_pEleStart, _val)           SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 4, 1, _val)
 136 #define SET_HT_CAP_ELE_FORTY_INTOLERANT(_pEleStart, _val)       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 6, 1, _val)
 137 #define SET_HT_CAP_ELE_LSIG_TXOP_PROTECT(_pEleStart, _val)      SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 7, 1, _val)
 138
 139 /* A-MPDU Parameters field */
 140 #define HT_CAP_ELE_AMPDU_PARA(_pEleStart)                               (((u8 *)(_pEleStart))+2)
 141 #define GET_HT_CAP_ELE_MAX_AMPDU_LEN_EXP(_pEleStart)    LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+2, 0, 2)
 142 #define GET_HT_CAP_ELE_MIN_MPDU_S_SPACE(_pEleStart)             LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+2, 2, 3)
 143
 144 #define HT_AMPDU_PARA_FMT "%02x " \
 145         "MAX AMPDU len:%u bytes, MIN MPDU Start Spacing:%u"
 146
 147 #define HT_AMPDU_PARA_ARG(x) \
 148         *((u8 *)(x)) \
 149         , (1 << (13+GET_HT_CAP_ELE_MAX_AMPDU_LEN_EXP(((u8 *)x)-2)))-1 \
 150         , GET_HT_CAP_ELE_MIN_MPDU_S_SPACE(((u8 *)x)-2)
 151
 152 /* Supported MCS Set field */
 153 #define HT_CAP_ELE_SUP_MCS_SET(_pEleStart)                              (((u8 *)(_pEleStart))+3)
 154 #define HT_CAP_ELE_RX_MCS_MAP(_pEleStart)                               HT_CAP_ELE_SUP_MCS_SET(_pEleStart)
 155 #define GET_HT_CAP_ELE_RX_HIGHEST_DATA_RATE(_pEleStart) LE_BITS_TO_2BYTE(((u8 *)(_pEleStart))+13, 0, 10)
 156 #define GET_HT_CAP_ELE_TX_MCS_DEF(_pEleStart)                   LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+15, 0, 1)
 157 #define GET_HT_CAP_ELE_TRX_MCS_NEQ(_pEleStart)                  LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+15, 1, 1)
 158 #define GET_HT_CAP_ELE_TX_MAX_SS(_pEleStart)                    LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+15, 2, 2)
 159 #define GET_HT_CAP_ELE_TX_UEQM(_pEleStart)                              LE_BITS_TO_1BYTE(((u8 *)(_pEleStart))+15, 4, 1)
 160
 161 #define HT_SUP_MCS_SET_FMT "%02x %02x %02x %02x %02x%02x%02x%02x%02x%02x" \
 162         /* "\n%02x%02x%02x%02x%02x%02x" */\
 163         " %uMbps %s%s%s"
 164 #define HT_SUP_MCS_SET_ARG(x) ((u8 *)(x))[0], ((u8 *)(x))[1], ((u8 *)(x))[2], ((u8 *)(x))[3], ((u8 *)(x))[4], ((u8 *)(x))[5], \
 165         ((u8 *)(x))[6], ((u8 *)(x))[7], ((u8 *)(x))[8], ((u8 *)(x))[9] \
 166         /*,((u8 *)(x))[10], ((u8 *)(x))[11], ((u8 *)(x))[12], ((u8 *)(x))[13], ((u8 *)(x))[14], ((u8 *)(x))[15] */\
 167         , GET_HT_CAP_ELE_RX_HIGHEST_DATA_RATE(((u8 *)x)-3) \
 168         , GET_HT_CAP_ELE_TX_MCS_DEF(((u8 *)x)-3) ? "TX_MCS_DEF " : "" \
 169         , GET_HT_CAP_ELE_TRX_MCS_NEQ(((u8 *)x)-3) ? "TRX_MCS_NEQ " : "" \
 170         , GET_HT_CAP_ELE_TX_UEQM(((u8 *)x)-3) ? "TX_UEQM " : ""
 171
 172 /* TXBF Capabilities */
 173 #define SET_HT_CAP_TXBF_RECEIVE_NDP_CAP(_pEleStart, _val)                               SET_BITS_TO_LE_4BYTE(((u8 *)(_pEleStart))+21, 3, 1, ((u8)_val))
 174 #define SET_HT_CAP_TXBF_TRANSMIT_NDP_CAP(_pEleStart, _val)                              SET_BITS_TO_LE_4BYTE(((u8 *)(_pEleStart))+21, 4, 1, ((u8)_val))
 175 #define SET_HT_CAP_TXBF_EXPLICIT_COMP_STEERING_CAP(_pEleStart, _val)    SET_BITS_TO_LE_4BYTE(((u8 *)(_pEleStart))+21, 10, 1, ((u8)_val))
 176 #define SET_HT_CAP_TXBF_EXPLICIT_COMP_FEEDBACK_CAP(_pEleStart, _val)    SET_BITS_TO_LE_4BYTE(((u8 *)(_pEleStart))+21, 15, 2, ((u8)_val))
 177 #define SET_HT_CAP_TXBF_COMP_STEERING_NUM_ANTENNAS(_pEleStart, _val)    SET_BITS_TO_LE_4BYTE(((u8 *)(_pEleStart))+21, 23, 2, ((u8)_val))
 178 #define SET_HT_CAP_TXBF_CHNL_ESTIMATION_NUM_ANTENNAS(_pEleStart, _val)  SET_BITS_TO_LE_4BYTE(((u8 *)(_pEleStart))+21, 27, 2, ((u8)_val))
 179
 180
 181 #define GET_HT_CAP_TXBF_EXPLICIT_COMP_STEERING_CAP(_pEleStart)                  LE_BITS_TO_4BYTE(((u8 *)(_pEleStart))+21, 10, 1)
 182 #define GET_HT_CAP_TXBF_EXPLICIT_COMP_FEEDBACK_CAP(_pEleStart)                  LE_BITS_TO_4BYTE(((u8 *)(_pEleStart))+21, 15, 2)
 183 #define GET_HT_CAP_TXBF_COMP_STEERING_NUM_ANTENNAS(_pEleStart)          LE_BITS_TO_4BYTE(((u8 *)(_pEleStart))+21, 23, 2)
 184 #define GET_HT_CAP_TXBF_CHNL_ESTIMATION_NUM_ANTENNAS(_pEleStart)                LE_BITS_TO_4BYTE(((u8 *)(_pEleStart))+21, 27, 2)
 185
 186 /* HT Operation element */
 187
 188 #define GET_HT_OP_ELE_PRI_CHL(_pEleStart)                                       LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)), 0, 8)
 189 #define SET_HT_OP_ELE_PRI_CHL(_pEleStart, _val)                         SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)), 0, 8, _val)
 190
 191 /* HT Operation Info field */
 192 #define HT_OP_ELE_OP_INFO(_pEleStart)                                           (((u8 *)(_pEleStart)) + 1)
 193 #define GET_HT_OP_ELE_2ND_CHL_OFFSET(_pEleStart)                        LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 1, 0, 2)
 194 #define GET_HT_OP_ELE_STA_CHL_WIDTH(_pEleStart)                         LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 1, 2, 1)
 195 #define GET_HT_OP_ELE_RIFS_MODE(_pEleStart)                                     LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 1, 3, 1)
 196 #define GET_HT_OP_ELE_HT_PROTECT(_pEleStart)                            LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 2, 0, 2)
 197 #define GET_HT_OP_ELE_NON_GREEN_PRESENT(_pEleStart)                     LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 2, 2, 1)
 198 #define GET_HT_OP_ELE_OBSS_NON_HT_PRESENT(_pEleStart)           LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 2, 4, 1)
 199 #define GET_HT_OP_ELE_DUAL_BEACON(_pEleStart)                           LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 4, 6, 1)
 200 #define GET_HT_OP_ELE_DUAL_CTS(_pEleStart)                                      LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 4, 7, 1)
 201 #define GET_HT_OP_ELE_STBC_BEACON(_pEleStart)                           LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 5, 0, 1)
 202 #define GET_HT_OP_ELE_LSIG_TXOP_PROTECT(_pEleStart)                     LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 5, 1, 1)
 203 #define GET_HT_OP_ELE_PCO_ACTIVE(_pEleStart)                            LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 5, 2, 1)
 204 #define GET_HT_OP_ELE_PCO_PHASE(_pEleStart)                                     LE_BITS_TO_1BYTE(((u8 *)(_pEleStart)) + 5, 3, 1)
 205
 206 #define SET_HT_OP_ELE_2ND_CHL_OFFSET(_pEleStart, _val)          SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 0, 2, _val)
 207 #define SET_HT_OP_ELE_STA_CHL_WIDTH(_pEleStart, _val)           SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 2, 1, _val)
 208 #define SET_HT_OP_ELE_RIFS_MODE(_pEleStart, _val)                       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 1, 3, 1, _val)
 209 #define SET_HT_OP_ELE_HT_PROTECT(_pEleStart, _val)                      SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 2, 0, 2, _val)
 210 #define SET_HT_OP_ELE_NON_GREEN_PRESENT(_pEleStart, _val)       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 2, 2, 1, _val)
 211 #define SET_HT_OP_ELE_OBSS_NON_HT_PRESENT(_pEleStart, _val)     SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 2, 4, 1, _val)
 212 #define SET_HT_OP_ELE_DUAL_BEACON(_pEleStart, _val)                     SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 4, 6, 1, _val)
 213 #define SET_HT_OP_ELE_DUAL_CTS(_pEleStart, _val)                        SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 4, 7, 1, _val)
 214 #define SET_HT_OP_ELE_STBC_BEACON(_pEleStart, _val)                     SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 5, 0, 1, _val)
 215 #define SET_HT_OP_ELE_LSIG_TXOP_PROTECT(_pEleStart, _val)       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 5, 1, 1, _val)
 216 #define SET_HT_OP_ELE_PCO_ACTIVE(_pEleStart, _val)                      SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 5, 2, 1, _val)
 217 #define SET_HT_OP_ELE_PCO_PHASE(_pEleStart, _val)                       SET_BITS_TO_LE_1BYTE(((u8 *)(_pEleStart)) + 5, 3, 1, _val)
 218
 219 #endif /* _RTL871X_HT_H_ */