drivers/net/wireless/rockchip_wlan/rtl8723cs/include/rtl8723d_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 __RTL8723D_HAL_H__
  21 #define __RTL8723D_HAL_H__
  22
  23 #include "hal_data.h"
  24
  25 #include "rtl8723d_spec.h"
  26 #include "rtl8723d_rf.h"
  27 #include "rtl8723d_dm.h"
  28 #include "rtl8723d_recv.h"
  29 #include "rtl8723d_xmit.h"
  30 #include "rtl8723d_cmd.h"
  31 #include "rtl8723d_led.h"
  32 #include "Hal8723DPwrSeq.h"
  33 #include "Hal8723DPhyReg.h"
  34 #include "Hal8723DPhyCfg.h"
  35 #ifdef DBG_CONFIG_ERROR_DETECT
  36         #include "rtl8723d_sreset.h"
  37 #endif
  38 #ifdef CONFIG_LPS_POFF
  39         #include "rtl8723d_lps_poff.h"
  40 #endif
  41
  42 #define FW_8723D_SIZE           0x8000
  43 #define FW_8723D_START_ADDRESS  0x1000
  44 #define FW_8723D_END_ADDRESS    0x1FFF /* 0x5FFF */
  45
  46 #define IS_FW_HEADER_EXIST_8723D(_pFwHdr)\
  47         ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x23D0)
  48
  49 typedef struct _RT_FIRMWARE {
  50         FIRMWARE_SOURCE eFWSource;
  51 #ifdef CONFIG_EMBEDDED_FWIMG
  52         u8                      *szFwBuffer;
  53 #else
  54         u8                      szFwBuffer[FW_8723D_SIZE];
  55 #endif
  56         u32                     ulFwLength;
  57 } RT_FIRMWARE_8723D, *PRT_FIRMWARE_8723D;
  58
  59 /*
  60  * This structure must be cared byte-ordering
  61  *
  62  * Added by tynli. 2009.12.04. */
  63 typedef struct _RT_8723D_FIRMWARE_HDR {
  64         /* 8-byte alinment required */
  65
  66         /* --- LONG WORD 0 ---- */
  67         u16             Signature;      /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
  68         u8              Category;       /* AP/NIC and USB/PCI */
  69         u8              Function;       /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
  70         u16             Version;                /* FW Version */
  71         u16             Subversion;     /* FW Subversion, default 0x00 */
  72
  73         /* --- LONG WORD 1 ---- */
  74         u8              Month;  /* Release time Month field */
  75         u8              Date;   /* Release time Date field */
  76         u8              Hour;   /* Release time Hour field */
  77         u8              Minute; /* Release time Minute field */
  78         u16             RamCodeSize;    /* The size of RAM code */
  79         u16             Rsvd2;
  80
  81         /* --- LONG WORD 2 ---- */
  82         u32             SvnIdx; /* The SVN entry index */
  83         u32             Rsvd3;
  84
  85         /* --- LONG WORD 3 ---- */
  86         u32             Rsvd4;
  87         u32             Rsvd5;
  88 } RT_8723D_FIRMWARE_HDR, *PRT_8723D_FIRMWARE_HDR;
  89
  90 #define DRIVER_EARLY_INT_TIME_8723D             0x05
  91 #define BCN_DMA_ATIME_INT_TIME_8723D            0x02
  92
  93 /* for 8723D
  94  * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
  95 #define PAGE_SIZE_TX_8723D                      128
  96 #define PAGE_SIZE_RX_8723D                      8
  97
  98 #define TX_DMA_SIZE_8723D                       0x8000  /* 32K(TX) */
  99 #define RX_DMA_SIZE_8723D                       0x4000  /* 16K(RX) */
 100
 101 #ifdef CONFIG_WOWLAN
 102         #define RESV_FMWF       (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/
 103 #else
 104         #define RESV_FMWF       0
 105 #endif
 106
 107 #ifdef CONFIG_FW_C2H_DEBUG
 108         #define RX_DMA_RESERVED_SIZE_8723D      0x100   /* 256B, reserved for c2h debug message */
 109 #else
 110         #define RX_DMA_RESERVED_SIZE_8723D      0x80    /* 128B, reserved for tx report */
 111 #endif
 112 #define RX_DMA_BOUNDARY_8723D\
 113         (RX_DMA_SIZE_8723D - RX_DMA_RESERVED_SIZE_8723D - 1)
 114
 115
 116 /* Note: We will divide number of page equally for each queue other than public queue! */
 117
 118 /* For General Reserved Page Number(Beacon Queue is reserved page)
 119  * Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1 */
 120 #define BCNQ_PAGE_NUM_8723D             0x08
 121 #ifdef CONFIG_CONCURRENT_MODE
 122         #define BCNQ1_PAGE_NUM_8723D            0x08 /* 0x04 */
 123 #else
 124         #define BCNQ1_PAGE_NUM_8723D            0x00
 125 #endif
 126
 127 #ifdef CONFIG_PNO_SUPPORT
 128         #undef BCNQ1_PAGE_NUM_8723D
 129         #define BCNQ1_PAGE_NUM_8723D            0x00 /* 0x04 */
 130 #endif
 131
 132 /* For WoWLan , more reserved page
 133  * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt 1, PNO: 6 */
 134 #ifdef CONFIG_WOWLAN
 135         #define WOWLAN_PAGE_NUM_8723D   0x08
 136 #else
 137         #define WOWLAN_PAGE_NUM_8723D   0x00
 138 #endif
 139
 140 #ifdef CONFIG_PNO_SUPPORT
 141         #undef WOWLAN_PAGE_NUM_8723D
 142         #define WOWLAN_PAGE_NUM_8723D   0x15
 143 #endif
 144
 145 #ifdef CONFIG_AP_WOWLAN
 146         #define AP_WOWLAN_PAGE_NUM_8723D        0x02
 147 #endif
 148
 149 #define TX_TOTAL_PAGE_NUMBER_8723D\
 150         (0xFF - BCNQ_PAGE_NUM_8723D - BCNQ1_PAGE_NUM_8723D - WOWLAN_PAGE_NUM_8723D)
 151 #define TX_PAGE_BOUNDARY_8723D          (TX_TOTAL_PAGE_NUMBER_8723D + 1)
 152
 153 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723D   TX_TOTAL_PAGE_NUMBER_8723D
 154 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723D\
 155         (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723D + 1)
 156
 157 /* For Normal Chip Setting
 158  * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723D */
 159 #define NORMAL_PAGE_NUM_HPQ_8723D               0x0C
 160 #define NORMAL_PAGE_NUM_LPQ_8723D               0x02
 161 #define NORMAL_PAGE_NUM_NPQ_8723D               0x02
 162
 163 /* Note: For Normal Chip Setting, modify later */
 164 #define WMM_NORMAL_PAGE_NUM_HPQ_8723D           0x30
 165 #define WMM_NORMAL_PAGE_NUM_LPQ_8723D           0x20
 166 #define WMM_NORMAL_PAGE_NUM_NPQ_8723D           0x20
 167
 168
 169 #include "HalVerDef.h"
 170 #include "hal_com.h"
 171
 172 #define EFUSE_OOB_PROTECT_BYTES (96 + 1)
 173
 174 #define HAL_EFUSE_MEMORY
 175 #define HWSET_MAX_SIZE_8723D                512
 176 #define EFUSE_REAL_CONTENT_LEN_8723D        512
 177 #define EFUSE_MAP_LEN_8723D                 512
 178 #define EFUSE_MAX_SECTION_8723D             64
 179
 180 /* For some inferiority IC purpose. added by Roger, 2009.09.02.*/
 181 #define EFUSE_IC_ID_OFFSET                      506
 182 #define AVAILABLE_EFUSE_ADDR(addr)      (addr < EFUSE_REAL_CONTENT_LEN_8723D)
 183
 184 #define EFUSE_ACCESS_ON         0x69
 185 #define EFUSE_ACCESS_OFF        0x00
 186
 187 /* ********************************************************
 188  *                      EFUSE for BT definition
 189  * ******************************************************** */
 190 #define BANK_NUM                        1
 191 #define EFUSE_BT_REAL_BANK_CONTENT_LEN  128
 192 #define EFUSE_BT_REAL_CONTENT_LEN       \
 193         (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM)
 194 #define EFUSE_BT_MAP_LEN                1024    /* 1k bytes */
 195 #define EFUSE_BT_MAX_SECTION            (EFUSE_BT_MAP_LEN / 8)
 196 #define EFUSE_PROTECT_BYTES_BANK        16
 197
 198 typedef enum tag_Package_Definition {
 199         PACKAGE_DEFAULT,
 200         PACKAGE_QFN68,
 201         PACKAGE_TFBGA90,
 202         PACKAGE_TFBGA80,
 203         PACKAGE_TFBGA79
 204 } PACKAGE_TYPE_E;
 205
 206 #define INCLUDE_MULTI_FUNC_BT(_Adapter) \
 207         (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
 208 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \
 209         (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 210
 211 #ifdef CONFIG_FILE_FWIMG
 212         extern char *rtw_fw_file_path;
 213         extern char *rtw_fw_wow_file_path;
 214         #ifdef CONFIG_MP_INCLUDED
 215                 extern char *rtw_fw_mp_bt_file_path;
 216         #endif /* CONFIG_MP_INCLUDED */
 217 #endif /* CONFIG_FILE_FWIMG */
 218
 219 /* rtl8723d_hal_init.c */
 220 s32 rtl8723d_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);
 221 void rtl8723d_FirmwareSelfReset(PADAPTER padapter);
 222 void rtl8723d_InitializeFirmwareVars(PADAPTER padapter);
 223
 224 void rtl8723d_InitAntenna_Selection(PADAPTER padapter);
 225 void rtl8723d_DeinitAntenna_Selection(PADAPTER padapter);
 226 void rtl8723d_CheckAntenna_Selection(PADAPTER padapter);
 227 void rtl8723d_init_default_value(PADAPTER padapter);
 228
 229 s32 rtl8723d_InitLLTTable(PADAPTER padapter);
 230
 231 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
 232 s32 CardDisableWithoutHWSM(PADAPTER padapter);
 233
 234 /* EFuse */
 235 u8 GetEEPROMSize8723D(PADAPTER padapter);
 236 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
 237 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
 238 void Hal_EfuseParseTxPowerInfo_8723D(PADAPTER padapter,
 239                                      u8 *PROMContent, BOOLEAN AutoLoadFail);
 240 void Hal_EfuseParseBTCoexistInfo_8723D(PADAPTER padapter,
 241                                        u8 *hwinfo, BOOLEAN AutoLoadFail);
 242 void Hal_EfuseParseEEPROMVer_8723D(PADAPTER padapter,
 243                                    u8 *hwinfo, BOOLEAN AutoLoadFail);
 244 void Hal_EfuseParsePackageType_8723D(PADAPTER pAdapter,
 245                                      u8 *hwinfo, BOOLEAN AutoLoadFail);
 246 void Hal_EfuseParseChnlPlan_8723D(PADAPTER padapter,
 247                                   u8 *hwinfo, BOOLEAN AutoLoadFail);
 248 void Hal_EfuseParseCustomerID_8723D(PADAPTER padapter,
 249                                     u8 *hwinfo, BOOLEAN AutoLoadFail);
 250 void Hal_EfuseParseAntennaDiversity_8723D(PADAPTER padapter,
 251                 u8 *hwinfo, BOOLEAN AutoLoadFail);
 252 void Hal_EfuseParseXtal_8723D(PADAPTER pAdapter,
 253                               u8 *hwinfo, u8 AutoLoadFail);
 254 void Hal_EfuseParseThermalMeter_8723D(PADAPTER padapter,
 255                                       u8 *hwinfo, u8 AutoLoadFail);
 256 VOID Hal_EfuseParseVoltage_8723D(PADAPTER pAdapter,
 257                                  u8 *hwinfo, BOOLEAN    AutoLoadFail);
 258 VOID Hal_EfuseParseBoardType_8723D(PADAPTER Adapter,
 259                                    u8   *PROMContent, BOOLEAN AutoloadFail);
 260
 261 void rtl8723d_set_hal_ops(struct hal_ops *pHalFunc);
 262 void init_hal_spec_8723d(_adapter *adapter);
 263 void SetHwReg8723D(PADAPTER padapter, u8 variable, u8 *val);
 264 void GetHwReg8723D(PADAPTER padapter, u8 variable, u8 *val);
 265 u8 SetHalDefVar8723D(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 266 u8 GetHalDefVar8723D(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 267
 268 /* register */
 269 void rtl8723d_InitBeaconParameters(PADAPTER padapter);
 270 void rtl8723d_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
 271 void _InitBurstPktLen_8723DS(PADAPTER Adapter);
 272 void _InitLTECoex_8723DS(PADAPTER Adapter);
 273 void _InitMacAPLLSetting_8723D(PADAPTER Adapter);
 274 void _8051Reset8723(PADAPTER padapter);
 275 #ifdef CONFIG_WOWLAN
 276         void Hal_DetectWoWMode(PADAPTER pAdapter);
 277 #endif /* CONFIG_WOWLAN */
 278
 279 void rtl8723d_start_thread(_adapter *padapter);
 280 void rtl8723d_stop_thread(_adapter *padapter);
 281
 282 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
 283         void rtl8723ds_init_checkbthang_workqueue(_adapter *adapter);
 284         void rtl8723ds_free_checkbthang_workqueue(_adapter *adapter);
 285         void rtl8723ds_cancle_checkbthang_workqueue(_adapter *adapter);
 286         void rtl8723ds_hal_check_bt_hang(_adapter *adapter);
 287 #endif
 288
 289 #ifdef CONFIG_GPIO_WAKEUP
 290         void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);
 291 #endif
 292 #ifdef CONFIG_MP_INCLUDED
 293 int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
 294 #endif
 295 void CCX_FwC2HTxRpt_8723d(PADAPTER padapter, u8 *pdata, u8 len);
 296
 297 u8 MRateToHwRate8723D(u8 rate);
 298 u8 HwRateToMRate8723D(u8 rate);
 299
 300 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 301
 302 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
 303         void check_bt_status_work(void *data);
 304 #endif
 305
 306 #ifdef CONFIG_USB_HCI
 307         void rtl8723d_cal_txdesc_chksum(struct tx_desc *ptxdesc);
 308 #endif
 309
 310 #ifdef CONFIG_PCI_HCI
 311         BOOLEAN InterruptRecognized8723DE(PADAPTER Adapter);
 312         VOID    UpdateInterruptMask8723DE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
 313         u16 get_txbufdesc_idx_hwaddr(u16 ff_hwaddr);
 314 #endif
 315
 316 #endif