Tools/Source/TianoTools/Include/Protocol/SmmStatusCode.h

   1 /** @file
   2   This file declares SMM Status code Protocol.
   3
   4   This code abstracts SMM Status Code reporting.
   5
   6   Copyright (c) 2006, 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   Module Name:  SmmStatusCode.h
  16
  17   @par Revision Reference:
  18   This Protocol is defined in Framework of EFI SMM Core Interface Spec
  19   Version 0.9.
  20
  21 **/
  22
  23 #ifndef _PROTOCOL_SMM_STATUS_CODE_H__
  24 #define _PROTOCOL_SMM_STATUS_CODE_H__
  25
  26 //
  27 // Global ID for the Smm Status Code Protocol
  28 //
  29 #define EFI_SMM_STATUS_CODE_PROTOCOL_GUID \
  30   { \
  31     0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1 } \
  32   }
  33
  34 typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL  EFI_SMM_STATUS_CODE_PROTOCOL;
  35
  36 /**
  37   Service to emit the status code in SMM.
  38
  39   @param  This Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.
  40
  41   @param  CodeType Indicates the type of status code being reported.
  42
  43   @param  Value Describes the current status of a hardware or software entity.
  44   This included information about the class and subclass that is used to
  45   classify the entity as well as an operation.
  46
  47   @param  Instance The enumeration of a hardware or software entity within
  48   the system. Valid instance numbers start with 1.
  49
  50   @param  CallerId This optional parameter may be used to identify the caller.
  51   This parameter allows the status code driver to apply different rules to
  52   different callers.
  53
  54   @param  Data This optional parameter may be used to pass additional data.
  55
  56   @retval EFI_SUCCESS The function completed successfully
  57
  58   @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
  59
  60 **/
  61 typedef
  62 EFI_STATUS
  63 (EFIAPI *EFI_SMM_REPORT_STATUS_CODE) (
  64   IN EFI_SMM_STATUS_CODE_PROTOCOL *This,
  65   IN EFI_STATUS_CODE_TYPE         CodeType,
  66   IN EFI_STATUS_CODE_VALUE        Value,
  67   IN UINT32                       Instance,
  68   IN EFI_GUID                     *CallerId,
  69   IN EFI_STATUS_CODE_DATA         *Data OPTIONAL
  70   );
  71
  72 /**
  73   @par Protocol Description:
  74   Provides status code services from SMM.
  75
  76   @param ReportStatusCode
  77   Allows for the SMM agent to produce a status code output.
  78
  79 **/
  80 struct _EFI_SMM_STATUS_CODE_PROTOCOL {
  81   EFI_SMM_REPORT_STATUS_CODE  ReportStatusCode;
  82 };
  83
  84 extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;
  85
  86 #endif