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 - 2008, Intel Corporation. <BR>
8 All rights reserved. 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.
22 #include <Protocol/BlockIo.h>
24 #include <Protocol/ComponentName.h>
25 #include <Protocol/DevicePath.h>
26 #include <Protocol/DriverBinding.h>
27 #include <Protocol/DiskIo.h>
28 #include <Library/DebugLib.h>
29 #include <Library/UefiDriverEntryPoint.h>
30 #include <Library/BaseLib.h>
31 #include <Library/UefiLib.h>
32 #include <Library/BaseMemoryLib.h>
33 #include <Library/MemoryAllocationLib.h>
34 #include <Library/UefiBootServicesTableLib.h>
35 #include <Library/DevicePathLib.h>
37 #include <IndustryStandard/Mbr.h>
38 #include <IndustryStandard/ElTorito.h>
42 // Partition private data
44 #define PARTITION_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('P', 'a', 'r', 't')
49 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
50 EFI_BLOCK_IO_PROTOCOL BlockIo
;
51 EFI_BLOCK_IO_MEDIA Media
;
53 EFI_DISK_IO_PROTOCOL
*DiskIo
;
54 EFI_BLOCK_IO_PROTOCOL
*ParentBlockIo
;
61 } PARTITION_PRIVATE_DATA
;
63 #define PARTITION_DEVICE_FROM_BLOCK_IO_THIS(a) CR (a, PARTITION_PRIVATE_DATA, BlockIo, PARTITION_PRIVATE_DATA_SIGNATURE)
68 extern EFI_DRIVER_BINDING_PROTOCOL gPartitionDriverBinding
;
69 extern EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName
;
70 extern EFI_COMPONENT_NAME2_PROTOCOL gPartitionComponentName2
;
73 // Extract INT32 from char array
75 #define UNPACK_INT32(a) (INT32)( (((UINT8 *) a)[0] << 0) | \
76 (((UINT8 *) a)[1] << 8) | \
77 (((UINT8 *) a)[2] << 16) | \
78 (((UINT8 *) a)[3] << 24) )
81 // Extract UINT32 from char array
83 #define UNPACK_UINT32(a) (UINT32)( (((UINT8 *) a)[0] << 0) | \
84 (((UINT8 *) a)[1] << 8) | \
85 (((UINT8 *) a)[2] << 16) | \
86 (((UINT8 *) a)[3] << 24) )
90 // GPT Partition Entry Status
95 } EFI_PARTITION_ENTRY_STATUS
;
98 // Function Prototypes
101 Test to see if this driver supports ControllerHandle. Any ControllerHandle
102 than contains a BlockIo and DiskIo protocol can be supported.
104 @param This Protocol instance pointer.
105 @param ControllerHandle Handle of device to test
106 @param RemainingDevicePath Optional parameter use to pick a specific child
109 @retval EFI_SUCCESS This driver supports this device
110 @retval EFI_ALREADY_STARTED This driver is already running on this device
111 @retval other This driver does not support this device
116 PartitionDriverBindingSupported (
117 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
118 IN EFI_HANDLE ControllerHandle
,
119 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
123 Start this driver on ControllerHandle by opening a Block IO and Disk IO
124 protocol, reading Device Path, and creating a child handle with a
125 Disk IO and device path protocol.
127 @param This Protocol instance pointer.
128 @param ControllerHandle Handle of device to bind driver to
129 @param RemainingDevicePath Optional parameter use to pick a specific child
132 @retval EFI_SUCCESS This driver is added to ControllerHandle
133 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
134 @retval other This driver does not support this device
139 PartitionDriverBindingStart (
140 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
141 IN EFI_HANDLE ControllerHandle
,
142 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
146 Stop this driver on ControllerHandle. Support stoping any child handles
147 created by this driver.
149 @param This Protocol instance pointer.
150 @param ControllerHandle Handle of device to stop driver on
151 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
152 children is zero stop the entire bus driver.
153 @param ChildHandleBuffer List of Child Handles to Stop.
155 @retval EFI_SUCCESS This driver is removed ControllerHandle
156 @retval other This driver was not removed from this device
161 PartitionDriverBindingStop (
162 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
163 IN EFI_HANDLE ControllerHandle
,
164 IN UINTN NumberOfChildren
,
165 IN EFI_HANDLE
*ChildHandleBuffer
169 // EFI Component Name Functions
172 Retrieves a Unicode string that is the user readable name of the driver.
174 This function retrieves the user readable name of a driver in the form of a
175 Unicode string. If the driver specified by This has a user readable name in
176 the language specified by Language, then a pointer to the driver name is
177 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
178 by This does not support the language specified by Language,
179 then EFI_UNSUPPORTED is returned.
181 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
182 EFI_COMPONENT_NAME_PROTOCOL instance.
184 @param Language[in] A pointer to a Null-terminated ASCII string
185 array indicating the language. This is the
186 language of the driver name that the caller is
187 requesting, and it must match one of the
188 languages specified in SupportedLanguages. The
189 number of languages supported by a driver is up
190 to the driver writer. Language is specified
191 in RFC 3066 or ISO 639-2 language code format.
193 @param DriverName[out] A pointer to the Unicode string to return.
194 This Unicode string is the name of the
195 driver specified by This in the language
196 specified by Language.
198 @retval EFI_SUCCESS The Unicode string for the Driver specified by
199 This and the language specified by Language was
200 returned in DriverName.
202 @retval EFI_INVALID_PARAMETER Language is NULL.
204 @retval EFI_INVALID_PARAMETER DriverName is NULL.
206 @retval EFI_UNSUPPORTED The driver specified by This does not support
207 the language specified by Language.
212 PartitionComponentNameGetDriverName (
213 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
215 OUT CHAR16
**DriverName
220 Retrieves a Unicode string that is the user readable name of the controller
221 that is being managed by a driver.
223 This function retrieves the user readable name of the controller specified by
224 ControllerHandle and ChildHandle in the form of a Unicode string. If the
225 driver specified by This has a user readable name in the language specified by
226 Language, then a pointer to the controller name is returned in ControllerName,
227 and EFI_SUCCESS is returned. If the driver specified by This is not currently
228 managing the controller specified by ControllerHandle and ChildHandle,
229 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
230 support the language specified by Language, then EFI_UNSUPPORTED is returned.
232 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
233 EFI_COMPONENT_NAME_PROTOCOL instance.
235 @param ControllerHandle[in] The handle of a controller that the driver
236 specified by This is managing. This handle
237 specifies the controller whose name is to be
240 @param ChildHandle[in] The handle of the child controller to retrieve
241 the name of. This is an optional parameter that
242 may be NULL. It will be NULL for device
243 drivers. It will also be NULL for a bus drivers
244 that wish to retrieve the name of the bus
245 controller. It will not be NULL for a bus
246 driver that wishes to retrieve the name of a
249 @param Language[in] A pointer to a Null-terminated ASCII string
250 array indicating the language. This is the
251 language of the driver name that the caller is
252 requesting, and it must match one of the
253 languages specified in SupportedLanguages. The
254 number of languages supported by a driver is up
255 to the driver writer. Language is specified in
256 RFC 3066 or ISO 639-2 language code format.
258 @param ControllerName[out] A pointer to the Unicode string to return.
259 This Unicode string is the name of the
260 controller specified by ControllerHandle and
261 ChildHandle in the language specified by
262 Language from the point of view of the driver
265 @retval EFI_SUCCESS The Unicode string for the user readable name in
266 the language specified by Language for the
267 driver specified by This was returned in
270 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
272 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
275 @retval EFI_INVALID_PARAMETER Language is NULL.
277 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
279 @retval EFI_UNSUPPORTED The driver specified by This is not currently
280 managing the controller specified by
281 ControllerHandle and ChildHandle.
283 @retval EFI_UNSUPPORTED The driver specified by This does not support
284 the language specified by Language.
289 PartitionComponentNameGetControllerName (
290 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
291 IN EFI_HANDLE ControllerHandle
,
292 IN EFI_HANDLE ChildHandle OPTIONAL
,
294 OUT CHAR16
**ControllerName
299 Create a child handle for a logical block device that represents the
300 bytes Start to End of the Parent Block IO device.
302 @param[in] This Protocol instance pointer
303 @param[in] ParentHandle Parent Handle for new child
304 @param[in] ParentDiskIo Parent DiskIo interface
305 @param[in] ParentBlockIo Parent BlockIo interface
306 @param[in] ParentDevicePath Parent Device Path
307 @param[in] DevicePathNode Child Device Path node
308 @param[in] Start Start Block
309 @param[in] End End Block
310 @param[in] BlockSize Child block size
311 @param[in] InstallEspGuid Flag to install EFI System Partition GUID on handle
313 @retval EFI_SUCCESS A child handle was added
314 @retval other A child handle was not added
318 PartitionInstallChildHandle (
319 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
320 IN EFI_HANDLE ParentHandle
,
321 IN EFI_DISK_IO_PROTOCOL
*ParentDiskIo
,
322 IN EFI_BLOCK_IO_PROTOCOL
*ParentBlockIo
,
323 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
324 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode
,
328 IN BOOLEAN InstallEspGuid
332 Install child handles if the Handle supports GPT partition structure.
334 @param[in] This - Calling context.
335 @param[in] Handle - Parent Handle
336 @param[in] DiskIo - Parent DiskIo interface
337 @param[in] BlockIo - Parent BlockIo interface
338 @param[in] DevicePath - Parent Device Path
340 @retval EFI_SUCCESS Valid GPT disk
341 @retval EFI_MEDIA_CHANGED Media changed Detected
342 @retval other Not a valid GPT disk
346 PartitionInstallGptChildHandles (
347 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
348 IN EFI_HANDLE Handle
,
349 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
350 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
351 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
355 Install child handles if the Handle supports El Torito format.
357 @param[in] This Calling context.
358 @param[in] Handle Parent Handle
359 @param[in] DiskIo Parent DiskIo interface
360 @param[in] BlockIo Parent BlockIo interface
361 @param[in] DevicePath Parent Device Path
364 @retval EFI_SUCCESS Child handle(s) was added
365 @retval EFI_MEDIA_CHANGED Media changed Detected
366 @retval other no child handle was added
370 PartitionInstallElToritoChildHandles (
371 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
372 IN EFI_HANDLE Handle
,
373 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
374 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
375 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
379 Install child handles if the Handle supports MBR format.
381 @param This Calling context.
382 @param Handle Parent Handle.
383 @param DiskIo Parent DiskIo interface.
384 @param BlockIo Parent BlockIo interface.
385 @param DevicePath Parent Device Path.
387 @retval EFI_SUCCESS A child handle was added.
388 @retval EFI_MEDIA_CHANGED Media change was detected.
389 @retval Others MBR partition was not found.
393 PartitionInstallMbrChildHandles (
394 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
395 IN EFI_HANDLE Handle
,
396 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
397 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
398 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
403 (*PARTITION_DETECT_ROUTINE
) (
404 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
405 IN EFI_HANDLE Handle
,
406 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
407 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
408 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath