root/drivers/net/ethernet/pensando/ionic/ionic_lif.h
/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright(c) 2017 - 2019 Pensando Systems, Inc */

#ifndef _IONIC_LIF_H_
#define _IONIC_LIF_H_

#include <linux/ptp_clock_kernel.h>
#include <linux/timecounter.h>
#include <linux/net_tstamp.h>
#include <linux/dim.h>
#include <linux/pci.h>
#include "ionic_rx_filter.h"
#include "ionic_api.h"

#define IONIC_ADMINQ_LENGTH     16      /* must be a power of two */
#define IONIC_NOTIFYQ_LENGTH    64      /* must be a power of two */

#define ADD_ADDR        true
#define DEL_ADDR        false
#define CAN_SLEEP       true
#define CAN_NOT_SLEEP   false

#define IONIC_RX_COPYBREAK_DEFAULT      256
#define IONIC_TX_BUDGET_DEFAULT         256

struct ionic_tx_stats {
        u64 pkts;
        u64 bytes;
        u64 csum_none;
        u64 csum;
        u64 tso;
        u64 tso_bytes;
        u64 frags;
        u64 vlan_inserted;
        u64 clean;
        u64 linearize;
        u64 crc32_csum;
        u64 dma_map_err;
        u64 hwstamp_valid;
        u64 hwstamp_invalid;
        u64 xdp_frames;
};

struct ionic_rx_stats {
        u64 pkts;
        u64 bytes;
        u64 csum_none;
        u64 csum_complete;
        u64 dropped;
        u64 vlan_stripped;
        u64 csum_error;
        u64 dma_map_err;
        u64 alloc_err;
        u64 hwstamp_valid;
        u64 hwstamp_invalid;
        u64 xdp_drop;
        u64 xdp_aborted;
        u64 xdp_pass;
        u64 xdp_tx;
        u64 xdp_redirect;
};

#define IONIC_QCQ_F_INITED              BIT(0)
#define IONIC_QCQ_F_SG                  BIT(1)
#define IONIC_QCQ_F_INTR                BIT(2)
#define IONIC_QCQ_F_TX_STATS            BIT(3)
#define IONIC_QCQ_F_RX_STATS            BIT(4)
#define IONIC_QCQ_F_NOTIFYQ             BIT(5)
#define IONIC_QCQ_F_CMB_RINGS           BIT(6)

struct ionic_qcq {
        void *q_base;
        dma_addr_t q_base_pa;
        u32 q_size;
        u32 cq_size;
        void *cq_base;
        dma_addr_t cq_base_pa;
        void *sg_base;
        dma_addr_t sg_base_pa;
        u32 sg_size;
        unsigned int flags;
        void __iomem *cmb_q_base;
        phys_addr_t cmb_q_base_pa;
        u32 cmb_q_size;
        u32 cmb_pgid;
        u32 cmb_order;
        struct dim dim;
        struct ionic_queue q;
        struct ionic_cq cq;
        struct napi_struct napi;
        struct ionic_intr_info intr;
        struct work_struct doorbell_napi_work;
        struct dentry *dentry;
};

#define q_to_qcq(q)             container_of(q, struct ionic_qcq, q)
#define q_to_tx_stats(q)        (&(q)->lif->txqstats[(q)->index])
#define q_to_rx_stats(q)        (&(q)->lif->rxqstats[(q)->index])
#define napi_to_qcq(napi)       container_of(napi, struct ionic_qcq, napi)
#define napi_to_cq(napi)        (&napi_to_qcq(napi)->cq)

enum ionic_deferred_work_type {
        IONIC_DW_TYPE_RX_MODE,
        IONIC_DW_TYPE_LINK_STATUS,
        IONIC_DW_TYPE_LIF_RESET,
};

struct ionic_deferred_work {
        struct list_head list;
        enum ionic_deferred_work_type type;
        union {
                u8 addr[ETH_ALEN];
                u8 fw_status;
        };
};

struct ionic_deferred {
        spinlock_t lock;                /* lock for deferred work list */
        struct list_head list;
        struct work_struct work;
};

