drivers/net/wireless/rockchip_wlan/rtl8723cs/include/rtl8814a_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 __RTL8814A_HAL_H__
  21 #define __RTL8814A_HAL_H__
  22
  23 /* #include "hal_com.h" */
  24 #include "hal_data.h"
  25
  26 /* include HAL Related header after HAL Related compiling flags */
  27 #include "rtl8814a_spec.h"
  28 #include "rtl8814a_rf.h"
  29 #include "rtl8814a_dm.h"
  30 #include "rtl8814a_recv.h"
  31 #include "rtl8814a_xmit.h"
  32 #include "rtl8814a_cmd.h"
  33 #include "rtl8814a_led.h"
  34 #include "Hal8814PwrSeq.h"
  35 #include "Hal8814PhyReg.h"
  36 #include "Hal8814PhyCfg.h"
  37 #ifdef DBG_CONFIG_ERROR_DETECT
  38         #include "rtl8814a_sreset.h"
  39 #endif /* DBG_CONFIG_ERROR_DETECT */
  40
  41 enum {
  42         VOLTAGE_V25                                             = 0x03,
  43         LDOE25_SHIFT                                    = 28 ,
  44 };
  45 /* max. iram is 64k , max dmen is 32k. Total = 96k = 0x18000*/
  46 #define FW_SIZE                                                 0x18000
  47 #define FW_START_ADDRESS   0x1000
  48 typedef struct _RT_FIRMWARE_8814 {
  49         FIRMWARE_SOURCE eFWSource;
  50 #ifdef CONFIG_EMBEDDED_FWIMG
  51         u8                      *szFwBuffer;
  52 #else
  53         u8                      szFwBuffer[FW_SIZE];
  54 #endif
  55         u32                     ulFwLength;
  56 } RT_FIRMWARE_8814, *PRT_FIRMWARE_8814;
  57
  58 #define PAGE_SIZE_TX_8814       PAGE_SIZE_128
  59 #define BCNQ_PAGE_NUM_8814              0x08
  60
  61 #define Rtl8814A_NIC_PWR_ON_FLOW                                rtl8814A_power_on_flow
  62 #define Rtl8814A_NIC_RF_OFF_FLOW                                rtl8814A_radio_off_flow
  63 #define Rtl8814A_NIC_DISABLE_FLOW                               rtl8814A_card_disable_flow
  64 #define Rtl8814A_NIC_ENABLE_FLOW                                rtl8814A_card_enable_flow
  65 #define Rtl8814A_NIC_SUSPEND_FLOW                               rtl8814A_suspend_flow
  66 #define Rtl8814A_NIC_RESUME_FLOW                                rtl8814A_resume_flow
  67 #define Rtl8814A_NIC_PDN_FLOW                                   rtl8814A_hwpdn_flow
  68 #define Rtl8814A_NIC_LPS_ENTER_FLOW                     rtl8814A_enter_lps_flow
  69 #define Rtl8814A_NIC_LPS_LEAVE_FLOW                     rtl8814A_leave_lps_flow
  70
  71 /* *****************************************************
  72  *                              New     Firmware Header(8-byte alinment required)
  73  * *****************************************************
  74  * --- LONG WORD 0 ---- */
  75 #define GET_FIRMWARE_HDR_SIGNATURE_3081(__FwHdr)                LE_BITS_TO_4BYTE(__FwHdr, 0, 16)
  76 #define GET_FIRMWARE_HDR_CATEGORY_3081(__FwHdr)         LE_BITS_TO_4BYTE(__FwHdr, 16, 8) /* AP/NIC and USB/PCI */
  77 #define GET_FIRMWARE_HDR_FUNCTION_3081(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr, 24, 8) /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
  78 #define GET_FIRMWARE_HDR_VERSION_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)/* FW Version */
  79 #define GET_FIRMWARE_HDR_SUB_VER_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) /* FW Subversion, default 0x00 */
  80 #define GET_FIRMWARE_HDR_SUB_IDX_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8) /* FW Subversion Index */
  81
  82 /* --- LONG WORD 1 ---- */
  83 #define GET_FIRMWARE_HDR_SVN_IDX_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+8, 0, 32)/* The SVN entry index */
  84 #define GET_FIRMWARE_HDR_RSVD1_3081(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+12, 0, 32)
  85
  86 /* --- LONG WORD 2 ---- */
  87 #define GET_FIRMWARE_HDR_MONTH_3081(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+16, 0, 8) /* Release time Month field */
  88 #define GET_FIRMWARE_HDR_DATE_3081(__FwHdr)                             LE_BITS_TO_4BYTE(__FwHdr+16, 8, 8) /* Release time Date field */
  89 #define GET_FIRMWARE_HDR_HOUR_3081(__FwHdr)                             LE_BITS_TO_4BYTE(__FwHdr+16, 16, 8)/* Release time Hour field */
  90 #define GET_FIRMWARE_HDR_MINUTE_3081(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+16, 24, 8)/* Release time Minute field */
  91 #define GET_FIRMWARE_HDR_YEAR_3081(__FwHdr)                             LE_BITS_TO_4BYTE(__FwHdr+20, 0, 16)/* Release time Year field */
  92 #define GET_FIRMWARE_HDR_FOUNDRY_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+20, 16, 8)/* Release time Foundry field */
  93 #define GET_FIRMWARE_HDR_RSVD2_3081(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+20, 24, 8)
  94
  95 /* --- LONG WORD 3 ---- */
  96 #define GET_FIRMWARE_HDR_MEM_UASGE_DL_FROM_3081(__FwHdr)                LE_BITS_TO_4BYTE(__FwHdr+24, 0, 1)
  97 #define GET_FIRMWARE_HDR_MEM_UASGE_BOOT_FROM_3081(__FwHdr)      LE_BITS_TO_4BYTE(__FwHdr+24, 1, 1)
  98 #define GET_FIRMWARE_HDR_MEM_UASGE_BOOT_LOADER_3081(__FwHdr)LE_BITS_TO_4BYTE(__FwHdr+24, 2, 1)
  99 #define GET_FIRMWARE_HDR_MEM_UASGE_IRAM_3081(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+24, 3, 1)
 100 #define GET_FIRMWARE_HDR_MEM_UASGE_ERAM_3081(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+24, 4, 1)
 101 #define GET_FIRMWARE_HDR_MEM_UASGE_RSVD4_3081(__FwHdr)          LE_BITS_TO_4BYTE(__FwHdr+24, 5, 3)
 102 #define GET_FIRMWARE_HDR_RSVD3_3081(__FwHdr)                                    LE_BITS_TO_4BYTE(__FwHdr+24, 8, 8)
 103 #define GET_FIRMWARE_HDR_BOOT_LOADER_SZ_3081(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+24, 16, 16)
 104 #define GET_FIRMWARE_HDR_RSVD5_3081(__FwHdr)                                    LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32)
 105
 106 /* --- LONG WORD 4 ---- */
 107 #define GET_FIRMWARE_HDR_TOTAL_DMEM_SZ_3081(__FwHdr)    LE_BITS_TO_4BYTE(__FwHdr+36, 0, 32)
 108 #define GET_FIRMWARE_HDR_FW_CFG_SZ_3081(__FwHdr)                LE_BITS_TO_4BYTE(__FwHdr+36, 0, 16)
 109 #define GET_FIRMWARE_HDR_FW_ATTR_SZ_3081(__FwHdr)               LE_BITS_TO_4BYTE(__FwHdr+36, 16, 16)
 110
 111 /* --- LONG WORD 5 ---- */
 112 #define GET_FIRMWARE_HDR_IROM_3081(__FwHdr)                             LE_BITS_TO_4BYTE(__FwHdr+40, 0, 32)
 113 #define GET_FIRMWARE_HDR_EROM_3081(__FwHdr)                             LE_BITS_TO_4BYTE(__FwHdr+44, 0, 32)
 114
 115 /* --- LONG WORD 6 ---- */
 116 #define GET_FIRMWARE_HDR_IRAM_SZ_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+48, 0, 32)
 117 #define GET_FIRMWARE_HDR_ERAM_SZ_3081(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+52, 0, 32)
 118
 119 /* --- LONG WORD 7 ---- */
 120 #define GET_FIRMWARE_HDR_RSVD6_3081(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+56, 0, 32)
 121 #define GET_FIRMWARE_HDR_RSVD7_3081(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+60, 0, 32)
 122
 123
 124
 125 /*
 126  * 2013/08/16 MH MOve from SDIO.h for common use.
 127  *   */
 128 #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI)
 129         #define TRX_SHARE_MODE_8814A                            0       /* TRX Buffer Share Index */
 130         #define BASIC_RXFF_SIZE_8814A                           24576/* Basic RXFF Size is 24K = 24*1024 Unit: Byte */
 131         #define TRX_SHARE_BUFF_UNIT_8814A                       65536/* TRX Share Buffer unit Size 64K = 64*1024 Unit: Byte */
 132         #define TRX_SHARE_BUFF_UNIT_PAGE_8814A  (TRX_SHARE_BUFF_UNIT_8814A/PAGE_SIZE_8814A)/* 512 Pages */
 133
 134         /* Origin: */
 135         #define  HPQ_PGNUM_8814A                                        0x20    /* High Queue */
 136         #define  LPQ_PGNUM_8814A                                        0x20    /* Low Queue */
 137         #define  NPQ_PGNUM_8814A                                        0x20    /* Normal Queue */
 138         #define  EPQ_PGNUM_8814A                                        0x20    /* Extra Queue */
 139
 140 #else   /*  #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) */
 141
 142         #define  HPQ_PGNUM_8814A                20
 143         #define  NPQ_PGNUM_8814A                20
 144         #define  LPQ_PGNUM_8814A                20 /* 1972 */
 145         #define  EPQ_PGNUM_8814A                20
 146         #define  BCQ_PGNUM_8814A                32
 147
 148 #endif /* #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) */
 149
 150 #ifdef CONFIG_WOWLAN
 151         #define WOWLAN_PAGE_NUM_8814    0x00
 152 #else
 153         #define WOWLAN_PAGE_NUM_8814    0x00
 154 #endif
 155
 156 #define PAGE_SIZE_8814A                                         128/* TXFF Page Size, Unit: Byte */
 157 #define MAX_RX_DMA_BUFFER_SIZE_8814A            0x5C00  /* BASIC_RXFF_SIZE_8814A + TRX_SHARE_MODE_8814A * TRX_SHARE_BUFF_UNIT_8814A */ /* Basic RXFF Size + ShareBuffer Size */
 158 #define TX_PAGE_BOUNDARY_8814A                  TXPKT_PGNUM_8814A       /* Need to enlarge boundary, by KaiYuan */
 159 #define TX_PAGE_BOUNDARY_WOWLAN_8814A   TXPKT_PGNUM_8814A       /* TODO: 20130415 KaiYuan Check this value later */
 160
 161 #ifdef CONFIG_FW_C2H_DEBUG
 162         #define RX_DMA_RESERVED_SIZE_8814A      0x100   /* 256B, reserved for c2h debug message */
 163 #else
 164         #define RX_DMA_RESERVED_SIZE_8814A      0x0     /* 0B */
 165 #endif
 166 #define RX_DMA_BOUNDARY_8814A           (MAX_RX_DMA_BUFFER_SIZE_8814A - RX_DMA_RESERVED_SIZE_8814A - 1)
 167
 168 #define  TOTAL_PGNUM_8814A              2048
 169 #define  TXPKT_PGNUM_8814A              (2048 - BCNQ_PAGE_NUM_8814-WOWLAN_PAGE_NUM_8814)
 170 #define  PUB_PGNUM_8814A                (TXPKT_PGNUM_8814A-HPQ_PGNUM_8814A-NPQ_PGNUM_8814A-LPQ_PGNUM_8814A-EPQ_PGNUM_8814A)
 171
 172 /* Note: For WMM Normal Chip Setting ,modify later */
 173 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8814A   TX_PAGE_BOUNDARY_8814A
 174 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8814A               (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8814A + 1)
 175
 176 #define DRIVER_EARLY_INT_TIME_8814              0x05
 177 #define BCN_DMA_ATIME_INT_TIME_8814             0x02
 178
 179
 180 #define MAX_PAGE_SIZE                   4096    /* @ page : 4k bytes */
 181
 182 #define EFUSE_MAX_SECTION_JAGUAR                                64
 183
 184 #define HWSET_MAX_SIZE_8814A                    512
 185
 186 #define EFUSE_REAL_CONTENT_LEN_8814A    1024
 187 #define EFUSE_MAX_BANK_8814A            2
 188
 189 #define EFUSE_MAP_LEN_8814A                     512
 190 #define EFUSE_MAX_SECTION_8814A         64
 191 #define EFUSE_MAX_WORD_UNIT_8814A               4
 192 #define EFUSE_PROTECT_BYTES_BANK_8814A          16
 193
 194 #define EFUSE_IC_ID_OFFSET_8814A                506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 195 #define AVAILABLE_EFUSE_ADDR_8814A(addr)        (addr < EFUSE_REAL_CONTENT_LEN_8814A)
 196
 197 /*-------------------------------------------------------------------------
 198 Chip specific
 199 -------------------------------------------------------------------------*/
 200
 201 /* pic buffer descriptor */
 202 #if 1 /* according to the define in the rtw_xmit.h, rtw_recv.h */
 203         #define RTL8814AE_SEG_NUM  TX_BUFFER_SEG_NUM /* 0:2 seg, 1: 4 seg, 2: 8 seg */
 204         #define TX_DESC_NUM_8814A  TXDESC_NUM   /* 128 */
 205         #define RX_DESC_NUM_8814A  PCI_MAX_RX_COUNT /* 128 */
 206         #ifdef CONFIG_CONCURRENT_MODE
 207                 #define BE_QUEUE_TX_DESC_NUM_8814A  (TXDESC_NUM<<1)    /* 256 */
 208         #else
 209                 #define BE_QUEUE_TX_DESC_NUM_8814A  (TXDESC_NUM+(TXDESC_NUM>>1)) /* 192 */
 210         #endif
 211 #else
 212         #define RTL8814AE_SEG_NUM  TX_BUFFER_SEG_NUM /* 0:2 seg, 1: 4 seg, 2: 8 seg */
 213         #define TX_DESC_NUM_8814A  128 /* 1024//2048 change by ylb 20130624 */
 214         #define RX_DESC_NUM_8814A  128 /* 1024 //512 change by ylb 20130624 */
 215 #endif
 216
 217 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section
 218  * 9bytes + 1byt + 5bytes and pre 1byte.
 219  * For worst case:
 220  * | 1byte|----8bytes----|1byte|--5bytes--|
 221  * |         |            Reserved(14bytes)           |
 222  *   */
 223 #define EFUSE_OOB_PROTECT_BYTES         15      /* PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. */
 224
 225 /* rtl8814_hal_init.c */
 226 s32 FirmwareDownload8814A(PADAPTER      Adapter, BOOLEAN bUsedWoWLANFw);
 227 void    InitializeFirmwareVars8814(PADAPTER padapter);
 228
 229 VOID
 230 Hal_InitEfuseVars_8814A(
 231         IN      PADAPTER        Adapter
 232 );
 233
 234 s32 InitLLTTable8814A(
 235         IN      PADAPTER        Adapter
 236 );
 237
 238
 239 void InitRDGSetting8814A(PADAPTER padapter);
 240
 241 /* void CheckAutoloadState8812A(PADAPTER padapter); */
 242
 243 /* EFuse */
 244 u8      GetEEPROMSize8814A(PADAPTER padapter);
 245 VOID hal_InitPGData_8814A(
 246  IN PADAPTER  padapter,
 247  IN OUT u8   *PROMContent
 248 );
 249
 250 void    hal_ReadPROMVersion8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 251 void    hal_ReadTxPowerInfo8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 252 void    hal_ReadBoardType8814A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 253 void    hal_ReadThermalMeter_8814A(PADAPTER     Adapter, u8 *PROMContent, BOOLEAN       AutoloadFail);
 254 void    hal_ReadChannelPlan8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 255 void    hal_EfuseParseXtal_8814A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 256 void    hal_ReadAntennaDiversity8814A(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
 257 void    hal_Read_TRX_antenna_8814A(PADAPTER     Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 258 VOID hal_ReadAmplifierType_8814A(
 259         IN      PADAPTER                Adapter
 260 );
 261 VOID hal_ReadPAType_8814A(
 262         IN      PADAPTER        Adapter,
 263         IN      u8                      *PROMContent,
 264         IN      BOOLEAN         AutoloadFail,
 265         OUT u8          *pPAType,
 266         OUT u8          *pLNAType
 267 );
 268
 269 void hal_ReadPowerTrackingType_8814A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 270
 271 void hal_GetRxGainOffset_8814A(
 272         PADAPTER        Adapter,
 273         pu1Byte         PROMContent,
 274         BOOLEAN         AutoloadFail
 275 );
 276 void Hal_EfuseParseKFreeData_8814A(
 277         IN              PADAPTER                Adapter,
 278         IN              u8                              *PROMContent,
 279         IN              BOOLEAN                 AutoloadFail);
 280 void    hal_ReadRFEType_8814A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 281 void    hal_EfuseParseBTCoexistInfo8814A(PADAPTER Adapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 282
 283 /* void hal_ReadUsbType_8812AU(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 284  * int  FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); */
 285 void    hal_ReadRemoteWakeup_8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 286 u8      MgntQuery_NssTxRate(u16 Rate);
 287
 288 /* BOOLEAN HalDetectPwrDownMode8812(PADAPTER Adapter); */
 289
 290 #ifdef CONFIG_WOWLAN
 291         void Hal_DetectWoWMode(PADAPTER pAdapter);
 292 #endif /* CONFIG_WOWLAN */
 293
 294 void _InitBeaconParameters_8814A(PADAPTER padapter);
 295 void SetBeaconRelatedRegisters8814A(PADAPTER padapter);
 296
 297 void ReadRFType8814A(PADAPTER padapter);
 298 void InitDefaultValue8814A(PADAPTER padapter);
 299
 300 void SetHwReg8814A(PADAPTER padapter, u8 variable, u8 *pval);
 301 void GetHwReg8814A(PADAPTER padapter, u8 variable, u8 *pval);
 302 u8 SetHalDefVar8814A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 303 u8 GetHalDefVar8814A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 304 void rtl8814_set_hal_ops(struct hal_ops *pHalFunc);
 305 void init_hal_spec_8814a(_adapter *adapter);
 306
 307 /* register */
 308 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);
 309 void SetBcnCtrlReg(PADAPTER     Adapter, u8     SetBits, u8     ClearBits);
 310 void rtl8814_start_thread(PADAPTER padapter);
 311 void rtl8814_stop_thread(PADAPTER padapter);
 312
 313
 314 #ifdef CONFIG_PCI_HCI
 315         BOOLEAN InterruptRecognized8814AE(PADAPTER Adapter);
 316         VOID    UpdateInterruptMask8814AE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
 317         u16     get_txbd_idx_addr(u16 ff_hwaddr);
 318 #endif
 319
 320 #ifdef CONFIG_BT_COEXIST
 321         void rtl8812a_combo_card_WifiOnlyHwInit(PADAPTER Adapter);
 322 #endif
 323
 324 #endif /* __RTL8188E_HAL_H__ */