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