2 Partition driver that produces logical BlockIo devices from a physical
3 BlockIo device. The logical BlockIo devices are based on the format
4 of the raw block devices media. Currently "El Torito CD-ROM", Legacy
5 MBR, and GPT partition schemes are supported.
7 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include "Partition.h"
22 // Partition Driver Global Variables.
24 EFI_DRIVER_BINDING_PROTOCOL gPartitionDriverBinding
= {
25 PartitionDriverBindingSupported
,
26 PartitionDriverBindingStart
,
27 PartitionDriverBindingStop
,
29 // Grub4Dos copies the BPB of the first partition to the MBR. If the
30 // DriverBindingStart() of the Fat driver gets run before that of Partition
31 // driver only the first partition can be recognized.
32 // Let the driver binding version of Partition driver be higher than that of
33 // Fat driver to make sure the DriverBindingStart() of the Partition driver
34 // gets run before that of Fat driver so that all the partitions can be recognized.
42 // Prioritized function list to detect partition table.
44 PARTITION_DETECT_ROUTINE mPartitionDetectRoutineTable
[] = {
45 PartitionInstallGptChildHandles
,
46 PartitionInstallElToritoChildHandles
,
47 PartitionInstallMbrChildHandles
,
52 Test to see if this driver supports ControllerHandle. Any ControllerHandle
53 than contains a BlockIo and DiskIo protocol or a BlockIo2 protocol can be
56 @param[in] This Protocol instance pointer.
57 @param[in] ControllerHandle Handle of device to test.
58 @param[in] RemainingDevicePath Optional parameter use to pick a specific child
61 @retval EFI_SUCCESS This driver supports this device
62 @retval EFI_ALREADY_STARTED This driver is already running on this device
63 @retval other This driver does not support this device
68 PartitionDriverBindingSupported (
69 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
70 IN EFI_HANDLE ControllerHandle
,
71 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
75 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
76 EFI_DISK_IO_PROTOCOL
*DiskIo
;
80 // Check RemainingDevicePath validation
82 if (RemainingDevicePath
!= NULL
) {
84 // Check if RemainingDevicePath is the End of Device Path Node,
85 // if yes, go on checking other conditions
87 if (!IsDevicePathEnd (RemainingDevicePath
)) {
89 // If RemainingDevicePath isn't the End of Device Path Node,
90 // check its validation
92 Node
= (EFI_DEV_PATH
*) RemainingDevicePath
;
93 if (Node
->DevPath
.Type
!= MEDIA_DEVICE_PATH
||
94 Node
->DevPath
.SubType
!= MEDIA_HARDDRIVE_DP
||
95 DevicePathNodeLength (&Node
->DevPath
) != sizeof (HARDDRIVE_DEVICE_PATH
)) {
96 return EFI_UNSUPPORTED
;
102 // Open the IO Abstraction(s) needed to perform the supported test
104 Status
= gBS
->OpenProtocol (
106 &gEfiDiskIoProtocolGuid
,
108 This
->DriverBindingHandle
,
110 EFI_OPEN_PROTOCOL_BY_DRIVER
112 if (Status
== EFI_ALREADY_STARTED
) {
115 if (EFI_ERROR (Status
)) {
119 // Close the I/O Abstraction(s) used to perform the supported test
123 &gEfiDiskIoProtocolGuid
,
124 This
->DriverBindingHandle
,
129 // Open the EFI Device Path protocol needed to perform the supported test
131 Status
= gBS
->OpenProtocol (
133 &gEfiDevicePathProtocolGuid
,
134 (VOID
**) &ParentDevicePath
,
135 This
->DriverBindingHandle
,
137 EFI_OPEN_PROTOCOL_BY_DRIVER
139 if (Status
== EFI_ALREADY_STARTED
) {
143 if (EFI_ERROR (Status
)) {
148 // Close protocol, don't use device path protocol in the Support() function
152 &gEfiDevicePathProtocolGuid
,
153 This
->DriverBindingHandle
,
158 // Open the IO Abstraction(s) needed to perform the supported test
160 Status
= gBS
->OpenProtocol (
162 &gEfiBlockIoProtocolGuid
,
164 This
->DriverBindingHandle
,
166 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
173 Start this driver on ControllerHandle by opening a Block IO or a Block IO2
174 or both, and Disk IO protocol, reading Device Path, and creating a child
175 handle with a Disk IO and device path protocol.
177 @param[in] This Protocol instance pointer.
178 @param[in] ControllerHandle Handle of device to bind driver to
179 @param[in] RemainingDevicePath Optional parameter use to pick a specific child
182 @retval EFI_SUCCESS This driver is added to ControllerHandle
183 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
184 @retval other This driver does not support this device
189 PartitionDriverBindingStart (
190 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
191 IN EFI_HANDLE ControllerHandle
,
192 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
196 EFI_STATUS OpenStatus
;
197 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
198 EFI_BLOCK_IO2_PROTOCOL
*BlockIo2
;
199 EFI_DISK_IO_PROTOCOL
*DiskIo
;
200 EFI_DISK_IO2_PROTOCOL
*DiskIo2
;
201 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
202 PARTITION_DETECT_ROUTINE
*Routine
;
203 BOOLEAN MediaPresent
;
207 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
209 // Check RemainingDevicePath validation
211 if (RemainingDevicePath
!= NULL
) {
213 // Check if RemainingDevicePath is the End of Device Path Node,
214 // if yes, return EFI_SUCCESS
216 if (IsDevicePathEnd (RemainingDevicePath
)) {
217 Status
= EFI_SUCCESS
;
223 // Try to open BlockIO and BlockIO2. If BlockIO would be opened, continue,
224 // otherwise, return error.
226 Status
= gBS
->OpenProtocol (
228 &gEfiBlockIoProtocolGuid
,
230 This
->DriverBindingHandle
,
232 EFI_OPEN_PROTOCOL_GET_PROTOCOL
234 if (EFI_ERROR (Status
)) {
238 Status
= gBS
->OpenProtocol (
240 &gEfiBlockIo2ProtocolGuid
,
242 This
->DriverBindingHandle
,
244 EFI_OPEN_PROTOCOL_GET_PROTOCOL
246 if (EFI_ERROR (Status
)) {
251 // Get the Device Path Protocol on ControllerHandle's handle.
253 Status
= gBS
->OpenProtocol (
255 &gEfiDevicePathProtocolGuid
,
256 (VOID
**) &ParentDevicePath
,
257 This
->DriverBindingHandle
,
259 EFI_OPEN_PROTOCOL_BY_DRIVER
261 if (EFI_ERROR (Status
) && Status
!= EFI_ALREADY_STARTED
) {
266 // Get the DiskIo and DiskIo2.
268 Status
= gBS
->OpenProtocol (
270 &gEfiDiskIoProtocolGuid
,
272 This
->DriverBindingHandle
,
274 EFI_OPEN_PROTOCOL_BY_DRIVER
276 if (EFI_ERROR (Status
) && Status
!= EFI_ALREADY_STARTED
) {
279 &gEfiDevicePathProtocolGuid
,
280 This
->DriverBindingHandle
,
288 Status
= gBS
->OpenProtocol (
290 &gEfiDiskIo2ProtocolGuid
,
292 This
->DriverBindingHandle
,
294 EFI_OPEN_PROTOCOL_BY_DRIVER
296 if (EFI_ERROR (Status
) && Status
!= EFI_ALREADY_STARTED
) {
301 // Try to read blocks when there's media or it is removable physical partition.
303 Status
= EFI_UNSUPPORTED
;
304 MediaPresent
= BlockIo
->Media
->MediaPresent
;
305 if (BlockIo
->Media
->MediaPresent
||
306 (BlockIo
->Media
->RemovableMedia
&& !BlockIo
->Media
->LogicalPartition
)) {
308 // Try for GPT, then El Torito, and then legacy MBR partition types. If the
309 // media supports a given partition type install child handles to represent
310 // the partitions described by the media.
312 Routine
= &mPartitionDetectRoutineTable
[0];
313 while (*Routine
!= NULL
) {
314 Status
= (*Routine
) (
323 if (!EFI_ERROR (Status
) || Status
== EFI_MEDIA_CHANGED
|| Status
== EFI_NO_MEDIA
) {
330 // In the case that the driver is already started (OpenStatus == EFI_ALREADY_STARTED),
331 // the DevicePathProtocol and the DiskIoProtocol are not actually opened by the
332 // driver. So don't try to close them. Otherwise, we will break the dependency
333 // between the controller and the driver set up before.
335 // In the case that when the media changes on a device it will Reinstall the
336 // BlockIo interaface. This will cause a call to our Stop(), and a subsequent
337 // reentrant call to our Start() successfully. We should leave the device open
338 // when this happen. The "media change" case includes either the status is
339 // EFI_MEDIA_CHANGED or it is a "media" to "no media" change.
341 if (EFI_ERROR (Status
) &&
342 !EFI_ERROR (OpenStatus
) &&
343 Status
!= EFI_MEDIA_CHANGED
&&
344 !(MediaPresent
&& Status
== EFI_NO_MEDIA
)) {
347 &gEfiDiskIoProtocolGuid
,
348 This
->DriverBindingHandle
,
352 // Close Parent DiskIo2 if has.
356 &gEfiDiskIo2ProtocolGuid
,
357 This
->DriverBindingHandle
,
363 &gEfiDevicePathProtocolGuid
,
364 This
->DriverBindingHandle
,
370 gBS
->RestoreTPL (OldTpl
);
375 Stop this driver on ControllerHandle. Support stopping any child handles
376 created by this driver.
378 @param This Protocol instance pointer.
379 @param ControllerHandle Handle of device to stop driver on
380 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
381 children is zero stop the entire bus driver.
382 @param ChildHandleBuffer List of Child Handles to Stop.
384 @retval EFI_SUCCESS This driver is removed ControllerHandle
385 @retval other This driver was not removed from this device
390 PartitionDriverBindingStop (
391 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
392 IN EFI_HANDLE ControllerHandle
,
393 IN UINTN NumberOfChildren
,
394 IN EFI_HANDLE
*ChildHandleBuffer
399 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
400 EFI_BLOCK_IO2_PROTOCOL
*BlockIo2
;
401 BOOLEAN AllChildrenStopped
;
402 PARTITION_PRIVATE_DATA
*Private
;
403 EFI_DISK_IO_PROTOCOL
*DiskIo
;
409 if (NumberOfChildren
== 0) {
411 // In the case of re-entry of the PartitionDriverBindingStop, the
412 // NumberOfChildren may not reflect the actual number of children on the
413 // bus driver. Hence, additional check is needed here.
415 if (HasChildren (ControllerHandle
)) {
416 DEBUG((EFI_D_ERROR
, "PartitionDriverBindingStop: Still has child.\n"));
417 return EFI_DEVICE_ERROR
;
421 // Close the bus driver
425 &gEfiDiskIoProtocolGuid
,
426 This
->DriverBindingHandle
,
430 // Close Parent BlockIO2 if has.
434 &gEfiDiskIo2ProtocolGuid
,
435 This
->DriverBindingHandle
,
441 &gEfiDevicePathProtocolGuid
,
442 This
->DriverBindingHandle
,
448 AllChildrenStopped
= TRUE
;
449 for (Index
= 0; Index
< NumberOfChildren
; Index
++) {
451 ChildHandleBuffer
[Index
],
452 &gEfiBlockIoProtocolGuid
,
454 This
->DriverBindingHandle
,
456 EFI_OPEN_PROTOCOL_GET_PROTOCOL
459 // Try to locate BlockIo2.
462 ChildHandleBuffer
[Index
],
463 &gEfiBlockIo2ProtocolGuid
,
465 This
->DriverBindingHandle
,
467 EFI_OPEN_PROTOCOL_GET_PROTOCOL
471 Private
= PARTITION_DEVICE_FROM_BLOCK_IO_THIS (BlockIo
);
472 if (Private
->InStop
) {
474 // If the child handle is going to be stopped again during the re-entry
475 // of DriverBindingStop, just do nothing.
479 Private
->InStop
= TRUE
;
481 BlockIo
->FlushBlocks (BlockIo
);
483 if (BlockIo2
!= NULL
) {
484 Status
= BlockIo2
->FlushBlocksEx (BlockIo2
, NULL
);
485 DEBUG((EFI_D_ERROR
, "PartitionDriverBindingStop: FlushBlocksEx returned with %r\n", Status
));
487 Status
= EFI_SUCCESS
;
492 &gEfiDiskIoProtocolGuid
,
493 This
->DriverBindingHandle
,
494 ChildHandleBuffer
[Index
]
497 // All Software protocols have be freed from the handle so remove it.
498 // Remove the BlockIo Protocol if has.
499 // Remove the BlockIo2 Protocol if has.
501 if (BlockIo2
!= NULL
) {
503 // Some device drivers might re-install the BlockIO(2) protocols for a
504 // media change condition. Therefore, if the FlushBlocksEx returned with
505 // EFI_MEDIA_CHANGED, just let the BindingStop fail to avoid potential
506 // reference of already stopped child handle.
508 if (Status
!= EFI_MEDIA_CHANGED
) {
509 Status
= gBS
->UninstallMultipleProtocolInterfaces (
510 ChildHandleBuffer
[Index
],
511 &gEfiDevicePathProtocolGuid
,
513 &gEfiBlockIoProtocolGuid
,
515 &gEfiBlockIo2ProtocolGuid
,
523 Status
= gBS
->UninstallMultipleProtocolInterfaces (
524 ChildHandleBuffer
[Index
],
525 &gEfiDevicePathProtocolGuid
,
527 &gEfiBlockIoProtocolGuid
,
535 if (EFI_ERROR (Status
)) {
536 Private
->InStop
= FALSE
;
539 &gEfiDiskIoProtocolGuid
,
541 This
->DriverBindingHandle
,
542 ChildHandleBuffer
[Index
],
543 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
546 FreePool (Private
->DevicePath
);
550 if (EFI_ERROR (Status
)) {
551 AllChildrenStopped
= FALSE
;
552 if (Status
== EFI_MEDIA_CHANGED
) {
558 if (!AllChildrenStopped
) {
559 return EFI_DEVICE_ERROR
;
567 Reset the Block Device.
569 @param This Protocol instance pointer.
570 @param ExtendedVerification Driver may perform diagnostics on reset.
572 @retval EFI_SUCCESS The device was reset.
573 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
580 IN EFI_BLOCK_IO_PROTOCOL
*This
,
581 IN BOOLEAN ExtendedVerification
584 PARTITION_PRIVATE_DATA
*Private
;
586 Private
= PARTITION_DEVICE_FROM_BLOCK_IO_THIS (This
);
588 return Private
->ParentBlockIo
->Reset (
589 Private
->ParentBlockIo
,
595 Probe the media status and return EFI_NO_MEDIA or EFI_MEDIA_CHANGED
596 for no media or media change case. Otherwise DefaultStatus is returned.
598 @param DiskIo Pointer to the DiskIo instance.
599 @param MediaId Id of the media, changes every time the media is replaced.
600 @param DefaultStatus The default status to return when it's not the no media
601 or media change case.
603 @retval EFI_NO_MEDIA There is no media.
604 @retval EFI_MEDIA_CHANGED The media was changed.
605 @retval others The default status to return.
609 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
611 IN EFI_STATUS DefaultStatus
618 // Read 1 byte from offset 0 to check if the MediaId is still valid.
619 // The reading operation is synchronious thus it is not worth it to
620 // allocate a buffer from the pool. The destination buffer for the
621 // data is in the stack.
623 Status
= DiskIo
->ReadDisk (DiskIo
, MediaId
, 0, 1, (VOID
*)Buffer
);
624 if ((Status
== EFI_NO_MEDIA
) || (Status
== EFI_MEDIA_CHANGED
)) {
627 return DefaultStatus
;
631 Read by using the Disk IO protocol on the parent device. Lba addresses
632 must be converted to byte offsets.
634 @param This Protocol instance pointer.
635 @param MediaId Id of the media, changes every time the media is replaced.
636 @param Lba The starting Logical Block Address to read from
637 @param BufferSize Size of Buffer, must be a multiple of device block size.
638 @param Buffer Buffer containing read data
640 @retval EFI_SUCCESS The data was read correctly from the device.
641 @retval EFI_DEVICE_ERROR The device reported an error while performing the read.
642 @retval EFI_NO_MEDIA There is no media in the device.
643 @retval EFI_MEDIA_CHANGED The MediaId does not matched the current device.
644 @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
645 @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not
646 valid for the device.
651 PartitionReadBlocks (
652 IN EFI_BLOCK_IO_PROTOCOL
*This
,
659 PARTITION_PRIVATE_DATA
*Private
;
662 Private
= PARTITION_DEVICE_FROM_BLOCK_IO_THIS (This
);
664 if (BufferSize
% Private
->BlockSize
!= 0) {
665 return ProbeMediaStatus (Private
->DiskIo
, MediaId
, EFI_BAD_BUFFER_SIZE
);
668 Offset
= MultU64x32 (Lba
, Private
->BlockSize
) + Private
->Start
;
669 if (Offset
+ BufferSize
> Private
->End
) {
670 return ProbeMediaStatus (Private
->DiskIo
, MediaId
, EFI_INVALID_PARAMETER
);
673 // Because some kinds of partition have different block size from their parent
674 // device, we call the Disk IO protocol on the parent device, not the Block IO
677 return Private
->DiskIo
->ReadDisk (Private
->DiskIo
, MediaId
, Offset
, BufferSize
, Buffer
);
681 Write by using the Disk IO protocol on the parent device. Lba addresses
682 must be converted to byte offsets.
684 @param[in] This Protocol instance pointer.
685 @param[in] MediaId Id of the media, changes every time the media is replaced.
686 @param[in] Lba The starting Logical Block Address to read from
687 @param[in] BufferSize Size of Buffer, must be a multiple of device block size.
688 @param[in] Buffer Buffer containing data to be written to device.
690 @retval EFI_SUCCESS The data was written correctly to the device.
691 @retval EFI_WRITE_PROTECTED The device can not be written to.
692 @retval EFI_DEVICE_ERROR The device reported an error while performing the write.
693 @retval EFI_NO_MEDIA There is no media in the device.
694 @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
695 @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
696 @retval EFI_INVALID_PARAMETER The write request contains a LBA that is not
697 valid for the device.
702 PartitionWriteBlocks (
703 IN EFI_BLOCK_IO_PROTOCOL
*This
,
710 PARTITION_PRIVATE_DATA
*Private
;
713 Private
= PARTITION_DEVICE_FROM_BLOCK_IO_THIS (This
);
715 if (BufferSize
% Private
->BlockSize
!= 0) {
716 return ProbeMediaStatus (Private
->DiskIo
, MediaId
, EFI_BAD_BUFFER_SIZE
);
719 Offset
= MultU64x32 (Lba
, Private
->BlockSize
) + Private
->Start
;
720 if (Offset
+ BufferSize
> Private
->End
) {
721 return ProbeMediaStatus (Private
->DiskIo
, MediaId
, EFI_INVALID_PARAMETER
);
724 // Because some kinds of partition have different block size from their parent
725 // device, we call the Disk IO protocol on the parent device, not the Block IO
728 return Private
->DiskIo
->WriteDisk (Private
->DiskIo
, MediaId
, Offset
, BufferSize
, Buffer
);
733 Flush the parent Block Device.
735 @param This Protocol instance pointer.
737 @retval EFI_SUCCESS All outstanding data was written to the device
738 @retval EFI_DEVICE_ERROR The device reported an error while writting back the data
739 @retval EFI_NO_MEDIA There is no media in the device.
744 PartitionFlushBlocks (
745 IN EFI_BLOCK_IO_PROTOCOL
*This
748 PARTITION_PRIVATE_DATA
*Private
;
750 Private
= PARTITION_DEVICE_FROM_BLOCK_IO_THIS (This
);
752 return Private
->ParentBlockIo
->FlushBlocks (Private
->ParentBlockIo
);
756 Probe the media status and return EFI_NO_MEDIA or EFI_MEDIA_CHANGED
757 for no media or media change case. Otherwise DefaultStatus is returned.
759 @param DiskIo2 Pointer to the DiskIo2 instance.
760 @param MediaId Id of the media, changes every time the media is replaced.
761 @param DefaultStatus The default status to return when it's not the no media
762 or media change case.
764 @retval EFI_NO_MEDIA There is no media.
765 @retval EFI_MEDIA_CHANGED The media was changed.
766 @retval others The default status to return.
770 IN EFI_DISK_IO2_PROTOCOL
*DiskIo2
,
772 IN EFI_STATUS DefaultStatus
778 // Read 1 byte from offset 0 but passing NULL as buffer pointer
780 Status
= DiskIo2
->ReadDiskEx (DiskIo2
, MediaId
, 0, NULL
, 1, NULL
);
781 if ((Status
== EFI_NO_MEDIA
) || (Status
== EFI_MEDIA_CHANGED
)) {
784 return DefaultStatus
;
788 Reset the Block Device throught Block I/O2 protocol.
790 @param This Protocol instance pointer.
791 @param ExtendedVerification Driver may perform diagnostics on reset.
793 @retval EFI_SUCCESS The device was reset.
794 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
801 IN EFI_BLOCK_IO2_PROTOCOL
*This
,
802 IN BOOLEAN ExtendedVerification
805 PARTITION_PRIVATE_DATA
*Private
;
807 Private
= PARTITION_DEVICE_FROM_BLOCK_IO2_THIS (This
);
809 return Private
->ParentBlockIo2
->Reset (
810 Private
->ParentBlockIo2
,
816 The general callback for the DiskIo2 interfaces.
817 @param Event Event whose notification function is being invoked.
818 @param Context The pointer to the notification function's context,
819 which points to the PARTITION_ACCESS_TASK instance.
823 PartitionOnAccessComplete (
828 PARTITION_ACCESS_TASK
*Task
;
830 Task
= (PARTITION_ACCESS_TASK
*) Context
;
832 gBS
->CloseEvent (Event
);
834 Task
->BlockIo2Token
->TransactionStatus
= Task
->DiskIo2Token
.TransactionStatus
;
835 gBS
->SignalEvent (Task
->BlockIo2Token
->Event
);
841 Create a new PARTITION_ACCESS_TASK instance.
843 @param Token Pointer to the EFI_BLOCK_IO2_TOKEN.
845 @return Pointer to the created PARTITION_ACCESS_TASK instance or NULL upon failure.
847 PARTITION_ACCESS_TASK
*
848 PartitionCreateAccessTask (
849 IN EFI_BLOCK_IO2_TOKEN
*Token
853 PARTITION_ACCESS_TASK
*Task
;
855 Task
= AllocatePool (sizeof (*Task
));
860 Status
= gBS
->CreateEvent (
863 PartitionOnAccessComplete
,
865 &Task
->DiskIo2Token
.Event
867 if (EFI_ERROR (Status
)) {
872 Task
->BlockIo2Token
= Token
;
878 Read BufferSize bytes from Lba into Buffer.
880 This function reads the requested number of blocks from the device. All the
881 blocks are read, or an error is returned.
882 If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and
883 non-blocking I/O is being used, the Event associated with this request will
886 @param[in] This Indicates a pointer to the calling context.
887 @param[in] MediaId Id of the media, changes every time the media is
889 @param[in] Lba The starting Logical Block Address to read from.
890 @param[in, out] Token A pointer to the token associated with the transaction.
891 @param[in] BufferSize Size of Buffer, must be a multiple of device block size.
892 @param[out] Buffer A pointer to the destination buffer for the data. The
893 caller is responsible for either having implicit or
894 explicit ownership of the buffer.
896 @retval EFI_SUCCESS The read request was queued if Token->Event is
897 not NULL.The data was read correctly from the
898 device if the Token->Event is NULL.
899 @retval EFI_DEVICE_ERROR The device reported an error while performing
901 @retval EFI_NO_MEDIA There is no media in the device.
902 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
903 @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the
904 intrinsic block size of the device.
905 @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
906 or the buffer is not on proper alignment.
907 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack
912 PartitionReadBlocksEx (
913 IN EFI_BLOCK_IO2_PROTOCOL
*This
,
916 IN OUT EFI_BLOCK_IO2_TOKEN
*Token
,
922 PARTITION_PRIVATE_DATA
*Private
;
924 PARTITION_ACCESS_TASK
*Task
;
926 Private
= PARTITION_DEVICE_FROM_BLOCK_IO2_THIS (This
);
928 if (BufferSize
% Private
->BlockSize
!= 0) {
929 return ProbeMediaStatusEx (Private
->DiskIo2
, MediaId
, EFI_BAD_BUFFER_SIZE
);
932 Offset
= MultU64x32 (Lba
, Private
->BlockSize
) + Private
->Start
;
933 if (Offset
+ BufferSize
> Private
->End
) {
934 return ProbeMediaStatusEx (Private
->DiskIo2
, MediaId
, EFI_INVALID_PARAMETER
);
937 if ((Token
!= NULL
) && (Token
->Event
!= NULL
)) {
938 Task
= PartitionCreateAccessTask (Token
);
940 return EFI_OUT_OF_RESOURCES
;
943 Status
= Private
->DiskIo2
->ReadDiskEx (Private
->DiskIo2
, MediaId
, Offset
, &Task
->DiskIo2Token
, BufferSize
, Buffer
);
944 if (EFI_ERROR (Status
)) {
945 gBS
->CloseEvent (Task
->DiskIo2Token
.Event
);
949 Status
= Private
->DiskIo2
->ReadDiskEx (Private
->DiskIo2
, MediaId
, Offset
, NULL
, BufferSize
, Buffer
);
956 Write BufferSize bytes from Lba into Buffer.
958 This function writes the requested number of blocks to the device. All blocks
959 are written, or an error is returned.If EFI_DEVICE_ERROR, EFI_NO_MEDIA,
960 EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is
961 being used, the Event associated with this request will not be signaled.
963 @param[in] This Indicates a pointer to the calling context.
964 @param[in] MediaId The media ID that the write request is for.
965 @param[in] Lba The starting logical block address to be written. The
966 caller is responsible for writing to only legitimate
968 @param[in, out] Token A pointer to the token associated with the transaction.
969 @param[in] BufferSize Size of Buffer, must be a multiple of device block size.
970 @param[in] Buffer A pointer to the source buffer for the data.
972 @retval EFI_SUCCESS The write request was queued if Event is not NULL.
973 The data was written correctly to the device if
975 @retval EFI_WRITE_PROTECTED The device can not be written to.
976 @retval EFI_NO_MEDIA There is no media in the device.
977 @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
978 @retval EFI_DEVICE_ERROR The device reported an error while performing the write.
979 @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
980 @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
981 or the buffer is not on proper alignment.
982 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack
988 PartitionWriteBlocksEx (
989 IN EFI_BLOCK_IO2_PROTOCOL
*This
,
992 IN OUT EFI_BLOCK_IO2_TOKEN
*Token
,
998 PARTITION_PRIVATE_DATA
*Private
;
1000 PARTITION_ACCESS_TASK
*Task
;
1002 Private
= PARTITION_DEVICE_FROM_BLOCK_IO2_THIS (This
);
1004 if (BufferSize
% Private
->BlockSize
!= 0) {
1005 return ProbeMediaStatusEx (Private
->DiskIo2
, MediaId
, EFI_BAD_BUFFER_SIZE
);
1008 Offset
= MultU64x32 (Lba
, Private
->BlockSize
) + Private
->Start
;
1009 if (Offset
+ BufferSize
> Private
->End
) {
1010 return ProbeMediaStatusEx (Private
->DiskIo2
, MediaId
, EFI_INVALID_PARAMETER
);
1013 if ((Token
!= NULL
) && (Token
->Event
!= NULL
)) {
1014 Task
= PartitionCreateAccessTask (Token
);
1016 return EFI_OUT_OF_RESOURCES
;
1019 Status
= Private
->DiskIo2
->WriteDiskEx (Private
->DiskIo2
, MediaId
, Offset
, &Task
->DiskIo2Token
, BufferSize
, Buffer
);
1020 if (EFI_ERROR (Status
)) {
1021 gBS
->CloseEvent (Task
->DiskIo2Token
.Event
);
1025 Status
= Private
->DiskIo2
->WriteDiskEx (Private
->DiskIo2
, MediaId
, Offset
, NULL
, BufferSize
, Buffer
);
1031 Flush the Block Device.
1033 If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED
1034 is returned and non-blocking I/O is being used, the Event associated with
1035 this request will not be signaled.
1037 @param[in] This Indicates a pointer to the calling context.
1038 @param[in, out] Token A pointer to the token associated with the transaction
1040 @retval EFI_SUCCESS The flush request was queued if Event is not NULL.
1041 All outstanding data was written correctly to the
1042 device if the Event is NULL.
1043 @retval EFI_DEVICE_ERROR The device reported an error while writting back
1045 @retval EFI_WRITE_PROTECTED The device cannot be written to.
1046 @retval EFI_NO_MEDIA There is no media in the device.
1047 @retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
1048 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack
1054 PartitionFlushBlocksEx (
1055 IN EFI_BLOCK_IO2_PROTOCOL
*This
,
1056 IN OUT EFI_BLOCK_IO2_TOKEN
*Token
1060 PARTITION_PRIVATE_DATA
*Private
;
1061 PARTITION_ACCESS_TASK
*Task
;
1063 Private
= PARTITION_DEVICE_FROM_BLOCK_IO2_THIS (This
);
1065 if ((Token
!= NULL
) && (Token
->Event
!= NULL
)) {
1066 Task
= PartitionCreateAccessTask (Token
);
1068 return EFI_OUT_OF_RESOURCES
;
1071 Status
= Private
->DiskIo2
->FlushDiskEx (Private
->DiskIo2
, &Task
->DiskIo2Token
);
1072 if (EFI_ERROR (Status
)) {
1073 gBS
->CloseEvent (Task
->DiskIo2Token
.Event
);
1077 Status
= Private
->DiskIo2
->FlushDiskEx (Private
->DiskIo2
, NULL
);
1084 Create a child handle for a logical block device that represents the
1085 bytes Start to End of the Parent Block IO device.
1087 @param[in] This Protocol instance pointer.
1088 @param[in] ParentHandle Parent Handle for new child.
1089 @param[in] ParentDiskIo Parent DiskIo interface.
1090 @param[in] ParentDiskIo2 Parent DiskIo2 interface.
1091 @param[in] ParentBlockIo Parent BlockIo interface.
1092 @param[in] ParentBlockIo2 Parent BlockIo2 interface.
1093 @param[in] ParentDevicePath Parent Device Path.
1094 @param[in] DevicePathNode Child Device Path node.
1095 @param[in] Start Start Block.
1096 @param[in] End End Block.
1097 @param[in] BlockSize Child block size.
1098 @param[in] InstallEspGuid Flag to install EFI System Partition GUID on handle.
1100 @retval EFI_SUCCESS A child handle was added.
1101 @retval other A child handle was not added.
1105 PartitionInstallChildHandle (
1106 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1107 IN EFI_HANDLE ParentHandle
,
1108 IN EFI_DISK_IO_PROTOCOL
*ParentDiskIo
,
1109 IN EFI_DISK_IO2_PROTOCOL
*ParentDiskIo2
,
1110 IN EFI_BLOCK_IO_PROTOCOL
*ParentBlockIo
,
1111 IN EFI_BLOCK_IO2_PROTOCOL
*ParentBlockIo2
,
1112 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
1113 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode
,
1116 IN UINT32 BlockSize
,
1117 IN BOOLEAN InstallEspGuid
1121 PARTITION_PRIVATE_DATA
*Private
;
1123 Status
= EFI_SUCCESS
;
1124 Private
= AllocateZeroPool (sizeof (PARTITION_PRIVATE_DATA
));
1125 if (Private
== NULL
) {
1126 return EFI_OUT_OF_RESOURCES
;
1129 Private
->Signature
= PARTITION_PRIVATE_DATA_SIGNATURE
;
1131 Private
->Start
= MultU64x32 (Start
, ParentBlockIo
->Media
->BlockSize
);
1132 Private
->End
= MultU64x32 (End
+ 1, ParentBlockIo
->Media
->BlockSize
);
1134 Private
->BlockSize
= BlockSize
;
1135 Private
->ParentBlockIo
= ParentBlockIo
;
1136 Private
->ParentBlockIo2
= ParentBlockIo2
;
1137 Private
->DiskIo
= ParentDiskIo
;
1138 Private
->DiskIo2
= ParentDiskIo2
;
1141 // Set the BlockIO into Private Data.
1143 Private
->BlockIo
.Revision
= ParentBlockIo
->Revision
;
1145 Private
->BlockIo
.Media
= &Private
->Media
;
1146 CopyMem (Private
->BlockIo
.Media
, ParentBlockIo
->Media
, sizeof (EFI_BLOCK_IO_MEDIA
));
1148 Private
->BlockIo
.Reset
= PartitionReset
;
1149 Private
->BlockIo
.ReadBlocks
= PartitionReadBlocks
;
1150 Private
->BlockIo
.WriteBlocks
= PartitionWriteBlocks
;
1151 Private
->BlockIo
.FlushBlocks
= PartitionFlushBlocks
;
1154 // Set the BlockIO2 into Private Data.
1156 if (Private
->DiskIo2
!= NULL
) {
1157 ASSERT (Private
->ParentBlockIo2
!= NULL
);
1158 Private
->BlockIo2
.Media
= &Private
->Media2
;
1159 CopyMem (Private
->BlockIo2
.Media
, ParentBlockIo2
->Media
, sizeof (EFI_BLOCK_IO_MEDIA
));
1161 Private
->BlockIo2
.Reset
= PartitionResetEx
;
1162 Private
->BlockIo2
.ReadBlocksEx
= PartitionReadBlocksEx
;
1163 Private
->BlockIo2
.WriteBlocksEx
= PartitionWriteBlocksEx
;
1164 Private
->BlockIo2
.FlushBlocksEx
= PartitionFlushBlocksEx
;
1167 Private
->Media
.IoAlign
= 0;
1168 Private
->Media
.LogicalPartition
= TRUE
;
1169 Private
->Media
.LastBlock
= DivU64x32 (
1172 ParentBlockIo
->Media
->BlockSize
1177 Private
->Media
.BlockSize
= (UINT32
) BlockSize
;
1179 Private
->Media2
.IoAlign
= 0;
1180 Private
->Media2
.LogicalPartition
= TRUE
;
1181 Private
->Media2
.LastBlock
= Private
->Media
.LastBlock
;
1182 Private
->Media2
.BlockSize
= (UINT32
) BlockSize
;
1185 // Per UEFI Spec, LowestAlignedLba, LogicalBlocksPerPhysicalBlock and OptimalTransferLengthGranularity must be 0
1186 // for logical partitions.
1188 if (Private
->BlockIo
.Revision
>= EFI_BLOCK_IO_PROTOCOL_REVISION2
) {
1189 Private
->Media
.LowestAlignedLba
= 0;
1190 Private
->Media
.LogicalBlocksPerPhysicalBlock
= 0;
1191 Private
->Media2
.LowestAlignedLba
= 0;
1192 Private
->Media2
.LogicalBlocksPerPhysicalBlock
= 0;
1193 if (Private
->BlockIo
.Revision
>= EFI_BLOCK_IO_PROTOCOL_REVISION3
) {
1194 Private
->Media
.OptimalTransferLengthGranularity
= 0;
1195 Private
->Media2
.OptimalTransferLengthGranularity
= 0;
1199 Private
->DevicePath
= AppendDevicePathNode (ParentDevicePath
, DevicePathNode
);
1201 if (Private
->DevicePath
== NULL
) {
1203 return EFI_OUT_OF_RESOURCES
;
1206 if (InstallEspGuid
) {
1207 Private
->EspGuid
= &gEfiPartTypeSystemPartGuid
;
1210 // If NULL InstallMultipleProtocolInterfaces will ignore it.
1212 Private
->EspGuid
= NULL
;
1216 // Create the new handle.
1218 Private
->Handle
= NULL
;
1219 if (Private
->DiskIo2
!= NULL
) {
1220 Status
= gBS
->InstallMultipleProtocolInterfaces (
1222 &gEfiDevicePathProtocolGuid
,
1223 Private
->DevicePath
,
1224 &gEfiBlockIoProtocolGuid
,
1226 &gEfiBlockIo2ProtocolGuid
,
1233 Status
= gBS
->InstallMultipleProtocolInterfaces (
1235 &gEfiDevicePathProtocolGuid
,
1236 Private
->DevicePath
,
1237 &gEfiBlockIoProtocolGuid
,
1245 if (!EFI_ERROR (Status
)) {
1247 // Open the Parent Handle for the child
1249 Status
= gBS
->OpenProtocol (
1251 &gEfiDiskIoProtocolGuid
,
1252 (VOID
**) &ParentDiskIo
,
1253 This
->DriverBindingHandle
,
1255 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
1258 FreePool (Private
->DevicePath
);
1267 The user Entry Point for module Partition. The user code starts with this function.
1269 @param[in] ImageHandle The firmware allocated handle for the EFI image.
1270 @param[in] SystemTable A pointer to the EFI System Table.
1272 @retval EFI_SUCCESS The entry point is executed successfully.
1273 @retval other Some error occurs when executing this entry point.
1278 InitializePartition (
1279 IN EFI_HANDLE ImageHandle
,
1280 IN EFI_SYSTEM_TABLE
*SystemTable
1286 // Install driver model protocol(s).
1288 Status
= EfiLibInstallDriverBindingComponentName2 (
1291 &gPartitionDriverBinding
,
1293 &gPartitionComponentName
,
1294 &gPartitionComponentName2
1296 ASSERT_EFI_ERROR (Status
);
1304 Test to see if there is any child on ControllerHandle.
1306 @param[in] ControllerHandle Handle of device to test.
1308 @retval TRUE There are children on the ControllerHandle.
1309 @retval FALSE No child is on the ControllerHandle.
1314 IN EFI_HANDLE ControllerHandle
1317 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfoBuffer
;
1322 Status
= gBS
->OpenProtocolInformation (
1324 &gEfiDiskIoProtocolGuid
,
1328 ASSERT_EFI_ERROR (Status
);
1330 for (Index
= 0; Index
< EntryCount
; Index
++) {
1331 if ((OpenInfoBuffer
[Index
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1335 FreePool (OpenInfoBuffer
);
1337 return (BOOLEAN
) (Index
< EntryCount
);