LXR linux/drivers/staging/rtl8723bs/include/drv

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