struct ionic_lif_sw_stats {
        u64 tx_packets;
        u64 tx_bytes;
        u64 rx_packets;
        u64 rx_bytes;
        u64 tx_tso;
        u64 tx_tso_bytes;
        u64 tx_csum_none;
        u64 tx_csum;
        u64 rx_csum_none;
        u64 rx_csum_complete;
        u64 rx_csum_error;
        u64 tx_hwstamp_valid;
        u64 tx_hwstamp_invalid;
        u64 rx_hwstamp_valid;
        u64 rx_hwstamp_invalid;
        u64 hw_tx_dropped;
        u64 hw_rx_dropped;
        u64 hw_rx_over_errors;
        u64 hw_rx_missed_errors;
        u64 hw_tx_aborted_errors;
        u64 xdp_drop;
        u64 xdp_aborted;
        u64 xdp_pass;
        u64 xdp_tx;
        u64 xdp_redirect;
        u64 xdp_frames;
};

enum ionic_lif_state_flags {
        IONIC_LIF_F_INITED,
        IONIC_LIF_F_UP,
        IONIC_LIF_F_LINK_CHECK_REQUESTED,
        IONIC_LIF_F_FILTER_SYNC_NEEDED,
        IONIC_LIF_F_FW_RESET,
        IONIC_LIF_F_FW_STOPPING,
        IONIC_LIF_F_SPLIT_INTR,
        IONIC_LIF_F_BROKEN,
        IONIC_LIF_F_TX_DIM_INTR,
        IONIC_LIF_F_RX_DIM_INTR,
        IONIC_LIF_F_CMB_TX_RINGS,
        IONIC_LIF_F_CMB_RX_RINGS,

        /* leave this as last */
        IONIC_LIF_F_STATE_SIZE
};

struct ionic_qtype_info {
        u8  version;
        u8  supported;
        u64 features;
        u16 desc_sz;
        u16 comp_sz;
        u16 sg_desc_sz;
        u16 max_sg_elems;
        u16 sg_desc_stride;
};

struct ionic_phc;

#define IONIC_LIF_NAME_MAX_SZ           32
struct ionic_lif {
        struct net_device *netdev;
        DECLARE_BITMAP(state, IONIC_LIF_F_STATE_SIZE);
        struct ionic *ionic;
        unsigned int index;
        unsigned int hw_index;
        struct mutex queue_lock;        /* lock for queue structures */
        struct mutex config_lock;       /* lock for config actions */
        spinlock_t adminq_lock;         /* lock for AdminQ operations */
        struct ionic_qcq *adminqcq;
        struct ionic_qcq *notifyqcq;
        struct ionic_qcq **txqcqs;
        struct ionic_qcq *hwstamp_txq;
        struct ionic_tx_stats *txqstats;
        struct ionic_qcq **rxqcqs;
        struct ionic_qcq *hwstamp_rxq;
        struct ionic_rx_stats *rxqstats;
        struct ionic_deferred deferred;
        struct work_struct tx_timeout_work;
        u64 last_eid;
        unsigned int kern_pid;
        u64 __iomem *kern_dbpage;
        unsigned int neqs;
        unsigned int nxqs;
        unsigned int ntxq_descs;
        unsigned int nrxq_descs;
        u64 rxq_features;
        u64 hw_features;
        u16 rx_copybreak;
        u16 rx_mode;
        bool registered;
        bool doorbell_wa;
        u16 lif_type;
        unsigned int link_down_count;
        unsigned int nmcast;
        unsigned int nucast;
        unsigned int nvlans;
        unsigned int max_vlans;
        char name[IONIC_LIF_NAME_MAX_SZ];

        union ionic_lif_identity *identity;
        struct ionic_lif_info *info;
        dma_addr_t info_pa;
        u32 info_sz;
        struct ionic_qtype_info qtype_info[IONIC_QTYPE_MAX];
        struct ionic_aux_dev *ionic_adev;
        struct mutex adev_lock; /* lock for aux_dev actions */

