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