/* SPDX-License-Identifier: GPL-2.0+ */
// Copyright (c) 2016-2017 Hisilicon Limited.

#ifndef __HNAE3_H
#define __HNAE3_H

/* Names used in this framework:
 *      ae handle (handle):
 *        a set of queues provided by AE
 *      ring buffer queue (rbq):
 *        the channel between upper layer and the AE, can do tx and rx
 *      ring:
 *        a tx or rx channel within a rbq
 *      ring description (desc):
 *        an element in the ring with packet information
 *      buffer:
 *        a memory region referred by desc with the full packet payload
 *
 * "num" means a static number set as a parameter, "count" mean a dynamic
 *   number set while running
 * "cb" means control block
 */

#include <linux/acpi.h>
#include <linux/dcbnl.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/ethtool.h>
#include <linux/module.h>
#include <linux/netdevice.h>
#include <linux/pci.h>
#include <linux/pkt_sched.h>
#include <linux/types.h>
#include <linux/bitmap.h>
#include <net/pkt_cls.h>
#include <net/pkt_sched.h>

#define HNAE3_MOD_VERSION "1.0"

#define HNAE3_MIN_VECTOR_NUM    2 /* first one for misc, another for IO */

/* Device version */
#define HNAE3_DEVICE_VERSION_V1   0x00020
#define HNAE3_DEVICE_VERSION_V2   0x00021
#define HNAE3_DEVICE_VERSION_V3   0x00030

#define HNAE3_PCI_REVISION_BIT_SIZE             8

/* Device IDs */
#define HNAE3_DEV_ID_GE                         0xA220
#define HNAE3_DEV_ID_25GE                       0xA221
#define HNAE3_DEV_ID_25GE_RDMA                  0xA222
#define HNAE3_DEV_ID_25GE_RDMA_MACSEC           0xA223
#define HNAE3_DEV_ID_50GE_RDMA                  0xA224
#define HNAE3_DEV_ID_50GE_RDMA_MACSEC           0xA225
#define HNAE3_DEV_ID_100G_RDMA_MACSEC           0xA226
#define HNAE3_DEV_ID_200G_RDMA                  0xA228
#define HNAE3_DEV_ID_VF                         0xA22E
#define HNAE3_DEV_ID_RDMA_DCB_PFC_VF            0xA22F

#define HNAE3_CLASS_NAME_SIZE 16

#define HNAE3_DEV_INITED_B                      0x0
#define HNAE3_DEV_SUPPORT_ROCE_B                0x1
#define HNAE3_DEV_SUPPORT_DCB_B                 0x2
#define HNAE3_KNIC_CLIENT_INITED_B              0x3
#define HNAE3_UNIC_CLIENT_INITED_B              0x4
#define HNAE3_ROCE_CLIENT_INITED_B              0x5

#define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) | \
                BIT(HNAE3_DEV_SUPPORT_ROCE_B))

#define hnae3_dev_roce_supported(hdev) \
        hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)

#define hnae3_dev_dcb_supported(hdev) \
        hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)

enum HNAE3_DEV_CAP_BITS {
        HNAE3_DEV_SUPPORT_FD_B,
        HNAE3_DEV_SUPPORT_GRO_B,
        HNAE3_DEV_SUPPORT_FEC_B,
        HNAE3_DEV_SUPPORT_UDP_GSO_B,
        HNAE3_DEV_SUPPORT_QB_B,
        HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B,
        HNAE3_DEV_SUPPORT_PTP_B,
        HNAE3_DEV_SUPPORT_INT_QL_B,
        HNAE3_DEV_SUPPORT_HW_TX_CSUM_B,
        HNAE3_DEV_SUPPORT_TX_PUSH_B,
        HNAE3_DEV_SUPPORT_PHY_IMP_B,
        HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B,
        HNAE3_DEV_SUPPORT_HW_PAD_B,
        HNAE3_DEV_SUPPORT_STASH_B,
        HNAE3_DEV_SUPPORT_UDP_TUNNEL_CSUM_B,
        HNAE3_DEV_SUPPORT_PAUSE_B,
        HNAE3_DEV_SUPPORT_RAS_IMP_B,
        HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B,
        HNAE3_DEV_SUPPORT_PORT_VLAN_BYPASS_B,
        HNAE3_DEV_SUPPORT_VLAN_FLTR_MDF_B,
        HNAE3_DEV_SUPPORT_MC_MAC_MNG_B,
        HNAE3_DEV_SUPPORT_CQ_B,
        HNAE3_DEV_SUPPORT_FEC_STATS_B,
        HNAE3_DEV_SUPPORT_LANE_NUM_B,
        HNAE3_DEV_SUPPORT_WOL_B,
        HNAE3_DEV_SUPPORT_TM_FLUSH_B,
        HNAE3_DEV_SUPPORT_VF_FAULT_B,
        HNAE3_DEV_SUPPORT_ERR_MOD_GEN_REG_B,
};

#define hnae3_ae_dev_fd_supported(ae_dev) \
                test_bit(HNAE3_DEV_SUPPORT_FD_B, (ae_dev)->caps)

