MdeModulePkg: Add definition of the EDKII_UFS_HC_PLATFORM_PROTOCOL

[mirror_edk2.git] / MdeModulePkg / Include / Library / ResetUtilityLib.h

/** @file\r
  This header describes various helper functions for resetting the system.\r
\r
  Copyright (c) 2017 - 2019 Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2016 Microsoft Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#ifndef _RESET_UTILITY_LIB_H_\r
#define _RESET_UTILITY_LIB_H_\r
\r
#include <Uefi/UefiMultiPhase.h>\r
\r
/**\r
  This is a shorthand helper function to reset with reset type and a subtype\r
  so that the caller doesn't have to bother with a function that has half\r
  a dozen parameters.\r
\r
  This will generate a reset with status EFI_SUCCESS, a NULL string, and\r
  no custom data. The subtype will be formatted in such a way that it can be\r
  picked up by notification registrations and custom handlers.\r
\r
  NOTE: This call will fail if the architectural ResetSystem underpinnings\r
        are not initialized. For DXE, you can add gEfiResetArchProtocolGuid\r
        to your DEPEX.\r
\r
  @param[in]  ResetType     The default EFI_RESET_TYPE of the reset.\r
  @param[in]  ResetSubtype  GUID pointer for the reset subtype to be used.\r
\r
**/\r
VOID\r
EFIAPI\r
ResetSystemWithSubtype (\r
  IN EFI_RESET_TYPE     ResetType,\r
  IN CONST  GUID        *ResetSubtype\r
  );\r
\r
/**\r
  This is a shorthand helper function to reset with the reset type\r
  'EfiResetPlatformSpecific' and a subtype so that the caller doesn't\r
  have to bother with a function that has half a dozen parameters.\r
\r
  This will generate a reset with status EFI_SUCCESS, a NULL string, and\r
  no custom data. The subtype will be formatted in such a way that it can be\r
  picked up by notification registrations and custom handlers.\r
\r
  NOTE: This call will fail if the architectural ResetSystem underpinnings\r
        are not initialized. For DXE, you can add gEfiResetArchProtocolGuid\r
        to your DEPEX.\r
\r
  @param[in]  ResetSubtype  GUID pointer for the reset subtype to be used.\r
\r
**/\r
VOID\r
EFIAPI\r
ResetPlatformSpecificGuid (\r
  IN CONST  GUID        *ResetSubtype\r
  );\r
\r
/**\r
  This function examines the DataSize and ResetData parameters passed to\r
  to ResetSystem() and detemrines if the ResetData contains a Null-terminated\r
  Unicode string followed by a GUID specific subtype.  If the GUID specific\r
  subtype is present, then a pointer to the GUID value in ResetData is returned.\r
\r
  @param[in]  DataSize    The size, in bytes, of ResetData.\r
  @param[in]  ResetData   Pointer to the data buffer passed into ResetSystem().\r
\r
  @retval     Pointer     Pointer to the GUID value in ResetData.\r
  @retval     NULL        ResetData is NULL.\r
  @retval     NULL        ResetData does not start with a Null-terminated\r
                          Unicode string.\r
  @retval     NULL        A Null-terminated Unicode string is present, but there\r
                          are less than sizeof (GUID) bytes after the string.\r
  @retval     NULL        No subtype is found.\r
\r
**/\r
GUID *\r
EFIAPI\r
GetResetPlatformSpecificGuid (\r
  IN UINTN       DataSize,\r
  IN CONST VOID  *ResetData\r
  );\r
\r
/**\r
  This is a helper function that creates the reset data buffer that can be\r
  passed into ResetSystem().\r
\r
  The reset data buffer is returned in ResetData and contains ResetString\r
  followed by the ResetSubtype GUID followed by the ExtraData.\r
\r
  NOTE: Strings are internally limited by MAX_UINT16.\r
\r
  @param[in, out] ResetDataSize  On input, the size of the ResetData buffer. On\r
                                 output, either the total number of bytes\r
                                 copied, or the required buffer size.\r
  @param[in, out] ResetData      A pointer to the buffer in which to place the\r
                                 final structure.\r
  @param[in]      ResetSubtype   Pointer to the GUID specific subtype.  This\r
                                 parameter is optional and may be NULL.\r
  @param[in]      ResetString    Pointer to a Null-terminated Unicode string\r
                                 that describes the reset.  This parameter is\r
                                 optional and may be NULL.\r
  @param[in]      ExtraDataSize  The size, in bytes, of ExtraData buffer.\r
  @param[in]      ExtraData      Pointer to a buffer of extra data.  This\r
                                 parameter is optional and may be NULL.\r
\r
  @retval     RETURN_SUCCESS             ResetDataSize and ResetData are updated.\r
  @retval     RETURN_INVALID_PARAMETER   ResetDataSize is NULL.\r
  @retval     RETURN_INVALID_PARAMETER   ResetData is NULL.\r
  @retval     RETURN_INVALID_PARAMETER   ExtraData was provided without a\r
                                         ResetSubtype. This is not supported by the\r
                                         UEFI spec.\r
  @retval     RETURN_BUFFER_TOO_SMALL    An insufficient buffer was provided.\r
                                         ResetDataSize is updated with minimum size\r
                                         required.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
BuildResetData (\r
  IN OUT   UINTN     *ResetDataSize,\r
  IN OUT   VOID      *ResetData,\r
  IN CONST GUID      *ResetSubtype  OPTIONAL,\r
  IN CONST CHAR16    *ResetString   OPTIONAL,\r
  IN       UINTN     ExtraDataSize  OPTIONAL,\r
  IN CONST VOID      *ExtraData     OPTIONAL\r
  );\r
\r
#endif // _RESET_UTILITY_LIB_H_\r