drivers/net/wireless/rockchip_wlan/rtl8723ds/include/rtl8188e_hal.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  *
  19  ******************************************************************************/
  20 #ifndef __RTL8188E_HAL_H__
  21 #define __RTL8188E_HAL_H__
  22
  23 /* #include "hal_com.h" */
  24 #include "hal_data.h"
  25
  26 /* include HAL Related header after HAL Related compiling flags */
  27 #include "rtl8188e_spec.h"
  28 #include "Hal8188EPhyReg.h"
  29 #include "Hal8188EPhyCfg.h"
  30 #include "rtl8188e_rf.h"
  31 #include "rtl8188e_dm.h"
  32 #include "rtl8188e_recv.h"
  33 #include "rtl8188e_xmit.h"
  34 #include "rtl8188e_cmd.h"
  35 #include "rtl8188e_led.h"
  36 #include "Hal8188EPwrSeq.h"
  37 #ifdef DBG_CONFIG_ERROR_DETECT
  38         #include "rtl8188e_sreset.h"
  39 #endif
  40
  41 /* --------------------------------------------------------------------- */
  42 /*              RTL8188E Power Configuration CMDs for USB/SDIO/PCIE interfaces */
  43 /* --------------------------------------------------------------------- */
  44 #define Rtl8188E_NIC_PWR_ON_FLOW                                rtl8188E_power_on_flow
  45 #define Rtl8188E_NIC_RF_OFF_FLOW                                rtl8188E_radio_off_flow
  46 #define Rtl8188E_NIC_DISABLE_FLOW                               rtl8188E_card_disable_flow
  47 #define Rtl8188E_NIC_ENABLE_FLOW                                rtl8188E_card_enable_flow
  48 #define Rtl8188E_NIC_SUSPEND_FLOW                               rtl8188E_suspend_flow
  49 #define Rtl8188E_NIC_RESUME_FLOW                                rtl8188E_resume_flow
  50 #define Rtl8188E_NIC_PDN_FLOW                                   rtl8188E_hwpdn_flow
  51 #define Rtl8188E_NIC_LPS_ENTER_FLOW                     rtl8188E_enter_lps_flow
  52 #define Rtl8188E_NIC_LPS_LEAVE_FLOW                     rtl8188E_leave_lps_flow
  53
  54
  55 #if 1 /* download firmware related data structure */
  56 #define MAX_FW_8188E_SIZE                       0x8000 /* 32768, 32k / 16384, 16k */
  57
  58 #define FW_8188E_SIZE                           0x4000 /* 16384, 16k */
  59 #define FW_8188E_SIZE_2                 0x8000 /* 32768, 32k */
  60
  61 #define FW_8188E_START_ADDRESS  0x1000
  62 #define FW_8188E_END_ADDRESS            0x1FFF /* 0x5FFF */
  63
  64
  65 #define IS_FW_HEADER_EXIST_88E(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x88E0)
  66
  67 typedef struct _RT_FIRMWARE_8188E {
  68         FIRMWARE_SOURCE eFWSource;
  69 #ifdef CONFIG_EMBEDDED_FWIMG
  70         u8                      *szFwBuffer;
  71 #else
  72         u8                      szFwBuffer[MAX_FW_8188E_SIZE];
  73 #endif
  74         u32                     ulFwLength;
  75 } RT_FIRMWARE_8188E, *PRT_FIRMWARE_8188E;
  76
  77 /*
  78  * This structure must be cared byte-ordering
  79  *   */
  80
  81 typedef struct _RT_8188E_FIRMWARE_HDR {
  82         /* 8-byte alinment required */
  83
  84         /* --- LONG WORD 0 ---- */
  85         u16             Signature;      /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
  86         u8              Category;       /* AP/NIC and USB/PCI */
  87         u8              Function;       /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
  88         u16             Version;                /* FW Version */
  89         u8              Subversion;     /* FW Subversion, default 0x00 */
  90         u16             Rsvd1;
  91
  92
  93         /* --- LONG WORD 1 ---- */
  94         u8              Month;  /* Release time Month field */
  95         u8              Date;   /* Release time Date field */
  96         u8              Hour;   /* Release time Hour field */
  97         u8              Minute; /* Release time Minute field */
  98         u16             RamCodeSize;    /* The size of RAM code */
  99         u8              Foundry;
 100         u8              Rsvd2;
 101
 102         /* --- LONG WORD 2 ---- */
 103         u32             SvnIdx; /* The SVN entry index */
 104         u32             Rsvd3;
 105
 106         /* --- LONG WORD 3 ---- */
 107         u32             Rsvd4;
 108         u32             Rsvd5;
 109 } RT_8188E_FIRMWARE_HDR, *PRT_8188E_FIRMWARE_HDR;
 110 #endif /* download firmware related data structure */
 111
 112
 113 #define DRIVER_EARLY_INT_TIME_8188E                     0x05
 114 #define BCN_DMA_ATIME_INT_TIME_8188E            0x02
 115
 116
 117 /* #define MAX_RX_DMA_BUFFER_SIZE_88E         0x2400 */ /* 9k for 88E nornal chip , */ /* MaxRxBuff=10k-max(TxReportSize(64*8), WOLPattern(16*24)) */
 118 #ifdef CONFIG_USB_HCI
 119         #define RX_DMA_SIZE_88E(__Adapter) 0x2800 /* no cut difference */
 120 #else
 121         #define RX_DMA_SIZE_88E(__Adapter) ((!IS_VENDOR_8188E_I_CUT_SERIES(__Adapter)) ? 0x2800 : 0x4000)
 122 #endif
 123
 124 #ifdef CONFIG_WOWLAN
 125         #define RESV_FMWF       (WKFMCAM_SIZE * MAX_WKFM_NUM) /* 16 entries, for each is 24 bytes*/
 126 #else
 127         #define RESV_FMWF       0
 128 #endif
 129
 130 #define RX_DMA_RESERVD_FW_FEATURE       0x200 /* for tx report (64*8) */
 131
 132 #define MAX_RX_DMA_BUFFER_SIZE_88E(__Adapter) (RX_DMA_SIZE_88E(__Adapter)-RX_DMA_RESERVD_FW_FEATURE)
 133
 134 #define MAX_TX_REPORT_BUFFER_SIZE                       0x0400 /* 1k */
 135
 136 /* Note: We will divide number of page equally for each queue other than public queue!
 137  * 22k = 22528 bytes = 176 pages (@page =  128 bytes)
 138  * must reserved about 7 pages for LPS =>  176-7 = 169 (0xA9)
 139  * 2*BCN / 1*ps-poll / 1*null-data /1*prob_rsp /1*QOS null-data /1*BT QOS null-data  */
 140
 141 #define BCNQ_PAGE_NUM_88E               0x08
 142
 143 /* For WoWLan , more reserved page */
 144 #ifdef CONFIG_WOWLAN
 145         #define WOWLAN_PAGE_NUM_88E     0x00
 146 #else
 147         #define WOWLAN_PAGE_NUM_88E     0x00
 148 #endif
 149
 150 /* Note:
 151 Tx FIFO Size : previous CUT:22K /I_CUT after:32KB
 152 Tx page Size : 128B
 153 Total page numbers : 176(0xB0) / 256(0x100)
 154 */
 155 #ifdef CONFIG_USB_HCI
 156         #define TOTAL_PAGE_NUMBER_88E(_Adapter) (0xB0 - 1) /* no cut difference */
 157 #else
 158         #define TOTAL_PAGE_NUMBER_88E(_Adapter) ((IS_VENDOR_8188E_I_CUT_SERIES(_Adapter) ? 0x100 : 0xB0) - 1)/* must reserved 1 page for dma issue */
 159 #endif
 160 #define TX_TOTAL_PAGE_NUMBER_88E(_Adapter)      (TOTAL_PAGE_NUMBER_88E(_Adapter) - BCNQ_PAGE_NUM_88E - WOWLAN_PAGE_NUM_88E)
 161 #define TX_PAGE_BOUNDARY_88E(_Adapter)          (TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) /* beacon header start address */
 162
 163 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter)   TX_TOTAL_PAGE_NUMBER_88E(_Adapter)
 164 #define WMM_NORMAL_TX_PAGE_BOUNDARY_88E(_Adapter)               (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1)
 165
 166 /* For Normal Chip Setting
 167  * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */
 168 #define NORMAL_PAGE_NUM_HPQ_88E         0x0
 169 #define NORMAL_PAGE_NUM_LPQ_88E         0x09
 170 #define NORMAL_PAGE_NUM_NPQ_88E         0x0
 171
 172 /* Note: For Normal Chip Setting, modify later */
 173 #define WMM_NORMAL_PAGE_NUM_HPQ_88E             0x29
 174 #define WMM_NORMAL_PAGE_NUM_LPQ_88E             0x1C
 175 #define WMM_NORMAL_PAGE_NUM_NPQ_88E             0x1C
 176
 177
 178 /* -------------------------------------------------------------------------
 179  *      Chip specific
 180  * ------------------------------------------------------------------------- */
 181 #define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22) & 0x3)
 182 #define CHIP_BONDING_92C_1T2R   0x1
 183 #define CHIP_BONDING_88C_USB_MCARD      0x2
 184 #define CHIP_BONDING_88C_USB_HP 0x1
 185
 186 /* -------------------------------------------------------------------------
 187  *      Channel Plan
 188  * ------------------------------------------------------------------------- */
 189
 190
 191 #define EFUSE_REAL_CONTENT_LEN          512
 192 #define EFUSE_MAP_LEN                           128
 193 #define EFUSE_MAX_SECTION                       16
 194 #define EFUSE_IC_ID_OFFSET                      506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 195 #define AVAILABLE_EFUSE_ADDR(addr)      (addr < EFUSE_REAL_CONTENT_LEN)
 196 /*
 197  * <Roger_Notes>
 198  * To prevent out of boundary programming case,
 199  * leave 1byte and program full section
 200  * 9bytes + 1byt + 5bytes and pre 1byte.
 201  * For worst case:
 202  * | 1byte|----8bytes----|1byte|--5bytes--|
 203  * |         |            Reserved(14bytes)           |
 204  *   */
 205 #define EFUSE_OOB_PROTECT_BYTES                 15      /* PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. */
 206
 207 #define         EFUSE_REAL_CONTENT_LEN_88E      256
 208 #define         EFUSE_MAP_LEN_88E               512
 209 #define         EFUSE_MAX_SECTION_88E           64
 210 #define         EFUSE_MAX_WORD_UNIT_88E         4
 211 #define         EFUSE_IC_ID_OFFSET_88E                  506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 212 #define         AVAILABLE_EFUSE_ADDR_88E(addr)  (addr < EFUSE_REAL_CONTENT_LEN_88E)
 213 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section
 214  * 9bytes + 1byt + 5bytes and pre 1byte.
 215  * For worst case:
 216  * | 2byte|----8bytes----|1byte|--7bytes--|  */ /* 92D */
 217 #define                 EFUSE_OOB_PROTECT_BYTES_88E     18      /* PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. */
 218 #define         EFUSE_PROTECT_BYTES_BANK_88E    16
 219
 220
 221 /* ********************************************************
 222  *                      EFUSE for BT definition
 223  * ******************************************************** */
 224 #define EFUSE_BT_REAL_CONTENT_LEN               1536    /* 512*3 */
 225 #define EFUSE_BT_MAP_LEN                                1024    /* 1k bytes */
 226 #define EFUSE_BT_MAX_SECTION                    128             /* 1024/8 */
 227
 228 #define EFUSE_PROTECT_BYTES_BANK                16
 229
 230 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
 231 #define INCLUDE_MULTI_FUNC_GPS(_Adapter)        (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 232
 233 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */
 234
 235 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */
 236
 237 #ifdef CONFIG_PCI_HCI
 238         /* according to the define in the rtw_xmit.h, rtw_recv.h */
 239         #define TX_DESC_NUM_8188EE  TXDESC_NUM   /* 128 */
 240         #ifdef CONFIG_CONCURRENT_MODE
 241                 /*#define BE_QUEUE_TX_DESC_NUM_8188EE  (TXDESC_NUM<<1)*/                /* 256 */
 242                 #define BE_QUEUE_TX_DESC_NUM_8188EE  ((TXDESC_NUM<<1)+(TXDESC_NUM>>1))    /* 320 */
 243                 /*#define BE_QUEUE_TX_DESC_NUM_8188EE  ((TXDESC_NUM<<1)+TXDESC_NUM)*/    /* 384 */
 244         #else
 245                 #define BE_QUEUE_TX_DESC_NUM_8188EE  TXDESC_NUM /* 128 */
 246                 /*#define BE_QUEUE_TX_DESC_NUM_8188EE  (TXDESC_NUM+(TXDESC_NUM>>1)) */ /* 192 */
 247         #endif
 248
 249         void InterruptRecognized8188EE(PADAPTER Adapter, PRT_ISR_CONTENT pIsrContent);
 250         void UpdateInterruptMask8188EE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
 251 #endif /* CONFIG_PCI_HCI */
 252
 253 /* rtl8188e_hal_init.c */
 254
 255 s32 rtl8188e_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);
 256 void _8051Reset88E(PADAPTER padapter);
 257 void rtl8188e_InitializeFirmwareVars(PADAPTER padapter);
 258
 259
 260 s32 InitLLTTable(PADAPTER padapter, u8 txpktbuf_bndy);
 261
 262 /* EFuse */
 263 u8 GetEEPROMSize8188E(PADAPTER padapter);
 264 void Hal_InitPGData88E(PADAPTER padapter);
 265 void Hal_EfuseParseIDCode88E(PADAPTER padapter, u8 *hwinfo);
 266 void Hal_ReadTxPowerInfo88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN      AutoLoadFail);
 267
 268 void Hal_EfuseParseEEPROMVer88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 269 void rtl8188e_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 270 void Hal_EfuseParseCustomerID88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 271 void Hal_ReadAntennaDiversity88E(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
 272 void Hal_ReadThermalMeter_88E(PADAPTER  Adapter, u8 *PROMContent, BOOLEAN       AutoloadFail);
 273 void Hal_EfuseParseXtal_8188E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 274 void Hal_EfuseParseBoardType88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 275 void Hal_ReadPowerSavingMode88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 276 void Hal_ReadPAType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 277 void Hal_ReadAmplifierType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 278 void Hal_ReadRFEType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 279
 280 BOOLEAN HalDetectPwrDownMode88E(PADAPTER Adapter);
 281
 282 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
 283         void Hal_DetectWoWMode(PADAPTER pAdapter);
 284 #endif /* CONFIG_WOWLAN */
 285
 286
 287 #ifdef CONFIG_RF_POWER_TRIM
 288         void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 289 #endif /*CONFIG_RF_POWER_TRIM*/
 290
 291 void rtl8188e_init_default_value(_adapter *adapter);
 292
 293 void rtl8188e_set_hal_ops(struct hal_ops *pHalFunc);
 294 void init_hal_spec_8188e(_adapter *adapter);
 295
 296 /* register */
 297 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);
 298
 299 void rtl8188e_start_thread(_adapter *padapter);
 300 void rtl8188e_stop_thread(_adapter *padapter);
 301
 302 void rtw_IOL_cmd_tx_pkt_buf_dump(ADAPTER *Adapter, int data_len);
 303 #ifdef CONFIG_IOL_EFUSE_PATCH
 304         s32 rtl8188e_iol_efuse_patch(PADAPTER padapter);
 305 #endif/* CONFIG_IOL_EFUSE_PATCH */
 306 void _InitTransferPageSize(PADAPTER padapter);
 307
 308 void SetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val);
 309 void GetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val);
 310
 311 u8
 312 GetHalDefVar8188E(
 313         IN      PADAPTER                                Adapter,
 314         IN      HAL_DEF_VARIABLE                eVariable,
 315         IN      PVOID                                   pValue
 316 );
 317 #ifdef CONFIG_GPIO_API
 318 int rtl8188e_GpioFuncCheck(PADAPTER adapter, u8 gpio_num);
 319 #endif
 320 #endif /* __RTL8188E_HAL_H__ */