nvme-cli/Documentation/nvme-sndk-set-latency-monitor-feature.1

'\" t
.\"     Title: nvme-sndk-set-latency-monitor-feature
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 05/20/2025
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-SNDK\-SET\-LAT" "1" "05/20/2025" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-sndk-set-latency-monitor-feature \- Set NVMe sndk latency monitor feature options
.SH "SYNOPSIS"
.sp
.nf
\fInvme sndk set\-latency\-monitor\-feature\fR <device>
                        [\-\-active_bucket_timer_threshold=<NUM> | \-t <NUM>]
                        [\-\-active_threshold_a=<NUM> | \-a <NUM>]
                        [\-\-active_threshold_b=<NUM> | \-b <NUM>]
                        [\-\-active_threshold_c=<NUM> | \-c <NUM>]
                        [\-\-active_threshold_d=<NUM> | \-d <NUM>]
                        [\-\-active_latency_config=<NUM> | \-f <NUM>]
                        [\-\-active_latency_minimum_window=<NUM> | \-w <NUM>]
                        [\-\-debug_log_trigger_enable=<NUM> | \-r <NUM>]
                        [\-\-discard_debug_log=<NUM> | \-l <NUM>]
                        [\-\-latency_monitor_feature_enable=<NUM> | \-e <NUM>]
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, this command set the latency monitor feature options (if supported by the device)\&.
.sp
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
.sp
Setting results can be checked with \fIget\-latency\-monitor\-log\fR command\&.
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
\-t <NUM>, \-\-active_bucket_timer_threshold=<NUM>
.RS 4
The value that loads the Active Bucket Timer Threshold; default value is 07E0h\&.
.RE
.PP
\-a <NUM>, \-\-active_threshold_a=<NUM>
.RS 4
The value that loads into the Active Threshold A; default value is 05h\&.
.RE
.PP
\-b <NUM>, \-\-active_threshold_b=<NUM>
.RS 4
The value that loads into the Active Threshold B; default value is 13h\&.
.RE
.PP
\-c <NUM>, \-\-active_threshold_c=<NUM>
.RS 4
The value that loads into the Active Threshold C; default value is 1Eh\&.
.RE
.PP
\-d <NUM>, \-\-active_threshold_d=<NUM>
.RS 4
The value that loads into the Active Threshold D; default value is 2Eh\&.
.RE
.PP
\-f <NUM>, \-\-active_latency_config=<NUM>
.RS 4
The value that loads into the Active Latency Configuration\&. This configures how both the Active Latency Stamp, and the Active Measured Latency Fields are updated on a per I/O command (Read, Write, Deallocate) counter basis; default value is 0FFFh\&.
.RE
.PP
\-w <NUM>, \-\-active_latency_minimum_window=<NUM>
.RS 4
The value that loads into the Active Latency Minimum Window; default value is 0Ah\&.
.RE
.PP
\-r <NUM>, \-\-debug_log_trigger_enable=<NUM>
.RS 4
The value that loads into the Debug Log Trigger Enable; When set to 1b the first time the bucket/counter combination is incremented a debug log is triggered\&. When cleared to 0b a debug log will not be triggered when the bucket/counter combination is incremented\&.
.RE
.PP
\-l <NUM>, \-\-discard_debug_log=<NUM>
.RS 4
Discard Debug Log\&. When cleared to 00h the debug log, if it exists, will not be cleared\&. When set to 01h the debug log will be discarded so another log can be triggered\&. All the fields in the Set Features Data structure are valid\&. When set to 02h the debug log will be discarded so another log can be triggered\&. None of the other fields of the Set Features Data structure are valid\&.
.RE
.PP
\-e <NUM>, \-\-latency_monitor_feature_enable=<NUM>
.RS 4
Latency Monitor Feature Enable; When set to 01h the Latency Monitor Feature is enabled\&. When cleared to 00h the Latency Monitor Feature is disabled\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Set NVMe sndk latency monitor feature options enabled with default value values:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme sndk set\-latency\-monitor\-feature /dev/nvme0 \-e 1
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Set NVMe sndk latency monitor feature options disabled with default value values:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme sndk set\-latency\-monitor\-feature /dev/nvme0 \-e 0
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Set NVMe sndk latency monitor feature options enabled with specific values:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme sndk set\-latency\-monitor\-feature /dev/nvme0 \-\-active_bucket_timer_threshold=1 \e
            \-\-active_threshold_a=0x0 \e
            \-\-active_threshold_b=0x1 \e
            \-\-active_threshold_c=0x2 \e
            \-\-active_threshold_d=0x3 \e
            \-\-active_latency_config=0xfff \e
            \-\-active_latency_minimum_window=0 \e
            \-\-debug_log_trigger_enable=0 \e
            \-\-discard_debug_log=0 \e
            \-\-latency_monitor_feature_enable=0x1
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite\&.