1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application disk support
5 * Copyright (c) 2016 Alexander Graf
8 #define LOG_CATEGORY LOGC_EFI
13 #include <efi_loader.h>
19 struct efi_system_partition efi_system_partition;
21 const efi_guid_t efi_block_io_guid = EFI_BLOCK_IO_PROTOCOL_GUID;
24 * struct efi_disk_obj - EFI disk object
26 * @header: EFI object header
27 * @ops: EFI disk I/O protocol interface
28 * @ifname: interface name for block device
29 * @dev_index: device index of block device
30 * @media: block I/O media information
31 * @dp: device path to the block device
33 * @volume: simple file system protocol of the partition
34 * @offset: offset into disk for simple partition
35 * @desc: internal block device descriptor
38 struct efi_object header;
39 struct efi_block_io ops;
42 struct efi_block_io_media media;
43 struct efi_device_path *dp;
45 struct efi_simple_file_system_protocol *volume;
47 struct blk_desc *desc;
51 * efi_disk_reset() - reset block device
53 * This function implements the Reset service of the EFI_BLOCK_IO_PROTOCOL.
55 * As U-Boot's block devices do not have a reset function simply return
58 * See the Unified Extensible Firmware Interface (UEFI) specification for
61 * @this: pointer to the BLOCK_IO_PROTOCOL
62 * @extended_verification: extended verification
65 static efi_status_t EFIAPI efi_disk_reset(struct efi_block_io *this,
66 char extended_verification)
68 EFI_ENTRY("%p, %x", this, extended_verification);
69 return EFI_EXIT(EFI_SUCCESS);
72 enum efi_disk_direction {
77 static efi_status_t efi_disk_rw_blocks(struct efi_block_io *this,
78 u32 media_id, u64 lba, unsigned long buffer_size,
79 void *buffer, enum efi_disk_direction direction)
81 struct efi_disk_obj *diskobj;
82 struct blk_desc *desc;
87 diskobj = container_of(this, struct efi_disk_obj, ops);
88 desc = (struct blk_desc *) diskobj->desc;
90 blocks = buffer_size / blksz;
91 lba += diskobj->offset;
93 EFI_PRINT("blocks=%x lba=%llx blksz=%x dir=%d\n",
94 blocks, lba, blksz, direction);
96 /* We only support full block access */
97 if (buffer_size & (blksz - 1))
98 return EFI_BAD_BUFFER_SIZE;
100 if (direction == EFI_DISK_READ)
101 n = blk_dread(desc, lba, blocks, buffer);
103 n = blk_dwrite(desc, lba, blocks, buffer);
105 /* We don't do interrupts, so check for timers cooperatively */
108 EFI_PRINT("n=%lx blocks=%x\n", n, blocks);
111 return EFI_DEVICE_ERROR;
117 * efi_disk_read_blocks() - reads blocks from device
119 * This function implements the ReadBlocks service of the EFI_BLOCK_IO_PROTOCOL.
121 * See the Unified Extensible Firmware Interface (UEFI) specification for
124 * @this: pointer to the BLOCK_IO_PROTOCOL
125 * @media_id: id of the medium to be read from
126 * @lba: starting logical block for reading
127 * @buffer_size: size of the read buffer
128 * @buffer: pointer to the destination buffer
129 * Return: status code
131 static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
132 u32 media_id, u64 lba, efi_uintn_t buffer_size,
135 void *real_buffer = buffer;
139 return EFI_INVALID_PARAMETER;
140 /* TODO: check for media changes */
141 if (media_id != this->media->media_id)
142 return EFI_MEDIA_CHANGED;
143 if (!this->media->media_present)
145 /* media->io_align is a power of 2 or 0 */
146 if (this->media->io_align &&
147 (uintptr_t)buffer & (this->media->io_align - 1))
148 return EFI_INVALID_PARAMETER;
149 if (lba * this->media->block_size + buffer_size >
150 this->media->last_block * this->media->block_size)
151 return EFI_INVALID_PARAMETER;
153 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
154 if (buffer_size > EFI_LOADER_BOUNCE_BUFFER_SIZE) {
155 r = efi_disk_read_blocks(this, media_id, lba,
156 EFI_LOADER_BOUNCE_BUFFER_SIZE, buffer);
157 if (r != EFI_SUCCESS)
159 return efi_disk_read_blocks(this, media_id, lba +
160 EFI_LOADER_BOUNCE_BUFFER_SIZE / this->media->block_size,
161 buffer_size - EFI_LOADER_BOUNCE_BUFFER_SIZE,
162 buffer + EFI_LOADER_BOUNCE_BUFFER_SIZE);
165 real_buffer = efi_bounce_buffer;
168 EFI_ENTRY("%p, %x, %llx, %zx, %p", this, media_id, lba,
169 buffer_size, buffer);
171 r = efi_disk_rw_blocks(this, media_id, lba, buffer_size, real_buffer,
174 /* Copy from bounce buffer to real buffer if necessary */
175 if ((r == EFI_SUCCESS) && (real_buffer != buffer))
176 memcpy(buffer, real_buffer, buffer_size);
182 * efi_disk_write_blocks() - writes blocks to device
184 * This function implements the WriteBlocks service of the
185 * EFI_BLOCK_IO_PROTOCOL.
187 * See the Unified Extensible Firmware Interface (UEFI) specification for
190 * @this: pointer to the BLOCK_IO_PROTOCOL
191 * @media_id: id of the medium to be written to
192 * @lba: starting logical block for writing
193 * @buffer_size: size of the write buffer
194 * @buffer: pointer to the source buffer
195 * Return: status code
197 static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
198 u32 media_id, u64 lba, efi_uintn_t buffer_size,
201 void *real_buffer = buffer;
205 return EFI_INVALID_PARAMETER;
206 if (this->media->read_only)
207 return EFI_WRITE_PROTECTED;
208 /* TODO: check for media changes */
209 if (media_id != this->media->media_id)
210 return EFI_MEDIA_CHANGED;
211 if (!this->media->media_present)
213 /* media->io_align is a power of 2 or 0 */
214 if (this->media->io_align &&
215 (uintptr_t)buffer & (this->media->io_align - 1))
216 return EFI_INVALID_PARAMETER;
217 if (lba * this->media->block_size + buffer_size >
218 this->media->last_block * this->media->block_size)
219 return EFI_INVALID_PARAMETER;
221 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
222 if (buffer_size > EFI_LOADER_BOUNCE_BUFFER_SIZE) {
223 r = efi_disk_write_blocks(this, media_id, lba,
224 EFI_LOADER_BOUNCE_BUFFER_SIZE, buffer);
225 if (r != EFI_SUCCESS)
227 return efi_disk_write_blocks(this, media_id, lba +
228 EFI_LOADER_BOUNCE_BUFFER_SIZE / this->media->block_size,
229 buffer_size - EFI_LOADER_BOUNCE_BUFFER_SIZE,
230 buffer + EFI_LOADER_BOUNCE_BUFFER_SIZE);
233 real_buffer = efi_bounce_buffer;
236 EFI_ENTRY("%p, %x, %llx, %zx, %p", this, media_id, lba,
237 buffer_size, buffer);
239 /* Populate bounce buffer if necessary */
240 if (real_buffer != buffer)
241 memcpy(real_buffer, buffer, buffer_size);
243 r = efi_disk_rw_blocks(this, media_id, lba, buffer_size, real_buffer,
250 * efi_disk_flush_blocks() - flushes modified data to the device
252 * This function implements the FlushBlocks service of the
253 * EFI_BLOCK_IO_PROTOCOL.
255 * As we always write synchronously nothing is done here.
257 * See the Unified Extensible Firmware Interface (UEFI) specification for
260 * @this: pointer to the BLOCK_IO_PROTOCOL
261 * Return: status code
263 static efi_status_t EFIAPI efi_disk_flush_blocks(struct efi_block_io *this)
265 EFI_ENTRY("%p", this);
266 return EFI_EXIT(EFI_SUCCESS);
269 static const struct efi_block_io block_io_disk_template = {
270 .reset = &efi_disk_reset,
271 .read_blocks = &efi_disk_read_blocks,
272 .write_blocks = &efi_disk_write_blocks,
273 .flush_blocks = &efi_disk_flush_blocks,
277 * efi_fs_from_path() - retrieve simple file system protocol
279 * Gets the simple file system protocol for a file device path.
281 * The full path provided is split into device part and into a file
282 * part. The device part is used to find the handle on which the
283 * simple file system protocol is installed.
285 * @full_path: device path including device and file
286 * Return: simple file system protocol
288 struct efi_simple_file_system_protocol *
289 efi_fs_from_path(struct efi_device_path *full_path)
291 struct efi_object *efiobj;
292 struct efi_handler *handler;
293 struct efi_device_path *device_path;
294 struct efi_device_path *file_path;
297 /* Split the path into a device part and a file part */
298 ret = efi_dp_split_file_path(full_path, &device_path, &file_path);
299 if (ret != EFI_SUCCESS)
301 efi_free_pool(file_path);
303 /* Get the EFI object for the partition */
304 efiobj = efi_dp_find_obj(device_path, NULL);
305 efi_free_pool(device_path);
309 /* Find the simple file system protocol */
310 ret = efi_search_protocol(efiobj, &efi_simple_file_system_protocol_guid,
312 if (ret != EFI_SUCCESS)
315 /* Return the simple file system protocol for the partition */
316 return handler->protocol_interface;
320 * efi_fs_exists() - check if a partition bears a file system
322 * @desc: block device descriptor
323 * @part: partition number
324 * Return: 1 if a file system exists on the partition
327 static int efi_fs_exists(struct blk_desc *desc, int part)
329 if (fs_set_blk_dev_with_part(desc, part))
332 if (fs_get_type() == FS_TYPE_ANY)
341 * efi_disk_add_dev() - create a handle for a partition or disk
343 * @parent: parent handle
344 * @dp_parent: parent device path
345 * @if_typename: interface name for block device
346 * @desc: internal block device
347 * @dev_index: device index for block device
348 * @part_info: partition info
350 * @disk: pointer to receive the created handle
351 * Return: disk object
353 static efi_status_t efi_disk_add_dev(
355 struct efi_device_path *dp_parent,
356 const char *if_typename,
357 struct blk_desc *desc,
359 struct disk_partition *part_info,
361 struct efi_disk_obj **disk)
363 struct efi_disk_obj *diskobj;
364 struct efi_object *handle;
367 /* Don't add empty devices */
369 return EFI_NOT_READY;
371 diskobj = calloc(1, sizeof(*diskobj));
373 return EFI_OUT_OF_RESOURCES;
375 /* Hook up to the device list */
376 efi_add_handle(&diskobj->header);
378 /* Fill in object data */
380 struct efi_device_path *node = efi_dp_part_node(desc, part);
381 struct efi_handler *handler;
382 void *protocol_interface;
384 /* Parent must expose EFI_BLOCK_IO_PROTOCOL */
385 ret = efi_search_protocol(parent, &efi_block_io_guid, &handler);
386 if (ret != EFI_SUCCESS)
390 * Link the partition (child controller) to the block device
393 ret = efi_protocol_open(handler, &protocol_interface, NULL,
395 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER);
396 if (ret != EFI_SUCCESS)
399 diskobj->dp = efi_dp_append_node(dp_parent, node);
401 diskobj->offset = part_info->start;
402 diskobj->media.last_block = part_info->size - 1;
404 diskobj->dp = efi_dp_from_part(desc, part);
406 diskobj->media.last_block = desc->lba - 1;
408 diskobj->part = part;
411 * Install the device path and the block IO protocol.
413 * InstallMultipleProtocolInterfaces() checks if the device path is
414 * already installed on an other handle and returns EFI_ALREADY_STARTED
417 handle = &diskobj->header;
418 ret = EFI_CALL(efi_install_multiple_protocol_interfaces(
419 &handle, &efi_guid_device_path, diskobj->dp,
420 &efi_block_io_guid, &diskobj->ops, NULL));
421 if (ret != EFI_SUCCESS)
425 * On partitions or whole disks without partitions install the
426 * simple file system protocol if a file system is available.
428 if ((part || desc->part_type == PART_TYPE_UNKNOWN) &&
429 efi_fs_exists(desc, part)) {
430 diskobj->volume = efi_simple_file_system(desc, part,
432 ret = efi_add_protocol(&diskobj->header,
433 &efi_simple_file_system_protocol_guid,
435 if (ret != EFI_SUCCESS)
438 diskobj->ops = block_io_disk_template;
439 diskobj->ifname = if_typename;
440 diskobj->dev_index = dev_index;
441 diskobj->desc = desc;
443 /* Fill in EFI IO Media info (for read/write callbacks) */
444 diskobj->media.removable_media = desc->removable;
445 diskobj->media.media_present = 1;
447 * MediaID is just an arbitrary counter.
448 * We have to change it if the medium is removed or changed.
450 diskobj->media.media_id = 1;
451 diskobj->media.block_size = desc->blksz;
452 diskobj->media.io_align = desc->blksz;
454 diskobj->media.logical_partition = 1;
455 diskobj->ops.media = &diskobj->media;
459 EFI_PRINT("BlockIO: part %u, present %d, logical %d, removable %d"
460 ", offset " LBAF ", last_block %llu\n",
462 diskobj->media.media_present,
463 diskobj->media.logical_partition,
464 diskobj->media.removable_media,
466 diskobj->media.last_block);
468 /* Store first EFI system partition */
469 if (part && !efi_system_partition.if_type) {
471 struct disk_partition info;
473 r = part_get_info(desc, part, &info);
475 return EFI_DEVICE_ERROR;
476 if (info.bootable & PART_EFI_SYSTEM_PARTITION) {
477 efi_system_partition.if_type = desc->if_type;
478 efi_system_partition.devnum = desc->devnum;
479 efi_system_partition.part = part;
480 EFI_PRINT("EFI system partition: %s %d:%d\n",
481 blk_get_if_type_name(desc->if_type),
487 efi_delete_handle(&diskobj->header);
492 * efi_disk_create_partitions() - create handles and protocols for partitions
494 * Create handles and protocols for the partitions of a block device.
496 * @parent: handle of the parent disk
497 * @desc: block device
498 * @if_typename: interface type
499 * @diskid: device number
500 * @pdevname: device name
501 * Return: number of partitions created
503 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
504 const char *if_typename, int diskid,
505 const char *pdevname)
508 char devname[32] = { 0 }; /* dp->str is u16[32] long */
510 struct efi_device_path *dp = NULL;
512 struct efi_handler *handler;
514 /* Get the device path of the parent */
515 ret = efi_search_protocol(parent, &efi_guid_device_path, &handler);
516 if (ret == EFI_SUCCESS)
517 dp = handler->protocol_interface;
519 /* Add devices for each partition */
520 for (part = 1; part <= MAX_SEARCH_PARTITIONS; part++) {
521 struct disk_partition info;
523 if (part_get_info(desc, part, &info))
525 snprintf(devname, sizeof(devname), "%s:%d", pdevname,
527 ret = efi_disk_add_dev(parent, dp, if_typename, desc, diskid,
529 if (ret != EFI_SUCCESS) {
530 log_err("Adding partition %s failed\n", pdevname);
540 * efi_disk_register() - register block devices
542 * U-Boot doesn't have a list of all online disk devices. So when running our
543 * EFI payload, we scan through all of the potentially available ones and
544 * store them in our object pool.
546 * This function is called in efi_init_obj_list().
549 * Consider converting the code to look up devices as needed. The EFI device
550 * could be a child of the UCLASS_BLK block device, perhaps.
552 * Return: status code
554 efi_status_t efi_disk_register(void)
556 struct efi_disk_obj *disk;
562 for (uclass_first_device_check(UCLASS_BLK, &dev); dev;
563 uclass_next_device_check(&dev)) {
564 struct blk_desc *desc = dev_get_uclass_plat(dev);
565 const char *if_typename = blk_get_if_type_name(desc->if_type);
567 /* Add block device for the full device */
568 log_info("Scanning disk %s...\n", dev->name);
569 ret = efi_disk_add_dev(NULL, NULL, if_typename,
570 desc, desc->devnum, NULL, 0, &disk);
571 if (ret == EFI_NOT_READY) {
572 log_notice("Disk %s not ready\n", dev->name);
576 log_err("ERROR: failure to add disk device %s, r = %lu\n",
577 dev->name, ret & ~EFI_ERROR_MASK);
582 /* Partitions show up as block devices in EFI */
583 disks += efi_disk_create_partitions(
584 &disk->header, desc, if_typename,
585 desc->devnum, dev->name);
590 /* Search for all available disk devices */
591 for (if_type = 0; if_type < IF_TYPE_COUNT; if_type++) {
592 const struct blk_driver *cur_drvr;
593 const char *if_typename;
595 cur_drvr = blk_driver_lookup_type(if_type);
599 if_typename = cur_drvr->if_typename;
600 log_info("Scanning disks on %s...\n", if_typename);
601 for (i = 0; i < 4; i++) {
602 struct blk_desc *desc;
603 char devname[32] = { 0 }; /* dp->str is u16[32] long */
605 desc = blk_get_devnum_by_type(if_type, i);
608 if (desc->type == DEV_TYPE_UNKNOWN)
611 snprintf(devname, sizeof(devname), "%s%d",
614 /* Add block device for the full device */
615 ret = efi_disk_add_dev(NULL, NULL, if_typename, desc,
617 if (ret == EFI_NOT_READY) {
618 log_notice("Disk %s not ready\n", devname);
622 log_err("ERROR: failure to add disk device %s, r = %lu\n",
623 devname, ret & ~EFI_ERROR_MASK);
628 /* Partitions show up as block devices in EFI */
629 disks += efi_disk_create_partitions
630 (&disk->header, desc,
631 if_typename, i, devname);
635 log_info("Found %d disks\n", disks);
641 * efi_disk_is_system_part() - check if handle refers to an EFI system partition
643 * @handle: handle of partition
645 * Return: true if handle refers to an EFI system partition
647 bool efi_disk_is_system_part(efi_handle_t handle)
649 struct efi_handler *handler;
650 struct efi_disk_obj *diskobj;
651 struct disk_partition info;
655 /* check if this is a block device */
656 ret = efi_search_protocol(handle, &efi_block_io_guid, &handler);
657 if (ret != EFI_SUCCESS)
660 diskobj = container_of(handle, struct efi_disk_obj, header);
662 r = part_get_info(diskobj->desc, diskobj->part, &info);
666 return !!(info.bootable & PART_EFI_SYSTEM_PARTITION);