/** @file | |
Partition driver that produces logical BlockIo devices from a physical | |
BlockIo device. The logical BlockIo devices are based on the format | |
of the raw block devices media. Currently "El Torito CD-ROM", UDF, Legacy | |
MBR, and GPT partition schemes are supported. | |
Copyright (c) 2018 Qualcomm Datacenter Technologies, Inc. | |
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#ifndef _PARTITION_H_ | |
#define _PARTITION_H_ | |
#include <Uefi.h> | |
#include <Protocol/BlockIo.h> | |
#include <Protocol/BlockIo2.h> | |
#include <Guid/Gpt.h> | |
#include <Protocol/ComponentName.h> | |
#include <Protocol/DevicePath.h> | |
#include <Protocol/DriverBinding.h> | |
#include <Protocol/DiskIo.h> | |
#include <Protocol/DiskIo2.h> | |
#include <Protocol/PartitionInfo.h> | |
#include <Library/DebugLib.h> | |
#include <Library/UefiDriverEntryPoint.h> | |
#include <Library/BaseLib.h> | |
#include <Library/UefiLib.h> | |
#include <Library/BaseMemoryLib.h> | |
#include <Library/MemoryAllocationLib.h> | |
#include <Library/UefiBootServicesTableLib.h> | |
#include <Library/DevicePathLib.h> | |
#include <IndustryStandard/Mbr.h> | |
#include <IndustryStandard/ElTorito.h> | |
#include <IndustryStandard/Udf.h> | |
// | |
// Partition private data | |
// | |
#define PARTITION_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'a', 'r', 't') | |
typedef struct { | |
UINT64 Signature; | |
EFI_HANDLE Handle; | |
EFI_DEVICE_PATH_PROTOCOL *DevicePath; | |
EFI_BLOCK_IO_PROTOCOL BlockIo; | |
EFI_BLOCK_IO2_PROTOCOL BlockIo2; | |
EFI_BLOCK_IO_MEDIA Media; | |
EFI_BLOCK_IO_MEDIA Media2;// For BlockIO2 | |
EFI_PARTITION_INFO_PROTOCOL PartitionInfo; | |
EFI_DISK_IO_PROTOCOL *DiskIo; | |
EFI_DISK_IO2_PROTOCOL *DiskIo2; | |
EFI_BLOCK_IO_PROTOCOL *ParentBlockIo; | |
EFI_BLOCK_IO2_PROTOCOL *ParentBlockIo2; | |
UINT64 Start; | |
UINT64 End; | |
UINT32 BlockSize; | |
BOOLEAN InStop; | |
EFI_GUID TypeGuid; | |
} PARTITION_PRIVATE_DATA; | |
typedef struct { | |
EFI_DISK_IO2_TOKEN DiskIo2Token; | |
EFI_BLOCK_IO2_TOKEN *BlockIo2Token; | |
} PARTITION_ACCESS_TASK; | |
#define PARTITION_DEVICE_FROM_BLOCK_IO_THIS(a) CR (a, PARTITION_PRIVATE_DATA, BlockIo, PARTITION_PRIVATE_DATA_SIGNATURE) | |
#define PARTITION_DEVICE_FROM_BLOCK_IO2_THIS(a) CR (a, PARTITION_PRIVATE_DATA, BlockIo2, PARTITION_PRIVATE_DATA_SIGNATURE) | |
// | |
// Global Variables | |
// | |
extern EFI_DRIVER_BINDING_PROTOCOL gPartitionDriverBinding; | |
extern EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName; | |
extern EFI_COMPONENT_NAME2_PROTOCOL gPartitionComponentName2; | |
// | |
// Extract INT32 from char array | |
// | |
#define UNPACK_INT32(a) (INT32)( (((UINT8 *) a)[0] << 0) | \ | |
(((UINT8 *) a)[1] << 8) | \ | |
(((UINT8 *) a)[2] << 16) | \ | |
(((UINT8 *) a)[3] << 24) ) | |
// | |
// Extract UINT32 from char array | |
// | |
#define UNPACK_UINT32(a) (UINT32)( (((UINT8 *) a)[0] << 0) | \ | |
(((UINT8 *) a)[1] << 8) | \ | |
(((UINT8 *) a)[2] << 16) | \ | |
(((UINT8 *) a)[3] << 24) ) | |
// | |
// GPT Partition Entry Status | |
// | |
typedef struct { | |
BOOLEAN OutOfRange; | |
BOOLEAN Overlap; | |
BOOLEAN OsSpecific; | |
} EFI_PARTITION_ENTRY_STATUS; | |
// | |
// Function Prototypes | |
// | |
/** | |
Test to see if this driver supports ControllerHandle. Any ControllerHandle | |
than contains a BlockIo and DiskIo protocol can be supported. | |
@param This Protocol instance pointer. | |
@param ControllerHandle Handle of device to test | |
@param RemainingDevicePath Optional parameter use to pick a specific child | |
device to start. | |
@retval EFI_SUCCESS This driver supports this device | |
@retval EFI_ALREADY_STARTED This driver is already running on this device | |
@retval other This driver does not support this device | |
**/ | |
EFI_STATUS | |
EFIAPI | |
PartitionDriverBindingSupported ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE ControllerHandle, | |
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath | |
); | |
/** | |
Start this driver on ControllerHandle by opening a Block IO and Disk IO | |
protocol, reading Device Path, and creating a child handle with a | |
Disk IO and device path protocol. | |
@param This Protocol instance pointer. | |
@param ControllerHandle Handle of device to bind driver to | |
@param RemainingDevicePath Optional parameter use to pick a specific child | |
device to start. | |
@retval EFI_SUCCESS This driver is added to ControllerHandle | |
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle | |
@retval other This driver does not support this device | |
**/ | |
EFI_STATUS | |
EFIAPI | |
PartitionDriverBindingStart ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE ControllerHandle, | |
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath | |
); | |
/** | |
Stop this driver on ControllerHandle. Support stopping any child handles | |
created by this driver. | |
@param This Protocol instance pointer. | |
@param ControllerHandle Handle of device to stop driver on | |
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of | |
children is zero stop the entire bus driver. | |
@param ChildHandleBuffer List of Child Handles to Stop. | |
@retval EFI_SUCCESS This driver is removed ControllerHandle | |
@retval other This driver was not removed from this device | |
**/ | |
EFI_STATUS | |
EFIAPI | |
PartitionDriverBindingStop ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE ControllerHandle, | |
IN UINTN NumberOfChildren, | |
IN EFI_HANDLE *ChildHandleBuffer | |
); | |
// | |
// EFI Component Name Functions | |
// | |
/** | |
Retrieves a Unicode string that is the user readable name of the driver. | |
This function retrieves the user readable name of a driver in the form of a | |
Unicode string. If the driver specified by This has a user readable name in | |
the language specified by Language, then a pointer to the driver name is | |
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified | |
by This does not support the language specified by Language, | |
then EFI_UNSUPPORTED is returned. | |
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or | |
EFI_COMPONENT_NAME_PROTOCOL instance. | |
@param Language[in] A pointer to a Null-terminated ASCII string | |
array indicating the language. This is the | |
language of the driver name that the caller is | |
requesting, and it must match one of the | |
languages specified in SupportedLanguages. The | |
number of languages supported by a driver is up | |
to the driver writer. Language is specified | |
in RFC 4646 or ISO 639-2 language code format. | |
@param DriverName[out] A pointer to the Unicode string to return. | |
This Unicode string is the name of the | |
driver specified by This in the language | |
specified by Language. | |
@retval EFI_SUCCESS The Unicode string for the Driver specified by | |
This and the language specified by Language was | |
returned in DriverName. | |
@retval EFI_INVALID_PARAMETER Language is NULL. | |
@retval EFI_INVALID_PARAMETER DriverName is NULL. | |
@retval EFI_UNSUPPORTED The driver specified by This does not support | |
the language specified by Language. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
PartitionComponentNameGetDriverName ( | |
IN EFI_COMPONENT_NAME_PROTOCOL *This, | |
IN CHAR8 *Language, | |
OUT CHAR16 **DriverName | |
); | |
/** | |
Retrieves a Unicode string that is the user readable name of the controller | |
that is being managed by a driver. | |
This function retrieves the user readable name of the controller specified by | |
ControllerHandle and ChildHandle in the form of a Unicode string. If the | |
driver specified by This has a user readable name in the language specified by | |
Language, then a pointer to the controller name is returned in ControllerName, | |
and EFI_SUCCESS is returned. If the driver specified by This is not currently | |
managing the controller specified by ControllerHandle and ChildHandle, | |
then EFI_UNSUPPORTED is returned. If the driver specified by This does not | |
support the language specified by Language, then EFI_UNSUPPORTED is returned. | |
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or | |
EFI_COMPONENT_NAME_PROTOCOL instance. | |
@param ControllerHandle[in] The handle of a controller that the driver | |
specified by This is managing. This handle | |
specifies the controller whose name is to be | |
returned. | |
@param ChildHandle[in] The handle of the child controller to retrieve | |
the name of. This is an optional parameter that | |
may be NULL. It will be NULL for device | |
drivers. It will also be NULL for a bus drivers | |
that wish to retrieve the name of the bus | |
controller. It will not be NULL for a bus | |
driver that wishes to retrieve the name of a | |
child controller. | |
@param Language[in] A pointer to a Null-terminated ASCII string | |
array indicating the language. This is the | |
language of the driver name that the caller is | |
requesting, and it must match one of the | |
languages specified in SupportedLanguages. The | |
number of languages supported by a driver is up | |
to the driver writer. Language is specified in | |
RFC 4646 or ISO 639-2 language code format. | |
@param ControllerName[out] A pointer to the Unicode string to return. | |
This Unicode string is the name of the | |
controller specified by ControllerHandle and | |
ChildHandle in the language specified by | |
Language from the point of view of the driver | |
specified by This. | |
@retval EFI_SUCCESS The Unicode string for the user readable name in | |
the language specified by Language for the | |
driver specified by This was returned in | |
DriverName. | |
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. | |
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid | |
EFI_HANDLE. | |
@retval EFI_INVALID_PARAMETER Language is NULL. | |
@retval EFI_INVALID_PARAMETER ControllerName is NULL. | |
@retval EFI_UNSUPPORTED The driver specified by This is not currently | |
managing the controller specified by | |
ControllerHandle and ChildHandle. | |
@retval EFI_UNSUPPORTED The driver specified by This does not support | |
the language specified by Language. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
PartitionComponentNameGetControllerName ( | |
IN EFI_COMPONENT_NAME_PROTOCOL *This, | |
IN EFI_HANDLE ControllerHandle, | |
IN EFI_HANDLE ChildHandle OPTIONAL, | |
IN CHAR8 *Language, | |
OUT CHAR16 **ControllerName | |
); | |
/** | |
Create a child handle for a logical block device that represents the | |
bytes Start to End of the Parent Block IO device. | |
@param[in] This Protocol instance pointer. | |
@param[in] ParentHandle Parent Handle for new child. | |
@param[in] ParentDiskIo Parent DiskIo interface. | |
@param[in] ParentDiskIo2 Parent DiskIo2 interface. | |
@param[in] ParentBlockIo Parent BlockIo interface. | |
@param[in] ParentBlockIo2 Parent BlockIo2 interface. | |
@param[in] ParentDevicePath Parent Device Path. | |
@param[in] DevicePathNode Child Device Path node. | |
@param[in] PartitionInfo Child Partition Information interface. | |
@param[in] Start Start Block. | |
@param[in] End End Block. | |
@param[in] BlockSize Child block size. | |
@param[in] TypeGuid Parition Type Guid. | |
@retval EFI_SUCCESS A child handle was added. | |
@retval other A child handle was not added. | |
**/ | |
EFI_STATUS | |
PartitionInstallChildHandle ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE ParentHandle, | |
IN EFI_DISK_IO_PROTOCOL *ParentDiskIo, | |
IN EFI_DISK_IO2_PROTOCOL *ParentDiskIo2, | |
IN EFI_BLOCK_IO_PROTOCOL *ParentBlockIo, | |
IN EFI_BLOCK_IO2_PROTOCOL *ParentBlockIo2, | |
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath, | |
IN EFI_DEVICE_PATH_PROTOCOL *DevicePathNode, | |
IN EFI_PARTITION_INFO_PROTOCOL *PartitionInfo, | |
IN EFI_LBA Start, | |
IN EFI_LBA End, | |
IN UINT32 BlockSize, | |
IN EFI_GUID *TypeGuid | |
); | |
/** | |
Test to see if there is any child on ControllerHandle. | |
@param[in] ControllerHandle Handle of device to test. | |
@retval TRUE There are children on the ControllerHandle. | |
@retval FALSE No child is on the ControllerHandle. | |
**/ | |
BOOLEAN | |
HasChildren ( | |
IN EFI_HANDLE ControllerHandle | |
); | |
/** | |
Install child handles if the Handle supports GPT partition structure. | |
@param[in] This Calling context. | |
@param[in] Handle Parent Handle. | |
@param[in] DiskIo Parent DiskIo interface. | |
@param[in] DiskIo2 Parent DiskIo2 interface. | |
@param[in] BlockIo Parent BlockIo interface. | |
@param[in] BlockIo2 Parent BlockIo2 interface. | |
@param[in] DevicePath Parent Device Path. | |
@retval EFI_SUCCESS Valid GPT disk. | |
@retval EFI_MEDIA_CHANGED Media changed Detected. | |
@retval EFI_INVALID_PARAMETER If both BlockIo and BlockIo2 are NULL; | |
@retval other Not a valid GPT disk. | |
**/ | |
EFI_STATUS | |
PartitionInstallGptChildHandles ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE Handle, | |
IN EFI_DISK_IO_PROTOCOL *DiskIo, | |
IN EFI_DISK_IO2_PROTOCOL *DiskIo2, | |
IN EFI_BLOCK_IO_PROTOCOL *BlockIo, | |
IN EFI_BLOCK_IO2_PROTOCOL *BlockIo2, | |
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath | |
); | |
/** | |
Install child handles if the Handle supports El Torito format. | |
@param[in] This Calling context. | |
@param[in] Handle Parent Handle. | |
@param[in] DiskIo Parent DiskIo interface. | |
@param[in] DiskIo2 Parent DiskIo2 interface. | |
@param[in] BlockIo Parent BlockIo interface. | |
@param[in] BlockIo2 Parent BlockIo2 interface. | |
@param[in] DevicePath Parent Device Path | |
@retval EFI_SUCCESS Child handle(s) was added. | |
@retval EFI_MEDIA_CHANGED Media changed Detected. | |
@retval other no child handle was added. | |
**/ | |
EFI_STATUS | |
PartitionInstallElToritoChildHandles ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE Handle, | |
IN EFI_DISK_IO_PROTOCOL *DiskIo, | |
IN EFI_DISK_IO2_PROTOCOL *DiskIo2, | |
IN EFI_BLOCK_IO_PROTOCOL *BlockIo, | |
IN EFI_BLOCK_IO2_PROTOCOL *BlockIo2, | |
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath | |
); | |
/** | |
Install child handles if the Handle supports MBR format. | |
@param[in] This Calling context. | |
@param[in] Handle Parent Handle. | |
@param[in] DiskIo Parent DiskIo interface. | |
@param[in] DiskIo2 Parent DiskIo2 interface. | |
@param[in] BlockIo Parent BlockIo interface. | |
@param[in] BlockIo2 Parent BlockIo2 interface. | |
@param[in] DevicePath Parent Device Path. | |
@retval EFI_SUCCESS A child handle was added. | |
@retval EFI_MEDIA_CHANGED Media change was detected. | |
@retval Others MBR partition was not found. | |
**/ | |
EFI_STATUS | |
PartitionInstallMbrChildHandles ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE Handle, | |
IN EFI_DISK_IO_PROTOCOL *DiskIo, | |
IN EFI_DISK_IO2_PROTOCOL *DiskIo2, | |
IN EFI_BLOCK_IO_PROTOCOL *BlockIo, | |
IN EFI_BLOCK_IO2_PROTOCOL *BlockIo2, | |
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath | |
); | |
/** | |
Install child handles if the Handle supports UDF/ECMA-167 volume format. | |
@param[in] This Calling context. | |
@param[in] Handle Parent Handle. | |
@param[in] DiskIo Parent DiskIo interface. | |
@param[in] DiskIo2 Parent DiskIo2 interface. | |
@param[in] BlockIo Parent BlockIo interface. | |
@param[in] BlockIo2 Parent BlockIo2 interface. | |
@param[in] DevicePath Parent Device Path | |
@retval EFI_SUCCESS Child handle(s) was added. | |
@retval EFI_MEDIA_CHANGED Media changed Detected. | |
@retval other no child handle was added. | |
**/ | |
EFI_STATUS | |
PartitionInstallUdfChildHandles ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE Handle, | |
IN EFI_DISK_IO_PROTOCOL *DiskIo, | |
IN EFI_DISK_IO2_PROTOCOL *DiskIo2, | |
IN EFI_BLOCK_IO_PROTOCOL *BlockIo, | |
IN EFI_BLOCK_IO2_PROTOCOL *BlockIo2, | |
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath | |
); | |
typedef | |
EFI_STATUS | |
(*PARTITION_DETECT_ROUTINE) ( | |
IN EFI_DRIVER_BINDING_PROTOCOL *This, | |
IN EFI_HANDLE Handle, | |
IN EFI_DISK_IO_PROTOCOL *DiskIo, | |
IN EFI_DISK_IO2_PROTOCOL *DiskIo2, | |
IN EFI_BLOCK_IO_PROTOCOL *BlockIo, | |
IN EFI_BLOCK_IO2_PROTOCOL *BlockIo2, | |
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath | |
); | |
#endif |