MdePkg/Include/Protocol/SmmStatusCode.h

   1 /** @file
   2   EFI SMM Status Code Protocol as defined in the PI 1.2 specification.
   3
   4   This protocol provides the basic status code services while in SMM.
   5
   6   Copyright (c) 2009, Intel Corporation
   7   All rights reserved. This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef _SMM_STATUS_CODE_H__
  18 #define _SMM_STATUS_CODE_H__
  19
  20 #include <Uefi/UefiBaseType.h>
  21 #include <Pi/PiMultiPhase.h>
  22
  23 #define EFI_SMM_STATUS_CODE_PROTOCOL_GUID \
  24   { \
  25     0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1} \
  26   }
  27
  28 typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL  EFI_SMM_STATUS_CODE_PROTOCOL;
  29
  30 /**
  31   Service to emit the status code in SMM.
  32
  33   The EFI_SMM_STATUS_CODE_PROTOCOL.ReportStatusCode() function enables a driver
  34   to emit a status code while in SMM.  The reason that there is a separate protocol definition from the
  35   DXE variant of this service is that the publisher of this protocol will provide a service that is
  36   capability of coexisting with a foreground operational environment, such as an operating system
  37   after the termination of boot services.
  38
  39   @param[in] This                Points to this instance of the EFI_SMM_STATUS_CODE_PROTOCOL.
  40   @param[in] CodeType            DIndicates the type of status code being reported.
  41   @param[in] Value               Describes the current status of a hardware or software entity.
  42   @param[in] Instance            The enumeration of a hardware or software entity within the system.
  43   @param[in] CallerId            This optional parameter may be used to identify the caller.
  44   @param[in] Data                This optional parameter may be used to pass additional data.
  45
  46   @retval EFI_SUCCESS            The function completed successfully.
  47   @retval EFI_INVALID_PARAMETER  The function should not be completed due to a device error.
  48 **/
  49 typedef
  50 EFI_STATUS
  51 (EFIAPI *EFI_SMM_REPORT_STATUS_CODE)(
  52   IN CONST EFI_SMM_STATUS_CODE_PROTOCOL  *This,
  53   IN EFI_STATUS_CODE_TYPE                CodeType,
  54   IN EFI_STATUS_CODE_VALUE               Value,
  55   IN UINT32                              Instance,
  56   IN CONST EFI_GUID                      *CallerId,
  57   IN EFI_STATUS_CODE_DATA                *Data OPTIONAL
  58   );
  59
  60 struct _EFI_SMM_STATUS_CODE_PROTOCOL {
  61   EFI_SMM_REPORT_STATUS_CODE  ReportStatusCode;
  62 };
  63
  64 extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;
  65
  66 #endif
  67