From 19b2cb5c11cf3a4512e9183125ba4a69facb0489 Mon Sep 17 00:00:00 2001 From: Hao Wu Date: Mon, 3 Jul 2017 08:41:16 +0800 Subject: [PATCH] MdeModulePkg/EmmcDxe: Implementation of Disk Information Protocol Adds the implementation of Disk Information Protocol for EMMC devices per PI 1.6 spec. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Hao Wu Reviewed-by: Star Zeng --- MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.c | 140 +++++++++++++++++++++ MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.h | 115 +++++++++++++++++ MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.c | 15 ++- MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.h | 9 +- MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf | 5 +- 5 files changed, 281 insertions(+), 3 deletions(-) create mode 100644 MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.c create mode 100644 MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.h diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.c b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.c new file mode 100644 index 0000000000..85c7ac6c2e --- /dev/null +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.c @@ -0,0 +1,140 @@ +/** @file + Implement the EFI_DISK_INFO_PROTOCOL interface on EMMC devices. + + Copyright (c) 2017, Intel Corporation. All rights reserved.
+ This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#include "EmmcDxe.h" + +/** + Provides inquiry information for the controller type. + + This function is used by the driver entity to get inquiry data. Data format of + Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in,out] InquiryData Pointer to a buffer for the inquiry data. + @param[in,out] InquiryDataSize Pointer to the value for the inquiry data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading InquiryData from device. + @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoInquiry ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *InquiryData, + IN OUT UINT32 *InquiryDataSize + ) +{ + EFI_STATUS Status; + EMMC_PARTITION *Partition; + EMMC_DEVICE *Device; + + Partition = EMMC_PARTITION_DATA_FROM_DISKINFO (This); + Device = Partition->Device; + + if (*InquiryDataSize >= sizeof (Device->Cid)) { + Status = EFI_SUCCESS; + CopyMem (InquiryData, &Device->Cid, sizeof (Device->Cid)); + } else { + Status = EFI_BUFFER_TOO_SMALL; + } + + *InquiryDataSize = sizeof (Device->Cid); + + return Status; +} + +/** + Provides identify information for the controller type. + + This function is used by the driver entity to get identify data. Data format + of Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL + instance. + @param[in,out] IdentifyData Pointer to a buffer for the identify data. + @param[in,out] IdentifyDataSize Pointer to the value for the identify data + size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading IdentifyData from device. + @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoIdentify ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *IdentifyData, + IN OUT UINT32 *IdentifyDataSize + ) +{ + return EFI_NOT_FOUND; +} + +/** + Provides sense data information for the controller type. + + This function is used by the driver entity to get sense data. Data format of + Sense data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in,out] SenseData Pointer to the SenseData. + @param[in,out] SenseDataSize Size of SenseData in bytes. + @param[out] SenseDataNumber Pointer to the value for the sense data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading SenseData from device. + @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoSenseData ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *SenseData, + IN OUT UINT32 *SenseDataSize, + OUT UINT8 *SenseDataNumber + ) +{ + return EFI_NOT_FOUND; +} + +/** + Provides IDE channel and device information for the interface. + + This function is used by the driver entity to get controller information. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. + @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. + + @retval EFI_SUCCESS IdeChannel and IdeDevice are valid. + @retval EFI_UNSUPPORTED This is not an IDE device. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoWhichIde ( + IN EFI_DISK_INFO_PROTOCOL *This, + OUT UINT32 *IdeChannel, + OUT UINT32 *IdeDevice + ) +{ + return EFI_UNSUPPORTED; +} diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.h b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.h new file mode 100644 index 0000000000..4d3e6916d5 --- /dev/null +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDiskInfo.h @@ -0,0 +1,115 @@ +/** @file + Header file for EFI_DISK_INFO_PROTOCOL interface on EMMC devices. + + Copyright (c) 2017, Intel Corporation. All rights reserved.
+ This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#ifndef _EMMC_DISKINFO_H_ +#define _EMMC_DISKINFO_H_ + +/** + Provides inquiry information for the controller type. + + This function is used by the driver entity to get inquiry data. Data format of + Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in,out] InquiryData Pointer to a buffer for the inquiry data. + @param[in,out] InquiryDataSize Pointer to the value for the inquiry data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading InquiryData from device. + @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoInquiry ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *InquiryData, + IN OUT UINT32 *InquiryDataSize + ); + +/** + Provides identify information for the controller type. + + This function is used by the driver entity to get identify data. Data format + of Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL + instance. + @param[in,out] IdentifyData Pointer to a buffer for the identify data. + @param[in,out] IdentifyDataSize Pointer to the value for the identify data + size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading IdentifyData from device. + @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoIdentify ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *IdentifyData, + IN OUT UINT32 *IdentifyDataSize + ); + +/** + Provides sense data information for the controller type. + + This function is used by the driver entity to get sense data. Data format of + Sense data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in,out] SenseData Pointer to the SenseData. + @param[in,out] SenseDataSize Size of SenseData in bytes. + @param[out] SenseDataNumber Pointer to the value for the sense data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading SenseData from device. + @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoSenseData ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *SenseData, + IN OUT UINT32 *SenseDataSize, + OUT UINT8 *SenseDataNumber + ); + +/** + Provides IDE channel and device information for the interface. + + This function is used by the driver entity to get controller information. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. + @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. + + @retval EFI_SUCCESS IdeChannel and IdeDevice are valid. + @retval EFI_UNSUPPORTED This is not an IDE device. + +**/ +EFI_STATUS +EFIAPI +EmmcDiskInfoWhichIde ( + IN EFI_DISK_INFO_PROTOCOL *This, + OUT UINT32 *IdeChannel, + OUT UINT32 *IdeDevice + ); + +#endif diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.c b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.c index 5040882d62..4ebced0b94 100644 --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.c +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.c @@ -4,7 +4,7 @@ It produces BlockIo, BlockIo2 and StorageSecurity protocols to allow upper layer access the EMMC device. - Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.
+ Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -73,6 +73,13 @@ EMMC_PARTITION mEmmcPartitionTemplate = { 1, EmmcEraseBlocks }, + { // DiskInfo + EFI_DISK_INFO_SD_MMC_INTERFACE_GUID, + EmmcDiskInfoInquiry, + EmmcDiskInfoIdentify, + EmmcDiskInfoSenseData, + EmmcDiskInfoWhichIde + }, { NULL, NULL @@ -454,6 +461,8 @@ InstallProtocolOnPartition ( &Partition->BlockIo2, &gEfiEraseBlockProtocolGuid, &Partition->EraseBlock, + &gEfiDiskInfoProtocolGuid, + &Partition->DiskInfo, NULL ); if (EFI_ERROR (Status)) { @@ -481,6 +490,8 @@ InstallProtocolOnPartition ( &Partition->BlockIo2, &gEfiEraseBlockProtocolGuid, &Partition->EraseBlock, + &gEfiDiskInfoProtocolGuid, + &Partition->DiskInfo, NULL ); goto Error; @@ -1104,6 +1115,8 @@ EmmcDxeDriverBindingStop ( &Partition->BlockIo2, &gEfiEraseBlockProtocolGuid, &Partition->EraseBlock, + &gEfiDiskInfoProtocolGuid, + &Partition->DiskInfo, NULL ); if (EFI_ERROR (Status)) { diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.h b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.h index 0ae4eccac6..abdffbb50b 100644 --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.h +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.h @@ -4,7 +4,7 @@ This file defines common data structures, macro definitions and some module internal function header files. - Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.
+ Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -26,6 +26,7 @@ #include #include #include +#include #include @@ -40,6 +41,8 @@ #include #include "EmmcBlockIo.h" +#include "EmmcDiskInfo.h" + // // Global Variables // @@ -61,6 +64,9 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gEmmcDxeComponentName2; #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) + // // Take 2.5 seconds as generic time out value, 1 microsecond as unit. // @@ -102,6 +108,7 @@ typedef struct { EFI_BLOCK_IO_MEDIA BlockMedia; EFI_STORAGE_SECURITY_COMMAND_PROTOCOL StorageSecurity; EFI_ERASE_BLOCK_PROTOCOL EraseBlock; + EFI_DISK_INFO_PROTOCOL DiskInfo; LIST_ENTRY Queue; diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf index 7b0504937a..3f27bdbcaf 100644 --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcDxe.inf @@ -4,7 +4,7 @@ # It produces BlockIo, BlockIo2 and StorageSecurity protocols to allow upper layer # access the EMMC device. # -# Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.
+# Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -41,6 +41,8 @@ EmmcDxe.h EmmcBlockIo.c EmmcBlockIo.h + EmmcDiskInfo.c + EmmcDiskInfo.h [Packages] MdePkg/MdePkg.dec @@ -61,6 +63,7 @@ gEfiBlockIo2ProtocolGuid ## BY_START gEfiStorageSecurityCommandProtocolGuid ## SOMETIMES_PRODUCES gEfiEraseBlockProtocolGuid ## BY_START + gEfiDiskInfoProtocolGuid ## BY_START ## TO_START ## BY_START gEfiDevicePathProtocolGuid