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_debug.h>
  86 #include <rte_interrupts.h>
  87 #include <rte_dev.h>
  88
  89 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
  90 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
  91
  92 extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
  93 extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
  94
  95 /** Pathname of PCI devices directory. */
  96 const char *pci_get_sysfs_path(void);
  97
  98 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
  99 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
 100 #define PCI_PRI_STR_SIZE sizeof("XXXX:XX:XX.X")
 101
 102 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
 103 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
 104
 105 /** Nb. of values in PCI device identifier format string. */
 106 #define PCI_FMT_NVAL 4
 107
 108 /** Nb. of values in PCI resource format. */
 109 #define PCI_RESOURCE_FMT_NVAL 3
 110
 111 /** Maximum number of PCI resources. */
 112 #define PCI_MAX_RESOURCE 6
 113
 114 /**
 115  * A structure describing an ID for a PCI driver. Each driver provides a
 116  * table of these IDs for each device that it supports.
 117  */
 118 struct rte_pci_id {
 119         uint32_t class_id;            /**< Class ID (class, subclass, pi) or RTE_CLASS_ANY_ID. */
 120         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
 121         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
 122         uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
 123         uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
 124 };
 125
 126 /**
 127  * A structure describing the location of a PCI device.
 128  */
 129 struct rte_pci_addr {
 130         uint16_t domain;                /**< Device domain */
 131         uint8_t bus;                    /**< Device bus */
 132         uint8_t devid;                  /**< Device ID */
 133         uint8_t function;               /**< Device function. */
 134 };
 135
 136 struct rte_devargs;
 137
 138 enum rte_kernel_driver {
 139         RTE_KDRV_UNKNOWN = 0,
 140         RTE_KDRV_IGB_UIO,
 141         RTE_KDRV_VFIO,
 142         RTE_KDRV_UIO_GENERIC,
 143         RTE_KDRV_NIC_UIO,
 144         RTE_KDRV_NONE,
 145 };
 146
 147 /**
 148  * A structure describing a PCI device.
 149  */
 150 struct rte_pci_device {
 151         TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
 152         struct rte_device device;               /**< Inherit core device */
 153         struct rte_pci_addr addr;               /**< PCI location. */
 154         struct rte_pci_id id;                   /**< PCI ID. */
 155         struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
 156                                                 /**< PCI Memory Resource */
 157         struct rte_intr_handle intr_handle;     /**< Interrupt handle */
 158         struct rte_pci_driver *driver;          /**< Associated driver */
 159         uint16_t max_vfs;                       /**< sriov enable if not zero */
 160         enum rte_kernel_driver kdrv;            /**< Kernel driver passthrough */
 161 };
 162
 163 /** Any PCI device identifier (vendor, device, ...) */
 164 #define PCI_ANY_ID (0xffff)
 165 #define RTE_CLASS_ANY_ID (0xffffff)
 166
 167 #ifdef __cplusplus
 168 /** C++ macro used to help building up tables of device IDs */
 169 #define RTE_PCI_DEVICE(vend, dev) \
 170         RTE_CLASS_ANY_ID,         \
 171         (vend),                   \
 172         (dev),                    \
 173         PCI_ANY_ID,               \
 174         PCI_ANY_ID
 175 #else
 176 /** Macro used to help building up tables of device IDs */
 177 #define RTE_PCI_DEVICE(vend, dev)          \
 178         .class_id = RTE_CLASS_ANY_ID,      \
 179         .vendor_id = (vend),               \
 180         .device_id = (dev),                \
 181         .subsystem_vendor_id = PCI_ANY_ID, \
 182         .subsystem_device_id = PCI_ANY_ID
 183 #endif
 184
 185 struct rte_pci_driver;
 186
 187 /**
 188  * Initialisation function for the driver called during PCI probing.
 189  */
 190 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
 191
 192 /**
 193  * Uninitialisation function for the driver called during hotplugging.
 194  */
 195 typedef int (pci_remove_t)(struct rte_pci_device *);
 196
 197 /**
 198  * A structure describing a PCI driver.
 199  */
 200 struct rte_pci_driver {
 201         TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
 202         struct rte_driver driver;               /**< Inherit core driver. */
 203         pci_probe_t *probe;                     /**< Device Probe function. */
 204         pci_remove_t *remove;                   /**< Device Remove function. */
 205         const struct rte_pci_id *id_table;      /**< ID table, NULL terminated. */
 206         uint32_t drv_flags;                     /**< Flags contolling handling of device. */
 207 };
 208
 209 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
 210 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
 211 /** Device driver supports link state interrupt */
 212 #define RTE_PCI_DRV_INTR_LSC    0x0008
 213 /** Device driver supports detaching capability */
 214 #define RTE_PCI_DRV_DETACHABLE  0x0010
 215
 216 /**
 217  * A structure describing a PCI mapping.
 218  */
 219 struct pci_map {
 220         void *addr;
 221         char *path;
 222         uint64_t offset;
 223         uint64_t size;
 224         uint64_t phaddr;
 225 };
 226
 227 /**
 228  * A structure describing a mapped PCI resource.
 229  * For multi-process we need to reproduce all PCI mappings in secondary
 230  * processes, so save them in a tailq.
 231  */
 232 struct mapped_pci_resource {
 233         TAILQ_ENTRY(mapped_pci_resource) next;
 234
 235         struct rte_pci_addr pci_addr;
 236         char path[PATH_MAX];
 237         int nb_maps;
 238         struct pci_map maps[PCI_MAX_RESOURCE];
 239 };
 240
 241 /** mapped pci device list */
 242 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
 243
 244 /**< Internal use only - Macro used by pci addr parsing functions **/
 245 #define GET_PCIADDR_FIELD(in, fd, lim, dlm)                   \
 246 do {                                                               \
 247         unsigned long val;                                      \
 248         char *end;                                              \
 249         errno = 0;                                              \
 250         val = strtoul((in), &end, 16);                          \
 251         if (errno != 0 || end[0] != (dlm) || val > (lim))       \
 252                 return -EINVAL;                                 \
 253         (fd) = (typeof (fd))val;                                \
 254         (in) = end + 1;                                         \
 255 } while(0)
 256
 257 /**
 258  * Utility function to produce a PCI Bus-Device-Function value
 259  * given a string representation. Assumes that the BDF is provided without
 260  * a domain prefix (i.e. domain returned is always 0)
 261  *
 262  * @param input
 263  *      The input string to be parsed. Should have the format XX:XX.X
 264  * @param dev_addr
 265  *      The PCI Bus-Device-Function address to be returned. Domain will always be
 266  *      returned as 0
 267  * @return
 268  *  0 on success, negative on error.
 269  */
 270 static inline int
 271 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
 272 {
 273         dev_addr->domain = 0;
 274         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
 275         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
 276         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
 277         return 0;
 278 }
 279
 280 /**
 281  * Utility function to produce a PCI Bus-Device-Function value
 282  * given a string representation. Assumes that the BDF is provided including
 283  * a domain prefix.
 284  *
 285  * @param input
 286  *      The input string to be parsed. Should have the format XXXX:XX:XX.X
 287  * @param dev_addr
 288  *      The PCI Bus-Device-Function address to be returned
 289  * @return
 290  *  0 on success, negative on error.
 291  */
 292 static inline int
 293 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
 294 {
 295         GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
 296         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
 297         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
 298         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
 299         return 0;
 300 }
 301 #undef GET_PCIADDR_FIELD
 302
 303 /**
 304  * Utility function to write a pci device name, this device name can later be
 305  * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
 306  * BDF helpers.
 307  *
 308  * @param addr
 309  *      The PCI Bus-Device-Function address
 310  * @param output
 311  *      The output buffer string
 312  * @param size
 313  *      The output buffer size
 314  */
 315 static inline void
 316 rte_eal_pci_device_name(const struct rte_pci_addr *addr,
 317                     char *output, size_t size)
 318 {
 319         RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
 320         RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
 321                             addr->domain, addr->bus,
 322                             addr->devid, addr->function) >= 0);
 323 }
 324
 325 /* Compare two PCI device addresses. */
 326 /**
 327  * Utility function to compare two PCI device addresses.
 328  *
 329  * @param addr
 330  *      The PCI Bus-Device-Function address to compare
 331  * @param addr2
 332  *      The PCI Bus-Device-Function address to compare
 333  * @return
 334  *      0 on equal PCI address.
 335  *      Positive on addr is greater than addr2.
 336  *      Negative on addr is less than addr2, or error.
 337  */
 338 static inline int
 339 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
 340                          const struct rte_pci_addr *addr2)
 341 {
 342         uint64_t dev_addr, dev_addr2;
 343
 344         if ((addr == NULL) || (addr2 == NULL))
 345                 return -1;
 346
 347         dev_addr = (addr->domain << 24) | (addr->bus << 16) |
 348                                 (addr->devid << 8) | addr->function;
 349         dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
 350                                 (addr2->devid << 8) | addr2->function;
 351
 352         if (dev_addr > dev_addr2)
 353                 return 1;
 354         else if (dev_addr < dev_addr2)
 355                 return -1;
 356         else
 357                 return 0;
 358 }
 359
 360 /**
 361  * Scan the content of the PCI bus, and the devices in the devices
 362  * list
 363  *
 364  * @return
 365  *  0 on success, negative on error
 366  */
 367 int rte_eal_pci_scan(void);
 368
 369 /**
 370  * Probe the PCI bus for registered drivers.
 371  *
 372  * Scan the content of the PCI bus, and call the probe() function for
 373  * all registered drivers that have a matching entry in its id_table
 374  * for discovered devices.
 375  *
 376  * @return
 377  *   - 0 on success.
 378  *   - Negative on error.
 379  */
 380 int rte_eal_pci_probe(void);
 381
 382 /**
 383  * Map the PCI device resources in user space virtual memory address
 384  *
 385  * Note that driver should not call this function when flag
 386  * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
 387  * you when it's on.
 388  *
 389  * @param dev
 390  *   A pointer to a rte_pci_device structure describing the device
 391  *   to use
 392  *
 393  * @return
 394  *   0 on success, negative on error and positive if no driver
 395  *   is found for the device.
 396  */
 397 int rte_eal_pci_map_device(struct rte_pci_device *dev);
 398
 399 /**
 400  * Unmap this device
 401  *
 402  * @param dev
 403  *   A pointer to a rte_pci_device structure describing the device
 404  *   to use
 405  */
 406 void rte_eal_pci_unmap_device(struct rte_pci_device *dev);
 407
 408 /**
 409  * @internal
 410  * Map a particular resource from a file.
 411  *
 412  * @param requested_addr
 413  *      The starting address for the new mapping range.
 414  * @param fd
 415  *      The file descriptor.
 416  * @param offset
 417  *      The offset for the mapping range.
 418  * @param size
 419  *      The size for the mapping range.
 420  * @param additional_flags
 421  *      The additional flags for the mapping range.
 422  * @return
 423  *   - On success, the function returns a pointer to the mapped area.
 424  *   - On error, the value MAP_FAILED is returned.
 425  */
 426 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
 427                 size_t size, int additional_flags);
 428
 429 /**
 430  * @internal
 431  * Unmap a particular resource.
 432  *
 433  * @param requested_addr
 434  *      The address for the unmapping range.
 435  * @param size
 436  *      The size for the unmapping range.
 437  */
 438 void pci_unmap_resource(void *requested_addr, size_t size);
 439
 440 /**
 441  * Probe 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 probe() 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 probe.
 449  * @return
 450  *   - 0 on success.
 451  *   - Negative on error.
 452  */
 453 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
 454
 455 /**
 456  * Close the single PCI device.
 457  *
 458  * Scan the content of the PCI bus, and find the pci device specified by pci
 459  * address, then call the remove() function for registered driver that has a
 460  * matching entry in its id_table for discovered device.
 461  *
 462  * @param addr
 463  *      The PCI Bus-Device-Function address to close.
 464  * @return
 465  *   - 0 on success.
 466  *   - Negative on error.
 467  */
 468 int rte_eal_pci_detach(const struct rte_pci_addr *addr);
 469
 470 /**
 471  * Dump the content of the PCI bus.
 472  *
 473  * @param f
 474  *   A pointer to a file for output
 475  */
 476 void rte_eal_pci_dump(FILE *f);
 477
 478 /**
 479  * Register a PCI driver.
 480  *
 481  * @param driver
 482  *   A pointer to a rte_pci_driver structure describing the driver
 483  *   to be registered.
 484  */
 485 void rte_eal_pci_register(struct rte_pci_driver *driver);
 486
 487 /** Helper for PCI device registration from driver (eth, crypto) instance */
 488 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
 489 RTE_INIT(pciinitfn_ ##nm); \
 490 static void pciinitfn_ ##nm(void) \
 491 {\
 492         (pci_drv).driver.name = RTE_STR(nm);\
 493         rte_eal_pci_register(&pci_drv); \
 494 } \
 495 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 496
 497 /**
 498  * Unregister a PCI driver.
 499  *
 500  * @param driver
 501  *   A pointer to a rte_pci_driver structure describing the driver
 502  *   to be unregistered.
 503  */
 504 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
 505
 506 /**
 507  * Read PCI config space.
 508  *
 509  * @param device
 510  *   A pointer to a rte_pci_device structure describing the device
 511  *   to use
 512  * @param buf
 513  *   A data buffer where the bytes should be read into
 514  * @param len
 515  *   The length of the data buffer.
 516  * @param offset
 517  *   The offset into PCI config space
 518  */
 519 int rte_eal_pci_read_config(const struct rte_pci_device *device,
 520                             void *buf, size_t len, off_t offset);
 521
 522 /**
 523  * Write PCI config space.
 524  *
 525  * @param device
 526  *   A pointer to a rte_pci_device structure describing the device
 527  *   to use
 528  * @param buf
 529  *   A data buffer containing the bytes should be written
 530  * @param len
 531  *   The length of the data buffer.
 532  * @param offset
 533  *   The offset into PCI config space
 534  */
 535 int rte_eal_pci_write_config(const struct rte_pci_device *device,
 536                              const void *buf, size_t len, off_t offset);
 537
 538 /**
 539  * A structure used to access io resources for a pci device.
 540  * rte_pci_ioport is arch, os, driver specific, and should not be used outside
 541  * of pci ioport api.
 542  */
 543 struct rte_pci_ioport {
 544         struct rte_pci_device *dev;
 545         uint64_t base;
 546         uint64_t len; /* only filled for memory mapped ports */
 547 };
 548
 549 /**
 550  * Initialize a rte_pci_ioport object for a pci device io resource.
 551  *
 552  * This object is then used to gain access to those io resources (see below).
 553  *
 554  * @param dev
 555  *   A pointer to a rte_pci_device structure describing the device
 556  *   to use.
 557  * @param bar
 558  *   Index of the io pci resource we want to access.
 559  * @param p
 560  *   The rte_pci_ioport object to be initialized.
 561  * @return
 562  *  0 on success, negative on error.
 563  */
 564 int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
 565                            struct rte_pci_ioport *p);
 566
 567 /**
 568  * Release any resources used in a rte_pci_ioport object.
 569  *
 570  * @param p
 571  *   The rte_pci_ioport object to be uninitialized.
 572  * @return
 573  *  0 on success, negative on error.
 574  */
 575 int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p);
 576
 577 /**
 578  * Read from a io pci resource.
 579  *
 580  * @param p
 581  *   The rte_pci_ioport object from which we want to read.
 582  * @param data
 583  *   A data buffer where the bytes should be read into
 584  * @param len
 585  *   The length of the data buffer.
 586  * @param offset
 587  *   The offset into the pci io resource.
 588  */
 589 void rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
 590                              void *data, size_t len, off_t offset);
 591
 592 /**
 593  * Write to a io pci resource.
 594  *
 595  * @param p
 596  *   The rte_pci_ioport object to which we want to write.
 597  * @param data
 598  *   A data buffer where the bytes should be read into
 599  * @param len
 600  *   The length of the data buffer.
 601  * @param offset
 602  *   The offset into the pci io resource.
 603  */
 604 void rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
 605                               const void *data, size_t len, off_t offset);
 606
 607 #ifdef __cplusplus
 608 }
 609 #endif
 610
 611 #endif /* _RTE_PCI_H_ */