1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * EFI application disk support
4 *
5 * Copyright (c) 2016 Alexander Graf
6 */
7
8 #define LOG_CATEGORY LOGC_EFI
9
10 #include <common.h>
11 #include <blk.h>
12 #include <dm.h>
13 #include <efi_loader.h>
14 #include <fs.h>
15 #include <log.h>
16 #include <part.h>
17 #include <malloc.h>
18
19 struct efi_system_partition efi_system_partition;
20
21 const efi_guid_t efi_block_io_guid = EFI_BLOCK_IO_PROTOCOL_GUID;
22 const efi_guid_t efi_system_partition_guid = PARTITION_SYSTEM_GUID;
23
24 /**
25 * struct efi_disk_obj - EFI disk object
26 *
27 * @header: EFI object header
28 * @ops: EFI disk I/O protocol interface
29 * @ifname: interface name for block device
30 * @dev_index: device index of block device
31 * @media: block I/O media information
32 * @dp: device path to the block device
33 * @part: partition
34 * @volume: simple file system protocol of the partition
35 * @offset: offset into disk for simple partition
36 * @desc: internal block device descriptor
37 */
38 struct efi_disk_obj {
39 struct efi_object header;
40 struct efi_block_io ops;
41 const char *ifname;
42 int dev_index;
43 struct efi_block_io_media media;
44 struct efi_device_path *dp;
45 unsigned int part;
46 struct efi_simple_file_system_protocol *volume;
47 lbaint_t offset;
48 struct blk_desc *desc;
49 };
50
51 /**
52 * efi_disk_reset() - reset block device
53 *
54 * This function implements the Reset service of the EFI_BLOCK_IO_PROTOCOL.
55 *
56 * As U-Boot's block devices do not have a reset function simply return
57 * EFI_SUCCESS.
58 *
59 * See the Unified Extensible Firmware Interface (UEFI) specification for
60 * details.
61 *
62 * @this: pointer to the BLOCK_IO_PROTOCOL
63 * @extended_verification: extended verification
64 * Return: status code
65 */
efi_disk_reset(struct efi_block_io * this,char extended_verification)66 static efi_status_t EFIAPI efi_disk_reset(struct efi_block_io *this,
67 char extended_verification)
68 {
69 EFI_ENTRY("%p, %x", this, extended_verification);
70 return EFI_EXIT(EFI_SUCCESS);
71 }
72
73 enum efi_disk_direction {
74 EFI_DISK_READ,
75 EFI_DISK_WRITE,
76 };
77
efi_disk_rw_blocks(struct efi_block_io * this,u32 media_id,u64 lba,unsigned long buffer_size,void * buffer,enum efi_disk_direction direction)78 static efi_status_t efi_disk_rw_blocks(struct efi_block_io *this,
79 u32 media_id, u64 lba, unsigned long buffer_size,
80 void *buffer, enum efi_disk_direction direction)
81 {
82 struct efi_disk_obj *diskobj;
83 struct blk_desc *desc;
84 int blksz;
85 int blocks;
86 unsigned long n;
87
88 diskobj = container_of(this, struct efi_disk_obj, ops);
89 desc = (struct blk_desc *) diskobj->desc;
90 blksz = desc->blksz;
91 blocks = buffer_size / blksz;
92 lba += diskobj->offset;
93
94 EFI_PRINT("blocks=%x lba=%llx blksz=%x dir=%d\n",
95 blocks, lba, blksz, direction);
96
97 /* We only support full block access */
98 if (buffer_size & (blksz - 1))
99 return EFI_BAD_BUFFER_SIZE;
100
101 if (direction == EFI_DISK_READ)
102 n = blk_dread(desc, lba, blocks, buffer);
103 else
104 n = blk_dwrite(desc, lba, blocks, buffer);
105
106 /* We don't do interrupts, so check for timers cooperatively */
107 efi_timer_check();
108
109 EFI_PRINT("n=%lx blocks=%x\n", n, blocks);
110
111 if (n != blocks)
112 return EFI_DEVICE_ERROR;
113
114 return EFI_SUCCESS;
115 }
116
117 /**
118 * efi_disk_read_blocks() - reads blocks from device
119 *
120 * This function implements the ReadBlocks service of the EFI_BLOCK_IO_PROTOCOL.
121 *
122 * See the Unified Extensible Firmware Interface (UEFI) specification for
123 * details.
124 *
125 * @this: pointer to the BLOCK_IO_PROTOCOL
126 * @media_id: id of the medium to be read from
127 * @lba: starting logical block for reading
128 * @buffer_size: size of the read buffer
129 * @buffer: pointer to the destination buffer
130 * Return: status code
131 */
efi_disk_read_blocks(struct efi_block_io * this,u32 media_id,u64 lba,efi_uintn_t buffer_size,void * buffer)132 static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
133 u32 media_id, u64 lba, efi_uintn_t buffer_size,
134 void *buffer)
135 {
136 void *real_buffer = buffer;
137 efi_status_t r;
138
139 if (!this)
140 return EFI_INVALID_PARAMETER;
141 /* TODO: check for media changes */
142 if (media_id != this->media->media_id)
143 return EFI_MEDIA_CHANGED;
144 if (!this->media->media_present)
145 return EFI_NO_MEDIA;
146 /* media->io_align is a power of 2 or 0 */
147 if (this->media->io_align &&
148 (uintptr_t)buffer & (this->media->io_align - 1))
149 return EFI_INVALID_PARAMETER;
150 if (lba * this->media->block_size + buffer_size >
151 (this->media->last_block + 1) * this->media->block_size)
152 return EFI_INVALID_PARAMETER;
153
154 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
155 if (buffer_size > EFI_LOADER_BOUNCE_BUFFER_SIZE) {
156 r = efi_disk_read_blocks(this, media_id, lba,
157 EFI_LOADER_BOUNCE_BUFFER_SIZE, buffer);
158 if (r != EFI_SUCCESS)
159 return r;
160 return efi_disk_read_blocks(this, media_id, lba +
161 EFI_LOADER_BOUNCE_BUFFER_SIZE / this->media->block_size,
162 buffer_size - EFI_LOADER_BOUNCE_BUFFER_SIZE,
163 buffer + EFI_LOADER_BOUNCE_BUFFER_SIZE);
164 }
165
166 real_buffer = efi_bounce_buffer;
167 #endif
168
169 EFI_ENTRY("%p, %x, %llx, %zx, %p", this, media_id, lba,
170 buffer_size, buffer);
171
172 r = efi_disk_rw_blocks(this, media_id, lba, buffer_size, real_buffer,
173 EFI_DISK_READ);
174
175 /* Copy from bounce buffer to real buffer if necessary */
176 if ((r == EFI_SUCCESS) && (real_buffer != buffer))
177 memcpy(buffer, real_buffer, buffer_size);
178
179 return EFI_EXIT(r);
180 }
181
182 /**
183 * efi_disk_write_blocks() - writes blocks to device
184 *
185 * This function implements the WriteBlocks service of the
186 * EFI_BLOCK_IO_PROTOCOL.
187 *
188 * See the Unified Extensible Firmware Interface (UEFI) specification for
189 * details.
190 *
191 * @this: pointer to the BLOCK_IO_PROTOCOL
192 * @media_id: id of the medium to be written to
193 * @lba: starting logical block for writing
194 * @buffer_size: size of the write buffer
195 * @buffer: pointer to the source buffer
196 * Return: status code
197 */
efi_disk_write_blocks(struct efi_block_io * this,u32 media_id,u64 lba,efi_uintn_t buffer_size,void * buffer)198 static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
199 u32 media_id, u64 lba, efi_uintn_t buffer_size,
200 void *buffer)
201 {
202 void *real_buffer = buffer;
203 efi_status_t r;
204
205 if (!this)
206 return EFI_INVALID_PARAMETER;
207 if (this->media->read_only)
208 return EFI_WRITE_PROTECTED;
209 /* TODO: check for media changes */
210 if (media_id != this->media->media_id)
211 return EFI_MEDIA_CHANGED;
212 if (!this->media->media_present)
213 return EFI_NO_MEDIA;
214 /* media->io_align is a power of 2 or 0 */
215 if (this->media->io_align &&
216 (uintptr_t)buffer & (this->media->io_align - 1))
217 return EFI_INVALID_PARAMETER;
218 if (lba * this->media->block_size + buffer_size >
219 (this->media->last_block + 1) * this->media->block_size)
220 return EFI_INVALID_PARAMETER;
221
222 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
223 if (buffer_size > EFI_LOADER_BOUNCE_BUFFER_SIZE) {
224 r = efi_disk_write_blocks(this, media_id, lba,
225 EFI_LOADER_BOUNCE_BUFFER_SIZE, buffer);
226 if (r != EFI_SUCCESS)
227 return r;
228 return efi_disk_write_blocks(this, media_id, lba +
229 EFI_LOADER_BOUNCE_BUFFER_SIZE / this->media->block_size,
230 buffer_size - EFI_LOADER_BOUNCE_BUFFER_SIZE,
231 buffer + EFI_LOADER_BOUNCE_BUFFER_SIZE);
232 }
233
234 real_buffer = efi_bounce_buffer;
235 #endif
236
237 EFI_ENTRY("%p, %x, %llx, %zx, %p", this, media_id, lba,
238 buffer_size, buffer);
239
240 /* Populate bounce buffer if necessary */
241 if (real_buffer != buffer)
242 memcpy(real_buffer, buffer, buffer_size);
243
244 r = efi_disk_rw_blocks(this, media_id, lba, buffer_size, real_buffer,
245 EFI_DISK_WRITE);
246
247 return EFI_EXIT(r);
248 }
249
250 /**
251 * efi_disk_flush_blocks() - flushes modified data to the device
252 *
253 * This function implements the FlushBlocks service of the
254 * EFI_BLOCK_IO_PROTOCOL.
255 *
256 * As we always write synchronously nothing is done here.
257 *
258 * See the Unified Extensible Firmware Interface (UEFI) specification for
259 * details.
260 *
261 * @this: pointer to the BLOCK_IO_PROTOCOL
262 * Return: status code
263 */
efi_disk_flush_blocks(struct efi_block_io * this)264 static efi_status_t EFIAPI efi_disk_flush_blocks(struct efi_block_io *this)
265 {
266 EFI_ENTRY("%p", this);
267 return EFI_EXIT(EFI_SUCCESS);
268 }
269
270 static const struct efi_block_io block_io_disk_template = {
271 .reset = &efi_disk_reset,
272 .read_blocks = &efi_disk_read_blocks,
273 .write_blocks = &efi_disk_write_blocks,
274 .flush_blocks = &efi_disk_flush_blocks,
275 };
276
277 /**
278 * efi_fs_from_path() - retrieve simple file system protocol
279 *
280 * Gets the simple file system protocol for a file device path.
281 *
282 * The full path provided is split into device part and into a file
283 * part. The device part is used to find the handle on which the
284 * simple file system protocol is installed.
285 *
286 * @full_path: device path including device and file
287 * Return: simple file system protocol
288 */
289 struct efi_simple_file_system_protocol *
efi_fs_from_path(struct efi_device_path * full_path)290 efi_fs_from_path(struct efi_device_path *full_path)
291 {
292 struct efi_object *efiobj;
293 struct efi_handler *handler;
294 struct efi_device_path *device_path;
295 struct efi_device_path *file_path;
296 efi_status_t ret;
297
298 /* Split the path into a device part and a file part */
299 ret = efi_dp_split_file_path(full_path, &device_path, &file_path);
300 if (ret != EFI_SUCCESS)
301 return NULL;
302 efi_free_pool(file_path);
303
304 /* Get the EFI object for the partition */
305 efiobj = efi_dp_find_obj(device_path, NULL);
306 efi_free_pool(device_path);
307 if (!efiobj)
308 return NULL;
309
310 /* Find the simple file system protocol */
311 ret = efi_search_protocol(efiobj, &efi_simple_file_system_protocol_guid,
312 &handler);
313 if (ret != EFI_SUCCESS)
314 return NULL;
315
316 /* Return the simple file system protocol for the partition */
317 return handler->protocol_interface;
318 }
319
320 /**
321 * efi_fs_exists() - check if a partition bears a file system
322 *
323 * @desc: block device descriptor
324 * @part: partition number
325 * Return: 1 if a file system exists on the partition
326 * 0 otherwise
327 */
efi_fs_exists(struct blk_desc * desc,int part)328 static int efi_fs_exists(struct blk_desc *desc, int part)
329 {
330 if (fs_set_blk_dev_with_part(desc, part))
331 return 0;
332
333 if (fs_get_type() == FS_TYPE_ANY)
334 return 0;
335
336 fs_close();
337
338 return 1;
339 }
340
341 /**
342 * efi_disk_add_dev() - create a handle for a partition or disk
343 *
344 * @parent: parent handle
345 * @dp_parent: parent device path
346 * @if_typename: interface name for block device
347 * @desc: internal block device
348 * @dev_index: device index for block device
349 * @part_info: partition info
350 * @part: partition
351 * @disk: pointer to receive the created handle
352 * Return: disk object
353 */
efi_disk_add_dev(efi_handle_t parent,struct efi_device_path * dp_parent,const char * if_typename,struct blk_desc * desc,int dev_index,struct disk_partition * part_info,unsigned int part,struct efi_disk_obj ** disk)354 static efi_status_t efi_disk_add_dev(
355 efi_handle_t parent,
356 struct efi_device_path *dp_parent,
357 const char *if_typename,
358 struct blk_desc *desc,
359 int dev_index,
360 struct disk_partition *part_info,
361 unsigned int part,
362 struct efi_disk_obj **disk)
363 {
364 struct efi_disk_obj *diskobj;
365 struct efi_object *handle;
366 const efi_guid_t *guid = NULL;
367 efi_status_t ret;
368
369 /* Don't add empty devices */
370 if (!desc->lba)
371 return EFI_NOT_READY;
372
373 diskobj = calloc(1, sizeof(*diskobj));
374 if (!diskobj)
375 return EFI_OUT_OF_RESOURCES;
376
377 /* Hook up to the device list */
378 efi_add_handle(&diskobj->header);
379
380 /* Fill in object data */
381 if (part_info) {
382 struct efi_device_path *node = efi_dp_part_node(desc, part);
383 struct efi_handler *handler;
384 void *protocol_interface;
385
386 /* Parent must expose EFI_BLOCK_IO_PROTOCOL */
387 ret = efi_search_protocol(parent, &efi_block_io_guid, &handler);
388 if (ret != EFI_SUCCESS)
389 goto error;
390
391 /*
392 * Link the partition (child controller) to the block device
393 * (controller).
394 */
395 ret = efi_protocol_open(handler, &protocol_interface, NULL,
396 &diskobj->header,
397 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER);
398 if (ret != EFI_SUCCESS)
399 goto error;
400
401 diskobj->dp = efi_dp_append_node(dp_parent, node);
402 efi_free_pool(node);
403 diskobj->offset = part_info->start;
404 diskobj->media.last_block = part_info->size - 1;
405 if (part_info->bootable & PART_EFI_SYSTEM_PARTITION)
406 guid = &efi_system_partition_guid;
407 } else {
408 diskobj->dp = efi_dp_from_part(desc, part);
409 diskobj->offset = 0;
410 diskobj->media.last_block = desc->lba - 1;
411 }
412 diskobj->part = part;
413
414 /*
415 * Install the device path and the block IO protocol.
416 *
417 * InstallMultipleProtocolInterfaces() checks if the device path is
418 * already installed on an other handle and returns EFI_ALREADY_STARTED
419 * in this case.
420 */
421 handle = &diskobj->header;
422 ret = EFI_CALL(efi_install_multiple_protocol_interfaces(
423 &handle, &efi_guid_device_path, diskobj->dp,
424 &efi_block_io_guid, &diskobj->ops,
425 guid, NULL, NULL));
426 if (ret != EFI_SUCCESS)
427 return ret;
428
429 /*
430 * On partitions or whole disks without partitions install the
431 * simple file system protocol if a file system is available.
432 */
433 if ((part || desc->part_type == PART_TYPE_UNKNOWN) &&
434 efi_fs_exists(desc, part)) {
435 diskobj->volume = efi_simple_file_system(desc, part,
436 diskobj->dp);
437 ret = efi_add_protocol(&diskobj->header,
438 &efi_simple_file_system_protocol_guid,
439 diskobj->volume);
440 if (ret != EFI_SUCCESS)
441 return ret;
442 }
443 diskobj->ops = block_io_disk_template;
444 diskobj->ifname = if_typename;
445 diskobj->dev_index = dev_index;
446 diskobj->desc = desc;
447
448 /* Fill in EFI IO Media info (for read/write callbacks) */
449 diskobj->media.removable_media = desc->removable;
450 diskobj->media.media_present = 1;
451 /*
452 * MediaID is just an arbitrary counter.
453 * We have to change it if the medium is removed or changed.
454 */
455 diskobj->media.media_id = 1;
456 diskobj->media.block_size = desc->blksz;
457 diskobj->media.io_align = desc->blksz;
458 if (part)
459 diskobj->media.logical_partition = 1;
460 diskobj->ops.media = &diskobj->media;
461 if (disk)
462 *disk = diskobj;
463
464 EFI_PRINT("BlockIO: part %u, present %d, logical %d, removable %d"
465 ", offset " LBAF ", last_block %llu\n",
466 diskobj->part,
467 diskobj->media.media_present,
468 diskobj->media.logical_partition,
469 diskobj->media.removable_media,
470 diskobj->offset,
471 diskobj->media.last_block);
472
473 /* Store first EFI system partition */
474 if (part && !efi_system_partition.if_type) {
475 if (part_info->bootable & PART_EFI_SYSTEM_PARTITION) {
476 efi_system_partition.if_type = desc->if_type;
477 efi_system_partition.devnum = desc->devnum;
478 efi_system_partition.part = part;
479 EFI_PRINT("EFI system partition: %s %x:%x\n",
480 blk_get_if_type_name(desc->if_type),
481 desc->devnum, part);
482 }
483 }
484 return EFI_SUCCESS;
485 error:
486 efi_delete_handle(&diskobj->header);
487 return ret;
488 }
489
490 /**
491 * efi_disk_create_partitions() - create handles and protocols for partitions
492 *
493 * Create handles and protocols for the partitions of a block device.
494 *
495 * @parent: handle of the parent disk
496 * @desc: block device
497 * @if_typename: interface type
498 * @diskid: device number
499 * @pdevname: device name
500 * Return: number of partitions created
501 */
efi_disk_create_partitions(efi_handle_t parent,struct blk_desc * desc,const char * if_typename,int diskid,const char * pdevname)502 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
503 const char *if_typename, int diskid,
504 const char *pdevname)
505 {
506 int disks = 0;
507 char devname[32] = { 0 }; /* dp->str is u16[32] long */
508 int part;
509 struct efi_device_path *dp = NULL;
510 efi_status_t ret;
511 struct efi_handler *handler;
512
513 /* Get the device path of the parent */
514 ret = efi_search_protocol(parent, &efi_guid_device_path, &handler);
515 if (ret == EFI_SUCCESS)
516 dp = handler->protocol_interface;
517
518 /* Add devices for each partition */
519 for (part = 1; part <= MAX_SEARCH_PARTITIONS; part++) {
520 struct disk_partition info;
521
522 if (part_get_info(desc, part, &info))
523 continue;
524 snprintf(devname, sizeof(devname), "%s:%x", pdevname,
525 part);
526 ret = efi_disk_add_dev(parent, dp, if_typename, desc, diskid,
527 &info, part, NULL);
528 if (ret != EFI_SUCCESS) {
529 log_err("Adding partition %s failed\n", pdevname);
530 continue;
531 }
532 disks++;
533 }
534
535 return disks;
536 }
537
538 /**
539 * efi_disk_register() - register block devices
540 *
541 * U-Boot doesn't have a list of all online disk devices. So when running our
542 * EFI payload, we scan through all of the potentially available ones and
543 * store them in our object pool.
544 *
545 * This function is called in efi_init_obj_list().
546 *
547 * TODO(sjg@chromium.org): Actually with CONFIG_BLK, U-Boot does have this.
548 * Consider converting the code to look up devices as needed. The EFI device
549 * could be a child of the UCLASS_BLK block device, perhaps.
550 *
551 * Return: status code
552 */
efi_disk_register(void)553 efi_status_t efi_disk_register(void)
554 {
555 struct efi_disk_obj *disk;
556 int disks = 0;
557 efi_status_t ret;
558 #ifdef CONFIG_BLK
559 struct udevice *dev;
560
561 for (uclass_first_device_check(UCLASS_BLK, &dev); dev;
562 uclass_next_device_check(&dev)) {
563 struct blk_desc *desc = dev_get_uclass_plat(dev);
564 const char *if_typename = blk_get_if_type_name(desc->if_type);
565
566 /* Add block device for the full device */
567 log_info("Scanning disk %s...\n", dev->name);
568 ret = efi_disk_add_dev(NULL, NULL, if_typename,
569 desc, desc->devnum, NULL, 0, &disk);
570 if (ret == EFI_NOT_READY) {
571 log_notice("Disk %s not ready\n", dev->name);
572 continue;
573 }
574 if (ret) {
575 log_err("ERROR: failure to add disk device %s, r = %lu\n",
576 dev->name, ret & ~EFI_ERROR_MASK);
577 return ret;
578 }
579 disks++;
580
581 /* Partitions show up as block devices in EFI */
582 disks += efi_disk_create_partitions(
583 &disk->header, desc, if_typename,
584 desc->devnum, dev->name);
585 }
586 #else
587 int i, if_type;
588
589 /* Search for all available disk devices */
590 for (if_type = 0; if_type < IF_TYPE_COUNT; if_type++) {
591 const struct blk_driver *cur_drvr;
592 const char *if_typename;
593
594 cur_drvr = blk_driver_lookup_type(if_type);
595 if (!cur_drvr)
596 continue;
597
598 if_typename = cur_drvr->if_typename;
599 log_info("Scanning disks on %s...\n", if_typename);
600 for (i = 0; i < 4; i++) {
601 struct blk_desc *desc;
602 char devname[32] = { 0 }; /* dp->str is u16[32] long */
603
604 desc = blk_get_devnum_by_type(if_type, i);
605 if (!desc)
606 continue;
607 if (desc->type == DEV_TYPE_UNKNOWN)
608 continue;
609
610 snprintf(devname, sizeof(devname), "%s%d",
611 if_typename, i);
612
613 /* Add block device for the full device */
614 ret = efi_disk_add_dev(NULL, NULL, if_typename, desc,
615 i, NULL, 0, &disk);
616 if (ret == EFI_NOT_READY) {
617 log_notice("Disk %s not ready\n", devname);
618 continue;
619 }
620 if (ret) {
621 log_err("ERROR: failure to add disk device %s, r = %lu\n",
622 devname, ret & ~EFI_ERROR_MASK);
623 return ret;
624 }
625 disks++;
626
627 /* Partitions show up as block devices in EFI */
628 disks += efi_disk_create_partitions
629 (&disk->header, desc,
630 if_typename, i, devname);
631 }
632 }
633 #endif
634 log_info("Found %d disks\n", disks);
635
636 return EFI_SUCCESS;
637 }
638
639 /**
640 * efi_disk_is_system_part() - check if handle refers to an EFI system partition
641 *
642 * @handle: handle of partition
643 *
644 * Return: true if handle refers to an EFI system partition
645 */
efi_disk_is_system_part(efi_handle_t handle)646 bool efi_disk_is_system_part(efi_handle_t handle)
647 {
648 struct efi_handler *handler;
649 struct efi_disk_obj *diskobj;
650 struct disk_partition info;
651 efi_status_t ret;
652 int r;
653
654 /* check if this is a block device */
655 ret = efi_search_protocol(handle, &efi_block_io_guid, &handler);
656 if (ret != EFI_SUCCESS)
657 return false;
658
659 diskobj = container_of(handle, struct efi_disk_obj, header);
660
661 r = part_get_info(diskobj->desc, diskobj->part, &info);
662 if (r)
663 return false;
664
665 return !!(info.bootable & PART_EFI_SYSTEM_PARTITION);
666 }
667