+++ /dev/null
-/** @file\r
- This file declares BlockIo PPI used to access block-oriented storage devices\r
-\r
- Copyright (c) 2006, 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
- http://opensource.org/licenses/bsd-license.php \r
-\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
-\r
-**/\r
-\r
-#ifndef _PEI_BLOCK_IO_H_\r
-#define _PEI_BLOCK_IO_H_\r
-\r
-#define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \\r
- { \\r
- 0x695d8aa1, 0x42ee, 0x4c46, {0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \\r
- }\r
-\r
-typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI;\r
-\r
-typedef UINT64 EFI_PEI_LBA;\r
-\r
-typedef enum {\r
- LegacyFloppy = 0,\r
- IdeCDROM = 1,\r
- IdeLS120 = 2,\r
- UsbMassStorage= 3,\r
- MaxDeviceType\r
-} EFI_PEI_BLOCK_DEVICE_TYPE;\r
-\r
-typedef struct {\r
- EFI_PEI_BLOCK_DEVICE_TYPE DeviceType;\r
- BOOLEAN MediaPresent;\r
- UINTN LastBlock;\r
- UINTN BlockSize;\r
-} EFI_PEI_BLOCK_IO_MEDIA;\r
-\r
-/**\r
- Gets the count of block I/O devices that one specific block driver detects.\r
-\r
- @param PeiServices General-purpose services that are available to every PEIM.\r
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
- @param NumberBlockDevices The number of block I/O devices discovered.\r
-\r
- @return Status code\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\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
-\r
-/**\r
- Gets a block device's media information.\r
-\r
- @param PeiServices General-purpose services that are available to every PEIM\r
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
- @param DeviceIndex Specifies the block device to which the function\r
- wants to talk. Because the driver that implements Block I/O PPIs\r
- will manage multiple block devices, the PPIs that want to talk to a single\r
- device must specify the device index that was assigned during the enumeration\r
- process. This index is a number from one to NumberBlockDevices.\r
- @param MediaInfo The media information of the specified block media.\r
-\r
- @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.\r
- @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\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
- OUT EFI_PEI_BLOCK_IO_MEDIA *MediaInfo\r
- );\r
-\r
-/**\r
- Reads the requested number of blocks from the specified block device.\r
-\r
- @param PeiServices General-purpose services that are available to every PEIM.\r
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
- @param DeviceIndex Specifies the block device to which the function wants to talk.\r
- @param StartLBA The starting logical block address (LBA) to read from on the device\r
- @param BufferSize The size of the Buffer in bytes. This number must\r
- be a multiple of the intrinsic block size of the device.\r
- @param Buffer A pointer to the destination buffer for the data.\r
- The caller is responsible for the ownership of the buffer.\r
-\r
- @retval EFI_SUCCESS The data was read correctly from the device.\r
- @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
- @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
- or the buffer is not properly aligned.\r
- @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of\r
- the intrinsic block size of the device.\r
- @retval EFI_NO_MEDIA There is no media in the device.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\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
- IN EFI_PEI_LBA StartLBA,\r
- IN UINTN BufferSize,\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
-struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {\r
- EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices;\r
- EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo;\r
- EFI_PEI_READ_BLOCKS ReadBlocks;\r
-};\r
-\r
-extern EFI_GUID gEfiPeiBlockIoPpiGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff