drivers/net/wireless/rockchip_wlan/rtl8822be/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
  40 /* ---------------------------------------------------------------------
  41  *              RTL8703B From file
  42  * --------------------------------------------------------------------- */
  43 #define RTL8703B_FW_IMG                                 "rtl8703b/FW_NIC.bin"
  44 #define RTL8703B_FW_WW_IMG                              "rtl8703b/FW_WoWLAN.bin"
  45 #define RTL8703B_PHY_REG                                        "rtl8703b/PHY_REG.txt"
  46 #define RTL8703B_PHY_RADIO_A                            "rtl8703b/RadioA.txt"
  47 #define RTL8703B_PHY_RADIO_B                            "rtl8703b/RadioB.txt"
  48 #define RTL8703B_TXPWR_TRACK                            "rtl8703b/TxPowerTrack.txt"
  49 #define RTL8703B_AGC_TAB                                        "rtl8703b/AGC_TAB.txt"
  50 #define RTL8703B_PHY_MACREG                             "rtl8703b/MAC_REG.txt"
  51 #define RTL8703B_PHY_REG_PG                             "rtl8703b/PHY_REG_PG.txt"
  52 #define RTL8703B_PHY_REG_MP                             "rtl8703b/PHY_REG_MP.txt"
  53 #define RTL8703B_TXPWR_LMT                              "rtl8703b/TXPWR_LMT.txt"
  54
  55 /* ---------------------------------------------------------------------
  56  *              RTL8703B From header
  57  * --------------------------------------------------------------------- */
  58
  59 #if MP_DRIVER == 1
  60         #define Rtl8703B_FwBTImgArray                           Rtl8703BFwBTImgArray
  61         #define Rtl8703B_FwBTImgArrayLength             Rtl8703BFwBTImgArrayLength
  62
  63         #define Rtl8703B_PHY_REG_Array_MP                       Rtl8703B_PHYREG_Array_MP
  64         #define Rtl8703B_PHY_REG_Array_MPLength Rtl8703B_PHYREG_Array_MPLength
  65 #endif
  66
  67
  68 #define FW_8703B_SIZE                   0x8000
  69 #define FW_8703B_START_ADDRESS  0x1000
  70 #define FW_8703B_END_ADDRESS            0x1FFF /* 0x5FFF */
  71
  72 #define IS_FW_HEADER_EXIST_8703B(_pFwHdr)       ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x03B0)
  73
  74 typedef struct _RT_FIRMWARE {
  75         FIRMWARE_SOURCE eFWSource;
  76 #ifdef CONFIG_EMBEDDED_FWIMG
  77         u8                      *szFwBuffer;
  78 #else
  79         u8                      szFwBuffer[FW_8703B_SIZE];
  80 #endif
  81         u32                     ulFwLength;
  82 } RT_FIRMWARE_8703B, *PRT_FIRMWARE_8703B;
  83
  84 /*
  85  * This structure must be cared byte-ordering
  86  *
  87  * Added by tynli. 2009.12.04. */
  88 typedef struct _RT_8703B_FIRMWARE_HDR {
  89         /* 8-byte alinment required */
  90
  91         /* --- LONG WORD 0 ---- */
  92         u16             Signature;      /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
  93         u8              Category;       /* AP/NIC and USB/PCI */
  94         u8              Function;       /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
  95         u16             Version;                /* FW Version */
  96         u16             Subversion;     /* FW Subversion, default 0x00 */
  97
  98         /* --- LONG WORD 1 ---- */
  99         u8              Month;  /* Release time Month field */
 100         u8              Date;   /* Release time Date field */
 101         u8              Hour;   /* Release time Hour field */
 102         u8              Minute; /* Release time Minute field */
 103         u16             RamCodeSize;    /* The size of RAM code */
 104         u16             Rsvd2;
 105
 106         /* --- LONG WORD 2 ---- */
 107         u32             SvnIdx; /* The SVN entry index */
 108         u32             Rsvd3;
 109
 110         /* --- LONG WORD 3 ---- */
 111         u32             Rsvd4;
 112         u32             Rsvd5;
 113 } RT_8703B_FIRMWARE_HDR, *PRT_8703B_FIRMWARE_HDR;
 114
 115 #define DRIVER_EARLY_INT_TIME_8703B             0x05
 116 #define BCN_DMA_ATIME_INT_TIME_8703B            0x02
 117
 118 /* for 8703B
 119  * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
 120 #define PAGE_SIZE_TX_8703B                      128
 121 #define PAGE_SIZE_RX_8703B                      8
 122
 123 #define TX_DMA_SIZE_8703B                       0x8000  /* 32K(TX) */
 124 #define RX_DMA_SIZE_8703B                       0x4000  /* 16K(RX) */
 125
 126 #ifdef CONFIG_WOWLAN
 127         #define RESV_FMWF       (WKFMCAM_SIZE * MAX_WKFM_NUM) /* 16 entries, for each is 24 bytes*/
 128 #else
 129         #define RESV_FMWF       0
 130 #endif
 131
 132 #ifdef CONFIG_FW_C2H_DEBUG
 133         #define RX_DMA_RESERVED_SIZE_8703B      0x100   /* 256B, reserved for c2h debug message */
 134 #else
 135         #define RX_DMA_RESERVED_SIZE_8703B      0x80    /* 128B, reserved for tx report */
 136 #endif
 137 #define RX_DMA_BOUNDARY_8703B           (RX_DMA_SIZE_8703B - RX_DMA_RESERVED_SIZE_8703B - 1)
 138
 139
 140 /* Note: We will divide number of page equally for each queue other than public queue! */
 141
 142 /* For General Reserved Page Number(Beacon Queue is reserved page)
 143  * Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1 */
 144 #define BCNQ_PAGE_NUM_8703B             0x08
 145 #ifdef CONFIG_CONCURRENT_MODE
 146         #define BCNQ1_PAGE_NUM_8703B            0x08 /* 0x04 */
 147 #else
 148         #define BCNQ1_PAGE_NUM_8703B            0x00
 149 #endif
 150
 151 #ifdef CONFIG_PNO_SUPPORT
 152         #undef BCNQ1_PAGE_NUM_8703B
 153         #define BCNQ1_PAGE_NUM_8703B            0x00 /* 0x04 */
 154 #endif
 155
 156 /* For WoWLan , more reserved page
 157  * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, PNO: 6 */
 158 #ifdef CONFIG_WOWLAN
 159         #define WOWLAN_PAGE_NUM_8703B   0x07
 160 #else
 161         #define WOWLAN_PAGE_NUM_8703B   0x00
 162 #endif
 163
 164 #ifdef CONFIG_PNO_SUPPORT
 165         #undef WOWLAN_PAGE_NUM_8703B
 166         #define WOWLAN_PAGE_NUM_8703B   0x15
 167 #endif
 168
 169 #ifdef CONFIG_AP_WOWLAN
 170         #define AP_WOWLAN_PAGE_NUM_8703B        0x02
 171 #endif
 172
 173 #define TX_TOTAL_PAGE_NUMBER_8703B      (0xFF - BCNQ_PAGE_NUM_8703B - BCNQ1_PAGE_NUM_8703B - WOWLAN_PAGE_NUM_8703B)
 174 #define TX_PAGE_BOUNDARY_8703B          (TX_TOTAL_PAGE_NUMBER_8703B + 1)
 175
 176 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B   TX_TOTAL_PAGE_NUMBER_8703B
 177 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8703B               (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B + 1)
 178
 179 /* For Normal Chip Setting
 180  * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8703B */
 181 #define NORMAL_PAGE_NUM_HPQ_8703B               0x0C
 182 #define NORMAL_PAGE_NUM_LPQ_8703B               0x02
 183 #define NORMAL_PAGE_NUM_NPQ_8703B               0x02
 184
 185 /* Note: For Normal Chip Setting, modify later */
 186 #define WMM_NORMAL_PAGE_NUM_HPQ_8703B           0x30
 187 #define WMM_NORMAL_PAGE_NUM_LPQ_8703B           0x20
 188 #define WMM_NORMAL_PAGE_NUM_NPQ_8703B           0x20
 189
 190
 191 #include "HalVerDef.h"
 192 #include "hal_com.h"
 193
 194 #define EFUSE_OOB_PROTECT_BYTES         15
 195
 196 #define HAL_EFUSE_MEMORY
 197
 198 #define HWSET_MAX_SIZE_8703B                    256
 199 #define EFUSE_REAL_CONTENT_LEN_8703B            256
 200 #define EFUSE_MAP_LEN_8703B                             512
 201 #define EFUSE_MAX_SECTION_8703B                 64
 202
 203 #define EFUSE_IC_ID_OFFSET                      506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 204 #define AVAILABLE_EFUSE_ADDR(addr)      (addr < EFUSE_REAL_CONTENT_LEN_8703B)
 205
 206 #define EFUSE_ACCESS_ON                 0x69
 207 #define EFUSE_ACCESS_OFF                        0x00
 208
 209 /* ********************************************************
 210  *                      EFUSE for BT definition
 211  * ******************************************************** */
 212 #define BANK_NUM                1
 213 #define EFUSE_BT_REAL_BANK_CONTENT_LEN  128
 214 #define EFUSE_BT_REAL_CONTENT_LEN               (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM)
 215 #define EFUSE_BT_MAP_LEN                                1024    /* 1k bytes */
 216 #define EFUSE_BT_MAX_SECTION                    (EFUSE_BT_MAP_LEN / 8)
 217 #define EFUSE_PROTECT_BYTES_BANK                16
 218
 219 typedef struct _C2H_EVT_HDR {
 220         u8      CmdID;
 221         u8      CmdLen;
 222         u8      CmdSeq;
 223 } __attribute__((__packed__)) C2H_EVT_HDR, *PC2H_EVT_HDR;
 224
 225 typedef enum tag_Package_Definition {
 226         PACKAGE_DEFAULT,
 227         PACKAGE_QFN68,
 228         PACKAGE_TFBGA90,
 229         PACKAGE_TFBGA80,
 230         PACKAGE_TFBGA79
 231 } PACKAGE_TYPE_E;
 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 /* rtl8703b_hal_init.c */
 237 s32 rtl8703b_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);
 238 void rtl8703b_FirmwareSelfReset(PADAPTER padapter);
 239 void rtl8703b_InitializeFirmwareVars(PADAPTER padapter);
 240
 241 void rtl8703b_InitAntenna_Selection(PADAPTER padapter);
 242 void rtl8703b_DeinitAntenna_Selection(PADAPTER padapter);
 243 void rtl8703b_CheckAntenna_Selection(PADAPTER padapter);
 244 void rtl8703b_init_default_value(PADAPTER padapter);
 245
 246 s32 rtl8703b_InitLLTTable(PADAPTER padapter);
 247
 248 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
 249 s32 CardDisableWithoutHWSM(PADAPTER padapter);
 250
 251 /* EFuse */
 252 u8 GetEEPROMSize8703B(PADAPTER padapter);
 253 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
 254 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
 255 void Hal_EfuseParseTxPowerInfo_8703B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
 256 void Hal_EfuseParseBTCoexistInfo_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 257 void Hal_EfuseParseEEPROMVer_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 258 void Hal_EfuseParseChnlPlan_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 259 void Hal_EfuseParseCustomerID_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 260 void Hal_EfuseParseAntennaDiversity_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 261 void Hal_EfuseParseXtal_8703B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);
 262 void Hal_EfuseParseThermalMeter_8703B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);
 263 VOID Hal_EfuseParseVoltage_8703B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 264 VOID Hal_EfuseParseBoardType_8703B(PADAPTER Adapter,    u8      *PROMContent, BOOLEAN AutoloadFail);
 265
 266 #ifdef CONFIG_C2H_PACKET_EN
 267         void rtl8703b_c2h_packet_handler(PADAPTER padapter, u8 *pbuf, u16 length);
 268 #endif
 269
 270
 271 void rtl8703b_set_hal_ops(struct hal_ops *pHalFunc);
 272 void init_hal_spec_8703b(_adapter *adapter);
 273 void SetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);
 274 void GetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);
 275 #ifdef CONFIG_C2H_PACKET_EN
 276         void SetHwRegWithBuf8703B(PADAPTER padapter, u8 variable, u8 *pbuf, int len);
 277 #endif /* CONFIG_C2H_PACKET_EN */
 278 u8 SetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 279 u8 GetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 280
 281 /* register */
 282 void rtl8703b_InitBeaconParameters(PADAPTER padapter);
 283 void rtl8703b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
 284 void    _InitBurstPktLen_8703BS(PADAPTER Adapter);
 285 void _InitLTECoex_8703BS(PADAPTER Adapter);
 286 void _InitMacAPLLSetting_8703B(PADAPTER Adapter);
 287 void _8051Reset8703(PADAPTER padapter);
 288 #ifdef CONFIG_WOWLAN
 289         void Hal_DetectWoWMode(PADAPTER pAdapter);
 290 #endif /* CONFIG_WOWLAN */
 291
 292 void rtl8703b_start_thread(_adapter *padapter);
 293 void rtl8703b_stop_thread(_adapter *padapter);
 294
 295 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
 296         void rtl8703bs_init_checkbthang_workqueue(_adapter *adapter);
 297         void rtl8703bs_free_checkbthang_workqueue(_adapter *adapter);
 298         void rtl8703bs_cancle_checkbthang_workqueue(_adapter *adapter);
 299         void rtl8703bs_hal_check_bt_hang(_adapter *adapter);
 300 #endif
 301
 302 #ifdef CONFIG_GPIO_WAKEUP
 303         void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);
 304 #endif
 305
 306 int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
 307
 308 void CCX_FwC2HTxRpt_8703b(PADAPTER padapter, u8 *pdata, u8 len);
 309 s32 c2h_id_filter_ccx_8703b(u8 *buf);
 310 s32 c2h_handler_8703b(PADAPTER padapter, u8 *pC2hEvent);
 311 u8 MRateToHwRate8703B(u8  rate);
 312 u8 HwRateToMRate8703B(u8         rate);
 313
 314 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 315
 316 #ifdef CONFIG_PCI_HCI
 317         BOOLEAN InterruptRecognized8703BE(PADAPTER Adapter);
 318         VOID    UpdateInterruptMask8703BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
 319 #endif
 320
 321 #endif