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.
22 #include <rte_config.h>
23 #include <rte_compat.h>
27 * The device event type.
29 enum rte_dev_event_type {
30 RTE_DEV_EVENT_ADD, /**< device being added */
31 RTE_DEV_EVENT_REMOVE, /**< device being removed */
32 RTE_DEV_EVENT_MAX /**< max value of this enum */
35 typedef void (*rte_dev_event_cb_fn)(const char *device_name,
36 enum rte_dev_event_type event,
39 /* Macros to check for invalid function pointers */
40 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
45 #define RTE_FUNC_PTR_OR_RET(func) do { \
59 * A generic memory resource representation.
61 struct rte_mem_resource {
62 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
63 uint64_t len; /**< Length of the resource. */
64 void *addr; /**< Virtual address, NULL when not mapped. */
68 * A structure describing a device driver.
71 RTE_TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
72 const char *name; /**< Driver name. */
73 const char *alias; /**< Driver alias. */
77 * Internal identifier length
78 * Sufficiently large to allow for UUID or PCI address
80 #define RTE_DEV_NAME_MAX_LEN 64
83 * A structure describing a generic device.
86 RTE_TAILQ_ENTRY(rte_device) next; /**< Next device */
87 const char *name; /**< Device name */
88 const struct rte_driver *driver; /**< Driver assigned after probing */
89 const struct rte_bus *bus; /**< Bus handle assigned on scan */
90 int numa_node; /**< NUMA node connection */
91 struct rte_devargs *devargs; /**< Arguments for latest probing */
95 * Query status of a device.
98 * Generic device pointer.
100 * (int)true if already probed successfully, 0 otherwise.
102 int rte_dev_is_probed(const struct rte_device *dev);
105 * Hotplug add a given device to a specific bus.
107 * In multi-process, it will request other processes to add the same device.
108 * A failure, in any process, will rollback the action
111 * The bus name the device is added to.
113 * The device name. Based on this device name, eal will identify a driver
114 * capable of handling it and pass it to the driver probing function.
116 * Device arguments to be passed to the driver.
118 * 0 on success, negative on error.
120 int rte_eal_hotplug_add(const char *busname, const char *devname,
121 const char *drvargs);
124 * Add matching devices.
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 * Device arguments including bus, class and driver properties.
132 * 0 on success, negative on error.
134 int rte_dev_probe(const char *devargs);
137 * Hotplug remove a given device from a specific bus.
139 * In multi-process, it will request other processes to remove the same device.
140 * A failure, in any process, will rollback the action
143 * The bus name the device is removed from.
145 * The device name being removed.
147 * 0 on success, negative on error.
149 int rte_eal_hotplug_remove(const char *busname, const char *devname);
154 * In multi-process, it will request other processes to remove the same device.
155 * A failure, in any process, will rollback the action
158 * Data structure of the device to remove.
160 * 0 on success, negative on error.
162 int rte_dev_remove(struct rte_device *dev);
165 * Device comparison function.
167 * This type of function is used to compare an rte_device with arbitrary
174 * Data to compare against. The type of this parameter is determined by
175 * the kind of comparison performed by the function.
178 * 0 if the device matches the data.
179 * !0 if the device does not match.
180 * <0 if ordering is possible and the device is lower than the data.
181 * >0 if ordering is possible and the device is greater than the data.
183 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
185 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
187 #define RTE_PMD_EXPORT_NAME(name, idx) \
188 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
189 __rte_used = RTE_STR(name)
191 #define DRV_EXP_TAG(name, tag) __##name##_##tag
193 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
194 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __rte_used = \
197 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
198 static const char DRV_EXP_TAG(name, param_string_export)[] \
202 * Advertise the list of kernel modules required to run this driver
204 * This string lists the kernel modules required for the devices
205 * associated to a PMD. The format of each line of the string is:
206 * "<device-pattern> <kmod-expression>".
208 * The possible formats for the device pattern are:
209 * "*" all devices supported by this driver
210 * "pci:*" all PCI devices supported by this driver
211 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
212 * whose vendor id is 0x8086.
214 * The format of the kernel modules list is a parenthesized expression
215 * containing logical-and (&) and logical-or (|).
217 * The device pattern and the kmod expression are separated by a space.
220 * - "* igb_uio | uio_pci_generic | vfio"
222 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
223 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
229 * This context carries over the current iteration state.
231 struct rte_dev_iterator {
232 const char *dev_str; /**< device string. */
233 const char *bus_str; /**< bus-related part of device string. */
234 const char *cls_str; /**< class-related part of device string. */
235 struct rte_bus *bus; /**< bus handle. */
236 struct rte_class *cls; /**< class handle. */
237 struct rte_device *device; /**< current position. */
238 void *class_device; /**< additional specialized context. */
242 * Device iteration function.
244 * Find the next device matching properties passed in parameters.
245 * The function takes an additional ``start`` parameter, that is
246 * used as starting context when relevant.
248 * The function returns the current element in the iteration.
249 * This return value will potentially be used as a start parameter
250 * in subsequent calls to the function.
252 * The additional iterator parameter is only there if a specific
253 * implementation needs additional context. It must not be modified by
254 * the iteration function itself.
257 * Starting iteration context.
260 * Device description string.
266 * The address of the current element matching the device description
269 typedef void *(*rte_dev_iterate_t)(const void *start,
271 const struct rte_dev_iterator *it);
274 * Initializes a device iterator.
276 * This iterator allows accessing a list of devices matching a criteria.
277 * The device matching is made among all buses and classes currently registered,
278 * filtered by the device description given as parameter.
280 * This function will not allocate any memory. It is safe to stop the
281 * iteration at any moment and let the iterator go out of context.
284 * Device iterator handle.
287 * Device description string.
290 * 0 on successful initialization.
295 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
298 * Iterates on a device iterator.
300 * Generates a new rte_device handle corresponding to the next element
301 * in the list described in comprehension by the iterator.
303 * The next object is returned, and the iterator is updated.
306 * Device iterator handle.
309 * An rte_device handle if found.
310 * NULL if an error occurred (rte_errno is set).
311 * NULL if no device could be found (rte_errno is not set).
315 rte_dev_iterator_next(struct rte_dev_iterator *it);
317 #define RTE_DEV_FOREACH(dev, devstr, it) \
318 for (rte_dev_iterator_init(it, devstr), \
319 dev = rte_dev_iterator_next(it); \
321 dev = rte_dev_iterator_next(it))
329 * @b EXPERIMENTAL: this API may change without prior notice
331 * It registers the callback for the specific device.
332 * Multiple callbacks can be registered at the same time.
335 * The device name, that is the param name of the struct rte_device,
336 * null value means for all devices.
340 * address of parameter for callback.
343 * - On success, zero.
344 * - On failure, a negative value.
348 rte_dev_event_callback_register(const char *device_name,
349 rte_dev_event_cb_fn cb_fn,
354 * @b EXPERIMENTAL: this API may change without prior notice
356 * It unregisters the callback according to the specified device.
359 * The device name, that is the param name of the struct rte_device,
360 * null value means for all devices and their callbacks.
364 * address of parameter for callback, (void *)-1 means to remove all
365 * registered which has the same callback address.
368 * - On success, return the number of callback entities removed.
369 * - On failure, a negative value.
373 rte_dev_event_callback_unregister(const char *device_name,
374 rte_dev_event_cb_fn cb_fn,
379 * @b EXPERIMENTAL: this API may change without prior notice
381 * Executes all the user application registered callbacks for
382 * the specific device.
387 * the device event type.
391 rte_dev_event_callback_process(const char *device_name,
392 enum rte_dev_event_type event);
396 * @b EXPERIMENTAL: this API may change without prior notice
398 * Start the device event monitoring.
401 * - On success, zero.
402 * - On failure, a negative value.
406 rte_dev_event_monitor_start(void);
410 * @b EXPERIMENTAL: this API may change without prior notice
412 * Stop the device event monitoring.
415 * - On success, zero.
416 * - On failure, a negative value.
420 rte_dev_event_monitor_stop(void);
424 * @b EXPERIMENTAL: this API may change without prior notice
426 * Enable hotplug handling for devices.
429 * - On success, zero.
430 * - On failure, a negative value.
434 rte_dev_hotplug_handle_enable(void);
438 * @b EXPERIMENTAL: this API may change without prior notice
440 * Disable hotplug handling for devices.
443 * - On success, zero.
444 * - On failure, a negative value.
448 rte_dev_hotplug_handle_disable(void);
451 * Device level DMA map function.
452 * After a successful call, the memory segment will be mapped to the
455 * @note: Memory must be registered in advance using rte_extmem_* APIs.
460 * Virtual address to map.
462 * IOVA address to map.
464 * Length of the memory segment being mapped.
467 * 0 if mapping was successful.
468 * Negative value and rte_errno is set otherwise.
472 rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len);
475 * Device level DMA unmap function.
476 * After a successful call, the memory segment will no longer be
477 * accessible by the given device.
479 * @note: Memory must be registered in advance using rte_extmem_* APIs.
484 * Virtual address to unmap.
486 * IOVA address to unmap.
488 * Length of the memory segment being mapped.
491 * 0 if un-mapping was successful.
492 * Negative value and rte_errno is set otherwise.
496 rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
499 #endif /* _RTE_DEV_H_ */