Import some Pei and Dxe related instances for MdePkg.

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

4 files changed, 555 insertions, 0 deletions

diff --git a/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/CommonHeader.h b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/CommonHeader.h
new file mode 100644
index 0000000000..40a075d503
--- /dev/null
+++ b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/CommonHeader.h
@@ -0,0 +1,38 @@
+/**@file

+  Common header file shared by all source files.

+

+  This file includes package header files, library classes and protocol, PPI & GUID definitions.

+

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

+**/

+

+#ifndef __COMMON_HEADER_H_

+#define __COMMON_HEADER_H_

+

+

+//

+// The package level header files this module uses

+//

+#include <Uefi.h>

+//

+// The protocols, PPI and GUID defintions for this module

+//

+#include <Protocol/DevicePathUtilities.h>

+#include <Protocol/DevicePath.h>

+//

+// The Library classes this module consumes

+//

+#include <Library/DevicePathLib.h>

+#include <Library/DebugLib.h>

+#include <Library/BaseLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+

+#endif

diff --git a/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c
new file mode 100644
index 0000000000..2492e4b95d
--- /dev/null
+++ b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c
@@ -0,0 +1,353 @@
+/** @file

+  UEFI Device Path Library.

+

+  Copyright (c) 2006, Intel Corporation<BR>

+  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:  UefiDevicePathLib.c

+

+**/

+

+//

+// Include common header file for this module.

+//

+#include "CommonHeader.h"

+

+STATIC EFI_DEVICE_PATH_UTILITIES_PROTOCOL          *mDevicePathUtilities = NULL;

+

+/**

+  The constructor function caches the pointer to DevicePathUtilites protocol.

+  

+  The constructor function locates DevicePathUtilities protocol from protocol database.

+  It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. 

+

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

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

+  

+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+DevicePathLibConstructor (

+  IN      EFI_HANDLE                ImageHandle,

+  IN      EFI_SYSTEM_TABLE          *SystemTable

+  )

+{

+  EFI_STATUS                        Status;

+

+  Status = gBS->LocateProtocol (

+                  &gEfiDevicePathUtilitiesProtocolGuid,

+                  NULL,

+                  (VOID**) &mDevicePathUtilities

+                  );

+  ASSERT_EFI_ERROR (Status);

+  ASSERT (mDevicePathUtilities != NULL);

+

+  return Status;

+}

+

+/**

+  Returns the size of a device path in bytes.

+

+  This function returns the size, in bytes, of the device path data structure specified by

+  DevicePath including the end of device path node.  If DevicePath is NULL, then 0 is returned.

+

+  @param  DevicePath                 A pointer to a device path data structure.

+

+  @return The size of a device path in bytes.

+

+**/

+UINTN

+EFIAPI

+GetDevicePathSize (

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath

+  )

+{

+  return mDevicePathUtilities->GetDevicePathSize (DevicePath);

+}

+