#define hnae3_ae_dev_gro_supported(ae_dev) \
                test_bit(HNAE3_DEV_SUPPORT_GRO_B, (ae_dev)->caps)

#define hnae3_dev_fec_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_FEC_B, (hdev)->ae_dev->caps)

#define hnae3_dev_udp_gso_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_UDP_GSO_B, (hdev)->ae_dev->caps)

#define hnae3_dev_qb_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_QB_B, (hdev)->ae_dev->caps)

#define hnae3_dev_fd_forward_tc_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B, (hdev)->ae_dev->caps)

#define hnae3_dev_ptp_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_PTP_B, (hdev)->ae_dev->caps)

#define hnae3_dev_int_ql_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_INT_QL_B, (hdev)->ae_dev->caps)

#define hnae3_dev_hw_csum_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_HW_TX_CSUM_B, (hdev)->ae_dev->caps)

#define hnae3_dev_tx_push_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_TX_PUSH_B, (hdev)->ae_dev->caps)

#define hnae3_dev_phy_imp_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_PHY_IMP_B, (hdev)->ae_dev->caps)

#define hnae3_dev_ras_imp_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_RAS_IMP_B, (hdev)->ae_dev->caps)

#define hnae3_dev_tqp_txrx_indep_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B, (hdev)->ae_dev->caps)

#define hnae3_dev_hw_pad_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_HW_PAD_B, (hdev)->ae_dev->caps)

#define hnae3_dev_stash_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_STASH_B, (hdev)->ae_dev->caps)

#define hnae3_dev_pause_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_PAUSE_B, (hdev)->ae_dev->caps)

#define hnae3_ae_dev_tqp_txrx_indep_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B, (ae_dev)->caps)

#define hnae3_ae_dev_rxd_adv_layout_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B, (ae_dev)->caps)

#define hnae3_ae_dev_mc_mac_mng_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_MC_MAC_MNG_B, (ae_dev)->caps)

#define hnae3_ae_dev_cq_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_CQ_B, (ae_dev)->caps)

#define hnae3_ae_dev_fec_stats_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_FEC_STATS_B, (ae_dev)->caps)

#define hnae3_ae_dev_lane_num_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_LANE_NUM_B, (ae_dev)->caps)

#define hnae3_ae_dev_wol_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_WOL_B, (ae_dev)->caps)

#define hnae3_ae_dev_tm_flush_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_TM_FLUSH_B, (hdev)->ae_dev->caps)

#define hnae3_ae_dev_vf_fault_supported(ae_dev) \
        test_bit(HNAE3_DEV_SUPPORT_VF_FAULT_B, (ae_dev)->caps)

#define hnae3_ae_dev_gen_reg_dfx_supported(hdev) \
        test_bit(HNAE3_DEV_SUPPORT_ERR_MOD_GEN_REG_B, (hdev)->ae_dev->caps)

