EdkModulePkg/Include/Library/EdkRtMemoryStatusCodeLib.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   RtMemoryStatusCodeLib.h
  15
  16 Abstract:
  17
  18   Lib to provide memory status code reporting.
  19
  20 --*/
  21
  22 #ifndef _EFI_RT_MEMORY_STATUS_CODE_LIB_H_
  23 #define _EFI_RT_MEMORY_STATUS_CODE_LIB_H_
  24
  25 //
  26 // Initialization function
  27 //
  28 VOID
  29 RtMemoryStatusCodeInitialize (
  30   VOID
  31   )
  32 ;
  33
  34 //
  35 // Status code reporting function
  36 //
  37 EFI_STATUS
  38 RtMemoryReportStatusCode (
  39   IN EFI_STATUS_CODE_TYPE     CodeType,
  40   IN EFI_STATUS_CODE_VALUE    Value,
  41   IN UINT32                   Instance,
  42   IN EFI_GUID                 * CallerId,
  43   IN EFI_STATUS_CODE_DATA     * Data OPTIONAL
  44   )
  45 ;
  46
  47 //
  48 // Playback all prior status codes to a listener
  49 //
  50 typedef
  51 EFI_STATUS
  52 (*PLATFORM_REPORT_STATUS_CODE) (
  53   IN EFI_STATUS_CODE_TYPE     Type,
  54   IN EFI_STATUS_CODE_VALUE    Value,
  55   IN UINT32                   Instance,
  56   IN EFI_GUID                 * CallerId OPTIONAL,
  57   IN EFI_STATUS_CODE_DATA     * Data OPTIONAL
  58   );
  59
  60 VOID
  61 PlaybackStatusCodes (
  62   IN PLATFORM_REPORT_STATUS_CODE  ReportStatusCode
  63   )
  64 ;
  65
  66 #endif