common/cnxk: support NIX PTP
[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_rq {
51         /* Input parameters */
52         uint16_t qid;
53         uint64_t aura_handle;
54         bool ipsech_ena;
55         uint16_t first_skip;
56         uint16_t later_skip;
57         uint16_t wqe_skip;
58         uint16_t lpb_size;
59         uint32_t tag_mask;
60         uint32_t flow_tag_width;
61         uint8_t tt;     /* Valid when SSO is enabled */
62         uint16_t hwgrp; /* Valid when SSO is enabled */
63         bool sso_ena;
64         bool vwqe_ena;
65         uint64_t spb_aura_handle; /* Valid when SPB is enabled */
66         uint16_t spb_size;        /* Valid when SPB is enabled */
67         bool spb_ena;
68         uint8_t vwqe_first_skip;
69         uint32_t vwqe_max_sz_exp;
70         uint64_t vwqe_wait_tmo;
71         uint64_t vwqe_aura_handle;
72         /* End of Input parameters */
73         struct roc_nix *roc_nix;
74 };
75
76 struct roc_nix_cq {
77         /* Input parameters */
78         uint16_t qid;
79         uint16_t nb_desc;
80         /* End of Input parameters */
81         uint16_t drop_thresh;
82         struct roc_nix *roc_nix;
83         uintptr_t door;
84         int64_t *status;
85         uint64_t wdata;
86         void *desc_base;
87         uint32_t qmask;
88         uint32_t head;
89 };
90
91 struct roc_nix_sq {
92         /* Input parameters */
93         enum roc_nix_sq_max_sqe_sz max_sqe_sz;
94         uint32_t nb_desc;
95         uint16_t qid;
96         /* End of Input parameters */
97         uint16_t sqes_per_sqb_log2;
98         struct roc_nix *roc_nix;
99         uint64_t aura_handle;
100         int16_t nb_sqb_bufs_adj;
101         uint16_t nb_sqb_bufs;
102         plt_iova_t io_addr;
103         void *lmt_addr;
104         void *sqe_mem;
105         void *fc;
106 };
107
108 struct roc_nix_link_info {
109         uint64_t status : 1;
110         uint64_t full_duplex : 1;
111         uint64_t lmac_type_id : 4;
112         uint64_t speed : 20;
113         uint64_t autoneg : 1;
114         uint64_t fec : 2;
115         uint64_t port : 8;
116 };
117
118 struct roc_nix_ipsec_cfg {
119         uint32_t sa_size;
120         uint32_t tag_const;
121         plt_iova_t iova;
122         uint16_t max_sa;
123         uint8_t tt;
124 };
125
126 /* Link status update callback */
127 typedef void (*link_status_t)(struct roc_nix *roc_nix,
128                               struct roc_nix_link_info *link);
129
130 /* PTP info update callback */
131 typedef int (*ptp_info_update_t)(struct roc_nix *roc_nix, bool enable);
132
133 struct roc_nix {
134         /* Input parameters */
135         struct plt_pci_device *pci_dev;
136         uint16_t port_id;
137         bool rss_tag_as_xor;
138         uint16_t max_sqb_count;
139         enum roc_nix_rss_reta_sz reta_sz;
140         bool enable_loop;
141         /* End of input parameters */
142         /* LMT line base for "Per Core Tx LMT line" mode*/
143         uintptr_t lmt_base;
144         bool io_enabled;
145         bool rx_ptp_ena;
146         uint16_t cints;
147
148 #define ROC_NIX_MEM_SZ (6 * 1024)
149         uint8_t reserved[ROC_NIX_MEM_SZ] __plt_cache_aligned;
150 } __plt_cache_aligned;
151
152 /* Dev */
153 int __roc_api roc_nix_dev_init(struct roc_nix *roc_nix);
154 int __roc_api roc_nix_dev_fini(struct roc_nix *roc_nix);
155
156 /* Type */
157 bool __roc_api roc_nix_is_lbk(struct roc_nix *roc_nix);
158 bool __roc_api roc_nix_is_sdp(struct roc_nix *roc_nix);
159 bool __roc_api roc_nix_is_pf(struct roc_nix *roc_nix);
160 bool __roc_api roc_nix_is_vf_or_sdp(struct roc_nix *roc_nix);
161 int __roc_api roc_nix_get_base_chan(struct roc_nix *roc_nix);
162 int __roc_api roc_nix_get_pf(struct roc_nix *roc_nix);
163 int __roc_api roc_nix_get_vf(struct roc_nix *roc_nix);
164 uint16_t __roc_api roc_nix_get_pf_func(struct roc_nix *roc_nix);
165 uint16_t __roc_api roc_nix_get_vwqe_interval(struct roc_nix *roc_nix);
166 int __roc_api roc_nix_max_pkt_len(struct roc_nix *roc_nix);
167
168 /* LF ops */
169 int __roc_api roc_nix_lf_alloc(struct roc_nix *roc_nix, uint32_t nb_rxq,
170                                uint32_t nb_txq, uint64_t rx_cfg);
171 int __roc_api roc_nix_lf_free(struct roc_nix *roc_nix);
172 int __roc_api roc_nix_lf_inl_ipsec_cfg(struct roc_nix *roc_nix,
173                                        struct roc_nix_ipsec_cfg *cfg, bool enb);
174
175 /* IRQ */
176 void __roc_api roc_nix_rx_queue_intr_enable(struct roc_nix *roc_nix,
177                                             uint16_t rxq_id);
178 void __roc_api roc_nix_rx_queue_intr_disable(struct roc_nix *roc_nix,
179                                              uint16_t rxq_id);
180 void __roc_api roc_nix_err_intr_ena_dis(struct roc_nix *roc_nix, bool enb);
181 void __roc_api roc_nix_ras_intr_ena_dis(struct roc_nix *roc_nix, bool enb);
182 int __roc_api roc_nix_register_queue_irqs(struct roc_nix *roc_nix);
183 void __roc_api roc_nix_unregister_queue_irqs(struct roc_nix *roc_nix);
184 int __roc_api roc_nix_register_cq_irqs(struct roc_nix *roc_nix);
185 void __roc_api roc_nix_unregister_cq_irqs(struct roc_nix *roc_nix);
186
187 /* MAC */
188 int __roc_api roc_nix_mac_rxtx_start_stop(struct roc_nix *roc_nix, bool start);
189 int __roc_api roc_nix_mac_link_event_start_stop(struct roc_nix *roc_nix,
190                                                 bool start);
191 int __roc_api roc_nix_mac_loopback_enable(struct roc_nix *roc_nix, bool enable);
192 int __roc_api roc_nix_mac_addr_set(struct roc_nix *roc_nix,
193                                    const uint8_t addr[]);
194 int __roc_api roc_nix_mac_max_entries_get(struct roc_nix *roc_nix);
195 int __roc_api roc_nix_mac_addr_add(struct roc_nix *roc_nix, uint8_t addr[]);
196 int __roc_api roc_nix_mac_addr_del(struct roc_nix *roc_nix, uint32_t index);
197 int __roc_api roc_nix_mac_promisc_mode_enable(struct roc_nix *roc_nix,
198                                               int enable);
199 int __roc_api roc_nix_mac_link_state_set(struct roc_nix *roc_nix, uint8_t up);
200 int __roc_api roc_nix_mac_link_info_set(struct roc_nix *roc_nix,
201                                         struct roc_nix_link_info *link_info);
202 int __roc_api roc_nix_mac_link_info_get(struct roc_nix *roc_nix,
203                                         struct roc_nix_link_info *link_info);
204 int __roc_api roc_nix_mac_mtu_set(struct roc_nix *roc_nix, uint16_t mtu);
205 int __roc_api roc_nix_mac_max_rx_len_set(struct roc_nix *roc_nix,
206                                          uint16_t maxlen);
207 int __roc_api roc_nix_mac_link_cb_register(struct roc_nix *roc_nix,
208                                            link_status_t link_update);
209 void __roc_api roc_nix_mac_link_cb_unregister(struct roc_nix *roc_nix);
210
211 /* NPC */
212 int __roc_api roc_nix_npc_promisc_ena_dis(struct roc_nix *roc_nix, int enable);
213
214 int __roc_api roc_nix_npc_mac_addr_set(struct roc_nix *roc_nix, uint8_t addr[]);
215
216 int __roc_api roc_nix_npc_mac_addr_get(struct roc_nix *roc_nix, uint8_t *addr);
217
218 int __roc_api roc_nix_npc_rx_ena_dis(struct roc_nix *roc_nix, bool enable);
219
220 int __roc_api roc_nix_npc_mcast_config(struct roc_nix *roc_nix,
221                                        bool mcast_enable, bool prom_enable);
222
223 /* RSS */
224 void __roc_api roc_nix_rss_key_default_fill(struct roc_nix *roc_nix,
225                                             uint8_t key[ROC_NIX_RSS_KEY_LEN]);
226 void __roc_api roc_nix_rss_key_set(struct roc_nix *roc_nix,
227                                    const uint8_t key[ROC_NIX_RSS_KEY_LEN]);
228 void __roc_api roc_nix_rss_key_get(struct roc_nix *roc_nix,
229                                    uint8_t key[ROC_NIX_RSS_KEY_LEN]);
230 int __roc_api roc_nix_rss_reta_set(struct roc_nix *roc_nix, uint8_t group,
231                                    uint16_t reta[ROC_NIX_RSS_RETA_MAX]);
232 int __roc_api roc_nix_rss_reta_get(struct roc_nix *roc_nix, uint8_t group,
233                                    uint16_t reta[ROC_NIX_RSS_RETA_MAX]);
234 int __roc_api roc_nix_rss_flowkey_set(struct roc_nix *roc_nix, uint8_t *alg_idx,
235                                       uint32_t flowkey, uint8_t group,
236                                       int mcam_index);
237 int __roc_api roc_nix_rss_default_setup(struct roc_nix *roc_nix,
238                                         uint32_t flowkey);
239
240 /* Queue */
241 int __roc_api roc_nix_rq_init(struct roc_nix *roc_nix, struct roc_nix_rq *rq,
242                               bool ena);
243 int __roc_api roc_nix_rq_modify(struct roc_nix *roc_nix, struct roc_nix_rq *rq,
244                                 bool ena);
245 int __roc_api roc_nix_rq_ena_dis(struct roc_nix_rq *rq, bool enable);
246 int __roc_api roc_nix_rq_fini(struct roc_nix_rq *rq);
247 int __roc_api roc_nix_cq_init(struct roc_nix *roc_nix, struct roc_nix_cq *cq);
248 int __roc_api roc_nix_cq_fini(struct roc_nix_cq *cq);
249 int __roc_api roc_nix_sq_init(struct roc_nix *roc_nix, struct roc_nix_sq *sq);
250 int __roc_api roc_nix_sq_fini(struct roc_nix_sq *sq);
251
252 /* PTP */
253 int __roc_api roc_nix_ptp_rx_ena_dis(struct roc_nix *roc_nix, int enable);
254 int __roc_api roc_nix_ptp_tx_ena_dis(struct roc_nix *roc_nix, int enable);
255 int __roc_api roc_nix_ptp_clock_read(struct roc_nix *roc_nix, uint64_t *clock,
256                                      uint64_t *tsc, uint8_t is_pmu);
257 int __roc_api roc_nix_ptp_sync_time_adjust(struct roc_nix *roc_nix,
258                                            int64_t delta);
259 int __roc_api roc_nix_ptp_info_cb_register(struct roc_nix *roc_nix,
260                                            ptp_info_update_t ptp_update);
261 void __roc_api roc_nix_ptp_info_cb_unregister(struct roc_nix *roc_nix);
262
263 /* MCAST*/
264 int __roc_api roc_nix_mcast_mcam_entry_alloc(struct roc_nix *roc_nix,
265                                              uint16_t nb_entries,
266                                              uint8_t priority,
267                                              uint16_t index[]);
268 int __roc_api roc_nix_mcast_mcam_entry_free(struct roc_nix *roc_nix,
269                                             uint32_t index);
270 int __roc_api roc_nix_mcast_mcam_entry_write(struct roc_nix *roc_nix,
271                                              struct mcam_entry *entry,
272                                              uint32_t index, uint8_t intf,
273                                              uint64_t action);
274 int __roc_api roc_nix_mcast_mcam_entry_ena_dis(struct roc_nix *roc_nix,
275                                                uint32_t index, bool enable);
276 #endif /* _ROC_NIX_H_ */