1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /* Copyright(c) 2018-2019  Realtek Corporation
3  */
4 
5 #ifndef __RTK_MAIN_H_
6 #define __RTK_MAIN_H_
7 
8 #include <net/mac80211.h>
9 #include <linux/vmalloc.h>
10 #include <linux/firmware.h>
11 #include <linux/average.h>
12 #include <linux/bitops.h>
13 #include <linux/bitfield.h>
14 #include <linux/iopoll.h>
15 #include <linux/interrupt.h>
16 #include <linux/workqueue.h>
17 
18 #include "util.h"
19 
20 #define RTW_NAPI_WEIGHT_NUM		64
21 #define RTW_MAX_MAC_ID_NUM		32
22 #define RTW_MAX_SEC_CAM_NUM		32
23 #define MAX_PG_CAM_BACKUP_NUM		8
24 
25 #define RTW_MAX_PATTERN_NUM		12
26 #define RTW_MAX_PATTERN_MASK_SIZE	16
27 #define RTW_MAX_PATTERN_SIZE		128
28 
29 #define RTW_WATCH_DOG_DELAY_TIME	round_jiffies_relative(HZ * 2)
30 
31 #define RFREG_MASK			0xfffff
32 #define INV_RF_DATA			0xffffffff
33 #define TX_PAGE_SIZE_SHIFT		7
34 
35 #define RTW_CHANNEL_WIDTH_MAX		3
36 #define RTW_RF_PATH_MAX			4
37 #define HW_FEATURE_LEN			13
38 
39 #define RTW_TP_SHIFT			18 /* bytes/2s --> Mbps */
40 
41 extern bool rtw_bf_support;
42 extern bool rtw_disable_lps_deep_mode;
43 extern unsigned int rtw_debug_mask;
44 extern bool rtw_edcca_enabled;
45 extern const struct ieee80211_ops rtw_ops;
46 
47 #define RTW_MAX_CHANNEL_NUM_2G 14
48 #define RTW_MAX_CHANNEL_NUM_5G 49
49 
50 struct rtw_dev;
51 
52 enum rtw_hci_type {
53 	RTW_HCI_TYPE_PCIE,
54 	RTW_HCI_TYPE_USB,
55 	RTW_HCI_TYPE_SDIO,
56 
57 	RTW_HCI_TYPE_UNDEFINE,
58 };
59 
60 struct rtw_hci {
61 	struct rtw_hci_ops *ops;
62 	enum rtw_hci_type type;
63 
64 	u32 rpwm_addr;
65 	u32 cpwm_addr;
66 
67 	u8 bulkout_num;
68 };
69 
70 #define IS_CH_5G_BAND_1(channel) ((channel) >= 36 && (channel <= 48))
71 #define IS_CH_5G_BAND_2(channel) ((channel) >= 52 && (channel <= 64))
72 #define IS_CH_5G_BAND_3(channel) ((channel) >= 100 && (channel <= 144))
73 #define IS_CH_5G_BAND_4(channel) ((channel) >= 149 && (channel <= 177))
74 
75 #define IS_CH_5G_BAND_MID(channel) \
76 	(IS_CH_5G_BAND_2(channel) || IS_CH_5G_BAND_3(channel))
77 
78 #define IS_CH_2G_BAND(channel) ((channel) <= 14)
79 #define IS_CH_5G_BAND(channel) \
80 	(IS_CH_5G_BAND_1(channel) || IS_CH_5G_BAND_2(channel) || \
81 	 IS_CH_5G_BAND_3(channel) || IS_CH_5G_BAND_4(channel))
82 
83 enum rtw_supported_band {
84 	RTW_BAND_2G = 1 << 0,
85 	RTW_BAND_5G = 1 << 1,
86 	RTW_BAND_60G = 1 << 2,
87 
88 	RTW_BAND_MAX,
89 };
90 
91 /* now, support upto 80M bw */
92 #define RTW_MAX_CHANNEL_WIDTH RTW_CHANNEL_WIDTH_80
93 
94 enum rtw_bandwidth {
95 	RTW_CHANNEL_WIDTH_20	= 0,
96 	RTW_CHANNEL_WIDTH_40	= 1,
97 	RTW_CHANNEL_WIDTH_80	= 2,
98 	RTW_CHANNEL_WIDTH_160	= 3,
99 	RTW_CHANNEL_WIDTH_80_80	= 4,
100 	RTW_CHANNEL_WIDTH_5	= 5,
101 	RTW_CHANNEL_WIDTH_10	= 6,
102 };
103 
104 enum rtw_sc_offset {
105 	RTW_SC_DONT_CARE	= 0,
106 	RTW_SC_20_UPPER		= 1,
107 	RTW_SC_20_LOWER		= 2,
108 	RTW_SC_20_UPMOST	= 3,
109 	RTW_SC_20_LOWEST	= 4,
110 	RTW_SC_40_UPPER		= 9,
111 	RTW_SC_40_LOWER		= 10,
112 };
113 
114 enum rtw_net_type {
115 	RTW_NET_NO_LINK		= 0,
116 	RTW_NET_AD_HOC		= 1,
117 	RTW_NET_MGD_LINKED	= 2,
118 	RTW_NET_AP_MODE		= 3,
119 };
120 
121 enum rtw_rf_type {
122 	RF_1T1R			= 0,
123 	RF_1T2R			= 1,
124 	RF_2T2R			= 2,
125 	RF_2T3R			= 3,
126 	RF_2T4R			= 4,
127 	RF_3T3R			= 5,
128 	RF_3T4R			= 6,
129 	RF_4T4R			= 7,
130 	RF_TYPE_MAX,
131 };
132 
133 enum rtw_rf_path {
134 	RF_PATH_A = 0,
135 	RF_PATH_B = 1,
136 	RF_PATH_C = 2,
137 	RF_PATH_D = 3,
138 };
139 
140 enum rtw_bb_path {
141 	BB_PATH_A = BIT(0),
142 	BB_PATH_B = BIT(1),
143 	BB_PATH_C = BIT(2),
144 	BB_PATH_D = BIT(3),
145 
146 	BB_PATH_AB = (BB_PATH_A | BB_PATH_B),
147 	BB_PATH_AC = (BB_PATH_A | BB_PATH_C),
148 	BB_PATH_AD = (BB_PATH_A | BB_PATH_D),
149 	BB_PATH_BC = (BB_PATH_B | BB_PATH_C),
150 	BB_PATH_BD = (BB_PATH_B | BB_PATH_D),
151 	BB_PATH_CD = (BB_PATH_C | BB_PATH_D),
152 
153 	BB_PATH_ABC = (BB_PATH_A | BB_PATH_B | BB_PATH_C),
154 	BB_PATH_ABD = (BB_PATH_A | BB_PATH_B | BB_PATH_D),
155 	BB_PATH_ACD = (BB_PATH_A | BB_PATH_C | BB_PATH_D),
156 	BB_PATH_BCD = (BB_PATH_B | BB_PATH_C | BB_PATH_D),
157 
158 	BB_PATH_ABCD = (BB_PATH_A | BB_PATH_B | BB_PATH_C | BB_PATH_D),
159 };
160 
161 enum rtw_rate_section {
162 	RTW_RATE_SECTION_CCK = 0,
163 	RTW_RATE_SECTION_OFDM,
164 	RTW_RATE_SECTION_HT_1S,
165 	RTW_RATE_SECTION_HT_2S,
166 	RTW_RATE_SECTION_VHT_1S,
167 	RTW_RATE_SECTION_VHT_2S,
168 
169 	/* keep last */
170 	RTW_RATE_SECTION_MAX,
171 };
172 
173 enum rtw_wireless_set {
174 	WIRELESS_CCK	= 0x00000001,
175 	WIRELESS_OFDM	= 0x00000002,
176 	WIRELESS_HT	= 0x00000004,
177 	WIRELESS_VHT	= 0x00000008,
178 };
179 
180 #define HT_STBC_EN	BIT(0)
181 #define VHT_STBC_EN	BIT(1)
182 #define HT_LDPC_EN	BIT(0)
183 #define VHT_LDPC_EN	BIT(1)
184 
185 enum rtw_chip_type {
186 	RTW_CHIP_TYPE_8822B,
187 	RTW_CHIP_TYPE_8822C,
188 	RTW_CHIP_TYPE_8723D,
189 	RTW_CHIP_TYPE_8821C,
190 };
191 
192 enum rtw_tx_queue_type {
193 	/* the order of AC queues matters */
194 	RTW_TX_QUEUE_BK = 0x0,
195 	RTW_TX_QUEUE_BE = 0x1,
196 	RTW_TX_QUEUE_VI = 0x2,
197 	RTW_TX_QUEUE_VO = 0x3,
198 
199 	RTW_TX_QUEUE_BCN = 0x4,
200 	RTW_TX_QUEUE_MGMT = 0x5,
201 	RTW_TX_QUEUE_HI0 = 0x6,
202 	RTW_TX_QUEUE_H2C = 0x7,
203 	/* keep it last */
204 	RTK_MAX_TX_QUEUE_NUM
205 };
206 
207 enum rtw_rx_queue_type {
208 	RTW_RX_QUEUE_MPDU = 0x0,
209 	RTW_RX_QUEUE_C2H = 0x1,
210 	/* keep it last */
211 	RTK_MAX_RX_QUEUE_NUM
212 };
213 
214 enum rtw_fw_type {
215 	RTW_NORMAL_FW = 0x0,
216 	RTW_WOWLAN_FW = 0x1,
217 };
218 
219 enum rtw_rate_index {
220 	RTW_RATEID_BGN_40M_2SS	= 0,
221 	RTW_RATEID_BGN_40M_1SS	= 1,
222 	RTW_RATEID_BGN_20M_2SS	= 2,
223 	RTW_RATEID_BGN_20M_1SS	= 3,
224 	RTW_RATEID_GN_N2SS	= 4,
225 	RTW_RATEID_GN_N1SS	= 5,
226 	RTW_RATEID_BG		= 6,
227 	RTW_RATEID_G		= 7,
228 	RTW_RATEID_B_20M	= 8,
229 	RTW_RATEID_ARFR0_AC_2SS	= 9,
230 	RTW_RATEID_ARFR1_AC_1SS	= 10,
231 	RTW_RATEID_ARFR2_AC_2G_1SS = 11,
232 	RTW_RATEID_ARFR3_AC_2G_2SS = 12,
233 	RTW_RATEID_ARFR4_AC_3SS	= 13,
234 	RTW_RATEID_ARFR5_N_3SS	= 14,
235 	RTW_RATEID_ARFR7_N_4SS	= 15,
236 	RTW_RATEID_ARFR6_AC_4SS	= 16
237 };
238 
239 enum rtw_trx_desc_rate {
240 	DESC_RATE1M	= 0x00,
241 	DESC_RATE2M	= 0x01,
242 	DESC_RATE5_5M	= 0x02,
243 	DESC_RATE11M	= 0x03,
244 
245 	DESC_RATE6M	= 0x04,
246 	DESC_RATE9M	= 0x05,
247 	DESC_RATE12M	= 0x06,
248 	DESC_RATE18M	= 0x07,
249 	DESC_RATE24M	= 0x08,
250 	DESC_RATE36M	= 0x09,
251 	DESC_RATE48M	= 0x0a,
252 	DESC_RATE54M	= 0x0b,
253 
254 	DESC_RATEMCS0	= 0x0c,
255 	DESC_RATEMCS1	= 0x0d,
256 	DESC_RATEMCS2	= 0x0e,
257 	DESC_RATEMCS3	= 0x0f,
258 	DESC_RATEMCS4	= 0x10,
259 	DESC_RATEMCS5	= 0x11,
260 	DESC_RATEMCS6	= 0x12,
261 	DESC_RATEMCS7	= 0x13,
262 	DESC_RATEMCS8	= 0x14,
263 	DESC_RATEMCS9	= 0x15,
264 	DESC_RATEMCS10	= 0x16,
265 	DESC_RATEMCS11	= 0x17,
266 	DESC_RATEMCS12	= 0x18,
267 	DESC_RATEMCS13	= 0x19,
268 	DESC_RATEMCS14	= 0x1a,
269 	DESC_RATEMCS15	= 0x1b,
270 	DESC_RATEMCS16	= 0x1c,
271 	DESC_RATEMCS17	= 0x1d,
272 	DESC_RATEMCS18	= 0x1e,
273 	DESC_RATEMCS19	= 0x1f,
274 	DESC_RATEMCS20	= 0x20,
275 	DESC_RATEMCS21	= 0x21,
276 	DESC_RATEMCS22	= 0x22,
277 	DESC_RATEMCS23	= 0x23,
278 	DESC_RATEMCS24	= 0x24,
279 	DESC_RATEMCS25	= 0x25,
280 	DESC_RATEMCS26	= 0x26,
281 	DESC_RATEMCS27	= 0x27,
282 	DESC_RATEMCS28	= 0x28,
283 	DESC_RATEMCS29	= 0x29,
284 	DESC_RATEMCS30	= 0x2a,
285 	DESC_RATEMCS31	= 0x2b,
286 
287 	DESC_RATEVHT1SS_MCS0	= 0x2c,
288 	DESC_RATEVHT1SS_MCS1	= 0x2d,
289 	DESC_RATEVHT1SS_MCS2	= 0x2e,
290 	DESC_RATEVHT1SS_MCS3	= 0x2f,
291 	DESC_RATEVHT1SS_MCS4	= 0x30,
292 	DESC_RATEVHT1SS_MCS5	= 0x31,
293 	DESC_RATEVHT1SS_MCS6	= 0x32,
294 	DESC_RATEVHT1SS_MCS7	= 0x33,
295 	DESC_RATEVHT1SS_MCS8	= 0x34,
296 	DESC_RATEVHT1SS_MCS9	= 0x35,
297 
298 	DESC_RATEVHT2SS_MCS0	= 0x36,
299 	DESC_RATEVHT2SS_MCS1	= 0x37,
300 	DESC_RATEVHT2SS_MCS2	= 0x38,
301 	DESC_RATEVHT2SS_MCS3	= 0x39,
302 	DESC_RATEVHT2SS_MCS4	= 0x3a,
303 	DESC_RATEVHT2SS_MCS5	= 0x3b,
304 	DESC_RATEVHT2SS_MCS6	= 0x3c,
305 	DESC_RATEVHT2SS_MCS7	= 0x3d,
306 	DESC_RATEVHT2SS_MCS8	= 0x3e,
307 	DESC_RATEVHT2SS_MCS9	= 0x3f,
308 
309 	DESC_RATEVHT3SS_MCS0	= 0x40,
310 	DESC_RATEVHT3SS_MCS1	= 0x41,
311 	DESC_RATEVHT3SS_MCS2	= 0x42,
312 	DESC_RATEVHT3SS_MCS3	= 0x43,
313 	DESC_RATEVHT3SS_MCS4	= 0x44,
314 	DESC_RATEVHT3SS_MCS5	= 0x45,
315 	DESC_RATEVHT3SS_MCS6	= 0x46,
316 	DESC_RATEVHT3SS_MCS7	= 0x47,
317 	DESC_RATEVHT3SS_MCS8	= 0x48,
318 	DESC_RATEVHT3SS_MCS9	= 0x49,
319 
320 	DESC_RATEVHT4SS_MCS0	= 0x4a,
321 	DESC_RATEVHT4SS_MCS1	= 0x4b,
322 	DESC_RATEVHT4SS_MCS2	= 0x4c,
323 	DESC_RATEVHT4SS_MCS3	= 0x4d,
324 	DESC_RATEVHT4SS_MCS4	= 0x4e,
325 	DESC_RATEVHT4SS_MCS5	= 0x4f,
326 	DESC_RATEVHT4SS_MCS6	= 0x50,
327 	DESC_RATEVHT4SS_MCS7	= 0x51,
328 	DESC_RATEVHT4SS_MCS8	= 0x52,
329 	DESC_RATEVHT4SS_MCS9	= 0x53,
330 
331 	DESC_RATE_MAX,
332 };
333 
334 enum rtw_regulatory_domains {
335 	RTW_REGD_FCC		= 0,
336 	RTW_REGD_MKK		= 1,
337 	RTW_REGD_ETSI		= 2,
338 	RTW_REGD_IC		= 3,
339 	RTW_REGD_KCC		= 4,
340 	RTW_REGD_ACMA		= 5,
341 	RTW_REGD_CHILE		= 6,
342 	RTW_REGD_UKRAINE	= 7,
343 	RTW_REGD_MEXICO		= 8,
344 	RTW_REGD_CN		= 9,
345 	RTW_REGD_WW,
346 
347 	RTW_REGD_MAX
348 };
349 
350 enum rtw_txq_flags {
351 	RTW_TXQ_AMPDU,
352 	RTW_TXQ_BLOCK_BA,
353 };
354 
355 enum rtw_flags {
356 	RTW_FLAG_RUNNING,
357 	RTW_FLAG_FW_RUNNING,
358 	RTW_FLAG_SCANNING,
359 	RTW_FLAG_INACTIVE_PS,
360 	RTW_FLAG_LEISURE_PS,
361 	RTW_FLAG_LEISURE_PS_DEEP,
362 	RTW_FLAG_DIG_DISABLE,
363 	RTW_FLAG_BUSY_TRAFFIC,
364 	RTW_FLAG_WOWLAN,
365 	RTW_FLAG_RESTARTING,
366 
367 	NUM_OF_RTW_FLAGS,
368 };
369 
370 enum rtw_evm {
371 	RTW_EVM_OFDM = 0,
372 	RTW_EVM_1SS,
373 	RTW_EVM_2SS_A,
374 	RTW_EVM_2SS_B,
375 	/* keep it last */
376 	RTW_EVM_NUM
377 };
378 
379 enum rtw_snr {
380 	RTW_SNR_OFDM_A = 0,
381 	RTW_SNR_OFDM_B,
382 	RTW_SNR_OFDM_C,
383 	RTW_SNR_OFDM_D,
384 	RTW_SNR_1SS_A,
385 	RTW_SNR_1SS_B,
386 	RTW_SNR_1SS_C,
387 	RTW_SNR_1SS_D,
388 	RTW_SNR_2SS_A,
389 	RTW_SNR_2SS_B,
390 	RTW_SNR_2SS_C,
391 	RTW_SNR_2SS_D,
392 	/* keep it last */
393 	RTW_SNR_NUM
394 };
395 
396 enum rtw_wow_flags {
397 	RTW_WOW_FLAG_EN_MAGIC_PKT,
398 	RTW_WOW_FLAG_EN_REKEY_PKT,
399 	RTW_WOW_FLAG_EN_DISCONNECT,
400 
401 	/* keep it last */
402 	RTW_WOW_FLAG_MAX,
403 };
404 
405 /* the power index is represented by differences, which cck-1s & ht40-1s are
406  * the base values, so for 1s's differences, there are only ht20 & ofdm
407  */
408 struct rtw_2g_1s_pwr_idx_diff {
409 #ifdef __LITTLE_ENDIAN
410 	s8 ofdm:4;
411 	s8 bw20:4;
412 #else
413 	s8 bw20:4;
414 	s8 ofdm:4;
415 #endif
416 } __packed;
417 
418 struct rtw_2g_ns_pwr_idx_diff {
419 #ifdef __LITTLE_ENDIAN
420 	s8 bw20:4;
421 	s8 bw40:4;
422 	s8 cck:4;
423 	s8 ofdm:4;
424 #else
425 	s8 ofdm:4;
426 	s8 cck:4;
427 	s8 bw40:4;
428 	s8 bw20:4;
429 #endif
430 } __packed;
431 
432 struct rtw_2g_txpwr_idx {
433 	u8 cck_base[6];
434 	u8 bw40_base[5];
435 	struct rtw_2g_1s_pwr_idx_diff ht_1s_diff;
436 	struct rtw_2g_ns_pwr_idx_diff ht_2s_diff;
437 	struct rtw_2g_ns_pwr_idx_diff ht_3s_diff;
438 	struct rtw_2g_ns_pwr_idx_diff ht_4s_diff;
439 };
440 
441 struct rtw_5g_ht_1s_pwr_idx_diff {
442 #ifdef __LITTLE_ENDIAN
443 	s8 ofdm:4;
444 	s8 bw20:4;
445 #else
446 	s8 bw20:4;
447 	s8 ofdm:4;
448 #endif
449 } __packed;
450 
451 struct rtw_5g_ht_ns_pwr_idx_diff {
452 #ifdef __LITTLE_ENDIAN
453 	s8 bw20:4;
454 	s8 bw40:4;
455 #else
456 	s8 bw40:4;
457 	s8 bw20:4;
458 #endif
459 } __packed;
460 
461 struct rtw_5g_ofdm_ns_pwr_idx_diff {
462 #ifdef __LITTLE_ENDIAN
463 	s8 ofdm_3s:4;
464 	s8 ofdm_2s:4;
465 	s8 ofdm_4s:4;
466 	s8 res:4;
467 #else
468 	s8 res:4;
469 	s8 ofdm_4s:4;
470 	s8 ofdm_2s:4;
471 	s8 ofdm_3s:4;
472 #endif
473 } __packed;
474 
475 struct rtw_5g_vht_ns_pwr_idx_diff {
476 #ifdef __LITTLE_ENDIAN
477 	s8 bw160:4;
478 	s8 bw80:4;
479 #else
480 	s8 bw80:4;
481 	s8 bw160:4;
482 #endif
483 } __packed;
484 
485 struct rtw_5g_txpwr_idx {
486 	u8 bw40_base[14];
487 	struct rtw_5g_ht_1s_pwr_idx_diff ht_1s_diff;
488 	struct rtw_5g_ht_ns_pwr_idx_diff ht_2s_diff;
489 	struct rtw_5g_ht_ns_pwr_idx_diff ht_3s_diff;
490 	struct rtw_5g_ht_ns_pwr_idx_diff ht_4s_diff;
491 	struct rtw_5g_ofdm_ns_pwr_idx_diff ofdm_diff;
492 	struct rtw_5g_vht_ns_pwr_idx_diff vht_1s_diff;
493 	struct rtw_5g_vht_ns_pwr_idx_diff vht_2s_diff;
494 	struct rtw_5g_vht_ns_pwr_idx_diff vht_3s_diff;
495 	struct rtw_5g_vht_ns_pwr_idx_diff vht_4s_diff;
496 };
497 
498 struct rtw_txpwr_idx {
499 	struct rtw_2g_txpwr_idx pwr_idx_2g;
500 	struct rtw_5g_txpwr_idx pwr_idx_5g;
501 };
502 
503 struct rtw_timer_list {
504 	struct timer_list timer;
505 	void (*function)(void *data);
506 	void *args;
507 };
508 
509 struct rtw_channel_params {
510 	u8 center_chan;
511 	u8 bandwidth;
512 	u8 primary_chan_idx;
513 	/* center channel by different available bandwidth,
514 	 * val of (bw > current bandwidth) is invalid
515 	 */
516 	u8 cch_by_bw[RTW_MAX_CHANNEL_WIDTH + 1];
517 };
518 
519 struct rtw_hw_reg {
520 	u32 addr;
521 	u32 mask;
522 };
523 
524 struct rtw_ltecoex_addr {
525 	u32 ctrl;
526 	u32 wdata;
527 	u32 rdata;
528 };
529 
530 struct rtw_reg_domain {
531 	u32 addr;
532 	u32 mask;
533 #define RTW_REG_DOMAIN_MAC32	0
534 #define RTW_REG_DOMAIN_MAC16	1
535 #define RTW_REG_DOMAIN_MAC8	2
536 #define RTW_REG_DOMAIN_RF_A	3
537 #define RTW_REG_DOMAIN_RF_B	4
538 #define RTW_REG_DOMAIN_NL	0xFF
539 	u8 domain;
540 };
541 
542 struct rtw_rf_sipi_addr {
543 	u32 hssi_1;
544 	u32 hssi_2;
545 	u32 lssi_read;
546 	u32 lssi_read_pi;
547 };
548 
549 struct rtw_hw_reg_offset {
550 	struct rtw_hw_reg hw_reg;
551 	u8 offset;
552 };
553 
554 struct rtw_backup_info {
555 	u8 len;
556 	u32 reg;
557 	u32 val;
558 };
559 
560 enum rtw_vif_port_set {
561 	PORT_SET_MAC_ADDR	= BIT(0),
562 	PORT_SET_BSSID		= BIT(1),
563 	PORT_SET_NET_TYPE	= BIT(2),
564 	PORT_SET_AID		= BIT(3),
565 	PORT_SET_BCN_CTRL	= BIT(4),
566 };
567 
568 struct rtw_vif_port {
569 	struct rtw_hw_reg mac_addr;
570 	struct rtw_hw_reg bssid;
571 	struct rtw_hw_reg net_type;
572 	struct rtw_hw_reg aid;
573 	struct rtw_hw_reg bcn_ctrl;
574 };
575 
576 struct rtw_tx_pkt_info {
577 	u32 tx_pkt_size;
578 	u8 offset;
579 	u8 pkt_offset;
580 	u8 mac_id;
581 	u8 rate_id;
582 	u8 rate;
583 	u8 qsel;
584 	u8 bw;
585 	u8 sec_type;
586 	u8 sn;
587 	bool ampdu_en;
588 	u8 ampdu_factor;
589 	u8 ampdu_density;
590 	u16 seq;
591 	bool stbc;
592 	bool ldpc;
593 	bool dis_rate_fallback;
594 	bool bmc;
595 	bool use_rate;
596 	bool ls;
597 	bool fs;
598 	bool short_gi;
599 	bool report;
600 	bool rts;
601 	bool dis_qselseq;
602 	bool en_hwseq;
603 	u8 hw_ssn_sel;
604 	bool nav_use_hdr;
605 	bool bt_null;
606 };
607 
608 struct rtw_rx_pkt_stat {
609 	bool phy_status;
610 	bool icv_err;
611 	bool crc_err;
612 	bool decrypted;
613 	bool is_c2h;
614 
615 	s32 signal_power;
616 	u16 pkt_len;
617 	u8 bw;
618 	u8 drv_info_sz;
619 	u8 shift;
620 	u8 rate;
621 	u8 mac_id;
622 	u8 cam_id;
623 	u8 ppdu_cnt;
624 	u32 tsf_low;
625 	s8 rx_power[RTW_RF_PATH_MAX];
626 	u8 rssi;
627 	u8 rxsc;
628 	s8 rx_snr[RTW_RF_PATH_MAX];
629 	u8 rx_evm[RTW_RF_PATH_MAX];
630 	s8 cfo_tail[RTW_RF_PATH_MAX];
631 
632 	struct rtw_sta_info *si;
633 	struct ieee80211_vif *vif;
634 	struct ieee80211_hdr *hdr;
635 };
636 
637 DECLARE_EWMA(tp, 10, 2);
638 
639 struct rtw_traffic_stats {
640 	/* units in bytes */
641 	u64 tx_unicast;
642 	u64 rx_unicast;
643 
644 	/* count for packets */
645 	u64 tx_cnt;
646 	u64 rx_cnt;
647 
648 	/* units in Mbps */
649 	u32 tx_throughput;
650 	u32 rx_throughput;
651 	struct ewma_tp tx_ewma_tp;
652 	struct ewma_tp rx_ewma_tp;
653 };
654 
655 enum rtw_lps_mode {
656 	RTW_MODE_ACTIVE	= 0,
657 	RTW_MODE_LPS	= 1,
658 	RTW_MODE_WMM_PS	= 2,
659 };
660 
661 enum rtw_lps_deep_mode {
662 	LPS_DEEP_MODE_NONE	= 0,
663 	LPS_DEEP_MODE_LCLK	= 1,
664 	LPS_DEEP_MODE_PG	= 2,
665 };
666 
667 enum rtw_pwr_state {
668 	RTW_RF_OFF	= 0x0,
669 	RTW_RF_ON	= 0x4,
670 	RTW_ALL_ON	= 0xc,
671 };
672 
673 struct rtw_lps_conf {
674 	enum rtw_lps_mode mode;
675 	enum rtw_lps_deep_mode deep_mode;
676 	enum rtw_lps_deep_mode wow_deep_mode;
677 	enum rtw_pwr_state state;
678 	u8 awake_interval;
679 	u8 rlbm;
680 	u8 smart_ps;
681 	u8 port_id;
682 	bool sec_cam_backup;
683 	bool pattern_cam_backup;
684 };
685 
686 enum rtw_hw_key_type {
687 	RTW_CAM_NONE	= 0,
688 	RTW_CAM_WEP40	= 1,
689 	RTW_CAM_TKIP	= 2,
690 	RTW_CAM_AES	= 4,
691 	RTW_CAM_WEP104	= 5,
692 };
693 
694 struct rtw_cam_entry {
695 	bool valid;
696 	bool group;
697 	u8 addr[ETH_ALEN];
698 	u8 hw_key_type;
699 	struct ieee80211_key_conf *key;
700 };
701 
702 struct rtw_sec_desc {
703 	/* search strategy */
704 	bool default_key_search;
705 
706 	u32 total_cam_num;
707 	struct rtw_cam_entry cam_table[RTW_MAX_SEC_CAM_NUM];
708 	DECLARE_BITMAP(cam_map, RTW_MAX_SEC_CAM_NUM);
709 };
710 
711 struct rtw_tx_report {
712 	/* protect the tx report queue */
713 	spinlock_t q_lock;
714 	struct sk_buff_head queue;
715 	atomic_t sn;
716 	struct timer_list purge_timer;
717 };
718 
719 struct rtw_ra_report {
720 	struct rate_info txrate;
721 	u32 bit_rate;
722 	u8 desc_rate;
723 };
724 
725 struct rtw_txq {
726 	struct list_head list;
727 
728 	unsigned long flags;
729 	unsigned long last_push;
730 };
731 
732 #define RTW_BC_MC_MACID 1
733 DECLARE_EWMA(rssi, 10, 16);
734 
735 struct rtw_sta_info {
736 	struct ieee80211_sta *sta;
737 	struct ieee80211_vif *vif;
738 
739 	struct ewma_rssi avg_rssi;
740 	u8 rssi_level;
741 
742 	u8 mac_id;
743 	u8 rate_id;
744 	enum rtw_bandwidth bw_mode;
745 	enum rtw_rf_type rf_type;
746 	enum rtw_wireless_set wireless_set;
747 	u8 stbc_en:2;
748 	u8 ldpc_en:2;
749 	bool sgi_enable;
750 	bool vht_enable;
751 	bool updated;
752 	u8 init_ra_lv;
753 	u64 ra_mask;
754 
755 	DECLARE_BITMAP(tid_ba, IEEE80211_NUM_TIDS);
756 
757 	struct rtw_ra_report ra_report;
758 
759 	bool use_cfg_mask;
760 	struct cfg80211_bitrate_mask *mask;
761 };
762 
763 enum rtw_bfee_role {
764 	RTW_BFEE_NONE,
765 	RTW_BFEE_SU,
766 	RTW_BFEE_MU
767 };
768 
769 struct rtw_bfee {
770 	enum rtw_bfee_role role;
771 
772 	u16 p_aid;
773 	u8 g_id;
774 	u8 mac_addr[ETH_ALEN];
775 	u8 sound_dim;
776 
777 	/* SU-MIMO */
778 	u8 su_reg_index;
779 
780 	/* MU-MIMO */
781 	u16 aid;
782 };
783 
784 struct rtw_bf_info {
785 	u8 bfer_mu_cnt;
786 	u8 bfer_su_cnt;
787 	DECLARE_BITMAP(bfer_su_reg_maping, 2);
788 	u8 cur_csi_rpt_rate;
789 };
790 
791 struct rtw_vif {
792 	enum rtw_net_type net_type;
793 	u16 aid;
794 	u8 mac_addr[ETH_ALEN];
795 	u8 bssid[ETH_ALEN];
796 	u8 port;
797 	u8 bcn_ctrl;
798 	struct list_head rsvd_page_list;
799 	struct ieee80211_tx_queue_params tx_params[IEEE80211_NUM_ACS];
800 	const struct rtw_vif_port *conf;
801 
802 	struct rtw_traffic_stats stats;
803 
804 	struct rtw_bfee bfee;
805 };
806 
807 struct rtw_regulatory {
808 	char alpha2[2];
809 	u8 txpwr_regd_2g;
810 	u8 txpwr_regd_5g;
811 };
812 
813 enum rtw_regd_state {
814 	RTW_REGD_STATE_WORLDWIDE,
815 	RTW_REGD_STATE_PROGRAMMED,
816 	RTW_REGD_STATE_SETTING,
817 
818 	RTW_REGD_STATE_NR,
819 };
820 
821 struct rtw_regd {
822 	enum rtw_regd_state state;
823 	const struct rtw_regulatory *regulatory;
824 	enum nl80211_dfs_regions dfs_region;
825 };
826 
827 struct rtw_chip_ops {
828 	int (*mac_init)(struct rtw_dev *rtwdev);
829 	int (*dump_fw_crash)(struct rtw_dev *rtwdev);
830 	void (*shutdown)(struct rtw_dev *rtwdev);
831 	int (*read_efuse)(struct rtw_dev *rtwdev, u8 *map);
832 	void (*phy_set_param)(struct rtw_dev *rtwdev);
833 	void (*set_channel)(struct rtw_dev *rtwdev, u8 channel,
834 			    u8 bandwidth, u8 primary_chan_idx);
835 	void (*query_rx_desc)(struct rtw_dev *rtwdev, u8 *rx_desc,
836 			      struct rtw_rx_pkt_stat *pkt_stat,
837 			      struct ieee80211_rx_status *rx_status);
838 	u32 (*read_rf)(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
839 		       u32 addr, u32 mask);
840 	bool (*write_rf)(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
841 			 u32 addr, u32 mask, u32 data);
842 	void (*set_tx_power_index)(struct rtw_dev *rtwdev);
843 	int (*rsvd_page_dump)(struct rtw_dev *rtwdev, u8 *buf, u32 offset,
844 			      u32 size);
845 	int (*set_antenna)(struct rtw_dev *rtwdev,
846 			   u32 antenna_tx,
847 			   u32 antenna_rx);
848 	void (*cfg_ldo25)(struct rtw_dev *rtwdev, bool enable);
849 	void (*efuse_grant)(struct rtw_dev *rtwdev, bool enable);
850 	void (*false_alarm_statistics)(struct rtw_dev *rtwdev);
851 	void (*phy_calibration)(struct rtw_dev *rtwdev);
852 	void (*dpk_track)(struct rtw_dev *rtwdev);
853 	void (*cck_pd_set)(struct rtw_dev *rtwdev, u8 level);
854 	void (*pwr_track)(struct rtw_dev *rtwdev);
855 	void (*config_bfee)(struct rtw_dev *rtwdev, struct rtw_vif *vif,
856 			    struct rtw_bfee *bfee, bool enable);
857 	void (*set_gid_table)(struct rtw_dev *rtwdev,
858 			      struct ieee80211_vif *vif,
859 			      struct ieee80211_bss_conf *conf);
860 	void (*cfg_csi_rate)(struct rtw_dev *rtwdev, u8 rssi, u8 cur_rate,
861 			     u8 fixrate_en, u8 *new_rate);
862 	void (*adaptivity_init)(struct rtw_dev *rtwdev);
863 	void (*adaptivity)(struct rtw_dev *rtwdev);
864 	void (*cfo_init)(struct rtw_dev *rtwdev);
865 	void (*cfo_track)(struct rtw_dev *rtwdev);
866 	void (*config_tx_path)(struct rtw_dev *rtwdev, u8 tx_path,
867 			       enum rtw_bb_path tx_path_1ss,
868 			       enum rtw_bb_path tx_path_cck,
869 			       bool is_tx2_path);
870 
871 	/* for coex */
872 	void (*coex_set_init)(struct rtw_dev *rtwdev);
873 	void (*coex_set_ant_switch)(struct rtw_dev *rtwdev,
874 				    u8 ctrl_type, u8 pos_type);
875 	void (*coex_set_gnt_fix)(struct rtw_dev *rtwdev);
876 	void (*coex_set_gnt_debug)(struct rtw_dev *rtwdev);
877 	void (*coex_set_rfe_type)(struct rtw_dev *rtwdev);
878 	void (*coex_set_wl_tx_power)(struct rtw_dev *rtwdev, u8 wl_pwr);
879 	void (*coex_set_wl_rx_gain)(struct rtw_dev *rtwdev, bool low_gain);
880 };
881 
882 #define RTW_PWR_POLLING_CNT	20000
883 
884 #define RTW_PWR_CMD_READ	0x00
885 #define RTW_PWR_CMD_WRITE	0x01
886 #define RTW_PWR_CMD_POLLING	0x02
887 #define RTW_PWR_CMD_DELAY	0x03
888 #define RTW_PWR_CMD_END		0x04
889 
890 /* define the base address of each block */
891 #define RTW_PWR_ADDR_MAC	0x00
892 #define RTW_PWR_ADDR_USB	0x01
893 #define RTW_PWR_ADDR_PCIE	0x02
894 #define RTW_PWR_ADDR_SDIO	0x03
895 
896 #define RTW_PWR_INTF_SDIO_MSK	BIT(0)
897 #define RTW_PWR_INTF_USB_MSK	BIT(1)
898 #define RTW_PWR_INTF_PCI_MSK	BIT(2)
899 #define RTW_PWR_INTF_ALL_MSK	(BIT(0) | BIT(1) | BIT(2) | BIT(3))
900 
901 #define RTW_PWR_CUT_TEST_MSK	BIT(0)
902 #define RTW_PWR_CUT_A_MSK	BIT(1)
903 #define RTW_PWR_CUT_B_MSK	BIT(2)
904 #define RTW_PWR_CUT_C_MSK	BIT(3)
905 #define RTW_PWR_CUT_D_MSK	BIT(4)
906 #define RTW_PWR_CUT_E_MSK	BIT(5)
907 #define RTW_PWR_CUT_F_MSK	BIT(6)
908 #define RTW_PWR_CUT_G_MSK	BIT(7)
909 #define RTW_PWR_CUT_ALL_MSK	0xFF
910 
911 enum rtw_pwr_seq_cmd_delay_unit {
912 	RTW_PWR_DELAY_US,
913 	RTW_PWR_DELAY_MS,
914 };
915 
916 struct rtw_pwr_seq_cmd {
917 	u16 offset;
918 	u8 cut_mask;
919 	u8 intf_mask;
920 	u8 base:4;
921 	u8 cmd:4;
922 	u8 mask;
923 	u8 value;
924 };
925 
926 enum rtw_chip_ver {
927 	RTW_CHIP_VER_CUT_A = 0x00,
928 	RTW_CHIP_VER_CUT_B = 0x01,
929 	RTW_CHIP_VER_CUT_C = 0x02,
930 	RTW_CHIP_VER_CUT_D = 0x03,
931 	RTW_CHIP_VER_CUT_E = 0x04,
932 	RTW_CHIP_VER_CUT_F = 0x05,
933 	RTW_CHIP_VER_CUT_G = 0x06,
934 };
935 
936 #define RTW_INTF_PHY_PLATFORM_ALL 0
937 
938 enum rtw_intf_phy_cut {
939 	RTW_INTF_PHY_CUT_A = BIT(0),
940 	RTW_INTF_PHY_CUT_B = BIT(1),
941 	RTW_INTF_PHY_CUT_C = BIT(2),
942 	RTW_INTF_PHY_CUT_D = BIT(3),
943 	RTW_INTF_PHY_CUT_E = BIT(4),
944 	RTW_INTF_PHY_CUT_F = BIT(5),
945 	RTW_INTF_PHY_CUT_G = BIT(6),
946 	RTW_INTF_PHY_CUT_ALL = 0xFFFF,
947 };
948 
949 enum rtw_ip_sel {
950 	RTW_IP_SEL_PHY = 0,
951 	RTW_IP_SEL_MAC = 1,
952 	RTW_IP_SEL_DBI = 2,
953 
954 	RTW_IP_SEL_UNDEF = 0xFFFF
955 };
956 
957 enum rtw_pq_map_id {
958 	RTW_PQ_MAP_VO = 0x0,
959 	RTW_PQ_MAP_VI = 0x1,
960 	RTW_PQ_MAP_BE = 0x2,
961 	RTW_PQ_MAP_BK = 0x3,
962 	RTW_PQ_MAP_MG = 0x4,
963 	RTW_PQ_MAP_HI = 0x5,
964 	RTW_PQ_MAP_NUM = 0x6,
965 
966 	RTW_PQ_MAP_UNDEF,
967 };
968 
969 enum rtw_dma_mapping {
970 	RTW_DMA_MAPPING_EXTRA	= 0,
971 	RTW_DMA_MAPPING_LOW	= 1,
972 	RTW_DMA_MAPPING_NORMAL	= 2,
973 	RTW_DMA_MAPPING_HIGH	= 3,
974 
975 	RTW_DMA_MAPPING_MAX,
976 	RTW_DMA_MAPPING_UNDEF,
977 };
978 
979 struct rtw_rqpn {
980 	enum rtw_dma_mapping dma_map_vo;
981 	enum rtw_dma_mapping dma_map_vi;
982 	enum rtw_dma_mapping dma_map_be;
983 	enum rtw_dma_mapping dma_map_bk;
984 	enum rtw_dma_mapping dma_map_mg;
985 	enum rtw_dma_mapping dma_map_hi;
986 };
987 
988 struct rtw_prioq_addr {
989 	u32 rsvd;
990 	u32 avail;
991 };
992 
993 struct rtw_prioq_addrs {
994 	struct rtw_prioq_addr prio[RTW_DMA_MAPPING_MAX];
995 	bool wsize;
996 };
997 
998 struct rtw_page_table {
999 	u16 hq_num;
1000 	u16 nq_num;
1001 	u16 lq_num;
1002 	u16 exq_num;
1003 	u16 gapq_num;
1004 };
1005 
1006 struct rtw_intf_phy_para {
1007 	u16 offset;
1008 	u16 value;
1009 	u16 ip_sel;
1010 	u16 cut_mask;
1011 	u16 platform;
1012 };
1013 
1014 struct rtw_wow_pattern {
1015 	u16 crc;
1016 	u8 type;
1017 	u8 valid;
1018 	u8 mask[RTW_MAX_PATTERN_MASK_SIZE];
1019 };
1020 
1021 struct rtw_pno_request {
1022 	bool inited;
1023 	u32 match_set_cnt;
1024 	struct cfg80211_match_set *match_sets;
1025 	u8 channel_cnt;
1026 	struct ieee80211_channel *channels;
1027 	struct cfg80211_sched_scan_plan scan_plan;
1028 };
1029 
1030 struct rtw_wow_param {
1031 	struct ieee80211_vif *wow_vif;
1032 	DECLARE_BITMAP(flags, RTW_WOW_FLAG_MAX);
1033 	u8 txpause;
1034 	u8 pattern_cnt;
1035 	struct rtw_wow_pattern patterns[RTW_MAX_PATTERN_NUM];
1036 
1037 	bool ips_enabled;
1038 	struct rtw_pno_request pno_req;
1039 };
1040 
1041 struct rtw_intf_phy_para_table {
1042 	const struct rtw_intf_phy_para *usb2_para;
1043 	const struct rtw_intf_phy_para *usb3_para;
1044 	const struct rtw_intf_phy_para *gen1_para;
1045 	const struct rtw_intf_phy_para *gen2_para;
1046 	u8 n_usb2_para;
1047 	u8 n_usb3_para;
1048 	u8 n_gen1_para;
1049 	u8 n_gen2_para;
1050 };
1051 
1052 struct rtw_table {
1053 	const void *data;
1054 	const u32 size;
1055 	void (*parse)(struct rtw_dev *rtwdev, const struct rtw_table *tbl);
1056 	void (*do_cfg)(struct rtw_dev *rtwdev, const struct rtw_table *tbl,
1057 		       u32 addr, u32 data);
1058 	enum rtw_rf_path rf_path;
1059 };
1060 
1061 static inline void rtw_load_table(struct rtw_dev *rtwdev,
1062 				  const struct rtw_table *tbl)
1063 {
1064 	(*tbl->parse)(rtwdev, tbl);
1065 }
1066 
1067 enum rtw_rfe_fem {
1068 	RTW_RFE_IFEM,
1069 	RTW_RFE_EFEM,
1070 	RTW_RFE_IFEM2G_EFEM5G,
1071 	RTW_RFE_NUM,
1072 };
1073 
1074 struct rtw_rfe_def {
1075 	const struct rtw_table *phy_pg_tbl;
1076 	const struct rtw_table *txpwr_lmt_tbl;
1077 	const struct rtw_table *agc_btg_tbl;
1078 };
1079 
1080 #define RTW_DEF_RFE(chip, bb_pg, pwrlmt) {				  \
1081 	.phy_pg_tbl = &rtw ## chip ## _bb_pg_type ## bb_pg ## _tbl,	  \
1082 	.txpwr_lmt_tbl = &rtw ## chip ## _txpwr_lmt_type ## pwrlmt ## _tbl, \
1083 	}
1084 
1085 #define RTW_DEF_RFE_EXT(chip, bb_pg, pwrlmt, btg) {			  \
1086 	.phy_pg_tbl = &rtw ## chip ## _bb_pg_type ## bb_pg ## _tbl,	  \
1087 	.txpwr_lmt_tbl = &rtw ## chip ## _txpwr_lmt_type ## pwrlmt ## _tbl, \
1088 	.agc_btg_tbl = &rtw ## chip ## _agc_btg_type ## btg ## _tbl, \
1089 	}
1090 
1091 #define RTW_PWR_TRK_5G_1		0
1092 #define RTW_PWR_TRK_5G_2		1
1093 #define RTW_PWR_TRK_5G_3		2
1094 #define RTW_PWR_TRK_5G_NUM		3
1095 
1096 #define RTW_PWR_TRK_TBL_SZ		30
1097 
1098 /* This table stores the values of TX power that will be adjusted by power
1099  * tracking.
1100  *
1101  * For 5G bands, there are 3 different settings.
1102  * For 2G there are cck rate and ofdm rate with different settings.
1103  */
1104 struct rtw_pwr_track_tbl {
1105 	const u8 *pwrtrk_5gb_n[RTW_PWR_TRK_5G_NUM];
1106 	const u8 *pwrtrk_5gb_p[RTW_PWR_TRK_5G_NUM];
1107 	const u8 *pwrtrk_5ga_n[RTW_PWR_TRK_5G_NUM];
1108 	const u8 *pwrtrk_5ga_p[RTW_PWR_TRK_5G_NUM];
1109 	const u8 *pwrtrk_2gb_n;
1110 	const u8 *pwrtrk_2gb_p;
1111 	const u8 *pwrtrk_2ga_n;
1112 	const u8 *pwrtrk_2ga_p;
1113 	const u8 *pwrtrk_2g_cckb_n;
1114 	const u8 *pwrtrk_2g_cckb_p;
1115 	const u8 *pwrtrk_2g_ccka_n;
1116 	const u8 *pwrtrk_2g_ccka_p;
1117 	const s8 *pwrtrk_xtal_n;
1118 	const s8 *pwrtrk_xtal_p;
1119 };
1120 
1121 enum rtw_wlan_cpu {
1122 	RTW_WCPU_11AC,
1123 	RTW_WCPU_11N,
1124 };
1125 
1126 enum rtw_fw_fifo_sel {
1127 	RTW_FW_FIFO_SEL_TX,
1128 	RTW_FW_FIFO_SEL_RX,
1129 	RTW_FW_FIFO_SEL_RSVD_PAGE,
1130 	RTW_FW_FIFO_SEL_REPORT,
1131 	RTW_FW_FIFO_SEL_LLT,
1132 	RTW_FW_FIFO_SEL_RXBUF_FW,
1133 
1134 	RTW_FW_FIFO_MAX,
1135 };
1136 
1137 enum rtw_fwcd_item {
1138 	RTW_FWCD_TLV,
1139 	RTW_FWCD_REG,
1140 	RTW_FWCD_ROM,
1141 	RTW_FWCD_IMEM,
1142 	RTW_FWCD_DMEM,
1143 	RTW_FWCD_EMEM,
1144 };
1145 
1146 /* hardware configuration for each IC */
1147 struct rtw_chip_info {
1148 	struct rtw_chip_ops *ops;
1149 	u8 id;
1150 
1151 	const char *fw_name;
1152 	enum rtw_wlan_cpu wlan_cpu;
1153 	u8 tx_pkt_desc_sz;
1154 	u8 tx_buf_desc_sz;
1155 	u8 rx_pkt_desc_sz;
1156 	u8 rx_buf_desc_sz;
1157 	u32 phy_efuse_size;
1158 	u32 log_efuse_size;
1159 	u32 ptct_efuse_size;
1160 	u32 txff_size;
1161 	u32 rxff_size;
1162 	u32 fw_rxff_size;
1163 	u8 band;
1164 	u8 page_size;
1165 	u8 csi_buf_pg_num;
1166 	u8 dig_max;
1167 	u8 dig_min;
1168 	u8 txgi_factor;
1169 	bool is_pwr_by_rate_dec;
1170 	bool rx_ldpc;
1171 	bool tx_stbc;
1172 	u8 max_power_index;
1173 
1174 	u16 fw_fifo_addr[RTW_FW_FIFO_MAX];
1175 	const struct rtw_fwcd_segs *fwcd_segs;
1176 
1177 	u8 default_1ss_tx_path;
1178 
1179 	bool path_div_supported;
1180 	bool ht_supported;
1181 	bool vht_supported;
1182 	u8 lps_deep_mode_supported;
1183 
1184 	/* init values */
1185 	u8 sys_func_en;
1186 	const struct rtw_pwr_seq_cmd **pwr_on_seq;
1187 	const struct rtw_pwr_seq_cmd **pwr_off_seq;
1188 	const struct rtw_rqpn *rqpn_table;
1189 	const struct rtw_prioq_addrs *prioq_addrs;
1190 	const struct rtw_page_table *page_table;
1191 	const struct rtw_intf_phy_para_table *intf_table;
1192 
1193 	const struct rtw_hw_reg *dig;
1194 	const struct rtw_hw_reg *dig_cck;
1195 	u32 rf_base_addr[2];
1196 	u32 rf_sipi_addr[2];
1197 	const struct rtw_rf_sipi_addr *rf_sipi_read_addr;
1198 	u8 fix_rf_phy_num;
1199 	const struct rtw_ltecoex_addr *ltecoex_addr;
1200 
1201 	const struct rtw_table *mac_tbl;
1202 	const struct rtw_table *agc_tbl;
1203 	const struct rtw_table *bb_tbl;
1204 	const struct rtw_table *rf_tbl[RTW_RF_PATH_MAX];
1205 	const struct rtw_table *rfk_init_tbl;
1206 
1207 	const struct rtw_rfe_def *rfe_defs;
1208 	u32 rfe_defs_size;
1209 
1210 	bool en_dis_dpd;
1211 	u16 dpd_ratemask;
1212 	u8 iqk_threshold;
1213 	u8 lck_threshold;
1214 	const struct rtw_pwr_track_tbl *pwr_track_tbl;
1215 
1216 	u8 bfer_su_max_num;
1217 	u8 bfer_mu_max_num;
1218 
1219 	struct rtw_hw_reg_offset *edcca_th;
1220 	s8 l2h_th_ini_cs;
1221 	s8 l2h_th_ini_ad;
1222 
1223 	const char *wow_fw_name;
1224 	const struct wiphy_wowlan_support *wowlan_stub;
1225 	const u8 max_sched_scan_ssids;
1226 
1227 	/* for 8821c set channel */
1228 	u32 ch_param[3];
1229 
1230 	/* coex paras */
1231 	u32 coex_para_ver;
1232 	u8 bt_desired_ver;
1233 	bool scbd_support;
1234 	bool new_scbd10_def; /* true: fix 2M(8822c) */
1235 	bool ble_hid_profile_support;
1236 	u8 pstdma_type; /* 0: LPSoff, 1:LPSon */
1237 	u8 bt_rssi_type;
1238 	u8 ant_isolation;
1239 	u8 rssi_tolerance;
1240 	u8 table_sant_num;
1241 	u8 table_nsant_num;
1242 	u8 tdma_sant_num;
1243 	u8 tdma_nsant_num;
1244 	u8 bt_afh_span_bw20;
1245 	u8 bt_afh_span_bw40;
1246 	u8 afh_5g_num;
1247 	u8 wl_rf_para_num;
1248 	u8 coex_info_hw_regs_num;
1249 	const u8 *bt_rssi_step;
1250 	const u8 *wl_rssi_step;
1251 	const struct coex_table_para *table_nsant;
1252 	const struct coex_table_para *table_sant;
1253 	const struct coex_tdma_para *tdma_sant;
1254 	const struct coex_tdma_para *tdma_nsant;
1255 	const struct coex_rf_para *wl_rf_para_tx;
1256 	const struct coex_rf_para *wl_rf_para_rx;
1257 	const struct coex_5g_afh_map *afh_5g;
1258 	const struct rtw_hw_reg *btg_reg;
1259 	const struct rtw_reg_domain *coex_info_hw_regs;
1260 	u32 wl_fw_desired_ver;
1261 };
1262 
1263 enum rtw_coex_bt_state_cnt {
1264 	COEX_CNT_BT_RETRY,
1265 	COEX_CNT_BT_REINIT,
1266 	COEX_CNT_BT_REENABLE,
1267 	COEX_CNT_BT_POPEVENT,
1268 	COEX_CNT_BT_SETUPLINK,
1269 	COEX_CNT_BT_IGNWLANACT,
1270 	COEX_CNT_BT_INQ,
1271 	COEX_CNT_BT_PAGE,
1272 	COEX_CNT_BT_ROLESWITCH,
1273 	COEX_CNT_BT_AFHUPDATE,
1274 	COEX_CNT_BT_INFOUPDATE,
1275 	COEX_CNT_BT_IQK,
1276 	COEX_CNT_BT_IQKFAIL,
1277 
1278 	COEX_CNT_BT_MAX
1279 };
1280 
1281 enum rtw_coex_wl_state_cnt {
1282 	COEX_CNT_WL_SCANAP,
1283 	COEX_CNT_WL_CONNPKT,
1284 	COEX_CNT_WL_COEXRUN,
1285 	COEX_CNT_WL_NOISY0,
1286 	COEX_CNT_WL_NOISY1,
1287 	COEX_CNT_WL_NOISY2,
1288 	COEX_CNT_WL_5MS_NOEXTEND,
1289 	COEX_CNT_WL_FW_NOTIFY,
1290 
1291 	COEX_CNT_WL_MAX
1292 };
1293 
1294 struct rtw_coex_rfe {
1295 	bool ant_switch_exist;
1296 	bool ant_switch_diversity;
1297 	bool ant_switch_with_bt;
1298 	u8 rfe_module_type;
1299 	u8 ant_switch_polarity;
1300 
1301 	/* true if WLG at BTG, else at WLAG */
1302 	bool wlg_at_btg;
1303 };
1304 
1305 #define COEX_WL_TDMA_PARA_LENGTH	5
1306 
1307 struct rtw_coex_dm {
1308 	bool cur_ps_tdma_on;
1309 	bool cur_wl_rx_low_gain_en;
1310 	bool ignore_wl_act;
1311 
1312 	u8 reason;
1313 	u8 bt_rssi_state[4];
1314 	u8 wl_rssi_state[4];
1315 	u8 wl_ch_info[3];
1316 	u8 cur_ps_tdma;
1317 	u8 cur_table;
1318 	u8 ps_tdma_para[5];
1319 	u8 cur_bt_pwr_lvl;
1320 	u8 cur_bt_lna_lvl;
1321 	u8 cur_wl_pwr_lvl;
1322 	u8 bt_status;
1323 	u32 cur_ant_pos_type;
1324 	u32 cur_switch_status;
1325 	u32 setting_tdma;
1326 	u8 fw_tdma_para[COEX_WL_TDMA_PARA_LENGTH];
1327 };
1328 
1329 #define COEX_BTINFO_SRC_WL_FW	0x0
1330 #define COEX_BTINFO_SRC_BT_RSP	0x1
1331 #define COEX_BTINFO_SRC_BT_ACT	0x2
1332 #define COEX_BTINFO_SRC_BT_IQK	0x3
1333 #define COEX_BTINFO_SRC_BT_SCBD	0x4
1334 #define COEX_BTINFO_SRC_H2C60	0x5
1335 #define COEX_BTINFO_SRC_MAX	0x6
1336 
1337 #define COEX_INFO_FTP		BIT(7)
1338 #define COEX_INFO_A2DP		BIT(6)
1339 #define COEX_INFO_HID		BIT(5)
1340 #define COEX_INFO_SCO_BUSY	BIT(4)
1341 #define COEX_INFO_ACL_BUSY	BIT(3)
1342 #define COEX_INFO_INQ_PAGE	BIT(2)
1343 #define COEX_INFO_SCO_ESCO	BIT(1)
1344 #define COEX_INFO_CONNECTION	BIT(0)
1345 #define COEX_BTINFO_LENGTH_MAX	10
1346 #define COEX_BTINFO_LENGTH	7
1347 
1348 struct rtw_coex_stat {
1349 	bool bt_disabled;
1350 	bool bt_disabled_pre;
1351 	bool bt_link_exist;
1352 	bool bt_whck_test;
1353 	bool bt_inq_page;
1354 	bool bt_inq_remain;
1355 	bool bt_inq;
1356 	bool bt_page;
1357 	bool bt_ble_voice;
1358 	bool bt_ble_exist;
1359 	bool bt_hfp_exist;
1360 	bool bt_a2dp_exist;
1361 	bool bt_hid_exist;
1362 	bool bt_pan_exist; /* PAN or OPP */
1363 	bool bt_opp_exist; /* OPP only */
1364 	bool bt_acl_busy;
1365 	bool bt_fix_2M;
1366 	bool bt_setup_link;
1367 	bool bt_multi_link;
1368 	bool bt_multi_link_pre;
1369 	bool bt_multi_link_remain;
1370 	bool bt_a2dp_sink;
1371 	bool bt_a2dp_active;
1372 	bool bt_reenable;
1373 	bool bt_ble_scan_en;
1374 	bool bt_init_scan;
1375 	bool bt_slave;
1376 	bool bt_418_hid_exist;
1377 	bool bt_ble_hid_exist;
1378 	bool bt_mailbox_reply;
1379 
1380 	bool wl_under_lps;
1381 	bool wl_under_ips;
1382 	bool wl_hi_pri_task1;
1383 	bool wl_hi_pri_task2;
1384 	bool wl_force_lps_ctrl;
1385 	bool wl_gl_busy;
1386 	bool wl_linkscan_proc;
1387 	bool wl_ps_state_fail;
1388 	bool wl_tx_limit_en;
1389 	bool wl_ampdu_limit_en;
1390 	bool wl_connected;
1391 	bool wl_slot_extend;
1392 	bool wl_cck_lock;
1393 	bool wl_cck_lock_pre;
1394 	bool wl_cck_lock_ever;
1395 	bool wl_connecting;
1396 	bool wl_slot_toggle;
1397 	bool wl_slot_toggle_change; /* if toggle to no-toggle */
1398 
1399 	u32 bt_supported_version;
1400 	u32 bt_supported_feature;
1401 	u32 hi_pri_tx;
1402 	u32 hi_pri_rx;
1403 	u32 lo_pri_tx;
1404 	u32 lo_pri_rx;
1405 	u32 patch_ver;
1406 	u16 bt_reg_vendor_ae;
1407 	u16 bt_reg_vendor_ac;
1408 	s8 bt_rssi;
1409 	u8 kt_ver;
1410 	u8 gnt_workaround_state;
1411 	u8 tdma_timer_base;
1412 	u8 bt_profile_num;
1413 	u8 bt_info_c2h[COEX_BTINFO_SRC_MAX][COEX_BTINFO_LENGTH_MAX];
1414 	u8 bt_info_lb2;
1415 	u8 bt_info_lb3;
1416 	u8 bt_info_hb0;
1417 	u8 bt_info_hb1;
1418 	u8 bt_info_hb2;
1419 	u8 bt_info_hb3;
1420 	u8 bt_ble_scan_type;
1421 	u8 bt_hid_pair_num;
1422 	u8 bt_hid_slot;
1423 	u8 bt_a2dp_bitpool;
1424 	u8 bt_iqk_state;
1425 
1426 	u16 wl_beacon_interval;
1427 	u8 wl_noisy_level;
1428 	u8 wl_fw_dbg_info[10];
1429 	u8 wl_fw_dbg_info_pre[10];
1430 	u8 wl_rx_rate;
1431 	u8 wl_tx_rate;
1432 	u8 wl_rts_rx_rate;
1433 	u8 wl_coex_mode;
1434 	u8 wl_iot_peer;
1435 	u8 ampdu_max_time;
1436 	u8 wl_tput_dir;
1437 
1438 	u8 wl_toggle_para[6];
1439 	u8 wl_toggle_interval;
1440 
1441 	u16 score_board;
1442 	u16 retry_limit;
1443 
1444 	/* counters to record bt states */
1445 	u32 cnt_bt[COEX_CNT_BT_MAX];
1446 
1447 	/* counters to record wifi states */
1448 	u32 cnt_wl[COEX_CNT_WL_MAX];
1449 
1450 	/* counters to record bt c2h data */
1451 	u32 cnt_bt_info_c2h[COEX_BTINFO_SRC_MAX];
1452 
1453 	u32 darfrc;
1454 	u32 darfrch;
1455 };
1456 
1457 struct rtw_coex {
1458 	/* protects coex info request section */
1459 	struct mutex mutex;
1460 	struct sk_buff_head queue;
1461 	wait_queue_head_t wait;
1462 
1463 	bool under_5g;
1464 	bool stop_dm;
1465 	bool freeze;
1466 	bool freerun;
1467 	bool wl_rf_off;
1468 	bool manual_control;
1469 
1470 	struct rtw_coex_stat stat;
1471 	struct rtw_coex_dm dm;
1472 	struct rtw_coex_rfe rfe;
1473 
1474 	struct delayed_work bt_relink_work;
1475 	struct delayed_work bt_reenable_work;
1476 	struct delayed_work defreeze_work;
1477 	struct delayed_work wl_remain_work;
1478 	struct delayed_work bt_remain_work;
1479 	struct delayed_work wl_connecting_work;
1480 	struct delayed_work bt_multi_link_remain_work;
1481 	struct delayed_work wl_ccklock_work;
1482 
1483 };
1484 
1485 #define DPK_RF_REG_NUM 7
1486 #define DPK_RF_PATH_NUM 2
1487 #define DPK_BB_REG_NUM 18
1488 #define DPK_CHANNEL_WIDTH_80 1
1489 
1490 DECLARE_EWMA(thermal, 10, 4);
1491 
1492 struct rtw_dpk_info {
1493 	bool is_dpk_pwr_on;
1494 	bool is_reload;
1495 
1496 	DECLARE_BITMAP(dpk_path_ok, DPK_RF_PATH_NUM);
1497 
1498 	u8 thermal_dpk[DPK_RF_PATH_NUM];
1499 	struct ewma_thermal avg_thermal[DPK_RF_PATH_NUM];
1500 
1501 	u32 gnt_control;
1502 	u32 gnt_value;
1503 
1504 	u8 result[RTW_RF_PATH_MAX];
1505 	u8 dpk_txagc[RTW_RF_PATH_MAX];
1506 	u32 coef[RTW_RF_PATH_MAX][20];
1507 	u16 dpk_gs[RTW_RF_PATH_MAX];
1508 	u8 thermal_dpk_delta[RTW_RF_PATH_MAX];
1509 	u8 pre_pwsf[RTW_RF_PATH_MAX];
1510 
1511 	u8 dpk_band;
1512 	u8 dpk_ch;
1513 	u8 dpk_bw;
1514 };
1515 
1516 struct rtw_phy_cck_pd_reg {
1517 	u32 reg_pd;
1518 	u32 mask_pd;
1519 	u32 reg_cs;
1520 	u32 mask_cs;
1521 };
1522 
1523 #define DACK_MSBK_BACKUP_NUM	0xf
1524 #define DACK_DCK_BACKUP_NUM	0x2
1525 
1526 struct rtw_swing_table {
1527 	const u8 *p[RTW_RF_PATH_MAX];
1528 	const u8 *n[RTW_RF_PATH_MAX];
1529 };
1530 
1531 struct rtw_pkt_count {
1532 	u16 num_bcn_pkt;
1533 	u16 num_qry_pkt[DESC_RATE_MAX];
1534 };
1535 
1536 DECLARE_EWMA(evm, 10, 4);
1537 DECLARE_EWMA(snr, 10, 4);
1538 
1539 struct rtw_iqk_info {
1540 	bool done;
1541 	struct {
1542 		u32 s1_x;
1543 		u32 s1_y;
1544 		u32 s0_x;
1545 		u32 s0_y;
1546 	} result;
1547 };
1548 
1549 enum rtw_rf_band {
1550 	RF_BAND_2G_CCK,
1551 	RF_BAND_2G_OFDM,
1552 	RF_BAND_5G_L,
1553 	RF_BAND_5G_M,
1554 	RF_BAND_5G_H,
1555 	RF_BAND_MAX
1556 };
1557 
1558 #define RF_GAIN_NUM 11
1559 #define RF_HW_OFFSET_NUM 10
1560 
1561 struct rtw_gapk_info {
1562 	u32 rf3f_bp[RF_BAND_MAX][RF_GAIN_NUM][RTW_RF_PATH_MAX];
1563 	u32 rf3f_fs[RTW_RF_PATH_MAX][RF_GAIN_NUM];
1564 	bool txgapk_bp_done;
1565 	s8 offset[RF_GAIN_NUM][RTW_RF_PATH_MAX];
1566 	s8 fianl_offset[RF_GAIN_NUM][RTW_RF_PATH_MAX];
1567 	u8 read_txgain;
1568 	u8 channel;
1569 };
1570 
1571 #define EDCCA_TH_L2H_IDX 0
1572 #define EDCCA_TH_H2L_IDX 1
1573 #define EDCCA_TH_L2H_LB 48
1574 #define EDCCA_ADC_BACKOFF 12
1575 #define EDCCA_IGI_BASE 50
1576 #define EDCCA_IGI_L2H_DIFF 8
1577 #define EDCCA_L2H_H2L_DIFF 7
1578 #define EDCCA_L2H_H2L_DIFF_NORMAL 8
1579 
1580 enum rtw_edcca_mode {
1581 	RTW_EDCCA_NORMAL	= 0,
1582 	RTW_EDCCA_ADAPTIVITY	= 1,
1583 };
1584 
1585 struct rtw_cfo_track {
1586 	bool is_adjust;
1587 	u8 crystal_cap;
1588 	s32 cfo_tail[RTW_RF_PATH_MAX];
1589 	s32 cfo_cnt[RTW_RF_PATH_MAX];
1590 	u32 packet_count;
1591 	u32 packet_count_pre;
1592 };
1593 
1594 #define RRSR_INIT_2G 0x15f
1595 #define RRSR_INIT_5G 0x150
1596 
1597 enum rtw_dm_cap {
1598 	RTW_DM_CAP_NA,
1599 	RTW_DM_CAP_TXGAPK,
1600 	RTW_DM_CAP_NUM
1601 };
1602 
1603 struct rtw_dm_info {
1604 	u32 cck_fa_cnt;
1605 	u32 ofdm_fa_cnt;
1606 	u32 total_fa_cnt;
1607 	u32 cck_cca_cnt;
1608 	u32 ofdm_cca_cnt;
1609 	u32 total_cca_cnt;
1610 
1611 	u32 cck_ok_cnt;
1612 	u32 cck_err_cnt;
1613 	u32 ofdm_ok_cnt;
1614 	u32 ofdm_err_cnt;
1615 	u32 ht_ok_cnt;
1616 	u32 ht_err_cnt;
1617 	u32 vht_ok_cnt;
1618 	u32 vht_err_cnt;
1619 
1620 	u8 min_rssi;
1621 	u8 pre_min_rssi;
1622 	u16 fa_history[4];
1623 	u8 igi_history[4];
1624 	u8 igi_bitmap;
1625 	bool damping;
1626 	u8 damping_cnt;
1627 	u8 damping_rssi;
1628 
1629 	u8 cck_gi_u_bnd;
1630 	u8 cck_gi_l_bnd;
1631 
1632 	u8 tx_rate;
1633 	u32 rrsr_val_init;
1634 	u32 rrsr_mask_min;
1635 	u8 thermal_avg[RTW_RF_PATH_MAX];
1636 	u8 thermal_meter_k;
1637 	u8 thermal_meter_lck;
1638 	s8 delta_power_index[RTW_RF_PATH_MAX];
1639 	s8 delta_power_index_last[RTW_RF_PATH_MAX];
1640 	u8 default_ofdm_index;
1641 	bool pwr_trk_triggered;
1642 	bool pwr_trk_init_trigger;
1643 	struct ewma_thermal avg_thermal[RTW_RF_PATH_MAX];
1644 	s8 txagc_remnant_cck;
1645 	s8 txagc_remnant_ofdm;
1646 
1647 	/* backup dack results for each path and I/Q */
1648 	u32 dack_adck[RTW_RF_PATH_MAX];
1649 	u16 dack_msbk[RTW_RF_PATH_MAX][2][DACK_MSBK_BACKUP_NUM];
1650 	u8 dack_dck[RTW_RF_PATH_MAX][2][DACK_DCK_BACKUP_NUM];
1651 
1652 	struct rtw_dpk_info dpk_info;
1653 	struct rtw_cfo_track cfo_track;
1654 
1655 	/* [bandwidth 0:20M/1:40M][number of path] */
1656 	u8 cck_pd_lv[2][RTW_RF_PATH_MAX];
1657 	u32 cck_fa_avg;
1658 	u8 cck_pd_default;
1659 
1660 	/* save the last rx phy status for debug */
1661 	s8 rx_snr[RTW_RF_PATH_MAX];
1662 	u8 rx_evm_dbm[RTW_RF_PATH_MAX];
1663 	s16 cfo_tail[RTW_RF_PATH_MAX];
1664 	u8 rssi[RTW_RF_PATH_MAX];
1665 	u8 curr_rx_rate;
1666 	struct rtw_pkt_count cur_pkt_count;
1667 	struct rtw_pkt_count last_pkt_count;
1668 	struct ewma_evm ewma_evm[RTW_EVM_NUM];
1669 	struct ewma_snr ewma_snr[RTW_SNR_NUM];
1670 
1671 	u32 dm_flags; /* enum rtw_dm_cap */
1672 	struct rtw_iqk_info iqk;
1673 	struct rtw_gapk_info gapk;
1674 	bool is_bt_iqk_timeout;
1675 
1676 	s8 l2h_th_ini;
1677 	enum rtw_edcca_mode edcca_mode;
1678 	u8 scan_density;
1679 };
1680 
1681 struct rtw_efuse {
1682 	u32 size;
1683 	u32 physical_size;
1684 	u32 logical_size;
1685 	u32 protect_size;
1686 
1687 	u8 addr[ETH_ALEN];
1688 	u8 channel_plan;
1689 	u8 country_code[2];
1690 	u8 rf_board_option;
1691 	u8 rfe_option;
1692 	u8 power_track_type;
1693 	u8 thermal_meter[RTW_RF_PATH_MAX];
1694 	u8 thermal_meter_k;
1695 	u8 crystal_cap;
1696 	u8 ant_div_cfg;
1697 	u8 ant_div_type;
1698 	u8 regd;
1699 	u8 afe;
1700 
1701 	u8 lna_type_2g;
1702 	u8 lna_type_5g;
1703 	u8 glna_type;
1704 	u8 alna_type;
1705 	bool ext_lna_2g;
1706 	bool ext_lna_5g;
1707 	u8 pa_type_2g;
1708 	u8 pa_type_5g;
1709 	u8 gpa_type;
1710 	u8 apa_type;
1711 	bool ext_pa_2g;
1712 	bool ext_pa_5g;
1713 	u8 tx_bb_swing_setting_2g;
1714 	u8 tx_bb_swing_setting_5g;
1715 
1716 	bool btcoex;
1717 	/* bt share antenna with wifi */
1718 	bool share_ant;
1719 	u8 bt_setting;
1720 
1721 	struct {
1722 		u8 hci;
1723 		u8 bw;
1724 		u8 ptcl;
1725 		u8 nss;
1726 		u8 ant_num;
1727 	} hw_cap;
1728 
1729 	struct rtw_txpwr_idx txpwr_idx_table[4];
1730 };
1731 
1732 struct rtw_phy_cond {
1733 #ifdef __LITTLE_ENDIAN
1734 	u32 rfe:8;
1735 	u32 intf:4;
1736 	u32 pkg:4;
1737 	u32 plat:4;
1738 	u32 intf_rsvd:4;
1739 	u32 cut:4;
1740 	u32 branch:2;
1741 	u32 neg:1;
1742 	u32 pos:1;
1743 #else
1744 	u32 pos:1;
1745 	u32 neg:1;
1746 	u32 branch:2;
1747 	u32 cut:4;
1748 	u32 intf_rsvd:4;
1749 	u32 plat:4;
1750 	u32 pkg:4;
1751 	u32 intf:4;
1752 	u32 rfe:8;
1753 #endif
1754 	/* for intf:4 */
1755 	#define INTF_PCIE	BIT(0)
1756 	#define INTF_USB	BIT(1)
1757 	#define INTF_SDIO	BIT(2)
1758 	/* for branch:2 */
1759 	#define BRANCH_IF	0
1760 	#define BRANCH_ELIF	1
1761 	#define BRANCH_ELSE	2
1762 	#define BRANCH_ENDIF	3
1763 };
1764 
1765 struct rtw_fifo_conf {
1766 	/* tx fifo information */
1767 	u16 rsvd_boundary;
1768 	u16 rsvd_pg_num;
1769 	u16 rsvd_drv_pg_num;
1770 	u16 txff_pg_num;
1771 	u16 acq_pg_num;
1772 	u16 rsvd_drv_addr;
1773 	u16 rsvd_h2c_info_addr;
1774 	u16 rsvd_h2c_sta_info_addr;
1775 	u16 rsvd_h2cq_addr;
1776 	u16 rsvd_cpu_instr_addr;
1777 	u16 rsvd_fw_txbuf_addr;
1778 	u16 rsvd_csibuf_addr;
1779 	const struct rtw_rqpn *rqpn;
1780 };
1781 
1782 struct rtw_fwcd_desc {
1783 	u32 size;
1784 	u8 *next;
1785 	u8 *data;
1786 };
1787 
1788 struct rtw_fwcd_segs {
1789 	const u32 *segs;
1790 	u8 num;
1791 };
1792 
1793 #define FW_CD_TYPE 0xffff
1794 #define FW_CD_LEN 4
1795 #define FW_CD_VAL 0xaabbccdd
1796 struct rtw_fw_state {
1797 	const struct firmware *firmware;
1798 	struct rtw_dev *rtwdev;
1799 	struct completion completion;
1800 	struct rtw_fwcd_desc fwcd_desc;
1801 	u16 version;
1802 	u8 sub_version;
1803 	u8 sub_index;
1804 	u16 h2c_version;
1805 	u32 feature;
1806 };
1807 
1808 struct rtw_hal {
1809 	u32 rcr;
1810 
1811 	u32 chip_version;
1812 	u8 cut_version;
1813 	u8 mp_chip;
1814 	u8 oem_id;
1815 	struct rtw_phy_cond phy_cond;
1816 
1817 	u8 ps_mode;
1818 	u8 current_channel;
1819 	u8 current_band_width;
1820 	u8 current_band_type;
1821 
1822 	/* center channel for different available bandwidth,
1823 	 * val of (bw > current_band_width) is invalid
1824 	 */
1825 	u8 cch_by_bw[RTW_MAX_CHANNEL_WIDTH + 1];
1826 
1827 	u8 sec_ch_offset;
1828 	u8 rf_type;
1829 	u8 rf_path_num;
1830 	u8 rf_phy_num;
1831 	u32 antenna_tx;
1832 	u32 antenna_rx;
1833 	u8 bfee_sts_cap;
1834 
1835 	/* protect tx power section */
1836 	struct mutex tx_power_mutex;
1837 	s8 tx_pwr_by_rate_offset_2g[RTW_RF_PATH_MAX]
1838 				   [DESC_RATE_MAX];
1839 	s8 tx_pwr_by_rate_offset_5g[RTW_RF_PATH_MAX]
1840 				   [DESC_RATE_MAX];
1841 	s8 tx_pwr_by_rate_base_2g[RTW_RF_PATH_MAX]
1842 				 [RTW_RATE_SECTION_MAX];
1843 	s8 tx_pwr_by_rate_base_5g[RTW_RF_PATH_MAX]
1844 				 [RTW_RATE_SECTION_MAX];
1845 	s8 tx_pwr_limit_2g[RTW_REGD_MAX]
1846 			  [RTW_CHANNEL_WIDTH_MAX]
1847 			  [RTW_RATE_SECTION_MAX]
1848 			  [RTW_MAX_CHANNEL_NUM_2G];
1849 	s8 tx_pwr_limit_5g[RTW_REGD_MAX]
1850 			  [RTW_CHANNEL_WIDTH_MAX]
1851 			  [RTW_RATE_SECTION_MAX]
1852 			  [RTW_MAX_CHANNEL_NUM_5G];
1853 	s8 tx_pwr_tbl[RTW_RF_PATH_MAX]
1854 		     [DESC_RATE_MAX];
1855 };
1856 
1857 struct rtw_path_div {
1858 	enum rtw_bb_path current_tx_path;
1859 	u32 path_a_sum;
1860 	u32 path_b_sum;
1861 	u16 path_a_cnt;
1862 	u16 path_b_cnt;
1863 };
1864 
1865 struct rtw_dev {
1866 	struct ieee80211_hw *hw;
1867 	struct device *dev;
1868 
1869 	struct rtw_hci hci;
1870 
1871 	struct rtw_chip_info *chip;
1872 	struct rtw_hal hal;
1873 	struct rtw_fifo_conf fifo;
1874 	struct rtw_fw_state fw;
1875 	struct rtw_efuse efuse;
1876 	struct rtw_sec_desc sec;
1877 	struct rtw_traffic_stats stats;
1878 	struct rtw_regd regd;
1879 	struct rtw_bf_info bf_info;
1880 
1881 	struct rtw_dm_info dm_info;
1882 	struct rtw_coex coex;
1883 
1884 	/* ensures exclusive access from mac80211 callbacks */
1885 	struct mutex mutex;
1886 
1887 	/* read/write rf register */
1888 	spinlock_t rf_lock;
1889 
1890 	/* watch dog every 2 sec */
1891 	struct delayed_work watch_dog_work;
1892 	u32 watch_dog_cnt;
1893 
1894 	struct list_head rsvd_page_list;
1895 
1896 	/* c2h cmd queue & handler work */
1897 	struct sk_buff_head c2h_queue;
1898 	struct work_struct c2h_work;
1899 	struct work_struct fw_recovery_work;
1900 
1901 	/* used to protect txqs list */
1902 	spinlock_t txq_lock;
1903 	struct list_head txqs;
1904 	struct workqueue_struct *tx_wq;
1905 	struct work_struct tx_work;
1906 	struct work_struct ba_work;
1907 
1908 	struct rtw_tx_report tx_report;
1909 
1910 	struct {
1911 		/* incicate the mail box to use with fw */
1912 		u8 last_box_num;
1913 		/* protect to send h2c to fw */
1914 		spinlock_t lock;
1915 		u32 seq;
1916 	} h2c;
1917 
1918 	/* lps power state & handler work */
1919 	struct rtw_lps_conf lps_conf;
1920 	bool ps_enabled;
1921 	bool beacon_loss;
1922 	struct completion lps_leave_check;
1923 
1924 	struct dentry *debugfs;
1925 
1926 	u8 sta_cnt;
1927 	u32 rts_threshold;
1928 
1929 	DECLARE_BITMAP(mac_id_map, RTW_MAX_MAC_ID_NUM);
1930 	DECLARE_BITMAP(flags, NUM_OF_RTW_FLAGS);
1931 
1932 	u8 mp_mode;
1933 	struct rtw_path_div dm_path_div;
1934 
1935 	struct rtw_fw_state wow_fw;
1936 	struct rtw_wow_param wow;
1937 
1938 	bool need_rfk;
1939 	struct completion fw_scan_density;
1940 
1941 	/* hci related data, must be last */
1942 	u8 priv[] __aligned(sizeof(void *));
1943 };
1944 
1945 #include "hci.h"
1946 
1947 static inline bool rtw_is_assoc(struct rtw_dev *rtwdev)
1948 {
1949 	return !!rtwdev->sta_cnt;
1950 }
1951 
1952 static inline struct ieee80211_txq *rtwtxq_to_txq(struct rtw_txq *rtwtxq)
1953 {
1954 	void *p = rtwtxq;
1955 
1956 	return container_of(p, struct ieee80211_txq, drv_priv);
1957 }
1958 
1959 static inline struct ieee80211_vif *rtwvif_to_vif(struct rtw_vif *rtwvif)
1960 {
1961 	void *p = rtwvif;
1962 
1963 	return container_of(p, struct ieee80211_vif, drv_priv);
1964 }
1965 
1966 static inline bool rtw_ssid_equal(struct cfg80211_ssid *a,
1967 				  struct cfg80211_ssid *b)
1968 {
1969 	if (!a || !b || a->ssid_len != b->ssid_len)
1970 		return false;
1971 
1972 	if (memcmp(a->ssid, b->ssid, a->ssid_len))
1973 		return false;
1974 
1975 	return true;
1976 }
1977 
1978 static inline void rtw_chip_efuse_grant_on(struct rtw_dev *rtwdev)
1979 {
1980 	if (rtwdev->chip->ops->efuse_grant)
1981 		rtwdev->chip->ops->efuse_grant(rtwdev, true);
1982 }
1983 
1984 static inline void rtw_chip_efuse_grant_off(struct rtw_dev *rtwdev)
1985 {
1986 	if (rtwdev->chip->ops->efuse_grant)
1987 		rtwdev->chip->ops->efuse_grant(rtwdev, false);
1988 }
1989 
1990 static inline bool rtw_chip_wcpu_11n(struct rtw_dev *rtwdev)
1991 {
1992 	return rtwdev->chip->wlan_cpu == RTW_WCPU_11N;
1993 }
1994 
1995 static inline bool rtw_chip_wcpu_11ac(struct rtw_dev *rtwdev)
1996 {
1997 	return rtwdev->chip->wlan_cpu == RTW_WCPU_11AC;
1998 }
1999 
2000 static inline bool rtw_chip_has_rx_ldpc(struct rtw_dev *rtwdev)
2001 {
2002 	return rtwdev->chip->rx_ldpc;
2003 }
2004 
2005 static inline bool rtw_chip_has_tx_stbc(struct rtw_dev *rtwdev)
2006 {
2007 	return rtwdev->chip->tx_stbc;
2008 }
2009 
2010 static inline void rtw_release_macid(struct rtw_dev *rtwdev, u8 mac_id)
2011 {
2012 	clear_bit(mac_id, rtwdev->mac_id_map);
2013 }
2014 
2015 static inline int rtw_chip_dump_fw_crash(struct rtw_dev *rtwdev)
2016 {
2017 	if (rtwdev->chip->ops->dump_fw_crash)
2018 		return rtwdev->chip->ops->dump_fw_crash(rtwdev);
2019 
2020 	return 0;
2021 }
2022 
2023 void rtw_get_channel_params(struct cfg80211_chan_def *chandef,
2024 			    struct rtw_channel_params *ch_param);
2025 bool check_hw_ready(struct rtw_dev *rtwdev, u32 addr, u32 mask, u32 target);
2026 bool ltecoex_read_reg(struct rtw_dev *rtwdev, u16 offset, u32 *val);
2027 bool ltecoex_reg_write(struct rtw_dev *rtwdev, u16 offset, u32 value);
2028 void rtw_restore_reg(struct rtw_dev *rtwdev,
2029 		     struct rtw_backup_info *bckp, u32 num);
2030 void rtw_desc_to_mcsrate(u16 rate, u8 *mcs, u8 *nss);
2031 void rtw_set_channel(struct rtw_dev *rtwdev);
2032 void rtw_chip_prepare_tx(struct rtw_dev *rtwdev);
2033 void rtw_vif_port_config(struct rtw_dev *rtwdev, struct rtw_vif *rtwvif,
2034 			 u32 config);
2035 void rtw_tx_report_purge_timer(struct timer_list *t);
2036 void rtw_update_sta_info(struct rtw_dev *rtwdev, struct rtw_sta_info *si);
2037 int rtw_core_start(struct rtw_dev *rtwdev);
2038 void rtw_core_stop(struct rtw_dev *rtwdev);
2039 int rtw_chip_info_setup(struct rtw_dev *rtwdev);
2040 int rtw_core_init(struct rtw_dev *rtwdev);
2041 void rtw_core_deinit(struct rtw_dev *rtwdev);
2042 int rtw_register_hw(struct rtw_dev *rtwdev, struct ieee80211_hw *hw);
2043 void rtw_unregister_hw(struct rtw_dev *rtwdev, struct ieee80211_hw *hw);
2044 u16 rtw_desc_to_bitrate(u8 desc_rate);
2045 void rtw_vif_assoc_changed(struct rtw_vif *rtwvif,
2046 			   struct ieee80211_bss_conf *conf);
2047 int rtw_sta_add(struct rtw_dev *rtwdev, struct ieee80211_sta *sta,
2048 		struct ieee80211_vif *vif);
2049 void rtw_sta_remove(struct rtw_dev *rtwdev, struct ieee80211_sta *sta,
2050 		    bool fw_exist);
2051 void rtw_fw_recovery(struct rtw_dev *rtwdev);
2052 void rtw_core_fw_scan_notify(struct rtw_dev *rtwdev, bool start);
2053 int rtw_dump_fw(struct rtw_dev *rtwdev, const u32 ocp_src, u32 size,
2054 		u32 fwcd_item);
2055 int rtw_dump_reg(struct rtw_dev *rtwdev, const u32 addr, const u32 size);
2056 
2057 #endif
2058