nvme: mi: Convert AdminFormatNvmConfiguration to deku bits

Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

Author: amboar

src/nvme.rs

@@ -154,50 +154,41 @@ struct ControllerListRequest {
 }
 
 // Base v2.1, 5.1.10, Figure 189, SES
-#[derive(Debug)]
+#[derive(Debug, DekuRead, DekuWrite, Eq, PartialEq)]
+#[deku(
+    bits = "bits.0",
+    ctx = "endian: Endian, bits: BitSize",
+    endian = "endian",
+    id_type = "u8"
+)]
 #[repr(u8)]
 enum SecureEraseSettings {
     NoOperation = 0b000,
     UserDataErase = 0b001,
     CryptographicErase = 0b010,
 }
-unsafe impl Discriminant<u8> for SecureEraseSettings {}
-
-impl TryFrom<u32> for SecureEraseSettings {
-    type Error = ();
-
-    fn try_from(value: u32) -> Result<Self, Self::Error> {
-        match value {
-            0b000 => Ok(Self::NoOperation),
-            0b001 => Ok(Self::UserDataErase),
-            0b010 => Ok(Self::CryptographicErase),
-            _ => Err(()),
-        }
-    }
-}
 
 // Base v2.1, 5.1.10, Figure 189
-#[derive(Debug)]
-#[expect(dead_code)]
+#[derive(Debug, DekuRead, DekuWrite, Eq, PartialEq)]
+#[deku(ctx = "endian: Endian", endian = "endian")]
 struct AdminFormatNvmConfiguration {
-    lbafi: u8,
-    mset: bool,
+    #[deku(bits = "3")]
     pi: u8,
-    pil: bool,
+    #[deku(bits = "1")]
+    mset: bool,
+    #[deku(bits = "4")]
+    lbafl: u8,
+    #[deku(bits = "2", pad_bits_before = "2")]
+    lbafu: u8,
+    #[deku(bits = "3")]
     ses: SecureEraseSettings,
+    #[deku(bits = "1", pad_bytes_after = "2")]
+    pil: bool,
 }
 
-impl TryFrom<u32> for AdminFormatNvmConfiguration {
-    type Error = ();
-
-    fn try_from(value: u32) -> Result<Self, Self::Error> {
-        Ok(Self {
-            lbafi: ((((value >> 12) & 0x3) << 4) | (value & 0xf)) as u8,
-            mset: ((value >> 4) & 1) == 1,
-            pi: ((value >> 5) & 0x3) as u8,
-            pil: ((value >> 6) & 1) == 1,
-            ses: TryFrom::try_from((value >> 9) & 0x7)?,
-        })
+impl AdminFormatNvmConfiguration {
+    fn lbafi(&self) -> u8 {
+        self.lbafu << 4 | self.lbafl
     }
 }
 

src/nvme/mi.rs

@@ -9,7 +9,8 @@ use flagset::{FlagSet, flags};
 use log::debug;
 
 use crate::nvme::{
-    AdminNamespaceAttachmentSelect, AdminNamespaceManagementSelect, ControllerListRequest,
+    AdminFormatNvmConfiguration, AdminNamespaceAttachmentSelect, AdminNamespaceManagementSelect,
+    ControllerListRequest,
 };
 use crate::wire::{WireFlagSet, WireVec};
 use crate::{CommandEffectError, Discriminant, Encode, MAX_CONTROLLERS};
@@ -901,7 +902,7 @@ struct AdminFormatNvmRequest {
     dlen: u32,
     #[deku(seek_from_current = "8")]
     #[deku(pad_bytes_after = "20")]
-    config: u32,
+    config: AdminFormatNvmConfiguration,
 }
 
 // MI v2.0, 6, Figure 136

src/nvme/mi/dev.rs

@@ -17,10 +17,9 @@ use crate::{
     CommandEffect, CommandEffectError, Controller, ControllerError, ControllerType, Discriminant,
     MAX_CONTROLLERS, MAX_NAMESPACES, NamespaceId, NamespaceIdDisposition, SubsystemError,
     nvme::{
-        AdminFormatNvmConfiguration, AdminGetLogPageLidRequestType,
-        AdminGetLogPageSupportedLogPagesResponse, AdminIdentifyActiveNamespaceIdListResponse,
-        AdminIdentifyAllocatedNamespaceIdListResponse, AdminIdentifyCnsRequestType,
-        AdminIdentifyControllerResponse,
+        AdminGetLogPageLidRequestType, AdminGetLogPageSupportedLogPagesResponse,
+        AdminIdentifyActiveNamespaceIdListResponse, AdminIdentifyAllocatedNamespaceIdListResponse,
+        AdminIdentifyCnsRequestType, AdminIdentifyControllerResponse,
         AdminIdentifyNamespaceIdentificationDescriptorListResponse,
         AdminIdentifyNvmIdentifyNamespaceResponse, AdminIoCqeGenericCommandStatus,
         AdminIoCqeStatusType, AdminSanitizeConfiguration, ControllerListResponse,
@@ -2016,19 +2015,8 @@ impl RequestHandler for AdminFormatNvmRequest {
             .await;
         };
 
-        let Ok(config) = TryInto::<AdminFormatNvmConfiguration>::try_into(self.config) else {
-            debug!("Invalid configuration for Admin Format NVM");
-            return admin_send_status(
-                resp,
-                AdminIoCqeStatusType::GenericCommandStatus(
-                    AdminIoCqeGenericCommandStatus::InvalidFieldInCommand,
-                ),
-            )
-            .await;
-        };
-
-        if config.lbafi != 0 {
-            debug!("Unsupported LBA format index: {}", config.lbafi);
+        if self.config.lbafi() != 0 {
+            debug!("Unsupported LBA format index: {}", self.config.lbafi());
             return admin_send_status(
                 resp,
                 AdminIoCqeStatusType::GenericCommandStatus(

tests/admin.rs

@@ -4990,7 +4990,8 @@ mod format_nvm {
             0x7a, 0x05, 0xbd, 0xb8
         ];
 
-        let resp = ExpectedRespChannel::new(&RESP_ADMIN_STATUS_INVALID_FIELD);
+        // FIXME: Poor error response code for the problem at hand
+        let resp = ExpectedRespChannel::new(&RESP_INVALID_COMMAND_SIZE);
         smol::block_on(async {
             mep.handle_async(&mut subsys, &REQ, MsgIC(true), resp, async |_| Ok(()))
                 .await