2 This file declares BlockIo PPI used to access block-oriented storage devices
4 Copyright (c) 2007 - 2009, 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_
26 #define EFI_PEI_IDE_BLOCK_IO_PPI \
28 0x0964e5b22, 0x6459, 0x11d2, { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
31 #define EFI_PEI_144_FLOPPY_BLOCK_IO_PPI \
33 0xda6855bd, 0x07b7, 0x4c05, { 0x9e, 0xd8, 0xe2, 0x59, 0xfd, 0x36, 0x0e, 0x22 } \
36 #define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \
38 0x695d8aa1, 0x42ee, 0x4c46, { 0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \
41 typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI
;
43 typedef UINT64 EFI_PEI_LBA
;
51 } EFI_PEI_BLOCK_DEVICE_TYPE
;
54 /// Inconsistent with specification here:
55 /// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.
56 /// Inconsistency exists in Framework Recovery Specification, where all referrences to this
57 /// structure name are with the "EFI_" prefix, except for the definition which is without "EFI_".
58 /// So the name of PEI_BLOCK_IO_MEDIA is taken as the exception caused by mistake, and
59 /// EFI_PEI_BLOCK_IO_MEDIA is used to comply with most part of the specification.
62 EFI_PEI_BLOCK_DEVICE_TYPE DeviceType
;
66 } EFI_PEI_BLOCK_IO_MEDIA
;
69 Gets the count of block I/O devices that one specific block driver detects.
71 @param PeiServices General-purpose services that are available to every PEIM.
72 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
73 @param NumberBlockDevices The number of block I/O devices discovered.
80 (EFIAPI
*EFI_PEI_GET_NUMBER_BLOCK_DEVICES
)(
81 IN EFI_PEI_SERVICES
**PeiServices
,
82 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI
*This
,
83 OUT UINTN
*NumberBlockDevices
87 Gets a block device's media information.
89 @param PeiServices General-purpose services that are available to every PEIM
90 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
91 @param DeviceIndex Specifies the block device to which the function
92 wants to talk. Because the driver that implements Block I/O PPIs
93 will manage multiple block devices, the PPIs that want to talk to a single
94 device must specify the device index that was assigned during the enumeration
95 process. This index is a number from one to NumberBlockDevices.
96 @param MediaInfo The media information of the specified block media.
98 @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
99 @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
104 (EFIAPI
*EFI_PEI_GET_DEVICE_MEDIA_INFORMATION
)(
105 IN EFI_PEI_SERVICES
**PeiServices
,
106 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI
*This
,
107 IN UINTN DeviceIndex
,
108 OUT EFI_PEI_BLOCK_IO_MEDIA
*MediaInfo
112 Reads the requested number of blocks from the specified block device.
114 @param PeiServices General-purpose services that are available to every PEIM.
115 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
116 @param DeviceIndex Specifies the block device to which the function wants to talk.
117 @param StartLBA The starting logical block address (LBA) to read from on the device
118 @param BufferSize The size of the Buffer in bytes. This number must
119 be a multiple of the intrinsic block size of the device.
120 @param Buffer A pointer to the destination buffer for the data.
121 The caller is responsible for the ownership of the buffer.
123 @retval EFI_SUCCESS The data was read correctly from the device.
124 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
125 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
126 or the buffer is not properly aligned.
127 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
128 the intrinsic block size of the device.
129 @retval EFI_NO_MEDIA There is no media in the device.
134 (EFIAPI
*EFI_PEI_READ_BLOCKS
)(
135 IN EFI_PEI_SERVICES
**PeiServices
,
136 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI
*This
,
137 IN UINTN DeviceIndex
,
138 IN EFI_PEI_LBA StartLBA
,
144 /// EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required
145 /// to access a block I/O device during PEI recovery boot mode.
147 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI
{
149 /// Gets the number of block I/O devices that the specific block driver manages.
151 EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices
;
154 /// Gets the specified media information.
156 EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo
;
159 /// Reads the requested number of blocks from the specified block device.
161 EFI_PEI_READ_BLOCKS ReadBlocks
;
164 extern EFI_GUID gEfiPeiIdeBlockIoPpiGuid
;
165 extern EFI_GUID gEfiPei144FloppyBlockIoPpiGuid
;
166 extern EFI_GUID gEfiPeiVirtualBlockIoPpiGuid
;