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 typedef void (*rte_dev_event_cb_fn)(const char *device_name,
37 enum rte_dev_event_type event,
40 /* Macros to check for invalid function pointers */
41 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
46 #define RTE_FUNC_PTR_OR_RET(func) do { \
59 /* Backwards compatibility will be removed */
60 #define RTE_DEV_WHITELISTED \
61 RTE_DEPRECATED(RTE_DEV_WHITELISTED) RTE_DEV_ALLOWED
62 #define RTE_DEV_BLACKLISTED \
63 RTE_DEPRECATED(RTE_DEV_BLACKLISTED) RTE_DEV_BLOCKED
66 * A generic memory resource representation.
68 struct rte_mem_resource {
69 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
70 uint64_t len; /**< Length of the resource. */
71 void *addr; /**< Virtual address, NULL when not mapped. */
75 * A structure describing a device driver.
78 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
79 const char *name; /**< Driver name. */
80 const char *alias; /**< Driver alias. */
84 * Internal identifier length
85 * Sufficiently large to allow for UUID or PCI address
87 #define RTE_DEV_NAME_MAX_LEN 64
90 * A structure describing a generic device.
93 TAILQ_ENTRY(rte_device) next; /**< Next device */
94 const char *name; /**< Device name */
95 const struct rte_driver *driver; /**< Driver assigned after probing */
96 const struct rte_bus *bus; /**< Bus handle assigned on scan */
97 int numa_node; /**< NUMA node connection */
98 struct rte_devargs *devargs; /**< Arguments for latest probing */
102 * Query status of a device.
105 * Generic device pointer.
107 * (int)true if already probed successfully, 0 otherwise.
109 int rte_dev_is_probed(const struct rte_device *dev);
112 * Hotplug add a given device to a specific bus.
114 * In multi-process, it will request other processes to add the same device.
115 * A failure, in any process, will rollback the action
118 * The bus name the device is added to.
120 * The device name. Based on this device name, eal will identify a driver
121 * capable of handling it and pass it to the driver probing function.
123 * Device arguments to be passed to the driver.
125 * 0 on success, negative on error.
127 int rte_eal_hotplug_add(const char *busname, const char *devname,
128 const char *drvargs);
131 * Add matching devices.
133 * In multi-process, it will request other processes to add the same device.
134 * A failure, in any process, will rollback the action
137 * Device arguments including bus, class and driver properties.
139 * 0 on success, negative on error.
141 int rte_dev_probe(const char *devargs);
144 * Hotplug remove a given device from a specific bus.
146 * In multi-process, it will request other processes to remove the same device.
147 * A failure, in any process, will rollback the action
150 * The bus name the device is removed from.
152 * The device name being removed.
154 * 0 on success, negative on error.
156 int rte_eal_hotplug_remove(const char *busname, const char *devname);
161 * In multi-process, it will request other processes to remove the same device.
162 * A failure, in any process, will rollback the action
165 * Data structure of the device to remove.
167 * 0 on success, negative on error.
169 int rte_dev_remove(struct rte_device *dev);
172 * Device comparison function.
174 * This type of function is used to compare an rte_device with arbitrary
181 * Data to compare against. The type of this parameter is determined by
182 * the kind of comparison performed by the function.
185 * 0 if the device matches the data.
186 * !0 if the device does not match.
187 * <0 if ordering is possible and the device is lower than the data.
188 * >0 if ordering is possible and the device is greater than the data.
190 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
192 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
194 #define RTE_PMD_EXPORT_NAME(name, idx) \
195 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
196 __rte_used = RTE_STR(name)
198 #define DRV_EXP_TAG(name, tag) __##name##_##tag
200 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
201 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __rte_used = \
204 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
205 static const char DRV_EXP_TAG(name, param_string_export)[] \
209 * Advertise the list of kernel modules required to run this driver
211 * This string lists the kernel modules required for the devices
212 * associated to a PMD. The format of each line of the string is:
213 * "<device-pattern> <kmod-expression>".
215 * The possible formats for the device pattern are:
216 * "*" all devices supported by this driver
217 * "pci:*" all PCI devices supported by this driver
218 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
219 * whose vendor id is 0x8086.
221 * The format of the kernel modules list is a parenthesized expression
222 * containing logical-and (&) and logical-or (|).
224 * The device pattern and the kmod expression are separated by a space.
227 * - "* igb_uio | uio_pci_generic | vfio"
229 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
230 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
236 * This context carries over the current iteration state.
238 struct rte_dev_iterator {
239 const char *dev_str; /**< device string. */
240 const char *bus_str; /**< bus-related part of device string. */
241 const char *cls_str; /**< class-related part of device string. */
242 struct rte_bus *bus; /**< bus handle. */
243 struct rte_class *cls; /**< class handle. */
244 struct rte_device *device; /**< current position. */
245 void *class_device; /**< additional specialized context. */
249 * Device iteration function.
251 * Find the next device matching properties passed in parameters.
252 * The function takes an additional ``start`` parameter, that is
253 * used as starting context when relevant.
255 * The function returns the current element in the iteration.
256 * This return value will potentially be used as a start parameter
257 * in subsequent calls to the function.
259 * The additional iterator parameter is only there if a specific
260 * implementation needs additional context. It must not be modified by
261 * the iteration function itself.
264 * Starting iteration context.
267 * Device description string.
273 * The address of the current element matching the device description
276 typedef void *(*rte_dev_iterate_t)(const void *start,
278 const struct rte_dev_iterator *it);
281 * Initializes a device iterator.
283 * This iterator allows accessing a list of devices matching a criteria.
284 * The device matching is made among all buses and classes currently registered,
285 * filtered by the device description given as parameter.
287 * This function will not allocate any memory. It is safe to stop the
288 * iteration at any moment and let the iterator go out of context.
291 * Device iterator handle.
294 * Device description string.
297 * 0 on successful initialization.
302 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
305 * Iterates on a device iterator.
307 * Generates a new rte_device handle corresponding to the next element
308 * in the list described in comprehension by the iterator.
310 * The next object is returned, and the iterator is updated.
313 * Device iterator handle.
316 * An rte_device handle if found.
317 * NULL if an error occurred (rte_errno is set).
318 * NULL if no device could be found (rte_errno is not set).
322 rte_dev_iterator_next(struct rte_dev_iterator *it);
324 #define RTE_DEV_FOREACH(dev, devstr, it) \
325 for (rte_dev_iterator_init(it, devstr), \
326 dev = rte_dev_iterator_next(it); \
328 dev = rte_dev_iterator_next(it))
336 * @b EXPERIMENTAL: this API may change without prior notice
338 * It registers the callback for the specific device.
339 * Multiple callbacks can be registered at the same time.
342 * The device name, that is the param name of the struct rte_device,
343 * null value means for all devices.
347 * address of parameter for callback.
350 * - On success, zero.
351 * - On failure, a negative value.
355 rte_dev_event_callback_register(const char *device_name,
356 rte_dev_event_cb_fn cb_fn,
361 * @b EXPERIMENTAL: this API may change without prior notice
363 * It unregisters the callback according to the specified device.
366 * The device name, that is the param name of the struct rte_device,
367 * null value means for all devices and their callbacks.
371 * address of parameter for callback, (void *)-1 means to remove all
372 * registered which has the same callback address.
375 * - On success, return the number of callback entities removed.
376 * - On failure, a negative value.
380 rte_dev_event_callback_unregister(const char *device_name,
381 rte_dev_event_cb_fn cb_fn,
386 * @b EXPERIMENTAL: this API may change without prior notice
388 * Executes all the user application registered callbacks for
389 * the specific device.
394 * the device event type.
398 rte_dev_event_callback_process(const char *device_name,
399 enum rte_dev_event_type event);
403 * @b EXPERIMENTAL: this API may change without prior notice
405 * Start the device event monitoring.
408 * - On success, zero.
409 * - On failure, a negative value.
413 rte_dev_event_monitor_start(void);
417 * @b EXPERIMENTAL: this API may change without prior notice
419 * Stop the device event monitoring.
422 * - On success, zero.
423 * - On failure, a negative value.
427 rte_dev_event_monitor_stop(void);
431 * @b EXPERIMENTAL: this API may change without prior notice
433 * Enable hotplug handling for devices.
436 * - On success, zero.
437 * - On failure, a negative value.
441 rte_dev_hotplug_handle_enable(void);
445 * @b EXPERIMENTAL: this API may change without prior notice
447 * Disable hotplug handling for devices.
450 * - On success, zero.
451 * - On failure, a negative value.
455 rte_dev_hotplug_handle_disable(void);
458 * Device level DMA map function.
459 * After a successful call, the memory segment will be mapped to the
462 * @note: Memory must be registered in advance using rte_extmem_* APIs.
467 * Virtual address to map.
469 * IOVA address to map.
471 * Length of the memory segment being mapped.
474 * 0 if mapping was successful.
475 * Negative value and rte_errno is set otherwise.
479 rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len);
482 * Device level DMA unmap function.
483 * After a successful call, the memory segment will no longer be
484 * accessible by the given device.
486 * @note: Memory must be registered in advance using rte_extmem_* APIs.
491 * Virtual address to unmap.
493 * IOVA address to unmap.
495 * Length of the memory segment being mapped.
498 * 0 if un-mapping was successful.
499 * Negative value and rte_errno is set otherwise.
503 rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
506 #endif /* _RTE_DEV_H_ */