-/** @file\r
- Internal include file for the CPU I/O 2 Protocol implementation.\r
-\r
-Copyright (c) 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
-\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
-#ifndef _CPU_IO2_H_\r
-#define _CPU_IO2_H_\r
-\r
-#include <Protocol/CpuIo2.h>\r
-\r
-#include <Library/DebugLib.h>\r
-#include <Library/IoLib.h>\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-\r
-#define IA32_MAX_IO_ADDRESS 0xFFFF\r
-\r
-typedef union {\r
- UINT8 volatile *Buf;\r
- UINT8 volatile *Ui8;\r
- UINT16 volatile *Ui16;\r
- UINT32 volatile *Ui32;\r
- UINT64 volatile *Ui64;\r
- UINTN volatile Ui;\r
-} PTR;\r
-\r
-/**\r
- Enables a driver to read memory-mapped registers in the PI System memory space.\r
-\r
- @param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance.\r
- @param[in] Width Signifies the width of the memory operation.\r
- @param[in] Address The base address of the memory operation.\r
- @param[in] Count The number of memory operations to perform. The number of bytes moved\r
- is Width size * Count, starting at Address.\r
- @param[out] Buffer The destination buffer to store the results.\r
-\r
- @retval EFI_SUCCESS The data was read from or written to the EFI system.\r
- @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.\r
- @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.\r
- Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CpuMemoryServiceRead (\r
- IN EFI_CPU_IO2_PROTOCOL *This,\r
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
- IN UINT64 Address,\r
- IN UINTN Count,\r
- OUT VOID *Buffer\r
- );\r
-\r
-/**\r
- Enables a driver to write memory-mapped registers in the PI System memory space.\r
-\r
- @param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance.\r
- @param[in] Width Signifies the width of the memory operation.\r
- @param[in] Address The base address of the memory operation.\r
- @param[in] Count The number of memory operations to perform. The number of bytes moved\r
- is Width size * Count, starting at Address.\r
- @param[in] Buffer The source buffer from which to write data.\r
-\r
- @retval EFI_SUCCESS The data was read from or written to the EFI system.\r
- @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.\r
- @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.\r
- Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CpuMemoryServiceWrite (\r
- IN EFI_CPU_IO2_PROTOCOL *This,\r
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
- IN UINT64 Address,\r
- IN UINTN Count,\r
- IN VOID *Buffer\r
- );\r
-\r
-/**\r
- Enables a driver to read registers in the PI CPU I/O space.\r
-\r
- @param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance.\r
- @param[in] Width Signifies the width of the I/O operation.\r
- @param[in] UserAddress The base address of the I/O operation. The caller is responsible\r
- for aligning the Address if required. \r
- @param[in] Count The number of I/O operations to perform. The number of bytes moved\r
- is Width size * Count, starting at Address.\r
- @param[out] UserBuffer The destination buffer to store the results.\r
-\r
- @retval EFI_SUCCESS The data was read from or written to the EFI system.\r
- @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.\r
- @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.\r
- Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CpuIoServiceRead (\r
- IN EFI_CPU_IO2_PROTOCOL *This,\r
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
- IN UINT64 UserAddress,\r
- IN UINTN Count,\r
- OUT VOID *UserBuffer\r
- );\r
-\r
-/**\r
- Enables a driver to write registers in the PI CPU I/O space.\r
-\r
- @param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance.\r
- @param[in] Width Signifies the width of the I/O operation.\r
- @param[in] UserAddress The base address of the I/O operation. The caller is responsible\r
- for aligning the Address if required. \r
- @param[in] Count The number of I/O operations to perform. The number of bytes moved\r
- is Width size * Count, starting at Address.\r
- @param[in] UserBuffer The source buffer from which to write data.\r
-\r
- @retval EFI_SUCCESS The data was read from or written to the EFI system.\r
- @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.\r
- @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.\r
- Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CpuIoServiceWrite (\r
- IN EFI_CPU_IO2_PROTOCOL *This,\r
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
- IN UINT64 UserAddress,\r
- IN UINTN Count,\r
- IN VOID *UserBuffer\r
- );\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff