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