7438a8a2a8e4db50cc6e32022cb8351679e8ccc0
[dpdk.git] / drivers / net / hns3 / hns3_ethdev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018-2021 HiSilicon Limited.
3  */
4
5 #ifndef _HNS3_ETHDEV_H_
6 #define _HNS3_ETHDEV_H_
7
8 #include <pthread.h>
9 #include <ethdev_driver.h>
10 #include <rte_byteorder.h>
11 #include <rte_io.h>
12 #include <rte_spinlock.h>
13
14 #include "hns3_cmd.h"
15 #include "hns3_mbx.h"
16 #include "hns3_rss.h"
17 #include "hns3_fdir.h"
18 #include "hns3_stats.h"
19 #include "hns3_tm.h"
20
21 /* Vendor ID */
22 #define PCI_VENDOR_ID_HUAWEI                    0x19e5
23
24 /* Device IDs */
25 #define HNS3_DEV_ID_GE                          0xA220
26 #define HNS3_DEV_ID_25GE                        0xA221
27 #define HNS3_DEV_ID_25GE_RDMA                   0xA222
28 #define HNS3_DEV_ID_50GE_RDMA                   0xA224
29 #define HNS3_DEV_ID_100G_RDMA_MACSEC            0xA226
30 #define HNS3_DEV_ID_200G_RDMA                   0xA228
31 #define HNS3_DEV_ID_100G_VF                     0xA22E
32 #define HNS3_DEV_ID_100G_RDMA_PFC_VF            0xA22F
33
34 /* PCI Config offsets */
35 #define HNS3_PCI_REVISION_ID                    0x08
36 #define HNS3_PCI_REVISION_ID_LEN                1
37
38 #define PCI_REVISION_ID_HIP08_B                 0x21
39 #define PCI_REVISION_ID_HIP09_A                 0x30
40
41 #define HNS3_PF_FUNC_ID                 0
42 #define HNS3_1ST_VF_FUNC_ID             1
43
44 #define HNS3_DEFAULT_PORT_CONF_BURST_SIZE       32
45 #define HNS3_DEFAULT_PORT_CONF_QUEUES_NUM       1
46
47 #define HNS3_SW_SHIFT_AND_DISCARD_MODE          0
48 #define HNS3_HW_SHIFT_AND_DISCARD_MODE          1
49
50 #define HNS3_UNLIMIT_PROMISC_MODE       0
51 #define HNS3_LIMIT_PROMISC_MODE         1
52
53 #define HNS3_SPECIAL_PORT_SW_CKSUM_MODE         0
54 #define HNS3_SPECIAL_PORT_HW_CKSUM_MODE         1
55
56 #define HNS3_UC_MACADDR_NUM             128
57 #define HNS3_VF_UC_MACADDR_NUM          48
58 #define HNS3_MC_MACADDR_NUM             128
59
60 #define HNS3_MAX_BD_SIZE                65535
61 #define HNS3_MAX_NON_TSO_BD_PER_PKT     8
62 #define HNS3_MAX_TSO_BD_PER_PKT         63
63 #define HNS3_MAX_FRAME_LEN              9728
64 #define HNS3_VLAN_TAG_SIZE              4
65 #define HNS3_DEFAULT_RX_BUF_LEN         2048
66 #define HNS3_MAX_BD_PAYLEN              (1024 * 1024 - 1)
67 #define HNS3_MAX_TSO_HDR_SIZE           512
68 #define HNS3_MAX_TSO_HDR_BD_NUM         3
69 #define HNS3_MAX_LRO_SIZE               64512
70
71 #define HNS3_ETH_OVERHEAD \
72         (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + HNS3_VLAN_TAG_SIZE * 2)
73 #define HNS3_PKTLEN_TO_MTU(pktlen)      ((pktlen) - HNS3_ETH_OVERHEAD)
74 #define HNS3_MAX_MTU    (HNS3_MAX_FRAME_LEN - HNS3_ETH_OVERHEAD)
75 #define HNS3_DEFAULT_MTU                1500UL
76 #define HNS3_DEFAULT_FRAME_LEN          (HNS3_DEFAULT_MTU + HNS3_ETH_OVERHEAD)
77 #define HNS3_HIP08_MIN_TX_PKT_LEN       33
78 #define HNS3_HIP09_MIN_TX_PKT_LEN       9
79
80 #define HNS3_BITS_PER_BYTE      8
81
82 #define HNS3_4_TCS                      4
83 #define HNS3_8_TCS                      8
84
85 #define HNS3_MAX_PF_NUM                 8
86 #define HNS3_UMV_TBL_SIZE               3072
87 #define HNS3_DEFAULT_UMV_SPACE_PER_PF \
88         (HNS3_UMV_TBL_SIZE / HNS3_MAX_PF_NUM)
89
90 #define HNS3_PF_CFG_BLOCK_SIZE          32
91 #define HNS3_PF_CFG_DESC_NUM \
92         (HNS3_PF_CFG_BLOCK_SIZE / HNS3_CFG_RD_LEN_BYTES)
93
94 #define HNS3_DEFAULT_ENABLE_PFC_NUM     0
95
96 #define HNS3_INTR_UNREG_FAIL_RETRY_CNT  5
97 #define HNS3_INTR_UNREG_FAIL_DELAY_MS   500
98
99 #define HNS3_QUIT_RESET_CNT             10
100 #define HNS3_QUIT_RESET_DELAY_MS        100
101
102 #define HNS3_POLL_RESPONE_MS            1
103
104 #define HNS3_MAX_USER_PRIO              8
105 #define HNS3_PG_NUM                     4
106 enum hns3_fc_mode {
107         HNS3_FC_NONE,
108         HNS3_FC_RX_PAUSE,
109         HNS3_FC_TX_PAUSE,
110         HNS3_FC_FULL,
111         HNS3_FC_DEFAULT
112 };
113
114 #define HNS3_SCH_MODE_SP        0
115 #define HNS3_SCH_MODE_DWRR      1
116 struct hns3_pg_info {
117         uint8_t pg_id;
118         uint8_t pg_sch_mode;  /* 0: sp; 1: dwrr */
119         uint8_t tc_bit_map;
120         uint32_t bw_limit;
121         uint8_t tc_dwrr[HNS3_MAX_TC_NUM];
122 };
123
124 struct hns3_tc_info {
125         uint8_t tc_id;
126         uint8_t tc_sch_mode;  /* 0: sp; 1: dwrr */
127         uint8_t pgid;
128         uint32_t bw_limit;
129         uint8_t up_to_tc_map; /* user priority maping on the TC */
130 };
131
132 struct hns3_dcb_info {
133         uint8_t num_tc;
134         uint8_t num_pg;     /* It must be 1 if vNET-Base schd */
135         uint8_t pg_dwrr[HNS3_PG_NUM];
136         uint8_t prio_tc[HNS3_MAX_USER_PRIO];
137         struct hns3_pg_info pg_info[HNS3_PG_NUM];
138         struct hns3_tc_info tc_info[HNS3_MAX_TC_NUM];
139         uint8_t hw_pfc_map; /* Allow for packet drop or not on this TC */
140         uint8_t pfc_en; /* Pfc enabled or not for user priority */
141 };
142
143 enum hns3_fc_status {
144         HNS3_FC_STATUS_NONE,
145         HNS3_FC_STATUS_MAC_PAUSE,
146         HNS3_FC_STATUS_PFC,
147 };
148
149 struct hns3_tc_queue_info {
150         uint16_t tqp_offset;    /* TQP offset from base TQP */
151         uint16_t tqp_count;     /* Total TQPs */
152         uint8_t tc;             /* TC index */
153         bool enable;            /* If this TC is enable or not */
154 };
155
156 struct hns3_cfg {
157         uint8_t tc_num;
158         uint16_t tqp_desc_num;
159         uint16_t rx_buf_len;
160         uint16_t rss_size_max;
161         uint8_t phy_addr;
162         uint8_t media_type;
163         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
164         uint8_t default_speed;
165         uint32_t numa_node_map;
166         uint8_t speed_ability;
167         uint16_t umv_space;
168 };
169
170 struct hns3_set_link_speed_cfg {
171         uint32_t speed;
172         uint8_t duplex  : 1;
173         uint8_t autoneg : 1;
174 };
175
176 /* mac media type */
177 enum hns3_media_type {
178         HNS3_MEDIA_TYPE_UNKNOWN,
179         HNS3_MEDIA_TYPE_FIBER,
180         HNS3_MEDIA_TYPE_COPPER,
181         HNS3_MEDIA_TYPE_BACKPLANE,
182         HNS3_MEDIA_TYPE_NONE,
183 };
184
185 #define HNS3_DEFAULT_QUERY              0
186 #define HNS3_ACTIVE_QUERY               1
187
188 struct hns3_mac {
189         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
190         uint8_t media_type;
191         uint8_t phy_addr;
192         uint8_t link_duplex  : 1; /* RTE_ETH_LINK_[HALF/FULL]_DUPLEX */
193         uint8_t link_autoneg : 1; /* RTE_ETH_LINK_[AUTONEG/FIXED] */
194         uint8_t link_status  : 1; /* RTE_ETH_LINK_[DOWN/UP] */
195         uint32_t link_speed;      /* RTE_ETH_SPEED_NUM_ */
196         /*
197          * Some firmware versions support only the SFP speed query. In addition
198          * to the SFP speed query, some firmware supports the query of the speed
199          * capability, auto-negotiation capability, and FEC mode, which can be
200          * selected by the 'query_type' filed in the HNS3_OPC_GET_SFP_INFO CMD.
201          * This field is used to record the SFP information query mode.
202          * Value range:
203          *       HNS3_DEFAULT_QUERY/HNS3_ACTIVE_QUERY
204          *
205          * - HNS3_DEFAULT_QUERY
206          * Speed obtained is from SFP. When the queried speed changes, the MAC
207          * speed needs to be reconfigured.
208          *
209          * - HNS3_ACTIVE_QUERY
210          * Speed obtained is from MAC. At this time, it is unnecessary for
211          * driver to reconfigured the MAC speed. In addition, more information,
212          * such as, the speed capability, auto-negotiation capability and FEC
213          * mode, can be obtained by the HNS3_OPC_GET_SFP_INFO CMD.
214          */
215         uint8_t query_type;
216         uint32_t supported_speed;  /* supported speed for current media type */
217         uint32_t advertising;     /* advertised capability in the local part */
218         uint32_t lp_advertising; /* advertised capability in the link partner */
219         uint8_t support_autoneg;
220 };
221
222 struct hns3_fake_queue_data {
223         void **rx_queues; /* Array of pointers to fake RX queues. */
224         void **tx_queues; /* Array of pointers to fake TX queues. */
225         uint16_t nb_fake_rx_queues; /* Number of fake RX queues. */
226         uint16_t nb_fake_tx_queues; /* Number of fake TX queues. */
227 };
228
229 #define HNS3_PORT_BASE_VLAN_DISABLE     0
230 #define HNS3_PORT_BASE_VLAN_ENABLE      1
231 struct hns3_port_base_vlan_config {
232         uint16_t state;
233         uint16_t pvid;
234 };
235
236 /* Primary process maintains driver state in main thread.
237  *
238  * +---------------+
239  * | UNINITIALIZED |<-----------+
240  * +---------------+            |
241  *      |.eth_dev_init          |.eth_dev_uninit
242  *      V                       |
243  * +---------------+------------+
244  * |  INITIALIZED  |
245  * +---------------+<-----------<---------------+
246  *      |.dev_configure         |               |
247  *      V                       |failed         |
248  * +---------------+------------+               |
249  * |  CONFIGURING  |                            |
250  * +---------------+----+                       |
251  *      |success        |                       |
252  *      |               |               +---------------+
253  *      |               |               |    CLOSING    |
254  *      |               |               +---------------+
255  *      |               |                       ^
256  *      V               |.dev_configure         |
257  * +---------------+----+                       |.dev_close
258  * |  CONFIGURED   |----------------------------+
259  * +---------------+<-----------+
260  *      |.dev_start             |
261  *      V                       |
262  * +---------------+            |
263  * |   STARTING    |------------^
264  * +---------------+ failed     |
265  *      |success                |
266  *      |               +---------------+
267  *      |               |   STOPPING    |
268  *      |               +---------------+
269  *      |                       ^
270  *      V                       |.dev_stop
271  * +---------------+------------+
272  * |    STARTED    |
273  * +---------------+
274  */
275 enum hns3_adapter_state {
276         HNS3_NIC_UNINITIALIZED = 0,
277         HNS3_NIC_INITIALIZED,
278         HNS3_NIC_CONFIGURING,
279         HNS3_NIC_CONFIGURED,
280         HNS3_NIC_STARTING,
281         HNS3_NIC_STARTED,
282         HNS3_NIC_STOPPING,
283         HNS3_NIC_CLOSING,
284         HNS3_NIC_CLOSED,
285         HNS3_NIC_REMOVED,
286         HNS3_NIC_NSTATES
287 };
288
289 /* Reset various stages, execute in order */
290 enum hns3_reset_stage {
291         /* Stop query services, stop transceiver, disable MAC */
292         RESET_STAGE_DOWN,
293         /* Clear reset completion flags, disable send command */
294         RESET_STAGE_PREWAIT,
295         /* Inform IMP to start resetting */
296         RESET_STAGE_REQ_HW_RESET,
297         /* Waiting for hardware reset to complete */
298         RESET_STAGE_WAIT,
299         /* Reinitialize hardware */
300         RESET_STAGE_DEV_INIT,
301         /* Restore user settings and enable MAC */
302         RESET_STAGE_RESTORE,
303         /* Restart query services, start transceiver */
304         RESET_STAGE_DONE,
305         /* Not in reset state */
306         RESET_STAGE_NONE,
307 };
308
309 enum hns3_reset_level {
310         HNS3_FLR_RESET,     /* A VF perform FLR reset */
311         HNS3_VF_FUNC_RESET, /* A VF function reset */
312
313         /*
314          * All VFs under a PF perform function reset.
315          * Kernel PF driver use mailbox to inform DPDK VF to do reset, the value
316          * of the reset level and the one defined in kernel driver should be
317          * same.
318          */
319         HNS3_VF_PF_FUNC_RESET = 2,
320
321         /*
322          * All VFs under a PF perform FLR reset.
323          * Kernel PF driver use mailbox to inform DPDK VF to do reset, the value
324          * of the reset level and the one defined in kernel driver should be
325          * same.
326          *
327          * According to the protocol of PCIe, FLR to a PF resets the PF state as
328          * well as the SR-IOV extended capability including VF Enable which
329          * means that VFs no longer exist.
330          *
331          * In PF FLR, the register state of VF is not reliable, VF's driver
332          * should not access the registers of the VF device.
333          */
334         HNS3_VF_FULL_RESET,
335
336         /* All VFs under the rootport perform a global or IMP reset */
337         HNS3_VF_RESET,
338
339         /*
340          * The enumeration value of HNS3_FUNC_RESET/HNS3_GLOBAL_RESET/
341          * HNS3_IMP_RESET/HNS3_NONE_RESET are also used by firmware, and
342          * can not be changed.
343          */
344
345         HNS3_FUNC_RESET = 5,    /* A PF function reset */
346
347         /* All PFs under the rootport perform a global reset */
348         HNS3_GLOBAL_RESET,
349         HNS3_IMP_RESET,     /* All PFs under the rootport perform a IMP reset */
350         HNS3_NONE_RESET,
351         HNS3_MAX_RESET
352 };
353
354 enum hns3_wait_result {
355         HNS3_WAIT_UNKNOWN,
356         HNS3_WAIT_REQUEST,
357         HNS3_WAIT_SUCCESS,
358         HNS3_WAIT_TIMEOUT
359 };
360
361 #define HNS3_RESET_SYNC_US 100000
362
363 struct hns3_reset_stats {
364         uint64_t request_cnt; /* Total request reset times */
365         uint64_t global_cnt;  /* Total GLOBAL reset times */
366         uint64_t imp_cnt;     /* Total IMP reset times */
367         uint64_t exec_cnt;    /* Total reset executive times */
368         uint64_t success_cnt; /* Total reset successful times */
369         uint64_t fail_cnt;    /* Total reset failed times */
370         uint64_t merge_cnt;   /* Total merged in high reset times */
371 };
372
373 typedef bool (*check_completion_func)(struct hns3_hw *hw);
374
375 struct hns3_wait_data {
376         void *hns;
377         uint64_t end_ms;
378         uint64_t interval;
379         int16_t count;
380         enum hns3_wait_result result;
381         check_completion_func check_completion;
382 };
383
384 struct hns3_reset_ops {
385         void (*reset_service)(void *arg);
386         int (*stop_service)(struct hns3_adapter *hns);
387         int (*prepare_reset)(struct hns3_adapter *hns);
388         int (*wait_hardware_ready)(struct hns3_adapter *hns);
389         int (*reinit_dev)(struct hns3_adapter *hns);
390         int (*restore_conf)(struct hns3_adapter *hns);
391         int (*start_service)(struct hns3_adapter *hns);
392 };
393
394 enum hns3_schedule {
395         SCHEDULE_NONE,
396         SCHEDULE_PENDING,
397         SCHEDULE_REQUESTED,
398         SCHEDULE_DEFERRED,
399 };
400
401 struct hns3_reset_data {
402         enum hns3_reset_stage stage;
403         uint16_t schedule;
404         /* Reset flag, covering the entire reset process */
405         uint16_t resetting;
406         /* Used to disable sending cmds during reset */
407         uint16_t disable_cmd;
408         /* The reset level being processed */
409         enum hns3_reset_level level;
410         /* Reset level set, each bit represents a reset level */
411         uint64_t pending;
412         /* Request reset level set, from interrupt or mailbox */
413         uint64_t request;
414         int attempts; /* Reset failure retry */
415         int retries;  /* Timeout failure retry in reset_post */
416         /*
417          * At the time of global or IMP reset, the command cannot be sent to
418          * stop the tx/rx queues. Tx/Rx queues may be access mbuf during the
419          * reset process, so the mbuf is required to be released after the reset
420          * is completed.The mbuf_deferred_free is used to mark whether mbuf
421          * needs to be released.
422          */
423         bool mbuf_deferred_free;
424         struct timeval start_time;
425         struct hns3_reset_stats stats;
426         const struct hns3_reset_ops *ops;
427         struct hns3_wait_data *wait_data;
428 };
429
430 struct hns3_hw_ops {
431         int (*add_mc_mac_addr)(struct hns3_hw *hw,
432                                 struct rte_ether_addr *mac_addr);
433         int (*del_mc_mac_addr)(struct hns3_hw *hw,
434                                 struct rte_ether_addr *mac_addr);
435         int (*add_uc_mac_addr)(struct hns3_hw *hw,
436                                 struct rte_ether_addr *mac_addr);
437         int (*del_uc_mac_addr)(struct hns3_hw *hw,
438                                 struct rte_ether_addr *mac_addr);
439 };
440
441 #define HNS3_INTR_MAPPING_VEC_RSV_ONE           0
442 #define HNS3_INTR_MAPPING_VEC_ALL               1
443
444 #define HNS3_INTR_COALESCE_GL_UINT_2US          0
445 #define HNS3_INTR_COALESCE_GL_UINT_1US          1
446
447 #define HNS3_INTR_QL_NONE                       0
448
449 struct hns3_queue_intr {
450         /*
451          * interrupt mapping mode.
452          * value range:
453          *      HNS3_INTR_MAPPING_VEC_RSV_ONE/HNS3_INTR_MAPPING_VEC_ALL
454          *
455          *  - HNS3_INTR_MAPPING_VEC_RSV_ONE
456          *     For some versions of hardware network engine, because of the
457          *     hardware constraint, we need implement clearing the mapping
458          *     relationship configurations by binding all queues to the last
459          *     interrupt vector and reserving the last interrupt vector. This
460          *     method results in a decrease of the maximum queues when upper
461          *     applications call the rte_eth_dev_configure API function to
462          *     enable Rx interrupt.
463          *
464          *  - HNS3_INTR_MAPPING_VEC_ALL
465          *     PMD driver can map/unmmap all interrupt vectors with queues When
466          *     Rx interrupt in enabled.
467          */
468         uint8_t mapping_mode;
469         /*
470          * The unit of GL(gap limiter) configuration for interrupt coalesce of
471          * queue's interrupt.
472          * value range:
473          *      HNS3_INTR_COALESCE_GL_UINT_2US/HNS3_INTR_COALESCE_GL_UINT_1US
474          */
475         uint8_t gl_unit;
476         /* The max QL(quantity limiter) value */
477         uint16_t int_ql_max;
478 };
479
480 #define HNS3_TSO_SW_CAL_PSEUDO_H_CSUM           0
481 #define HNS3_TSO_HW_CAL_PSEUDO_H_CSUM           1
482
483 #define HNS3_PKTS_DROP_STATS_MODE1              0
484 #define HNS3_PKTS_DROP_STATS_MODE2              1
485
486 struct hns3_hw {
487         struct rte_eth_dev_data *data;
488         void *io_base;
489         uint8_t revision;           /* PCI revision, low byte of class word */
490         struct hns3_cmq cmq;
491         struct hns3_mbx_resp_status mbx_resp; /* mailbox response */
492         struct hns3_mac mac;
493         /*
494          * This flag indicates dev_set_link_down() API is called, and is cleared
495          * by dev_set_link_up() or dev_start().
496          */
497         bool set_link_down;
498         unsigned int secondary_cnt; /* Number of secondary processes init'd. */
499         struct hns3_tqp_stats tqp_stats;
500         /* Include Mac stats | Rx stats | Tx stats */
501         struct hns3_mac_stats mac_stats;
502         struct hns3_rx_missed_stats imissed_stats;
503         uint64_t oerror_stats;
504         uint32_t fw_version;
505         uint16_t pf_vf_if_version;  /* version of communication interface */
506
507         uint16_t num_msi;
508         uint16_t total_tqps_num;    /* total task queue pairs of this PF */
509         uint16_t tqps_num;          /* num task queue pairs of this function */
510         uint16_t intr_tqps_num;     /* num queue pairs mapping interrupt */
511         uint16_t rss_size_max;      /* HW defined max RSS task queue */
512         uint16_t rx_buf_len;        /* hold min hardware rx buf len */
513         uint16_t num_tx_desc;       /* desc num of per tx queue */
514         uint16_t num_rx_desc;       /* desc num of per rx queue */
515         uint32_t mng_entry_num;     /* number of manager table entry */
516         uint32_t mac_entry_num;     /* number of mac-vlan table entry */
517
518         struct rte_ether_addr mc_addrs[HNS3_MC_MACADDR_NUM];
519         int mc_addrs_num; /* Multicast mac addresses number */
520
521         /* The configuration info of RSS */
522         struct hns3_rss_conf rss_info;
523         bool rss_dis_flag; /* disable rss flag. true: disable, false: enable */
524         uint16_t rss_ind_tbl_size;
525         uint16_t rss_key_size;
526
527         uint8_t num_tc;             /* Total number of enabled TCs */
528         uint8_t hw_tc_map;
529         enum hns3_fc_mode requested_fc_mode; /* FC mode requested by user */
530         struct hns3_dcb_info dcb_info;
531         enum hns3_fc_status current_fc_status; /* current flow control status */
532         struct hns3_tc_queue_info tc_queue[HNS3_MAX_TC_NUM];
533         uint16_t used_rx_queues;
534         uint16_t used_tx_queues;
535
536         /* Config max queue numbers between rx and tx queues from user */
537         uint16_t cfg_max_queues;
538         struct hns3_fake_queue_data fkq_data;     /* fake queue data */
539         uint16_t alloc_rss_size;    /* RX queue number per TC */
540         uint16_t tx_qnum_per_tc;    /* TX queue number per TC */
541
542         uint32_t capability;
543         uint32_t max_tm_rate;
544         /*
545          * The minimum length of the packet supported by hardware in the Tx
546          * direction.
547          */
548         uint32_t min_tx_pkt_len;
549
550         struct hns3_queue_intr intr;
551         /*
552          * tso mode.
553          * value range:
554          *      HNS3_TSO_SW_CAL_PSEUDO_H_CSUM/HNS3_TSO_HW_CAL_PSEUDO_H_CSUM
555          *
556          *  - HNS3_TSO_SW_CAL_PSEUDO_H_CSUM
557          *     In this mode, because of the hardware constraint, network driver
558          *     software need erase the L4 len value of the TCP pseudo header
559          *     and recalculate the TCP pseudo header checksum of packets that
560          *     need TSO.
561          *
562          *  - HNS3_TSO_HW_CAL_PSEUDO_H_CSUM
563          *     In this mode, hardware support recalculate the TCP pseudo header
564          *     checksum of packets that need TSO, so network driver software
565          *     not need to recalculate it.
566          */
567         uint8_t tso_mode;
568         /*
569          * vlan mode.
570          * value range:
571          *      HNS3_SW_SHIFT_AND_DISCARD_MODE/HNS3_HW_SHFIT_AND_DISCARD_MODE
572          *
573          *  - HNS3_SW_SHIFT_AND_DISCARD_MODE
574          *     For some versions of hardware network engine, because of the
575          *     hardware limitation, PMD driver needs to detect the PVID status
576          *     to work with haredware to implement PVID-related functions.
577          *     For example, driver need discard the stripped PVID tag to ensure
578          *     the PVID will not report to mbuf and shift the inserted VLAN tag
579          *     to avoid port based VLAN covering it.
580          *
581          *  - HNS3_HW_SHIT_AND_DISCARD_MODE
582          *     PMD driver does not need to process PVID-related functions in
583          *     I/O process, Hardware will adjust the sequence between port based
584          *     VLAN tag and BD VLAN tag automatically and VLAN tag stripped by
585          *     PVID will be invisible to driver. And in this mode, hns3 is able
586          *     to send a multi-layer VLAN packets when hw VLAN insert offload
587          *     is enabled.
588          */
589         uint8_t vlan_mode;
590         /*
591          * promisc mode.
592          * value range:
593          *      HNS3_UNLIMIT_PROMISC_MODE/HNS3_LIMIT_PROMISC_MODE
594          *
595          *  - HNS3_UNLIMIT_PROMISC_MODE
596          *     In this mode, TX unicast promisc will be configured when promisc
597          *     is set, driver can receive all the ingress and outgoing traffic.
598          *     In the words, all the ingress packets, all the packets sent from
599          *     the PF and other VFs on the same physical port.
600          *
601          *  - HNS3_LIMIT_PROMISC_MODE
602          *     In this mode, TX unicast promisc is shutdown when promisc mode
603          *     is set. So, driver will only receive all the ingress traffic.
604          *     The packets sent from the PF and other VFs on the same physical
605          *     port won't be copied to the function which has set promisc mode.
606          */
607         uint8_t promisc_mode;
608
609         /*
610          * drop_stats_mode mode.
611          * value range:
612          *      HNS3_PKTS_DROP_STATS_MODE1/HNS3_PKTS_DROP_STATS_MODE2
613          *
614          *  - HNS3_PKTS_DROP_STATS_MODE1
615          *     This mode for kunpeng920. In this mode, port level imissed stats
616          *     is supported. It only includes RPU drop stats.
617          *
618          *  - HNS3_PKTS_DROP_STATS_MODE2
619          *     This mode for kunpeng930. In this mode, imissed stats and oerrors
620          *     stats is supported. Function level imissed stats is supported. It
621          *     includes RPU drop stats in VF, and includes both RPU drop stats
622          *     and SSU drop stats in PF. Oerror stats is also supported in PF.
623          */
624         uint8_t drop_stats_mode;
625
626         uint8_t max_non_tso_bd_num; /* max BD number of one non-TSO packet */
627         /*
628          * udp checksum mode.
629          * value range:
630          *      HNS3_SPECIAL_PORT_HW_CKSUM_MODE/HNS3_SPECIAL_PORT_SW_CKSUM_MODE
631          *
632          *  - HNS3_SPECIAL_PORT_SW_CKSUM_MODE
633          *     In this mode, HW can not do checksum for special UDP port like
634          *     4789, 4790, 6081 for non-tunnel UDP packets and UDP tunnel
635          *     packets without the RTE_MBUF_F_TX_TUNEL_MASK in the mbuf. So, PMD need
636          *     do the checksum for these packets to avoid a checksum error.
637          *
638          *  - HNS3_SPECIAL_PORT_HW_CKSUM_MODE
639          *     In this mode, HW does not have the preceding problems and can
640          *     directly calculate the checksum of these UDP packets.
641          */
642         uint8_t udp_cksum_mode;
643
644         struct hns3_port_base_vlan_config port_base_vlan_cfg;
645
646         pthread_mutex_t flows_lock; /* rte_flow ops lock */
647         struct hns3_fdir_rule_list flow_fdir_list; /* flow fdir rule list */
648         struct hns3_rss_filter_list flow_rss_list; /* flow RSS rule list */
649         struct hns3_flow_mem_list flow_list;
650
651         struct hns3_hw_ops ops;
652
653         /*
654          * PMD setup and configuration is not thread safe. Since it is not
655          * performance sensitive, it is better to guarantee thread-safety
656          * and add device level lock. Adapter control operations which
657          * change its state should acquire the lock.
658          */
659         rte_spinlock_t lock;
660         enum hns3_adapter_state adapter_state;
661         struct hns3_reset_data reset;
662 };
663
664 #define HNS3_FLAG_TC_BASE_SCH_MODE              1
665 #define HNS3_FLAG_VNET_BASE_SCH_MODE            2
666
667 /* vlan entry information. */
668 struct hns3_user_vlan_table {
669         LIST_ENTRY(hns3_user_vlan_table) next;
670         bool hd_tbl_status;
671         uint16_t vlan_id;
672 };
673
674 /* Vlan tag configuration for RX direction */
675 struct hns3_rx_vtag_cfg {
676         bool rx_vlan_offload_en;    /* Whether enable rx vlan offload */
677         bool strip_tag1_en;         /* Whether strip inner vlan tag */
678         bool strip_tag2_en;         /* Whether strip outer vlan tag */
679         /*
680          * If strip_tag_en is enabled, this bit decide whether to map the vlan
681          * tag to descriptor.
682          */
683         bool strip_tag1_discard_en;
684         bool strip_tag2_discard_en;
685         /*
686          * If this bit is enabled, only map inner/outer priority to descriptor
687          * and the vlan tag is always 0.
688          */
689         bool vlan1_vlan_prionly;
690         bool vlan2_vlan_prionly;
691 };
692
693 /* Vlan tag configuration for TX direction */
694 struct hns3_tx_vtag_cfg {
695         bool accept_tag1;           /* Whether accept tag1 packet from host */
696         bool accept_untag1;         /* Whether accept untag1 packet from host */
697         bool accept_tag2;
698         bool accept_untag2;
699         bool insert_tag1_en;        /* Whether insert outer vlan tag */
700         bool insert_tag2_en;        /* Whether insert inner vlan tag */
701         /*
702          * In shift mode, hw will shift the sequence of port based VLAN and
703          * BD VLAN.
704          */
705         bool tag_shift_mode_en;     /* hw shift vlan tag automatically */
706         uint16_t default_tag1;      /* The default outer vlan tag to insert */
707         uint16_t default_tag2;      /* The default inner vlan tag to insert */
708 };
709
710 struct hns3_vtag_cfg {
711         struct hns3_rx_vtag_cfg rx_vcfg;
712         struct hns3_tx_vtag_cfg tx_vcfg;
713 };
714
715 /* Request types for IPC. */
716 enum hns3_mp_req_type {
717         HNS3_MP_REQ_START_RXTX = 1,
718         HNS3_MP_REQ_STOP_RXTX,
719         HNS3_MP_REQ_START_TX,
720         HNS3_MP_REQ_STOP_TX,
721         HNS3_MP_REQ_MAX
722 };
723
724 /* Pameters for IPC. */
725 struct hns3_mp_param {
726         enum hns3_mp_req_type type;
727         int port_id;
728         int result;
729 };
730
731 /* Request timeout for IPC. */
732 #define HNS3_MP_REQ_TIMEOUT_SEC 5
733
734 /* Key string for IPC. */
735 #define HNS3_MP_NAME "net_hns3_mp"
736
737 #define HNS3_L2TBL_NUM  4
738 #define HNS3_L3TBL_NUM  16
739 #define HNS3_L4TBL_NUM  16
740 #define HNS3_OL2TBL_NUM 4
741 #define HNS3_OL3TBL_NUM 16
742 #define HNS3_OL4TBL_NUM 16
743 #define HNS3_PTYPE_NUM  256
744
745 struct hns3_ptype_table {
746         /*
747          * The next fields used to calc packet-type by the
748          * L3_ID/L4_ID/OL3_ID/OL4_ID from the Rx descriptor.
749          */
750         uint32_t l3table[HNS3_L3TBL_NUM];
751         uint32_t l4table[HNS3_L4TBL_NUM];
752         uint32_t inner_l3table[HNS3_L3TBL_NUM];
753         uint32_t inner_l4table[HNS3_L4TBL_NUM];
754         uint32_t ol3table[HNS3_OL3TBL_NUM];
755         uint32_t ol4table[HNS3_OL4TBL_NUM];
756
757         /*
758          * The next field used to calc packet-type by the PTYPE from the Rx
759          * descriptor, it functions only when firmware report the capability of
760          * HNS3_CAPS_RXD_ADV_LAYOUT_B and driver enabled it.
761          */
762         uint32_t ptype[HNS3_PTYPE_NUM] __rte_cache_aligned;
763 };
764
765 #define HNS3_FIXED_MAX_TQP_NUM_MODE             0
766 #define HNS3_FLEX_MAX_TQP_NUM_MODE              1
767
768 struct hns3_pf {
769         struct hns3_adapter *adapter;
770         bool is_main_pf;
771         uint16_t func_num; /* num functions of this pf, include pf and vfs */
772
773         /*
774          * tqp_config mode
775          * tqp_config_mode value range:
776          *      HNS3_FIXED_MAX_TQP_NUM_MODE,
777          *      HNS3_FLEX_MAX_TQP_NUM_MODE
778          *
779          * - HNS3_FIXED_MAX_TQP_NUM_MODE
780          *   There is a limitation on the number of pf interrupts available for
781          *   on some versions of network engines. In this case, the maximum
782          *   queue number of pf can not be greater than the interrupt number,
783          *   such as pf of network engine with revision_id 0x21. So the maximum
784          *   number of queues must be fixed.
785          *
786          * - HNS3_FLEX_MAX_TQP_NUM_MODE
787          *   In this mode, the maximum queue number of pf has not any constraint
788          *   and comes from the macro RTE_LIBRTE_HNS3_MAX_TQP_NUM_PER_PF
789          *   in the config file. Users can modify the macro according to their
790          *   own application scenarios, which is more flexible to use.
791          */
792         uint8_t tqp_config_mode;
793
794         uint32_t pkt_buf_size; /* Total pf buf size for tx/rx */
795         uint32_t tx_buf_size; /* Tx buffer size for each TC */
796         uint32_t dv_buf_size; /* Dv buffer size for each TC */
797
798         uint16_t mps; /* Max packet size */
799
800         uint8_t tx_sch_mode;
801         uint8_t tc_max; /* max number of tc driver supported */
802         uint8_t local_max_tc; /* max number of local tc */
803         uint8_t pfc_max;
804         uint8_t prio_tc[HNS3_MAX_USER_PRIO]; /* TC indexed by prio */
805         uint16_t pause_time;
806         bool support_fc_autoneg;       /* support FC autonegotiate */
807         bool support_multi_tc_pause;
808
809         uint16_t wanted_umv_size;
810         uint16_t max_umv_size;
811         uint16_t used_umv_size;
812
813         bool support_sfp_query;
814         uint32_t fec_mode; /* current FEC mode for ethdev */
815
816         bool ptp_enable;
817
818         /* Stores timestamp of last received packet on dev */
819         uint64_t rx_timestamp;
820
821         struct hns3_vtag_cfg vtag_config;
822         LIST_HEAD(vlan_tbl, hns3_user_vlan_table) vlan_list;
823
824         struct hns3_fdir_info fdir; /* flow director info */
825         LIST_HEAD(counters, hns3_flow_counter) flow_counters;
826
827         struct hns3_tm_conf tm_conf;
828 };
829
830 enum {
831         HNS3_PF_PUSH_LSC_CAP_NOT_SUPPORTED,
832         HNS3_PF_PUSH_LSC_CAP_SUPPORTED,
833         HNS3_PF_PUSH_LSC_CAP_UNKNOWN
834 };
835
836 struct hns3_vf {
837         struct hns3_adapter *adapter;
838
839         /* Whether PF support push link status change to VF */
840         uint16_t pf_push_lsc_cap;
841
842         /*
843          * If PF support push link status change, VF still need send request to
844          * get link status in some cases (such as reset recover stage), so use
845          * the req_link_info_cnt to control max request count.
846          */
847         uint16_t req_link_info_cnt;
848
849         uint16_t poll_job_started; /* whether poll job is started */
850 };
851
852 struct hns3_adapter {
853         struct hns3_hw hw;
854
855         /* Specific for PF or VF */
856         bool is_vf; /* false - PF, true - VF */
857         union {
858                 struct hns3_pf pf;
859                 struct hns3_vf vf;
860         };
861
862         uint32_t rx_func_hint;
863         uint32_t tx_func_hint;
864
865         uint64_t dev_caps_mask;
866         uint16_t mbx_time_limit_ms; /* wait time for mbx message */
867
868         struct hns3_ptype_table ptype_tbl __rte_cache_aligned;
869 };
870
871 #define HNS3_DEVARG_RX_FUNC_HINT        "rx_func_hint"
872 #define HNS3_DEVARG_TX_FUNC_HINT        "tx_func_hint"
873
874 #define HNS3_DEVARG_DEV_CAPS_MASK       "dev_caps_mask"
875
876 #define HNS3_DEVARG_MBX_TIME_LIMIT_MS   "mbx_time_limit_ms"
877
878 enum {
879         HNS3_DEV_SUPPORT_DCB_B,
880         HNS3_DEV_SUPPORT_COPPER_B,
881         HNS3_DEV_SUPPORT_FD_QUEUE_REGION_B,
882         HNS3_DEV_SUPPORT_PTP_B,
883         HNS3_DEV_SUPPORT_TX_PUSH_B,
884         HNS3_DEV_SUPPORT_INDEP_TXRX_B,
885         HNS3_DEV_SUPPORT_STASH_B,
886         HNS3_DEV_SUPPORT_RXD_ADV_LAYOUT_B,
887         HNS3_DEV_SUPPORT_OUTER_UDP_CKSUM_B,
888         HNS3_DEV_SUPPORT_RAS_IMP_B,
889         HNS3_DEV_SUPPORT_TM_B,
890         HNS3_DEV_SUPPORT_VF_VLAN_FLT_MOD_B,
891 };
892
893 #define hns3_dev_get_support(hw, _name) \
894         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_##_name##_B)
895
896 #define HNS3_DEV_PRIVATE_TO_HW(adapter) \
897         (&((struct hns3_adapter *)adapter)->hw)
898 #define HNS3_DEV_PRIVATE_TO_PF(adapter) \
899         (&((struct hns3_adapter *)adapter)->pf)
900 #define HNS3_DEV_PRIVATE_TO_VF(adapter) \
901         (&((struct hns3_adapter *)adapter)->vf)
902 #define HNS3_DEV_HW_TO_ADAPTER(hw) \
903         container_of(hw, struct hns3_adapter, hw)
904
905 static inline struct hns3_pf *HNS3_DEV_HW_TO_PF(struct hns3_hw *hw)
906 {
907         struct hns3_adapter *adapter = HNS3_DEV_HW_TO_ADAPTER(hw);
908         return &adapter->pf;
909 }
910
911 static inline struct hns3_vf *HNS3_DEV_HW_TO_VF(struct hns3_hw *hw)
912 {
913         struct hns3_adapter *adapter = HNS3_DEV_HW_TO_ADAPTER(hw);
914         return &adapter->vf;
915 }
916
917 #define hns3_set_field(origin, mask, shift, val) \
918         do { \
919                 (origin) &= (~(mask)); \
920                 (origin) |= ((val) << (shift)) & (mask); \
921         } while (0)
922 #define hns3_get_field(origin, mask, shift) \
923         (((origin) & (mask)) >> (shift))
924 #define hns3_set_bit(origin, shift, val) \
925         hns3_set_field((origin), (0x1UL << (shift)), (shift), (val))
926 #define hns3_get_bit(origin, shift) \
927         hns3_get_field((origin), (0x1UL << (shift)), (shift))
928
929 #define hns3_gen_field_val(mask, shift, val) (((val) << (shift)) & (mask))
930
931 /*
932  * upper_32_bits - return bits 32-63 of a number
933  * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
934  * the "right shift count >= width of type" warning when that quantity is
935  * 32-bits.
936  */
937 #define upper_32_bits(n) ((uint32_t)(((n) >> 16) >> 16))
938
939 /* lower_32_bits - return bits 0-31 of a number */
940 #define lower_32_bits(n) ((uint32_t)(n))
941
942 #define BIT(nr) (1UL << (nr))
943
944 #define BIT_ULL(x) (1ULL << (x))
945
946 #define BITS_PER_LONG   (__SIZEOF_LONG__ * 8)
947 #define GENMASK(h, l) \
948         (((~0UL) << (l)) & (~0UL >> (BITS_PER_LONG - 1 - (h))))
949
950 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
951 #define rounddown(x, y) ((x) - ((x) % (y)))
952
953 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
954
955 /*
956  * Because hardware always access register in little-endian mode based on hns3
957  * network engine, so driver should also call rte_cpu_to_le_32 to convert data
958  * in little-endian mode before writing register and call rte_le_to_cpu_32 to
959  * convert data after reading from register.
960  *
961  * Here the driver encapsulates the data conversion operation in the register
962  * read/write operation function as below:
963  *   hns3_write_reg
964  *   hns3_write_reg_opt
965  *   hns3_read_reg
966  * Therefore, when calling these functions, conversion is not required again.
967  */
968 static inline void hns3_write_reg(void *base, uint32_t reg, uint32_t value)
969 {
970         rte_write32(rte_cpu_to_le_32(value),
971                     (volatile void *)((char *)base + reg));
972 }
973
974 /*
975  * The optimized function for writing registers reduces one address addition
976  * calculation, it was used in the '.rx_pkt_burst' and '.tx_pkt_burst' ops
977  * implementation function.
978  */
979 static inline void hns3_write_reg_opt(volatile void *addr, uint32_t value)
980 {
981         rte_write32(rte_cpu_to_le_32(value), addr);
982 }
983
984 static inline uint32_t hns3_read_reg(void *base, uint32_t reg)
985 {
986         uint32_t read_val = rte_read32((volatile void *)((char *)base + reg));
987         return rte_le_to_cpu_32(read_val);
988 }
989
990 #define hns3_write_dev(a, reg, value) \
991         hns3_write_reg((a)->io_base, (reg), (value))
992
993 #define hns3_read_dev(a, reg) \
994         hns3_read_reg((a)->io_base, (reg))
995
996 #define NEXT_ITEM_OF_ACTION(act, actions, index)                        \
997         do {                                                            \
998                 act = (actions) + (index);                              \
999                 while (act->type == RTE_FLOW_ACTION_TYPE_VOID) {        \
1000                         (index)++;                                      \
1001                         act = actions + index;                          \
1002                 }                                                       \
1003         } while (0)
1004
1005 static inline uint64_t
1006 hns3_atomic_test_bit(unsigned int nr, volatile uint64_t *addr)
1007 {
1008         uint64_t res;
1009
1010         res = (__atomic_load_n(addr, __ATOMIC_RELAXED) & (1UL << nr)) != 0;
1011         return res;
1012 }
1013
1014 static inline void
1015 hns3_atomic_set_bit(unsigned int nr, volatile uint64_t *addr)
1016 {
1017         __atomic_fetch_or(addr, (1UL << nr), __ATOMIC_RELAXED);
1018 }
1019
1020 static inline void
1021 hns3_atomic_clear_bit(unsigned int nr, volatile uint64_t *addr)
1022 {
1023         __atomic_fetch_and(addr, ~(1UL << nr), __ATOMIC_RELAXED);
1024 }
1025
1026 static inline int64_t
1027 hns3_test_and_clear_bit(unsigned int nr, volatile uint64_t *addr)
1028 {
1029         uint64_t mask = (1UL << nr);
1030
1031         return __atomic_fetch_and(addr, ~mask, __ATOMIC_RELAXED) & mask;
1032 }
1033
1034 int hns3_buffer_alloc(struct hns3_hw *hw);
1035 int hns3_dev_flow_ops_get(struct rte_eth_dev *dev,
1036                           const struct rte_flow_ops **ops);
1037 bool hns3_is_reset_pending(struct hns3_adapter *hns);
1038 bool hns3vf_is_reset_pending(struct hns3_adapter *hns);
1039 void hns3_update_linkstatus_and_event(struct hns3_hw *hw, bool query);
1040 int hns3_dev_infos_get(struct rte_eth_dev *eth_dev,
1041                        struct rte_eth_dev_info *info);
1042 void hns3vf_update_link_status(struct hns3_hw *hw, uint8_t link_status,
1043                           uint32_t link_speed, uint8_t link_duplex);
1044 void hns3vf_update_push_lsc_cap(struct hns3_hw *hw, bool supported);
1045
1046 int hns3_restore_ptp(struct hns3_adapter *hns);
1047 int hns3_mbuf_dyn_rx_timestamp_register(struct rte_eth_dev *dev,
1048                                     struct rte_eth_conf *conf);
1049 int hns3_ptp_init(struct hns3_hw *hw);
1050 int hns3_timesync_enable(struct rte_eth_dev *dev);
1051 int hns3_timesync_disable(struct rte_eth_dev *dev);
1052 int hns3_timesync_read_rx_timestamp(struct rte_eth_dev *dev,
1053                                 struct timespec *timestamp,
1054                                 uint32_t flags __rte_unused);
1055 int hns3_timesync_read_tx_timestamp(struct rte_eth_dev *dev,
1056                                 struct timespec *timestamp);
1057 int hns3_timesync_read_time(struct rte_eth_dev *dev, struct timespec *ts);
1058 int hns3_timesync_write_time(struct rte_eth_dev *dev,
1059                         const struct timespec *ts);
1060 int hns3_timesync_adjust_time(struct rte_eth_dev *dev, int64_t delta);
1061
1062 static inline bool
1063 is_reset_pending(struct hns3_adapter *hns)
1064 {
1065         bool ret;
1066         if (hns->is_vf)
1067                 ret = hns3vf_is_reset_pending(hns);
1068         else
1069                 ret = hns3_is_reset_pending(hns);
1070         return ret;
1071 }
1072
1073 static inline uint64_t
1074 hns3_txvlan_cap_get(struct hns3_hw *hw)
1075 {
1076         if (hw->port_base_vlan_cfg.state)
1077                 return RTE_ETH_TX_OFFLOAD_VLAN_INSERT;
1078         else
1079                 return RTE_ETH_TX_OFFLOAD_VLAN_INSERT | RTE_ETH_TX_OFFLOAD_QINQ_INSERT;
1080 }
1081
1082 #endif /* _HNS3_ETHDEV_H_ */