enum HNAE3_PF_CAP_BITS {
        HNAE3_PF_SUPPORT_VLAN_FLTR_MDF_B = 0,
};
#define ring_ptr_move_fw(ring, p) \
        ((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
#define ring_ptr_move_bw(ring, p) \
        ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)

struct hnae3_handle;

struct hnae3_queue {
        void __iomem *io_base;
        void __iomem *mem_base;
        struct hnae3_ae_algo *ae_algo;
        struct hnae3_handle *handle;
        int tqp_index;          /* index in a handle */
        u32 buf_size;           /* size for hnae_desc->addr, preset by AE */
        u16 tx_desc_num;        /* total number of tx desc */
        u16 rx_desc_num;        /* total number of rx desc */
};

struct hns3_mac_stats {
        u64 tx_pause_cnt;
        u64 rx_pause_cnt;
};

/* hnae3 loop mode */
enum hnae3_loop {
        HNAE3_LOOP_EXTERNAL,
        HNAE3_LOOP_APP,
        HNAE3_LOOP_SERIAL_SERDES,
        HNAE3_LOOP_PARALLEL_SERDES,
        HNAE3_LOOP_PHY,
        HNAE3_LOOP_NONE,
};

enum hnae3_client_type {
        HNAE3_CLIENT_KNIC,
        HNAE3_CLIENT_ROCE,
};

/* mac media type */
enum hnae3_media_type {
        HNAE3_MEDIA_TYPE_UNKNOWN,
        HNAE3_MEDIA_TYPE_FIBER,
        HNAE3_MEDIA_TYPE_COPPER,
        HNAE3_MEDIA_TYPE_BACKPLANE,
        HNAE3_MEDIA_TYPE_NONE,
};

/* must be consistent with definition in firmware */
enum hnae3_module_type {
        HNAE3_MODULE_TYPE_UNKNOWN       = 0x00,
        HNAE3_MODULE_TYPE_FIBRE_LR      = 0x01,
        HNAE3_MODULE_TYPE_FIBRE_SR      = 0x02,
        HNAE3_MODULE_TYPE_AOC           = 0x03,
        HNAE3_MODULE_TYPE_CR            = 0x04,
        HNAE3_MODULE_TYPE_KR            = 0x05,
        HNAE3_MODULE_TYPE_TP            = 0x06,
};

enum hnae3_fec_mode {
        HNAE3_FEC_AUTO = 0,
        HNAE3_FEC_BASER,
        HNAE3_FEC_RS,
        HNAE3_FEC_LLRS,
        HNAE3_FEC_NONE,
        HNAE3_FEC_USER_DEF,
};

enum hnae3_reset_notify_type {
        HNAE3_UP_CLIENT,
        HNAE3_DOWN_CLIENT,
        HNAE3_INIT_CLIENT,
        HNAE3_UNINIT_CLIENT,
};

enum hnae3_hw_error_type {
        HNAE3_PPU_POISON_ERROR,
        HNAE3_CMDQ_ECC_ERROR,
        HNAE3_IMP_RD_POISON_ERROR,
        HNAE3_ROCEE_AXI_RESP_ERROR,
};

enum hnae3_reset_type {
        HNAE3_VF_RESET,
        HNAE3_VF_FUNC_RESET,
        HNAE3_VF_PF_FUNC_RESET,
        HNAE3_VF_FULL_RESET,
        HNAE3_FLR_RESET,
        HNAE3_FUNC_RESET,
        HNAE3_GLOBAL_RESET,
        HNAE3_IMP_RESET,
        HNAE3_NONE_RESET,
        HNAE3_VF_EXP_RESET,
        HNAE3_MAX_RESET,
};

enum hnae3_port_base_vlan_state {
        HNAE3_PORT_BASE_VLAN_DISABLE,
        HNAE3_PORT_BASE_VLAN_ENABLE,
        HNAE3_PORT_BASE_VLAN_MODIFY,
        HNAE3_PORT_BASE_VLAN_NOCHANGE,
};

enum hnae3_dbg_cmd {
        HNAE3_DBG_CMD_TM_NODES,
        HNAE3_DBG_CMD_TM_PRI,
        HNAE3_DBG_CMD_TM_QSET,
        HNAE3_DBG_CMD_TM_MAP,
        HNAE3_DBG_CMD_TM_PG,
        HNAE3_DBG_CMD_TM_PORT,
        HNAE3_DBG_CMD_TC_SCH_INFO,
        HNAE3_DBG_CMD_QOS_PAUSE_CFG,
        HNAE3_DBG_CMD_QOS_PRI_MAP,
        HNAE3_DBG_CMD_QOS_DSCP_MAP,
        HNAE3_DBG_CMD_QOS_BUF_CFG,
        HNAE3_DBG_CMD_DEV_INFO,
        HNAE3_DBG_CMD_TX_BD,
        HNAE3_DBG_CMD_RX_BD,
        HNAE3_DBG_CMD_MAC_UC,
        HNAE3_DBG_CMD_MAC_MC,
        HNAE3_DBG_CMD_MNG_TBL,
        HNAE3_DBG_CMD_LOOPBACK,
        HNAE3_DBG_CMD_PTP_INFO,
        HNAE3_DBG_CMD_INTERRUPT_INFO,
        HNAE3_DBG_CMD_RESET_INFO,
        HNAE3_DBG_CMD_IMP_INFO,
        HNAE3_DBG_CMD_NCL_CONFIG,
        HNAE3_DBG_CMD_REG_BIOS_COMMON,
        HNAE3_DBG_CMD_REG_SSU,
        HNAE3_DBG_CMD_REG_IGU_EGU,
        HNAE3_DBG_CMD_REG_RPU,
        HNAE3_DBG_CMD_REG_NCSI,
        HNAE3_DBG_CMD_REG_RTC,
        HNAE3_DBG_CMD_REG_PPP,
        HNAE3_DBG_CMD_REG_RCB,
        HNAE3_DBG_CMD_REG_TQP,
        HNAE3_DBG_CMD_REG_MAC,
        HNAE3_DBG_CMD_REG_DCB,
        HNAE3_DBG_CMD_VLAN_CONFIG,
        HNAE3_DBG_CMD_QUEUE_MAP,
        HNAE3_DBG_CMD_RX_QUEUE_INFO,
        HNAE3_DBG_CMD_TX_QUEUE_INFO,
        HNAE3_DBG_CMD_FD_TCAM,
        HNAE3_DBG_CMD_FD_COUNTER,
        HNAE3_DBG_CMD_FD_RULE,
        HNAE3_DBG_CMD_MAC_TNL_STATUS,
        HNAE3_DBG_CMD_SERV_INFO,
        HNAE3_DBG_CMD_UMV_INFO,
        HNAE3_DBG_CMD_PAGE_POOL_INFO,
        HNAE3_DBG_CMD_COAL_INFO,
        HNAE3_DBG_CMD_UNKNOWN,
};

#define hnae3_seq_file_to_ae_dev(s)     (dev_get_drvdata((s)->private))
#define hnae3_seq_file_to_handle(s)     \
                (((struct hnae3_ae_dev *)hnae3_seq_file_to_ae_dev(s))->handle)

enum hnae3_tc_map_mode {
        HNAE3_TC_MAP_MODE_PRIO,
        HNAE3_TC_MAP_MODE_DSCP,
};

struct hnae3_vector_info {
        u8 __iomem *io_addr;
        int vector;
};

#define HNAE3_RING_TYPE_B 0
#define HNAE3_RING_TYPE_TX 0
#define HNAE3_RING_TYPE_RX 1
#define HNAE3_RING_GL_IDX_S 0
#define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
#define HNAE3_RING_GL_RX 0
#define HNAE3_RING_GL_TX 1

#define HNAE3_FW_VERSION_BYTE3_SHIFT    24
#define HNAE3_FW_VERSION_BYTE3_MASK     GENMASK(31, 24)
#define HNAE3_FW_VERSION_BYTE2_SHIFT    16
#define HNAE3_FW_VERSION_BYTE2_MASK     GENMASK(23, 16)
#define HNAE3_FW_VERSION_BYTE1_SHIFT    8
#define HNAE3_FW_VERSION_BYTE1_MASK     GENMASK(15, 8)
#define HNAE3_FW_VERSION_BYTE0_SHIFT    0
#define HNAE3_FW_VERSION_BYTE0_MASK     GENMASK(7, 0)

#define HNAE3_SCC_VERSION_BYTE3_SHIFT   24
#define HNAE3_SCC_VERSION_BYTE3_MASK    GENMASK(31, 24)
#define HNAE3_SCC_VERSION_BYTE2_SHIFT   16
#define HNAE3_SCC_VERSION_BYTE2_MASK    GENMASK(23, 16)
#define HNAE3_SCC_VERSION_BYTE1_SHIFT   8
#define HNAE3_SCC_VERSION_BYTE1_MASK    GENMASK(15, 8)
#define HNAE3_SCC_VERSION_BYTE0_SHIFT   0
#define HNAE3_SCC_VERSION_BYTE0_MASK    GENMASK(7, 0)

struct hnae3_ring_chain_node {
        struct hnae3_ring_chain_node *next;
        u32 tqp_index;
        u32 flag;
        u32 int_gl_idx;
};

#define HNAE3_IS_TX_RING(node) \
        (((node)->flag & 1 << HNAE3_RING_TYPE_B) == HNAE3_RING_TYPE_TX)

/* device specification info from firmware */
struct hnae3_dev_specs {
        u32 mac_entry_num; /* number of mac-vlan table entry */
        u32 mng_entry_num; /* number of manager table entry */
        u32 max_tm_rate;
        u16 rss_ind_tbl_size;
        u16 rss_key_size;
        u16 int_ql_max; /* max value of interrupt coalesce based on INT_QL */
        u16 max_int_gl; /* max value of interrupt coalesce based on INT_GL */
        u8 max_non_tso_bd_num; /* max BD number of one non-TSO packet */
        u16 max_frm_size;
        u16 max_qset_num;
        u16 umv_size;
        u16 mc_mac_size;
        u32 mac_stats_num;
        u8 tnl_num;
        u8 hilink_version;
};

struct hnae3_client_ops {
        int (*init_instance)(struct hnae3_handle *handle);
        void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
        void (*link_status_change)(struct hnae3_handle *handle, bool state);
        int (*reset_notify)(struct hnae3_handle *handle,
                            enum hnae3_reset_notify_type type);
        void (*process_hw_error)(struct hnae3_handle *handle,
                                 enum hnae3_hw_error_type);
};

#define HNAE3_CLIENT_NAME_LENGTH 16
struct hnae3_client {
        char name[HNAE3_CLIENT_NAME_LENGTH];
        unsigned long state;
        enum hnae3_client_type type;
        const struct hnae3_client_ops *ops;
        struct list_head node;
};

#define HNAE3_DEV_CAPS_MAX_NUM  96
struct hnae3_ae_dev {
        struct pci_dev *pdev;
        const struct hnae3_ae_ops *ops;
        struct list_head node;
        u32 flag;
        unsigned long hw_err_reset_req;
        struct hnae3_dev_specs dev_specs;
        u32 dev_version;
        DECLARE_BITMAP(caps, HNAE3_DEV_CAPS_MAX_NUM);
        void *priv;
        struct hnae3_handle *handle;
};

typedef int (*read_func)(struct seq_file *s, void *data);

/* This struct defines the operation on the handle.
 *
 * init_ae_dev(): (mandatory)
 *   Get PF configure from pci_dev and initialize PF hardware
 * uninit_ae_dev()
 *   Disable PF device and release PF resource
 * register_client
 *   Register client to ae_dev
 * unregister_client()
 *   Unregister client from ae_dev
 * start()
 *   Enable the hardware
 * stop()
 *   Disable the hardware
 * start_client()
 *   Inform the hclge that client has been started
 * stop_client()
 *   Inform the hclge that client has been stopped
 * get_status()
 *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
 *   non-ok
 * get_ksettings_an_result()
 *   Get negotiation status,speed and duplex
 * get_media_type()
 *   Get media type of MAC
 * check_port_speed()
 *   Check target speed whether is supported
 * adjust_link()
 *   Adjust link status
 * set_loopback()
 *   Set loopback
 * set_promisc_mode
 *   Set promisc mode
 * request_update_promisc_mode
 *   request to hclge(vf) to update promisc mode
 * set_mtu()
 *   set mtu
 * get_pauseparam()
 *   get tx and rx of pause frame use
 * set_pauseparam()
 *   set tx and rx of pause frame use
 * set_autoneg()
 *   set auto autonegotiation of pause frame use
 * get_autoneg()
 *   get auto autonegotiation of pause frame use
 * restart_autoneg()
 *   restart autonegotiation
 * halt_autoneg()
 *   halt/resume autonegotiation when autonegotiation on
 * get_coalesce_usecs()
 *   get usecs to delay a TX interrupt after a packet is sent
 * get_rx_max_coalesced_frames()
 *   get Maximum number of packets to be sent before a TX interrupt.
 * set_coalesce_usecs()
 *   set usecs to delay a TX interrupt after a packet is sent
 * set_coalesce_frames()
 *   set Maximum number of packets to be sent before a TX interrupt.
 * get_mac_addr()
 *   get mac address
 * set_mac_addr()
 *   set mac address
 * add_uc_addr
 *   Add unicast addr to mac table
 * rm_uc_addr
 *   Remove unicast addr from mac table
 * set_mc_addr()
 *   Set multicast address
 * add_mc_addr
 *   Add multicast address to mac table
 * rm_mc_addr
 *   Remove multicast address from mac table
 * update_stats()
 *   Update Old network device statistics
 * get_mac_stats()
 *   get mac pause statistics including tx_cnt and rx_cnt
 * get_ethtool_stats()
 *   Get ethtool network device statistics
 * get_strings()
 *   Get a set of strings that describe the requested objects
 * get_sset_count()
 *   Get number of strings that @get_strings will write
 * update_led_status()
 *   Update the led status
 * set_led_id()
 *   Set led id
 * get_regs()
 *   Get regs dump
 * get_regs_len()
 *   Get the len of the regs dump
 * get_rss_key_size()
 *   Get rss key size
 * get_rss()
 *   Get rss table
 * set_rss()
 *   Set rss table
 * get_tc_size()
 *   Get tc size of handle
 * get_vector()
 *   Get vector number and vector information
 * put_vector()
 *   Put the vector in hdev
 * map_ring_to_vector()
 *   Map rings to vector
 * unmap_ring_from_vector()
 *   Unmap rings from vector
 * reset_queue()
 *   Reset queue
 * get_fw_version()
 *   Get firmware version
 * get_mdix_mode()
 *   Get media typr of phy
 * enable_vlan_filter()
 *   Enable vlan filter
 * set_vlan_filter()
 *   Set vlan filter config of Ports
 * set_vf_vlan_filter()
 *   Set vlan filter config of vf
 * enable_hw_strip_rxvtag()
 *   Enable/disable hardware strip vlan tag of packets received
 * set_gro_en
 *   Enable/disable HW GRO
 * add_arfs_entry
 *   Check the 5-tuples of flow, and create flow director rule
 * get_vf_config
 *   Get the VF configuration setting by the host
 * set_vf_link_state
 *   Set VF link status
 * set_vf_spoofchk
 *   Enable/disable spoof check for specified vf
 * set_vf_trust
 *   Enable/disable trust for specified vf, if the vf being trusted, then
 *   it can enable promisc mode
 * set_vf_rate
 *   Set the max tx rate of specified vf.
 * set_vf_mac
 *   Configure the default MAC for specified VF
 * get_module_eeprom
 *   Get the optical module eeprom info.
 * add_cls_flower
 *   Add clsflower rule
 * del_cls_flower
 *   Delete clsflower rule
 * cls_flower_active
 *   Check if any cls flower rule exist
 * set_tx_hwts_info
 *   Save information for 1588 tx packet
 * get_rx_hwts
 *   Get 1588 rx hwstamp
 * get_ts_info
 *   Get phc info
 * clean_vf_config
 *   Clean residual vf info after disable sriov
 * get_wol
 *   Get wake on lan info
 * set_wol
 *   Config wake on lan
 * dbg_get_read_func
 *   Return the read func for debugfs seq file
 */
struct hnae3_ae_ops {
        int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
        void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
        void (*reset_prepare)(struct hnae3_ae_dev *ae_dev,
                              enum hnae3_reset_type rst_type);
        void (*reset_done)(struct hnae3_ae_dev *ae_dev);
        int (*init_client_instance)(struct hnae3_client *client,
                                    struct hnae3_ae_dev *ae_dev);
        void (*uninit_client_instance)(struct hnae3_client *client,
                                       struct hnae3_ae_dev *ae_dev);
        int (*start)(struct hnae3_handle *handle);
        void (*stop)(struct hnae3_handle *handle);
        int (*client_start)(struct hnae3_handle *handle);
        void (*client_stop)(struct hnae3_handle *handle);
        int (*get_status)(struct hnae3_handle *handle);
        void (*get_ksettings_an_result)(struct hnae3_handle *handle,
                                        u8 *auto_neg, u32 *speed, u8 *duplex,
                                        u32 *lane_num);

        int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
                                   u8 duplex, u8 lane_num);

        void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type,
                               u8 *module_type);
        int (*check_port_speed)(struct hnae3_handle *handle, u32 speed);
        void (*get_fec_stats)(struct hnae3_handle *handle,
                              struct ethtool_fec_stats *fec_stats);
        void (*get_fec)(struct hnae3_handle *handle, u8 *fec_ability,
                        u8 *fec_mode);
        int (*set_fec)(struct hnae3_handle *handle, u32 fec_mode);
        void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
        int (*set_loopback)(struct hnae3_handle *handle,
                            enum hnae3_loop loop_mode, bool en);

        int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
                                bool en_mc_pmc);
        void (*request_update_promisc_mode)(struct hnae3_handle *handle);
        int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);

        void (*get_pauseparam)(struct hnae3_handle *handle,
                               u32 *auto_neg, u32 *rx_en, u32 *tx_en);
        int (*set_pauseparam)(struct hnae3_handle *handle,
                              u32 auto_neg, u32 rx_en, u32 tx_en);

        int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
        int (*get_autoneg)(struct hnae3_handle *handle);
        int (*restart_autoneg)(struct hnae3_handle *handle);
        int (*halt_autoneg)(struct hnae3_handle *handle, bool halt);

        void (*get_coalesce_usecs)(struct hnae3_handle *handle,
                                   u32 *tx_usecs, u32 *rx_usecs);
        void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
                                            u32 *tx_frames, u32 *rx_frames);
        int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
        int (*set_coalesce_frames)(struct hnae3_handle *handle,
                                   u32 coalesce_frames);
        void (*get_coalesce_range)(struct hnae3_handle *handle,
                                   u32 *tx_frames_low, u32 *rx_frames_low,
                                   u32 *tx_frames_high, u32 *rx_frames_high,
                                   u32 *tx_usecs_low, u32 *rx_usecs_low,
                                   u32 *tx_usecs_high, u32 *rx_usecs_high);

        void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
        int (*set_mac_addr)(struct hnae3_handle *handle, const void *p,
                            bool is_first);
        int (*do_ioctl)(struct hnae3_handle *handle,
                        struct ifreq *ifr, int cmd);
        int (*add_uc_addr)(struct hnae3_handle *handle,
                           const unsigned char *addr);
        int (*rm_uc_addr)(struct hnae3_handle *handle,
                          const unsigned char *addr);
        int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
        int (*add_mc_addr)(struct hnae3_handle *handle,
                           const unsigned char *addr);
        int (*rm_mc_addr)(struct hnae3_handle *handle,
                          const unsigned char *addr);
        void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
        void (*update_stats)(struct hnae3_handle *handle);
        void (*get_stats)(struct hnae3_handle *handle, u64 *data);
        void (*get_mac_stats)(struct hnae3_handle *handle,
                              struct hns3_mac_stats *mac_stats);
        void (*get_strings)(struct hnae3_handle *handle,
                            u32 stringset, u8 **data);
        int (*get_sset_count)(struct hnae3_handle *handle, int stringset);

        void (*get_regs)(struct hnae3_handle *handle, u32 *version,
                         void *data);
        int (*get_regs_len)(struct hnae3_handle *handle);

        u32 (*get_rss_key_size)(struct hnae3_handle *handle);
        int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
                       u8 *hfunc);
        int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
                       const u8 *key, const u8 hfunc);
        int (*set_rss_tuple)(struct hnae3_handle *handle,
                             const struct ethtool_rxfh_fields *cmd);
        int (*get_rss_tuple)(struct hnae3_handle *handle,
                             struct ethtool_rxfh_fields *cmd);

        int (*get_tc_size)(struct hnae3_handle *handle);

        int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
                          struct hnae3_vector_info *vector_info);
        int (*put_vector)(struct hnae3_handle *handle, int vector_num);
        int (*map_ring_to_vector)(struct hnae3_handle *handle,
                                  int vector_num,
                                  struct hnae3_ring_chain_node *vr_chain);
        int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
                                      int vector_num,
                                      struct hnae3_ring_chain_node *vr_chain);

        int (*reset_queue)(struct hnae3_handle *handle);
        u32 (*get_fw_version)(struct hnae3_handle *handle);
        void (*get_mdix_mode)(struct hnae3_handle *handle,
                              u8 *tp_mdix_ctrl, u8 *tp_mdix);

        int (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
        int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
                               u16 vlan_id, bool is_kill);
        int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
                                  u16 vlan, u8 qos, __be16 proto);
        int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
        void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
        enum hnae3_reset_type (*get_reset_level)(struct hnae3_ae_dev *ae_dev,
                                                 unsigned long *addr);
        void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
                                          enum hnae3_reset_type rst_type);
        void (*get_channels)(struct hnae3_handle *handle,
                             struct ethtool_channels *ch);
        void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
                                      u16 *alloc_tqps, u16 *max_rss_size);
        int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num,
                            bool rxfh_configured);
        void (*get_flowctrl_adv)(struct hnae3_handle *handle,
                                 u32 *flowctrl_adv);
        int (*set_led_id)(struct hnae3_handle *handle,
                          enum ethtool_phys_id_state status);
        void (*get_link_mode)(struct hnae3_handle *handle,
                              unsigned long *supported,
                              unsigned long *advertising);
        int (*add_fd_entry)(struct hnae3_handle *handle,
                            struct ethtool_rxnfc *cmd);
        int (*del_fd_entry)(struct hnae3_handle *handle,
                            struct ethtool_rxnfc *cmd);
        int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
                               struct ethtool_rxnfc *cmd);
        int (*get_fd_rule_info)(struct hnae3_handle *handle,
                                struct ethtool_rxnfc *cmd);
        int (*get_fd_all_rules)(struct hnae3_handle *handle,
                                struct ethtool_rxnfc *cmd, u32 *rule_locs);
        void (*enable_fd)(struct hnae3_handle *handle, bool enable);
        int (*add_arfs_entry)(struct hnae3_handle *handle, u16 queue_id,
                              u16 flow_id, struct flow_keys *fkeys);
        pci_ers_result_t (*handle_hw_ras_error)(struct hnae3_ae_dev *ae_dev);
        bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
        bool (*ae_dev_resetting)(struct hnae3_handle *handle);
        unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
        int (*set_gro_en)(struct hnae3_handle *handle, bool enable);
        u16 (*get_global_queue_id)(struct hnae3_handle *handle, u16 queue_id);
        void (*set_timer_task)(struct hnae3_handle *handle, bool enable);
        int (*mac_connect_phy)(struct hnae3_handle *handle);
        void (*mac_disconnect_phy)(struct hnae3_handle *handle);
        int (*get_vf_config)(struct hnae3_handle *handle, int vf,
                             struct ifla_vf_info *ivf);
        int (*set_vf_link_state)(struct hnae3_handle *handle, int vf,
                                 int link_state);
        int (*set_vf_spoofchk)(struct hnae3_handle *handle, int vf,
                               bool enable);
        int (*set_vf_trust)(struct hnae3_handle *handle, int vf, bool enable);
        int (*set_vf_rate)(struct hnae3_handle *handle, int vf,
                           int min_tx_rate, int max_tx_rate, bool force);
        int (*set_vf_mac)(struct hnae3_handle *handle, int vf, u8 *p);
        int (*get_module_eeprom)(struct hnae3_handle *handle, u32 offset,
                                 u32 len, u8 *data);
        bool (*get_cmdq_stat)(struct hnae3_handle *handle);
        int (*add_cls_flower)(struct hnae3_handle *handle,
                              struct flow_cls_offload *cls_flower);
        int (*del_cls_flower)(struct hnae3_handle *handle,
                              struct flow_cls_offload *cls_flower);
        bool (*cls_flower_active)(struct hnae3_handle *handle);
        int (*get_phy_link_ksettings)(struct hnae3_handle *handle,
                                      struct ethtool_link_ksettings *cmd);
        int (*set_phy_link_ksettings)(struct hnae3_handle *handle,
                                      const struct ethtool_link_ksettings *cmd);
        bool (*set_tx_hwts_info)(struct hnae3_handle *handle,
                                 struct sk_buff *skb);
        void (*get_rx_hwts)(struct hnae3_handle *handle, struct sk_buff *skb,
                            u32 nsec, u32 sec);
        int (*get_ts_info)(struct hnae3_handle *handle,
                           struct kernel_ethtool_ts_info *info);
        int (*get_link_diagnosis_info)(struct hnae3_handle *handle,
                                       u32 *status_code);
        void (*clean_vf_config)(struct hnae3_ae_dev *ae_dev, int num_vfs);
        int (*get_dscp_prio)(struct hnae3_handle *handle, u8 dscp,
                             u8 *tc_map_mode, u8 *priority);
        void (*get_wol)(struct hnae3_handle *handle,
                        struct ethtool_wolinfo *wol);
        int (*set_wol)(struct hnae3_handle *handle,
                       struct ethtool_wolinfo *wol);
        int (*dbg_get_read_func)(struct hnae3_handle *handle,
                                 enum hnae3_dbg_cmd cmd,
                                 read_func *func);
        int (*hwtstamp_get)(struct hnae3_handle *handle,
                            struct kernel_hwtstamp_config *config);
        int (*hwtstamp_set)(struct hnae3_handle *handle,
                            struct kernel_hwtstamp_config *config,
                            struct netlink_ext_ack *extack);
};

