uefi: Add integration test for ATA_PASS_THRU_PROTOCOL

Author: seijikun

Diff for: uefi-test-runner/src/proto/ata/mod.rs

@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+mod pass_thru;
+
+pub fn test() {
+    pass_thru::test();
+}

Diff for: uefi-test-runner/src/proto/ata/pass_thru.rs

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+use uefi::boot;
+use uefi::boot::{OpenProtocolAttributes, OpenProtocolParams};
+use uefi::proto::ata::pass_thru::AtaPassThru;
+use uefi::proto::ata::AtaRequestBuilder;
+
+pub fn test() {
+    info!("Running ATA PassThru tests");
+
+    assert!(is_testdrive_present());
+}
+
+const ATACMD_IDENTIFY: u8 = 0xEC;
+
+fn is_testdrive_present() -> bool {
+    let ata_ctrl_handles = boot::find_handles::<AtaPassThru>().unwrap();
+    assert_eq!(ata_ctrl_handles.len(), 1);
+
+    for handle in ata_ctrl_handles {
+        let params = OpenProtocolParams {
+            handle,
+            agent: boot::image_handle(),
+            controller: None,
+        };
+        let ata_pt = unsafe {
+            // don't open exclusive! That would break other tests
+            boot::open_protocol::<AtaPassThru>(params, OpenProtocolAttributes::GetProtocol).unwrap()
+        };
+        for mut device in ata_pt.iter_devices() {
+            // ATA IDENTIFY command
+            let request = AtaRequestBuilder::read_udma(ata_pt.io_align(), ATACMD_IDENTIFY)
+                .unwrap()
+                .with_timeout(core::time::Duration::from_millis(500))
+                .with_read_buffer(255)
+                .unwrap()
+                .build();
+            if let Ok(result) = device.execute_command(request) {
+                let bfr = result.read_buffer().unwrap();
+                // ATA uses wchar16 big endian strings for serial numbers
+                let mut serial_bfr = [0u8; 20];
+                bfr[20..40]
+                    .chunks_exact(2)
+                    .zip(serial_bfr.chunks_exact_mut(2))
+                    .for_each(|(src, dst)| {
+                        dst[0] = src[1];
+                        dst[1] = src[0];
+                    });
+                let serial = core::str::from_utf8(&serial_bfr).unwrap().trim();
+                if serial == "AtaPassThru" {
+                    info!("Found Testdisk at handle: {:?}", handle);
+                    return true; // found our testdrive!
+                }
+            }
+        }
+    }
+
+    false
+}

Diff for: uefi-test-runner/src/proto/media.rs

@@ -398,7 +398,15 @@ fn test_partition_info(disk_handle: Handle) {
 fn find_test_disk() -> (Handle, ScopedProtocol<SimpleFileSystem>) {
     let handles = boot::find_handles::<SimpleFileSystem>()
         .expect("Failed to get handles for `SimpleFileSystem` protocol");
+
+    // This branch is due to the qemu machine type we use based on the architecture.
+    // - *Q35* by default uses a SATA-Controller to connect disks.
+    // - *virt* by default uses virtio to connect disks.
+    // The aarch64 UEFI Firmware does not yet seem to support SATA-Controllers.
+    #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
     assert_eq!(handles.len(), 2);
+    #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+    assert_eq!(handles.len(), 3);
 
     for handle in handles {
         let mut sfs = boot::open_protocol_exclusive::<SimpleFileSystem>(handle)

Diff for: uefi-test-runner/src/proto/mod.rs

@@ -25,6 +25,11 @@ pub fn test() {
     shell_params::test();
     string::test();
     misc::test();
+
+    // disable the ATA test on aarch64 for now. The aarch64 UEFI Firmware does not yet seem
+    // to support SATA controllers (and providing an AtaPassThru protocol instance for them).
+    #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+    ata::test();
     scsi::test();
     nvme::test();
 
@@ -64,6 +69,8 @@ fn test_test_protocol() {
     .unwrap());
 }
 
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
+mod ata;
 mod console;
 mod debug;
 mod device_path;

Diff for: xtask/src/qemu.rs

@@ -459,6 +459,11 @@ pub fn run_qemu(arch: UefiArch, opt: &QemuOpt) -> Result<()> {
     // Configure SCSI Controller
     cmd.arg("-device");
     cmd.arg("virtio-scsi-pci");
+    if arch != UefiArch::IA32 && arch != UefiArch::X86_64 {
+        // The "virt" qemu machine does not have SATA-Controller by default
+        cmd.arg("-device");
+        cmd.arg("ahci,id=ide");
+    }
 
     // Mount a local directory as a FAT partition.
     cmd.arg("-drive");
@@ -499,6 +504,16 @@ pub fn run_qemu(arch: UefiArch, opt: &QemuOpt) -> Result<()> {
     cmd.arg("-device");
     cmd.arg("nvme,drive=nvmedisk0,serial=uefi-rsNvmePassThru");
 
+    // Fifth (ATA) disk
+    let ata_test_disk = tmp_dir.join("test_disk4.empty.img");
+    create_mbr_test_disk(&ata_test_disk)?;
+    cmd.arg("-drive");
+    let mut drive_arg = OsString::from("if=none,format=raw,id=satadisk0,file=");
+    drive_arg.push(ata_test_disk.clone());
+    cmd.arg(drive_arg);
+    cmd.arg("-device");
+    cmd.arg("ide-hd,drive=satadisk0,bus=ide.2,serial=AtaPassThru,model=AtaPassThru");
+
     let qemu_monitor_pipe = Pipe::new(tmp_dir, "qemu-monitor")?;
     let serial_pipe = Pipe::new(tmp_dir, "serial")?;