MdeModulePkg/ResetSystemPei: Change comments of ResetSystem2

[mirror_edk2.git] / MdeModulePkg / Universal / ResetSystemPei / ResetSystem.c

/** @file\r
  Implementation of Reset2, ResetFilter and ResetHandler PPIs.\r
\r
  Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "ResetSystem.h"\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED CHAR16 *mResetTypeStr[] = {\r
  L"Cold", L"Warm", L"Shutdown", L"PlatformSpecific"\r
};\r
\r
EFI_PEI_RESET2_PPI mPpiReset2 = {\r
  ResetSystem2\r
};\r
\r
EFI_GUID                *mProcessingOrder[] = {\r
  &gEdkiiPlatformSpecificResetFilterPpiGuid,\r
  &gEdkiiPlatformSpecificResetNotificationPpiGuid,\r
  &gEdkiiPlatformSpecificResetHandlerPpiGuid\r
};\r
\r
RESET_FILTER_INSTANCE   mResetFilter = {\r
  {\r
    RegisterResetNotify,\r
    UnregisterResetNotify\r
  },\r
  &gEdkiiPlatformSpecificResetFilterPpiGuid\r
};\r
\r
RESET_FILTER_INSTANCE   mResetNotification = {\r
  {\r
    RegisterResetNotify,\r
    UnregisterResetNotify\r
  },\r
  &gEdkiiPlatformSpecificResetNotificationPpiGuid\r
};\r
\r
RESET_FILTER_INSTANCE   mResetHandler = {\r
  {\r
    RegisterResetNotify,\r
    UnregisterResetNotify\r
  },\r
  &gEdkiiPlatformSpecificResetHandlerPpiGuid\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR mPpiListReset[] = {\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
    &gEfiPeiReset2PpiGuid,\r
    &mPpiReset2\r
  },\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
    &gEdkiiPlatformSpecificResetFilterPpiGuid,\r
    &mResetFilter.ResetFilter\r
  },\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
    &gEdkiiPlatformSpecificResetNotificationPpiGuid,\r
    &mResetNotification.ResetFilter\r
  },\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
    &gEdkiiPlatformSpecificResetHandlerPpiGuid,\r
    &mResetHandler.ResetFilter\r
  }\r
};\r
\r
/**\r
  Register a notification function to be called when ResetSystem() is called.\r
\r
  The RegisterResetNotify() function registers a notification function that is called when\r
  ResetSystem() is called and prior to completing the reset of the platform.\r
  The registered functions must not perform a platform reset themselves. These\r
  notifications are intended only for the notification of components which may need some\r
  special-purpose maintenance prior to the platform resetting.\r
  The list of registered reset notification functions are processed if ResetSystem()is called\r
  before ExitBootServices(). The list of registered reset notification functions is ignored if\r
  ResetSystem() is called after ExitBootServices().\r
\r
  @param[in]  This              A pointer to the EFI_RESET_NOTIFICATION_PROTOCOL instance.\r
  @param[in]  ResetFunction     Points to the function to be called when a ResetSystem() is executed.\r
\r
  @retval EFI_SUCCESS           The reset notification function was successfully registered.\r
  @retval EFI_INVALID_PARAMETER ResetFunction is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to register the reset notification function.\r
  @retval EFI_ALREADY_STARTED   The reset notification function specified by ResetFunction has already been registered.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterResetNotify (\r
  IN EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI *This,\r
  IN EFI_RESET_SYSTEM                         ResetFunction\r
  )\r
{\r
  RESET_FILTER_INSTANCE                       *ResetFilter;\r
  RESET_FILTER_LIST                           *List;\r
  VOID                                        *Hob;\r
  UINTN                                       Index;\r
\r
  if (ResetFunction == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ResetFilter = (RESET_FILTER_INSTANCE *) This;\r
  ASSERT (CompareGuid (ResetFilter->Guid, &gEdkiiPlatformSpecificResetFilterPpiGuid) ||\r
          CompareGuid (ResetFilter->Guid, &gEdkiiPlatformSpecificResetNotificationPpiGuid) ||\r
          CompareGuid (ResetFilter->Guid, &gEdkiiPlatformSpecificResetHandlerPpiGuid)\r
          );\r
\r
  Hob = GetFirstGuidHob (ResetFilter->Guid);\r
  if (Hob == NULL) {\r
    //\r
    // When the GUIDed HOB doesn't exist, create it.\r
    //\r
    List = (RESET_FILTER_LIST *)BuildGuidHob (\r
                                  ResetFilter->Guid,\r
                                  sizeof (RESET_FILTER_LIST) + sizeof (EFI_RESET_SYSTEM) * PcdGet32 (PcdMaximumPeiResetNotifies)\r
                                  );\r
    if (List == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    List->Signature = RESET_FILTER_LIST_SIGNATURE;\r
    List->Count     = PcdGet32 (PcdMaximumPeiResetNotifies);\r
    ZeroMem (List->ResetFilters, sizeof (EFI_RESET_SYSTEM) * List->Count);\r
    List->ResetFilters[0] = ResetFunction;\r
    return EFI_SUCCESS;\r
  } else {\r
    List = (RESET_FILTER_LIST *)GET_GUID_HOB_DATA (Hob);\r
    ASSERT (List->Signature == RESET_FILTER_LIST_SIGNATURE);\r
    //\r
    // Firstly check whether the ResetFunction is already registerred.\r
    //\r
    for (Index = 0; Index < List->Count; Index++) {\r
      if (List->ResetFilters[Index] == ResetFunction) {\r
        break;\r
      }\r
    }\r
    if (Index != List->Count) {\r
      return EFI_ALREADY_STARTED;\r
    }\r
\r
    //\r
    // Secondly find the first free slot.\r
    //\r
    for (Index = 0; Index < List->Count; Index++) {\r
      if (List->ResetFilters[Index] == NULL) {\r
        break;\r
      }\r
    }\r
\r
    if (Index == List->Count) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    List->ResetFilters[Index] = ResetFunction;\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
/**\r
  Unregister a notification function.\r
\r
  The UnregisterResetNotify() function removes the previously registered\r
  notification using RegisterResetNotify().\r
\r
  @param[in]  This              A pointer to the EFI_RESET_NOTIFICATION_PROTOCOL instance.\r
  @param[in]  ResetFunction     The pointer to the ResetFunction being unregistered.\r
\r
  @retval EFI_SUCCESS           The reset notification function was unregistered.\r
  @retval EFI_INVALID_PARAMETER ResetFunction is NULL.\r
  @retval EFI_INVALID_PARAMETER The reset notification function specified by ResetFunction was not previously\r
                                registered using RegisterResetNotify().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UnregisterResetNotify (\r
  IN EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI *This,\r
  IN EFI_RESET_SYSTEM                         ResetFunction\r
  )\r
{\r
\r
  RESET_FILTER_INSTANCE                       *ResetFilter;\r
  RESET_FILTER_LIST                           *List;\r
  VOID                                        *Hob;\r
  UINTN                                       Index;\r
\r
  if (ResetFunction == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ResetFilter = (RESET_FILTER_INSTANCE *)This;\r
  ASSERT (CompareGuid (ResetFilter->Guid, &gEdkiiPlatformSpecificResetFilterPpiGuid) ||\r
    CompareGuid (ResetFilter->Guid, &gEdkiiPlatformSpecificResetNotificationPpiGuid) ||\r
    CompareGuid (ResetFilter->Guid, &gEdkiiPlatformSpecificResetHandlerPpiGuid)\r
  );\r
\r
  Hob = GetFirstGuidHob (ResetFilter->Guid);\r
  if (Hob == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  List = (RESET_FILTER_LIST *)GET_GUID_HOB_DATA (Hob);\r
  ASSERT (List->Signature == RESET_FILTER_LIST_SIGNATURE);\r
  for (Index = 0; Index < List->Count; Index++) {\r
    if (List->ResetFilters[Index] == ResetFunction) {\r
      break;\r
    }\r
  }\r
\r
  if (Index == List->Count) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  List->ResetFilters[Index] = NULL;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  The PEIM's entry point.\r
\r
  It initializes the Reset2, ResetFilter and ResetHandler PPIs.\r
\r
  @param[in] FileHandle  Handle of the file being invoked.\r
  @param[in] PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCESS         The entry point is executed successfully.\r
  @retval EFI_ALREADY_STARTED The Reset2 PPI was already installed.\r
  @retval others              Status code returned from PeiServicesInstallPpi().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeResetSystem (\r
  IN EFI_PEI_FILE_HANDLE     FileHandle,\r
  IN CONST EFI_PEI_SERVICES  **PeiServices\r
  )\r
{\r
  EFI_STATUS  Status;\r
  VOID        *Ppi;\r
\r
  Status = PeiServicesLocatePpi (&gEfiPeiReset2PpiGuid, 0, NULL, (VOID **)&Ppi);\r
  if (Status != EFI_NOT_FOUND) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  PeiServicesInstallPpi (mPpiListReset);\r
\r
  return Status;\r
}\r
\r
/**\r
  Resets the entire platform.\r
\r
  @param[in] ResetType          The type of reset to perform.\r
  @param[in] ResetStatus        The status code for the reset.\r
  @param[in] DataSize           The size, in bytes, of ResetData.\r
  @param[in] ResetData          For a ResetType of EfiResetCold, EfiResetWarm, or\r
                                EfiResetShutdown the data buffer starts with a Null-terminated\r
                                string, optionally followed by additional binary data.\r
                                The string is a description that the caller may use to further\r
                                indicate the reason for the system reset.\r
                                For a ResetType of EfiResetPlatformSpecific the data buffer\r
                                also starts with a Null-terminated string that is followed\r
                                by an EFI_GUID that describes the specific type of reset to perform.\r
**/\r
VOID\r
EFIAPI\r
ResetSystem2 (\r
  IN EFI_RESET_TYPE   ResetType,\r
  IN EFI_STATUS       ResetStatus,\r
  IN UINTN            DataSize,\r
  IN VOID             *ResetData OPTIONAL\r
  )\r
{\r
  VOID                *Hob;\r
  UINTN               Index;\r
  RESET_FILTER_LIST   *List;\r
  UINTN               OrderIndex;\r
  UINT8               RecursionDepth;\r
  UINT8               *RecursionDepthPointer;\r
\r
  //\r
  // The recursion depth is stored in GUIDed HOB using gEfiCallerIdGuid.\r
  //\r
  Hob = GetFirstGuidHob (&gEfiCallerIdGuid);\r
  if (Hob == NULL) {\r
    RecursionDepth = 0;\r
    RecursionDepthPointer = BuildGuidDataHob (&gEfiCallerIdGuid, &RecursionDepth, sizeof (RecursionDepth));\r
  } else {\r
    RecursionDepthPointer = (UINT8 *)GET_GUID_HOB_DATA (Hob);\r
  }\r
  //\r
  // Only do REPORT_STATUS_CODE() on first call to ResetSystem()\r
  //\r
  if (*RecursionDepthPointer == 0) {\r
    //\r
    // Indicate reset system PEI service is called.\r
    //\r
    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_SERVICE | EFI_SW_PS_PC_RESET_SYSTEM));\r
  }\r
