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 {
79 * A generic memory resource representation.
81 struct rte_mem_resource {
82 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
83 uint64_t len; /**< Length of the resource. */
84 void *addr; /**< Virtual address, NULL when not mapped. */
88 * A structure describing a device driver.
91 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
92 const char *name; /**< Driver name. */
93 const char *alias; /**< Driver alias. */
97 * Internal identifier length
98 * Sufficiently large to allow for UUID or PCI address
100 #define RTE_DEV_NAME_MAX_LEN 64
103 * A structure describing a generic device.
106 TAILQ_ENTRY(rte_device) next; /**< Next device */
107 const char *name; /**< Device name */
108 const struct rte_driver *driver; /**< Driver assigned after probing */
109 const struct rte_bus *bus; /**< Bus handle assigned on scan */
110 int numa_node; /**< NUMA node connection */
111 struct rte_devargs *devargs; /**< Arguments for latest probing */
115 * Query status of a device.
118 * Generic device pointer.
120 * (int)true if already probed successfully, 0 otherwise.
122 int rte_dev_is_probed(const struct rte_device *dev);
125 * Hotplug add a given device to a specific bus.
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 * The bus name the device is added to.
133 * The device name. Based on this device name, eal will identify a driver
134 * capable of handling it and pass it to the driver probing function.
136 * Device arguments to be passed to the driver.
138 * 0 on success, negative on error.
140 int rte_eal_hotplug_add(const char *busname, const char *devname,
141 const char *drvargs);
144 * Add matching devices.
146 * In multi-process, it will request other processes to add the same device.
147 * A failure, in any process, will rollback the action
150 * Device arguments including bus, class and driver properties.
152 * 0 on success, negative on error.
154 int rte_dev_probe(const char *devargs);
157 * Hotplug remove a given device from a specific bus.
159 * In multi-process, it will request other processes to remove the same device.
160 * A failure, in any process, will rollback the action
163 * The bus name the device is removed from.
165 * The device name being removed.
167 * 0 on success, negative on error.
169 int rte_eal_hotplug_remove(const char *busname, const char *devname);
174 * In multi-process, it will request other processes to remove the same device.
175 * A failure, in any process, will rollback the action
178 * Data structure of the device to remove.
180 * 0 on success, negative on error.
182 int rte_dev_remove(struct rte_device *dev);
185 * Device comparison function.
187 * This type of function is used to compare an rte_device with arbitrary
194 * Data to compare against. The type of this parameter is determined by
195 * the kind of comparison performed by the function.
198 * 0 if the device matches the data.
199 * !0 if the device does not match.
200 * <0 if ordering is possible and the device is lower than the data.
201 * >0 if ordering is possible and the device is greater than the data.
203 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
205 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
207 #define RTE_PMD_EXPORT_NAME(name, idx) \
208 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
209 __attribute__((used)) = RTE_STR(name)
211 #define DRV_EXP_TAG(name, tag) __##name##_##tag
213 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
214 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
217 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
218 static const char DRV_EXP_TAG(name, param_string_export)[] \
219 __attribute__((used)) = str
222 * Advertise the list of kernel modules required to run this driver
224 * This string lists the kernel modules required for the devices
225 * associated to a PMD. The format of each line of the string is:
226 * "<device-pattern> <kmod-expression>".
228 * The possible formats for the device pattern are:
229 * "*" all devices supported by this driver
230 * "pci:*" all PCI devices supported by this driver
231 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
232 * whose vendor id is 0x8086.
234 * The format of the kernel modules list is a parenthesed expression
235 * containing logical-and (&) and logical-or (|).
237 * The device pattern and the kmod expression are separated by a space.
240 * - "* igb_uio | uio_pci_generic | vfio"
242 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
243 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
244 __attribute__((used)) = str
249 * This context carries over the current iteration state.
251 struct rte_dev_iterator {
252 const char *dev_str; /**< device string. */
253 const char *bus_str; /**< bus-related part of device string. */
254 const char *cls_str; /**< class-related part of device string. */
255 struct rte_bus *bus; /**< bus handle. */
256 struct rte_class *cls; /**< class handle. */
257 struct rte_device *device; /**< current position. */
258 void *class_device; /**< additional specialized context. */
262 * Device iteration function.
264 * Find the next device matching properties passed in parameters.
265 * The function takes an additional ``start`` parameter, that is
266 * used as starting context when relevant.
268 * The function returns the current element in the iteration.
269 * This return value will potentially be used as a start parameter
270 * in subsequent calls to the function.
272 * The additional iterator parameter is only there if a specific
273 * implementation needs additional context. It must not be modified by
274 * the iteration function itself.
277 * Starting iteration context.
280 * Device description string.
286 * The address of the current element matching the device description
289 typedef void *(*rte_dev_iterate_t)(const void *start,
291 const struct rte_dev_iterator *it);
294 * Initializes a device iterator.
296 * This iterator allows accessing a list of devices matching a criteria.
297 * The device matching is made among all buses and classes currently registered,
298 * filtered by the device description given as parameter.
300 * This function will not allocate any memory. It is safe to stop the
301 * iteration at any moment and let the iterator go out of context.
304 * Device iterator handle.
307 * Device description string.
310 * 0 on successful initialization.
315 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
318 * Iterates on a device iterator.
320 * Generates a new rte_device handle corresponding to the next element
321 * in the list described in comprehension by the iterator.
323 * The next object is returned, and the iterator is updated.
326 * Device iterator handle.
329 * An rte_device handle if found.
330 * NULL if an error occurred (rte_errno is set).
331 * NULL if no device could be found (rte_errno is not set).
335 rte_dev_iterator_next(struct rte_dev_iterator *it);
337 #define RTE_DEV_FOREACH(dev, devstr, it) \
338 for (rte_dev_iterator_init(it, devstr), \
339 dev = rte_dev_iterator_next(it); \
341 dev = rte_dev_iterator_next(it))
349 * @b EXPERIMENTAL: this API may change without prior notice
351 * It registers the callback for the specific device.
352 * Multiple callbacks can be registered at the same time.
355 * The device name, that is the param name of the struct rte_device,
356 * null value means for all devices.
360 * address of parameter for callback.
363 * - On success, zero.
364 * - On failure, a negative value.
368 rte_dev_event_callback_register(const char *device_name,
369 rte_dev_event_cb_fn cb_fn,
374 * @b EXPERIMENTAL: this API may change without prior notice
376 * It unregisters the callback according to the specified device.
379 * The device name, that is the param name of the struct rte_device,
380 * null value means for all devices and their callbacks.
384 * address of parameter for callback, (void *)-1 means to remove all
385 * registered which has the same callback address.
388 * - On success, return the number of callback entities removed.
389 * - On failure, a negative value.
393 rte_dev_event_callback_unregister(const char *device_name,
394 rte_dev_event_cb_fn cb_fn,
399 * @b EXPERIMENTAL: this API may change without prior notice
401 * Executes all the user application registered callbacks for
402 * the specific device.
407 * the device event type.
411 rte_dev_event_callback_process(const char *device_name,
412 enum rte_dev_event_type event);
416 * @b EXPERIMENTAL: this API may change without prior notice
418 * Start the device event monitoring.
421 * - On success, zero.
422 * - On failure, a negative value.
426 rte_dev_event_monitor_start(void);
430 * @b EXPERIMENTAL: this API may change without prior notice
432 * Stop the device event monitoring.
435 * - On success, zero.
436 * - On failure, a negative value.
440 rte_dev_event_monitor_stop(void);
444 * @b EXPERIMENTAL: this API may change without prior notice
446 * Enable hotplug handling for devices.
449 * - On success, zero.
450 * - On failure, a negative value.
454 rte_dev_hotplug_handle_enable(void);
458 * @b EXPERIMENTAL: this API may change without prior notice
460 * Disable hotplug handling for devices.
463 * - On success, zero.
464 * - On failure, a negative value.
468 rte_dev_hotplug_handle_disable(void);
471 * Device level DMA map function.
472 * After a successful call, the memory segment will be mapped to the
475 * @note: Memory must be registered in advance using rte_extmem_* APIs.
480 * Virtual address to map.
482 * IOVA address to map.
484 * Length of the memory segment being mapped.
487 * 0 if mapping was successful.
488 * Negative value and rte_errno is set otherwise.
492 rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len);
495 * Device level DMA unmap function.
496 * After a successful call, the memory segment will no longer be
497 * accessible by the given device.
499 * @note: Memory must be registered in advance using rte_extmem_* APIs.
504 * Virtual address to unmap.
506 * IOVA address to unmap.
508 * Length of the memory segment being mapped.
511 * 0 if un-mapping was successful.
512 * Negative value and rte_errno is set otherwise.
516 rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
519 #endif /* _RTE_DEV_H_ */