smartie.nvme.structures module

This file contains the various low-level structure definitions used for sending and receiving NVME commands, as well as the structures required for platform-specific APIs.

smartie.nvme.structures.IOCTL_NVME_ADMIN_CMD = 3225964097

IOCTL for NVMe Admin commands on Linux.

class smartie.nvme.structures.NVMEAdminCommand

Bases: Structure

addr

Structure/Union member

cdw10

Structure/Union member

cdw11

Structure/Union member

cdw12

Structure/Union member

cdw13

Structure/Union member

cdw14

Structure/Union member

cdw15

Structure/Union member

cdw2

Structure/Union member

cdw3

Structure/Union member

data_len

Structure/Union member

flags

Structure/Union member

metadata

Structure/Union member

metadata_len

Structure/Union member

nsid

Structure/Union member

opcode

Structure/Union member

reserved_1

Structure/Union member

result

Structure/Union member

timeout_ms

Structure/Union member

class smartie.nvme.structures.NVMEAdminCommands(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

GET_LOG_PAGE = 2

IDENTIFY = 6

class smartie.nvme.structures.NVMEIdentifyResponse

Bases: Structure

firmware_revision

Structure/Union member

model_number

Structure/Union member

serial_number

Structure/Union member

ssvid

Structure/Union member

unknown

Structure/Union member

vendor_id

Structure/Union member

class smartie.nvme.structures.SMARTCriticalWarning

Bases: Structure

available_spare

Structure/Union member

degraded_nvm

Structure/Union member

read_only

Structure/Union member

reserved_1

Structure/Union member

temperature

Structure/Union member

volatile_memory_backup

Structure/Union member

class smartie.nvme.structures.SMARTPageResponse

Bases: Structure

This structure represents the response from the SMART Log Page (0x02).

Note

Defined in the NVMe 1.4 specification as figure 194.

available_spare

Structure/Union member

available_spare_threshold

Structure/Union member

controller_busy_time

Structure/Union member

critical_temp_time

Structure/Union member

critical_warning

Structure/Union member

data_units_read

Structure/Union member

data_units_written

Structure/Union member

endurance_group_critical_warning_summary

Structure/Union member

host_read_commands

Structure/Union member

host_write_commands

Structure/Union member

media_errors

Structure/Union member

num_err_log_entries

Structure/Union member

percent_used

Structure/Union member

power_cycles

Structure/Union member

power_on_hours

Structure/Union member

reserved_1

Structure/Union member

reserved_2

Structure/Union member

temperature

Structure/Union member

temperature_sensors

Structure/Union member

thermal_transition_counts

Structure/Union member

total_time_for_thermal_management

Structure/Union member

unsafe_shutdowns

Structure/Union member

warning_temp_time

Structure/Union member