common/cnxk: support NIX LSO and misc utils
[dpdk.git] / drivers / common / cnxk / roc_nix.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2021 Marvell.
3  */
4
5 #ifndef _ROC_NIX_H_
6 #define _ROC_NIX_H_
7
8 /* Constants */
9 enum roc_nix_rss_reta_sz {
10         ROC_NIX_RSS_RETA_SZ_64 = 64,
11         ROC_NIX_RSS_RETA_SZ_128 = 128,
12         ROC_NIX_RSS_RETA_SZ_256 = 256,
13 };
14
15 enum roc_nix_sq_max_sqe_sz {
16         roc_nix_maxsqesz_w16 = NIX_MAXSQESZ_W16,
17         roc_nix_maxsqesz_w8 = NIX_MAXSQESZ_W8,
18 };
19
20 enum roc_nix_fc_mode {
21         ROC_NIX_FC_NONE = 0,
22         ROC_NIX_FC_RX,
23         ROC_NIX_FC_TX,
24         ROC_NIX_FC_FULL
25 };
26
27 enum roc_nix_vlan_type {
28         ROC_NIX_VLAN_TYPE_INNER = 0x01,
29         ROC_NIX_VLAN_TYPE_OUTER = 0x02,
30 };
31
32 struct roc_nix_vlan_config {
33         uint32_t type;
34         union {
35                 struct {
36                         uint32_t vtag_inner;
37                         uint32_t vtag_outer;
38                 } vlan;
39
40                 struct {
41                         int idx_inner;
42                         int idx_outer;
43                 } mcam;
44         };
45 };
46
47 struct roc_nix_fc_cfg {
48         bool cq_cfg_valid;
49         union {
50                 struct {
51                         bool enable;
52                 } rxchan_cfg;
53
54                 struct {
55                         uint32_t rq;
56                         uint16_t cq_drop;
57                         bool enable;
58                 } cq_cfg;
59         };
60 };
61
62 struct roc_nix_eeprom_info {
63 #define ROC_NIX_EEPROM_SIZE 256
64         uint16_t sff_id;
65         uint8_t buf[ROC_NIX_EEPROM_SIZE];
66 };
67
68 /* Range to adjust PTP frequency. Valid range is
69  * (-ROC_NIX_PTP_FREQ_ADJUST, ROC_NIX_PTP_FREQ_ADJUST)
70  */
71 #define ROC_NIX_PTP_FREQ_ADJUST (1 << 9)
72
73 /* NIX LF RX offload configuration flags.
74  * These are input flags to roc_nix_lf_alloc:rx_cfg
75  */
76 #define ROC_NIX_LF_RX_CFG_DROP_RE     BIT_ULL(32)
77 #define ROC_NIX_LF_RX_CFG_L2_LEN_ERR  BIT_ULL(33)
78 #define ROC_NIX_LF_RX_CFG_IP6_UDP_OPT BIT_ULL(34)
79 #define ROC_NIX_LF_RX_CFG_DIS_APAD    BIT_ULL(35)
80 #define ROC_NIX_LF_RX_CFG_CSUM_IL4    BIT_ULL(36)
81 #define ROC_NIX_LF_RX_CFG_CSUM_OL4    BIT_ULL(37)
82 #define ROC_NIX_LF_RX_CFG_LEN_IL4     BIT_ULL(38)
83 #define ROC_NIX_LF_RX_CFG_LEN_IL3     BIT_ULL(39)
84 #define ROC_NIX_LF_RX_CFG_LEN_OL4     BIT_ULL(40)
85 #define ROC_NIX_LF_RX_CFG_LEN_OL3     BIT_ULL(41)
86
87 /* Group 0 will be used for RSS, 1 -7 will be used for npc_flow RSS action*/
88 #define ROC_NIX_RSS_GROUP_DEFAULT 0
89 #define ROC_NIX_RSS_GRPS          8
90 #define ROC_NIX_RSS_RETA_MAX      ROC_NIX_RSS_RETA_SZ_256
91 #define ROC_NIX_RSS_KEY_LEN       48 /* 352 Bits */
92
93 #define ROC_NIX_DEFAULT_HW_FRS 1514
94
95 #define ROC_NIX_VWQE_MAX_SIZE_LOG2 11
96 #define ROC_NIX_VWQE_MIN_SIZE_LOG2 2
97
98 struct roc_nix_stats {
99         /* Rx */
100         uint64_t rx_octs;
101         uint64_t rx_ucast;
102         uint64_t rx_bcast;
103         uint64_t rx_mcast;
104         uint64_t rx_drop;
105         uint64_t rx_drop_octs;
106         uint64_t rx_fcs;
107         uint64_t rx_err;
108         uint64_t rx_drop_bcast;
109         uint64_t rx_drop_mcast;
110         uint64_t rx_drop_l3_bcast;
111         uint64_t rx_drop_l3_mcast;
112         /* Tx */
113         uint64_t tx_ucast;
114         uint64_t tx_bcast;
115         uint64_t tx_mcast;
116         uint64_t tx_drop;
117         uint64_t tx_octs;
118 };
119
120 struct roc_nix_stats_queue {
121         PLT_STD_C11
122         union {
123                 struct {
124                         /* Rx */
125                         uint64_t rx_pkts;
126                         uint64_t rx_octs;
127                         uint64_t rx_drop_pkts;
128                         uint64_t rx_drop_octs;
129                         uint64_t rx_error_pkts;
130                 };
131                 struct {
132                         /* Tx */
133                         uint64_t tx_pkts;
134                         uint64_t tx_octs;
135                         uint64_t tx_drop_pkts;
136                         uint64_t tx_drop_octs;
137                 };
138         };
139 };
140
141 struct roc_nix_rq {
142         /* Input parameters */
143         uint16_t qid;
144         uint64_t aura_handle;
145         bool ipsech_ena;
146         uint16_t first_skip;
147         uint16_t later_skip;
148         uint16_t wqe_skip;
149         uint16_t lpb_size;
150         uint32_t tag_mask;
151         uint32_t flow_tag_width;
152         uint8_t tt;     /* Valid when SSO is enabled */
153         uint16_t hwgrp; /* Valid when SSO is enabled */
154         bool sso_ena;
155         bool vwqe_ena;
156         uint64_t spb_aura_handle; /* Valid when SPB is enabled */
157         uint16_t spb_size;        /* Valid when SPB is enabled */
158         bool spb_ena;
159         uint8_t vwqe_first_skip;
160         uint32_t vwqe_max_sz_exp;
161         uint64_t vwqe_wait_tmo;
162         uint64_t vwqe_aura_handle;
163         /* End of Input parameters */
164         struct roc_nix *roc_nix;
165 };
166
167 struct roc_nix_cq {
168         /* Input parameters */
169         uint16_t qid;
170         uint16_t nb_desc;
171         /* End of Input parameters */
172         uint16_t drop_thresh;
173         struct roc_nix *roc_nix;
174         uintptr_t door;
175         int64_t *status;
176         uint64_t wdata;
177         void *desc_base;
178         uint32_t qmask;
179         uint32_t head;
180 };
181
182 struct roc_nix_sq {
183         /* Input parameters */
184         enum roc_nix_sq_max_sqe_sz max_sqe_sz;
185         uint32_t nb_desc;
186         uint16_t qid;
187         /* End of Input parameters */
188         uint16_t sqes_per_sqb_log2;
189         struct roc_nix *roc_nix;
190         uint64_t aura_handle;
191         int16_t nb_sqb_bufs_adj;
192         uint16_t nb_sqb_bufs;
193         plt_iova_t io_addr;
194         void *lmt_addr;
195         void *sqe_mem;
196         void *fc;
197 };
198
199 struct roc_nix_link_info {
200         uint64_t status : 1;
201         uint64_t full_duplex : 1;
202         uint64_t lmac_type_id : 4;
203         uint64_t speed : 20;
204         uint64_t autoneg : 1;
205         uint64_t fec : 2;
206         uint64_t port : 8;
207 };
208
209 /** Maximum name length for extended statistics counters */
210 #define ROC_NIX_XSTATS_NAME_SIZE 64
211
212 struct roc_nix_xstat {
213         uint64_t id;    /**< The index in xstats name array. */
214         uint64_t value; /**< The statistic counter value. */
215 };
216
217 struct roc_nix_xstat_name {
218         char name[ROC_NIX_XSTATS_NAME_SIZE];
219 };
220
221 struct roc_nix_ipsec_cfg {
222         uint32_t sa_size;
223         uint32_t tag_const;
224         plt_iova_t iova;
225         uint16_t max_sa;
226         uint8_t tt;
227 };
228
229 /* Link status update callback */
230 typedef void (*link_status_t)(struct roc_nix *roc_nix,
231                               struct roc_nix_link_info *link);
232
233 /* PTP info update callback */
234 typedef int (*ptp_info_update_t)(struct roc_nix *roc_nix, bool enable);
235
236 struct roc_nix {
237         /* Input parameters */
238         struct plt_pci_device *pci_dev;
239         uint16_t port_id;
240         bool rss_tag_as_xor;
241         uint16_t max_sqb_count;
242         enum roc_nix_rss_reta_sz reta_sz;
243         bool enable_loop;
244         /* End of input parameters */
245         /* LMT line base for "Per Core Tx LMT line" mode*/
246         uintptr_t lmt_base;
247         bool io_enabled;
248         bool rx_ptp_ena;
249         uint16_t cints;
250
251 #define ROC_NIX_MEM_SZ (6 * 1024)
252         uint8_t reserved[ROC_NIX_MEM_SZ] __plt_cache_aligned;
253 } __plt_cache_aligned;
254
255 enum roc_nix_lso_tun_type {
256         ROC_NIX_LSO_TUN_V4V4,
257         ROC_NIX_LSO_TUN_V4V6,
258         ROC_NIX_LSO_TUN_V6V4,
259         ROC_NIX_LSO_TUN_V6V6,
260         ROC_NIX_LSO_TUN_MAX,
261 };
262
263 /* Dev */
264 int __roc_api roc_nix_dev_init(struct roc_nix *roc_nix);
265 int __roc_api roc_nix_dev_fini(struct roc_nix *roc_nix);
266
267 /* Type */
268 bool __roc_api roc_nix_is_lbk(struct roc_nix *roc_nix);
269 bool __roc_api roc_nix_is_sdp(struct roc_nix *roc_nix);
270 bool __roc_api roc_nix_is_pf(struct roc_nix *roc_nix);
271 bool __roc_api roc_nix_is_vf_or_sdp(struct roc_nix *roc_nix);
272 int __roc_api roc_nix_get_base_chan(struct roc_nix *roc_nix);
273 int __roc_api roc_nix_get_pf(struct roc_nix *roc_nix);
274 int __roc_api roc_nix_get_vf(struct roc_nix *roc_nix);
275 uint16_t __roc_api roc_nix_get_pf_func(struct roc_nix *roc_nix);
276 uint16_t __roc_api roc_nix_get_vwqe_interval(struct roc_nix *roc_nix);
277 int __roc_api roc_nix_max_pkt_len(struct roc_nix *roc_nix);
278
279 /* LF ops */
280 int __roc_api roc_nix_lf_alloc(struct roc_nix *roc_nix, uint32_t nb_rxq,
281                                uint32_t nb_txq, uint64_t rx_cfg);
282 int __roc_api roc_nix_lf_free(struct roc_nix *roc_nix);
283 int __roc_api roc_nix_lf_inl_ipsec_cfg(struct roc_nix *roc_nix,
284                                        struct roc_nix_ipsec_cfg *cfg, bool enb);
285
286 /* Debug */
287 int __roc_api roc_nix_lf_get_reg_count(struct roc_nix *roc_nix);
288 int __roc_api roc_nix_lf_reg_dump(struct roc_nix *roc_nix, uint64_t *data);
289 int __roc_api roc_nix_queues_ctx_dump(struct roc_nix *roc_nix);
290 void __roc_api roc_nix_cqe_dump(const struct nix_cqe_hdr_s *cq);
291 void __roc_api roc_nix_rq_dump(struct roc_nix_rq *rq);
292 void __roc_api roc_nix_cq_dump(struct roc_nix_cq *cq);
293 void __roc_api roc_nix_sq_dump(struct roc_nix_sq *sq);
294 void __roc_api roc_nix_dump(struct roc_nix *roc_nix);
295
296 /* IRQ */
297 void __roc_api roc_nix_rx_queue_intr_enable(struct roc_nix *roc_nix,
298                                             uint16_t rxq_id);
299 void __roc_api roc_nix_rx_queue_intr_disable(struct roc_nix *roc_nix,
300                                              uint16_t rxq_id);
301 void __roc_api roc_nix_err_intr_ena_dis(struct roc_nix *roc_nix, bool enb);
302 void __roc_api roc_nix_ras_intr_ena_dis(struct roc_nix *roc_nix, bool enb);
303 int __roc_api roc_nix_register_queue_irqs(struct roc_nix *roc_nix);
304 void __roc_api roc_nix_unregister_queue_irqs(struct roc_nix *roc_nix);
305 int __roc_api roc_nix_register_cq_irqs(struct roc_nix *roc_nix);
306 void __roc_api roc_nix_unregister_cq_irqs(struct roc_nix *roc_nix);
307
308 /* MAC */
309 int __roc_api roc_nix_mac_rxtx_start_stop(struct roc_nix *roc_nix, bool start);
310 int __roc_api roc_nix_mac_link_event_start_stop(struct roc_nix *roc_nix,
311                                                 bool start);
312 int __roc_api roc_nix_mac_loopback_enable(struct roc_nix *roc_nix, bool enable);
313 int __roc_api roc_nix_mac_addr_set(struct roc_nix *roc_nix,
314                                    const uint8_t addr[]);
315 int __roc_api roc_nix_mac_max_entries_get(struct roc_nix *roc_nix);
316 int __roc_api roc_nix_mac_addr_add(struct roc_nix *roc_nix, uint8_t addr[]);
317 int __roc_api roc_nix_mac_addr_del(struct roc_nix *roc_nix, uint32_t index);
318 int __roc_api roc_nix_mac_promisc_mode_enable(struct roc_nix *roc_nix,
319                                               int enable);
320 int __roc_api roc_nix_mac_link_state_set(struct roc_nix *roc_nix, uint8_t up);
321 int __roc_api roc_nix_mac_link_info_set(struct roc_nix *roc_nix,
322                                         struct roc_nix_link_info *link_info);
323 int __roc_api roc_nix_mac_link_info_get(struct roc_nix *roc_nix,
324                                         struct roc_nix_link_info *link_info);
325 int __roc_api roc_nix_mac_mtu_set(struct roc_nix *roc_nix, uint16_t mtu);
326 int __roc_api roc_nix_mac_max_rx_len_set(struct roc_nix *roc_nix,
327                                          uint16_t maxlen);
328 int __roc_api roc_nix_mac_link_cb_register(struct roc_nix *roc_nix,
329                                            link_status_t link_update);
330 void __roc_api roc_nix_mac_link_cb_unregister(struct roc_nix *roc_nix);
331
332 /* Ops */
333 int __roc_api roc_nix_switch_hdr_set(struct roc_nix *roc_nix,
334                                      uint64_t switch_header_type);
335 int __roc_api roc_nix_lso_fmt_setup(struct roc_nix *roc_nix);
336 int __roc_api roc_nix_lso_fmt_get(struct roc_nix *roc_nix,
337                                   uint8_t udp_tun[ROC_NIX_LSO_TUN_MAX],
338                                   uint8_t tun[ROC_NIX_LSO_TUN_MAX]);
339 int __roc_api roc_nix_lso_custom_fmt_setup(struct roc_nix *roc_nix,
340                                            struct nix_lso_format *fields,
341                                            uint16_t nb_fields);
342
343 int __roc_api roc_nix_eeprom_info_get(struct roc_nix *roc_nix,
344                                       struct roc_nix_eeprom_info *info);
345
346 /* Flow control */
347 int __roc_api roc_nix_fc_config_set(struct roc_nix *roc_nix,
348                                     struct roc_nix_fc_cfg *fc_cfg);
349
350 int __roc_api roc_nix_fc_config_get(struct roc_nix *roc_nix,
351                                     struct roc_nix_fc_cfg *fc_cfg);
352
353 int __roc_api roc_nix_fc_mode_set(struct roc_nix *roc_nix,
354                                   enum roc_nix_fc_mode mode);
355
356 enum roc_nix_fc_mode __roc_api roc_nix_fc_mode_get(struct roc_nix *roc_nix);
357
358 /* NPC */
359 int __roc_api roc_nix_npc_promisc_ena_dis(struct roc_nix *roc_nix, int enable);
360
361 int __roc_api roc_nix_npc_mac_addr_set(struct roc_nix *roc_nix, uint8_t addr[]);
362
363 int __roc_api roc_nix_npc_mac_addr_get(struct roc_nix *roc_nix, uint8_t *addr);
364
365 int __roc_api roc_nix_npc_rx_ena_dis(struct roc_nix *roc_nix, bool enable);
366
367 int __roc_api roc_nix_npc_mcast_config(struct roc_nix *roc_nix,
368                                        bool mcast_enable, bool prom_enable);
369
370 /* RSS */
371 void __roc_api roc_nix_rss_key_default_fill(struct roc_nix *roc_nix,
372                                             uint8_t key[ROC_NIX_RSS_KEY_LEN]);
373 void __roc_api roc_nix_rss_key_set(struct roc_nix *roc_nix,
374                                    const uint8_t key[ROC_NIX_RSS_KEY_LEN]);
375 void __roc_api roc_nix_rss_key_get(struct roc_nix *roc_nix,
376                                    uint8_t key[ROC_NIX_RSS_KEY_LEN]);
377 int __roc_api roc_nix_rss_reta_set(struct roc_nix *roc_nix, uint8_t group,
378                                    uint16_t reta[ROC_NIX_RSS_RETA_MAX]);
379 int __roc_api roc_nix_rss_reta_get(struct roc_nix *roc_nix, uint8_t group,
380                                    uint16_t reta[ROC_NIX_RSS_RETA_MAX]);
381 int __roc_api roc_nix_rss_flowkey_set(struct roc_nix *roc_nix, uint8_t *alg_idx,
382                                       uint32_t flowkey, uint8_t group,
383                                       int mcam_index);
384 int __roc_api roc_nix_rss_default_setup(struct roc_nix *roc_nix,
385                                         uint32_t flowkey);
386
387 /* Stats */
388 int __roc_api roc_nix_stats_get(struct roc_nix *roc_nix,
389                                 struct roc_nix_stats *stats);
390 int __roc_api roc_nix_stats_reset(struct roc_nix *roc_nix);
391 int __roc_api roc_nix_stats_queue_get(struct roc_nix *roc_nix, uint16_t qid,
392                                       bool is_rx,
393                                       struct roc_nix_stats_queue *qstats);
394 int __roc_api roc_nix_stats_queue_reset(struct roc_nix *roc_nix, uint16_t qid,
395                                         bool is_rx);
396 int __roc_api roc_nix_num_xstats_get(struct roc_nix *roc_nix);
397 int __roc_api roc_nix_xstats_get(struct roc_nix *roc_nix,
398                                  struct roc_nix_xstat *xstats, unsigned int n);
399 int __roc_api roc_nix_xstats_names_get(struct roc_nix *roc_nix,
400                                        struct roc_nix_xstat_name *xstats_names,
401                                        unsigned int limit);
402
403 /* Queue */
404 int __roc_api roc_nix_rq_init(struct roc_nix *roc_nix, struct roc_nix_rq *rq,
405                               bool ena);
406 int __roc_api roc_nix_rq_modify(struct roc_nix *roc_nix, struct roc_nix_rq *rq,
407                                 bool ena);
408 int __roc_api roc_nix_rq_ena_dis(struct roc_nix_rq *rq, bool enable);
409 int __roc_api roc_nix_rq_fini(struct roc_nix_rq *rq);
410 int __roc_api roc_nix_cq_init(struct roc_nix *roc_nix, struct roc_nix_cq *cq);
411 int __roc_api roc_nix_cq_fini(struct roc_nix_cq *cq);
412 int __roc_api roc_nix_sq_init(struct roc_nix *roc_nix, struct roc_nix_sq *sq);
413 int __roc_api roc_nix_sq_fini(struct roc_nix_sq *sq);
414
415 /* PTP */
416 int __roc_api roc_nix_ptp_rx_ena_dis(struct roc_nix *roc_nix, int enable);
417 int __roc_api roc_nix_ptp_tx_ena_dis(struct roc_nix *roc_nix, int enable);
418 int __roc_api roc_nix_ptp_clock_read(struct roc_nix *roc_nix, uint64_t *clock,
419                                      uint64_t *tsc, uint8_t is_pmu);
420 int __roc_api roc_nix_ptp_sync_time_adjust(struct roc_nix *roc_nix,
421                                            int64_t delta);
422 int __roc_api roc_nix_ptp_info_cb_register(struct roc_nix *roc_nix,
423                                            ptp_info_update_t ptp_update);
424 void __roc_api roc_nix_ptp_info_cb_unregister(struct roc_nix *roc_nix);
425
426 /* VLAN */
427 int __roc_api
428 roc_nix_vlan_mcam_entry_read(struct roc_nix *roc_nix, uint32_t index,
429                              struct npc_mcam_read_entry_rsp **rsp);
430 int __roc_api roc_nix_vlan_mcam_entry_write(struct roc_nix *roc_nix,
431                                             uint32_t index,
432                                             struct mcam_entry *entry,
433                                             uint8_t intf, uint8_t enable);
434 int __roc_api roc_nix_vlan_mcam_entry_alloc_and_write(struct roc_nix *roc_nix,
435                                                       struct mcam_entry *entry,
436                                                       uint8_t intf,
437                                                       uint8_t priority,
438                                                       uint8_t ref_entry);
439 int __roc_api roc_nix_vlan_mcam_entry_free(struct roc_nix *roc_nix,
440                                            uint32_t index);
441 int __roc_api roc_nix_vlan_mcam_entry_ena_dis(struct roc_nix *roc_nix,
442                                               uint32_t index, const int enable);
443 int __roc_api roc_nix_vlan_strip_vtag_ena_dis(struct roc_nix *roc_nix,
444                                               bool enable);
445 int __roc_api roc_nix_vlan_insert_ena_dis(struct roc_nix *roc_nix,
446                                           struct roc_nix_vlan_config *vlan_cfg,
447                                           uint64_t *mcam_index, bool enable);
448 int __roc_api roc_nix_vlan_tpid_set(struct roc_nix *roc_nix, uint32_t type,
449                                     uint16_t tpid);
450
451 /* MCAST*/
452 int __roc_api roc_nix_mcast_mcam_entry_alloc(struct roc_nix *roc_nix,
453                                              uint16_t nb_entries,
454                                              uint8_t priority,
455                                              uint16_t index[]);
456 int __roc_api roc_nix_mcast_mcam_entry_free(struct roc_nix *roc_nix,
457                                             uint32_t index);
458 int __roc_api roc_nix_mcast_mcam_entry_write(struct roc_nix *roc_nix,
459                                              struct mcam_entry *entry,
460                                              uint32_t index, uint8_t intf,
461                                              uint64_t action);
462 int __roc_api roc_nix_mcast_mcam_entry_ena_dis(struct roc_nix *roc_nix,
463                                                uint32_t index, bool enable);
464 #endif /* _ROC_NIX_H_ */