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