]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/Library/BaseMemEncryptSevLib/X64/VirtualMemory.c
OvmfPkg/MemEncryptSevLib: clean up InternalMemEncryptSevSetMemoryEncrypted() decl
[mirror_edk2.git] / OvmfPkg / Library / BaseMemEncryptSevLib / X64 / VirtualMemory.c
index 4185874c99b8b614e67061665917433b959d0dc6..39b246048f1f2f37b745d6a60e1b82ca4c643d79 100644 (file)
@@ -2,18 +2,18 @@
 \r
   Virtual Memory Management Services to set or clear the memory encryption bit\r
 \r
-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
-Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\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
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+  This program and the accompanying materials are licensed and made available\r
+  under the terms and conditions of the BSD License which accompanies this\r
+  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
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
+  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Code is derived from MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c\r
+  Code is derived from MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c\r
 \r
 **/\r
 \r
@@ -69,11 +69,12 @@ GetMemEncryptionAddressMask (
   To reduce the potential split operation on page table, the pages reserved for\r
   page table should be allocated in the times of PAGE_TABLE_POOL_UNIT_PAGES and\r
   at the boundary of PAGE_TABLE_POOL_ALIGNMENT. So the page pool is always\r
-  initialized with number of pages greater than or equal to the given PoolPages.\r
+  initialized with number of pages greater than or equal to the given\r
+  PoolPages.\r
 \r
   Once the pages in the pool are used up, this method should be called again to\r
-  reserve at least another PAGE_TABLE_POOL_UNIT_PAGES. Usually this won't happen\r
-  often in practice.\r
+  reserve at least another PAGE_TABLE_POOL_UNIT_PAGES. Usually this won't\r
+  happen often in practice.\r
 \r
   @param[in] PoolPages      The least page number of the pool to be created.\r
 \r
@@ -183,7 +184,8 @@ AllocatePageTableMemory (
 /**\r
   Split 2M page to 4K.\r
 \r
-  @param[in]      PhysicalAddress       Start physical address the 2M page covered.\r
+  @param[in]      PhysicalAddress       Start physical address the 2M page\r
+                                        covered.\r
   @param[in, out] PageEntry2M           Pointer to 2M page entry.\r
   @param[in]      StackBase             Stack base address.\r
   @param[in]      StackSize             Stack size.\r
@@ -213,14 +215,19 @@ Split2MPageTo4K (
   ASSERT (*PageEntry2M & AddressEncMask);\r
 \r
   PhysicalAddress4K = PhysicalAddress;\r
-  for (IndexOfPageTableEntries = 0; IndexOfPageTableEntries < 512; IndexOfPageTableEntries++, PageTableEntry++, PhysicalAddress4K += SIZE_4KB) {\r
+  for (IndexOfPageTableEntries = 0;\r
+       IndexOfPageTableEntries < 512;\r
+       (IndexOfPageTableEntries++,\r
+        PageTableEntry++,\r
+        PhysicalAddress4K += SIZE_4KB)) {\r
     //\r
     // Fill in the Page Table entries\r
     //\r
     PageTableEntry->Uint64 = (UINT64) PhysicalAddress4K | AddressEncMask;\r
     PageTableEntry->Bits.ReadWrite = 1;\r
     PageTableEntry->Bits.Present = 1;\r
-    if ((PhysicalAddress4K >= StackBase) && (PhysicalAddress4K < StackBase + StackSize)) {\r
+    if ((PhysicalAddress4K >= StackBase) &&\r
+        (PhysicalAddress4K < StackBase + StackSize)) {\r
       //\r
       // Set Nx bit for stack.\r
       //\r
@@ -231,7 +238,8 @@ Split2MPageTo4K (
   //\r
   // Fill in 2M page entry.\r
   //\r
-  *PageEntry2M = (UINT64) (UINTN) PageTableEntry1 | IA32_PG_P | IA32_PG_RW | AddressEncMask;\r
+  *PageEntry2M = ((UINT64)(UINTN)PageTableEntry1 |\r
+                  IA32_PG_P | IA32_PG_RW | AddressEncMask);\r
 }\r
 \r
 /**\r
@@ -391,9 +399,9 @@ EnablePageTableProtection (
     PoolSize = Pool->Offset + EFI_PAGES_TO_SIZE (Pool->FreePages);\r
 \r
     //\r
-    // The size of one pool must be multiple of PAGE_TABLE_POOL_UNIT_SIZE, which\r
-    // is one of page size of the processor (2MB by default). Let's apply the\r
-    // protection to them one by one.\r
+    // The size of one pool must be multiple of PAGE_TABLE_POOL_UNIT_SIZE,\r
+    // which is one of page size of the processor (2MB by default). Let's apply\r
+    // the protection to them one by one.\r
     //\r
     while (PoolSize > 0) {\r
       SetPageTablePoolReadOnly(PageTableBase, Address, Level4Paging);\r
@@ -410,7 +418,8 @@ EnablePageTableProtection (
 /**\r
   Split 1G page to 2M.\r
 \r
-  @param[in]      PhysicalAddress       Start physical address the 1G page covered.\r
+  @param[in]      PhysicalAddress       Start physical address the 1G page\r
+                                        covered.\r
   @param[in, out] PageEntry1G           Pointer to 1G page entry.\r
   @param[in]      StackBase             Stack base address.\r
   @param[in]      StackSize             Stack size.\r
@@ -438,15 +447,26 @@ Split1GPageTo2M (
   //\r
   // Fill in 1G page entry.\r
   //\r
-  *PageEntry1G = (UINT64) (UINTN) PageDirectoryEntry | IA32_PG_P | IA32_PG_RW | AddressEncMask;\r
+  *PageEntry1G = ((UINT64)(UINTN)PageDirectoryEntry |\r
+                  IA32_PG_P | IA32_PG_RW | AddressEncMask);\r
 \r
   PhysicalAddress2M = PhysicalAddress;\r
-  for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PhysicalAddress2M += SIZE_2MB) {\r
-    if ((PhysicalAddress2M < StackBase + StackSize) && ((PhysicalAddress2M + SIZE_2MB) > StackBase)) {\r
+  for (IndexOfPageDirectoryEntries = 0;\r
+       IndexOfPageDirectoryEntries < 512;\r
+       (IndexOfPageDirectoryEntries++,\r
+        PageDirectoryEntry++,\r
+        PhysicalAddress2M += SIZE_2MB)) {\r
+    if ((PhysicalAddress2M < StackBase + StackSize) &&\r
+        ((PhysicalAddress2M + SIZE_2MB) > StackBase)) {\r
       //\r
       // Need to split this 2M page that covers stack range.\r
       //\r
-      Split2MPageTo4K (PhysicalAddress2M, (UINT64 *) PageDirectoryEntry, StackBase, StackSize);\r
+      Split2MPageTo4K (\r
+        PhysicalAddress2M,\r
+        (UINT64 *)PageDirectoryEntry,\r
+        StackBase,\r
+        StackSize\r
+        );\r
     } else {\r
       //\r
       // Fill in the Page Directory entries\r
@@ -527,28 +547,31 @@ EnableReadOnlyPageWriteProtect (
 \r
 \r
 /**\r
-  This function either sets or clears memory encryption bit for the memory region\r
-  specified by PhysicalAddress and length from the current page table context.\r
+  This function either sets or clears memory encryption bit for the memory\r
+  region specified by PhysicalAddress and Length from the current page table\r
+  context.\r
 \r
-  The function iterates through the physicalAddress one page at a time, and set\r
+  The function iterates through the PhysicalAddress one page at a time, and set\r
   or clears the memory encryption mask in the page table. If it encounters\r
   that a given physical address range is part of large page then it attempts to\r
   change the attribute at one go (based on size), otherwise it splits the\r
   large pages into smaller (e.g 2M page into 4K pages) and then try to set or\r
   clear the encryption bit on the smallest page size.\r
 \r
+  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
+                                      current CR3)\r
   @param[in]  PhysicalAddress         The physical address that is the start\r
                                       address of a memory region.\r
   @param[in]  Length                  The length of memory region\r
   @param[in]  Mode                    Set or Clear mode\r
-  @param[in]  Flush                   Flush the caches before applying the\r
+  @param[in]  CacheFlush              Flush the caches before applying the\r
                                       encryption mask\r
 \r
-  @retval RETURN_SUCCESS              The attributes were cleared for the memory\r
-                                      region.\r
+  @retval RETURN_SUCCESS              The attributes were cleared for the\r
+                                      memory region.\r
   @retval RETURN_INVALID_PARAMETER    Number of pages is zero.\r
-  @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute is\r
-                                      not supported\r
+  @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute\r
+                                      is not supported\r
 **/\r
 \r
 STATIC\r
@@ -601,8 +624,8 @@ SetMemoryEncDec (
 \r
   //\r
   // We are going to change the memory encryption attribute from C=0 -> C=1 or\r
-  // vice versa Flush the caches to ensure that data is written into memory with\r
-  // correct C-bit\r
+  // vice versa Flush the caches to ensure that data is written into memory\r
+  // with correct C-bit\r
   //\r
   if (CacheFlush) {\r
     WriteBackInvalidateDataCacheRange((VOID*) (UINTN)PhysicalAddress, Length);\r
@@ -641,7 +664,10 @@ SetMemoryEncDec (
       goto Done;\r
     }\r
 \r
-    PageDirectory1GEntry = (VOID*) ((PageMapLevel4Entry->Bits.PageTableBaseAddress<<12) & ~PgTableMask);\r
+    PageDirectory1GEntry = (VOID *)(\r
+                             (PageMapLevel4Entry->Bits.PageTableBaseAddress <<\r
+                              12) & ~PgTableMask\r
+                             );\r
     PageDirectory1GEntry += PDP_OFFSET(PhysicalAddress);\r
     if (!PageDirectory1GEntry->Bits.Present) {\r
       DEBUG ((\r
@@ -685,15 +711,25 @@ SetMemoryEncDec (
           __FUNCTION__,\r
           PhysicalAddress\r
           ));\r
-        Split1GPageTo2M(((UINT64)PageDirectory1GEntry->Bits.PageTableBaseAddress)<<30, (UINT64*) PageDirectory1GEntry, 0, 0);\r
+        Split1GPageTo2M (\r
+          (UINT64)PageDirectory1GEntry->Bits.PageTableBaseAddress << 30,\r
+          (UINT64 *)PageDirectory1GEntry,\r
+          0,\r
+          0\r
+          );\r
         continue;\r
       }\r
     } else {\r
       //\r
       // Actually a PDP\r
       //\r
-      PageUpperDirectoryPointerEntry = (PAGE_MAP_AND_DIRECTORY_POINTER*) PageDirectory1GEntry;\r
-      PageDirectory2MEntry = (VOID*) ((PageUpperDirectoryPointerEntry->Bits.PageTableBaseAddress<<12) & ~PgTableMask);\r
+      PageUpperDirectoryPointerEntry =\r
+        (PAGE_MAP_AND_DIRECTORY_POINTER *)PageDirectory1GEntry;\r
+      PageDirectory2MEntry =\r
+        (VOID *)(\r
+          (PageUpperDirectoryPointerEntry->Bits.PageTableBaseAddress <<\r
+           12) & ~PgTableMask\r
+          );\r
       PageDirectory2MEntry += PDE_OFFSET(PhysicalAddress);\r
       if (!PageDirectory2MEntry->Bits.Present) {\r
         DEBUG ((\r
@@ -729,12 +765,22 @@ SetMemoryEncDec (
             __FUNCTION__,\r
             PhysicalAddress\r
             ));\r
-          Split2MPageTo4K (((UINT64)PageDirectory2MEntry->Bits.PageTableBaseAddress) << 21, (UINT64*) PageDirectory2MEntry, 0, 0);\r
+          Split2MPageTo4K (\r
+            (UINT64)PageDirectory2MEntry->Bits.PageTableBaseAddress << 21,\r
+            (UINT64 *)PageDirectory2MEntry,\r
+            0,\r
+            0\r
+            );\r
           continue;\r
         }\r
       } else {\r
-        PageDirectoryPointerEntry = (PAGE_MAP_AND_DIRECTORY_POINTER*) PageDirectory2MEntry;\r
-        PageTableEntry = (VOID*) (PageDirectoryPointerEntry->Bits.PageTableBaseAddress<<12 & ~PgTableMask);\r
+        PageDirectoryPointerEntry =\r
+          (PAGE_MAP_AND_DIRECTORY_POINTER *)PageDirectory2MEntry;\r
+        PageTableEntry =\r
+          (VOID *)(\r
+            (PageDirectoryPointerEntry->Bits.PageTableBaseAddress <<\r
+             12) & ~PgTableMask\r
+            );\r
         PageTableEntry += PTE_OFFSET(PhysicalAddress);\r
         if (!PageTableEntry->Bits.Present) {\r
           DEBUG ((\r
@@ -780,19 +826,21 @@ Done:
 \r
 /**\r
   This function clears memory encryption bit for the memory region specified by\r
-  PhysicalAddress and length from the current page table context.\r
+  PhysicalAddress and Length from the current page table context.\r
 \r
+  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
+                                      current CR3)\r
   @param[in]  PhysicalAddress         The physical address that is the start\r
                                       address of a memory region.\r
   @param[in]  Length                  The length of memory region\r
   @param[in]  Flush                   Flush the caches before applying the\r
                                       encryption mask\r
 \r
-  @retval RETURN_SUCCESS              The attributes were cleared for the memory\r
-                                      region.\r
+  @retval RETURN_SUCCESS              The attributes were cleared for the\r
+                                      memory region.\r
   @retval RETURN_INVALID_PARAMETER    Number of pages is zero.\r
-  @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute is\r
-                                      not supported\r
+  @retval RETURN_UNSUPPORTED          Clearing the memory encyrption attribute\r
+                                      is not supported\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -804,24 +852,32 @@ InternalMemEncryptSevSetMemoryDecrypted (
   )\r
 {\r
 \r
-  return SetMemoryEncDec (Cr3BaseAddress, PhysicalAddress, Length, ClearCBit, Flush);\r
+  return SetMemoryEncDec (\r
+           Cr3BaseAddress,\r
+           PhysicalAddress,\r
+           Length,\r
+           ClearCBit,\r
+           Flush\r
+           );\r
 }\r
 \r
 /**\r
   This function sets memory encryption bit for the memory region specified by\r
-  PhysicalAddress and length from the current page table context.\r
+  PhysicalAddress and Length from the current page table context.\r
 \r
-  @param[in]  PhysicalAddress         The physical address that is the start address\r
-                                      of a memory region.\r
+  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
+                                      current CR3)\r
+  @param[in]  PhysicalAddress         The physical address that is the start\r
+                                      address of a memory region.\r
   @param[in]  Length                  The length of memory region\r
   @param[in]  Flush                   Flush the caches before applying the\r
                                       encryption mask\r
 \r
-  @retval RETURN_SUCCESS              The attributes were cleared for the memory\r
+  @retval RETURN_SUCCESS              The attributes were set for the memory\r
                                       region.\r
   @retval RETURN_INVALID_PARAMETER    Number of pages is zero.\r
-  @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute is\r
-                                      not supported\r
+  @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute\r
+                                      is not supported\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -832,5 +888,11 @@ InternalMemEncryptSevSetMemoryEncrypted (
   IN  BOOLEAN                 Flush\r
   )\r
 {\r
-  return SetMemoryEncDec (Cr3BaseAddress, PhysicalAddress, Length, SetCBit, Flush);\r
+  return SetMemoryEncDec (\r
+           Cr3BaseAddress,\r
+           PhysicalAddress,\r
+           Length,\r
+           SetCBit,\r
+           Flush\r
+           );\r
 }\r