/** @file\r
PCI Root Bridge I/O protocol as defined in the UEFI 2.0 specification.\r
\r
- PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O, \r
- and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform \r
+ PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O,\r
+ and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform\r
defferent types of bus mastering DMA.\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
UINT32 ExtendedRegister;\r
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS;\r
\r
-/** \r
+/**\r
Reads from the I/O space of a PCI Root Bridge. Returns when either the polling exit criteria is\r
satisfied or after a defined duration.\r
- \r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
@param Width Signifies the width of the memory or I/O operations.\r
- @param Address The base address of the memory or I/O operations. \r
+ @param Address The base address of the memory or I/O operations.\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_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
Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.\r
- \r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
@param Width Signifies the width of the memory operations.\r
- @param Address The base address of the memory operations. \r
+ @param Address The base address of the memory operations.\r
@param Count The number of memory 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
- @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. \r
+ operations, the source buffer to write data from.\r
+\r
+ @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.\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_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM Write;\r
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS;\r
\r
-/** \r
+/**\r
Enables a PCI driver to copy one region of PCI root bridge memory space to another region of PCI\r
- root bridge memory space. \r
- \r
+ root bridge memory space.\r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.\r
@param Width Signifies the width of the memory operations.\r
- @param DestAddress The destination address of the memory operation. \r
- @param SrcAddress The source address of the memory operation. \r
- @param Count The number of memory operations to perform. \r
- \r
- @retval EFI_SUCCESS The data was copied from one memory region to another memory region. \r
+ @param DestAddress The destination address of the memory operation.\r
+ @param SrcAddress The source address of the memory operation.\r
+ @param Count The number of memory operations to perform.\r
+\r
+ @retval EFI_SUCCESS The data was copied from one memory region to another memory region.\r
@retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.\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 required to access system memory from a\r
- DMA bus master. \r
- \r
+ DMA bus master.\r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\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
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
@param Mapping The mapping value returned from Map().\r
- \r
+\r
@retval EFI_SUCCESS The range was unmapped.\r
@retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map().\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 EfiPciOperationBusMasterCommonBuffer or\r
- EfiPciOperationBusMasterCommonBuffer64 mapping. \r
- \r
+ EfiPciOperationBusMasterCommonBuffer64 mapping.\r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\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 and MEMORY_CACHED. \r
+ MEMORY_WRITE_COMBINE and MEMORY_CACHED.\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
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
- @param Pages The number of pages to free. \r
- @param HostAddress The base system memory address of the allocated range. \r
- \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
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
- \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_ROOT_BRIDGE_IO_PROTOCOL *This\r
);\r
\r
-/** \r
+/**\r
Gets the attributes that a PCI root bridge supports setting with SetAttributes(), and the\r
- attributes that a PCI root bridge is currently using. \r
- \r
+ attributes that a PCI root bridge is currently using.\r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
@param Supports A pointer to the mask of attributes that this PCI root bridge supports\r
- setting with SetAttributes(). \r
+ setting with SetAttributes().\r
@param Attributes A pointer to the mask of attributes that this PCI root bridge is currently\r
- using. \r
- \r
- @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI root \r
- bridge supports is returned in Supports. If Attributes is \r
+ using.\r
+\r
+ @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI root\r
+ bridge supports is returned in Supports. If Attributes is\r
not NULL, then the attributes that the PCI root bridge is currently\r
- using is returned in Attributes. \r
+ using is returned in Attributes.\r
@retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.\r
- \r
- \r
+\r
+\r
**/\r
typedef\r
EFI_STATUS\r
OUT UINT64 *Attributes\r
);\r
\r
-/** \r
+/**\r
Sets attributes for a resource range on a PCI root bridge.\r
- \r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
@param Attributes The mask of attributes to set.\r
@param ResourceBase A pointer to the base address of the resource range to be modified by the\r
attributes specified by Attributes.\r
@param ResourceLength 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 ResourceBase and ResourceLength \r
+ attributes specified by Attributes.\r
+\r
+ @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource\r
+ range specified by ResourceBase and ResourceLength\r
were set on the PCI root bridge, and the actual resource range is\r
- returned in ResuourceBase and ResourceLength. \r
+ returned in ResuourceBase and ResourceLength.\r
@retval EFI_UNSUPPORTED A bit is set in Attributes that is not supported by the PCI Root\r
- Bridge. \r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the \r
- resource range specified by BaseAddress and Length. \r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
- \r
+ Bridge.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the\r
+ resource range specified by BaseAddress and Length.\r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN OUT UINT64 *ResourceLength\r
);\r
\r
-/** \r
+/**\r
Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI\r
resource descriptors.\r
- \r
+\r
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
@param Resources A pointer to the resource descriptors that describe the current\r
configuration of this PCI root bridge.\r
);\r
\r
///\r
-/// Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are \r
-/// used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller. \r
+/// Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are\r
+/// used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller.\r
///\r
struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL {\r
///\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES GetAttributes;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES SetAttributes;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION Configuration;\r
- \r
+\r
///\r
/// The segment number that this PCI root bridge resides.\r
///\r
projects / mirror_edk2.git / blobdiff