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