nvme: mi: dev: Implement Admin / Get Log Page / SMART Health Information Log Page

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

Author: amboar

src/lib.rs

@@ -8,7 +8,10 @@ use deku::{DekuContainerWrite, DekuError};
 use flagset::FlagSet;
 use hmac::Mac;
 use mctp::AsyncRespChannel;
-use nvme::mi::ResponseStatus;
+use nvme::{
+    AdminGetLogPageLidRequestType, LidSupportedAndEffectsFlags, LogPageAttributes,
+    mi::ResponseStatus,
+};
 use uuid::Uuid;
 
 pub mod nvme;
@@ -240,14 +243,14 @@ pub enum Temperature<T> {
 }
 
 #[derive(Debug)]
-struct OperatingRange {
+struct OperatingRange<T> {
     kind: UnitKind,
-    lower: u16,
-    upper: u16,
+    lower: T,
+    upper: T,
 }
 
-impl OperatingRange {
-    fn new(kind: UnitKind, lower: u16, upper: u16) -> Self {
+impl<T> OperatingRange<T> {
+    fn new(kind: UnitKind, lower: T, upper: T) -> Self {
         Self { kind, lower, upper }
     }
 }
@@ -268,15 +271,17 @@ pub struct Controller {
     secondaries: heapless::Vec<SecondaryController, 0>,
     active_ns: heapless::Vec<NamespaceId, MAX_NAMESPACES>,
     temp: u16,
-    temp_range: OperatingRange,
+    temp_range: OperatingRange<u16>,
     capacity: u64,
     spare: u64,
-    spare_range: OperatingRange,
+    spare_range: OperatingRange<u64>,
     write_age: u64,
     write_lifespan: u64,
     ro: bool,
     cc: nvme::ControllerConfiguration,
     csts: FlagSet<nvme::ControllerStatusFlags>,
+    lpa: FlagSet<LogPageAttributes>,
+    lsaes: [FlagSet<LidSupportedAndEffectsFlags>; 3],
 }
 
 impl Controller {
@@ -296,6 +301,15 @@ impl Controller {
             ro: false,
             cc: nvme::ControllerConfiguration::default(),
             csts: FlagSet::empty(),
+            lpa: FlagSet::empty(),
+            lsaes: {
+                let mut arr = [FlagSet::default(); 3];
+                arr[AdminGetLogPageLidRequestType::SupportedLogPages.id() as usize] =
+                    LidSupportedAndEffectsFlags::Lsupp.into();
+                arr[AdminGetLogPageLidRequestType::SmartHealthInformation.id() as usize] =
+                    LidSupportedAndEffectsFlags::Lsupp.into();
+                arr
+            },
         }
     }
 

src/nvme.rs

@@ -106,6 +106,7 @@ unsafe impl Discriminant<u8> for AdminIoCqeStatusType {}
 #[repr(u8)]
 enum AdminIoCqeGenericCommandStatus {
     SuccessfulCompletion = 0x00,
+    InvalidFieldInCommand = 0x02,
 }
 unsafe impl Discriminant<u8> for AdminIoCqeGenericCommandStatus {}
 
@@ -152,6 +153,95 @@ pub struct AdminIdentifyNvmIdentifyNamespaceResponse {
 }
 impl Encode<4096> for AdminIdentifyNvmIdentifyNamespaceResponse {}
 
+// Base v2.1, 5.1.12, Figure 202
+// MI v2.0, 6.3, Figure 141
+#[derive(Debug, DekuRead, DekuWrite, Eq, PartialEq)]
+#[deku(ctx = "endian: Endian, lid: u8", id = "lid", endian = "endian")]
+#[repr(u8)]
+pub enum AdminGetLogPageLidRequestType {
+    SupportedLogPages = 0x00,
+    ErrorInformation = 0x01,
+    SmartHealthInformation = 0x02,
+    FeatureIdentifiersSupportedAndEffects = 0x12,
+}
+unsafe impl Discriminant<u8> for AdminGetLogPageLidRequestType {}
+
+// Base v2.1, 5.1.12.1.1, Figure 203
+#[derive(Debug, DekuRead, DekuWrite)]
+#[deku(endian = "little")]
+pub struct AdminGetLogPageSupportedLogPagesResponse {
+    lsids: WireVec<LidSupportedAndEffectsDataStructure, 256>,
+}
+impl Encode<1024> for AdminGetLogPageSupportedLogPagesResponse {}
+
+// Base v2.1, 5.1.12.1.1, Figure 204
+flags! {
+    pub enum LidSupportedAndEffectsFlags: u8 {
+        Lsupp,
+        Ios,
+    }
+}
+
+// Base v2.1, 5.1.12.1.1, Figure 204
+#[derive(Clone, Copy, Debug, DekuRead, DekuWrite)]
+#[deku(ctx = "endian: Endian", endian = "endian")]
+pub struct LidSupportedAndEffectsDataStructure {
+    flags: WireFlagSet<LidSupportedAndEffectsFlags>,
+    #[deku(seek_from_current = "1")]
+    lidsp: u16,
+}
+
+// Base v2.1, 5.1.12.1.3, Figure 206, CW
+flags! {
+    pub enum CriticalWarning: u8 {
+        Ascbt,
+        Ttc,
+        Ndr,
+        Amro,
+        Vmbf,
+        Pmrro,
+    }
+}
+
+// Base v2.1, 5.1.12.1.3, Figure 206, EGCWS
+flags! {
+    pub enum EnduranceGroupCriticalWarningSummary: u8 {
+        Egascbt = 1 << 0,
+        Egdr = 1 << 2,
+        Egro = 1 << 3,
+    }
+}
+
+// Base v2.1, 5.1.12.1.3, Figure 206
+#[derive(Debug, Default, DekuRead, DekuWrite)]
+#[deku(endian = "little")]
+pub struct SmartHealthInformationLogPageResponse {
+    cw: WireFlagSet<CriticalWarning>,
+    ctemp: u16,
+    avsp: u8,
+    avspt: u8,
+    pused: u8,
+    egcws: WireFlagSet<EnduranceGroupCriticalWarningSummary>,
+    #[deku(seek_from_current = "25")]
+    dur: u128,
+    duw: u128,
+    hrc: u128,
+    hwc: u128,
+    cbt: u128,
+    pwrc: u128,
+    poh: u128,
+    upl: u128,
+    mdie: u128,
+    neile: u128,
+    wctt: u32,
+    cctt: u32,
+    tsen: [u16; 8],
+    tmttc: [u32; 2],
+    #[deku(pad_bytes_after = "280")]
+    tttmt: [u32; 2],
+}
+impl Encode<512> for SmartHealthInformationLogPageResponse {}
+
 // Base v2.1, 5.1.13.1, Figure 311
 #[derive(Clone, Copy, Debug, DekuRead, DekuWrite)]
 #[deku(id_type = "u8", endian = "endian", ctx = "endian: Endian")]

src/nvme/mi.rs

@@ -5,7 +5,7 @@ use log::debug;
 
 use crate::{CommandEffectError, Discriminant, Encode};
 
-use super::AdminIdentifyCnsRequestType;
+use super::{AdminGetLogPageLidRequestType, AdminIdentifyCnsRequestType};
 
 // SPDX-License-Identifier: GPL-3.0-only
 /*
@@ -591,7 +591,8 @@ impl Encode<32> for ControllerInformationResponse {}
 enum AdminCommandRequestType {
     DeleteIoSubmissionQueue = 0x00, // P
     CreateIoSubmissionQueue = 0x01, // P
-    GetLogPage = 0x02,              // M
+    #[deku(id = 0x02)]
+    GetLogPage(AdminGetLogPageRequest), // M
     DeleteIoCompletionQueue = 0x04, // P
     CreateIoCompletionQueue = 0x05, // P
     #[deku(id = 0x06)]
@@ -634,6 +635,31 @@ struct AdminCommandRequestHeader {
     op: AdminCommandRequestType,
 }
 
+// MI v2.0, 6, Figure 136
+// Base v2.1, 5.1.12, Figures 197-201
+#[derive(Debug, DekuRead, DekuWrite, Eq, PartialEq)]
+#[deku(ctx = "endian: Endian", endian = "endian")]
+struct AdminGetLogPageRequest {
+    nsid: u32,
+    #[deku(seek_from_current = "16")]
+    dofst: u32,
+    dlen: u32,
+    #[deku(seek_from_current = "8")]
+    #[deku(update = "self.req.id()")]
+    lid: u8,
+    lsp_rae: u8,
+    numdw: u32, // Synthesised from NUMDL / NUMDU
+    lsi: u16,
+    lpo: u64, // Synthesised from LPOL / LPOU
+    uidx: u8,
+    #[deku(seek_from_current = "1")]
+    ot: u8,
+    csi: u8,
+    #[deku(pad_bytes_after = "4")]
+    #[deku(ctx = "*lid")]
+    req: AdminGetLogPageLidRequestType,
+}
+
 // MI v2.0, 6, Figure 136
 // Base v2.1, 5.1.13.1, Figures 306-309
 #[derive(Debug, DekuRead, DekuWrite, Eq, PartialEq)]