OvmfPkg: Add platform specific reset vector code for X64

KVM has a bug that prevents using page tables in the ROM if the ROM
region utilizes the KVM READONLY memory feature. Therefore, we
avoid using page tables stored in the ROM.

Since OVMF doesn't require memory initialization, we just build
page table entries in RAM at 0x80000 very early in the OVMF boot
process. This address is just after the 'temp RAM' which is set
up by the SEC module.

Currently we only set up 4GB of page tables for OVMF's PEI,
but DxeIpl will build identity mapped page tables that cover all
of the available processor physical address space.

Reported-by: Gary Ching-Pang Lin <glin@suse.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Tested-by: Laszlo Ersek <lersek@redhat.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14715 6f19259b-4bc3-4df7-8a09-765794883524

6 files changed, 259 insertions, 0 deletions

diff --git a/OvmfPkg/ResetVector/Bin/ResetVector.inf b/OvmfPkg/ResetVector/Bin/ResetVector.inf
new file mode 100644
index 0000000000..afc80e3cd5
--- /dev/null
+++ b/OvmfPkg/ResetVector/Bin/ResetVector.inf
@@ -0,0 +1,29 @@
+## @file

+#  Reset Vector binary

+#

+#  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>

+#

+#  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.

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = ResetVector

+  FILE_GUID                      = 1BA0062E-C779-4582-8566-336AE8F78F09

+  MODULE_TYPE                    = SEC

+  VERSION_STRING                 = 1.1

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64

+#

+

+[Binaries.X64]

+  RAW|ResetVector.x64.raw|*

diff --git a/OvmfPkg/ResetVector/Bin/ResetVector.x64.raw b/OvmfPkg/ResetVector/Bin/ResetVector.x64.raw
new file mode 100644
index 0000000000..ff08363600
--- /dev/null
+++ b/OvmfPkg/ResetVector/Bin/ResetVector.x64.raw
diff --git a/OvmfPkg/ResetVector/Build.py b/OvmfPkg/ResetVector/Build.py
new file mode 100644
index 0000000000..e0a9496e37
--- /dev/null
+++ b/OvmfPkg/ResetVector/Build.py
@@ -0,0 +1,58 @@
+## @file
+#  Automate the process of building the various reset vector types
+#
+#  Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
+#
+#  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.
+#
+
+import glob
+import os
+import subprocess
+import sys
+
+def RunCommand(commandLine):
+    #print ' '.join(commandLine)
+    return subprocess.call(commandLine)
+
+for filename in glob.glob(os.path.join('Bin', '*.raw')):
+    os.remove(filename)
+
+ThisDir = os.path.realpath(os.path.split(sys.argv[0])[0])
+WorkspaceDir = os.path.realpath(os.path.join(ThisDir, '..', '..'))
+UefiCpuPkgVtf0Dir = os.path.join(WorkspaceDir, 'UefiCpuPkg', 'ResetVector', 'Vtf0')
+
+for arch in ('x64',):
+    for debugType in (None,):
+        output = os.path.join('Bin', 'ResetVector')
+        output += '.' + arch
+        if debugType is not None:
+            output += '.' + debugType
+        output += '.raw'
+        commandLine = (
+            'nasm',
+            '-D', 'ARCH_%s' % arch.upper(),
+            '-D', 'DEBUG_%s' % str(debugType).upper(),
+            '-I', UefiCpuPkgVtf0Dir + os.path.sep,
+            '-o', output,
+            'ResetVectorCode.asm',
+            )
+        ret = RunCommand(commandLine)
+        print '\tASM\t' + output
+        if ret != 0: sys.exit(ret)
+
+        commandLine = (
+            'python',
+            'Tools/FixupForRawSection.py',
+            output,
+            )
+        print '\tFIXUP\t' + output
+        ret = RunCommand(commandLine)
+        if ret != 0: sys.exit(ret)
+
diff --git a/OvmfPkg/ResetVector/Ia32/PageTables64.asm b/OvmfPkg/ResetVector/Ia32/PageTables64.asm
new file mode 100644
index 0000000000..5ebf211fbc
--- /dev/null
+++ b/OvmfPkg/ResetVector/Ia32/PageTables64.asm
@@ -0,0 +1,93 @@
+;------------------------------------------------------------------------------

+; @file

+; Sets the CR3 register for 64-bit paging

+;

+; Copyright (c) 2008 - 2013, Intel Corporation. All rights reserved.<BR>

+; 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.

+;

+;------------------------------------------------------------------------------

+

+BITS    32

+

+%define PAGE_PRESENT            0x01

+%define PAGE_READ_WRITE         0x02

+%define PAGE_USER_SUPERVISOR    0x04

+%define PAGE_WRITE_THROUGH      0x08

+%define PAGE_CACHE_DISABLE     0x010

+%define PAGE_ACCESSED          0x020

+%define PAGE_DIRTY             0x040

+%define PAGE_PAT               0x080

+%define PAGE_GLOBAL           0x0100

+%define PAGE_2M_MBO            0x080

+%define PAGE_2M_PAT          0x01000

+

