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 __RTL8188F_HAL_H__ 17 #define __RTL8188F_HAL_H__ 18 19 #include "hal_data.h" 20 21 #include "rtl8188f_spec.h" 22 #include "rtl8188f_rf.h" 23 #include "rtl8188f_dm.h" 24 #include "rtl8188f_recv.h" 25 #include "rtl8188f_xmit.h" 26 #include "rtl8188f_cmd.h" 27 #include "rtl8188f_led.h" 28 #include "Hal8188FPwrSeq.h" 29 #include "Hal8188FPhyReg.h" 30 #include "Hal8188FPhyCfg.h" 31 #ifdef DBG_CONFIG_ERROR_DETECT 32 #include "rtl8188f_sreset.h" 33 #endif 34 35 #define FW_8188F_SIZE 0x8000 36 #define FW_8188F_START_ADDRESS 0x1000 37 #define FW_8188F_END_ADDRESS 0x1FFF /* 0x5FFF */ 38 39 #define IS_FW_HEADER_EXIST_8188F(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x88F0) 40 41 typedef struct _RT_FIRMWARE { 42 FIRMWARE_SOURCE eFWSource; 43 #ifdef CONFIG_EMBEDDED_FWIMG 44 u8 *szFwBuffer; 45 #else 46 u8 szFwBuffer[FW_8188F_SIZE]; 47 #endif 48 u32 ulFwLength; 49 } RT_FIRMWARE_8188F, *PRT_FIRMWARE_8188F; 50 51 /* 52 * This structure must be cared byte-ordering 53 * 54 * Added by tynli. 2009.12.04. */ 55 typedef struct _RT_8188F_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_8188F_FIRMWARE_HDR, *PRT_8188F_FIRMWARE_HDR; 81 82 #define DRIVER_EARLY_INT_TIME_8188F 0x05 83 #define BCN_DMA_ATIME_INT_TIME_8188F 0x02 84 85 /* for 8188F 86 * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */ 87 #define PAGE_SIZE_TX_8188F 128 88 #define PAGE_SIZE_RX_8188F 8 89 90 #define RX_DMA_SIZE_8188F 0x4000 /* 16K */ 91 #ifdef CONFIG_FW_C2H_DEBUG 92 #define RX_DMA_RESERVED_SIZE_8188F 0x100 /* 256B, reserved for c2h debug message */ 93 #else 94 #define RX_DMA_RESERVED_SIZE_8188F 0x80 /* 128B, reserved for tx report */ 95 #endif 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 #define RX_DMA_BOUNDARY_8188F (RX_DMA_SIZE_8188F - RX_DMA_RESERVED_SIZE_8188F - 1) 104 105 /* Note: We will divide number of page equally for each queue other than public queue! */ 106 107 /* For General Reserved Page Number(Beacon Queue is reserved page) 108 * BCN rsvd_page_num = MAX_BEACON_LEN / PAGE_SIZE_TX_8188F, 109 * PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1, CTS-2-SELF / LTE QoS Null */ 110 111 #define BCNQ_PAGE_NUM_8188F (MAX_BEACON_LEN / PAGE_SIZE_TX_8188F + 6) /*0x08*/ 112 113 /* For WoWLan , more reserved page 114 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt:1 ,PNO: 6 115 * NS offload:2 NDP info: 1 116 */ 117 #ifdef CONFIG_WOWLAN 118 #define WOWLAN_PAGE_NUM_8188F 0x0b 119 #else 120 #define WOWLAN_PAGE_NUM_8188F 0x00 121 #endif 122 123 #ifdef CONFIG_PNO_SUPPORT 124 #undef WOWLAN_PAGE_NUM_8188F 125 #define WOWLAN_PAGE_NUM_8188F 0x15 126 #endif 127 128 #ifdef CONFIG_AP_WOWLAN 129 #define AP_WOWLAN_PAGE_NUM_8188F 0x02 130 #endif 131 132 #define TX_TOTAL_PAGE_NUMBER_8188F (0xFF - BCNQ_PAGE_NUM_8188F - WOWLAN_PAGE_NUM_8188F) 133 #define TX_PAGE_BOUNDARY_8188F (TX_TOTAL_PAGE_NUMBER_8188F + 1) 134 135 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8188F TX_TOTAL_PAGE_NUMBER_8188F 136 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8188F (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8188F + 1) 137 138 /* For Normal Chip Setting 139 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8188F */ 140 #define NORMAL_PAGE_NUM_HPQ_8188F 0x0C 141 #define NORMAL_PAGE_NUM_LPQ_8188F 0x02 142 #define NORMAL_PAGE_NUM_NPQ_8188F 0x02 143 144 /* Note: For Normal Chip Setting, modify later */ 145 #define WMM_NORMAL_PAGE_NUM_HPQ_8188F 0x30 146 #define WMM_NORMAL_PAGE_NUM_LPQ_8188F 0x20 147 #define WMM_NORMAL_PAGE_NUM_NPQ_8188F 0x20 148 149 150 #include "HalVerDef.h" 151 #include "hal_com.h" 152 153 #define EFUSE_OOB_PROTECT_BYTES (34 + 1) 154 155 #define HAL_EFUSE_MEMORY 156 157 #define HWSET_MAX_SIZE_8188F 512 158 #define EFUSE_REAL_CONTENT_LEN_8188F 256 159 #define EFUSE_MAP_LEN_8188F 512 160 #define EFUSE_MAX_SECTION_8188F (EFUSE_MAP_LEN_8188F / 8) 161 162 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 163 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8188F) 164 165 #define EFUSE_ACCESS_ON 0x69 /* For RTL8188 only. */ 166 #define EFUSE_ACCESS_OFF 0x00 /* For RTL8188 only. */ 167 168 /* ******************************************************** 169 * EFUSE for BT definition 170 * ******************************************************** */ 171 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512 172 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */ 173 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 174 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ 175 176 #define EFUSE_PROTECT_BYTES_BANK 16 177 178 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 179 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 180 181 /* rtl8188a_hal_init.c */ 182 s32 rtl8188f_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 183 void rtl8188f_FirmwareSelfReset(PADAPTER padapter); 184 void rtl8188f_InitializeFirmwareVars(PADAPTER padapter); 185 186 void rtl8188f_InitAntenna_Selection(PADAPTER padapter); 187 void rtl8188f_DeinitAntenna_Selection(PADAPTER padapter); 188 void rtl8188f_CheckAntenna_Selection(PADAPTER padapter); 189 void rtl8188f_init_default_value(PADAPTER padapter); 190 191 s32 rtl8188f_InitLLTTable(PADAPTER padapter); 192 193 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 194 s32 CardDisableWithoutHWSM(PADAPTER padapter); 195 196 /* EFuse */ 197 u8 GetEEPROMSize8188F(PADAPTER padapter); 198 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 199 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 200 void Hal_EfuseParseTxPowerInfo_8188F(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 201 /* void Hal_EfuseParseBTCoexistInfo_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); */ 202 void Hal_EfuseParseEEPROMVer_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 203 void Hal_EfuseParseChnlPlan_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 204 void Hal_EfuseParseCustomerID_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 205 void Hal_EfuseParsePowerSavingMode_8188F(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 206 void Hal_EfuseParseAntennaDiversity_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 207 void Hal_EfuseParseXtal_8188F(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail); 208 void Hal_EfuseParseThermalMeter_8188F(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail); 209 void Hal_EfuseParseKFreeData_8188F(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 210 211 #if 0 /* Do not need for rtl8188f */ 212 void Hal_EfuseParseVoltage_8188F(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 213 #endif 214 215 void rtl8188f_set_pll_ref_clk_sel(_adapter *adapter, u8 sel); 216 217 void rtl8188f_set_hal_ops(struct hal_ops *pHalFunc); 218 void init_hal_spec_8188f(_adapter *adapter); 219 u8 SetHwReg8188F(PADAPTER padapter, u8 variable, u8 *val); 220 void GetHwReg8188F(PADAPTER padapter, u8 variable, u8 *val); 221 u8 SetHalDefVar8188F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 222 u8 GetHalDefVar8188F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 223 224 /* register */ 225 void rtl8188f_InitBeaconParameters(PADAPTER padapter); 226 void rtl8188f_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 227 void _InitBurstPktLen_8188FS(PADAPTER Adapter); 228 void _8051Reset8188(PADAPTER padapter); 229 #ifdef CONFIG_WOWLAN 230 void Hal_DetectWoWMode(PADAPTER pAdapter); 231 #endif /* CONFIG_WOWLAN */ 232 233 void rtl8188f_start_thread(_adapter *padapter); 234 void rtl8188f_stop_thread(_adapter *padapter); 235 236 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 237 void rtl8188fs_init_checkbthang_workqueue(_adapter *adapter); 238 void rtl8188fs_free_checkbthang_workqueue(_adapter *adapter); 239 void rtl8188fs_cancle_checkbthang_workqueue(_adapter *adapter); 240 void rtl8188fs_hal_check_bt_hang(_adapter *adapter); 241 #endif 242 243 #ifdef CONFIG_GPIO_WAKEUP 244 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 245 #endif 246 247 #ifdef CONFIG_MP_INCLUDED 248 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 249 #endif 250 251 void CCX_FwC2HTxRpt_8188f(PADAPTER padapter, u8 *pdata, u8 len); 252 253 u8 MRateToHwRate8188F(u8 rate); 254 u8 HwRateToMRate8188F(u8 rate); 255 256 #ifdef CONFIG_PCI_HCI 257 BOOLEAN InterruptRecognized8188FE(PADAPTER Adapter); 258 void UpdateInterruptMask8188FE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 259 #endif 260 261 #endif 262