drivers/staging/rtlwifi/wifi.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /******************************************************************************
   3  *
   4  * Copyright(c) 2009-2012  Realtek Corporation.
   5  *
   6  * Contact Information:
   7  * wlanfae <[email protected]>
   8  * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
   9  * Hsinchu 300, Taiwan.
  10  *
  11  * Larry Finger <[email protected]>
  12  *
  13  *****************************************************************************/
  14
  15 #ifndef __RTL_WIFI_H__
  16 #define __RTL_WIFI_H__
  17
  18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  19
  20 #include <linux/sched.h>
  21 #include <linux/firmware.h>
  22 #include <linux/etherdevice.h>
  23 #include <linux/vmalloc.h>
  24 #include <linux/usb.h>
  25 #include <net/mac80211.h>
  26 #include <linux/completion.h>
  27 #include "debug.h"
  28
  29 #define MASKBYTE0                               0xff
  30 #define MASKBYTE1                               0xff00
  31 #define MASKBYTE2                               0xff0000
  32 #define MASKBYTE3                               0xff000000
  33 #define MASKHWORD                               0xffff0000
  34 #define MASKLWORD                               0x0000ffff
  35 #define MASKDWORD                               0xffffffff
  36 #define MASK12BITS                              0xfff
  37 #define MASKH4BITS                              0xf0000000
  38 #define MASKOFDM_D                              0xffc00000
  39 #define MASKCCK                                 0x3f3f3f3f
  40
  41 #define MASK4BITS                               0x0f
  42 #define MASK20BITS                              0xfffff
  43 #define RFREG_OFFSET_MASK                       0xfffff
  44
  45 #define MASKBYTE0                               0xff
  46 #define MASKBYTE1                               0xff00
  47 #define MASKBYTE2                               0xff0000
  48 #define MASKBYTE3                               0xff000000
  49 #define MASKHWORD                               0xffff0000
  50 #define MASKLWORD                               0x0000ffff
  51 #define MASKDWORD                               0xffffffff
  52 #define MASK12BITS                              0xfff
  53 #define MASKH4BITS                              0xf0000000
  54 #define MASKOFDM_D                              0xffc00000
  55 #define MASKCCK                                 0x3f3f3f3f
  56
  57 #define MASK4BITS                               0x0f
  58 #define MASK20BITS                              0xfffff
  59 #define RFREG_OFFSET_MASK                       0xfffff
  60
  61 #define RF_CHANGE_BY_INIT                       0
  62 #define RF_CHANGE_BY_IPS                        BIT(28)
  63 #define RF_CHANGE_BY_PS                         BIT(29)
  64 #define RF_CHANGE_BY_HW                         BIT(30)
  65 #define RF_CHANGE_BY_SW                         BIT(31)
  66
  67 #define IQK_ADDA_REG_NUM                        16
  68 #define IQK_MAC_REG_NUM                         4
  69 #define IQK_THRESHOLD                           8
  70
  71 #define MAX_KEY_LEN                             61
  72 #define KEY_BUF_SIZE                            5
  73
  74 /* QoS related. */
  75 /*aci: 0x00     Best Effort*/
  76 /*aci: 0x01     Background*/
  77 /*aci: 0x10     Video*/
  78 /*aci: 0x11     Voice*/
  79 /*Max: define total number.*/
  80 #define AC0_BE                                  0
  81 #define AC1_BK                                  1
  82 #define AC2_VI                                  2
  83 #define AC3_VO                                  3
  84 #define AC_MAX                                  4
  85 #define QOS_QUEUE_NUM                           4
  86 #define RTL_MAC80211_NUM_QUEUE                  5
  87 #define REALTEK_USB_VENQT_MAX_BUF_SIZE          254
  88 #define RTL_USB_MAX_RX_COUNT                    100
  89 #define QBSS_LOAD_SIZE                          5
  90 #define MAX_WMMELE_LENGTH                       64
  91
  92 #define TOTAL_CAM_ENTRY                         32
  93
  94 /*slot time for 11g. */
  95 #define RTL_SLOT_TIME_9                         9
  96 #define RTL_SLOT_TIME_20                        20
  97
  98 /*related to tcp/ip. */
  99 #define SNAP_SIZE               6
 100 #define PROTOC_TYPE_SIZE        2
 101
 102 /*related with 802.11 frame*/
 103 #define MAC80211_3ADDR_LEN                      24
 104 #define MAC80211_4ADDR_LEN                      30
 105
 106 #define CHANNEL_MAX_NUMBER      (14 + 24 + 21)  /* 14 is the max channel no */
 107 #define CHANNEL_MAX_NUMBER_2G           14
 108 #define CHANNEL_MAX_NUMBER_5G           49 /* Please refer to
 109                                             *"phy_GetChnlGroup8812A" and
 110                                             * "Hal_ReadTxPowerInfo8812A"
 111                                             */
 112 #define CHANNEL_MAX_NUMBER_5G_80M       7
 113 #define CHANNEL_GROUP_MAX       (3 + 9) /*  ch1~3, 4~9, 10~14 = three groups */
 114 #define MAX_PG_GROUP                    13
 115 #define CHANNEL_GROUP_MAX_2G            3
 116 #define CHANNEL_GROUP_IDX_5GL           3
 117 #define CHANNEL_GROUP_IDX_5GM           6
 118 #define CHANNEL_GROUP_IDX_5GH           9
 119 #define CHANNEL_GROUP_MAX_5G            9
 120 #define CHANNEL_MAX_NUMBER_2G           14
 121 #define AVG_THERMAL_NUM                 8
 122 #define AVG_THERMAL_NUM_88E             4
 123 #define AVG_THERMAL_NUM_8723BE          4
 124 #define MAX_TID_COUNT                   9
 125
 126 /* for early mode */
 127 #define FCS_LEN                         4
 128 #define EM_HDR_LEN                      8
 129
 130 enum rtl8192c_h2c_cmd {
 131         H2C_AP_OFFLOAD = 0,
 132         H2C_SETPWRMODE = 1,
 133         H2C_JOINBSSRPT = 2,
 134         H2C_RSVDPAGE = 3,
 135         H2C_RSSI_REPORT = 5,
 136         H2C_RA_MASK = 6,
 137         H2C_MACID_PS_MODE = 7,
 138         H2C_P2P_PS_OFFLOAD = 8,
 139         H2C_MAC_MODE_SEL = 9,
 140         H2C_PWRM = 15,
 141         H2C_P2P_PS_CTW_CMD = 24,
 142         MAX_H2CCMD
 143 };
 144
 145 #define MAX_TX_COUNT                    4
 146 #define MAX_REGULATION_NUM              4
 147 #define MAX_RF_PATH_NUM                 4
 148 #define MAX_RATE_SECTION_NUM            6       /* = MAX_RATE_SECTION */
 149 #define MAX_2_4G_BANDWIDTH_NUM          4
 150 #define MAX_5G_BANDWIDTH_NUM            4
 151 #define MAX_RF_PATH                     4
 152 #define MAX_CHNL_GROUP_24G              6
 153 #define MAX_CHNL_GROUP_5G               14
 154
 155 #define TX_PWR_BY_RATE_NUM_BAND         2
 156 #define TX_PWR_BY_RATE_NUM_RF           4
 157 #define TX_PWR_BY_RATE_NUM_SECTION      12
 158 /* compatible with TX_PWR_BY_RATE_NUM_SECTION */
 159 #define TX_PWR_BY_RATE_NUM_RATE         84
 160 #define MAX_BASE_NUM_IN_PHY_REG_PG_24G  6       /* MAX_RATE_SECTION */
 161 #define MAX_BASE_NUM_IN_PHY_REG_PG_5G   5       /* MAX_RATE_SECTION -1 */
 162
 163 #define BUFDESC_SEG_NUM         1 /* 0:2 seg, 1: 4 seg, 2: 8 seg */
 164
 165 #define DEL_SW_IDX_SZ           30
 166
 167 /* For now, it's just for 8192ee
 168  * but not OK yet, keep it 0
 169  */
 170 #define RTL8192EE_SEG_NUM               BUFDESC_SEG_NUM
 171 #define RTL8822BE_SEG_NUM               BUFDESC_SEG_NUM
 172
 173 enum rf_tx_num {
 174         RF_1TX = 0,
 175         RF_2TX,
 176         RF_MAX_TX_NUM,
 177         RF_TX_NUM_NONIMPLEMENT,
 178 };
 179
 180 #define PACKET_NORMAL                   0
 181 #define PACKET_DHCP                     1
 182 #define PACKET_ARP                      2
 183 #define PACKET_EAPOL                    3
 184
 185 #define MAX_SUPPORT_WOL_PATTERN_NUM     16
 186 #define RSVD_WOL_PATTERN_NUM            1
 187 #define WKFMCAM_ADDR_NUM                6
 188 #define WKFMCAM_SIZE                    24
 189
 190 #define MAX_WOL_BIT_MASK_SIZE           16
 191 /* MIN LEN keeps 13 here */
 192 #define MIN_WOL_PATTERN_SIZE            13
 193 #define MAX_WOL_PATTERN_SIZE            128
 194
 195 #define WAKE_ON_MAGIC_PACKET            BIT(0)
 196 #define WAKE_ON_PATTERN_MATCH           BIT(1)
 197
 198 #define WOL_REASON_PTK_UPDATE           BIT(0)
 199 #define WOL_REASON_GTK_UPDATE           BIT(1)
 200 #define WOL_REASON_DISASSOC             BIT(2)
 201 #define WOL_REASON_DEAUTH               BIT(3)
 202 #define WOL_REASON_AP_LOST              BIT(4)
 203 #define WOL_REASON_MAGIC_PKT            BIT(5)
 204 #define WOL_REASON_UNICAST_PKT          BIT(6)
 205 #define WOL_REASON_PATTERN_PKT          BIT(7)
 206 #define WOL_REASON_RTD3_SSID_MATCH      BIT(8)
 207 #define WOL_REASON_REALWOW_V2_WAKEUPPKT BIT(9)
 208 #define WOL_REASON_REALWOW_V2_ACKLOST   BIT(10)
 209
 210 struct rtlwifi_firmware_header {
 211         __le16 signature;
 212         u8 category;
 213         u8 function;
 214         __le16 version;
 215         u8 subversion;
 216         u8 rsvd1;
 217         u8 month;
 218         u8 date;
 219         u8 hour;
 220         u8 minute;
 221         __le16 ramcodesize;
 222         __le16 rsvd2;
 223         __le32 svnindex;
 224         __le32 rsvd3;
 225         __le32 rsvd4;
 226         __le32 rsvd5;
 227 };
 228
 229 struct txpower_info_2g {
 230         u8 index_cck_base[MAX_RF_PATH][MAX_CHNL_GROUP_24G];
 231         u8 index_bw40_base[MAX_RF_PATH][MAX_CHNL_GROUP_24G];
 232         /*If only one tx, only BW20 and OFDM are used.*/
 233         u8 cck_diff[MAX_RF_PATH][MAX_TX_COUNT];
 234         u8 ofdm_diff[MAX_RF_PATH][MAX_TX_COUNT];
 235         u8 bw20_diff[MAX_RF_PATH][MAX_TX_COUNT];
 236         u8 bw40_diff[MAX_RF_PATH][MAX_TX_COUNT];
 237         u8 bw80_diff[MAX_RF_PATH][MAX_TX_COUNT];
 238         u8 bw160_diff[MAX_RF_PATH][MAX_TX_COUNT];
 239 };
 240
 241 struct txpower_info_5g {
 242         u8 index_bw40_base[MAX_RF_PATH][MAX_CHNL_GROUP_5G];
 243         /*If only one tx, only BW20, OFDM, BW80 and BW160 are used.*/
 244         u8 ofdm_diff[MAX_RF_PATH][MAX_TX_COUNT];
 245         u8 bw20_diff[MAX_RF_PATH][MAX_TX_COUNT];
 246         u8 bw40_diff[MAX_RF_PATH][MAX_TX_COUNT];
 247         u8 bw80_diff[MAX_RF_PATH][MAX_TX_COUNT];
 248         u8 bw160_diff[MAX_RF_PATH][MAX_TX_COUNT];
 249 };
 250
 251 enum rate_section {
 252         CCK = 0,
 253         OFDM,
 254         HT_MCS0_MCS7,
 255         HT_MCS8_MCS15,
 256         VHT_1SSMCS0_1SSMCS9,
 257         VHT_2SSMCS0_2SSMCS9,
 258         MAX_RATE_SECTION,
 259 };
 260
 261 enum intf_type {
 262         INTF_PCI = 0,
 263         INTF_USB = 1,
 264 };
 265
 266 enum radio_path {
 267         RF90_PATH_A = 0,
 268         RF90_PATH_B = 1,
 269         RF90_PATH_C = 2,
 270         RF90_PATH_D = 3,
 271 };
 272
 273 enum radio_mask {
 274         RF_MASK_A = BIT(0),
 275         RF_MASK_B = BIT(1),
 276         RF_MASK_C = BIT(2),
 277         RF_MASK_D = BIT(3),
 278 };
 279
 280 enum regulation_txpwr_lmt {
 281         TXPWR_LMT_FCC = 0,
 282         TXPWR_LMT_MKK = 1,
 283         TXPWR_LMT_ETSI = 2,
 284         TXPWR_LMT_WW = 3,
 285
 286         TXPWR_LMT_MAX_REGULATION_NUM = 4
 287 };
 288
 289 enum rt_eeprom_type {
 290         EEPROM_93C46,
 291         EEPROM_93C56,
 292         EEPROM_BOOT_EFUSE,
 293 };
 294
 295 enum ttl_status {
 296         RTL_STATUS_INTERFACE_START = 0,
 297 };
 298
 299 enum hardware_type {
 300         HARDWARE_TYPE_RTL8192E,
 301         HARDWARE_TYPE_RTL8192U,
 302         HARDWARE_TYPE_RTL8192SE,
 303         HARDWARE_TYPE_RTL8192SU,
 304         HARDWARE_TYPE_RTL8192CE,
 305         HARDWARE_TYPE_RTL8192CU,
 306         HARDWARE_TYPE_RTL8192DE,
 307         HARDWARE_TYPE_RTL8192DU,
 308         HARDWARE_TYPE_RTL8723AE,
 309         HARDWARE_TYPE_RTL8723U,
 310         HARDWARE_TYPE_RTL8188EE,
 311         HARDWARE_TYPE_RTL8723BE,
 312         HARDWARE_TYPE_RTL8192EE,
 313         HARDWARE_TYPE_RTL8821AE,
 314         HARDWARE_TYPE_RTL8812AE,
 315         HARDWARE_TYPE_RTL8822BE,
 316
 317         /* keep it last */
 318         HARDWARE_TYPE_NUM
 319 };
 320
 321 #define RTL_HW_TYPE(rtlpriv)    (rtl_hal((struct rtl_priv *)rtlpriv)->hw_type)
 322 #define IS_NEW_GENERATION_IC(rtlpriv)                   \
 323                         (RTL_HW_TYPE(rtlpriv) >= HARDWARE_TYPE_RTL8192EE)
 324 #define IS_HARDWARE_TYPE_8192CE(rtlpriv)                \
 325                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8192CE)
 326 #define IS_HARDWARE_TYPE_8812(rtlpriv)                  \
 327                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8812AE)
 328 #define IS_HARDWARE_TYPE_8821(rtlpriv)                  \
 329                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8821AE)
 330 #define IS_HARDWARE_TYPE_8723A(rtlpriv)                 \
 331                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8723AE)
 332 #define IS_HARDWARE_TYPE_8723B(rtlpriv)                 \
 333                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8723BE)
 334 #define IS_HARDWARE_TYPE_8192E(rtlpriv)                 \
 335                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8192EE)
 336 #define IS_HARDWARE_TYPE_8822B(rtlpriv)                 \
 337                         (RTL_HW_TYPE(rtlpriv) == HARDWARE_TYPE_RTL8822BE)
 338
 339 #define RX_HAL_IS_CCK_RATE(rxmcs)                       \
 340         ((rxmcs) == DESC_RATE1M ||                      \
 341          (rxmcs) == DESC_RATE2M ||                      \
 342          (rxmcs) == DESC_RATE5_5M ||                    \
 343          (rxmcs) == DESC_RATE11M)
 344
 345 enum scan_operation_backup_opt {
 346         SCAN_OPT_BACKUP = 0,
 347         SCAN_OPT_BACKUP_BAND0 = 0,
 348         SCAN_OPT_BACKUP_BAND1,
 349         SCAN_OPT_RESTORE,
 350         SCAN_OPT_MAX
 351 };
 352
 353 /*RF state.*/
 354 enum rf_pwrstate {
 355         ERFON,
 356         ERFSLEEP,
 357         ERFOFF
 358 };
 359
 360 struct bb_reg_def {
 361         u32 rfintfs;
 362         u32 rfintfi;
 363         u32 rfintfo;
 364         u32 rfintfe;
 365         u32 rf3wire_offset;
 366         u32 rflssi_select;
 367         u32 rftxgain_stage;
 368         u32 rfhssi_para1;
 369         u32 rfhssi_para2;
 370         u32 rfsw_ctrl;
 371         u32 rfagc_control1;
 372         u32 rfagc_control2;
 373         u32 rfrxiq_imbal;
 374         u32 rfrx_afe;
 375         u32 rftxiq_imbal;
 376         u32 rftx_afe;
 377         u32 rf_rb;              /* rflssi_readback */
 378         u32 rf_rbpi;            /* rflssi_readbackpi */
 379 };
 380
 381 enum io_type {
 382         IO_CMD_PAUSE_DM_BY_SCAN = 0,
 383         IO_CMD_PAUSE_BAND0_DM_BY_SCAN = 0,
 384         IO_CMD_PAUSE_BAND1_DM_BY_SCAN = 1,
 385         IO_CMD_RESUME_DM_BY_SCAN = 2,
 386 };
 387
 388 enum hw_variables {
 389         HW_VAR_ETHER_ADDR = 0x0,
 390         HW_VAR_MULTICAST_REG = 0x1,
 391         HW_VAR_BASIC_RATE = 0x2,
 392         HW_VAR_BSSID = 0x3,
 393         HW_VAR_MEDIA_STATUS = 0x4,
 394         HW_VAR_SECURITY_CONF = 0x5,
 395         HW_VAR_BEACON_INTERVAL = 0x6,
 396         HW_VAR_ATIM_WINDOW = 0x7,
 397         HW_VAR_LISTEN_INTERVAL = 0x8,
 398         HW_VAR_CS_COUNTER = 0x9,
 399         HW_VAR_DEFAULTKEY0 = 0xa,
 400         HW_VAR_DEFAULTKEY1 = 0xb,
 401         HW_VAR_DEFAULTKEY2 = 0xc,
 402         HW_VAR_DEFAULTKEY3 = 0xd,
 403         HW_VAR_SIFS = 0xe,
 404         HW_VAR_R2T_SIFS = 0xf,
 405         HW_VAR_DIFS = 0x10,
 406         HW_VAR_EIFS = 0x11,
 407         HW_VAR_SLOT_TIME = 0x12,
 408         HW_VAR_ACK_PREAMBLE = 0x13,
 409         HW_VAR_CW_CONFIG = 0x14,
 410         HW_VAR_CW_VALUES = 0x15,
 411         HW_VAR_RATE_FALLBACK_CONTROL = 0x16,
 412         HW_VAR_CONTENTION_WINDOW = 0x17,
 413         HW_VAR_RETRY_COUNT = 0x18,
 414         HW_VAR_TR_SWITCH = 0x19,
 415         HW_VAR_COMMAND = 0x1a,
 416         HW_VAR_WPA_CONFIG = 0x1b,
 417         HW_VAR_AMPDU_MIN_SPACE = 0x1c,
 418         HW_VAR_SHORTGI_DENSITY = 0x1d,
 419         HW_VAR_AMPDU_FACTOR = 0x1e,
 420         HW_VAR_MCS_RATE_AVAILABLE = 0x1f,
 421         HW_VAR_AC_PARAM = 0x20,
 422         HW_VAR_ACM_CTRL = 0x21,
 423         HW_VAR_DIS_REQ_QSIZE = 0x22,
 424         HW_VAR_CCX_CHNL_LOAD = 0x23,
 425         HW_VAR_CCX_NOISE_HISTOGRAM = 0x24,
 426         HW_VAR_CCX_CLM_NHM = 0x25,
 427         HW_VAR_TXOPLIMIT = 0x26,
 428         HW_VAR_TURBO_MODE = 0x27,
 429         HW_VAR_RF_STATE = 0x28,
 430         HW_VAR_RF_OFF_BY_HW = 0x29,
 431         HW_VAR_BUS_SPEED = 0x2a,
 432         HW_VAR_SET_DEV_POWER = 0x2b,
 433
 434         HW_VAR_RCR = 0x2c,
 435         HW_VAR_RATR_0 = 0x2d,
 436         HW_VAR_RRSR = 0x2e,
 437         HW_VAR_CPU_RST = 0x2f,
 438         HW_VAR_CHECK_BSSID = 0x30,
 439         HW_VAR_LBK_MODE = 0x31,
 440         HW_VAR_AES_11N_FIX = 0x32,
 441         HW_VAR_USB_RX_AGGR = 0x33,
 442         HW_VAR_USER_CONTROL_TURBO_MODE = 0x34,
 443         HW_VAR_RETRY_LIMIT = 0x35,
 444         HW_VAR_INIT_TX_RATE = 0x36,
 445         HW_VAR_TX_RATE_REG = 0x37,
 446         HW_VAR_EFUSE_USAGE = 0x38,
 447         HW_VAR_EFUSE_BYTES = 0x39,
 448         HW_VAR_AUTOLOAD_STATUS = 0x3a,
 449         HW_VAR_RF_2R_DISABLE = 0x3b,
 450         HW_VAR_SET_RPWM = 0x3c,
 451         HW_VAR_H2C_FW_PWRMODE = 0x3d,
 452         HW_VAR_H2C_FW_JOINBSSRPT = 0x3e,
 453         HW_VAR_H2C_FW_MEDIASTATUSRPT = 0x3f,
 454         HW_VAR_H2C_FW_P2P_PS_OFFLOAD = 0x40,
 455         HW_VAR_FW_PSMODE_STATUS = 0x41,
 456         HW_VAR_INIT_RTS_RATE = 0x42,
 457         HW_VAR_RESUME_CLK_ON = 0x43,
 458         HW_VAR_FW_LPS_ACTION = 0x44,
 459         HW_VAR_1X1_RECV_COMBINE = 0x45,
 460         HW_VAR_STOP_SEND_BEACON = 0x46,
 461         HW_VAR_TSF_TIMER = 0x47,
 462         HW_VAR_IO_CMD = 0x48,
 463
 464         HW_VAR_RF_RECOVERY = 0x49,
 465         HW_VAR_H2C_FW_UPDATE_GTK = 0x4a,
 466         HW_VAR_WF_MASK = 0x4b,
 467         HW_VAR_WF_CRC = 0x4c,
 468         HW_VAR_WF_IS_MAC_ADDR = 0x4d,
 469         HW_VAR_H2C_FW_OFFLOAD = 0x4e,
 470         HW_VAR_RESET_WFCRC = 0x4f,
 471
 472         HW_VAR_HANDLE_FW_C2H = 0x50,
 473         HW_VAR_DL_FW_RSVD_PAGE = 0x51,
 474         HW_VAR_AID = 0x52,
 475         HW_VAR_HW_SEQ_ENABLE = 0x53,
 476         HW_VAR_CORRECT_TSF = 0x54,
 477         HW_VAR_BCN_VALID = 0x55,
 478         HW_VAR_FWLPS_RF_ON = 0x56,
 479         HW_VAR_DUAL_TSF_RST = 0x57,
 480         HW_VAR_SWITCH_EPHY_WOWLAN = 0x58,
 481         HW_VAR_INT_MIGRATION = 0x59,
 482         HW_VAR_INT_AC = 0x5a,
 483         HW_VAR_RF_TIMING = 0x5b,
 484
 485         HAL_DEF_WOWLAN = 0x5c,
 486         HW_VAR_MRC = 0x5d,
 487         HW_VAR_KEEP_ALIVE = 0x5e,
 488         HW_VAR_NAV_UPPER = 0x5f,
 489
 490         HW_VAR_MGT_FILTER = 0x60,
 491         HW_VAR_CTRL_FILTER = 0x61,
 492         HW_VAR_DATA_FILTER = 0x62,
 493 };
 494
 495 enum rt_media_status {
 496         RT_MEDIA_DISCONNECT = 0,
 497         RT_MEDIA_CONNECT = 1
 498 };
 499
 500 enum rt_oem_id {
 501         RT_CID_DEFAULT = 0,
 502         RT_CID_8187_ALPHA0 = 1,
 503         RT_CID_8187_SERCOMM_PS = 2,
 504         RT_CID_8187_HW_LED = 3,
 505         RT_CID_8187_NETGEAR = 4,
 506         RT_CID_WHQL = 5,
 507         RT_CID_819X_CAMEO = 6,
 508         RT_CID_819X_RUNTOP = 7,
 509         RT_CID_819X_SENAO = 8,
 510         RT_CID_TOSHIBA = 9,
 511         RT_CID_819X_NETCORE = 10,
 512         RT_CID_NETTRONIX = 11,
 513         RT_CID_DLINK = 12,
 514         RT_CID_PRONET = 13,
 515         RT_CID_COREGA = 14,
 516         RT_CID_819X_ALPHA = 15,
 517         RT_CID_819X_SITECOM = 16,
 518         RT_CID_CCX = 17,
 519         RT_CID_819X_LENOVO = 18,
 520         RT_CID_819X_QMI = 19,
 521         RT_CID_819X_EDIMAX_BELKIN = 20,
 522         RT_CID_819X_SERCOMM_BELKIN = 21,
 523         RT_CID_819X_CAMEO1 = 22,
 524         RT_CID_819X_MSI = 23,
 525         RT_CID_819X_ACER = 24,
 526         RT_CID_819X_HP = 27,
 527         RT_CID_819X_CLEVO = 28,
 528         RT_CID_819X_ARCADYAN_BELKIN = 29,
 529         RT_CID_819X_SAMSUNG = 30,
 530         RT_CID_819X_WNC_COREGA = 31,
 531         RT_CID_819X_FOXCOON = 32,
 532         RT_CID_819X_DELL = 33,
 533         RT_CID_819X_PRONETS = 34,
 534         RT_CID_819X_EDIMAX_ASUS = 35,
 535         RT_CID_NETGEAR = 36,
 536         RT_CID_PLANEX = 37,
 537         RT_CID_CC_C = 38,
 538 };
 539
 540 enum hw_descs {
 541         HW_DESC_OWN,
 542         HW_DESC_RXOWN,
 543         HW_DESC_TX_NEXTDESC_ADDR,
 544         HW_DESC_TXBUFF_ADDR,
 545         HW_DESC_RXBUFF_ADDR,
 546         HW_DESC_RXPKT_LEN,
 547         HW_DESC_RXERO,
 548         HW_DESC_RX_PREPARE,
 549 };
 550
 551 enum prime_sc {
 552         PRIME_CHNL_OFFSET_DONT_CARE = 0,
 553         PRIME_CHNL_OFFSET_LOWER = 1,
 554         PRIME_CHNL_OFFSET_UPPER = 2,
 555 };
 556
 557 enum rf_type {
 558         RF_1T1R = 0,
 559         RF_1T2R = 1,
 560         RF_2T2R = 2,
 561         RF_2T2R_GREEN = 3,
 562         RF_2T3R = 4,
 563         RF_2T4R = 5,
 564         RF_3T3R = 6,
 565         RF_3T4R = 7,
 566         RF_4T4R = 8,
 567 };
 568
 569 enum ht_channel_width {
 570         HT_CHANNEL_WIDTH_20 = 0,
 571         HT_CHANNEL_WIDTH_20_40 = 1,
 572         HT_CHANNEL_WIDTH_80 = 2,
 573         HT_CHANNEL_WIDTH_MAX,
 574 };
 575
 576 /* Ref: 802.11i spec D10.0 7.3.2.25.1
 577  * Cipher Suites Encryption Algorithms
 578  */
 579 enum rt_enc_alg {
 580         NO_ENCRYPTION = 0,
 581         WEP40_ENCRYPTION = 1,
 582         TKIP_ENCRYPTION = 2,
 583         RSERVED_ENCRYPTION = 3,
 584         AESCCMP_ENCRYPTION = 4,
 585         WEP104_ENCRYPTION = 5,
 586         AESCMAC_ENCRYPTION = 6, /*IEEE802.11w */
 587 };
 588
 589 enum rtl_hal_state {
 590         _HAL_STATE_STOP = 0,
 591         _HAL_STATE_START = 1,
 592 };
 593
 594 enum rtl_desc_rate {
 595         DESC_RATE1M = 0x00,
 596         DESC_RATE2M = 0x01,
 597         DESC_RATE5_5M = 0x02,
 598         DESC_RATE11M = 0x03,
 599
 600         DESC_RATE6M = 0x04,
 601         DESC_RATE9M = 0x05,
 602         DESC_RATE12M = 0x06,
 603         DESC_RATE18M = 0x07,
 604         DESC_RATE24M = 0x08,
 605         DESC_RATE36M = 0x09,
 606         DESC_RATE48M = 0x0a,
 607         DESC_RATE54M = 0x0b,
 608
 609         DESC_RATEMCS0 = 0x0c,
 610         DESC_RATEMCS1 = 0x0d,
 611         DESC_RATEMCS2 = 0x0e,
 612         DESC_RATEMCS3 = 0x0f,
 613         DESC_RATEMCS4 = 0x10,
 614         DESC_RATEMCS5 = 0x11,
 615         DESC_RATEMCS6 = 0x12,
 616         DESC_RATEMCS7 = 0x13,
 617         DESC_RATEMCS8 = 0x14,
 618         DESC_RATEMCS9 = 0x15,
 619         DESC_RATEMCS10 = 0x16,
 620         DESC_RATEMCS11 = 0x17,
 621         DESC_RATEMCS12 = 0x18,
 622         DESC_RATEMCS13 = 0x19,
 623         DESC_RATEMCS14 = 0x1a,
 624         DESC_RATEMCS15 = 0x1b,
 625         DESC_RATEMCS15_SG = 0x1c,
 626         DESC_RATEMCS32 = 0x20,
 627
 628         DESC_RATEVHT1SS_MCS0 = 0x2c,
 629         DESC_RATEVHT1SS_MCS1 = 0x2d,
 630         DESC_RATEVHT1SS_MCS2 = 0x2e,
 631         DESC_RATEVHT1SS_MCS3 = 0x2f,
 632         DESC_RATEVHT1SS_MCS4 = 0x30,
 633         DESC_RATEVHT1SS_MCS5 = 0x31,
 634         DESC_RATEVHT1SS_MCS6 = 0x32,
 635         DESC_RATEVHT1SS_MCS7 = 0x33,
 636         DESC_RATEVHT1SS_MCS8 = 0x34,
 637         DESC_RATEVHT1SS_MCS9 = 0x35,
 638         DESC_RATEVHT2SS_MCS0 = 0x36,
 639         DESC_RATEVHT2SS_MCS1 = 0x37,
 640         DESC_RATEVHT2SS_MCS2 = 0x38,
 641         DESC_RATEVHT2SS_MCS3 = 0x39,
 642         DESC_RATEVHT2SS_MCS4 = 0x3a,
 643         DESC_RATEVHT2SS_MCS5 = 0x3b,
 644         DESC_RATEVHT2SS_MCS6 = 0x3c,
 645         DESC_RATEVHT2SS_MCS7 = 0x3d,
 646         DESC_RATEVHT2SS_MCS8 = 0x3e,
 647         DESC_RATEVHT2SS_MCS9 = 0x3f,
 648 };
 649
 650 enum rtl_var_map {
 651         /*reg map */
 652         SYS_ISO_CTRL = 0,
 653         SYS_FUNC_EN,
 654         SYS_CLK,
 655         MAC_RCR_AM,
 656         MAC_RCR_AB,
 657         MAC_RCR_ACRC32,
 658         MAC_RCR_ACF,
 659         MAC_RCR_AAP,
 660         MAC_HIMR,
 661         MAC_HIMRE,
 662         MAC_HSISR,
 663
 664         /*efuse map */
 665         EFUSE_TEST,
 666         EFUSE_CTRL,
 667         EFUSE_CLK,
 668         EFUSE_CLK_CTRL,
 669         EFUSE_PWC_EV12V,
 670         EFUSE_FEN_ELDR,
 671         EFUSE_LOADER_CLK_EN,
 672         EFUSE_ANA8M,
 673         EFUSE_HWSET_MAX_SIZE,
 674         EFUSE_MAX_SECTION_MAP,
 675         EFUSE_REAL_CONTENT_SIZE,
 676         EFUSE_OOB_PROTECT_BYTES_LEN,
 677         EFUSE_ACCESS,
 678
 679         /*CAM map */
 680         RWCAM,
 681         WCAMI,
 682         RCAMO,
 683         CAMDBG,
 684         SECR,
 685         SEC_CAM_NONE,
 686         SEC_CAM_WEP40,
 687         SEC_CAM_TKIP,
 688         SEC_CAM_AES,
 689         SEC_CAM_WEP104,
 690
 691         /*IMR map */
 692         RTL_IMR_BCNDMAINT6,     /*Beacon DMA Interrupt 6 */
 693         RTL_IMR_BCNDMAINT5,     /*Beacon DMA Interrupt 5 */
 694         RTL_IMR_BCNDMAINT4,     /*Beacon DMA Interrupt 4 */
 695         RTL_IMR_BCNDMAINT3,     /*Beacon DMA Interrupt 3 */
 696         RTL_IMR_BCNDMAINT2,     /*Beacon DMA Interrupt 2 */
 697         RTL_IMR_BCNDMAINT1,     /*Beacon DMA Interrupt 1 */
 698         RTL_IMR_BCNDOK8,        /*Beacon Queue DMA OK Interrupt 8 */
 699         RTL_IMR_BCNDOK7,        /*Beacon Queue DMA OK Interrupt 7 */
 700         RTL_IMR_BCNDOK6,        /*Beacon Queue DMA OK Interrupt 6 */
 701         RTL_IMR_BCNDOK5,        /*Beacon Queue DMA OK Interrupt 5 */
 702         RTL_IMR_BCNDOK4,        /*Beacon Queue DMA OK Interrupt 4 */
 703         RTL_IMR_BCNDOK3,        /*Beacon Queue DMA OK Interrupt 3 */
 704         RTL_IMR_BCNDOK2,        /*Beacon Queue DMA OK Interrupt 2 */
 705         RTL_IMR_BCNDOK1,        /*Beacon Queue DMA OK Interrupt 1 */
 706         RTL_IMR_TIMEOUT2,       /*Timeout interrupt 2 */
 707         RTL_IMR_TIMEOUT1,       /*Timeout interrupt 1 */
 708         RTL_IMR_TXFOVW,         /*Transmit FIFO Overflow */
 709         RTL_IMR_PSTIMEOUT,      /*Power save time out interrupt */
 710         RTL_IMR_BCNINT,         /*Beacon DMA Interrupt 0 */
 711         RTL_IMR_RXFOVW,         /*Receive FIFO Overflow */
 712         RTL_IMR_RDU,            /*Receive Descriptor Unavailable */
 713         RTL_IMR_ATIMEND,        /*For 92C,ATIM Window End Interrupt */
 714         RTL_IMR_H2CDOK,         /*H2C Queue DMA OK Interrupt */
 715         RTL_IMR_BDOK,           /*Beacon Queue DMA OK Interrupt */
 716         RTL_IMR_HIGHDOK,        /*High Queue DMA OK Interrupt */
 717         RTL_IMR_COMDOK,         /*Command Queue DMA OK Interrupt*/
 718         RTL_IMR_TBDOK,          /*Transmit Beacon OK interrupt */
 719         RTL_IMR_MGNTDOK,        /*Management Queue DMA OK Interrupt */
 720         RTL_IMR_TBDER,          /*For 92C,Transmit Beacon Error Interrupt */
 721         RTL_IMR_BKDOK,          /*AC_BK DMA OK Interrupt */
 722         RTL_IMR_BEDOK,          /*AC_BE DMA OK Interrupt */
 723         RTL_IMR_VIDOK,          /*AC_VI DMA OK Interrupt */
 724         RTL_IMR_VODOK,          /*AC_VO DMA Interrupt */
 725         RTL_IMR_ROK,            /*Receive DMA OK Interrupt */
 726         RTL_IMR_HSISR_IND,      /*HSISR Interrupt*/
 727         RTL_IBSS_INT_MASKS,     /*(RTL_IMR_BCNINT | RTL_IMR_TBDOK |
 728                                  * RTL_IMR_TBDER)
 729                                  */
 730         RTL_IMR_C2HCMD,         /*fw interrupt*/
 731
 732         /*CCK Rates, TxHT = 0 */
 733         RTL_RC_CCK_RATE1M,
 734         RTL_RC_CCK_RATE2M,
 735         RTL_RC_CCK_RATE5_5M,
 736         RTL_RC_CCK_RATE11M,
 737
 738         /*OFDM Rates, TxHT = 0 */
 739         RTL_RC_OFDM_RATE6M,
 740         RTL_RC_OFDM_RATE9M,
 741         RTL_RC_OFDM_RATE12M,
 742         RTL_RC_OFDM_RATE18M,
 743         RTL_RC_OFDM_RATE24M,
 744         RTL_RC_OFDM_RATE36M,
 745         RTL_RC_OFDM_RATE48M,
 746         RTL_RC_OFDM_RATE54M,
 747
 748         RTL_RC_HT_RATEMCS7,
 749         RTL_RC_HT_RATEMCS15,
 750
 751         RTL_RC_VHT_RATE_1SS_MCS7,
 752         RTL_RC_VHT_RATE_1SS_MCS8,
 753         RTL_RC_VHT_RATE_1SS_MCS9,
 754         RTL_RC_VHT_RATE_2SS_MCS7,
 755         RTL_RC_VHT_RATE_2SS_MCS8,
 756         RTL_RC_VHT_RATE_2SS_MCS9,
 757
 758         /*keep it last */
 759         RTL_VAR_MAP_MAX,
 760 };
 761
 762 /*Firmware PS mode for control LPS.*/
 763 enum _fw_ps_mode {
 764         FW_PS_ACTIVE_MODE = 0,
 765         FW_PS_MIN_MODE = 1,
 766         FW_PS_MAX_MODE = 2,
 767         FW_PS_DTIM_MODE = 3,
 768         FW_PS_VOIP_MODE = 4,
 769         FW_PS_UAPSD_WMM_MODE = 5,
 770         FW_PS_UAPSD_MODE = 6,
 771         FW_PS_IBSS_MODE = 7,
 772         FW_PS_WWLAN_MODE = 8,
 773         FW_PS_PM_RADIO_OFF = 9,
 774         FW_PS_PM_CARD_DISABLE = 10,
 775 };
 776
 777 enum rt_psmode {
 778         EACTIVE,                /*Active/Continuous access. */
 779         EMAXPS,                 /*Max power save mode. */
 780         EFASTPS,                /*Fast power save mode. */
 781         EAUTOPS,                /*Auto power save mode. */
 782 };
 783
 784 /*LED related.*/
 785 enum led_ctl_mode {
 786         LED_CTL_POWER_ON = 1,
 787         LED_CTL_LINK = 2,
 788         LED_CTL_NO_LINK = 3,
 789         LED_CTL_TX = 4,
 790         LED_CTL_RX = 5,
 791         LED_CTL_SITE_SURVEY = 6,
 792         LED_CTL_POWER_OFF = 7,
 793         LED_CTL_START_TO_LINK = 8,
 794         LED_CTL_START_WPS = 9,
 795         LED_CTL_STOP_WPS = 10,
 796 };
 797
 798 enum rtl_led_pin {
 799         LED_PIN_GPIO0,
 800         LED_PIN_LED0,
 801         LED_PIN_LED1,
 802         LED_PIN_LED2
 803 };
 804
 805 /* QoS related.*/
 806 /* acm implementation method.*/
 807 enum acm_method {
 808         EACMWAY0_SWANDHW = 0,
 809         EACMWAY1_HW = 1,
 810         EACMWAY2_SW = 2,
 811 };
 812
 813 enum macphy_mode {
 814         SINGLEMAC_SINGLEPHY = 0,
 815         DUALMAC_DUALPHY,
 816         DUALMAC_SINGLEPHY,
 817 };
 818
 819 enum band_type {
 820         BAND_ON_2_4G = 0,
 821         BAND_ON_5G,
 822         BAND_ON_BOTH,
 823         BANDMAX
 824 };
 825
 826 /* aci/aifsn Field.
 827  * Ref: WMM spec 2.2.2: WME Parameter Element, p.12.
 828  */
 829 union aci_aifsn {
 830         u8 char_data;
 831
 832         struct {
 833                 u8 aifsn:4;
 834                 u8 acm:1;
 835                 u8 aci:2;
 836                 u8 reserved:1;
 837         } f;                    /* Field */
 838 };
 839
 840 /*mlme related.*/
 841 enum wireless_mode {
 842         WIRELESS_MODE_UNKNOWN = 0x00,
 843         WIRELESS_MODE_A = 0x01,
 844         WIRELESS_MODE_B = 0x02,
 845         WIRELESS_MODE_G = 0x04,
 846         WIRELESS_MODE_AUTO = 0x08,
 847         WIRELESS_MODE_N_24G = 0x10,
 848         WIRELESS_MODE_N_5G = 0x20,
 849         WIRELESS_MODE_AC_5G = 0x40,
 850         WIRELESS_MODE_AC_24G  = 0x80,
 851         WIRELESS_MODE_AC_ONLY = 0x100,
 852         WIRELESS_MODE_MAX = 0x800
 853 };
 854
 855 #define IS_WIRELESS_MODE_A(wirelessmode)        \
 856         (wirelessmode == WIRELESS_MODE_A)
 857 #define IS_WIRELESS_MODE_B(wirelessmode)        \
 858         (wirelessmode == WIRELESS_MODE_B)
 859 #define IS_WIRELESS_MODE_G(wirelessmode)        \
 860         (wirelessmode == WIRELESS_MODE_G)
 861 #define IS_WIRELESS_MODE_N_24G(wirelessmode)    \
 862         (wirelessmode == WIRELESS_MODE_N_24G)
 863 #define IS_WIRELESS_MODE_N_5G(wirelessmode)     \
 864         (wirelessmode == WIRELESS_MODE_N_5G)
 865
 866 enum ratr_table_mode {
 867         RATR_INX_WIRELESS_NGB = 0,
 868         RATR_INX_WIRELESS_NG = 1,
 869         RATR_INX_WIRELESS_NB = 2,
 870         RATR_INX_WIRELESS_N = 3,
 871         RATR_INX_WIRELESS_GB = 4,
 872         RATR_INX_WIRELESS_G = 5,
 873         RATR_INX_WIRELESS_B = 6,
 874         RATR_INX_WIRELESS_MC = 7,
 875         RATR_INX_WIRELESS_A = 8,
 876         RATR_INX_WIRELESS_AC_5N = 8,
 877         RATR_INX_WIRELESS_AC_24N = 9,
 878 };
 879
 880 enum ratr_table_mode_new {
 881         RATEID_IDX_BGN_40M_2SS = 0,
 882         RATEID_IDX_BGN_40M_1SS = 1,
 883         RATEID_IDX_BGN_20M_2SS_BN = 2,
 884         RATEID_IDX_BGN_20M_1SS_BN = 3,
 885         RATEID_IDX_GN_N2SS = 4,
 886         RATEID_IDX_GN_N1SS = 5,
 887         RATEID_IDX_BG = 6,
 888         RATEID_IDX_G = 7,
 889         RATEID_IDX_B = 8,
 890         RATEID_IDX_VHT_2SS = 9,
 891         RATEID_IDX_VHT_1SS = 10,
 892         RATEID_IDX_MIX1 = 11,
 893         RATEID_IDX_MIX2 = 12,
 894         RATEID_IDX_VHT_3SS = 13,
 895         RATEID_IDX_BGN_3SS = 14,
 896 };
 897
 898 enum rtl_link_state {
 899         MAC80211_NOLINK = 0,
 900         MAC80211_LINKING = 1,
 901         MAC80211_LINKED = 2,
 902         MAC80211_LINKED_SCANNING = 3,
 903 };
 904
 905 enum act_category {
 906         ACT_CAT_QOS = 1,
 907         ACT_CAT_DLS = 2,
 908         ACT_CAT_BA = 3,
 909         ACT_CAT_HT = 7,
 910         ACT_CAT_WMM = 17,
 911 };
 912
 913 enum ba_action {
 914         ACT_ADDBAREQ = 0,
 915         ACT_ADDBARSP = 1,
 916         ACT_DELBA = 2,
 917 };
 918
 919 enum rt_polarity_ctl {
 920         RT_POLARITY_LOW_ACT = 0,
 921         RT_POLARITY_HIGH_ACT = 1,
 922 };
 923
 924 /* After 8188E, we use V2 reason define. 88C/8723A use V1 reason. */
 925 enum fw_wow_reason_v2 {
 926         FW_WOW_V2_PTK_UPDATE_EVENT = 0x01,
 927         FW_WOW_V2_GTK_UPDATE_EVENT = 0x02,
 928         FW_WOW_V2_DISASSOC_EVENT = 0x04,
 929         FW_WOW_V2_DEAUTH_EVENT = 0x08,
 930         FW_WOW_V2_FW_DISCONNECT_EVENT = 0x10,
 931         FW_WOW_V2_MAGIC_PKT_EVENT = 0x21,
 932         FW_WOW_V2_UNICAST_PKT_EVENT = 0x22,
 933         FW_WOW_V2_PATTERN_PKT_EVENT = 0x23,
 934         FW_WOW_V2_RTD3_SSID_MATCH_EVENT = 0x24,
 935         FW_WOW_V2_REALWOW_V2_WAKEUPPKT = 0x30,
 936         FW_WOW_V2_REALWOW_V2_ACKLOST = 0x31,
 937         FW_WOW_V2_REASON_MAX = 0xff,
 938 };
 939
 940 enum wolpattern_type {
 941         UNICAST_PATTERN = 0,
 942         MULTICAST_PATTERN = 1,
 943         BROADCAST_PATTERN = 2,
 944         DONT_CARE_DA = 3,
 945         UNKNOWN_TYPE = 4,
 946 };
 947
 948 enum package_type {
 949         PACKAGE_DEFAULT,
 950         PACKAGE_QFN68,
 951         PACKAGE_TFBGA90,
 952         PACKAGE_TFBGA80,
 953         PACKAGE_TFBGA79
 954 };
 955
 956 enum rtl_spec_ver {
 957         RTL_SPEC_NEW_RATEID = BIT(0),   /* use ratr_table_mode_new */
 958         RTL_SPEC_SUPPORT_VHT = BIT(1),  /* support VHT */
 959         RTL_SPEC_NEW_FW_C2H = BIT(2),   /* new FW C2H (e.g. TX REPORT) */
 960 };
 961
 962 struct octet_string {
 963         u8 *octet;
 964         u16 length;
 965 };
 966
 967 struct rtl_hdr_3addr {
 968         __le16 frame_ctl;
 969         __le16 duration_id;
 970         u8 addr1[ETH_ALEN];
 971         u8 addr2[ETH_ALEN];
 972         u8 addr3[ETH_ALEN];
 973         __le16 seq_ctl;
 974         u8 payload[0];
 975 } __packed;
 976
 977 struct rtl_info_element {
 978         u8 id;
 979         u8 len;
 980         u8 data[0];
 981 } __packed;
 982
 983 struct rtl_probe_rsp {
 984         struct rtl_hdr_3addr header;
 985         u32 time_stamp[2];
 986         __le16 beacon_interval;
 987         __le16 capability;
 988         /* SSID, supported rates, FH params, DS params,
 989          * CF params, IBSS params, TIM (if beacon), RSN
 990          */
 991         struct rtl_info_element info_element[0];
 992 } __packed;
 993
 994 struct rtl_beacon_keys {
 995         /*u8 ssid[32];*/
 996         /*u32 ssid_len;*/
 997         u8 bcn_channel;
 998         __le16 ht_cap_info;
 999         u8 ht_info_infos_0_sco; /* bit0 & bit1 in infos[0] is 2nd ch offset */
1000         bool valid;
1001 };
1002
1003 /*LED related.*/
1004 /*ledpin Identify how to implement this SW led.*/
1005 struct rtl_led {
1006         void *hw;
1007         enum rtl_led_pin ledpin;
1008         bool ledon;
1009 };
1010
1011 struct rtl_led_ctl {
1012         bool led_opendrain;
1013         struct rtl_led sw_led0;
1014         struct rtl_led sw_led1;
1015 };
1016
1017 struct rtl_qos_parameters {
1018         __le16 cw_min;
1019         __le16 cw_max;
1020         u8 aifs;
1021         u8 flag;
1022         __le16 tx_op;
1023 } __packed;
1024
1025 struct rt_smooth_data {
1026         u32 elements[100];      /*array to store values */
1027         u32 index;              /*index to current array to store */
1028         u32 total_num;          /*num of valid elements */
1029         u32 total_val;          /*sum of valid elements */
1030 };
1031
1032 struct false_alarm_statistics {
1033         u32 cnt_parity_fail;
1034         u32 cnt_rate_illegal;
1035         u32 cnt_crc8_fail;
1036         u32 cnt_mcs_fail;
1037         u32 cnt_fast_fsync_fail;
1038         u32 cnt_sb_search_fail;
1039         u32 cnt_ofdm_fail;
1040         u32 cnt_cck_fail;
1041         u32 cnt_all;
1042         u32 cnt_ofdm_cca;
1043         u32 cnt_cck_cca;
1044         u32 cnt_cca_all;
1045         u32 cnt_bw_usc;
1046         u32 cnt_bw_lsc;
1047 };
1048
1049 struct init_gain {
1050         u8 xaagccore1;
1051         u8 xbagccore1;
1052         u8 xcagccore1;
1053         u8 xdagccore1;
1054         u8 cca;
1055
1056 };
1057
1058 struct wireless_stats {
1059         u64 txbytesunicast;
1060         u64 txbytesmulticast;
1061         u64 txbytesbroadcast;
1062         u64 rxbytesunicast;
1063
1064         u64 txbytesunicast_inperiod;
1065         u64 rxbytesunicast_inperiod;
1066         u32 txbytesunicast_inperiod_tp;
1067         u32 rxbytesunicast_inperiod_tp;
1068         u64 txbytesunicast_last;
1069         u64 rxbytesunicast_last;
1070
1071         long rx_snr_db[4];
1072         /* Correct smoothed ss in Dbm, only used
1073          * in driver to report real power now.
1074          */
1075         long recv_signal_power;
1076         long signal_quality;
1077         long last_sigstrength_inpercent;
1078
1079         u32 rssi_calculate_cnt;
1080         u32 pwdb_all_cnt;
1081
1082         /* Transformed, in dbm. Beautified signal
1083          * strength for UI, not correct.
1084          */
1085         long signal_strength;
1086
1087         u8 rx_rssi_percentage[4];
1088         u8 rx_evm_dbm[4];
1089         u8 rx_evm_percentage[2];
1090
1091         u16 rx_cfo_short[4];
1092         u16 rx_cfo_tail[4];
1093
1094         struct rt_smooth_data ui_rssi;
1095         struct rt_smooth_data ui_link_quality;
1096 };
1097
1098 struct rate_adaptive {
1099         u8 rate_adaptive_disabled;
1100         u8 ratr_state;
1101         u16 reserve;
1102
1103         u32 high_rssi_thresh_for_ra;
1104         u32 high2low_rssi_thresh_for_ra;
1105         u8 low2high_rssi_thresh_for_ra40m;
1106         u32 low_rssi_thresh_for_ra40m;
1107         u8 low2high_rssi_thresh_for_ra20m;
1108         u32 low_rssi_thresh_for_ra20m;
1109         u32 upper_rssi_threshold_ratr;
1110         u32 middleupper_rssi_threshold_ratr;
1111         u32 middle_rssi_threshold_ratr;
1112         u32 middlelow_rssi_threshold_ratr;
1113         u32 low_rssi_threshold_ratr;
1114         u32 ultralow_rssi_threshold_ratr;
1115         u32 low_rssi_threshold_ratr_40m;
1116         u32 low_rssi_threshold_ratr_20m;
1117         u8 ping_rssi_enable;
1118         u32 ping_rssi_ratr;
1119         u32 ping_rssi_thresh_for_ra;
1120         u32 last_ratr;
1121         u8 pre_ratr_state;
1122         u8 ldpc_thres;
1123         bool use_ldpc;
1124         bool lower_rts_rate;
1125         bool is_special_data;
1126 };
1127
1128 struct regd_pair_mapping {
1129         u16 reg_dmnenum;
1130         u16 reg_5ghz_ctl;
1131         u16 reg_2ghz_ctl;
1132 };
1133
1134 struct dynamic_primary_cca {
1135         u8 pricca_flag;
1136         u8 intf_flag;
1137         u8 intf_type;
1138         u8 dup_rts_flag;
1139         u8 monitor_flag;
1140         u8 ch_offset;
1141         u8 mf_state;
1142 };
1143
1144 struct rtl_regulatory {
1145         s8 alpha2[2];
1146         u16 country_code;
1147         u16 max_power_level;
1148         u32 tp_scale;
1149         u16 current_rd;
1150         u16 current_rd_ext;
1151         s16 power_limit;
1152         struct regd_pair_mapping *regpair;
1153 };
1154
1155 struct rtl_rfkill {
1156         bool rfkill_state;      /*0 is off, 1 is on */
1157 };
1158
1159 /*for P2P PS**/
1160 #define P2P_MAX_NOA_NUM         2
1161
1162 enum p2p_role {
1163         P2P_ROLE_DISABLE = 0,
1164         P2P_ROLE_DEVICE = 1,
1165         P2P_ROLE_CLIENT = 2,
1166         P2P_ROLE_GO = 3
1167 };
1168
1169 enum p2p_ps_state {
1170         P2P_PS_DISABLE = 0,
1171         P2P_PS_ENABLE = 1,
1172         P2P_PS_SCAN = 2,
1173         P2P_PS_SCAN_DONE = 3,
1174         P2P_PS_ALLSTASLEEP = 4, /* for P2P GO */
1175 };
1176
1177 enum p2p_ps_mode {
1178         P2P_PS_NONE = 0,
1179         P2P_PS_CTWINDOW = 1,
1180         P2P_PS_NOA       = 2,
1181         P2P_PS_MIX = 3, /* CTWindow and NoA */
1182 };
1183
1184 struct rtl_p2p_ps_info {
1185         enum p2p_ps_mode p2p_ps_mode; /* indicate p2p ps mode */
1186         enum p2p_ps_state p2p_ps_state; /*  indicate p2p ps state */
1187         u8 noa_index; /*  Identifies instance of Notice of Absence timing. */
1188         /*  Client traffic window. A period of time in TU after TBTT. */
1189         u8 ctwindow;
1190         u8 opp_ps; /*  opportunistic power save. */
1191         u8 noa_num; /*  number of NoA descriptor in P2P IE. */
1192         /*  Count for owner, Type of client. */
1193         u8 noa_count_type[P2P_MAX_NOA_NUM];
1194         /*  Max duration for owner, preferred or min acceptable duration
1195          * for client.
1196          */
1197         u32 noa_duration[P2P_MAX_NOA_NUM];
1198         /*  Length of interval for owner, preferred or max acceptable intervali
1199          * of client.
1200          */
1201         u32 noa_interval[P2P_MAX_NOA_NUM];
1202         /*  schedule in terms of the lower 4 bytes of the TSF timer. */
1203         u32 noa_start_time[P2P_MAX_NOA_NUM];
1204 };
1205
1206 struct p2p_ps_offload_t {
1207         u8 offload_en:1;
1208         u8 role:1; /* 1: Owner, 0: Client */
1209         u8 ctwindow_en:1;
1210         u8 noa0_en:1;
1211         u8 noa1_en:1;
1212         u8 allstasleep:1;
1213         u8 discovery:1;
1214         u8 reserved:1;
1215 };
1216
1217 #define IQK_MATRIX_REG_NUM      8
1218 #define IQK_MATRIX_SETTINGS_NUM (1 + 24 + 21)
1219
1220 struct iqk_matrix_regs {
1221         bool iqk_done;
1222         long value[1][IQK_MATRIX_REG_NUM];
1223 };
1224
1225 struct phy_parameters {
1226         u16 length;
1227         u32 *pdata;
1228 };
1229
1230 enum hw_param_tab_index {
1231         PHY_REG_2T,
1232         PHY_REG_1T,
1233         PHY_REG_PG,
1234         RADIOA_2T,
1235         RADIOB_2T,
1236         RADIOA_1T,
1237         RADIOB_1T,
1238         MAC_REG,
1239         AGCTAB_2T,
1240         AGCTAB_1T,
1241         MAX_TAB
1242 };
1243
1244 struct rtl_phy {
1245         struct bb_reg_def phyreg_def[4];        /*Radio A/B/C/D */
1246         struct init_gain initgain_backup;
1247         enum io_type current_io_type;
1248
1249         u8 rf_mode;
1250         u8 rf_type;
1251         u8 current_chan_bw;
1252         u8 max_ht_chan_bw;
1253         u8 max_vht_chan_bw;
1254         u8 set_bwmode_inprogress;
1255         u8 sw_chnl_inprogress;
1256         u8 sw_chnl_stage;
1257         u8 sw_chnl_step;
1258         u8 current_channel;
1259         u8 h2c_box_num;
1260         u8 set_io_inprogress;
1261         u8 lck_inprogress;
1262
1263         /* record for power tracking */
1264         s32 reg_e94;
1265         s32 reg_e9c;
1266         s32 reg_ea4;
1267         s32 reg_eac;
1268         s32 reg_eb4;
1269         s32 reg_ebc;
1270         s32 reg_ec4;
1271         s32 reg_ecc;
1272         u8 rfpienable;
1273         u8 reserve_0;
1274         u16 reserve_1;
1275         u32 reg_c04, reg_c08, reg_874;
1276         u32 adda_backup[16];
1277         u32 iqk_mac_backup[IQK_MAC_REG_NUM];
1278         u32 iqk_bb_backup[10];
1279         bool iqk_initialized;
1280
1281         bool rfpath_rx_enable[MAX_RF_PATH];
1282         u8 reg_837;
1283         /* Dual mac */
1284         bool need_iqk;
1285         struct iqk_matrix_regs iqk_matrix[IQK_MATRIX_SETTINGS_NUM];
1286
1287         bool rfpi_enable;
1288         bool iqk_in_progress;
1289
1290         u8 pwrgroup_cnt;
1291         u8 cck_high_power;
1292         /* this is for 88E & 8723A */
1293         u32 mcs_txpwrlevel_origoffset[MAX_PG_GROUP][16];
1294         /* MAX_PG_GROUP groups of pwr diff by rates */
1295         u32 mcs_offset[MAX_PG_GROUP][16];
1296         u32 tx_power_by_rate_offset[TX_PWR_BY_RATE_NUM_BAND]
1297                                    [TX_PWR_BY_RATE_NUM_RF]
1298                                    [TX_PWR_BY_RATE_NUM_RF]
1299                                    [TX_PWR_BY_RATE_NUM_RATE];
1300         /* compatible with TX_PWR_BY_RATE_NUM_SECTION*/
1301         u8 txpwr_by_rate_base_24g[TX_PWR_BY_RATE_NUM_RF]
1302                                  [TX_PWR_BY_RATE_NUM_RF]
1303                                  [MAX_BASE_NUM_IN_PHY_REG_PG_24G];
1304         u8 txpwr_by_rate_base_5g[TX_PWR_BY_RATE_NUM_RF]
1305                                 [TX_PWR_BY_RATE_NUM_RF]
1306                                 [MAX_BASE_NUM_IN_PHY_REG_PG_5G];
1307         u8 default_initialgain[4];
1308
1309         /* the current Tx power level */
1310         u8 cur_cck_txpwridx;
1311         u8 cur_ofdm24g_txpwridx;
1312         u8 cur_bw20_txpwridx;
1313         u8 cur_bw40_txpwridx;
1314
1315         s8 txpwr_limit_2_4g[MAX_REGULATION_NUM]
1316                            [MAX_2_4G_BANDWIDTH_NUM]
1317                            [MAX_RATE_SECTION_NUM]
1318                            [CHANNEL_MAX_NUMBER_2G]
1319                            [MAX_RF_PATH_NUM];
1320         s8 txpwr_limit_5g[MAX_REGULATION_NUM]
1321                          [MAX_5G_BANDWIDTH_NUM]
1322                          [MAX_RATE_SECTION_NUM]
1323                          [CHANNEL_MAX_NUMBER_5G]
1324                          [MAX_RF_PATH_NUM];
1325
1326         u32 rfreg_chnlval[2];
1327         bool apk_done;
1328         u32 reg_rf3c[2];        /* pathA / pathB  */
1329
1330         u32 backup_rf_0x1a;/*92ee*/
1331         /* bfsync */
1332         u8 framesync;
1333         u32 framesync_c34;
1334
1335         u8 num_total_rfpath;
1336         struct phy_parameters hwparam_tables[MAX_TAB];
1337         u16 rf_pathmap;
1338
1339         u8 hw_rof_enable; /*Enable GPIO[9] as WL RF HW PDn source*/
1340         enum rt_polarity_ctl polarity_ctl;
1341 };
1342
1343 #define MAX_TID_COUNT                           9
1344 #define RTL_AGG_STOP                            0
1345 #define RTL_AGG_PROGRESS                        1
1346 #define RTL_AGG_START                           2
1347 #define RTL_AGG_OPERATIONAL                     3
1348 #define RTL_AGG_OFF                             0
1349 #define RTL_AGG_ON                              1
1350 #define RTL_RX_AGG_START                        1
1351 #define RTL_RX_AGG_STOP                         0
1352 #define RTL_AGG_EMPTYING_HW_QUEUE_ADDBA         2
1353 #define RTL_AGG_EMPTYING_HW_QUEUE_DELBA         3
1354
1355 struct rtl_ht_agg {
1356         u16 txq_id;
1357         u16 wait_for_ba;
1358         u16 start_idx;
1359         u64 bitmap;
1360         u32 rate_n_flags;
1361         u8 agg_state;
1362         u8 rx_agg_state;
1363 };
1364
1365 struct rssi_sta {
1366         /* for old dm */
1367         long undec_sm_pwdb;
1368         long undec_sm_cck;
1369
1370         /* for new phydm_mod */
1371         s32 undecorated_smoothed_pwdb;
1372         s32 undecorated_smoothed_cck;
1373         s32 undecorated_smoothed_ofdm;
1374         u8 ofdm_pkt;
1375         u8 cck_pkt;
1376         u16 cck_sum_power;
1377         u8 is_send_rssi;
1378         u64 packet_map;
1379         u8 valid_bit;
1380 };
1381
1382 struct rtl_tid_data {
1383         u16 seq_number;
1384         struct rtl_ht_agg agg;
1385 };
1386
1387 struct rtl_sta_info {
1388         struct list_head list;
1389         struct rtl_tid_data tids[MAX_TID_COUNT];
1390         /* just used for ap adhoc or mesh*/
1391         struct rssi_sta rssi_stat;
1392         u8 rssi_level;
1393         u16 wireless_mode;
1394         u8 ratr_index;
1395         u8 mimo_ps;
1396         u8 mac_addr[ETH_ALEN];
1397 } __packed;
1398
1399 struct rtl_priv;
1400 struct rtl_io {
1401         struct device *dev;
1402         struct mutex bb_mutex;
1403
1404         /*PCI MEM map */
1405         unsigned long pci_mem_end;      /*shared mem end        */
1406         unsigned long pci_mem_start;    /*shared mem start */
1407
1408         /*PCI IO map */
1409         unsigned long pci_base_addr;    /*device I/O address */
1410
1411         void (*write8_async)(struct rtl_priv *rtlpriv, u32 addr, u8 val);
1412         void (*write16_async)(struct rtl_priv *rtlpriv, u32 addr, u16 val);
1413         void (*write32_async)(struct rtl_priv *rtlpriv, u32 addr, u32 val);
1414         void (*writeN_sync)(struct rtl_priv *rtlpriv, u32 addr, void *buf,
1415                             u16 len);
1416
1417         u8 (*read8_sync)(struct rtl_priv *rtlpriv, u32 addr);
1418         u16 (*read16_sync)(struct rtl_priv *rtlpriv, u32 addr);
1419         u32 (*read32_sync)(struct rtl_priv *rtlpriv, u32 addr);
1420
1421 };
1422
1423 struct rtl_mac {
1424         u8 mac_addr[ETH_ALEN];
1425         u8 mac80211_registered;
1426         u8 beacon_enabled;
1427
1428         u32 tx_ss_num;
1429         u32 rx_ss_num;
1430
1431         struct ieee80211_supported_band bands[NUM_NL80211_BANDS];
1432         struct ieee80211_hw *hw;
1433         struct ieee80211_vif *vif;
1434         enum nl80211_iftype opmode;
1435
1436         /*Probe Beacon management */
1437         struct rtl_tid_data tids[MAX_TID_COUNT];
1438         enum rtl_link_state link_state;
1439         struct rtl_beacon_keys cur_beacon_keys;
1440         u8 new_beacon_cnt;
1441
1442         int n_channels;
1443         int n_bitrates;
1444
1445         bool offchan_delay;
1446         u8 p2p; /*using p2p role*/
1447         bool p2p_in_use;
1448
1449         /*filters */
1450         u32 rx_conf;
1451         u16 rx_mgt_filter;
1452         u16 rx_ctrl_filter;
1453         u16 rx_data_filter;
1454
1455         bool act_scanning;
1456         u8 cnt_after_linked;
1457         bool skip_scan;
1458
1459         /* early mode */
1460         /* skb wait queue */
1461         struct sk_buff_head skb_waitq[MAX_TID_COUNT];
1462
1463         u8 ht_stbc_cap;
1464         u8 ht_cur_stbc;
1465
1466         /*vht support*/
1467         u8 vht_enable;
1468         u8 bw_80;
1469         u8 vht_cur_ldpc;
1470         u8 vht_cur_stbc;
1471         u8 vht_stbc_cap;
1472         u8 vht_ldpc_cap;
1473
1474         /*RDG*/
1475         bool rdg_en;
1476
1477         /*AP*/
1478         u8 bssid[ETH_ALEN] __aligned(2);
1479         u32 vendor;
1480         u8 mcs[16];     /* 16 bytes mcs for HT rates. */
1481         u32 basic_rates; /* b/g rates */
1482         u8 ht_enable;
1483         u8 sgi_40;
1484         u8 sgi_20;
1485         u8 bw_40;
1486         u16 mode;               /* wireless mode */
1487         u8 slot_time;
1488         u8 short_preamble;
1489         u8 use_cts_protect;
1490         u8 cur_40_prime_sc;
1491         u8 cur_40_prime_sc_bk;
1492         u8 cur_80_prime_sc;
1493         u64 tsf;
1494         u8 retry_short;
1495         u8 retry_long;
1496         u16 assoc_id;
1497         bool hiddenssid;
1498
1499         /*IBSS*/
1500         int beacon_interval;
1501
1502         /*AMPDU*/
1503         u8 min_space_cfg;       /*For Min spacing configurations */
1504         u8 max_mss_density;
1505         u8 current_ampdu_factor;
1506         u8 current_ampdu_density;
1507
1508         /*QOS & EDCA */
1509         struct ieee80211_tx_queue_params edca_param[RTL_MAC80211_NUM_QUEUE];
1510         struct rtl_qos_parameters ac[AC_MAX];
1511
1512         /* counters */
1513         u64 last_txok_cnt;
1514         u64 last_rxok_cnt;
1515         u32 last_bt_edca_ul;
1516         u32 last_bt_edca_dl;
1517 };
1518
1519 struct btdm_8723 {
1520         bool all_off;
1521         bool agc_table_en;
1522         bool adc_back_off_on;
1523         bool b2_ant_hid_en;
1524         bool low_penalty_rate_adaptive;
1525         bool rf_rx_lpf_shrink;
1526         bool reject_aggre_pkt;
1527         bool tra_tdma_on;
1528         u8 tra_tdma_nav;
1529         u8 tra_tdma_ant;
1530         bool tdma_on;
1531         u8 tdma_ant;
1532         u8 tdma_nav;
1533         u8 tdma_dac_swing;
1534         u8 fw_dac_swing_lvl;
1535         bool ps_tdma_on;
1536         u8 ps_tdma_byte[5];
1537         bool pta_on;
1538         u32 val_0x6c0;
1539         u32 val_0x6c8;
1540         u32 val_0x6cc;
1541         bool sw_dac_swing_on;
1542         u32 sw_dac_swing_lvl;
1543         u32 wlan_act_hi;
1544         u32 wlan_act_lo;
1545         u32 bt_retry_index;
1546         bool dec_bt_pwr;
1547         bool ignore_wlan_act;
1548 };
1549
1550 struct bt_coexist_8723 {
1551         u32 high_priority_tx;
1552         u32 high_priority_rx;
1553         u32 low_priority_tx;
1554         u32 low_priority_rx;
1555         u8 c2h_bt_info;
1556         bool c2h_bt_info_req_sent;
1557         bool c2h_bt_inquiry_page;
1558         u32 bt_inq_page_start_time;
1559         u8 bt_retry_cnt;
1560         u8 c2h_bt_info_original;
1561         u8 bt_inquiry_page_cnt;
1562         struct btdm_8723 btdm;
1563 };
1564
1565 struct rtl_hal {
1566         struct ieee80211_hw *hw;
1567         bool driver_is_goingto_unload;
1568         bool up_first_time;
1569         bool first_init;
1570         bool being_init_adapter;
1571         bool bbrf_ready;
1572         bool mac_func_enable;
1573         bool pre_edcca_enable;
1574         struct bt_coexist_8723 hal_coex_8723;
1575
1576         enum intf_type interface;
1577         u16 hw_type;            /*92c or 92d or 92s and so on */
1578         u8 ic_class;
1579         u8 oem_id;
1580         u32 version;            /*version of chip */
1581         u8 state;               /*stop 0, start 1 */
1582         u8 board_type;
1583         u8 package_type;
1584         u8 external_pa;
1585
1586         u8 pa_mode;
1587         u8 pa_type_2g;
1588         u8 pa_type_5g;
1589         u8 lna_type_2g;
1590         u8 lna_type_5g;
1591         u8 external_pa_2g;
1592         u8 external_lna_2g;
1593         u8 external_pa_5g;
1594         u8 external_lna_5g;
1595         u8 type_glna;
1596         u8 type_gpa;
1597         u8 type_alna;
1598         u8 type_apa;
1599         u8 rfe_type;
1600
1601         /*firmware */
1602         u32 fwsize;
1603         u8 *pfirmware;
1604         u16 fw_version;
1605         u16 fw_subversion;
1606         bool h2c_setinprogress;
1607         u8 last_hmeboxnum;
1608         bool fw_ready;
1609         /*Reserve page start offset except beacon in TxQ. */
1610         u8 fw_rsvdpage_startoffset;
1611         u8 h2c_txcmd_seq;
1612         u8 current_ra_rate;
1613
1614         /* FW Cmd IO related */
1615         u16 fwcmd_iomap;
1616         u32 fwcmd_ioparam;
1617         bool set_fwcmd_inprogress;
1618         u8 current_fwcmd_io;
1619
1620         struct p2p_ps_offload_t p2p_ps_offload;
1621         bool fw_clk_change_in_progress;
1622         bool allow_sw_to_change_hwclc;
1623         u8 fw_ps_state;
1624         /**/
1625         bool driver_going2unload;
1626
1627         /*AMPDU init min space*/
1628         u8 minspace_cfg;        /*For Min spacing configurations */
1629
1630         /* Dual mac */
1631         enum macphy_mode macphymode;
1632         enum band_type current_bandtype;        /* 0:2.4G, 1:5G */
1633         enum band_type current_bandtypebackup;
1634         enum band_type bandset;
1635         /* dual MAC 0--Mac0 1--Mac1 */
1636         u32 interfaceindex;
1637         /* just for DualMac S3S4 */
1638         u8 macphyctl_reg;
1639         bool earlymode_enable;
1640         u8 max_earlymode_num;
1641         /* Dual mac*/
1642         bool during_mac0init_radiob;
1643         bool during_mac1init_radioa;
1644         bool reloadtxpowerindex;
1645         /* True if IMR or IQK  have done
1646          * for 2.4G in scan progress
1647          */
1648         bool load_imrandiqk_setting_for2g;
1649
1650         bool disable_amsdu_8k;
1651         bool master_of_dmsp;
1652         bool slave_of_dmsp;
1653
1654         u16 rx_tag;/*for 92ee*/
1655         u8 rts_en;
1656
1657         /*for wowlan*/
1658         bool wow_enable;
1659         bool enter_pnp_sleep;
1660         bool wake_from_pnp_sleep;
1661         bool wow_enabled;
1662         time64_t last_suspend_sec;
1663         u32 wowlan_fwsize;
1664         u8 *wowlan_firmware;
1665
1666         u8 hw_rof_enable; /*Enable GPIO[9] as WL RF HW PDn source*/
1667
1668         bool real_wow_v2_enable;
1669         bool re_init_llt_table;
1670 };
1671
1672 struct rtl_security {
1673         /*default 0 */
1674         bool use_sw_sec;
1675
1676         bool being_setkey;
1677         bool use_defaultkey;
1678         /*Encryption Algorithm for Unicast Packet */
1679         enum rt_enc_alg pairwise_enc_algorithm;
1680         /*Encryption Algorithm for Brocast/Multicast */
1681         enum rt_enc_alg group_enc_algorithm;
1682         /*Cam Entry Bitmap */
1683         u32 hwsec_cam_bitmap;
1684         u8 hwsec_cam_sta_addr[TOTAL_CAM_ENTRY][ETH_ALEN];
1685         /* local Key buffer, indx 0 is for
1686          * pairwise key 1-4 is for agoup key.
1687          */
1688         u8 key_buf[KEY_BUF_SIZE][MAX_KEY_LEN];
1689         u8 key_len[KEY_BUF_SIZE];
1690
1691         /* The pointer of Pairwise Key,
1692          * it always points to KeyBuf[4]
1693          */
1694         u8 *pairwise_key;
1695 };
1696
1697 #define ASSOCIATE_ENTRY_NUM     33
1698
1699 struct fast_ant_training {
1700         u8      bssid[6];
1701         u8      antsel_rx_keep_0;
1702         u8      antsel_rx_keep_1;
1703         u8      antsel_rx_keep_2;
1704         u32     ant_sum[7];
1705         u32     ant_cnt[7];
1706         u32     ant_ave[7];
1707         u8      fat_state;
1708         u32     train_idx;
1709         u8      antsel_a[ASSOCIATE_ENTRY_NUM];
1710         u8      antsel_b[ASSOCIATE_ENTRY_NUM];
1711         u8      antsel_c[ASSOCIATE_ENTRY_NUM];
1712         u32     main_ant_sum[ASSOCIATE_ENTRY_NUM];
1713         u32     aux_ant_sum[ASSOCIATE_ENTRY_NUM];
1714         u32     main_ant_cnt[ASSOCIATE_ENTRY_NUM];
1715         u32     aux_ant_cnt[ASSOCIATE_ENTRY_NUM];
1716         u8      rx_idle_ant;
1717         bool    becomelinked;
1718 };
1719
1720 struct dm_phy_dbg_info {
1721         s8 rx_snrdb[4];
1722         u64 num_qry_phy_status;
1723         u64 num_qry_phy_status_cck;
1724         u64 num_qry_phy_status_ofdm;
1725         u16 num_qry_beacon_pkt;
1726         u16 num_non_be_pkt;
1727         s32 rx_evm[4];
1728 };
1729
1730 struct rtl_dm {
1731         /*PHY status for Dynamic Management */
1732         long entry_min_undec_sm_pwdb;
1733         long undec_sm_cck;
1734         long undec_sm_pwdb;     /*out dm */
1735         long entry_max_undec_sm_pwdb;
1736         s32 ofdm_pkt_cnt;
1737         bool dm_initialgain_enable;
1738         bool dynamic_txpower_enable;
1739         bool current_turbo_edca;
1740         bool is_any_nonbepkts;  /*out dm */
1741         bool is_cur_rdlstate;
1742         bool txpower_trackinginit;
1743         bool disable_framebursting;
1744         bool cck_inch14;
1745         bool txpower_tracking;
1746         bool useramask;
1747         bool rfpath_rxenable[4];
1748         bool inform_fw_driverctrldm;
1749         bool current_mrc_switch;
1750         u8 txpowercount;
1751         u8 powerindex_backup[6];
1752
1753         u8 thermalvalue_rxgain;
1754         u8 thermalvalue_iqk;
1755         u8 thermalvalue_lck;
1756         u8 thermalvalue;
1757         u8 last_dtp_lvl;
1758         u8 thermalvalue_avg[AVG_THERMAL_NUM];
1759         u8 thermalvalue_avg_index;
1760         u8 tm_trigger;
1761         bool done_txpower;
1762         u8 dynamic_txhighpower_lvl;     /*Tx high power level */
1763         u8 dm_flag;             /*Indicate each dynamic mechanism's status. */
1764         u8 dm_flag_tmp;
1765         u8 dm_type;
1766         u8 dm_rssi_sel;
1767         u8 txpower_track_control;
1768         bool interrupt_migration;
1769         bool disable_tx_int;
1770         s8 ofdm_index[MAX_RF_PATH];
1771         u8 default_ofdm_index;
1772         u8 default_cck_index;
1773         s8 cck_index;
1774         s8 delta_power_index[MAX_RF_PATH];
1775         s8 delta_power_index_last[MAX_RF_PATH];
1776         s8 power_index_offset[MAX_RF_PATH];
1777         s8 absolute_ofdm_swing_idx[MAX_RF_PATH];
1778         s8 remnant_ofdm_swing_idx[MAX_RF_PATH];
1779         s8 remnant_cck_idx;
1780         bool modify_txagc_flag_path_a;
1781         bool modify_txagc_flag_path_b;
1782
1783         bool one_entry_only;
1784         struct dm_phy_dbg_info dbginfo;
1785
1786         /* Dynamic ATC switch */
1787         bool atc_status;
1788         bool large_cfo_hit;
1789         bool is_freeze;
1790         int cfo_tail[2];
1791         int cfo_ave_pre;
1792         int crystal_cap;
1793         u8 cfo_threshold;
1794         u32 packet_count;
1795         u32 packet_count_pre;
1796         u8 tx_rate;
1797
1798         /*88e tx power tracking*/
1799         u8      swing_idx_ofdm[MAX_RF_PATH];
1800         u8      swing_idx_ofdm_cur;
1801         u8      swing_idx_ofdm_base[MAX_RF_PATH];
1802         bool    swing_flag_ofdm;
1803         u8      swing_idx_cck;
1804         u8      swing_idx_cck_cur;
1805         u8      swing_idx_cck_base;
1806         bool    swing_flag_cck;
1807
1808         s8      swing_diff_2g;
1809         s8      swing_diff_5g;
1810
1811         /* DMSP */
1812         bool supp_phymode_switch;
1813
1814         /* DulMac */
1815         struct fast_ant_training fat_table;
1816
1817         u8      resp_tx_path;
1818         u8      path_sel;
1819         u32     patha_sum;
1820         u32     pathb_sum;
1821         u32     patha_cnt;
1822         u32     pathb_cnt;
1823
1824         u8 pre_channel;
1825         u8 *p_channel;
1826         u8 linked_interval;
1827
1828         u64 last_tx_ok_cnt;
1829         u64 last_rx_ok_cnt;
1830 };
1831
1832 #define EFUSE_MAX_LOGICAL_SIZE                  512
1833
1834 struct rtl_efuse {
1835         bool autoload_ok;
1836         bool bootfromefuse;
1837         u16 max_physical_size;
1838
1839         u8 efuse_map[2][EFUSE_MAX_LOGICAL_SIZE];
1840         u16 efuse_usedbytes;
1841         u8 efuse_usedpercentage;
1842 #ifdef EFUSE_REPG_WORKAROUND
1843         bool efuse_re_pg_sec1flag;
1844         u8 efuse_re_pg_data[8];
1845 #endif
1846
1847         u8 autoload_failflag;
1848         u8 autoload_status;
1849
1850         short epromtype;
1851         u16 eeprom_vid;
1852         u16 eeprom_did;
1853         u16 eeprom_svid;
1854         u16 eeprom_smid;
1855         u8 eeprom_oemid;
1856         u16 eeprom_channelplan;
1857         u8 eeprom_version;
1858         u8 board_type;
1859         u8 external_pa;
1860
1861         u8 dev_addr[6];
1862         u8 wowlan_enable;
1863         u8 antenna_div_cfg;
1864         u8 antenna_div_type;
1865
1866         bool txpwr_fromeprom;
1867         u8 eeprom_crystalcap;
1868         u8 eeprom_tssi[2];
1869         u8 eeprom_tssi_5g[3][2]; /* for 5GL/5GM/5GH band. */
1870         u8 eeprom_pwrlimit_ht20[CHANNEL_GROUP_MAX];
1871         u8 eeprom_pwrlimit_ht40[CHANNEL_GROUP_MAX];
1872         u8 eeprom_chnlarea_txpwr_cck[MAX_RF_PATH][CHANNEL_GROUP_MAX_2G];
1873         u8 eeprom_chnlarea_txpwr_ht40_1s[MAX_RF_PATH][CHANNEL_GROUP_MAX];
1874         u8 eprom_chnl_txpwr_ht40_2sdf[MAX_RF_PATH][CHANNEL_GROUP_MAX];
1875
1876         u8 internal_pa_5g[2];   /* pathA / pathB */
1877         u8 eeprom_c9;
1878         u8 eeprom_cc;
1879
1880         /*For power group */
1881         u8 eeprom_pwrgroup[2][3];
1882         u8 pwrgroup_ht20[2][CHANNEL_MAX_NUMBER];
1883         u8 pwrgroup_ht40[2][CHANNEL_MAX_NUMBER];
1884
1885         u8 txpwrlevel_cck[MAX_RF_PATH][CHANNEL_MAX_NUMBER_2G];
1886         /*For HT 40MHZ pwr */
1887         u8 txpwrlevel_ht40_1s[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1888         /*For HT 40MHZ pwr */
1889         u8 txpwrlevel_ht40_2s[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1890
1891         /*--------------------------------------------------------*
1892          * 8192CE\8192SE\8192DE\8723AE use the following 4 arrays,
1893          * other ICs (8188EE\8723BE\8192EE\8812AE...)
1894          * define new arrays in Windows code.
1895          * BUT, in linux code, we use the same array for all ICs.
1896          *
1897          * The Correspondance relation between two arrays is:
1898          * txpwr_cckdiff[][] == CCK_24G_Diff[][]
1899          * txpwr_ht20diff[][] == BW20_24G_Diff[][]
1900          * txpwr_ht40diff[][] == BW40_24G_Diff[][]
1901          * txpwr_legacyhtdiff[][] == OFDM_24G_Diff[][]
1902          *
1903          * Sizes of these arrays are decided by the larger ones.
1904          */
1905         s8 txpwr_cckdiff[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1906         s8 txpwr_ht20diff[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1907         s8 txpwr_ht40diff[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1908         s8 txpwr_legacyhtdiff[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1909
1910         u8 txpwr_5g_bw40base[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
1911         u8 txpwr_5g_bw80base[MAX_RF_PATH][CHANNEL_MAX_NUMBER_5G_80M];
1912         s8 txpwr_5g_ofdmdiff[MAX_RF_PATH][MAX_TX_COUNT];
1913         s8 txpwr_5g_bw20diff[MAX_RF_PATH][MAX_TX_COUNT];
1914         s8 txpwr_5g_bw40diff[MAX_RF_PATH][MAX_TX_COUNT];
1915         s8 txpwr_5g_bw80diff[MAX_RF_PATH][MAX_TX_COUNT];
1916
1917         u8 txpwr_safetyflag;                    /* Band edge enable flag */
1918         u16 eeprom_txpowerdiff;
1919         u8 legacy_httxpowerdiff;        /* Legacy to HT rate power diff */
1920         u8 antenna_txpwdiff[3];
1921
1922         u8 eeprom_regulatory;
1923         u8 eeprom_thermalmeter;
1924         u8 thermalmeter[2]; /*ThermalMeter, index 0 for RFIC0, 1 for RFIC1 */
1925         u16 tssi_13dbm;
1926         u8 crystalcap;          /* CrystalCap. */
1927         u8 delta_iqk;
1928         u8 delta_lck;
1929
1930         u8 legacy_ht_txpowerdiff;       /*Legacy to HT rate power diff */
1931         bool apk_thermalmeterignore;
1932
1933         bool b1x1_recvcombine;
1934         bool b1ss_support;
1935
1936         /*channel plan */
1937         u8 channel_plan;
1938 };
1939
1940 struct rtl_tx_report {
1941         atomic_t sn;
1942         u16 last_sent_sn;
1943         unsigned long last_sent_time;
1944         u16 last_recv_sn;
1945 };
1946
1947 struct rtl_ps_ctl {
1948         bool pwrdomain_protect;
1949         bool in_powersavemode;
1950         bool rfchange_inprogress;
1951         bool swrf_processing;
1952         bool hwradiooff;
1953         /* just for PCIE ASPM
1954          * If it supports ASPM, Offset[560h] = 0x40,
1955          * otherwise Offset[560h] = 0x00.
1956          */
1957         bool support_aspm;
1958         bool support_backdoor;
1959
1960         /*for LPS */
1961         enum rt_psmode dot11_psmode;    /*Power save mode configured. */
1962         bool swctrl_lps;
1963         bool leisure_ps;
1964         bool fwctrl_lps;
1965         u8 fwctrl_psmode;
1966         /*For Fw control LPS mode */
1967         u8 reg_fwctrl_lps;
1968         /*Record Fw PS mode status. */
1969         bool fw_current_inpsmode;
1970         u8 reg_max_lps_awakeintvl;
1971         bool report_linked;
1972         bool low_power_enable;/*for 32k*/
1973
1974         /*for IPS */
1975         bool inactiveps;
1976
1977         u32 rfoff_reason;
1978
1979         /*RF OFF Level */
1980         u32 cur_ps_level;
1981         u32 reg_rfps_level;
1982
1983         /*just for PCIE ASPM */
1984         u8 const_amdpci_aspm;
1985         bool pwrdown_mode;
1986
1987         enum rf_pwrstate inactive_pwrstate;
1988         enum rf_pwrstate rfpwr_state;   /*cur power state */
1989
1990         /* for SW LPS*/
1991         bool sw_ps_enabled;
1992         bool state;
1993         bool state_inap;
1994         bool multi_buffered;
1995         u16 nullfunc_seq;
1996         unsigned int dtim_counter;
1997         unsigned int sleep_ms;
1998         unsigned long last_sleep_jiffies;
1999         unsigned long last_awake_jiffies;
2000         unsigned long last_delaylps_stamp_jiffies;
2001         unsigned long last_dtim;
2002         unsigned long last_beacon;
2003         unsigned long last_action;
2004         unsigned long last_slept;
2005
2006         /*For P2P PS */
2007         struct rtl_p2p_ps_info p2p_ps_info;
2008         u8 pwr_mode;
2009         u8 smart_ps;
2010
2011         /* wake up on line */
2012         u8 wo_wlan_mode;
2013         u8 arp_offload_enable;
2014         u8 gtk_offload_enable;
2015         /* Used for WOL, indicates the reason for waking event.*/
2016         u32 wakeup_reason;
2017         /* Record the last waking time for comparison with setting key. */
2018         u64 last_wakeup_time;
2019 };
2020
2021 struct rtl_stats {
2022         u8 psaddr[ETH_ALEN];
2023         u32 mac_time[2];
2024         s8 rssi;
2025         u8 signal;
2026         u8 noise;
2027         u8 rate;                /* hw desc rate */
2028         u8 received_channel;
2029         u8 control;
2030         u8 mask;
2031         u8 freq;
2032         u16 len;
2033         u64 tsf;
2034         u32 beacon_time;
2035         u8 nic_type;
2036         u16 length;
2037         u8 signalquality;       /*in 0-100 index. */
2038         /*
2039          * Real power in dBm for this packet,
2040          * no beautification and aggregation.
2041          */
2042         s32 recvsignalpower;
2043         s8 rxpower;             /*in dBm Translate from PWdB */
2044         u8 signalstrength;      /*in 0-100 index. */
2045         u16 hwerror:1;
2046         u16 crc:1;
2047         u16 icv:1;
2048         u16 shortpreamble:1;
2049         u16 antenna:1;
2050         u16 decrypted:1;
2051         u16 wakeup:1;
2052         u32 timestamp_low;
2053         u32 timestamp_high;
2054         bool shift;
2055
2056         u8 rx_drvinfo_size;
2057         u8 rx_bufshift;
2058         bool isampdu;
2059         bool isfirst_ampdu;
2060         bool rx_is40mhzpacket;
2061         u8 rx_packet_bw;
2062         u32 rx_pwdb_all;
2063         u8 rx_mimo_signalstrength[4];   /*in 0~100 index */
2064         s8 rx_mimo_signalquality[4];
2065         u8 rx_mimo_evm_dbm[4];
2066         u16 cfo_short[4];               /* per-path's Cfo_short */
2067         u16 cfo_tail[4];
2068
2069         s8 rx_mimo_sig_qual[4];
2070         u8 rx_pwr[4]; /* per-path's pwdb */
2071         u8 rx_snr[4]; /* per-path's SNR */
2072         u8 bandwidth;
2073         u8 bt_coex_pwr_adjust;
2074         bool packet_matchbssid;
2075         bool is_cck;
2076         bool is_ht;
2077         bool packet_toself;
2078         bool packet_beacon;     /*for rssi */
2079         s8 cck_adc_pwdb[4];     /*for rx path selection */
2080
2081         bool is_vht;
2082         bool is_short_gi;
2083         u8 vht_nss;
2084
2085         u8 packet_report_type;
2086
2087         u32 macid;
2088         u8 wake_match;
2089         u32 bt_rx_rssi_percentage;
2090         u32 macid_valid_entry[2];
2091 };
2092
2093 struct rt_link_detect {
2094         /* count for roaming */
2095         u32 bcn_rx_inperiod;
2096         u32 roam_times;
2097
2098         u32 num_tx_in4period[4];
2099         u32 num_rx_in4period[4];
2100
2101         u32 num_tx_inperiod;
2102         u32 num_rx_inperiod;
2103
2104         bool busytraffic;
2105         bool tx_busy_traffic;
2106         bool rx_busy_traffic;
2107         bool higher_busytraffic;
2108         bool higher_busyrxtraffic;
2109
2110         u32 tidtx_in4period[MAX_TID_COUNT][4];
2111         u32 tidtx_inperiod[MAX_TID_COUNT];
2112         bool higher_busytxtraffic[MAX_TID_COUNT];
2113 };
2114
2115 struct rtl_tcb_desc {
2116         u8 packet_bw:2;
2117         u8 multicast:1;
2118         u8 broadcast:1;
2119
2120         u8 rts_stbc:1;
2121         u8 rts_enable:1;
2122         u8 cts_enable:1;
2123         u8 rts_use_shortpreamble:1;
2124         u8 rts_use_shortgi:1;
2125         u8 rts_sc:1;
2126         u8 rts_bw:1;
2127         u8 rts_rate;
2128
2129         u8 use_shortgi:1;
2130         u8 use_shortpreamble:1;
2131         u8 use_driver_rate:1;
2132         u8 disable_ratefallback:1;
2133
2134         u8 use_spe_rpt:1;
2135
2136         u8 ratr_index;
2137         u8 mac_id;
2138         u8 hw_rate;
2139
2140         u8 last_inipkt:1;
2141         u8 cmd_or_init:1;
2142         u8 queue_index;
2143
2144         /* early mode */
2145         u8 empkt_num;
2146         /* The max value by HW */
2147         u32 empkt_len[10];
2148         bool tx_enable_sw_calc_duration;
2149 };
2150
2151 struct rtl_wow_pattern {
2152         u8 type;
2153         u16 crc;
2154         u32 mask[4];
2155 };
2156
2157 struct rtl_hal_ops {
2158         int (*init_sw_vars)(struct ieee80211_hw *hw);
2159         void (*deinit_sw_vars)(struct ieee80211_hw *hw);
2160         void (*read_chip_version)(struct ieee80211_hw *hw);
2161         void (*read_eeprom_info)(struct ieee80211_hw *hw);
2162         void (*interrupt_recognized)(struct ieee80211_hw *hw,
2163                                      u32 *p_inta, u32 *p_intb,
2164                                      u32 *p_intc, u32 *p_intd);
2165         int (*hw_init)(struct ieee80211_hw *hw);
2166         void (*hw_disable)(struct ieee80211_hw *hw);
2167         void (*hw_suspend)(struct ieee80211_hw *hw);
2168         void (*hw_resume)(struct ieee80211_hw *hw);
2169         void (*enable_interrupt)(struct ieee80211_hw *hw);
2170         void (*disable_interrupt)(struct ieee80211_hw *hw);
2171         int (*set_network_type)(struct ieee80211_hw *hw,
2172                                 enum nl80211_iftype type);
2173         void (*set_chk_bssid)(struct ieee80211_hw *hw,
2174                               bool check_bssid);
2175         void (*set_bw_mode)(struct ieee80211_hw *hw,
2176                             enum nl80211_channel_type ch_type);
2177          u8 (*switch_channel)(struct ieee80211_hw *hw);
2178         void (*set_qos)(struct ieee80211_hw *hw, int aci);
2179         void (*set_bcn_reg)(struct ieee80211_hw *hw);
2180         void (*set_bcn_intv)(struct ieee80211_hw *hw);
2181         void (*update_interrupt_mask)(struct ieee80211_hw *hw,
2182                                       u32 add_msr, u32 rm_msr);
2183         void (*get_hw_reg)(struct ieee80211_hw *hw, u8 variable, u8 *val);
2184         void (*set_hw_reg)(struct ieee80211_hw *hw, u8 variable, u8 *val);
2185         void (*update_rate_tbl)(struct ieee80211_hw *hw,
2186                                 struct ieee80211_sta *sta, u8 rssi_leve,
2187                                 bool update_bw);
2188         void (*pre_fill_tx_bd_desc)(struct ieee80211_hw *hw, u8 *tx_bd_desc,
2189                                     u8 *desc, u8 queue_index,
2190                                     struct sk_buff *skb, dma_addr_t addr);
2191         void (*update_rate_mask)(struct ieee80211_hw *hw, u8 rssi_level);
2192         u16 (*rx_desc_buff_remained_cnt)(struct ieee80211_hw *hw,
2193                                          u8 queue_index);
2194         void (*rx_check_dma_ok)(struct ieee80211_hw *hw, u8 *header_desc,
2195                                 u8 queue_index);
2196         void (*fill_tx_desc)(struct ieee80211_hw *hw,
2197                              struct ieee80211_hdr *hdr, u8 *pdesc_tx,
2198                              u8 *pbd_desc_tx,
2199                              struct ieee80211_tx_info *info,
2200                              struct ieee80211_sta *sta,
2201                              struct sk_buff *skb, u8 hw_queue,
2202                              struct rtl_tcb_desc *ptcb_desc);
2203         void (*fill_fake_txdesc)(struct ieee80211_hw *hw, u8 *pdesc,
2204                                  u32 buffer_len, bool bispspoll);
2205         void (*fill_tx_cmddesc)(struct ieee80211_hw *hw, u8 *pdesc,
2206                                 bool firstseg, bool lastseg,
2207                                 struct sk_buff *skb);
2208         void (*fill_tx_special_desc)(struct ieee80211_hw *hw,
2209                                      u8 *pdesc, u8 *pbd_desc,
2210                                      struct sk_buff *skb, u8 hw_queue);
2211         bool (*query_rx_desc)(struct ieee80211_hw *hw,
2212                               struct rtl_stats *stats,
2213                               struct ieee80211_rx_status *rx_status,
2214                               u8 *pdesc, struct sk_buff *skb);
2215         void (*set_channel_access)(struct ieee80211_hw *hw);
2216         bool (*radio_onoff_checking)(struct ieee80211_hw *hw, u8 *valid);
2217         void (*dm_watchdog)(struct ieee80211_hw *hw);
2218         void (*scan_operation_backup)(struct ieee80211_hw *hw, u8 operation);
2219         bool (*set_rf_power_state)(struct ieee80211_hw *hw,
2220                                    enum rf_pwrstate rfpwr_state);
2221         void (*led_control)(struct ieee80211_hw *hw,
2222                             enum led_ctl_mode ledaction);
2223         void (*set_desc)(struct ieee80211_hw *hw, u8 *pdesc, bool istx,
2224                          u8 desc_name, u8 *val);
2225         u64 (*get_desc)(struct ieee80211_hw *hw, u8 *pdesc, bool istx,
2226                         u8 desc_name);
2227         bool (*is_tx_desc_closed)(struct ieee80211_hw *hw,
2228                                   u8 hw_queue, u16 index);
2229         void (*tx_polling)(struct ieee80211_hw *hw, u8 hw_queue);
2230         void (*enable_hw_sec)(struct ieee80211_hw *hw);
2231         void (*set_key)(struct ieee80211_hw *hw, u32 key_index,
2232                         u8 *macaddr, bool is_group, u8 enc_algo,
2233                         bool is_wepkey, bool clear_all);
2234         void (*init_sw_leds)(struct ieee80211_hw *hw);
2235         void (*deinit_sw_leds)(struct ieee80211_hw *hw);
2236         u32 (*get_bbreg)(struct ieee80211_hw *hw, u32 regaddr, u32 bitmask);
2237         void (*set_bbreg)(struct ieee80211_hw *hw, u32 regaddr, u32 bitmask,
2238                           u32 data);
2239         u32 (*get_rfreg)(struct ieee80211_hw *hw, enum radio_path rfpath,
2240                          u32 regaddr, u32 bitmask);
2241         void (*set_rfreg)(struct ieee80211_hw *hw, enum radio_path rfpath,
2242                           u32 regaddr, u32 bitmask, u32 data);
2243         void (*linked_set_reg)(struct ieee80211_hw *hw);
2244         void (*chk_switch_dmdp)(struct ieee80211_hw *hw);
2245         void (*dualmac_easy_concurrent)(struct ieee80211_hw *hw);
2246         void (*dualmac_switch_to_dmdp)(struct ieee80211_hw *hw);
2247         bool (*phy_rf6052_config)(struct ieee80211_hw *hw);
2248         void (*phy_rf6052_set_cck_txpower)(struct ieee80211_hw *hw,
2249                                            u8 *powerlevel);
2250         void (*phy_rf6052_set_ofdm_txpower)(struct ieee80211_hw *hw,
2251                                             u8 *ppowerlevel, u8 channel);
2252         bool (*config_bb_with_headerfile)(struct ieee80211_hw *hw,
2253                                           u8 configtype);
2254         bool (*config_bb_with_pgheaderfile)(struct ieee80211_hw *hw,
2255                                             u8 configtype);
2256         void (*phy_lc_calibrate)(struct ieee80211_hw *hw, bool is2t);
2257         void (*phy_set_bw_mode_callback)(struct ieee80211_hw *hw);
2258         void (*dm_dynamic_txpower)(struct ieee80211_hw *hw);
2259         void (*c2h_command_handle)(struct ieee80211_hw *hw);
2260         void (*bt_wifi_media_status_notify)(struct ieee80211_hw *hw,
2261                                             bool mstate);
2262         void (*bt_coex_off_before_lps)(struct ieee80211_hw *hw);
2263         void (*fill_h2c_cmd)(struct ieee80211_hw *hw, u8 element_id,
2264                              u32 cmd_len, u8 *p_cmdbuffer);
2265         void (*set_default_port_id_cmd)(struct ieee80211_hw *hw);
2266         bool (*get_btc_status)(void);
2267         bool (*is_fw_header)(struct rtlwifi_firmware_header *hdr);
2268         u32 (*rx_command_packet)(struct ieee80211_hw *hw,
2269                                  const struct rtl_stats *status,
2270                                  struct sk_buff *skb);
2271         void (*add_wowlan_pattern)(struct ieee80211_hw *hw,
2272                                    struct rtl_wow_pattern *rtl_pattern,
2273                                    u8 index);
2274         u16 (*get_available_desc)(struct ieee80211_hw *hw, u8 q_idx);
2275         void (*c2h_content_parsing)(struct ieee80211_hw *hw, u8 tag, u8 len,
2276                                     u8 *val);
2277         /* ops for halmac cb */
2278         bool (*halmac_cb_init_mac_register)(struct rtl_priv *rtlpriv);
2279         bool (*halmac_cb_init_bb_rf_register)(struct rtl_priv *rtlpriv);
2280         bool (*halmac_cb_write_data_rsvd_page)(struct rtl_priv *rtlpriv,
2281                                                u8 *buf, u32 size);
2282         bool (*halmac_cb_write_data_h2c)(struct rtl_priv *rtlpriv, u8 *buf,
2283                                          u32 size);
2284         /* ops for phydm cb */
2285         u8 (*get_txpower_index)(struct ieee80211_hw *hw, u8 path,
2286                                 u8 rate, u8 bandwidth, u8 channel);
2287         void (*set_tx_power_index_by_rs)(struct ieee80211_hw *hw,
2288                                          u8 channel, u8 path,
2289                                          enum rate_section rs);
2290         void (*store_tx_power_by_rate)(struct ieee80211_hw *hw,
2291                                        u32 band, u32 rfpath,
2292                                        u32 txnum, u32 regaddr,
2293                                        u32 bitmask, u32 data);
2294         void (*phy_set_txpower_limit)(struct ieee80211_hw *hw, u8 *pregulation,
2295                                       u8 *pband, u8 *pbandwidth,
2296                                       u8 *prate_section, u8 *prf_path,
2297                                       u8 *pchannel, u8 *ppower_limit);
2298 };
2299
2300 struct rtl_intf_ops {
2301         /*com */
2302         void (*read_efuse_byte)(struct ieee80211_hw *hw, u16 _offset, u8 *pbuf);
2303         int (*adapter_start)(struct ieee80211_hw *hw);
2304         void (*adapter_stop)(struct ieee80211_hw *hw);
2305         bool (*check_buddy_priv)(struct ieee80211_hw *hw,
2306                                  struct rtl_priv **buddy_priv);
2307
2308         int (*adapter_tx)(struct ieee80211_hw *hw,
2309                           struct ieee80211_sta *sta,
2310                           struct sk_buff *skb,
2311                           struct rtl_tcb_desc *ptcb_desc);
2312         void (*flush)(struct ieee80211_hw *hw, u32 queues, bool drop);
2313         int (*reset_trx_ring)(struct ieee80211_hw *hw);
2314         bool (*waitq_insert)(struct ieee80211_hw *hw,
2315                              struct ieee80211_sta *sta,
2316                              struct sk_buff *skb);
2317
2318         /*pci */
2319         void (*disable_aspm)(struct ieee80211_hw *hw);
2320         void (*enable_aspm)(struct ieee80211_hw *hw);
2321
2322         /*usb */
2323 };
2324
2325 struct rtl_mod_params {
2326         /* default: 0,0 */
2327         u64 debug_mask;
2328         /* default: 0 = using hardware encryption */
2329         bool sw_crypto;
2330
2331         /* default: 0 = DBG_EMERG (0)*/
2332         int debug_level;
2333
2334         /* default: 1 = using no linked power save */
2335         bool inactiveps;
2336
2337         /* default: 1 = using linked sw power save */
2338         bool swctrl_lps;
2339
2340         /* default: 1 = using linked fw power save */
2341         bool fwctrl_lps;
2342
2343         /* default: 0 = not using MSI interrupts mode
2344          * submodules should set their own default value
2345          */
2346         bool msi_support;
2347
2348         /* default: 0 = dma 32 */
2349         bool dma64;
2350
2351         /* default: 1 = enable aspm */
2352         int aspm_support;
2353
2354         /* default 0: 1 means disable */
2355         bool disable_watchdog;
2356
2357         /* default 0: 1 means do not disable interrupts */
2358         bool int_clear;
2359
2360         /* select antenna */
2361         int ant_sel;
2362 };
2363
2364 struct rtl_hal_usbint_cfg {
2365         /* data - rx */
2366         u32 in_ep_num;
2367         u32 rx_urb_num;
2368         u32 rx_max_size;
2369
2370         /* op - rx */
2371         void (*usb_rx_hdl)(struct ieee80211_hw *hw, struct sk_buff *skb);
2372         void (*usb_rx_segregate_hdl)(struct ieee80211_hw *hw,
2373                                      struct sk_buff *skb,
2374                                      struct sk_buff_head *skbh);
2375
2376         /* tx */
2377         void (*usb_tx_cleanup)(struct ieee80211_hw *hw, struct sk_buff *skb);
2378         int (*usb_tx_post_hdl)(struct ieee80211_hw *hw, struct urb *urb,
2379                                struct sk_buff *skb);
2380         struct sk_buff *(*usb_tx_aggregate_hdl)(struct ieee80211_hw *hw,
2381                                                 struct sk_buff_head *skbh);
2382
2383         /* endpoint mapping */
2384         int (*usb_endpoint_mapping)(struct ieee80211_hw *hw);
2385         u16 (*usb_mq_to_hwq)(__le16 fc, u16 mac80211_queue_index);
2386 };
2387
2388 struct rtl_hal_cfg {
2389         u8 bar_id;
2390         bool write_readback;
2391         char *name;
2392         char *alt_fw_name;
2393         struct rtl_hal_ops *ops;
2394         struct rtl_mod_params *mod_params;
2395         struct rtl_hal_usbint_cfg *usb_interface_cfg;
2396         enum rtl_spec_ver spec_ver;
2397
2398         /* this map used for some registers or vars
2399          * defined int HAL but used in MAIN
2400          */
2401         u32 maps[RTL_VAR_MAP_MAX];
2402
2403 };
2404
2405 struct rtl_locks {
2406         /* mutex */
2407         struct mutex conf_mutex;
2408         struct mutex ips_mutex; /* mutex for enter/leave IPS */
2409         struct mutex lps_mutex; /* mutex for enter/leave LPS */
2410
2411         /*spin lock */
2412         spinlock_t irq_th_lock;
2413         spinlock_t h2c_lock;
2414         spinlock_t rf_ps_lock;
2415         spinlock_t rf_lock;
2416         spinlock_t waitq_lock;
2417         spinlock_t entry_list_lock;
2418         spinlock_t usb_lock;
2419         spinlock_t c2hcmd_lock;
2420         spinlock_t scan_list_lock; /* lock for the scan list */
2421
2422         /*FW clock change */
2423         spinlock_t fw_ps_lock;
2424
2425         /*Dual mac*/
2426         spinlock_t cck_and_rw_pagea_lock;
2427
2428         spinlock_t iqk_lock;
2429 };
2430
2431 struct rtl_works {
2432         struct ieee80211_hw *hw;
2433
2434         /*timer */
2435         struct timer_list watchdog_timer;
2436         struct timer_list dualmac_easyconcurrent_retrytimer;
2437         struct timer_list fw_clockoff_timer;
2438         struct timer_list fast_antenna_training_timer;
2439         /*task */
2440         struct tasklet_struct irq_tasklet;
2441         struct tasklet_struct irq_prepare_bcn_tasklet;
2442
2443         /*work queue */
2444         struct workqueue_struct *rtl_wq;
2445         struct delayed_work watchdog_wq;
2446         struct delayed_work ips_nic_off_wq;
2447         struct delayed_work c2hcmd_wq;
2448
2449         /* For SW LPS */
2450         struct delayed_work ps_work;
2451         struct delayed_work ps_rfon_wq;
2452         struct delayed_work fwevt_wq;
2453
2454         struct work_struct lps_change_work;
2455         struct work_struct fill_h2c_cmd;
2456 };
2457
2458 struct rtl_debug {
2459         /* add for debug */
2460         struct dentry *debugfs_dir;
2461         char debugfs_name[20];
2462
2463         char *msg_buf;
2464 };
2465
2466 #define MIMO_PS_STATIC                  0
2467 #define MIMO_PS_DYNAMIC                 1
2468 #define MIMO_PS_NOLIMIT                 3
2469
2470 struct rtl_dualmac_easy_concurrent_ctl {
2471         enum band_type currentbandtype_backfordmdp;
2472         bool close_bbandrf_for_dmsp;
2473         bool change_to_dmdp;
2474         bool change_to_dmsp;
2475         bool switch_in_process;
2476 };
2477
2478 struct rtl_dmsp_ctl {
2479         bool activescan_for_slaveofdmsp;
2480         bool scan_for_anothermac_fordmsp;
2481         bool scan_for_itself_fordmsp;
2482         bool writedig_for_anothermacofdmsp;
2483         u32 curdigvalue_for_anothermacofdmsp;
2484         bool changecckpdstate_for_anothermacofdmsp;
2485         u8 curcckpdstate_for_anothermacofdmsp;
2486         bool changetxhighpowerlvl_for_anothermacofdmsp;
2487         u8 curtxhighlvl_for_anothermacofdmsp;
2488         long rssivalmin_for_anothermacofdmsp;
2489 };
2490
2491 struct ps_t {
2492         u8 pre_ccastate;
2493         u8 cur_ccasate;
2494         u8 pre_rfstate;
2495         u8 cur_rfstate;
2496         u8 initialize;
2497         long rssi_val_min;
2498 };
2499
2500 struct dig_t {
2501         u32 rssi_lowthresh;
2502         u32 rssi_highthresh;
2503         u32 fa_lowthresh;
2504         u32 fa_highthresh;
2505         long last_min_undec_pwdb_for_dm;
2506         long rssi_highpower_lowthresh;
2507         long rssi_highpower_highthresh;
2508         u32 recover_cnt;
2509         u32 pre_igvalue;
2510         u32 cur_igvalue;
2511         long rssi_val;
2512         u8 dig_enable_flag;
2513         u8 dig_ext_port_stage;
2514         u8 dig_algorithm;
2515         u8 dig_twoport_algorithm;
2516         u8 dig_dbgmode;
2517         u8 dig_slgorithm_switch;
2518         u8 cursta_cstate;
2519         u8 presta_cstate;
2520         u8 curmultista_cstate;
2521         u8 stop_dig;
2522         s8 back_val;
2523         s8 back_range_max;
2524         s8 back_range_min;
2525         u8 rx_gain_max;
2526         u8 rx_gain_min;
2527         u8 min_undec_pwdb_for_dm;
2528         u8 rssi_val_min;
2529         u8 pre_cck_cca_thres;
2530         u8 cur_cck_cca_thres;
2531         u8 pre_cck_pd_state;
2532         u8 cur_cck_pd_state;
2533         u8 pre_cck_fa_state;
2534         u8 cur_cck_fa_state;
2535         u8 pre_ccastate;
2536         u8 cur_ccasate;
2537         u8 large_fa_hit;
2538         u8 forbidden_igi;
2539         u8 dig_state;
2540         u8 dig_highpwrstate;
2541         u8 cur_sta_cstate;
2542         u8 pre_sta_cstate;
2543         u8 cur_ap_cstate;
2544         u8 pre_ap_cstate;
2545         u8 cur_pd_thstate;
2546         u8 pre_pd_thstate;
2547         u8 cur_cs_ratiostate;
2548         u8 pre_cs_ratiostate;
2549         u8 backoff_enable_flag;
2550         s8 backoffval_range_max;
2551         s8 backoffval_range_min;
2552         u8 dig_min_0;
2553         u8 dig_min_1;
2554         u8 bt30_cur_igi;
2555         bool media_connect_0;
2556         bool media_connect_1;
2557
2558         u32 antdiv_rssi_max;
2559         u32 rssi_max;
2560 };
2561
2562 struct rtl_global_var {
2563         /* from this list we can get
2564          * other adapter's rtl_priv
2565          */
2566         struct list_head glb_priv_list;
2567         spinlock_t glb_list_lock;
2568 };
2569
2570 #define IN_4WAY_TIMEOUT_TIME    (30 * MSEC_PER_SEC)     /* 30 seconds */
2571
2572 struct rtl_btc_info {
2573         u8 bt_type;
2574         u8 btcoexist;
2575         u8 ant_num;
2576         u8 single_ant_path;
2577
2578         u8 ap_num;
2579         bool in_4way;
2580         unsigned long in_4way_ts;
2581 };
2582
2583 struct bt_coexist_info {
2584         struct rtl_btc_ops *btc_ops;
2585         struct rtl_btc_info btc_info;
2586         /* btc context */
2587         void *btc_context;
2588         void *wifi_only_context;
2589         /* EEPROM BT info. */
2590         u8 eeprom_bt_coexist;
2591         u8 eeprom_bt_type;
2592         u8 eeprom_bt_ant_num;
2593         u8 eeprom_bt_ant_isol;
2594         u8 eeprom_bt_radio_shared;
2595
2596         u8 bt_coexistence;
2597         u8 bt_ant_num;
2598         u8 bt_coexist_type;
2599         u8 bt_state;
2600         u8 bt_cur_state;        /* 0:on, 1:off */
2601         u8 bt_ant_isolation;    /* 0:good, 1:bad */
2602         u8 bt_pape_ctrl;        /* 0:SW, 1:SW/HW dynamic */
2603         u8 bt_service;
2604         u8 bt_radio_shared_type;
2605         u8 bt_rfreg_origin_1e;
2606         u8 bt_rfreg_origin_1f;
2607         u8 bt_rssi_state;
2608         u32 ratio_tx;
2609         u32 ratio_pri;
2610         u32 bt_edca_ul;
2611         u32 bt_edca_dl;
2612
2613         bool init_set;
2614         bool bt_busy_traffic;
2615         bool bt_traffic_mode_set;
2616         bool bt_non_traffic_mode_set;
2617
2618         bool fw_coexist_all_off;
2619         bool sw_coexist_all_off;
2620         bool hw_coexist_all_off;
2621         u32 cstate;
2622         u32 previous_state;
2623         u32 cstate_h;
2624         u32 previous_state_h;
2625
2626         u8 bt_pre_rssi_state;
2627         u8 bt_pre_rssi_state1;
2628
2629         u8 reg_bt_iso;
2630         u8 reg_bt_sco;
2631         bool balance_on;
2632         u8 bt_active_zero_cnt;
2633         bool cur_bt_disabled;
2634         bool pre_bt_disabled;
2635
2636         u8 bt_profile_case;
2637         u8 bt_profile_action;
2638         bool bt_busy;
2639         bool hold_for_bt_operation;
2640         u8 lps_counter;
2641 };
2642
2643 struct rtl_btc_ops {
2644         void (*btc_init_variables)(struct rtl_priv *rtlpriv);
2645         void (*btc_init_variables_wifi_only)(struct rtl_priv *rtlpriv);
2646         void (*btc_deinit_variables)(struct rtl_priv *rtlpriv);
2647         void (*btc_init_hal_vars)(struct rtl_priv *rtlpriv);
2648         void (*btc_power_on_setting)(struct rtl_priv *rtlpriv);
2649         void (*btc_init_hw_config)(struct rtl_priv *rtlpriv);
2650         void (*btc_init_hw_config_wifi_only)(struct rtl_priv *rtlpriv);
2651         void (*btc_ips_notify)(struct rtl_priv *rtlpriv, u8 type);
2652         void (*btc_lps_notify)(struct rtl_priv *rtlpriv, u8 type);
2653         void (*btc_scan_notify)(struct rtl_priv *rtlpriv, u8 scantype);
2654         void (*btc_scan_notify_wifi_only)(struct rtl_priv *rtlpriv,
2655                                           u8 scantype);
2656         void (*btc_connect_notify)(struct rtl_priv *rtlpriv, u8 action);
2657         void (*btc_mediastatus_notify)(struct rtl_priv *rtlpriv,
2658                                        enum rt_media_status mstatus);
2659         void (*btc_periodical)(struct rtl_priv *rtlpriv);
2660         void (*btc_halt_notify)(struct rtl_priv *rtlpriv);
2661         void (*btc_btinfo_notify)(struct rtl_priv *rtlpriv,
2662                                   u8 *tmp_buf, u8 length);
2663         void (*btc_btmpinfo_notify)(struct rtl_priv *rtlpriv,
2664                                     u8 *tmp_buf, u8 length);
2665         bool (*btc_is_limited_dig)(struct rtl_priv *rtlpriv);
2666         bool (*btc_is_disable_edca_turbo)(struct rtl_priv *rtlpriv);
2667         bool (*btc_is_bt_disabled)(struct rtl_priv *rtlpriv);
2668         void (*btc_special_packet_notify)(struct rtl_priv *rtlpriv,
2669                                           u8 pkt_type);
2670         void (*btc_switch_band_notify)(struct rtl_priv *rtlpriv, u8 type,
2671                                        bool scanning);
2672         void (*btc_switch_band_notify_wifi_only)(struct rtl_priv *rtlpriv,
2673                                                  u8 type, bool scanning);
2674         void (*btc_display_bt_coex_info)(struct rtl_priv *rtlpriv,
2675                                          struct seq_file *m);
2676         void (*btc_record_pwr_mode)(struct rtl_priv *rtlpriv, u8 *buf, u8 len);
2677         u8   (*btc_get_lps_val)(struct rtl_priv *rtlpriv);
2678         u8   (*btc_get_rpwm_val)(struct rtl_priv *rtlpriv);
2679         bool (*btc_is_bt_ctrl_lps)(struct rtl_priv *rtlpriv);
2680         void (*btc_get_ampdu_cfg)(struct rtl_priv *rtlpriv, u8 *reject_agg,
2681                                   u8 *ctrl_agg_size, u8 *agg_size);
2682         bool (*btc_is_bt_lps_on)(struct rtl_priv *rtlpriv);
2683 };
2684
2685 struct rtl_halmac_ops {
2686         int (*halmac_init_adapter)(struct rtl_priv *rtlpriv);
2687         int (*halmac_deinit_adapter)(struct rtl_priv *rtlpriv);
2688         int (*halmac_init_hal)(struct rtl_priv *rtlpriv);
2689         int (*halmac_deinit_hal)(struct rtl_priv *rtlpriv);
2690         int (*halmac_poweron)(struct rtl_priv *rtlpriv);
2691         int (*halmac_poweroff)(struct rtl_priv *rtlpriv);
2692
2693         int (*halmac_phy_power_switch)(struct rtl_priv *rtlpriv, u8 enable);
2694         int (*halmac_set_mac_address)(struct rtl_priv *rtlpriv, u8 hwport,
2695                                       u8 *addr);
2696         int (*halmac_set_bssid)(struct rtl_priv *rtlpriv, u8 hwport, u8 *addr);
2697
2698         int (*halmac_get_physical_efuse_size)(struct rtl_priv *rtlpriv,
2699                                               u32 *size);
2700         int (*halmac_read_physical_efuse_map)(struct rtl_priv *rtlpriv,
2701                                               u8 *map, u32 size);
2702         int (*halmac_get_logical_efuse_size)(struct rtl_priv *rtlpriv,
2703                                              u32 *size);
2704         int (*halmac_read_logical_efuse_map)(struct rtl_priv *rtlpriv, u8 *map,
2705                                              u32 size);
2706
2707         int (*halmac_set_bandwidth)(struct rtl_priv *rtlpriv, u8 channel,
2708                                     u8 pri_ch_idx, u8 bw);
2709
2710         int (*halmac_c2h_handle)(struct rtl_priv *rtlpriv, u8 *c2h, u32 size);
2711
2712         int (*halmac_chk_txdesc)(struct rtl_priv *rtlpriv, u8 *txdesc,
2713                                  u32 size);
2714 };
2715
2716 struct rtl_halmac_indicator {
2717         struct completion *comp;
2718         u32 wait_ms;
2719
2720         u8 *buffer;
2721         u32 buf_size;
2722         u32 ret_size;
2723         u32 status;
2724 };
2725
2726 struct rtl_halmac {
2727         struct rtl_halmac_ops *ops; /* halmac ops (halmac.ko own this object) */
2728         void *internal; /* internal context of halmac, i.e. PHALMAC_ADAPTER */
2729         struct rtl_halmac_indicator *indicator; /* size=10 */
2730
2731         /* flags */
2732         /*
2733          * send_general_info
2734          *      0: no need to call halmac_send_general_info()
2735          *      1: need to call halmac_send_general_info()
2736          */
2737         u8 send_general_info;
2738 };
2739
2740 struct rtl_phydm_params {
2741         u8 mp_chip;     /* 1: MP chip, 0: test chip */
2742         u8 fab_ver;     /* 0: TSMC, 1: UMC, ...*/
2743         u8 cut_ver;     /* 0: A, 1: B, ..., 10: K */
2744         u8 efuse0x3d7;  /* default: 0xff */
2745         u8 efuse0x3d8;  /* default: 0xff */
2746 };
2747
2748 struct rtl_phydm_ops {
2749         /* init/deinit priv */
2750         int (*phydm_init_priv)(struct rtl_priv *rtlpriv,
2751                                struct rtl_phydm_params *params);
2752         int (*phydm_deinit_priv)(struct rtl_priv *rtlpriv);
2753         bool (*phydm_load_txpower_by_rate)(struct rtl_priv *rtlpriv);
2754         bool (*phydm_load_txpower_limit)(struct rtl_priv *rtlpriv);
2755
2756         /* init hw */
2757         int  (*phydm_init_dm)(struct rtl_priv *rtlpriv);
2758         int  (*phydm_deinit_dm)(struct rtl_priv *rtlpriv);
2759         int  (*phydm_reset_dm)(struct rtl_priv *rtlpriv);
2760         bool (*phydm_parameter_init)(struct rtl_priv *rtlpriv, bool post);
2761         bool (*phydm_phy_bb_config)(struct rtl_priv *rtlpriv);
2762         bool (*phydm_phy_rf_config)(struct rtl_priv *rtlpriv);
2763         bool (*phydm_phy_mac_config)(struct rtl_priv *rtlpriv);
2764         bool (*phydm_trx_mode)(struct rtl_priv *rtlpriv,
2765                                enum radio_mask tx_path, enum radio_mask rx_path,
2766                                bool is_tx2_path);
2767         /* watchdog */
2768         bool (*phydm_watchdog)(struct rtl_priv *rtlpriv);
2769
2770         /* channel */
2771         bool (*phydm_switch_band)(struct rtl_priv *rtlpriv, u8 central_ch);
2772         bool (*phydm_switch_channel)(struct rtl_priv *rtlpriv, u8 central_ch);
2773         bool (*phydm_switch_bandwidth)(struct rtl_priv *rtlpriv,
2774                                        u8 primary_ch_idx,
2775                                        enum ht_channel_width width);
2776         bool (*phydm_iq_calibrate)(struct rtl_priv *rtlpriv);
2777         bool (*phydm_clear_txpowertracking_state)(struct rtl_priv *rtlpriv);
2778         bool (*phydm_pause_dig)(struct rtl_priv *rtlpriv, bool pause);
2779
2780         /* read/write reg */
2781         u32  (*phydm_read_rf_reg)(struct rtl_priv *rtlpriv,
2782                                   enum radio_path rfpath,
2783                                   u32 addr, u32 mask);
2784         bool (*phydm_write_rf_reg)(struct rtl_priv *rtlpriv,
2785                                    enum radio_path rfpath,
2786                                    u32 addr, u32 mask, u32 data);
2787         u8   (*phydm_read_txagc)(struct rtl_priv *rtlpriv,
2788                                  enum radio_path rfpath, u8 hw_rate);
2789         bool (*phydm_write_txagc)(struct rtl_priv *rtlpriv, u32 power_index,
2790                                   enum radio_path rfpath, u8 hw_rate);
2791
2792         /* RX */
2793         bool (*phydm_c2h_content_parsing)(struct rtl_priv *rtlpriv, u8 cmd_id,
2794                                           u8 cmd_len, u8 *content);
2795         bool (*phydm_query_phy_status)(struct rtl_priv *rtlpriv, u8 *phystrpt,
2796                                        struct ieee80211_hdr *hdr,
2797                                        struct rtl_stats *pstatus);
2798
2799         /* TX */
2800         u8 (*phydm_rate_id_mapping)(struct rtl_priv *rtlpriv,
2801                                     enum wireless_mode wireless_mode,
2802                                     enum rf_type rf_type,
2803                                     enum ht_channel_width bw);
2804         bool (*phydm_get_ra_bitmap)(struct rtl_priv *rtlpriv,
2805                                     enum wireless_mode wireless_mode,
2806                                     enum rf_type rf_type,
2807                                     enum ht_channel_width bw,
2808                                     u8 tx_rate_level, /* 0~6 */
2809                                     u32 *tx_bitmap_msb,
2810                                     u32 *tx_bitmap_lsb);
2811
2812         /* STA */
2813         bool (*phydm_add_sta)(struct rtl_priv *rtlpriv,
2814                               struct ieee80211_sta *sta);
2815         bool (*phydm_del_sta)(struct rtl_priv *rtlpriv,
2816                               struct ieee80211_sta *sta);
2817
2818         /* BTC */
2819         u32  (*phydm_get_version)(struct rtl_priv *rtlpriv);
2820         bool (*phydm_modify_ra_pcr_threshold)(struct rtl_priv *rtlpriv,
2821                                               u8 ra_offset_direction,
2822                                               u8 ra_threshold_offset);
2823         u32  (*phydm_query_counter)(struct rtl_priv *rtlpriv,
2824                                     const char *info_type);
2825
2826         /* debug */
2827         bool (*phydm_debug_cmd)(struct rtl_priv *rtlpriv, char *in, u32 in_len,
2828                                 char *out, u32 out_len);
2829
2830 };
2831
2832 struct rtl_phydm {
2833         struct rtl_phydm_ops *ops;/* phydm ops (phydm_mod.ko own this object) */
2834         void *internal; /* internal context of phydm, i.e. PHY_DM_STRUCT */
2835
2836         u8 adaptivity_en;
2837         /* debug */
2838         u16 forced_data_rate;
2839         u8 forced_igi_lb;
2840         u8 antenna_test;
2841 };
2842
2843 struct proxim {
2844         bool proxim_on;
2845
2846         void *proximity_priv;
2847         int (*proxim_rx)(struct ieee80211_hw *hw, struct rtl_stats *status,
2848                          struct sk_buff *skb);
2849         u8  (*proxim_get_var)(struct ieee80211_hw *hw, u8 type);
2850 };
2851
2852 struct rtl_c2hcmd {
2853         struct list_head list;
2854         u8 tag;
2855         u8 len;
2856         u8 *val;
2857 };
2858
2859 struct rtl_bssid_entry {
2860         struct list_head list;
2861         u8 bssid[ETH_ALEN];
2862         u32 age;
2863 };
2864
2865 struct rtl_scan_list {
2866         int num;
2867         struct list_head list;  /* sort by age */
2868 };
2869
2870 struct rtl_priv {
2871         struct ieee80211_hw *hw;
2872         struct completion firmware_loading_complete;
2873         struct list_head list;
2874         struct rtl_priv *buddy_priv;
2875         struct rtl_global_var *glb_var;
2876         struct rtl_dualmac_easy_concurrent_ctl easy_concurrent_ctl;
2877         struct rtl_dmsp_ctl dmsp_ctl;
2878         struct rtl_locks locks;
2879         struct rtl_works works;
2880         struct rtl_mac mac80211;
2881         struct rtl_hal rtlhal;
2882         struct rtl_regulatory regd;
2883         struct rtl_rfkill rfkill;
2884         struct rtl_io io;
2885         struct rtl_phy phy;
2886         struct rtl_dm dm;
2887         struct rtl_security sec;
2888         struct rtl_efuse efuse;
2889         struct rtl_led_ctl ledctl;
2890         struct rtl_tx_report tx_report;
2891         struct rtl_scan_list scan_list;
2892         struct rtl_ps_ctl psc;
2893         struct rate_adaptive ra;
2894         struct dynamic_primary_cca primarycca;
2895         struct wireless_stats stats;
2896         struct rt_link_detect link_info;
2897         struct false_alarm_statistics falsealm_cnt;
2898         struct rtl_rate_priv *rate_priv;
2899         /* sta entry list for ap adhoc or mesh */
2900         struct list_head entry_list;
2901         /* c2hcmd list for kthread level access */
2902         struct list_head c2hcmd_list;
2903         struct rtl_debug dbg;
2904         int max_fw_size;
2905
2906         /*hal_cfg : for diff cards
2907          *intf_ops : for diff interface usb/pcie
2908          */
2909         struct rtl_hal_cfg *cfg;
2910         const struct rtl_intf_ops *intf_ops;
2911
2912         /* this var will be set by set_bit,
2913          * and was used to indicate status of
2914          * interface or hardware
2915          */
2916         unsigned long status;
2917
2918         /* tables for dm */
2919         struct dig_t dm_digtable;
2920         struct ps_t dm_pstable;
2921
2922         u32 reg_874;
2923         u32 reg_c70;
2924         u32 reg_85c;
2925         u32 reg_a74;
2926         bool reg_init;  /* true if regs saved */
2927         bool bt_operation_on;
2928         __le32 *usb_data;
2929         int usb_data_index;
2930         bool initialized;
2931         bool enter_ps;  /* true when entering PS */
2932         u8 rate_mask[5];
2933
2934         /* intel Proximity, should be alloc mem
2935          * in intel Proximity module and can only
2936          * be used in intel Proximity mode
2937          */
2938         struct proxim proximity;
2939
2940         /*for bt coexist use*/
2941         struct bt_coexist_info btcoexist;
2942
2943         /* halmac for newer IC. (e.g. 8822B) */
2944         struct rtl_halmac halmac;
2945
2946         /* phydm for newer IC. (e.g. 8822B) */
2947         struct rtl_phydm phydm;
2948
2949         /* separate 92ee from other ICs,
2950          * 92ee use new trx flow.
2951          */
2952         bool use_new_trx_flow;
2953
2954 #ifdef CONFIG_PM
2955         struct wiphy_wowlan_support wowlan;
2956 #endif
2957         /* This must be the last item so
2958          * that it points to the data allocated
2959          * beyond  this structure like:
2960          * rtl_pci_priv or rtl_usb_priv
2961          */
2962         u8 priv[0] __aligned(sizeof(void *));
2963 };
2964
2965 #define rtl_priv(hw)            (((struct rtl_priv *)(hw)->priv))
2966 #define rtl_mac(rtlpriv)        (&((rtlpriv)->mac80211))
2967 #define rtl_hal(rtlpriv)        (&((rtlpriv)->rtlhal))
2968 #define rtl_efuse(rtlpriv)      (&((rtlpriv)->efuse))
2969 #define rtl_psc(rtlpriv)        (&((rtlpriv)->psc))
2970
2971 /***************************************
2972  *    Bluetooth Co-existence Related
2973  ***************************************/
2974
2975 enum bt_ant_num {
2976         ANT_X2 = 0,
2977         ANT_X1 = 1,
2978 };
2979
2980 enum bt_co_type {
2981         BT_2WIRE = 0,
2982         BT_ISSC_3WIRE = 1,
2983         BT_ACCEL = 2,
2984         BT_CSR_BC4 = 3,
2985         BT_CSR_BC8 = 4,
2986         BT_RTL8756 = 5,
2987         BT_RTL8723A = 6,
2988         BT_RTL8821A = 7,
2989         BT_RTL8723B = 8,
2990         BT_RTL8192E = 9,
2991         BT_RTL8812A = 11,
2992         BT_RTL8822B = 12,
2993 };
2994
2995 enum bt_total_ant_num {
2996         ANT_TOTAL_X2 = 0,
2997         ANT_TOTAL_X1 = 1
2998 };
2999
3000 enum bt_cur_state {
3001         BT_OFF = 0,
3002         BT_ON = 1,
3003 };
3004
3005 enum bt_service_type {
3006         BT_SCO = 0,
3007         BT_A2DP = 1,
3008         BT_HID = 2,
3009         BT_HID_IDLE = 3,
3010         BT_SCAN = 4,
3011         BT_IDLE = 5,
3012         BT_OTHER_ACTION = 6,
3013         BT_BUSY = 7,
3014         BT_OTHERBUSY = 8,
3015         BT_PAN = 9,
3016 };
3017
3018 enum bt_radio_shared {
3019         BT_RADIO_SHARED = 0,
3020         BT_RADIO_INDIVIDUAL = 1,
3021 };
3022
3023 /****************************************
3024  *      mem access macro define start
3025  *      Call endian free function when
3026  *      1. Read/write packet content.
3027  *      2. Before write integer to IO.
3028  *      3. After read integer from IO.
3029  ***************************************/
3030 /* Convert little data endian to host ordering */
3031 #define EF1BYTE(_val)           \
3032         ((u8)(_val))
3033 #define EF2BYTE(_val)           \
3034         (le16_to_cpu(_val))
3035 #define EF4BYTE(_val)           \
3036         (le32_to_cpu(_val))
3037
3038 /* Read data from memory */
3039 #define READEF1BYTE(_ptr)      \
3040         EF1BYTE(*((u8 *)(_ptr)))
3041 /* Read le16 data from memory and convert to host ordering */
3042 #define READEF2BYTE(_ptr)      \
3043         EF2BYTE(*(_ptr))
3044 #define READEF4BYTE(_ptr)      \
3045         EF4BYTE(*(_ptr))
3046
3047 /* Create a bit mask
3048  * Examples:
3049  * BIT_LEN_MASK_32(0) => 0x00000000
3050  * BIT_LEN_MASK_32(1) => 0x00000001
3051  * BIT_LEN_MASK_32(2) => 0x00000003
3052  * BIT_LEN_MASK_32(32) => 0xFFFFFFFF
3053  */
3054 #define BIT_LEN_MASK_32(__bitlen)        \
3055         (0xFFFFFFFF >> (32 - (__bitlen)))
3056 #define BIT_LEN_MASK_16(__bitlen)        \
3057         (0xFFFF >> (16 - (__bitlen)))
3058 #define BIT_LEN_MASK_8(__bitlen) \
3059         (0xFF >> (8 - (__bitlen)))
3060
3061 /* Create an offset bit mask
3062  * Examples:
3063  * BIT_OFFSET_LEN_MASK_32(0, 2) => 0x00000003
3064  * BIT_OFFSET_LEN_MASK_32(16, 2) => 0x00030000
3065  */
3066 #define BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen) \
3067         (BIT_LEN_MASK_32(__bitlen) << (__bitoffset))
3068 #define BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen) \
3069         (BIT_LEN_MASK_16(__bitlen) << (__bitoffset))
3070 #define BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen) \
3071         (BIT_LEN_MASK_8(__bitlen) << (__bitoffset))
3072
3073 /*Description:
3074  * Return 4-byte value in host byte ordering from
3075  * 4-byte pointer in little-endian system.
3076  */
3077 #define LE_P4BYTE_TO_HOST_4BYTE(__pstart) \
3078         (EF4BYTE(*((__le32 *)(__pstart))))
3079 #define LE_P2BYTE_TO_HOST_2BYTE(__pstart) \
3080         (EF2BYTE(*((__le16 *)(__pstart))))
3081 #define LE_P1BYTE_TO_HOST_1BYTE(__pstart) \
3082         (EF1BYTE(*((u8 *)(__pstart))))
3083
3084 /* Description:
3085  * Translate subfield (continuous bits in little-endian) of 4-byte
3086  * value to host byte ordering.
3087  */
3088 #define LE_BITS_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
3089         ( \
3090                 (LE_P4BYTE_TO_HOST_4BYTE(__pstart) >> (__bitoffset))  & \
3091                 BIT_LEN_MASK_32(__bitlen) \
3092         )
3093 #define LE_BITS_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
3094         ( \
3095                 (LE_P2BYTE_TO_HOST_2BYTE(__pstart) >> (__bitoffset)) & \
3096                 BIT_LEN_MASK_16(__bitlen) \
3097         )
3098 #define LE_BITS_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
3099         ( \
3100                 (LE_P1BYTE_TO_HOST_1BYTE(__pstart) >> (__bitoffset)) & \
3101                 BIT_LEN_MASK_8(__bitlen) \
3102         )
3103
3104 /* Description:
3105  * Mask subfield (continuous bits in little-endian) of 4-byte value
3106  * and return the result in 4-byte value in host byte ordering.
3107  */
3108 #define LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
3109         ( \
3110                 LE_P4BYTE_TO_HOST_4BYTE(__pstart)  & \
3111                 (~BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen)) \
3112         )
3113 #define LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
3114         ( \
3115                 LE_P2BYTE_TO_HOST_2BYTE(__pstart) & \
3116                 (~BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen)) \
3117         )
3118 #define LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
3119         ( \
3120                 LE_P1BYTE_TO_HOST_1BYTE(__pstart) & \
3121                 (~BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen)) \
3122         )
3123
3124 /* Description:
3125  * Set subfield of little-endian 4-byte value to specified value.
3126  */
3127 #define SET_BITS_TO_LE_4BYTE(__pstart, __bitoffset, __bitlen, __val) \
3128         (*((__le32 *)(__pstart)) = \
3129         cpu_to_le32( \
3130                 LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) | \
3131                 ((((u32)__val) & BIT_LEN_MASK_32(__bitlen)) << (__bitoffset)) \
3132         ))
3133 #define SET_BITS_TO_LE_2BYTE(__pstart, __bitoffset, __bitlen, __val) \
3134         (*((__le16 *)(__pstart)) = \
3135         cpu_to_le16( \
3136                 LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) | \
3137                 ((((u16)__val) & BIT_LEN_MASK_16(__bitlen)) << (__bitoffset)) \
3138         ))
3139 #define SET_BITS_TO_LE_1BYTE(__pstart, __bitoffset, __bitlen, __val) \
3140         (*((u8 *)(__pstart)) = EF1BYTE \
3141         ( \
3142                 LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) | \
3143                 ((((u8)__val) & BIT_LEN_MASK_8(__bitlen)) << (__bitoffset)) \
3144         ))
3145
3146 #define N_BYTE_ALIGNMENT(__value, __alignment) ((__alignment == 1) ? \
3147         (__value) : (((__value + __alignment - 1) /                 \
3148          __alignment) * __alignment))
3149
3150 /****************************************
3151  *      mem access macro define end
3152  ****************************************/
3153
3154 #define byte(x, n) ((x >> (8 * n)) & 0xff)
3155
3156 #define packet_get_type(_packet) (EF1BYTE((_packet).octet[0]) & 0xFC)
3157 #define RTL_WATCH_DOG_TIME      2000
3158 #define MSECS(t)                msecs_to_jiffies(t)
3159 #define WLAN_FC_GET_VERS(fc)    (le16_to_cpu(fc) & IEEE80211_FCTL_VERS)
3160 #define WLAN_FC_GET_TYPE(fc)    (le16_to_cpu(fc) & IEEE80211_FCTL_FTYPE)
3161 #define WLAN_FC_GET_STYPE(fc)   (le16_to_cpu(fc) & IEEE80211_FCTL_STYPE)
3162 #define WLAN_FC_MORE_DATA(fc)   (le16_to_cpu(fc) & IEEE80211_FCTL_MOREDATA)
3163 #define rtl_dm(rtlpriv)         (&((rtlpriv)->dm))
3164
3165 #define RT_RF_OFF_LEVL_ASPM             BIT(0)  /*PCI ASPM */
3166 #define RT_RF_OFF_LEVL_CLK_REQ          BIT(1)  /*PCI clock request */
3167 #define RT_RF_OFF_LEVL_PCI_D3           BIT(2)  /*PCI D3 mode */
3168 /*NIC halt, re-initialize hw parameters*/
3169 #define RT_RF_OFF_LEVL_HALT_NIC         BIT(3)
3170 #define RT_RF_OFF_LEVL_FREE_FW          BIT(4)  /*FW free, re-download the FW */
3171 #define RT_RF_OFF_LEVL_FW_32K           BIT(5)  /*FW in 32k */
3172 /*Always enable ASPM and Clock Req in initialization.*/
3173 #define RT_RF_PS_LEVEL_ALWAYS_ASPM      BIT(6)
3174 /* no matter RFOFF or SLEEP we set PS_ASPM_LEVL*/
3175 #define RT_PS_LEVEL_ASPM                BIT(7)
3176 /*When LPS is on, disable 2R if no packet is received or transmitted.*/
3177 #define RT_RF_LPS_DISALBE_2R            BIT(30)
3178 #define RT_RF_LPS_LEVEL_ASPM            BIT(31) /*LPS with ASPM */
3179 #define RT_IN_PS_LEVEL(ppsc, _ps_flg)           \
3180         ((ppsc->cur_ps_level & _ps_flg) ? true : false)
3181 #define RT_CLEAR_PS_LEVEL(ppsc, _ps_flg)        \
3182         (ppsc->cur_ps_level &= (~(_ps_flg)))
3183 #define RT_SET_PS_LEVEL(ppsc, _ps_flg)          \
3184         (ppsc->cur_ps_level |= _ps_flg)
3185
3186 #define container_of_dwork_rtl(x, y, z) \
3187         container_of(to_delayed_work(x), y, z)
3188
3189 #define FILL_OCTET_STRING(_os, _octet, _len)    \
3190                 (_os).octet = (u8 *)(_octet);           \
3191                 (_os).length = (_len)
3192
3193 #define CP_MACADDR(des, src)    \
3194         ((des)[0] = (src)[0], (des)[1] = (src)[1],\
3195         (des)[2] = (src)[2], (des)[3] = (src)[3],\
3196         (des)[4] = (src)[4], (des)[5] = (src)[5])
3197
3198 #define LDPC_HT_ENABLE_RX                       BIT(0)
3199 #define LDPC_HT_ENABLE_TX                       BIT(1)
3200 #define LDPC_HT_TEST_TX_ENABLE                  BIT(2)
3201 #define LDPC_HT_CAP_TX                          BIT(3)
3202
3203 #define STBC_HT_ENABLE_RX                       BIT(0)
3204 #define STBC_HT_ENABLE_TX                       BIT(1)
3205 #define STBC_HT_TEST_TX_ENABLE                  BIT(2)
3206 #define STBC_HT_CAP_TX                          BIT(3)
3207
3208 #define LDPC_VHT_ENABLE_RX                      BIT(0)
3209 #define LDPC_VHT_ENABLE_TX                      BIT(1)
3210 #define LDPC_VHT_TEST_TX_ENABLE                 BIT(2)
3211 #define LDPC_VHT_CAP_TX                         BIT(3)
3212
3213 #define STBC_VHT_ENABLE_RX                      BIT(0)
3214 #define STBC_VHT_ENABLE_TX                      BIT(1)
3215 #define STBC_VHT_TEST_TX_ENABLE                 BIT(2)
3216 #define STBC_VHT_CAP_TX                         BIT(3)
3217
3218 extern u8 channel5g[CHANNEL_MAX_NUMBER_5G];
3219
3220 extern u8 channel5g_80m[CHANNEL_MAX_NUMBER_5G_80M];
3221
3222 static inline u8 rtl_read_byte(struct rtl_priv *rtlpriv, u32 addr)
3223 {
3224         return rtlpriv->io.read8_sync(rtlpriv, addr);
3225 }
3226
3227 static inline u16 rtl_read_word(struct rtl_priv *rtlpriv, u32 addr)
3228 {
3229         return rtlpriv->io.read16_sync(rtlpriv, addr);
3230 }
3231
3232 static inline u32 rtl_read_dword(struct rtl_priv *rtlpriv, u32 addr)
3233 {
3234         return rtlpriv->io.read32_sync(rtlpriv, addr);
3235 }
3236
3237 static inline void rtl_write_byte(struct rtl_priv *rtlpriv, u32 addr, u8 val8)
3238 {
3239         rtlpriv->io.write8_async(rtlpriv, addr, val8);
3240
3241         if (rtlpriv->cfg->write_readback)
3242                 rtlpriv->io.read8_sync(rtlpriv, addr);
3243 }
3244
3245 static inline void rtl_write_byte_with_val32(struct ieee80211_hw *hw,
3246                                              u32 addr, u32 val8)
3247 {
3248         struct rtl_priv *rtlpriv = rtl_priv(hw);
3249
3250         rtl_write_byte(rtlpriv, addr, (u8)val8);
3251 }
3252
3253 static inline void rtl_write_word(struct rtl_priv *rtlpriv, u32 addr, u16 val16)
3254 {
3255         rtlpriv->io.write16_async(rtlpriv, addr, val16);
3256
3257         if (rtlpriv->cfg->write_readback)
3258                 rtlpriv->io.read16_sync(rtlpriv, addr);
3259 }
3260
3261 static inline void rtl_write_dword(struct rtl_priv *rtlpriv,
3262                                    u32 addr, u32 val32)
3263 {
3264         rtlpriv->io.write32_async(rtlpriv, addr, val32);
3265
3266         if (rtlpriv->cfg->write_readback)
3267                 rtlpriv->io.read32_sync(rtlpriv, addr);
3268 }
3269
3270 static inline u32 rtl_get_bbreg(struct ieee80211_hw *hw,
3271                                 u32 regaddr, u32 bitmask)
3272 {
3273         struct rtl_priv *rtlpriv = hw->priv;
3274
3275         return rtlpriv->cfg->ops->get_bbreg(hw, regaddr, bitmask);
3276 }
3277
3278 static inline void rtl_set_bbreg(struct ieee80211_hw *hw, u32 regaddr,
3279                                  u32 bitmask, u32 data)
3280 {
3281         struct rtl_priv *rtlpriv = hw->priv;
3282
3283         rtlpriv->cfg->ops->set_bbreg(hw, regaddr, bitmask, data);
3284 }
3285
3286 static inline void rtl_set_bbreg_with_dwmask(struct ieee80211_hw *hw,
3287                                              u32 regaddr, u32 data)
3288 {
3289         rtl_set_bbreg(hw, regaddr, 0xffffffff, data);
3290 }
3291
3292 static inline u32 rtl_get_rfreg(struct ieee80211_hw *hw,
3293                                 enum radio_path rfpath, u32 regaddr,
3294                                 u32 bitmask)
3295 {
3296         struct rtl_priv *rtlpriv = hw->priv;
3297
3298         return rtlpriv->cfg->ops->get_rfreg(hw, rfpath, regaddr, bitmask);
3299 }
3300
3301 static inline void rtl_set_rfreg(struct ieee80211_hw *hw,
3302                                  enum radio_path rfpath, u32 regaddr,
3303                                  u32 bitmask, u32 data)
3304 {
3305         struct rtl_priv *rtlpriv = hw->priv;
3306
3307         rtlpriv->cfg->ops->set_rfreg(hw, rfpath, regaddr, bitmask, data);
3308 }
3309
3310 static inline bool is_hal_stop(struct rtl_hal *rtlhal)
3311 {
3312         return (rtlhal->state == _HAL_STATE_STOP);
3313 }
3314
3315 static inline void set_hal_start(struct rtl_hal *rtlhal)
3316 {
3317         rtlhal->state = _HAL_STATE_START;
3318 }
3319
3320 static inline void set_hal_stop(struct rtl_hal *rtlhal)
3321 {
3322         rtlhal->state = _HAL_STATE_STOP;
3323 }
3324
3325 static inline u8 get_rf_type(struct rtl_phy *rtlphy)
3326 {
3327         return rtlphy->rf_type;
3328 }
3329
3330 static inline struct ieee80211_hdr *rtl_get_hdr(struct sk_buff *skb)
3331 {
3332         return (struct ieee80211_hdr *)(skb->data);
3333 }
3334
3335 static inline __le16 rtl_get_fc(struct sk_buff *skb)
3336 {
3337         return rtl_get_hdr(skb)->frame_control;
3338 }
3339
3340 static inline u16 rtl_get_tid_h(struct ieee80211_hdr *hdr)
3341 {
3342         return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
3343 }
3344
3345 static inline u16 rtl_get_tid(struct sk_buff *skb)
3346 {
3347         return rtl_get_tid_h(rtl_get_hdr(skb));
3348 }
3349
3350 static inline struct ieee80211_sta *get_sta(struct ieee80211_hw *hw,
3351                                             struct ieee80211_vif *vif,
3352                                             const u8 *bssid)
3353 {
3354         return ieee80211_find_sta(vif, bssid);
3355 }
3356
3357 static inline struct ieee80211_sta *rtl_find_sta(struct ieee80211_hw *hw,
3358                                                  u8 *mac_addr)
3359 {
3360         struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
3361
3362         return ieee80211_find_sta(mac->vif, mac_addr);
3363 }
3364
3365 #endif