--- /dev/null
+/** @file\r
+ Produces the SMM CPU I/O Protocol.\r
+\r
+Copyright (c) 2009 - 2010, 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
+#include <PiSmm.h>\r
+\r
+#include <Protocol/SmmCpuIo2.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/IoLib.h>\r
+#include <Library/SmmServicesTableLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+\r
+#define MAX_IO_PORT_ADDRESS 0xFFFF\r
+\r
+//\r
+// Function Prototypes\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+CpuMemoryServiceRead (\r
+ IN CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+CpuMemoryServiceWrite (\r
+ IN CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+CpuIoServiceRead (\r
+ IN CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+CpuIoServiceWrite (\r
+ IN CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ );\r
+\r
+//\r
+// Handle for the SMM CPU I/O Protocol\r
+//\r
+EFI_HANDLE mHandle = NULL;\r
+\r
+//\r
+// SMM CPU I/O Protocol instance\r
+//\r
+EFI_SMM_CPU_IO2_PROTOCOL mSmmCpuIo2 = {\r
+ {\r
+ CpuMemoryServiceRead,\r
+ CpuMemoryServiceWrite\r
+ },\r
+ {\r
+ CpuIoServiceRead,\r
+ CpuIoServiceWrite\r
+ }\r
+};\r
+\r
+//\r
+// Lookup table for increment values based on transfer widths\r
+//\r
+UINT8 mStride[] = {\r
+ 1, // SMM_IO_UINT8\r
+ 2, // SMM_IO_UINT16\r
+ 4, // SMM_IO_UINT32\r
+ 8 // SMM_IO_UINT64\r
+};\r
+\r
+/**\r
+ Check parameters to a SMM CPU I/O Protocol service request.\r
+\r
+ @param Width Signifies the width of the I/O or Memory operation.\r
+ @param Address The base address of the I/O or Memory operation.\r
+ @param Count The number of I/O or Memory operations to perform.\r
+ The number of bytes moved is Width size * Count, starting at Address.\r
+ @param Buffer For read operations, the destination buffer to store the results.\r
+ For write operations, the source buffer from which to write data.\r
+ @param MmioOperation TRUE for an MMIO operation, FALSE for I/O Port operation.\r
+ \r
+ @retval EFI_SUCCESS The parameters for this request pass the checks.\r
+ @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is not valid.\r
+ @retval EFI_UNSUPPORTED The address range specified by Address, Width, and Count exceeds Limit.\r
+ The Buffer is not aligned for the given Width.\r
+\r
+**/\r
+EFI_STATUS\r
+CpuIoCheckParameter (\r
+ IN BOOLEAN MmioOperation,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ UINT64 MaxCount;\r
+ UINT64 Limit;\r
+\r
+ //\r
+ // Check to see if Buffer is NULL\r
+ //\r
+ if (Buffer == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Check to see if Width is in the valid range\r
+ //\r
+ if (Width > SMM_IO_UINT64) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Check to see if Width is in the valid range for I/O Port operations\r
+ //\r
+ if (!MmioOperation && (Width == SMM_IO_UINT64)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ \r
+ //\r
+ // Check to see if any address associated with this transfer exceeds the maximum \r
+ // allowed address. The maximum address implied by the parameters passed in is\r
+ // Address + Size * Count. If the following condition is met, then the transfer\r
+ // is not supported.\r
+ //\r
+ // Address + Size * Count > (MmioOperation ? MAX_ADDRESS : MAX_IO_PORT_ADDRESS) + 1\r
+ //\r
+ // Since MAX_ADDRESS can be the maximum integer value supported by the CPU and Count \r
+ // can also be the maximum integer value supported by the CPU, this range\r
+ // check must be adjusted to avoid all oveflow conditions.\r
+ // \r
+ // The follwing form of the range check is equivalent but assumes that \r
+ // MAX_ADDRESS and MAX_IO_PORT_ADDRESS are of the form (2^n - 1).\r
+ //\r
+ Limit = (MmioOperation ? MAX_ADDRESS : MAX_IO_PORT_ADDRESS);\r
+ if (Count == 0) {\r
+ if (Address > Limit) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ } else { \r
+ MaxCount = RShiftU64 (Limit, Width);\r
+ if (MaxCount < (Count - 1)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ if (Address > LShiftU64 (MaxCount - Count + 1, Width)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ }\r
+ \r
+ //\r
+ // Check to see if Address is aligned\r
+ //\r
+ if ((Address & (UINT64)(mStride[Width] - 1)) != 0) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Reads memory-mapped registers.\r
+\r
+ @param This A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.\r
+ @param Width Signifies the width of the I/O or Memory operation.\r
+ @param Address The base address of the I/O or Memoryoperation.\r
+ @param Count The number of I/O or Memory operations to perform.\r
+ The number of bytes moved is Width size * Count, starting at Address.\r
+ @param Buffer For read operations, the destination buffer to store the results.\r
+ For write operations, 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
+CpuMemoryServiceRead (\r
+ IN CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT8 Stride;\r
+ UINT8 *Uint8Buffer;\r
+\r
+ Status = CpuIoCheckParameter (TRUE, Width, Address, Count, Buffer);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Select loop based on the width of the transfer\r
+ //\r
+ Stride = mStride[Width];\r
+ for (Uint8Buffer = Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {\r
+ if (Width == SMM_IO_UINT8) {\r
+ *Uint8Buffer = MmioRead8 ((UINTN)Address);\r
+ } else if (Width == SMM_IO_UINT16) {\r
+ *((UINT16 *)Uint8Buffer) = MmioRead16 ((UINTN)Address);\r
+ } else if (Width == SMM_IO_UINT32) {\r
+ *((UINT32 *)Uint8Buffer) = MmioRead32 ((UINTN)Address);\r
+ } else if (Width == SMM_IO_UINT64) {\r
+ *((UINT64 *)Uint8Buffer) = MmioRead64 ((UINTN)Address);\r
+ }\r
+ }\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Writes memory-mapped registers.\r
+\r
+ @param This A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.\r
+ @param Width Signifies the width of the I/O or Memory operation.\r
+ @param Address The base address of the I/O or Memoryoperation.\r
+ @param Count The number of I/O or Memory operations to perform.\r
+ The number of bytes moved is Width size * Count, starting at Address.\r
+ @param Buffer For read operations, the destination buffer to store the results.\r
+ For write operations, 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 CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT8 Stride;\r
+ UINT8 *Uint8Buffer;\r
+\r
+ Status = CpuIoCheckParameter (TRUE, Width, Address, Count, Buffer);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Select loop based on the width of the transfer\r
+ //\r
+ Stride = mStride[Width];\r
+ for (Uint8Buffer = Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {\r
+ if (Width == SMM_IO_UINT8) {\r
+ MmioWrite8 ((UINTN)Address, *Uint8Buffer);\r
+ } else if (Width == SMM_IO_UINT16) {\r
+ MmioWrite16 ((UINTN)Address, *((UINT16 *)Uint8Buffer));\r
+ } else if (Width == SMM_IO_UINT32) {\r
+ MmioWrite32 ((UINTN)Address, *((UINT32 *)Uint8Buffer));\r
+ } else if (Width == SMM_IO_UINT64) {\r
+ MmioWrite64 ((UINTN)Address, *((UINT64 *)Uint8Buffer));\r
+ }\r
+ }\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Reads I/O registers.\r
+\r
+ @param This A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.\r
+ @param Width Signifies the width of the I/O or Memory operation.\r
+ @param Address The base address of the I/O or Memoryoperation.\r
+ @param Count The number of I/O or Memory operations to perform.\r
+ The number of bytes moved is Width size * Count, starting at Address.\r
+ @param Buffer For read operations, the destination buffer to store the results.\r
+ For write operations, 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
+CpuIoServiceRead (\r
+ IN CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT8 Stride;\r
+ UINT8 *Uint8Buffer;\r
+\r
+ Status = CpuIoCheckParameter (FALSE, Width, Address, Count, Buffer);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Select loop based on the width of the transfer\r
+ //\r
+ Stride = mStride[Width];\r
+ for (Uint8Buffer = Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {\r
+ if (Width == SMM_IO_UINT8) {\r
+ *Uint8Buffer = IoRead8 ((UINTN)Address);\r
+ } else if (Width == SMM_IO_UINT16) {\r
+ *((UINT16 *)Uint8Buffer) = IoRead16 ((UINTN)Address);\r
+ } else if (Width == SMM_IO_UINT32) {\r
+ *((UINT32 *)Uint8Buffer) = IoRead32 ((UINTN)Address);\r
+ }\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Write I/O registers.\r
+\r
+ @param This A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.\r
+ @param Width Signifies the width of the I/O or Memory operation.\r
+ @param Address The base address of the I/O or Memoryoperation.\r
+ @param Count The number of I/O or Memory operations to perform.\r
+ The number of bytes moved is Width size * Count, starting at Address.\r
+ @param Buffer For read operations, the destination buffer to store the results.\r
+ For write operations, 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 CONST EFI_SMM_CPU_IO2_PROTOCOL *This,\r
+ IN EFI_SMM_IO_WIDTH Width,\r
+ IN UINT64 Address,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT8 Stride;\r
+ UINT8 *Uint8Buffer;\r
+\r
+ //\r
+ // Make sure the parameters are valid\r
+ //\r
+ Status = CpuIoCheckParameter (FALSE, Width, Address, Count, Buffer);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Select loop based on the width of the transfer\r
+ //\r
+ Stride = mStride[Width];\r
+ for (Uint8Buffer = (UINT8 *)Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {\r
+ if (Width == SMM_IO_UINT8) {\r
+ IoWrite8 ((UINTN)Address, *Uint8Buffer);\r
+ } else if (Width == SMM_IO_UINT16) {\r
+ IoWrite16 ((UINTN)Address, *((UINT16 *)Uint8Buffer));\r
+ } else if (Width == SMM_IO_UINT32) {\r
+ IoWrite32 ((UINTN)Address, *((UINT32 *)Uint8Buffer));\r
+ }\r
+ }\r
+ \r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ The module Entry Point SmmCpuIoProtocol driver\r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
+\r
+ @retval EFI_SUCCESS The entry point is executed successfully.\r
+ @retval Other Some error occurs when executing this entry point.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SmmCpuIo2Initialize (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+ {\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Copy the SMM CPU I/O Protocol instance into the System Management System Table\r
+ //\r
+ CopyMem (&gSmst->SmmIo, &mSmmCpuIo2, sizeof (mSmmCpuIo2));\r
+\r
+ //\r
+ // Install the SMM CPU I/O Protocol into the SMM protocol database\r
+ //\r
+ Status = gSmst->SmmInstallProtocolInterface (\r
+ &mHandle,\r
+ &gEfiSmmCpuIo2ProtocolGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ &mSmmCpuIo2\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ return Status;\r
+}\r
projects / mirror_edk2.git / blobdiff