/** @file\r
- This PPI provides a set of memory- and I/O-based services. \r
+ This PPI provides a set of memory and I/O-based services. \r
The perspective of the services is that of the processor, not the bus or system.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation \r
- All rights reserved. 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 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This PPI is introduced in PI Version 1.0.\r
typedef struct _EFI_PEI_CPU_IO_PPI EFI_PEI_CPU_IO_PPI;\r
\r
///\r
-/// *******************************************************\r
-/// EFI_PEI_CPU_IO_PPI_WIDTH\r
-/// *******************************************************\r
+/// EFI_PEI_CPU_IO_PPI_WIDTH.\r
///\r
typedef enum {\r
EfiPeiCpuIoWidthUint8,\r
/**\r
Memory-based access services and I/O-based access services.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table\r
- published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Width The width of the access. Enumerated in bytes.\r
- @param Address The physical address of the access.\r
- @param Count The number of accesses to perform.\r
- @param Buffer A pointer to the buffer of data.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table\r
+ published by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Width The width of the access. Enumerated in bytes.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Count The number of accesses to perform.\r
+ @param[in, out] Buffer A pointer to the buffer of data.\r
\r
- @retval EFI_SUCCESS The function completed successfully.\r
- @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_MEM)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN EFI_PEI_CPU_IO_PPI_WIDTH Width,\r
- IN UINT64 Address,\r
- IN UINTN Count,\r
- IN OUT VOID *Buffer\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN EFI_PEI_CPU_IO_PPI_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ IN OUT VOID *Buffer\r
);\r
\r
///\r
-/// *******************************************************\r
/// EFI_PEI_CPU_IO_PPI_ACCESS\r
-/// *******************************************************\r
///\r
typedef struct {\r
///\r
/// This service provides the various modalities of memory and I/O read.\r
///\r
- EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r
+ EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r
///\r
/// This service provides the various modalities of memory and I/O write.\r
///\r
- EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r
+ EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r
} EFI_PEI_CPU_IO_PPI_ACCESS;\r
\r
/**\r
8-bit I/O read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return An 8-bit value returned from the I/O space.\r
+ @return An 8-bit value returned from the I/O space.\r
\r
**/\r
typedef\r
UINT8\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ8)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
16-bit I/O read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return A 16-bit value returned from the I/O space.\r
+ @return A 16-bit value returned from the I/O space.\r
\r
**/\r
typedef\r
UINT16\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ16)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
32-bit I/O read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return A 32-bit value returned from the I/O space.\r
+ @return A 32-bit value returned from the I/O space.\r
\r
**/\r
typedef\r
UINT32\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ32)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
64-bit I/O read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return A 64-bit value returned from the I/O space.\r
+ @return A 64-bit value returned from the I/O space.\r
\r
**/\r
typedef\r
UINT64\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ64)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
8-bit I/O write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE8)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT8 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT8 Data\r
);\r
\r
/**\r
16-bit I/O write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE16)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT16 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT16 Data\r
);\r
\r
/**\r
32-bit I/O write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE32)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT32 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT32 Data\r
);\r
\r
/**\r
64-bit I/O write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE64)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT64 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT64 Data\r
);\r
\r
/**\r
8-bit memory read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return An 8-bit value returned from the memory space.\r
+ @return An 8-bit value returned from the memory space.\r
\r
**/\r
typedef\r
UINT8\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ8)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
16-bit memory read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return A 16-bit value returned from the memory space.\r
+ @return A 16-bit value returned from the memory space.\r
\r
**/\r
typedef\r
UINT16\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ16)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
32-bit memory read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return A 32-bit value returned from the memory space.\r
+ @return A 32-bit value returned from the memory space.\r
\r
**/\r
typedef\r
UINT32\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ32)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
64-bit memory read operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
\r
- @return A 64-bit value returned from the memory space.\r
+ @return A 64-bit value returned from the memory space.\r
\r
**/\r
typedef\r
UINT64\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ64)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address\r
);\r
\r
/**\r
8-bit memory write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE8)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT8 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT8 Data\r
);\r
\r
/**\r
16-bit memory write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE16)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT16 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT16 Data\r
);\r
\r
/**\r
32-bit memory write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE32)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT32 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT32 Data\r
);\r
\r
/**\r
64-bit memory write operations.\r
\r
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
- @param This Pointer to local data for the interface.\r
- @param Address The physical address of the access.\r
- @param Data The data to write.\r
+ @param[in] PeiServices An indirect pointer to the PEI Services Table published \r
+ by the PEI Foundation.\r
+ @param[in] This The pointer to local data for the interface.\r
+ @param[in] Address The physical address of the access.\r
+ @param[in] Data The data to write.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE64)(\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST EFI_PEI_CPU_IO_PPI *This,\r
- IN UINT64 Address,\r
- IN UINT64 Data\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_CPU_IO_PPI *This,\r
+ IN UINT64 Address,\r
+ IN UINT64 Data\r
);\r
\r
///\r
/// EFI_PEI_CPU_IO_PPI provides a set of memory and I/O-based services.\r
-/// The perspective of the services is that of the processor, not the bus or system.\r
+/// The perspective of the services is that of the processor, not that of the \r
+/// bus or system.\r
///\r
struct _EFI_PEI_CPU_IO_PPI {\r
- EFI_PEI_CPU_IO_PPI_ACCESS Mem; ///< Collection of memory-access services.\r
- EFI_PEI_CPU_IO_PPI_ACCESS Io; ///< Collection of I/O-access services.\r
+ ///\r
+ /// Collection of memory-access services.\r
+ ///\r
+ EFI_PEI_CPU_IO_PPI_ACCESS Mem;\r
+ ///\r
+ /// Collection of I/O-access services.\r
+ ///\r
+ EFI_PEI_CPU_IO_PPI_ACCESS Io;\r
\r
EFI_PEI_CPU_IO_PPI_IO_READ8 IoRead8;\r
EFI_PEI_CPU_IO_PPI_IO_READ16 IoRead16;\r
projects / mirror_edk2.git / blobdiff