struct hnae3_dcb_ops {
        /* IEEE 802.1Qaz std */
        int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
        int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
        int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
        int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
        int (*ieee_setapp)(struct hnae3_handle *h, struct dcb_app *app);
        int (*ieee_delapp)(struct hnae3_handle *h, struct dcb_app *app);

        /* DCBX configuration */
        u8   (*getdcbx)(struct hnae3_handle *);
        u8   (*setdcbx)(struct hnae3_handle *, u8);

        int (*setup_tc)(struct hnae3_handle *handle,
                        struct tc_mqprio_qopt_offload *mqprio_qopt);
};

struct hnae3_ae_algo {
        const struct hnae3_ae_ops *ops;
        struct list_head node;
        const struct pci_device_id *pdev_id_table;
};

#define HNAE3_INT_NAME_LEN        32
#define HNAE3_ITR_COUNTDOWN_START 100

#define HNAE3_MAX_TC            8
#define HNAE3_MAX_USER_PRIO     8
struct hnae3_tc_info {
        u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
        u16 tqp_count[HNAE3_MAX_TC];
        u16 tqp_offset[HNAE3_MAX_TC];
        u8 max_tc; /* Total number of TCs */
        u8 num_tc; /* Total number of enabled TCs */
        bool mqprio_active;
        bool mqprio_destroy;
        bool dcb_ets_active;
};

