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
  56 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
  57                 BIT(HNAE3_DEV_SUPPORT_ROCE_B))
  58
  59 #define hnae3_dev_roce_supported(hdev) \
  60         hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
  61
  62 #define hnae3_dev_dcb_supported(hdev) \
  63         hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
  64
  65 #define hnae3_dev_fd_supported(hdev) \
  66         hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_FD_B)
  67
  68 #define ring_ptr_move_fw(ring, p) \
  69         ((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
  70 #define ring_ptr_move_bw(ring, p) \
  71         ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
  72
  73 enum hns_desc_type {
  74         DESC_TYPE_SKB,
  75         DESC_TYPE_PAGE,
  76 };
  77
  78 struct hnae3_handle;
  79
  80 struct hnae3_queue {
  81         void __iomem *io_base;
  82         struct hnae3_ae_algo *ae_algo;
  83         struct hnae3_handle *handle;
  84         int tqp_index;  /* index in a handle */
  85         u32 buf_size;   /* size for hnae_desc->addr, preset by AE */
  86         u16 desc_num;   /* total number of desc */
  87 };
  88
  89 /*hnae3 loop mode*/
  90 enum hnae3_loop {
  91         HNAE3_LOOP_APP,
  92         HNAE3_LOOP_SERIAL_SERDES,
  93         HNAE3_LOOP_PARALLEL_SERDES,
  94         HNAE3_LOOP_PHY,
  95         HNAE3_LOOP_NONE,
  96 };
  97
  98 enum hnae3_client_type {
  99         HNAE3_CLIENT_KNIC,
 100         HNAE3_CLIENT_UNIC,
 101         HNAE3_CLIENT_ROCE,
 102 };
 103
 104 enum hnae3_dev_type {
 105         HNAE3_DEV_KNIC,
 106         HNAE3_DEV_UNIC,
 107 };
 108
 109 /* mac media type */
 110 enum hnae3_media_type {
 111         HNAE3_MEDIA_TYPE_UNKNOWN,
 112         HNAE3_MEDIA_TYPE_FIBER,
 113         HNAE3_MEDIA_TYPE_COPPER,
 114         HNAE3_MEDIA_TYPE_BACKPLANE,
 115         HNAE3_MEDIA_TYPE_NONE,
 116 };
 117
 118 enum hnae3_reset_notify_type {
 119         HNAE3_UP_CLIENT,
 120         HNAE3_DOWN_CLIENT,
 121         HNAE3_INIT_CLIENT,
 122         HNAE3_UNINIT_CLIENT,
 123 };
 124
 125 enum hnae3_reset_type {
 126         HNAE3_VF_RESET,
 127         HNAE3_VF_FULL_RESET,
 128         HNAE3_FUNC_RESET,
 129         HNAE3_CORE_RESET,
 130         HNAE3_GLOBAL_RESET,
 131         HNAE3_IMP_RESET,
 132         HNAE3_NONE_RESET,
 133 };
 134
 135 struct hnae3_vector_info {
 136         u8 __iomem *io_addr;
 137         int vector;
 138 };
 139
 140 #define HNAE3_RING_TYPE_B 0
 141 #define HNAE3_RING_TYPE_TX 0
 142 #define HNAE3_RING_TYPE_RX 1
 143 #define HNAE3_RING_GL_IDX_S 0
 144 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
 145 #define HNAE3_RING_GL_RX 0
 146 #define HNAE3_RING_GL_TX 1
 147
 148 struct hnae3_ring_chain_node {
 149         struct hnae3_ring_chain_node *next;
 150         u32 tqp_index;
 151         u32 flag;
 152         u32 int_gl_idx;
 153 };
 154
 155 #define HNAE3_IS_TX_RING(node) \
 156         (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
 157
 158 struct hnae3_client_ops {
 159         int (*init_instance)(struct hnae3_handle *handle);
 160         void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
 161         void (*link_status_change)(struct hnae3_handle *handle, bool state);
 162         int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
 163         int (*reset_notify)(struct hnae3_handle *handle,
 164                             enum hnae3_reset_notify_type type);
 165         enum hnae3_reset_type (*process_hw_error)(struct hnae3_handle *handle);
 166 };
 167
 168 #define HNAE3_CLIENT_NAME_LENGTH 16
 169 struct hnae3_client {
 170         char name[HNAE3_CLIENT_NAME_LENGTH];
 171         unsigned long state;
 172         enum hnae3_client_type type;
 173         const struct hnae3_client_ops *ops;
 174         struct list_head node;
 175 };
 176
 177 struct hnae3_ae_dev {
 178         struct pci_dev *pdev;
 179         const struct hnae3_ae_ops *ops;
 180         struct list_head node;
 181         u32 flag;
 182         enum hnae3_dev_type dev_type;
 183         enum hnae3_reset_type reset_type;
 184         void *priv;
 185 };
 186
 187 /* This struct defines the operation on the handle.
 188  *
 189  * init_ae_dev(): (mandatory)
 190  *   Get PF configure from pci_dev and initialize PF hardware
 191  * uninit_ae_dev()
 192  *   Disable PF device and release PF resource
 193  * register_client
 194  *   Register client to ae_dev
 195  * unregister_client()
 196  *   Unregister client from ae_dev
 197  * start()
 198  *   Enable the hardware
 199  * stop()
 200  *   Disable the hardware
 201  * get_status()
 202  *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
 203  *   non-ok
 204  * get_ksettings_an_result()
 205  *   Get negotiation status,speed and duplex
 206  * update_speed_duplex_h()
 207  *   Update hardware speed and duplex
 208  * get_media_type()
 209  *   Get media type of MAC
 210  * adjust_link()
 211  *   Adjust link status
 212  * set_loopback()
 213  *   Set loopback
 214  * set_promisc_mode
 215  *   Set promisc mode
 216  * set_mtu()
 217  *   set mtu
 218  * get_pauseparam()
 219  *   get tx and rx of pause frame use
 220  * set_pauseparam()
 221  *   set tx and rx of pause frame use
 222  * set_autoneg()
 223  *   set auto autonegotiation of pause frame use
 224  * get_autoneg()
 225  *   get auto autonegotiation of pause frame use
 226  * get_coalesce_usecs()
 227  *   get usecs to delay a TX interrupt after a packet is sent
 228  * get_rx_max_coalesced_frames()
 229  *   get Maximum number of packets to be sent before a TX interrupt.
 230  * set_coalesce_usecs()
 231  *   set usecs to delay a TX interrupt after a packet is sent
 232  * set_coalesce_frames()
 233  *   set Maximum number of packets to be sent before a TX interrupt.
 234  * get_mac_addr()
 235  *   get mac address
 236  * set_mac_addr()
 237  *   set mac address
 238  * add_uc_addr
 239  *   Add unicast addr to mac table
 240  * rm_uc_addr
 241  *   Remove unicast addr from mac table
 242  * set_mc_addr()
 243  *   Set multicast address
 244  * add_mc_addr
 245  *   Add multicast address to mac table
 246  * rm_mc_addr
 247  *   Remove multicast address from mac table
 248  * update_stats()
 249  *   Update Old network device statistics
 250  * get_ethtool_stats()
 251  *   Get ethtool network device statistics
 252  * get_strings()
 253  *   Get a set of strings that describe the requested objects
 254  * get_sset_count()
 255  *   Get number of strings that @get_strings will write
 256  * update_led_status()
 257  *   Update the led status
 258  * set_led_id()
 259  *   Set led id
 260  * get_regs()
 261  *   Get regs dump
 262  * get_regs_len()
 263  *   Get the len of the regs dump
 264  * get_rss_key_size()
 265  *   Get rss key size
 266  * get_rss_indir_size()
 267  *   Get rss indirection table size
 268  * get_rss()
 269  *   Get rss table
 270  * set_rss()
 271  *   Set rss table
 272  * get_tc_size()
 273  *   Get tc size of handle
 274  * get_vector()
 275  *   Get vector number and vector information
 276  * put_vector()
 277  *   Put the vector in hdev
 278  * map_ring_to_vector()
 279  *   Map rings to vector
 280  * unmap_ring_from_vector()
 281  *   Unmap rings from vector
 282  * reset_queue()
 283  *   Reset queue
 284  * get_fw_version()
 285  *   Get firmware version
 286  * get_mdix_mode()
 287  *   Get media typr of phy
 288  * enable_vlan_filter()
 289  *   Enable vlan filter
 290  * set_vlan_filter()
 291  *   Set vlan filter config of Ports
 292  * set_vf_vlan_filter()
 293  *   Set vlan filter config of vf
 294  * enable_hw_strip_rxvtag()
 295  *   Enable/disable hardware strip vlan tag of packets received
 296  */
 297 struct hnae3_ae_ops {
 298         int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
 299         void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
 300
 301         int (*init_client_instance)(struct hnae3_client *client,
 302                                     struct hnae3_ae_dev *ae_dev);
 303         void (*uninit_client_instance)(struct hnae3_client *client,
 304                                        struct hnae3_ae_dev *ae_dev);
 305         int (*start)(struct hnae3_handle *handle);
 306         void (*stop)(struct hnae3_handle *handle);
 307         int (*get_status)(struct hnae3_handle *handle);
 308         void (*get_ksettings_an_result)(struct hnae3_handle *handle,
 309                                         u8 *auto_neg, u32 *speed, u8 *duplex);
 310
 311         int (*update_speed_duplex_h)(struct hnae3_handle *handle);
 312         int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
 313                                    u8 duplex);
 314
 315         void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type);
 316         void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
 317         int (*set_loopback)(struct hnae3_handle *handle,
 318                             enum hnae3_loop loop_mode, bool en);
 319
 320         int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
 321                                 bool en_mc_pmc);
 322         int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
 323
 324         void (*get_pauseparam)(struct hnae3_handle *handle,
 325                                u32 *auto_neg, u32 *rx_en, u32 *tx_en);
 326         int (*set_pauseparam)(struct hnae3_handle *handle,
 327                               u32 auto_neg, u32 rx_en, u32 tx_en);
 328
 329         int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
 330         int (*get_autoneg)(struct hnae3_handle *handle);
 331
 332         void (*get_coalesce_usecs)(struct hnae3_handle *handle,
 333                                    u32 *tx_usecs, u32 *rx_usecs);
 334         void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
 335                                             u32 *tx_frames, u32 *rx_frames);
 336         int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
 337         int (*set_coalesce_frames)(struct hnae3_handle *handle,
 338                                    u32 coalesce_frames);
 339         void (*get_coalesce_range)(struct hnae3_handle *handle,
 340                                    u32 *tx_frames_low, u32 *rx_frames_low,
 341                                    u32 *tx_frames_high, u32 *rx_frames_high,
 342                                    u32 *tx_usecs_low, u32 *rx_usecs_low,
 343                                    u32 *tx_usecs_high, u32 *rx_usecs_high);
 344
 345         void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
 346         int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
 347                             bool is_first);
 348         int (*do_ioctl)(struct hnae3_handle *handle,
 349                         struct ifreq *ifr, int cmd);
 350         int (*add_uc_addr)(struct hnae3_handle *handle,
 351                            const unsigned char *addr);
 352         int (*rm_uc_addr)(struct hnae3_handle *handle,
 353                           const unsigned char *addr);
 354         int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
 355         int (*add_mc_addr)(struct hnae3_handle *handle,
 356                            const unsigned char *addr);
 357         int (*rm_mc_addr)(struct hnae3_handle *handle,
 358                           const unsigned char *addr);
 359         void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
 360         void (*update_stats)(struct hnae3_handle *handle,
 361                              struct net_device_stats *net_stats);
 362         void (*get_stats)(struct hnae3_handle *handle, u64 *data);
 363
 364         void (*get_strings)(struct hnae3_handle *handle,
 365                             u32 stringset, u8 *data);
 366         int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
 367
 368         void (*get_regs)(struct hnae3_handle *handle, u32 *version,
 369                          void *data);
 370         int (*get_regs_len)(struct hnae3_handle *handle);
 371
 372         u32 (*get_rss_key_size)(struct hnae3_handle *handle);
 373         u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
 374         int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
 375                        u8 *hfunc);
 376         int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
 377                        const u8 *key, const u8 hfunc);
 378         int (*set_rss_tuple)(struct hnae3_handle *handle,
 379                              struct ethtool_rxnfc *cmd);
 380         int (*get_rss_tuple)(struct hnae3_handle *handle,
 381                              struct ethtool_rxnfc *cmd);
 382
 383         int (*get_tc_size)(struct hnae3_handle *handle);
 384
 385         int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
 386                           struct hnae3_vector_info *vector_info);
 387         int (*put_vector)(struct hnae3_handle *handle, int vector_num);
 388         int (*map_ring_to_vector)(struct hnae3_handle *handle,
 389                                   int vector_num,
 390                                   struct hnae3_ring_chain_node *vr_chain);
 391         int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
 392                                       int vector_num,
 393                                       struct hnae3_ring_chain_node *vr_chain);
 394
 395         int (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
 396         u32 (*get_fw_version)(struct hnae3_handle *handle);
 397         void (*get_mdix_mode)(struct hnae3_handle *handle,
 398                               u8 *tp_mdix_ctrl, u8 *tp_mdix);
 399
 400         void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
 401         int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
 402                                u16 vlan_id, bool is_kill);
 403         int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
 404                                   u16 vlan, u8 qos, __be16 proto);
 405         int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
 406         void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
 407         void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
 408                                           enum hnae3_reset_type rst_type);
 409         void (*get_channels)(struct hnae3_handle *handle,
 410                              struct ethtool_channels *ch);
 411         void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
 412                                       u16 *alloc_tqps, u16 *max_rss_size);
 413         int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num);
 414         void (*get_flowctrl_adv)(struct hnae3_handle *handle,
 415                                  u32 *flowctrl_adv);
 416         int (*set_led_id)(struct hnae3_handle *handle,
 417                           enum ethtool_phys_id_state status);
 418         void (*get_link_mode)(struct hnae3_handle *handle,
 419                               unsigned long *supported,
 420                               unsigned long *advertising);
 421         int (*add_fd_entry)(struct hnae3_handle *handle,
 422                             struct ethtool_rxnfc *cmd);
 423         int (*del_fd_entry)(struct hnae3_handle *handle,
 424                             struct ethtool_rxnfc *cmd);
 425         void (*del_all_fd_entries)(struct hnae3_handle *handle,
 426                                    bool clear_list);
 427         int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
 428                                struct ethtool_rxnfc *cmd);
 429         int (*get_fd_rule_info)(struct hnae3_handle *handle,
 430                                 struct ethtool_rxnfc *cmd);
 431         int (*get_fd_all_rules)(struct hnae3_handle *handle,
 432                                 struct ethtool_rxnfc *cmd, u32 *rule_locs);
 433         int (*restore_fd_rules)(struct hnae3_handle *handle);
 434         void (*enable_fd)(struct hnae3_handle *handle, bool enable);
 435         pci_ers_result_t (*process_hw_error)(struct hnae3_ae_dev *ae_dev);
 436         bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
 437         bool (*ae_dev_resetting)(struct hnae3_handle *handle);
 438         unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
 439 };
 440
 441 struct hnae3_dcb_ops {
 442         /* IEEE 802.1Qaz std */
 443         int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
 444         int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
 445         int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
 446         int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
 447
 448         /* DCBX configuration */
 449         u8   (*getdcbx)(struct hnae3_handle *);
 450         u8   (*setdcbx)(struct hnae3_handle *, u8);
 451
 452         int (*map_update)(struct hnae3_handle *);
 453         int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
 454 };
 455
 456 struct hnae3_ae_algo {
 457         const struct hnae3_ae_ops *ops;
 458         struct list_head node;
 459         const struct pci_device_id *pdev_id_table;
 460 };
 461
 462 #define HNAE3_INT_NAME_LEN        (IFNAMSIZ + 16)
 463 #define HNAE3_ITR_COUNTDOWN_START 100
 464
 465 struct hnae3_tc_info {
 466         u16     tqp_offset;     /* TQP offset from base TQP */
 467         u16     tqp_count;      /* Total TQPs */
 468         u8      tc;             /* TC index */
 469         bool    enable;         /* If this TC is enable or not */
 470 };
 471
 472 #define HNAE3_MAX_TC            8
 473 #define HNAE3_MAX_USER_PRIO     8
 474 struct hnae3_knic_private_info {
 475         struct net_device *netdev; /* Set by KNIC client when init instance */
 476         u16 rss_size;              /* Allocated RSS queues */
 477         u16 rx_buf_len;
 478         u16 num_desc;
 479
 480         u8 num_tc;                 /* Total number of enabled TCs */
 481         u8 prio_tc[HNAE3_MAX_USER_PRIO];  /* TC indexed by prio */
 482         struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
 483
 484         u16 num_tqps;             /* total number of TQPs in this handle */
 485         struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
 486         const struct hnae3_dcb_ops *dcb_ops;
 487
 488         u16 int_rl_setting;
 489         enum pkt_hash_types rss_type;
 490 };
 491
 492 struct hnae3_roce_private_info {
 493         struct net_device *netdev;
 494         void __iomem *roce_io_base;
 495         int base_vector;
 496         int num_vectors;
 497
 498         /* The below attributes defined for RoCE client, hnae3 gives
 499          * initial values to them, and RoCE client can modify and use
 500          * them.
 501          */
 502         unsigned long reset_state;
 503         unsigned long instance_state;
 504         unsigned long state;
 505 };
 506
 507 struct hnae3_unic_private_info {
 508         struct net_device *netdev;
 509         u16 rx_buf_len;
 510         u16 num_desc;
 511         u16 num_tqps;   /* total number of tqps in this handle */
 512         struct hnae3_queue **tqp;  /* array base of all TQPs of this instance */
 513 };
 514
 515 #define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
 516 #define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
 517 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK    BIT(2)
 518 #define HNAE3_SUPPORT_VF              BIT(3)
 519 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK  BIT(4)
 520
 521 #define HNAE3_USER_UPE          BIT(0)  /* unicast promisc enabled by user */
 522 #define HNAE3_USER_MPE          BIT(1)  /* mulitcast promisc enabled by user */
 523 #define HNAE3_BPE               BIT(2)  /* broadcast promisc enable */
 524 #define HNAE3_OVERFLOW_UPE      BIT(3)  /* unicast mac vlan overflow */
 525 #define HNAE3_OVERFLOW_MPE      BIT(4)  /* multicast mac vlan overflow */
 526 #define HNAE3_VLAN_FLTR         BIT(5)  /* enable vlan filter */
 527 #define HNAE3_UPE               (HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
 528 #define HNAE3_MPE               (HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
 529
 530 struct hnae3_handle {
 531         struct hnae3_client *client;
 532         struct pci_dev *pdev;
 533         void *priv;
 534         struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
 535         u64 flags; /* Indicate the capabilities for this handle*/
 536
 537         union {
 538                 struct net_device *netdev; /* first member */
 539                 struct hnae3_knic_private_info kinfo;
 540                 struct hnae3_unic_private_info uinfo;
 541                 struct hnae3_roce_private_info rinfo;
 542         };
 543
 544         u32 numa_node_mask;     /* for multi-chip support */
 545
 546         u8 netdev_flags;
 547 };
 548
 549 #define hnae3_set_field(origin, mask, shift, val) \
 550         do { \
 551                 (origin) &= (~(mask)); \
 552                 (origin) |= ((val) << (shift)) & (mask); \
 553         } while (0)
 554 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
 555
 556 #define hnae3_set_bit(origin, shift, val) \
 557         hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
 558 #define hnae3_get_bit(origin, shift) \
 559         hnae3_get_field((origin), (0x1 << (shift)), (shift))
 560
 561 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
 562 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
 563
 564 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
 565 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
 566
 567 void hnae3_unregister_client(struct hnae3_client *client);
 568 int hnae3_register_client(struct hnae3_client *client);
 569
 570 void hnae3_set_client_init_flag(struct hnae3_client *client,
 571                                 struct hnae3_ae_dev *ae_dev, int inited);
 572 #endif