Add some comments for translator parameter

[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / Dxe / Ipf / DxeStatusCodeIpf.c

/** @file\r
  Status code driver for IA32/X64/EBC architecture.\r
\r
// Copyright (c) 2006, Intel Corporation. All rights reserved. \r
// This software and associated documentation (if any) is furnished\r
// under a license and may only be used or copied in accordance\r
// with the terms of the license. Except as permitted by such\r
// license, no part of this software or documentation may be\r
// reproduced, stored in a retrieval system, or transmitted in any\r
// form or by any means without the express written consent of\r
// Intel Corporation.\r
\r
  Module Name:  DxeStatusCodeIpf.c\r
\r
**/\r
\r
#include "DxeStatusCode.h"\r
\r
\r
//\r
// Delaration of DXE status code controller \r
//\r
DXE_STATUS_CODE_CONTROLLER gDxeStatusCode = {\r
  //\r
  // Initialize nest status as non nested. \r
  // \r
  0,\r
  {NULL, NULL}\r
};\r
\r
/**\r
\r
  Main entry for Extended SAL ReportStatusCode Services\r
\r
  @param FunctionId        Function Id which needed to be called\r
  @param Arg2              Efi status code type\r
  @param Arg3              Efi status code value\r
  @param Arg4              Instance number \r
  @param Arg5              Caller Id\r
  @param Arg6              Efi status code data\r
  @param Arg7              Not used       \r
  @param Arg8              Not used       \r
  @param ExtendedSalProc   Esal Proc pointer    \r
  @param VirtualMode       If this function is called in virtual mode\r
  @param Global            This module's global variable pointer\r
  \r
  @return Value returned in SAL_RETURN_REGS\r
\r
--*/\r
SAL_RETURN_REGS\r
EFIAPI\r
ReportEsalServiceEntry (\r
  IN  UINT64                    FunctionId,\r
  IN  UINT64                    Arg2,\r
  IN  UINT64                    Arg3,\r
  IN  UINT64                    Arg4,\r
  IN  UINT64                    Arg5,\r
  IN  UINT64                    Arg6,\r
  IN  UINT64                    Arg7,\r
  IN  UINT64                    Arg8,\r
  IN  SAL_EXTENDED_SAL_PROC     ExtendedSalProc,\r
  IN  BOOLEAN                   VirtualMode,\r
  IN  VOID                      *Global\r
  )\r
{\r
  SAL_RETURN_REGS               ReturnVal;\r
  DXE_STATUS_CODE_CONTROLLER    *DxeStatusCode;\r
\r
  switch (FunctionId) {\r
\r
  case ReportStatusCodeService:\r
\r
    DxeStatusCode = (DXE_STATUS_CODE_CONTROLLER *) Global;\r
\r
    //\r
    // Use atom operation to avoid the reentant of report.\r
    // If current status is not zero, then the function is reentrancy.\r
    //\r
    if (InterlockedCompareExchange32 (&DxeStatusCode->StatusCodeNestStatus, 0, 1)) {\r
      ReturnVal.Status = EFI_DEVICE_ERROR ;\r
      return ReturnVal;\r
    }\r
\r
    if (FeaturePcdGet (PcdStatusCodeUseEfiSerial) || FeaturePcdGet (PcdStatusCodeUseHardSerial)) {\r
      SerialStatusCodeReportWorker (\r
        (EFI_STATUS_CODE_TYPE)    Arg2,\r
        (EFI_STATUS_CODE_VALUE)   Arg3,\r
        (UINT32)                  Arg4,\r
        (EFI_GUID *)              Arg5,\r
        (EFI_STATUS_CODE_DATA *)  Arg6\r
        );\r
    }\r
    if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory)) {\r
      RtMemoryStatusCodeReportWorker (\r
        DxeStatusCode->RtMemoryStatusCodeTable[VirtualMode],\r
        (EFI_STATUS_CODE_TYPE)    Arg2,\r
        (EFI_STATUS_CODE_VALUE)   Arg3,\r
        (UINT32)                  Arg4\r
        );\r
    }\r
    if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {\r
      DataHubStatusCodeReportWorker (\r
        (EFI_STATUS_CODE_TYPE)    Arg2,\r
        (EFI_STATUS_CODE_VALUE)   Arg3,\r
        (UINT32)                  Arg4,\r
        (EFI_GUID *)              Arg5,\r
        (EFI_STATUS_CODE_DATA *)  Arg6\r
        );\r
    }\r
    if (FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
      OemHookStatusCodeReport (\r
        (EFI_STATUS_CODE_TYPE)    Arg2,\r
        (EFI_STATUS_CODE_VALUE)   Arg3,\r
        (UINT32)                  Arg4,\r
        (EFI_GUID *)              Arg5,\r
        (EFI_STATUS_CODE_DATA *)  Arg6\r
        );\r
    }\r
\r
    //\r
    // Restore the nest status of report\r
    //\r
    InterlockedCompareExchange32 (&DxeStatusCode->StatusCodeNestStatus, 1, 0);\r
\r
    ReturnVal.Status = EFI_SUCCESS;\r
\r
    break;\r
\r
  default:\r
    ReturnVal.Status = EFI_SAL_INVALID_ARGUMENT;\r
    break;\r
  }\r
\r
  return ReturnVal;\r
}\r
\r
/**\r
\r
  Install the ReportStatusCode runtime service.\r
\r
  @param ImageHandle     Image handle of the loaded driver\r
  @param SystemTable     Pointer to the System Table\r
\r
  @return                The function always returns success.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeStatusCodeDriverEntry (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  //\r
  // Dispatch initialization request to supported devices\r
  //\r
  InitializationDispatcherWorker ();\r
\r
  //\r
  // Initialize ESAL capabilities.\r
  //\r
  RegisterEsalClass (\r
    &gEfiExtendedSalStatusCodeServicesProtocolGuid,\r
    &gDxeStatusCode,\r
    ReportEsalServiceEntry,\r
    StatusCode,\r
    NULL\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Virtual address change notification call back. It converts physical mode global pointer to \r
  virtual mode.\r
\r
  @param  Event         Event whose notification function is being invoked.\r