ReportStatusCodeRouterPei.c File Reference

#include "ReportStatusCodeRouterPei.h"

Go to the source code of this file.

Functions
UINTN *	CreateRscHandlerCallbackPacket (VOID)
EFI_STATUS EFIAPI	Register (IN EFI_PEI_RSC_HANDLER_CALLBACK Callback)
EFI_STATUS EFIAPI	Unregister (IN EFI_PEI_RSC_HANDLER_CALLBACK Callback)
EFI_STATUS EFIAPI	ReportDispatcher (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId OPTIONAL, IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL)
EFI_STATUS EFIAPI	GenericStatusCodePeiEntry (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Variables
EFI_PEI_RSC_HANDLER_PPI	mRscHandlerPpi
EFI_PEI_PROGRESS_CODE_PPI	mStatusCodePpi
EFI_PEI_PPI_DESCRIPTOR	mRscHandlerPpiList []
EFI_PEI_PPI_DESCRIPTOR	mStatusCodePpiList []

Detailed Description

Report Status Code Router PEIM which produces Report Stataus Code Handler PPI and Status Code PPI.

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ReportStatusCodeRouterPei.c.

Function Documentation

CreateRscHandlerCallbackPacket()

UINTN * CreateRscHandlerCallbackPacket

(

VOID

)

Worker function to create one memory status code GUID'ed HOB, using PacketIndex to identify the packet.

Parameters

PacketIndex

Index of records packet.

Returns

Pointer to the memory status code packet.

Definition at line 46 of file ReportStatusCodeRouterPei.c.

GenericStatusCodePeiEntry()

EFI_STATUS EFIAPI GenericStatusCodePeiEntry	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Entry point of Status Code PEIM.

This function is the entry point of this Status Code Router PEIM. It produces Report Stataus Code Handler PPI and Status Code PPI.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCESS

The entry point of DXE IPL PEIM executes successfully.

Definition at line 283 of file ReportStatusCodeRouterPei.c.

Register()

EFI_STATUS EFIAPI Register

(

IN EFI_PEI_RSC_HANDLER_CALLBACK

Callback

)

Register the callback function for ReportStatusCode() notification.

When this function is called the function pointer is added to an internal list and any future calls to ReportStatusCode() will be forwarded to the Callback function.

Parameters

[in]

Callback

A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called when a call to ReportStatusCode() occurs.

Return values

EFI_SUCCESS	Function was successfully registered.
EFI_INVALID_PARAMETER	The callback function was NULL.
EFI_OUT_OF_RESOURCES	The internal buffer ran out of space. No more functions can be registered.
EFI_ALREADY_STARTED	The function was already registered. It can't be registered again.

Definition at line 84 of file ReportStatusCodeRouterPei.c.

ReportDispatcher()

EFI_STATUS EFIAPI ReportDispatcher	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN EFI_STATUS_CODE_TYPE	CodeType,
		IN EFI_STATUS_CODE_VALUE	Value,
		IN UINT32	Instance,
		IN CONST EFI_GUID *CallerId	OPTIONAL,
		IN CONST EFI_STATUS_CODE_DATA *Data	OPTIONAL
	)

Publishes an interface that allows PEIMs to report status codes.

This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode(). It publishes an interface that allows PEIMs to report status codes.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
CodeType	Indicates the type of status code being reported.
Value	Describes the current status of a hardware or software entity. This includes 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.
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.
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.
Data	This optional parameter may be used to pass additional data.

Return values

EFI_SUCCESS

The function completed successfully.

Definition at line 231 of file ReportStatusCodeRouterPei.c.

Unregister()

EFI_STATUS EFIAPI Unregister

(

IN EFI_PEI_RSC_HANDLER_CALLBACK

Callback

)

Remove a previously registered callback function from the notification list.

ReportStatusCode() messages will no longer be forwarded to the Callback function.

Parameters

[in]

Callback

A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be unregistered.

Return values

EFI_SUCCESS	The function was successfully unregistered.
EFI_INVALID_PARAMETER	The callback function was NULL.
EFI_NOT_FOUND	The callback function was not found to be unregistered.

Definition at line 169 of file ReportStatusCodeRouterPei.c.

Variable Documentation

mRscHandlerPpi

EFI_PEI_RSC_HANDLER_PPI mRscHandlerPpi

Initial value:

= {
  Register,
  Unregister
}

Definition at line 11 of file ReportStatusCodeRouterPei.c.

mRscHandlerPpiList

EFI_PEI_PPI_DESCRIPTOR mRscHandlerPpiList[]

Initial value:

= {
  {
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
    &gEfiPeiRscHandlerPpiGuid,
    &mRscHandlerPpi
  }
}

Definition at line 20 of file ReportStatusCodeRouterPei.c.

mStatusCodePpi

EFI_PEI_PROGRESS_CODE_PPI mStatusCodePpi

Initial value:

= {
  ReportDispatcher
}

Definition at line 16 of file ReportStatusCodeRouterPei.c.

mStatusCodePpiList

EFI_PEI_PPI_DESCRIPTOR mStatusCodePpiList[]

Initial value:

= {
  {
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
    &gEfiPeiStatusCodePpiGuid,
    &mStatusCodePpi
  }
}

Definition at line 28 of file ReportStatusCodeRouterPei.c.