1 /******************************************************************************
3 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
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.
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
14 ******************************************************************************/
15 /*-------------------------------------------------------------------------------
17 For type defines and data structure defines
19 --------------------------------------------------------------------------------*/
22 #ifndef __DRV_TYPES_H__
23 #define __DRV_TYPES_H__
25 #include <linux/version.h>
26 #include <linux/sched/signal.h>
28 #include <basic_types.h>
29 #include <osdep_service.h>
30 #include <rtw_byteorder.h>
31 #include <wlan_bssdef.h>
33 #include <ieee80211.h>
48 #ifdef CONFIG_INTEL_WIDI
49 #include <rtw_intel_widi.h>
53 #include <cmd_osdep.h>
54 #include <rtw_security.h>
56 #include <xmit_osdep.h>
59 #include <recv_osdep.h>
60 #include <rtw_efuse.h>
64 #include <rtw_pwrctrl.h>
66 #include <mlme_osdep.h>
68 #include <rtw_ioctl.h>
69 #include <rtw_ioctl_set.h>
70 #include <osdep_intf.h>
71 #include <rtw_eeprom.h>
73 #include <rtw_event.h>
74 #include <rtw_mlme_ext.h>
76 #include <rtw_efuse.h>
77 #include <rtw_version.h>
80 #include "ioctl_cfg80211.h"
83 #include <linux/if_ether.h>
86 #define SPEC_DEV_ID_NONE BIT(0)
87 #define SPEC_DEV_ID_DISABLE_HT BIT(1)
88 #define SPEC_DEV_ID_ENABLE_PS BIT(2)
89 #define SPEC_DEV_ID_RF_CONFIG_1T1R BIT(3)
90 #define SPEC_DEV_ID_RF_CONFIG_2T2R BIT(4)
91 #define SPEC_DEV_ID_ASSIGN_IFNAME BIT(5)
93 struct specific_device_id{
108 struct ndis_802_11_ssid ssid;
109 u8 network_mode; /* infra, ad-hoc, auto */
110 u8 channel;/* ad-hoc support requirement */
111 u8 wireless_mode;/* A, B, G, auto */
112 u8 scan_mode;/* active, passive */
114 u8 preamble;/* long, short, auto */
115 u8 vrtl_carrier_sense;/* Enable, Disable, Auto */
116 u8 vcs_type;/* RTS/CTS, CTS-to-self */
142 struct wlan_bssid_ex dev_network;
145 /* 0: 20 MHz, 1: 40 MHz, 2: 80 MHz, 3: 160MHz */
146 /* 2.4G use bit 0 ~ 3, 5G use bit 4 ~ 7 */
147 /* 0x21 means enable 2.4G 40MHz & 5G 80MHz */
149 u8 ampdu_enable;/* for tx */
151 u8 ampdu_amsdu;/* A-MPDU Supports A-MSDU is permitted */
152 /* Short GI support Bit Map */
153 /* BIT0 - 20MHz, 1: support, 0: non-support */
154 /* BIT1 - 40MHz, 1: support, 0: non-support */
155 /* BIT2 - 80MHz, 1: support, 0: non-support */
156 /* BIT3 - 160MHz, 1: support, 0: non-support */
158 /* BIT0: Enable VHT LDPC Rx, BIT1: Enable VHT LDPC Tx, BIT4: Enable HT LDPC Rx, BIT5: Enable HT LDPC Tx */
160 /* BIT0: Enable VHT STBC Rx, BIT1: Enable VHT STBC Tx, BIT4: Enable HT STBC Rx, BIT5: Enable HT STBC Tx */
162 /* BIT0: Enable VHT Beamformer, BIT1: Enable VHT Beamformee, BIT4: Enable HT Beamformer, BIT5: Enable HT Beamformee */
170 u8 wifi_spec;/* !turbo_mode */
180 bool bAcceptAddbaReq;
185 u8 usbss_enable;/* 0:disable, 1:enable */
186 u8 hwpdn_mode;/* 0:disable, 1:enable, 2:decide by EFUSE config */
187 u8 hwpwrp_detect;/* 0:disable, 1:enable */
189 u8 hw_wps_pbc;/* 0:disable, 1:enable */
191 u8 max_roaming_times; /* the max number driver will try to roaming */
199 /* define for tx power adjust */
200 u8 RegEnableTxPowerLimit;
201 u8 RegEnableTxPowerByRate;
213 u8 RegDecryptCustomFile;
215 #ifdef CONFIG_MULTI_VIR_IFACES
216 u8 ext_iface_num;/* primary/secondary iface is excluded */
224 /* For registry parameters */
225 #define RGTRY_OFT(field) ((u32)FIELD_OFFSET(struct registry_priv, field))
226 #define RGTRY_SZ(field) sizeof(((struct registry_priv*) 0)->field)
227 #define BSSID_OFT(field) ((u32)FIELD_OFFSET(struct wlan_bssid_ex, field))
228 #define BSSID_SZ(field) sizeof(((struct wlan_bssid_ex *) 0)->field)
230 #include <drv_types_sdio.h>
231 #define INTF_DATA SDIO_DATA
233 #define is_primary_adapter(adapter) (1)
234 #define get_iface_type(adapter) (IFACE_PORT0)
235 #define GET_PRIMARY_ADAPTER(padapter) (((struct adapter *)padapter)->dvobj->if1)
236 #define GET_IFACE_NUMS(padapter) (((struct adapter *)padapter)->dvobj->iface_nums)
237 #define GET_ADAPTER(padapter, iface_id) (((struct adapter *)padapter)->dvobj->padapters[iface_id])
239 #ifdef CONFIG_DBG_COUNTER
243 u32 intf_rx_err_recvframe;
248 u32 core_rx_pre_ver_err;
249 u32 core_rx_pre_mgmt;
250 u32 core_rx_pre_mgmt_err_80211w;
251 u32 core_rx_pre_mgmt_err;
252 u32 core_rx_pre_ctrl;
253 u32 core_rx_pre_ctrl_err;
254 u32 core_rx_pre_data;
255 u32 core_rx_pre_data_wapi_seq_err;
256 u32 core_rx_pre_data_wapi_key_err;
257 u32 core_rx_pre_data_handled;
258 u32 core_rx_pre_data_err;
259 u32 core_rx_pre_data_unknown;
260 u32 core_rx_pre_unknown;
264 u32 core_rx_post_decrypt;
265 u32 core_rx_post_decrypt_wep;
266 u32 core_rx_post_decrypt_tkip;
267 u32 core_rx_post_decrypt_aes;
268 u32 core_rx_post_decrypt_wapi;
269 u32 core_rx_post_decrypt_hw;
270 u32 core_rx_post_decrypt_unknown;
271 u32 core_rx_post_decrypt_err;
272 u32 core_rx_post_defrag_err;
273 u32 core_rx_post_portctrl_err;
274 u32 core_rx_post_indicate;
275 u32 core_rx_post_indicate_in_oder;
276 u32 core_rx_post_indicate_reoder;
277 u32 core_rx_post_indicate_err;
279 u32 os_indicate_ap_mcast;
280 u32 os_indicate_ap_forward;
281 u32 os_indicate_ap_self;
292 u32 os_tx_m2u_ignore_fw_linked;
293 u32 os_tx_m2u_ignore_self;
295 u32 os_tx_m2u_entry_err_xmit;
296 u32 os_tx_m2u_entry_err_skb;
299 u32 core_tx_err_pxmitframe;
300 u32 core_tx_err_brtx;
301 u32 core_tx_upd_attrib;
302 u32 core_tx_upd_attrib_adhoc;
303 u32 core_tx_upd_attrib_sta;
304 u32 core_tx_upd_attrib_ap;
305 u32 core_tx_upd_attrib_unknown;
306 u32 core_tx_upd_attrib_dhcp;
307 u32 core_tx_upd_attrib_icmp;
308 u32 core_tx_upd_attrib_active;
309 u32 core_tx_upd_attrib_err_ucast_sta;
310 u32 core_tx_upd_attrib_err_ucast_ap_link;
311 u32 core_tx_upd_attrib_err_sta;
312 u32 core_tx_upd_attrib_err_link;
313 u32 core_tx_upd_attrib_err_sec;
314 u32 core_tx_ap_enqueue_warn_fwstate;
315 u32 core_tx_ap_enqueue_warn_sta;
316 u32 core_tx_ap_enqueue_warn_nosta;
317 u32 core_tx_ap_enqueue_warn_link;
318 u32 core_tx_ap_enqueue_warn_trigger;
319 u32 core_tx_ap_enqueue_mcast;
320 u32 core_tx_ap_enqueue_ucast;
321 u32 core_tx_ap_enqueue;
323 u32 intf_tx_pending_ac;
324 u32 intf_tx_pending_fw_under_survey;
325 u32 intf_tx_pending_fw_under_linking;
326 u32 intf_tx_pending_xmitbuf;
329 u32 core_tx_enqueue_class;
330 u32 core_tx_enqueue_class_err_sta;
331 u32 core_tx_enqueue_class_err_nosta;
332 u32 core_tx_enqueue_class_err_fwlink;
334 u32 intf_tx_direct_err_coalesce;
336 u32 intf_tx_dequeue_err_coalesce;
337 u32 intf_tx_dump_xframe;
338 u32 intf_tx_dump_xframe_err_txdesc;
339 u32 intf_tx_dump_xframe_err_port;
362 #endif /* CONFIG_DBG_COUNTER */
365 u32 dbg_sdio_free_irq_error_cnt;
366 u32 dbg_sdio_alloc_irq_error_cnt;
367 u32 dbg_sdio_free_irq_cnt;
368 u32 dbg_sdio_alloc_irq_cnt;
369 u32 dbg_sdio_deinit_error_cnt;
370 u32 dbg_sdio_init_error_cnt;
371 u32 dbg_suspend_error_cnt;
374 u32 dbg_resume_error_cnt;
375 u32 dbg_deinit_fail_cnt;
376 u32 dbg_carddisable_cnt;
377 u32 dbg_carddisable_error_cnt;
378 u32 dbg_ps_insuspend_cnt;
379 u32 dbg_dev_unload_inIPS_cnt;
380 u32 dbg_wow_leave_ps_fail_cnt;
381 u32 dbg_scan_pwr_state_cnt;
382 u32 dbg_downloadfw_pwr_state_cnt;
383 u32 dbg_fw_read_ps_state_fail_cnt;
384 u32 dbg_leave_ips_fail_cnt;
385 u32 dbg_leave_lps_fail_cnt;
386 u32 dbg_h2c_leave32k_fail_cnt;
387 u32 dbg_diswow_dload_fw_fail_cnt;
388 u32 dbg_enwow_dload_fw_fail_cnt;
389 u32 dbg_ips_drvopen_fail_cnt;
390 u32 dbg_poll_fail_cnt;
391 u32 dbg_rpwm_toogle_cnt;
392 u32 dbg_rpwm_timeout_fail_cnt;
393 u64 dbg_rx_fifo_last_overflow;
394 u64 dbg_rx_fifo_curr_overflow;
395 u64 dbg_rx_fifo_diff_overflow;
396 u64 dbg_rx_ampdu_drop_count;
397 u64 dbg_rx_ampdu_forced_indicate_count;
398 u64 dbg_rx_ampdu_loss_count;
399 u64 dbg_rx_dup_mgt_frame_drop_count;
400 u64 dbg_rx_ampdu_window_shift_cnt;
403 struct rtw_traffic_statistics {
410 u32 cur_tx_tp; /* Tx throughput in MBps. */
418 u32 cur_rx_tp; /* Rx throughput in MBps. */
426 struct cam_entry_cache {
432 #define KEY_FMT "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x"
433 #define KEY_ARG(x) ((u8 *)(x))[0], ((u8 *)(x))[1], ((u8 *)(x))[2], ((u8 *)(x))[3], ((u8 *)(x))[4], ((u8 *)(x))[5], \
434 ((u8 *)(x))[6], ((u8 *)(x))[7], ((u8 *)(x))[8], ((u8 *)(x))[9], ((u8 *)(x))[10], ((u8 *)(x))[11], \
435 ((u8 *)(x))[12], ((u8 *)(x))[13], ((u8 *)(x))[14], ((u8 *)(x))[15]
439 /*-------- below is common data --------*/
440 struct adapter *if1; /* PRIMARY_ADAPTER */
441 struct adapter *if2; /* SECONDARY_ADAPTER */
443 s32 processing_dev_remove;
445 struct debug_priv drv_dbg;
447 /* for local/global synchronization */
452 _mutex hw_init_mutex;
453 _mutex h2c_fwcmd_mutex;
457 unsigned char oper_channel; /* saved channel info when call set_channel_bw */
458 unsigned char oper_bwmode;
459 unsigned char oper_ch_offset;/* PRIME_CHNL_OFFSET */
460 unsigned long on_oper_ch_time;
462 struct adapter *padapters;
464 struct cam_ctl_t cam_ctl;
465 struct cam_entry_cache cam_cache[TOTAL_CAM_ENTRY];
467 /* For 92D, DMDP have 2 interface. */
471 /* In /Out Pipe information */
474 u8 Queue2Pipe[HW_QUEUE_ENTRY];/* for out pipe mapping */
477 atomic_t continual_io_error;
479 atomic_t disable_func;
481 struct pwrctrl_priv pwrctl_priv;
483 struct rtw_traffic_statistics traffic_stat;
485 /*-------- below is for SDIO INTERFACE --------*/
492 #define dvobj_to_pwrctl(dvobj) (&(dvobj->pwrctl_priv))
493 #define pwrctl_to_dvobj(pwrctl) container_of(pwrctl, struct dvobj_priv, pwrctl_priv)
495 __inline static struct device *dvobj_to_dev(struct dvobj_priv *dvobj)
497 /* todo: get interface type from dvobj and the return the dev accordingly */
498 #ifdef RTW_DVOBJ_CHIP_HW_TYPE
501 return &dvobj->intf_data.func->dev;
504 struct adapter *dvobj_get_port0_adapter(struct dvobj_priv *dvobj);
507 IFACE_PORT0, /* mapping to port0 for C/D series chips */
508 IFACE_PORT1, /* mapping to port1 for C/D series chip */
518 typedef enum _DRIVER_STATE{
520 DRIVER_DISAPPEAR = 1,
521 DRIVER_REPLACE_DONGLE = 2,
525 int DriverState;/* for disable driver using module, use dongle to replace module. */
526 int pid[3];/* process id from UI, 0:wps, 1:hostapd, 2:dhcpcd */
527 int bDongle;/* build-in module or external dongle */
529 struct dvobj_priv *dvobj;
530 struct mlme_priv mlmepriv;
531 struct mlme_ext_priv mlmeextpriv;
532 struct cmd_priv cmdpriv;
533 struct evt_priv evtpriv;
534 /* struct io_queue *pio_queue; */
535 struct io_priv iopriv;
536 struct xmit_priv xmitpriv;
537 struct recv_priv recvpriv;
538 struct sta_priv stapriv;
539 struct security_priv securitypriv;
540 _lock security_key_mutex; /* add for CONFIG_IEEE80211W, none 11w also can use */
541 struct registry_priv registrypriv;
542 struct eeprom_priv eeprompriv;
544 struct hostapd_priv *phostapdpriv;
550 struct hal_ops HalFunc;
553 s32 bSurpriseRemoved;
554 s32 bCardDisableWOHSM;
559 u8 EepromAddressSize;
560 u8 hw_init_completed;
561 u8 bDriverIsGoingToUnload;
562 u8 init_adpt_in_progress;
570 u32 (*intf_init)(struct dvobj_priv *dvobj);
571 void (*intf_deinit)(struct dvobj_priv *dvobj);
572 int (*intf_alloc_irq)(struct dvobj_priv *dvobj);
573 void (*intf_free_irq)(struct dvobj_priv *dvobj);
576 void (*intf_start)(struct adapter * adapter);
577 void (*intf_stop)(struct adapter * adapter);
580 char old_ifname[IFNAMSIZ];
582 /* used by rtw_rereg_nd_name related function */
583 struct rereg_nd_name_data {
584 _nic_hdl old_pnetdev;
585 char old_ifname[IFNAMSIZ];
588 } rereg_nd_name_priv;
591 struct net_device_stats stats;
592 struct iw_statistics iwstats;
593 struct proc_dir_entry *dir_dev;/* for proc directory */
594 struct proc_dir_entry *dir_odm;
596 struct wireless_dev *rtw_wdev;
597 struct rtw_wdev_priv wdev_data;
607 /* Added by Albert 2012/10/26 */
608 /* The driver will show up the desired channel number when this flag is 1. */
609 u8 bNotifyChannelChange;
611 /* pbuddystruct adapter is used only in two inteface case, (iface_nums =2 in struct dvobj_priv) */
612 /* PRIMARY ADAPTER's buddy is SECONDARY_ADAPTER */
613 /* SECONDARY_ADAPTER's buddy is PRIMARY_ADAPTER */
614 /* for iface_id > SECONDARY_ADAPTER(IFACE_ID1), refer to padapters[iface_id] in struct dvobj_priv */
615 /* and their pbuddystruct adapter is PRIMARY_ADAPTER. */
616 /* for PRIMARY_ADAPTER(IFACE_ID0) can directly refer to if1 in struct dvobj_priv */
617 struct adapter *pbuddy_adapter;
619 /* extend to support multi interface */
620 /* IFACE_ID0 is equals to PRIMARY_ADAPTER */
621 /* IFACE_ID1 is equals to SECONDARY_ADAPTER */
624 /* for debug purpose */
626 u8 driver_vcs_en; /* Enable = 1, Disable = 0 driver control vrtl_carrier_sense for tx */
627 u8 driver_vcs_type;/* force 0:disable VCS, 1:RTS-CTS, 2:CTS-to-self when vcs_en = 1. */
628 u8 driver_ampdu_spacing;/* driver control AMPDU Density for peer sta's rx */
629 u8 driver_rx_ampdu_factor;/* 0xff: disable drv ctrl, 0:8k, 1:16k, 2:32k, 3:64k; */
631 unsigned char in_cta_test;
633 #ifdef CONFIG_DBG_COUNTER
634 struct rx_logs rx_logs;
635 struct tx_logs tx_logs;
636 struct int_logs int_logs;
640 #define adapter_to_dvobj(adapter) (adapter->dvobj)
641 #define adapter_to_pwrctl(adapter) (dvobj_to_pwrctl(adapter->dvobj))
642 #define adapter_wdev_data(adapter) (&((adapter)->wdev_data))
645 /* Function disabled. */
647 #define DF_TX_BIT BIT0
648 #define DF_RX_BIT BIT1
649 #define DF_IO_BIT BIT2
651 /* define RTW_DISABLE_FUNC(padapter, func) (atomic_add(&adapter_to_dvobj(padapter)->disable_func, (func))) */
652 /* define RTW_ENABLE_FUNC(padapter, func) (atomic_sub(&adapter_to_dvobj(padapter)->disable_func, (func))) */
653 __inline static void RTW_DISABLE_FUNC(struct adapter *padapter, int func_bit)
655 int df = atomic_read(&adapter_to_dvobj(padapter)->disable_func);
657 atomic_set(&adapter_to_dvobj(padapter)->disable_func, df);
660 __inline static void RTW_ENABLE_FUNC(struct adapter *padapter, int func_bit)
662 int df = atomic_read(&adapter_to_dvobj(padapter)->disable_func);
664 atomic_set(&adapter_to_dvobj(padapter)->disable_func, df);
667 #define RTW_IS_FUNC_DISABLED(padapter, func_bit) (atomic_read(&adapter_to_dvobj(padapter)->disable_func) & (func_bit))
669 #define RTW_CANNOT_IO(padapter) \
670 ((padapter)->bSurpriseRemoved || \
671 RTW_IS_FUNC_DISABLED((padapter), DF_IO_BIT))
673 #define RTW_CANNOT_RX(padapter) \
674 ((padapter)->bDriverStopped || \
675 (padapter)->bSurpriseRemoved || \
676 RTW_IS_FUNC_DISABLED((padapter), DF_RX_BIT))
678 #define RTW_CANNOT_TX(padapter) \
679 ((padapter)->bDriverStopped || \
680 (padapter)->bSurpriseRemoved || \
681 RTW_IS_FUNC_DISABLED((padapter), DF_TX_BIT))
683 #ifdef CONFIG_GPIO_API
684 int rtw_get_gpio(struct net_device *netdev, int gpio_num);
685 int rtw_set_gpio_output_value(struct net_device *netdev, int gpio_num, bool isHigh);
686 int rtw_config_gpio(struct net_device *netdev, int gpio_num, bool isOutput);
690 int rtw_suspend_wow(struct adapter *padapter);
691 int rtw_resume_process_wow(struct adapter *padapter);
694 __inline static u8 *myid(struct eeprom_priv *peepriv)
696 return (peepriv->mac_addr);
699 /* HCI Related header file */
700 #include <sdio_osintf.h>
701 #include <sdio_ops.h>
702 #include <sdio_hal.h>
704 #include <rtw_btcoex.h>
706 void rtw_indicate_wx_disassoc_event(struct adapter *padapter);
707 void rtw_indicate_wx_assoc_event(struct adapter *padapter);
708 void rtw_indicate_wx_disassoc_event(struct adapter *padapter);
709 void indicate_wx_scan_complete_event(struct adapter *padapter);
710 int rtw_change_ifname(struct adapter *padapter, const char *ifname);
712 extern char *rtw_phy_file_path;
713 extern char *rtw_initmac;
714 extern int rtw_mc2u_disable;
715 extern int rtw_ht_enable;
716 extern u32 g_wait_hiq_empty;
717 extern u8 g_fwdl_wintint_rdy_fail;
718 extern u8 g_fwdl_chksum_fail;
720 #endif /* __DRV_TYPES_H__ */