]>
Commit | Line | Data |
---|---|---|
b9ec9330 QH |
1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2005 - 2007, Intel Corporation\r | |
4 | All rights reserved. This program and the accompanying materials are licensed and made available\r | |
5 | under the terms and conditions of the BSD License which accompanies this\r | |
6 | 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 | \r | |
13 | Module Name:\r | |
14 | \r | |
15 | Fat.c\r | |
16 | \r | |
17 | Abstract:\r | |
18 | \r | |
19 | Fat File System driver routines that support EFI driver model\r | |
20 | \r | |
21 | --*/\r | |
22 | \r | |
23 | #include "Fat.h"\r | |
24 | \r | |
25 | EFI_STATUS\r | |
26 | EFIAPI\r | |
27 | FatEntryPoint (\r | |
28 | IN EFI_HANDLE ImageHandle,\r | |
29 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
30 | );\r | |
31 | \r | |
32 | EFI_STATUS\r | |
33 | EFIAPI\r | |
34 | FatUnload (\r | |
35 | IN EFI_HANDLE ImageHandle\r | |
36 | );\r | |
37 | \r | |
38 | EFI_STATUS\r | |
39 | EFIAPI\r | |
40 | FatDriverBindingSupported (\r | |
41 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
42 | IN EFI_HANDLE Controller,\r | |
43 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
44 | );\r | |
45 | \r | |
46 | EFI_STATUS\r | |
47 | EFIAPI\r | |
48 | FatDriverBindingStart (\r | |
49 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
50 | IN EFI_HANDLE Controller,\r | |
51 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
52 | );\r | |
53 | \r | |
54 | EFI_STATUS\r | |
55 | EFIAPI\r | |
56 | FatDriverBindingStop (\r | |
57 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
58 | IN EFI_HANDLE Controller,\r | |
59 | IN UINTN NumberOfChildren,\r | |
60 | IN EFI_HANDLE *ChildHandleBuffer\r | |
61 | );\r | |
62 | \r | |
63 | //\r | |
64 | // DriverBinding protocol instance\r | |
65 | //\r | |
66 | EFI_DRIVER_BINDING_PROTOCOL gFatDriverBinding = {\r | |
67 | FatDriverBindingSupported,\r | |
68 | FatDriverBindingStart,\r | |
69 | FatDriverBindingStop,\r | |
70 | 0xa,\r | |
71 | NULL,\r | |
72 | NULL\r | |
73 | };\r | |
74 | \r | |
75 | EFI_STATUS\r | |
76 | EFIAPI\r | |
77 | FatEntryPoint (\r | |
78 | IN EFI_HANDLE ImageHandle,\r | |
79 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
80 | )\r | |
81 | /*++\r | |
82 | \r | |
83 | Routine Description:\r | |
84 | \r | |
85 | Register Driver Binding protocol for this driver.\r | |
86 | \r | |
87 | Arguments:\r | |
88 | \r | |
89 | ImageHandle - Handle for the image of this driver.\r | |
90 | SystemTable - Pointer to the EFI System Table.\r | |
91 | \r | |
92 | Returns:\r | |
93 | \r | |
94 | EFI_SUCCESS - Driver loaded.\r | |
95 | other - Driver not loaded.\r | |
96 | \r | |
97 | --*/\r | |
98 | {\r | |
99 | EFI_STATUS Status;\r | |
100 | \r | |
101 | //\r | |
102 | // Initialize the EFI Driver Library\r | |
103 | //\r | |
104 | Status = EfiLibInstallDriverBindingComponentName2 (\r | |
105 | ImageHandle,\r | |
106 | SystemTable,\r | |
107 | &gFatDriverBinding,\r | |
108 | ImageHandle,\r | |
109 | &gFatComponentName,\r | |
110 | &gFatComponentName2\r | |
111 | );\r | |
112 | ASSERT_EFI_ERROR (Status);\r | |
113 | \r | |
114 | return Status;\r | |
115 | }\r | |
116 | \r | |
117 | EFI_STATUS\r | |
118 | EFIAPI\r | |
119 | FatUnload (\r | |
120 | IN EFI_HANDLE ImageHandle\r | |
121 | )\r | |
122 | /*++\r | |
123 | \r | |
124 | Routine Description:\r | |
125 | \r | |
126 | Unload function for this image. Uninstall DriverBinding protocol.\r | |
127 | \r | |
128 | Arguments:\r | |
129 | \r | |
130 | ImageHandle - Handle for the image of this driver.\r | |
131 | \r | |
132 | Returns:\r | |
133 | \r | |
134 | EFI_SUCCESS - Driver unloaded successfully.\r | |
135 | other - Driver can not unloaded.\r | |
136 | \r | |
137 | --*/\r | |
138 | {\r | |
139 | EFI_STATUS Status;\r | |
140 | EFI_HANDLE *DeviceHandleBuffer;\r | |
141 | UINTN DeviceHandleCount;\r | |
142 | UINTN Index;\r | |
143 | \r | |
144 | Status = gBS->LocateHandleBuffer (\r | |
145 | AllHandles,\r | |
146 | NULL,\r | |
147 | NULL,\r | |
148 | &DeviceHandleCount,\r | |
149 | &DeviceHandleBuffer\r | |
150 | );\r | |
151 | if (!EFI_ERROR (Status)) {\r | |
152 | for (Index = 0; Index < DeviceHandleCount; Index++) {\r | |
153 | Status = gBS->DisconnectController (\r | |
154 | DeviceHandleBuffer[Index],\r | |
155 | ImageHandle,\r | |
156 | NULL\r | |
157 | );\r | |
158 | }\r | |
159 | \r | |
160 | if (DeviceHandleBuffer != NULL) {\r | |
161 | FreePool (DeviceHandleBuffer);\r | |
162 | }\r | |
163 | }\r | |
164 | \r | |
165 | return Status;\r | |
166 | }\r | |
167 | \r | |
168 | EFI_STATUS\r | |
169 | EFIAPI\r | |
170 | FatDriverBindingSupported (\r | |
171 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
172 | IN EFI_HANDLE ControllerHandle,\r | |
173 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
174 | )\r | |
175 | /*++\r | |
176 | \r | |
177 | Routine Description:\r | |
178 | \r | |
179 | Test to see if this driver can add a file system to ControllerHandle.\r | |
180 | ControllerHandle must support both Disk IO and Block IO protocols.\r | |
181 | \r | |
182 | Arguments:\r | |
183 | \r | |
184 | This - Protocol instance pointer.\r | |
185 | ControllerHandle - Handle of device to test.\r | |
186 | RemainingDevicePath - Not used.\r | |
187 | \r | |
188 | Returns:\r | |
189 | \r | |
190 | EFI_SUCCESS - This driver supports this device.\r | |
191 | EFI_ALREADY_STARTED - This driver is already running on this device.\r | |
192 | other - This driver does not support this device.\r | |
193 | \r | |
194 | --*/\r | |
195 | {\r | |
196 | EFI_STATUS Status;\r | |
197 | EFI_DISK_IO_PROTOCOL *DiskIo;\r | |
198 | \r | |
199 | //\r | |
200 | // Open the IO Abstraction(s) needed to perform the supported test\r | |
201 | //\r | |
202 | Status = gBS->OpenProtocol (\r | |
203 | ControllerHandle,\r | |
204 | &gEfiDiskIoProtocolGuid,\r | |
205 | (VOID **) &DiskIo,\r | |
206 | This->DriverBindingHandle,\r | |
207 | ControllerHandle,\r | |
208 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
209 | );\r | |
210 | \r | |
211 | if (EFI_ERROR (Status)) {\r | |
212 | return Status;\r | |
213 | }\r | |
214 | //\r | |
215 | // Close the I/O Abstraction(s) used to perform the supported test\r | |
216 | //\r | |
217 | gBS->CloseProtocol (\r | |
218 | ControllerHandle,\r | |
219 | &gEfiDiskIoProtocolGuid,\r | |
220 | This->DriverBindingHandle,\r | |
221 | ControllerHandle\r | |
222 | );\r | |
223 | \r | |
224 | //\r | |
225 | // Open the IO Abstraction(s) needed to perform the supported test\r | |
226 | //\r | |
227 | Status = gBS->OpenProtocol (\r | |
228 | ControllerHandle,\r | |
229 | &gEfiBlockIoProtocolGuid,\r | |
230 | NULL,\r | |
231 | This->DriverBindingHandle,\r | |
232 | ControllerHandle,\r | |
233 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
234 | );\r | |
235 | \r | |
236 | return Status;\r | |
237 | }\r | |
238 | \r | |
239 | EFI_STATUS\r | |
240 | EFIAPI\r | |
241 | FatDriverBindingStart (\r | |
242 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
243 | IN EFI_HANDLE ControllerHandle,\r | |
244 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
245 | )\r | |
246 | /*++\r | |
247 | \r | |
248 | Routine Description:\r | |
249 | \r | |
250 | Start this driver on ControllerHandle by opening a Block IO and Disk IO\r | |
251 | protocol, reading Device Path. Add a Simple File System protocol to\r | |
252 | ControllerHandle if the media contains a valid file system.\r | |
253 | \r | |
254 | Arguments:\r | |
255 | \r | |
256 | This - Protocol instance pointer.\r | |
257 | ControllerHandle - Handle of device to bind driver to.\r | |
258 | RemainingDevicePath - Not used.\r | |
259 | \r | |
260 | Returns:\r | |
261 | \r | |
262 | EFI_SUCCESS - This driver is added to DeviceHandle.\r | |
263 | EFI_ALREADY_STARTED - This driver is already running on DeviceHandle.\r | |
264 | EFI_OUT_OF_RESOURCES - Can not allocate the memory.\r | |
265 | other - This driver does not support this device.\r | |
266 | \r | |
267 | --*/\r | |
268 | {\r | |
269 | EFI_STATUS Status;\r | |
270 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
271 | EFI_DISK_IO_PROTOCOL *DiskIo;\r | |
272 | \r | |
273 | Status = InitializeUnicodeCollationSupport (This->DriverBindingHandle);\r | |
274 | if (EFI_ERROR (Status)) {\r | |
275 | return Status;\r | |
276 | }\r | |
277 | //\r | |
278 | // Open our required BlockIo and DiskIo\r | |
279 | //\r | |
280 | Status = gBS->OpenProtocol (\r | |
281 | ControllerHandle,\r | |
282 | &gEfiBlockIoProtocolGuid,\r | |
283 | (VOID **) &BlockIo,\r | |
284 | This->DriverBindingHandle,\r | |
285 | ControllerHandle,\r | |
286 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
287 | );\r | |
288 | if (EFI_ERROR (Status)) {\r | |
289 | return Status;\r | |
290 | }\r | |
291 | \r | |
292 | Status = gBS->OpenProtocol (\r | |
293 | ControllerHandle,\r | |
294 | &gEfiDiskIoProtocolGuid,\r | |
295 | (VOID **) &DiskIo,\r | |
296 | This->DriverBindingHandle,\r | |
297 | ControllerHandle,\r | |
298 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
299 | );\r | |
300 | if (EFI_ERROR (Status)) {\r | |
301 | return Status;\r | |
302 | }\r | |
303 | //\r | |
304 | // Allocate Volume structure. In FatAllocateVolume(), Resources\r | |
305 | // are allocated with protocol installed and cached initialized\r | |
306 | //\r | |
307 | Status = FatAllocateVolume (ControllerHandle, DiskIo, BlockIo);\r | |
308 | \r | |
309 | //\r | |
310 | // When the media changes on a device it will Reinstall the BlockIo interaface.\r | |
311 | // This will cause a call to our Stop(), and a subsequent reentrant call to our\r | |
312 | // Start() successfully. We should leave the device open when this happen.\r | |
313 | //\r | |
314 | if (EFI_ERROR (Status)) {\r | |
315 | Status = gBS->OpenProtocol (\r | |
316 | ControllerHandle,\r | |
317 | &gEfiSimpleFileSystemProtocolGuid,\r | |
318 | NULL,\r | |
319 | This->DriverBindingHandle,\r | |
320 | ControllerHandle,\r | |
321 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
322 | );\r | |
323 | if (EFI_ERROR (Status)) {\r | |
324 | gBS->CloseProtocol (\r | |
325 | ControllerHandle,\r | |
326 | &gEfiDiskIoProtocolGuid,\r | |
327 | This->DriverBindingHandle,\r | |
328 | ControllerHandle\r | |
329 | );\r | |
330 | }\r | |
331 | }\r | |
332 | \r | |
333 | return Status;\r | |
334 | }\r | |
335 | \r | |
336 | EFI_STATUS\r | |
337 | EFIAPI\r | |
338 | FatDriverBindingStop (\r | |
339 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
340 | IN EFI_HANDLE ControllerHandle,\r | |
341 | IN UINTN NumberOfChildren,\r | |
342 | IN EFI_HANDLE *ChildHandleBuffer\r | |
343 | )\r | |
344 | /*++\r | |
345 | \r | |
346 | Routine Description:\r | |
347 | Stop this driver on ControllerHandle.\r | |
348 | \r | |
349 | Arguments:\r | |
350 | This - Protocol instance pointer.\r | |
351 | ControllerHandle - Handle of device to stop driver on.\r | |
352 | NumberOfChildren - Not used.\r | |
353 | ChildHandleBuffer - Not used.\r | |
354 | \r | |
355 | Returns:\r | |
356 | EFI_SUCCESS - This driver is removed DeviceHandle.\r | |
357 | other - This driver was not removed from this device.\r | |
358 | \r | |
359 | --*/\r | |
360 | {\r | |
361 | EFI_STATUS Status;\r | |
362 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *FileSystem;\r | |
363 | FAT_VOLUME *Volume;\r | |
364 | \r | |
365 | //\r | |
366 | // Get our context back\r | |
367 | //\r | |
368 | Status = gBS->OpenProtocol (\r | |
369 | ControllerHandle,\r | |
370 | &gEfiSimpleFileSystemProtocolGuid,\r | |
371 | (VOID **) &FileSystem,\r | |
372 | This->DriverBindingHandle,\r | |
373 | ControllerHandle,\r | |
374 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
375 | );\r | |
376 | \r | |
377 | if (!EFI_ERROR (Status)) {\r | |
378 | Volume = VOLUME_FROM_VOL_INTERFACE (FileSystem);\r | |
379 | Status = FatAbandonVolume (Volume);\r | |
380 | if (EFI_ERROR (Status)) {\r | |
381 | return Status;\r | |
382 | }\r | |
383 | }\r | |
384 | \r | |
385 | Status = gBS->CloseProtocol (\r | |
386 | ControllerHandle,\r | |
387 | &gEfiDiskIoProtocolGuid,\r | |
388 | This->DriverBindingHandle,\r | |
389 | ControllerHandle\r | |
390 | );\r | |
391 | \r | |
392 | return Status;\r | |
393 | }\r |