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 /* Macros to check for invalid function pointers */
47 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
52 #define RTE_FUNC_PTR_OR_RET(func) do { \
60 enum rte_kernel_driver {
78 * A generic memory resource representation.
80 struct rte_mem_resource {
81 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
82 uint64_t len; /**< Length of the resource. */
83 void *addr; /**< Virtual address, NULL when not mapped. */
87 * A structure describing a device driver.
90 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
91 const char *name; /**< Driver name. */
92 const char *alias; /**< Driver alias. */
96 * Internal identifier length
97 * Sufficiently large to allow for UUID or PCI address
99 #define RTE_DEV_NAME_MAX_LEN 64
102 * A structure describing a generic device.
105 TAILQ_ENTRY(rte_device) next; /**< Next device */
106 const char *name; /**< Device name */
107 const struct rte_driver *driver; /**< Driver assigned after probing */
108 const struct rte_bus *bus; /**< Bus handle assigned on scan */
109 int numa_node; /**< NUMA node connection */
110 struct rte_devargs *devargs; /**< Arguments for latest probing */
114 * Query status of a device.
117 * Generic device pointer.
119 * (int)true if already probed successfully, 0 otherwise.
121 int rte_dev_is_probed(const struct rte_device *dev);
124 * Hotplug add a given device to a specific bus.
126 * In multi-process, it will request other processes to add the same device.
127 * A failure, in any process, will rollback the action
130 * The bus name the device is added to.
132 * The device name. Based on this device name, eal will identify a driver
133 * capable of handling it and pass it to the driver probing function.
135 * Device arguments to be passed to the driver.
137 * 0 on success, negative on error.
139 int rte_eal_hotplug_add(const char *busname, const char *devname,
140 const char *drvargs);
143 * Add matching devices.
145 * In multi-process, it will request other processes to add the same device.
146 * A failure, in any process, will rollback the action
149 * Device arguments including bus, class and driver properties.
151 * 0 on success, negative on error.
153 int rte_dev_probe(const char *devargs);
156 * Hotplug remove a given device from a specific bus.
158 * In multi-process, it will request other processes to remove the same device.
159 * A failure, in any process, will rollback the action
162 * The bus name the device is removed from.
164 * The device name being removed.
166 * 0 on success, negative on error.
168 int rte_eal_hotplug_remove(const char *busname, const char *devname);
173 * In multi-process, it will request other processes to remove the same device.
174 * A failure, in any process, will rollback the action
177 * Data structure of the device to remove.
179 * 0 on success, negative on error.
181 int rte_dev_remove(struct rte_device *dev);
184 * Device comparison function.
186 * This type of function is used to compare an rte_device with arbitrary
193 * Data to compare against. The type of this parameter is determined by
194 * the kind of comparison performed by the function.
197 * 0 if the device matches the data.
198 * !0 if the device does not match.
199 * <0 if ordering is possible and the device is lower than the data.
200 * >0 if ordering is possible and the device is greater than the data.
202 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
204 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
206 #define RTE_PMD_EXPORT_NAME(name, idx) \
207 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
208 __attribute__((used)) = RTE_STR(name)
210 #define DRV_EXP_TAG(name, tag) __##name##_##tag
212 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
213 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
216 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
217 static const char DRV_EXP_TAG(name, param_string_export)[] \
218 __attribute__((used)) = str
221 * Advertise the list of kernel modules required to run this driver
223 * This string lists the kernel modules required for the devices
224 * associated to a PMD. The format of each line of the string is:
225 * "<device-pattern> <kmod-expression>".
227 * The possible formats for the device pattern are:
228 * "*" all devices supported by this driver
229 * "pci:*" all PCI devices supported by this driver
230 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
231 * whose vendor id is 0x8086.
233 * The format of the kernel modules list is a parenthesed expression
234 * containing logical-and (&) and logical-or (|).
236 * The device pattern and the kmod expression are separated by a space.
239 * - "* igb_uio | uio_pci_generic | vfio"
241 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
242 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
243 __attribute__((used)) = str
248 * This context carries over the current iteration state.
250 struct rte_dev_iterator {
251 const char *dev_str; /**< device string. */
252 const char *bus_str; /**< bus-related part of device string. */
253 const char *cls_str; /**< class-related part of device string. */
254 struct rte_bus *bus; /**< bus handle. */
255 struct rte_class *cls; /**< class handle. */
256 struct rte_device *device; /**< current position. */
257 void *class_device; /**< additional specialized context. */
261 * Device iteration function.
263 * Find the next device matching properties passed in parameters.
264 * The function takes an additional ``start`` parameter, that is
265 * used as starting context when relevant.
267 * The function returns the current element in the iteration.
268 * This return value will potentially be used as a start parameter
269 * in subsequent calls to the function.
271 * The additional iterator parameter is only there if a specific
272 * implementation needs additional context. It must not be modified by
273 * the iteration function itself.
276 * Starting iteration context.
279 * Device description string.
285 * The address of the current element matching the device description
288 typedef void *(*rte_dev_iterate_t)(const void *start,
290 const struct rte_dev_iterator *it);
293 * Initializes a device iterator.
295 * This iterator allows accessing a list of devices matching a criteria.
296 * The device matching is made among all buses and classes currently registered,
297 * filtered by the device description given as parameter.
299 * This function will not allocate any memory. It is safe to stop the
300 * iteration at any moment and let the iterator go out of context.
303 * Device iterator handle.
306 * Device description string.
309 * 0 on successful initialization.
314 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
317 * Iterates on a device iterator.
319 * Generates a new rte_device handle corresponding to the next element
320 * in the list described in comprehension by the iterator.
322 * The next object is returned, and the iterator is updated.
325 * Device iterator handle.
328 * An rte_device handle if found.
329 * NULL if an error occurred (rte_errno is set).
330 * NULL if no device could be found (rte_errno is not set).
334 rte_dev_iterator_next(struct rte_dev_iterator *it);
336 #define RTE_DEV_FOREACH(dev, devstr, it) \
337 for (rte_dev_iterator_init(it, devstr), \
338 dev = rte_dev_iterator_next(it); \
340 dev = rte_dev_iterator_next(it))
348 * @b EXPERIMENTAL: this API may change without prior notice
350 * It registers the callback for the specific device.
351 * Multiple callbacks cal be registered at the same time.
354 * The device name, that is the param name of the struct rte_device,
355 * null value means for all devices.
359 * address of parameter for callback.
362 * - On success, zero.
363 * - On failure, a negative value.
365 int __rte_experimental
366 rte_dev_event_callback_register(const char *device_name,
367 rte_dev_event_cb_fn cb_fn,
372 * @b EXPERIMENTAL: this API may change without prior notice
374 * It unregisters the callback according to the specified device.
377 * The device name, that is the param name of the struct rte_device,
378 * null value means for all devices and their callbacks.
382 * address of parameter for callback, (void *)-1 means to remove all
383 * registered which has the same callback address.
386 * - On success, return the number of callback entities removed.
387 * - On failure, a negative value.
389 int __rte_experimental
390 rte_dev_event_callback_unregister(const char *device_name,
391 rte_dev_event_cb_fn cb_fn,
396 * @b EXPERIMENTAL: this API may change without prior notice
398 * Executes all the user application registered callbacks for
399 * the specific device.
404 * the device event type.
406 void __rte_experimental
407 rte_dev_event_callback_process(const char *device_name,
408 enum rte_dev_event_type event);
412 * @b EXPERIMENTAL: this API may change without prior notice
414 * Start the device event monitoring.
417 * - On success, zero.
418 * - On failure, a negative value.
420 int __rte_experimental
421 rte_dev_event_monitor_start(void);
425 * @b EXPERIMENTAL: this API may change without prior notice
427 * Stop the device event monitoring.
430 * - On success, zero.
431 * - On failure, a negative value.
433 int __rte_experimental
434 rte_dev_event_monitor_stop(void);
438 * @b EXPERIMENTAL: this API may change without prior notice
440 * Enable hotplug handling for devices.
443 * - On success, zero.
444 * - On failure, a negative value.
446 int __rte_experimental
447 rte_dev_hotplug_handle_enable(void);
451 * @b EXPERIMENTAL: this API may change without prior notice
453 * Disable hotplug handling for devices.
456 * - On success, zero.
457 * - On failure, a negative value.
459 int __rte_experimental
460 rte_dev_hotplug_handle_disable(void);
463 * Device level DMA map function.
464 * After a successful call, the memory segment will be mapped to the
467 * @note: Memory must be registered in advance using rte_extmem_* APIs.
472 * Virtual address to map.
474 * IOVA address to map.
476 * Length of the memory segment being mapped.
479 * 0 if mapping was successful.
480 * Negative value and rte_errno is set otherwise.
482 int __rte_experimental
483 rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len);
486 * Device level DMA unmap function.
487 * After a successful call, the memory segment will no longer be
488 * accessible by the given device.
490 * @note: Memory must be registered in advance using rte_extmem_* APIs.
495 * Virtual address to unmap.
497 * IOVA address to unmap.
499 * Length of the memory segment being mapped.
502 * 0 if un-mapping was successful.
503 * Negative value and rte_errno is set otherwise.
505 int __rte_experimental
506 rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
509 #endif /* _RTE_DEV_H_ */