/** @file\r
This file declares BlockIo PPI used to access block-oriented storage devices\r
\r
- Copyright (c) 2007, Intel Corporation\r
+ Copyright (c) 2007 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- Module Name: BlockIo.h\r
-\r
@par Revision Reference:\r
This PPI is defined in Framework of EFI Recovery Spec\r
Version 0.9\r
MaxDeviceType\r
} EFI_PEI_BLOCK_DEVICE_TYPE;\r
\r
+///\r
+/// Inconsistent with specification here: \r
+/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.\r
+/// Inconsistency exists in Framework Recovery Specification, where all referrences to this\r
+/// structure name are with the "EFI_" prefix, except for the definition which is without "EFI_".\r
+/// So the name of PEI_BLOCK_IO_MEDIA is taken as the exception caused by mistake, and\r
+/// EFI_PEI_BLOCK_IO_MEDIA is used to comply with most part of the specification.\r
+///\r
typedef struct {\r
EFI_PEI_BLOCK_DEVICE_TYPE DeviceType;\r
BOOLEAN MediaPresent;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES) (\r
+(EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES)(\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r
OUT UINTN *NumberBlockDevices\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION) (\r
+(EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION)(\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r
IN UINTN DeviceIndex,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_READ_BLOCKS) (\r
+(EFIAPI *EFI_PEI_READ_BLOCKS)(\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r
IN UINTN DeviceIndex,\r
OUT VOID *Buffer\r
);\r
\r
-/**\r
- @par Ppi Description:\r
- EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
- to access a block I/O device during PEI recovery boot mode.\r
-\r
- @param GetNumberOfBlockDevices\r
- Gets the number of block I/O devices that the specific block driver manages.\r
-\r
- @param GetBlockDeviceMediaInfo\r
- Gets the specified media information.\r
-\r
- @param ReadBlocks\r
- Reads the requested number of blocks from the specified block device.\r
-\r
-**/\r
+///\r
+/// EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
+/// to access a block I/O device during PEI recovery boot mode.\r
+///\r
struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {\r
+ ///\r
+ /// Gets the number of block I/O devices that the specific block driver manages.\r
+ ///\r
EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices;\r
+ \r
+ ///\r
+ /// Gets the specified media information.\r
+ ///\r
EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo;\r
+ \r
+ ///\r
+ /// Reads the requested number of blocks from the specified block device.\r
+ ///\r
EFI_PEI_READ_BLOCKS ReadBlocks;\r
};\r
\r