PCI/endpoint/pci-endpoint.rst

5 This document is a guide to use the PCI Endpoint Framework in order to create
6 endpoint controller driver, endpoint function driver, and using configfs
19 either in Root Complex mode or Endpoint mode. PCI Endpoint Framework will
20 add endpoint mode support in Linux. This will help to run Linux in an
24 PCI Endpoint Core
27 The PCI Endpoint Core layer comprises 3 components: the Endpoint Controller
28 library, the Endpoint Function library, and the configfs layer to bind the
29 endpoint function with the endpoint controller.
31 PCI Endpoint Controller(EPC) Library
35 in endpoint mode. It also provides APIs to be used by function driver/library
36 in order to implement a particular endpoint function.
41 This section lists the APIs that the PCI Endpoint core provides to be used
80 EPC APIs for the PCI Endpoint Function Driver
83 This section lists the APIs that the PCI Endpoint core provides to be used
84 by the PCI endpoint function driver.
88    The PCI endpoint function driver should use pci_epc_write_header() to
89    write the standard configuration header to the endpoint controller.
93    The PCI endpoint function driver should use pci_epc_set_bar() to configure
100    The PCI endpoint function driver should use pci_epc_clear_bar() to reset
105    The PCI endpoint function driver should use pci_epc_raise_irq() to raise
110    The PCI endpoint function driver should use pci_epc_mem_alloc_addr(), to
116    The PCI endpoint function driver should use pci_epc_mem_free_addr() to
121   A PCI endpoint function driver should use pci_epc_map_addr() to map to a RC
127   A PCI endpoint function driver should use pci_epc_unmap_addr() to unmap the
132   A PCI endpoint controller may impose constraints on the RC PCI addresses that
133   can be mapped. The function pci_epc_mem_map() allows endpoint function
144   A PCI endpoint function driver can use pci_epc_mem_unmap() to unmap and free
157    Get a reference to the PCI endpoint controller based on the device name of
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.
176    The PCI endpoint function driver should invoke pci_epc_start() once it
177    has configured the endpoint function and wants to start the PCI link.
181    The PCI endpoint function driver should invoke pci_epc_stop() to stop
185 PCI Endpoint Function(EPF) Library
189 library to provide endpoint mode functionality.
191 EPF APIs for the PCI Endpoint Function Driver
194 This section lists the APIs that the PCI Endpoint core provides to be used
195 by the PCI endpoint function driver.
199    The PCI Endpoint Function driver should implement the following ops:
224 APIs for the PCI Endpoint Controller Library
227 This section lists the APIs that the PCI Endpoint core provides to be used
228 by the PCI endpoint controller library.
232    The PCI endpoint controller library invokes pci_epf_linkup() when the