hc
2024-05-14 bedbef8ad3e75a304af6361af235302bcc61d06b
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/******************************************************************************
 *
 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 *
 ******************************************************************************/
#ifndef __RTL8703B_HAL_H__
#define __RTL8703B_HAL_H__
 
#include "hal_data.h"
 
#include "rtl8703b_spec.h"
#include "rtl8703b_rf.h"
#include "rtl8703b_dm.h"
#include "rtl8703b_recv.h"
#include "rtl8703b_xmit.h"
#include "rtl8703b_cmd.h"
#include "rtl8703b_led.h"
#include "Hal8703BPwrSeq.h"
#include "Hal8703BPhyReg.h"
#include "Hal8703BPhyCfg.h"
#ifdef DBG_CONFIG_ERROR_DETECT
#include "rtl8703b_sreset.h"
#endif
 
 
//---------------------------------------------------------------------
//        RTL8703B From file
//---------------------------------------------------------------------
   #define RTL8703B_FW_IMG                    "rtl8703b/FW_NIC.bin"
   #define RTL8703B_FW_WW_IMG                "rtl8703b/FW_WoWLAN.bin"
   #define RTL8703B_PHY_REG                    "rtl8703b/PHY_REG.txt"
   #define RTL8703B_PHY_RADIO_A                "rtl8703b/RadioA.txt"
   #define RTL8703B_PHY_RADIO_B                "rtl8703b/RadioB.txt"
   #define RTL8703B_TXPWR_TRACK                "rtl8703b/TxPowerTrack.txt" 
   #define RTL8703B_AGC_TAB                    "rtl8703b/AGC_TAB.txt"
   #define RTL8703B_PHY_MACREG                 "rtl8703b/MAC_REG.txt"
   #define RTL8703B_PHY_REG_PG                "rtl8703b/PHY_REG_PG.txt"
   #define RTL8703B_PHY_REG_MP                "rtl8703b/PHY_REG_MP.txt"
   #define RTL8703B_TXPWR_LMT                 "rtl8703b/TXPWR_LMT.txt"
 
//---------------------------------------------------------------------
//        RTL8703B From header
//---------------------------------------------------------------------
 
#if MP_DRIVER == 1
   #define Rtl8703B_FwBTImgArray                Rtl8703BFwBTImgArray
   #define Rtl8703B_FwBTImgArrayLength        Rtl8703BFwBTImgArrayLength
 
   #define Rtl8703B_PHY_REG_Array_MP            Rtl8703B_PHYREG_Array_MP
   #define Rtl8703B_PHY_REG_Array_MPLength    Rtl8703B_PHYREG_Array_MPLength
#endif
 
 
#define FW_8703B_SIZE            0x8000
#define FW_8703B_START_ADDRESS    0x1000
#define FW_8703B_END_ADDRESS        0x1FFF //0x5FFF
 
#define IS_FW_HEADER_EXIST_8703B(_pFwHdr)    ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x03B0)
 
typedef struct _RT_FIRMWARE {
   FIRMWARE_SOURCE    eFWSource;
#ifdef CONFIG_EMBEDDED_FWIMG
   u8*            szFwBuffer;
#else
   u8            szFwBuffer[FW_8703B_SIZE];
#endif
   u32            ulFwLength;
} RT_FIRMWARE_8703B, *PRT_FIRMWARE_8703B;
 
//
// This structure must be cared byte-ordering
//
// Added by tynli. 2009.12.04.
typedef struct _RT_8703B_FIRMWARE_HDR
{
   // 8-byte alinment required
 
   //--- LONG WORD 0 ----
   u16        Signature;    // 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut
   u8        Category;    // AP/NIC and USB/PCI
   u8        Function;    // Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions
   u16        Version;        // FW Version
   u16        Subversion;    // FW Subversion, default 0x00
 
   //--- LONG WORD 1 ----
   u8        Month;    // Release time Month field
   u8        Date;    // Release time Date field
   u8        Hour;    // Release time Hour field
   u8        Minute;    // Release time Minute field
   u16        RamCodeSize;    // The size of RAM code
   u16        Rsvd2;
 
   //--- LONG WORD 2 ----
   u32        SvnIdx;    // The SVN entry index
   u32        Rsvd3;
 
   //--- LONG WORD 3 ----
   u32        Rsvd4;
   u32        Rsvd5;
}RT_8703B_FIRMWARE_HDR, *PRT_8703B_FIRMWARE_HDR;
 
