lib/librte_eal/common/include/rte_pci.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 <stdlib.h>
  78 #include <limits.h>
  79 #include <errno.h>
  80 #include <sys/queue.h>
  81 #include <stdint.h>
  82 #include <inttypes.h>
  83 #include <rte_interrupts.h>
  84
  85 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
  86 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
  87
  88 extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
  89 extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
  90
  91 /** Pathname of PCI devices directory. */
  92 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
  93
  94 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
  95 #define PCI_PRI_FMT "%.4"PRIx16":%.2"PRIx8":%.2"PRIx8".%"PRIx8
  96
  97 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
  98 #define PCI_SHORT_PRI_FMT "%.2"PRIx8":%.2"PRIx8".%"PRIx8
  99
 100 /** Nb. of values in PCI device identifier format string. */
 101 #define PCI_FMT_NVAL 4
 102
 103 /** Nb. of values in PCI resource format. */
 104 #define PCI_RESOURCE_FMT_NVAL 3
 105
 106 /**
 107  * A structure describing a PCI resource.
 108  */
 109 struct rte_pci_resource {
 110         uint64_t phys_addr;   /**< Physical address, 0 if no resource. */
 111         uint64_t len;         /**< Length of the resource. */
 112         void *addr;           /**< Virtual address, NULL when not mapped. */
 113 };
 114
 115 /** Maximum number of PCI resources. */
 116 #define PCI_MAX_RESOURCE 7
 117
 118 /**
 119  * A structure describing an ID for a PCI driver. Each driver provides a
 120  * table of these IDs for each device that it supports.
 121  */
 122 struct rte_pci_id {
 123         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
 124         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
 125         uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
 126         uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
 127 };
 128
 129 /**
 130  * A structure describing the location of a PCI device.
 131  */
 132 struct rte_pci_addr {
 133         uint16_t domain;                /**< Device domain */
 134         uint8_t bus;                    /**< Device bus */
 135         uint8_t devid;                  /**< Device ID */
 136         uint8_t function;               /**< Device function. */
 137 };
 138
 139 struct rte_devargs;
 140
 141 /**
 142  * A structure describing a PCI device.
 143  */
 144 struct rte_pci_device {
 145         TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
 146         struct rte_pci_addr addr;               /**< PCI location. */
 147         struct rte_pci_id id;                   /**< PCI ID. */
 148         struct rte_pci_resource mem_resource[PCI_MAX_RESOURCE];   /**< PCI Memory Resource */
 149         struct rte_intr_handle intr_handle;     /**< Interrupt handle */
 150         const struct rte_pci_driver *driver;    /**< Associated driver */
 151         uint16_t max_vfs;                       /**< sriov enable if not zero */
 152         int numa_node;                          /**< NUMA node connection */
 153         struct rte_devargs *devargs;            /**< Device user arguments */
 154 };
 155
 156 /** Any PCI device identifier (vendor, device, ...) */
 157 #define PCI_ANY_ID (0xffff)
 158
 159 #ifdef __cplusplus
 160 /** C++ macro used to help building up tables of device IDs */
 161 #define RTE_PCI_DEVICE(vend, dev) \
 162         (vend),                   \
 163         (dev),                    \
 164         PCI_ANY_ID,               \
 165         PCI_ANY_ID
 166 #else
 167 /** Macro used to help building up tables of device IDs */
 168 #define RTE_PCI_DEVICE(vend, dev)          \
 169         .vendor_id = (vend),               \
 170         .device_id = (dev),                \
 171         .subsystem_vendor_id = PCI_ANY_ID, \
 172         .subsystem_device_id = PCI_ANY_ID
 173 #endif
 174
 175 struct rte_pci_driver;
 176
 177 /**
 178  * Initialisation function for the driver called during PCI probing.
 179  */
 180 typedef int (pci_devinit_t)(struct rte_pci_driver *, struct rte_pci_device *);
 181
 182 /**
 183  * A structure describing a PCI driver.
 184  */
 185 struct rte_pci_driver {
 186         TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
 187         const char *name;                       /**< Driver name. */
 188         pci_devinit_t *devinit;                 /**< Device init. function. */
 189         struct rte_pci_id *id_table;            /**< ID table, NULL terminated. */
 190         uint32_t drv_flags;                     /**< Flags contolling handling of device. */
 191 };
 192
 193 /** Device needs igb_uio kernel module */
 194 #define RTE_PCI_DRV_NEED_IGB_UIO 0x0001
 195 /** Device driver must be registered several times until failure */
 196 #define RTE_PCI_DRV_MULTIPLE 0x0002
 197 /** Device needs to be unbound even if no module is provided */
 198 #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
 199
 200 /**< Internal use only - Macro used by pci addr parsing functions **/
 201 #define GET_PCIADDR_FIELD(in, fd, lim, dlm)                   \
 202 do {                                                               \
 203         unsigned long val;                                      \
 204         char *end;                                              \
 205         errno = 0;                                              \
 206         val = strtoul((in), &end, 16);                          \
 207         if (errno != 0 || end[0] != (dlm) || val > (lim))       \
 208                 return (-EINVAL);                               \
 209         (fd) = (typeof (fd))val;                                \
 210         (in) = end + 1;                                         \
 211 } while(0)
 212
 213 /**
 214  * Utility function to produce a PCI Bus-Device-Function value
 215  * given a string representation. Assumes that the BDF is provided without
 216  * a domain prefix (i.e. domain returned is always 0)
 217  *
 218  * @param input
 219  *      The input string to be parsed. Should have the format XX:XX.X
 220  * @param dev_addr
 221  *      The PCI Bus-Device-Function address to be returned. Domain will always be
 222  *      returned as 0
 223  * @return
 224  *  0 on success, negative on error.
 225  */
 226 static inline int
 227 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
 228 {
 229         dev_addr->domain = 0;
 230         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
 231         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
 232         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
 233         return (0);
 234 }
 235
 236 /**
 237  * Utility function to produce a PCI Bus-Device-Function value
 238  * given a string representation. Assumes that the BDF is provided including
 239  * a domain prefix.
 240  *
 241  * @param input
 242  *      The input string to be parsed. Should have the format XXXX:XX:XX.X
 243  * @param dev_addr
 244  *      The PCI Bus-Device-Function address to be returned
 245  * @return
 246  *  0 on success, negative on error.
 247  */
 248 static inline int
 249 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
 250 {
 251         GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
 252         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
 253         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
 254         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
 255         return (0);
 256 }
 257 #undef GET_PCIADDR_FIELD
 258
 259 /**
 260  * Probe the PCI bus for registered drivers.
 261  *
 262  * Scan the content of the PCI bus, and call the probe() function for
 263  * all registered drivers that have a matching entry in its id_table
 264  * for discovered devices.
 265  *
 266  * @return
 267  *   - 0 on success.
 268  *   - Negative on error.
 269  */
 270 int rte_eal_pci_probe(void);
 271
 272 /**
 273  * Dump the content of the PCI bus.
 274  *
 275  * @param f
 276  *   A pointer to a file for output
 277  */
 278 void rte_eal_pci_dump(FILE *f);
 279
 280 /**
 281  * Register a PCI driver.
 282  *
 283  * @param driver
 284  *   A pointer to a rte_pci_driver structure describing the driver
 285  *   to be registered.
 286  */
 287 void rte_eal_pci_register(struct rte_pci_driver *driver);
 288
 289 /**
 290  * Unregister a PCI driver.
 291  *
 292  * @param driver
 293  *   A pointer to a rte_pci_driver structure describing the driver
 294  *   to be unregistered.
 295  */
 296 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
 297
 298 #ifdef __cplusplus
 299 }
 300 #endif
 301
 302 #endif /* _RTE_PCI_H_ */