Pkg-Module: CorebootModulePkg

Initial coreboot UEFI payload code check in. It provides UEFI services on top of coreboot that allows UEFI OS boot.
CorebootModulePkg is the source code package of coreboot support modules that will be used to parse the coreboot tables and report memory/io resources.

It supports the following features:
  - Support Unified Extensible Firmware Interface (UEFI) specification 2.4.
  - Support Platform Initialization(PI) specification 1.3.
  - Support execution as a coreboot payload.
  - Support USB 3.0
  - Support SATA/ATA devices.
  - Support EFI aware OS boot.

The following features are not supported currently and have not been validated:
  - GCC Tool Chains
  - SMM Execution Environment
  - Security Boot

It was tested on a Intel Bay Trail CRB platform.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Maurice Ma <maurice.ma@intel.com>
Reviewed-by: Prince Agyeman <prince.agyeman@intel.com>

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

3 files changed, 293 insertions, 0 deletions

diff --git a/CorebootModulePkg/CbSupportDxe/CbSupportDxe.c b/CorebootModulePkg/CbSupportDxe/CbSupportDxe.c
new file mode 100644
index 0000000000..1b3e74a525
--- /dev/null
+++ b/CorebootModulePkg/CbSupportDxe/CbSupportDxe.c
@@ -0,0 +1,199 @@
+/** @file

+  This driver will report some MMIO/IO resources to dxe core, extract smbios and acpi 

+  tables from coreboot and install.

+  

+  Copyright (c) 2014, 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.

+

+**/

+#include "CbSupportDxe.h"

+

+UINTN mPmCtrlReg = 0;

+/**

+  Reserve MMIO/IO resource in GCD

+

+  @param  IsMMIO        Flag of whether it is mmio resource or io resource.

+  @param  GcdType       Type of the space.

+  @param  BaseAddress   Base address of the space.

+  @param  Length        Length of the space.

+  @param  Alignment     Align with 2^Alignment

+  @param  ImageHandle   Handle for the image of this driver.

+

+  @retval EFI_SUCCESS   Reserve successful

+**/

+EFI_STATUS

+CbReserveResourceInGcd (

+  IN BOOLEAN               IsMMIO,

+  IN UINTN                 GcdType,

+  IN EFI_PHYSICAL_ADDRESS  BaseAddress,

+  IN UINT64                Length,

+  IN UINTN                 Alignment,

+  IN EFI_HANDLE            ImageHandle

+  )

+{

+	EFI_STATUS               Status;

+

+  if (IsMMIO) {

+    Status = gDS->AddMemorySpace (

+                    GcdType,

+                    BaseAddress,

+                    Length,

+                    EFI_MEMORY_UC

+                    );

+    if (EFI_ERROR (Status)) {

+      DEBUG ((

+        EFI_D_ERROR,

+        "Failed to add memory space :0x%x 0x%x\n",

+        BaseAddress,

+        Length

+        ));

+    }

+    ASSERT_EFI_ERROR (Status);

+    Status = gDS->AllocateMemorySpace (

+                    EfiGcdAllocateAddress,

+                    GcdType,

+                    Alignment,

+                    Length,

+                    &BaseAddress,

+                    ImageHandle,

+                    NULL

+                    );

+    ASSERT_EFI_ERROR (Status);

+  } else {

+    Status = gDS->AddIoSpace (

+                    GcdType,

+                    BaseAddress,

+                    Length

+                    );

+    ASSERT_EFI_ERROR (Status);

+    Status = gDS->AllocateIoSpace (

+                    EfiGcdAllocateAddress,

+                    GcdType,

+                    Alignment,

+                    Length,

+                    &BaseAddress,

+                    ImageHandle,

+                    NULL

+                    );

+    ASSERT_EFI_ERROR (Status);

+  }

+  return Status;

+}

+

