drivers/net/wireless/rockchip_wlan/rtl8723cs/include/rtl8188f_hal.h

   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 __RTL8188F_HAL_H__
  21 #define __RTL8188F_HAL_H__
  22
  23 #include "hal_data.h"
  24
  25 #include "rtl8188f_spec.h"
  26 #include "rtl8188f_rf.h"
  27 #include "rtl8188f_dm.h"
  28 #include "rtl8188f_recv.h"
  29 #include "rtl8188f_xmit.h"
  30 #include "rtl8188f_cmd.h"
  31 #include "rtl8188f_led.h"
  32 #include "Hal8188FPwrSeq.h"
  33 #include "Hal8188FPhyReg.h"
  34 #include "Hal8188FPhyCfg.h"
  35 #ifdef DBG_CONFIG_ERROR_DETECT
  36 #include "rtl8188f_sreset.h"
  37 #endif
  38
  39 #define FW_8188F_SIZE                   0x8000
  40 #define FW_8188F_START_ADDRESS  0x1000
  41 #define FW_8188F_END_ADDRESS            0x1FFF /* 0x5FFF */
  42
  43 #define IS_FW_HEADER_EXIST_8188F(_pFwHdr)       ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x88F0)
  44
  45 typedef struct _RT_FIRMWARE {
  46         FIRMWARE_SOURCE eFWSource;
  47 #ifdef CONFIG_EMBEDDED_FWIMG
  48         u8                      *szFwBuffer;
  49 #else
  50         u8                      szFwBuffer[FW_8188F_SIZE];
  51 #endif
  52         u32                     ulFwLength;
  53 } RT_FIRMWARE_8188F, *PRT_FIRMWARE_8188F;
  54
  55 /*
  56  * This structure must be cared byte-ordering
  57  *
  58  * Added by tynli. 2009.12.04. */
  59 typedef struct _RT_8188F_FIRMWARE_HDR {
  60         /* 8-byte alinment required */
  61
  62         /* --- LONG WORD 0 ---- */
  63         u16             Signature;      /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
  64         u8              Category;       /* AP/NIC and USB/PCI */
  65         u8              Function;       /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
  66         u16             Version;                /* FW Version */
  67         u16             Subversion;     /* FW Subversion, default 0x00 */
  68
  69         /* --- LONG WORD 1 ---- */
  70         u8              Month;  /* Release time Month field */
  71         u8              Date;   /* Release time Date field */
  72         u8              Hour;   /* Release time Hour field */
  73         u8              Minute; /* Release time Minute field */
  74         u16             RamCodeSize;    /* The size of RAM code */
  75         u16             Rsvd2;
  76
  77         /* --- LONG WORD 2 ---- */
  78         u32             SvnIdx; /* The SVN entry index */
  79         u32             Rsvd3;
  80
  81         /* --- LONG WORD 3 ---- */
  82         u32             Rsvd4;
  83         u32             Rsvd5;
  84 } RT_8188F_FIRMWARE_HDR, *PRT_8188F_FIRMWARE_HDR;
  85
  86 #define DRIVER_EARLY_INT_TIME_8188F             0x05
  87 #define BCN_DMA_ATIME_INT_TIME_8188F            0x02
  88
  89 /* for 8188F
  90  * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
  91 #define PAGE_SIZE_TX_8188F                      128
  92 #define PAGE_SIZE_RX_8188F                      8
  93
  94 #define RX_DMA_SIZE_8188F                       0x4000  /* 16K */
  95 #ifdef CONFIG_FW_C2H_DEBUG
  96         #define RX_DMA_RESERVED_SIZE_8188F      0x100   /* 256B, reserved for c2h debug message */
  97 #else
  98         #define RX_DMA_RESERVED_SIZE_8188F      0x80    /* 128B, reserved for tx report */
  99 #endif
 100
 101 #ifdef CONFIG_WOWLAN
 102         #define RESV_FMWF       (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/
 103 #else
 104         #define RESV_FMWF       0
 105 #endif
 106
 107 #define RX_DMA_BOUNDARY_8188F           (RX_DMA_SIZE_8188F - RX_DMA_RESERVED_SIZE_8188F - 1)
 108
 109 /* Note: We will divide number of page equally for each queue other than public queue! */
 110
 111 /* For General Reserved Page Number(Beacon Queue is reserved page)
 112  * Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1 */
 113 #define BCNQ_PAGE_NUM_8188F             0x08
 114 #ifdef CONFIG_CONCURRENT_MODE
 115         #define BCNQ1_PAGE_NUM_8188F            0x08 /* 0x04 */
 116 #else
 117         #define BCNQ1_PAGE_NUM_8188F            0x00
 118 #endif
 119
 120 #ifdef CONFIG_PNO_SUPPORT
 121 #undef BCNQ1_PAGE_NUM_8188F
 122 #define BCNQ1_PAGE_NUM_8188F            0x00 /* 0x04 */
 123 #endif
 124
 125 /* For WoWLan , more reserved page
 126  * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt:1 ,PNO: 6 */
 127 #ifdef CONFIG_WOWLAN
 128         #define WOWLAN_PAGE_NUM_8188F   0x08
 129 #else
 130         #define WOWLAN_PAGE_NUM_8188F   0x00
 131 #endif
 132
 133 #ifdef CONFIG_PNO_SUPPORT
 134 #undef WOWLAN_PAGE_NUM_8188F
 135 #define WOWLAN_PAGE_NUM_8188F   0x15
 136 #endif
 137
 138 #ifdef CONFIG_AP_WOWLAN
 139 #define AP_WOWLAN_PAGE_NUM_8188F        0x02
 140 #endif
 141
 142 #define TX_TOTAL_PAGE_NUMBER_8188F      (0xFF - BCNQ_PAGE_NUM_8188F - BCNQ1_PAGE_NUM_8188F - WOWLAN_PAGE_NUM_8188F)
 143 #define TX_PAGE_BOUNDARY_8188F          (TX_TOTAL_PAGE_NUMBER_8188F + 1)
 144
 145 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8188F   TX_TOTAL_PAGE_NUMBER_8188F
 146 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8188F               (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8188F + 1)
 147
 148 /* For Normal Chip Setting
 149  * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8188F */
 150 #define NORMAL_PAGE_NUM_HPQ_8188F               0x0C
 151 #define NORMAL_PAGE_NUM_LPQ_8188F               0x02
 152 #define NORMAL_PAGE_NUM_NPQ_8188F               0x02
 153
 154 /* Note: For Normal Chip Setting, modify later */
 155 #define WMM_NORMAL_PAGE_NUM_HPQ_8188F           0x30
 156 #define WMM_NORMAL_PAGE_NUM_LPQ_8188F           0x20
 157 #define WMM_NORMAL_PAGE_NUM_NPQ_8188F           0x20
 158
 159
 160 #include "HalVerDef.h"
 161 #include "hal_com.h"
 162
 163 #define EFUSE_OOB_PROTECT_BYTES (34 + 1)
 164
 165 #define HAL_EFUSE_MEMORY
 166
 167 #define HWSET_MAX_SIZE_8188F                    512
 168 #define EFUSE_REAL_CONTENT_LEN_8188F    256
 169 #define EFUSE_MAP_LEN_8188F                             512
 170 #define EFUSE_MAX_SECTION_8188F                 (EFUSE_MAP_LEN_8188F / 8)
 171
 172 #define EFUSE_IC_ID_OFFSET                      506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 173 #define AVAILABLE_EFUSE_ADDR(addr)      (addr < EFUSE_REAL_CONTENT_LEN_8188F)
 174
 175 #define EFUSE_ACCESS_ON                 0x69    /* For RTL8188 only. */
 176 #define EFUSE_ACCESS_OFF                        0x00    /* For RTL8188 only. */
 177
 178 /* ********************************************************
 179  *                      EFUSE for BT definition
 180  * ******************************************************** */
 181 #define EFUSE_BT_REAL_BANK_CONTENT_LEN  512
 182 #define EFUSE_BT_REAL_CONTENT_LEN               1536    /* 512*3 */
 183 #define EFUSE_BT_MAP_LEN                                1024    /* 1k bytes */
 184 #define EFUSE_BT_MAX_SECTION                    128             /* 1024/8 */
 185
 186 #define EFUSE_PROTECT_BYTES_BANK                16
 187
 188 #define INCLUDE_MULTI_FUNC_BT(_Adapter)         (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
 189 #define INCLUDE_MULTI_FUNC_GPS(_Adapter)        (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 190
 191 /* rtl8188a_hal_init.c */
 192 s32 rtl8188f_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);
 193 void rtl8188f_FirmwareSelfReset(PADAPTER padapter);
 194 void rtl8188f_InitializeFirmwareVars(PADAPTER padapter);
 195
 196 void rtl8188f_InitAntenna_Selection(PADAPTER padapter);
 197 void rtl8188f_DeinitAntenna_Selection(PADAPTER padapter);
 198 void rtl8188f_CheckAntenna_Selection(PADAPTER padapter);
 199 void rtl8188f_init_default_value(PADAPTER padapter);
 200
 201 s32 rtl8188f_InitLLTTable(PADAPTER padapter);
 202
 203 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
 204 s32 CardDisableWithoutHWSM(PADAPTER padapter);
 205
 206 /* EFuse */
 207 u8 GetEEPROMSize8188F(PADAPTER padapter);
 208 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
 209 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
 210 void Hal_EfuseParseTxPowerInfo_8188F(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
 211 /* void Hal_EfuseParseBTCoexistInfo_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); */
 212 void Hal_EfuseParseEEPROMVer_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 213 void Hal_EfuseParseChnlPlan_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 214 void Hal_EfuseParseCustomerID_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 215 void Hal_EfuseParsePowerSavingMode_8188F(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 216 void Hal_EfuseParseAntennaDiversity_8188F(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 217 void Hal_EfuseParseXtal_8188F(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);
 218 void Hal_EfuseParseThermalMeter_8188F(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);
 219 void Hal_EfuseParseKFreeData_8188F(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 220
 221 #if 0 /* Do not need for rtl8188f */
 222 VOID Hal_EfuseParseVoltage_8188F(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 223 #endif
 224
 225 void rtl8188f_set_pll_ref_clk_sel(_adapter *adapter, u8 sel);
 226
 227 void rtl8188f_set_hal_ops(struct hal_ops *pHalFunc);
 228 void init_hal_spec_8188f(_adapter *adapter);
 229 void SetHwReg8188F(PADAPTER padapter, u8 variable, u8 *val);
 230 void GetHwReg8188F(PADAPTER padapter, u8 variable, u8 *val);
 231 u8 SetHalDefVar8188F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 232 u8 GetHalDefVar8188F(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 233
 234 /* register */
 235 void rtl8188f_InitBeaconParameters(PADAPTER padapter);
 236 void rtl8188f_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
 237 void    _InitBurstPktLen_8188FS(PADAPTER Adapter);
 238 void _8051Reset8188(PADAPTER padapter);
 239 #ifdef CONFIG_WOWLAN
 240 void Hal_DetectWoWMode(PADAPTER pAdapter);
 241 #endif /* CONFIG_WOWLAN */
 242
 243 void rtl8188f_start_thread(_adapter *padapter);
 244 void rtl8188f_stop_thread(_adapter *padapter);
 245
 246 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
 247         void rtl8188fs_init_checkbthang_workqueue(_adapter *adapter);
 248         void rtl8188fs_free_checkbthang_workqueue(_adapter *adapter);
 249         void rtl8188fs_cancle_checkbthang_workqueue(_adapter *adapter);
 250         void rtl8188fs_hal_check_bt_hang(_adapter *adapter);
 251 #endif
 252
 253 #ifdef CONFIG_GPIO_WAKEUP
 254 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);
 255 #endif
 256
 257 #ifdef CONFIG_MP_INCLUDED
 258 int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
 259 #endif
 260
 261 void CCX_FwC2HTxRpt_8188f(PADAPTER padapter, u8 *pdata, u8 len);
 262
 263 u8 MRateToHwRate8188F(u8  rate);
 264 u8 HwRateToMRate8188F(u8         rate);
 265
 266 #ifdef CONFIG_PCI_HCI
 267 BOOLEAN InterruptRecognized8188FE(PADAPTER Adapter);
 268 VOID    UpdateInterruptMask8188FE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
 269 #endif
 270
 271 #endif