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