]>
Commit | Line | Data |
---|---|---|
adbcbf8f | 1 | /** @file\r |
ff61847d | 2 | DiskIo driver that lays on every BlockIo protocol in the system.\r |
adbcbf8f | 3 | DiskIo converts a block oriented device to a byte oriented device.\r |
4 | \r | |
ff61847d | 5 | Disk access may have to handle unaligned request about sector boundaries.\r |
adbcbf8f | 6 | There are three cases:\r |
7 | UnderRun - The first byte is not on a sector boundary or the read request is\r | |
8 | less than a sector in length.\r | |
9 | Aligned - A read of N contiguous sectors.\r | |
10 | OverRun - The last byte is not on a sector boundary.\r | |
11 | \r | |
bf5a9493 | 12 | Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 13 | This program and the accompanying materials\r |
f42be642 | 14 | are licensed and made available under the terms and conditions of the BSD License\r |
15 | which accompanies this distribution. The full text of the license may be found at\r | |
16 | http://opensource.org/licenses/bsd-license.php\r | |
17 | \r | |
18 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
19 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
adbcbf8f | 20 | \r |
21 | **/\r | |
22 | \r | |
23 | #include "DiskIo.h"\r | |
24 | \r | |
ff61847d | 25 | //\r |
26 | // Driver binding protocol implementation for DiskIo driver.\r | |
27 | //\r | |
adbcbf8f | 28 | EFI_DRIVER_BINDING_PROTOCOL gDiskIoDriverBinding = {\r |
29 | DiskIoDriverBindingSupported,\r | |
30 | DiskIoDriverBindingStart,\r | |
31 | DiskIoDriverBindingStop,\r | |
32 | 0xa,\r | |
33 | NULL,\r | |
34 | NULL\r | |
35 | };\r | |
36 | \r | |
ff61847d | 37 | //\r |
38 | // Template for DiskIo private data structure.\r | |
39 | // The pointer to BlockIo protocol interface is assigned dynamically.\r | |
40 | //\r | |
adbcbf8f | 41 | DISK_IO_PRIVATE_DATA gDiskIoPrivateDataTemplate = {\r |
42 | DISK_IO_PRIVATE_DATA_SIGNATURE,\r | |
43 | {\r | |
44 | EFI_DISK_IO_PROTOCOL_REVISION,\r | |
45 | DiskIoReadDisk,\r | |
46 | DiskIoWriteDisk\r | |
47 | },\r | |
493d8e3a RN |
48 | {\r |
49 | EFI_DISK_IO2_PROTOCOL_REVISION,\r | |
50 | DiskIo2Cancel,\r | |
51 | DiskIo2ReadDiskEx,\r | |
52 | DiskIo2WriteDiskEx,\r | |
53 | DiskIo2FlushDiskEx\r | |
54 | }\r | |
adbcbf8f | 55 | };\r |
56 | \r | |
adbcbf8f | 57 | /**\r |
58 | Test to see if this driver supports ControllerHandle. \r | |
59 | \r | |
60 | @param This Protocol instance pointer.\r | |
61 | @param ControllerHandle Handle of device to test\r | |
62 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
63 | device to start.\r | |
64 | \r | |
65 | @retval EFI_SUCCESS This driver supports this device\r | |
66 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
67 | @retval other This driver does not support this device\r | |
68 | \r | |
69 | **/\r | |
70 | EFI_STATUS\r | |
71 | EFIAPI\r | |
72 | DiskIoDriverBindingSupported (\r | |
73 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
74 | IN EFI_HANDLE ControllerHandle,\r | |
75 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
76 | )\r | |
77 | {\r | |
78 | EFI_STATUS Status;\r | |
79 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
80 | \r | |
81 | //\r | |
82 | // Open the IO Abstraction(s) needed to perform the supported test.\r | |
83 | //\r | |
84 | Status = gBS->OpenProtocol (\r | |
85 | ControllerHandle,\r | |
86 | &gEfiBlockIoProtocolGuid,\r | |
87 | (VOID **) &BlockIo,\r | |
88 | This->DriverBindingHandle,\r | |
89 | ControllerHandle,\r | |
90 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
91 | );\r | |
92 | if (EFI_ERROR (Status)) {\r | |
93 | return Status;\r | |
94 | }\r | |
95 | \r | |
96 | //\r | |
97 | // Close the I/O Abstraction(s) used to perform the supported test.\r | |
98 | //\r | |
99 | gBS->CloseProtocol (\r | |
493d8e3a RN |
100 | ControllerHandle,\r |
101 | &gEfiBlockIoProtocolGuid,\r | |
102 | This->DriverBindingHandle,\r | |
103 | ControllerHandle\r | |
104 | );\r | |
adbcbf8f | 105 | return EFI_SUCCESS;\r |
106 | }\r | |
107 | \r | |
108 | \r | |
109 | /**\r | |
110 | Start this driver on ControllerHandle by opening a Block IO protocol and\r | |
111 | installing a Disk IO protocol on ControllerHandle.\r | |
112 | \r | |
113 | @param This Protocol instance pointer.\r | |
114 | @param ControllerHandle Handle of device to bind driver to\r | |
115 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
116 | device to start.\r | |
117 | \r | |
118 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
119 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
120 | @retval other This driver does not support this device\r | |
121 | \r | |
122 | **/\r | |
123 | EFI_STATUS\r | |
124 | EFIAPI\r | |
125 | DiskIoDriverBindingStart (\r | |
126 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
127 | IN EFI_HANDLE ControllerHandle,\r | |
128 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
129 | )\r | |
130 | {\r | |
131 | EFI_STATUS Status;\r | |
493d8e3a | 132 | DISK_IO_PRIVATE_DATA *Instance;\r |
15cc67e6 | 133 | EFI_TPL OldTpl;\r |
493d8e3a RN |
134 | \r |
135 | Instance = NULL;\r | |
adbcbf8f | 136 | \r |
15cc67e6 | 137 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
adbcbf8f | 138 | \r |
139 | //\r | |
493d8e3a | 140 | // Connect to the Block IO and Block IO2 interface on ControllerHandle.\r |
adbcbf8f | 141 | //\r |
142 | Status = gBS->OpenProtocol (\r | |
143 | ControllerHandle,\r | |
144 | &gEfiBlockIoProtocolGuid,\r | |
145 | (VOID **) &gDiskIoPrivateDataTemplate.BlockIo,\r | |
146 | This->DriverBindingHandle,\r | |
147 | ControllerHandle,\r | |
148 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
149 | );\r | |
150 | if (EFI_ERROR (Status)) {\r | |
15cc67e6 | 151 | goto ErrorExit1;\r |
adbcbf8f | 152 | }\r |
493d8e3a RN |
153 | \r |
154 | Status = gBS->OpenProtocol (\r | |
155 | ControllerHandle,\r | |
156 | &gEfiBlockIo2ProtocolGuid,\r | |
157 | (VOID **) &gDiskIoPrivateDataTemplate.BlockIo2,\r | |
158 | This->DriverBindingHandle,\r | |
159 | ControllerHandle,\r | |
160 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
161 | );\r | |
162 | if (EFI_ERROR (Status)) {\r | |
163 | gDiskIoPrivateDataTemplate.BlockIo2 = NULL;\r | |
164 | }\r | |
adbcbf8f | 165 | \r |
166 | //\r | |
167 | // Initialize the Disk IO device instance.\r | |
168 | //\r | |
493d8e3a RN |
169 | Instance = AllocateCopyPool (sizeof (DISK_IO_PRIVATE_DATA), &gDiskIoPrivateDataTemplate);\r |
170 | if (Instance == NULL) {\r | |
adbcbf8f | 171 | Status = EFI_OUT_OF_RESOURCES;\r |
172 | goto ErrorExit;\r | |
173 | }\r | |
174 | \r | |
493d8e3a RN |
175 | //\r |
176 | // The BlockSize and IoAlign of BlockIo and BlockIo2 should equal.\r | |
177 | //\r | |
178 | ASSERT ((Instance->BlockIo2 == NULL) ||\r | |
179 | ((Instance->BlockIo->Media->IoAlign == Instance->BlockIo2->Media->IoAlign) && \r | |
180 | (Instance->BlockIo->Media->BlockSize == Instance->BlockIo2->Media->BlockSize)\r | |
181 | ));\r | |
182 | \r | |
183 | InitializeListHead (&Instance->TaskQueue);\r | |
184 | EfiInitializeLock (&Instance->TaskQueueLock, TPL_NOTIFY);\r | |
185 | Instance->SharedWorkingBuffer = AllocateAlignedPages (\r | |
e645bd85 | 186 | EFI_SIZE_TO_PAGES (PcdGet32 (PcdDiskIoDataBufferBlockNum) * Instance->BlockIo->Media->BlockSize),\r |
493d8e3a RN |
187 | Instance->BlockIo->Media->IoAlign\r |
188 | );\r | |
189 | if (Instance->SharedWorkingBuffer == NULL) {\r | |
190 | Status = EFI_OUT_OF_RESOURCES;\r | |
191 | goto ErrorExit;\r | |
192 | }\r | |
193 | \r | |
adbcbf8f | 194 | //\r |
195 | // Install protocol interfaces for the Disk IO device.\r | |
196 | //\r | |
493d8e3a RN |
197 | if (Instance->BlockIo2 != NULL) {\r |
198 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
199 | &ControllerHandle,\r | |
200 | &gEfiDiskIoProtocolGuid, &Instance->DiskIo,\r | |
201 | &gEfiDiskIo2ProtocolGuid, &Instance->DiskIo2,\r | |
202 | NULL\r | |
203 | );\r | |
204 | } else {\r | |
205 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
206 | &ControllerHandle,\r | |
207 | &gEfiDiskIoProtocolGuid, &Instance->DiskIo,\r | |
208 | NULL\r | |
209 | );\r | |
210 | }\r | |
adbcbf8f | 211 | \r |
212 | ErrorExit:\r | |
213 | if (EFI_ERROR (Status)) {\r | |
493d8e3a RN |
214 | if (Instance != NULL && Instance->SharedWorkingBuffer != NULL) {\r |
215 | FreeAlignedPages (\r | |
216 | Instance->SharedWorkingBuffer,\r | |
e645bd85 | 217 | EFI_SIZE_TO_PAGES (PcdGet32 (PcdDiskIoDataBufferBlockNum) * Instance->BlockIo->Media->BlockSize)\r |
493d8e3a RN |
218 | );\r |
219 | }\r | |
adbcbf8f | 220 | \r |
493d8e3a RN |
221 | if (Instance != NULL) {\r |
222 | FreePool (Instance);\r | |
adbcbf8f | 223 | }\r |
224 | \r | |
225 | gBS->CloseProtocol (\r | |
493d8e3a RN |
226 | ControllerHandle,\r |
227 | &gEfiBlockIoProtocolGuid,\r | |
228 | This->DriverBindingHandle,\r | |
229 | ControllerHandle\r | |
230 | );\r | |
adbcbf8f | 231 | }\r |
232 | \r | |
15cc67e6 | 233 | ErrorExit1:\r |
234 | gBS->RestoreTPL (OldTpl);\r | |
adbcbf8f | 235 | return Status;\r |
236 | }\r | |
237 | \r | |
adbcbf8f | 238 | /**\r |
239 | Stop this driver on ControllerHandle by removing Disk IO protocol and closing\r | |
240 | the Block IO protocol on ControllerHandle.\r | |
241 | \r | |
242 | @param This Protocol instance pointer.\r | |
243 | @param ControllerHandle Handle of device to stop driver on\r | |
244 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
245 | children is zero stop the entire bus driver.\r | |
246 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
247 | \r | |
248 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
249 | @retval other This driver was not removed from this device\r | |
250 | \r | |
251 | **/\r | |
252 | EFI_STATUS\r | |
253 | EFIAPI\r | |
254 | DiskIoDriverBindingStop (\r | |
255 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
256 | IN EFI_HANDLE ControllerHandle,\r | |
257 | IN UINTN NumberOfChildren,\r | |
258 | IN EFI_HANDLE *ChildHandleBuffer\r | |
259 | )\r | |
260 | {\r | |
261 | EFI_STATUS Status;\r | |
262 | EFI_DISK_IO_PROTOCOL *DiskIo;\r | |
493d8e3a RN |
263 | EFI_DISK_IO2_PROTOCOL *DiskIo2;\r |
264 | DISK_IO_PRIVATE_DATA *Instance;\r | |
265 | BOOLEAN AllTaskDone;\r | |
adbcbf8f | 266 | \r |
267 | //\r | |
268 | // Get our context back.\r | |
269 | //\r | |
270 | Status = gBS->OpenProtocol (\r | |
271 | ControllerHandle,\r | |
272 | &gEfiDiskIoProtocolGuid,\r | |
273 | (VOID **) &DiskIo,\r | |
274 | This->DriverBindingHandle,\r | |
275 | ControllerHandle,\r | |
276 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
277 | );\r | |
278 | if (EFI_ERROR (Status)) {\r | |
493d8e3a | 279 | return Status;\r |
adbcbf8f | 280 | }\r |
493d8e3a | 281 | Status = gBS->OpenProtocol (\r |
adbcbf8f | 282 | ControllerHandle,\r |
493d8e3a RN |
283 | &gEfiDiskIo2ProtocolGuid,\r |
284 | (VOID **) &DiskIo2,\r | |
285 | This->DriverBindingHandle,\r | |
286 | ControllerHandle,\r | |
287 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
adbcbf8f | 288 | );\r |
493d8e3a RN |
289 | if (EFI_ERROR (Status)) {\r |
290 | DiskIo2 = NULL;\r | |
291 | }\r | |
292 | \r | |
293 | Instance = DISK_IO_PRIVATE_DATA_FROM_DISK_IO (DiskIo);\r | |
294 | \r | |
295 | if (DiskIo2 != NULL) {\r | |
296 | //\r | |
297 | // Call BlockIo2::Reset() to terminate any in-flight non-blocking I/O requests\r | |
298 | //\r | |
299 | ASSERT (Instance->BlockIo2 != NULL);\r | |
300 | Status = Instance->BlockIo2->Reset (Instance->BlockIo2, FALSE);\r | |
301 | if (EFI_ERROR (Status)) {\r | |
302 | return Status;\r | |
303 | }\r | |
304 | Status = gBS->UninstallMultipleProtocolInterfaces (\r | |
305 | ControllerHandle,\r | |
306 | &gEfiDiskIoProtocolGuid, &Instance->DiskIo,\r | |
307 | &gEfiDiskIo2ProtocolGuid, &Instance->DiskIo2,\r | |
308 | NULL\r | |
309 | );\r | |
310 | } else {\r | |
311 | Status = gBS->UninstallMultipleProtocolInterfaces (\r | |
312 | ControllerHandle,\r | |
313 | &gEfiDiskIoProtocolGuid, &Instance->DiskIo,\r | |
314 | NULL\r | |
315 | );\r | |
316 | }\r | |
adbcbf8f | 317 | if (!EFI_ERROR (Status)) {\r |
493d8e3a RN |
318 | \r |
319 | do {\r | |
320 | EfiAcquireLock (&Instance->TaskQueueLock);\r | |
321 | AllTaskDone = IsListEmpty (&Instance->TaskQueue);\r | |
322 | EfiReleaseLock (&Instance->TaskQueueLock);\r | |
323 | } while (!AllTaskDone);\r | |
324 | \r | |
325 | FreeAlignedPages (\r | |
326 | Instance->SharedWorkingBuffer,\r | |
e645bd85 | 327 | EFI_SIZE_TO_PAGES (PcdGet32 (PcdDiskIoDataBufferBlockNum) * Instance->BlockIo->Media->BlockSize)\r |
493d8e3a RN |
328 | );\r |
329 | \r | |
adbcbf8f | 330 | Status = gBS->CloseProtocol (\r |
331 | ControllerHandle,\r | |
332 | &gEfiBlockIoProtocolGuid,\r | |
333 | This->DriverBindingHandle,\r | |
334 | ControllerHandle\r | |
335 | );\r | |
493d8e3a RN |
336 | ASSERT_EFI_ERROR (Status);\r |
337 | if (DiskIo2 != NULL) {\r | |
338 | Status = gBS->CloseProtocol (\r | |
339 | ControllerHandle,\r | |
340 | &gEfiBlockIo2ProtocolGuid,\r | |
341 | This->DriverBindingHandle,\r | |
342 | ControllerHandle\r | |
343 | );\r | |
344 | ASSERT_EFI_ERROR (Status);\r | |
345 | }\r | |
346 | \r | |
347 | FreePool (Instance);\r | |
adbcbf8f | 348 | }\r |
349 | \r | |
493d8e3a RN |
350 | return Status;\r |
351 | }\r | |
352 | \r | |
353 | \r | |
354 | /**\r | |
355 | Destroy the sub task.\r | |
356 | \r | |
b822eb42 | 357 | @param Instance Pointer to the DISK_IO_PRIVATE_DATA.\r |
493d8e3a RN |
358 | @param Subtask Subtask.\r |
359 | \r | |
360 | @return LIST_ENTRY * Pointer to the next link of subtask.\r | |
361 | **/\r | |
362 | LIST_ENTRY *\r | |
363 | DiskIoDestroySubtask (\r | |
364 | IN DISK_IO_PRIVATE_DATA *Instance,\r | |
365 | IN DISK_IO_SUBTASK *Subtask\r | |
366 | )\r | |
367 | {\r | |
368 | LIST_ENTRY *Link;\r | |
bf5a9493 RN |
369 | \r |
370 | if (Subtask->Task != NULL) {\r | |
371 | EfiAcquireLock (&Subtask->Task->SubtasksLock);\r | |
372 | }\r | |
493d8e3a | 373 | Link = RemoveEntryList (&Subtask->Link);\r |
bf5a9493 RN |
374 | if (Subtask->Task != NULL) {\r |
375 | EfiReleaseLock (&Subtask->Task->SubtasksLock);\r | |
376 | }\r | |
377 | \r | |
493d8e3a RN |
378 | if (!Subtask->Blocking) {\r |
379 | if (Subtask->WorkingBuffer != NULL) {\r | |
380 | FreeAlignedPages (\r | |
381 | Subtask->WorkingBuffer, \r | |
382 | Subtask->Length < Instance->BlockIo->Media->BlockSize\r | |
383 | ? EFI_SIZE_TO_PAGES (Instance->BlockIo->Media->BlockSize)\r | |
384 | : EFI_SIZE_TO_PAGES (Subtask->Length)\r | |
385 | );\r | |
386 | }\r | |
387 | if (Subtask->BlockIo2Token.Event != NULL) {\r | |
388 | gBS->CloseEvent (Subtask->BlockIo2Token.Event);\r | |
389 | }\r | |
adbcbf8f | 390 | }\r |
493d8e3a | 391 | FreePool (Subtask);\r |
adbcbf8f | 392 | \r |
493d8e3a | 393 | return Link;\r |
adbcbf8f | 394 | }\r |
395 | \r | |
493d8e3a RN |
396 | /**\r |
397 | The callback for the BlockIo2 ReadBlocksEx/WriteBlocksEx.\r | |
398 | @param Event Event whose notification function is being invoked.\r | |
399 | @param Context The pointer to the notification function's context,\r | |
400 | which points to the DISK_IO_SUBTASK instance.\r | |
401 | **/\r | |
402 | VOID\r | |
403 | EFIAPI\r | |
404 | DiskIo2OnReadWriteComplete (\r | |
405 | IN EFI_EVENT Event,\r | |
406 | IN VOID *Context\r | |
407 | )\r | |
408 | {\r | |
409 | DISK_IO_SUBTASK *Subtask;\r | |
410 | DISK_IO2_TASK *Task;\r | |
411 | EFI_STATUS TransactionStatus;\r | |
412 | DISK_IO_PRIVATE_DATA *Instance;\r | |
413 | \r | |
493d8e3a RN |
414 | Subtask = (DISK_IO_SUBTASK *) Context;\r |
415 | TransactionStatus = Subtask->BlockIo2Token.TransactionStatus;\r | |
416 | Task = Subtask->Task;\r | |
417 | Instance = Task->Instance;\r | |
418 | \r | |
419 | ASSERT (Subtask->Signature == DISK_IO_SUBTASK_SIGNATURE);\r | |
420 | ASSERT (Instance->Signature == DISK_IO_PRIVATE_DATA_SIGNATURE);\r | |
421 | ASSERT (Task->Signature == DISK_IO2_TASK_SIGNATURE);\r | |
adbcbf8f | 422 | \r |
80c83a69 RN |
423 | if ((Subtask->WorkingBuffer != NULL) && !EFI_ERROR (TransactionStatus) && \r |
424 | (Task->Token != NULL) && !Subtask->Write\r | |
425 | ) {\r | |
426 | CopyMem (Subtask->Buffer, Subtask->WorkingBuffer + Subtask->Offset, Subtask->Length);\r | |
493d8e3a | 427 | }\r |
80c83a69 RN |
428 | \r |
429 | DiskIoDestroySubtask (Instance, Subtask);\r | |
493d8e3a RN |
430 | \r |
431 | if (EFI_ERROR (TransactionStatus) || IsListEmpty (&Task->Subtasks)) {\r | |
432 | if (Task->Token != NULL) {\r | |
433 | //\r | |
434 | // Signal error status once the subtask is failed.\r | |
435 | // Or signal the last status once the last subtask is finished.\r | |
436 | //\r | |
437 | Task->Token->TransactionStatus = TransactionStatus;\r | |
438 | gBS->SignalEvent (Task->Token->Event);\r | |
439 | \r | |
440 | //\r | |
bf5a9493 | 441 | // Mark token to NULL indicating the Task is a dead task.\r |
493d8e3a RN |
442 | //\r |
443 | Task->Token = NULL;\r | |
444 | }\r | |
445 | }\r | |
493d8e3a | 446 | }\r |
adbcbf8f | 447 | \r |
448 | /**\r | |
493d8e3a | 449 | Create the subtask.\r |
adbcbf8f | 450 | \r |
493d8e3a RN |
451 | @param Write TRUE: Write request; FALSE: Read request.\r |
452 | @param Lba The starting logical block address to read from on the device.\r | |
453 | @param Offset The starting byte offset to read from the LBA.\r | |
454 | @param Length The number of bytes to read from the device.\r | |
455 | @param WorkingBuffer The aligned buffer to hold the data for reading or writing.\r | |
456 | @param Buffer The buffer to hold the data for reading or writing.\r | |
457 | @param Blocking TRUE: Blocking request; FALSE: Non-blocking request.\r | |
adbcbf8f | 458 | \r |
493d8e3a RN |
459 | @return A pointer to the created subtask.\r |
460 | **/\r | |
461 | DISK_IO_SUBTASK *\r | |
462 | DiskIoCreateSubtask (\r | |
463 | IN BOOLEAN Write,\r | |
464 | IN UINT64 Lba,\r | |
465 | IN UINT32 Offset,\r | |
466 | IN UINTN Length,\r | |
467 | IN VOID *WorkingBuffer, OPTIONAL\r | |
468 | IN VOID *Buffer,\r | |
469 | IN BOOLEAN Blocking\r | |
470 | )\r | |
471 | {\r | |
472 | DISK_IO_SUBTASK *Subtask;\r | |
473 | EFI_STATUS Status;\r | |
adbcbf8f | 474 | \r |
493d8e3a RN |
475 | Subtask = AllocateZeroPool (sizeof (DISK_IO_SUBTASK));\r |
476 | if (Subtask == NULL) {\r | |
477 | return NULL;\r | |
478 | }\r | |
479 | Subtask->Signature = DISK_IO_SUBTASK_SIGNATURE;\r | |
480 | Subtask->Write = Write;\r | |
481 | Subtask->Lba = Lba;\r | |
482 | Subtask->Offset = Offset;\r | |
483 | Subtask->Length = Length;\r | |
484 | Subtask->WorkingBuffer = WorkingBuffer;\r | |
485 | Subtask->Buffer = Buffer;\r | |
486 | Subtask->Blocking = Blocking;\r | |
487 | if (!Blocking) {\r | |
488 | Status = gBS->CreateEvent (\r | |
489 | EVT_NOTIFY_SIGNAL,\r | |
490 | TPL_NOTIFY,\r | |
491 | DiskIo2OnReadWriteComplete,\r | |
492 | Subtask,\r | |
493 | &Subtask->BlockIo2Token.Event\r | |
494 | );\r | |
495 | if (EFI_ERROR (Status)) {\r | |
496 | FreePool (Subtask);\r | |
497 | return NULL;\r | |
498 | }\r | |
499 | }\r | |
500 | DEBUG ((\r | |
501 | EFI_D_BLKIO, \r | |
502 | " %c:Lba/Offset/Length/WorkingBuffer/Buffer = %016lx/%08x/%08x/%08x/%08x\n",\r | |
503 | Write ? 'W': 'R', Lba, Offset, Length, WorkingBuffer, Buffer\r | |
504 | ));\r | |
505 | \r | |
506 | return Subtask;\r | |
507 | }\r | |
508 | \r | |
509 | /**\r | |
510 | Create the subtask list.\r | |
511 | \r | |
512 | @param Instance Pointer to the DISK_IO_PRIVATE_DATA.\r | |
513 | @param Write TRUE: Write request; FALSE: Read request.\r | |
514 | @param Offset The starting byte offset to read from the device.\r | |
515 | @param BufferSize The size in bytes of Buffer. The number of bytes to read from the device.\r | |
516 | @param Buffer A pointer to the buffer for the data.\r | |
517 | @param Blocking TRUE: Blocking request; FALSE: Non-blocking request.\r | |
518 | @param SharedWorkingBuffer The aligned buffer to hold the data for reading or writing.\r | |
519 | @param Subtasks The subtask list header.\r | |
520 | \r | |
521 | @retval TRUE The subtask list is created successfully.\r | |
522 | @retval FALSE The subtask list is not created.\r | |
adbcbf8f | 523 | **/\r |
493d8e3a RN |
524 | BOOLEAN\r |
525 | DiskIoCreateSubtaskList (\r | |
526 | IN DISK_IO_PRIVATE_DATA *Instance,\r | |
527 | IN BOOLEAN Write,\r | |
adbcbf8f | 528 | IN UINT64 Offset,\r |
529 | IN UINTN BufferSize,\r | |
493d8e3a RN |
530 | IN VOID *Buffer,\r |
531 | IN BOOLEAN Blocking,\r | |
532 | IN VOID *SharedWorkingBuffer,\r | |
533 | IN OUT LIST_ENTRY *Subtasks\r | |
adbcbf8f | 534 | )\r |
535 | {\r | |
adbcbf8f | 536 | UINT32 BlockSize;\r |
493d8e3a | 537 | UINT32 IoAlign;\r |
adbcbf8f | 538 | UINT64 Lba;\r |
539 | UINT64 OverRunLba;\r | |
540 | UINT32 UnderRun;\r | |
541 | UINT32 OverRun;\r | |
493d8e3a | 542 | UINT8 *BufferPtr;\r |
adbcbf8f | 543 | UINTN Length;\r |
adbcbf8f | 544 | UINTN DataBufferSize;\r |
493d8e3a RN |
545 | DISK_IO_SUBTASK *Subtask;\r |
546 | VOID *WorkingBuffer;\r | |
547 | LIST_ENTRY *Link;\r | |
adbcbf8f | 548 | \r |
493d8e3a | 549 | DEBUG ((EFI_D_BLKIO, "DiskIo: Create subtasks for task: Offset/BufferSize/Buffer = %016lx/%08x/%08x\n", Offset, BufferSize, Buffer));\r |
adbcbf8f | 550 | \r |
493d8e3a RN |
551 | BlockSize = Instance->BlockIo->Media->BlockSize;\r |
552 | IoAlign = Instance->BlockIo->Media->IoAlign;\r | |
553 | if (IoAlign == 0) {\r | |
554 | IoAlign = 1;\r | |
adbcbf8f | 555 | }\r |
493d8e3a RN |
556 | \r |
557 | Lba = DivU64x32Remainder (Offset, BlockSize, &UnderRun);\r | |
558 | BufferPtr = (UINT8 *) Buffer;\r | |
adbcbf8f | 559 | \r |
560 | //\r | |
493d8e3a | 561 | // Special handling for zero BufferSize\r |
adbcbf8f | 562 | //\r |
493d8e3a RN |
563 | if (BufferSize == 0) {\r |
564 | Subtask = DiskIoCreateSubtask (Write, Lba, UnderRun, 0, NULL, BufferPtr, Blocking);\r | |
565 | if (Subtask == NULL) {\r | |
566 | goto Done;\r | |
567 | }\r | |
568 | InsertTailList (Subtasks, &Subtask->Link);\r | |
569 | return TRUE;\r | |
adbcbf8f | 570 | }\r |
571 | \r | |
adbcbf8f | 572 | if (UnderRun != 0) {\r |
493d8e3a RN |
573 | Length = MIN (BlockSize - UnderRun, BufferSize);\r |
574 | if (Blocking) {\r | |
575 | WorkingBuffer = SharedWorkingBuffer;\r | |
576 | } else {\r | |
577 | WorkingBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BlockSize), IoAlign);\r | |
578 | if (WorkingBuffer == NULL) {\r | |
579 | goto Done;\r | |
580 | }\r | |
581 | }\r | |
582 | if (Write) {\r | |
583 | //\r | |
584 | // A half write operation can be splitted to a blocking block-read and half write operation\r | |
585 | // This can simplify the sub task processing logic\r | |
586 | //\r | |
587 | Subtask = DiskIoCreateSubtask (FALSE, Lba, 0, BlockSize, NULL, WorkingBuffer, TRUE);\r | |
588 | if (Subtask == NULL) {\r | |
589 | goto Done;\r | |
590 | }\r | |
591 | InsertTailList (Subtasks, &Subtask->Link);\r | |
adbcbf8f | 592 | }\r |
593 | \r | |
493d8e3a RN |
594 | Subtask = DiskIoCreateSubtask (Write, Lba, UnderRun, Length, WorkingBuffer, BufferPtr, Blocking);\r |
595 | if (Subtask == NULL) {\r | |
596 | goto Done;\r | |
adbcbf8f | 597 | }\r |
493d8e3a RN |
598 | InsertTailList (Subtasks, &Subtask->Link);\r |
599 | \r | |
600 | BufferPtr += Length;\r | |
601 | Offset += Length;\r | |
602 | BufferSize -= Length;\r | |
603 | Lba ++;\r | |
604 | }\r | |
adbcbf8f | 605 | \r |
493d8e3a RN |
606 | OverRunLba = Lba + DivU64x32Remainder (BufferSize, BlockSize, &OverRun);\r |
607 | BufferSize -= OverRun;\r | |
adbcbf8f | 608 | \r |
493d8e3a RN |
609 | if (OverRun != 0) {\r |
610 | if (Blocking) {\r | |
611 | WorkingBuffer = SharedWorkingBuffer;\r | |
612 | } else {\r | |
613 | WorkingBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BlockSize), IoAlign);\r | |
614 | if (WorkingBuffer == NULL) {\r | |
615 | goto Done;\r | |
616 | }\r | |
617 | }\r | |
618 | if (Write) {\r | |
619 | //\r | |
620 | // A half write operation can be splitted to a blocking block-read and half write operation\r | |
621 | // This can simplify the sub task processing logic\r | |
622 | //\r | |
623 | Subtask = DiskIoCreateSubtask (FALSE, OverRunLba, 0, BlockSize, NULL, WorkingBuffer, TRUE);\r | |
624 | if (Subtask == NULL) {\r | |
625 | goto Done;\r | |
626 | }\r | |
627 | InsertTailList (Subtasks, &Subtask->Link);\r | |
628 | }\r | |
adbcbf8f | 629 | \r |
4e39b75e | 630 | Subtask = DiskIoCreateSubtask (Write, OverRunLba, 0, OverRun, WorkingBuffer, BufferPtr + BufferSize, Blocking);\r |
493d8e3a | 631 | if (Subtask == NULL) {\r |
adbcbf8f | 632 | goto Done;\r |
633 | }\r | |
493d8e3a | 634 | InsertTailList (Subtasks, &Subtask->Link);\r |
adbcbf8f | 635 | }\r |
493d8e3a RN |
636 | \r |
637 | if (OverRunLba > Lba) {\r | |
adbcbf8f | 638 | //\r |
639 | // If the DiskIo maps directly to a BlockIo device do the read.\r | |
640 | //\r | |
493d8e3a RN |
641 | if (ALIGN_POINTER (BufferPtr, IoAlign) == BufferPtr) {\r |
642 | Subtask = DiskIoCreateSubtask (Write, Lba, 0, BufferSize, NULL, BufferPtr, Blocking);\r | |
643 | if (Subtask == NULL) {\r | |
adbcbf8f | 644 | goto Done;\r |
645 | }\r | |
493d8e3a | 646 | InsertTailList (Subtasks, &Subtask->Link);\r |
adbcbf8f | 647 | \r |
493d8e3a RN |
648 | BufferPtr += BufferSize;\r |
649 | Offset += BufferSize;\r | |
650 | BufferSize -= BufferSize;\r | |
adbcbf8f | 651 | \r |
652 | } else {\r | |
493d8e3a RN |
653 | if (Blocking) {\r |
654 | //\r | |
655 | // Use the allocated buffer instead of the original buffer\r | |
656 | // to avoid alignment issue.\r | |
657 | //\r | |
e645bd85 OM |
658 | for (; Lba < OverRunLba; Lba += PcdGet32 (PcdDiskIoDataBufferBlockNum)) {\r |
659 | DataBufferSize = MIN (BufferSize, PcdGet32 (PcdDiskIoDataBufferBlockNum) * BlockSize);\r | |
493d8e3a RN |
660 | \r |
661 | Subtask = DiskIoCreateSubtask (Write, Lba, 0, DataBufferSize, SharedWorkingBuffer, BufferPtr, Blocking);\r | |
662 | if (Subtask == NULL) {\r | |
663 | goto Done;\r | |
664 | }\r | |
665 | InsertTailList (Subtasks, &Subtask->Link);\r | |
666 | \r | |
667 | BufferPtr += DataBufferSize;\r | |
668 | Offset += DataBufferSize;\r | |
669 | BufferSize -= DataBufferSize;\r | |
670 | }\r | |
671 | } else {\r | |
672 | WorkingBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), IoAlign);\r | |
673 | if (WorkingBuffer == NULL) {\r | |
adbcbf8f | 674 | //\r |
493d8e3a | 675 | // If there is not enough memory, downgrade to blocking access\r |
adbcbf8f | 676 | //\r |
493d8e3a RN |
677 | DEBUG ((EFI_D_VERBOSE, "DiskIo: No enough memory so downgrade to blocking access\n"));\r |
678 | if (!DiskIoCreateSubtaskList (Instance, Write, Offset, BufferSize, BufferPtr, TRUE, SharedWorkingBuffer, Subtasks)) {\r | |
679 | goto Done;\r | |
680 | }\r | |
681 | } else {\r | |
682 | Subtask = DiskIoCreateSubtask (Write, Lba, 0, BufferSize, WorkingBuffer, BufferPtr, Blocking);\r | |
683 | if (Subtask == NULL) {\r | |
684 | goto Done;\r | |
685 | }\r | |
686 | InsertTailList (Subtasks, &Subtask->Link);\r | |
adbcbf8f | 687 | }\r |
688 | \r | |
493d8e3a RN |
689 | BufferPtr += BufferSize;\r |
690 | Offset += BufferSize;\r | |
691 | BufferSize -= BufferSize;\r | |
692 | }\r | |
adbcbf8f | 693 | }\r |
694 | }\r | |
695 | \r | |
493d8e3a | 696 | ASSERT (BufferSize == 0);\r |
adbcbf8f | 697 | \r |
493d8e3a | 698 | return TRUE;\r |
adbcbf8f | 699 | \r |
700 | Done:\r | |
493d8e3a RN |
701 | //\r |
702 | // Remove all the subtasks.\r | |
703 | //\r | |
704 | for (Link = GetFirstNode (Subtasks); !IsNull (Subtasks, Link); ) {\r | |
705 | Subtask = CR (Link, DISK_IO_SUBTASK, Link, DISK_IO_SUBTASK_SIGNATURE);\r | |
706 | Link = DiskIoDestroySubtask (Instance, Subtask);\r | |
adbcbf8f | 707 | }\r |
493d8e3a | 708 | return FALSE;\r |
adbcbf8f | 709 | }\r |
710 | \r | |
adbcbf8f | 711 | /**\r |
493d8e3a | 712 | Terminate outstanding asynchronous requests to a device.\r |
adbcbf8f | 713 | \r |
493d8e3a | 714 | @param This Indicates a pointer to the calling context.\r |
adbcbf8f | 715 | \r |
493d8e3a RN |
716 | @retval EFI_SUCCESS All outstanding requests were successfully terminated.\r |
717 | @retval EFI_DEVICE_ERROR The device reported an error while performing the cancel\r | |
718 | operation.\r | |
adbcbf8f | 719 | **/\r |
720 | EFI_STATUS\r | |
721 | EFIAPI\r | |
493d8e3a RN |
722 | DiskIo2Cancel (\r |
723 | IN EFI_DISK_IO2_PROTOCOL *This\r | |
adbcbf8f | 724 | )\r |
725 | {\r | |
493d8e3a RN |
726 | DISK_IO_PRIVATE_DATA *Instance;\r |
727 | DISK_IO2_TASK *Task;\r | |
728 | LIST_ENTRY *Link;\r | |
729 | \r | |
730 | Instance = DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This);\r | |
adbcbf8f | 731 | \r |
493d8e3a | 732 | EfiAcquireLock (&Instance->TaskQueueLock);\r |
adbcbf8f | 733 | \r |
493d8e3a RN |
734 | for (Link = GetFirstNode (&Instance->TaskQueue)\r |
735 | ; !IsNull (&Instance->TaskQueue, Link)\r | |
736 | ; Link = GetNextNode (&Instance->TaskQueue, Link)\r | |
737 | ) {\r | |
738 | Task = CR (Link, DISK_IO2_TASK, Link, DISK_IO2_TASK_SIGNATURE);\r | |
adbcbf8f | 739 | \r |
493d8e3a RN |
740 | if (Task->Token != NULL) {\r |
741 | Task->Token->TransactionStatus = EFI_ABORTED;\r | |
742 | gBS->SignalEvent (Task->Token->Event);\r | |
743 | //\r | |
744 | // Set Token to NULL so that the further BlockIo2 responses will be ignored\r | |
745 | //\r | |
746 | Task->Token = NULL;\r | |
747 | }\r | |
adbcbf8f | 748 | }\r |
749 | \r | |
493d8e3a | 750 | EfiReleaseLock (&Instance->TaskQueueLock);\r |
adbcbf8f | 751 | \r |
493d8e3a RN |
752 | return EFI_SUCCESS;\r |
753 | }\r | |
adbcbf8f | 754 | \r |
bf5a9493 RN |
755 | /**\r |
756 | Remove the completed tasks from Instance->TaskQueue. Completed tasks are those who don't have any subtasks.\r | |
757 | \r | |
758 | @param Instance Pointer to the DISK_IO_PRIVATE_DATA.\r | |
759 | \r | |
760 | @retval TRUE The Instance->TaskQueue is empty after the completed tasks are removed.\r | |
761 | @retval FALSE The Instance->TaskQueue is not empty after the completed tasks are removed.\r | |
762 | **/\r | |
763 | BOOLEAN\r | |
764 | DiskIo2RemoveCompletedTask (\r | |
765 | IN DISK_IO_PRIVATE_DATA *Instance\r | |
766 | )\r | |
767 | {\r | |
768 | BOOLEAN QueueEmpty;\r | |
769 | LIST_ENTRY *Link;\r | |
770 | DISK_IO2_TASK *Task;\r | |
771 | \r | |
772 | QueueEmpty = TRUE;\r | |
773 | \r | |
774 | EfiAcquireLock (&Instance->TaskQueueLock);\r | |
775 | for (Link = GetFirstNode (&Instance->TaskQueue); !IsNull (&Instance->TaskQueue, Link); ) {\r | |
776 | Task = CR (Link, DISK_IO2_TASK, Link, DISK_IO2_TASK_SIGNATURE);\r | |
777 | if (IsListEmpty (&Task->Subtasks)) {\r | |
778 | Link = RemoveEntryList (&Task->Link);\r | |
779 | ASSERT (Task->Token == NULL);\r | |
780 | FreePool (Task);\r | |
781 | } else {\r | |
782 | Link = GetNextNode (&Instance->TaskQueue, Link);\r | |
783 | QueueEmpty = FALSE;\r | |
784 | }\r | |
785 | }\r | |
786 | EfiReleaseLock (&Instance->TaskQueueLock);\r | |
787 | \r | |
788 | return QueueEmpty;\r | |
789 | }\r | |
790 | \r | |
493d8e3a RN |
791 | /**\r |
792 | Common routine to access the disk.\r | |
793 | \r | |
794 | @param Instance Pointer to the DISK_IO_PRIVATE_DATA.\r | |
795 | @param Write TRUE: Write operation; FALSE: Read operation.\r | |
796 | @param MediaId ID of the medium to access.\r | |
797 | @param Offset The starting byte offset on the logical block I/O device to access.\r | |
798 | @param Token A pointer to the token associated with the transaction.\r | |
799 | If this field is NULL, synchronous/blocking IO is performed.\r | |
800 | @param BufferSize The size in bytes of Buffer. The number of bytes to read from the device.\r | |
801 | @param Buffer A pointer to the destination buffer for the data.\r | |
802 | The caller is responsible either having implicit or explicit ownership of the buffer. \r | |
803 | **/\r | |
804 | EFI_STATUS\r | |
805 | DiskIo2ReadWriteDisk (\r | |
806 | IN DISK_IO_PRIVATE_DATA *Instance,\r | |
807 | IN BOOLEAN Write,\r | |
808 | IN UINT32 MediaId,\r | |
809 | IN UINT64 Offset,\r | |
810 | IN EFI_DISK_IO2_TOKEN *Token,\r | |
811 | IN UINTN BufferSize,\r | |
812 | IN UINT8 *Buffer\r | |
813 | )\r | |
814 | {\r | |
815 | EFI_STATUS Status;\r | |
816 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
817 | EFI_BLOCK_IO2_PROTOCOL *BlockIo2;\r | |
818 | EFI_BLOCK_IO_MEDIA *Media;\r | |
819 | LIST_ENTRY *Link;\r | |
bf5a9493 | 820 | LIST_ENTRY *NextLink;\r |
493d8e3a RN |
821 | LIST_ENTRY Subtasks;\r |
822 | DISK_IO_SUBTASK *Subtask;\r | |
823 | DISK_IO2_TASK *Task;\r | |
493d8e3a RN |
824 | EFI_TPL OldTpl;\r |
825 | BOOLEAN Blocking;\r | |
bf5a9493 | 826 | BOOLEAN SubtaskBlocking;\r |
493d8e3a RN |
827 | LIST_ENTRY *SubtasksPtr;\r |
828 | \r | |
829 | Task = NULL;\r | |
830 | BlockIo = Instance->BlockIo;\r | |
831 | BlockIo2 = Instance->BlockIo2;\r | |
832 | Media = BlockIo->Media;\r | |
833 | Status = EFI_SUCCESS;\r | |
de49225d | 834 | Blocking = (BOOLEAN) ((Token == NULL) || (Token->Event == NULL));\r |
adbcbf8f | 835 | \r |
66ca22d0 HW |
836 | if (!(Media->MediaPresent)) {\r |
837 | return EFI_NO_MEDIA;\r | |
838 | }\r | |
839 | \r | |
493d8e3a RN |
840 | if (Media->MediaId != MediaId) {\r |
841 | return EFI_MEDIA_CHANGED;\r | |
adbcbf8f | 842 | }\r |
493d8e3a RN |
843 | \r |
844 | if (Write && Media->ReadOnly) {\r | |
845 | return EFI_WRITE_PROTECTED;\r | |
846 | }\r | |
bf5a9493 | 847 | \r |
493d8e3a | 848 | if (Blocking) {\r |
adbcbf8f | 849 | //\r |
493d8e3a | 850 | // Wait till pending async task is completed.\r |
adbcbf8f | 851 | //\r |
bf5a9493 | 852 | while (!DiskIo2RemoveCompletedTask (Instance));\r |
adbcbf8f | 853 | \r |
493d8e3a RN |
854 | SubtasksPtr = &Subtasks;\r |
855 | } else {\r | |
bf5a9493 | 856 | DiskIo2RemoveCompletedTask (Instance);\r |
493d8e3a RN |
857 | Task = AllocatePool (sizeof (DISK_IO2_TASK));\r |
858 | if (Task == NULL) {\r | |
859 | return EFI_OUT_OF_RESOURCES;\r | |
adbcbf8f | 860 | }\r |
bf5a9493 | 861 | \r |
493d8e3a RN |
862 | EfiAcquireLock (&Instance->TaskQueueLock);\r |
863 | InsertTailList (&Instance->TaskQueue, &Task->Link);\r | |
864 | EfiReleaseLock (&Instance->TaskQueueLock);\r | |
adbcbf8f | 865 | \r |
493d8e3a RN |
866 | Task->Signature = DISK_IO2_TASK_SIGNATURE;\r |
867 | Task->Instance = Instance;\r | |
868 | Task->Token = Token;\r | |
bf5a9493 | 869 | EfiInitializeLock (&Task->SubtasksLock, TPL_NOTIFY);\r |
adbcbf8f | 870 | \r |
493d8e3a RN |
871 | SubtasksPtr = &Task->Subtasks;\r |
872 | }\r | |
adbcbf8f | 873 | \r |
493d8e3a RN |
874 | InitializeListHead (SubtasksPtr);\r |
875 | if (!DiskIoCreateSubtaskList (Instance, Write, Offset, BufferSize, Buffer, Blocking, Instance->SharedWorkingBuffer, SubtasksPtr)) {\r | |
876 | if (Task != NULL) {\r | |
877 | FreePool (Task);\r | |
adbcbf8f | 878 | }\r |
493d8e3a | 879 | return EFI_OUT_OF_RESOURCES;\r |
adbcbf8f | 880 | }\r |
493d8e3a | 881 | ASSERT (!IsListEmpty (SubtasksPtr));\r |
adbcbf8f | 882 | \r |
493d8e3a | 883 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
bf5a9493 RN |
884 | for ( Link = GetFirstNode (SubtasksPtr), NextLink = GetNextNode (SubtasksPtr, Link)\r |
885 | ; !IsNull (SubtasksPtr, Link)\r | |
886 | ; Link = NextLink, NextLink = GetNextNode (SubtasksPtr, NextLink)\r | |
887 | ) {\r | |
888 | Subtask = CR (Link, DISK_IO_SUBTASK, Link, DISK_IO_SUBTASK_SIGNATURE);\r | |
889 | Subtask->Task = Task;\r | |
890 | SubtaskBlocking = Subtask->Blocking;\r | |
adbcbf8f | 891 | \r |
bf5a9493 | 892 | ASSERT ((Subtask->Length % Media->BlockSize == 0) || (Subtask->Length < Media->BlockSize));\r |
adbcbf8f | 893 | \r |
493d8e3a | 894 | if (Subtask->Write) {\r |
adbcbf8f | 895 | //\r |
493d8e3a | 896 | // Write\r |
adbcbf8f | 897 | //\r |
493d8e3a RN |
898 | if (Subtask->WorkingBuffer != NULL) {\r |
899 | //\r | |
900 | // A sub task before this one should be a block read operation, causing the WorkingBuffer filled with the entire one block data.\r | |
901 | //\r | |
902 | CopyMem (Subtask->WorkingBuffer + Subtask->Offset, Subtask->Buffer, Subtask->Length);\r | |
adbcbf8f | 903 | }\r |
904 | \r | |
bf5a9493 | 905 | if (SubtaskBlocking) {\r |
493d8e3a RN |
906 | Status = BlockIo->WriteBlocks (\r |
907 | BlockIo,\r | |
908 | MediaId,\r | |
909 | Subtask->Lba,\r | |
bf5a9493 | 910 | (Subtask->Length % Media->BlockSize == 0) ? Subtask->Length : Media->BlockSize,\r |
493d8e3a RN |
911 | (Subtask->WorkingBuffer != NULL) ? Subtask->WorkingBuffer : Subtask->Buffer\r |
912 | );\r | |
913 | } else {\r | |
914 | Status = BlockIo2->WriteBlocksEx (\r | |
915 | BlockIo2,\r | |
916 | MediaId,\r | |
917 | Subtask->Lba,\r | |
918 | &Subtask->BlockIo2Token,\r | |
bf5a9493 | 919 | (Subtask->Length % Media->BlockSize == 0) ? Subtask->Length : Media->BlockSize,\r |
493d8e3a RN |
920 | (Subtask->WorkingBuffer != NULL) ? Subtask->WorkingBuffer : Subtask->Buffer\r |
921 | );\r | |
922 | }\r | |
adbcbf8f | 923 | \r |
924 | } else {\r | |
925 | //\r | |
493d8e3a | 926 | // Read\r |
adbcbf8f | 927 | //\r |
bf5a9493 | 928 | if (SubtaskBlocking) {\r |
493d8e3a | 929 | Status = BlockIo->ReadBlocks (\r |
adbcbf8f | 930 | BlockIo,\r |
931 | MediaId,\r | |
493d8e3a | 932 | Subtask->Lba,\r |
bf5a9493 | 933 | (Subtask->Length % Media->BlockSize == 0) ? Subtask->Length : Media->BlockSize,\r |
493d8e3a | 934 | (Subtask->WorkingBuffer != NULL) ? Subtask->WorkingBuffer : Subtask->Buffer\r |
adbcbf8f | 935 | );\r |
493d8e3a RN |
936 | if (!EFI_ERROR (Status) && (Subtask->WorkingBuffer != NULL)) {\r |
937 | CopyMem (Subtask->Buffer, Subtask->WorkingBuffer + Subtask->Offset, Subtask->Length);\r | |
adbcbf8f | 938 | }\r |
493d8e3a RN |
939 | } else {\r |
940 | Status = BlockIo2->ReadBlocksEx (\r | |
941 | BlockIo2,\r | |
942 | MediaId,\r | |
943 | Subtask->Lba,\r | |
944 | &Subtask->BlockIo2Token,\r | |
bf5a9493 | 945 | (Subtask->Length % Media->BlockSize == 0) ? Subtask->Length : Media->BlockSize,\r |
493d8e3a RN |
946 | (Subtask->WorkingBuffer != NULL) ? Subtask->WorkingBuffer : Subtask->Buffer\r |
947 | );\r | |
948 | }\r | |
949 | }\r | |
bf5a9493 RN |
950 | \r |
951 | if (SubtaskBlocking || EFI_ERROR (Status)) {\r | |
952 | //\r | |
953 | // Make sure the subtask list only contains non-blocking subtasks.\r | |
954 | // Remove failed non-blocking subtasks as well because the callback won't be called.\r | |
955 | //\r | |
956 | DiskIoDestroySubtask (Instance, Subtask);\r | |
957 | }\r | |
958 | \r | |
493d8e3a RN |
959 | if (EFI_ERROR (Status)) {\r |
960 | break;\r | |
adbcbf8f | 961 | }\r |
962 | }\r | |
493d8e3a RN |
963 | \r |
964 | gBS->RaiseTPL (TPL_NOTIFY);\r | |
adbcbf8f | 965 | \r |
493d8e3a RN |
966 | //\r |
967 | // Remove all the remaining subtasks when failure.\r | |
968 | // We shouldn't remove all the tasks because the non-blocking requests have been submitted and cannot be canceled.\r | |
969 | //\r | |
970 | if (EFI_ERROR (Status)) {\r | |
bf5a9493 RN |
971 | while (!IsNull (SubtasksPtr, NextLink)) {\r |
972 | Subtask = CR (NextLink, DISK_IO_SUBTASK, Link, DISK_IO_SUBTASK_SIGNATURE);\r | |
973 | NextLink = DiskIoDestroySubtask (Instance, Subtask);\r | |
493d8e3a RN |
974 | }\r |
975 | }\r | |
adbcbf8f | 976 | \r |
493d8e3a | 977 | //\r |
bf5a9493 RN |
978 | // It's possible that the non-blocking subtasks finish before raising TPL to NOTIFY,\r |
979 | // so the subtasks list might be empty at this point.\r | |
493d8e3a RN |
980 | //\r |
981 | if (!Blocking && IsListEmpty (SubtasksPtr)) {\r | |
982 | EfiAcquireLock (&Instance->TaskQueueLock);\r | |
983 | RemoveEntryList (&Task->Link);\r | |
984 | EfiReleaseLock (&Instance->TaskQueueLock);\r | |
adbcbf8f | 985 | \r |
80c83a69 | 986 | if (!EFI_ERROR (Status) && (Task->Token != NULL)) {\r |
493d8e3a RN |
987 | //\r |
988 | // Task->Token should be set to NULL by the DiskIo2OnReadWriteComplete\r | |
989 | // It it's not, that means the non-blocking request was downgraded to blocking request.\r | |
990 | //\r | |
991 | DEBUG ((EFI_D_VERBOSE, "DiskIo: Non-blocking request was downgraded to blocking request, signal event directly.\n"));\r | |
992 | Task->Token->TransactionStatus = Status;\r | |
993 | gBS->SignalEvent (Task->Token->Event);\r | |
adbcbf8f | 994 | }\r |
493d8e3a RN |
995 | \r |
996 | FreePool (Task);\r | |
adbcbf8f | 997 | }\r |
998 | \r | |
493d8e3a RN |
999 | gBS->RestoreTPL (OldTpl);\r |
1000 | \r | |
1001 | return Status;\r | |
1002 | }\r | |
1003 | \r | |
1004 | /**\r | |
1005 | Reads a specified number of bytes from a device.\r | |
1006 | \r | |
1007 | @param This Indicates a pointer to the calling context.\r | |
1008 | @param MediaId ID of the medium to be read.\r | |
1009 | @param Offset The starting byte offset on the logical block I/O device to read from.\r | |
1010 | @param Token A pointer to the token associated with the transaction.\r | |
1011 | If this field is NULL, synchronous/blocking IO is performed.\r | |
1012 | @param BufferSize The size in bytes of Buffer. The number of bytes to read from the device.\r | |
1013 | @param Buffer A pointer to the destination buffer for the data.\r | |
1014 | The caller is responsible either having implicit or explicit ownership of the buffer.\r | |
1015 | \r | |
1016 | @retval EFI_SUCCESS If Event is NULL (blocking I/O): The data was read correctly from the device.\r | |
1017 | If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.\r | |
1018 | Event will be signaled upon completion.\r | |
1019 | @retval EFI_DEVICE_ERROR The device reported an error while performing the write.\r | |
1020 | @retval EFI_NO_MEDIA There is no medium in the device.\r | |
1021 | @retval EFI_MEDIA_CHNAGED The MediaId is not for the current medium.\r | |
1022 | @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not valid for the device.\r | |
1023 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
1024 | \r | |
1025 | **/\r | |
1026 | EFI_STATUS\r | |
1027 | EFIAPI\r | |
1028 | DiskIo2ReadDiskEx (\r | |
1029 | IN EFI_DISK_IO2_PROTOCOL *This,\r | |
1030 | IN UINT32 MediaId,\r | |
1031 | IN UINT64 Offset,\r | |
1032 | IN OUT EFI_DISK_IO2_TOKEN *Token,\r | |
1033 | IN UINTN BufferSize,\r | |
1034 | OUT VOID *Buffer\r | |
1035 | )\r | |
1036 | {\r | |
1037 | return DiskIo2ReadWriteDisk (\r | |
1038 | DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This),\r | |
1039 | FALSE, MediaId, Offset, Token, BufferSize, (UINT8 *) Buffer\r | |
1040 | );\r | |
1041 | }\r | |
1042 | \r | |
1043 | /**\r | |
1044 | Writes a specified number of bytes to a device.\r | |
1045 | \r | |
1046 | @param This Indicates a pointer to the calling context.\r | |
1047 | @param MediaId ID of the medium to be written.\r | |
1048 | @param Offset The starting byte offset on the logical block I/O device to write to.\r | |
1049 | @param Token A pointer to the token associated with the transaction.\r | |
1050 | If this field is NULL, synchronous/blocking IO is performed.\r | |
1051 | @param BufferSize The size in bytes of Buffer. The number of bytes to write to the device.\r | |
1052 | @param Buffer A pointer to the buffer containing the data to be written.\r | |
1053 | \r | |
1054 | @retval EFI_SUCCESS If Event is NULL (blocking I/O): The data was written correctly to the device.\r | |
1055 | If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.\r | |
1056 | Event will be signaled upon completion.\r | |
1057 | @retval EFI_WRITE_PROTECTED The device cannot be written to.\r | |
1058 | @retval EFI_DEVICE_ERROR The device reported an error while performing the write operation.\r | |
1059 | @retval EFI_NO_MEDIA There is no medium in the device.\r | |
1060 | @retval EFI_MEDIA_CHNAGED The MediaId is not for the current medium.\r | |
1061 | @retval EFI_INVALID_PARAMETER The write request contains device addresses that are not valid for the device.\r | |
1062 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
1063 | \r | |
1064 | **/\r | |
1065 | EFI_STATUS\r | |
1066 | EFIAPI\r | |
1067 | DiskIo2WriteDiskEx (\r | |
1068 | IN EFI_DISK_IO2_PROTOCOL *This,\r | |
1069 | IN UINT32 MediaId,\r | |
1070 | IN UINT64 Offset,\r | |
1071 | IN OUT EFI_DISK_IO2_TOKEN *Token,\r | |
1072 | IN UINTN BufferSize,\r | |
1073 | IN VOID *Buffer\r | |
1074 | )\r | |
1075 | {\r | |
1076 | return DiskIo2ReadWriteDisk (\r | |
1077 | DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This),\r | |
1078 | TRUE, MediaId, Offset, Token, BufferSize, (UINT8 *) Buffer\r | |
1079 | );\r | |
1080 | }\r | |
1081 | \r | |
1082 | /**\r | |
1083 | The callback for the BlockIo2 FlushBlocksEx.\r | |
1084 | @param Event Event whose notification function is being invoked.\r | |
1085 | @param Context The pointer to the notification function's context,\r | |
1086 | which points to the DISK_IO2_FLUSH_TASK instance.\r | |
1087 | **/\r | |
1088 | VOID\r | |
1089 | EFIAPI\r | |
1090 | DiskIo2OnFlushComplete (\r | |
1091 | IN EFI_EVENT Event,\r | |
1092 | IN VOID *Context\r | |
1093 | )\r | |
1094 | {\r | |
1095 | DISK_IO2_FLUSH_TASK *Task;\r | |
1096 | \r | |
1097 | gBS->CloseEvent (Event);\r | |
1098 | \r | |
1099 | Task = (DISK_IO2_FLUSH_TASK *) Context;\r | |
1100 | ASSERT (Task->Signature == DISK_IO2_FLUSH_TASK_SIGNATURE);\r | |
1101 | Task->Token->TransactionStatus = Task->BlockIo2Token.TransactionStatus;\r | |
1102 | gBS->SignalEvent (Task->Token->Event);\r | |
bf5a9493 RN |
1103 | \r |
1104 | FreePool (Task);\r | |
493d8e3a RN |
1105 | }\r |
1106 | \r | |
1107 | /**\r | |
1108 | Flushes all modified data to the physical device.\r | |
1109 | \r | |
1110 | @param This Indicates a pointer to the calling context.\r | |
1111 | @param Token A pointer to the token associated with the transaction.\r | |
1112 | If this field is NULL, synchronous/blocking IO is performed.\r | |
1113 | \r | |
1114 | @retval EFI_SUCCESS If Event is NULL (blocking I/O): The data was flushed successfully to the device.\r | |
1115 | If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.\r | |
1116 | Event will be signaled upon completion.\r | |
1117 | @retval EFI_WRITE_PROTECTED The device cannot be written to.\r | |
1118 | @retval EFI_DEVICE_ERROR The device reported an error while performing the write operation.\r | |
1119 | @retval EFI_NO_MEDIA There is no medium in the device.\r | |
1120 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
1121 | **/\r | |
1122 | EFI_STATUS\r | |
1123 | EFIAPI\r | |
1124 | DiskIo2FlushDiskEx (\r | |
1125 | IN EFI_DISK_IO2_PROTOCOL *This,\r | |
1126 | IN OUT EFI_DISK_IO2_TOKEN *Token\r | |
1127 | )\r | |
1128 | {\r | |
1129 | EFI_STATUS Status;\r | |
1130 | DISK_IO2_FLUSH_TASK *Task;\r | |
1131 | DISK_IO_PRIVATE_DATA *Private;\r | |
1132 | \r | |
1133 | Private = DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This);\r | |
1134 | \r | |
1135 | if ((Token != NULL) && (Token->Event != NULL)) {\r | |
1136 | Task = AllocatePool (sizeof (DISK_IO2_FLUSH_TASK));\r | |
1137 | if (Task == NULL) {\r | |
1138 | return EFI_OUT_OF_RESOURCES;\r | |
1139 | }\r | |
1140 | \r | |
1141 | Status = gBS->CreateEvent (\r | |
1142 | EVT_NOTIFY_SIGNAL,\r | |
1143 | TPL_CALLBACK,\r | |
1144 | DiskIo2OnFlushComplete,\r | |
1145 | Task,\r | |
1146 | &Task->BlockIo2Token.Event\r | |
1147 | );\r | |
1148 | if (EFI_ERROR (Status)) {\r | |
1149 | FreePool (Task);\r | |
1150 | return Status;\r | |
1151 | }\r | |
1152 | Task->Signature = DISK_IO2_FLUSH_TASK_SIGNATURE;\r | |
4636295f | 1153 | Task->Token = Token;\r |
493d8e3a RN |
1154 | Status = Private->BlockIo2->FlushBlocksEx (Private->BlockIo2, &Task->BlockIo2Token);\r |
1155 | if (EFI_ERROR (Status)) {\r | |
1156 | gBS->CloseEvent (Task->BlockIo2Token.Event);\r | |
1157 | FreePool (Task);\r | |
1158 | }\r | |
1159 | } else {\r | |
1160 | Status = Private->BlockIo2->FlushBlocksEx (Private->BlockIo2, NULL);\r | |
adbcbf8f | 1161 | }\r |
1162 | \r | |
1163 | return Status;\r | |
1164 | }\r | |
1165 | \r | |
493d8e3a RN |
1166 | /**\r |
1167 | Read BufferSize bytes from Offset into Buffer.\r | |
1168 | Reads may support reads that are not aligned on\r | |
1169 | sector boundaries. There are three cases:\r | |
1170 | UnderRun - The first byte is not on a sector boundary or the read request is\r | |
1171 | less than a sector in length.\r | |
1172 | Aligned - A read of N contiguous sectors.\r | |
1173 | OverRun - The last byte is not on a sector boundary.\r | |
1174 | \r | |
1175 | @param This Protocol instance pointer.\r | |
1176 | @param MediaId Id of the media, changes every time the media is replaced.\r | |
1177 | @param Offset The starting byte offset to read from\r | |
1178 | @param BufferSize Size of Buffer\r | |
1179 | @param Buffer Buffer containing read data\r | |
1180 | \r | |
1181 | @retval EFI_SUCCESS The data was read correctly from the device.\r | |
1182 | @retval EFI_DEVICE_ERROR The device reported an error while performing the read.\r | |
1183 | @retval EFI_NO_MEDIA There is no media in the device.\r | |
1184 | @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.\r | |
1185 | @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not\r | |
1186 | valid for the device.\r | |
1187 | \r | |
1188 | **/\r | |
1189 | EFI_STATUS\r | |
1190 | EFIAPI\r | |
1191 | DiskIoReadDisk (\r | |
1192 | IN EFI_DISK_IO_PROTOCOL *This,\r | |
1193 | IN UINT32 MediaId,\r | |
1194 | IN UINT64 Offset,\r | |
1195 | IN UINTN BufferSize,\r | |
1196 | OUT VOID *Buffer\r | |
1197 | )\r | |
1198 | {\r | |
1199 | return DiskIo2ReadWriteDisk (\r | |
1200 | DISK_IO_PRIVATE_DATA_FROM_DISK_IO (This),\r | |
1201 | FALSE, MediaId, Offset, NULL, BufferSize, (UINT8 *) Buffer\r | |
1202 | );\r | |
1203 | }\r | |
1204 | \r | |
1205 | \r | |
1206 | /**\r | |
1207 | Writes BufferSize bytes from Buffer into Offset.\r | |
1208 | Writes may require a read modify write to support writes that are not\r | |
1209 | aligned on sector boundaries. There are three cases:\r | |
1210 | UnderRun - The first byte is not on a sector boundary or the write request\r | |
1211 | is less than a sector in length. Read modify write is required.\r | |
1212 | Aligned - A write of N contiguous sectors.\r | |
1213 | OverRun - The last byte is not on a sector boundary. Read modified write\r | |
1214 | required.\r | |
1215 | \r | |
1216 | @param This Protocol instance pointer.\r | |
1217 | @param MediaId Id of the media, changes every time the media is replaced.\r | |
1218 | @param Offset The starting byte offset to read from\r | |
1219 | @param BufferSize Size of Buffer\r | |
1220 | @param Buffer Buffer containing read data\r | |
1221 | \r | |
1222 | @retval EFI_SUCCESS The data was written correctly to the device.\r | |
1223 | @retval EFI_WRITE_PROTECTED The device can not be written to.\r | |
1224 | @retval EFI_DEVICE_ERROR The device reported an error while performing the write.\r | |
1225 | @retval EFI_NO_MEDIA There is no media in the device.\r | |
1226 | @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.\r | |
1227 | @retval EFI_INVALID_PARAMETER The write request contains device addresses that are not\r | |
1228 | valid for the device.\r | |
1229 | \r | |
1230 | **/\r | |
1231 | EFI_STATUS\r | |
1232 | EFIAPI\r | |
1233 | DiskIoWriteDisk (\r | |
1234 | IN EFI_DISK_IO_PROTOCOL *This,\r | |
1235 | IN UINT32 MediaId,\r | |
1236 | IN UINT64 Offset,\r | |
1237 | IN UINTN BufferSize,\r | |
1238 | IN VOID *Buffer\r | |
1239 | )\r | |
1240 | {\r | |
1241 | return DiskIo2ReadWriteDisk (\r | |
1242 | DISK_IO_PRIVATE_DATA_FROM_DISK_IO (This),\r | |
1243 | TRUE, MediaId, Offset, NULL, BufferSize, (UINT8 *) Buffer\r | |
1244 | );\r | |
1245 | }\r | |
adbcbf8f | 1246 | \r |
1247 | /**\r | |
1248 | The user Entry Point for module DiskIo. The user code starts with this function.\r | |
1249 | \r | |
1250 | @param[in] ImageHandle The firmware allocated handle for the EFI image. \r | |
1251 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
1252 | \r | |
1253 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
1254 | @retval other Some error occurs when executing this entry point.\r | |
1255 | \r | |
1256 | **/\r | |
1257 | EFI_STATUS\r | |
1258 | EFIAPI\r | |
1259 | InitializeDiskIo (\r | |
1260 | IN EFI_HANDLE ImageHandle,\r | |
1261 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1262 | )\r | |
1263 | {\r | |
1264 | EFI_STATUS Status;\r | |
1265 | \r | |
1266 | //\r | |
1267 | // Install driver model protocol(s).\r | |
1268 | //\r | |
d38a0f44 | 1269 | Status = EfiLibInstallDriverBindingComponentName2 (\r |
adbcbf8f | 1270 | ImageHandle,\r |
1271 | SystemTable,\r | |
1272 | &gDiskIoDriverBinding,\r | |
1273 | ImageHandle,\r | |
1274 | &gDiskIoComponentName,\r | |
d38a0f44 | 1275 | &gDiskIoComponentName2\r |
adbcbf8f | 1276 | );\r |
1277 | ASSERT_EFI_ERROR (Status);\r | |
1278 | \r | |
adbcbf8f | 1279 | return Status;\r |
1280 | }\r |