load_image: LoadImageSource::FromFilePath => FromDevicePath

Author: phip1611

CHANGELOG.md

@@ -8,6 +8,7 @@
 - `DevicePathNode::data`
 
 ### Changed
+- Renamed `LoadImageSource::FromFilePath` to `LoadImageSource::FromDevicePath`
 
 ### Removed
 
@@ -44,7 +45,6 @@
   `BUFFER_TOO_SMALL` error can only occur when reading a directory, not a file.
 - `RegularFile::read` now reads in 1 MiB chunks to avoid a bug in some
   firmware. This fix also applies to `fs::FileSystem::read`.
-
 ## uefi-services - 0.19.0 (2023-06-01)
 
 ### Changed

uefi-test-runner/src/bin/shell_launcher.rs

@@ -57,8 +57,8 @@ fn efi_main(image: Handle, mut st: SystemTable<Boot>) -> Status {
     let shell_image_handle = boot_services
         .load_image(
             image,
-            LoadImageSource::FromFilePath {
-                file_path: shell_image_path,
+            LoadImageSource::FromDevicePath {
+                device_path: shell_image_path,
                 from_boot_manager: false,
             },
         )

uefi-test-runner/src/boot/mod.rs

@@ -91,10 +91,10 @@ fn test_load_image(bt: &BootServices) {
 
         log::debug!("load_image with FromBuffer strategy works");
     }
-    // Variant B: FromFilePath
+    // Variant B: FromDevicePath
     {
-        let load_source = LoadImageSource::FromFilePath {
-            file_path: image_device_path,
+        let load_source = LoadImageSource::FromDevicePath {
+            device_path: image_device_path,
             from_boot_manager: false,
         };
         let _ = bt

uefi/src/table/boot.rs

@@ -1026,8 +1026,8 @@ impl BootServices {
                 source_buffer = buffer.as_ptr();
                 source_size = buffer.len();
             }
-            LoadImageSource::FromFilePath {
-                file_path,
+            LoadImageSource::FromDevicePath {
+                device_path: file_path,
                 from_boot_manager,
             } => {
                 boot_policy = u8::from(from_boot_manager);
@@ -1697,11 +1697,21 @@ pub enum LoadImageSource<'a> {
     /// behavior depends on `from_boot_manager`. If `true`, attempt to
     /// load via the `LoadFile` protocol. If `false`, attempt to load
     /// via the `LoadFile2` protocol, then fall back to `LoadFile`.
-    FromFilePath {
-        /// Device path from which to load the image.
-        file_path: &'a DevicePath,
-
-        /// Whether the request originates from the boot manager.
+    FromDevicePath {
+        /// The full device path from which to load the image.
+        ///
+        /// The provided path should be a full device path and not just the
+        /// file path portion of it. So for example, it must be (the binary
+        /// representation)
+        /// `PciRoot(0x0)/Pci(0x1F,0x2)/Sata(0x0,0xFFFF,0x0)/HD(1,MBR,0xBE1AFDFA,0x3F,0xFBFC1)/\\EFI\\BOOT\\BOOTX64.EFI`
+        /// and not just `\\EFI\\BOOT\\BOOTX64.EFI`.
+        device_path: &'a DevicePath,
+
+        /// If there is no instance of [`SimpleFileSystem`] protocol associated
+        /// with the given device path, then this function will attempt to use
+        /// `LoadFileProtocol` (`from_boot_manager` is `true`) or
+        /// `LoadFile2Protocol`, and then `LoadFileProtocol`
+        /// (`from_boot_manager` is `false`).
         from_boot_manager: bool,
     },
 }