net: wireless: rockchip_wlan: add rtl8188fu support
[firefly-linux-kernel-4.4.55.git] / drivers / net / wireless / rockchip_wlan / rtl8188fu / include / rtl8703b_hal.h
diff --git a/drivers/net/wireless/rockchip_wlan/rtl8188fu/include/rtl8703b_hal.h b/drivers/net/wireless/rockchip_wlan/rtl8188fu/include/rtl8703b_hal.h
new file mode 100644 (file)
index 0000000..1ad386f
--- /dev/null
@@ -0,0 +1,326 @@
+/******************************************************************************\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 __RTL8703B_HAL_H__\r
+#define __RTL8703B_HAL_H__\r
+\r
+#include "hal_data.h"\r
+\r
+#include "rtl8703b_spec.h"\r
+#include "rtl8703b_rf.h"\r
+#include "rtl8703b_dm.h"\r
+#include "rtl8703b_recv.h"\r
+#include "rtl8703b_xmit.h"\r
+#include "rtl8703b_cmd.h"\r
+#include "rtl8703b_led.h"\r
+#include "Hal8703BPwrSeq.h"\r
+#include "Hal8703BPhyReg.h"\r
+#include "Hal8703BPhyCfg.h"\r
+#ifdef DBG_CONFIG_ERROR_DETECT\r
+#include "rtl8703b_sreset.h"\r
+#endif\r
+\r
+\r
+//---------------------------------------------------------------------\r
+//             RTL8703B From file\r
+//---------------------------------------------------------------------\r
+       #define RTL8703B_FW_IMG                                 "rtl8703b/FW_NIC.bin"\r
+       #define RTL8703B_FW_WW_IMG                              "rtl8703b/FW_WoWLAN.bin"\r
+       #define RTL8703B_PHY_REG                                        "rtl8703b/PHY_REG.txt"\r
+       #define RTL8703B_PHY_RADIO_A                            "rtl8703b/RadioA.txt"\r
+       #define RTL8703B_PHY_RADIO_B                            "rtl8703b/RadioB.txt"\r
+       #define RTL8703B_TXPWR_TRACK                            "rtl8703b/TxPowerTrack.txt" \r
+       #define RTL8703B_AGC_TAB                                        "rtl8703b/AGC_TAB.txt"\r
+       #define RTL8703B_PHY_MACREG                             "rtl8703b/MAC_REG.txt"\r
+       #define RTL8703B_PHY_REG_PG                             "rtl8703b/PHY_REG_PG.txt"\r
+       #define RTL8703B_PHY_REG_MP                             "rtl8703b/PHY_REG_MP.txt"\r
+       #define RTL8703B_TXPWR_LMT                              "rtl8703b/TXPWR_LMT.txt"\r
+\r
+//---------------------------------------------------------------------\r
+//             RTL8703B From header\r
+//---------------------------------------------------------------------\r
+\r
+#if MP_DRIVER == 1\r
+       #define Rtl8703B_FwBTImgArray                           Rtl8703BFwBTImgArray\r
+       #define Rtl8703B_FwBTImgArrayLength             Rtl8703BFwBTImgArrayLength\r
+\r
+       #define Rtl8703B_PHY_REG_Array_MP                       Rtl8703B_PHYREG_Array_MP\r
+       #define Rtl8703B_PHY_REG_Array_MPLength Rtl8703B_PHYREG_Array_MPLength\r
+#endif\r
+\r
+\r
+#define FW_8703B_SIZE                  0x8000\r
+#define FW_8703B_START_ADDRESS 0x1000\r
+#define FW_8703B_END_ADDRESS           0x1FFF //0x5FFF\r
+\r
+#define IS_FW_HEADER_EXIST_8703B(_pFwHdr)      ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x03B0)\r
+\r
+typedef struct _RT_FIRMWARE {\r
+       FIRMWARE_SOURCE eFWSource;\r
+#ifdef CONFIG_EMBEDDED_FWIMG\r
+       u8*                     szFwBuffer;\r
+#else\r
+       u8                      szFwBuffer[FW_8703B_SIZE];\r
+#endif\r
+       u32                     ulFwLength;\r
+} RT_FIRMWARE_8703B, *PRT_FIRMWARE_8703B;\r
+\r
+//\r
+// This structure must be cared byte-ordering\r
+//\r
+// Added by tynli. 2009.12.04.\r
+typedef struct _RT_8703B_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
+       u16             Subversion;     // FW Subversion, default 0x00\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
+       u16             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_8703B_FIRMWARE_HDR, *PRT_8703B_FIRMWARE_HDR;\r
+\r
+#define DRIVER_EARLY_INT_TIME_8703B            0x05\r
+#define BCN_DMA_ATIME_INT_TIME_8703B           0x02\r
+\r
+// for 8703B\r
+// TX 32K, RX 16K, Page size 128B for TX, 8B for RX\r
+#define PAGE_SIZE_TX_8703B                     128\r
+#define PAGE_SIZE_RX_8703B                     8\r
+\r
+#define TX_DMA_SIZE_8703B                      0x8000  /* 32K(TX) */\r
+#define RX_DMA_SIZE_8703B                      0x4000  /* 16K(RX) */\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
+#ifdef CONFIG_FW_C2H_DEBUG \r
+#define RX_DMA_RESERVED_SIZE_8703B     0x100   // 256B, reserved for c2h debug message\r
+#else\r
+#define RX_DMA_RESERVED_SIZE_8703B     0x80    // 128B, reserved for tx report\r
+#endif\r
+#define RX_DMA_BOUNDARY_8703B          (RX_DMA_SIZE_8703B - RX_DMA_RESERVED_SIZE_8703B - 1)\r
+\r
+\r
+// Note: We will divide number of page equally for each queue other than public queue!\r
+\r
+//For General Reserved Page Number(Beacon Queue is reserved page)\r
+//Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1\r
+#define BCNQ_PAGE_NUM_8703B            0x08\r
+#ifdef CONFIG_CONCURRENT_MODE\r
+#define BCNQ1_PAGE_NUM_8703B           0x08 // 0x04\r
+#else\r
+#define BCNQ1_PAGE_NUM_8703B           0x00\r
+#endif\r
+\r
+#ifdef CONFIG_PNO_SUPPORT\r
+#undef BCNQ1_PAGE_NUM_8703B\r
+#define BCNQ1_PAGE_NUM_8703B           0x00 // 0x04\r
+#endif\r
+\r
+//For WoWLan , more reserved page\r
+//ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, PNO: 6\r
+#ifdef CONFIG_WOWLAN\r
+#define WOWLAN_PAGE_NUM_8703B  0x07\r
+#else\r
+#define WOWLAN_PAGE_NUM_8703B  0x00\r
+#endif\r
+\r
+#ifdef CONFIG_PNO_SUPPORT\r
+#undef WOWLAN_PAGE_NUM_8703B\r
+#define WOWLAN_PAGE_NUM_8703B  0x15\r
+#endif\r
+\r
+#ifdef CONFIG_AP_WOWLAN\r
+#define AP_WOWLAN_PAGE_NUM_8703B       0x02\r
+#endif\r
+\r
+#define TX_TOTAL_PAGE_NUMBER_8703B     (0xFF - BCNQ_PAGE_NUM_8703B - BCNQ1_PAGE_NUM_8703B - WOWLAN_PAGE_NUM_8703B)\r
+#define TX_PAGE_BOUNDARY_8703B         (TX_TOTAL_PAGE_NUMBER_8703B + 1)\r
+\r
+#define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B  TX_TOTAL_PAGE_NUMBER_8703B\r
+#define WMM_NORMAL_TX_PAGE_BOUNDARY_8703B              (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B + 1)\r
+\r
+// For Normal Chip Setting\r
+// (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8703B\r
+#define NORMAL_PAGE_NUM_HPQ_8703B              0x0C\r
+#define NORMAL_PAGE_NUM_LPQ_8703B              0x02\r
+#define NORMAL_PAGE_NUM_NPQ_8703B              0x02\r
+\r
+// Note: For Normal Chip Setting, modify later\r
+#define WMM_NORMAL_PAGE_NUM_HPQ_8703B          0x30\r
+#define WMM_NORMAL_PAGE_NUM_LPQ_8703B          0x20\r
+#define WMM_NORMAL_PAGE_NUM_NPQ_8703B          0x20\r
+\r
+\r
+#include "HalVerDef.h"\r
+#include "hal_com.h"\r
+\r
+#define EFUSE_OOB_PROTECT_BYTES                15\r
+\r
+#define HAL_EFUSE_MEMORY\r
+\r
+#define HWSET_MAX_SIZE_8703B                   512\r
+#define EFUSE_REAL_CONTENT_LEN_8703B           512\r
+#define EFUSE_MAP_LEN_8703B                            512\r
+#define EFUSE_MAX_SECTION_8703B                        64\r
+\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_8703B)\r
+\r
+#define EFUSE_ACCESS_ON                        0x69    \r
+#define EFUSE_ACCESS_OFF                       0x00    \r
+\r
+//========================================================\r
+//                     EFUSE for BT definition\r
+//========================================================\r
+#define EFUSE_BT_REAL_BANK_CONTENT_LEN 512\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
+typedef struct _C2H_EVT_HDR\r
+{\r
+       u8      CmdID;\r
+       u8      CmdLen;\r
+       u8      CmdSeq;\r
+} __attribute__((__packed__)) C2H_EVT_HDR, *PC2H_EVT_HDR;\r
+\r
+typedef enum tag_Package_Definition\r
+{\r
+    PACKAGE_DEFAULT,\r
+    PACKAGE_QFN68,\r
+    PACKAGE_TFBGA90,\r
+    PACKAGE_TFBGA80,\r
+    PACKAGE_TFBGA79\r
+}PACKAGE_TYPE_E;\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
+// rtl8703b_hal_init.c\r
+s32 rtl8703b_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);\r
+void rtl8703b_FirmwareSelfReset(PADAPTER padapter);\r
+void rtl8703b_InitializeFirmwareVars(PADAPTER padapter);\r
+\r
+void rtl8703b_InitAntenna_Selection(PADAPTER padapter);\r
+void rtl8703b_DeinitAntenna_Selection(PADAPTER padapter);\r
+void rtl8703b_CheckAntenna_Selection(PADAPTER padapter);\r
+void rtl8703b_init_default_value(PADAPTER padapter);\r
+\r
+s32 rtl8703b_InitLLTTable(PADAPTER padapter);\r
+\r
+s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);\r
+s32 CardDisableWithoutHWSM(PADAPTER padapter);\r
+\r
+// EFuse\r
+u8 GetEEPROMSize8703B(PADAPTER padapter);\r
+void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);\r
+void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);\r
+void Hal_EfuseParseTxPowerInfo_8703B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseBTCoexistInfo_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseEEPROMVer_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseChnlPlan_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseCustomerID_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseAntennaDiversity_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+void Hal_EfuseParseXtal_8703B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);\r
+void Hal_EfuseParseThermalMeter_8703B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);\r
+VOID Hal_EfuseParseMacHidden_8703B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
+VOID Hal_EfuseParseVoltage_8703B(PADAPTER pAdapter,u8* hwinfo,BOOLEAN  AutoLoadFail); \r
+VOID Hal_EfuseParseBoardType_8703B(PADAPTER Adapter,   u8*     PROMContent,BOOLEAN AutoloadFail);\r
+\r
+#ifdef CONFIG_C2H_PACKET_EN\r
+void rtl8703b_c2h_packet_handler(PADAPTER padapter, u8 *pbuf, u16 length);\r
+#endif\r
+\r
+\r
+void rtl8703b_set_hal_ops(struct hal_ops *pHalFunc);\r
+void init_hal_spec_8703b(_adapter *adapter);\r
+void SetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);\r
+void GetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);\r
+#ifdef CONFIG_C2H_PACKET_EN\r
+void SetHwRegWithBuf8703B(PADAPTER padapter, u8 variable, u8 *pbuf, int len);\r
+#endif // CONFIG_C2H_PACKET_EN\r
+u8 SetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);\r
+u8 GetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);\r
+\r
+// register\r
+void rtl8703b_InitBeaconParameters(PADAPTER padapter);\r
+void rtl8703b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);\r
+void   _InitBurstPktLen_8703BS(PADAPTER Adapter);\r
+void _InitLTECoex_8703BS(PADAPTER Adapter);\r
+void _InitMacAPLLSetting_8703B(PADAPTER Adapter);\r
+void _8051Reset8703(PADAPTER padapter);\r
+#ifdef CONFIG_WOWLAN\r
+void Hal_DetectWoWMode(PADAPTER pAdapter);\r
+#endif //CONFIG_WOWLAN\r
+\r
+void rtl8703b_start_thread(_adapter *padapter);\r
+void rtl8703b_stop_thread(_adapter *padapter);\r
+\r
+#if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)\r
+void rtl8703bs_init_checkbthang_workqueue(_adapter * adapter);\r
+void rtl8703bs_free_checkbthang_workqueue(_adapter * adapter);\r
+void rtl8703bs_cancle_checkbthang_workqueue(_adapter * adapter);\r
+void rtl8703bs_hal_check_bt_hang(_adapter * adapter);\r
+#endif\r
+\r
+#ifdef CONFIG_GPIO_WAKEUP\r
+void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);\r
+#endif\r
+\r
+int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);\r
+\r
+void CCX_FwC2HTxRpt_8703b(PADAPTER padapter, u8 *pdata, u8 len);\r
+s32 c2h_id_filter_ccx_8703b(u8 *buf);\r
+s32 c2h_handler_8703b(PADAPTER padapter, u8 *pC2hEvent);\r
+u8 MRateToHwRate8703B(u8  rate);\r
+u8 HwRateToMRate8703B(u8        rate);\r
+\r
+void Hal_ReadRFGainOffset(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
+\r
+#ifdef CONFIG_PCI_HCI\r
+BOOLEAN        InterruptRecognized8703BE(PADAPTER Adapter);\r
+VOID   UpdateInterruptMask8703BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);\r
+#endif\r
+\r
+#endif\r
+\r