Add function headers & file header for public header files

[mirror_edk2.git] / MdeModulePkg / Include / Guid / PeiPerformanceHob.h

/** @file\r
  GUIDs used for PEI Performance HOB data structures\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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
**/\r
\r
#ifndef __PEI_PERFORMANCE_HOB_H__\r
#define __PEI_PERFORMANCE_HOB_H__\r
\r
//\r
// This is the GUID of PEI performance HOB\r
//\r
#define PEI_PERFORMANCE_HOB_GUID \\r
  { 0xec4df5af, 0x4395, 0x4cc9, { 0x94, 0xde, 0x77, 0x50, 0x6d, 0x12, 0xc7, 0xb8 } }\r
\r
//\r
// PEI_PERFORMANCE_STRING_SIZE must be a multiple of 8.\r
//\r
#define PEI_PERFORMANCE_STRING_SIZE     8\r
#define PEI_PERFORMANCE_STRING_LENGTH   (PEI_PERFORMANCE_STRING_SIZE - 1)\r
\r
typedef struct {\r
  EFI_PHYSICAL_ADDRESS  Handle;\r
  CHAR8                 Token[PEI_PERFORMANCE_STRING_SIZE];\r
  CHAR8                 Module[PEI_PERFORMANCE_STRING_SIZE];\r
  UINT64                StartTimeStamp;\r
  UINT64                EndTimeStamp;\r
} PEI_PERFORMANCE_LOG_ENTRY;\r
\r
//\r
// The header must be aligned at 8 bytes.\r
// \r
typedef struct {\r
  UINT32                             NumberOfEntries;\r
  UINT32                             Reserved;\r
} PEI_PERFORMANCE_LOG_HEADER;\r
\r
\r
extern EFI_GUID gPeiPerformanceHobGuid;\r
\r
#endif\r