1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018 Gaƫtan Rivet
11 * DPDK device class interface.
13 * This file describes the interface of the device class
16 * A device class defines the type of function a device
17 * will be used for e.g.: Ethernet adapter (eth),
18 * cryptographic co-processor (crypto), etc.
27 /** Double linked list of classes */
28 RTE_TAILQ_HEAD(rte_class_list, rte_class);
31 * A structure describing a generic device class.
34 RTE_TAILQ_ENTRY(rte_class) next; /**< Next device class in linked list */
35 const char *name; /**< Name of the class */
36 rte_dev_iterate_t dev_iterate; /**< Device iterator. */
40 * Class comparison function.
46 * Data to compare against.
49 * 0 if the class matches the data.
50 * !0 if the class does not match.
51 * <0 if ordering is possible and the class is lower than the data.
52 * >0 if ordering is possible and the class is greater than the data.
54 typedef int (*rte_class_cmp_t)(const struct rte_class *cls, const void *data);
57 * Class iterator to find a particular class.
59 * This function compares each registered class to find one that matches
60 * the data passed as parameter.
62 * If the comparison function returns zero this function will stop iterating
63 * over any more classes. To continue a search the class of a previous search
64 * can be passed via the start parameter.
67 * Starting point for the iteration.
70 * Comparison function.
73 * Data to pass to comparison function.
76 * A pointer to a rte_class structure or NULL in case no class matches
80 rte_class_find(const struct rte_class *start, rte_class_cmp_t cmp,
84 * Find the registered class for a given name.
88 rte_class_find_by_name(const char *name);
91 * Register a Class handle.
94 * A pointer to a rte_class structure describing the class
98 void rte_class_register(struct rte_class *cls);
101 * Unregister a Class handle.
104 * A pointer to a rte_class structure describing the class
105 * to be unregistered.
108 void rte_class_unregister(struct rte_class *cls);
111 * Helper for Class registration.
112 * The constructor has lower priority than Bus constructors.
113 * The constructor has higher priority than PMD constructors.
115 #define RTE_REGISTER_CLASS(nm, cls) \
116 RTE_INIT_PRIO(classinitfn_ ##nm, CLASS) \
118 (cls).name = RTE_STR(nm); \
119 rte_class_register(&cls); \
122 #define RTE_UNREGISTER_CLASS(nm, cls) \
123 RTE_FINI_PRIO(classfinifn_ ##nm, CLASS) \
125 rte_class_unregister(&cls); \
132 #endif /* _RTE_CLASS_H_ */