PCI/endpoint/pci-endpoint.rst

1 .. SPDX-License-Identifier: GPL-2.0
6 endpoint controller driver, endpoint function driver, and using configfs
7 interface to bind the function driver to the controller driver.
14 assign memory resources and IRQ resources, load PCI driver (based on
15 vendor ID, device ID), support other services like hot-plug, power management,
18 However the PCI controller IP integrated in some SoCs is capable of operating
22 validation, co-processor accelerator, etc.
27 The PCI Endpoint Core layer comprises 3 components: the Endpoint Controller
29 endpoint function with the endpoint controller.
31 PCI Endpoint Controller(EPC) Library
32 ------------------------------------
34 The EPC library provides APIs to be used by the controller that can operate
38 APIs for the PCI controller Driver
42 by the PCI controller driver.
46    The PCI controller driver should implement the following ops:
51 	 * alloc_addr_space: ops to allocate in PCI controller address space
53 	 * raise_irq: ops to raise a legacy, MSI or MSI-X interrupt
57    The PCI controller driver can then create a new EPC device by invoking
62    The PCI controller driver can destroy the EPC device created by
68    they are linked has established a link with the host, the PCI controller
89    write the standard configuration header to the endpoint controller.
106    Legacy Interrupt, MSI or MSI-X Interrupt.
111    allocate memory address from EPC addr space which is required to access
117    free the memory space allocated using pci_epc_mem_alloc_addr().
122   PCI address the CPU address of local memory obtained with
128   CPU address of local memory mapped to a RC address with pci_epc_map_addr().
132   A PCI endpoint controller may impose constraints on the RC PCI addresses that
134   drivers to allocate and map controller memory while handling such
135   constraints. This function will determine the size of the memory that must be
139   well as the offset into the allocated memory to use for accessing the mapped
145   controller memory that was allocated and mapped using pci_epc_mem_map().
152 the EPF device with EPC device. pci-ep-cfs.c can be used as reference for
157    Get a reference to the PCI endpoint controller based on the device name of
158    the controller.
162    Release the reference to the PCI endpoint controller obtained using
167    Add a PCI endpoint function to a PCI endpoint controller. A PCIe device
172    Remove the PCI endpoint function from PCI endpoint controller.
186 ----------------------------------
224 APIs for the PCI Endpoint Controller Library
228 by the PCI endpoint controller library.
232    The PCI endpoint controller library invokes pci_epf_linkup() when the
240 pci-ep-cfs.c can be used as reference for using these APIs.