4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Internal include file of Status Code Runtime DXE Driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Data hub worker definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DATAHUB_STATUS_CODE_SIGNATURE SIGNATURE_32 ('B', 'D', 'H', 'S')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Data[sizeof(DATA_HUB_STATUS_CODE_DATA_RECORD) + EFI_STATUS_CODE_DATA_MAX_SIZE];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Runtime memory status code worker definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern RUNTIME_MEMORY_STATUSCODE_HEADER *mRtMemoryStatusCodeTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Report status code to all supported device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function implements EFI_STATUS_CODE_PROTOCOL.ReportStatusCode().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It calls into the workers which dispatches the platform specific listeners.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CodeType Indicates the type of status code being reported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Describes the current status of a hardware or software entity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This included information about the class and subclass that is used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync classify the entity as well as an operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance The enumeration of a hardware or software entity within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system. Valid instance numbers start with 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CallerId This optional parameter may be used to identify the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter allows the status code driver to apply different rules to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync different callers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data This optional parameter may be used to pass additional data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dispatch initialization request to sub status code devices based on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync customized feature flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Locates Serial I/O Protocol as initialization for serial status code worker.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Serial I/O Protocol is successfully located.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CodeType Indicates the type of status code being reported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Describes the current status of a hardware or software entity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This included information about the class and subclass that is used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync classify the entity as well as an operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance The enumeration of a hardware or software entity within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system. Valid instance numbers start with 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CallerId This optional parameter may be used to identify the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter allows the status code driver to apply different rules to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync different callers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data This optional parameter may be used to pass additional data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Status code reported to serial I/O successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize runtime memory status code table as initialization for runtime memory status code worker
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Runtime memory status code table successfully initialized.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Report status code into runtime memory. If the runtime pool is full, roll back to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync first record and overwrite it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CodeType Indicates the type of status code being reported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Describes the current status of a hardware or software entity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This included information about the class and subclass that is used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync classify the entity as well as an operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance The enumeration of a hardware or software entity within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system. Valid instance numbers start with 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Status code successfully recorded in runtime memory status code table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Locate Data Hub Protocol and create event for logging data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as initialization for data hub status code worker.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Initialization is successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Report status code into DataHub.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CodeType Indicates the type of status code being reported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Describes the current status of a hardware or software entity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This included information about the class and subclass that is used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync classify the entity as well as an operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance The enumeration of a hardware or software entity within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system. Valid instance numbers start with 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CallerId This optional parameter may be used to identify the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter allows the status code driver to apply different rules to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync different callers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data This optional parameter may be used to pass additional data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Function is reentered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Function is called at runtime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Fail to allocate memory for free record buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Virtual address change notification call back. It converts global pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to virtual address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event Event whose notification function is being invoked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context Pointer to the notification function's context, which is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync always zero in current implementation.