#define HNAE3_MAX_DSCP                  64
#define HNAE3_PRIO_ID_INVALID           0xff
struct hnae3_knic_private_info {
        struct net_device *netdev; /* Set by KNIC client when init instance */
        u16 rss_size;              /* Allocated RSS queues */
        u16 req_rss_size;
        u16 rx_buf_len;
        u16 num_tx_desc;
        u16 num_rx_desc;
        u32 tx_spare_buf_size;

        struct hnae3_tc_info tc_info;
        u8 tc_map_mode;
        u8 dscp_app_cnt;
        u8 dscp_prio[HNAE3_MAX_DSCP];

        u16 num_tqps;             /* total number of TQPs in this handle */
        struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
        const struct hnae3_dcb_ops *dcb_ops;

        u16 int_rl_setting;
        void __iomem *io_base;
};

struct hnae3_roce_private_info {
        struct net_device *netdev;
        void __iomem *roce_io_base;
        void __iomem *roce_mem_base;
        int base_vector;
        int num_vectors;

        /* The below attributes defined for RoCE client, hnae3 gives
         * initial values to them, and RoCE client can modify and use
         * them.
         */
        unsigned long reset_state;
        unsigned long instance_state;
        unsigned long state;
};

#define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
#define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
#define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK    BIT(2)
#define HNAE3_SUPPORT_VF              BIT(3)
#define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK  BIT(4)
#define HNAE3_SUPPORT_EXTERNAL_LOOPBACK BIT(5)

