MdePkg/Include/Protocol/MmStatusCode.h

   1 /** @file
   2   EFI MM Status Code Protocol as defined in the PI 1.5 specification.
   3
   4   This protocol provides the basic status code services while in MM.
   5
   6   Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef _MM_STATUS_CODE_H__
  12 #define _MM_STATUS_CODE_H__
  13
  14
  15 #define EFI_MM_STATUS_CODE_PROTOCOL_GUID \
  16   { \
  17     0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1} \
  18   }
  19
  20 typedef struct _EFI_MM_STATUS_CODE_PROTOCOL  EFI_MM_STATUS_CODE_PROTOCOL;
  21
  22 /**
  23   Service to emit the status code in MM.
  24
  25   The EFI_MM_STATUS_CODE_PROTOCOL.ReportStatusCode() function enables a driver
  26   to emit a status code while in MM.  The reason that there is a separate protocol definition from the
  27   DXE variant of this service is that the publisher of this protocol will provide a service that is
  28   capability of coexisting with a foreground operational environment, such as an operating system
  29   after the termination of boot services.
  30
  31   @param[in] This                Points to this instance of the EFI_MM_STATUS_CODE_PROTOCOL.
  32   @param[in] CodeType            DIndicates the type of status code being reported.
  33   @param[in] Value               Describes the current status of a hardware or software entity.
  34   @param[in] Instance            The enumeration of a hardware or software entity within the system.
  35   @param[in] CallerId            This optional parameter may be used to identify the caller.
  36   @param[in] Data                This optional parameter may be used to pass additional data.
  37
  38   @retval EFI_SUCCESS            The function completed successfully.
  39   @retval EFI_INVALID_PARAMETER  The function should not be completed due to a device error.
  40 **/
  41 typedef
  42 EFI_STATUS
  43 (EFIAPI *EFI_MM_REPORT_STATUS_CODE)(
  44   IN CONST EFI_MM_STATUS_CODE_PROTOCOL   *This,
  45   IN EFI_STATUS_CODE_TYPE                CodeType,
  46   IN EFI_STATUS_CODE_VALUE               Value,
  47   IN UINT32                              Instance,
  48   IN CONST EFI_GUID                      *CallerId,
  49   IN EFI_STATUS_CODE_DATA                *Data OPTIONAL
  50   );
  51
  52 struct _EFI_MM_STATUS_CODE_PROTOCOL {
  53   EFI_MM_REPORT_STATUS_CODE  ReportStatusCode;
  54 };
  55
  56 extern EFI_GUID gEfiMmStatusCodeProtocolGuid;
  57
  58 #endif
  59