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 __RTL8188E_HAL_H__ 16 #define __RTL8188E_HAL_H__ 17 18 /* #include "hal_com.h" */ 19 #include "hal_data.h" 20 21 /* include HAL Related header after HAL Related compiling flags */ 22 #include "rtl8188e_spec.h" 23 #include "Hal8188EPhyReg.h" 24 #include "Hal8188EPhyCfg.h" 25 #include "rtl8188e_rf.h" 26 #include "rtl8188e_dm.h" 27 #include "rtl8188e_recv.h" 28 #include "rtl8188e_xmit.h" 29 #include "rtl8188e_cmd.h" 30 #include "rtl8188e_led.h" 31 #include "Hal8188EPwrSeq.h" 32 #ifdef DBG_CONFIG_ERROR_DETECT 33 #include "rtl8188e_sreset.h" 34 #endif 35 36 /* --------------------------------------------------------------------- */ 37 /* RTL8188E Power Configuration CMDs for USB/SDIO/PCIE interfaces */ 38 /* --------------------------------------------------------------------- */ 39 #define Rtl8188E_NIC_PWR_ON_FLOW rtl8188E_power_on_flow 40 #define Rtl8188E_NIC_RF_OFF_FLOW rtl8188E_radio_off_flow 41 #define Rtl8188E_NIC_DISABLE_FLOW rtl8188E_card_disable_flow 42 #define Rtl8188E_NIC_ENABLE_FLOW rtl8188E_card_enable_flow 43 #define Rtl8188E_NIC_SUSPEND_FLOW rtl8188E_suspend_flow 44 #define Rtl8188E_NIC_RESUME_FLOW rtl8188E_resume_flow 45 #define Rtl8188E_NIC_PDN_FLOW rtl8188E_hwpdn_flow 46 #define Rtl8188E_NIC_LPS_ENTER_FLOW rtl8188E_enter_lps_flow 47 #define Rtl8188E_NIC_LPS_LEAVE_FLOW rtl8188E_leave_lps_flow 48 49 50 #if 1 /* download firmware related data structure */ 51 #define MAX_FW_8188E_SIZE 0x8000 /* 32768, 32k / 16384, 16k */ 52 53 #define FW_8188E_SIZE 0x4000 /* 16384, 16k */ 54 #define FW_8188E_SIZE_2 0x8000 /* 32768, 32k */ 55 56 #define FW_8188E_START_ADDRESS 0x1000 57 #define FW_8188E_END_ADDRESS 0x1FFF /* 0x5FFF */ 58 59 60 #define IS_FW_HEADER_EXIST_88E(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x88E0) 61 62 typedef struct _RT_FIRMWARE_8188E { 63 FIRMWARE_SOURCE eFWSource; 64 #ifdef CONFIG_EMBEDDED_FWIMG 65 u8 *szFwBuffer; 66 #else 67 u8 szFwBuffer[MAX_FW_8188E_SIZE]; 68 #endif 69 u32 ulFwLength; 70 } RT_FIRMWARE_8188E, *PRT_FIRMWARE_8188E; 71 72 /* 73 * This structure must be cared byte-ordering 74 * */ 75 76 typedef struct _RT_8188E_FIRMWARE_HDR { 77 /* 8-byte alinment required */ 78 79 /* --- LONG WORD 0 ---- */ 80 u16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */ 81 u8 Category; /* AP/NIC and USB/PCI */ 82 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */ 83 u16 Version; /* FW Version */ 84 u8 Subversion; /* FW Subversion, default 0x00 */ 85 u16 Rsvd1; 86 87 88 /* --- LONG WORD 1 ---- */ 89 u8 Month; /* Release time Month field */ 90 u8 Date; /* Release time Date field */ 91 u8 Hour; /* Release time Hour field */ 92 u8 Minute; /* Release time Minute field */ 93 u16 RamCodeSize; /* The size of RAM code */ 94 u8 Foundry; 95 u8 Rsvd2; 96 97 /* --- LONG WORD 2 ---- */ 98 u32 SvnIdx; /* The SVN entry index */ 99 u32 Rsvd3; 100 101 /* --- LONG WORD 3 ---- */ 102 u32 Rsvd4; 103 u32 Rsvd5; 104 } RT_8188E_FIRMWARE_HDR, *PRT_8188E_FIRMWARE_HDR; 105 #endif /* download firmware related data structure */ 106 107 108 #define DRIVER_EARLY_INT_TIME_8188E 0x05 109 #define BCN_DMA_ATIME_INT_TIME_8188E 0x02 110 111 112 /* #define MAX_RX_DMA_BUFFER_SIZE_88E 0x2400 */ /* 9k for 88E nornal chip , */ /* MaxRxBuff=10k-max(TxReportSize(64*8), WOLPattern(16*24)) */ 113 #ifdef CONFIG_USB_HCI 114 #define RX_DMA_SIZE_88E(__Adapter) 0x2800 115 #else 116 #define RX_DMA_SIZE_88E(__Adapter) ((!IS_VENDOR_8188E_I_CUT_SERIES(__Adapter))?0x2800:0x4000) 117 #endif 118 119 #ifdef CONFIG_WOWLAN 120 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/ 121 #else 122 #define RESV_FMWF 0 123 #endif 124 125 #define RX_DMA_RESERVD_FW_FEATURE 0x200 /* for tx report (64*8) */ 126 127 #define MAX_RX_DMA_BUFFER_SIZE_88E(__Adapter) (RX_DMA_SIZE_88E(__Adapter)-RX_DMA_RESERVD_FW_FEATURE) 128 129 #define MAX_TX_REPORT_BUFFER_SIZE 0x0400 /* 1k */ 130 131 /* Note: We will divide number of page equally for each queue other than public queue! 132 * 22k = 22528 bytes = 176 pages (@page = 128 bytes) 133 * must reserved about 7 pages for LPS => 176-7 = 169 (0xA9) 134 * 2*BCN / 1*ps-poll / 1*null-data /1*prob_rsp /1*QOS null-data /1*BT QOS null-data */ 135 136 #define BCNQ_PAGE_NUM_88E 0x09 137 138 /* For WoWLan , more reserved page */ 139 #ifdef CONFIG_WOWLAN 140 #define WOWLAN_PAGE_NUM_88E 0x00 141 #else 142 #define WOWLAN_PAGE_NUM_88E 0x00 143 #endif 144 145 /* Note: 146 Tx FIFO Size : previous CUT:22K /I_CUT after:32KB 147 Tx page Size : 128B 148 Total page numbers : 176(0xB0) / 256(0x100) 149 */ 150 #ifdef CONFIG_USB_HCI 151 #define TOTAL_PAGE_NUMBER_88E(_Adapter) (0xB0 - 1) 152 #else 153 #define TOTAL_PAGE_NUMBER_88E(_Adapter) ((IS_VENDOR_8188E_I_CUT_SERIES(_Adapter)?0x100:0xB0) - 1)/* must reserved 1 page for dma issue */ 154 #endif 155 #define TX_TOTAL_PAGE_NUMBER_88E(_Adapter) (TOTAL_PAGE_NUMBER_88E(_Adapter) - BCNQ_PAGE_NUM_88E - WOWLAN_PAGE_NUM_88E) 156 #define TX_PAGE_BOUNDARY_88E(_Adapter) (TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) /* beacon header start address */ 157 158 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) TX_TOTAL_PAGE_NUMBER_88E(_Adapter) 159 #define WMM_NORMAL_TX_PAGE_BOUNDARY_88E(_Adapter) (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) 160 161 /* For Normal Chip Setting 162 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */ 163 #define NORMAL_PAGE_NUM_HPQ_88E 0x0 164 #define NORMAL_PAGE_NUM_LPQ_88E 0x09 165 #define NORMAL_PAGE_NUM_NPQ_88E 0x0 166 167 /* Note: For Normal Chip Setting, modify later */ 168 #define WMM_NORMAL_PAGE_NUM_HPQ_88E 0x29 169 #define WMM_NORMAL_PAGE_NUM_LPQ_88E 0x1C 170 #define WMM_NORMAL_PAGE_NUM_NPQ_88E 0x1C 171 172 173 /* ------------------------------------------------------------------------- 174 * Chip specific 175 * ------------------------------------------------------------------------- */ 176 #define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22) & 0x3) 177 #define CHIP_BONDING_92C_1T2R 0x1 178 #define CHIP_BONDING_88C_USB_MCARD 0x2 179 #define CHIP_BONDING_88C_USB_HP 0x1 180 181 /* ------------------------------------------------------------------------- 182 * Channel Plan 183 * ------------------------------------------------------------------------- */ 184 185 186 #define EFUSE_REAL_CONTENT_LEN 512 187 #define EFUSE_MAP_LEN 128 188 #define EFUSE_MAX_SECTION 16 189 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 190 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN) 191 /* 192 * <Roger_Notes> 193 * To prevent out of boundary programming case, 194 * leave 1byte and program full section 195 * 9bytes + 1byt + 5bytes and pre 1byte. 196 * For worst case: 197 * | 1byte|----8bytes----|1byte|--5bytes--| 198 * | | Reserved(14bytes) | 199 * */ 200 #define EFUSE_OOB_PROTECT_BYTES 15 /* PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. */ 201 202 #define EFUSE_REAL_CONTENT_LEN_88E 256 203 #define EFUSE_MAP_LEN_88E 512 204 #define EFUSE_MAX_SECTION_88E 64 205 #define EFUSE_MAX_WORD_UNIT_88E 4 206 #define EFUSE_IC_ID_OFFSET_88E 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 207 #define AVAILABLE_EFUSE_ADDR_88E(addr) (addr < EFUSE_REAL_CONTENT_LEN_88E) 208 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section 209 * 9bytes + 1byt + 5bytes and pre 1byte. 210 * For worst case: 211 * | 2byte|----8bytes----|1byte|--7bytes--| */ /* 92D */ 212 #define EFUSE_OOB_PROTECT_BYTES_88E 18 /* PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. */ 213 #define EFUSE_PROTECT_BYTES_BANK_88E 16 214 215 216 /* ******************************************************** 217 * EFUSE for BT definition 218 * ******************************************************** */ 219 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */ 220 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 221 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ 222 223 #define EFUSE_PROTECT_BYTES_BANK 16 224 225 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 226 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 227 228 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */ 229 230 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */ 231 232 #ifdef CONFIG_PCI_HCI 233 /* according to the define in the rtw_xmit.h, rtw_recv.h */ 234 #define TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */ 235 #ifdef CONFIG_CONCURRENT_MODE 236 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM<<1)*/ /* 256 */ 237 #define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+(TXDESC_NUM>>1)) /* 320 */ 238 /*#define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+TXDESC_NUM)*/ /* 384 */ 239 #else 240 #define BE_QUEUE_TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */ 241 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM+(TXDESC_NUM>>1)) */ /* 192 */ 242 #endif 243 244 void InterruptRecognized8188EE(PADAPTER Adapter, PRT_ISR_CONTENT pIsrContent); 245 void UpdateInterruptMask8188EE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 246 #endif /* CONFIG_PCI_HCI */ 247 248 /* rtl8188e_hal_init.c */ 249 250 s32 rtl8188e_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 251 void _8051Reset88E(PADAPTER padapter); 252 void rtl8188e_InitializeFirmwareVars(PADAPTER padapter); 253 254 255 s32 InitLLTTable(PADAPTER padapter, u8 txpktbuf_bndy); 256 257 /* EFuse */ 258 u8 GetEEPROMSize8188E(PADAPTER padapter); 259 void Hal_InitPGData88E(PADAPTER padapter); 260 void Hal_EfuseParseIDCode88E(PADAPTER padapter, u8 *hwinfo); 261 void Hal_ReadTxPowerInfo88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 262 263 void Hal_EfuseParseEEPROMVer88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 264 void rtl8188e_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 265 void Hal_EfuseParseCustomerID88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 266 void Hal_ReadAntennaDiversity88E(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 267 void Hal_ReadThermalMeter_88E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 268 void Hal_EfuseParseXtal_8188E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 269 void Hal_EfuseParseBoardType88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 270 void Hal_ReadPowerSavingMode88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 271 void Hal_ReadPAType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 272 void Hal_ReadAmplifierType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 273 void Hal_ReadRFEType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 274 275 BOOLEAN HalDetectPwrDownMode88E(PADAPTER Adapter); 276 277 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN) 278 void Hal_DetectWoWMode(PADAPTER pAdapter); 279 #endif /* CONFIG_WOWLAN */ 280 281 282 #ifdef CONFIG_RF_POWER_TRIM 283 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 284 #endif /*CONFIG_RF_POWER_TRIM*/ 285 286 void rtl8188e_init_default_value(_adapter *adapter); 287 288 void InitBeaconParameters_8188e(_adapter *adapter); 289 void SetBeaconRelatedRegisters8188E(PADAPTER padapter); 290 291 void rtl8188e_set_hal_ops(struct hal_ops *pHalFunc); 292 void init_hal_spec_8188e(_adapter *adapter); 293 294 /* register */ 295 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits); 296 297 void rtl8188e_start_thread(_adapter *padapter); 298 void rtl8188e_stop_thread(_adapter *padapter); 299 300 void rtw_IOL_cmd_tx_pkt_buf_dump(ADAPTER *Adapter, int data_len); 301 #ifdef CONFIG_IOL_EFUSE_PATCH 302 s32 rtl8188e_iol_efuse_patch(PADAPTER padapter); 303 #endif/* CONFIG_IOL_EFUSE_PATCH */ 304 void _InitTransferPageSize(PADAPTER padapter); 305 306 u8 SetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val); 307 void GetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val); 308 309 u8 310 GetHalDefVar8188E( 311 IN PADAPTER Adapter, 312 IN HAL_DEF_VARIABLE eVariable, 313 IN PVOID pValue 314 ); 315 #ifdef CONFIG_GPIO_API 316 int rtl8188e_GpioFuncCheck(PADAPTER adapter, u8 gpio_num); 317 #endif 318 #endif /* __RTL8188E_HAL_H__ */ 319