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