Add PcdDxe and PcdPEIM to all-arch for EdkModulePkg-All-Archs.fpd

[mirror_edk2.git] / MdePkg / Include / Library / DevicePathLib.h

/** @file\r
  Entry point to a DXE Boot Services Driver\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:  DevicePathLib.h\r
\r
**/\r
\r
#ifndef __DEVICE_PATH_LIB_H__\r
#define __DEVICE_PATH_LIB_H__\r
\r
/**\r
  This function returns the size, in bytes, \r
  of the device path data structure specified by DevicePath.\r
  If DevicePath is NULL, then 0 is returned.\r
\r
  @param  DevicePath A pointer to a device path data structure.\r
\r
  @return The size of a device path in bytes.\r
\r
**/\r
UINTN\r
EFIAPI\r
GetDevicePathSize (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  )\r
;\r
\r
/**\r
  This function allocates space for a new copy of the device path\r
  specified by DevicePath.\r
\r
  @param  DevicePath A pointer to a device path data structure.\r
\r
  @return The duplicated device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
DuplicateDevicePath (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL   *DevicePath\r
  )\r
;\r
\r
/**\r
  This function appends the device path SecondDevicePath\r
  to every device path instance in FirstDevicePath. \r
\r
  @param  FirstDevicePath A pointer to a device path data structure.\r
  \r
  @param  SecondDevicePath A pointer to a device path data structure.\r
\r
  @return\r
  A pointer to the new device path is returned.\r
  NULL is returned if space for the new device path could not be allocated from pool.\r
  It is up to the caller to free the memory used by FirstDevicePath and SecondDevicePath\r
  if they are no longer needed.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
AppendDevicePath (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *FirstDevicePath,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *SecondDevicePath\r
  )\r
;\r
\r
/**\r
  This function appends the device path node SecondDevicePath\r
  to every device path instance in FirstDevicePath.\r
\r
  @param  DevicePath A pointer to a device path data structure.\r
  \r
  @param  DevicePathNode A pointer to a single device path node.\r
\r
  @return A pointer to the new device path.\r
  If there is not enough temporary pool memory available to complete this function,\r
  then NULL is returned.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
AppendDevicePathNode (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathNode\r
  )\r
;\r
\r
/**\r
  This function appends the device path instance Instance to the device path Source.\r
  If Source is NULL, then a new device path with one instance is created.  \r
\r
  @param  Source A pointer to a device path data structure.\r
  @param  Instance A pointer to a device path instance.\r
\r
  @return\r
  A pointer to the new device path.\r
  If there is not enough temporary pool memory available to complete this function,\r
  then NULL is returned.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
AppendDevicePathInstance (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *Source,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *Instance\r
  )\r
;\r
\r
/**\r
  Function retrieves the next device path instance from a device path data structure.\r
\r
  @param  DevicePath A pointer to a device path data structure.\r
  \r
  @param  Size A pointer to the size of a device path instance in bytes.\r
\r
  @return\r
  This function returns a pointer to the current device path instance.\r
  In addition, it returns the size in bytes of the current device path instance in Size,\r
  and a pointer to the next device path instance in DevicePath.\r
  If there are no more device path instances in DevicePath, then DevicePath will be set to NULL.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
GetNextDevicePathInstance (\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePath,\r
     OUT UINTN                     *Size\r
  )\r
;\r
\r
/**\r
  Return TRUE is this is a multi instance device path.\r
\r
  @param  DevicePath A pointer to a device path data structure.\r
\r
  @retval  TRUE If DevicePath is multi-instance.\r
  @retval  FALSE If DevicePath is not multi-instance or DevicePath is NULL.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsDevicePathMultiInstance (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  )\r
;\r
\r
/**\r
  This function retrieves the device path protocol from a handle.\r
\r
  @param  Handle The handle from which to retrieve the device path protocol.\r
\r
  @return\r
  This function returns the device path protocol from the handle specified by Handle.\r
  If Handle is NULL or Handle does not contain a device path protocol, then NULL is returned.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
DevicePathFromHandle (\r
  IN EFI_HANDLE  Handle\r
  )\r
;\r
\r
/**\r
  This function allocates a device path for a file and appends it to an existing device path.\r
\r
  @param  Device A pointer to a device handle.  This parameter is optional and may be NULL.\r
  @param  FileName A pointer to a Null-terminated Unicode string.\r
\r
  @return\r
  If Device is a valid device handle that contains a device path protocol,\r
  then a device path for the file specified by FileName is allocated\r
  and appended to the device path associated with the handle Device. The allocated device path is returned.\r
  If Device is NULL or Device is a handle that does not support the device path protocol,\r
  then a device path containing a single device path node for the file specified by FileName\r
  is allocated and returned.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
FileDevicePath (\r
  IN EFI_HANDLE    Device,     OPTIONAL\r
  IN CONST CHAR16  *FileName\r
  )\r
;\r
\r
#endif\r