drivers/net/wireless/rtlwifi/wifi.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2009-2010  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 #include <linux/sched.h>
  34 #include <linux/firmware.h>
  35 #include <linux/version.h>
  36 #include <linux/etherdevice.h>
  37 #include <linux/usb.h>
  38 #include <net/mac80211.h>
  39 #include "debug.h"
  40
  41 #define RF_CHANGE_BY_INIT                       0
  42 #define RF_CHANGE_BY_IPS                        BIT(28)
  43 #define RF_CHANGE_BY_PS                         BIT(29)
  44 #define RF_CHANGE_BY_HW                         BIT(30)
  45 #define RF_CHANGE_BY_SW                         BIT(31)
  46
  47 #define IQK_ADDA_REG_NUM                        16
  48 #define IQK_MAC_REG_NUM                         4
  49
  50 #define MAX_KEY_LEN                             61
  51 #define KEY_BUF_SIZE                            5
  52
  53 /* QoS related. */
  54 /*aci: 0x00     Best Effort*/
  55 /*aci: 0x01     Background*/
  56 /*aci: 0x10     Video*/
  57 /*aci: 0x11     Voice*/
  58 /*Max: define total number.*/
  59 #define AC0_BE                                  0
  60 #define AC1_BK                                  1
  61 #define AC2_VI                                  2
  62 #define AC3_VO                                  3
  63 #define AC_MAX                                  4
  64 #define QOS_QUEUE_NUM                           4
  65 #define RTL_MAC80211_NUM_QUEUE                  5
  66
  67 #define QBSS_LOAD_SIZE                          5
  68 #define MAX_WMMELE_LENGTH                       64
  69
  70 /*slot time for 11g. */
  71 #define RTL_SLOT_TIME_9                         9
  72 #define RTL_SLOT_TIME_20                        20
  73
  74 /*related with tcp/ip. */
  75 /*if_ehther.h*/
  76 #define ETH_P_PAE               0x888E  /*Port Access Entity (IEEE 802.1X) */
  77 #define ETH_P_IP                0x0800  /*Internet Protocol packet */
  78 #define ETH_P_ARP               0x0806  /*Address Resolution packet */
  79 #define SNAP_SIZE               6
  80 #define PROTOC_TYPE_SIZE        2
  81
  82 /*related with 802.11 frame*/
  83 #define MAC80211_3ADDR_LEN                      24
  84 #define MAC80211_4ADDR_LEN                      30
  85
  86 #define CHANNEL_MAX_NUMBER      (14 + 24 + 21)  /* 14 is the max channel no */
  87 #define CHANNEL_GROUP_MAX       (3 + 9) /*  ch1~3, 4~9, 10~14 = three groups */
  88 #define MAX_PG_GROUP                    13
  89 #define CHANNEL_GROUP_MAX_2G            3
  90 #define CHANNEL_GROUP_IDX_5GL           3
  91 #define CHANNEL_GROUP_IDX_5GM           6
  92 #define CHANNEL_GROUP_IDX_5GH           9
  93 #define CHANNEL_GROUP_MAX_5G            9
  94 #define CHANNEL_MAX_NUMBER_2G           14
  95 #define AVG_THERMAL_NUM                 8
  96
  97 /* for early mode */
  98 #define EM_HDR_LEN                      8
  99 enum intf_type {
 100         INTF_PCI = 0,
 101         INTF_USB = 1,
 102 };
 103
 104 enum radio_path {
 105         RF90_PATH_A = 0,
 106         RF90_PATH_B = 1,
 107         RF90_PATH_C = 2,
 108         RF90_PATH_D = 3,
 109 };
 110
 111 enum rt_eeprom_type {
 112         EEPROM_93C46,
 113         EEPROM_93C56,
 114         EEPROM_BOOT_EFUSE,
 115 };
 116
 117 enum rtl_status {
 118         RTL_STATUS_INTERFACE_START = 0,
 119 };
 120
 121 enum hardware_type {
 122         HARDWARE_TYPE_RTL8192E,
 123         HARDWARE_TYPE_RTL8192U,
 124         HARDWARE_TYPE_RTL8192SE,
 125         HARDWARE_TYPE_RTL8192SU,
 126         HARDWARE_TYPE_RTL8192CE,
 127         HARDWARE_TYPE_RTL8192CU,
 128         HARDWARE_TYPE_RTL8192DE,
 129         HARDWARE_TYPE_RTL8192DU,
 130         HARDWARE_TYPE_RTL8723E,
 131         HARDWARE_TYPE_RTL8723U,
 132
 133         /* keep it last */
 134         HARDWARE_TYPE_NUM
 135 };
 136
 137 #define IS_HARDWARE_TYPE_8192SU(rtlhal)                 \
 138         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192SU)
 139 #define IS_HARDWARE_TYPE_8192SE(rtlhal)                 \
 140         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192SE)
 141 #define IS_HARDWARE_TYPE_8192CE(rtlhal)                 \
 142         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192CE)
 143 #define IS_HARDWARE_TYPE_8192CU(rtlhal)                 \
 144         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192CU)
 145 #define IS_HARDWARE_TYPE_8192DE(rtlhal)                 \
 146         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192DE)
 147 #define IS_HARDWARE_TYPE_8192DU(rtlhal)                 \
 148         (rtlhal->hw_type == HARDWARE_TYPE_RTL8192DU)
 149 #define IS_HARDWARE_TYPE_8723E(rtlhal)                  \
 150         (rtlhal->hw_type == HARDWARE_TYPE_RTL8723E)
 151 #define IS_HARDWARE_TYPE_8723U(rtlhal)                  \
 152         (rtlhal->hw_type == HARDWARE_TYPE_RTL8723U)
 153 #define IS_HARDWARE_TYPE_8192S(rtlhal)                  \
 154 (IS_HARDWARE_TYPE_8192SE(rtlhal) || IS_HARDWARE_TYPE_8192SU(rtlhal))
 155 #define IS_HARDWARE_TYPE_8192C(rtlhal)                  \
 156 (IS_HARDWARE_TYPE_8192CE(rtlhal) || IS_HARDWARE_TYPE_8192CU(rtlhal))
 157 #define IS_HARDWARE_TYPE_8192D(rtlhal)                  \
 158 (IS_HARDWARE_TYPE_8192DE(rtlhal) || IS_HARDWARE_TYPE_8192DU(rtlhal))
 159 #define IS_HARDWARE_TYPE_8723(rtlhal)                   \
 160 (IS_HARDWARE_TYPE_8723E(rtlhal) || IS_HARDWARE_TYPE_8723U(rtlhal))
 161
 162 enum scan_operation_backup_opt {
 163         SCAN_OPT_BACKUP = 0,
 164         SCAN_OPT_RESTORE,
 165         SCAN_OPT_MAX
 166 };
 167
 168 /*RF state.*/
 169 enum rf_pwrstate {
 170         ERFON,
 171         ERFSLEEP,
 172         ERFOFF
 173 };
 174
 175 struct bb_reg_def {
 176         u32 rfintfs;
 177         u32 rfintfi;
 178         u32 rfintfo;
 179         u32 rfintfe;
 180         u32 rf3wire_offset;
 181         u32 rflssi_select;
 182         u32 rftxgain_stage;
 183         u32 rfhssi_para1;
 184         u32 rfhssi_para2;
 185         u32 rfswitch_control;
 186         u32 rfagc_control1;
 187         u32 rfagc_control2;
 188         u32 rfrxiq_imbalance;
 189         u32 rfrx_afe;
 190         u32 rftxiq_imbalance;
 191         u32 rftx_afe;
 192         u32 rflssi_readback;
 193         u32 rflssi_readbackpi;
 194 };
 195
 196 enum io_type {
 197         IO_CMD_PAUSE_DM_BY_SCAN = 0,
 198         IO_CMD_RESUME_DM_BY_SCAN = 1,
 199 };
 200
 201 enum hw_variables {
 202         HW_VAR_ETHER_ADDR,
 203         HW_VAR_MULTICAST_REG,
 204         HW_VAR_BASIC_RATE,
 205         HW_VAR_BSSID,
 206         HW_VAR_MEDIA_STATUS,
 207         HW_VAR_SECURITY_CONF,
 208         HW_VAR_BEACON_INTERVAL,
 209         HW_VAR_ATIM_WINDOW,
 210         HW_VAR_LISTEN_INTERVAL,
 211         HW_VAR_CS_COUNTER,
 212         HW_VAR_DEFAULTKEY0,
 213         HW_VAR_DEFAULTKEY1,
 214         HW_VAR_DEFAULTKEY2,
 215         HW_VAR_DEFAULTKEY3,
 216         HW_VAR_SIFS,
 217         HW_VAR_DIFS,
 218         HW_VAR_EIFS,
 219         HW_VAR_SLOT_TIME,
 220         HW_VAR_ACK_PREAMBLE,
 221         HW_VAR_CW_CONFIG,
 222         HW_VAR_CW_VALUES,
 223         HW_VAR_RATE_FALLBACK_CONTROL,
 224         HW_VAR_CONTENTION_WINDOW,
 225         HW_VAR_RETRY_COUNT,
 226         HW_VAR_TR_SWITCH,
 227         HW_VAR_COMMAND,
 228         HW_VAR_WPA_CONFIG,
 229         HW_VAR_AMPDU_MIN_SPACE,
 230         HW_VAR_SHORTGI_DENSITY,
 231         HW_VAR_AMPDU_FACTOR,
 232         HW_VAR_MCS_RATE_AVAILABLE,
 233         HW_VAR_AC_PARAM,
 234         HW_VAR_ACM_CTRL,
 235         HW_VAR_DIS_Req_Qsize,
 236         HW_VAR_CCX_CHNL_LOAD,
 237         HW_VAR_CCX_NOISE_HISTOGRAM,
 238         HW_VAR_CCX_CLM_NHM,
 239         HW_VAR_TxOPLimit,
 240         HW_VAR_TURBO_MODE,
 241         HW_VAR_RF_STATE,
 242         HW_VAR_RF_OFF_BY_HW,
 243         HW_VAR_BUS_SPEED,
 244         HW_VAR_SET_DEV_POWER,
 245
 246         HW_VAR_RCR,
 247         HW_VAR_RATR_0,
 248         HW_VAR_RRSR,
 249         HW_VAR_CPU_RST,
 250         HW_VAR_CECHK_BSSID,
 251         HW_VAR_LBK_MODE,
 252         HW_VAR_AES_11N_FIX,
 253         HW_VAR_USB_RX_AGGR,
 254         HW_VAR_USER_CONTROL_TURBO_MODE,
 255         HW_VAR_RETRY_LIMIT,
 256         HW_VAR_INIT_TX_RATE,
 257         HW_VAR_TX_RATE_REG,
 258         HW_VAR_EFUSE_USAGE,
 259         HW_VAR_EFUSE_BYTES,
 260         HW_VAR_AUTOLOAD_STATUS,
 261         HW_VAR_RF_2R_DISABLE,
 262         HW_VAR_SET_RPWM,
 263         HW_VAR_H2C_FW_PWRMODE,
 264         HW_VAR_H2C_FW_JOINBSSRPT,
 265         HW_VAR_FW_PSMODE_STATUS,
 266         HW_VAR_1X1_RECV_COMBINE,
 267         HW_VAR_STOP_SEND_BEACON,
 268         HW_VAR_TSF_TIMER,
 269         HW_VAR_IO_CMD,
 270
 271         HW_VAR_RF_RECOVERY,
 272         HW_VAR_H2C_FW_UPDATE_GTK,
 273         HW_VAR_WF_MASK,
 274         HW_VAR_WF_CRC,
 275         HW_VAR_WF_IS_MAC_ADDR,
 276         HW_VAR_H2C_FW_OFFLOAD,
 277         HW_VAR_RESET_WFCRC,
 278
 279         HW_VAR_HANDLE_FW_C2H,
 280         HW_VAR_DL_FW_RSVD_PAGE,
 281         HW_VAR_AID,
 282         HW_VAR_HW_SEQ_ENABLE,
 283         HW_VAR_CORRECT_TSF,
 284         HW_VAR_BCN_VALID,
 285         HW_VAR_FWLPS_RF_ON,
 286         HW_VAR_DUAL_TSF_RST,
 287         HW_VAR_SWITCH_EPHY_WoWLAN,
 288         HW_VAR_INT_MIGRATION,
 289         HW_VAR_INT_AC,
 290         HW_VAR_RF_TIMING,
 291
 292         HW_VAR_MRC,
 293
 294         HW_VAR_MGT_FILTER,
 295         HW_VAR_CTRL_FILTER,
 296         HW_VAR_DATA_FILTER,
 297 };
 298
 299 enum _RT_MEDIA_STATUS {
 300         RT_MEDIA_DISCONNECT = 0,
 301         RT_MEDIA_CONNECT = 1
 302 };
 303
 304 enum rt_oem_id {
 305         RT_CID_DEFAULT = 0,
 306         RT_CID_8187_ALPHA0 = 1,
 307         RT_CID_8187_SERCOMM_PS = 2,
 308         RT_CID_8187_HW_LED = 3,
 309         RT_CID_8187_NETGEAR = 4,
 310         RT_CID_WHQL = 5,
 311         RT_CID_819x_CAMEO = 6,
 312         RT_CID_819x_RUNTOP = 7,
 313         RT_CID_819x_Senao = 8,
 314         RT_CID_TOSHIBA = 9,
 315         RT_CID_819x_Netcore = 10,
 316         RT_CID_Nettronix = 11,
 317         RT_CID_DLINK = 12,
 318         RT_CID_PRONET = 13,
 319         RT_CID_COREGA = 14,
 320         RT_CID_819x_ALPHA = 15,
 321         RT_CID_819x_Sitecom = 16,
 322         RT_CID_CCX = 17,
 323         RT_CID_819x_Lenovo = 18,
 324         RT_CID_819x_QMI = 19,
 325         RT_CID_819x_Edimax_Belkin = 20,
 326         RT_CID_819x_Sercomm_Belkin = 21,
 327         RT_CID_819x_CAMEO1 = 22,
 328         RT_CID_819x_MSI = 23,
 329         RT_CID_819x_Acer = 24,
 330         RT_CID_819x_HP = 27,
 331         RT_CID_819x_CLEVO = 28,
 332         RT_CID_819x_Arcadyan_Belkin = 29,
 333         RT_CID_819x_SAMSUNG = 30,
 334         RT_CID_819x_WNC_COREGA = 31,
 335         RT_CID_819x_Foxcoon = 32,
 336         RT_CID_819x_DELL = 33,
 337 };
 338
 339 enum hw_descs {
 340         HW_DESC_OWN,
 341         HW_DESC_RXOWN,
 342         HW_DESC_TX_NEXTDESC_ADDR,
 343         HW_DESC_TXBUFF_ADDR,
 344         HW_DESC_RXBUFF_ADDR,
 345         HW_DESC_RXPKT_LEN,
 346         HW_DESC_RXERO,
 347 };
 348
 349 enum prime_sc {
 350         PRIME_CHNL_OFFSET_DONT_CARE = 0,
 351         PRIME_CHNL_OFFSET_LOWER = 1,
 352         PRIME_CHNL_OFFSET_UPPER = 2,
 353 };
 354
 355 enum rf_type {
 356         RF_1T1R = 0,
 357         RF_1T2R = 1,
 358         RF_2T2R = 2,
 359         RF_2T2R_GREEN = 3,
 360 };
 361
 362 enum ht_channel_width {
 363         HT_CHANNEL_WIDTH_20 = 0,
 364         HT_CHANNEL_WIDTH_20_40 = 1,
 365 };
 366
 367 /* Ref: 802.11i sepc D10.0 7.3.2.25.1
 368 Cipher Suites Encryption Algorithms */
 369 enum rt_enc_alg {
 370         NO_ENCRYPTION = 0,
 371         WEP40_ENCRYPTION = 1,
 372         TKIP_ENCRYPTION = 2,
 373         RSERVED_ENCRYPTION = 3,
 374         AESCCMP_ENCRYPTION = 4,
 375         WEP104_ENCRYPTION = 5,
 376 };
 377
 378 enum rtl_hal_state {
 379         _HAL_STATE_STOP = 0,
 380         _HAL_STATE_START = 1,
 381 };
 382
 383 enum rtl_var_map {
 384         /*reg map */
 385         SYS_ISO_CTRL = 0,
 386         SYS_FUNC_EN,
 387         SYS_CLK,
 388         MAC_RCR_AM,
 389         MAC_RCR_AB,
 390         MAC_RCR_ACRC32,
 391         MAC_RCR_ACF,
 392         MAC_RCR_AAP,
 393
 394         /*efuse map */
 395         EFUSE_TEST,
 396         EFUSE_CTRL,
 397         EFUSE_CLK,
 398         EFUSE_CLK_CTRL,
 399         EFUSE_PWC_EV12V,
 400         EFUSE_FEN_ELDR,
 401         EFUSE_LOADER_CLK_EN,
 402         EFUSE_ANA8M,
 403         EFUSE_HWSET_MAX_SIZE,
 404         EFUSE_MAX_SECTION_MAP,
 405         EFUSE_REAL_CONTENT_SIZE,
 406
 407         /*CAM map */
 408         RWCAM,
 409         WCAMI,
 410         RCAMO,
 411         CAMDBG,
 412         SECR,
 413         SEC_CAM_NONE,
 414         SEC_CAM_WEP40,
 415         SEC_CAM_TKIP,
 416         SEC_CAM_AES,
 417         SEC_CAM_WEP104,
 418
 419         /*IMR map */
 420         RTL_IMR_BCNDMAINT6,     /*Beacon DMA Interrupt 6 */
 421         RTL_IMR_BCNDMAINT5,     /*Beacon DMA Interrupt 5 */
 422         RTL_IMR_BCNDMAINT4,     /*Beacon DMA Interrupt 4 */
 423         RTL_IMR_BCNDMAINT3,     /*Beacon DMA Interrupt 3 */
 424         RTL_IMR_BCNDMAINT2,     /*Beacon DMA Interrupt 2 */
 425         RTL_IMR_BCNDMAINT1,     /*Beacon DMA Interrupt 1 */
 426         RTL_IMR_BCNDOK8,        /*Beacon Queue DMA OK Interrup 8 */
 427         RTL_IMR_BCNDOK7,        /*Beacon Queue DMA OK Interrup 7 */
 428         RTL_IMR_BCNDOK6,        /*Beacon Queue DMA OK Interrup 6 */
 429         RTL_IMR_BCNDOK5,        /*Beacon Queue DMA OK Interrup 5 */
 430         RTL_IMR_BCNDOK4,        /*Beacon Queue DMA OK Interrup 4 */
 431         RTL_IMR_BCNDOK3,        /*Beacon Queue DMA OK Interrup 3 */
 432         RTL_IMR_BCNDOK2,        /*Beacon Queue DMA OK Interrup 2 */
 433         RTL_IMR_BCNDOK1,        /*Beacon Queue DMA OK Interrup 1 */
 434         RTL_IMR_TIMEOUT2,       /*Timeout interrupt 2 */
 435         RTL_IMR_TIMEOUT1,       /*Timeout interrupt 1 */
 436         RTL_IMR_TXFOVW,         /*Transmit FIFO Overflow */
 437         RTL_IMR_PSTIMEOUT,      /*Power save time out interrupt */
 438         RTL_IMR_BcnInt,         /*Beacon DMA Interrupt 0 */
 439         RTL_IMR_RXFOVW,         /*Receive FIFO Overflow */
 440         RTL_IMR_RDU,            /*Receive Descriptor Unavailable */
 441         RTL_IMR_ATIMEND,        /*For 92C,ATIM Window End Interrupt */
 442         RTL_IMR_BDOK,           /*Beacon Queue DMA OK Interrup */
 443         RTL_IMR_HIGHDOK,        /*High Queue DMA OK Interrupt */
 444         RTL_IMR_COMDOK,         /*Command Queue DMA OK Interrupt*/
 445         RTL_IMR_TBDOK,          /*Transmit Beacon OK interrup */
 446         RTL_IMR_MGNTDOK,        /*Management Queue DMA OK Interrupt */
 447         RTL_IMR_TBDER,          /*For 92C,Transmit Beacon Error Interrupt */
 448         RTL_IMR_BKDOK,          /*AC_BK DMA OK Interrupt */
 449         RTL_IMR_BEDOK,          /*AC_BE DMA OK Interrupt */
 450         RTL_IMR_VIDOK,          /*AC_VI DMA OK Interrupt */
 451         RTL_IMR_VODOK,          /*AC_VO DMA Interrupt */
 452         RTL_IMR_ROK,            /*Receive DMA OK Interrupt */
 453         RTL_IBSS_INT_MASKS,     /*(RTL_IMR_BcnInt | RTL_IMR_TBDOK |
 454                                  * RTL_IMR_TBDER) */
 455
 456         /*CCK Rates, TxHT = 0 */
 457         RTL_RC_CCK_RATE1M,
 458         RTL_RC_CCK_RATE2M,
 459         RTL_RC_CCK_RATE5_5M,
 460         RTL_RC_CCK_RATE11M,
 461
 462         /*OFDM Rates, TxHT = 0 */
 463         RTL_RC_OFDM_RATE6M,
 464         RTL_RC_OFDM_RATE9M,
 465         RTL_RC_OFDM_RATE12M,
 466         RTL_RC_OFDM_RATE18M,
 467         RTL_RC_OFDM_RATE24M,
 468         RTL_RC_OFDM_RATE36M,
 469         RTL_RC_OFDM_RATE48M,
 470         RTL_RC_OFDM_RATE54M,
 471
 472         RTL_RC_HT_RATEMCS7,
 473         RTL_RC_HT_RATEMCS15,
 474
 475         /*keep it last */
 476         RTL_VAR_MAP_MAX,
 477 };
 478
 479 /*Firmware PS mode for control LPS.*/
 480 enum _fw_ps_mode {
 481         FW_PS_ACTIVE_MODE = 0,
 482         FW_PS_MIN_MODE = 1,
 483         FW_PS_MAX_MODE = 2,
 484         FW_PS_DTIM_MODE = 3,
 485         FW_PS_VOIP_MODE = 4,
 486         FW_PS_UAPSD_WMM_MODE = 5,
 487         FW_PS_UAPSD_MODE = 6,
 488         FW_PS_IBSS_MODE = 7,
 489         FW_PS_WWLAN_MODE = 8,
 490         FW_PS_PM_Radio_Off = 9,
 491         FW_PS_PM_Card_Disable = 10,
 492 };
 493
 494 enum rt_psmode {
 495         EACTIVE,                /*Active/Continuous access. */
 496         EMAXPS,                 /*Max power save mode. */
 497         EFASTPS,                /*Fast power save mode. */
 498         EAUTOPS,                /*Auto power save mode. */
 499 };
 500
 501 /*LED related.*/
 502 enum led_ctl_mode {
 503         LED_CTL_POWER_ON = 1,
 504         LED_CTL_LINK = 2,
 505         LED_CTL_NO_LINK = 3,
 506         LED_CTL_TX = 4,
 507         LED_CTL_RX = 5,
 508         LED_CTL_SITE_SURVEY = 6,
 509         LED_CTL_POWER_OFF = 7,
 510         LED_CTL_START_TO_LINK = 8,
 511         LED_CTL_START_WPS = 9,
 512         LED_CTL_STOP_WPS = 10,
 513 };
 514
 515 enum rtl_led_pin {
 516         LED_PIN_GPIO0,
 517         LED_PIN_LED0,
 518         LED_PIN_LED1,
 519         LED_PIN_LED2
 520 };
 521
 522 /*QoS related.*/
 523 /*acm implementation method.*/
 524 enum acm_method {
 525         eAcmWay0_SwAndHw = 0,
 526         eAcmWay1_HW = 1,
 527         eAcmWay2_SW = 2,
 528 };
 529
 530 enum macphy_mode {
 531         SINGLEMAC_SINGLEPHY = 0,
 532         DUALMAC_DUALPHY,
 533         DUALMAC_SINGLEPHY,
 534 };
 535
 536 enum band_type {
 537         BAND_ON_2_4G = 0,
 538         BAND_ON_5G,
 539         BAND_ON_BOTH,
 540         BANDMAX
 541 };
 542
 543 /*aci/aifsn Field.
 544 Ref: WMM spec 2.2.2: WME Parameter Element, p.12.*/
 545 union aci_aifsn {
 546         u8 char_data;
 547
 548         struct {
 549                 u8 aifsn:4;
 550                 u8 acm:1;
 551                 u8 aci:2;
 552                 u8 reserved:1;
 553         } f;                    /* Field */
 554 };
 555
 556 /*mlme related.*/
 557 enum wireless_mode {
 558         WIRELESS_MODE_UNKNOWN = 0x00,
 559         WIRELESS_MODE_A = 0x01,
 560         WIRELESS_MODE_B = 0x02,
 561         WIRELESS_MODE_G = 0x04,
 562         WIRELESS_MODE_AUTO = 0x08,
 563         WIRELESS_MODE_N_24G = 0x10,
 564         WIRELESS_MODE_N_5G = 0x20
 565 };
 566
 567 #define IS_WIRELESS_MODE_A(wirelessmode)        \
 568         (wirelessmode == WIRELESS_MODE_A)
 569 #define IS_WIRELESS_MODE_B(wirelessmode)        \
 570         (wirelessmode == WIRELESS_MODE_B)
 571 #define IS_WIRELESS_MODE_G(wirelessmode)        \
 572         (wirelessmode == WIRELESS_MODE_G)
 573 #define IS_WIRELESS_MODE_N_24G(wirelessmode)    \
 574         (wirelessmode == WIRELESS_MODE_N_24G)
 575 #define IS_WIRELESS_MODE_N_5G(wirelessmode)     \
 576         (wirelessmode == WIRELESS_MODE_N_5G)
 577
 578 enum ratr_table_mode {
 579         RATR_INX_WIRELESS_NGB = 0,
 580         RATR_INX_WIRELESS_NG = 1,
 581         RATR_INX_WIRELESS_NB = 2,
 582         RATR_INX_WIRELESS_N = 3,
 583         RATR_INX_WIRELESS_GB = 4,
 584         RATR_INX_WIRELESS_G = 5,
 585         RATR_INX_WIRELESS_B = 6,
 586         RATR_INX_WIRELESS_MC = 7,
 587         RATR_INX_WIRELESS_A = 8,
 588 };
 589
 590 enum rtl_link_state {
 591         MAC80211_NOLINK = 0,
 592         MAC80211_LINKING = 1,
 593         MAC80211_LINKED = 2,
 594         MAC80211_LINKED_SCANNING = 3,
 595 };
 596
 597 enum act_category {
 598         ACT_CAT_QOS = 1,
 599         ACT_CAT_DLS = 2,
 600         ACT_CAT_BA = 3,
 601         ACT_CAT_HT = 7,
 602         ACT_CAT_WMM = 17,
 603 };
 604
 605 enum ba_action {
 606         ACT_ADDBAREQ = 0,
 607         ACT_ADDBARSP = 1,
 608         ACT_DELBA = 2,
 609 };
 610
 611 struct octet_string {
 612         u8 *octet;
 613         u16 length;
 614 };
 615
 616 struct rtl_hdr_3addr {
 617         __le16 frame_ctl;
 618         __le16 duration_id;
 619         u8 addr1[ETH_ALEN];
 620         u8 addr2[ETH_ALEN];
 621         u8 addr3[ETH_ALEN];
 622         __le16 seq_ctl;
 623         u8 payload[0];
 624 } __packed;
 625
 626 struct rtl_info_element {
 627         u8 id;
 628         u8 len;
 629         u8 data[0];
 630 } __packed;
 631
 632 struct rtl_probe_rsp {
 633         struct rtl_hdr_3addr header;
 634         u32 time_stamp[2];
 635         __le16 beacon_interval;
 636         __le16 capability;
 637         /*SSID, supported rates, FH params, DS params,
 638            CF params, IBSS params, TIM (if beacon), RSN */
 639         struct rtl_info_element info_element[0];
 640 } __packed;
 641
 642 /*LED related.*/
 643 /*ledpin Identify how to implement this SW led.*/
 644 struct rtl_led {
 645         void *hw;
 646         enum rtl_led_pin ledpin;
 647         bool ledon;
 648 };
 649
 650 struct rtl_led_ctl {
 651         bool led_opendrain;
 652         struct rtl_led sw_led0;
 653         struct rtl_led sw_led1;
 654 };
 655
 656 struct rtl_qos_parameters {
 657         __le16 cw_min;
 658         __le16 cw_max;
 659         u8 aifs;
 660         u8 flag;
 661         __le16 tx_op;
 662 } __packed;
 663
 664 struct rt_smooth_data {
 665         u32 elements[100];      /*array to store values */
 666         u32 index;              /*index to current array to store */
 667         u32 total_num;          /*num of valid elements */
 668         u32 total_val;          /*sum of valid elements */
 669 };
 670
 671 struct false_alarm_statistics {
 672         u32 cnt_parity_fail;
 673         u32 cnt_rate_illegal;
 674         u32 cnt_crc8_fail;
 675         u32 cnt_mcs_fail;
 676         u32 cnt_fast_fsync_fail;
 677         u32 cnt_sb_search_fail;
 678         u32 cnt_ofdm_fail;
 679         u32 cnt_cck_fail;
 680         u32 cnt_all;
 681 };
 682
 683 struct init_gain {
 684         u8 xaagccore1;
 685         u8 xbagccore1;
 686         u8 xcagccore1;
 687         u8 xdagccore1;
 688         u8 cca;
 689
 690 };
 691
 692 struct wireless_stats {
 693         unsigned long txbytesunicast;
 694         unsigned long txbytesmulticast;
 695         unsigned long txbytesbroadcast;
 696         unsigned long rxbytesunicast;
 697
 698         long rx_snr_db[4];
 699         /*Correct smoothed ss in Dbm, only used
 700            in driver to report real power now. */
 701         long recv_signal_power;
 702         long signal_quality;
 703         long last_sigstrength_inpercent;
 704
 705         u32 rssi_calculate_cnt;
 706
 707         /*Transformed, in dbm. Beautified signal
 708            strength for UI, not correct. */
 709         long signal_strength;
 710
 711         u8 rx_rssi_percentage[4];
 712         u8 rx_evm_percentage[2];
 713
 714         struct rt_smooth_data ui_rssi;
 715         struct rt_smooth_data ui_link_quality;
 716 };
 717
 718 struct rate_adaptive {
 719         u8 rate_adaptive_disabled;
 720         u8 ratr_state;
 721         u16 reserve;
 722
 723         u32 high_rssi_thresh_for_ra;
 724         u32 high2low_rssi_thresh_for_ra;
 725         u8 low2high_rssi_thresh_for_ra40m;
 726         u32 low_rssi_thresh_for_ra40M;
 727         u8 low2high_rssi_thresh_for_ra20m;
 728         u32 low_rssi_thresh_for_ra20M;
 729         u32 upper_rssi_threshold_ratr;
 730         u32 middleupper_rssi_threshold_ratr;
 731         u32 middle_rssi_threshold_ratr;
 732         u32 middlelow_rssi_threshold_ratr;
 733         u32 low_rssi_threshold_ratr;
 734         u32 ultralow_rssi_threshold_ratr;
 735         u32 low_rssi_threshold_ratr_40m;
 736         u32 low_rssi_threshold_ratr_20m;
 737         u8 ping_rssi_enable;
 738         u32 ping_rssi_ratr;
 739         u32 ping_rssi_thresh_for_ra;
 740         u32 last_ratr;
 741         u8 pre_ratr_state;
 742 };
 743
 744 struct regd_pair_mapping {
 745         u16 reg_dmnenum;
 746         u16 reg_5ghz_ctl;
 747         u16 reg_2ghz_ctl;
 748 };
 749
 750 struct rtl_regulatory {
 751         char alpha2[2];
 752         u16 country_code;
 753         u16 max_power_level;
 754         u32 tp_scale;
 755         u16 current_rd;
 756         u16 current_rd_ext;
 757         int16_t power_limit;
 758         struct regd_pair_mapping *regpair;
 759 };
 760
 761 struct rtl_rfkill {
 762         bool rfkill_state;      /*0 is off, 1 is on */
 763 };
 764
 765 #define IQK_MATRIX_REG_NUM      8
 766 #define IQK_MATRIX_SETTINGS_NUM (1 + 24 + 21)
 767 struct iqk_matrix_regs {
 768         bool b_iqk_done;
 769         long value[1][IQK_MATRIX_REG_NUM];
 770 };
 771
 772 struct phy_parameters {
 773         u16 length;
 774         u32 *pdata;
 775 };
 776
 777 enum hw_param_tab_index {
 778         PHY_REG_2T,
 779         PHY_REG_1T,
 780         PHY_REG_PG,
 781         RADIOA_2T,
 782         RADIOB_2T,
 783         RADIOA_1T,
 784         RADIOB_1T,
 785         MAC_REG,
 786         AGCTAB_2T,
 787         AGCTAB_1T,
 788         MAX_TAB
 789 };
 790
 791 struct rtl_phy {
 792         struct bb_reg_def phyreg_def[4];        /*Radio A/B/C/D */
 793         struct init_gain initgain_backup;
 794         enum io_type current_io_type;
 795
 796         u8 rf_mode;
 797         u8 rf_type;
 798         u8 current_chan_bw;
 799         u8 set_bwmode_inprogress;
 800         u8 sw_chnl_inprogress;
 801         u8 sw_chnl_stage;
 802         u8 sw_chnl_step;
 803         u8 current_channel;
 804         u8 h2c_box_num;
 805         u8 set_io_inprogress;
 806         u8 lck_inprogress;
 807
 808         /* record for power tracking */
 809         s32 reg_e94;
 810         s32 reg_e9c;
 811         s32 reg_ea4;
 812         s32 reg_eac;
 813         s32 reg_eb4;
 814         s32 reg_ebc;
 815         s32 reg_ec4;
 816         s32 reg_ecc;
 817         u8 rfpienable;
 818         u8 reserve_0;
 819         u16 reserve_1;
 820         u32 reg_c04, reg_c08, reg_874;
 821         u32 adda_backup[16];
 822         u32 iqk_mac_backup[IQK_MAC_REG_NUM];
 823         u32 iqk_bb_backup[10];
 824
 825         /* Dual mac */
 826         bool need_iqk;
 827         struct iqk_matrix_regs iqk_matrix_regsetting[IQK_MATRIX_SETTINGS_NUM];
 828
 829         bool rfpi_enable;
 830
 831         u8 pwrgroup_cnt;
 832         u8 cck_high_power;
 833         /* MAX_PG_GROUP groups of pwr diff by rates */
 834         u32 mcs_txpwrlevel_origoffset[MAX_PG_GROUP][16];
 835         u8 default_initialgain[4];
 836
 837         /* the current Tx power level */
 838         u8 cur_cck_txpwridx;
 839         u8 cur_ofdm24g_txpwridx;
 840
 841         u32 rfreg_chnlval[2];
 842         bool apk_done;
 843         u32 reg_rf3c[2];        /* pathA / pathB  */
 844
 845         u8 framesync;
 846         u32 framesync_c34;
 847
 848         u8 num_total_rfpath;
 849         struct phy_parameters hwparam_tables[MAX_TAB];
 850         u16 rf_pathmap;
 851 };
 852
 853 #define MAX_TID_COUNT                           9
 854 #define RTL_AGG_OFF                             0
 855 #define RTL_AGG_ON                              1
 856 #define RTL_AGG_EMPTYING_HW_QUEUE_ADDBA         2
 857 #define RTL_AGG_EMPTYING_HW_QUEUE_DELBA         3
 858
 859 struct rtl_ht_agg {
 860         u16 txq_id;
 861         u16 wait_for_ba;
 862         u16 start_idx;
 863         u64 bitmap;
 864         u32 rate_n_flags;
 865         u8 agg_state;
 866 };
 867
 868 struct rtl_tid_data {
 869         u16 seq_number;
 870         struct rtl_ht_agg agg;
 871 };
 872
 873 struct rtl_priv;
 874 struct rtl_io {
 875         struct device *dev;
 876         struct mutex bb_mutex;
 877
 878         /*PCI MEM map */
 879         unsigned long pci_mem_end;      /*shared mem end        */
 880         unsigned long pci_mem_start;    /*shared mem start */
 881
 882         /*PCI IO map */
 883         unsigned long pci_base_addr;    /*device I/O address */
 884
 885         void (*write8_async) (struct rtl_priv *rtlpriv, u32 addr, u8 val);
 886         void (*write16_async) (struct rtl_priv *rtlpriv, u32 addr, u16 val);
 887         void (*write32_async) (struct rtl_priv *rtlpriv, u32 addr, u32 val);
 888         int (*writeN_async) (struct rtl_priv *rtlpriv, u32 addr, u16 len,
 889                              u8 *pdata);
 890
 891         u8(*read8_sync) (struct rtl_priv *rtlpriv, u32 addr);
 892         u16(*read16_sync) (struct rtl_priv *rtlpriv, u32 addr);
 893         u32(*read32_sync) (struct rtl_priv *rtlpriv, u32 addr);
 894         int (*readN_sync) (struct rtl_priv *rtlpriv, u32 addr, u16 len,
 895                             u8 *pdata);
 896 };
 897
 898 struct rtl_mac {
 899         u8 mac_addr[ETH_ALEN];
 900         u8 mac80211_registered;
 901         u8 beacon_enabled;
 902
 903         u32 tx_ss_num;
 904         u32 rx_ss_num;
 905
 906         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 907         struct ieee80211_hw *hw;
 908         struct ieee80211_vif *vif;
 909         enum nl80211_iftype opmode;
 910
 911         /*Probe Beacon management */
 912         struct rtl_tid_data tids[MAX_TID_COUNT];
 913         enum rtl_link_state link_state;
 914
 915         int n_channels;
 916         int n_bitrates;
 917
 918         /*filters */
 919         u32 rx_conf;
 920         u16 rx_mgt_filter;
 921         u16 rx_ctrl_filter;
 922         u16 rx_data_filter;
 923
 924         bool act_scanning;
 925         u8 cnt_after_linked;
 926
 927         /* early mode */
 928         /* skb wait queue */
 929         struct sk_buff_head skb_waitq[MAX_TID_COUNT];
 930         u8 earlymode_threshold;
 931
 932         /*RDG*/
 933         bool rdg_en;
 934
 935         /*AP*/
 936         u8 bssid[6];
 937         u32 vendor;
 938         u8 mcs[16];     /* 16 bytes mcs for HT rates. */
 939         u32 basic_rates; /* b/g rates */
 940         u8 ht_enable;
 941         u8 sgi_40;
 942         u8 sgi_20;
 943         u8 bw_40;
 944         u8 mode;                /* wireless mode */
 945         u8 slot_time;
 946         u8 short_preamble;
 947         u8 use_cts_protect;
 948         u8 cur_40_prime_sc;
 949         u8 cur_40_prime_sc_bk;
 950         u64 tsf;
 951         u8 retry_short;
 952         u8 retry_long;
 953         u16 assoc_id;
 954
 955         /*IBSS*/
 956         int beacon_interval;
 957
 958         /*AMPDU*/
 959         u8 min_space_cfg;       /*For Min spacing configurations */
 960         u8 max_mss_density;
 961         u8 current_ampdu_factor;
 962         u8 current_ampdu_density;
 963
 964         /*QOS & EDCA */
 965         struct ieee80211_tx_queue_params edca_param[RTL_MAC80211_NUM_QUEUE];
 966         struct rtl_qos_parameters ac[AC_MAX];
 967 };
 968
 969 struct rtl_hal {
 970         struct ieee80211_hw *hw;
 971
 972         enum intf_type interface;
 973         u16 hw_type;            /*92c or 92d or 92s and so on */
 974         u8 ic_class;
 975         u8 oem_id;
 976         u32 version;            /*version of chip */
 977         u8 state;               /*stop 0, start 1 */
 978
 979         /*firmware */
 980         u32 fwsize;
 981         u8 *pfirmware;
 982         u16 fw_version;
 983         u16 fw_subversion;
 984         bool h2c_setinprogress;
 985         u8 last_hmeboxnum;
 986         bool fw_ready;
 987         /*Reserve page start offset except beacon in TxQ. */
 988         u8 fw_rsvdpage_startoffset;
 989         u8 h2c_txcmd_seq;
 990
 991         /* FW Cmd IO related */
 992         u16 fwcmd_iomap;
 993         u32 fwcmd_ioparam;
 994         bool set_fwcmd_inprogress;
 995         u8 current_fwcmd_io;
 996
 997         /**/
 998         bool driver_going2unload;
 999
1000         /*AMPDU init min space*/
1001         u8 minspace_cfg;        /*For Min spacing configurations */
1002
1003         /* Dual mac */
1004         enum macphy_mode macphymode;
1005         enum band_type current_bandtype;        /* 0:2.4G, 1:5G */
1006         enum band_type current_bandtypebackup;
1007         enum band_type bandset;
1008         /* dual MAC 0--Mac0 1--Mac1 */
1009         u32 interfaceindex;
1010         /* just for DualMac S3S4 */
1011         u8 macphyctl_reg;
1012         bool earlymode_enable;
1013         /* Dual mac*/
1014         bool during_mac0init_radiob;
1015         bool during_mac1init_radioa;
1016         bool reloadtxpowerindex;
1017         /* True if IMR or IQK  have done
1018         for 2.4G in scan progress */
1019         bool load_imrandiqk_setting_for2g;
1020
1021         bool disable_amsdu_8k;
1022 };
1023
1024 struct rtl_security {
1025         /*default 0 */
1026         bool use_sw_sec;
1027
1028         bool being_setkey;
1029         bool use_defaultkey;
1030         /*Encryption Algorithm for Unicast Packet */
1031         enum rt_enc_alg pairwise_enc_algorithm;
1032         /*Encryption Algorithm for Brocast/Multicast */
1033         enum rt_enc_alg group_enc_algorithm;
1034
1035         /*local Key buffer, indx 0 is for
1036            pairwise key 1-4 is for agoup key. */
1037         u8 key_buf[KEY_BUF_SIZE][MAX_KEY_LEN];
1038         u8 key_len[KEY_BUF_SIZE];
1039
1040         /*The pointer of Pairwise Key,
1041            it always points to KeyBuf[4] */
1042         u8 *pairwise_key;
1043 };
1044
1045 struct rtl_dm {
1046         /*PHY status for Dynamic Management */
1047         long entry_min_undecoratedsmoothed_pwdb;
1048         long undecorated_smoothed_pwdb; /*out dm */
1049         long entry_max_undecoratedsmoothed_pwdb;
1050         bool dm_initialgain_enable;
1051         bool dynamic_txpower_enable;
1052         bool current_turbo_edca;
1053         bool is_any_nonbepkts;  /*out dm */
1054         bool is_cur_rdlstate;
1055         bool txpower_trackingInit;
1056         bool disable_framebursting;
1057         bool cck_inch14;
1058         bool txpower_tracking;
1059         bool useramask;
1060         bool rfpath_rxenable[4];
1061         bool inform_fw_driverctrldm;
1062         bool current_mrc_switch;
1063         u8 txpowercount;
1064
1065         u8 thermalvalue_rxgain;
1066         u8 thermalvalue_iqk;
1067         u8 thermalvalue_lck;
1068         u8 thermalvalue;
1069         u8 last_dtp_lvl;
1070         u8 thermalvalue_avg[AVG_THERMAL_NUM];
1071         u8 thermalvalue_avg_index;
1072         bool done_txpower;
1073         u8 dynamic_txhighpower_lvl;     /*Tx high power level */
1074         u8 dm_flag;             /*Indicate each dynamic mechanism's status. */
1075         u8 dm_type;
1076         u8 txpower_track_control;
1077         bool interrupt_migration;
1078         bool disable_tx_int;
1079         char ofdm_index[2];
1080         char cck_index;
1081         u8 power_index_backup[6];
1082 };
1083
1084 #define EFUSE_MAX_LOGICAL_SIZE                  256
1085
1086 struct rtl_efuse {
1087         bool autoLoad_ok;
1088         bool bootfromefuse;
1089         u16 max_physical_size;
1090
1091         u8 efuse_map[2][EFUSE_MAX_LOGICAL_SIZE];
1092         u16 efuse_usedbytes;
1093         u8 efuse_usedpercentage;
1094 #ifdef EFUSE_REPG_WORKAROUND
1095         bool efuse_re_pg_sec1flag;
1096         u8 efuse_re_pg_data[8];
1097 #endif
1098
1099         u8 autoload_failflag;
1100         u8 autoload_status;
1101
1102         short epromtype;
1103         u16 eeprom_vid;
1104         u16 eeprom_did;
1105         u16 eeprom_svid;
1106         u16 eeprom_smid;
1107         u8 eeprom_oemid;
1108         u16 eeprom_channelplan;
1109         u8 eeprom_version;
1110         u8 board_type;
1111         u8 external_pa;
1112
1113         u8 dev_addr[6];
1114
1115         bool txpwr_fromeprom;
1116         u8 eeprom_crystalcap;
1117         u8 eeprom_tssi[2];
1118         u8 eeprom_tssi_5g[3][2]; /* for 5GL/5GM/5GH band. */
1119         u8 eeprom_pwrlimit_ht20[CHANNEL_GROUP_MAX];
1120         u8 eeprom_pwrlimit_ht40[CHANNEL_GROUP_MAX];
1121         u8 eeprom_chnlarea_txpwr_cck[2][CHANNEL_GROUP_MAX_2G];
1122         u8 eeprom_chnlarea_txpwr_ht40_1s[2][CHANNEL_GROUP_MAX];
1123         u8 eeprom_chnlarea_txpwr_ht40_2sdiif[2][CHANNEL_GROUP_MAX];
1124         u8 txpwrlevel_cck[2][CHANNEL_MAX_NUMBER_2G];
1125         u8 txpwrlevel_ht40_1s[2][CHANNEL_MAX_NUMBER];   /*For HT 40MHZ pwr */
1126         u8 txpwrlevel_ht40_2s[2][CHANNEL_MAX_NUMBER];   /*For HT 40MHZ pwr */
1127
1128         u8 internal_pa_5g[2];   /* pathA / pathB */
1129         u8 eeprom_c9;
1130         u8 eeprom_cc;
1131
1132         /*For power group */
1133         u8 eeprom_pwrgroup[2][3];
1134         u8 pwrgroup_ht20[2][CHANNEL_MAX_NUMBER];
1135         u8 pwrgroup_ht40[2][CHANNEL_MAX_NUMBER];
1136
1137         char txpwr_ht20diff[2][CHANNEL_MAX_NUMBER]; /*HT 20<->40 Pwr diff */
1138         /*For HT<->legacy pwr diff*/
1139         u8 txpwr_legacyhtdiff[2][CHANNEL_MAX_NUMBER];
1140         u8 txpwr_safetyflag;                    /* Band edge enable flag */
1141         u16 eeprom_txpowerdiff;
1142         u8 legacy_httxpowerdiff;        /* Legacy to HT rate power diff */
1143         u8 antenna_txpwdiff[3];
1144
1145         u8 eeprom_regulatory;
1146         u8 eeprom_thermalmeter;
1147         u8 thermalmeter[2]; /*ThermalMeter, index 0 for RFIC0, 1 for RFIC1 */
1148         u16 tssi_13dbm;
1149         u8 crystalcap;          /* CrystalCap. */
1150         u8 delta_iqk;
1151         u8 delta_lck;
1152
1153         u8 legacy_ht_txpowerdiff;       /*Legacy to HT rate power diff */
1154         bool apk_thermalmeterignore;
1155
1156         bool b1x1_recvcombine;
1157         bool b1ss_support;
1158
1159         /*channel plan */
1160         u8 channel_plan;
1161 };
1162
1163 struct rtl_ps_ctl {
1164         bool pwrdomain_protect;
1165         bool set_rfpowerstate_inprogress;
1166         bool in_powersavemode;
1167         bool rfchange_inprogress;
1168         bool swrf_processing;
1169         bool hwradiooff;
1170
1171         /*
1172          * just for PCIE ASPM
1173          * If it supports ASPM, Offset[560h] = 0x40,
1174          * otherwise Offset[560h] = 0x00.
1175          * */
1176         bool support_aspm;
1177         bool support_backdoor;
1178
1179         /*for LPS */
1180         enum rt_psmode dot11_psmode;    /*Power save mode configured. */
1181         bool swctrl_lps;
1182         bool leisure_ps;
1183         bool fwctrl_lps;
1184         u8 fwctrl_psmode;
1185         /*For Fw control LPS mode */
1186         u8 reg_fwctrl_lps;
1187         /*Record Fw PS mode status. */
1188         bool fw_current_inpsmode;
1189         u8 reg_max_lps_awakeintvl;
1190         bool report_linked;
1191
1192         /*for IPS */
1193         bool inactiveps;
1194
1195         u32 rfoff_reason;
1196
1197         /*RF OFF Level */
1198         u32 cur_ps_level;
1199         u32 reg_rfps_level;
1200
1201         /*just for PCIE ASPM */
1202         u8 const_amdpci_aspm;
1203
1204         bool pwrdown_mode;
1205
1206         enum rf_pwrstate inactive_pwrstate;
1207         enum rf_pwrstate rfpwr_state;   /*cur power state */
1208
1209         /* for SW LPS*/
1210         bool sw_ps_enabled;
1211         bool state;
1212         bool state_inap;
1213         bool multi_buffered;
1214         u16 nullfunc_seq;
1215         unsigned int dtim_counter;
1216         unsigned int sleep_ms;
1217         unsigned long last_sleep_jiffies;
1218         unsigned long last_awake_jiffies;
1219         unsigned long last_delaylps_stamp_jiffies;
1220         unsigned long last_dtim;
1221         unsigned long last_beacon;
1222         unsigned long last_action;
1223         unsigned long last_slept;
1224 };
1225
1226 struct rtl_stats {
1227         u32 mac_time[2];
1228         s8 rssi;
1229         u8 signal;
1230         u8 noise;
1231         u16 rate;               /*in 100 kbps */
1232         u8 received_channel;
1233         u8 control;
1234         u8 mask;
1235         u8 freq;
1236         u16 len;
1237         u64 tsf;
1238         u32 beacon_time;
1239         u8 nic_type;
1240         u16 length;
1241         u8 signalquality;       /*in 0-100 index. */
1242         /*
1243          * Real power in dBm for this packet,
1244          * no beautification and aggregation.
1245          * */
1246         s32 recvsignalpower;
1247         s8 rxpower;             /*in dBm Translate from PWdB */
1248         u8 signalstrength;      /*in 0-100 index. */
1249         u16 hwerror:1;
1250         u16 crc:1;
1251         u16 icv:1;
1252         u16 shortpreamble:1;
1253         u16 antenna:1;
1254         u16 decrypted:1;
1255         u16 wakeup:1;
1256         u32 timestamp_low;
1257         u32 timestamp_high;
1258
1259         u8 rx_drvinfo_size;
1260         u8 rx_bufshift;
1261         bool isampdu;
1262         bool isfirst_ampdu;
1263         bool rx_is40Mhzpacket;
1264         u32 rx_pwdb_all;
1265         u8 rx_mimo_signalstrength[4];   /*in 0~100 index */
1266         s8 rx_mimo_signalquality[2];
1267         bool packet_matchbssid;
1268         bool is_cck;
1269         bool packet_toself;
1270         bool packet_beacon;     /*for rssi */
1271         char cck_adc_pwdb[4];   /*for rx path selection */
1272 };
1273
1274 struct rt_link_detect {
1275         u32 num_tx_in4period[4];
1276         u32 num_rx_in4period[4];
1277
1278         u32 num_tx_inperiod;
1279         u32 num_rx_inperiod;
1280
1281         bool busytraffic;
1282         bool higher_busytraffic;
1283         bool higher_busyrxtraffic;
1284 };
1285
1286 struct rtl_tcb_desc {
1287         u8 packet_bw:1;
1288         u8 multicast:1;
1289         u8 broadcast:1;
1290
1291         u8 rts_stbc:1;
1292         u8 rts_enable:1;
1293         u8 cts_enable:1;
1294         u8 rts_use_shortpreamble:1;
1295         u8 rts_use_shortgi:1;
1296         u8 rts_sc:1;
1297         u8 rts_bw:1;
1298         u8 rts_rate;
1299
1300         u8 use_shortgi:1;
1301         u8 use_shortpreamble:1;
1302         u8 use_driver_rate:1;
1303         u8 disable_ratefallback:1;
1304
1305         u8 ratr_index;
1306         u8 mac_id;
1307         u8 hw_rate;
1308
1309         u8 last_inipkt:1;
1310         u8 cmd_or_init:1;
1311         u8 queue_index;
1312
1313         /* early mode */
1314         u8 empkt_num;
1315         /* The max value by HW */
1316         u32 empkt_len[5];
1317 };
1318
1319 struct rtl_hal_ops {
1320         int (*init_sw_vars) (struct ieee80211_hw *hw);
1321         void (*deinit_sw_vars) (struct ieee80211_hw *hw);
1322         void (*read_chip_version)(struct ieee80211_hw *hw);
1323         void (*read_eeprom_info) (struct ieee80211_hw *hw);
1324         void (*interrupt_recognized) (struct ieee80211_hw *hw,
1325                                       u32 *p_inta, u32 *p_intb);
1326         int (*hw_init) (struct ieee80211_hw *hw);
1327         void (*hw_disable) (struct ieee80211_hw *hw);
1328         void (*hw_suspend) (struct ieee80211_hw *hw);
1329         void (*hw_resume) (struct ieee80211_hw *hw);
1330         void (*enable_interrupt) (struct ieee80211_hw *hw);
1331         void (*disable_interrupt) (struct ieee80211_hw *hw);
1332         int (*set_network_type) (struct ieee80211_hw *hw,
1333                                  enum nl80211_iftype type);
1334         void (*set_chk_bssid)(struct ieee80211_hw *hw,
1335                                 bool check_bssid);
1336         void (*set_bw_mode) (struct ieee80211_hw *hw,
1337                              enum nl80211_channel_type ch_type);
1338          u8(*switch_channel) (struct ieee80211_hw *hw);
1339         void (*set_qos) (struct ieee80211_hw *hw, int aci);
1340         void (*set_bcn_reg) (struct ieee80211_hw *hw);
1341         void (*set_bcn_intv) (struct ieee80211_hw *hw);
1342         void (*update_interrupt_mask) (struct ieee80211_hw *hw,
1343                                        u32 add_msr, u32 rm_msr);
1344         void (*get_hw_reg) (struct ieee80211_hw *hw, u8 variable, u8 *val);
1345         void (*set_hw_reg) (struct ieee80211_hw *hw, u8 variable, u8 *val);
1346         void (*update_rate_table) (struct ieee80211_hw *hw);
1347         void (*update_rate_mask) (struct ieee80211_hw *hw, u8 rssi_level);
1348         void (*fill_tx_desc) (struct ieee80211_hw *hw,
1349                               struct ieee80211_hdr *hdr, u8 *pdesc_tx,
1350                               struct ieee80211_tx_info *info,
1351                               struct sk_buff *skb, unsigned int queue_index);
1352         void (*fill_fake_txdesc) (struct ieee80211_hw *hw, u8 * pDesc,
1353                                   u32 buffer_len, bool bIsPsPoll);
1354         void (*fill_tx_cmddesc) (struct ieee80211_hw *hw, u8 *pdesc,
1355                                  bool firstseg, bool lastseg,
1356                                  struct sk_buff *skb);
1357         bool (*cmd_send_packet)(struct ieee80211_hw *hw, struct sk_buff *skb);
1358         bool (*query_rx_desc) (struct ieee80211_hw *hw,
1359                                struct rtl_stats *stats,
1360                                struct ieee80211_rx_status *rx_status,
1361                                u8 *pdesc, struct sk_buff *skb);
1362         void (*set_channel_access) (struct ieee80211_hw *hw);
1363         bool (*radio_onoff_checking) (struct ieee80211_hw *hw, u8 *valid);
1364         void (*dm_watchdog) (struct ieee80211_hw *hw);
1365         void (*scan_operation_backup) (struct ieee80211_hw *hw, u8 operation);
1366         bool (*set_rf_power_state) (struct ieee80211_hw *hw,
1367                                     enum rf_pwrstate rfpwr_state);
1368         void (*led_control) (struct ieee80211_hw *hw,
1369                              enum led_ctl_mode ledaction);
1370         void (*set_desc) (u8 *pdesc, bool istx, u8 desc_name, u8 *val);
1371         u32 (*get_desc) (u8 *pdesc, bool istx, u8 desc_name);
1372         void (*tx_polling) (struct ieee80211_hw *hw, unsigned int hw_queue);
1373         void (*enable_hw_sec) (struct ieee80211_hw *hw);
1374         void (*set_key) (struct ieee80211_hw *hw, u32 key_index,
1375                          u8 *p_macaddr, bool is_group, u8 enc_algo,
1376                          bool is_wepkey, bool clear_all);
1377         void (*init_sw_leds) (struct ieee80211_hw *hw);
1378         void (*deinit_sw_leds) (struct ieee80211_hw *hw);
1379         u32 (*get_bbreg) (struct ieee80211_hw *hw, u32 regaddr, u32 bitmask);
1380         void (*set_bbreg) (struct ieee80211_hw *hw, u32 regaddr, u32 bitmask,
1381                            u32 data);
1382         u32 (*get_rfreg) (struct ieee80211_hw *hw, enum radio_path rfpath,
1383                           u32 regaddr, u32 bitmask);
1384         void (*set_rfreg) (struct ieee80211_hw *hw, enum radio_path rfpath,
1385                            u32 regaddr, u32 bitmask, u32 data);
1386 };
1387
1388 struct rtl_intf_ops {
1389         /*com */
1390         void (*read_efuse_byte)(struct ieee80211_hw *hw, u16 _offset, u8 *pbuf);
1391         int (*adapter_start) (struct ieee80211_hw *hw);
1392         void (*adapter_stop) (struct ieee80211_hw *hw);
1393
1394         int (*adapter_tx) (struct ieee80211_hw *hw, struct sk_buff *skb);
1395         int (*reset_trx_ring) (struct ieee80211_hw *hw);
1396         bool (*waitq_insert) (struct ieee80211_hw *hw, struct sk_buff *skb);
1397
1398         /*pci */
1399         void (*disable_aspm) (struct ieee80211_hw *hw);
1400         void (*enable_aspm) (struct ieee80211_hw *hw);
1401
1402         /*usb */
1403 };
1404
1405 struct rtl_mod_params {
1406         /* default: 0 = using hardware encryption */
1407         int sw_crypto;
1408 };
1409
1410 struct rtl_hal_usbint_cfg {
1411         /* data - rx */
1412         u32 in_ep_num;
1413         u32 rx_urb_num;
1414         u32 rx_max_size;
1415
1416         /* op - rx */
1417         void (*usb_rx_hdl)(struct ieee80211_hw *, struct sk_buff *);
1418         void (*usb_rx_segregate_hdl)(struct ieee80211_hw *, struct sk_buff *,
1419                                      struct sk_buff_head *);
1420
1421         /* tx */
1422         void (*usb_tx_cleanup)(struct ieee80211_hw *, struct sk_buff *);
1423         int (*usb_tx_post_hdl)(struct ieee80211_hw *, struct urb *,
1424                                struct sk_buff *);
1425         struct sk_buff *(*usb_tx_aggregate_hdl)(struct ieee80211_hw *,
1426                                                 struct sk_buff_head *);
1427
1428         /* endpoint mapping */
1429         int (*usb_endpoint_mapping)(struct ieee80211_hw *hw);
1430         u16 (*usb_mq_to_hwq)(u16 fc, u16 mac80211_queue_index);
1431 };
1432
1433 struct rtl_hal_cfg {
1434         u8 bar_id;
1435         char *name;
1436         char *fw_name;
1437         struct rtl_hal_ops *ops;
1438         struct rtl_mod_params *mod_params;
1439         struct rtl_hal_usbint_cfg *usb_interface_cfg;
1440
1441         /*this map used for some registers or vars
1442            defined int HAL but used in MAIN */
1443         u32 maps[RTL_VAR_MAP_MAX];
1444
1445 };
1446
1447 struct rtl_locks {
1448         /* mutex */
1449         struct mutex conf_mutex;
1450
1451         /*spin lock */
1452         spinlock_t ips_lock;
1453         spinlock_t irq_th_lock;
1454         spinlock_t h2c_lock;
1455         spinlock_t rf_ps_lock;
1456         spinlock_t rf_lock;
1457         spinlock_t lps_lock;
1458         spinlock_t waitq_lock;
1459         spinlock_t tx_urb_lock;
1460
1461         /*Dual mac*/
1462         spinlock_t cck_and_rw_pagea_lock;
1463 };
1464
1465 struct rtl_works {
1466         struct ieee80211_hw *hw;
1467
1468         /*timer */
1469         struct timer_list watchdog_timer;
1470
1471         /*task */
1472         struct tasklet_struct irq_tasklet;
1473         struct tasklet_struct irq_prepare_bcn_tasklet;
1474
1475         /*work queue */
1476         struct workqueue_struct *rtl_wq;
1477         struct delayed_work watchdog_wq;
1478         struct delayed_work ips_nic_off_wq;
1479
1480         /* For SW LPS */
1481         struct delayed_work ps_work;
1482         struct delayed_work ps_rfon_wq;
1483 };
1484
1485 struct rtl_debug {
1486         u32 dbgp_type[DBGP_TYPE_MAX];
1487         u32 global_debuglevel;
1488         u64 global_debugcomponents;
1489
1490         /* add for proc debug */
1491         struct proc_dir_entry *proc_dir;
1492         char proc_name[20];
1493 };
1494
1495 struct rtl_priv {
1496         struct rtl_locks locks;
1497         struct rtl_works works;
1498         struct rtl_mac mac80211;
1499         struct rtl_hal rtlhal;
1500         struct rtl_regulatory regd;
1501         struct rtl_rfkill rfkill;
1502         struct rtl_io io;
1503         struct rtl_phy phy;
1504         struct rtl_dm dm;
1505         struct rtl_security sec;
1506         struct rtl_efuse efuse;
1507
1508         struct rtl_ps_ctl psc;
1509         struct rate_adaptive ra;
1510         struct wireless_stats stats;
1511         struct rt_link_detect link_info;
1512         struct false_alarm_statistics falsealm_cnt;
1513
1514         struct rtl_rate_priv *rate_priv;
1515
1516         struct rtl_debug dbg;
1517
1518         /*
1519          *hal_cfg : for diff cards
1520          *intf_ops : for diff interrface usb/pcie
1521          */
1522         struct rtl_hal_cfg *cfg;
1523         struct rtl_intf_ops *intf_ops;
1524
1525         /*this var will be set by set_bit,
1526            and was used to indicate status of
1527            interface or hardware */
1528         unsigned long status;
1529
1530         /*This must be the last item so
1531            that it points to the data allocated
1532            beyond  this structure like:
1533            rtl_pci_priv or rtl_usb_priv */
1534         u8 priv[0];
1535 };
1536
1537 #define rtl_priv(hw)            (((struct rtl_priv *)(hw)->priv))
1538 #define rtl_mac(rtlpriv)        (&((rtlpriv)->mac80211))
1539 #define rtl_hal(rtlpriv)        (&((rtlpriv)->rtlhal))
1540 #define rtl_efuse(rtlpriv)      (&((rtlpriv)->efuse))
1541 #define rtl_psc(rtlpriv)        (&((rtlpriv)->psc))
1542
1543
1544 /***************************************
1545     Bluetooth Co-existance Related
1546 ****************************************/
1547
1548 enum bt_ant_num {
1549         ANT_X2 = 0,
1550         ANT_X1 = 1,
1551 };
1552
1553 enum bt_co_type {
1554         BT_2WIRE = 0,
1555         BT_ISSC_3WIRE = 1,
1556         BT_ACCEL = 2,
1557         BT_CSR_BC4 = 3,
1558         BT_CSR_BC8 = 4,
1559         BT_RTL8756 = 5,
1560 };
1561
1562 enum bt_cur_state {
1563         BT_OFF = 0,
1564         BT_ON = 1,
1565 };
1566
1567 enum bt_service_type {
1568         BT_SCO = 0,
1569         BT_A2DP = 1,
1570         BT_HID = 2,
1571         BT_HID_IDLE = 3,
1572         BT_SCAN = 4,
1573         BT_IDLE = 5,
1574         BT_OTHER_ACTION = 6,
1575         BT_BUSY = 7,
1576         BT_OTHERBUSY = 8,
1577         BT_PAN = 9,
1578 };
1579
1580 enum bt_radio_shared {
1581         BT_RADIO_SHARED = 0,
1582         BT_RADIO_INDIVIDUAL = 1,
1583 };
1584
1585 struct bt_coexist_info {
1586
1587         /* EEPROM BT info. */
1588         u8 eeprom_bt_coexist;
1589         u8 eeprom_bt_type;
1590         u8 eeprom_bt_ant_num;
1591         u8 eeprom_bt_ant_isolation;
1592         u8 eeprom_bt_radio_shared;
1593
1594         u8 bt_coexistence;
1595         u8 bt_ant_num;
1596         u8 bt_coexist_type;
1597         u8 bt_state;
1598         u8 bt_cur_state;        /* 0:on, 1:off */
1599         u8 bt_ant_isolation;    /* 0:good, 1:bad */
1600         u8 bt_pape_ctrl;        /* 0:SW, 1:SW/HW dynamic */
1601         u8 bt_service;
1602         u8 bt_radio_shared_type;
1603         u8 bt_rfreg_origin_1e;
1604         u8 bt_rfreg_origin_1f;
1605         u8 bt_rssi_state;
1606         u32 ratio_tx;
1607         u32 ratio_pri;
1608         u32 bt_edca_ul;
1609         u32 bt_edca_dl;
1610
1611         bool b_init_set;
1612         bool b_bt_busy_traffic;
1613         bool b_bt_traffic_mode_set;
1614         bool b_bt_non_traffic_mode_set;
1615
1616         bool b_fw_coexist_all_off;
1617         bool b_sw_coexist_all_off;
1618         u32 current_state;
1619         u32 previous_state;
1620         u8 bt_pre_rssi_state;
1621
1622         u8 b_reg_bt_iso;
1623         u8 b_reg_bt_sco;
1624
1625 };
1626
1627
1628 /****************************************
1629         mem access macro define start
1630         Call endian free function when
1631         1. Read/write packet content.
1632         2. Before write integer to IO.
1633         3. After read integer from IO.
1634 ****************************************/
1635 /* Convert little data endian to host */
1636 #define EF1BYTE(_val)           \
1637         ((u8)(_val))
1638 #define EF2BYTE(_val)           \
1639         (le16_to_cpu(_val))
1640 #define EF4BYTE(_val)           \
1641         (le32_to_cpu(_val))
1642
1643 /* Read data from memory */
1644 #define READEF1BYTE(_ptr)       \
1645         EF1BYTE(*((u8 *)(_ptr)))
1646 #define READEF2BYTE(_ptr)       \
1647         EF2BYTE(*((u16 *)(_ptr)))
1648 #define READEF4BYTE(_ptr)       \
1649         EF4BYTE(*((u32 *)(_ptr)))
1650
1651 /* Write data to memory */
1652 #define WRITEEF1BYTE(_ptr, _val)        \
1653         (*((u8 *)(_ptr))) = EF1BYTE(_val)
1654 #define WRITEEF2BYTE(_ptr, _val)        \
1655         (*((u16 *)(_ptr))) = EF2BYTE(_val)
1656 #define WRITEEF4BYTE(_ptr, _val)        \
1657         (*((u32 *)(_ptr))) = EF4BYTE(_val)
1658
1659 /*Example:
1660 BIT_LEN_MASK_32(0) => 0x00000000
1661 BIT_LEN_MASK_32(1) => 0x00000001
1662 BIT_LEN_MASK_32(2) => 0x00000003
1663 BIT_LEN_MASK_32(32) => 0xFFFFFFFF*/
1664 #define BIT_LEN_MASK_32(__bitlen)        \
1665         (0xFFFFFFFF >> (32 - (__bitlen)))
1666 #define BIT_LEN_MASK_16(__bitlen)        \
1667         (0xFFFF >> (16 - (__bitlen)))
1668 #define BIT_LEN_MASK_8(__bitlen) \
1669         (0xFF >> (8 - (__bitlen)))
1670
1671 /*Example:
1672 BIT_OFFSET_LEN_MASK_32(0, 2) => 0x00000003
1673 BIT_OFFSET_LEN_MASK_32(16, 2) => 0x00030000*/
1674 #define BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen) \
1675         (BIT_LEN_MASK_32(__bitlen) << (__bitoffset))
1676 #define BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen) \
1677         (BIT_LEN_MASK_16(__bitlen) << (__bitoffset))
1678 #define BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen) \
1679         (BIT_LEN_MASK_8(__bitlen) << (__bitoffset))
1680
1681 /*Description:
1682 Return 4-byte value in host byte ordering from
1683 4-byte pointer in little-endian system.*/
1684 #define LE_P4BYTE_TO_HOST_4BYTE(__pstart) \
1685         (EF4BYTE(*((u32 *)(__pstart))))
1686 #define LE_P2BYTE_TO_HOST_2BYTE(__pstart) \
1687         (EF2BYTE(*((u16 *)(__pstart))))
1688 #define LE_P1BYTE_TO_HOST_1BYTE(__pstart) \
1689         (EF1BYTE(*((u8 *)(__pstart))))
1690
1691 /*Description:
1692 Translate subfield (continuous bits in little-endian) of 4-byte
1693 value to host byte ordering.*/
1694 #define LE_BITS_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
1695         ( \
1696                 (LE_P4BYTE_TO_HOST_4BYTE(__pstart) >> (__bitoffset))  & \
1697                 BIT_LEN_MASK_32(__bitlen) \
1698         )
1699 #define LE_BITS_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
1700         ( \
1701                 (LE_P2BYTE_TO_HOST_2BYTE(__pstart) >> (__bitoffset)) & \
1702                 BIT_LEN_MASK_16(__bitlen) \
1703         )
1704 #define LE_BITS_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
1705         ( \
1706                 (LE_P1BYTE_TO_HOST_1BYTE(__pstart) >> (__bitoffset)) & \
1707                 BIT_LEN_MASK_8(__bitlen) \
1708         )
1709
1710 /*Description:
1711 Mask subfield (continuous bits in little-endian) of 4-byte value
1712 and return the result in 4-byte value in host byte ordering.*/
1713 #define LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
1714         ( \
1715                 LE_P4BYTE_TO_HOST_4BYTE(__pstart)  & \
1716                 (~BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen)) \
1717         )
1718 #define LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
1719         ( \
1720                 LE_P2BYTE_TO_HOST_2BYTE(__pstart) & \
1721                 (~BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen)) \
1722         )
1723 #define LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
1724         ( \
1725                 LE_P1BYTE_TO_HOST_1BYTE(__pstart) & \
1726                 (~BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen)) \
1727         )
1728
1729 /*Description:
1730 Set subfield of little-endian 4-byte value to specified value.  */
1731 #define SET_BITS_TO_LE_4BYTE(__pstart, __bitoffset, __bitlen, __val) \
1732         *((u32 *)(__pstart)) = EF4BYTE \
1733         ( \
1734                 LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) | \
1735                 ((((u32)__val) & BIT_LEN_MASK_32(__bitlen)) << (__bitoffset)) \
1736         );
1737 #define SET_BITS_TO_LE_2BYTE(__pstart, __bitoffset, __bitlen, __val) \
1738         *((u16 *)(__pstart)) = EF2BYTE \
1739         ( \
1740                 LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) | \
1741                 ((((u16)__val) & BIT_LEN_MASK_16(__bitlen)) << (__bitoffset)) \
1742         );
1743 #define SET_BITS_TO_LE_1BYTE(__pstart, __bitoffset, __bitlen, __val) \
1744         *((u8 *)(__pstart)) = EF1BYTE \
1745         ( \
1746                 LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) | \
1747                 ((((u8)__val) & BIT_LEN_MASK_8(__bitlen)) << (__bitoffset)) \
1748         );
1749
1750 #define N_BYTE_ALIGMENT(__value, __aligment) ((__aligment == 1) ? \
1751         (__value) : (((__value + __aligment - 1) / __aligment) * __aligment))
1752
1753 /****************************************
1754         mem access macro define end
1755 ****************************************/
1756
1757 #define byte(x, n) ((x >> (8 * n)) & 0xff)
1758
1759 #define packet_get_type(_packet) (EF1BYTE((_packet).octet[0]) & 0xFC)
1760 #define RTL_WATCH_DOG_TIME      2000
1761 #define MSECS(t)                msecs_to_jiffies(t)
1762 #define WLAN_FC_GET_VERS(fc)    ((fc) & IEEE80211_FCTL_VERS)
1763 #define WLAN_FC_GET_TYPE(fc)    ((fc) & IEEE80211_FCTL_FTYPE)
1764 #define WLAN_FC_GET_STYPE(fc)   ((fc) & IEEE80211_FCTL_STYPE)
1765 #define WLAN_FC_MORE_DATA(fc)   ((fc) & IEEE80211_FCTL_MOREDATA)
1766 #define SEQ_TO_SN(seq)          (((seq) & IEEE80211_SCTL_SEQ) >> 4)
1767 #define SN_TO_SEQ(ssn)          (((ssn) << 4) & IEEE80211_SCTL_SEQ)
1768 #define MAX_SN                  ((IEEE80211_SCTL_SEQ) >> 4)
1769
1770 #define RT_RF_OFF_LEVL_ASPM             BIT(0)  /*PCI ASPM */
1771 #define RT_RF_OFF_LEVL_CLK_REQ          BIT(1)  /*PCI clock request */
1772 #define RT_RF_OFF_LEVL_PCI_D3           BIT(2)  /*PCI D3 mode */
1773 /*NIC halt, re-initialize hw parameters*/
1774 #define RT_RF_OFF_LEVL_HALT_NIC         BIT(3)
1775 #define RT_RF_OFF_LEVL_FREE_FW          BIT(4)  /*FW free, re-download the FW */
1776 #define RT_RF_OFF_LEVL_FW_32K           BIT(5)  /*FW in 32k */
1777 /*Always enable ASPM and Clock Req in initialization.*/
1778 #define RT_RF_PS_LEVEL_ALWAYS_ASPM      BIT(6)
1779 /* no matter RFOFF or SLEEP we set PS_ASPM_LEVL*/
1780 #define RT_PS_LEVEL_ASPM                BIT(7)
1781 /*When LPS is on, disable 2R if no packet is received or transmittd.*/
1782 #define RT_RF_LPS_DISALBE_2R            BIT(30)
1783 #define RT_RF_LPS_LEVEL_ASPM            BIT(31) /*LPS with ASPM */
1784 #define RT_IN_PS_LEVEL(ppsc, _ps_flg)           \
1785         ((ppsc->cur_ps_level & _ps_flg) ? true : false)
1786 #define RT_CLEAR_PS_LEVEL(ppsc, _ps_flg)        \
1787         (ppsc->cur_ps_level &= (~(_ps_flg)))
1788 #define RT_SET_PS_LEVEL(ppsc, _ps_flg)          \
1789         (ppsc->cur_ps_level |= _ps_flg)
1790
1791 #define container_of_dwork_rtl(x, y, z) \
1792         container_of(container_of(x, struct delayed_work, work), y, z)
1793
1794 #define FILL_OCTET_STRING(_os, _octet, _len)    \
1795         do {                                    \
1796                 (_os). octet = (u8 *)(_octet);          \
1797                 (_os). length = (_len);         \
1798         } while (0);
1799
1800 #define CP_MACADDR(des, src)            \
1801         memcpy((des), (src), ETH_ALEN)
1802
1803 static inline u8 rtl_read_byte(struct rtl_priv *rtlpriv, u32 addr)
1804 {
1805         return rtlpriv->io.read8_sync(rtlpriv, addr);
1806 }
1807
1808 static inline u16 rtl_read_word(struct rtl_priv *rtlpriv, u32 addr)
1809 {
1810         return rtlpriv->io.read16_sync(rtlpriv, addr);
1811 }
1812
1813 static inline u32 rtl_read_dword(struct rtl_priv *rtlpriv, u32 addr)
1814 {
1815         return rtlpriv->io.read32_sync(rtlpriv, addr);
1816 }
1817
1818 static inline void rtl_write_byte(struct rtl_priv *rtlpriv, u32 addr, u8 val8)
1819 {
1820         rtlpriv->io.write8_async(rtlpriv, addr, val8);
1821 }
1822
1823 static inline void rtl_write_word(struct rtl_priv *rtlpriv, u32 addr, u16 val16)
1824 {
1825         rtlpriv->io.write16_async(rtlpriv, addr, val16);
1826 }
1827
1828 static inline void rtl_write_dword(struct rtl_priv *rtlpriv,
1829                                    u32 addr, u32 val32)
1830 {
1831         rtlpriv->io.write32_async(rtlpriv, addr, val32);
1832 }
1833
1834 static inline u32 rtl_get_bbreg(struct ieee80211_hw *hw,
1835                                 u32 regaddr, u32 bitmask)
1836 {
1837         return ((struct rtl_priv *)(hw)->priv)->cfg->ops->get_bbreg(hw,
1838                                                                     regaddr,
1839                                                                     bitmask);
1840 }
1841
1842 static inline void rtl_set_bbreg(struct ieee80211_hw *hw, u32 regaddr,
1843                                  u32 bitmask, u32 data)
1844 {
1845         ((struct rtl_priv *)(hw)->priv)->cfg->ops->set_bbreg(hw,
1846                                                              regaddr, bitmask,
1847                                                              data);
1848
1849 }
1850
1851 static inline u32 rtl_get_rfreg(struct ieee80211_hw *hw,
1852                                 enum radio_path rfpath, u32 regaddr,
1853                                 u32 bitmask)
1854 {
1855         return ((struct rtl_priv *)(hw)->priv)->cfg->ops->get_rfreg(hw,
1856                                                                     rfpath,
1857                                                                     regaddr,
1858                                                                     bitmask);
1859 }
1860
1861 static inline void rtl_set_rfreg(struct ieee80211_hw *hw,
1862                                  enum radio_path rfpath, u32 regaddr,
1863                                  u32 bitmask, u32 data)
1864 {
1865         ((struct rtl_priv *)(hw)->priv)->cfg->ops->set_rfreg(hw,
1866                                                              rfpath, regaddr,
1867                                                              bitmask, data);
1868 }
1869
1870 static inline bool is_hal_stop(struct rtl_hal *rtlhal)
1871 {
1872         return (_HAL_STATE_STOP == rtlhal->state);
1873 }
1874
1875 static inline void set_hal_start(struct rtl_hal *rtlhal)
1876 {
1877         rtlhal->state = _HAL_STATE_START;
1878 }
1879
1880 static inline void set_hal_stop(struct rtl_hal *rtlhal)
1881 {
1882         rtlhal->state = _HAL_STATE_STOP;
1883 }
1884
1885 static inline u8 get_rf_type(struct rtl_phy *rtlphy)
1886 {
1887         return rtlphy->rf_type;
1888 }
1889
1890 #endif