        u8 rss_hash_key[IONIC_RSS_HASH_KEY_SIZE];
        u8 *rss_ind_tbl;
        dma_addr_t rss_ind_tbl_pa;
        u32 rss_ind_tbl_sz;
        u16 rss_types;

        struct ionic_rx_filters rx_filters;
        u32 rx_coalesce_usecs;          /* what the user asked for */
        u32 rx_coalesce_hw;             /* what the hw is using */
        u32 tx_coalesce_usecs;          /* what the user asked for */
        u32 tx_coalesce_hw;             /* what the hw is using */
        unsigned int dbid_count;

        struct ionic_phc *phc;

        struct dentry *dentry;
        struct bpf_prog *xdp_prog;
};

struct ionic_phc {
        spinlock_t lock; /* lock for cc and tc */
        struct cyclecounter cc;
        struct timecounter tc;

        struct mutex config_lock; /* lock for ts_config */
        struct kernel_hwtstamp_config ts_config;
        u64 ts_config_rx_filt;
        u32 ts_config_tx_mode;

        u32 init_cc_mult;
        long aux_work_delay;

        struct ptp_clock_info ptp_info;
        struct ptp_clock *ptp;
        struct ionic_lif *lif;
};

struct ionic_queue_params {
        unsigned int nxqs;
        unsigned int ntxq_descs;
        unsigned int nrxq_descs;
        u64 rxq_features;
        struct bpf_prog *xdp_prog;
        bool intr_split;
        bool cmb_tx;
        bool cmb_rx;
};

static inline void ionic_init_queue_params(struct ionic_lif *lif,
                                           struct ionic_queue_params *qparam)
{
        qparam->nxqs = lif->nxqs;
        qparam->ntxq_descs = lif->ntxq_descs;
        qparam->nrxq_descs = lif->nrxq_descs;
        qparam->rxq_features = lif->rxq_features;
        qparam->xdp_prog = lif->xdp_prog;
        qparam->intr_split = test_bit(IONIC_LIF_F_SPLIT_INTR, lif->state);
        qparam->cmb_tx = test_bit(IONIC_LIF_F_CMB_TX_RINGS, lif->state);
        qparam->cmb_rx = test_bit(IONIC_LIF_F_CMB_RX_RINGS, lif->state);
}

static inline void ionic_set_queue_params(struct ionic_lif *lif,
                                          struct ionic_queue_params *qparam)
{
        lif->nxqs = qparam->nxqs;
        lif->ntxq_descs = qparam->ntxq_descs;
        lif->nrxq_descs = qparam->nrxq_descs;
        lif->rxq_features = qparam->rxq_features;

        if (qparam->intr_split)
                set_bit(IONIC_LIF_F_SPLIT_INTR, lif->state);
        else
                clear_bit(IONIC_LIF_F_SPLIT_INTR, lif->state);

        if (qparam->cmb_tx)
                set_bit(IONIC_LIF_F_CMB_TX_RINGS, lif->state);
        else
                clear_bit(IONIC_LIF_F_CMB_TX_RINGS, lif->state);

        if (qparam->cmb_rx)
                set_bit(IONIC_LIF_F_CMB_RX_RINGS, lif->state);
        else
                clear_bit(IONIC_LIF_F_CMB_RX_RINGS, lif->state);
}

static inline u32 ionic_coal_usec_to_hw(struct ionic *ionic, u32 usecs)
{
        u32 mult = le32_to_cpu(ionic->ident.dev.intr_coal_mult);
        u32 div = le32_to_cpu(ionic->ident.dev.intr_coal_div);

        /* Div-by-zero should never be an issue, but check anyway */
        if (!div || !mult)
                return 0;

        /* Round up in case usecs is close to the next hw unit */
        usecs += (div / mult) >> 1;

        /* Convert from usecs to device units */
        return (usecs * mult) / div;
}

static inline bool ionic_txq_hwstamp_enabled(struct ionic_queue *q)
{
        return q->features & IONIC_TXQ_F_HWSTAMP;
}

