From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 21:41:32 +0200 Subject: Adding upstream version 2.8. Signed-off-by: Daniel Baumann --- Documentation/nvme-mi-cmd-support-effects-log.txt | 49 +++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 Documentation/nvme-mi-cmd-support-effects-log.txt (limited to 'Documentation/nvme-mi-cmd-support-effects-log.txt') diff --git a/Documentation/nvme-mi-cmd-support-effects-log.txt b/Documentation/nvme-mi-cmd-support-effects-log.txt new file mode 100644 index 0000000..2221804 --- /dev/null +++ b/Documentation/nvme-mi-cmd-support-effects-log.txt @@ -0,0 +1,49 @@ +nvme-mi-cmd-support-effects-log(1) +================================== + +NAME +---- +nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log, +returns results and structure + +SYNOPSIS +-------- +[verse] +'nvme-mi-cmd-support-effects-log' [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] + +DESCRIPTION +----------- +For the NVMe device given, sends an MI Command Support and Effects log (id 13h) +and provides the result and returned log structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout. + +OPTIONS +------- +-H:: +--human-readable:: + This option will parse and format many of the bit fields + into human-readable formats. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + +EXAMPLES +-------- +nvme mi-cmd-support-effects-log /dev/nvme0 -H + +NVME +---- +Part of the nvme-user suite -- cgit v1.2.3