#include <Uefi.h>
#include <IndustryStandard/Emmc.h>
#include <Protocol/SdMmcPassThru.h>
#include <Protocol/BlockIo.h>
#include <Protocol/BlockIo2.h>
#include <Protocol/StorageSecurityCommand.h>
#include <Protocol/EraseBlock.h>
#include <Protocol/DiskInfo.h>
#include <Protocol/DevicePath.h>
#include <Library/DebugLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DevicePathLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include "EmmcBlockIo.h"
#include "EmmcDiskInfo.h"

Data Structures
struct	EMMC_REQUEST

struct	EMMC_PARTITION

struct	_EMMC_DEVICE

struct	_EMMC_DRIVER_PRIVATE_DATA

Macros
#define	EMMC_PARTITION_SIGNATURE SIGNATURE_32 ('E', 'm', 'm', 'P')

#define	EMMC_PARTITION_DATA_FROM_BLKIO(a) CR(a, EMMC_PARTITION, BlockIo, EMMC_PARTITION_SIGNATURE)

#define	EMMC_PARTITION_DATA_FROM_BLKIO2(a) CR(a, EMMC_PARTITION, BlockIo2, EMMC_PARTITION_SIGNATURE)

#define	EMMC_PARTITION_DATA_FROM_SSP(a) CR(a, EMMC_PARTITION, StorageSecurity, EMMC_PARTITION_SIGNATURE)

#define	EMMC_PARTITION_DATA_FROM_ERASEBLK(a) CR(a, EMMC_PARTITION, EraseBlock, EMMC_PARTITION_SIGNATURE)

#define	EMMC_PARTITION_DATA_FROM_DISKINFO(a) CR(a, EMMC_PARTITION, DiskInfo, EMMC_PARTITION_SIGNATURE)

#define	EMMC_GENERIC_TIMEOUT 2500 * 1000

#define	EMMC_REQUEST_SIGNATURE SIGNATURE_32 ('E', 'm', 'R', 'e')

#define	EMMC_REQUEST_FROM_LINK(a) CR(a, EMMC_REQUEST, Link, EMMC_REQUEST_SIGNATURE)

#define	EMMC_MAX_DEVICES 6

#define	EMMC_MAX_PARTITIONS 8

#define	EMMC_MODEL_NAME_MAX_LEN 32

Typedefs
typedef struct _EMMC_DEVICE	EMMC_DEVICE

typedef struct _EMMC_DRIVER_PRIVATE_DATA	EMMC_DRIVER_PRIVATE_DATA

Functions
EFI_STATUS EFIAPI	EmmcDxeDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	EmmcDxeDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	EmmcDxeDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

EFI_STATUS EFIAPI	EmmcDxeComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN CHAR8 Language, OUT CHAR16 **DriverName)

EFI_STATUS EFIAPI	EmmcDxeComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 Language, OUT CHAR16 **ControllerName)

EFI_STATUS	EmmcSelect (IN EMMC_DEVICE *Device, IN UINT16 Rca)

EFI_STATUS	EmmcSendStatus (IN EMMC_DEVICE Device, IN UINT16 Rca, OUT UINT32 DevStatus)

EFI_STATUS	EmmcGetCsd (IN EMMC_DEVICE Device, IN UINT16 Rca, OUT EMMC_CSD Csd)

EFI_STATUS	EmmcGetCid (IN EMMC_DEVICE Device, IN UINT16 Rca, OUT EMMC_CID Cid)

EFI_STATUS	EmmcGetExtCsd (IN EMMC_DEVICE Device, OUT EMMC_EXT_CSD ExtCsd)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gEmmcDxeDriverBinding

EFI_COMPONENT_NAME_PROTOCOL	gEmmcDxeComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gEmmcDxeComponentName2

Detailed Description

Header file for EmmcDxe Driver.

This file defines common data structures, macro definitions and some module internal function header files.

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

Definition in file EmmcDxe.h.

Macro Definition Documentation

◆ EMMC_GENERIC_TIMEOUT

#define EMMC_GENERIC_TIMEOUT 2500 * 1000

Definition at line 67 of file EmmcDxe.h.

◆ EMMC_MAX_DEVICES

#define EMMC_MAX_DEVICES 6

Definition at line 115 of file EmmcDxe.h.

◆ EMMC_MAX_PARTITIONS

#define EMMC_MAX_PARTITIONS 8

Definition at line 119 of file EmmcDxe.h.

◆ EMMC_MODEL_NAME_MAX_LEN

#define EMMC_MODEL_NAME_MAX_LEN 32

Definition at line 120 of file EmmcDxe.h.

◆ EMMC_PARTITION_DATA_FROM_BLKIO

#define EMMC_PARTITION_DATA_FROM_BLKIO ( a ) CR(a, EMMC_PARTITION, BlockIo, EMMC_PARTITION_SIGNATURE)

Definition at line 49 of file EmmcDxe.h.

◆ EMMC_PARTITION_DATA_FROM_BLKIO2

