DPDK  24.03.0-rc1
rte_dev.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2014 6WIND S.A.
3  */
4 
5 #ifndef _RTE_DEV_H_
6 #define _RTE_DEV_H_
7 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <stdio.h>
21 
22 #include <rte_config.h>
23 #include <rte_common.h>
24 #include <rte_log.h>
25 
26 struct rte_bus;
27 struct rte_devargs;
28 struct rte_device;
29 struct rte_driver;
30 
38 };
39 
40 typedef void (*rte_dev_event_cb_fn)(const char *device_name,
41  enum rte_dev_event_type event,
42  void *cb_arg);
43 
48  RTE_DEV_ALLOWED,
49  RTE_DEV_BLOCKED,
50 };
51 
56  uint64_t phys_addr;
57  uint64_t len;
58  void *addr;
59 };
60 
69 const char *
70 rte_driver_name(const struct rte_driver *driver);
71 
80 const struct rte_bus *
81 rte_dev_bus(const struct rte_device *dev);
82 
91 const char *
92 rte_dev_bus_info(const struct rte_device *dev);
93 
102 const struct rte_devargs *
103 rte_dev_devargs(const struct rte_device *dev);
104 
113 const struct rte_driver *
114 rte_dev_driver(const struct rte_device *dev);
115 
124 const char *
125 rte_dev_name(const struct rte_device *dev);
126 
135 int
136 rte_dev_numa_node(const struct rte_device *dev);
137 
138 /*
139  * Internal identifier length
140  * Sufficiently large to allow for UUID or PCI address
141  */
142 #define RTE_DEV_NAME_MAX_LEN 64
143 
152 int rte_dev_is_probed(const struct rte_device *dev);
153 
170 int rte_eal_hotplug_add(const char *busname, const char *devname,
171  const char *drvargs);
172 
184 int rte_dev_probe(const char *devargs);
185 
199 int rte_eal_hotplug_remove(const char *busname, const char *devname);
200 
212 int rte_dev_remove(struct rte_device *dev);
213 
233 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
234 
235 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
236 
237 #define RTE_PMD_EXPORT_NAME(name, idx) \
238 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
239 __rte_used = RTE_STR(name)
240 
241 #define DRV_EXP_TAG(name, tag) __##name##_##tag
242 
243 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
244 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __rte_used = \
245 RTE_STR(table)
246 
247 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
248 static const char DRV_EXP_TAG(name, param_string_export)[] \
249 __rte_used = str
250 
272 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
273 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
274 __rte_used = str
275 
282  const char *dev_str;
283  const char *bus_str;
284  const char *cls_str;
285  struct rte_bus *bus;
286  struct rte_class *cls;
287  struct rte_device *device;
288  void *class_device;
289 };
290 
319 typedef void *(*rte_dev_iterate_t)(const void *start,
320  const char *devstr,
321  const struct rte_dev_iterator *it);
322 
343 int
344 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
345 
362 struct rte_device *
364 
365 #define RTE_DEV_FOREACH(dev, devstr, it) \
366  for (rte_dev_iterator_init(it, devstr), \
367  dev = rte_dev_iterator_next(it); \
368  dev != NULL; \
369  dev = rte_dev_iterator_next(it))
370 
387 int
388 rte_dev_event_callback_register(const char *device_name,
389  rte_dev_event_cb_fn cb_fn,
390  void *cb_arg);
391 
408 int
409 rte_dev_event_callback_unregister(const char *device_name,
410  rte_dev_event_cb_fn cb_fn,
411  void *cb_arg);
412 
422 void
423 rte_dev_event_callback_process(const char *device_name,
424  enum rte_dev_event_type event);
425 
433 int
435 
443 int
445 
453 int
455 
463 int
465 
486 int
487 rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len);
488 
509 int
510 rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
511  size_t len);
512 
513 #ifdef __cplusplus
514 }
515 #endif
516 
517 #endif /* _RTE_DEV_H_ */
struct rte_device * rte_dev_iterator_next(struct rte_dev_iterator *it)
struct rte_device * device
Definition: rte_dev.h:287
int rte_dev_hotplug_handle_enable(void)
const struct rte_bus * rte_dev_bus(const struct rte_device *dev)
uint64_t len
Definition: rte_dev.h:57
int rte_dev_event_monitor_stop(void)
const char * cls_str
Definition: rte_dev.h:284
int rte_dev_is_probed(const struct rte_device *dev)
int rte_dev_event_callback_register(const char *device_name, rte_dev_event_cb_fn cb_fn, void *cb_arg)
int rte_dev_numa_node(const struct rte_device *dev)
void * addr
Definition: rte_dev.h:58
int rte_dev_event_monitor_start(void)
void * class_device
Definition: rte_dev.h:288
void rte_dev_event_callback_process(const char *device_name, enum rte_dev_event_type event)
int rte_dev_remove(struct rte_device *dev)
struct rte_class * cls
Definition: rte_dev.h:286
int rte_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova, size_t len)
rte_dev_event_type
Definition: rte_dev.h:34
int rte_dev_probe(const char *devargs)
int rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str)
const char * rte_dev_bus_info(const struct rte_device *dev)
int rte_dev_hotplug_handle_disable(void)
uint64_t phys_addr
Definition: rte_dev.h:56
int rte_eal_hotplug_add(const char *busname, const char *devname, const char *drvargs)
const char * rte_dev_name(const struct rte_device *dev)
const struct rte_devargs * rte_dev_devargs(const struct rte_device *dev)
const struct rte_driver * rte_dev_driver(const struct rte_device *dev)
const char * rte_driver_name(const struct rte_driver *driver)
int rte_dev_event_callback_unregister(const char *device_name, rte_dev_event_cb_fn cb_fn, void *cb_arg)
rte_dev_policy
Definition: rte_dev.h:47
int rte_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len)
struct rte_bus * bus
Definition: rte_dev.h:285
int rte_eal_hotplug_remove(const char *busname, const char *devname)
const char * bus_str
Definition: rte_dev.h:283
const char * dev_str
Definition: rte_dev.h:282
int(* rte_dev_cmp_t)(const struct rte_device *dev, const void *data)
Definition: rte_dev.h:233