/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2014-2018 Chelsio Communications.
 * All rights reserved.
 */

#ifndef __CHELSIO_COMMON_H
#define __CHELSIO_COMMON_H

#include "../cxgbe_compat.h"
#include "t4_hw.h"
#include "t4vf_hw.h"
#include "t4_chip_type.h"
#include "t4fw_interface.h"

#define CXGBE_PAGE_SIZE RTE_PGSIZE_4K

#define T4_MEMORY_WRITE 0
#define T4_MEMORY_READ  1

enum {
        MAX_NPORTS     = 4,     /* max # of ports */
};

enum {
        T5_REGMAP_SIZE = (332 * 1024),
};

enum {
        MEMWIN0_APERTURE = 2048,
        MEMWIN0_BASE     = 0x1b800,
};

enum dev_master { MASTER_CANT, MASTER_MAY, MASTER_MUST };

enum dev_state { DEV_STATE_UNINIT, DEV_STATE_INIT, DEV_STATE_ERR };

enum { MEM_EDC0, MEM_EDC1, MEM_MC, MEM_MC0 = MEM_MC, MEM_MC1 };

struct port_stats {
        u64 tx_octets;            /* total # of octets in good frames */
        u64 tx_frames;            /* all good frames */
        u64 tx_bcast_frames;      /* all broadcast frames */
        u64 tx_mcast_frames;      /* all multicast frames */
        u64 tx_ucast_frames;      /* all unicast frames */
        u64 tx_error_frames;      /* all error frames */

        u64 tx_frames_64;         /* # of Tx frames in a particular range */
        u64 tx_frames_65_127;
        u64 tx_frames_128_255;
        u64 tx_frames_256_511;
        u64 tx_frames_512_1023;
        u64 tx_frames_1024_1518;
        u64 tx_frames_1519_max;

        u64 tx_drop;              /* # of dropped Tx frames */
        u64 tx_pause;             /* # of transmitted pause frames */
        u64 tx_ppp0;              /* # of transmitted PPP prio 0 frames */
        u64 tx_ppp1;              /* # of transmitted PPP prio 1 frames */
        u64 tx_ppp2;              /* # of transmitted PPP prio 2 frames */
        u64 tx_ppp3;              /* # of transmitted PPP prio 3 frames */
        u64 tx_ppp4;              /* # of transmitted PPP prio 4 frames */
        u64 tx_ppp5;              /* # of transmitted PPP prio 5 frames */
        u64 tx_ppp6;              /* # of transmitted PPP prio 6 frames */
        u64 tx_ppp7;              /* # of transmitted PPP prio 7 frames */

        u64 rx_octets;            /* total # of octets in good frames */
        u64 rx_frames;            /* all good frames */
        u64 rx_bcast_frames;      /* all broadcast frames */
        u64 rx_mcast_frames;      /* all multicast frames */
        u64 rx_ucast_frames;      /* all unicast frames */
        u64 rx_too_long;          /* # of frames exceeding MTU */
        u64 rx_jabber;            /* # of jabber frames */
        u64 rx_fcs_err;           /* # of received frames with bad FCS */
        u64 rx_len_err;           /* # of received frames with length error */
        u64 rx_symbol_err;        /* symbol errors */
        u64 rx_runt;              /* # of short frames */

        u64 rx_frames_64;         /* # of Rx frames in a particular range */
        u64 rx_frames_65_127;
        u64 rx_frames_128_255;
        u64 rx_frames_256_511;
        u64 rx_frames_512_1023;
        u64 rx_frames_1024_1518;
        u64 rx_frames_1519_max;

        u64 rx_pause;             /* # of received pause frames */
        u64 rx_ppp0;              /* # of received PPP prio 0 frames */
        u64 rx_ppp1;              /* # of received PPP prio 1 frames */
        u64 rx_ppp2;              /* # of received PPP prio 2 frames */
        u64 rx_ppp3;              /* # of received PPP prio 3 frames */
        u64 rx_ppp4;              /* # of received PPP prio 4 frames */
        u64 rx_ppp5;              /* # of received PPP prio 5 frames */
        u64 rx_ppp6;              /* # of received PPP prio 6 frames */
        u64 rx_ppp7;              /* # of received PPP prio 7 frames */