+/**

+  Notification function of EVT_GROUP_READY_TO_BOOT event group.

+

+  This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group.

+  When the Boot Manager is about to load and execute a boot option, it reclaims variable

+  storage if free size is below the threshold.

+

+  @param  Event        Event whose notification function is being invoked.

+  @param  Context      Pointer to the notification function's context.

+

+**/

+VOID

+OnReadyToBoot (

+  EFI_EVENT  Event,

+  VOID       *Context

+  )

+{	

+	//

+	// Enable SCI

+	//

+	IoOr16 (mPmCtrlReg, BIT0);

+	

+	DEBUG ((EFI_D_ERROR, "Enable SCI bit at 0x%x before boot\n", mPmCtrlReg));	

+}

+

+/**

+  Main entry for the Coreboot Support DXE module.

+  

+  @param[in] ImageHandle    The firmware allocated handle for the EFI image.

+  @param[in] SystemTable    A pointer to the EFI System Table.

+  

+  @retval EFI_SUCCESS       The entry point is executed successfully.

+  @retval other             Some error occurs when executing this entry point.

+

+**/

+EFI_STATUS

+CbDxeEntryPoint (

+  IN EFI_HANDLE         ImageHandle,

+  IN EFI_SYSTEM_TABLE   *SystemTable

+  )

+{  

+	EFI_STATUS Status;

+	EFI_EVENT  ReadyToBootEvent;

+	EFI_HOB_GUID_TYPE  *GuidHob;

+	SYSTEM_TABLE_INFO  *pSystemTableInfo;

+	ACPI_BOARD_INFO    *pAcpiBoardInfo;

+	

+	Status = EFI_SUCCESS;

+	//

+	// Report MMIO/IO Resources

+	//

+	Status = CbReserveResourceInGcd (TRUE, EfiGcdMemoryTypeMemoryMappedIo, 0xFEE00000, SIZE_1MB, 0, SystemTable); // LAPIC 

+	ASSERT_EFI_ERROR (Status);

+	

+	Status = CbReserveResourceInGcd (TRUE, EfiGcdMemoryTypeMemoryMappedIo, 0xFEC00000, SIZE_4KB, 0, SystemTable); // IOAPIC 

+	ASSERT_EFI_ERROR (Status);

+	

+	Status = CbReserveResourceInGcd (TRUE, EfiGcdMemoryTypeMemoryMappedIo, 0xFED00000, SIZE_1KB, 0, SystemTable); // HPET 

+	ASSERT_EFI_ERROR (Status);

+	

+	//

+	// Find the system table information guid hob

+	//

+	GuidHob = GetFirstGuidHob (&gUefiSystemTableInfoGuid);

+	ASSERT (GuidHob != NULL);

+  pSystemTableInfo = (SYSTEM_TABLE_INFO *)GET_GUID_HOB_DATA (GuidHob);

+	

+	//

+	// Install Acpi Table

+	//

+	if (pSystemTableInfo->AcpiTableBase != 0 && pSystemTableInfo->AcpiTableSize != 0) {		

+		DEBUG ((EFI_D_ERROR, "Install Acpi Table at 0x%x, length 0x%x\n", (UINTN)pSystemTableInfo->AcpiTableBase, pSystemTableInfo->AcpiTableSize));	

+		Status = gBS->InstallConfigurationTable (&gEfiAcpiTableGuid, (VOID *)(UINTN)pSystemTableInfo->AcpiTableBase);

+		ASSERT_EFI_ERROR (Status);

+	}

+	

+	//

+	// Install Smbios Table

+	//

+	if (pSystemTableInfo->SmbiosTableBase != 0 && pSystemTableInfo->SmbiosTableSize != 0) {			

+		DEBUG ((EFI_D_ERROR, "Install Smbios Table at 0x%x, length 0x%x\n", (UINTN)pSystemTableInfo->SmbiosTableBase, pSystemTableInfo->SmbiosTableSize));	

+		Status = gBS->InstallConfigurationTable (&gEfiSmbiosTableGuid, (VOID *)(UINTN)pSystemTableInfo->SmbiosTableBase);

+		ASSERT_EFI_ERROR (Status);

+	}

+	

+	//

+	// Find the acpi board information guid hob

+	//

+	GuidHob = GetFirstGuidHob (&gUefiAcpiBoardInfoGuid);

+	ASSERT (GuidHob != NULL);

+  pAcpiBoardInfo = (ACPI_BOARD_INFO *)GET_GUID_HOB_DATA (GuidHob); 

+  

+  mPmCtrlReg = (UINTN)pAcpiBoardInfo->PmCtrlRegBase;

+	DEBUG ((EFI_D_ERROR, "PmCtrlReg at 0x%x\n", mPmCtrlReg));	

+	 

+	//

+	// Register callback on the ready to boot event 

+	// in order to enable SCI

+	// 	

+	ReadyToBootEvent = NULL;

+  Status = EfiCreateEventReadyToBootEx (

+                    TPL_CALLBACK,

+                    OnReadyToBoot,

+                    NULL,

+                    &ReadyToBootEvent

+                    );

+  ASSERT_EFI_ERROR (Status);

+  

+  return EFI_SUCCESS;

+}

