Add the following PI 1.2 PPIs to the MdePkg
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BlockIo.h
CommitLineData
79964ac8 1/** @file\r
2 This file declares BlockIo PPI used to access block-oriented storage devices\r
3\r
2bbaeb0d 4 Copyright (c) 2007 - 2009, Intel Corporation\r
79964ac8 5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
79964ac8 13 @par Revision Reference:\r
14 This PPI is defined in Framework of EFI Recovery Spec\r
15 Version 0.9\r
16\r
17**/\r
18\r
19#ifndef _PEI_BLOCK_IO_H_\r
20#define _PEI_BLOCK_IO_H_\r
21\r
22#define EFI_PEI_IDE_BLOCK_IO_PPI \\r
23 { \\r
24 0x0964e5b22, 0x6459, 0x11d2, { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
25 }\r
26\r
27#define EFI_PEI_144_FLOPPY_BLOCK_IO_PPI \\r
28 { \\r
29 0xda6855bd, 0x07b7, 0x4c05, { 0x9e, 0xd8, 0xe2, 0x59, 0xfd, 0x36, 0x0e, 0x22 } \\r
30 }\r
31\r
32#define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \\r
33 { \\r
34 0x695d8aa1, 0x42ee, 0x4c46, { 0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \\r
35 }\r
36\r
37typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI;\r
38\r
39typedef UINT64 EFI_PEI_LBA;\r
40\r
41typedef enum {\r
42 LegacyFloppy = 0,\r
43 IdeCDROM = 1,\r
44 IdeLS120 = 2,\r
45 UsbMassStorage= 3,\r
46 MaxDeviceType\r
47} EFI_PEI_BLOCK_DEVICE_TYPE;\r
48\r
50877421 49///\r
50/// Inconsistent with specification here: \r
56fd2fa4 51/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.\r
52/// Inconsistency exists in Framework Recovery Specification, where all referrences to this\r
53/// structure name are with the "EFI_" prefix, except for the definition which is without "EFI_".\r
54/// So the name of PEI_BLOCK_IO_MEDIA is taken as the exception caused by mistake, and\r
55/// EFI_PEI_BLOCK_IO_MEDIA is used to comply with most part of the specification.\r
50877421 56///\r
79964ac8 57typedef struct {\r
58 EFI_PEI_BLOCK_DEVICE_TYPE DeviceType;\r
59 BOOLEAN MediaPresent;\r
60 UINTN LastBlock;\r
61 UINTN BlockSize;\r
62} EFI_PEI_BLOCK_IO_MEDIA;\r
63\r
64/**\r
65 Gets the count of block I/O devices that one specific block driver detects.\r
66\r
67 @param PeiServices General-purpose services that are available to every PEIM.\r
68 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
69 @param NumberBlockDevices The number of block I/O devices discovered.\r
70\r
71 @return Status code\r
72\r
73**/\r
74typedef\r
75EFI_STATUS\r
69686d56 76(EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES)(\r
79964ac8 77 IN EFI_PEI_SERVICES **PeiServices,\r
78 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r
79 OUT UINTN *NumberBlockDevices\r
80 );\r
81\r
82/**\r
83 Gets a block device's media information.\r
84\r
85 @param PeiServices General-purpose services that are available to every PEIM\r
86 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
87 @param DeviceIndex Specifies the block device to which the function\r
88 wants to talk. Because the driver that implements Block I/O PPIs\r
89 will manage multiple block devices, the PPIs that want to talk to a single\r
90 device must specify the device index that was assigned during the enumeration\r
91 process. This index is a number from one to NumberBlockDevices.\r
92 @param MediaInfo The media information of the specified block media.\r
93\r
94 @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.\r
95 @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.\r
96\r
97**/\r
98typedef\r
99EFI_STATUS\r
69686d56 100(EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION)(\r
79964ac8 101 IN EFI_PEI_SERVICES **PeiServices,\r
102 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r
103 IN UINTN DeviceIndex,\r
104 OUT EFI_PEI_BLOCK_IO_MEDIA *MediaInfo\r
105 );\r
106\r
107/**\r
108 Reads the requested number of blocks from the specified block device.\r
109\r
110 @param PeiServices General-purpose services that are available to every PEIM.\r
111 @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
112 @param DeviceIndex Specifies the block device to which the function wants to talk.\r
113 @param StartLBA The starting logical block address (LBA) to read from on the device\r
114 @param BufferSize The size of the Buffer in bytes. This number must\r
115 be a multiple of the intrinsic block size of the device.\r
116 @param Buffer A pointer to the destination buffer for the data.\r
117 The caller is responsible for the ownership of the buffer.\r
118\r
119 @retval EFI_SUCCESS The data was read correctly from the device.\r
120 @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
121 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
122 or the buffer is not properly aligned.\r
123 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of\r
124 the intrinsic block size of the device.\r
125 @retval EFI_NO_MEDIA There is no media in the device.\r
126\r
127**/\r
128typedef\r
129EFI_STATUS\r
69686d56 130(EFIAPI *EFI_PEI_READ_BLOCKS)(\r
79964ac8 131 IN EFI_PEI_SERVICES **PeiServices,\r
132 IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r
133 IN UINTN DeviceIndex,\r
134 IN EFI_PEI_LBA StartLBA,\r
135 IN UINTN BufferSize,\r
136 OUT VOID *Buffer\r
137 );\r
138\r
2bbaeb0d 139///\r
140/// EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
141/// to access a block I/O device during PEI recovery boot mode.\r
142///\r
79964ac8 143struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {\r
2bbaeb0d 144 ///\r
145 /// Gets the number of block I/O devices that the specific block driver manages.\r
146 ///\r
79964ac8 147 EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices;\r
2bbaeb0d 148 \r
149 ///\r
150 /// Gets the specified media information.\r
151 ///\r
79964ac8 152 EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo;\r
2bbaeb0d 153 \r
154 ///\r
155 /// Reads the requested number of blocks from the specified block device.\r
156 ///\r
79964ac8 157 EFI_PEI_READ_BLOCKS ReadBlocks;\r
158};\r
159\r
160extern EFI_GUID gEfiPeiIdeBlockIoPpiGuid;\r
161extern EFI_GUID gEfiPei144FloppyBlockIoPpiGuid;\r
162extern EFI_GUID gEfiPeiVirtualBlockIoPpiGuid;\r
163\r
164#endif\r