        u64 rx_ovflow0;           /* drops due to buffer-group 0 overflows */
        u64 rx_ovflow1;           /* drops due to buffer-group 1 overflows */
        u64 rx_ovflow2;           /* drops due to buffer-group 2 overflows */
        u64 rx_ovflow3;           /* drops due to buffer-group 3 overflows */
        u64 rx_trunc0;            /* buffer-group 0 truncated packets */
        u64 rx_trunc1;            /* buffer-group 1 truncated packets */
        u64 rx_trunc2;            /* buffer-group 2 truncated packets */
        u64 rx_trunc3;            /* buffer-group 3 truncated packets */

        u64 rx_tp_tnl_cong_drops[NCHAN]; /* TP frame drops due to congestion */
};

struct sge_params {
        u32 hps;                        /* host page size for our PF/VF */
        u32 eq_qpp;                     /* egress queues/page for our PF/VF */
        u32 iq_qpp;                     /* egress queues/page for our PF/VF */
};

struct tp_params {
        unsigned int ntxchan;        /* # of Tx channels */
        unsigned int tre;            /* log2 of core clocks per TP tick */
        unsigned int dack_re;        /* DACK timer resolution */
        unsigned int la_mask;        /* what events are recorded by TP LA */
        unsigned short tx_modq[NCHAN];  /* channel to modulation queue map */

        u32 vlan_pri_map;               /* cached TP_VLAN_PRI_MAP */
        u32 filter_mask;
        u32 ingress_config;             /* cached TP_INGRESS_CONFIG */

        /* cached TP_OUT_CONFIG compressed error vector
         * and passing outer header info for encapsulated packets.
         */
        int rx_pkt_encap;

        /*
         * TP_VLAN_PRI_MAP Compressed Filter Tuple field offsets.  This is a
         * subset of the set of fields which may be present in the Compressed
         * Filter Tuple portion of filters and TCP TCB connections.  The
         * fields which are present are controlled by the TP_VLAN_PRI_MAP.
         * Since a variable number of fields may or may not be present, their
         * shifted field positions within the Compressed Filter Tuple may
         * vary, or not even be present if the field isn't selected in
         * TP_VLAN_PRI_MAP.  Since some of these fields are needed in various
         * places we store their offsets here, or a -1 if the field isn't
         * present.
         */
        int vlan_shift;
        int vnic_shift;
        int port_shift;
        int protocol_shift;
        int ethertype_shift;
        int macmatch_shift;
        int tos_shift;

        u64 hash_filter_mask;
};

struct vpd_params {
        unsigned int cclk;
};

struct pci_params {
        uint16_t        vendor_id;
        uint16_t        device_id;
        uint32_t        vpd_cap_addr;
        uint16_t        speed;
        uint8_t         width;
};

/*
 * Firmware device log.
 */
struct devlog_params {
        u32 memtype;                    /* which memory (EDC0, EDC1, MC) */
        u32 start;                      /* start of log in firmware memory */
        u32 size;                       /* size of log */
};

struct arch_specific_params {
        u8 nchan;
        u8 cng_ch_bits_log;             /* congestion channel map bits width */
        u16 mps_rplc_size;
        u16 vfcount;
        u32 sge_fl_db;
        u16 mps_tcam_size;
};

/*
 * Global Receive Side Scaling (RSS) parameters in host-native format.
 */
struct rss_params {
        unsigned int mode;                      /* RSS mode */
        union {
                struct {
                        unsigned int synmapen:1;      /* SYN Map Enable */
                        unsigned int syn4tupenipv6:1; /* en 4-tuple IPv6 SYNs hash */
                        unsigned int syn2tupenipv6:1; /* en 2-tuple IPv6 SYNs hash */
                        unsigned int syn4tupenipv4:1; /* en 4-tuple IPv4 SYNs hash */
                        unsigned int syn2tupenipv4:1; /* en 2-tuple IPv4 SYNs hash */
                        unsigned int ofdmapen:1;      /* Offload Map Enable */
                        unsigned int tnlmapen:1;      /* Tunnel Map Enable */
                        unsigned int tnlalllookup:1;  /* Tunnel All Lookup */
                        unsigned int hashtoeplitz:1;  /* use Toeplitz hash */
                } basicvirtual;
        } u;
};

