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