/* SPDX-License-Identifier: GPL-2.0 */
/*
 * This file contains definitions and data structures specific
 * to Marvell 802.11 NIC. It contains the Device Information
 * structure struct lbs_private..
 */
#ifndef _LBS_DEV_H_
#define _LBS_DEV_H_

#include "defs.h"
#include "decl.h"
#include "host.h"

#include <linux/kfifo.h>

/* sleep_params */
struct sleep_params {
        uint16_t sp_error;
        uint16_t sp_offset;
        uint16_t sp_stabletime;
        uint8_t  sp_calcontrol;
        uint8_t  sp_extsleepclk;
        uint16_t sp_reserved;
};

/* Mesh statistics */
struct lbs_mesh_stats {
        u32     fwd_bcast_cnt;          /* Fwd: Broadcast counter */
        u32     fwd_unicast_cnt;        /* Fwd: Unicast counter */
        u32     fwd_drop_ttl;           /* Fwd: TTL zero */
        u32     fwd_drop_rbt;           /* Fwd: Recently Broadcasted */
        u32     fwd_drop_noroute;       /* Fwd: No route to Destination */
        u32     fwd_drop_nobuf;         /* Fwd: Run out of internal buffers */
        u32     drop_blind;             /* Rx:  Dropped by blinding table */
        u32     tx_failed_cnt;          /* Tx:  Failed transmissions */
};

/* Private structure for the MV device */
struct lbs_private {

        /* Basic networking */
        struct net_device *dev;
        u32 connect_status;
        struct work_struct mcast_work;
        u32 nr_of_multicastmacaddr;
        u8 multicastlist[MRVDRV_MAX_MULTICAST_LIST_SIZE][ETH_ALEN];

        /* CFG80211 */
        struct wireless_dev *wdev;
        bool wiphy_registered;
        struct cfg80211_scan_request *scan_req;
        u8 assoc_bss[ETH_ALEN];
        u8 country_code[IEEE80211_COUNTRY_STRING_LEN];
        u8 disassoc_reason;

        /* Mesh */
        struct net_device *mesh_dev; /* Virtual device */
#ifdef CONFIG_LIBERTAS_MESH
        struct lbs_mesh_stats mstats;
        uint16_t mesh_tlv;
        u8 mesh_channel;
#endif

        /* Debugfs */
        struct dentry *debugfs_dir;
        struct dentry *debugfs_debug;
        struct dentry *debugfs_files[6];
        struct dentry *events_dir;
        struct dentry *debugfs_events_files[6];
        struct dentry *regs_dir;
        struct dentry *debugfs_regs_files[6];

        /* Hardware debugging */
        u32 mac_offset;
        u32 bbp_offset;
        u32 rf_offset;

        /* Power management */
        u16 psmode;
        u32 psstate;
        u8 needtowakeup;

        /* Deep sleep */
        int is_deep_sleep;
        int deep_sleep_required;
        int is_activity_detected;
        wait_queue_head_t ds_awake_q;

        /* Host sleep*/
        int is_host_sleep_configured;
        int is_host_sleep_activated;
        wait_queue_head_t host_sleep_q;

        /* Hardware access */
        void *card;
        bool iface_running;
        u8 is_polling; /* host has to poll the card irq */
        u8 fw_ready;
        u8 surpriseremoved;
        u8 setup_fw_on_resume;
        u8 power_up_on_resume;
        int (*hw_host_to_card) (struct lbs_private *priv, u8 type, u8 *payload, u16 nb);
        void (*reset_card) (struct lbs_private *priv);
        int (*power_save) (struct lbs_private *priv);
        int (*power_restore) (struct lbs_private *priv);
        int (*enter_deep_sleep) (struct lbs_private *priv);
        int (*exit_deep_sleep) (struct lbs_private *priv);
        int (*reset_deep_sleep_wakeup) (struct lbs_private *priv);

        /* Adapter info (from EEPROM) */
        u32 fwrelease;
        u32 fwcapinfo;
        u16 regioncode;
        u8 current_addr[ETH_ALEN];
        u8 copied_hwaddr;

        /* Command download */
        u8 dnld_sent;
        /* bit0 1/0=data_sent/data_tx_done,
           bit1 1/0=cmd_sent/cmd_tx_done,
           all other bits reserved 0 */
        u16 seqnum;
        struct cmd_ctrl_node *cmd_array;
        struct cmd_ctrl_node *cur_cmd;
        struct list_head cmdfreeq;    /* free command buffers */
        struct list_head cmdpendingq; /* pending command buffers */
        struct timer_list command_timer;
        int cmd_timed_out;

        /* Command responses sent from the hardware to the driver */
        u8 resp_idx;
        u8 resp_buf[2][LBS_UPLD_SIZE];
        u32 resp_len[2];

        /* Events sent from hardware to driver */
        struct kfifo event_fifo;

        /* thread to service interrupts */
        struct task_struct *main_thread;
        wait_queue_head_t waitq;
        struct workqueue_struct *work_thread;

        /* Encryption stuff */
        u8 authtype_auto;
        u8 wep_tx_key;
        u8 wep_key[4][WLAN_KEY_LEN_WEP104];
        u8 wep_key_len[4];

        /* Wake On LAN */
        uint32_t wol_criteria;
        uint8_t wol_gpio;
        uint8_t wol_gap;
        bool ehs_remove_supported;

        /* Transmitting */
        int tx_pending_len;             /* -1 while building packet */
        u8 tx_pending_buf[LBS_UPLD_SIZE];
        /* protected by hard_start_xmit serialization */
        u8 txretrycount;
        struct sk_buff *currenttxskb;
        struct timer_list tx_lockup_timer;

        /* Locks */
        struct mutex lock;
        spinlock_t driver_lock;

        /* NIC/link operation characteristics */
        u16 mac_control;
        u8 radio_on;
        u8 cur_rate;
        u8 channel;
        s16 txpower_cur;
        s16 txpower_min;
        s16 txpower_max;

        /* Scanning */
        struct delayed_work scan_work;
        int scan_channel;
        /* Queue of things waiting for scan completion */
        wait_queue_head_t scan_q;
        /* Whether the scan was initiated internally and not by cfg80211 */
        bool internal_scan;

        /* Firmware load */
        u32 fw_model;
        wait_queue_head_t fw_waitq;
        struct device *fw_device;
        const struct firmware *helper_fw;
        const struct lbs_fw_table *fw_table;
        const struct lbs_fw_table *fw_iter;
        lbs_fw_cb fw_callback;
};

extern struct cmd_confirm_sleep confirm_sleep;

/* Check if there is an interface active. */
static inline int lbs_iface_active(struct lbs_private *priv)
{
        int r;

        r = netif_running(priv->dev);
        if (priv->mesh_dev)
                r |= netif_running(priv->mesh_dev);

        return r;
}

#endif