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 */
115 * @b EXPERIMENTAL: this API may change without prior notice
117 * Query status of a device.
120 * Generic device pointer.
122 * (int)true if already probed successfully, 0 otherwise.
125 int rte_dev_is_probed(const struct rte_device *dev);
128 * Hotplug add a given device to a specific bus.
130 * In multi-process, it will request other processes to add the same device.
131 * A failure, in any process, will rollback the action
134 * The bus name the device is added to.
136 * The device name. Based on this device name, eal will identify a driver
137 * capable of handling it and pass it to the driver probing function.
139 * Device arguments to be passed to the driver.
141 * 0 on success, negative on error.
143 int rte_eal_hotplug_add(const char *busname, const char *devname,
144 const char *drvargs);
147 * Add matching devices.
149 * In multi-process, it will request other processes to add the same device.
150 * A failure, in any process, will rollback the action
153 * Device arguments including bus, class and driver properties.
155 * 0 on success, negative on error.
157 int rte_dev_probe(const char *devargs);
160 * Hotplug remove a given device from a specific bus.
162 * In multi-process, it will request other processes to remove the same device.
163 * A failure, in any process, will rollback the action
166 * The bus name the device is removed from.
168 * The device name being removed.
170 * 0 on success, negative on error.
172 int rte_eal_hotplug_remove(const char *busname, const char *devname);
177 * In multi-process, it will request other processes to remove the same device.
178 * A failure, in any process, will rollback the action
181 * Data structure of the device to remove.
183 * 0 on success, negative on error.
185 int rte_dev_remove(struct rte_device *dev);
188 * Device comparison function.
190 * This type of function is used to compare an rte_device with arbitrary
197 * Data to compare against. The type of this parameter is determined by
198 * the kind of comparison performed by the function.
201 * 0 if the device matches the data.
202 * !0 if the device does not match.
203 * <0 if ordering is possible and the device is lower than the data.
204 * >0 if ordering is possible and the device is greater than the data.
206 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
208 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
210 #define RTE_PMD_EXPORT_NAME(name, idx) \
211 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
212 __attribute__((used)) = RTE_STR(name)
214 #define DRV_EXP_TAG(name, tag) __##name##_##tag
216 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
217 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
220 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
221 static const char DRV_EXP_TAG(name, param_string_export)[] \
222 __attribute__((used)) = str
225 * Advertise the list of kernel modules required to run this driver
227 * This string lists the kernel modules required for the devices
228 * associated to a PMD. The format of each line of the string is:
229 * "<device-pattern> <kmod-expression>".
231 * The possible formats for the device pattern are:
232 * "*" all devices supported by this driver
233 * "pci:*" all PCI devices supported by this driver
234 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
235 * whose vendor id is 0x8086.
237 * The format of the kernel modules list is a parenthesed expression
238 * containing logical-and (&) and logical-or (|).
240 * The device pattern and the kmod expression are separated by a space.
243 * - "* igb_uio | uio_pci_generic | vfio"
245 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
246 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
247 __attribute__((used)) = str
252 * This context carries over the current iteration state.
254 struct rte_dev_iterator {
255 const char *dev_str; /**< device string. */
256 const char *bus_str; /**< bus-related part of device string. */
257 const char *cls_str; /**< class-related part of device string. */
258 struct rte_bus *bus; /**< bus handle. */
259 struct rte_class *cls; /**< class handle. */
260 struct rte_device *device; /**< current position. */
261 void *class_device; /**< additional specialized context. */
265 * Device iteration function.
267 * Find the next device matching properties passed in parameters.
268 * The function takes an additional ``start`` parameter, that is
269 * used as starting context when relevant.
271 * The function returns the current element in the iteration.
272 * This return value will potentially be used as a start parameter
273 * in subsequent calls to the function.
275 * The additional iterator parameter is only there if a specific
276 * implementation needs additional context. It must not be modified by
277 * the iteration function itself.
280 * Starting iteration context.
283 * Device description string.
289 * The address of the current element matching the device description
292 typedef void *(*rte_dev_iterate_t)(const void *start,
294 const struct rte_dev_iterator *it);
297 * Initializes a device iterator.
299 * This iterator allows accessing a list of devices matching a criteria.
300 * The device matching is made among all buses and classes currently registered,
301 * filtered by the device description given as parameter.
303 * This function will not allocate any memory. It is safe to stop the
304 * iteration at any moment and let the iterator go out of context.
307 * Device iterator handle.
310 * Device description string.
313 * 0 on successful initialization.
318 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
321 * Iterates on a device iterator.
323 * Generates a new rte_device handle corresponding to the next element
324 * in the list described in comprehension by the iterator.
326 * The next object is returned, and the iterator is updated.
329 * Device iterator handle.
332 * An rte_device handle if found.
333 * NULL if an error occurred (rte_errno is set).
334 * NULL if no device could be found (rte_errno is not set).
338 rte_dev_iterator_next(struct rte_dev_iterator *it);
340 #define RTE_DEV_FOREACH(dev, devstr, it) \
341 for (rte_dev_iterator_init(it, devstr), \
342 dev = rte_dev_iterator_next(it); \
344 dev = rte_dev_iterator_next(it))
352 * @b EXPERIMENTAL: this API may change without prior notice
354 * It registers the callback for the specific device.
355 * Multiple callbacks cal be registered at the same time.
358 * The device name, that is the param name of the struct rte_device,
359 * null value means for all devices.
363 * address of parameter for callback.
366 * - On success, zero.
367 * - On failure, a negative value.
369 int __rte_experimental
370 rte_dev_event_callback_register(const char *device_name,
371 rte_dev_event_cb_fn cb_fn,
376 * @b EXPERIMENTAL: this API may change without prior notice
378 * It unregisters the callback according to the specified device.
381 * The device name, that is the param name of the struct rte_device,
382 * null value means for all devices and their callbacks.
386 * address of parameter for callback, (void *)-1 means to remove all
387 * registered which has the same callback address.
390 * - On success, return the number of callback entities removed.
391 * - On failure, a negative value.
393 int __rte_experimental
394 rte_dev_event_callback_unregister(const char *device_name,
395 rte_dev_event_cb_fn cb_fn,
400 * @b EXPERIMENTAL: this API may change without prior notice
402 * Executes all the user application registered callbacks for
403 * the specific device.
408 * the device event type.
410 void __rte_experimental
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.
424 int __rte_experimental
425 rte_dev_event_monitor_start(void);
429 * @b EXPERIMENTAL: this API may change without prior notice
431 * Stop the device event monitoring.
434 * - On success, zero.
435 * - On failure, a negative value.
437 int __rte_experimental
438 rte_dev_event_monitor_stop(void);
442 * @b EXPERIMENTAL: this API may change without prior notice
444 * Enable hotplug handling for devices.
447 * - On success, zero.
448 * - On failure, a negative value.
450 int __rte_experimental
451 rte_dev_hotplug_handle_enable(void);
455 * @b EXPERIMENTAL: this API may change without prior notice
457 * Disable hotplug handling for devices.
460 * - On success, zero.
461 * - On failure, a negative value.
463 int __rte_experimental
464 rte_dev_hotplug_handle_disable(void);
466 #endif /* _RTE_DEV_H_ */