]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c
OvmfPkg: Modify QemuFwCfgLib to use new IoLib class library
[mirror_edk2.git] / OvmfPkg / Library / QemuFwCfgLib / QemuFwCfgLib.c
index 8caab42e8b0a9c27c574aed09dbf63cafd07ad6b..a228c029dfb909edadb3247017264c182ea6f0e7 100644 (file)
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-  Copyright (c) 2011 - 2012, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (C) 2013, Red Hat, Inc.\r
+  Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 \r
-STATIC BOOLEAN mQemuFwCfgSupported = FALSE;\r
-\r
-\r
-/**\r
-  Reads an 8-bit I/O port fifo into a block of memory.\r
-\r
-  Reads the 8-bit I/O fifo port specified by Port.\r
-\r
-  The port is read Count times, and the read data is\r
-  stored in the provided Buffer.\r
-\r
-  This function must guarantee that all I/O read and write operations are\r
-  serialized.\r
-\r
-  If 8-bit I/O port operations are not supported, then ASSERT().\r
-\r
-  @param  Port    The I/O port to read.\r
-  @param  Count   The number of times to read I/O port.\r
-  @param  Buffer  The buffer to store the read data into.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-IoReadFifo8 (\r
-  IN      UINTN                     Port,\r
-  IN      UINTN                     Count,\r
-  OUT     VOID                      *Buffer\r
-  );\r
-\r
-\r
-/**\r
-  Returns a boolean indicating if the firmware configuration interface\r
-  is available or not.\r
-\r
-  @retval    TRUE   The interface is available\r
-  @retval    FALSE  The interface is not available\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-QemuFwCfgIsAvailable (\r
-  VOID\r
-  )\r
-{\r
-  return mQemuFwCfgSupported;\r
-}\r
+#include "QemuFwCfgLibInternal.h"\r
 \r
 \r
 /**\r
@@ -89,6 +46,70 @@ QemuFwCfgSelectItem (
 }\r
 \r
 \r
+/**\r
+  Transfer an array of bytes using the DMA interface.\r
+\r
+  @param[in]     Size    Size in bytes to transfer.\r
+  @param[in,out] Buffer  Buffer to read data into or write data from. May be\r
+                         NULL if Size is zero.\r
+  @param[in]     Write   TRUE if writing to fw_cfg from Buffer, FALSE if\r
+                         reading from fw_cfg into Buffer.\r
+**/\r
+VOID\r
+InternalQemuFwCfgDmaBytes (\r
+  IN     UINT32   Size,\r
+  IN OUT VOID     *Buffer OPTIONAL,\r
+  IN     BOOLEAN  Write\r
+  )\r
+{\r
+  volatile FW_CFG_DMA_ACCESS Access;\r
+  UINT32                     AccessHigh, AccessLow;\r
+  UINT32                     Status;\r
+\r
+  if (Size == 0) {\r
+    return;\r
+  }\r
+\r
+  Access.Control = SwapBytes32 (\r
+                    Write ? FW_CFG_DMA_CTL_WRITE : FW_CFG_DMA_CTL_READ\r
+                    );\r
+  Access.Length  = SwapBytes32 (Size);\r
+  Access.Address = SwapBytes64 ((UINTN)Buffer);\r
+\r
+  //\r
+  // Delimit the transfer from (a) modifications to Access, (b) in case of a\r
+  // write, from writes to Buffer by the caller.\r
+  //\r
+  MemoryFence ();\r
+\r
+  //\r
+  // Start the transfer.\r
+  //\r
+  AccessHigh = (UINT32)RShiftU64 ((UINTN)&Access, 32);\r
+  AccessLow  = (UINT32)(UINTN)&Access;\r
+  IoWrite32 (0x514, SwapBytes32 (AccessHigh));\r
+  IoWrite32 (0x518, SwapBytes32 (AccessLow));\r
+\r
+  //\r
+  // Don't look at Access.Control before starting the transfer.\r
+  //\r
+  MemoryFence ();\r
+\r
+  //\r
+  // Wait for the transfer to complete.\r
+  //\r
+  do {\r
+    Status = SwapBytes32 (Access.Control);\r
+    ASSERT ((Status & FW_CFG_DMA_CTL_ERROR) == 0);\r
+  } while (Status != 0);\r
+\r
+  //\r
+  // After a read, the caller will want to use Buffer.\r
+  //\r
+  MemoryFence ();\r
+}\r
+\r
+\r
 /**\r
   Reads firmware configuration bytes into a buffer\r
 \r
@@ -103,6 +124,10 @@ InternalQemuFwCfgReadBytes (
   IN VOID                   *Buffer  OPTIONAL\r
   )\r
 {\r
+  if (InternalQemuFwCfgDmaIsAvailable () && Size <= MAX_UINT32) {\r
+    InternalQemuFwCfgDmaBytes ((UINT32)Size, Buffer, FALSE);\r
+    return;\r
+  }\r
   IoReadFifo8 (0x511, Size, Buffer);\r
 }\r
 \r
@@ -125,13 +150,40 @@ QemuFwCfgReadBytes (
   IN VOID                   *Buffer\r
   )\r
 {\r
-  if (mQemuFwCfgSupported) {\r
+  if (InternalQemuFwCfgIsAvailable ()) {\r
     InternalQemuFwCfgReadBytes (Size, Buffer);\r
   } else {\r
     ZeroMem (Buffer, Size);\r
   }\r
 }\r
 \r
+/**\r
+  Write firmware configuration bytes from a buffer\r
+\r
+  If called multiple times, then the data written will\r
+  continue at the offset of the firmware configuration\r
+  item where the previous write ended.\r
+\r
+  @param[in] Size - Size in bytes to write\r
+  @param[in] Buffer - Buffer to read data from\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+QemuFwCfgWriteBytes (\r
+  IN UINTN                  Size,\r
+  IN VOID                   *Buffer\r
+  )\r
+{\r
+  if (InternalQemuFwCfgIsAvailable ()) {\r
+    if (InternalQemuFwCfgDmaIsAvailable () && Size <= MAX_UINT32) {\r
+      InternalQemuFwCfgDmaBytes ((UINT32)Size, Buffer, TRUE);\r
+      return;\r
+    }\r
+    IoWriteFifo8 (0x511, Size, Buffer);\r
+  }\r
+}\r
+\r
 \r
 /**\r
   Reads a UINT8 firmware configuration value\r
@@ -213,39 +265,6 @@ QemuFwCfgRead64 (
 }\r
 \r
 \r
-RETURN_STATUS\r
-EFIAPI\r
-QemuFwCfgInitialize (\r
-  VOID\r
-  )\r
-{\r
-  UINT32 Signature;\r
-  UINT32 Revision;\r
-\r
-  //\r
-  // Enable the access routines while probing to see if it is supported.\r
-  //\r
-  mQemuFwCfgSupported = TRUE;\r
-\r
-  QemuFwCfgSelectItem (QemuFwCfgItemSignature);\r
-  Signature = QemuFwCfgRead32 ();\r
-  DEBUG ((EFI_D_INFO, "FW CFG Signature: 0x%x\n", Signature));\r
-  QemuFwCfgSelectItem (QemuFwCfgItemInterfaceVersion);\r
-  Revision = QemuFwCfgRead32 ();\r
-  DEBUG ((EFI_D_INFO, "FW CFG Revision: 0x%x\n", Revision));\r
-  if ((Signature != SIGNATURE_32 ('Q', 'E', 'M', 'U')) ||\r
-      (Revision < 1)\r
-     ) {\r
-    DEBUG ((EFI_D_INFO, "QemuFwCfg interface not supported.\n"));\r
-    mQemuFwCfgSupported = FALSE;\r
-    return RETURN_SUCCESS;\r
-  }\r
-\r
-  DEBUG ((EFI_D_INFO, "QemuFwCfg interface is supported.\n"));\r
-  return RETURN_SUCCESS;\r
-}\r
-\r
-\r
 /**\r
   Find the configuration item corresponding to the firmware configuration file.\r
 \r
@@ -270,7 +289,7 @@ QemuFwCfgFindFile (
   UINT32 Count;\r
   UINT32 Idx;\r
 \r
-  if (!mQemuFwCfgSupported) {\r
+  if (!InternalQemuFwCfgIsAvailable ()) {\r
     return RETURN_UNSUPPORTED;\r
   }\r
 \r
@@ -281,11 +300,12 @@ QemuFwCfgFindFile (
     UINT32 FileSize;\r
     UINT16 FileSelect;\r
     UINT16 FileReserved;\r
-    CHAR8  FName[56];\r
+    CHAR8  FName[QEMU_FW_CFG_FNAME_SIZE];\r
 \r
     FileSize     = QemuFwCfgRead32 ();\r
     FileSelect   = QemuFwCfgRead16 ();\r
     FileReserved = QemuFwCfgRead16 ();\r
+    (VOID) FileReserved; /* Force a do-nothing reference. */\r
     InternalQemuFwCfgReadBytes (sizeof (FName), FName);\r
 \r
     if (AsciiStrCmp (Name, FName) == 0) {\r
@@ -297,3 +317,31 @@ QemuFwCfgFindFile (
 \r
   return RETURN_NOT_FOUND;\r
 }\r
+\r
+\r
+/**\r
+  Determine if S3 support is explicitly enabled.\r
+\r
+  @retval  TRUE   if S3 support is explicitly enabled.\r
+           FALSE  otherwise. This includes unavailability of the firmware\r
+                  configuration interface.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+QemuFwCfgS3Enabled (\r
+  VOID\r
+  )\r
+{\r
+  RETURN_STATUS        Status;\r
+  FIRMWARE_CONFIG_ITEM FwCfgItem;\r
+  UINTN                FwCfgSize;\r
+  UINT8                SystemStates[6];\r
+\r
+  Status = QemuFwCfgFindFile ("etc/system-states", &FwCfgItem, &FwCfgSize);\r
+  if (Status != RETURN_SUCCESS || FwCfgSize != sizeof SystemStates) {\r
+    return FALSE;\r
+  }\r
+  QemuFwCfgSelectItem (FwCfgItem);\r
+  QemuFwCfgReadBytes (sizeof SystemStates, SystemStates);\r
+  return (BOOLEAN) (SystemStates[3] & BIT7);\r
+}\r