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:MAX_BEACON_LEN/PAGE_SIZE_TX_8723D 115 * PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1,CTS-2-SELF,LTE QoS Null*/ 116 117 #define BCNQ_PAGE_NUM_8723D (MAX_BEACON_LEN/PAGE_SIZE_TX_8723D + 6) /*0x08*/ 118 119 /* For WoWLan , more reserved page 120 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt 1, PNO: 6 121 * NS offload: 2 NDP info: 1 122 */ 123 #ifdef CONFIG_WOWLAN 124 #define WOWLAN_PAGE_NUM_8723D 0x0b 125 #else 126 #define WOWLAN_PAGE_NUM_8723D 0x00 127 #endif 128 129 #ifdef CONFIG_PNO_SUPPORT 130 #undef WOWLAN_PAGE_NUM_8723D 131 #define WOWLAN_PAGE_NUM_8723D 0x15 132 #endif 133 134 #ifdef CONFIG_AP_WOWLAN 135 #define AP_WOWLAN_PAGE_NUM_8723D 0x02 136 #endif 137 138 #define TX_TOTAL_PAGE_NUMBER_8723D\ 139 (0xFF - BCNQ_PAGE_NUM_8723D - WOWLAN_PAGE_NUM_8723D) 140 #define TX_PAGE_BOUNDARY_8723D (TX_TOTAL_PAGE_NUMBER_8723D + 1) 141 142 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723D TX_TOTAL_PAGE_NUMBER_8723D 143 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723D\ 144 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723D + 1) 145 146 /* For Normal Chip Setting 147 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723D */ 148 #define NORMAL_PAGE_NUM_HPQ_8723D 0x0C 149 #define NORMAL_PAGE_NUM_LPQ_8723D 0x02 150 #define NORMAL_PAGE_NUM_NPQ_8723D 0x02 151 #define NORMAL_PAGE_NUM_EPQ_8723D 0x04 152 153 /* Note: For Normal Chip Setting, modify later */ 154 #define WMM_NORMAL_PAGE_NUM_HPQ_8723D 0x30 155 #define WMM_NORMAL_PAGE_NUM_LPQ_8723D 0x20 156 #define WMM_NORMAL_PAGE_NUM_NPQ_8723D 0x20 157 #define WMM_NORMAL_PAGE_NUM_EPQ_8723D 0x00 158 159 160 #include "HalVerDef.h" 161 #include "hal_com.h" 162 163 #define EFUSE_OOB_PROTECT_BYTES (96 + 1) 164 165 #define HAL_EFUSE_MEMORY 166 #define HWSET_MAX_SIZE_8723D 512 167 #define EFUSE_REAL_CONTENT_LEN_8723D 512 168 #define EFUSE_MAP_LEN_8723D 512 169 #define EFUSE_MAX_SECTION_8723D 64 170 171 /* For some inferiority IC purpose. added by Roger, 2009.09.02.*/ 172 #define EFUSE_IC_ID_OFFSET 506 173 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8723D) 174 175 #define EFUSE_ACCESS_ON 0x69 176 #define EFUSE_ACCESS_OFF 0x00 177 178 /* ******************************************************** 179 * EFUSE for BT definition 180 * ******************************************************** */ 181 #define BANK_NUM 1 182 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 128 183 #define EFUSE_BT_REAL_CONTENT_LEN \ 184 (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM) 185 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 186 #define EFUSE_BT_MAX_SECTION (EFUSE_BT_MAP_LEN / 8) 187 #define EFUSE_PROTECT_BYTES_BANK 16 188 189 typedef enum tag_Package_Definition { 190 PACKAGE_DEFAULT, 191 PACKAGE_QFN68, 192 PACKAGE_TFBGA90, 193 PACKAGE_TFBGA80, 194 PACKAGE_TFBGA79 195 } PACKAGE_TYPE_E; 196 197 #define INCLUDE_MULTI_FUNC_BT(_Adapter) \ 198 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 199 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \ 200 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 201 202 #ifdef CONFIG_FILE_FWIMG 203 extern char *rtw_fw_file_path; 204 extern char *rtw_fw_wow_file_path; 205 #ifdef CONFIG_MP_INCLUDED 206 extern char *rtw_fw_mp_bt_file_path; 207 #endif /* CONFIG_MP_INCLUDED */ 208 #endif /* CONFIG_FILE_FWIMG */ 209 210 /* rtl8723d_hal_init.c */ 211 s32 rtl8723d_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 212 void rtl8723d_FirmwareSelfReset(PADAPTER padapter); 213 void rtl8723d_InitializeFirmwareVars(PADAPTER padapter); 214 215 void rtl8723d_InitAntenna_Selection(PADAPTER padapter); 216 void rtl8723d_DeinitAntenna_Selection(PADAPTER padapter); 217 void rtl8723d_CheckAntenna_Selection(PADAPTER padapter); 218 void rtl8723d_init_default_value(PADAPTER padapter); 219 220 s32 rtl8723d_InitLLTTable(PADAPTER padapter); 221 222 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 223 s32 CardDisableWithoutHWSM(PADAPTER padapter); 224 225 /* EFuse */ 226 u8 GetEEPROMSize8723D(PADAPTER padapter); 227 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 228 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 229 void Hal_EfuseParseTxPowerInfo_8723D(PADAPTER padapter, 230 u8 *PROMContent, BOOLEAN AutoLoadFail); 231 void Hal_EfuseParseBTCoexistInfo_8723D(PADAPTER padapter, 232 u8 *hwinfo, BOOLEAN AutoLoadFail); 233 void Hal_EfuseParseEEPROMVer_8723D(PADAPTER padapter, 234 u8 *hwinfo, BOOLEAN AutoLoadFail); 235 void Hal_EfuseParseChnlPlan_8723D(PADAPTER padapter, 236 u8 *hwinfo, BOOLEAN AutoLoadFail); 237 void Hal_EfuseParseCustomerID_8723D(PADAPTER padapter, 238 u8 *hwinfo, BOOLEAN AutoLoadFail); 239 void Hal_EfuseParseAntennaDiversity_8723D(PADAPTER padapter, 240 u8 *hwinfo, BOOLEAN AutoLoadFail); 241 void Hal_EfuseParseXtal_8723D(PADAPTER pAdapter, 242 u8 *hwinfo, u8 AutoLoadFail); 243 void Hal_EfuseParseThermalMeter_8723D(PADAPTER padapter, 244 u8 *hwinfo, u8 AutoLoadFail); 245 void Hal_EfuseParseVoltage_8723D(PADAPTER pAdapter, 246 u8 *hwinfo, BOOLEAN AutoLoadFail); 247 void Hal_EfuseParseBoardType_8723D(PADAPTER Adapter, 248 u8 *PROMContent, BOOLEAN AutoloadFail); 249 250 void rtl8723d_set_hal_ops(struct hal_ops *pHalFunc); 251 void init_hal_spec_8723d(_adapter *adapter); 252 u8 SetHwReg8723D(PADAPTER padapter, u8 variable, u8 *val); 253 void GetHwReg8723D(PADAPTER padapter, u8 variable, u8 *val); 254 u8 SetHalDefVar8723D(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 255 u8 GetHalDefVar8723D(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 256 257 /* register */ 258 void rtl8723d_InitBeaconParameters(PADAPTER padapter); 259 void rtl8723d_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 260 void _InitMacAPLLSetting_8723D(PADAPTER Adapter); 261 void _8051Reset8723(PADAPTER padapter); 262 #ifdef CONFIG_WOWLAN 263 void Hal_DetectWoWMode(PADAPTER pAdapter); 264 #endif /* CONFIG_WOWLAN */ 265 266 void rtl8723d_start_thread(_adapter *padapter); 267 void rtl8723d_stop_thread(_adapter *padapter); 268 269 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 270 void rtl8723ds_init_checkbthang_workqueue(_adapter *adapter); 271 void rtl8723ds_free_checkbthang_workqueue(_adapter *adapter); 272 void rtl8723ds_cancle_checkbthang_workqueue(_adapter *adapter); 273 void rtl8723ds_hal_check_bt_hang(_adapter *adapter); 274 #endif 275 276 #ifdef CONFIG_GPIO_WAKEUP 277 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 278 #endif 279 #ifdef CONFIG_MP_INCLUDED 280 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 281 #endif 282 void CCX_FwC2HTxRpt_8723d(PADAPTER padapter, u8 *pdata, u8 len); 283 284 u8 MRateToHwRate8723D(u8 rate); 285 u8 HwRateToMRate8723D(u8 rate); 286 287 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 288 289 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 290 void check_bt_status_work(void *data); 291 #endif 292 293 #ifdef CONFIG_USB_HCI 294 void rtl8723d_cal_txdesc_chksum(struct tx_desc *ptxdesc); 295 #endif 296 297 #ifdef CONFIG_PCI_HCI 298 BOOLEAN InterruptRecognized8723DE(PADAPTER Adapter); 299 void UpdateInterruptMask8723DE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 300 u16 get_txbd_rw_reg(u16 ff_hwaddr); 301 #endif 302 303 #endif 304