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 __RTL8192F_HAL_H__ 17 #define __RTL8192F_HAL_H__ 18 19 #include "hal_data.h" 20 21 #include "rtl8192f_spec.h" 22 #include "rtl8192f_rf.h" 23 #include "rtl8192f_dm.h" 24 #include "rtl8192f_recv.h" 25 #include "rtl8192f_xmit.h" 26 #include "rtl8192f_cmd.h" 27 #include "rtl8192f_led.h" 28 #include "Hal8192FPwrSeq.h" 29 #include "Hal8192FPhyReg.h" 30 #include "Hal8192FPhyCfg.h" 31 #ifdef DBG_CONFIG_ERROR_DETECT 32 #include "rtl8192f_sreset.h" 33 #endif 34 #ifdef CONFIG_LPS_POFF 35 #include "rtl8192f_lps_poff.h" 36 #endif 37 38 #define FW_8192F_SIZE 0x8000 39 #define FW_8192F_START_ADDRESS 0x4000 40 #define FW_8192F_END_ADDRESS 0x5000 /* brian_zhang@realsil.com.cn */ 41 42 #define IS_FW_HEADER_EXIST_8192F(_pFwHdr)\ 43 ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x92F0) 44 45 typedef struct _RT_FIRMWARE { 46 FIRMWARE_SOURCE eFWSource; 47 #ifdef CONFIG_EMBEDDED_FWIMG 48 u8 *szFwBuffer; 49 #else 50 u8 szFwBuffer[FW_8192F_SIZE]; 51 #endif 52 u32 ulFwLength; 53 } RT_FIRMWARE_8192F, *PRT_FIRMWARE_8192F; 54 55 /* 56 * This structure must be cared byte-ordering 57 * 58 * Added by tynli. 2009.12.04. */ 59 typedef struct _RT_8192F_FIRMWARE_HDR { 60 /* 8-byte alinment required */ 61 62 /* --- LONG WORD 0 ---- */ 63 u16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */ 64 u8 Category; /* AP/NIC and USB/PCI */ 65 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */ 66 u16 Version; /* FW Version */ 67 u16 Subversion; /* FW Subversion, default 0x00 */ 68 69 /* --- LONG WORD 1 ---- */ 70 u8 Month; /* Release time Month field */ 71 u8 Date; /* Release time Date field */ 72 u8 Hour; /* Release time Hour field */ 73 u8 Minute; /* Release time Minute field */ 74 u16 RamCodeSize; /* The size of RAM code */ 75 u16 Rsvd2; 76 77 /* --- LONG WORD 2 ---- */ 78 u32 SvnIdx; /* The SVN entry index */ 79 u32 Rsvd3; 80 81 /* --- LONG WORD 3 ---- */ 82 u32 Rsvd4; 83 u32 Rsvd5; 84 } RT_8192F_FIRMWARE_HDR, *PRT_8192F_FIRMWARE_HDR; 85 #define DRIVER_EARLY_INT_TIME_8192F 0x05 86 #define BCN_DMA_ATIME_INT_TIME_8192F 0x02 87 /* for 8192F 88 * TX 64K, RX 16K, Page size 256B for TX*/ 89 #define PAGE_SIZE_TX_8192F 256 90 #define PAGE_SIZE_RX_8192F 8 91 #define TX_DMA_SIZE_8192F 0x10000/* 64K(TX) */ 92 #define RX_DMA_SIZE_8192F 0x4000/* 16K(RX) */ 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_8192F 0x100 /* 256B, reserved for c2h debug message */ 101 #else 102 #define RX_DMA_RESERVED_SIZE_8192F 0xc0 /* 192B, reserved for tx report 24*8=192*/ 103 #endif 104 #define RX_DMA_BOUNDARY_8192F\ 105 (RX_DMA_SIZE_8192F - RX_DMA_RESERVED_SIZE_8192F - 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_8192F 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_8192F (MAX_BEACON_LEN/PAGE_SIZE_TX_8192F + 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 #ifdef CONFIG_WOW_KEEP_ALIVE_PATTERN 122 #define WOWLAN_KEEP_ALIVE_PAGE 0x02 /*for keep alive packet*/ 123 #else 124 #define WOWLAN_KEEP_ALIVE_PAGE 0x00 125 #endif /*CONFIG_WOW_KEEP_ALIVE_PATTERN*/ 126 /* 7 pages for wow rsvd page + 2 pages for pattern */ 127 #define WOWLAN_PAGE_NUM_8192F (0x09 + WOWLAN_KEEP_ALIVE_PAGE) 128 #else 129 #define WOWLAN_PAGE_NUM_8192F 0x00 130 #endif 131 132 #ifdef CONFIG_PNO_SUPPORT 133 #undef WOWLAN_PAGE_NUM_8192F 134 #define WOWLAN_PAGE_NUM_8192F 0x15 135 #endif 136 137 #ifdef CONFIG_AP_WOWLAN 138 #define AP_WOWLAN_PAGE_NUM_8192F 0x02 139 #endif 140 141 #ifdef DBG_LA_MODE 142 #define LA_MODE_PAGE_NUM 0xE0 143 #endif 144 145 #define MAX_RX_DMA_BUFFER_SIZE_8192F (RX_DMA_SIZE_8192F - RX_DMA_RESERVED_SIZE_8192F) 146 147 #ifdef DBG_LA_MODE 148 #define TX_TOTAL_PAGE_NUMBER_8192F (0xFF - LA_MODE_PAGE_NUM) 149 #else 150 #define TX_TOTAL_PAGE_NUMBER_8192F (0xFF - BCNQ_PAGE_NUM_8192F - WOWLAN_PAGE_NUM_8192F) 151 #endif 152 153 #define TX_PAGE_BOUNDARY_8192F (TX_TOTAL_PAGE_NUMBER_8192F + 1) 154 155 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8192F \ 156 TX_TOTAL_PAGE_NUMBER_8192F 157 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8192F \ 158 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8192F + 1) 159 160 /* For Normal Chip Setting 161 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8192F */ 162 #define NORMAL_PAGE_NUM_HPQ_8192F 0x8 163 #define NORMAL_PAGE_NUM_LPQ_8192F 0x8 164 #define NORMAL_PAGE_NUM_NPQ_8192F 0x8 165 #define NORMAL_PAGE_NUM_EPQ_8192F 0x00 166 167 /* Note: For Normal Chip Setting, modify later */ 168 #define WMM_NORMAL_PAGE_NUM_HPQ_8192F 0x30 169 #define WMM_NORMAL_PAGE_NUM_LPQ_8192F 0x20 170 #define WMM_NORMAL_PAGE_NUM_NPQ_8192F 0x20 171 #define WMM_NORMAL_PAGE_NUM_EPQ_8192F 0x00 172 173 174 #include "HalVerDef.h" 175 #include "hal_com.h" 176 177 #define EFUSE_OOB_PROTECT_BYTES 56 /*0x1C8~0x1FF*/ 178 179 #define HAL_EFUSE_MEMORY 180 #define HWSET_MAX_SIZE_8192F 512 181 #define EFUSE_REAL_CONTENT_LEN_8192F 512 182 #define EFUSE_MAP_LEN_8192F 512 183 #define EFUSE_MAX_SECTION_8192F 64 184 185 /* For some inferiority IC purpose. added by Roger, 2009.09.02.*/ 186 #define EFUSE_IC_ID_OFFSET 506 187 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8192F) 188 189 #define EFUSE_ACCESS_ON 0x69 190 #define EFUSE_ACCESS_OFF 0x00 191 192 /* ******************************************************** 193 * EFUSE for BT definition 194 * ******************************************************** */ 195 #define BANK_NUM 1 196 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512 197 #define EFUSE_BT_REAL_CONTENT_LEN 1536/*512 * 3 */ 198 /* (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM)*/ 199 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 200 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ 201 #define EFUSE_PROTECT_BYTES_BANK 16 202 203 typedef enum tag_Package_Definition { 204 PACKAGE_DEFAULT, 205 PACKAGE_QFN32, 206 PACKAGE_QFN40, 207 PACKAGE_QFN46 208 } PACKAGE_TYPE_E; 209 210 #define INCLUDE_MULTI_FUNC_BT(_Adapter) \ 211 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 212 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \ 213 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 214 215 #ifdef CONFIG_FILE_FWIMG 216 extern char *rtw_fw_file_path; 217 extern char *rtw_fw_wow_file_path; 218 #ifdef CONFIG_MP_INCLUDED 219 extern char *rtw_fw_mp_bt_file_path; 220 #endif /* CONFIG_MP_INCLUDED */ 221 #endif /* CONFIG_FILE_FWIMG */ 222 223 /* rtl8192f_hal_init.c */ 224 s32 rtl8192f_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 225 void rtl8192f_FirmwareSelfReset(PADAPTER padapter); 226 void rtl8192f_InitializeFirmwareVars(PADAPTER padapter); 227 228 void rtl8192f_InitAntenna_Selection(PADAPTER padapter); 229 void rtl8192f_DeinitAntenna_Selection(PADAPTER padapter); 230 void rtl8192f_CheckAntenna_Selection(PADAPTER padapter); 231 void rtl8192f_init_default_value(PADAPTER padapter); 232 233 s32 rtl8192f_InitLLTTable(PADAPTER padapter); 234 235 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 236 s32 CardDisableWithoutHWSM(PADAPTER padapter); 237 238 /* EFuse */ 239 u8 GetEEPROMSize8192F(PADAPTER padapter); 240 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 241 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 242 void Hal_EfuseParseTxPowerInfo_8192F(PADAPTER padapter, 243 u8 *PROMContent, BOOLEAN AutoLoadFail); 244 #ifdef CONFIG_BT_COEXIST 245 void Hal_EfuseParseBTCoexistInfo_8192F(PADAPTER padapter, 246 u8 *hwinfo, BOOLEAN AutoLoadFail); 247 #endif /* CONFIG_BT_COEXIST */ 248 void Hal_EfuseParseEEPROMVer_8192F(PADAPTER padapter, 249 u8 *hwinfo, BOOLEAN AutoLoadFail); 250 void Hal_EfuseParseChnlPlan_8192F(PADAPTER padapter, 251 u8 *hwinfo, BOOLEAN AutoLoadFail); 252 void Hal_EfuseParseCustomerID_8192F(PADAPTER padapter, 253 u8 *hwinfo, BOOLEAN AutoLoadFail); 254 void Hal_EfuseParseAntennaDiversity_8192F(PADAPTER padapter, 255 u8 *hwinfo, BOOLEAN AutoLoadFail); 256 void Hal_EfuseParseXtal_8192F(PADAPTER pAdapter, 257 u8 *hwinfo, u8 AutoLoadFail); 258 void Hal_EfuseParseThermalMeter_8192F(PADAPTER padapter, 259 u8 *hwinfo, u8 AutoLoadFail); 260 void Hal_EfuseParseVoltage_8192F(PADAPTER pAdapter, 261 u8 *hwinfo, BOOLEAN AutoLoadFail); 262 void Hal_EfuseParseBoardType_8192F(PADAPTER Adapter, 263 u8 *PROMContent, BOOLEAN AutoloadFail); 264 u8 Hal_ReadRFEType_8192F(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 265 void rtl8192f_set_hal_ops(struct hal_ops *pHalFunc); 266 void init_hal_spec_8192f(_adapter *adapter); 267 u8 SetHwReg8192F(PADAPTER padapter, u8 variable, u8 *val); 268 void GetHwReg8192F(PADAPTER padapter, u8 variable, u8 *val); 269 u8 SetHalDefVar8192F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 270 u8 GetHalDefVar8192F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 271 272 /* register */ 273 void rtl8192f_InitBeaconParameters(PADAPTER padapter); 274 void rtl8192f_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 275 276 void _InitMacAPLLSetting_8192F(PADAPTER Adapter); 277 void _8051Reset8192F(PADAPTER padapter); 278 #ifdef CONFIG_WOWLAN 279 void Hal_DetectWoWMode(PADAPTER pAdapter); 280 #endif /* CONFIG_WOWLAN */ 281 282 void rtl8192f_start_thread(_adapter *padapter); 283 void rtl8192f_stop_thread(_adapter *padapter); 284 285 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 286 void rtl8192fs_init_checkbthang_workqueue(_adapter *adapter); 287 void rtl8192fs_free_checkbthang_workqueue(_adapter *adapter); 288 void rtl8192fs_cancle_checkbthang_workqueue(_adapter *adapter); 289 void rtl8192fs_hal_check_bt_hang(_adapter *adapter); 290 #endif 291 292 #ifdef CONFIG_GPIO_WAKEUP 293 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 294 #endif 295 #ifdef CONFIG_MP_INCLUDED 296 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 297 #endif 298 void CCX_FwC2HTxRpt_8192f(PADAPTER padapter, u8 *pdata, u8 len); 299 300 u8 MRateToHwRate8192F(u8 rate); 301 u8 HwRateToMRate8192F(u8 rate); 302 303 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 304 void check_bt_status_work(void *data); 305 #endif 306 307 308 void rtl8192f_cal_txdesc_chksum(struct tx_desc *ptxdesc); 309 310 #ifdef CONFIG_AMPDU_PRETX_CD 311 void rtl8192f_pretx_cd_config(_adapter *adapter); 312 #endif 313 314 #ifdef CONFIG_PCI_HCI 315 BOOLEAN InterruptRecognized8192FE(PADAPTER Adapter); 316 void UpdateInterruptMask8192FE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 317 void InitMAC_TRXBD_8192FE(PADAPTER Adapter); 318 319 u16 get_txbd_rw_reg(u16 ff_hwaddr); 320 #endif 321 322 #endif 323