#define EMMC_PARTITION_DATA_FROM_BLKIO2 ( a ) CR(a, EMMC_PARTITION, BlockIo2, EMMC_PARTITION_SIGNATURE)

Definition at line 52 of file EmmcDxe.h.

◆ EMMC_PARTITION_DATA_FROM_DISKINFO

#define EMMC_PARTITION_DATA_FROM_DISKINFO ( a ) CR(a, EMMC_PARTITION, DiskInfo, EMMC_PARTITION_SIGNATURE)

Definition at line 61 of file EmmcDxe.h.

◆ EMMC_PARTITION_DATA_FROM_ERASEBLK

#define EMMC_PARTITION_DATA_FROM_ERASEBLK ( a ) CR(a, EMMC_PARTITION, EraseBlock, EMMC_PARTITION_SIGNATURE)

Definition at line 58 of file EmmcDxe.h.

◆ EMMC_PARTITION_DATA_FROM_SSP

#define EMMC_PARTITION_DATA_FROM_SSP ( a ) CR(a, EMMC_PARTITION, StorageSecurity, EMMC_PARTITION_SIGNATURE)

Definition at line 55 of file EmmcDxe.h.

◆ EMMC_PARTITION_SIGNATURE

#define EMMC_PARTITION_SIGNATURE SIGNATURE_32 ('E', 'm', 'm', 'P')

Definition at line 47 of file EmmcDxe.h.

◆ EMMC_REQUEST_FROM_LINK

#define EMMC_REQUEST_FROM_LINK ( a ) CR(a, EMMC_REQUEST, Link, EMMC_REQUEST_SIGNATURE)

Definition at line 91 of file EmmcDxe.h.

◆ EMMC_REQUEST_SIGNATURE

#define EMMC_REQUEST_SIGNATURE SIGNATURE_32 ('E', 'm', 'R', 'e')

Definition at line 69 of file EmmcDxe.h.

Typedef Documentation

◆ EMMC_DEVICE

typedef struct _EMMC_DEVICE EMMC_DEVICE

Definition at line 71 of file EmmcDxe.h.

◆ EMMC_DRIVER_PRIVATE_DATA

typedef struct _EMMC_DRIVER_PRIVATE_DATA EMMC_DRIVER_PRIVATE_DATA

Definition at line 72 of file EmmcDxe.h.

Function Documentation

◆ EmmcDxeComponentNameGetControllerName()

EFI_STATUS EFIAPI EmmcDxeComponentNameGetControllerName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE ChildHandle	OPTIONAL,
		IN CHAR8 *	Language,
		OUT CHAR16 **	ControllerName
	)

Retrieves a Unicode string that is the user readable name of the controller that is being managed by a driver.

This function retrieves the user readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandle[in]	The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned.
ChildHandle[in]	The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a child controller.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
ControllerName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language from the point of view of the driver specified by This.

Return values

EFI_SUCCESS	The Unicode string for the user readable name in the language specified by Language for the driver specified by This was returned in DriverName.
EFI_INVALID_PARAMETER	ControllerHandle is NULL.
EFI_INVALID_PARAMETER	ChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	ControllerName is NULL.
EFI_UNSUPPORTED	The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 171 of file ComponentName.c.

◆ EmmcDxeComponentNameGetDriverName()

EFI_STATUS EFIAPI EmmcDxeComponentNameGetDriverName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN CHAR8 *	Language,
		OUT CHAR16 **	DriverName
	)

Retrieves a Unicode string that is the user readable name of the driver.

This function retrieves the user readable name of a driver in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the driver name is returned in DriverName, and EFI_SUCCESS is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
DriverName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language specified by Language.

Return values

EFI_SUCCESS	The Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	DriverName is NULL.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 86 of file ComponentName.c.

◆ EmmcDxeDriverBindingStart()

EFI_STATUS EFIAPI EmmcDxeDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Starts a device controller or a bus controller.

The Start() function is designed to be invoked from the EFI boot service ConnectController(). As a result, much of the error checking on the parameters to Start() has been moved into this common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE.
If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL.
Prior to calling Start(), the Supported() function for the driver specified by This must have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver.

Return values

EFI_SUCCESS	The device was started.
EFI_DEVICE_ERROR	The device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
Others	The driver failed to start the device.

Definition at line 854 of file EmmcDxe.c.

◆ EmmcDxeDriverBindingStop()

EFI_STATUS EFIAPI EmmcDxeDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stops a device controller or a bus controller.

The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function.
The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 1002 of file EmmcDxe.c.

◆ EmmcDxeDriverBindingSupported()

EFI_STATUS EFIAPI EmmcDxeDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device.

This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers will typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small, and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Since ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this bus driver.

Return values

EFI_SUCCESS	The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 743 of file EmmcDxe.c.

◆ EmmcGetCid()

EFI_STATUS EmmcGetCid	(	IN EMMC_DEVICE *	Device,
		IN UINT16	Rca,
		OUT EMMC_CID *	Cid
	)

Send command SEND_CID to the device to get the CID register data.

