TianoCore EDK2 master
|
#include <PiPei.h>
#include <Ppi/SdMmcHostController.h>
#include <Ppi/BlockIo.h>
#include <Ppi/BlockIo2.h>
#include <Ppi/IoMmu.h>
#include <Ppi/EndOfPeiPhase.h>
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/IoLib.h>
#include <Library/TimerLib.h>
#include <Library/PeiServicesLib.h>
#include <IndustryStandard/Emmc.h>
#include "EmmcHci.h"
#include "EmmcHcMem.h"
Go to the source code of this file.
Data Structures | |
struct | _EMMC_PEIM_HC_SLOT |
struct | _EMMC_PEIM_HC_PRIVATE_DATA |
struct | _EMMC_TRB |
Macros | |
#define | EMMC_PEIM_SIG SIGNATURE_32 ('E', 'M', 'C', 'P') |
#define | EMMC_PEIM_SLOT_SIG SIGNATURE_32 ('E', 'M', 'C', 'S') |
#define | EMMC_PEIM_MAX_SLOTS 6 |
#define | EMMC_PEIM_MAX_PARTITIONS 8 |
#define | EMMC_TIMEOUT MultU64x32((UINT64)(3), 1000000) |
#define | GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS(a) CR (a, EMMC_PEIM_HC_PRIVATE_DATA, BlkIoPpi, EMMC_PEIM_SIG) |
#define | GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS2(a) CR (a, EMMC_PEIM_HC_PRIVATE_DATA, BlkIo2Ppi, EMMC_PEIM_SIG) |
#define | GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS_NOTIFY(a) CR (a, EMMC_PEIM_HC_PRIVATE_DATA, EndOfPeiNotifyList, EMMC_PEIM_SIG) |
Typedefs | |
typedef struct _EMMC_PEIM_HC_PRIVATE_DATA | EMMC_PEIM_HC_PRIVATE_DATA |
typedef struct _EMMC_PEIM_HC_SLOT | EMMC_PEIM_HC_SLOT |
typedef struct _EMMC_TRB | EMMC_TRB |
Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file EmmcBlockIoPei.h.
#define EMMC_PEIM_MAX_PARTITIONS 8 |
Definition at line 40 of file EmmcBlockIoPei.h.
#define EMMC_PEIM_MAX_SLOTS 6 |
Definition at line 39 of file EmmcBlockIoPei.h.
#define EMMC_PEIM_SIG SIGNATURE_32 ('E', 'M', 'C', 'P') |
Definition at line 36 of file EmmcBlockIoPei.h.
#define EMMC_PEIM_SLOT_SIG SIGNATURE_32 ('E', 'M', 'C', 'S') |
Definition at line 37 of file EmmcBlockIoPei.h.
#define EMMC_TIMEOUT MultU64x32((UINT64)(3), 1000000) |
Definition at line 74 of file EmmcBlockIoPei.h.
#define GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS | ( | a | ) | CR (a, EMMC_PEIM_HC_PRIVATE_DATA, BlkIoPpi, EMMC_PEIM_SIG) |
Definition at line 75 of file EmmcBlockIoPei.h.
#define GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS2 | ( | a | ) | CR (a, EMMC_PEIM_HC_PRIVATE_DATA, BlkIo2Ppi, EMMC_PEIM_SIG) |
Definition at line 76 of file EmmcBlockIoPei.h.
#define GET_EMMC_PEIM_HC_PRIVATE_DATA_FROM_THIS_NOTIFY | ( | a | ) | CR (a, EMMC_PEIM_HC_PRIVATE_DATA, EndOfPeiNotifyList, EMMC_PEIM_SIG) |
Definition at line 77 of file EmmcBlockIoPei.h.
typedef struct _EMMC_PEIM_HC_PRIVATE_DATA EMMC_PEIM_HC_PRIVATE_DATA |
Definition at line 29 of file EmmcBlockIoPei.h.
typedef struct _EMMC_PEIM_HC_SLOT EMMC_PEIM_HC_SLOT |
Definition at line 30 of file EmmcBlockIoPei.h.
Definition at line 31 of file EmmcBlockIoPei.h.
EFI_STATUS EFIAPI EmmcBlockIoPeimEndOfPei | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_NOTIFY_DESCRIPTOR * | NotifyDescriptor, | ||
IN VOID * | Ppi | ||
) |
One notified function to cleanup the allocated DMA buffers at the end of PEI.
[in] | PeiServices | Pointer to PEI Services Table. |
[in] | NotifyDescriptor | Pointer to the descriptor for the Notification event that caused this function to execute. |
[in] | Ppi | Pointer to the PPI data associated with this function. |
EFI_SUCCESS | The function completes successfully |
Definition at line 640 of file EmmcBlockIoPei.c.
EFI_STATUS EFIAPI EmmcBlockIoPeimGetDeviceNo | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_RECOVERY_BLOCK_IO_PPI * | This, | ||
OUT UINTN * | NumberBlockDevices | ||
) |
Gets the count of block I/O devices that one specific block driver detects.
This function is used for getting the count of block I/O devices that one specific block driver detects. To the PEI ATAPI driver, it returns the number of all the detected ATAPI devices it detects during the enumeration process. To the PEI legacy floppy driver, it returns the number of all the legacy devices it finds during its enumeration process. If no device is detected, then the function will return zero.
[in] | PeiServices | General-purpose services that are available to every PEIM. |
[in] | This | Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. |
[out] | NumberBlockDevices | The number of block I/O devices discovered. |
EFI_SUCCESS | The operation performed successfully. |
Definition at line 183 of file EmmcBlockIoPei.c.
EFI_STATUS EFIAPI EmmcBlockIoPeimGetDeviceNo2 | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI * | This, | ||
OUT UINTN * | NumberBlockDevices | ||
) |
Gets the count of block I/O devices that one specific block driver detects.
This function is used for getting the count of block I/O devices that one specific block driver detects. To the PEI ATAPI driver, it returns the number of all the detected ATAPI devices it detects during the enumeration process. To the PEI legacy floppy driver, it returns the number of all the legacy devices it finds during its enumeration process. If no device is detected, then the function will return zero.
[in] | PeiServices | General-purpose services that are available to every PEIM. |
[in] | This | Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance. |
[out] | NumberBlockDevices | The number of block I/O devices discovered. |
EFI_SUCCESS | The operation performed successfully. |
Definition at line 460 of file EmmcBlockIoPei.c.
EFI_STATUS EFIAPI EmmcBlockIoPeimGetMediaInfo | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_RECOVERY_BLOCK_IO_PPI * | This, | ||
IN UINTN | DeviceIndex, | ||
OUT EFI_PEI_BLOCK_IO_MEDIA * | MediaInfo | ||
) |
Gets a block device's media information.
This function will provide the caller with the specified block device's media information. If the media changes, calling this function will update the media information accordingly.
[in] | PeiServices | General-purpose services that are available to every PEIM |
[in] | This | Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. |
[in] | DeviceIndex | Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices. |
[out] | MediaInfo | The media information of the specified block media. The caller is responsible for the ownership of this data structure. |
EFI_SUCCESS | Media information about the specified block device was obtained successfully. |
EFI_DEVICE_ERROR | Cannot get the media information due to a hardware error. |
Definition at line 239 of file EmmcBlockIoPei.c.
EFI_STATUS EFIAPI EmmcBlockIoPeimGetMediaInfo2 | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI * | This, | ||
IN UINTN | DeviceIndex, | ||
OUT EFI_PEI_BLOCK_IO2_MEDIA * | MediaInfo | ||
) |
Gets a block device's media information.
This function will provide the caller with the specified block device's media information. If the media changes, calling this function will update the media information accordingly.
[in] | PeiServices | General-purpose services that are available to every PEIM |
[in] | This | Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance. |
[in] | DeviceIndex | Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices. |
[out] | MediaInfo | The media information of the specified block media. The caller is responsible for the ownership of this data structure. |
EFI_SUCCESS | Media information about the specified block device was obtained successfully. |
EFI_DEVICE_ERROR | Cannot get the media information due to a hardware error. |
Definition at line 517 of file EmmcBlockIoPei.c.
EFI_STATUS EFIAPI EmmcBlockIoPeimReadBlocks | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_RECOVERY_BLOCK_IO_PPI * | This, | ||
IN UINTN | DeviceIndex, | ||
IN EFI_PEI_LBA | StartLBA, | ||
IN UINTN | BufferSize, | ||
OUT VOID * | Buffer | ||
) |
Reads the requested number of blocks from the specified block device.
The function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If there is no media in the device, the function returns EFI_NO_MEDIA.
[in] | PeiServices | General-purpose services that are available to every PEIM. |
[in] | This | Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. |
[in] | DeviceIndex | Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices. |
[in] | StartLBA | The starting logical block address (LBA) to read from on the device |
[in] | BufferSize | The size of the Buffer in bytes. This number must be a multiple of the intrinsic block size of the device. |
[out] | Buffer | A pointer to the destination buffer for the data. The caller is responsible for the ownership of the buffer. |
EFI_SUCCESS | The data was read correctly from the device. |
EFI_DEVICE_ERROR | The device reported an error while attempting to perform the read operation. |
EFI_INVALID_PARAMETER | The read request contains LBAs that are not valid, or the buffer is not properly aligned. |
EFI_NO_MEDIA | There is no media in the device. |
EFI_BAD_BUFFER_SIZE | The BufferSize parameter is not a multiple of the intrinsic block size of the device. |
Definition at line 319 of file EmmcBlockIoPei.c.
EFI_STATUS EFIAPI EmmcBlockIoPeimReadBlocks2 | ( | IN EFI_PEI_SERVICES ** | PeiServices, |
IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI * | This, | ||
IN UINTN | DeviceIndex, | ||
IN EFI_PEI_LBA | StartLBA, | ||
IN UINTN | BufferSize, | ||
OUT VOID * | Buffer | ||
) |
Reads the requested number of blocks from the specified block device.
The function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If there is no media in the device, the function returns EFI_NO_MEDIA.
[in] | PeiServices | General-purpose services that are available to every PEIM. |
[in] | This | Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance. |
[in] | DeviceIndex | Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices. |
[in] | StartLBA | The starting logical block address (LBA) to read from on the device |
[in] | BufferSize | The size of the Buffer in bytes. This number must be a multiple of the intrinsic block size of the device. |
[out] | Buffer | A pointer to the destination buffer for the data. The caller is responsible for the ownership of the buffer. |
EFI_SUCCESS | The data was read correctly from the device. |
EFI_DEVICE_ERROR | The device reported an error while attempting to perform the read operation. |
EFI_INVALID_PARAMETER | The read request contains LBAs that are not valid, or the buffer is not properly aligned. |
EFI_NO_MEDIA | There is no media in the device. |
EFI_BAD_BUFFER_SIZE | The BufferSize parameter is not a multiple of the intrinsic block size of the device. |
Definition at line 601 of file EmmcBlockIoPei.c.
VOID * EmmcPeimAllocateMem | ( | IN EMMC_PEIM_MEM_POOL * | Pool, |
IN UINTN | Size | ||
) |
Allocate some memory from the host controller's memory pool which can be used to communicate with host controller.
Pool | The host controller's memory pool. |
Size | Size of the memory to allocate. |
Definition at line 294 of file EmmcHcMem.c.
VOID EmmcPeimFreeMem | ( | IN EMMC_PEIM_MEM_POOL * | Pool, |
IN VOID * | Mem, | ||
IN UINTN | Size | ||
) |
Free the allocated memory back to the memory pool.
Pool | The memory pool of the host controller. |
Mem | The memory to free. |
Size | The size of the memory to free. |
Definition at line 366 of file EmmcHcMem.c.
EFI_STATUS EmmcPeimFreeMemPool | ( | IN EMMC_PEIM_MEM_POOL * | Pool | ) |
Release the memory management pool.
Pool | The memory pool to free. |
EFI_DEVICE_ERROR | Fail to free the memory pool. |
EFI_SUCCESS | The memory pool is freed. |
Definition at line 263 of file EmmcHcMem.c.
EFI_STATUS EmmcPeimInitMemPool | ( | IN EMMC_PEIM_HC_PRIVATE_DATA * | Private | ) |
Initialize the memory management pool for the host controller.
Private | The Emmc Peim driver private data. |
EFI_SUCCESS | The memory pool is initialized. |
Others | Fail to init the memory pool. |
Definition at line 223 of file EmmcHcMem.c.
EFI_STATUS IoMmuAllocateBuffer | ( | IN UINTN | Pages, |
OUT VOID ** | HostAddress, | ||
OUT EFI_PHYSICAL_ADDRESS * | DeviceAddress, | ||
OUT VOID ** | Mapping | ||
) |
Allocates pages that are suitable for an OperationBusMasterCommonBuffer or OperationBusMasterCommonBuffer64 mapping.
Pages | The number of pages to allocate. |
HostAddress | A pointer to store the base system memory address of the allocated range. |
DeviceAddress | The resulting map address for the bus master PCI controller to use to access the hosts HostAddress. |
Mapping | A resulting value to pass to Unmap(). |
EFI_SUCCESS | The requested memory pages were allocated. |
EFI_UNSUPPORTED | Attributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE and MEMORY_CACHED. |
EFI_INVALID_PARAMETER | One or more parameters are invalid. |
EFI_OUT_OF_RESOURCES | The memory pages could not be allocated. |
EFI_STATUS IoMmuFreeBuffer | ( | IN UINTN | Pages, |
IN VOID * | HostAddress, | ||
IN VOID * | Mapping | ||
) |
Frees memory that was allocated with AllocateBuffer().
Pages | The number of pages to free. |
HostAddress | The base system memory address of the allocated range. |
Mapping | The mapping value returned from Map(). |
EFI_SUCCESS | The requested memory pages were freed. |
EFI_INVALID_PARAMETER | The memory range specified by HostAddress and Pages was not allocated with AllocateBuffer(). |
EFI_STATUS IoMmuMap | ( | IN EDKII_IOMMU_OPERATION | Operation, |
IN VOID * | HostAddress, | ||
IN OUT UINTN * | NumberOfBytes, | ||
OUT EFI_PHYSICAL_ADDRESS * | DeviceAddress, | ||
OUT VOID ** | Mapping | ||
) |
Provides the controller-specific addresses required to access system memory from a DMA bus master.
Operation | Indicates if the bus master is going to read or write to system memory. |
HostAddress | The system memory address to map to the PCI controller. |
NumberOfBytes | On input the number of bytes to map. On output the number of bytes that were mapped. |
DeviceAddress | The resulting map address for the bus master PCI controller to use to access the hosts HostAddress. |
Mapping | A resulting value to pass to Unmap(). |
EFI_SUCCESS | The range was mapped for the returned NumberOfBytes. |
EFI_UNSUPPORTED | The HostAddress cannot be mapped as a common buffer. |
EFI_INVALID_PARAMETER | One or more parameters are invalid. |
EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. |
EFI_DEVICE_ERROR | The system hardware could not map the requested address. |
EFI_STATUS IoMmuUnmap | ( | IN VOID * | Mapping | ) |
Completes the Map() operation and releases any corresponding resources.
Mapping | The mapping value returned from Map(). |
EFI_SUCCESS | The range was unmapped. |
EFI_INVALID_PARAMETER | Mapping is not a value that was returned by Map(). |
EFI_DEVICE_ERROR | The data was not committed to the target system memory. |