1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018-2019 Hisilicon Limited.
5 #ifndef _HNS3_ETHDEV_H_
6 #define _HNS3_ETHDEV_H_
12 #include "hns3_fdir.h"
15 #define PCI_VENDOR_ID_HUAWEI 0x19e5
18 #define HNS3_DEV_ID_GE 0xA220
19 #define HNS3_DEV_ID_25GE 0xA221
20 #define HNS3_DEV_ID_25GE_RDMA 0xA222
21 #define HNS3_DEV_ID_50GE_RDMA 0xA224
22 #define HNS3_DEV_ID_100G_RDMA_MACSEC 0xA226
23 #define HNS3_DEV_ID_100G_VF 0xA22E
24 #define HNS3_DEV_ID_100G_RDMA_PFC_VF 0xA22F
26 #define HNS3_UC_MACADDR_NUM 128
27 #define HNS3_VF_UC_MACADDR_NUM 48
28 #define HNS3_MC_MACADDR_NUM 128
30 #define HNS3_MAX_BD_SIZE 65535
31 #define HNS3_MAX_TX_BD_PER_PKT 8
32 #define HNS3_MAX_FRAME_LEN 9728
33 #define HNS3_MIN_FRAME_LEN 64
34 #define HNS3_VLAN_TAG_SIZE 4
35 #define HNS3_DEFAULT_RX_BUF_LEN 2048
37 #define HNS3_ETH_OVERHEAD \
38 (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + HNS3_VLAN_TAG_SIZE * 2)
39 #define HNS3_PKTLEN_TO_MTU(pktlen) ((pktlen) - HNS3_ETH_OVERHEAD)
40 #define HNS3_MAX_MTU (HNS3_MAX_FRAME_LEN - HNS3_ETH_OVERHEAD)
41 #define HNS3_DEFAULT_MTU 1500UL
42 #define HNS3_DEFAULT_FRAME_LEN (HNS3_DEFAULT_MTU + HNS3_ETH_OVERHEAD)
47 #define HNS3_MAX_PF_NUM 8
48 #define HNS3_UMV_TBL_SIZE 3072
49 #define HNS3_DEFAULT_UMV_SPACE_PER_PF \
50 (HNS3_UMV_TBL_SIZE / HNS3_MAX_PF_NUM)
52 #define HNS3_PF_CFG_BLOCK_SIZE 32
53 #define HNS3_PF_CFG_DESC_NUM \
54 (HNS3_PF_CFG_BLOCK_SIZE / HNS3_CFG_RD_LEN_BYTES)
56 #define HNS3_DEFAULT_ENABLE_PFC_NUM 0
58 #define HNS3_INTR_UNREG_FAIL_RETRY_CNT 5
59 #define HNS3_INTR_UNREG_FAIL_DELAY_MS 500
61 #define HNS3_QUIT_RESET_CNT 10
62 #define HNS3_QUIT_RESET_DELAY_MS 100
64 #define HNS3_POLL_RESPONE_MS 1
66 #define HNS3_MAX_USER_PRIO 8
76 #define HNS3_SCH_MODE_SP 0
77 #define HNS3_SCH_MODE_DWRR 1
80 uint8_t pg_sch_mode; /* 0: sp; 1: dwrr */
83 uint8_t tc_dwrr[HNS3_MAX_TC_NUM];
88 uint8_t tc_sch_mode; /* 0: sp; 1: dwrr */
91 uint8_t up_to_tc_map; /* user priority maping on the TC */
94 struct hns3_dcb_info {
96 uint8_t num_pg; /* It must be 1 if vNET-Base schd */
97 uint8_t pg_dwrr[HNS3_PG_NUM];
98 uint8_t prio_tc[HNS3_MAX_USER_PRIO];
99 struct hns3_pg_info pg_info[HNS3_PG_NUM];
100 struct hns3_tc_info tc_info[HNS3_MAX_TC_NUM];
101 uint8_t hw_pfc_map; /* Allow for packet drop or not on this TC */
102 uint8_t pfc_en; /* Pfc enabled or not for user priority */
105 enum hns3_fc_status {
107 HNS3_FC_STATUS_MAC_PAUSE,
111 struct hns3_tc_queue_info {
112 uint8_t tqp_offset; /* TQP offset from base TQP */
113 uint8_t tqp_count; /* Total TQPs */
114 uint8_t tc; /* TC index */
115 bool enable; /* If this TC is enable or not */
119 uint8_t vmdq_vport_num;
121 uint16_t tqp_desc_num;
123 uint16_t rss_size_max;
126 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
127 uint8_t default_speed;
128 uint32_t numa_node_map;
129 uint8_t speed_ability;
134 enum hns3_media_type {
135 HNS3_MEDIA_TYPE_UNKNOWN,
136 HNS3_MEDIA_TYPE_FIBER,
137 HNS3_MEDIA_TYPE_COPPER,
138 HNS3_MEDIA_TYPE_BACKPLANE,
139 HNS3_MEDIA_TYPE_NONE,
143 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
144 bool default_addr_setted; /* whether default addr(mac_addr) is setted */
147 uint8_t link_duplex : 1; /* ETH_LINK_[HALF/FULL]_DUPLEX */
148 uint8_t link_autoneg : 1; /* ETH_LINK_[AUTONEG/FIXED] */
149 uint8_t link_status : 1; /* ETH_LINK_[DOWN/UP] */
150 uint32_t link_speed; /* ETH_SPEED_NUM_ */
154 /* Primary process maintains driver state in main thread.
157 * | UNINITIALIZED |<-----------+
158 * +---------------+ |
159 * |.eth_dev_init |.eth_dev_uninit
161 * +---------------+------------+
163 * +---------------+<-----------<---------------+
164 * |.dev_configure | |
166 * +---------------+------------+ |
168 * +---------------+----+ |
170 * | | +---------------+
172 * | | +---------------+
174 * V |.dev_configure |
175 * +---------------+----+ |.dev_close
176 * | CONFIGURED |----------------------------+
177 * +---------------+<-----------+
180 * +---------------+ |
181 * | STARTING |------------^
182 * +---------------+ failed |
184 * | +---------------+
186 * | +---------------+
189 * +---------------+------------+
193 enum hns3_adapter_state {
194 HNS3_NIC_UNINITIALIZED = 0,
195 HNS3_NIC_INITIALIZED,
196 HNS3_NIC_CONFIGURING,
207 /* Reset various stages, execute in order */
208 enum hns3_reset_stage {
209 /* Stop query services, stop transceiver, disable MAC */
211 /* Clear reset completion flags, disable send command */
213 /* Inform IMP to start resetting */
214 RESET_STAGE_REQ_HW_RESET,
215 /* Waiting for hardware reset to complete */
217 /* Reinitialize hardware */
218 RESET_STAGE_DEV_INIT,
219 /* Restore user settings and enable MAC */
221 /* Restart query services, start transceiver */
223 /* Not in reset state */
227 enum hns3_reset_level {
229 HNS3_VF_FUNC_RESET, /* A VF function reset */
231 * All VFs under a PF perform function reset.
232 * Kernel PF driver use mailbox to inform DPDK VF to do reset, the value
233 * of the reset level and the one defined in kernel driver should be
236 HNS3_VF_PF_FUNC_RESET = 2,
238 * All VFs under a PF perform FLR reset.
239 * Kernel PF driver use mailbox to inform DPDK VF to do reset, the value
240 * of the reset level and the one defined in kernel driver should be
243 HNS3_VF_FULL_RESET = 3,
244 HNS3_FLR_RESET, /* A VF perform FLR reset */
245 /* All VFs under the rootport perform a global or IMP reset */
247 HNS3_FUNC_RESET, /* A PF function reset */
248 /* All PFs under the rootport perform a global reset */
250 HNS3_IMP_RESET, /* All PFs under the rootport perform a IMP reset */
254 enum hns3_wait_result {
261 #define HNS3_RESET_SYNC_US 100000
263 struct hns3_reset_stats {
264 uint64_t request_cnt; /* Total request reset times */
265 uint64_t global_cnt; /* Total GLOBAL reset times */
266 uint64_t imp_cnt; /* Total IMP reset times */
267 uint64_t exec_cnt; /* Total reset executive times */
268 uint64_t success_cnt; /* Total reset successful times */
269 uint64_t fail_cnt; /* Total reset failed times */
270 uint64_t merge_cnt; /* Total merged in high reset times */
273 typedef bool (*check_completion_func)(struct hns3_hw *hw);
275 struct hns3_wait_data {
280 enum hns3_wait_result result;
281 check_completion_func check_completion;
284 struct hns3_reset_ops {
285 void (*reset_service)(void *arg);
286 int (*stop_service)(struct hns3_adapter *hns);
287 int (*prepare_reset)(struct hns3_adapter *hns);
288 int (*wait_hardware_ready)(struct hns3_adapter *hns);
289 int (*reinit_dev)(struct hns3_adapter *hns);
290 int (*restore_conf)(struct hns3_adapter *hns);
291 int (*start_service)(struct hns3_adapter *hns);
301 struct hns3_reset_data {
302 enum hns3_reset_stage stage;
303 rte_atomic16_t schedule;
304 /* Reset flag, covering the entire reset process */
305 rte_atomic16_t resetting;
306 /* Used to disable sending cmds during reset */
307 rte_atomic16_t disable_cmd;
308 /* The reset level being processed */
309 enum hns3_reset_level level;
310 /* Reset level set, each bit represents a reset level */
312 /* Request reset level set, from interrupt or mailbox */
314 int attempts; /* Reset failure retry */
315 int retries; /* Timeout failure retry in reset_post */
317 * At the time of global or IMP reset, the command cannot be sent to
318 * stop the tx/rx queues. Tx/Rx queues may be access mbuf during the
319 * reset process, so the mbuf is required to be released after the reset
320 * is completed.The mbuf_deferred_free is used to mark whether mbuf
321 * needs to be released.
323 bool mbuf_deferred_free;
324 struct timeval start_time;
325 struct hns3_reset_stats stats;
326 const struct hns3_reset_ops *ops;
327 struct hns3_wait_data *wait_data;
331 struct rte_eth_dev_data *data;
335 unsigned int secondary_cnt; /* Number of secondary processes init'd. */
339 uint16_t total_tqps_num; /* total task queue pairs of this PF */
340 uint16_t tqps_num; /* num task queue pairs of this function */
341 uint16_t rss_size_max; /* HW defined max RSS task queue */
343 uint16_t num_tx_desc; /* desc num of per tx queue */
344 uint16_t num_rx_desc; /* desc num of per rx queue */
346 struct rte_ether_addr mc_addrs[HNS3_MC_MACADDR_NUM];
347 int mc_addrs_num; /* Multicast mac addresses number */
349 uint8_t num_tc; /* Total number of enabled TCs */
351 enum hns3_fc_mode current_mode;
352 enum hns3_fc_mode requested_mode;
353 struct hns3_dcb_info dcb_info;
354 enum hns3_fc_status current_fc_status; /* current flow control status */
355 struct hns3_tc_queue_info tc_queue[HNS3_MAX_TC_NUM];
357 uint16_t alloc_rss_size; /* Queue number per TC */
361 * PMD setup and configuration is not thread safe. Since it is not
362 * performance sensitive, it is better to guarantee thread-safety
363 * and add device level lock. Adapter control operations which
364 * change its state should acquire the lock.
367 enum hns3_adapter_state adapter_state;
368 struct hns3_reset_data reset;
371 #define HNS3_FLAG_TC_BASE_SCH_MODE 1
372 #define HNS3_FLAG_VNET_BASE_SCH_MODE 2
374 struct hns3_err_msix_intr_stats {
375 uint64_t mac_afifo_tnl_intr_cnt;
376 uint64_t ppu_mpf_abnormal_intr_st2_cnt;
377 uint64_t ssu_port_based_pf_intr_cnt;
378 uint64_t ppp_pf_abnormal_intr_cnt;
379 uint64_t ppu_pf_abnormal_intr_cnt;
382 /* vlan entry information. */
383 struct hns3_user_vlan_table {
384 LIST_ENTRY(hns3_user_vlan_table) next;
389 struct hns3_port_base_vlan_config {
394 /* Vlan tag configuration for RX direction */
395 struct hns3_rx_vtag_cfg {
396 uint8_t rx_vlan_offload_en; /* Whether enable rx vlan offload */
397 uint8_t strip_tag1_en; /* Whether strip inner vlan tag */
398 uint8_t strip_tag2_en; /* Whether strip outer vlan tag */
399 uint8_t vlan1_vlan_prionly; /* Inner VLAN Tag up to descriptor Enable */
400 uint8_t vlan2_vlan_prionly; /* Outer VLAN Tag up to descriptor Enable */
403 /* Vlan tag configuration for TX direction */
404 struct hns3_tx_vtag_cfg {
405 bool accept_tag1; /* Whether accept tag1 packet from host */
406 bool accept_untag1; /* Whether accept untag1 packet from host */
409 bool insert_tag1_en; /* Whether insert inner vlan tag */
410 bool insert_tag2_en; /* Whether insert outer vlan tag */
411 uint16_t default_tag1; /* The default inner vlan tag to insert */
412 uint16_t default_tag2; /* The default outer vlan tag to insert */
415 struct hns3_vtag_cfg {
416 struct hns3_rx_vtag_cfg rx_vcfg;
417 struct hns3_tx_vtag_cfg tx_vcfg;
420 /* Request types for IPC. */
421 enum hns3_mp_req_type {
422 HNS3_MP_REQ_START_RXTX = 1,
423 HNS3_MP_REQ_STOP_RXTX,
427 /* Pameters for IPC. */
428 struct hns3_mp_param {
429 enum hns3_mp_req_type type;
434 /* Request timeout for IPC. */
435 #define HNS3_MP_REQ_TIMEOUT_SEC 5
437 /* Key string for IPC. */
438 #define HNS3_MP_NAME "net_hns3_mp"
441 struct hns3_adapter *adapter;
444 uint32_t pkt_buf_size; /* Total pf buf size for tx/rx */
445 uint32_t tx_buf_size; /* Tx buffer size for each TC */
446 uint32_t dv_buf_size; /* Dv buffer size for each TC */
448 uint16_t mps; /* Max packet size */
451 uint8_t tc_max; /* max number of tc driver supported */
452 uint8_t local_max_tc; /* max number of local tc */
454 uint8_t prio_tc[HNS3_MAX_USER_PRIO]; /* TC indexed by prio */
456 bool support_fc_autoneg; /* support FC autonegotiate */
458 uint16_t wanted_umv_size;
459 uint16_t max_umv_size;
460 uint16_t used_umv_size;
462 /* Statistics information for abnormal interrupt */
463 struct hns3_err_msix_intr_stats abn_int_stats;
465 bool support_sfp_query;
467 struct hns3_vtag_cfg vtag_config;
468 struct hns3_port_base_vlan_config port_base_vlan_cfg;
469 LIST_HEAD(vlan_tbl, hns3_user_vlan_table) vlan_list;
471 struct hns3_fdir_info fdir; /* flow director info */
472 LIST_HEAD(counters, hns3_flow_counter) flow_counters;
476 struct hns3_adapter *adapter;
479 struct hns3_adapter {
482 /* Specific for PF or VF */
483 bool is_vf; /* false - PF, true - VF */
490 #define HNS3_DEV_SUPPORT_DCB_B 0x0
492 #define hns3_dev_dcb_supported(hw) \
493 hns3_get_bit((hw)->flag, HNS3_DEV_SUPPORT_DCB_B)
495 #define HNS3_DEV_PRIVATE_TO_HW(adapter) \
496 (&((struct hns3_adapter *)adapter)->hw)
497 #define HNS3_DEV_PRIVATE_TO_ADAPTER(adapter) \
498 ((struct hns3_adapter *)adapter)
499 #define HNS3_DEV_PRIVATE_TO_PF(adapter) \
500 (&((struct hns3_adapter *)adapter)->pf)
501 #define HNS3VF_DEV_PRIVATE_TO_VF(adapter) \
502 (&((struct hns3_adapter *)adapter)->vf)
503 #define HNS3_DEV_HW_TO_ADAPTER(hw) \
504 container_of(hw, struct hns3_adapter, hw)
506 #define hns3_set_field(origin, mask, shift, val) \
508 (origin) &= (~(mask)); \
509 (origin) |= ((val) << (shift)) & (mask); \
511 #define hns3_get_field(origin, mask, shift) \
512 (((origin) & (mask)) >> (shift))
513 #define hns3_set_bit(origin, shift, val) \
514 hns3_set_field((origin), (0x1UL << (shift)), (shift), (val))
515 #define hns3_get_bit(origin, shift) \
516 hns3_get_field((origin), (0x1UL << (shift)), (shift))
519 * upper_32_bits - return bits 32-63 of a number
520 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
521 * the "right shift count >= width of type" warning when that quantity is
524 #define upper_32_bits(n) ((uint32_t)(((n) >> 16) >> 16))
526 /* lower_32_bits - return bits 0-31 of a number */
527 #define lower_32_bits(n) ((uint32_t)(n))
529 #define BIT(nr) (1UL << (nr))
531 #define BITS_PER_LONG (__SIZEOF_LONG__ * 8)
532 #define GENMASK(h, l) \
533 (((~0UL) << (l)) & (~0UL >> (BITS_PER_LONG - 1 - (h))))
535 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
536 #define rounddown(x, y) ((x) - ((x) % (y)))
538 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
540 #define max_t(type, x, y) ({ \
543 __max1 > __max2 ? __max1 : __max2; })
545 static inline void hns3_write_reg(void *base, uint32_t reg, uint32_t value)
547 rte_write32(value, (volatile void *)((char *)base + reg));
550 static inline uint32_t hns3_read_reg(void *base, uint32_t reg)
552 return rte_read32((volatile void *)((char *)base + reg));
555 #define hns3_write_dev(a, reg, value) \
556 hns3_write_reg((a)->io_base, (reg), (value))
558 #define hns3_read_dev(a, reg) \
559 hns3_read_reg((a)->io_base, (reg))
561 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
563 #define NEXT_ITEM_OF_ACTION(act, actions, index) \
565 act = (actions) + (index); \
566 while (act->type == RTE_FLOW_ACTION_TYPE_VOID) { \
568 act = actions + index; \
572 #define MSEC_PER_SEC 1000L
573 #define USEC_PER_MSEC 1000L
575 static inline uint64_t
576 get_timeofday_ms(void)
580 (void)gettimeofday(&tv, NULL);
582 return (uint64_t)tv.tv_sec * MSEC_PER_SEC + tv.tv_usec / USEC_PER_MSEC;
585 static inline uint64_t
586 hns3_atomic_test_bit(unsigned int nr, volatile uint64_t *addr)
590 res = (__atomic_load_n(addr, __ATOMIC_RELAXED) & (1UL << nr)) != 0;
595 hns3_atomic_set_bit(unsigned int nr, volatile uint64_t *addr)
597 __atomic_fetch_or(addr, (1UL << nr), __ATOMIC_RELAXED);
601 hns3_atomic_clear_bit(unsigned int nr, volatile uint64_t *addr)
603 __atomic_fetch_and(addr, ~(1UL << nr), __ATOMIC_RELAXED);
606 static inline int64_t
607 hns3_test_and_clear_bit(unsigned int nr, volatile uint64_t *addr)
609 uint64_t mask = (1UL << nr);
611 return __atomic_fetch_and(addr, ~mask, __ATOMIC_RELAXED) & mask;
614 int hns3_buffer_alloc(struct hns3_hw *hw);
615 int hns3_config_gro(struct hns3_hw *hw, bool en);
616 int hns3_dev_filter_ctrl(struct rte_eth_dev *dev,
617 enum rte_filter_type filter_type,
618 enum rte_filter_op filter_op, void *arg);
620 #endif /* _HNS3_ETHDEV_H_ */