Removed CommonHeader.h from MdePkg & MdeModulePkg

[mirror_edk2.git] / MdeModulePkg / Universal / DevicePathDxe / DevicePathUtilities.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                     \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  DevicePathUtilities.c\r
\r
Abstract:\r
\r
  Implementation file for Device Path Utilities Protocol\r
\r
--*/\r
\r
#include "DevicePath.h"\r
\r
UINTN\r
GetDevicePathSizeProtocolInterface (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  )\r
/*++\r
\r
  Routine Description:\r
    Returns the size of the device path, in bytes.\r
\r
  Arguments:\r
    DevicePath  -   Points to the start of the EFI device path.\r
\r
  Returns:\r
    Size        -   Size of the specified device path, in bytes, including the end-of-path tag.\r
\r
--*/\r
{\r
  return GetDevicePathSize (DevicePath);\r
}\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
DuplicateDevicePathProtocolInterface (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  )\r
/*++\r
\r
  Routine Description:\r
    Create a duplicate of the specified path.\r
\r
  Arguments:\r
    DevicePath  -   Points to the source EFI device path.\r
\r
  Returns:\r
    Pointer     -   A pointer to the duplicate device path.\r
    NULL        -   Insufficient memory.\r
\r
--*/\r
{\r
  return DuplicateDevicePath (DevicePath);\r
}\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
AppendDevicePathProtocolInterface (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2\r
  )\r
/*++\r
\r
  Routine Description:\r
    Create a new path by appending the second device path to the first.\r
\r
  Arguments:\r
    Src1      -   Points to the first device path. If NULL, then it is ignored.\r
    Src2      -   Points to the second device path. If NULL, then it is ignored.\r
\r
  Returns:\r
    Pointer   -   A pointer to the newly created device path.\r
    NULL      -   Memory could not be allocated\r
                  or either DevicePath or DeviceNode is NULL.\r
\r
--*/\r
{\r
  return AppendDevicePath (Src1, Src2);\r
}\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
AppendDeviceNodeProtocolInterface (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode\r
  )\r
/*++\r
\r
  Routine Description:\r
    Creates a new path by appending the device node to the device path.\r
\r
  Arguments:\r
    DevicePath   -   Points to the device path.\r
    DeviceNode   -   Points to the device node.\r
\r
  Returns:\r
    Pointer      -   A pointer to the allocated device node.\r
    NULL         -   Memory could not be allocated\r
                     or either DevicePath or DeviceNode is NULL.\r
\r
--*/\r
{\r
  return AppendDevicePathNode (DevicePath, DeviceNode);\r
}\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
AppendDevicePathInstanceProtocolInterface (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance\r
  )\r
/*++\r
\r
  Routine Description:\r
    Creates a new path by appending the specified device path instance to the specified device path.\r
\r
  Arguments:\r
    DevicePath           -   Points to the device path. If NULL, then ignored.\r
    DevicePathInstance   -   Points to the device path instance.\r
\r
  Returns:\r
    Pointer              -   A pointer to the newly created device path\r
    NULL                 -   Memory could not be allocated or DevicePathInstance is NULL.\r
\r
--*/\r
{\r
  return AppendDevicePathInstance (DevicePath, DevicePathInstance);\r
}\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
GetNextDevicePathInstanceProtocolInterface (\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL   **DevicePathInstance,\r
  OUT UINTN                         *DevicePathInstanceSize\r
  )\r
/*++\r
\r
  Routine Description:\r
    Creates a copy of the current device path instance and returns a pointer to the next device path instance.\r
\r
  Arguments:\r
    DevicePathInstance       -   On input, this holds the pointer to the current device path\r
                                 instance. On output, this holds the pointer to the next\r
                                 device path instance or NULL if there are no more device\r
                                 path instances in the device path.\r
    DevicePathInstanceSize   -   On output, this holds the size of the device path instance,\r
                                 in bytes or zero, if DevicePathInstance is zero.\r
\r
  Returns:\r
    Pointer                  -   A pointer to the copy of the current device path instance.\r
    NULL                     -   DevicePathInstace was NULL on entry or there was insufficient memory.\r
\r
--*/\r
{\r
  return GetNextDevicePathInstance (DevicePathInstance, DevicePathInstanceSize);\r
}\r
\r
BOOLEAN\r
IsDevicePathMultiInstanceProtocolInterface (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
  )\r
/*++\r
\r
  Routine Description:\r
    Returns whether a device path is multi-instance.\r
\r
  Arguments:\r
    DevicePath  -   Points to the device path. If NULL, then ignored.\r
\r
  Returns:\r
    TRUE        -   The device path has more than one instance\r
    FALSE       -   The device path is empty or contains only a single instance.\r
\r
--*/\r
{\r
  return IsDevicePathMultiInstance (DevicePath);\r
}\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
CreateDeviceNodeProtocolInterface (\r
  IN UINT8  NodeType,\r
  IN UINT8  NodeSubType,\r
  IN UINT16 NodeLength\r
  )\r
/*++\r
\r
  Routine Description:\r
    Creates a device node\r
\r
  Arguments:\r
    NodeType     -    NodeType is the device node type (EFI_DEVICE_PATH.Type) for\r
                      the new device node.\r
    NodeSubType  -    NodeSubType is the device node sub-type\r
                      EFI_DEVICE_PATH.SubType) for the new device node.\r
    NodeLength   -    NodeLength is the length of the device node\r
                      (EFI_DEVICE_PATH.Length) for the new device node.\r
\r
  Returns:\r
    Pointer      -    A pointer to the newly created device node.\r
    NULL         -    NodeLength is less than\r
                      the size of the header or there was insufficient memory.\r
\r
--*/\r
{\r
  return CreateDeviceNode (NodeType, NodeSubType, NodeLength);\r
}\r