MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / StatusCodeHandler / Smm / MemoryStatusCodeWorker.c

/** @file\r
  Runtime memory status code worker.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "StatusCodeHandlerSmm.h"\r
\r
RUNTIME_MEMORY_STATUSCODE_HEADER  *mSmmMemoryStatusCodeTable;\r
\r
/**\r
  Initialize SMM memory status code table as initialization for memory status code worker\r
\r
  @retval EFI_SUCCESS  SMM memory status code table successfully initialized.\r
  @retval others       Errors from gSmst->SmmInstallConfigurationTable().\r
**/\r
EFI_STATUS\r
MemoryStatusCodeInitializeWorker (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                        Status;\r
\r
  //\r
  // Allocate SMM memory status code pool.\r
  //\r
  mSmmMemoryStatusCodeTable = (RUNTIME_MEMORY_STATUSCODE_HEADER *)AllocateZeroPool (sizeof (RUNTIME_MEMORY_STATUSCODE_HEADER) + PcdGet16 (PcdStatusCodeMemorySize) * 1024);\r
  ASSERT (mSmmMemoryStatusCodeTable != NULL);\r
\r
  mSmmMemoryStatusCodeTable->MaxRecordsNumber = (PcdGet16 (PcdStatusCodeMemorySize) * 1024) / sizeof (MEMORY_STATUSCODE_RECORD);\r
  Status = gSmst->SmmInstallConfigurationTable (\r
                    gSmst,\r
                    &gMemoryStatusCodeRecordGuid,\r
                    &mSmmMemoryStatusCodeTable,\r
                    sizeof (mSmmMemoryStatusCodeTable)\r
                    );\r
  return Status;\r
}\r
\r
\r
/**\r
  Report status code into runtime memory. If the runtime pool is full, roll back to the\r
  first record and overwrite it.\r
\r
  @param  CodeType                Indicates the type of status code being reported.\r
  @param  Value                   Describes the current status of a hardware or software entity.\r
                                  This included information about the class and subclass that is used to\r
                                  classify the entity as well as an operation.\r
  @param  Instance                The enumeration of a hardware or software entity within\r
                                  the system. Valid instance numbers start with 1.\r
  @param  CallerId                This optional parameter may be used to identify the caller.\r
                                  This parameter allows the status code driver to apply different rules to\r
                                  different callers.\r
  @param  Data                    This optional parameter may be used to pass additional data.\r
\r
  @retval EFI_SUCCESS             Status code successfully recorded in runtime memory status code table.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MemoryStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE               CodeType,\r
  IN EFI_STATUS_CODE_VALUE              Value,\r
  IN UINT32                             Instance,\r
  IN EFI_GUID                           *CallerId,\r
  IN EFI_STATUS_CODE_DATA               *Data OPTIONAL\r
  )\r
{\r
  MEMORY_STATUSCODE_RECORD              *Record;\r
\r
  //\r
  // Locate current record buffer.\r
  //\r
  Record = (MEMORY_STATUSCODE_RECORD *) (mSmmMemoryStatusCodeTable + 1);\r
  Record = &Record[mSmmMemoryStatusCodeTable->RecordIndex++];\r
\r
  //\r
  // Save status code.\r
  //\r
  Record->CodeType = CodeType;\r
  Record->Value    = Value;\r
  Record->Instance = Instance;\r
\r
  //\r
  // If record index equals to max record number, then wrap around record index to zero.\r
  //\r
  // The reader of status code should compare the number of records with max records number,\r
  // If it is equal to or larger than the max number, then the wrap-around had happened,\r
  // so the first record is pointed by record index.\r
  // If it is less then max number, index of the first record is zero.\r
  //\r
  mSmmMemoryStatusCodeTable->NumberOfRecords++;\r
  if (mSmmMemoryStatusCodeTable->RecordIndex == mSmmMemoryStatusCodeTable->MaxRecordsNumber) {\r
    //\r
    // Wrap around record index.\r
    //\r
    mSmmMemoryStatusCodeTable->RecordIndex = 0;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
\r