1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3 *
4 * Copyright(c) 2007 - 2017 Realtek Corporation.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 *****************************************************************************/
16 #ifndef __HAL_COMMON_H__
17 #define __HAL_COMMON_H__
18
19 #include "HalVerDef.h"
20 #include "hal_pg.h"
21 #include "hal_phy.h"
22 #include "hal_phy_reg.h"
23 #include "hal_com_reg.h"
24 #include "hal_com_phycfg.h"
25 #include "../hal/hal_com_c2h.h"
26
27 /*------------------------------ Tx Desc definition Macro ------------------------*/
28 /* #pragma mark -- Tx Desc related definition. -- */
29 /* ----------------------------------------------------------------------------
30 * -----------------------------------------------------------
31 * Rate
32 * -----------------------------------------------------------
33 * CCK Rates, TxHT = 0 */
34 #define DESC_RATE1M 0x00
35 #define DESC_RATE2M 0x01
36 #define DESC_RATE5_5M 0x02
37 #define DESC_RATE11M 0x03
38
39 /* OFDM Rates, TxHT = 0 */
40 #define DESC_RATE6M 0x04
41 #define DESC_RATE9M 0x05
42 #define DESC_RATE12M 0x06
43 #define DESC_RATE18M 0x07
44 #define DESC_RATE24M 0x08
45 #define DESC_RATE36M 0x09
46 #define DESC_RATE48M 0x0a
47 #define DESC_RATE54M 0x0b
48
49 /* MCS Rates, TxHT = 1 */
50 #define DESC_RATEMCS0 0x0c
51 #define DESC_RATEMCS1 0x0d
52 #define DESC_RATEMCS2 0x0e
53 #define DESC_RATEMCS3 0x0f
54 #define DESC_RATEMCS4 0x10
55 #define DESC_RATEMCS5 0x11
56 #define DESC_RATEMCS6 0x12
57 #define DESC_RATEMCS7 0x13
58 #define DESC_RATEMCS8 0x14
59 #define DESC_RATEMCS9 0x15
60 #define DESC_RATEMCS10 0x16
61 #define DESC_RATEMCS11 0x17
62 #define DESC_RATEMCS12 0x18
63 #define DESC_RATEMCS13 0x19
64 #define DESC_RATEMCS14 0x1a
65 #define DESC_RATEMCS15 0x1b
66 #define DESC_RATEMCS16 0x1C
67 #define DESC_RATEMCS17 0x1D
68 #define DESC_RATEMCS18 0x1E
69 #define DESC_RATEMCS19 0x1F
70 #define DESC_RATEMCS20 0x20
71 #define DESC_RATEMCS21 0x21
72 #define DESC_RATEMCS22 0x22
73 #define DESC_RATEMCS23 0x23
74 #define DESC_RATEMCS24 0x24
75 #define DESC_RATEMCS25 0x25
76 #define DESC_RATEMCS26 0x26
77 #define DESC_RATEMCS27 0x27
78 #define DESC_RATEMCS28 0x28
79 #define DESC_RATEMCS29 0x29
80 #define DESC_RATEMCS30 0x2A
81 #define DESC_RATEMCS31 0x2B
82 #define DESC_RATEVHTSS1MCS0 0x2C
83 #define DESC_RATEVHTSS1MCS1 0x2D
84 #define DESC_RATEVHTSS1MCS2 0x2E
85 #define DESC_RATEVHTSS1MCS3 0x2F
86 #define DESC_RATEVHTSS1MCS4 0x30
87 #define DESC_RATEVHTSS1MCS5 0x31
88 #define DESC_RATEVHTSS1MCS6 0x32
89 #define DESC_RATEVHTSS1MCS7 0x33
90 #define DESC_RATEVHTSS1MCS8 0x34
91 #define DESC_RATEVHTSS1MCS9 0x35
92 #define DESC_RATEVHTSS2MCS0 0x36
93 #define DESC_RATEVHTSS2MCS1 0x37
94 #define DESC_RATEVHTSS2MCS2 0x38
95 #define DESC_RATEVHTSS2MCS3 0x39
96 #define DESC_RATEVHTSS2MCS4 0x3A
97 #define DESC_RATEVHTSS2MCS5 0x3B
98 #define DESC_RATEVHTSS2MCS6 0x3C
99 #define DESC_RATEVHTSS2MCS7 0x3D
100 #define DESC_RATEVHTSS2MCS8 0x3E
101 #define DESC_RATEVHTSS2MCS9 0x3F
102 #define DESC_RATEVHTSS3MCS0 0x40
103 #define DESC_RATEVHTSS3MCS1 0x41
104 #define DESC_RATEVHTSS3MCS2 0x42
105 #define DESC_RATEVHTSS3MCS3 0x43
106 #define DESC_RATEVHTSS3MCS4 0x44
107 #define DESC_RATEVHTSS3MCS5 0x45
108 #define DESC_RATEVHTSS3MCS6 0x46
109 #define DESC_RATEVHTSS3MCS7 0x47
110 #define DESC_RATEVHTSS3MCS8 0x48
111 #define DESC_RATEVHTSS3MCS9 0x49
112 #define DESC_RATEVHTSS4MCS0 0x4A
113 #define DESC_RATEVHTSS4MCS1 0x4B
114 #define DESC_RATEVHTSS4MCS2 0x4C
115 #define DESC_RATEVHTSS4MCS3 0x4D
116 #define DESC_RATEVHTSS4MCS4 0x4E
117 #define DESC_RATEVHTSS4MCS5 0x4F
118 #define DESC_RATEVHTSS4MCS6 0x50
119 #define DESC_RATEVHTSS4MCS7 0x51
120 #define DESC_RATEVHTSS4MCS8 0x52
121 #define DESC_RATEVHTSS4MCS9 0x53
122
123 #define IS_CCK_HRATE(_rate) ((_rate) <= DESC_RATE11M)
124 #define IS_OFDM_HRATE(_rate) ((_rate) >= DESC_RATE6M && (_rate) <= DESC_RATE54M)
125 #define IS_LEGACY_HRATE(_rate) ((_rate) <= DESC_RATE54M)
126 #define IS_HT_HRATE(_rate) ((_rate) >= DESC_RATEMCS0 && (_rate) <= DESC_RATEMCS31)
127 #define IS_VHT_HRATE(_rate) ((_rate) >= DESC_RATEVHTSS1MCS0 && (_rate) <= DESC_RATEVHTSS4MCS9)
128
129 #define IS_HT1SS_HRATE(_rate) ((_rate) >= DESC_RATEMCS0 && (_rate) <= DESC_RATEMCS7)
130 #define IS_HT2SS_HRATE(_rate) ((_rate) >= DESC_RATEMCS8 && (_rate) <= DESC_RATEMCS15)
131 #define IS_HT3SS_HRATE(_rate) ((_rate) >= DESC_RATEMCS16 && (_rate) <= DESC_RATEMCS23)
132 #define IS_HT4SS_HRATE(_rate) ((_rate) >= DESC_RATEMCS24 && (_rate) <= DESC_RATEMCS31)
133
134 #define IS_VHT1SS_HRATE(_rate) ((_rate) >= DESC_RATEVHTSS1MCS0 && (_rate) <= DESC_RATEVHTSS1MCS9)
135 #define IS_VHT2SS_HRATE(_rate) ((_rate) >= DESC_RATEVHTSS2MCS0 && (_rate) <= DESC_RATEVHTSS2MCS9)
136 #define IS_VHT3SS_HRATE(_rate) ((_rate) >= DESC_RATEVHTSS3MCS0 && (_rate) <= DESC_RATEVHTSS3MCS9)
137 #define IS_VHT4SS_HRATE(_rate) ((_rate) >= DESC_RATEVHTSS4MCS0 && (_rate) <= DESC_RATEVHTSS4MCS9)
138
139 #define IS_1SS_HRATE(_rate) (IS_CCK_HRATE((_rate)) || IS_OFDM_HRATE((_rate)) || IS_HT1SS_HRATE((_rate)) || IS_VHT1SS_HRATE((_rate)))
140 #define IS_2SS_HRATE(_rate) (IS_HT2SS_HRATE((_rate)) || IS_VHT2SS_HRATE((_rate)))
141 #define IS_3SS_HRATE(_rate) (IS_HT3SS_HRATE((_rate)) || IS_VHT3SS_HRATE((_rate)))
142 #define IS_4SS_HRATE(_rate) (IS_HT4SS_HRATE((_rate)) || IS_VHT4SS_HRATE((_rate)))
143
144 #define HRARE_SS_NUM(_rate) (IS_1SS_HRATE(_rate) ? 1 : (IS_2SS_HRATE(_rate) ? 2 : (IS_3SS_HRATE(_rate) ? 3 : (IS_4SS_HRATE(_rate) ? 4 : 0))))
145
146 #define HDATA_RATE(rate)\
147 (rate == DESC_RATE1M) ? "CCK_1M" :\
148 (rate == DESC_RATE2M) ? "CCK_2M" :\
149 (rate == DESC_RATE5_5M) ? "CCK5_5M" :\
150 (rate == DESC_RATE11M) ? "CCK_11M" :\
151 (rate == DESC_RATE6M) ? "OFDM_6M" :\
152 (rate == DESC_RATE9M) ? "OFDM_9M" :\
153 (rate == DESC_RATE12M) ? "OFDM_12M" :\
154 (rate == DESC_RATE18M) ? "OFDM_18M" :\
155 (rate == DESC_RATE24M) ? "OFDM_24M" :\
156 (rate == DESC_RATE36M) ? "OFDM_36M" :\
157 (rate == DESC_RATE48M) ? "OFDM_48M" :\
158 (rate == DESC_RATE54M) ? "OFDM_54M" :\
159 (rate == DESC_RATEMCS0) ? "MCS0" :\
160 (rate == DESC_RATEMCS1) ? "MCS1" :\
161 (rate == DESC_RATEMCS2) ? "MCS2" :\
162 (rate == DESC_RATEMCS3) ? "MCS3" :\
163 (rate == DESC_RATEMCS4) ? "MCS4" :\
164 (rate == DESC_RATEMCS5) ? "MCS5" :\
165 (rate == DESC_RATEMCS6) ? "MCS6" :\
166 (rate == DESC_RATEMCS7) ? "MCS7" :\
167 (rate == DESC_RATEMCS8) ? "MCS8" :\
168 (rate == DESC_RATEMCS9) ? "MCS9" :\
169 (rate == DESC_RATEMCS10) ? "MCS10" :\
170 (rate == DESC_RATEMCS11) ? "MCS11" :\
171 (rate == DESC_RATEMCS12) ? "MCS12" :\
172 (rate == DESC_RATEMCS13) ? "MCS13" :\
173 (rate == DESC_RATEMCS14) ? "MCS14" :\
174 (rate == DESC_RATEMCS15) ? "MCS15" :\
175 (rate == DESC_RATEMCS16) ? "MCS16" :\
176 (rate == DESC_RATEMCS17) ? "MCS17" :\
177 (rate == DESC_RATEMCS18) ? "MCS18" :\
178 (rate == DESC_RATEMCS19) ? "MCS19" :\
179 (rate == DESC_RATEMCS20) ? "MCS20" :\
180 (rate == DESC_RATEMCS21) ? "MCS21" :\
181 (rate == DESC_RATEMCS22) ? "MCS22" :\
182 (rate == DESC_RATEMCS23) ? "MCS23" :\
183 (rate == DESC_RATEMCS24) ? "MCS24" :\
184 (rate == DESC_RATEMCS25) ? "MCS25" :\
185 (rate == DESC_RATEMCS26) ? "MCS26" :\
186 (rate == DESC_RATEMCS27) ? "MCS27" :\
187 (rate == DESC_RATEMCS28) ? "MCS28" :\
188 (rate == DESC_RATEMCS29) ? "MCS29" :\
189 (rate == DESC_RATEMCS30) ? "MCS30" :\
190 (rate == DESC_RATEMCS31) ? "MCS31" :\
191 (rate == DESC_RATEVHTSS1MCS0) ? "VHTSS1MCS0" :\
192 (rate == DESC_RATEVHTSS1MCS1) ? "VHTSS1MCS1" :\
193 (rate == DESC_RATEVHTSS1MCS2) ? "VHTSS1MCS2" :\
194 (rate == DESC_RATEVHTSS1MCS3) ? "VHTSS1MCS3" :\
195 (rate == DESC_RATEVHTSS1MCS4) ? "VHTSS1MCS4" :\
196 (rate == DESC_RATEVHTSS1MCS5) ? "VHTSS1MCS5" :\
197 (rate == DESC_RATEVHTSS1MCS6) ? "VHTSS1MCS6" :\
198 (rate == DESC_RATEVHTSS1MCS7) ? "VHTSS1MCS7" :\
199 (rate == DESC_RATEVHTSS1MCS8) ? "VHTSS1MCS8" :\
200 (rate == DESC_RATEVHTSS1MCS9) ? "VHTSS1MCS9" :\
201 (rate == DESC_RATEVHTSS2MCS0) ? "VHTSS2MCS0" :\
202 (rate == DESC_RATEVHTSS2MCS1) ? "VHTSS2MCS1" :\
203 (rate == DESC_RATEVHTSS2MCS2) ? "VHTSS2MCS2" :\
204 (rate == DESC_RATEVHTSS2MCS3) ? "VHTSS2MCS3" :\
205 (rate == DESC_RATEVHTSS2MCS4) ? "VHTSS2MCS4" :\
206 (rate == DESC_RATEVHTSS2MCS5) ? "VHTSS2MCS5" :\
207 (rate == DESC_RATEVHTSS2MCS6) ? "VHTSS2MCS6" :\
208 (rate == DESC_RATEVHTSS2MCS7) ? "VHTSS2MCS7" :\
209 (rate == DESC_RATEVHTSS2MCS8) ? "VHTSS2MCS8" :\
210 (rate == DESC_RATEVHTSS2MCS9) ? "VHTSS2MCS9" :\
211 (rate == DESC_RATEVHTSS3MCS0) ? "VHTSS3MCS0" :\
212 (rate == DESC_RATEVHTSS3MCS1) ? "VHTSS3MCS1" :\
213 (rate == DESC_RATEVHTSS3MCS2) ? "VHTSS3MCS2" :\
214 (rate == DESC_RATEVHTSS3MCS3) ? "VHTSS3MCS3" :\
215 (rate == DESC_RATEVHTSS3MCS4) ? "VHTSS3MCS4" :\
216 (rate == DESC_RATEVHTSS3MCS5) ? "VHTSS3MCS5" :\
217 (rate == DESC_RATEVHTSS3MCS6) ? "VHTSS3MCS6" :\
218 (rate == DESC_RATEVHTSS3MCS7) ? "VHTSS3MCS7" :\
219 (rate == DESC_RATEVHTSS3MCS8) ? "VHTSS3MCS8" :\
220 (rate == DESC_RATEVHTSS3MCS9) ? "VHTSS3MCS9" :\
221 (rate == DESC_RATEVHTSS4MCS0) ? "VHTSS4MCS0" :\
222 (rate == DESC_RATEVHTSS4MCS1) ? "VHTSS4MCS1" :\
223 (rate == DESC_RATEVHTSS4MCS2) ? "VHTSS4MCS2" :\
224 (rate == DESC_RATEVHTSS4MCS3) ? "VHTSS4MCS3" :\
225 (rate == DESC_RATEVHTSS4MCS4) ? "VHTSS4MCS4" :\
226 (rate == DESC_RATEVHTSS4MCS5) ? "VHTSS4MCS5" :\
227 (rate == DESC_RATEVHTSS4MCS6) ? "VHTSS4MCS6" :\
228 (rate == DESC_RATEVHTSS4MCS7) ? "VHTSS4MCS7" :\
229 (rate == DESC_RATEVHTSS4MCS8) ? "VHTSS4MCS8" :\
230 (rate == DESC_RATEVHTSS4MCS9) ? "VHTSS4MCS9" :\
231 "UNKNOWN"
232
233 enum {
234 UP_LINK,
235 DOWN_LINK,
236 };
237 typedef enum _RT_MEDIA_STATUS {
238 RT_MEDIA_DISCONNECT = 0,
239 RT_MEDIA_CONNECT = 1
240 } RT_MEDIA_STATUS;
241
242 #define MAX_DLFW_PAGE_SIZE 4096 /* @ page : 4k bytes */
243 typedef enum _FIRMWARE_SOURCE {
244 FW_SOURCE_IMG_FILE = 0,
245 FW_SOURCE_HEADER_FILE = 1, /* from header file */
246 } FIRMWARE_SOURCE, *PFIRMWARE_SOURCE;
247
248 typedef enum _CH_SW_USE_CASE {
249 CH_SW_USE_CASE_TDLS = 0,
250 CH_SW_USE_CASE_MCC = 1
251 } CH_SW_USE_CASE;
252
253 typedef enum _WAKEUP_REASON{
254 RX_PAIRWISEKEY = 0x01,
255 RX_GTK = 0x02,
256 RX_FOURWAY_HANDSHAKE = 0x03,
257 RX_DISASSOC = 0x04,
258 RX_DEAUTH = 0x08,
259 RX_ARP_REQUEST = 0x09,
260 FW_DECISION_DISCONNECT = 0x10,
261 RX_MAGIC_PKT = 0x21,
262 RX_UNICAST_PKT = 0x22,
263 RX_PATTERN_PKT = 0x23,
264 RTD3_SSID_MATCH = 0x24,
265 RX_REALWOW_V2_WAKEUP_PKT = 0x30,
266 RX_REALWOW_V2_ACK_LOST = 0x31,
267 ENABLE_FAIL_DMA_IDLE = 0x40,
268 ENABLE_FAIL_DMA_PAUSE = 0x41,
269 RTIME_FAIL_DMA_IDLE = 0x42,
270 RTIME_FAIL_DMA_PAUSE = 0x43,
271 RX_PNO = 0x55,
272 AP_OFFLOAD_WAKEUP = 0x66,
273 CLK_32K_UNLOCK = 0xFD,
274 CLK_32K_LOCK = 0xFE
275 }WAKEUP_REASON;
276
277 /*
278 * Queue Select Value in TxDesc
279 * */
280 #define QSLT_BK 0x2/* 0x01 */
281 #define QSLT_BE 0x0
282 #define QSLT_VI 0x5/* 0x4 */
283 #define QSLT_VO 0x7/* 0x6 */
284 #define QSLT_BEACON 0x10
285 #define QSLT_HIGH 0x11
286 #define QSLT_MGNT 0x12
287 #define QSLT_CMD 0x13
288
289 /* BK, BE, VI, VO, HCCA, MANAGEMENT, COMMAND, HIGH, BEACON.
290 * #define MAX_TX_QUEUE 9 */
291
292 #define TX_SELE_HQ BIT(0) /* High Queue */
293 #define TX_SELE_LQ BIT(1) /* Low Queue */
294 #define TX_SELE_NQ BIT(2) /* Normal Queue */
295 #define TX_SELE_EQ BIT(3) /* Extern Queue */
296
297 #define PageNum_128(_Len) (u32)(((_Len)>>7) + ((_Len) & 0x7F ? 1 : 0))
298 #define PageNum_256(_Len) (u32)(((_Len)>>8) + ((_Len) & 0xFF ? 1 : 0))
299 #define PageNum_512(_Len) (u32)(((_Len)>>9) + ((_Len) & 0x1FF ? 1 : 0))
300 #define PageNum(_Len, _Size) (u32)(((_Len)/(_Size)) + ((_Len)&((_Size) - 1) ? 1 : 0))
301
302 struct dbg_rx_counter {
303 u32 rx_pkt_ok;
304 u32 rx_pkt_crc_error;
305 u32 rx_pkt_drop;
306 u32 rx_ofdm_fa;
307 u32 rx_cck_fa;
308 u32 rx_ht_fa;
309 };
310
311 u8 rtw_hal_get_port(_adapter *adapter);
312
313 #ifdef CONFIG_MBSSID_CAM
314 /*#define DBG_MBID_CAM_DUMP*/
315
316 void rtw_mbid_cam_init(struct dvobj_priv *dvobj);
317 void rtw_mbid_cam_deinit(struct dvobj_priv *dvobj);
318 void rtw_mbid_cam_reset(_adapter *adapter);
319 u8 rtw_get_max_mbid_cam_id(_adapter *adapter);
320 u8 rtw_get_mbid_cam_entry_num(_adapter *adapter);
321 int rtw_mbid_cam_cache_dump(void *sel, const char *fun_name , _adapter *adapter);
322 int rtw_mbid_cam_dump(void *sel, const char *fun_name, _adapter *adapter);
323 void rtw_mi_set_mbid_cam(_adapter *adapter);
324 u8 rtw_mbid_camid_alloc(_adapter *adapter, u8 *mac_addr);
325 void rtw_ap_set_mbid_num(_adapter *adapter, u8 ap_num);
326 void rtw_mbid_cam_enable(_adapter *adapter);
327 #endif
328
329 #ifdef CONFIG_MI_WITH_MBSSID_CAM
330 void rtw_hal_set_macaddr_mbid(_adapter *adapter, u8 *mac_addr);
331 void rtw_hal_change_macaddr_mbid(_adapter *adapter, u8 *mac_addr);
332 #ifdef CONFIG_SWTIMER_BASED_TXBCN
333 u16 rtw_hal_bcn_interval_adjust(_adapter *adapter, u16 bcn_interval);
334 #endif
335 void hw_var_set_opmode_mbid(_adapter *Adapter, u8 mode);
336 #endif
337
338 void rtw_dump_mac_rx_counters(_adapter *padapter, struct dbg_rx_counter *rx_counter);
339 void rtw_dump_phy_rx_counters(_adapter *padapter, struct dbg_rx_counter *rx_counter);
340 void rtw_reset_mac_rx_counters(_adapter *padapter);
341 void rtw_reset_phy_rx_counters(_adapter *padapter);
342 void rtw_reset_phy_trx_ok_counters(_adapter *padapter);
343
344 #ifdef DBG_RX_COUNTER_DUMP
345 #define DUMP_DRV_RX_COUNTER BIT0
346 #define DUMP_MAC_RX_COUNTER BIT1
347 #define DUMP_PHY_RX_COUNTER BIT2
348 #define DUMP_DRV_TRX_COUNTER_DATA BIT3
349
350 void rtw_dump_phy_rxcnts_preprocess(_adapter *padapter, u8 rx_cnt_mode);
351 void rtw_dump_rx_counters(_adapter *padapter);
352 #endif
353
354 void dump_chip_info(HAL_VERSION ChipVersion);
355
356 #define BAND_CAP_2G BIT0
357 #define BAND_CAP_5G BIT1
358 #define BAND_CAP_BIT_NUM 2
359
360 #define BW_CAP_5M BIT0
361 #define BW_CAP_10M BIT1
362 #define BW_CAP_20M BIT2
363 #define BW_CAP_40M BIT3
364 #define BW_CAP_80M BIT4
365 #define BW_CAP_160M BIT5
366 #define BW_CAP_80_80M BIT6
367 #define BW_CAP_BIT_NUM 7
368
369 #define PROTO_CAP_11B BIT0
370 #define PROTO_CAP_11G BIT1
371 #define PROTO_CAP_11N BIT2
372 #define PROTO_CAP_11AC BIT3
373 #define PROTO_CAP_BIT_NUM 4
374
375 #define WL_FUNC_P2P BIT0
376 #define WL_FUNC_MIRACAST BIT1
377 #define WL_FUNC_TDLS BIT2
378 #define WL_FUNC_FTM BIT3
379 #define WL_FUNC_BIT_NUM 4
380
381 #define TBTT_PROHIBIT_SETUP_TIME 0x04 /* 128us, unit is 32us */
382 #define TBTT_PROHIBIT_HOLD_TIME 0x80 /* 4ms, unit is 32us*/
383 #define TBTT_PROHIBIT_HOLD_TIME_STOP_BCN 0x64 /* 3.2ms unit is 32us*/
384
385 int hal_spec_init(_adapter *adapter);
386 void dump_hal_spec(void *sel, _adapter *adapter);
387
388 bool hal_chk_band_cap(_adapter *adapter, u8 cap);
389 bool hal_chk_bw_cap(_adapter *adapter, u8 cap);
390 bool hal_chk_proto_cap(_adapter *adapter, u8 cap);
391 bool hal_is_band_support(_adapter *adapter, u8 band);
392 bool hal_is_bw_support(_adapter *adapter, u8 bw);
393 bool hal_is_wireless_mode_support(_adapter *adapter, u8 mode);
394 bool hal_is_mimo_support(_adapter *adapter);
395 u8 hal_largest_bw(_adapter *adapter, u8 in_bw);
396
397 bool hal_chk_wl_func(_adapter *adapter, u8 func);
398
399 void hal_com_config_channel_plan(
400 PADAPTER padapter,
401 char *hw_alpha2,
402 u8 hw_chplan,
403 char *sw_alpha2,
404 u8 sw_chplan,
405 BOOLEAN AutoLoadFail
406 );
407
408 int hal_config_macaddr(_adapter *adapter, bool autoload_fail);
409 #ifdef RTW_HALMAC
410 void rtw_hal_hw_port_enable(_adapter *adapter);
411 void rtw_hal_hw_port_disable(_adapter *adapter);
412 #endif
413
414 BOOLEAN
415 HAL_IsLegalChannel(
416 PADAPTER Adapter,
417 u32 Channel
418 );
419
420 u8 MRateToHwRate(u8 rate);
421
422 u8 hw_rate_to_m_rate(u8 rate);
423
424 void HalSetBrateCfg(
425 PADAPTER Adapter,
426 u8 *mBratesOS,
427 u16 *pBrateCfg);
428
429 BOOLEAN
430 Hal_MappingOutPipe(
431 PADAPTER pAdapter,
432 u8 NumOutPipe
433 );
434
435 void rtw_dump_fw_info(void *sel, _adapter *adapter);
436 void rtw_restore_hw_port_cfg(_adapter *adapter);
437 void rtw_mi_set_mac_addr(_adapter *adapter);/*set mac addr when hal_init for all iface*/
438 void rtw_hal_dump_macaddr(void *sel, _adapter *adapter);
439
440 void rtw_init_hal_com_default_value(PADAPTER Adapter);
441
442 #ifdef CONFIG_FW_C2H_REG
443 void c2h_evt_clear(_adapter *adapter);
444 s32 c2h_evt_read_88xx(_adapter *adapter, u8 *buf);
445 #endif
446
447 #ifdef CONFIG_FW_C2H_PKT
448 void rtw_hal_c2h_pkt_pre_hdl(_adapter *adapter, u8 *buf, u16 len);
449 void rtw_hal_c2h_pkt_hdl(_adapter *adapter, u8 *buf, u16 len);
450 #endif
451
452 u8 rtw_get_mgntframe_raid(_adapter *adapter, unsigned char network_type);
453
454 void rtw_hal_update_sta_wset(_adapter *adapter, struct sta_info *psta);
455 s8 rtw_get_sta_rx_nss(_adapter *adapter, struct sta_info *psta);
456 s8 rtw_get_sta_tx_nss(_adapter *adapter, struct sta_info *psta);
457 void rtw_hal_update_sta_ra_info(PADAPTER padapter, struct sta_info *psta);
458
459 /* access HW only */
460 u32 rtw_sec_read_cam(_adapter *adapter, u8 addr);
461 void rtw_sec_write_cam(_adapter *adapter, u8 addr, u32 wdata);
462 void rtw_sec_read_cam_ent(_adapter *adapter, u8 id, u8 *ctrl, u8 *mac, u8 *key);
463 void rtw_sec_write_cam_ent(_adapter *adapter, u8 id, u16 ctrl, u8 *mac, u8 *key);
464 void rtw_sec_clr_cam_ent(_adapter *adapter, u8 id);
465 bool rtw_sec_read_cam_is_gk(_adapter *adapter, u8 id);
466
467 u8 rtw_hal_rcr_check(_adapter *adapter, u32 check_bit);
468
469 u8 rtw_hal_rcr_add(_adapter *adapter, u32 add);
470 u8 rtw_hal_rcr_clear(_adapter *adapter, u32 clear);
471 void rtw_hal_rcr_set_chk_bssid(_adapter *adapter, u8 self_action);
472
473 void rtw_iface_enable_tsf_update(_adapter *adapter);
474 void rtw_iface_disable_tsf_update(_adapter *adapter);
475 void rtw_hal_periodic_tsf_update_chk(_adapter *adapter);
476 void rtw_hal_periodic_tsf_update_end_timer_hdl(void *ctx);
477
478 #if CONFIG_TX_AC_LIFETIME
479 #define TX_ACLT_CONF_DEFAULT 0
480 #define TX_ACLT_CONF_AP_M2U 1
481 #define TX_ACLT_CONF_MESH 2
482 #define TX_ACLT_CONF_NUM 3
483
484 extern const char *const _tx_aclt_conf_str[];
485 #define tx_aclt_conf_str(conf) (((conf) >= TX_ACLT_CONF_NUM) ? _tx_aclt_conf_str[TX_ACLT_CONF_NUM] : _tx_aclt_conf_str[(conf)])
486
487 struct tx_aclt_conf_t {
488 u8 en;
489 u32 vo_vi;
490 u32 be_bk;
491 };
492
493 void dump_tx_aclt_force_val(void *sel, struct dvobj_priv *dvobj);
494 void rtw_hal_set_tx_aclt_force_val(_adapter *adapter, struct tx_aclt_conf_t *input, u8 arg_num);
495 void dump_tx_aclt_confs(void *sel, struct dvobj_priv *dvobj);
496 void rtw_hal_set_tx_aclt_conf(_adapter *adapter, u8 conf_idx, struct tx_aclt_conf_t *input, u8 arg_num);
497 void rtw_hal_update_tx_aclt(_adapter *adapter);
498 #endif
499
500 void hw_var_port_switch(_adapter *adapter);
501 void rtw_var_set_basic_rate(PADAPTER padapter, u8 *val);
502 u8 SetHwReg(PADAPTER padapter, u8 variable, u8 *val);
503 void GetHwReg(PADAPTER padapter, u8 variable, u8 *val);
504 void rtw_hal_check_rxfifo_full(_adapter *adapter);
505 void rtw_hal_reqtxrpt(_adapter *padapter, u8 macid);
506
507 u8 SetHalDefVar(_adapter *adapter, HAL_DEF_VARIABLE variable, void *value);
508 u8 GetHalDefVar(_adapter *adapter, HAL_DEF_VARIABLE variable, void *value);
509
510 u32
511 MapCharToHexDigit(
512 char chTmp
513 );
514
515 BOOLEAN
516 GetHexValueFromString(
517 char *szStr,
518 u32 *pu4bVal,
519 u32 *pu4bMove
520 );
521
522 BOOLEAN
523 GetFractionValueFromString(
524 char *szStr,
525 u8 *pInteger,
526 u8 *pFraction,
527 u32 *pu4bMove
528 );
529
530 BOOLEAN
531 IsCommentString(
532 char *szStr
533 );
534
535 BOOLEAN
536 ParseQualifiedString(
537 char *In,
538 u32 *Start,
539 char *Out,
540 char LeftQualifier,
541 char RightQualifier
542 );
543
544 BOOLEAN
545 GetU1ByteIntegerFromStringInDecimal(
546 char *Str,
547 u8 *pInt
548 );
549
550 BOOLEAN
551 isAllSpaceOrTab(
552 u8 *data,
553 u8 size
554 );
555
556 void linked_info_dump(_adapter *padapter, u8 benable);
557 #ifdef DBG_RX_SIGNAL_DISPLAY_RAW_DATA
558 void rtw_get_raw_rssi_info(void *sel, _adapter *padapter);
559 void rtw_dump_raw_rssi_info(_adapter *padapter, void *sel);
560 #endif
561
562 #ifdef DBG_RX_DFRAME_RAW_DATA
563 void rtw_dump_rx_dframe_info(_adapter *padapter, void *sel);
564 #endif
565 void rtw_store_phy_info(_adapter *padapter, union recv_frame *prframe);
566 #define HWSET_MAX_SIZE 1024
567
568 #ifdef CONFIG_EFUSE_CONFIG_FILE
569 u32 Hal_readPGDataFromConfigFile(PADAPTER padapter);
570 u32 Hal_ReadMACAddrFromFile(PADAPTER padapter, u8 *mac_addr);
571 #endif /* CONFIG_EFUSE_CONFIG_FILE */
572
573 int hal_efuse_macaddr_offset(_adapter *adapter);
574 int Hal_GetPhyEfuseMACAddr(PADAPTER padapter, u8 *mac_addr);
575 void rtw_dump_cur_efuse(PADAPTER padapter);
576
577 #ifdef CONFIG_RF_POWER_TRIM
578 void rtw_bb_rf_gain_offset(_adapter *padapter);
579 #endif /*CONFIG_RF_POWER_TRIM*/
580
581 void dm_DynamicUsbTxAgg(_adapter *padapter, u8 from_timer);
582 u8 rtw_hal_busagg_qsel_check(_adapter *padapter, u8 pre_qsel, u8 next_qsel);
583
584 u8 rtw_get_current_tx_rate(_adapter *padapter, struct sta_info *psta);
585 u8 rtw_get_current_tx_sgi(_adapter *padapter, struct sta_info *psta);
586 #ifdef CONFIG_CUSTOMER01_SMART_ANTENNA
587 void rtw_hal_set_pathb_phase(_adapter *adapter, u8 phase_idx);
588 #endif
589 void rtw_hal_set_fw_rsvd_page(_adapter *adapter, bool finished);
590 u8 rtw_hal_get_rsvd_page_num(struct _ADAPTER *adapter);
591
592 #ifdef CONFIG_TSF_RESET_OFFLOAD
593 int rtw_hal_reset_tsf(_adapter *adapter, u8 reset_port);
594 #endif
595 u64 rtw_hal_get_tsftr_by_port(_adapter *adapter, u8 port);
596
597 #ifdef CONFIG_TDLS
598 #ifdef CONFIG_TDLS_CH_SW
599 s32 rtw_hal_ch_sw_oper_offload(_adapter *padapter, u8 channel, u8 channel_offset, u16 bwmode);
600 #endif
601 #endif
602 #if defined(CONFIG_BT_COEXIST) && defined(CONFIG_FW_MULTI_PORT_SUPPORT)
603 s32 rtw_hal_set_wifi_btc_port_id_cmd(_adapter *adapter);
604 #endif
605
606 void rtw_lps_state_chk(_adapter *adapter, u8 ps_mode);
607
608 #ifdef CONFIG_GPIO_API
609 u8 rtw_hal_get_gpio(_adapter *adapter, u8 gpio_num);
610 int rtw_hal_set_gpio_output_value(_adapter *adapter, u8 gpio_num, bool isHigh);
611 int rtw_hal_config_gpio(_adapter *adapter, u8 gpio_num, bool isOutput);
612 int rtw_hal_register_gpio_interrupt(_adapter *adapter, int gpio_num, void(*callback)(u8 level));
613 int rtw_hal_disable_gpio_interrupt(_adapter *adapter, int gpio_num);
614 #endif
615
616 s8 rtw_hal_ch_sw_iqk_info_search(_adapter *padapter, u8 central_chnl, u8 bw_mode);
617 void rtw_hal_ch_sw_iqk_info_backup(_adapter *adapter);
618 void rtw_hal_ch_sw_iqk_info_restore(_adapter *padapter, u8 ch_sw_use_case);
619
620 #ifdef CONFIG_GPIO_WAKEUP
621 void rtw_hal_switch_gpio_wl_ctrl(_adapter *padapter, u8 index, u8 enable);
622 void rtw_hal_set_output_gpio(_adapter *padapter, u8 index, u8 outputval);
623 void rtw_hal_set_input_gpio(_adapter *padapter, u8 index);
624 #define GPIO_OUTPUT_LOW 0
625 #define GPIO_OUTPUT_HIGH 1
626 #endif
627
628 #ifdef CONFIG_LOAD_PHY_PARA_FROM_FILE
629 extern char *rtw_phy_file_path;
630 extern char rtw_phy_para_file_path[PATH_LENGTH_MAX];
631 #define GetLineFromBuffer(buffer) strsep(&buffer, "\r\n")
632 #endif
633
634 void update_IOT_info(_adapter *padapter);
635 #ifdef CONFIG_RTS_FULL_BW
636 void rtw_set_rts_bw(_adapter *padapter);
637 #endif/*CONFIG_RTS_FULL_BW*/
638
639 void ResumeTxBeacon(_adapter *padapter);
640 void StopTxBeacon(_adapter *padapter);
641
642 #ifdef CONFIG_ANTENNA_DIVERSITY
643 u8 rtw_hal_antdiv_before_linked(_adapter *padapter);
644 void rtw_hal_antdiv_rssi_compared(_adapter *padapter, WLAN_BSSID_EX *dst, WLAN_BSSID_EX *src);
645 #endif
646
647 #ifdef DBG_SEC_CAM_MOVE
648 void rtw_hal_move_sta_gk_to_dk(_adapter *adapter);
649 void rtw_hal_read_sta_dk_key(_adapter *adapter, u8 key_id);
650 #endif
651
652 #ifdef CONFIG_LPS_PG
653 #define LPSPG_RSVD_PAGE_SET_MACID(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 0, 8, _value)/*used macid*/
654 #define LPSPG_RSVD_PAGE_SET_MBSSCAMID(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 8, 8, _value)/*used BSSID CAM entry*/
655 #define LPSPG_RSVD_PAGE_SET_PMC_NUM(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 16, 8, _value)/*Max used Pattern Match CAM entry*/
656 #define LPSPG_RSVD_PAGE_SET_MU_RAID_GID(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 24, 8, _value)/*Max MU rate table Group ID*/
657 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_NUM(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x04, 0, 8, _value)/*used Security CAM entry number*/
658 #define LPSPG_RSVD_PAGE_SET_DRV_RSVDPAGE_NUM(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x04, 8, 8, _value)/*Txbuf used page number for fw offload*/
659 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID1(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 0, 8, _value)/*used Security CAM entry -1*/
660 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID2(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 8, 8, _value)/*used Security CAM entry -2*/
661 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID3(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 16, 8, _value)/*used Security CAM entry -3*/
662 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID4(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 24, 8, _value)/*used Security CAM entry -4*/
663 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID5(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 0, 8, _value)/*used Security CAM entry -5*/
664 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID6(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 8, 8, _value)/*used Security CAM entry -6*/
665 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID7(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 16, 8, _value)/*used Security CAM entry -7*/
666 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID8(_rsvd_pag, _value) SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 24, 8, _value)/*used Security CAM entry -8*/
667 enum lps_pg_hdl_id {
668 LPS_PG_INFO_CFG = 0,
669 LPS_PG_REDLEMEM,
670 LPS_PG_PHYDM_DIS,
671 LPS_PG_PHYDM_EN,
672 };
673
674 u8 rtw_hal_set_lps_pg_info_cmd(_adapter *adapter);
675 u8 rtw_hal_set_lps_pg_info(_adapter *adapter);
676 #endif
677
678 int rtw_hal_get_rsvd_page(_adapter *adapter, u32 page_offset, u32 page_num, u8 *buffer, u32 buffer_size);
679 void rtw_hal_construct_beacon(_adapter *padapter, u8 *pframe, u32 *pLength);
680 void rtw_hal_construct_NullFunctionData(PADAPTER, u8 *pframe, u32 *pLength,
681 u8 bQoS, u8 AC, u8 bEosp, u8 bForcePowerSave);
682
683 bool _rtw_wow_chk_cap(_adapter *adapter, u8 cap);
684 #ifdef CONFIG_WOWLAN
685 struct rtl_wow_pattern {
686 u16 crc;
687 u8 type;
688 u32 mask[4];
689 };
690 void rtw_wow_pattern_cam_dump(_adapter *adapter);
691
692 #ifdef CONFIG_WOW_PATTERN_HW_CAM
693 void rtw_wow_pattern_read_cam_ent(_adapter *adapter, u8 id, struct rtl_wow_pattern *context);
694 void rtw_dump_wow_pattern(void *sel, struct rtl_wow_pattern *pwow_pattern, u8 idx);
695 #endif
696
697 struct rtw_ndp_info {
698 u8 enable:1;
699 u8 check_remote_ip:1; /* Need to Check Sender IP or not */
700 u8 rsvd:6;
701 u8 num_of_target_ip; /* Number of Check IP which NA query IP */
702 u8 target_link_addr[6]; /* DUT's MAC address */
703 u8 remote_ipv6_addr[16]; /* Just respond IP */
704 u8 target_ipv6_addr[16]; /* target IP */
705 };
706 #define REMOTE_INFO_CTRL_SET_VALD_EN(target, _value) \
707 SET_BITS_TO_LE_4BYTE(target + 0, 0, 8, _value)
708 #define REMOTE_INFO_CTRL_SET_PTK_EN(target, _value) \
709 SET_BITS_TO_LE_4BYTE(target + 1, 0, 1, _value)
710 #define REMOTE_INFO_CTRL_SET_GTK_EN(target, _value) \
711 SET_BITS_TO_LE_4BYTE(target + 1, 1, 1, _value)
712 #define REMOTE_INFO_CTRL_SET_GTK_IDX(target, _value) \
713 SET_BITS_TO_LE_4BYTE(target + 2, 0, 8, _value)
714 #endif /*CONFIG_WOWLAN*/
715
716 void rtw_dump_phy_cap(void *sel, _adapter *adapter);
717 void rtw_dump_rsvd_page(void *sel, _adapter *adapter, u8 page_offset, u8 page_num);
718 #ifdef CONFIG_SUPPORT_FIFO_DUMP
719 void rtw_dump_fifo(void *sel, _adapter *adapter, u8 fifo_sel, u32 fifo_addr, u32 fifo_size);
720 #endif
721
722 #ifdef CONFIG_FW_MULTI_PORT_SUPPORT
723 s32 rtw_hal_set_default_port_id_cmd(_adapter *adapter, u8 mac_id);
724 s32 rtw_set_default_port_id(_adapter *adapter);
725 s32 rtw_set_ps_rsvd_page(_adapter *adapter);
726
727 #define get_dft_portid(adapter) (adapter_to_dvobj(adapter)->dft.port_id)
728 #define get_dft_macid(adapter) (adapter_to_dvobj(adapter)->dft.mac_id)
729
730 /*void rtw_search_default_port(_adapter *adapter);*/
731 #endif
732
733 #ifdef CONFIG_P2P_PS
734 #ifdef RTW_HALMAC
735 void rtw_set_p2p_ps_offload_cmd(_adapter *adapter, u8 p2p_ps_state);
736 #endif
737 #endif
738
739 #ifdef RTW_CHANNEL_SWITCH_OFFLOAD
740 void rtw_hal_switch_chnl_and_set_bw_offload(_adapter *adapter, u8 central_ch, u8 pri_ch_idx, u8 bw);
741 #endif
742
743 s16 translate_dbm_to_percentage(s16 signal);
744
745 #ifdef CONFIG_SUPPORT_MULTI_BCN
746 void rtw_ap_multi_bcn_cfg(_adapter *adapter);
747 #endif
748
749 #ifdef CONFIG_SWTIMER_BASED_TXBCN
750 #ifdef CONFIG_BCN_RECOVERY
751 u8 rtw_ap_bcn_recovery(_adapter *padapter);
752 #endif
753 #ifdef CONFIG_BCN_XMIT_PROTECT
754 u8 rtw_ap_bcn_queue_empty_check(_adapter *padapter, u32 txbcn_timer_ms);
755 #endif
756 #endif /*CONFIG_SWTIMER_BASED_TXBCN*/
757
758 #ifdef CONFIG_FW_HANDLE_TXBCN
759 void rtw_ap_mbid_bcn_en(_adapter *adapter, u8 mbcn_id);
760 void rtw_ap_mbid_bcn_dis(_adapter *adapter, u8 mbcn_id);
761 #endif
762
763 void rtw_hal_get_trx_path(struct dvobj_priv *d, enum rf_type *type,
764 enum bb_path *tx, enum bb_path *rx);
765 #ifdef CONFIG_BEAMFORMING
766 #ifdef RTW_BEAMFORMING_VERSION_2
767 void rtw_hal_beamforming_config_csirate(PADAPTER adapter);
768 #endif
769 #endif
770
771 u8 phy_get_current_tx_num(PADAPTER pAdapter, u8 Rate);
772
773 #ifdef CONFIG_RTL8812A
774 u8 * rtw_hal_set_8812a_vendor_ie(_adapter *padapter , u8 *pframe ,uint *frlen );
775 #endif
776
777 #ifdef CONFIG_PROTSEL_PORT
778 void rtw_enter_protsel_port(_adapter *padapter, u8 port_sel);
779 bool rtw_assert_protsel_port(_adapter *padapter, u32 addr, u8 len);
780 void rtw_leave_protsel_port(_adapter *padapter);
781 #else
rtw_enter_protsel_port(_adapter * padapter,u8 port_sel)782 static inline void rtw_enter_protsel_port(_adapter *padapter, u8 port_sel) {}
rtw_assert_protsel_port(_adapter * padapter,u32 addr,u8 len)783 static inline bool rtw_assert_protsel_port(_adapter *padapter, u32 addr, u8 len) {return true; }
rtw_leave_protsel_port(_adapter * padapter)784 static inline void rtw_leave_protsel_port(_adapter *padapter) {}
785 #endif
786 #ifdef CONFIG_PROTSEL_ATIMDTIM
787 void rtw_enter_protsel_atimdtim(_adapter *padapter, u8 port_sel);
788 bool rtw_assert_protsel_atimdtim(_adapter *padapter, u32 addr, u8 len);
789 void rtw_leave_protsel_atimdtim(_adapter *padapter);
790 #else
rtw_enter_protsel_atimdtim(_adapter * padapter,u8 port_sel)791 static inline void rtw_enter_protsel_atimdtim(_adapter *padapter, u8 port_sel) {}
rtw_assert_protsel_atimdtim(_adapter * padapter,u32 addr,u8 len)792 static inline bool rtw_assert_protsel_atimdtim(_adapter *padapter, u32 addr, u8 len) {return true; }
rtw_leave_protsel_atimdtim(_adapter * padapter)793 static inline void rtw_leave_protsel_atimdtim(_adapter *padapter) {}
794 #endif
795 #ifdef CONFIG_PROTSEL_MACSLEEP
796 void rtw_enter_protsel_macsleep(_adapter *padapter, u8 sel);
797 bool rtw_assert_protsel_macsleep(_adapter *padapter, u32 addr, u8 len);
798 void rtw_leave_protsel_macsleep(_adapter *padapter);
799 #else
rtw_enter_protsel_macsleep(_adapter * padapter,u8 port_sel)800 static inline void rtw_enter_protsel_macsleep(_adapter *padapter, u8 port_sel) {}
rtw_assert_protsel_macsleep(_adapter * padapter,u32 addr,u8 len)801 static inline bool rtw_assert_protsel_macsleep(_adapter *padapter, u32 addr, u8 len) {return true; }
rtw_leave_protsel_macsleep(_adapter * padapter)802 static inline void rtw_leave_protsel_macsleep(_adapter *padapter) {}
803 #endif
804 #endif /* __HAL_COMMON_H__ */
805