--- /dev/null
+/******************************************************************************\r
+ *\r
+ * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.\r
+ *\r
+ * This program is free software; you can redistribute it and/or modify it\r
+ * under the terms of version 2 of the GNU General Public License as\r
+ * published by the Free Software Foundation.\r
+ *\r
+ * This program is distributed in the hope that it will be useful, but WITHOUT\r
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for\r
+ * more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License along with\r
+ * this program; if not, write to the Free Software Foundation, Inc.,\r
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA\r
+ *\r
+ *\r
+ ******************************************************************************/\r
+#ifndef __RTL8188E_HAL_H__\r
+#define __RTL8188E_HAL_H__\r
+\r
+//#include "hal_com.h"\r
+#include "hal_data.h"\r
+\r
+//include HAL Related header after HAL Related compiling flags \r
+#include "rtl8188e_spec.h"\r
+#include "Hal8188EPhyReg.h"\r
+#include "Hal8188EPhyCfg.h"\r
+#include "rtl8188e_rf.h"\r
+#include "rtl8188e_dm.h"\r
+#include "rtl8188e_recv.h"\r
+#include "rtl8188e_xmit.h"\r
+#include "rtl8188e_cmd.h"\r
+#include "rtl8188e_led.h"\r
+#include "Hal8188EPwrSeq.h"\r
+#ifdef DBG_CONFIG_ERROR_DETECT\r
+#include "rtl8188e_sreset.h"\r
+#endif\r
+\r
+#if 0\r
+ // Fw Array\r
+ #define Rtl8188E_FwImageArray Rtl8188EFwImgArray\r
+ #define Rtl8188E_FWImgArrayLength Rtl8188EFWImgArrayLength\r
+#ifdef CONFIG_WOWLAN\r
+ #define Rtl8188E_FwWoWImageArray Array_MP_8188E_FW_WoWLAN\r
+ #define Rtl8188E_FwWoWImgArrayLength ArrayLength_MP_8188E_FW_WoWLAN\r
+#endif //CONFIG_WOWLAN\r
+#endif\r
+\r
+\r
+ #define RTL8188E_FW_IMG "rtl8188e/FW_NIC.bin"\r
+ #define RTL8188E_FW_WW_IMG "rtl8188e/FW_WoWLAN.bin"\r
+ #define RTL8188E_PHY_REG "rtl8188e/PHY_REG.txt" \r
+ #define RTL8188E_PHY_RADIO_A "rtl8188e/RadioA.txt"\r
+ #define RTL8188E_PHY_RADIO_B "rtl8188e/RadioB.txt"\r
+ #define RTL8188E_TXPWR_TRACK "rtl8188e/TxPowerTrack.txt" \r
+ #define RTL8188E_AGC_TAB "rtl8188e/AGC_TAB.txt"\r
+ #define RTL8188E_PHY_MACREG "rtl8188e/MAC_REG.txt"\r
+ #define RTL8188E_PHY_REG_PG "rtl8188e/PHY_REG_PG.txt"\r
+ #define RTL8188E_PHY_REG_MP "rtl8188e/PHY_REG_MP.txt" \r
+ #define RTL8188E_TXPWR_LMT "rtl8188e/TXPWR_LMT.txt" \r
+\r
+ //---------------------------------------------------------------------\r
+ // RTL8188E Power Configuration CMDs for USB/SDIO/PCIE interfaces\r
+ //---------------------------------------------------------------------\r
+ #define Rtl8188E_NIC_PWR_ON_FLOW rtl8188E_power_on_flow\r
+ #define Rtl8188E_NIC_RF_OFF_FLOW rtl8188E_radio_off_flow\r
+ #define Rtl8188E_NIC_DISABLE_FLOW rtl8188E_card_disable_flow\r
+ #define Rtl8188E_NIC_ENABLE_FLOW rtl8188E_card_enable_flow\r
+ #define Rtl8188E_NIC_SUSPEND_FLOW rtl8188E_suspend_flow\r
+ #define Rtl8188E_NIC_RESUME_FLOW rtl8188E_resume_flow\r
+ #define Rtl8188E_NIC_PDN_FLOW rtl8188E_hwpdn_flow\r
+ #define Rtl8188E_NIC_LPS_ENTER_FLOW rtl8188E_enter_lps_flow\r
+ #define Rtl8188E_NIC_LPS_LEAVE_FLOW rtl8188E_leave_lps_flow\r
+\r
+\r
+#if 1 // download firmware related data structure\r
+#define MAX_FW_8188E_SIZE 0x8000 //32768,32k / 16384,16k\r
+\r
+#define FW_8188E_SIZE 0x4000 //16384,16k\r
+#define FW_8188E_SIZE_2 0x8000 //32768,32k \r
+\r
+#define FW_8188E_START_ADDRESS 0x1000\r
+#define FW_8188E_END_ADDRESS 0x1FFF //0x5FFF\r
+\r
+\r
+#define IS_FW_HEADER_EXIST_88E(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x88E0)\r
+\r
+typedef struct _RT_FIRMWARE_8188E {\r
+ FIRMWARE_SOURCE eFWSource;\r
+#ifdef CONFIG_EMBEDDED_FWIMG\r
+ u8* szFwBuffer;\r
+#else\r
+ u8 szFwBuffer[MAX_FW_8188E_SIZE];\r
+#endif\r
+ u32 ulFwLength;\r
+} RT_FIRMWARE_8188E, *PRT_FIRMWARE_8188E;\r
+\r
+//\r
+// This structure must be cared byte-ordering\r
+//\r
+\r
+typedef struct _RT_8188E_FIRMWARE_HDR\r
+{\r
+ // 8-byte alinment required\r
+\r
+ //--- LONG WORD 0 ----\r
+ u16 Signature; // 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut\r
+ u8 Category; // AP/NIC and USB/PCI\r
+ u8 Function; // Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions\r
+ u16 Version; // FW Version\r
+ u8 Subversion; // FW Subversion, default 0x00\r
+ u16 Rsvd1;\r
+\r
+\r
+ //--- LONG WORD 1 ----\r
+ u8 Month; // Release time Month field\r
+ u8 Date; // Release time Date field\r
+ u8 Hour; // Release time Hour field\r
+ u8 Minute; // Release time Minute field\r
+ u16 RamCodeSize; // The size of RAM code\r
+ u8 Foundry;\r
+ u8 Rsvd2;\r
+\r
+ //--- LONG WORD 2 ----\r
+ u32 SvnIdx; // The SVN entry index\r
+ u32 Rsvd3;\r
+\r
+ //--- LONG WORD 3 ----\r
+ u32 Rsvd4;\r
+ u32 Rsvd5;\r
+}RT_8188E_FIRMWARE_HDR, *PRT_8188E_FIRMWARE_HDR;\r
+#endif // download firmware related data structure\r
+\r
+\r
+#define DRIVER_EARLY_INT_TIME_8188E 0x05\r
+#define BCN_DMA_ATIME_INT_TIME_8188E 0x02\r
+\r
+\r
+//#define MAX_RX_DMA_BUFFER_SIZE_88E 0x2400 //9k for 88E nornal chip , //MaxRxBuff=10k-max(TxReportSize(64*8), WOLPattern(16*24))\r
+#ifdef CONFIG_USB_HCI\r
+ #define RX_DMA_SIZE_88E(__Adapter) 0x2800\r
+#else\r
+ #define RX_DMA_SIZE_88E(__Adapter) ((!IS_VENDOR_8188E_I_CUT_SERIES(__Adapter))?0x2800:0x4000)\r
+#endif\r
+\r
+#ifdef CONFIG_WOWLAN\r
+#define RESV_FMWF WKFMCAM_SIZE*MAX_WKFM_NUM /* 16 entries, for each is 24 bytes*/\r
+#else\r
+#define RESV_FMWF 0\r
+#endif\r
+\r
+#define RX_DMA_RESERVD_FW_FEATURE 0x200 /* for tx report (64*8) */\r
+\r
+#define MAX_RX_DMA_BUFFER_SIZE_88E(__Adapter) RX_DMA_SIZE_88E(__Adapter)-RX_DMA_RESERVD_FW_FEATURE\r
+\r
+#define MAX_TX_REPORT_BUFFER_SIZE 0x0400 /* 1k */\r
+\r
+// Note: We will divide number of page equally for each queue other than public queue!\r
+// 22k = 22528 bytes = 176 pages (@page = 128 bytes)\r
+// must reserved about 7 pages for LPS => 176-7 = 169 (0xA9)\r
+// 2*BCN / 1*ps-poll / 1*null-data /1*prob_rsp /1*QOS null-data /1*BT QOS null-data \r
+\r
+#define BCNQ_PAGE_NUM_88E 0x08\r
+\r
+//For WoWLan , more reserved page\r
+#ifdef CONFIG_WOWLAN\r
+#define WOWLAN_PAGE_NUM_88E 0x00\r
+#else\r
+#define WOWLAN_PAGE_NUM_88E 0x00\r
+#endif\r
+\r
+/* Note: \r
+Tx FIFO Size : previous CUT:22K /I_CUT after:32KB\r
+Tx page Size : 128B\r
+Total page numbers : 176(0xB0) / 256(0x100)\r
+*/\r
+#ifdef CONFIG_USB_HCI\r
+ #define TOTAL_PAGE_NUMBER_88E(_Adapter) (0xB0 - 1)\r
+#else\r
+ #define TOTAL_PAGE_NUMBER_88E(_Adapter) ((IS_VENDOR_8188E_I_CUT_SERIES(_Adapter)?0x100:0xB0) - 1)/* must reserved 1 page for dma issue */\r
+#endif\r
+#define TX_TOTAL_PAGE_NUMBER_88E(_Adapter) (TOTAL_PAGE_NUMBER_88E(_Adapter) - BCNQ_PAGE_NUM_88E - WOWLAN_PAGE_NUM_88E)\r
+#define TX_PAGE_BOUNDARY_88E(_Adapter) (TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) /* beacon header start address */\r
+\r
+#define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) TX_TOTAL_PAGE_NUMBER_88E(_Adapter)\r
+#define WMM_NORMAL_TX_PAGE_BOUNDARY_88E(_Adapter) (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1)\r
+\r
+// For Normal Chip Setting\r
+// (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B\r
+#define NORMAL_PAGE_NUM_HPQ_88E 0x0\r
+#define NORMAL_PAGE_NUM_LPQ_88E 0x09\r
+#define NORMAL_PAGE_NUM_NPQ_88E 0x0\r
+\r
+// Note: For Normal Chip Setting, modify later\r
+#define WMM_NORMAL_PAGE_NUM_HPQ_88E 0x29\r
+#define WMM_NORMAL_PAGE_NUM_LPQ_88E 0x1C\r
+#define WMM_NORMAL_PAGE_NUM_NPQ_88E 0x1C\r
+\r
+\r
+//-------------------------------------------------------------------------\r
+// Chip specific\r
+//-------------------------------------------------------------------------\r
+#define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22)&0x3)\r
+#define CHIP_BONDING_92C_1T2R 0x1\r
+#define CHIP_BONDING_88C_USB_MCARD 0x2\r
+#define CHIP_BONDING_88C_USB_HP 0x1\r
+\r
+//-------------------------------------------------------------------------\r
+// Channel Plan\r
+//-------------------------------------------------------------------------\r
+\r
+\r
+#define EFUSE_REAL_CONTENT_LEN 512\r
+#define EFUSE_MAP_LEN 128\r
+#define EFUSE_MAX_SECTION 16\r
+#define EFUSE_IC_ID_OFFSET 506 //For some inferiority IC purpose. added by Roger, 2009.09.02.\r
+#define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN)\r
+//\r
+// <Roger_Notes>\r
+// To prevent out of boundary programming case,\r
+// leave 1byte and program full section\r
+// 9bytes + 1byt + 5bytes and pre 1byte.\r
+// For worst case:\r
+// | 1byte|----8bytes----|1byte|--5bytes--| \r
+// | | Reserved(14bytes) |\r
+//\r
+#define EFUSE_OOB_PROTECT_BYTES 15 // PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte.\r
+\r
+#define EFUSE_REAL_CONTENT_LEN_88E 256\r
+#define EFUSE_MAP_LEN_88E 512\r
+#define EFUSE_MAX_SECTION_88E 64\r
+#define EFUSE_MAX_WORD_UNIT_88E 4\r
+#define EFUSE_IC_ID_OFFSET_88E 506 //For some inferiority IC purpose. added by Roger, 2009.09.02.\r
+#define AVAILABLE_EFUSE_ADDR_88E(addr) (addr < EFUSE_REAL_CONTENT_LEN_88E)\r
+// <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section\r
+// 9bytes + 1byt + 5bytes and pre 1byte.\r
+// For worst case:\r
+// | 2byte|----8bytes----|1byte|--7bytes--| //92D\r
+#define EFUSE_OOB_PROTECT_BYTES_88E 18 // PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte.\r
+#define EFUSE_PROTECT_BYTES_BANK_88E 16\r
+\r
+\r
+//========================================================\r
+// EFUSE for BT definition\r
+//========================================================\r
+#define EFUSE_BT_REAL_CONTENT_LEN 1536 // 512*3\r
+#define EFUSE_BT_MAP_LEN 1024 // 1k bytes\r
+#define EFUSE_BT_MAX_SECTION 128 // 1024/8\r
+\r
+#define EFUSE_PROTECT_BYTES_BANK 16\r
+\r
+#define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)\r
+#define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)\r
+\r
+//#define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE)\r
+\r
+//#define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) )\r
+\r
+#ifdef CONFIG_PCI_HCI\r
+void InterruptRecognized8188EE(PADAPTER Adapter, PRT_ISR_CONTENT pIsrContent);\r
+void UpdateInterruptMask8188EE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);\r
+#endif //CONFIG_PCI_HCI\r
+\r
+// rtl8188e_hal_init.c\r
+\r
+s32 rtl8188e_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw);\r
+void _8051Reset88E(PADAPTER padapter);\r
+void rtl8188e_InitializeFirmwareVars(PADAPTER padapter);\r
+\r
+\r
+s32 InitLLTTable(PADAPTER padapter, u8 txpktbuf_bndy);\r
+\r
+// EFuse\r
+u8 GetEEPROMSize8188E(PADAPTER padapter);\r
+void Hal_InitPGData88E(PADAPTER padapter);\r
+void Hal_EfuseParseIDCode88E(PADAPTER padapter, u8 *hwinfo);\r
+void Hal_ReadTxPowerInfo88E(PADAPTER padapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
+ \r
+void Hal_EfuseParseEEPROMVer88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void rtl8188e_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseCustomerID88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_ReadAntennaDiversity88E (PADAPTER pAdapter,u8*PROMContent,BOOLEAN AutoLoadFail);\r
+void Hal_ReadThermalMeter_88E(PADAPTER Adapter,u8* PROMContent,BOOLEAN AutoloadFail);\r
+void Hal_EfuseParseXtal_8188E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseBoardType88E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
+void Hal_ReadPowerSavingMode88E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
+void Hal_ReadPAType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);\r
+void Hal_ReadAmplifierType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);\r
+void Hal_ReadRFEType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);\r
+\r
+BOOLEAN HalDetectPwrDownMode88E(PADAPTER Adapter);\r
+ \r
+#if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)\r
+void Hal_DetectWoWMode(PADAPTER pAdapter);\r
+#endif //CONFIG_WOWLAN\r
+\r
+\r
+#ifdef CONFIG_RF_POWER_TRIM\r
+void Hal_ReadRFGainOffset(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
+#endif /*CONFIG_RF_POWER_TRIM*/\r
+\r
+void rtl8188e_init_default_value(_adapter *adapter);\r
+\r
+void rtl8188e_set_hal_ops(struct hal_ops *pHalFunc);\r
+void init_hal_spec_8188e(_adapter *adapter);\r
+\r
+// register\r
+void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);\r
+\r
+void rtl8188e_start_thread(_adapter *padapter);\r
+void rtl8188e_stop_thread(_adapter *padapter);\r
+\r
+void rtw_IOL_cmd_tx_pkt_buf_dump(ADAPTER *Adapter,int data_len);\r
+#ifdef CONFIG_IOL_EFUSE_PATCH\r
+s32 rtl8188e_iol_efuse_patch(PADAPTER padapter);\r
+#endif//CONFIG_IOL_EFUSE_PATCH\r
+void _InitTransferPageSize(PADAPTER padapter);\r
+\r
+void SetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val);\r
+void GetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val);\r
+void ResumeTxBeacon(PADAPTER padapter);\r
+void StopTxBeacon(PADAPTER padapter);\r
+u8\r
+GetHalDefVar8188E(\r
+ IN PADAPTER Adapter,\r
+ IN HAL_DEF_VARIABLE eVariable,\r
+ IN PVOID pValue\r
+ );\r
+#endif //__RTL8188E_HAL_H__\r
+\r
projects / firefly-linux-kernel-4.4.55.git / blobdiff