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 { \
60 * A generic memory resource representation.
62 struct rte_mem_resource {
63 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
64 uint64_t len; /**< Length of the resource. */
65 void *addr; /**< Virtual address, NULL when not mapped. */
69 * A structure describing a device driver.
72 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
73 const char *name; /**< Driver name. */
74 const char *alias; /**< Driver alias. */
78 * Internal identifier length
79 * Sufficiently large to allow for UUID or PCI address
81 #define RTE_DEV_NAME_MAX_LEN 64
84 * A structure describing a generic device.
87 TAILQ_ENTRY(rte_device) next; /**< Next device */
88 const char *name; /**< Device name */
89 const struct rte_driver *driver; /**< Driver assigned after probing */
90 const struct rte_bus *bus; /**< Bus handle assigned on scan */
91 int numa_node; /**< NUMA node connection */
92 struct rte_devargs *devargs; /**< Arguments for latest probing */
96 * Query status of a device.
99 * Generic device pointer.
101 * (int)true if already probed successfully, 0 otherwise.
103 int rte_dev_is_probed(const struct rte_device *dev);
106 * Hotplug add a given device to a specific bus.
108 * In multi-process, it will request other processes to add the same device.
109 * A failure, in any process, will rollback the action
112 * The bus name the device is added to.
114 * The device name. Based on this device name, eal will identify a driver
115 * capable of handling it and pass it to the driver probing function.
117 * Device arguments to be passed to the driver.
119 * 0 on success, negative on error.
121 int rte_eal_hotplug_add(const char *busname, const char *devname,
122 const char *drvargs);
125 * Add matching devices.
127 * In multi-process, it will request other processes to add the same device.
128 * A failure, in any process, will rollback the action
131 * Device arguments including bus, class and driver properties.
133 * 0 on success, negative on error.
135 int rte_dev_probe(const char *devargs);
138 * Hotplug remove a given device from a specific bus.
140 * In multi-process, it will request other processes to remove the same device.
141 * A failure, in any process, will rollback the action
144 * The bus name the device is removed from.
146 * The device name being removed.
148 * 0 on success, negative on error.
150 int rte_eal_hotplug_remove(const char *busname, const char *devname);
155 * In multi-process, it will request other processes to remove the same device.
156 * A failure, in any process, will rollback the action
159 * Data structure of the device to remove.
161 * 0 on success, negative on error.
163 int rte_dev_remove(struct rte_device *dev);
166 * Device comparison function.
168 * This type of function is used to compare an rte_device with arbitrary
175 * Data to compare against. The type of this parameter is determined by
176 * the kind of comparison performed by the function.
179 * 0 if the device matches the data.
180 * !0 if the device does not match.
181 * <0 if ordering is possible and the device is lower than the data.
182 * >0 if ordering is possible and the device is greater than the data.
184 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
186 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
188 #define RTE_PMD_EXPORT_NAME(name, idx) \
189 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
190 __rte_used = RTE_STR(name)
192 #define DRV_EXP_TAG(name, tag) __##name##_##tag
194 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
195 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __rte_used = \
198 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
199 static const char DRV_EXP_TAG(name, param_string_export)[] \
203 * Advertise the list of kernel modules required to run this driver
205 * This string lists the kernel modules required for the devices
206 * associated to a PMD. The format of each line of the string is:
207 * "<device-pattern> <kmod-expression>".
209 * The possible formats for the device pattern are:
210 * "*" all devices supported by this driver
211 * "pci:*" all PCI devices supported by this driver
212 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
213 * whose vendor id is 0x8086.
215 * The format of the kernel modules list is a parenthesized expression
216 * containing logical-and (&) and logical-or (|).
218 * The device pattern and the kmod expression are separated by a space.
221 * - "* igb_uio | uio_pci_generic | vfio"
223 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
224 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
230 * This context carries over the current iteration state.
232 struct rte_dev_iterator {
233 const char *dev_str; /**< device string. */
234 const char *bus_str; /**< bus-related part of device string. */
235 const char *cls_str; /**< class-related part of device string. */
236 struct rte_bus *bus; /**< bus handle. */
237 struct rte_class *cls; /**< class handle. */
238 struct rte_device *device; /**< current position. */
239 void *class_device; /**< additional specialized context. */
243 * Device iteration function.
245 * Find the next device matching properties passed in parameters.
246 * The function takes an additional ``start`` parameter, that is
247 * used as starting context when relevant.
249 * The function returns the current element in the iteration.
250 * This return value will potentially be used as a start parameter
251 * in subsequent calls to the function.
253 * The additional iterator parameter is only there if a specific
254 * implementation needs additional context. It must not be modified by
255 * the iteration function itself.
258 * Starting iteration context.
261 * Device description string.
267 * The address of the current element matching the device description
270 typedef void *(*rte_dev_iterate_t)(const void *start,
272 const struct rte_dev_iterator *it);
275 * Initializes a device iterator.
277 * This iterator allows accessing a list of devices matching a criteria.
278 * The device matching is made among all buses and classes currently registered,
279 * filtered by the device description given as parameter.
281 * This function will not allocate any memory. It is safe to stop the
282 * iteration at any moment and let the iterator go out of context.
285 * Device iterator handle.
288 * Device description string.
291 * 0 on successful initialization.
296 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
299 * Iterates on a device iterator.
301 * Generates a new rte_device handle corresponding to the next element
302 * in the list described in comprehension by the iterator.
304 * The next object is returned, and the iterator is updated.
307 * Device iterator handle.
310 * An rte_device handle if found.
311 * NULL if an error occurred (rte_errno is set).
312 * NULL if no device could be found (rte_errno is not set).
316 rte_dev_iterator_next(struct rte_dev_iterator *it);
318 #define RTE_DEV_FOREACH(dev, devstr, it) \
319 for (rte_dev_iterator_init(it, devstr), \
320 dev = rte_dev_iterator_next(it); \
322 dev = rte_dev_iterator_next(it))
330 * @b EXPERIMENTAL: this API may change without prior notice
332 * It registers the callback for the specific device.
333 * Multiple callbacks can be registered at the same time.
336 * The device name, that is the param name of the struct rte_device,
337 * null value means for all devices.
341 * address of parameter for callback.
344 * - On success, zero.
345 * - On failure, a negative value.
349 rte_dev_event_callback_register(const char *device_name,
350 rte_dev_event_cb_fn cb_fn,
355 * @b EXPERIMENTAL: this API may change without prior notice
357 * It unregisters the callback according to the specified device.
360 * The device name, that is the param name of the struct rte_device,
361 * null value means for all devices and their callbacks.
365 * address of parameter for callback, (void *)-1 means to remove all
366 * registered which has the same callback address.
369 * - On success, return the number of callback entities removed.
370 * - On failure, a negative value.
374 rte_dev_event_callback_unregister(const char *device_name,
375 rte_dev_event_cb_fn cb_fn,
380 * @b EXPERIMENTAL: this API may change without prior notice
382 * Executes all the user application registered callbacks for
383 * the specific device.
388 * the device event type.
392 rte_dev_event_callback_process(const char *device_name,
393 enum rte_dev_event_type event);
397 * @b EXPERIMENTAL: this API may change without prior notice
399 * Start the device event monitoring.
402 * - On success, zero.
403 * - On failure, a negative value.
407 rte_dev_event_monitor_start(void);
411 * @b EXPERIMENTAL: this API may change without prior notice
413 * Stop the device event monitoring.
416 * - On success, zero.
417 * - On failure, a negative value.
421 rte_dev_event_monitor_stop(void);
425 * @b EXPERIMENTAL: this API may change without prior notice
427 * Enable hotplug handling for devices.
430 * - On success, zero.
431 * - On failure, a negative value.
435 rte_dev_hotplug_handle_enable(void);
439 * @b EXPERIMENTAL: this API may change without prior notice
441 * Disable hotplug handling for devices.
444 * - On success, zero.
445 * - On failure, a negative value.
449 rte_dev_hotplug_handle_disable(void);
452 * Device level DMA map function.
453 * After a successful call, the memory segment will be mapped to the
456 * @note: Memory must be registered in advance using rte_extmem_* APIs.
461 * Virtual address to map.
463 * IOVA address to map.
465 * Length of the memory segment being mapped.
468 * 0 if mapping was successful.
469 * Negative value and rte_errno is set otherwise.
473 rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len);
476 * Device level DMA unmap function.
477 * After a successful call, the memory segment will no longer be
478 * accessible by the given device.
480 * @note: Memory must be registered in advance using rte_extmem_* APIs.
485 * Virtual address to unmap.
487 * IOVA address to unmap.
489 * Length of the memory segment being mapped.
492 * 0 if un-mapping was successful.
493 * Negative value and rte_errno is set otherwise.
497 rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
500 #endif /* _RTE_DEV_H_ */