Peripheral Component Interconnect express Bus (PCIe)

Overview

API Reference

group pcie_host_interface

PCIe Host Interface.

Defines

PCIE_ID_IS_VALID(id)

PCIE_DT_ID(node_id)

Get the PCIe Vendor and Device ID for a node.

Parameters:

node_id – DTS node identifier

Returns:

The VID/DID combination as pcie_id_t

PCIE_DT_INST_ID(inst)

Get the PCIe Vendor and Device ID for a node.

This is equivalent to PCIE_DT_ID(DT_DRV_INST(inst))

Parameters:

inst – Devicetree instance number

Returns:

The VID/DID combination as pcie_id_t

DEVICE_PCIE_DECLARE(node_id)

Declare a PCIe context variable for a DTS node.

Declares a PCIe context for a DTS node. This must be done before using the DEVICE_PCIE_INIT() macro for the same node.

Parameters:

node_id – DTS node identifier

DEVICE_PCIE_INST_DECLARE(inst)

Declare a PCIe context variable for a DTS node.

This is equivalent to DEVICE_PCIE_DECLARE(DT_DRV_INST(inst))

Parameters:

inst – Devicetree instance number

DEVICE_PCIE_INIT(node_id, name)

Initialize a named struct member to point at a PCIe context.

Initialize PCIe-related information within a specific instance of a device config struct, using information from DTS. Using the macro requires having first created PCIe context struct using the DEVICE_PCIE_DECLARE() macro.

Example for an instance of a driver belonging to the “foo” subsystem

struct foo_config { struct pcie_dev *pcie; … };

DEVICE_PCIE_ID_DECLARE(DT_DRV_INST(…)); struct foo_config my_config = { DEVICE_PCIE_INIT(pcie, DT_DRV_INST(…)), … };

Parameters:

node_id – DTS node identifier
name – Member name within config for the MMIO region

DEVICE_PCIE_INST_INIT(inst, name)

Initialize a named struct member to point at a PCIe context.

This is equivalent to DEVICE_PCIE_INIT(DT_DRV_INST(inst), name)

Parameters:

inst – Devicetree instance number
name – Name of the struct member (of type struct pcie_dev *)

PCIE_HOST_CONTROLLER(n)

Get the BDF for a given PCI host controller.

This macro is useful when the PCI host controller behind PCIE_BDF(0, 0, 0) indicates a multifunction device. In such a case each function of this endpoint is a potential host controller itself.

Parameters:

n – Bus number

Returns:

BDF value of the given host controller

PCIE_CONF_CAPPTR

PCIE_CONF_CAPPTR_FIRST(w)

PCIE_CONF_CAP_ID(w)

PCIE_CONF_CAP_NEXT(w)

PCIE_CONF_EXT_CAPPTR

PCIE_CONF_EXT_CAP_ID(w)

PCIE_CONF_EXT_CAP_VER(w)

PCIE_CONF_EXT_CAP_NEXT(w)

PCIE_CONF_ID

PCIE_CONF_CMDSTAT

PCIE_CONF_CMDSTAT_IO

PCIE_CONF_CMDSTAT_MEM

PCIE_CONF_CMDSTAT_MASTER

PCIE_CONF_CMDSTAT_INTERRUPT

PCIE_CONF_CMDSTAT_CAPS

PCIE_CONF_CLASSREV

PCIE_CONF_CLASSREV_CLASS(w)

PCIE_CONF_CLASSREV_SUBCLASS(w)

PCIE_CONF_CLASSREV_PROGIF(w)

PCIE_CONF_CLASSREV_REV(w)

PCIE_CONF_TYPE

PCIE_CONF_MULTIFUNCTION(w)

PCIE_CONF_TYPE_BRIDGE(w)

PCIE_CONF_TYPE_GET(w)

PCIE_CONF_TYPE_STANDARD

PCIE_CONF_TYPE_PCI_BRIDGE

PCIE_CONF_TYPE_CARDBUS_BRIDGE

PCIE_CONF_BAR0

PCIE_CONF_BAR1

PCIE_CONF_BAR2

PCIE_CONF_BAR3

PCIE_CONF_BAR4

PCIE_CONF_BAR5

PCIE_CONF_BAR_IO(w)

PCIE_CONF_BAR_MEM(w)

PCIE_CONF_BAR_64(w)

