drivers/net/wireless/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  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called LICENSE.
  20  *
  21  * Contact Information:
  22  * wlanfae <wlanfae@realtek.com>
  23  * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
  24  * Hsinchu 300, Taiwan.
  25  *
  26  * Larry Finger <Larry.Finger@lwfinger.net>
  27  *
  28  *****************************************************************************/
  29
  30 #ifndef __RTL_WIFI_H__
  31 #define __RTL_WIFI_H__
  32
  33 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  34
  35 #include <linux/sched.h>
  36 #include <linux/firmware.h>
  37 #include <linux/etherdevice.h>
  38 #include <linux/vmalloc.h>
  39 #include <linux/usb.h>
  40 #include <net/mac80211.h>
  41 #include <linux/completion.h>
  42 #include "debug.h"
  43
  44 #define RF_CHANGE_BY_INIT                       0
  45 #define RF_CHANGE_BY_IPS                        BIT(28)
  46 #define RF_CHANGE_BY_PS                         BIT(29)
  47 #define RF_CHANGE_BY_HW                         BIT(30)
  48 #define RF_CHANGE_BY_SW                         BIT(31)
  49
  50 #define IQK_ADDA_REG_NUM                        16
  51 #define IQK_MAC_REG_NUM                         4
  52
  53 #define MAX_KEY_LEN                             61
  54 #define KEY_BUF_SIZE                            5
  55
  56 /* QoS related. */
  57 /*aci: 0x00     Best Effort*/
  58 /*aci: 0x01     Background*/
  59 /*aci: 0x10     Video*/
  60 /*aci: 0x11     Voice*/
  61 /*Max: define total number.*/
  62 #define AC0_BE                                  0
  63 #define AC1_BK                                  1
  64 #define AC2_VI                                  2
  65 #define AC3_VO                                  3
  66 #define AC_MAX                                  4
  67 #define QOS_QUEUE_NUM                           4
  68 #define RTL_MAC80211_NUM_QUEUE                  5
  69 #define REALTEK_USB_VENQT_MAX_BUF_SIZE          254
  70 #define RTL_USB_MAX_RX_COUNT                    100
  71 #define QBSS_LOAD_SIZE                          5
  72 #define MAX_WMMELE_LENGTH                       64
  73
  74 #define TOTAL_CAM_ENTRY                         32
  75
  76 /*slot time for 11g. */
  77 #define RTL_SLOT_TIME_9                         9
  78 #define RTL_SLOT_TIME_20                        20
  79
  80 /*related with tcp/ip. */
  81 /*if_ehther.h*/
  82 #define ETH_P_PAE               0x888E  /*Port Access Entity (IEEE 802.1X) */
  83 #define ETH_P_IP                0x0800  /*Internet Protocol packet */
  84 #define ETH_P_ARP               0x0806  /*Address Resolution packet */
  85 #define SNAP_SIZE               6
  86 #define PROTOC_TYPE_SIZE        2
  87
  88 /*related with 802.11 frame*/
  89 #define MAC80211_3ADDR_LEN                      24
  90 #define MAC80211_4ADDR_LEN                      30
  91
  92 #define CHANNEL_MAX_NUMBER      (14 + 24 + 21)  /* 14 is the max channel no */
  93 #define CHANNEL_GROUP_MAX       (3 + 9) /*  ch1~3, 4~9, 10~14 = three groups */
  94 #define MAX_PG_GROUP                    13
  95 #define CHANNEL_GROUP_MAX_2G            3
  96 #define CHANNEL_GROUP_IDX_5GL           3
  97 #define CHANNEL_GROUP_IDX_5GM           6
  98 #define CHANNEL_GROUP_IDX_5GH           9
  99 #define CHANNEL_GROUP_MAX_5G            9
 100 #define CHANNEL_MAX_NUMBER_2G           14
 101 #define AVG_THERMAL_NUM                 8
 102 #define AVG_THERMAL_NUM_88E             4
 103 #define MAX_TID_COUNT                   9
 104
 105 /* for early mode */
 106 #define FCS_LEN                         4
 107 #define EM_HDR_LEN                      8
 108
 109 #define MAX_TX_COUNT                    4
 110 #define MAX_RF_PATH                     4
 111 #define MAX_CHNL_GROUP_24G              6
 112 #define MAX_CHNL_GROUP_5G               14
 113
 114 struct txpower_info_2g {
 115         u8 index_cck_base[MAX_RF_PATH][MAX_CHNL_GROUP_24G];
 116         u8 index_bw40_base[MAX_RF_PATH][MAX_CHNL_GROUP_24G];
 117         /*If only one tx, only BW20 and OFDM are used.*/
 118         u8 cck_diff[MAX_RF_PATH][MAX_TX_COUNT];
 119         u8 ofdm_diff[MAX_RF_PATH][MAX_TX_COUNT];
 120         u8 bw20_diff[MAX_RF_PATH][MAX_TX_COUNT];
 121         u8 bw40_diff[MAX_RF_PATH][MAX_TX_COUNT];
 122 };
 123
 124 struct txpower_info_5g {
 125         u8 index_bw40_base[MAX_RF_PATH][MAX_CHNL_GROUP_5G];
 126         /*If only one tx, only BW20, OFDM, BW80 and BW160 are used.*/
 127         u8 ofdm_diff[MAX_RF_PATH][MAX_TX_COUNT];
 128         u8 bw20_diff[MAX_RF_PATH][MAX_TX_COUNT];
 129         u8 bw40_diff[MAX_RF_PATH][MAX_TX_COUNT];
 130 };
 131
 132 enum intf_type {
 133         INTF_PCI = 0,
 134         INTF_USB = 1,
 135 };
 136
 137 enum radio_path {
 138         RF90_PATH_A = 0,
 139         RF90_PATH_B = 1,
 140         RF90_PATH_C = 2,
 141         RF90_PATH_D = 3,
 142 };
 143
 144 enum rt_eeprom_type {
 145         EEPROM_93C46,
 146         EEPROM_93C56,
 147         EEPROM_BOOT_EFUSE,
 148 };
 149
 150 enum ttl_status {
 151         RTL_STATUS_INTERFACE_START = 0,
 152 };
 153
 154 enum hardware_type {
 155         HARDWARE_TYPE_RTL8192E,
 156         HARDWARE_TYPE_RTL8192U,
 157         HARDWARE_TYPE_RTL8192SE,
 158         HARDWARE_TYPE_RTL8192SU,
 159         HARDWARE_TYPE_RTL8192CE,
 160         HARDWARE_TYPE_RTL8192CU,
 161         HARDWARE_TYPE_RTL8192DE,
 162         HARDWARE_TYPE_RTL8192DU,
 163         HARDWARE_TYPE_RTL8723AE,
 164         HARDWARE_TYPE_RTL8723U,
 165         HARDWARE_TYPE_RTL8188EE,
 166
 167         /* keep it last */
 168         HARDWARE_TYPE_NUM
 169 };
 170
 171 #define IS_HARDWARE_TYPE_8192SU(rtlhal)                 \
 172         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192SU)
 173 #define IS_HARDWARE_TYPE_8192SE(rtlhal)                 \
 174         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192SE)
 175 #define IS_HARDWARE_TYPE_8192CE(rtlhal)                 \
 176         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192CE)
 177 #define IS_HARDWARE_TYPE_8192CU(rtlhal)                 \
 178         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192CU)
 179 #define IS_HARDWARE_TYPE_8192DE(rtlhal)                 \
 180         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192DE)
 181 #define IS_HARDWARE_TYPE_8192DU(rtlhal)                 \
 182         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192DU)
 183 #define IS_HARDWARE_TYPE_8723E(rtlhal)                  \
 184         (rtlhal->hw_type == HARDWARE_TYPE_RTL8723E)
 185 #define IS_HARDWARE_TYPE_8723U(rtlhal)                  \
 186         (rtlhal->hw_type == HARDWARE_TYPE_RTL8723U)
 187 #define IS_HARDWARE_TYPE_8192S(rtlhal)                  \
 188 (IS_HARDWARE_TYPE_8192SE(rtlhal) || IS_HARDWARE_TYPE_8192SU(rtlhal))
 189 #define IS_HARDWARE_TYPE_8192C(rtlhal)                  \
 190 (IS_HARDWARE_TYPE_8192CE(rtlhal) || IS_HARDWARE_TYPE_8192CU(rtlhal))
 191 #define IS_HARDWARE_TYPE_8192D(rtlhal)                  \
 192 (IS_HARDWARE_TYPE_8192DE(rtlhal) || IS_HARDWARE_TYPE_8192DU(rtlhal))
 193 #define IS_HARDWARE_TYPE_8723(rtlhal)                   \
 194 (IS_HARDWARE_TYPE_8723E(rtlhal) || IS_HARDWARE_TYPE_8723U(rtlhal))
 195
 196 #define RX_HAL_IS_CCK_RATE(_pdesc)\
 197         (_pdesc->rxmcs == DESC92_RATE1M ||              \
 198          _pdesc->rxmcs == DESC92_RATE2M ||              \
 199          _pdesc->rxmcs == DESC92_RATE5_5M ||            \
 200          _pdesc->rxmcs == DESC92_RATE11M)
 201
 202 enum scan_operation_backup_opt {
 203         SCAN_OPT_BACKUP = 0,
 204         SCAN_OPT_RESTORE,
 205         SCAN_OPT_MAX
 206 };
 207
 208 /*RF state.*/
 209 enum rf_pwrstate {
 210         ERFON,
 211         ERFSLEEP,
 212         ERFOFF
 213 };
 214
 215 struct bb_reg_def {
 216         u32 rfintfs;
 217         u32 rfintfi;
 218         u32 rfintfo;
 219         u32 rfintfe;
 220         u32 rf3wire_offset;
 221         u32 rflssi_select;
 222         u32 rftxgain_stage;
 223         u32 rfhssi_para1;
 224         u32 rfhssi_para2;
 225         u32 rfsw_ctrl;
 226         u32 rfagc_control1;
 227         u32 rfagc_control2;
 228         u32 rfrxiq_imbal;
 229         u32 rfrx_afe;
 230         u32 rftxiq_imbal;
 231         u32 rftx_afe;
 232         u32 rf_rb;              /* rflssi_readback */
 233         u32 rf_rbpi;            /* rflssi_readbackpi */
 234 };
 235
 236 enum io_type {
 237         IO_CMD_PAUSE_DM_BY_SCAN = 0,
 238         IO_CMD_RESUME_DM_BY_SCAN = 1,
 239 };
 240
 241 enum hw_variables {
 242         HW_VAR_ETHER_ADDR,
 243         HW_VAR_MULTICAST_REG,
 244         HW_VAR_BASIC_RATE,
 245         HW_VAR_BSSID,
 246         HW_VAR_MEDIA_STATUS,
 247         HW_VAR_SECURITY_CONF,
 248         HW_VAR_BEACON_INTERVAL,
 249         HW_VAR_ATIM_WINDOW,
 250         HW_VAR_LISTEN_INTERVAL,
 251         HW_VAR_CS_COUNTER,
 252         HW_VAR_DEFAULTKEY0,
 253         HW_VAR_DEFAULTKEY1,
 254         HW_VAR_DEFAULTKEY2,
 255         HW_VAR_DEFAULTKEY3,
 256         HW_VAR_SIFS,
 257         HW_VAR_DIFS,
 258         HW_VAR_EIFS,
 259         HW_VAR_SLOT_TIME,
 260         HW_VAR_ACK_PREAMBLE,
 261         HW_VAR_CW_CONFIG,
 262         HW_VAR_CW_VALUES,
 263         HW_VAR_RATE_FALLBACK_CONTROL,
 264         HW_VAR_CONTENTION_WINDOW,
 265         HW_VAR_RETRY_COUNT,
 266         HW_VAR_TR_SWITCH,
 267         HW_VAR_COMMAND,
 268         HW_VAR_WPA_CONFIG,
 269         HW_VAR_AMPDU_MIN_SPACE,
 270         HW_VAR_SHORTGI_DENSITY,
 271         HW_VAR_AMPDU_FACTOR,
 272         HW_VAR_MCS_RATE_AVAILABLE,
 273         HW_VAR_AC_PARAM,
 274         HW_VAR_ACM_CTRL,
 275         HW_VAR_DIS_Req_Qsize,
 276         HW_VAR_CCX_CHNL_LOAD,
 277         HW_VAR_CCX_NOISE_HISTOGRAM,
 278         HW_VAR_CCX_CLM_NHM,
 279         HW_VAR_TxOPLimit,
 280         HW_VAR_TURBO_MODE,
 281         HW_VAR_RF_STATE,
 282         HW_VAR_RF_OFF_BY_HW,
 283         HW_VAR_BUS_SPEED,
 284         HW_VAR_SET_DEV_POWER,
 285
 286         HW_VAR_RCR,
 287         HW_VAR_RATR_0,
 288         HW_VAR_RRSR,
 289         HW_VAR_CPU_RST,
 290         HW_VAR_CHECK_BSSID,
 291         HW_VAR_LBK_MODE,
 292         HW_VAR_AES_11N_FIX,
 293         HW_VAR_USB_RX_AGGR,
 294         HW_VAR_USER_CONTROL_TURBO_MODE,
 295         HW_VAR_RETRY_LIMIT,
 296         HW_VAR_INIT_TX_RATE,
 297         HW_VAR_TX_RATE_REG,
 298         HW_VAR_EFUSE_USAGE,
 299         HW_VAR_EFUSE_BYTES,
 300         HW_VAR_AUTOLOAD_STATUS,
 301         HW_VAR_RF_2R_DISABLE,
 302         HW_VAR_SET_RPWM,
 303         HW_VAR_H2C_FW_PWRMODE,
 304         HW_VAR_H2C_FW_JOINBSSRPT,
 305         HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
 306         HW_VAR_FW_PSMODE_STATUS,
 307         HW_VAR_RESUME_CLK_ON,
 308         HW_VAR_FW_LPS_ACTION,
 309         HW_VAR_1X1_RECV_COMBINE,
 310         HW_VAR_STOP_SEND_BEACON,
 311         HW_VAR_TSF_TIMER,
 312         HW_VAR_IO_CMD,
 313
 314         HW_VAR_RF_RECOVERY,
 315         HW_VAR_H2C_FW_UPDATE_GTK,
 316         HW_VAR_WF_MASK,
 317         HW_VAR_WF_CRC,
 318         HW_VAR_WF_IS_MAC_ADDR,
 319         HW_VAR_H2C_FW_OFFLOAD,
 320         HW_VAR_RESET_WFCRC,
 321
 322         HW_VAR_HANDLE_FW_C2H,
 323         HW_VAR_DL_FW_RSVD_PAGE,
 324         HW_VAR_AID,
 325         HW_VAR_HW_SEQ_ENABLE,
 326         HW_VAR_CORRECT_TSF,
 327         HW_VAR_BCN_VALID,
 328         HW_VAR_FWLPS_RF_ON,
 329         HW_VAR_DUAL_TSF_RST,
 330         HW_VAR_SWITCH_EPHY_WoWLAN,
 331         HW_VAR_INT_MIGRATION,
 332         HW_VAR_INT_AC,
 333         HW_VAR_RF_TIMING,
 334
 335         HAL_DEF_WOWLAN,
 336         HW_VAR_MRC,
 337
 338         HW_VAR_MGT_FILTER,
 339         HW_VAR_CTRL_FILTER,
 340         HW_VAR_DATA_FILTER,
 341 };
 342
 343 enum _RT_MEDIA_STATUS {
 344         RT_MEDIA_DISCONNECT = 0,
 345         RT_MEDIA_CONNECT = 1
 346 };
 347
 348 enum rt_oem_id {
 349         RT_CID_DEFAULT = 0,
 350         RT_CID_8187_ALPHA0 = 1,
 351         RT_CID_8187_SERCOMM_PS = 2,
 352         RT_CID_8187_HW_LED = 3,
 353         RT_CID_8187_NETGEAR = 4,
 354         RT_CID_WHQL = 5,
 355         RT_CID_819x_CAMEO = 6,
 356         RT_CID_819x_RUNTOP = 7,
 357         RT_CID_819x_Senao = 8,
 358         RT_CID_TOSHIBA = 9,
 359         RT_CID_819x_Netcore = 10,
 360         RT_CID_Nettronix = 11,
 361         RT_CID_DLINK = 12,
 362         RT_CID_PRONET = 13,
 363         RT_CID_COREGA = 14,
 364         RT_CID_819x_ALPHA = 15,
 365         RT_CID_819x_Sitecom = 16,
 366         RT_CID_CCX = 17,
 367         RT_CID_819x_Lenovo = 18,
 368         RT_CID_819x_QMI = 19,
 369         RT_CID_819x_Edimax_Belkin = 20,
 370         RT_CID_819x_Sercomm_Belkin = 21,
 371         RT_CID_819x_CAMEO1 = 22,
 372         RT_CID_819x_MSI = 23,
 373         RT_CID_819x_Acer = 24,
 374         RT_CID_819x_HP = 27,
 375         RT_CID_819x_CLEVO = 28,
 376         RT_CID_819x_Arcadyan_Belkin = 29,
 377         RT_CID_819x_SAMSUNG = 30,
 378         RT_CID_819x_WNC_COREGA = 31,
 379         RT_CID_819x_Foxcoon = 32,
 380         RT_CID_819x_DELL = 33,
 381         RT_CID_819x_PRONETS = 34,
 382         RT_CID_819x_Edimax_ASUS = 35,
 383         RT_CID_NETGEAR = 36,
 384         RT_CID_PLANEX = 37,
 385         RT_CID_CC_C = 38,
 386 };
 387
 388 enum hw_descs {
 389         HW_DESC_OWN,
 390         HW_DESC_RXOWN,
 391         HW_DESC_TX_NEXTDESC_ADDR,
 392         HW_DESC_TXBUFF_ADDR,
 393         HW_DESC_RXBUFF_ADDR,
 394         HW_DESC_RXPKT_LEN,
 395         HW_DESC_RXERO,
 396 };
 397
 398 enum prime_sc {
 399         PRIME_CHNL_OFFSET_DONT_CARE = 0,
 400         PRIME_CHNL_OFFSET_LOWER = 1,
 401         PRIME_CHNL_OFFSET_UPPER = 2,
 402 };
 403
 404 enum rf_type {
 405         RF_1T1R = 0,
 406         RF_1T2R = 1,
 407         RF_2T2R = 2,
 408         RF_2T2R_GREEN = 3,
 409 };
 410
 411 enum ht_channel_width {
 412         HT_CHANNEL_WIDTH_20 = 0,
 413         HT_CHANNEL_WIDTH_20_40 = 1,
 414 };
 415
 416 /* Ref: 802.11i sepc D10.0 7.3.2.25.1
 417 Cipher Suites Encryption Algorithms */
 418 enum rt_enc_alg {
 419         NO_ENCRYPTION = 0,
 420         WEP40_ENCRYPTION = 1,
 421         TKIP_ENCRYPTION = 2,
 422         RSERVED_ENCRYPTION = 3,
 423         AESCCMP_ENCRYPTION = 4,
 424         WEP104_ENCRYPTION = 5,
 425         AESCMAC_ENCRYPTION = 6, /*IEEE802.11w */
 426 };
 427
 428 enum rtl_hal_state {
 429         _HAL_STATE_STOP = 0,
 430         _HAL_STATE_START = 1,
 431 };
 432
 433 enum rtl_desc92_rate {
 434         DESC92_RATE1M = 0x00,
 435         DESC92_RATE2M = 0x01,
 436         DESC92_RATE5_5M = 0x02,
 437         DESC92_RATE11M = 0x03,
 438
 439         DESC92_RATE6M = 0x04,
 440         DESC92_RATE9M = 0x05,
 441         DESC92_RATE12M = 0x06,
 442         DESC92_RATE18M = 0x07,
 443         DESC92_RATE24M = 0x08,
 444         DESC92_RATE36M = 0x09,
 445         DESC92_RATE48M = 0x0a,
 446         DESC92_RATE54M = 0x0b,
 447
 448         DESC92_RATEMCS0 = 0x0c,
 449         DESC92_RATEMCS1 = 0x0d,
 450         DESC92_RATEMCS2 = 0x0e,
 451         DESC92_RATEMCS3 = 0x0f,
 452         DESC92_RATEMCS4 = 0x10,
 453         DESC92_RATEMCS5 = 0x11,
 454         DESC92_RATEMCS6 = 0x12,
 455         DESC92_RATEMCS7 = 0x13,
 456         DESC92_RATEMCS8 = 0x14,
 457         DESC92_RATEMCS9 = 0x15,
 458         DESC92_RATEMCS10 = 0x16,
 459         DESC92_RATEMCS11 = 0x17,
 460         DESC92_RATEMCS12 = 0x18,
 461         DESC92_RATEMCS13 = 0x19,
 462         DESC92_RATEMCS14 = 0x1a,
 463         DESC92_RATEMCS15 = 0x1b,
 464         DESC92_RATEMCS15_SG = 0x1c,
 465         DESC92_RATEMCS32 = 0x20,
 466 };
 467
 468 enum rtl_var_map {
 469         /*reg map */
 470         SYS_ISO_CTRL = 0,
 471         SYS_FUNC_EN,
 472         SYS_CLK,
 473         MAC_RCR_AM,
 474         MAC_RCR_AB,
 475         MAC_RCR_ACRC32,
 476         MAC_RCR_ACF,
 477         MAC_RCR_AAP,
 478
 479         /*efuse map */
 480         EFUSE_TEST,
 481         EFUSE_CTRL,
 482         EFUSE_CLK,
 483         EFUSE_CLK_CTRL,
 484         EFUSE_PWC_EV12V,
 485         EFUSE_FEN_ELDR,
 486         EFUSE_LOADER_CLK_EN,
 487         EFUSE_ANA8M,
 488         EFUSE_HWSET_MAX_SIZE,
 489         EFUSE_MAX_SECTION_MAP,
 490         EFUSE_REAL_CONTENT_SIZE,
 491         EFUSE_OOB_PROTECT_BYTES_LEN,
 492         EFUSE_ACCESS,
 493
 494         /*CAM map */
 495         RWCAM,
 496         WCAMI,
 497         RCAMO,
 498         CAMDBG,
 499         SECR,
 500         SEC_CAM_NONE,
 501         SEC_CAM_WEP40,
 502         SEC_CAM_TKIP,
 503         SEC_CAM_AES,
 504         SEC_CAM_WEP104,
 505
 506         /*IMR map */
 507         RTL_IMR_BCNDMAINT6,     /*Beacon DMA Interrupt 6 */
 508         RTL_IMR_BCNDMAINT5,     /*Beacon DMA Interrupt 5 */
 509         RTL_IMR_BCNDMAINT4,     /*Beacon DMA Interrupt 4 */
 510         RTL_IMR_BCNDMAINT3,     /*Beacon DMA Interrupt 3 */
 511         RTL_IMR_BCNDMAINT2,     /*Beacon DMA Interrupt 2 */
 512         RTL_IMR_BCNDMAINT1,     /*Beacon DMA Interrupt 1 */
 513         RTL_IMR_BCNDOK8,        /*Beacon Queue DMA OK Interrup 8 */
 514         RTL_IMR_BCNDOK7,        /*Beacon Queue DMA OK Interrup 7 */
 515         RTL_IMR_BCNDOK6,        /*Beacon Queue DMA OK Interrup 6 */
 516         RTL_IMR_BCNDOK5,        /*Beacon Queue DMA OK Interrup 5 */
 517         RTL_IMR_BCNDOK4,        /*Beacon Queue DMA OK Interrup 4 */
 518         RTL_IMR_BCNDOK3,        /*Beacon Queue DMA OK Interrup 3 */
 519         RTL_IMR_BCNDOK2,        /*Beacon Queue DMA OK Interrup 2 */
 520         RTL_IMR_BCNDOK1,        /*Beacon Queue DMA OK Interrup 1 */
 521         RTL_IMR_TIMEOUT2,       /*Timeout interrupt 2 */
 522         RTL_IMR_TIMEOUT1,       /*Timeout interrupt 1 */
 523         RTL_IMR_TXFOVW,         /*Transmit FIFO Overflow */
 524         RTL_IMR_PSTIMEOUT,      /*Power save time out interrupt */
 525         RTL_IMR_BCNINT,         /*Beacon DMA Interrupt 0 */
 526         RTL_IMR_RXFOVW,         /*Receive FIFO Overflow */
 527         RTL_IMR_RDU,            /*Receive Descriptor Unavailable */
 528         RTL_IMR_ATIMEND,        /*For 92C,ATIM Window End Interrupt */
 529         RTL_IMR_BDOK,           /*Beacon Queue DMA OK Interrup */
 530         RTL_IMR_HIGHDOK,        /*High Queue DMA OK Interrupt */
 531         RTL_IMR_COMDOK,         /*Command Queue DMA OK Interrupt*/
 532         RTL_IMR_TBDOK,          /*Transmit Beacon OK interrup */
 533         RTL_IMR_MGNTDOK,        /*Management Queue DMA OK Interrupt */
 534         RTL_IMR_TBDER,          /*For 92C,Transmit Beacon Error Interrupt */
 535         RTL_IMR_BKDOK,          /*AC_BK DMA OK Interrupt */
 536         RTL_IMR_BEDOK,          /*AC_BE DMA OK Interrupt */
 537         RTL_IMR_VIDOK,          /*AC_VI DMA OK Interrupt */
 538         RTL_IMR_VODOK,          /*AC_VO DMA Interrupt */
 539         RTL_IMR_ROK,            /*Receive DMA OK Interrupt */
 540         RTL_IBSS_INT_MASKS,     /*(RTL_IMR_BCNINT | RTL_IMR_TBDOK |
 541                                  * RTL_IMR_TBDER) */
 542         RTL_IMR_C2HCMD,         /*fw interrupt*/
 543
 544         /*CCK Rates, TxHT = 0 */
 545         RTL_RC_CCK_RATE1M,
 546         RTL_RC_CCK_RATE2M,
 547         RTL_RC_CCK_RATE5_5M,
 548         RTL_RC_CCK_RATE11M,
 549
 550         /*OFDM Rates, TxHT = 0 */
 551         RTL_RC_OFDM_RATE6M,
 552         RTL_RC_OFDM_RATE9M,
 553         RTL_RC_OFDM_RATE12M,
 554         RTL_RC_OFDM_RATE18M,
 555         RTL_RC_OFDM_RATE24M,
 556         RTL_RC_OFDM_RATE36M,
 557         RTL_RC_OFDM_RATE48M,
 558         RTL_RC_OFDM_RATE54M,
 559
 560         RTL_RC_HT_RATEMCS7,
 561         RTL_RC_HT_RATEMCS15,
 562
 563         /*keep it last */
 564         RTL_VAR_MAP_MAX,
 565 };
 566
 567 /*Firmware PS mode for control LPS.*/
 568 enum _fw_ps_mode {
 569         FW_PS_ACTIVE_MODE = 0,
 570         FW_PS_MIN_MODE = 1,
 571         FW_PS_MAX_MODE = 2,
 572         FW_PS_DTIM_MODE = 3,
 573         FW_PS_VOIP_MODE = 4,
 574         FW_PS_UAPSD_WMM_MODE = 5,
 575         FW_PS_UAPSD_MODE = 6,
 576         FW_PS_IBSS_MODE = 7,
 577         FW_PS_WWLAN_MODE = 8,
 578         FW_PS_PM_Radio_Off = 9,
 579         FW_PS_PM_Card_Disable = 10,
 580 };
 581
 582 enum rt_psmode {
 583         EACTIVE,                /*Active/Continuous access. */
 584         EMAXPS,                 /*Max power save mode. */
 585         EFASTPS,                /*Fast power save mode. */
 586         EAUTOPS,                /*Auto power save mode. */
 587 };
 588
 589 /*LED related.*/
 590 enum led_ctl_mode {
 591         LED_CTL_POWER_ON = 1,
 592         LED_CTL_LINK = 2,
 593         LED_CTL_NO_LINK = 3,
 594         LED_CTL_TX = 4,
 595         LED_CTL_RX = 5,
 596         LED_CTL_SITE_SURVEY = 6,
 597         LED_CTL_POWER_OFF = 7,
 598         LED_CTL_START_TO_LINK = 8,
 599         LED_CTL_START_WPS = 9,
 600         LED_CTL_STOP_WPS = 10,
 601 };
 602
 603 enum rtl_led_pin {
 604         LED_PIN_GPIO0,
 605         LED_PIN_LED0,
 606         LED_PIN_LED1,
 607         LED_PIN_LED2
 608 };
 609
 610 /*QoS related.*/
 611 /*acm implementation method.*/
 612 enum acm_method {
 613         eAcmWay0_SwAndHw = 0,
 614         eAcmWay1_HW = 1,
 615         eAcmWay2_SW = 2,
 616 };
 617
 618 enum macphy_mode {
 619         SINGLEMAC_SINGLEPHY = 0,
 620         DUALMAC_DUALPHY,
 621         DUALMAC_SINGLEPHY,
 622 };
 623
 624 enum band_type {
 625         BAND_ON_2_4G = 0,
 626         BAND_ON_5G,
 627         BAND_ON_BOTH,
 628         BANDMAX
 629 };
 630
 631 /*aci/aifsn Field.
 632 Ref: WMM spec 2.2.2: WME Parameter Element, p.12.*/
 633 union aci_aifsn {
 634         u8 char_data;
 635
 636         struct {
 637                 u8 aifsn:4;
 638                 u8 acm:1;
 639                 u8 aci:2;
 640                 u8 reserved:1;
 641         } f;                    /* Field */
 642 };
 643
 644 /*mlme related.*/
 645 enum wireless_mode {
 646         WIRELESS_MODE_UNKNOWN = 0x00,
 647         WIRELESS_MODE_A = 0x01,
 648         WIRELESS_MODE_B = 0x02,
 649         WIRELESS_MODE_G = 0x04,
 650         WIRELESS_MODE_AUTO = 0x08,
 651         WIRELESS_MODE_N_24G = 0x10,
 652         WIRELESS_MODE_N_5G = 0x20
 653 };
 654
 655 #define IS_WIRELESS_MODE_A(wirelessmode)        \
 656         (wirelessmode == WIRELESS_MODE_A)
 657 #define IS_WIRELESS_MODE_B(wirelessmode)        \
 658         (wirelessmode == WIRELESS_MODE_B)
 659 #define IS_WIRELESS_MODE_G(wirelessmode)        \
 660         (wirelessmode == WIRELESS_MODE_G)
 661 #define IS_WIRELESS_MODE_N_24G(wirelessmode)    \
 662         (wirelessmode == WIRELESS_MODE_N_24G)
 663 #define IS_WIRELESS_MODE_N_5G(wirelessmode)     \
 664         (wirelessmode == WIRELESS_MODE_N_5G)
 665
 666 enum ratr_table_mode {
 667         RATR_INX_WIRELESS_NGB = 0,
 668         RATR_INX_WIRELESS_NG = 1,
 669         RATR_INX_WIRELESS_NB = 2,
 670         RATR_INX_WIRELESS_N = 3,
 671         RATR_INX_WIRELESS_GB = 4,
 672         RATR_INX_WIRELESS_G = 5,
 673         RATR_INX_WIRELESS_B = 6,
 674         RATR_INX_WIRELESS_MC = 7,
 675         RATR_INX_WIRELESS_A = 8,
 676 };
 677
 678 enum rtl_link_state {
 679         MAC80211_NOLINK = 0,
 680         MAC80211_LINKING = 1,
 681         MAC80211_LINKED = 2,
 682         MAC80211_LINKED_SCANNING = 3,
 683 };
 684
 685 enum act_category {
 686         ACT_CAT_QOS = 1,
 687         ACT_CAT_DLS = 2,
 688         ACT_CAT_BA = 3,
 689         ACT_CAT_HT = 7,
 690         ACT_CAT_WMM = 17,
 691 };
 692
 693 enum ba_action {
 694         ACT_ADDBAREQ = 0,
 695         ACT_ADDBARSP = 1,
 696         ACT_DELBA = 2,
 697 };
 698
 699 enum rt_polarity_ctl {
 700         RT_POLARITY_LOW_ACT = 0,
 701         RT_POLARITY_HIGH_ACT = 1,
 702 };
 703
 704 struct octet_string {
 705         u8 *octet;
 706         u16 length;
 707 };
 708
 709 struct rtl_hdr_3addr {
 710         __le16 frame_ctl;
 711         __le16 duration_id;
 712         u8 addr1[ETH_ALEN];
 713         u8 addr2[ETH_ALEN];
 714         u8 addr3[ETH_ALEN];
 715         __le16 seq_ctl;
 716         u8 payload[0];
 717 } __packed;
 718
 719 struct rtl_info_element {
 720         u8 id;
 721         u8 len;
 722         u8 data[0];
 723 } __packed;
 724
 725 struct rtl_probe_rsp {
 726         struct rtl_hdr_3addr header;
 727         u32 time_stamp[2];
 728         __le16 beacon_interval;
 729         __le16 capability;
 730         /*SSID, supported rates, FH params, DS params,
 731            CF params, IBSS params, TIM (if beacon), RSN */
 732         struct rtl_info_element info_element[0];
 733 } __packed;
 734
 735 /*LED related.*/
 736 /*ledpin Identify how to implement this SW led.*/
 737 struct rtl_led {
 738         void *hw;
 739         enum rtl_led_pin ledpin;
 740         bool ledon;
 741 };
 742
 743 struct rtl_led_ctl {
 744         bool led_opendrain;
 745         struct rtl_led sw_led0;
 746         struct rtl_led sw_led1;
 747 };
 748
 749 struct rtl_qos_parameters {
 750         __le16 cw_min;
 751         __le16 cw_max;
 752         u8 aifs;
 753         u8 flag;
 754         __le16 tx_op;
 755 } __packed;
 756
 757 struct rt_smooth_data {
 758         u32 elements[100];      /*array to store values */
 759         u32 index;              /*index to current array to store */
 760         u32 total_num;          /*num of valid elements */
 761         u32 total_val;          /*sum of valid elements */
 762 };
 763
 764 struct false_alarm_statistics {
 765         u32 cnt_parity_fail;
 766         u32 cnt_rate_illegal;
 767         u32 cnt_crc8_fail;
 768         u32 cnt_mcs_fail;
 769         u32 cnt_fast_fsync_fail;
 770         u32 cnt_sb_search_fail;
 771         u32 cnt_ofdm_fail;
 772         u32 cnt_cck_fail;
 773         u32 cnt_all;
 774         u32 cnt_ofdm_cca;
 775         u32 cnt_cck_cca;
 776         u32 cnt_cca_all;
 777         u32 cnt_bw_usc;
 778         u32 cnt_bw_lsc;
 779 };
 780
 781 struct init_gain {
 782         u8 xaagccore1;
 783         u8 xbagccore1;
 784         u8 xcagccore1;
 785         u8 xdagccore1;
 786         u8 cca;
 787
 788 };
 789
 790 struct wireless_stats {
 791         unsigned long txbytesunicast;
 792         unsigned long txbytesmulticast;
 793         unsigned long txbytesbroadcast;
 794         unsigned long rxbytesunicast;
 795
 796         long rx_snr_db[4];
 797         /*Correct smoothed ss in Dbm, only used
 798            in driver to report real power now. */
 799         long recv_signal_power;
 800         long signal_quality;
 801         long last_sigstrength_inpercent;
 802
 803         u32 rssi_calculate_cnt;
 804
 805         /*Transformed, in dbm. Beautified signal
 806            strength for UI, not correct. */
 807         long signal_strength;
 808
 809         u8 rx_rssi_percentage[4];
 810         u8 rx_evm_percentage[2];
 811
 812         struct rt_smooth_data ui_rssi;
 813         struct rt_smooth_data ui_link_quality;
 814 };
 815
 816 struct rate_adaptive {
 817         u8 rate_adaptive_disabled;
 818         u8 ratr_state;
 819         u16 reserve;
 820
 821         u32 high_rssi_thresh_for_ra;
 822         u32 high2low_rssi_thresh_for_ra;
 823         u8 low2high_rssi_thresh_for_ra40m;
 824         u32 low_rssi_thresh_for_ra40M;
 825         u8 low2high_rssi_thresh_for_ra20m;
 826         u32 low_rssi_thresh_for_ra20M;
 827         u32 upper_rssi_threshold_ratr;
 828         u32 middleupper_rssi_threshold_ratr;
 829         u32 middle_rssi_threshold_ratr;
 830         u32 middlelow_rssi_threshold_ratr;
 831         u32 low_rssi_threshold_ratr;
 832         u32 ultralow_rssi_threshold_ratr;
 833         u32 low_rssi_threshold_ratr_40m;
 834         u32 low_rssi_threshold_ratr_20m;
 835         u8 ping_rssi_enable;
 836         u32 ping_rssi_ratr;
 837         u32 ping_rssi_thresh_for_ra;
 838         u32 last_ratr;
 839         u8 pre_ratr_state;
 840 };
 841
 842 struct regd_pair_mapping {
 843         u16 reg_dmnenum;
 844         u16 reg_5ghz_ctl;
 845         u16 reg_2ghz_ctl;
 846 };
 847
 848 struct rtl_regulatory {
 849         char alpha2[2];
 850         u16 country_code;
 851         u16 max_power_level;
 852         u32 tp_scale;
 853         u16 current_rd;
 854         u16 current_rd_ext;
 855         int16_t power_limit;
 856         struct regd_pair_mapping *regpair;
 857 };
 858
 859 struct rtl_rfkill {
 860         bool rfkill_state;      /*0 is off, 1 is on */
 861 };
 862
 863 /*for P2P PS**/
 864 #define P2P_MAX_NOA_NUM         2
 865
 866 enum p2p_role {
 867         P2P_ROLE_DISABLE = 0,
 868         P2P_ROLE_DEVICE = 1,
 869         P2P_ROLE_CLIENT = 2,
 870         P2P_ROLE_GO = 3
 871 };
 872
 873 enum p2p_ps_state {
 874         P2P_PS_DISABLE = 0,
 875         P2P_PS_ENABLE = 1,
 876         P2P_PS_SCAN = 2,
 877         P2P_PS_SCAN_DONE = 3,
 878         P2P_PS_ALLSTASLEEP = 4, /* for P2P GO */
 879 };
 880
 881 enum p2p_ps_mode {
 882         P2P_PS_NONE = 0,
 883         P2P_PS_CTWINDOW = 1,
 884         P2P_PS_NOA       = 2,
 885         P2P_PS_MIX = 3, /* CTWindow and NoA */
 886 };
 887
 888 struct rtl_p2p_ps_info {
 889         enum p2p_ps_mode p2p_ps_mode; /* indicate p2p ps mode */
 890         enum p2p_ps_state p2p_ps_state; /*  indicate p2p ps state */
 891         u8 noa_index; /*  Identifies instance of Notice of Absence timing. */
 892         /*  Client traffic window. A period of time in TU after TBTT. */
 893         u8 ctwindow;
 894         u8 opp_ps; /*  opportunistic power save. */
 895         u8 noa_num; /*  number of NoA descriptor in P2P IE. */
 896         /*  Count for owner, Type of client. */
 897         u8 noa_count_type[P2P_MAX_NOA_NUM];
 898         /*  Max duration for owner, preferred or min acceptable duration
 899          * for client.
 900          */
 901         u32 noa_duration[P2P_MAX_NOA_NUM];
 902         /*  Length of interval for owner, preferred or max acceptable intervali
 903          * of client.
 904          */
 905         u32 noa_interval[P2P_MAX_NOA_NUM];
 906         /*  schedule in terms of the lower 4 bytes of the TSF timer. */
 907         u32 noa_start_time[P2P_MAX_NOA_NUM];
 908 };
 909
 910 struct p2p_ps_offload_t {
 911         u8 offload_en:1;
 912         u8 role:1; /* 1: Owner, 0: Client */
 913         u8 ctwindow_en:1;
 914         u8 noa0_en:1;
 915         u8 noa1_en:1;
 916         u8 allstasleep:1;
 917         u8 discovery:1;
 918         u8 reserved:1;
 919 };
 920
 921 #define IQK_MATRIX_REG_NUM      8
 922 #define IQK_MATRIX_SETTINGS_NUM (1 + 24 + 21)
 923
 924 struct iqk_matrix_regs {
 925         bool iqk_done;
 926         long value[1][IQK_MATRIX_REG_NUM];
 927 };
 928
 929 struct phy_parameters {
 930         u16 length;
 931         u32 *pdata;
 932 };
 933
 934 enum hw_param_tab_index {
 935         PHY_REG_2T,
 936         PHY_REG_1T,
 937         PHY_REG_PG,
 938         RADIOA_2T,
 939         RADIOB_2T,
 940         RADIOA_1T,
 941         RADIOB_1T,
 942         MAC_REG,
 943         AGCTAB_2T,
 944         AGCTAB_1T,
 945         MAX_TAB
 946 };
 947
 948 struct rtl_phy {
 949         struct bb_reg_def phyreg_def[4];        /*Radio A/B/C/D */
 950         struct init_gain initgain_backup;
 951         enum io_type current_io_type;
 952
 953         u8 rf_mode;
 954         u8 rf_type;
 955         u8 current_chan_bw;
 956         u8 set_bwmode_inprogress;
 957         u8 sw_chnl_inprogress;
 958         u8 sw_chnl_stage;
 959         u8 sw_chnl_step;
 960         u8 current_channel;
 961         u8 h2c_box_num;
 962         u8 set_io_inprogress;
 963         u8 lck_inprogress;
 964
 965         /* record for power tracking */
 966         s32 reg_e94;
 967         s32 reg_e9c;
 968         s32 reg_ea4;
 969         s32 reg_eac;
 970         s32 reg_eb4;
 971         s32 reg_ebc;
 972         s32 reg_ec4;
 973         s32 reg_ecc;
 974         u8 rfpienable;
 975         u8 reserve_0;
 976         u16 reserve_1;
 977         u32 reg_c04, reg_c08, reg_874;
 978         u32 adda_backup[16];
 979         u32 iqk_mac_backup[IQK_MAC_REG_NUM];
 980         u32 iqk_bb_backup[10];
 981         bool iqk_initialized;
 982
 983         /* Dual mac */
 984         bool need_iqk;
 985         struct iqk_matrix_regs iqk_matrix[IQK_MATRIX_SETTINGS_NUM];
 986
 987         bool rfpi_enable;
 988
 989         u8 pwrgroup_cnt;
 990         u8 cck_high_power;
 991         /* MAX_PG_GROUP groups of pwr diff by rates */
 992         u32 mcs_offset[MAX_PG_GROUP][16];
 993         u8 default_initialgain[4];
 994
 995         /* the current Tx power level */
 996         u8 cur_cck_txpwridx;
 997         u8 cur_ofdm24g_txpwridx;
 998         u8 cur_bw20_txpwridx;
 999         u8 cur_bw40_txpwridx;
1000
1001         u32 rfreg_chnlval[2];
1002         bool apk_done;
1003         u32 reg_rf3c[2];        /* pathA / pathB  */
1004
1005         /* bfsync */
1006         u8 framesync;
1007         u32 framesync_c34;
1008
1009         u8 num_total_rfpath;
1010         struct phy_parameters hwparam_tables[MAX_TAB];
1011         u16 rf_pathmap;
1012
1013         enum rt_polarity_ctl polarity_ctl;
1014 };
1015
1016 #define MAX_TID_COUNT                           9
1017 #define RTL_AGG_STOP                            0
1018 #define RTL_AGG_PROGRESS                        1
1019 #define RTL_AGG_START                           2
1020 #define RTL_AGG_OPERATIONAL                     3
1021 #define RTL_AGG_OFF                             0
1022 #define RTL_AGG_ON                              1
1023 #define RTL_RX_AGG_START                        1
1024 #define RTL_RX_AGG_STOP                         0
1025 #define RTL_AGG_EMPTYING_HW_QUEUE_ADDBA         2
1026 #define RTL_AGG_EMPTYING_HW_QUEUE_DELBA         3
1027
1028 struct rtl_ht_agg {
1029         u16 txq_id;
1030         u16 wait_for_ba;
1031         u16 start_idx;
1032         u64 bitmap;
1033         u32 rate_n_flags;
1034         u8 agg_state;
1035         u8 rx_agg_state;
1036 };
1037
1038 struct rssi_sta {
1039         long undec_sm_pwdb;
1040 };
1041
1042 struct rtl_tid_data {
1043         u16 seq_number;
1044         struct rtl_ht_agg agg;
1045 };
1046
1047 struct rtl_sta_info {
1048         struct list_head list;
1049         u8 ratr_index;
1050         u8 wireless_mode;
1051         u8 mimo_ps;
1052         u8 mac_addr[ETH_ALEN];
1053         struct rtl_tid_data tids[MAX_TID_COUNT];
1054
1055         /* just used for ap adhoc or mesh*/
1056         struct rssi_sta rssi_stat;
1057 } __packed;
1058
1059 struct rtl_priv;
1060 struct rtl_io {
1061         struct device *dev;
1062         struct mutex bb_mutex;
1063
1064         /*PCI MEM map */
1065         unsigned long pci_mem_end;      /*shared mem end        */
1066         unsigned long pci_mem_start;    /*shared mem start */
1067
1068         /*PCI IO map */
1069         unsigned long pci_base_addr;    /*device I/O address */
1070
1071         void (*write8_async) (struct rtl_priv *rtlpriv, u32 addr, u8 val);
1072         void (*write16_async) (struct rtl_priv *rtlpriv, u32 addr, u16 val);
1073         void (*write32_async) (struct rtl_priv *rtlpriv, u32 addr, u32 val);
1074         void (*writeN_sync) (struct rtl_priv *rtlpriv, u32 addr, void *buf,
1075                              u16 len);
1076
1077         u8(*read8_sync) (struct rtl_priv *rtlpriv, u32 addr);
1078         u16(*read16_sync) (struct rtl_priv *rtlpriv, u32 addr);
1079         u32(*read32_sync) (struct rtl_priv *rtlpriv, u32 addr);
1080
1081 };
1082
1083 struct rtl_mac {
1084         u8 mac_addr[ETH_ALEN];
1085         u8 mac80211_registered;
1086         u8 beacon_enabled;
1087
1088         u32 tx_ss_num;
1089         u32 rx_ss_num;
1090
1091         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
1092         struct ieee80211_hw *hw;
1093         struct ieee80211_vif *vif;
1094         enum nl80211_iftype opmode;
1095
1096         /*Probe Beacon management */
1097         struct rtl_tid_data tids[MAX_TID_COUNT];
1098         enum rtl_link_state link_state;
1099
1100         int n_channels;
1101         int n_bitrates;
1102
1103         bool offchan_delay;
1104         u8 p2p; /*using p2p role*/
1105         bool p2p_in_use;
1106
1107         /*filters */
1108         u32 rx_conf;
1109         u16 rx_mgt_filter;
1110         u16 rx_ctrl_filter;
1111         u16 rx_data_filter;
1112
1113         bool act_scanning;
1114         u8 cnt_after_linked;
1115         bool skip_scan;
1116
1117         /* early mode */
1118         /* skb wait queue */
1119         struct sk_buff_head skb_waitq[MAX_TID_COUNT];
1120
1121         /*RDG*/
1122         bool rdg_en;
1123
1124         /*AP*/
1125         u8 bssid[6];
1126         u32 vendor;
1127         u8 mcs[16];     /* 16 bytes mcs for HT rates. */
1128         u32 basic_rates; /* b/g rates */
1129         u8 ht_enable;
1130         u8 sgi_40;
1131         u8 sgi_20;
1132         u8 bw_40;
1133         u8 mode;                /* wireless mode */
1134         u8 slot_time;
1135         u8 short_preamble;
1136         u8 use_cts_protect;
1137         u8 cur_40_prime_sc;
1138         u8 cur_40_prime_sc_bk;
1139         u64 tsf;
1140         u8 retry_short;
1141         u8 retry_long;
1142         u16 assoc_id;
1143         bool hiddenssid;
1144
1145         /*IBSS*/
1146         int beacon_interval;
1147
1148         /*AMPDU*/
1149         u8 min_space_cfg;       /*For Min spacing configurations */
1150         u8 max_mss_density;
1151         u8 current_ampdu_factor;
1152         u8 current_ampdu_density;
1153
1154         /*QOS & EDCA */
1155         struct ieee80211_tx_queue_params edca_param[RTL_MAC80211_NUM_QUEUE];
1156         struct rtl_qos_parameters ac[AC_MAX];
1157
1158         /* counters */
1159         u64 last_txok_cnt;
1160         u64 last_rxok_cnt;
1161         u32 last_bt_edca_ul;
1162         u32 last_bt_edca_dl;
1163 };
1164
1165 struct btdm_8723 {
1166         bool all_off;
1167         bool agc_table_en;
1168         bool adc_back_off_on;
1169         bool b2_ant_hid_en;
1170         bool low_penalty_rate_adaptive;
1171         bool rf_rx_lpf_shrink;
1172         bool reject_aggre_pkt;
1173         bool tra_tdma_on;
1174         u8 tra_tdma_nav;
1175         u8 tra_tdma_ant;
1176         bool tdma_on;
1177         u8 tdma_ant;
1178         u8 tdma_nav;
1179         u8 tdma_dac_swing;
1180         u8 fw_dac_swing_lvl;
1181         bool ps_tdma_on;
1182         u8 ps_tdma_byte[5];
1183         bool pta_on;
1184         u32 val_0x6c0;
1185         u32 val_0x6c8;
1186         u32 val_0x6cc;
1187         bool sw_dac_swing_on;
1188         u32 sw_dac_swing_lvl;
1189         u32 wlan_act_hi;
1190         u32 wlan_act_lo;
1191         u32 bt_retry_index;
1192         bool dec_bt_pwr;
1193         bool ignore_wlan_act;
1194 };
1195
1196 struct bt_coexist_8723 {
1197         u32 high_priority_tx;
1198         u32 high_priority_rx;
1199         u32 low_priority_tx;
1200         u32 low_priority_rx;
1201         u8 c2h_bt_info;
1202         bool c2h_bt_info_req_sent;
1203         bool c2h_bt_inquiry_page;
1204         u32 bt_inq_page_start_time;
1205         u8 bt_retry_cnt;
1206         u8 c2h_bt_info_original;
1207         u8 bt_inquiry_page_cnt;
1208         struct btdm_8723 btdm;
1209 };
1210
1211 struct rtl_hal {
1212         struct ieee80211_hw *hw;
1213         bool driver_is_goingto_unload;
1214         bool up_first_time;
1215         bool first_init;
1216         bool being_init_adapter;
1217         bool bbrf_ready;
1218         bool mac_func_enable;
1219         struct bt_coexist_8723 hal_coex_8723;
1220
1221         enum intf_type interface;
1222         u16 hw_type;            /*92c or 92d or 92s and so on */
1223         u8 ic_class;
1224         u8 oem_id;
1225         u32 version;            /*version of chip */
1226         u8 state;               /*stop 0, start 1 */
1227         u8 board_type;
1228
1229         /*firmware */
1230         u32 fwsize;
1231         u8 *pfirmware;
1232         u16 fw_version;
1233         u16 fw_subversion;
1234         bool h2c_setinprogress;
1235         u8 last_hmeboxnum;
1236         bool fw_ready;
1237         /*Reserve page start offset except beacon in TxQ. */
1238         u8 fw_rsvdpage_startoffset;
1239         u8 h2c_txcmd_seq;
1240
1241         /* FW Cmd IO related */
1242         u16 fwcmd_iomap;
1243         u32 fwcmd_ioparam;
1244         bool set_fwcmd_inprogress;
1245         u8 current_fwcmd_io;
1246
1247         struct p2p_ps_offload_t p2p_ps_offload;
1248         bool fw_clk_change_in_progress;
1249         bool allow_sw_to_change_hwclc;
1250         u8 fw_ps_state;
1251         /**/
1252         bool driver_going2unload;
1253
1254         /*AMPDU init min space*/
1255         u8 minspace_cfg;        /*For Min spacing configurations */
1256
1257         /* Dual mac */
1258         enum macphy_mode macphymode;
1259         enum band_type current_bandtype;        /* 0:2.4G, 1:5G */
1260         enum band_type current_bandtypebackup;
1261         enum band_type bandset;
1262         /* dual MAC 0--Mac0 1--Mac1 */
1263         u32 interfaceindex;
1264         /* just for DualMac S3S4 */
1265         u8 macphyctl_reg;
1266         bool earlymode_enable;
1267         u8 max_earlymode_num;
1268         /* Dual mac*/
1269         bool during_mac0init_radiob;
1270         bool during_mac1init_radioa;
1271         bool reloadtxpowerindex;
1272         /* True if IMR or IQK  have done
1273         for 2.4G in scan progress */
1274         bool load_imrandiqk_setting_for2g;
1275
1276         bool disable_amsdu_8k;
1277         bool master_of_dmsp;
1278         bool slave_of_dmsp;
1279 };
1280
1281 struct rtl_security {
1282         /*default 0 */
1283         bool use_sw_sec;
1284
1285         bool being_setkey;
1286         bool use_defaultkey;
1287         /*Encryption Algorithm for Unicast Packet */
1288         enum rt_enc_alg pairwise_enc_algorithm;
1289         /*Encryption Algorithm for Brocast/Multicast */
1290         enum rt_enc_alg group_enc_algorithm;
1291         /*Cam Entry Bitmap */
1292         u32 hwsec_cam_bitmap;
1293         u8 hwsec_cam_sta_addr[TOTAL_CAM_ENTRY][ETH_ALEN];
1294         /*local Key buffer, indx 0 is for
1295            pairwise key 1-4 is for agoup key. */
1296         u8 key_buf[KEY_BUF_SIZE][MAX_KEY_LEN];
1297         u8 key_len[KEY_BUF_SIZE];
1298
1299         /*The pointer of Pairwise Key,
1300            it always points to KeyBuf[4] */
1301         u8 *pairwise_key;
1302 };
1303
1304 #define ASSOCIATE_ENTRY_NUM     33
1305
1306 struct fast_ant_training {
1307         u8      bssid[6];
1308         u8      antsel_rx_keep_0;
1309         u8      antsel_rx_keep_1;
1310         u8      antsel_rx_keep_2;
1311         u32     ant_sum[7];
1312         u32     ant_cnt[7];
1313         u32     ant_ave[7];
1314         u8      fat_state;
1315         u32     train_idx;
1316         u8      antsel_a[ASSOCIATE_ENTRY_NUM];
1317         u8      antsel_b[ASSOCIATE_ENTRY_NUM];
1318         u8      antsel_c[ASSOCIATE_ENTRY_NUM];
1319         u32     main_ant_sum[ASSOCIATE_ENTRY_NUM];
1320         u32     aux_ant_sum[ASSOCIATE_ENTRY_NUM];
1321         u32     main_ant_cnt[ASSOCIATE_ENTRY_NUM];
1322         u32     aux_ant_cnt[ASSOCIATE_ENTRY_NUM];
1323         u8      rx_idle_ant;
1324         bool    becomelinked;
1325 };
1326
1327 struct rtl_dm {
1328         /*PHY status for Dynamic Management */
1329         long entry_min_undec_sm_pwdb;
1330         long undec_sm_pwdb;     /*out dm */
1331         long entry_max_undec_sm_pwdb;
1332         bool dm_initialgain_enable;
1333         bool dynamic_txpower_enable;
1334         bool current_turbo_edca;
1335         bool is_any_nonbepkts;  /*out dm */
1336         bool is_cur_rdlstate;
1337         bool txpower_trackinginit;
1338         bool disable_framebursting;
1339         bool cck_inch14;
1340         bool txpower_tracking;
1341         bool useramask;
1342         bool rfpath_rxenable[4];
1343         bool inform_fw_driverctrldm;
1344         bool current_mrc_switch;
1345         u8 txpowercount;
1346
1347         u8 thermalvalue_rxgain;
1348         u8 thermalvalue_iqk;
1349         u8 thermalvalue_lck;
1350         u8 thermalvalue;
1351         u8 last_dtp_lvl;
1352         u8 thermalvalue_avg[AVG_THERMAL_NUM];
1353         u8 thermalvalue_avg_index;
1354         bool done_txpower;
1355         u8 dynamic_txhighpower_lvl;     /*Tx high power level */
1356         u8 dm_flag;             /*Indicate each dynamic mechanism's status. */
1357         u8 dm_type;
1358         u8 txpower_track_control;
1359         bool interrupt_migration;
1360         bool disable_tx_int;
1361         char ofdm_index[2];
1362         char cck_index;
1363         char delta_power_index;
1364         char delta_power_index_last;
1365         char power_index_offset;
1366
1367         /*88e tx power tracking*/
1368         u8      swing_idx_ofdm[2];
1369         u8      swing_idx_ofdm_cur;
1370         u8      swing_idx_ofdm_base;
1371         bool    swing_flag_ofdm;
1372         u8      swing_idx_cck;
1373         u8      swing_idx_cck_cur;
1374         u8      swing_idx_cck_base;
1375         bool    swing_flag_cck;
1376
1377         /* DMSP */
1378         bool supp_phymode_switch;
1379
1380         struct fast_ant_training fat_table;
1381 };
1382
1383 #define EFUSE_MAX_LOGICAL_SIZE                  256
1384
1385 struct rtl_efuse {
1386         bool autoLoad_ok;
1387         bool bootfromefuse;
1388         u16 max_physical_size;
1389
1390         u8 efuse_map[2][EFUSE_MAX_LOGICAL_SIZE];
1391         u16 efuse_usedbytes;
1392         u8 efuse_usedpercentage;
1393 #ifdef EFUSE_REPG_WORKAROUND
1394         bool efuse_re_pg_sec1flag;
1395         u8 efuse_re_pg_data[8];
1396 #endif
1397
1398         u8 autoload_failflag;
1399         u8 autoload_status;
1400
1401         short epromtype;
1402         u16 eeprom_vid;
1403         u16 eeprom_did;
1404         u16 eeprom_svid;
1405         u16 eeprom_smid;
1406         u8 eeprom_oemid;
1407         u16 eeprom_channelplan;
1408         u8 eeprom_version;
1409         u8 board_type;
1410         u8 external_pa;
1411
1412         u8 dev_addr[6];
1413         u8 wowlan_enable;
1414         u8 antenna_div_cfg;
1415         u8 antenna_div_type;
1416
1417         bool txpwr_fromeprom;
1418         u8 eeprom_crystalcap;
1419         u8 eeprom_tssi[2];
1420         u8 eeprom_tssi_5g[3][2]; /* for 5GL/5GM/5GH band. */
1421         u8 eeprom_pwrlimit_ht20[CHANNEL_GROUP_MAX];
1422         u8 eeprom_pwrlimit_ht40[CHANNEL_GROUP_MAX];
1423         u8 eeprom_chnlarea_txpwr_cck[2][CHANNEL_GROUP_MAX_2G];
1424         u8 eeprom_chnlarea_txpwr_ht40_1s[2][CHANNEL_GROUP_MAX];
1425         u8 eprom_chnl_txpwr_ht40_2sdf[2][CHANNEL_GROUP_MAX];
1426         u8 txpwrlevel_cck[2][CHANNEL_MAX_NUMBER_2G];
1427         u8 txpwrlevel_ht40_1s[2][CHANNEL_MAX_NUMBER];   /*For HT 40MHZ pwr */
1428         u8 txpwrlevel_ht40_2s[2][CHANNEL_MAX_NUMBER];   /*For HT 40MHZ pwr */
1429
1430         u8 internal_pa_5g[2];   /* pathA / pathB */
1431         u8 eeprom_c9;
1432         u8 eeprom_cc;
1433
1434         /*For power group */
1435         u8 eeprom_pwrgroup[2][3];
1436         u8 pwrgroup_ht20[2][CHANNEL_MAX_NUMBER];
1437         u8 pwrgroup_ht40[2][CHANNEL_MAX_NUMBER];
1438
1439         char txpwr_ht20diff[2][CHANNEL_MAX_NUMBER]; /*HT 20<->40 Pwr diff */
1440         /*For HT<->legacy pwr diff*/
1441         u8 txpwr_legacyhtdiff[2][CHANNEL_MAX_NUMBER];
1442         u8 txpwr_safetyflag;                    /* Band edge enable flag */
1443         u16 eeprom_txpowerdiff;
1444         u8 legacy_httxpowerdiff;        /* Legacy to HT rate power diff */
1445         u8 antenna_txpwdiff[3];
1446
1447         u8 eeprom_regulatory;
1448         u8 eeprom_thermalmeter;
1449         u8 thermalmeter[2]; /*ThermalMeter, index 0 for RFIC0, 1 for RFIC1 */
1450         u16 tssi_13dbm;
1451         u8 crystalcap;          /* CrystalCap. */
1452         u8 delta_iqk;
1453         u8 delta_lck;
1454
1455         u8 legacy_ht_txpowerdiff;       /*Legacy to HT rate power diff */
1456         bool apk_thermalmeterignore;
1457
1458         bool b1x1_recvcombine;
1459         bool b1ss_support;
1460
1461         /*channel plan */
1462         u8 channel_plan;
1463 };
1464
1465 struct rtl_ps_ctl {
1466         bool pwrdomain_protect;
1467         bool in_powersavemode;
1468         bool rfchange_inprogress;
1469         bool swrf_processing;
1470         bool hwradiooff;
1471         /*
1472          * just for PCIE ASPM
1473          * If it supports ASPM, Offset[560h] = 0x40,
1474          * otherwise Offset[560h] = 0x00.
1475          * */
1476         bool support_aspm;
1477         bool support_backdoor;
1478
1479         /*for LPS */
1480         enum rt_psmode dot11_psmode;    /*Power save mode configured. */
1481         bool swctrl_lps;
1482         bool leisure_ps;
1483         bool fwctrl_lps;
1484         u8 fwctrl_psmode;
1485         /*For Fw control LPS mode */
1486         u8 reg_fwctrl_lps;
1487         /*Record Fw PS mode status. */
1488         bool fw_current_inpsmode;
1489         u8 reg_max_lps_awakeintvl;
1490         bool report_linked;
1491         bool low_power_enable;/*for 32k*/
1492
1493         /*for IPS */
1494         bool inactiveps;
1495
1496         u32 rfoff_reason;
1497
1498         /*RF OFF Level */
1499         u32 cur_ps_level;
1500         u32 reg_rfps_level;
1501
1502         /*just for PCIE ASPM */
1503         u8 const_amdpci_aspm;
1504         bool pwrdown_mode;
1505
1506         enum rf_pwrstate inactive_pwrstate;
1507         enum rf_pwrstate rfpwr_state;   /*cur power state */
1508
1509         /* for SW LPS*/
1510         bool sw_ps_enabled;
1511         bool state;
1512         bool state_inap;
1513         bool multi_buffered;
1514         u16 nullfunc_seq;
1515         unsigned int dtim_counter;
1516         unsigned int sleep_ms;
1517         unsigned long last_sleep_jiffies;
1518         unsigned long last_awake_jiffies;
1519         unsigned long last_delaylps_stamp_jiffies;
1520         unsigned long last_dtim;
1521         unsigned long last_beacon;
1522         unsigned long last_action;
1523         unsigned long last_slept;
1524
1525         /*For P2P PS */
1526         struct rtl_p2p_ps_info p2p_ps_info;
1527         u8 pwr_mode;
1528         u8 smart_ps;
1529 };
1530
1531 struct rtl_stats {
1532         u8 psaddr[ETH_ALEN];
1533         u32 mac_time[2];
1534         s8 rssi;
1535         u8 signal;
1536         u8 noise;
1537         u8 rate;                /* hw desc rate */
1538         u8 received_channel;
1539         u8 control;
1540         u8 mask;
1541         u8 freq;
1542         u16 len;
1543         u64 tsf;
1544         u32 beacon_time;
1545         u8 nic_type;
1546         u16 length;
1547         u8 signalquality;       /*in 0-100 index. */
1548         /*
1549          * Real power in dBm for this packet,
1550          * no beautification and aggregation.
1551          * */
1552         s32 recvsignalpower;
1553         s8 rxpower;             /*in dBm Translate from PWdB */
1554         u8 signalstrength;      /*in 0-100 index. */
1555         u16 hwerror:1;
1556         u16 crc:1;
1557         u16 icv:1;
1558         u16 shortpreamble:1;
1559         u16 antenna:1;
1560         u16 decrypted:1;
1561         u16 wakeup:1;
1562         u32 timestamp_low;
1563         u32 timestamp_high;
1564
1565         u8 rx_drvinfo_size;
1566         u8 rx_bufshift;
1567         bool isampdu;
1568         bool isfirst_ampdu;
1569         bool rx_is40Mhzpacket;
1570         u32 rx_pwdb_all;
1571         u8 rx_mimo_signalstrength[4];   /*in 0~100 index */
1572         s8 rx_mimo_sig_qual[2];
1573         bool packet_matchbssid;
1574         bool is_cck;
1575         bool is_ht;
1576         bool packet_toself;
1577         bool packet_beacon;     /*for rssi */
1578         char cck_adc_pwdb[4];   /*for rx path selection */
1579
1580         u8 packet_report_type;
1581
1582         u32 macid;
1583         u8 wake_match;
1584         u32 bt_rx_rssi_percentage;
1585         u32 macid_valid_entry[2];
1586 };
1587
1588
1589 struct rt_link_detect {
1590         /* count for roaming */
1591         u32 bcn_rx_inperiod;
1592         u32 roam_times;
1593
1594         u32 num_tx_in4period[4];
1595         u32 num_rx_in4period[4];
1596
1597         u32 num_tx_inperiod;
1598         u32 num_rx_inperiod;
1599
1600         bool busytraffic;
1601         bool tx_busy_traffic;
1602         bool rx_busy_traffic;
1603         bool higher_busytraffic;
1604         bool higher_busyrxtraffic;
1605
1606         u32 tidtx_in4period[MAX_TID_COUNT][4];
1607         u32 tidtx_inperiod[MAX_TID_COUNT];
1608         bool higher_busytxtraffic[MAX_TID_COUNT];
1609 };
1610
1611 struct rtl_tcb_desc {
1612         u8 packet_bw:1;
1613         u8 multicast:1;
1614         u8 broadcast:1;
1615
1616         u8 rts_stbc:1;
1617         u8 rts_enable:1;
1618         u8 cts_enable:1;
1619         u8 rts_use_shortpreamble:1;
1620         u8 rts_use_shortgi:1;
1621         u8 rts_sc:1;
1622         u8 rts_bw:1;
1623         u8 rts_rate;
1624
1625         u8 use_shortgi:1;
1626         u8 use_shortpreamble:1;
1627         u8 use_driver_rate:1;
1628         u8 disable_ratefallback:1;
1629
1630         u8 ratr_index;
1631         u8 mac_id;
1632         u8 hw_rate;
1633
1634         u8 last_inipkt:1;
1635         u8 cmd_or_init:1;
1636         u8 queue_index;
1637
1638         /* early mode */
1639         u8 empkt_num;
1640         /* The max value by HW */
1641         u32 empkt_len[10];
1642         bool btx_enable_sw_calc_duration;
1643 };
1644
1645 struct rtl_hal_ops {
1646         int (*init_sw_vars) (struct ieee80211_hw *hw);
1647         void (*deinit_sw_vars) (struct ieee80211_hw *hw);
1648         void (*read_chip_version)(struct ieee80211_hw *hw);
1649         void (*read_eeprom_info) (struct ieee80211_hw *hw);
1650         void (*interrupt_recognized) (struct ieee80211_hw *hw,
1651                                       u32 *p_inta, u32 *p_intb);
1652         int (*hw_init) (struct ieee80211_hw *hw);
1653         void (*hw_disable) (struct ieee80211_hw *hw);
1654         void (*hw_suspend) (struct ieee80211_hw *hw);
1655         void (*hw_resume) (struct ieee80211_hw *hw);
1656         void (*enable_interrupt) (struct ieee80211_hw *hw);
1657         void (*disable_interrupt) (struct ieee80211_hw *hw);
1658         int (*set_network_type) (struct ieee80211_hw *hw,
1659                                  enum nl80211_iftype type);
1660         void (*set_chk_bssid)(struct ieee80211_hw *hw,
1661                                 bool check_bssid);
1662         void (*set_bw_mode) (struct ieee80211_hw *hw,
1663                              enum nl80211_channel_type ch_type);
1664          u8(*switch_channel) (struct ieee80211_hw *hw);
1665         void (*set_qos) (struct ieee80211_hw *hw, int aci);
1666         void (*set_bcn_reg) (struct ieee80211_hw *hw);
1667         void (*set_bcn_intv) (struct ieee80211_hw *hw);
1668         void (*update_interrupt_mask) (struct ieee80211_hw *hw,
1669                                        u32 add_msr, u32 rm_msr);
1670         void (*get_hw_reg) (struct ieee80211_hw *hw, u8 variable, u8 *val);
1671         void (*set_hw_reg) (struct ieee80211_hw *hw, u8 variable, u8 *val);
1672         void (*update_rate_tbl) (struct ieee80211_hw *hw,
1673                               struct ieee80211_sta *sta, u8 rssi_level);
1674         void (*update_rate_mask) (struct ieee80211_hw *hw, u8 rssi_level);
1675         void (*fill_tx_desc) (struct ieee80211_hw *hw,
1676                               struct ieee80211_hdr *hdr, u8 *pdesc_tx,
1677                               struct ieee80211_tx_info *info,
1678                               struct ieee80211_sta *sta,
1679                               struct sk_buff *skb, u8 hw_queue,
1680                               struct rtl_tcb_desc *ptcb_desc);
1681         void (*fill_fake_txdesc) (struct ieee80211_hw *hw, u8 *pDesc,
1682                                   u32 buffer_len, bool bIsPsPoll);
1683         void (*fill_tx_cmddesc) (struct ieee80211_hw *hw, u8 *pdesc,
1684                                  bool firstseg, bool lastseg,
1685                                  struct sk_buff *skb);
1686         bool (*cmd_send_packet)(struct ieee80211_hw *hw, struct sk_buff *skb);
1687         bool (*query_rx_desc) (struct ieee80211_hw *hw,
1688                                struct rtl_stats *stats,
1689                                struct ieee80211_rx_status *rx_status,
1690                                u8 *pdesc, struct sk_buff *skb);
1691         void (*set_channel_access) (struct ieee80211_hw *hw);
1692         bool (*radio_onoff_checking) (struct ieee80211_hw *hw, u8 *valid);
1693         void (*dm_watchdog) (struct ieee80211_hw *hw);
1694         void (*scan_operation_backup) (struct ieee80211_hw *hw, u8 operation);
1695         bool (*set_rf_power_state) (struct ieee80211_hw *hw,
1696                                     enum rf_pwrstate rfpwr_state);
1697         void (*led_control) (struct ieee80211_hw *hw,
1698                              enum led_ctl_mode ledaction);
1699         void (*set_desc) (u8 *pdesc, bool istx, u8 desc_name, u8 *val);
1700         u32 (*get_desc) (u8 *pdesc, bool istx, u8 desc_name);
1701         void (*tx_polling) (struct ieee80211_hw *hw, u8 hw_queue);
1702         void (*enable_hw_sec) (struct ieee80211_hw *hw);
1703         void (*set_key) (struct ieee80211_hw *hw, u32 key_index,
1704                          u8 *macaddr, bool is_group, u8 enc_algo,
1705                          bool is_wepkey, bool clear_all);
1706         void (*init_sw_leds) (struct ieee80211_hw *hw);
1707         void (*deinit_sw_leds) (struct ieee80211_hw *hw);
1708         u32 (*get_bbreg) (struct ieee80211_hw *hw, u32 regaddr, u32 bitmask);
1709         void (*set_bbreg) (struct ieee80211_hw *hw, u32 regaddr, u32 bitmask,
1710                            u32 data);
1711         u32 (*get_rfreg) (struct ieee80211_hw *hw, enum radio_path rfpath,
1712                           u32 regaddr, u32 bitmask);
1713         void (*set_rfreg) (struct ieee80211_hw *hw, enum radio_path rfpath,
1714                            u32 regaddr, u32 bitmask, u32 data);
1715         void (*allow_all_destaddr)(struct ieee80211_hw *hw,
1716                 bool allow_all_da, bool write_into_reg);
1717         void (*linked_set_reg) (struct ieee80211_hw *hw);
1718         void (*chk_switch_dmdp) (struct ieee80211_hw *hw);
1719         void (*dualmac_easy_concurrent) (struct ieee80211_hw *hw);
1720         void (*dualmac_switch_to_dmdp) (struct ieee80211_hw *hw);
1721         bool (*phy_rf6052_config) (struct ieee80211_hw *hw);
1722         void (*phy_rf6052_set_cck_txpower) (struct ieee80211_hw *hw,
1723                                             u8 *powerlevel);
1724         void (*phy_rf6052_set_ofdm_txpower) (struct ieee80211_hw *hw,
1725                                              u8 *ppowerlevel, u8 channel);
1726         bool (*config_bb_with_headerfile) (struct ieee80211_hw *hw,
1727                                            u8 configtype);
1728         bool (*config_bb_with_pgheaderfile) (struct ieee80211_hw *hw,
1729                                              u8 configtype);
1730         void (*phy_lc_calibrate) (struct ieee80211_hw *hw, bool is2t);
1731         void (*phy_set_bw_mode_callback) (struct ieee80211_hw *hw);
1732         void (*dm_dynamic_txpower) (struct ieee80211_hw *hw);
1733         void (*c2h_command_handle) (struct ieee80211_hw *hw);
1734         void (*bt_wifi_media_status_notify) (struct ieee80211_hw *hw,
1735                                              bool mstate);
1736         void (*bt_coex_off_before_lps) (struct ieee80211_hw *hw);
1737         void (*fill_h2c_cmd) (struct ieee80211_hw *hw, u8 element_id,
1738                               u32 cmd_len, u8 *p_cmdbuffer);
1739 };
1740
1741 struct rtl_intf_ops {
1742         /*com */
1743         void (*read_efuse_byte)(struct ieee80211_hw *hw, u16 _offset, u8 *pbuf);
1744         int (*adapter_start) (struct ieee80211_hw *hw);
1745         void (*adapter_stop) (struct ieee80211_hw *hw);
1746         bool (*check_buddy_priv)(struct ieee80211_hw *hw,
1747                                  struct rtl_priv **buddy_priv);
1748
1749         int (*adapter_tx) (struct ieee80211_hw *hw,
1750                            struct ieee80211_sta *sta,
1751                            struct sk_buff *skb,
1752                            struct rtl_tcb_desc *ptcb_desc);
1753         void (*flush)(struct ieee80211_hw *hw, bool drop);
1754         int (*reset_trx_ring) (struct ieee80211_hw *hw);
1755         bool (*waitq_insert) (struct ieee80211_hw *hw,
1756                               struct ieee80211_sta *sta,
1757                               struct sk_buff *skb);
1758
1759         /*pci */
1760         void (*disable_aspm) (struct ieee80211_hw *hw);
1761         void (*enable_aspm) (struct ieee80211_hw *hw);
1762
1763         /*usb */
1764 };
1765
1766 struct rtl_mod_params {
1767         /* default: 0 = using hardware encryption */
1768         bool sw_crypto;
1769
1770         /* default: 0 = DBG_EMERG (0)*/
1771         int debug;
1772
1773         /* default: 1 = using no linked power save */
1774         bool inactiveps;
1775
1776         /* default: 1 = using linked sw power save */
1777         bool swctrl_lps;
1778
1779         /* default: 1 = using linked fw power save */
1780         bool fwctrl_lps;
1781 };
1782
1783 struct rtl_hal_usbint_cfg {
1784         /* data - rx */
1785         u32 in_ep_num;
1786         u32 rx_urb_num;
1787         u32 rx_max_size;
1788
1789         /* op - rx */
1790         void (*usb_rx_hdl)(struct ieee80211_hw *, struct sk_buff *);
1791         void (*usb_rx_segregate_hdl)(struct ieee80211_hw *, struct sk_buff *,
1792                                      struct sk_buff_head *);
1793
1794         /* tx */
1795         void (*usb_tx_cleanup)(struct ieee80211_hw *, struct sk_buff *);
1796         int (*usb_tx_post_hdl)(struct ieee80211_hw *, struct urb *,
1797                                struct sk_buff *);
1798         struct sk_buff *(*usb_tx_aggregate_hdl)(struct ieee80211_hw *,
1799                                                 struct sk_buff_head *);
1800
1801         /* endpoint mapping */
1802         int (*usb_endpoint_mapping)(struct ieee80211_hw *hw);
1803         u16 (*usb_mq_to_hwq)(__le16 fc, u16 mac80211_queue_index);
1804 };
1805
1806 struct rtl_hal_cfg {
1807         u8 bar_id;
1808         bool write_readback;
1809         char *name;
1810         char *fw_name;
1811         struct rtl_hal_ops *ops;
1812         struct rtl_mod_params *mod_params;
1813         struct rtl_hal_usbint_cfg *usb_interface_cfg;
1814
1815         /*this map used for some registers or vars
1816            defined int HAL but used in MAIN */
1817         u32 maps[RTL_VAR_MAP_MAX];
1818
1819 };
1820
1821 struct rtl_locks {
1822         /* mutex */
1823         struct mutex conf_mutex;
1824         struct mutex ps_mutex;
1825
1826         /*spin lock */
1827         spinlock_t ips_lock;
1828         spinlock_t irq_th_lock;
1829         spinlock_t irq_pci_lock;
1830         spinlock_t tx_lock;
1831         spinlock_t h2c_lock;
1832         spinlock_t rf_ps_lock;
1833         spinlock_t rf_lock;
1834         spinlock_t lps_lock;
1835         spinlock_t waitq_lock;
1836         spinlock_t entry_list_lock;
1837         spinlock_t usb_lock;
1838
1839         /*FW clock change */
1840         spinlock_t fw_ps_lock;
1841
1842         /*Dual mac*/
1843         spinlock_t cck_and_rw_pagea_lock;
1844
1845         /*Easy concurrent*/
1846         spinlock_t check_sendpkt_lock;
1847 };
1848
1849 struct rtl_works {
1850         struct ieee80211_hw *hw;
1851
1852         /*timer */
1853         struct timer_list watchdog_timer;
1854         struct timer_list dualmac_easyconcurrent_retrytimer;
1855         struct timer_list fw_clockoff_timer;
1856         struct timer_list fast_antenna_training_timer;
1857         /*task */
1858         struct tasklet_struct irq_tasklet;
1859         struct tasklet_struct irq_prepare_bcn_tasklet;
1860
1861         /*work queue */
1862         struct workqueue_struct *rtl_wq;
1863         struct delayed_work watchdog_wq;
1864         struct delayed_work ips_nic_off_wq;
1865
1866         /* For SW LPS */
1867         struct delayed_work ps_work;
1868         struct delayed_work ps_rfon_wq;
1869         struct delayed_work fwevt_wq;
1870
1871         struct work_struct lps_change_work;
1872         struct work_struct fill_h2c_cmd;
1873 };
1874
1875 struct rtl_debug {
1876         u32 dbgp_type[DBGP_TYPE_MAX];
1877         int global_debuglevel;
1878         u64 global_debugcomponents;
1879
1880         /* add for proc debug */
1881         struct proc_dir_entry *proc_dir;
1882         char proc_name[20];
1883 };
1884
1885 #define MIMO_PS_STATIC                  0
1886 #define MIMO_PS_DYNAMIC                 1
1887 #define MIMO_PS_NOLIMIT                 3
1888
1889 struct rtl_dualmac_easy_concurrent_ctl {
1890         enum band_type currentbandtype_backfordmdp;
1891         bool close_bbandrf_for_dmsp;
1892         bool change_to_dmdp;
1893         bool change_to_dmsp;
1894         bool switch_in_process;
1895 };
1896
1897 struct rtl_dmsp_ctl {
1898         bool activescan_for_slaveofdmsp;
1899         bool scan_for_anothermac_fordmsp;
1900         bool scan_for_itself_fordmsp;
1901         bool writedig_for_anothermacofdmsp;
1902         u32 curdigvalue_for_anothermacofdmsp;
1903         bool changecckpdstate_for_anothermacofdmsp;
1904         u8 curcckpdstate_for_anothermacofdmsp;
1905         bool changetxhighpowerlvl_for_anothermacofdmsp;
1906         u8 curtxhighlvl_for_anothermacofdmsp;
1907         long rssivalmin_for_anothermacofdmsp;
1908 };
1909
1910 struct ps_t {
1911         u8 pre_ccastate;
1912         u8 cur_ccasate;
1913         u8 pre_rfstate;
1914         u8 cur_rfstate;
1915         long rssi_val_min;
1916 };
1917
1918 struct dig_t {
1919         u32 rssi_lowthresh;
1920         u32 rssi_highthresh;
1921         u32 fa_lowthresh;
1922         u32 fa_highthresh;
1923         long last_min_undec_pwdb_for_dm;
1924         long rssi_highpower_lowthresh;
1925         long rssi_highpower_highthresh;
1926         u32 recover_cnt;
1927         u32 pre_igvalue;
1928         u32 cur_igvalue;
1929         long rssi_val;
1930         u8 dig_enable_flag;
1931         u8 dig_ext_port_stage;
1932         u8 dig_algorithm;
1933         u8 dig_twoport_algorithm;
1934         u8 dig_dbgmode;
1935         u8 dig_slgorithm_switch;
1936         u8 cursta_cstate;
1937         u8 presta_cstate;
1938         u8 curmultista_cstate;
1939         char back_val;
1940         char back_range_max;
1941         char back_range_min;
1942         u8 rx_gain_max;
1943         u8 rx_gain_min;
1944         u8 min_undec_pwdb_for_dm;
1945         u8 rssi_val_min;
1946         u8 pre_cck_cca_thres;
1947         u8 cur_cck_cca_thres;
1948         u8 pre_cck_pd_state;
1949         u8 cur_cck_pd_state;
1950         u8 pre_cck_fa_state;
1951         u8 cur_cck_fa_state;
1952         u8 pre_ccastate;
1953         u8 cur_ccasate;
1954         u8 large_fa_hit;
1955         u8 forbidden_igi;
1956         u8 dig_state;
1957         u8 dig_highpwrstate;
1958         u8 cur_sta_cstate;
1959         u8 pre_sta_cstate;
1960         u8 cur_ap_cstate;
1961         u8 pre_ap_cstate;
1962         u8 cur_pd_thstate;
1963         u8 pre_pd_thstate;
1964         u8 cur_cs_ratiostate;
1965         u8 pre_cs_ratiostate;
1966         u8 backoff_enable_flag;
1967         char backoffval_range_max;
1968         char backoffval_range_min;
1969         u8 dig_min_0;
1970         u8 dig_min_1;
1971         bool media_connect_0;
1972         bool media_connect_1;
1973
1974         u32 antdiv_rssi_max;
1975         u32 rssi_max;
1976 };
1977
1978 struct rtl_global_var {
1979         /* from this list we can get
1980          * other adapter's rtl_priv */
1981         struct list_head glb_priv_list;
1982         spinlock_t glb_list_lock;
1983 };
1984
1985 struct rtl_priv {
1986         struct ieee80211_hw *hw;
1987         struct completion firmware_loading_complete;
1988         struct list_head list;
1989         struct rtl_priv *buddy_priv;
1990         struct rtl_global_var *glb_var;
1991         struct rtl_dualmac_easy_concurrent_ctl easy_concurrent_ctl;
1992         struct rtl_dmsp_ctl dmsp_ctl;
1993         struct rtl_locks locks;
1994         struct rtl_works works;
1995         struct rtl_mac mac80211;
1996         struct rtl_hal rtlhal;
1997         struct rtl_regulatory regd;
1998         struct rtl_rfkill rfkill;
1999         struct rtl_io io;
2000         struct rtl_phy phy;
2001         struct rtl_dm dm;
2002         struct rtl_security sec;
2003         struct rtl_efuse efuse;
2004
2005         struct rtl_ps_ctl psc;
2006         struct rate_adaptive ra;
2007         struct wireless_stats stats;
2008         struct rt_link_detect link_info;
2009         struct false_alarm_statistics falsealm_cnt;
2010
2011         struct rtl_rate_priv *rate_priv;
2012
2013         /* sta entry list for ap adhoc or mesh */
2014         struct list_head entry_list;
2015
2016         struct rtl_debug dbg;
2017         int max_fw_size;
2018
2019         /*
2020          *hal_cfg : for diff cards
2021          *intf_ops : for diff interrface usb/pcie
2022          */
2023         struct rtl_hal_cfg *cfg;
2024         struct rtl_intf_ops *intf_ops;
2025
2026         /*this var will be set by set_bit,
2027            and was used to indicate status of
2028            interface or hardware */
2029         unsigned long status;
2030
2031         /* tables for dm */
2032         struct dig_t dm_digtable;
2033         struct ps_t dm_pstable;
2034
2035         /* section shared by individual drivers */
2036         union {
2037                 struct {        /* data buffer pointer for USB reads */
2038                         __le32 *usb_data;
2039                         int usb_data_index;
2040                         bool initialized;
2041                 };
2042                 struct {        /* section for 8723ae */
2043                         bool reg_init;  /* true if regs saved */
2044                         u32 reg_874;
2045                         u32 reg_c70;
2046                         u32 reg_85c;
2047                         u32 reg_a74;
2048                         bool bt_operation_on;
2049                 };
2050         };
2051         bool enter_ps;  /* true when entering PS */
2052         u8 rate_mask[5];
2053
2054         /*This must be the last item so
2055            that it points to the data allocated
2056            beyond  this structure like:
2057            rtl_pci_priv or rtl_usb_priv */
2058         u8 priv[0] __aligned(sizeof(void *));
2059 };
2060
2061 #define rtl_priv(hw)            (((struct rtl_priv *)(hw)->priv))
2062 #define rtl_mac(rtlpriv)        (&((rtlpriv)->mac80211))
2063 #define rtl_hal(rtlpriv)        (&((rtlpriv)->rtlhal))
2064 #define rtl_efuse(rtlpriv)      (&((rtlpriv)->efuse))
2065 #define rtl_psc(rtlpriv)        (&((rtlpriv)->psc))
2066
2067
2068 /***************************************
2069     Bluetooth Co-existence Related
2070 ****************************************/
2071
2072 enum bt_ant_num {
2073         ANT_X2 = 0,
2074         ANT_X1 = 1,
2075 };
2076
2077 enum bt_co_type {
2078         BT_2WIRE = 0,
2079         BT_ISSC_3WIRE = 1,
2080         BT_ACCEL = 2,
2081         BT_CSR_BC4 = 3,
2082         BT_CSR_BC8 = 4,
2083         BT_RTL8756 = 5,
2084         BT_RTL8723A = 6,
2085 };
2086
2087 enum bt_cur_state {
2088         BT_OFF = 0,
2089         BT_ON = 1,
2090 };
2091
2092 enum bt_service_type {
2093         BT_SCO = 0,
2094         BT_A2DP = 1,
2095         BT_HID = 2,
2096         BT_HID_IDLE = 3,
2097         BT_SCAN = 4,
2098         BT_IDLE = 5,
2099         BT_OTHER_ACTION = 6,
2100         BT_BUSY = 7,
2101         BT_OTHERBUSY = 8,
2102         BT_PAN = 9,
2103 };
2104
2105 enum bt_radio_shared {
2106         BT_RADIO_SHARED = 0,
2107         BT_RADIO_INDIVIDUAL = 1,
2108 };
2109
2110 struct bt_coexist_info {
2111
2112         /* EEPROM BT info. */
2113         u8 eeprom_bt_coexist;
2114         u8 eeprom_bt_type;
2115         u8 eeprom_bt_ant_num;
2116         u8 eeprom_bt_ant_isol;
2117         u8 eeprom_bt_radio_shared;
2118
2119         u8 bt_coexistence;
2120         u8 bt_ant_num;
2121         u8 bt_coexist_type;
2122         u8 bt_state;
2123         u8 bt_cur_state;        /* 0:on, 1:off */
2124         u8 bt_ant_isolation;    /* 0:good, 1:bad */
2125         u8 bt_pape_ctrl;        /* 0:SW, 1:SW/HW dynamic */
2126         u8 bt_service;
2127         u8 bt_radio_shared_type;
2128         u8 bt_rfreg_origin_1e;
2129         u8 bt_rfreg_origin_1f;
2130         u8 bt_rssi_state;
2131         u32 ratio_tx;
2132         u32 ratio_pri;
2133         u32 bt_edca_ul;
2134         u32 bt_edca_dl;
2135
2136         bool init_set;
2137         bool bt_busy_traffic;
2138         bool bt_traffic_mode_set;
2139         bool bt_non_traffic_mode_set;
2140
2141         bool fw_coexist_all_off;
2142         bool sw_coexist_all_off;
2143         bool hw_coexist_all_off;
2144         u32 cstate;
2145         u32 previous_state;
2146         u32 cstate_h;
2147         u32 previous_state_h;
2148
2149         u8 bt_pre_rssi_state;
2150         u8 bt_pre_rssi_state1;
2151
2152         u8 reg_bt_iso;
2153         u8 reg_bt_sco;
2154         bool balance_on;
2155         u8 bt_active_zero_cnt;
2156         bool cur_bt_disabled;
2157         bool pre_bt_disabled;
2158
2159         u8 bt_profile_case;
2160         u8 bt_profile_action;
2161         bool bt_busy;
2162         bool hold_for_bt_operation;
2163         u8 lps_counter;
2164 };
2165
2166
2167 /****************************************
2168         mem access macro define start
2169         Call endian free function when
2170         1. Read/write packet content.
2171         2. Before write integer to IO.
2172         3. After read integer from IO.
2173 ****************************************/
2174 /* Convert little data endian to host ordering */
2175 #define EF1BYTE(_val)           \
2176         ((u8)(_val))
2177 #define EF2BYTE(_val)           \
2178         (le16_to_cpu(_val))
2179 #define EF4BYTE(_val)           \
2180         (le32_to_cpu(_val))
2181
2182 /* Read data from memory */
2183 #define READEF1BYTE(_ptr)       \
2184         EF1BYTE(*((u8 *)(_ptr)))
2185 /* Read le16 data from memory and convert to host ordering */
2186 #define READEF2BYTE(_ptr)       \
2187         EF2BYTE(*(_ptr))
2188 #define READEF4BYTE(_ptr)       \
2189         EF4BYTE(*(_ptr))
2190
2191 /* Write data to memory */
2192 #define WRITEEF1BYTE(_ptr, _val)        \
2193         (*((u8 *)(_ptr))) = EF1BYTE(_val)
2194 /* Write le16 data to memory in host ordering */
2195 #define WRITEEF2BYTE(_ptr, _val)        \
2196         (*((u16 *)(_ptr))) = EF2BYTE(_val)
2197 #define WRITEEF4BYTE(_ptr, _val)        \
2198         (*((u32 *)(_ptr))) = EF2BYTE(_val)
2199
2200 /* Create a bit mask
2201  * Examples:
2202  * BIT_LEN_MASK_32(0) => 0x00000000
2203  * BIT_LEN_MASK_32(1) => 0x00000001
2204  * BIT_LEN_MASK_32(2) => 0x00000003
2205  * BIT_LEN_MASK_32(32) => 0xFFFFFFFF
2206  */
2207 #define BIT_LEN_MASK_32(__bitlen)        \
2208         (0xFFFFFFFF >> (32 - (__bitlen)))
2209 #define BIT_LEN_MASK_16(__bitlen)        \
2210         (0xFFFF >> (16 - (__bitlen)))
2211 #define BIT_LEN_MASK_8(__bitlen) \
2212         (0xFF >> (8 - (__bitlen)))
2213
2214 /* Create an offset bit mask
2215  * Examples:
2216  * BIT_OFFSET_LEN_MASK_32(0, 2) => 0x00000003
2217  * BIT_OFFSET_LEN_MASK_32(16, 2) => 0x00030000
2218  */
2219 #define BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen) \
2220         (BIT_LEN_MASK_32(__bitlen) << (__bitoffset))
2221 #define BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen) \
2222         (BIT_LEN_MASK_16(__bitlen) << (__bitoffset))
2223 #define BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen) \
2224         (BIT_LEN_MASK_8(__bitlen) << (__bitoffset))
2225
2226 /*Description:
2227  * Return 4-byte value in host byte ordering from
2228  * 4-byte pointer in little-endian system.
2229  */
2230 #define LE_P4BYTE_TO_HOST_4BYTE(__pstart) \
2231         (EF4BYTE(*((__le32 *)(__pstart))))
2232 #define LE_P2BYTE_TO_HOST_2BYTE(__pstart) \
2233         (EF2BYTE(*((__le16 *)(__pstart))))
2234 #define LE_P1BYTE_TO_HOST_1BYTE(__pstart) \
2235         (EF1BYTE(*((u8 *)(__pstart))))
2236
2237 /*Description:
2238 Translate subfield (continuous bits in little-endian) of 4-byte
2239 value to host byte ordering.*/
2240 #define LE_BITS_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
2241         ( \
2242                 (LE_P4BYTE_TO_HOST_4BYTE(__pstart) >> (__bitoffset))  & \
2243                 BIT_LEN_MASK_32(__bitlen) \
2244         )
2245 #define LE_BITS_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
2246         ( \
2247                 (LE_P2BYTE_TO_HOST_2BYTE(__pstart) >> (__bitoffset)) & \
2248                 BIT_LEN_MASK_16(__bitlen) \
2249         )
2250 #define LE_BITS_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
2251         ( \
2252                 (LE_P1BYTE_TO_HOST_1BYTE(__pstart) >> (__bitoffset)) & \
2253                 BIT_LEN_MASK_8(__bitlen) \
2254         )
2255
2256 /* Description:
2257  * Mask subfield (continuous bits in little-endian) of 4-byte value
2258  * and return the result in 4-byte value in host byte ordering.
2259  */
2260 #define LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
2261         ( \
2262                 LE_P4BYTE_TO_HOST_4BYTE(__pstart)  & \
2263                 (~BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen)) \
2264         )
2265 #define LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
2266         ( \
2267                 LE_P2BYTE_TO_HOST_2BYTE(__pstart) & \
2268                 (~BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen)) \
2269         )
2270 #define LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
2271         ( \
2272                 LE_P1BYTE_TO_HOST_1BYTE(__pstart) & \
2273                 (~BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen)) \
2274         )
2275
2276 /* Description:
2277  * Set subfield of little-endian 4-byte value to specified value.
2278  */
2279 #define SET_BITS_TO_LE_4BYTE(__pstart, __bitoffset, __bitlen, __val) \
2280         *((u32 *)(__pstart)) = \
2281         ( \
2282                 LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) | \
2283                 ((((u32)__val) & BIT_LEN_MASK_32(__bitlen)) << (__bitoffset)) \
2284         );
2285 #define SET_BITS_TO_LE_2BYTE(__pstart, __bitoffset, __bitlen, __val) \
2286         *((u16 *)(__pstart)) = \
2287         ( \
2288                 LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) | \
2289                 ((((u16)__val) & BIT_LEN_MASK_16(__bitlen)) << (__bitoffset)) \
2290         );
2291 #define SET_BITS_TO_LE_1BYTE(__pstart, __bitoffset, __bitlen, __val) \
2292         *((u8 *)(__pstart)) = EF1BYTE \
2293         ( \
2294                 LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) | \
2295                 ((((u8)__val) & BIT_LEN_MASK_8(__bitlen)) << (__bitoffset)) \
2296         );
2297
2298 #define N_BYTE_ALIGMENT(__value, __aligment) ((__aligment == 1) ? \
2299         (__value) : (((__value + __aligment - 1) / __aligment) * __aligment))
2300
2301 /****************************************
2302         mem access macro define end
2303 ****************************************/
2304
2305 #define byte(x, n) ((x >> (8 * n)) & 0xff)
2306
2307 #define packet_get_type(_packet) (EF1BYTE((_packet).octet[0]) & 0xFC)
2308 #define RTL_WATCH_DOG_TIME      2000
2309 #define MSECS(t)                msecs_to_jiffies(t)
2310 #define WLAN_FC_GET_VERS(fc)    (le16_to_cpu(fc) & IEEE80211_FCTL_VERS)
2311 #define WLAN_FC_GET_TYPE(fc)    (le16_to_cpu(fc) & IEEE80211_FCTL_FTYPE)
2312 #define WLAN_FC_GET_STYPE(fc)   (le16_to_cpu(fc) & IEEE80211_FCTL_STYPE)
2313 #define WLAN_FC_MORE_DATA(fc)   (le16_to_cpu(fc) & IEEE80211_FCTL_MOREDATA)
2314 #define rtl_dm(rtlpriv)         (&((rtlpriv)->dm))
2315
2316 #define RT_RF_OFF_LEVL_ASPM             BIT(0)  /*PCI ASPM */
2317 #define RT_RF_OFF_LEVL_CLK_REQ          BIT(1)  /*PCI clock request */
2318 #define RT_RF_OFF_LEVL_PCI_D3           BIT(2)  /*PCI D3 mode */
2319 /*NIC halt, re-initialize hw parameters*/
2320 #define RT_RF_OFF_LEVL_HALT_NIC         BIT(3)
2321 #define RT_RF_OFF_LEVL_FREE_FW          BIT(4)  /*FW free, re-download the FW */
2322 #define RT_RF_OFF_LEVL_FW_32K           BIT(5)  /*FW in 32k */
2323 /*Always enable ASPM and Clock Req in initialization.*/
2324 #define RT_RF_PS_LEVEL_ALWAYS_ASPM      BIT(6)
2325 /* no matter RFOFF or SLEEP we set PS_ASPM_LEVL*/
2326 #define RT_PS_LEVEL_ASPM                BIT(7)
2327 /*When LPS is on, disable 2R if no packet is received or transmittd.*/
2328 #define RT_RF_LPS_DISALBE_2R            BIT(30)
2329 #define RT_RF_LPS_LEVEL_ASPM            BIT(31) /*LPS with ASPM */
2330 #define RT_IN_PS_LEVEL(ppsc, _ps_flg)           \
2331         ((ppsc->cur_ps_level & _ps_flg) ? true : false)
2332 #define RT_CLEAR_PS_LEVEL(ppsc, _ps_flg)        \
2333         (ppsc->cur_ps_level &= (~(_ps_flg)))
2334 #define RT_SET_PS_LEVEL(ppsc, _ps_flg)          \
2335         (ppsc->cur_ps_level |= _ps_flg)
2336
2337 #define container_of_dwork_rtl(x, y, z) \
2338         container_of(container_of(x, struct delayed_work, work), y, z)
2339
2340 #define FILL_OCTET_STRING(_os, _octet, _len)    \
2341                 (_os).octet = (u8 *)(_octet);           \
2342                 (_os).length = (_len);
2343
2344 #define CP_MACADDR(des, src)    \
2345         ((des)[0] = (src)[0], (des)[1] = (src)[1],\
2346         (des)[2] = (src)[2], (des)[3] = (src)[3],\
2347         (des)[4] = (src)[4], (des)[5] = (src)[5])
2348
2349 static inline u8 rtl_read_byte(struct rtl_priv *rtlpriv, u32 addr)
2350 {
2351         return rtlpriv->io.read8_sync(rtlpriv, addr);
2352 }
2353
2354 static inline u16 rtl_read_word(struct rtl_priv *rtlpriv, u32 addr)
2355 {
2356         return rtlpriv->io.read16_sync(rtlpriv, addr);
2357 }
2358
2359 static inline u32 rtl_read_dword(struct rtl_priv *rtlpriv, u32 addr)
2360 {
2361         return rtlpriv->io.read32_sync(rtlpriv, addr);
2362 }
2363
2364 static inline void rtl_write_byte(struct rtl_priv *rtlpriv, u32 addr, u8 val8)
2365 {
2366         rtlpriv->io.write8_async(rtlpriv, addr, val8);
2367
2368         if (rtlpriv->cfg->write_readback)
2369                 rtlpriv->io.read8_sync(rtlpriv, addr);
2370 }
2371
2372 static inline void rtl_write_word(struct rtl_priv *rtlpriv, u32 addr, u16 val16)
2373 {
2374         rtlpriv->io.write16_async(rtlpriv, addr, val16);
2375
2376         if (rtlpriv->cfg->write_readback)
2377                 rtlpriv->io.read16_sync(rtlpriv, addr);
2378 }
2379
2380 static inline void rtl_write_dword(struct rtl_priv *rtlpriv,
2381                                    u32 addr, u32 val32)
2382 {
2383         rtlpriv->io.write32_async(rtlpriv, addr, val32);
2384
2385         if (rtlpriv->cfg->write_readback)
2386                 rtlpriv->io.read32_sync(rtlpriv, addr);
2387 }
2388
2389 static inline u32 rtl_get_bbreg(struct ieee80211_hw *hw,
2390                                 u32 regaddr, u32 bitmask)
2391 {
2392         struct rtl_priv *rtlpriv = hw->priv;
2393
2394         return rtlpriv->cfg->ops->get_bbreg(hw, regaddr, bitmask);
2395 }
2396
2397 static inline void rtl_set_bbreg(struct ieee80211_hw *hw, u32 regaddr,
2398                                  u32 bitmask, u32 data)
2399 {
2400         struct rtl_priv *rtlpriv = hw->priv;
2401
2402         rtlpriv->cfg->ops->set_bbreg(hw, regaddr, bitmask, data);
2403 }
2404
2405 static inline u32 rtl_get_rfreg(struct ieee80211_hw *hw,
2406                                 enum radio_path rfpath, u32 regaddr,
2407                                 u32 bitmask)
2408 {
2409         struct rtl_priv *rtlpriv = hw->priv;
2410
2411         return rtlpriv->cfg->ops->get_rfreg(hw, rfpath, regaddr, bitmask);
2412 }
2413
2414 static inline void rtl_set_rfreg(struct ieee80211_hw *hw,
2415                                  enum radio_path rfpath, u32 regaddr,
2416                                  u32 bitmask, u32 data)
2417 {
2418         struct rtl_priv *rtlpriv = hw->priv;
2419
2420         rtlpriv->cfg->ops->set_rfreg(hw, rfpath, regaddr, bitmask, data);
2421 }
2422
2423 static inline bool is_hal_stop(struct rtl_hal *rtlhal)
2424 {
2425         return (_HAL_STATE_STOP == rtlhal->state);
2426 }
2427
2428 static inline void set_hal_start(struct rtl_hal *rtlhal)
2429 {
2430         rtlhal->state = _HAL_STATE_START;
2431 }
2432
2433 static inline void set_hal_stop(struct rtl_hal *rtlhal)
2434 {
2435         rtlhal->state = _HAL_STATE_STOP;
2436 }
2437
2438 static inline u8 get_rf_type(struct rtl_phy *rtlphy)
2439 {
2440         return rtlphy->rf_type;
2441 }
2442
2443 static inline struct ieee80211_hdr *rtl_get_hdr(struct sk_buff *skb)
2444 {
2445         return (struct ieee80211_hdr *)(skb->data);
2446 }
2447
2448 static inline __le16 rtl_get_fc(struct sk_buff *skb)
2449 {
2450         return rtl_get_hdr(skb)->frame_control;
2451 }
2452
2453 static inline u16 rtl_get_tid_h(struct ieee80211_hdr *hdr)
2454 {
2455         return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
2456 }
2457
2458 static inline u16 rtl_get_tid(struct sk_buff *skb)
2459 {
2460         return rtl_get_tid_h(rtl_get_hdr(skb));
2461 }
2462
2463 static inline struct ieee80211_sta *get_sta(struct ieee80211_hw *hw,
2464                                             struct ieee80211_vif *vif,
2465                                             const u8 *bssid)
2466 {
2467         return ieee80211_find_sta(vif, bssid);
2468 }
2469
2470 static inline struct ieee80211_sta *rtl_find_sta(struct ieee80211_hw *hw,
2471                 u8 *mac_addr)
2472 {
2473         struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
2474         return ieee80211_find_sta(mac->vif, mac_addr);
2475 }
2476
2477 #endif