/** @file\r
- EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration, \r
+ EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration,\r
and DMA interfaces that a driver uses to access its PCI controller.\r
\r
- Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
- This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
EfiPciIoAttributeOperationMaximum\r
} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;\r
\r
-/** \r
+/**\r
Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is\r
- satisfied or after a defined duration. \r
- \r
+ satisfied or after a defined duration.\r
+\r
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Width Signifies the width of the memory or I/O operations.\r
@param BarIndex The BAR index of the standard PCI Configuration header to use as the\r
- base address for the memory operation to perform. \r
+ base address for the memory operation to perform.\r
@param Offset The offset within the selected BAR to start the memory operation.\r
@param Mask Mask used for the polling criteria.\r
@param Value The comparison value used for the polling exit criteria.\r
@param Delay The number of 100 ns units to poll.\r
@param Result Pointer to the last value read from the memory location.\r
- \r
+\r
@retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria.\r
@retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.\r
@retval EFI_UNSUPPORTED Offset is not valid for the BarIndex of this PCI controller.\r
@retval EFI_TIMEOUT Delay expired before a match occurred.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
OUT UINT64 *Result\r
);\r
\r
-/** \r
+/**\r
Enable a PCI driver to access PCI controller registers in the PCI memory or I/O space.\r
- \r
+\r
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Width Signifies the width of the memory or I/O operations.\r
@param BarIndex The BAR index of the standard PCI Configuration header to use as the\r
- base address for the memory or I/O operation to perform. \r
- @param Offset The offset within the selected BAR to start the memory or I/O operation. \r
+ base address for the memory or I/O operation to perform.\r
+ @param Offset The offset within the selected BAR to start the memory or I/O operation.\r
@param Count The number of memory or I/O operations to perform.\r
@param Buffer For read operations, the destination buffer to store the results. For write\r
- operations, the source buffer to write data from. \r
- \r
+ operations, the source buffer to write data from.\r
+\r
@retval EFI_SUCCESS The data was read from or written to the PCI controller.\r
@retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.\r
@retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not\r
- valid for the PCI BAR specified by BarIndex. \r
+ valid for the PCI BAR specified by BarIndex.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
EFI_PCI_IO_PROTOCOL_IO_MEM Write;\r
} EFI_PCI_IO_PROTOCOL_ACCESS;\r
\r
-/** \r
+/**\r
Enable a PCI driver to access PCI controller registers in PCI configuration space.\r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Width Signifies the width of the memory operations.\r
@param Offset The offset within the PCI configuration space for the PCI controller.\r
@param Count The number of PCI configuration operations to perform.\r
@param Buffer For read operations, the destination buffer to store the results. For write\r
operations, the source buffer to write data from.\r
- \r
- \r
+\r
+\r
@retval EFI_SUCCESS The data was read from or written to the PCI controller.\r
@retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not\r
valid for the PCI configuration header of the PCI controller.\r
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. \r
- @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is invalid. \r
- \r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
+ @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is invalid.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
EFI_PCI_IO_PROTOCOL_CONFIG Write;\r
} EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS;\r
\r
-/** \r
+/**\r
Enables a PCI driver to copy one region of PCI memory space to another region of PCI\r
memory space.\r
- \r
+\r
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Width Signifies the width of the memory operations.\r
@param DestBarIndex The BAR index in the standard PCI Configuration header to use as the\r
- base address for the memory operation to perform. \r
+ base address for the memory operation to perform.\r
@param DestOffset The destination offset within the BAR specified by DestBarIndex to\r
- start the memory writes for the copy operation. \r
+ start the memory writes for the copy operation.\r
@param SrcBarIndex The BAR index in the standard PCI Configuration header to use as the\r
- base address for the memory operation to perform. \r
+ base address for the memory operation to perform.\r
@param SrcOffset The source offset within the BAR specified by SrcBarIndex to start\r
- the memory reads for the copy operation. \r
+ the memory reads for the copy operation.\r
@param Count The number of memory operations to perform. Bytes moved is Width\r
- size * Count, starting at DestOffset and SrcOffset. \r
- \r
+ size * Count, starting at DestOffset and SrcOffset.\r
+\r
@retval EFI_SUCCESS The data was copied from one memory region to another memory region.\r
@retval EFI_UNSUPPORTED DestBarIndex not valid for this PCI controller.\r
@retval EFI_UNSUPPORTED SrcBarIndex not valid for this PCI controller.\r
@retval EFI_UNSUPPORTED The address range specified by DestOffset, Width, and Count\r
- is not valid for the PCI BAR specified by DestBarIndex. \r
+ is not valid for the PCI BAR specified by DestBarIndex.\r
@retval EFI_UNSUPPORTED The address range specified by SrcOffset, Width, and Count is\r
- not valid for the PCI BAR specified by SrcBarIndex. \r
+ not valid for the PCI BAR specified by SrcBarIndex.\r
@retval EFI_INVALID_PARAMETER Width is invalid.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN UINTN Count\r
);\r
\r
-/** \r
+/**\r
Provides the PCI controller-specific addresses needed to access system memory.\r
- \r
+\r
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Operation Indicates if the bus master is going to read or write to system memory.\r
@param HostAddress The system memory address to map to the PCI controller.\r
@param NumberOfBytes On input the number of bytes to map. On output the number of bytes\r
- that were mapped. \r
+ that were mapped.\r
@param DeviceAddress The resulting map address for the bus master PCI controller to use to\r
- access the hosts HostAddress. \r
+ access the hosts HostAddress.\r
@param Mapping A resulting value to pass to Unmap().\r
- \r
+\r
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r
- @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. \r
+ @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
OUT VOID **Mapping\r
);\r
\r
-/** \r
+/**\r
Completes the Map() operation and releases any corresponding resources.\r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Mapping The mapping value returned from Map().\r
- \r
+\r
@retval EFI_SUCCESS The range was unmapped.\r
@retval EFI_DEVICE_ERROR The data was not committed to the target system memory.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN VOID *Mapping\r
);\r
\r
-/** \r
+/**\r
Allocates pages that are suitable for an EfiPciIoOperationBusMasterCommonBuffer\r
or EfiPciOperationBusMasterCommonBuffer64 mapping.\r
- \r
+\r
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Type This parameter is not used and must be ignored.\r
@param MemoryType The type of memory to allocate, EfiBootServicesData or\r
- EfiRuntimeServicesData. \r
- @param Pages The number of pages to allocate. \r
+ EfiRuntimeServicesData.\r
+ @param Pages The number of pages to allocate.\r
@param HostAddress A pointer to store the base system memory address of the\r
- allocated range. \r
+ allocated range.\r
@param Attributes The requested bit mask of attributes for the allocated range.\r
- \r
+\r
@retval EFI_SUCCESS The requested memory pages were allocated.\r
@retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are\r
MEMORY_WRITE_COMBINE, MEMORY_CACHED and DUAL_ADDRESS_CYCLE.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. \r
- \r
+ @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN UINT64 Attributes\r
);\r
\r
-/** \r
+/**\r
Frees memory that was allocated with AllocateBuffer().\r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
- @param Pages The number of pages to free. \r
- @param HostAddress The base system memory address of the allocated range. \r
- \r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
+ @param Pages The number of pages to free.\r
+ @param HostAddress The base system memory address of the allocated range.\r
+\r
@retval EFI_SUCCESS The requested memory pages were freed.\r
@retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages\r
was not allocated with AllocateBuffer().\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN VOID *HostAddress\r
);\r
\r
-/** \r
+/**\r
Flushes all PCI posted write transactions from a PCI host bridge to system memory.\r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
- \r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
+\r
@retval EFI_SUCCESS The PCI posted write transactions were flushed from the PCI host\r
- bridge to system memory. \r
+ bridge to system memory.\r
@retval EFI_DEVICE_ERROR The PCI posted write transactions were not flushed from the PCI\r
- host bridge due to a hardware error. \r
- \r
+ host bridge due to a hardware error.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_PCI_IO_PROTOCOL *This\r
);\r
\r
-/** \r
+/**\r
Retrieves this PCI controller's current PCI bus number, device number, and function number.\r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param SegmentNumber The PCI controller's current PCI segment number.\r
@param BusNumber The PCI controller's current PCI bus number.\r
@param DeviceNumber The PCI controller's current PCI device number.\r
@param FunctionNumber The PCI controller's current PCI function number.\r
- \r
- @retval EFI_SUCCESS The PCI controller location was returned. \r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- \r
+\r
+ @retval EFI_SUCCESS The PCI controller location was returned.\r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
OUT UINTN *FunctionNumber\r
);\r
\r
-/** \r
+/**\r
Performs an operation on the attributes that this PCI controller supports. The operations include\r
- getting the set of supported attributes, retrieving the current attributes, setting the current \r
- attributes, enabling attributes, and disabling attributes. \r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
+ getting the set of supported attributes, retrieving the current attributes, setting the current\r
+ attributes, enabling attributes, and disabling attributes.\r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Operation The operation to perform on the attributes for this PCI controller.\r
@param Attributes The mask of attributes that are used for Set, Enable, and Disable\r
- operations. \r
+ operations.\r
@param Result A pointer to the result mask of attributes that are returned for the Get\r
- and Supported operations. \r
- \r
+ and Supported operations.\r
+\r
@retval EFI_SUCCESS The operation on the PCI controller's attributes was completed.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- @retval EFI_UNSUPPORTED one or more of the bits set in \r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_UNSUPPORTED one or more of the bits set in\r
Attributes are not supported by this PCI controller or one of\r
its parent bridges when Operation is Set, Enable or Disable.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
setting for this BAR with SetBarAttributes().\r
@param Resources A pointer to the resource descriptors that describe the current\r
configuration of this BAR of the PCI controller.\r
- \r
+\r
@retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI\r
controller supports are returned in Supports. If Resources\r
is not NULL, then the resource descriptors that the PCI\r
OUT VOID **Resources OPTIONAL\r
);\r
\r
-/** \r
+/**\r
Sets the attributes for a range of a BAR on a PCI controller.\r
- \r
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. \r
+\r
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.\r
@param Attributes The mask of attributes to set for the resource range specified by\r
- BarIndex, Offset, and Length. \r
+ BarIndex, Offset, and Length.\r
@param BarIndex The BAR index of the standard PCI Configuration header to use as the\r
base address for resource range. The legal range for this field is 0..5.\r
@param Offset A pointer to the BAR relative base address of the resource range to be\r
- modified by the attributes specified by Attributes. \r
+ modified by the attributes specified by Attributes.\r
@param Length A pointer to the length of the resource range to be modified by the\r
- attributes specified by Attributes. \r
- \r
- @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource \r
- range specified by BarIndex, Offset, and Length were \r
+ attributes specified by Attributes.\r
+\r
+ @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource\r
+ range specified by BarIndex, Offset, and Length were\r
set on the PCI controller, and the actual resource range is returned\r
- in Offset and Length. \r
+ in Offset and Length.\r
@retval EFI_INVALID_PARAMETER Offset or Length is NULL.\r
@retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the\r
- resource range specified by BarIndex, Offset, and \r
- Length. \r
- \r
+ resource range specified by BarIndex, Offset, and\r
+ Length.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
///\r
-/// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration, \r
-/// and DMA interfaces used to abstract accesses to PCI controllers. \r
-/// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus. \r
-/// A device driver that wishes to manage a PCI controller in a system will have to \r
-/// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller. \r
+/// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration,\r
+/// and DMA interfaces used to abstract accesses to PCI controllers.\r
+/// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus.\r
+/// A device driver that wishes to manage a PCI controller in a system will have to\r
+/// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller.\r
///\r
struct _EFI_PCI_IO_PROTOCOL {\r
EFI_PCI_IO_PROTOCOL_POLL_IO_MEM PollMem;\r
EFI_PCI_IO_PROTOCOL_ATTRIBUTES Attributes;\r
EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES GetBarAttributes;\r
EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES SetBarAttributes;\r
- \r
+\r
///\r
/// The size, in bytes, of the ROM image.\r
///\r
UINT64 RomSize;\r
\r
///\r
- /// A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible \r
- /// for allocating memory for the ROM image, and copying the contents of the ROM to memory. \r
- /// The contents of this buffer are either from the PCI option ROM that can be accessed \r
- /// through the ROM BAR of the PCI controller, or it is from a platform-specific location. \r
- /// The Attributes() function can be used to determine from which of these two sources \r
+ /// A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible\r
+ /// for allocating memory for the ROM image, and copying the contents of the ROM to memory.\r
+ /// The contents of this buffer are either from the PCI option ROM that can be accessed\r
+ /// through the ROM BAR of the PCI controller, or it is from a platform-specific location.\r
+ /// The Attributes() function can be used to determine from which of these two sources\r
/// the RomImage buffer was initialized.\r
- /// \r
+ ///\r
VOID *RomImage;\r
};\r
\r