/*
 * Maximum resources provisioned for a PCI PF.
 */
struct pf_resources {
        unsigned int neq;      /* N egress Qs */
        unsigned int nethctrl; /* N egress ETH or CTRL Qs */
        unsigned int niqflint; /* N ingress Qs/w free list(s) & intr */
};

/*
 * Maximum resources provisioned for a PCI VF.
 */
struct vf_resources {
        unsigned int nvi;               /* N virtual interfaces */
        unsigned int neq;               /* N egress Qs */
        unsigned int nethctrl;          /* N egress ETH or CTRL Qs */
        unsigned int niqflint;          /* N ingress Qs/w free list(s) & intr */
        unsigned int niq;               /* N ingress Qs */
        unsigned int tc;                /* PCI-E traffic class */
        unsigned int pmask;             /* port access rights mask */
        unsigned int nexactf;           /* N exact MPS filters */
        unsigned int r_caps;            /* read capabilities */
        unsigned int wx_caps;           /* write/execute capabilities */
};

struct adapter_params {
        struct sge_params sge;
        struct tp_params  tp;
        struct vpd_params vpd;
        struct pci_params pci;
        struct devlog_params devlog;
        struct rss_params rss;
        struct pf_resources pfres;
        struct vf_resources vfres;
        enum pcie_memwin drv_memwin;

        unsigned int sf_size;             /* serial flash size in bytes */
        unsigned int sf_nsec;             /* # of flash sectors */

        unsigned int fw_vers;
        unsigned int bs_vers;
        unsigned int tp_vers;
        unsigned int er_vers;

        unsigned short mtus[NMTUS];
        unsigned short a_wnd[NCCTRL_WIN];
        unsigned short b_wnd[NCCTRL_WIN];

        unsigned int mc_size;             /* MC memory size */
        unsigned int cim_la_size;

        unsigned char nports;             /* # of ethernet ports */
        unsigned char portvec;

        unsigned char hash_filter;

        enum chip_type chip;              /* chip code */
        struct arch_specific_params arch; /* chip specific params */

        bool ulptx_memwrite_dsgl;          /* use of T5 DSGL allowed */
        u8 filter2_wr_support;            /* FW support for FILTER2_WR */
        u32 viid_smt_extn_support:1;      /* FW returns vin and smt index */
        u32 max_tx_coalesce_num; /* Max # of Tx packets that can be coalesced */
        u8 vi_enable_rx; /* FW support for enable/disable VI Rx at runtime */

        u16 rawf_start; /* FW supports RAW MAC match-all filters */
        u16 rawf_size;
};

/* Firmware Port Capabilities types.
 */
struct link_config {
        u32 pcaps;         /* Physically supported link caps */
        u32 acaps;         /* Advertised link caps */

        u32 link_caps;     /* Current link caps */
        u32 admin_caps;    /* Admin configured link caps  */

        u8 mdio_addr;      /* Address of the PHY */
        u8 port_type;      /* Firmware port type */
        u8 mod_type;       /* Firmware module type */

        u8 link_ok;        /* Link up? */
        u8 link_down_rc;   /* Link down reason */
};

#include "adapter.h"

void t4_set_reg_field(struct adapter *adap, unsigned int addr, u32 mask,
                      u32 val);
int t4_wait_op_done_val(struct adapter *adapter, int reg, u32 mask,
                        int polarity,
                        int attempts, int delay, u32 *valp);

static inline int t4_wait_op_done(struct adapter *adapter, int reg, u32 mask,
                                  int polarity, int attempts, int delay)
{
        return t4_wait_op_done_val(adapter, reg, mask, polarity, attempts,
                                   delay, NULL);
}

static inline int is_pf4(struct adapter *adap)
{
        return adap->pf == 4;
}

#define for_each_port(adapter, iter) \
        for (iter = 0; iter < (adapter)->params.nports; ++iter)

static inline int is_hashfilter(const struct adapter *adap)
{
        return adap->params.hash_filter;
}

