lib/librte_eal/common/include/rte_pci.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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  */
  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 <sys/queue.h>
  49 #include <stdint.h>
  50 #include <inttypes.h>
  51 #include <rte_interrupts.h>
  52
  53 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
  54 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
  55
  56 extern struct pci_driver_list driver_list; /**< Global list of PCI drivers. */
  57 extern struct pci_device_list device_list; /**< Global list of PCI devices. */
  58
  59 /** Pathname of PCI devices directory. */
  60 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
  61
  62 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
  63 #define PCI_PRI_FMT "%.4"PRIx16":%.2"PRIx8":%.2"PRIx8".%"PRIx8
  64
  65 /** Nb. of values in PCI device identifier format string. */
  66 #define PCI_FMT_NVAL 4
  67
  68 /** Nb. of values in PCI resource format. */
  69 #define PCI_RESOURCE_FMT_NVAL 3
  70
  71 /**
  72  * A structure describing a PCI resource.
  73  */
  74 struct rte_pci_resource {
  75         uint64_t phys_addr;   /**< Physical address, 0 if no resource. */
  76         uint64_t len;         /**< Length of the resource. */
  77         void *addr;           /**< Virtual address, NULL when not mapped. */
  78 };
  79
  80 /** Maximum number of PCI resources. */
  81 #define PCI_MAX_RESOURCE 7
  82
  83 /**
  84  * A structure describing an ID for a PCI driver. Each driver provides a
  85  * table of these IDs for each device that it supports.
  86  */
  87 struct rte_pci_id {
  88         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
  89         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
  90         uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
  91         uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
  92 };
  93
  94 /**
  95  * A structure describing the location of a PCI device.
  96  */
  97 struct rte_pci_addr {
  98         uint16_t domain;                /**< Device domain */
  99         uint8_t bus;                    /**< Device bus */
 100         uint8_t devid;                  /**< Device ID */
 101         uint8_t function;               /**< Device function. */
 102 };
 103
 104 /**
 105  * A structure describing a PCI device.
 106  */
 107 struct rte_pci_device {
 108         TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
 109         struct rte_pci_addr addr;               /**< PCI location. */
 110         struct rte_pci_id id;                   /**< PCI ID. */
 111         struct rte_pci_resource mem_resource;   /**< PCI Memory Resource */
 112         struct rte_intr_handle intr_handle;     /**< Interrupt handle */
 113         const struct rte_pci_driver *driver;    /**< Associated driver */
 114         unsigned int blacklisted:1;             /**< Device is blacklisted */
 115 };
 116
 117 /** Any PCI device identifier (vendor, device, ...) */
 118 #define PCI_ANY_ID (0xffff)
 119
 120 #ifdef __cplusplus
 121 /** C++ macro used to help building up tables of device IDs */
 122 #define RTE_PCI_DEVICE(vend, dev) \
 123         (vend),                   \
 124         (dev),                    \
 125         PCI_ANY_ID,               \
 126         PCI_ANY_ID
 127 #else
 128 /** Macro used to help building up tables of device IDs */
 129 #define RTE_PCI_DEVICE(vend, dev)          \
 130         .vendor_id = (vend),               \
 131         .device_id = (dev),                \
 132         .subsystem_vendor_id = PCI_ANY_ID, \
 133         .subsystem_device_id = PCI_ANY_ID
 134 #endif
 135
 136 struct rte_pci_driver;
 137
 138 /**
 139  * Initialisation function for the driver called during PCI probing.
 140  */
 141 typedef int (pci_devinit_t)(struct rte_pci_driver *, struct rte_pci_device *);
 142
 143 /**
 144  * A structure describing a PCI driver.
 145  */
 146 struct rte_pci_driver {
 147         TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
 148         const char *name;                       /**< Driver name. */
 149         pci_devinit_t *devinit;                 /**< Device init. function. */
 150         struct rte_pci_id *id_table;            /**< ID table, NULL terminated. */
 151         uint32_t drv_flags;                     /**< Flags contolling handling of device. */
 152 };
 153
 154 /**< Device needs igb_uio kernel module */
 155 #define RTE_PCI_DRV_NEED_IGB_UIO 0x0001
 156
 157 /**
 158  * Probe the PCI bus for registered drivers.
 159  *
 160  * Scan the content of the PCI bus, and call the probe() function for
 161  * all registered drivers that have a matching entry in its id_table
 162  * for discovered devices.
 163  *
 164  * @return
 165  *   - 0 on success.
 166  *   - Negative on error.
 167  */
 168 int rte_eal_pci_probe(void);
 169
 170 /**
 171  * Dump the content of the PCI bus.
 172  */
 173 void rte_eal_pci_dump(void);
 174
 175 /**
 176  * Register a PCI driver.
 177  *
 178  * @param driver
 179  *   A pointer to a rte_pci_driver structure describing the driver
 180  *   to be registered.
 181  */
 182 void rte_eal_pci_register(struct rte_pci_driver *driver);
 183
 184 /**
 185  * Register a list of PCI locations that will be blacklisted (not used by DPDK).
 186  *
 187  * @param blacklist
 188  *   List of PCI device addresses that will not be used by DPDK.
 189  * @param size
 190  *   Number of items in the list.
 191  */
 192 void rte_eal_pci_set_blacklist(struct rte_pci_addr *blacklist, unsigned size);
 193
 194 #ifdef __cplusplus
 195 }
 196 #endif
 197
 198 #endif /* _RTE_PCI_H_ */