X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkModulePkg%2FUniversal%2FStatusCode%2FDxe%2FDxeStatusCode.h;fp=IntelFrameworkModulePkg%2FUniversal%2FStatusCode%2FDxe%2FDxeStatusCode.h;h=9762313e6ef38c02fc6ff936b307d8a6c87b882b;hp=288e3988051b190bc5c42a35c14ca2544b244f81;hb=ececc2eb4b589cc55eabcabbafbd067ff3432df0;hpb=7658d609a376be0fba1c2ba3496e016e55f7aa3a diff --git a/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DxeStatusCode.h b/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DxeStatusCode.h index 288e398805..9762313e6e 100644 --- a/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DxeStatusCode.h +++ b/IntelFrameworkModulePkg/Universal/StatusCode/Dxe/DxeStatusCode.h @@ -1,13 +1,13 @@ /*++ - Copyright (c) 2006, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + Copyright (c) 2006, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. --*/ @@ -46,7 +46,7 @@ #include // -// Data hub worker definition +// Data hub worker definition // #define MAX_NUMBER_DATAHUB_RECORDS 1000 #define DATAHUB_BYTES_PER_RECORD EFI_STATUS_CODE_DATA_MAX_SIZE @@ -56,8 +56,8 @@ // // Address type of pointer. // The point type always equal to PHYSICAL_MODE on IA32/X64/EBC architecture -// Otherwise, VIRTUAL_MODE/PHYSICAL_MODE would be used on Ipf architecture, -// +// Otherwise, VIRTUAL_MODE/PHYSICAL_MODE would be used on Ipf architecture, +// typedef enum { PHYSICAL_MODE, VIRTUAL_MODE @@ -72,8 +72,8 @@ typedef struct { // -// Runtime memory status code worker definition -// +// Runtime memory status code worker definition +// typedef struct { UINT32 RecordIndex; UINT32 NumberOfRecords; @@ -83,22 +83,22 @@ typedef struct { typedef struct { // - // Report operation nest status. + // Report operation nest status. // If it is set, then the report operation has nested. - // + // UINT32 StatusCodeNestStatus; // // Runtime status code management header, the records buffer is following it. - // + // RUNTIME_MEMORY_STATUSCODE_HEADER *RtMemoryStatusCodeTable[2]; } DXE_STATUS_CODE_CONTROLLER; /** - - Dispatch initialization request to sub status code devices based on + + Dispatch initialization request to sub status code devices based on customized feature flags. - + **/ VOID InitializationDispatcherWorker ( @@ -108,7 +108,7 @@ InitializationDispatcherWorker ( /** Initialize serial status code worker. - + @return The function always return EFI_SUCCESS **/ @@ -120,29 +120,29 @@ EfiSerialStatusCodeInitializeWorker ( /** Convert status code value and extended data to readable ASCII string, send string to serial I/O device. - + @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below. - - @param Value Describes the current status of a hardware or software entity. - This included information about the class and subclass that is used to classify the entity - as well as an operation. For progress codes, the operation is the current activity. - For error codes, it is the exception. For debug codes, it is not defined at this time. - Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. + + @param Value Describes the current status of a hardware or software entity. + This included information about the class and subclass that is used to classify the entity + as well as an operation. For progress codes, the operation is the current activity. + For error codes, it is the exception. For debug codes, it is not defined at this time. + Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification. - - @param Instance The enumeration of a hardware or software entity within the system. - A system may contain multiple entities that match a class/subclass pairing. - The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, + + @param Instance The enumeration of a hardware or software entity within the system. + A system may contain multiple entities that match a class/subclass pairing. + The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1. - @param CallerId This optional parameter may be used to identify the caller. - This parameter allows the status code driver to apply different rules to different callers. + @param CallerId This optional parameter may be used to identify the caller. + This parameter allows the status code driver to apply different rules to different callers. Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification. @param Data This optional parameter may be used to pass additional data - + @retval EFI_SUCCESS Success to report status code to serial I/O. @retval EFI_DEVICE_ERROR EFI serial device can not work after ExitBootService() is called . @@ -158,7 +158,7 @@ SerialStatusCodeReportWorker ( /** Initialize runtime memory status code. - + @return The function always return EFI_SUCCESS **/ @@ -168,26 +168,26 @@ RtMemoryStatusCodeInitializeWorker ( ); /** - Report status code into runtime memory. If the runtime pool is full, roll back to the + Report status code into runtime memory. If the runtime pool is full, roll back to the first record and overwrite it. - - @param RtMemoryStatusCodeTable + + @param RtMemoryStatusCodeTable Point to Runtime memory table header. @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below. - - @param Value Describes the current status of a hardware or software entity. - This included information about the class and subclass that is used to classify the entity - as well as an operation. For progress codes, the operation is the current activity. - For error codes, it is the exception. For debug codes, it is not defined at this time. - Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. + + @param Value Describes the current status of a hardware or software entity. + This included information about the class and subclass that is used to classify the entity + as well as an operation. For progress codes, the operation is the current activity. + For error codes, it is the exception. For debug codes, it is not defined at this time. + Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification. - - @param Instance The enumeration of a hardware or software entity within the system. - A system may contain multiple entities that match a class/subclass pairing. - The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, + + @param Instance The enumeration of a hardware or software entity within the system. + A system may contain multiple entities that match a class/subclass pairing. + The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1. - + @return The function always return EFI_SUCCESS. **/ @@ -202,7 +202,7 @@ RtMemoryStatusCodeReportWorker ( /** Initialize data hubstatus code. Create a data hub listener. - + @return The function always return EFI_SUCCESS **/ @@ -214,29 +214,29 @@ DataHubStatusCodeInitializeWorker ( /** Report status code into DataHub. - + @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below. - - @param Value Describes the current status of a hardware or software entity. - This included information about the class and subclass that is used to classify the entity - as well as an operation. For progress codes, the operation is the current activity. - For error codes, it is the exception. For debug codes, it is not defined at this time. - Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. + + @param Value Describes the current status of a hardware or software entity. + This included information about the class and subclass that is used to classify the entity + as well as an operation. For progress codes, the operation is the current activity. + For error codes, it is the exception. For debug codes, it is not defined at this time. + Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification. - - @param Instance The enumeration of a hardware or software entity within the system. - A system may contain multiple entities that match a class/subclass pairing. - The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, + + @param Instance The enumeration of a hardware or software entity within the system. + A system may contain multiple entities that match a class/subclass pairing. + The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1. - @param CallerId This optional parameter may be used to identify the caller. - This parameter allows the status code driver to apply different rules to different callers. + @param CallerId This optional parameter may be used to identify the caller. + This parameter allows the status code driver to apply different rules to different callers. Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification. @param Data This optional parameter may be used to pass additional data - + @retval EFI_OUT_OF_RESOURCES Can not acquire record buffer. @retval EFI_DEVICE_ERROR EFI serial device can not work after ExitBootService() is called . @retval EFI_SUCCESS Success to cache status code and signal log data event. @@ -274,7 +274,7 @@ DxeStatusCodeDriverEntry ( // // declaration of DXE status code controller. -// +// extern DXE_STATUS_CODE_CONTROLLER gDxeStatusCode; #endif