git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10631 6f19259b-4bc3-4df7-8a09-765794883524
		
			
				
	
	
		
			302 lines
		
	
	
		
			8.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			302 lines
		
	
	
		
			8.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
|   Status code driver for IA32/X64/EBC architecture.
 | |
| 
 | |
|   Copyright (c) 2006 - 2010, 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.
 | |
| 
 | |
| **/
 | |
| 
 | |
| #include "StatusCodeRuntimeDxe.h"
 | |
| 
 | |
| EFI_EVENT    mVirtualAddressChangeEvent = NULL;
 | |
| EFI_HANDLE   mHandle = NULL;
 | |
| 
 | |
| //
 | |
| // Declaration of status code protocol.
 | |
| //
 | |
| EFI_STATUS_CODE_PROTOCOL  mEfiStatusCodeProtocol  = {
 | |
|   ReportDispatcher
 | |
| };
 | |
| 
 | |
| //
 | |
| // Report operation nest status.
 | |
| // If it is set, then the report operation has nested.
 | |
| //
 | |
| UINT32  mStatusCodeNestStatus = 0;
 | |
| 
 | |
| /**
 | |
|   Entry point of DXE Status Code Driver.
 | |
| 
 | |
|   This function is the entry point of this DXE Status Code Driver.
 | |
|   It installs Status Code Runtime Protocol, and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
 | |
| 
 | |
|   @param  ImageHandle       The firmware allocated handle for the EFI image.
 | |
|   @param  SystemTable       A pointer to the EFI System Table.
 | |
|   
 | |
|   @retval EFI_SUCCESS       The entry point is executed successfully.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| StatusCodeRuntimeDxeEntry (
 | |
|   IN EFI_HANDLE         ImageHandle,
 | |
|   IN EFI_SYSTEM_TABLE   *SystemTable
 | |
|   )
 | |
| {
 | |
|   EFI_STATUS  Status;
 | |
| 
 | |
|   //
 | |
|   // Dispatch initialization request to supported devices
 | |
|   //
 | |
|   InitializationDispatcherWorker ();
 | |
| 
 | |
|   //
 | |
|   // Install Status Code Runtime Protocol implementation as defined in PI Specification.
 | |
|   //
 | |
|   Status = gBS->InstallMultipleProtocolInterfaces (
 | |
|                   &mHandle,
 | |
|                   &gEfiStatusCodeRuntimeProtocolGuid,
 | |
|                   &mEfiStatusCodeProtocol,
 | |
|                   NULL
 | |
|                   );
 | |
|   ASSERT_EFI_ERROR (Status);
 | |
| 
 | |
|   Status = gBS->CreateEventEx (
 | |
|                   EVT_NOTIFY_SIGNAL,
 | |
|                   TPL_NOTIFY,
 | |
|                   VirtualAddressChangeCallBack,
 | |
|                   NULL,
 | |
|                   &gEfiEventVirtualAddressChangeGuid,
 | |
|                   &mVirtualAddressChangeEvent
 | |
|                   );
 | |
|   ASSERT_EFI_ERROR (Status);
 | |
| 
 | |
|   return EFI_SUCCESS;
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Report status code to all supported device.
 | |
| 
 | |
|   This function implements EFI_STATUS_CODE_PROTOCOL.ReportStatusCode().
 | |
|   It calls into the workers which dispatches the platform specific listeners.
 | |
| 
 | |
|   @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      The function completed successfully
 | |
|   @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| ReportDispatcher (
 | |
|   IN EFI_STATUS_CODE_TYPE     CodeType,
 | |
|   IN EFI_STATUS_CODE_VALUE    Value,
 | |
|   IN UINT32                   Instance,
 | |
|   IN EFI_GUID                 *CallerId  OPTIONAL,
 | |
|   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL
 | |
|   )
 | |
| {
 | |
|   //
 | |
|   // Use atom operation to avoid the reentant of report.
 | |
|   // If current status is not zero, then the function is reentrancy.
 | |
|   //
 | |
|   if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {
 | |
|     return EFI_DEVICE_ERROR;
 | |
|   }
 | |
| 
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseSerial)) {
 | |
|     SerialStatusCodeReportWorker (
 | |
|       CodeType,
 | |
|       Value,
 | |
|       Instance,
 | |
|       CallerId,
 | |
|       Data
 | |
|       );
 | |
|   }
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseMemory)) {
 | |
|     RtMemoryStatusCodeReportWorker (
 | |
|       CodeType,
 | |
|       Value,
 | |
|       Instance
 | |
|       );
 | |
|   }
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {
 | |
|     DataHubStatusCodeReportWorker (
 | |
|       CodeType,
 | |
|       Value,
 | |
|       Instance,
 | |
|       CallerId,
 | |
|       Data
 | |
|       );
 | |
|   }
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseOEM)) {
 | |
|     //
 | |
|     // Call OEM hook status code library API to report status code to OEM device
 | |
|     //
 | |
|     OemHookStatusCodeReport (
 | |
|       CodeType,
 | |
|       Value,
 | |
|       Instance,
 | |
|       CallerId,
 | |
|       Data
 | |
|       );
 | |
|   }
 | |
| 
 | |
|   //
 | |
|   // Restore the nest status of report
 | |
|   //
 | |
|   InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);
 | |
| 
 | |
|   return EFI_SUCCESS;
 | |
| }
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Virtual address change notification call back. It converts global pointer
 | |
|   to virtual address.
 | |
| 
 | |
|   @param  Event         Event whose notification function is being invoked.
 | |
|   @param  Context       Pointer to the notification function's context, which is
 | |
|                         always zero in current implementation.
 | |
| 
 | |
| **/
 | |
