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