+/**

+  Creates a new device path by appending a second device path to a first device path.

+

+  This function allocates space for a new copy of the device path specified by DevicePath.  If

+  DevicePath is NULL, then NULL is returned.  If the memory is successfully allocated, then the

+  contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer

+  is returned.  Otherwise, NULL is returned.  

+  

+  @param  DevicePath                 A pointer to a device path data structure.

+

+  @return A pointer to the duplicated device path.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+DuplicateDevicePath (

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath

+  )

+{

+  return mDevicePathUtilities->DuplicateDevicePath (DevicePath);

+}

+

+/**

+  Creates a new device path by appending a second device path to a first device path.

+

+  This function creates a new device path by appending a copy of SecondDevicePath to a copy of

+  FirstDevicePath in a newly allocated buffer.  Only the end-of-device-path device node from

+  SecondDevicePath is retained. The newly created device path is returned.  

+  If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned.  

+  If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned.  

+  If both FirstDevicePath and SecondDevicePath are NULL, then NULL is returned.  

+  If there is not enough memory for the newly allocated buffer, then NULL is returned.

+  The memory for the new device path is allocated from EFI boot services memory. It is the

+  responsibility of the caller to free the memory allocated.

+

+  @param  FirstDevicePath            A pointer to a device path data structure.

+  @param  SecondDevicePath           A pointer to a device path data structure.

+

+  @return A pointer to the new device path.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+AppendDevicePath (

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *FirstDevicePath,  OPTIONAL

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *SecondDevicePath  OPTIONAL

+  )

+{

+  return mDevicePathUtilities->AppendDevicePath (FirstDevicePath, SecondDevicePath);

+}

+

+/**

+  Creates a new path by appending the device node to the device path.

+

+  This function creates a new device path by appending a copy of the device node specified by

+  DevicePathNode to a copy of the device path specified by DevicePath in an allocated buffer.

+  The end-of-device-path device node is moved after the end of the appended device node.

+  If DevicePath is NULL, then NULL is returned.

+  If DevicePathNode is NULL, then NULL is returned.

+  If there is not enough memory to allocate space for the new device path, then NULL is returned.  

+  The memory is allocated from EFI boot services memory. It is the responsibility of the caller to

+  free the memory allocated.

+

+  @param  DevicePath                 A pointer to a device path data structure.

+  @param  DevicePathNode             A pointer to a single device path node.

+

+  @return A pointer to the new device path.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+AppendDevicePathNode (

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,     OPTIONAL

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathNode  OPTIONAL

+  )

+{

+  return mDevicePathUtilities->AppendDeviceNode (DevicePath, DevicePathNode);

+}

+

+/**

+  Creates a new device path by appending the specified device path instance to the specified device

+  path.

+ 

+  This function creates a new device path by appending a copy of the device path instance specified

+  by DevicePathInstance to a copy of the device path secified by DevicePath in a allocated buffer.

+  The end-of-device-path device node is moved after the end of the appended device path instance

+  and a new end-of-device-path-instance node is inserted between. 

+  If DevicePath is NULL, then a copy if DevicePathInstance is returned.

+  If DevicePathInstance is NULL, then NULL is returned.

+  If there is not enough memory to allocate space for the new device path, then NULL is returned.  

+  The memory is allocated from EFI boot services memory. It is the responsibility of the caller to

+  free the memory allocated.

+  

+  @param  DevicePath                 A pointer to a device path data structure.

+  @param  DevicePathInstance         A pointer to a device path instance.

+

+  @return A pointer to the new device path.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+AppendDevicePathInstance (

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,        OPTIONAL

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathInstance OPTIONAL

+  )

+{

+  return mDevicePathUtilities->AppendDevicePathInstance (DevicePath, DevicePathInstance);

+}

+

+/**

+  Creates a copy of the current device path instance and returns a pointer to the next device path

+  instance.

+

+  This function creates a copy of the current device path instance. It also updates DevicePath to

+  point to the next device path instance in the device path (or NULL if no more) and updates Size

+  to hold the size of the device path instance copy.

+  If DevicePath is NULL, then NULL is returned.

+  If there is not enough memory to allocate space for the new device path, then NULL is returned.  

+  The memory is allocated from EFI boot services memory. It is the responsibility of the caller to

+  free the memory allocated.

+  If Size is NULL, then ASSERT().

+ 

+  @param  DevicePath                 On input, this holds the pointer to the current device path

+                                     instance. On output, this holds the pointer to the next device

+                                     path instance or NULL if there are no more device path

+                                     instances in the device path pointer to a device path data

+                                     structure.

+  @param  Size                       On output, this holds the size of the device path instance, in

+                                     bytes or zero, if DevicePath is NULL.

+

+  @return A pointer to the current device path instance.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+GetNextDevicePathInstance (

+  IN OUT EFI_DEVICE_PATH_PROTOCOL    **DevicePath,

+  OUT UINTN                          *Size

+  )

+{

+  ASSERT (Size != NULL);

+  return mDevicePathUtilities->GetNextDevicePathInstance (DevicePath, Size);

+}

+

+/**

+  Creates a copy of the current device path instance and returns a pointer to the next device path

+  instance.

+

+  This function creates a new device node in a newly allocated buffer of size NodeLength and

+  initializes the device path node header with NodeType and NodeSubType.  The new device path node

+  is returned.

+  If NodeLength is smaller than a device path header, then NULL is returned.  

+  If there is not enough memory to allocate space for the new device path, then NULL is returned.  

+  The memory is allocated from EFI boot services memory. It is the responsibility of the caller to

+  free the memory allocated.

+

+  @param  NodeType                   The device node type for the new device node.

+  @param  NodeSubType                The device node sub-type for the new device node.

+  @param  NodeLength                 The length of the new device node.

+

+  @return The new device path.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+CreateDeviceNode (

+  IN UINT8                           NodeType,

+  IN UINT8                           NodeSubType,

+  IN UINT16                          NodeLength

+  )

+{

+  return mDevicePathUtilities->CreateDeviceNode (NodeType, NodeSubType, NodeLength);

+}

+

+/**

+  Determines if a device path is single or multi-instance.

+

+  This function returns TRUE if the device path specified by DevicePath is multi-instance.

+  Otherwise, FALSE is returned.  If DevicePath is NULL, then FALSE is returned.

+

+  @param  DevicePath                 A pointer to a device path data structure.

+

+  @retval  TRUE                      DevicePath is multi-instance.

+  @retval  FALSE                     DevicePath is not multi-instance or DevicePath is NULL.

+

+**/

