4d509afa7b
The name of the constant PCI_ANY_ID was missing RTE_ prefix. It is renamed, and the old name becomes a deprecated alias. While renaming, the duplicate definitions in rte_bus_pci.h are removed to keep only those in rte_pci.h. Note: rte_pci.h is included in rte_bus_pci.h Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Reviewed-by: Parav Pandit <parav@nvidia.com> Reviewed-by: David Marchand <david.marchand@redhat.com>
387 lines
11 KiB
C
387 lines
11 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2010-2015 Intel Corporation.
|
|
* Copyright 2013-2014 6WIND S.A.
|
|
*/
|
|
|
|
#ifndef _RTE_BUS_PCI_H_
|
|
#define _RTE_BUS_PCI_H_
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* RTE PCI Bus Interface
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <limits.h>
|
|
#include <errno.h>
|
|
#include <sys/queue.h>
|
|
#include <stdint.h>
|
|
#include <inttypes.h>
|
|
|
|
#include <rte_debug.h>
|
|
#include <rte_interrupts.h>
|
|
#include <rte_dev.h>
|
|
#include <rte_bus.h>
|
|
#include <rte_pci.h>
|
|
|
|
/** Pathname of PCI devices directory. */
|
|
const char *rte_pci_get_sysfs_path(void);
|
|
|
|
/* Forward declarations */
|
|
struct rte_pci_device;
|
|
struct rte_pci_driver;
|
|
|
|
/** List of PCI devices */
|
|
TAILQ_HEAD(rte_pci_device_list, rte_pci_device);
|
|
/** List of PCI drivers */
|
|
TAILQ_HEAD(rte_pci_driver_list, rte_pci_driver);
|
|
|
|
/* PCI Bus iterators */
|
|
#define FOREACH_DEVICE_ON_PCIBUS(p) \
|
|
TAILQ_FOREACH(p, &(rte_pci_bus.device_list), next)
|
|
|
|
#define FOREACH_DRIVER_ON_PCIBUS(p) \
|
|
TAILQ_FOREACH(p, &(rte_pci_bus.driver_list), next)
|
|
|
|
struct rte_devargs;
|
|
|
|
enum rte_pci_kernel_driver {
|
|
RTE_PCI_KDRV_UNKNOWN = 0, /* may be misc UIO or bifurcated driver */
|
|
RTE_PCI_KDRV_IGB_UIO, /* igb_uio for Linux */
|
|
RTE_PCI_KDRV_VFIO, /* VFIO for Linux */
|
|
RTE_PCI_KDRV_UIO_GENERIC, /* uio_pci_generic for Linux */
|
|
RTE_PCI_KDRV_NIC_UIO, /* nic_uio for FreeBSD */
|
|
RTE_PCI_KDRV_NONE, /* no attached driver */
|
|
RTE_PCI_KDRV_NET_UIO, /* NetUIO for Windows */
|
|
};
|
|
|
|
/**
|
|
* A structure describing a PCI device.
|
|
*/
|
|
struct rte_pci_device {
|
|
TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
|
|
struct rte_device device; /**< Inherit core device */
|
|
struct rte_pci_addr addr; /**< PCI location. */
|
|
struct rte_pci_id id; /**< PCI ID. */
|
|
struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
|
|
/**< PCI Memory Resource */
|
|
struct rte_intr_handle intr_handle; /**< Interrupt handle */
|
|
struct rte_pci_driver *driver; /**< PCI driver used in probing */
|
|
uint16_t max_vfs; /**< sriov enable if not zero */
|
|
enum rte_pci_kernel_driver kdrv; /**< Kernel driver passthrough */
|
|
char name[PCI_PRI_STR_SIZE+1]; /**< PCI location (ASCII) */
|
|
struct rte_intr_handle vfio_req_intr_handle;
|
|
/**< Handler of VFIO request interrupt */
|
|
};
|
|
|
|
/**
|
|
* @internal
|
|
* Helper macro for drivers that need to convert to struct rte_pci_device.
|
|
*/
|
|
#define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
|
|
|
|
#define RTE_DEV_TO_PCI_CONST(ptr) \
|
|
container_of(ptr, const struct rte_pci_device, device)
|
|
|
|
#define RTE_ETH_DEV_TO_PCI(eth_dev) RTE_DEV_TO_PCI((eth_dev)->device)
|
|
|
|
#ifdef __cplusplus
|
|
/** C++ macro used to help building up tables of device IDs */
|
|
#define RTE_PCI_DEVICE(vend, dev) \
|
|
RTE_CLASS_ANY_ID, \
|
|
(vend), \
|
|
(dev), \
|
|
RTE_PCI_ANY_ID, \
|
|
RTE_PCI_ANY_ID
|
|
#else
|
|
/** Macro used to help building up tables of device IDs */
|
|
#define RTE_PCI_DEVICE(vend, dev) \
|
|
.class_id = RTE_CLASS_ANY_ID, \
|
|
.vendor_id = (vend), \
|
|
.device_id = (dev), \
|
|
.subsystem_vendor_id = RTE_PCI_ANY_ID, \
|
|
.subsystem_device_id = RTE_PCI_ANY_ID
|
|
#endif
|
|
|
|
/**
|
|
* Initialisation function for the driver called during PCI probing.
|
|
*/
|
|
typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
|
|
|
|
/**
|
|
* Uninitialisation function for the driver called during hotplugging.
|
|
*/
|
|
typedef int (pci_remove_t)(struct rte_pci_device *);
|
|
|
|
/**
|
|
* Driver-specific DMA mapping. After a successful call the device
|
|
* will be able to read/write from/to this segment.
|
|
*
|
|
* @param dev
|
|
* Pointer to the PCI device.
|
|
* @param addr
|
|
* Starting virtual address of memory to be mapped.
|
|
* @param iova
|
|
* Starting IOVA address of memory to be mapped.
|
|
* @param len
|
|
* Length of memory segment being mapped.
|
|
* @return
|
|
* - 0 On success.
|
|
* - Negative value and rte_errno is set otherwise.
|
|
*/
|
|
typedef int (pci_dma_map_t)(struct rte_pci_device *dev, void *addr,
|
|
uint64_t iova, size_t len);
|
|
|
|
/**
|
|
* Driver-specific DMA un-mapping. After a successful call the device
|
|
* will not be able to read/write from/to this segment.
|
|
*
|
|
* @param dev
|
|
* Pointer to the PCI device.
|
|
* @param addr
|
|
* Starting virtual address of memory to be unmapped.
|
|
* @param iova
|
|
* Starting IOVA address of memory to be unmapped.
|
|
* @param len
|
|
* Length of memory segment being unmapped.
|
|
* @return
|
|
* - 0 On success.
|
|
* - Negative value and rte_errno is set otherwise.
|
|
*/
|
|
typedef int (pci_dma_unmap_t)(struct rte_pci_device *dev, void *addr,
|
|
uint64_t iova, size_t len);
|
|
|
|
/**
|
|
* A structure describing a PCI driver.
|
|
*/
|
|
struct rte_pci_driver {
|
|
TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
|
|
struct rte_driver driver; /**< Inherit core driver. */
|
|
struct rte_pci_bus *bus; /**< PCI bus reference. */
|
|
pci_probe_t *probe; /**< Device Probe function. */
|
|
pci_remove_t *remove; /**< Device Remove function. */
|
|
pci_dma_map_t *dma_map; /**< device dma map function. */
|
|
pci_dma_unmap_t *dma_unmap; /**< device dma unmap function. */
|
|
const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
|
|
uint32_t drv_flags; /**< Flags RTE_PCI_DRV_*. */
|
|
};
|
|
|
|
/**
|
|
* Structure describing the PCI bus
|
|
*/
|
|
struct rte_pci_bus {
|
|
struct rte_bus bus; /**< Inherit the generic class */
|
|
struct rte_pci_device_list device_list; /**< List of PCI devices */
|
|
struct rte_pci_driver_list driver_list; /**< List of PCI drivers */
|
|
};
|
|
|
|
/** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
|
|
#define RTE_PCI_DRV_NEED_MAPPING 0x0001
|
|
/** Device needs PCI BAR mapping with enabled write combining (wc) */
|
|
#define RTE_PCI_DRV_WC_ACTIVATE 0x0002
|
|
/** Device already probed can be probed again to check for new ports. */
|
|
#define RTE_PCI_DRV_PROBE_AGAIN 0x0004
|
|
/** Device driver supports link state interrupt */
|
|
#define RTE_PCI_DRV_INTR_LSC 0x0008
|
|
/** Device driver supports device removal interrupt */
|
|
#define RTE_PCI_DRV_INTR_RMV 0x0010
|
|
/** Device driver needs to keep mapped resources if unsupported dev detected */
|
|
#define RTE_PCI_DRV_KEEP_MAPPED_RES 0x0020
|
|
/** Device driver needs IOVA as VA and cannot work with IOVA as PA */
|
|
#define RTE_PCI_DRV_NEED_IOVA_AS_VA 0x0040
|
|
|
|
/**
|
|
* Map the PCI device resources in user space virtual memory address
|
|
*
|
|
* Note that driver should not call this function when flag
|
|
* RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
|
|
* you when it's on.
|
|
*
|
|
* @param dev
|
|
* A pointer to a rte_pci_device structure describing the device
|
|
* to use
|
|
*
|
|
* @return
|
|
* 0 on success, negative on error and positive if no driver
|
|
* is found for the device.
|
|
*/
|
|
int rte_pci_map_device(struct rte_pci_device *dev);
|
|
|
|
/**
|
|
* Unmap this device
|
|
*
|
|
* @param dev
|
|
* A pointer to a rte_pci_device structure describing the device
|
|
* to use
|
|
*/
|
|
void rte_pci_unmap_device(struct rte_pci_device *dev);
|
|
|
|
/**
|
|
* Dump the content of the PCI bus.
|
|
*
|
|
* @param f
|
|
* A pointer to a file for output
|
|
*/
|
|
void rte_pci_dump(FILE *f);
|
|
|
|
/**
|
|
* Find device's extended PCI capability.
|
|
*
|
|
* @param dev
|
|
* A pointer to rte_pci_device structure.
|
|
*
|
|
* @param cap
|
|
* Extended capability to be found, which can be any from
|
|
* RTE_PCI_EXT_CAP_ID_*, defined in librte_pci.
|
|
*
|
|
* @return
|
|
* > 0: The offset of the next matching extended capability structure
|
|
* within the device's PCI configuration space.
|
|
* < 0: An error in PCI config space read.
|
|
* = 0: Device does not support it.
|
|
*/
|
|
__rte_experimental
|
|
off_t rte_pci_find_ext_capability(struct rte_pci_device *dev, uint32_t cap);
|
|
|
|
/**
|
|
* Register a PCI driver.
|
|
*
|
|
* @param driver
|
|
* A pointer to a rte_pci_driver structure describing the driver
|
|
* to be registered.
|
|
*/
|
|
void rte_pci_register(struct rte_pci_driver *driver);
|
|
|
|
/** Helper for PCI device registration from driver (eth, crypto) instance */
|
|
#define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
|
|
RTE_INIT(pciinitfn_ ##nm) \
|
|
{\
|
|
(pci_drv).driver.name = RTE_STR(nm);\
|
|
rte_pci_register(&pci_drv); \
|
|
} \
|
|
RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
|
|
|
|
/**
|
|
* Unregister a PCI driver.
|
|
*
|
|
* @param driver
|
|
* A pointer to a rte_pci_driver structure describing the driver
|
|
* to be unregistered.
|
|
*/
|
|
void rte_pci_unregister(struct rte_pci_driver *driver);
|
|
|
|
/**
|
|
* Read PCI config space.
|
|
*
|
|
* @param device
|
|
* A pointer to a rte_pci_device structure describing the device
|
|
* to use
|
|
* @param buf
|
|
* A data buffer where the bytes should be read into
|
|
* @param len
|
|
* The length of the data buffer.
|
|
* @param offset
|
|
* The offset into PCI config space
|
|
* @return
|
|
* Number of bytes read on success, negative on error.
|
|
*/
|
|
int rte_pci_read_config(const struct rte_pci_device *device,
|
|
void *buf, size_t len, off_t offset);
|
|
|
|
/**
|
|
* Write PCI config space.
|
|
*
|
|
* @param device
|
|
* A pointer to a rte_pci_device structure describing the device
|
|
* to use
|
|
* @param buf
|
|
* A data buffer containing the bytes should be written
|
|
* @param len
|
|
* The length of the data buffer.
|
|
* @param offset
|
|
* The offset into PCI config space
|
|
*/
|
|
int rte_pci_write_config(const struct rte_pci_device *device,
|
|
const void *buf, size_t len, off_t offset);
|
|
|
|
/**
|
|
* A structure used to access io resources for a pci device.
|
|
* rte_pci_ioport is arch, os, driver specific, and should not be used outside
|
|
* of pci ioport api.
|
|
*/
|
|
struct rte_pci_ioport {
|
|
struct rte_pci_device *dev;
|
|
uint64_t base;
|
|
uint64_t len; /* only filled for memory mapped ports */
|
|
};
|
|
|
|
/**
|
|
* Initialize a rte_pci_ioport object for a pci device io resource.
|
|
*
|
|
* This object is then used to gain access to those io resources (see below).
|
|
*
|
|
* @param dev
|
|
* A pointer to a rte_pci_device structure describing the device
|
|
* to use.
|
|
* @param bar
|
|
* Index of the io pci resource we want to access.
|
|
* @param p
|
|
* The rte_pci_ioport object to be initialized.
|
|
* @return
|
|
* 0 on success, negative on error.
|
|
*/
|
|
int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
|
|
struct rte_pci_ioport *p);
|
|
|
|
/**
|
|
* Release any resources used in a rte_pci_ioport object.
|
|
*
|
|
* @param p
|
|
* The rte_pci_ioport object to be uninitialized.
|
|
* @return
|
|
* 0 on success, negative on error.
|
|
*/
|
|
int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
|
|
|
|
/**
|
|
* Read from a io pci resource.
|
|
*
|
|
* @param p
|
|
* The rte_pci_ioport object from which we want to read.
|
|
* @param data
|
|
* A data buffer where the bytes should be read into
|
|
* @param len
|
|
* The length of the data buffer.
|
|
* @param offset
|
|
* The offset into the pci io resource.
|
|
*/
|
|
void rte_pci_ioport_read(struct rte_pci_ioport *p,
|
|
void *data, size_t len, off_t offset);
|
|
|
|
/**
|
|
* Write to a io pci resource.
|
|
*
|
|
* @param p
|
|
* The rte_pci_ioport object to which we want to write.
|
|
* @param data
|
|
* A data buffer where the bytes should be read into
|
|
* @param len
|
|
* The length of the data buffer.
|
|
* @param offset
|
|
* The offset into the pci io resource.
|
|
*/
|
|
void rte_pci_ioport_write(struct rte_pci_ioport *p,
|
|
const void *data, size_t len, off_t offset);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTE_BUS_PCI_H_ */
|