/* SPDX-License-Identifier: GPL-2.0 */
/******************************************************************************
 *
 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
 *
 ******************************************************************************/
/*-------------------------------------------------------------------------------

        For type defines and data structure defines

--------------------------------------------------------------------------------*/


#ifndef __DRV_TYPES_H__
#define __DRV_TYPES_H__

#include <linux/sched/signal.h>
#include <basic_types.h>
#include <osdep_service.h>
#include <rtw_byteorder.h>
#include <wlan_bssdef.h>
#include <wifi.h>
#include <ieee80211.h>

#include <rtw_rf.h>

#include <rtw_ht.h>

#include <rtw_cmd.h>
#include <cmd_osdep.h>
#include <rtw_security.h>
#include <rtw_xmit.h>
#include <xmit_osdep.h>
#include <rtw_recv.h>

#include <rtw_efuse.h>
#include <hal_intf.h>
#include <hal_com.h>
#include <rtw_qos.h>
#include <rtw_pwrctrl.h>
#include <rtw_mlme.h>
#include <rtw_io.h>
#include <rtw_ioctl_set.h>
#include <osdep_intf.h>
#include <rtw_eeprom.h>
#include <sta_info.h>
#include <rtw_event.h>
#include <rtw_mlme_ext.h>
#include <rtw_ap.h>
#include <rtw_version.h>

#include "ioctl_cfg80211.h"

#include <linux/ip.h>
#include <linux/if_ether.h>

#define SPEC_DEV_ID_NONE BIT(0)
#define SPEC_DEV_ID_DISABLE_HT BIT(1)
#define SPEC_DEV_ID_ENABLE_PS BIT(2)
#define SPEC_DEV_ID_RF_CONFIG_1T1R BIT(3)
#define SPEC_DEV_ID_RF_CONFIG_2T2R BIT(4)
#define SPEC_DEV_ID_ASSIGN_IFNAME BIT(5)

struct registry_priv {
        u8 chip_version;
        u8 rfintfs;
        u8 lbkmode;
        u8 hci;
        struct ndis_802_11_ssid ssid;
        u8 network_mode;        /* infra, ad-hoc, auto */
        u8 channel;/* ad-hoc support requirement */
        u8 wireless_mode;/* A, B, G, auto */
        u8 scan_mode;/* active, passive */
        u8 radio_enable;
        u8 preamble;/* long, short, auto */
        u8 vrtl_carrier_sense;/* Enable, Disable, Auto */
        u8 vcs_type;/* RTS/CTS, CTS-to-self */
        u16 rts_thresh;
        u16  frag_thresh;
        u8 adhoc_tx_pwr;
        u8 soft_ap;
        u8 power_mgnt;
        u8 ips_mode;
        u8 smart_ps;
        u8   usb_rxagg_mode;
        u8 long_retry_lmt;
        u8 short_retry_lmt;
        u16 busy_thresh;
        u8 ack_policy;
        u8  mp_dm;
        u8 software_encrypt;
        u8 software_decrypt;
        u8 acm_method;
          /* UAPSD */
        u8 wmm_enable;
        u8 uapsd_enable;
        u8 uapsd_max_sp;
        u8 uapsd_acbk_en;
        u8 uapsd_acbe_en;
        u8 uapsd_acvi_en;
        u8 uapsd_acvo_en;

        struct wlan_bssid_ex    dev_network;

