ArmPkg: Move IS_DEVICE_PATH_NODE for sharing

[mirror_edk2.git] / ArmPkg / Include / Library / BdsLib.h

/** @file\r
*\r
*  Copyright (c) 2013-2015, ARM Limited. All rights reserved.\r
*\r
*  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
**/\r
\r
#ifndef __BDS_ENTRY_H__\r
#define __BDS_ENTRY_H__\r
\r
#define IS_DEVICE_PATH_NODE(node,type,subtype)    \\r
        (((node)->Type == (type)) && ((node)->SubType == (subtype)))\r
\r
/**\r
  This is defined by the UEFI specs, don't change it\r
**/\r
typedef struct {\r
  UINT16                      LoadOptionIndex;\r
  EFI_LOAD_OPTION             *LoadOption;\r
  UINTN                       LoadOptionSize;\r
\r
  UINT32                      Attributes;\r
  UINT16                      FilePathListLength;\r
  CHAR16                      *Description;\r
  EFI_DEVICE_PATH_PROTOCOL    *FilePathList;\r
\r
  VOID*                       OptionalData;\r
  UINTN                       OptionalDataSize;\r
} BDS_LOAD_OPTION;\r
\r
/**\r
  Connect a Device Path and return the handle of the driver that support this DevicePath\r
\r
  @param  DevicePath            Device Path of the File to connect\r
  @param  Handle                Handle of the driver that support this DevicePath\r
  @param  RemainingDevicePath   Remaining DevicePath nodes that do not match the driver DevicePath\r
\r
  @retval EFI_SUCCESS           A driver that matches the Device Path has been found\r
  @retval EFI_NOT_FOUND         No handles match the search.\r
  @retval EFI_INVALID_PARAMETER DevicePath or Handle is NULL\r
\r
**/\r
EFI_STATUS\r
BdsConnectDevicePath (\r
  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
  OUT EFI_HANDLE                *Handle,\r
  OUT EFI_DEVICE_PATH_PROTOCOL  **RemainingDevicePath\r
  );\r
\r
/**\r
  Connect all DXE drivers\r
\r
  @retval EFI_SUCCESS           All drivers have been connected\r
  @retval EFI_NOT_FOUND         No handles match the search.\r
  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.\r
\r
**/\r
EFI_STATUS\r
BdsConnectAllDrivers (\r
  VOID\r
  );\r
\r
/**\r
  Return the value of a global variable defined by its VariableName.\r
  The variable must be defined with the VendorGuid gEfiGlobalVariableGuid.\r
\r
  @param  VariableName          A Null-terminated string that is the name of the vendor's\r
                                variable.\r
  @param  DefaultValue          Value returned by the function if the variable does not exist\r
  @param  DataSize              On input, the size in bytes of the return Data buffer.\r
                                On output the size of data returned in Data.\r
  @param  Value                 Value read from the UEFI Variable or copy of the default value\r
                                if the UEFI Variable does not exist\r
\r
  @retval EFI_SUCCESS           All drivers have been connected\r
  @retval EFI_NOT_FOUND         No handles match the search.\r
  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.\r
\r
**/\r
EFI_STATUS\r
GetGlobalEnvironmentVariable (\r
  IN     CONST CHAR16*   VariableName,\r
  IN     VOID*           DefaultValue,\r
  IN OUT UINTN*          Size,\r
  OUT    VOID**          Value\r
  );\r
\r
/**\r
  Return the value of the variable defined by its VariableName and VendorGuid\r
\r
  @param  VariableName          A Null-terminated string that is the name of the vendor's\r
                                variable.\r
  @param  VendorGuid            A unique identifier for the vendor.\r
  @param  DefaultValue          Value returned by the function if the variable does not exist\r
  @param  DataSize              On input, the size in bytes of the return Data buffer.\r
                                On output the size of data returned in Data.\r
  @param  Value                 Value read from the UEFI Variable or copy of the default value\r
                                if the UEFI Variable does not exist\r
\r
  @retval EFI_SUCCESS           All drivers have been connected\r
  @retval EFI_NOT_FOUND         No handles match the search.\r
  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.\r
\r
**/\r
EFI_STATUS\r
GetEnvironmentVariable (\r
  IN     CONST CHAR16*   VariableName,\r
  IN     EFI_GUID*       VendorGuid,\r
  IN     VOID*           DefaultValue,\r
  IN OUT UINTN*          Size,\r
  OUT    VOID**          Value\r
  );\r