#define HNAE3_USER_UPE          BIT(0)  /* unicast promisc enabled by user */
#define HNAE3_USER_MPE          BIT(1)  /* mulitcast promisc enabled by user */
#define HNAE3_BPE               BIT(2)  /* broadcast promisc enable */
#define HNAE3_OVERFLOW_UPE      BIT(3)  /* unicast mac vlan overflow */
#define HNAE3_OVERFLOW_MPE      BIT(4)  /* multicast mac vlan overflow */
#define HNAE3_UPE               (HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
#define HNAE3_MPE               (HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)

enum hnae3_pflag {
        HNAE3_PFLAG_LIMIT_PROMISC,
        HNAE3_PFLAG_MAX
};

struct hnae3_handle {
        struct hnae3_client *client;
        struct pci_dev *pdev;
        void *priv;
        struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
        u64 flags; /* Indicate the capabilities for this handle */

        union {
                struct net_device *netdev; /* first member */
                struct hnae3_knic_private_info kinfo;
                struct hnae3_roce_private_info rinfo;
        };

        nodemask_t numa_node_mask; /* for multi-chip support */

        enum hnae3_port_base_vlan_state port_base_vlan_state;

        u8 netdev_flags;
        struct dentry *hnae3_dbgfs;

        /* Network interface message level enabled bits */
        u32 msg_enable;