PCIE_CONF_BAR_ADDR(w)

PCIE_CONF_BAR_IO_ADDR(w)

PCIE_CONF_BAR_FLAGS(w)

PCIE_CONF_BAR_NONE

PCIE_CONF_BAR_INVAL

PCIE_CONF_BAR_INVAL64

PCIE_CONF_BAR_INVAL_FLAGS(w)

PCIE_BUS_NUMBER

PCIE_BUS_PRIMARY_NUMBER(w)

PCIE_BUS_SECONDARY_NUMBER(w)

PCIE_BUS_SUBORDINATE_NUMBER(w)

PCIE_SECONDARY_LATENCY_TIMER(w)

PCIE_BUS_NUMBER_VAL(prim, sec, sub, lat)

PCIE_IO_SEC_STATUS

PCIE_IO_BASE(w)

PCIE_IO_LIMIT(w)

PCIE_SEC_STATUS(w)

PCIE_IO_SEC_STATUS_VAL(iob, iol, sec_status)

PCIE_MEM_BASE_LIMIT

PCIE_MEM_BASE(w)

PCIE_MEM_LIMIT(w)

PCIE_MEM_BASE_LIMIT_VAL(memb, meml)

PCIE_PREFETCH_BASE_LIMIT

PCIE_PREFETCH_BASE(w)

PCIE_PREFETCH_LIMIT(w)

PCIE_PREFETCH_BASE_LIMIT_VAL(pmemb, pmeml)

PCIE_PREFETCH_BASE_UPPER

PCIE_PREFETCH_LIMIT_UPPER

PCIE_IO_BASE_LIMIT_UPPER

PCIE_IO_BASE_UPPER(w)

PCIE_IO_LIMIT_UPPER(w)

PCIE_IO_BASE_LIMIT_UPPER_VAL(iobu, iolu)

PCIE_CONF_INTR

PCIE_CONF_INTR_IRQ(w)

PCIE_CONF_INTR_IRQ_NONE

PCIE_MAX_BUS

PCIE_MAX_DEV

PCIE_MAX_FUNC

PCIE_IRQ_CONNECT(bdf_p, irq_p, priority_p, isr_p, isr_param_p, flags_p)

Initialize an interrupt handler for a PCIe endpoint IRQ.

This routine is only meant to be used by drivers using PCIe bus and having fixed or MSI based IRQ (so no runtime detection of the IRQ). In case of runtime detection see pcie_connect_dynamic_irq()

Parameters:

bdf_p – PCIe endpoint BDF
irq_p – IRQ line number.
priority_p – Interrupt priority.
isr_p – Address of interrupt service routine.
isr_param_p – Parameter passed to interrupt service routine.
flags_p – Architecture-specific IRQ configuration flags..

Typedefs

typedef uint32_t pcie_bdf_t

A unique PCI(e) endpoint (bus, device, function).

A PCI(e) endpoint is uniquely identified topologically using a (bus, device, function) tuple. The internal structure is documented in include/dt-bindings/pcie/pcie.h: see PCIE_BDF() and friends, since these tuples are referenced from devicetree.

typedef uint32_t pcie_id_t

A unique PCI(e) identifier (vendor ID, device ID).

The PCIE_CONF_ID register for each endpoint is a (vendor ID, device ID) pair, which is meant to tell the system what the PCI(e) endpoint is. Again, look to PCIE_ID_* macros in include/dt-bindings/pcie/pcie.h for more.

typedef bool (*pcie_scan_cb_t)(pcie_bdf_t bdf, pcie_id_t id, void *cb_data)

Callback type used for scanning for PCI endpoints.

Param bdf:: BDF value for a found endpoint.
Param id:: Vendor & Device ID for the found endpoint.
Param cb_data:: Custom, use case specific data.
Return:: true to continue scanning, false to stop scanning.

Enums

enum [anonymous]

Values:

enumerator PCIE_SCAN_RECURSIVE = BIT(0): Scan all available PCI host controllers and sub-busses.

enumerator PCIE_SCAN_CB_ALL = BIT(1): Do the callback for all endpoint types, including bridges.

Functions

pcie_bdf_t pcie_bdf_lookup(pcie_id_t id)

Look up the BDF based on PCI(e) vendor & device ID.

This function is used to look up the BDF for a device given its vendor and device ID.

Deprecated: