Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Ppi / Reset.h

/** @file\r
  This file declares Reset PPI used to reset the platform.\r
  \r
  This PPI is installed by some platform- or chipset-specific PEIM that \r
  abstracts the Reset Service to other agents.\r
\r
  Copyright (c) 2006 - 2008, 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
  @par Revision Reference:\r
  This PPI is defined in PI.\r
  Version 1.0.\r
\r
**/\r
\r
#ifndef __RESET_PPI_H__\r
#define __RESET_PPI_H__\r
\r
#include <Pi/PiPeiCis.h>\r
\r
#define EFI_PEI_RESET_PPI_GUID \\r
  { \\r
    0xef398d58, 0x9dfd, 0x4103, {0xbf, 0x94, 0x78, 0xc6, 0xf4, 0xfe, 0x71, 0x2f } \\r
  }\r
\r
//\r
// EFI_PEI_RESET_PPI.ResetSystem() is equivalent to the\r
// PEI Service ResetSystem().\r
// It is defined in PiPeiCis.h. \r
//\r
\r
///\r
/// This PPI provides provide a simple reset service. \r
///\r
typedef struct {\r
  EFI_PEI_RESET_SYSTEM  ResetSystem;\r
} EFI_PEI_RESET_PPI;\r
\r
extern EFI_GUID gEfiPeiResetPpiGuid;\r
\r
#endif\r