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 ******************************************************************************/
15 #ifndef __RTL8723B_HAL_H__
16 #define __RTL8723B_HAL_H__
20 #include "rtl8723b_spec.h"
21 #include "rtl8723b_rf.h"
22 #include "rtl8723b_dm.h"
23 #include "rtl8723b_recv.h"
24 #include "rtl8723b_xmit.h"
25 #include "rtl8723b_cmd.h"
27 #include "Hal8723BPwrSeq.h"
28 #include "Hal8723BPhyReg.h"
29 #include "Hal8723BPhyCfg.h"
32 /* RTL8723B From file */
34 #define RTL8723B_FW_IMG "/*(DEBLOBBED)*/"
35 #define RTL8723B_FW_WW_IMG "/*(DEBLOBBED)*/"
36 #define RTL8723B_PHY_REG "rtl8723b/PHY_REG.txt"
37 #define RTL8723B_PHY_RADIO_A "rtl8723b/RadioA.txt"
38 #define RTL8723B_PHY_RADIO_B "rtl8723b/RadioB.txt"
39 #define RTL8723B_TXPWR_TRACK "rtl8723b/TxPowerTrack.txt"
40 #define RTL8723B_AGC_TAB "rtl8723b/AGC_TAB.txt"
41 #define RTL8723B_PHY_MACREG "rtl8723b/MAC_REG.txt"
42 #define RTL8723B_PHY_REG_PG "rtl8723b/PHY_REG_PG.txt"
43 #define RTL8723B_PHY_REG_MP "rtl8723b/PHY_REG_MP.txt"
44 #define RTL8723B_TXPWR_LMT "rtl8723b/TXPWR_LMT.txt"
47 /* RTL8723B From header */
50 #define FW_8723B_SIZE 0x8000
51 #define FW_8723B_START_ADDRESS 0x1000
52 #define FW_8723B_END_ADDRESS 0x1FFF /* 0x5FFF */
54 #define IS_FW_HEADER_EXIST_8723B(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x5300)
61 /* This structure must be cared byte-ordering */
62 struct rt_firmware_hdr {
63 /* 8-byte alinment required */
65 /* LONG WORD 0 ---- */
66 __le16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
67 u8 Category; /* AP/NIC and USB/PCI */
68 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
69 __le16 Version; /* FW Version */
70 __le16 Subversion; /* FW Subversion, default 0x00 */
72 /* LONG WORD 1 ---- */
73 u8 Month; /* Release time Month field */
74 u8 Date; /* Release time Date field */
75 u8 Hour; /* Release time Hour field */
76 u8 Minute; /* Release time Minute field */
77 __le16 RamCodeSize; /* The size of RAM code */
80 /* LONG WORD 2 ---- */
81 __le32 SvnIdx; /* The SVN entry index */
84 /* LONG WORD 3 ---- */
89 #define DRIVER_EARLY_INT_TIME_8723B 0x05
90 #define BCN_DMA_ATIME_INT_TIME_8723B 0x02
93 /* TX 32K, RX 16K, Page size 128B for TX, 8B for RX */
94 #define PAGE_SIZE_TX_8723B 128
95 #define PAGE_SIZE_RX_8723B 8
97 #define RX_DMA_SIZE_8723B 0x4000 /* 16K */
98 #define RX_DMA_RESERVED_SIZE_8723B 0x80 /* 128B, reserved for tx report */
99 #define RX_DMA_BOUNDARY_8723B (RX_DMA_SIZE_8723B - RX_DMA_RESERVED_SIZE_8723B - 1)
102 /* Note: We will divide number of page equally for each queue other than public queue! */
104 /* For General Reserved Page Number(Beacon Queue is reserved page) */
105 /* Beacon:2, PS-Poll:1, Null Data:1, Qos Null Data:1, BT Qos Null Data:1 */
106 #define BCNQ_PAGE_NUM_8723B 0x08
107 #define BCNQ1_PAGE_NUM_8723B 0x00
109 #ifdef CONFIG_PNO_SUPPORT
110 #undef BCNQ1_PAGE_NUM_8723B
111 #define BCNQ1_PAGE_NUM_8723B 0x00 /* 0x04 */
113 #define MAX_RX_DMA_BUFFER_SIZE_8723B 0x2800 /* RX 10K */
115 /* For WoWLan , more reserved page */
116 /* ARP Rsp:1, RWC:1, GTK Info:1, GTK RSP:2, GTK EXT MEM:2, PNO: 6 */
118 #define WOWLAN_PAGE_NUM_8723B 0x07
120 #define WOWLAN_PAGE_NUM_8723B 0x00
123 #ifdef CONFIG_PNO_SUPPORT
124 #undef WOWLAN_PAGE_NUM_8723B
125 #define WOWLAN_PAGE_NUM_8723B 0x0d
128 #ifdef CONFIG_AP_WOWLAN
129 #define AP_WOWLAN_PAGE_NUM_8723B 0x02
132 #define TX_TOTAL_PAGE_NUMBER_8723B (0xFF - BCNQ_PAGE_NUM_8723B - BCNQ1_PAGE_NUM_8723B - WOWLAN_PAGE_NUM_8723B)
133 #define TX_PAGE_BOUNDARY_8723B (TX_TOTAL_PAGE_NUMBER_8723B + 1)
135 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B TX_TOTAL_PAGE_NUMBER_8723B
136 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723B (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B + 1)
138 /* For Normal Chip Setting */
139 /* (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */
140 #define NORMAL_PAGE_NUM_HPQ_8723B 0x0C
141 #define NORMAL_PAGE_NUM_LPQ_8723B 0x02
142 #define NORMAL_PAGE_NUM_NPQ_8723B 0x02
144 /* Note: For Normal Chip Setting, modify later */
145 #define WMM_NORMAL_PAGE_NUM_HPQ_8723B 0x30
146 #define WMM_NORMAL_PAGE_NUM_LPQ_8723B 0x20
147 #define WMM_NORMAL_PAGE_NUM_NPQ_8723B 0x20
150 #include "HalVerDef.h"
153 #define EFUSE_OOB_PROTECT_BYTES 15
155 #define HAL_EFUSE_MEMORY
157 #define HWSET_MAX_SIZE_8723B 512
158 #define EFUSE_REAL_CONTENT_LEN_8723B 512
159 #define EFUSE_MAP_LEN_8723B 512
160 #define EFUSE_MAX_SECTION_8723B 64
162 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
163 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8723B)
165 #define EFUSE_ACCESS_ON 0x69 /* For RTL8723 only. */
166 #define EFUSE_ACCESS_OFF 0x00 /* For RTL8723 only. */
169 /* EFUSE for BT definition */
171 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512
172 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */
173 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */
174 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */
176 #define EFUSE_PROTECT_BYTES_BANK 16
178 /* Description: Determine the types of C2H events that are the same in driver and Fw. */
179 /* Fisrt constructed by tynli. 2009.10.09. */
180 typedef enum _C2H_EVT
185 C2H_CCX_TX_RPT = 3, /* The FW notify the report of the specific tx packet. */
189 C2H_8723B_BT_INFO = 9,
190 C2H_HW_INFO_EXCH = 10,
191 C2H_8723B_BT_MP_INFO = 11,
195 typedef struct _C2H_EVT_HDR
200 } __attribute__((__packed__)) C2H_EVT_HDR, *PC2H_EVT_HDR;
202 typedef enum tag_Package_Definition
211 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
212 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
214 /* rtl8723a_hal_init.c */
215 s32 rtl8723b_FirmwareDownload(struct adapter *padapter, bool bUsedWoWLANFw);
216 void rtl8723b_FirmwareSelfReset(struct adapter *padapter);
217 void rtl8723b_InitializeFirmwareVars(struct adapter *padapter);
219 void rtl8723b_InitAntenna_Selection(struct adapter *padapter);
220 void rtl8723b_init_default_value(struct adapter *padapter);
222 s32 rtl8723b_InitLLTTable(struct adapter *padapter);
225 u8 GetEEPROMSize8723B(struct adapter *padapter);
226 void Hal_InitPGData(struct adapter *padapter, u8 *PROMContent);
227 void Hal_EfuseParseIDCode(struct adapter *padapter, u8 *hwinfo);
228 void Hal_EfuseParseTxPowerInfo_8723B(struct adapter *padapter, u8 *PROMContent, bool AutoLoadFail);
229 void Hal_EfuseParseBTCoexistInfo_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
230 void Hal_EfuseParseEEPROMVer_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
231 void Hal_EfuseParseChnlPlan_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
232 void Hal_EfuseParseCustomerID_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
233 void Hal_EfuseParseAntennaDiversity_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
234 void Hal_EfuseParseXtal_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
235 void Hal_EfuseParseThermalMeter_8723B(struct adapter *padapter, u8 *hwinfo, u8 AutoLoadFail);
236 void Hal_EfuseParsePackageType_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
237 void Hal_EfuseParseVoltage_8723B(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);
239 void C2HPacketHandler_8723B(struct adapter *padapter, u8 *pbuffer, u16 length);
241 void rtl8723b_set_hal_ops(struct hal_ops *pHalFunc);
242 void SetHwReg8723B(struct adapter *padapter, u8 variable, u8 *val);
243 void GetHwReg8723B(struct adapter *padapter, u8 variable, u8 *val);
244 u8 SetHalDefVar8723B(struct adapter *padapter, enum HAL_DEF_VARIABLE variable, void *pval);
245 u8 GetHalDefVar8723B(struct adapter *padapter, enum HAL_DEF_VARIABLE variable, void *pval);
248 void rtl8723b_InitBeaconParameters(struct adapter *padapter);
249 void _InitBurstPktLen_8723BS(struct adapter * Adapter);
250 void _8051Reset8723(struct adapter *padapter);
252 void Hal_DetectWoWMode(struct adapter *padapter);
253 #endif /* CONFIG_WOWLAN */
255 void rtl8723b_start_thread(struct adapter *padapter);
256 void rtl8723b_stop_thread(struct adapter *padapter);
258 #if defined(CONFIG_CHECK_BT_HANG)
259 void rtl8723bs_init_checkbthang_workqueue(struct adapter * adapter);
260 void rtl8723bs_free_checkbthang_workqueue(struct adapter * adapter);
261 void rtl8723bs_cancle_checkbthang_workqueue(struct adapter * adapter);
262 void rtl8723bs_hal_check_bt_hang(struct adapter * adapter);
265 #ifdef CONFIG_GPIO_WAKEUP
266 void HalSetOutPutGPIO(struct adapter *padapter, u8 index, u8 OutPutValue);
269 int FirmwareDownloadBT(struct adapter * Adapter, struct rt_firmware *firmware);
271 void CCX_FwC2HTxRpt_8723b(struct adapter *padapter, u8 *pdata, u8 len);
272 s32 c2h_id_filter_ccx_8723b(u8 *buf);
273 s32 c2h_handler_8723b(struct adapter *padapter, u8 *pC2hEvent);
274 u8 MRateToHwRate8723B(u8 rate);
275 u8 HwRateToMRate8723B(u8 rate);
277 void Hal_ReadRFGainOffset(struct adapter *padapter, u8 *hwinfo, bool AutoLoadFail);