Merge application PlatOverMngr and library DxePlatDriOverLib into driver PlatDriOverrideDxe.

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

1 files changed, 218 insertions, 0 deletions

diff --git a/MdeModulePkg/Universal/PlatformDriOverrideDxe/InternalPlatDriOverrideDxe.h b/MdeModulePkg/Universal/PlatformDriOverrideDxe/InternalPlatDriOverrideDxe.h
new file mode 100644
index 0000000000..efd87e91e7
--- /dev/null
+++ b/MdeModulePkg/Universal/PlatformDriOverrideDxe/InternalPlatDriOverrideDxe.h
@@ -0,0 +1,218 @@
+/** @file

+  Ihe internal heder file includes the required Protocol/Guid/Library

+  and the shared function APIs.

+

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

+

+**/

+

+#ifndef _INTERNAL_PLATFORM_DRIVER_OVERRIDE_H_

+#define _INTERNAL_PLATFORM_DRIVER_OVERRIDE_H_

+

+#include <PiDxe.h>

+

+#include <Protocol/HiiConfigAccess.h>

+#include <Protocol/HiiConfigRouting.h>

+#include <Protocol/HiiDatabase.h>

+#include <Protocol/FormBrowser2.h>

+#include <Protocol/LoadedImage.h>

+#include <Protocol/FirmwareVolume2.h>

+#include <Protocol/PciIo.h>

+#include <Protocol/BusSpecificDriverOverride.h>

+#include <Protocol/ComponentName2.h>

+#include <Protocol/ComponentName.h>

+#include <Protocol/DriverBinding.h>

+#include <Protocol/DevicePathToText.h>

+#include <Protocol/DevicePath.h>

+#include <Protocol/PlatformDriverOverride.h>

+#include <Guid/MdeModuleHii.h>

+#include <Guid/VariableFormat.h>

+

+#include <Library/BaseLib.h>

+#include <Library/DebugLib.h>

+#include <Library/UefiLib.h>

+#include <Library/PrintLib.h>

+#include <Library/UefiDriverEntryPoint.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/UefiRuntimeServicesTableLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/DevicePathLib.h>

+#include <Library/DxeServicesTableLib.h>

+#include <Library/HiiLib.h>

+

+/**

+  Free all the mapping database memory resource and initialize the mapping list entry.

+

+  @param  MappingDataBase          Mapping database list entry pointer

+

+  @retval EFI_INVALID_PARAMETER    mapping database list entry is NULL

+  @retval EFI_SUCCESS              Free success

+

+**/

+EFI_STATUS

+EFIAPI

+FreeMappingDatabase (

+  IN  OUT  LIST_ENTRY            *MappingDataBase

+  )

+;
+

+/**

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

+  a set of Driver Device Paths, and create the mapping database in memory to contain these variable info.

+

+  @param  MappingDataBase          Mapping database list entry pointer

+

+  @retval EFI_INVALID_PARAMETER    MappingDataBase pointer is null

+  @retval EFI_NOT_FOUND            Cannot find the 'PlatDriOver' NV variable

+  @retval EFI_VOLUME_CORRUPTED     The found NV variable is corrupted

+  @retval EFI_SUCCESS              Create the mapping database in memory successfully

+

+**/

+EFI_STATUS

+EFIAPI

+InitOverridesMapping (

+  OUT  LIST_ENTRY            *MappingDataBase

+  )

+;
+

+/**

+  Save the memory mapping database into NV environment variable(s).

+  If MappingDataBase list is empty, then delete all platform override NV variables.

+

+  @param  MappingDataBase          Mapping database list entry pointer

+

+  @retval EFI_INVALID_PARAMETER    MappingDataBase pointer is null

+  @retval EFI_SUCCESS              Save memory mapping database successfully

+

+**/

+EFI_STATUS

+EFIAPI

+SaveOverridesMapping (

+  IN  LIST_ENTRY              *MappingDataBase

+  )

+;
+

+/**

+  Retrieves the image handle of the platform override driver for a controller in the system from the memory mapping database.

+

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

+                                   a driver override exists.

+  @param  DriverImageHandle        On output, a pointer to the next driver handle.

+                                   Passing in a pointer to NULL, will return the

+                                   first driver handle for ControllerHandle.

+  @param  MappingDataBase          MappingDataBase - Mapping database list entry

+                                   pointer

+  @param  CallerImageHandle        The caller driver's image handle, for

+                                   UpdateFvFileDevicePath use.

+

+  @retval EFI_INVALID_PARAMETER    The handle specified by ControllerHandle is not

+                                   a valid handle.  Or DriverImagePath is not a

+                                   device path that was returned on a previous call

+                                   to GetDriverPath().

+  @retval EFI_NOT_FOUND            A driver override for ControllerHandle was not

+                                   found.

+  @retval EFI_UNSUPPORTED          The operation is not supported.

+  @retval EFI_SUCCESS              The driver override for ControllerHandle was

+                                   returned in DriverImagePath.

+

+**/

