MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h

   1 /** @file
   2   This file defines the GUID and data structure used to pass DEBUG() macro
   3   information to the Status Code Protocol and Status Code PPI.
   4
   5 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _STATUS_CODE_DATA_TYPE_DEBUG_H_
  11 #define _STATUS_CODE_DATA_TYPE_DEBUG_H_
  12
  13 ///
  14 /// The Global ID used to identify a structure of type EFI_DEBUG_INFO.
  15 ///
  16 #define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \
  17   { \
  18     0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9 } \
  19   }
  20
  21 ///
  22 /// The maximum size of an EFI_DEBUG_INFO structure.
  23 ///
  24 #define EFI_STATUS_CODE_DATA_MAX_SIZE 200
  25
  26 ///
  27 /// This structure contains the ErrorLevel passed into the DEBUG() macro, followed
  28 /// by a 96-byte buffer that contains the variable argument list passed to the
  29 /// DEBUG() macro that has been converted to a BASE_LIST.  The 96-byte buffer is
  30 /// followed by a Null-terminated ASCII string that is the Format string passed
  31 /// to the DEBUG() macro.  The maximum size of this structure is defined by
  32 /// EFI_STATUS_CODE_DATA_MAX_SIZE.
  33 ///
  34 typedef struct {
  35   ///
  36   /// The debug error level passed into a DEBUG() macro.
  37   ///
  38   UINT32  ErrorLevel;
  39 } EFI_DEBUG_INFO;
  40
  41 extern EFI_GUID gEfiStatusCodeDataTypeDebugGuid;
  42
  43 #endif // _STATUS_CODE_DATA_TYPE_DEBUG_H_