Modify all file header to follow doxygen format

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

/** @file\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
  Reset.c\r
\r
Abstract:\r
\r
  Pei Core Reset System Support\r
\r
Revision History\r
\r
**/\r
\r
#include <PeiMain.h>\r
\r
EFI_STATUS\r
EFIAPI\r
PeiResetSystem (\r
  IN CONST EFI_PEI_SERVICES         **PeiServices\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Core version of the Reset System\r
\r
Arguments:\r
\r
  PeiServices - The PEI core services table.\r
\r
Returns:\r
\r
  Status  - EFI_NOT_AVAILABLE_YET. PPI not available yet.\r
          - EFI_DEVICE_ERROR.   Did not reset system.\r
          \r
  Otherwise, resets the system. \r
\r
--*/\r
{\r
  EFI_STATUS        Status;\r
  EFI_PEI_RESET_PPI *ResetPpi;\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiResetPpiGuid,         \r
             0,                         \r
             NULL,                      \r
             (VOID **)&ResetPpi                  \r
             );\r
\r
  //\r
  // LocatePpi returns EFI_NOT_FOUND on error\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    return ResetPpi->ResetSystem (PeiServices);\r
  } \r
  return  EFI_NOT_AVAILABLE_YET;\r
}\r
\r