+EFI_STATUS

+EFIAPI

+GetDriverFromMapping (

+  IN     EFI_HANDLE                                     ControllerHandle,

+  IN OUT EFI_HANDLE                                     *DriverImageHandle,

+  IN     LIST_ENTRY                                     *MappingDataBase,

+  IN     EFI_HANDLE                                     CallerImageHandle

+  )

+;
+

+/**

+  Check mapping database whether already has the mapping info which

+  records the input Controller to input DriverImage.

+

+  @param  ControllerDevicePath     The controller device path is to be check.

+  @param  DriverImageDevicePath    The driver image device path is to be check.

+  @param  MappingDataBase          Mapping database list entry pointer

+  @param  DriverInfoNum            the controller's total override driver number

+  @param  DriverImageNO            The driver order number for the input DriverImage.

+                                   If the DriverImageDevicePath is NULL, DriverImageNO is not set.

+

+  @retval EFI_INVALID_PARAMETER    ControllerDevicePath or MappingDataBase is NULL.

+  @retval EFI_NOT_FOUND            ControllerDevicePath is not found in MappingDataBase or

+                                   DriverImageDevicePath is not found in the found DriverImage Info list. 

+  @retval EFI_SUCCESS              The controller's total override driver number and 

+                                   input DriverImage's order number is correctly return.

+**/

+EFI_STATUS

+EFIAPI

+CheckMapping (

+  IN     EFI_DEVICE_PATH_PROTOCOL                       *ControllerDevicePath,

+  IN     EFI_DEVICE_PATH_PROTOCOL                       *DriverImageDevicePath  OPTIONAL,

+  IN     LIST_ENTRY                                     *MappingDataBase,

+  OUT    UINT32                                         *DriverInfoNum  OPTIONAL,

+  OUT    UINT32                                         *DriverImageNO  OPTIONAL

+  )

+;
+

+/**

+  Insert a driver image as a controller's override driver into the mapping database.

+  The driver image's order number is indicated by DriverImageNO.

+

+  @param  ControllerDevicePath     The controller device path need to add a

+                                   override driver image item

+  @param  DriverImageDevicePath    The driver image device path need to be insert

+  @param  MappingDataBase          Mapping database list entry pointer

+  @param  DriverImageNO            The inserted order number. If this number is taken, 

+                                   the larger available number will be used.

+

+  @retval EFI_INVALID_PARAMETER    ControllerDevicePath is NULL, or DriverImageDevicePath is NULL

+                                   or MappingDataBase is NULL

+  @retval EFI_ALREADY_STARTED      The input Controller to input DriverImage has been 

+                                   recorded into the mapping database.

+  @retval EFI_SUCCESS              The Controller and DriverImage are inserted into 

+                                   the mapping database successfully.

+

+**/

+EFI_STATUS

+EFIAPI

+InsertDriverImage (

+  IN     EFI_DEVICE_PATH_PROTOCOL                       *ControllerDevicePath,

+  IN     EFI_DEVICE_PATH_PROTOCOL                       *DriverImageDevicePath,

+  IN     LIST_ENTRY                                     *MappingDataBase,

+  IN     UINT32                                         DriverImageNO

+  )

+;
+

+/**

+  Delete a controller's override driver from the mapping database.

+

+  @param  ControllerDevicePath     The controller device path will be deleted 

+                                   when all drivers images on it are removed.

+  @param  DriverImageDevicePath    The driver image device path will be delete.

+                                   If NULL, all driver image will be delete.

+  @param  MappingDataBase          Mapping database list entry pointer

+

+  @retval EFI_INVALID_PARAMETER    ControllerDevicePath is NULL, or MappingDataBase is NULL

+  @retval EFI_NOT_FOUND            ControllerDevicePath is not found in MappingDataBase or

+                                   DriverImageDevicePath is not found in the found DriverImage Info list. 

+  @retval EFI_SUCCESS              Delete the specified driver successfully.

+

+**/

+EFI_STATUS

+EFIAPI

+DeleteDriverImage (

+  IN     EFI_DEVICE_PATH_PROTOCOL                       *ControllerDevicePath,

+  IN     EFI_DEVICE_PATH_PROTOCOL                       *DriverImageDevicePath,

+  IN     LIST_ENTRY                                     *MappingDataBase

+  )

+;
+

+#endif