Parameters

[in]	Device	A pointer to the EMMC_DEVICE instance.
[in]	Rca	The relative device address to use.
[out]	Cid	The buffer to store the EMMC_CID register data.

Return values

EFI_SUCCESS	The request is executed successfully.
EFI_OUT_OF_RESOURCES	The request could not be executed due to a lack of resources.
Others	The request could not be executed successfully.

Definition at line 213 of file EmmcBlockIo.c.

◆ EmmcGetCsd()

EFI_STATUS EmmcGetCsd	(	IN EMMC_DEVICE *	Device,
		IN UINT16	Rca,
		OUT EMMC_CSD *	Csd
	)

Send command SEND_CSD to the device to get the CSD register data.

Parameters

[in]	Device	A pointer to the EMMC_DEVICE instance.
[in]	Rca	The relative device address to use.
[out]	Csd	The buffer to store the EMMC_CSD register data.

Return values

EFI_SUCCESS	The request is executed successfully.
EFI_OUT_OF_RESOURCES	The request could not be executed due to a lack of resources.
Others	The request could not be executed successfully.

Definition at line 161 of file EmmcBlockIo.c.

◆ EmmcGetExtCsd()

EFI_STATUS EmmcGetExtCsd	(	IN EMMC_DEVICE *	Device,
		OUT EMMC_EXT_CSD *	ExtCsd
	)

Send command SEND_EXT_CSD to the device to get the EXT_CSD register data.

Parameters

[in]	Device	A pointer to the EMMC_DEVICE instance.
[out]	ExtCsd	The buffer to store the EXT_CSD register data.

Return values

EFI_SUCCESS	The request is executed successfully.
EFI_OUT_OF_RESOURCES	The request could not be executed due to a lack of resources.
Others	The request could not be executed successfully.

Definition at line 264 of file EmmcBlockIo.c.

◆ EmmcSelect()

EFI_STATUS EmmcSelect	(	IN EMMC_DEVICE *	Device,
		IN UINT16	Rca
	)

Send command SELECT to the device to select/deselect the device.

Parameters

[in]	Device	A pointer to the EMMC_DEVICE instance.
[in]	Rca	The relative device address to use.

Return values

EFI_SUCCESS	The request is executed successfully.
EFI_OUT_OF_RESOURCES	The request could not be executed due to a lack of resources.
Others	The request could not be executed successfully.

Definition at line 71 of file EmmcBlockIo.c.

◆ EmmcSendStatus()

EFI_STATUS EmmcSendStatus	(	IN EMMC_DEVICE *	Device,
		IN UINT16	Rca,
		OUT UINT32 *	DevStatus
	)

Send command SEND_STATUS to the device to get device status.

Parameters

[in]	Device	A pointer to the EMMC_DEVICE instance.
[in]	Rca	The relative device address to use.
[out]	DevStatus	The buffer to store the device status.

Return values

EFI_SUCCESS	The request is executed successfully.
EFI_OUT_OF_RESOURCES	The request could not be executed due to a lack of resources.
Others	The request could not be executed successfully.

Definition at line 114 of file EmmcBlockIo.c.

Variable Documentation

◆ gEmmcDxeComponentName

EFI_COMPONENT_NAME_PROTOCOL gEmmcDxeComponentName

extern

Definition at line 30 of file ComponentName.c.

◆ gEmmcDxeComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gEmmcDxeComponentName2

extern

Definition at line 39 of file ComponentName.c.

◆ gEmmcDxeDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gEmmcDxeDriverBinding

extern

Definition at line 17 of file EmmcDxe.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ EMMC_GENERIC_TIMEOUT

◆ EMMC_MAX_DEVICES

◆ EMMC_MAX_PARTITIONS

◆ EMMC_MODEL_NAME_MAX_LEN

◆ EMMC_PARTITION_DATA_FROM_BLKIO

◆ EMMC_PARTITION_DATA_FROM_BLKIO2

◆ EMMC_PARTITION_DATA_FROM_DISKINFO

◆ EMMC_PARTITION_DATA_FROM_ERASEBLK

◆ EMMC_PARTITION_DATA_FROM_SSP

◆ EMMC_PARTITION_SIGNATURE

◆ EMMC_REQUEST_FROM_LINK

◆ EMMC_REQUEST_SIGNATURE

Typedef Documentation

◆ EMMC_DEVICE

◆ EMMC_DRIVER_PRIVATE_DATA

Function Documentation

◆ EmmcDxeComponentNameGetControllerName()

◆ EmmcDxeComponentNameGetDriverName()

◆ EmmcDxeDriverBindingStart()

◆ EmmcDxeDriverBindingStop()

◆ EmmcDxeDriverBindingSupported()

◆ EmmcGetCid()

◆ EmmcGetCsd()

◆ EmmcGetExtCsd()

◆ EmmcSelect()

◆ EmmcSendStatus()

Variable Documentation

◆ gEmmcDxeComponentName

◆ gEmmcDxeComponentName2

◆ gEmmcDxeDriverBinding