diff options
| author | rsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-08-31 03:23:38 +0000 |
|---|---|---|
| committer | rsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-08-31 03:23:38 +0000 |
| commit | 0495739faa2213714a3e413c4471af69960b1e76 (patch) | |
| tree | ba1bb06c36cb19e6603ea3e0f890ca946a48221d /MdePkg/Include/Protocol/SmmCpuIo.h | |
| parent | a29a93b4bda3a7cb0a7152bb9888731dfbcf4db3 (diff) | |
| download | edk2-platforms-0495739faa2213714a3e413c4471af69960b1e76.tar.xz | |
Add into MdePkg definitions for the SMM Cpu I/O Protocol defined in the PI 1.2 specification.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9208 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/SmmCpuIo.h')
| -rw-r--r-- | MdePkg/Include/Protocol/SmmCpuIo.h | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/MdePkg/Include/Protocol/SmmCpuIo.h b/MdePkg/Include/Protocol/SmmCpuIo.h new file mode 100644 index 0000000000..90d0e93428 --- /dev/null +++ b/MdePkg/Include/Protocol/SmmCpuIo.h @@ -0,0 +1,87 @@ +/** @file
+ SMM CPU I/O protocol as defined in the PI 1.2 specification.
+
+ This protocol provides CPU I/O and memory access within SMM.
+
+ Copyright (c) 2009, Intel Corporation
+ All rights reserved. This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _SMM_CPU_IO_H_
+#define _SMM_CPU_IO_H_
+
+#define EFI_SMM_CPU_IO_PROTOCOL_GUID \
+ { \
+ 0x3242A9D8, 0xCE70, 0x4AA0, { 0x95, 0x5D, 0x5E, 0x7B, 0x14, 0x0D, 0xE4, 0xD2 } \
+ }
+
+typedef struct _EFI_SMM_CPU_IO_PROTOCOL EFI_SMM_CPU_IO_PROTOCOL;
+
+///
+/// Width of the SMM CPU I/O operations
+///
+typedef enum {
+ SMM_IO_UINT8 = 0,
+ SMM_IO_UINT16 = 1,
+ SMM_IO_UINT32 = 2,
+ SMM_IO_UINT64 = 3
+} EFI_SMM_IO_WIDTH;
+
+/**
+ Provides the basic memory and I/O interfaces used toabstract accesses to devices.
+
+ The I/O operations are carried out exactly as requested. The caller is responsible for any alignment
+ and I/O width issues that the bus, device, platform, or type of I/O might require.
+
+ @param[in] This The EFI_SMM_CPU_IO_PROTOCOL instance.
+ @param[in] Width Signifies the width of the I/O operations.
+ @param[in] Address The base address of the I/O operations.
+ The caller is responsible for aligning the Address if required.
+ @param[in] Count The number of I/O operations to perform.
+ @param[in,out] Buffer For read operations, the destination buffer to store the results.
+ For write operations, the source buffer from which to write data.
+
+ @retval EFI_SUCCESS The data was read from or written to the device.
+ @retval EFI_UNSUPPORTED The Address is not valid for this system.
+ @retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_SMM_CPU_IO)(
+ IN CONST EFI_SMM_CPU_IO_PROTOCOL *This,
+ IN EFI_SMM_IO_WIDTH Width,
+ IN UINT64 Address,
+ IN UINTN Count,
+ IN OUT VOID *Buffer
+ );
+
+typedef struct {
+ ///
+ /// This service provides the various modalities of memory and I/O read.
+ ///
+ EFI_SMM_CPU_IO Read;
+ ///
+ /// This service provides the various modalities of memory and I/O write.
+ ///
+ EFI_SMM_CPU_IO Write;
+} EFI_SMM_IO_ACCESS;
+
+///
+/// SMM CPU I/O Protocol provides CPU I/O and memory access within SMM.
+///
+typedef struct _EFI_SMM_CPU_IO_PROTOCOL {
+ EFI_SMM_IO_ACCESS Mem; ///< Allows reads and writes to memory-mapped I/O space.
+ EFI_SMM_IO_ACCESS Io; ///< Allows reads and writes to I/O space.
+};
+
+extern EFI_GUID gEfiSmmCpuIoProtocolGuid;
+
+#endif
|