#define DRIVER_EARLY_INT_TIME_8703B        0x05
#define BCN_DMA_ATIME_INT_TIME_8703B        0x02
 
// for 8703B
// TX 32K, RX 16K, Page size 128B for TX, 8B for RX
#define PAGE_SIZE_TX_8703B            128
#define PAGE_SIZE_RX_8703B            8
 
#define TX_DMA_SIZE_8703B            0x8000    /* 32K(TX) */
#define RX_DMA_SIZE_8703B            0x4000    /* 16K(RX) */
 
#ifdef CONFIG_WOWLAN
#define RESV_FMWF    WKFMCAM_SIZE*MAX_WKFM_NUM /* 16 entries, for each is 24 bytes*/
#else
#define RESV_FMWF    0
#endif
 
#ifdef CONFIG_FW_C2H_DEBUG 
#define RX_DMA_RESERVED_SIZE_8703B    0x100    // 256B, reserved for c2h debug message
#else
#define RX_DMA_RESERVED_SIZE_8703B    0x80    // 128B, reserved for tx report
#endif
#define RX_DMA_BOUNDARY_8703B        (RX_DMA_SIZE_8703B - RX_DMA_RESERVED_SIZE_8703B - 1)
 
 
// Note: We will divide number of page equally for each queue other than public queue!
 
//For General Reserved Page Number(Beacon Queue is reserved page)
//Beacon:2, PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1
#define BCNQ_PAGE_NUM_8703B        0x08
#ifdef CONFIG_CONCURRENT_MODE
#define BCNQ1_PAGE_NUM_8703B        0x08 // 0x04
#else
#define BCNQ1_PAGE_NUM_8703B        0x00
#endif
 
#ifdef CONFIG_PNO_SUPPORT
#undef BCNQ1_PAGE_NUM_8703B
#define BCNQ1_PAGE_NUM_8703B        0x00 // 0x04
#endif
 
//For WoWLan , more reserved page
//ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, PNO: 6
#ifdef CONFIG_WOWLAN
#define WOWLAN_PAGE_NUM_8703B    0x07
#else
#define WOWLAN_PAGE_NUM_8703B    0x00
#endif
 
#ifdef CONFIG_PNO_SUPPORT
#undef WOWLAN_PAGE_NUM_8703B
#define WOWLAN_PAGE_NUM_8703B    0x15
#endif
 
#ifdef CONFIG_AP_WOWLAN
#define AP_WOWLAN_PAGE_NUM_8703B    0x02
#endif
 
#define TX_TOTAL_PAGE_NUMBER_8703B    (0xFF - BCNQ_PAGE_NUM_8703B - BCNQ1_PAGE_NUM_8703B - WOWLAN_PAGE_NUM_8703B)
#define TX_PAGE_BOUNDARY_8703B        (TX_TOTAL_PAGE_NUMBER_8703B + 1)
 
#define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B    TX_TOTAL_PAGE_NUMBER_8703B
#define WMM_NORMAL_TX_PAGE_BOUNDARY_8703B        (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8703B + 1)
 
// For Normal Chip Setting
// (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8703B
#define NORMAL_PAGE_NUM_HPQ_8703B        0x0C
#define NORMAL_PAGE_NUM_LPQ_8703B        0x02
#define NORMAL_PAGE_NUM_NPQ_8703B        0x02
 
