pcie_ep_driver_api Struct Reference

Driver Operations PCIe Endpoint driver operations More...

#include <zephyr/drivers/pcie/endpoint/pcie_ep.h>

Data Fields
pcie_ep_api_conf_read	conf_read
	REQ Read PCIe EP configuration space.
pcie_ep_api_conf_write	conf_write
	REQ Write PCIe EP configuration space.
pcie_ep_api_map_addr	map_addr
	REQ Map a host memory buffer to PCIe outbound region.
pcie_ep_api_unmap_addr	unmap_addr
	REQ Remove mapping to PCIe outbound region.
pcie_ep_api_raise_irq	raise_irq
	REQ Raise interrupt to Host.
pcie_ep_api_register_reset_cb	register_reset_cb
	OPT Register callback function for reset interrupts.
pcie_ep_api_dma_xfer	dma_xfer
	OPT Data transfer between mapped Host memory and device memory with "System DMA".

Detailed Description

Driver Operations PCIe Endpoint driver operations

This is the driver API structure any PCIe Endpoint driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also

DEVICE_DT_INST_DEFINE()

DEVICE_DT_DEFINE()

DEVICE_API()

Field Documentation

conf_read

pcie_ep_api_conf_read pcie_ep_driver_api::conf_read

REQ Read PCIe EP configuration space.

conf_write

pcie_ep_api_conf_write pcie_ep_driver_api::conf_write

REQ Write PCIe EP configuration space.

dma_xfer

pcie_ep_api_dma_xfer pcie_ep_driver_api::dma_xfer

OPT Data transfer between mapped Host memory and device memory with "System DMA".

map_addr

pcie_ep_api_map_addr pcie_ep_driver_api::map_addr

REQ Map a host memory buffer to PCIe outbound region.

raise_irq

pcie_ep_api_raise_irq pcie_ep_driver_api::raise_irq

REQ Raise interrupt to Host.

register_reset_cb

pcie_ep_api_register_reset_cb pcie_ep_driver_api::register_reset_cb

OPT Register callback function for reset interrupts.

unmap_addr

pcie_ep_api_unmap_addr pcie_ep_driver_api::unmap_addr

REQ Remove mapping to PCIe outbound region.

---

The documentation for this struct was generated from the following file:

• zephyr/drivers/pcie/endpoint/pcie_ep.h