1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3 *
4 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
5 *
6 ******************************************************************************/
7 /*-------------------------------------------------------------------------------
8
9 For type defines and data structure defines
10
11 --------------------------------------------------------------------------------*/
12
13
14 #ifndef __DRV_TYPES_H__
15 #define __DRV_TYPES_H__
16
17 #include <linux/sched/signal.h>
18 #include <basic_types.h>
19 #include <osdep_service.h>
20 #include <rtw_byteorder.h>
21 #include <wlan_bssdef.h>
22 #include <wifi.h>
23 #include <ieee80211.h>
24
25 #include <rtw_rf.h>
26
27 #include <rtw_ht.h>
28
29 #include <rtw_cmd.h>
30 #include <cmd_osdep.h>
31 #include <rtw_security.h>
32 #include <rtw_xmit.h>
33 #include <xmit_osdep.h>
34 #include <rtw_recv.h>
35
36 #include <recv_osdep.h>
37 #include <rtw_efuse.h>
38 #include <hal_intf.h>
39 #include <hal_com.h>
40 #include <rtw_qos.h>
41 #include <rtw_pwrctrl.h>
42 #include <rtw_mlme.h>
43 #include <mlme_osdep.h>
44 #include <rtw_io.h>
45 #include <rtw_ioctl_set.h>
46 #include <osdep_intf.h>
47 #include <rtw_eeprom.h>
48 #include <sta_info.h>
49 #include <rtw_event.h>
50 #include <rtw_mlme_ext.h>
51 #include <rtw_ap.h>
52 #include <rtw_version.h>
53
54 #include "ioctl_cfg80211.h"
55
56 #include <linux/ip.h>
57 #include <linux/if_ether.h>
58
59 #define SPEC_DEV_ID_NONE BIT(0)
60 #define SPEC_DEV_ID_DISABLE_HT BIT(1)
61 #define SPEC_DEV_ID_ENABLE_PS BIT(2)
62 #define SPEC_DEV_ID_RF_CONFIG_1T1R BIT(3)
63 #define SPEC_DEV_ID_RF_CONFIG_2T2R BIT(4)
64 #define SPEC_DEV_ID_ASSIGN_IFNAME BIT(5)
65
66 struct registry_priv {
67 u8 chip_version;
68 u8 rfintfs;
69 u8 lbkmode;
70 u8 hci;
71 struct ndis_802_11_ssid ssid;
72 u8 network_mode; /* infra, ad-hoc, auto */
73 u8 channel;/* ad-hoc support requirement */
74 u8 wireless_mode;/* A, B, G, auto */
75 u8 scan_mode;/* active, passive */
76 u8 radio_enable;
77 u8 preamble;/* long, short, auto */
78 u8 vrtl_carrier_sense;/* Enable, Disable, Auto */
79 u8 vcs_type;/* RTS/CTS, CTS-to-self */
80 u16 rts_thresh;
81 u16 frag_thresh;
82 u8 adhoc_tx_pwr;
83 u8 soft_ap;
84 u8 power_mgnt;
85 u8 ips_mode;
86 u8 smart_ps;
87 u8 usb_rxagg_mode;
88 u8 long_retry_lmt;
89 u8 short_retry_lmt;
90 u16 busy_thresh;
91 u8 ack_policy;
92 u8 mp_dm;
93 u8 software_encrypt;
94 u8 software_decrypt;
95 u8 acm_method;
96 /* UAPSD */
97 u8 wmm_enable;
98 u8 uapsd_enable;
99 u8 uapsd_max_sp;
100 u8 uapsd_acbk_en;
101 u8 uapsd_acbe_en;
102 u8 uapsd_acvi_en;
103 u8 uapsd_acvo_en;
104
105 struct wlan_bssid_ex dev_network;
106
107 u8 ht_enable;
108 /*
109 * 0: 20 MHz, 1: 40 MHz
110 * 2.4G use bit 0 ~ 3
111 * 0x01 means enable 2.4G 40MHz
112 */
113 u8 bw_mode;
114 u8 ampdu_enable;/* for tx */
115 u8 rx_stbc;
116 u8 ampdu_amsdu;/* A-MPDU Supports A-MSDU is permitted */
117 /* Short GI support Bit Map */
118 /* BIT0 - 20MHz, 1: support, 0: non-support */
119 /* BIT1 - 40MHz, 1: support, 0: non-support */
120 /* BIT2 - 80MHz, 1: support, 0: non-support */
121 /* BIT3 - 160MHz, 1: support, 0: non-support */
122 u8 short_gi;
123 /* BIT0: Enable VHT LDPC Rx, BIT1: Enable VHT LDPC Tx, BIT4: Enable HT LDPC Rx, BIT5: Enable HT LDPC Tx */
124 u8 ldpc_cap;
125 /* BIT0: Enable VHT STBC Rx, BIT1: Enable VHT STBC Tx, BIT4: Enable HT STBC Rx, BIT5: Enable HT STBC Tx */
126 u8 stbc_cap;
127 /* BIT0: Enable VHT Beamformer, BIT1: Enable VHT Beamformee, BIT4: Enable HT Beamformer, BIT5: Enable HT Beamformee */
128 u8 beamform_cap;
129
130 u8 lowrate_two_xmit;
131
132 u8 low_power;
133
134 u8 wifi_spec;/* !turbo_mode */
135
136 u8 channel_plan;
137
138 s8 ant_num;
139
140 /* false:Reject AP's Add BA req, true:accept AP's Add BA req */
141 bool accept_addba_req;
142
143 u8 antdiv_cfg;
144 u8 antdiv_type;
145
146 u8 usbss_enable;/* 0:disable, 1:enable */
147 u8 hwpdn_mode;/* 0:disable, 1:enable, 2:decide by EFUSE config */
148 u8 hwpwrp_detect;/* 0:disable, 1:enable */
149
150 u8 hw_wps_pbc;/* 0:disable, 1:enable */
151
152 u8 max_roaming_times; /* the max number driver will try to roaming */
153
154 u8 enable80211d;
155
156 u8 ifname[16];
157
158 u8 notch_filter;
159
160 /* define for tx power adjust */
161 u8 RegEnableTxPowerLimit;
162 u8 RegEnableTxPowerByRate;
163 u8 RegPowerBase;
164 u8 RegPwrTblSel;
165 s8 TxBBSwing_2G;
166 u8 AmplifierType_2G;
167 u8 bEn_RFE;
168 u8 RFE_Type;
169 u8 check_fw_ps;
170
171 u8 qos_opt_enable;
172
173 u8 hiq_filter;
174 };
175
176
177 /* For registry parameters */
178 #define RGTRY_OFT(field) ((u32)FIELD_OFFSET(struct registry_priv, field))
179 #define RGTRY_SZ(field) sizeof(((struct registry_priv *)0)->field)
180 #define BSSID_OFT(field) ((u32)FIELD_OFFSET(struct wlan_bssid_ex, field))
181 #define BSSID_SZ(field) sizeof(((struct wlan_bssid_ex *) 0)->field)
182
183 #include <drv_types_sdio.h>
184
185 #define GET_PRIMARY_ADAPTER(padapter) (((struct adapter *)padapter)->dvobj->if1)
186 #define GET_IFACE_NUMS(padapter) (((struct adapter *)padapter)->dvobj->iface_nums)
187 #define GET_ADAPTER(padapter, iface_id) (((struct adapter *)padapter)->dvobj->padapters[iface_id])
188
189 struct debug_priv {
190 u32 dbg_sdio_free_irq_error_cnt;
191 u32 dbg_sdio_alloc_irq_error_cnt;
192 u32 dbg_sdio_free_irq_cnt;
193 u32 dbg_sdio_alloc_irq_cnt;
194 u32 dbg_sdio_deinit_error_cnt;
195 u32 dbg_sdio_init_error_cnt;
196 u32 dbg_suspend_error_cnt;
197 u32 dbg_suspend_cnt;
198 u32 dbg_resume_cnt;
199 u32 dbg_resume_error_cnt;
200 u32 dbg_deinit_fail_cnt;
201 u32 dbg_carddisable_cnt;
202 u32 dbg_carddisable_error_cnt;
203 u32 dbg_ps_insuspend_cnt;
204 u32 dbg_dev_unload_inIPS_cnt;
205 u32 dbg_wow_leave_ps_fail_cnt;
206 u32 dbg_scan_pwr_state_cnt;
207 u32 dbg_downloadfw_pwr_state_cnt;
208 u32 dbg_fw_read_ps_state_fail_cnt;
209 u32 dbg_leave_ips_fail_cnt;
210 u32 dbg_leave_lps_fail_cnt;
211 u32 dbg_h2c_leave32k_fail_cnt;
212 u32 dbg_diswow_dload_fw_fail_cnt;
213 u32 dbg_enwow_dload_fw_fail_cnt;
214 u32 dbg_ips_drvopen_fail_cnt;
215 u32 dbg_poll_fail_cnt;
216 u32 dbg_rpwm_toggle_cnt;
217 u32 dbg_rpwm_timeout_fail_cnt;
218 u64 dbg_rx_fifo_last_overflow;
219 u64 dbg_rx_fifo_curr_overflow;
220 u64 dbg_rx_fifo_diff_overflow;
221 u64 dbg_rx_ampdu_drop_count;
222 u64 dbg_rx_ampdu_forced_indicate_count;
223 u64 dbg_rx_ampdu_loss_count;
224 u64 dbg_rx_dup_mgt_frame_drop_count;
225 u64 dbg_rx_ampdu_window_shift_cnt;
226 };
227
228 struct rtw_traffic_statistics {
229 /* tx statistics */
230 u64 tx_bytes;
231 u64 tx_pkts;
232 u64 tx_drop;
233 u64 cur_tx_bytes;
234 u64 last_tx_bytes;
235 u32 cur_tx_tp; /* Tx throughput in MBps. */
236
237 /* rx statistics */
238 u64 rx_bytes;
239 u64 rx_pkts;
240 u64 rx_drop;
241 u64 cur_rx_bytes;
242 u64 last_rx_bytes;
243 u32 cur_rx_tp; /* Rx throughput in MBps. */
244 };
245
246 struct cam_ctl_t {
247 spinlock_t lock;
248 u64 bitmap;
249 };
250
251 struct cam_entry_cache {
252 u16 ctrl;
253 u8 mac[ETH_ALEN];
254 u8 key[16];
255 };
256
257 struct dvobj_priv {
258 /*-------- below is common data --------*/
259 struct adapter *if1; /* PRIMARY_ADAPTER */
260
261 s32 processing_dev_remove;
262
263 struct debug_priv drv_dbg;
264
265 /* for local/global synchronization */
266 /* */
267 spinlock_t lock;
268 int macid[NUM_STA];
269
270 struct mutex hw_init_mutex;
271 struct mutex h2c_fwcmd_mutex;
272 struct mutex setch_mutex;
273 struct mutex setbw_mutex;
274
275 unsigned char oper_channel; /* saved channel info when call set_channel_bw */
276 unsigned char oper_bwmode;
277 unsigned char oper_ch_offset;/* PRIME_CHNL_OFFSET */
278 unsigned long on_oper_ch_time;
279
280 struct adapter *padapters;
281
282 struct cam_ctl_t cam_ctl;
283 struct cam_entry_cache cam_cache[TOTAL_CAM_ENTRY];
284
285 /* In /Out Pipe information */
286 int RtInPipe[2];
287 int RtOutPipe[4];
288 u8 Queue2Pipe[HW_QUEUE_ENTRY];/* for out pipe mapping */
289
290 u8 irq_alloc;
291 atomic_t continual_io_error;
292
293 atomic_t disable_func;
294
295 struct pwrctrl_priv pwrctl_priv;
296
297 struct rtw_traffic_statistics traffic_stat;
298
299 /*-------- below is for SDIO INTERFACE --------*/
300
301 struct sdio_data intf_data;
302
303 };
304
305 #define dvobj_to_pwrctl(dvobj) (&(dvobj->pwrctl_priv))
306
pwrctl_to_dvobj(struct pwrctrl_priv * pwrctl_priv)307 static inline struct dvobj_priv *pwrctl_to_dvobj(struct pwrctrl_priv *pwrctl_priv)
308 {
309 return container_of(pwrctl_priv, struct dvobj_priv, pwrctl_priv);
310 }
311
dvobj_to_dev(struct dvobj_priv * dvobj)312 static inline struct device *dvobj_to_dev(struct dvobj_priv *dvobj)
313 {
314 /* todo: get interface type from dvobj and the return the dev accordingly */
315 #ifdef RTW_DVOBJ_CHIP_HW_TYPE
316 #endif
317
318 return &dvobj->intf_data.func->dev;
319 }
320
321 enum {
322 DRIVER_NORMAL = 0,
323 DRIVER_DISAPPEAR = 1,
324 DRIVER_REPLACE_DONGLE = 2,
325 };
326
327 struct adapter {
328 int DriverState;/* for disable driver using module, use dongle to replace module. */
329 int pid[3];/* process id from UI, 0:wps, 1:hostapd, 2:dhcpcd */
330 int bDongle;/* build-in module or external dongle */
331
332 struct dvobj_priv *dvobj;
333 struct mlme_priv mlmepriv;
334 struct mlme_ext_priv mlmeextpriv;
335 struct cmd_priv cmdpriv;
336 struct evt_priv evtpriv;
337 /* struct io_queue *pio_queue; */
338 struct io_priv iopriv;
339 struct xmit_priv xmitpriv;
340 struct recv_priv recvpriv;
341 struct sta_priv stapriv;
342 struct security_priv securitypriv;
343 spinlock_t security_key_mutex; /* add for CONFIG_IEEE80211W, none 11w also can use */
344 struct registry_priv registrypriv;
345 struct eeprom_priv eeprompriv;
346
347 struct hostapd_priv *phostapdpriv;
348
349 u32 setband;
350
351 void *HalData;
352 u32 hal_data_sz;
353 struct hal_ops HalFunc;
354
355 s32 bDriverStopped;
356 s32 bSurpriseRemoved;
357 s32 bCardDisableWOHSM;
358
359 u32 IsrContent;
360 u32 ImrContent;
361
362 u8 EepromAddressSize;
363 u8 hw_init_completed;
364 u8 bDriverIsGoingToUnload;
365 u8 init_adpt_in_progress;
366 u8 bHaltInProgress;
367
368 void *cmdThread;
369 void *evtThread;
370 void *xmitThread;
371 void *recvThread;
372
373 u32 (*intf_init)(struct dvobj_priv *dvobj);
374 void (*intf_deinit)(struct dvobj_priv *dvobj);
375 int (*intf_alloc_irq)(struct dvobj_priv *dvobj);
376 void (*intf_free_irq)(struct dvobj_priv *dvobj);
377
378
379 void (*intf_start)(struct adapter *adapter);
380 void (*intf_stop)(struct adapter *adapter);
381
382 struct net_device *pnetdev;
383 char old_ifname[IFNAMSIZ];
384
385 /* used by rtw_rereg_nd_name related function */
386 struct rereg_nd_name_data {
387 struct net_device *old_pnetdev;
388 char old_ifname[IFNAMSIZ];
389 u8 old_bRegUseLed;
390 } rereg_nd_name_priv;
391
392 int bup;
393 struct net_device_stats stats;
394 struct iw_statistics iwstats;
395
396 struct wireless_dev *rtw_wdev;
397 struct rtw_wdev_priv wdev_data;
398
399 int net_closed;
400
401 u8 netif_up;
402
403 u8 bFWReady;
404 u8 bBTFWReady;
405 u8 bLinkInfoDump;
406 u8 bRxRSSIDisplay;
407 /* Added by Albert 2012/10/26 */
408 /* The driver will show up the desired channel number when this flag is 1. */
409 u8 bNotifyChannelChange;
410
411 /* pbuddystruct adapter is used only in two interface case, (iface_nums =2 in struct dvobj_priv) */
412 /* PRIMARY ADAPTER's buddy is SECONDARY_ADAPTER */
413 /* SECONDARY_ADAPTER's buddy is PRIMARY_ADAPTER */
414 /* for iface_id > SECONDARY_ADAPTER(IFACE_ID1), refer to padapters[iface_id] in struct dvobj_priv */
415 /* and their pbuddystruct adapter is PRIMARY_ADAPTER. */
416 /* for PRIMARY_ADAPTER(IFACE_ID0) can directly refer to if1 in struct dvobj_priv */
417 struct adapter *pbuddy_adapter;
418
419 /* extend to support multi interface */
420 /* IFACE_ID0 is equals to PRIMARY_ADAPTER */
421 /* IFACE_ID1 is equals to SECONDARY_ADAPTER */
422 u8 iface_id;
423
424 /* for debug purpose */
425 u8 fix_rate;
426 u8 driver_vcs_en; /* Enable = 1, Disable = 0 driver control vrtl_carrier_sense for tx */
427 u8 driver_vcs_type;/* force 0:disable VCS, 1:RTS-CTS, 2:CTS-to-self when vcs_en = 1. */
428 u8 driver_ampdu_spacing;/* driver control AMPDU Density for peer sta's rx */
429 u8 driver_rx_ampdu_factor;/* 0xff: disable drv ctrl, 0:8k, 1:16k, 2:32k, 3:64k; */
430
431 unsigned char in_cta_test;
432 };
433
434 #define adapter_to_dvobj(adapter) (adapter->dvobj)
435 #define adapter_to_pwrctl(adapter) (dvobj_to_pwrctl(adapter->dvobj))
436 #define adapter_wdev_data(adapter) (&((adapter)->wdev_data))
437
438 /* */
439 /* Function disabled. */
440 /* */
441 #define DF_TX_BIT BIT0
442 #define DF_RX_BIT BIT1
443 #define DF_IO_BIT BIT2
444
445 /* define RTW_ENABLE_FUNC(padapter, func) (atomic_sub(&adapter_to_dvobj(padapter)->disable_func, (func))) */
446
RTW_ENABLE_FUNC(struct adapter * padapter,int func_bit)447 static inline void RTW_ENABLE_FUNC(struct adapter *padapter, int func_bit)
448 {
449 int df = atomic_read(&adapter_to_dvobj(padapter)->disable_func);
450 df &= ~(func_bit);
451 atomic_set(&adapter_to_dvobj(padapter)->disable_func, df);
452 }
453
454 #define RTW_IS_FUNC_DISABLED(padapter, func_bit) (atomic_read(&adapter_to_dvobj(padapter)->disable_func) & (func_bit))
455
456 #define RTW_CANNOT_IO(padapter) \
457 ((padapter)->bSurpriseRemoved || \
458 RTW_IS_FUNC_DISABLED((padapter), DF_IO_BIT))
459
460 #define RTW_CANNOT_RX(padapter) \
461 ((padapter)->bDriverStopped || \
462 (padapter)->bSurpriseRemoved || \
463 RTW_IS_FUNC_DISABLED((padapter), DF_RX_BIT))
464
465 #define RTW_CANNOT_TX(padapter) \
466 ((padapter)->bDriverStopped || \
467 (padapter)->bSurpriseRemoved || \
468 RTW_IS_FUNC_DISABLED((padapter), DF_TX_BIT))
469
myid(struct eeprom_priv * peepriv)470 static inline u8 *myid(struct eeprom_priv *peepriv)
471 {
472 return peepriv->mac_addr;
473 }
474
475 /* HCI Related header file */
476 #include <sdio_ops.h>
477 #include <sdio_hal.h>
478
479 #include <rtw_btcoex.h>
480
481 extern char *rtw_initmac;
482 extern int rtw_mc2u_disable;
483 extern int rtw_ht_enable;
484 extern u32 g_wait_hiq_empty;
485 extern u8 g_fwdl_wintint_rdy_fail;
486 extern u8 g_fwdl_chksum_fail;
487
488 #endif /* __DRV_TYPES_H__ */
489