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 __RTL8710B_HAL_H__ 16 #define __RTL8710B_HAL_H__ 17 18 #include "hal_data.h" 19 20 #include "rtl8710b_spec.h" 21 #include "rtl8710b_rf.h" 22 #include "rtl8710b_dm.h" 23 #include "rtl8710b_recv.h" 24 #include "rtl8710b_xmit.h" 25 #include "rtl8710b_cmd.h" 26 #include "rtl8710b_led.h" 27 #include "Hal8710BPwrSeq.h" 28 #include "Hal8710BPhyReg.h" 29 #include "Hal8710BPhyCfg.h" 30 #ifdef DBG_CONFIG_ERROR_DETECT 31 #include "rtl8710b_sreset.h" 32 #endif 33 #ifdef CONFIG_LPS_POFF 34 #include "rtl8710b_lps_poff.h" 35 #endif 36 37 #define FW_8710B_SIZE 0x8000 38 #define FW_8710B_START_ADDRESS 0x1000 39 #define FW_8710B_END_ADDRESS 0x1FFF /* 0x5FFF */ 40 41 typedef struct _RT_FIRMWARE { 42 FIRMWARE_SOURCE eFWSource; 43 #ifdef CONFIG_EMBEDDED_FWIMG 44 u8 *szFwBuffer; 45 #else 46 u8 szFwBuffer[FW_8710B_SIZE]; 47 #endif 48 u32 ulFwLength; 49 } RT_FIRMWARE_8710B, *PRT_FIRMWARE_8710B; 50 51 /* 52 * This structure must be cared byte-ordering 53 * 54 * Added by tynli. 2009.12.04. */ 55 typedef struct _RT_8710B_FIRMWARE_HDR { 56 /* 8-byte alinment required */ 57 58 /* --- LONG WORD 0 ---- */ 59 u16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */ 60 u8 Category; /* AP/NIC and USB/PCI */ 61 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */ 62 u16 Version; /* FW Version */ 63 u16 Subversion; /* FW Subversion, default 0x00 */ 64 65 /* --- LONG WORD 1 ---- */ 66 u8 Month; /* Release time Month field */ 67 u8 Date; /* Release time Date field */ 68 u8 Hour; /* Release time Hour field */ 69 u8 Minute; /* Release time Minute field */ 70 u16 RamCodeSize; /* The size of RAM code */ 71 u16 Rsvd2; 72 73 /* --- LONG WORD 2 ---- */ 74 u32 SvnIdx; /* The SVN entry index */ 75 u32 Rsvd3; 76 77 /* --- LONG WORD 3 ---- */ 78 u32 Rsvd4; 79 u32 Rsvd5; 80 } RT_8710B_FIRMWARE_HDR, *PRT_8710B_FIRMWARE_HDR; 81 82 #define DRIVER_EARLY_INT_TIME_8710B 0x05 83 #define BCN_DMA_ATIME_INT_TIME_8710B 0x02 84 85 /* for 8710B 86 * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */ 87 #define PAGE_SIZE_TX_8710B 128 88 #define PAGE_SIZE_RX_8710B 8 89 90 #define TX_DMA_SIZE_8710B 0x8000 /* 32K(TX) */ 91 #define RX_DMA_SIZE_8710B 0x4000 /* 16K(RX) */ 92 93 #ifdef CONFIG_WOWLAN 94 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/ 95 #else 96 #define RESV_FMWF 0 97 #endif 98 99 #ifdef CONFIG_FW_C2H_DEBUG 100 #define RX_DMA_RESERVED_SIZE_8710B 0x100 /* 256B, reserved for c2h debug message */ 101 #else 102 #define RX_DMA_RESERVED_SIZE_8710B 0x80 /* 128B, reserved for tx report */ 103 #endif 104 #define RX_DMA_BOUNDARY_8710B\ 105 (RX_DMA_SIZE_8710B - RX_DMA_RESERVED_SIZE_8710B - 1) 106 107 108 /* Note: We will divide number of page equally for each queue other than public queue! */ 109 110 /* For General Reserved Page Number(Beacon Queue is reserved page) 111 * Beacon:MAX_BEACON_LEN/PAGE_SIZE_TX_8710B 112 * PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1,CTS-2-SELF,LTE QoS Null*/ 113 #define BCNQ_PAGE_NUM_8710B (MAX_BEACON_LEN/PAGE_SIZE_TX_8710B + 6) /*0x08*/ 114 115 116 /* For WoWLan , more reserved page 117 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt 1, PNO: 6 118 * NS offload: 2 NDP info: 1 119 */ 120 #ifdef CONFIG_WOWLAN 121 #define WOWLAN_PAGE_NUM_8710B 0x0b 122 #else 123 #define WOWLAN_PAGE_NUM_8710B 0x00 124 #endif 125 126 #ifdef CONFIG_PNO_SUPPORT 127 #undef WOWLAN_PAGE_NUM_8710B 128 #define WOWLAN_PAGE_NUM_8710B 0x15 129 #endif 130 131 #ifdef CONFIG_AP_WOWLAN 132 #define AP_WOWLAN_PAGE_NUM_8710B 0x02 133 #endif 134 135 #define TX_TOTAL_PAGE_NUMBER_8710B\ 136 (0xFF - BCNQ_PAGE_NUM_8710B -WOWLAN_PAGE_NUM_8710B) 137 #define TX_PAGE_BOUNDARY_8710B (TX_TOTAL_PAGE_NUMBER_8710B + 1) 138 139 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8710B TX_TOTAL_PAGE_NUMBER_8710B 140 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8710B\ 141 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8710B + 1) 142 143 /* For Normal Chip Setting 144 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8710B */ 145 #define NORMAL_PAGE_NUM_HPQ_8710B 0x0C 146 #define NORMAL_PAGE_NUM_LPQ_8710B 0x02 147 #define NORMAL_PAGE_NUM_NPQ_8710B 0x02 148 #define NORMAL_PAGE_NUM_EPQ_8710B 0x04 149 150 /* Note: For Normal Chip Setting, modify later */ 151 #define WMM_NORMAL_PAGE_NUM_HPQ_8710B 0x30 152 #define WMM_NORMAL_PAGE_NUM_LPQ_8710B 0x20 153 #define WMM_NORMAL_PAGE_NUM_NPQ_8710B 0x20 154 #define WMM_NORMAL_PAGE_NUM_EPQ_8710B 0x00 155 156 157 #include "HalVerDef.h" 158 #include "hal_com.h" 159 160 #define EFUSE_OOB_PROTECT_BYTES (96 + 1) 161 162 #define HAL_EFUSE_MEMORY 163 #define HWSET_MAX_SIZE_8710B 512 164 #define EFUSE_REAL_CONTENT_LEN_8710B 512 165 #define EFUSE_MAP_LEN_8710B 512 166 #define EFUSE_MAX_SECTION_8710B 64 167 168 /* For some inferiority IC purpose. added by Roger, 2009.09.02.*/ 169 #define EFUSE_IC_ID_OFFSET 506 170 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8710B) 171 172 #define EFUSE_ACCESS_ON 0x69 173 #define EFUSE_ACCESS_OFF 0x00 174 175 #define PACKAGE_QFN32_S 0 176 #define PACKAGE_QFN48M_S 1 //definiton 8188GU Dongle Package, Efuse Physical Address 0xF8 = 0xFE 177 #define PACKAGE_QFN48_S 2 178 #define PACKAGE_QFN64_S 3 179 #define PACKAGE_QFN32_U 4 180 #define PACKAGE_QFN48M_U 5 //definiton 8188GU Dongle Package, Efuse Physical Address 0xF8 = 0xEE 181 #define PACKAGE_QFN48_U 6 182 #define PACKAGE_QFN68_U 7 183 184 typedef enum _PACKAGE_TYPE_E 185 { 186 PACKAGE_DEFAULT, 187 PACKAGE_QFN68, 188 PACKAGE_TFBGA90, 189 PACKAGE_TFBGA80, 190 PACKAGE_TFBGA79 191 }PACKAGE_TYPE_E; 192 193 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \ 194 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 195 196 #ifdef CONFIG_FILE_FWIMG 197 extern char *rtw_fw_file_path; 198 extern char *rtw_fw_wow_file_path; 199 #ifdef CONFIG_MP_INCLUDED 200 extern char *rtw_fw_mp_bt_file_path; 201 #endif /* CONFIG_MP_INCLUDED */ 202 #endif /* CONFIG_FILE_FWIMG */ 203 204 /* rtl8710b_hal_init.c */ 205 s32 rtl8710b_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 206 void rtl8710b_FirmwareSelfReset(PADAPTER padapter); 207 void rtl8710b_InitializeFirmwareVars(PADAPTER padapter); 208 209 void rtl8710b_InitAntenna_Selection(PADAPTER padapter); 210 void rtl8710b_DeinitAntenna_Selection(PADAPTER padapter); 211 void rtl8710b_CheckAntenna_Selection(PADAPTER padapter); 212 void rtl8710b_init_default_value(PADAPTER padapter); 213 214 215 u32 indirect_read32_8710b(PADAPTER padapter, u32 regaddr); 216 void indirect_write32_8710b(PADAPTER padapter, u32 regaddr, u32 data); 217 u32 hal_query_syson_reg_8710b(PADAPTER padapter, u32 regaddr, u32 bitmask); 218 void hal_set_syson_reg_8710b(PADAPTER padapter, u32 regaddr, u32 bitmask, u32 data); 219 #define HAL_SetSYSOnReg hal_set_syson_reg_8710b 220 221 222 /* EFuse */ 223 u8 GetEEPROMSize8710B(PADAPTER padapter); 224 225 #if 0 226 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 227 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 228 void Hal_EfuseParseTxPowerInfo_8710B(PADAPTER padapter, 229 u8 *PROMContent, BOOLEAN AutoLoadFail); 230 void Hal_EfuseParseEEPROMVer_8710B(PADAPTER padapter, 231 u8 *hwinfo, BOOLEAN AutoLoadFail); 232 void Hal_EfuseParsePackageType_8710B(PADAPTER pAdapter, 233 u8 *hwinfo, BOOLEAN AutoLoadFail); 234 void Hal_EfuseParseChnlPlan_8710B(PADAPTER padapter, 235 u8 *hwinfo, BOOLEAN AutoLoadFail); 236 void Hal_EfuseParseCustomerID_8710B(PADAPTER padapter, 237 u8 *hwinfo, BOOLEAN AutoLoadFail); 238 void Hal_EfuseParseAntennaDiversity_8710B(PADAPTER padapter, 239 u8 *hwinfo, BOOLEAN AutoLoadFail); 240 void Hal_EfuseParseXtal_8710B(PADAPTER pAdapter, 241 u8 *hwinfo, u8 AutoLoadFail); 242 void Hal_EfuseParseThermalMeter_8710B(PADAPTER padapter, 243 u8 *hwinfo, u8 AutoLoadFail); 244 void Hal_EfuseParseBoardType_8710B(PADAPTER Adapter, 245 u8 *PROMContent, BOOLEAN AutoloadFail); 246 #endif 247 248 void rtl8710b_set_hal_ops(struct hal_ops *pHalFunc); 249 void init_hal_spec_8710b(_adapter *adapter); 250 u8 SetHwReg8710B(PADAPTER padapter, u8 variable, u8 *val); 251 void GetHwReg8710B(PADAPTER padapter, u8 variable, u8 *val); 252 u8 SetHalDefVar8710B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 253 u8 GetHalDefVar8710B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 254 255 /* register */ 256 void rtl8710b_InitBeaconParameters(PADAPTER padapter); 257 void rtl8710b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 258 void _8051Reset8710(PADAPTER padapter); 259 260 void rtl8710b_start_thread(_adapter *padapter); 261 void rtl8710b_stop_thread(_adapter *padapter); 262 263 #ifdef CONFIG_GPIO_WAKEUP 264 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 265 #endif 266 267 void CCX_FwC2HTxRpt_8710b(PADAPTER padapter, u8 *pdata, u8 len); 268 269 u8 MRateToHwRate8710B(u8 rate); 270 u8 HwRateToMRate8710B(u8 rate); 271 272 #ifdef CONFIG_USB_HCI 273 void rtl8710b_cal_txdesc_chksum(struct tx_desc *ptxdesc); 274 #endif 275 276 277 #endif 278