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>
		
			
				
	
	
		
			111 lines
		
	
	
		
			3.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			111 lines
		
	
	
		
			3.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  Runtime memory status code worker.
 | 
						|
 | 
						|
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
 | 
						|
  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
 | 
						|
  SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#include "StatusCodeHandlerRuntimeDxe.h"
 | 
						|
 | 
						|
RUNTIME_MEMORY_STATUSCODE_HEADER  *mRtMemoryStatusCodeTable;
 | 
						|
 | 
						|
/**
 | 
						|
  Initialize runtime memory status code table as initialization for runtime memory status code worker
 | 
						|
 | 
						|
  @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.
 | 
						|
  @retval others       Errors from gBS->InstallConfigurationTable().
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
RtMemoryStatusCodeInitializeWorker (
 | 
						|
  VOID
 | 
						|
  )
 | 
						|
{
 | 
						|
  EFI_STATUS                        Status;
 | 
						|
 | 
						|
  //
 | 
						|
  // Allocate runtime memory status code pool.
 | 
						|
  //
 | 
						|
  mRtMemoryStatusCodeTable = AllocateRuntimePool (
 | 
						|
                               sizeof (RUNTIME_MEMORY_STATUSCODE_HEADER) +
 | 
						|
                               PcdGet16 (PcdStatusCodeMemorySize) * 1024
 | 
						|
                               );
 | 
						|
  ASSERT (mRtMemoryStatusCodeTable != NULL);
 | 
						|
 | 
						|
  mRtMemoryStatusCodeTable->RecordIndex      = 0;
 | 
						|
  mRtMemoryStatusCodeTable->NumberOfRecords  = 0;
 | 
						|
  mRtMemoryStatusCodeTable->MaxRecordsNumber =
 | 
						|
    (PcdGet16 (PcdStatusCodeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);
 | 
						|
  Status = gBS->InstallConfigurationTable (&gMemoryStatusCodeRecordGuid, mRtMemoryStatusCodeTable);
 | 
						|
 | 
						|
  return Status;
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
RtMemoryStatusCodeReportWorker (
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  MEMORY_STATUSCODE_RECORD              *Record;
 | 
						|
 | 
						|
  //
 | 
						|
  // Locate current record buffer.
 | 
						|
  //
 | 
						|
  Record = (MEMORY_STATUSCODE_RECORD *) (mRtMemoryStatusCodeTable + 1);
 | 
						|
  Record = &Record[mRtMemoryStatusCodeTable->RecordIndex++];
 | 
						|
 | 
						|
  //
 | 
						|
  // Save status code.
 | 
						|
  //
 | 
						|
  Record->CodeType = CodeType;
 | 
						|
  Record->Value    = Value;
 | 
						|
  Record->Instance = Instance;
 | 
						|
 | 
						|
  //
 | 
						|
  // 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.
 | 
						|
  //
 | 
						|
  mRtMemoryStatusCodeTable->NumberOfRecords++;
 | 
						|
  if (mRtMemoryStatusCodeTable->RecordIndex == mRtMemoryStatusCodeTable->MaxRecordsNumber) {
 | 
						|
    //
 | 
						|
    // Wrap around record index.
 | 
						|
    //
 | 
						|
    mRtMemoryStatusCodeTable->RecordIndex = 0;
 | 
						|
  }
 | 
						|
 | 
						|
  return EFI_SUCCESS;
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
 |