Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Documentation/cmd-plugins.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ linknvme:nvme-micron-smart-add-log[1]::
linknvme:nvme-micron-temperature-stats[1]::
Retrieves temperature information of given micron device

linknvme:nvme-micron-smart-log[1]::
Retrieve SMART/Health log with Micron vendor-specific fields

linknvme:nvme-micron-id-ctrl[1]::
Send NVMe Identify Controller with Micron vendor-specific fields

linknvme:nvme-ocp-internal-log[1]::
Retrieves and parses OCP Telemetry DA1 and DA2 logs.

Expand Down
2 changes: 2 additions & 0 deletions Documentation/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,13 @@ adoc_sources = [
'nvme-lockdown',
'nvme-mi-cmd-support-effects-log',
'nvme-micron-clear-pcie-errors',
'nvme-micron-id-ctrl',
'nvme-micron-internal-log',
'nvme-micron-nand-stats',
'nvme-micron-pcie-stats',
'nvme-micron-selective-download',
'nvme-micron-smart-add-log',
'nvme-micron-smart-log',
'nvme-micron-temperature-stats',
'nvme-netapp-ontapdevices',
'nvme-netapp-smdevices',
Expand Down
59 changes: 59 additions & 0 deletions Documentation/nvme-micron-id-ctrl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
nvme-micron-id-ctrl(1)
======================

NAME
----
nvme-micron-id-ctrl - Send NVMe Identify Controller with Micron vendor-specific fields

SYNOPSIS
--------
[verse]
'nvme micron id-ctrl' <device> [--output-format=<fmt> | -o <fmt>]

DESCRIPTION
-----------
For the NVMe device given, sends an identify controller command and
provides the result with Micron vendor-specific fields decoded.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

This command extends the standard Identify Controller output with
Micron-specific fields:

PMS (Power Measurement Support)::
Bit 21 of CTRATT (Controller Attributes).
Indicates whether the controller supports power measurement.

IPMSR (Interval Power Measurement Sample Rate)::
Located at bytes 392-393 in the Identify Controller reserved area.
Specifies the sample rate for interval power measurement.

MSMT (Maximum Stop Measurement Time)::
Located at bytes 394-395 in the Identify Controller reserved area.
Specifies the maximum time to stop power measurement.

OPTIONS
-------
-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'.
Default is 'normal'.

EXAMPLES
--------
* Display Identify Controller in human-readable format:
+
------------
# nvme micron id-ctrl /dev/nvme0
------------

* Display Identify Controller in JSON format:
+
------------
# nvme micron id-ctrl /dev/nvme0 -o json
------------

NVME
----
Part of the nvme-user suite
54 changes: 54 additions & 0 deletions Documentation/nvme-micron-smart-log.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
nvme-micron-smart-log(1)
========================

NAME
----
nvme-micron-smart-log - Retrieve SMART/Health log with Micron vendor-specific fields

SYNOPSIS
--------
[verse]
'nvme micron smart-log' <device> [--output-format=<fmt> | -o <fmt>]

DESCRIPTION
-----------
For the NVMe device given, retrieves the SMART/Health Information log page
and displays it with Micron vendor-specific fields decoded.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

This command extends the standard SMART log with Micron-specific fields:

OLEC (Operational Lifetime Energy Consumed)::
Located at bytes 232-239 in the SMART log reserved area.
Reports cumulative energy consumed by the device.

IPM (Interval Power Measurement)::
Located at bytes 240-243 in the SMART log reserved area.
Reports power measurement over sampling interval.

OPTIONS
-------
-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'.
Default is 'normal'.

EXAMPLES
--------
* Display SMART log in human-readable format:
+
------------
# nvme micron smart-log /dev/nvme0
------------

* Display SMART log in JSON format:
+
------------
# nvme micron smart-log /dev/nvme0 -o json
------------

NVME
----
Part of the nvme-user suite
2 changes: 2 additions & 0 deletions completions/_nvme
Original file line number Diff line number Diff line change
Expand Up @@ -2972,6 +2972,8 @@ _nvme () {
clear-fw-activate-history':Clear FW activation history'
vs-smbus-option':Enable/Disable SMBUS on the drive'
ocp-telemetry-log-parse':Parse OCP Telemetry DA1 and DA2 logs'
smart-log':Retrieve SMART/Health log with Micron vendor-specific fields'
id-ctrl':Identify Controller with Micron vendor-specific fields'
help':Display this help'
)
_arguments '*:: :->subcmds'
Expand Down
3 changes: 2 additions & 1 deletion completions/bash-nvme-completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -1713,7 +1713,8 @@
vs-drive-info plugin-version cloud-SSD-plugin-version \
log-page-directory vs-fw-activate-history \
vs-error-reason-identifier vs-smart-add-log \
clear-fw-activate-history vs-smbus-option ocp-telemetry-log-parse"
clear-fw-activate-history vs-smbus-option ocp-telemetry-log-parse \

Check failure on line 1716 in completions/bash-nvme-completion.sh

View workflow job for this annotation

GitHub Actions / checkpatch review

WARNING: line length of 91 exceeds 80 columns
smart-log id-ctrl"
[seagate]="vs-temperature-stats vs-log-page-sup \
vs-smart-add-log vs-pcie-stats clear-pcie-correctable-errors \
get-host-tele get-ctrl-tele vs-internal-log \
Expand Down
Loading