#include <Protocol/UfsHostController.h>

Data Structures
struct	EDKII_UIC_COMMAND

struct	_EDKII_UFS_HC_DRIVER_INTERFACE

struct	EDKII_UFS_HC_INFO

struct	_EDKII_UFS_HC_PLATFORM_PROTOCOL

Macros
#define	EDKII_UFS_HC_PLATFORM_PROTOCOL_VERSION 2

Typedefs
typedef struct _EDKII_UFS_HC_PLATFORM_PROTOCOL	EDKII_UFS_HC_PLATFORM_PROTOCOL

typedef struct _EDKII_UFS_HC_DRIVER_INTERFACE	EDKII_UFS_HC_DRIVER_INTERFACE

typedef EFI_STATUS(EFIAPI *	EDKII_UFS_EXEC_UIC_COMMAND) (IN EDKII_UFS_HC_DRIVER_INTERFACE This, IN OUT EDKII_UIC_COMMAND UicCommand)

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_CALLBACK) (IN EFI_HANDLE ControllerHandle, IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE CallbackPhase, IN OUT VOID *CallbackData)

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	gEdkiiUfsHcPlatformProtocolGuid

Detailed Description

EDKII_UFS_HC_PLATFORM_PROTOCOL definition.

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

Definition in file UfsHostControllerPlatform.h.

Macro Definition Documentation

◆ EDKII_UFS_HC_PLATFORM_PROTOCOL_VERSION

#define EDKII_UFS_HC_PLATFORM_PROTOCOL_VERSION 2

Definition at line 14 of file UfsHostControllerPlatform.h.

Typedef Documentation

◆ EDKII_UFS_EXEC_UIC_COMMAND

typedef EFI_STATUS(EFIAPI * EDKII_UFS_EXEC_UIC_COMMAND) (IN EDKII_UFS_HC_DRIVER_INTERFACE *This, IN OUT EDKII_UIC_COMMAND *UicCommand)

Execute UIC command

Parameters

[in]	This	Pointer to driver interface produced by the UFS controller.
[in,out]	UicCommand	Descriptor of the command that will be executed.

Return values

EFI_SUCCESS	Command executed successfully.
EFI_INVALID_PARAMETER	This or UicCommand is NULL.
Others	Command failed to execute.

Definition at line 40 of file UfsHostControllerPlatform.h.

◆ EDKII_UFS_HC_DRIVER_INTERFACE

typedef struct _EDKII_UFS_HC_DRIVER_INTERFACE EDKII_UFS_HC_DRIVER_INTERFACE

Definition at line 20 of file UfsHostControllerPlatform.h.

◆ EDKII_UFS_HC_PLATFORM_CALLBACK

typedef EFI_STATUS(EFIAPI * EDKII_UFS_HC_PLATFORM_CALLBACK) (IN EFI_HANDLE ControllerHandle, IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE CallbackPhase, IN OUT VOID *CallbackData)

Callback function for platform driver.

Parameters

[in]	ControllerHandle	Handle of the UFS controller.
[in]	CallbackPhase	Specifies when the platform protocol is called
[in,out]	CallbackData	Data specific to the callback phase. For PreHce and PostHce - EDKII_UFS_HC_DRIVER_INTERFACE. For PreLinkStartup and PostLinkStartup - EDKII_UFS_HC_DRIVER_INTERFACE.

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.

Definition at line 107 of file UfsHostControllerPlatform.h.