+

diff --git a/CorebootModulePkg/CbSupportDxe/CbSupportDxe.h b/CorebootModulePkg/CbSupportDxe/CbSupportDxe.h
new file mode 100644
index 0000000000..bace2728e6
--- /dev/null
+++ b/CorebootModulePkg/CbSupportDxe/CbSupportDxe.h
@@ -0,0 +1,35 @@
+/** @file

+  The header file of Coreboot Support DXE.

+

+Copyright (c) 2014, 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.

+

+**/

+#ifndef __DXE_COREBOOT_SUPPORT_H__

+#define __DXE_COREBOOT_SUPPORT_H__

+

+#include <PiDxe.h>

+

+#include <Library/UefiDriverEntryPoint.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/DxeServicesTableLib.h>

+#include <Library/DebugLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/UefiLib.h>

+#include <Library/IoLib.h>

+#include <Library/HobLib.h>

+

+#include <Guid/Acpi.h>

+#include <Guid/SmBios.h>

+#include <Guid/SystemTableInfoGuid.h>

+#include <Guid/AcpiBoardInfoGuid.h>

+

+#include <IndustryStandard/Acpi.h>

+

+#endif

diff --git a/CorebootModulePkg/CbSupportDxe/CbSupportDxe.inf b/CorebootModulePkg/CbSupportDxe/CbSupportDxe.inf
new file mode 100644
index 0000000000..c92db8ded4
--- /dev/null
+++ b/CorebootModulePkg/CbSupportDxe/CbSupportDxe.inf
@@ -0,0 +1,59 @@
+## @file

+# Coreboot Support DXE Module

+#

+# Report some MMIO/IO resources to dxe core, extract smbios and acpi tables from coreboot and install.

+#

+#  Copyright (c) 2014, 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                      = CbSupportDxe

+  FILE_GUID                      = C68DAA4E-7AB5-41e8-A91D-5954421053F3

+  MODULE_TYPE                    = DXE_DRIVER

+  VERSION_STRING                 = 1.0

+  ENTRY_POINT                    = CbDxeEntryPoint

+

+#

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

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources]

+  CbSupportDxe.c

+  CbSupportDxe.h

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+  IntelFrameworkPkg/IntelFrameworkPkg.dec

+  IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec

+  CorebootModulePkg/CorebootModulePkg.dec

+

+[LibraryClasses]

+  UefiDriverEntryPoint

+  UefiBootServicesTableLib

+  DxeServicesTableLib

+  DebugLib

+  BaseMemoryLib

+  UefiLib

+  IoLib

+  HobLib

+

+[Guids]  

+  gEfiAcpiTableGuid

+  gEfiSmbiosTableGuid

+  gUefiSystemTableInfoGuid

+  gUefiAcpiBoardInfoGuid

+

+[Depex]

+  TRUE