drivers/bus/pci/rte_bus_pci.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2015 Intel Corporation.
   3  * Copyright 2013-2014 6WIND S.A.
   4  */
   5
   6 #ifndef _RTE_BUS_PCI_H_
   7 #define _RTE_BUS_PCI_H_
   8
   9 /**
  10  * @file
  11  *
  12  * RTE PCI Bus Interface
  13  */
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <limits.h>
  22 #include <errno.h>
  23 #include <sys/queue.h>
  24 #include <stdint.h>
  25 #include <inttypes.h>
  26
  27 #include <rte_debug.h>
  28 #include <rte_interrupts.h>
  29 #include <rte_dev.h>
  30 #include <rte_bus.h>
  31 #include <rte_pci.h>
  32
  33 /** Pathname of PCI devices directory. */
  34 const char *rte_pci_get_sysfs_path(void);
  35
  36 /* Forward declarations */
  37 struct rte_pci_device;
  38 struct rte_pci_driver;
  39
  40 /** List of PCI devices */
  41 TAILQ_HEAD(rte_pci_device_list, rte_pci_device);
  42 /** List of PCI drivers */
  43 TAILQ_HEAD(rte_pci_driver_list, rte_pci_driver);
  44
  45 /* PCI Bus iterators */
  46 #define FOREACH_DEVICE_ON_PCIBUS(p)     \
  47                 TAILQ_FOREACH(p, &(rte_pci_bus.device_list), next)
  48
  49 #define FOREACH_DRIVER_ON_PCIBUS(p)     \
  50                 TAILQ_FOREACH(p, &(rte_pci_bus.driver_list), next)
  51
  52 struct rte_devargs;
  53
  54 /**
  55  * A structure describing a PCI device.
  56  */
  57 struct rte_pci_device {
  58         TAILQ_ENTRY(rte_pci_device) next;   /**< Next probed PCI device. */
  59         struct rte_device device;           /**< Inherit core device */
  60         struct rte_pci_addr addr;           /**< PCI location. */
  61         struct rte_pci_id id;               /**< PCI ID. */
  62         struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
  63                                             /**< PCI Memory Resource */
  64         struct rte_intr_handle intr_handle; /**< Interrupt handle */
  65         struct rte_pci_driver *driver;      /**< PCI driver used in probing */
  66         uint16_t max_vfs;                   /**< sriov enable if not zero */
  67         enum rte_kernel_driver kdrv;        /**< Kernel driver passthrough */
  68         char name[PCI_PRI_STR_SIZE+1];      /**< PCI location (ASCII) */
  69         struct rte_intr_handle vfio_req_intr_handle;
  70                                 /**< Handler of VFIO request interrupt */
  71 };
  72
  73 /**
  74  * @internal
  75  * Helper macro for drivers that need to convert to struct rte_pci_device.
  76  */
  77 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
  78
  79 #define RTE_DEV_TO_PCI_CONST(ptr) \
  80         container_of(ptr, const struct rte_pci_device, device)
  81
  82 #define RTE_ETH_DEV_TO_PCI(eth_dev)     RTE_DEV_TO_PCI((eth_dev)->device)
  83
  84 /** Any PCI device identifier (vendor, device, ...) */
  85 #define PCI_ANY_ID (0xffff)
  86 #define RTE_CLASS_ANY_ID (0xffffff)
  87
  88 #ifdef __cplusplus
  89 /** C++ macro used to help building up tables of device IDs */
  90 #define RTE_PCI_DEVICE(vend, dev) \
  91         RTE_CLASS_ANY_ID,         \
  92         (vend),                   \
  93         (dev),                    \
  94         PCI_ANY_ID,               \
  95         PCI_ANY_ID
  96 #else
  97 /** Macro used to help building up tables of device IDs */
  98 #define RTE_PCI_DEVICE(vend, dev)          \
  99         .class_id = RTE_CLASS_ANY_ID,      \
 100         .vendor_id = (vend),               \
 101         .device_id = (dev),                \
 102         .subsystem_vendor_id = PCI_ANY_ID, \
 103         .subsystem_device_id = PCI_ANY_ID
 104 #endif
 105
 106 /**
 107  * Initialisation function for the driver called during PCI probing.
 108  */
 109 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
 110
 111 /**
 112  * Uninitialisation function for the driver called during hotplugging.
 113  */
 114 typedef int (pci_remove_t)(struct rte_pci_device *);
 115
 116 /**
 117  * A structure describing a PCI driver.
 118  */
 119 struct rte_pci_driver {
 120         TAILQ_ENTRY(rte_pci_driver) next;  /**< Next in list. */
 121         struct rte_driver driver;          /**< Inherit core driver. */
 122         struct rte_pci_bus *bus;           /**< PCI bus reference. */
 123         pci_probe_t *probe;                /**< Device Probe function. */
 124         pci_remove_t *remove;              /**< Device Remove function. */
 125         const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
 126         uint32_t drv_flags;                /**< Flags contolling handling of device. */
 127 };
 128
 129 /**
 130  * Structure describing the PCI bus
 131  */
 132 struct rte_pci_bus {
 133         struct rte_bus bus;               /**< Inherit the generic class */
 134         struct rte_pci_device_list device_list;  /**< List of PCI devices */
 135         struct rte_pci_driver_list driver_list;  /**< List of PCI drivers */
 136 };
 137
 138 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
 139 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
 140 /** Device needs PCI BAR mapping with enabled write combining (wc) */
 141 #define RTE_PCI_DRV_WC_ACTIVATE 0x0002
 142 /** Device driver supports link state interrupt */
 143 #define RTE_PCI_DRV_INTR_LSC    0x0008
 144 /** Device driver supports device removal interrupt */
 145 #define RTE_PCI_DRV_INTR_RMV 0x0010
 146 /** Device driver needs to keep mapped resources if unsupported dev detected */
 147 #define RTE_PCI_DRV_KEEP_MAPPED_RES 0x0020
 148 /** Device driver supports IOVA as VA */
 149 #define RTE_PCI_DRV_IOVA_AS_VA 0X0040
 150
 151 /**
 152  * Map the PCI device resources in user space virtual memory address
 153  *
 154  * Note that driver should not call this function when flag
 155  * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
 156  * you when it's on.
 157  *
 158  * @param dev
 159  *   A pointer to a rte_pci_device structure describing the device
 160  *   to use
 161  *
 162  * @return
 163  *   0 on success, negative on error and positive if no driver
 164  *   is found for the device.
 165  */
 166 int rte_pci_map_device(struct rte_pci_device *dev);
 167
 168 /**
 169  * Unmap this device
 170  *
 171  * @param dev
 172  *   A pointer to a rte_pci_device structure describing the device
 173  *   to use
 174  */
 175 void rte_pci_unmap_device(struct rte_pci_device *dev);
 176
 177 /**
 178  * Dump the content of the PCI bus.
 179  *
 180  * @param f
 181  *   A pointer to a file for output
 182  */
 183 void rte_pci_dump(FILE *f);
 184
 185 /**
 186  * Register a PCI driver.
 187  *
 188  * @param driver
 189  *   A pointer to a rte_pci_driver structure describing the driver
 190  *   to be registered.
 191  */
 192 void rte_pci_register(struct rte_pci_driver *driver);
 193
 194 /** Helper for PCI device registration from driver (eth, crypto) instance */
 195 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
 196 RTE_INIT(pciinitfn_ ##nm) \
 197 {\
 198         (pci_drv).driver.name = RTE_STR(nm);\
 199         rte_pci_register(&pci_drv); \
 200 } \
 201 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 202
 203 /**
 204  * Unregister a PCI driver.
 205  *
 206  * @param driver
 207  *   A pointer to a rte_pci_driver structure describing the driver
 208  *   to be unregistered.
 209  */
 210 void rte_pci_unregister(struct rte_pci_driver *driver);
 211
 212 /**
 213  * Read PCI config space.
 214  *
 215  * @param device
 216  *   A pointer to a rte_pci_device structure describing the device
 217  *   to use
 218  * @param buf
 219  *   A data buffer where the bytes should be read into
 220  * @param len
 221  *   The length of the data buffer.
 222  * @param offset
 223  *   The offset into PCI config space
 224  */
 225 int rte_pci_read_config(const struct rte_pci_device *device,
 226                 void *buf, size_t len, off_t offset);
 227
 228 /**
 229  * Write PCI config space.
 230  *
 231  * @param device
 232  *   A pointer to a rte_pci_device structure describing the device
 233  *   to use
 234  * @param buf
 235  *   A data buffer containing the bytes should be written
 236  * @param len
 237  *   The length of the data buffer.
 238  * @param offset
 239  *   The offset into PCI config space
 240  */
 241 int rte_pci_write_config(const struct rte_pci_device *device,
 242                 const void *buf, size_t len, off_t offset);
 243
 244 /**
 245  * A structure used to access io resources for a pci device.
 246  * rte_pci_ioport is arch, os, driver specific, and should not be used outside
 247  * of pci ioport api.
 248  */
 249 struct rte_pci_ioport {
 250         struct rte_pci_device *dev;
 251         uint64_t base;
 252         uint64_t len; /* only filled for memory mapped ports */
 253 };
 254
 255 /**
 256  * Initialize a rte_pci_ioport object for a pci device io resource.
 257  *
 258  * This object is then used to gain access to those io resources (see below).
 259  *
 260  * @param dev
 261  *   A pointer to a rte_pci_device structure describing the device
 262  *   to use.
 263  * @param bar
 264  *   Index of the io pci resource we want to access.
 265  * @param p
 266  *   The rte_pci_ioport object to be initialized.
 267  * @return
 268  *  0 on success, negative on error.
 269  */
 270 int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
 271                 struct rte_pci_ioport *p);
 272
 273 /**
 274  * Release any resources used in a rte_pci_ioport object.
 275  *
 276  * @param p
 277  *   The rte_pci_ioport object to be uninitialized.
 278  * @return
 279  *  0 on success, negative on error.
 280  */
 281 int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
 282
 283 /**
 284  * Read from a io pci resource.
 285  *
 286  * @param p
 287  *   The rte_pci_ioport object from which we want to read.
 288  * @param data
 289  *   A data buffer where the bytes should be read into
 290  * @param len
 291  *   The length of the data buffer.
 292  * @param offset
 293  *   The offset into the pci io resource.
 294  */
 295 void rte_pci_ioport_read(struct rte_pci_ioport *p,
 296                 void *data, size_t len, off_t offset);
 297
 298 /**
 299  * Write to a io pci resource.
 300  *
 301  * @param p
 302  *   The rte_pci_ioport object to which we want to write.
 303  * @param data
 304  *   A data buffer where the bytes should be read into
 305  * @param len
 306  *   The length of the data buffer.
 307  * @param offset
 308  *   The offset into the pci io resource.
 309  */
 310 void rte_pci_ioport_write(struct rte_pci_ioport *p,
 311                 const void *data, size_t len, off_t offset);
 312
 313 #ifdef __cplusplus
 314 }
 315 #endif
 316
 317 #endif /* _RTE_BUS_PCI_H_ */