1 /****************************************************************************** 2 * 3 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved. 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 * You should have received a copy of the GNU General Public License along with 15 * this program; if not, write to the Free Software Foundation, Inc., 16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA 17 * 18 * 19 ******************************************************************************/ 20 #ifndef __RTL8703B_HAL_H__ 21 #define __RTL8703B_HAL_H__ 22 23 #include "hal_data.h" 24 25 #include "rtl8703b_spec.h" 26 #include "rtl8703b_rf.h" 27 #include "rtl8703b_dm.h" 28 #include "rtl8703b_recv.h" 29 #include "rtl8703b_xmit.h" 30 #include "rtl8703b_cmd.h" 31 #include "rtl8703b_led.h" 32 #include "Hal8703BPwrSeq.h" 33 #include "Hal8703BPhyReg.h" 34 #include "Hal8703BPhyCfg.h" 35 #ifdef DBG_CONFIG_ERROR_DETECT 36 #include "rtl8703b_sreset.h" 37 #endif 38 39 40 //--------------------------------------------------------------------- 41 // RTL8703B From file 42 //--------------------------------------------------------------------- 43 #define RTL8703B_FW_IMG "rtl8703b/FW_NIC.bin" 44 #define RTL8703B_FW_WW_IMG "rtl8703b/FW_WoWLAN.bin" 45 #define RTL8703B_PHY_REG "rtl8703b/PHY_REG.txt" 46 #define RTL8703B_PHY_RADIO_A "rtl8703b/RadioA.txt" 47 #define RTL8703B_PHY_RADIO_B "rtl8703b/RadioB.txt" 48 #define RTL8703B_TXPWR_TRACK "rtl8703b/TxPowerTrack.txt" 49 #define RTL8703B_AGC_TAB "rtl8703b/AGC_TAB.txt" 50 #define RTL8703B_PHY_MACREG "rtl8703b/MAC_REG.txt" 51 #define RTL8703B_PHY_REG_PG "rtl8703b/PHY_REG_PG.txt" 52 #define RTL8703B_PHY_REG_MP "rtl8703b/PHY_REG_MP.txt" 53 #define RTL8703B_TXPWR_LMT "rtl8703b/TXPWR_LMT.txt" 54 55 //--------------------------------------------------------------------- 56 // RTL8703B From header 57 //--------------------------------------------------------------------- 58 59 #if MP_DRIVER == 1 60 #define Rtl8703B_FwBTImgArray Rtl8703BFwBTImgArray 61 #define Rtl8703B_FwBTImgArrayLength Rtl8703BFwBTImgArrayLength 62 63 #define Rtl8703B_PHY_REG_Array_MP Rtl8703B_PHYREG_Array_MP 64 #define Rtl8703B_PHY_REG_Array_MPLength Rtl8703B_PHYREG_Array_MPLength 65 #endif 66 67 68 #define FW_8703B_SIZE 0x8000 69 #define FW_8703B_START_ADDRESS 0x1000 70 #define FW_8703B_END_ADDRESS 0x1FFF //0x5FFF 71 72 #define IS_FW_HEADER_EXIST_8703B(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x03B0) 73 74 typedef struct _RT_FIRMWARE { 75 FIRMWARE_SOURCE eFWSource; 76 #ifdef CONFIG_EMBEDDED_FWIMG 77 u8* szFwBuffer; 78 #else 79 u8 szFwBuffer[FW_8703B_SIZE]; 80 #endif 81 u32 ulFwLength; 82 } RT_FIRMWARE_8703B, *PRT_FIRMWARE_8703B; 83 84 // 85 // This structure must be cared byte-ordering 86 // 87 // Added by tynli. 2009.12.04. 88 typedef struct _RT_8703B_FIRMWARE_HDR 89 { 90 // 8-byte alinment required 91 92 //--- LONG WORD 0 ---- 93 u16 Signature; // 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut 94 u8 Category; // AP/NIC and USB/PCI 95 u8 Function; // Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions 96 u16 Version; // FW Version 97 u16 Subversion; // FW Subversion, default 0x00 98 99 //--- LONG WORD 1 ---- 100 u8 Month; // Release time Month field 101 u8 Date; // Release time Date field 102 u8 Hour; // Release time Hour field 103 u8 Minute; // Release time Minute field 104 u16 RamCodeSize; // The size of RAM code 105 u16 Rsvd2; 106 107 //--- LONG WORD 2 ---- 108 u32 SvnIdx; // The SVN entry index 109 u32 Rsvd3; 110 111 //--- LONG WORD 3 ---- 112 u32 Rsvd4; 113 u32 Rsvd5; 114 }RT_8703B_FIRMWARE_HDR, *PRT_8703B_FIRMWARE_HDR; 115 116 #define DRIVER_EARLY_INT_TIME_8703B 0x05 117 #define BCN_DMA_ATIME_INT_TIME_8703B 0x02 118 119 // for 8703B 120 // TX 32K, RX 16K, Page size 128B for TX, 8B for RX 121 #define PAGE_SIZE_TX_8703B 128 122 #define PAGE_SIZE_RX_8703B 8 123 124 #define TX_DMA_SIZE_8703B 0x8000 /* 32K(TX) */ 125 #define RX_DMA_SIZE_8703B 0x4000 /* 16K(RX) */ 126 127 #ifdef CONFIG_WOWLAN 128 #define RESV_FMWF WKFMCAM_SIZE*MAX_WKFM_NUM /* 16 entries, for each is 24 bytes*/ 129 #else 130 #define RESV_FMWF 0 131 #endif 132 133 #ifdef CONFIG_FW_C2H_DEBUG 134 #define RX_DMA_RESERVED_SIZE_8703B 0x100 // 256B, reserved for c2h debug message 135 #else 136 #define RX_DMA_RESERVED_SIZE_8703B 0x80 // 128B, reserved for tx report 137 #endif 138 #define RX_DMA_BOUNDARY_8703B (RX_DMA_SIZE_8703B - RX_DMA_RESERVED_SIZE_8703B - 1) 139 140 141 // Note: We will divide number of page equally for each queue other than public queue! 142 143 //For General Reserved Page Number(Beacon Queue is reserved page) 144 //Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1 145 #define BCNQ_PAGE_NUM_8703B 0x08 146 #ifdef CONFIG_CONCURRENT_MODE 147 #define BCNQ1_PAGE_NUM_8703B 0x08 // 0x04 148 #else 149 #define BCNQ1_PAGE_NUM_8703B 0x00 150 #endif 151 152 #ifdef CONFIG_PNO_SUPPORT 153 #undef BCNQ1_PAGE_NUM_8703B 154 #define BCNQ1_PAGE_NUM_8703B 0x00 // 0x04 155 #endif 156 157 //For WoWLan , more reserved page 158 //ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, PNO: 6 159 #ifdef CONFIG_WOWLAN 160 #define WOWLAN_PAGE_NUM_8703B 0x07 161 #else 162 #define WOWLAN_PAGE_NUM_8703B 0x00 163 #endif 164 165 #ifdef CONFIG_PNO_SUPPORT 166 #undef WOWLAN_PAGE_NUM_8703B 167 #define WOWLAN_PAGE_NUM_8703B 0x15 168 #endif 169 170 #ifdef CONFIG_AP_WOWLAN 171 #define AP_WOWLAN_PAGE_NUM_8703B 0x02 172 #endif 173 174 #define TX_TOTAL_PAGE_NUMBER_8703B (0xFF - BCNQ_PAGE_NUM_8703B - BCNQ1_PAGE_NUM_8703B - WOWLAN_PAGE_NUM_8703B) 175 #define TX_PAGE_BOUNDARY_8703B (TX_TOTAL_PAGE_NUMBER_8703B + 1) 176 177 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B TX_TOTAL_PAGE_NUMBER_8703B 178 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8703B (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B + 1) 179 180 // For Normal Chip Setting 181 // (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8703B 182 #define NORMAL_PAGE_NUM_HPQ_8703B 0x0C 183 #define NORMAL_PAGE_NUM_LPQ_8703B 0x02 184 #define NORMAL_PAGE_NUM_NPQ_8703B 0x02 185 186 // Note: For Normal Chip Setting, modify later 187 #define WMM_NORMAL_PAGE_NUM_HPQ_8703B 0x30 188 #define WMM_NORMAL_PAGE_NUM_LPQ_8703B 0x20 189 #define WMM_NORMAL_PAGE_NUM_NPQ_8703B 0x20 190 191 192 #include "HalVerDef.h" 193 #include "hal_com.h" 194 195 #define EFUSE_OOB_PROTECT_BYTES 15 196 197 #define HAL_EFUSE_MEMORY 198 199 #define HWSET_MAX_SIZE_8703B 256 200 #define EFUSE_REAL_CONTENT_LEN_8703B 256 201 #define EFUSE_MAP_LEN_8703B 512 202 #define EFUSE_MAX_SECTION_8703B 64 203 204 #define EFUSE_IC_ID_OFFSET 506 //For some inferiority IC purpose. added by Roger, 2009.09.02. 205 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8703B) 206 207 #define EFUSE_ACCESS_ON 0x69 208 #define EFUSE_ACCESS_OFF 0x00 209 210 //======================================================== 211 // EFUSE for BT definition 212 //======================================================== 213 #define BANK_NUM 1 214 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 128 215 #define EFUSE_BT_REAL_CONTENT_LEN (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM) 216 #define EFUSE_BT_MAP_LEN 1024 // 1k bytes 217 #define EFUSE_BT_MAX_SECTION (EFUSE_BT_MAP_LEN / 8) 218 #define EFUSE_PROTECT_BYTES_BANK 16 219 220 typedef struct _C2H_EVT_HDR 221 { 222 u8 CmdID; 223 u8 CmdLen; 224 u8 CmdSeq; 225 } __attribute__((__packed__)) C2H_EVT_HDR, *PC2H_EVT_HDR; 226 227 typedef enum tag_Package_Definition 228 { 229 PACKAGE_DEFAULT, 230 PACKAGE_QFN68, 231 PACKAGE_TFBGA90, 232 PACKAGE_TFBGA80, 233 PACKAGE_TFBGA79 234 }PACKAGE_TYPE_E; 235 236 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 237 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 238 239 // rtl8703b_hal_init.c 240 s32 rtl8703b_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 241 void rtl8703b_FirmwareSelfReset(PADAPTER padapter); 242 void rtl8703b_InitializeFirmwareVars(PADAPTER padapter); 243 244 void rtl8703b_InitAntenna_Selection(PADAPTER padapter); 245 void rtl8703b_DeinitAntenna_Selection(PADAPTER padapter); 246 void rtl8703b_CheckAntenna_Selection(PADAPTER padapter); 247 void rtl8703b_init_default_value(PADAPTER padapter); 248 249 s32 rtl8703b_InitLLTTable(PADAPTER padapter); 250 251 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU); 252 s32 CardDisableWithoutHWSM(PADAPTER padapter); 253 254 // EFuse 255 u8 GetEEPROMSize8703B(PADAPTER padapter); 256 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent); 257 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo); 258 void Hal_EfuseParseTxPowerInfo_8703B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 259 void Hal_EfuseParseBTCoexistInfo_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 260 void Hal_EfuseParseEEPROMVer_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 261 void Hal_EfuseParseChnlPlan_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 262 void Hal_EfuseParseCustomerID_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 263 void Hal_EfuseParseAntennaDiversity_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 264 void Hal_EfuseParseXtal_8703B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail); 265 void Hal_EfuseParseThermalMeter_8703B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail); 266 VOID Hal_EfuseParseMacHidden_8703B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 267 VOID Hal_EfuseParseVoltage_8703B(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail); 268 VOID Hal_EfuseParseBoardType_8703B(PADAPTER Adapter, u8* PROMContent,BOOLEAN AutoloadFail); 269 270 #ifdef CONFIG_C2H_PACKET_EN 271 void rtl8703b_c2h_packet_handler(PADAPTER padapter, u8 *pbuf, u16 length); 272 #endif 273 274 275 void rtl8703b_set_hal_ops(struct hal_ops *pHalFunc); 276 void init_hal_spec_8703b(_adapter *adapter); 277 void SetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val); 278 void GetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val); 279 #ifdef CONFIG_C2H_PACKET_EN 280 void SetHwRegWithBuf8703B(PADAPTER padapter, u8 variable, u8 *pbuf, int len); 281 #endif // CONFIG_C2H_PACKET_EN 282 u8 SetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 283 u8 GetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 284 285 // register 286 void rtl8703b_InitBeaconParameters(PADAPTER padapter); 287 void rtl8703b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode); 288 void _InitBurstPktLen_8703BS(PADAPTER Adapter); 289 void _InitLTECoex_8703BS(PADAPTER Adapter); 290 void _InitMacAPLLSetting_8703B(PADAPTER Adapter); 291 void _8051Reset8703(PADAPTER padapter); 292 #ifdef CONFIG_WOWLAN 293 void Hal_DetectWoWMode(PADAPTER pAdapter); 294 #endif //CONFIG_WOWLAN 295 296 void rtl8703b_start_thread(_adapter *padapter); 297 void rtl8703b_stop_thread(_adapter *padapter); 298 299 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST) 300 void rtl8703bs_init_checkbthang_workqueue(_adapter * adapter); 301 void rtl8703bs_free_checkbthang_workqueue(_adapter * adapter); 302 void rtl8703bs_cancle_checkbthang_workqueue(_adapter * adapter); 303 void rtl8703bs_hal_check_bt_hang(_adapter * adapter); 304 #endif 305 306 #ifdef CONFIG_GPIO_WAKEUP 307 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue); 308 #endif 309 310 int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 311 312 void CCX_FwC2HTxRpt_8703b(PADAPTER padapter, u8 *pdata, u8 len); 313 s32 c2h_id_filter_ccx_8703b(u8 *buf); 314 s32 c2h_handler_8703b(PADAPTER padapter, u8 *pC2hEvent); 315 u8 MRateToHwRate8703B(u8 rate); 316 u8 HwRateToMRate8703B(u8 rate); 317 318 void Hal_ReadRFGainOffset(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail); 319 320 #ifdef CONFIG_PCI_HCI 321 BOOLEAN InterruptRecognized8703BE(PADAPTER Adapter); 322 VOID UpdateInterruptMask8703BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 323 #endif 324 325 #endif 326 327