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 #include <Pi/PiStatusCode.h>
  14
  15 ///
  16 /// The Global ID used to identify a structure of type EFI_DEBUG_INFO.
  17 ///
  18 #define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \
  19   { \
  20     0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9 } \
  21   }
  22
  23 ///
  24 /// The maximum size of an EFI_DEBUG_INFO structure.
  25 ///
  26 #define EFI_STATUS_CODE_DATA_MAX_SIZE  0x200
  27
  28 ///
  29 /// Define the maximum extended data size that is supported when a
  30 /// status code is reported.
  31 ///
  32 #define MAX_EXTENDED_DATA_SIZE  (EFI_STATUS_CODE_DATA_MAX_SIZE + sizeof(EFI_STATUS_CODE_DATA))
  33
  34 ///
  35 /// This structure contains the ErrorLevel passed into the DEBUG() macro, followed
  36 /// by a 96-byte buffer that contains the variable argument list passed to the
  37 /// DEBUG() macro that has been converted to a BASE_LIST.  The 96-byte buffer is
  38 /// followed by a Null-terminated ASCII string that is the Format string passed
  39 /// to the DEBUG() macro.  The maximum size of this structure is defined by
  40 /// EFI_STATUS_CODE_DATA_MAX_SIZE.
  41 ///
  42 typedef struct {
  43   ///
  44   /// The debug error level passed into a DEBUG() macro.
  45   ///
  46   UINT32    ErrorLevel;
  47 } EFI_DEBUG_INFO;
  48
  49 extern EFI_GUID  gEfiStatusCodeDataTypeDebugGuid;
  50
  51 #endif // _STATUS_CODE_DATA_TYPE_DEBUG_H_