ArmPlatformPkg/ArmVExpressPkg/ArmVExpressDxe/ArmVExpressInternal.h

   1 /** @file
   2
   3   Copyright (c) 2014, ARM Ltd. All rights reserved.
   4
   5   This program and the accompanying materials are licensed and made available
   6   under the terms and conditions of the BSD License which accompanies this
   7   distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
  11   WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __ARM_VEXPRESS_INTERNAL_H__
  16 #define __ARM_VEXPRESS_INTERNAL_H__
  17
  18 #include <Uefi.h>
  19
  20 #include <Library/ArmLib.h>
  21 #include <Library/DebugLib.h>
  22 #include <Library/IoLib.h>
  23 #include <Library/PcdLib.h>
  24 #include <Library/UefiBootServicesTableLib.h>
  25 #include <Library/UefiLib.h>
  26
  27 #include <VExpressMotherBoard.h>
  28
  29 // This 'enum' is needed as variations based on existing platform exist
  30 typedef enum {
  31   ARM_FVP_VEXPRESS_UNKNOWN = 0,
  32   ARM_FVP_VEXPRESS_A9x4,
  33   ARM_FVP_VEXPRESS_A15x1,
  34   ARM_FVP_VEXPRESS_A15x2,
  35   ARM_FVP_VEXPRESS_A15x4,
  36   ARM_FVP_VEXPRESS_A15x1_A7x1,
  37   ARM_FVP_VEXPRESS_A15x4_A7x4,
  38   ARM_FVP_VEXPRESS_AEMv8x4,
  39   ARM_FVP_BASE_AEMv8x4_AEMv8x4,
  40   ARM_FVP_FOUNDATION,
  41   ARM_HW_A9x4,
  42   ARM_HW_A15x2_A7x3,
  43   ARM_HW_A15,
  44   ARM_HW_A5
  45 } ARM_VEXPRESS_PLATFORM_ID;
  46
  47 typedef struct {
  48   ARM_VEXPRESS_PLATFORM_ID  Id;
  49   // Will be extended with platform specific information
  50 } ARM_VEXPRESS_PLATFORM;
  51
  52 // Array that contains the list of the VExpress based platform supported by this DXE driver
  53 extern CONST ARM_VEXPRESS_PLATFORM ArmVExpressPlatforms[];
  54
  55 /**
  56   Get information about the VExpress platform the firmware is running on given its Id.
  57
  58   @param[in]   PlatformId  Id of the VExpress platform.
  59   @param[out]  Platform    Address where the pointer to the platform information
  60                            (type ARM_VEXPRESS_PLATFORM*) should be stored.
  61                            The returned pointer does not point to an allocated
  62                            memory area.
  63
  64   @retval  EFI_SUCCESS    The platform information was returned.
  65   @retval  EFI_NOT_FOUND  The platform was not recognised.
  66
  67 **/
  68 EFI_STATUS
  69 ArmVExpressGetPlatformFromId (
  70   IN  CONST ARM_VEXPRESS_PLATFORM_ID PlatformId,
  71   OUT CONST ARM_VEXPRESS_PLATFORM**  Platform
  72   );
  73
  74 /**
  75
  76   Get information about the VExpress platform the firmware is running on.
  77
  78   @param[out]  Platform   Address where the pointer to the platform information
  79                           (type ARM_VEXPRESS_PLATFORM*) should be stored.
  80                           The returned pointer does not point to an allocated
  81                           memory area.
  82
  83   @retval  EFI_SUCCESS    The platform information was returned.
  84   @retval  EFI_NOT_FOUND  The platform was not recognised.
  85
  86 **/
  87 EFI_STATUS
  88 ArmVExpressGetPlatform (
  89   OUT CONST ARM_VEXPRESS_PLATFORM** Platform
  90   );
  91
  92 #endif // __ARM_VEXPRESS_INTERNAL_H__