1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2014 6WIND S.A.
11 * RTE PMD Driver Registration Interface
13 * This file manages the list of device drivers.
21 #include <sys/queue.h>
23 #include <rte_config.h>
24 #include <rte_compat.h>
28 * The device event type.
30 enum rte_dev_event_type {
31 RTE_DEV_EVENT_ADD, /**< device being added */
32 RTE_DEV_EVENT_REMOVE, /**< device being removed */
33 RTE_DEV_EVENT_MAX /**< max value of this enum */
36 struct rte_dev_event {
37 enum rte_dev_event_type type; /**< device event type */
38 int subsystem; /**< subsystem id */
39 char *devname; /**< device name */
42 typedef void (*rte_dev_event_cb_fn)(const char *device_name,
43 enum rte_dev_event_type event,
46 __attribute__((format(printf, 2, 0)))
48 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
55 char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
60 vsnprintf(buffer, sizeof(buffer), fmt, ap);
63 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s",
69 * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
70 * RTE_*_RET() macros defined below is compiled in debug mode.
72 #if defined(RTE_LIBRTE_EVENTDEV_DEBUG)
73 #define RTE_PMD_DEBUG_TRACE(...) \
74 rte_pmd_debug_trace(__func__, __VA_ARGS__)
76 #define RTE_PMD_DEBUG_TRACE(...) (void)0
79 /* Macros for checking for restricting functions to primary instance only */
80 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
81 if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
82 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
87 #define RTE_PROC_PRIMARY_OR_RET() do { \
88 if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
89 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
94 /* Macros to check for invalid function pointers */
95 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
96 if ((func) == NULL) { \
97 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
102 #define RTE_FUNC_PTR_OR_RET(func) do { \
103 if ((func) == NULL) { \
104 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
112 enum rte_kernel_driver {
113 RTE_KDRV_UNKNOWN = 0,
116 RTE_KDRV_UIO_GENERIC,
124 enum rte_dev_policy {
130 * A generic memory resource representation.
132 struct rte_mem_resource {
133 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
134 uint64_t len; /**< Length of the resource. */
135 void *addr; /**< Virtual address, NULL when not mapped. */
139 * A structure describing a device driver.
142 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
143 const char *name; /**< Driver name. */
144 const char *alias; /**< Driver alias. */
148 * Internal identifier length
149 * Sufficiently large to allow for UUID or PCI address
151 #define RTE_DEV_NAME_MAX_LEN 64
154 * A structure describing a generic device.
157 TAILQ_ENTRY(rte_device) next; /**< Next device */
158 const char *name; /**< Device name */
159 const struct rte_driver *driver; /**< Driver assigned after probing */
160 const struct rte_bus *bus; /**< Bus handle assigned on scan */
161 int numa_node; /**< NUMA node connection */
162 struct rte_devargs *devargs; /**< Arguments for latest probing */
167 * @b EXPERIMENTAL: this API may change without prior notice
169 * Query status of a device.
172 * Generic device pointer.
174 * (int)true if already probed successfully, 0 otherwise.
177 int rte_dev_is_probed(const struct rte_device *dev);
180 * Hotplug add a given device to a specific bus.
182 * In multi-process, it will request other processes to add the same device.
183 * A failure, in any process, will rollback the action
186 * The bus name the device is added to.
188 * The device name. Based on this device name, eal will identify a driver
189 * capable of handling it and pass it to the driver probing function.
191 * Device arguments to be passed to the driver.
193 * 0 on success, negative on error.
195 int rte_eal_hotplug_add(const char *busname, const char *devname,
196 const char *drvargs);
199 * Add matching devices.
201 * In multi-process, it will request other processes to add the same device.
202 * A failure, in any process, will rollback the action
205 * Device arguments including bus, class and driver properties.
207 * 0 on success, negative on error.
209 int rte_dev_probe(const char *devargs);
212 * Hotplug remove a given device from a specific bus.
214 * In multi-process, it will request other processes to remove the same device.
215 * A failure, in any process, will rollback the action
218 * The bus name the device is removed from.
220 * The device name being removed.
222 * 0 on success, negative on error.
224 int rte_eal_hotplug_remove(const char *busname, const char *devname);
229 * In multi-process, it will request other processes to remove the same device.
230 * A failure, in any process, will rollback the action
233 * Data structure of the device to remove.
235 * 0 on success, negative on error.
237 int rte_dev_remove(struct rte_device *dev);
240 * Device comparison function.
242 * This type of function is used to compare an rte_device with arbitrary
249 * Data to compare against. The type of this parameter is determined by
250 * the kind of comparison performed by the function.
253 * 0 if the device matches the data.
254 * !0 if the device does not match.
255 * <0 if ordering is possible and the device is lower than the data.
256 * >0 if ordering is possible and the device is greater than the data.
258 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
260 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
262 #define RTE_PMD_EXPORT_NAME(name, idx) \
263 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
264 __attribute__((used)) = RTE_STR(name)
266 #define DRV_EXP_TAG(name, tag) __##name##_##tag
268 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
269 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
272 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
273 static const char DRV_EXP_TAG(name, param_string_export)[] \
274 __attribute__((used)) = str
277 * Advertise the list of kernel modules required to run this driver
279 * This string lists the kernel modules required for the devices
280 * associated to a PMD. The format of each line of the string is:
281 * "<device-pattern> <kmod-expression>".
283 * The possible formats for the device pattern are:
284 * "*" all devices supported by this driver
285 * "pci:*" all PCI devices supported by this driver
286 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
287 * whose vendor id is 0x8086.
289 * The format of the kernel modules list is a parenthesed expression
290 * containing logical-and (&) and logical-or (|).
292 * The device pattern and the kmod expression are separated by a space.
295 * - "* igb_uio | uio_pci_generic | vfio"
297 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
298 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
299 __attribute__((used)) = str
304 * This context carries over the current iteration state.
306 struct rte_dev_iterator {
307 const char *dev_str; /**< device string. */
308 const char *bus_str; /**< bus-related part of device string. */
309 const char *cls_str; /**< class-related part of device string. */
310 struct rte_bus *bus; /**< bus handle. */
311 struct rte_class *cls; /**< class handle. */
312 struct rte_device *device; /**< current position. */
313 void *class_device; /**< additional specialized context. */
317 * Device iteration function.
319 * Find the next device matching properties passed in parameters.
320 * The function takes an additional ``start`` parameter, that is
321 * used as starting context when relevant.
323 * The function returns the current element in the iteration.
324 * This return value will potentially be used as a start parameter
325 * in subsequent calls to the function.
327 * The additional iterator parameter is only there if a specific
328 * implementation needs additional context. It must not be modified by
329 * the iteration function itself.
332 * Starting iteration context.
335 * Device description string.
341 * The address of the current element matching the device description
344 typedef void *(*rte_dev_iterate_t)(const void *start,
346 const struct rte_dev_iterator *it);
349 * Initializes a device iterator.
351 * This iterator allows accessing a list of devices matching a criteria.
352 * The device matching is made among all buses and classes currently registered,
353 * filtered by the device description given as parameter.
355 * This function will not allocate any memory. It is safe to stop the
356 * iteration at any moment and let the iterator go out of context.
359 * Device iterator handle.
362 * Device description string.
365 * 0 on successful initialization.
370 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
373 * Iterates on a device iterator.
375 * Generates a new rte_device handle corresponding to the next element
376 * in the list described in comprehension by the iterator.
378 * The next object is returned, and the iterator is updated.
381 * Device iterator handle.
384 * An rte_device handle if found.
385 * NULL if an error occurred (rte_errno is set).
386 * NULL if no device could be found (rte_errno is not set).
390 rte_dev_iterator_next(struct rte_dev_iterator *it);
392 #define RTE_DEV_FOREACH(dev, devstr, it) \
393 for (rte_dev_iterator_init(it, devstr), \
394 dev = rte_dev_iterator_next(it); \
396 dev = rte_dev_iterator_next(it))
404 * @b EXPERIMENTAL: this API may change without prior notice
406 * It registers the callback for the specific device.
407 * Multiple callbacks cal be registered at the same time.
410 * The device name, that is the param name of the struct rte_device,
411 * null value means for all devices.
415 * address of parameter for callback.
418 * - On success, zero.
419 * - On failure, a negative value.
421 int __rte_experimental
422 rte_dev_event_callback_register(const char *device_name,
423 rte_dev_event_cb_fn cb_fn,
428 * @b EXPERIMENTAL: this API may change without prior notice
430 * It unregisters the callback according to the specified device.
433 * The device name, that is the param name of the struct rte_device,
434 * null value means for all devices and their callbacks.
438 * address of parameter for callback, (void *)-1 means to remove all
439 * registered which has the same callback address.
442 * - On success, return the number of callback entities removed.
443 * - On failure, a negative value.
445 int __rte_experimental
446 rte_dev_event_callback_unregister(const char *device_name,
447 rte_dev_event_cb_fn cb_fn,
452 * @b EXPERIMENTAL: this API may change without prior notice
454 * Executes all the user application registered callbacks for
455 * the specific device.
460 * the device event type.
462 void __rte_experimental
463 rte_dev_event_callback_process(const char *device_name,
464 enum rte_dev_event_type event);
468 * @b EXPERIMENTAL: this API may change without prior notice
470 * Start the device event monitoring.
473 * - On success, zero.
474 * - On failure, a negative value.
476 int __rte_experimental
477 rte_dev_event_monitor_start(void);
481 * @b EXPERIMENTAL: this API may change without prior notice
483 * Stop the device event monitoring.
486 * - On success, zero.
487 * - On failure, a negative value.
489 int __rte_experimental
490 rte_dev_event_monitor_stop(void);
494 * @b EXPERIMENTAL: this API may change without prior notice
496 * Enable hotplug handling for devices.
499 * - On success, zero.
500 * - On failure, a negative value.
502 int __rte_experimental
503 rte_dev_hotplug_handle_enable(void);
507 * @b EXPERIMENTAL: this API may change without prior notice
509 * Disable hotplug handling for devices.
512 * - On success, zero.
513 * - On failure, a negative value.
515 int __rte_experimental
516 rte_dev_hotplug_handle_disable(void);
518 #endif /* _RTE_DEV_H_ */