\r
  //\r
  // Increase the call depth\r
  //\r
  (*RecursionDepthPointer)++;\r
  DEBUG ((DEBUG_INFO, "PEI ResetSystem2: Reset call depth = %d.\n", *RecursionDepthPointer));\r
\r
  if (*RecursionDepthPointer <= MAX_RESET_NOTIFY_DEPTH) {\r
    //\r
    // Iteratively call Reset Filters and Reset Handlers.\r
    //\r
    for (OrderIndex = 0; OrderIndex < ARRAY_SIZE (mProcessingOrder); OrderIndex++) {\r
      Hob = GetFirstGuidHob (mProcessingOrder[OrderIndex]);\r
      if (Hob != NULL) {\r
        List = (RESET_FILTER_LIST *)GET_GUID_HOB_DATA (Hob);\r
        ASSERT (List->Signature == RESET_FILTER_LIST_SIGNATURE);\r
\r
        for (Index = 0; Index < List->Count; Index++) {\r
          if (List->ResetFilters[Index] != NULL) {\r
            List->ResetFilters[Index] (ResetType, ResetStatus, DataSize, ResetData);\r
          }\r
        }\r
      }\r
    }\r
  } else {\r
    ASSERT (ResetType < ARRAY_SIZE (mResetTypeStr));\r
    DEBUG ((DEBUG_ERROR, "PEI ResetSystem2: Maximum reset call depth is met. Use the current reset type: %s!\n", mResetTypeStr[ResetType]));\r
  }\r
\r
  switch (ResetType) {\r
  case EfiResetWarm:\r
    ResetWarm ();\r
    break;\r
\r
 case EfiResetCold:\r
    ResetCold ();\r
    break;\r
\r
  case EfiResetShutdown:\r
    ResetShutdown ();\r
    return ;\r
\r
  case EfiResetPlatformSpecific:\r
    ResetPlatformSpecific (DataSize, ResetData);\r
    return;\r
\r
  default:\r
    return ;\r
  }\r
\r
  //\r
  // Given we should have reset getting here would be bad\r
  //\r
  ASSERT (FALSE);\r
}\r