OvmfPkg: get boot order from QEMU

[mirror_edk2.git] / OvmfPkg / Library / PlatformBdsLib / QemuBootOrder.h

/** @file\r
  Rewrite the BootOrder NvVar based on QEMU's "bootorder" fw_cfg file --\r
  include file.\r
\r
  Copyright (C) 2012, Red Hat, Inc.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  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, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
\r
#include <Uefi/UefiBaseType.h>\r
#include <Base.h>\r
\r
\r
/**\r
\r
  Set the boot order based on configuration retrieved from QEMU.\r
\r
  Attempt to retrieve the "bootorder" fw_cfg file from QEMU. Translate the\r
  OpenFirmware device paths therein to UEFI device path fragments. Match the\r
  translated fragments against BootOptionList, and rewrite the BootOrder NvVar\r
  so that it corresponds to the order described in fw_cfg.\r
\r
  @param[in] BootOptionList  A boot option list, created with\r
                             BdsLibEnumerateAllBootOption ().\r
\r
\r
  @retval RETURN_SUCCESS            BootOrder NvVar rewritten.\r
\r
  @retval RETURN_UNSUPPORTED        QEMU's fw_cfg is not supported.\r
\r
  @retval RETURN_NOT_FOUND          Empty or nonexistent "bootorder" fw_cfg\r
                                    file, or no match found between the\r
                                    "bootorder" fw_cfg file and BootOptionList.\r
\r
  @retval RETURN_INVALID_PARAMETER  Parse error in the "bootorder" fw_cfg file.\r
\r
  @retval RETURN_OUT_OF_RESOURCES   Memory allocation failed.\r
\r
  @return                           Values returned by gBS->LocateProtocol ()\r
                                    or gRT->SetVariable ().\r
\r
**/\r
RETURN_STATUS\r
SetBootOrderFromQemu (\r
  IN  CONST LIST_ENTRY *BootOptionList\r
  );\r