\r
EFI_STATUS\r
BootOptionFromLoadOptionIndex (\r
  IN  UINT16            LoadOptionIndex,\r
  OUT BDS_LOAD_OPTION** BdsLoadOption\r
  );\r
\r
EFI_STATUS\r
BootOptionFromLoadOptionVariable (\r
  IN  CHAR16*           BootVariableName,\r
  OUT BDS_LOAD_OPTION** BdsLoadOption\r
  );\r
\r
EFI_STATUS\r
BootOptionToLoadOptionVariable (\r
  IN BDS_LOAD_OPTION*   BdsLoadOption\r
  );\r
\r
UINT16\r
BootOptionAllocateBootIndex (\r
  VOID\r
  );\r
\r
/**\r
  Start an EFI Application from a Device Path\r
\r
  @param  ParentImageHandle     Handle of the calling image\r
  @param  DevicePath            Location of the EFI Application\r
\r
  @retval EFI_SUCCESS           All drivers have been connected\r
  @retval EFI_NOT_FOUND         The Linux kernel Device Path has not been found\r
  @retval EFI_OUT_OF_RESOURCES  There is not enough resource memory to store the matching results.\r
\r
**/\r
EFI_STATUS\r
BdsStartEfiApplication (\r
  IN EFI_HANDLE                  ParentImageHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *DevicePath,\r
  IN UINTN                       LoadOptionsSize,\r
  IN VOID*                       LoadOptions\r
  );\r
\r
EFI_STATUS\r
BdsLoadImage (\r
  IN     EFI_DEVICE_PATH       *DevicePath,\r
  IN     EFI_ALLOCATE_TYPE     Type,\r
  IN OUT EFI_PHYSICAL_ADDRESS* Image,\r
  OUT    UINTN                 *FileSize\r
  );\r
\r
/**\r
 * Call BS.ExitBootServices with the appropriate Memory Map information\r
 */\r
EFI_STATUS\r
ShutdownUefiBootServices (\r
  VOID\r
  );\r
\r
/**\r
  Locate an EFI application in a the Firmware Volumes by its name\r
\r
  @param  EfiAppGuid            Guid of the EFI Application into the Firmware Volume\r
  @param  DevicePath            EFI Device Path of the EFI application\r
\r
  @return EFI_SUCCESS           The function completed successfully.\r
  @return EFI_NOT_FOUND         The protocol could not be located.\r
  @return EFI_OUT_OF_RESOURCES  There are not enough resources to find the protocol.\r
\r
**/\r
EFI_STATUS\r
LocateEfiApplicationInFvByName (\r
  IN  CONST CHAR16*             EfiAppName,\r
  OUT EFI_DEVICE_PATH           **DevicePath\r
  );\r
\r
/**\r
  Locate an EFI application in a the Firmware Volumes by its GUID\r
\r
  @param  EfiAppGuid            Guid of the EFI Application into the Firmware Volume\r
  @param  DevicePath            EFI Device Path of the EFI application\r
\r
  @return EFI_SUCCESS           The function completed successfully.\r
  @return EFI_NOT_FOUND         The protocol could not be located.\r
  @return EFI_OUT_OF_RESOURCES  There are not enough resources to find the protocol.\r
\r
**/\r
EFI_STATUS\r
LocateEfiApplicationInFvByGuid (\r
  IN  CONST EFI_GUID            *EfiAppGuid,\r
  OUT EFI_DEVICE_PATH           **DevicePath\r
  );\r
\r
#endif\r