+BOOLEAN

+EFIAPI

+IsDevicePathMultiInstance (

+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath

+  )

+{

+  return mDevicePathUtilities->IsDevicePathMultiInstance (DevicePath);

+}

+

+/**

+  Retrieves the device path protocol from a handle.

+

+  This function returns the device path protocol from the handle specified by Handle.  If Handle is

+  NULL or Handle does not contain a device path protocol, then NULL is returned.

+ 

+  @param  Handle                     The handle from which to retrieve the device path protocol.

+

+  @return The device path protocol from the handle specified by Handle.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+DevicePathFromHandle (

+  IN EFI_HANDLE                      Handle

+  )

+{

+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;

+  EFI_STATUS                Status;

+

+  Status = gBS->HandleProtocol (

+                  Handle,

+                  &gEfiDevicePathProtocolGuid,

+                  (VOID *) &DevicePath

+                  );

+  if (EFI_ERROR (Status)) {

+    DevicePath = NULL;

+  }

+  return DevicePath;

+}

+

+/**

+  Allocates a device path for a file and appends it to an existing device path.

+

+  If Device is a valid device handle that contains a device path protocol, then a device path for

+  the file specified by FileName  is allocated and appended to the device path associated with the

+  handle Device.  The allocated device path is returned.  If Device is NULL or Device is a handle

+  that does not support the device path protocol, then a device path containing a single device

+  path node for the file specified by FileName is allocated and returned.

+  If FileName is NULL, then ASSERT().

+

+  @param  Device                     A pointer to a device handle.  This parameter is optional and

+                                     may be NULL.

+  @param  FileName                   A pointer to a Null-terminated Unicode string.

+

+  @return The allocated device path.

+

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+EFIAPI

+FileDevicePath (

+  IN EFI_HANDLE                      Device,     OPTIONAL

+  IN CONST CHAR16                    *FileName

+  )

+{

+  UINTN                     Size;

+  FILEPATH_DEVICE_PATH      *FilePath;

+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;

+  EFI_DEVICE_PATH_PROTOCOL  *FileDevicePath;

+

+  DevicePath = NULL;

+

+  Size = StrSize (FileName);

+  FileDevicePath = AllocatePool (Size + SIZE_OF_FILEPATH_DEVICE_PATH + EFI_END_DEVICE_PATH_LENGTH);

+  if (FileDevicePath != NULL) {

+    FilePath = (FILEPATH_DEVICE_PATH *) FileDevicePath;

+    FilePath->Header.Type    = MEDIA_DEVICE_PATH;

+    FilePath->Header.SubType = MEDIA_FILEPATH_DP;

+    CopyMem (&FilePath->PathName, FileName, Size);

+    SetDevicePathNodeLength (&FilePath->Header, Size + SIZE_OF_FILEPATH_DEVICE_PATH);

+    SetDevicePathEndNode (NextDevicePathNode (&FilePath->Header));

+

+    if (Device != NULL) {

+      DevicePath = DevicePathFromHandle (Device);

+    }

+

+    DevicePath = AppendDevicePath (DevicePath, FileDevicePath);

+    FreePool (FileDevicePath);

+  }

+

+  return DevicePath;

+}

+

diff --git a/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.inf b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.inf
new file mode 100644
index 0000000000..39da015378
--- /dev/null
+++ b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.inf
@@ -0,0 +1,98 @@
+#/** @file

+# Component description file for Uefi Device Path Library via protocol

+#

+# Device Path Library that layers on top of the UEFI 2.0 Device Path Protocol.

+#  This library is not available for EFI 1.10 modules.

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

+#

+#

+#**/

