2 This file declares BlockIo PPI used to access block-oriented storage devices
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: BlockIo.h
15 @par Revision Reference:
16 This PPI is defined in Framework of EFI Recovery Spec
21 #ifndef _PEI_BLOCK_IO_H_
22 #define _PEI_BLOCK_IO_H_
24 #define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \
26 0x695d8aa1, 0x42ee, 0x4c46, {0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \
29 typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI
;
31 typedef UINT64 EFI_PEI_LBA
;
39 } EFI_PEI_BLOCK_DEVICE_TYPE
;
42 EFI_PEI_BLOCK_DEVICE_TYPE DeviceType
;
46 } EFI_PEI_BLOCK_IO_MEDIA
;
49 Gets the count of block I/O devices that one specific block driver detects.
51 @param PeiServices General-purpose services that are available to every PEIM.
53 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
55 @param NumberBlockDevices The number of block I/O devices discovered.
62 (EFIAPI
*EFI_PEI_GET_NUMBER_BLOCK_DEVICES
) (
63 IN EFI_PEI_SERVICES
**PeiServices
,
64 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI
*This
,
65 OUT UINTN
*NumberBlockDevices
69 Gets a block device¡¯s media information.
71 @param PeiServices General-purpose services that are available to every PEIM
73 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
75 @param DeviceIndex Specifies the block device to which the function
76 wants to talk. Because the driver that implements Block I/O PPIs
77 will manage multiple block devices, the PPIs that want to talk to a single
78 device must specify the device index that was assigned during the enumeration
79 process. This index is a number from one to NumberBlockDevices.
81 @param MediaInfo The media information of the specified block media.
83 @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
85 @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
90 (EFIAPI
*EFI_PEI_GET_DEVICE_MEDIA_INFORMATION
) (
91 IN EFI_PEI_SERVICES
**PeiServices
,
92 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI
*This
,
94 OUT EFI_PEI_BLOCK_IO_MEDIA
*MediaInfo
98 Reads the requested number of blocks from the specified block device.
100 @param PeiServices General-purpose services that are available to every PEIM.
102 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
104 @param DeviceIndex Specifies the block device to which the function wants to talk.
106 @param StartLBA The starting logical block address (LBA) to read from on the device
108 @param BufferSize The size of the Buffer in bytes. This number must
109 be a multiple of the intrinsic block size of the device.
111 @param Buffer A pointer to the destination buffer for the data.
112 The caller is responsible for the ownership of the buffer.
114 @retval EFI_SUCCESS The data was read correctly from the device.
116 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
118 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
119 or the buffer is not properly aligned.
121 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
122 the intrinsic block size of the device.
124 @retval EFI_NO_MEDIA There is no media in the device.
129 (EFIAPI
*EFI_PEI_READ_BLOCKS
) (
130 IN EFI_PEI_SERVICES
**PeiServices
,
131 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI
*This
,
132 IN UINTN DeviceIndex
,
133 IN EFI_PEI_LBA StartLBA
,
139 @par Ppi Description:
140 EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required
141 to access a block I/O device during PEI recovery boot mode.
143 @param GetNumberOfBlockDevices
144 Gets the number of block I/O devices that the specific block driver manages.
146 @param GetBlockDeviceMediaInfo
147 Gets the specified media information.
150 Reads the requested number of blocks from the specified block device.
153 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI
{
154 EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices
;
155 EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo
;
156 EFI_PEI_READ_BLOCKS ReadBlocks
;
159 extern EFI_GUID gEfiPeiBlockIoPpiGuid
;