Adding upstream version 1.1~rc0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
336fe81026
commit
aca1b93997
GPG key ID:
FBB4F0E80A80222F
764 changed files with 32602 additions and 5874 deletions
7
.github/dependabot.yml
vendored
Normal file
7
.github/dependabot.yml
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
21
.github/workflows/doc.yml
vendored
21
.github/workflows/doc.yml
vendored
|
|
@ -1,21 +0,0 @@
|
|||
name: libnvme documenation CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
|
||||
jobs:
|
||||
kernel_doc_job:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v2
|
||||
- name: Check documentation format
|
||||
run: |
|
||||
API_FILES="fabrics.h filters.h ioctl.h linux.h tree.h types.h"
|
||||
for file in $API_FILES; do
|
||||
./doc/kernel-doc -v -none src/nvme/$file 2>&1 | sed -r 's/^([^:]+):([0-9]+): (warning|error):/::\3 file=\1,line=\2::/g'
|
||||
done
|
||||
shell: bash
|
||||
50
.github/workflows/meson.yml
vendored
50
.github/workflows/meson.yml
vendored
|
|
@ -14,15 +14,17 @@ jobs:
|
|||
steps:
|
||||
- name: install libraries
|
||||
run: sudo apt-get install libjson-c-dev
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v1
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- uses: BSFishy/meson-build@v1.0.3
|
||||
with:
|
||||
setup-options: --werror
|
||||
options: --verbose
|
||||
action: test
|
||||
# Preserve meson's log file on failure
|
||||
- uses: actions/upload-artifact@v1
|
||||
- uses: actions/upload-artifact@v3
|
||||
if: failure()
|
||||
with:
|
||||
name: Linux_Meson_Testlog
|
||||
|
|
@ -32,17 +34,41 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: install libraries
|
||||
run: sudo apt-get remove -y libssl-dev
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v1
|
||||
run: sudo apt-get install -y libpam-dev libcap-ng-dev
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- uses: BSFishy/meson-build@v1.0.3
|
||||
with:
|
||||
setup-options: --werror
|
||||
setup-options: --werror --wrap-mode=forcefallback
|
||||
options: --verbose
|
||||
action: test
|
||||
meson-version: 0.61.2
|
||||
# Preserve meson's log file on failure
|
||||
- uses: actions/upload-artifact@v1
|
||||
- uses: actions/upload-artifact@v3
|
||||
if: failure()
|
||||
with:
|
||||
name: Linux_Meson_log
|
||||
path: build/meson-logs/meson-log.txt
|
||||
|
||||
build-static:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: install libraries
|
||||
run: sudo apt-get install -y libpam-dev libcap-ng-dev
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- uses: BSFishy/meson-build@v1.0.3
|
||||
with:
|
||||
setup-options: --werror --wrap-mode=forcefallback --default-library=static
|
||||
options: --verbose
|
||||
action: test
|
||||
meson-version: 0.61.2
|
||||
# Preserve meson's log file on failure
|
||||
- uses: actions/upload-artifact@v3
|
||||
if: failure()
|
||||
with:
|
||||
name: Linux_Meson_log
|
||||
|
|
@ -53,8 +79,10 @@ jobs:
|
|||
steps:
|
||||
- name: install libraries
|
||||
run: sudo apt-get install libjson-c-dev lcov
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v1
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- uses: BSFishy/meson-build@v1.0.3
|
||||
with:
|
||||
setup-options: -Db_coverage=true --werror
|
||||
|
|
@ -64,6 +92,6 @@ jobs:
|
|||
- name: Generate Coverage Report
|
||||
# Can't use meson here, see https://github.com/mesonbuild/meson/issues/7895
|
||||
run: ninja -C build coverage --verbose
|
||||
- uses: codecov/codecov-action@v1
|
||||
- uses: codecov/codecov-action@v3
|
||||
with:
|
||||
fail_ci_if_error: false
|
||||
|
|
|
|||
59
.github/workflows/python-publish.yml
vendored
59
.github/workflows/python-publish.yml
vendored
|
|
@ -1,67 +1,58 @@
|
|||
# This workflow will upload a Python Package using Twine when a release is created
|
||||
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
|
||||
|
||||
# This workflow uses actions that are not certified by GitHub.
|
||||
# They are provided by a third-party and are governed by
|
||||
# separate terms of service, privacy policy, and support
|
||||
# documentation.
|
||||
|
||||
name: Build and upload to PyPI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
tags:
|
||||
- '**'
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build_wheels:
|
||||
name: Build wheels manylinux
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.3.1
|
||||
env:
|
||||
CIBW_REPAIR_WHEEL_COMMAND_LINUX: ""
|
||||
CIBW_SKIP: "*-musllinux_*"
|
||||
CIBW_BEFORE_BUILD_LINUX: yum install -y openssl-devel libuuid-devel json-c-devel
|
||||
CIBW_BUILD_VERBOSITY: 1
|
||||
|
||||
- uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
retention-days: 5
|
||||
|
||||
build_sdist:
|
||||
name: Build source distribution
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Build sdist
|
||||
run: pipx run build --sdist
|
||||
|
||||
- uses: actions/upload-artifact@v2
|
||||
- uses: actions/upload-artifact@v3
|
||||
with:
|
||||
path: dist/*.tar.gz
|
||||
retention-days: 5
|
||||
|
||||
upload_pypi:
|
||||
needs: [build_wheels, build_sdist]
|
||||
upload_test_pypi:
|
||||
needs: [build_sdist]
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name == 'release' && github.event.action == 'published'
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
- uses: actions/download-artifact@v2
|
||||
- uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: artifact
|
||||
path: dist
|
||||
|
||||
- name: Publish package to TestPyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
uses: pypa/gh-action-pypi-publish@release/v1.5
|
||||
with:
|
||||
user: __token__
|
||||
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
|
||||
repository_url: https://test.pypi.org/legacy/
|
||||
|
||||
upload_pypi:
|
||||
needs: [build_sdist]
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
- uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: artifact
|
||||
path: dist
|
||||
|
||||
- name: Publish package to PyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1.5
|
||||
with:
|
||||
user: __token__
|
||||
password: ${{ secrets.PYPI_API_TOKEN }}
|
||||
|
|
|
|||
19
.github/workflows/release.yml
vendored
Normal file
19
.github/workflows/release.yml
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
name: Releases
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
tags:
|
||||
- '**'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: ncipollo/release-action@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
12
README.md
12
README.md
|
|
@ -18,18 +18,19 @@ The public specification is the authority to resolve any protocol
|
|||
discrepencies with this library. For more info on NVM Express, please
|
||||
see:
|
||||
|
||||
http://nvmexpress.org
|
||||
https://nvmexpress.org
|
||||
|
||||
Subscribe to linux-nvme@lists.infradead.org for linux-nvme related
|
||||
discussions and development for both kernel and userspace. The list is
|
||||
archived here:
|
||||
|
||||
http://lists.infradead.org/mailman/listinfo/linux-nvme
|
||||
https://lists.infradead.org/mailman/listinfo/linux-nvme
|
||||
|
||||
# License
|
||||
|
||||
Except where otherwise stated, all software contained within this repo
|
||||
is currently licensed LGPL, see COPYING for more information.
|
||||
is currently licensed LGPL-2.1-or-later, see COPYING for more
|
||||
information.
|
||||
|
||||
Keith Busch 2020-02-06
|
||||
|
||||
|
|
@ -56,6 +57,11 @@ please consult the following sites:
|
|||
|
||||
**meson repo**: https://github.com/mesonbuild/meson
|
||||
|
||||
## Dependency
|
||||
|
||||
libnvme depends on minimum Linux kernel version v4.15, which
|
||||
introduced the /sys/class/nvme-subsystem.
|
||||
|
||||
## Prerequisite
|
||||
|
||||
First, install meson.
|
||||
|
|
|
|||
18
doc/api.rst
Normal file
18
doc/api.rst
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
===
|
||||
API
|
||||
===
|
||||
|
||||
.. module:: libnvme
|
||||
|
||||
This part of the documentation lists the full API reference of all public classes and
|
||||
functions.
|
||||
|
||||
.. include:: rst/types.rst
|
||||
.. include:: rst/ioctl.rst
|
||||
.. include:: rst/fabrics.rst
|
||||
.. include:: rst/linux.rst
|
||||
.. include:: rst/mi.rst
|
||||
.. include:: rst/tree.rst
|
||||
.. include:: rst/filters.rst
|
||||
.. include:: rst/util.rst
|
||||
.. include:: rst/log.rst
|
||||
18
doc/api.rst.in
Normal file
18
doc/api.rst.in
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
===
|
||||
API
|
||||
===
|
||||
|
||||
.. module:: libnvme
|
||||
|
||||
This part of the documentation lists the full API reference of all public classes and
|
||||
functions.
|
||||
|
||||
.. include:: rst/types.rst
|
||||
.. include:: rst/ioctl.rst
|
||||
.. include:: rst/fabrics.rst
|
||||
.. include:: rst/linux.rst
|
||||
.. include:: rst/mi.rst
|
||||
.. include:: rst/tree.rst
|
||||
.. include:: rst/filters.rst
|
||||
.. include:: rst/util.rst
|
||||
.. include:: rst/log.rst
|
||||
47
doc/conf.py
47
doc/conf.py
|
|
@ -4,26 +4,15 @@
|
|||
# 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'
|
||||
master_doc = 'index'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '0.1'
|
||||
release = '1.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
|
@ -40,34 +29,4 @@ 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')
|
||||
exclude_patterns = ['html', 'man', 'Thumbs.db', '.DS_Store']
|
||||
|
|
|
|||
32
doc/conf.py.in
Normal file
32
doc/conf.py.in
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# 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
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'libnvme'
|
||||
copyright = '2020, Keith Busch'
|
||||
author = 'Keith Busch <kbusch@kernel.org>'
|
||||
master_doc = 'index'
|
||||
|
||||
release = '@VERSION@'
|
||||
|
||||
|
||||
# -- 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', 'Thumbs.db', '.DS_Store']
|
||||
164
doc/config-schema.json.in
Normal file
164
doc/config-schema.json.in
Normal file
|
|
@ -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" ]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,17 +1,19 @@
|
|||
.. 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!
|
||||
===================================
|
||||
|
||||
This is the libnvme development C library. libnvme provides type definitions for
|
||||
NVMe specification structures, enumerations, and bit fields,
|
||||
helper functions to construct, dispatch, and decode commands and payloads,
|
||||
and utilities to connect, scan, and manage nvme devices on a Linux system.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
libnvme
|
||||
|
||||
installation.rst
|
||||
quickstart.rst
|
||||
mi.rst
|
||||
api.rst
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
|
|||
23
doc/index.rst.in
Normal file
23
doc/index.rst.in
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
Welcome to libnvme's documentation!
|
||||
===================================
|
||||
|
||||
This is the libnvme development C library. libnvme provides type definitions for
|
||||
NVMe specification structures, enumerations, and bit fields,
|
||||
helper functions to construct, dispatch, and decode commands and payloads,
|
||||
and utilities to connect, scan, and manage nvme devices on a Linux system.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
installation.rst
|
||||
quickstart.rst
|
||||
mi.rst
|
||||
api.rst
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
52
doc/installation.rst
Normal file
52
doc/installation.rst
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
Debian / Ubuntu:
|
||||
--------------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ apt-get install libnvme
|
||||
|
||||
Fedora / Red Hat:
|
||||
--------------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ dnf install libnvme
|
||||
|
||||
Python Version
|
||||
--------------
|
||||
|
||||
The latest Python 3 version is always recommended, since it has all the latest bells and
|
||||
whistles. libnvme supports Python 3.6 and above.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
libnvme only uses packages from the standard library,
|
||||
so no additional dependencies will be installed when installing libnvme.
|
||||
|
||||
Install libnvme python
|
||||
-------------
|
||||
|
||||
Debian / Ubuntu:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ apt-get install python3-libnvme
|
||||
|
||||
Fedora / Red Hat:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ dnf install python3-libnvme
|
||||
|
||||
libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is
|
||||
always the latest stable release.
|
||||
|
||||
.. _PyPi: https://pypi.org/project/libnvme/
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ pip install libnvme
|
||||
55
doc/installation.rst.in
Normal file
55
doc/installation.rst.in
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
Debian / Ubuntu:
|
||||
----------------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ apt-get install libnvme
|
||||
|
||||
Fedora / Red Hat:
|
||||
-----------------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ dnf install libnvme
|
||||
|
||||
Python binding
|
||||
--------------
|
||||
|
||||
Python Version
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
The latest Python 3 version is always recommended, since it has all
|
||||
the latest bells and whistles. libnvme supports Python 3.6 and above.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
libnvme only uses packages from the standard library, so no additional
|
||||
dependencies will be installed when installing libnvme.
|
||||
|
||||
Install libnvme python
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Debian / Ubuntu:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ apt-get install python3-libnvme
|
||||
|
||||
Fedora / Red Hat:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ dnf install python3-libnvme
|
||||
|
||||
libnvme is available on `PyPI`_, and can be installed using pip. The
|
||||
version on PyPI is always the latest stable release.
|
||||
|
||||
.. _PyPi: https://pypi.org/project/libnvme/
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ pip install libnvme
|
||||
10
doc/kernel-doc-check
Normal file
10
doc/kernel-doc-check
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
#!/bin/bash
|
||||
# SPDX-License-Identifier: LGPL-2.1-or-later
|
||||
|
||||
kernel_doc=$(dirname $0)/kernel-doc
|
||||
|
||||
"$kernel_doc" -none "$@" 2>&1 |
|
||||
grep '\(warning\|error\)'
|
||||
|
||||
# check that kernel-doc succeeded, but the grep failed
|
||||
[ ${PIPESTATUS[0]} -eq 0 -a ${PIPESTATUS[1]} -eq 1 ]
|
||||
|
|
@ -1,4 +1,5 @@
|
|||
#!/bin/bash
|
||||
# SPDX-License-Identifier: LGPL-2.1-or-later
|
||||
|
||||
file=$1
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_admin_opcode" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_admin_opcode" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_admin_opcode \- Known NVMe admin opcodes
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_admin_passthru \- Submit an nvme passthrough command
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -30,7 +30,7 @@ The nvme io command to send
|
|||
.IP "flags" 12
|
||||
NVMe command flags (not used)
|
||||
.IP "rsvd" 12
|
||||
Reserevd for future use
|
||||
Reserved for future use
|
||||
.IP "nsid" 12
|
||||
Namespace identifier
|
||||
.IP "cdw2" 12
|
||||
|
|
@ -50,11 +50,11 @@ Command dword 14
|
|||
.IP "cdw15" 12
|
||||
Command dword 15
|
||||
.IP "data_len" 12
|
||||
Length of the data transfered in this command in bytes
|
||||
Length of the data transferred 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
|
||||
Length of metadata transferred in this command
|
||||
.IP "metadata" 12
|
||||
Pointer to user address of the metadata buffer
|
||||
.IP "timeout_ms" 12
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_css_nvm \-
|
||||
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
|
||||
.SH SYNOPSIS
|
||||
enum nvme_ae_info_css_nvm {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_error" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_error" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_error \-
|
||||
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
|
||||
.SH SYNOPSIS
|
||||
enum nvme_ae_info_error {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_notice" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_notice" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_notice \-
|
||||
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
|
||||
.SH SYNOPSIS
|
||||
enum nvme_ae_info_notice {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_smart" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_smart" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_smart \-
|
||||
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
|
||||
.SH SYNOPSIS
|
||||
enum nvme_ae_info_smart {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_type" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_type" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_type \-
|
||||
enum nvme_ae_type \- Asynchronous Event Type
|
||||
.SH SYNOPSIS
|
||||
enum nvme_ae_type {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_aggregate_endurance_group_event \-
|
||||
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
|
||||
.SH SYNOPSIS
|
||||
struct nvme_aggregate_endurance_group_event {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_aggregate_predictable_lat_event \-
|
||||
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
|
||||
.SH SYNOPSIS
|
||||
struct nvme_aggregate_predictable_lat_event {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_ana_group_desc" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ana_group_desc" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_ana_group_desc \-
|
||||
struct nvme_ana_group_desc \- ANA Group Descriptor
|
||||
.SH SYNOPSIS
|
||||
struct nvme_ana_group_desc {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_ana_log" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ana_log" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_ana_log \-
|
||||
struct nvme_ana_log \- Asymmetric Namespace Access Log
|
||||
.SH SYNOPSIS
|
||||
struct nvme_ana_log {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_ana_state" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ana_state" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ana_state \-
|
||||
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
|
||||
.SH SYNOPSIS
|
||||
enum nvme_ana_state {
|
||||
.br
|
||||
|
|
@ -25,7 +25,12 @@ enum nvme_ana_state {
|
|||
};
|
||||
.SH Constants
|
||||
.IP "NVME_ANA_STATE_OPTIMIZED" 12
|
||||
ANA Optimized state
|
||||
.IP "NVME_ANA_STATE_NONOPTIMIZED" 12
|
||||
ANA Non-Optimized state
|
||||
.IP "NVME_ANA_STATE_INACCESSIBLE" 12
|
||||
ANA Inaccessible state
|
||||
.IP "NVME_ANA_STATE_PERSISTENT_LOSS" 12
|
||||
ANA Persistent Loss state
|
||||
.IP "NVME_ANA_STATE_CHANGE" 12
|
||||
ANA Change state
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_apst_entry" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_apst_entry" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_apst_entry \-
|
||||
enum nvme_apst_entry \- Autonomous Power State Transition
|
||||
.SH SYNOPSIS
|
||||
enum nvme_apst_entry {
|
||||
.br
|
||||
|
|
@ -21,6 +21,10 @@ enum nvme_apst_entry {
|
|||
};
|
||||
.SH Constants
|
||||
.IP "NVME_APST_ENTRY_ITPS_SHIFT" 12
|
||||
Idle Transition Power State Shift
|
||||
.IP "NVME_APST_ENTRY_ITPT_SHIFT" 12
|
||||
Idle Time Prior to Transition Shift
|
||||
.IP "NVME_APST_ENTRY_ITPS_MASK" 12
|
||||
Idle Transition Power State Mask
|
||||
.IP "NVME_APST_ENTRY_ITPT_MASK" 12
|
||||
Idle Time Prior to Transition Mask
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_boot_partition" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_boot_partition" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_boot_partition \-
|
||||
struct nvme_boot_partition \- Boot Partition Log
|
||||
.SH SYNOPSIS
|
||||
struct nvme_boot_partition {
|
||||
.br
|
||||
|
|
|
|||
33
doc/man/nvme_capacity_config_desc.2
Normal file
33
doc/man/nvme_capacity_config_desc.2
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
|
||||
.SH SYNOPSIS
|
||||
struct nvme_capacity_config_desc {
|
||||
.br
|
||||
.BI " __le16 cap_config_id;"
|
||||
.br
|
||||
.BI " __le16 domainid;"
|
||||
.br
|
||||
.BI " __le16 egcn;"
|
||||
.br
|
||||
.BI " __u8 rsvd6[26];"
|
||||
.br
|
||||
.BI " struct nvme_end_grp_config_desc egcd[];"
|
||||
.br
|
||||
.BI "
|
||||
};
|
||||
.br
|
||||
|
||||
.SH Members
|
||||
.IP "cap_config_id" 12
|
||||
Capacity Configuration Identifier
|
||||
.IP "domainid" 12
|
||||
Domain Identifier
|
||||
.IP "egcn" 12
|
||||
Number Endurance Group Configuration
|
||||
Descriptors
|
||||
.IP "rsvd6" 12
|
||||
Reserved
|
||||
.IP "egcd" 12
|
||||
Endurance Group Config descriptors.
|
||||
See \fIstruct\fP nvme_end_grp_config_desc
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_capacity_mgmt \-
|
||||
nvme_capacity_mgmt \- Capacity management command
|
||||
.SH SYNOPSIS
|
||||
.B "int" nvme_capacity_mgmt
|
||||
.BI "(struct nvme_capacity_mgmt_args *args " ");"
|
||||
|
|
|
|||
|
|
@ -1,45 +0,0 @@
|
|||
.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
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_change_ns_event" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_change_ns_event" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_change_ns_event \-
|
||||
struct nvme_change_ns_event \- Change Namespace Event Data
|
||||
.SH SYNOPSIS
|
||||
struct nvme_change_ns_event {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_channel_config_desc" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_channel_config_desc" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_channel_config_desc \-
|
||||
struct nvme_channel_config_desc \- Channel Configuration Descriptor
|
||||
.SH SYNOPSIS
|
||||
struct nvme_channel_config_desc {
|
||||
.br
|
||||
|
|
@ -19,6 +19,6 @@ struct nvme_channel_config_desc {
|
|||
Channel Identifier
|
||||
.IP "chmus" 12
|
||||
Number Channel Media Units
|
||||
.SH "Description"
|
||||
Channel Configuration Descriptor
|
||||
Structure Definitions
|
||||
.IP "mu_config_desc" 12
|
||||
Channel Unit config descriptors.
|
||||
See \fIstruct\fP nvme_media_unit_config_desc
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_cmb_size \- Calculate size of the controller memory buffer
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -7,5 +7,5 @@ nvme_cmb_size \- Calculate size of the controller memory buffer
|
|||
.SH ARGUMENTS
|
||||
.IP "cmbsz" 12
|
||||
Value from controller register NVME_REG_CMBSZ
|
||||
.SH "DESCRIPTION"
|
||||
Returns size of controller memory buffer in bytes
|
||||
.SH "RETURN"
|
||||
size of controller memory buffer in bytes
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_effects" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_effects" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_effects \-
|
||||
enum nvme_cmd_effects \- Commands Supported and Effects
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmd_effects {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_cmd_effects_log \-
|
||||
struct nvme_cmd_effects_log \- Commands Supported and Effects Log
|
||||
.SH SYNOPSIS
|
||||
struct nvme_cmd_effects_log {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_format_mset \- Format NVM - Metadata Settings
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_format_pi \- Format NVM - Protection Information
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_format_pil \- Format NVM - Protection Information Location
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_get_log_lid \-
|
||||
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmd_get_log_lid {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_get_log_telemetry_host_lsp \-
|
||||
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmd_get_log_telemetry_host_lsp {
|
||||
.br
|
||||
|
|
@ -13,4 +13,6 @@ enum nvme_cmd_get_log_telemetry_host_lsp {
|
|||
};
|
||||
.SH Constants
|
||||
.IP "NVME_LOG_TELEM_HOST_LSP_RETAIN" 12
|
||||
Get Telemetry Data Blocks
|
||||
.IP "NVME_LOG_TELEM_HOST_LSP_CREATE" 12
|
||||
Create Telemetry Data Blocks
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_compare" 9 "nvme_compare" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_compare" 9 "nvme_compare" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_compare \- Submit an nvme user compare command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_connect_err" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_connect_err" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_connect_err \- nvme connect error codes
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -49,6 +49,26 @@ enum nvme_connect_err {
|
|||
.br
|
||||
.br
|
||||
.BI " ENVME_CONNECT_LOOKUP_SUBSYS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " ENVME_CONNECT_ALREADY"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " ENVME_CONNECT_INVAL"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " ENVME_CONNECT_ADDRINUSE"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " ENVME_CONNECT_NODEV"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " ENVME_CONNECT_OPNOTSUPP"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
|
|
@ -76,3 +96,13 @@ invalid transport type
|
|||
failed to lookup subsystem name
|
||||
.IP "ENVME_CONNECT_LOOKUP_SUBSYS" 12
|
||||
failed to lookup subsystem
|
||||
.IP "ENVME_CONNECT_ALREADY" 12
|
||||
the connect attempt failed, already connected
|
||||
.IP "ENVME_CONNECT_INVAL" 12
|
||||
invalid arguments/configuration
|
||||
.IP "ENVME_CONNECT_ADDRINUSE" 12
|
||||
hostnqn already in use
|
||||
.IP "ENVME_CONNECT_NODEV" 12
|
||||
invalid interface
|
||||
.IP "ENVME_CONNECT_OPNOTSUPP" 12
|
||||
not supported
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_constants" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_constants" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_constants \- A place to stash various constant nvme values
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -141,7 +141,7 @@ 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
|
||||
The largest possible index in the supported
|
||||
log pages log.
|
||||
.IP "NVME_ID_NVMSET_LIST_MAX" 12
|
||||
The largest possible nvmset index in identify
|
||||
|
|
@ -177,7 +177,7 @@ 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
|
||||
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
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "nvme_copy" 9 "nvme_copy" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_copy" 9 "nvme_copy" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_copy \-
|
||||
nvme_copy \- Copy command
|
||||
.SH SYNOPSIS
|
||||
.B "int" nvme_copy
|
||||
.BI "(struct nvme_copy_args *args " ");"
|
||||
|
|
|
|||
|
|
@ -1,83 +0,0 @@
|
|||
.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
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_copy_range" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_copy_range \-
|
||||
struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
|
||||
.SH SYNOPSIS
|
||||
struct nvme_copy_range {
|
||||
.br
|
||||
|
|
@ -32,7 +32,8 @@ Number of Logical Blocks
|
|||
.IP "rsvd18" 12
|
||||
Reserved
|
||||
.IP "eilbrt" 12
|
||||
Expected Initial Logical Block Reference Tag
|
||||
Expected Initial Logical Block Reference Tag /
|
||||
Expected Logical Block Storage Tag
|
||||
.IP "elbatm" 12
|
||||
Expected Logical Block Application Tag Mask
|
||||
.IP "elbat" 12
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_create_ctrl \- Allocate an unconnected NVMe controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_create_root" 9 "nvme_create_root" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_create_root" 9 "nvme_create_root" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_create_root \- Initialize root object
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_csi" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_csi" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_csi \- Defined command set indicators
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_first_ns \- Start namespace iterator
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_first_path \- Start path iterator
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_for_each_ns \- Traverse namespaces
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_for_each_ns_safe \- Traverse namespaces
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_for_each_path \- Traverse paths
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_for_each_path_safe \- Traverse paths
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_address \- Address string of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_config \- Fabrics configuration of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_dhchap_key \- Return controller key
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_fd \- Get associated file descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_firmware \- Firmware string of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_host_iface \- Host interface name of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_host_traddr \- Host transport address of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_model \- Model of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_name \- sysfs name of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_numa_node \- NUMA node of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_queue_count \- Queue count of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_serial \- Serial number of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -6,6 +6,6 @@ nvme_ctrl_get_serial \- Serial number of a controller
|
|||
.BI "(nvme_ctrl_t c " ");"
|
||||
.SH ARGUMENTS
|
||||
.IP "c" 12
|
||||
Conroller instance
|
||||
Controller instance
|
||||
.SH "RETURN"
|
||||
Serial number string of \fIc\fP
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_sqsize \- SQ size of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_state \- Running state of an controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_subsysnqn \- Subsystem NQN of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_subsystem \- Parent subsystem of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_sysfs_dir \- sysfs directory of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_traddr \- Transport address of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_transport \- Transport type of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_trsvcid \- Transport service identifier of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_identify \- Issues an 'identify controller' command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_is_discovered \- Returns the value of the 'discovered' flag
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_is_discovery_ctrl \- Check the 'discovery_ctrl' flag
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_is_persistent \- Returns the value of the 'persistent' flag
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "struct nvme_ctrl_list" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ctrl_list" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_ctrl_list \-
|
||||
struct nvme_ctrl_list \- Controller List
|
||||
.SH SYNOPSIS
|
||||
struct nvme_ctrl_list {
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ctrl_metadata_type \- Controller Metadata Element Types
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -91,7 +91,7 @@ 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.
|
||||
Chipset driver version.
|
||||
.IP "NVME_CTRL_METADATA_OS_NAME_AND_BUILD" 12
|
||||
Operating system name and build.
|
||||
.IP "NVME_CTRL_METADATA_SYS_PROD_NAME" 12
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_next_ns \- Next namespace iterator
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_next_path \- Next path iterator
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_reset \- Initiate a controller reset
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_set_dhchap_key \- Set controller key
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_set_discovered \- Set the 'discovered' flag
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_set_discovery_ctrl \- Set the 'discovery_ctrl' flag
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_set_persistent \- Set the 'persistent' flag
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrls_filter \- Filter for controllers
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_default_host" 9 "nvme_default_host" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_default_host" 9 "nvme_default_host" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_default_host \- Initializes the default host
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "April 2022" "libnvme API manual" LINUX
|
||||
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "July 2022" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_dev_self_test \- Start or abort a self test
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,35 +0,0 @@
|
|||
.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
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
.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)
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "libnvme" 9 "enum nvme_directive_dtype" "April 2022" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_directive_dtype" "July 2022" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_directive_dtype \-
|
||||
enum nvme_directive_dtype \- Directive Types
|
||||
.SH SYNOPSIS
|
||||
enum nvme_directive_dtype {
|
||||
.br
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue