lib/librte_eal/common/include/rte_pci.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 /*   BSD LICENSE
  34  *
  35  *   Copyright 2013-2014 6WIND S.A.
  36  *
  37  *   Redistribution and use in source and binary forms, with or without
  38  *   modification, are permitted provided that the following conditions
  39  *   are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in
  45  *       the documentation and/or other materials provided with the
  46  *       distribution.
  47  *     * Neither the name of 6WIND S.A. nor the names of its
  48  *       contributors may be used to endorse or promote products derived
  49  *       from this software without specific prior written permission.
  50  *
  51  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  52  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  53  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  54  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  55  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  56  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  57  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  58  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  59  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  61  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62  */
  63
  64 #ifndef _RTE_PCI_H_
  65 #define _RTE_PCI_H_
  66
  67 /**
  68  * @file
  69  *
  70  * RTE PCI Interface
  71  */
  72
  73 #ifdef __cplusplus
  74 extern "C" {
  75 #endif
  76
  77 #include <stdio.h>
  78 #include <stdlib.h>
  79 #include <limits.h>
  80 #include <errno.h>
  81 #include <sys/queue.h>
  82 #include <stdint.h>
  83 #include <inttypes.h>
  84
  85 #include <rte_interrupts.h>
  86
  87 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
  88 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
  89
  90 extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
  91 extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
  92
  93 /** Pathname of PCI devices directory. */
  94 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
  95
  96 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
  97 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
  98
  99 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
 100 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
 101
 102 /** Nb. of values in PCI device identifier format string. */
 103 #define PCI_FMT_NVAL 4
 104
 105 /** Nb. of values in PCI resource format. */
 106 #define PCI_RESOURCE_FMT_NVAL 3
 107
 108 /** IO resource type: memory address space */
 109 #define IORESOURCE_MEM        0x00000200
 110
 111 /**
 112  * A structure describing a PCI resource.
 113  */
 114 struct rte_pci_resource {
 115         uint64_t phys_addr;   /**< Physical address, 0 if no resource. */
 116         uint64_t len;         /**< Length of the resource. */
 117         void *addr;           /**< Virtual address, NULL when not mapped. */
 118 };
 119
 120 /** Maximum number of PCI resources. */
 121 #define PCI_MAX_RESOURCE 6
 122
 123 /**
 124  * A structure describing an ID for a PCI driver. Each driver provides a
 125  * table of these IDs for each device that it supports.
 126  */
 127 struct rte_pci_id {
 128         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
 129         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
 130         uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
 131         uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
 132 };
 133
 134 /**
 135  * A structure describing the location of a PCI device.
 136  */
 137 struct rte_pci_addr {
 138         uint16_t domain;                /**< Device domain */
 139         uint8_t bus;                    /**< Device bus */
 140         uint8_t devid;                  /**< Device ID */
 141         uint8_t function;               /**< Device function. */
 142 };
 143
 144 struct rte_devargs;
 145
 146 enum rte_kernel_driver {
 147         RTE_KDRV_UNKNOWN = 0,
 148         RTE_KDRV_IGB_UIO,
 149         RTE_KDRV_VFIO,
 150         RTE_KDRV_UIO_GENERIC,
 151         RTE_KDRV_NIC_UIO,
 152         RTE_KDRV_NONE,
 153 };
 154
 155 /**
 156  * A structure describing a PCI device.
 157  */
 158 struct rte_pci_device {
 159         TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
 160         struct rte_pci_addr addr;               /**< PCI location. */
 161         struct rte_pci_id id;                   /**< PCI ID. */
 162         struct rte_pci_resource mem_resource[PCI_MAX_RESOURCE];   /**< PCI Memory Resource */
 163         struct rte_intr_handle intr_handle;     /**< Interrupt handle */
 164         struct rte_pci_driver *driver;          /**< Associated driver */
 165         uint16_t max_vfs;                       /**< sriov enable if not zero */
 166         int numa_node;                          /**< NUMA node connection */
 167         struct rte_devargs *devargs;            /**< Device user arguments */
 168         enum rte_kernel_driver kdrv;            /**< Kernel driver passthrough */
 169 };
 170
 171 /** Any PCI device identifier (vendor, device, ...) */
 172 #define PCI_ANY_ID (0xffff)
 173
 174 #ifdef __cplusplus
 175 /** C++ macro used to help building up tables of device IDs */
 176 #define RTE_PCI_DEVICE(vend, dev) \
 177         (vend),                   \
 178         (dev),                    \
 179         PCI_ANY_ID,               \
 180         PCI_ANY_ID
 181 #else
 182 /** Macro used to help building up tables of device IDs */
 183 #define RTE_PCI_DEVICE(vend, dev)          \
 184         .vendor_id = (vend),               \
 185         .device_id = (dev),                \
 186         .subsystem_vendor_id = PCI_ANY_ID, \
 187         .subsystem_device_id = PCI_ANY_ID
 188 #endif
 189
 190 struct rte_pci_driver;
 191
 192 /**
 193  * Initialisation function for the driver called during PCI probing.
 194  */
 195 typedef int (pci_devinit_t)(struct rte_pci_driver *, struct rte_pci_device *);
 196
 197 /**
 198  * Uninitialisation function for the driver called during hotplugging.
 199  */
 200 typedef int (pci_devuninit_t)(struct rte_pci_device *);
 201
 202 /**
 203  * A structure describing a PCI driver.
 204  */
 205 struct rte_pci_driver {
 206         TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
 207         const char *name;                       /**< Driver name. */
 208         pci_devinit_t *devinit;                 /**< Device init. function. */
 209         pci_devuninit_t *devuninit;             /**< Device uninit function. */
 210         const struct rte_pci_id *id_table;      /**< ID table, NULL terminated. */
 211         uint32_t drv_flags;                     /**< Flags contolling handling of device. */
 212 };
 213
 214 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
 215 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
 216 /** Device needs to be unbound even if no module is provided */
 217 #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
 218 /** Device driver supports link state interrupt */
 219 #define RTE_PCI_DRV_INTR_LSC    0x0008
 220 /** Device driver supports detaching capability */
 221 #define RTE_PCI_DRV_DETACHABLE  0x0010
 222
 223 /**
 224  * A structure describing a PCI mapping.
 225  */
 226 struct pci_map {
 227         void *addr;
 228         char *path;
 229         uint64_t offset;
 230         uint64_t size;
 231         uint64_t phaddr;
 232 };
 233
 234 /**
 235  * A structure describing a mapped PCI resource.
 236  * For multi-process we need to reproduce all PCI mappings in secondary
 237  * processes, so save them in a tailq.
 238  */
 239 struct mapped_pci_resource {
 240         TAILQ_ENTRY(mapped_pci_resource) next;
 241
 242         struct rte_pci_addr pci_addr;
 243         char path[PATH_MAX];
 244         int nb_maps;
 245         struct pci_map maps[PCI_MAX_RESOURCE];
 246 };
 247
 248 /** mapped pci device list */
 249 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
 250
 251 /**< Internal use only - Macro used by pci addr parsing functions **/
 252 #define GET_PCIADDR_FIELD(in, fd, lim, dlm)                   \
 253 do {                                                               \
 254         unsigned long val;                                      \
 255         char *end;                                              \
 256         errno = 0;                                              \
 257         val = strtoul((in), &end, 16);                          \
 258         if (errno != 0 || end[0] != (dlm) || val > (lim))       \
 259                 return -EINVAL;                                 \
 260         (fd) = (typeof (fd))val;                                \
 261         (in) = end + 1;                                         \
 262 } while(0)
 263
 264 /**
 265  * Utility function to produce a PCI Bus-Device-Function value
 266  * given a string representation. Assumes that the BDF is provided without
 267  * a domain prefix (i.e. domain returned is always 0)
 268  *
 269  * @param input
 270  *      The input string to be parsed. Should have the format XX:XX.X
 271  * @param dev_addr
 272  *      The PCI Bus-Device-Function address to be returned. Domain will always be
 273  *      returned as 0
 274  * @return
 275  *  0 on success, negative on error.
 276  */
 277 static inline int
 278 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
 279 {
 280         dev_addr->domain = 0;
 281         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
 282         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
 283         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
 284         return 0;
 285 }
 286
 287 /**
 288  * Utility function to produce a PCI Bus-Device-Function value
 289  * given a string representation. Assumes that the BDF is provided including
 290  * a domain prefix.
 291  *
 292  * @param input
 293  *      The input string to be parsed. Should have the format XXXX:XX:XX.X
 294  * @param dev_addr
 295  *      The PCI Bus-Device-Function address to be returned
 296  * @return
 297  *  0 on success, negative on error.
 298  */
 299 static inline int
 300 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
 301 {
 302         GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
 303         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
 304         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
 305         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
 306         return 0;
 307 }
 308 #undef GET_PCIADDR_FIELD
 309
 310 /* Compare two PCI device addresses. */
 311 /**
 312  * Utility function to compare two PCI device addresses.
 313  *
 314  * @param addr
 315  *      The PCI Bus-Device-Function address to compare
 316  * @param addr2
 317  *      The PCI Bus-Device-Function address to compare
 318  * @return
 319  *      0 on equal PCI address.
 320  *      Positive on addr is greater than addr2.
 321  *      Negative on addr is less than addr2, or error.
 322  */
 323 static inline int
 324 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
 325                          const struct rte_pci_addr *addr2)
 326 {
 327         uint64_t dev_addr, dev_addr2;
 328
 329         if ((addr == NULL) || (addr2 == NULL))
 330                 return -1;
 331
 332         dev_addr = (addr->domain << 24) | (addr->bus << 16) |
 333                                 (addr->devid << 8) | addr->function;
 334         dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
 335                                 (addr2->devid << 8) | addr2->function;
 336
 337         if (dev_addr > dev_addr2)
 338                 return 1;
 339         else if (dev_addr < dev_addr2)
 340                 return -1;
 341         else
 342                 return 0;
 343 }
 344
 345 /**
 346  * Scan the content of the PCI bus, and the devices in the devices
 347  * list
 348  *
 349  * @return
 350  *  0 on success, negative on error
 351  */
 352 int rte_eal_pci_scan(void);
 353
 354 /**
 355  * Probe the PCI bus for registered drivers.
 356  *
 357  * Scan the content of the PCI bus, and call the probe() function for
 358  * all registered drivers that have a matching entry in its id_table
 359  * for discovered devices.
 360  *
 361  * @return
 362  *   - 0 on success.
 363  *   - Negative on error.
 364  */
 365 int rte_eal_pci_probe(void);
 366
 367 /**
 368  * Map the PCI device resources in user space virtual memory address
 369  *
 370  * Note that driver should not call this function when flag
 371  * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
 372  * you when it's on.
 373  *
 374  * @param dev
 375  *   A pointer to a rte_pci_device structure describing the device
 376  *   to use
 377  *
 378  * @return
 379  *   0 on success, negative on error and positive if no driver
 380  *   is found for the device.
 381  */
 382 int rte_eal_pci_map_device(struct rte_pci_device *dev);
 383
 384 /**
 385  * Unmap this device
 386  *
 387  * @param dev
 388  *   A pointer to a rte_pci_device structure describing the device
 389  *   to use
 390  */
 391 void rte_eal_pci_unmap_device(struct rte_pci_device *dev);
 392
 393 /**
 394  * @internal
 395  * Map a particular resource from a file.
 396  *
 397  * @param requested_addr
 398  *      The starting address for the new mapping range.
 399  * @param fd
 400  *      The file descriptor.
 401  * @param offset
 402  *      The offset for the mapping range.
 403  * @param size
 404  *      The size for the mapping range.
 405  * @param additional_flags
 406  *      The additional flags for the mapping range.
 407  * @return
 408  *   - On success, the function returns a pointer to the mapped area.
 409  *   - On error, the value MAP_FAILED is returned.
 410  */
 411 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
 412                 size_t size, int additional_flags);
 413
 414 /**
 415  * @internal
 416  * Unmap a particular resource.
 417  *
 418  * @param requested_addr
 419  *      The address for the unmapping range.
 420  * @param size
 421  *      The size for the unmapping range.
 422  */
 423 void pci_unmap_resource(void *requested_addr, size_t size);
 424
 425 /**
 426  * Probe the single PCI device.
 427  *
 428  * Scan the content of the PCI bus, and find the pci device specified by pci
 429  * address, then call the probe() function for registered driver that has a
 430  * matching entry in its id_table for discovered device.
 431  *
 432  * @param addr
 433  *      The PCI Bus-Device-Function address to probe.
 434  * @return
 435  *   - 0 on success.
 436  *   - Negative on error.
 437  */
 438 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
 439
 440 /**
 441  * Close the single PCI device.
 442  *
 443  * Scan the content of the PCI bus, and find the pci device specified by pci
 444  * address, then call the devuninit() function for registered driver that has a
 445  * matching entry in its id_table for discovered device.
 446  *
 447  * @param addr
 448  *      The PCI Bus-Device-Function address to close.
 449  * @return
 450  *   - 0 on success.
 451  *   - Negative on error.
 452  */
 453 int rte_eal_pci_detach(const struct rte_pci_addr *addr);
 454
 455 /**
 456  * Dump the content of the PCI bus.
 457  *
 458  * @param f
 459  *   A pointer to a file for output
 460  */
 461 void rte_eal_pci_dump(FILE *f);
 462
 463 /**
 464  * Register a PCI driver.
 465  *
 466  * @param driver
 467  *   A pointer to a rte_pci_driver structure describing the driver
 468  *   to be registered.
 469  */
 470 void rte_eal_pci_register(struct rte_pci_driver *driver);
 471
 472 /**
 473  * Unregister a PCI driver.
 474  *
 475  * @param driver
 476  *   A pointer to a rte_pci_driver structure describing the driver
 477  *   to be unregistered.
 478  */
 479 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
 480
 481 /**
 482  * Read PCI config space.
 483  *
 484  * @param device
 485  *   A pointer to a rte_pci_device structure describing the device
 486  *   to use
 487  * @param buf
 488  *   A data buffer where the bytes should be read into
 489  * @param len
 490  *   The length of the data buffer.
 491  * @param offset
 492  *   The offset into PCI config space
 493  */
 494 int rte_eal_pci_read_config(const struct rte_pci_device *device,
 495                             void *buf, size_t len, off_t offset);
 496
 497 /**
 498  * Write PCI config space.
 499  *
 500  * @param device
 501  *   A pointer to a rte_pci_device structure describing the device
 502  *   to use
 503  * @param buf
 504  *   A data buffer containing the bytes should be written
 505  * @param len
 506  *   The length of the data buffer.
 507  * @param offset
 508  *   The offset into PCI config space
 509  */
 510 int rte_eal_pci_write_config(const struct rte_pci_device *device,
 511                              const void *buf, size_t len, off_t offset);
 512
 513 /**
 514  * A structure used to access io resources for a pci device.
 515  * rte_pci_ioport is arch, os, driver specific, and should not be used outside
 516  * of pci ioport api.
 517  */
 518 struct rte_pci_ioport {
 519         struct rte_pci_device *dev;
 520         uint64_t base;
 521 };
 522
 523 /**
 524  * Initialises a rte_pci_ioport object for a pci device io resource.
 525  * This object is then used to gain access to those io resources (see below).
 526  *
 527  * @param dev
 528  *   A pointer to a rte_pci_device structure describing the device.
 529  *   to use
 530  * @param bar
 531  *   Index of the io pci resource we want to access.
 532  * @param p
 533  *   The rte_pci_ioport object to be initialized.
 534  * @return
 535  *  0 on success, negative on error.
 536  */
 537 int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
 538                            struct rte_pci_ioport *p);
 539
 540 /**
 541  * Release any resources used in a rte_pci_ioport object.
 542  *
 543  * @param p
 544  *   The rte_pci_ioport object to be uninitialized.
 545  */
 546 int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p);
 547
 548 /**
 549  * Read from a io pci resource.
 550  *
 551  * @param p
 552  *   The rte_pci_ioport object from which we want to read.
 553  * @param data
 554  *   A data buffer where the bytes should be read into
 555  * @param len
 556  *   The length of the data buffer.
 557  * @param offset
 558  *   The offset into the pci io resource.
 559  */
 560 void rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
 561                              void *data, size_t len, off_t offset);
 562
 563 /**
 564  * Write to a io pci resource.
 565  *
 566  * @param p
 567  *   The rte_pci_ioport object to which we want to write.
 568  * @param data
 569  *   A data buffer where the bytes should be read into
 570  * @param len
 571  *   The length of the data buffer.
 572  * @param offset
 573  *   The offset into the pci io resource.
 574  */
 575 void rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
 576                               const void *data, size_t len, off_t offset);
 577
 578 #ifdef __cplusplus
 579 }
 580 #endif
 581
 582 #endif /* _RTE_PCI_H_ */