diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:53:09 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:53:09 +0000 |
| commit | 3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch) | |
| tree | 7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc | |
| parent | Initial commit. (diff) | |
| download | libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.tar.xz libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.zip | |
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc')
653 files changed, 23380 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..422386a --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,73 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'libnvme' +copyright = '2020, Keith Busch' +author = 'Keith Busch <kbusch@kernel.org>' +master_doc = 'libnvme' + +# The full version, including alpha/beta/rc tags +release = '0.1' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['html', 'man', 'index.rst', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +#html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['sphinx-static'] +html_context = { + 'css_files': [ + '_static/theme_overrides.css', + ], +} + +html_use_smartypants = False +pygments_style = 'sphinx' + +htmlhelp_basename = 'libnvme' + +try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +except ImportError: + sys.stderr.write('Warning: The Sphinx \'sphinx_rtd_theme\' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.\n') diff --git a/doc/config-schema.json b/doc/config-schema.json new file mode 100644 index 0000000..a7bbdf1 --- /dev/null +++ b/doc/config-schema.json @@ -0,0 +1,164 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/linux-nvme/libnvme/doc/config-schema.json", + "title": "config.json", + "description": "libnvme JSON configuration", + "type": "object", + "properties": { + "hosts": { + "description": "Array of NVMe Host properties", + "type": "array", + "items": { "$ref": "#/$defs/host" } + } + }, + "$defs": { + "host": { + "description": "NVMe Host properties", + "type": "object", + "properties": { + "hostnqn": { + "description": "NVMe host NQN", + "type": "string", + "maxLength": 223 + }, + "hostid": { + "description": "NVMe host ID", + "type": "string" + }, + "hostsymname": { + "description": "NVMe host symbolic name", + "type": "string" + }, + "required": [ "hostnqn" ], + "subsystems": { + "description": "Array of NVMe subsystem properties", + "type": "array", + "items": { "$ref": "#/$defs/subsystem" } + } + } + }, + "subsystem": { + "description": "NVMe subsystem properties", + "type": "object", + "properties": { + "nqn": { + "description": "Subsystem NQN", + "type": "string", + "maxLength": 223 + }, + "ports": { + "description": "Array of NVMe subsystem ports", + "type": "array", + "items": { "$ref": "#/$defs/port" } + }, + "required": [ "nqn" ] + } + }, + "port": { + "description": "NVMe subsystem port", + "type": "object", + "properties": { + "transport": { + "description": "Transport type", + "type": "string" + }, + "traddr": { + "description": "Transport address", + "type": "string" + }, + "host_traddr": { + "description": "Host transport address", + "type": "string" + }, + "host_iface": { + "description": "Host interface name", + "type": "string" + }, + "trsvcid": { + "description": "Transport service identifier", + "type": "string" + }, + "dhchap_key": { + "description": "Host DH-HMAC-CHAP key", + "type": "string" + }, + "dhchap_ctrl_key": { + "description": "Controller DH-HMAC-CHAP key", + "type": "string" + }, + "nr_io_queues": { + "description": "Number of I/O queues", + "type": "integer" + }, + "nr_write_queues": { + "description": "Number of write queues", + "type": "integer" + }, + "nr_poll_queues": { + "description": "Number of poll queues", + "type": "integer" + }, + "queue_size": { + "description": "Queue size", + "type": "integer" + }, + "keep_alive_tmo": { + "description": "Keep-Alive timeout (in seconds)", + "type": "integer" + }, + "reconnect_delay": { + "description": "Reconnect delay (in seconds)", + "type": "integer" + }, + "ctrl_loss_tmo": { + "description": "Controller loss timeout (in seconds)", + "type": "integer" + }, + "fast_io_fail_tmo": { + "description": "Fast I/O Fail timeout (in seconds)", + "type": "integer", + "default": 600 + }, + "tos": { + "description": "Type of service", + "type": "integer", + "default": -1 + }, + "duplicate_connect": { + "description": "Allow duplicate connections", + "type": "boolean", + "default": false + }, + "disable_sqflow": { + "description": "Explicitly disable SQ flow control", + "type": "boolean", + "default": false + }, + "hdr_digest": { + "description": "Enable header digest", + "type": "boolean", + "default": false + }, + "data_digest": { + "description": "Enable data digest", + "type": "boolean", + "default": false + }, + "tls": { + "description": "Enable TLS encryption", + "type": "boolean", + "default": false + }, + "persistent": { + "description": "Create persistent discovery connection", + "type": "boolean" + }, + "discovery": { + "description": "Connect to a discovery controller", + "type": "boolean" + } + }, + "required": [ "transport" ] + } + } +} diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..639b3d5 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,21 @@ +.. libnvme documentation master file, created by + sphinx-quickstart on Thu Feb 6 17:59:42 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to libnvme's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + libnvme + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/kernel-doc b/doc/kernel-doc new file mode 100755 index 0000000..4900c3a --- /dev/null +++ b/doc/kernel-doc @@ -0,0 +1,2523 @@ +#!/usr/bin/env perl +# SPDX-License-Identifier: GPL-2.0 + +use warnings; +use strict; + +## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## +## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## +## Copyright (C) 2001 Simon Huggins ## +## Copyright (C) 2005-2012 Randy Dunlap ## +## Copyright (C) 2012 Dan Luedtke ## +## ## +## #define enhancements by Armin Kuster <akuster@mvista.com> ## +## Copyright (c) 2000 MontaVista Software, Inc. ## +## ## +## This software falls under the GNU General Public License. ## +## Please read the COPYING file for more information ## + +# 18/01/2001 - Cleanups +# Functions prototyped as foo(void) same as foo() +# Stop eval'ing where we don't need to. +# -- huggie@earth.li + +# 27/06/2001 - Allowed whitespace after initial "/**" and +# allowed comments before function declarations. +# -- Christian Kreibich <ck@whoop.org> + +# Still to do: +# - add perldoc documentation +# - Look more closely at some of the scarier bits :) + +# 26/05/2001 - Support for separate source and object trees. +# Return error code. +# Keith Owens <kaos@ocs.com.au> + +# 23/09/2001 - Added support for typedefs, structs, enums and unions +# Support for Context section; can be terminated using empty line +# Small fixes (like spaces vs. \s in regex) +# -- Tim Jansen <tim@tjansen.de> + +# 25/07/2012 - Added support for HTML5 +# -- Dan Luedtke <mail@danrl.de> + +sub usage { + my $message = <<"EOF"; +Usage: $0 [OPTION ...] FILE ... + +Read C language source or header FILEs, extract embedded documentation comments, +and print formatted documentation to standard output. + +The documentation comments are identified by "/**" opening comment mark. See +Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. + +Output format selection (mutually exclusive): + -man Output troff manual page format. This is the default. + -rst Output reStructuredText format. + -none Do not output documentation, only warnings. + +Output format selection modifier (affects only ReST output): + + -sphinx-version Use the ReST C domain dialect compatible with an + specific Sphinx Version. + If not specified, kernel-doc will auto-detect using + the sphinx-build version found on PATH. + +Output selection (mutually exclusive): + -export Only output documentation for symbols that have been + exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() + in any input FILE or -export-file FILE. + -internal Only output documentation for symbols that have NOT been + exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() + in any input FILE or -export-file FILE. + -function NAME Only output documentation for the given function(s) + or DOC: section title(s). All other functions and DOC: + sections are ignored. May be specified multiple times. + -nosymbol NAME Exclude the specified symbols from the output + documentation. May be specified multiple times. + +Output selection modifiers: + -no-doc-sections Do not output DOC: sections. + -enable-lineno Enable output of #define LINENO lines. Only works with + reStructuredText format. + -export-file FILE Specify an additional FILE in which to look for + EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with + -export or -internal. May be specified multiple times. + +Other parameters: + -v Verbose output, more warnings and other information. + -h Print this help. + -Werror Treat warnings as errors. + +EOF + print $message; + exit 1; +} + +# +# format of comments. +# In the following table, (...)? signifies optional structure. +# (...)* signifies 0 or more structure elements +# /** +# * function_name(:)? (- short description)? +# (* @parameterx: (description of parameter x)?)* +# (* a blank line)? +# * (Description:)? (Description of function)? +# * (section header: (section description)? )* +# (*)?*/ +# +# So .. the trivial example would be: +# +# /** +# * my_function +# */ +# +# If the Description: header tag is omitted, then there must be a blank line +# after the last parameter specification. +# e.g. +# /** +# * my_function - does my stuff +# * @my_arg: its mine damnit +# * +# * Does my stuff explained. +# */ +# +# or, could also use: +# /** +# * my_function - does my stuff +# * @my_arg: its mine damnit +# * Description: Does my stuff explained. +# */ +# etc. +# +# Besides functions you can also write documentation for structs, unions, +# enums and typedefs. Instead of the function name you must write the name +# of the declaration; the struct/union/enum/typedef must always precede +# the name. Nesting of declarations is not supported. +# Use the argument mechanism to document members or constants. +# e.g. +# /** +# * struct my_struct - short description +# * @a: first member +# * @b: second member +# * +# * Longer description +# */ +# struct my_struct { +# int a; +# int b; +# /* private: */ +# int c; +# }; +# +# All descriptions can be multiline, except the short function description. +# +# For really longs structs, you can also describe arguments inside the +# body of the struct. +# eg. +# /** +# * struct my_struct - short description +# * @a: first member +# * @b: second member +# * +# * Longer description +# */ +# struct my_struct { +# int a; +# int b; +# /** +# * @c: This is longer description of C +# * +# * You can use paragraphs to describe arguments +# * using this method. +# */ +# int c; +# }; +# +# This should be use only for struct/enum members. +# +# You can also add additional sections. When documenting kernel functions you +# should document the "Context:" of the function, e.g. whether the functions +# can be called form interrupts. Unlike other sections you can end it with an +# empty line. +# A non-void function should have a "Return:" section describing the return +# value(s). +# Example-sections should contain the string EXAMPLE so that they are marked +# appropriately in DocBook. +# +# Example: +# /** +# * user_function - function that can only be called in user context +# * @a: some argument +# * Context: !in_interrupt() +# * +# * Some description +# * Example: +# * user_function(22); +# */ +# ... +# +# +# All descriptive text is further processed, scanning for the following special +# patterns, which are highlighted appropriately. +# +# 'funcname()' - function +# '$ENVVAR' - environmental variable +# '&struct_name' - name of a structure (up to two words including 'struct') +# '&struct_name.member' - name of a structure member +# '@parameter' - name of a parameter +# '%CONST' - name of a constant. +# '``LITERAL``' - literal string without any spaces on it. + +## init lots of data + +my $errors = 0; +my $warnings = 0; +my $anon_struct_union = 0; + +# match expressions used to find embedded type information +my $type_constant = '\b``([^\`]+)``\b'; +my $type_constant2 = '\%([-_\w]+)'; +my $type_func = '(\w+)\(\)'; +my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; +my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; +my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params +my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params +my $type_env = '(\$\w+)'; +my $type_enum = '\&(enum\s*([_\w]+))'; +my $type_struct = '\&(struct\s*([_\w]+))'; +my $type_typedef = '\&(typedef\s*([_\w]+))'; +my $type_union = '\&(union\s*([_\w]+))'; +my $type_member = '\&([_\w]+)(\.|->)([_\w]+)'; +my $type_fallback = '\&([_\w]+)'; +my $type_member_func = $type_member . '\(\)'; + +# Output conversion substitutions. +# One for each output format + +# these are pretty rough +my @highlights_man = ( + [$type_constant, "\$1"], + [$type_constant2, "\$1"], + [$type_func, "\\\\fB\$1\\\\fP"], + [$type_enum, "\\\\fI\$1\\\\fP"], + [$type_struct, "\\\\fI\$1\\\\fP"], + [$type_typedef, "\\\\fI\$1\\\\fP"], + [$type_union, "\\\\fI\$1\\\\fP"], + [$type_param, "\\\\fI\$1\\\\fP"], + [$type_param_ref, "\\\\fI\$1\$2\\\\fP"], + [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], + [$type_fallback, "\\\\fI\$1\\\\fP"] + ); +my $blankline_man = ""; + +# rst-mode +my @highlights_rst = ( + [$type_constant, "``\$1``"], + [$type_constant2, "``\$1``"], + # Note: need to escape () to avoid func matching later + [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"], + [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], + [$type_fp_param, "**\$1\\\\(\\\\)**"], + [$type_fp_param2, "**\$1\\\\(\\\\)**"], + [$type_func, "\$1()"], + [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], + [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], + [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], + [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], + # in rst this can refer to any type + [$type_fallback, "\\:c\\:type\\:`\$1`"], + [$type_param_ref, "**\$1\$2**"] + ); +my $blankline_rst = "\n"; + +# read arguments +if ($#ARGV == -1) { + usage(); +} + +my $kernelversion; +my ($sphinx_major, $sphinx_minor, $sphinx_patch); + +my $dohighlight = ""; + +my $verbose = 0; +my $Werror = 0; +my $output_mode = "rst"; +my $output_preformatted = 0; +my $no_doc_sections = 0; +my $enable_lineno = 0; +my @highlights = @highlights_rst; +my $blankline = $blankline_rst; +my $modulename = "Kernel API"; + +use constant { + OUTPUT_ALL => 0, # output all symbols and doc sections + OUTPUT_INCLUDE => 1, # output only specified symbols + OUTPUT_EXPORTED => 2, # output exported symbols + OUTPUT_INTERNAL => 3, # output non-exported symbols +}; +my $output_selection = OUTPUT_ALL; +my $show_not_found = 0; # No longer used + +my @export_file_list; + +my @build_time; +if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && + (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') { + @build_time = gmtime($seconds); +} else { + @build_time = localtime; +} + +my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', + 'July', 'August', 'September', 'October', + 'November', 'December')[$build_time[4]] . + " " . ($build_time[5]+1900); + +# Essentially these are globals. +# They probably want to be tidied up, made more localised or something. +# CAVEAT EMPTOR! Some of the others I localised may not want to be, which +# could cause "use of undefined value" or other bugs. +my ($function, %function_table, %parametertypes, $declaration_purpose); +my %nosymbol_table = (); +my $declaration_start_line; +my ($type, $declaration_name, $return_type); +my ($newsection, $newcontents, $prototype, $brcount, %source_map); + +if (defined($ENV{'KBUILD_VERBOSE'})) { + $verbose = "$ENV{'KBUILD_VERBOSE'}"; +} + +if (defined($ENV{'KCFLAGS'})) { + my $kcflags = "$ENV{'KCFLAGS'}"; + + if ($kcflags =~ /Werror/) { + $Werror = 1; + } +} + +if (defined($ENV{'KDOC_WERROR'})) { + $Werror = "$ENV{'KDOC_WERROR'}"; +} + +# Generated docbook code is inserted in a template at a point where +# docbook v3.1 requires a non-zero sequence of RefEntry's; see: +# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html +# We keep track of number of generated entries and generate a dummy +# if needs be to ensure the expanded template can be postprocessed +# into html. +my $section_counter = 0; + +my $lineprefix=""; + +# Parser states +use constant { + STATE_NORMAL => 0, # normal code + STATE_NAME => 1, # looking for function name + STATE_BODY_MAYBE => 2, # body - or maybe more description + STATE_BODY => 3, # the body of the comment + STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line + STATE_PROTO => 5, # scanning prototype + STATE_DOCBLOCK => 6, # documentation block + STATE_INLINE => 7, # gathering doc outside main block +}; +my $state; +my $in_doc_sect; +my $leading_space; + +# Inline documentation state +use constant { + STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE) + STATE_INLINE_NAME => 1, # looking for member name (@foo:) + STATE_INLINE_TEXT => 2, # looking for member documentation + STATE_INLINE_END => 3, # done + STATE_INLINE_ERROR => 4, # error - Comment without header was found. + # Spit a warning as it's not + # proper kernel-doc and ignore the rest. +}; +my $inline_doc_state; + +#declaration types: can be +# 'function', 'struct', 'union', 'enum', 'typedef' +my $decl_type; + +# Name of the kernel-doc identifier for non-DOC markups +my $identifier; + +my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. +my $doc_end = '\*/'; +my $doc_com = '\s*\*\s*'; +my $doc_com_body = '\s*\* ?'; +my $doc_decl = $doc_com . '(\w+)'; +# @params and a strictly limited set of supported section names +# Specifically: +# Match @word: +# @...: +# @{section-name}: +# while trying to not match literal block starts like "example::" +# +my $doc_sect = $doc_com . + '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$'; +my $doc_content = $doc_com_body . '(.*)'; +my $doc_block = $doc_com . 'DOC:\s*(.*)?'; +my $doc_inline_start = '^\s*/\*\*\s*$'; +my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; +my $doc_inline_end = '^\s*\*/\s*$'; +my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; +my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; +my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)}; +my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i; + +my %parameterdescs; +my %parameterdesc_start_lines; +my @parameterlist; +my %sections; +my @sectionlist; +my %section_start_lines; +my $sectcheck; +my $struct_actual; + +my $contents = ""; +my $new_start_line = 0; + +# the canonical section names. see also $doc_sect above. +my $section_default = "Description"; # default section +my $section_intro = "Introduction"; +my $section = $section_default; +my $section_context = "Context"; +my $section_return = "Return"; + +my $undescribed = "-- undescribed --"; + +reset_state(); + +while ($ARGV[0] =~ m/^--?(.*)/) { + my $cmd = $1; + shift @ARGV; + if ($cmd eq "man") { + $output_mode = "man"; + @highlights = @highlights_man; + $blankline = $blankline_man; + } elsif ($cmd eq "rst") { + $output_mode = "rst"; + @highlights = @highlights_rst; + $blankline = $blankline_rst; + } elsif ($cmd eq "none") { + $output_mode = "none"; + } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document + $modulename = shift @ARGV; + } elsif ($cmd eq "function") { # to only output specific functions + $output_selection = OUTPUT_INCLUDE; + $function = shift @ARGV; + $function_table{$function} = 1; + } elsif ($cmd eq "nosymbol") { # Exclude specific symbols + my $symbol = shift @ARGV; + $nosymbol_table{$symbol} = 1; + } elsif ($cmd eq "export") { # only exported symbols + $output_selection = OUTPUT_EXPORTED; + %function_table = (); + } elsif ($cmd eq "internal") { # only non-exported symbols + $output_selection = OUTPUT_INTERNAL; + %function_table = (); + } elsif ($cmd eq "export-file") { + my $file = shift @ARGV; + push(@export_file_list, $file); + } elsif ($cmd eq "v") { + $verbose = 1; + } elsif ($cmd eq "Werror") { + $Werror = 1; + } elsif (($cmd eq "h") || ($cmd eq "help")) { + usage(); + } elsif ($cmd eq 'no-doc-sections') { + $no_doc_sections = 1; + } elsif ($cmd eq 'enable-lineno') { + $enable_lineno = 1; + } elsif ($cmd eq 'show-not-found') { + $show_not_found = 1; # A no-op but don't fail + } elsif ($cmd eq "sphinx-version") { + my $ver_string = shift @ARGV; + if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) { + $sphinx_major = $1; + if (defined($2)) { + $sphinx_minor = substr($2,1); + } else { + $sphinx_minor = 0; + } + if (defined($3)) { + $sphinx_patch = substr($3,1) + } else { + $sphinx_patch = 0; + } + } else { + die "Sphinx version should either major.minor or major.minor.patch format\n"; + } + } else { + # Unknown argument + usage(); + } +} + +# continue execution near EOF; + +# The C domain dialect changed on Sphinx 3. So, we need to check the +# version in order to produce the right tags. +sub findprog($) +{ + foreach(split(/:/, $ENV{PATH})) { + return "$_/$_[0]" if(-x "$_/$_[0]"); + } +} + +sub get_sphinx_version() +{ + my $ver; + + my $cmd = "sphinx-build"; + if (!findprog($cmd)) { + my $cmd = "sphinx-build3"; + if (!findprog($cmd)) { + $sphinx_major = 1; + $sphinx_minor = 2; + $sphinx_patch = 0; + printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n", + $sphinx_major, $sphinx_minor, $sphinx_patch; + return; + } + } + + open IN, "$cmd --version 2>&1 |"; + while (<IN>) { + if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) { + $sphinx_major = $1; + $sphinx_minor = $2; + $sphinx_patch = $3; + last; + } + # Sphinx 1.2.x uses a different format + if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) { + $sphinx_major = $1; + $sphinx_minor = $2; + $sphinx_patch = $3; + last; + } + } + close IN; +} + +# get kernel version from env +sub get_kernel_version() { + my $version = 'unknown kernel version'; + + if (defined($ENV{'KERNELVERSION'})) { + $version = $ENV{'KERNELVERSION'}; + } + return $version; +} + +# +sub print_lineno { + my $lineno = shift; + if ($enable_lineno && defined($lineno)) { + print "#define LINENO " . $lineno . "\n"; + } +} +## +# dumps section contents to arrays/hashes intended for that purpose. +# +sub dump_section { + my $file = shift; + my $name = shift; + my $contents = join "\n", @_; + + if ($name =~ m/$type_param/) { + $name = $1; + $parameterdescs{$name} = $contents; + $sectcheck = $sectcheck . $name . " "; + $parameterdesc_start_lines{$name} = $new_start_line; + $new_start_line = 0; + } elsif ($name eq "@\.\.\.") { + $name = "..."; + $parameterdescs{$name} = $contents; + $sectcheck = $sectcheck . $name . " "; + $parameterdesc_start_lines{$name} = $new_start_line; + $new_start_line = 0; + } else { + if (defined($sections{$name}) && ($sections{$name} ne "")) { + # Only warn on user specified duplicate section names. + if ($name ne $section_default) { + print STDERR "${file}:$.: warning: duplicate section name '$name'\n"; + ++$warnings; + } + $sections{$name} .= $contents; + } else { + $sections{$name} = $contents; + push @sectionlist, $name; + $section_start_lines{$name} = $new_start_line; + $new_start_line = 0; + } + } +} + +## +# dump DOC: section after checking that it should go out +# +sub dump_doc_section { + my $file = shift; + my $name = shift; + my $contents = join "\n", @_; + + if ($no_doc_sections) { + return; + } + + return if (defined($nosymbol_table{$name})); + + if (($output_selection == OUTPUT_ALL) || + (($output_selection == OUTPUT_INCLUDE) && + defined($function_table{$name}))) + { + dump_section($file, $name, $contents); + output_blockhead({'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'module' => $modulename, + 'content-only' => ($output_selection != OUTPUT_ALL), }); + } +} + +## +# output function +# +# parameterdescs, a hash. +# function => "function name" +# parameterlist => @list of parameters +# parameterdescs => %parameter descriptions +# sectionlist => @list of sections +# sections => %section descriptions +# + +sub output_highlight { + my $contents = join "\n",@_; + my $line; + +# DEBUG +# if (!defined $contents) { +# use Carp; +# confess "output_highlight got called with no args?\n"; +# } + +# print STDERR "contents b4:$contents\n"; + eval $dohighlight; + die $@ if $@; +# print STDERR "contents af:$contents\n"; + + foreach $line (split "\n", $contents) { + if (! $output_preformatted) { + $line =~ s/^\s*//; + } + if ($line eq ""){ + if (! $output_preformatted) { + print $lineprefix, $blankline; + } + } else { + if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { + print "\\&$line"; + } else { + print $lineprefix, $line; + } + } + print "\n"; + } +} + +## +# output function in man +sub output_function_man(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + my $count; + + print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"libnvme API manual\" LINUX\n"; + + print ".SH NAME\n"; + print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; + + print ".SH SYNOPSIS\n"; + if ($args{'functiontype'} ne "") { + print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; + } else { + print ".B \"" . $args{'function'} . "\n"; + } + $count = 0; + my $parenth = "("; + my $post = ","; + foreach my $parameter (@{$args{'parameterlist'}}) { + if ($count == $#{$args{'parameterlist'}}) { + $post = ");"; + } + $type = $args{'parametertypes'}{$parameter}; + if ($type =~ m/$function_pointer/) { + # pointer-to-function + print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n"; + } else { + $type =~ s/([^\*])$/$1 /; + print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n"; + } + $count++; + $parenth = ""; + } + + print ".SH ARGUMENTS\n"; + foreach $parameter (@{$args{'parameterlist'}}) { + my $parameter_name = $parameter; + $parameter_name =~ s/\[.*//; + + print ".IP \"" . $parameter . "\" 12\n"; + output_highlight($args{'parameterdescs'}{$parameter_name}); + } + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"", uc $section, "\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output enum in man +sub output_enum_man(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + my $count; + + print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n"; + + print ".SH NAME\n"; + print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; + + print ".SH SYNOPSIS\n"; + print "enum " . $args{'enum'} . " {\n"; + $count = 0; + foreach my $parameter (@{$args{'parameterlist'}}) { + print ".br\n.BI \" $parameter\"\n"; + if ($count == $#{$args{'parameterlist'}}) { + print "\n};\n"; + last; + } + else { + print ", \n.br\n"; + } + $count++; + } + + print ".SH Constants\n"; + foreach $parameter (@{$args{'parameterlist'}}) { + my $parameter_name = $parameter; + $parameter_name =~ s/\[.*//; + + print ".IP \"" . $parameter . "\" 12\n"; + output_highlight($args{'parameterdescs'}{$parameter_name}); + } + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output struct in man +sub output_struct_man(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + + print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; + + print ".SH NAME\n"; + print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; + + my $declaration = $args{'definition'}; + $declaration =~ s/\t/ /g; + $declaration =~ s/\n/"\n.br\n.BI \"/g; + print ".SH SYNOPSIS\n"; + print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; + print ".BI \"$declaration\n};\n.br\n\n"; + + print ".SH Members\n"; + foreach $parameter (@{$args{'parameterlist'}}) { + ($parameter =~ /^#/) && next; + + my $parameter_name = $parameter; + $parameter_name =~ s/\[.*//; + + ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; + print ".IP \"" . $parameter . "\" 12\n"; + output_highlight($args{'parameterdescs'}{$parameter_name}); + } + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output typedef in man +sub output_typedef_man(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + + print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n"; + + print ".SH NAME\n"; + print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; + + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +sub output_blockhead_man(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + my $count; + + print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n"; + + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output in restructured text +# + +# +# This could use some work; it's used to output the DOC: sections, and +# starts by putting out the name of the doc section itself, but that tends +# to duplicate a header already in the template file. +# +sub output_blockhead_rst(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + + foreach $section (@{$args{'sectionlist'}}) { + next if (defined($nosymbol_table{$section})); + + if ($output_selection != OUTPUT_INCLUDE) { + print ".. _$section:\n\n"; + print "**$section**\n\n"; + } + print_lineno($section_start_lines{$section}); + output_highlight_rst($args{'sections'}{$section}); + print "\n"; + } +} + +# +# Apply the RST highlights to a sub-block of text. +# +sub highlight_block($) { + # The dohighlight kludge requires the text be called $contents + my $contents = shift; + eval $dohighlight; + die $@ if $@; + return $contents; +} + +# +# Regexes used only here. +# +my $sphinx_literal = '^[^.].*::$'; +my $sphinx_cblock = '^\.\.\ +code-block::'; + +sub output_highlight_rst { + my $input = join "\n",@_; + my $output = ""; + my $line; + my $in_literal = 0; + my $litprefix; + my $block = ""; + + foreach $line (split "\n",$input) { + # + # If we're in a literal block, see if we should drop out + # of it. Otherwise pass the line straight through unmunged. + # + if ($in_literal) { + if (! ($line =~ /^\s*$/)) { + # + # If this is the first non-blank line in a literal + # block we need to figure out what the proper indent is. + # + if ($litprefix eq "") { + $line =~ /^(\s*)/; + $litprefix = '^' . $1; + $output .= $line . "\n"; + } elsif (! ($line =~ /$litprefix/)) { + $in_literal = 0; + } else { + $output .= $line . "\n"; + } + } else { + $output .= $line . "\n"; + } + } + # + # Not in a literal block (or just dropped out) + # + if (! $in_literal) { + $block .= $line . "\n"; + if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) { + $in_literal = 1; + $litprefix = ""; + $output .= highlight_block($block); + $block = "" + } + } + } + + if ($block) { + $output .= highlight_block($block); + } + foreach $line (split "\n", $output) { + print $lineprefix . $line . "\n"; + } +} + +sub output_function_rst(%) { + my %args = %{$_[0]}; + my ($parameter, $section); + my $oldprefix = $lineprefix; + my $start = ""; + my $is_macro = 0; + + if ($sphinx_major < 3) { + if ($args{'typedef'}) { + print ".. c:type:: ". $args{'function'} . "\n\n"; + print_lineno($declaration_start_line); + print " **Typedef**: "; + $lineprefix = ""; + output_highlight_rst($args{'purpose'}); + $start = "\n\n**Syntax**\n\n ``"; + $is_macro = 1; + } else { + print ".. c:function:: "; + } + } else { + if ($args{'typedef'} || $args{'functiontype'} eq "") { + $is_macro = 1; + print ".. c:macro:: ". $args{'function'} . "\n\n"; + } else { + print ".. c:function:: "; + } + + if ($args{'typedef'}) { + print_lineno($declaration_start_line); + print " **Typedef**: "; + $lineprefix = ""; + output_highlight_rst($args{'purpose'}); + $start = "\n\n**Syntax**\n\n ``"; + } else { + print "``" if ($is_macro); + } + } + if ($args{'functiontype'} ne "") { + $start .= $args{'functiontype'} . " " . $args{'function'} . " ("; + } else { + $start .= $args{'function'} . " ("; + } + print $start; + + my $count = 0; + foreach my $parameter (@{$args{'parameterlist'}}) { + if ($count ne 0) { + print ", "; + } + $count++; + $type = $args{'parametertypes'}{$parameter}; + + if ($type =~ m/$function_pointer/) { + # pointer-to-function + print $1 . $parameter . ") (" . $2 . ")"; + } else { + print $type; + } + } + if ($is_macro) { + print ")``\n\n"; + } else { + print ")\n\n"; + } + if (!$args{'typedef'}) { + print_lineno($declaration_start_line); + $lineprefix = " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + } + + print "**Parameters**\n\n"; + $lineprefix = " "; + foreach $parameter (@{$args{'parameterlist'}}) { + my $parameter_name = $parameter; + $parameter_name =~ s/\[.*//; + $type = $args{'parametertypes'}{$parameter}; + + if ($type ne "") { + print "``$type``\n"; + } else { + print "``$parameter``\n"; + } + + print_lineno($parameterdesc_start_lines{$parameter_name}); + + if (defined($args{'parameterdescs'}{$parameter_name}) && + $args{'parameterdescs'}{$parameter_name} ne $undescribed) { + output_highlight_rst($args{'parameterdescs'}{$parameter_name}); + } else { + print " *undescribed*\n"; + } + print "\n"; + } + + $lineprefix = $oldprefix; + output_section_rst(@_); +} + +sub output_section_rst(%) { + my %args = %{$_[0]}; + my $section; + my $oldprefix = $lineprefix; + $lineprefix = ""; + + foreach $section (@{$args{'sectionlist'}}) { + print "**$section**\n\n"; + print_lineno($section_start_lines{$section}); + output_highlight_rst($args{'sections'}{$section}); + print "\n"; + } + print "\n"; + $lineprefix = $oldprefix; +} + +sub output_enum_rst(%) { + my %args = %{$_[0]}; + my ($parameter); + my $oldprefix = $lineprefix; + my $count; + + if ($sphinx_major < 3) { + my $name = "enum " . $args{'enum'}; + print "\n\n.. c:type:: " . $name . "\n\n"; + } else { + my $name = $args{'enum'}; + print "\n\n.. c:enum:: " . $name . "\n\n"; + } + print_lineno($declaration_start_line); + $lineprefix = " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + + print "**Constants**\n\n"; + $lineprefix = " "; + foreach $parameter (@{$args{'parameterlist'}}) { + print "``$parameter``\n"; + if ($args{'parameterdescs'}{$parameter} ne $undescribed) { + output_highlight_rst($args{'parameterdescs'}{$parameter}); + } else { + print " *undescribed*\n"; + } + print "\n"; + } + + $lineprefix = $oldprefix; + output_section_rst(@_); +} + +sub output_typedef_rst(%) { + my %args = %{$_[0]}; + my ($parameter); + my $oldprefix = $lineprefix; + my $name; + + if ($sphinx_major < 3) { + $name = "typedef " . $args{'typedef'}; + } else { + $name = $args{'typedef'}; + } + print "\n\n.. c:type:: " . $name . "\n\n"; + print_lineno($declaration_start_line); + $lineprefix = " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + + $lineprefix = $oldprefix; + output_section_rst(@_); +} + +sub output_struct_rst(%) { + my %args = %{$_[0]}; + my ($parameter); + my $oldprefix = $lineprefix; + + if ($sphinx_major < 3) { + my $name = $args{'type'} . " " . $args{'struct'}; + print "\n\n.. c:type:: " . $name . "\n\n"; + } else { + my $name = $args{'struct'}; + if ($args{'type'} eq 'union') { + print "\n\n.. c:union:: " . $name . "\n\n"; + } else { + print "\n\n.. c:struct:: " . $name . "\n\n"; + } + } + print_lineno($declaration_start_line); + $lineprefix = " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + + print "**Definition**\n\n"; + print "::\n\n"; + my $declaration = $args{'definition'}; + $declaration =~ s/\t/ /g; + print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n"; + + print "**Members**\n\n"; + $lineprefix = " "; + foreach $parameter (@{$args{'parameterlist'}}) { + ($parameter =~ /^#/) && next; + + my $parameter_name = $parameter; + $parameter_name =~ s/\[.*//; + + ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; + $type = $args{'parametertypes'}{$parameter}; + print_lineno($parameterdesc_start_lines{$parameter_name}); + print "``" . $parameter . "``\n"; + output_highlight_rst($args{'parameterdescs'}{$parameter_name}); + print "\n"; + } + print "\n"; + + $lineprefix = $oldprefix; + output_section_rst(@_); +} + +## none mode output functions + +sub output_function_none(%) { +} + +sub output_enum_none(%) { +} + +sub output_typedef_none(%) { +} + +sub output_struct_none(%) { +} + +sub output_blockhead_none(%) { +} + +## +# generic output function for all types (function, struct/union, typedef, enum); +# calls the generated, variable output_ function name based on +# functype and output_mode +sub output_declaration { + no strict 'refs'; + my $name = shift; + my $functype = shift; + my $func = "output_${functype}_$output_mode"; + + return if (defined($nosymbol_table{$name})); + + if (($output_selection == OUTPUT_ALL) || + (($output_selection == OUTPUT_INCLUDE || + $output_selection == OUTPUT_EXPORTED) && + defined($function_table{$name})) || + ($output_selection == OUTPUT_INTERNAL && + !($functype eq "function" && defined($function_table{$name})))) + { + &$func(@_); + $section_counter++; + } +} + +## +# generic output function - calls the right one based on current output mode. +sub output_blockhead { + no strict 'refs'; + my $func = "output_blockhead_" . $output_mode; + &$func(@_); + $section_counter++; +} + +## +# takes a declaration (struct, union, enum, typedef) and +# invokes the right handler. NOT called for functions. +sub dump_declaration($$) { + no strict 'refs'; + my ($prototype, $file) = @_; + my $func = "dump_" . $decl_type; + &$func(@_); +} + +sub dump_union($$) { + dump_struct(@_); +} + +sub dump_struct($$) { + my $x = shift; + my $file = shift; + my $decl_type; + my $members; + my $type = qr{struct|union}; + # For capturing struct/union definition body, i.e. "{members*}qualifiers*" + my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned}; + my $definition_body = qr{\{(.*)\}\s*$qualifiers*}; + my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;}; + + if ($x =~ /($type)\s+(\w+)\s*$definition_body/) { + $decl_type = $1; + $declaration_name = $2; + $members = $3; + } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) { + $decl_type = $1; + $declaration_name = $3; + $members = $2; + } + + if ($members) { + if ($identifier ne $declaration_name) { + print STDERR "${file}:$.: warning: expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n"; + return; + } + + # ignore members marked private: + $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; + $members =~ s/\/\*\s*private:.*//gosi; + # strip comments: + $members =~ s/\/\*.*?\*\///gos; + # strip attributes + $members =~ s/\s*$attribute/ /gi; + $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos; + $members =~ s/\s*__packed\s*/ /gos; + $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; + $members =~ s/\s*____cacheline_aligned_in_smp/ /gos; + $members =~ s/\s*____cacheline_aligned/ /gos; + # unwrap struct_group(): + # - first eat non-declaration parameters and rewrite for final match + # - then remove macro, outer parens, and trailing semicolon + $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; + $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; + $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; + $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos; + + my $args = qr{([^,)]+)}; + # replace DECLARE_BITMAP + $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; + $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos; + $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; + # replace DECLARE_HASHTABLE + $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos; + # replace DECLARE_KFIFO + $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos; + # replace DECLARE_KFIFO_PTR + $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos; + # replace DECLARE_FLEX_ARRAY + $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos; + my $declaration = $members; + + # Split nested struct/union elements as newer ones + while ($members =~ m/$struct_members/) { + my $newmember; + my $maintype = $1; + my $ids = $4; + my $content = $3; + foreach my $id(split /,/, $ids) { + $newmember .= "$maintype $id; "; + + $id =~ s/[:\[].*//; + $id =~ s/^\s*\**(\S+)\s*/$1/; + foreach my $arg (split /;/, $content) { + next if ($arg =~ m/^\s*$/); + if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { + # pointer-to-function + my $type = $1; + my $name = $2; + my $extra = $3; + next if (!$name); + if ($id =~ m/^\s*$/) { + # anonymous struct/union + $newmember .= "$type$name$extra; "; + } else { + $newmember .= "$type$id.$name$extra; "; + } + } else { + my $type; + my $names; + $arg =~ s/^\s+//; + $arg =~ s/\s+$//; + # Handle bitmaps + $arg =~ s/:\s*\d+\s*//g; + # Handle arrays + $arg =~ s/\[.*\]//g; + # The type may have multiple words, + # and multiple IDs can be defined, like: + # const struct foo, *bar, foobar + # So, we remove spaces when parsing the + # names, in order to match just names + # and commas for the names + $arg =~ s/\s*,\s*/,/g; + if ($arg =~ m/(.*)\s+([\S+,]+)/) { + $type = $1; + $names = $2; + } else { + $newmember .= "$arg; "; + next; + } + foreach my $name (split /,/, $names) { + $name =~ s/^\s*\**(\S+)\s*/$1/; + next if (($name =~ m/^\s*$/)); + if ($id =~ m/^\s*$/) { + # anonymous struct/union + $newmember .= "$type $name; "; + } else { + $newmember .= "$type $id.$name; "; + } + } + } + } + } + $members =~ s/$struct_members/$newmember/; + } + + # Ignore other nested elements, like enums + $members =~ s/(\{[^\{\}]*\})//g; + + create_parameterlist($members, ';', $file, $declaration_name); + check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); + + # Adjust declaration for better display + $declaration =~ s/([\{;])/$1\n/g; + $declaration =~ s/\}\s+;/};/g; + # Better handle inlined enums + do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/); + + my @def_args = split /\n/, $declaration; + my $level = 1; + $declaration = ""; + foreach my $clause (@def_args) { + $clause =~ s/^\s+//; + $clause =~ s/\s+$//; + $clause =~ s/\s+/ /; + next if (!$clause); + $level-- if ($clause =~ m/(\})/ && $level > 1); + if (!($clause =~ m/^\s*#/)) { + $declaration .= "\t" x $level; + } + $declaration .= "\t" . $clause . "\n"; + $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); + } + output_declaration($declaration_name, + 'struct', + {'struct' => $declaration_name, + 'module' => $modulename, + 'definition' => $declaration, + 'parameterlist' => \@parameterlist, + 'parameterdescs' => \%parameterdescs, + 'parametertypes' => \%parametertypes, + 'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'purpose' => $declaration_purpose, + 'type' => $decl_type + }); + } + else { + print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; + ++$errors; + } +} + + +sub show_warnings($$) { + my $functype = shift; + my $name = shift; + + return 0 if (defined($nosymbol_table{$name})); + + return 1 if ($output_selection == OUTPUT_ALL); + + if ($output_selection == OUTPUT_EXPORTED) { + if (defined($function_table{$name})) { + return 1; + } else { + return 0; + } + } + if ($output_selection == OUTPUT_INTERNAL) { + if (!($functype eq "function" && defined($function_table{$name}))) { + return 1; + } else { + return 0; + } + } + if ($output_selection == OUTPUT_INCLUDE) { + if (defined($function_table{$name})) { + return 1; + } else { + return 0; + } + } + die("Please add the new output type at show_warnings()"); +} + +sub dump_enum($$) { + my $x = shift; + my $file = shift; + my $members; + + + $x =~ s@/\*.*?\*/@@gos; # strip comments. + # strip #define macros inside enums + $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; + + if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) { + $declaration_name = $2; + $members = $1; + } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) { + $declaration_name = $1; + $members = $2; + } + + if ($members) { + if ($identifier ne $declaration_name) { + if ($identifier eq "") { + print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n"; + } else { + print STDERR "${file}:$.: warning: expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n"; + } + return; + } + $declaration_name = "(anonymous)" if ($declaration_name eq ""); + + my %_members; + + $members =~ s/\s+$//; + + foreach my $arg (split ',', $members) { + $arg =~ s/^\s*(\w+).*/$1/; + push @parameterlist, $arg; + if (!$parameterdescs{$arg}) { + $parameterdescs{$arg} = $undescribed; + if (show_warnings("enum", $declaration_name)) { + print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n"; + } + } + $_members{$arg} = 1; + } + + while (my ($k, $v) = each %parameterdescs) { + if (!exists($_members{$k})) { + if (show_warnings("enum", $declaration_name)) { + print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n"; + } + } + } + + output_declaration($declaration_name, + 'enum', + {'enum' => $declaration_name, + 'module' => $modulename, + 'parameterlist' => \@parameterlist, + 'parameterdescs' => \%parameterdescs, + 'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'purpose' => $declaration_purpose + }); + } else { + print STDERR "${file}:$.: error: Cannot parse enum!\n"; + ++$errors; + } +} + +my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x; +my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x; +my $typedef_args = qr { \s*\((.*)\); }x; + +my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x; +my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x; + +sub dump_typedef($$) { + my $x = shift; + my $file = shift; + + $x =~ s@/\*.*?\*/@@gos; # strip comments. + + # Parse function typedef prototypes + if ($x =~ $typedef1 || $x =~ $typedef2) { + $return_type = $1; + $declaration_name = $2; + my $args = $3; + $return_type =~ s/^\s+//; + + if ($identifier ne $declaration_name) { + print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n"; + return; + } + + create_parameterlist($args, ',', $file, $declaration_name); + + output_declaration($declaration_name, + 'function', + {'function' => $declaration_name, + 'typedef' => 1, + 'module' => $modulename, + 'functiontype' => $return_type, + 'parameterlist' => \@parameterlist, + 'parameterdescs' => \%parameterdescs, + 'parametertypes' => \%parametertypes, + 'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'purpose' => $declaration_purpose + }); + return; + } + + while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { + $x =~ s/\(*.\)\s*;$/;/; + $x =~ s/\[*.\]\s*;$/;/; + } + + if ($x =~ /typedef.*\s+(\w+)\s*;/) { + $declaration_name = $1; + + if ($identifier ne $declaration_name) { + print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n"; + return; + } + + output_declaration($declaration_name, + 'typedef', + {'typedef' => $declaration_name, + 'module' => $modulename, + 'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'purpose' => $declaration_purpose + }); + } + else { + print STDERR "${file}:$.: error: Cannot parse typedef!\n"; + ++$errors; + } +} + +sub save_struct_actual($) { + my $actual = shift; + + # strip all spaces from the actual param so that it looks like one string item + $actual =~ s/\s*//g; + $struct_actual = $struct_actual . $actual . " "; +} + +sub create_parameterlist($$$$) { + my $args = shift; + my $splitter = shift; + my $file = shift; + my $declaration_name = shift; + my $type; + my $param; + + # temporarily replace commas inside function pointer definition + my $arg_expr = qr{\([^\),]+}; + while ($args =~ /$arg_expr,/) { + $args =~ s/($arg_expr),/$1#/g; + } + + foreach my $arg (split($splitter, $args)) { + # strip comments + $arg =~ s/\/\*.*\*\///; + # strip leading/trailing spaces + $arg =~ s/^\s*//; + $arg =~ s/\s*$//; + $arg =~ s/\s+/ /; + + if ($arg =~ /^#/) { + # Treat preprocessor directive as a typeless variable just to fill + # corresponding data structures "correctly". Catch it later in + # output_* subs. + push_parameter($arg, "", "", $file); + } elsif ($arg =~ m/\(.+\)\s*\(/) { + # pointer-to-function + $arg =~ tr/#/,/; + $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/; + $param = $1; + $type = $arg; + $type =~ s/([^\(]+\(\*?)\s*$param/$1/; + save_struct_actual($param); + push_parameter($param, $type, $arg, $file, $declaration_name); + } elsif ($arg) { + $arg =~ s/\s*:\s*/:/g; + $arg =~ s/\s*\[/\[/g; + + my @args = split('\s*,\s*', $arg); + if ($args[0] =~ m/\*/) { + $args[0] =~ s/(\*+)\s*/ $1/; + } + + my @first_arg; + if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { + shift @args; + push(@first_arg, split('\s+', $1)); + push(@first_arg, $2); + } else { + @first_arg = split('\s+', shift @args); + } + + unshift(@args, pop @first_arg); + $type = join " ", @first_arg; + + foreach $param (@args) { + if ($param =~ m/^(\*+)\s*(.*)/) { + save_struct_actual($2); + + push_parameter($2, "$type $1", $arg, $file, $declaration_name); + } + elsif ($param =~ m/(.*?):(\d+)/) { + if ($type ne "") { # skip unnamed bit-fields + save_struct_actual($1); + push_parameter($1, "$type:$2", $arg, $file, $declaration_name) + } + } + else { + save_struct_actual($param); + push_parameter($param, $type, $arg, $file, $declaration_name); + } + } + } + } +} + +sub push_parameter($$$$$) { + my $param = shift; + my $type = shift; + my $org_arg = shift; + my $file = shift; + my $declaration_name = shift; + + if (($anon_struct_union == 1) && ($type eq "") && + ($param eq "}")) { + return; # ignore the ending }; from anon. struct/union + } + + $anon_struct_union = 0; + $param =~ s/[\[\)].*//; + + if ($type eq "" && $param =~ /\.\.\.$/) + { + if (!$param =~ /\w\.\.\.$/) { + # handles unnamed variable parameters + $param = "..."; + } + elsif ($param =~ /\w\.\.\.$/) { + # for named variable parameters of the form `x...`, remove the dots + $param =~ s/\.\.\.$//; + } + if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { + $parameterdescs{$param} = "variable arguments"; + } + } + elsif ($type eq "" && ($param eq "" or $param eq "void")) + { + $param="void"; + $parameterdescs{void} = "no arguments"; + } + elsif ($type eq "" && ($param eq "struct" or $param eq "union")) + # handle unnamed (anonymous) union or struct: + { + $type = $param; + $param = "{unnamed_" . $param . "}"; + $parameterdescs{$param} = "anonymous\n"; + $anon_struct_union = 1; + } + + # warn if parameter has no description + # (but ignore ones starting with # as these are not parameters + # but inline preprocessor statements); + # Note: It will also ignore void params and unnamed structs/unions + if (!defined $parameterdescs{$param} && $param !~ /^#/) { + $parameterdescs{$param} = $undescribed; + + if (show_warnings($type, $declaration_name) && $param !~ /\./) { + print STDERR + "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; + ++$warnings; + } + } + + # strip spaces from $param so that it is one continuous string + # on @parameterlist; + # this fixes a problem where check_sections() cannot find + # a parameter like "addr[6 + 2]" because it actually appears + # as "addr[6", "+", "2]" on the parameter list; + # but it's better to maintain the param string unchanged for output, + # so just weaken the string compare in check_sections() to ignore + # "[blah" in a parameter string; + ###$param =~ s/\s*//g; + push @parameterlist, $param; + $org_arg =~ s/\s\s+/ /g; + $parametertypes{$param} = $org_arg; +} + +sub check_sections($$$$$) { + my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_; + my @sects = split ' ', $sectcheck; + my @prms = split ' ', $prmscheck; + my $err; + my ($px, $sx); + my $prm_clean; # strip trailing "[array size]" and/or beginning "*" + + foreach $sx (0 .. $#sects) { + $err = 1; + foreach $px (0 .. $#prms) { + $prm_clean = $prms[$px]; + $prm_clean =~ s/\[.*\]//; + $prm_clean =~ s/$attribute//i; + # ignore array size in a parameter string; + # however, the original param string may contain + # spaces, e.g.: addr[6 + 2] + # and this appears in @prms as "addr[6" since the + # parameter list is split at spaces; + # hence just ignore "[..." for the sections check; + $prm_clean =~ s/\[.*//; + + ##$prm_clean =~ s/^\**//; + if ($prm_clean eq $sects[$sx]) { + $err = 0; + last; + } + } + if ($err) { + if ($decl_type eq "function") { + print STDERR "${file}:$.: warning: " . + "Excess function parameter " . + "'$sects[$sx]' " . + "description in '$decl_name'\n"; + ++$warnings; + } + } + } +} + +## +# Checks the section describing the return value of a function. +sub check_return_section { + my $file = shift; + my $declaration_name = shift; + my $return_type = shift; + + # Ignore an empty return type (It's a macro) + # Ignore functions with a "void" return type. (But don't ignore "void *") + if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { + return; + } + + if (!defined($sections{$section_return}) || + $sections{$section_return} eq "") { + print STDERR "${file}:$.: warning: " . + "No description found for return value of " . + "'$declaration_name'\n"; + ++$warnings; + } +} + +## +# takes a function prototype and the name of the current file being +# processed and spits out all the details stored in the global +# arrays/hashes. +sub dump_function($$) { + my $prototype = shift; + my $file = shift; + my $noret = 0; + + print_lineno($new_start_line); + + $prototype =~ s/^static +//; + $prototype =~ s/^extern +//; + $prototype =~ s/^asmlinkage +//; + $prototype =~ s/^inline +//; + $prototype =~ s/^__inline__ +//; + $prototype =~ s/^__inline +//; + $prototype =~ s/^__always_inline +//; + $prototype =~ s/^noinline +//; + $prototype =~ s/__init +//; + $prototype =~ s/__init_or_module +//; + $prototype =~ s/__deprecated +//; + $prototype =~ s/__flatten +//; + $prototype =~ s/__meminit +//; + $prototype =~ s/__must_check +//; + $prototype =~ s/__weak +//; + $prototype =~ s/__sched +//; + $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; + $prototype =~ s/__alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//; + my $define = $prototype =~ s/^#\s*define\s+//; #ak added + $prototype =~ s/__attribute_const__ +//; + $prototype =~ s/__attribute__\s*\(\( + (?: + [\w\s]++ # attribute name + (?:\([^)]*+\))? # attribute arguments + \s*+,? # optional comma at the end + )+ + \)\)\s+//x; + + # Yes, this truly is vile. We are looking for: + # 1. Return type (may be nothing if we're looking at a macro) + # 2. Function name + # 3. Function parameters. + # + # All the while we have to watch out for function pointer parameters + # (which IIRC is what the two sections are for), C types (these + # regexps don't even start to express all the possibilities), and + # so on. + # + # If you mess with these regexps, it's a good idea to check that + # the following functions' documentation still comes out right: + # - parport_register_device (function pointer parameters) + # - atomic_set (macro) + # - pci_match_device, __copy_to_user (long return type) + my $name = qr{[a-zA-Z0-9_~:]+}; + my $prototype_end1 = qr{[^\(]*}; + my $prototype_end2 = qr{[^\{]*}; + my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)}; + my $type1 = qr{[\w\s]+}; + my $type2 = qr{$type1\*+}; + + if ($define && $prototype =~ m/^()($name)\s+/) { + # This is an object-like macro, it has no return type and no parameter + # list. + # Function-like macros are not allowed to have spaces between + # declaration_name and opening parenthesis (notice the \s+). + $return_type = $1; + $declaration_name = $2; + $noret = 1; + } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ || + $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ || + $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) { + $return_type = $1; + $declaration_name = $2; + my $args = $3; + + create_parameterlist($args, ',', $file, $declaration_name); + } else { + print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n"; + return; + } + + if ($identifier ne $declaration_name) { + print STDERR "${file}:$.: warning: expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n"; + return; + } + + my $prms = join " ", @parameterlist; + check_sections($file, $declaration_name, "function", $sectcheck, $prms); + + # This check emits a lot of warnings at the moment, because many + # functions don't have a 'Return' doc section. So until the number + # of warnings goes sufficiently down, the check is only performed in + # verbose mode. + # TODO: always perform the check. + if ($verbose && !$noret) { + check_return_section($file, $declaration_name, $return_type); + } + + # The function parser can be called with a typedef parameter. + # Handle it. + if ($return_type =~ /typedef/) { + output_declaration($declaration_name, + 'function', + {'function' => $declaration_name, + 'typedef' => 1, + 'module' => $modulename, + 'functiontype' => $return_type, + 'parameterlist' => \@parameterlist, + 'parameterdescs' => \%parameterdescs, + 'parametertypes' => \%parametertypes, + 'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'purpose' => $declaration_purpose + }); + } else { + output_declaration($declaration_name, + 'function', + {'function' => $declaration_name, + 'module' => $modulename, + 'functiontype' => $return_type, + 'parameterlist' => \@parameterlist, + 'parameterdescs' => \%parameterdescs, + 'parametertypes' => \%parametertypes, + 'sectionlist' => \@sectionlist, + 'sections' => \%sections, + 'purpose' => $declaration_purpose + }); + } +} + +sub reset_state { + $function = ""; + %parameterdescs = (); + %parametertypes = (); + @parameterlist = (); + %sections = (); + @sectionlist = (); + $sectcheck = ""; + $struct_actual = ""; + $prototype = ""; + + $state = STATE_NORMAL; + $inline_doc_state = STATE_INLINE_NA; +} + +sub tracepoint_munge($) { + my $file = shift; + my $tracepointname = 0; + my $tracepointargs = 0; + + if ($prototype =~ m/TRACE_EVENT\((.*?),/) { + $tracepointname = $1; + } + if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { + $tracepointname = $1; + } + if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { + $tracepointname = $2; + } + $tracepointname =~ s/^\s+//; #strip leading whitespace + if ($prototype =~ m/TP_PROTO\((.*?)\)/) { + $tracepointargs = $1; + } + if (($tracepointname eq 0) || ($tracepointargs eq 0)) { + print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n". + "$prototype\n"; + } else { + $prototype = "static inline void trace_$tracepointname($tracepointargs)"; + $identifier = "trace_$identifier"; + } +} + +sub syscall_munge() { + my $void = 0; + + $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's +## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { + if ($prototype =~ m/SYSCALL_DEFINE0/) { + $void = 1; +## $prototype = "long sys_$1(void)"; + } + + $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name + if ($prototype =~ m/long (sys_.*?),/) { + $prototype =~ s/,/\(/; + } elsif ($void) { + $prototype =~ s/\)/\(void\)/; + } + + # now delete all of the odd-number commas in $prototype + # so that arg types & arg names don't have a comma between them + my $count = 0; + my $len = length($prototype); + if ($void) { + $len = 0; # skip the for-loop + } + for (my $ix = 0; $ix < $len; $ix++) { + if (substr($prototype, $ix, 1) eq ',') { + $count++; + if ($count % 2 == 1) { + substr($prototype, $ix, 1) = ' '; + } + } + } +} + +sub process_proto_function($$) { + my $x = shift; + my $file = shift; + + $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line + + if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { + # do nothing + } + elsif ($x =~ /([^\{]*)/) { + $prototype .= $1; + } + + if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { + $prototype =~ s@/\*.*?\*/@@gos; # strip comments. + $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. + $prototype =~ s@^\s+@@gos; # strip leading spaces + + # Handle prototypes for function pointers like: + # int (*pcs_config)(struct foo) + $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; + + if ($prototype =~ /SYSCALL_DEFINE/) { + syscall_munge(); + } + if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || + $prototype =~ /DEFINE_SINGLE_EVENT/) + { + tracepoint_munge($file); + } + dump_function($prototype, $file); + reset_state(); + } +} + +sub process_proto_type($$) { + my $x = shift; + my $file = shift; + + $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. + $x =~ s@^\s+@@gos; # strip leading spaces + $x =~ s@\s+$@@gos; # strip trailing spaces + $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line + + if ($x =~ /^#/) { + # To distinguish preprocessor directive from regular declaration later. + $x .= ";"; + } + + while (1) { + if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) { + if( length $prototype ) { + $prototype .= " " + } + $prototype .= $1 . $2; + ($2 eq '{') && $brcount++; + ($2 eq '}') && $brcount--; + if (($2 eq ';') && ($brcount == 0)) { + dump_declaration($prototype, $file); + reset_state(); + last; + } + $x = $3; + } else { + $prototype .= $x; + last; + } + } +} + + +sub map_filename($) { + my $file; + my ($orig_file) = @_; + + if (defined($ENV{'SRCTREE'})) { + $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; + } else { + $file = $orig_file; + } + + if (defined($source_map{$file})) { + $file = $source_map{$file}; + } + + return $file; +} + +sub process_export_file($) { + my ($orig_file) = @_; + my $file = map_filename($orig_file); + + if (!open(IN,"<$file")) { + print STDERR "Error: Cannot open file $file\n"; + ++$errors; + return; + } + + while (<IN>) { + if (/$export_symbol/) { + next if (defined($nosymbol_table{$2})); + $function_table{$2} = 1; + } + } + + close(IN); +} + +# +# Parsers for the various processing states. +# +# STATE_NORMAL: looking for the /** to begin everything. +# +sub process_normal() { + if (/$doc_start/o) { + $state = STATE_NAME; # next line is always the function name + $in_doc_sect = 0; + $declaration_start_line = $. + 1; + } +} + +# +# STATE_NAME: Looking for the "name - description" line +# +sub process_name($$) { + my $file = shift; + my $descr; + + if (/$doc_block/o) { + $state = STATE_DOCBLOCK; + $contents = ""; + $new_start_line = $.; + + if ( $1 eq "" ) { + $section = $section_intro; + } else { + $section = $1; + } + } elsif (/$doc_decl/o) { + $identifier = $1; + my $is_kernel_comment = 0; + my $decl_start = qr{$doc_com}; + # test for pointer declaration type, foo * bar() - desc + my $fn_type = qr{\w+\s*\*\s*}; + my $parenthesis = qr{\(\w*\)}; + my $decl_end = qr{[-:].*}; + if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) { + $identifier = $1; + } + if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) { + $decl_type = $1; + $identifier = $2; + $is_kernel_comment = 1; + } + # Look for foo() or static void foo() - description; or misspelt + # identifier + elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ || + /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) { + $identifier = $1; + $decl_type = 'function'; + $identifier =~ s/^define\s+//; + $is_kernel_comment = 1; + } + $identifier =~ s/\s+$//; + + $state = STATE_BODY; + # if there's no @param blocks need to set up default section + # here + $contents = ""; + $section = $section_default; + $new_start_line = $. + 1; + if (/[-:](.*)/) { + # strip leading/trailing/multiple spaces + $descr= $1; + $descr =~ s/^\s*//; + $descr =~ s/\s*$//; + $descr =~ s/\s+/ /g; + $declaration_purpose = $descr; + $state = STATE_BODY_MAYBE; + } else { + $declaration_purpose = ""; + } + + if (!$is_kernel_comment) { + print STDERR "${file}:$.: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n"; + print STDERR $_; + ++$warnings; + $state = STATE_NORMAL; + } + + if (($declaration_purpose eq "") && $verbose) { + print STDERR "${file}:$.: warning: missing initial short description on line:\n"; + print STDERR $_; + ++$warnings; + } + + if ($identifier eq "" && $decl_type ne "enum") { + print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n"; + print STDERR $_; + ++$warnings; + $state = STATE_NORMAL; + } + + if ($verbose) { + print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n"; + } + } else { + print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", + " - I thought it was a doc line\n"; + ++$warnings; + $state = STATE_NORMAL; + } +} + + +# +# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. +# +sub process_body($$) { + my $file = shift; + + # Until all named variable macro parameters are + # documented using the bare name (`x`) rather than with + # dots (`x...`), strip the dots: + if ($section =~ /\w\.\.\.$/) { + $section =~ s/\.\.\.$//; + + if ($verbose) { + print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n"; + ++$warnings; + } + } + + if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { + dump_section($file, $section, $contents); + $section = $section_default; + $new_start_line = $.; + $contents = ""; + } + + if (/$doc_sect/i) { # case insensitive for supported section names + $newsection = $1; + $newcontents = $2; + + # map the supported section names to the canonical names + if ($newsection =~ m/^description$/i) { + $newsection = $section_default; + } elsif ($newsection =~ m/^context$/i) { + $newsection = $section_context; + } elsif ($newsection =~ m/^returns?$/i) { + $newsection = $section_return; + } elsif ($newsection =~ m/^\@return$/) { + # special: @return is a section, not a param description + $newsection = $section_return; + } + + if (($contents ne "") && ($contents ne "\n")) { + if (!$in_doc_sect && $verbose) { + print STDERR "${file}:$.: warning: contents before sections\n"; + ++$warnings; + } + dump_section($file, $section, $contents); + $section = $section_default; + } + + $in_doc_sect = 1; + $state = STATE_BODY; + $contents = $newcontents; + $new_start_line = $.; + while (substr($contents, 0, 1) eq " ") { + $contents = substr($contents, 1); + } + if ($contents ne "") { + $contents .= "\n"; + } + $section = $newsection; + $leading_space = undef; + } elsif (/$doc_end/) { + if (($contents ne "") && ($contents ne "\n")) { + dump_section($file, $section, $contents); + $section = $section_default; + $contents = ""; + } + # look for doc_com + <text> + doc_end: + if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { + print STDERR "${file}:$.: warning: suspicious ending line: $_"; + ++$warnings; + } + + $prototype = ""; + $state = STATE_PROTO; + $brcount = 0; + $new_start_line = $. + 1; + } elsif (/$doc_content/) { + if ($1 eq "") { + if ($section eq $section_context) { + dump_section($file, $section, $contents); + $section = $section_default; + $contents = ""; + $new_start_line = $.; + $state = STATE_BODY; + } else { + if ($section ne $section_default) { + $state = STATE_BODY_WITH_BLANK_LINE; + } else { + $state = STATE_BODY; + } + $contents .= "\n"; + } + } elsif ($state == STATE_BODY_MAYBE) { + # Continued declaration purpose + chomp($declaration_purpose); + $declaration_purpose .= " " . $1; + $declaration_purpose =~ s/\s+/ /g; + } else { + my $cont = $1; + if ($section =~ m/^@/ || $section eq $section_context) { + if (!defined $leading_space) { + if ($cont =~ m/^(\s+)/) { + $leading_space = $1; + } else { + $leading_space = ""; + } + } + $cont =~ s/^$leading_space//; + } + $contents .= $cont . "\n"; + } + } else { + # i dont know - bad line? ignore. + print STDERR "${file}:$.: warning: bad line: $_"; + ++$warnings; + } +} + + +# +# STATE_PROTO: reading a function/whatever prototype. +# +sub process_proto($$) { + my $file = shift; + + if (/$doc_inline_oneline/) { + $section = $1; + $contents = $2; + if ($contents ne "") { + $contents .= "\n"; + dump_section($file, $section, $contents); + $section = $section_default; + $contents = ""; + } + } elsif (/$doc_inline_start/) { + $state = STATE_INLINE; + $inline_doc_state = STATE_INLINE_NAME; + } elsif ($decl_type eq 'function') { + process_proto_function($_, $file); + } else { + process_proto_type($_, $file); + } +} + +# +# STATE_DOCBLOCK: within a DOC: block. +# +sub process_docblock($$) { + my $file = shift; + + if (/$doc_end/) { + dump_doc_section($file, $section, $contents); + $section = $section_default; + $contents = ""; + $function = ""; + %parameterdescs = (); + %parametertypes = (); + @parameterlist = (); + %sections = (); + @sectionlist = (); + $prototype = ""; + $state = STATE_NORMAL; + } elsif (/$doc_content/) { + if ( $1 eq "" ) { + $contents .= $blankline; + } else { + $contents .= $1 . "\n"; + } + } +} + +# +# STATE_INLINE: docbook comments within a prototype. +# +sub process_inline($$) { + my $file = shift; + + # First line (state 1) needs to be a @parameter + if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { + $section = $1; + $contents = $2; + $new_start_line = $.; + if ($contents ne "") { + while (substr($contents, 0, 1) eq " ") { + $contents = substr($contents, 1); + } + $contents .= "\n"; + } + $inline_doc_state = STATE_INLINE_TEXT; + # Documentation block end */ + } elsif (/$doc_inline_end/) { + if (($contents ne "") && ($contents ne "\n")) { + dump_section($file, $section, $contents); + $section = $section_default; + $contents = ""; + } + $state = STATE_PROTO; + $inline_doc_state = STATE_INLINE_NA; + # Regular text + } elsif (/$doc_content/) { + if ($inline_doc_state == STATE_INLINE_TEXT) { + $contents .= $1 . "\n"; + # nuke leading blank lines + if ($contents =~ /^\s*$/) { + $contents = ""; + } + } elsif ($inline_doc_state == STATE_INLINE_NAME) { + $inline_doc_state = STATE_INLINE_ERROR; + print STDERR "${file}:$.: warning: "; + print STDERR "Incorrect use of kernel-doc format: $_"; + ++$warnings; + } + } +} + + +sub process_file($) { + my $file; + my $initial_section_counter = $section_counter; + my ($orig_file) = @_; + + $file = map_filename($orig_file); + + if (!open(IN_FILE,"<$file")) { + print STDERR "Error: Cannot open file $file\n"; + ++$errors; + return; + } + + $. = 1; + + $section_counter = 0; + while (<IN_FILE>) { + while (s/\\\s*$//) { + $_ .= <IN_FILE>; + } + # Replace tabs by spaces + while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; + # Hand this line to the appropriate state handler + if ($state == STATE_NORMAL) { + process_normal(); + } elsif ($state == STATE_NAME) { + process_name($file, $_); + } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE || + $state == STATE_BODY_WITH_BLANK_LINE) { + process_body($file, $_); + } elsif ($state == STATE_INLINE) { # scanning for inline parameters + process_inline($file, $_); + } elsif ($state == STATE_PROTO) { + process_proto($file, $_); + } elsif ($state == STATE_DOCBLOCK) { + process_docblock($file, $_); + } + } + + # Make sure we got something interesting. + if ($initial_section_counter == $section_counter && $ + output_mode ne "none") { + if ($output_selection == OUTPUT_INCLUDE) { + print STDERR "${file}:1: warning: '$_' not found\n" + for keys %function_table; + } + else { + print STDERR "${file}:1: warning: no structured comments found\n"; + } + } + close IN_FILE; +} + + +if ($output_mode eq "rst") { + get_sphinx_version() if (!$sphinx_major); +} + +$kernelversion = get_kernel_version(); + +# generate a sequence of code that will splice in highlighting information +# using the s// operator. +for (my $k = 0; $k < @highlights; $k++) { + my $pattern = $highlights[$k][0]; + my $result = $highlights[$k][1]; +# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; + $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n"; +} + +# Read the file that maps relative names to absolute names for +# separate source and object directories and for shadow trees. +if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { + my ($relname, $absname); + while(<SOURCE_MAP>) { + chop(); + ($relname, $absname) = (split())[0..1]; + $relname =~ s:^/+::; + $source_map{$relname} = $absname; + } + close(SOURCE_MAP); +} + +if ($output_selection == OUTPUT_EXPORTED || + $output_selection == OUTPUT_INTERNAL) { + + push(@export_file_list, @ARGV); + + foreach (@export_file_list) { + chomp; + process_export_file($_); + } +} + +foreach (@ARGV) { + chomp; + process_file($_); +} +if ($verbose && $errors) { + print STDERR "$errors errors\n"; +} +if ($verbose && $warnings) { + print STDERR "$warnings warnings\n"; +} + +if ($Werror && $warnings) { + print STDERR "$warnings warnings as Errors\n"; + exit($warnings); +} else { + exit($output_mode eq "none" ? 0 : $errors) +} diff --git a/doc/list-man-pages.sh b/doc/list-man-pages.sh new file mode 100755 index 0000000..fef237c --- /dev/null +++ b/doc/list-man-pages.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +file=$1 + +for func in $(sed -n 's/ \* \([a-z_]*\)() -.*/\1/p' $file); do + echo ${func} +done + +for struct in $(sed -n 's/ \* struct \([a-z_]*\) -.*/\1/p' $file); do + echo ${struct} +done + +for enum in $(sed -n 's/ \* enum \([a-z_]*\) -.*/\1/p' $file); do + echo ${enum} +done diff --git a/doc/man/nvme_admin_opcode.2 b/doc/man/nvme_admin_opcode.2 new file mode 100644 index 0000000..a762b8a --- /dev/null +++ b/doc/man/nvme_admin_opcode.2 @@ -0,0 +1,216 @@ +.TH "libnvme" 9 "enum nvme_admin_opcode" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_admin_opcode \- Known NVMe admin opcodes +.SH SYNOPSIS +enum nvme_admin_opcode { +.br +.BI " nvme_admin_delete_sq" +, +.br +.br +.BI " nvme_admin_create_sq" +, +.br +.br +.BI " nvme_admin_get_log_page" +, +.br +.br +.BI " nvme_admin_delete_cq" +, +.br +.br +.BI " nvme_admin_create_cq" +, +.br +.br +.BI " nvme_admin_identify" +, +.br +.br +.BI " nvme_admin_abort_cmd" +, +.br +.br +.BI " nvme_admin_set_features" +, +.br +.br +.BI " nvme_admin_get_features" +, +.br +.br +.BI " nvme_admin_async_event" +, +.br +.br +.BI " nvme_admin_ns_mgmt" +, +.br +.br +.BI " nvme_admin_fw_commit" +, +.br +.br +.BI " nvme_admin_fw_activate" +, +.br +.br +.BI " nvme_admin_fw_download" +, +.br +.br +.BI " nvme_admin_dev_self_test" +, +.br +.br +.BI " nvme_admin_ns_attach" +, +.br +.br +.BI " nvme_admin_keep_alive" +, +.br +.br +.BI " nvme_admin_directive_send" +, +.br +.br +.BI " nvme_admin_directive_recv" +, +.br +.br +.BI " nvme_admin_virtual_mgmt" +, +.br +.br +.BI " nvme_admin_nvme_mi_send" +, +.br +.br +.BI " nvme_admin_nvme_mi_recv" +, +.br +.br +.BI " nvme_admin_capacity_mgmt" +, +.br +.br +.BI " nvme_admin_discovery_info_mgmt" +, +.br +.br +.BI " nvme_admin_fabric_zoning_recv" +, +.br +.br +.BI " nvme_admin_lockdown" +, +.br +.br +.BI " nvme_admin_fabric_zoning_lookup" +, +.br +.br +.BI " nvme_admin_fabric_zoning_send" +, +.br +.br +.BI " nvme_admin_dbbuf" +, +.br +.br +.BI " nvme_admin_fabrics" +, +.br +.br +.BI " nvme_admin_format_nvm" +, +.br +.br +.BI " nvme_admin_security_send" +, +.br +.br +.BI " nvme_admin_security_recv" +, +.br +.br +.BI " nvme_admin_sanitize_nvm" +, +.br +.br +.BI " nvme_admin_get_lba_status" + +}; +.SH Constants +.IP "nvme_admin_delete_sq" 12 +Delete I/O Submission Queue +.IP "nvme_admin_create_sq" 12 +Create I/O Submission Queue +.IP "nvme_admin_get_log_page" 12 +Get Log Page +.IP "nvme_admin_delete_cq" 12 +Delete I/O Completion Queue +.IP "nvme_admin_create_cq" 12 +Create I/O Completion Queue +.IP "nvme_admin_identify" 12 +Identify +.IP "nvme_admin_abort_cmd" 12 +Abort +.IP "nvme_admin_set_features" 12 +Set Features +.IP "nvme_admin_get_features" 12 +Get Features +.IP "nvme_admin_async_event" 12 +Asynchronous Event Request +.IP "nvme_admin_ns_mgmt" 12 +Namespace Management +.IP "nvme_admin_fw_commit" 12 +Firmware Commit +.IP "nvme_admin_fw_activate" 12 +Firmware Commit +.IP "nvme_admin_fw_download" 12 +Firmware Image Download +.IP "nvme_admin_dev_self_test" 12 +Device Self-test +.IP "nvme_admin_ns_attach" 12 +Namespace Attachment +.IP "nvme_admin_keep_alive" 12 +Keep Alive +.IP "nvme_admin_directive_send" 12 +Directive Send +.IP "nvme_admin_directive_recv" 12 +Directive Receive +.IP "nvme_admin_virtual_mgmt" 12 +Virtualization Management +.IP "nvme_admin_nvme_mi_send" 12 +NVMe-MI Send +.IP "nvme_admin_nvme_mi_recv" 12 +NVMe-MI Receive +.IP "nvme_admin_capacity_mgmt" 12 +Capacity Management +.IP "nvme_admin_discovery_info_mgmt" 12 +Discovery Information Management (DIM) +.IP "nvme_admin_fabric_zoning_recv" 12 +Fabric Zoning Receive +.IP "nvme_admin_lockdown" 12 +Lockdown +.IP "nvme_admin_fabric_zoning_lookup" 12 +Fabric Zoning Lookup +.IP "nvme_admin_fabric_zoning_send" 12 +Fabric Zoning Send +.IP "nvme_admin_dbbuf" 12 +Doorbell Buffer Config +.IP "nvme_admin_fabrics" 12 +Fabrics Commands +.IP "nvme_admin_format_nvm" 12 +Format NVM +.IP "nvme_admin_security_send" 12 +Security Send +.IP "nvme_admin_security_recv" 12 +Security Receive +.IP "nvme_admin_sanitize_nvm" 12 +Sanitize +.IP "nvme_admin_get_lba_status" 12 +Get LBA Status diff --git a/doc/man/nvme_admin_passthru.2 b/doc/man/nvme_admin_passthru.2 new file mode 100644 index 0000000..df4dbf4 --- /dev/null +++ b/doc/man/nvme_admin_passthru.2 @@ -0,0 +1,71 @@ +.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_admin_passthru \- Submit an nvme passthrough command +.SH SYNOPSIS +.B "int" nvme_admin_passthru +.BI "(int fd " "," +.BI "__u8 opcode " "," +.BI "__u8 flags " "," +.BI "__u16 rsvd " "," +.BI "__u32 nsid " "," +.BI "__u32 cdw2 " "," +.BI "__u32 cdw3 " "," +.BI "__u32 cdw10 " "," +.BI "__u32 cdw11 " "," +.BI "__u32 cdw12 " "," +.BI "__u32 cdw13 " "," +.BI "__u32 cdw14 " "," +.BI "__u32 cdw15 " "," +.BI "__u32 data_len " "," +.BI "void *data " "," +.BI "__u32 metadata_len " "," +.BI "void *metadata " "," +.BI "__u32 timeout_ms " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "opcode" 12 +The nvme io command to send +.IP "flags" 12 +NVMe command flags (not used) +.IP "rsvd" 12 +Reserevd for future use +.IP "nsid" 12 +Namespace identifier +.IP "cdw2" 12 +Command dword 2 +.IP "cdw3" 12 +Command dword 3 +.IP "cdw10" 12 +Command dword 10 +.IP "cdw11" 12 +Command dword 11 +.IP "cdw12" 12 +Command dword 12 +.IP "cdw13" 12 +Command dword 13 +.IP "cdw14" 12 +Command dword 14 +.IP "cdw15" 12 +Command dword 15 +.IP "data_len" 12 +Length of the data transfered in this command in bytes +.IP "data" 12 +Pointer to user address of the data buffer +.IP "metadata_len" 12 +Length of metadata transfered in this command +.IP "metadata" 12 +Pointer to user address of the metadata buffer +.IP "timeout_ms" 12 +How long the kernel waits for the command to complete +.IP "result" 12 +Optional field to return the result from the CQE dword 0 +.SH "DESCRIPTION" +Parameterized form of \fBnvme_submit_admin_passthru\fP. This sets up and +submits a \fIstruct nvme_passthru_cmd\fP. + +Known values for \fIopcode\fP are defined in \fIenum nvme_admin_opcode\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ae_info_css_nvm.2 b/doc/man/nvme_ae_info_css_nvm.2 new file mode 100644 index 0000000..b583463 --- /dev/null +++ b/doc/man/nvme_ae_info_css_nvm.2 @@ -0,0 +1,25 @@ +.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ae_info_css_nvm \- +.SH SYNOPSIS +enum nvme_ae_info_css_nvm { +.br +.BI " NVME_AER_CSS_NVM_RESERVATION" +, +.br +.br +.BI " NVME_AER_CSS_NVM_SANITIZE_COMPLETED" +, +.br +.br +.BI " NVME_AER_CSS_NVM_UNEXPECTED_SANITIZE_DEALLOC" + +}; +.SH Constants +.IP "NVME_AER_CSS_NVM_RESERVATION" 12 +Reservation Log Page Available +.IP "NVME_AER_CSS_NVM_SANITIZE_COMPLETED" 12 +Sanitize Operation Completed +.IP "NVME_AER_CSS_NVM_UNEXPECTED_SANITIZE_DEALLOC" 12 +Sanitize Operation Completed +With Unexpected Deallocation diff --git a/doc/man/nvme_ae_info_error.2 b/doc/man/nvme_ae_info_error.2 new file mode 100644 index 0000000..103b6a2 --- /dev/null +++ b/doc/man/nvme_ae_info_error.2 @@ -0,0 +1,42 @@ +.TH "libnvme" 9 "enum nvme_ae_info_error" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ae_info_error \- +.SH SYNOPSIS +enum nvme_ae_info_error { +.br +.BI " NVME_AER_ERROR_INVALID_DB_REG" +, +.br +.br +.BI " NVME_AER_ERROR_INVALID_DB_VAL" +, +.br +.br +.BI " NVME_AER_ERROR_DIAG_FAILURE" +, +.br +.br +.BI " NVME_AER_ERROR_PERSISTENT_INTERNAL_ERROR" +, +.br +.br +.BI " NVME_AER_ERROR_TRANSIENT_INTERNAL_ERROR" +, +.br +.br +.BI " NVME_AER_ERROR_FW_IMAGE_LOAD_ERROR" + +}; +.SH Constants +.IP "NVME_AER_ERROR_INVALID_DB_REG" 12 +Write to Invalid Doorbell Register +.IP "NVME_AER_ERROR_INVALID_DB_VAL" 12 +Invalid Doorbell Write Value +.IP "NVME_AER_ERROR_DIAG_FAILURE" 12 +Diagnostic Failure +.IP "NVME_AER_ERROR_PERSISTENT_INTERNAL_ERROR" 12 +Persistent Internal Error +.IP "NVME_AER_ERROR_TRANSIENT_INTERNAL_ERROR" 12 +Transient Internal Error +.IP "NVME_AER_ERROR_FW_IMAGE_LOAD_ERROR" 12 +Firmware Image Load Error diff --git a/doc/man/nvme_ae_info_notice.2 b/doc/man/nvme_ae_info_notice.2 new file mode 100644 index 0000000..9c5ceb2 --- /dev/null +++ b/doc/man/nvme_ae_info_notice.2 @@ -0,0 +1,54 @@ +.TH "libnvme" 9 "enum nvme_ae_info_notice" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ae_info_notice \- +.SH SYNOPSIS +enum nvme_ae_info_notice { +.br +.BI " NVME_AER_NOTICE_NS_CHANGED" +, +.br +.br +.BI " NVME_AER_NOTICE_FW_ACT_STARTING" +, +.br +.br +.BI " NVME_AER_NOTICE_TELEMETRY" +, +.br +.br +.BI " NVME_AER_NOTICE_ANA" +, +.br +.br +.BI " NVME_AER_NOTICE_PL_EVENT" +, +.br +.br +.BI " NVME_AER_NOTICE_LBA_STATUS_ALERT" +, +.br +.br +.BI " NVME_AER_NOTICE_EG_EVENT" +, +.br +.br +.BI " NVME_AER_NOTICE_DISC_CHANGED" + +}; +.SH Constants +.IP "NVME_AER_NOTICE_NS_CHANGED" 12 +Namespace Attribute Changed +.IP "NVME_AER_NOTICE_FW_ACT_STARTING" 12 +Firmware Activation Starting +.IP "NVME_AER_NOTICE_TELEMETRY" 12 +Telemetry Log Changed +.IP "NVME_AER_NOTICE_ANA" 12 +Asymmetric Namespace Access Change +.IP "NVME_AER_NOTICE_PL_EVENT" 12 +Predictable Latency Event Aggregate Log Change +.IP "NVME_AER_NOTICE_LBA_STATUS_ALERT" 12 +LBA Status Information Alert +.IP "NVME_AER_NOTICE_EG_EVENT" 12 +Endurance Group Event Aggregate Log Page Change +.IP "NVME_AER_NOTICE_DISC_CHANGED" 12 +Discovery Log Page Change diff --git a/doc/man/nvme_ae_info_smart.2 b/doc/man/nvme_ae_info_smart.2 new file mode 100644 index 0000000..1a6cd98 --- /dev/null +++ b/doc/man/nvme_ae_info_smart.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_ae_info_smart" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ae_info_smart \- +.SH SYNOPSIS +enum nvme_ae_info_smart { +.br +.BI " NVME_AER_SMART_SUBSYSTEM_RELIABILITY" +, +.br +.br +.BI " NVME_AER_SMART_TEMPERATURE_THRESHOLD" +, +.br +.br +.BI " NVME_AER_SMART_SPARE_THRESHOLD" + +}; +.SH Constants +.IP "NVME_AER_SMART_SUBSYSTEM_RELIABILITY" 12 +NVM subsystem Reliability +.IP "NVME_AER_SMART_TEMPERATURE_THRESHOLD" 12 +Temperature Threshold +.IP "NVME_AER_SMART_SPARE_THRESHOLD" 12 +Spare Below Threshold diff --git a/doc/man/nvme_ae_type.2 b/doc/man/nvme_ae_type.2 new file mode 100644 index 0000000..514ea84 --- /dev/null +++ b/doc/man/nvme_ae_type.2 @@ -0,0 +1,36 @@ +.TH "libnvme" 9 "enum nvme_ae_type" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ae_type \- +.SH SYNOPSIS +enum nvme_ae_type { +.br +.BI " NVME_AER_ERROR" +, +.br +.br +.BI " NVME_AER_SMART" +, +.br +.br +.BI " NVME_AER_NOTICE" +, +.br +.br +.BI " NVME_AER_CSS" +, +.br +.br +.BI " NVME_AER_VS" + +}; +.SH Constants +.IP "NVME_AER_ERROR" 12 +Error event +.IP "NVME_AER_SMART" 12 +SMART / Health Status event +.IP "NVME_AER_NOTICE" 12 +Notice event +.IP "NVME_AER_CSS" 12 +NVM Command Set Specific events +.IP "NVME_AER_VS" 12 +Vendor Specific event diff --git a/doc/man/nvme_aggregate_endurance_group_event.2 b/doc/man/nvme_aggregate_endurance_group_event.2 new file mode 100644 index 0000000..c7656cd --- /dev/null +++ b/doc/man/nvme_aggregate_endurance_group_event.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_aggregate_endurance_group_event \- +.SH SYNOPSIS +struct nvme_aggregate_endurance_group_event { +.br +.BI " __le64 num_entries;" +.br +.BI " __le16 entries[];" +.br +.BI " +}; +.br + +.SH Members +.IP "num_entries" 12 +Number or entries +.IP "entries" 12 +List of entries diff --git a/doc/man/nvme_aggregate_predictable_lat_event.2 b/doc/man/nvme_aggregate_predictable_lat_event.2 new file mode 100644 index 0000000..26937e2 --- /dev/null +++ b/doc/man/nvme_aggregate_predictable_lat_event.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_aggregate_predictable_lat_event \- +.SH SYNOPSIS +struct nvme_aggregate_predictable_lat_event { +.br +.BI " __le64 num_entries;" +.br +.BI " __le16 entries[];" +.br +.BI " +}; +.br + +.SH Members +.IP "num_entries" 12 +Number of entries +.IP "entries" 12 +Entry list diff --git a/doc/man/nvme_ana_group_desc.2 b/doc/man/nvme_ana_group_desc.2 new file mode 100644 index 0000000..5b8ceb9 --- /dev/null +++ b/doc/man/nvme_ana_group_desc.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_ana_group_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ana_group_desc \- +.SH SYNOPSIS +struct nvme_ana_group_desc { +.br +.BI " __le32 grpid;" +.br +.BI " __le32 nnsids;" +.br +.BI " __le64 chgcnt;" +.br +.BI " __u8 state;" +.br +.BI " __u8 rsvd17[15];" +.br +.BI " __le32 nsids[];" +.br +.BI " +}; +.br + +.SH Members +.IP "grpid" 12 +ANA group id +.IP "nnsids" 12 +Number of namespaces in \fInsids\fP +.IP "chgcnt" 12 +Change counter +.IP "state" 12 +ANA state +.IP "rsvd17" 12 +Reserved +.IP "nsids" 12 +List of namespaces diff --git a/doc/man/nvme_ana_log.2 b/doc/man/nvme_ana_log.2 new file mode 100644 index 0000000..51b4bd8 --- /dev/null +++ b/doc/man/nvme_ana_log.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_ana_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ana_log \- +.SH SYNOPSIS +struct nvme_ana_log { +.br +.BI " __le64 chgcnt;" +.br +.BI " __le16 ngrps;" +.br +.BI " __u8 rsvd10[6];" +.br +.BI " struct nvme_ana_group_desc descs[];" +.br +.BI " +}; +.br + +.SH Members +.IP "chgcnt" 12 +Change Count +.IP "ngrps" 12 +Number of ANA Group Descriptors +.IP "rsvd10" 12 +Reserved +.IP "descs" 12 +ANA Group Descriptor diff --git a/doc/man/nvme_ana_state.2 b/doc/man/nvme_ana_state.2 new file mode 100644 index 0000000..83d50b6 --- /dev/null +++ b/doc/man/nvme_ana_state.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "enum nvme_ana_state" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ana_state \- +.SH SYNOPSIS +enum nvme_ana_state { +.br +.BI " NVME_ANA_STATE_OPTIMIZED" +, +.br +.br +.BI " NVME_ANA_STATE_NONOPTIMIZED" +, +.br +.br +.BI " NVME_ANA_STATE_INACCESSIBLE" +, +.br +.br +.BI " NVME_ANA_STATE_PERSISTENT_LOSS" +, +.br +.br +.BI " NVME_ANA_STATE_CHANGE" + +}; +.SH Constants +.IP "NVME_ANA_STATE_OPTIMIZED" 12 +.IP "NVME_ANA_STATE_NONOPTIMIZED" 12 +.IP "NVME_ANA_STATE_INACCESSIBLE" 12 +.IP "NVME_ANA_STATE_PERSISTENT_LOSS" 12 +.IP "NVME_ANA_STATE_CHANGE" 12 diff --git a/doc/man/nvme_apst_entry.2 b/doc/man/nvme_apst_entry.2 new file mode 100644 index 0000000..fb52310 --- /dev/null +++ b/doc/man/nvme_apst_entry.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_apst_entry" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_apst_entry \- +.SH SYNOPSIS +enum nvme_apst_entry { +.br +.BI " NVME_APST_ENTRY_ITPS_SHIFT" +, +.br +.br +.BI " NVME_APST_ENTRY_ITPT_SHIFT" +, +.br +.br +.BI " NVME_APST_ENTRY_ITPS_MASK" +, +.br +.br +.BI " NVME_APST_ENTRY_ITPT_MASK" + +}; +.SH Constants +.IP "NVME_APST_ENTRY_ITPS_SHIFT" 12 +.IP "NVME_APST_ENTRY_ITPT_SHIFT" 12 +.IP "NVME_APST_ENTRY_ITPS_MASK" 12 +.IP "NVME_APST_ENTRY_ITPT_MASK" 12 diff --git a/doc/man/nvme_boot_partition.2 b/doc/man/nvme_boot_partition.2 new file mode 100644 index 0000000..3403da5 --- /dev/null +++ b/doc/man/nvme_boot_partition.2 @@ -0,0 +1,32 @@ +.TH "libnvme" 9 "struct nvme_boot_partition" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_boot_partition \- +.SH SYNOPSIS +struct nvme_boot_partition { +.br +.BI " __u8 lid;" +.br +.BI " __u8 rsvd1[3];" +.br +.BI " __le32 bpinfo;" +.br +.BI " __u8 rsvd8[8];" +.br +.BI " __u8 boot_partition_data[];" +.br +.BI " +}; +.br + +.SH Members +.IP "lid" 12 +Boot Partition Identifier +.IP "rsvd1" 12 +Reserved +.IP "bpinfo" 12 +Boot Partition Information +.IP "rsvd8" 12 +Reserved +.IP "boot_partition_data" 12 +Contains the contents of the +specified Boot Partition diff --git a/doc/man/nvme_cap_config_desc.2 b/doc/man/nvme_cap_config_desc.2 new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/doc/man/nvme_cap_config_desc.2 diff --git a/doc/man/nvme_capacity_mgmt.2 b/doc/man/nvme_capacity_mgmt.2 new file mode 100644 index 0000000..4ebf6a2 --- /dev/null +++ b/doc/man/nvme_capacity_mgmt.2 @@ -0,0 +1,12 @@ +.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_capacity_mgmt \- +.SH SYNOPSIS +.B "int" nvme_capacity_mgmt +.BI "(struct nvme_capacity_mgmt_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_capacity_mgmt_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_capacity_mgmt_args.2 b/doc/man/nvme_capacity_mgmt_args.2 new file mode 100644 index 0000000..b3c42e7 --- /dev/null +++ b/doc/man/nvme_capacity_mgmt_args.2 @@ -0,0 +1,45 @@ +.TH "libnvme" 9 "struct nvme_capacity_mgmt_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_capacity_mgmt_args \- Arguments for the NVMe Capacity Management command +.SH SYNOPSIS +struct nvme_capacity_mgmt_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 cdw11;" +.br +.BI " __u32 cdw12;" +.br +.BI " __u16 element_id;" +.br +.BI " __u8 op;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +If successful, the CQE dword0 value +.IP "args_size" 12 +Size of \fIstruct nvme_capacity_mgmt_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "cdw11" 12 +Least significant 32 bits of the capacity in bytes of the +Endurance Group or NVM Set to be created +.IP "cdw12" 12 +Most significant 32 bits of the capacity in bytes of the +Endurance Group or NVM Set to be created +.IP "element_id" 12 +Value specific to the value of the Operation field +.IP "op" 12 +Operation to be performed by the controller diff --git a/doc/man/nvme_change_ns_event.2 b/doc/man/nvme_change_ns_event.2 new file mode 100644 index 0000000..e7d329c --- /dev/null +++ b/doc/man/nvme_change_ns_event.2 @@ -0,0 +1,63 @@ +.TH "libnvme" 9 "struct nvme_change_ns_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_change_ns_event \- +.SH SYNOPSIS +struct nvme_change_ns_event { +.br +.BI " __le32 nsmgt_cdw10;" +.br +.BI " __u8 rsvd4[4];" +.br +.BI " __le64 nsze;" +.br +.BI " __u8 rsvd16[8];" +.br +.BI " __le64 nscap;" +.br +.BI " __u8 flbas;" +.br +.BI " __u8 dps;" +.br +.BI " __u8 nmic;" +.br +.BI " __u8 rsvd35;" +.br +.BI " __le32 ana_grp_id;" +.br +.BI " __le16 nvmset_id;" +.br +.BI " __le16 rsvd42;" +.br +.BI " __le32 nsid;" +.br +.BI " +}; +.br + +.SH Members +.IP "nsmgt_cdw10" 12 +Namespace Management CDW10 +.IP "rsvd4" 12 +Reserved +.IP "nsze" 12 +Namespace Size +.IP "rsvd16" 12 +Reserved +.IP "nscap" 12 +Namespace Capacity +.IP "flbas" 12 +Formatted LBA Size +.IP "dps" 12 +End-to-end Data Protection Type Settings +.IP "nmic" 12 +Namespace Multi-path I/O and Namespace Sharing Capabilities +.IP "rsvd35" 12 +Reserved +.IP "ana_grp_id" 12 +ANA Group Identifier +.IP "nvmset_id" 12 +NVM Set Identifier +.IP "rsvd42" 12 +Reserved +.IP "nsid" 12 +Namespace ID diff --git a/doc/man/nvme_channel_config_desc.2 b/doc/man/nvme_channel_config_desc.2 new file mode 100644 index 0000000..844f858 --- /dev/null +++ b/doc/man/nvme_channel_config_desc.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "struct nvme_channel_config_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_channel_config_desc \- +.SH SYNOPSIS +struct nvme_channel_config_desc { +.br +.BI " __le16 chanid;" +.br +.BI " __le16 chmus;" +.br +.BI " struct nvme_media_unit_config_desc mu_config_desc[];" +.br +.BI " +}; +.br + +.SH Members +.IP "chanid" 12 +Channel Identifier +.IP "chmus" 12 +Number Channel Media Units +.SH "Description" +Channel Configuration Descriptor +Structure Definitions diff --git a/doc/man/nvme_cmb_size.2 b/doc/man/nvme_cmb_size.2 new file mode 100644 index 0000000..395347d --- /dev/null +++ b/doc/man/nvme_cmb_size.2 @@ -0,0 +1,11 @@ +.TH "nvme_cmb_size" 9 "nvme_cmb_size" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_cmb_size \- Calculate size of the controller memory buffer +.SH SYNOPSIS +.B "__u64" nvme_cmb_size +.BI "(__u32 cmbsz " ");" +.SH ARGUMENTS +.IP "cmbsz" 12 +Value from controller register NVME_REG_CMBSZ +.SH "DESCRIPTION" +Returns size of controller memory buffer in bytes diff --git a/doc/man/nvme_cmd_effects.2 b/doc/man/nvme_cmd_effects.2 new file mode 100644 index 0000000..f0cf27b --- /dev/null +++ b/doc/man/nvme_cmd_effects.2 @@ -0,0 +1,48 @@ +.TH "libnvme" 9 "enum nvme_cmd_effects" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_effects \- +.SH SYNOPSIS +enum nvme_cmd_effects { +.br +.BI " NVME_CMD_EFFECTS_CSUPP" +, +.br +.br +.BI " NVME_CMD_EFFECTS_LBCC" +, +.br +.br +.BI " NVME_CMD_EFFECTS_NCC" +, +.br +.br +.BI " NVME_CMD_EFFECTS_NIC" +, +.br +.br +.BI " NVME_CMD_EFFECTS_CCC" +, +.br +.br +.BI " NVME_CMD_EFFECTS_CSE_MASK" +, +.br +.br +.BI " NVME_CMD_EFFECTS_UUID_SEL" + +}; +.SH Constants +.IP "NVME_CMD_EFFECTS_CSUPP" 12 +Command Supported +.IP "NVME_CMD_EFFECTS_LBCC" 12 +Logical Block Content Change +.IP "NVME_CMD_EFFECTS_NCC" 12 +Namespace Capability Change +.IP "NVME_CMD_EFFECTS_NIC" 12 +Namespace Inventory Change +.IP "NVME_CMD_EFFECTS_CCC" 12 +Controller Capability Change +.IP "NVME_CMD_EFFECTS_CSE_MASK" 12 +Command Submission and Execution +.IP "NVME_CMD_EFFECTS_UUID_SEL" 12 +UUID Selection Supported diff --git a/doc/man/nvme_cmd_effects_log.2 b/doc/man/nvme_cmd_effects_log.2 new file mode 100644 index 0000000..7458732 --- /dev/null +++ b/doc/man/nvme_cmd_effects_log.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_cmd_effects_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_cmd_effects_log \- +.SH SYNOPSIS +struct nvme_cmd_effects_log { +.br +.BI " __le32 acs[256];" +.br +.BI " __le32 iocs[256];" +.br +.BI " __u8 rsvd[2048];" +.br +.BI " +}; +.br + +.SH Members +.IP "acs" 12 +Admin Command Supported +.IP "iocs" 12 +I/O Command Supported +.IP "rsvd" 12 +Reserved diff --git a/doc/man/nvme_cmd_format_mset.2 b/doc/man/nvme_cmd_format_mset.2 new file mode 100644 index 0000000..dba60cd --- /dev/null +++ b/doc/man/nvme_cmd_format_mset.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "enum nvme_cmd_format_mset" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_format_mset \- Format NVM - Metadata Settings +.SH SYNOPSIS +enum nvme_cmd_format_mset { +.br +.BI " NVME_FORMAT_MSET_SEPARATE" +, +.br +.br +.BI " NVME_FORMAT_MSET_EXTENDED" + +}; +.SH Constants +.IP "NVME_FORMAT_MSET_SEPARATE" 12 +indicates that the metadata is transferred +as part of a separate buffer. +.IP "NVME_FORMAT_MSET_EXTENDED" 12 +indicates that the metadata is transferred +as part of an extended data LBA. diff --git a/doc/man/nvme_cmd_format_pi.2 b/doc/man/nvme_cmd_format_pi.2 new file mode 100644 index 0000000..4388656 --- /dev/null +++ b/doc/man/nvme_cmd_format_pi.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_cmd_format_pi" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_format_pi \- Format NVM - Protection Information +.SH SYNOPSIS +enum nvme_cmd_format_pi { +.br +.BI " NVME_FORMAT_PI_DISABLE" +, +.br +.br +.BI " NVME_FORMAT_PI_TYPE1" +, +.br +.br +.BI " NVME_FORMAT_PI_TYPE2" +, +.br +.br +.BI " NVME_FORMAT_PI_TYPE3" + +}; +.SH Constants +.IP "NVME_FORMAT_PI_DISABLE" 12 +Protection information is not enabled. +.IP "NVME_FORMAT_PI_TYPE1" 12 +Protection information is enabled, Type 1. +.IP "NVME_FORMAT_PI_TYPE2" 12 +Protection information is enabled, Type 2. +.IP "NVME_FORMAT_PI_TYPE3" 12 +Protection information is enabled, Type 3. diff --git a/doc/man/nvme_cmd_format_pil.2 b/doc/man/nvme_cmd_format_pil.2 new file mode 100644 index 0000000..a0b3269 --- /dev/null +++ b/doc/man/nvme_cmd_format_pil.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "enum nvme_cmd_format_pil" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_format_pil \- Format NVM - Protection Information Location +.SH SYNOPSIS +enum nvme_cmd_format_pil { +.br +.BI " NVME_FORMAT_PIL_LAST" +, +.br +.br +.BI " NVME_FORMAT_PIL_FIRST" + +}; +.SH Constants +.IP "NVME_FORMAT_PIL_LAST" 12 +Protection information is transferred as the last +bytes of metadata. +.IP "NVME_FORMAT_PIL_FIRST" 12 +Protection information is transferred as the first +bytes of metadata. diff --git a/doc/man/nvme_cmd_format_ses.2 b/doc/man/nvme_cmd_format_ses.2 new file mode 100644 index 0000000..d2b6ed5 --- /dev/null +++ b/doc/man/nvme_cmd_format_ses.2 @@ -0,0 +1,33 @@ +.TH "libnvme" 9 "enum nvme_cmd_format_ses" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings +.SH SYNOPSIS +enum nvme_cmd_format_ses { +.br +.BI " NVME_FORMAT_SES_NONE" +, +.br +.br +.BI " NVME_FORMAT_SES_USER_DATA_ERASE" +, +.br +.br +.BI " NVME_FORMAT_SES_CRYPTO_ERASE" + +}; +.SH Constants +.IP "NVME_FORMAT_SES_NONE" 12 +No secure erase operation requested. +.IP "NVME_FORMAT_SES_USER_DATA_ERASE" 12 +User Data Erase: All user data shall be erased, +contents of the user data after the erase is +indeterminate (e.g. the user data may be zero +filled, one filled, etc.). If a User Data Erase +is requested and all affected user data is +encrypted, then the controller is allowed +to use a cryptographic erase to perform +the requested User Data Erase. +.IP "NVME_FORMAT_SES_CRYPTO_ERASE" 12 +Cryptographic Erase: All user data shall +be erased cryptographically. This is +accomplished by deleting the encryption key. diff --git a/doc/man/nvme_cmd_get_log_lid.2 b/doc/man/nvme_cmd_get_log_lid.2 new file mode 100644 index 0000000..f2023ad --- /dev/null +++ b/doc/man/nvme_cmd_get_log_lid.2 @@ -0,0 +1,156 @@ +.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_get_log_lid \- +.SH SYNOPSIS +enum nvme_cmd_get_log_lid { +.br +.BI " NVME_LOG_LID_SUPPORTED_LOG_PAGES" +, +.br +.br +.BI " NVME_LOG_LID_ERROR" +, +.br +.br +.BI " NVME_LOG_LID_SMART" +, +.br +.br +.BI " NVME_LOG_LID_FW_SLOT" +, +.br +.br +.BI " NVME_LOG_LID_CHANGED_NS" +, +.br +.br +.BI " NVME_LOG_LID_CMD_EFFECTS" +, +.br +.br +.BI " NVME_LOG_LID_DEVICE_SELF_TEST" +, +.br +.br +.BI " NVME_LOG_LID_TELEMETRY_HOST" +, +.br +.br +.BI " NVME_LOG_LID_TELEMETRY_CTRL" +, +.br +.br +.BI " NVME_LOG_LID_ENDURANCE_GROUP" +, +.br +.br +.BI " NVME_LOG_LID_PREDICTABLE_LAT_NVMSET" +, +.br +.br +.BI " NVME_LOG_LID_PREDICTABLE_LAT_AGG" +, +.br +.br +.BI " NVME_LOG_LID_ANA" +, +.br +.br +.BI " NVME_LOG_LID_PERSISTENT_EVENT" +, +.br +.br +.BI " NVME_LOG_LID_LBA_STATUS" +, +.br +.br +.BI " NVME_LOG_LID_ENDURANCE_GRP_EVT" +, +.br +.br +.BI " NVME_LOG_LID_MEDIA_UNIT_STATUS" +, +.br +.br +.BI " NVME_LOG_LID_SUPPORTED_CAP_CONFIG_LIST" +, +.br +.br +.BI " NVME_LOG_LID_FID_SUPPORTED_EFFECTS" +, +.br +.br +.BI " NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS" +, +.br +.br +.BI " NVME_LOG_LID_BOOT_PARTITION" +, +.br +.br +.BI " NVME_LOG_LID_DISCOVER" +, +.br +.br +.BI " NVME_LOG_LID_RESERVATION" +, +.br +.br +.BI " NVME_LOG_LID_SANITIZE" +, +.br +.br +.BI " NVME_LOG_LID_ZNS_CHANGED_ZONES" + +}; +.SH Constants +.IP "NVME_LOG_LID_SUPPORTED_LOG_PAGES" 12 +Supported Log Pages +.IP "NVME_LOG_LID_ERROR" 12 +Error Information +.IP "NVME_LOG_LID_SMART" 12 +SMART / Health Information +.IP "NVME_LOG_LID_FW_SLOT" 12 +Firmware Slot Information +.IP "NVME_LOG_LID_CHANGED_NS" 12 +Changed Namespace List +.IP "NVME_LOG_LID_CMD_EFFECTS" 12 +Commands Supported and Effects +.IP "NVME_LOG_LID_DEVICE_SELF_TEST" 12 +Device Self-test +.IP "NVME_LOG_LID_TELEMETRY_HOST" 12 +Telemetry Host-Initiated +.IP "NVME_LOG_LID_TELEMETRY_CTRL" 12 +Telemetry Controller-Initiated +.IP "NVME_LOG_LID_ENDURANCE_GROUP" 12 +Endurance Group Information +.IP "NVME_LOG_LID_PREDICTABLE_LAT_NVMSET" 12 +Predictable Latency Per NVM Set +.IP "NVME_LOG_LID_PREDICTABLE_LAT_AGG" 12 +Predictable Latency Event Aggregate +.IP "NVME_LOG_LID_ANA" 12 +Asymmetric Namespace Access +.IP "NVME_LOG_LID_PERSISTENT_EVENT" 12 +Persistent Event Log +.IP "NVME_LOG_LID_LBA_STATUS" 12 +LBA Status Information +.IP "NVME_LOG_LID_ENDURANCE_GRP_EVT" 12 +Endurance Group Event Aggregate +.IP "NVME_LOG_LID_MEDIA_UNIT_STATUS" 12 +Media Unit Status +.IP "NVME_LOG_LID_SUPPORTED_CAP_CONFIG_LIST" 12 +Supported Capacity Configuration Lis +.IP "NVME_LOG_LID_FID_SUPPORTED_EFFECTS" 12 +Feature Identifiers Supported and Effects +.IP "NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS" 12 +NVMe-MI Commands Supported and Effects +.IP "NVME_LOG_LID_BOOT_PARTITION" 12 +Boot Partition +.IP "NVME_LOG_LID_DISCOVER" 12 +Discovery +.IP "NVME_LOG_LID_RESERVATION" 12 +Reservation Notification +.IP "NVME_LOG_LID_SANITIZE" 12 +Sanitize Status +.IP "NVME_LOG_LID_ZNS_CHANGED_ZONES" 12 +Changed Zone List diff --git a/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 b/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 new file mode 100644 index 0000000..062093a --- /dev/null +++ b/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 @@ -0,0 +1,16 @@ +.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_cmd_get_log_telemetry_host_lsp \- +.SH SYNOPSIS +enum nvme_cmd_get_log_telemetry_host_lsp { +.br +.BI " NVME_LOG_TELEM_HOST_LSP_RETAIN" +, +.br +.br +.BI " NVME_LOG_TELEM_HOST_LSP_CREATE" + +}; +.SH Constants +.IP "NVME_LOG_TELEM_HOST_LSP_RETAIN" 12 +.IP "NVME_LOG_TELEM_HOST_LSP_CREATE" 12 diff --git a/doc/man/nvme_compare.2 b/doc/man/nvme_compare.2 new file mode 100644 index 0000000..5a3214b --- /dev/null +++ b/doc/man/nvme_compare.2 @@ -0,0 +1,12 @@ +.TH "nvme_compare" 9 "nvme_compare" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_compare \- Submit an nvme user compare command +.SH SYNOPSIS +.B "int" nvme_compare +.BI "(struct nvme_io_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_connect_err.2 b/doc/man/nvme_connect_err.2 new file mode 100644 index 0000000..821fa74 --- /dev/null +++ b/doc/man/nvme_connect_err.2 @@ -0,0 +1,78 @@ +.TH "libnvme" 9 "enum nvme_connect_err" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_connect_err \- nvme connect error codes +.SH SYNOPSIS +enum nvme_connect_err { +.br +.BI " ENVME_CONNECT_RESOLVE" +, +.br +.br +.BI " ENVME_CONNECT_ADDRFAM" +, +.br +.br +.BI " ENVME_CONNECT_TRADDR" +, +.br +.br +.BI " ENVME_CONNECT_TARG" +, +.br +.br +.BI " ENVME_CONNECT_AARG" +, +.br +.br +.BI " ENVME_CONNECT_OPEN" +, +.br +.br +.BI " ENVME_CONNECT_WRITE" +, +.br +.br +.BI " ENVME_CONNECT_READ" +, +.br +.br +.BI " ENVME_CONNECT_PARSE" +, +.br +.br +.BI " ENVME_CONNECT_INVAL_TR" +, +.br +.br +.BI " ENVME_CONNECT_LOOKUP_SUBSYS_NAME" +, +.br +.br +.BI " ENVME_CONNECT_LOOKUP_SUBSYS" + +}; +.SH Constants +.IP "ENVME_CONNECT_RESOLVE" 12 +failed to resolve host +.IP "ENVME_CONNECT_ADDRFAM" 12 +unrecognized address family +.IP "ENVME_CONNECT_TRADDR" 12 +failed to get traddr +.IP "ENVME_CONNECT_TARG" 12 +need a transport (-t) argument +.IP "ENVME_CONNECT_AARG" 12 +need a address (-a) argument +.IP "ENVME_CONNECT_OPEN" 12 +failed to open nvme-fabrics device +.IP "ENVME_CONNECT_WRITE" 12 +failed to write to nvme-fabrics device +.IP "ENVME_CONNECT_READ" 12 +failed to read from nvme-fabrics device +.IP "ENVME_CONNECT_PARSE" 12 +failed to parse ctrl info +.IP "ENVME_CONNECT_INVAL_TR" 12 +invalid transport type +.IP "ENVME_CONNECT_LOOKUP_SUBSYS_NAME" 12 +failed to lookup subsystem name +.IP "ENVME_CONNECT_LOOKUP_SUBSYS" 12 +failed to lookup subsystem diff --git a/doc/man/nvme_constants.2 b/doc/man/nvme_constants.2 new file mode 100644 index 0000000..ab07e99 --- /dev/null +++ b/doc/man/nvme_constants.2 @@ -0,0 +1,199 @@ +.TH "libnvme" 9 "enum nvme_constants" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_constants \- A place to stash various constant nvme values +.SH SYNOPSIS +enum nvme_constants { +.br +.BI " NVME_NSID_ALL" +, +.br +.br +.BI " NVME_NSID_NONE" +, +.br +.br +.BI " NVME_UUID_NONE" +, +.br +.br +.BI " NVME_CNTLID_NONE" +, +.br +.br +.BI " NVME_CNSSPECID_NONE" +, +.br +.br +.BI " NVME_LOG_LSP_NONE" +, +.br +.br +.BI " NVME_LOG_LSI_NONE" +, +.br +.br +.BI " NVME_LOG_LPO_NONE" +, +.br +.br +.BI " NVME_IDENTIFY_DATA_SIZE" +, +.br +.br +.BI " NVME_LOG_SUPPORTED_LOG_PAGES_MAX" +, +.br +.br +.BI " NVME_ID_NVMSET_LIST_MAX" +, +.br +.br +.BI " NVME_ID_UUID_LIST_MAX" +, +.br +.br +.BI " NVME_ID_CTRL_LIST_MAX" +, +.br +.br +.BI " NVME_ID_NS_LIST_MAX" +, +.br +.br +.BI " NVME_ID_SECONDARY_CTRL_MAX" +, +.br +.br +.BI " NVME_ID_DOMAIN_LIST_MAX" +, +.br +.br +.BI " NVME_ID_ENDURANCE_GROUP_LIST_MAX" +, +.br +.br +.BI " NVME_ID_ND_DESCRIPTOR_MAX" +, +.br +.br +.BI " NVME_FEAT_LBA_RANGE_MAX" +, +.br +.br +.BI " NVME_LOG_ST_MAX_RESULTS" +, +.br +.br +.BI " NVME_LOG_TELEM_BLOCK_SIZE" +, +.br +.br +.BI " NVME_LOG_FID_SUPPORTED_EFFECTS_MAX" +, +.br +.br +.BI " NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX" +, +.br +.br +.BI " NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED" +, +.br +.br +.BI " NVME_DSM_MAX_RANGES" +, +.br +.br +.BI " NVME_NQN_LENGTH" +, +.br +.br +.BI " NVMF_TRADDR_SIZE" +, +.br +.br +.BI " NVMF_TSAS_SIZE" +, +.br +.br +.BI " NVME_ZNS_CHANGED_ZONES_MAX" + +}; +.SH Constants +.IP "NVME_NSID_ALL" 12 +A broadcast value that is used to specify all +namespaces +.IP "NVME_NSID_NONE" 12 +The invalid namespace id, for when the nsid +parameter is not used in a command +.IP "NVME_UUID_NONE" 12 +Use to omit a uuid command parameter +.IP "NVME_CNTLID_NONE" 12 +Use to omit a cntlid command parameter +.IP "NVME_CNSSPECID_NONE" 12 +Use to omit a cns_specific_id command parameter +.IP "NVME_LOG_LSP_NONE" 12 +Use to omit a log lsp command parameter +.IP "NVME_LOG_LSI_NONE" 12 +Use to omit a log lsi command parameter +.IP "NVME_LOG_LPO_NONE" 12 +Use to omit a log lpo command parameter +.IP "NVME_IDENTIFY_DATA_SIZE" 12 +The transfer size for nvme identify commands +.IP "NVME_LOG_SUPPORTED_LOG_PAGES_MAX" 12 +The lagest possible index in the supported +log pages log. +.IP "NVME_ID_NVMSET_LIST_MAX" 12 +The largest possible nvmset index in identify +nvmeset +.IP "NVME_ID_UUID_LIST_MAX" 12 +The largest possible uuid index in identify +uuid list +.IP "NVME_ID_CTRL_LIST_MAX" 12 +The largest possible controller index in +identify controller list +.IP "NVME_ID_NS_LIST_MAX" 12 +The largest possible namespace index in +identify namespace list +.IP "NVME_ID_SECONDARY_CTRL_MAX" 12 +The largest possible secondary controller index +in identify secondary controller +.IP "NVME_ID_DOMAIN_LIST_MAX" 12 +The largest possible domain index in the +in domain list +.IP "NVME_ID_ENDURANCE_GROUP_LIST_MAX" 12 +The largest possible endurance group +index in the endurance group list +.IP "NVME_ID_ND_DESCRIPTOR_MAX" 12 +The largest possible namespace granularity +index in the namespace granularity descriptor +list +.IP "NVME_FEAT_LBA_RANGE_MAX" 12 +The largest possible LBA range index in feature +lba range type +.IP "NVME_LOG_ST_MAX_RESULTS" 12 +The largest possible self test result index in the +device self test log +.IP "NVME_LOG_TELEM_BLOCK_SIZE" 12 +Specification defined size of Telemetry Data Blocks +.IP "NVME_LOG_FID_SUPPORTED_EFFECTS_MAX" 12 +The largest possible FID index in the +feature identifiers effects log. +.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX" 12 +The largest possible MI Command index +in the MI Command effects log. +.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED" 12 +The reserved space in the MI Command +effects log. +.IP "NVME_DSM_MAX_RANGES" 12 +The largest possible range index in a data-set +management command +.IP "NVME_NQN_LENGTH" 12 +Max length for NVMe Qualified Name +.IP "NVMF_TRADDR_SIZE" 12 +Max Transport Address size +.IP "NVMF_TSAS_SIZE" 12 +Max Transport Specific Address Subtype size +.IP "NVME_ZNS_CHANGED_ZONES_MAX" 12 +Max number of zones in the changed zones log +page diff --git a/doc/man/nvme_copy.2 b/doc/man/nvme_copy.2 new file mode 100644 index 0000000..c8cdf33 --- /dev/null +++ b/doc/man/nvme_copy.2 @@ -0,0 +1,12 @@ +.TH "nvme_copy" 9 "nvme_copy" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_copy \- +.SH SYNOPSIS +.B "int" nvme_copy +.BI "(struct nvme_copy_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_copy_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_copy_args.2 b/doc/man/nvme_copy_args.2 new file mode 100644 index 0000000..5cc2fe1 --- /dev/null +++ b/doc/man/nvme_copy_args.2 @@ -0,0 +1,83 @@ +.TH "libnvme" 9 "struct nvme_copy_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_copy_args \- Arguments for the NVMe Copy command +.SH SYNOPSIS +struct nvme_copy_args { +.br +.BI " __u64 sdlba;" +.br +.BI " __u32 *result;" +.br +.BI " struct nvme_copy_range *copy;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 ilbrt;" +.br +.BI " int lr;" +.br +.BI " int fua;" +.br +.BI " __u16 nr;" +.br +.BI " __u16 dspec;" +.br +.BI " __u16 lbatm;" +.br +.BI " __u16 lbat;" +.br +.BI " __u8 prinfor;" +.br +.BI " __u8 prinfow;" +.br +.BI " __u8 dtype;" +.br +.BI " __u8 format;" +.br +.BI " +}; +.br + +.SH Members +.IP "sdlba" 12 +Start destination LBA +.IP "result" 12 +The command completion result from CQE dword0 +.IP "copy" 12 +Range descriptior +.IP "args_size" 12 +Size of \fIstruct nvme_copy_args\fP +.IP "fd" 12 +File descriptor of the nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "ilbrt" 12 +Initial logical block reference tag +.IP "lr" 12 +Limited retry +.IP "fua" 12 +Force unit access +.IP "nr" 12 +Number of ranges +.IP "dspec" 12 +Directive specific value +.IP "lbatm" 12 +Logical block application tag mask +.IP "lbat" 12 +Logical block application tag +.IP "prinfor" 12 +Protection information field for read +.IP "prinfow" 12 +Protection information field for write +.IP "dtype" 12 +Directive type +.IP "format" 12 +Descriptor format diff --git a/doc/man/nvme_copy_range.2 b/doc/man/nvme_copy_range.2 new file mode 100644 index 0000000..590d4f1 --- /dev/null +++ b/doc/man/nvme_copy_range.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_copy_range" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_copy_range \- +.SH SYNOPSIS +struct nvme_copy_range { +.br +.BI " __u8 rsvd0[8];" +.br +.BI " __le64 slba;" +.br +.BI " __le16 nlb;" +.br +.BI " __u8 rsvd18[6];" +.br +.BI " __le32 eilbrt;" +.br +.BI " __le16 elbatm;" +.br +.BI " __le16 elbat;" +.br +.BI " +}; +.br + +.SH Members +.IP "rsvd0" 12 +Reserved +.IP "slba" 12 +Starting LBA +.IP "nlb" 12 +Number of Logical Blocks +.IP "rsvd18" 12 +Reserved +.IP "eilbrt" 12 +Expected Initial Logical Block Reference Tag +.IP "elbatm" 12 +Expected Logical Block Application Tag Mask +.IP "elbat" 12 +Expected Logical Block Application Tag diff --git a/doc/man/nvme_create_ctrl.2 b/doc/man/nvme_create_ctrl.2 new file mode 100644 index 0000000..8cab856 --- /dev/null +++ b/doc/man/nvme_create_ctrl.2 @@ -0,0 +1,31 @@ +.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_create_ctrl \- Allocate an unconnected NVMe controller +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_create_ctrl +.BI "(nvme_root_t r " "," +.BI "const char *subsysnqn " "," +.BI "const char *transport " "," +.BI "const char *traddr " "," +.BI "const char *host_traddr " "," +.BI "const char *host_iface " "," +.BI "const char *trsvcid " ");" +.SH ARGUMENTS +.IP "r" 12 +NVMe root element +.IP "subsysnqn" 12 +Subsystem NQN +.IP "transport" 12 +Transport type +.IP "traddr" 12 +Transport address +.IP "host_traddr" 12 +Host transport address +.IP "host_iface" 12 +Host interface name +.IP "trsvcid" 12 +Transport service ID +.SH "DESCRIPTION" +Creates an unconnected controller to be used for \fBnvme_add_ctrl\fP. +.SH "RETURN" +Controller instance diff --git a/doc/man/nvme_create_root.2 b/doc/man/nvme_create_root.2 new file mode 100644 index 0000000..fc8cdab --- /dev/null +++ b/doc/man/nvme_create_root.2 @@ -0,0 +1,14 @@ +.TH "nvme_create_root" 9 "nvme_create_root" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_create_root \- Initialize root object +.SH SYNOPSIS +.B "nvme_root_t" nvme_create_root +.BI "(FILE *fp " "," +.BI "int log_level " ");" +.SH ARGUMENTS +.IP "fp" 12 +File descriptor for logging messages +.IP "log_level" 12 +Logging level to use +.SH "RETURN" +Initialized \fInvme_root_t\fP object diff --git a/doc/man/nvme_csi.2 b/doc/man/nvme_csi.2 new file mode 100644 index 0000000..0a8523c --- /dev/null +++ b/doc/man/nvme_csi.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_csi" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_csi \- Defined command set indicators +.SH SYNOPSIS +enum nvme_csi { +.br +.BI " NVME_CSI_NVM" +, +.br +.br +.BI " NVME_CSI_KV" +, +.br +.br +.BI " NVME_CSI_ZNS" + +}; +.SH Constants +.IP "NVME_CSI_NVM" 12 +NVM Command Set Indicator +.IP "NVME_CSI_KV" 12 +Key Value Command Set +.IP "NVME_CSI_ZNS" 12 +Zoned Namespace Command Set diff --git a/doc/man/nvme_ctrl_first_ns.2 b/doc/man/nvme_ctrl_first_ns.2 new file mode 100644 index 0000000..a8ef754 --- /dev/null +++ b/doc/man/nvme_ctrl_first_ns.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_first_ns \- Start namespace iterator +.SH SYNOPSIS +.B "nvme_ns_t" nvme_ctrl_first_ns +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +First \fInvme_ns_t\fP object of an \fIc\fP iterator diff --git a/doc/man/nvme_ctrl_first_path.2 b/doc/man/nvme_ctrl_first_path.2 new file mode 100644 index 0000000..606feef --- /dev/null +++ b/doc/man/nvme_ctrl_first_path.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_first_path \- Start path iterator +.SH SYNOPSIS +.B "nvme_path_t" nvme_ctrl_first_path +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +First \fInvme_path_t\fP object of an \fIc\fP iterator diff --git a/doc/man/nvme_ctrl_for_each_ns.2 b/doc/man/nvme_ctrl_for_each_ns.2 new file mode 100644 index 0000000..97b08b1 --- /dev/null +++ b/doc/man/nvme_ctrl_for_each_ns.2 @@ -0,0 +1,12 @@ +.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_for_each_ns \- Traverse namespaces +.SH SYNOPSIS +.B "nvme_ctrl_for_each_ns +.BI "(c " "," +.BI "n " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "n" 12 +\fInvme_ns_t\fP object diff --git a/doc/man/nvme_ctrl_for_each_ns_safe.2 b/doc/man/nvme_ctrl_for_each_ns_safe.2 new file mode 100644 index 0000000..844a7c7 --- /dev/null +++ b/doc/man/nvme_ctrl_for_each_ns_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_for_each_ns_safe \- Traverse namespaces +.SH SYNOPSIS +.B "nvme_ctrl_for_each_ns_safe +.BI "(c " "," +.BI "n " "," +.BI "_n " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "n" 12 +\fInvme_ns_t\fP object +.IP "_n" 12 +A \fInvme_ns_t_node\fP to use as temporary storage diff --git a/doc/man/nvme_ctrl_for_each_path.2 b/doc/man/nvme_ctrl_for_each_path.2 new file mode 100644 index 0000000..ad85b94 --- /dev/null +++ b/doc/man/nvme_ctrl_for_each_path.2 @@ -0,0 +1,12 @@ +.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_for_each_path \- Traverse paths +.SH SYNOPSIS +.B "nvme_ctrl_for_each_path +.BI "(c " "," +.BI "p " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "p" 12 +\fInvme_path_t\fP object diff --git a/doc/man/nvme_ctrl_for_each_path_safe.2 b/doc/man/nvme_ctrl_for_each_path_safe.2 new file mode 100644 index 0000000..b341119 --- /dev/null +++ b/doc/man/nvme_ctrl_for_each_path_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_for_each_path_safe \- Traverse paths +.SH SYNOPSIS +.B "nvme_ctrl_for_each_path_safe +.BI "(c " "," +.BI "p " "," +.BI "_p " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "p" 12 +\fInvme_path_t\fP object +.IP "_p" 12 +A \fInvme_path_t_node\fP to use as temporary storage diff --git a/doc/man/nvme_ctrl_get_address.2 b/doc/man/nvme_ctrl_get_address.2 new file mode 100644 index 0000000..559a5de --- /dev/null +++ b/doc/man/nvme_ctrl_get_address.2 @@ -0,0 +1,12 @@ +.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_address \- Address string of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_address +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +NVMe-over-Fabrics address string of \fIc\fP or empty string +of no address is present. diff --git a/doc/man/nvme_ctrl_get_config.2 b/doc/man/nvme_ctrl_get_config.2 new file mode 100644 index 0000000..130de7e --- /dev/null +++ b/doc/man/nvme_ctrl_get_config.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_config \- Fabrics configuration of a controller +.SH SYNOPSIS +.B "struct nvme_fabrics_config *" nvme_ctrl_get_config +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Fabrics configuration of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_dhchap_key.2 b/doc/man/nvme_ctrl_get_dhchap_key.2 new file mode 100644 index 0000000..e9191da --- /dev/null +++ b/doc/man/nvme_ctrl_get_dhchap_key.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_dhchap_key \- Return controller key +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_dhchap_key +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller for which the key should be set +.SH "RETURN" +DH-HMAC-CHAP controller key or NULL if not set diff --git a/doc/man/nvme_ctrl_get_fd.2 b/doc/man/nvme_ctrl_get_fd.2 new file mode 100644 index 0000000..699c823 --- /dev/null +++ b/doc/man/nvme_ctrl_get_fd.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_fd \- Get associated file descriptor +.SH SYNOPSIS +.B "int" nvme_ctrl_get_fd +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +File descriptor associated with \fIc\fP or -1 diff --git a/doc/man/nvme_ctrl_get_firmware.2 b/doc/man/nvme_ctrl_get_firmware.2 new file mode 100644 index 0000000..9072a2a --- /dev/null +++ b/doc/man/nvme_ctrl_get_firmware.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_firmware \- Firmware string of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_firmware +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Firmware string of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_host_iface.2 b/doc/man/nvme_ctrl_get_host_iface.2 new file mode 100644 index 0000000..792795b --- /dev/null +++ b/doc/man/nvme_ctrl_get_host_iface.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_host_iface \- Host interface name of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_host_iface +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Host interface name of \fIc\fP (if present) diff --git a/doc/man/nvme_ctrl_get_host_traddr.2 b/doc/man/nvme_ctrl_get_host_traddr.2 new file mode 100644 index 0000000..7972169 --- /dev/null +++ b/doc/man/nvme_ctrl_get_host_traddr.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_host_traddr \- Host transport address of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_host_traddr +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Host transport address of \fIc\fP (if present) diff --git a/doc/man/nvme_ctrl_get_model.2 b/doc/man/nvme_ctrl_get_model.2 new file mode 100644 index 0000000..41b5b50 --- /dev/null +++ b/doc/man/nvme_ctrl_get_model.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_model \- Model of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_model +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Model string of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_name.2 b/doc/man/nvme_ctrl_get_name.2 new file mode 100644 index 0000000..022766a --- /dev/null +++ b/doc/man/nvme_ctrl_get_name.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_name \- sysfs name of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_name +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +sysfs name of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_numa_node.2 b/doc/man/nvme_ctrl_get_numa_node.2 new file mode 100644 index 0000000..06e199f --- /dev/null +++ b/doc/man/nvme_ctrl_get_numa_node.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_numa_node \- NUMA node of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_numa_node +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +String indicating the NUMA node diff --git a/doc/man/nvme_ctrl_get_queue_count.2 b/doc/man/nvme_ctrl_get_queue_count.2 new file mode 100644 index 0000000..0645e4a --- /dev/null +++ b/doc/man/nvme_ctrl_get_queue_count.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_queue_count \- Queue count of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_queue_count +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Queue count of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_serial.2 b/doc/man/nvme_ctrl_get_serial.2 new file mode 100644 index 0000000..646c43c --- /dev/null +++ b/doc/man/nvme_ctrl_get_serial.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_serial \- Serial number of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_serial +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Conroller instance +.SH "RETURN" +Serial number string of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_sqsize.2 b/doc/man/nvme_ctrl_get_sqsize.2 new file mode 100644 index 0000000..2ee323a --- /dev/null +++ b/doc/man/nvme_ctrl_get_sqsize.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_sqsize \- SQ size of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_sqsize +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +SQ size (as string) of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_state.2 b/doc/man/nvme_ctrl_get_state.2 new file mode 100644 index 0000000..8114541 --- /dev/null +++ b/doc/man/nvme_ctrl_get_state.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_state \- Running state of an controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_state +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +String indicating the running state of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_subsysnqn.2 b/doc/man/nvme_ctrl_get_subsysnqn.2 new file mode 100644 index 0000000..13ae3f2 --- /dev/null +++ b/doc/man/nvme_ctrl_get_subsysnqn.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_subsysnqn \- Subsystem NQN of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_subsysnqn +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Subsystem NQN of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_subsystem.2 b/doc/man/nvme_ctrl_get_subsystem.2 new file mode 100644 index 0000000..d522928 --- /dev/null +++ b/doc/man/nvme_ctrl_get_subsystem.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_subsystem \- Parent subsystem of a controller +.SH SYNOPSIS +.B "nvme_subsystem_t" nvme_ctrl_get_subsystem +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Parent nvme_subsystem_t object diff --git a/doc/man/nvme_ctrl_get_sysfs_dir.2 b/doc/man/nvme_ctrl_get_sysfs_dir.2 new file mode 100644 index 0000000..fb7973e --- /dev/null +++ b/doc/man/nvme_ctrl_get_sysfs_dir.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_sysfs_dir \- sysfs directory of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_sysfs_dir +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +sysfs directory name of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_traddr.2 b/doc/man/nvme_ctrl_get_traddr.2 new file mode 100644 index 0000000..bf6963e --- /dev/null +++ b/doc/man/nvme_ctrl_get_traddr.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_traddr \- Transport address of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_traddr +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Transport address of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_transport.2 b/doc/man/nvme_ctrl_get_transport.2 new file mode 100644 index 0000000..e7acdfa --- /dev/null +++ b/doc/man/nvme_ctrl_get_transport.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_transport \- Transport type of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_transport +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Transport type of \fIc\fP diff --git a/doc/man/nvme_ctrl_get_trsvcid.2 b/doc/man/nvme_ctrl_get_trsvcid.2 new file mode 100644 index 0000000..b889a6c --- /dev/null +++ b/doc/man/nvme_ctrl_get_trsvcid.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_trsvcid \- Transport service identifier of a controller +.SH SYNOPSIS +.B "const char *" nvme_ctrl_get_trsvcid +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Transport service identifier of \fIc\fP (if present) diff --git a/doc/man/nvme_ctrl_identify.2 b/doc/man/nvme_ctrl_identify.2 new file mode 100644 index 0000000..1bd849a --- /dev/null +++ b/doc/man/nvme_ctrl_identify.2 @@ -0,0 +1,17 @@ +.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_identify \- Issues an 'identify controller' command +.SH SYNOPSIS +.B "int" nvme_ctrl_identify +.BI "(nvme_ctrl_t c " "," +.BI "struct nvme_id_ctrl *id " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "id" 12 +Identify controller data structure +.SH "DESCRIPTION" +Issues an 'identify controller' command to \fIc\fP and copies the +data into \fIid\fP. +.SH "RETURN" +0 on success or -1 on failure. diff --git a/doc/man/nvme_ctrl_is_discovered.2 b/doc/man/nvme_ctrl_is_discovered.2 new file mode 100644 index 0000000..70d0ebe --- /dev/null +++ b/doc/man/nvme_ctrl_is_discovered.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_is_discovered \- Returns the value of the 'discovered' flag +.SH SYNOPSIS +.B "bool" nvme_ctrl_is_discovered +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Value of the 'discovered' flag of \fIc\fP diff --git a/doc/man/nvme_ctrl_is_discovery_ctrl.2 b/doc/man/nvme_ctrl_is_discovery_ctrl.2 new file mode 100644 index 0000000..2255323 --- /dev/null +++ b/doc/man/nvme_ctrl_is_discovery_ctrl.2 @@ -0,0 +1,14 @@ +.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_is_discovery_ctrl \- Check the 'discovery_ctrl' flag +.SH SYNOPSIS +.B "bool" nvme_ctrl_is_discovery_ctrl +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller to be checked +.SH "DESCRIPTION" +Returns the value of the 'discovery_ctrl' flag which specifies whether +\fIc\fP connects to a discovery subsystem. +.SH "RETURN" +Value of the 'discover_ctrl' flag diff --git a/doc/man/nvme_ctrl_is_persistent.2 b/doc/man/nvme_ctrl_is_persistent.2 new file mode 100644 index 0000000..9af269c --- /dev/null +++ b/doc/man/nvme_ctrl_is_persistent.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_is_persistent \- Returns the value of the 'persistent' flag +.SH SYNOPSIS +.B "bool" nvme_ctrl_is_persistent +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "RETURN" +Value of the 'persistent' flag of \fIc\fP diff --git a/doc/man/nvme_ctrl_list.2 b/doc/man/nvme_ctrl_list.2 new file mode 100644 index 0000000..85e11af --- /dev/null +++ b/doc/man/nvme_ctrl_list.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_ctrl_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ctrl_list \- +.SH SYNOPSIS +struct nvme_ctrl_list { +.br +.BI " __le16 num;" +.br +.BI " __le16 identifier[NVME_ID_CTRL_LIST_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "num" 12 +Number of Identifiers +.IP "identifier" 12 +NVM subsystem unique controller identifier diff --git a/doc/man/nvme_ctrl_metadata_type.2 b/doc/man/nvme_ctrl_metadata_type.2 new file mode 100644 index 0000000..eed88d8 --- /dev/null +++ b/doc/man/nvme_ctrl_metadata_type.2 @@ -0,0 +1,108 @@ +.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ctrl_metadata_type \- Controller Metadata Element Types +.SH SYNOPSIS +enum nvme_ctrl_metadata_type { +.br +.BI " NVME_CTRL_METADATA_OS_CTRL_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_OS_DRIVER_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_OS_DRIVER_VER" +, +.br +.br +.BI " NVME_CTRL_METADATA_PRE_BOOT_CTRL_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_PRE_BOOT_DRIVER_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_PRE_BOOT_DRIVER_VER" +, +.br +.br +.BI " NVME_CTRL_METADATA_SYS_PROC_MODEL" +, +.br +.br +.BI " NVME_CTRL_METADATA_CHIPSET_DRV_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_CHIPSET_DRV_VERSION" +, +.br +.br +.BI " NVME_CTRL_METADATA_OS_NAME_AND_BUILD" +, +.br +.br +.BI " NVME_CTRL_METADATA_SYS_PROD_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_FIRMWARE_VERSION" +, +.br +.br +.BI " NVME_CTRL_METADATA_OS_DRIVER_FILENAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_DISPLAY_DRV_NAME" +, +.br +.br +.BI " NVME_CTRL_METADATA_DISPLAY_DRV_VERSION" +, +.br +.br +.BI " NVME_CTRL_METADATA_HOST_DET_FAIL_REC" + +}; +.SH Constants +.IP "NVME_CTRL_METADATA_OS_CTRL_NAME" 12 +Name of the controller in +the operating system. +.IP "NVME_CTRL_METADATA_OS_DRIVER_NAME" 12 +Name of the driver in the +operating system. +.IP "NVME_CTRL_METADATA_OS_DRIVER_VER" 12 +Version of the driver in +the operating system. +.IP "NVME_CTRL_METADATA_PRE_BOOT_CTRL_NAME" 12 +Name of the controller in +the pre-boot environment. +.IP "NVME_CTRL_METADATA_PRE_BOOT_DRIVER_NAME" 12 +Name of the driver in the +pre-boot environment. +.IP "NVME_CTRL_METADATA_PRE_BOOT_DRIVER_VER" 12 +Version of the driver in the +pre-boot environment. +.IP "NVME_CTRL_METADATA_SYS_PROC_MODEL" 12 +Model of the processor. +.IP "NVME_CTRL_METADATA_CHIPSET_DRV_NAME" 12 +Chipset driver name. +.IP "NVME_CTRL_METADATA_CHIPSET_DRV_VERSION" 12 +Chipsset driver version. +.IP "NVME_CTRL_METADATA_OS_NAME_AND_BUILD" 12 +Operating system name and build. +.IP "NVME_CTRL_METADATA_SYS_PROD_NAME" 12 +System product name. +.IP "NVME_CTRL_METADATA_FIRMWARE_VERSION" 12 +Host firmware (e.g UEFI) version. +.IP "NVME_CTRL_METADATA_OS_DRIVER_FILENAME" 12 +Operating system driver filename. +.IP "NVME_CTRL_METADATA_DISPLAY_DRV_NAME" 12 +Display driver name. +.IP "NVME_CTRL_METADATA_DISPLAY_DRV_VERSION" 12 +Display driver version. +.IP "NVME_CTRL_METADATA_HOST_DET_FAIL_REC" 12 +Failure record. diff --git a/doc/man/nvme_ctrl_next_ns.2 b/doc/man/nvme_ctrl_next_ns.2 new file mode 100644 index 0000000..194dcfc --- /dev/null +++ b/doc/man/nvme_ctrl_next_ns.2 @@ -0,0 +1,14 @@ +.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_next_ns \- Next namespace iterator +.SH SYNOPSIS +.B "nvme_ns_t" nvme_ctrl_next_ns +.BI "(nvme_ctrl_t c " "," +.BI "nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "n" 12 +Previous nvme_ns_t iterator +.SH "RETURN" +Next nvme_ns_t object of an \fIc\fP iterator diff --git a/doc/man/nvme_ctrl_next_path.2 b/doc/man/nvme_ctrl_next_path.2 new file mode 100644 index 0000000..b494a73 --- /dev/null +++ b/doc/man/nvme_ctrl_next_path.2 @@ -0,0 +1,14 @@ +.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_next_path \- Next path iterator +.SH SYNOPSIS +.B "nvme_path_t" nvme_ctrl_next_path +.BI "(nvme_ctrl_t c " "," +.BI "nvme_path_t p " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "p" 12 +Previous \fInvme_path_t\fP object of an \fIc\fP iterator +.SH "RETURN" +Next \fInvme_path_t\fP object of an \fIc\fP iterator diff --git a/doc/man/nvme_ctrl_reset.2 b/doc/man/nvme_ctrl_reset.2 new file mode 100644 index 0000000..4912171 --- /dev/null +++ b/doc/man/nvme_ctrl_reset.2 @@ -0,0 +1,13 @@ +.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_reset \- Initiate a controller reset +.SH SYNOPSIS +.B "int" nvme_ctrl_reset +.BI "(int fd " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.SH "DESCRIPTION" +This should only be sent to controller handles, not to namespaces. +.SH "RETURN" +0 if a reset was initiated or -1 with errno set otherwise. diff --git a/doc/man/nvme_ctrl_set_dhchap_key.2 b/doc/man/nvme_ctrl_set_dhchap_key.2 new file mode 100644 index 0000000..0e02292 --- /dev/null +++ b/doc/man/nvme_ctrl_set_dhchap_key.2 @@ -0,0 +1,12 @@ +.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_set_dhchap_key \- Set controller key +.SH SYNOPSIS +.B "void" nvme_ctrl_set_dhchap_key +.BI "(nvme_ctrl_t c " "," +.BI "const char *key " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller for which the key should be set +.IP "key" 12 +DH-HMAC-CHAP Key to set or NULL to clear existing key diff --git a/doc/man/nvme_ctrl_set_discovered.2 b/doc/man/nvme_ctrl_set_discovered.2 new file mode 100644 index 0000000..f895e51 --- /dev/null +++ b/doc/man/nvme_ctrl_set_discovered.2 @@ -0,0 +1,14 @@ +.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_set_discovered \- Set the 'discovered' flag +.SH SYNOPSIS +.B "void" nvme_ctrl_set_discovered +.BI "(nvme_ctrl_t c " "," +.BI "bool discovered " ");" +.SH ARGUMENTS +.IP "c" 12 +nvme_ctrl_t object +.IP "discovered" 12 +Value of the 'discovered' flag +.SH "DESCRIPTION" +Set the 'discovered' flag of \fIc\fP to \fIdiscovered\fP diff --git a/doc/man/nvme_ctrl_set_discovery_ctrl.2 b/doc/man/nvme_ctrl_set_discovery_ctrl.2 new file mode 100644 index 0000000..824d201 --- /dev/null +++ b/doc/man/nvme_ctrl_set_discovery_ctrl.2 @@ -0,0 +1,15 @@ +.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_set_discovery_ctrl \- Set the 'discovery_ctrl' flag +.SH SYNOPSIS +.B "void" nvme_ctrl_set_discovery_ctrl +.BI "(nvme_ctrl_t c " "," +.BI "bool discovery " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller to be modified +.IP "discovery" 12 +value of the discovery_ctrl flag +.SH "DESCRIPTION" +Sets the 'discovery_ctrl' flag in \fIc\fP to specify whether +\fIc\fP connects to a discovery subsystem. diff --git a/doc/man/nvme_ctrl_set_persistent.2 b/doc/man/nvme_ctrl_set_persistent.2 new file mode 100644 index 0000000..6d70b36 --- /dev/null +++ b/doc/man/nvme_ctrl_set_persistent.2 @@ -0,0 +1,14 @@ +.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_set_persistent \- Set the 'persistent' flag +.SH SYNOPSIS +.B "void" nvme_ctrl_set_persistent +.BI "(nvme_ctrl_t c " "," +.BI "bool persistent " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "persistent" 12 +value of the 'persistent' flag +.SH "DESCRIPTION" +Set the 'persistent' flag of \fIc\fP to \fIpersistent\fP diff --git a/doc/man/nvme_ctrls_filter.2 b/doc/man/nvme_ctrls_filter.2 new file mode 100644 index 0000000..59aeaaf --- /dev/null +++ b/doc/man/nvme_ctrls_filter.2 @@ -0,0 +1,11 @@ +.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ctrls_filter \- Filter for controllers +.SH SYNOPSIS +.B "int" nvme_ctrls_filter +.BI "(const struct dirent *d " ");" +.SH ARGUMENTS +.IP "d" 12 +dirent to check +.SH "RETURN" +1 if \fId\fP matches, 0 otherwise diff --git a/doc/man/nvme_default_host.2 b/doc/man/nvme_default_host.2 new file mode 100644 index 0000000..73ebb07 --- /dev/null +++ b/doc/man/nvme_default_host.2 @@ -0,0 +1,14 @@ +.TH "nvme_default_host" 9 "nvme_default_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_default_host \- Initializes the default host +.SH SYNOPSIS +.B "nvme_host_t" nvme_default_host +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.SH "DESCRIPTION" +Initializes the default host object based on the values in +/etc/nvme/hostnqn and /etc/nvme/hostid and attaches it to \fIr\fP. +.SH "RETURN" +\fInvme_host_t\fP object diff --git a/doc/man/nvme_dev_self_test.2 b/doc/man/nvme_dev_self_test.2 new file mode 100644 index 0000000..b0d6d9e --- /dev/null +++ b/doc/man/nvme_dev_self_test.2 @@ -0,0 +1,23 @@ +.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_dev_self_test \- Start or abort a self test +.SH SYNOPSIS +.B "int" nvme_dev_self_test +.BI "(struct nvme_dev_self_test_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_dev_self_test\fP argument structure +.SH "DESCRIPTION" +The Device Self-test command starts a device self-test operation or abort a +device self-test operation. A device self-test operation is a diagnostic +testing sequence that tests the integrity and functionality of the +controller and may include testing of the media associated with namespaces. +The controller may return a response to this command immediately while +running the self-test in the background. + +Set the 'nsid' field to 0 to not include namepsaces in the test. Set to +0xffffffff to test all namespaces. All other values tests a specific +namespace, if present. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_dev_self_test_args.2 b/doc/man/nvme_dev_self_test_args.2 new file mode 100644 index 0000000..a8cfb35 --- /dev/null +++ b/doc/man/nvme_dev_self_test_args.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_dev_self_test_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_dev_self_test_args \- Arguments for the NVMe Device Self Test command +.SH SYNOPSIS +struct nvme_dev_self_test_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_dst_stc stc;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_dev_self_test_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID to test +.IP "stc" 12 +Self test code, see \fIenum nvme_dst_stc\fP diff --git a/doc/man/nvme_dim_args.2 b/doc/man/nvme_dim_args.2 new file mode 100644 index 0000000..8a674eb --- /dev/null +++ b/doc/man/nvme_dim_args.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_dim_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_dim_args \- Arguments for the Discovery Information Management (DIM) command +.SH SYNOPSIS +struct nvme_dim_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 data_len;" +.br +.BI " __u8 tas;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +Set on completion to the command's CQE DWORD 0 controller response. +.IP "data" 12 +Pointer to the DIM data +.IP "args_size" 12 +Length of the structure +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "data_len" 12 +Length of \fIdata\fP +.IP "tas" 12 +Task field of the Command Dword 10 (cdw10) diff --git a/doc/man/nvme_directive_dtype.2 b/doc/man/nvme_directive_dtype.2 new file mode 100644 index 0000000..e50bc32 --- /dev/null +++ b/doc/man/nvme_directive_dtype.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_directive_dtype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_directive_dtype \- +.SH SYNOPSIS +enum nvme_directive_dtype { +.br +.BI " NVME_DIRECTIVE_DTYPE_IDENTIFY" +, +.br +.br +.BI " NVME_DIRECTIVE_DTYPE_STREAMS" + +}; +.SH Constants +.IP "NVME_DIRECTIVE_DTYPE_IDENTIFY" 12 +Identify directive type +.IP "NVME_DIRECTIVE_DTYPE_STREAMS" 12 +Streams directive type diff --git a/doc/man/nvme_directive_receive_doper.2 b/doc/man/nvme_directive_receive_doper.2 new file mode 100644 index 0000000..0095be2 --- /dev/null +++ b/doc/man/nvme_directive_receive_doper.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_directive_receive_doper" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_directive_receive_doper \- +.SH SYNOPSIS +enum nvme_directive_receive_doper { +.br +.BI " NVME_DIRECTIVE_RECEIVE_IDENTIFY_DOPER_PARAM" +, +.br +.br +.BI " NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_PARAM" +, +.br +.br +.BI " NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_STATUS" +, +.br +.br +.BI " NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_RESOURCE" + +}; +.SH Constants +.IP "NVME_DIRECTIVE_RECEIVE_IDENTIFY_DOPER_PARAM" 12 +.IP "NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_PARAM" 12 +.IP "NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_STATUS" 12 +.IP "NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_RESOURCE" 12 diff --git a/doc/man/nvme_directive_recv.2 b/doc/man/nvme_directive_recv.2 new file mode 100644 index 0000000..ae3802e --- /dev/null +++ b/doc/man/nvme_directive_recv.2 @@ -0,0 +1,12 @@ +.TH "nvme_directive_recv" 9 "nvme_directive_recv" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_recv \- Receive directive specific data +.SH SYNOPSIS +.B "int" nvme_directive_recv +.BI "(struct nvme_directive_recv_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_directive_recv_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_recv_args.2 b/doc/man/nvme_directive_recv_args.2 new file mode 100644 index 0000000..83345ef --- /dev/null +++ b/doc/man/nvme_directive_recv_args.2 @@ -0,0 +1,55 @@ +.TH "libnvme" 9 "struct nvme_directive_recv_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_directive_recv_args \- Arguments for the NVMe Directive Receive command +.SH SYNOPSIS +struct nvme_directive_recv_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_directive_receive_doper doper;" +.br +.BI " enum nvme_directive_dtype dtype;" +.br +.BI " __u32 cdw12;" +.br +.BI " __u32 data_len;" +.br +.BI " __u16 dspec;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +If successful, the CQE dword0 value +.IP "data" 12 +Usespace address of data payload +.IP "args_size" 12 +Size of \fIstruct nvme_directive_recv_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID, if applicable +.IP "doper" 12 +Directive send operation, see \fIenum nvme_directive_send_doper\fP +.IP "dtype" 12 +Directive type, see \fIenum nvme_directive_dtype\fP +.IP "cdw12" 12 +Directive specific command dword12 +.IP "data_len" 12 +Length of data payload in bytes +.IP "dspec" 12 +Directive specific field diff --git a/doc/man/nvme_directive_recv_identify_parameters.2 b/doc/man/nvme_directive_recv_identify_parameters.2 new file mode 100644 index 0000000..d067edc --- /dev/null +++ b/doc/man/nvme_directive_recv_identify_parameters.2 @@ -0,0 +1,18 @@ +.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_recv_identify_parameters \- +.SH SYNOPSIS +.B "int" nvme_directive_recv_identify_parameters +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_id_directives *id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "id" 12 +Identify parameters buffer +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_recv_stream_allocate.2 b/doc/man/nvme_directive_recv_stream_allocate.2 new file mode 100644 index 0000000..24057ec --- /dev/null +++ b/doc/man/nvme_directive_recv_stream_allocate.2 @@ -0,0 +1,21 @@ +.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_recv_stream_allocate \- +.SH SYNOPSIS +.B "int" nvme_directive_recv_stream_allocate +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 nsr " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "nsr" 12 +Namespace Streams Requested +.IP "result" 12 +If successful, the CQE dword0 value +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_recv_stream_parameters.2 b/doc/man/nvme_directive_recv_stream_parameters.2 new file mode 100644 index 0000000..fdcdec6 --- /dev/null +++ b/doc/man/nvme_directive_recv_stream_parameters.2 @@ -0,0 +1,18 @@ +.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_recv_stream_parameters \- +.SH SYNOPSIS +.B "int" nvme_directive_recv_stream_parameters +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_streams_directive_params *parms " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "parms" 12 +Streams directive parameters buffer +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_recv_stream_status.2 b/doc/man/nvme_directive_recv_stream_status.2 new file mode 100644 index 0000000..d3b20f2 --- /dev/null +++ b/doc/man/nvme_directive_recv_stream_status.2 @@ -0,0 +1,21 @@ +.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_recv_stream_status \- +.SH SYNOPSIS +.B "int" nvme_directive_recv_stream_status +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "unsigned nr_entries " "," +.BI "struct nvme_streams_directive_status *id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "nr_entries" 12 +Number of streams to receive +.IP "id" 12 +Stream status buffer +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_send.2 b/doc/man/nvme_directive_send.2 new file mode 100644 index 0000000..af9d0fc --- /dev/null +++ b/doc/man/nvme_directive_send.2 @@ -0,0 +1,18 @@ +.TH "nvme_directive_send" 9 "nvme_directive_send" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_send \- Send directive command +.SH SYNOPSIS +.B "int" nvme_directive_send +.BI "(struct nvme_directive_send_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_directive_send_args\fP argument structure +.SH "DESCRIPTION" +Directives is a mechanism to enable host and NVM subsystem or controller +information exchange. The Directive Send command transfers data related to a +specific Directive Type from the host to the controller. + +See the NVMe specification for more information. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_send_args.2 b/doc/man/nvme_directive_send_args.2 new file mode 100644 index 0000000..d8de887 --- /dev/null +++ b/doc/man/nvme_directive_send_args.2 @@ -0,0 +1,55 @@ +.TH "libnvme" 9 "struct nvme_directive_send_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_directive_send_args \- Arguments for the NVMe Directive Send command +.SH SYNOPSIS +struct nvme_directive_send_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_directive_send_doper doper;" +.br +.BI " enum nvme_directive_dtype dtype;" +.br +.BI " __u32 cdw12;" +.br +.BI " __u32 data_len;" +.br +.BI " __u16 dspec;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +If successful, the CQE dword0 value +.IP "data" 12 +Data payload to to be send +.IP "args_size" 12 +Size of \fIstruct nvme_directive_send_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID, if applicable +.IP "doper" 12 +Directive send operation, see \fIenum nvme_directive_send_doper\fP +.IP "dtype" 12 +Directive type, see \fIenum nvme_directive_dtype\fP +.IP "cdw12" 12 +Directive specific command dword12 +.IP "data_len" 12 +Length of data payload in bytes +.IP "dspec" 12 +Directive specific field diff --git a/doc/man/nvme_directive_send_doper.2 b/doc/man/nvme_directive_send_doper.2 new file mode 100644 index 0000000..4d3ece1 --- /dev/null +++ b/doc/man/nvme_directive_send_doper.2 @@ -0,0 +1,21 @@ +.TH "libnvme" 9 "enum nvme_directive_send_doper" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_directive_send_doper \- +.SH SYNOPSIS +enum nvme_directive_send_doper { +.br +.BI " NVME_DIRECTIVE_SEND_IDENTIFY_DOPER_ENDIR" +, +.br +.br +.BI " NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_IDENTIFIER" +, +.br +.br +.BI " NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_RESOURCE" + +}; +.SH Constants +.IP "NVME_DIRECTIVE_SEND_IDENTIFY_DOPER_ENDIR" 12 +.IP "NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_IDENTIFIER" 12 +.IP "NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_RESOURCE" 12 diff --git a/doc/man/nvme_directive_send_id_endir.2 b/doc/man/nvme_directive_send_id_endir.2 new file mode 100644 index 0000000..c3b31ee --- /dev/null +++ b/doc/man/nvme_directive_send_id_endir.2 @@ -0,0 +1,24 @@ +.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_send_id_endir \- +.SH SYNOPSIS +.B "int" nvme_directive_send_id_endir +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "bool endir " "," +.BI "enum nvme_directive_dtype dtype " "," +.BI "struct nvme_id_directives *id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace Identifier +.IP "endir" 12 +Enable Directive +.IP "dtype" 12 +Directive Type +.IP "id" 12 +Pointer to structure nvme_id_directives +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_send_identify_endir.2 b/doc/man/nvme_directive_send_identify_endir.2 new file mode 100644 index 0000000..f6cb007 --- /dev/null +++ b/doc/man/nvme_directive_send_identify_endir.2 @@ -0,0 +1,16 @@ +.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_directive_send_identify_endir \- +.SH SYNOPSIS +enum nvme_directive_send_identify_endir { +.br +.BI " NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_DISABLE" +, +.br +.br +.BI " NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_ENABLE" + +}; +.SH Constants +.IP "NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_DISABLE" 12 +.IP "NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_ENABLE" 12 diff --git a/doc/man/nvme_directive_send_stream_release_identifier.2 b/doc/man/nvme_directive_send_stream_release_identifier.2 new file mode 100644 index 0000000..9768cd6 --- /dev/null +++ b/doc/man/nvme_directive_send_stream_release_identifier.2 @@ -0,0 +1,18 @@ +.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_send_stream_release_identifier \- +.SH SYNOPSIS +.B "int" nvme_directive_send_stream_release_identifier +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 stream_id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "stream_id" 12 +Stream identifier +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_send_stream_release_resource.2 b/doc/man/nvme_directive_send_stream_release_resource.2 new file mode 100644 index 0000000..32ebab4 --- /dev/null +++ b/doc/man/nvme_directive_send_stream_release_resource.2 @@ -0,0 +1,15 @@ +.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_directive_send_stream_release_resource \- +.SH SYNOPSIS +.B "int" nvme_directive_send_stream_release_resource +.BI "(int fd " "," +.BI "__u32 nsid " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_directive_types.2 b/doc/man/nvme_directive_types.2 new file mode 100644 index 0000000..aa2e48c --- /dev/null +++ b/doc/man/nvme_directive_types.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_directive_types" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_directive_types \- +.SH SYNOPSIS +enum nvme_directive_types { +.br +.BI " NVME_ID_DIR_ID_BIT" +, +.br +.br +.BI " NVME_ID_DIR_SD_BIT" + +}; +.SH Constants +.IP "NVME_ID_DIR_ID_BIT" 12 +Identify directive is supported +.IP "NVME_ID_DIR_SD_BIT" 12 +Streams directive is supported diff --git a/doc/man/nvme_disconnect_ctrl.2 b/doc/man/nvme_disconnect_ctrl.2 new file mode 100644 index 0000000..35a8a0a --- /dev/null +++ b/doc/man/nvme_disconnect_ctrl.2 @@ -0,0 +1,13 @@ +.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_disconnect_ctrl \- Disconnect a controller +.SH SYNOPSIS +.B "int" nvme_disconnect_ctrl +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "DESCRIPTION" +Issues a 'disconnect' fabrics command to \fIc\fP +.SH "RETURN" +0 on success, -1 on failure. diff --git a/doc/man/nvme_dsm.2 b/doc/man/nvme_dsm.2 new file mode 100644 index 0000000..4803104 --- /dev/null +++ b/doc/man/nvme_dsm.2 @@ -0,0 +1,18 @@ +.TH "nvme_dsm" 9 "nvme_dsm" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_dsm \- Send an nvme data set management command +.SH SYNOPSIS +.B "int" nvme_dsm +.BI "(struct nvme_dsm_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_dsm_args\fP argument structure +.SH "DESCRIPTION" +The Dataset Management command is used by the host to indicate attributes +for ranges of logical blocks. This includes attributes like frequency that +data is read or written, access size, and other information that may be used +to optimize performance and reliability, and may be used to +deallocate/unmap/trim those logical blocks. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_dsm_args.2 b/doc/man/nvme_dsm_args.2 new file mode 100644 index 0000000..bb4f645 --- /dev/null +++ b/doc/man/nvme_dsm_args.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "struct nvme_dsm_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_dsm_args \- Arguments for the NVMe Dataset Management command +.SH SYNOPSIS +struct nvme_dsm_args { +.br +.BI " __u32 *result;" +.br +.BI " struct nvme_dsm_range *dsm;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 attrs;" +.br +.BI " __u16 nr_ranges;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "dsm" 12 +The data set management attributes +.IP "args_size" 12 +Size of \fIstruct nvme_dsm_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "attrs" 12 +DSM attributes, see \fIenum nvme_dsm_attributes\fP +.IP "nr_ranges" 12 +Number of block ranges in the data set management attributes diff --git a/doc/man/nvme_dsm_attributes.2 b/doc/man/nvme_dsm_attributes.2 new file mode 100644 index 0000000..1814d87 --- /dev/null +++ b/doc/man/nvme_dsm_attributes.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_dsm_attributes" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_dsm_attributes \- +.SH SYNOPSIS +enum nvme_dsm_attributes { +.br +.BI " NVME_DSMGMT_IDR" +, +.br +.br +.BI " NVME_DSMGMT_IDW" +, +.br +.br +.BI " NVME_DSMGMT_AD" + +}; +.SH Constants +.IP "NVME_DSMGMT_IDR" 12 +Attribute – Integral Dataset for Read +.IP "NVME_DSMGMT_IDW" 12 +Attribute – Integral Dataset for Write +.IP "NVME_DSMGMT_AD" 12 +Attribute – Deallocate diff --git a/doc/man/nvme_dsm_range.2 b/doc/man/nvme_dsm_range.2 new file mode 100644 index 0000000..1edd263 --- /dev/null +++ b/doc/man/nvme_dsm_range.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_dsm_range" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_dsm_range \- +.SH SYNOPSIS +struct nvme_dsm_range { +.br +.BI " __le32 cattr;" +.br +.BI " __le32 nlb;" +.br +.BI " __le64 slba;" +.br +.BI " +}; +.br + +.SH Members +.IP "cattr" 12 +Context Attributes +.IP "nlb" 12 +Length in logical blocks +.IP "slba" 12 +Starting LBA diff --git a/doc/man/nvme_dst_stc.2 b/doc/man/nvme_dst_stc.2 new file mode 100644 index 0000000..991a171 --- /dev/null +++ b/doc/man/nvme_dst_stc.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_dst_stc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_dst_stc \- Action taken by the Device Self-test command +.SH SYNOPSIS +enum nvme_dst_stc { +.br +.BI " NVME_DST_STC_SHORT" +, +.br +.br +.BI " NVME_DST_STC_LONG" +, +.br +.br +.BI " NVME_DST_STC_VS" +, +.br +.br +.BI " NVME_DST_STC_ABORT" + +}; +.SH Constants +.IP "NVME_DST_STC_SHORT" 12 +Start a short device self-test operation +.IP "NVME_DST_STC_LONG" 12 +Start an extended device self-test operation +.IP "NVME_DST_STC_VS" 12 +Start a vendor specific device self-test operation +.IP "NVME_DST_STC_ABORT" 12 +Abort device self-test operation diff --git a/doc/man/nvme_dump_config.2 b/doc/man/nvme_dump_config.2 new file mode 100644 index 0000000..d3e9f1f --- /dev/null +++ b/doc/man/nvme_dump_config.2 @@ -0,0 +1,14 @@ +.TH "nvme_dump_config" 9 "nvme_dump_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_dump_config \- Print the JSON configuration +.SH SYNOPSIS +.B "int" nvme_dump_config +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.SH "DESCRIPTION" +Prints the current contents of the JSON configuration +file to stdout. +.SH "RETURN" +0 on success, -1 on failure. diff --git a/doc/man/nvme_dump_tree.2 b/doc/man/nvme_dump_tree.2 new file mode 100644 index 0000000..505f94c --- /dev/null +++ b/doc/man/nvme_dump_tree.2 @@ -0,0 +1,14 @@ +.TH "nvme_dump_tree" 9 "nvme_dump_tree" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_dump_tree \- Dump internal object tree +.SH SYNOPSIS +.B "int" nvme_dump_tree +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.SH "DESCRIPTION" +Prints the internal object tree in JSON format +to stdout. +.SH "RETURN" +0 on success, -1 on failure. diff --git a/doc/man/nvme_eg_critical_warning_flags.2 b/doc/man/nvme_eg_critical_warning_flags.2 new file mode 100644 index 0000000..ec2a3ff --- /dev/null +++ b/doc/man/nvme_eg_critical_warning_flags.2 @@ -0,0 +1,21 @@ +.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_eg_critical_warning_flags \- +.SH SYNOPSIS +enum nvme_eg_critical_warning_flags { +.br +.BI " NVME_EG_CRITICAL_WARNING_SPARE" +, +.br +.br +.BI " NVME_EG_CRITICAL_WARNING_DEGRADED" +, +.br +.br +.BI " NVME_EG_CRITICAL_WARNING_READ_ONLY" + +}; +.SH Constants +.IP "NVME_EG_CRITICAL_WARNING_SPARE" 12 +.IP "NVME_EG_CRITICAL_WARNING_DEGRADED" 12 +.IP "NVME_EG_CRITICAL_WARNING_READ_ONLY" 12 diff --git a/doc/man/nvme_eg_event_aggregate_log.2 b/doc/man/nvme_eg_event_aggregate_log.2 new file mode 100644 index 0000000..0546d53 --- /dev/null +++ b/doc/man/nvme_eg_event_aggregate_log.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_eg_event_aggregate_log \- +.SH SYNOPSIS +struct nvme_eg_event_aggregate_log { +.br +.BI " __le64 nr_entries;" +.br +.BI " __le16 egids[];" +.br +.BI " +}; +.br + +.SH Members +.IP "nr_entries" 12 +Number of Entries +.IP "egids" 12 +Endurance Group Identifier diff --git a/doc/man/nvme_end_grp_chan_desc.2 b/doc/man/nvme_end_grp_chan_desc.2 new file mode 100644 index 0000000..a7a810f --- /dev/null +++ b/doc/man/nvme_end_grp_chan_desc.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_end_grp_chan_desc \- +.SH SYNOPSIS +struct nvme_end_grp_chan_desc { +.br +.BI " __le16 egchans;" +.br +.BI " struct nvme_channel_config_desc chan_config_desc[];" +.br +.BI " +}; +.br + +.SH Members +.IP "egchans" 12 +Number of Channels +.SH "Description" +Endurance group Channel Configuration Descriptor +Structure Definitions diff --git a/doc/man/nvme_end_grp_config_desc.2 b/doc/man/nvme_end_grp_config_desc.2 new file mode 100644 index 0000000..b418522 --- /dev/null +++ b/doc/man/nvme_end_grp_config_desc.2 @@ -0,0 +1,46 @@ +.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_end_grp_config_desc \- +.SH SYNOPSIS +struct nvme_end_grp_config_desc { +.br +.BI " __le16 endgid;" +.br +.BI " __le16 cap_adj_factor;" +.br +.BI " __u8 rsvd4[12];" +.br +.BI " __u8 tegcap[16];" +.br +.BI " __u8 segcap[16];" +.br +.BI " __u8 end_est[16];" +.br +.BI " __u8 rsvd64[16];" +.br +.BI " __le16 egsets;" +.br +.BI " __le16 nvmsetid[];" +.br +.BI " +}; +.br + +.SH Members +.IP "endgid" 12 +Endurance Group Identifier +.IP "cap_adj_factor" 12 +Capacity Adjustment Factor +.IP "tegcap" 12 +Total Endurance Group Capacity +.IP "segcap" 12 +Spare Endurance Group Capacity +.IP "end_est" 12 +Endurance Estimate +.IP "egsets" 12 +Number of NVM Sets +.IP "nvmsetid" 12 +NVM Set Identifier +.SH "Description" +Endurance Group Configuration Descriptor +Structure Definitions diff --git a/doc/man/nvme_endurance_group_log.2 b/doc/man/nvme_endurance_group_log.2 new file mode 100644 index 0000000..1ba728f --- /dev/null +++ b/doc/man/nvme_endurance_group_log.2 @@ -0,0 +1,71 @@ +.TH "libnvme" 9 "struct nvme_endurance_group_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_endurance_group_log \- +.SH SYNOPSIS +struct nvme_endurance_group_log { +.br +.BI " __u8 critical_warning;" +.br +.BI " __u8 rsvd1[2];" +.br +.BI " __u8 avl_spare;" +.br +.BI " __u8 avl_spare_threshold;" +.br +.BI " __u8 percent_used;" +.br +.BI " __u8 rsvd6[26];" +.br +.BI " __u8 endurance_estimate[16];" +.br +.BI " __u8 data_units_read[16];" +.br +.BI " __u8 data_units_written[16];" +.br +.BI " __u8 media_units_written[16];" +.br +.BI " __u8 host_read_cmds[16];" +.br +.BI " __u8 host_write_cmds[16];" +.br +.BI " __u8 media_data_integrity_err[16];" +.br +.BI " __u8 num_err_info_log_entries[16];" +.br +.BI " __u8 rsvd160[352];" +.br +.BI " +}; +.br + +.SH Members +.IP "critical_warning" 12 +Critical Warning +.IP "rsvd1" 12 +Reserved +.IP "avl_spare" 12 +Available Spare +.IP "avl_spare_threshold" 12 +Available Spare Threshold +.IP "percent_used" 12 +Percentage Used +.IP "rsvd6" 12 +Reserved +.IP "endurance_estimate" 12 +Endurance Estimate +.IP "data_units_read" 12 +Data Units Read +.IP "data_units_written" 12 +Data Units Written +.IP "media_units_written" 12 +Media Units Written +.IP "host_read_cmds" 12 +Host Read Commands +.IP "host_write_cmds" 12 +Host Write Commands +.IP "media_data_integrity_err" 12 +Media and Data Integrity Errors +.IP "num_err_info_log_entries" 12 +Number of Error Information Log Entries +.IP "rsvd160" 12 +Reserved diff --git a/doc/man/nvme_err_pel.2 b/doc/man/nvme_err_pel.2 new file mode 100644 index 0000000..e217cf7 --- /dev/null +++ b/doc/man/nvme_err_pel.2 @@ -0,0 +1,16 @@ +.TH "libnvme" 9 "enum nvme_err_pel" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_err_pel \- +.SH SYNOPSIS +enum nvme_err_pel { +.br +.BI " NVME_ERR_PEL_BYTE_MASK" +, +.br +.br +.BI " NVME_ERR_PEL_BIT_MASK" + +}; +.SH Constants +.IP "NVME_ERR_PEL_BYTE_MASK" 12 +.IP "NVME_ERR_PEL_BIT_MASK" 12 diff --git a/doc/man/nvme_errno_to_string.2 b/doc/man/nvme_errno_to_string.2 new file mode 100644 index 0000000..6e8ea1c --- /dev/null +++ b/doc/man/nvme_errno_to_string.2 @@ -0,0 +1,11 @@ +.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_errno_to_string \- Returns string describing nvme connect failures +.SH SYNOPSIS +.B "const char *" nvme_errno_to_string +.BI "(int err " ");" +.SH ARGUMENTS +.IP "err" 12 +Returned error code from \fBnvme_add_ctrl\fP +.SH "RETURN" +String representation of the nvme connect error codes diff --git a/doc/man/nvme_error_log_page.2 b/doc/man/nvme_error_log_page.2 new file mode 100644 index 0000000..f6a908c --- /dev/null +++ b/doc/man/nvme_error_log_page.2 @@ -0,0 +1,109 @@ +.TH "libnvme" 9 "struct nvme_error_log_page" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_error_log_page \- Error Information Log Entry (Log Identifier 01h) +.SH SYNOPSIS +struct nvme_error_log_page { +.br +.BI " __le64 error_count;" +.br +.BI " __le16 sqid;" +.br +.BI " __le16 cmdid;" +.br +.BI " __le16 status_field;" +.br +.BI " __le16 parm_error_location;" +.br +.BI " __le64 lba;" +.br +.BI " __le32 nsid;" +.br +.BI " __u8 vs;" +.br +.BI " __u8 trtype;" +.br +.BI " __u8 rsvd[2];" +.br +.BI " __le64 cs;" +.br +.BI " __le16 trtype_spec_info;" +.br +.BI " __u8 rsvd2[22];" +.br +.BI " +}; +.br + +.SH Members +.IP "error_count" 12 +Error Count: a 64-bit incrementing error count, +indicating a unique identifier for this error. The error +count starts at 1h, is incremented for each unique error +log entry, and is retained across power off conditions. +A value of 0h indicates an invalid entry; this value +is used when there are lost entries or when there are +fewer errors than the maximum number of entries the +controller supports. If the value of this field is +FFFFFFFFh, then the field shall be set to 1h when +incremented (i.e., rolls over to 1h). Prior to NVMe +1.4, processing of incrementing beyond FFFFFFFFh is +unspecified. +.IP "sqid" 12 +Submission Queue ID: indicates the Submission Queue +Identifier of the command that the error information is +associated with. If the error is not specific to +a particular command, then this field shall be set to +FFFFh. +.IP "cmdid" 12 +Command ID: indicates the Command Identifier of the +command that the error is associated with. If the error +is not specific to a particular command, then this field +shall be set to FFFFh. +.IP "status_field" 12 +Bits 15-1: Status Field: indicates the Status Field for +the command that completed. If the error is not specific +to a particular command, then this field reports the most +applicable status value. +Bit 0: Phase Tag: may indicate the Phase Tag posted for +the command. +.IP "parm_error_location" 12 +Parameter Error Location: indicates the byte and bit of +the command parameter that the error is associated with, +if applicable. If the parameter spans multiple bytes or +bits, then the location indicates the first byte and bit +of the parameter. +Bits 10-8: Bit in command that contained the error. +Valid values are 0 to 7. +Bits 7-0: Byte in command that contained the error. +Valid values are 0 to 63. +.IP "lba" 12 +LBA: This field indicates the first LBA that experienced +the error condition, if applicable. +.IP "nsid" 12 +Namespace: This field indicates the NSID of the namespace +that the error is associated with, if applicable. +.IP "vs" 12 +Vendor Specific Information Available: If there is +additional vendor specific error information available, +this field provides the log page identifier associated +with that page. A value of 0h indicates that no additional +information is available. Valid values are in the range +of 80h to FFh. +.IP "trtype" 12 +Transport Type (TRTYPE): indicates the Transport Type of +the transport associated with the error. The values in +this field are the same as the TRTYPE values in the +Discovery Log Page Entry. If the error is not transport +related, this field shall be cleared to 0h. If the error +is transport related, this field shall be set to the type +of the transport - see \fIenum nvme_trtype\fP. +.IP "rsvd" 12 +Reserved +.IP "cs" 12 +Command Specific Information: This field contains command +specific information. If used, the command definition +specifies the information returned. +.IP "trtype_spec_info" 12 +Transport Type Specific Information +.IP "rsvd2" 12 +Reserved diff --git a/doc/man/nvme_fabrics_config.2 b/doc/man/nvme_fabrics_config.2 new file mode 100644 index 0000000..f54377f --- /dev/null +++ b/doc/man/nvme_fabrics_config.2 @@ -0,0 +1,75 @@ +.TH "libnvme" 9 "struct nvme_fabrics_config" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_fabrics_config \- Defines all linux nvme fabrics initiator options +.SH SYNOPSIS +struct nvme_fabrics_config { +.br +.BI " char *host_traddr;" +.br +.BI " char *host_iface;" +.br +.BI " int queue_size;" +.br +.BI " int nr_io_queues;" +.br +.BI " int reconnect_delay;" +.br +.BI " int ctrl_loss_tmo;" +.br +.BI " int fast_io_fail_tmo;" +.br +.BI " int keep_alive_tmo;" +.br +.BI " int nr_write_queues;" +.br +.BI " int nr_poll_queues;" +.br +.BI " int tos;" +.br +.BI " bool duplicate_connect;" +.br +.BI " bool disable_sqflow;" +.br +.BI " bool hdr_digest;" +.br +.BI " bool data_digest;" +.br +.BI " bool tls;" +.br +.BI " +}; +.br + +.SH Members +.IP "host_traddr" 12 +Host transport address +.IP "host_iface" 12 +Host interface name +.IP "queue_size" 12 +Number of IO queue entries +.IP "nr_io_queues" 12 +Number of controller IO queues to establish +.IP "reconnect_delay" 12 +Time between two consecutive reconnect attempts. +.IP "ctrl_loss_tmo" 12 +Override the default controller reconnect attempt timeout in seconds +.IP "fast_io_fail_tmo" 12 +Set the fast I/O fail timeout in seconds. +.IP "keep_alive_tmo" 12 +Override the default keep-alive-timeout to this value in seconds +.IP "nr_write_queues" 12 +Number of queues to use for exclusively for writing +.IP "nr_poll_queues" 12 +Number of queues to reserve for polling completions +.IP "tos" 12 +Type of service +.IP "duplicate_connect" 12 +Allow multiple connections to the same target +.IP "disable_sqflow" 12 +Disable controller sq flow control +.IP "hdr_digest" 12 +Generate/verify header digest (TCP) +.IP "data_digest" 12 +Generate/verify data digest (TCP) +.IP "tls" 12 +Start TLS on the connection (TCP) diff --git a/doc/man/nvme_fctype.2 b/doc/man/nvme_fctype.2 new file mode 100644 index 0000000..560a989 --- /dev/null +++ b/doc/man/nvme_fctype.2 @@ -0,0 +1,42 @@ +.TH "libnvme" 9 "enum nvme_fctype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_fctype \- +.SH SYNOPSIS +enum nvme_fctype { +.br +.BI " nvme_fabrics_type_property_set" +, +.br +.br +.BI " nvme_fabrics_type_connect" +, +.br +.br +.BI " nvme_fabrics_type_property_get" +, +.br +.br +.BI " nvme_fabrics_type_auth_send" +, +.br +.br +.BI " nvme_fabrics_type_auth_receive" +, +.br +.br +.BI " nvme_fabrics_type_disconnect" + +}; +.SH Constants +.IP "nvme_fabrics_type_property_set" 12 +Property set +.IP "nvme_fabrics_type_connect" 12 +Connect +.IP "nvme_fabrics_type_property_get" 12 +Property Get +.IP "nvme_fabrics_type_auth_send" 12 +Authentication Send +.IP "nvme_fabrics_type_auth_receive" 12 +Authentication Receive +.IP "nvme_fabrics_type_disconnect" 12 +Disconnect diff --git a/doc/man/nvme_feat.2 b/doc/man/nvme_feat.2 new file mode 100644 index 0000000..981cd62 --- /dev/null +++ b/doc/man/nvme_feat.2 @@ -0,0 +1,496 @@ +.TH "libnvme" 9 "enum nvme_feat" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_feat \- +.SH SYNOPSIS +enum nvme_feat { +.br +.BI " NVME_FEAT_ARBITRATION_BURST_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_BURST_MASK" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_LPW_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_LPW_MASK" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_MPW_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_MPW_MASK" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_HPW_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ARBITRATION_HPW_MASK" +, +.br +.br +.BI " NVME_FEAT_PWRMGMT_PS_SHIFT" +, +.br +.br +.BI " NVME_FEAT_PWRMGMT_PS_MASK" +, +.br +.br +.BI " NVME_FEAT_PWRMGMT_WH_SHIFT" +, +.br +.br +.BI " NVME_FEAT_PWRMGMT_WH_MASK" +, +.br +.br +.BI " NVME_FEAT_LBAR_NR_SHIFT" +, +.br +.br +.BI " NVME_FEAT_LBAR_NR_MASK" +, +.br +.br +.BI " NVME_FEAT_TT_TMPTH_SHIFT" +, +.br +.br +.BI " NVME_FEAT_TT_TMPTH_MASK" +, +.br +.br +.BI " NVME_FEAT_TT_TMPSEL_SHIFT" +, +.br +.br +.BI " NVME_FEAT_TT_TMPSEL_MASK" +, +.br +.br +.BI " NVME_FEAT_TT_THSEL_SHIFT" +, +.br +.br +.BI " NVME_FEAT_TT_THSEL_MASK" +, +.br +.br +.BI " NVME_FEAT_ERROR_RECOVERY_TLER_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ERROR_RECOVERY_TLER_MASK" +, +.br +.br +.BI " NVME_FEAT_ERROR_RECOVERY_DULBE_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ERROR_RECOVERY_DULBE_MASK" +, +.br +.br +.BI " NVME_FEAT_VWC_WCE_SHIFT" +, +.br +.br +.BI " NVME_FEAT_VWC_WCE_MASK" +, +.br +.br +.BI " NVME_FEAT_NRQS_NSQR_SHIFT" +, +.br +.br +.BI " NVME_FEAT_NRQS_NSQR_MASK" +, +.br +.br +.BI " NVME_FEAT_NRQS_NCQR_SHIFT" +, +.br +.br +.BI " NVME_FEAT_NRQS_NCQR_MASK" +, +.br +.br +.BI " NVME_FEAT_IRQC_THR_SHIFT" +, +.br +.br +.BI " NVME_FEAT_IRQC_THR_MASK" +, +.br +.br +.BI " NVME_FEAT_IRQC_TIME_SHIFT" +, +.br +.br +.BI " NVME_FEAT_IRQC_TIME_MASK" +, +.br +.br +.BI " NVME_FEAT_ICFG_IV_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ICFG_IV_MASK" +, +.br +.br +.BI " NVME_FEAT_ICFG_CD_SHIFT" +, +.br +.br +.BI " NVME_FEAT_ICFG_CD_MASK" +, +.br +.br +.BI " NVME_FEAT_WA_DN_SHIFT" +, +.br +.br +.BI " NVME_FEAT_WA_DN_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_SMART_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_SMART_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_NAN_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_NAN_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_FW_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_FW_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_TELEM_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_TELEM_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_ANA_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_ANA_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_PLA_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_PLA_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_LBAS_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_LBAS_MASK" +, +.br +.br +.BI " NVME_FEAT_AE_EGA_SHIFT" +, +.br +.br +.BI " NVME_FEAT_AE_EGA_MASK" +, +.br +.br +.BI " NVME_FEAT_APST_APSTE_SHIFT" +, +.br +.br +.BI " NVME_FEAT_APST_APSTE_MASK" +, +.br +.br +.BI " NVME_FEAT_HMEM_EHM_SHIFT" +, +.br +.br +.BI " NVME_FEAT_HMEM_EHM_MASK" +, +.br +.br +.BI " NVME_FEAT_HCTM_TMT2_SHIFT" +, +.br +.br +.BI " NVME_FEAT_HCTM_TMT2_MASK" +, +.br +.br +.BI " NVME_FEAT_HCTM_TMT1_SHIFT" +, +.br +.br +.BI " NVME_FEAT_HCTM_TMT1_MASK" +, +.br +.br +.BI " NVME_FEAT_NOPS_NOPPME_SHIFT" +, +.br +.br +.BI " NVME_FEAT_NOPS_NOPPME_MASK" +, +.br +.br +.BI " NVME_FEAT_RRL_RRL_SHIFT" +, +.br +.br +.BI " NVME_FEAT_RRL_RRL_MASK" +, +.br +.br +.BI " NVME_FEAT_PLM_PLME_SHIFT" +, +.br +.br +.BI " NVME_FEAT_PLM_PLME_MASK" +, +.br +.br +.BI " NVME_FEAT_PLMW_WS_SHIFT" +, +.br +.br +.BI " NVME_FEAT_PLMW_WS_MASK" +, +.br +.br +.BI " NVME_FEAT_LBAS_LSIRI_SHIFT" +, +.br +.br +.BI " NVME_FEAT_LBAS_LSIRI_MASK" +, +.br +.br +.BI " NVME_FEAT_LBAS_LSIPI_SHIFT" +, +.br +.br +.BI " NVME_FEAT_LBAS_LSIPI_MASK" +, +.br +.br +.BI " NVME_FEAT_SC_NODRM_SHIFT" +, +.br +.br +.BI " NVME_FEAT_SC_NODRM_MASK" +, +.br +.br +.BI " NVME_FEAT_EG_ENDGID_SHIFT" +, +.br +.br +.BI " NVME_FEAT_EG_ENDGID_MASK" +, +.br +.br +.BI " NVME_FEAT_EG_EGCW_SHIFT" +, +.br +.br +.BI " NVME_FEAT_EG_EGCW_MASK" +, +.br +.br +.BI " NVME_FEAT_SPM_PBSLC_SHIFT" +, +.br +.br +.BI " NVME_FEAT_SPM_PBSLC_MASK" +, +.br +.br +.BI " NVME_FEAT_HOSTID_EXHID_SHIFT" +, +.br +.br +.BI " NVME_FEAT_HOSTID_EXHID_MASK" +, +.br +.br +.BI " NVME_FEAT_RM_REGPRE_SHIFT" +, +.br +.br +.BI " NVME_FEAT_RM_REGPRE_MASK" +, +.br +.br +.BI " NVME_FEAT_RM_RESREL_SHIFT" +, +.br +.br +.BI " NVME_FEAT_RM_RESREL_MASK" +, +.br +.br +.BI " NVME_FEAT_RM_RESPRE_SHIFT" +, +.br +.br +.BI " NVME_FEAT_RM_RESPRE_MASK" +, +.br +.br +.BI " NVME_FEAT_RP_PTPL_SHIFT" +, +.br +.br +.BI " NVME_FEAT_RP_PTPL_MASK" +, +.br +.br +.BI " NVME_FEAT_WP_WPS_SHIFT" +, +.br +.br +.BI " NVME_FEAT_WP_WPS_MASK" +, +.br +.br +.BI " NVME_FEAT_IOCSP_IOCSCI_SHIFT" +, +.br +.br +.BI " NVME_FEAT_IOCSP_IOCSCI_MASK" + +}; +.SH Constants +.IP "NVME_FEAT_ARBITRATION_BURST_SHIFT" 12 +.IP "NVME_FEAT_ARBITRATION_BURST_MASK" 12 +.IP "NVME_FEAT_ARBITRATION_LPW_SHIFT" 12 +.IP "NVME_FEAT_ARBITRATION_LPW_MASK" 12 +.IP "NVME_FEAT_ARBITRATION_MPW_SHIFT" 12 +.IP "NVME_FEAT_ARBITRATION_MPW_MASK" 12 +.IP "NVME_FEAT_ARBITRATION_HPW_SHIFT" 12 +.IP "NVME_FEAT_ARBITRATION_HPW_MASK" 12 +.IP "NVME_FEAT_PWRMGMT_PS_SHIFT" 12 +.IP "NVME_FEAT_PWRMGMT_PS_MASK" 12 +.IP "NVME_FEAT_PWRMGMT_WH_SHIFT" 12 +.IP "NVME_FEAT_PWRMGMT_WH_MASK" 12 +.IP "NVME_FEAT_LBAR_NR_SHIFT" 12 +.IP "NVME_FEAT_LBAR_NR_MASK" 12 +.IP "NVME_FEAT_TT_TMPTH_SHIFT" 12 +.IP "NVME_FEAT_TT_TMPTH_MASK" 12 +.IP "NVME_FEAT_TT_TMPSEL_SHIFT" 12 +.IP "NVME_FEAT_TT_TMPSEL_MASK" 12 +.IP "NVME_FEAT_TT_THSEL_SHIFT" 12 +.IP "NVME_FEAT_TT_THSEL_MASK" 12 +.IP "NVME_FEAT_ERROR_RECOVERY_TLER_SHIFT" 12 +.IP "NVME_FEAT_ERROR_RECOVERY_TLER_MASK" 12 +.IP "NVME_FEAT_ERROR_RECOVERY_DULBE_SHIFT" 12 +.IP "NVME_FEAT_ERROR_RECOVERY_DULBE_MASK" 12 +.IP "NVME_FEAT_VWC_WCE_SHIFT" 12 +.IP "NVME_FEAT_VWC_WCE_MASK" 12 +.IP "NVME_FEAT_NRQS_NSQR_SHIFT" 12 +.IP "NVME_FEAT_NRQS_NSQR_MASK" 12 +.IP "NVME_FEAT_NRQS_NCQR_SHIFT" 12 +.IP "NVME_FEAT_NRQS_NCQR_MASK" 12 +.IP "NVME_FEAT_IRQC_THR_SHIFT" 12 +.IP "NVME_FEAT_IRQC_THR_MASK" 12 +.IP "NVME_FEAT_IRQC_TIME_SHIFT" 12 +.IP "NVME_FEAT_IRQC_TIME_MASK" 12 +.IP "NVME_FEAT_ICFG_IV_SHIFT" 12 +.IP "NVME_FEAT_ICFG_IV_MASK" 12 +.IP "NVME_FEAT_ICFG_CD_SHIFT" 12 +.IP "NVME_FEAT_ICFG_CD_MASK" 12 +.IP "NVME_FEAT_WA_DN_SHIFT" 12 +.IP "NVME_FEAT_WA_DN_MASK" 12 +.IP "NVME_FEAT_AE_SMART_SHIFT" 12 +.IP "NVME_FEAT_AE_SMART_MASK" 12 +.IP "NVME_FEAT_AE_NAN_SHIFT" 12 +.IP "NVME_FEAT_AE_NAN_MASK" 12 +.IP "NVME_FEAT_AE_FW_SHIFT" 12 +.IP "NVME_FEAT_AE_FW_MASK" 12 +.IP "NVME_FEAT_AE_TELEM_SHIFT" 12 +.IP "NVME_FEAT_AE_TELEM_MASK" 12 +.IP "NVME_FEAT_AE_ANA_SHIFT" 12 +.IP "NVME_FEAT_AE_ANA_MASK" 12 +.IP "NVME_FEAT_AE_PLA_SHIFT" 12 +.IP "NVME_FEAT_AE_PLA_MASK" 12 +.IP "NVME_FEAT_AE_LBAS_SHIFT" 12 +.IP "NVME_FEAT_AE_LBAS_MASK" 12 +.IP "NVME_FEAT_AE_EGA_SHIFT" 12 +.IP "NVME_FEAT_AE_EGA_MASK" 12 +.IP "NVME_FEAT_APST_APSTE_SHIFT" 12 +.IP "NVME_FEAT_APST_APSTE_MASK" 12 +.IP "NVME_FEAT_HMEM_EHM_SHIFT" 12 +.IP "NVME_FEAT_HMEM_EHM_MASK" 12 +.IP "NVME_FEAT_HCTM_TMT2_SHIFT" 12 +.IP "NVME_FEAT_HCTM_TMT2_MASK" 12 +.IP "NVME_FEAT_HCTM_TMT1_SHIFT" 12 +.IP "NVME_FEAT_HCTM_TMT1_MASK" 12 +.IP "NVME_FEAT_NOPS_NOPPME_SHIFT" 12 +.IP "NVME_FEAT_NOPS_NOPPME_MASK" 12 +.IP "NVME_FEAT_RRL_RRL_SHIFT" 12 +.IP "NVME_FEAT_RRL_RRL_MASK" 12 +.IP "NVME_FEAT_PLM_PLME_SHIFT" 12 +.IP "NVME_FEAT_PLM_PLME_MASK" 12 +.IP "NVME_FEAT_PLMW_WS_SHIFT" 12 +.IP "NVME_FEAT_PLMW_WS_MASK" 12 +.IP "NVME_FEAT_LBAS_LSIRI_SHIFT" 12 +.IP "NVME_FEAT_LBAS_LSIRI_MASK" 12 +.IP "NVME_FEAT_LBAS_LSIPI_SHIFT" 12 +.IP "NVME_FEAT_LBAS_LSIPI_MASK" 12 +.IP "NVME_FEAT_SC_NODRM_SHIFT" 12 +.IP "NVME_FEAT_SC_NODRM_MASK" 12 +.IP "NVME_FEAT_EG_ENDGID_SHIFT" 12 +.IP "NVME_FEAT_EG_ENDGID_MASK" 12 +.IP "NVME_FEAT_EG_EGCW_SHIFT" 12 +.IP "NVME_FEAT_EG_EGCW_MASK" 12 +.IP "NVME_FEAT_SPM_PBSLC_SHIFT" 12 +.IP "NVME_FEAT_SPM_PBSLC_MASK" 12 +.IP "NVME_FEAT_HOSTID_EXHID_SHIFT" 12 +.IP "NVME_FEAT_HOSTID_EXHID_MASK" 12 +.IP "NVME_FEAT_RM_REGPRE_SHIFT" 12 +.IP "NVME_FEAT_RM_REGPRE_MASK" 12 +.IP "NVME_FEAT_RM_RESREL_SHIFT" 12 +.IP "NVME_FEAT_RM_RESREL_MASK" 12 +.IP "NVME_FEAT_RM_RESPRE_SHIFT" 12 +.IP "NVME_FEAT_RM_RESPRE_MASK" 12 +.IP "NVME_FEAT_RP_PTPL_SHIFT" 12 +.IP "NVME_FEAT_RP_PTPL_MASK" 12 +.IP "NVME_FEAT_WP_WPS_SHIFT" 12 +.IP "NVME_FEAT_WP_WPS_MASK" 12 +.IP "NVME_FEAT_IOCSP_IOCSCI_SHIFT" 12 +.IP "NVME_FEAT_IOCSP_IOCSCI_MASK" 12 diff --git a/doc/man/nvme_feat_auto_pst.2 b/doc/man/nvme_feat_auto_pst.2 new file mode 100644 index 0000000..c84f481 --- /dev/null +++ b/doc/man/nvme_feat_auto_pst.2 @@ -0,0 +1,15 @@ +.TH "libnvme" 9 "struct nvme_feat_auto_pst" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_feat_auto_pst \- +.SH SYNOPSIS +struct nvme_feat_auto_pst { +.br +.BI " __le64 apst_entry[32];" +.br +.BI " +}; +.br + +.SH Members +.IP "apst_entry" 12 +See \fIenum nvme_apst_entry\fP diff --git a/doc/man/nvme_feat_host_behavior.2 b/doc/man/nvme_feat_host_behavior.2 new file mode 100644 index 0000000..7f9be77 --- /dev/null +++ b/doc/man/nvme_feat_host_behavior.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_feat_host_behavior" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_feat_host_behavior \- +.SH SYNOPSIS +struct nvme_feat_host_behavior { +.br +.BI " __u8 acre;" +.br +.BI " __u8 rsvd1[511];" +.br +.BI " +}; +.br + +.SH Members +.IP "acre" 12 +Advanced Command Retry Enable +.IP "rsvd1" 12 +Reserved diff --git a/doc/man/nvme_feat_nswpcfg_state.2 b/doc/man/nvme_feat_nswpcfg_state.2 new file mode 100644 index 0000000..c671e63 --- /dev/null +++ b/doc/man/nvme_feat_nswpcfg_state.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_feat_nswpcfg_state \- +.SH SYNOPSIS +enum nvme_feat_nswpcfg_state { +.br +.BI " NVME_FEAT_NS_NO_WRITE_PROTECT" +, +.br +.br +.BI " NVME_FEAT_NS_WRITE_PROTECT" +, +.br +.br +.BI " NVME_FEAT_NS_WRITE_PROTECT_PWR_CYCLE" +, +.br +.br +.BI " NVME_FEAT_NS_WRITE_PROTECT_PERMANENT" + +}; +.SH Constants +.IP "NVME_FEAT_NS_NO_WRITE_PROTECT" 12 +No Write Protect +.IP "NVME_FEAT_NS_WRITE_PROTECT" 12 +Write Protect +.IP "NVME_FEAT_NS_WRITE_PROTECT_PWR_CYCLE" 12 +Write Protect Until Power Cycle +.IP "NVME_FEAT_NS_WRITE_PROTECT_PERMANENT" 12 +Permanent Write Protect diff --git a/doc/man/nvme_feat_plm_window_select.2 b/doc/man/nvme_feat_plm_window_select.2 new file mode 100644 index 0000000..a864d98 --- /dev/null +++ b/doc/man/nvme_feat_plm_window_select.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_feat_plm_window_select \- +.SH SYNOPSIS +enum nvme_feat_plm_window_select { +.br +.BI " NVME_FEATURE_PLM_DTWIN" +, +.br +.br +.BI " NVME_FEATURE_PLM_NDWIN" + +}; +.SH Constants +.IP "NVME_FEATURE_PLM_DTWIN" 12 +Deterministic Window select +.IP "NVME_FEATURE_PLM_NDWIN" 12 +Non-Deterministic Window select diff --git a/doc/man/nvme_feat_resv_notify_flags.2 b/doc/man/nvme_feat_resv_notify_flags.2 new file mode 100644 index 0000000..53a262b --- /dev/null +++ b/doc/man/nvme_feat_resv_notify_flags.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_feat_resv_notify_flags \- +.SH SYNOPSIS +enum nvme_feat_resv_notify_flags { +.br +.BI " NVME_FEAT_RESV_NOTIFY_REGPRE" +, +.br +.br +.BI " NVME_FEAT_RESV_NOTIFY_RESREL" +, +.br +.br +.BI " NVME_FEAT_RESV_NOTIFY_RESPRE" + +}; +.SH Constants +.IP "NVME_FEAT_RESV_NOTIFY_REGPRE" 12 +Mask Registration Preempted Notification +.IP "NVME_FEAT_RESV_NOTIFY_RESREL" 12 +Mask Reservation Released Notification +.IP "NVME_FEAT_RESV_NOTIFY_RESPRE" 12 +Mask Reservation Preempted Notification diff --git a/doc/man/nvme_feat_tmpthresh_thsel.2 b/doc/man/nvme_feat_tmpthresh_thsel.2 new file mode 100644 index 0000000..1c91429 --- /dev/null +++ b/doc/man/nvme_feat_tmpthresh_thsel.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_feat_tmpthresh_thsel \- +.SH SYNOPSIS +enum nvme_feat_tmpthresh_thsel { +.br +.BI " NVME_FEATURE_TEMPTHRESH_THSEL_OVER" +, +.br +.br +.BI " NVME_FEATURE_TEMPTHRESH_THSEL_UNDER" + +}; +.SH Constants +.IP "NVME_FEATURE_TEMPTHRESH_THSEL_OVER" 12 +Over temperature threshold select +.IP "NVME_FEATURE_TEMPTHRESH_THSEL_UNDER" 12 +Under temperature threshold select diff --git a/doc/man/nvme_features_async_event_config_flags.2 b/doc/man/nvme_features_async_event_config_flags.2 new file mode 100644 index 0000000..eaa5062 --- /dev/null +++ b/doc/man/nvme_features_async_event_config_flags.2 @@ -0,0 +1,76 @@ +.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_features_async_event_config_flags \- +.SH SYNOPSIS +enum nvme_features_async_event_config_flags { +.br +.BI " NVME_FEATURE_AENCFG_SMART_CRIT_SPARE" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_SMART_CRIT_TEMPERATURE" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_SMART_CRIT_DEGRADED" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_SMART_CRIT_VOLATILE_BACKUP" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY_PMR" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_NAMESPACE_ATTRIBUTES" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_FIRMWARE_ACTIVATION" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_TELEMETRY_LOG" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_ANA_CHANGE" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_PL_EVENT" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_LBA_STATUS" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_EG_EVENT" +, +.br +.br +.BI " NVME_FEATURE_AENCFG_NOTICE_DISCOVERY_CHANGE" + +}; +.SH Constants +.IP "NVME_FEATURE_AENCFG_SMART_CRIT_SPARE" 12 +.IP "NVME_FEATURE_AENCFG_SMART_CRIT_TEMPERATURE" 12 +.IP "NVME_FEATURE_AENCFG_SMART_CRIT_DEGRADED" 12 +.IP "NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY" 12 +.IP "NVME_FEATURE_AENCFG_SMART_CRIT_VOLATILE_BACKUP" 12 +.IP "NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY_PMR" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_NAMESPACE_ATTRIBUTES" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_FIRMWARE_ACTIVATION" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_TELEMETRY_LOG" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_ANA_CHANGE" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_PL_EVENT" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_LBA_STATUS" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_EG_EVENT" 12 +.IP "NVME_FEATURE_AENCFG_NOTICE_DISCOVERY_CHANGE" 12 diff --git a/doc/man/nvme_features_id.2 b/doc/man/nvme_features_id.2 new file mode 100644 index 0000000..a908964 --- /dev/null +++ b/doc/man/nvme_features_id.2 @@ -0,0 +1,210 @@ +.TH "libnvme" 9 "enum nvme_features_id" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_features_id \- +.SH SYNOPSIS +enum nvme_features_id { +.br +.BI " NVME_FEAT_FID_ARBITRATION" +, +.br +.br +.BI " NVME_FEAT_FID_POWER_MGMT" +, +.br +.br +.BI " NVME_FEAT_FID_LBA_RANGE" +, +.br +.br +.BI " NVME_FEAT_FID_TEMP_THRESH" +, +.br +.br +.BI " NVME_FEAT_FID_ERR_RECOVERY" +, +.br +.br +.BI " NVME_FEAT_FID_VOLATILE_WC" +, +.br +.br +.BI " NVME_FEAT_FID_NUM_QUEUES" +, +.br +.br +.BI " NVME_FEAT_FID_IRQ_COALESCE" +, +.br +.br +.BI " NVME_FEAT_FID_IRQ_CONFIG" +, +.br +.br +.BI " NVME_FEAT_FID_WRITE_ATOMIC" +, +.br +.br +.BI " NVME_FEAT_FID_ASYNC_EVENT" +, +.br +.br +.BI " NVME_FEAT_FID_AUTO_PST" +, +.br +.br +.BI " NVME_FEAT_FID_HOST_MEM_BUF" +, +.br +.br +.BI " NVME_FEAT_FID_TIMESTAMP" +, +.br +.br +.BI " NVME_FEAT_FID_KATO" +, +.br +.br +.BI " NVME_FEAT_FID_HCTM" +, +.br +.br +.BI " NVME_FEAT_FID_NOPSC" +, +.br +.br +.BI " NVME_FEAT_FID_RRL" +, +.br +.br +.BI " NVME_FEAT_FID_PLM_CONFIG" +, +.br +.br +.BI " NVME_FEAT_FID_PLM_WINDOW" +, +.br +.br +.BI " NVME_FEAT_FID_LBA_STS_INTERVAL" +, +.br +.br +.BI " NVME_FEAT_FID_HOST_BEHAVIOR" +, +.br +.br +.BI " NVME_FEAT_FID_SANITIZE" +, +.br +.br +.BI " NVME_FEAT_FID_ENDURANCE_EVT_CFG" +, +.br +.br +.BI " NVME_FEAT_FID_IOCS_PROFILE" +, +.br +.br +.BI " NVME_FEAT_FID_SPINUP_CONTROL" +, +.br +.br +.BI " NVME_FEAT_FID_ENH_CTRL_METADATA" +, +.br +.br +.BI " NVME_FEAT_FID_CTRL_METADATA" +, +.br +.br +.BI " NVME_FEAT_FID_NS_METADATA" +, +.br +.br +.BI " NVME_FEAT_FID_SW_PROGRESS" +, +.br +.br +.BI " NVME_FEAT_FID_HOST_ID" +, +.br +.br +.BI " NVME_FEAT_FID_RESV_MASK" +, +.br +.br +.BI " NVME_FEAT_FID_RESV_PERSIST" +, +.br +.br +.BI " NVME_FEAT_FID_WRITE_PROTECT" + +}; +.SH Constants +.IP "NVME_FEAT_FID_ARBITRATION" 12 +Arbitration +.IP "NVME_FEAT_FID_POWER_MGMT" 12 +Power Management +.IP "NVME_FEAT_FID_LBA_RANGE" 12 +LBA Range Type +.IP "NVME_FEAT_FID_TEMP_THRESH" 12 +Temperature Threshold +.IP "NVME_FEAT_FID_ERR_RECOVERY" 12 +Error Recovery +.IP "NVME_FEAT_FID_VOLATILE_WC" 12 +Volatile Write Cache +.IP "NVME_FEAT_FID_NUM_QUEUES" 12 +Number of Queues +.IP "NVME_FEAT_FID_IRQ_COALESCE" 12 +Interrupt Coalescing +.IP "NVME_FEAT_FID_IRQ_CONFIG" 12 +Interrupt Vector Configuration +.IP "NVME_FEAT_FID_WRITE_ATOMIC" 12 +Write Atomicity Normal +.IP "NVME_FEAT_FID_ASYNC_EVENT" 12 +Asynchronous Event Configuration +.IP "NVME_FEAT_FID_AUTO_PST" 12 +Autonomous Power State Transition +.IP "NVME_FEAT_FID_HOST_MEM_BUF" 12 +Host Memory Buffer +.IP "NVME_FEAT_FID_TIMESTAMP" 12 +Timestamp +.IP "NVME_FEAT_FID_KATO" 12 +Keep Alive Timer +.IP "NVME_FEAT_FID_HCTM" 12 +Host Controlled Thermal Management +.IP "NVME_FEAT_FID_NOPSC" 12 +Non-Operational Power State Config +.IP "NVME_FEAT_FID_RRL" 12 +Read Recovery Level Config +.IP "NVME_FEAT_FID_PLM_CONFIG" 12 +Predictable Latency Mode Config +.IP "NVME_FEAT_FID_PLM_WINDOW" 12 +Predictable Latency Mode Window +.IP "NVME_FEAT_FID_LBA_STS_INTERVAL" 12 +LBA Status Information Report Interval +.IP "NVME_FEAT_FID_HOST_BEHAVIOR" 12 +Host Behavior Support +.IP "NVME_FEAT_FID_SANITIZE" 12 +Endurance Group Event Configuration +.IP "NVME_FEAT_FID_ENDURANCE_EVT_CFG" 12 +Endurance Group Event Configuration +.IP "NVME_FEAT_FID_IOCS_PROFILE" 12 +I/O Command Set Profile +.IP "NVME_FEAT_FID_SPINUP_CONTROL" 12 +Spinup Control +.IP "NVME_FEAT_FID_ENH_CTRL_METADATA" 12 +Enhanced Controller Metadata +.IP "NVME_FEAT_FID_CTRL_METADATA" 12 +Controller Metadata +.IP "NVME_FEAT_FID_NS_METADATA" 12 +Namespace Metadata +.IP "NVME_FEAT_FID_SW_PROGRESS" 12 +Software Progress Marker +.IP "NVME_FEAT_FID_HOST_ID" 12 +Host Identifier +.IP "NVME_FEAT_FID_RESV_MASK" 12 +Reservation Notification Mask +.IP "NVME_FEAT_FID_RESV_PERSIST" 12 +Reservation Persistence +.IP "NVME_FEAT_FID_WRITE_PROTECT" 12 +Namespace Write Protection Config diff --git a/doc/man/nvme_fid_supported_effects.2 b/doc/man/nvme_fid_supported_effects.2 new file mode 100644 index 0000000..353ed27 --- /dev/null +++ b/doc/man/nvme_fid_supported_effects.2 @@ -0,0 +1,78 @@ +.TH "libnvme" 9 "enum nvme_fid_supported_effects" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_fid_supported_effects \- +.SH SYNOPSIS +enum nvme_fid_supported_effects { +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_FSUPP" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_UDCC" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_NCC" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_NIC" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_CCC" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_UUID_SEL" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFT" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASK" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_NS" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRL" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SET" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRP" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAIN" +, +.br +.br +.BI " NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSS" + +}; +.SH Constants +.IP "NVME_FID_SUPPORTED_EFFECTS_FSUPP" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_UDCC" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_NCC" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_NIC" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_CCC" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_UUID_SEL" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFT" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASK" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_NS" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRL" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SET" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRP" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAIN" 12 +.IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSS" 12 +.SH "Description" +FID Supported and Effects Data Structure definitions diff --git a/doc/man/nvme_fid_supported_effects_log.2 b/doc/man/nvme_fid_supported_effects_log.2 new file mode 100644 index 0000000..6603c45 --- /dev/null +++ b/doc/man/nvme_fid_supported_effects_log.2 @@ -0,0 +1,17 @@ +.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_fid_supported_effects_log \- +.SH SYNOPSIS +struct nvme_fid_supported_effects_log { +.br +.BI " __le32 fid_support[NVME_LOG_FID_SUPPORTED_EFFECTS_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "fid_support" 12 +Feature Identifier Supported +.SH "Description" +Feature Identifiers Supported and Effects (Log Identifier 12h) diff --git a/doc/man/nvme_firmware_slot.2 b/doc/man/nvme_firmware_slot.2 new file mode 100644 index 0000000..61524c7 --- /dev/null +++ b/doc/man/nvme_firmware_slot.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_firmware_slot" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_firmware_slot \- +.SH SYNOPSIS +struct nvme_firmware_slot { +.br +.BI " __u8 afi;" +.br +.BI " __u8 rsvd1[7];" +.br +.BI " char frs[7][8];" +.br +.BI " __u8 rsvd2[448];" +.br +.BI " +}; +.br + +.SH Members +.IP "afi" 12 +Active Firmware Info +.IP "rsvd1" 12 +Reserved +.IP "frs" 12 +Firmware Revision for Slot +.IP "rsvd2" 12 +Reserved diff --git a/doc/man/nvme_first_host.2 b/doc/man/nvme_first_host.2 new file mode 100644 index 0000000..bfad78d --- /dev/null +++ b/doc/man/nvme_first_host.2 @@ -0,0 +1,11 @@ +.TH "nvme_first_host" 9 "nvme_first_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_first_host \- Start host iterator +.SH SYNOPSIS +.B "nvme_host_t" nvme_first_host +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.SH "RETURN" +First \fInvme_host_t\fP object in an iterator diff --git a/doc/man/nvme_first_subsystem.2 b/doc/man/nvme_first_subsystem.2 new file mode 100644 index 0000000..c47b3d9 --- /dev/null +++ b/doc/man/nvme_first_subsystem.2 @@ -0,0 +1,11 @@ +.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_first_subsystem \- Start subsystem iterator +.SH SYNOPSIS +.B "nvme_subsystem_t" nvme_first_subsystem +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +\fInvme_host_t\fP object +.SH "RETURN" +first \fInvme_subsystem_t\fP object in an iterator diff --git a/doc/man/nvme_flush.2 b/doc/man/nvme_flush.2 new file mode 100644 index 0000000..251958e --- /dev/null +++ b/doc/man/nvme_flush.2 @@ -0,0 +1,18 @@ +.TH "nvme_flush" 9 "nvme_flush" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_flush \- Send an nvme flush command +.SH SYNOPSIS +.B "int" nvme_flush +.BI "(int fd " "," +.BI "__u32 nsid " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace identifier +.SH "DESCRIPTION" +The Flush command requests that the contents of volatile write cache be made +non-volatile. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_for_each_host.2 b/doc/man/nvme_for_each_host.2 new file mode 100644 index 0000000..08e4912 --- /dev/null +++ b/doc/man/nvme_for_each_host.2 @@ -0,0 +1,12 @@ +.TH "nvme_for_each_host" 9 "nvme_for_each_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_for_each_host \- Traverse host list +.SH SYNOPSIS +.B "nvme_for_each_host +.BI "(r " "," +.BI "h " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.IP "h" 12 +\fInvme_host_t\fP object diff --git a/doc/man/nvme_for_each_host_safe.2 b/doc/man/nvme_for_each_host_safe.2 new file mode 100644 index 0000000..04f31fe --- /dev/null +++ b/doc/man/nvme_for_each_host_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_for_each_host_safe \- Traverse host list +.SH SYNOPSIS +.B "nvme_for_each_host_safe +.BI "(r " "," +.BI "h " "," +.BI "_h " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.IP "h" 12 +\fInvme_host_t\fP object +.IP "_h" 12 +Temporary \fInvme_host_t\fP object diff --git a/doc/man/nvme_for_each_subsystem.2 b/doc/man/nvme_for_each_subsystem.2 new file mode 100644 index 0000000..7f50b64 --- /dev/null +++ b/doc/man/nvme_for_each_subsystem.2 @@ -0,0 +1,12 @@ +.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_for_each_subsystem \- Traverse subsystems +.SH SYNOPSIS +.B "nvme_for_each_subsystem +.BI "(h " "," +.BI "s " ");" +.SH ARGUMENTS +.IP "h" 12 +\fInvme_host_t\fP object +.IP "s" 12 +\fInvme_subsystem_t\fP object diff --git a/doc/man/nvme_for_each_subsystem_safe.2 b/doc/man/nvme_for_each_subsystem_safe.2 new file mode 100644 index 0000000..b03d683 --- /dev/null +++ b/doc/man/nvme_for_each_subsystem_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_for_each_subsystem_safe \- Traverse subsystems +.SH SYNOPSIS +.B "nvme_for_each_subsystem_safe +.BI "(h " "," +.BI "s " "," +.BI "_s " ");" +.SH ARGUMENTS +.IP "h" 12 +\fInvme_host_t\fP object +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "_s" 12 +Temporary \fInvme_subsystem_t\fP object diff --git a/doc/man/nvme_format_nvm.2 b/doc/man/nvme_format_nvm.2 new file mode 100644 index 0000000..60ffa5b --- /dev/null +++ b/doc/man/nvme_format_nvm.2 @@ -0,0 +1,17 @@ +.TH "nvme_format_nvm" 9 "nvme_format_nvm" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_format_nvm \- Format nvme namespace(s) +.SH SYNOPSIS +.B "int" nvme_format_nvm +.BI "(struct nvme_format_nvm_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_format_nvme_args\fP argument structure +.SH "DESCRIPTION" +The Format NVM command low level formats the NVM media. This command is used +by the host to change the LBA data size and/or metadata size. A low level +format may destroy all data and metadata associated with all namespaces or +only the specific namespace associated with the command +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_format_nvm_args.2 b/doc/man/nvme_format_nvm_args.2 new file mode 100644 index 0000000..53f4fcb --- /dev/null +++ b/doc/man/nvme_format_nvm_args.2 @@ -0,0 +1,52 @@ +.TH "libnvme" 9 "struct nvme_format_nvm_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_format_nvm_args \- Arguments for the Format Nvme Namespace command +.SH SYNOPSIS +struct nvme_format_nvm_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_cmd_format_mset mset;" +.br +.BI " enum nvme_cmd_format_pi pi;" +.br +.BI " enum nvme_cmd_format_pil pil;" +.br +.BI " enum nvme_cmd_format_ses ses;" +.br +.BI " __u8 lbaf;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_format_nvm_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Set to override default timeout to this value in milliseconds; +useful for long running formats. 0 will use system default. +.IP "nsid" 12 +Namespace ID to format +.IP "mset" 12 +Metadata settings (extended or separated), true if extended +.IP "pi" 12 +Protection information type +.IP "pil" 12 +Protection information location (beginning or end), true if end +.IP "ses" 12 +Secure erase settings +.IP "lbaf" 12 +Logical block address format diff --git a/doc/man/nvme_format_nvm_compln_event.2 b/doc/man/nvme_format_nvm_compln_event.2 new file mode 100644 index 0000000..d53651a --- /dev/null +++ b/doc/man/nvme_format_nvm_compln_event.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_format_nvm_compln_event \- +.SH SYNOPSIS +struct nvme_format_nvm_compln_event { +.br +.BI " __le32 nsid;" +.br +.BI " __u8 smallest_fpi;" +.br +.BI " __u8 format_nvm_status;" +.br +.BI " __le16 compln_info;" +.br +.BI " __le32 status_field;" +.br +.BI " +}; +.br + +.SH Members +.IP "nsid" 12 +Namespace Identifier +.IP "smallest_fpi" 12 +Smallest Format Progress Indicator +.IP "format_nvm_status" 12 +Format NVM Status +.IP "compln_info" 12 +Completion Information +.IP "status_field" 12 +Status Field diff --git a/doc/man/nvme_format_nvm_start_event.2 b/doc/man/nvme_format_nvm_start_event.2 new file mode 100644 index 0000000..cff8f5f --- /dev/null +++ b/doc/man/nvme_format_nvm_start_event.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_format_nvm_start_event \- +.SH SYNOPSIS +struct nvme_format_nvm_start_event { +.br +.BI " __le32 nsid;" +.br +.BI " __u8 fna;" +.br +.BI " __u8 rsvd5[3];" +.br +.BI " __le32 format_nvm_cdw10;" +.br +.BI " +}; +.br + +.SH Members +.IP "nsid" 12 +Namespace Identifier +.IP "fna" 12 +Format NVM Attributes +.IP "rsvd5" 12 +Reserved +.IP "format_nvm_cdw10" 12 +Format NVM CDW10 diff --git a/doc/man/nvme_free_ctrl.2 b/doc/man/nvme_free_ctrl.2 new file mode 100644 index 0000000..e350001 --- /dev/null +++ b/doc/man/nvme_free_ctrl.2 @@ -0,0 +1,9 @@ +.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_free_ctrl \- Free controller +.SH SYNOPSIS +.B "void" nvme_free_ctrl +.BI "(struct nvme_ctrl *c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance diff --git a/doc/man/nvme_free_host.2 b/doc/man/nvme_free_host.2 new file mode 100644 index 0000000..a1393ac --- /dev/null +++ b/doc/man/nvme_free_host.2 @@ -0,0 +1,9 @@ +.TH "nvme_free_host" 9 "nvme_free_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_free_host \- Free nvme_host_t object +.SH SYNOPSIS +.B "void" nvme_free_host +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +nvme_host_t object diff --git a/doc/man/nvme_free_ns.2 b/doc/man/nvme_free_ns.2 new file mode 100644 index 0000000..f8ad3e8 --- /dev/null +++ b/doc/man/nvme_free_ns.2 @@ -0,0 +1,9 @@ +.TH "nvme_free_ns" 9 "nvme_free_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_free_ns \- Free a namespace object +.SH SYNOPSIS +.B "void" nvme_free_ns +.BI "(struct nvme_ns *n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance diff --git a/doc/man/nvme_free_subsystem.2 b/doc/man/nvme_free_subsystem.2 new file mode 100644 index 0000000..121fc6c --- /dev/null +++ b/doc/man/nvme_free_subsystem.2 @@ -0,0 +1,11 @@ +.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_free_subsystem \- Free a subsystem +.SH SYNOPSIS +.B "void" nvme_free_subsystem +.BI "(struct nvme_subsystem *s " ");" +.SH ARGUMENTS +.IP "s" 12 +subsystem +.SH "DESCRIPTION" +Frees \fIs\fP and all related objects. diff --git a/doc/man/nvme_free_tree.2 b/doc/man/nvme_free_tree.2 new file mode 100644 index 0000000..d819425 --- /dev/null +++ b/doc/man/nvme_free_tree.2 @@ -0,0 +1,11 @@ +.TH "nvme_free_tree" 9 "nvme_free_tree" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_free_tree \- Free root object +.SH SYNOPSIS +.B "void" nvme_free_tree +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.SH "DESCRIPTION" +Free an \fInvme_root_t\fP object and all attached objects diff --git a/doc/man/nvme_fw_commit.2 b/doc/man/nvme_fw_commit.2 new file mode 100644 index 0000000..a9d1f20 --- /dev/null +++ b/doc/man/nvme_fw_commit.2 @@ -0,0 +1,16 @@ +.TH "nvme_fw_commit" 9 "nvme_fw_commit" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_fw_commit \- Commit firmware using the specified action +.SH SYNOPSIS +.B "int" nvme_fw_commit +.BI "(struct nvme_fw_commit_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_fw_commit_args\fP argument structure +.SH "DESCRIPTION" +The Firmware Commit command modifies the firmware image or Boot Partitions. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. The command +status response may specify additional reset actions required to complete +the commit process. diff --git a/doc/man/nvme_fw_commit_args.2 b/doc/man/nvme_fw_commit_args.2 new file mode 100644 index 0000000..81236ed --- /dev/null +++ b/doc/man/nvme_fw_commit_args.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_fw_commit_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_fw_commit_args \- Arguments for the NVMe Firmware Commit command +.SH SYNOPSIS +struct nvme_fw_commit_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " enum nvme_fw_commit_ca action;" +.br +.BI " __u8 slot;" +.br +.BI " bool bpid;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_fw_commit_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "action" 12 +Action to use for the firmware image, see \fIenum nvme_fw_commit_ca\fP +.IP "slot" 12 +Firmware slot to commit the downloaded image +.IP "bpid" 12 +Set to true to select the boot partition id diff --git a/doc/man/nvme_fw_commit_ca.2 b/doc/man/nvme_fw_commit_ca.2 new file mode 100644 index 0000000..90194e8 --- /dev/null +++ b/doc/man/nvme_fw_commit_ca.2 @@ -0,0 +1,59 @@ +.TH "libnvme" 9 "enum nvme_fw_commit_ca" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_fw_commit_ca \- +.SH SYNOPSIS +enum nvme_fw_commit_ca { +.br +.BI " NVME_FW_COMMIT_CA_REPLACE" +, +.br +.br +.BI " NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE" +, +.br +.br +.BI " NVME_FW_COMMIT_CA_SET_ACTIVE" +, +.br +.br +.BI " NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE_IMMEDIATE" +, +.br +.br +.BI " NVME_FW_COMMIT_CA_REPLACE_BOOT_PARTITION" +, +.br +.br +.BI " NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITION" + +}; +.SH Constants +.IP "NVME_FW_COMMIT_CA_REPLACE" 12 +Downloaded image replaces the existing +image, if any, in the specified Firmware +Slot. The newly placed image is not +activated. +.IP "NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE" 12 +Downloaded image replaces the existing +image, if any, in the specified Firmware +Slot. The newly placed image is activated +at the next Controller Level Reset. +.IP "NVME_FW_COMMIT_CA_SET_ACTIVE" 12 +The existing image in the specified +Firmware Slot is activated at the +next Controller Level Reset. +.IP "NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE_IMMEDIATE" 12 +Downloaded image replaces the existing +image, if any, in the specified Firmware +Slot and is then activated immediately. +If there is not a newly downloaded image, +then the existing image in the specified +firmware slot is activated immediately. +.IP "NVME_FW_COMMIT_CA_REPLACE_BOOT_PARTITION" 12 +Downloaded image replaces the Boot +Partition specified by the Boot +Partition ID field. +.IP "NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITION" 12 +Mark the Boot Partition specified in +the BPID field as active and update +BPINFO.ABPID. diff --git a/doc/man/nvme_fw_commit_event.2 b/doc/man/nvme_fw_commit_event.2 new file mode 100644 index 0000000..30bd35f --- /dev/null +++ b/doc/man/nvme_fw_commit_event.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_fw_commit_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_fw_commit_event \- +.SH SYNOPSIS +struct nvme_fw_commit_event { +.br +.BI " __le64 old_fw_rev;" +.br +.BI " __le64 new_fw_rev;" +.br +.BI " __u8 fw_commit_action;" +.br +.BI " __u8 fw_slot;" +.br +.BI " __u8 sct_fw;" +.br +.BI " __u8 sc_fw;" +.br +.BI " __le16 vndr_assign_fw_commit_rc;" +.br +.BI " +}; +.br + +.SH Members +.IP "old_fw_rev" 12 +Old Firmware Revision +.IP "new_fw_rev" 12 +New Firmware Revision +.IP "fw_commit_action" 12 +Firmware Commit Action +.IP "fw_slot" 12 +Firmware Slot +.IP "sct_fw" 12 +Status Code Type for Firmware Commit Command +.IP "sc_fw" 12 +Status Returned for Firmware Commit Command +.IP "vndr_assign_fw_commit_rc" 12 +Vendor Assigned Firmware Commit Result Code diff --git a/doc/man/nvme_fw_download.2 b/doc/man/nvme_fw_download.2 new file mode 100644 index 0000000..e810902 --- /dev/null +++ b/doc/man/nvme_fw_download.2 @@ -0,0 +1,25 @@ +.TH "nvme_fw_download" 9 "nvme_fw_download" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_fw_download \- Download part or all of a firmware image to the controller +.SH SYNOPSIS +.B "int" nvme_fw_download +.BI "(struct nvme_fw_download_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_fw_download_args\fP argument structure +.SH "DESCRIPTION" +The Firmware Image Download command downloads all or a portion of an image +for a future update to the controller. The Firmware Image Download command +downloads a new image (in whole or in part) to the controller. + +The image may be constructed of multiple pieces that are individually +downloaded with separate Firmware Image Download commands. Each Firmware +Image Download command includes a Dword Offset and Number of Dwords that +specify a dword range. + +The new firmware image is not activated as part of the Firmware Image +Download command. Use the \fBnvme_fw_commit\fP to activate a newly downloaded +image. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_fw_download_args.2 b/doc/man/nvme_fw_download_args.2 new file mode 100644 index 0000000..46ba23a --- /dev/null +++ b/doc/man/nvme_fw_download_args.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_fw_download_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_fw_download_args \- Arguments for the NVMe Firmware Download command +.SH SYNOPSIS +struct nvme_fw_download_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 offset;" +.br +.BI " __u32 data_len;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Userspace address of the firmware data +.IP "args_size" 12 +Size of \fIstruct nvme_fw_download_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "offset" 12 +Offset in the firmware data +.IP "data_len" 12 +Length of data in this command in bytes diff --git a/doc/man/nvme_fw_download_seq.2 b/doc/man/nvme_fw_download_seq.2 new file mode 100644 index 0000000..9afb52c --- /dev/null +++ b/doc/man/nvme_fw_download_seq.2 @@ -0,0 +1,24 @@ +.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_fw_download_seq \- Firmware download sequence +.SH SYNOPSIS +.B "int" nvme_fw_download_seq +.BI "(int fd " "," +.BI "__u32 size " "," +.BI "__u32 xfer " "," +.BI "__u32 offset " "," +.BI "void *buf " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "size" 12 +Total size of the firmware image to transfer +.IP "xfer" 12 +Maximum size to send with each partial transfer +.IP "offset" 12 +Starting offset to send with this firmware downlaod +.IP "buf" 12 +Address of buffer containing all or part of the firmware image. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_gen_dhchap_key.2 b/doc/man/nvme_gen_dhchap_key.2 new file mode 100644 index 0000000..b9a0866 --- /dev/null +++ b/doc/man/nvme_gen_dhchap_key.2 @@ -0,0 +1,24 @@ +.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_gen_dhchap_key \- DH-HMAC-CHAP key generation +.SH SYNOPSIS +.B "int" nvme_gen_dhchap_key +.BI "(char *hostnqn " "," +.BI "enum nvme_hmac_alg hmac " "," +.BI "unsigned int key_len " "," +.BI "unsigned char *secret " "," +.BI "unsigned char *key " ");" +.SH ARGUMENTS +.IP "hostnqn" 12 +Host NVMe Qualified Name +.IP "hmac" 12 +HMAC algorithm +.IP "key_len" 12 +Output key length +.IP "secret" 12 +Secret to used for digest +.IP "key" 12 +Generated DH-HMAC-CHAP key +.SH "RETURN" +If key generation was successful the function returns 0 or +-1 with errno set otherwise. diff --git a/doc/man/nvme_get_ana_log_len.2 b/doc/man/nvme_get_ana_log_len.2 new file mode 100644 index 0000000..9c2efec --- /dev/null +++ b/doc/man/nvme_get_ana_log_len.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_ana_log_len \- Retreive size of the current ANA log +.SH SYNOPSIS +.B "int" nvme_get_ana_log_len +.BI "(int fd " "," +.BI "size_t *analen " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "analen" 12 +Pointer to where the length will be set on success +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_attr.2 b/doc/man/nvme_get_attr.2 new file mode 100644 index 0000000..2c52587 --- /dev/null +++ b/doc/man/nvme_get_attr.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_attr" 9 "nvme_get_attr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_attr \- Read sysfs attribute +.SH SYNOPSIS +.B "char *" nvme_get_attr +.BI "(const char *d " "," +.BI "const char *attr " ");" +.SH ARGUMENTS +.IP "d" 12 +sysfs directory +.IP "attr" 12 +sysfs attribute name +.SH "RETURN" +String with the contents of \fIattr\fP or NULL in case of an empty value +or in case of an error (indicated by non-zero errno code). diff --git a/doc/man/nvme_get_ctrl_attr.2 b/doc/man/nvme_get_ctrl_attr.2 new file mode 100644 index 0000000..6ec20f6 --- /dev/null +++ b/doc/man/nvme_get_ctrl_attr.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_ctrl_attr \- Read controller sysfs attribute +.SH SYNOPSIS +.B "char *" nvme_get_ctrl_attr +.BI "(nvme_ctrl_t c " "," +.BI "const char *attr " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "attr" 12 +sysfs attribute name +.SH "RETURN" +String with the contents of \fIattr\fP or NULL in case of an empty value +or in case of an error (indicated by non-zero errno code). diff --git a/doc/man/nvme_get_ctrl_telemetry.2 b/doc/man/nvme_get_ctrl_telemetry.2 new file mode 100644 index 0000000..c77da5f --- /dev/null +++ b/doc/man/nvme_get_ctrl_telemetry.2 @@ -0,0 +1,27 @@ +.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_ctrl_telemetry \- Get controller telemetry log +.SH SYNOPSIS +.B "int" nvme_get_ctrl_telemetry +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_telemetry_log **log " "," +.BI "enum nvme_telemetry_da da " "," +.BI "size_t *size " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +On success, set to the value of the allocated and retrieved log. +.IP "da" 12 +Log page data area, valid values: \fIenum nvme_telemetry_da\fP +.IP "size" 12 +Ptr to the telemetry log size, so it can be returned +.SH "DESCRIPTION" +The total size allocated can be calculated as: +(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_directive_receive_length.2 b/doc/man/nvme_get_directive_receive_length.2 new file mode 100644 index 0000000..54dd32b --- /dev/null +++ b/doc/man/nvme_get_directive_receive_length.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_directive_receive_length \- +.SH SYNOPSIS +.B "int" nvme_get_directive_receive_length +.BI "(enum nvme_directive_dtype dtype " "," +.BI "enum nvme_directive_receive_doper doper " "," +.BI "__u32 *len " ");" +.SH ARGUMENTS +.IP "dtype" 12 +Directive type, see \fIenum nvme_directive_dtype\fP +.IP "doper" 12 +Directive receive operation, see \fIenum nvme_directive_receive_doper\fP +.IP "len" 12 +On success, set to this directives payload length in bytes. +.SH "RETURN" +0 on success, -1 with errno set to EINVAL if the function did not +recognize \fIdtype\fP or \fIdoper\fP. diff --git a/doc/man/nvme_get_feature_length.2 b/doc/man/nvme_get_feature_length.2 new file mode 100644 index 0000000..c8f66a0 --- /dev/null +++ b/doc/man/nvme_get_feature_length.2 @@ -0,0 +1,19 @@ +.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_feature_length \- Retreive the command payload length for a specific feature identifier +.SH SYNOPSIS +.B "int" nvme_get_feature_length +.BI "(int fid " "," +.BI "__u32 cdw11 " "," +.BI "__u32 *len " ");" +.SH ARGUMENTS +.IP "fid" 12 +Feature identifier, see \fIenum nvme_features_id\fP. +.IP "cdw11" 12 +The cdw11 value may affect the transfer (only known fid is +NVME_FEAT_FID_HOST_ID) +.IP "len" 12 +On success, set to this features payload length in bytes. +.SH "RETURN" +0 on success, -1 with errno set to EINVAL if the function did not +recognize \fIfid\fP. diff --git a/doc/man/nvme_get_features.2 b/doc/man/nvme_get_features.2 new file mode 100644 index 0000000..df6d662 --- /dev/null +++ b/doc/man/nvme_get_features.2 @@ -0,0 +1,12 @@ +.TH "nvme_get_features" 9 "nvme_get_features" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features \- Retrieve a feature attribute +.SH SYNOPSIS +.B "int" nvme_get_features +.BI "(struct nvme_get_features_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_get_features_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_arbitration.2 b/doc/man/nvme_get_features_arbitration.2 new file mode 100644 index 0000000..b6a5fb5 --- /dev/null +++ b/doc/man/nvme_get_features_arbitration.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_arbitration \- +.SH SYNOPSIS +.B "int" nvme_get_features_arbitration +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_args.2 b/doc/man/nvme_get_features_args.2 new file mode 100644 index 0000000..ea214fa --- /dev/null +++ b/doc/man/nvme_get_features_args.2 @@ -0,0 +1,56 @@ +.TH "libnvme" 9 "struct nvme_get_features_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_get_features_args \- Arguments for the NVMe Admin Get Feature command +.SH SYNOPSIS +struct nvme_get_features_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_get_features_sel sel;" +.br +.BI " __u32 cdw11;" +.br +.BI " __u32 data_len;" +.br +.BI " __u8 fid;" +.br +.BI " __u8 uuidx;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +User address of feature data, if applicable +.IP "args_size" 12 +Size of \fIstruct nvme_get_features_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID, if applicable +.IP "sel" 12 +Select which type of attribute to return, +see \fIenum nvme_get_features_sel\fP +.IP "cdw11" 12 +Feature specific command dword11 field +.IP "data_len" 12 +Length of feature data, if applicable, in bytes +.IP "fid" 12 +Feature identifier, see \fIenum nvme_features_id\fP +.IP "uuidx" 12 +UUID Index for differentiating vendor specific encoding diff --git a/doc/man/nvme_get_features_async_event.2 b/doc/man/nvme_get_features_async_event.2 new file mode 100644 index 0000000..ffcefe9 --- /dev/null +++ b/doc/man/nvme_get_features_async_event.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_async_event \- +.SH SYNOPSIS +.B "int" nvme_get_features_async_event +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_auto_pst.2 b/doc/man/nvme_get_features_auto_pst.2 new file mode 100644 index 0000000..56824c9 --- /dev/null +++ b/doc/man/nvme_get_features_auto_pst.2 @@ -0,0 +1,20 @@ +.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_auto_pst \- +.SH SYNOPSIS +.B "int" nvme_get_features_auto_pst +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "struct nvme_feat_auto_pst *apst " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "apst" 12 +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_data.2 b/doc/man/nvme_get_features_data.2 new file mode 100644 index 0000000..02b82e4 --- /dev/null +++ b/doc/man/nvme_get_features_data.2 @@ -0,0 +1,24 @@ +.TH "nvme_get_features_data" 9 "nvme_get_features_data" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_data \- Helper function for @nvme_get_features() +.SH SYNOPSIS +.B "int" nvme_get_features_data +.BI "(int fd " "," +.BI "enum nvme_features_id fid " "," +.BI "__u32 nsid " "," +.BI "__u32 data_len " "," +.BI "void *data " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "fid" 12 +Feature identifier +.IP "nsid" 12 +Namespace ID, if applicable +.IP "data_len" 12 +Length of feature data, if applicable, in bytes +.IP "data" 12 +User address of feature data, if applicable +.IP "result" 12 +The command completion result from CQE dword0 diff --git a/doc/man/nvme_get_features_endurance_event_cfg.2 b/doc/man/nvme_get_features_endurance_event_cfg.2 new file mode 100644 index 0000000..6087ec5 --- /dev/null +++ b/doc/man/nvme_get_features_endurance_event_cfg.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_endurance_event_cfg \- +.SH SYNOPSIS +.B "int" nvme_get_features_endurance_event_cfg +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u16 endgid " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "endgid" 12 +Endurance Group Identifier +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_err_recovery.2 b/doc/man/nvme_get_features_err_recovery.2 new file mode 100644 index 0000000..ab1bf69 --- /dev/null +++ b/doc/man/nvme_get_features_err_recovery.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_err_recovery \- +.SH SYNOPSIS +.B "int" nvme_get_features_err_recovery +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_hctm.2 b/doc/man/nvme_get_features_hctm.2 new file mode 100644 index 0000000..d0a7d2b --- /dev/null +++ b/doc/man/nvme_get_features_hctm.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_hctm \- +.SH SYNOPSIS +.B "int" nvme_get_features_hctm +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_host_behavior.2 b/doc/man/nvme_get_features_host_behavior.2 new file mode 100644 index 0000000..720a2a6 --- /dev/null +++ b/doc/man/nvme_get_features_host_behavior.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_host_behavior \- +.SH SYNOPSIS +.B "int" nvme_get_features_host_behavior +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "struct nvme_feat_host_behavior *data " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "data" 12 +Poniter to structure nvme_feat_host_behavior +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_host_id.2 b/doc/man/nvme_get_features_host_id.2 new file mode 100644 index 0000000..86e91ce --- /dev/null +++ b/doc/man/nvme_get_features_host_id.2 @@ -0,0 +1,24 @@ +.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_host_id \- +.SH SYNOPSIS +.B "int" nvme_get_features_host_id +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "bool exhid " "," +.BI "__u32 len " "," +.BI "__u8 *hostid " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "exhid" 12 +Enable Extended Host Identifier +.IP "len" 12 +Length of \fIhostid\fP +.IP "hostid" 12 +Buffer for returned host ID +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_host_mem_buf.2 b/doc/man/nvme_get_features_host_mem_buf.2 new file mode 100644 index 0000000..2769024 --- /dev/null +++ b/doc/man/nvme_get_features_host_mem_buf.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_host_mem_buf \- +.SH SYNOPSIS +.B "int" nvme_get_features_host_mem_buf +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_iocs_profile.2 b/doc/man/nvme_get_features_iocs_profile.2 new file mode 100644 index 0000000..a771076 --- /dev/null +++ b/doc/man/nvme_get_features_iocs_profile.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_iocs_profile \- +.SH SYNOPSIS +.B "int" nvme_get_features_iocs_profile +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_irq_coalesce.2 b/doc/man/nvme_get_features_irq_coalesce.2 new file mode 100644 index 0000000..4a7974a --- /dev/null +++ b/doc/man/nvme_get_features_irq_coalesce.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_irq_coalesce \- +.SH SYNOPSIS +.B "int" nvme_get_features_irq_coalesce +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_irq_config.2 b/doc/man/nvme_get_features_irq_config.2 new file mode 100644 index 0000000..2d6a207 --- /dev/null +++ b/doc/man/nvme_get_features_irq_config.2 @@ -0,0 +1,20 @@ +.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_irq_config \- +.SH SYNOPSIS +.B "int" nvme_get_features_irq_config +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u16 iv " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "iv" 12 +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_kato.2 b/doc/man/nvme_get_features_kato.2 new file mode 100644 index 0000000..cb9d29e --- /dev/null +++ b/doc/man/nvme_get_features_kato.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_kato \- +.SH SYNOPSIS +.B "int" nvme_get_features_kato +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_lba_range.2 b/doc/man/nvme_get_features_lba_range.2 new file mode 100644 index 0000000..cdb80c6 --- /dev/null +++ b/doc/man/nvme_get_features_lba_range.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_lba_range \- +.SH SYNOPSIS +.B "int" nvme_get_features_lba_range +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "struct nvme_lba_range_type *data " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "data" 12 +User address of feature data, if applicable +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_lba_sts_interval.2 b/doc/man/nvme_get_features_lba_sts_interval.2 new file mode 100644 index 0000000..a8ba856 --- /dev/null +++ b/doc/man/nvme_get_features_lba_sts_interval.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_lba_sts_interval \- +.SH SYNOPSIS +.B "int" nvme_get_features_lba_sts_interval +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_nopsc.2 b/doc/man/nvme_get_features_nopsc.2 new file mode 100644 index 0000000..92b4e18 --- /dev/null +++ b/doc/man/nvme_get_features_nopsc.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_nopsc \- +.SH SYNOPSIS +.B "int" nvme_get_features_nopsc +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_num_queues.2 b/doc/man/nvme_get_features_num_queues.2 new file mode 100644 index 0000000..ff528b0 --- /dev/null +++ b/doc/man/nvme_get_features_num_queues.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_num_queues \- +.SH SYNOPSIS +.B "int" nvme_get_features_num_queues +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_plm_config.2 b/doc/man/nvme_get_features_plm_config.2 new file mode 100644 index 0000000..c9994db --- /dev/null +++ b/doc/man/nvme_get_features_plm_config.2 @@ -0,0 +1,23 @@ +.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_plm_config \- +.SH SYNOPSIS +.B "int" nvme_get_features_plm_config +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u16 nvmsetid " "," +.BI "struct nvme_plm_config *data " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "nvmsetid" 12 +NVM set id +.IP "data" 12 +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_plm_window.2 b/doc/man/nvme_get_features_plm_window.2 new file mode 100644 index 0000000..effac98 --- /dev/null +++ b/doc/man/nvme_get_features_plm_window.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_plm_window \- +.SH SYNOPSIS +.B "int" nvme_get_features_plm_window +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u16 nvmsetid " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "nvmsetid" 12 +NVM set id +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_power_mgmt.2 b/doc/man/nvme_get_features_power_mgmt.2 new file mode 100644 index 0000000..a8ab0f1 --- /dev/null +++ b/doc/man/nvme_get_features_power_mgmt.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_power_mgmt \- +.SH SYNOPSIS +.B "int" nvme_get_features_power_mgmt +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_resv_mask.2 b/doc/man/nvme_get_features_resv_mask.2 new file mode 100644 index 0000000..e197b46 --- /dev/null +++ b/doc/man/nvme_get_features_resv_mask.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_resv_mask \- +.SH SYNOPSIS +.B "int" nvme_get_features_resv_mask +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_resv_persist.2 b/doc/man/nvme_get_features_resv_persist.2 new file mode 100644 index 0000000..2146dba --- /dev/null +++ b/doc/man/nvme_get_features_resv_persist.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_resv_persist \- +.SH SYNOPSIS +.B "int" nvme_get_features_resv_persist +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_rrl.2 b/doc/man/nvme_get_features_rrl.2 new file mode 100644 index 0000000..570cbdf --- /dev/null +++ b/doc/man/nvme_get_features_rrl.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_rrl \- +.SH SYNOPSIS +.B "int" nvme_get_features_rrl +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_sanitize.2 b/doc/man/nvme_get_features_sanitize.2 new file mode 100644 index 0000000..dd81fc1 --- /dev/null +++ b/doc/man/nvme_get_features_sanitize.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_sanitize \- +.SH SYNOPSIS +.B "int" nvme_get_features_sanitize +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_sel.2 b/doc/man/nvme_get_features_sel.2 new file mode 100644 index 0000000..f2a9b86 --- /dev/null +++ b/doc/man/nvme_get_features_sel.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_get_features_sel" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_get_features_sel \- +.SH SYNOPSIS +enum nvme_get_features_sel { +.br +.BI " NVME_GET_FEATURES_SEL_CURRENT" +, +.br +.br +.BI " NVME_GET_FEATURES_SEL_DEFAULT" +, +.br +.br +.BI " NVME_GET_FEATURES_SEL_SAVED" +, +.br +.br +.BI " NVME_GET_FEATURES_SEL_SUPPORTED" + +}; +.SH Constants +.IP "NVME_GET_FEATURES_SEL_CURRENT" 12 +Current value +.IP "NVME_GET_FEATURES_SEL_DEFAULT" 12 +Default value +.IP "NVME_GET_FEATURES_SEL_SAVED" 12 +Saved value +.IP "NVME_GET_FEATURES_SEL_SUPPORTED" 12 +Supported capabilities diff --git a/doc/man/nvme_get_features_simple.2 b/doc/man/nvme_get_features_simple.2 new file mode 100644 index 0000000..26b4fea --- /dev/null +++ b/doc/man/nvme_get_features_simple.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_simple \- Helper function for @nvme_get_features() +.SH SYNOPSIS +.B "int" nvme_get_features_simple +.BI "(int fd " "," +.BI "enum nvme_features_id fid " "," +.BI "__u32 nsid " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "fid" 12 +Feature identifier +.IP "nsid" 12 +Namespace ID, if applicable +.IP "result" 12 +The command completion result from CQE dword0 diff --git a/doc/man/nvme_get_features_sw_progress.2 b/doc/man/nvme_get_features_sw_progress.2 new file mode 100644 index 0000000..602237b --- /dev/null +++ b/doc/man/nvme_get_features_sw_progress.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_sw_progress \- +.SH SYNOPSIS +.B "int" nvme_get_features_sw_progress +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_temp_thresh.2 b/doc/man/nvme_get_features_temp_thresh.2 new file mode 100644 index 0000000..7b781f2 --- /dev/null +++ b/doc/man/nvme_get_features_temp_thresh.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_temp_thresh \- +.SH SYNOPSIS +.B "int" nvme_get_features_temp_thresh +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_timestamp.2 b/doc/man/nvme_get_features_timestamp.2 new file mode 100644 index 0000000..4828dd1 --- /dev/null +++ b/doc/man/nvme_get_features_timestamp.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_timestamp \- +.SH SYNOPSIS +.B "int" nvme_get_features_timestamp +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "struct nvme_timestamp *ts " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "ts" 12 +Current timestamp +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_volatile_wc.2 b/doc/man/nvme_get_features_volatile_wc.2 new file mode 100644 index 0000000..9a3ca60 --- /dev/null +++ b/doc/man/nvme_get_features_volatile_wc.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_volatile_wc \- +.SH SYNOPSIS +.B "int" nvme_get_features_volatile_wc +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_write_atomic.2 b/doc/man/nvme_get_features_write_atomic.2 new file mode 100644 index 0000000..bd8cc59 --- /dev/null +++ b/doc/man/nvme_get_features_write_atomic.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_write_atomic \- +.SH SYNOPSIS +.B "int" nvme_get_features_write_atomic +.BI "(int fd " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_write_protect.2 b/doc/man/nvme_get_features_write_protect.2 new file mode 100644 index 0000000..5c6bee6 --- /dev/null +++ b/doc/man/nvme_get_features_write_protect.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_features_write_protect \- +.SH SYNOPSIS +.B "int" nvme_get_features_write_protect +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "enum nvme_get_features_sel sel " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "sel" 12 +Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_host_telemetry.2 b/doc/man/nvme_get_host_telemetry.2 new file mode 100644 index 0000000..2737ee2 --- /dev/null +++ b/doc/man/nvme_get_host_telemetry.2 @@ -0,0 +1,24 @@ +.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_host_telemetry \- Get host telemetry log +.SH SYNOPSIS +.B "int" nvme_get_host_telemetry +.BI "(int fd " "," +.BI "struct nvme_telemetry_log **log " "," +.BI "enum nvme_telemetry_da da " "," +.BI "size_t *size " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "log" 12 +On success, set to the value of the allocated and retrieved log. +.IP "da" 12 +Log page data area, valid values: \fIenum nvme_telemetry_da\fP +.IP "size" 12 +Ptr to the telemetry log size, so it can be returned +.SH "DESCRIPTION" +The total size allocated can be calculated as: +(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_lba_status.2 b/doc/man/nvme_get_lba_status.2 new file mode 100644 index 0000000..0a0d9cd --- /dev/null +++ b/doc/man/nvme_get_lba_status.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_lba_status \- Retrieve information on possibly unrecoverable LBAs +.SH SYNOPSIS +.B "int" nvme_get_lba_status +.BI "(struct nvme_get_lba_status_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_get_lba_status_args\fP argument structure +.SH "DESCRIPTION" +The Get LBA Status command requests information about Potentially +Unrecoverable LBAs. Refer to the specification for action type descriptions. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_lba_status_args.2 b/doc/man/nvme_get_lba_status_args.2 new file mode 100644 index 0000000..f12ab36 --- /dev/null +++ b/doc/man/nvme_get_lba_status_args.2 @@ -0,0 +1,52 @@ +.TH "libnvme" 9 "struct nvme_get_lba_status_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_get_lba_status_args \- Arguments for the NVMe Get LBA Status command +.SH SYNOPSIS +struct nvme_get_lba_status_args { +.br +.BI " __u64 slba;" +.br +.BI " __u32 *result;" +.br +.BI " struct nvme_lba_status *lbas;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 mndw;" +.br +.BI " enum nvme_lba_status_atype atype;" +.br +.BI " __u16 rl;" +.br +.BI " +}; +.br + +.SH Members +.IP "slba" 12 +Starting logical block address to check statuses +.IP "result" 12 +The command completion result from CQE dword0 +.IP "lbas" 12 +Data payload to return status descriptors +.IP "args_size" 12 +Size of \fIstruct nvme_get_lba_status_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID to retrieve LBA status +.IP "mndw" 12 +Maximum number of dwords to return +.IP "atype" 12 +Action type mechanism to determine LBA status desctriptors to +return, see \fIenum nvme_lba_status_atype\fP +.IP "rl" 12 +Range length from slba to perform the action diff --git a/doc/man/nvme_get_lba_status_log.2 b/doc/man/nvme_get_lba_status_log.2 new file mode 100644 index 0000000..558fbaf --- /dev/null +++ b/doc/man/nvme_get_lba_status_log.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_lba_status_log \- Retreive the LBA Status log page +.SH SYNOPSIS +.B "int" nvme_get_lba_status_log +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_lba_status_log **log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of the nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +On success, set to the value of the allocated and retreived log. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log.2 b/doc/man/nvme_get_log.2 new file mode 100644 index 0000000..e0a57ea --- /dev/null +++ b/doc/man/nvme_get_log.2 @@ -0,0 +1,12 @@ +.TH "nvme_get_log" 9 "nvme_get_log" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log \- NVMe Admin Get Log command +.SH SYNOPSIS +.B "int" nvme_get_log +.BI "(struct nvme_get_log_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_get_log_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_ana.2 b/doc/man/nvme_get_log_ana.2 new file mode 100644 index 0000000..24d038e --- /dev/null +++ b/doc/man/nvme_get_log_ana.2 @@ -0,0 +1,33 @@ +.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_ana \- +.SH SYNOPSIS +.B "int" nvme_get_log_ana +.BI "(int fd " "," +.BI "enum nvme_log_ana_lsp lsp " "," +.BI "bool rae " "," +.BI "__u64 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "lsp" 12 +Log specific, see \fIenum nvme_get_log_ana_lsp\fP +.IP "rae" 12 +Retain asynchronous events +.IP "offset" 12 +Offset to the start of the log page +.IP "len" 12 +The allocated length of the log page +.IP "log" 12 +User address to store the ana log +.SH "DESCRIPTION" +This log consists of a header describing the log and descriptors containing +the asymmetric namespace access information for ANA Groups that contain +namespaces that are attached to the controller processing the command. + +See \fIstruct nvme_ana_rsp_hdr\fP for the defintion of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_ana_groups.2 b/doc/man/nvme_get_log_ana_groups.2 new file mode 100644 index 0000000..8e1f5c6 --- /dev/null +++ b/doc/man/nvme_get_log_ana_groups.2 @@ -0,0 +1,20 @@ +.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_ana_groups \- +.SH SYNOPSIS +.B "int" nvme_get_log_ana_groups +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u32 len " "," +.BI "struct nvme_ana_group_desc *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "len" 12 +The allocated length of the log page +.IP "log" 12 +User address to store the ana group log +.SH "DESCRIPTION" +See \fIstruct nvme_ana_group_desc\fP for the defintion of the returned structure. diff --git a/doc/man/nvme_get_log_args.2 b/doc/man/nvme_get_log_args.2 new file mode 100644 index 0000000..60a6db6 --- /dev/null +++ b/doc/man/nvme_get_log_args.2 @@ -0,0 +1,74 @@ +.TH "libnvme" 9 "struct nvme_get_log_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_get_log_args \- Arguments for the NVMe Admin Get Log command +.SH SYNOPSIS +struct nvme_get_log_args { +.br +.BI " __u64 lpo;" +.br +.BI " __u32 *result;" +.br +.BI " void *log;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " enum nvme_cmd_get_log_lid lid;" +.br +.BI " __u32 len;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_csi csi;" +.br +.BI " __u16 lsi;" +.br +.BI " __u8 lsp;" +.br +.BI " __u8 uuidx;" +.br +.BI " bool rae;" +.br +.BI " bool ot;" +.br +.BI " +}; +.br + +.SH Members +.IP "lpo" 12 +Log page offset for partial log transfers +.IP "result" 12 +The command completion result from CQE dword0 +.IP "log" 12 +User space destination address to transfer the data +.IP "args_size" 12 +Length of the structure +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "lid" 12 +Log page identifier, see \fIenum nvme_cmd_get_log_lid\fP for known +values +.IP "len" 12 +Length of provided user buffer to hold the log data in bytes +.IP "nsid" 12 +Namespace identifier, if applicable +.IP "csi" 12 +Command set identifier, see \fIenum nvme_csi\fP for known values +.IP "lsi" 12 +Log Specific Identifier +.IP "lsp" 12 +Log specific field +.IP "uuidx" 12 +UUID selection, if supported +.IP "rae" 12 +Retain asynchronous events +.IP "ot" 12 +Offset Type; if set \fIlpo\fP specifies the index into the list +of data structures, otherwise \fIlpo\fP specifies the byte offset +into the log page. diff --git a/doc/man/nvme_get_log_boot_partition.2 b/doc/man/nvme_get_log_boot_partition.2 new file mode 100644 index 0000000..b6917b1 --- /dev/null +++ b/doc/man/nvme_get_log_boot_partition.2 @@ -0,0 +1,25 @@ +.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_boot_partition \- +.SH SYNOPSIS +.B "int" nvme_get_log_boot_partition +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u8 lsp " "," +.BI "__u32 len " "," +.BI "struct nvme_boot_partition *part " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "lsp" 12 +The log specified field of LID +.IP "len" 12 +The allocated size, minimum +struct nvme_boot_partition +.IP "part" 12 +User address to store the log page +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_changed_ns_list.2 b/doc/man/nvme_get_log_changed_ns_list.2 new file mode 100644 index 0000000..ce4984d --- /dev/null +++ b/doc/man/nvme_get_log_changed_ns_list.2 @@ -0,0 +1,22 @@ +.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_changed_ns_list \- Retrieve namespace changed list +.SH SYNOPSIS +.B "int" nvme_get_log_changed_ns_list +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_ns_list *ns_log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "ns_log" 12 +User address to store the log page +.SH "DESCRIPTION" +This log page describes namespaces attached to this controller that have +changed since the last time the namespace was identified, been added, or +deleted. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_cmd_effects.2 b/doc/man/nvme_get_log_cmd_effects.2 new file mode 100644 index 0000000..b443981 --- /dev/null +++ b/doc/man/nvme_get_log_cmd_effects.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_cmd_effects \- Retrieve nvme command effects log +.SH SYNOPSIS +.B "int" nvme_get_log_cmd_effects +.BI "(int fd " "," +.BI "enum nvme_csi csi " "," +.BI "struct nvme_cmd_effects_log *effects_log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "csi" 12 +Command Set Identifier +.IP "effects_log" 12 +User address to store the effects log +.SH "DESCRIPTION" +This log page describes the commands that the controller supports and the +effects of those commands on the state of the NVM subsystem. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_create_telemetry_host.2 b/doc/man/nvme_get_log_create_telemetry_host.2 new file mode 100644 index 0000000..59328c7 --- /dev/null +++ b/doc/man/nvme_get_log_create_telemetry_host.2 @@ -0,0 +1,12 @@ +.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_create_telemetry_host \- Create host telemetry log +.SH SYNOPSIS +.B "int" nvme_get_log_create_telemetry_host +.BI "(int fd " "," +.BI "struct nvme_telemetry_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "log" 12 +Userspace address of the log payload diff --git a/doc/man/nvme_get_log_device_self_test.2 b/doc/man/nvme_get_log_device_self_test.2 new file mode 100644 index 0000000..262e223 --- /dev/null +++ b/doc/man/nvme_get_log_device_self_test.2 @@ -0,0 +1,19 @@ +.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_device_self_test \- Retrieve the device self test log +.SH SYNOPSIS +.B "int" nvme_get_log_device_self_test +.BI "(int fd " "," +.BI "struct nvme_self_test_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "log" 12 +Userspace address of the log payload +.SH "DESCRIPTION" +The log page indicates the status of an in progress self test and the +percent complete of that operation, and the results of the previous 20 +self-test operations. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_discovery.2 b/doc/man/nvme_get_log_discovery.2 new file mode 100644 index 0000000..cc84ee9 --- /dev/null +++ b/doc/man/nvme_get_log_discovery.2 @@ -0,0 +1,27 @@ +.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_discovery \- +.SH SYNOPSIS +.B "int" nvme_get_log_discovery +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u32 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "offset" 12 +Offset of this log to retrieve +.IP "len" 12 +The allocated size for this portion of the log +.IP "log" 12 +User address to store the discovery log +.SH "DESCRIPTION" +Supported only by fabrics discovery controllers, returning discovery +records. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_endurance_group.2 b/doc/man/nvme_get_log_endurance_group.2 new file mode 100644 index 0000000..7a305f7 --- /dev/null +++ b/doc/man/nvme_get_log_endurance_group.2 @@ -0,0 +1,25 @@ +.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_endurance_group \- +.SH SYNOPSIS +.B "int" nvme_get_log_endurance_group +.BI "(int fd " "," +.BI "__u16 endgid " "," +.BI "struct nvme_endurance_group_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "endgid" 12 +Starting group identifier to return in the list +.IP "log" 12 +User address to store the endurance log +.SH "DESCRIPTION" +This log page indicates if an Endurance Group Event has occurred for a +particular Endurance Group. If an Endurance Group Event has occurred, the +details of the particular event are included in the Endurance Group +Information log page for that Endurance Group. An asynchronous event is +generated when an entry for an Endurance Group is newly added to this log +page. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_endurance_grp_evt.2 b/doc/man/nvme_get_log_endurance_grp_evt.2 new file mode 100644 index 0000000..81f1536 --- /dev/null +++ b/doc/man/nvme_get_log_endurance_grp_evt.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_endurance_grp_evt \- +.SH SYNOPSIS +.B "int" nvme_get_log_endurance_grp_evt +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u32 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "offset" 12 +Offset to the start of the log page +.IP "len" 12 +The allocated length of the log page +.IP "log" 12 +User address to store the log page diff --git a/doc/man/nvme_get_log_error.2 b/doc/man/nvme_get_log_error.2 new file mode 100644 index 0000000..2bcf0aa --- /dev/null +++ b/doc/man/nvme_get_log_error.2 @@ -0,0 +1,25 @@ +.TH "nvme_get_log_error" 9 "nvme_get_log_error" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_error \- Retrieve nvme error log +.SH SYNOPSIS +.B "int" nvme_get_log_error +.BI "(int fd " "," +.BI "unsigned nr_entries " "," +.BI "bool rae " "," +.BI "struct nvme_error_log_page *err_log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nr_entries" 12 +Number of error log entries allocated +.IP "rae" 12 +Retain asynchronous events +.IP "err_log" 12 +Array of error logs of size 'entries' +.SH "DESCRIPTION" +This log page describes extended error information for a command that +completed with error, or may report an error that is not specific to a +particular command. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_fid_supported_effects.2 b/doc/man/nvme_get_log_fid_supported_effects.2 new file mode 100644 index 0000000..ebe2223 --- /dev/null +++ b/doc/man/nvme_get_log_fid_supported_effects.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_fid_supported_effects \- +.SH SYNOPSIS +.B "int" nvme_get_log_fid_supported_effects +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_fid_supported_effects_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +FID Supported and Effects data structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_fw_slot.2 b/doc/man/nvme_get_log_fw_slot.2 new file mode 100644 index 0000000..5ab7744 --- /dev/null +++ b/doc/man/nvme_get_log_fw_slot.2 @@ -0,0 +1,22 @@ +.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_fw_slot \- Retrieves the controller firmware log +.SH SYNOPSIS +.B "int" nvme_get_log_fw_slot +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_firmware_slot *fw_log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "fw_log" 12 +User address to store the log page +.SH "DESCRIPTION" +This log page describes the firmware revision stored in each firmware slot +supported. The firmware revision is indicated as an ASCII string. The log +page also indicates the active slot number. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_lba_status.2 b/doc/man/nvme_get_log_lba_status.2 new file mode 100644 index 0000000..f339eaa --- /dev/null +++ b/doc/man/nvme_get_log_lba_status.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_lba_status \- +.SH SYNOPSIS +.B "int" nvme_get_log_lba_status +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u64 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "offset" 12 +Offset to the start of the log page +.IP "len" 12 +The allocated length of the log page +.IP "log" 12 +User address to store the log page diff --git a/doc/man/nvme_get_log_media_unit_stat.2 b/doc/man/nvme_get_log_media_unit_stat.2 new file mode 100644 index 0000000..8c40d10 --- /dev/null +++ b/doc/man/nvme_get_log_media_unit_stat.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_media_unit_stat \- +.SH SYNOPSIS +.B "int" nvme_get_log_media_unit_stat +.BI "(int fd " "," +.BI "__u16 domid " "," +.BI "struct nvme_media_unit_stat_log *mus " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "domid" 12 +Domain Identifier selection, if supported +.IP "mus" 12 +User address to store the Media Unit statistics log +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_mi_cmd_supported_effects.2 b/doc/man/nvme_get_log_mi_cmd_supported_effects.2 new file mode 100644 index 0000000..82e1aa7 --- /dev/null +++ b/doc/man/nvme_get_log_mi_cmd_supported_effects.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported byt the controller +.SH SYNOPSIS +.B "int" nvme_get_log_mi_cmd_supported_effects +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_mi_cmd_supported_effects_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +MI Command Supported and Effects data structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_page.2 b/doc/man/nvme_get_log_page.2 new file mode 100644 index 0000000..59edb54 --- /dev/null +++ b/doc/man/nvme_get_log_page.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_page" 9 "nvme_get_log_page" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_page \- Get log page data +.SH SYNOPSIS +.B "int" nvme_get_log_page +.BI "(int fd " "," +.BI "__u32 xfer_len " "," +.BI "struct nvme_get_log_args *args " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "xfer_len" 12 +Max log transfer size per request to split the total. +.IP "args" 12 +\fIstruct nvme_get_log_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_persistent_event.2 b/doc/man/nvme_get_log_persistent_event.2 new file mode 100644 index 0000000..d95e984 --- /dev/null +++ b/doc/man/nvme_get_log_persistent_event.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_persistent_event \- +.SH SYNOPSIS +.B "int" nvme_get_log_persistent_event +.BI "(int fd " "," +.BI "enum nvme_pevent_log_action action " "," +.BI "__u32 size " "," +.BI "void *pevent_log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "action" 12 +Action the controller should take during processing this command +.IP "size" 12 +Size of \fIpevent_log\fP +.IP "pevent_log" 12 +User address to store the persistent event log diff --git a/doc/man/nvme_get_log_predictable_lat_event.2 b/doc/man/nvme_get_log_predictable_lat_event.2 new file mode 100644 index 0000000..a796c95 --- /dev/null +++ b/doc/man/nvme_get_log_predictable_lat_event.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_predictable_lat_event \- +.SH SYNOPSIS +.B "int" nvme_get_log_predictable_lat_event +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u32 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "offset" 12 +Offset into the predictable latency event +.IP "len" 12 +Length of provided user buffer to hold the log data in bytes +.IP "log" 12 +User address for log page data diff --git a/doc/man/nvme_get_log_predictable_lat_nvmset.2 b/doc/man/nvme_get_log_predictable_lat_nvmset.2 new file mode 100644 index 0000000..089c9d9 --- /dev/null +++ b/doc/man/nvme_get_log_predictable_lat_nvmset.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_predictable_lat_nvmset \- +.SH SYNOPSIS +.B "int" nvme_get_log_predictable_lat_nvmset +.BI "(int fd " "," +.BI "__u16 nvmsetid " "," +.BI "struct nvme_nvmset_predictable_lat_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nvmsetid" 12 +NVM set id +.IP "log" 12 +User address to store the predictable latency log +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_reservation.2 b/doc/man/nvme_get_log_reservation.2 new file mode 100644 index 0000000..af522a2 --- /dev/null +++ b/doc/man/nvme_get_log_reservation.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_reservation \- +.SH SYNOPSIS +.B "int" nvme_get_log_reservation +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_resv_notification_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +User address to store the reservation log diff --git a/doc/man/nvme_get_log_sanitize.2 b/doc/man/nvme_get_log_sanitize.2 new file mode 100644 index 0000000..7210a04 --- /dev/null +++ b/doc/man/nvme_get_log_sanitize.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_sanitize \- +.SH SYNOPSIS +.B "int" nvme_get_log_sanitize +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_sanitize_log_page *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +User address to store the sanitize log +.SH "DESCRIPTION" +The Sanitize Status log page reports sanitize operation time estimates and +information about the most recent sanitize operation. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_smart.2 b/doc/man/nvme_get_log_smart.2 new file mode 100644 index 0000000..5e6c1e6 --- /dev/null +++ b/doc/man/nvme_get_log_smart.2 @@ -0,0 +1,28 @@ +.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_smart \- Retrieve nvme smart log +.SH SYNOPSIS +.B "int" nvme_get_log_smart +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "bool rae " "," +.BI "struct nvme_smart_log *smart_log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Optional namespace identifier +.IP "rae" 12 +Retain asynchronous events +.IP "smart_log" 12 +User address to store the smart log +.SH "DESCRIPTION" +This log page provides SMART and general health information. The information +provided is over the life of the controller and is retained across power +cycles. To request the controller log page, the namespace identifier +specified is FFFFFFFFh. The controller may also support requesting the log +page on a per namespace basis, as indicated by bit 0 of the LPA field in the +Identify Controller data structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_support_cap_config_list.2 b/doc/man/nvme_get_log_support_cap_config_list.2 new file mode 100644 index 0000000..9eaea26 --- /dev/null +++ b/doc/man/nvme_get_log_support_cap_config_list.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_support_cap_config_list \- +.SH SYNOPSIS +.B "int" nvme_get_log_support_cap_config_list +.BI "(int fd " "," +.BI "__u16 domid " "," +.BI "struct nvme_supported_cap_config_list_log *cap " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "domid" 12 +Domain Identifier selection, if supported +.IP "cap" 12 +-- undescribed -- +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_supported_log_pages.2 b/doc/man/nvme_get_log_supported_log_pages.2 new file mode 100644 index 0000000..6376164 --- /dev/null +++ b/doc/man/nvme_get_log_supported_log_pages.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_supported_log_pages \- Retrieve nmve supported log pages +.SH SYNOPSIS +.B "int" nvme_get_log_supported_log_pages +.BI "(int fd " "," +.BI "bool rae " "," +.BI "struct nvme_supported_log_pages *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +Array of LID supported and Effects data structures +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_telemetry_ctrl.2 b/doc/man/nvme_get_log_telemetry_ctrl.2 new file mode 100644 index 0000000..4d97df7 --- /dev/null +++ b/doc/man/nvme_get_log_telemetry_ctrl.2 @@ -0,0 +1,21 @@ +.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_telemetry_ctrl \- +.SH SYNOPSIS +.B "int" nvme_get_log_telemetry_ctrl +.BI "(int fd " "," +.BI "bool rae " "," +.BI "__u64 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rae" 12 +Retain asynchronous events +.IP "offset" 12 +Offset into the telemetry data +.IP "len" 12 +Length of provided user buffer to hold the log data in bytes +.IP "log" 12 +User address for log page data diff --git a/doc/man/nvme_get_log_telemetry_host.2 b/doc/man/nvme_get_log_telemetry_host.2 new file mode 100644 index 0000000..de8a91a --- /dev/null +++ b/doc/man/nvme_get_log_telemetry_host.2 @@ -0,0 +1,24 @@ +.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_telemetry_host \- +.SH SYNOPSIS +.B "int" nvme_get_log_telemetry_host +.BI "(int fd " "," +.BI "__u64 offset " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "offset" 12 +Offset into the telemetry data +.IP "len" 12 +Length of provided user buffer to hold the log data in bytes +.IP "log" 12 +User address for log page data +.SH "DESCRIPTION" +Retreives the Telemetry Host-Initiated log page at the requested offset +using the previously existing capture. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_zns_changed_zones.2 b/doc/man/nvme_get_log_zns_changed_zones.2 new file mode 100644 index 0000000..8877aaa --- /dev/null +++ b/doc/man/nvme_get_log_zns_changed_zones.2 @@ -0,0 +1,23 @@ +.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_log_zns_changed_zones \- +.SH SYNOPSIS +.B "int" nvme_get_log_zns_changed_zones +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "bool rae " "," +.BI "struct nvme_zns_changed_zone_log *log " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +User address to store the changed zone log +.SH "DESCRIPTION" +The list of zones that have changed state due to an exceptional event. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_logical_block_size.2 b/doc/man/nvme_get_logical_block_size.2 new file mode 100644 index 0000000..b8709eb --- /dev/null +++ b/doc/man/nvme_get_logical_block_size.2 @@ -0,0 +1,18 @@ +.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_logical_block_size \- Retrieve block size +.SH SYNOPSIS +.B "int" nvme_get_logical_block_size +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "int *blksize " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace id +.IP "blksize" 12 +Pointer to where the block size will be set on success +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_new_host_telemetry.2 b/doc/man/nvme_get_new_host_telemetry.2 new file mode 100644 index 0000000..f7bea6a --- /dev/null +++ b/doc/man/nvme_get_new_host_telemetry.2 @@ -0,0 +1,24 @@ +.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_new_host_telemetry \- Get new host telemetry log +.SH SYNOPSIS +.B "int" nvme_get_new_host_telemetry +.BI "(int fd " "," +.BI "struct nvme_telemetry_log **log " "," +.BI "enum nvme_telemetry_da da " "," +.BI "size_t *size " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "log" 12 +On success, set to the value of the allocated and retrieved log. +.IP "da" 12 +Log page data area, valid values: \fIenum nvme_telemetry_da\fP +.IP "size" 12 +Ptr to the telemetry log size, so it can be returned +.SH "DESCRIPTION" +The total size allocated can be calculated as: +(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_ns_attr.2 b/doc/man/nvme_get_ns_attr.2 new file mode 100644 index 0000000..9d001d9 --- /dev/null +++ b/doc/man/nvme_get_ns_attr.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_ns_attr \- Read namespace sysfs attribute +.SH SYNOPSIS +.B "char *" nvme_get_ns_attr +.BI "(nvme_ns_t n " "," +.BI "const char *attr " ");" +.SH ARGUMENTS +.IP "n" 12 +nvme_ns_t object +.IP "attr" 12 +sysfs attribute name +.SH "RETURN" +String with the contents of \fIattr\fP or NULL in case of an empty value +or in case of an error (indicated by non-zero errno code). diff --git a/doc/man/nvme_get_nsid.2 b/doc/man/nvme_get_nsid.2 new file mode 100644 index 0000000..dcdfe02 --- /dev/null +++ b/doc/man/nvme_get_nsid.2 @@ -0,0 +1,19 @@ +.TH "nvme_get_nsid" 9 "nvme_get_nsid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_nsid \- Retrieve the NSID from a namespace file descriptor +.SH SYNOPSIS +.B "int" nvme_get_nsid +.BI "(int fd " "," +.BI "__u32 *nsid " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme namespace +.IP "nsid" 12 +User pointer to namespace id +.SH "DESCRIPTION" +This should only be sent to namespace handles, not to controllers. The +kernel's interface returns the nsid as the return value. This is unfortunate +for many architectures that are incapable of allowing distinguishing a +namespace id > 0x80000000 from a negative error number. +.SH "RETURN" +0 if \fInsid\fP was set successfully or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_path_attr.2 b/doc/man/nvme_get_path_attr.2 new file mode 100644 index 0000000..ca3ed4f --- /dev/null +++ b/doc/man/nvme_get_path_attr.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_path_attr \- Read path sysfs attribute +.SH SYNOPSIS +.B "char *" nvme_get_path_attr +.BI "(nvme_path_t p " "," +.BI "const char *attr " ");" +.SH ARGUMENTS +.IP "p" 12 +nvme_path_t object +.IP "attr" 12 +sysfs attribute name +.SH "RETURN" +String with the contents of \fIattr\fP or NULL in case of an empty value +or in case of an error (indicated by non-zero errno code). diff --git a/doc/man/nvme_get_property.2 b/doc/man/nvme_get_property.2 new file mode 100644 index 0000000..8988ae7 --- /dev/null +++ b/doc/man/nvme_get_property.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_property" 9 "nvme_get_property" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_property \- Get a controller property +.SH SYNOPSIS +.B "int" nvme_get_property +.BI "(struct nvme_get_property_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_get_propert_args\fP argument structure +.SH "DESCRIPTION" +This is an NVMe-over-Fabrics specific command, not applicable to PCIe. These +properties align to the PCI MMIO controller registers. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_property_args.2 b/doc/man/nvme_get_property_args.2 new file mode 100644 index 0000000..f7cb1f3 --- /dev/null +++ b/doc/man/nvme_get_property_args.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_get_property_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_get_property_args \- Arguments for NVMe Get Property command +.SH SYNOPSIS +struct nvme_get_property_args { +.br +.BI " __u64 *value;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " int offset;" +.br +.BI " +}; +.br + +.SH Members +.IP "value" 12 +Where the property's value will be stored on success +.IP "args_size" 12 +Size of \fIstruct nvme_get_property_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "offset" 12 +Property offset from the base to retrieve diff --git a/doc/man/nvme_get_subsys_attr.2 b/doc/man/nvme_get_subsys_attr.2 new file mode 100644 index 0000000..6d738ef --- /dev/null +++ b/doc/man/nvme_get_subsys_attr.2 @@ -0,0 +1,15 @@ +.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_get_subsys_attr \- Read subsystem sysfs attribute +.SH SYNOPSIS +.B "char *" nvme_get_subsys_attr +.BI "(nvme_subsystem_t s " "," +.BI "const char *attr " ");" +.SH ARGUMENTS +.IP "s" 12 +nvme_subsystem_t object +.IP "attr" 12 +sysfs attribute name +.SH "RETURN" +String with the contents of \fIattr\fP or NULL in case of an empty value +or in case of an error (indicated by non-zero errno code). diff --git a/doc/man/nvme_hmac_alg.2 b/doc/man/nvme_hmac_alg.2 new file mode 100644 index 0000000..be6a07c --- /dev/null +++ b/doc/man/nvme_hmac_alg.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_hmac_alg" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_hmac_alg \- HMAC algorithm +.SH SYNOPSIS +enum nvme_hmac_alg { +.br +.BI " NVME_HMAC_ALG_NONE" +, +.br +.br +.BI " NVME_HMAC_ALG_SHA2_256" +, +.br +.br +.BI " NVME_HMAC_ALG_SHA2_384" +, +.br +.br +.BI " NVME_HMAC_ALG_SHA2_512" + +}; +.SH Constants +.IP "NVME_HMAC_ALG_NONE" 12 +No HMAC algorithm +.IP "NVME_HMAC_ALG_SHA2_256" 12 +SHA2-256 +.IP "NVME_HMAC_ALG_SHA2_384" 12 +SHA2-384 +.IP "NVME_HMAC_ALG_SHA2_512" 12 +SHA2-512 diff --git a/doc/man/nvme_host_behavior_support.2 b/doc/man/nvme_host_behavior_support.2 new file mode 100644 index 0000000..c70a25d --- /dev/null +++ b/doc/man/nvme_host_behavior_support.2 @@ -0,0 +1,12 @@ +.TH "libnvme" 9 "enum nvme_host_behavior_support" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_host_behavior_support \- +.SH SYNOPSIS +enum nvme_host_behavior_support { +.br +.BI " NVME_ENABLE_ACRE" + +}; +.SH Constants +.IP "NVME_ENABLE_ACRE" 12 +Enable Advanced Command Retry Enable diff --git a/doc/man/nvme_host_get_dhchap_key.2 b/doc/man/nvme_host_get_dhchap_key.2 new file mode 100644 index 0000000..06505a2 --- /dev/null +++ b/doc/man/nvme_host_get_dhchap_key.2 @@ -0,0 +1,11 @@ +.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_get_dhchap_key \- Return host key +.SH SYNOPSIS +.B "const char *" nvme_host_get_dhchap_key +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +Host for which the key should be returned +.SH "RETURN" +DH-HMAC-CHAP host key or NULL if not set diff --git a/doc/man/nvme_host_get_hostid.2 b/doc/man/nvme_host_get_hostid.2 new file mode 100644 index 0000000..6e34d5c --- /dev/null +++ b/doc/man/nvme_host_get_hostid.2 @@ -0,0 +1,11 @@ +.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_get_hostid \- Host ID of an nvme_host_t object +.SH SYNOPSIS +.B "const char *" nvme_host_get_hostid +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +nvme_host_t object +.SH "RETURN" +Host ID of \fIh\fP diff --git a/doc/man/nvme_host_get_hostnqn.2 b/doc/man/nvme_host_get_hostnqn.2 new file mode 100644 index 0000000..24c44f2 --- /dev/null +++ b/doc/man/nvme_host_get_hostnqn.2 @@ -0,0 +1,11 @@ +.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_get_hostnqn \- Host NQN of an nvme_host_t object +.SH SYNOPSIS +.B "const char *" nvme_host_get_hostnqn +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +nvme_host_t object +.SH "RETURN" +Host NQN of \fIh\fP diff --git a/doc/man/nvme_host_get_hostsymname.2 b/doc/man/nvme_host_get_hostsymname.2 new file mode 100644 index 0000000..9232596 --- /dev/null +++ b/doc/man/nvme_host_get_hostsymname.2 @@ -0,0 +1,12 @@ +.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_get_hostsymname \- Get the host's symbolic name +.SH SYNOPSIS +.B "const char *" nvme_host_get_hostsymname +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +Host for which the symbolic name should be returned. +.SH "RETURN" +The symbolic name or NULL if a symbolic name hasn't been +configure. diff --git a/doc/man/nvme_host_get_root.2 b/doc/man/nvme_host_get_root.2 new file mode 100644 index 0000000..e2c2f92 --- /dev/null +++ b/doc/man/nvme_host_get_root.2 @@ -0,0 +1,11 @@ +.TH "nvme_host_get_root" 9 "nvme_host_get_root" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_get_root \- Returns nvme_root_t object +.SH SYNOPSIS +.B "nvme_root_t" nvme_host_get_root +.BI "(nvme_host_t h " ");" +.SH ARGUMENTS +.IP "h" 12 +\fInvme_host_t\fP object +.SH "RETURN" +\fInvme_root_t\fP object from \fIh\fP diff --git a/doc/man/nvme_host_mem_buf_attrs.2 b/doc/man/nvme_host_mem_buf_attrs.2 new file mode 100644 index 0000000..83bd190 --- /dev/null +++ b/doc/man/nvme_host_mem_buf_attrs.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_host_mem_buf_attrs \- +.SH SYNOPSIS +struct nvme_host_mem_buf_attrs { +.br +.BI " __le32 hsize;" +.br +.BI " __le32 hmdlal;" +.br +.BI " __le32 hmdlau;" +.br +.BI " __le32 hmdlec;" +.br +.BI " __u8 rsvd16[4080];" +.br +.BI " +}; +.br + +.SH Members +.IP "hsize" 12 +Host Memory Buffer Size +.IP "hmdlal" 12 +Host Memory Descriptor List Lower Address +.IP "hmdlau" 12 +Host Memory Descriptor List Upper Address +.IP "hmdlec" 12 +Host Memory Descriptor List Entry Count +.IP "rsvd16" 12 +Reserved diff --git a/doc/man/nvme_host_metadata.2 b/doc/man/nvme_host_metadata.2 new file mode 100644 index 0000000..beed508 --- /dev/null +++ b/doc/man/nvme_host_metadata.2 @@ -0,0 +1,33 @@ +.TH "libnvme" 9 "struct nvme_host_metadata" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_host_metadata \- Host Metadata Data Structure +.SH SYNOPSIS +struct nvme_host_metadata { +.br +.BI " __u8 ndesc;" +.br +.BI " __u8 rsvd1;" +.br +.BI " union {" +.br +.BI " struct nvme_metadata_element_desc descs[0];" +.br +.BI " __u8 descs_buf[4094];" +.br +.BI " };" +.br +.BI " +}; +.br + +.SH Members +.IP "ndesc" 12 +Number of metadata element descriptors +.IP "rsvd1" 12 +Reserved +.IP "{unnamed_union}" 12 +anonymous +.IP "descs" 12 +Metadata element descriptors +.IP "descs_buf" 12 +Metadata element descriptor buffer diff --git a/doc/man/nvme_host_set_dhchap_key.2 b/doc/man/nvme_host_set_dhchap_key.2 new file mode 100644 index 0000000..e7a7a1a --- /dev/null +++ b/doc/man/nvme_host_set_dhchap_key.2 @@ -0,0 +1,12 @@ +.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_set_dhchap_key \- set host key +.SH SYNOPSIS +.B "void" nvme_host_set_dhchap_key +.BI "(nvme_host_t h " "," +.BI "const char *key " ");" +.SH ARGUMENTS +.IP "h" 12 +Host for which the key should be set +.IP "key" 12 +DH-HMAC-CHAP Key to set or NULL to clear existing key diff --git a/doc/man/nvme_host_set_hostsymname.2 b/doc/man/nvme_host_set_hostsymname.2 new file mode 100644 index 0000000..54c0b43 --- /dev/null +++ b/doc/man/nvme_host_set_hostsymname.2 @@ -0,0 +1,12 @@ +.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_host_set_hostsymname \- Set the host's symbolic name +.SH SYNOPSIS +.B "void" nvme_host_set_hostsymname +.BI "(nvme_host_t h " "," +.BI "const char *hostsymname " ");" +.SH ARGUMENTS +.IP "h" 12 +Host for which the symbolic name should be set. +.IP "hostsymname" 12 +Symbolic name diff --git a/doc/man/nvme_id_ctrl.2 b/doc/man/nvme_id_ctrl.2 new file mode 100644 index 0000000..e42c4df --- /dev/null +++ b/doc/man/nvme_id_ctrl.2 @@ -0,0 +1,505 @@ +.TH "libnvme" 9 "struct nvme_id_ctrl" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_ctrl \- Identify Controller data structure +.SH SYNOPSIS +struct nvme_id_ctrl { +.br +.BI " __le16 vid;" +.br +.BI " __le16 ssvid;" +.br +.BI " char sn[20];" +.br +.BI " char mn[40];" +.br +.BI " char fr[8];" +.br +.BI " __u8 rab;" +.br +.BI " __u8 ieee[3];" +.br +.BI " __u8 cmic;" +.br +.BI " __u8 mdts;" +.br +.BI " __le16 cntlid;" +.br +.BI " __le32 ver;" +.br +.BI " __le32 rtd3r;" +.br +.BI " __le32 rtd3e;" +.br +.BI " __le32 oaes;" +.br +.BI " __le32 ctratt;" +.br +.BI " __le16 rrls;" +.br +.BI " __u8 rsvd102[9];" +.br +.BI " __u8 cntrltype;" +.br +.BI " __u8 fguid[16];" +.br +.BI " __le16 crdt1;" +.br +.BI " __le16 crdt2;" +.br +.BI " __le16 crdt3;" +.br +.BI " __u8 rsvd134[119];" +.br +.BI " __u8 nvmsr;" +.br +.BI " __u8 vwci;" +.br +.BI " __u8 mec;" +.br +.BI " __le16 oacs;" +.br +.BI " __u8 acl;" +.br +.BI " __u8 aerl;" +.br +.BI " __u8 frmw;" +.br +.BI " __u8 lpa;" +.br +.BI " __u8 elpe;" +.br +.BI " __u8 npss;" +.br +.BI " __u8 avscc;" +.br +.BI " __u8 apsta;" +.br +.BI " __le16 wctemp;" +.br +.BI " __le16 cctemp;" +.br +.BI " __le16 mtfa;" +.br +.BI " __le32 hmpre;" +.br +.BI " __le32 hmmin;" +.br +.BI " __u8 tnvmcap[16];" +.br +.BI " __u8 unvmcap[16];" +.br +.BI " __le32 rpmbs;" +.br +.BI " __le16 edstt;" +.br +.BI " __u8 dsto;" +.br +.BI " __u8 fwug;" +.br +.BI " __le16 kas;" +.br +.BI " __le16 hctma;" +.br +.BI " __le16 mntmt;" +.br +.BI " __le16 mxtmt;" +.br +.BI " __le32 sanicap;" +.br +.BI " __le32 hmminds;" +.br +.BI " __le16 hmmaxd;" +.br +.BI " __le16 nsetidmax;" +.br +.BI " __le16 endgidmax;" +.br +.BI " __u8 anatt;" +.br +.BI " __u8 anacap;" +.br +.BI " __le32 anagrpmax;" +.br +.BI " __le32 nanagrpid;" +.br +.BI " __le32 pels;" +.br +.BI " __le16 domainid;" +.br +.BI " __u8 rsvd358[10];" +.br +.BI " __u8 megcap[16];" +.br +.BI " __u8 rsvd384[128];" +.br +.BI " __u8 sqes;" +.br +.BI " __u8 cqes;" +.br +.BI " __le16 maxcmd;" +.br +.BI " __le32 nn;" +.br +.BI " __le16 oncs;" +.br +.BI " __le16 fuses;" +.br +.BI " __u8 fna;" +.br +.BI " __u8 vwc;" +.br +.BI " __le16 awun;" +.br +.BI " __le16 awupf;" +.br +.BI " __u8 icsvscc;" +.br +.BI " __u8 nwpc;" +.br +.BI " __le16 acwu;" +.br +.BI " __le16 ocfs;" +.br +.BI " __le32 sgls;" +.br +.BI " __le32 mnan;" +.br +.BI " __u8 maxdna[16];" +.br +.BI " __le32 maxcna;" +.br +.BI " __u8 rsvd564[204];" +.br +.BI " char subnqn[NVME_NQN_LENGTH];" +.br +.BI " __u8 rsvd1024[768];" +.br +.BI " __le32 ioccsz;" +.br +.BI " __le32 iorcsz;" +.br +.BI " __le16 icdoff;" +.br +.BI " __u8 fcatt;" +.br +.BI " __u8 msdbd;" +.br +.BI " __le16 ofcs;" +.br +.BI " __u8 dctype;" +.br +.BI " __u8 rsvd1807[241];" +.br +.BI " struct nvme_id_psd psd[32];" +.br +.BI " __u8 vs[1024];" +.br +.BI " +}; +.br + +.SH Members +.IP "vid" 12 +PCI Vendor ID, the company vendor identifier that is assigned by +the PCI SIG. +.IP "ssvid" 12 +PCI Subsystem Vendor ID, the company vendor identifier that is +assigned by the PCI SIG for the subsystem. +.IP "sn" 12 +Serial Number in ascii +.IP "mn" 12 +Model Number in ascii +.IP "fr" 12 +Firmware Revision in ascii, the currently active firmware +revision for the NVM subsystem +.IP "rab" 12 +Recommended Arbitration Burst, reported as a power of two +.IP "ieee" 12 +IEEE assigned Organization Unique Identifier +.IP "cmic" 12 +Controller Multipath IO and Namespace Sharing Capabilities of +the controller and NVM subsystem. See \fIenum nvme_id_ctrl_cmic\fP. +.IP "mdts" 12 +Max Data Transfer Size is the largest data transfer size. The +host should not submit a command that exceeds this maximum data +transfer size. The value is in units of the minimum memory page +size (CAP.MPSMIN) and is reported as a power of two +.IP "cntlid" 12 +Controller ID, the NVM subsystem unique controller identifier +associated with the controller. +.IP "ver" 12 +Version, this field contains the value reported in the Version +register, or property (see \fIenum nvme_registers\fP NVME_REG_VS). +.IP "rtd3r" 12 +RTD3 Resume Latency, the expected latency in microseconds to resume +from Runtime D3 +.IP "rtd3e" 12 +RTD3 Exit Latency, the typical latency in microseconds to enter +Runtime D3. +.IP "oaes" 12 +Optional Async Events Supported, see \fIenum\fP nvme_id_ctrl_oaes. +.IP "ctratt" 12 +Controller Attributes, see \fIenum\fP nvme_id_ctrl_ctratt. +.IP "rrls" 12 +Read Recovery Levels. If a bit is set, then the corresponding +Read Recovery Level is supported. If a bit is cleared, then the +corresponding Read Recovery Level is not supported. +.IP "rsvd102" 12 +Reserved +.IP "cntrltype" 12 +Controller Type, see \fIenum nvme_id_ctrl_cntrltype\fP +.IP "fguid" 12 +FRU GUID, a 128-bit value that is globally unique for a given +Field Replaceable Unit +.IP "crdt1" 12 +Controller Retry Delay time in 100 millisecod units if CQE CRD +field is 1 +.IP "crdt2" 12 +Controller Retry Delay time in 100 millisecod units if CQE CRD +field is 2 +.IP "crdt3" 12 +Controller Retry Delay time in 100 millisecod units if CQE CRD +field is 3 +.IP "rsvd134" 12 +Reserved +.IP "nvmsr" 12 +NVM Subsystem Report, see \fIenum nvme_id_ctrl_nvmsr\fP +.IP "vwci" 12 +VPD Write Cycle Information, see \fIenum nvme_id_ctrl_vwci\fP +.IP "mec" 12 +Management Endpoint Capabilities, see \fIenum nvme_id_ctrl_mec\fP +.IP "oacs" 12 +Optional Admin Command Support,the optional Admin commands and +features supported by the controller, see \fIenum nvme_id_ctrl_oacs\fP. +.IP "acl" 12 +Abort Command Limit, the maximum number of concurrently +executing Abort commands supported by the controller. This is a +0's based value. +.IP "aerl" 12 +Async Event Request Limit, the maximum number of concurrently +outstanding Asynchronous Event Request commands supported by the +controller This is a 0's based value. +.IP "frmw" 12 +Firmware Updates indicates capabilities regarding firmware +updates. See \fIenum nvme_id_ctrl_frmw\fP. +.IP "lpa" 12 +Log Page Attributes, see \fIenum nvme_id_ctrl_lpa\fP. +.IP "elpe" 12 +Error Log Page Entries, the maximum number of Error Information +log entries that are stored by the controller. This field is a +0's based value. +.IP "npss" 12 +Number of Power States Supported, the number of NVM Express +power states supported by the controller, indicating the number +of valid entries in \fIstruct nvme_id_ctrl\fP.psd. This is a 0's +based value. +.IP "avscc" 12 +Admin Vendor Specific Command Configuration, see +\fIenum nvme_id_ctrl_avscc\fP. +.IP "apsta" 12 +Autonomous Power State Transition Attributes, see +\fIenum nvme_id_ctrl_apsta\fP. +.IP "wctemp" 12 +Warning Composite Temperature Threshold indicates +the minimum Composite Temperature field value (see \fIstruct +nvme_smart_log\fP.critical_comp_time) that indicates an overheating +condition during which controller operation continues. +.IP "cctemp" 12 +Critical Composite Temperature Threshold, field indicates the +minimum Composite Temperature field value (see \fIstruct +nvme_smart_log\fP.critical_comp_time) that indicates a critical +overheating condition. +.IP "mtfa" 12 +Maximum Time for Firmware Activation indicates the maximum time +the controller temporarily stops processing commands to activate +the firmware image, specified in 100 millisecond units. This +field is always valid if the controller supports firmware +activation without a reset. +.IP "hmpre" 12 +Host Memory Buffer Preferred Size indicates the preferred size +that the host is requested to allocate for the Host Memory +Buffer feature in 4 KiB units. +.IP "hmmin" 12 +Host Memory Buffer Minimum Size indicates the minimum size that +the host is requested to allocate for the Host Memory Buffer +feature in 4 KiB units. +.IP "tnvmcap" 12 +Total NVM Capacity, the total NVM capacity in the NVM subsystem. +The value is in bytes. +.IP "unvmcap" 12 +Unallocated NVM Capacity, the unallocated NVM capacity in the +NVM subsystem. The value is in bytes. +.IP "rpmbs" 12 +Replay Protected Memory Block Support, see +\fIenum nvme_id_ctrl_rpmbs\fP. +.IP "edstt" 12 +Extended Device Self-test Time, if Device Self-test command is +supported (see \fIstruct nvme_id_ctrl\fP.oacs, NVME_CTRL_OACS_SELF_TEST), +then this field indicates the nominal amount of time in one +minute units that the controller takes to complete an extended +device self-test operation when in power state 0. +.IP "dsto" 12 +Device Self-test Options, see \fIenum nvme_id_ctrl_dsto\fP. +.IP "fwug" 12 +Firmware Update Granularity indicates the granularity and +alignment requirement of the firmware image being updated by the +Firmware Image Download command. The value is reported in 4 KiB +units. A value of 0h indicates no information on granularity is +provided. A value of FFh indicates no restriction +.IP "kas" 12 +Keep Alive Support indicates the granularity of the Keep Alive +Timer in 100 millisecond units. +.IP "hctma" 12 +Host Controlled Thermal Management Attributes, see +\fIenum nvme_id_ctrl_hctm\fP. +.IP "mntmt" 12 +Minimum Thermal Management Temperature indicates the minimum +temperature, in degrees Kelvin, that the host may request in the +Thermal Management Temperature 1 field and Thermal Management +Temperature 2 field of a Set Features command with the Feature +Identifier field set to NVME_FEAT_FID_HCTM. +.IP "mxtmt" 12 +Maximum Thermal Management Temperature indicates the maximum +temperature, in degrees Kelvin, that the host may request in the +Thermal Management Temperature 1 field and Thermal Management +Temperature 2 field of the Set Features command with the Feature +Identifier set to NVME_FEAT_FID_HCTM. +.IP "sanicap" 12 +Sanitize Capabilities, see \fIenum nvme_id_ctrl_sanicap\fP +.IP "hmminds" 12 +Host Memory Buffer Minimum Descriptor Entry Size indicates the +minimum usable size of a Host Memory Buffer Descriptor Entry in +4 KiB units. +.IP "hmmaxd" 12 +Host Memory Maximum Descriptors Entries indicates the number of +usable Host Memory Buffer Descriptor Entries. +.IP "nsetidmax" 12 +NVM Set Identifier Maximum, defines the maximum value of a valid +NVM Set Identifier for any controller in the NVM subsystem. +.IP "endgidmax" 12 +Endurance Group Identifier Maximum, defines the maximum value of +a valid Endurance Group Identifier for any controller in the NVM +subsystem. +.IP "anatt" 12 +ANA Transition Time indicates the maximum amount of time, in +seconds, for a transition between ANA states or the maximum +amount of time, in seconds, that the controller reports the ANA +change state. +.IP "anacap" 12 +Asymmetric Namespace Access Capabilities, see +\fIenum nvme_id_ctrl_anacap\fP. +.IP "anagrpmax" 12 +ANA Group Identifier Maximum indicates the maximum value of a +valid ANA Group Identifier for any controller in the NVM +subsystem. +.IP "nanagrpid" 12 +Number of ANA Group Identifiers indicates the number of ANA +groups supported by this controller. +.IP "pels" 12 +Persistent Event Log Size indicates the maximum reportable size +for the Persistent Event Log. +.IP "domainid" 12 +Domain Identifier indicates the identifier of the domain +that contains this controller. +.IP "rsvd358" 12 +Reserved +.IP "megcap" 12 +Max Endurance Group Capacity indicates the maximum capacity +of a single Endurance Group. +.IP "rsvd384" 12 +Reserved +.IP "sqes" 12 +Submission Queue Entry Size, see \fIenum nvme_id_ctrl_sqes\fP. +.IP "cqes" 12 +Completion Queue Entry Size, see \fIenum nvme_id_ctrl_cqes\fP. +.IP "maxcmd" 12 +Maximum Outstanding Commands indicates the maximum number of +commands that the controller processes at one time for a +particular queue. +.IP "nn" 12 +Number of Namespaces indicates the maximum value of a valid +nsid for the NVM subsystem. If the MNAN (\fIstruct nvme_id_ctrl\fP.mnan +field is cleared to 0h, then this field also indicates the +maximum number of namespaces supported by the NVM subsystem. +.IP "oncs" 12 +Optional NVM Command Support, see \fIenum nvme_id_ctrl_oncs\fP. +.IP "fuses" 12 +Fused Operation Support, see \fIenum nvme_id_ctrl_fuses\fP. +.IP "fna" 12 +Format NVM Attributes, see \fIenum nvme_id_ctrl_fna\fP. +.IP "vwc" 12 +Volatile Write Cache, see \fIenum nvme_id_ctrl_vwc\fP. +.IP "awun" 12 +Atomic Write Unit Normal indicates the size of the write +operation guaranteed to be written atomically to the NVM across +all namespaces with any supported namespace format during normal +operation. This field is specified in logical blocks and is a +0's based value. +.IP "awupf" 12 +Atomic Write Unit Power Fail indicates the size of the write +operation guaranteed to be written atomically to the NVM across +all namespaces with any supported namespace format during a +power fail or error condition. This field is specified in +logical blocks and is a 0’s based value. +.IP "icsvscc" 12 +NVM Vendor Specific Command Configuration, see +\fIenum nvme_id_ctrl_nvscc\fP. +.IP "nwpc" 12 +Namespace Write Protection Capabilities, see +\fIenum nvme_id_ctrl_nwpc\fP. +.IP "acwu" 12 +Atomic Compare & Write Unit indicates the size of the write +operation guaranteed to be written atomically to the NVM across +all namespaces with any supported namespace format for a Compare +and Write fused operation. This field is specified in logical +blocks and is a 0’s based value. +.IP "ocfs" 12 +Optional Copy Formats Supported, each bit n means controller +supports Copy Format n. +.IP "sgls" 12 +SGL Support, see \fIenum nvme_id_ctrl_sgls\fP +.IP "mnan" 12 +Maximum Number of Allowed Namespaces indicates the maximum +number of namespaces supported by the NVM subsystem. +.IP "maxdna" 12 +Maximum Domain Namespace Attachments indicates the maximum +of the sum of the numver of namespaces attached to each I/O +controller in the Domain. +.IP "maxcna" 12 +Maximum I/O Controller Namespace Attachments indicates the +maximum number of namespaces that are allowed to be attached to +this I/O controller. +.IP "rsvd564" 12 +Reserved +.IP "subnqn" 12 +NVM Subsystem NVMe Qualified Name, UTF-8 null terminated string +.IP "rsvd1024" 12 +Reserved +.IP "ioccsz" 12 +I/O Queue Command Capsule Supported Size, defines the maximum +I/O command capsule size in 16 byte units. +.IP "iorcsz" 12 +I/O Queue Response Capsule Supported Size, defines the maximum +I/O response capsule size in 16 byte units. +.IP "icdoff" 12 +In Capsule Data Offset, defines the offset where data starts +within a capsule. This value is applicable to I/O Queues only. +.IP "fcatt" 12 +Fabrics Controller Attributes, see \fIenum nvme_id_ctrl_fcatt\fP. +.IP "msdbd" 12 +Maximum SGL Data Block Descriptors indicates the maximum +number of SGL Data Block or Keyed SGL Data Block descriptors +that a host is allowed to place in a capsule. A value of 0h +indicates no limit. +.IP "ofcs" 12 +Optional Fabric Commands Support, see \fIenum nvme_id_ctrl_ofcs\fP. +.IP "dctype" 12 +Discovery Controller Type (DCTYPE). This field indicates what +type of Discovery controller the controller is (see enum +nvme_id_ctrl_dctype) +.IP "rsvd1807" 12 +Reserved +.IP "psd" 12 +Power State Descriptors, see \fIstruct nvme_id_psd\fP. +.IP "vs" 12 +Vendor Specific diff --git a/doc/man/nvme_id_ctrl_anacap.2 b/doc/man/nvme_id_ctrl_anacap.2 new file mode 100644 index 0000000..f5106b6 --- /dev/null +++ b/doc/man/nvme_id_ctrl_anacap.2 @@ -0,0 +1,59 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_anacap \- This field indicates the capabilities associated with Asymmetric Namespace Access Reporting. +.SH SYNOPSIS +enum nvme_id_ctrl_anacap { +.br +.BI " NVME_CTRL_ANACAP_OPT" +, +.br +.br +.BI " NVME_CTRL_ANACAP_NON_OPT" +, +.br +.br +.BI " NVME_CTRL_ANACAP_INACCESSIBLE" +, +.br +.br +.BI " NVME_CTRL_ANACAP_PERSISTENT_LOSS" +, +.br +.br +.BI " NVME_CTRL_ANACAP_CHANGE" +, +.br +.br +.BI " NVME_CTRL_ANACAP_GRPID_NO_CHG" +, +.br +.br +.BI " NVME_CTRL_ANACAP_GRPID_MGMT" + +}; +.SH Constants +.IP "NVME_CTRL_ANACAP_OPT" 12 +If set, then the controller is able to +report ANA Optimized state. +.IP "NVME_CTRL_ANACAP_NON_OPT" 12 +If set, then the controller is able to +report ANA Non-Optimized state. +.IP "NVME_CTRL_ANACAP_INACCESSIBLE" 12 +If set, then the controller is able to +report ANA Inaccessible state. +.IP "NVME_CTRL_ANACAP_PERSISTENT_LOSS" 12 +If set, then the controller is able to +report ANA Persistent Loss state. +.IP "NVME_CTRL_ANACAP_CHANGE" 12 +If set, then the controller is able to +report ANA Change state. +.IP "NVME_CTRL_ANACAP_GRPID_NO_CHG" 12 +If set, then the ANAGRPID field in the +Identify Namespace data structure +(\fIstruct nvme_id_ns\fP.anagrpid), does not +change while the namespace is attached to +any controller. +.IP "NVME_CTRL_ANACAP_GRPID_MGMT" 12 +If set, then the controller supports a +non-zero value in the ANAGRPID field of +the Namespace Management command. diff --git a/doc/man/nvme_id_ctrl_apsta.2 b/doc/man/nvme_id_ctrl_apsta.2 new file mode 100644 index 0000000..c0c62c2 --- /dev/null +++ b/doc/man/nvme_id_ctrl_apsta.2 @@ -0,0 +1,13 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_apsta \- Flags indicating the attributes of the autonomous power state transition feature. +.SH SYNOPSIS +enum nvme_id_ctrl_apsta { +.br +.BI " NVME_CTRL_APSTA_APST" + +}; +.SH Constants +.IP "NVME_CTRL_APSTA_APST" 12 +If set, then the controller supports autonomous power +state transitions. diff --git a/doc/man/nvme_id_ctrl_avscc.2 b/doc/man/nvme_id_ctrl_avscc.2 new file mode 100644 index 0000000..8864a80 --- /dev/null +++ b/doc/man/nvme_id_ctrl_avscc.2 @@ -0,0 +1,14 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_avscc \- Flags indicating the configuration settings for Admin Vendor Specific command handling. +.SH SYNOPSIS +enum nvme_id_ctrl_avscc { +.br +.BI " NVME_CTRL_AVSCC_AVS" + +}; +.SH Constants +.IP "NVME_CTRL_AVSCC_AVS" 12 +If set, all Admin Vendor Specific Commands use the +optional vendor specific command format with NDT and +NDM fields. diff --git a/doc/man/nvme_id_ctrl_cmic.2 b/doc/man/nvme_id_ctrl_cmic.2 new file mode 100644 index 0000000..1844dcd --- /dev/null +++ b/doc/man/nvme_id_ctrl_cmic.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_cmic \- Controller Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem. +.SH SYNOPSIS +enum nvme_id_ctrl_cmic { +.br +.BI " NVME_CTRL_CMIC_MULTI_PORT" +, +.br +.br +.BI " NVME_CTRL_CMIC_MULTI_CTRL" +, +.br +.br +.BI " NVME_CTRL_CMIC_MULTI_SRIOV" +, +.br +.br +.BI " NVME_CTRL_CMIC_MULTI_ANA_REPORTING" + +}; +.SH Constants +.IP "NVME_CTRL_CMIC_MULTI_PORT" 12 +If set, then the NVM subsystem may contain +more than one NVM subsystem port, otherwise +the NVM subsystem contains only a single +NVM subsystem port. +.IP "NVME_CTRL_CMIC_MULTI_CTRL" 12 +If set, then the NVM subsystem may contain +two or more controllers, otherwise the +NVM subsystem contains only a single +controller. An NVM subsystem that contains +multiple controllers may be used by +multiple hosts, or may provide multiple +paths for a single host. +.IP "NVME_CTRL_CMIC_MULTI_SRIOV" 12 +If set, then the controller is associated +with an SR-IOV Virtual Function, otherwise +it is associated with a PCI Function +or a Fabrics connection. +.IP "NVME_CTRL_CMIC_MULTI_ANA_REPORTING" 12 +If set, then the NVM subsystem supports +Asymmetric Namespace Access Reporting. diff --git a/doc/man/nvme_id_ctrl_cntrltype.2 b/doc/man/nvme_id_ctrl_cntrltype.2 new file mode 100644 index 0000000..9b3e6d8 --- /dev/null +++ b/doc/man/nvme_id_ctrl_cntrltype.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_cntrltype \- Controller types +.SH SYNOPSIS +enum nvme_id_ctrl_cntrltype { +.br +.BI " NVME_CTRL_CNTRLTYPE_IO" +, +.br +.br +.BI " NVME_CTRL_CNTRLTYPE_DISCOVERY" +, +.br +.br +.BI " NVME_CTRL_CNTRLTYPE_ADMIN" + +}; +.SH Constants +.IP "NVME_CTRL_CNTRLTYPE_IO" 12 +NVM I/O controller +.IP "NVME_CTRL_CNTRLTYPE_DISCOVERY" 12 +Discovery controller +.IP "NVME_CTRL_CNTRLTYPE_ADMIN" 12 +Admin controller diff --git a/doc/man/nvme_id_ctrl_cqes.2 b/doc/man/nvme_id_ctrl_cqes.2 new file mode 100644 index 0000000..d3914f0 --- /dev/null +++ b/doc/man/nvme_id_ctrl_cqes.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_cqes \- Defines the required and maximum Completion Queue entry size when using the NVM Command Set. +.SH SYNOPSIS +enum nvme_id_ctrl_cqes { +.br +.BI " NVME_CTRL_CQES_MIN" +, +.br +.br +.BI " NVME_CTRL_CQES_MAX" + +}; +.SH Constants +.IP "NVME_CTRL_CQES_MIN" 12 +Mask to get the value of the required Completion Queue +Entry size when using the NVM Command Set. +.IP "NVME_CTRL_CQES_MAX" 12 +Mask to get the value of the maximum Completion Queue +entry size when using the NVM Command Set. diff --git a/doc/man/nvme_id_ctrl_ctratt.2 b/doc/man/nvme_id_ctrl_ctratt.2 new file mode 100644 index 0000000..3ee3da9 --- /dev/null +++ b/doc/man/nvme_id_ctrl_ctratt.2 @@ -0,0 +1,104 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_ctratt \- Controller attributes +.SH SYNOPSIS +enum nvme_id_ctrl_ctratt { +.br +.BI " NVME_CTRL_CTRATT_128_ID" +, +.br +.br +.BI " NVME_CTRL_CTRATT_NON_OP_PSP" +, +.br +.br +.BI " NVME_CTRL_CTRATT_NVM_SETS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_READ_RECV_LVLS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_ENDURANCE_GROUPS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_PREDICTABLE_LAT" +, +.br +.br +.BI " NVME_CTRL_CTRATT_TBKAS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_NAMESPACE_GRANULARITY" +, +.br +.br +.BI " NVME_CTRL_CTRATT_SQ_ASSOCIATIONS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_UUID_LIST" +, +.br +.br +.BI " NVME_CTRL_CTRATT_MDS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_FIXED_CAP" +, +.br +.br +.BI " NVME_CTRL_CTRATT_VARIABLE_CAP" +, +.br +.br +.BI " NVME_CTRL_CTRATT_DEL_ENDURANCE_GROUPS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_DEL_NVM_SETS" +, +.br +.br +.BI " NVME_CTRL_CTRATT_ELBAS" + +}; +.SH Constants +.IP "NVME_CTRL_CTRATT_128_ID" 12 +128-bit Host Identifier supported +.IP "NVME_CTRL_CTRATT_NON_OP_PSP" 12 +Non-Operational Poser State Permissive Mode +supported +.IP "NVME_CTRL_CTRATT_NVM_SETS" 12 +NVM Sets supported +.IP "NVME_CTRL_CTRATT_READ_RECV_LVLS" 12 +Read Recovery Levels supported +.IP "NVME_CTRL_CTRATT_ENDURANCE_GROUPS" 12 +Endurance Groups supported +.IP "NVME_CTRL_CTRATT_PREDICTABLE_LAT" 12 +Predictable Latency Mode supported +.IP "NVME_CTRL_CTRATT_TBKAS" 12 +Traffic Based Keep Alive Support +.IP "NVME_CTRL_CTRATT_NAMESPACE_GRANULARITY" 12 +Namespace Granularity reporting +supported +.IP "NVME_CTRL_CTRATT_SQ_ASSOCIATIONS" 12 +SQ Associations supported +.IP "NVME_CTRL_CTRATT_UUID_LIST" 12 +UUID List reporting supported +.IP "NVME_CTRL_CTRATT_MDS" 12 +Multi-Domain Subsystem supported +.IP "NVME_CTRL_CTRATT_FIXED_CAP" 12 +Fixed Capacity Management supported +.IP "NVME_CTRL_CTRATT_VARIABLE_CAP" 12 +Variable Capacity Managment supported +.IP "NVME_CTRL_CTRATT_DEL_ENDURANCE_GROUPS" 12 +Delete Endurance Groups supported +.IP "NVME_CTRL_CTRATT_DEL_NVM_SETS" 12 +Delete NVM Sets supported +.IP "NVME_CTRL_CTRATT_ELBAS" 12 +Extended LBA Formats supported diff --git a/doc/man/nvme_id_ctrl_dctype.2 b/doc/man/nvme_id_ctrl_dctype.2 new file mode 100644 index 0000000..5548874 --- /dev/null +++ b/doc/man/nvme_id_ctrl_dctype.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_dctype \- Discovery Controller types +.SH SYNOPSIS +enum nvme_id_ctrl_dctype { +.br +.BI " NVME_CTRL_DCTYPE_NOT_REPORTED" +, +.br +.br +.BI " NVME_CTRL_DCTYPE_DDC" +, +.br +.br +.BI " NVME_CTRL_DCTYPE_CDC" + +}; +.SH Constants +.IP "NVME_CTRL_DCTYPE_NOT_REPORTED" 12 +Not reported (I/O, Admin, and pre-TP8010) +.IP "NVME_CTRL_DCTYPE_DDC" 12 +Direct Discovery controller +.IP "NVME_CTRL_DCTYPE_CDC" 12 +Central Discovery controller diff --git a/doc/man/nvme_id_ctrl_dsto.2 b/doc/man/nvme_id_ctrl_dsto.2 new file mode 100644 index 0000000..2ede49c --- /dev/null +++ b/doc/man/nvme_id_ctrl_dsto.2 @@ -0,0 +1,13 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_dsto \- Flags indicating the optional Device Self-test command or operation behaviors supported by the controller or NVM subsystem. +.SH SYNOPSIS +enum nvme_id_ctrl_dsto { +.br +.BI " NVME_CTRL_DSTO_ONE_DST" + +}; +.SH Constants +.IP "NVME_CTRL_DSTO_ONE_DST" 12 +If set, then the NVM subsystem supports only one +device self-test operation in progress at a time. diff --git a/doc/man/nvme_id_ctrl_fcatt.2 b/doc/man/nvme_id_ctrl_fcatt.2 new file mode 100644 index 0000000..2f15f13 --- /dev/null +++ b/doc/man/nvme_id_ctrl_fcatt.2 @@ -0,0 +1,14 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_fcatt \- This field indicates attributes of the controller that are specific to NVMe over Fabrics. +.SH SYNOPSIS +enum nvme_id_ctrl_fcatt { +.br +.BI " NVME_CTRL_FCATT_DYNAMIC" + +}; +.SH Constants +.IP "NVME_CTRL_FCATT_DYNAMIC" 12 +If cleared, then the NVM subsystem uses a dynamic +controller model. If set, then the NVM subsystem +uses a static controller model. diff --git a/doc/man/nvme_id_ctrl_fna.2 b/doc/man/nvme_id_ctrl_fna.2 new file mode 100644 index 0000000..7b68f26 --- /dev/null +++ b/doc/man/nvme_id_ctrl_fna.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_fna \- This field indicates attributes for the Format NVM command. +.SH SYNOPSIS +enum nvme_id_ctrl_fna { +.br +.BI " NVME_CTRL_FNA_FMT_ALL_NAMESPACES" +, +.br +.br +.BI " NVME_CTRL_FNA_SEC_ALL_NAMESPACES" +, +.br +.br +.BI " NVME_CTRL_FNA_CRYPTO_ERASE" + +}; +.SH Constants +.IP "NVME_CTRL_FNA_FMT_ALL_NAMESPACES" 12 +If set, then all namespaces in an NVM +subsystem shall be configured with the +same attributes and a format (excluding +secure erase) of any namespace results in +a format of all namespaces in an NVM +subsystem. If cleared, then the +controller supports format on a per +namespace basis. +.IP "NVME_CTRL_FNA_SEC_ALL_NAMESPACES" 12 +If set, then any secure erase performed +as part of a format operation results in +a secure erase of all namespaces in the +NVM subsystem. If cleared, then any +secure erase performed as part of a +format results in a secure erase of the +particular namespace specified. +.IP "NVME_CTRL_FNA_CRYPTO_ERASE" 12 +If set, then cryptographic erase is +supported. If cleared, then cryptographic +erase is not supported. diff --git a/doc/man/nvme_id_ctrl_frmw.2 b/doc/man/nvme_id_ctrl_frmw.2 new file mode 100644 index 0000000..f9e6fb0 --- /dev/null +++ b/doc/man/nvme_id_ctrl_frmw.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_frmw \- Flags and values indicates capabilities regarding firmware updates from &struct nvme_id_ctrl.frmw. +.SH SYNOPSIS +enum nvme_id_ctrl_frmw { +.br +.BI " NVME_CTRL_FRMW_1ST_RO" +, +.br +.br +.BI " NVME_CTRL_FRMW_NR_SLOTS" +, +.br +.br +.BI " NVME_CTRL_FRMW_FW_ACT_NO_RESET" + +}; +.SH Constants +.IP "NVME_CTRL_FRMW_1ST_RO" 12 +If set, the first firmware slot is readonly +.IP "NVME_CTRL_FRMW_NR_SLOTS" 12 +Mask to get the value of the number of +firmware slots that the controller supports. +.IP "NVME_CTRL_FRMW_FW_ACT_NO_RESET" 12 +If set, the controller supports firmware +activation without a reset. diff --git a/doc/man/nvme_id_ctrl_fuses.2 b/doc/man/nvme_id_ctrl_fuses.2 new file mode 100644 index 0000000..27634d4 --- /dev/null +++ b/doc/man/nvme_id_ctrl_fuses.2 @@ -0,0 +1,13 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_fuses \- This field indicates the fused operations that the controller supports. +.SH SYNOPSIS +enum nvme_id_ctrl_fuses { +.br +.BI " NVME_CTRL_FUSES_COMPARE_AND_WRITE" + +}; +.SH Constants +.IP "NVME_CTRL_FUSES_COMPARE_AND_WRITE" 12 +If set, then the controller supports the +Compare and Write fused operation. diff --git a/doc/man/nvme_id_ctrl_hctm.2 b/doc/man/nvme_id_ctrl_hctm.2 new file mode 100644 index 0000000..e6d11bf --- /dev/null +++ b/doc/man/nvme_id_ctrl_hctm.2 @@ -0,0 +1,15 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_hctm \- Flags indicate the attributes of the host controlled thermal management feature +.SH SYNOPSIS +enum nvme_id_ctrl_hctm { +.br +.BI " NVME_CTRL_HCTMA_HCTM" + +}; +.SH Constants +.IP "NVME_CTRL_HCTMA_HCTM" 12 +then the controller supports host controlled thermal +management, and the Set Features command and Get +Features command with the Feature Identifier field +set to NVME_FEAT_FID_HCTM. diff --git a/doc/man/nvme_id_ctrl_lpa.2 b/doc/man/nvme_id_ctrl_lpa.2 new file mode 100644 index 0000000..1b88b89 --- /dev/null +++ b/doc/man/nvme_id_ctrl_lpa.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_lpa \- Flags indicating optional attributes for log pages that are accessed via the Get Log Page command. +.SH SYNOPSIS +enum nvme_id_ctrl_lpa { +.br +.BI " NVME_CTRL_LPA_SMART_PER_NS" +, +.br +.br +.BI " NVME_CTRL_LPA_CMD_EFFECTS" +, +.br +.br +.BI " NVME_CTRL_LPA_EXTENDED" +, +.br +.br +.BI " NVME_CTRL_LPA_TELEMETRY" +, +.br +.br +.BI " NVME_CTRL_LPA_PERSETENT_EVENT" + +}; +.SH Constants +.IP "NVME_CTRL_LPA_SMART_PER_NS" 12 +.IP "NVME_CTRL_LPA_CMD_EFFECTS" 12 +.IP "NVME_CTRL_LPA_EXTENDED" 12 +.IP "NVME_CTRL_LPA_TELEMETRY" 12 +.IP "NVME_CTRL_LPA_PERSETENT_EVENT" 12 diff --git a/doc/man/nvme_id_ctrl_mec.2 b/doc/man/nvme_id_ctrl_mec.2 new file mode 100644 index 0000000..afa77b6 --- /dev/null +++ b/doc/man/nvme_id_ctrl_mec.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_mec \- Flags indicatings the capabilities of the Management Endpoint in the Controller, &struct nvme_id_ctrl.mec. +.SH SYNOPSIS +enum nvme_id_ctrl_mec { +.br +.BI " NVME_CTRL_MEC_SMBUSME" +, +.br +.br +.BI " NVME_CTRL_MEC_PCIEME" + +}; +.SH Constants +.IP "NVME_CTRL_MEC_SMBUSME" 12 +If set, then the NVM Subsystem contains a Management +Endpoint on an SMBus/I2C port. +.IP "NVME_CTRL_MEC_PCIEME" 12 +If set, then the NVM Subsystem contains a Management +Endpoint on a PCIe port. diff --git a/doc/man/nvme_id_ctrl_nvm.2 b/doc/man/nvme_id_ctrl_nvm.2 new file mode 100644 index 0000000..16554ff --- /dev/null +++ b/doc/man/nvme_id_ctrl_nvm.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_ctrl_nvm \- +.SH SYNOPSIS +struct nvme_id_ctrl_nvm { +.br +.BI " __u8 vsl;" +.br +.BI " __u8 wzsl;" +.br +.BI " __u8 wusl;" +.br +.BI " __u8 dmrl;" +.br +.BI " __u32 dmrsl;" +.br +.BI " __u64 dmsl;" +.br +.BI " __u8 rsvd16[4080];" +.br +.BI " +}; +.br + +.SH Members +.IP "vsl" 12 +Verify Size Limit +.IP "wzsl" 12 +Write Zeroes Size Limit +.IP "wusl" 12 +Write Uncorrectable Size Limit +.IP "dmrl" 12 +Dataset Management Ranges Limit +.IP "dmrsl" 12 +Dataset Management Range Size Limit +.IP "dmsl" 12 +Dataset Management Size Limit +.IP "rsvd16" 12 +reserved diff --git a/doc/man/nvme_id_ctrl_nvmsr.2 b/doc/man/nvme_id_ctrl_nvmsr.2 new file mode 100644 index 0000000..e0b118f --- /dev/null +++ b/doc/man/nvme_id_ctrl_nvmsr.2 @@ -0,0 +1,22 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_nvmsr \- This field reports information associated with the NVM Subsystem, see &struct nvme_id_ctrl.nvmsr. +.SH SYNOPSIS +enum nvme_id_ctrl_nvmsr { +.br +.BI " NVME_CTRL_NVMSR_NVMESD" +, +.br +.br +.BI " NVME_CTRL_NVMSR_NVMEE" + +}; +.SH Constants +.IP "NVME_CTRL_NVMSR_NVMESD" 12 +If set, then the NVM Subsystem is part of an NVMe +Storage Device; if cleared, then the NVM Subsystem +is not part of an NVMe Storage Device. +.IP "NVME_CTRL_NVMSR_NVMEE" 12 +If set’, then the NVM Subsystem is part of an NVMe +Enclosure; if cleared, then the NVM Subsystem is +not part of an NVMe Enclosure. diff --git a/doc/man/nvme_id_ctrl_nvscc.2 b/doc/man/nvme_id_ctrl_nvscc.2 new file mode 100644 index 0000000..077c6ef --- /dev/null +++ b/doc/man/nvme_id_ctrl_nvscc.2 @@ -0,0 +1,13 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_nvscc \- This field indicates the configuration settings for NVM Vendor Specific command handling. +.SH SYNOPSIS +enum nvme_id_ctrl_nvscc { +.br +.BI " NVME_CTRL_NVSCC_FMT" + +}; +.SH Constants +.IP "NVME_CTRL_NVSCC_FMT" 12 +If set, all NVM Vendor Specific Commands use the +format format with NDT and NDM fields. diff --git a/doc/man/nvme_id_ctrl_nwpc.2 b/doc/man/nvme_id_ctrl_nwpc.2 new file mode 100644 index 0000000..794afe2 --- /dev/null +++ b/doc/man/nvme_id_ctrl_nwpc.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_nwpc \- This field indicates the optional namespace write protection capabilities supported by the controller. +.SH SYNOPSIS +enum nvme_id_ctrl_nwpc { +.br +.BI " NVME_CTRL_NWPC_WRITE_PROTECT" +, +.br +.br +.BI " NVME_CTRL_NWPC_WRITE_PROTECT_POWER_CYCLE" +, +.br +.br +.BI " NVME_CTRL_NWPC_WRITE_PROTECT_PERMANENT" + +}; +.SH Constants +.IP "NVME_CTRL_NWPC_WRITE_PROTECT" 12 +If set, then the controller shall +support the No Write Protect and +Write Protect namespace write +protection states and may support +the Write Protect Until Power +Cycle state and Permanent Write +Protect namespace write +protection states. +.IP "NVME_CTRL_NWPC_WRITE_PROTECT_POWER_CYCLE" 12 +If set, then the controller +supports the Write Protect Until +Power Cycle state. +.IP "NVME_CTRL_NWPC_WRITE_PROTECT_PERMANENT" 12 +If set, then the controller +supports the Permanent Write +Protect state. diff --git a/doc/man/nvme_id_ctrl_oacs.2 b/doc/man/nvme_id_ctrl_oacs.2 new file mode 100644 index 0000000..d5ae344 --- /dev/null +++ b/doc/man/nvme_id_ctrl_oacs.2 @@ -0,0 +1,77 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_oacs \- Flags indicating the optional Admin commands and features supported by the controller, see &struct nvme_id_ctrl.oacs. +.SH SYNOPSIS +enum nvme_id_ctrl_oacs { +.br +.BI " NVME_CTRL_OACS_SECURITY" +, +.br +.br +.BI " NVME_CTRL_OACS_FORMAT" +, +.br +.br +.BI " NVME_CTRL_OACS_FW" +, +.br +.br +.BI " NVME_CTRL_OACS_NS_MGMT" +, +.br +.br +.BI " NVME_CTRL_OACS_SELF_TEST" +, +.br +.br +.BI " NVME_CTRL_OACS_DIRECTIVES" +, +.br +.br +.BI " NVME_CTRL_OACS_NVME_MI" +, +.br +.br +.BI " NVME_CTRL_OACS_VIRT_MGMT" +, +.br +.br +.BI " NVME_CTRL_OACS_DBBUF_CFG" +, +.br +.br +.BI " NVME_CTRL_OACS_LBA_STATUS" + +}; +.SH Constants +.IP "NVME_CTRL_OACS_SECURITY" 12 +If set, then the controller supports the +Security Send and Security Receive commands. +.IP "NVME_CTRL_OACS_FORMAT" 12 +If set then the controller supports the Format +NVM command. +.IP "NVME_CTRL_OACS_FW" 12 +If set, then the controller supports the +Firmware Commit and Firmware Image Download commands. +.IP "NVME_CTRL_OACS_NS_MGMT" 12 +If set, then the controller supports the +Namespace Management capability +.IP "NVME_CTRL_OACS_SELF_TEST" 12 +If set, then the controller supports the Device +Self-test command. +.IP "NVME_CTRL_OACS_DIRECTIVES" 12 +If set, then the controller supports Directives +and the Directive Send and Directive Receive +commands. +.IP "NVME_CTRL_OACS_NVME_MI" 12 +If set, then the controller supports the NVMe-MI +Send and NVMe-MI Receive commands. +.IP "NVME_CTRL_OACS_VIRT_MGMT" 12 +If set, then the controller supports the +Virtualization Management command. +.IP "NVME_CTRL_OACS_DBBUF_CFG" 12 +If set, then the controller supports the +Doorbell Buffer Config command. +.IP "NVME_CTRL_OACS_LBA_STATUS" 12 +If set, then the controller supports the Get LBA +Status capability. diff --git a/doc/man/nvme_id_ctrl_oaes.2 b/doc/man/nvme_id_ctrl_oaes.2 new file mode 100644 index 0000000..3e27733 --- /dev/null +++ b/doc/man/nvme_id_ctrl_oaes.2 @@ -0,0 +1,62 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_oaes \- Optional Asynchronous Events Supported +.SH SYNOPSIS +enum nvme_id_ctrl_oaes { +.br +.BI " NVME_CTRL_OAES_NA" +, +.br +.br +.BI " NVME_CTRL_OAES_FA" +, +.br +.br +.BI " NVME_CTRL_OAES_ANA" +, +.br +.br +.BI " NVME_CTRL_OAES_PLEA" +, +.br +.br +.BI " NVME_CTRL_OAES_LBAS" +, +.br +.br +.BI " NVME_CTRL_OAES_EGE" +, +.br +.br +.BI " NVME_CTRL_OAES_NS" +, +.br +.br +.BI " NVME_CTRL_OAES_ZD" +, +.br +.br +.BI " NVME_CTRL_OAES_DL" + +}; +.SH Constants +.IP "NVME_CTRL_OAES_NA" 12 +Namespace Attribute Notices event supported +.IP "NVME_CTRL_OAES_FA" 12 +Firmware Activation Notices event supported +.IP "NVME_CTRL_OAES_ANA" 12 +ANA Change Notices supported +.IP "NVME_CTRL_OAES_PLEA" 12 +Predictable Latency Event Aggregate Log +Change Notices event supported +.IP "NVME_CTRL_OAES_LBAS" 12 +LBA Status Information Notices event supported +.IP "NVME_CTRL_OAES_EGE" 12 +Endurance Group Events Aggregate Log Change +Notices event supported +.IP "NVME_CTRL_OAES_NS" 12 +Normal NVM Subsystem Shutdown event supported +.IP "NVME_CTRL_OAES_ZD" 12 +Zone Descriptor Change Notifications supported +.IP "NVME_CTRL_OAES_DL" 12 +Discover Log Page Change Notifications supported diff --git a/doc/man/nvme_id_ctrl_ofcs.2 b/doc/man/nvme_id_ctrl_ofcs.2 new file mode 100644 index 0000000..d03d025 --- /dev/null +++ b/doc/man/nvme_id_ctrl_ofcs.2 @@ -0,0 +1,14 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_ofcs \- Indicate whether the controller supports optional fabric commands. +.SH SYNOPSIS +enum nvme_id_ctrl_ofcs { +.br +.BI " NVME_CTRL_OFCS_DISCONNECT" + +}; +.SH Constants +.IP "NVME_CTRL_OFCS_DISCONNECT" 12 +If set, then the controller supports the +Disconnect command and deletion of individual +I/O Queues. diff --git a/doc/man/nvme_id_ctrl_oncs.2 b/doc/man/nvme_id_ctrl_oncs.2 new file mode 100644 index 0000000..fe711b7 --- /dev/null +++ b/doc/man/nvme_id_ctrl_oncs.2 @@ -0,0 +1,65 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_oncs \- This field indicates the optional NVM commands and features supported by the controller. +.SH SYNOPSIS +enum nvme_id_ctrl_oncs { +.br +.BI " NVME_CTRL_ONCS_COMPARE" +, +.br +.br +.BI " NVME_CTRL_ONCS_WRITE_UNCORRECTABLE" +, +.br +.br +.BI " NVME_CTRL_ONCS_DSM" +, +.br +.br +.BI " NVME_CTRL_ONCS_WRITE_ZEROES" +, +.br +.br +.BI " NVME_CTRL_ONCS_SAVE_FEATURES" +, +.br +.br +.BI " NVME_CTRL_ONCS_RESERVATIONS" +, +.br +.br +.BI " NVME_CTRL_ONCS_TIMESTAMP" +, +.br +.br +.BI " NVME_CTRL_ONCS_VERIFY" + +}; +.SH Constants +.IP "NVME_CTRL_ONCS_COMPARE" 12 +If set, then the controller supports +the Compare command. +.IP "NVME_CTRL_ONCS_WRITE_UNCORRECTABLE" 12 +If set, then the controller supports +the Write Uncorrectable command. +.IP "NVME_CTRL_ONCS_DSM" 12 +If set, then the controller supports +the Dataset Management command. +.IP "NVME_CTRL_ONCS_WRITE_ZEROES" 12 +If set, then the controller supports +the Write Zeroes command. +.IP "NVME_CTRL_ONCS_SAVE_FEATURES" 12 +If set, then the controller supports +the Save field set to a non-zero value +in the Set Features command and the +Select field set to a non-zero value in +the Get Features command. +.IP "NVME_CTRL_ONCS_RESERVATIONS" 12 +If set, then the controller supports +reservations. +.IP "NVME_CTRL_ONCS_TIMESTAMP" 12 +If set, then the controller supports +the Timestamp feature. +.IP "NVME_CTRL_ONCS_VERIFY" 12 +If set, then the controller supports +the Verify command. diff --git a/doc/man/nvme_id_ctrl_rpmbs.2 b/doc/man/nvme_id_ctrl_rpmbs.2 new file mode 100644 index 0000000..95a861c --- /dev/null +++ b/doc/man/nvme_id_ctrl_rpmbs.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_rpmbs \- This field indicates if the controller supports one or more Replay Protected Memory Blocks, from &struct nvme_id_ctrl.rpmbs. +.SH SYNOPSIS +enum nvme_id_ctrl_rpmbs { +.br +.BI " NVME_CTRL_RPMBS_NR_UNITS" +, +.br +.br +.BI " NVME_CTRL_RPMBS_AUTH_METHOD" +, +.br +.br +.BI " NVME_CTRL_RPMBS_TOTAL_SIZE" +, +.br +.br +.BI " NVME_CTRL_RPMBS_ACCESS_SIZE" + +}; +.SH Constants +.IP "NVME_CTRL_RPMBS_NR_UNITS" 12 +Mask to get the value of the Number of RPMB Units +.IP "NVME_CTRL_RPMBS_AUTH_METHOD" 12 +Mask to get the value of the Authentication Method +.IP "NVME_CTRL_RPMBS_TOTAL_SIZE" 12 +Mask to get the value of Total Size +.IP "NVME_CTRL_RPMBS_ACCESS_SIZE" 12 +Mask to get the value of Access Size diff --git a/doc/man/nvme_id_ctrl_sanicap.2 b/doc/man/nvme_id_ctrl_sanicap.2 new file mode 100644 index 0000000..1c09afc --- /dev/null +++ b/doc/man/nvme_id_ctrl_sanicap.2 @@ -0,0 +1,44 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_sanicap \- Indicates attributes for sanitize operations. +.SH SYNOPSIS +enum nvme_id_ctrl_sanicap { +.br +.BI " NVME_CTRL_SANICAP_CES" +, +.br +.br +.BI " NVME_CTRL_SANICAP_BES" +, +.br +.br +.BI " NVME_CTRL_SANICAP_OWS" +, +.br +.br +.BI " NVME_CTRL_SANICAP_NDI" +, +.br +.br +.BI " NVME_CTRL_SANICAP_NODMMAS" + +}; +.SH Constants +.IP "NVME_CTRL_SANICAP_CES" 12 +Crypto Erase Support. If set, then the +controller supports the Crypto Erase sanitize operation. +.IP "NVME_CTRL_SANICAP_BES" 12 +Block Erase Support. If set, then the controller +supports the Block Erase sanitize operation. +.IP "NVME_CTRL_SANICAP_OWS" 12 +Overwrite Support. If set, then the controller +supports the Overwrite sanitize operation. +.IP "NVME_CTRL_SANICAP_NDI" 12 +No-Deallocate Inhibited. If set and the No- +Deallocate Response Mode bit is set, then the +controller deallocates after the sanitize +operation even if the No-Deallocate After +Sanitize bit is set in a Sanitize command. +.IP "NVME_CTRL_SANICAP_NODMMAS" 12 +No-Deallocate Modifies Media After Sanitize, +mask to extract value. diff --git a/doc/man/nvme_id_ctrl_sgls.2 b/doc/man/nvme_id_ctrl_sgls.2 new file mode 100644 index 0000000..efe1ddd --- /dev/null +++ b/doc/man/nvme_id_ctrl_sgls.2 @@ -0,0 +1,46 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_sgls \- This field indicates if SGLs are supported for the NVM Command Set and the particular SGL types supported. +.SH SYNOPSIS +enum nvme_id_ctrl_sgls { +.br +.BI " NVME_CTRL_SGLS_SUPPORTED" +, +.br +.br +.BI " NVME_CTRL_SGLS_KEYED" +, +.br +.br +.BI " NVME_CTRL_SGLS_BIT_BUCKET" +, +.br +.br +.BI " NVME_CTRL_SGLS_MPTR_BYTE_ALIGNED" +, +.br +.br +.BI " NVME_CTRL_SGLS_OVERSIZE" +, +.br +.br +.BI " NVME_CTRL_SGLS_MPTR_SGL" +, +.br +.br +.BI " NVME_CTRL_SGLS_OFFSET" +, +.br +.br +.BI " NVME_CTRL_SGLS_TPORT" + +}; +.SH Constants +.IP "NVME_CTRL_SGLS_SUPPORTED" 12 +.IP "NVME_CTRL_SGLS_KEYED" 12 +.IP "NVME_CTRL_SGLS_BIT_BUCKET" 12 +.IP "NVME_CTRL_SGLS_MPTR_BYTE_ALIGNED" 12 +.IP "NVME_CTRL_SGLS_OVERSIZE" 12 +.IP "NVME_CTRL_SGLS_MPTR_SGL" 12 +.IP "NVME_CTRL_SGLS_OFFSET" 12 +.IP "NVME_CTRL_SGLS_TPORT" 12 diff --git a/doc/man/nvme_id_ctrl_sqes.2 b/doc/man/nvme_id_ctrl_sqes.2 new file mode 100644 index 0000000..4ed6fee --- /dev/null +++ b/doc/man/nvme_id_ctrl_sqes.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_sqes \- Defines the required and maximum Submission Queue entry size when using the NVM Command Set. +.SH SYNOPSIS +enum nvme_id_ctrl_sqes { +.br +.BI " NVME_CTRL_SQES_MIN" +, +.br +.br +.BI " NVME_CTRL_SQES_MAX" + +}; +.SH Constants +.IP "NVME_CTRL_SQES_MIN" 12 +Mask to get the value of the required Submission Queue +Entry size when using the NVM Command Set. +.IP "NVME_CTRL_SQES_MAX" 12 +Mask to get the value of the maximum Submission Queue +entry size when using the NVM Command Set. diff --git a/doc/man/nvme_id_ctrl_vwc.2 b/doc/man/nvme_id_ctrl_vwc.2 new file mode 100644 index 0000000..a020908 --- /dev/null +++ b/doc/man/nvme_id_ctrl_vwc.2 @@ -0,0 +1,22 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_vwc \- +.SH SYNOPSIS +enum nvme_id_ctrl_vwc { +.br +.BI " NVME_CTRL_VWC_PRESENT" +, +.br +.br +.BI " NVME_CTRL_VWC_FLUSH" + +}; +.SH Constants +.IP "NVME_CTRL_VWC_PRESENT" 12 +If set, indicates a volatile write cache is present. +If a volatile write cache is present, then the host +controls whether the volatile write cache is enabled +with a Set Features command specifying the value +NVME_FEAT_FID_VOLATILE_WC. +.IP "NVME_CTRL_VWC_FLUSH" 12 +Mask to get the value of the flush command behavior. diff --git a/doc/man/nvme_id_ctrl_vwci.2 b/doc/man/nvme_id_ctrl_vwci.2 new file mode 100644 index 0000000..4600a2c --- /dev/null +++ b/doc/man/nvme_id_ctrl_vwci.2 @@ -0,0 +1,28 @@ +.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ctrl_vwci \- This field indicates information about remaining number of times that VPD contents are able to be updated using the VPD Write command, see &struct nvme_id_ctrl.vwci. +.SH SYNOPSIS +enum nvme_id_ctrl_vwci { +.br +.BI " NVME_CTRL_VWCI_VWCR" +, +.br +.br +.BI " NVME_CTRL_VWCI_VWCRV" + +}; +.SH Constants +.IP "NVME_CTRL_VWCI_VWCR" 12 +Mask to get value of VPD Write Cycles Remaining. If +the VPD Write Cycle Remaining Valid bit is set, then +this field contains a value indicating the remaining +number of times that VPD contents are able to be +updated using the VPD Write command. If this field is +set to 7Fh, then the remaining number of times that +VPD contents are able to be updated using the VPD +Write command is greater than or equal to 7Fh. +.IP "NVME_CTRL_VWCI_VWCRV" 12 +VPD Write Cycle Remaining Valid. If this bit is set, +then the VPD Write Cycle Remaining field is valid. If +this bit is cleared, then the VPD Write Cycles +Remaining field is invalid and cleared to 0h. diff --git a/doc/man/nvme_id_directives.2 b/doc/man/nvme_id_directives.2 new file mode 100644 index 0000000..29ef330 --- /dev/null +++ b/doc/man/nvme_id_directives.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_id_directives" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_directives \- +.SH SYNOPSIS +struct nvme_id_directives { +.br +.BI " __u8 supported[32];" +.br +.BI " __u8 enabled[32];" +.br +.BI " __u8 rsvd64[4032];" +.br +.BI " +}; +.br + +.SH Members +.IP "supported" 12 +Identify directive is supported +.IP "enabled" 12 +Identify directive is Enabled +.IP "rsvd64" 12 +Reserved diff --git a/doc/man/nvme_id_domain_attr.2 b/doc/man/nvme_id_domain_attr.2 new file mode 100644 index 0000000..fe69d9a --- /dev/null +++ b/doc/man/nvme_id_domain_attr.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_id_domain_attr" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_domain_attr \- Domain Attributes Entry +.SH SYNOPSIS +struct nvme_id_domain_attr { +.br +.BI " __le16 dom_id;" +.br +.BI " __u8 rsvd2[14];" +.br +.BI " __u8 dom_cap[16];" +.br +.BI " __u8 unalloc_dom_cap[16];" +.br +.BI " __u8 max_egrp_dom_cap[16];" +.br +.BI " __u8 rsvd64[64];" +.br +.BI " +}; +.br + +.SH Members +.IP "dom_id" 12 +Domain Identifier +.IP "rsvd2" 12 +Reserved +.IP "dom_cap" 12 +Total Domain Capacity +.IP "unalloc_dom_cap" 12 +Unallocated Domain Capacity +.IP "max_egrp_dom_cap" 12 +Max Endurance Group Domain Capacity +.IP "rsvd64" 12 +Reserved diff --git a/doc/man/nvme_id_domain_list.2 b/doc/man/nvme_id_domain_list.2 new file mode 100644 index 0000000..413aab3 --- /dev/null +++ b/doc/man/nvme_id_domain_list.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_id_domain_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_domain_list \- +.SH SYNOPSIS +struct nvme_id_domain_list { +.br +.BI " __u8 num;" +.br +.BI " __u8 rsvd[127];" +.br +.BI " struct nvme_id_domain_attr domain_attr[NVME_ID_DOMAIN_LIST_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "num" 12 +Number of domain attributes +.IP "rsvd" 12 +Reserved +.IP "domain_attr" 12 +List of domain attributes diff --git a/doc/man/nvme_id_endurance_group_list.2 b/doc/man/nvme_id_endurance_group_list.2 new file mode 100644 index 0000000..30db7cd --- /dev/null +++ b/doc/man/nvme_id_endurance_group_list.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_endurance_group_list \- +.SH SYNOPSIS +struct nvme_id_endurance_group_list { +.br +.BI " __le16 num;" +.br +.BI " __le16 identifier[NVME_ID_ENDURANCE_GROUP_LIST_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "num" 12 +Number of Identifiers +.IP "identifier" 12 +Endurance Group Identifier diff --git a/doc/man/nvme_id_independent_id_ns.2 b/doc/man/nvme_id_independent_id_ns.2 new file mode 100644 index 0000000..03281e0 --- /dev/null +++ b/doc/man/nvme_id_independent_id_ns.2 @@ -0,0 +1,56 @@ +.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_independent_id_ns \- +.SH SYNOPSIS +struct nvme_id_independent_id_ns { +.br +.BI " __u8 nsfeat;" +.br +.BI " __u8 nmic;" +.br +.BI " __u8 rescap;" +.br +.BI " __u8 fpi;" +.br +.BI " __le32 anagrpid;" +.br +.BI " __u8 nsattr;" +.br +.BI " __u8 rsvd9;" +.br +.BI " __le16 nvmsetid;" +.br +.BI " __le16 endgid;" +.br +.BI " __u8 nstat;" +.br +.BI " __u8 rsvd15[4081];" +.br +.BI " +}; +.br + +.SH Members +.IP "nsfeat" 12 +common namespace features +.IP "nmic" 12 +Namespace Multi-path I/O and Namespace +Sharing Capabilities +.IP "rescap" 12 +Reservation Capabilities +.IP "fpi" 12 +Format Progress Indicator +.IP "anagrpid" 12 +ANA Group Identifier +.IP "nsattr" 12 +Namespace Attributes +.IP "rsvd9" 12 +reserved +.IP "nvmsetid" 12 +NVM Set Identifier +.IP "endgid" 12 +Endurance Group Identifier +.IP "nstat" 12 +Namespace Status +.IP "rsvd15" 12 +reserved diff --git a/doc/man/nvme_id_iocs.2 b/doc/man/nvme_id_iocs.2 new file mode 100644 index 0000000..20606c9 --- /dev/null +++ b/doc/man/nvme_id_iocs.2 @@ -0,0 +1,15 @@ +.TH "libnvme" 9 "struct nvme_id_iocs" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_iocs \- NVMe Identify IO Command Set data structure +.SH SYNOPSIS +struct nvme_id_iocs { +.br +.BI " __u64 iocsc[512];" +.br +.BI " +}; +.br + +.SH Members +.IP "iocsc" 12 +List of supported IO Command Set Combination vectors diff --git a/doc/man/nvme_id_ns.2 b/doc/man/nvme_id_ns.2 new file mode 100644 index 0000000..9a82518 --- /dev/null +++ b/doc/man/nvme_id_ns.2 @@ -0,0 +1,237 @@ +.TH "libnvme" 9 "struct nvme_id_ns" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_ns \- Identify Namespace data structure +.SH SYNOPSIS +struct nvme_id_ns { +.br +.BI " __le64 nsze;" +.br +.BI " __le64 ncap;" +.br +.BI " __le64 nuse;" +.br +.BI " __u8 nsfeat;" +.br +.BI " __u8 nlbaf;" +.br +.BI " __u8 flbas;" +.br +.BI " __u8 mc;" +.br +.BI " __u8 dpc;" +.br +.BI " __u8 dps;" +.br +.BI " __u8 nmic;" +.br +.BI " __u8 rescap;" +.br +.BI " __u8 fpi;" +.br +.BI " __u8 dlfeat;" +.br +.BI " __le16 nawun;" +.br +.BI " __le16 nawupf;" +.br +.BI " __le16 nacwu;" +.br +.BI " __le16 nabsn;" +.br +.BI " __le16 nabo;" +.br +.BI " __le16 nabspf;" +.br +.BI " __le16 noiob;" +.br +.BI " __u8 nvmcap[16];" +.br +.BI " __le16 npwg;" +.br +.BI " __le16 npwa;" +.br +.BI " __le16 npdg;" +.br +.BI " __le16 npda;" +.br +.BI " __le16 nows;" +.br +.BI " __le16 mssrl;" +.br +.BI " __le32 mcl;" +.br +.BI " __u8 msrc;" +.br +.BI " __u8 rsvd81;" +.br +.BI " __u8 nulbaf;" +.br +.BI " __u8 rsvd83[9];" +.br +.BI " __le32 anagrpid;" +.br +.BI " __u8 rsvd96[3];" +.br +.BI " __u8 nsattr;" +.br +.BI " __le16 nvmsetid;" +.br +.BI " __le16 endgid;" +.br +.BI " __u8 nguid[16];" +.br +.BI " __u8 eui64[8];" +.br +.BI " struct nvme_lbaf lbaf[64];" +.br +.BI " __le64 lbstm;" +.br +.BI " __u8 vs[3704];" +.br +.BI " +}; +.br + +.SH Members +.IP "nsze" 12 +Namespace Size indicates the total size of the namespace in +logical blocks. The number of logical blocks is based on the +formatted LBA size. +.IP "ncap" 12 +Namespace Capacity indicates the maximum number of logical blocks +that may be allocated in the namespace at any point in time. The +number of logical blocks is based on the formatted LBA size. +.IP "nuse" 12 +Namespace Utilization indicates the current number of logical +blocks allocated in the namespace. This field is smaller than or +equal to the Namespace Capacity. The number of logical blocks is +based on the formatted LBA size. +.IP "nsfeat" 12 +Namespace Features, see \fIenum nvme_id_nsfeat\fP. +.IP "nlbaf" 12 +Number of LBA Formats defines the number of supported LBA data +size and metadata size combinations supported by the namespace +and the highest possible index to \fIstruct nvme_id_ns\fP.lbaf. +.IP "flbas" 12 +Formatted LBA Size, see \fIenum nvme_id_ns_flbas\fP. +.IP "mc" 12 +Metadata Capabilities, see \fIenum nvme_id_ns_mc\fP. +.IP "dpc" 12 +End-to-end Data Protection Capabilities, see +\fIenum nvme_id_ns_dpc\fP. +.IP "dps" 12 +End-to-end Data Protection Type Settings, see +\fIenum nvme_id_ns_dps\fP. +.IP "nmic" 12 +Namespace Multi-path I/O and Namespace Sharing Capabilities, see +\fIenum nvme_id_ns_nmic\fP. +.IP "rescap" 12 +Reservation Capabilities, see \fIenum nvme_id_ns_rescap\fP. +.IP "fpi" 12 +Format Progress Indicator, see \fIenum nvme_nd_ns_fpi\fP. +.IP "dlfeat" 12 +Deallocate Logical Block Features, see \fIenum nvme_id_ns_dlfeat\fP. +.IP "nawun" 12 +Namespace Atomic Write Unit Normal indicates the +namespace specific size of the write operation guaranteed to be +written atomically to the NVM during normal operation. +.IP "nawupf" 12 +Namespace Atomic Write Unit Power Fail indicates the +namespace specific size of the write operation guaranteed to be +written atomically to the NVM during a power fail or error +condition. +.IP "nacwu" 12 +Namespace Atomic Compare & Write Unit indicates the namespace +specific size of the write operation guaranteed to be written +atomically to the NVM for a Compare and Write fused command. +.IP "nabsn" 12 +Namespace Atomic Boundary Size Normal indicates the atomic +boundary size for this namespace for the NAWUN value. This field +is specified in logical blocks. +.IP "nabo" 12 +Namespace Atomic Boundary Offset indicates the LBA on this +namespace where the first atomic boundary starts. +.IP "nabspf" 12 +Namespace Atomic Boundary Size Power Fail indicates the atomic +boundary size for this namespace specific to the Namespace Atomic +Write Unit Power Fail value. This field is specified in logical +blocks. +.IP "noiob" 12 +Namespace Optimal I/O Boundary indicates the optimal I/O boundary +for this namespace. This field is specified in logical blocks. +The host should construct Read and Write commands that do not +cross the I/O boundary to achieve optimal performance. +.IP "nvmcap" 12 +NVM Capacity indicates the total size of the NVM allocated to +this namespace. The value is in bytes. +.IP "npwg" 12 +Namespace Preferred Write Granularity indicates the smallest +recommended write granularity in logical blocks for this +namespace. This is a 0's based value. +.IP "npwa" 12 +Namespace Preferred Write Alignment indicates the recommended +write alignment in logical blocks for this namespace. This is a +0's based value. +.IP "npdg" 12 +Namespace Preferred Deallocate Granularity indicates the +recommended granularity in logical blocks for the Dataset +Management command with the Attribute - Deallocate bit. +.IP "npda" 12 +Namespace Preferred Deallocate Alignment indicates the +recommended alignment in logical blocks for the Dataset +Management command with the Attribute - Deallocate bit +.IP "nows" 12 +Namespace Optimal Write Size indicates the size in logical blocks +for optimal write performance for this namespace. This is a 0's +based value. +.IP "mssrl" 12 +Maximum Single Source Range Length indicates the maximum number +of logical blocks that may be specified in each valid Source Range +field of a Copy command. +.IP "mcl" 12 +Maximum Copy Length indicates the maximum number of logical +blocks that may be specified in a Copy command. +.IP "msrc" 12 +Maximum Source Range Count indicates the maximum number of Source +Range entries that may be used to specify source data in a Copy +command. This is a 0’s based value. +.IP "rsvd81" 12 +Reserved +.IP "nulbaf" 12 +Number of Unique Capability LBA Formats defines the number of +supported user data size and metadata size combinations supported +by the namespace that may not share the same capabilities. LBA +formats shall be allocated in order and packed sequentially. +.IP "rsvd83" 12 +Reserved +.IP "anagrpid" 12 +ANA Group Identifier indicates the ANA Group Identifier of the +ANA group of which the namespace is a member. +.IP "rsvd96" 12 +Reserved +.IP "nsattr" 12 +Namespace Attributes, see \fIenum nvme_id_ns_attr\fP. +.IP "nvmsetid" 12 +NVM Set Identifier indicates the NVM Set with which this +namespace is associated. +.IP "endgid" 12 +Endurance Group Identifier indicates the Endurance Group with +which this namespace is associated. +.IP "nguid" 12 +Namespace Globally Unique Identifier contains a 128-bit value +that is globally unique and assigned to the namespace when the +namespace is created. This field remains fixed throughout the +life of the namespace and is preserved across namespace and +controller operations +.IP "eui64" 12 +IEEE Extended Unique Identifier contains a 64-bit IEEE Extended +Unique Identifier (EUI-64) that is globally unique and assigned +to the namespace when the namespace is created. This field +remains fixed throughout the life of the namespace and is +preserved across namespace and controller operations +.IP "lbaf" 12 +LBA Format, see \fIstruct nvme_lbaf\fP. +.IP "lbstm" 12 +Logical Block Storage Tag Mask for end-to-end protection +.IP "vs" 12 +Vendor Specific diff --git a/doc/man/nvme_id_ns_attr.2 b/doc/man/nvme_id_ns_attr.2 new file mode 100644 index 0000000..05bd554 --- /dev/null +++ b/doc/man/nvme_id_ns_attr.2 @@ -0,0 +1,14 @@ +.TH "libnvme" 9 "enum nvme_id_ns_attr" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_attr \- Specifies attributes of the namespace. +.SH SYNOPSIS +enum nvme_id_ns_attr { +.br +.BI " NVME_NS_NSATTR_WRITE_PROTECTED" + +}; +.SH Constants +.IP "NVME_NS_NSATTR_WRITE_PROTECTED" 12 +If set, then the namespace is currently +write protected and all write access to the +namespace shall fail. diff --git a/doc/man/nvme_id_ns_dlfeat.2 b/doc/man/nvme_id_ns_dlfeat.2 new file mode 100644 index 0000000..2dabf24 --- /dev/null +++ b/doc/man/nvme_id_ns_dlfeat.2 @@ -0,0 +1,50 @@ +.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_dlfeat \- This field indicates information about features that affect deallocating logical blocks for this namespace. +.SH SYNOPSIS +enum nvme_id_ns_dlfeat { +.br +.BI " NVME_NS_DLFEAT_RB" +, +.br +.br +.BI " NVME_NS_DLFEAT_RB_NR" +, +.br +.br +.BI " NVME_NS_DLFEAT_RB_ALL_0S" +, +.br +.br +.BI " NVME_NS_DLFEAT_RB_ALL_FS" +, +.br +.br +.BI " NVME_NS_DLFEAT_WRITE_ZEROES" +, +.br +.br +.BI " NVME_NS_DLFEAT_CRC_GUARD" + +}; +.SH Constants +.IP "NVME_NS_DLFEAT_RB" 12 +Mask to get the value of the read behavior +.IP "NVME_NS_DLFEAT_RB_NR" 12 +Read behvaior is not reported +.IP "NVME_NS_DLFEAT_RB_ALL_0S" 12 +A deallocated logical block returns all bytes +cleared to 0h. +.IP "NVME_NS_DLFEAT_RB_ALL_FS" 12 +A deallocated logical block returns all bytes +set to FFh. +.IP "NVME_NS_DLFEAT_WRITE_ZEROES" 12 +If set, indicates that the controller supports +the Deallocate bit in the Write Zeroes command +for this namespace. +.IP "NVME_NS_DLFEAT_CRC_GUARD" 12 +If set, indicates that the Guard field for +deallocated logical blocks that contain +protection information is set to the CRC for +the value read from the deallocated logical +block and its metadata diff --git a/doc/man/nvme_id_ns_dpc.2 b/doc/man/nvme_id_ns_dpc.2 new file mode 100644 index 0000000..2ccfca9 --- /dev/null +++ b/doc/man/nvme_id_ns_dpc.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "enum nvme_id_ns_dpc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_dpc \- This field indicates the capabilities for the end-to-end data protection feature. +.SH SYNOPSIS +enum nvme_id_ns_dpc { +.br +.BI " NVME_NS_DPC_PI_TYPE1" +, +.br +.br +.BI " NVME_NS_DPC_PI_TYPE2" +, +.br +.br +.BI " NVME_NS_DPC_PI_TYPE3" +, +.br +.br +.BI " NVME_NS_DPC_PI_FIRST" +, +.br +.br +.BI " NVME_NS_DPC_PI_LAST" + +}; +.SH Constants +.IP "NVME_NS_DPC_PI_TYPE1" 12 +If set, indicates that the namespace supports +Protection Information Type 1. +.IP "NVME_NS_DPC_PI_TYPE2" 12 +If set, indicates that the namespace supports +Protection Information Type 2. +.IP "NVME_NS_DPC_PI_TYPE3" 12 +If set, indicates that the namespace supports +Protection Information Type 3. +.IP "NVME_NS_DPC_PI_FIRST" 12 +If set, indicates that the namespace supports +protection information transferred as the first eight +bytes of metadata. +.IP "NVME_NS_DPC_PI_LAST" 12 +If set, indicates that the namespace supports +protection information transferred as the last eight +bytes of metadata. diff --git a/doc/man/nvme_id_ns_dps.2 b/doc/man/nvme_id_ns_dps.2 new file mode 100644 index 0000000..f171054 --- /dev/null +++ b/doc/man/nvme_id_ns_dps.2 @@ -0,0 +1,44 @@ +.TH "libnvme" 9 "enum nvme_id_ns_dps" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_dps \- This field indicates the Type settings for the end-to-end data protection feature. +.SH SYNOPSIS +enum nvme_id_ns_dps { +.br +.BI " NVME_NS_DPS_PI_NONE" +, +.br +.br +.BI " NVME_NS_DPS_PI_TYPE1" +, +.br +.br +.BI " NVME_NS_DPS_PI_TYPE2" +, +.br +.br +.BI " NVME_NS_DPS_PI_TYPE3" +, +.br +.br +.BI " NVME_NS_DPS_PI_MASK" +, +.br +.br +.BI " NVME_NS_DPS_PI_FIRST" + +}; +.SH Constants +.IP "NVME_NS_DPS_PI_NONE" 12 +Protection information is not enabled +.IP "NVME_NS_DPS_PI_TYPE1" 12 +Protection information is enabled, Type 1 +.IP "NVME_NS_DPS_PI_TYPE2" 12 +Protection information is enabled, Type 2 +.IP "NVME_NS_DPS_PI_TYPE3" 12 +Protection information is enabled, Type 3 +.IP "NVME_NS_DPS_PI_MASK" 12 +Mask to get the value of the PI type +.IP "NVME_NS_DPS_PI_FIRST" 12 +If set, indicates that the protection information, if +enabled, is transferred as the first eight bytes of +metadata. diff --git a/doc/man/nvme_id_ns_flbas.2 b/doc/man/nvme_id_ns_flbas.2 new file mode 100644 index 0000000..e2b54af --- /dev/null +++ b/doc/man/nvme_id_ns_flbas.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "enum nvme_id_ns_flbas" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_flbas \- This field indicates the LBA data size & metadata size combination that the namespace has been formatted with +.SH SYNOPSIS +enum nvme_id_ns_flbas { +.br +.BI " NVME_NS_FLBAS_LOWER_MASK" +, +.br +.br +.BI " NVME_NS_FLBAS_META_EXT" +, +.br +.br +.BI " NVME_NS_FLBAS_HIGHER_MASK" + +}; +.SH Constants +.IP "NVME_NS_FLBAS_LOWER_MASK" 12 +Mask to get the index of one of the supported +LBA Formats's least significant +4bits indicated in +:c:type:`struct nvme_id_ns <nvme_id_ns>`.lbaf. +.IP "NVME_NS_FLBAS_META_EXT" 12 +Applicable only if format contains metadata. If +this bit is set, indicates that the metadata is +transferred at the end of the data LBA, creating an +extended data LBA. If cleared, indicates that all +of the metadata for a command is transferred as a +separate contiguous buffer of data. +.IP "NVME_NS_FLBAS_HIGHER_MASK" 12 +Mask to get the index of one of +the supported LBA Formats's most significant +2bits indicated in +:c:type:`struct nvme_id_ns <nvme_id_ns>`.lbaf. diff --git a/doc/man/nvme_id_ns_granularity_desc.2 b/doc/man/nvme_id_ns_granularity_desc.2 new file mode 100644 index 0000000..8c7c259 --- /dev/null +++ b/doc/man/nvme_id_ns_granularity_desc.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_ns_granularity_desc \- +.SH SYNOPSIS +struct nvme_id_ns_granularity_desc { +.br +.BI " __le64 nszegran;" +.br +.BI " __le64 ncapgran;" +.br +.BI " +}; +.br + +.SH Members +.IP "nszegran" 12 +Namespace Size Granularity +.IP "ncapgran" 12 +Namespace Capacity Granularity diff --git a/doc/man/nvme_id_ns_granularity_list.2 b/doc/man/nvme_id_ns_granularity_list.2 new file mode 100644 index 0000000..375974e --- /dev/null +++ b/doc/man/nvme_id_ns_granularity_list.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_ns_granularity_list \- +.SH SYNOPSIS +struct nvme_id_ns_granularity_list { +.br +.BI " __le32 attributes;" +.br +.BI " __u8 num_descriptors;" +.br +.BI " __u8 rsvd5[27];" +.br +.BI " struct nvme_id_ns_granularity_desc entry[NVME_ID_ND_DESCRIPTOR_MAX];" +.br +.BI " __u8 rsvd288[3808];" +.br +.BI " +}; +.br + +.SH Members +.IP "attributes" 12 +Namespace Granularity Attributes +.IP "num_descriptors" 12 +Number of Descriptors +.IP "rsvd5" 12 +reserved +.IP "entry" 12 +Namespace Granularity Descriptor +.IP "rsvd288" 12 +reserved diff --git a/doc/man/nvme_id_ns_mc.2 b/doc/man/nvme_id_ns_mc.2 new file mode 100644 index 0000000..774742f --- /dev/null +++ b/doc/man/nvme_id_ns_mc.2 @@ -0,0 +1,21 @@ +.TH "libnvme" 9 "enum nvme_id_ns_mc" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_mc \- This field indicates the capabilities for metadata. +.SH SYNOPSIS +enum nvme_id_ns_mc { +.br +.BI " NVME_NS_MC_EXTENDED" +, +.br +.br +.BI " NVME_NS_MC_SEPARATE" + +}; +.SH Constants +.IP "NVME_NS_MC_EXTENDED" 12 +If set, indicates the namespace supports the metadata +being transferred as part of a separate buffer that is +specified in the Metadata Pointer. +.IP "NVME_NS_MC_SEPARATE" 12 +If set, indicates that the namespace supports the +metadata being transferred as part of an extended data LBA. diff --git a/doc/man/nvme_id_ns_nmic.2 b/doc/man/nvme_id_ns_nmic.2 new file mode 100644 index 0000000..9f15b41 --- /dev/null +++ b/doc/man/nvme_id_ns_nmic.2 @@ -0,0 +1,13 @@ +.TH "libnvme" 9 "enum nvme_id_ns_nmic" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_nmic \- This field specifies multi-path I/O and namespace sharing capabilities of the namespace. +.SH SYNOPSIS +enum nvme_id_ns_nmic { +.br +.BI " NVME_NS_NMIC_SHARED" + +}; +.SH Constants +.IP "NVME_NS_NMIC_SHARED" 12 +If set, then the namespace may be attached to two or +more controllers in the NVM subsystem concurrently diff --git a/doc/man/nvme_id_ns_rescap.2 b/doc/man/nvme_id_ns_rescap.2 new file mode 100644 index 0000000..63fc83e --- /dev/null +++ b/doc/man/nvme_id_ns_rescap.2 @@ -0,0 +1,62 @@ +.TH "libnvme" 9 "enum nvme_id_ns_rescap" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_ns_rescap \- This field indicates the reservation capabilities of the namespace. +.SH SYNOPSIS +enum nvme_id_ns_rescap { +.br +.BI " NVME_NS_RESCAP_PTPL" +, +.br +.br +.BI " NVME_NS_RESCAP_WE" +, +.br +.br +.BI " NVME_NS_RESCAP_EA" +, +.br +.br +.BI " NVME_NS_RESCAP_WERO" +, +.br +.br +.BI " NVME_NS_RESCAP_EARO" +, +.br +.br +.BI " NVME_NS_RESCAP_WEAR" +, +.br +.br +.BI " NVME_NS_RESCAP_EAAR" +, +.br +.br +.BI " NVME_NS_RESCAP_IEK_13" + +}; +.SH Constants +.IP "NVME_NS_RESCAP_PTPL" 12 +If set, indicates that the namespace supports the +Persist Through Power Loss capability. +.IP "NVME_NS_RESCAP_WE" 12 +If set, indicates that the namespace supports the +Write Exclusive reservation type. +.IP "NVME_NS_RESCAP_EA" 12 +If set, indicates that the namespace supports the +Exclusive Access reservation type. +.IP "NVME_NS_RESCAP_WERO" 12 +If set, indicates that the namespace supports the +Write Exclusive - Registrants Only reservation type. +.IP "NVME_NS_RESCAP_EARO" 12 +If set, indicates that the namespace supports the +Exclusive Access - Registrants Only reservation type. +.IP "NVME_NS_RESCAP_WEAR" 12 +If set, indicates that the namespace supports the +Write Exclusive - All Registrants reservation type. +.IP "NVME_NS_RESCAP_EAAR" 12 +If set, indicates that the namespace supports the +Exclusive Access - All Registrants reservation type. +.IP "NVME_NS_RESCAP_IEK_13" 12 +If set, indicates that Ignore Existing Key is used +as defined in revision 1.3 or later of this specification. diff --git a/doc/man/nvme_id_nsfeat.2 b/doc/man/nvme_id_nsfeat.2 new file mode 100644 index 0000000..3c5c9ec --- /dev/null +++ b/doc/man/nvme_id_nsfeat.2 @@ -0,0 +1,50 @@ +.TH "libnvme" 9 "enum nvme_id_nsfeat" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_nsfeat \- This field defines features of the namespace. +.SH SYNOPSIS +enum nvme_id_nsfeat { +.br +.BI " NVME_NS_FEAT_THIN" +, +.br +.br +.BI " NVME_NS_FEAT_NATOMIC" +, +.br +.br +.BI " NVME_NS_FEAT_DULBE" +, +.br +.br +.BI " NVME_NS_FEAT_ID_REUSE" +, +.br +.br +.BI " NVME_NS_FEAT_IO_OPT" + +}; +.SH Constants +.IP "NVME_NS_FEAT_THIN" 12 +If set, indicates that the namespace supports thin +provisioning. Specifically, the Namespace Capacity +reported may be less than the Namespace Size. +.IP "NVME_NS_FEAT_NATOMIC" 12 +If set, indicates that the fields NAWUN, NAWUPF, and +NACWU are defined for this namespace and should be +used by the host for this namespace instead of the +AWUN, AWUPF, and ACWU fields in the Identify +Controller data structure. +.IP "NVME_NS_FEAT_DULBE" 12 +If set, indicates that the controller supports the +Deallocated or Unwritten Logical Block error for +this namespace. +.IP "NVME_NS_FEAT_ID_REUSE" 12 +If set, indicates that the value in the NGUID field +for this namespace, if non- zero, is never reused by +the controller and that the value in the EUI64 field +for this namespace, if non-zero, is never reused by +the controller. +.IP "NVME_NS_FEAT_IO_OPT" 12 +If set, indicates that the fields NPWG, NPWA, NPDG, +NPDA, and NOWS are defined for this namespace and +should be used by the host for I/O optimization diff --git a/doc/man/nvme_id_nvmset_list.2 b/doc/man/nvme_id_nvmset_list.2 new file mode 100644 index 0000000..6907ea7 --- /dev/null +++ b/doc/man/nvme_id_nvmset_list.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_id_nvmset_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_nvmset_list \- +.SH SYNOPSIS +struct nvme_id_nvmset_list { +.br +.BI " __u8 nid;" +.br +.BI " __u8 rsvd1[127];" +.br +.BI " struct nvme_nvmset_attr ent[NVME_ID_NVMSET_LIST_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "nid" 12 +Nvmset id +.IP "rsvd1" 12 +Reserved +.IP "ent" 12 +nvmset id list diff --git a/doc/man/nvme_id_psd.2 b/doc/man/nvme_id_psd.2 new file mode 100644 index 0000000..435d380 --- /dev/null +++ b/doc/man/nvme_id_psd.2 @@ -0,0 +1,95 @@ +.TH "libnvme" 9 "struct nvme_id_psd" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_psd \- +.SH SYNOPSIS +struct nvme_id_psd { +.br +.BI " __le16 mp;" +.br +.BI " __u8 rsvd2;" +.br +.BI " __u8 flags;" +.br +.BI " __le32 enlat;" +.br +.BI " __le32 exlat;" +.br +.BI " __u8 rrt;" +.br +.BI " __u8 rrl;" +.br +.BI " __u8 rwt;" +.br +.BI " __u8 rwl;" +.br +.BI " __le16 idlp;" +.br +.BI " __u8 ips;" +.br +.BI " __u8 rsvd19;" +.br +.BI " __le16 actp;" +.br +.BI " __u8 apws;" +.br +.BI " __u8 rsvd23[9];" +.br +.BI " +}; +.br + +.SH Members +.IP "mp" 12 +Maximum Power indicates the sustained maximum power consumed by the +NVM subsystem in this power state. The power in Watts is equal to +the value in this field multiplied by the scale specified in the Max +Power Scale bit (see \fIenum nvme_psd_flags\fP). A value of 0 indicates +Maximum Power is not reported. +.IP "rsvd2" 12 +Reserved +.IP "flags" 12 +Additional decoding flags, see \fIenum nvme_psd_flags\fP. +.IP "enlat" 12 +Entry Latency indicates the maximum latency in microseconds +associated with entering this power state. A value of 0 indicates +Entry Latency is not reported. +.IP "exlat" 12 +Exit Latency indicates the maximum latency in microseconds +associated with exiting this power state. A value of 0 indicates +Exit Latency is not reported. +.IP "rrt" 12 +Relative Read Throughput indicates the read throughput rank +associated with this power state relative to others. The value in +this is less than the number of supported power states. +.IP "rrl" 12 +Relative Reade Latency indicates the read latency rank associated +with this power state relative to others. The value in this field is +less than the number of supported power states. +.IP "rwt" 12 +Relative Write Throughput indicates write throughput rank associated +with this power state relative to others. The value in this field is +less than the number of supported power states +.IP "rwl" 12 +Relative Write Latency indicates the write latency rank associated +with this power state relative to others. The value in this field is +less than the number of supported power states +.IP "idlp" 12 +Idle Power indicates the typical power consumed by the NVM +subsystem over 30 seconds in this power state when idle. +.IP "ips" 12 +Idle Power Scale indicates the scale for \fIstruct nvme_id_psd\fP.idlp, +see \fIenum nvme_psd_ps\fP for decoding this field. +.IP "rsvd19" 12 +Reserved +.IP "actp" 12 +Active Power indicates the largest average power consumed by the +NVM subsystem over a 10 second period in this power state with +the workload indicated in the Active Power Workload field. +.IP "apws" 12 +Bits 7-6: Active Power Scale(APS) indicates the scale for the \fIstruct +nvme_id_psd\fP.actp, see \fIenum nvme_psd_ps\fP for decoding this value. +Bits 2-0: Active Power Workload(APW) indicates the workload +used to calculate maximum power for this power state. +See \fIenum nvme_psd_workload\fP for decoding this field. +.IP "rsvd23" 12 +Reserved diff --git a/doc/man/nvme_id_uuid.2 b/doc/man/nvme_id_uuid.2 new file mode 100644 index 0000000..01326e7 --- /dev/null +++ b/doc/man/nvme_id_uuid.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_id_uuid" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_id_uuid \- +.SH SYNOPSIS +enum nvme_id_uuid { +.br +.BI " NVME_ID_UUID_HDR_ASSOCIATION_MASK" +, +.br +.br +.BI " NVME_ID_UUID_ASSOCIATION_NONE" +, +.br +.br +.BI " NVME_ID_UUID_ASSOCIATION_VENDOR" +, +.br +.br +.BI " NVME_ID_UUID_ASSOCIATION_SUBSYSTEM_VENDOR" + +}; +.SH Constants +.IP "NVME_ID_UUID_HDR_ASSOCIATION_MASK" 12 +.IP "NVME_ID_UUID_ASSOCIATION_NONE" 12 +.IP "NVME_ID_UUID_ASSOCIATION_VENDOR" 12 +.IP "NVME_ID_UUID_ASSOCIATION_SUBSYSTEM_VENDOR" 12 diff --git a/doc/man/nvme_id_uuid_list.2 b/doc/man/nvme_id_uuid_list.2 new file mode 100644 index 0000000..8aca721 --- /dev/null +++ b/doc/man/nvme_id_uuid_list.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_id_uuid_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_uuid_list \- +.SH SYNOPSIS +struct nvme_id_uuid_list { +.br +.BI " __u8 rsvd0[32];" +.br +.BI " struct nvme_id_uuid_list_entry entry[NVME_ID_UUID_LIST_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "rsvd0" 12 +reserved +.IP "entry" 12 +UUID list entry diff --git a/doc/man/nvme_id_uuid_list_entry.2 b/doc/man/nvme_id_uuid_list_entry.2 new file mode 100644 index 0000000..ca2d528 --- /dev/null +++ b/doc/man/nvme_id_uuid_list_entry.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_id_uuid_list_entry \- +.SH SYNOPSIS +struct nvme_id_uuid_list_entry { +.br +.BI " __u8 header;" +.br +.BI " __u8 rsvd1[15];" +.br +.BI " __u8 uuid[16];" +.br +.BI " +}; +.br + +.SH Members +.IP "header" 12 +UUID Lists Entry Header +.IP "rsvd1" 12 +reserved +.IP "uuid" 12 +128-bit Universally Unique Identifier diff --git a/doc/man/nvme_identify.2 b/doc/man/nvme_identify.2 new file mode 100644 index 0000000..527185e --- /dev/null +++ b/doc/man/nvme_identify.2 @@ -0,0 +1,15 @@ +.TH "nvme_identify" 9 "nvme_identify" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify \- Send the NVMe Identify command +.SH SYNOPSIS +.B "int" nvme_identify +.BI "(struct nvme_identify_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_identify_args\fP argument structure +.SH "DESCRIPTION" +The Identify command returns a data buffer that describes information about +the NVM subsystem, the controller or the namespace(s). +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_active_ns_list.2 b/doc/man/nvme_identify_active_ns_list.2 new file mode 100644 index 0000000..73eba7c --- /dev/null +++ b/doc/man/nvme_identify_active_ns_list.2 @@ -0,0 +1,24 @@ +.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_active_ns_list \- Retrieves active namespaces id list +.SH SYNOPSIS +.B "int" nvme_identify_active_ns_list +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_ns_list *list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Return namespaces greater than this identifer +.IP "list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +A list of 1024 namespace IDs is returned to the host containing NSIDs in +increasing order that are greater than the value specified in the Namespace +Identifier (nsid) field of the command. + +See \fIstruct nvme_ns_list\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_active_ns_list_csi.2 b/doc/man/nvme_identify_active_ns_list_csi.2 new file mode 100644 index 0000000..01c49a9 --- /dev/null +++ b/doc/man/nvme_identify_active_ns_list_csi.2 @@ -0,0 +1,28 @@ +.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_active_ns_list_csi \- Active namespace ID list associated with a specified I/O command set +.SH SYNOPSIS +.B "int" nvme_identify_active_ns_list_csi +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "enum nvme_csi csi " "," +.BI "struct nvme_ns_list *ns_list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Return namespaces greater than this identifier +.IP "csi" 12 +Command Set Identifier +.IP "ns_list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +A list of 1024 namespace IDs is returned to the host containing active +NSIDs in increasing order that are greater than the value specified in +the Namespace Identifier (nsid) field of the command and matching the +I/O Command Set specified in the \fIcsi\fP argument. + +See \fIstruct nvme_ns_list\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_allocated_ns.2 b/doc/man/nvme_identify_allocated_ns.2 new file mode 100644 index 0000000..3927da4 --- /dev/null +++ b/doc/man/nvme_identify_allocated_ns.2 @@ -0,0 +1,18 @@ +.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_allocated_ns \- Same as nvme_identify_ns, but only for allocated namespaces +.SH SYNOPSIS +.B "int" nvme_identify_allocated_ns +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_id_ns *ns " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace to identify +.IP "ns" 12 +User space destination address to transfer the data +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_allocated_ns_list.2 b/doc/man/nvme_identify_allocated_ns_list.2 new file mode 100644 index 0000000..5aaf6fc --- /dev/null +++ b/doc/man/nvme_identify_allocated_ns_list.2 @@ -0,0 +1,24 @@ +.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_allocated_ns_list \- Retrieves allocated namespace id list +.SH SYNOPSIS +.B "int" nvme_identify_allocated_ns_list +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_ns_list *list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Return namespaces greater than this identifer +.IP "list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +A list of 1024 namespace IDs is returned to the host containing NSIDs in +increasing order that are greater than the value specified in the Namespace +Identifier (nsid) field of the command. + +See \fIstruct nvme_ns_list\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_allocated_ns_list_csi.2 b/doc/man/nvme_identify_allocated_ns_list_csi.2 new file mode 100644 index 0000000..447be6c --- /dev/null +++ b/doc/man/nvme_identify_allocated_ns_list_csi.2 @@ -0,0 +1,28 @@ +.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_allocated_ns_list_csi \- Allocated namespace ID list associated with a specified I/O command set +.SH SYNOPSIS +.B "int" nvme_identify_allocated_ns_list_csi +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "enum nvme_csi csi " "," +.BI "struct nvme_ns_list *ns_list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Return namespaces greater than this identifier +.IP "csi" 12 +Command Set Identifier +.IP "ns_list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +A list of 1024 namespace IDs is returned to the host containing allocated +NSIDs in increasing order that are greater than the value specified in +the \fInsid\fP field of the command and matching the I/O Command Set +specified in the \fIcsi\fP argument. + +See \fIstruct nvme_ns_list\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_args.2 b/doc/man/nvme_identify_args.2 new file mode 100644 index 0000000..58b9667 --- /dev/null +++ b/doc/man/nvme_identify_args.2 @@ -0,0 +1,55 @@ +.TH "libnvme" 9 "struct nvme_identify_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_identify_args \- Arguments for the NVMe Identify command +.SH SYNOPSIS +struct nvme_identify_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " enum nvme_identify_cns cns;" +.br +.BI " enum nvme_csi csi;" +.br +.BI " __u32 nsid;" +.br +.BI " __u16 cntid;" +.br +.BI " __u16 cns_specific_id;" +.br +.BI " __u8 uuidx;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +User space destination address to transfer the data +.IP "args_size" 12 +Size of \fIstruct nvme_identify_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms (0 for default timeout) +.IP "cns" 12 +The Controller or Namespace structure, see \fIenum\fP nvme_identify_cns +.IP "csi" 12 +Command Set Identifier +.IP "nsid" 12 +Namespace identifier, if applicable +.IP "cntid" 12 +The Controller Identifier, if applicable +.IP "cns_specific_id" 12 +Identifier that is required for a particular CNS value +.IP "uuidx" 12 +UUID Index if controller supports this id selection method diff --git a/doc/man/nvme_identify_cns.2 b/doc/man/nvme_identify_cns.2 new file mode 100644 index 0000000..1b5b4f2 --- /dev/null +++ b/doc/man/nvme_identify_cns.2 @@ -0,0 +1,162 @@ +.TH "libnvme" 9 "enum nvme_identify_cns" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_identify_cns \- +.SH SYNOPSIS +enum nvme_identify_cns { +.br +.BI " NVME_IDENTIFY_CNS_NS" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CTRL" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_NS_ACTIVE_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_NS_DESC_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_NVMSET_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_NS" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_CTRL" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_NS_ACTIVE_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NS" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_NS_USER_DATA_FORMAT" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_NS_USER_DATA_FORMAT" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_ALLOCATED_NS_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_ALLOCATED_NS" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_NS_CTRL_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CTRL_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_PRIMARY_CTRL_CAP" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_SECONDARY_CTRL_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_NS_GRANULARITY" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_UUID_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_DOMAIN_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_ENDURANCE_GROUP_ID" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_CSI_ID_NS_DATA_STRUCTURE" +, +.br +.br +.BI " NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTURE" + +}; +.SH Constants +.IP "NVME_IDENTIFY_CNS_NS" 12 +Identify Namespace data structure +.IP "NVME_IDENTIFY_CNS_CTRL" 12 +Identify Controller data structur +.IP "NVME_IDENTIFY_CNS_NS_ACTIVE_LIST" 12 +Active Namespace ID list +.IP "NVME_IDENTIFY_CNS_NS_DESC_LIST" 12 +Namespace Identification Descriptor list +.IP "NVME_IDENTIFY_CNS_NVMSET_LIST" 12 +NVM Set List +.IP "NVME_IDENTIFY_CNS_CSI_NS" 12 +I/O Command Set specific Identify +Namespace data structure +.IP "NVME_IDENTIFY_CNS_CSI_CTRL" 12 +I/O Command Set specific Identify +Controller data structure +.IP "NVME_IDENTIFY_CNS_CSI_NS_ACTIVE_LIST" 12 +Active Namespace ID list associated +with the specified I/O Command Set +.IP "NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NS" 12 +I/O Command Set Independent Identify +Namespace data structure +.IP "NVME_IDENTIFY_CNS_NS_USER_DATA_FORMAT" 12 +-- undescribed -- +.IP "NVME_IDENTIFY_CNS_CSI_NS_USER_DATA_FORMAT" 12 +-- undescribed -- +.IP "NVME_IDENTIFY_CNS_ALLOCATED_NS_LIST" 12 +Allocated Namespace ID list +.IP "NVME_IDENTIFY_CNS_ALLOCATED_NS" 12 +Identify Namespace data structure for +the specified allocated NSID +.IP "NVME_IDENTIFY_CNS_NS_CTRL_LIST" 12 +Controller List of controllers attached +to the specified NSID +.IP "NVME_IDENTIFY_CNS_CTRL_LIST" 12 +Controller List of controllers that exist +in the NVM subsystem +.IP "NVME_IDENTIFY_CNS_PRIMARY_CTRL_CAP" 12 +Primary Controller Capabilities data +structure for the specified primary controller +.IP "NVME_IDENTIFY_CNS_SECONDARY_CTRL_LIST" 12 +Secondary Controller list of controllers +associated with the primary controller +processing the command +.IP "NVME_IDENTIFY_CNS_NS_GRANULARITY" 12 +A Namespace Granularity Lis +.IP "NVME_IDENTIFY_CNS_UUID_LIST" 12 +A UUID List +.IP "NVME_IDENTIFY_CNS_DOMAIN_LIST" 12 +Domain List +.IP "NVME_IDENTIFY_CNS_ENDURANCE_GROUP_ID" 12 +Endurance Group List +.IP "NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST" 12 +I/O Command Set specific Allocated Namespace +ID list +.IP "NVME_IDENTIFY_CNS_CSI_ID_NS_DATA_STRUCTURE" 12 +I/O Command Set specific ID Namespace +Data Structure for Allocated Namespace ID +.IP "NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTURE" 12 +Base Specification 2.0a section 5.17.2.21 diff --git a/doc/man/nvme_identify_ctrl.2 b/doc/man/nvme_identify_ctrl.2 new file mode 100644 index 0000000..dce2bf1 --- /dev/null +++ b/doc/man/nvme_identify_ctrl.2 @@ -0,0 +1,19 @@ +.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ctrl \- Retrieves nvme identify controller +.SH SYNOPSIS +.B "int" nvme_identify_ctrl +.BI "(int fd " "," +.BI "struct nvme_id_ctrl *id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "id" 12 +User space destination address to transfer the data, +.SH "DESCRIPTION" +Sends nvme identify with CNS value NVME_IDENTIFY_CNS_CTRL. + +See \fIstruct nvme_id_ctrl\fP for details on the data returned. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ctrl_csi.2 b/doc/man/nvme_identify_ctrl_csi.2 new file mode 100644 index 0000000..60572eb --- /dev/null +++ b/doc/man/nvme_identify_ctrl_csi.2 @@ -0,0 +1,22 @@ +.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ctrl_csi \- I/O command set specific Identify Controller data +.SH SYNOPSIS +.B "int" nvme_identify_ctrl_csi +.BI "(int fd " "," +.BI "enum nvme_csi csi " "," +.BI "void *data " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "csi" 12 +Command Set Identifier +.IP "data" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +An I/O Command Set specific Identify Controller data structure is returned +to the host for the controller processing the command. The specific Identify +Controller data structure to be returned is specified by \fIcsi\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ctrl_list.2 b/doc/man/nvme_identify_ctrl_list.2 new file mode 100644 index 0000000..dc2296f --- /dev/null +++ b/doc/man/nvme_identify_ctrl_list.2 @@ -0,0 +1,24 @@ +.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ctrl_list \- Retrieves identify controller list +.SH SYNOPSIS +.B "int" nvme_identify_ctrl_list +.BI "(int fd " "," +.BI "__u16 cntid " "," +.BI "struct nvme_ctrl_list *cntlist " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "cntid" 12 +Starting CNTLID to return in the list +.IP "cntlist" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +Up to 2047 controller identifiers is returned containing a controller +identifier greater than or equal to the controller identifier specified in +\fIcntid\fP. + +See \fIstruct nvme_ctrl_list\fP for a definition of the structure returned. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_domain_list.2 b/doc/man/nvme_identify_domain_list.2 new file mode 100644 index 0000000..58a76d8 --- /dev/null +++ b/doc/man/nvme_identify_domain_list.2 @@ -0,0 +1,25 @@ +.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_domain_list \- Domain list data +.SH SYNOPSIS +.B "int" nvme_identify_domain_list +.BI "(int fd " "," +.BI "__u16 domid " "," +.BI "struct nvme_id_domain_list *list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "domid" 12 +Domain ID +.IP "list" 12 +User space destiantion address to transfer data +.SH "DESCRIPTION" +A list of 31 domain IDs is returned to the host containing domain +attributes in increasing order that are greater than the value +specified in the \fIdomid\fP field. + +See \fIstruct nvme_identify_domain_attr\fP for the definition of the +returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_endurance_group_list.2 b/doc/man/nvme_identify_endurance_group_list.2 new file mode 100644 index 0000000..5050a9e --- /dev/null +++ b/doc/man/nvme_identify_endurance_group_list.2 @@ -0,0 +1,18 @@ +.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_endurance_group_list \- Endurance group list data +.SH SYNOPSIS +.B "int" nvme_identify_endurance_group_list +.BI "(int fd " "," +.BI "__u16 endgrp_id " "," +.BI "struct nvme_id_endurance_group_list *list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "endgrp_id" 12 +Endurance group identifier +.IP "list" 12 +Array of endurance group identifiers +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_independent_identify_ns.2 b/doc/man/nvme_identify_independent_identify_ns.2 new file mode 100644 index 0000000..9dc83a0 --- /dev/null +++ b/doc/man/nvme_identify_independent_identify_ns.2 @@ -0,0 +1,22 @@ +.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_independent_identify_ns \- I/O command set independent Identify namespace data +.SH SYNOPSIS +.B "int" nvme_identify_independent_identify_ns +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_id_independent_id_ns *ns " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Return namespaces greater than this identifier +.IP "ns" 12 +I/O Command Set Independent Identify Namespace data +structure +.SH "DESCRIPTION" +The I/O command set independent Identify namespace data structure for +the namespace identified with \fIns\fP is returned to the host. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_iocs.2 b/doc/man/nvme_identify_iocs.2 new file mode 100644 index 0000000..5255ae4 --- /dev/null +++ b/doc/man/nvme_identify_iocs.2 @@ -0,0 +1,21 @@ +.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_iocs \- I/O command set data structure +.SH SYNOPSIS +.B "int" nvme_identify_iocs +.BI "(int fd " "," +.BI "__u16 cntlid " "," +.BI "struct nvme_id_iocs *iocs " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "cntlid" 12 +Controller ID +.IP "iocs" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +Retrieves list of the controller's supported io command set vectors. See +\fIstruct nvme_id_iocs\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 b/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 new file mode 100644 index 0000000..86e1c21 --- /dev/null +++ b/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 @@ -0,0 +1,28 @@ +.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_iocs_ns_csi_user_data_format \- +.SH SYNOPSIS +.B "int" nvme_identify_iocs_ns_csi_user_data_format +.BI "(int fd " "," +.BI "__u16 user_data_format " "," +.BI "__u8 uuidx " "," +.BI "enum nvme_csi csi " "," +.BI "void *data " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "user_data_format" 12 +Return namespaces capability of identifier +.IP "uuidx" 12 +UUID selection, if supported +.IP "csi" 12 +Command Set Identifier +.IP "data" 12 +-- undescribed -- +.SH "DESCRIPTION" +I/O Command Set specific Identify Namespace data structure for +the specified User Data Format index containing the namespace +capabilities for the I/O Command Set specified in the CSI field. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ns.2 b/doc/man/nvme_identify_ns.2 new file mode 100644 index 0000000..428c9cb --- /dev/null +++ b/doc/man/nvme_identify_ns.2 @@ -0,0 +1,29 @@ +.TH "nvme_identify_ns" 9 "nvme_identify_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ns \- Retrieves nvme identify namespace +.SH SYNOPSIS +.B "int" nvme_identify_ns +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_id_ns *ns " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace to identify +.IP "ns" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +If the Namespace Identifier (NSID) field specifies an active NSID, then the +Identify Namespace data structure is returned to the host for that specified +namespace. + +If the controller supports the Namespace Management capability and the NSID +field is set to NVME_NSID_ALL, then the controller returns an Identify Namespace +data structure that specifies capabilities that are common across namespaces +for this controller. + +See \fIstruct nvme_id_ns\fP for details on the structure returned. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ns_csi.2 b/doc/man/nvme_identify_ns_csi.2 new file mode 100644 index 0000000..f8ccf78 --- /dev/null +++ b/doc/man/nvme_identify_ns_csi.2 @@ -0,0 +1,27 @@ +.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ns_csi \- I/O command set specific identify namespace data +.SH SYNOPSIS +.B "int" nvme_identify_ns_csi +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u8 uuidx " "," +.BI "enum nvme_csi csi " "," +.BI "void *data " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace to identify +.IP "uuidx" 12 +UUID Index for differentiating vendor specific encoding +.IP "csi" 12 +Command Set Identifier +.IP "data" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +An I/O Command Set specific Identify Namespace data structre is returned +for the namespace specified in \fInsid\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ns_csi_user_data_format.2 b/doc/man/nvme_identify_ns_csi_user_data_format.2 new file mode 100644 index 0000000..96fa09c --- /dev/null +++ b/doc/man/nvme_identify_ns_csi_user_data_format.2 @@ -0,0 +1,27 @@ +.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ns_csi_user_data_format \- +.SH SYNOPSIS +.B "int" nvme_identify_ns_csi_user_data_format +.BI "(int fd " "," +.BI "__u16 user_data_format " "," +.BI "__u8 uuidx " "," +.BI "enum nvme_csi csi " "," +.BI "void *data " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "user_data_format" 12 +Return namespaces capability of identifier +.IP "uuidx" 12 +UUID selection, if supported +.IP "csi" 12 +Command Set Identifier +.IP "data" 12 +-- undescribed -- +.SH "DESCRIPTION" +Identify Namespace data structure for the specified User Data Format +index containing the namespace capabilities for the NVM Command Set. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ns_descs.2 b/doc/man/nvme_identify_ns_descs.2 new file mode 100644 index 0000000..def86ee --- /dev/null +++ b/doc/man/nvme_identify_ns_descs.2 @@ -0,0 +1,26 @@ +.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ns_descs \- Retrieves namespace descriptor list +.SH SYNOPSIS +.B "int" nvme_identify_ns_descs +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_ns_id_desc *descs " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +The namespace id to retrieve destriptors +.IP "descs" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +A list of Namespace Identification Descriptor structures is returned to the +host for the namespace specified in the Namespace Identifier (NSID) field if +it is an active NSID. + +The data returned is in the form of an arrray of 'struct nvme_ns_id_desc'. + +See \fIstruct nvme_ns_id_desc\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_ns_granularity.2 b/doc/man/nvme_identify_ns_granularity.2 new file mode 100644 index 0000000..f960461 --- /dev/null +++ b/doc/man/nvme_identify_ns_granularity.2 @@ -0,0 +1,22 @@ +.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_ns_granularity \- Retrieves namespace granularity identification +.SH SYNOPSIS +.B "int" nvme_identify_ns_granularity +.BI "(int fd " "," +.BI "struct nvme_id_ns_granularity_list *gr_list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "gr_list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +If the controller supports reporting of Namespace Granularity, then a +Namespace Granularity List is returned to the host for up to sixteen +namespace granularity descriptors + +See \fIstruct nvme_id_ns_granularity_list\fP for the definition of the returned +structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_nsid_ctrl_list.2 b/doc/man/nvme_identify_nsid_ctrl_list.2 new file mode 100644 index 0000000..3842e70 --- /dev/null +++ b/doc/man/nvme_identify_nsid_ctrl_list.2 @@ -0,0 +1,27 @@ +.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_nsid_ctrl_list \- Retrieves controller list attached to an nsid +.SH SYNOPSIS +.B "int" nvme_identify_nsid_ctrl_list +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 cntid " "," +.BI "struct nvme_ctrl_list *cntlist " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Return controllers that are attached to this nsid +.IP "cntid" 12 +Starting CNTLID to return in the list +.IP "cntlist" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +Up to 2047 controller identifiers are returned containing a controller +identifier greater than or equal to the controller identifier specified in +\fIcntid\fP attached to \fInsid\fP. + +See \fIstruct nvme_ctrl_list\fP for a definition of the structure returned. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 diff --git a/doc/man/nvme_identify_nvmset_list.2 b/doc/man/nvme_identify_nvmset_list.2 new file mode 100644 index 0000000..98b368a --- /dev/null +++ b/doc/man/nvme_identify_nvmset_list.2 @@ -0,0 +1,25 @@ +.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_nvmset_list \- Retrieves NVM Set List +.SH SYNOPSIS +.B "int" nvme_identify_nvmset_list +.BI "(int fd " "," +.BI "__u16 nvmsetid " "," +.BI "struct nvme_id_nvmset_list *nvmset " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nvmsetid" 12 +NVM Set Identifier +.IP "nvmset" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +Retrieves an NVM Set List, \fIstruct nvme_id_nvmset_list\fP. The data structure +is an ordered list by NVM Set Identifier, starting with the first NVM Set +Identifier supported by the NVM subsystem that is equal to or greater than +the NVM Set Identifier. + +See \fIstruct nvme_id_nvmset_list\fP for the defintion of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_primary_ctrl.2 b/doc/man/nvme_identify_primary_ctrl.2 new file mode 100644 index 0000000..8654539 --- /dev/null +++ b/doc/man/nvme_identify_primary_ctrl.2 @@ -0,0 +1,20 @@ +.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_primary_ctrl \- Retrieve NVMe Primary Controller identification +.SH SYNOPSIS +.B "int" nvme_identify_primary_ctrl +.BI "(int fd " "," +.BI "__u16 cntid " "," +.BI "struct nvme_primary_ctrl_cap *cap " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "cntid" 12 +Return controllers starting at this identifier +.IP "cap" 12 +User space destination buffer address to transfer the data +.SH "DESCRIPTION" +See \fIstruct nvme_primary_ctrl_cap\fP for the defintion of the returned structure, \fIcap\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_secondary_ctrl_list.2 b/doc/man/nvme_identify_secondary_ctrl_list.2 new file mode 100644 index 0000000..7a81cce --- /dev/null +++ b/doc/man/nvme_identify_secondary_ctrl_list.2 @@ -0,0 +1,29 @@ +.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_secondary_ctrl_list \- Retrieves secondary controller list +.SH SYNOPSIS +.B "int" nvme_identify_secondary_ctrl_list +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 cntid " "," +.BI "struct nvme_secondary_ctrl_list *sc_list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace identifier +.IP "cntid" 12 +Return controllers starting at this identifier +.IP "sc_list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +A Secondary Controller List is returned to the host for up to 127 secondary +controllers associated with the primary controller processing this command. +The list contains entries for controller identifiers greater than or equal +to the value specified in the Controller Identifier (cntid). + +See \fIstruct nvme_secondary_ctrls_list\fP for a defintion of the returned +structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_uuid.2 b/doc/man/nvme_identify_uuid.2 new file mode 100644 index 0000000..dc19985 --- /dev/null +++ b/doc/man/nvme_identify_uuid.2 @@ -0,0 +1,20 @@ +.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_identify_uuid \- Retrieves device's UUIDs +.SH SYNOPSIS +.B "int" nvme_identify_uuid +.BI "(int fd " "," +.BI "struct nvme_id_uuid_list *uuid_list " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "uuid_list" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +Each UUID List entry is either 0h, the NVMe Invalid UUID, or a valid UUID. +Valid UUIDs are those which are non-zero and are not the NVMe Invalid UUID. + +See \fIstruct nvme_id_uuid_list\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_init_copy_range.2 b/doc/man/nvme_init_copy_range.2 new file mode 100644 index 0000000..b49dd53 --- /dev/null +++ b/doc/man/nvme_init_copy_range.2 @@ -0,0 +1,27 @@ +.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_init_copy_range \- Constructs a copy range structure +.SH SYNOPSIS +.B "void" nvme_init_copy_range +.BI "(struct nvme_copy_range *copy " "," +.BI "__u16 *nlbs " "," +.BI "__u64 *slbas " "," +.BI "__u32 *eilbrts " "," +.BI "__u32 *elbatms " "," +.BI "__u32 *elbats " "," +.BI "__u16 nr " ");" +.SH ARGUMENTS +.IP "copy" 12 +Copy range array +.IP "nlbs" 12 +Number of logical blocks +.IP "slbas" 12 +Starting LBA +.IP "eilbrts" 12 +Expected initial logical block reference tag +.IP "elbatms" 12 +Expected logical block application tag mask +.IP "elbats" 12 +Expected logical block application tag +.IP "nr" 12 +Number of descriptors to construct diff --git a/doc/man/nvme_init_ctrl.2 b/doc/man/nvme_init_ctrl.2 new file mode 100644 index 0000000..1799484 --- /dev/null +++ b/doc/man/nvme_init_ctrl.2 @@ -0,0 +1,17 @@ +.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_init_ctrl \- Initialize nvme_ctrl_t object for an existing controller. +.SH SYNOPSIS +.B "int" nvme_init_ctrl +.BI "(nvme_host_t h " "," +.BI "nvme_ctrl_t c " "," +.BI "int instance " ");" +.SH ARGUMENTS +.IP "h" 12 +nvme_host_t object +.IP "c" 12 +nvme_ctrl_t object +.IP "instance" 12 +Instance number (e.g. 1 for nvme1) +.SH "RETURN" +The \fBioctl\fP return code. Typically 0 on success. diff --git a/doc/man/nvme_init_ctrl_list.2 b/doc/man/nvme_init_ctrl_list.2 new file mode 100644 index 0000000..3173143 --- /dev/null +++ b/doc/man/nvme_init_ctrl_list.2 @@ -0,0 +1,18 @@ +.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_init_ctrl_list \- Initialize an nvme_ctrl_list structure from an array. +.SH SYNOPSIS +.B "void" nvme_init_ctrl_list +.BI "(struct nvme_ctrl_list *cntlist " "," +.BI "__u16 num_ctrls " "," +.BI "__u16 *ctrlist " ");" +.SH ARGUMENTS +.IP "cntlist" 12 +The controller list structure to initialize +.IP "num_ctrls" 12 +The number of controllers in the array, \fIctrlist\fP. +.IP "ctrlist" 12 +An array of controller identifiers in CPU native endian. +.SH "DESCRIPTION" +This is intended to be used with any command that takes a controller list +argument. See \fBnvme_ns_attach_ctrls\fP and \fBnvme_ns_detach\fP. diff --git a/doc/man/nvme_init_dsm_range.2 b/doc/man/nvme_init_dsm_range.2 new file mode 100644 index 0000000..260169d --- /dev/null +++ b/doc/man/nvme_init_dsm_range.2 @@ -0,0 +1,27 @@ +.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_init_dsm_range \- Constructs a data set range structure +.SH SYNOPSIS +.B "void" nvme_init_dsm_range +.BI "(struct nvme_dsm_range *dsm " "," +.BI "__u32 *ctx_attrs " "," +.BI "__u32 *llbas " "," +.BI "__u64 *slbas " "," +.BI "__u16 nr_ranges " ");" +.SH ARGUMENTS +.IP "dsm" 12 +DSM range array +.IP "ctx_attrs" 12 +Array of context attributes +.IP "llbas" 12 +Array of length in logical blocks +.IP "slbas" 12 +Array of starting logical blocks +.IP "nr_ranges" 12 +The size of the dsm arrays +.SH "DESCRIPTION" +Each array must be the same size of size 'nr_ranges'. This is intended to be +used with constructing a payload for \fBnvme_dsm\fP. +.SH "RETURN" +The nvme command status if a response was received or -errno +otherwise. diff --git a/doc/man/nvme_init_logging.2 b/doc/man/nvme_init_logging.2 new file mode 100644 index 0000000..d2c2829 --- /dev/null +++ b/doc/man/nvme_init_logging.2 @@ -0,0 +1,20 @@ +.TH "nvme_init_logging" 9 "nvme_init_logging" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_init_logging \- Initialize logging +.SH SYNOPSIS +.B "void" nvme_init_logging +.BI "(nvme_root_t r " "," +.BI "int lvl " "," +.BI "bool log_pid " "," +.BI "bool log_tstamp " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t context +.IP "lvl" 12 +Logging level to set +.IP "log_pid" 12 +Boolean to enable logging of the PID +.IP "log_tstamp" 12 +Boolean to enable logging of the timestamp +.SH "DESCRIPTION" +Sets the default logging variables for the library. diff --git a/doc/man/nvme_io.2 b/doc/man/nvme_io.2 new file mode 100644 index 0000000..422b922 --- /dev/null +++ b/doc/man/nvme_io.2 @@ -0,0 +1,15 @@ +.TH "nvme_io" 9 "nvme_io" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_io \- Submit an nvme user I/O command +.SH SYNOPSIS +.B "int" nvme_io +.BI "(struct nvme_io_args *args " "," +.BI "__u8 opcode " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.IP "opcode" 12 +Opcode to execute +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_io_args.2 b/doc/man/nvme_io_args.2 new file mode 100644 index 0000000..4993da8 --- /dev/null +++ b/doc/man/nvme_io_args.2 @@ -0,0 +1,91 @@ +.TH "libnvme" 9 "struct nvme_io_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_io_args \- Arguments for NVMe I/O commands +.SH SYNOPSIS +struct nvme_io_args { +.br +.BI " __u64 slba;" +.br +.BI " __u64 storage_tag;" +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " void *metadata;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 reftag;" +.br +.BI " __u32 data_len;" +.br +.BI " __u32 metadata_len;" +.br +.BI " __u16 nlb;" +.br +.BI " __u16 control;" +.br +.BI " __u16 apptag;" +.br +.BI " __u16 appmask;" +.br +.BI " __u16 dspec;" +.br +.BI " __u8 dsm;" +.br +.BI " +}; +.br + +.SH Members +.IP "slba" 12 +Starting logical block +.IP "storage_tag" 12 +This filed specifies Variable Sized Expected Logical Block +Storage Tag (ELBST) and Expected Logical Block Reference +Tag (ELBRT) +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Pointer to user address of the data buffer +.IP "metadata" 12 +Pointer to user address of the metadata buffer +.IP "args_size" 12 +Size of \fIstruct nvme_io_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID +.IP "reftag" 12 +This field specifies the Initial Logical Block Reference Tag +expected value. Used only if the namespace is formatted to use +end-to-end protection information. +.IP "data_len" 12 +Length of user buffer, \fIdata\fP, in bytes +.IP "metadata_len" 12 +Length of user buffer, \fImetadata\fP, in bytes +.IP "nlb" 12 +Number of logical blocks to send (0's based value) +.IP "control" 12 +Command control flags, see \fIenum nvme_io_control_flags\fP. +.IP "apptag" 12 +This field specifies the Application Tag Mask expected value. +Used only if the namespace is formatted to use end-to-end +protection information. +.IP "appmask" 12 +This field specifies the Application Tag expected value. Used +only if the namespace is formatted to use end-to-end protection +information. +.IP "dspec" 12 +Directive specific value +.IP "dsm" 12 +Data set management attributes, see \fIenum nvme_io_dsm_flags\fP diff --git a/doc/man/nvme_io_control_flags.2 b/doc/man/nvme_io_control_flags.2 new file mode 100644 index 0000000..43ee21f --- /dev/null +++ b/doc/man/nvme_io_control_flags.2 @@ -0,0 +1,60 @@ +.TH "libnvme" 9 "enum nvme_io_control_flags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_io_control_flags \- +.SH SYNOPSIS +enum nvme_io_control_flags { +.br +.BI " NVME_IO_DTYPE_STREAMS" +, +.br +.br +.BI " NVME_IO_DEAC" +, +.br +.br +.BI " NVME_IO_ZNS_APPEND_PIREMAP" +, +.br +.br +.BI " NVME_IO_PRINFO_PRCHK_REF" +, +.br +.br +.BI " NVME_IO_PRINFO_PRCHK_APP" +, +.br +.br +.BI " NVME_IO_PRINFO_PRCHK_GUARD" +, +.br +.br +.BI " NVME_IO_PRINFO_PRACT" +, +.br +.br +.BI " NVME_IO_FUA" +, +.br +.br +.BI " NVME_IO_LR" + +}; +.SH Constants +.IP "NVME_IO_DTYPE_STREAMS" 12 +Directive Type Streams +.IP "NVME_IO_DEAC" 12 +Deallocate +.IP "NVME_IO_ZNS_APPEND_PIREMAP" 12 +Protection Information Remap +.IP "NVME_IO_PRINFO_PRCHK_REF" 12 +Protection Information Check Reference Tag +.IP "NVME_IO_PRINFO_PRCHK_APP" 12 +Protection Information Check Application Tag +.IP "NVME_IO_PRINFO_PRCHK_GUARD" 12 +Protection Information Check Guard field +.IP "NVME_IO_PRINFO_PRACT" 12 +Protection Information Action +.IP "NVME_IO_FUA" 12 +Force Unit Access +.IP "NVME_IO_LR" 12 +Limited Retry diff --git a/doc/man/nvme_io_dsm_flags.2 b/doc/man/nvme_io_dsm_flags.2 new file mode 100644 index 0000000..5daacc3 --- /dev/null +++ b/doc/man/nvme_io_dsm_flags.2 @@ -0,0 +1,96 @@ +.TH "libnvme" 9 "enum nvme_io_dsm_flags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_io_dsm_flags \- +.SH SYNOPSIS +enum nvme_io_dsm_flags { +.br +.BI " NVME_IO_DSM_FREQ_UNSPEC" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_TYPICAL" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_RARE" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_READS" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_WRITES" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_RW" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_ONCE" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_PREFETCH" +, +.br +.br +.BI " NVME_IO_DSM_FREQ_TEMP" +, +.br +.br +.BI " NVME_IO_DSM_LATENCY_NONE" +, +.br +.br +.BI " NVME_IO_DSM_LATENCY_IDLE" +, +.br +.br +.BI " NVME_IO_DSM_LATENCY_NORM" +, +.br +.br +.BI " NVME_IO_DSM_LATENCY_LOW" +, +.br +.br +.BI " NVME_IO_DSM_SEQ_REQ" +, +.br +.br +.BI " NVME_IO_DSM_COMPRESSED" + +}; +.SH Constants +.IP "NVME_IO_DSM_FREQ_UNSPEC" 12 +No frequency information provided +.IP "NVME_IO_DSM_FREQ_TYPICAL" 12 +Typical number of reads and writes +expected for this LBA range +.IP "NVME_IO_DSM_FREQ_RARE" 12 +Infrequent writes and infrequent +reads to the LBA range indicated +.IP "NVME_IO_DSM_FREQ_READS" 12 +Infrequent writes and frequent +reads to the LBA range indicated +.IP "NVME_IO_DSM_FREQ_WRITES" 12 +Frequent writes and infrequent +reads to the LBA range indicated +.IP "NVME_IO_DSM_FREQ_RW" 12 +Frequent writes and frequent reads +to the LBA range indicated +.IP "NVME_IO_DSM_FREQ_ONCE" 12 +.IP "NVME_IO_DSM_FREQ_PREFETCH" 12 +.IP "NVME_IO_DSM_FREQ_TEMP" 12 +.IP "NVME_IO_DSM_LATENCY_NONE" 12 +No latency information provided +.IP "NVME_IO_DSM_LATENCY_IDLE" 12 +Longer latency acceptable +.IP "NVME_IO_DSM_LATENCY_NORM" 12 +Typical latency +.IP "NVME_IO_DSM_LATENCY_LOW" 12 +Smallest possible latency +.IP "NVME_IO_DSM_SEQ_REQ" 12 +.IP "NVME_IO_DSM_COMPRESSED" 12 diff --git a/doc/man/nvme_io_opcode.2 b/doc/man/nvme_io_opcode.2 new file mode 100644 index 0000000..74fd864 --- /dev/null +++ b/doc/man/nvme_io_opcode.2 @@ -0,0 +1,102 @@ +.TH "libnvme" 9 "enum nvme_io_opcode" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_io_opcode \- +.SH SYNOPSIS +enum nvme_io_opcode { +.br +.BI " nvme_cmd_flush" +, +.br +.br +.BI " nvme_cmd_write" +, +.br +.br +.BI " nvme_cmd_read" +, +.br +.br +.BI " nvme_cmd_write_uncor" +, +.br +.br +.BI " nvme_cmd_compare" +, +.br +.br +.BI " nvme_cmd_write_zeroes" +, +.br +.br +.BI " nvme_cmd_dsm" +, +.br +.br +.BI " nvme_cmd_verify" +, +.br +.br +.BI " nvme_cmd_resv_register" +, +.br +.br +.BI " nvme_cmd_resv_report" +, +.br +.br +.BI " nvme_cmd_resv_acquire" +, +.br +.br +.BI " nvme_cmd_resv_release" +, +.br +.br +.BI " nvme_cmd_copy" +, +.br +.br +.BI " nvme_zns_cmd_mgmt_send" +, +.br +.br +.BI " nvme_zns_cmd_mgmt_recv" +, +.br +.br +.BI " nvme_zns_cmd_append" + +}; +.SH Constants +.IP "nvme_cmd_flush" 12 +Flush +.IP "nvme_cmd_write" 12 +Write +.IP "nvme_cmd_read" 12 +Read +.IP "nvme_cmd_write_uncor" 12 +Write Uncorrectable +.IP "nvme_cmd_compare" 12 +Compare +.IP "nvme_cmd_write_zeroes" 12 +write Zeros +.IP "nvme_cmd_dsm" 12 +Dataset Management +.IP "nvme_cmd_verify" 12 +Verify +.IP "nvme_cmd_resv_register" 12 +Reservation Register +.IP "nvme_cmd_resv_report" 12 +Reservation Report +.IP "nvme_cmd_resv_acquire" 12 +Reservation Acquire +.IP "nvme_cmd_resv_release" 12 +Reservation Release +.IP "nvme_cmd_copy" 12 +Copy +.IP "nvme_zns_cmd_mgmt_send" 12 +Zone Management Send +.IP "nvme_zns_cmd_mgmt_recv" 12 +Zone Management Receive +.IP "nvme_zns_cmd_append" 12 +Zone Append diff --git a/doc/man/nvme_io_passthru.2 b/doc/man/nvme_io_passthru.2 new file mode 100644 index 0000000..0e848ea --- /dev/null +++ b/doc/man/nvme_io_passthru.2 @@ -0,0 +1,71 @@ +.TH "nvme_io_passthru" 9 "nvme_io_passthru" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_io_passthru \- Submit an nvme io passthrough command +.SH SYNOPSIS +.B "int" nvme_io_passthru +.BI "(int fd " "," +.BI "__u8 opcode " "," +.BI "__u8 flags " "," +.BI "__u16 rsvd " "," +.BI "__u32 nsid " "," +.BI "__u32 cdw2 " "," +.BI "__u32 cdw3 " "," +.BI "__u32 cdw10 " "," +.BI "__u32 cdw11 " "," +.BI "__u32 cdw12 " "," +.BI "__u32 cdw13 " "," +.BI "__u32 cdw14 " "," +.BI "__u32 cdw15 " "," +.BI "__u32 data_len " "," +.BI "void *data " "," +.BI "__u32 metadata_len " "," +.BI "void *metadata " "," +.BI "__u32 timeout_ms " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "opcode" 12 +The nvme io command to send +.IP "flags" 12 +NVMe command flags (not used) +.IP "rsvd" 12 +Reserevd for future use +.IP "nsid" 12 +Namespace identifier +.IP "cdw2" 12 +Command dword 2 +.IP "cdw3" 12 +Command dword 3 +.IP "cdw10" 12 +Command dword 10 +.IP "cdw11" 12 +Command dword 11 +.IP "cdw12" 12 +Command dword 12 +.IP "cdw13" 12 +Command dword 13 +.IP "cdw14" 12 +Command dword 14 +.IP "cdw15" 12 +Command dword 15 +.IP "data_len" 12 +Length of the data transfered in this command in bytes +.IP "data" 12 +Pointer to user address of the data buffer +.IP "metadata_len" 12 +Length of metadata transfered in this command +.IP "metadata" 12 +Pointer to user address of the metadata buffer +.IP "timeout_ms" 12 +How long the kernel waits for the command to complete +.IP "result" 12 +Optional field to return the result from the CQE dword 0 +.SH "DESCRIPTION" +Parameterized form of \fBnvme_submit_io_passthru\fP. This sets up and submits +a \fIstruct nvme_passthru_cmd\fP. + +Known values for \fIopcode\fP are defined in \fIenum nvme_io_opcode\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_lba_range_type.2 b/doc/man/nvme_lba_range_type.2 new file mode 100644 index 0000000..14caf22 --- /dev/null +++ b/doc/man/nvme_lba_range_type.2 @@ -0,0 +1,15 @@ +.TH "libnvme" 9 "struct nvme_lba_range_type" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lba_range_type \- +.SH SYNOPSIS +struct nvme_lba_range_type { +.br +.BI " struct nvme_lba_range_type_entry entry[NVME_FEAT_LBA_RANGE_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "entry" 12 +LBA range type entry diff --git a/doc/man/nvme_lba_range_type_entry.2 b/doc/man/nvme_lba_range_type_entry.2 new file mode 100644 index 0000000..ef9496b --- /dev/null +++ b/doc/man/nvme_lba_range_type_entry.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lba_range_type_entry \- +.SH SYNOPSIS +struct nvme_lba_range_type_entry { +.br +.BI " __u8 type;" +.br +.BI " __u8 attributes;" +.br +.BI " __u8 rsvd2[14];" +.br +.BI " __u64 slba;" +.br +.BI " __u64 nlb;" +.br +.BI " __u8 guid[16];" +.br +.BI " __u8 rsvd48[16];" +.br +.BI " +}; +.br + +.SH Members +.IP "type" 12 +Specifies the Type of the LBA range +.IP "attributes" 12 +Specifies attributes of the LBA range +.IP "rsvd2" 12 +Reserved +.IP "slba" 12 +Starting LBA +.IP "nlb" 12 +Number of Logical Blocks +.IP "guid" 12 +Unique Identifier +.IP "rsvd48" 12 +Reserved diff --git a/doc/man/nvme_lba_rd.2 b/doc/man/nvme_lba_rd.2 new file mode 100644 index 0000000..5203f90 --- /dev/null +++ b/doc/man/nvme_lba_rd.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_lba_rd" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lba_rd \- +.SH SYNOPSIS +struct nvme_lba_rd { +.br +.BI " __le64 rslba;" +.br +.BI " __le32 rnlb;" +.br +.BI " __u8 rsvd12[4];" +.br +.BI " +}; +.br + +.SH Members +.IP "rslba" 12 +Range Starting LBA +.IP "rnlb" 12 +Range Number of Logical Blocks +.IP "rsvd12" 12 +Reserved diff --git a/doc/man/nvme_lba_status.2 b/doc/man/nvme_lba_status.2 new file mode 100644 index 0000000..c4b55f5 --- /dev/null +++ b/doc/man/nvme_lba_status.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_lba_status" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lba_status \- +.SH SYNOPSIS +struct nvme_lba_status { +.br +.BI " __le32 nlsd;" +.br +.BI " __u8 cmpc;" +.br +.BI " __u8 rsvd5[3];" +.br +.BI " struct nvme_lba_status_desc descs[];" +.br +.BI " +}; +.br + +.SH Members +.IP "nlsd" 12 +Number of LBA Status Descriptors +.IP "cmpc" 12 +Completion Condition +.IP "rsvd5" 12 +Reserved +.IP "descs" 12 +LBA status descriptor Entry diff --git a/doc/man/nvme_lba_status_atype.2 b/doc/man/nvme_lba_status_atype.2 new file mode 100644 index 0000000..4cc9aa6 --- /dev/null +++ b/doc/man/nvme_lba_status_atype.2 @@ -0,0 +1,16 @@ +.TH "libnvme" 9 "enum nvme_lba_status_atype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_lba_status_atype \- +.SH SYNOPSIS +enum nvme_lba_status_atype { +.br +.BI " NVME_LBA_STATUS_ATYPE_SCAN_UNTRACKED" +, +.br +.br +.BI " NVME_LBA_STATUS_ATYPE_SCAN_TRACKED" + +}; +.SH Constants +.IP "NVME_LBA_STATUS_ATYPE_SCAN_UNTRACKED" 12 +.IP "NVME_LBA_STATUS_ATYPE_SCAN_TRACKED" 12 diff --git a/doc/man/nvme_lba_status_desc.2 b/doc/man/nvme_lba_status_desc.2 new file mode 100644 index 0000000..c1d8309 --- /dev/null +++ b/doc/man/nvme_lba_status_desc.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_lba_status_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lba_status_desc \- +.SH SYNOPSIS +struct nvme_lba_status_desc { +.br +.BI " __le64 dslba;" +.br +.BI " __le32 nlb;" +.br +.BI " __u8 rsvd12;" +.br +.BI " __u8 status;" +.br +.BI " __u8 rsvd14[2];" +.br +.BI " +}; +.br + +.SH Members +.IP "dslba" 12 +Descriptor Starting LBA +.IP "nlb" 12 +Number of Logical Blocks +.IP "rsvd12" 12 +Reserved +.IP "status" 12 +Additional status about this LBA range +.IP "rsvd14" 12 +Reserved diff --git a/doc/man/nvme_lba_status_log.2 b/doc/man/nvme_lba_status_log.2 new file mode 100644 index 0000000..6574def --- /dev/null +++ b/doc/man/nvme_lba_status_log.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_lba_status_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lba_status_log \- +.SH SYNOPSIS +struct nvme_lba_status_log { +.br +.BI " __le32 lslplen;" +.br +.BI " __le32 nlslne;" +.br +.BI " __le32 estulb;" +.br +.BI " __u8 rsvd12[2];" +.br +.BI " __le16 lsgc;" +.br +.BI " struct nvme_lbas_ns_element elements[];" +.br +.BI " +}; +.br + +.SH Members +.IP "lslplen" 12 +LBA Status Log Page Length +.IP "nlslne" 12 +Number of LBA Status Log Namespace Elements +.IP "estulb" 12 +Estimate of Unrecoverable Logical Blocks +.IP "rsvd12" 12 +Reserved +.IP "lsgc" 12 +LBA Status Generation Counter +.IP "elements" 12 +LBA Status Log Namespace Element List diff --git a/doc/man/nvme_lbaf.2 b/doc/man/nvme_lbaf.2 new file mode 100644 index 0000000..2270b8b --- /dev/null +++ b/doc/man/nvme_lbaf.2 @@ -0,0 +1,25 @@ +.TH "libnvme" 9 "struct nvme_lbaf" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lbaf \- LBA Format Data Structure +.SH SYNOPSIS +struct nvme_lbaf { +.br +.BI " __le16 ms;" +.br +.BI " __u8 ds;" +.br +.BI " __u8 rp;" +.br +.BI " +}; +.br + +.SH Members +.IP "ms" 12 +Metadata Size indicates the number of metadata bytes provided per LBA +based on the LBA Data Size indicated. +.IP "ds" 12 +LBA Data Size indicates the LBA data size supported, reported as a +power of two. +.IP "rp" 12 +Relative Performance, see \fIenum nvme_lbaf_rp\fP. diff --git a/doc/man/nvme_lbaf_rp.2 b/doc/man/nvme_lbaf_rp.2 new file mode 100644 index 0000000..37d9ab6 --- /dev/null +++ b/doc/man/nvme_lbaf_rp.2 @@ -0,0 +1,37 @@ +.TH "libnvme" 9 "enum nvme_lbaf_rp" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_lbaf_rp \- This field indicates the relative performance of the LBA format indicated relative to other LBA formats supported by the controller. +.SH SYNOPSIS +enum nvme_lbaf_rp { +.br +.BI " NVME_LBAF_RP_BEST" +, +.br +.br +.BI " NVME_LBAF_RP_BETTER" +, +.br +.br +.BI " NVME_LBAF_RP_GOOD" +, +.br +.br +.BI " NVME_LBAF_RP_DEGRADED" +, +.br +.br +.BI " NVME_LBAF_RP_MASK" + +}; +.SH Constants +.IP "NVME_LBAF_RP_BEST" 12 +Best performance +.IP "NVME_LBAF_RP_BETTER" 12 +Better performance +.IP "NVME_LBAF_RP_GOOD" 12 +Good performance +.IP "NVME_LBAF_RP_DEGRADED" 12 +Degraded performance +.IP "NVME_LBAF_RP_MASK" 12 +Mask to get the relative performance value from the +field diff --git a/doc/man/nvme_lbart.2 b/doc/man/nvme_lbart.2 new file mode 100644 index 0000000..6c1ee8a --- /dev/null +++ b/doc/man/nvme_lbart.2 @@ -0,0 +1,48 @@ +.TH "libnvme" 9 "enum nvme_lbart" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_lbart \- +.SH SYNOPSIS +enum nvme_lbart { +.br +.BI " NVME_LBART_TYPE_GP" +, +.br +.br +.BI " NVME_LBART_TYPE_FS" +, +.br +.br +.BI " NVME_LBART_TYPE_RAID" +, +.br +.br +.BI " NVME_LBART_TYPE_CACHE" +, +.br +.br +.BI " NVME_LBART_TYPE_SWAP" +, +.br +.br +.BI " NVME_LBART_ATTRIB_TEMP" +, +.br +.br +.BI " NVME_LBART_ATTRIB_HIDE" + +}; +.SH Constants +.IP "NVME_LBART_TYPE_GP" 12 +General Purpose +.IP "NVME_LBART_TYPE_FS" 12 +Filesystem +.IP "NVME_LBART_TYPE_RAID" 12 +RAID +.IP "NVME_LBART_TYPE_CACHE" 12 +Cache +.IP "NVME_LBART_TYPE_SWAP" 12 +Page / swap file +.IP "NVME_LBART_ATTRIB_TEMP" 12 +Temp +.IP "NVME_LBART_ATTRIB_HIDE" 12 +Hidden diff --git a/doc/man/nvme_lbas_ns_element.2 b/doc/man/nvme_lbas_ns_element.2 new file mode 100644 index 0000000..5367ae1 --- /dev/null +++ b/doc/man/nvme_lbas_ns_element.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_lbas_ns_element" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lbas_ns_element \- +.SH SYNOPSIS +struct nvme_lbas_ns_element { +.br +.BI " __le32 neid;" +.br +.BI " __le32 nlrd;" +.br +.BI " __u8 ratype;" +.br +.BI " __u8 rsvd8[7];" +.br +.BI " struct nvme_lba_rd lba_rd[];" +.br +.BI " +}; +.br + +.SH Members +.IP "neid" 12 +Namespace Element Identifier +.IP "nlrd" 12 +Number of LBA Range Descriptors +.IP "ratype" 12 +Recommended Action Type +.IP "rsvd8" 12 +Reserved +.IP "lba_rd" 12 +LBA Range Descriptor diff --git a/doc/man/nvme_lockdown.2 b/doc/man/nvme_lockdown.2 new file mode 100644 index 0000000..dd67871 --- /dev/null +++ b/doc/man/nvme_lockdown.2 @@ -0,0 +1,12 @@ +.TH "nvme_lockdown" 9 "nvme_lockdown" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_lockdown \- Issue lockdown command +.SH SYNOPSIS +.B "int" nvme_lockdown +.BI "(struct nvme_lockdown_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_lockdown_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_lockdown_args.2 b/doc/man/nvme_lockdown_args.2 new file mode 100644 index 0000000..c8f83b5 --- /dev/null +++ b/doc/man/nvme_lockdown_args.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_lockdown_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_lockdown_args \- Arguments for the NVME Lockdown command +.SH SYNOPSIS +struct nvme_lockdown_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u8 scp;" +.br +.BI " __u8 prhbt;" +.br +.BI " __u8 ifc;" +.br +.BI " __u8 ofi;" +.br +.BI " __u8 uuidx;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_lockdown_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms (0 for default timeout) +.IP "scp" 12 +Scope of the command +.IP "prhbt" 12 +Prohibit or allow the command opcode or Set Features command +.IP "ifc" 12 +Affected interface +.IP "ofi" 12 +Opcode or Feature Identifier +.IP "uuidx" 12 +UUID Index if controller supports this id selection method diff --git a/doc/man/nvme_log_ana_lsp.2 b/doc/man/nvme_log_ana_lsp.2 new file mode 100644 index 0000000..fc8f063 --- /dev/null +++ b/doc/man/nvme_log_ana_lsp.2 @@ -0,0 +1,16 @@ +.TH "libnvme" 9 "enum nvme_log_ana_lsp" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_log_ana_lsp \- +.SH SYNOPSIS +enum nvme_log_ana_lsp { +.br +.BI " NVME_LOG_ANA_LSP_RGO_NAMESPACES" +, +.br +.br +.BI " NVME_LOG_ANA_LSP_RGO_GROUPS_ONLY" + +}; +.SH Constants +.IP "NVME_LOG_ANA_LSP_RGO_NAMESPACES" 12 +.IP "NVME_LOG_ANA_LSP_RGO_GROUPS_ONLY" 12 diff --git a/doc/man/nvme_lookup_ctrl.2 b/doc/man/nvme_lookup_ctrl.2 new file mode 100644 index 0000000..6b42f4a --- /dev/null +++ b/doc/man/nvme_lookup_ctrl.2 @@ -0,0 +1,35 @@ +.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_lookup_ctrl \- Lookup nvme_ctrl_t object +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_lookup_ctrl +.BI "(nvme_subsystem_t s " "," +.BI "const char *transport " "," +.BI "const char *traddr " "," +.BI "const char *host_traddr " "," +.BI "const char *host_iface " "," +.BI "const char *trsvcid " "," +.BI "nvme_ctrl_t p " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "transport" 12 +Transport name +.IP "traddr" 12 +Transport address +.IP "host_traddr" 12 +Host transport address +.IP "host_iface" 12 +Host interface name +.IP "trsvcid" 12 +Transport service identifier +.IP "p" 12 +Previous controller instance +.SH "DESCRIPTION" +Lookup a controller in \fIs\fP based on \fItransport\fP, \fItraddr\fP, +\fIhost_traddr\fP, \fIhost_iface\fP, and \fItrsvcid\fP. \fItransport\fP must be specified, +other fields may be required depending on the transport. A new +object is created if none is found. If \fIp\fP is specified the lookup +will start at \fIp\fP instead of the first controller. +.SH "RETURN" +Controller instance diff --git a/doc/man/nvme_lookup_host.2 b/doc/man/nvme_lookup_host.2 new file mode 100644 index 0000000..f5fb23c --- /dev/null +++ b/doc/man/nvme_lookup_host.2 @@ -0,0 +1,20 @@ +.TH "nvme_lookup_host" 9 "nvme_lookup_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_lookup_host \- Lookup nvme_host_t object +.SH SYNOPSIS +.B "nvme_host_t" nvme_lookup_host +.BI "(nvme_root_t r " "," +.BI "const char *hostnqn " "," +.BI "const char *hostid " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.IP "hostnqn" 12 +Host NQN +.IP "hostid" 12 +Host ID +.SH "DESCRIPTION" +Lookup a nvme_host_t object based on \fIhostnqn\fP and \fIhostid\fP +or create one if not found. +.SH "RETURN" +\fInvme_host_t\fP object diff --git a/doc/man/nvme_lookup_subsystem.2 b/doc/man/nvme_lookup_subsystem.2 new file mode 100644 index 0000000..5127f68 --- /dev/null +++ b/doc/man/nvme_lookup_subsystem.2 @@ -0,0 +1,20 @@ +.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_lookup_subsystem \- Lookup nvme_subsystem_t object +.SH SYNOPSIS +.B "nvme_subsystem_t" nvme_lookup_subsystem +.BI "(struct nvme_host *h " "," +.BI "const char *name " "," +.BI "const char *subsysnqn " ");" +.SH ARGUMENTS +.IP "h" 12 +\fInvme_host_t\fP object +.IP "name" 12 +Name of the subsystem (may be NULL) +.IP "subsysnqn" 12 +Subsystem NQN +.SH "DESCRIPTION" +Lookup a \fInvme_subsystem_t\fP object in \fIh\fP base on \fIname\fP (if present) +and \fIsubsystemnqn\fP or create one if not found. +.SH "RETURN" +nvme_subsystme_t object diff --git a/doc/man/nvme_media_unit_config_desc.2 b/doc/man/nvme_media_unit_config_desc.2 new file mode 100644 index 0000000..e739f1d --- /dev/null +++ b/doc/man/nvme_media_unit_config_desc.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_media_unit_config_desc \- +.SH SYNOPSIS +struct nvme_media_unit_config_desc { +.br +.BI " __le16 muid;" +.br +.BI " __u8 rsvd2[4];" +.br +.BI " __le16 mudl;" +.br +.BI " +}; +.br + +.SH Members +.IP "muid" 12 +Media Unit Identifier +.IP "mudl" 12 +Media Unit Descriptor Length +.SH "Description" +Media Unit Configuration Descriptor +Structure Definitions diff --git a/doc/man/nvme_media_unit_stat_desc.2 b/doc/man/nvme_media_unit_stat_desc.2 new file mode 100644 index 0000000..26282e3 --- /dev/null +++ b/doc/man/nvme_media_unit_stat_desc.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_media_unit_stat_desc \- +.SH SYNOPSIS +struct nvme_media_unit_stat_desc { +.br +.BI " __le16 muid;" +.br +.BI " __le16 domainid;" +.br +.BI " __le16 endgid;" +.br +.BI " __le16 nvmsetid;" +.br +.BI " __le16 cap_adj_fctr;" +.br +.BI " __u8 avl_spare;" +.br +.BI " __u8 percent_used;" +.br +.BI " __u8 mucs;" +.br +.BI " __u8 cio;" +.br +.BI " +}; +.br + +.SH Members +.IP "muid" 12 +Media Unit Identifier +.IP "domainid" 12 +Domain Identifier +.IP "endgid" 12 +Endurance Group Identifier +.IP "nvmsetid" 12 +NVM Set Identifier +.IP "cap_adj_fctr" 12 +Capacity Adjustment Factor +.IP "avl_spare" 12 +Available Spare +.IP "percent_used" 12 +Percentage Used +.IP "mucs" 12 +Number of Channels attached to media units +.IP "cio" 12 +Channel Identifiers Offset diff --git a/doc/man/nvme_media_unit_stat_log.2 b/doc/man/nvme_media_unit_stat_log.2 new file mode 100644 index 0000000..45affc3 --- /dev/null +++ b/doc/man/nvme_media_unit_stat_log.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_media_unit_stat_log \- +.SH SYNOPSIS +struct nvme_media_unit_stat_log { +.br +.BI " __le16 nmu;" +.br +.BI " __le16 cchans;" +.br +.BI " __le16 sel_config;" +.br +.BI " __u8 rsvd6[10];" +.br +.BI " struct nvme_media_unit_stat_desc mus_desc[];" +.br +.BI " +}; +.br + +.SH Members +.IP "nmu" 12 +Number unit status descriptor +.IP "cchans" 12 +Number of Channels +.IP "sel_config" 12 +Selected Configuration +.IP "rsvd6" 12 +Reserved +.IP "mus_desc" 12 +Media unit statistic descriptors diff --git a/doc/man/nvme_metadata_element_desc.2 b/doc/man/nvme_metadata_element_desc.2 new file mode 100644 index 0000000..32565a8 --- /dev/null +++ b/doc/man/nvme_metadata_element_desc.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_metadata_element_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_metadata_element_desc \- Metadata Element Descriptor +.SH SYNOPSIS +struct nvme_metadata_element_desc { +.br +.BI " __u8 type;" +.br +.BI " __u8 rev;" +.br +.BI " __u16 len;" +.br +.BI " __u8 val[0];" +.br +.BI " +}; +.br + +.SH Members +.IP "type" 12 +Element Type (ET) +.IP "rev" 12 +Element Revision (ER) +.IP "len" 12 +Element Length (ELEN) +.IP "val" 12 +Element Value (EVAL), UTF-8 string diff --git a/doc/man/nvme_mi_cmd_supported_effects.2 b/doc/man/nvme_mi_cmd_supported_effects.2 new file mode 100644 index 0000000..14a723d --- /dev/null +++ b/doc/man/nvme_mi_cmd_supported_effects.2 @@ -0,0 +1,86 @@ +.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_cmd_supported_effects \- bit field definitions +.SH SYNOPSIS +enum nvme_mi_cmd_supported_effects { +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_CSUPP" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_UDCC" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_NCC" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_NIC" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_CCC" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_SHIFT" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_MASK" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NS" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_CTRL" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NVM_SET" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_ENDGRP" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_DOMAIN" +, +.br +.br +.BI " NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NSS" + +}; +.SH Constants +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_CSUPP" 12 +Command Supported +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_UDCC" 12 +User Data Conttent Change +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_NCC" 12 +Namespace Capability Change +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_NIC" 12 +Namespace Inventory Change +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_CCC" 12 +Controller Capability Change +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_SHIFT" 12 +20 bit shift +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_MASK" 12 +12 bit mask - 0xfff +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NS" 12 +Namespace Scope +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_CTRL" 12 +Controller Scope +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NVM_SET" 12 +NVM Set Scope +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_ENDGRP" 12 +Endurance Group Scope +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_DOMAIN" 12 +Domain Scope +.IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NSS" 12 +NVM Subsystem Scope +.SH "Description" +MI Command Supported and Effects Data Structure definitions diff --git a/doc/man/nvme_mi_cmd_supported_effects_log.2 b/doc/man/nvme_mi_cmd_supported_effects_log.2 new file mode 100644 index 0000000..96763e7 --- /dev/null +++ b/doc/man/nvme_mi_cmd_supported_effects_log.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_cmd_supported_effects_log \- +.SH SYNOPSIS +struct nvme_mi_cmd_supported_effects_log { +.br +.BI " __le32 mi_cmd_support[NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX];" +.br +.BI " __le32 reserved1[NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED];" +.br +.BI " +}; +.br + +.SH Members +.IP "mi_cmd_support" 12 +NVMe-MI Commands Supported +.SH "Description" +NVMe-MI Commands Supported and Effects (Log Identifier 13h) diff --git a/doc/man/nvme_mi_css.2 b/doc/man/nvme_mi_css.2 new file mode 100644 index 0000000..f75db9e --- /dev/null +++ b/doc/man/nvme_mi_css.2 @@ -0,0 +1,78 @@ +.TH "libnvme" 9 "enum nvme_mi_css" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_css \- +.SH SYNOPSIS +enum nvme_mi_css { +.br +.BI " NVME_MI_CCS_RDY" +, +.br +.br +.BI " NVME_MI_CSS_CFS" +, +.br +.br +.BI " NVME_MI_CSS_SHST" +, +.br +.br +.BI " NVME_MI_CSS_NSSRO" +, +.br +.br +.BI " NVME_MI_CSS_CECO" +, +.br +.br +.BI " NVME_MI_CSS_NAC" +, +.br +.br +.BI " NVME_MI_CSS_FA" +, +.br +.br +.BI " NVME_MI_CSS_CSTS" +, +.br +.br +.BI " NVME_MI_CSS_CTEMP" +, +.br +.br +.BI " NVME_MI_CSS_PDLU" +, +.br +.br +.BI " NVME_MI_CSS_SPARE" +, +.br +.br +.BI " NVME_MI_CSS_CCWARN" + +}; +.SH Constants +.IP "NVME_MI_CCS_RDY" 12 +Ready +.IP "NVME_MI_CSS_CFS" 12 +Controller Fatal Status +.IP "NVME_MI_CSS_SHST" 12 +Shutdown Status +.IP "NVME_MI_CSS_NSSRO" 12 +NVM Subsystem Reset Occurred +.IP "NVME_MI_CSS_CECO" 12 +Controller Enable Change Occurred +.IP "NVME_MI_CSS_NAC" 12 +Namespace Attribute Changed +.IP "NVME_MI_CSS_FA" 12 +Firmware Activated +.IP "NVME_MI_CSS_CSTS" 12 +Controller Status Change +.IP "NVME_MI_CSS_CTEMP" 12 +Composite Temperature Change +.IP "NVME_MI_CSS_PDLU" 12 +Percentage Used +.IP "NVME_MI_CSS_SPARE" 12 +Available Spare +.IP "NVME_MI_CSS_CCWARN" 12 +Critical Warning diff --git a/doc/man/nvme_mi_csts.2 b/doc/man/nvme_mi_csts.2 new file mode 100644 index 0000000..f9e388a --- /dev/null +++ b/doc/man/nvme_mi_csts.2 @@ -0,0 +1,48 @@ +.TH "libnvme" 9 "enum nvme_mi_csts" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_csts \- +.SH SYNOPSIS +enum nvme_mi_csts { +.br +.BI " NVME_MI_CSTS_RDY" +, +.br +.br +.BI " NVME_MI_CSTS_CFS" +, +.br +.br +.BI " NVME_MI_CSTS_SHST" +, +.br +.br +.BI " NVME_MI_CSTS_NSSRO" +, +.br +.br +.BI " NVME_MI_CSTS_CECO" +, +.br +.br +.BI " NVME_MI_CSTS_NAC" +, +.br +.br +.BI " NVME_MI_CSTS_FA" + +}; +.SH Constants +.IP "NVME_MI_CSTS_RDY" 12 +Ready +.IP "NVME_MI_CSTS_CFS" 12 +Controller Fatal Status +.IP "NVME_MI_CSTS_SHST" 12 +Shutdown Status +.IP "NVME_MI_CSTS_NSSRO" 12 +NVM Subsystem Reset Occurred +.IP "NVME_MI_CSTS_CECO" 12 +Controller Enable Change Occurred +.IP "NVME_MI_CSTS_NAC" 12 +Namespace Attribute Changed +.IP "NVME_MI_CSTS_FA" 12 +Firmware Activated diff --git a/doc/man/nvme_mi_ctrl_health_status.2 b/doc/man/nvme_mi_ctrl_health_status.2 new file mode 100644 index 0000000..76cb616 --- /dev/null +++ b/doc/man/nvme_mi_ctrl_health_status.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_ctrl_health_status \- +.SH SYNOPSIS +struct nvme_mi_ctrl_health_status { +.br +.BI " __le16 ctlid;" +.br +.BI " __le16 csts;" +.br +.BI " __le16 ctemp;" +.br +.BI " __u8 pdlu;" +.br +.BI " __u8 spare;" +.br +.BI " __u8 cwarn;" +.br +.BI " __u8 rsvd9[7];" +.br +.BI " +}; +.br + +.SH Members +.IP "ctlid" 12 +Controller Identifier +.IP "csts" 12 +Controller Status +.IP "ctemp" 12 +Composite Temperature +.IP "pdlu" 12 +Percentage Used +.IP "spare" 12 +Available Spare +.IP "cwarn" 12 +Critical Warning +.IP "rsvd9" 12 +Reserved diff --git a/doc/man/nvme_mi_cwarn.2 b/doc/man/nvme_mi_cwarn.2 new file mode 100644 index 0000000..11ccbc8 --- /dev/null +++ b/doc/man/nvme_mi_cwarn.2 @@ -0,0 +1,36 @@ +.TH "libnvme" 9 "enum nvme_mi_cwarn" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_cwarn \- +.SH SYNOPSIS +enum nvme_mi_cwarn { +.br +.BI " NVME_MI_CWARN_ST" +, +.br +.br +.BI " NVME_MI_CWARN_TAUT" +, +.br +.br +.BI " NVME_MI_CWARN_RD" +, +.br +.br +.BI " NVME_MI_CWARN_RO" +, +.br +.br +.BI " NVME_MI_CWARN_VMBF" + +}; +.SH Constants +.IP "NVME_MI_CWARN_ST" 12 +Spare Threshold +.IP "NVME_MI_CWARN_TAUT" 12 +Temperature Above or Under Threshold +.IP "NVME_MI_CWARN_RD" 12 +Reliability Degraded +.IP "NVME_MI_CWARN_RO" 12 +Read Only +.IP "NVME_MI_CWARN_VMBF" 12 +Volatile Memory Backup Failed diff --git a/doc/man/nvme_mi_elem.2 b/doc/man/nvme_mi_elem.2 new file mode 100644 index 0000000..17be0ef --- /dev/null +++ b/doc/man/nvme_mi_elem.2 @@ -0,0 +1,48 @@ +.TH "libnvme" 9 "enum nvme_mi_elem" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_elem \- +.SH SYNOPSIS +enum nvme_mi_elem { +.br +.BI " NVME_MI_ELEM_EED" +, +.br +.br +.BI " NVME_MI_ELEM_USCE" +, +.br +.br +.BI " NVME_MI_ELEM_ECED" +, +.br +.br +.BI " NVME_MI_ELEM_LED" +, +.br +.br +.BI " NVME_MI_ELEM_SMBMED" +, +.br +.br +.BI " NVME_MI_ELEM_PCIESED" +, +.br +.br +.BI " NVME_MI_ELEM_NVMED" + +}; +.SH Constants +.IP "NVME_MI_ELEM_EED" 12 +Extended Element Descriptor +.IP "NVME_MI_ELEM_USCE" 12 +Upstream Connector Element Descriptor +.IP "NVME_MI_ELEM_ECED" 12 +Expansion Connector Element Descriptor +.IP "NVME_MI_ELEM_LED" 12 +Label Element Descriptor +.IP "NVME_MI_ELEM_SMBMED" 12 +SMBus/I2C Mux Element Descriptor +.IP "NVME_MI_ELEM_PCIESED" 12 +PCIe Switch Element Descriptor +.IP "NVME_MI_ELEM_NVMED" 12 +NVM Subsystem Element Descriptor diff --git a/doc/man/nvme_mi_nvm_ss_health_status.2 b/doc/man/nvme_mi_nvm_ss_health_status.2 new file mode 100644 index 0000000..55c6d96 --- /dev/null +++ b/doc/man/nvme_mi_nvm_ss_health_status.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_nvm_ss_health_status \- +.SH SYNOPSIS +struct nvme_mi_nvm_ss_health_status { +.br +.BI " __u8 nss;" +.br +.BI " __u8 sw;" +.br +.BI " __u8 ctemp;" +.br +.BI " __u8 pdlu;" +.br +.BI " __le16 ccs;" +.br +.BI " __u8 rsvd8[2];" +.br +.BI " +}; +.br + +.SH Members +.IP "nss" 12 +NVM Subsystem Status +.IP "sw" 12 +Smart Warnings +.IP "ctemp" 12 +Composite Temperature +.IP "pdlu" 12 +Percentage Drive Life Used +.IP "ccs" 12 +Composite Controller Status +.IP "rsvd8" 12 +Reserved diff --git a/doc/man/nvme_mi_osc.2 b/doc/man/nvme_mi_osc.2 new file mode 100644 index 0000000..df270a2 --- /dev/null +++ b/doc/man/nvme_mi_osc.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_mi_osc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_osc \- +.SH SYNOPSIS +struct nvme_mi_osc { +.br +.BI " __u8 type;" +.br +.BI " __u8 opc;" +.br +.BI " +}; +.br + +.SH Members +.IP "type" 12 +Command Type +.IP "opc" 12 +Opcode diff --git a/doc/man/nvme_mi_port_pcie.2 b/doc/man/nvme_mi_port_pcie.2 new file mode 100644 index 0000000..5221f02 --- /dev/null +++ b/doc/man/nvme_mi_port_pcie.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_mi_port_pcie" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_port_pcie \- +.SH SYNOPSIS +struct nvme_mi_port_pcie { +.br +.BI " __u8 mps;" +.br +.BI " __u8 sls;" +.br +.BI " __u8 cls;" +.br +.BI " __u8 mlw;" +.br +.BI " __u8 nlw;" +.br +.BI " __u8 pn;" +.br +.BI " __u8 rsvd14[18];" +.br +.BI " +}; +.br + +.SH Members +.IP "mps" 12 +PCIe Maximum Payload Size +.IP "sls" 12 +PCIe Supported Link Speeds Vector +.IP "cls" 12 +PCIe Current Link Speed +.IP "mlw" 12 +PCIe Maximum Link Width +.IP "nlw" 12 +PCIe Negotiated Link Width +.IP "pn" 12 +PCIe Port Number +.IP "rsvd14" 12 +Reserved diff --git a/doc/man/nvme_mi_port_smb.2 b/doc/man/nvme_mi_port_smb.2 new file mode 100644 index 0000000..e7f3bfa --- /dev/null +++ b/doc/man/nvme_mi_port_smb.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_mi_port_smb" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_port_smb \- +.SH SYNOPSIS +struct nvme_mi_port_smb { +.br +.BI " __u8 vpd_addr;" +.br +.BI " __u8 mvpd_freq;" +.br +.BI " __u8 mme_addr;" +.br +.BI " __u8 mme_freq;" +.br +.BI " __u8 nvmebm;" +.br +.BI " __u8 rsvd13[19];" +.br +.BI " +}; +.br + +.SH Members +.IP "vpd_addr" 12 +Current VPD SMBus/I2C Address +.IP "mvpd_freq" 12 +Maximum VPD Access SMBus/I2C Frequency +.IP "mme_addr" 12 +Current Management Endpoint SMBus/I2C Address +.IP "mme_freq" 12 +Maximum Management Endpoint SMBus/I2C Frequency +.IP "nvmebm" 12 +NVMe Basic Management +.IP "rsvd13" 12 +Reserved diff --git a/doc/man/nvme_mi_read_ctrl_info.2 b/doc/man/nvme_mi_read_ctrl_info.2 new file mode 100644 index 0000000..790b652 --- /dev/null +++ b/doc/man/nvme_mi_read_ctrl_info.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_read_ctrl_info \- +.SH SYNOPSIS +struct nvme_mi_read_ctrl_info { +.br +.BI " __u8 portid;" +.br +.BI " __u8 rsvd1[4];" +.br +.BI " __u8 prii;" +.br +.BI " __le16 pri;" +.br +.BI " __le16 vid;" +.br +.BI " __le16 did;" +.br +.BI " __le16 ssvid;" +.br +.BI " __le16 ssid;" +.br +.BI " __u8 rsvd16[16];" +.br +.BI " +}; +.br + +.SH Members +.IP "portid" 12 +Port Identifier +.IP "rsvd1" 12 +Reserved +.IP "prii" 12 +PCIe Routing ID Information +.IP "pri" 12 +PCIe Routing ID +.IP "vid" 12 +PCI Vendor ID +.IP "did" 12 +PCI Device ID +.IP "ssvid" 12 +PCI Subsystem Vendor ID +.IP "ssid" 12 +PCI Subsystem Device ID +.IP "rsvd16" 12 +Reserved diff --git a/doc/man/nvme_mi_read_nvm_ss_info.2 b/doc/man/nvme_mi_read_nvm_ss_info.2 new file mode 100644 index 0000000..c063097 --- /dev/null +++ b/doc/man/nvme_mi_read_nvm_ss_info.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_read_nvm_ss_info \- +.SH SYNOPSIS +struct nvme_mi_read_nvm_ss_info { +.br +.BI " __u8 nump;" +.br +.BI " __u8 mjr;" +.br +.BI " __u8 mnr;" +.br +.BI " __u8 rsvd3[29];" +.br +.BI " +}; +.br + +.SH Members +.IP "nump" 12 +Number of Ports +.IP "mjr" 12 +NVMe-MI Major Version Number +.IP "mnr" 12 +NVMe-MI Minor Version Number +.IP "rsvd3" 12 +Reserved diff --git a/doc/man/nvme_mi_read_port_info.2 b/doc/man/nvme_mi_read_port_info.2 new file mode 100644 index 0000000..dd634cb --- /dev/null +++ b/doc/man/nvme_mi_read_port_info.2 @@ -0,0 +1,41 @@ +.TH "libnvme" 9 "struct nvme_mi_read_port_info" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_read_port_info \- +.SH SYNOPSIS +struct nvme_mi_read_port_info { +.br +.BI " __u8 portt;" +.br +.BI " __u8 rsvd1;" +.br +.BI " __le16 mmctptus;" +.br +.BI " __le32 meb;" +.br +.BI " union {" +.br +.BI " struct nvme_mi_port_pcie pcie;" +.br +.BI " struct nvme_mi_port_smb smb;" +.br +.BI " };" +.br +.BI " +}; +.br + +.SH Members +.IP "portt" 12 +Port Type +.IP "rsvd1" 12 +Reserved +.IP "mmctptus" 12 +Maximum MCTP Transmission Unit Size +.IP "meb" 12 +Management Endpoint Buffer Size +.IP "{unnamed_union}" 12 +anonymous +.IP "pcie" 12 +PCIe Port Specific Data +.IP "smb" 12 +SMBus Port Specific Data diff --git a/doc/man/nvme_mi_read_sc_list.2 b/doc/man/nvme_mi_read_sc_list.2 new file mode 100644 index 0000000..f7b9ba4 --- /dev/null +++ b/doc/man/nvme_mi_read_sc_list.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_read_sc_list \- +.SH SYNOPSIS +struct nvme_mi_read_sc_list { +.br +.BI " __le16 numcmd;" +.br +.BI " struct nvme_mi_osc cmds[];" +.br +.BI " +}; +.br + +.SH Members +.IP "numcmd" 12 +Number of Commands +.IP "cmds" 12 +MEB supported Command Data Structure diff --git a/doc/man/nvme_mi_vpd_hdr.2 b/doc/man/nvme_mi_vpd_hdr.2 new file mode 100644 index 0000000..f3b646d --- /dev/null +++ b/doc/man/nvme_mi_vpd_hdr.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_vpd_hdr \- +.SH SYNOPSIS +struct nvme_mi_vpd_hdr { +.br +.BI " __u8 ipmiver;" +.br +.BI " __u8 iuaoff;" +.br +.BI " __u8 ciaoff;" +.br +.BI " __u8 biaoff;" +.br +.BI " __u8 piaoff;" +.br +.BI " __u8 mrioff;" +.br +.BI " __u8 rsvd6;" +.br +.BI " __u8 chchk;" +.br +.BI " __u8 vpd[];" +.br +.BI " +}; +.br + +.SH Members +.IP "ipmiver" 12 +IPMI Format Version Number +.IP "iuaoff" 12 +Internal Use Area Starting Offset +.IP "ciaoff" 12 +Chassis Info Area Starting Offset +.IP "biaoff" 12 +Board Info Area Starting Offset +.IP "piaoff" 12 +Product Info Area Starting Offset +.IP "mrioff" 12 +MultiRecord Info Area Starting Offset +.IP "rsvd6" 12 +Reserved +.IP "chchk" 12 +Common Header Checksum +.IP "vpd" 12 +Vital Product Data diff --git a/doc/man/nvme_mi_vpd_mr_common.2 b/doc/man/nvme_mi_vpd_mr_common.2 new file mode 100644 index 0000000..7e8d7a2 --- /dev/null +++ b/doc/man/nvme_mi_vpd_mr_common.2 @@ -0,0 +1,49 @@ +.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_vpd_mr_common \- +.SH SYNOPSIS +struct nvme_mi_vpd_mr_common { +.br +.BI " __u8 type;" +.br +.BI " __u8 rf;" +.br +.BI " __u8 rlen;" +.br +.BI " __u8 rchksum;" +.br +.BI " __u8 hchksum;" +.br +.BI " union {" +.br +.BI " struct nvme_mi_vpd_mra nmra;" +.br +.BI " struct nvme_mi_vpd_ppmra ppmra;" +.br +.BI " struct nvme_mi_vpd_tra tmra;" +.br +.BI " };" +.br +.BI " +}; +.br + +.SH Members +.IP "type" 12 +NVMe Record Type ID +.IP "rf" 12 +Record Format +.IP "rlen" 12 +Record Length +.IP "rchksum" 12 +Record Checksum +.IP "hchksum" 12 +Header Checksum +.IP "{unnamed_union}" 12 +anonymous +.IP "nmra" 12 +NVMe MultiRecord Area +.IP "ppmra" 12 +NVMe PCIe Port MultiRecord Area +.IP "tmra" 12 +Topology MultiRecord Area diff --git a/doc/man/nvme_mi_vpd_mra.2 b/doc/man/nvme_mi_vpd_mra.2 new file mode 100644 index 0000000..6658d62 --- /dev/null +++ b/doc/man/nvme_mi_vpd_mra.2 @@ -0,0 +1,75 @@ +.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_vpd_mra \- +.SH SYNOPSIS +struct nvme_mi_vpd_mra { +.br +.BI " __u8 nmravn;" +.br +.BI " __u8 ff;" +.br +.BI " __u8 rsvd7[6];" +.br +.BI " __u8 i18vpwr;" +.br +.BI " __u8 m18vpwr;" +.br +.BI " __u8 i33vpwr;" +.br +.BI " __u8 m33vpwr;" +.br +.BI " __u8 rsvd17;" +.br +.BI " __u8 m33vapsr;" +.br +.BI " __u8 i5vapsr;" +.br +.BI " __u8 m5vapsr;" +.br +.BI " __u8 i12vapsr;" +.br +.BI " __u8 m12vapsr;" +.br +.BI " __u8 mtl;" +.br +.BI " __u8 tnvmcap[16];" +.br +.BI " __u8 rsvd37[27];" +.br +.BI " +}; +.br + +.SH Members +.IP "nmravn" 12 +NVMe MultiRecord Area Version Number +.IP "ff" 12 +Form Factor +.IP "rsvd7" 12 +Reserved +.IP "i18vpwr" 12 +Initial 1.8 V Power Supply Requirements +.IP "m18vpwr" 12 +Maximum 1.8 V Power Supply Requirements +.IP "i33vpwr" 12 +Initial 3.3 V Power Supply Requirements +.IP "m33vpwr" 12 +Maximum 3.3 V Power Supply Requirements +.IP "rsvd17" 12 +Reserved +.IP "m33vapsr" 12 +Maximum 3.3 V aux Power Supply Requirements +.IP "i5vapsr" 12 +Initial 5 V Power Supply Requirements +.IP "m5vapsr" 12 +Maximum 5 V Power Supply Requirements +.IP "i12vapsr" 12 +Initial 12 V Power Supply Requirements +.IP "m12vapsr" 12 +Maximum 12 V Power Supply Requirements +.IP "mtl" 12 +Maximum Thermal Load +.IP "tnvmcap" 12 +Total NVM Capacity +.IP "rsvd37" 12 +Reserved diff --git a/doc/man/nvme_mi_vpd_ppmra.2 b/doc/man/nvme_mi_vpd_ppmra.2 new file mode 100644 index 0000000..7e45525 --- /dev/null +++ b/doc/man/nvme_mi_vpd_ppmra.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_vpd_ppmra \- +.SH SYNOPSIS +struct nvme_mi_vpd_ppmra { +.br +.BI " __u8 nppmravn;" +.br +.BI " __u8 pn;" +.br +.BI " __u8 ppi;" +.br +.BI " __u8 ls;" +.br +.BI " __u8 mlw;" +.br +.BI " __u8 mctp;" +.br +.BI " __u8 refccap;" +.br +.BI " __u8 pi;" +.br +.BI " __u8 rsvd13[3];" +.br +.BI " +}; +.br + +.SH Members +.IP "nppmravn" 12 +NVMe PCIe Port MultiRecord Area Version Number +.IP "pn" 12 +PCIe Port Number +.IP "ppi" 12 +Port Information +.IP "ls" 12 +PCIe Link Speed +.IP "mlw" 12 +PCIe Maximum Link Width +.IP "mctp" 12 +MCTP Support +.IP "refccap" 12 +Ref Clk Capability +.IP "pi" 12 +Port Identifier +.IP "rsvd13" 12 +Reserved diff --git a/doc/man/nvme_mi_vpd_telem.2 b/doc/man/nvme_mi_vpd_telem.2 new file mode 100644 index 0000000..f7a754b --- /dev/null +++ b/doc/man/nvme_mi_vpd_telem.2 @@ -0,0 +1,28 @@ +.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_vpd_telem \- +.SH SYNOPSIS +struct nvme_mi_vpd_telem { +.br +.BI " __u8 type;" +.br +.BI " __u8 rev;" +.br +.BI " __u8 len;" +.br +.BI " __u8 data[0];" +.br +.BI " +}; +.br + +.SH Members +.IP "type" 12 +Type of the Element Descriptor +.IP "rev" 12 +Revision of the Element Descriptor +.IP "len" 12 +Number of bytes in the Element Descriptor +.IP "data" 12 +Type-specific information associated with +the Element Descriptor diff --git a/doc/man/nvme_mi_vpd_tra.2 b/doc/man/nvme_mi_vpd_tra.2 new file mode 100644 index 0000000..ed56dcd --- /dev/null +++ b/doc/man/nvme_mi_vpd_tra.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_vpd_tra \- +.SH SYNOPSIS +struct nvme_mi_vpd_tra { +.br +.BI " __u8 vn;" +.br +.BI " __u8 rsvd6;" +.br +.BI " __u8 ec;" +.br +.BI " struct nvme_mi_vpd_telem elems[0];" +.br +.BI " +}; +.br + +.SH Members +.IP "vn" 12 +Version Number +.IP "rsvd6" 12 +Reserved +.IP "ec" 12 +Element Count +.IP "elems" 12 +Element Descriptor diff --git a/doc/man/nvme_namespace_attach_ctrls.2 b/doc/man/nvme_namespace_attach_ctrls.2 new file mode 100644 index 0000000..22657bd --- /dev/null +++ b/doc/man/nvme_namespace_attach_ctrls.2 @@ -0,0 +1,21 @@ +.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_attach_ctrls \- Attach namespace to controller(s) +.SH SYNOPSIS +.B "int" nvme_namespace_attach_ctrls +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 num_ctrls " "," +.BI "__u16 *ctrlist " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID to attach +.IP "num_ctrls" 12 +Number of controllers in ctrlist +.IP "ctrlist" 12 +List of controller IDs to perform the attach action +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_namespace_detach_ctrls.2 b/doc/man/nvme_namespace_detach_ctrls.2 new file mode 100644 index 0000000..2d18cc5 --- /dev/null +++ b/doc/man/nvme_namespace_detach_ctrls.2 @@ -0,0 +1,21 @@ +.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_detach_ctrls \- Detach namespace from controller(s) +.SH SYNOPSIS +.B "int" nvme_namespace_detach_ctrls +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 num_ctrls " "," +.BI "__u16 *ctrlist " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID to detach +.IP "num_ctrls" 12 +Number of controllers in ctrlist +.IP "ctrlist" 12 +List of controller IDs to perform the detach action +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_namespace_filter.2 b/doc/man/nvme_namespace_filter.2 new file mode 100644 index 0000000..5536b95 --- /dev/null +++ b/doc/man/nvme_namespace_filter.2 @@ -0,0 +1,11 @@ +.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_filter \- Filter for namespaces +.SH SYNOPSIS +.B "int" nvme_namespace_filter +.BI "(const struct dirent *d " ");" +.SH ARGUMENTS +.IP "d" 12 +dirent to check +.SH "RETURN" +1 if \fId\fP matches, 0 otherwise diff --git a/doc/man/nvme_namespace_first_path.2 b/doc/man/nvme_namespace_first_path.2 new file mode 100644 index 0000000..faaace8 --- /dev/null +++ b/doc/man/nvme_namespace_first_path.2 @@ -0,0 +1,11 @@ +.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_first_path \- Start path iterator +.SH SYNOPSIS +.B "nvme_path_t" nvme_namespace_first_path +.BI "(nvme_ns_t ns " ");" +.SH ARGUMENTS +.IP "ns" 12 +Namespace instance +.SH "RETURN" +First \fInvme_path_t\fP object of an \fIns\fP iterator diff --git a/doc/man/nvme_namespace_for_each_path.2 b/doc/man/nvme_namespace_for_each_path.2 new file mode 100644 index 0000000..c86bb59 --- /dev/null +++ b/doc/man/nvme_namespace_for_each_path.2 @@ -0,0 +1,12 @@ +.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_for_each_path \- Traverse paths +.SH SYNOPSIS +.B "nvme_namespace_for_each_path +.BI "(c " "," +.BI "p " ");" +.SH ARGUMENTS +.IP "c" 12 +-- undescribed -- +.IP "p" 12 +\fInvme_path_t\fP object diff --git a/doc/man/nvme_namespace_for_each_path_safe.2 b/doc/man/nvme_namespace_for_each_path_safe.2 new file mode 100644 index 0000000..9202a27 --- /dev/null +++ b/doc/man/nvme_namespace_for_each_path_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_for_each_path_safe \- Traverse paths +.SH SYNOPSIS +.B "nvme_namespace_for_each_path_safe +.BI "(n " "," +.BI "p " "," +.BI "_p " ");" +.SH ARGUMENTS +.IP "n" 12 +-- undescribed -- +.IP "p" 12 +\fInvme_path_t\fP object +.IP "_p" 12 +A \fInvme_path_t_node\fP to use as temporary storage diff --git a/doc/man/nvme_namespace_next_path.2 b/doc/man/nvme_namespace_next_path.2 new file mode 100644 index 0000000..a380df3 --- /dev/null +++ b/doc/man/nvme_namespace_next_path.2 @@ -0,0 +1,14 @@ +.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_namespace_next_path \- Next path iterator +.SH SYNOPSIS +.B "nvme_path_t" nvme_namespace_next_path +.BI "(nvme_ns_t c " "," +.BI "nvme_path_t p " ");" +.SH ARGUMENTS +.IP "c" 12 +-- undescribed -- +.IP "p" 12 +Previous \fInvme_path_t\fP object of an \fIns\fP iterator +.SH "RETURN" +Next \fInvme_path_t\fP object of an \fIns\fP iterator diff --git a/doc/man/nvme_nd_ns_fpi.2 b/doc/man/nvme_nd_ns_fpi.2 new file mode 100644 index 0000000..b3dfa5b --- /dev/null +++ b/doc/man/nvme_nd_ns_fpi.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_nd_ns_fpi \- If a format operation is in progress, this field indicates the percentage of the namespace that remains to be formatted. +.SH SYNOPSIS +enum nvme_nd_ns_fpi { +.br +.BI " NVME_NS_FPI_REMAINING" +, +.br +.br +.BI " NVME_NS_FPI_SUPPORTED" + +}; +.SH Constants +.IP "NVME_NS_FPI_REMAINING" 12 +Mask to get the format percent remaining value +.IP "NVME_NS_FPI_SUPPORTED" 12 +If set, indicates that the namespace supports the +Format Progress Indicator defined for the field. diff --git a/doc/man/nvme_next_host.2 b/doc/man/nvme_next_host.2 new file mode 100644 index 0000000..39cbf31 --- /dev/null +++ b/doc/man/nvme_next_host.2 @@ -0,0 +1,14 @@ +.TH "nvme_next_host" 9 "nvme_next_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_next_host \- Next host iterator +.SH SYNOPSIS +.B "nvme_host_t" nvme_next_host +.BI "(nvme_root_t r " "," +.BI "nvme_host_t h " ");" +.SH ARGUMENTS +.IP "r" 12 +\fInvme_root_t\fP object +.IP "h" 12 +Previous \fInvme_host_t\fP iterator +.SH "RETURN" +Next \fInvme_host_t\fP object in an iterator diff --git a/doc/man/nvme_next_subsystem.2 b/doc/man/nvme_next_subsystem.2 new file mode 100644 index 0000000..d6a0b32 --- /dev/null +++ b/doc/man/nvme_next_subsystem.2 @@ -0,0 +1,14 @@ +.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_next_subsystem \- Next subsystem iterator +.SH SYNOPSIS +.B "nvme_subsystem_t" nvme_next_subsystem +.BI "(nvme_host_t h " "," +.BI "nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "h" 12 +\fInvme_host_t\fP object +.IP "s" 12 +Previous \fInvme_subsystem_t\fP iterator +.SH "RETURN" +next \fInvme_subsystem_t\fP object in an iterator diff --git a/doc/man/nvme_ns_attach.2 b/doc/man/nvme_ns_attach.2 new file mode 100644 index 0000000..806998c --- /dev/null +++ b/doc/man/nvme_ns_attach.2 @@ -0,0 +1,9 @@ +.TH "nvme_ns_attach" 9 "nvme_ns_attach" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_attach \- Attach or detach namespace to controller(s) +.SH SYNOPSIS +.B "int" nvme_ns_attach +.BI "(struct nvme_ns_attach_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_ns_attach_args\fP Argument structure diff --git a/doc/man/nvme_ns_attach_args.2 b/doc/man/nvme_ns_attach_args.2 new file mode 100644 index 0000000..00f2d14 --- /dev/null +++ b/doc/man/nvme_ns_attach_args.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_ns_attach_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ns_attach_args \- Arguments for Nvme Namespace Management command +.SH SYNOPSIS +struct nvme_ns_attach_args { +.br +.BI " __u32 *result;" +.br +.BI " struct nvme_ctrl_list *ctrlist;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_ns_attach_sel sel;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +NVMe command result +.IP "ctrlist" 12 +Controller list to modify attachment state of nsid +.IP "args_size" 12 +Size of \fIstruct nvme_ns_attach_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID to execute attach selection +.IP "sel" 12 +Attachment selection, see \fIenum nvme_ns_attach_sel\fP diff --git a/doc/man/nvme_ns_attach_ctrls.2 b/doc/man/nvme_ns_attach_ctrls.2 new file mode 100644 index 0000000..b28ddb3 --- /dev/null +++ b/doc/man/nvme_ns_attach_ctrls.2 @@ -0,0 +1,15 @@ +.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_attach_ctrls \- +.SH SYNOPSIS +.B "int" nvme_ns_attach_ctrls +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_ctrl_list *ctrlist " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID to attach +.IP "ctrlist" 12 +Controller list to modify attachment state of nsid diff --git a/doc/man/nvme_ns_attach_sel.2 b/doc/man/nvme_ns_attach_sel.2 new file mode 100644 index 0000000..b3e0386 --- /dev/null +++ b/doc/man/nvme_ns_attach_sel.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_ns_attach_sel" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ns_attach_sel \- +.SH SYNOPSIS +enum nvme_ns_attach_sel { +.br +.BI " NVME_NS_ATTACH_SEL_CTRL_ATTACH" +, +.br +.br +.BI " NVME_NS_ATTACH_SEL_CTRL_DEATTACH" + +}; +.SH Constants +.IP "NVME_NS_ATTACH_SEL_CTRL_ATTACH" 12 +Namespace attach selection +.IP "NVME_NS_ATTACH_SEL_CTRL_DEATTACH" 12 +Namespace detach selection diff --git a/doc/man/nvme_ns_compare.2 b/doc/man/nvme_ns_compare.2 new file mode 100644 index 0000000..0c1d267 --- /dev/null +++ b/doc/man/nvme_ns_compare.2 @@ -0,0 +1,20 @@ +.TH "nvme_ns_compare" 9 "nvme_ns_compare" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_compare \- Compare data on a namespace +.SH SYNOPSIS +.B "int" nvme_ns_compare +.BI "(nvme_ns_t n " "," +.BI "void *buf " "," +.BI "off_t offset " "," +.BI "size_t count " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "buf" 12 +Buffer with data to be compared +.IP "offset" 12 +LBA offset of \fIn\fP +.IP "count" 12 +Number of sectors in \fIbuf\fP +.SH "RETURN" +Number of sectors compared diff --git a/doc/man/nvme_ns_detach_ctrls.2 b/doc/man/nvme_ns_detach_ctrls.2 new file mode 100644 index 0000000..28ea6f3 --- /dev/null +++ b/doc/man/nvme_ns_detach_ctrls.2 @@ -0,0 +1,15 @@ +.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_detach_ctrls \- +.SH SYNOPSIS +.B "int" nvme_ns_detach_ctrls +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_ctrl_list *ctrlist " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID to detach +.IP "ctrlist" 12 +Controller list to modify attachment state of nsid diff --git a/doc/man/nvme_ns_flush.2 b/doc/man/nvme_ns_flush.2 new file mode 100644 index 0000000..c7cab3a --- /dev/null +++ b/doc/man/nvme_ns_flush.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_flush" 9 "nvme_ns_flush" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_flush \- Flush data to a namespace +.SH SYNOPSIS +.B "int" nvme_ns_flush +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +0 on success, -1 on error. diff --git a/doc/man/nvme_ns_get_csi.2 b/doc/man/nvme_ns_get_csi.2 new file mode 100644 index 0000000..b8ba92f --- /dev/null +++ b/doc/man/nvme_ns_get_csi.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_csi \- Command set identifier of a namespace +.SH SYNOPSIS +.B "enum nvme_csi" nvme_ns_get_csi +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +The namespace's command set identifier in use diff --git a/doc/man/nvme_ns_get_ctrl.2 b/doc/man/nvme_ns_get_ctrl.2 new file mode 100644 index 0000000..fb3467c --- /dev/null +++ b/doc/man/nvme_ns_get_ctrl.2 @@ -0,0 +1,13 @@ +.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_ctrl \- &nvme_ctrl_t of a namespace +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_ns_get_ctrl +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "DESCRIPTION" +nvme_ctrl_t object may be NULL for a multipathed namespace +.SH "RETURN" +nvme_ctrl_t object of \fIn\fP if present diff --git a/doc/man/nvme_ns_get_fd.2 b/doc/man/nvme_ns_get_fd.2 new file mode 100644 index 0000000..95c199e --- /dev/null +++ b/doc/man/nvme_ns_get_fd.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_fd \- Get associated filedescriptor +.SH SYNOPSIS +.B "int" nvme_ns_get_fd +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +File descriptor associated with \fIn\fP or -1 diff --git a/doc/man/nvme_ns_get_firmware.2 b/doc/man/nvme_ns_get_firmware.2 new file mode 100644 index 0000000..cc721c7 --- /dev/null +++ b/doc/man/nvme_ns_get_firmware.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_firmware \- Firmware string of a namespace +.SH SYNOPSIS +.B "const char *" nvme_ns_get_firmware +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +Firmware string of \fIn\fP diff --git a/doc/man/nvme_ns_get_generic_name.2 b/doc/man/nvme_ns_get_generic_name.2 new file mode 100644 index 0000000..58176ca --- /dev/null +++ b/doc/man/nvme_ns_get_generic_name.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_generic_name \- Returns name of generic namespace chardev. +.SH SYNOPSIS +.B "const char *" nvme_ns_get_generic_name +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +Name of generic namespace chardev diff --git a/doc/man/nvme_ns_get_lba_count.2 b/doc/man/nvme_ns_get_lba_count.2 new file mode 100644 index 0000000..7d3c172 --- /dev/null +++ b/doc/man/nvme_ns_get_lba_count.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_lba_count \- LBA count of a namespace +.SH SYNOPSIS +.B "uint64_t" nvme_ns_get_lba_count +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +LBA count of \fIn\fP diff --git a/doc/man/nvme_ns_get_lba_size.2 b/doc/man/nvme_ns_get_lba_size.2 new file mode 100644 index 0000000..62f3850 --- /dev/null +++ b/doc/man/nvme_ns_get_lba_size.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_lba_size \- LBA size of a namespace +.SH SYNOPSIS +.B "int" nvme_ns_get_lba_size +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +LBA size of \fIn\fP diff --git a/doc/man/nvme_ns_get_lba_util.2 b/doc/man/nvme_ns_get_lba_util.2 new file mode 100644 index 0000000..52eac40 --- /dev/null +++ b/doc/man/nvme_ns_get_lba_util.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_lba_util \- LBA utilisation of a namespace +.SH SYNOPSIS +.B "uint64_t" nvme_ns_get_lba_util +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +LBA utilisation of \fIn\fP diff --git a/doc/man/nvme_ns_get_meta_size.2 b/doc/man/nvme_ns_get_meta_size.2 new file mode 100644 index 0000000..7cd756a --- /dev/null +++ b/doc/man/nvme_ns_get_meta_size.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_meta_size \- Metadata size of a namespace +.SH SYNOPSIS +.B "int" nvme_ns_get_meta_size +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +Metadata size of \fIn\fP diff --git a/doc/man/nvme_ns_get_model.2 b/doc/man/nvme_ns_get_model.2 new file mode 100644 index 0000000..3ca02f4 --- /dev/null +++ b/doc/man/nvme_ns_get_model.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_model \- Model of a namespace +.SH SYNOPSIS +.B "const char *" nvme_ns_get_model +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +Model string of \fIn\fP diff --git a/doc/man/nvme_ns_get_name.2 b/doc/man/nvme_ns_get_name.2 new file mode 100644 index 0000000..d4cf500 --- /dev/null +++ b/doc/man/nvme_ns_get_name.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_name \- sysfs name of a namespace +.SH SYNOPSIS +.B "const char *" nvme_ns_get_name +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +sysfs name of \fIn\fP diff --git a/doc/man/nvme_ns_get_nguid.2 b/doc/man/nvme_ns_get_nguid.2 new file mode 100644 index 0000000..43bb47c --- /dev/null +++ b/doc/man/nvme_ns_get_nguid.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_nguid \- 128-bit nguid of a namespace +.SH SYNOPSIS +.B "const uint8_t *" nvme_ns_get_nguid +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +A pointer to the 128-bit nguid diff --git a/doc/man/nvme_ns_get_nsid.2 b/doc/man/nvme_ns_get_nsid.2 new file mode 100644 index 0000000..2904471 --- /dev/null +++ b/doc/man/nvme_ns_get_nsid.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_nsid \- NSID of a namespace +.SH SYNOPSIS +.B "int" nvme_ns_get_nsid +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +NSID of \fIn\fP diff --git a/doc/man/nvme_ns_get_serial.2 b/doc/man/nvme_ns_get_serial.2 new file mode 100644 index 0000000..cafedd7 --- /dev/null +++ b/doc/man/nvme_ns_get_serial.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_serial \- Serial number of a namespace +.SH SYNOPSIS +.B "const char *" nvme_ns_get_serial +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +Serial number string of \fIn\fP diff --git a/doc/man/nvme_ns_get_subsystem.2 b/doc/man/nvme_ns_get_subsystem.2 new file mode 100644 index 0000000..b9404ad --- /dev/null +++ b/doc/man/nvme_ns_get_subsystem.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_subsystem \- &nvme_subsystem_t of a namespace +.SH SYNOPSIS +.B "nvme_subsystem_t" nvme_ns_get_subsystem +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +nvme_subsystem_t object of \fIn\fP diff --git a/doc/man/nvme_ns_get_sysfs_dir.2 b/doc/man/nvme_ns_get_sysfs_dir.2 new file mode 100644 index 0000000..5ff53f5 --- /dev/null +++ b/doc/man/nvme_ns_get_sysfs_dir.2 @@ -0,0 +1,11 @@ +.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_sysfs_dir \- sysfs directory of a namespace +.SH SYNOPSIS +.B "const char *" nvme_ns_get_sysfs_dir +.BI "(nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.SH "RETURN" +sysfs directory name of \fIn\fP diff --git a/doc/man/nvme_ns_get_uuid.2 b/doc/man/nvme_ns_get_uuid.2 new file mode 100644 index 0000000..ee0c607 --- /dev/null +++ b/doc/man/nvme_ns_get_uuid.2 @@ -0,0 +1,14 @@ +.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_get_uuid \- UUID of a namespace +.SH SYNOPSIS +.B "void" nvme_ns_get_uuid +.BI "(nvme_ns_t n " "," +.BI "uuid_t out " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "out" 12 +buffer for the UUID +.SH "DESCRIPTION" +Copies the namespace's uuid into \fIout\fP diff --git a/doc/man/nvme_ns_id_desc.2 b/doc/man/nvme_ns_id_desc.2 new file mode 100644 index 0000000..2116046 --- /dev/null +++ b/doc/man/nvme_ns_id_desc.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "struct nvme_ns_id_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ns_id_desc \- +.SH SYNOPSIS +struct nvme_ns_id_desc { +.br +.BI " __u8 nidt;" +.br +.BI " __u8 nidl;" +.br +.BI " __le16 rsvd;" +.br +.BI " __u8 nid[];" +.br +.BI " +}; +.br + +.SH Members +.IP "nidt" 12 +Namespace Identifier Type, see \fIenum nvme_ns_id_desc_nidt\fP +.IP "nidl" 12 +Namespace Identifier Length contains the length in bytes of the +\fIstruct nvme_id_ns\fP.nid. +.IP "rsvd" 12 +Reserved +.IP "nid" 12 +Namespace Identifier contains a value that is globally unique and +assigned to the namespace when the namespace is created. The length +is defined in \fIstruct nvme_id_ns\fP.nidl. diff --git a/doc/man/nvme_ns_id_desc_nidt.2 b/doc/man/nvme_ns_id_desc_nidt.2 new file mode 100644 index 0000000..eb399b1 --- /dev/null +++ b/doc/man/nvme_ns_id_desc_nidt.2 @@ -0,0 +1,33 @@ +.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ns_id_desc_nidt \- Known namespace identifier types +.SH SYNOPSIS +enum nvme_ns_id_desc_nidt { +.br +.BI " NVME_NIDT_EUI64" +, +.br +.br +.BI " NVME_NIDT_NGUID" +, +.br +.br +.BI " NVME_NIDT_UUID" +, +.br +.br +.BI " NVME_NIDT_CSI" + +}; +.SH Constants +.IP "NVME_NIDT_EUI64" 12 +IEEE Extended Unique Identifier, the NID field contains a +copy of the EUI64 field in the struct nvme_id_ns.eui64. +.IP "NVME_NIDT_NGUID" 12 +Namespace Globally Unique Identifier, the NID field +contains a copy of the NGUID field in struct nvme_id_ns.nguid. +.IP "NVME_NIDT_UUID" 12 +The NID field contains a 128-bit Universally Unique +Identifier (UUID) as specified in RFC 4122. +.IP "NVME_NIDT_CSI" 12 +The NID field contains the command set indentifier. diff --git a/doc/man/nvme_ns_identify.2 b/doc/man/nvme_ns_identify.2 new file mode 100644 index 0000000..0aa1e53 --- /dev/null +++ b/doc/man/nvme_ns_identify.2 @@ -0,0 +1,17 @@ +.TH "nvme_ns_identify" 9 "nvme_ns_identify" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_identify \- Issue an 'identify namespace' command +.SH SYNOPSIS +.B "int" nvme_ns_identify +.BI "(nvme_ns_t n " "," +.BI "struct nvme_id_ns *ns " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "ns" 12 +\fInvme_id_ns\fP buffer +.SH "DESCRIPTION" +Writes the data returned by the 'identify namespace' command +into \fIns\fP. +.SH "RETURN" +0 on success, -1 on error. diff --git a/doc/man/nvme_ns_identify_descs.2 b/doc/man/nvme_ns_identify_descs.2 new file mode 100644 index 0000000..e7a8e68 --- /dev/null +++ b/doc/man/nvme_ns_identify_descs.2 @@ -0,0 +1,17 @@ +.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_identify_descs \- Issue an 'identify descriptors' command +.SH SYNOPSIS +.B "int" nvme_ns_identify_descs +.BI "(nvme_ns_t n " "," +.BI "struct nvme_ns_id_desc *descs " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "descs" 12 +List of identify descriptors +.SH "DESCRIPTION" +Writes the data returned by the 'identify descriptors' command +into \fIdescs\fP. +.SH "RETURN" +0 on success, -1 on error. diff --git a/doc/man/nvme_ns_list.2 b/doc/man/nvme_ns_list.2 new file mode 100644 index 0000000..92943a0 --- /dev/null +++ b/doc/man/nvme_ns_list.2 @@ -0,0 +1,15 @@ +.TH "libnvme" 9 "struct nvme_ns_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ns_list \- +.SH SYNOPSIS +struct nvme_ns_list { +.br +.BI " __le32 ns[NVME_ID_NS_LIST_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "ns" 12 +Namespace Identifier diff --git a/doc/man/nvme_ns_metadata_type.2 b/doc/man/nvme_ns_metadata_type.2 new file mode 100644 index 0000000..7de5c2d --- /dev/null +++ b/doc/man/nvme_ns_metadata_type.2 @@ -0,0 +1,34 @@ +.TH "libnvme" 9 "enum nvme_ns_metadata_type" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ns_metadata_type \- Namespace Metadata Element Types +.SH SYNOPSIS +enum nvme_ns_metadata_type { +.br +.BI " NVME_NS_METADATA_OS_NS_NAME" +, +.br +.br +.BI " NVME_NS_METADATA_PRE_BOOT_NS_NAME" +, +.br +.br +.BI " NVME_NS_METADATA_OS_NS_QUAL_1" +, +.br +.br +.BI " NVME_NS_METADATA_OS_NS_QUAL_2" + +}; +.SH Constants +.IP "NVME_NS_METADATA_OS_NS_NAME" 12 +Name of the namespace in the the +operating system +.IP "NVME_NS_METADATA_PRE_BOOT_NS_NAME" 12 +Name of the namespace in the pre-boot +environment. +.IP "NVME_NS_METADATA_OS_NS_QUAL_1" 12 +First qualifier of the Operating System +Namespace Name. +.IP "NVME_NS_METADATA_OS_NS_QUAL_2" 12 +Second qualifier of the Operating System +Namespace Name. diff --git a/doc/man/nvme_ns_mgmt.2 b/doc/man/nvme_ns_mgmt.2 new file mode 100644 index 0000000..8916910 --- /dev/null +++ b/doc/man/nvme_ns_mgmt.2 @@ -0,0 +1,9 @@ +.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_mgmt \- Issue a Namespace management command +.SH SYNOPSIS +.B "int" nvme_ns_mgmt +.BI "(struct nvme_ns_mgmt_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_ns_mgmt_args\fP Argument structure diff --git a/doc/man/nvme_ns_mgmt_args.2 b/doc/man/nvme_ns_mgmt_args.2 new file mode 100644 index 0000000..9231c78 --- /dev/null +++ b/doc/man/nvme_ns_mgmt_args.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "struct nvme_ns_mgmt_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_ns_mgmt_args \- Arguments for NVMe Namespace Management command +.SH SYNOPSIS +struct nvme_ns_mgmt_args { +.br +.BI " __u32 *result;" +.br +.BI " struct nvme_id_ns *ns;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_ns_mgmt_sel sel;" +.br +.BI " __u8 csi;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +NVMe command result +.IP "ns" 12 +Namespace identication descriptors +.IP "args_size" 12 +Size of \fIstruct nvme_ns_mgmt_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "sel" 12 +Type of management operation to perform +.IP "csi" 12 +Command Set Identifier diff --git a/doc/man/nvme_ns_mgmt_create.2 b/doc/man/nvme_ns_mgmt_create.2 new file mode 100644 index 0000000..479d146 --- /dev/null +++ b/doc/man/nvme_ns_mgmt_create.2 @@ -0,0 +1,29 @@ +.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_mgmt_create \- +.SH SYNOPSIS +.B "int" nvme_ns_mgmt_create +.BI "(int fd " "," +.BI "struct nvme_id_ns *ns " "," +.BI "__u32 *nsid " "," +.BI "__u32 timeout " "," +.BI "__u8 csi " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "ns" 12 +Namespace identification that defines ns creation parameters +.IP "nsid" 12 +On success, set to the namespace id that was created +.IP "timeout" 12 +Overide the default timeout to this value in milliseconds; +set to 0 to use the system default. +.IP "csi" 12 +Command Set Identifier +.SH "DESCRIPTION" +On successful creation, the namespace exists in the subsystem, but is not +attached to any controller. Use the \fBnvme_ns_attach_ctrls\fP to assign the +namespace to one or more controllers. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_mgmt_delete.2 b/doc/man/nvme_ns_mgmt_delete.2 new file mode 100644 index 0000000..dcbf3f0 --- /dev/null +++ b/doc/man/nvme_ns_mgmt_delete.2 @@ -0,0 +1,19 @@ +.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_mgmt_delete \- +.SH SYNOPSIS +.B "int" nvme_ns_mgmt_delete +.BI "(int fd " "," +.BI "__u32 nsid " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace identifier to delete +.SH "DESCRIPTION" +It is recommended that a namespace being deleted is not attached to any +controller. Use the \fBnvme_ns_detach_ctrls\fP first if the namespace is still +attached. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_mgmt_sel.2 b/doc/man/nvme_ns_mgmt_sel.2 new file mode 100644 index 0000000..8683f3b --- /dev/null +++ b/doc/man/nvme_ns_mgmt_sel.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ns_mgmt_sel \- +.SH SYNOPSIS +enum nvme_ns_mgmt_sel { +.br +.BI " NVME_NS_MGMT_SEL_CREATE" +, +.br +.br +.BI " NVME_NS_MGMT_SEL_DELETE" + +}; +.SH Constants +.IP "NVME_NS_MGMT_SEL_CREATE" 12 +Namespace Create selection +.IP "NVME_NS_MGMT_SEL_DELETE" 12 +Namespace Delete selection diff --git a/doc/man/nvme_ns_read.2 b/doc/man/nvme_ns_read.2 new file mode 100644 index 0000000..b6d8441 --- /dev/null +++ b/doc/man/nvme_ns_read.2 @@ -0,0 +1,20 @@ +.TH "nvme_ns_read" 9 "nvme_ns_read" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_read \- Read from a namespace +.SH SYNOPSIS +.B "int" nvme_ns_read +.BI "(nvme_ns_t n " "," +.BI "void *buf " "," +.BI "off_t offset " "," +.BI "size_t count " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "buf" 12 +Buffer into which the data will be transferred +.IP "offset" 12 +LBA offset of \fIn\fP +.IP "count" 12 +Number of sectors in \fIbuf\fP +.SH "RETURN" +Number of sectors read or -1 on error. diff --git a/doc/man/nvme_ns_rescan.2 b/doc/man/nvme_ns_rescan.2 new file mode 100644 index 0000000..c0334d3 --- /dev/null +++ b/doc/man/nvme_ns_rescan.2 @@ -0,0 +1,13 @@ +.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_rescan \- Initiate a controller rescan +.SH SYNOPSIS +.B "int" nvme_ns_rescan +.BI "(int fd " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.SH "DESCRIPTION" +This should only be sent to controller handles, not to namespaces. +.SH "RETURN" +0 if a rescan was initiated or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_verify.2 b/doc/man/nvme_ns_verify.2 new file mode 100644 index 0000000..1f669ad --- /dev/null +++ b/doc/man/nvme_ns_verify.2 @@ -0,0 +1,17 @@ +.TH "nvme_ns_verify" 9 "nvme_ns_verify" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_verify \- Verify data on a namespace +.SH SYNOPSIS +.B "int" nvme_ns_verify +.BI "(nvme_ns_t n " "," +.BI "off_t offset " "," +.BI "size_t count " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "offset" 12 +LBA offset of \fIn\fP +.IP "count" 12 +Number of sectors to be verified +.SH "RETURN" +Number of sectors verified diff --git a/doc/man/nvme_ns_write.2 b/doc/man/nvme_ns_write.2 new file mode 100644 index 0000000..132ea2c --- /dev/null +++ b/doc/man/nvme_ns_write.2 @@ -0,0 +1,20 @@ +.TH "nvme_ns_write" 9 "nvme_ns_write" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_write \- Write to a namespace +.SH SYNOPSIS +.B "int" nvme_ns_write +.BI "(nvme_ns_t n " "," +.BI "void *buf " "," +.BI "off_t offset " "," +.BI "size_t count " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "buf" 12 +Buffer with data to be written +.IP "offset" 12 +LBA offset of \fIn\fP +.IP "count" 12 +Number of sectors in \fIbuf\fP +.SH "RETURN" +Number of sectors written or -1 on error diff --git a/doc/man/nvme_ns_write_protect_cfg.2 b/doc/man/nvme_ns_write_protect_cfg.2 new file mode 100644 index 0000000..5a8dc11 --- /dev/null +++ b/doc/man/nvme_ns_write_protect_cfg.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_ns_write_protect_cfg \- +.SH SYNOPSIS +enum nvme_ns_write_protect_cfg { +.br +.BI " NVME_NS_WP_CFG_NONE" +, +.br +.br +.BI " NVME_NS_WP_CFG_PROTECT" +, +.br +.br +.BI " NVME_NS_WP_CFG_PROTECT_POWER_CYCLE" +, +.br +.br +.BI " NVME_NS_WP_CFG_PROTECT_PERMANENT" + +}; +.SH Constants +.IP "NVME_NS_WP_CFG_NONE" 12 +No Write Protect +.IP "NVME_NS_WP_CFG_PROTECT" 12 +Write Protect +.IP "NVME_NS_WP_CFG_PROTECT_POWER_CYCLE" 12 +Write Protect Until Power Cycle +.IP "NVME_NS_WP_CFG_PROTECT_PERMANENT" 12 +Permanent Write Protect diff --git a/doc/man/nvme_ns_write_uncorrectable.2 b/doc/man/nvme_ns_write_uncorrectable.2 new file mode 100644 index 0000000..b6de816 --- /dev/null +++ b/doc/man/nvme_ns_write_uncorrectable.2 @@ -0,0 +1,17 @@ +.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_write_uncorrectable \- Issus a 'write uncorrectable' command +.SH SYNOPSIS +.B "int" nvme_ns_write_uncorrectable +.BI "(nvme_ns_t n " "," +.BI "off_t offset " "," +.BI "size_t count " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "offset" 12 +LBA offset in \fIn\fP +.IP "count" 12 +Number of sectors to be written +.SH "RETURN" +Number of sectors written diff --git a/doc/man/nvme_ns_write_zeros.2 b/doc/man/nvme_ns_write_zeros.2 new file mode 100644 index 0000000..ee2c2d1 --- /dev/null +++ b/doc/man/nvme_ns_write_zeros.2 @@ -0,0 +1,17 @@ +.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_ns_write_zeros \- Write zeros to a namespace +.SH SYNOPSIS +.B "int" nvme_ns_write_zeros +.BI "(nvme_ns_t n " "," +.BI "off_t offset " "," +.BI "size_t count " ");" +.SH ARGUMENTS +.IP "n" 12 +Namespace instance +.IP "offset" 12 +LBA offset in \fIn\fP +.IP "count" 12 +Number of sectors to be written +.SH "RETURN" +Number of sectors written diff --git a/doc/man/nvme_nss_hw_err_event.2 b/doc/man/nvme_nss_hw_err_event.2 new file mode 100644 index 0000000..a64966e --- /dev/null +++ b/doc/man/nvme_nss_hw_err_event.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_nss_hw_err_event \- +.SH SYNOPSIS +struct nvme_nss_hw_err_event { +.br +.BI " __le16 nss_hw_err_event_code;" +.br +.BI " __u8 rsvd2[2];" +.br +.BI " __u8 *add_hw_err_info;" +.br +.BI " +}; +.br + +.SH Members +.IP "nss_hw_err_event_code" 12 +NVM Subsystem Hardware Error Event Code +.IP "rsvd2" 12 +Reserved +.IP "add_hw_err_info" 12 +Additional Hardware Error Information diff --git a/doc/man/nvme_nvm_id_ns.2 b/doc/man/nvme_nvm_id_ns.2 new file mode 100644 index 0000000..13dae13 --- /dev/null +++ b/doc/man/nvme_nvm_id_ns.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_nvm_id_ns" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_nvm_id_ns \- +.SH SYNOPSIS +struct nvme_nvm_id_ns { +.br +.BI " __le64 lbstm;" +.br +.BI " __u8 pic;" +.br +.BI " __u8 rsvd9[3];" +.br +.BI " __le32 elbaf[64];" +.br +.BI " __u8 rsvd268[3828];" +.br +.BI " +}; +.br + +.SH Members +.IP "lbstm" 12 +Logical Block Storage Tag Mask +.IP "pic" 12 +Protection Information Capabilities +.IP "rsvd9" 12 +Reserved +.IP "elbaf" 12 +List of Extended LBA Format Support +.IP "rsvd268" 12 +Reserved diff --git a/doc/man/nvme_nvm_identify_ctrl.2 b/doc/man/nvme_nvm_identify_ctrl.2 new file mode 100644 index 0000000..313368a --- /dev/null +++ b/doc/man/nvme_nvm_identify_ctrl.2 @@ -0,0 +1,18 @@ +.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_nvm_identify_ctrl \- Identify controller data +.SH SYNOPSIS +.B "int" nvme_nvm_identify_ctrl +.BI "(int fd " "," +.BI "struct nvme_id_ctrl_nvm *id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "id" 12 +User space destination address to transfer the data +.SH "DESCRIPTION" +Return an identify controller data structure to the host of +processing controller. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_nvmeset_pl_status.2 b/doc/man/nvme_nvmeset_pl_status.2 new file mode 100644 index 0000000..3c224b4 --- /dev/null +++ b/doc/man/nvme_nvmeset_pl_status.2 @@ -0,0 +1,21 @@ +.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_nvmeset_pl_status \- +.SH SYNOPSIS +enum nvme_nvmeset_pl_status { +.br +.BI " NVME_NVMSET_PL_STATUS_DISABLED" +, +.br +.br +.BI " NVME_NVMSET_PL_STATUS_DTWIN" +, +.br +.br +.BI " NVME_NVMSET_PL_STATUS_NDWIN" + +}; +.SH Constants +.IP "NVME_NVMSET_PL_STATUS_DISABLED" 12 +.IP "NVME_NVMSET_PL_STATUS_DTWIN" 12 +.IP "NVME_NVMSET_PL_STATUS_NDWIN" 12 diff --git a/doc/man/nvme_nvmset_attr.2 b/doc/man/nvme_nvmset_attr.2 new file mode 100644 index 0000000..450378c --- /dev/null +++ b/doc/man/nvme_nvmset_attr.2 @@ -0,0 +1,46 @@ +.TH "libnvme" 9 "struct nvme_nvmset_attr" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_nvmset_attr \- NVM Set Attributes Entry +.SH SYNOPSIS +struct nvme_nvmset_attr { +.br +.BI " __le16 nvmsetid;" +.br +.BI " __le16 endgid;" +.br +.BI " __u8 rsvd4[4];" +.br +.BI " __le32 rr4kt;" +.br +.BI " __le32 ows;" +.br +.BI " __u8 tnvmsetcap[16];" +.br +.BI " __u8 unvmsetcap[16];" +.br +.BI " __u8 rsvd48[80];" +.br +.BI " +}; +.br + +.SH Members +.IP "nvmsetid" 12 +NVM Set Identifier +.IP "endgid" 12 +Endurance Group Identifier +.IP "rsvd4" 12 +Reserved +.IP "rr4kt" 12 +Random 4 KiB Read Typical indicates the typical +time to complete a 4 KiB random read in 100 nanosecond units +when the NVM Set is in a Predictable Latency Mode Deterministic +Window and there is 1 outstanding command per NVM Set. +.IP "ows" 12 +Optimal Write Size +.IP "tnvmsetcap" 12 +Total NVM Set Capacity +.IP "unvmsetcap" 12 +Unallocated NVM Set Capacity +.IP "rsvd48" 12 +Reserved diff --git a/doc/man/nvme_nvmset_pl_events.2 b/doc/man/nvme_nvmset_pl_events.2 new file mode 100644 index 0000000..36fe819 --- /dev/null +++ b/doc/man/nvme_nvmset_pl_events.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_nvmset_pl_events \- +.SH SYNOPSIS +enum nvme_nvmset_pl_events { +.br +.BI " NVME_NVMSET_PL_EVENT_DTWIN_READ_WARN" +, +.br +.br +.BI " NVME_NVMSET_PL_EVENT_DTWIN_WRITE_WARN" +, +.br +.br +.BI " NVME_NVMSET_PL_EVENT_DTWIN_TIME_WARN" +, +.br +.br +.BI " NVME_NVMSET_PL_EVENT_DTWIN_EXCEEDED" +, +.br +.br +.BI " NVME_NVMSET_PL_EVENT_DTWIN_EXCURSION" + +}; +.SH Constants +.IP "NVME_NVMSET_PL_EVENT_DTWIN_READ_WARN" 12 +.IP "NVME_NVMSET_PL_EVENT_DTWIN_WRITE_WARN" 12 +.IP "NVME_NVMSET_PL_EVENT_DTWIN_TIME_WARN" 12 +.IP "NVME_NVMSET_PL_EVENT_DTWIN_EXCEEDED" 12 +.IP "NVME_NVMSET_PL_EVENT_DTWIN_EXCURSION" 12 diff --git a/doc/man/nvme_nvmset_predictable_lat_log.2 b/doc/man/nvme_nvmset_predictable_lat_log.2 new file mode 100644 index 0000000..172bdce --- /dev/null +++ b/doc/man/nvme_nvmset_predictable_lat_log.2 @@ -0,0 +1,67 @@ +.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_nvmset_predictable_lat_log \- +.SH SYNOPSIS +struct nvme_nvmset_predictable_lat_log { +.br +.BI " __u8 status;" +.br +.BI " __u8 rsvd1;" +.br +.BI " __le16 event_type;" +.br +.BI " __u8 rsvd4[28];" +.br +.BI " __le64 dtwin_rt;" +.br +.BI " __le64 dtwin_wt;" +.br +.BI " __le64 dtwin_tmax;" +.br +.BI " __le64 ndwin_tmin_hi;" +.br +.BI " __le64 ndwin_tmin_lo;" +.br +.BI " __u8 rsvd72[56];" +.br +.BI " __le64 dtwin_re;" +.br +.BI " __le64 dtwin_we;" +.br +.BI " __le64 dtwin_te;" +.br +.BI " __u8 rsvd152[360];" +.br +.BI " +}; +.br + +.SH Members +.IP "status" 12 +Status +.IP "rsvd1" 12 +Reserved +.IP "event_type" 12 +Event Type +.IP "rsvd4" 12 +Reserved +.IP "dtwin_rt" 12 +DTWIN Reads Typical +.IP "dtwin_wt" 12 +DTWIN Writes Typical +.IP "dtwin_tmax" 12 +DTWIN Time Maximum +.IP "ndwin_tmin_hi" 12 +NDWIN Time Minimum High +.IP "ndwin_tmin_lo" 12 +NDWIN Time Minimum Low +.IP "rsvd72" 12 +Reserved +.IP "dtwin_re" 12 +DTWIN Reads Estimate +.IP "dtwin_we" 12 +DTWIN Writes Estimate +.IP "dtwin_te" 12 +DTWIN Time Estimate +.IP "rsvd152" 12 +Reserved diff --git a/doc/man/nvme_open.2 b/doc/man/nvme_open.2 new file mode 100644 index 0000000..5d7e7d0 --- /dev/null +++ b/doc/man/nvme_open.2 @@ -0,0 +1,15 @@ +.TH "nvme_open" 9 "nvme_open" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_open \- Open an nvme controller or namespace device +.SH SYNOPSIS +.B "int" nvme_open +.BI "(const char *name " ");" +.SH ARGUMENTS +.IP "name" 12 +The basename of the device to open +.SH "DESCRIPTION" +This will look for the handle in /dev/ and validate the name and filetype +match linux conventions. +.SH "RETURN" +A file descriptor for the device on a successful open, or -1 with +errno set otherwise. diff --git a/doc/man/nvme_passthru_cmd.2 b/doc/man/nvme_passthru_cmd.2 new file mode 100644 index 0000000..dbe721a --- /dev/null +++ b/doc/man/nvme_passthru_cmd.2 @@ -0,0 +1,83 @@ +.TH "libnvme" 9 "struct nvme_passthru_cmd" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_passthru_cmd \- nvme passthrough command structure +.SH SYNOPSIS +struct nvme_passthru_cmd { +.br +.BI " __u8 opcode;" +.br +.BI " __u8 flags;" +.br +.BI " __u16 rsvd1;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 cdw2;" +.br +.BI " __u32 cdw3;" +.br +.BI " __u64 metadata;" +.br +.BI " __u64 addr;" +.br +.BI " __u32 metadata_len;" +.br +.BI " __u32 data_len;" +.br +.BI " __u32 cdw10;" +.br +.BI " __u32 cdw11;" +.br +.BI " __u32 cdw12;" +.br +.BI " __u32 cdw13;" +.br +.BI " __u32 cdw14;" +.br +.BI " __u32 cdw15;" +.br +.BI " __u32 timeout_ms;" +.br +.BI " __u32 result;" +.br +.BI " +}; +.br + +.SH Members +.IP "opcode" 12 +Operation code, see \fIenum nvme_io_opcodes\fP and \fIenum nvme_admin_opcodes\fP +.IP "flags" 12 +Not supported: intended for command flags (eg: SGL, FUSE) +.IP "rsvd1" 12 +Reserved for future use +.IP "nsid" 12 +Namespace Identifier, or Fabrics type +.IP "cdw2" 12 +Command Dword 2 (no spec defined use) +.IP "cdw3" 12 +Command Dword 3 (no spec defined use) +.IP "metadata" 12 +User space address to metadata buffer (NULL if not used) +.IP "addr" 12 +User space address to data buffer (NULL if not used) +.IP "metadata_len" 12 +Metadata buffer transfer length +.IP "data_len" 12 +Data buffer transfer length +.IP "cdw10" 12 +Command Dword 10 (command specific) +.IP "cdw11" 12 +Command Dword 11 (command specific) +.IP "cdw12" 12 +Command Dword 12 (command specific) +.IP "cdw13" 12 +Command Dword 13 (command specific) +.IP "cdw14" 12 +Command Dword 14 (command specific) +.IP "cdw15" 12 +Command Dword 15 (command specific) +.IP "timeout_ms" 12 +If non-zero, overrides system default timeout in milliseconds +.IP "result" 12 +Set on completion to the command's CQE DWORD 0 controller response diff --git a/doc/man/nvme_path_get_ana_state.2 b/doc/man/nvme_path_get_ana_state.2 new file mode 100644 index 0000000..aea9250 --- /dev/null +++ b/doc/man/nvme_path_get_ana_state.2 @@ -0,0 +1,11 @@ +.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_path_get_ana_state \- ANA state of an nvme_path_t object +.SH SYNOPSIS +.B "const char *" nvme_path_get_ana_state +.BI "(nvme_path_t p " ");" +.SH ARGUMENTS +.IP "p" 12 +\fInvme_path_t\fP object +.SH "RETURN" +ANA (Asynchronous Namespace Access) state of \fIp\fP diff --git a/doc/man/nvme_path_get_ctrl.2 b/doc/man/nvme_path_get_ctrl.2 new file mode 100644 index 0000000..eb5a046 --- /dev/null +++ b/doc/man/nvme_path_get_ctrl.2 @@ -0,0 +1,11 @@ +.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_path_get_ctrl \- Parent controller of an nvme_path_t object +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_path_get_ctrl +.BI "(nvme_path_t p " ");" +.SH ARGUMENTS +.IP "p" 12 +\fInvme_path_t\fP object +.SH "RETURN" +Parent controller if present diff --git a/doc/man/nvme_path_get_name.2 b/doc/man/nvme_path_get_name.2 new file mode 100644 index 0000000..5d78c61 --- /dev/null +++ b/doc/man/nvme_path_get_name.2 @@ -0,0 +1,11 @@ +.TH "nvme_path_get_name" 9 "nvme_path_get_name" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_path_get_name \- sysfs name of an &nvme_path_t object +.SH SYNOPSIS +.B "const char *" nvme_path_get_name +.BI "(nvme_path_t p " ");" +.SH ARGUMENTS +.IP "p" 12 +\fInvme_path_t\fP object +.SH "RETURN" +sysfs name of \fIp\fP diff --git a/doc/man/nvme_path_get_ns.2 b/doc/man/nvme_path_get_ns.2 new file mode 100644 index 0000000..6fb4450 --- /dev/null +++ b/doc/man/nvme_path_get_ns.2 @@ -0,0 +1,11 @@ +.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_path_get_ns \- Parent namespace of an nvme_path_t object +.SH SYNOPSIS +.B "nvme_ns_t" nvme_path_get_ns +.BI "(nvme_path_t p " ");" +.SH ARGUMENTS +.IP "p" 12 +\fInvme_path_t\fP object +.SH "RETURN" +Parent namespace if present diff --git a/doc/man/nvme_path_get_sysfs_dir.2 b/doc/man/nvme_path_get_sysfs_dir.2 new file mode 100644 index 0000000..f14b537 --- /dev/null +++ b/doc/man/nvme_path_get_sysfs_dir.2 @@ -0,0 +1,11 @@ +.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_path_get_sysfs_dir \- sysfs directory of an nvme_path_t object +.SH SYNOPSIS +.B "const char *" nvme_path_get_sysfs_dir +.BI "(nvme_path_t p " ");" +.SH ARGUMENTS +.IP "p" 12 +\fInvme_path_t\fP object +.SH "RETURN" +sysfs directory of \fIp\fP diff --git a/doc/man/nvme_paths_filter.2 b/doc/man/nvme_paths_filter.2 new file mode 100644 index 0000000..d2d2955 --- /dev/null +++ b/doc/man/nvme_paths_filter.2 @@ -0,0 +1,11 @@ +.TH "nvme_paths_filter" 9 "nvme_paths_filter" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_paths_filter \- Filter for paths +.SH SYNOPSIS +.B "int" nvme_paths_filter +.BI "(const struct dirent *d " ");" +.SH ARGUMENTS +.IP "d" 12 +dirent to check +.SH "RETURN" +1 if \fId\fP matches, 0 otherwise diff --git a/doc/man/nvme_persistent_event_entry.2 b/doc/man/nvme_persistent_event_entry.2 new file mode 100644 index 0000000..0e19ab9 --- /dev/null +++ b/doc/man/nvme_persistent_event_entry.2 @@ -0,0 +1,51 @@ +.TH "libnvme" 9 "struct nvme_persistent_event_entry" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_persistent_event_entry \- +.SH SYNOPSIS +struct nvme_persistent_event_entry { +.br +.BI " __u8 etype;" +.br +.BI " __u8 etype_rev;" +.br +.BI " __u8 ehl;" +.br +.BI " __u8 ehai;" +.br +.BI " __le16 cntlid;" +.br +.BI " __le64 ets;" +.br +.BI " __le16 pelpid;" +.br +.BI " __u8 rsvd16[4];" +.br +.BI " __le16 vsil;" +.br +.BI " __le16 el;" +.br +.BI " +}; +.br + +.SH Members +.IP "etype" 12 +Event Type +.IP "etype_rev" 12 +Event Type Revision +.IP "ehl" 12 +Event Header Length +.IP "ehai" 12 +Event Header Additional Info +.IP "cntlid" 12 +Controller Identifier +.IP "ets" 12 +Event Timestamp +.IP "pelpid" 12 +Port Identifier +.IP "rsvd16" 12 +Reserved +.IP "vsil" 12 +Vendor Specific Information Length +.IP "el" 12 +Event Length diff --git a/doc/man/nvme_persistent_event_log.2 b/doc/man/nvme_persistent_event_log.2 new file mode 100644 index 0000000..466b333 --- /dev/null +++ b/doc/man/nvme_persistent_event_log.2 @@ -0,0 +1,87 @@ +.TH "libnvme" 9 "struct nvme_persistent_event_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_persistent_event_log \- +.SH SYNOPSIS +struct nvme_persistent_event_log { +.br +.BI " __u8 lid;" +.br +.BI " __u8 rsvd1[3];" +.br +.BI " __le32 tnev;" +.br +.BI " __le64 tll;" +.br +.BI " __u8 rv;" +.br +.BI " __u8 rsvd17;" +.br +.BI " __le16 lhl;" +.br +.BI " __le64 ts;" +.br +.BI " __u8 poh[16];" +.br +.BI " __le64 pcc;" +.br +.BI " __le16 vid;" +.br +.BI " __le16 ssvid;" +.br +.BI " char sn[20];" +.br +.BI " char mn[40];" +.br +.BI " char subnqn[NVME_NQN_LENGTH];" +.br +.BI " __le16 gen_number;" +.br +.BI " __le32 rci;" +.br +.BI " __u8 rsvd378[102];" +.br +.BI " __u8 seb[32];" +.br +.BI " +}; +.br + +.SH Members +.IP "lid" 12 +Log Identifier +.IP "rsvd1" 12 +Reserved +.IP "tnev" 12 +Total Number of Events +.IP "tll" 12 +Total Log Length +.IP "rv" 12 +Log Revision +.IP "rsvd17" 12 +Reserved +.IP "lhl" 12 +Log Header Length +.IP "ts" 12 +Timestamp +.IP "poh" 12 +Power on Hours +.IP "pcc" 12 +Power Cycle Count +.IP "vid" 12 +PCI Vendor ID +.IP "ssvid" 12 +PCI Subsystem Vendor ID +.IP "sn" 12 +Serial Number +.IP "mn" 12 +Model Number +.IP "subnqn" 12 +NVM Subsystem NVMe Qualified Name +.IP "gen_number" 12 +Generation Number +.IP "rci" 12 +Reporting Context Information +.IP "rsvd378" 12 +Reserved +.IP "seb" 12 +Supported Events Bitmap diff --git a/doc/man/nvme_persistent_event_types.2 b/doc/man/nvme_persistent_event_types.2 new file mode 100644 index 0000000..42900f8 --- /dev/null +++ b/doc/man/nvme_persistent_event_types.2 @@ -0,0 +1,71 @@ +.TH "libnvme" 9 "enum nvme_persistent_event_types" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_persistent_event_types \- +.SH SYNOPSIS +enum nvme_persistent_event_types { +.br +.BI " NVME_PEL_SMART_HEALTH_EVENT" +, +.br +.br +.BI " NVME_PEL_FW_COMMIT_EVENT" +, +.br +.br +.BI " NVME_PEL_TIMESTAMP_EVENT" +, +.br +.br +.BI " NVME_PEL_POWER_ON_RESET_EVENT" +, +.br +.br +.BI " NVME_PEL_NSS_HW_ERROR_EVENT" +, +.br +.br +.BI " NVME_PEL_CHANGE_NS_EVENT" +, +.br +.br +.BI " NVME_PEL_FORMAT_START_EVENT" +, +.br +.br +.BI " NVME_PEL_FORMAT_COMPLETION_EVENT" +, +.br +.br +.BI " NVME_PEL_SANITIZE_START_EVENT" +, +.br +.br +.BI " NVME_PEL_SANITIZE_COMPLETION_EVENT" +, +.br +.br +.BI " NVME_PEL_SET_FEATURE_EVENT" +, +.br +.br +.BI " NVME_PEL_TELEMETRY_CRT" +, +.br +.br +.BI " NVME_PEL_THERMAL_EXCURSION_EVENT" + +}; +.SH Constants +.IP "NVME_PEL_SMART_HEALTH_EVENT" 12 +.IP "NVME_PEL_FW_COMMIT_EVENT" 12 +.IP "NVME_PEL_TIMESTAMP_EVENT" 12 +.IP "NVME_PEL_POWER_ON_RESET_EVENT" 12 +.IP "NVME_PEL_NSS_HW_ERROR_EVENT" 12 +.IP "NVME_PEL_CHANGE_NS_EVENT" 12 +.IP "NVME_PEL_FORMAT_START_EVENT" 12 +.IP "NVME_PEL_FORMAT_COMPLETION_EVENT" 12 +.IP "NVME_PEL_SANITIZE_START_EVENT" 12 +.IP "NVME_PEL_SANITIZE_COMPLETION_EVENT" 12 +.IP "NVME_PEL_SET_FEATURE_EVENT" 12 +.IP "NVME_PEL_TELEMETRY_CRT" 12 +.IP "NVME_PEL_THERMAL_EXCURSION_EVENT" 12 diff --git a/doc/man/nvme_pevent_log_action.2 b/doc/man/nvme_pevent_log_action.2 new file mode 100644 index 0000000..d0e500b --- /dev/null +++ b/doc/man/nvme_pevent_log_action.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_pevent_log_action" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_pevent_log_action \- +.SH SYNOPSIS +enum nvme_pevent_log_action { +.br +.BI " NVME_PEVENT_LOG_READ" +, +.br +.br +.BI " NVME_PEVENT_LOG_EST_CTX_AND_READ" +, +.br +.br +.BI " NVME_PEVENT_LOG_RELEASE_CTX" + +}; +.SH Constants +.IP "NVME_PEVENT_LOG_READ" 12 +Read Log Data +.IP "NVME_PEVENT_LOG_EST_CTX_AND_READ" 12 +Establish Context and Read Log Data +.IP "NVME_PEVENT_LOG_RELEASE_CTX" 12 +Release Context diff --git a/doc/man/nvme_plm_config.2 b/doc/man/nvme_plm_config.2 new file mode 100644 index 0000000..098aec6 --- /dev/null +++ b/doc/man/nvme_plm_config.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_plm_config" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_plm_config \- +.SH SYNOPSIS +struct nvme_plm_config { +.br +.BI " __le16 ee;" +.br +.BI " __u8 rsvd2[30];" +.br +.BI " __le64 dtwinrt;" +.br +.BI " __le64 dtwinwt;" +.br +.BI " __le64 dtwintt;" +.br +.BI " __u8 rsvd56[456];" +.br +.BI " +}; +.br + +.SH Members +.IP "ee" 12 +Enable Event +.IP "rsvd2" 12 +Reserved +.IP "dtwinrt" 12 +DTWIN Reads Threshold +.IP "dtwinwt" 12 +DTWIN Writes Threshold +.IP "dtwintt" 12 +DTWIN Time Threshold +.IP "rsvd56" 12 +Reserved diff --git a/doc/man/nvme_pmr_size.2 b/doc/man/nvme_pmr_size.2 new file mode 100644 index 0000000..07e7906 --- /dev/null +++ b/doc/man/nvme_pmr_size.2 @@ -0,0 +1,11 @@ +.TH "nvme_pmr_size" 9 "nvme_pmr_size" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_pmr_size \- Calculate size of persistent memory region elasticity buffer +.SH SYNOPSIS +.B "__u64" nvme_pmr_size +.BI "(__u32 pmrebs " ");" +.SH ARGUMENTS +.IP "pmrebs" 12 +Value from controller register NVME_REG_PMREBS +.SH "DESCRIPTION" +Returns size of controller persistent memory buffer in bytes diff --git a/doc/man/nvme_pmr_throughput.2 b/doc/man/nvme_pmr_throughput.2 new file mode 100644 index 0000000..5a1d88b --- /dev/null +++ b/doc/man/nvme_pmr_throughput.2 @@ -0,0 +1,11 @@ +.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_pmr_throughput \- Calculate throughput of persistent memory buffer +.SH SYNOPSIS +.B "__u64" nvme_pmr_throughput +.BI "(__u32 pmrswtp " ");" +.SH ARGUMENTS +.IP "pmrswtp" 12 +Value from controller register NVME_REG_PMRSWTP +.SH "DESCRIPTION" +Returns throughput of controller persistent memory buffer in bytes/second diff --git a/doc/man/nvme_power_on_reset_info_list.2 b/doc/man/nvme_power_on_reset_info_list.2 new file mode 100644 index 0000000..2e08e42 --- /dev/null +++ b/doc/man/nvme_power_on_reset_info_list.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_power_on_reset_info_list \- +.SH SYNOPSIS +struct nvme_power_on_reset_info_list { +.br +.BI " __le16 cid;" +.br +.BI " __u8 fw_act;" +.br +.BI " __u8 op_in_prog;" +.br +.BI " __u8 rsvd4[12];" +.br +.BI " __le32 ctrl_power_cycle;" +.br +.BI " __le64 power_on_ml_seconds;" +.br +.BI " __le64 ctrl_time_stamp;" +.br +.BI " +}; +.br + +.SH Members +.IP "cid" 12 +Controller ID +.IP "fw_act" 12 +Firmware Activation +.IP "op_in_prog" 12 +Operation in Progress +.IP "rsvd4" 12 +Reserved +.IP "ctrl_power_cycle" 12 +Controller Power Cycle +.IP "power_on_ml_seconds" 12 +Power on milliseconds +.IP "ctrl_time_stamp" 12 +Controller Timestamp diff --git a/doc/man/nvme_primary_ctrl_cap.2 b/doc/man/nvme_primary_ctrl_cap.2 new file mode 100644 index 0000000..05aa41d --- /dev/null +++ b/doc/man/nvme_primary_ctrl_cap.2 @@ -0,0 +1,83 @@ +.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_primary_ctrl_cap \- +.SH SYNOPSIS +struct nvme_primary_ctrl_cap { +.br +.BI " __le16 cntlid;" +.br +.BI " __le16 portid;" +.br +.BI " __u8 crt;" +.br +.BI " __u8 rsvd5[27];" +.br +.BI " __le32 vqfrt;" +.br +.BI " __le32 vqrfa;" +.br +.BI " __le16 vqrfap;" +.br +.BI " __le16 vqprt;" +.br +.BI " __le16 vqfrsm;" +.br +.BI " __le16 vqgran;" +.br +.BI " __u8 rsvd48[16];" +.br +.BI " __le32 vifrt;" +.br +.BI " __le32 virfa;" +.br +.BI " __le16 virfap;" +.br +.BI " __le16 viprt;" +.br +.BI " __le16 vifrsm;" +.br +.BI " __le16 vigran;" +.br +.BI " __u8 rsvd80[4016];" +.br +.BI " +}; +.br + +.SH Members +.IP "cntlid" 12 +Controller Identifier +.IP "portid" 12 +Port Identifier +.IP "crt" 12 +Controller Resource Types +.IP "rsvd5" 12 +reserved +.IP "vqfrt" 12 +VQ Resources Flexible Total +.IP "vqrfa" 12 +VQ Resources Flexible Assigned +.IP "vqrfap" 12 +VQ Resources Flexible Allocated to Primary +.IP "vqprt" 12 +VQ Resources Private Total +.IP "vqfrsm" 12 +VQ Resources Flexible Secondary Maximum +.IP "vqgran" 12 +VQ Flexible Resource Preferred Granularity +.IP "rsvd48" 12 +reserved +.IP "vifrt" 12 +VI Resources Flexible Total +.IP "virfa" 12 +VI Resources Flexible Assigned +.IP "virfap" 12 +VI Resources Flexible Allocated to Primary +.IP "viprt" 12 +VI Resources Private Total +.IP "vifrsm" 12 +VI Resources Flexible Secondary Maximum +.IP "vigran" 12 +VI Flexible Resource Preferred Granularity +.IP "rsvd80" 12 +reserved diff --git a/doc/man/nvme_psd_flags.2 b/doc/man/nvme_psd_flags.2 new file mode 100644 index 0000000..655a4db --- /dev/null +++ b/doc/man/nvme_psd_flags.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_psd_flags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_psd_flags \- Possible flag values in nvme power state descriptor +.SH SYNOPSIS +enum nvme_psd_flags { +.br +.BI " NVME_PSD_FLAGS_MXPS" +, +.br +.br +.BI " NVME_PSD_FLAGS_NOPS" + +}; +.SH Constants +.IP "NVME_PSD_FLAGS_MXPS" 12 +Indicates the scale for the Maximum Power +field. If this bit is cleared, then the scale of the +Maximum Power field is in 0.01 Watts. If this bit is +set, then the scale of the Maximum Power field is in +0.0001 Watts. +.IP "NVME_PSD_FLAGS_NOPS" 12 +Indicates whether the controller processes I/O +commands in this power state. If this bit is cleared, +then the controller processes I/O commands in this +power state. If this bit is set, then the controller +does not process I/O commands in this power state. diff --git a/doc/man/nvme_psd_power_scale.2 b/doc/man/nvme_psd_power_scale.2 new file mode 100644 index 0000000..974c60e --- /dev/null +++ b/doc/man/nvme_psd_power_scale.2 @@ -0,0 +1,9 @@ +.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_psd_power_scale \- power scale occupies the upper 3 bits +.SH SYNOPSIS +.B "unsigned int" nvme_psd_power_scale +.BI "(__u8 ps " ");" +.SH ARGUMENTS +.IP "ps" 12 +power scale value diff --git a/doc/man/nvme_psd_ps.2 b/doc/man/nvme_psd_ps.2 new file mode 100644 index 0000000..bd5e403 --- /dev/null +++ b/doc/man/nvme_psd_ps.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_psd_ps" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_psd_ps \- Known values for &struct nvme_psd %ips and %aps. Use with nvme_psd_power_scale() to extract the power scale field to match this enum. +.SH SYNOPSIS +enum nvme_psd_ps { +.br +.BI " NVME_PSD_PS_100_MICRO_WATT" +, +.br +.br +.BI " NVME_PSD_PS_10_MILLI_WATT" + +}; +.SH Constants +.IP "NVME_PSD_PS_100_MICRO_WATT" 12 +0.0001 watt scale +.IP "NVME_PSD_PS_10_MILLI_WATT" 12 +0.01 watt scale diff --git a/doc/man/nvme_psd_workload.2 b/doc/man/nvme_psd_workload.2 new file mode 100644 index 0000000..2e2fe26 --- /dev/null +++ b/doc/man/nvme_psd_workload.2 @@ -0,0 +1,29 @@ +.TH "libnvme" 9 "enum nvme_psd_workload" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_psd_workload \- Specifies a workload hint in the Power Management Feature (see &struct nvme_psd.apw) to inform the NVM subsystem or indicate the conditions for the active power level. +.SH SYNOPSIS +enum nvme_psd_workload { +.br +.BI " NVME_PSD_WORKLOAD_1" +, +.br +.br +.BI " NVME_PSD_WORKLOAD_2" + +}; +.SH Constants +.IP "NVME_PSD_WORKLOAD_1" 12 +Extended Idle Period with a Burst of Random Write +consists of five minutes of idle followed by +thirty-two random write commands of size 1 MiB +submitted to a single controller while all other +controllers in the NVM subsystem are idle, and then +thirty (30) seconds of idle. +.IP "NVME_PSD_WORKLOAD_2" 12 +Heavy Sequential Writes consists of 80,000 +sequential write commands of size 128 KiB submitted to +a single controller while all other controllers in the +NVM subsystem are idle. The submission queue(s) +should be sufficiently large allowing the host to +ensure there are multiple commands pending at all +times during the workload. diff --git a/doc/man/nvme_read.2 b/doc/man/nvme_read.2 new file mode 100644 index 0000000..7e25fe3 --- /dev/null +++ b/doc/man/nvme_read.2 @@ -0,0 +1,12 @@ +.TH "nvme_read" 9 "nvme_read" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_read \- Submit an nvme user read command +.SH SYNOPSIS +.B "int" nvme_read +.BI "(struct nvme_io_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_read_config.2 b/doc/man/nvme_read_config.2 new file mode 100644 index 0000000..3f5867f --- /dev/null +++ b/doc/man/nvme_read_config.2 @@ -0,0 +1,17 @@ +.TH "nvme_read_config" 9 "nvme_read_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_read_config \- Read NVMe JSON configuration file +.SH SYNOPSIS +.B "int" nvme_read_config +.BI "(nvme_root_t r " "," +.BI "const char *config_file " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.IP "config_file" 12 +JSON configuration file +.SH "DESCRIPTION" +Read in the contents of \fIconfig_file\fP and merge them with +the elements in \fIr\fP. +.SH "RETURN" +0 on success, -1 on failure with errno set. diff --git a/doc/man/nvme_refresh_topology.2 b/doc/man/nvme_refresh_topology.2 new file mode 100644 index 0000000..625310c --- /dev/null +++ b/doc/man/nvme_refresh_topology.2 @@ -0,0 +1,11 @@ +.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_refresh_topology \- Refresh nvme_root_t object contents +.SH SYNOPSIS +.B "void" nvme_refresh_topology +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.SH "DESCRIPTION" +Removes all elements in \fIr\fP and rescans the existing topology. diff --git a/doc/man/nvme_register_offsets.2 b/doc/man/nvme_register_offsets.2 new file mode 100644 index 0000000..c10bed5 --- /dev/null +++ b/doc/man/nvme_register_offsets.2 @@ -0,0 +1,150 @@ +.TH "libnvme" 9 "enum nvme_register_offsets" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_register_offsets \- controller registers for all transports. This is the layout of BAR0/1 for PCIe, and properties for fabrics. +.SH SYNOPSIS +enum nvme_register_offsets { +.br +.BI " NVME_REG_CAP" +, +.br +.br +.BI " NVME_REG_VS" +, +.br +.br +.BI " NVME_REG_INTMS" +, +.br +.br +.BI " NVME_REG_INTMC" +, +.br +.br +.BI " NVME_REG_CC" +, +.br +.br +.BI " NVME_REG_CSTS" +, +.br +.br +.BI " NVME_REG_NSSR" +, +.br +.br +.BI " NVME_REG_AQA" +, +.br +.br +.BI " NVME_REG_ASQ" +, +.br +.br +.BI " NVME_REG_ACQ" +, +.br +.br +.BI " NVME_REG_CMBLOC" +, +.br +.br +.BI " NVME_REG_CMBSZ" +, +.br +.br +.BI " NVME_REG_BPINFO" +, +.br +.br +.BI " NVME_REG_BPRSEL" +, +.br +.br +.BI " NVME_REG_BPMBL" +, +.br +.br +.BI " NVME_REG_CMBMSC" +, +.br +.br +.BI " NVME_REG_CMBSTS" +, +.br +.br +.BI " NVME_REG_PMRCAP" +, +.br +.br +.BI " NVME_REG_PMRCTL" +, +.br +.br +.BI " NVME_REG_PMRSTS" +, +.br +.br +.BI " NVME_REG_PMREBS" +, +.br +.br +.BI " NVME_REG_PMRSWTP" +, +.br +.br +.BI " NVME_REG_PMRMSCL" +, +.br +.br +.BI " NVME_REG_PMRMSCU" + +}; +.SH Constants +.IP "NVME_REG_CAP" 12 +Controller Capabilities +.IP "NVME_REG_VS" 12 +Version +.IP "NVME_REG_INTMS" 12 +Interrupt Mask Set +.IP "NVME_REG_INTMC" 12 +Interrupt Mask Clear +.IP "NVME_REG_CC" 12 +Controller Configuration +.IP "NVME_REG_CSTS" 12 +Controller Status +.IP "NVME_REG_NSSR" 12 +NVM Subsystem Reset +.IP "NVME_REG_AQA" 12 +Admin Queue Attributes +.IP "NVME_REG_ASQ" 12 +Admin SQ Base Address +.IP "NVME_REG_ACQ" 12 +Admin CQ Base Address +.IP "NVME_REG_CMBLOC" 12 +Controller Memory Buffer Location +.IP "NVME_REG_CMBSZ" 12 +Controller Memory Buffer Size +.IP "NVME_REG_BPINFO" 12 +Boot Partition Information +.IP "NVME_REG_BPRSEL" 12 +Boot Partition Read Select +.IP "NVME_REG_BPMBL" 12 +Boot Partition Memory Buffer Location +.IP "NVME_REG_CMBMSC" 12 +Controller Memory Buffer Memory Space Control +.IP "NVME_REG_CMBSTS" 12 +Controller Memory Buffer Status +.IP "NVME_REG_PMRCAP" 12 +Persistent Memory Capabilities +.IP "NVME_REG_PMRCTL" 12 +Persistent Memory Region Control +.IP "NVME_REG_PMRSTS" 12 +Persistent Memory Region Status +.IP "NVME_REG_PMREBS" 12 +Persistent Memory Region Elasticity Buffer Size +.IP "NVME_REG_PMRSWTP" 12 +Memory Region Sustained Write Throughput +.IP "NVME_REG_PMRMSCL" 12 +Persistent Memory Region Controller Memory Space Control Lower +.IP "NVME_REG_PMRMSCU" 12 +Persistent Memory Region Controller Memory Space Control Upper diff --git a/doc/man/nvme_registered_ctrl.2 b/doc/man/nvme_registered_ctrl.2 new file mode 100644 index 0000000..b66824e --- /dev/null +++ b/doc/man/nvme_registered_ctrl.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_registered_ctrl" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_registered_ctrl \- +.SH SYNOPSIS +struct nvme_registered_ctrl { +.br +.BI " __le16 cntlid;" +.br +.BI " __u8 rcsts;" +.br +.BI " __u8 rsvd3[5];" +.br +.BI " __le64 hostid;" +.br +.BI " __le64 rkey;" +.br +.BI " +}; +.br + +.SH Members +.IP "cntlid" 12 +Controller ID +.IP "rcsts" 12 +Reservation Status +.IP "rsvd3" 12 +Reserved +.IP "hostid" 12 +Host Identifier +.IP "rkey" 12 +Reservation Key diff --git a/doc/man/nvme_registered_ctrl_ext.2 b/doc/man/nvme_registered_ctrl_ext.2 new file mode 100644 index 0000000..04e0da2 --- /dev/null +++ b/doc/man/nvme_registered_ctrl_ext.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_registered_ctrl_ext \- +.SH SYNOPSIS +struct nvme_registered_ctrl_ext { +.br +.BI " __le16 cntlid;" +.br +.BI " __u8 rcsts;" +.br +.BI " __u8 rsvd3[5];" +.br +.BI " __le64 rkey;" +.br +.BI " __u8 hostid[16];" +.br +.BI " __u8 rsvd32[32];" +.br +.BI " +}; +.br + +.SH Members +.IP "cntlid" 12 +Controller ID +.IP "rcsts" 12 +Reservation Status +.IP "rsvd3" 12 +Reserved +.IP "rkey" 12 +Reservation Key +.IP "hostid" 12 +Host Identifier +.IP "rsvd32" 12 +Reserved diff --git a/doc/man/nvme_rescan_ctrl.2 b/doc/man/nvme_rescan_ctrl.2 new file mode 100644 index 0000000..af1c791 --- /dev/null +++ b/doc/man/nvme_rescan_ctrl.2 @@ -0,0 +1,9 @@ +.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_rescan_ctrl \- Rescan an existing controller +.SH SYNOPSIS +.B "void" nvme_rescan_ctrl +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance diff --git a/doc/man/nvme_resv_acquire.2 b/doc/man/nvme_resv_acquire.2 new file mode 100644 index 0000000..2a66281 --- /dev/null +++ b/doc/man/nvme_resv_acquire.2 @@ -0,0 +1,16 @@ +.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_resv_acquire \- Send an nvme reservation acquire +.SH SYNOPSIS +.B "int" nvme_resv_acquire +.BI "(struct nvme_resv_acquire_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_resv_acquire\fP argument structure +.SH "DESCRIPTION" +The Reservation Acquire command acquires a reservation on a namespace, +preempt a reservation held on a namespace, and abort a reservation held on a +namespace. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_resv_acquire_args.2 b/doc/man/nvme_resv_acquire_args.2 new file mode 100644 index 0000000..bbbda30 --- /dev/null +++ b/doc/man/nvme_resv_acquire_args.2 @@ -0,0 +1,52 @@ +.TH "libnvme" 9 "struct nvme_resv_acquire_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_resv_acquire_args \- Arguments for the NVMe Reservation Acquire Comand +.SH SYNOPSIS +struct nvme_resv_acquire_args { +.br +.BI " __u64 crkey;" +.br +.BI " __u64 nrkey;" +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_resv_rtype rtype;" +.br +.BI " enum nvme_resv_racqa racqa;" +.br +.BI " bool iekey;" +.br +.BI " +}; +.br + +.SH Members +.IP "crkey" 12 +The current reservation key associated with the host +.IP "nrkey" 12 +The reservation key to be unregistered from the namespace if +the action is preempt +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_resv_acquire_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "rtype" 12 +The type of reservation to be create, see \fIenum nvme_resv_rtype\fP +.IP "racqa" 12 +The action that is performed by the command, see \fIenum nvme_resv_racqa\fP +.IP "iekey" 12 +Set to ignore the existing key diff --git a/doc/man/nvme_resv_cptpl.2 b/doc/man/nvme_resv_cptpl.2 new file mode 100644 index 0000000..e59177a --- /dev/null +++ b/doc/man/nvme_resv_cptpl.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_resv_cptpl" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_resv_cptpl \- +.SH SYNOPSIS +enum nvme_resv_cptpl { +.br +.BI " NVME_RESERVATION_CPTPL_NO_CHANGE" +, +.br +.br +.BI " NVME_RESERVATION_CPTPL_CLEAR" +, +.br +.br +.BI " NVME_RESERVATION_CPTPL_PERSIST" + +}; +.SH Constants +.IP "NVME_RESERVATION_CPTPL_NO_CHANGE" 12 +No change to PTPL state +.IP "NVME_RESERVATION_CPTPL_CLEAR" 12 +Reservations are released and +registrants are cleared on a power on +.IP "NVME_RESERVATION_CPTPL_PERSIST" 12 +Reservations and registrants persist +across a power loss diff --git a/doc/man/nvme_resv_notification_log.2 b/doc/man/nvme_resv_notification_log.2 new file mode 100644 index 0000000..d1e2df8 --- /dev/null +++ b/doc/man/nvme_resv_notification_log.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_resv_notification_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_resv_notification_log \- +.SH SYNOPSIS +struct nvme_resv_notification_log { +.br +.BI " __le64 lpc;" +.br +.BI " __u8 rnlpt;" +.br +.BI " __u8 nalp;" +.br +.BI " __u8 rsvd9[2];" +.br +.BI " __le32 nsid;" +.br +.BI " __u8 rsvd16[48];" +.br +.BI " +}; +.br + +.SH Members +.IP "lpc" 12 +Log Page Count +.IP "rnlpt" 12 +See \fIenum nvme_resv_notify_rnlpt\fP. +.IP "nalp" 12 +Number of Available Log Pages +.IP "rsvd9" 12 +Reserved +.IP "nsid" 12 +Namespace ID +.IP "rsvd16" 12 +Reserved diff --git a/doc/man/nvme_resv_notify_rnlpt.2 b/doc/man/nvme_resv_notify_rnlpt.2 new file mode 100644 index 0000000..26d54c5 --- /dev/null +++ b/doc/man/nvme_resv_notify_rnlpt.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_resv_notify_rnlpt \- +.SH SYNOPSIS +enum nvme_resv_notify_rnlpt { +.br +.BI " NVME_RESV_NOTIFY_RNLPT_EMPTY" +, +.br +.br +.BI " NVME_RESV_NOTIFY_RNLPT_REGISTRATION_PREEMPTED" +, +.br +.br +.BI " NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASED" +, +.br +.br +.BI " NVME_RESV_NOTIFY_RNLPT_RESERVATION_PREEMPTED" + +}; +.SH Constants +.IP "NVME_RESV_NOTIFY_RNLPT_EMPTY" 12 +.IP "NVME_RESV_NOTIFY_RNLPT_REGISTRATION_PREEMPTED" 12 +.IP "NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASED" 12 +.IP "NVME_RESV_NOTIFY_RNLPT_RESERVATION_PREEMPTED" 12 diff --git a/doc/man/nvme_resv_racqa.2 b/doc/man/nvme_resv_racqa.2 new file mode 100644 index 0000000..724eedf --- /dev/null +++ b/doc/man/nvme_resv_racqa.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_resv_racqa" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_resv_racqa \- +.SH SYNOPSIS +enum nvme_resv_racqa { +.br +.BI " NVME_RESERVATION_RACQA_ACQUIRE" +, +.br +.br +.BI " NVME_RESERVATION_RACQA_PREEMPT" +, +.br +.br +.BI " NVME_RESERVATION_RACQA_PREEMPT_AND_ABORT" + +}; +.SH Constants +.IP "NVME_RESERVATION_RACQA_ACQUIRE" 12 +Acquire +.IP "NVME_RESERVATION_RACQA_PREEMPT" 12 +Preempt +.IP "NVME_RESERVATION_RACQA_PREEMPT_AND_ABORT" 12 +Preempt and Abort diff --git a/doc/man/nvme_resv_register.2 b/doc/man/nvme_resv_register.2 new file mode 100644 index 0000000..af51199 --- /dev/null +++ b/doc/man/nvme_resv_register.2 @@ -0,0 +1,15 @@ +.TH "nvme_resv_register" 9 "nvme_resv_register" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_resv_register \- Send an nvme reservation register +.SH SYNOPSIS +.B "int" nvme_resv_register +.BI "(struct nvme_resv_register_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_resv_register_args\fP argument structure +.SH "DESCRIPTION" +The Reservation Register command registers, unregisters, or replaces a +reservation key. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_resv_register_args.2 b/doc/man/nvme_resv_register_args.2 new file mode 100644 index 0000000..5654c8d --- /dev/null +++ b/doc/man/nvme_resv_register_args.2 @@ -0,0 +1,52 @@ +.TH "libnvme" 9 "struct nvme_resv_register_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_resv_register_args \- Arguments for the NVMe Reservation Register command +.SH SYNOPSIS +struct nvme_resv_register_args { +.br +.BI " __u64 crkey;" +.br +.BI " __u64 nrkey;" +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_resv_rrega rrega;" +.br +.BI " enum nvme_resv_cptpl cptpl;" +.br +.BI " bool iekey;" +.br +.BI " +}; +.br + +.SH Members +.IP "crkey" 12 +The current reservation key associated with the host +.IP "nrkey" 12 +The new reservation key to be register if action is register or +replace +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_resv_register_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "rrega" 12 +The registration action, see \fIenum nvme_resv_rrega\fP +.IP "cptpl" 12 +Change persist through power loss, see \fIenum nvme_resv_cptpl\fP +.IP "iekey" 12 +Set to ignore the existing key diff --git a/doc/man/nvme_resv_release.2 b/doc/man/nvme_resv_release.2 new file mode 100644 index 0000000..d656ddd --- /dev/null +++ b/doc/man/nvme_resv_release.2 @@ -0,0 +1,12 @@ +.TH "nvme_resv_release" 9 "nvme_resv_release" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_resv_release \- Send an nvme reservation release +.SH SYNOPSIS +.B "int" nvme_resv_release +.BI "(struct nvme_resv_release_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_resv_release_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_resv_release_args.2 b/doc/man/nvme_resv_release_args.2 new file mode 100644 index 0000000..ad4eeda --- /dev/null +++ b/doc/man/nvme_resv_release_args.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_resv_release_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_resv_release_args \- Arguments for the NVMe Reservation Release Command +.SH SYNOPSIS +struct nvme_resv_release_args { +.br +.BI " __u64 crkey;" +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_resv_rtype rtype;" +.br +.BI " enum nvme_resv_rrela rrela;" +.br +.BI " bool iekey;" +.br +.BI " +}; +.br + +.SH Members +.IP "crkey" 12 +The current reservation key to release +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_resv_release_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "rtype" 12 +The type of reservation to be create, see \fIenum nvme_resv_rtype\fP +.IP "rrela" 12 +Reservation releast action, see \fIenum nvme_resv_rrela\fP +.IP "iekey" 12 +Set to ignore the existing key diff --git a/doc/man/nvme_resv_report.2 b/doc/man/nvme_resv_report.2 new file mode 100644 index 0000000..0e266d7 --- /dev/null +++ b/doc/man/nvme_resv_report.2 @@ -0,0 +1,16 @@ +.TH "nvme_resv_report" 9 "nvme_resv_report" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_resv_report \- Send an nvme reservation report +.SH SYNOPSIS +.B "int" nvme_resv_report +.BI "(struct nvme_resv_report_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +struct nvme_resv_report_args argument structure +.SH "DESCRIPTION" +Returns a Reservation Status data structure to memory that describes the +registration and reservation status of a namespace. See the defintion for +the returned structure, \fIstruct nvme_reservation_status\fP, for more details. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_resv_report_args.2 b/doc/man/nvme_resv_report_args.2 new file mode 100644 index 0000000..f98fd25 --- /dev/null +++ b/doc/man/nvme_resv_report_args.2 @@ -0,0 +1,44 @@ +.TH "libnvme" 9 "struct nvme_resv_report_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_resv_report_args \- Arguments for the NVMe Reservation Report command +.SH SYNOPSIS +struct nvme_resv_report_args { +.br +.BI " __u32 *result;" +.br +.BI " struct nvme_resv_status *report;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 len;" +.br +.BI " bool eds;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "report" 12 +The user space destination address to store the reservation +report +.IP "args_size" 12 +Size of \fIstruct nvme_resv_report_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace identifier +.IP "len" 12 +Number of bytes to request transfered with this command +.IP "eds" 12 +Request extended Data Structure diff --git a/doc/man/nvme_resv_rrega.2 b/doc/man/nvme_resv_rrega.2 new file mode 100644 index 0000000..dfce261 --- /dev/null +++ b/doc/man/nvme_resv_rrega.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvme_resv_rrega" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_resv_rrega \- +.SH SYNOPSIS +enum nvme_resv_rrega { +.br +.BI " NVME_RESERVATION_RREGA_REGISTER_KEY" +, +.br +.br +.BI " NVME_RESERVATION_RREGA_UNREGISTER_KEY" +, +.br +.br +.BI " NVME_RESERVATION_RREGA_REPLACE_KEY" + +}; +.SH Constants +.IP "NVME_RESERVATION_RREGA_REGISTER_KEY" 12 +Register Reservation Key +.IP "NVME_RESERVATION_RREGA_UNREGISTER_KEY" 12 +Unregister Reservation Key +.IP "NVME_RESERVATION_RREGA_REPLACE_KEY" 12 +Replace Reservation Key diff --git a/doc/man/nvme_resv_rrela.2 b/doc/man/nvme_resv_rrela.2 new file mode 100644 index 0000000..b3eb068 --- /dev/null +++ b/doc/man/nvme_resv_rrela.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_resv_rrela" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_resv_rrela \- +.SH SYNOPSIS +enum nvme_resv_rrela { +.br +.BI " NVME_RESERVATION_RRELA_RELEASE" +, +.br +.br +.BI " NVME_RESERVATION_RRELA_CLEAR" + +}; +.SH Constants +.IP "NVME_RESERVATION_RRELA_RELEASE" 12 +Release +.IP "NVME_RESERVATION_RRELA_CLEAR" 12 +Clear diff --git a/doc/man/nvme_resv_rtype.2 b/doc/man/nvme_resv_rtype.2 new file mode 100644 index 0000000..bdff164 --- /dev/null +++ b/doc/man/nvme_resv_rtype.2 @@ -0,0 +1,42 @@ +.TH "libnvme" 9 "enum nvme_resv_rtype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_resv_rtype \- +.SH SYNOPSIS +enum nvme_resv_rtype { +.br +.BI " NVME_RESERVATION_RTYPE_WE" +, +.br +.br +.BI " NVME_RESERVATION_RTYPE_EA" +, +.br +.br +.BI " NVME_RESERVATION_RTYPE_WERO" +, +.br +.br +.BI " NVME_RESERVATION_RTYPE_EARO" +, +.br +.br +.BI " NVME_RESERVATION_RTYPE_WEAR" +, +.br +.br +.BI " NVME_RESERVATION_RTYPE_EAAR" + +}; +.SH Constants +.IP "NVME_RESERVATION_RTYPE_WE" 12 +Write Exclusive Reservation +.IP "NVME_RESERVATION_RTYPE_EA" 12 +Exclusive Access Reservation +.IP "NVME_RESERVATION_RTYPE_WERO" 12 +Write Exclusive - Registrants Only Reservation +.IP "NVME_RESERVATION_RTYPE_EARO" 12 +Exclusive Access - Registrants Only Reservation +.IP "NVME_RESERVATION_RTYPE_WEAR" 12 +Write Exclusive - All Registrants Reservation +.IP "NVME_RESERVATION_RTYPE_EAAR" 12 +Exclusive Access - All Registrants Reservation diff --git a/doc/man/nvme_resv_status.2 b/doc/man/nvme_resv_status.2 new file mode 100644 index 0000000..cdb117d --- /dev/null +++ b/doc/man/nvme_resv_status.2 @@ -0,0 +1,59 @@ +.TH "libnvme" 9 "struct nvme_resv_status" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_resv_status \- +.SH SYNOPSIS +struct nvme_resv_status { +.br +.BI " __le32 gen;" +.br +.BI " __u8 rtype;" +.br +.BI " __u8 regctl[2];" +.br +.BI " __u8 rsvd7[2];" +.br +.BI " __u8 ptpls;" +.br +.BI " __u8 rsvd10[14];" +.br +.BI " union {" +.br +.BI " struct {" +.br +.BI " __u8 rsvd24[40];" +.br +.BI " struct nvme_registered_ctrl_ext regctl_eds[0];" +.br +.BI " };" +.br +.BI " struct nvme_registered_ctrl regctl_ds[0];" +.br +.BI " };" +.br +.BI " +}; +.br + +.SH Members +.IP "gen" 12 +Generation +.IP "rtype" 12 +Reservation Type +.IP "regctl" 12 +Number of Registered Controllers +.IP "rsvd7" 12 +Reserved +.IP "ptpls" 12 +Persist Through Power Loss State +.IP "rsvd10" 12 +Reserved +.IP "{unnamed_union}" 12 +anonymous +.IP "{unnamed_struct}" 12 +anonymous +.IP "rsvd24" 12 +Reserved +.IP "regctl_eds" 12 +Registered Controller Extended Data Structure +.IP "regctl_ds" 12 +Registered Controller Data Structure diff --git a/doc/man/nvme_sanitize_compln_event.2 b/doc/man/nvme_sanitize_compln_event.2 new file mode 100644 index 0000000..456e3bc --- /dev/null +++ b/doc/man/nvme_sanitize_compln_event.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_sanitize_compln_event \- +.SH SYNOPSIS +struct nvme_sanitize_compln_event { +.br +.BI " __le16 sani_prog;" +.br +.BI " __le16 sani_status;" +.br +.BI " __le16 cmpln_info;" +.br +.BI " __u8 rsvd6[2];" +.br +.BI " +}; +.br + +.SH Members +.IP "sani_prog" 12 +Sanitize Progress +.IP "sani_status" 12 +Sanitize Status +.IP "cmpln_info" 12 +Completion Information +.IP "rsvd6" 12 +Reserved diff --git a/doc/man/nvme_sanitize_log_page.2 b/doc/man/nvme_sanitize_log_page.2 new file mode 100644 index 0000000..1a915f5 --- /dev/null +++ b/doc/man/nvme_sanitize_log_page.2 @@ -0,0 +1,106 @@ +.TH "libnvme" 9 "struct nvme_sanitize_log_page" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_sanitize_log_page \- Sanitize Status (Log Identifier 81h) +.SH SYNOPSIS +struct nvme_sanitize_log_page { +.br +.BI " __le16 sprog;" +.br +.BI " __le16 sstat;" +.br +.BI " __le32 scdw10;" +.br +.BI " __le32 eto;" +.br +.BI " __le32 etbe;" +.br +.BI " __le32 etce;" +.br +.BI " __le32 etond;" +.br +.BI " __le32 etbend;" +.br +.BI " __le32 etcend;" +.br +.BI " __u8 rsvd32[480];" +.br +.BI " +}; +.br + +.SH Members +.IP "sprog" 12 +Sanitize Progress (SPROG): indicates the fraction complete of the +sanitize operation. The value is a numerator of the fraction +complete that has 65,536 (10000h) as its denominator. This value +shall be set to FFFFh if the \fIsstat\fP field is not set to +NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS. +.IP "sstat" 12 +Sanitize Status (SSTAT): indicates the status associated with +the most recent sanitize operation. See \fIenum nvme_sanitize_sstat\fP. +.IP "scdw10" 12 +Sanitize Command Dword 10 Information (SCDW10): contains the value +of the Command Dword 10 field of the Sanitize command that started +the sanitize operation. +.IP "eto" 12 +Estimated Time For Overwrite: indicates the number of seconds required +to complete an Overwrite sanitize operation with 16 passes in +the background when the No-Deallocate Modifies Media After Sanitize +field is not set to 10b. A value of 0h indicates that the sanitize +operation is expected to be completed in the background when the +Sanitize command that started that operation is completed. A value +of FFFFFFFFh indicates that no time period is reported. +.IP "etbe" 12 +Estimated Time For Block Erase: indicates the number of seconds +required to complete a Block Erase sanitize operation in the +background when the No-Deallocate Modifies Media After Sanitize +field is not set to 10b. A value of 0h indicates that the sanitize +operation is expected to be completed in the background when the +Sanitize command that started that operation is completed. +A value of FFFFFFFFh indicates that no time period is reported. +.IP "etce" 12 +Estimated Time For Crypto Erase: indicates the number of seconds +required to complete a Crypto Erase sanitize operation in the +background when the No-Deallocate Modifies Media After Sanitize +field is not set to 10b. A value of 0h indicates that the sanitize +operation is expected to be completed in the background when the +Sanitize command that started that operation is completed. +A value of FFFFFFFFh indicates that no time period is reported. +.IP "etond" 12 +Estimated Time For Overwrite With No-Deallocate Media Modification: +indicates the number of seconds required to complete an Overwrite +sanitize operation and the associated additional media modification +after the Overwrite sanitize operation in the background when +the No-Deallocate After Sanitize bit was set to 1 in the Sanitize +command that requested the Overwrite sanitize operation; and +the No-Deallocate Modifies Media After Sanitize field is set to 10b. +A value of 0h indicates that the sanitize operation is expected +to be completed in the background when the Sanitize command that +started that operation is completed. A value of FFFFFFFFh indicates +that no time period is reported. +.IP "etbend" 12 +Estimated Time For Block Erase With No-Deallocate Media Modification: +indicates the number of seconds required to complete a Block Erase +sanitize operation and the associated additional media modification +after the Block Erase sanitize operation in the background when +the No-Deallocate After Sanitize bit was set to 1 in the Sanitize +command that requested the Overwrite sanitize operation; and +the No-Deallocate Modifies Media After Sanitize field is set to 10b. +A value of 0h indicates that the sanitize operation is expected +to be completed in the background when the Sanitize command that +started that operation is completed. A value of FFFFFFFFh indicates +that no time period is reported. +.IP "etcend" 12 +Estimated Time For Crypto Erase With No-Deallocate Media Modification: +indicates the number of seconds required to complete a Crypto Erase +sanitize operation and the associated additional media modification +after the Crypto Erase sanitize operation in the background when +the No-Deallocate After Sanitize bit was set to 1 in the Sanitize +command that requested the Overwrite sanitize operation; and +the No-Deallocate Modifies Media After Sanitize field is set to 10b. +A value of 0h indicates that the sanitize operation is expected +to be completed in the background when the Sanitize command that +started that operation is completed. A value of FFFFFFFFh indicates +that no time period is reported. +.IP "rsvd32" 12 +Reserved diff --git a/doc/man/nvme_sanitize_nvm.2 b/doc/man/nvme_sanitize_nvm.2 new file mode 100644 index 0000000..89dbcf5 --- /dev/null +++ b/doc/man/nvme_sanitize_nvm.2 @@ -0,0 +1,22 @@ +.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_sanitize_nvm \- Start a sanitize operation +.SH SYNOPSIS +.B "int" nvme_sanitize_nvm +.BI "(struct nvme_sanitize_nvm_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_sanitize_nvm_args\fP argument structure +.SH "DESCRIPTION" +A sanitize operation alters all user data in the NVM subsystem such that +recovery of any previous user data from any cache, the non-volatile media, +or any Controller Memory Buffer is not possible. + +The Sanitize command starts a sanitize operation or to recover from a +previously failed sanitize operation. The sanitize operation types that may +be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize +operations are processed in the background, i.e., completion of the sanitize +command does not indicate completion of the sanitize operation. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_sanitize_nvm_args.2 b/doc/man/nvme_sanitize_nvm_args.2 new file mode 100644 index 0000000..1a414db --- /dev/null +++ b/doc/man/nvme_sanitize_nvm_args.2 @@ -0,0 +1,51 @@ +.TH "libnvme" 9 "struct nvme_sanitize_nvm_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_sanitize_nvm_args \- Arguments for the NVMe Sanitize NVM command +.SH SYNOPSIS +struct nvme_sanitize_nvm_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " enum nvme_sanitize_sanact sanact;" +.br +.BI " __u32 ovrpat;" +.br +.BI " bool ause;" +.br +.BI " __u8 owpass;" +.br +.BI " bool oipbp;" +.br +.BI " bool nodas;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_sanitize_nvm_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "sanact" 12 +Sanitize action, see \fIenum nvme_sanitize_sanact\fP +.IP "ovrpat" 12 +Overwrite pattern +.IP "ause" 12 +Set to allow unrestriced sanitize exit +.IP "owpass" 12 +Overwrite pass count +.IP "oipbp" 12 +Set to overwrite invert pattern between passes +.IP "nodas" 12 +Set to not deallocate blocks after sanitizing diff --git a/doc/man/nvme_sanitize_sanact.2 b/doc/man/nvme_sanitize_sanact.2 new file mode 100644 index 0000000..13d1163 --- /dev/null +++ b/doc/man/nvme_sanitize_sanact.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_sanitize_sanact" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_sanitize_sanact \- Sanitize Action +.SH SYNOPSIS +enum nvme_sanitize_sanact { +.br +.BI " NVME_SANITIZE_SANACT_EXIT_FAILURE" +, +.br +.br +.BI " NVME_SANITIZE_SANACT_START_BLOCK_ERASE" +, +.br +.br +.BI " NVME_SANITIZE_SANACT_START_OVERWRITE" +, +.br +.br +.BI " NVME_SANITIZE_SANACT_START_CRYPTO_ERASE" + +}; +.SH Constants +.IP "NVME_SANITIZE_SANACT_EXIT_FAILURE" 12 +Exit Failure Mode. +.IP "NVME_SANITIZE_SANACT_START_BLOCK_ERASE" 12 +Start a Block Erase sanitize operation. +.IP "NVME_SANITIZE_SANACT_START_OVERWRITE" 12 +Start an Overwrite sanitize operation. +.IP "NVME_SANITIZE_SANACT_START_CRYPTO_ERASE" 12 +Start a Crypto Erase sanitize operation. diff --git a/doc/man/nvme_sanitize_sstat.2 b/doc/man/nvme_sanitize_sstat.2 new file mode 100644 index 0000000..abe4334 --- /dev/null +++ b/doc/man/nvme_sanitize_sstat.2 @@ -0,0 +1,105 @@ +.TH "libnvme" 9 "enum nvme_sanitize_sstat" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_sanitize_sstat \- Sanitize Status (SSTAT) +.SH SYNOPSIS +enum nvme_sanitize_sstat { +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_SHIFT" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_MASK" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK" +, +.br +.br +.BI " NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED" + +}; +.SH Constants +.IP "NVME_SANITIZE_SSTAT_STATUS_SHIFT" 12 +Shift amount to get the status value of +the most recent sanitize operation from +the \fIstruct nvme_sanitize_log_page\fP.sstat +field. +.IP "NVME_SANITIZE_SSTAT_STATUS_MASK" 12 +Mask to get the status value of the most +recent sanitize operation. +.IP "NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED" 12 +The NVM subsystem has never been +sanitized. +.IP "NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS" 12 +The most recent sanitize operation +completed successfully including any +additional media modification. +.IP "NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS" 12 +A sanitize operation is currently in progress. +.IP "NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED" 12 +The most recent sanitize operation +failed. +.IP "NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS" 12 +The most recent sanitize operation +for which No-Deallocate After Sanitize was +requested has completed successfully with +deallocation of all user data. +.IP "NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT" 12 +Shift amount to get the number +of completed passes if the most recent +sanitize operation was an Overwrite. This +value shall be cleared to 0h if the most +recent sanitize operation was not +an Overwrite. +.IP "NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK" 12 +Mask to get the number of completed +passes. +.IP "NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT" 12 +Shift amount to get the Global +Data Erased value from the +\fIstruct nvme_sanitize_log_page\fP.sstat field. +.IP "NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK" 12 +Mask to get the Global Data Erased +value. +.IP "NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED" 12 +Global Data Erased: if set, then no +namespace user data in the NVM subsystem +has been written to and no Persistent +Memory Region in the NVM subsystem has +been enabled since being manufactured and +the NVM subsystem has never been sanitized; +or since the most recent successful sanitize +operation. diff --git a/doc/man/nvme_sanitize_start_event.2 b/doc/man/nvme_sanitize_start_event.2 new file mode 100644 index 0000000..36ea6ea --- /dev/null +++ b/doc/man/nvme_sanitize_start_event.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_sanitize_start_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_sanitize_start_event \- +.SH SYNOPSIS +struct nvme_sanitize_start_event { +.br +.BI " __le32 sani_cap;" +.br +.BI " __le32 sani_cdw10;" +.br +.BI " __le32 sani_cdw11;" +.br +.BI " +}; +.br + +.SH Members +.IP "sani_cap" 12 +SANICAP +.IP "sani_cdw10" 12 +Sanitize CDW10 +.IP "sani_cdw11" 12 +Sanitize CDW11 diff --git a/doc/man/nvme_scan.2 b/doc/man/nvme_scan.2 new file mode 100644 index 0000000..962e786 --- /dev/null +++ b/doc/man/nvme_scan.2 @@ -0,0 +1,11 @@ +.TH "nvme_scan" 9 "nvme_scan" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan \- Scan NVMe topology +.SH SYNOPSIS +.B "nvme_root_t" nvme_scan +.BI "(const char *config_file " ");" +.SH ARGUMENTS +.IP "config_file" 12 +Configuration file +.SH "RETURN" +nvme_root_t object of found elements diff --git a/doc/man/nvme_scan_ctrl.2 b/doc/man/nvme_scan_ctrl.2 new file mode 100644 index 0000000..bef86d0 --- /dev/null +++ b/doc/man/nvme_scan_ctrl.2 @@ -0,0 +1,16 @@ +.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_ctrl \- Scan on a controller +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_scan_ctrl +.BI "(nvme_root_t r " "," +.BI "const char *name " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.IP "name" 12 +Name of the controller +.SH "DESCRIPTION" +Scans a controller with sysfs name \fIname\fP and add it to \fIr\fP. +.SH "RETURN" +nvme_ctrl_t object diff --git a/doc/man/nvme_scan_ctrl_namespace_paths.2 b/doc/man/nvme_scan_ctrl_namespace_paths.2 new file mode 100644 index 0000000..db2549e --- /dev/null +++ b/doc/man/nvme_scan_ctrl_namespace_paths.2 @@ -0,0 +1,14 @@ +.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_ctrl_namespace_paths \- Scan for namespace paths in a controller +.SH SYNOPSIS +.B "int" nvme_scan_ctrl_namespace_paths +.BI "(nvme_ctrl_t c " "," +.BI "struct dirent ***paths " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller to scan +.IP "paths" 12 +Pointer to array of dirents +.SH "RETURN" +number of entries in \fIpaths\fP diff --git a/doc/man/nvme_scan_ctrl_namespaces.2 b/doc/man/nvme_scan_ctrl_namespaces.2 new file mode 100644 index 0000000..aba1eca --- /dev/null +++ b/doc/man/nvme_scan_ctrl_namespaces.2 @@ -0,0 +1,14 @@ +.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_ctrl_namespaces \- Scan for namespaces in a controller +.SH SYNOPSIS +.B "int" nvme_scan_ctrl_namespaces +.BI "(nvme_ctrl_t c " "," +.BI "struct dirent ***ns " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller to scan +.IP "ns" 12 +Pointer to array of dirents +.SH "RETURN" +number of entries in \fIns\fP diff --git a/doc/man/nvme_scan_ctrls.2 b/doc/man/nvme_scan_ctrls.2 new file mode 100644 index 0000000..9c04e6c --- /dev/null +++ b/doc/man/nvme_scan_ctrls.2 @@ -0,0 +1,11 @@ +.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_ctrls \- Scan for controllers +.SH SYNOPSIS +.B "int" nvme_scan_ctrls +.BI "(struct dirent ***ctrls " ");" +.SH ARGUMENTS +.IP "ctrls" 12 +Pointer to array of dirents +.SH "RETURN" +number of entries in \fIctrls\fP diff --git a/doc/man/nvme_scan_namespace.2 b/doc/man/nvme_scan_namespace.2 new file mode 100644 index 0000000..a4c8f83 --- /dev/null +++ b/doc/man/nvme_scan_namespace.2 @@ -0,0 +1,11 @@ +.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_namespace \- scan namespace based on sysfs name +.SH SYNOPSIS +.B "nvme_ns_t" nvme_scan_namespace +.BI "(const char *name " ");" +.SH ARGUMENTS +.IP "name" 12 +sysfs name of the namespace to scan +.SH "RETURN" +nvme_ns_t object or NULL if not found. diff --git a/doc/man/nvme_scan_subsystem_namespaces.2 b/doc/man/nvme_scan_subsystem_namespaces.2 new file mode 100644 index 0000000..2915fa1 --- /dev/null +++ b/doc/man/nvme_scan_subsystem_namespaces.2 @@ -0,0 +1,14 @@ +.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_subsystem_namespaces \- Scan for namespaces in a subsystem +.SH SYNOPSIS +.B "int" nvme_scan_subsystem_namespaces +.BI "(nvme_subsystem_t s " "," +.BI "struct dirent ***ns " ");" +.SH ARGUMENTS +.IP "s" 12 +Subsystem to scan +.IP "ns" 12 +Pointer to array of dirents +.SH "RETURN" +number of entries in \fIns\fP diff --git a/doc/man/nvme_scan_subsystems.2 b/doc/man/nvme_scan_subsystems.2 new file mode 100644 index 0000000..48e0eb8 --- /dev/null +++ b/doc/man/nvme_scan_subsystems.2 @@ -0,0 +1,11 @@ +.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_subsystems \- Scan for subsystems +.SH SYNOPSIS +.B "int" nvme_scan_subsystems +.BI "(struct dirent ***subsys " ");" +.SH ARGUMENTS +.IP "subsys" 12 +Pointer to array of dirents +.SH "RETURN" +number of entries in \fIsubsys\fP diff --git a/doc/man/nvme_scan_topology.2 b/doc/man/nvme_scan_topology.2 new file mode 100644 index 0000000..602d8ae --- /dev/null +++ b/doc/man/nvme_scan_topology.2 @@ -0,0 +1,20 @@ +.TH "nvme_scan_topology" 9 "nvme_scan_topology" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_scan_topology \- Scan NVMe topology and apply filter +.SH SYNOPSIS +.B "int" nvme_scan_topology +.BI "(nvme_root_t r " "," +.BI "nvme_scan_filter_t f " "," +.BI "void *f_args " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.IP "f" 12 +filter to apply +.IP "f_args" 12 +user-specified argument to \fIf\fP +.SH "DESCRIPTION" +Scans the NVMe topology and filters out the resulting elements +by applying \fIf\fP. +.SH "RETURN" +Number of elements scanned diff --git a/doc/man/nvme_secondary_ctrl.2 b/doc/man/nvme_secondary_ctrl.2 new file mode 100644 index 0000000..b6eb2bd --- /dev/null +++ b/doc/man/nvme_secondary_ctrl.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "struct nvme_secondary_ctrl" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_secondary_ctrl \- +.SH SYNOPSIS +struct nvme_secondary_ctrl { +.br +.BI " __le16 scid;" +.br +.BI " __le16 pcid;" +.br +.BI " __u8 scs;" +.br +.BI " __u8 rsvd5[3];" +.br +.BI " __le16 vfn;" +.br +.BI " __le16 nvq;" +.br +.BI " __le16 nvi;" +.br +.BI " __u8 rsvd14[18];" +.br +.BI " +}; +.br + +.SH Members +.IP "scid" 12 +Secondary Controller Identifier +.IP "pcid" 12 +Primary Controller Identifier +.IP "scs" 12 +Secondary Controller State +.IP "rsvd5" 12 +Reserved +.IP "vfn" 12 +Virtual Function Number +.IP "nvq" 12 +Number of VQ Flexible Resources Assigned +.IP "nvi" 12 +Number of VI Flexible Resources Assigned +.IP "rsvd14" 12 +Reserved diff --git a/doc/man/nvme_secondary_ctrl_list.2 b/doc/man/nvme_secondary_ctrl_list.2 new file mode 100644 index 0000000..69afc87 --- /dev/null +++ b/doc/man/nvme_secondary_ctrl_list.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_secondary_ctrl_list \- +.SH SYNOPSIS +struct nvme_secondary_ctrl_list { +.br +.BI " __u8 num;" +.br +.BI " __u8 rsvd[31];" +.br +.BI " struct nvme_secondary_ctrl sc_entry[NVME_ID_SECONDARY_CTRL_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "num" 12 +Number of Identifiers +.IP "rsvd" 12 +Reserved +.IP "sc_entry" 12 +Secondary Controller Entry diff --git a/doc/man/nvme_security_receive.2 b/doc/man/nvme_security_receive.2 new file mode 100644 index 0000000..008e6d0 --- /dev/null +++ b/doc/man/nvme_security_receive.2 @@ -0,0 +1,12 @@ +.TH "nvme_security_receive" 9 "nvme_security_receive" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_security_receive \- +.SH SYNOPSIS +.B "int" nvme_security_receive +.BI "(struct nvme_security_receive_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_security_recevice\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_security_receive_args.2 b/doc/man/nvme_security_receive_args.2 new file mode 100644 index 0000000..220d3ce --- /dev/null +++ b/doc/man/nvme_security_receive_args.2 @@ -0,0 +1,59 @@ +.TH "libnvme" 9 "struct nvme_security_receive_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_security_receive_args \- Arguments for the NVMe Security Receive command +.SH SYNOPSIS +struct nvme_security_receive_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 al;" +.br +.BI " __u32 data_len;" +.br +.BI " __u8 nssf;" +.br +.BI " __u8 spsp0;" +.br +.BI " __u8 spsp1;" +.br +.BI " __u8 secp;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Security data payload to send +.IP "args_size" 12 +Size of \fIstruct nvme_security_receive_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID to issue security command on +.IP "al" 12 +Protocol specific allocation length +.IP "data_len" 12 +Data length of the payload in bytes +.IP "nssf" 12 +NVMe Security Specific field +.IP "spsp0" 12 +Security Protocol Specific field +.IP "spsp1" 12 +Security Protocol Specific field +.IP "secp" 12 +Security Protocol diff --git a/doc/man/nvme_security_send.2 b/doc/man/nvme_security_send.2 new file mode 100644 index 0000000..cadb73f --- /dev/null +++ b/doc/man/nvme_security_send.2 @@ -0,0 +1,21 @@ +.TH "nvme_security_send" 9 "nvme_security_send" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_security_send \- +.SH SYNOPSIS +.B "int" nvme_security_send +.BI "(struct nvme_security_send_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_security_send\fP argument structure +.SH "DESCRIPTION" +The Security Send command transfers security protocol data to the +controller. The data structure transferred to the controller as part of this +command contains security protocol specific commands to be performed by the +controller. The data structure transferred may also contain data or +parameters associated with the security protocol commands. + +The security data is protocol specific and is not defined by the NVMe +specification. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_security_send_args.2 b/doc/man/nvme_security_send_args.2 new file mode 100644 index 0000000..ac9272b --- /dev/null +++ b/doc/man/nvme_security_send_args.2 @@ -0,0 +1,59 @@ +.TH "libnvme" 9 "struct nvme_security_send_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_security_send_args \- Arguments for the NVMe Security Send command +.SH SYNOPSIS +struct nvme_security_send_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 tl;" +.br +.BI " __u32 data_len;" +.br +.BI " __u8 nssf;" +.br +.BI " __u8 spsp0;" +.br +.BI " __u8 spsp1;" +.br +.BI " __u8 secp;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Security data payload to send +.IP "args_size" 12 +Size of \fIstruct nvme_security_send_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID to issue security command on +.IP "tl" 12 +Protocol specific transfer length +.IP "data_len" 12 +Data length of the payload in bytes +.IP "nssf" 12 +NVMe Security Specific field +.IP "spsp0" 12 +Security Protocol Specific field +.IP "spsp1" 12 +Security Protocol Specific field +.IP "secp" 12 +Security Protocol diff --git a/doc/man/nvme_self_test_log.2 b/doc/man/nvme_self_test_log.2 new file mode 100644 index 0000000..f46cd21 --- /dev/null +++ b/doc/man/nvme_self_test_log.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "struct nvme_self_test_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_self_test_log \- Device Self-test (Log Identifier 06h) +.SH SYNOPSIS +struct nvme_self_test_log { +.br +.BI " __u8 current_operation;" +.br +.BI " __u8 completion;" +.br +.BI " __u8 rsvd[2];" +.br +.BI " struct nvme_st_result result[NVME_LOG_ST_MAX_RESULTS];" +.br +.BI " +}; +.br + +.SH Members +.IP "current_operation" 12 +Current Device Self-Test Operation: indicates the status +of the current device self-test operation. If a device +self-test operation is in process (i.e., this field is set +to #NVME_ST_CURR_OP_SHORT or #NVME_ST_CURR_OP_EXTENDED), +then the controller shall not set this field to +#NVME_ST_CURR_OP_NOT_RUNNING until a new Self-test Result +Data Structure is created (i.e., if a device self-test +operation completes or is aborted, then the controller +shall create a Self-test Result Data Structure prior to +setting this field to #NVME_ST_CURR_OP_NOT_RUNNING). +See \fIenum nvme_st_curr_op\fP. +.IP "completion" 12 +Current Device Self-Test Completion: indicates the percentage +of the device self-test operation that is complete (e.g., +a value of 25 indicates that 25% of the device self-test +operation is complete and 75% remains to be tested). +If the \fIcurrent_operation\fP field is cleared to +#NVME_ST_CURR_OP_NOT_RUNNING (indicating there is no device +self-test operation in progress), then this field is ignored. +.IP "rsvd" 12 +Reserved +.IP "result" 12 +Self-test Result Data Structures, see \fIstruct nvme_st_result\fP. diff --git a/doc/man/nvme_set_feature_event.2 b/doc/man/nvme_set_feature_event.2 new file mode 100644 index 0000000..00050af --- /dev/null +++ b/doc/man/nvme_set_feature_event.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_set_feature_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_set_feature_event \- +.SH SYNOPSIS +struct nvme_set_feature_event { +.br +.BI " __le32 layout;" +.br +.BI " __le32 cdw_mem[0];" +.br +.BI " +}; +.br + +.SH Members +.IP "layout" 12 +Set Feature Event Layout +.IP "cdw_mem" 12 +Command Dwords Memory buffer diff --git a/doc/man/nvme_set_features.2 b/doc/man/nvme_set_features.2 new file mode 100644 index 0000000..9a41c06 --- /dev/null +++ b/doc/man/nvme_set_features.2 @@ -0,0 +1,12 @@ +.TH "nvme_set_features" 9 "nvme_set_features" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features \- Set a feature attribute +.SH SYNOPSIS +.B "int" nvme_set_features +.BI "(struct nvme_set_features_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_set_features_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_arbitration.2 b/doc/man/nvme_set_features_arbitration.2 new file mode 100644 index 0000000..141d152 --- /dev/null +++ b/doc/man/nvme_set_features_arbitration.2 @@ -0,0 +1,30 @@ +.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_arbitration \- +.SH SYNOPSIS +.B "int" nvme_set_features_arbitration +.BI "(int fd " "," +.BI "__u8 ab " "," +.BI "__u8 lpw " "," +.BI "__u8 mpw " "," +.BI "__u8 hpw " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "ab" 12 +Arbitration Burst +.IP "lpw" 12 +Low Priority Weight +.IP "mpw" 12 +Medium Priority Weight +.IP "hpw" 12 +High Priority Weight +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_args.2 b/doc/man/nvme_set_features_args.2 new file mode 100644 index 0000000..9c15083 --- /dev/null +++ b/doc/man/nvme_set_features_args.2 @@ -0,0 +1,65 @@ +.TH "libnvme" 9 "struct nvme_set_features_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_set_features_args \- Arguments for the NVMe Admin Set Feature command +.SH SYNOPSIS +struct nvme_set_features_args { +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 cdw11;" +.br +.BI " __u32 cdw12;" +.br +.BI " __u32 cdw13;" +.br +.BI " __u32 cdw15;" +.br +.BI " __u32 data_len;" +.br +.BI " bool save;" +.br +.BI " __u8 uuidx;" +.br +.BI " __u8 fid;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +User address of feature data, if applicable +.IP "args_size" 12 +Size of \fIstruct nvme_set_features_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID, if applicable +.IP "cdw11" 12 +Value to set the feature to +.IP "cdw12" 12 +Feature specific command dword12 field +.IP "cdw15" 12 +Feature specific command dword15 field +.IP "data_len" 12 +Length of feature data, if applicable, in bytes +.IP "save" 12 +Save value across power states +.IP "uuidx" 12 +UUID Index for differentiating vendor specific encoding +.IP "fid" 12 +Feature identifier diff --git a/doc/man/nvme_set_features_async_event.2 b/doc/man/nvme_set_features_async_event.2 new file mode 100644 index 0000000..e8084db --- /dev/null +++ b/doc/man/nvme_set_features_async_event.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_async_event \- +.SH SYNOPSIS +.B "int" nvme_set_features_async_event +.BI "(int fd " "," +.BI "__u32 events " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "events" 12 +Events to enable +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_auto_pst.2 b/doc/man/nvme_set_features_auto_pst.2 new file mode 100644 index 0000000..21597e2 --- /dev/null +++ b/doc/man/nvme_set_features_auto_pst.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_auto_pst \- +.SH SYNOPSIS +.B "int" nvme_set_features_auto_pst +.BI "(int fd " "," +.BI "bool apste " "," +.BI "bool save " "," +.BI "struct nvme_feat_auto_pst *apst " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "apste" 12 +Autonomous Power State Transition Enable +.IP "save" 12 +Save value across power states +.IP "apst" 12 +Autonomous Power State Transition +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_data.2 b/doc/man/nvme_set_features_data.2 new file mode 100644 index 0000000..43e81bf --- /dev/null +++ b/doc/man/nvme_set_features_data.2 @@ -0,0 +1,30 @@ +.TH "nvme_set_features_data" 9 "nvme_set_features_data" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_data \- Helper function for @nvme_set_features() +.SH SYNOPSIS +.B "int" nvme_set_features_data +.BI "(int fd " "," +.BI "__u8 fid " "," +.BI "__u32 nsid " "," +.BI "__u32 cdw11 " "," +.BI "bool save " "," +.BI "__u32 data_len " "," +.BI "void *data " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "fid" 12 +Feature identifier +.IP "nsid" 12 +Namespace ID, if applicable +.IP "cdw11" 12 +Value to set the feature to +.IP "save" 12 +Save value across power states +.IP "data_len" 12 +Length of feature data, if applicable, in bytes +.IP "data" 12 +User address of feature data, if applicable +.IP "result" 12 +The command completion result from CQE dword0 diff --git a/doc/man/nvme_set_features_endurance_evt_cfg.2 b/doc/man/nvme_set_features_endurance_evt_cfg.2 new file mode 100644 index 0000000..c8e796a --- /dev/null +++ b/doc/man/nvme_set_features_endurance_evt_cfg.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_endurance_evt_cfg \- +.SH SYNOPSIS +.B "int" nvme_set_features_endurance_evt_cfg +.BI "(int fd " "," +.BI "__u16 endgid " "," +.BI "__u8 egwarn " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "endgid" 12 +Endurance Group Identifier +.IP "egwarn" 12 +Flags to enable warning, see \fIenum nvme_eg_critical_warning_flags\fP +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_err_recovery.2 b/doc/man/nvme_set_features_err_recovery.2 new file mode 100644 index 0000000..69de02e --- /dev/null +++ b/doc/man/nvme_set_features_err_recovery.2 @@ -0,0 +1,27 @@ +.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_err_recovery \- +.SH SYNOPSIS +.B "int" nvme_set_features_err_recovery +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u16 tler " "," +.BI "bool dulbe " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "tler" 12 +Time-limited error recovery value +.IP "dulbe" 12 +Deallocated or Unwritten Logical Block Error Enable +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_hctm.2 b/doc/man/nvme_set_features_hctm.2 new file mode 100644 index 0000000..6b47711 --- /dev/null +++ b/doc/man/nvme_set_features_hctm.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_hctm \- +.SH SYNOPSIS +.B "int" nvme_set_features_hctm +.BI "(int fd " "," +.BI "__u16 tmt2 " "," +.BI "__u16 tmt1 " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "tmt2" 12 +Thermal Management Temperature 2 +.IP "tmt1" 12 +Thermal Management Temperature 1 +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_host_behavior.2 b/doc/man/nvme_set_features_host_behavior.2 new file mode 100644 index 0000000..271dbb2 --- /dev/null +++ b/doc/man/nvme_set_features_host_behavior.2 @@ -0,0 +1,18 @@ +.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_host_behavior \- +.SH SYNOPSIS +.B "int" nvme_set_features_host_behavior +.BI "(int fd " "," +.BI "bool save " "," +.BI "struct nvme_feat_host_behavior *data " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "save" 12 +Save value across power states +.IP "data" 12 +Pointer to structure nvme_feat_host_behavior +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_host_id.2 b/doc/man/nvme_set_features_host_id.2 new file mode 100644 index 0000000..09de5d5 --- /dev/null +++ b/doc/man/nvme_set_features_host_id.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_host_id \- +.SH SYNOPSIS +.B "int" nvme_set_features_host_id +.BI "(int fd " "," +.BI "bool exhid " "," +.BI "bool save " "," +.BI "__u8 *hostid " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "exhid" 12 +Enable Extended Host Identifier +.IP "save" 12 +Save value across power states +.IP "hostid" 12 +Host ID to set +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_irq_coalesce.2 b/doc/man/nvme_set_features_irq_coalesce.2 new file mode 100644 index 0000000..58d2e3f --- /dev/null +++ b/doc/man/nvme_set_features_irq_coalesce.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_irq_coalesce \- +.SH SYNOPSIS +.B "int" nvme_set_features_irq_coalesce +.BI "(int fd " "," +.BI "__u8 thr " "," +.BI "__u8 time " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "thr" 12 +Aggregation Threshold +.IP "time" 12 +Aggregation Time +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_irq_config.2 b/doc/man/nvme_set_features_irq_config.2 new file mode 100644 index 0000000..ffce575 --- /dev/null +++ b/doc/man/nvme_set_features_irq_config.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_irq_config \- +.SH SYNOPSIS +.B "int" nvme_set_features_irq_config +.BI "(int fd " "," +.BI "__u16 iv " "," +.BI "bool cd " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "iv" 12 +Interrupt Vector +.IP "cd" 12 +Coalescing Disable +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_lba_range.2 b/doc/man/nvme_set_features_lba_range.2 new file mode 100644 index 0000000..94ca62d --- /dev/null +++ b/doc/man/nvme_set_features_lba_range.2 @@ -0,0 +1,27 @@ +.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_lba_range \- +.SH SYNOPSIS +.B "int" nvme_set_features_lba_range +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u32 nr_ranges " "," +.BI "bool save " "," +.BI "struct nvme_lba_range_type *data " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "nr_ranges" 12 +Number of ranges in \fIdata\fP +.IP "save" 12 +Save value across power states +.IP "data" 12 +User address of feature data +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_lba_sts_interval.2 b/doc/man/nvme_set_features_lba_sts_interval.2 new file mode 100644 index 0000000..1507a76 --- /dev/null +++ b/doc/man/nvme_set_features_lba_sts_interval.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_lba_sts_interval \- +.SH SYNOPSIS +.B "int" nvme_set_features_lba_sts_interval +.BI "(int fd " "," +.BI "__u16 lsiri " "," +.BI "__u16 lsipi " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "lsiri" 12 +LBA Status Information Report Interval +.IP "lsipi" 12 +LBA Status Information Poll Interval +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_nopsc.2 b/doc/man/nvme_set_features_nopsc.2 new file mode 100644 index 0000000..c3ed464 --- /dev/null +++ b/doc/man/nvme_set_features_nopsc.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_nopsc \- +.SH SYNOPSIS +.B "int" nvme_set_features_nopsc +.BI "(int fd " "," +.BI "bool noppme " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "noppme" 12 +Non-Operational Power State Permissive Mode Enable +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_plm_config.2 b/doc/man/nvme_set_features_plm_config.2 new file mode 100644 index 0000000..3443b6f --- /dev/null +++ b/doc/man/nvme_set_features_plm_config.2 @@ -0,0 +1,27 @@ +.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_plm_config \- +.SH SYNOPSIS +.B "int" nvme_set_features_plm_config +.BI "(int fd " "," +.BI "bool enable " "," +.BI "__u16 nvmsetid " "," +.BI "bool save " "," +.BI "struct nvme_plm_config *data " "," +.BI "__u32*result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "enable" 12 +Predictable Latency Enable +.IP "nvmsetid" 12 +NVM Set Identifier +.IP "save" 12 +Save value across power states +.IP "data" 12 +Pointer to structure nvme_plm_config +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_plm_window.2 b/doc/man/nvme_set_features_plm_window.2 new file mode 100644 index 0000000..66cf86d --- /dev/null +++ b/doc/man/nvme_set_features_plm_window.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_plm_window \- +.SH SYNOPSIS +.B "int" nvme_set_features_plm_window +.BI "(int fd " "," +.BI "enum nvme_feat_plm_window_select sel " "," +.BI "__u16 nvmsetid " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "sel" 12 +Window Select +.IP "nvmsetid" 12 +NVM Set Identifier +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_power_mgmt.2 b/doc/man/nvme_set_features_power_mgmt.2 new file mode 100644 index 0000000..1cce50e --- /dev/null +++ b/doc/man/nvme_set_features_power_mgmt.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_power_mgmt \- +.SH SYNOPSIS +.B "int" nvme_set_features_power_mgmt +.BI "(int fd " "," +.BI "__u8 ps " "," +.BI "__u8 wh " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "ps" 12 +Power State +.IP "wh" 12 +Workload Hint +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_resv_mask.2 b/doc/man/nvme_set_features_resv_mask.2 new file mode 100644 index 0000000..5804011 --- /dev/null +++ b/doc/man/nvme_set_features_resv_mask.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_resv_mask \- +.SH SYNOPSIS +.B "int" nvme_set_features_resv_mask +.BI "(int fd " "," +.BI "__u32 mask " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "mask" 12 +Reservation Notification Mask Field +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_resv_persist.2 b/doc/man/nvme_set_features_resv_persist.2 new file mode 100644 index 0000000..e487d6f --- /dev/null +++ b/doc/man/nvme_set_features_resv_persist.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_resv_persist \- +.SH SYNOPSIS +.B "int" nvme_set_features_resv_persist +.BI "(int fd " "," +.BI "bool ptpl " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "ptpl" 12 +Persist Through Power Loss +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_rrl.2 b/doc/man/nvme_set_features_rrl.2 new file mode 100644 index 0000000..d2b264c --- /dev/null +++ b/doc/man/nvme_set_features_rrl.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_rrl \- +.SH SYNOPSIS +.B "int" nvme_set_features_rrl +.BI "(int fd " "," +.BI "__u8 rrl " "," +.BI "__u16 nvmsetid " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "rrl" 12 +Read recovery level setting +.IP "nvmsetid" 12 +NVM set id +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_sanitize.2 b/doc/man/nvme_set_features_sanitize.2 new file mode 100644 index 0000000..c1fe032 --- /dev/null +++ b/doc/man/nvme_set_features_sanitize.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_sanitize \- +.SH SYNOPSIS +.B "int" nvme_set_features_sanitize +.BI "(int fd " "," +.BI "bool nodrm " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nodrm" 12 +No-Deallocate Response Mode +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_simple.2 b/doc/man/nvme_set_features_simple.2 new file mode 100644 index 0000000..3a1d8de --- /dev/null +++ b/doc/man/nvme_set_features_simple.2 @@ -0,0 +1,24 @@ +.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_simple \- Helper functionn for @nvme_set_features() +.SH SYNOPSIS +.B "int" nvme_set_features_simple +.BI "(int fd " "," +.BI "__u8 fid " "," +.BI "__u32 nsid " "," +.BI "__u32 cdw11 " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "fid" 12 +Feature identifier +.IP "nsid" 12 +Namespace ID, if applicable +.IP "cdw11" 12 +Value to set the feature to +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 diff --git a/doc/man/nvme_set_features_sw_progress.2 b/doc/man/nvme_set_features_sw_progress.2 new file mode 100644 index 0000000..eb48ccd --- /dev/null +++ b/doc/man/nvme_set_features_sw_progress.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_sw_progress \- +.SH SYNOPSIS +.B "int" nvme_set_features_sw_progress +.BI "(int fd " "," +.BI "__u8 pbslc " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "pbslc" 12 +Pre-boot Software Load Count +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_temp_thresh.2 b/doc/man/nvme_set_features_temp_thresh.2 new file mode 100644 index 0000000..ae653c1 --- /dev/null +++ b/doc/man/nvme_set_features_temp_thresh.2 @@ -0,0 +1,27 @@ +.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_temp_thresh \- +.SH SYNOPSIS +.B "int" nvme_set_features_temp_thresh +.BI "(int fd " "," +.BI "__u16 tmpth " "," +.BI "__u8 tmpsel " "," +.BI "enum nvme_feat_tmpthresh_thsel thsel " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "tmpth" 12 +Temperature Threshold +.IP "tmpsel" 12 +Threshold Temperature Select +.IP "thsel" 12 +Threshold Type Select +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_timestamp.2 b/doc/man/nvme_set_features_timestamp.2 new file mode 100644 index 0000000..f286a0d --- /dev/null +++ b/doc/man/nvme_set_features_timestamp.2 @@ -0,0 +1,18 @@ +.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_timestamp \- +.SH SYNOPSIS +.B "int" nvme_set_features_timestamp +.BI "(int fd " "," +.BI "bool save " "," +.BI "__u64 timestamp " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "save" 12 +Save value across power states +.IP "timestamp" 12 +The current timestamp value to assign to this this feature +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_volatile_wc.2 b/doc/man/nvme_set_features_volatile_wc.2 new file mode 100644 index 0000000..4ec60c8 --- /dev/null +++ b/doc/man/nvme_set_features_volatile_wc.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_volatile_wc \- +.SH SYNOPSIS +.B "int" nvme_set_features_volatile_wc +.BI "(int fd " "," +.BI "bool wce " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "wce" 12 +Write cache enable +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_write_atomic.2 b/doc/man/nvme_set_features_write_atomic.2 new file mode 100644 index 0000000..5037a0b --- /dev/null +++ b/doc/man/nvme_set_features_write_atomic.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_write_atomic \- +.SH SYNOPSIS +.B "int" nvme_set_features_write_atomic +.BI "(int fd " "," +.BI "bool dn " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "dn" 12 +Disable Normal +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_write_protect.2 b/doc/man/nvme_set_features_write_protect.2 new file mode 100644 index 0000000..e87dfe1 --- /dev/null +++ b/doc/man/nvme_set_features_write_protect.2 @@ -0,0 +1,21 @@ +.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_features_write_protect \- +.SH SYNOPSIS +.B "int" nvme_set_features_write_protect +.BI "(int fd " "," +.BI "enum nvme_feat_nswpcfg_state state " "," +.BI "bool save " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "state" 12 +Write Protection State +.IP "save" 12 +Save value across power states +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_property.2 b/doc/man/nvme_set_property.2 new file mode 100644 index 0000000..6d484a1 --- /dev/null +++ b/doc/man/nvme_set_property.2 @@ -0,0 +1,15 @@ +.TH "nvme_set_property" 9 "nvme_set_property" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_set_property \- Set controller property +.SH SYNOPSIS +.B "int" nvme_set_property +.BI "(struct nvme_set_property_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_set_property_args\fP argument structure +.SH "DESCRIPTION" +This is an NVMe-over-Fabrics specific command, not applicable to PCIe. These +properties align to the PCI MMIO controller registers. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_property_args.2 b/doc/man/nvme_set_property_args.2 new file mode 100644 index 0000000..3d40857 --- /dev/null +++ b/doc/man/nvme_set_property_args.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvme_set_property_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_set_property_args \- Arguments for NVMe Set Property command +.SH SYNOPSIS +struct nvme_set_property_args { +.br +.BI " __u64 value;" +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " int offset;" +.br +.BI " +}; +.br + +.SH Members +.IP "value" 12 +The value to set the property +.IP "result" 12 +The command completion result from CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_set_property_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "offset" 12 +Property offset from the base to set diff --git a/doc/man/nvme_smart_crit.2 b/doc/man/nvme_smart_crit.2 new file mode 100644 index 0000000..9a23b81 --- /dev/null +++ b/doc/man/nvme_smart_crit.2 @@ -0,0 +1,54 @@ +.TH "libnvme" 9 "enum nvme_smart_crit" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_smart_crit \- Critical Warning +.SH SYNOPSIS +enum nvme_smart_crit { +.br +.BI " NVME_SMART_CRIT_SPARE" +, +.br +.br +.BI " NVME_SMART_CRIT_TEMPERATURE" +, +.br +.br +.BI " NVME_SMART_CRIT_DEGRADED" +, +.br +.br +.BI " NVME_SMART_CRIT_MEDIA" +, +.br +.br +.BI " NVME_SMART_CRIT_VOLATILE_MEMORY" +, +.br +.br +.BI " NVME_SMART_CRIT_PMR_RO" + +}; +.SH Constants +.IP "NVME_SMART_CRIT_SPARE" 12 +If set, then the available spare capacity has fallen +below the threshold. +.IP "NVME_SMART_CRIT_TEMPERATURE" 12 +If set, then a temperature is either greater +than or equal to an over temperature threshold; or +less than or equal to an under temperature threshold. +.IP "NVME_SMART_CRIT_DEGRADED" 12 +If set, then the NVM subsystem reliability has +been degraded due to significant media related errors +or any internal error that degrades NVM subsystem +reliability. +.IP "NVME_SMART_CRIT_MEDIA" 12 +If set, then all of the media has been placed in read +only mode. The controller shall not set this bit if +the read-only condition on the media is a result of +a change in the write protection state of a namespace. +.IP "NVME_SMART_CRIT_VOLATILE_MEMORY" 12 +If set, then the volatile memory backup +device has failed. This field is only valid if the +controller has a volatile memory backup solution. +.IP "NVME_SMART_CRIT_PMR_RO" 12 +If set, then the Persistent Memory Region has become +read-only or unreliable. diff --git a/doc/man/nvme_smart_egcw.2 b/doc/man/nvme_smart_egcw.2 new file mode 100644 index 0000000..9bb08a9 --- /dev/null +++ b/doc/man/nvme_smart_egcw.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "enum nvme_smart_egcw" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_smart_egcw \- Endurance Group Critical Warning Summary +.SH SYNOPSIS +enum nvme_smart_egcw { +.br +.BI " NVME_SMART_EGCW_SPARE" +, +.br +.br +.BI " NVME_SMART_EGCW_DEGRADED" +, +.br +.br +.BI " NVME_SMART_EGCW_RO" + +}; +.SH Constants +.IP "NVME_SMART_EGCW_SPARE" 12 +If set, then the available spare capacity of one or +more Endurance Groups has fallen below the threshold. +.IP "NVME_SMART_EGCW_DEGRADED" 12 +If set, then the reliability of one or more +Endurance Groups has been degraded due to significant +media related errors or any internal error that +degrades NVM subsystem reliability. +.IP "NVME_SMART_EGCW_RO" 12 +If set, then the namespaces in one or more Endurance +Groups have been placed in read only mode not as +a result of a change in the write protection state +of a namespace. diff --git a/doc/man/nvme_smart_log.2 b/doc/man/nvme_smart_log.2 new file mode 100644 index 0000000..beac84c --- /dev/null +++ b/doc/man/nvme_smart_log.2 @@ -0,0 +1,235 @@ +.TH "libnvme" 9 "struct nvme_smart_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_smart_log \- SMART / Health Information Log (Log Identifier 02h) +.SH SYNOPSIS +struct nvme_smart_log { +.br +.BI " __u8 critical_warning;" +.br +.BI " __u8 temperature[2];" +.br +.BI " __u8 avail_spare;" +.br +.BI " __u8 spare_thresh;" +.br +.BI " __u8 percent_used;" +.br +.BI " __u8 endu_grp_crit_warn_sumry;" +.br +.BI " __u8 rsvd7[25];" +.br +.BI " __u8 data_units_read[16];" +.br +.BI " __u8 data_units_written[16];" +.br +.BI " __u8 host_reads[16];" +.br +.BI " __u8 host_writes[16];" +.br +.BI " __u8 ctrl_busy_time[16];" +.br +.BI " __u8 power_cycles[16];" +.br +.BI " __u8 power_on_hours[16];" +.br +.BI " __u8 unsafe_shutdowns[16];" +.br +.BI " __u8 media_errors[16];" +.br +.BI " __u8 num_err_log_entries[16];" +.br +.BI " __le32 warning_temp_time;" +.br +.BI " __le32 critical_comp_time;" +.br +.BI " __le16 temp_sensor[8];" +.br +.BI " __le32 thm_temp1_trans_count;" +.br +.BI " __le32 thm_temp2_trans_count;" +.br +.BI " __le32 thm_temp1_total_time;" +.br +.BI " __le32 thm_temp2_total_time;" +.br +.BI " __u8 rsvd232[280];" +.br +.BI " +}; +.br + +.SH Members +.IP "critical_warning" 12 +This field indicates critical warnings for the state +of the controller. Critical warnings may result in an +asynchronous event notification to the host. Bits in +this field represent the current associated state and +are not persistent (see \fIenum nvme_smart_crit\fP). +.IP "temperature" 12 +Composite Temperature: Contains a value corresponding +to a temperature in Kelvins that represents the current +composite temperature of the controller and namespace(s) +associated with that controller. The manner in which +this value is computed is implementation specific and +may not represent the actual temperature of any physical +point in the NVM subsystem. Warning and critical +overheating composite temperature threshold values are +reported by the WCTEMP and CCTEMP fields in the Identify +Controller data structure. +.IP "avail_spare" 12 +Available Spare: Contains a normalized percentage (0% +to 100%) of the remaining spare capacity available. +.IP "spare_thresh" 12 +Available Spare Threshold: When the Available Spare +falls below the threshold indicated in this field, an +asynchronous event completion may occur. The value is +indicated as a normalized percentage (0% to 100%). +The values 101 to 255 are reserved. +.IP "percent_used" 12 +Percentage Used: Contains a vendor specific estimate +of the percentage of NVM subsystem life used based on +the actual usage and the manufacturer's prediction of +NVM life. A value of 100 indicates that the estimated +endurance of the NVM in the NVM subsystem has been +consumed, but may not indicate an NVM subsystem failure. +The value is allowed to exceed 100. Percentages greater +than 254 shall be represented as 255. This value shall +be updated once per power-on hour (when the controller +is not in a sleep state). +.IP "endu_grp_crit_warn_sumry" 12 +Endurance Group Critical Warning Summary: This field +indicates critical warnings for the state of Endurance +Groups. Bits in this field represent the current associated +state and are not persistent (see \fIenum nvme_smart_egcw\fP). +.IP "rsvd7" 12 +Reserved +.IP "data_units_read" 12 +Data Units Read: Contains the number of 512 byte data +units the host has read from the controller; this value +does not include metadata. This value is reported in +thousands (i.e., a value of 1 corresponds to 1000 +units of 512 bytes read) and is rounded up (e.g., one +indicates the that number of 512 byte data units read +is from 1 to 1000, three indicates that the number of +512 byte data units read is from 2001 to 3000). When +the LBA size is a value other than 512 bytes, the +controller shall convert the amount of data read to +512 byte units. For the NVM command set, logical blocks +read as part of Compare, Read, and Verify operations +shall be included in this value. A value of 0h in +this field indicates that the number of Data Units Read +is not reported. +.IP "data_units_written" 12 +Data Units Written: Contains the number of 512 byte +data units the host has written to the controller; +this value does not include metadata. This value is +reported in thousands (i.e., a value of 1 corresponds +to 1000 units of 512 bytes written) and is rounded up +(e.g., one indicates that the number of 512 byte data +units written is from 1 to 1,000, three indicates that +the number of 512 byte data units written is from 2001 +to 3000). When the LBA size is a value other than 512 +bytes, the controller shall convert the amount of data +written to 512 byte units. For the NVM command set, +logical blocks written as part of Write operations shall +be included in this value. Write Uncorrectable commands +and Write Zeroes commands shall not impact this value. +A value of 0h in this field indicates that the number +of Data Units Written is not reported. +.IP "host_reads" 12 +Host Read Commands: Contains the number of read commands +completed by the controller. For the NVM command set, +this value is the sum of the number of Compare commands +and the number of Read commands. +.IP "host_writes" 12 +Host Write Commands: Contains the number of write +commands completed by the controller. For the NVM +command set, this is the number of Write commands. +.IP "ctrl_busy_time" 12 +Controller Busy Time: Contains the amount of time the +controller is busy with I/O commands. The controller +is busy when there is a command outstanding to an I/O +Queue (specifically, a command was issued via an I/O +Submission Queue Tail doorbell write and the corresponding +completion queue entry has not been posted yet to the +associated I/O Completion Queue). This value is +reported in minutes. +.IP "power_cycles" 12 +Power Cycles: Contains the number of power cycles. +.IP "power_on_hours" 12 +Power On Hours: Contains the number of power-on hours. +This may not include time that the controller was +powered and in a non-operational power state. +.IP "unsafe_shutdowns" 12 +Unsafe Shutdowns: Contains the number of unsafe +shutdowns. This count is incremented when a Shutdown +Notification (CC.SHN) is not received prior to loss of power. +.IP "media_errors" 12 +Media and Data Integrity Errors: Contains the number +of occurrences where the controller detected an +unrecovered data integrity error. Errors such as +uncorrectable ECC, CRC checksum failure, or LBA tag +mismatch are included in this field. Errors introduced +as a result of a Write Uncorrectable command may or +may not be included in this field. +.IP "num_err_log_entries" 12 +Number of Error Information Log Entries: Contains the +number of Error Information log entries over the life +of the controller. +.IP "warning_temp_time" 12 +Warning Composite Temperature Time: Contains the amount +of time in minutes that the controller is operational +and the Composite Temperature is greater than or equal +to the Warning Composite Temperature Threshold (WCTEMP) +field and less than the Critical Composite Temperature +Threshold (CCTEMP) field in the Identify Controller +data structure. If the value of the WCTEMP or CCTEMP +field is 0h, then this field is always cleared to 0h +regardless of the Composite Temperature value. +.IP "critical_comp_time" 12 +Critical Composite Temperature Time: Contains the amount +of time in minutes that the controller is operational +and the Composite Temperature is greater than or equal +to the Critical Composite Temperature Threshold (CCTEMP) +field in the Identify Controller data structure. If +the value of the CCTEMP field is 0h, then this field +is always cleared to 0h regardless of the Composite +Temperature value. +.IP "temp_sensor" 12 +Temperature Sensor 1-8: Contains the current temperature +in degrees Kelvin reported by temperature sensors 1-8. +The physical point in the NVM subsystem whose temperature +is reported by the temperature sensor and the temperature +accuracy is implementation specific. An implementation +that does not implement the temperature sensor reports +a value of 0h. +.IP "thm_temp1_trans_count" 12 +Thermal Management Temperature 1 Transition Count: +Contains the number of times the controller transitioned +to lower power active power states or performed vendor +specific thermal management actions while minimizing +the impact on performance in order to attempt to reduce +the Composite Temperature because of the host controlled +thermal management feature (i.e., the Composite +Temperature rose above the Thermal Management +Temperature 1). This counter shall not wrap once the +value FFFFFFFFh is reached. A value of 0h, indicates +that this transition has never occurred or this field +is not implemented. +.IP "thm_temp2_trans_count" 12 +Thermal Management Temperature 2 Transition Count +.IP "thm_temp1_total_time" 12 +Total Time For Thermal Management Temperature 1: +Contains the number of seconds that the controller +had transitioned to lower power active power states or +performed vendor specific thermal management actions +while minimizing the impact on performance in order to +attempt to reduce the Composite Temperature because of +the host controlled thermal management feature. This +counter shall not wrap once the value FFFFFFFFh is +reached. A value of 0h, indicates that this transition +has never occurred or this field is not implemented. +.IP "thm_temp2_total_time" 12 +Total Time For Thermal Management Temperature 2 +.IP "rsvd232" 12 +Reserved diff --git a/doc/man/nvme_st_code.2 b/doc/man/nvme_st_code.2 new file mode 100644 index 0000000..83b3aaa --- /dev/null +++ b/doc/man/nvme_st_code.2 @@ -0,0 +1,37 @@ +.TH "libnvme" 9 "enum nvme_st_code" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_st_code \- Self-test Code value +.SH SYNOPSIS +enum nvme_st_code { +.br +.BI " NVME_ST_CODE_RESERVED" +, +.br +.br +.BI " NVME_ST_CODE_SHORT" +, +.br +.br +.BI " NVME_ST_CODE_EXTENDED" +, +.br +.br +.BI " NVME_ST_CODE_VS" +, +.br +.br +.BI " NVME_ST_CODE_SHIFT" + +}; +.SH Constants +.IP "NVME_ST_CODE_RESERVED" 12 +Reserved. +.IP "NVME_ST_CODE_SHORT" 12 +Short device self-test operation. +.IP "NVME_ST_CODE_EXTENDED" 12 +Extended device self-test operation. +.IP "NVME_ST_CODE_VS" 12 +Vendor specific. +.IP "NVME_ST_CODE_SHIFT" 12 +Shift amount to get the code value from the +\fIstruct nvme_st_result\fP.dsts field. diff --git a/doc/man/nvme_st_curr_op.2 b/doc/man/nvme_st_curr_op.2 new file mode 100644 index 0000000..1148499 --- /dev/null +++ b/doc/man/nvme_st_curr_op.2 @@ -0,0 +1,50 @@ +.TH "libnvme" 9 "enum nvme_st_curr_op" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_st_curr_op \- Current Device Self-Test Operation +.SH SYNOPSIS +enum nvme_st_curr_op { +.br +.BI " NVME_ST_CURR_OP_NOT_RUNNING" +, +.br +.br +.BI " NVME_ST_CURR_OP_SHORT" +, +.br +.br +.BI " NVME_ST_CURR_OP_EXTENDED" +, +.br +.br +.BI " NVME_ST_CURR_OP_VS" +, +.br +.br +.BI " NVME_ST_CURR_OP_RESERVED" +, +.br +.br +.BI " NVME_ST_CURR_OP_MASK" +, +.br +.br +.BI " NVME_ST_CURR_OP_CMPL_MASK" + +}; +.SH Constants +.IP "NVME_ST_CURR_OP_NOT_RUNNING" 12 +No device self-test operation in progress. +.IP "NVME_ST_CURR_OP_SHORT" 12 +Short device self-test operation in progress. +.IP "NVME_ST_CURR_OP_EXTENDED" 12 +Extended device self-test operation in progress. +.IP "NVME_ST_CURR_OP_VS" 12 +Vendor specific. +.IP "NVME_ST_CURR_OP_RESERVED" 12 +Reserved. +.IP "NVME_ST_CURR_OP_MASK" 12 +Mask to get the current operation value from the +\fIstruct nvme_self_test_log\fP.current_operation field. +.IP "NVME_ST_CURR_OP_CMPL_MASK" 12 +Mask to get the current operation completion value +from the \fIstruct nvme_self_test_log\fP.completion field. diff --git a/doc/man/nvme_st_result.2 b/doc/man/nvme_st_result.2 new file mode 100644 index 0000000..e8b2b34 --- /dev/null +++ b/doc/man/nvme_st_result.2 @@ -0,0 +1,77 @@ +.TH "libnvme" 9 "struct nvme_st_result" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_st_result \- Self-test Result +.SH SYNOPSIS +struct nvme_st_result { +.br +.BI " __u8 dsts;" +.br +.BI " __u8 seg;" +.br +.BI " __u8 vdi;" +.br +.BI " __u8 rsvd;" +.br +.BI " __le64 poh;" +.br +.BI " __le32 nsid;" +.br +.BI " __le64 flba;" +.br +.BI " __u8 sct;" +.br +.BI " __u8 sc;" +.br +.BI " __u8 vs[2];" +.br +.BI " +}; +.br + +.SH Members +.IP "dsts" 12 +Device Self-test Status: Indicates the device self-test code and the +status of the operation (see \fIenum nvme_status_result\fP and \fIenum nvme_st_code\fP). +.IP "seg" 12 +Segment Number: Iindicates the segment number where the first self-test +failure occurred. If Device Self-test Status (\fIdsts\fP) is not set to +#NVME_ST_RESULT_KNOWN_SEG_FAIL, then this field should be ignored. +.IP "vdi" 12 +Valid Diagnostic Information: Indicates the diagnostic failure +information that is reported. See \fIenum nvme_st_valid_diag_info\fP. +.IP "rsvd" 12 +Reserved +.IP "poh" 12 +Power On Hours (POH): Indicates the number of power-on hours at the +time the device self-test operation was completed or aborted. This +does not include time that the controller was powered and in a low +power state condition. +.IP "nsid" 12 +Namespace Identifier (NSID): Indicates the namespace that the Failing +LBA occurred on. Valid only when the NSID Valid bit +(#NVME_ST_VALID_DIAG_INFO_NSID) is set in the Valid Diagnostic +Information (\fIvdi\fP) field. +.IP "flba" 12 +Failing LBA: indicates the LBA of the logical block that caused the +test to fail. If the device encountered more than one failed logical +block during the test, then this field only indicates one of those +failed logical blocks. Valid only when the NSID Valid bit +(#NVME_ST_VALID_DIAG_INFO_FLBA) is set in the Valid Diagnostic +Information (\fIvdi\fP) field. +.IP "sct" 12 +Status Code Type: This field may contain additional information related +to errors or conditions. Bits 2:0 may contain additional information +relating to errors or conditions that occurred during the device +self-test operation represented in the same format used in the Status +Code Type field of the completion queue entry (refer to \fIenum nvme_status_field\fP). +Valid only when the NSID Valid bit (#NVME_ST_VALID_DIAG_INFO_SCT) is +set in the Valid Diagnostic Information (\fIvdi\fP) field. +.IP "sc" 12 +Status Code: This field may contain additional information relating +to errors or conditions that occurred during the device self-test +operation represented in the same format used in the Status Code field +of the completion queue entry. Valid only when the SCT Valid bit +(#NVME_ST_VALID_DIAG_INFO_SC) is set in the Valid Diagnostic +Information (\fIvdi\fP) field. +.IP "vs" 12 +Vendor Specific. diff --git a/doc/man/nvme_st_valid_diag_info.2 b/doc/man/nvme_st_valid_diag_info.2 new file mode 100644 index 0000000..09d123a --- /dev/null +++ b/doc/man/nvme_st_valid_diag_info.2 @@ -0,0 +1,34 @@ +.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_st_valid_diag_info \- Valid Diagnostic Information +.SH SYNOPSIS +enum nvme_st_valid_diag_info { +.br +.BI " NVME_ST_VALID_DIAG_INFO_NSID" +, +.br +.br +.BI " NVME_ST_VALID_DIAG_INFO_FLBA" +, +.br +.br +.BI " NVME_ST_VALID_DIAG_INFO_SCT" +, +.br +.br +.BI " NVME_ST_VALID_DIAG_INFO_SC" + +}; +.SH Constants +.IP "NVME_ST_VALID_DIAG_INFO_NSID" 12 +NSID Valid: if set, then the contents of +the Namespace Identifier field are valid. +.IP "NVME_ST_VALID_DIAG_INFO_FLBA" 12 +FLBA Valid: if set, then the contents of +the Failing LBA field are valid. +.IP "NVME_ST_VALID_DIAG_INFO_SCT" 12 +SCT Valid: if set, then the contents of +the Status Code Type field are valid. +.IP "NVME_ST_VALID_DIAG_INFO_SC" 12 +SC Valid: if set, then the contents of +the Status Code field are valid. diff --git a/doc/man/nvme_status_code.2 b/doc/man/nvme_status_code.2 new file mode 100644 index 0000000..2087a4f --- /dev/null +++ b/doc/man/nvme_status_code.2 @@ -0,0 +1,11 @@ +.TH "nvme_status_code" 9 "nvme_status_code" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_status_code \- Returns the NVMe Status Code +.SH SYNOPSIS +.B "__u16" nvme_status_code +.BI "(__u16 status_field " ");" +.SH ARGUMENTS +.IP "status_field" 12 +The NVMe Completion Queue Entry's Status Field +.SH "DESCRIPTION" +See \fIenum nvme_status_field\fP diff --git a/doc/man/nvme_status_code_type.2 b/doc/man/nvme_status_code_type.2 new file mode 100644 index 0000000..39fb999 --- /dev/null +++ b/doc/man/nvme_status_code_type.2 @@ -0,0 +1,11 @@ +.TH "nvme_status_code_type" 9 "nvme_status_code_type" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_status_code_type \- Returns the NVMe Status Code Type +.SH SYNOPSIS +.B "__u16" nvme_status_code_type +.BI "(__u16 status_field " ");" +.SH ARGUMENTS +.IP "status_field" 12 +The NVMe Completion Queue Entry's Status Field +.SH "DESCRIPTION" +See \fIenum nvme_status_field\fP diff --git a/doc/man/nvme_status_field.2 b/doc/man/nvme_status_field.2 new file mode 100644 index 0000000..d39a561 --- /dev/null +++ b/doc/man/nvme_status_field.2 @@ -0,0 +1,1153 @@ +.TH "libnvme" 9 "enum nvme_status_field" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_status_field \- Defines all parts of the nvme status field: status code, status code type, and additional flags. +.SH SYNOPSIS +enum nvme_status_field { +.br +.BI " NVME_SCT_GENERIC" +, +.br +.br +.BI " NVME_SCT_CMD_SPECIFIC" +, +.br +.br +.BI " NVME_SCT_MEDIA" +, +.br +.br +.BI " NVME_SCT_PATH" +, +.br +.br +.BI " NVME_SCT_VS" +, +.br +.br +.BI " NVME_SCT_MASK" +, +.br +.br +.BI " NVME_SCT_SHIFT" +, +.br +.br +.BI " NVME_SC_MASK" +, +.br +.br +.BI " NVME_SC_SHIFT" +, +.br +.br +.BI " NVME_SC_SUCCESS" +, +.br +.br +.BI " NVME_SC_INVALID_OPCODE" +, +.br +.br +.BI " NVME_SC_INVALID_FIELD" +, +.br +.br +.BI " NVME_SC_CMDID_CONFLICT" +, +.br +.br +.BI " NVME_SC_DATA_XFER_ERROR" +, +.br +.br +.BI " NVME_SC_POWER_LOSS" +, +.br +.br +.BI " NVME_SC_INTERNAL" +, +.br +.br +.BI " NVME_SC_ABORT_REQ" +, +.br +.br +.BI " NVME_SC_ABORT_QUEUE" +, +.br +.br +.BI " NVME_SC_FUSED_FAIL" +, +.br +.br +.BI " NVME_SC_FUSED_MISSING" +, +.br +.br +.BI " NVME_SC_INVALID_NS" +, +.br +.br +.BI " NVME_SC_CMD_SEQ_ERROR" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_LAST" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_COUNT" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_DATA" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_METADATA" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_TYPE" +, +.br +.br +.BI " NVME_SC_CMB_INVALID_USE" +, +.br +.br +.BI " NVME_SC_PRP_INVALID_OFFSET" +, +.br +.br +.BI " NVME_SC_AWU_EXCEEDED" +, +.br +.br +.BI " NVME_SC_OP_DENIED" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_OFFSET" +, +.br +.br +.BI " NVME_SC_HOSTID_FORMAT" +, +.br +.br +.BI " NVME_SC_KAT_EXPIRED" +, +.br +.br +.BI " NVME_SC_KAT_INVALID" +, +.br +.br +.BI " NVME_SC_CMD_ABORTED_PREMEPT" +, +.br +.br +.BI " NVME_SC_SANITIZE_FAILED" +, +.br +.br +.BI " NVME_SC_SANITIZE_IN_PROGRESS" +, +.br +.br +.BI " NVME_SC_SGL_INVALID_GRANULARITY" +, +.br +.br +.BI " NVME_SC_CMD_IN_CMBQ_NOT_SUPP" +, +.br +.br +.BI " NVME_SC_NS_WRITE_PROTECTED" +, +.br +.br +.BI " NVME_SC_CMD_INTERRUPTED" +, +.br +.br +.BI " NVME_SC_TRAN_TPORT_ERROR" +, +.br +.br +.BI " NVME_SC_PROHIBITED_BY_CMD_AND_FEAT" +, +.br +.br +.BI " NVME_SC_ADMIN_CMD_MEDIA_NOT_READY" +, +.br +.br +.BI " NVME_SC_LBA_RANGE" +, +.br +.br +.BI " NVME_SC_CAP_EXCEEDED" +, +.br +.br +.BI " NVME_SC_NS_NOT_READY" +, +.br +.br +.BI " NVME_SC_RESERVATION_CONFLICT" +, +.br +.br +.BI " NVME_SC_FORMAT_IN_PROGRESS" +, +.br +.br +.BI " NVME_SC_CQ_INVALID" +, +.br +.br +.BI " NVME_SC_QID_INVALID" +, +.br +.br +.BI " NVME_SC_QUEUE_SIZE" +, +.br +.br +.BI " NVME_SC_ABORT_LIMIT" +, +.br +.br +.BI " NVME_SC_ABORT_MISSING" +, +.br +.br +.BI " NVME_SC_ASYNC_LIMIT" +, +.br +.br +.BI " NVME_SC_FIRMWARE_SLOT" +, +.br +.br +.BI " NVME_SC_FIRMWARE_IMAGE" +, +.br +.br +.BI " NVME_SC_INVALID_VECTOR" +, +.br +.br +.BI " NVME_SC_INVALID_LOG_PAGE" +, +.br +.br +.BI " NVME_SC_INVALID_FORMAT" +, +.br +.br +.BI " NVME_SC_FW_NEEDS_CONV_RESET" +, +.br +.br +.BI " NVME_SC_INVALID_QUEUE" +, +.br +.br +.BI " NVME_SC_FEATURE_NOT_SAVEABLE" +, +.br +.br +.BI " NVME_SC_FEATURE_NOT_CHANGEABLE" +, +.br +.br +.BI " NVME_SC_FEATURE_NOT_PER_NS" +, +.br +.br +.BI " NVME_SC_FW_NEEDS_SUBSYS_RESET" +, +.br +.br +.BI " NVME_SC_FW_NEEDS_RESET" +, +.br +.br +.BI " NVME_SC_FW_NEEDS_MAX_TIME" +, +.br +.br +.BI " NVME_SC_FW_ACTIVATE_PROHIBITED" +, +.br +.br +.BI " NVME_SC_OVERLAPPING_RANGE" +, +.br +.br +.BI " NVME_SC_NS_INSUFFICIENT_CAP" +, +.br +.br +.BI " NVME_SC_NS_ID_UNAVAILABLE" +, +.br +.br +.BI " NVME_SC_NS_ALREADY_ATTACHED" +, +.br +.br +.BI " NVME_SC_NS_IS_PRIVATE" +, +.br +.br +.BI " NVME_SC_NS_NOT_ATTACHED" +, +.br +.br +.BI " NVME_SC_THIN_PROV_NOT_SUPP" +, +.br +.br +.BI " NVME_SC_CTRL_LIST_INVALID" +, +.br +.br +.BI " NVME_SC_SELF_TEST_IN_PROGRESS" +, +.br +.br +.BI " NVME_SC_BP_WRITE_PROHIBITED" +, +.br +.br +.BI " NVME_SC_INVALID_CTRL_ID" +, +.br +.br +.BI " NVME_SC_INVALID_SEC_CTRL_STATE" +, +.br +.br +.BI " NVME_SC_INVALID_CTRL_RESOURCES" +, +.br +.br +.BI " NVME_SC_INVALID_RESOURCE_ID" +, +.br +.br +.BI " NVME_SC_PMR_SAN_PROHIBITED" +, +.br +.br +.BI " NVME_SC_ANA_GROUP_ID_INVALID" +, +.br +.br +.BI " NVME_SC_ANA_ATTACH_FAILED" +, +.br +.br +.BI " NVME_SC_INSUFFICIENT_CAP" +, +.br +.br +.BI " NVME_SC_NS_ATTACHMENT_LIMIT_EXCEEDED" +, +.br +.br +.BI " NVME_SC_PROHIBIT_CMD_EXEC_NOT_SUPPORTED" +, +.br +.br +.BI " NVME_SC_IOCS_NOT_SUPPORTED" +, +.br +.br +.BI " NVME_SC_IOCS_NOT_ENABLED" +, +.br +.br +.BI " NVME_SC_IOCS_COMBINATION_REJECTED" +, +.br +.br +.BI " NVME_SC_INVALID_IOCS" +, +.br +.br +.BI " NVME_SC_ID_UNAVAILABLE" +, +.br +.br +.BI " NVME_SC_INVALID_DISCOVERY_INFO" +, +.br +.br +.BI " NVME_SC_ZONING_DATA_STRUCT_LOCKED" +, +.br +.br +.BI " NVME_SC_ZONING_DATA_STRUCT_NOTFND" +, +.br +.br +.BI " NVME_SC_INSUFFICIENT_DISC_RES" +, +.br +.br +.BI " NVME_SC_REQSTD_FUNCTION_DISABLED" +, +.br +.br +.BI " NVME_SC_ZONEGRP_ORIGINATOR_INVLD" +, +.br +.br +.BI " NVME_SC_BAD_ATTRIBUTES" +, +.br +.br +.BI " NVME_SC_INVALID_PI" +, +.br +.br +.BI " NVME_SC_READ_ONLY" +, +.br +.br +.BI " NVME_SC_CMD_SIZE_LIMIT_EXCEEDED" +, +.br +.br +.BI " NVME_SC_CONNECT_FORMAT" +, +.br +.br +.BI " NVME_SC_CONNECT_CTRL_BUSY" +, +.br +.br +.BI " NVME_SC_CONNECT_INVALID_PARAM" +, +.br +.br +.BI " NVME_SC_CONNECT_RESTART_DISC" +, +.br +.br +.BI " NVME_SC_CONNECT_INVALID_HOST" +, +.br +.br +.BI " NVME_SC_DISCONNECT_INVALID_QTYPE" +, +.br +.br +.BI " NVME_SC_DISCOVERY_RESTART" +, +.br +.br +.BI " NVME_SC_AUTH_REQUIRED" +, +.br +.br +.BI " NVME_SC_ZNS_INVALID_OP_REQUEST" +, +.br +.br +.BI " NVME_SC_ZNS_ZRWA_RESOURCES_UNAVAILABLE" +, +.br +.br +.BI " NVME_SC_ZNS_BOUNDARY_ERROR" +, +.br +.br +.BI " NVME_SC_ZNS_FULL" +, +.br +.br +.BI " NVME_SC_ZNS_READ_ONLY" +, +.br +.br +.BI " NVME_SC_ZNS_OFFLINE" +, +.br +.br +.BI " NVME_SC_ZNS_INVALID_WRITE" +, +.br +.br +.BI " NVME_SC_ZNS_TOO_MANY_ACTIVE" +, +.br +.br +.BI " NVME_SC_ZNS_TOO_MANY_OPENS" +, +.br +.br +.BI " NVME_SC_ZNS_INVAL_TRANSITION" +, +.br +.br +.BI " NVME_SC_WRITE_FAULT" +, +.br +.br +.BI " NVME_SC_READ_ERROR" +, +.br +.br +.BI " NVME_SC_GUARD_CHECK" +, +.br +.br +.BI " NVME_SC_APPTAG_CHECK" +, +.br +.br +.BI " NVME_SC_REFTAG_CHECK" +, +.br +.br +.BI " NVME_SC_COMPARE_FAILED" +, +.br +.br +.BI " NVME_SC_ACCESS_DENIED" +, +.br +.br +.BI " NVME_SC_UNWRITTEN_BLOCK" +, +.br +.br +.BI " NVME_SC_STORAGE_TAG_CHECK" +, +.br +.br +.BI " NVME_SC_ANA_INTERNAL_PATH_ERROR" +, +.br +.br +.BI " NVME_SC_ANA_PERSISTENT_LOSS" +, +.br +.br +.BI " NVME_SC_ANA_INACCESSIBLE" +, +.br +.br +.BI " NVME_SC_ANA_TRANSITION" +, +.br +.br +.BI " NVME_SC_CTRL_PATH_ERROR" +, +.br +.br +.BI " NVME_SC_HOST_PATH_ERROR" +, +.br +.br +.BI " NVME_SC_CMD_ABORTED_BY_HOST" +, +.br +.br +.BI " NVME_SC_CRD" +, +.br +.br +.BI " NVME_SC_MORE" +, +.br +.br +.BI " NVME_SC_DNR" + +}; +.SH Constants +.IP "NVME_SCT_GENERIC" 12 +Generic errors applicable to multiple opcodes +.IP "NVME_SCT_CMD_SPECIFIC" 12 +Errors associated to a specific opcode +.IP "NVME_SCT_MEDIA" 12 +Errors associated with media and data integrity +.IP "NVME_SCT_PATH" 12 +Errors associated with the paths connection +.IP "NVME_SCT_VS" 12 +Vendor specific errors +.IP "NVME_SCT_MASK" 12 +Mask to get the value of the Status Code Type +.IP "NVME_SCT_SHIFT" 12 +-- undescribed -- +.IP "NVME_SC_MASK" 12 +Mask to get the value of the status code. +.IP "NVME_SC_SHIFT" 12 +-- undescribed -- +.IP "NVME_SC_SUCCESS" 12 +Successful Completion: The command +completed without error. +.IP "NVME_SC_INVALID_OPCODE" 12 +Invalid Command Opcode: A reserved coded +value or an unsupported value in the +command opcode field. +.IP "NVME_SC_INVALID_FIELD" 12 +Invalid Field in Command: A reserved +coded value or an unsupported value in a +defined field. +.IP "NVME_SC_CMDID_CONFLICT" 12 +Command ID Conflict: The command +identifier is already in use. +.IP "NVME_SC_DATA_XFER_ERROR" 12 +Data Transfer Error: Transferring the +data or metadata associated with a +command experienced an error. +.IP "NVME_SC_POWER_LOSS" 12 +Commands Aborted due to Power Loss +Notification: Indicates that the command +was aborted due to a power loss +notification. +.IP "NVME_SC_INTERNAL" 12 +Internal Error: The command was not +completed successfully due to an internal error. +.IP "NVME_SC_ABORT_REQ" 12 +Command Abort Requested: The command was +aborted due to an Abort command being +received that specified the Submission +Queue Identifier and Command Identifier +of this command. +.IP "NVME_SC_ABORT_QUEUE" 12 +Command Aborted due to SQ Deletion: The +command was aborted due to a Delete I/O +Submission Queue request received for the +Submission Queue to which the command was +submitted. +.IP "NVME_SC_FUSED_FAIL" 12 +Command Aborted due to Failed Fused Command: +The command was aborted due to the other +command in a fused operation failing. +.IP "NVME_SC_FUSED_MISSING" 12 +Aborted due to Missing Fused Command: The +fused command was aborted due to the +adjacent submission queue entry not +containing a fused command that is the +other command. +.IP "NVME_SC_INVALID_NS" 12 +Invalid Namespace or Format: The +namespace or the format of that namespace +is invalid. +.IP "NVME_SC_CMD_SEQ_ERROR" 12 +Command Sequence Error: The command was +aborted due to a protocol violation in a +multi-command sequence. +.IP "NVME_SC_SGL_INVALID_LAST" 12 +Invalid SGL Segment Descriptor: The +command includes an invalid SGL Last +Segment or SGL Segment descriptor. +.IP "NVME_SC_SGL_INVALID_COUNT" 12 +Invalid Number of SGL Descriptors: There +is an SGL Last Segment descriptor or an +SGL Segment descriptor in a location +other than the last descriptor of a +segment based on the length indicated. +.IP "NVME_SC_SGL_INVALID_DATA" 12 +Data SGL Length Invalid: This may occur +if the length of a Data SGL is too short. +This may occur if the length of a Data +SGL is too long and the controller does +not support SGL transfers longer than the +amount of data to be transferred as +indicated in the SGL Support field of the +Identify Controller data structure. +.IP "NVME_SC_SGL_INVALID_METADATA" 12 +Metadata SGL Length Invalid: This may +occur if the length of a Metadata SGL is +too short. This may occur if the length +of a Metadata SGL is too long and the +controller does not support SGL transfers +longer than the amount of data to be +transferred as indicated in the SGL +Support field of the Identify Controller +data structure. +.IP "NVME_SC_SGL_INVALID_TYPE" 12 +SGL Descriptor Type Invalid: The type of +an SGL Descriptor is a type that is not +supported by the controller. +.IP "NVME_SC_CMB_INVALID_USE" 12 +Invalid Use of Controller Memory Buffer: +The attempted use of the Controller +Memory Buffer is not supported by the +controller. +.IP "NVME_SC_PRP_INVALID_OFFSET" 12 +PRP Offset Invalid: The Offset field for +a PRP entry is invalid. +.IP "NVME_SC_AWU_EXCEEDED" 12 +Atomic Write Unit Exceeded: The length +specified exceeds the atomic write unit size. +.IP "NVME_SC_OP_DENIED" 12 +Operation Denied: The command was denied +due to lack of access rights. Refer to +the appropriate security specification. +.IP "NVME_SC_SGL_INVALID_OFFSET" 12 +SGL Offset Invalid: The offset specified +in a descriptor is invalid. This may +occur when using capsules for data +transfers in NVMe over Fabrics +implementations and an invalid offset in +the capsule is specified. +.IP "NVME_SC_HOSTID_FORMAT" 12 +Host Identifier Inconsistent Format: The +NVM subsystem detected the simultaneous +use of 64- bit and 128-bit Host +Identifier values on different +controllers. +.IP "NVME_SC_KAT_EXPIRED" 12 +Keep Alive Timer Expired: The Keep Alive +Timer expired. +.IP "NVME_SC_KAT_INVALID" 12 +Keep Alive Timeout Invalid: The Keep +Alive Timeout value specified is invalid. +.IP "NVME_SC_CMD_ABORTED_PREMEPT" 12 +Command Aborted due to Preempt and Abort: +The command was aborted due to a +Reservation Acquire command. +.IP "NVME_SC_SANITIZE_FAILED" 12 +Sanitize Failed: The most recent sanitize +operation failed and no recovery action +has been successfully completed. +.IP "NVME_SC_SANITIZE_IN_PROGRESS" 12 +Sanitize In Progress: The requested +function (e.g., command) is prohibited +while a sanitize operation is in +progress. +.IP "NVME_SC_SGL_INVALID_GRANULARITY" 12 +SGL Data Block Granularity Invalid: The +Address alignment or Length granularity +for an SGL Data Block descriptor is +invalid. +.IP "NVME_SC_CMD_IN_CMBQ_NOT_SUPP" 12 +Command Not Supported for Queue in CMB: +The implementation does not support +submission of the command to a Submission +Queue in the Controller Memory Buffer or +command completion to a Completion Queue +in the Controller Memory Buffer. +.IP "NVME_SC_NS_WRITE_PROTECTED" 12 +Namespace is Write Protected: The command +is prohibited while the namespace is +write protected as a result of a change +in the namespace write protection state +as defined by the Namespace Write +Protection State Machine. +.IP "NVME_SC_CMD_INTERRUPTED" 12 +Command Interrupted: Command processing +was interrupted and the controller is +unable to successfully complete the +command. The host should retry the +command. +.IP "NVME_SC_TRAN_TPORT_ERROR" 12 +Transient Transport Error: A transient +transport error was detected. If the +command is retried on the same +controller, the command is likely to +succeed. A command that fails with a +transient transport error four or more +times should be treated as a persistent +transport error that is not likely to +succeed if retried on the same +controller. +.IP "NVME_SC_PROHIBITED_BY_CMD_AND_FEAT" 12 +Command Prohibited by Command and Feature +Lockdown: The command was aborted due to +command execution being prohibited by +the Command and Feature Lockdown. +.IP "NVME_SC_ADMIN_CMD_MEDIA_NOT_READY" 12 +Admin Command Media Not Ready: The Admin +command requires access to media and +the media is not ready. +.IP "NVME_SC_LBA_RANGE" 12 +LBA Out of Range: The command references +an LBA that exceeds the size of the namespace. +.IP "NVME_SC_CAP_EXCEEDED" 12 +Capacity Exceeded: Execution of the +command has caused the capacity of the +namespace to be exceeded. +.IP "NVME_SC_NS_NOT_READY" 12 +Namespace Not Ready: The namespace is not +ready to be accessed as a result of a +condition other than a condition that is +reported as an Asymmetric Namespace +Access condition. +.IP "NVME_SC_RESERVATION_CONFLICT" 12 +Reservation Conflict: The command was +aborted due to a conflict with a +reservation held on the accessed +namespace. +.IP "NVME_SC_FORMAT_IN_PROGRESS" 12 +Format In Progress: A Format NVM command +is in progress on the namespace. +.IP "NVME_SC_CQ_INVALID" 12 +Completion Queue Invalid: The Completion +Queue identifier specified in the command +does not exist. +.IP "NVME_SC_QID_INVALID" 12 +Invalid Queue Identifier: The creation of +the I/O Completion Queue failed due to an +invalid queue identifier specified as +part of the command. An invalid queue +identifier is one that is currently in +use or one that is outside the range +supported by the controller. +.IP "NVME_SC_QUEUE_SIZE" 12 +Invalid Queue Size: The host attempted to +create an I/O Completion Queue with an +invalid number of entries. +.IP "NVME_SC_ABORT_LIMIT" 12 +Abort Command Limit Exceeded: The number +of concurrently outstanding Abort commands +has exceeded the limit indicated in the +Identify Controller data structure. +.IP "NVME_SC_ABORT_MISSING" 12 +Abort Command is missing: The abort +command is missing. +.IP "NVME_SC_ASYNC_LIMIT" 12 +Asynchronous Event Request Limit +Exceeded: The number of concurrently +outstanding Asynchronous Event Request +commands has been exceeded. +.IP "NVME_SC_FIRMWARE_SLOT" 12 +Invalid Firmware Slot: The firmware slot +indicated is invalid or read only. This +error is indicated if the firmware slot +exceeds the number supported. +.IP "NVME_SC_FIRMWARE_IMAGE" 12 +Invalid Firmware Image: The firmware +image specified for activation is invalid +and not loaded by the controller. +.IP "NVME_SC_INVALID_VECTOR" 12 +Invalid Interrupt Vector: The creation of +the I/O Completion Queue failed due to an +invalid interrupt vector specified as +part of the command. +.IP "NVME_SC_INVALID_LOG_PAGE" 12 +Invalid Log Page: The log page indicated +is invalid. This error condition is also +returned if a reserved log page is +requested. +.IP "NVME_SC_INVALID_FORMAT" 12 +Invalid Format: The LBA Format specified +is not supported. +.IP "NVME_SC_FW_NEEDS_CONV_RESET" 12 +Firmware Activation Requires Conventional Reset: +The firmware commit was successful, +however, activation of the firmware image +requires a conventional reset. +.IP "NVME_SC_INVALID_QUEUE" 12 +Invalid Queue Deletion: Invalid I/O +Completion Queue specified to delete. +.IP "NVME_SC_FEATURE_NOT_SAVEABLE" 12 +Feature Identifier Not Saveable: The +Feature Identifier specified does not +support a saveable value. +.IP "NVME_SC_FEATURE_NOT_CHANGEABLE" 12 +Feature Not Changeable: The Feature +Identifier is not able to be changed. +.IP "NVME_SC_FEATURE_NOT_PER_NS" 12 +Feature Not Namespace Specific: The +Feature Identifier specified is not +namespace specific. The Feature +Identifier settings apply across all +namespaces. +.IP "NVME_SC_FW_NEEDS_SUBSYS_RESET" 12 +Firmware Activation Requires NVM +Subsystem Reset: The firmware commit was +successful, however, activation of the +firmware image requires an NVM Subsystem. +.IP "NVME_SC_FW_NEEDS_RESET" 12 +Firmware Activation Requires Controller +Level Reset: The firmware commit was +successful; however, the image specified +does not support being activated without +a reset. +.IP "NVME_SC_FW_NEEDS_MAX_TIME" 12 +Firmware Activation Requires Maximum Time +Violation: The image specified if +activated immediately would exceed the +Maximum Time for Firmware Activation +(MTFA) value reported in Identify +Controller. +.IP "NVME_SC_FW_ACTIVATE_PROHIBITED" 12 +Firmware Activation Prohibited: The image +specified is being prohibited from +activation by the controller for vendor +specific reasons. +.IP "NVME_SC_OVERLAPPING_RANGE" 12 +Overlapping Range: The downloaded +firmware image has overlapping ranges. +.IP "NVME_SC_NS_INSUFFICIENT_CAP" 12 +Namespace Insufficient Capacity: Creating +the namespace requires more free space +than is currently available. +.IP "NVME_SC_NS_ID_UNAVAILABLE" 12 +Namespace Identifier Unavailable: The +number of namespaces supported has been +exceeded. +.IP "NVME_SC_NS_ALREADY_ATTACHED" 12 +Namespace Already Attached: The +controller is already attached to the +namespace specified. +.IP "NVME_SC_NS_IS_PRIVATE" 12 +Namespace Is Private: The namespace is +private and is already attached to one +controller. +.IP "NVME_SC_NS_NOT_ATTACHED" 12 +Namespace Not Attached: The request to +detach the controller could not be +completed because the controller is not +attached to the namespace. +.IP "NVME_SC_THIN_PROV_NOT_SUPP" 12 +Thin Provisioning Not Supported: Thin +provisioning is not supported by the +controller. +.IP "NVME_SC_CTRL_LIST_INVALID" 12 +Controller List Invalid: The controller +list provided contains invalid controller +ids. +.IP "NVME_SC_SELF_TEST_IN_PROGRESS" 12 +Device Self-test In Progress: The controller +or NVM subsystem already has a device +self-test operation in process. +.IP "NVME_SC_BP_WRITE_PROHIBITED" 12 +Boot Partition Write Prohibited: The +command is trying to modify a locked Boot +Partition. +.IP "NVME_SC_INVALID_CTRL_ID" 12 +Invalid Controller Identifier: +.IP "NVME_SC_INVALID_SEC_CTRL_STATE" 12 +Invalid Secondary Controller State +.IP "NVME_SC_INVALID_CTRL_RESOURCES" 12 +Invalid Number of Controller Resources +.IP "NVME_SC_INVALID_RESOURCE_ID" 12 +Invalid Resource Identifier +.IP "NVME_SC_PMR_SAN_PROHIBITED" 12 +Sanitize Prohibited While Persistent +Memory Region is Enabled +.IP "NVME_SC_ANA_GROUP_ID_INVALID" 12 +ANA Group Identifier Invalid: The specified +ANA Group Identifier (ANAGRPID) is not +supported in the submitted command. +.IP "NVME_SC_ANA_ATTACH_FAILED" 12 +ANA Attach Failed: The controller is not +attached to the namespace as a result +of an ANA condition. +.IP "NVME_SC_INSUFFICIENT_CAP" 12 +Insufficient Capacity: Requested operation +requires more free space than is currently +available. +.IP "NVME_SC_NS_ATTACHMENT_LIMIT_EXCEEDED" 12 +Namespace Attachment Limit Exceeded: +Attaching the ns to a controller causes +max number of ns attachments allowed +to be exceeded. +.IP "NVME_SC_PROHIBIT_CMD_EXEC_NOT_SUPPORTED" 12 +Prohibition of Command Execution +Not Supported +.IP "NVME_SC_IOCS_NOT_SUPPORTED" 12 +I/O Command Set Not Supported +.IP "NVME_SC_IOCS_NOT_ENABLED" 12 +I/O Command Set Not Enabled +.IP "NVME_SC_IOCS_COMBINATION_REJECTED" 12 +I/O Command Set Combination Rejected +.IP "NVME_SC_INVALID_IOCS" 12 +Invalid I/O Command Set +.IP "NVME_SC_ID_UNAVAILABLE" 12 +Identifier Unavailable +.IP "NVME_SC_INVALID_DISCOVERY_INFO" 12 +The discovery information provided in +one or more extended discovery +information entries is not applicable +for the type of entity selected in +the Entity Type (ETYPE) field of the +Discovery Information Management +command data portion’s header. +.IP "NVME_SC_ZONING_DATA_STRUCT_LOCKED" 12 +The requested Zoning data structure +is locked on the CDC. +.IP "NVME_SC_ZONING_DATA_STRUCT_NOTFND" 12 +The requested Zoning data structure +does not exist on the CDC. +.IP "NVME_SC_INSUFFICIENT_DISC_RES" 12 +The number of discover information +entries provided in the data portion +of the Discovery Information +Management command for a registration +task (i.e., TAS field cleared to 0h) +exceeds the available capacity for +new discovery information entries on +the CDC or DDC. This may be a +transient condition. +.IP "NVME_SC_REQSTD_FUNCTION_DISABLED" 12 +Fabric Zoning is not enabled on the +CDC +.IP "NVME_SC_ZONEGRP_ORIGINATOR_INVLD" 12 +-- undescribed -- +.IP "NVME_SC_BAD_ATTRIBUTES" 12 +Conflicting Dataset Management Attributes +.IP "NVME_SC_INVALID_PI" 12 +Invalid Protection Information +.IP "NVME_SC_READ_ONLY" 12 +Attempted Write to Read Only Range +.IP "NVME_SC_CMD_SIZE_LIMIT_EXCEEDED" 12 +Command Size Limit Exceeded +.IP "NVME_SC_CONNECT_FORMAT" 12 +Incompatible Format: The NVM subsystem +does not support the record format +specified by the host. +.IP "NVME_SC_CONNECT_CTRL_BUSY" 12 +Controller Busy: The controller is +already associated with a host. +.IP "NVME_SC_CONNECT_INVALID_PARAM" 12 +Connect Invalid Parameters: One or more +of the command parameters. +.IP "NVME_SC_CONNECT_RESTART_DISC" 12 +Connect Restart Discovery: The NVM +subsystem requested is not available. +.IP "NVME_SC_CONNECT_INVALID_HOST" 12 +Connect Invalid Host: The host is either +not allowed to establish an association +to any controller in the NVM subsystem or +the host is not allowed to establish an +association to the specified controller +.IP "NVME_SC_DISCONNECT_INVALID_QTYPE" 12 +Invalid Queue Type: The command was sent +on the wrong queue type. +.IP "NVME_SC_DISCOVERY_RESTART" 12 +Discover Restart: The snapshot of the +records is now invalid or out of date. +.IP "NVME_SC_AUTH_REQUIRED" 12 +Authentication Required: NVMe in-band +authentication is required and the queue +has not yet been authenticated. +.IP "NVME_SC_ZNS_INVALID_OP_REQUEST" 12 +Invalid Zone Operation Request: +The operation requested is invalid. This may be due to +various conditions, including: attempting to allocate a +ZRWA when a zone is not in the ZSE:Empty state; or +invalid Flush Explicit ZRWA Range Send Zone Action +operation. +.IP "NVME_SC_ZNS_ZRWA_RESOURCES_UNAVAILABLE" 12 +ZRWA Resources Unavailable: +No ZRWAs are available. +.IP "NVME_SC_ZNS_BOUNDARY_ERROR" 12 +Zone Boundary Error: The command specifies +logical blocks in more than one zone. +.IP "NVME_SC_ZNS_FULL" 12 +Zone Is Full: The accessed zone is in the +ZSF:Full state. +.IP "NVME_SC_ZNS_READ_ONLY" 12 +Zone Is Read Only: The accessed zone is +in the ZSRO:Read Only state. +.IP "NVME_SC_ZNS_OFFLINE" 12 +Zone Is Offline: The accessed zone is +in the ZSO:Offline state. +.IP "NVME_SC_ZNS_INVALID_WRITE" 12 +Zone Invalid Write: The write to a zone +was not at the write pointer. +.IP "NVME_SC_ZNS_TOO_MANY_ACTIVE" 12 +Too Many Active Zones: The controller +does not allow additional active zones. +.IP "NVME_SC_ZNS_TOO_MANY_OPENS" 12 +Too Many Open Zones: The controller does +not allow additional open zones. +.IP "NVME_SC_ZNS_INVAL_TRANSITION" 12 +Invalid Zone State Transition: The request +is not a valid zone state transition. +.IP "NVME_SC_WRITE_FAULT" 12 +Write Fault: The write data could not be +committed to the media. +.IP "NVME_SC_READ_ERROR" 12 +Unrecovered Read Error: The read data +could not be recovered from the media. +.IP "NVME_SC_GUARD_CHECK" 12 +End-to-end Guard Check Error: The command +was aborted due to an end-to-end guard +check failure. +.IP "NVME_SC_APPTAG_CHECK" 12 +End-to-end Application Tag Check Error: +The command was aborted due to an +end-to-end application tag check failure. +.IP "NVME_SC_REFTAG_CHECK" 12 +End-to-end Reference Tag Check Error: The +command was aborted due to an end-to-end +reference tag check failure. +.IP "NVME_SC_COMPARE_FAILED" 12 +Compare Failure: The command failed due +to a miscompare during a Compare command. +.IP "NVME_SC_ACCESS_DENIED" 12 +Access Denied: Access to the namespace +and/or LBA range is denied due to lack of +access rights. +.IP "NVME_SC_UNWRITTEN_BLOCK" 12 +Deallocated or Unwritten Logical Block: +The command failed due to an attempt to +read from or verify an LBA range +containing a deallocated or unwritten +logical block. +.IP "NVME_SC_STORAGE_TAG_CHECK" 12 +End-to-End Storage Tag Check Error: The +command was aborted due to an end-to-end +storage tag check failure. +.IP "NVME_SC_ANA_INTERNAL_PATH_ERROR" 12 +Internal Path Error: The command was not +completed as the result of a controller +internal error that is specific to the +controller processing the command. +.IP "NVME_SC_ANA_PERSISTENT_LOSS" 12 +Asymmetric Access Persistent Loss: The +requested function (e.g., command) is not +able to be performed as a result of the +relationship between the controller and +the namespace being in the ANA Persistent +Loss state. +.IP "NVME_SC_ANA_INACCESSIBLE" 12 +Asymmetric Access Inaccessible: The +requested function (e.g., command) is not +able to be performed as a result of the +relationship between the controller and +the namespace being in the ANA +Inaccessible state. +.IP "NVME_SC_ANA_TRANSITION" 12 +Asymmetric Access Transition: The +requested function (e.g., command) is not +able to be performed as a result of the +relationship between the controller and +the namespace transitioning between +Asymmetric Namespace Access states. +.IP "NVME_SC_CTRL_PATH_ERROR" 12 +Controller Pathing Error: A pathing error +was detected by the controller. +.IP "NVME_SC_HOST_PATH_ERROR" 12 +Host Pathing Error: A pathing error was +detected by the host. +.IP "NVME_SC_CMD_ABORTED_BY_HOST" 12 +Command Aborted By Host: The command was +aborted as a result of host action. +.IP "NVME_SC_CRD" 12 +Mask to get value of Command Retry Delay +index +.IP "NVME_SC_MORE" 12 +More bit. If set, more status information +for this command as part of the Error +Information log that may be retrieved with +the Get Log Page command. +.IP "NVME_SC_DNR" 12 +Do Not Retry bit. If set, if the same +command is re-submitted to any controller +in the NVM subsystem, then that +re-submitted command is expected to fail. diff --git a/doc/man/nvme_status_result.2 b/doc/man/nvme_status_result.2 new file mode 100644 index 0000000..e1e51ad --- /dev/null +++ b/doc/man/nvme_status_result.2 @@ -0,0 +1,87 @@ +.TH "libnvme" 9 "enum nvme_status_result" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_status_result \- Result of the device self-test operation +.SH SYNOPSIS +enum nvme_status_result { +.br +.BI " NVME_ST_RESULT_NO_ERR" +, +.br +.br +.BI " NVME_ST_RESULT_ABORTED" +, +.br +.br +.BI " NVME_ST_RESULT_CLR" +, +.br +.br +.BI " NVME_ST_RESULT_NS_REMOVED" +, +.br +.br +.BI " NVME_ST_RESULT_ABORTED_FORMAT" +, +.br +.br +.BI " NVME_ST_RESULT_FATAL_ERR" +, +.br +.br +.BI " NVME_ST_RESULT_UNKNOWN_SEG_FAIL" +, +.br +.br +.BI " NVME_ST_RESULT_KNOWN_SEG_FAIL" +, +.br +.br +.BI " NVME_ST_RESULT_ABORTED_UNKNOWN" +, +.br +.br +.BI " NVME_ST_RESULT_ABORTED_SANITIZE" +, +.br +.br +.BI " NVME_ST_RESULT_NOT_USED" +, +.br +.br +.BI " NVME_ST_RESULT_MASK" + +}; +.SH Constants +.IP "NVME_ST_RESULT_NO_ERR" 12 +Operation completed without error. +.IP "NVME_ST_RESULT_ABORTED" 12 +Operation was aborted by a Device Self-test command. +.IP "NVME_ST_RESULT_CLR" 12 +Operation was aborted by a Controller Level Reset. +.IP "NVME_ST_RESULT_NS_REMOVED" 12 +Operation was aborted due to a removal of +a namespace from the namespace inventory. +.IP "NVME_ST_RESULT_ABORTED_FORMAT" 12 +Operation was aborted due to the processing +of a Format NVM command. +.IP "NVME_ST_RESULT_FATAL_ERR" 12 +A fatal error or unknown test error occurred +while the controller was executing the device +self-test operation and the operation did +not complete. +.IP "NVME_ST_RESULT_UNKNOWN_SEG_FAIL" 12 +Operation completed with a segment that failed +and the segment that failed is not known. +.IP "NVME_ST_RESULT_KNOWN_SEG_FAIL" 12 +Operation completed with one or more failed +segments and the first segment that failed +is indicated in the Segment Number field. +.IP "NVME_ST_RESULT_ABORTED_UNKNOWN" 12 +Operation was aborted for unknown reason. +.IP "NVME_ST_RESULT_ABORTED_SANITIZE" 12 +Operation was aborted due to a sanitize operation. +.IP "NVME_ST_RESULT_NOT_USED" 12 +Entry not used (does not contain a test result). +.IP "NVME_ST_RESULT_MASK" 12 +Mask to get the status result value from +the \fIstruct nvme_st_result\fP.dsts field. diff --git a/doc/man/nvme_status_to_errno.2 b/doc/man/nvme_status_to_errno.2 new file mode 100644 index 0000000..d5174a7 --- /dev/null +++ b/doc/man/nvme_status_to_errno.2 @@ -0,0 +1,15 @@ +.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_status_to_errno \- Converts nvme return status to errno +.SH SYNOPSIS +.B "__u8" nvme_status_to_errno +.BI "(int status " "," +.BI "bool fabrics " ");" +.SH ARGUMENTS +.IP "status" 12 +Return status from an nvme passthrough commmand +.IP "fabrics" 12 +Set to true if \fIstatus\fP is to a fabrics target. +.SH "RETURN" +An errno representing the nvme status if it is an nvme status field, +or unchanged status is < 0 since errno is already set. diff --git a/doc/man/nvme_status_to_string.2 b/doc/man/nvme_status_to_string.2 new file mode 100644 index 0000000..c91938d --- /dev/null +++ b/doc/man/nvme_status_to_string.2 @@ -0,0 +1,15 @@ +.TH "nvme_status_to_string" 9 "nvme_status_to_string" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_status_to_string \- Returns string describing nvme return status. +.SH SYNOPSIS +.B "const char *" nvme_status_to_string +.BI "(int status " "," +.BI "bool fabrics " ");" +.SH ARGUMENTS +.IP "status" 12 +Return status from an nvme passthrough commmand +.IP "fabrics" 12 +Set to true if \fIstatus\fP is to a fabrics target. +.SH "RETURN" +String representation of the nvme status if it is an nvme status field, +or a standard errno string if status is < 0. diff --git a/doc/man/nvme_streams_directive_params.2 b/doc/man/nvme_streams_directive_params.2 new file mode 100644 index 0000000..c2dd59a --- /dev/null +++ b/doc/man/nvme_streams_directive_params.2 @@ -0,0 +1,51 @@ +.TH "libnvme" 9 "struct nvme_streams_directive_params" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_streams_directive_params \- +.SH SYNOPSIS +struct nvme_streams_directive_params { +.br +.BI " __le16 msl;" +.br +.BI " __le16 nssa;" +.br +.BI " __le16 nsso;" +.br +.BI " __u8 nssc;" +.br +.BI " __u8 rsvd[9];" +.br +.BI " __le32 sws;" +.br +.BI " __le16 sgs;" +.br +.BI " __le16 nsa;" +.br +.BI " __le16 nso;" +.br +.BI " __u8 rsvd2[6];" +.br +.BI " +}; +.br + +.SH Members +.IP "msl" 12 +Max Streams Limit +.IP "nssa" 12 +NVM Subsystem Streams Available +.IP "nsso" 12 +NVM Subsystem Streams Open +.IP "nssc" 12 +NVM Subsystem Stream Capability +.IP "rsvd" 12 +Reserved +.IP "sws" 12 +Stream Write Size +.IP "sgs" 12 +Stream Granularity Size +.IP "nsa" 12 +Namespace Streams Allocated +.IP "nso" 12 +Namespace Streams Open +.IP "rsvd2" 12 +Reserved diff --git a/doc/man/nvme_streams_directive_status.2 b/doc/man/nvme_streams_directive_status.2 new file mode 100644 index 0000000..5b0a192 --- /dev/null +++ b/doc/man/nvme_streams_directive_status.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_streams_directive_status" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_streams_directive_status \- +.SH SYNOPSIS +struct nvme_streams_directive_status { +.br +.BI " __le16 osc;" +.br +.BI " __le16 sid[];" +.br +.BI " +}; +.br + +.SH Members +.IP "osc" 12 +Open Stream Count +.IP "sid" 12 +Stream Identifier diff --git a/doc/man/nvme_submit_admin_passthru.2 b/doc/man/nvme_submit_admin_passthru.2 new file mode 100644 index 0000000..823bbff --- /dev/null +++ b/doc/man/nvme_submit_admin_passthru.2 @@ -0,0 +1,20 @@ +.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_submit_admin_passthru \- Submit an nvme passthrough admin command +.SH SYNOPSIS +.B "int" nvme_submit_admin_passthru +.BI "(int fd " "," +.BI "struct nvme_passthru_cmd *cmd " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "cmd" 12 +The nvme admin command to send +.IP "result" 12 +Optional field to return the result from the CQE DW0 +.SH "DESCRIPTION" +Uses NVME_IOCTL_ADMIN_CMD for the ioctl request. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_submit_io_passthru.2 b/doc/man/nvme_submit_io_passthru.2 new file mode 100644 index 0000000..8319a47 --- /dev/null +++ b/doc/man/nvme_submit_io_passthru.2 @@ -0,0 +1,20 @@ +.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_submit_io_passthru \- Submit an nvme passthrough command +.SH SYNOPSIS +.B "int" nvme_submit_io_passthru +.BI "(int fd " "," +.BI "struct nvme_passthru_cmd *cmd " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "cmd" 12 +The nvme io command to send +.IP "result" 12 +Optional field to return the result from the CQE DW0 +.SH "DESCRIPTION" +Uses NVME_IOCTL_IO_CMD for the ioctl request. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_subsys_filter.2 b/doc/man/nvme_subsys_filter.2 new file mode 100644 index 0000000..c53a5e5 --- /dev/null +++ b/doc/man/nvme_subsys_filter.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsys_filter \- Filter for subsystems +.SH SYNOPSIS +.B "int" nvme_subsys_filter +.BI "(const struct dirent *d " ");" +.SH ARGUMENTS +.IP "d" 12 +dirent to check +.SH "RETURN" +1 if \fId\fP matches, 0 otherwise diff --git a/doc/man/nvme_subsys_type.2 b/doc/man/nvme_subsys_type.2 new file mode 100644 index 0000000..8abd195 --- /dev/null +++ b/doc/man/nvme_subsys_type.2 @@ -0,0 +1,37 @@ +.TH "libnvme" 9 "enum nvme_subsys_type" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_subsys_type \- Type of the NVM subsystem. +.SH SYNOPSIS +enum nvme_subsys_type { +.br +.BI " NVME_NQN_DISC" +, +.br +.br +.BI " NVME_NQN_NVME" +, +.br +.br +.BI " NVME_NQN_CURR" + +}; +.SH Constants +.IP "NVME_NQN_DISC" 12 +Discovery type target subsystem. Describes a referral to another +Discovery Service composed of Discovery controllers that provide +additional discovery records. Multiple Referral entries may +be reported for each Discovery Service (if that Discovery Service +has multiple NVM subsystem ports or supports multiple protocols). +.IP "NVME_NQN_NVME" 12 +NVME type target subsystem. Describes an NVM subsystem whose +controllers may have attached namespaces (an NVM subsystem +that is not composed of Discovery controllers). Multiple NVM +Subsystem entries may be reported for each NVM subsystem if +that NVM subsystem has multiple NVM subsystem ports. +.IP "NVME_NQN_CURR" 12 +Current Discovery type target subsystem. Describes this Discovery +subsystem (the Discovery Service that contains the controller +processing the Get Log Page command). Multiple Current Discovery +Subsystem entries may be reported for this Discovery subsystem +if the current Discovery subsystem has multiple NVM subsystem +ports. diff --git a/doc/man/nvme_subsystem_first_ctrl.2 b/doc/man/nvme_subsystem_first_ctrl.2 new file mode 100644 index 0000000..0080c21 --- /dev/null +++ b/doc/man/nvme_subsystem_first_ctrl.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_first_ctrl \- First ctrl iterator +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_subsystem_first_ctrl +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.SH "RETURN" +First controller of an \fIs\fP iterator diff --git a/doc/man/nvme_subsystem_first_ns.2 b/doc/man/nvme_subsystem_first_ns.2 new file mode 100644 index 0000000..77e6f06 --- /dev/null +++ b/doc/man/nvme_subsystem_first_ns.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_first_ns \- Start namespace iterator +.SH SYNOPSIS +.B "nvme_ns_t" nvme_subsystem_first_ns +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.SH "RETURN" +First \fInvme_ns_t\fP object of an \fIs\fP iterator diff --git a/doc/man/nvme_subsystem_for_each_ctrl.2 b/doc/man/nvme_subsystem_for_each_ctrl.2 new file mode 100644 index 0000000..b2f90f1 --- /dev/null +++ b/doc/man/nvme_subsystem_for_each_ctrl.2 @@ -0,0 +1,12 @@ +.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_for_each_ctrl \- Traverse controllers +.SH SYNOPSIS +.B "nvme_subsystem_for_each_ctrl +.BI "(s " "," +.BI "c " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "c" 12 +Controller instance diff --git a/doc/man/nvme_subsystem_for_each_ctrl_safe.2 b/doc/man/nvme_subsystem_for_each_ctrl_safe.2 new file mode 100644 index 0000000..5c61ad8 --- /dev/null +++ b/doc/man/nvme_subsystem_for_each_ctrl_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_for_each_ctrl_safe \- Traverse controllers +.SH SYNOPSIS +.B "nvme_subsystem_for_each_ctrl_safe +.BI "(s " "," +.BI "c " "," +.BI "_c " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "c" 12 +Controller instance +.IP "_c" 12 +A \fInvme_ctrl_t_node\fP to use as temporary storage diff --git a/doc/man/nvme_subsystem_for_each_ns.2 b/doc/man/nvme_subsystem_for_each_ns.2 new file mode 100644 index 0000000..ed20603 --- /dev/null +++ b/doc/man/nvme_subsystem_for_each_ns.2 @@ -0,0 +1,12 @@ +.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_for_each_ns \- Traverse namespaces +.SH SYNOPSIS +.B "nvme_subsystem_for_each_ns +.BI "(s " "," +.BI "n " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "n" 12 +\fInvme_ns_t\fP object diff --git a/doc/man/nvme_subsystem_for_each_ns_safe.2 b/doc/man/nvme_subsystem_for_each_ns_safe.2 new file mode 100644 index 0000000..7b565bf --- /dev/null +++ b/doc/man/nvme_subsystem_for_each_ns_safe.2 @@ -0,0 +1,15 @@ +.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_for_each_ns_safe \- Traverse namespaces +.SH SYNOPSIS +.B "nvme_subsystem_for_each_ns_safe +.BI "(s " "," +.BI "n " "," +.BI "_n " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "n" 12 +\fInvme_ns_t\fP object +.IP "_n" 12 +A \fInvme_ns_t_node\fP to use as temporary storage diff --git a/doc/man/nvme_subsystem_get_host.2 b/doc/man/nvme_subsystem_get_host.2 new file mode 100644 index 0000000..cdabc3f --- /dev/null +++ b/doc/man/nvme_subsystem_get_host.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_get_host \- Returns nvme_host_t object +.SH SYNOPSIS +.B "nvme_host_t" nvme_subsystem_get_host +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +subsystem +.SH "RETURN" +\fInvme_host_t\fP object from \fIs\fP diff --git a/doc/man/nvme_subsystem_get_name.2 b/doc/man/nvme_subsystem_get_name.2 new file mode 100644 index 0000000..a5c7335 --- /dev/null +++ b/doc/man/nvme_subsystem_get_name.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_get_name \- sysfs name of an nvme_subsystem_t object +.SH SYNOPSIS +.B "const char *" nvme_subsystem_get_name +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +nvme_subsystem_t object +.SH "RETURN" +sysfs name of \fIs\fP diff --git a/doc/man/nvme_subsystem_get_nqn.2 b/doc/man/nvme_subsystem_get_nqn.2 new file mode 100644 index 0000000..45aea5e --- /dev/null +++ b/doc/man/nvme_subsystem_get_nqn.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_get_nqn \- Retrieve NQN from subsystem +.SH SYNOPSIS +.B "const char *" nvme_subsystem_get_nqn +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +nvme_subsystem_t object +.SH "RETURN" +NQN of systemstem diff --git a/doc/man/nvme_subsystem_get_sysfs_dir.2 b/doc/man/nvme_subsystem_get_sysfs_dir.2 new file mode 100644 index 0000000..d07e445 --- /dev/null +++ b/doc/man/nvme_subsystem_get_sysfs_dir.2 @@ -0,0 +1,11 @@ +.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_get_sysfs_dir \- sysfs directory of an nvme_subsystem_t object +.SH SYNOPSIS +.B "const char *" nvme_subsystem_get_sysfs_dir +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +nvme_subsystem_t object +.SH "RETURN" +sysfs directory name of \fIs\fP diff --git a/doc/man/nvme_subsystem_get_type.2 b/doc/man/nvme_subsystem_get_type.2 new file mode 100644 index 0000000..55c1b99 --- /dev/null +++ b/doc/man/nvme_subsystem_get_type.2 @@ -0,0 +1,13 @@ +.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_get_type \- Returns the type of a subsystem +.SH SYNOPSIS +.B "const char *" nvme_subsystem_get_type +.BI "(nvme_subsystem_t s " ");" +.SH ARGUMENTS +.IP "s" 12 +nvme_subsystem_t object +.SH "DESCRIPTION" +Returns the subsystem type of \fIs\fP. +.SH "RETURN" +'nvm' or 'discovery' diff --git a/doc/man/nvme_subsystem_lookup_namespace.2 b/doc/man/nvme_subsystem_lookup_namespace.2 new file mode 100644 index 0000000..201c3fd --- /dev/null +++ b/doc/man/nvme_subsystem_lookup_namespace.2 @@ -0,0 +1,14 @@ +.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_lookup_namespace \- lookup namespace by NSID +.SH SYNOPSIS +.B "nvme_ns_t" nvme_subsystem_lookup_namespace +.BI "(struct nvme_subsystem *s " "," +.BI "__u32 nsid " ");" +.SH ARGUMENTS +.IP "s" 12 +nvme_subsystem_t object +.IP "nsid" 12 +Namespace id +.SH "RETURN" +nvme_ns_t of the namespace with id \fInsid\fP in subsystem \fIs\fP diff --git a/doc/man/nvme_subsystem_next_ctrl.2 b/doc/man/nvme_subsystem_next_ctrl.2 new file mode 100644 index 0000000..971ab8a --- /dev/null +++ b/doc/man/nvme_subsystem_next_ctrl.2 @@ -0,0 +1,14 @@ +.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_next_ctrl \- Next ctrl iterator +.SH SYNOPSIS +.B "nvme_ctrl_t" nvme_subsystem_next_ctrl +.BI "(nvme_subsystem_t s " "," +.BI "nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "c" 12 +Previous controller instance of an \fIs\fP iterator +.SH "RETURN" +Next controller of an \fIs\fP iterator diff --git a/doc/man/nvme_subsystem_next_ns.2 b/doc/man/nvme_subsystem_next_ns.2 new file mode 100644 index 0000000..fad424e --- /dev/null +++ b/doc/man/nvme_subsystem_next_ns.2 @@ -0,0 +1,14 @@ +.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_next_ns \- Next namespace iterator +.SH SYNOPSIS +.B "nvme_ns_t" nvme_subsystem_next_ns +.BI "(nvme_subsystem_t s " "," +.BI "nvme_ns_t n " ");" +.SH ARGUMENTS +.IP "s" 12 +\fInvme_subsystem_t\fP object +.IP "n" 12 +Previous \fInvme_ns_t\fP iterator +.SH "RETURN" +Next \fInvme_ns_t\fP object of an \fIs\fP iterator diff --git a/doc/man/nvme_subsystem_reset.2 b/doc/man/nvme_subsystem_reset.2 new file mode 100644 index 0000000..6f96dcf --- /dev/null +++ b/doc/man/nvme_subsystem_reset.2 @@ -0,0 +1,14 @@ +.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_subsystem_reset \- Initiate a subsystem reset +.SH SYNOPSIS +.B "int" nvme_subsystem_reset +.BI "(int fd " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.SH "DESCRIPTION" +This should only be sent to controller handles, not to namespaces. +.SH "RETURN" +Zero if a subsystem reset was initiated or -1 with errno set +otherwise. diff --git a/doc/man/nvme_supported_cap_config_list_log.2 b/doc/man/nvme_supported_cap_config_list_log.2 new file mode 100644 index 0000000..b842e36 --- /dev/null +++ b/doc/man/nvme_supported_cap_config_list_log.2 @@ -0,0 +1,22 @@ +.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_supported_cap_config_list_log \- +.SH SYNOPSIS +struct nvme_supported_cap_config_list_log { +.br +.BI " __u8 sccn;" +.br +.BI " __u8 rsvd1[15];" +.br +.BI " struct nvme_capacity_config_desc cap_config_desc[];" +.br +.BI " +}; +.br + +.SH Members +.IP "sccn" 12 +number of capacity configuration +.SH "Description" +Supported Capacity Configuration list log page +structure definitions diff --git a/doc/man/nvme_supported_log_pages.2 b/doc/man/nvme_supported_log_pages.2 new file mode 100644 index 0000000..4ff8d55 --- /dev/null +++ b/doc/man/nvme_supported_log_pages.2 @@ -0,0 +1,17 @@ +.TH "libnvme" 9 "struct nvme_supported_log_pages" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_supported_log_pages \- +.SH SYNOPSIS +struct nvme_supported_log_pages { +.br +.BI " __le32 lid_support[NVME_LOG_SUPPORTED_LOG_PAGES_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "lid_support" 12 +Log Page Identifier Supported +.SH "Description" +Supported Log Pages (Log Identifier 00h) diff --git a/doc/man/nvme_telemetry_da.2 b/doc/man/nvme_telemetry_da.2 new file mode 100644 index 0000000..7ba72d7 --- /dev/null +++ b/doc/man/nvme_telemetry_da.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_telemetry_da" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_telemetry_da \- Telemetry Log Data Area +.SH SYNOPSIS +enum nvme_telemetry_da { +.br +.BI " NVME_TELEMETRY_DA_1" +, +.br +.br +.BI " NVME_TELEMETRY_DA_2" +, +.br +.br +.BI " NVME_TELEMETRY_DA_3" +, +.br +.br +.BI " NVME_TELEMETRY_DA_4" + +}; +.SH Constants +.IP "NVME_TELEMETRY_DA_1" 12 +Data Area 1 +.IP "NVME_TELEMETRY_DA_2" 12 +Data Area 2 +.IP "NVME_TELEMETRY_DA_3" 12 +Data Area 3 +.IP "NVME_TELEMETRY_DA_4" 12 +Data Area 4 diff --git a/doc/man/nvme_telemetry_log.2 b/doc/man/nvme_telemetry_log.2 new file mode 100644 index 0000000..4ee5d67 --- /dev/null +++ b/doc/man/nvme_telemetry_log.2 @@ -0,0 +1,88 @@ +.TH "libnvme" 9 "struct nvme_telemetry_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_telemetry_log \- Retrieve internal data specific to the manufacturer. +.SH SYNOPSIS +struct nvme_telemetry_log { +.br +.BI " __u8 lpi;" +.br +.BI " __u8 rsvd1[4];" +.br +.BI " __u8 ieee[3];" +.br +.BI " __le16 dalb1;" +.br +.BI " __le16 dalb2;" +.br +.BI " __le16 dalb3;" +.br +.BI " __u8 rsvd14[2];" +.br +.BI " __le32 dalb4;" +.br +.BI " __u8 rsvd20[361];" +.br +.BI " __u8 hostdgn;" +.br +.BI " __u8 ctrlavail;" +.br +.BI " __u8 ctrldgn;" +.br +.BI " __u8 rsnident[128];" +.br +.BI " __u8 data_area[];" +.br +.BI " +}; +.br + +.SH Members +.IP "lpi" 12 +Log Identifier, either NVME_LOG_LID_TELEMETRY_HOST or +NVME_LOG_LID_TELEMETRY_CTRL +.IP "rsvd1" 12 +Reserved +.IP "ieee" 12 +IEEE OUI Identifier is the Organization Unique Identifier (OUI) +for the controller vendor that is able to interpret the data. +.IP "dalb1" 12 +Telemetry Controller-Initiated Data Area 1 Last Block is +the value of the last block in this area. +.IP "dalb2" 12 +Telemetry Controller-Initiated Data Area 1 Last Block is +the value of the last block in this area. +.IP "dalb3" 12 +Telemetry Controller-Initiated Data Area 1 Last Block is +the value of the last block in this area. +.IP "rsvd14" 12 +Reserved +.IP "dalb4" 12 +Telemetry Controller-Initiated Data Area 4 Last Block is +the value of the last block in this area. +.IP "rsvd20" 12 +Reserved +.IP "hostdgn" 12 +Telemetry Host-Initiated Data Generation Number is a +value that is incremented each time the host initiates a +capture of its internal controller state in the controller . +.IP "ctrlavail" 12 +Telemetry Controller-Initiated Data Available, if cleared, +then the controller telemetry log does not contain saved +internal controller state. If this field is set to 1h, the +controller log contains saved internal controller state. If +this field is set to 1h, the data will be latched until the +host releases it by reading the log with RAE cleared. +.IP "ctrldgn" 12 +Telemetry Controller-Initiated Data Generation Number is +a value that is incremented each time the controller initiates a +capture of its internal controller state in the controller . +.IP "rsnident" 12 +Reason Identifieris a vendor specific identifier that describes +the operating conditions of the controller at the time of +capture. +.IP "data_area" 12 +Telemetry data blocks, vendor specific information data. +.SH "Description" +This log consists of a header describing the log and zero or more Telemetry +Data Blocks. All Telemetry Data Blocks are NVME_LOG_TELEM_BLOCK_SIZE, 512 +bytes, in size. This log captures the controller’s internal state. diff --git a/doc/man/nvme_thermal_exc_event.2 b/doc/man/nvme_thermal_exc_event.2 new file mode 100644 index 0000000..a50ff57 --- /dev/null +++ b/doc/man/nvme_thermal_exc_event.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_thermal_exc_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_thermal_exc_event \- +.SH SYNOPSIS +struct nvme_thermal_exc_event { +.br +.BI " __u8 over_temp;" +.br +.BI " __u8 threshold;" +.br +.BI " +}; +.br + +.SH Members +.IP "over_temp" 12 +Over Temperature +.IP "threshold" 12 +temperature threshold diff --git a/doc/man/nvme_time_stamp_change_event.2 b/doc/man/nvme_time_stamp_change_event.2 new file mode 100644 index 0000000..3a01771 --- /dev/null +++ b/doc/man/nvme_time_stamp_change_event.2 @@ -0,0 +1,19 @@ +.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_time_stamp_change_event \- +.SH SYNOPSIS +struct nvme_time_stamp_change_event { +.br +.BI " __le64 previous_timestamp;" +.br +.BI " __le64 ml_secs_since_reset;" +.br +.BI " +}; +.br + +.SH Members +.IP "previous_timestamp" 12 +Previous Timestamp +.IP "ml_secs_since_reset" 12 +Milliseconds Since Reset diff --git a/doc/man/nvme_timestamp.2 b/doc/man/nvme_timestamp.2 new file mode 100644 index 0000000..97d6ee3 --- /dev/null +++ b/doc/man/nvme_timestamp.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_timestamp" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_timestamp \- +.SH SYNOPSIS +struct nvme_timestamp { +.br +.BI " __u8 timestamp[6];" +.br +.BI " __u8 attr;" +.br +.BI " __u8 rsvd;" +.br +.BI " +}; +.br + +.SH Members +.IP "timestamp" 12 +Timestamp value based on origin and synch field +.IP "attr" 12 +Attribute +.IP "rsvd" 12 +Reserved diff --git a/doc/man/nvme_unlink_ctrl.2 b/doc/man/nvme_unlink_ctrl.2 new file mode 100644 index 0000000..8ef69e8 --- /dev/null +++ b/doc/man/nvme_unlink_ctrl.2 @@ -0,0 +1,9 @@ +.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_unlink_ctrl \- Unlink controller +.SH SYNOPSIS +.B "void" nvme_unlink_ctrl +.BI "(struct nvme_ctrl *c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance diff --git a/doc/man/nvme_update_config.2 b/doc/man/nvme_update_config.2 new file mode 100644 index 0000000..c3357e2 --- /dev/null +++ b/doc/man/nvme_update_config.2 @@ -0,0 +1,13 @@ +.TH "nvme_update_config" 9 "nvme_update_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_update_config \- Update JSON configuration +.SH SYNOPSIS +.B "int" nvme_update_config +.BI "(nvme_root_t r " ");" +.SH ARGUMENTS +.IP "r" 12 +nvme_root_t object +.SH "DESCRIPTION" +Updates the JSON configuration file with the contents of \fIr\fP. +.SH "RETURN" +0 on success, -1 on failure. diff --git a/doc/man/nvme_verify.2 b/doc/man/nvme_verify.2 new file mode 100644 index 0000000..000ae7f --- /dev/null +++ b/doc/man/nvme_verify.2 @@ -0,0 +1,16 @@ +.TH "nvme_verify" 9 "nvme_verify" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_verify \- Send an nvme verify command +.SH SYNOPSIS +.B "int" nvme_verify +.BI "(struct nvme_io_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.SH "DESCRIPTION" +The Verify command verifies integrity of stored information by reading data +and metadata, if applicable, for the LBAs indicated without transferring any +data or metadata to the host. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_virt_mgmt_act.2 b/doc/man/nvme_virt_mgmt_act.2 new file mode 100644 index 0000000..a04cf35 --- /dev/null +++ b/doc/man/nvme_virt_mgmt_act.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_virt_mgmt_act \- +.SH SYNOPSIS +enum nvme_virt_mgmt_act { +.br +.BI " NVME_VIRT_MGMT_ACT_PRIM_CTRL_FLEX_ALLOC" +, +.br +.br +.BI " NVME_VIRT_MGMT_ACT_OFFLINE_SEC_CTRL" +, +.br +.br +.BI " NVME_VIRT_MGMT_ACT_ASSIGN_SEC_CTRL" +, +.br +.br +.BI " NVME_VIRT_MGMT_ACT_ONLINE_SEC_CTRL" + +}; +.SH Constants +.IP "NVME_VIRT_MGMT_ACT_PRIM_CTRL_FLEX_ALLOC" 12 +Primary Controller Flexible +Allocation +.IP "NVME_VIRT_MGMT_ACT_OFFLINE_SEC_CTRL" 12 +Secondary Controller Offline +.IP "NVME_VIRT_MGMT_ACT_ASSIGN_SEC_CTRL" 12 +Secondary Controller Assign +.IP "NVME_VIRT_MGMT_ACT_ONLINE_SEC_CTRL" 12 +Secondary Controller Online diff --git a/doc/man/nvme_virt_mgmt_rt.2 b/doc/man/nvme_virt_mgmt_rt.2 new file mode 100644 index 0000000..99db5e0 --- /dev/null +++ b/doc/man/nvme_virt_mgmt_rt.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_virt_mgmt_rt \- +.SH SYNOPSIS +enum nvme_virt_mgmt_rt { +.br +.BI " NVME_VIRT_MGMT_RT_VQ_RESOURCE" +, +.br +.br +.BI " NVME_VIRT_MGMT_RT_VI_RESOURCE" + +}; +.SH Constants +.IP "NVME_VIRT_MGMT_RT_VQ_RESOURCE" 12 +VQ Resources +.IP "NVME_VIRT_MGMT_RT_VI_RESOURCE" 12 +VI Resources diff --git a/doc/man/nvme_virtual_mgmt.2 b/doc/man/nvme_virtual_mgmt.2 new file mode 100644 index 0000000..ece162d --- /dev/null +++ b/doc/man/nvme_virtual_mgmt.2 @@ -0,0 +1,20 @@ +.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_virtual_mgmt \- Virtualization resource management +.SH SYNOPSIS +.B "int" nvme_virtual_mgmt +.BI "(struct nvme_virtual_mgmt_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_virtual_mgmt_args\fP argument structure +.SH "DESCRIPTION" +The Virtualization Management command is supported by primary controllers +that support the Virtualization Enhancements capability. This command is +used for several functions: + +- Modifying Flexible Resource allocation for the primary controller +- Assigning Flexible Resources for secondary controllers +- Setting the Online and Offline state for secondary controllers +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_virtual_mgmt_args.2 b/doc/man/nvme_virtual_mgmt_args.2 new file mode 100644 index 0000000..d072b4c --- /dev/null +++ b/doc/man/nvme_virtual_mgmt_args.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "struct nvme_virtual_mgmt_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_virtual_mgmt_args \- Arguments for the NVMe Virtualization resource management command +.SH SYNOPSIS +struct nvme_virtual_mgmt_args { +.br +.BI " __u32 *result;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " enum nvme_virt_mgmt_act act;" +.br +.BI " enum nvme_virt_mgmt_rt rt;" +.br +.BI " __u16 cntlid;" +.br +.BI " __u16 nr;" +.br +.BI " +}; +.br + +.SH Members +.IP "result" 12 +If successful, the CQE dword0 +.IP "args_size" 12 +Size of \fIstruct nvme_virtual_mgmt_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "act" 12 +Virtual resource action, see \fIenum nvme_virt_mgmt_act\fP +.IP "rt" 12 +Resource type to modify, see \fIenum nvme_virt_mgmt_rt\fP +.IP "cntlid" 12 +Controller id for which resources are bing modified +.IP "nr" 12 +Number of resources being allocated or assigned diff --git a/doc/man/nvme_write.2 b/doc/man/nvme_write.2 new file mode 100644 index 0000000..ca701a9 --- /dev/null +++ b/doc/man/nvme_write.2 @@ -0,0 +1,12 @@ +.TH "nvme_write" 9 "nvme_write" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_write \- Submit an nvme user write command +.SH SYNOPSIS +.B "int" nvme_write +.BI "(struct nvme_io_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_write_uncorrectable.2 b/doc/man/nvme_write_uncorrectable.2 new file mode 100644 index 0000000..018f526 --- /dev/null +++ b/doc/man/nvme_write_uncorrectable.2 @@ -0,0 +1,17 @@ +.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_write_uncorrectable \- Submit an nvme write uncorrectable command +.SH SYNOPSIS +.B "int" nvme_write_uncorrectable +.BI "(struct nvme_io_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.SH "DESCRIPTION" +The Write Uncorrectable command marks a range of logical blocks as invalid. +When the specified logical block(s) are read after this operation, a failure +is returned with Unrecovered Read Error status. To clear the invalid logical +block status, a write operation on those logical blocks is required. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_write_zeros.2 b/doc/man/nvme_write_zeros.2 new file mode 100644 index 0000000..26f17e0 --- /dev/null +++ b/doc/man/nvme_write_zeros.2 @@ -0,0 +1,17 @@ +.TH "nvme_write_zeros" 9 "nvme_write_zeros" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_write_zeros \- Submit an nvme write zeroes command +.SH SYNOPSIS +.B "int" nvme_write_zeros +.BI "(struct nvme_io_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_io_args\fP argument structure +.SH "DESCRIPTION" +The Write Zeroes command sets a range of logical blocks to zero. After +successful completion of this command, the value returned by subsequent +reads of logical blocks in this range shall be all bytes cleared to 0h until +a write occurs to this LBA range. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_append.2 b/doc/man/nvme_zns_append.2 new file mode 100644 index 0000000..ee381ea --- /dev/null +++ b/doc/man/nvme_zns_append.2 @@ -0,0 +1,12 @@ +.TH "nvme_zns_append" 9 "nvme_zns_append" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_zns_append \- Append data to a zone +.SH SYNOPSIS +.B "int" nvme_zns_append +.BI "(struct nvme_zns_append_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_zns_append_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_append_args.2 b/doc/man/nvme_zns_append_args.2 new file mode 100644 index 0000000..7c87dce --- /dev/null +++ b/doc/man/nvme_zns_append_args.2 @@ -0,0 +1,70 @@ +.TH "libnvme" 9 "struct nvme_zns_append_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_append_args \- Arguments for the NVMe ZNS Append command +.SH SYNOPSIS +struct nvme_zns_append_args { +.br +.BI " __u64 zslba;" +.br +.BI " __u64 *result;" +.br +.BI " void *data;" +.br +.BI " void *metadata;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 ilbrt;" +.br +.BI " __u32 data_len;" +.br +.BI " __u32 metadata_len;" +.br +.BI " __u16 nlb;" +.br +.BI " __u16 control;" +.br +.BI " __u16 lbat;" +.br +.BI " __u16 lbatm;" +.br +.BI " +}; +.br + +.SH Members +.IP "zslba" 12 +Zone start logical block address +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Userspace address of the data +.IP "metadata" 12 +Userspace address of the metadata +.IP "args_size" 12 +Size of \fIstruct nvme_zns_append_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +Timeout in ms +.IP "nsid" 12 +Namespace ID +.IP "ilbrt" 12 +Initial logical block reference tag +.IP "data_len" 12 +Length of \fIdata\fP +.IP "metadata_len" 12 +Length of \fImetadata\fP +.IP "nlb" 12 +Number of logical blocks +.IP "control" 12 +.IP "lbat" 12 +Logical block application tag +.IP "lbatm" 12 +Logical block application tag mask diff --git a/doc/man/nvme_zns_changed_zone_log.2 b/doc/man/nvme_zns_changed_zone_log.2 new file mode 100644 index 0000000..31a9aef --- /dev/null +++ b/doc/man/nvme_zns_changed_zone_log.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_changed_zone_log \- ZNS Changed Zone List log +.SH SYNOPSIS +struct nvme_zns_changed_zone_log { +.br +.BI " __le16 nrzid;" +.br +.BI " __u8 rsvd2[6];" +.br +.BI " __le64 zid[NVME_ZNS_CHANGED_ZONES_MAX];" +.br +.BI " +}; +.br + +.SH Members +.IP "nrzid" 12 +Number of Zone Identifiers +.IP "rsvd2" 12 +Reserved +.IP "zid" 12 +Zone Identifier diff --git a/doc/man/nvme_zns_desc.2 b/doc/man/nvme_zns_desc.2 new file mode 100644 index 0000000..06bc3a4 --- /dev/null +++ b/doc/man/nvme_zns_desc.2 @@ -0,0 +1,47 @@ +.TH "libnvme" 9 "struct nvme_zns_desc" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_desc \- +.SH SYNOPSIS +struct nvme_zns_desc { +.br +.BI " __u8 zt;" +.br +.BI " __u8 zs;" +.br +.BI " __u8 za;" +.br +.BI " __u8 zai;" +.br +.BI " __u8 rsvd4[4];" +.br +.BI " __le64 zcap;" +.br +.BI " __le64 zslba;" +.br +.BI " __le64 wp;" +.br +.BI " __u8 rsvd32[32];" +.br +.BI " +}; +.br + +.SH Members +.IP "zt" 12 +Zone Type +.IP "zs" 12 +Zone State +.IP "za" 12 +Zone Attributes +.IP "zai" 12 +Zone Attributes Information +.IP "rsvd4" 12 +Reserved +.IP "zcap" 12 +Zone Capacity +.IP "zslba" 12 +Zone Start Logical Block Address +.IP "wp" 12 +Write Pointer +.IP "rsvd32" 12 +Reserved diff --git a/doc/man/nvme_zns_id_ctrl.2 b/doc/man/nvme_zns_id_ctrl.2 new file mode 100644 index 0000000..fc0898f --- /dev/null +++ b/doc/man/nvme_zns_id_ctrl.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_id_ctrl \- +.SH SYNOPSIS +struct nvme_zns_id_ctrl { +.br +.BI " __u8 zasl;" +.br +.BI " __u8 rsvd1[4095];" +.br +.BI " +}; +.br + +.SH Members +.IP "zasl" 12 +.IP "rsvd1" 12 +Reserved diff --git a/doc/man/nvme_zns_id_ns.2 b/doc/man/nvme_zns_id_ns.2 new file mode 100644 index 0000000..4e9ac06 --- /dev/null +++ b/doc/man/nvme_zns_id_ns.2 @@ -0,0 +1,87 @@ +.TH "libnvme" 9 "struct nvme_zns_id_ns" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_id_ns \- Zoned Namespace Command Set Specific Identify Namespace Data Structure +.SH SYNOPSIS +struct nvme_zns_id_ns { +.br +.BI " __le16 zoc;" +.br +.BI " __le16 ozcs;" +.br +.BI " __le32 mar;" +.br +.BI " __le32 mor;" +.br +.BI " __le32 rrl;" +.br +.BI " __le32 frl;" +.br +.BI " __le32 rrl1;" +.br +.BI " __le32 rrl2;" +.br +.BI " __le32 rrl3;" +.br +.BI " __le32 frl1;" +.br +.BI " __le32 frl2;" +.br +.BI " __le32 frl3;" +.br +.BI " __le32 numzrwa;" +.br +.BI " __le16 zrwafg;" +.br +.BI " __le16 zrwasz;" +.br +.BI " __u8 zrwacap;" +.br +.BI " __u8 rsvd53[2763];" +.br +.BI " struct nvme_zns_lbafe lbafe[64];" +.br +.BI " __u8 vs[256];" +.br +.BI " +}; +.br + +.SH Members +.IP "zoc" 12 +Zone Operation Characteristics +.IP "ozcs" 12 +Optional Zoned Command Support +.IP "mar" 12 +Maximum Active Resources +.IP "mor" 12 +Maximum Open Resources +.IP "rrl" 12 +Reset Recommended Limit +.IP "frl" 12 +Finish Recommended Limit +.IP "rrl1" 12 +Reset Recommended Limit 1 +.IP "rrl2" 12 +Reset Recommended Limit 2 +.IP "rrl3" 12 +Reset Recommended Limit 3 +.IP "frl1" 12 +Finish Recommended Limit 1 +.IP "frl2" 12 +Finish Recommended Limit 2 +.IP "frl3" 12 +Finish Recommended Limit 3 +.IP "numzrwa" 12 +Number of ZRWA Resources +.IP "zrwafg" 12 +ZRWA Flush Granularity +.IP "zrwasz" 12 +ZRWA Size +.IP "zrwacap" 12 +ZRWA Capability +.IP "rsvd53" 12 +Reserved +.IP "lbafe" 12 +LBA Format Extension +.IP "vs" 12 +Vendor Specific diff --git a/doc/man/nvme_zns_identify_ctrl.2 b/doc/man/nvme_zns_identify_ctrl.2 new file mode 100644 index 0000000..bf3ebd3 --- /dev/null +++ b/doc/man/nvme_zns_identify_ctrl.2 @@ -0,0 +1,15 @@ +.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_zns_identify_ctrl \- ZNS identify controller data +.SH SYNOPSIS +.B "int" nvme_zns_identify_ctrl +.BI "(int fd " "," +.BI "struct nvme_zns_id_ctrl *id " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "id" 12 +User space destination address to transfer the data +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_identify_ns.2 b/doc/man/nvme_zns_identify_ns.2 new file mode 100644 index 0000000..4b95bb9 --- /dev/null +++ b/doc/man/nvme_zns_identify_ns.2 @@ -0,0 +1,18 @@ +.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_zns_identify_ns \- ZNS identify namespace data +.SH SYNOPSIS +.B "int" nvme_zns_identify_ns +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "struct nvme_zns_id_ns *data " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace to identify +.IP "data" 12 +User space destination address to transfer the data +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_lbafe.2 b/doc/man/nvme_zns_lbafe.2 new file mode 100644 index 0000000..846d775 --- /dev/null +++ b/doc/man/nvme_zns_lbafe.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_zns_lbafe" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_lbafe \- +.SH SYNOPSIS +struct nvme_zns_lbafe { +.br +.BI " __le64 zsze;" +.br +.BI " __u8 zdes;" +.br +.BI " __u8 rsvd9[7];" +.br +.BI " +}; +.br + +.SH Members +.IP "zsze" 12 +Zone Size +.IP "zdes" 12 +Zone Descriptor Extension Size +.IP "rsvd9" 12 +reserved diff --git a/doc/man/nvme_zns_mgmt_recv.2 b/doc/man/nvme_zns_mgmt_recv.2 new file mode 100644 index 0000000..222d828 --- /dev/null +++ b/doc/man/nvme_zns_mgmt_recv.2 @@ -0,0 +1,12 @@ +.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_zns_mgmt_recv \- +.SH SYNOPSIS +.B "int" nvme_zns_mgmt_recv +.BI "(struct nvme_zns_mgmt_recv_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_zns_mgmt_recv_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_mgmt_recv_args.2 b/doc/man/nvme_zns_mgmt_recv_args.2 new file mode 100644 index 0000000..556b136 --- /dev/null +++ b/doc/man/nvme_zns_mgmt_recv_args.2 @@ -0,0 +1,55 @@ +.TH "libnvme" 9 "struct nvme_zns_mgmt_recv_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_mgmt_recv_args \- Arguments for the NVMe ZNS Management Receive command +.SH SYNOPSIS +struct nvme_zns_mgmt_recv_args { +.br +.BI " __u64 slba;" +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_zns_recv_action zra;" +.br +.BI " __u32 data_len;" +.br +.BI " __u16 zrasf;" +.br +.BI " bool zras_feat;" +.br +.BI " +}; +.br + +.SH Members +.IP "slba" 12 +Starting logical block address +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Userspace address of the data +.IP "args_size" 12 +Size of \fIstruct nvme_zns_mgmt_recv_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +timeout in ms +.IP "nsid" 12 +Namespace ID +.IP "zra" 12 +zone receive action +.IP "data_len" 12 +Length of \fIdata\fP +.IP "zrasf" 12 +Zone receive action specific field +.IP "zras_feat" 12 +Zone receive action specific features diff --git a/doc/man/nvme_zns_mgmt_send.2 b/doc/man/nvme_zns_mgmt_send.2 new file mode 100644 index 0000000..e91a032 --- /dev/null +++ b/doc/man/nvme_zns_mgmt_send.2 @@ -0,0 +1,12 @@ +.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_zns_mgmt_send \- +.SH SYNOPSIS +.B "int" nvme_zns_mgmt_send +.BI "(struct nvme_zns_mgmt_send_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_zns_mgmt_send_args\fP argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_mgmt_send_args.2 b/doc/man/nvme_zns_mgmt_send_args.2 new file mode 100644 index 0000000..0b1b53c --- /dev/null +++ b/doc/man/nvme_zns_mgmt_send_args.2 @@ -0,0 +1,55 @@ +.TH "libnvme" 9 "struct nvme_zns_mgmt_send_args" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zns_mgmt_send_args \- Arguments for the NVMe ZNS Management Send command +.SH SYNOPSIS +struct nvme_zns_mgmt_send_args { +.br +.BI " __u64 slba;" +.br +.BI " __u32 *result;" +.br +.BI " void *data;" +.br +.BI " int args_size;" +.br +.BI " int fd;" +.br +.BI " __u32 timeout;" +.br +.BI " __u32 nsid;" +.br +.BI " enum nvme_zns_send_action zsa;" +.br +.BI " __u32 data_len;" +.br +.BI " bool select_all;" +.br +.BI " __u8 zsaso;" +.br +.BI " +}; +.br + +.SH Members +.IP "slba" 12 +Starting logical block address +.IP "result" 12 +The command completion result from CQE dword0 +.IP "data" 12 +Userspace address of the data +.IP "args_size" 12 +Size of \fIstruct nvme_zns_mgmt_send_args\fP +.IP "fd" 12 +File descriptor of nvme device +.IP "timeout" 12 +timeout in ms +.IP "nsid" 12 +Namespace ID +.IP "zsa" 12 +Zone send action +.IP "data_len" 12 +Length of \fIdata\fP +.IP "select_all" 12 +Select all flag +.IP "zsaso" 12 +Zone Send Action Specific Option diff --git a/doc/man/nvme_zns_recv_action.2 b/doc/man/nvme_zns_recv_action.2 new file mode 100644 index 0000000..a14d83e --- /dev/null +++ b/doc/man/nvme_zns_recv_action.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_zns_recv_action" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_zns_recv_action \- +.SH SYNOPSIS +enum nvme_zns_recv_action { +.br +.BI " NVME_ZNS_ZRA_REPORT_ZONES" +, +.br +.br +.BI " NVME_ZNS_ZRA_EXTENDED_REPORT_ZONES" + +}; +.SH Constants +.IP "NVME_ZNS_ZRA_REPORT_ZONES" 12 +Report Zones +.IP "NVME_ZNS_ZRA_EXTENDED_REPORT_ZONES" 12 +Extended Report Zones diff --git a/doc/man/nvme_zns_report_options.2 b/doc/man/nvme_zns_report_options.2 new file mode 100644 index 0000000..f938ffd --- /dev/null +++ b/doc/man/nvme_zns_report_options.2 @@ -0,0 +1,54 @@ +.TH "libnvme" 9 "enum nvme_zns_report_options" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_zns_report_options \- +.SH SYNOPSIS +enum nvme_zns_report_options { +.br +.BI " NVME_ZNS_ZRAS_REPORT_ALL" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_EMPTY" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_IMPL_OPENED" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_EXPL_OPENED" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_CLOSED" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_FULL" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_READ_ONLY" +, +.br +.br +.BI " NVME_ZNS_ZRAS_REPORT_OFFLINE" + +}; +.SH Constants +.IP "NVME_ZNS_ZRAS_REPORT_ALL" 12 +List all zones +.IP "NVME_ZNS_ZRAS_REPORT_EMPTY" 12 +List the zones in the ZSE:Empty state +.IP "NVME_ZNS_ZRAS_REPORT_IMPL_OPENED" 12 +List the zones in the ZSIO:Implicitly Opened state +.IP "NVME_ZNS_ZRAS_REPORT_EXPL_OPENED" 12 +List the zones in the ZSEO:Explicitly Opened state +.IP "NVME_ZNS_ZRAS_REPORT_CLOSED" 12 +List the zones in the ZSC:Closed state +.IP "NVME_ZNS_ZRAS_REPORT_FULL" 12 +List the zones in the ZSF:Full state +.IP "NVME_ZNS_ZRAS_REPORT_READ_ONLY" 12 +List the zones in the ZSRO:Read Only state +.IP "NVME_ZNS_ZRAS_REPORT_OFFLINE" 12 +List the zones in the ZSO:Offline state diff --git a/doc/man/nvme_zns_report_zones.2 b/doc/man/nvme_zns_report_zones.2 new file mode 100644 index 0000000..6d61605 --- /dev/null +++ b/doc/man/nvme_zns_report_zones.2 @@ -0,0 +1,39 @@ +.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvme_zns_report_zones \- Return the list of zones +.SH SYNOPSIS +.B "int" nvme_zns_report_zones +.BI "(int fd " "," +.BI "__u32 nsid " "," +.BI "__u64 slba " "," +.BI "enum nvme_zns_report_options opts " "," +.BI "bool extended " "," +.BI "bool partial " "," +.BI "__u32 data_len " "," +.BI "void *data " "," +.BI "__u32 timeout " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "nsid" 12 +Namespace ID +.IP "slba" 12 +Starting LBA +.IP "opts" 12 +Reporting options +.IP "extended" 12 +Extended report +.IP "partial" 12 +Partial report requested +.IP "data_len" 12 +Length of the data buffer +.IP "data" 12 +Userspace address of the report zones data +.IP "timeout" 12 +timeout in ms +.IP "result" 12 +The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_zns_send_action.2 b/doc/man/nvme_zns_send_action.2 new file mode 100644 index 0000000..0c13f63 --- /dev/null +++ b/doc/man/nvme_zns_send_action.2 @@ -0,0 +1,48 @@ +.TH "libnvme" 9 "enum nvme_zns_send_action" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_zns_send_action \- +.SH SYNOPSIS +enum nvme_zns_send_action { +.br +.BI " NVME_ZNS_ZSA_CLOSE" +, +.br +.br +.BI " NVME_ZNS_ZSA_FINISH" +, +.br +.br +.BI " NVME_ZNS_ZSA_OPEN" +, +.br +.br +.BI " NVME_ZNS_ZSA_RESET" +, +.br +.br +.BI " NVME_ZNS_ZSA_OFFLINE" +, +.br +.br +.BI " NVME_ZNS_ZSA_SET_DESC_EXT" +, +.br +.br +.BI " NVME_ZNS_ZSA_ZRWA_FLUSH" + +}; +.SH Constants +.IP "NVME_ZNS_ZSA_CLOSE" 12 +Close Zone +.IP "NVME_ZNS_ZSA_FINISH" 12 +Finish Zone +.IP "NVME_ZNS_ZSA_OPEN" 12 +Open Zone +.IP "NVME_ZNS_ZSA_RESET" 12 +Reset Zone +.IP "NVME_ZNS_ZSA_OFFLINE" 12 +Offline Zone +.IP "NVME_ZNS_ZSA_SET_DESC_EXT" 12 +Set Zone Descriptor Extension +.IP "NVME_ZNS_ZSA_ZRWA_FLUSH" 12 +Flush diff --git a/doc/man/nvme_zns_za.2 b/doc/man/nvme_zns_za.2 new file mode 100644 index 0000000..ab9cb27 --- /dev/null +++ b/doc/man/nvme_zns_za.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "enum nvme_zns_za" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_zns_za \- +.SH SYNOPSIS +enum nvme_zns_za { +.br +.BI " NVME_ZNS_ZA_ZFC" +, +.br +.br +.BI " NVME_ZNS_ZA_FZR" +, +.br +.br +.BI " NVME_ZNS_ZA_RZR" +, +.br +.br +.BI " NVME_ZNS_ZA_ZRWAV" +, +.br +.br +.BI " NVME_ZNS_ZA_ZDEV" + +}; +.SH Constants +.IP "NVME_ZNS_ZA_ZFC" 12 +Zone Finished by Controller +.IP "NVME_ZNS_ZA_FZR" 12 +Finish Zone Recommended +.IP "NVME_ZNS_ZA_RZR" 12 +Reset Zone Recommended +.IP "NVME_ZNS_ZA_ZRWAV" 12 +.IP "NVME_ZNS_ZA_ZDEV" 12 +Zone Descriptor Extension Valid diff --git a/doc/man/nvme_zns_zs.2 b/doc/man/nvme_zns_zs.2 new file mode 100644 index 0000000..ee0d193 --- /dev/null +++ b/doc/man/nvme_zns_zs.2 @@ -0,0 +1,48 @@ +.TH "libnvme" 9 "enum nvme_zns_zs" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_zns_zs \- +.SH SYNOPSIS +enum nvme_zns_zs { +.br +.BI " NVME_ZNS_ZS_EMPTY" +, +.br +.br +.BI " NVME_ZNS_ZS_IMPL_OPEN" +, +.br +.br +.BI " NVME_ZNS_ZS_EXPL_OPEN" +, +.br +.br +.BI " NVME_ZNS_ZS_CLOSED" +, +.br +.br +.BI " NVME_ZNS_ZS_READ_ONLY" +, +.br +.br +.BI " NVME_ZNS_ZS_FULL" +, +.br +.br +.BI " NVME_ZNS_ZS_OFFLINE" + +}; +.SH Constants +.IP "NVME_ZNS_ZS_EMPTY" 12 +Empty state +.IP "NVME_ZNS_ZS_IMPL_OPEN" 12 +Implicitly open state +.IP "NVME_ZNS_ZS_EXPL_OPEN" 12 +Explicitly open state +.IP "NVME_ZNS_ZS_CLOSED" 12 +Closed state +.IP "NVME_ZNS_ZS_READ_ONLY" 12 +Read only state +.IP "NVME_ZNS_ZS_FULL" 12 +Full state +.IP "NVME_ZNS_ZS_OFFLINE" 12 +Offline state diff --git a/doc/man/nvme_zns_zt.2 b/doc/man/nvme_zns_zt.2 new file mode 100644 index 0000000..97b1291 --- /dev/null +++ b/doc/man/nvme_zns_zt.2 @@ -0,0 +1,11 @@ +.TH "libnvme" 9 "enum nvme_zns_zt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvme_zns_zt \- +.SH SYNOPSIS +enum nvme_zns_zt { +.br +.BI " NVME_ZONE_TYPE_SEQWRITE_REQ" + +}; +.SH Constants +.IP "NVME_ZONE_TYPE_SEQWRITE_REQ" 12 diff --git a/doc/man/nvme_zone_report.2 b/doc/man/nvme_zone_report.2 new file mode 100644 index 0000000..26a3495 --- /dev/null +++ b/doc/man/nvme_zone_report.2 @@ -0,0 +1,23 @@ +.TH "libnvme" 9 "struct nvme_zone_report" "April 2022" "API Manual" LINUX +.SH NAME +struct nvme_zone_report \- +.SH SYNOPSIS +struct nvme_zone_report { +.br +.BI " __le64 nr_zones;" +.br +.BI " __u8 rsvd8[56];" +.br +.BI " struct nvme_zns_desc entries[];" +.br +.BI " +}; +.br + +.SH Members +.IP "nr_zones" 12 +Number of descriptors in \fIentries\fP +.IP "rsvd8" 12 +Reserved +.IP "entries" 12 +Zoned namespace descriptors diff --git a/doc/man/nvmf_add_ctrl.2 b/doc/man/nvmf_add_ctrl.2 new file mode 100644 index 0000000..d4ac1ac --- /dev/null +++ b/doc/man/nvmf_add_ctrl.2 @@ -0,0 +1,21 @@ +.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_add_ctrl \- Connect a controller and update topology +.SH SYNOPSIS +.B "int" nvmf_add_ctrl +.BI "(nvme_host_t h " "," +.BI "nvme_ctrl_t c " "," +.BI "const struct nvme_fabrics_config *cfg " ");" +.SH ARGUMENTS +.IP "h" 12 +Host to which the controller should be attached +.IP "c" 12 +Controller to be connected +.IP "cfg" 12 +Default configuration for the controller +.SH "DESCRIPTION" +Issues a 'connect' command to the NVMe-oF controller and inserts \fIc\fP +into the topology using \fIh\fP as parent. +\fIc\fP must be initialized and not connected to the topology. +.SH "RETURN" +0 on success; on failure errno is set and -1 is returned. diff --git a/doc/man/nvmf_addr_family.2 b/doc/man/nvmf_addr_family.2 new file mode 100644 index 0000000..333509c --- /dev/null +++ b/doc/man/nvmf_addr_family.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "enum nvmf_addr_family" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_addr_family \- Address Family codes for Discovery Log Page entry ADRFAM field +.SH SYNOPSIS +enum nvmf_addr_family { +.br +.BI " NVMF_ADDR_FAMILY_PCI" +, +.br +.br +.BI " NVMF_ADDR_FAMILY_IP4" +, +.br +.br +.BI " NVMF_ADDR_FAMILY_IP6" +, +.br +.br +.BI " NVMF_ADDR_FAMILY_IB" +, +.br +.br +.BI " NVMF_ADDR_FAMILY_FC" +, +.br +.br +.BI " NVMF_ADDR_FAMILY_LOOP" + +}; +.SH Constants +.IP "NVMF_ADDR_FAMILY_PCI" 12 +PCIe +.IP "NVMF_ADDR_FAMILY_IP4" 12 +AF_INET: IPv4 address family. +.IP "NVMF_ADDR_FAMILY_IP6" 12 +AF_INET6: IPv6 address family. +.IP "NVMF_ADDR_FAMILY_IB" 12 +AF_IB: InfiniBand address family. +.IP "NVMF_ADDR_FAMILY_FC" 12 +Fibre Channel address family. +.IP "NVMF_ADDR_FAMILY_LOOP" 12 +Intra-host Transport (i.e., loopback), reserved +for host usage. diff --git a/doc/man/nvmf_adrfam_str.2 b/doc/man/nvmf_adrfam_str.2 new file mode 100644 index 0000000..d58dc90 --- /dev/null +++ b/doc/man/nvmf_adrfam_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_adrfam_str \- Decode ADRFAM field +.SH SYNOPSIS +.B "const char *" nvmf_adrfam_str +.BI "(__u8 adrfam " ");" +.SH ARGUMENTS +.IP "adrfam" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the address family field in the discovery +log page entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_cms_str.2 b/doc/man/nvmf_cms_str.2 new file mode 100644 index 0000000..dffcf85 --- /dev/null +++ b/doc/man/nvmf_cms_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_cms_str" 9 "nvmf_cms_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_cms_str \- Decode RDMA connection management service field +.SH SYNOPSIS +.B "const char *" nvmf_cms_str +.BI "(__u8 cms " ");" +.SH ARGUMENTS +.IP "cms" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the RDMA connection management service field in the discovery +log page entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_connect_data.2 b/doc/man/nvmf_connect_data.2 new file mode 100644 index 0000000..6164c0a --- /dev/null +++ b/doc/man/nvmf_connect_data.2 @@ -0,0 +1,35 @@ +.TH "libnvme" 9 "struct nvmf_connect_data" "April 2022" "API Manual" LINUX +.SH NAME +struct nvmf_connect_data \- Data payload for the 'connect' command +.SH SYNOPSIS +struct nvmf_connect_data { +.br +.BI " __u8 hostid[16];" +.br +.BI " __le16 cntlid;" +.br +.BI " char rsvd4[238];" +.br +.BI " char subsysnqn[NVME_NQN_LENGTH];" +.br +.BI " char hostnqn[NVME_NQN_LENGTH];" +.br +.BI " char rsvd5[256];" +.br +.BI " +}; +.br + +.SH Members +.IP "hostid" 12 +Host ID of the connecting host +.IP "cntlid" 12 +Requested controller ID +.IP "rsvd4" 12 +Reserved +.IP "subsysnqn" 12 +Subsystem NQN to connect to +.IP "hostnqn" 12 +Host NQN of the connecting host +.IP "rsvd5" 12 +Reserved diff --git a/doc/man/nvmf_connect_disc_entry.2 b/doc/man/nvmf_connect_disc_entry.2 new file mode 100644 index 0000000..dd15474 --- /dev/null +++ b/doc/man/nvmf_connect_disc_entry.2 @@ -0,0 +1,20 @@ +.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_connect_disc_entry \- Connect controller based on the discovery log page entry +.SH SYNOPSIS +.B "nvme_ctrl_t" nvmf_connect_disc_entry +.BI "(nvme_host_t h " "," +.BI "struct nvmf_disc_log_entry *e " "," +.BI "const struct nvme_fabrics_config *defcfg " "," +.BI "bool *discover " ");" +.SH ARGUMENTS +.IP "h" 12 +Host to which the controller should be connected +.IP "e" 12 +Discovery log page entry +.IP "defcfg" 12 +Default configurationn to be used for the new controller +.IP "discover" 12 +Set to 'true' if the new controller is a discovery controller +.SH "RETURN" +Pointer to the new controller diff --git a/doc/man/nvmf_default_config.2 b/doc/man/nvmf_default_config.2 new file mode 100644 index 0000000..3b958db --- /dev/null +++ b/doc/man/nvmf_default_config.2 @@ -0,0 +1,11 @@ +.TH "nvmf_default_config" 9 "nvmf_default_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_default_config \- Default values for fabrics configuration +.SH SYNOPSIS +.B "void" nvmf_default_config +.BI "(struct nvme_fabrics_config *cfg " ");" +.SH ARGUMENTS +.IP "cfg" 12 +config values to set +.SH "DESCRIPTION" +Initializes \fIcfg\fP with default values. diff --git a/doc/man/nvmf_dim_data.2 b/doc/man/nvmf_dim_data.2 new file mode 100644 index 0000000..85d2be9 --- /dev/null +++ b/doc/man/nvmf_dim_data.2 @@ -0,0 +1,63 @@ +.TH "libnvme" 9 "struct nvmf_dim_data" "April 2022" "API Manual" LINUX +.SH NAME +struct nvmf_dim_data \- Discovery Information Management (DIM) - Data +.SH SYNOPSIS +struct nvmf_dim_data { +.br +.BI " __le32 tdl;" +.br +.BI " __u8 rsvd4[4];" +.br +.BI " __le64 nument;" +.br +.BI " __le16 entfmt;" +.br +.BI " __le16 etype;" +.br +.BI " __u8 portlcl;" +.br +.BI " __u8 rsvd21;" +.br +.BI " __le16 ektype;" +.br +.BI " char eid[NVME_NQN_LENGTH];" +.br +.BI " char ename[NVMF_ENAME_LEN];" +.br +.BI " char ever[NVMF_EVER_LEN];" +.br +.BI " __u8 rsvd600[424];" +.br +.BI " union nvmf_die die[];" +.br +.BI " +}; +.br + +.SH Members +.IP "tdl" 12 +Total Data Length +.IP "rsvd4" 12 +Reserved +.IP "nument" 12 +Number of entries +.IP "entfmt" 12 +Entry Format (\fIenum nvmf_dim_entfmt\fP) +.IP "etype" 12 +Entity Type (\fIenum nvmf_dim_etype\fP) +.IP "portlcl" 12 +Port Local +.IP "rsvd21" 12 +Reserved +.IP "ektype" 12 +Entry Key Type +.IP "eid" 12 +Entity Identifier (e.g. Host NQN) +.IP "ename" 12 +Entity Name (e.g. hostname) +.IP "ever" 12 +Entity Version (e.g. OS Name/Version) +.IP "rsvd600" 12 +Reserved +.IP "die" 12 +Discovery Information Entry (see \fInument\fP above) diff --git a/doc/man/nvmf_dim_entfmt.2 b/doc/man/nvmf_dim_entfmt.2 new file mode 100644 index 0000000..b0903fd --- /dev/null +++ b/doc/man/nvmf_dim_entfmt.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvmf_dim_entfmt" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_dim_entfmt \- Discovery Information Management Entry Format +.SH SYNOPSIS +enum nvmf_dim_entfmt { +.br +.BI " NVMF_DIM_ENTFMT_BASIC" +, +.br +.br +.BI " NVMF_DIM_ENTFMT_EXTENDED" + +}; +.SH Constants +.IP "NVMF_DIM_ENTFMT_BASIC" 12 +Basic discovery information entry +.IP "NVMF_DIM_ENTFMT_EXTENDED" 12 +Extended discovery information entry diff --git a/doc/man/nvmf_dim_etype.2 b/doc/man/nvmf_dim_etype.2 new file mode 100644 index 0000000..4f3a9eb --- /dev/null +++ b/doc/man/nvmf_dim_etype.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvmf_dim_etype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_dim_etype \- Discovery Information Management Entity Type +.SH SYNOPSIS +enum nvmf_dim_etype { +.br +.BI " NVMF_DIM_ETYPE_HOST" +, +.br +.br +.BI " NVMF_DIM_ETYPE_DDC" +, +.br +.br +.BI " NVMF_DIM_ETYPE_CDC" + +}; +.SH Constants +.IP "NVMF_DIM_ETYPE_HOST" 12 +Host +.IP "NVMF_DIM_ETYPE_DDC" 12 +Direct Discovery controller +.IP "NVMF_DIM_ETYPE_CDC" 12 +Centralized Discovery controller diff --git a/doc/man/nvmf_dim_tas.2 b/doc/man/nvmf_dim_tas.2 new file mode 100644 index 0000000..156a7da --- /dev/null +++ b/doc/man/nvmf_dim_tas.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "enum nvmf_dim_tas" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_dim_tas \- Discovery Information Management Task +.SH SYNOPSIS +enum nvmf_dim_tas { +.br +.BI " NVMF_DIM_TAS_REGISTER" +, +.br +.br +.BI " NVMF_DIM_TAS_DEREGISTER" +, +.br +.br +.BI " NVMF_DIM_TAS_UPDATE" + +}; +.SH Constants +.IP "NVMF_DIM_TAS_REGISTER" 12 +Register +.IP "NVMF_DIM_TAS_DEREGISTER" 12 +Deregister +.IP "NVMF_DIM_TAS_UPDATE" 12 +Update diff --git a/doc/man/nvmf_disc_eflags.2 b/doc/man/nvmf_disc_eflags.2 new file mode 100644 index 0000000..60f4ba3 --- /dev/null +++ b/doc/man/nvmf_disc_eflags.2 @@ -0,0 +1,39 @@ +.TH "libnvme" 9 "enum nvmf_disc_eflags" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_disc_eflags \- Discovery Log Page entry flags. +.SH SYNOPSIS +enum nvmf_disc_eflags { +.br +.BI " NVMF_DISC_EFLAGS_NONE" +, +.br +.br +.BI " NVMF_DISC_EFLAGS_DUPRETINFO" +, +.br +.br +.BI " NVMF_DISC_EFLAGS_EPCSD" +, +.br +.br +.BI " NVMF_DISC_EFLAGS_BOTH" + +}; +.SH Constants +.IP "NVMF_DISC_EFLAGS_NONE" 12 +Indicates that none of the DUPRETINFO or EPCSD +features are supported. +.IP "NVMF_DISC_EFLAGS_DUPRETINFO" 12 +Duplicate Returned Information (DUPRETINFO): +Indicates that using the content of this entry +to access this Discovery Service returns the same +information that is returned by using the content +of other entries in this log page that also have +this flag set. +.IP "NVMF_DISC_EFLAGS_EPCSD" 12 +Explicit Persistent Connection Support for Discovery (EPCSD): +Indicates that Explicit Persistent Connections are +supported for the Discovery controller. +.IP "NVMF_DISC_EFLAGS_BOTH" 12 +Indicates that both the DUPRETINFO and EPCSD +features are supported. diff --git a/doc/man/nvmf_disc_log_entry.2 b/doc/man/nvmf_disc_log_entry.2 new file mode 100644 index 0000000..73ef858 --- /dev/null +++ b/doc/man/nvmf_disc_log_entry.2 @@ -0,0 +1,96 @@ +.TH "libnvme" 9 "struct nvmf_disc_log_entry" "April 2022" "API Manual" LINUX +.SH NAME +struct nvmf_disc_log_entry \- Discovery Log Page entry +.SH SYNOPSIS +struct nvmf_disc_log_entry { +.br +.BI " __u8 trtype;" +.br +.BI " __u8 adrfam;" +.br +.BI " __u8 subtype;" +.br +.BI " __u8 treq;" +.br +.BI " __le16 portid;" +.br +.BI " __le16 cntlid;" +.br +.BI " __le16 asqsz;" +.br +.BI " __le16 eflags;" +.br +.BI " __u8 rsvd12[20];" +.br +.BI " char trsvcid[NVMF_TRSVCID_SIZE];" +.br +.BI " __u8 rsvd64[192];" +.br +.BI " char subnqn[NVME_NQN_LENGTH];" +.br +.BI " char traddr[NVMF_TRADDR_SIZE];" +.br +.BI " union nvmf_tsas tsas;" +.br +.BI " +}; +.br + +.SH Members +.IP "trtype" 12 +Transport Type (TRTYPE): Specifies the NVMe Transport type. +See \fIenum nvmf_trtype\fP. +.IP "adrfam" 12 +Address Family (ADRFAM): Specifies the address family. +See \fIenum nvmf_addr_family\fP. +.IP "subtype" 12 +Subsystem Type (SUBTYPE): Specifies the type of the NVM subsystem +that is indicated in this entry. See \fIenum nvme_subsys_type\fP. +.IP "treq" 12 +Transport Requirements (TREQ): Indicates requirements for the NVMe +Transport. See \fIenum nvmf_treq\fP. +.IP "portid" 12 +Port ID (PORTID): Specifies a particular NVM subsystem port. +Different NVMe Transports or address families may utilize the same +Port ID value (e.g. a Port ID may support both iWARP and RoCE). +.IP "cntlid" 12 +Controller ID (CNTLID): Specifies the controller ID. If the NVM +subsystem uses a dynamic controller model, then this field shall +be set to FFFFh. If the NVM subsystem uses a static controller model, +then this field may be set to a specific controller ID (values 0h +to FFEFh are valid). If the NVM subsystem uses a static controller +model and the value indicated is FFFEh, then the host should remember +the Controller ID returned as part of the Fabrics Connect command +in order to re-establish an association in the future with the same +controller. +.IP "asqsz" 12 +Admin Max SQ Size (ASQSZ): Specifies the maximum size of an Admin +Submission Queue. This applies to all controllers in the NVM +subsystem. The value shall be a minimum of 32 entries. +.IP "eflags" 12 +Entry Flags (EFLAGS): Indicates additional information related to +the current entry. See \fIenum nvmf_disc_eflags\fP. +.IP "rsvd12" 12 +Reserved +.IP "trsvcid" 12 +Transport Service Identifier (TRSVCID): Specifies the NVMe Transport +service identifier as an ASCII string. The NVMe Transport service +identifier is specified by the associated NVMe Transport binding +specification. +.IP "rsvd64" 12 +Reserved +.IP "subnqn" 12 +NVM Subsystem Qualified Name (SUBNQN): NVMe Qualified Name (NQN) +that uniquely identifies the NVM subsystem. For a subsystem, if that +Discovery subsystem has a unique NQN (i.e., the NVM Subsystem NVMe +Qualified Name (SUBNQN) field in that Discovery subsystem's Identify +Controller data structure contains a unique NQN value), then the +value returned shall be that unique NQN. If the Discovery subsystem +does not have a unique NQN, then the value returned shall be the +well-known Discovery Service NQN (nqn.2014-08.org.nvmexpress.discovery). +.IP "traddr" 12 +Transport Address (TRADDR): Specifies the address of the NVM subsystem +that may be used for a Connect command as an ASCII string. The +Address Family field describes the reference for parsing this field. +.IP "tsas" 12 +Transport specific attribute settings diff --git a/doc/man/nvmf_discovery_log.2 b/doc/man/nvmf_discovery_log.2 new file mode 100644 index 0000000..f8707c1 --- /dev/null +++ b/doc/man/nvmf_discovery_log.2 @@ -0,0 +1,38 @@ +.TH "libnvme" 9 "struct nvmf_discovery_log" "April 2022" "API Manual" LINUX +.SH NAME +struct nvmf_discovery_log \- Discovery Log Page (Log Identifier 70h) +.SH SYNOPSIS +struct nvmf_discovery_log { +.br +.BI " __le64 genctr;" +.br +.BI " __le64 numrec;" +.br +.BI " __le16 recfmt;" +.br +.BI " __u8 rsvd14[1006];" +.br +.BI " struct nvmf_disc_log_entry entries[];" +.br +.BI " +}; +.br + +.SH Members +.IP "genctr" 12 +Generation Counter (GENCTR): Indicates the version of the discovery +information, starting at a value of 0h. For each change in the +Discovery Log Page, this counter is incremented by one. If the value +of this field is FFFFFFFF_FFFFFFFFh, then the field shall be cleared +to 0h when incremented (i.e., rolls over to 0h). +.IP "numrec" 12 +Number of Records (NUMREC): Indicates the number of records +contained in the log. +.IP "recfmt" 12 +Record Format (RECFMT): Specifies the format of the Discovery Log +Page. If a new format is defined, this value is incremented by one. +The format of the record specified in this definition shall be 0h. +.IP "rsvd14" 12 +Reserved +.IP "entries" 12 +Discovery Log Page Entries - see \fIstruct nvmf_disc_log_entry\fP. diff --git a/doc/man/nvmf_eflags_str.2 b/doc/man/nvmf_eflags_str.2 new file mode 100644 index 0000000..dbe1065 --- /dev/null +++ b/doc/man/nvmf_eflags_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_eflags_str \- Decode EFLAGS field +.SH SYNOPSIS +.B "const char *" nvmf_eflags_str +.BI "(__u16 eflags " ");" +.SH ARGUMENTS +.IP "eflags" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the EFLAGS field in the discovery log page +entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_exat_len.2 b/doc/man/nvmf_exat_len.2 new file mode 100644 index 0000000..2daeaea --- /dev/null +++ b/doc/man/nvmf_exat_len.2 @@ -0,0 +1,15 @@ +.TH "nvmf_exat_len" 9 "nvmf_exat_len" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_exat_len \- Return length rounded up by 4 +.SH SYNOPSIS +.B "__u16" nvmf_exat_len +.BI "(size_t val_len " ");" +.SH ARGUMENTS +.IP "val_len" 12 +Value lenght +.SH "DESCRIPTION" +Return the size in bytes, rounded to a multiple of 4 (e.g., size of +__u32), of the buffer needed to hold the exat value of size +\fIval_len\fP. +.SH "RETURN" +Lenght rounded up by 4 diff --git a/doc/man/nvmf_exattype.2 b/doc/man/nvmf_exattype.2 new file mode 100644 index 0000000..07d0a92 --- /dev/null +++ b/doc/man/nvmf_exattype.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvmf_exattype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_exattype \- Extended Attribute Type +.SH SYNOPSIS +enum nvmf_exattype { +.br +.BI " NVMF_EXATTYPE_HOSTID" +, +.br +.br +.BI " NVMF_EXATTYPE_SYMNAME" + +}; +.SH Constants +.IP "NVMF_EXATTYPE_HOSTID" 12 +Host Identifier +.IP "NVMF_EXATTYPE_SYMNAME" 12 +Symblic Name diff --git a/doc/man/nvmf_ext_attr.2 b/doc/man/nvmf_ext_attr.2 new file mode 100644 index 0000000..4215edc --- /dev/null +++ b/doc/man/nvmf_ext_attr.2 @@ -0,0 +1,24 @@ +.TH "libnvme" 9 "struct nvmf_ext_attr" "April 2022" "API Manual" LINUX +.SH NAME +struct nvmf_ext_attr \- Extended Attribute (EXAT) +.SH SYNOPSIS +struct nvmf_ext_attr { +.br +.BI " __le16 exattype;" +.br +.BI " __le16 exatlen;" +.br +.BI " __u8 exatval[];" +.br +.BI " +}; +.br + +.SH Members +.IP "exattype" 12 +Extended Attribute Type (EXATTYPE) - see \fIenum\fP nvmf_exattype +.IP "exatlen" 12 +Extended Attribute Length (EXATLEN) +.IP "exatval" 12 +Extended Attribute Value (EXATVAL) - size allocated for array +must be a multiple of 4 bytes diff --git a/doc/man/nvmf_ext_die.2 b/doc/man/nvmf_ext_die.2 new file mode 100644 index 0000000..4d50926 --- /dev/null +++ b/doc/man/nvmf_ext_die.2 @@ -0,0 +1,79 @@ +.TH "libnvme" 9 "struct nvmf_ext_die" "April 2022" "API Manual" LINUX +.SH NAME +struct nvmf_ext_die \- Extended Discovery Information Entry (DIE) +.SH SYNOPSIS +struct nvmf_ext_die { +.br +.BI " __u8 trtype;" +.br +.BI " __u8 adrfam;" +.br +.BI " __u8 subtype;" +.br +.BI " __u8 treq;" +.br +.BI " __le16 portid;" +.br +.BI " __le16 cntlid;" +.br +.BI " __le16 asqsz;" +.br +.BI " __u8 rsvd10[22];" +.br +.BI " char trsvcid[NVMF_TRSVCID_SIZE];" +.br +.BI " __u8 resv64[192];" +.br +.BI " char nqn[NVME_NQN_LENGTH];" +.br +.BI " char traddr[NVMF_TRADDR_SIZE];" +.br +.BI " union nvmf_tsas tsas;" +.br +.BI " __le32 tel;" +.br +.BI " __le16 numexat;" +.br +.BI " __u8 resv1030[2];" +.br +.BI " struct nvmf_ext_attr exat[];" +.br +.BI " +}; +.br + +.SH Members +.IP "trtype" 12 +Transport Type (\fIenum nvmf_trtype\fP) +.IP "adrfam" 12 +Address Family (\fIenum nvmf_addr_family\fP) +.IP "subtype" 12 +Subsystem Type (\fIenum nvme_subsys_type\fP) +.IP "treq" 12 +Transport Requirements (\fIenum nvmf_treq\fP) +.IP "portid" 12 +Port ID +.IP "cntlid" 12 +Controller ID +.IP "asqsz" 12 +Admin Max SQ Size +.IP "rsvd10" 12 +Reserved +.IP "trsvcid" 12 +Transport Service Identifier +.IP "resv64" 12 +Reserved +.IP "nqn" 12 +NVM Qualified Name +.IP "traddr" 12 +Transport Address +.IP "tsas" 12 +Transport Specific Address Subtype (\fIunion nvmf_tsas\fP) +.IP "tel" 12 +Total Entry Length +.IP "numexat" 12 +Number of Extended Attributes +.IP "resv1030" 12 +Reserved +.IP "exat" 12 +Extented Attributes 0 (\fIstruct nvmf_ext_attr\fP) diff --git a/doc/man/nvmf_get_discovery_log.2 b/doc/man/nvmf_get_discovery_log.2 new file mode 100644 index 0000000..aee9c17 --- /dev/null +++ b/doc/man/nvmf_get_discovery_log.2 @@ -0,0 +1,17 @@ +.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_get_discovery_log \- Return the discovery log page +.SH SYNOPSIS +.B "int" nvmf_get_discovery_log +.BI "(nvme_ctrl_t c " "," +.BI "struct nvmf_discovery_log **logp " "," +.BI "int max_retries " ");" +.SH ARGUMENTS +.IP "c" 12 +Discover controller to use +.IP "logp" 12 +Pointer to the log page to be returned +.IP "max_retries" 12 +maximum number of log page entries to be returned +.SH "RETURN" +0 on success; on failure -1 is returned and errno is set diff --git a/doc/man/nvmf_hostid_from_file.2 b/doc/man/nvmf_hostid_from_file.2 new file mode 100644 index 0000000..72e5002 --- /dev/null +++ b/doc/man/nvmf_hostid_from_file.2 @@ -0,0 +1,9 @@ +.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_hostid_from_file \- Reads the host identifier from the config default location in /etc/nvme/. +.SH SYNOPSIS +.B "char *" nvmf_hostid_from_file +.SH ARGUMENTS +.SH "RETURN" +The host identifier, or NULL if unsuccessful. If found, the caller +is responsible to free the string. diff --git a/doc/man/nvmf_hostnqn_from_file.2 b/doc/man/nvmf_hostnqn_from_file.2 new file mode 100644 index 0000000..ce84ae5 --- /dev/null +++ b/doc/man/nvmf_hostnqn_from_file.2 @@ -0,0 +1,9 @@ +.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_hostnqn_from_file \- Reads the host nvm qualified name from the config default location in /etc/nvme/ +.SH SYNOPSIS +.B "char *" nvmf_hostnqn_from_file +.SH ARGUMENTS +.SH "RETURN" +The host nqn, or NULL if unsuccessful. If found, the caller +is responsible to free the string. diff --git a/doc/man/nvmf_hostnqn_generate.2 b/doc/man/nvmf_hostnqn_generate.2 new file mode 100644 index 0000000..baa5c12 --- /dev/null +++ b/doc/man/nvmf_hostnqn_generate.2 @@ -0,0 +1,9 @@ +.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_hostnqn_generate \- Generate a machine specific host nqn +.SH SYNOPSIS +.B "char *" nvmf_hostnqn_generate +.SH ARGUMENTS +.SH "RETURN" +An nvm namespace qualified name string based on the machine +identifier, or NULL if not successful. diff --git a/doc/man/nvmf_prtype_str.2 b/doc/man/nvmf_prtype_str.2 new file mode 100644 index 0000000..fb33189 --- /dev/null +++ b/doc/man/nvmf_prtype_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_prtype_str \- Decode RDMA Provider type field +.SH SYNOPSIS +.B "const char *" nvmf_prtype_str +.BI "(__u8 prtype " ");" +.SH ARGUMENTS +.IP "prtype" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the RDMA Provider type field in the discovery +log page entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_qptype_str.2 b/doc/man/nvmf_qptype_str.2 new file mode 100644 index 0000000..f67f9f6 --- /dev/null +++ b/doc/man/nvmf_qptype_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_qptype_str \- Decode RDMA QP Service type field +.SH SYNOPSIS +.B "const char *" nvmf_qptype_str +.BI "(__u8 qptype " ");" +.SH ARGUMENTS +.IP "qptype" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the RDMA QP Service type field in the discovery log page +entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_rdma_cms.2 b/doc/man/nvmf_rdma_cms.2 new file mode 100644 index 0000000..0b4d2fe --- /dev/null +++ b/doc/man/nvmf_rdma_cms.2 @@ -0,0 +1,12 @@ +.TH "libnvme" 9 "enum nvmf_rdma_cms" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_rdma_cms \- RDMA Connection Management Service Type codes for Discovery Log Page entry TSAS RDMA_CMS field +.SH SYNOPSIS +enum nvmf_rdma_cms { +.br +.BI " NVMF_RDMA_CMS_RDMA_CM" + +}; +.SH Constants +.IP "NVMF_RDMA_CMS_RDMA_CM" 12 +Sockets based endpoint addressing diff --git a/doc/man/nvmf_rdma_prtype.2 b/doc/man/nvmf_rdma_prtype.2 new file mode 100644 index 0000000..997fe6d --- /dev/null +++ b/doc/man/nvmf_rdma_prtype.2 @@ -0,0 +1,36 @@ +.TH "libnvme" 9 "enum nvmf_rdma_prtype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_rdma_prtype \- RDMA Provider Type codes for Discovery Log Page entry TSAS RDMA_PRTYPE field +.SH SYNOPSIS +enum nvmf_rdma_prtype { +.br +.BI " NVMF_RDMA_PRTYPE_NOT_SPECIFIED" +, +.br +.br +.BI " NVMF_RDMA_PRTYPE_IB" +, +.br +.br +.BI " NVMF_RDMA_PRTYPE_ROCE" +, +.br +.br +.BI " NVMF_RDMA_PRTYPE_ROCEV2" +, +.br +.br +.BI " NVMF_RDMA_PRTYPE_IWARP" + +}; +.SH Constants +.IP "NVMF_RDMA_PRTYPE_NOT_SPECIFIED" 12 +No Provider Specified +.IP "NVMF_RDMA_PRTYPE_IB" 12 +InfiniBand +.IP "NVMF_RDMA_PRTYPE_ROCE" 12 +InfiniBand RoCE +.IP "NVMF_RDMA_PRTYPE_ROCEV2" 12 +InfiniBand RoCEV2 +.IP "NVMF_RDMA_PRTYPE_IWARP" 12 +iWARP diff --git a/doc/man/nvmf_rdma_qptype.2 b/doc/man/nvmf_rdma_qptype.2 new file mode 100644 index 0000000..c6a01d7 --- /dev/null +++ b/doc/man/nvmf_rdma_qptype.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvmf_rdma_qptype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_rdma_qptype \- RDMA QP Service Type codes for Discovery Log Page entry TSAS RDMA_QPTYPE field +.SH SYNOPSIS +enum nvmf_rdma_qptype { +.br +.BI " NVMF_RDMA_QPTYPE_CONNECTED" +, +.br +.br +.BI " NVMF_RDMA_QPTYPE_DATAGRAM" + +}; +.SH Constants +.IP "NVMF_RDMA_QPTYPE_CONNECTED" 12 +Reliable Connected +.IP "NVMF_RDMA_QPTYPE_DATAGRAM" 12 +Reliable Datagram diff --git a/doc/man/nvmf_register_ctrl.2 b/doc/man/nvmf_register_ctrl.2 new file mode 100644 index 0000000..813cac6 --- /dev/null +++ b/doc/man/nvmf_register_ctrl.2 @@ -0,0 +1,22 @@ +.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_register_ctrl \- Perform registration task with a DC +.SH SYNOPSIS +.B "int" nvmf_register_ctrl +.BI "(nvme_ctrl_t c " "," +.BI "enum nvmf_dim_tas tas " "," +.BI "__u32 *result " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.IP "tas" 12 +Task field of the Command Dword 10 (cdw10). Indicates whether to +perform a Registration, Deregistration, or Registration-update. +.IP "result" 12 +The command-specific result returned by the DC upon command +completion. +.SH "DESCRIPTION" +Perform registration task with a Discovery Controller (DC). Three +tasks are supported: register, deregister, and registration update. +.SH "RETURN" +0 on success; on failure -1 is returned and errno is set diff --git a/doc/man/nvmf_sectype_str.2 b/doc/man/nvmf_sectype_str.2 new file mode 100644 index 0000000..8dc8515 --- /dev/null +++ b/doc/man/nvmf_sectype_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_sectype_str \- Decode SECTYPE field +.SH SYNOPSIS +.B "const char *" nvmf_sectype_str +.BI "(__u8 sectype " ");" +.SH ARGUMENTS +.IP "sectype" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the SECTYPE field in the discovery log page +entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_subtype_str.2 b/doc/man/nvmf_subtype_str.2 new file mode 100644 index 0000000..1134736 --- /dev/null +++ b/doc/man/nvmf_subtype_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_subtype_str \- Decode SUBTYPE field +.SH SYNOPSIS +.B "const char *" nvmf_subtype_str +.BI "(__u8 subtype " ");" +.SH ARGUMENTS +.IP "subtype" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the subsystem type field in the discovery +log page entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_tcp_sectype.2 b/doc/man/nvmf_tcp_sectype.2 new file mode 100644 index 0000000..770e684 --- /dev/null +++ b/doc/man/nvmf_tcp_sectype.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "enum nvmf_tcp_sectype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_tcp_sectype \- Transport Specific Address Subtype Definition for NVMe/TCP Transport +.SH SYNOPSIS +enum nvmf_tcp_sectype { +.br +.BI " NVMF_TCP_SECTYPE_NONE" +, +.br +.br +.BI " NVMF_TCP_SECTYPE_TLS" +, +.br +.br +.BI " NVMF_TCP_SECTYPE_TLS13" + +}; +.SH Constants +.IP "NVMF_TCP_SECTYPE_NONE" 12 +No Security +.IP "NVMF_TCP_SECTYPE_TLS" 12 +Transport Layer Security version 1.2 +.IP "NVMF_TCP_SECTYPE_TLS13" 12 +Transport Layer Security version 1.3 or a subsequent +version. The TLS protocol negotiates the version and +cipher suite for each TCP connection. diff --git a/doc/man/nvmf_treq.2 b/doc/man/nvmf_treq.2 new file mode 100644 index 0000000..a1c01a1 --- /dev/null +++ b/doc/man/nvmf_treq.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvmf_treq" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_treq \- Transport Requirements codes for Discovery Log Page entry TREQ field +.SH SYNOPSIS +enum nvmf_treq { +.br +.BI " NVMF_TREQ_NOT_SPECIFIED" +, +.br +.br +.BI " NVMF_TREQ_REQUIRED" +, +.br +.br +.BI " NVMF_TREQ_NOT_REQUIRED" +, +.br +.br +.BI " NVMF_TREQ_DISABLE_SQFLOW" + +}; +.SH Constants +.IP "NVMF_TREQ_NOT_SPECIFIED" 12 +Not specified +.IP "NVMF_TREQ_REQUIRED" 12 +Required +.IP "NVMF_TREQ_NOT_REQUIRED" 12 +Not Required +.IP "NVMF_TREQ_DISABLE_SQFLOW" 12 +SQ flow control disable supported diff --git a/doc/man/nvmf_treq_str.2 b/doc/man/nvmf_treq_str.2 new file mode 100644 index 0000000..3c5e7c3 --- /dev/null +++ b/doc/man/nvmf_treq_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_treq_str" 9 "nvmf_treq_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_treq_str \- Decode TREQ field +.SH SYNOPSIS +.B "const char *" nvmf_treq_str +.BI "(__u8 treq " ");" +.SH ARGUMENTS +.IP "treq" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the transport requirements field in the +discovery log page entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_trtype.2 b/doc/man/nvmf_trtype.2 new file mode 100644 index 0000000..7d00ca7 --- /dev/null +++ b/doc/man/nvmf_trtype.2 @@ -0,0 +1,43 @@ +.TH "libnvme" 9 "enum nvmf_trtype" "April 2022" "API Manual" LINUX +.SH NAME +enum nvmf_trtype \- Transport Type codes for Discovery Log Page entry TRTYPE field +.SH SYNOPSIS +enum nvmf_trtype { +.br +.BI " NVMF_TRTYPE_UNSPECIFIED" +, +.br +.br +.BI " NVMF_TRTYPE_RDMA" +, +.br +.br +.BI " NVMF_TRTYPE_FC" +, +.br +.br +.BI " NVMF_TRTYPE_TCP" +, +.br +.br +.BI " NVMF_TRTYPE_LOOP" +, +.br +.br +.BI " NVMF_TRTYPE_MAX" + +}; +.SH Constants +.IP "NVMF_TRTYPE_UNSPECIFIED" 12 +Not indicated +.IP "NVMF_TRTYPE_RDMA" 12 +RDMA +.IP "NVMF_TRTYPE_FC" 12 +Fibre Channel +.IP "NVMF_TRTYPE_TCP" 12 +TCP +.IP "NVMF_TRTYPE_LOOP" 12 +Intra-host Transport (i.e., loopback), reserved +for host usage. +.IP "NVMF_TRTYPE_MAX" 12 +Maximum value for \fIenum nvmf_trtype\fP diff --git a/doc/man/nvmf_trtype_str.2 b/doc/man/nvmf_trtype_str.2 new file mode 100644 index 0000000..b46fe99 --- /dev/null +++ b/doc/man/nvmf_trtype_str.2 @@ -0,0 +1,14 @@ +.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_trtype_str \- Decode TRTYPE field +.SH SYNOPSIS +.B "const char *" nvmf_trtype_str +.BI "(__u8 trtype " ");" +.SH ARGUMENTS +.IP "trtype" 12 +value to be decoded +.SH "DESCRIPTION" +Decode the transport type field in the discovery +log page entry. +.SH "RETURN" +decoded string diff --git a/doc/man/nvmf_update_config.2 b/doc/man/nvmf_update_config.2 new file mode 100644 index 0000000..c23097b --- /dev/null +++ b/doc/man/nvmf_update_config.2 @@ -0,0 +1,15 @@ +.TH "nvmf_update_config" 9 "nvmf_update_config" "April 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_update_config \- Update fabrics configuration values +.SH SYNOPSIS +.B "void" nvmf_update_config +.BI "(nvme_ctrl_t c " "," +.BI "const struct nvme_fabrics_config *cfg " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller to be modified +.IP "cfg" 12 +Updated configuration values +.SH "DESCRIPTION" +Updates the values from \fIc\fP with the configuration values from \fIcfg\fP; +all non-default values from \fIcfg\fP will overwrite the values in \fIc\fP. diff --git a/doc/meson.build b/doc/meson.build new file mode 100644 index 0000000..0f04343 --- /dev/null +++ b/doc/meson.build @@ -0,0 +1,121 @@ +# SPDX-License-Identifier: LGPL-2.1-or-later +# +# This file is part of libnvme. +# Copyright (c) 2022 Dell Inc. +# Copyright (c) 2022 SUSE LLC +# +# Authors: Martin Belanger <Martin.Belanger@dell.com> +# Authors: Daniel Wagner <dwagner@suse.de> +# + +api_files = [ + 'filters.h', + 'ioctl.h', + 'linux.h', + 'log.h', + 'tree.h', + 'types.h', + 'fabrics.h', + 'util.h' +] + +sphinx_sources = [ + 'conf.py', + 'index.rst', + 'config-schema.json' +] + +want_docs = get_option('docs') +want_docs_build = get_option('docs-build') +if want_docs != 'false' + kernel_doc = find_program('kernel-doc') + + conf = configuration_data() + conf.set('SYSCONFDIR', sysconfdir) + + if want_docs == 'all' or want_docs == 'man' + mandir = join_paths(get_option('mandir'), 'man2') + list_man_pages = find_program('list-man-pages.sh') + if want_docs_build + foreach apif : api_files + foreach file : files('../src/nvme/' + apif) + subst = configure_file( + input: file, + output: '@BASENAME@.msubst', + configuration: conf) + c = run_command(list_man_pages, subst) + man_pages = c.stdout().split() + foreach page : man_pages + custom_target( + page.underscorify() + '_man', + input: subst, + output: page + '.2', + capture: true, + command: [kernel_doc, + '-module', 'libnvme', + '-man', + '-function', + page, + subst], + install: true, + install_dir: mandir) + endforeach + endforeach + endforeach + else + if want_docs == 'all' or want_docs == 'man' + install_subdir('man', install_dir: mandir) + endif + endif + endif + + if want_docs == 'all' or want_docs == 'html' + htmldir = join_paths(get_option('htmldir'), 'nvme') + sphinx_build = find_program('sphinx-build-3', 'sphinx-build') + if sphinx_build.found() and want_docs_build + cat = find_program('cat') + rsts = [] + foreach apif : api_files + afile = files('../src/nvme/' + apif) + subst = configure_file( + input: afile, + output: '@BASENAME@.hsubst', + configuration: conf) + rst = custom_target( + apif.underscorify() + '_rst', + input: subst, + output: '@BASENAME@._rst', + capture: true, + command: [kernel_doc, + '-rst', + '@INPUT@']) + rsts += rst + endforeach + libnvme = custom_target( + 'libnvme', + command: [ cat, '@INPUT@' ], + capture: true, + input: rsts, + output: 'libnvme.rst') + static_sources = [] + foreach file : sphinx_sources + static_sources += configure_file(input: file, output: file, copy: true) + endforeach + custom_target( + 'generate_doc_html', + input: [static_sources, libnvme], + output: 'html', + command: [sphinx_build, + '-b', 'html', + '@OUTDIR@', + '@OUTDIR@' + '/html'], + install: true, + install_dir: htmldir) + else + # The HTML doc is not ready yet. + # if want_docs == 'all' or want_docs == 'html' + # install_subdir('html', install_dir: htmldir) + # endif + endif + endif +endif diff --git a/doc/update-docs.sh b/doc/update-docs.sh new file mode 100755 index 0000000..7765b9b --- /dev/null +++ b/doc/update-docs.sh @@ -0,0 +1,19 @@ +#!/bin/sh -x + +DESTDIR=$(pwd) + +BUILDDIR="$(mktemp -d)" +trap 'rm -rf -- $BUILDDIR' EXIT + +meson $BUILDDIR -Ddocs=man -Ddocs-build=true +ninja -C $BUILDDIR + +rm -rf $DESTDIR/doc/man +mkdir $DESTDIR/doc/man + +find $BUILDDIR/doc -maxdepth 1 -name '*.2' -exec cp {} $DESTDIR/doc/man \; + +# The HTML doc is not ready yet +# rm -rf $DESTDIR/doc/html +# cp -R $BUILDDIR/doc/html $DESTDIR/doc/ + |