Port PlatformDriOverrideDxe into R9.

1. Add one OverrideVariableGuid in MdeModulePkg
2. Add one library PlatDriOverLib used by PlatformDriOverrideDxe.
3. Add PlatformDriOverrideDxe in MdeModulePkg

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4557 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 342 insertions, 0 deletions

diff --git a/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverride.c b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverride.c
new file mode 100644
index 0000000000..2a189138ed
--- /dev/null
+++ b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverride.c
@@ -0,0 +1,186 @@
+/** @file

+

+Copyright (c) 2007, Intel Corporation

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

+

+Module Name:

+

+    PlatformDriOverride.c

+

+Abstract:

+

+

+**/

+

+

+#include "PlatformDriOverride.h"

+

+EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL gPlatformDriverOverride = {

+  GetDriver,

+  GetDriverPath,

+  DriverLoaded

+};

+

+STATIC  LIST_ENTRY      mMappingDataBase = INITIALIZE_LIST_HEAD_VARIABLE (mMappingDataBase);

+STATIC  BOOLEAN         mEnvironmentVariableRead = FALSE;

+STATIC  EFI_HANDLE      mCallerImageHandle;

+

+

+EFI_STATUS

+EFIAPI

+PlatformDriverOverrideEntry (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+/*++

+

+Routine Description:

+   Platform Driver Override driver entry point, install the Platform Driver Override Protocol

+

+Arguments:

+  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)

+

+Returns:

+  EFI_STATUS

+

+--*/

+{

+  mEnvironmentVariableRead = FALSE;

+  mCallerImageHandle = ImageHandle;

+  InitializeListHead (&mMappingDataBase);

+  return InstallPlatformDriverOverrideProtocol (&gPlatformDriverOverride);

+}

+

+

+/**

+  Retrieves the image handle of the platform override driver for a controller in the system.

+

+  @param  This                   A pointer to the

+                                 EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.

+  @param  ControllerHandle       The device handle of the controller to check if a

+                                 driver override exists.

+  @param  DriverImageHandle      On input, a pointer to the previous driver image

+                                 handle returned by GetDriver().  On output, a

+                                 pointer to the next driver image handle. Passing

+                                 in a NULL,  will return the first driver image

+                                 handle for ControllerHandle.

+

+  @retval EFI_SUCCESS            The driver override for ControllerHandle was

+                                 returned in DriverImageHandle.

+  @retval EFI_NOT_FOUND          A driver override for ControllerHandle was not

+                                 found.

+  @retval EFI_INVALID_PARAMETER  The handle specified by ControllerHandle is not a

+                                 valid handle. DriverImageHandle is not a handle

+                                 that was returned on a previous  call to

+                                 GetDriver().

+

+**/

+STATIC

+EFI_STATUS

+EFIAPI

+GetDriver (

+  IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              * This,

+  IN     EFI_HANDLE                                     ControllerHandle,

+  IN OUT EFI_HANDLE                                     * DriverImageHandle

+  )

+{

+  EFI_STATUS  Status;

+  //

+  // Check that ControllerHandle is a valid handle

+  //

+  if (ControllerHandle == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  //

+  // Read the environment variable(s) that contain the override mappings from Controller Device Path to

+  // a set of Driver Device Paths, and  initialize in memory database of the overrides that map Controller

+  // Device Paths to an ordered set of Driver Device Paths and Driver Handles. This action is only performed

+  // once and finished in first call.

+  //

+  if (!mEnvironmentVariableRead) {

+    mEnvironmentVariableRead = TRUE;

+

+    Status = InitOverridesMapping (&mMappingDataBase);

+    if (Status == EFI_NOT_FOUND) {

+      InitializeListHead (&mMappingDataBase);

+      return EFI_NOT_FOUND;

+    } else if (Status == EFI_VOLUME_CORRUPTED){

+      DEBUG ((DEBUG_ERROR, "Platform Driver Override Variable is corrupt\n"));

+      //

+      // The environment variable(s) that contain the override mappings from Controller Device Path to

+      //  a set of Driver Device Paths is corrupted,  platform code can use LibDeleteOverridesVariables to

+      //  delete all orverride variables as a policy. Here can be IBV/OEM customized.

+      //

+

+      //LibDeleteOverridesVariables();

+      InitializeListHead (&mMappingDataBase);

+      return EFI_NOT_FOUND;

+    } else if (EFI_ERROR (Status)){

+      InitializeListHead (&mMappingDataBase);

+      return EFI_NOT_FOUND;

+    }

+  }

+  //

+  // if the environment variable does not exist or the variable appears to be corrupt, just return not found

+  //

+  if (IsListEmpty (&mMappingDataBase)) {

+    return EFI_NOT_FOUND;

+  }

+

+  return GetDriverFromMapping (

+            This,

+            ControllerHandle,

+            DriverImageHandle,

+            &mMappingDataBase,

+            mCallerImageHandle

+            );

+

+}

+

+

+/**

+  For the use of the ControllerHandle parameter in the GetDriverPath() and DriverLoaded() APIs

+  makes those APIs very difficult to use, so not support.

+

+

+

+**/

+STATIC

+EFI_STATUS

+EFIAPI

+GetDriverPath (

+  IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              * This,

+  IN     EFI_HANDLE                                     ControllerHandle,

+  IN OUT EFI_DEVICE_PATH_PROTOCOL                       **DriverImagePath

+  )

+{

+  return EFI_UNSUPPORTED;

+}

+

+

+/**

+  For the use of the ControllerHandle parameter in the GetDriverPath() and DriverLoaded() APIs

+  makes those APIs very difficult to use, so not support.

+

+

+

+**/

+STATIC

+EFI_STATUS

+EFIAPI

+DriverLoaded (

+  IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL          * This,

+  IN EFI_HANDLE                                     ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL                       * DriverImagePath,

+  IN EFI_HANDLE                                     DriverImageHandle

+  )

+{

+  return EFI_UNSUPPORTED;

+}

diff --git a/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverride.h b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverride.h
new file mode 100644
index 0000000000..5a5b276451
--- /dev/null
+++ b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverride.h
@@ -0,0 +1,58 @@
+/** @file
+
+Copyright (c) 2007, Intel Corporation
+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.
+
+Module Name:
+
+    PlatformDriOverride.h
+
+Abstract:
+
+
+**/
+
+#ifndef PLATFORM_DRI_OVERRIDE_H_
+#define PLATFORM_DRI_OVERRIDE_H_
+
+#include <PiDxe.h>
+

+#include <Library/DebugLib.h>

+#include <Library/UefiDriverEntryPoint.h>

+#include <Library/BaseLib.h>

+#include <Library/PlatDriOverLib.h>
+
+STATIC
+EFI_STATUS
+EFIAPI
+GetDriver (
+  IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              * This,
+  IN     EFI_HANDLE                                     ControllerHandle,
+  IN OUT EFI_HANDLE                                     * DriverImageHandle
+  );
+
+STATIC
+EFI_STATUS
+EFIAPI
+GetDriverPath (
+  IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              * This,
+  IN     EFI_HANDLE                                     ControllerHandle,
+  IN OUT EFI_DEVICE_PATH_PROTOCOL                       **DriverImagePath
+  );
+
+STATIC
+EFI_STATUS
+EFIAPI
+DriverLoaded (
+  IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL          * This,
+  IN EFI_HANDLE                                     ControllerHandle,
+  IN EFI_DEVICE_PATH_PROTOCOL                       * DriverImagePath,
+  IN EFI_HANDLE                                     DriverImageHandle
+  );
+#endif
diff --git a/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverrideDxe.inf b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverrideDxe.inf
new file mode 100644
index 0000000000..dbc9f0ecb7
--- /dev/null
+++ b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverrideDxe.inf
@@ -0,0 +1,48 @@
+#/** @file

+# Component name for module PlatformDriOverride

+#

+# FIX ME!

+# Copyright (c) 2007, Intel Corporation. All rights reserved.

+#

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

+#

+#

+#**/

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = PlatformDriOverrideDxe

+  FILE_GUID                      = 35034CE2-A6E5-4fb4-BABE-A0156E9B2549

+  MODULE_TYPE                    = DXE_DRIVER

+  VERSION_STRING                 = 1.0

+  EDK_RELEASE_VERSION            = 0x00020000

+  EFI_SPECIFICATION_VERSION      = 0x00020000

+

+  ENTRY_POINT                    = PlatformDriverOverrideEntry

+

+#

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

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources.common]

+  PlatformDriOverride.c

+  PlatformDriOverride.h

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+  BaseLib

+  UefiDriverEntryPoint

+  DebugLib

+  PlatDriOverLib

+

diff --git a/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverrideDxe.msa b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverrideDxe.msa
new file mode 100644
index 0000000000..6e1645af35
--- /dev/null
+++ b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatformDriOverrideDxe.msa
@@ -0,0 +1,50 @@
+<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

+  <MsaHeader>

+    <ModuleName>PlatformDriOverrideDxe</ModuleName>

+    <ModuleType>DXE_DRIVER</ModuleType>

+    <GuidValue>35034CE2-A6E5-4fb4-BABE-A0156E9B2549</GuidValue>

+    <Version>1.0</Version>

+    <Abstract>Component name for module PlatformDriOverride</Abstract>

+    <Description>FIX ME!</Description>

+    <Copyright>Copyright (c) 2007, Intel Corporation. All rights reserved.</Copyright>

+    <License>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.</License>

+    <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052</Specification>

+  </MsaHeader>

+  <ModuleDefinitions>

+    <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>

+    <BinaryModule>false</BinaryModule>

+    <OutputFileBasename>PlatformDriOverrideDxe</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>UefiDriverEntryPoint</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseLib</Keyword>

+    </LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>PlatformDriOverride.h</Filename>

+    <Filename>PlatformDriOverride.c</Filename>

+  </SourceFiles>

+  <PackageDependencies>

+    <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>

+    <Package PackageGuid="68169ab0-d41b-4009-9060-292c253ac43d"/>

+  </PackageDependencies>

+  <Externs>

+    <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>

+    <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>

+    <Extern>

+      <ModuleEntryPoint>PlatformDriverOverrideEntry</ModuleEntryPoint>

+    </Extern>

+  </Externs>

+</ModuleSurfaceArea>
\ No newline at end of file