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