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