]>
Commit | Line | Data |
---|---|---|
1 | /**@file\r | |
2 | \r | |
3 | Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r | |
4 | This program and the accompanying materials \r | |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | FwBlockService.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Firmware volume block driver for Intel Firmware Hub (FWH) device\r | |
19 | \r | |
20 | **/\r | |
21 | \r | |
22 | #ifndef _FW_BLOCK_SERVICE_H\r | |
23 | #define _FW_BLOCK_SERVICE_H\r | |
24 | \r | |
25 | //\r | |
26 | // BugBug: Add documentation here for data structure!!!!\r | |
27 | //\r | |
28 | #define FVB_PHYSICAL 0\r | |
29 | #define FVB_VIRTUAL 1\r | |
30 | \r | |
31 | typedef struct {\r | |
32 | EFI_LOCK FvbDevLock;\r | |
33 | UINTN FvBase[2];\r | |
34 | UINTN NumOfBlocks;\r | |
35 | EFI_FIRMWARE_VOLUME_HEADER VolumeHeader;\r | |
36 | } EFI_FW_VOL_INSTANCE;\r | |
37 | \r | |
38 | typedef struct {\r | |
39 | UINT32 NumFv;\r | |
40 | EFI_FW_VOL_INSTANCE *FvInstance[2];\r | |
41 | UINT8 *FvbScratchSpace[2];\r | |
42 | } ESAL_FWB_GLOBAL;\r | |
43 | \r | |
44 | //\r | |
45 | // Fvb Protocol instance data\r | |
46 | //\r | |
47 | #define FVB_DEVICE_FROM_THIS(a) CR (a, EFI_FW_VOL_BLOCK_DEVICE, FwVolBlockInstance, FVB_DEVICE_SIGNATURE)\r | |
48 | #define FVB_EXTEND_DEVICE_FROM_THIS(a) CR (a, EFI_FW_VOL_BLOCK_DEVICE, FvbExtension, FVB_DEVICE_SIGNATURE)\r | |
49 | #define FVB_DEVICE_SIGNATURE SIGNATURE_32 ('F', 'V', 'B', 'N')\r | |
50 | \r | |
51 | typedef struct {\r | |
52 | MEDIA_FW_VOL_DEVICE_PATH FvDevPath;\r | |
53 | EFI_DEVICE_PATH_PROTOCOL EndDevPath;\r | |
54 | } FV_PIWG_DEVICE_PATH;\r | |
55 | \r | |
56 | typedef struct {\r | |
57 | MEMMAP_DEVICE_PATH MemMapDevPath;\r | |
58 | EFI_DEVICE_PATH_PROTOCOL EndDevPath;\r | |
59 | } FV_MEMMAP_DEVICE_PATH;\r | |
60 | \r | |
61 | typedef struct {\r | |
62 | UINTN Signature;\r | |
63 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
64 | UINTN Instance;\r | |
65 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FwVolBlockInstance;\r | |
66 | } EFI_FW_VOL_BLOCK_DEVICE;\r | |
67 | \r | |
68 | EFI_STATUS\r | |
69 | GetFvbInfo (\r | |
70 | IN UINT64 FvLength,\r | |
71 | OUT EFI_FIRMWARE_VOLUME_HEADER **FvbInfo\r | |
72 | );\r | |
73 | \r | |
74 | EFI_STATUS\r | |
75 | FvbReadBlock (\r | |
76 | IN UINTN Instance,\r | |
77 | IN EFI_LBA Lba,\r | |
78 | IN UINTN BlockOffset,\r | |
79 | IN OUT UINTN *NumBytes,\r | |
80 | IN UINT8 *Buffer,\r | |
81 | IN ESAL_FWB_GLOBAL *Global,\r | |
82 | IN BOOLEAN Virtual\r | |
83 | );\r | |
84 | \r | |
85 | EFI_STATUS\r | |
86 | FvbWriteBlock (\r | |
87 | IN UINTN Instance,\r | |
88 | IN CONST EFI_LBA Lba,\r | |
89 | IN CONST UINTN BlockOffset,\r | |
90 | IN OUT UINTN *NumBytes,\r | |
91 | IN CONST UINT8 *Buffer,\r | |
92 | IN ESAL_FWB_GLOBAL *Global,\r | |
93 | IN BOOLEAN Virtual\r | |
94 | );\r | |
95 | \r | |
96 | EFI_STATUS\r | |
97 | FvbEraseBlock (\r | |
98 | IN UINTN Instance,\r | |
99 | IN EFI_LBA Lba,\r | |
100 | IN ESAL_FWB_GLOBAL *Global,\r | |
101 | IN BOOLEAN Virtual\r | |
102 | );\r | |
103 | \r | |
104 | EFI_STATUS\r | |
105 | FvbSetVolumeAttributes (\r | |
106 | IN UINTN Instance,\r | |
107 | IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes,\r | |
108 | IN ESAL_FWB_GLOBAL *Global,\r | |
109 | IN BOOLEAN Virtual\r | |
110 | );\r | |
111 | \r | |
112 | EFI_STATUS\r | |
113 | FvbGetVolumeAttributes (\r | |
114 | IN UINTN Instance,\r | |
115 | OUT EFI_FVB_ATTRIBUTES_2 *Attributes,\r | |
116 | IN ESAL_FWB_GLOBAL *Global,\r | |
117 | IN BOOLEAN Virtual\r | |
118 | );\r | |
119 | \r | |
120 | EFI_STATUS\r | |
121 | FvbGetPhysicalAddress (\r | |
122 | IN UINTN Instance,\r | |
123 | OUT EFI_PHYSICAL_ADDRESS *Address,\r | |
124 | IN ESAL_FWB_GLOBAL *Global,\r | |
125 | IN BOOLEAN Virtual\r | |
126 | );\r | |
127 | \r | |
128 | EFI_STATUS\r | |
129 | EFIAPI\r | |
130 | FvbInitialize (\r | |
131 | IN EFI_HANDLE ImageHandle,\r | |
132 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
133 | );\r | |
134 | \r | |
135 | \r | |
136 | VOID\r | |
137 | EFIAPI\r | |
138 | FvbClassAddressChangeEvent (\r | |
139 | IN EFI_EVENT Event,\r | |
140 | IN VOID *Context\r | |
141 | );\r | |
142 | \r | |
143 | EFI_STATUS\r | |
144 | FvbGetLbaAddress (\r | |
145 | IN UINTN Instance,\r | |
146 | IN EFI_LBA Lba,\r | |
147 | OUT UINTN *LbaAddress,\r | |
148 | OUT UINTN *LbaLength,\r | |
149 | OUT UINTN *NumOfBlocks,\r | |
150 | IN ESAL_FWB_GLOBAL *Global,\r | |
151 | IN BOOLEAN Virtual\r | |
152 | );\r | |
153 | \r | |
154 | //\r | |
155 | // Protocol APIs\r | |
156 | //\r | |
157 | EFI_STATUS\r | |
158 | EFIAPI\r | |
159 | FvbProtocolGetAttributes (\r | |
160 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
161 | OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r | |
162 | );\r | |
163 | \r | |
164 | EFI_STATUS\r | |
165 | EFIAPI\r | |
166 | FvbProtocolSetAttributes (\r | |
167 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
168 | IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r | |
169 | );\r | |
170 | \r | |
171 | EFI_STATUS\r | |
172 | EFIAPI\r | |
173 | FvbProtocolGetPhysicalAddress (\r | |
174 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
175 | OUT EFI_PHYSICAL_ADDRESS *Address\r | |
176 | );\r | |
177 | \r | |
178 | EFI_STATUS\r | |
179 | EFIAPI\r | |
180 | FvbProtocolGetBlockSize (\r | |
181 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
182 | IN CONST EFI_LBA Lba,\r | |
183 | OUT UINTN *BlockSize,\r | |
184 | OUT UINTN *NumOfBlocks\r | |
185 | );\r | |
186 | \r | |
187 | EFI_STATUS\r | |
188 | EFIAPI\r | |
189 | FvbProtocolRead (\r | |
190 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
191 | IN CONST EFI_LBA Lba,\r | |
192 | IN CONST UINTN Offset,\r | |
193 | IN OUT UINTN *NumBytes,\r | |
194 | IN UINT8 *Buffer\r | |
195 | );\r | |
196 | \r | |
197 | EFI_STATUS\r | |
198 | EFIAPI\r | |
199 | FvbProtocolWrite (\r | |
200 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
201 | IN EFI_LBA Lba,\r | |
202 | IN UINTN Offset,\r | |
203 | IN OUT UINTN *NumBytes,\r | |
204 | IN UINT8 *Buffer\r | |
205 | );\r | |
206 | \r | |
207 | EFI_STATUS\r | |
208 | EFIAPI\r | |
209 | FvbProtocolEraseBlocks (\r | |
210 | IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r | |
211 | ...\r | |
212 | );\r | |
213 | \r | |
214 | #endif\r |