void t4_read_mtu_tbl(struct adapter *adap, u16 *mtus, u8 *mtu_log);
void t4_tp_wr_bits_indirect(struct adapter *adap, unsigned int addr,
                            unsigned int mask, unsigned int val);
void t4_intr_enable(struct adapter *adapter);
void t4_intr_disable(struct adapter *adapter);
int t4_link_l1cfg_core(struct port_info *pi, u32 caps, u8 sleep_ok);
static inline int t4_link_l1cfg(struct port_info *pi, u32 caps)
{
        return t4_link_l1cfg_core(pi, caps, true);
}

static inline int t4_link_l1cfg_ns(struct port_info *pi, u32 caps)
{
        return t4_link_l1cfg_core(pi, caps, false);
}

int t4_set_link_speed(struct port_info *pi, u32 speed, u32 *new_caps);
int t4_set_link_pause(struct port_info *pi, u8 autoneg, u8 pause_tx,
                      u8 pause_rx, u32 *new_caps);
int t4_set_link_fec(struct port_info *pi, u8 fec_rs, u8 fec_baser,
                    u8 fec_none, u32 *new_caps);
unsigned int t4_fwcap_to_speed(u32 caps);
void t4_load_mtus(struct adapter *adap, const unsigned short *mtus,
                  const unsigned short *alpha, const unsigned short *beta);
int t4_fw_hello(struct adapter *adap, unsigned int mbox, unsigned int evt_mbox,
                enum dev_master master, enum dev_state *state);
int t4_fw_bye(struct adapter *adap, unsigned int mbox);
int t4_fw_reset(struct adapter *adap, unsigned int mbox, int reset);
int t4vf_fw_reset(struct adapter *adap);
int t4_fw_halt(struct adapter *adap, unsigned int mbox, int reset);
int t4_fw_restart(struct adapter *adap, unsigned int mbox, int reset);
int t4vf_get_vfres(struct adapter *adap);
int t4_fixup_host_params_compat(struct adapter *adap, unsigned int page_size,
                                unsigned int cache_line_size,
                                enum chip_type chip_compat);
int t4_fixup_host_params(struct adapter *adap, unsigned int page_size,
                         unsigned int cache_line_size);
int t4_fw_initialize(struct adapter *adap, unsigned int mbox);
int t4_query_params(struct adapter *adap, unsigned int mbox, unsigned int pf,
                    unsigned int vf, unsigned int nparams, const u32 *params,
                    u32 *val);
int t4vf_query_params(struct adapter *adap, unsigned int nparams,
                      const u32 *params, u32 *vals);
int t4vf_get_dev_params(struct adapter *adap);
int t4vf_get_vpd_params(struct adapter *adap);
int t4vf_get_rss_glb_config(struct adapter *adap);
int t4vf_set_params(struct adapter *adapter, unsigned int nparams,
                    const u32 *params, const u32 *vals);
int t4_set_params_timeout(struct adapter *adap, unsigned int mbox,
                          unsigned int pf, unsigned int vf,
                          unsigned int nparams, const u32 *params,
                          const u32 *val, int timeout);
int t4_set_params(struct adapter *adap, unsigned int mbox, unsigned int pf,
                  unsigned int vf, unsigned int nparams, const u32 *params,
                  const u32 *val);
int t4_alloc_vi_func(struct adapter *adap, unsigned int mbox,
                     unsigned int port, unsigned int pf, unsigned int vf,
                     unsigned int nmac, u8 *mac, unsigned int *rss_size,
                     unsigned int portfunc, unsigned int idstype,
                     u8 *vivld, u8 *vin);
int t4_alloc_vi(struct adapter *adap, unsigned int mbox, unsigned int port,
                unsigned int pf, unsigned int vf, unsigned int nmac, u8 *mac,
                unsigned int *rss_size, u8 *vivild, u8 *vin);
int t4_free_vi(struct adapter *adap, unsigned int mbox,
               unsigned int pf, unsigned int vf,
               unsigned int viid);
int t4_set_rxmode(struct adapter *adap, unsigned int mbox, unsigned int viid,
                  int mtu, int promisc, int all_multi, int bcast, int vlanex,
                  bool sleep_ok);
