drivers/net/wireless/realtek/rtlwifi/wifi.h

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