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