IntelFrameworkModulePkg/Universal/StatusCode/Dxe/RtMemoryStatusCodeWorker.c

   1 /** @file
   2   Runtime memory status code worker.
   3
   4   Copyright (c) 2006 - 2009, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "DxeStatusCode.h"
  16
  17 RUNTIME_MEMORY_STATUSCODE_HEADER  *mRtMemoryStatusCodeTable;
  18
  19 /**
  20   Initialize runtime memory status code table as initialization for runtime memory status code worker
  21
  22   @retval EFI_SUCCESS  Runtime memory status code table successfully initialized.
  23
  24 **/
  25 EFI_STATUS
  26 RtMemoryStatusCodeInitializeWorker (
  27   VOID
  28   )
  29 {
  30   //
  31   // Allocate runtime memory status code pool.
  32   //
  33   mRtMemoryStatusCodeTable = AllocateRuntimePool (
  34                                sizeof (RUNTIME_MEMORY_STATUSCODE_HEADER) +
  35                                PcdGet16 (PcdStatusCodeRuntimeMemorySize) *
  36                                1024
  37                                );
  38   ASSERT (mRtMemoryStatusCodeTable != NULL);
  39
  40   mRtMemoryStatusCodeTable->RecordIndex      = 0;
  41   mRtMemoryStatusCodeTable->NumberOfRecords  = 0;
  42   mRtMemoryStatusCodeTable->MaxRecordsNumber =
  43     (PcdGet16 (PcdStatusCodeRuntimeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);
  44
  45   return EFI_SUCCESS;
  46 }
  47
  48
  49 /**
  50   Report status code into runtime memory. If the runtime pool is full, roll back to the
  51   first record and overwrite it.
  52
  53   @param  CodeType                Indicates the type of status code being reported.
  54   @param  Value                   Describes the current status of a hardware or software entity.
  55                                   This included information about the class and subclass that is used to
  56                                   classify the entity as well as an operation.
  57   @param  Instance                The enumeration of a hardware or software entity within
  58                                   the system. Valid instance numbers start with 1.
  59   @param  CallerId                This optional parameter may be used to identify the caller.
  60                                   This parameter allows the status code driver to apply different rules to
  61                                   different callers.
  62
  63   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.
  64
  65 **/
  66 EFI_STATUS
  67 RtMemoryStatusCodeReportWorker (
  68   IN EFI_STATUS_CODE_TYPE               CodeType,
  69   IN EFI_STATUS_CODE_VALUE              Value,
  70   IN UINT32                             Instance
  71   )
  72 {
  73   MEMORY_STATUSCODE_RECORD              *Record;
  74
  75   //
  76   // Locate current record buffer.
  77   //
  78   Record = (MEMORY_STATUSCODE_RECORD *) (mRtMemoryStatusCodeTable + 1);
  79   Record = &Record[mRtMemoryStatusCodeTable->RecordIndex++];
  80
  81   //
  82   // Save status code.
  83   //
  84   Record->CodeType = CodeType;
  85   Record->Value    = Value;
  86   Record->Instance = Instance;
  87
  88   //
  89   // If record index equals to max record number, then wrap around record index to zero.
  90   //
  91   // The reader of status code should compare the number of records with max records number,
  92   // If it is equal to or larger than the max number, then the wrap-around had happened,
  93   // so the first record is pointed by record index.
  94   // If it is less then max number, index of the first record is zero.
  95   //
  96   mRtMemoryStatusCodeTable->NumberOfRecords++;
  97   if (mRtMemoryStatusCodeTable->RecordIndex == mRtMemoryStatusCodeTable->MaxRecordsNumber) {
  98     //
  99     // Wrap around record index.
 100     //
 101     mRtMemoryStatusCodeTable->RecordIndex = 0;
 102   }
 103
 104   return EFI_SUCCESS;
 105 }
 106
 107
 108