lib/librte_eal/common/include/rte_pci.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
   5  *   Copyright 2013-2014 6WIND S.A.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef _RTE_PCI_H_
  36 #define _RTE_PCI_H_
  37
  38 /**
  39  * @file
  40  *
  41  * RTE PCI Interface
  42  */
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <stdio.h>
  49 #include <stdlib.h>
  50 #include <limits.h>
  51 #include <errno.h>
  52 #include <sys/queue.h>
  53 #include <stdint.h>
  54 #include <inttypes.h>
  55
  56 #include <rte_debug.h>
  57 #include <rte_interrupts.h>
  58 #include <rte_dev.h>
  59 #include <rte_bus.h>
  60
  61 /** Pathname of PCI devices directory. */
  62 const char *pci_get_sysfs_path(void);
  63
  64 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
  65 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
  66 #define PCI_PRI_STR_SIZE sizeof("XXXX:XX:XX.X")
  67
  68 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
  69 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
  70
  71 /** Nb. of values in PCI device identifier format string. */
  72 #define PCI_FMT_NVAL 4
  73
  74 /** Nb. of values in PCI resource format. */
  75 #define PCI_RESOURCE_FMT_NVAL 3
  76
  77 /** Maximum number of PCI resources. */
  78 #define PCI_MAX_RESOURCE 6
  79
  80 /** Name of PCI Bus */
  81 #define PCI_BUS_NAME "PCI"
  82
  83 /* Forward declarations */
  84 struct rte_pci_device;
  85 struct rte_pci_driver;
  86
  87 /** List of PCI devices */
  88 TAILQ_HEAD(rte_pci_device_list, rte_pci_device);
  89 /** List of PCI drivers */
  90 TAILQ_HEAD(rte_pci_driver_list, rte_pci_driver);
  91
  92 /* PCI Bus iterators */
  93 #define FOREACH_DEVICE_ON_PCIBUS(p)     \
  94                 TAILQ_FOREACH(p, &(rte_pci_bus.device_list), next)
  95
  96 #define FOREACH_DRIVER_ON_PCIBUS(p)     \
  97                 TAILQ_FOREACH(p, &(rte_pci_bus.driver_list), next)
  98
  99 /**
 100  * A structure describing an ID for a PCI driver. Each driver provides a
 101  * table of these IDs for each device that it supports.
 102  */
 103 struct rte_pci_id {
 104         uint32_t class_id;            /**< Class ID (class, subclass, pi) or RTE_CLASS_ANY_ID. */
 105         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
 106         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
 107         uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
 108         uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
 109 };
 110
 111 /**
 112  * A structure describing the location of a PCI device.
 113  */
 114 struct rte_pci_addr {
 115         uint16_t domain;                /**< Device domain */
 116         uint8_t bus;                    /**< Device bus */
 117         uint8_t devid;                  /**< Device ID */
 118         uint8_t function;               /**< Device function. */
 119 };
 120
 121 struct rte_devargs;
 122
 123 enum rte_kernel_driver {
 124         RTE_KDRV_UNKNOWN = 0,
 125         RTE_KDRV_IGB_UIO,
 126         RTE_KDRV_VFIO,
 127         RTE_KDRV_UIO_GENERIC,
 128         RTE_KDRV_NIC_UIO,
 129         RTE_KDRV_NONE,
 130 };
 131
 132 /**
 133  * A structure describing a PCI device.
 134  */
 135 struct rte_pci_device {
 136         TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
 137         struct rte_device device;               /**< Inherit core device */
 138         struct rte_pci_addr addr;               /**< PCI location. */
 139         struct rte_pci_id id;                   /**< PCI ID. */
 140         struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
 141                                                 /**< PCI Memory Resource */
 142         struct rte_intr_handle intr_handle;     /**< Interrupt handle */
 143         struct rte_pci_driver *driver;          /**< Associated driver */
 144         uint16_t max_vfs;                       /**< sriov enable if not zero */
 145         enum rte_kernel_driver kdrv;            /**< Kernel driver passthrough */
 146         char name[PCI_PRI_STR_SIZE+1];          /**< PCI location (ASCII) */
 147 };
 148
 149 /**
 150  * @internal
 151  * Helper macro for drivers that need to convert to struct rte_pci_device.
 152  */
 153 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
 154
 155 /** Any PCI device identifier (vendor, device, ...) */
 156 #define PCI_ANY_ID (0xffff)
 157 #define RTE_CLASS_ANY_ID (0xffffff)
 158
 159 #ifdef __cplusplus
 160 /** C++ macro used to help building up tables of device IDs */
 161 #define RTE_PCI_DEVICE(vend, dev) \
 162         RTE_CLASS_ANY_ID,         \
 163         (vend),                   \
 164         (dev),                    \
 165         PCI_ANY_ID,               \
 166         PCI_ANY_ID
 167 #else
 168 /** Macro used to help building up tables of device IDs */
 169 #define RTE_PCI_DEVICE(vend, dev)          \
 170         .class_id = RTE_CLASS_ANY_ID,      \
 171         .vendor_id = (vend),               \
 172         .device_id = (dev),                \
 173         .subsystem_vendor_id = PCI_ANY_ID, \
 174         .subsystem_device_id = PCI_ANY_ID
 175 #endif
 176
 177 /**
 178  * Initialisation function for the driver called during PCI probing.
 179  */
 180 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
 181
 182 /**
 183  * Uninitialisation function for the driver called during hotplugging.
 184  */
 185 typedef int (pci_remove_t)(struct rte_pci_device *);
 186
 187 /**
 188  * A structure describing a PCI driver.
 189  */
 190 struct rte_pci_driver {
 191         TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
 192         struct rte_driver driver;               /**< Inherit core driver. */
 193         struct rte_pci_bus *bus;                /**< PCI bus reference. */
 194         pci_probe_t *probe;                     /**< Device Probe function. */
 195         pci_remove_t *remove;                   /**< Device Remove function. */
 196         const struct rte_pci_id *id_table;      /**< ID table, NULL terminated. */
 197         uint32_t drv_flags;                     /**< Flags contolling handling of device. */
 198 };
 199
 200 /**
 201  * Structure describing the PCI bus
 202  */
 203 struct rte_pci_bus {
 204         struct rte_bus bus;               /**< Inherit the generic class */
 205         struct rte_pci_device_list device_list;  /**< List of PCI devices */
 206         struct rte_pci_driver_list driver_list;  /**< List of PCI drivers */
 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 device removal interrupt */
 214 #define RTE_PCI_DRV_INTR_RMV 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_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_pci_scan(void);
 368
 369 /**
 370  * Probe the PCI bus
 371  *
 372  * @return
 373  *   - 0 on success.
 374  *   - !0 on error.
 375  */
 376 int
 377 rte_pci_probe(void);
 378
 379 /**
 380  * Map the PCI device resources in user space virtual memory address
 381  *
 382  * Note that driver should not call this function when flag
 383  * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
 384  * you when it's on.
 385  *
 386  * @param dev
 387  *   A pointer to a rte_pci_device structure describing the device
 388  *   to use
 389  *
 390  * @return
 391  *   0 on success, negative on error and positive if no driver
 392  *   is found for the device.
 393  */
 394 int rte_pci_map_device(struct rte_pci_device *dev);
 395
 396 /**
 397  * Unmap this device
 398  *
 399  * @param dev
 400  *   A pointer to a rte_pci_device structure describing the device
 401  *   to use
 402  */
 403 void rte_pci_unmap_device(struct rte_pci_device *dev);
 404
 405 /**
 406  * @internal
 407  * Map a particular resource from a file.
 408  *
 409  * @param requested_addr
 410  *      The starting address for the new mapping range.
 411  * @param fd
 412  *      The file descriptor.
 413  * @param offset
 414  *      The offset for the mapping range.
 415  * @param size
 416  *      The size for the mapping range.
 417  * @param additional_flags
 418  *      The additional flags for the mapping range.
 419  * @return
 420  *   - On success, the function returns a pointer to the mapped area.
 421  *   - On error, the value MAP_FAILED is returned.
 422  */
 423 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
 424                 size_t size, int additional_flags);
 425
 426 /**
 427  * @internal
 428  * Unmap a particular resource.
 429  *
 430  * @param requested_addr
 431  *      The address for the unmapping range.
 432  * @param size
 433  *      The size for the unmapping range.
 434  */
 435 void pci_unmap_resource(void *requested_addr, size_t size);
 436
 437 /**
 438  * Probe the single PCI device.
 439  *
 440  * Scan the content of the PCI bus, and find the pci device specified by pci
 441  * address, then call the probe() function for registered driver that has a
 442  * matching entry in its id_table for discovered device.
 443  *
 444  * @param addr
 445  *      The PCI Bus-Device-Function address to probe.
 446  * @return
 447  *   - 0 on success.
 448  *   - Negative on error.
 449  */
 450 int rte_pci_probe_one(const struct rte_pci_addr *addr);
 451
 452 /**
 453  * Close the single PCI device.
 454  *
 455  * Scan the content of the PCI bus, and find the pci device specified by pci
 456  * address, then call the remove() function for registered driver that has a
 457  * matching entry in its id_table for discovered device.
 458  *
 459  * @param addr
 460  *      The PCI Bus-Device-Function address to close.
 461  * @return
 462  *   - 0 on success.
 463  *   - Negative on error.
 464  */
 465 int rte_pci_detach(const struct rte_pci_addr *addr);
 466
 467 /**
 468  * Dump the content of the PCI bus.
 469  *
 470  * @param f
 471  *   A pointer to a file for output
 472  */
 473 void rte_pci_dump(FILE *f);
 474
 475 /**
 476  * Register a PCI driver.
 477  *
 478  * @param driver
 479  *   A pointer to a rte_pci_driver structure describing the driver
 480  *   to be registered.
 481  */
 482 void rte_pci_register(struct rte_pci_driver *driver);
 483
 484 /** Helper for PCI device registration from driver (eth, crypto) instance */
 485 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
 486 RTE_INIT(pciinitfn_ ##nm); \
 487 static void pciinitfn_ ##nm(void) \
 488 {\
 489         (pci_drv).driver.name = RTE_STR(nm);\
 490         rte_pci_register(&pci_drv); \
 491 } \
 492 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 493
 494 /**
 495  * Unregister a PCI driver.
 496  *
 497  * @param driver
 498  *   A pointer to a rte_pci_driver structure describing the driver
 499  *   to be unregistered.
 500  */
 501 void rte_pci_unregister(struct rte_pci_driver *driver);
 502
 503 /**
 504  * Read PCI config space.
 505  *
 506  * @param device
 507  *   A pointer to a rte_pci_device structure describing the device
 508  *   to use
 509  * @param buf
 510  *   A data buffer where the bytes should be read into
 511  * @param len
 512  *   The length of the data buffer.
 513  * @param offset
 514  *   The offset into PCI config space
 515  */
 516 int rte_pci_read_config(const struct rte_pci_device *device,
 517                 void *buf, size_t len, off_t offset);
 518
 519 /**
 520  * Write PCI config space.
 521  *
 522  * @param device
 523  *   A pointer to a rte_pci_device structure describing the device
 524  *   to use
 525  * @param buf
 526  *   A data buffer containing the bytes should be written
 527  * @param len
 528  *   The length of the data buffer.
 529  * @param offset
 530  *   The offset into PCI config space
 531  */
 532 int rte_pci_write_config(const struct rte_pci_device *device,
 533                 const void *buf, size_t len, off_t offset);
 534
 535 /**
 536  * A structure used to access io resources for a pci device.
 537  * rte_pci_ioport is arch, os, driver specific, and should not be used outside
 538  * of pci ioport api.
 539  */
 540 struct rte_pci_ioport {
 541         struct rte_pci_device *dev;
 542         uint64_t base;
 543         uint64_t len; /* only filled for memory mapped ports */
 544 };
 545
 546 /**
 547  * Initialize a rte_pci_ioport object for a pci device io resource.
 548  *
 549  * This object is then used to gain access to those io resources (see below).
 550  *
 551  * @param dev
 552  *   A pointer to a rte_pci_device structure describing the device
 553  *   to use.
 554  * @param bar
 555  *   Index of the io pci resource we want to access.
 556  * @param p
 557  *   The rte_pci_ioport object to be initialized.
 558  * @return
 559  *  0 on success, negative on error.
 560  */
 561 int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
 562                 struct rte_pci_ioport *p);
 563
 564 /**
 565  * Release any resources used in a rte_pci_ioport object.
 566  *
 567  * @param p
 568  *   The rte_pci_ioport object to be uninitialized.
 569  * @return
 570  *  0 on success, negative on error.
 571  */
 572 int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
 573
 574 /**
 575  * Read from a io pci resource.
 576  *
 577  * @param p
 578  *   The rte_pci_ioport object from which we want to read.
 579  * @param data
 580  *   A data buffer where the bytes should be read into
 581  * @param len
 582  *   The length of the data buffer.
 583  * @param offset
 584  *   The offset into the pci io resource.
 585  */
 586 void rte_pci_ioport_read(struct rte_pci_ioport *p,
 587                 void *data, size_t len, off_t offset);
 588
 589 /**
 590  * Write to a io pci resource.
 591  *
 592  * @param p
 593  *   The rte_pci_ioport object to which we want to write.
 594  * @param data
 595  *   A data buffer where the bytes should be read into
 596  * @param len
 597  *   The length of the data buffer.
 598  * @param offset
 599  *   The offset into the pci io resource.
 600  */
 601 void rte_pci_ioport_write(struct rte_pci_ioport *p,
 602                 const void *data, size_t len, off_t offset);
 603
 604 #ifdef __cplusplus
 605 }
 606 #endif
 607
 608 #endif /* _RTE_PCI_H_ */