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