#include "EmmcDxe.h"

Functions
EFI_STATUS	DumpCsd (IN EMMC_CSD *Csd)

EFI_STATUS	DumpExtCsd (IN EMMC_EXT_CSD *ExtCsd)

EFI_STATUS	GetEmmcModelName (IN OUT EMMC_DEVICE Device, IN EMMC_CID Cid)

EFI_STATUS	DiscoverAllPartitions (IN EMMC_DEVICE *Device)

EFI_STATUS	InstallProtocolOnPartition (IN EMMC_DEVICE *Device, IN UINT8 Index)

EFI_STATUS EFIAPI	DiscoverEmmcDevice (IN EMMC_DRIVER_PRIVATE_DATA Private, IN UINT8 Slot, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

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	InitializeEmmcDxe (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gEmmcDxeDriverBinding

EMMC_PARTITION	mEmmcPartitionTemplate

Detailed Description

The EmmcDxe driver is used to manage the EMMC device.

It produces BlockIo, BlockIo2 and StorageSecurity protocols to allow upper layer access the EMMC device.

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

Definition in file EmmcDxe.c.

Function Documentation

◆ DiscoverAllPartitions()

EFI_STATUS DiscoverAllPartitions ( IN EMMC_DEVICE * Device )

Discover all partitions in the EMMC device.

Parameters

[in] Device The pointer to the EMMC_DEVICE data structure.

Return values

EFI_SUCCESS All the partitions in the device are successfully enumerated.

Returns: Others Some error occurs when enumerating the partitions.

Definition at line 280 of file EmmcDxe.c.

◆ DiscoverEmmcDevice()

EFI_STATUS EFIAPI DiscoverEmmcDevice	(	IN EMMC_DRIVER_PRIVATE_DATA *	Private,
		IN UINT8	Slot,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Scan EMMC Bus to discover the device.

Parameters

[in]	Private	The EMMC driver private data structure.
[in]	Slot	The slot number to check device present.
[in]	RemainingDevicePath	The pointer to the remaining device path.

Return values

EFI_SUCCESS	Successfully to discover the device and attach SdMmcIoProtocol to it.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
EFI_ALREADY_STARTED	The device was discovered before.
Others	Fail to discover the device.

Definition at line 567 of file EmmcDxe.c.

◆ DumpCsd()

EFI_STATUS DumpCsd ( IN EMMC_CSD * Csd )

Decode and print EMMC CSD Register content.

Parameters

[in] Csd Pointer to EMMC_CSD data structure.

Return values

EFI_SUCCESS The function completed successfully

Definition at line 92 of file EmmcDxe.c.

◆ DumpExtCsd()

EFI_STATUS DumpExtCsd ( IN EMMC_EXT_CSD * ExtCsd )

Decode and print EMMC EXT_CSD Register content.

Parameters

[in] ExtCsd Pointer to the EMMC_EXT_CSD data structure.

Return values

EFI_SUCCESS The function completed successfully

Definition at line 141 of file EmmcDxe.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.

◆ GetEmmcModelName()

EFI_STATUS GetEmmcModelName	(	IN OUT EMMC_DEVICE *	Device,
		IN EMMC_CID *	Cid
	)

Get EMMC device model name.

Parameters

[in,out]	Device	The pointer to the EMMC_DEVICE data structure.
[in]	Cid	Pointer to EMMC_CID data structure.

Return values

EFI_SUCCESS The function completed successfully

Definition at line 251 of file EmmcDxe.c.

◆ InitializeEmmcDxe()

EFI_STATUS EFIAPI InitializeEmmcDxe	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The user Entry Point for module EmmcDxe. The user code starts with this function.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some errors occur when executing this entry point.

Definition at line 1220 of file EmmcDxe.c.

◆ InstallProtocolOnPartition()

EFI_STATUS InstallProtocolOnPartition	(	IN EMMC_DEVICE *	Device,
		IN UINT8	Index
	)

Install BlkIo, BlkIo2 and Ssp protocols for the specified partition in the EMMC device.

Parameters

[in]	Device	The pointer to the EMMC_DEVICE data structure.
[in]	Index	The index of the partition.

Return values

EFI_SUCCESS	The protocols are installed successfully.
Others	Some error occurs when installing the protocols.

Definition at line 437 of file EmmcDxe.c.

Variable Documentation

◆ gEmmcDxeDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gEmmcDxeDriverBinding

Initial value:

= {
  EmmcDxeDriverBindingSupported,
  EmmcDxeDriverBindingStart,
  EmmcDxeDriverBindingStop,
  0x10,
  NULL,
  NULL
}

Definition at line 17 of file EmmcDxe.c.

◆ mEmmcPartitionTemplate

EMMC_PARTITION mEmmcPartitionTemplate

Definition at line 29 of file EmmcDxe.c.

Functions

Variables

Detailed Description

Function Documentation

◆ DiscoverAllPartitions()

◆ DiscoverEmmcDevice()

◆ DumpCsd()

◆ DumpExtCsd()

◆ EmmcDxeDriverBindingStart()

◆ EmmcDxeDriverBindingStop()

◆ EmmcDxeDriverBindingSupported()

◆ GetEmmcModelName()

◆ InitializeEmmcDxe()

◆ InstallProtocolOnPartition()

Variable Documentation

◆ gEmmcDxeDriverBinding

◆ mEmmcPartitionTemplate