4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Report Status Code Router PEIM which produces Report Stataus Code Handler PPI and Status Code PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, 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 EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Worker function to create one memory status code GUID'ed HOB,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using PacketIndex to identify the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PacketIndex Index of records packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Pointer to the memory status code packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build GUID'ed HOB with PCD defined size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sizeof (EFI_PEI_RSC_HANDLER_CALLBACK) * 64 + sizeof (UINTN)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Register the callback function for ReportStatusCode() notification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When this function is called the function pointer is added to an internal list and any future calls to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReportStatusCode() will be forwarded to the Callback function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when a call to ReportStatusCode() occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Function was successfully registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The callback function was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If current total number of handlers does not exceed 64, put new handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // at the last of packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < *NumberOfEntries; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the function was already registered. It can't be registered again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FreePacket == NULL && CallbackEntry[Index] == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the total number of handlers in current packet is max value 64,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // search an entry with NULL pointer and fill new handler into this entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (FreePacket + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If new registered callback is added as a new entry in the packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // increase the total number of handlers in the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove a previously registered callback function from the notification list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReportStatusCode() messages will no longer be forwarded to the Callback function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function was successfully unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The callback function was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The callback function was not found to be unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < *NumberOfEntries; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set removed entry as NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Publishes an interface that allows PEIMs to report status codes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It publishes an interface that allows PEIMs to report status codes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CodeType Indicates the type of status code being reported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Describes the current status of a hardware or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync software entity. This includes information about the class and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync subclass that is used to classify the entity as well as an operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For progress codes, the operation is the current activity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For error codes, it is the exception.For debug codes,it is not defined at this time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance The enumeration of a hardware or software entity within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system. A system may contain multiple entities that match a class/subclass
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pairing. The instance differentiates between them. An instance of 0 indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that instance information is unavailable, not meaningful, or not relevant.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 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 Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < *NumberOfEntries; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Entry point of Status Code PEIM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is the entry point of this Status Code Router PEIM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It produces Report Stataus Code Handler PPI and Status Code PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Handle of the file being invoked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PeiServices Describes the list of possible PEI Services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCESS The entry point of DXE IPL PEIM executes successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install Report Status Code Handler PPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiServicesInstallPpi (mRscHandlerPpiList);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install Status Code PPI. PI spec specifies that there can be only one instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // of this PPI in system. So first check if other instance already exists.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If no other instance exists, then just install the PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If other instance already exists, then reinstall it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PeiServicesReInstallPpi (OldDescriptor, mStatusCodePpiList);