https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Hao Wu <hao.a.wu@intel.com> Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
		
			
				
	
	
		
			122 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			122 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  PEI memory status code worker.
 | 
						|
 | 
						|
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
 | 
						|
  SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#include "StatusCodeHandlerPei.h"
 | 
						|
 | 
						|
/**
 | 
						|
  Create the first memory status code GUID'ed HOB as initialization for memory status code worker.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS  The GUID'ed HOB is created successfully.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
MemoryStatusCodeInitializeWorker (
 | 
						|
  VOID
 | 
						|
  )
 | 
						|
{
 | 
						|
  //
 | 
						|
  // Create memory status code GUID'ed HOB.
 | 
						|
  //
 | 
						|
  MEMORY_STATUSCODE_PACKET_HEADER *PacketHeader;
 | 
						|
 | 
						|
  //
 | 
						|
  // Build GUID'ed HOB with PCD defined size.
 | 
						|
  //
 | 
						|
  PacketHeader = BuildGuidHob (
 | 
						|
                   &gMemoryStatusCodeRecordGuid,
 | 
						|
                   PcdGet16 (PcdStatusCodeMemorySize) * 1024 + sizeof (MEMORY_STATUSCODE_PACKET_HEADER)
 | 
						|
                   );
 | 
						|
  ASSERT (PacketHeader != NULL);
 | 
						|
 | 
						|
  PacketHeader->MaxRecordsNumber = (PcdGet16 (PcdStatusCodeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);
 | 
						|
  PacketHeader->PacketIndex      = 0;
 | 
						|
  PacketHeader->RecordIndex      = 0;
 | 
						|
 | 
						|
  return EFI_SUCCESS;
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
/**
 | 
						|
  Report status code into GUID'ed HOB.
 | 
						|
 | 
						|
  This function reports status code into GUID'ed HOB. If not all packets are full, then
 | 
						|
  write status code into available entry. Otherwise, create a new packet for it.
 | 
						|
 | 
						|
  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
 | 
						|
  @param  CodeType         Indicates the type of status code being reported.
 | 
						|
  @param  Value            Describes the current status of a hardware or
 | 
						|
                           software entity. This includes information about the class and
 | 
						|
                           subclass that is used to classify the entity as well as an operation.
 | 
						|
                           For progress codes, the operation is the current activity.
 | 
						|
                           For error codes, it is the exception.For debug codes,it is not defined at this time.
 | 
						|
  @param  Instance         The enumeration of a hardware or software entity within
 | 
						|
                           the system. A system may contain multiple entities that match a class/subclass
 | 
						|
                           pairing. The instance differentiates between them. An instance of 0 indicates
 | 
						|
                           that instance information is unavailable, not meaningful, or not relevant.
 | 
						|
                           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 always return EFI_SUCCESS.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
MemoryStatusCodeReportWorker (
 | 
						|
  IN CONST  EFI_PEI_SERVICES    **PeiServices,
 | 
						|
  IN EFI_STATUS_CODE_TYPE       CodeType,
 | 
						|
  IN EFI_STATUS_CODE_VALUE      Value,
 | 
						|
  IN UINT32                     Instance,
 | 
						|
  IN CONST EFI_GUID             *CallerId,
 | 
						|
  IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL
 | 
						|
  )
 | 
						|
{
 | 
						|
 | 
						|
  EFI_PEI_HOB_POINTERS              Hob;
 | 
						|
  MEMORY_STATUSCODE_PACKET_HEADER   *PacketHeader;
 | 
						|
  MEMORY_STATUSCODE_RECORD          *Record;
 | 
						|
 | 
						|
  //
 | 
						|
  // Find GUID'ed HOBs to locate current record buffer.
 | 
						|
  //
 | 
						|
  Hob.Raw = GetFirstGuidHob (&gMemoryStatusCodeRecordGuid);
 | 
						|
  ASSERT (Hob.Raw != NULL);
 | 
						|
 | 
						|
  PacketHeader = (MEMORY_STATUSCODE_PACKET_HEADER *) GET_GUID_HOB_DATA (Hob.Guid);
 | 
						|
  Record = (MEMORY_STATUSCODE_RECORD *) (PacketHeader + 1);
 | 
						|
  Record = &Record[PacketHeader->RecordIndex++];
 | 
						|
 | 
						|
  //
 | 
						|
  // Save status code.
 | 
						|
  //
 | 
						|
  Record->CodeType = CodeType;
 | 
						|
  Record->Instance = Instance;
 | 
						|
  Record->Value    = Value;
 | 
						|
 | 
						|
  //
 | 
						|
  // If record index equals to max record number, then wrap around record index to zero.
 | 
						|
  //
 | 
						|
  // The reader of status code should compare the number of records with max records number,
 | 
						|
  // If it is equal to or larger than the max number, then the wrap-around had happened,
 | 
						|
  // so the first record is pointed by record index.
 | 
						|
  // If it is less then max number, index of the first record is zero.
 | 
						|
  //
 | 
						|
  if (PacketHeader->RecordIndex == PacketHeader->MaxRecordsNumber) {
 | 
						|
    //
 | 
						|
    // Wrap around record index.
 | 
						|
    //
 | 
						|
    PacketHeader->RecordIndex = 0;
 | 
						|
    PacketHeader->PacketIndex ++;
 | 
						|
  }
 | 
						|
 | 
						|
  return EFI_SUCCESS;
 | 
						|
}
 | 
						|
 |