Add some comments for translator parameter

[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / Dxe / DxeStatusCode.h

/*++\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:\r
\r
  DxeStatusCode.h\r
\r
Abstract:\r
\r
  Header file of EFI DXE/RT Status Code.\r
\r
--*/\r
\r
#ifndef __DXE_STATUS_CODE_H__\r
#define __DXE_STATUS_CODE_H__\r
\r
//\r
// Data hub worker definition \r
//\r
#define MAX_NUMBER_DATAHUB_RECORDS                1000\r
#define DATAHUB_BYTES_PER_RECORD                  EFI_STATUS_CODE_DATA_MAX_SIZE\r
#define EMPTY_RECORD_TAG                          0xFF\r
#define DATAHUB_STATUS_CODE_SIGNATURE             EFI_SIGNATURE_32 ('B', 'D', 'H', 'S')\r
\r
//\r
// Address type of pointer.\r
// The point type always equal to PHYSICAL_MODE on IA32/X64/EBC architecture\r
// Otherwise, VIRTUAL_MODE/PHYSICAL_MODE would be used on Ipf architecture, \r
// \r
enum {\r
  PHYSICAL_MODE,\r
  VIRTUAL_MODE\r
};\r
\r
typedef struct {\r
  UINTN                     Signature;\r
  LIST_ENTRY                Node;\r
  EFI_STATUS_CODE_TYPE      CodeType;\r
  EFI_STATUS_CODE_VALUE     Value;\r
  UINT32                    Instance;\r
  EFI_GUID                  CallerId;\r
  EFI_STATUS_CODE_DATA      Data;\r
  UINT8                     ExtendData[EFI_STATUS_CODE_DATA_MAX_SIZE];\r
} DATAHUB_STATUSCODE_RECORD;\r
\r
\r
//\r
// Runtime memory status code worker definition \r
// \r
typedef struct {\r
  UINT32   RecordIndex;\r
  UINT32   NumberOfRecords;\r
  UINT32   MaxRecordsNumber;\r
} RUNTIME_MEMORY_STATUSCODE_HEADER;\r
\r
\r
typedef struct {\r
  //\r
  // Report operation nest status. \r
  // If it is set, then the report operation has nested.\r
  // \r
  UINT32                            StatusCodeNestStatus;\r
  //\r
  // Runtime status code management header, the records buffer is following it.\r
  // \r
  RUNTIME_MEMORY_STATUSCODE_HEADER  *RtMemoryStatusCodeTable[2];\r
} DXE_STATUS_CODE_CONTROLLER;\r
\r
\r
/**\r
  \r
  Dispatch initialization request to sub status code devices based on \r
  customized feature flags.\r
 \r
**/\r
VOID\r
InitializationDispatcherWorker (\r
  VOID\r
  );\r
\r
\r
/**\r
  Initialize serial status code worker.\r
 \r
  @return  The function always return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
EfiSerialStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
\r
/**\r
  Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
 \r