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 __RTL8723B_HAL_H__ 16 #define __RTL8723B_HAL_H__ 17 18 #include "hal_data.h" 19 20 #include "rtl8723b_spec.h" 21 #include "rtl8723b_rf.h" 22 #include "rtl8723b_dm.h" 23 #include "rtl8723b_recv.h" 24 #include "rtl8723b_xmit.h" 25 #include "rtl8723b_cmd.h" 26 #include "rtl8723b_led.h" 27 #include "Hal8723BPwrSeq.h" 28 #include "Hal8723BPhyReg.h" 29 #include "Hal8723BPhyCfg.h" 30 #ifdef DBG_CONFIG_ERROR_DETECT 31 #include "rtl8723b_sreset.h" 32 #endif 33 34 #define FW_8723B_SIZE 0x8000 35 #define FW_8723B_START_ADDRESS 0x1000 36 #define FW_8723B_END_ADDRESS 0x1FFF /* 0x5FFF */ 37 38 #define IS_FW_HEADER_EXIST_8723B(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x5300) 39 40 typedef struct _RT_FIRMWARE { 41 FIRMWARE_SOURCE eFWSource; 42 #ifdef CONFIG_EMBEDDED_FWIMG 43 u8 *szFwBuffer; 44 #else 45 u8 szFwBuffer[FW_8723B_SIZE]; 46 #endif 47 u32 ulFwLength; 48 } RT_FIRMWARE_8723B, *PRT_FIRMWARE_8723B; 49 50 /* 51 * This structure must be cared byte-ordering 52 * 53 * Added by tynli. 2009.12.04. */ 54 typedef struct _RT_8723B_FIRMWARE_HDR { 55 /* 8-byte alinment required */ 56 57 /* --- LONG WORD 0 ---- */ 58 u16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */ 59 u8 Category; /* AP/NIC and USB/PCI */ 60 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */ 61 u16 Version; /* FW Version */ 62 u16 Subversion; /* FW Subversion, default 0x00 */ 63 64 /* --- LONG WORD 1 ---- */ 65 u8 Month; /* Release time Month field */ 66 u8 Date; /* Release time Date field */ 67 u8 Hour; /* Release time Hour field */ 68 u8 Minute; /* Release time Minute field */ 69 u16 RamCodeSize; /* The size of RAM code */ 70 u16 Rsvd2; 71 72 /* --- LONG WORD 2 ---- */ 73 u32 SvnIdx; /* The SVN entry index */ 74 u32 Rsvd3; 75 76 /* --- LONG WORD 3 ---- */ 77 u32 Rsvd4; 78 u32 Rsvd5; 79 } RT_8723B_FIRMWARE_HDR, *PRT_8723B_FIRMWARE_HDR; 80 81 #define DRIVER_EARLY_INT_TIME_8723B 0x05 82 #define BCN_DMA_ATIME_INT_TIME_8723B 0x02 83 84 /* for 8723B 85 * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */ 86 #define PAGE_SIZE_TX_8723B 128 87 #define PAGE_SIZE_RX_8723B 8 88 89 #define TX_DMA_SIZE_8723B 0x8000 /* 32K(TX) */ 90 #define RX_DMA_SIZE_8723B 0x4000 /* 16K(RX) */ 91 92 #ifdef CONFIG_WOWLAN 93 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/ 94 #else 95 #define RESV_FMWF 0 96 #endif 97 98 #ifdef CONFIG_FW_C2H_DEBUG 99 #define RX_DMA_RESERVED_SIZE_8723B 0x100 /* 256B, reserved for c2h debug message */ 100 #else 101 #define RX_DMA_RESERVED_SIZE_8723B 0x80 /* 128B, reserved for tx report */ 102 #endif 103 #define RX_DMA_BOUNDARY_8723B (RX_DMA_SIZE_8723B - RX_DMA_RESERVED_SIZE_8723B - 1) 104 105 106 /* Note: We will divide number of page equally for each queue other than public queue! */ 107 108 /* For General Reserved Page Number(Beacon Queue is reserved page) 109 * Beacon:MAX_BEACON_LEN/PAGE_SIZE_TX_8723B 110 * PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1,CTS-2-SELF,LTE QoS Null*/ 111 #define BCNQ_PAGE_NUM_8723B (MAX_BEACON_LEN / PAGE_SIZE_TX_8723B + 6) /*0x08*/ 112 113 114 /* For WoWLan , more reserved page 115 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt: 1,PNO: 6 116 * NS offload: 2 NDP info: 1 117 */ 118 #ifdef CONFIG_WOWLAN 119 #define WOWLAN_PAGE_NUM_8723B 0x0b 120 #else 121 #define WOWLAN_PAGE_NUM_8723B 0x00 122 #endif 123 124 #ifdef CONFIG_PNO_SUPPORT 125 #undef WOWLAN_PAGE_NUM_8723B 126 #define WOWLAN_PAGE_NUM_8723B 0x15 127 #endif 128 129 #ifdef CONFIG_AP_WOWLAN 130 #define AP_WOWLAN_PAGE_NUM_8723B 0x02 131 #endif 132 133 #define TX_TOTAL_PAGE_NUMBER_8723B (0xFF - BCNQ_PAGE_NUM_8723B - WOWLAN_PAGE_NUM_8723B) 134 #define TX_PAGE_BOUNDARY_8723B (TX_TOTAL_PAGE_NUMBER_8723B + 1) 135 136 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B TX_TOTAL_PAGE_NUMBER_8723B 137 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723B (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B + 1) 138 139 /* For Normal Chip Setting 140 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */ 141 #define NORMAL_PAGE_NUM_HPQ_8723B 0x0C 142 #define NORMAL_PAGE_NUM_LPQ_8723B 0x02 143 #define NORMAL_PAGE_NUM_NPQ_8723B 0x02 144 #define NORMAL_PAGE_NUM_EPQ_8723B 0x04 145 146 /* Note: For Normal Chip Setting, modify later */ 147 #define WMM_NORMAL_PAGE_NUM_HPQ_8723B 0x30 148 #define WMM_NORMAL_PAGE_NUM_LPQ_8723B 0x20 149 #define WMM_NORMAL_PAGE_NUM_NPQ_8723B 0x20 150 #define WMM_NORMAL_PAGE_NUM_EPQ_8723B 0x00 151 152 153 #include "HalVerDef.h" 154 #include "hal_com.h" 155 156 #define EFUSE_OOB_PROTECT_BYTES 15 157 158 #define HAL_EFUSE_MEMORY 159 160 #define HWSET_MAX_SIZE_8723B 512 161 #define EFUSE_REAL_CONTENT_LEN_8723B 512 162 #define EFUSE_MAP_LEN_8723B 512 163 #define EFUSE_MAX_SECTION_8723B 64 164 165 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 166 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8723B) 167 168 #define EFUSE_ACCESS_ON 0x69 /* For RTL8723 only. */ 169 #define EFUSE_ACCESS_OFF 0x00 /* For RTL8723 only. */ 170 171 /* ******************************************************** 172 * EFUSE for BT definition 173 * ******************************************************** */ 174 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512 175 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */ 176 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 177 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ 178 179 #define EFUSE_PROTECT_BYTES_BANK 16 180 181 typedef enum tag_Package_Definition { 182 PACKAGE_DEFAULT, 183 PACKAGE_QFN68, 184 PACKAGE_TFBGA90, 185 PACKAGE_TFBGA80, 186 PACKAGE_TFBGA79 187 } PACKAGE_TYPE_E; 188 189 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 190 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 191 192 /* rtl8723a_hal_init.c */ 193 s32 rtl8723b_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 194 void rtl8723b_FirmwareSelfReset(PADAPTER padapter); 195 void rtl8723b_InitializeFirmwareVars(PADAPTER padapter); 196 197 void rtl8723b_InitAntenna_Selection(PADAPTER padapter); 198 void rtl8723b_DeinitAntenna_Selection(PADAPTER padapter); 199 void rtl8723b_CheckAntenna_Selection(PADAPTER padapter); 200 void rtl8723b_init_default_value(PADAPTER padapter); 201 202 s32 rtl8723b_InitLLTTable(PADAPTER padapter); 203 204 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 205 s32 CardDisableWithoutHWSM(PADAPTER padapter); 206 207 /* EFuse */ 208 u8 GetEEPROMSize8723B(PADAPTER padapter); 209 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 210 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 211 void Hal_EfuseParseTxPowerInfo_8723B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 212 void Hal_EfuseParseBTCoexistInfo_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 213 void Hal_EfuseParseEEPROMVer_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 214 void Hal_EfuseParseChnlPlan_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 215 void Hal_EfuseParseCustomerID_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 216 void Hal_EfuseParseAntennaDiversity_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 217 void Hal_EfuseParseXtal_8723B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail); 218 void Hal_EfuseParseThermalMeter_8723B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail); 219 void Hal_EfuseParsePackageType_8723B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 220 void Hal_EfuseParseVoltage_8723B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 221 void Hal_EfuseParseBoardType_8723B(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 222 223 void rtl8723b_set_hal_ops(struct hal_ops *pHalFunc); 224 void init_hal_spec_8723b(_adapter *adapter); 225 u8 SetHwReg8723B(PADAPTER padapter, u8 variable, u8 *val); 226 void GetHwReg8723B(PADAPTER padapter, u8 variable, u8 *val); 227 u8 SetHalDefVar8723B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 228 u8 GetHalDefVar8723B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 229 230 /* register */ 231 void rtl8723b_InitBeaconParameters(PADAPTER padapter); 232 void rtl8723b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 233 void _InitBurstPktLen_8723BS(PADAPTER Adapter); 234 void _8051Reset8723(PADAPTER padapter); 235 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN) 236 void Hal_DetectWoWMode(PADAPTER pAdapter); 237 #endif /* CONFIG_WOWLAN */ 238 239 void rtl8723b_start_thread(_adapter *padapter); 240 void rtl8723b_stop_thread(_adapter *padapter); 241 242 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 243 void rtl8723bs_init_checkbthang_workqueue(_adapter *adapter); 244 void rtl8723bs_free_checkbthang_workqueue(_adapter *adapter); 245 void rtl8723bs_cancle_checkbthang_workqueue(_adapter *adapter); 246 void rtl8723bs_hal_check_bt_hang(_adapter *adapter); 247 #endif 248 249 #ifdef CONFIG_GPIO_WAKEUP 250 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 251 #endif 252 #ifdef CONFIG_MP_INCLUDED 253 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 254 #endif 255 void CCX_FwC2HTxRpt_8723b(PADAPTER padapter, u8 *pdata, u8 len); 256 257 u8 MRateToHwRate8723B(u8 rate); 258 u8 HwRateToMRate8723B(u8 rate); 259 260 #ifdef CONFIG_RF_POWER_TRIM 261 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 262 #endif /*CONFIG_RF_POWER_TRIM*/ 263 264 #ifdef CONFIG_PCI_HCI 265 BOOLEAN InterruptRecognized8723BE(PADAPTER Adapter); 266 void UpdateInterruptMask8723BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 267 #endif 268 269 #ifdef CONFIG_GPIO_API 270 int rtl8723b_GpioFuncCheck(PADAPTER adapter, u8 gpio_num); 271 void rtl8723b_GpioMultiFuncReset(PADAPTER adapter, u8 gpio_num); 272 #endif 273 274 #endif 275