79964ac8 |
1 | /** @file\r |
2 | This file declares BlockIo PPI used to access block-oriented storage devices\r |
3 | \r |
4 | Copyright (c) 2007, Intel Corporation\r |
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 |
13 | Module Name: BlockIo.h\r |
14 | \r |
15 | @par Revision Reference:\r |
16 | This PPI is defined in Framework of EFI Recovery Spec\r |
17 | Version 0.9\r |
18 | \r |
19 | **/\r |
20 | \r |
21 | #ifndef _PEI_BLOCK_IO_H_\r |
22 | #define _PEI_BLOCK_IO_H_\r |
23 | \r |
b80fbe85 |
24 | #include <PiPei.h>\r |
25 | \r |
79964ac8 |
26 | #define EFI_PEI_IDE_BLOCK_IO_PPI \\r |
27 | { \\r |
28 | 0x0964e5b22, 0x6459, 0x11d2, { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r |
29 | }\r |
30 | \r |
31 | #define EFI_PEI_144_FLOPPY_BLOCK_IO_PPI \\r |
32 | { \\r |
33 | 0xda6855bd, 0x07b7, 0x4c05, { 0x9e, 0xd8, 0xe2, 0x59, 0xfd, 0x36, 0x0e, 0x22 } \\r |
34 | }\r |
35 | \r |
36 | #define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \\r |
37 | { \\r |
38 | 0x695d8aa1, 0x42ee, 0x4c46, { 0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \\r |
39 | }\r |
40 | \r |
41 | typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI;\r |
42 | \r |
43 | typedef UINT64 EFI_PEI_LBA;\r |
44 | \r |
45 | typedef enum {\r |
46 | LegacyFloppy = 0,\r |
47 | IdeCDROM = 1,\r |
48 | IdeLS120 = 2,\r |
49 | UsbMassStorage= 3,\r |
50 | MaxDeviceType\r |
51 | } EFI_PEI_BLOCK_DEVICE_TYPE;\r |
52 | \r |
53 | typedef struct {\r |
54 | EFI_PEI_BLOCK_DEVICE_TYPE DeviceType;\r |
55 | BOOLEAN MediaPresent;\r |
56 | UINTN LastBlock;\r |
57 | UINTN BlockSize;\r |
58 | } EFI_PEI_BLOCK_IO_MEDIA;\r |
59 | \r |
60 | /**\r |
61 | Gets the count of block I/O devices that one specific block driver detects.\r |
62 | \r |
63 | @param PeiServices General-purpose services that are available to every PEIM.\r |
64 | @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r |
65 | @param NumberBlockDevices The number of block I/O devices discovered.\r |
66 | \r |
67 | @return Status code\r |
68 | \r |
69 | **/\r |
70 | typedef\r |
71 | EFI_STATUS\r |
69686d56 |
72 | (EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES)(\r |
79964ac8 |
73 | IN EFI_PEI_SERVICES **PeiServices,\r |
74 | IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r |
75 | OUT UINTN *NumberBlockDevices\r |
76 | );\r |
77 | \r |
78 | /**\r |
79 | Gets a block device's media information.\r |
80 | \r |
81 | @param PeiServices General-purpose services that are available to every PEIM\r |
82 | @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r |
83 | @param DeviceIndex Specifies the block device to which the function\r |
84 | wants to talk. Because the driver that implements Block I/O PPIs\r |
85 | will manage multiple block devices, the PPIs that want to talk to a single\r |
86 | device must specify the device index that was assigned during the enumeration\r |
87 | process. This index is a number from one to NumberBlockDevices.\r |
88 | @param MediaInfo The media information of the specified block media.\r |
89 | \r |
90 | @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.\r |
91 | @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.\r |
92 | \r |
93 | **/\r |
94 | typedef\r |
95 | EFI_STATUS\r |
69686d56 |
96 | (EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION)(\r |
79964ac8 |
97 | IN EFI_PEI_SERVICES **PeiServices,\r |
98 | IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r |
99 | IN UINTN DeviceIndex,\r |
100 | OUT EFI_PEI_BLOCK_IO_MEDIA *MediaInfo\r |
101 | );\r |
102 | \r |
103 | /**\r |
104 | Reads the requested number of blocks from the specified block device.\r |
105 | \r |
106 | @param PeiServices General-purpose services that are available to every PEIM.\r |
107 | @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r |
108 | @param DeviceIndex Specifies the block device to which the function wants to talk.\r |
109 | @param StartLBA The starting logical block address (LBA) to read from on the device\r |
110 | @param BufferSize The size of the Buffer in bytes. This number must\r |
111 | be a multiple of the intrinsic block size of the device.\r |
112 | @param Buffer A pointer to the destination buffer for the data.\r |
113 | The caller is responsible for the ownership of the buffer.\r |
114 | \r |
115 | @retval EFI_SUCCESS The data was read correctly from the device.\r |
116 | @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r |
117 | @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r |
118 | or the buffer is not properly aligned.\r |
119 | @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of\r |
120 | the intrinsic block size of the device.\r |
121 | @retval EFI_NO_MEDIA There is no media in the device.\r |
122 | \r |
123 | **/\r |
124 | typedef\r |
125 | EFI_STATUS\r |
69686d56 |
126 | (EFIAPI *EFI_PEI_READ_BLOCKS)(\r |
79964ac8 |
127 | IN EFI_PEI_SERVICES **PeiServices,\r |
128 | IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *This,\r |
129 | IN UINTN DeviceIndex,\r |
130 | IN EFI_PEI_LBA StartLBA,\r |
131 | IN UINTN BufferSize,\r |
132 | OUT VOID *Buffer\r |
133 | );\r |
134 | \r |
135 | /**\r |
136 | @par Ppi Description:\r |
137 | EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r |
138 | to access a block I/O device during PEI recovery boot mode.\r |
139 | \r |
140 | @param GetNumberOfBlockDevices\r |
141 | Gets the number of block I/O devices that the specific block driver manages.\r |
142 | \r |
143 | @param GetBlockDeviceMediaInfo\r |
144 | Gets the specified media information.\r |
145 | \r |
146 | @param ReadBlocks\r |
147 | Reads the requested number of blocks from the specified block device.\r |
148 | \r |
149 | **/\r |
150 | struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {\r |
151 | EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices;\r |
152 | EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo;\r |
153 | EFI_PEI_READ_BLOCKS ReadBlocks;\r |
154 | };\r |
155 | \r |
156 | extern EFI_GUID gEfiPeiIdeBlockIoPpiGuid;\r |
157 | extern EFI_GUID gEfiPei144FloppyBlockIoPpiGuid;\r |
158 | extern EFI_GUID gEfiPeiVirtualBlockIoPpiGuid;\r |
159 | \r |
160 | #endif\r |