1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved.
4 * Copyright 2016-2018 NXP
8 #ifndef _DPAA2_HW_PVT_H_
9 #define _DPAA2_HW_PVT_H_
11 #include <rte_eventdev.h>
12 #include <dpaax_iova_table.h>
14 #include <mc/fsl_mc_sys.h>
15 #include <fsl_qbman_portal.h>
23 #define lower_32_bits(x) ((uint32_t)(x))
24 #define upper_32_bits(x) ((uint32_t)(((x) >> 16) >> 16))
27 #define VLAN_TAG_SIZE 4 /** < Vlan Header Length */
30 /* Maximum number of slots available in TX ring */
31 #define MAX_TX_RING_SLOTS 32
32 #define MAX_EQ_RESP_ENTRIES (MAX_TX_RING_SLOTS + 1)
34 /* Maximum number of slots available in RX ring */
35 #define DPAA2_EQCR_RING_SIZE 8
36 /* Maximum number of slots available in RX ring on LX2 */
37 #define DPAA2_LX2_EQCR_RING_SIZE 32
39 /* Maximum number of slots available in RX ring */
40 #define DPAA2_DQRR_RING_SIZE 16
41 /* Maximum number of slots available in RX ring on LX2 */
42 #define DPAA2_LX2_DQRR_RING_SIZE 32
44 /* EQCR shift to get EQCR size (2 >> 3) = 8 for LS2/LS2 */
45 #define DPAA2_EQCR_SHIFT 3
46 /* EQCR shift to get EQCR size for LX2 (2 >> 5) = 32 for LX2 */
47 #define DPAA2_LX2_EQCR_SHIFT 5
49 /* Flag to determine an ordered queue mbuf */
50 #define DPAA2_ENQUEUE_FLAG_ORP (1ULL << 30)
51 /* ORP ID shift and mask */
52 #define DPAA2_EQCR_OPRID_SHIFT 16
53 #define DPAA2_EQCR_OPRID_MASK 0x3FFF0000
54 /* Sequence number shift and mask */
55 #define DPAA2_EQCR_SEQNUM_SHIFT 0
56 #define DPAA2_EQCR_SEQNUM_MASK 0x0000FFFF
58 #define DPAA2_SWP_CENA_REGION 0
59 #define DPAA2_SWP_CINH_REGION 1
60 #define DPAA2_SWP_CENA_MEM_REGION 2
62 #define MC_PORTAL_INDEX 0
63 #define NUM_DPIO_REGIONS 2
64 #define NUM_DQS_PER_QUEUE 2
66 /* Maximum release/acquire from QBMAN */
67 #define DPAA2_MBUF_MAX_ACQ_REL 7
69 #define DPAA2_MEMPOOL_OPS_NAME "dpaa2"
72 #define DPAA2_MBUF_HW_ANNOTATION 64
73 #define DPAA2_FD_PTA_SIZE 0
75 #if (DPAA2_MBUF_HW_ANNOTATION + DPAA2_FD_PTA_SIZE) > RTE_PKTMBUF_HEADROOM
76 #error "Annotation requirement is more than RTE_PKTMBUF_HEADROOM"
79 /* we will re-use the HEADROOM for annotation in RX */
80 #define DPAA2_HW_BUF_RESERVE 0
81 #define DPAA2_PACKET_LAYOUT_ALIGN 64 /*changing from 256 */
83 #define DPAA2_DPCI_MAX_QUEUES 2
87 struct eqresp_metadata {
88 struct dpaa2_queue *dpaa2_q;
89 struct rte_mempool *mp;
92 struct dpaa2_dpio_dev {
93 TAILQ_ENTRY(dpaa2_dpio_dev) next;
94 /**< Pointer to Next device instance */
95 uint16_t index; /**< Index of a instance in the list */
96 rte_atomic16_t ref_count;
97 /**< How many thread contexts are sharing this.*/
100 struct qbman_result *eqresp;
101 struct eqresp_metadata *eqresp_meta;
102 struct fsl_mc_io *dpio; /** handle to DPIO portal object */
104 struct qbman_swp *sw_portal; /** SW portal object */
105 const struct qbman_result *dqrr[4];
106 /**< DQRR Entry for this SW portal */
107 void *mc_portal; /**< MC Portal for configuring this device */
108 uintptr_t qbman_portal_ce_paddr;
109 /**< Physical address of Cache Enabled Area */
110 uintptr_t ce_size; /**< Size of the CE region */
111 uintptr_t qbman_portal_ci_paddr;
112 /**< Physical address of Cache Inhibit Area */
113 uintptr_t ci_size; /**< Size of the CI region */
114 struct rte_intr_handle intr_handle; /* Interrupt related info */
115 int32_t epoll_fd; /**< File descriptor created for interrupt polling */
116 int32_t hw_id; /**< An unique ID of this DPIO device instance */
119 struct dpaa2_dpbp_dev {
120 TAILQ_ENTRY(dpaa2_dpbp_dev) next;
121 /**< Pointer to Next device instance */
122 struct fsl_mc_io dpbp; /** handle to DPBP portal object */
124 rte_atomic16_t in_use;
125 uint32_t dpbp_id; /*HW ID for DPBP object */
128 struct queue_storage_info_t {
129 struct qbman_result *dq_storage[NUM_DQS_PER_QUEUE];
130 struct qbman_result *active_dqs;
131 uint8_t active_dpio_id;
133 uint8_t last_num_pkts;
138 typedef void (dpaa2_queue_cb_dqrr_t)(struct qbman_swp *swp,
139 const struct qbman_fd *fd,
140 const struct qbman_result *dq,
141 struct dpaa2_queue *rxq,
142 struct rte_event *ev);
144 typedef void (dpaa2_queue_cb_eqresp_free_t)(uint16_t eqresp_ci);
147 struct rte_mempool *mb_pool; /**< mbuf pool to populate RX ring. */
149 struct rte_eth_dev_data *eth_data;
150 struct rte_cryptodev_data *crypto_data;
152 int32_t eventfd; /*!< Event Fd of this queue */
153 uint32_t fqid; /*!< Unique ID of this queue */
154 uint8_t tc_index; /*!< traffic class identifier */
155 uint16_t flow_id; /*!< To be used by DPAA2 frmework */
160 struct queue_storage_info_t *q_storage;
161 struct qbman_result *cscn;
164 dpaa2_queue_cb_dqrr_t *cb;
165 dpaa2_queue_cb_eqresp_free_t *cb_eqresp_free;
166 struct dpaa2_bp_info *bp_array;
169 struct swp_active_dqs {
170 struct qbman_result *global_active_dqs;
171 uint64_t reserved[7];
174 #define NUM_MAX_SWP 64
176 extern struct swp_active_dqs rte_global_active_dqs_list[NUM_MAX_SWP];
178 struct dpaa2_dpci_dev {
179 TAILQ_ENTRY(dpaa2_dpci_dev) next;
180 /**< Pointer to Next device instance */
181 struct fsl_mc_io dpci; /** handle to DPCI portal object */
183 rte_atomic16_t in_use;
184 uint32_t dpci_id; /*HW ID for DPCI object */
185 struct dpaa2_queue rx_queue[DPAA2_DPCI_MAX_QUEUES];
186 struct dpaa2_queue tx_queue[DPAA2_DPCI_MAX_QUEUES];
189 /*! Global MCP list */
190 extern void *(*rte_mcp_ptr_list);
192 /* Refer to Table 7-3 in SEC BG */
197 /* FMT must be 00, MSB is final bit */
198 uint32_t fin_bpid_offset;
200 uint32_t reserved[3]; /* Not used currently */
207 uint32_t fin_bpid_offset;
210 /* There are three types of frames: Single, Scatter Gather and Frame Lists */
211 enum qbman_fd_format {
216 /*Macros to define operations on FD*/
217 #define DPAA2_SET_FD_ADDR(fd, addr) do { \
218 (fd)->simple.addr_lo = lower_32_bits((size_t)(addr)); \
219 (fd)->simple.addr_hi = upper_32_bits((uint64_t)(addr)); \
221 #define DPAA2_SET_FD_LEN(fd, length) ((fd)->simple.len = length)
222 #define DPAA2_SET_FD_BPID(fd, bpid) ((fd)->simple.bpid_offset |= bpid)
223 #define DPAA2_SET_ONLY_FD_BPID(fd, bpid) \
224 ((fd)->simple.bpid_offset = bpid)
225 #define DPAA2_SET_FD_IVP(fd) (((fd)->simple.bpid_offset |= 0x00004000))
226 #define DPAA2_SET_FD_OFFSET(fd, offset) \
227 (((fd)->simple.bpid_offset |= (uint32_t)(offset) << 16))
228 #define DPAA2_SET_FD_INTERNAL_JD(fd, len) \
229 ((fd)->simple.frc = (0x80000000 | (len)))
230 #define DPAA2_GET_FD_FRC_PARSE_SUM(fd) \
231 ((uint16_t)(((fd)->simple.frc & 0xffff0000) >> 16))
232 #define DPAA2_SET_FD_FRC(fd, _frc) ((fd)->simple.frc = _frc)
233 #define DPAA2_RESET_FD_CTRL(fd) ((fd)->simple.ctrl = 0)
235 #define DPAA2_SET_FD_ASAL(fd, asal) ((fd)->simple.ctrl |= (asal << 16))
237 #define DPAA2_RESET_FD_FLC(fd) do { \
238 (fd)->simple.flc_lo = 0; \
239 (fd)->simple.flc_hi = 0; \
242 #define DPAA2_SET_FD_FLC(fd, addr) do { \
243 (fd)->simple.flc_lo = lower_32_bits((size_t)(addr)); \
244 (fd)->simple.flc_hi = upper_32_bits((uint64_t)(addr)); \
246 #define DPAA2_SET_FLE_INTERNAL_JD(fle, len) ((fle)->frc = (0x80000000 | (len)))
247 #define DPAA2_GET_FLE_ADDR(fle) \
248 (size_t)((((uint64_t)((fle)->addr_hi)) << 32) + (fle)->addr_lo)
249 #define DPAA2_SET_FLE_ADDR(fle, addr) do { \
250 (fle)->addr_lo = lower_32_bits((size_t)addr); \
251 (fle)->addr_hi = upper_32_bits((uint64_t)addr); \
253 #define DPAA2_GET_FLE_CTXT(fle) \
254 ((((uint64_t)((fle)->reserved[1])) << 32) + (fle)->reserved[0])
255 #define DPAA2_FLE_SAVE_CTXT(fle, addr) do { \
256 (fle)->reserved[0] = lower_32_bits((size_t)addr); \
257 (fle)->reserved[1] = upper_32_bits((uint64_t)addr); \
259 #define DPAA2_SET_FLE_OFFSET(fle, offset) \
260 ((fle)->fin_bpid_offset |= (uint32_t)(offset) << 16)
261 #define DPAA2_SET_FLE_LEN(fle, len) ((fle)->length = len)
262 #define DPAA2_SET_FLE_BPID(fle, bpid) ((fle)->fin_bpid_offset |= (size_t)bpid)
263 #define DPAA2_GET_FLE_BPID(fle) ((fle)->fin_bpid_offset & 0x000000ff)
264 #define DPAA2_SET_FLE_FIN(fle) ((fle)->fin_bpid_offset |= 1 << 31)
265 #define DPAA2_SET_FLE_IVP(fle) (((fle)->fin_bpid_offset |= 0x00004000))
266 #define DPAA2_SET_FLE_BMT(fle) (((fle)->fin_bpid_offset |= 0x00008000))
267 #define DPAA2_SET_FD_COMPOUND_FMT(fd) \
268 ((fd)->simple.bpid_offset |= (uint32_t)1 << 28)
269 #define DPAA2_GET_FD_ADDR(fd) \
270 (((((uint64_t)((fd)->simple.addr_hi)) << 32) + (fd)->simple.addr_lo))
272 #define DPAA2_GET_FD_LEN(fd) ((fd)->simple.len)
273 #define DPAA2_GET_FD_BPID(fd) (((fd)->simple.bpid_offset & 0x00003FFF))
274 #define DPAA2_GET_FD_IVP(fd) (((fd)->simple.bpid_offset & 0x00004000) >> 14)
275 #define DPAA2_GET_FD_OFFSET(fd) (((fd)->simple.bpid_offset & 0x0FFF0000) >> 16)
276 #define DPAA2_GET_FD_FRC(fd) ((fd)->simple.frc)
277 #define DPAA2_GET_FD_FLC(fd) \
278 (((uint64_t)((fd)->simple.flc_hi) << 32) + (fd)->simple.flc_lo)
279 #define DPAA2_GET_FD_ERR(fd) ((fd)->simple.bpid_offset & 0x000000FF)
280 #define DPAA2_GET_FLE_OFFSET(fle) (((fle)->fin_bpid_offset & 0x0FFF0000) >> 16)
281 #define DPAA2_SET_FLE_SG_EXT(fle) ((fle)->fin_bpid_offset |= (uint64_t)1 << 29)
282 #define DPAA2_IS_SET_FLE_SG_EXT(fle) \
283 (((fle)->fin_bpid_offset & ((uint64_t)1 << 29)) ? 1 : 0)
285 #define DPAA2_INLINE_MBUF_FROM_BUF(buf, meta_data_size) \
286 ((struct rte_mbuf *)((size_t)(buf) - (meta_data_size)))
288 #define DPAA2_ASAL_VAL (DPAA2_MBUF_HW_ANNOTATION / 64)
290 #define DPAA2_FD_SET_FORMAT(fd, format) do { \
291 (fd)->simple.bpid_offset &= 0xCFFFFFFF; \
292 (fd)->simple.bpid_offset |= (uint32_t)format << 28; \
294 #define DPAA2_FD_GET_FORMAT(fd) (((fd)->simple.bpid_offset >> 28) & 0x3)
296 #define DPAA2_SG_SET_FINAL(sg, fin) do { \
297 (sg)->fin_bpid_offset &= 0x7FFFFFFF; \
298 (sg)->fin_bpid_offset |= (uint32_t)fin << 31; \
300 #define DPAA2_SG_IS_FINAL(sg) (!!((sg)->fin_bpid_offset >> 31))
301 /* Only Enqueue Error responses will be
302 * pushed on FQID_ERR of Enqueue FQ
304 #define DPAA2_EQ_RESP_ERR_FQ 0
305 /* All Enqueue responses will be pushed on address
306 * set with qbman_eq_desc_set_response
308 #define DPAA2_EQ_RESP_ALWAYS 1
310 /* Various structures representing contiguous memory maps */
311 struct dpaa2_memseg {
312 TAILQ_ENTRY(dpaa2_memseg) next;
318 TAILQ_HEAD(dpaa2_memseg_list, dpaa2_memseg);
319 extern struct dpaa2_memseg_list rte_dpaa2_memsegs;
321 #ifdef RTE_LIBRTE_DPAA2_USE_PHYS_IOVA
322 extern uint8_t dpaa2_virt_mode;
323 static void *dpaa2_mem_ptov(phys_addr_t paddr) __attribute__((unused));
325 static void *dpaa2_mem_ptov(phys_addr_t paddr)
330 return (void *)(size_t)paddr;
332 va = (void *)dpaax_iova_table_get_va(paddr);
333 if (likely(va != NULL))
336 /* If not, Fallback to full memseg list searching */
337 va = rte_mem_iova2virt(paddr);
342 static phys_addr_t dpaa2_mem_vtop(uint64_t vaddr) __attribute__((unused));
344 static phys_addr_t dpaa2_mem_vtop(uint64_t vaddr)
346 const struct rte_memseg *memseg;
351 memseg = rte_mem_virt2memseg((void *)(uintptr_t)vaddr, NULL);
353 return memseg->phys_addr + RTE_PTR_DIFF(vaddr, memseg->addr);
358 * When we are using Physical addresses as IO Virtual Addresses,
359 * Need to call conversion routines dpaa2_mem_vtop & dpaa2_mem_ptov
361 * These routines are called with help of below MACRO's
364 #define DPAA2_MBUF_VADDR_TO_IOVA(mbuf) ((mbuf)->buf_iova)
367 * macro to convert Virtual address to IOVA
369 #define DPAA2_VADDR_TO_IOVA(_vaddr) dpaa2_mem_vtop((size_t)(_vaddr))
372 * macro to convert IOVA to Virtual address
374 #define DPAA2_IOVA_TO_VADDR(_iova) dpaa2_mem_ptov((size_t)(_iova))
377 * macro to convert modify the memory containing IOVA to Virtual address
379 #define DPAA2_MODIFY_IOVA_TO_VADDR(_mem, _type) \
380 {_mem = (_type)(dpaa2_mem_ptov((size_t)(_mem))); }
382 #else /* RTE_LIBRTE_DPAA2_USE_PHYS_IOVA */
384 #define DPAA2_MBUF_VADDR_TO_IOVA(mbuf) ((mbuf)->buf_addr)
385 #define DPAA2_VADDR_TO_IOVA(_vaddr) (_vaddr)
386 #define DPAA2_IOVA_TO_VADDR(_iova) (_iova)
387 #define DPAA2_MODIFY_IOVA_TO_VADDR(_mem, _type)
389 #endif /* RTE_LIBRTE_DPAA2_USE_PHYS_IOVA */
392 int check_swp_active_dqs(uint16_t dpio_index)
394 if (rte_global_active_dqs_list[dpio_index].global_active_dqs != NULL)
400 void clear_swp_active_dqs(uint16_t dpio_index)
402 rte_global_active_dqs_list[dpio_index].global_active_dqs = NULL;
406 struct qbman_result *get_swp_active_dqs(uint16_t dpio_index)
408 return rte_global_active_dqs_list[dpio_index].global_active_dqs;
412 void set_swp_active_dqs(uint16_t dpio_index, struct qbman_result *dqs)
414 rte_global_active_dqs_list[dpio_index].global_active_dqs = dqs;
416 struct dpaa2_dpbp_dev *dpaa2_alloc_dpbp_dev(void);
417 void dpaa2_free_dpbp_dev(struct dpaa2_dpbp_dev *dpbp);
418 int dpaa2_dpbp_supported(void);
420 struct dpaa2_dpci_dev *rte_dpaa2_alloc_dpci_dev(void);
421 void rte_dpaa2_free_dpci_dev(struct dpaa2_dpci_dev *dpci);