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)(const 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  * Hotplug add a given device to a specific bus.
 194  *
 195  * In multi-process, it will request other processes to add the same device.
 196  * A failure, in any process, will rollback the action
 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 drvargs
 204  *   Device arguments to be passed to the driver.
 205  * @return
 206  *   0 on success, negative on error.
 207  */
 208 int rte_eal_hotplug_add(const char *busname, const char *devname,
 209                         const char *drvargs);
 210
 211 /**
 212  * @warning
 213  * @b EXPERIMENTAL: this API may change without prior notice
 214  *
 215  * Add matching devices.
 216  *
 217  * In multi-process, it will request other processes to add the same device.
 218  * A failure, in any process, will rollback the action
 219  *
 220  * @param devargs
 221  *   Device arguments including bus, class and driver properties.
 222  * @return
 223  *   0 on success, negative on error.
 224  */
 225 int __rte_experimental rte_dev_probe(const char *devargs);
 226
 227 /**
 228  * Hotplug remove a given device from a specific bus.
 229  *
 230  * In multi-process, it will request other processes to remove the same device.
 231  * A failure, in any process, will rollback the action
 232  *
 233  * @param busname
 234  *   The bus name the device is removed from.
 235  * @param devname
 236  *   The device name being removed.
 237  * @return
 238  *   0 on success, negative on error.
 239  */
 240 int rte_eal_hotplug_remove(const char *busname, const char *devname);
 241
 242 /**
 243  * @warning
 244  * @b EXPERIMENTAL: this API may change without prior notice
 245  *
 246  * Remove one device.
 247  *
 248  * In multi-process, it will request other processes to remove the same device.
 249  * A failure, in any process, will rollback the action
 250  *
 251  * @param dev
 252  *   Data structure of the device to remove.
 253  * @return
 254  *   0 on success, negative on error.
 255  */
 256 int __rte_experimental rte_dev_remove(struct rte_device *dev);
 257
 258 /**
 259  * Device comparison function.
 260  *
 261  * This type of function is used to compare an rte_device with arbitrary
 262  * data.
 263  *
 264  * @param dev
 265  *   Device handle.
 266  *
 267  * @param data
 268  *   Data to compare against. The type of this parameter is determined by
 269  *   the kind of comparison performed by the function.
 270  *
 271  * @return
 272  *   0 if the device matches the data.
 273  *   !0 if the device does not match.
 274  *   <0 if ordering is possible and the device is lower than the data.
 275  *   >0 if ordering is possible and the device is greater than the data.
 276  */
 277 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
 278
 279 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
 280
 281 #define RTE_PMD_EXPORT_NAME(name, idx) \
 282 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
 283 __attribute__((used)) = RTE_STR(name)
 284
 285 #define DRV_EXP_TAG(name, tag) __##name##_##tag
 286
 287 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
 288 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
 289 RTE_STR(table)
 290
 291 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
 292 static const char DRV_EXP_TAG(name, param_string_export)[] \
 293 __attribute__((used)) = str
 294
 295 /**
 296  * Advertise the list of kernel modules required to run this driver
 297  *
 298  * This string lists the kernel modules required for the devices
 299  * associated to a PMD. The format of each line of the string is:
 300  * "<device-pattern> <kmod-expression>".
 301  *
 302  * The possible formats for the device pattern are:
 303  *   "*"                     all devices supported by this driver
 304  *   "pci:*"                 all PCI devices supported by this driver
 305  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
 306  *                           whose vendor id is 0x8086.
 307  *
 308  * The format of the kernel modules list is a parenthesed expression
 309  * containing logical-and (&) and logical-or (|).
 310  *
 311  * The device pattern and the kmod expression are separated by a space.
 312  *
 313  * Example:
 314  * - "* igb_uio | uio_pci_generic | vfio"
 315  */
 316 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
 317 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
 318 __attribute__((used)) = str
 319
 320 /**
 321  * Iteration context.
 322  *
 323  * This context carries over the current iteration state.
 324  */
 325 struct rte_dev_iterator {
 326         const char *dev_str; /**< device string. */
 327         const char *bus_str; /**< bus-related part of device string. */
 328         const char *cls_str; /**< class-related part of device string. */
 329         struct rte_bus *bus; /**< bus handle. */
 330         struct rte_class *cls; /**< class handle. */
 331         struct rte_device *device; /**< current position. */
 332         void *class_device; /**< additional specialized context. */
 333 };
 334
 335 /**
 336  * Device iteration function.
 337  *
 338  * Find the next device matching properties passed in parameters.
 339  * The function takes an additional ``start`` parameter, that is
 340  * used as starting context when relevant.
 341  *
 342  * The function returns the current element in the iteration.
 343  * This return value will potentially be used as a start parameter
 344  * in subsequent calls to the function.
 345  *
 346  * The additional iterator parameter is only there if a specific
 347  * implementation needs additional context. It must not be modified by
 348  * the iteration function itself.
 349  *
 350  * @param start
 351  *   Starting iteration context.
 352  *
 353  * @param devstr
 354  *   Device description string.
 355  *
 356  * @param it
 357  *   Device iterator.
 358  *
 359  * @return
 360  *   The address of the current element matching the device description
 361  *   string.
 362  */
 363 typedef void *(*rte_dev_iterate_t)(const void *start,
 364                                    const char *devstr,
 365                                    const struct rte_dev_iterator *it);
 366
 367 /**
 368  * Initializes a device iterator.
 369  *
 370  * This iterator allows accessing a list of devices matching a criteria.
 371  * The device matching is made among all buses and classes currently registered,
 372  * filtered by the device description given as parameter.
 373  *
 374  * This function will not allocate any memory. It is safe to stop the
 375  * iteration at any moment and let the iterator go out of context.
 376  *
 377  * @param it
 378  *   Device iterator handle.
 379  *
 380  * @param str
 381  *   Device description string.
 382  *
 383  * @return
 384  *   0 on successful initialization.
 385  *   <0 on error.
 386  */
 387 __rte_experimental
 388 int
 389 rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);
 390
 391 /**
 392  * Iterates on a device iterator.
 393  *
 394  * Generates a new rte_device handle corresponding to the next element
 395  * in the list described in comprehension by the iterator.
 396  *
 397  * The next object is returned, and the iterator is updated.
 398  *
 399  * @param it
 400  *   Device iterator handle.
 401  *
 402  * @return
 403  *   An rte_device handle if found.
 404  *   NULL if an error occurred (rte_errno is set).
 405  *   NULL if no device could be found (rte_errno is not set).
 406  */
 407 __rte_experimental
 408 struct rte_device *
 409 rte_dev_iterator_next(struct rte_dev_iterator *it);
 410
 411 #define RTE_DEV_FOREACH(dev, devstr, it) \
 412         for (rte_dev_iterator_init(it, devstr), \
 413              dev = rte_dev_iterator_next(it); \
 414              dev != NULL; \
 415              dev = rte_dev_iterator_next(it))
 416
 417 #ifdef __cplusplus
 418 }
 419 #endif
 420
 421 /**
 422  * @warning
 423  * @b EXPERIMENTAL: this API may change without prior notice
 424  *
 425  * It registers the callback for the specific device.
 426  * Multiple callbacks cal be registered at the same time.
 427  *
 428  * @param device_name
 429  *  The device name, that is the param name of the struct rte_device,
 430  *  null value means for all devices.
 431  * @param cb_fn
 432  *  callback address.
 433  * @param cb_arg
 434  *  address of parameter for callback.
 435  *
 436  * @return
 437  *  - On success, zero.
 438  *  - On failure, a negative value.
 439  */
 440 int __rte_experimental
 441 rte_dev_event_callback_register(const char *device_name,
 442                                 rte_dev_event_cb_fn cb_fn,
 443                                 void *cb_arg);
 444
 445 /**
 446  * @warning
 447  * @b EXPERIMENTAL: this API may change without prior notice
 448  *
 449  * It unregisters the callback according to the specified device.
 450  *
 451  * @param device_name
 452  *  The device name, that is the param name of the struct rte_device,
 453  *  null value means for all devices and their callbacks.
 454  * @param cb_fn
 455  *  callback address.
 456  * @param cb_arg
 457  *  address of parameter for callback, (void *)-1 means to remove all
 458  *  registered which has the same callback address.
 459  *
 460  * @return
 461  *  - On success, return the number of callback entities removed.
 462  *  - On failure, a negative value.
 463  */
 464 int __rte_experimental
 465 rte_dev_event_callback_unregister(const char *device_name,
 466                                   rte_dev_event_cb_fn cb_fn,
 467                                   void *cb_arg);
 468
 469 /**
 470  * @warning
 471  * @b EXPERIMENTAL: this API may change without prior notice
 472  *
 473  * Executes all the user application registered callbacks for
 474  * the specific device.
 475  *
 476  * @param device_name
 477  *  The device name.
 478  * @param event
 479  *  the device event type.
 480  */
 481 void  __rte_experimental
 482 rte_dev_event_callback_process(const char *device_name,
 483                                enum rte_dev_event_type event);
 484
 485 /**
 486  * @warning
 487  * @b EXPERIMENTAL: this API may change without prior notice
 488  *
 489  * Start the device event monitoring.
 490  *
 491  * @return
 492  *   - On success, zero.
 493  *   - On failure, a negative value.
 494  */
 495 int __rte_experimental
 496 rte_dev_event_monitor_start(void);
 497
 498 /**
 499  * @warning
 500  * @b EXPERIMENTAL: this API may change without prior notice
 501  *
 502  * Stop the device event monitoring.
 503  *
 504  * @return
 505  *   - On success, zero.
 506  *   - On failure, a negative value.
 507  */
 508 int __rte_experimental
 509 rte_dev_event_monitor_stop(void);
 510
 511 /**
 512  * @warning
 513  * @b EXPERIMENTAL: this API may change without prior notice
 514  *
 515  * Enable hotplug handling for devices.
 516  *
 517  * @return
 518  *   - On success, zero.
 519  *   - On failure, a negative value.
 520  */
 521 int __rte_experimental
 522 rte_dev_hotplug_handle_enable(void);
 523
 524 /**
 525  * @warning
 526  * @b EXPERIMENTAL: this API may change without prior notice
 527  *
 528  * Disable hotplug handling for devices.
 529  *
 530  * @return
 531  *   - On success, zero.
 532  *   - On failure, a negative value.
 533  */
 534 int __rte_experimental
 535 rte_dev_hotplug_handle_disable(void);
 536
 537 #endif /* _RTE_DEV_H_ */