        u8 ht_enable;
        /*
         * 0: 20 MHz, 1: 40 MHz
         * 2.4G use bit 0 ~ 3
         * 0x01 means enable 2.4G 40MHz
         */
        u8 bw_mode;
        u8 ampdu_enable;/* for tx */
        u8 rx_stbc;
        u8 ampdu_amsdu;/* A-MPDU Supports A-MSDU is permitted */
        /*  Short GI support Bit Map */
        /*  BIT0 - 20MHz, 1: support, 0: non-support */
        /*  BIT1 - 40MHz, 1: support, 0: non-support */
        /*  BIT2 - 80MHz, 1: support, 0: non-support */
        /*  BIT3 - 160MHz, 1: support, 0: non-support */
        u8 short_gi;
        /*  BIT0: Enable VHT LDPC Rx, BIT1: Enable VHT LDPC Tx, BIT4: Enable HT LDPC Rx, BIT5: Enable HT LDPC Tx */
        u8 ldpc_cap;
        /*  BIT0: Enable VHT STBC Rx, BIT1: Enable VHT STBC Tx, BIT4: Enable HT STBC Rx, BIT5: Enable HT STBC Tx */
        u8 stbc_cap;
        /*  BIT0: Enable VHT Beamformer, BIT1: Enable VHT Beamformee, BIT4: Enable HT Beamformer, BIT5: Enable HT Beamformee */
        u8 beamform_cap;

        u8 lowrate_two_xmit;

        u8 low_power;

        u8 wifi_spec;/*  !turbo_mode */

        u8 channel_plan;

        s8      ant_num;

        /* false:Reject AP's Add BA req, true:accept AP's Add BA req */
        bool    accept_addba_req;

        u8 antdiv_cfg;
        u8 antdiv_type;

        u8 usbss_enable;/* 0:disable, 1:enable */
        u8 hwpdn_mode;/* 0:disable, 1:enable, 2:decide by EFUSE config */
        u8 hwpwrp_detect;/* 0:disable, 1:enable */

        u8 hw_wps_pbc;/* 0:disable, 1:enable */

        u8 max_roaming_times; /*  the max number driver will try to roaming */

        u8 enable80211d;

        u8 ifname[16];

        u8 notch_filter;

        /* define for tx power adjust */
        u8 reg_enable_tx_power_limit;
        u8 reg_enable_tx_power_by_rate;
        u8 reg_power_base;
        u8 reg_pwr_tbl_sel;
        u8  check_fw_ps;

        u8 qos_opt_enable;

        u8 hiq_filter;
};

#include <drv_types_sdio.h>

#define GET_PRIMARY_ADAPTER(padapter) (((struct adapter *)padapter)->dvobj->if1)
#define GET_IFACE_NUMS(padapter) (((struct adapter *)padapter)->dvobj->iface_nums)
#define GET_ADAPTER(padapter, iface_id) (((struct adapter *)padapter)->dvobj->padapters[iface_id])

struct rtw_traffic_statistics {
        /*  tx statistics */
        u64     tx_bytes;
        u64     tx_pkts;
        u64     tx_drop;
        u64     cur_tx_bytes;
        u64     last_tx_bytes;
        u32 cur_tx_tp; /*  Tx throughput in MBps. */

        /*  rx statistics */
        u64     rx_bytes;
        u64     rx_pkts;
        u64     rx_drop;
        u64     cur_rx_bytes;
        u64     last_rx_bytes;
        u32 cur_rx_tp; /*  Rx throughput in MBps. */
};

struct cam_ctl_t {
        spinlock_t lock;
        u64 bitmap;
};

struct cam_entry_cache {
        u16 ctrl;
        u8 mac[ETH_ALEN];
        u8 key[16];
};

struct dvobj_priv {
        /*-------- below is common data --------*/
        struct adapter *if1; /* PRIMARY_ADAPTER */

        s32     processing_dev_remove;

        /* for local/global synchronization */
        /*  */
        spinlock_t      lock;
        int macid[NUM_STA];

        struct mutex hw_init_mutex;
        struct mutex h2c_fwcmd_mutex;
        struct mutex setch_mutex;
        struct mutex setbw_mutex;

        unsigned char oper_channel; /* saved channel info when call set_channel_bw */
        unsigned char oper_bwmode;
        unsigned char oper_ch_offset;/* PRIME_CHNL_OFFSET */
        unsigned long on_oper_ch_time;

        struct adapter *padapters;

        struct cam_ctl_t cam_ctl;
        struct cam_entry_cache cam_cache[TOTAL_CAM_ENTRY];

