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