Macros
#define	EDKII_UFS_HC_PLATFORM_PPI_VERSION 1

Typedefs
typedef struct _EDKII_UFS_HC_PLATFORM_PPI	EDKII_UFS_HC_PLATFORM_PPI

typedef EFI_STATUS(EFIAPI *	EDKII_UFS_HC_PLATFORM_OVERRIDE_HC_INFO) (IN EFI_HANDLE ControllerHandle, IN OUT EDKII_UFS_HC_INFO *HcInfo)

typedef EFI_STATUS(EFIAPI *	EDKII_UFS_HC_PLATFORM_PEI_CALLBACK) (IN UINTN *UfsHcBaseAddr, IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE CallbackPhase)

Enumerations
enum	EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE { EdkiiUfsHcPreHce , EdkiiUfsHcPostHce , EdkiiUfsHcPreLinkStartup , EdkiiUfsHcPostLinkStartup , EdkiiUfsHcPreHce , EdkiiUfsHcPostHce , EdkiiUfsHcPreLinkStartup , EdkiiUfsHcPostLinkStartup }

enum	EDKII_UFS_CARD_REF_CLK_FREQ_ATTRIBUTE { EdkiiUfsCardRefClkFreq19p2Mhz , EdkiiUfsCardRefClkFreq26Mhz , EdkiiUfsCardRefClkFreq38p4Mhz , EdkiiUfsCardRefClkFreqObsolete , EdkiiUfsCardRefClkFreq19p2Mhz , EdkiiUfsCardRefClkFreq26Mhz , EdkiiUfsCardRefClkFreq38p4Mhz , EdkiiUfsCardRefClkFreqObsolete }

Variables
EFI_GUID	gEdkiiUfsHcPlatformPpiGuid

Detailed Description

EDKII_UFS_HC_PLATFORM_PPI definition.

Copyright (c) 2024, American Megatrends International LLC. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EDKII_UFS_HC_PLATFORM_PPI_VERSION 1

typedef EFI_STATUS(EFIAPI * EDKII_UFS_HC_PLATFORM_OVERRIDE_HC_INFO) (IN EFI_HANDLE ControllerHandle, IN OUT EDKII_UFS_HC_INFO *HcInfo)

Allows platform PPI to override host controller information

Parameters

[in]	ControllerHandle	Handle of the UFS controller.
[in,out]	HcInfo	Pointer EDKII_UFS_HC_INFO associated with host controller.

Return values

EFI_SUCCESS	Function completed successfully.
EFI_INVALID_PARAMETER	HcInfo is NULL.
Others	Function failed to complete.

typedef EFI_STATUS(EFIAPI * EDKII_UFS_HC_PLATFORM_PEI_CALLBACK) (IN UINTN *UfsHcBaseAddr, IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE CallbackPhase)

Callback function for platform driver.

Parameters

[in]	UfsHcBaseddr	The pointer to UfsHcBase address.
[in]	CallbackPhase	Specifies when the platform ppi is called

Return values

EFI_SUCCESS	Override function completed successfully.
EFI_INVALID_PARAMETER	CallbackPhase is invalid or CallbackData is NULL when phase expects valid data.
Others	Function failed to complete.