+

+################################################################################

+#

+# Defines Section - statements that will be processed to create a Makefile.

+#

+################################################################################

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = UefiDevicePathLibDevicePathProtocol

+  FILE_GUID                      = 050EB8C6-C12E-4b86-892B-40985E8B3137

+  MODULE_TYPE                    = UEFI_DRIVER

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = DevicePathLib|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER 

+  EDK_RELEASE_VERSION            = 0x00020000

+  EFI_SPECIFICATION_VERSION      = 0x00020000

+

+  CONSTRUCTOR                    = DevicePathLibConstructor

+

+#

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

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+################################################################################

+#

+# Sources Section - list of files that are required for the build to succeed.

+#

+################################################################################

+

+[Sources.common]

+  UefiDevicePathLib.c

+  CommonHeader.h

+

+

+################################################################################

+#

+# Includes Section - list of Include locations that are required for

+#                    this module.

+#

+################################################################################

+

+[Includes]

+  $(WORKSPACE)/MdePkg\Include/Library

+

+################################################################################

+#

+# Package Dependency Section - list of Package files that are required for

+#                              this module.

+#

+################################################################################

+

+[Packages]

+  MdePkg/MdePkg.dec

+

+

+################################################################################

+#

+# Library Class Section - list of Library Classes that are required for

+#                         this module.

+#

+################################################################################

+

+[LibraryClasses]

+  UefiBootServicesTableLib

+  BaseMemoryLib

+  MemoryAllocationLib

+  BaseLib

+  DebugLib

+

+

+################################################################################

+#

+# Protocol C Name Section - list of Protocol and Protocol Notify C Names

+#                           that this module uses or produces.

+#

+################################################################################

+

+[Protocols]

+  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED

+  gEfiDevicePathUtilitiesProtocolGuid           # PROTOCOL ALWAYS_CONSUMED

+

diff --git a/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.msa b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.msa
new file mode 100644
index 0000000000..6a095e46fd
--- /dev/null
+++ b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.msa
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

+  <MsaHeader>

+    <ModuleName>UefiDevicePathLibDevicePathProtocol</ModuleName>

+    <ModuleType>UEFI_DRIVER</ModuleType>

+    <GuidValue>050EB8C6-C12E-4b86-892B-40985E8B3137</GuidValue>

+    <Version>1.0</Version>

+    <Abstract>Component description file for Uefi Device Path Library via protocol</Abstract>

+    <Description>Device Path Library that layers on top of the UEFI 2.0 Device Path Protocol.
+      This library is not available for EFI 1.10 modules.</Description>

+    <Copyright>Copyright (c) 2006 - 2007, Intel Corporation</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>UefiDevicePathLibDevicePathProtocol</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">

+      <Keyword>DevicePathLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>MemoryAllocationLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseMemoryLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>UefiBootServicesTableLib</Keyword>

+    </LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>UefiDevicePathLib.c</Filename>

+  </SourceFiles>

+  <PackageDependencies>

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

+  </PackageDependencies>

+  <Protocols>

+    <Protocol Usage="ALWAYS_CONSUMED">

+      <ProtocolCName>gEfiDevicePathUtilitiesProtocolGuid</ProtocolCName>

+    </Protocol>

+    <Protocol Usage="ALWAYS_CONSUMED">

+      <ProtocolCName>gEfiDevicePathProtocolGuid</ProtocolCName>

+    </Protocol>

+  </Protocols>

+  <Externs>

+    <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>

+    <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>

+    <Extern>

+      <Constructor>DevicePathLibConstructor</Constructor>

+    </Extern>

+  </Externs>

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