ArmPkg: Add ArmHvcLib

This is a utility library closely modeled after ArmSmcLib, that allows
hypervisor call (HVC) instructions to be issued from C code.

Change-Id: I5f5c65f83e910ff98dbb2f5b031dad8c4f663daa
Contributed-under: TianoCore Contribution Agreement 1.0
Acked-by: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Olivier Martin <olivier.martin@arm.com>



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

ArmPkg/ArmPkg.dsc

@@ -36,7 +36,8 @@
   GCC:*_*_ARM_PLATFORM_FLAGS    == -march=armv7-a -mfpu=neon
   GCC:RELEASE_*_*_CC_FLAGS     = -DMDEPKG_NDEBUG
 
-  RVCT:*_*_ARM_PLATFORM_FLAGS  == --cpu Cortex-A8
+  # We use A15 to get the Secure and Virtualization extensions
+  RVCT:*_*_ARM_PLATFORM_FLAGS  == --cpu Cortex-A15
   RVCT:RELEASE_*_*_CC_FLAGS  = -DMDEPKG_NDEBUG
 
 [LibraryClasses.common]
@@ -130,6 +131,7 @@
 
   ArmPkg/Library/ArmSmcLib/ArmSmcLib.inf
   ArmPkg/Library/ArmSmcLibNull/ArmSmcLibNull.inf
+  ArmPkg/Library/ArmHvcLib/ArmHvcLib.inf
 
   ArmPkg/Filesystem/SemihostFs/SemihostFs.inf
 

ArmPkg/Include/Library/ArmHvcLib.h

@@ -0,0 +1,46 @@
+/** @file
+*
+*  Copyright (c) 2012-2014, ARM Limited. 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 __ARM_HVC_LIB__
+#define __ARM_HVC_LIB__
+
+/**
+ * The size of the HVC arguments are different between AArch64 and AArch32.
+ * The native size is used for the arguments.
+ */
+typedef struct {
+  UINTN  Arg0;
+  UINTN  Arg1;
+  UINTN  Arg2;
+  UINTN  Arg3;
+  UINTN  Arg4;
+  UINTN  Arg5;
+  UINTN  Arg6;
+  UINTN  Arg7;
+} ARM_HVC_ARGS;
+
+/**
+  Trigger an HVC call
+
+  HVC calls can take up to 8 arguments and return up to 4 return values.
+  Therefore, the 4 first fields in the ARM_HVC_ARGS structure are used
+  for both input and output values.
+
+**/
+VOID
+ArmCallHvc (
+  IN OUT ARM_HVC_ARGS *Args
+  );
+
+#endif

ArmPkg/Library/ArmHvcLib/AArch64/ArmHvc.S

@@ -0,0 +1,42 @@
+//
+//  Copyright (c) 2012-2014, ARM Limited. All rights reserved.
+//  Copyright (c) 2014, Linaro Limited. 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.
+//
+//
+
+.text
+.align 3
+
+GCC_ASM_EXPORT(ArmCallHvc)
+
+ASM_PFX(ArmCallHvc):
+  // Push x0 on the stack
+  str   x0, [sp, #-8]!
+
+  // Load the HVC arguments values into the appropriate registers
+  ldp   x6, x7, [x0, #48]
+  ldp   x4, x5, [x0, #32]
+  ldp   x2, x3, [x0, #16]
+  ldp   x0, x1, [x0, #0]
+
+  hvc   #0
+
+  // Pop the ARM_HVC_ARGS structure address from the stack into x9
+  ldr   x9, [sp], #8
+
+  // Store the HVC returned values into the appropriate registers
+  // A HVC call can return up to 4 values
+  stp   x2, x3, [x9, #16]
+  stp   x0, x1, [x9, #0]
+
+  mov   x0, x9
+
+  ret

ArmPkg/Library/ArmHvcLib/Arm/ArmHvc.S

@@ -0,0 +1,53 @@
+//
+//  Copyright (c) 2012-2014, ARM Limited. All rights reserved.
+//  Copyright (c) 2014, Linaro Limited. 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.
+//
+//
+
+.text
+.align 3
+.arch_extension virt
+
+GCC_ASM_EXPORT(ArmCallHvc)
+
+ASM_PFX(ArmCallHvc):
+    push    {r4-r8}
+    // r0 will be popped just after the HVC call
+    push    {r0}
+
+    // Load the HVC arguments values into the appropriate registers
+    ldr     r7, [r0, #28]
+    ldr     r6, [r0, #24]
+    ldr     r5, [r0, #20]
+    ldr     r4, [r0, #16]
+    ldr     r3, [r0, #12]
+    ldr     r2, [r0, #8]
+    ldr     r1, [r0, #4]
+    ldr     r0, [r0, #0]
+
+    hvc     #0
+
+    // Pop the ARM_HVC_ARGS structure address from the stack into r8
+    pop     {r8}
+
+    // Load the HVC returned values into the appropriate registers
+    // A HVC call can return up to 4 values - we do not need to store back r4-r7.
+    str     r3, [r8, #12]
+    str     r2, [r8, #8]
+    str     r1, [r8, #4]
+    str     r0, [r8, #0]
+
+    mov     r0, r8
+
+    // Restore the registers r4-r8
+    pop     {r4-r8}
+
+    bx      lr

ArmPkg/Library/ArmHvcLib/Arm/ArmHvc.asm

@@ -0,0 +1,53 @@
+//
+//  Copyright (c) 2012-2014, ARM Limited. All rights reserved.
+//  Copyright (c) 2014, Linaro Limited. 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.
+//
+//
+
+    EXPORT ArmCallHvc
+
+    AREA   ArmHvc, CODE, READONLY
+
+ArmCallHvc
+    push    {r4-r8}
+    // r0 will be popped just after the HVC call
+    push     {r0}
+
+    // Load the HVC arguments values into the appropriate registers
+    ldr     r7, [r0, #28]
+    ldr     r6, [r0, #24]
+    ldr     r5, [r0, #20]
+    ldr     r4, [r0, #16]
+    ldr     r3, [r0, #12]
+    ldr     r2, [r0, #8]
+    ldr     r1, [r0, #4]
+    ldr     r0, [r0, #0]
+
+    hvc     #0
+
+    // Pop the ARM_HVC_ARGS structure address from the stack into r8
+    pop     {r8}
+
+    // Load the HVC returned values into the appropriate registers
+    // A HVC call can return up to 4 values - we do not need to store back r4-r7.
+    str     r3, [r8, #12]
+    str     r2, [r8, #8]
+    str     r1, [r8, #4]
+    str     r0, [r8, #0]
+
+    mov     r0, r8
+
+    // Restore the registers r4-r8
+    pop     {r4-r8}
+
+    bx      lr
+
+    END

ArmPkg/Library/ArmHvcLib/ArmHvcLib.inf

@@ -0,0 +1,32 @@
+#/** @file
+#
+#  Copyright (c) 2012-2013, ARM Ltd. All rights reserved.<BR>
+#  Copyright (c) 2014, Linaro Ltd. 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                      = ArmHvcLib
+  FILE_GUID                      = E594959A-D150-44D3-963B-BA90329D3D9A
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = ArmHvcLib
+
+[Sources.ARM]
+  Arm/ArmHvc.asm    | RVCT
+  Arm/ArmHvc.S      | GCC
+
+[Sources.AARCH64]
+  AArch64/ArmHvc.S
+
+[Packages]
+  MdePkg/MdePkg.dec
+  ArmPkg/ArmPkg.dec