lib/librte_eal/common/include/rte_dev.h

   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
   8 /**
   9  * @file
  10  *
  11  * RTE PMD Driver Registration Interface
  12  *
  13  * This file manages the list of device drivers.
  14  */
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #include <stdio.h>
  21 #include <sys/queue.h>
  22
  23 #include <rte_config.h>
  24 #include <rte_compat.h>
  25 #include <rte_log.h>
  26
  27 /**
  28  * The device event type.
  29  */
  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 */
  34 };
  35
  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 */
  40 };
  41
  42 typedef void (*rte_dev_event_cb_fn)(char *device_name,
  43                                         enum rte_dev_event_type event,
  44                                         void *cb_arg);
  45
  46 __attribute__((format(printf, 2, 0)))
  47 static inline void
  48 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
  49 {
  50         va_list ap;
  51
  52         va_start(ap, fmt);
  53
  54         {
  55                 char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
  56
  57                 va_end(ap);
  58
  59                 va_start(ap, fmt);
  60                 vsnprintf(buffer, sizeof(buffer), fmt, ap);
  61                 va_end(ap);
  62
  63                 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s",
  64                         func_name, buffer);
  65         }
  66 }
  67
  68 /*
  69  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
  70  * RTE_*_RET() macros defined below is compiled in debug mode.
  71  */
  72 #if defined(RTE_LIBRTE_EVENTDEV_DEBUG)
  73 #define RTE_PMD_DEBUG_TRACE(...) \
  74         rte_pmd_debug_trace(__func__, __VA_ARGS__)
  75 #else
  76 #define RTE_PMD_DEBUG_TRACE(...) (void)0
  77 #endif
  78
  79 /* Macros for checking for restricting functions to primary instance only */
  80 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
  81         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
  82                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
  83                 return retval; \
  84         } \
  85 } while (0)
  86
  87 #define RTE_PROC_PRIMARY_OR_RET() do { \
  88         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
  89                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
  90                 return; \
  91         } \
  92 } while (0)
  93
  94 /* Macros to check for invalid function pointers */
  95 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
  96         if ((func) == NULL) { \
  97                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
  98                 return retval; \
  99         } \
 100 } while (0)
 101
 102 #define RTE_FUNC_PTR_OR_RET(func) do { \
 103         if ((func) == NULL) { \
 104                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
 105                 return; \
 106         } \
 107 } while (0)
 108
 109 /**
 110  * Device driver.
 111  */
 112 enum rte_kernel_driver {
 113         RTE_KDRV_UNKNOWN = 0,
 114         RTE_KDRV_IGB_UIO,
 115         RTE_KDRV_VFIO,
 116         RTE_KDRV_UIO_GENERIC,
 117         RTE_KDRV_NIC_UIO,
 118         RTE_KDRV_NONE,
 119 };
 120
 121 /**
 122  * Device policies.
 123  */
 124 enum rte_dev_policy {
 125         RTE_DEV_WHITELISTED,
 126         RTE_DEV_BLACKLISTED,
 127 };
 128
 129 /**
 130  * A generic memory resource representation.
 131  */
 132 struct rte_mem_resource {
 133         uint64_t phys_addr; /**< Physical address, 0 if not resource. */
 134         uint64_t len;       /**< Length of the resource. */
 135         void *addr;         /**< Virtual address, NULL when not mapped. */
 136 };
 137
 138 /**
 139  * A structure describing a device driver.
 140  */
 141 struct rte_driver {
 142         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
 143         const char *name;                   /**< Driver name. */
 144         const char *alias;              /**< Driver alias. */
 145 };
 146
 147 /*
 148  * Internal identifier length
 149  * Sufficiently large to allow for UUID or PCI address
 150  */
 151 #define RTE_DEV_NAME_MAX_LEN 64
 152
 153 /**
 154  * A structure describing a generic device.
 155  */
 156 struct rte_device {
 157         TAILQ_ENTRY(rte_device) next; /**< Next device */
 158         const char *name;             /**< Device name */
 159         const struct rte_driver *driver;/**< Associated driver */
 160         const struct rte_bus *bus;    /**< Bus handle assigned on scan */
 161         int numa_node;                /**< NUMA node connection */
 162         struct rte_devargs *devargs;  /**< Device user arguments */
 163 };
 164
 165 /**
 166  * Attach a device to a registered driver.
 167  *
 168  * @param name
 169  *   The device name, that refers to a pci device (or some private
 170  *   way of designating a vdev device). Based on this device name, eal
 171  *   will identify a driver capable of handling it and pass it to the
 172  *   driver probing function.
 173  * @param devargs
 174  *   Device arguments to be passed to the driver.
 175  * @return
 176  *   0 on success, negative on error.
 177  */
 178 __rte_deprecated
 179 int rte_eal_dev_attach(const char *name, const char *devargs);
 180
 181 /**
 182  * Detach a device from its driver.
 183  *
 184  * @param dev
 185  *   A pointer to a rte_device structure.
 186  * @return
 187  *   0 on success, negative on error.
 188  */
 189 __rte_deprecated
 190 int rte_eal_dev_detach(struct rte_device *dev);
 191
 192 /**
 193  * @warning
 194  * @b EXPERIMENTAL: this API may change without prior notice
 195  *
 196  * Hotplug add a given device to a specific bus.
 197  *
 198  * @param busname
 199  *   The bus name the device is added to.
 200  * @param devname
 201  *   The device name. Based on this device name, eal will identify a driver
 202  *   capable of handling it and pass it to the driver probing function.
 203  * @param devargs
 204  *   Device arguments to be passed to the driver.
 205  * @return
 206  *   0 on success, negative on error.
 207  */
 208 int __rte_experimental rte_eal_hotplug_add(const char *busname, const char *devname,
 209                         const char *devargs);
 210
 211 /**
 212  * @warning
 213  * @b EXPERIMENTAL: this API may change without prior notice
 214  *
 215  * Hotplug remove a given device from a specific bus.
 216  *
 217  * @param busname
 218  *   The bus name the device is removed from.
 219  * @param devname
 220  *   The device name being removed.
 221  * @return
 222  *   0 on success, negative on error.
 223  */
 224 int __rte_experimental rte_eal_hotplug_remove(const char *busname,
 225                                           const char *devname);
 226
 227 /**
 228  * Device comparison function.
 229  *
 230  * This type of function is used to compare an rte_device with arbitrary
 231  * data.
 232  *
 233  * @param dev
 234  *   Device handle.
 235  *
 236  * @param data
 237  *   Data to compare against. The type of this parameter is determined by
 238  *   the kind of comparison performed by the function.
 239  *
 240  * @return
 241  *   0 if the device matches the data.
 242  *   !0 if the device does not match.
 243  *   <0 if ordering is possible and the device is lower than the data.
 244  *   >0 if ordering is possible and the device is greater than the data.
 245  */
 246 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
 247
 248 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
 249
 250 #define RTE_PMD_EXPORT_NAME(name, idx) \
 251 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
 252 __attribute__((used)) = RTE_STR(name)
 253
 254 #define DRV_EXP_TAG(name, tag) __##name##_##tag
 255
 256 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
 257 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
 258 RTE_STR(table)
 259
 260 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
 261 static const char DRV_EXP_TAG(name, param_string_export)[] \
 262 __attribute__((used)) = str
 263
 264 /**
 265  * Advertise the list of kernel modules required to run this driver
 266  *
 267  * This string lists the kernel modules required for the devices
 268  * associated to a PMD. The format of each line of the string is:
 269  * "<device-pattern> <kmod-expression>".
 270  *
 271  * The possible formats for the device pattern are:
 272  *   "*"                     all devices supported by this driver
 273  *   "pci:*"                 all PCI devices supported by this driver
 274  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
 275  *                           whose vendor id is 0x8086.
 276  *
 277  * The format of the kernel modules list is a parenthesed expression
 278  * containing logical-and (&) and logical-or (|).
 279  *
 280  * The device pattern and the kmod expression are separated by a space.
 281  *
 282  * Example:
 283  * - "* igb_uio | uio_pci_generic | vfio"
 284  */
 285 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
 286 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
 287 __attribute__((used)) = str
 288
 289 /**
 290  * Iteration context.
 291  *
 292  * This context carries over the current iteration state.
 293  */
 294 struct rte_dev_iterator {
 295         const char *dev_str; /**< device string. */
 296         const char *bus_str; /**< bus-related part of device string. */
 297         const char *cls_str; /**< class-related part of device string. */
 298         struct rte_bus *bus; /**< bus handle. */
 299         struct rte_class *cls; /**< class handle. */
 300         struct rte_device *device; /**< current position. */
 301         void *class_device; /**< additional specialized context. */
 302 };
 303
 304 /**
 305  * Device iteration function.
 306  *
 307  * Find the next device matching properties passed in parameters.
 308  * The function takes an additional ``start`` parameter, that is
 309  * used as starting context when relevant.
 310  *
 311  * The function returns the current element in the iteration.
 312  * This return value will potentially be used as a start parameter
 313  * in subsequent calls to the function.
 314  *
 315  * The additional iterator parameter is only there if a specific
 316  * implementation needs additional context. It must not be modified by
 317  * the iteration function itself.
 318  *
 319  * @param start
 320  *   Starting iteration context.
 321  *
 322  * @param devstr
 323  *   Device description string.
 324  *
 325  * @param it
 326  *   Device iterator.
 327  *
 328  * @return
 329  *   The address of the current element matching the device description
 330  *   string.
 331  */
 332 typedef void *(*rte_dev_iterate_t)(const void *start,
 333                                    const char *devstr,
 334                                    const struct rte_dev_iterator *it);
 335
 336 /**
 337  * Initializes a device iterator.
 338  *
 339  * This iterator allows accessing a list of devices matching a criteria.
 340  * The device matching is made among all buses and classes currently registered,
 341  * filtered by the device description given as parameter.
 342  *
 343  * This function will not allocate any memory. It is safe to stop the
 344  * iteration at any moment and let the iterator go out of context.
 345  *
 346  * @param it
 347  *   Device iterator handle.
 348  *
 349  * @param str
 350  *   Device description string.
 351  *
 352  * @return
 353  *   0 on successful initialization.
 354  *   <0 on error.
 355  */
 356 __rte_experimental
 357 int
 358 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
 359
 360 /**
 361  * Iterates on a device iterator.
 362  *
 363  * Generates a new rte_device handle corresponding to the next element
 364  * in the list described in comprehension by the iterator.
 365  *
 366  * The next object is returned, and the iterator is updated.
 367  *
 368  * @param it
 369  *   Device iterator handle.
 370  *
 371  * @return
 372  *   An rte_device handle if found.
 373  *   NULL if an error occurred (rte_errno is set).
 374  *   NULL if no device could be found (rte_errno is not set).
 375  */
 376 __rte_experimental
 377 struct rte_device *
 378 rte_dev_iterator_next(struct rte_dev_iterator *it);
 379
 380 #define RTE_DEV_FOREACH(dev, devstr, it) \
 381         for (rte_dev_iterator_init(it, devstr), \
 382              dev = rte_dev_iterator_next(it); \
 383              dev != NULL; \
 384              dev = rte_dev_iterator_next(it))
 385
 386 #ifdef __cplusplus
 387 }
 388 #endif
 389
 390 /**
 391  * @warning
 392  * @b EXPERIMENTAL: this API may change without prior notice
 393  *
 394  * It registers the callback for the specific device.
 395  * Multiple callbacks cal be registered at the same time.
 396  *
 397  * @param device_name
 398  *  The device name, that is the param name of the struct rte_device,
 399  *  null value means for all devices.
 400  * @param cb_fn
 401  *  callback address.
 402  * @param cb_arg
 403  *  address of parameter for callback.
 404  *
 405  * @return
 406  *  - On success, zero.
 407  *  - On failure, a negative value.
 408  */
 409 int __rte_experimental
 410 rte_dev_event_callback_register(const char *device_name,
 411                                 rte_dev_event_cb_fn cb_fn,
 412                                 void *cb_arg);
 413
 414 /**
 415  * @warning
 416  * @b EXPERIMENTAL: this API may change without prior notice
 417  *
 418  * It unregisters the callback according to the specified device.
 419  *
 420  * @param device_name
 421  *  The device name, that is the param name of the struct rte_device,
 422  *  null value means for all devices and their callbacks.
 423  * @param cb_fn
 424  *  callback address.
 425  * @param cb_arg
 426  *  address of parameter for callback, (void *)-1 means to remove all
 427  *  registered which has the same callback address.
 428  *
 429  * @return
 430  *  - On success, return the number of callback entities removed.
 431  *  - On failure, a negative value.
 432  */
 433 int __rte_experimental
 434 rte_dev_event_callback_unregister(const char *device_name,
 435                                   rte_dev_event_cb_fn cb_fn,
 436                                   void *cb_arg);
 437
 438 /**
 439  * @warning
 440  * @b EXPERIMENTAL: this API may change without prior notice
 441  *
 442  * Start the device event monitoring.
 443  *
 444  * @return
 445  *   - On success, zero.
 446  *   - On failure, a negative value.
 447  */
 448 int __rte_experimental
 449 rte_dev_event_monitor_start(void);
 450
 451 /**
 452  * @warning
 453  * @b EXPERIMENTAL: this API may change without prior notice
 454  *
 455  * Stop the device event monitoring.
 456  *
 457  * @return
 458  *   - On success, zero.
 459  *   - On failure, a negative value.
 460  */
 461 int __rte_experimental
 462 rte_dev_event_monitor_stop(void);
 463
 464 #endif /* _RTE_DEV_H_ */