// Note: For Normal Chip Setting, modify later
#define WMM_NORMAL_PAGE_NUM_HPQ_8703B        0x30
#define WMM_NORMAL_PAGE_NUM_LPQ_8703B        0x20
#define WMM_NORMAL_PAGE_NUM_NPQ_8703B        0x20
 
 
#include "HalVerDef.h"
#include "hal_com.h"
 
#define EFUSE_OOB_PROTECT_BYTES         15
 
#define HAL_EFUSE_MEMORY
 
#define HWSET_MAX_SIZE_8703B            512
#define EFUSE_REAL_CONTENT_LEN_8703B        512
#define EFUSE_MAP_LEN_8703B                512
#define EFUSE_MAX_SECTION_8703B            64
 
#define EFUSE_IC_ID_OFFSET            506    //For some inferiority IC purpose. added by Roger, 2009.09.02.
#define AVAILABLE_EFUSE_ADDR(addr)     (addr < EFUSE_REAL_CONTENT_LEN_8703B)
 
#define EFUSE_ACCESS_ON            0x69    
#define EFUSE_ACCESS_OFF            0x00    
 
//========================================================
//            EFUSE for BT definition
//========================================================
#define EFUSE_BT_REAL_BANK_CONTENT_LEN    512
#define EFUSE_BT_REAL_CONTENT_LEN        1536    // 512*3
#define EFUSE_BT_MAP_LEN                1024    // 1k bytes
#define EFUSE_BT_MAX_SECTION            128        // 1024/8
 
#define EFUSE_PROTECT_BYTES_BANK        16
 
// Description: Determine the types of C2H events that are the same in driver and Fw.
// Fisrt constructed by tynli. 2009.10.09.
typedef enum _C2H_EVT
{
   C2H_DBG = 0,
   C2H_TSF = 1,
   C2H_AP_RPT_RSP = 2,
   C2H_CCX_TX_RPT = 3,    // The FW notify the report of the specific tx packet.
   C2H_BT_RSSI = 4,
   C2H_BT_OP_MODE = 5,
   C2H_EXT_RA_RPT = 6,
   C2H_8703B_BT_INFO = 9,
   C2H_HW_INFO_EXCH = 10,
   C2H_8703B_BT_MP_INFO = 11,
   C2H_8703B_P2P_RPORT = 0x16,
#ifdef CONFIG_FW_C2H_DEBUG
   C2H_8703B_FW_DEBUG = 0xff,
#endif //CONFIG_FW_C2H_DEBUG
   MAX_C2HEVENT
} C2H_EVT;
 
typedef struct _C2H_EVT_HDR
{
   u8    CmdID;
   u8    CmdLen;
   u8    CmdSeq;
} __attribute__((__packed__)) C2H_EVT_HDR, *PC2H_EVT_HDR;
 
typedef enum tag_Package_Definition
{
    PACKAGE_DEFAULT,
    PACKAGE_QFN68,
    PACKAGE_TFBGA90,
    PACKAGE_TFBGA80,
    PACKAGE_TFBGA79
}PACKAGE_TYPE_E;
 
#define INCLUDE_MULTI_FUNC_BT(_Adapter)        (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
#define INCLUDE_MULTI_FUNC_GPS(_Adapter)    (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 
// rtl8703b_hal_init.c
s32 rtl8703b_FirmwareDownload(PADAPTER padapter, BOOLEAN  bUsedWoWLANFw);
void rtl8703b_FirmwareSelfReset(PADAPTER padapter);
void rtl8703b_InitializeFirmwareVars(PADAPTER padapter);
 
void rtl8703b_InitAntenna_Selection(PADAPTER padapter);
void rtl8703b_DeinitAntenna_Selection(PADAPTER padapter);
void rtl8703b_CheckAntenna_Selection(PADAPTER padapter);
void rtl8703b_init_default_value(PADAPTER padapter);
 
s32 rtl8703b_InitLLTTable(PADAPTER padapter);
 
s32 CardDisableHWSM(PADAPTER padapter, u8 resetMCU);
s32 CardDisableWithoutHWSM(PADAPTER padapter);
 
