uefi: Implement safe bindings for EFI_ATA_PASS_THRU_PROTOCOL

Author: seijikun

Diff for: uefi-raw/src/protocol/ata.rs

@@ -31,7 +31,7 @@ bitflags::bitflags! {
     }
 }
 
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 #[repr(C)]
 pub struct AtaPassThruMode {
     pub attributes: AtaPassThruAttributes,
@@ -76,37 +76,37 @@ newtype_enum! {
 #[repr(C)]
 pub struct AtaStatusBlock {
     pub reserved1: [u8; 2],
-    pub ata_status: u8,
-    pub ata_error: u8,
-    pub ata_sector_number: u8,
-    pub ata_cylinder_low: u8,
-    pub ata_cylinder_high: u8,
-    pub ata_device_head: u8,
-    pub ata_sector_number_exp: u8,
-    pub ata_cylinder_low_exp: u8,
-    pub ata_cylinder_high_exp: u8,
+    pub status: u8,
+    pub error: u8,
+    pub sector_number: u8,
+    pub cylinder_low: u8,
+    pub cylinder_high: u8,
+    pub device_head: u8,
+    pub sector_number_exp: u8,
+    pub cylinder_low_exp: u8,
+    pub cylinder_high_exp: u8,
     pub reserved2: u8,
-    pub ata_sector_count: u8,
-    pub ata_sector_count_exp: u8,
+    pub sector_count: u8,
+    pub sector_count_exp: u8,
     pub reserved3: [u8; 6],
 }
 
-#[derive(Debug)]
+#[derive(Debug, Default)]
 #[repr(C)]
 pub struct AtaCommandBlock {
     pub reserved1: [u8; 2],
-    pub ata_command: u8,
-    pub ata_features: u8,
-    pub ata_sector_number: u8,
-    pub ata_cylinder_low: u8,
-    pub ata_cylinder_high: u8,
-    pub ata_device_head: u8,
-    pub ata_sector_number_exp: u8,
-    pub ata_cylinder_low_exp: u8,
-    pub ata_cylinder_high_exp: u8,
-    pub ata_features_exp: u8,
-    pub ata_sector_count: u8,
-    pub ata_sector_count_exp: u8,
+    pub command: u8,
+    pub features: u8,
+    pub sector_number: u8,
+    pub cylinder_low: u8,
+    pub cylinder_high: u8,
+    pub device_head: u8,
+    pub sector_number_exp: u8,
+    pub cylinder_low_exp: u8,
+    pub cylinder_high_exp: u8,
+    pub features_exp: u8,
+    pub sector_count: u8,
+    pub sector_count_exp: u8,
     pub reserved2: [u8; 6],
 }
 
@@ -118,6 +118,8 @@ pub struct AtaPassThruCommandPacket {
     pub timeout: u64,
     pub in_data_buffer: *mut c_void,
     pub out_data_buffer: *const c_void,
+    pub in_transfer_length: u32,
+    pub out_transfer_length: u32,
     pub protocol: AtaPassThruCommandProtocol,
     pub length: AtaPassThruLength,
 }
@@ -131,7 +133,7 @@ pub struct AtaPassThruProtocol {
         port: u16,
         port_multiplier_port: u16,
         packet: *mut AtaPassThruCommandPacket,
-        event: *mut Event,
+        event: Event,
     ) -> Status,
     pub get_next_port: unsafe extern "efiapi" fn(this: *const Self, port: *mut u16) -> Status,
     pub get_next_device: unsafe extern "efiapi" fn(
@@ -143,7 +145,7 @@ pub struct AtaPassThruProtocol {
         this: *const Self,
         port: u16,
         port_multiplier_port: u16,
-        device_path: *mut *mut DevicePathProtocol,
+        device_path: *mut *const DevicePathProtocol,
     ) -> Status,
     pub get_device: unsafe extern "efiapi" fn(
         this: *const Self,

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();
+                // what the...
+                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,11 @@ 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");
+
+    #[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

@@ -13,6 +13,10 @@ pub fn test() {
     test_protocols_per_handle();
     test_test_protocol();
 
+    // 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();
     debug::test();
     device_path::test();
     driver::test();
@@ -62,6 +66,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: uefi/CHANGELOG.md

@@ -8,6 +8,7 @@
 - Added `mem::AlignedBuffer`.
 - Added `proto::device_path::DevicePath::append_path()`.
 - Added `proto::device_path::DevicePath::append_node()`.
+- Added `proto::ata::pass_thru::AtaPassThru`.
 
 ## Changed
 - **Breaking:** Removed `BootPolicyError` as `BootPolicy` construction is no