1 /* 2 * Copyright (c) 2016-2017 Hisilicon Limited. 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation; either version 2 of the License, or 7 * (at your option) any later version. 8 */ 9 10 #ifndef __HNAE3_H 11 #define __HNAE3_H 12 13 /* Names used in this framework: 14 * ae handle (handle): 15 * a set of queues provided by AE 16 * ring buffer queue (rbq): 17 * the channel between upper layer and the AE, can do tx and rx 18 * ring: 19 * a tx or rx channel within a rbq 20 * ring description (desc): 21 * an element in the ring with packet information 22 * buffer: 23 * a memory region referred by desc with the full packet payload 24 * 25 * "num" means a static number set as a parameter, "count" mean a dynamic 26 * number set while running 27 * "cb" means control block 28 */ 29 30 #include <linux/acpi.h> 31 #include <linux/dcbnl.h> 32 #include <linux/delay.h> 33 #include <linux/device.h> 34 #include <linux/module.h> 35 #include <linux/netdevice.h> 36 #include <linux/pci.h> 37 #include <linux/types.h> 38 39 #define HNAE3_MOD_VERSION "1.0" 40 41 /* Device IDs */ 42 #define HNAE3_DEV_ID_GE 0xA220 43 #define HNAE3_DEV_ID_25GE 0xA221 44 #define HNAE3_DEV_ID_25GE_RDMA 0xA222 45 #define HNAE3_DEV_ID_25GE_RDMA_MACSEC 0xA223 46 #define HNAE3_DEV_ID_50GE_RDMA 0xA224 47 #define HNAE3_DEV_ID_50GE_RDMA_MACSEC 0xA225 48 #define HNAE3_DEV_ID_100G_RDMA_MACSEC 0xA226 49 #define HNAE3_DEV_ID_100G_VF 0xA22E 50 #define HNAE3_DEV_ID_100G_RDMA_DCB_PFC_VF 0xA22F 51 52 #define HNAE3_CLASS_NAME_SIZE 16 53 54 #define HNAE3_DEV_INITED_B 0x0 55 #define HNAE3_DEV_SUPPORT_ROCE_B 0x1 56 #define HNAE3_DEV_SUPPORT_DCB_B 0x2 57 #define HNAE3_KNIC_CLIENT_INITED_B 0x3 58 #define HNAE3_UNIC_CLIENT_INITED_B 0x4 59 #define HNAE3_ROCE_CLIENT_INITED_B 0x5 60 61 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\ 62 BIT(HNAE3_DEV_SUPPORT_ROCE_B)) 63 64 #define hnae3_dev_roce_supported(hdev) \ 65 hnae_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B) 66 67 #define hnae3_dev_dcb_supported(hdev) \ 68 hnae_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B) 69 70 #define ring_ptr_move_fw(ring, p) \ 71 ((ring)->p = ((ring)->p + 1) % (ring)->desc_num) 72 #define ring_ptr_move_bw(ring, p) \ 73 ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num) 74 75 enum hns_desc_type { 76 DESC_TYPE_SKB, 77 DESC_TYPE_PAGE, 78 }; 79 80 struct hnae3_handle; 81 82 struct hnae3_queue { 83 void __iomem *io_base; 84 struct hnae3_ae_algo *ae_algo; 85 struct hnae3_handle *handle; 86 int tqp_index; /* index in a handle */ 87 u32 buf_size; /* size for hnae_desc->addr, preset by AE */ 88 u16 desc_num; /* total number of desc */ 89 }; 90 91 /*hnae3 loop mode*/ 92 enum hnae3_loop { 93 HNAE3_MAC_INTER_LOOP_MAC, 94 HNAE3_MAC_INTER_LOOP_SERDES, 95 HNAE3_MAC_INTER_LOOP_PHY, 96 HNAE3_MAC_LOOP_NONE, 97 }; 98 99 enum hnae3_client_type { 100 HNAE3_CLIENT_KNIC, 101 HNAE3_CLIENT_UNIC, 102 HNAE3_CLIENT_ROCE, 103 }; 104 105 enum hnae3_dev_type { 106 HNAE3_DEV_KNIC, 107 HNAE3_DEV_UNIC, 108 }; 109 110 /* mac media type */ 111 enum hnae3_media_type { 112 HNAE3_MEDIA_TYPE_UNKNOWN, 113 HNAE3_MEDIA_TYPE_FIBER, 114 HNAE3_MEDIA_TYPE_COPPER, 115 HNAE3_MEDIA_TYPE_BACKPLANE, 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 }; 166 167 #define HNAE3_CLIENT_NAME_LENGTH 16 168 struct hnae3_client { 169 char name[HNAE3_CLIENT_NAME_LENGTH]; 170 u16 version; 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 void *priv; 184 }; 185 186 /* This struct defines the operation on the handle. 187 * 188 * init_ae_dev(): (mandatory) 189 * Get PF configure from pci_dev and initialize PF hardware 190 * uninit_ae_dev() 191 * Disable PF device and release PF resource 192 * register_client 193 * Register client to ae_dev 194 * unregister_client() 195 * Unregister client from ae_dev 196 * start() 197 * Enable the hardware 198 * stop() 199 * Disable the hardware 200 * get_status() 201 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for 202 * non-ok 203 * get_ksettings_an_result() 204 * Get negotiation status,speed and duplex 205 * update_speed_duplex_h() 206 * Update hardware speed and duplex 207 * get_media_type() 208 * Get media type of MAC 209 * adjust_link() 210 * Adjust link status 211 * set_loopback() 212 * Set loopback 213 * set_promisc_mode 214 * Set promisc mode 215 * set_mtu() 216 * set mtu 217 * get_pauseparam() 218 * get tx and rx of pause frame use 219 * set_pauseparam() 220 * set tx and rx of pause frame use 221 * set_autoneg() 222 * set auto autonegotiation of pause frame use 223 * get_autoneg() 224 * get auto autonegotiation of pause frame use 225 * get_coalesce_usecs() 226 * get usecs to delay a TX interrupt after a packet is sent 227 * get_rx_max_coalesced_frames() 228 * get Maximum number of packets to be sent before a TX interrupt. 229 * set_coalesce_usecs() 230 * set usecs to delay a TX interrupt after a packet is sent 231 * set_coalesce_frames() 232 * set Maximum number of packets to be sent before a TX interrupt. 233 * get_mac_addr() 234 * get mac address 235 * set_mac_addr() 236 * set mac address 237 * add_uc_addr 238 * Add unicast addr to mac table 239 * rm_uc_addr 240 * Remove unicast addr from mac table 241 * set_mc_addr() 242 * Set multicast address 243 * add_mc_addr 244 * Add multicast address to mac table 245 * rm_mc_addr 246 * Remove multicast address from mac table 247 * update_stats() 248 * Update Old network device statistics 249 * get_ethtool_stats() 250 * Get ethtool network device statistics 251 * get_strings() 252 * Get a set of strings that describe the requested objects 253 * get_sset_count() 254 * Get number of strings that @get_strings will write 255 * update_led_status() 256 * Update the led status 257 * set_led_id() 258 * Set led id 259 * get_regs() 260 * Get regs dump 261 * get_regs_len() 262 * Get the len of the regs dump 263 * get_rss_key_size() 264 * Get rss key size 265 * get_rss_indir_size() 266 * Get rss indirection table size 267 * get_rss() 268 * Get rss table 269 * set_rss() 270 * Set rss table 271 * get_tc_size() 272 * Get tc size of handle 273 * get_vector() 274 * Get vector number and vector information 275 * put_vector() 276 * Put the vector in hdev 277 * map_ring_to_vector() 278 * Map rings to vector 279 * unmap_ring_from_vector() 280 * Unmap rings from vector 281 * reset_queue() 282 * Reset queue 283 * get_fw_version() 284 * Get firmware version 285 * get_mdix_mode() 286 * Get media typr of phy 287 * enable_vlan_filter() 288 * Enable vlan filter 289 * set_vlan_filter() 290 * Set vlan filter config of Ports 291 * set_vf_vlan_filter() 292 * Set vlan filter config of vf 293 * enable_hw_strip_rxvtag() 294 * Enable/disable hardware strip vlan tag of packets received 295 */ 296 struct hnae3_ae_ops { 297 int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev); 298 void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev); 299 300 int (*init_client_instance)(struct hnae3_client *client, 301 struct hnae3_ae_dev *ae_dev); 302 void (*uninit_client_instance)(struct hnae3_client *client, 303 struct hnae3_ae_dev *ae_dev); 304 int (*start)(struct hnae3_handle *handle); 305 void (*stop)(struct hnae3_handle *handle); 306 int (*get_status)(struct hnae3_handle *handle); 307 void (*get_ksettings_an_result)(struct hnae3_handle *handle, 308 u8 *auto_neg, u32 *speed, u8 *duplex); 309 310 int (*update_speed_duplex_h)(struct hnae3_handle *handle); 311 int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed, 312 u8 duplex); 313 314 void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type); 315 void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex); 316 int (*set_loopback)(struct hnae3_handle *handle, 317 enum hnae3_loop loop_mode, bool en); 318 319 void (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc, 320 bool en_mc_pmc); 321 int (*set_mtu)(struct hnae3_handle *handle, int new_mtu); 322 323 void (*get_pauseparam)(struct hnae3_handle *handle, 324 u32 *auto_neg, u32 *rx_en, u32 *tx_en); 325 int (*set_pauseparam)(struct hnae3_handle *handle, 326 u32 auto_neg, u32 rx_en, u32 tx_en); 327 328 int (*set_autoneg)(struct hnae3_handle *handle, bool enable); 329 int (*get_autoneg)(struct hnae3_handle *handle); 330 331 void (*get_coalesce_usecs)(struct hnae3_handle *handle, 332 u32 *tx_usecs, u32 *rx_usecs); 333 void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle, 334 u32 *tx_frames, u32 *rx_frames); 335 int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout); 336 int (*set_coalesce_frames)(struct hnae3_handle *handle, 337 u32 coalesce_frames); 338 void (*get_coalesce_range)(struct hnae3_handle *handle, 339 u32 *tx_frames_low, u32 *rx_frames_low, 340 u32 *tx_frames_high, u32 *rx_frames_high, 341 u32 *tx_usecs_low, u32 *rx_usecs_low, 342 u32 *tx_usecs_high, u32 *rx_usecs_high); 343 344 void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p); 345 int (*set_mac_addr)(struct hnae3_handle *handle, void *p, 346 bool is_first); 347 int (*add_uc_addr)(struct hnae3_handle *handle, 348 const unsigned char *addr); 349 int (*rm_uc_addr)(struct hnae3_handle *handle, 350 const unsigned char *addr); 351 int (*set_mc_addr)(struct hnae3_handle *handle, void *addr); 352 int (*add_mc_addr)(struct hnae3_handle *handle, 353 const unsigned char *addr); 354 int (*rm_mc_addr)(struct hnae3_handle *handle, 355 const unsigned char *addr); 356 int (*update_mta_status)(struct hnae3_handle *handle); 357 358 void (*set_tso_stats)(struct hnae3_handle *handle, int enable); 359 void (*update_stats)(struct hnae3_handle *handle, 360 struct net_device_stats *net_stats); 361 void (*get_stats)(struct hnae3_handle *handle, u64 *data); 362 363 void (*get_strings)(struct hnae3_handle *handle, 364 u32 stringset, u8 *data); 365 int (*get_sset_count)(struct hnae3_handle *handle, int stringset); 366 367 void (*get_regs)(struct hnae3_handle *handle, u32 *version, 368 void *data); 369 int (*get_regs_len)(struct hnae3_handle *handle); 370 371 u32 (*get_rss_key_size)(struct hnae3_handle *handle); 372 u32 (*get_rss_indir_size)(struct hnae3_handle *handle); 373 int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key, 374 u8 *hfunc); 375 int (*set_rss)(struct hnae3_handle *handle, const u32 *indir, 376 const u8 *key, const u8 hfunc); 377 int (*set_rss_tuple)(struct hnae3_handle *handle, 378 struct ethtool_rxnfc *cmd); 379 int (*get_rss_tuple)(struct hnae3_handle *handle, 380 struct ethtool_rxnfc *cmd); 381 382 int (*get_tc_size)(struct hnae3_handle *handle); 383 384 int (*get_vector)(struct hnae3_handle *handle, u16 vector_num, 385 struct hnae3_vector_info *vector_info); 386 int (*put_vector)(struct hnae3_handle *handle, int vector_num); 387 int (*map_ring_to_vector)(struct hnae3_handle *handle, 388 int vector_num, 389 struct hnae3_ring_chain_node *vr_chain); 390 int (*unmap_ring_from_vector)(struct hnae3_handle *handle, 391 int vector_num, 392 struct hnae3_ring_chain_node *vr_chain); 393 394 void (*reset_queue)(struct hnae3_handle *handle, u16 queue_id); 395 u32 (*get_fw_version)(struct hnae3_handle *handle); 396 void (*get_mdix_mode)(struct hnae3_handle *handle, 397 u8 *tp_mdix_ctrl, u8 *tp_mdix); 398 399 void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable); 400 int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto, 401 u16 vlan_id, bool is_kill); 402 int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid, 403 u16 vlan, u8 qos, __be16 proto); 404 int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable); 405 void (*reset_event)(struct hnae3_handle *handle); 406 void (*get_channels)(struct hnae3_handle *handle, 407 struct ethtool_channels *ch); 408 void (*get_tqps_and_rss_info)(struct hnae3_handle *h, 409 u16 *free_tqps, u16 *max_rss_size); 410 int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num); 411 void (*get_flowctrl_adv)(struct hnae3_handle *handle, 412 u32 *flowctrl_adv); 413 int (*set_led_id)(struct hnae3_handle *handle, 414 enum ethtool_phys_id_state status); 415 void (*get_link_mode)(struct hnae3_handle *handle, 416 unsigned long *supported, 417 unsigned long *advertising); 418 void (*get_port_type)(struct hnae3_handle *handle, u8 *port_type); 419 }; 420 421 struct hnae3_dcb_ops { 422 /* IEEE 802.1Qaz std */ 423 int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *); 424 int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *); 425 int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *); 426 int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *); 427 428 /* DCBX configuration */ 429 u8 (*getdcbx)(struct hnae3_handle *); 430 u8 (*setdcbx)(struct hnae3_handle *, u8); 431 432 int (*map_update)(struct hnae3_handle *); 433 int (*setup_tc)(struct hnae3_handle *, u8, u8 *); 434 }; 435 436 struct hnae3_ae_algo { 437 const struct hnae3_ae_ops *ops; 438 struct list_head node; 439 char name[HNAE3_CLASS_NAME_SIZE]; 440 const struct pci_device_id *pdev_id_table; 441 }; 442 443 #define HNAE3_INT_NAME_LEN (IFNAMSIZ + 16) 444 #define HNAE3_ITR_COUNTDOWN_START 100 445 446 struct hnae3_tc_info { 447 u16 tqp_offset; /* TQP offset from base TQP */ 448 u16 tqp_count; /* Total TQPs */ 449 u8 tc; /* TC index */ 450 bool enable; /* If this TC is enable or not */ 451 }; 452 453 #define HNAE3_MAX_TC 8 454 #define HNAE3_MAX_USER_PRIO 8 455 struct hnae3_knic_private_info { 456 struct net_device *netdev; /* Set by KNIC client when init instance */ 457 u16 rss_size; /* Allocated RSS queues */ 458 u16 rx_buf_len; 459 u16 num_desc; 460 461 u8 num_tc; /* Total number of enabled TCs */ 462 u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */ 463 struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */ 464 465 u16 num_tqps; /* total number of TQPs in this handle */ 466 struct hnae3_queue **tqp; /* array base of all TQPs in this instance */ 467 const struct hnae3_dcb_ops *dcb_ops; 468 469 u16 int_rl_setting; 470 }; 471 472 struct hnae3_roce_private_info { 473 struct net_device *netdev; 474 void __iomem *roce_io_base; 475 int base_vector; 476 int num_vectors; 477 }; 478 479 struct hnae3_unic_private_info { 480 struct net_device *netdev; 481 u16 rx_buf_len; 482 u16 num_desc; 483 u16 num_tqps; /* total number of tqps in this handle */ 484 struct hnae3_queue **tqp; /* array base of all TQPs of this instance */ 485 }; 486 487 #define HNAE3_SUPPORT_MAC_LOOPBACK BIT(0) 488 #define HNAE3_SUPPORT_PHY_LOOPBACK BIT(1) 489 #define HNAE3_SUPPORT_SERDES_LOOPBACK BIT(2) 490 #define HNAE3_SUPPORT_VF BIT(3) 491 492 struct hnae3_handle { 493 struct hnae3_client *client; 494 struct pci_dev *pdev; 495 void *priv; 496 struct hnae3_ae_algo *ae_algo; /* the class who provides this handle */ 497 u64 flags; /* Indicate the capabilities for this handle*/ 498 499 unsigned long last_reset_time; 500 enum hnae3_reset_type reset_level; 501 502 union { 503 struct net_device *netdev; /* first member */ 504 struct hnae3_knic_private_info kinfo; 505 struct hnae3_unic_private_info uinfo; 506 struct hnae3_roce_private_info rinfo; 507 }; 508 509 u32 numa_node_mask; /* for multi-chip support */ 510 }; 511 512 #define hnae_set_field(origin, mask, shift, val) \ 513 do { \ 514 (origin) &= (~(mask)); \ 515 (origin) |= ((val) << (shift)) & (mask); \ 516 } while (0) 517 #define hnae_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift)) 518 519 #define hnae_set_bit(origin, shift, val) \ 520 hnae_set_field((origin), (0x1 << (shift)), (shift), (val)) 521 #define hnae_get_bit(origin, shift) \ 522 hnae_get_field((origin), (0x1 << (shift)), (shift)) 523 524 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev); 525 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev); 526 527 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo); 528 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo); 529 530 void hnae3_unregister_client(struct hnae3_client *client); 531 int hnae3_register_client(struct hnae3_client *client); 532 #endif 533