1 /******************************************************************************
3 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
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.
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
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
19 ******************************************************************************/
20 #ifndef __RTL8723B_HAL_H__
21 #define __RTL8723B_HAL_H__
25 #include "rtl8723b_spec.h"
26 #include "rtl8723b_rf.h"
27 #include "rtl8723b_dm.h"
28 #include "rtl8723b_recv.h"
29 #include "rtl8723b_xmit.h"
30 #include "rtl8723b_cmd.h"
31 #include "rtl8723b_led.h"
32 #include "Hal8723BPwrSeq.h"
33 #include "Hal8723BPhyReg.h"
34 #include "Hal8723BPhyCfg.h"
35 #ifdef DBG_CONFIG_ERROR_DETECT
36 #include "rtl8723b_sreset.h"
39 #define FW_8723B_SIZE 0x8000
40 #define FW_8723B_START_ADDRESS 0x1000
41 #define FW_8723B_END_ADDRESS 0x1FFF /* 0x5FFF */
43 #define IS_FW_HEADER_EXIST_8723B(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x5300)
45 typedef struct _RT_FIRMWARE {
46 FIRMWARE_SOURCE eFWSource;
47 #ifdef CONFIG_EMBEDDED_FWIMG
50 u8 szFwBuffer[FW_8723B_SIZE];
53 } RT_FIRMWARE_8723B, *PRT_FIRMWARE_8723B;
56 * This structure must be cared byte-ordering
58 * Added by tynli. 2009.12.04. */
59 typedef struct _RT_8723B_FIRMWARE_HDR {
60 /* 8-byte alinment required */
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 */
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 */
77 /* --- LONG WORD 2 ---- */
78 u32 SvnIdx; /* The SVN entry index */
81 /* --- LONG WORD 3 ---- */
84 } RT_8723B_FIRMWARE_HDR, *PRT_8723B_FIRMWARE_HDR;
86 #define DRIVER_EARLY_INT_TIME_8723B 0x05
87 #define BCN_DMA_ATIME_INT_TIME_8723B 0x02
90 * TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
91 #define PAGE_SIZE_TX_8723B 128
92 #define PAGE_SIZE_RX_8723B 8
94 #define TX_DMA_SIZE_8723B 0x8000 /* 32K(TX) */
95 #define RX_DMA_SIZE_8723B 0x4000 /* 16K(RX) */
98 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/
103 #ifdef CONFIG_FW_C2H_DEBUG
104 #define RX_DMA_RESERVED_SIZE_8723B 0x100 /* 256B, reserved for c2h debug message */
106 #define RX_DMA_RESERVED_SIZE_8723B 0x80 /* 128B, reserved for tx report */
108 #define RX_DMA_BOUNDARY_8723B (RX_DMA_SIZE_8723B - RX_DMA_RESERVED_SIZE_8723B - 1)
111 /* Note: We will divide number of page equally for each queue other than public queue! */
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_8723B 0x08
116 #ifdef CONFIG_CONCURRENT_MODE
117 #define BCNQ1_PAGE_NUM_8723B 0x08 /* 0x04 */
119 #define BCNQ1_PAGE_NUM_8723B 0x00
122 #ifdef CONFIG_PNO_SUPPORT
123 #undef BCNQ1_PAGE_NUM_8723B
124 #define BCNQ1_PAGE_NUM_8723B 0x00 /* 0x04 */
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 */
130 #define WOWLAN_PAGE_NUM_8723B 0x08
132 #define WOWLAN_PAGE_NUM_8723B 0x00
135 #ifdef CONFIG_PNO_SUPPORT
136 #undef WOWLAN_PAGE_NUM_8723B
137 #define WOWLAN_PAGE_NUM_8723B 0x15
140 #ifdef CONFIG_AP_WOWLAN
141 #define AP_WOWLAN_PAGE_NUM_8723B 0x02
144 #define TX_TOTAL_PAGE_NUMBER_8723B (0xFF - BCNQ_PAGE_NUM_8723B - BCNQ1_PAGE_NUM_8723B - WOWLAN_PAGE_NUM_8723B)
145 #define TX_PAGE_BOUNDARY_8723B (TX_TOTAL_PAGE_NUMBER_8723B + 1)
147 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B TX_TOTAL_PAGE_NUMBER_8723B
148 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723B (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B + 1)
150 /* For Normal Chip Setting
151 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */
152 #define NORMAL_PAGE_NUM_HPQ_8723B 0x0C
153 #define NORMAL_PAGE_NUM_LPQ_8723B 0x02
154 #define NORMAL_PAGE_NUM_NPQ_8723B 0x02
156 /* Note: For Normal Chip Setting, modify later */
157 #define WMM_NORMAL_PAGE_NUM_HPQ_8723B 0x30
158 #define WMM_NORMAL_PAGE_NUM_LPQ_8723B 0x20
159 #define WMM_NORMAL_PAGE_NUM_NPQ_8723B 0x20
162 #include "HalVerDef.h"
165 #define EFUSE_OOB_PROTECT_BYTES 15
167 #define HAL_EFUSE_MEMORY
169 #define HWSET_MAX_SIZE_8723B 512
170 #define EFUSE_REAL_CONTENT_LEN_8723B 512
171 #define EFUSE_MAP_LEN_8723B 512
172 #define EFUSE_MAX_SECTION_8723B 64
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_8723B)
177 #define EFUSE_ACCESS_ON 0x69 /* For RTL8723 only. */
178 #define EFUSE_ACCESS_OFF 0x00 /* For RTL8723 only. */
180 /* ********************************************************
181 * EFUSE for BT definition
182 * ******************************************************** */
183 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512
184 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */
185 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */
186 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */
188 #define EFUSE_PROTECT_BYTES_BANK 16
190 typedef enum tag_Package_Definition {
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)
201 /* rtl8723a_hal_init.c */
202 s32 rtl8723b_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw);
203 void rtl8723b_FirmwareSelfReset(PADAPTER padapter);
204 void rtl8723b_InitializeFirmwareVars(PADAPTER padapter);
206 void rtl8723b_InitAntenna_Selection(PADAPTER padapter);
207 void rtl8723b_DeinitAntenna_Selection(PADAPTER padapter);
208 void rtl8723b_CheckAntenna_Selection(PADAPTER padapter);
209 void rtl8723b_init_default_value(PADAPTER padapter);
211 s32 rtl8723b_InitLLTTable(PADAPTER padapter);
213 s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
214 s32 CardDisableWithoutHWSM(PADAPTER padapter);
217 u8 GetEEPROMSize8723B(PADAPTER padapter);
218 void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
219 void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
220 void Hal_EfuseParseTxPowerInfo_8723B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
221 void Hal_EfuseParseBTCoexistInfo_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
222 void Hal_EfuseParseEEPROMVer_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
223 void Hal_EfuseParseChnlPlan_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
224 void Hal_EfuseParseCustomerID_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
225 void Hal_EfuseParseAntennaDiversity_8723B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
226 void Hal_EfuseParseXtal_8723B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);
227 void Hal_EfuseParseThermalMeter_8723B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);
228 VOID Hal_EfuseParsePackageType_8723B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
229 VOID Hal_EfuseParseVoltage_8723B(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
230 VOID Hal_EfuseParseBoardType_8723B(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
232 void rtl8723b_set_hal_ops(struct hal_ops *pHalFunc);
233 void init_hal_spec_8723b(_adapter *adapter);
234 void SetHwReg8723B(PADAPTER padapter, u8 variable, u8 *val);
235 void GetHwReg8723B(PADAPTER padapter, u8 variable, u8 *val);
236 u8 SetHalDefVar8723B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
237 u8 GetHalDefVar8723B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
240 void rtl8723b_InitBeaconParameters(PADAPTER padapter);
241 void rtl8723b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
242 void _InitBurstPktLen_8723BS(PADAPTER Adapter);
243 void _8051Reset8723(PADAPTER padapter);
244 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
245 void Hal_DetectWoWMode(PADAPTER pAdapter);
246 #endif /* CONFIG_WOWLAN */
248 void rtl8723b_start_thread(_adapter *padapter);
249 void rtl8723b_stop_thread(_adapter *padapter);
251 #if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
252 void rtl8723bs_init_checkbthang_workqueue(_adapter *adapter);
253 void rtl8723bs_free_checkbthang_workqueue(_adapter *adapter);
254 void rtl8723bs_cancle_checkbthang_workqueue(_adapter *adapter);
255 void rtl8723bs_hal_check_bt_hang(_adapter *adapter);
258 #ifdef CONFIG_GPIO_WAKEUP
259 void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);
261 #ifdef CONFIG_MP_INCLUDED
262 int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
264 void CCX_FwC2HTxRpt_8723b(PADAPTER padapter, u8 *pdata, u8 len);
266 u8 MRateToHwRate8723B(u8 rate);
267 u8 HwRateToMRate8723B(u8 rate);
269 #ifdef CONFIG_RF_POWER_TRIM
270 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
271 #endif /*CONFIG_RF_POWER_TRIM*/
273 #ifdef CONFIG_PCI_HCI
274 BOOLEAN InterruptRecognized8723BE(PADAPTER Adapter);
275 VOID UpdateInterruptMask8723BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
278 #ifdef CONFIG_GPIO_API
279 int rtl8723b_GpioFuncCheck(PADAPTER adapter, u8 gpio_num);
280 VOID rtl8723b_GpioMultiFuncReset(PADAPTER adapter, u8 gpio_num);