drivers/net/ethernet/hisilicon/hns3/hnae3.h

   1 // SPDX-License-Identifier: GPL-2.0+
   2 // Copyright (c) 2016-2017 Hisilicon Limited.
   3
   4 #ifndef __HNAE3_H
   5 #define __HNAE3_H
   6
   7 /* Names used in this framework:
   8  *      ae handle (handle):
   9  *        a set of queues provided by AE
  10  *      ring buffer queue (rbq):
  11  *        the channel between upper layer and the AE, can do tx and rx
  12  *      ring:
  13  *        a tx or rx channel within a rbq
  14  *      ring description (desc):
  15  *        an element in the ring with packet information
  16  *      buffer:
  17  *        a memory region referred by desc with the full packet payload
  18  *
  19  * "num" means a static number set as a parameter, "count" mean a dynamic
  20  *   number set while running
  21  * "cb" means control block
  22  */
  23
  24 #include <linux/acpi.h>
  25 #include <linux/dcbnl.h>
  26 #include <linux/delay.h>
  27 #include <linux/device.h>
  28 #include <linux/module.h>
  29 #include <linux/netdevice.h>
  30 #include <linux/pci.h>
  31 #include <linux/types.h>
  32
  33 #define HNAE3_MOD_VERSION "1.0"
  34
  35 /* Device IDs */
  36 #define HNAE3_DEV_ID_GE                         0xA220
  37 #define HNAE3_DEV_ID_25GE                       0xA221
  38 #define HNAE3_DEV_ID_25GE_RDMA                  0xA222
  39 #define HNAE3_DEV_ID_25GE_RDMA_MACSEC           0xA223
  40 #define HNAE3_DEV_ID_50GE_RDMA                  0xA224
  41 #define HNAE3_DEV_ID_50GE_RDMA_MACSEC           0xA225
  42 #define HNAE3_DEV_ID_100G_RDMA_MACSEC           0xA226
  43 #define HNAE3_DEV_ID_100G_VF                    0xA22E
  44 #define HNAE3_DEV_ID_100G_RDMA_DCB_PFC_VF       0xA22F
  45
  46 #define HNAE3_CLASS_NAME_SIZE 16
  47
  48 #define HNAE3_DEV_INITED_B                      0x0
  49 #define HNAE3_DEV_SUPPORT_ROCE_B                0x1
  50 #define HNAE3_DEV_SUPPORT_DCB_B                 0x2
  51 #define HNAE3_KNIC_CLIENT_INITED_B              0x3
  52 #define HNAE3_UNIC_CLIENT_INITED_B              0x4
  53 #define HNAE3_ROCE_CLIENT_INITED_B              0x5
  54 #define HNAE3_DEV_SUPPORT_FD_B                  0x6
  55 #define HNAE3_DEV_SUPPORT_GRO_B                 0x7
  56
  57 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
  58                 BIT(HNAE3_DEV_SUPPORT_ROCE_B))
  59
  60 #define hnae3_dev_roce_supported(hdev) \
  61         hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
  62
  63 #define hnae3_dev_dcb_supported(hdev) \
  64         hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
  65
  66 #define hnae3_dev_fd_supported(hdev) \
  67         hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_FD_B)
  68
  69 #define hnae3_dev_gro_supported(hdev) \
  70         hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_GRO_B)
  71
  72 #define ring_ptr_move_fw(ring, p) \
  73         ((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
  74 #define ring_ptr_move_bw(ring, p) \
  75         ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
  76
  77 enum hns_desc_type {
  78         DESC_TYPE_SKB,
  79         DESC_TYPE_PAGE,
  80 };
  81
  82 struct hnae3_handle;
  83
  84 struct hnae3_queue {
  85         void __iomem *io_base;
  86         struct hnae3_ae_algo *ae_algo;
  87         struct hnae3_handle *handle;
  88         int tqp_index;          /* index in a handle */
  89         u32 buf_size;           /* size for hnae_desc->addr, preset by AE */
  90         u16 tx_desc_num;        /* total number of tx desc */
  91         u16 rx_desc_num;        /* total number of rx desc */
  92 };
  93
  94 struct hns3_mac_stats {
  95         u64 tx_pause_cnt;
  96         u64 rx_pause_cnt;
  97 };
  98
  99 /* hnae3 loop mode */
 100 enum hnae3_loop {
 101         HNAE3_LOOP_APP,
 102         HNAE3_LOOP_SERIAL_SERDES,
 103         HNAE3_LOOP_PARALLEL_SERDES,
 104         HNAE3_LOOP_PHY,
 105         HNAE3_LOOP_NONE,
 106 };
 107
 108 enum hnae3_client_type {
 109         HNAE3_CLIENT_KNIC,
 110         HNAE3_CLIENT_ROCE,
 111 };
 112
 113 /* mac media type */
 114 enum hnae3_media_type {
 115         HNAE3_MEDIA_TYPE_UNKNOWN,
 116         HNAE3_MEDIA_TYPE_FIBER,
 117         HNAE3_MEDIA_TYPE_COPPER,
 118         HNAE3_MEDIA_TYPE_BACKPLANE,
 119         HNAE3_MEDIA_TYPE_NONE,
 120 };
 121
 122 /* must be consistent with definition in firmware */
 123 enum hnae3_module_type {
 124         HNAE3_MODULE_TYPE_UNKNOWN       = 0x00,
 125         HNAE3_MODULE_TYPE_FIBRE_LR      = 0x01,
 126         HNAE3_MODULE_TYPE_FIBRE_SR      = 0x02,
 127         HNAE3_MODULE_TYPE_AOC           = 0x03,
 128         HNAE3_MODULE_TYPE_CR            = 0x04,
 129         HNAE3_MODULE_TYPE_KR            = 0x05,
 130         HNAE3_MODULE_TYPE_TP            = 0x06,
 131
 132 };
 133
 134 enum hnae3_fec_mode {
 135         HNAE3_FEC_AUTO = 0,
 136         HNAE3_FEC_BASER,
 137         HNAE3_FEC_RS,
 138         HNAE3_FEC_USER_DEF,
 139 };
 140
 141 enum hnae3_reset_notify_type {
 142         HNAE3_UP_CLIENT,
 143         HNAE3_DOWN_CLIENT,
 144         HNAE3_INIT_CLIENT,
 145         HNAE3_UNINIT_CLIENT,
 146         HNAE3_RESTORE_CLIENT,
 147 };
 148
 149 enum hnae3_hw_error_type {
 150         HNAE3_PPU_POISON_ERROR,
 151         HNAE3_CMDQ_ECC_ERROR,
 152         HNAE3_IMP_RD_POISON_ERROR,
 153 };
 154
 155 enum hnae3_reset_type {
 156         HNAE3_VF_RESET,
 157         HNAE3_VF_FUNC_RESET,
 158         HNAE3_VF_PF_FUNC_RESET,
 159         HNAE3_VF_FULL_RESET,
 160         HNAE3_FLR_RESET,
 161         HNAE3_FUNC_RESET,
 162         HNAE3_GLOBAL_RESET,
 163         HNAE3_IMP_RESET,
 164         HNAE3_UNKNOWN_RESET,
 165         HNAE3_NONE_RESET,
 166 };
 167
 168 enum hnae3_flr_state {
 169         HNAE3_FLR_DOWN,
 170         HNAE3_FLR_DONE,
 171 };
 172
 173 enum hnae3_port_base_vlan_state {
 174         HNAE3_PORT_BASE_VLAN_DISABLE,
 175         HNAE3_PORT_BASE_VLAN_ENABLE,
 176         HNAE3_PORT_BASE_VLAN_MODIFY,
 177         HNAE3_PORT_BASE_VLAN_NOCHANGE,
 178 };
 179
 180 struct hnae3_vector_info {
 181         u8 __iomem *io_addr;
 182         int vector;
 183 };
 184
 185 #define HNAE3_RING_TYPE_B 0
 186 #define HNAE3_RING_TYPE_TX 0
 187 #define HNAE3_RING_TYPE_RX 1
 188 #define HNAE3_RING_GL_IDX_S 0
 189 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
 190 #define HNAE3_RING_GL_RX 0
 191 #define HNAE3_RING_GL_TX 1
 192
 193 #define HNAE3_FW_VERSION_BYTE3_SHIFT    24
 194 #define HNAE3_FW_VERSION_BYTE3_MASK     GENMASK(31, 24)
 195 #define HNAE3_FW_VERSION_BYTE2_SHIFT    16
 196 #define HNAE3_FW_VERSION_BYTE2_MASK     GENMASK(23, 16)
 197 #define HNAE3_FW_VERSION_BYTE1_SHIFT    8
 198 #define HNAE3_FW_VERSION_BYTE1_MASK     GENMASK(15, 8)
 199 #define HNAE3_FW_VERSION_BYTE0_SHIFT    0
 200 #define HNAE3_FW_VERSION_BYTE0_MASK     GENMASK(7, 0)
 201
 202 struct hnae3_ring_chain_node {
 203         struct hnae3_ring_chain_node *next;
 204         u32 tqp_index;
 205         u32 flag;
 206         u32 int_gl_idx;
 207 };
 208
 209 #define HNAE3_IS_TX_RING(node) \
 210         (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
 211
 212 struct hnae3_client_ops {
 213         int (*init_instance)(struct hnae3_handle *handle);
 214         void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
 215         void (*link_status_change)(struct hnae3_handle *handle, bool state);
 216         int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
 217         int (*reset_notify)(struct hnae3_handle *handle,
 218                             enum hnae3_reset_notify_type type);
 219         void (*process_hw_error)(struct hnae3_handle *handle,
 220                                  enum hnae3_hw_error_type);
 221 };
 222
 223 #define HNAE3_CLIENT_NAME_LENGTH 16
 224 struct hnae3_client {
 225         char name[HNAE3_CLIENT_NAME_LENGTH];
 226         unsigned long state;
 227         enum hnae3_client_type type;
 228         const struct hnae3_client_ops *ops;
 229         struct list_head node;
 230 };
 231
 232 struct hnae3_ae_dev {
 233         struct pci_dev *pdev;
 234         const struct hnae3_ae_ops *ops;
 235         struct list_head node;
 236         u32 flag;
 237         unsigned long hw_err_reset_req;
 238         enum hnae3_reset_type reset_type;
 239         void *priv;
 240 };
 241
 242 /* This struct defines the operation on the handle.
 243  *
 244  * init_ae_dev(): (mandatory)
 245  *   Get PF configure from pci_dev and initialize PF hardware
 246  * uninit_ae_dev()
 247  *   Disable PF device and release PF resource
 248  * register_client
 249  *   Register client to ae_dev
 250  * unregister_client()
 251  *   Unregister client from ae_dev
 252  * start()
 253  *   Enable the hardware
 254  * stop()
 255  *   Disable the hardware
 256  * start_client()
 257  *   Inform the hclge that client has been started
 258  * stop_client()
 259  *   Inform the hclge that client has been stopped
 260  * get_status()
 261  *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
 262  *   non-ok
 263  * get_ksettings_an_result()
 264  *   Get negotiation status,speed and duplex
 265  * get_media_type()
 266  *   Get media type of MAC
 267  * check_port_speed()
 268  *   Check target speed whether is supported
 269  * adjust_link()
 270  *   Adjust link status
 271  * set_loopback()
 272  *   Set loopback
 273  * set_promisc_mode
 274  *   Set promisc mode
 275  * set_mtu()
 276  *   set mtu
 277  * get_pauseparam()
 278  *   get tx and rx of pause frame use
 279  * set_pauseparam()
 280  *   set tx and rx of pause frame use
 281  * set_autoneg()
 282  *   set auto autonegotiation of pause frame use
 283  * get_autoneg()
 284  *   get auto autonegotiation of pause frame use
 285  * restart_autoneg()
 286  *   restart autonegotiation
 287  * halt_autoneg()
 288  *   halt/resume autonegotiation when autonegotiation on
 289  * get_coalesce_usecs()
 290  *   get usecs to delay a TX interrupt after a packet is sent
 291  * get_rx_max_coalesced_frames()
 292  *   get Maximum number of packets to be sent before a TX interrupt.
 293  * set_coalesce_usecs()
 294  *   set usecs to delay a TX interrupt after a packet is sent
 295  * set_coalesce_frames()
 296  *   set Maximum number of packets to be sent before a TX interrupt.
 297  * get_mac_addr()
 298  *   get mac address
 299  * set_mac_addr()
 300  *   set mac address
 301  * add_uc_addr
 302  *   Add unicast addr to mac table
 303  * rm_uc_addr
 304  *   Remove unicast addr from mac table
 305  * set_mc_addr()
 306  *   Set multicast address
 307  * add_mc_addr
 308  *   Add multicast address to mac table
 309  * rm_mc_addr
 310  *   Remove multicast address from mac table
 311  * update_stats()
 312  *   Update Old network device statistics
 313  * get_mac_stats()
 314  *   get mac pause statistics including tx_cnt and rx_cnt
 315  * get_ethtool_stats()
 316  *   Get ethtool network device statistics
 317  * get_strings()
 318  *   Get a set of strings that describe the requested objects
 319  * get_sset_count()
 320  *   Get number of strings that @get_strings will write
 321  * update_led_status()
 322  *   Update the led status
 323  * set_led_id()
 324  *   Set led id
 325  * get_regs()
 326  *   Get regs dump
 327  * get_regs_len()
 328  *   Get the len of the regs dump
 329  * get_rss_key_size()
 330  *   Get rss key size
 331  * get_rss_indir_size()
 332  *   Get rss indirection table size
 333  * get_rss()
 334  *   Get rss table
 335  * set_rss()
 336  *   Set rss table
 337  * get_tc_size()
 338  *   Get tc size of handle
 339  * get_vector()
 340  *   Get vector number and vector information
 341  * put_vector()
 342  *   Put the vector in hdev
 343  * map_ring_to_vector()
 344  *   Map rings to vector
 345  * unmap_ring_from_vector()
 346  *   Unmap rings from vector
 347  * reset_queue()
 348  *   Reset queue
 349  * get_fw_version()
 350  *   Get firmware version
 351  * get_mdix_mode()
 352  *   Get media typr of phy
 353  * enable_vlan_filter()
 354  *   Enable vlan filter
 355  * set_vlan_filter()
 356  *   Set vlan filter config of Ports
 357  * set_vf_vlan_filter()
 358  *   Set vlan filter config of vf
 359  * restore_vlan_table()
 360  *   Restore vlan filter entries after reset
 361  * enable_hw_strip_rxvtag()
 362  *   Enable/disable hardware strip vlan tag of packets received
 363  * set_gro_en
 364  *   Enable/disable HW GRO
 365  * add_arfs_entry
 366  *   Check the 5-tuples of flow, and create flow director rule
 367  * get_vf_config
 368  *   Get the VF configuration setting by the host
 369  * set_vf_link_state
 370  *   Set VF link status
 371  * set_vf_spoofchk
 372  *   Enable/disable spoof check for specified vf
 373  */
 374 struct hnae3_ae_ops {
 375         int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
 376         void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
 377         void (*flr_prepare)(struct hnae3_ae_dev *ae_dev);
 378         void (*flr_done)(struct hnae3_ae_dev *ae_dev);
 379         int (*init_client_instance)(struct hnae3_client *client,
 380                                     struct hnae3_ae_dev *ae_dev);
 381         void (*uninit_client_instance)(struct hnae3_client *client,
 382                                        struct hnae3_ae_dev *ae_dev);
 383         int (*start)(struct hnae3_handle *handle);
 384         void (*stop)(struct hnae3_handle *handle);
 385         int (*client_start)(struct hnae3_handle *handle);
 386         void (*client_stop)(struct hnae3_handle *handle);
 387         int (*get_status)(struct hnae3_handle *handle);
 388         void (*get_ksettings_an_result)(struct hnae3_handle *handle,
 389                                         u8 *auto_neg, u32 *speed, u8 *duplex);
 390
 391         int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
 392                                    u8 duplex);
 393
 394         void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type,
 395                                u8 *module_type);
 396         int (*check_port_speed)(struct hnae3_handle *handle, u32 speed);
 397         void (*get_fec)(struct hnae3_handle *handle, u8 *fec_ability,
 398                         u8 *fec_mode);
 399         int (*set_fec)(struct hnae3_handle *handle, u32 fec_mode);
 400         void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
 401         int (*set_loopback)(struct hnae3_handle *handle,
 402                             enum hnae3_loop loop_mode, bool en);
 403
 404         int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
 405                                 bool en_mc_pmc);
 406         int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
 407
 408         void (*get_pauseparam)(struct hnae3_handle *handle,
 409                                u32 *auto_neg, u32 *rx_en, u32 *tx_en);
 410         int (*set_pauseparam)(struct hnae3_handle *handle,
 411                               u32 auto_neg, u32 rx_en, u32 tx_en);
 412
 413         int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
 414         int (*get_autoneg)(struct hnae3_handle *handle);
 415         int (*restart_autoneg)(struct hnae3_handle *handle);
 416         int (*halt_autoneg)(struct hnae3_handle *handle, bool halt);
 417
 418         void (*get_coalesce_usecs)(struct hnae3_handle *handle,
 419                                    u32 *tx_usecs, u32 *rx_usecs);
 420         void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
 421                                             u32 *tx_frames, u32 *rx_frames);
 422         int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
 423         int (*set_coalesce_frames)(struct hnae3_handle *handle,
 424                                    u32 coalesce_frames);
 425         void (*get_coalesce_range)(struct hnae3_handle *handle,
 426                                    u32 *tx_frames_low, u32 *rx_frames_low,
 427                                    u32 *tx_frames_high, u32 *rx_frames_high,
 428                                    u32 *tx_usecs_low, u32 *rx_usecs_low,
 429                                    u32 *tx_usecs_high, u32 *rx_usecs_high);
 430
 431         void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
 432         int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
 433                             bool is_first);
 434         int (*do_ioctl)(struct hnae3_handle *handle,
 435                         struct ifreq *ifr, int cmd);
 436         int (*add_uc_addr)(struct hnae3_handle *handle,
 437                            const unsigned char *addr);
 438         int (*rm_uc_addr)(struct hnae3_handle *handle,
 439                           const unsigned char *addr);
 440         int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
 441         int (*add_mc_addr)(struct hnae3_handle *handle,
 442                            const unsigned char *addr);
 443         int (*rm_mc_addr)(struct hnae3_handle *handle,
 444                           const unsigned char *addr);
 445         void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
 446         void (*update_stats)(struct hnae3_handle *handle,
 447                              struct net_device_stats *net_stats);
 448         void (*get_stats)(struct hnae3_handle *handle, u64 *data);
 449         void (*get_mac_stats)(struct hnae3_handle *handle,
 450                               struct hns3_mac_stats *mac_stats);
 451         void (*get_strings)(struct hnae3_handle *handle,
 452                             u32 stringset, u8 *data);
 453         int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
 454
 455         void (*get_regs)(struct hnae3_handle *handle, u32 *version,
 456                          void *data);
 457         int (*get_regs_len)(struct hnae3_handle *handle);
 458
 459         u32 (*get_rss_key_size)(struct hnae3_handle *handle);
 460         u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
 461         int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
 462                        u8 *hfunc);
 463         int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
 464                        const u8 *key, const u8 hfunc);
 465         int (*set_rss_tuple)(struct hnae3_handle *handle,
 466                              struct ethtool_rxnfc *cmd);
 467         int (*get_rss_tuple)(struct hnae3_handle *handle,
 468                              struct ethtool_rxnfc *cmd);
 469
 470         int (*get_tc_size)(struct hnae3_handle *handle);
 471
 472         int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
 473                           struct hnae3_vector_info *vector_info);
 474         int (*put_vector)(struct hnae3_handle *handle, int vector_num);
 475         int (*map_ring_to_vector)(struct hnae3_handle *handle,
 476                                   int vector_num,
 477                                   struct hnae3_ring_chain_node *vr_chain);
 478         int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
 479                                       int vector_num,
 480                                       struct hnae3_ring_chain_node *vr_chain);
 481
 482         int (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
 483         u32 (*get_fw_version)(struct hnae3_handle *handle);
 484         void (*get_mdix_mode)(struct hnae3_handle *handle,
 485                               u8 *tp_mdix_ctrl, u8 *tp_mdix);
 486
 487         void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
 488         int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
 489                                u16 vlan_id, bool is_kill);
 490         int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
 491                                   u16 vlan, u8 qos, __be16 proto);
 492         int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
 493         void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
 494         enum hnae3_reset_type (*get_reset_level)(struct hnae3_ae_dev *ae_dev,
 495                                                  unsigned long *addr);
 496         void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
 497                                           enum hnae3_reset_type rst_type);
 498         void (*get_channels)(struct hnae3_handle *handle,
 499                              struct ethtool_channels *ch);
 500         void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
 501                                       u16 *alloc_tqps, u16 *max_rss_size);
 502         int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num,
 503                             bool rxfh_configured);
 504         void (*get_flowctrl_adv)(struct hnae3_handle *handle,
 505                                  u32 *flowctrl_adv);
 506         int (*set_led_id)(struct hnae3_handle *handle,
 507                           enum ethtool_phys_id_state status);
 508         void (*get_link_mode)(struct hnae3_handle *handle,
 509                               unsigned long *supported,
 510                               unsigned long *advertising);
 511         int (*add_fd_entry)(struct hnae3_handle *handle,
 512                             struct ethtool_rxnfc *cmd);
 513         int (*del_fd_entry)(struct hnae3_handle *handle,
 514                             struct ethtool_rxnfc *cmd);
 515         void (*del_all_fd_entries)(struct hnae3_handle *handle,
 516                                    bool clear_list);
 517         int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
 518                                struct ethtool_rxnfc *cmd);
 519         int (*get_fd_rule_info)(struct hnae3_handle *handle,
 520                                 struct ethtool_rxnfc *cmd);
 521         int (*get_fd_all_rules)(struct hnae3_handle *handle,
 522                                 struct ethtool_rxnfc *cmd, u32 *rule_locs);
 523         int (*restore_fd_rules)(struct hnae3_handle *handle);
 524         void (*enable_fd)(struct hnae3_handle *handle, bool enable);
 525         int (*add_arfs_entry)(struct hnae3_handle *handle, u16 queue_id,
 526                               u16 flow_id, struct flow_keys *fkeys);
 527         int (*dbg_run_cmd)(struct hnae3_handle *handle, const char *cmd_buf);
 528         pci_ers_result_t (*handle_hw_ras_error)(struct hnae3_ae_dev *ae_dev);
 529         bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
 530         bool (*ae_dev_resetting)(struct hnae3_handle *handle);
 531         unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
 532         int (*set_gro_en)(struct hnae3_handle *handle, bool enable);
 533         u16 (*get_global_queue_id)(struct hnae3_handle *handle, u16 queue_id);
 534         void (*set_timer_task)(struct hnae3_handle *handle, bool enable);
 535         int (*mac_connect_phy)(struct hnae3_handle *handle);
 536         void (*mac_disconnect_phy)(struct hnae3_handle *handle);
 537         void (*restore_vlan_table)(struct hnae3_handle *handle);
 538         int (*get_vf_config)(struct hnae3_handle *handle, int vf,
 539                              struct ifla_vf_info *ivf);
 540         int (*set_vf_link_state)(struct hnae3_handle *handle, int vf,
 541                                  int link_state);
 542         int (*set_vf_spoofchk)(struct hnae3_handle *handle, int vf,
 543                                bool enable);
 544 };
 545
 546 struct hnae3_dcb_ops {
 547         /* IEEE 802.1Qaz std */
 548         int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
 549         int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
 550         int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
 551         int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
 552
 553         /* DCBX configuration */
 554         u8   (*getdcbx)(struct hnae3_handle *);
 555         u8   (*setdcbx)(struct hnae3_handle *, u8);
 556
 557         int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
 558 };
 559
 560 struct hnae3_ae_algo {
 561         const struct hnae3_ae_ops *ops;
 562         struct list_head node;
 563         const struct pci_device_id *pdev_id_table;
 564 };
 565
 566 #define HNAE3_INT_NAME_LEN        (IFNAMSIZ + 16)
 567 #define HNAE3_ITR_COUNTDOWN_START 100
 568
 569 struct hnae3_tc_info {
 570         u16     tqp_offset;     /* TQP offset from base TQP */
 571         u16     tqp_count;      /* Total TQPs */
 572         u8      tc;             /* TC index */
 573         bool    enable;         /* If this TC is enable or not */
 574 };
 575
 576 #define HNAE3_MAX_TC            8
 577 #define HNAE3_MAX_USER_PRIO     8
 578 struct hnae3_knic_private_info {
 579         struct net_device *netdev; /* Set by KNIC client when init instance */
 580         u16 rss_size;              /* Allocated RSS queues */
 581         u16 req_rss_size;
 582         u16 rx_buf_len;
 583         u16 num_tx_desc;
 584         u16 num_rx_desc;
 585
 586         u8 num_tc;                 /* Total number of enabled TCs */
 587         u8 prio_tc[HNAE3_MAX_USER_PRIO];  /* TC indexed by prio */
 588         struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
 589
 590         u16 num_tqps;             /* total number of TQPs in this handle */
 591         struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
 592         const struct hnae3_dcb_ops *dcb_ops;
 593
 594         u16 int_rl_setting;
 595         enum pkt_hash_types rss_type;
 596 };
 597
 598 struct hnae3_roce_private_info {
 599         struct net_device *netdev;
 600         void __iomem *roce_io_base;
 601         int base_vector;
 602         int num_vectors;
 603
 604         /* The below attributes defined for RoCE client, hnae3 gives
 605          * initial values to them, and RoCE client can modify and use
 606          * them.
 607          */
 608         unsigned long reset_state;
 609         unsigned long instance_state;
 610         unsigned long state;
 611 };
 612
 613 struct hnae3_unic_private_info {
 614         struct net_device *netdev;
 615         u16 rx_buf_len;
 616         u16 num_tx_desc;
 617         u16 num_rx_desc;
 618
 619         u16 num_tqps;   /* total number of tqps in this handle */
 620         struct hnae3_queue **tqp;  /* array base of all TQPs of this instance */
 621 };
 622
 623 #define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
 624 #define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
 625 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK    BIT(2)
 626 #define HNAE3_SUPPORT_VF              BIT(3)
 627 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK  BIT(4)
 628
 629 #define HNAE3_USER_UPE          BIT(0)  /* unicast promisc enabled by user */
 630 #define HNAE3_USER_MPE          BIT(1)  /* mulitcast promisc enabled by user */
 631 #define HNAE3_BPE               BIT(2)  /* broadcast promisc enable */
 632 #define HNAE3_OVERFLOW_UPE      BIT(3)  /* unicast mac vlan overflow */
 633 #define HNAE3_OVERFLOW_MPE      BIT(4)  /* multicast mac vlan overflow */
 634 #define HNAE3_VLAN_FLTR         BIT(5)  /* enable vlan filter */
 635 #define HNAE3_UPE               (HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
 636 #define HNAE3_MPE               (HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
 637
 638 struct hnae3_handle {
 639         struct hnae3_client *client;
 640         struct pci_dev *pdev;
 641         void *priv;
 642         struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
 643         u64 flags; /* Indicate the capabilities for this handle */
 644
 645         union {
 646                 struct net_device *netdev; /* first member */
 647                 struct hnae3_knic_private_info kinfo;
 648                 struct hnae3_unic_private_info uinfo;
 649                 struct hnae3_roce_private_info rinfo;
 650         };
 651
 652         u32 numa_node_mask;     /* for multi-chip support */
 653
 654         enum hnae3_port_base_vlan_state port_base_vlan_state;
 655
 656         u8 netdev_flags;
 657         struct dentry *hnae3_dbgfs;
 658
 659         /* Network interface message level enabled bits */
 660         u32 msg_enable;
 661 };
 662
 663 #define hnae3_set_field(origin, mask, shift, val) \
 664         do { \
 665                 (origin) &= (~(mask)); \
 666                 (origin) |= ((val) << (shift)) & (mask); \
 667         } while (0)
 668 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
 669
 670 #define hnae3_set_bit(origin, shift, val) \
 671         hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
 672 #define hnae3_get_bit(origin, shift) \
 673         hnae3_get_field((origin), (0x1 << (shift)), (shift))
 674
 675 int hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
 676 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
 677
 678 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
 679 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
 680
 681 void hnae3_unregister_client(struct hnae3_client *client);
 682 int hnae3_register_client(struct hnae3_client *client);
 683
 684 void hnae3_set_client_init_flag(struct hnae3_client *client,
 685                                 struct hnae3_ae_dev *ae_dev,
 686                                 unsigned int inited);
 687 #endif