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 __RTL8703B_HAL_H__ 17 #define __RTL8703B_HAL_H__ 18 19 #include "hal_data.h" 20 21 #include "rtl8703b_spec.h" 22 #include "rtl8703b_rf.h" 23 #include "rtl8703b_dm.h" 24 #include "rtl8703b_recv.h" 25 #include "rtl8703b_xmit.h" 26 #include "rtl8703b_cmd.h" 27 #include "rtl8703b_led.h" 28 #include "Hal8703BPwrSeq.h" 29 #include "Hal8703BPhyReg.h" 30 #include "Hal8703BPhyCfg.h" 31 #ifdef DBG_CONFIG_ERROR_DETECT 32 #include "rtl8703b_sreset.h" 33 #endif 34 35 #define FW_8703B_SIZE 0x8000 36 #define FW_8703B_START_ADDRESS 0x1000 37 #define FW_8703B_END_ADDRESS 0x1FFF /* 0x5FFF */ 38 39 #define IS_FW_HEADER_EXIST_8703B(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x03B0) 40 41 typedef struct _RT_FIRMWARE { 42 FIRMWARE_SOURCE eFWSource; 43 #ifdef CONFIG_EMBEDDED_FWIMG 44 u8 *szFwBuffer; 45 #else 46 u8 szFwBuffer[FW_8703B_SIZE]; 47 #endif 48 u32 ulFwLength; 49 } RT_FIRMWARE_8703B, *PRT_FIRMWARE_8703B; 50 51 /* 52 * This structure must be cared byte-ordering 53 * 54 * Added by tynli. 2009.12.04. */ 55 typedef struct _RT_8703B_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_8703B_FIRMWARE_HDR, *PRT_8703B_FIRMWARE_HDR; 81 82 #define DRIVER_EARLY_INT_TIME_8703B 0x05 83 #define BCN_DMA_ATIME_INT_TIME_8703B 0x02 84 85 /* for 8703B 86 * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */ 87 #define PAGE_SIZE_TX_8703B 128 88 #define PAGE_SIZE_RX_8703B 8 89 90 #define TX_DMA_SIZE_8703B 0x8000 /* 32K(TX) */ 91 #define RX_DMA_SIZE_8703B 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_8703B 0x100 /* 256B, reserved for c2h debug message */ 101 #else 102 #define RX_DMA_RESERVED_SIZE_8703B 0x80 /* 128B, reserved for tx report */ 103 #endif 104 #define RX_DMA_BOUNDARY_8703B (RX_DMA_SIZE_8703B - RX_DMA_RESERVED_SIZE_8703B - 1) 105 106 107 /* Note: We will divide number of page equally for each queue other than public queue! */ 108 109 /* For General Reserved Page Number(Beacon Queue is reserved page) 110 * Beacon:MAX_BEACON_LEN/PAGE_SIZE_TX_8703B 111 * PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1,CTS-2-SELF,LTE QoS Null*/ 112 113 #define BCNQ_PAGE_NUM_8703B (MAX_BEACON_LEN/PAGE_SIZE_TX_8703B + 6) /*0x08*/ 114 115 /* For WoWLan , more reserved page 116 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt: 1 PNO: 6 117 * NS offload: 2NDP info: 1 118 */ 119 #ifdef CONFIG_WOWLAN 120 #define WOWLAN_PAGE_NUM_8703B 0x0b 121 #else 122 #define WOWLAN_PAGE_NUM_8703B 0x00 123 #endif 124 125 #ifdef CONFIG_PNO_SUPPORT 126 #undef WOWLAN_PAGE_NUM_8703B 127 #define WOWLAN_PAGE_NUM_8703B 0x15 128 #endif 129 130 #ifdef CONFIG_AP_WOWLAN 131 #define AP_WOWLAN_PAGE_NUM_8703B 0x02 132 #endif 133 134 #define TX_TOTAL_PAGE_NUMBER_8703B (0xFF - BCNQ_PAGE_NUM_8703B - WOWLAN_PAGE_NUM_8703B) 135 #define TX_PAGE_BOUNDARY_8703B (TX_TOTAL_PAGE_NUMBER_8703B + 1) 136 137 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B TX_TOTAL_PAGE_NUMBER_8703B 138 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8703B (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B + 1) 139 140 /* For Normal Chip Setting 141 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8703B */ 142 #define NORMAL_PAGE_NUM_HPQ_8703B 0x0C 143 #define NORMAL_PAGE_NUM_LPQ_8703B 0x02 144 #define NORMAL_PAGE_NUM_NPQ_8703B 0x02 145 146 /* Note: For Normal Chip Setting, modify later */ 147 #define WMM_NORMAL_PAGE_NUM_HPQ_8703B 0x30 148 #define WMM_NORMAL_PAGE_NUM_LPQ_8703B 0x20 149 #define WMM_NORMAL_PAGE_NUM_NPQ_8703B 0x20 150 151 152 #include "HalVerDef.h" 153 #include "hal_com.h" 154 155 #define EFUSE_OOB_PROTECT_BYTES 15 156 157 #define HAL_EFUSE_MEMORY 158 159 #define HWSET_MAX_SIZE_8703B 256 160 #define EFUSE_REAL_CONTENT_LEN_8703B 256 161 #define EFUSE_MAP_LEN_8703B 512 162 #define EFUSE_MAX_SECTION_8703B 64 163 164 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 165 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8703B) 166 167 #define EFUSE_ACCESS_ON 0x69 168 #define EFUSE_ACCESS_OFF 0x00 169 170 /* ******************************************************** 171 * EFUSE for BT definition 172 * ******************************************************** */ 173 #define BANK_NUM 1 174 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 128 175 #define EFUSE_BT_REAL_CONTENT_LEN (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM) 176 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 177 #define EFUSE_BT_MAX_SECTION (EFUSE_BT_MAP_LEN / 8) 178 #define EFUSE_PROTECT_BYTES_BANK 16 179 180 typedef enum tag_Package_Definition { 181 PACKAGE_DEFAULT, 182 PACKAGE_QFN68, 183 PACKAGE_TFBGA90, 184 PACKAGE_TFBGA80, 185 PACKAGE_TFBGA79 186 } PACKAGE_TYPE_E; 187 188 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 189 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 190 191 /* rtl8703b_hal_init.c */ 192 s32 rtl8703b_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 193 void rtl8703b_FirmwareSelfReset(PADAPTER padapter); 194 void rtl8703b_InitializeFirmwareVars(PADAPTER padapter); 195 196 void rtl8703b_InitAntenna_Selection(PADAPTER padapter); 197 void rtl8703b_DeinitAntenna_Selection(PADAPTER padapter); 198 void rtl8703b_CheckAntenna_Selection(PADAPTER padapter); 199 void rtl8703b_init_default_value(PADAPTER padapter); 200 201 s32 rtl8703b_InitLLTTable(PADAPTER padapter); 202 203 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 204 s32 CardDisableWithoutHWSM(PADAPTER padapter); 205 206 /* EFuse */ 207 u8 GetEEPROMSize8703B(PADAPTER padapter); 208 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 209 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 210 void Hal_EfuseParseTxPowerInfo_8703B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 211 void Hal_EfuseParseBTCoexistInfo_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 212 void Hal_EfuseParseEEPROMVer_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 213 void Hal_EfuseParseChnlPlan_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 214 void Hal_EfuseParseCustomerID_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 215 void Hal_EfuseParseAntennaDiversity_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 216 void Hal_EfuseParseXtal_8703B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail); 217 void Hal_EfuseParseThermalMeter_8703B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail); 218 void Hal_EfuseParseVoltage_8703B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 219 void Hal_EfuseParseBoardType_8703B(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 220 221 void rtl8703b_set_hal_ops(struct hal_ops *pHalFunc); 222 void init_hal_spec_8703b(_adapter *adapter); 223 u8 SetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val); 224 void GetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val); 225 u8 SetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 226 u8 GetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 227 228 /* register */ 229 void rtl8703b_InitBeaconParameters(PADAPTER padapter); 230 void rtl8703b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 231 void _InitBurstPktLen_8703BS(PADAPTER Adapter); 232 void _InitLTECoex_8703BS(PADAPTER Adapter); 233 void _InitMacAPLLSetting_8703B(PADAPTER Adapter); 234 void _8051Reset8703(PADAPTER padapter); 235 #ifdef CONFIG_WOWLAN 236 void Hal_DetectWoWMode(PADAPTER pAdapter); 237 #endif /* CONFIG_WOWLAN */ 238 239 void rtl8703b_start_thread(_adapter *padapter); 240 void rtl8703b_stop_thread(_adapter *padapter); 241 242 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 243 void rtl8703bs_init_checkbthang_workqueue(_adapter *adapter); 244 void rtl8703bs_free_checkbthang_workqueue(_adapter *adapter); 245 void rtl8703bs_cancle_checkbthang_workqueue(_adapter *adapter); 246 void rtl8703bs_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_8703b(PADAPTER padapter, u8 *pdata, u8 len); 256 257 u8 MRateToHwRate8703B(u8 rate); 258 u8 HwRateToMRate8703B(u8 rate); 259 260 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 261 262 #ifdef CONFIG_PCI_HCI 263 BOOLEAN InterruptRecognized8703BE(PADAPTER Adapter); 264 void UpdateInterruptMask8703BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 265 #endif 266 267 #endif 268