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