Struct IdentifyController 

pub struct IdentifyController { /* private fields */ }

Decoded Identify Controller (CNS 01h) data structure.

Owns the 4096-byte buffer returned by libnvme; accessors decode individual fields on demand. Field naming uses the NVMe spec abbreviations where they are widely known (e.g. vendor_id, not vid).

Implementations

impl IdentifyController

pub fn vendor_id(&self) -> u16

PCI vendor ID (VID).

Examples found in repository

examples/id_ctrl.rs (line 25)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn subsystem_vendor_id(&self) -> u16

PCI subsystem vendor ID (SSVID).

Examples found in repository

examples/id_ctrl.rs (line 26)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn serial_number(&self) -> Result<&str>

20-byte ASCII serial number, trimmed.

Examples found in repository

examples/id_ctrl.rs (line 28)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn model_number(&self) -> Result<&str>

40-byte ASCII model number, trimmed.

Examples found in repository

examples/id_ctrl.rs (line 27)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn firmware_revision(&self) -> Result<&str>

8-byte ASCII firmware revision, trimmed.

Examples found in repository

examples/id_ctrl.rs (line 29)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn ieee_oui(&self) -> [u8; 3]

IEEE OUI (3-byte company identifier), in little-endian byte order.

pub fn max_data_transfer_size_exp(&self) -> u8

Maximum data transfer size, as an exponent of the controller’s minimum memory-page size. 0 means no limit.

pub fn controller_id(&self) -> u16

16-bit controller identifier.

Examples found in repository

examples/id_ctrl.rs (line 31)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn nvme_version(&self) -> NvmeVersion

NVMe specification version supported by the controller.

Examples found in repository

examples/id_ctrl.rs (line 30)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn controller_type(&self) -> u8

Controller type: 1 = I/O, 2 = Discovery, 3 = Administrative.

Examples found in repository

examples/id_ctrl.rs (line 32)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn fru_guid(&self) -> [u8; 16]

16-byte FRU Globally Unique Identifier.

pub fn optional_admin_command_support(&self) -> u16

Optional Admin Command Support bitfield (OACS).

pub fn abort_command_limit(&self) -> u8

Abort command limit (ACL).

pub fn async_event_request_limit(&self) -> u8

Async event request limit (AERL).

pub fn firmware_updates(&self) -> u8

Firmware updates bitfield (FRMW).

pub fn log_page_attributes(&self) -> u8

Log Page Attributes bitfield (LPA).

pub fn error_log_page_entries(&self) -> u8

Number of supported error log page entries (ELPE).

pub fn num_power_states(&self) -> u8

Number of power states supported, zero-based (NPSS).

pub fn warning_temp_threshold_kelvin(&self) -> u16

Warning composite temperature threshold in Kelvin (WCTEMP).

Examples found in repository

examples/id_ctrl.rs (line 40)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn critical_temp_threshold_kelvin(&self) -> u16

Critical composite temperature threshold in Kelvin (CCTEMP).

Examples found in repository

examples/id_ctrl.rs (line 44)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn host_memory_buffer_preferred_size(&self) -> u32

Host Memory Buffer preferred size in 4 KiB units (HMPRE).

pub fn host_memory_buffer_min_size(&self) -> u32

Host Memory Buffer minimum size in 4 KiB units (HMMIN).

pub fn total_nvm_capacity_bytes(&self) -> u128

Total NVM Capacity in bytes (TNVMCAP), as a 128-bit little-endian integer.

Examples found in repository

examples/id_ctrl.rs (line 36)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

pub fn unallocated_nvm_capacity_bytes(&self) -> u128

Unallocated NVM Capacity in bytes (UNVMCAP).

pub fn submission_queue_entry_size(&self) -> u8

Submission Queue Entry Size encoding (SQES).

Bits 0–3: required size; bits 4–7: maximum size. The actual byte size is 2 ^ value.

pub fn completion_queue_entry_size(&self) -> u8

Completion Queue Entry Size encoding (CQES).

pub fn max_commands_outstanding(&self) -> u16

Maximum outstanding commands (MAXCMD). 0 means no limit reported.

pub fn num_namespaces(&self) -> u32

Number of namespaces supported (NN).

Examples found in repository

examples/id_ctrl.rs (line 33)

fn print_controller(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let id = ctrl.identify()?;
    println!("  vendor id          : 0x{:04x}", id.vendor_id());
    println!("  subsystem vendor   : 0x{:04x}", id.subsystem_vendor_id());
    println!("  model              : {}", id.model_number()?);
    println!("  serial             : {}", id.serial_number()?);
    println!("  firmware           : {}", id.firmware_revision()?);
    println!("  nvme spec          : {}", id.nvme_version());
    println!("  controller id      : {}", id.controller_id());
    println!("  controller type    : {}", id.controller_type());
    println!("  num namespaces     : {}", id.num_namespaces());
    println!(
        "  total nvm capacity : {} bytes",
        id.total_nvm_capacity_bytes()
    );
    println!(
        "  warn temp threshold: {} K",
        id.warning_temp_threshold_kelvin()
    );
    println!(
        "  crit temp threshold: {} K",
        id.critical_temp_threshold_kelvin()
    );
    println!();
    Ok(())
}

Trait Implementations

impl Debug for IdentifyController

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.