        unsigned long supported_pflags;
        unsigned long priv_flags;
};

#define hnae3_set_field(origin, mask, shift, val) \
        do { \
                (origin) &= (~(mask)); \
                (origin) |= ((val) << (shift)) & (mask); \
        } while (0)
#define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))

#define hnae3_set_bit(origin, shift, val) \
        hnae3_set_field(origin, 0x1 << (shift), shift, val)
#define hnae3_get_bit(origin, shift) \
        hnae3_get_field(origin, 0x1 << (shift), shift)

#define HNAE3_FORMAT_MAC_ADDR_LEN       18
#define HNAE3_FORMAT_MAC_ADDR_OFFSET_0  0
#define HNAE3_FORMAT_MAC_ADDR_OFFSET_4  4
#define HNAE3_FORMAT_MAC_ADDR_OFFSET_5  5

static inline void hnae3_format_mac_addr(char *format_mac_addr,
                                         const u8 *mac_addr)
{
        snprintf(format_mac_addr, HNAE3_FORMAT_MAC_ADDR_LEN, "%02x:**:**:**:%02x:%02x",
                 mac_addr[HNAE3_FORMAT_MAC_ADDR_OFFSET_0],
                 mac_addr[HNAE3_FORMAT_MAC_ADDR_OFFSET_4],
                 mac_addr[HNAE3_FORMAT_MAC_ADDR_OFFSET_5]);
}

int hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);

void hnae3_unregister_ae_algo_prepare(struct hnae3_ae_algo *ae_algo);
void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);

void hnae3_unregister_client(struct hnae3_client *client);
int hnae3_register_client(struct hnae3_client *client);

void hnae3_set_client_init_flag(struct hnae3_client *client,
                                struct hnae3_ae_dev *ae_dev,
                                unsigned int inited);
void hnae3_acquire_unload_lock(void);
void hnae3_release_unload_lock(void);
#endif