+%define PAGE_2M_PDE_ATTR (PAGE_2M_MBO + \

+                          PAGE_CACHE_DISABLE + \

+                          PAGE_ACCESSED + \

+                          PAGE_DIRTY + \

+                          PAGE_READ_WRITE + \

+                          PAGE_PRESENT)

+

+%define PAGE_PDP_ATTR (PAGE_CACHE_DISABLE + \

+                       PAGE_ACCESSED + \

+                       PAGE_READ_WRITE + \

+                       PAGE_PRESENT)

+

+

+;

+; Modified:  EAX, ECX

+;

+SetCr3ForPageTables64:

+

+    ;

+    ; For OVMF, build some initial page tables at 0x80000. This is just

+    ; after the early stack/temp RAM.

+    ;

+    ; At the end of PEI, the pages tables will be rebuilt into a

+    ; more permanent location by DxeIpl.

+    ;

+

+    mov     ecx, 6 * 0x1000 / 4

+    xor     eax, eax

+clearPageTablesMemoryLoop:

+    mov     dword[ecx * 4 + 0x80000 - 4], eax

+    loop    clearPageTablesMemoryLoop

+

+    ;

+    ; Top level Page Directory Pointers (1 * 512GB entry)

+    ;

+    mov     dword[0x80000], 0x81000 + PAGE_PDP_ATTR

+

+    ;

+    ; Next level Page Directory Pointers (4 * 1GB entries => 4GB)

+    ;

+    mov     dword[0x81000], 0x82000 + PAGE_PDP_ATTR

+    mov     dword[0x81008], 0x83000 + PAGE_PDP_ATTR

+    mov     dword[0x81010], 0x84000 + PAGE_PDP_ATTR

+    mov     dword[0x81018], 0x85000 + PAGE_PDP_ATTR

+

+    ;

+    ; Page Table Entries (2048 * 2MB entries => 4GB)

+    ;

+    mov     ecx, 0x800

+pageTableEntriesLoop:

+    mov     eax, ecx

+    dec     eax

+    shl     eax, 21

+    add     eax, PAGE_2M_PDE_ATTR

+    mov     [ecx * 8 + 0x82000 - 8], eax

+    loop    pageTableEntriesLoop

+

+    ;

+    ; Set CR3 now that the paging structures are available

+    ;

+    mov     eax, 0x80000

+    mov     cr3, eax

+

+    OneTimeCallRet SetCr3ForPageTables64

diff --git a/OvmfPkg/ResetVector/ResetVectorCode.asm b/OvmfPkg/ResetVector/ResetVectorCode.asm
new file mode 100644
index 0000000000..052c821f21
--- /dev/null
+++ b/OvmfPkg/ResetVector/ResetVectorCode.asm
@@ -0,0 +1,53 @@
+;------------------------------------------------------------------------------

+; @file

+; This file includes all other code files to assemble the reset vector code

+;

+; Copyright (c) 2008 - 2013, Intel Corporation. All rights reserved.<BR>

+; 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.

+;

+;------------------------------------------------------------------------------

+

+%ifdef ARCH_IA32

+  %ifdef ARCH_X64

+    %error "Only one of ARCH_IA32 or ARCH_X64 can be defined."

+  %endif

+%elifdef ARCH_X64

+%else

+  %error "Either ARCH_IA32 or ARCH_X64 must be defined."

+%endif

+

+%include "CommonMacros.inc"

+

+%include "PostCodes.inc"

+

+%ifdef DEBUG_NONE

+  %include "DebugDisabled.asm"

+%elifdef DEBUG_PORT80

+  %include "Port80Debug.asm"

+%elifdef DEBUG_SERIAL

+  %include "SerialDebug.asm"

+%else

+  %error "No debug type was specified."

+%endif

+

+%include "Ia32/SearchForBfvBase.asm"

+%include "Ia32/SearchForSecEntry.asm"

+

+%ifdef ARCH_X64

+%include "Ia32/Flat32ToFlat64.asm"

+%include "Ia32/PageTables64.asm"

+%endif

+

+%include "Ia16/Real16ToFlat32.asm"

+%include "Ia16/Init16.asm"

+

+%include "Main.asm"

+

+%include "Ia16/ResetVectorVtf0.asm"

+

diff --git a/OvmfPkg/ResetVector/Tools/FixupForRawSection.py b/OvmfPkg/ResetVector/Tools/FixupForRawSection.py
new file mode 100644
index 0000000000..f88c8a4cd7
--- /dev/null
+++ b/OvmfPkg/ResetVector/Tools/FixupForRawSection.py
@@ -0,0 +1,26 @@
+## @file
+#  Apply fixup to VTF binary image for FFS Raw section
+#
+#  Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>
+#
+#  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.
+#
+
+import sys
+
+filename = sys.argv[1]
+
+d = open(sys.argv[1], 'rb').read()
+c = ((len(d) + 4 + 7) & ~7) - 4
+if c > len(d):
+    c -= len(d)
+    f = open(sys.argv[1], 'wb')
+    f.write('\x90' * c)
+    f.write(d)
+    f.close()