IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h

   1 /** @file
   2   GUID used to identify status code records HOB that originate from the PEI status code
   3
   4 Copyright (c) 2006 - 2009, Intel Corporation
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __MEMORY_STATUS_CODE_RECORD_H__
  16 #define __MEMORY_STATUS_CODE_RECORD_H__
  17
  18 #define MEMORY_STATUS_CODE_RECORD_GUID \
  19   { \
  20     0x60cc026, 0x4c0d, 0x4dda, {0x8f, 0x41, 0x59, 0x5f, 0xef, 0x0, 0xa5, 0x2} \
  21   }
  22
  23 /**
  24   Memory status code records packet structure :
  25   +---------------+----------+----------+-----+----------+-----+----------+
  26   | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |
  27   +---------------+----------+----------+-----+----------+-----+----------+
  28                   ^                                 ^                     ^
  29                   +--------- RecordIndex -----------+                     |
  30                   +---------------- MaxRecordsNumber----------------------+
  31 **/
  32 typedef struct {
  33   UINT16                  PacketIndex;          ///< Index of the Packet.
  34   UINT16                  RecordIndex;          ///< Index of record in the packet.
  35   UINT32                  MaxRecordsNumber;     ///< Max number of records in the packet.
  36 } MEMORY_STATUSCODE_PACKET_HEADER;
  37
  38 typedef struct {
  39   ///
  40   /// Status Code type to be reported.
  41   ///
  42   EFI_STATUS_CODE_TYPE  CodeType;
  43
  44   ///
  45   /// Valu information about the class and subclass is used to
  46   /// classify the hardware and software entity as well as an operation.
  47   ///
  48   EFI_STATUS_CODE_VALUE Value;
  49
  50   ///
  51   /// The enumeration of a hardware or software entity within
  52   /// the system. Valid instance numbers start with 1
  53   ///
  54   UINT32                Instance;
  55 } MEMORY_STATUSCODE_RECORD;
  56
  57
  58 extern EFI_GUID gMemoryStatusCodeRecordGuid;
  59
  60 #endif