MdePkg: Add RecoveryBlockIo2Ppi definition to follow PI1.4 spec

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Feng Tian <feng.tian@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17477 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 227 insertions, 1 deletions

diff --git a/MdePkg/Include/Ppi/BlockIo2.h b/MdePkg/Include/Ppi/BlockIo2.h
new file mode 100644
index 0000000000..0ccc3a7894
--- /dev/null
+++ b/MdePkg/Include/Ppi/BlockIo2.h
@@ -0,0 +1,223 @@
+/** @file

+  Provides the services required to access a block I/O 2 device during PEI recovery

+  boot mode.

+

+Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>

+This program and the accompanying materials are licensed and made available under

+the terms and conditions of the BSD License that 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.

+

+  @par Revision Reference:

+  This PPI is defined in UEFI Platform Initialization Specification 1.4 Volume 1:

+  Pre-EFI Initalization Core Interface.

+

+**/

+

+#ifndef _PEI_BLOCK_IO2_H_

+#define _PEI_BLOCK_IO2_H_

+

+#include <Ppi/BlockIo.h>

+#include <Protocol/DevicePath.h>

+

+///

+/// Global ID for EFI_PEI_RECOVERY_BLOCK_IO2_PPI

+///

+#define EFI_PEI_RECOVERY_BLOCK_IO2_PPI_GUID \

+  { \

+    0x26cc0fad, 0xbeb3, 0x478a, { 0x91, 0xb2, 0xc, 0x18, 0x8f, 0x72, 0x61, 0x98 } \

+  }

+

+///

+/// The forward declaration for EFI_PEI_RECOVERY_BLOCK_IO_PPI.

+///

+typedef struct _EFI_PEI_RECOVERY_BLOCK_IO2_PPI  EFI_PEI_RECOVERY_BLOCK_IO2_PPI;

+

+#define EFI_PEI_RECOVERY_BLOCK_IO2_PPI_REVISION 0x00010000

+

+typedef struct {

+  ///

+  /// A type of interface that the device being referenced by DeviceIndex is

+  /// attached to. This field re-uses Messaging Device Path Node sub-type values

+  /// as defined by Section 9.3.5 Messaging Device Path of UEFI Specification.

+  /// When more than one sub-type is associated with the interface, sub-type with

+  /// the smallest number must be used.

+  ///

+  UINT8                      InterfaceType;

+  ///

+  /// A flag that indicates if media is removable.

+  ///

+  BOOLEAN                    RemovableMedia;

+  ///

+  /// A flag that indicates if media is present. This flag is always set for

+  /// non-removable media devices.

+  ///

+  BOOLEAN                    MediaPresent;

+  ///

+  /// A flag that indicates if media is read-only.

+  ///

+  BOOLEAN                    ReadOnly;

+  ///

+  /// The size of a logical block in bytes.

+  ///

+  UINT32                     BlockSize;

+  ///

+  /// The last logical block that the device supports.

+  ///

+  EFI_PEI_LBA                LastBlock;

+} EFI_PEI_BLOCK_IO2_MEDIA;

+