// EFuse
u8 GetEEPROMSize8703B(PADAPTER padapter);
void Hal_InitPGData(PADAPTER padapter, u8 *PROMContent);
void Hal_EfuseParseIDCode(PADAPTER padapter, u8 *hwinfo);
void Hal_EfuseParseTxPowerInfo_8703B(PADAPTER padapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
void Hal_EfuseParseBTCoexistInfo_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
void Hal_EfuseParseEEPROMVer_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
void Hal_EfuseParseChnlPlan_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
void Hal_EfuseParseCustomerID_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
void Hal_EfuseParseAntennaDiversity_8703B(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
void Hal_EfuseParseXtal_8703B(PADAPTER pAdapter, u8 *hwinfo, u8 AutoLoadFail);
void Hal_EfuseParseThermalMeter_8703B(PADAPTER padapter, u8 *hwinfo, u8 AutoLoadFail);
VOID Hal_EfuseParsePackageType_8703B(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);
VOID Hal_EfuseParseVoltage_8703B(PADAPTER pAdapter,u8* hwinfo,BOOLEAN     AutoLoadFail); 
VOID Hal_EfuseParseBoardType_8703B(PADAPTER Adapter,    u8*    PROMContent,BOOLEAN AutoloadFail);
 
#ifdef CONFIG_C2H_PACKET_EN
void rtl8703b_c2h_packet_handler(PADAPTER padapter, u8 *pbuf, u16 length);
#endif
 
 
void rtl8703b_set_hal_ops(struct hal_ops *pHalFunc);
void SetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);
void GetHwReg8703B(PADAPTER padapter, u8 variable, u8 *val);
#ifdef CONFIG_C2H_PACKET_EN
void SetHwRegWithBuf8703B(PADAPTER padapter, u8 variable, u8 *pbuf, int len);
#endif // CONFIG_C2H_PACKET_EN
u8 SetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
u8 GetHalDefVar8703B(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
 
// register
void rtl8703b_InitBeaconParameters(PADAPTER padapter);
void rtl8703b_InitBeaconMaxError(PADAPTER padapter, u8 InfraMode);
void    _InitBurstPktLen_8703BS(PADAPTER Adapter);
void _InitLTECoex_8703BS(PADAPTER Adapter);
void _8051Reset8703(PADAPTER padapter);
#ifdef CONFIG_WOWLAN
void Hal_DetectWoWMode(PADAPTER pAdapter);
#endif //CONFIG_WOWLAN
 
void rtl8703b_start_thread(_adapter *padapter);
void rtl8703b_stop_thread(_adapter *padapter);
 
#if defined(CONFIG_CHECK_BT_HANG) && defined(CONFIG_BT_COEXIST)
void rtl8703bs_init_checkbthang_workqueue(_adapter * adapter);
void rtl8703bs_free_checkbthang_workqueue(_adapter * adapter);
void rtl8703bs_cancle_checkbthang_workqueue(_adapter * adapter);
void rtl8703bs_hal_check_bt_hang(_adapter * adapter);
#endif
 
#ifdef CONFIG_GPIO_WAKEUP
void HalSetOutPutGPIO(PADAPTER padapter, u8 index, u8 OutPutValue);
#endif
 
int FirmwareDownloadBT(IN PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
 
void CCX_FwC2HTxRpt_8703b(PADAPTER padapter, u8 *pdata, u8 len);
s32 c2h_id_filter_ccx_8703b(u8 *buf);
s32 c2h_handler_8703b(PADAPTER padapter, u8 *pC2hEvent);
u8 MRateToHwRate8703B(u8  rate);
u8 HwRateToMRate8703B(u8     rate);
 
#ifdef CONFIG_RF_GAIN_OFFSET
void Hal_ReadRFGainOffset(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);
#endif //CONFIG_RF_GAIN_OFFSET
 
#ifdef CONFIG_PCI_HCI
BOOLEAN    InterruptRecognized8703BE(PADAPTER Adapter);
VOID    UpdateInterruptMask8703BE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
#endif
 
#endif