        /* In /Out Pipe information */
        int     RtInPipe[2];
        int     RtOutPipe[4];
        u8 Queue2Pipe[HW_QUEUE_ENTRY];/* for out pipe mapping */

        u8 irq_alloc;
        atomic_t continual_io_error;

        atomic_t disable_func;

        struct pwrctrl_priv pwrctl_priv;

        struct rtw_traffic_statistics   traffic_stat;

/*-------- below is for SDIO INTERFACE --------*/

struct sdio_data intf_data;

};

#define dvobj_to_pwrctl(dvobj) (&(dvobj->pwrctl_priv))

static inline struct dvobj_priv *pwrctl_to_dvobj(struct pwrctrl_priv *pwrctl_priv)
{
        return container_of(pwrctl_priv, struct dvobj_priv, pwrctl_priv);
}

static inline struct device *dvobj_to_dev(struct dvobj_priv *dvobj)
{
        /* todo: get interface type from dvobj and the return the dev accordingly */
#ifdef RTW_DVOBJ_CHIP_HW_TYPE
#endif

        return &dvobj->intf_data.func->dev;
}

enum {
        DRIVER_NORMAL = 0,
        DRIVER_DISAPPEAR = 1,
        DRIVER_REPLACE_DONGLE = 2,
};

struct adapter {
        int     DriverState;/*  for disable driver using module, use dongle to replace module. */
        int     pid[3];/* process id from UI, 0:wps, 1:hostapd, 2:dhcpcd */
        int     bDongle;/* build-in module or external dongle */

        struct dvobj_priv *dvobj;
        struct  mlme_priv mlmepriv;
        struct  mlme_ext_priv mlmeextpriv;
        struct  cmd_priv cmdpriv;
        struct  evt_priv evtpriv;
        /* struct       io_queue        *pio_queue; */
        struct  io_priv iopriv;
        struct  xmit_priv xmitpriv;
        struct  recv_priv recvpriv;
        struct  sta_priv stapriv;
        struct  security_priv securitypriv;
        spinlock_t   security_key_mutex; /*  add for CONFIG_IEEE80211W, none 11w also can use */
        struct  registry_priv registrypriv;
        struct  eeprom_priv eeprompriv;

        struct  hostapd_priv *phostapdpriv;

        u32 setband;

        void *HalData;
        u32 hal_data_sz;

        s32     bDriverStopped;
        s32     bSurpriseRemoved;
        s32  bCardDisableWOHSM;

        u32 IsrContent;
        u32 ImrContent;

        u8 EepromAddressSize;
        u8 hw_init_completed;
        u8 bDriverIsGoingToUnload;
        u8 init_adpt_in_progress;
        u8 bHaltInProgress;

        void *cmdThread;
        void *evtThread;
        void *xmitThread;
        void *recvThread;

        u32 (*intf_init)(struct dvobj_priv *dvobj);
        void (*intf_deinit)(struct dvobj_priv *dvobj);
        int (*intf_alloc_irq)(struct dvobj_priv *dvobj);
        void (*intf_free_irq)(struct dvobj_priv *dvobj);


        void (*intf_start)(struct adapter *adapter);
        void (*intf_stop)(struct adapter *adapter);

        struct net_device *pnetdev;
        char old_ifname[IFNAMSIZ];

        /*  used by rtw_rereg_nd_name related function */
        struct rereg_nd_name_data {
                struct net_device *old_pnetdev;
                char old_ifname[IFNAMSIZ];
                u8 old_bRegUseLed;
        } rereg_nd_name_priv;

        int bup;
        struct net_device_stats stats;
        struct iw_statistics iwstats;

        struct wireless_dev *rtw_wdev;
        struct rtw_wdev_priv wdev_data;

        int net_closed;

        u8 netif_up;

