Add in Abstract and Description for a few MSA files.

[mirror_edk2.git] / EdkNt32Pkg / Pei / BootMode / BootMode.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
  BootMode.c\r
   \r
Abstract:\r
\r
  Tiano PEIM to provide the platform support functionality within Windows\r
\r
--*/\r
\r
\r
\r
//\r
// Module globals\r
//\r
EFI_PEI_PPI_DESCRIPTOR  mPpiListBootMode = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiMasterBootModePpiGuid,\r
  NULL\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR  mPpiListRecoveryBootMode = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiBootInRecoveryModePpiGuid,\r
  NULL\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
InitializeBootMode (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Peform the boot mode determination logic\r
\r
Arguments:\r
\r
  PeiServices - General purpose services available to every PEIM.\r
    \r
Returns:\r
\r
  Status -  EFI_SUCCESS if the boot mode could be set\r
\r
--*/\r
// TODO:    FfsHeader - add argument and description to function comment\r
{\r
  EFI_STATUS  Status;\r
  UINTN       BootMode;\r
\r
  DEBUG ((EFI_D_ERROR, "NT32 Boot Mode PEIM Loaded\n"));\r
\r
  //\r
  // Let's assume things are OK if not told otherwise\r
  // Should we read an environment variable in order to easily change this?\r
  //\r
  BootMode  = BOOT_WITH_FULL_CONFIGURATION;\r
\r
  Status    = (**PeiServices).SetBootMode (PeiServices, (UINT8) BootMode);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = (**PeiServices).InstallPpi (PeiServices, &mPpiListBootMode);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
    Status = (**PeiServices).InstallPpi (PeiServices, &mPpiListRecoveryBootMode);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  return Status;\r
}\r