UfsHostControllerPlatform.h File Reference

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   1

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 IN OUT EDKII_UIC_COMMAND *	UicCommand
typedef IN OUT EDKII_UFS_HC_INFO *	HcInfo
typedef IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE	CallbackPhase
typedef IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE IN OUT VOID *	CallbackData

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

Functions
typedef	EFI_STATUS (EFIAPI *EDKII_UFS_EXEC_UIC_COMMAND)(IN EDKII_UFS_HC_DRIVER_INTERFACE *This

Variables
EFI_GUID	gEdkiiUfsHcPlatformProtocolGuid

Detailed Description

EDKII_UFS_HC_PLATFORM_PROTOCOL definition.

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

Macro Definition Documentation

#define EDKII_UFS_HC_PLATFORM_PROTOCOL_VERSION   1

Typedef Documentation

typedef IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE IN OUT VOID* CallbackData

typedef IN EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE CallbackPhase

typedef struct _EDKII_UFS_HC_DRIVER_INTERFACE EDKII_UFS_HC_DRIVER_INTERFACE

typedef struct _EDKII_UFS_HC_PLATFORM_PROTOCOL EDKII_UFS_HC_PLATFORM_PROTOCOL

typedef IN OUT EDKII_UFS_HC_INFO* HcInfo

typedef IN OUT EDKII_UIC_COMMAND* UicCommand

Enumeration Type Documentation

enum EDKII_UFS_HC_PLATFORM_CALLBACK_PHASE

Enumerator
EdkiiUfsHcPreHce
EdkiiUfsHcPostHce
EdkiiUfsHcPreLinkStartup
EdkiiUfsHcPostLinkStartup

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EDKII_UFS_HC_PLATFORM_CALLBACK

)

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.

Allows platform protocol 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.

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.

Variable Documentation

EFI_GUID gEdkiiUfsHcPlatformProtocolGuid