        u8 bFWReady;
        u8 bBTFWReady;
        u8 bLinkInfoDump;
        u8 bRxRSSIDisplay;
        /*      Added by Albert 2012/10/26 */
        /*      The driver will show up the desired channel number when this flag is 1. */
        u8 bNotifyChannelChange;

        /* pbuddystruct adapter is used only in two interface case, (iface_nums =2 in struct dvobj_priv) */
        /* PRIMARY ADAPTER's buddy is SECONDARY_ADAPTER */
        /* SECONDARY_ADAPTER's buddy is PRIMARY_ADAPTER */
        /* for iface_id > SECONDARY_ADAPTER(IFACE_ID1), refer to padapters[iface_id]  in struct dvobj_priv */
        /* and their pbuddystruct adapter is PRIMARY_ADAPTER. */
        /* for PRIMARY_ADAPTER(IFACE_ID0) can directly refer to if1 in struct dvobj_priv */
        struct adapter *pbuddy_adapter;

        /* extend to support multi interface */
       /* IFACE_ID0 is equals to PRIMARY_ADAPTER */
       /* IFACE_ID1 is equals to SECONDARY_ADAPTER */
        u8 iface_id;

        /* for debug purpose */
        u8 fix_rate;
        u8 driver_vcs_en; /* Enable = 1, Disable = 0 driver control vrtl_carrier_sense for tx */
        u8 driver_vcs_type;/* force 0:disable VCS, 1:RTS-CTS, 2:CTS-to-self when vcs_en = 1. */
        u8 driver_ampdu_spacing;/* driver control AMPDU Density for peer sta's rx */
        u8 driver_rx_ampdu_factor;/* 0xff: disable drv ctrl, 0:8k, 1:16k, 2:32k, 3:64k; */

        unsigned char     in_cta_test;
};

#define adapter_to_dvobj(adapter) (adapter->dvobj)
#define adapter_to_pwrctl(adapter) (dvobj_to_pwrctl(adapter->dvobj))
#define adapter_wdev_data(adapter) (&((adapter)->wdev_data))

/*  */
/*  Function disabled. */
/*  */
#define DF_TX_BIT               BIT0
#define DF_RX_BIT               BIT1
#define DF_IO_BIT               BIT2

/* define RTW_ENABLE_FUNC(padapter, func) (atomic_sub(&adapter_to_dvobj(padapter)->disable_func, (func))) */

static inline void RTW_ENABLE_FUNC(struct adapter *padapter, int func_bit)
{
        int     df = atomic_read(&adapter_to_dvobj(padapter)->disable_func);
        df &= ~(func_bit);
        atomic_set(&adapter_to_dvobj(padapter)->disable_func, df);
}

#define RTW_IS_FUNC_DISABLED(padapter, func_bit) (atomic_read(&adapter_to_dvobj(padapter)->disable_func) & (func_bit))

#define RTW_CANNOT_IO(padapter) \
                        ((padapter)->bSurpriseRemoved || \
                         RTW_IS_FUNC_DISABLED((padapter), DF_IO_BIT))

#define RTW_CANNOT_RX(padapter) \
                        ((padapter)->bDriverStopped || \
                         (padapter)->bSurpriseRemoved || \
                         RTW_IS_FUNC_DISABLED((padapter), DF_RX_BIT))

#define RTW_CANNOT_TX(padapter) \
                        ((padapter)->bDriverStopped || \
                         (padapter)->bSurpriseRemoved || \
                         RTW_IS_FUNC_DISABLED((padapter), DF_TX_BIT))

static inline u8 *myid(struct eeprom_priv *peepriv)
{
        return peepriv->mac_addr;
}

/*  HCI Related header file */
#include <sdio_ops.h>
#include <sdio_hal.h>

#include <rtw_btcoex.h>

extern char *rtw_initmac;
extern int rtw_mc2u_disable;
extern int rtw_ht_enable;
extern u32 g_wait_hiq_empty;
extern u8 g_fwdl_wintint_rdy_fail;
extern u8 g_fwdl_chksum_fail;

#endif /* __DRV_TYPES_H__ */