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 #ifdef CONFIG_WOW_KEEP_ALIVE_PATTERN 121 #define WOWLAN_KEEP_ALIVE_PAGE 0x02 /*for keep alive packet*/ 122 #else 123 #define WOWLAN_KEEP_ALIVE_PAGE 0x00 124 #endif /*CONFIG_WOW_KEEP_ALIVE_PATTERN*/ 125 /* 7 pages for wow rsvd page + 2 pages for pattern */ 126 #define WOWLAN_PAGE_NUM_8192F (0x09 + WOWLAN_KEEP_ALIVE_PAGE) 127 #else 128 #define WOWLAN_PAGE_NUM_8192F 0x00 129 #endif 130 131 #ifdef CONFIG_WOW_PATTERN_IN_TXFIFO 132 /* REG_TXBUF_WKCAM_OFFSET 0x1B1[15:0] */ 133 #define WKCAM_OFFSET_BIT_MASK 0xFFFF 134 #define WKCAM_OFFSET_BIT_MASK_OFFSET 0 135 #endif 136 137 #ifdef CONFIG_PNO_SUPPORT 138 #undef WOWLAN_PAGE_NUM_8192F 139 #define WOWLAN_PAGE_NUM_8192F 0x15 140 #endif 141 142 #ifdef CONFIG_AP_WOWLAN 143 #define AP_WOWLAN_PAGE_NUM_8192F 0x02 144 #endif 145 146 #ifdef DBG_LA_MODE 147 #define LA_MODE_PAGE_NUM 0xE0 148 #endif 149 150 #define MAX_RX_DMA_BUFFER_SIZE_8192F (RX_DMA_SIZE_8192F - RX_DMA_RESERVED_SIZE_8192F) 151 152 #ifdef DBG_LA_MODE 153 #define TX_TOTAL_PAGE_NUMBER_8192F (0xFF - LA_MODE_PAGE_NUM) 154 #else 155 #define TX_TOTAL_PAGE_NUMBER_8192F (0xFF - BCNQ_PAGE_NUM_8192F - WOWLAN_PAGE_NUM_8192F) 156 #endif 157 158 #define TX_PAGE_BOUNDARY_8192F (TX_TOTAL_PAGE_NUMBER_8192F + 1) 159 160 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8192F \ 161 TX_TOTAL_PAGE_NUMBER_8192F 162 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8192F \ 163 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8192F + 1) 164 165 /* For Normal Chip Setting 166 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8192F */ 167 #define NORMAL_PAGE_NUM_HPQ_8192F 0x8 168 #define NORMAL_PAGE_NUM_LPQ_8192F 0x8 169 #define NORMAL_PAGE_NUM_NPQ_8192F 0x8 170 #define NORMAL_PAGE_NUM_EPQ_8192F 0x00 171 172 /* Note: For Normal Chip Setting, modify later */ 173 #define WMM_NORMAL_PAGE_NUM_HPQ_8192F 0x30 174 #define WMM_NORMAL_PAGE_NUM_LPQ_8192F 0x20 175 #define WMM_NORMAL_PAGE_NUM_NPQ_8192F 0x20 176 #define WMM_NORMAL_PAGE_NUM_EPQ_8192F 0x00 177 178 179 #include "HalVerDef.h" 180 #include "hal_com.h" 181 182 #define EFUSE_OOB_PROTECT_BYTES 56 /*0x1C8~0x1FF*/ 183 184 #define HAL_EFUSE_MEMORY 185 #define HWSET_MAX_SIZE_8192F 512 186 #define EFUSE_REAL_CONTENT_LEN_8192F 512 187 #define EFUSE_MAP_LEN_8192F 512 188 #define EFUSE_MAX_SECTION_8192F 64 189 190 /* For some inferiority IC purpose. added by Roger, 2009.09.02.*/ 191 #define EFUSE_IC_ID_OFFSET 506 192 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8192F) 193 194 #define EFUSE_ACCESS_ON 0x69 195 #define EFUSE_ACCESS_OFF 0x00 196 197 /* ******************************************************** 198 * EFUSE for BT definition 199 * ******************************************************** */ 200 #define BANK_NUM 1 201 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512 202 #define EFUSE_BT_REAL_CONTENT_LEN 1536/*512 * 3 */ 203 /* (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM)*/ 204 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 205 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ 206 #define EFUSE_PROTECT_BYTES_BANK 16 207 208 typedef enum tag_Package_Definition { 209 PACKAGE_DEFAULT, 210 PACKAGE_QFN32, 211 PACKAGE_QFN40, 212 PACKAGE_QFN46 213 } PACKAGE_TYPE_E; 214 215 #define INCLUDE_MULTI_FUNC_BT(_Adapter) \ 216 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 217 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \ 218 (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 219 220 #ifdef CONFIG_FILE_FWIMG 221 extern char *rtw_fw_file_path; 222 extern char *rtw_fw_wow_file_path; 223 #ifdef CONFIG_MP_INCLUDED 224 extern char *rtw_fw_mp_bt_file_path; 225 #endif /* CONFIG_MP_INCLUDED */ 226 #endif /* CONFIG_FILE_FWIMG */ 227 228 /* rtl8192f_hal_init.c */ 229 s32 rtl8192f_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 230 void rtl8192f_FirmwareSelfReset(PADAPTER padapter); 231 void rtl8192f_InitializeFirmwareVars(PADAPTER padapter); 232 233 void rtl8192f_InitAntenna_Selection(PADAPTER padapter); 234 void rtl8192f_DeinitAntenna_Selection(PADAPTER padapter); 235 void rtl8192f_CheckAntenna_Selection(PADAPTER padapter); 236 void rtl8192f_init_default_value(PADAPTER padapter); 237 238 s32 rtl8192f_InitLLTTable(PADAPTER padapter); 239 240 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 241 s32 CardDisableWithoutHWSM(PADAPTER padapter); 242 243 /* EFuse */ 244 u8 GetEEPROMSize8192F(PADAPTER padapter); 245 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 246 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 247 void Hal_EfuseParseTxPowerInfo_8192F(PADAPTER padapter, 248 u8 *PROMContent, BOOLEAN AutoLoadFail); 249 #ifdef CONFIG_BT_COEXIST 250 void Hal_EfuseParseBTCoexistInfo_8192F(PADAPTER padapter, 251 u8 *hwinfo, BOOLEAN AutoLoadFail); 252 #endif /* CONFIG_BT_COEXIST */ 253 void Hal_EfuseParseEEPROMVer_8192F(PADAPTER padapter, 254 u8 *hwinfo, BOOLEAN AutoLoadFail); 255 void Hal_EfuseParseChnlPlan_8192F(PADAPTER padapter, 256 u8 *hwinfo, BOOLEAN AutoLoadFail); 257 void Hal_EfuseParseCustomerID_8192F(PADAPTER padapter, 258 u8 *hwinfo, BOOLEAN AutoLoadFail); 259 void Hal_EfuseParseAntennaDiversity_8192F(PADAPTER padapter, 260 u8 *hwinfo, BOOLEAN AutoLoadFail); 261 void Hal_EfuseParseXtal_8192F(PADAPTER pAdapter, 262 u8 *hwinfo, u8 AutoLoadFail); 263 void Hal_EfuseParseThermalMeter_8192F(PADAPTER padapter, 264 u8 *hwinfo, u8 AutoLoadFail); 265 void Hal_EfuseParseVoltage_8192F(PADAPTER pAdapter, 266 u8 *hwinfo, BOOLEAN AutoLoadFail); 267 void Hal_EfuseParseBoardType_8192F(PADAPTER Adapter, 268 u8 *PROMContent, BOOLEAN AutoloadFail); 269 u8 Hal_ReadRFEType_8192F(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 270 void rtl8192f_set_hal_ops(struct hal_ops *pHalFunc); 271 void init_hal_spec_8192f(_adapter *adapter); 272 u8 SetHwReg8192F(PADAPTER padapter, u8 variable, u8 *val); 273 void GetHwReg8192F(PADAPTER padapter, u8 variable, u8 *val); 274 u8 SetHalDefVar8192F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 275 u8 GetHalDefVar8192F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 276 277 /* register */ 278 void rtl8192f_InitBeaconParameters(PADAPTER padapter); 279 void rtl8192f_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 280 281 void _InitMacAPLLSetting_8192F(PADAPTER Adapter); 282 void _8051Reset8192F(PADAPTER padapter); 283 #ifdef CONFIG_WOWLAN 284 void Hal_DetectWoWMode(PADAPTER pAdapter); 285 #endif /* CONFIG_WOWLAN */ 286 287 void rtl8192f_start_thread(_adapter *padapter); 288 void rtl8192f_stop_thread(_adapter *padapter); 289 290 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 291 void rtl8192fs_init_checkbthang_workqueue(_adapter *adapter); 292 void rtl8192fs_free_checkbthang_workqueue(_adapter *adapter); 293 void rtl8192fs_cancle_checkbthang_workqueue(_adapter *adapter); 294 void rtl8192fs_hal_check_bt_hang(_adapter *adapter); 295 #endif 296 297 #ifdef CONFIG_GPIO_WAKEUP 298 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 299 #endif 300 #ifdef CONFIG_MP_INCLUDED 301 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 302 #endif 303 void CCX_FwC2HTxRpt_8192f(PADAPTER padapter, u8 *pdata, u8 len); 304 305 u8 MRateToHwRate8192F(u8 rate); 306 u8 HwRateToMRate8192F(u8 rate); 307 308 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 309 void check_bt_status_work(void *data); 310 #endif 311 312 313 void rtl8192f_cal_txdesc_chksum(struct tx_desc *ptxdesc); 314 315 #ifdef CONFIG_AMPDU_PRETX_CD 316 void rtl8192f_pretx_cd_config(_adapter *adapter); 317 #endif 318 319 #ifdef CONFIG_PCI_HCI 320 BOOLEAN InterruptRecognized8192FE(PADAPTER Adapter); 321 void UpdateInterruptMask8192FE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 322 void InitMAC_TRXBD_8192FE(PADAPTER Adapter); 323 324 u16 get_txbd_rw_reg(u16 ff_hwaddr); 325 #endif 326 327 #endif 328