int t4_free_raw_mac_filt(struct adapter *adap, unsigned int viid,
                         const u8 *addr, const u8 *mask, unsigned int idx,
                         u8 lookup_type, u8 port_id, bool sleep_ok);
int t4_alloc_raw_mac_filt(struct adapter *adap, unsigned int viid,
                          const u8 *addr, const u8 *mask, unsigned int idx,
                          u8 lookup_type, u8 port_id, bool sleep_ok);
int t4_change_mac(struct adapter *adap, unsigned int mbox, unsigned int viid,
                  int idx, const u8 *addr, bool persist, bool add_smt);
int t4_enable_vi_params(struct adapter *adap, unsigned int mbox,
                        unsigned int viid, bool rx_en, bool tx_en, bool dcb_en);
int t4_enable_vi(struct adapter *adap, unsigned int mbox, unsigned int viid,
                 bool rx_en, bool tx_en);
int t4_iq_start_stop(struct adapter *adap, unsigned int mbox, bool start,
                     unsigned int pf, unsigned int vf, unsigned int iqid,
                     unsigned int fl0id, unsigned int fl1id);
int t4_iq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
               unsigned int vf, unsigned int iqtype, unsigned int iqid,
               unsigned int fl0id, unsigned int fl1id);
int t4_eth_eq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
                   unsigned int vf, unsigned int eqid);
int t4_ctrl_eq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
                    unsigned int vf, unsigned int eqid);

static inline unsigned int core_ticks_per_usec(const struct adapter *adap)
{
        return adap->params.vpd.cclk / 1000;
}

static inline unsigned int us_to_core_ticks(const struct adapter *adap,
                                            unsigned int us)
{
        return (us * adap->params.vpd.cclk) / 1000;
}

static inline unsigned int core_ticks_to_us(const struct adapter *adapter,
                                            unsigned int ticks)
{
        /* add Core Clock / 2 to round ticks to nearest uS */
        return ((ticks * 1000 + adapter->params.vpd.cclk / 2) /
                adapter->params.vpd.cclk);
}

int t4_wr_mbox_meat_timeout(struct adapter *adap, int mbox, const void *cmd,
                            int size, void *rpl, bool sleep_ok, int timeout);
int t4_wr_mbox_meat(struct adapter *adap, int mbox,
                    const void __attribute__((__may_alias__)) *cmd, int size,
                    void *rpl, bool sleep_ok);

static inline int t4_wr_mbox_timeout(struct adapter *adap, int mbox,
                                     const void *cmd, int size, void *rpl,
                                     int timeout)
{
        return t4_wr_mbox_meat_timeout(adap, mbox, cmd, size, rpl, true,
                                       timeout);
}

int t4_get_core_clock(struct adapter *adapter, struct vpd_params *p);

static inline int t4_wr_mbox(struct adapter *adap, int mbox, const void *cmd,
                             int size, void *rpl)
{
        return t4_wr_mbox_meat(adap, mbox, cmd, size, rpl, true);
}

static inline int t4_wr_mbox_ns(struct adapter *adap, int mbox, const void *cmd,
                                int size, void *rpl)
{
        return t4_wr_mbox_meat(adap, mbox, cmd, size, rpl, false);
}

int t4vf_wr_mbox_core(struct adapter *, const void *, int, void *, bool);

static inline int t4vf_wr_mbox(struct adapter *adapter, const void *cmd,
                               int size, void *rpl)
{
        return t4vf_wr_mbox_core(adapter, cmd, size, rpl, true);
}

static inline int t4vf_wr_mbox_ns(struct adapter *adapter, const void *cmd,
                                  int size, void *rpl)
{
        return t4vf_wr_mbox_core(adapter, cmd, size, rpl, false);
}


void t4_read_indirect(struct adapter *adap, unsigned int addr_reg,
                      unsigned int data_reg, u32 *vals, unsigned int nregs,
                      unsigned int start_idx);
void t4_write_indirect(struct adapter *adap, unsigned int addr_reg,
                       unsigned int data_reg, const u32 *vals,
                       unsigned int nregs, unsigned int start_idx);

