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