void ionic_link_status_check_request(struct ionic_lif *lif, bool can_sleep);
void ionic_get_stats64(struct net_device *netdev,
                       struct rtnl_link_stats64 *ns);
void ionic_lif_deferred_enqueue(struct ionic_lif *lif,
                                struct ionic_deferred_work *work);
int ionic_lif_alloc(struct ionic *ionic);
int ionic_lif_init(struct ionic_lif *lif);
void ionic_lif_free(struct ionic_lif *lif);
void ionic_lif_deinit(struct ionic_lif *lif);

int ionic_lif_addr_add(struct ionic_lif *lif, const u8 *addr);
int ionic_lif_addr_del(struct ionic_lif *lif, const u8 *addr);

void ionic_stop_queues_reconfig(struct ionic_lif *lif);
void ionic_txrx_free(struct ionic_lif *lif);
void ionic_qcqs_free(struct ionic_lif *lif);
int ionic_restart_lif(struct ionic_lif *lif);

int ionic_lif_register(struct ionic_lif *lif);
void ionic_lif_unregister(struct ionic_lif *lif);
int ionic_lif_identify(struct ionic *ionic, u8 lif_type,
                       union ionic_lif_identity *lif_ident);
int ionic_lif_size(struct ionic *ionic);

#if IS_ENABLED(CONFIG_PTP_1588_CLOCK)
void ionic_lif_hwstamp_replay(struct ionic_lif *lif);
void ionic_lif_hwstamp_recreate_queues(struct ionic_lif *lif);
int ionic_hwstamp_set(struct net_device *netdev,
                      struct kernel_hwtstamp_config *config,
                      struct netlink_ext_ack *extack);
int ionic_hwstamp_get(struct net_device *netdev,
                      struct kernel_hwtstamp_config *config);
ktime_t ionic_lif_phc_ktime(struct ionic_lif *lif, u64 counter);
void ionic_lif_register_phc(struct ionic_lif *lif);
void ionic_lif_unregister_phc(struct ionic_lif *lif);
void ionic_lif_alloc_phc(struct ionic_lif *lif);
void ionic_lif_free_phc(struct ionic_lif *lif);
#else
static inline void ionic_lif_hwstamp_replay(struct ionic_lif *lif) {}
static inline void ionic_lif_hwstamp_recreate_queues(struct ionic_lif *lif) {}

static inline int ionic_hwstamp_set(struct net_device *netdev,
                                    struct kernel_hwtstamp_config *config,
                                    struct netlink_ext_ack *extack)
{
        return -EOPNOTSUPP;
}

static inline int ionic_hwstamp_get(struct net_device *netdev,
                                    struct kernel_hwtstamp_config *config)
{
        return -EOPNOTSUPP;
}

static inline ktime_t ionic_lif_phc_ktime(struct ionic_lif *lif, u64 counter)
{
        return ns_to_ktime(0);
}

static inline void ionic_lif_register_phc(struct ionic_lif *lif) {}
static inline void ionic_lif_unregister_phc(struct ionic_lif *lif) {}
static inline void ionic_lif_alloc_phc(struct ionic_lif *lif) {}
static inline void ionic_lif_free_phc(struct ionic_lif *lif) {}
#endif

int ionic_lif_create_hwstamp_txq(struct ionic_lif *lif);
int ionic_lif_create_hwstamp_rxq(struct ionic_lif *lif);
int ionic_lif_config_hwstamp_rxq_all(struct ionic_lif *lif, bool rx_all);
int ionic_lif_set_hwstamp_txmode(struct ionic_lif *lif, u16 txstamp_mode);
int ionic_lif_set_hwstamp_rxfilt(struct ionic_lif *lif, u64 pkt_class);

int ionic_lif_rss_config(struct ionic_lif *lif, u16 types,
                         const u8 *key, const u32 *indir);
void ionic_lif_rx_mode(struct ionic_lif *lif);
int ionic_reconfigure_queues(struct ionic_lif *lif,
                             struct ionic_queue_params *qparam);
#endif /* _IONIC_LIF_H_ */