mirror of
				https://git.proxmox.com/git/mirror_edk2
				synced 2025-10-31 22:30:33 +00:00 
			
		
		
		
	 90eaa3c1e0
			
		
	
	
		90eaa3c1e0
		
	
	
	
	
		
			
			Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com> git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13445 6f19259b-4bc3-4df7-8a09-765794883524
		
			
				
	
	
		
			132 lines
		
	
	
		
			4.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			132 lines
		
	
	
		
			4.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
|   Internal include file for Status Code Handler Driver.
 | |
| 
 | |
|   Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
 | |
|   This program and the accompanying materials
 | |
|   are licensed and made available under the terms and conditions of the BSD License
 | |
|   which accompanies this distribution.  The full text of the license may be found at
 | |
|   http://opensource.org/licenses/bsd-license.php
 | |
| 
 | |
|   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 | |
|   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 | |
| 
 | |
| **/
 | |
| 
 | |
| #ifndef __STATUS_CODE_HANDLER_SMM_H__
 | |
| #define __STATUS_CODE_HANDLER_SMM_H__
 | |
| 
 | |
| #include <Protocol/SmmReportStatusCodeHandler.h>
 | |
| 
 | |
| #include <Guid/MemoryStatusCodeRecord.h>
 | |
| #include <Guid/StatusCodeDataTypeId.h>
 | |
| #include <Guid/StatusCodeDataTypeDebug.h>
 | |
| 
 | |
| #include <Library/SynchronizationLib.h>
 | |
| #include <Library/DebugLib.h>
 | |
| #include <Library/ReportStatusCodeLib.h>
 | |
| #include <Library/PrintLib.h>
 | |
| #include <Library/PcdLib.h>
 | |
| #include <Library/UefiDriverEntryPoint.h>
 | |
| #include <Library/SmmServicesTableLib.h>
 | |
| #include <Library/SerialPortLib.h>
 | |
| #include <Library/MemoryAllocationLib.h>
 | |
| #include <Library/BaseMemoryLib.h>
 | |
| 
 | |
| //
 | |
| // Define the maximum message length
 | |
| //
 | |
| #define MAX_DEBUG_MESSAGE_LENGTH 0x100
 | |
| 
 | |
| //
 | |
| // Runtime memory status code worker definition
 | |
| //
 | |
| typedef struct {
 | |
|   UINT32   RecordIndex;
 | |
|   UINT32   NumberOfRecords;
 | |
|   UINT32   MaxRecordsNumber;
 | |
| } RUNTIME_MEMORY_STATUSCODE_HEADER;
 | |
| 
 | |
| extern RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;
 | |
| 
 | |
| /**
 | |
|   Locates Serial I/O Protocol as initialization for serial status code worker.
 | |
|  
 | |
|   @retval EFI_SUCCESS  Serial I/O Protocol is successfully located.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| EfiSerialStatusCodeInitializeWorker (
 | |
|   VOID
 | |
|   );
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
 | |
|  
 | |
|   @param  CodeType         Indicates the type of status code being reported.
 | |
|   @param  Value            Describes the current status of a hardware or software entity.
 | |
|                            This included information about the class and subclass that is used to
 | |
|                            classify the entity as well as an operation.
 | |
|   @param  Instance         The enumeration of a hardware or software entity within
 | |
|                            the system. Valid instance numbers start with 1.
 | |
|   @param  CallerId         This optional parameter may be used to identify the caller.
 | |
|                            This parameter allows the status code driver to apply different rules to
 | |
|                            different callers.
 | |
|   @param  Data             This optional parameter may be used to pass additional data.
 | |
| 
 | |
|   @retval EFI_SUCCESS      Status code reported to serial I/O successfully.
 | |
|   @retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.
 | |
|   @retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| SerialStatusCodeReportWorker (
 | |
|   IN EFI_STATUS_CODE_TYPE     CodeType,
 | |
|   IN EFI_STATUS_CODE_VALUE    Value,
 | |
|   IN UINT32                   Instance,
 | |
|   IN EFI_GUID                 *CallerId,
 | |
|   IN EFI_STATUS_CODE_DATA     *Data OPTIONAL
 | |
|   );
 | |
| 
 | |
| /**
 | |
|   Initialize runtime memory status code table as initialization for runtime memory status code worker
 | |
|  
 | |
|   @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| MemoryStatusCodeInitializeWorker (
 | |
|   VOID
 | |
|   );
 | |
| 
 | |
| /**
 | |
|   Report status code into runtime memory. If the runtime pool is full, roll back to the 
 | |
|   first record and overwrite it.
 | |
|  
 | |
|   @param  CodeType                Indicates the type of status code being reported.
 | |
|   @param  Value                   Describes the current status of a hardware or software entity.
 | |
|                                   This included information about the class and subclass that is used to
 | |
|                                   classify the entity as well as an operation.
 | |
|   @param  Instance                The enumeration of a hardware or software entity within
 | |
|                                   the system. Valid instance numbers start with 1.
 | |
|   @param  CallerId                This optional parameter may be used to identify the caller.
 | |
|                                   This parameter allows the status code driver to apply different rules to
 | |
|                                   different callers.
 | |
|   @param  Data                    This optional parameter may be used to pass additional data.
 | |
|  
 | |
|   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| MemoryStatusCodeReportWorker (
 | |
|   IN EFI_STATUS_CODE_TYPE               CodeType,
 | |
|   IN EFI_STATUS_CODE_VALUE              Value,
 | |
|   IN UINT32                             Instance,
 | |
|   IN EFI_GUID                           *CallerId,
 | |
|   IN EFI_STATUS_CODE_DATA               *Data OPTIONAL
 | |
|   );
 | |
| 
 | |
| #endif
 |