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