MdeModulePkg/Universal/StatusCodeHandler/Smm/MemoryStatusCodeWorker.c

   1 /** @file
   2   Runtime memory status code worker.
   3
   4   Copyright (c) 2006 - 2010, 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 "StatusCodeHandlerSmm.h"
  16
  17 RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;
  18
  19 /**
  20   Initialize SMM memory status code table as initialization for memory status code worker
  21
  22   @retval EFI_SUCCESS  SMM memory status code table successfully initialized.
  23
  24 **/
  25 EFI_STATUS
  26 MemoryStatusCodeInitializeWorker (
  27   VOID
  28   )
  29 {
  30   //
  31   // Allocate SMM memory status code pool.
  32   //
  33   mSmmMemoryStatusCodeTable = (RUNTIME_MEMORY_STATUSCODE_HEADER *)AllocateZeroPool (sizeof (RUNTIME_MEMORY_STATUSCODE_HEADER) + PcdGet16 (PcdStatusCodeMemorySize) * 1024);
  34   ASSERT (mSmmMemoryStatusCodeTable != NULL);
  35
  36   mSmmMemoryStatusCodeTable->MaxRecordsNumber = (PcdGet16 (PcdStatusCodeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);
  37   return EFI_SUCCESS;
  38 }
  39
  40
  41 /**
  42   Report status code into runtime memory. If the runtime pool is full, roll back to the
  43   first record and overwrite it.
  44
  45   @param  CodeType                Indicates the type of status code being reported.
  46   @param  Value                   Describes the current status of a hardware or software entity.
  47                                   This included information about the class and subclass that is used to
  48                                   classify the entity as well as an operation.
  49   @param  Instance                The enumeration of a hardware or software entity within
  50                                   the system. Valid instance numbers start with 1.
  51   @param  CallerId                This optional parameter may be used to identify the caller.
  52                                   This parameter allows the status code driver to apply different rules to
  53                                   different callers.
  54   @param  Data                    This optional parameter may be used to pass additional data.
  55
  56   @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.
  57
  58 **/
  59 EFI_STATUS
  60 MemoryStatusCodeReportWorker (
  61   IN EFI_STATUS_CODE_TYPE               CodeType,
  62   IN EFI_STATUS_CODE_VALUE              Value,
  63   IN UINT32                             Instance,
  64   IN EFI_GUID                           *CallerId,
  65   IN EFI_STATUS_CODE_DATA               *Data OPTIONAL
  66   )
  67 {
  68   MEMORY_STATUSCODE_RECORD              *Record;
  69
  70   //
  71   // Locate current record buffer.
  72   //
  73   Record = (MEMORY_STATUSCODE_RECORD *) (mSmmMemoryStatusCodeTable + 1);
  74   Record = &Record[mSmmMemoryStatusCodeTable->RecordIndex++];
  75
  76   //
  77   // Save status code.
  78   //
  79   Record->CodeType = CodeType;
  80   Record->Value    = Value;
  81   Record->Instance = Instance;
  82
  83   //
  84   // If record index equals to max record number, then wrap around record index to zero.
  85   //
  86   // The reader of status code should compare the number of records with max records number,
  87   // If it is equal to or larger than the max number, then the wrap-around had happened,
  88   // so the first record is pointed by record index.
  89   // If it is less then max number, index of the first record is zero.
  90   //
  91   mSmmMemoryStatusCodeTable->NumberOfRecords++;
  92   if (mSmmMemoryStatusCodeTable->RecordIndex == mSmmMemoryStatusCodeTable->MaxRecordsNumber) {
  93     //
  94     // Wrap around record index.
  95     //
  96     mSmmMemoryStatusCodeTable->RecordIndex = 0;
  97   }
  98
  99   return EFI_SUCCESS;
 100 }
 101
 102
 103