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 __HAL_DATA_H__
21 #define __HAL_DATA_H__
23 #if 1//def CONFIG_SINGLE_IMG
25 #include "../hal/OUTSRC/odm_precomp.h"
26 #ifdef CONFIG_BT_COEXIST
27 #include <hal_btcoex.h>
31 // <Roger_Notes> For RTL8723 WiFi/BT/GPS multi-function configuration. 2010.10.06.
33 typedef enum _RT_MULTI_FUNC{
34 RT_MULTI_FUNC_NONE = 0x00,
35 RT_MULTI_FUNC_WIFI = 0x01,
36 RT_MULTI_FUNC_BT = 0x02,
37 RT_MULTI_FUNC_GPS = 0x04,
38 }RT_MULTI_FUNC,*PRT_MULTI_FUNC;
40 // <Roger_Notes> For RTL8723 WiFi PDn/GPIO polarity control configuration. 2010.10.08.
42 typedef enum _RT_POLARITY_CTL {
43 RT_POLARITY_LOW_ACT = 0,
44 RT_POLARITY_HIGH_ACT = 1,
45 } RT_POLARITY_CTL, *PRT_POLARITY_CTL;
47 // For RTL8723 regulator mode. by tynli. 2011.01.14.
48 typedef enum _RT_REGULATOR_MODE {
49 RT_SWITCHING_REGULATOR = 0,
51 } RT_REGULATOR_MODE, *PRT_REGULATOR_MODE;
56 typedef enum _INTERFACE_SELECT_PCIE{
57 INTF_SEL0_SOLO_MINICARD = 0, // WiFi solo-mCard
58 INTF_SEL1_BT_COMBO_MINICARD = 1, // WiFi+BT combo-mCard
59 INTF_SEL2_PCIe = 2, // PCIe Card
60 } INTERFACE_SELECT_PCIE, *PINTERFACE_SELECT_PCIE;
63 typedef enum _INTERFACE_SELECT_USB{
64 INTF_SEL0_USB = 0, // USB
65 INTF_SEL1_USB_High_Power = 1, // USB with high power PA
66 INTF_SEL2_MINICARD = 2, // Minicard
67 INTF_SEL3_USB_Solo = 3, // USB solo-Slim module
68 INTF_SEL4_USB_Combo = 4, // USB Combo-Slim module
69 INTF_SEL5_USB_Combo_MF = 5, // USB WiFi+BT Multi-Function Combo, i.e., Proprietary layout(AS-VAU) which is the same as SDIO card
70 } INTERFACE_SELECT_USB, *PINTERFACE_SELECT_USB;
72 typedef enum _RT_AMPDU_BRUST_MODE{
73 RT_AMPDU_BRUST_NONE = 0,
74 RT_AMPDU_BRUST_92D = 1,
75 RT_AMPDU_BRUST_88E = 2,
76 RT_AMPDU_BRUST_8812_4 = 3,
77 RT_AMPDU_BRUST_8812_8 = 4,
78 RT_AMPDU_BRUST_8812_12 = 5,
79 RT_AMPDU_BRUST_8812_15 = 6,
80 RT_AMPDU_BRUST_8723B = 7,
81 }RT_AMPDU_BRUST,*PRT_AMPDU_BRUST_MODE;
83 #define CHANNEL_MAX_NUMBER 14+24+21 // 14 is the max channel number
84 #define CHANNEL_MAX_NUMBER_2G 14
85 #define CHANNEL_MAX_NUMBER_5G 54 // Please refer to "phy_GetChnlGroup8812A" and "Hal_ReadTxPowerInfo8812A"
86 #define CHANNEL_MAX_NUMBER_5G_80M 7
87 #define CHANNEL_GROUP_MAX 3+9 // ch1~3, ch4~9, ch10~14 total three groups
88 #define MAX_PG_GROUP 13
90 // Tx Power Limit Table Size
91 #define MAX_REGULATION_NUM 4
92 #define MAX_RF_PATH_NUM_IN_POWER_LIMIT_TABLE 4
93 #define MAX_2_4G_BANDWITH_NUM 2
94 #define MAX_RATE_SECTION_NUM 10
95 #define MAX_5G_BANDWITH_NUM 4
97 #define MAX_BASE_NUM_IN_PHY_REG_PG_2_4G 10 // CCK:1,OFDM:1, HT:4, VHT:4
98 #define MAX_BASE_NUM_IN_PHY_REG_PG_5G 9 // OFDM:1, HT:4, VHT:4
101 //###### duplicate code,will move to ODM #########
102 //#define IQK_MAC_REG_NUM 4
103 //#define IQK_ADDA_REG_NUM 16
105 //#define IQK_BB_REG_NUM 10
106 #define IQK_BB_REG_NUM_92C 9
107 #define IQK_BB_REG_NUM_92D 10
108 #define IQK_BB_REG_NUM_test 6
110 #define IQK_Matrix_Settings_NUM_92D 1+24+21
112 //#define HP_THERMAL_NUM 8
113 //###### duplicate code,will move to ODM #########
115 #if defined(CONFIG_RTL8192D) || defined(CONFIG_BT_COEXIST)
116 typedef enum _MACPHY_MODE_8192D{
117 SINGLEMAC_SINGLEPHY, //SMSP
118 DUALMAC_DUALPHY, //DMDP
119 DUALMAC_SINGLEPHY, //DMSP
120 }MACPHY_MODE_8192D,*PMACPHY_MODE_8192D;
123 #ifdef CONFIG_USB_RX_AGGREGATION
124 typedef enum _USB_RX_AGG_MODE{
131 //#define MAX_RX_DMA_BUFFER_SIZE 10240 // 10K for 8192C RX DMA buffer
139 #define DYNAMIC_FUNC_BT BIT0
146 //* Upper and Lower Signal threshold for Rate Adaptive*/
147 int UndecoratedSmoothedPWDB;
148 int UndecoratedSmoothedCCK;
149 int EntryMinUndecoratedSmoothedPWDB;
150 int EntryMaxUndecoratedSmoothedPWDB;
151 int MinUndecoratedPWDBForDM;
152 int LastMinUndecoratedPWDBForDM;
154 s32 UndecoratedSmoothedBeacon;
156 //###### duplicate code,will move to ODM #########
158 u8 bDynamicTxPowerEnable;
160 u8 DynamicTxHighPowerLvl;//Add by Jacken Tx Power Control for Near/Far Range 2008/03/06
162 //for tx power tracking
165 u8 bTXPowerTrackingInit;
166 u8 TxPowerTrackControl; //for mp mode, turn off txpwrtracking as default
169 u8 ThermalMeter[2]; // ThermalMeter, index 0 for RFIC0, and 1 for RFIC1
178 u32 APKoutput[2][2]; //path A/B; output1_1a/output1_2a
180 u8 bAPKThermalMeterIgnore;
189 u32 ADDA_backup[IQK_ADDA_REG_NUM];
190 u32 IQK_MAC_backup[IQK_MAC_REG_NUM];
191 u32 IQK_BB_backup_recover[9];
192 u32 IQK_BB_backup[IQK_BB_REG_NUM];
194 u8 PowerIndex_backup[6];
203 u8 ThermalValue_HP[HP_THERMAL_NUM];
204 u8 ThermalValue_HP_index;
213 u32 TXPowerTrackingCallbackCnt; //cosa add for debug
215 u32 prv_traffic_idx; // edca turbo
216 #ifdef CONFIG_RTL8192D
217 u8 ThermalValue_AVG[AVG_THERMAL_NUM];
218 u8 ThermalValue_AVG_index;
219 u8 ThermalValue_RxGain;
220 u8 ThermalValue_Crystal;
221 u8 bReloadtxpowerindex;
234 u32 RegRF3C[2]; //pathA / pathB
236 //###### duplicate code,will move to ODM #########
238 // Add for Reading Initial Data Rate SEL Register 0x484 during watchdog. Using for fill tx desc. 2011.3.21 by Thomas
243 typedef struct hal_com_data
245 HAL_VERSION VersionID;
246 RT_MULTI_FUNC MultiFunc; // For multi-function consideration.
247 RT_POLARITY_CTL PolarityCtl; // For Wifi PDn Polarity control.
248 RT_REGULATOR_MODE RegulatorMode; // switching regulator or LDO
251 u16 FirmwareVersionRev;
252 u16 FirmwareSubVersion;
253 u16 FirmwareSignature;
255 //current WIFI_PHY values
256 WIRELESS_MODE CurrentWirelessMode;
257 CHANNEL_WIDTH CurrentChannelBW;
258 BAND_TYPE CurrentBandType; //0:2.4G, 1:5G
261 u8 CurrentCenterFrequencyIndex1;
262 u8 nCur40MhzPrimeSC;// Control channel sub-carrier
263 u8 nCur80MhzPrimeSC; //used for primary 40MHz of 80MHz mode
267 u16 ForcedDataRate;// Force Data Rate. 0: Auto, 0x02: 1M ~ 0x6C: 54M.
280 u8 DefaultInitialGain[4];
286 #ifdef CONFIG_USB_HCI
290 #ifdef CONFIG_PCI_HCI
296 u8 EEPROMSubCustomerID;
299 u8 EEPROMThermalMeter;
300 u8 EEPROMBluetoothCoexist;
301 u8 EEPROMBluetoothType;
302 u8 EEPROMBluetoothAntNum;
303 u8 EEPROMBluetoothAntIsolation;
304 u8 EEPROMBluetoothRadioShared;
305 u8 bTXPowerDataReadFromEEPORM;
306 u8 bAPKThermalMeterIgnore;
307 u8 bDisableSWChannelPlan; // flag of disable software change channel plan
309 BOOLEAN EepromOrEfuse;
310 u8 EfuseUsedPercentage;
312 //u8 EfuseMap[2][HWSET_MAX_SIZE_JAGUAR];
315 //---------------------------------------------------------------------------------//
317 u8 Index24G_CCK_Base[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
318 u8 Index24G_BW40_Base[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
319 //If only one tx, only BW20 and OFDM are used.
320 s8 CCK_24G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
321 s8 OFDM_24G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
322 s8 BW20_24G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
323 s8 BW40_24G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
325 u8 Index5G_BW40_Base[MAX_RF_PATH][CHANNEL_MAX_NUMBER];
326 u8 Index5G_BW80_Base[MAX_RF_PATH][CHANNEL_MAX_NUMBER_5G_80M];
327 s8 OFDM_5G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
328 s8 BW20_5G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
329 s8 BW40_5G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
330 s8 BW80_5G_Diff[MAX_RF_PATH][MAX_TX_COUNT];
335 u8 TxPwrInPercentage;
337 u8 TxPwrCalibrateRate;
339 // TX power by rate table at most 4RF path.
342 // VHT TX power by rate off setArray =
343 // Band:-2G&5G = 0 / 1
344 // RF: at most 4*4 = ABCD=0/1/2/3
345 // CCK=0 OFDM=1/2 HT-MCS 0-15=3/4/56 VHT=7/8/9/10/11
349 s8 TxPwrByRateOffset[TX_PWR_BY_RATE_NUM_BAND]
350 [TX_PWR_BY_RATE_NUM_RF]
351 [TX_PWR_BY_RATE_NUM_RF]
352 [TX_PWR_BY_RATE_NUM_RATE];
353 //---------------------------------------------------------------------------------//
355 //2 Power Limit Table
356 u8 TxPwrLevelCck[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER];
357 u8 TxPwrLevelHT40_1S[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER]; // For HT 40MHZ pwr
358 u8 TxPwrLevelHT40_2S[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER]; // For HT 40MHZ pwr
359 u8 TxPwrHt20Diff[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER];// HT 20<->40 Pwr diff
360 u8 TxPwrLegacyHtDiff[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER];// For HT<->legacy pwr diff
362 // Power Limit Table for 2.4G
363 u8 TxPwrLimit_2_4G[MAX_REGULATION_NUM]
364 [MAX_2_4G_BANDWITH_NUM]
365 [MAX_RATE_SECTION_NUM]
366 [CHANNEL_MAX_NUMBER_2G]
369 // Power Limit Table for 5G
370 u8 TxPwrLimit_5G[MAX_REGULATION_NUM]
371 [MAX_5G_BANDWITH_NUM]
372 [MAX_RATE_SECTION_NUM]
373 [CHANNEL_MAX_NUMBER_5G]
377 // Store the original power by rate value of the base of each rate section of rf path A & B
378 u8 TxPwrByRateBase2_4G[TX_PWR_BY_RATE_NUM_RF]
379 [TX_PWR_BY_RATE_NUM_RF]
380 [MAX_BASE_NUM_IN_PHY_REG_PG_2_4G];
381 u8 TxPwrByRateBase5G[TX_PWR_BY_RATE_NUM_RF]
382 [TX_PWR_BY_RATE_NUM_RF]
383 [MAX_BASE_NUM_IN_PHY_REG_PG_5G];
386 u8 PwrGroupHT20[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER];
387 u8 PwrGroupHT40[RF_PATH_MAX_92C_88E][CHANNEL_MAX_NUMBER];
393 u8 LegacyHTTxPowerDiff;// Legacy to HT rate power diff
394 // The current Tx Power Level
395 u8 CurrentCckTxPwrIdx;
396 u8 CurrentOfdm24GTxPwrIdx;
397 u8 CurrentBW2024GTxPwrIdx;
398 u8 CurrentBW4024GTxPwrIdx;
400 // Read/write are allow for following hardware information variables
402 u32 MCSTxPowerLevelOriginalOffset[MAX_PG_GROUP][16];
403 u32 CCKTxPowerLevelOriginalOffset;
406 u32 AntennaTxPath; // Antenna path Tx
407 u32 AntennaRxPath; // Antenna path Rx
425 BOOLEAN bLCKInProgress;
429 BOOLEAN bChnlBWInitialized;
432 u8 bLedOpenDrain; // Support Open-drain arrangement for controlling the LED. Added by Roger, 2009.10.16.
433 u8 TxPowerTrackControl; //for mp mode, turn off txpwrtracking as default
434 u8 b1x1RecvCombine; // for 1T1R receive combining
436 u32 AcParam_BE; //Original parameter for BE, use for EDCA turbo.
438 BB_REGISTER_DEFINITION_T PHYRegDef[4]; //Radio A/B/C/D
445 //for host message to fw
450 // Beacon function related global variable.
464 u8 u1ForcedIgiLb; // forced IGI lower bound
466 u8 bDumpRxPkt;//for debug
467 u8 bDumpTxPkt;//for debug
468 u8 FwRsvdPageStartOffset; //2010.06.23. Added by tynli. Reserve page start offset except beacon in TxQ.
470 // 2010/08/09 MH Add CU power down mode.
473 // Add for dual MAC 0--Mac0 1--Mac1
479 // 2010/12/10 MH Add for USB aggreation mode dynamic shceme.
480 BOOLEAN UsbRxHighSpeedMode;
482 // 2010/11/22 MH Add for slim combo debug mode selective.
483 // This is used for fix the drawback of CU TSMC-A/UMC-A cut. HW auto suspend ability. Close BT clock.
484 BOOLEAN SlimComboDbg;
492 // Auto FSM to Turn On, include clock, isolation, power control for MAC only
496 struct submit_ctx iqk_sctx;
498 RT_AMPDU_BRUST AMPDUBurstMode; //92C maybe not use, but for compile successfully
500 #ifdef CONFIG_SDIO_HCI
502 // For SDIO Interface HAL related
509 // u32 IntrMaskToSet[1];
510 // LOG_INTERRUPT InterruptLog;
515 // SDIO Tx FIFO related.
517 // HIQ, MID, LOW, PUB free pages; padapter->xmitpriv.free_txpg
518 u8 SdioTxFIFOFreePage[SDIO_TX_FREE_PG_QUEUE];
519 _lock SdioTxFIFOFreePageLock;
522 // SDIO Rx FIFO related.
526 #endif //CONFIG_SDIO_HCI
528 #ifdef CONFIG_USB_HCI
530 BOOLEAN bSupportUSB3;
532 // Interrupt relatd register information.
533 u32 IntArray[3];//HISR0,HISR1,HSISR
536 #ifdef CONFIG_USB_TX_AGGREGATION
539 #endif // CONFIG_USB_TX_AGGREGATION
541 #ifdef CONFIG_USB_RX_AGGREGATION
542 u16 HwRxPageSize; // Hardware setting
543 u32 MaxUsbRxAggBlock;
545 USB_RX_AGG_MODE UsbRxAggMode;
546 u8 UsbRxAggBlockCount; //FOR USB Mode, USB Block count. Block size is 512-byte in hight speed and 64-byte in full speed
547 u8 UsbRxAggBlockTimeout;
548 u8 UsbRxAggPageCount; //FOR DMA Mode, 8192C DMA page count
549 u8 UsbRxAggPageTimeout;
553 #endif//CONFIG_USB_RX_AGGREGATION
554 #endif //CONFIG_USB_HCI
557 #ifdef CONFIG_PCI_HCI
561 u16 EEPROMChannelPlan;
567 u32 IntrMaskToSet[2];
573 u32 IntrMaskDefault[2];
575 BOOLEAN bL1OffSupport;
576 BOOLEAN bSupportBackDoor;
579 //u8 bIQKInitialized;
581 u8 bInterruptMigration;
584 #endif //CONFIG_PCI_HCI
586 struct dm_priv dmpriv;
588 #ifdef DBG_CONFIG_ERROR_DETECT
589 struct sreset_priv srestpriv;
590 #endif //#ifdef DBG_CONFIG_ERROR_DETECT
592 #ifdef CONFIG_BT_COEXIST
593 // For bluetooth co-existance
594 BT_COEXIST bt_coexist;
595 #ifdef CONFIG_RTL8723A
597 #endif // CONFIG_RTL8723A
598 #endif // CONFIG_BT_COEXIST
600 #if defined(CONFIG_RTL8723A) || defined(CONFIG_RTL8723B)
601 // Interrupt relatd register information.
604 #endif //endif CONFIG_RTL8723A
607 #if defined(CONFIG_RTL8192C) ||defined(CONFIG_RTL8192D)
611 u8 EEPROMChnlAreaTxPwrCCK[2][3];
612 u8 EEPROMChnlAreaTxPwrHT40_1S[2][3];
613 u8 EEPROMChnlAreaTxPwrHT40_2SDiff[2][3];
614 u8 EEPROMPwrLimitHT20[3];
615 u8 EEPROMPwrLimitHT40[3];
616 #ifdef CONFIG_RTL8192D
617 MACPHY_MODE_8192D MacPhyMode92D;
618 BAND_TYPE CurrentBandType92D; //0:2.4G, 1:5G
619 BAND_TYPE BandSet92D;
620 BOOLEAN bMasterOfDMSP;
621 BOOLEAN bSlaveOfDMSP;
623 IQK_MATRIX_REGS_SETTING IQKMatrixRegSetting[IQK_Matrix_Settings_NUM_92D];
624 #ifdef CONFIG_DUALMAC_CONCURRENT
625 BOOLEAN bInModeSwitchProcess;
627 u8 AutoLoadStatusFor8192D;
631 u8 InternalPA5G[2]; //pathA / pathB
632 BOOLEAN bPhyValueInitReady;
633 BOOLEAN bLoadIMRandIQKSettingFor2G;// True if IMR or IQK have done for 2.4G in scan progress
638 BOOLEAN bEarlyModeEnable;
639 BOOLEAN bSupportRemoteWakeUp;
641 u8 RTSInitRate; // 2010.11.24.by tynli.
642 #endif //CONFIG_RTL8192D
644 #endif //defined(CONFIG_RTL8192C) ||defined(CONFIG_RTL8192D)
646 #ifdef CONFIG_LOAD_PHY_PARA_FROM_FILE
647 char para_file_buf[MAX_PARA_FILE_BUF_LEN];
655 u32 bb_phy_reg_pg_len;
657 u32 bb_phy_reg_mp_len;
662 char *rf_tx_pwr_track;
663 u32 rf_tx_pwr_track_len;
665 u32 rf_tx_pwr_lmt_len;
667 } HAL_DATA_COMMON, *PHAL_DATA_COMMON;
670 typedef struct hal_com_data HAL_DATA_TYPE, *PHAL_DATA_TYPE;
671 #define GET_HAL_DATA(__pAdapter) ((HAL_DATA_TYPE *)((__pAdapter)->HalData))
672 #define GET_HAL_RFPATH_NUM(__pAdapter) (((HAL_DATA_TYPE *)((__pAdapter)->HalData))->NumTotalRFPath )
673 #define RT_GetInterfaceSelection(_Adapter) (GET_HAL_DATA(_Adapter)->InterfaceSel)
674 #define GET_RF_TYPE(__pAdapter) (GET_HAL_DATA(__pAdapter)->rf_type)
678 #endif //__HAL_DATA_H__