1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2 | /****************************************************************************** |
3 | * |
4 | * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved. |
5 | * |
6 | ******************************************************************************/ |
7 | #ifndef __RTL8723B_HAL_H__ |
8 | #define __RTL8723B_HAL_H__ |
9 | |
10 | #include "hal_data.h" |
11 | |
12 | #include "rtl8723b_spec.h" |
13 | #include "rtl8723b_rf.h" |
14 | #include "rtl8723b_dm.h" |
15 | #include "rtl8723b_recv.h" |
16 | #include "rtl8723b_xmit.h" |
17 | #include "rtl8723b_cmd.h" |
18 | #include "rtw_mp.h" |
19 | #include "hal_pwr_seq.h" |
20 | #include "hal_phy_reg_8723b.h" |
21 | #include "hal_phy_cfg.h" |
22 | |
23 | /* */ |
24 | /* RTL8723B From header */ |
25 | /* */ |
26 | |
27 | #define FW_8723B_SIZE 0x8000 |
28 | #define FW_8723B_START_ADDRESS 0x1000 |
29 | #define FW_8723B_END_ADDRESS 0x1FFF /* 0x5FFF */ |
30 | |
31 | #define (fw_hdr) \ |
32 | ((le16_to_cpu(fw_hdr->signature) & 0xFFF0) == 0x5300) |
33 | |
34 | struct rt_firmware { |
35 | u32 fw_length; |
36 | u8 *fw_buffer_sz; |
37 | }; |
38 | |
39 | /* This structure must be carefully byte-ordered. */ |
40 | struct rt_firmware_hdr { |
41 | /* 8-byte alinment required */ |
42 | |
43 | /* LONG WORD 0 ---- */ |
44 | __le16 signature; /* 92C0: test chip; 92C, 88C0: test chip; |
45 | * 88C1: MP A-cut; 92C1: MP A-cut |
46 | */ |
47 | u8 category; /* AP/NIC and USB/PCI */ |
48 | u8 function; /* Reserved for different FW function indications, |
49 | * for further use when driver needs to download |
50 | * different FW in different conditions. |
51 | */ |
52 | __le16 version; /* FW Version */ |
53 | __le16 subversion; /* FW Subversion, default 0x00 */ |
54 | |
55 | /* LONG WORD 1 ---- */ |
56 | u8 month; /* Release time Month field */ |
57 | u8 date; /* Release time Date field */ |
58 | u8 hour; /* Release time Hour field */ |
59 | u8 minute; /* Release time Minute field */ |
60 | |
61 | __le16 ram_code_size; /* The size of RAM code */ |
62 | __le16 rsvd2; |
63 | |
64 | /* LONG WORD 2 ---- */ |
65 | __le32 svn_idx; /* The SVN entry index */ |
66 | __le32 rsvd3; |
67 | |
68 | /* LONG WORD 3 ---- */ |
69 | __le32 rsvd4; |
70 | __le32 rsvd5; |
71 | }; |
72 | |
73 | #define DRIVER_EARLY_INT_TIME_8723B 0x05 |
74 | #define BCN_DMA_ATIME_INT_TIME_8723B 0x02 |
75 | |
76 | /* for 8723B */ |
77 | /* TX 32K, RX 16K, Page size 128B for TX, 8B for RX */ |
78 | #define PAGE_SIZE_TX_8723B 128 |
79 | #define PAGE_SIZE_RX_8723B 8 |
80 | |
81 | #define RX_DMA_SIZE_8723B 0x4000 /* 16K */ |
82 | #define RX_DMA_RESERVED_SIZE_8723B 0x80 /* 128B, reserved for tx report */ |
83 | #define RX_DMA_BOUNDARY_8723B \ |
84 | (RX_DMA_SIZE_8723B - RX_DMA_RESERVED_SIZE_8723B - 1) |
85 | |
86 | /* Note: We will divide number of pages equally for each queue other than the |
87 | * public queue! |
88 | */ |
89 | |
90 | /* For General Reserved Page Number(Beacon Queue is reserved page) */ |
91 | /* Beacon:2, PS-Poll:1, Null Data:1, Qos Null Data:1, BT Qos Null Data:1 */ |
92 | #define BCNQ_PAGE_NUM_8723B 0x08 |
93 | #define BCNQ1_PAGE_NUM_8723B 0x00 |
94 | |
95 | #define MAX_RX_DMA_BUFFER_SIZE_8723B 0x2800 /* RX 10K */ |
96 | |
97 | /* For WoWLan, more reserved page */ |
98 | /* ARP Rsp:1, RWC:1, GTK Info:1, GTK RSP:2, GTK EXT MEM:2, PNO: 6 */ |
99 | #define WOWLAN_PAGE_NUM_8723B 0x00 |
100 | |
101 | #define TX_TOTAL_PAGE_NUMBER_8723B \ |
102 | (0xFF - BCNQ_PAGE_NUM_8723B - \ |
103 | BCNQ1_PAGE_NUM_8723B - \ |
104 | WOWLAN_PAGE_NUM_8723B) |
105 | #define TX_PAGE_BOUNDARY_8723B (TX_TOTAL_PAGE_NUMBER_8723B + 1) |
106 | |
107 | #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B TX_TOTAL_PAGE_NUMBER_8723B |
108 | #define WMM_NORMAL_TX_PAGE_BOUNDARY_8723B \ |
109 | (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8723B + 1) |
110 | |
111 | /* For Normal Chip Setting */ |
112 | /* (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */ |
113 | #define NORMAL_PAGE_NUM_HPQ_8723B 0x0C |
114 | #define NORMAL_PAGE_NUM_LPQ_8723B 0x02 |
115 | #define NORMAL_PAGE_NUM_NPQ_8723B 0x02 |
116 | |
117 | /* Note: For Normal Chip Setting, modify later */ |
118 | #define WMM_NORMAL_PAGE_NUM_HPQ_8723B 0x30 |
119 | #define WMM_NORMAL_PAGE_NUM_LPQ_8723B 0x20 |
120 | #define WMM_NORMAL_PAGE_NUM_NPQ_8723B 0x20 |
121 | |
122 | #include "HalVerDef.h" |
123 | #include "hal_com.h" |
124 | |
125 | #define EFUSE_OOB_PROTECT_BYTES 15 |
126 | |
127 | #define HAL_EFUSE_MEMORY |
128 | |
129 | #define HWSET_MAX_SIZE_8723B 512 |
130 | #define EFUSE_REAL_CONTENT_LEN_8723B 512 |
131 | #define EFUSE_MAP_LEN_8723B 512 |
132 | #define EFUSE_MAX_SECTION_8723B 64 |
133 | |
134 | #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. |
135 | * Added by Roger, 2009.09.02. |
136 | */ |
137 | #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN_8723B) |
138 | |
139 | #define EFUSE_ACCESS_ON 0x69 /* For RTL8723 only. */ |
140 | #define EFUSE_ACCESS_OFF 0x00 /* For RTL8723 only. */ |
141 | |
142 | /* */ |
143 | /* EFUSE for BT definition */ |
144 | /* */ |
145 | #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512 |
146 | #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */ |
147 | #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ |
148 | #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ |
149 | |
150 | #define EFUSE_PROTECT_BYTES_BANK 16 |
151 | |
152 | /* Description: Determine the types of C2H events that are the same in driver |
153 | * and FW; First constructed by tynli. 2009.10.09. |
154 | */ |
155 | enum { |
156 | C2H_DBG = 0, |
157 | C2H_TSF = 1, |
158 | C2H_AP_RPT_RSP = 2, |
159 | C2H_CCX_TX_RPT = 3, /* The FW notify the report |
160 | * of the specific tx packet. |
161 | */ |
162 | = 4, |
163 | C2H_BT_OP_MODE = 5, |
164 | C2H_EXT_RA_RPT = 6, |
165 | C2H_8723B_BT_INFO = 9, |
166 | C2H_HW_INFO_EXCH = 10, |
167 | C2H_8723B_BT_MP_INFO = 11, |
168 | MAX_C2HEVENT |
169 | }; |
170 | |
171 | struct c2h_evt_hdr_t { |
172 | u8 CmdID; |
173 | u8 CmdLen; |
174 | u8 CmdSeq; |
175 | } __attribute__((__packed__)); |
176 | |
177 | enum { /* tag_Package_Definition */ |
178 | PACKAGE_DEFAULT, |
179 | PACKAGE_QFN68, |
180 | PACKAGE_TFBGA90, |
181 | PACKAGE_TFBGA80, |
182 | PACKAGE_TFBGA79 |
183 | }; |
184 | |
185 | #define INCLUDE_MULTI_FUNC_BT(_Adapter) \ |
186 | (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) |
187 | #define INCLUDE_MULTI_FUNC_GPS(_Adapter) \ |
188 | (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) |
189 | |
190 | /* rtl8723a_hal_init.c */ |
191 | s32 rtl8723b_FirmwareDownload(struct adapter *padapter, bool bUsedWoWLANFw); |
192 | void rtl8723b_FirmwareSelfReset(struct adapter *padapter); |
193 | void rtl8723b_InitializeFirmwareVars(struct adapter *padapter); |
194 | |
195 | void rtl8723b_InitAntenna_Selection(struct adapter *padapter); |
196 | void rtl8723b_init_default_value(struct adapter *padapter); |
197 | |
198 | s32 rtl8723b_InitLLTTable(struct adapter *padapter); |
199 | |
200 | /* EFuse */ |
201 | u8 GetEEPROMSize8723B(struct adapter *padapter); |
202 | void Hal_InitPGData(struct adapter *padapter, u8 *PROMContent); |
203 | void Hal_EfuseParseIDCode(struct adapter *padapter, u8 *hwinfo); |
204 | void Hal_EfuseParseTxPowerInfo_8723B(struct adapter *padapter, u8 *PROMContent, |
205 | bool AutoLoadFail); |
206 | void Hal_EfuseParseBTCoexistInfo_8723B(struct adapter *padapter, u8 *hwinfo, |
207 | bool AutoLoadFail); |
208 | void Hal_EfuseParseEEPROMVer_8723B(struct adapter *padapter, u8 *hwinfo, |
209 | bool AutoLoadFail); |
210 | void Hal_EfuseParseChnlPlan_8723B(struct adapter *padapter, u8 *hwinfo, |
211 | bool AutoLoadFail); |
212 | void Hal_EfuseParseCustomerID_8723B(struct adapter *padapter, u8 *hwinfo, |
213 | bool AutoLoadFail); |
214 | void Hal_EfuseParseAntennaDiversity_8723B(struct adapter *padapter, u8 *hwinfo, |
215 | bool AutoLoadFail); |
216 | void Hal_EfuseParseXtal_8723B(struct adapter *padapter, u8 *hwinfo, |
217 | bool AutoLoadFail); |
218 | void Hal_EfuseParseThermalMeter_8723B(struct adapter *padapter, u8 *hwinfo, |
219 | u8 AutoLoadFail); |
220 | void Hal_EfuseParsePackageType_8723B(struct adapter *padapter, u8 *hwinfo, |
221 | bool AutoLoadFail); |
222 | void Hal_EfuseParseVoltage_8723B(struct adapter *padapter, u8 *hwinfo, |
223 | bool AutoLoadFail); |
224 | |
225 | void C2HPacketHandler_8723B(struct adapter *padapter, u8 *pbuffer, u16 length); |
226 | |
227 | void rtl8723b_set_hal_ops(struct hal_ops *pHalFunc); |
228 | void SetHwReg8723B(struct adapter *padapter, u8 variable, u8 *val); |
229 | void GetHwReg8723B(struct adapter *padapter, u8 variable, u8 *val); |
230 | u8 SetHalDefVar8723B(struct adapter *padapter, enum hal_def_variable variable, |
231 | void *pval); |
232 | u8 GetHalDefVar8723B(struct adapter *padapter, enum hal_def_variable variable, |
233 | void *pval); |
234 | |
235 | /* register */ |
236 | void rtl8723b_InitBeaconParameters(struct adapter *padapter); |
237 | void _InitBurstPktLen_8723BS(struct adapter *adapter); |
238 | void _8051Reset8723(struct adapter *padapter); |
239 | |
240 | void rtl8723b_start_thread(struct adapter *padapter); |
241 | void rtl8723b_stop_thread(struct adapter *padapter); |
242 | |
243 | int FirmwareDownloadBT(struct adapter *adapter, struct rt_firmware *firmware); |
244 | |
245 | void CCX_FwC2HTxRpt_8723b(struct adapter *padapter, u8 *pdata, u8 len); |
246 | s32 c2h_id_filter_ccx_8723b(u8 *buf); |
247 | s32 c2h_handler_8723b(struct adapter *padapter, u8 *pC2hEvent); |
248 | u8 MRateToHwRate8723B(u8 rate); |
249 | u8 HwRateToMRate8723B(u8 rate); |
250 | |
251 | void Hal_ReadRFGainOffset(struct adapter *padapter, u8 *hwinfo, |
252 | bool AutoLoadFail); |
253 | |
254 | #endif |
255 | |