2 DiskIo driver that lays on every BlockIo protocol in the system.
3 DiskIo converts a block oriented device to a byte oriented device.
5 Disk access may have to handle unaligned request about sector boundaries.
7 UnderRun - The first byte is not on a sector boundary or the read request is
8 less than a sector in length.
9 Aligned - A read of N contiguous sectors.
10 OverRun - The last byte is not on a sector boundary.
12 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
13 This program and the accompanying materials
14 are licensed and made available under the terms and conditions of the BSD License
15 which accompanies this distribution. The full text of the license may be found at
16 http://opensource.org/licenses/bsd-license.php
18 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
19 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
26 // Driver binding protocol implementation for DiskIo driver.
28 EFI_DRIVER_BINDING_PROTOCOL gDiskIoDriverBinding
= {
29 DiskIoDriverBindingSupported
,
30 DiskIoDriverBindingStart
,
31 DiskIoDriverBindingStop
,
38 // Template for DiskIo private data structure.
39 // The pointer to BlockIo protocol interface is assigned dynamically.
41 DISK_IO_PRIVATE_DATA gDiskIoPrivateDataTemplate
= {
42 DISK_IO_PRIVATE_DATA_SIGNATURE
,
44 EFI_DISK_IO_PROTOCOL_REVISION
,
49 EFI_DISK_IO2_PROTOCOL_REVISION
,
58 Test to see if this driver supports ControllerHandle.
60 @param This Protocol instance pointer.
61 @param ControllerHandle Handle of device to test
62 @param RemainingDevicePath Optional parameter use to pick a specific child
65 @retval EFI_SUCCESS This driver supports this device
66 @retval EFI_ALREADY_STARTED This driver is already running on this device
67 @retval other This driver does not support this device
72 DiskIoDriverBindingSupported (
73 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
74 IN EFI_HANDLE ControllerHandle
,
75 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
79 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
82 // Open the IO Abstraction(s) needed to perform the supported test.
84 Status
= gBS
->OpenProtocol (
86 &gEfiBlockIoProtocolGuid
,
88 This
->DriverBindingHandle
,
90 EFI_OPEN_PROTOCOL_BY_DRIVER
92 if (EFI_ERROR (Status
)) {
97 // Close the I/O Abstraction(s) used to perform the supported test.
101 &gEfiBlockIoProtocolGuid
,
102 This
->DriverBindingHandle
,
110 Start this driver on ControllerHandle by opening a Block IO protocol and
111 installing a Disk IO protocol on ControllerHandle.
113 @param This Protocol instance pointer.
114 @param ControllerHandle Handle of device to bind driver to
115 @param RemainingDevicePath Optional parameter use to pick a specific child
118 @retval EFI_SUCCESS This driver is added to ControllerHandle
119 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
120 @retval other This driver does not support this device
125 DiskIoDriverBindingStart (
126 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
127 IN EFI_HANDLE ControllerHandle
,
128 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
132 DISK_IO_PRIVATE_DATA
*Instance
;
137 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
140 // Connect to the Block IO and Block IO2 interface on ControllerHandle.
142 Status
= gBS
->OpenProtocol (
144 &gEfiBlockIoProtocolGuid
,
145 (VOID
**) &gDiskIoPrivateDataTemplate
.BlockIo
,
146 This
->DriverBindingHandle
,
148 EFI_OPEN_PROTOCOL_BY_DRIVER
150 if (EFI_ERROR (Status
)) {
154 Status
= gBS
->OpenProtocol (
156 &gEfiBlockIo2ProtocolGuid
,
157 (VOID
**) &gDiskIoPrivateDataTemplate
.BlockIo2
,
158 This
->DriverBindingHandle
,
160 EFI_OPEN_PROTOCOL_BY_DRIVER
162 if (EFI_ERROR (Status
)) {
163 gDiskIoPrivateDataTemplate
.BlockIo2
= NULL
;
167 // Initialize the Disk IO device instance.
169 Instance
= AllocateCopyPool (sizeof (DISK_IO_PRIVATE_DATA
), &gDiskIoPrivateDataTemplate
);
170 if (Instance
== NULL
) {
171 Status
= EFI_OUT_OF_RESOURCES
;
176 // The BlockSize and IoAlign of BlockIo and BlockIo2 should equal.
178 ASSERT ((Instance
->BlockIo2
== NULL
) ||
179 ((Instance
->BlockIo
->Media
->IoAlign
== Instance
->BlockIo2
->Media
->IoAlign
) &&
180 (Instance
->BlockIo
->Media
->BlockSize
== Instance
->BlockIo2
->Media
->BlockSize
)
183 InitializeListHead (&Instance
->TaskQueue
);
184 EfiInitializeLock (&Instance
->TaskQueueLock
, TPL_NOTIFY
);
185 Instance
->SharedWorkingBuffer
= AllocateAlignedPages (
186 EFI_SIZE_TO_PAGES (PcdGet32 (PcdDiskIoDataBufferBlockNum
) * Instance
->BlockIo
->Media
->BlockSize
),
187 Instance
->BlockIo
->Media
->IoAlign
189 if (Instance
->SharedWorkingBuffer
== NULL
) {
190 Status
= EFI_OUT_OF_RESOURCES
;
195 // Install protocol interfaces for the Disk IO device.
197 if (Instance
->BlockIo2
!= NULL
) {
198 Status
= gBS
->InstallMultipleProtocolInterfaces (
200 &gEfiDiskIoProtocolGuid
, &Instance
->DiskIo
,
201 &gEfiDiskIo2ProtocolGuid
, &Instance
->DiskIo2
,
205 Status
= gBS
->InstallMultipleProtocolInterfaces (
207 &gEfiDiskIoProtocolGuid
, &Instance
->DiskIo
,
213 if (EFI_ERROR (Status
)) {
214 if (Instance
!= NULL
&& Instance
->SharedWorkingBuffer
!= NULL
) {
216 Instance
->SharedWorkingBuffer
,
217 EFI_SIZE_TO_PAGES (PcdGet32 (PcdDiskIoDataBufferBlockNum
) * Instance
->BlockIo
->Media
->BlockSize
)
221 if (Instance
!= NULL
) {
227 &gEfiBlockIoProtocolGuid
,
228 This
->DriverBindingHandle
,
234 gBS
->RestoreTPL (OldTpl
);
239 Stop this driver on ControllerHandle by removing Disk IO protocol and closing
240 the Block IO protocol on ControllerHandle.
242 @param This Protocol instance pointer.
243 @param ControllerHandle Handle of device to stop driver on
244 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
245 children is zero stop the entire bus driver.
246 @param ChildHandleBuffer List of Child Handles to Stop.
248 @retval EFI_SUCCESS This driver is removed ControllerHandle
249 @retval other This driver was not removed from this device
254 DiskIoDriverBindingStop (
255 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
256 IN EFI_HANDLE ControllerHandle
,
257 IN UINTN NumberOfChildren
,
258 IN EFI_HANDLE
*ChildHandleBuffer
262 EFI_DISK_IO_PROTOCOL
*DiskIo
;
263 EFI_DISK_IO2_PROTOCOL
*DiskIo2
;
264 DISK_IO_PRIVATE_DATA
*Instance
;
268 // Get our context back.
270 Status
= gBS
->OpenProtocol (
272 &gEfiDiskIoProtocolGuid
,
274 This
->DriverBindingHandle
,
276 EFI_OPEN_PROTOCOL_GET_PROTOCOL
278 if (EFI_ERROR (Status
)) {
281 Status
= gBS
->OpenProtocol (
283 &gEfiDiskIo2ProtocolGuid
,
285 This
->DriverBindingHandle
,
287 EFI_OPEN_PROTOCOL_GET_PROTOCOL
289 if (EFI_ERROR (Status
)) {
293 Instance
= DISK_IO_PRIVATE_DATA_FROM_DISK_IO (DiskIo
);
295 if (DiskIo2
!= NULL
) {
297 // Call BlockIo2::Reset() to terminate any in-flight non-blocking I/O requests
299 ASSERT (Instance
->BlockIo2
!= NULL
);
300 Status
= Instance
->BlockIo2
->Reset (Instance
->BlockIo2
, FALSE
);
301 if (EFI_ERROR (Status
)) {
304 Status
= gBS
->UninstallMultipleProtocolInterfaces (
306 &gEfiDiskIoProtocolGuid
, &Instance
->DiskIo
,
307 &gEfiDiskIo2ProtocolGuid
, &Instance
->DiskIo2
,
311 Status
= gBS
->UninstallMultipleProtocolInterfaces (
313 &gEfiDiskIoProtocolGuid
, &Instance
->DiskIo
,
317 if (!EFI_ERROR (Status
)) {
320 EfiAcquireLock (&Instance
->TaskQueueLock
);
321 AllTaskDone
= IsListEmpty (&Instance
->TaskQueue
);
322 EfiReleaseLock (&Instance
->TaskQueueLock
);
323 } while (!AllTaskDone
);
326 Instance
->SharedWorkingBuffer
,
327 EFI_SIZE_TO_PAGES (PcdGet32 (PcdDiskIoDataBufferBlockNum
) * Instance
->BlockIo
->Media
->BlockSize
)
330 Status
= gBS
->CloseProtocol (
332 &gEfiBlockIoProtocolGuid
,
333 This
->DriverBindingHandle
,
336 ASSERT_EFI_ERROR (Status
);
337 if (DiskIo2
!= NULL
) {
338 Status
= gBS
->CloseProtocol (
340 &gEfiBlockIo2ProtocolGuid
,
341 This
->DriverBindingHandle
,
344 ASSERT_EFI_ERROR (Status
);
355 Destroy the sub task.
357 @param Instance Pointer to the DISK_IO_PRIVATE_DATA.
358 @param Subtask Subtask.
360 @return LIST_ENTRY * Pointer to the next link of subtask.
363 DiskIoDestroySubtask (
364 IN DISK_IO_PRIVATE_DATA
*Instance
,
365 IN DISK_IO_SUBTASK
*Subtask
370 if (Subtask
->Task
!= NULL
) {
371 EfiAcquireLock (&Subtask
->Task
->SubtasksLock
);
373 Link
= RemoveEntryList (&Subtask
->Link
);
374 if (Subtask
->Task
!= NULL
) {
375 EfiReleaseLock (&Subtask
->Task
->SubtasksLock
);
378 if (!Subtask
->Blocking
) {
379 if (Subtask
->WorkingBuffer
!= NULL
) {
381 Subtask
->WorkingBuffer
,
382 Subtask
->Length
< Instance
->BlockIo
->Media
->BlockSize
383 ? EFI_SIZE_TO_PAGES (Instance
->BlockIo
->Media
->BlockSize
)
384 : EFI_SIZE_TO_PAGES (Subtask
->Length
)
387 if (Subtask
->BlockIo2Token
.Event
!= NULL
) {
388 gBS
->CloseEvent (Subtask
->BlockIo2Token
.Event
);
397 The callback for the BlockIo2 ReadBlocksEx/WriteBlocksEx.
398 @param Event Event whose notification function is being invoked.
399 @param Context The pointer to the notification function's context,
400 which points to the DISK_IO_SUBTASK instance.
404 DiskIo2OnReadWriteComplete (
409 DISK_IO_SUBTASK
*Subtask
;
411 EFI_STATUS TransactionStatus
;
412 DISK_IO_PRIVATE_DATA
*Instance
;
414 Subtask
= (DISK_IO_SUBTASK
*) Context
;
415 TransactionStatus
= Subtask
->BlockIo2Token
.TransactionStatus
;
416 Task
= Subtask
->Task
;
417 Instance
= Task
->Instance
;
419 ASSERT (Subtask
->Signature
== DISK_IO_SUBTASK_SIGNATURE
);
420 ASSERT (Instance
->Signature
== DISK_IO_PRIVATE_DATA_SIGNATURE
);
421 ASSERT (Task
->Signature
== DISK_IO2_TASK_SIGNATURE
);
423 if ((Subtask
->WorkingBuffer
!= NULL
) && !EFI_ERROR (TransactionStatus
) &&
424 (Task
->Token
!= NULL
) && !Subtask
->Write
426 CopyMem (Subtask
->Buffer
, Subtask
->WorkingBuffer
+ Subtask
->Offset
, Subtask
->Length
);
429 DiskIoDestroySubtask (Instance
, Subtask
);
431 if (EFI_ERROR (TransactionStatus
) || IsListEmpty (&Task
->Subtasks
)) {
432 if (Task
->Token
!= NULL
) {
434 // Signal error status once the subtask is failed.
435 // Or signal the last status once the last subtask is finished.
437 Task
->Token
->TransactionStatus
= TransactionStatus
;
438 gBS
->SignalEvent (Task
->Token
->Event
);
441 // Mark token to NULL indicating the Task is a dead task.
451 @param Write TRUE: Write request; FALSE: Read request.
452 @param Lba The starting logical block address to read from on the device.
453 @param Offset The starting byte offset to read from the LBA.
454 @param Length The number of bytes to read from the device.
455 @param WorkingBuffer The aligned buffer to hold the data for reading or writing.
456 @param Buffer The buffer to hold the data for reading or writing.
457 @param Blocking TRUE: Blocking request; FALSE: Non-blocking request.
459 @return A pointer to the created subtask.
462 DiskIoCreateSubtask (
467 IN VOID
*WorkingBuffer
, OPTIONAL
472 DISK_IO_SUBTASK
*Subtask
;
475 Subtask
= AllocateZeroPool (sizeof (DISK_IO_SUBTASK
));
476 if (Subtask
== NULL
) {
479 Subtask
->Signature
= DISK_IO_SUBTASK_SIGNATURE
;
480 Subtask
->Write
= Write
;
482 Subtask
->Offset
= Offset
;
483 Subtask
->Length
= Length
;
484 Subtask
->WorkingBuffer
= WorkingBuffer
;
485 Subtask
->Buffer
= Buffer
;
486 Subtask
->Blocking
= Blocking
;
488 Status
= gBS
->CreateEvent (
491 DiskIo2OnReadWriteComplete
,
493 &Subtask
->BlockIo2Token
.Event
495 if (EFI_ERROR (Status
)) {
502 " %c:Lba/Offset/Length/WorkingBuffer/Buffer = %016lx/%08x/%08x/%08x/%08x\n",
503 Write
? 'W': 'R', Lba
, Offset
, Length
, WorkingBuffer
, Buffer
510 Create the subtask list.
512 @param Instance Pointer to the DISK_IO_PRIVATE_DATA.
513 @param Write TRUE: Write request; FALSE: Read request.
514 @param Offset The starting byte offset to read from the device.
515 @param BufferSize The size in bytes of Buffer. The number of bytes to read from the device.
516 @param Buffer A pointer to the buffer for the data.
517 @param Blocking TRUE: Blocking request; FALSE: Non-blocking request.
518 @param SharedWorkingBuffer The aligned buffer to hold the data for reading or writing.
519 @param Subtasks The subtask list header.
521 @retval TRUE The subtask list is created successfully.
522 @retval FALSE The subtask list is not created.
525 DiskIoCreateSubtaskList (
526 IN DISK_IO_PRIVATE_DATA
*Instance
,
532 IN VOID
*SharedWorkingBuffer
,
533 IN OUT LIST_ENTRY
*Subtasks
544 UINTN DataBufferSize
;
545 DISK_IO_SUBTASK
*Subtask
;
549 DEBUG ((EFI_D_BLKIO
, "DiskIo: Create subtasks for task: Offset/BufferSize/Buffer = %016lx/%08x/%08x\n", Offset
, BufferSize
, Buffer
));
551 BlockSize
= Instance
->BlockIo
->Media
->BlockSize
;
552 IoAlign
= Instance
->BlockIo
->Media
->IoAlign
;
557 Lba
= DivU64x32Remainder (Offset
, BlockSize
, &UnderRun
);
558 BufferPtr
= (UINT8
*) Buffer
;
561 // Special handling for zero BufferSize
563 if (BufferSize
== 0) {
564 Subtask
= DiskIoCreateSubtask (Write
, Lba
, UnderRun
, 0, NULL
, BufferPtr
, Blocking
);
565 if (Subtask
== NULL
) {
568 InsertTailList (Subtasks
, &Subtask
->Link
);
573 Length
= MIN (BlockSize
- UnderRun
, BufferSize
);
575 WorkingBuffer
= SharedWorkingBuffer
;
577 WorkingBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BlockSize
), IoAlign
);
578 if (WorkingBuffer
== NULL
) {
584 // A half write operation can be splitted to a blocking block-read and half write operation
585 // This can simplify the sub task processing logic
587 Subtask
= DiskIoCreateSubtask (FALSE
, Lba
, 0, BlockSize
, NULL
, WorkingBuffer
, TRUE
);
588 if (Subtask
== NULL
) {
591 InsertTailList (Subtasks
, &Subtask
->Link
);
594 Subtask
= DiskIoCreateSubtask (Write
, Lba
, UnderRun
, Length
, WorkingBuffer
, BufferPtr
, Blocking
);
595 if (Subtask
== NULL
) {
598 InsertTailList (Subtasks
, &Subtask
->Link
);
602 BufferSize
-= Length
;
606 OverRunLba
= Lba
+ DivU64x32Remainder (BufferSize
, BlockSize
, &OverRun
);
607 BufferSize
-= OverRun
;
611 WorkingBuffer
= SharedWorkingBuffer
;
613 WorkingBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BlockSize
), IoAlign
);
614 if (WorkingBuffer
== NULL
) {
620 // A half write operation can be splitted to a blocking block-read and half write operation
621 // This can simplify the sub task processing logic
623 Subtask
= DiskIoCreateSubtask (FALSE
, OverRunLba
, 0, BlockSize
, NULL
, WorkingBuffer
, TRUE
);
624 if (Subtask
== NULL
) {
627 InsertTailList (Subtasks
, &Subtask
->Link
);
630 Subtask
= DiskIoCreateSubtask (Write
, OverRunLba
, 0, OverRun
, WorkingBuffer
, BufferPtr
+ BufferSize
, Blocking
);
631 if (Subtask
== NULL
) {
634 InsertTailList (Subtasks
, &Subtask
->Link
);
637 if (OverRunLba
> Lba
) {
639 // If the DiskIo maps directly to a BlockIo device do the read.
641 if (ALIGN_POINTER (BufferPtr
, IoAlign
) == BufferPtr
) {
642 Subtask
= DiskIoCreateSubtask (Write
, Lba
, 0, BufferSize
, NULL
, BufferPtr
, Blocking
);
643 if (Subtask
== NULL
) {
646 InsertTailList (Subtasks
, &Subtask
->Link
);
648 BufferPtr
+= BufferSize
;
649 Offset
+= BufferSize
;
650 BufferSize
-= BufferSize
;
655 // Use the allocated buffer instead of the original buffer
656 // to avoid alignment issue.
658 for (; Lba
< OverRunLba
; Lba
+= PcdGet32 (PcdDiskIoDataBufferBlockNum
)) {
659 DataBufferSize
= MIN (BufferSize
, PcdGet32 (PcdDiskIoDataBufferBlockNum
) * BlockSize
);
661 Subtask
= DiskIoCreateSubtask (Write
, Lba
, 0, DataBufferSize
, SharedWorkingBuffer
, BufferPtr
, Blocking
);
662 if (Subtask
== NULL
) {
665 InsertTailList (Subtasks
, &Subtask
->Link
);
667 BufferPtr
+= DataBufferSize
;
668 Offset
+= DataBufferSize
;
669 BufferSize
-= DataBufferSize
;
672 WorkingBuffer
= AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize
), IoAlign
);
673 if (WorkingBuffer
== NULL
) {
675 // If there is not enough memory, downgrade to blocking access
677 DEBUG ((EFI_D_VERBOSE
, "DiskIo: No enough memory so downgrade to blocking access\n"));
678 if (!DiskIoCreateSubtaskList (Instance
, Write
, Offset
, BufferSize
, BufferPtr
, TRUE
, SharedWorkingBuffer
, Subtasks
)) {
682 Subtask
= DiskIoCreateSubtask (Write
, Lba
, 0, BufferSize
, WorkingBuffer
, BufferPtr
, Blocking
);
683 if (Subtask
== NULL
) {
686 InsertTailList (Subtasks
, &Subtask
->Link
);
689 BufferPtr
+= BufferSize
;
690 Offset
+= BufferSize
;
691 BufferSize
-= BufferSize
;
696 ASSERT (BufferSize
== 0);
702 // Remove all the subtasks.
704 for (Link
= GetFirstNode (Subtasks
); !IsNull (Subtasks
, Link
); ) {
705 Subtask
= CR (Link
, DISK_IO_SUBTASK
, Link
, DISK_IO_SUBTASK_SIGNATURE
);
706 Link
= DiskIoDestroySubtask (Instance
, Subtask
);
712 Terminate outstanding asynchronous requests to a device.
714 @param This Indicates a pointer to the calling context.
716 @retval EFI_SUCCESS All outstanding requests were successfully terminated.
717 @retval EFI_DEVICE_ERROR The device reported an error while performing the cancel
723 IN EFI_DISK_IO2_PROTOCOL
*This
726 DISK_IO_PRIVATE_DATA
*Instance
;
730 Instance
= DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This
);
732 EfiAcquireLock (&Instance
->TaskQueueLock
);
734 for (Link
= GetFirstNode (&Instance
->TaskQueue
)
735 ; !IsNull (&Instance
->TaskQueue
, Link
)
736 ; Link
= GetNextNode (&Instance
->TaskQueue
, Link
)
738 Task
= CR (Link
, DISK_IO2_TASK
, Link
, DISK_IO2_TASK_SIGNATURE
);
740 if (Task
->Token
!= NULL
) {
741 Task
->Token
->TransactionStatus
= EFI_ABORTED
;
742 gBS
->SignalEvent (Task
->Token
->Event
);
744 // Set Token to NULL so that the further BlockIo2 responses will be ignored
750 EfiReleaseLock (&Instance
->TaskQueueLock
);
756 Remove the completed tasks from Instance->TaskQueue. Completed tasks are those who don't have any subtasks.
758 @param Instance Pointer to the DISK_IO_PRIVATE_DATA.
760 @retval TRUE The Instance->TaskQueue is empty after the completed tasks are removed.
761 @retval FALSE The Instance->TaskQueue is not empty after the completed tasks are removed.
764 DiskIo2RemoveCompletedTask (
765 IN DISK_IO_PRIVATE_DATA
*Instance
774 EfiAcquireLock (&Instance
->TaskQueueLock
);
775 for (Link
= GetFirstNode (&Instance
->TaskQueue
); !IsNull (&Instance
->TaskQueue
, Link
); ) {
776 Task
= CR (Link
, DISK_IO2_TASK
, Link
, DISK_IO2_TASK_SIGNATURE
);
777 if (IsListEmpty (&Task
->Subtasks
)) {
778 Link
= RemoveEntryList (&Task
->Link
);
779 ASSERT (Task
->Token
== NULL
);
782 Link
= GetNextNode (&Instance
->TaskQueue
, Link
);
786 EfiReleaseLock (&Instance
->TaskQueueLock
);
792 Common routine to access the disk.
794 @param Instance Pointer to the DISK_IO_PRIVATE_DATA.
795 @param Write TRUE: Write operation; FALSE: Read operation.
796 @param MediaId ID of the medium to access.
797 @param Offset The starting byte offset on the logical block I/O device to access.
798 @param Token A pointer to the token associated with the transaction.
799 If this field is NULL, synchronous/blocking IO is performed.
800 @param BufferSize The size in bytes of Buffer. The number of bytes to read from the device.
801 @param Buffer A pointer to the destination buffer for the data.
802 The caller is responsible either having implicit or explicit ownership of the buffer.
805 DiskIo2ReadWriteDisk (
806 IN DISK_IO_PRIVATE_DATA
*Instance
,
810 IN EFI_DISK_IO2_TOKEN
*Token
,
816 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
817 EFI_BLOCK_IO2_PROTOCOL
*BlockIo2
;
818 EFI_BLOCK_IO_MEDIA
*Media
;
820 LIST_ENTRY
*NextLink
;
822 DISK_IO_SUBTASK
*Subtask
;
826 BOOLEAN SubtaskBlocking
;
827 LIST_ENTRY
*SubtasksPtr
;
830 BlockIo
= Instance
->BlockIo
;
831 BlockIo2
= Instance
->BlockIo2
;
832 Media
= BlockIo
->Media
;
833 Status
= EFI_SUCCESS
;
834 Blocking
= (BOOLEAN
) ((Token
== NULL
) || (Token
->Event
== NULL
));
836 if (Media
->MediaId
!= MediaId
) {
837 return EFI_MEDIA_CHANGED
;
840 if (Write
&& Media
->ReadOnly
) {
841 return EFI_WRITE_PROTECTED
;
846 // Wait till pending async task is completed.
848 while (!DiskIo2RemoveCompletedTask (Instance
));
850 SubtasksPtr
= &Subtasks
;
852 DiskIo2RemoveCompletedTask (Instance
);
853 Task
= AllocatePool (sizeof (DISK_IO2_TASK
));
855 return EFI_OUT_OF_RESOURCES
;
858 EfiAcquireLock (&Instance
->TaskQueueLock
);
859 InsertTailList (&Instance
->TaskQueue
, &Task
->Link
);
860 EfiReleaseLock (&Instance
->TaskQueueLock
);
862 Task
->Signature
= DISK_IO2_TASK_SIGNATURE
;
863 Task
->Instance
= Instance
;
865 EfiInitializeLock (&Task
->SubtasksLock
, TPL_NOTIFY
);
867 SubtasksPtr
= &Task
->Subtasks
;
870 InitializeListHead (SubtasksPtr
);
871 if (!DiskIoCreateSubtaskList (Instance
, Write
, Offset
, BufferSize
, Buffer
, Blocking
, Instance
->SharedWorkingBuffer
, SubtasksPtr
)) {
875 return EFI_OUT_OF_RESOURCES
;
877 ASSERT (!IsListEmpty (SubtasksPtr
));
879 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
880 for ( Link
= GetFirstNode (SubtasksPtr
), NextLink
= GetNextNode (SubtasksPtr
, Link
)
881 ; !IsNull (SubtasksPtr
, Link
)
882 ; Link
= NextLink
, NextLink
= GetNextNode (SubtasksPtr
, NextLink
)
884 Subtask
= CR (Link
, DISK_IO_SUBTASK
, Link
, DISK_IO_SUBTASK_SIGNATURE
);
885 Subtask
->Task
= Task
;
886 SubtaskBlocking
= Subtask
->Blocking
;
888 ASSERT ((Subtask
->Length
% Media
->BlockSize
== 0) || (Subtask
->Length
< Media
->BlockSize
));
890 if (Subtask
->Write
) {
894 if (Subtask
->WorkingBuffer
!= NULL
) {
896 // A sub task before this one should be a block read operation, causing the WorkingBuffer filled with the entire one block data.
898 CopyMem (Subtask
->WorkingBuffer
+ Subtask
->Offset
, Subtask
->Buffer
, Subtask
->Length
);
901 if (SubtaskBlocking
) {
902 Status
= BlockIo
->WriteBlocks (
906 (Subtask
->Length
% Media
->BlockSize
== 0) ? Subtask
->Length
: Media
->BlockSize
,
907 (Subtask
->WorkingBuffer
!= NULL
) ? Subtask
->WorkingBuffer
: Subtask
->Buffer
910 Status
= BlockIo2
->WriteBlocksEx (
914 &Subtask
->BlockIo2Token
,
915 (Subtask
->Length
% Media
->BlockSize
== 0) ? Subtask
->Length
: Media
->BlockSize
,
916 (Subtask
->WorkingBuffer
!= NULL
) ? Subtask
->WorkingBuffer
: Subtask
->Buffer
924 if (SubtaskBlocking
) {
925 Status
= BlockIo
->ReadBlocks (
929 (Subtask
->Length
% Media
->BlockSize
== 0) ? Subtask
->Length
: Media
->BlockSize
,
930 (Subtask
->WorkingBuffer
!= NULL
) ? Subtask
->WorkingBuffer
: Subtask
->Buffer
932 if (!EFI_ERROR (Status
) && (Subtask
->WorkingBuffer
!= NULL
)) {
933 CopyMem (Subtask
->Buffer
, Subtask
->WorkingBuffer
+ Subtask
->Offset
, Subtask
->Length
);
936 Status
= BlockIo2
->ReadBlocksEx (
940 &Subtask
->BlockIo2Token
,
941 (Subtask
->Length
% Media
->BlockSize
== 0) ? Subtask
->Length
: Media
->BlockSize
,
942 (Subtask
->WorkingBuffer
!= NULL
) ? Subtask
->WorkingBuffer
: Subtask
->Buffer
947 if (SubtaskBlocking
|| EFI_ERROR (Status
)) {
949 // Make sure the subtask list only contains non-blocking subtasks.
950 // Remove failed non-blocking subtasks as well because the callback won't be called.
952 DiskIoDestroySubtask (Instance
, Subtask
);
955 if (EFI_ERROR (Status
)) {
960 gBS
->RaiseTPL (TPL_NOTIFY
);
963 // Remove all the remaining subtasks when failure.
964 // We shouldn't remove all the tasks because the non-blocking requests have been submitted and cannot be canceled.
966 if (EFI_ERROR (Status
)) {
967 while (!IsNull (SubtasksPtr
, NextLink
)) {
968 Subtask
= CR (NextLink
, DISK_IO_SUBTASK
, Link
, DISK_IO_SUBTASK_SIGNATURE
);
969 NextLink
= DiskIoDestroySubtask (Instance
, Subtask
);
974 // It's possible that the non-blocking subtasks finish before raising TPL to NOTIFY,
975 // so the subtasks list might be empty at this point.
977 if (!Blocking
&& IsListEmpty (SubtasksPtr
)) {
978 EfiAcquireLock (&Instance
->TaskQueueLock
);
979 RemoveEntryList (&Task
->Link
);
980 EfiReleaseLock (&Instance
->TaskQueueLock
);
982 if (!EFI_ERROR (Status
) && (Task
->Token
!= NULL
)) {
984 // Task->Token should be set to NULL by the DiskIo2OnReadWriteComplete
985 // It it's not, that means the non-blocking request was downgraded to blocking request.
987 DEBUG ((EFI_D_VERBOSE
, "DiskIo: Non-blocking request was downgraded to blocking request, signal event directly.\n"));
988 Task
->Token
->TransactionStatus
= Status
;
989 gBS
->SignalEvent (Task
->Token
->Event
);
995 gBS
->RestoreTPL (OldTpl
);
1001 Reads a specified number of bytes from a device.
1003 @param This Indicates a pointer to the calling context.
1004 @param MediaId ID of the medium to be read.
1005 @param Offset The starting byte offset on the logical block I/O device to read from.
1006 @param Token A pointer to the token associated with the transaction.
1007 If this field is NULL, synchronous/blocking IO is performed.
1008 @param BufferSize The size in bytes of Buffer. The number of bytes to read from the device.
1009 @param Buffer A pointer to the destination buffer for the data.
1010 The caller is responsible either having implicit or explicit ownership of the buffer.
1012 @retval EFI_SUCCESS If Event is NULL (blocking I/O): The data was read correctly from the device.
1013 If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
1014 Event will be signaled upon completion.
1015 @retval EFI_DEVICE_ERROR The device reported an error while performing the write.
1016 @retval EFI_NO_MEDIA There is no medium in the device.
1017 @retval EFI_MEDIA_CHNAGED The MediaId is not for the current medium.
1018 @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not valid for the device.
1019 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1025 IN EFI_DISK_IO2_PROTOCOL
*This
,
1028 IN OUT EFI_DISK_IO2_TOKEN
*Token
,
1029 IN UINTN BufferSize
,
1033 return DiskIo2ReadWriteDisk (
1034 DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This
),
1035 FALSE
, MediaId
, Offset
, Token
, BufferSize
, (UINT8
*) Buffer
1040 Writes a specified number of bytes to a device.
1042 @param This Indicates a pointer to the calling context.
1043 @param MediaId ID of the medium to be written.
1044 @param Offset The starting byte offset on the logical block I/O device to write to.
1045 @param Token A pointer to the token associated with the transaction.
1046 If this field is NULL, synchronous/blocking IO is performed.
1047 @param BufferSize The size in bytes of Buffer. The number of bytes to write to the device.
1048 @param Buffer A pointer to the buffer containing the data to be written.
1050 @retval EFI_SUCCESS If Event is NULL (blocking I/O): The data was written correctly to the device.
1051 If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
1052 Event will be signaled upon completion.
1053 @retval EFI_WRITE_PROTECTED The device cannot be written to.
1054 @retval EFI_DEVICE_ERROR The device reported an error while performing the write operation.
1055 @retval EFI_NO_MEDIA There is no medium in the device.
1056 @retval EFI_MEDIA_CHNAGED The MediaId is not for the current medium.
1057 @retval EFI_INVALID_PARAMETER The write request contains device addresses that are not valid for the device.
1058 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1063 DiskIo2WriteDiskEx (
1064 IN EFI_DISK_IO2_PROTOCOL
*This
,
1067 IN OUT EFI_DISK_IO2_TOKEN
*Token
,
1068 IN UINTN BufferSize
,
1072 return DiskIo2ReadWriteDisk (
1073 DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This
),
1074 TRUE
, MediaId
, Offset
, Token
, BufferSize
, (UINT8
*) Buffer
1079 The callback for the BlockIo2 FlushBlocksEx.
1080 @param Event Event whose notification function is being invoked.
1081 @param Context The pointer to the notification function's context,
1082 which points to the DISK_IO2_FLUSH_TASK instance.
1086 DiskIo2OnFlushComplete (
1091 DISK_IO2_FLUSH_TASK
*Task
;
1093 gBS
->CloseEvent (Event
);
1095 Task
= (DISK_IO2_FLUSH_TASK
*) Context
;
1096 ASSERT (Task
->Signature
== DISK_IO2_FLUSH_TASK_SIGNATURE
);
1097 Task
->Token
->TransactionStatus
= Task
->BlockIo2Token
.TransactionStatus
;
1098 gBS
->SignalEvent (Task
->Token
->Event
);
1104 Flushes all modified data to the physical device.
1106 @param This Indicates a pointer to the calling context.
1107 @param Token A pointer to the token associated with the transaction.
1108 If this field is NULL, synchronous/blocking IO is performed.
1110 @retval EFI_SUCCESS If Event is NULL (blocking I/O): The data was flushed successfully to the device.
1111 If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
1112 Event will be signaled upon completion.
1113 @retval EFI_WRITE_PROTECTED The device cannot be written to.
1114 @retval EFI_DEVICE_ERROR The device reported an error while performing the write operation.
1115 @retval EFI_NO_MEDIA There is no medium in the device.
1116 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1120 DiskIo2FlushDiskEx (
1121 IN EFI_DISK_IO2_PROTOCOL
*This
,
1122 IN OUT EFI_DISK_IO2_TOKEN
*Token
1126 DISK_IO2_FLUSH_TASK
*Task
;
1127 DISK_IO_PRIVATE_DATA
*Private
;
1129 Private
= DISK_IO_PRIVATE_DATA_FROM_DISK_IO2 (This
);
1131 if ((Token
!= NULL
) && (Token
->Event
!= NULL
)) {
1132 Task
= AllocatePool (sizeof (DISK_IO2_FLUSH_TASK
));
1134 return EFI_OUT_OF_RESOURCES
;
1137 Status
= gBS
->CreateEvent (
1140 DiskIo2OnFlushComplete
,
1142 &Task
->BlockIo2Token
.Event
1144 if (EFI_ERROR (Status
)) {
1148 Task
->Signature
= DISK_IO2_FLUSH_TASK_SIGNATURE
;
1149 Task
->Token
= Token
;
1150 Status
= Private
->BlockIo2
->FlushBlocksEx (Private
->BlockIo2
, &Task
->BlockIo2Token
);
1151 if (EFI_ERROR (Status
)) {
1152 gBS
->CloseEvent (Task
->BlockIo2Token
.Event
);
1156 Status
= Private
->BlockIo2
->FlushBlocksEx (Private
->BlockIo2
, NULL
);
1163 Read BufferSize bytes from Offset into Buffer.
1164 Reads may support reads that are not aligned on
1165 sector boundaries. There are three cases:
1166 UnderRun - The first byte is not on a sector boundary or the read request is
1167 less than a sector in length.
1168 Aligned - A read of N contiguous sectors.
1169 OverRun - The last byte is not on a sector boundary.
1171 @param This Protocol instance pointer.
1172 @param MediaId Id of the media, changes every time the media is replaced.
1173 @param Offset The starting byte offset to read from
1174 @param BufferSize Size of Buffer
1175 @param Buffer Buffer containing read data
1177 @retval EFI_SUCCESS The data was read correctly from the device.
1178 @retval EFI_DEVICE_ERROR The device reported an error while performing the read.
1179 @retval EFI_NO_MEDIA There is no media in the device.
1180 @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
1181 @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not
1182 valid for the device.
1188 IN EFI_DISK_IO_PROTOCOL
*This
,
1191 IN UINTN BufferSize
,
1195 return DiskIo2ReadWriteDisk (
1196 DISK_IO_PRIVATE_DATA_FROM_DISK_IO (This
),
1197 FALSE
, MediaId
, Offset
, NULL
, BufferSize
, (UINT8
*) Buffer
1203 Writes BufferSize bytes from Buffer into Offset.
1204 Writes may require a read modify write to support writes that are not
1205 aligned on sector boundaries. There are three cases:
1206 UnderRun - The first byte is not on a sector boundary or the write request
1207 is less than a sector in length. Read modify write is required.
1208 Aligned - A write of N contiguous sectors.
1209 OverRun - The last byte is not on a sector boundary. Read modified write
1212 @param This Protocol instance pointer.
1213 @param MediaId Id of the media, changes every time the media is replaced.
1214 @param Offset The starting byte offset to read from
1215 @param BufferSize Size of Buffer
1216 @param Buffer Buffer containing read data
1218 @retval EFI_SUCCESS The data was written correctly to the device.
1219 @retval EFI_WRITE_PROTECTED The device can not be written to.
1220 @retval EFI_DEVICE_ERROR The device reported an error while performing the write.
1221 @retval EFI_NO_MEDIA There is no media in the device.
1222 @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
1223 @retval EFI_INVALID_PARAMETER The write request contains device addresses that are not
1224 valid for the device.
1230 IN EFI_DISK_IO_PROTOCOL
*This
,
1233 IN UINTN BufferSize
,
1237 return DiskIo2ReadWriteDisk (
1238 DISK_IO_PRIVATE_DATA_FROM_DISK_IO (This
),
1239 TRUE
, MediaId
, Offset
, NULL
, BufferSize
, (UINT8
*) Buffer
1244 The user Entry Point for module DiskIo. The user code starts with this function.
1246 @param[in] ImageHandle The firmware allocated handle for the EFI image.
1247 @param[in] SystemTable A pointer to the EFI System Table.
1249 @retval EFI_SUCCESS The entry point is executed successfully.
1250 @retval other Some error occurs when executing this entry point.
1256 IN EFI_HANDLE ImageHandle
,
1257 IN EFI_SYSTEM_TABLE
*SystemTable
1263 // Install driver model protocol(s).
1265 Status
= EfiLibInstallDriverBindingComponentName2 (
1268 &gDiskIoDriverBinding
,
1270 &gDiskIoComponentName
,
1271 &gDiskIoComponentName2
1273 ASSERT_EFI_ERROR (Status
);