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 __RTL8188E_HAL_H__
21 #define __RTL8188E_HAL_H__
23 /* #include "hal_com.h" */
26 /* include HAL Related header after HAL Related compiling flags */
27 #include "rtl8188e_spec.h"
28 #include "Hal8188EPhyReg.h"
29 #include "Hal8188EPhyCfg.h"
30 #include "rtl8188e_rf.h"
31 #include "rtl8188e_dm.h"
32 #include "rtl8188e_recv.h"
33 #include "rtl8188e_xmit.h"
34 #include "rtl8188e_cmd.h"
35 #include "rtl8188e_led.h"
36 #include "Hal8188EPwrSeq.h"
37 #ifdef DBG_CONFIG_ERROR_DETECT
38 #include "rtl8188e_sreset.h"
41 /* --------------------------------------------------------------------- */
42 /* RTL8188E Power Configuration CMDs for USB/SDIO/PCIE interfaces */
43 /* --------------------------------------------------------------------- */
44 #define Rtl8188E_NIC_PWR_ON_FLOW rtl8188E_power_on_flow
45 #define Rtl8188E_NIC_RF_OFF_FLOW rtl8188E_radio_off_flow
46 #define Rtl8188E_NIC_DISABLE_FLOW rtl8188E_card_disable_flow
47 #define Rtl8188E_NIC_ENABLE_FLOW rtl8188E_card_enable_flow
48 #define Rtl8188E_NIC_SUSPEND_FLOW rtl8188E_suspend_flow
49 #define Rtl8188E_NIC_RESUME_FLOW rtl8188E_resume_flow
50 #define Rtl8188E_NIC_PDN_FLOW rtl8188E_hwpdn_flow
51 #define Rtl8188E_NIC_LPS_ENTER_FLOW rtl8188E_enter_lps_flow
52 #define Rtl8188E_NIC_LPS_LEAVE_FLOW rtl8188E_leave_lps_flow
55 #if 1 /* download firmware related data structure */
56 #define MAX_FW_8188E_SIZE 0x8000 /* 32768, 32k / 16384, 16k */
58 #define FW_8188E_SIZE 0x4000 /* 16384, 16k */
59 #define FW_8188E_SIZE_2 0x8000 /* 32768, 32k */
61 #define FW_8188E_START_ADDRESS 0x1000
62 #define FW_8188E_END_ADDRESS 0x1FFF /* 0x5FFF */
65 #define IS_FW_HEADER_EXIST_88E(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature) & 0xFFF0) == 0x88E0)
67 typedef struct _RT_FIRMWARE_8188E {
68 FIRMWARE_SOURCE eFWSource;
69 #ifdef CONFIG_EMBEDDED_FWIMG
72 u8 szFwBuffer[MAX_FW_8188E_SIZE];
75 } RT_FIRMWARE_8188E, *PRT_FIRMWARE_8188E;
78 * This structure must be cared byte-ordering
81 typedef struct _RT_8188E_FIRMWARE_HDR {
82 /* 8-byte alinment required */
84 /* --- LONG WORD 0 ---- */
85 u16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
86 u8 Category; /* AP/NIC and USB/PCI */
87 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
88 u16 Version; /* FW Version */
89 u8 Subversion; /* FW Subversion, default 0x00 */
93 /* --- LONG WORD 1 ---- */
94 u8 Month; /* Release time Month field */
95 u8 Date; /* Release time Date field */
96 u8 Hour; /* Release time Hour field */
97 u8 Minute; /* Release time Minute field */
98 u16 RamCodeSize; /* The size of RAM code */
102 /* --- LONG WORD 2 ---- */
103 u32 SvnIdx; /* The SVN entry index */
106 /* --- LONG WORD 3 ---- */
109 } RT_8188E_FIRMWARE_HDR, *PRT_8188E_FIRMWARE_HDR;
110 #endif /* download firmware related data structure */
113 #define DRIVER_EARLY_INT_TIME_8188E 0x05
114 #define BCN_DMA_ATIME_INT_TIME_8188E 0x02
117 /* #define MAX_RX_DMA_BUFFER_SIZE_88E 0x2400 */ /* 9k for 88E nornal chip , */ /* MaxRxBuff=10k-max(TxReportSize(64*8), WOLPattern(16*24)) */
118 #define RX_DMA_SIZE_88E(__Adapter) ((!IS_VENDOR_8188E_I_CUT_SERIES(__Adapter))?0x2800:0x4000)
\r
121 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/
126 #define RX_DMA_RESERVD_FW_FEATURE 0x200 /* for tx report (64*8) */
128 #define MAX_RX_DMA_BUFFER_SIZE_88E(__Adapter) (RX_DMA_SIZE_88E(__Adapter)-RX_DMA_RESERVD_FW_FEATURE)
130 #define MAX_TX_REPORT_BUFFER_SIZE 0x0400 /* 1k */
132 /* Note: We will divide number of page equally for each queue other than public queue!
133 * 22k = 22528 bytes = 176 pages (@page = 128 bytes)
134 * must reserved about 7 pages for LPS => 176-7 = 169 (0xA9)
135 * 2*BCN / 1*ps-poll / 1*null-data /1*prob_rsp /1*QOS null-data /1*BT QOS null-data */
137 #define BCNQ_PAGE_NUM_88E 0x09
139 /* For WoWLan , more reserved page */
141 #define WOWLAN_PAGE_NUM_88E 0x00
143 #define WOWLAN_PAGE_NUM_88E 0x00
147 Tx FIFO Size : previous CUT:22K /I_CUT after:32KB
149 Total page numbers : 176(0xB0) / 256(0x100)
151 #define TOTAL_PAGE_NUMBER_88E(_Adapter) ((IS_VENDOR_8188E_I_CUT_SERIES(_Adapter)?0x100:0xB0) - 1)/* must reserved 1 page for dma issue */
\r
152 #define TX_TOTAL_PAGE_NUMBER_88E(_Adapter) (TOTAL_PAGE_NUMBER_88E(_Adapter) - BCNQ_PAGE_NUM_88E - WOWLAN_PAGE_NUM_88E)
153 #define TX_PAGE_BOUNDARY_88E(_Adapter) (TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) /* beacon header start address */
155 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) TX_TOTAL_PAGE_NUMBER_88E(_Adapter)
156 #define WMM_NORMAL_TX_PAGE_BOUNDARY_88E(_Adapter) (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1)
158 /* For Normal Chip Setting
159 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */
160 #define NORMAL_PAGE_NUM_HPQ_88E 0x0
161 #define NORMAL_PAGE_NUM_LPQ_88E 0x09
162 #define NORMAL_PAGE_NUM_NPQ_88E 0x0
164 /* Note: For Normal Chip Setting, modify later */
165 #define WMM_NORMAL_PAGE_NUM_HPQ_88E 0x29
166 #define WMM_NORMAL_PAGE_NUM_LPQ_88E 0x1C
167 #define WMM_NORMAL_PAGE_NUM_NPQ_88E 0x1C
170 /* -------------------------------------------------------------------------
172 * ------------------------------------------------------------------------- */
173 #define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22) & 0x3)
174 #define CHIP_BONDING_92C_1T2R 0x1
175 #define CHIP_BONDING_88C_USB_MCARD 0x2
176 #define CHIP_BONDING_88C_USB_HP 0x1
178 /* -------------------------------------------------------------------------
180 * ------------------------------------------------------------------------- */
183 #define EFUSE_REAL_CONTENT_LEN 512
184 #define EFUSE_MAP_LEN 128
185 #define EFUSE_MAX_SECTION 16
186 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
187 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN)
190 * To prevent out of boundary programming case,
191 * leave 1byte and program full section
192 * 9bytes + 1byt + 5bytes and pre 1byte.
194 * | 1byte|----8bytes----|1byte|--5bytes--|
195 * | | Reserved(14bytes) |
197 #define EFUSE_OOB_PROTECT_BYTES 15 /* PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. */
199 #define EFUSE_REAL_CONTENT_LEN_88E 256
200 #define EFUSE_MAP_LEN_88E 512
201 #define EFUSE_MAX_SECTION_88E 64
202 #define EFUSE_MAX_WORD_UNIT_88E 4
203 #define EFUSE_IC_ID_OFFSET_88E 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
204 #define AVAILABLE_EFUSE_ADDR_88E(addr) (addr < EFUSE_REAL_CONTENT_LEN_88E)
205 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section
206 * 9bytes + 1byt + 5bytes and pre 1byte.
208 * | 2byte|----8bytes----|1byte|--7bytes--| */ /* 92D */
209 #define EFUSE_OOB_PROTECT_BYTES_88E 18 /* PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. */
210 #define EFUSE_PROTECT_BYTES_BANK_88E 16
213 /* ********************************************************
214 * EFUSE for BT definition
215 * ******************************************************** */
216 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */
217 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */
218 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */
220 #define EFUSE_PROTECT_BYTES_BANK 16
222 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
223 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
225 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */
227 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */
229 #ifdef CONFIG_PCI_HCI
230 /* according to the define in the rtw_xmit.h, rtw_recv.h */
231 #define TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */
232 #ifdef CONFIG_CONCURRENT_MODE
233 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM<<1)*/ /* 256 */
234 #define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+(TXDESC_NUM>>1)) /* 320 */
235 /*#define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+TXDESC_NUM)*/ /* 384 */
237 #define BE_QUEUE_TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */
238 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM+(TXDESC_NUM>>1)) */ /* 192 */
241 void InterruptRecognized8188EE(PADAPTER Adapter, PRT_ISR_CONTENT pIsrContent);
242 void UpdateInterruptMask8188EE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
243 #endif /* CONFIG_PCI_HCI */
245 /* rtl8188e_hal_init.c */
247 s32 rtl8188e_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw);
248 void _8051Reset88E(PADAPTER padapter);
249 void rtl8188e_InitializeFirmwareVars(PADAPTER padapter);
252 s32 InitLLTTable(PADAPTER padapter, u8 txpktbuf_bndy);
255 u8 GetEEPROMSize8188E(PADAPTER padapter);
256 void Hal_InitPGData88E(PADAPTER padapter);
257 void Hal_EfuseParseIDCode88E(PADAPTER padapter, u8 *hwinfo);
258 void Hal_ReadTxPowerInfo88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
260 void Hal_EfuseParseEEPROMVer88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
261 void rtl8188e_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
262 void Hal_EfuseParseCustomerID88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
263 void Hal_ReadAntennaDiversity88E(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
264 void Hal_ReadThermalMeter_88E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
265 void Hal_EfuseParseXtal_8188E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
266 void Hal_EfuseParseBoardType88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
267 void Hal_ReadPowerSavingMode88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
268 void Hal_ReadPAType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
269 void Hal_ReadAmplifierType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
270 void Hal_ReadRFEType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
272 BOOLEAN HalDetectPwrDownMode88E(PADAPTER Adapter);
274 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
275 void Hal_DetectWoWMode(PADAPTER pAdapter);
276 #endif /* CONFIG_WOWLAN */
279 #ifdef CONFIG_RF_POWER_TRIM
280 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
281 #endif /*CONFIG_RF_POWER_TRIM*/
283 void rtl8188e_init_default_value(_adapter *adapter);
285 void rtl8188e_set_hal_ops(struct hal_ops *pHalFunc);
286 void init_hal_spec_8188e(_adapter *adapter);
289 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);
291 void rtl8188e_start_thread(_adapter *padapter);
292 void rtl8188e_stop_thread(_adapter *padapter);
294 void rtw_IOL_cmd_tx_pkt_buf_dump(ADAPTER *Adapter, int data_len);
295 #ifdef CONFIG_IOL_EFUSE_PATCH
296 s32 rtl8188e_iol_efuse_patch(PADAPTER padapter);
297 #endif/* CONFIG_IOL_EFUSE_PATCH */
298 void _InitTransferPageSize(PADAPTER padapter);
300 void SetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val);
301 void GetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val);
306 IN HAL_DEF_VARIABLE eVariable,
309 #ifdef CONFIG_GPIO_API
310 int rtl8188e_GpioFuncCheck(PADAPTER adapter, u8 gpio_num);
312 #endif /* __RTL8188E_HAL_H__ */