MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Core / Pei / BootMode / BootMode.c

/** @file\r
  This module provide function for ascertaining and updating the boot mode:\r
  GetBootMode()\r
  SetBootMode()\r
  See PI Specification volume I, chapter 9 Boot Paths for additional information\r
  on the boot mode.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PeiMain.h"\r
\r
/**\r
  This service enables PEIMs to ascertain the present value of the boot mode.\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param BootMode               A pointer to contain the value of the boot mode.\r
\r
  @retval EFI_SUCCESS           The boot mode was returned successfully.\r
  @retval EFI_INVALID_PARAMETER BootMode is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetBootMode (\r
  IN  CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN  OUT   EFI_BOOT_MODE     *BootMode\r
  )\r
{\r
  PEI_CORE_INSTANCE             *PrivateData;\r
  EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;\r
\r
\r
  if (BootMode == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS(PeiServices);\r
\r
  HandOffHob  = (PrivateData->HobList.HandoffInformationTable);\r
\r
  *BootMode   = HandOffHob->BootMode;\r
\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  This service enables PEIMs to update the boot mode variable.\r
\r
\r
  @param PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param BootMode         The value of the boot mode to set.\r
\r
  @return EFI_SUCCESS     The value was successfully updated\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiSetBootMode (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN EFI_BOOT_MODE           BootMode\r
  )\r
{\r
  PEI_CORE_INSTANCE                    *PrivateData;\r
  EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;\r
\r
\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS(PeiServices);\r
\r
  HandOffHob  = (PrivateData->HobList.HandoffInformationTable);\r
\r
  HandOffHob->BootMode = BootMode;\r
\r
\r
  return EFI_SUCCESS;\r
}\r