1 /** @file 2 Provides the services required to access a block I/O device during PEI recovery 3 boot mode. 4 5 The Recovery Module PPI and the Device Recovery Module PPI are device neutral. 6 This PPI is device specific and addresses the most common form of recovery 7 media-block I/O devices such as legacy floppy, CD-ROM, or IDE devices. 8 9 The Recovery Block I/O PPI is used to access block devices. Because the Recovery 10 Block I/O PPIs that are provided by the PEI ATAPI driver and PEI legacy floppy 11 driver are the same, here we define a set of general PPIs for both drivers to use. 12 13 Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR> 14 This program and the accompanying materials are licensed and made available under 15 the terms and conditions of the BSD License that accompanies this distribution. 16 The full text of the license may be found at 17 http://opensource.org/licenses/bsd-license.php. 18 19 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 20 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 21 22 @par Revision Reference: 23 This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1: 24 Pre-EFI Initalization Core Interface. 25 26 **/ 27 28 #ifndef _PEI_BLOCK_IO_H_ 29 #define _PEI_BLOCK_IO_H_ 30 31 /// 32 /// Global ID for EFI_PEI_RECOVERY_BLOCK_IO_PPI 33 /// 34 #define EFI_PEI_RECOVERY_BLOCK_IO_PPI_GUID \ 35 { \ 36 0x695d8aa1, 0x42ee, 0x4c46, { 0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \ 37 } 38 39 /// 40 /// The forward declaration for EFI_PEI_RECOVERY_BLOCK_IO_PPI. 41 /// 42 typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI; 43 44 /// 45 /// All blocks on the recovery device are addressed with a 64-bit Logical Block Address (LBA). 46 /// 47 typedef UINT64 EFI_PEI_LBA; 48 49 /// 50 /// EFI_PEI_BLOCK_DEVICE_TYPE 51 /// 52 typedef enum { 53 LegacyFloppy = 0, ///< The recovery device is a floppy. 54 IdeCDROM = 1, ///< The recovery device is an IDE CD-ROM 55 IdeLS120 = 2, ///< The recovery device is an IDE LS-120 56 UsbMassStorage= 3, ///< The recovery device is a USB Mass Storage device 57 SD = 4, ///< The recovery device is a Secure Digital device 58 EMMC = 5, ///< The recovery device is a eMMC device 59 UfsDevice = 6, ///< The recovery device is a Universal Flash Storage device 60 MaxDeviceType 61 } EFI_PEI_BLOCK_DEVICE_TYPE; 62 63 /// 64 /// Specification inconsistency here: 65 /// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA. 66 /// Inconsistency exists in UEFI Platform Initialization Specification 1.2 67 /// Volume 1: Pre-EFI Initalization Core Interface, where all referrences to 68 /// this structure name are with the "EFI_" prefix, except for the definition 69 /// which is without "EFI_". So the name of PEI_BLOCK_IO_MEDIA is taken as the 70 /// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most of 71 /// the specification. 72 /// 73 typedef struct { 74 /// 75 /// The type of media device being referenced by DeviceIndex. 76 /// 77 EFI_PEI_BLOCK_DEVICE_TYPE DeviceType; 78 /// 79 /// A flag that indicates if media is present. This flag is always set for 80 /// nonremovable media devices. 81 /// 82 BOOLEAN MediaPresent; 83 /// 84 /// The last logical block that the device supports. 85 /// 86 UINTN LastBlock; 87 /// 88 /// The size of a logical block in bytes. 89 /// 90 UINTN BlockSize; 91 } EFI_PEI_BLOCK_IO_MEDIA; 92 93 /** 94 Gets the count of block I/O devices that one specific block driver detects. 95 96 This function is used for getting the count of block I/O devices that one 97 specific block driver detects. To the PEI ATAPI driver, it returns the number 98 of all the detected ATAPI devices it detects during the enumeration process. 99 To the PEI legacy floppy driver, it returns the number of all the legacy 100 devices it finds during its enumeration process. If no device is detected, 101 then the function will return zero. 102 103 @param[in] PeiServices General-purpose services that are available 104 to every PEIM. 105 @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI 106 instance. 107 @param[out] NumberBlockDevices The number of block I/O devices discovered. 108 109 @retval EFI_SUCCESS The operation performed successfully. 110 111 **/ 112 typedef 113 EFI_STATUS 114 (EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES)( 115 IN EFI_PEI_SERVICES **PeiServices, 116 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This, 117 OUT UINTN *NumberBlockDevices 118 ); 119 120 /** 121 Gets a block device's media information. 122 123 This function will provide the caller with the specified block device's media 124 information. If the media changes, calling this function will update the media 125 information accordingly. 126 127 @param[in] PeiServices General-purpose services that are available to every 128 PEIM 129 @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. 130 @param[in] DeviceIndex Specifies the block device to which the function wants 131 to talk. Because the driver that implements Block I/O 132 PPIs will manage multiple block devices, the PPIs that 133 want to talk to a single device must specify the 134 device index that was assigned during the enumeration 135 process. This index is a number from one to 136 NumberBlockDevices. 137 @param[out] MediaInfo The media information of the specified block media. 138 The caller is responsible for the ownership of this 139 data structure. 140 141 @par Note: 142 The MediaInfo structure describes an enumeration of possible block device 143 types. This enumeration exists because no device paths are actually passed 144 across interfaces that describe the type or class of hardware that is publishing 145 the block I/O interface. This enumeration will allow for policy decisions 146 in the Recovery PEIM, such as "Try to recover from legacy floppy first, 147 LS-120 second, CD-ROM third." If there are multiple partitions abstracted 148 by a given device type, they should be reported in ascending order; this 149 order also applies to nested partitions, such as legacy MBR, where the 150 outermost partitions would have precedence in the reporting order. The 151 same logic applies to systems such as IDE that have precedence relationships 152 like "Master/Slave" or "Primary/Secondary". The master device should be 153 reported first, the slave second. 154 155 @retval EFI_SUCCESS Media information about the specified block device 156 was obtained successfully. 157 @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware 158 error. 159 160 **/ 161 typedef 162 EFI_STATUS 163 (EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION)( 164 IN EFI_PEI_SERVICES **PeiServices, 165 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This, 166 IN UINTN DeviceIndex, 167 OUT EFI_PEI_BLOCK_IO_MEDIA *MediaInfo 168 ); 169 170 /** 171 Reads the requested number of blocks from the specified block device. 172 173 The function reads the requested number of blocks from the device. All the 174 blocks are read, or an error is returned. If there is no media in the device, 175 the function returns EFI_NO_MEDIA. 176 177 @param[in] PeiServices General-purpose services that are available to 178 every PEIM. 179 @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. 180 @param[in] DeviceIndex Specifies the block device to which the function wants 181 to talk. Because the driver that implements Block I/O 182 PPIs will manage multiple block devices, PPIs that 183 want to talk to a single device must specify the device 184 index that was assigned during the enumeration process. 185 This index is a number from one to NumberBlockDevices. 186 @param[in] StartLBA The starting logical block address (LBA) to read from 187 on the device 188 @param[in] BufferSize The size of the Buffer in bytes. This number must be 189 a multiple of the intrinsic block size of the device. 190 @param[out] Buffer A pointer to the destination buffer for the data. 191 The caller is responsible for the ownership of the 192 buffer. 193 194 @retval EFI_SUCCESS The data was read correctly from the device. 195 @retval EFI_DEVICE_ERROR The device reported an error while attempting 196 to perform the read operation. 197 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not 198 valid, or the buffer is not properly aligned. 199 @retval EFI_NO_MEDIA There is no media in the device. 200 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of 201 the intrinsic block size of the device. 202 203 **/ 204 typedef 205 EFI_STATUS 206 (EFIAPI *EFI_PEI_READ_BLOCKS)( 207 IN EFI_PEI_SERVICES **PeiServices, 208 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This, 209 IN UINTN DeviceIndex, 210 IN EFI_PEI_LBA StartLBA, 211 IN UINTN BufferSize, 212 OUT VOID *Buffer 213 ); 214 215 /// 216 /// EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required 217 /// to access a block I/O device during PEI recovery boot mode. 218 /// 219 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI { 220 /// 221 /// Gets the number of block I/O devices that the specific block driver manages. 222 /// 223 EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices; 224 225 /// 226 /// Gets the specified media information. 227 /// 228 EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo; 229 230 /// 231 /// Reads the requested number of blocks from the specified block device. 232 /// 233 EFI_PEI_READ_BLOCKS ReadBlocks; 234 }; 235 236 extern EFI_GUID gEfiPeiVirtualBlockIoPpiGuid; 237 238 #endif 239