1 /******************************************************************************
\r
3 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
\r
5 * This program is free software; you can redistribute it and/or modify it
\r
6 * under the terms of version 2 of the GNU General Public License as
\r
7 * published by the Free Software Foundation.
\r
9 * This program is distributed in the hope that it will be useful, but WITHOUT
\r
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
14 * You should have received a copy of the GNU General Public License along with
\r
15 * this program; if not, write to the Free Software Foundation, Inc.,
\r
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
\r
19 ******************************************************************************/
\r
20 #ifndef __RTL8723A_HAL_H__
\r
21 #define __RTL8723A_HAL_H__
\r
24 //#include "hal_com.h"
\r
26 #include "hal_data.h"
\r
28 #include "../hal/OUTSRC/odm_precomp.h"
\r
31 #include "rtl8723a_spec.h"
\r
32 #include "rtl8723a_pg.h"
\r
33 #include "Hal8723APhyReg.h"
\r
34 #include "Hal8723APhyCfg.h"
\r
35 #include "rtl8723a_rf.h"
\r
36 #include "rtl8723a_dm.h"
\r
37 #include "rtl8723a_recv.h"
\r
38 #include "rtl8723a_xmit.h"
\r
39 #include "rtl8723a_cmd.h"
\r
40 #include "rtl8723a_led.h"
\r
41 #include "Hal8723PwrSeq.h"
\r
42 #ifdef DBG_CONFIG_ERROR_DETECT
\r
43 #include "rtl8723a_sreset.h"
\r
47 #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_GSPI_HCI)
\r
49 //2TODO: We should define 8192S firmware related macro settings here!!
\r
50 #define RTL819X_DEFAULT_RF_TYPE RF_1T2R
\r
51 #define RTL819X_TOTAL_RF_PATH 2
\r
53 //---------------------------------------------------------------------
\r
54 // RTL8723S From file
\r
55 //---------------------------------------------------------------------
\r
56 #define RTL8723_FW_UMC_IMG "rtl8723S\\rtl8723fw.bin"
\r
57 #define RTL8723_FW_UMC_B_IMG "rtl8723S\\rtl8723fw_B.bin"
\r
58 #define RTL8723_PHY_REG "rtl8723S\\PHY_REG_1T.txt"
\r
59 #define RTL8723_PHY_RADIO_A "rtl8723S\\radio_a_1T.txt"
\r
60 #define RTL8723_PHY_RADIO_B "rtl8723S\\radio_b_1T.txt"
\r
61 #define RTL8723_AGC_TAB "rtl8723S\\AGC_TAB_1T.txt"
\r
62 #define RTL8723_PHY_MACREG "rtl8723S\\MAC_REG.txt"
\r
63 #define RTL8723_PHY_REG_PG "rtl8723S\\PHY_REG_PG.txt"
\r
64 #define RTL8723_PHY_REG_MP "rtl8723S\\PHY_REG_MP.txt"
\r
66 //---------------------------------------------------------------------
\r
67 // RTL8723S From header
\r
68 //---------------------------------------------------------------------
\r
71 #define Rtl8723_FwImageArray Rtl8723SFwImgArray
\r
72 #define Rtl8723_FwUMCBCutImageArrayWithBT Rtl8723SFwUMCBCutImgArrayWithBT
\r
73 #define Rtl8723_FwUMCBCutImageArrayWithoutBT Rtl8723SFwUMCBCutImgArrayWithoutBT
\r
75 #define Rtl8723_ImgArrayLength Rtl8723SImgArrayLength
\r
76 #define Rtl8723_UMCBCutImgArrayWithBTLength Rtl8723SUMCBCutImgArrayWithBTLength
\r
77 #define Rtl8723_UMCBCutImgArrayWithoutBTLength Rtl8723SUMCBCutImgArrayWithoutBTLength
\r
79 #define Rtl8723_PHY_REG_Array_PG Rtl8723SPHY_REG_Array_PG
\r
80 #define Rtl8723_PHY_REG_Array_PGLength Rtl8723SPHY_REG_Array_PGLength
\r
82 #define Rtl8723E_FwBTImgArray Rtl8723EFwBTImgArray
\r
83 #define Rtl8723E_FwBTImgArrayLength Rtl8723EBTImgArrayLength
\r
85 #define Rtl8723_FwUMCBCutMPImageArray Rtl8723SFwUMCBCutMPImgArray
\r
86 #define Rtl8723_UMCBCutMPImgArrayLength Rtl8723SUMCBCutMPImgArrayLength
\r
88 #define Rtl8723_PHY_REG_Array_MP Rtl8723SPHY_REG_Array_MP
\r
89 #define Rtl8723_PHY_REG_Array_MPLength Rtl8723SPHY_REG_Array_MPLength
\r
92 #endif // CONFIG_SDIO_HCI
\r
94 #ifdef CONFIG_USB_HCI
\r
96 //2TODO: We should define 8192S firmware related macro settings here!!
\r
97 #define RTL819X_DEFAULT_RF_TYPE RF_1T2R
\r
98 #define RTL819X_TOTAL_RF_PATH 2
\r
100 //TODO: The following need to check!!
\r
101 #define RTL8723_FW_UMC_IMG "rtl8192CU\\rtl8723fw.bin"
\r
102 #define RTL8723_FW_UMC_B_IMG "rtl8192CU\\rtl8723fw_B.bin"
\r
103 #define RTL8723_PHY_REG "rtl8723S\\PHY_REG_1T.txt"
\r
104 #define RTL8723_PHY_RADIO_A "rtl8723S\\radio_a_1T.txt"
\r
105 #define RTL8723_PHY_RADIO_B "rtl8723S\\radio_b_1T.txt"
\r
106 #define RTL8723_AGC_TAB "rtl8723S\\AGC_TAB_1T.txt"
\r
107 #define RTL8723_PHY_MACREG "rtl8723S\\MAC_REG.txt"
\r
108 #define RTL8723_PHY_REG_PG "rtl8723S\\PHY_REG_PG.txt"
\r
109 #define RTL8723_PHY_REG_MP "rtl8723S\\PHY_REG_MP.txt"
\r
111 //---------------------------------------------------------------------
\r
112 // RTL8723S From header
\r
113 //---------------------------------------------------------------------
\r
116 #define Rtl8723_FwImageArray Rtl8723UFwImgArray
\r
117 #define Rtl8723_FwUMCBCutImageArrayWithBT Rtl8723UFwUMCBCutImgArrayWithBT
\r
118 #define Rtl8723_FwUMCBCutImageArrayWithoutBT Rtl8723UFwUMCBCutImgArrayWithoutBT
\r
120 #define Rtl8723_ImgArrayLength Rtl8723UImgArrayLength
\r
121 #define Rtl8723_UMCBCutImgArrayWithBTLength Rtl8723UUMCBCutImgArrayWithBTLength
\r
122 #define Rtl8723_UMCBCutImgArrayWithoutBTLength Rtl8723UUMCBCutImgArrayWithoutBTLength
\r
124 #define Rtl8723_PHY_REG_Array_PG Rtl8723UPHY_REG_Array_PG
\r
125 #define Rtl8723_PHY_REG_Array_PGLength Rtl8723UPHY_REG_Array_PGLength
\r
128 #define Rtl8723E_FwBTImgArray Rtl8723EFwBTImgArray
\r
129 #define Rtl8723E_FwBTImgArrayLength Rtl8723EBTImgArrayLength
\r
131 #define Rtl8723_FwUMCBCutMPImageArray Rtl8723SFwUMCBCutMPImgArray
\r
132 #define Rtl8723_UMCBCutMPImgArrayLength Rtl8723SUMCBCutMPImgArrayLength
\r
134 #define Rtl8723_PHY_REG_Array_MP Rtl8723UPHY_REG_Array_MP
\r
135 #define Rtl8723_PHY_REG_Array_MPLength Rtl8723UPHY_REG_Array_MPLength
\r
140 #define FW_8723A_SIZE 0x8000
\r
141 #define FW_8723A_START_ADDRESS 0x1000
\r
142 #define FW_8723A_END_ADDRESS 0x1FFF //0x5FFF
\r
145 #define IS_FW_HEADER_EXIST_8723A(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x92C0 ||\
\r
146 (le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x88C0 ||\
\r
147 (le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x2300)
\r
150 typedef struct _RT_FIRMWARE_8723A {
\r
151 FIRMWARE_SOURCE eFWSource;
\r
152 #ifdef CONFIG_EMBEDDED_FWIMG
\r
155 u8 szFwBuffer[FW_8723A_SIZE];
\r
159 #ifdef CONFIG_EMBEDDED_FWIMG
\r
162 u8 szBTFwBuffer[FW_8723A_SIZE];
\r
165 } RT_FIRMWARE_8723A, *PRT_FIRMWARE_8723A;
\r
168 // This structure must be cared byte-ordering
\r
170 // Added by tynli. 2009.12.04.
\r
171 typedef struct _RT_8723A_FIRMWARE_HDR
\r
173 // 8-byte alinment required
\r
175 //--- LONG WORD 0 ----
\r
176 u16 Signature; // 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut
\r
177 u8 Category; // AP/NIC and USB/PCI
\r
178 u8 Function; // Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions
\r
179 u16 Version; // FW Version
\r
180 u8 Subversion; // FW Subversion, default 0x00
\r
184 //--- LONG WORD 1 ----
\r
185 u8 Month; // Release time Month field
\r
186 u8 Date; // Release time Date field
\r
187 u8 Hour; // Release time Hour field
\r
188 u8 Minute; // Release time Minute field
\r
189 u16 RamCodeSize; // The size of RAM code
\r
192 //--- LONG WORD 2 ----
\r
193 u32 SvnIdx; // The SVN entry index
\r
196 //--- LONG WORD 3 ----
\r
199 }RT_8723A_FIRMWARE_HDR, *PRT_8723A_FIRMWARE_HDR;
\r
201 #define DRIVER_EARLY_INT_TIME_8723A 0x05
\r
202 #define BCN_DMA_ATIME_INT_TIME_8723A 0x02
\r
204 //For General Reserved Page Number(Beacon Queue is reserved page)
\r
205 //Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1
\r
206 #define BCNQ_PAGE_NUM_8723A 0x08
\r
208 #define TX_TOTAL_PAGE_NUMBER_8723A (0xFF - BCNQ_PAGE_NUM_8723A)
\r
209 #define TX_PAGE_BOUNDARY_8723A (TX_TOTAL_PAGE_NUMBER_8723A + 1)
\r
211 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723A TX_TOTAL_PAGE_NUMBER_8723A
\r
212 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723A (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723A + 1)
\r
214 // For Normal Chip Setting
\r
215 // (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723A
\r
216 #define NORMAL_PAGE_NUM_HPQ_8723A 0x0C
\r
217 #define NORMAL_PAGE_NUM_LPQ_8723A 0x02
\r
218 #define NORMAL_PAGE_NUM_NPQ_8723A 0x02
\r
220 // Note: For Normal Chip Setting, modify later
\r
221 #define WMM_NORMAL_PAGE_NUM_HPQ_8723A 0x29
\r
222 #define WMM_NORMAL_PAGE_NUM_LPQ_8723A 0x1C
\r
223 #define WMM_NORMAL_PAGE_NUM_NPQ_8723A 0x1C
\r
226 //-------------------------------------------------------------------------
\r
228 //-------------------------------------------------------------------------
\r
229 #define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22)&0x3)
\r
230 #define CHIP_BONDING_92C_1T2R 0x1
\r
231 #define CHIP_BONDING_88C_USB_MCARD 0x2
\r
232 #define CHIP_BONDING_88C_USB_HP 0x1
\r
234 //-------------------------------------------------------------------------
\r
236 //-------------------------------------------------------------------------
\r
239 #define HAL_EFUSE_MEMORY
\r
241 #define EFUSE_REAL_CONTENT_LEN 512
\r
242 #define EFUSE_MAP_LEN 128
\r
243 #define EFUSE_MAX_SECTION 16
\r
244 #define EFUSE_IC_ID_OFFSET 506 //For some inferiority IC purpose. added by Roger, 2009.09.02.
\r
245 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN)
\r
248 // To prevent out of boundary programming case,
\r
249 // leave 1byte and program full section
\r
250 // 9bytes + 1byt + 5bytes and pre 1byte.
\r
252 // | 1byte|----8bytes----|1byte|--5bytes--|
\r
253 // | | Reserved(14bytes) |
\r
256 // PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte.
\r
257 #define EFUSE_OOB_PROTECT_BYTES 15
\r
259 #define EFUSE_REAL_CONTENT_LEN_8723A 512
\r
260 #define EFUSE_MAP_LEN_8723A 256
\r
261 #define EFUSE_MAX_SECTION_8723A 32
\r
263 //========================================================
\r
264 // EFUSE for BT definition
\r
265 //========================================================
\r
266 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512
\r
267 #define EFUSE_BT_REAL_CONTENT_LEN 1536 // 512*3
\r
268 #define EFUSE_BT_MAP_LEN 1024 // 1k bytes
\r
269 #define EFUSE_BT_MAX_SECTION 128 // 1024/8
\r
271 #define EFUSE_PROTECT_BYTES_BANK 16
\r
274 // Description: Determine the types of C2H events that are the same in driver and Fw.
\r
275 // Fisrt constructed by tynli. 2009.10.09.
\r
276 typedef enum _RTL8192C_C2H_EVT
\r
280 C2H_AP_RPT_RSP = 2,
\r
281 C2H_CCX_TX_RPT = 3, // The FW notify the report of the specific tx packet.
\r
283 C2H_BT_OP_MODE = 5,
\r
284 C2H_EXT_RA_RPT = 6,
\r
285 C2H_HW_INFO_EXCH = 10,
\r
286 C2H_C2H_H2C_TEST = 11,
\r
288 C2H_BT_MP_INFO = 15,
\r
290 } RTL8192C_C2H_EVT;
\r
293 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
\r
294 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
\r
296 typedef struct rxreport_8723a
\r
346 u32 pattern0match:1;
\r
347 u32 pattern1match:1;
\r
348 u32 pattern2match:1;
\r
349 u32 pattern3match:1;
\r
350 u32 pattern4match:1;
\r
351 u32 pattern5match:1;
\r
352 u32 pattern6match:1;
\r
353 u32 pattern7match:1;
\r
354 u32 pattern8match:1;
\r
355 u32 pattern9match:1;
\r
356 u32 patternamatch:1;
\r
357 u32 patternbmatch:1;
\r
358 u32 patterncmatch:1;
\r
366 } RXREPORT, *PRXREPORT;
\r
368 typedef struct phystatus_8723a
\r
381 u32 noisepwrdb_h:8;
\r
392 u32 noisepwrdb_l:8;
\r
411 } PHYSTATUS, *PPHYSTATUS;
\r
414 // rtl8723a_hal_init.c
\r
415 s32 rtl8723a_FirmwareDownload(PADAPTER padapter);
\r
416 void rtl8723a_FirmwareSelfReset(PADAPTER padapter);
\r
417 void rtl8723a_InitializeFirmwareVars(PADAPTER padapter);
\r
419 void rtl8723a_InitAntenna_Selection(PADAPTER padapter);
\r
420 void rtl8723a_DeinitAntenna_Selection(PADAPTER padapter);
\r
421 void rtl8723a_CheckAntenna_Selection(PADAPTER padapter);
\r
422 void rtl8723a_init_default_value(PADAPTER padapter);
\r
424 s32 InitLLTTable(PADAPTER padapter, u32 boundary);
\r
426 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
\r
427 s32 CardDisableWithoutHWSM(PADAPTER padapter);
\r
430 u8 GetEEPROMSize8723A(PADAPTER padapter);
\r
431 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
\r
432 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
\r
433 void Hal_EfuseParseTxPowerInfo_8723A(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
\r
434 void Hal_EfuseParseBTCoexistInfo_8723A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
\r
435 void Hal_EfuseParseEEPROMVer(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
\r
436 void rtl8723a_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
\r
437 void Hal_EfuseParseCustomerID(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
\r
438 void Hal_EfuseParseAntennaDiversity(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
\r
439 void Hal_EfuseParseRateIndicationOption(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
\r
440 void Hal_EfuseParseXtal_8723A(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);
\r
441 void Hal_EfuseParseThermalMeter_8723A(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);
\r
443 //RT_CHANNEL_DOMAIN rtl8723a_HalMapChannelPlan(PADAPTER padapter, u8 HalChannelPlan);
\r
444 //VERSION_8192C rtl8723a_ReadChipVersion(PADAPTER padapter);
\r
445 //void rtl8723a_ReadBluetoothCoexistInfo(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoloadFail);
\r
446 void Hal_InitChannelPlan(PADAPTER padapter);
\r
448 void rtl8723a_set_hal_ops(struct hal_ops *pHalFunc);
\r
449 void SetHwReg8723A(PADAPTER padapter, u8 variable, u8 *val);
\r
450 void GetHwReg8723A(PADAPTER padapter, u8 variable, u8 *val);
\r
451 #ifdef CONFIG_BT_COEXIST
\r
452 void rtl8723a_SingleDualAntennaDetection(PADAPTER padapter);
\r
454 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
\r
457 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);
\r
458 void rtl8723a_InitBeaconParameters(PADAPTER padapter);
\r
459 void rtl8723a_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
\r
461 void rtl8723a_start_thread(_adapter *padapter);
\r
462 void rtl8723a_stop_thread(_adapter *padapter);
\r
464 s32 c2h_id_filter_ccx_8723a(u8 *buf);
\r
465 void _InitTransferPageSize(PADAPTER padapter);
\r
466 #endif// __RTL8723A_HAL_H__
\r