int t4_get_vpd_params(struct adapter *adapter, struct vpd_params *p);
int t4_get_pfres(struct adapter *adapter);
int t4_read_flash(struct adapter *adapter, unsigned int addr,
                  unsigned int nwords, u32 *data, int byte_oriented);
int t4_flash_cfg_addr(struct adapter *adapter);
unsigned int t4_get_mps_bg_map(struct adapter *adapter, unsigned int pidx);
unsigned int t4_get_tp_ch_map(struct adapter *adapter, unsigned int pidx);
const char *t4_get_port_type_description(enum fw_port_type port_type);
void t4_get_port_stats(struct adapter *adap, int idx, struct port_stats *p);
void t4vf_get_port_stats(struct adapter *adapter, int pidx,
                         struct port_stats *p);
void t4_get_port_stats_offset(struct adapter *adap, int idx,
                              struct port_stats *stats,
                              struct port_stats *offset);
void t4_clr_port_stats(struct adapter *adap, int idx);
void t4_init_link_config(struct port_info *pi, u32 pcaps, u32 acaps,
                         u8 mdio_addr, u8 port_type, u8 mod_type);
void t4_reset_link_config(struct adapter *adap, int idx);
int t4_get_version_info(struct adapter *adapter);
void t4_dump_version_info(struct adapter *adapter);
int t4_get_flash_params(struct adapter *adapter);
int t4_get_chip_type(struct adapter *adap, int ver);
int t4_prep_adapter(struct adapter *adapter);
int t4vf_prep_adapter(struct adapter *adapter);
int t4_port_init(struct adapter *adap, int mbox, int pf, int vf);
int t4vf_port_init(struct adapter *adap);
int t4_init_rss_mode(struct adapter *adap, int mbox);
int t4_config_rss_range(struct adapter *adapter, int mbox, unsigned int viid,
                        int start, int n, const u16 *rspq, unsigned int nrspq);
int t4_config_vi_rss(struct adapter *adapter, int mbox, unsigned int viid,
                     unsigned int flags, unsigned int defq);
int t4_read_config_vi_rss(struct adapter *adapter, int mbox, unsigned int viid,
                          u64 *flags, unsigned int *defq);
void t4_fw_tp_pio_rw(struct adapter *adap, u32 *vals, unsigned int nregs,
                     unsigned int start_index, unsigned int rw);
void t4_write_rss_key(struct adapter *adap, u32 *key, int idx);
void t4_read_rss_key(struct adapter *adap, u32 *key);

enum t4_bar2_qtype { T4_BAR2_QTYPE_EGRESS, T4_BAR2_QTYPE_INGRESS };
int t4_bar2_sge_qregs(struct adapter *adapter, unsigned int qid,
                      enum t4_bar2_qtype qtype, u64 *pbar2_qoffset,
                      unsigned int *pbar2_qid);

int t4_init_sge_params(struct adapter *adapter);
int t4_init_tp_params(struct adapter *adap);
int t4_filter_field_shift(const struct adapter *adap, unsigned int filter_sel);
int t4_handle_fw_rpl(struct adapter *adap, const __be64 *rpl);
unsigned int t4_get_regs_len(struct adapter *adap);
unsigned int t4vf_get_pf_from_vf(struct adapter *adap);
void t4_get_regs(struct adapter *adap, void *buf, size_t buf_size);
int t4_seeprom_read(struct adapter *adapter, u32 addr, u32 *data);
int t4_seeprom_write(struct adapter *adapter, u32 addr, u32 data);
int t4_seeprom_wp(struct adapter *adapter, int enable);
int t4_memory_rw_addr(struct adapter *adap, int win,
                      u32 addr, u32 len, void *hbuf, int dir);
int t4_memory_rw_mtype(struct adapter *adap, int win, int mtype, u32 maddr,
                       u32 len, void *hbuf, int dir);
static inline int t4_memory_rw(struct adapter *adap, int win,
                               int mtype, u32 maddr, u32 len,
                               void *hbuf, int dir)
{
        return t4_memory_rw_mtype(adap, win, mtype, maddr, len, hbuf, dir);
}
#endif /* __CHELSIO_COMMON_H */