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