1 /* SPDX-License-Identifier: BSD-3-Clause
2 *
3 * Copyright 2016,2019 NXP
4 *
5 */
6
7 #ifndef _RTE_FSLMC_H_
8 #define _RTE_FSLMC_H_
9
10 /**
11 * @file
12 *
13 * RTE FSLMC Bus Interface
14 */
15
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <limits.h>
23 #include <errno.h>
24 #include <sys/queue.h>
25 #include <stdint.h>
26 #include <inttypes.h>
27 #include <linux/vfio.h>
28
29 #include <rte_debug.h>
30 #include <rte_interrupts.h>
31 #include <rte_dev.h>
32 #include <rte_bus.h>
33 #include <rte_tailq.h>
34 #include <rte_devargs.h>
35 #include <rte_mbuf.h>
36 #include <rte_mbuf_dyn.h>
37
38 #include <fslmc_vfio.h>
39
40 #define FSLMC_OBJECT_MAX_LEN 32 /**< Length of each device on bus */
41
42 #define DPAA2_INVALID_MBUF_SEQN 0
43
44 typedef uint32_t dpaa2_seqn_t;
45 extern int dpaa2_seqn_dynfield_offset;
46
47 /**
48 * @warning
49 * @b EXPERIMENTAL: this API may change without prior notice
50 *
51 * Read dpaa2 sequence number from mbuf.
52 *
53 * @param mbuf Structure to read from.
54 * @return pointer to dpaa2 sequence number.
55 */
56 __rte_experimental
57 static inline dpaa2_seqn_t *
dpaa2_seqn(struct rte_mbuf * mbuf)58 dpaa2_seqn(struct rte_mbuf *mbuf)
59 {
60 return RTE_MBUF_DYNFIELD(mbuf, dpaa2_seqn_dynfield_offset,
61 dpaa2_seqn_t *);
62 }
63
64 /** Device driver supports link state interrupt */
65 #define RTE_DPAA2_DRV_INTR_LSC 0x0008
66
67 /** Device driver supports IOVA as VA */
68 #define RTE_DPAA2_DRV_IOVA_AS_VA 0X0040
69
70 struct rte_dpaa2_driver;
71
72 /* DPAA2 Device and Driver lists for FSLMC bus */
73 TAILQ_HEAD(rte_fslmc_device_list, rte_dpaa2_device);
74 TAILQ_HEAD(rte_fslmc_driver_list, rte_dpaa2_driver);
75
76 #define RTE_DEV_TO_FSLMC_CONST(ptr) \
77 container_of(ptr, const struct rte_dpaa2_device, device)
78
79 extern struct rte_fslmc_bus rte_fslmc_bus;
80
81 enum rte_dpaa2_dev_type {
82 /* Devices backed by DPDK driver */
83 DPAA2_ETH, /**< DPNI type device*/
84 DPAA2_CRYPTO, /**< DPSECI type device */
85 DPAA2_CON, /**< DPCONC type device */
86 /* Devices not backed by a DPDK driver: DPIO, DPBP, DPCI, DPMCP */
87 DPAA2_BPOOL, /**< DPBP type device */
88 DPAA2_IO, /**< DPIO type device */
89 DPAA2_CI, /**< DPCI type device */
90 DPAA2_MPORTAL, /**< DPMCP type device */
91 DPAA2_QDMA, /**< DPDMAI type device */
92 DPAA2_MUX, /**< DPDMUX type device */
93 DPAA2_DPRTC, /**< DPRTC type device */
94 /* Unknown device placeholder */
95 DPAA2_UNKNOWN,
96 DPAA2_DEVTYPE_MAX,
97 };
98
99 TAILQ_HEAD(rte_dpaa2_object_list, rte_dpaa2_object);
100
101 typedef int (*rte_dpaa2_obj_create_t)(int vdev_fd,
102 struct vfio_device_info *obj_info,
103 int object_id);
104
105 /**
106 * A structure describing a DPAA2 object.
107 */
108 struct rte_dpaa2_object {
109 TAILQ_ENTRY(rte_dpaa2_object) next; /**< Next in list. */
110 const char *name; /**< Name of Object. */
111 enum rte_dpaa2_dev_type dev_type; /**< Type of device */
112 rte_dpaa2_obj_create_t create;
113 };
114
115 /**
116 * A structure describing a DPAA2 device.
117 */
118 struct rte_dpaa2_device {
119 TAILQ_ENTRY(rte_dpaa2_device) next; /**< Next probed DPAA2 device. */
120 struct rte_device device; /**< Inherit core device */
121 union {
122 struct rte_eth_dev *eth_dev; /**< ethernet device */
123 struct rte_cryptodev *cryptodev; /**< Crypto Device */
124 struct rte_rawdev *rawdev; /**< Raw Device */
125 };
126 enum rte_dpaa2_dev_type dev_type; /**< Device Type */
127 uint16_t object_id; /**< DPAA2 Object ID */
128 struct rte_intr_handle intr_handle; /**< Interrupt handle */
129 struct rte_dpaa2_driver *driver; /**< Associated driver */
130 char name[FSLMC_OBJECT_MAX_LEN]; /**< DPAA2 Object name*/
131 };
132
133 typedef int (*rte_dpaa2_probe_t)(struct rte_dpaa2_driver *dpaa2_drv,
134 struct rte_dpaa2_device *dpaa2_dev);
135 typedef int (*rte_dpaa2_remove_t)(struct rte_dpaa2_device *dpaa2_dev);
136
137 /**
138 * A structure describing a DPAA2 driver.
139 */
140 struct rte_dpaa2_driver {
141 TAILQ_ENTRY(rte_dpaa2_driver) next; /**< Next in list. */
142 struct rte_driver driver; /**< Inherit core driver. */
143 struct rte_fslmc_bus *fslmc_bus; /**< FSLMC bus reference */
144 uint32_t drv_flags; /**< Flags for controlling device.*/
145 enum rte_dpaa2_dev_type drv_type; /**< Driver Type */
146 rte_dpaa2_probe_t probe;
147 rte_dpaa2_remove_t remove;
148 };
149
150 /*
151 * FSLMC bus
152 */
153 struct rte_fslmc_bus {
154 struct rte_bus bus; /**< Generic Bus object */
155 struct rte_fslmc_device_list device_list;
156 /**< FSLMC DPAA2 Device list */
157 struct rte_fslmc_driver_list driver_list;
158 /**< FSLMC DPAA2 Driver list */
159 int device_count[DPAA2_DEVTYPE_MAX];
160 /**< Count of all devices scanned */
161 };
162
163 /**
164 * Register a DPAA2 driver.
165 *
166 * @param driver
167 * A pointer to a rte_dpaa2_driver structure describing the driver
168 * to be registered.
169 */
170 __rte_internal
171 void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
172
173 /**
174 * Unregister a DPAA2 driver.
175 *
176 * @param driver
177 * A pointer to a rte_dpaa2_driver structure describing the driver
178 * to be unregistered.
179 */
180 __rte_internal
181 void rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver);
182
183 /** Helper for DPAA2 device registration from driver (eth, crypto) instance */
184 #define RTE_PMD_REGISTER_DPAA2(nm, dpaa2_drv) \
185 RTE_INIT(dpaa2initfn_ ##nm) \
186 {\
187 (dpaa2_drv).driver.name = RTE_STR(nm);\
188 rte_fslmc_driver_register(&dpaa2_drv); \
189 } \
190 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
191
192 /**
193 * Register a DPAA2 MC Object driver.
194 *
195 * @param mc_object
196 * A pointer to a rte_dpaa_object structure describing the mc object
197 * to be registered.
198 */
199 __rte_internal
200 void rte_fslmc_object_register(struct rte_dpaa2_object *object);
201
202 /**
203 * Count of a particular type of DPAA2 device scanned on the bus.
204 *
205 * @param dev_type
206 * Type of device as rte_dpaa2_dev_type enumerator
207 * @return
208 * >=0 for count; 0 indicates either no device of the said type scanned or
209 * invalid device type.
210 */
211 __rte_internal
212 uint32_t rte_fslmc_get_device_count(enum rte_dpaa2_dev_type device_type);
213
214 /** Helper for DPAA2 object registration */
215 #define RTE_PMD_REGISTER_DPAA2_OBJECT(nm, dpaa2_obj) \
216 RTE_INIT(dpaa2objinitfn_ ##nm) \
217 {\
218 (dpaa2_obj).name = RTE_STR(nm);\
219 rte_fslmc_object_register(&dpaa2_obj); \
220 } \
221 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
222
223 #ifdef __cplusplus
224 }
225 #endif
226
227 #endif /* _RTE_FSLMC_H_ */
228