| VOID
 | |
| EFIAPI
 | |
| VirtualAddressChangeCallBack (
 | |
|   IN EFI_EVENT        Event,
 | |
|   IN VOID             *Context
 | |
|   )
 | |
| {
 | |
|   //
 | |
|   // Convert memory status code table to virtual address;
 | |
|   //
 | |
|   EfiConvertPointer (
 | |
|     0,
 | |
|     (VOID **) &mRtMemoryStatusCodeTable
 | |
|     );
 | |
| }
 | |
| 
 | |
| /**
 | |
|   Dispatch initialization request to sub status code devices based on 
 | |
|   customized feature flags.
 | |
|  
 | |
| **/
 | |
| VOID
 | |
| InitializationDispatcherWorker (
 | |
|   VOID
 | |
|   )
 | |
| {
 | |
|   EFI_PEI_HOB_POINTERS              Hob;
 | |
|   EFI_STATUS                        Status;
 | |
|   MEMORY_STATUSCODE_PACKET_HEADER   *PacketHeader;
 | |
|   MEMORY_STATUSCODE_RECORD          *Record;
 | |
|   UINTN                             Index;
 | |
|   UINTN                             MaxRecordNumber;
 | |
| 
 | |
|   //
 | |
|   // If enable UseSerial, then initialize serial port.
 | |
|   // if enable UseRuntimeMemory, then initialize runtime memory status code worker.
 | |
|   // if enable UseDataHub, then initialize data hub status code worker.
 | |
|   //
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseSerial)) {
 | |
|     //
 | |
|     // Call Serial Port Lib API to initialize serial port.
 | |
|     //
 | |
|     Status = SerialPortInitialize ();
 | |
|     ASSERT_EFI_ERROR (Status);
 | |
|   }
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseMemory)) {
 | |
|     Status = RtMemoryStatusCodeInitializeWorker ();
 | |
|     ASSERT_EFI_ERROR (Status);
 | |
|   }
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {
 | |
|     DataHubStatusCodeInitializeWorker ();
 | |
|   }
 | |
|   if (FeaturePcdGet (PcdStatusCodeUseOEM)) {
 | |
|     //
 | |
|     // Call OEM hook status code library API to initialize OEM device for status code.
 | |
|     //
 | |
|     Status = OemHookStatusCodeInitialize ();
 | |
|     ASSERT_EFI_ERROR (Status);
 | |
|   }
 | |
| 
 | |
|   //
 | |
|   // Replay Status code which saved in GUID'ed HOB to all supported devices. 
 | |
|   //
 | |
|   if (FeaturePcdGet (PcdStatusCodeReplayIn)) {
 | |
|     // 
 | |
|     // Journal GUID'ed HOBs to find all record entry, if found, 
 | |
|     // then output record to support replay device.
 | |
|     //
 | |
|     Hob.Raw   = GetFirstGuidHob (&gMemoryStatusCodeRecordGuid);
 | |
|     if (Hob.Raw != NULL) {
 | |
|       PacketHeader = (MEMORY_STATUSCODE_PACKET_HEADER *) GET_GUID_HOB_DATA (Hob.Guid);
 | |
|       Record = (MEMORY_STATUSCODE_RECORD *) (PacketHeader + 1);
 | |
|       MaxRecordNumber = (UINTN) PacketHeader->RecordIndex;
 | |
|       if (PacketHeader->PacketIndex > 0) {
 | |
|         //
 | |
|         // Record has been wrapped around. So, record number has arrived at max number.
 | |
|         //
 | |
|         MaxRecordNumber = (UINTN) PacketHeader->MaxRecordsNumber;
 | |
|       }
 | |
|       for (Index = 0; Index < MaxRecordNumber; Index++) {
 | |
|         //
 | |
|         // Dispatch records to devices based on feature flag.
 | |
|         //
 | |
|         if (FeaturePcdGet (PcdStatusCodeUseSerial)) {
 | |
|           SerialStatusCodeReportWorker (
 | |
|             Record[Index].CodeType,
 | |
|             Record[Index].Value,
 | |
|             Record[Index].Instance,
 | |
|             NULL,
 | |
|             NULL
 | |
|             );
 | |
|         }
 | |
|         if (FeaturePcdGet (PcdStatusCodeUseMemory)) {
 | |
|           RtMemoryStatusCodeReportWorker (
 | |
|             Record[Index].CodeType,
 | |
|             Record[Index].Value,
 | |
|             Record[Index].Instance
 | |
|             );
 | |
|         }
 | |
|         if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {
 | |
|           DataHubStatusCodeReportWorker (
 | |
|             Record[Index].CodeType,
 | |
|             Record[Index].Value,
 | |
|             Record[Index].Instance,
 | |
|             NULL,
 | |
|             NULL
 | |
|             );
 | |
|         }
 | |
|         if (FeaturePcdGet (PcdStatusCodeUseOEM)) {
 | |
|           //
 | |
|           // Call OEM hook status code library API to report status code to OEM device
 | |
|           //
 | |
|           OemHookStatusCodeReport (
 | |
|             Record[Index].CodeType,
 | |
|             Record[Index].Value,
 | |
|             Record[Index].Instance,
 | |
|             NULL,
 | |
|             NULL
 | |
|             );
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|   }
 | |
| }
 |