drivers/net/wireless/rockchip_wlan/rtl8723cs/include/rtl8703b_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 __RTL8703B_HAL_H__
  21 #define __RTL8703B_HAL_H__
  22
  23 #include "hal_data.h"
  24
  25 #include "rtl8703b_spec.h"
  26 #include "rtl8703b_rf.h"
  27 #include "rtl8703b_dm.h"
  28 #include "rtl8703b_recv.h"
  29 #include "rtl8703b_xmit.h"
  30 #include "rtl8703b_cmd.h"
  31 #include "rtl8703b_led.h"
  32 #include "Hal8703BPwrSeq.h"
  33 #include "Hal8703BPhyReg.h"
  34 #include "Hal8703BPhyCfg.h"
  35 #ifdef DBG_CONFIG_ERROR_DETECT
  36         #include "rtl8703b_sreset.h"
  37 #endif
  38
  39 #define FW_8703B_SIZE                   0x8000
  40 #define FW_8703B_START_ADDRESS  0x1000
  41 #define FW_8703B_END_ADDRESS            0x1FFF /* 0x5FFF */
  42
  43 #define IS_FW_HEADER_EXIST_8703B(_pFwHdr)       ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x03B0)
  44
  45 typedef struct _RT_FIRMWARE {
  46         FIRMWARE_SOURCE eFWSource;
  47 #ifdef CONFIG_EMBEDDED_FWIMG
  48         u8                      *szFwBuffer;
  49 #else
  50         u8                      szFwBuffer[FW_8703B_SIZE];
  51 #endif
  52         u32                     ulFwLength;
  53 } RT_FIRMWARE_8703B, *PRT_FIRMWARE_8703B;
  54
  55 /*
  56  * This structure must be cared byte-ordering
  57  *
  58  * Added by tynli. 2009.12.04. */
  59 typedef struct _RT_8703B_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_8703B_FIRMWARE_HDR, *PRT_8703B_FIRMWARE_HDR;
  85
  86 #define DRIVER_EARLY_INT_TIME_8703B             0x05
  87 #define BCN_DMA_ATIME_INT_TIME_8703B            0x02
  88
  89 /* for 8703B
  90  * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
  91 #define PAGE_SIZE_TX_8703B                      128
  92 #define PAGE_SIZE_RX_8703B                      8
  93
  94 #define TX_DMA_SIZE_8703B                       0x8000  /* 32K(TX) */
  95 #define RX_DMA_SIZE_8703B                       0x4000  /* 16K(RX) */
  96
  97 #ifdef CONFIG_WOWLAN
  98         #define RESV_FMWF       (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/
  99 #else
 100         #define RESV_FMWF       0
 101 #endif
 102
 103 #ifdef CONFIG_FW_C2H_DEBUG
 104         #define RX_DMA_RESERVED_SIZE_8703B      0x100   /* 256B, reserved for c2h debug message */
 105 #else
 106         #define RX_DMA_RESERVED_SIZE_8703B      0x80    /* 128B, reserved for tx report */
 107 #endif
 108 #define RX_DMA_BOUNDARY_8703B           (RX_DMA_SIZE_8703B - RX_DMA_RESERVED_SIZE_8703B - 1)
 109
 110
 111 /* Note: We will divide number of page equally for each queue other than public queue! */
 112
 113 /* For General Reserved Page Number(Beacon Queue is reserved page)
 114  * Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1 */
 115 #define BCNQ_PAGE_NUM_8703B             0x08
 116 #ifdef CONFIG_CONCURRENT_MODE
 117         #define BCNQ1_PAGE_NUM_8703B            0x08 /* 0x04 */
 118 #else
 119         #define BCNQ1_PAGE_NUM_8703B            0x00
 120 #endif
 121
 122 #ifdef CONFIG_PNO_SUPPORT
 123         #undef BCNQ1_PAGE_NUM_8703B
 124         #define BCNQ1_PAGE_NUM_8703B            0x00 /* 0x04 */
 125 #endif
 126
 127 /* For WoWLan , more reserved page
 128  * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, AOAC rpt: 1 PNO: 6 */
 129 #ifdef CONFIG_WOWLAN
 130         #define WOWLAN_PAGE_NUM_8703B   0x08
 131 #else
 132         #define WOWLAN_PAGE_NUM_8703B   0x00
 133 #endif
 134
 135 #ifdef CONFIG_PNO_SUPPORT
 136         #undef WOWLAN_PAGE_NUM_8703B
 137         #define WOWLAN_PAGE_NUM_8703B   0x15
 138 #endif
 139
 140 #ifdef CONFIG_AP_WOWLAN
 141         #define AP_WOWLAN_PAGE_NUM_8703B        0x02
 142 #endif
 143
 144 #define TX_TOTAL_PAGE_NUMBER_8703B      (0xFF - BCNQ_PAGE_NUM_8703B - BCNQ1_PAGE_NUM_8703B - WOWLAN_PAGE_NUM_8703B)
 145 #define TX_PAGE_BOUNDARY_8703B          (TX_TOTAL_PAGE_NUMBER_8703B + 1)
 146
 147 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B   TX_TOTAL_PAGE_NUMBER_8703B
 148 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8703B               (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B + 1)
 149
 150 /* For Normal Chip Setting
 151  * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8703B */
 152 #define NORMAL_PAGE_NUM_HPQ_8703B               0x0C
 153 #define NORMAL_PAGE_NUM_LPQ_8703B               0x02
 154 #define NORMAL_PAGE_NUM_NPQ_8703B               0x02
 155
 156 /* Note: For Normal Chip Setting, modify later */
 157 #define WMM_NORMAL_PAGE_NUM_HPQ_8703B           0x30
 158 #define WMM_NORMAL_PAGE_NUM_LPQ_8703B           0x20
 159 #define WMM_NORMAL_PAGE_NUM_NPQ_8703B           0x20
 160
 161
 162 #include "HalVerDef.h"
 163 #include "hal_com.h"
 164
 165 #define EFUSE_OOB_PROTECT_BYTES         15
 166
 167 #define HAL_EFUSE_MEMORY
 168
 169 #define HWSET_MAX_SIZE_8703B                    256
 170 #define EFUSE_REAL_CONTENT_LEN_8703B            256
 171 #define EFUSE_MAP_LEN_8703B                             512
 172 #define EFUSE_MAX_SECTION_8703B                 64
 173
 174 #define EFUSE_IC_ID_OFFSET                      506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 175 #define AVAILABLE_EFUSE_ADDR(addr)      (addr < EFUSE_REAL_CONTENT_LEN_8703B)
 176
 177 #define EFUSE_ACCESS_ON                 0x69
 178 #define EFUSE_ACCESS_OFF                        0x00
 179
 180 /* ********************************************************
 181  *                      EFUSE for BT definition
 182  * ******************************************************** */
 183 #define BANK_NUM                1
 184 #define EFUSE_BT_REAL_BANK_CONTENT_LEN  128
 185 #define EFUSE_BT_REAL_CONTENT_LEN               (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM)
 186 #define EFUSE_BT_MAP_LEN                                1024    /* 1k bytes */
 187 #define EFUSE_BT_MAX_SECTION                    (EFUSE_BT_MAP_LEN / 8)
 188 #define EFUSE_PROTECT_BYTES_BANK                16
 189
 190 typedef enum tag_Package_Definition {
 191         PACKAGE_DEFAULT,
 192         PACKAGE_QFN68,
 193         PACKAGE_TFBGA90,
 194         PACKAGE_TFBGA80,
 195         PACKAGE_TFBGA79
 196 } PACKAGE_TYPE_E;
 197
 198 #define INCLUDE_MULTI_FUNC_BT(_Adapter)         (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
 199 #define INCLUDE_MULTI_FUNC_GPS(_Adapter)        (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 200
 201 /* rtl8703b_hal_init.c */
 202 s32 rtl8703b_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);
 203 void rtl8703b_FirmwareSelfReset(PADAPTER padapter);
 204 void rtl8703b_InitializeFirmwareVars(PADAPTER padapter);
 205
 206 void rtl8703b_InitAntenna_Selection(PADAPTER padapter);
 207 void rtl8703b_DeinitAntenna_Selection(PADAPTER padapter);
 208 void rtl8703b_CheckAntenna_Selection(PADAPTER padapter);
 209 void rtl8703b_init_default_value(PADAPTER padapter);
 210
 211 s32 rtl8703b_InitLLTTable(PADAPTER padapter);
 212
 213 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
 214 s32 CardDisableWithoutHWSM(PADAPTER padapter);
 215
 216 /* EFuse */
 217 u8 GetEEPROMSize8703B(PADAPTER padapter);
 218 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
 219 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
 220 void Hal_EfuseParseTxPowerInfo_8703B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
 221 void Hal_EfuseParseBTCoexistInfo_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 222 void Hal_EfuseParseEEPROMVer_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 223 void Hal_EfuseParseChnlPlan_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 224 void Hal_EfuseParseCustomerID_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 225 void Hal_EfuseParseAntennaDiversity_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 226 void Hal_EfuseParseXtal_8703B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);
 227 void Hal_EfuseParseThermalMeter_8703B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);
 228 VOID Hal_EfuseParseVoltage_8703B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 229 VOID Hal_EfuseParseBoardType_8703B(PADAPTER Adapter,    u8      *PROMContent, BOOLEAN AutoloadFail);
 230
 231 void rtl8703b_set_hal_ops(struct hal_ops *pHalFunc);
 232 void init_hal_spec_8703b(_adapter *adapter);
 233 void SetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);
 234 void GetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);
 235 u8 SetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 236 u8 GetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 237
 238 /* register */
 239 void rtl8703b_InitBeaconParameters(PADAPTER padapter);
 240 void rtl8703b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
 241 void    _InitBurstPktLen_8703BS(PADAPTER Adapter);
 242 void _InitLTECoex_8703BS(PADAPTER Adapter);
 243 void _InitMacAPLLSetting_8703B(PADAPTER Adapter);
 244 void _8051Reset8703(PADAPTER padapter);
 245 #ifdef CONFIG_WOWLAN
 246         void Hal_DetectWoWMode(PADAPTER pAdapter);
 247 #endif /* CONFIG_WOWLAN */
 248
 249 void rtl8703b_start_thread(_adapter *padapter);
 250 void rtl8703b_stop_thread(_adapter *padapter);
 251
 252 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
 253         void rtl8703bs_init_checkbthang_workqueue(_adapter *adapter);
 254         void rtl8703bs_free_checkbthang_workqueue(_adapter *adapter);
 255         void rtl8703bs_cancle_checkbthang_workqueue(_adapter *adapter);
 256         void rtl8703bs_hal_check_bt_hang(_adapter *adapter);
 257 #endif
 258
 259 #ifdef CONFIG_GPIO_WAKEUP
 260         void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);
 261 #endif
 262 #ifdef CONFIG_MP_INCLUDED
 263 int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
 264 #endif
 265 void CCX_FwC2HTxRpt_8703b(PADAPTER padapter, u8 *pdata, u8 len);
 266
 267 u8 MRateToHwRate8703B(u8  rate);
 268 u8 HwRateToMRate8703B(u8         rate);
 269
 270 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 271
 272 #ifdef CONFIG_PCI_HCI
 273         BOOLEAN InterruptRecognized8703BE(PADAPTER Adapter);
 274         VOID    UpdateInterruptMask8703BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
 275 #endif
 276
 277 #endif