+/**

+  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.

+

+  @param[in]  PeiServices          General-purpose services that are available

+                                   to every PEIM.

+  @param[in]  This                 Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI

+                                   instance.

+  @param[out] NumberBlockDevices   The number of block I/O devices discovered.

+

+  @retval     EFI_SUCCESS          The operation performed successfully.

+

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES2)(

+  IN  EFI_PEI_SERVICES               **PeiServices,

+  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI *This,

+  OUT UINTN                          *NumberBlockDevices

+  );

+

+/**

+  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.

+

+  @param[in]  PeiServices   General-purpose services that are available to every

+                            PEIM

+  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.

+  @param[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.

+  @param[out] MediaInfo     The media information of the specified block media.

+                            The caller is responsible for the ownership of this

+                            data structure.

+

+  @par Note:

+      The MediaInfo structure describes an enumeration of possible block device

+      types.  This enumeration exists because no device paths are actually passed

+      across interfaces that describe the type or class of hardware that is publishing

+      the block I/O interface. This enumeration will allow for policy decisions

+      in the Recovery PEIM, such as "Try to recover from legacy floppy first,

+      LS-120 second, CD-ROM third." If there are multiple partitions abstracted

+      by a given device type, they should be reported in ascending order; this

+      order also applies to nested partitions, such as legacy MBR, where the

+      outermost partitions would have precedence in the reporting order. The

+      same logic applies to systems such as IDE that have precedence relationships

+      like "Master/Slave" or "Primary/Secondary". The master device should be

+      reported first, the slave second.

+

+  @retval EFI_SUCCESS        Media information about the specified block device

+                             was obtained successfully.

+  @retval EFI_DEVICE_ERROR   Cannot get the media information due to a hardware

+                             error.

+

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION2)(

+  IN  EFI_PEI_SERVICES               **PeiServices,

+  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI *This,

+  IN  UINTN                          DeviceIndex,

+  OUT EFI_PEI_BLOCK_IO2_MEDIA        *MediaInfo

+  );

+

+/**

+  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.

+

+  @param[in]  PeiServices   General-purpose services that are available to

+                            every PEIM.

+  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.

+  @param[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.

+  @param[in]  StartLBA      The starting logical block address (LBA) to read from

+                            on the device

+  @param[in]  BufferSize    The size of the Buffer in bytes. This number must be

+                            a multiple of the intrinsic block size of the device.

+  @param[out] Buffer        A pointer to the destination buffer for the data.

+                            The caller is responsible for the ownership of the

+                            buffer.

+

+  @retval EFI_SUCCESS             The data was read correctly from the device.

+  @retval EFI_DEVICE_ERROR        The device reported an error while attempting

+                                  to perform the read operation.

+  @retval EFI_INVALID_PARAMETER   The read request contains LBAs that are not

+                                  valid, or the buffer is not properly aligned.

+  @retval EFI_NO_MEDIA            There is no media in the device.

+  @retval EFI_BAD_BUFFER_SIZE     The BufferSize parameter is not a multiple of

+                                  the intrinsic block size of the device.

+

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_PEI_READ_BLOCKS2)(

+  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

+  );

+

+///

+///  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required

+///  to access a block I/O device during PEI recovery boot mode.

+///

+struct _EFI_PEI_RECOVERY_BLOCK_IO2_PPI {

+  ///

+  /// The revision to which the interface adheres.

+  /// All future revisions must be backwards compatible.

+  ///

+  UINT64                                 Revision;

+  ///

+  /// Gets the number of block I/O devices that the specific block driver manages.

+  ///

+  EFI_PEI_GET_NUMBER_BLOCK_DEVICES2      GetNumberOfBlockDevices;

+

+  ///

+  /// Gets the specified media information.

+  ///

+  EFI_PEI_GET_DEVICE_MEDIA_INFORMATION2  GetBlockDeviceMediaInfo;

+

+  ///

+  /// Reads the requested number of blocks from the specified block device.

+  ///

+  EFI_PEI_READ_BLOCKS2                   ReadBlocks;

+};

+

+extern EFI_GUID gEfiPeiVirtualBlockIo2PpiGuid;

+

+#endif

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 521620bbd7..9d818cbcf6 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -837,7 +837,10 @@
   gPeiCapsulePpiGuid                = { 0x3acf33ee, 0xd892, 0x40f4, { 0xa2, 0xfc, 0x38, 0x54, 0xd2, 0xe1, 0x32, 0x3d }}

 

   ## Include/Ppi/Reset2.h

-  gEfiPeiReset2PpiGuid = { 0x6cc45765, 0xcce4, 0x42fd, {0xbc, 0x56, 0x1, 0x1a, 0xaa, 0xc6, 0xc9, 0xa8 } }

+  gEfiPeiReset2PpiGuid              = { 0x6cc45765, 0xcce4, 0x42fd, {0xbc, 0x56, 0x1, 0x1a, 0xaa, 0xc6, 0xc9, 0xa8 } }

+

+  ## Include/Ppi/BlockIo2.h

+  gEfiPeiVirtualBlockIo2PpiGuid     = { 0x26cc0fad, 0xbeb3, 0x478a, { 0x91, 0xb2, 0xc, 0x18, 0x8f, 0x72, 0x61, 0x98 }}

 

 [Protocols]

   ## Include/Protocol/Pcd.h