lib/efi_loader/efi_disk.c

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