1
0
Fork 0

Merging upstream version 1.3.

Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 10:06:51 +01:00
parent 34cf2bc5f8
commit ae07fb4ed6
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
803 changed files with 4523 additions and 1325 deletions

View file

@ -4,6 +4,7 @@ ar = '/usr/arm-linux-gnueabihf/bin/ar'
strip = '/usr/arm-linux-gnueabihf/bin/strip'
pkgconfig = '/usr/bin/arm-linux-gnueabihf-pkg-config'
ld = '/usr/bin/arm-linux/gnueabihf-ld'
exe_wrapper = '/usr/bin/qemu-arm-static'
[properties]
root = '/usr/arm-linux-gnueabihf'

View file

@ -4,6 +4,7 @@ ar = '/usr/powerpc64le-linux-gnu/bin/ar'
strip = '/usr/powerpc64le-linux-gnu/bin/strip'
pkgconfig = '/usr/bin/powerpc64le-linux-gnu-pkg-config'
ld = '/usr/bin/powerpc64le-linux-gnu-ld'
exe_wrapper = '/usr/bin/qemu-ppc64le-static'
[properties]
root = '/usr/powerpc64le-linux-gnu'

18
.github/cross/ubuntu-s390x.txt vendored Normal file
View file

@ -0,0 +1,18 @@
[binaries]
c = '/usr/bin/s390x-linux-gnu-gcc'
ar = '/usr/s390x-linux-gnu/bin/ar'
strip = '/usr/s390x-linux-gnu/bin/strip'
pkgconfig = '/usr/bin/s390x-linux-gnu-pkg-config'
ld = '/usr/bin/s390x-linux-gnu-ld'
exe_wrapper = '/usr/bin/qemu-s390x-static'
[properties]
root = '/usr/s390x-linux-gnu'
has_function_printf = true
skip_sanity_check = true
[host_machine]
system = 'linux'
cpu_family = 's390x'
cpu = ''
endian = 'big'

6
.github/cross/ubuntu-static.txt vendored Normal file
View file

@ -0,0 +1,6 @@
[properties]
c_args = '-static'
cpp_args = c_args
[binaries]
c = '/usr/bin/gcc'

View file

@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: install libraries
run: sudo apt-get install libjson-c-dev
run: sudo apt-get install libjson-c-dev libdbus-1-dev
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
@ -44,16 +44,16 @@ jobs:
EOF
sudo apt update
- name: install armhf compiler
run: sudo apt install gcc-arm-linux-gnueabihf pkg-config
run: sudo apt install gcc-arm-linux-gnueabihf pkg-config qemu-user-static
- name: install libraries
run: sudo apt install uuid-dev:armhf libjson-c-dev:armhf
run: sudo apt install libjson-c-dev:armhf
- uses: actions/checkout@v3
- uses: BSFishy/meson-build@v1.0.3
with:
# suppress python for now; the python headers currently assume native
setup-options: --werror --cross-file=.github/cross/ubuntu-armhf.txt --wrap-mode=nofallback -Dpython=false
options: --verbose
action: build
action: test
- uses: actions/upload-artifact@v3
if: failure()
with:
@ -74,16 +74,46 @@ jobs:
EOF
sudo apt update
- name: install powerpc64le compiler
run: sudo apt install gcc-powerpc64le-linux-gnu pkg-config
run: sudo apt install gcc-powerpc64le-linux-gnu pkg-config qemu-user-static
- name: install libraries
run: sudo apt install uuid-dev:ppc64el libjson-c-dev:ppc64el
run: sudo apt install libjson-c-dev:ppc64el
- uses: actions/checkout@v3
- uses: BSFishy/meson-build@v1.0.3
with:
# suppress python for now; the python headers currently assume native
setup-options: --werror --cross-file=.github/cross/ubuntu-ppc64le.txt --wrap-mode=nofallback -Dpython=false
options: --verbose
action: build
action: test
- uses: actions/upload-artifact@v3
if: failure()
with:
name: Linux_Meson_Testlog
path: build/meson-logs/testlog.txt
build-cross-s390x:
runs-on: ubuntu-latest
steps:
- name: set up s390x architecture
run: |
export release=$(lsb_release -c -s)
sudo dpkg --add-architecture s390x
sudo sed -i -e 's/deb http/deb [arch=amd64] http/g' /etc/apt/sources.list
sudo dd of=/etc/apt/sources.list.d/s390x.list <<EOF
deb [arch=s390x] http://ports.ubuntu.com/ $release main universe restricted"
deb [arch=s390x] http://ports.ubuntu.com/ $release-updates main universe restricted"
EOF
sudo apt update
- name: install s390x compiler
run: sudo apt install gcc-s390x-linux-gnu pkg-config qemu-user-static
- name: install libraries
run: sudo apt install libjson-c-dev:s390x
- uses: actions/checkout@v3
- uses: BSFishy/meson-build@v1.0.3
with:
# suppress python for now; the python headers currently assume native
setup-options: --werror --cross-file=.github/cross/ubuntu-s390x.txt --wrap-mode=nofallback -Dpython=false
options: --verbose
action: test
- uses: actions/upload-artifact@v3
if: failure()
with:
@ -101,7 +131,29 @@ jobs:
python-version: '3.x'
- uses: BSFishy/meson-build@v1.0.3
with:
setup-options: --werror --wrap-mode=forcefallback
setup-options: --wrap-mode=forcefallback
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
path: build/meson-logs/meson-log.txt
build-with-libray-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: --wrap-mode=forcefallback --default-library=static
options: --verbose
action: test
meson-version: 0.61.2
@ -123,7 +175,7 @@ jobs:
python-version: '3.x'
- uses: BSFishy/meson-build@v1.0.3
with:
setup-options: --werror --wrap-mode=forcefallback --default-library=static
setup-options: --wrap-mode=forcefallback --cross-file=.github/cross/ubuntu-static.txt --default-library=static
options: --verbose
action: test
meson-version: 0.61.2
@ -138,7 +190,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: install libraries
run: sudo apt-get install libjson-c-dev lcov
run: sudo apt-get install libjson-c-dev libdbus-1-dev lcov
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:

2
.gitignore vendored
View file

@ -8,8 +8,10 @@ a.out
*.so.*
*.tar.gz
cscope.*
compile_commands.json
.build
.cache
subprojects/*
!subprojects/*.wrap

26
.readthedocs.yaml Normal file
View file

@ -0,0 +1,26 @@
# SPDX-License-Identifier: Apache-2.0
version: 2
python:
system_packages: true
build:
os: ubuntu-22.04
tools:
python: "3"
apt_packages:
- meson
- python3-lxml
- docbook-xsl
- xsltproc
- pandoc
jobs:
post_install:
- pip3 install lxml
pre_build:
- meson .build -Ddocs=rst -Ddocs-build=true || cat .build/meson-logs/meson-log.txt
- ninja -C .build
sphinx:
configuration: .build/doc/conf.py

View file

@ -1,18 +0,0 @@
===
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

View file

@ -12,7 +12,7 @@ copyright = '2020, Keith Busch'
author = 'Keith Busch <kbusch@kernel.org>'
master_doc = 'index'
release = '1.2'
release = '1.3'
# -- General configuration ---------------------------------------------------

View file

@ -33,6 +33,10 @@
"description": "NVMe host symbolic name",
"type": "string"
},
"persistent_discovery_ctrl": {
"description": "Enable/disable Persistent Discovery Controller",
"type": "boolean"
},
"required": [ "hostnqn" ],
"subsystems": {
"description": "Array of NVMe subsystem properties",

View file

@ -33,6 +33,10 @@
"description": "NVMe host symbolic name",
"type": "string"
},
"persistent_discovery_ctrl": {
"description": "Enable/disable Persistent Discovery Controller",
"type": "boolean"
},
"required": [ "hostnqn" ],
"subsystems": {
"description": "Array of NVMe subsystem properties",

View file

@ -1,52 +0,0 @@
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

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_admin_opcode" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_admin_opcode" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_admin_opcode \- Known NVMe admin opcodes
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "October 2022" "libnvme API manual" LINUX
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru \- Submit an nvme passthrough command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "October 2022" "libnvme API manual" LINUX
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_error" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_error" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_notice" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_notice" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_smart" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_smart" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_type" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_type" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ae_type \- Asynchronous Event Type
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ana_group_desc" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_group_desc" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_ana_group_desc \- ANA Group Descriptor
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ana_log" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_log" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_ana_log \- Asymmetric Namespace Access Log
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ana_state" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ana_state" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_apst_entry" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_apst_entry" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_apst_entry \- Autonomous Power State Transition
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_boot_partition" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_boot_partition" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_boot_partition \- Boot Partition Log
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "October 2022" "libnvme API manual" LINUX
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_capacity_mgmt \- Capacity management command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_change_ns_event" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_change_ns_event" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_change_ns_event \- Change Namespace Event Data
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_channel_config_desc" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_channel_config_desc" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_channel_config_desc \- Channel Configuration Descriptor
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "October 2022" "libnvme API manual" LINUX
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_cmb_size \- Calculate size of the controller memory buffer
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_effects" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_effects" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_effects \- Commands Supported and Effects
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_cmd_effects_log \- Commands Supported and Effects Log
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_mset \- Format NVM - Metadata Settings
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pi \- Format NVM - Protection Information
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pil \- Format NVM - Protection Information Location
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
.SH SYNOPSIS
@ -88,6 +88,22 @@ enum nvme_cmd_get_log_lid {
,
.br
.br
.BI " NVME_LOG_LID_FDP_CONFIGS"
,
.br
.br
.BI " NVME_LOG_LID_FDP_RUH_USAGE"
,
.br
.br
.BI " NVME_LOG_LID_FDP_STATS"
,
.br
.br
.BI " NVME_LOG_LID_FDP_EVENTS"
,
.br
.br
.BI " NVME_LOG_LID_DISCOVER"
,
.br
@ -146,6 +162,14 @@ Feature Identifiers Supported and Effects
NVMe-MI Commands Supported and Effects
.IP "NVME_LOG_LID_BOOT_PARTITION" 12
Boot Partition
.IP "NVME_LOG_LID_FDP_CONFIGS" 12
FDP Configurations
.IP "NVME_LOG_LID_FDP_RUH_USAGE" 12
Reclaim Unit Handle Usage
.IP "NVME_LOG_LID_FDP_STATS" 12
FDP Statistics
.IP "NVME_LOG_LID_FDP_EVENTS" 12
FDP Events
.IP "NVME_LOG_LID_DISCOVER" 12
Discovery
.IP "NVME_LOG_LID_RESERVATION" 12

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_compare" 9 "nvme_compare" "October 2022" "libnvme API manual" LINUX
.TH "nvme_compare" 9 "nvme_compare" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_compare \- Submit an nvme user compare command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_connect_err" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_connect_err" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_connect_err \- nvme connect error codes
.SH SYNOPSIS
@ -69,6 +69,10 @@ enum nvme_connect_err {
.br
.br
.BI " ENVME_CONNECT_OPNOTSUPP"
,
.br
.br
.BI " ENVME_CONNECT_CONNREFUSED"
};
.SH Constants
@ -106,3 +110,5 @@ hostnqn already in use
invalid interface
.IP "ENVME_CONNECT_OPNOTSUPP" 12
not supported
.IP "ENVME_CONNECT_CONNREFUSED" 12
connection refused

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_constants" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_constants" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_constants \- A place to stash various constant nvme values
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_copy" 9 "nvme_copy" "October 2022" "libnvme API manual" LINUX
.TH "nvme_copy" 9 "nvme_copy" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_copy \- Copy command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_copy_range" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_copy_range" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_copy_range_f1" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_copy_range_f1" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f1 \- Copy - Source Range Entries Descriptor Format 1h
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "October 2022" "libnvme API manual" LINUX
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_create_ctrl \- Allocate an unconnected NVMe controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_create_root" 9 "nvme_create_root" "October 2022" "libnvme API manual" LINUX
.TH "nvme_create_root" 9 "nvme_create_root" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_create_root \- Initialize root object
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_csi" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_csi" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_csi \- Defined command set indicators
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_ns \- Start namespace iterator
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_path \- Start path iterator
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns \- Traverse namespaces
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns_safe \- Traverse namespaces
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path \- Traverse paths
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path_safe \- Traverse paths
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_address \- Address string of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_config \- Fabrics configuration of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_host_key \- Return host key
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_key \- Return controller key
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_fd \- Get associated file descriptor
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_firmware \- Firmware string of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_iface \- Host interface name of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_traddr \- Host transport address of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_model \- Model of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_name \- sysfs name of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_numa_node \- NUMA node of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_queue_count \- Queue count of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_serial \- Serial number of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_sqsize \- SQ size of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_state \- Running state of an controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_subsysnqn \- Subsystem NQN of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_subsystem \- Parent subsystem of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_sysfs_dir \- sysfs directory of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_traddr \- Transport address of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_transport \- Transport type of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_trsvcid \- Transport service identifier of a controller
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_identify \- Issues an 'identify controller' command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_discovered \- Returns the value of the 'discovered' flag
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_discovery_ctrl \- Check the 'discovery_ctrl' flag
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_persistent \- Returns the value of the 'persistent' flag
.SH SYNOPSIS

View file

@ -0,0 +1,11 @@
.TH "nvme_ctrl_is_unique_discovery_ctrl" 9 "nvme_ctrl_is_unique_discovery_ctrl" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_unique_discovery_ctrl \- Check the 'unique_discovery_ctrl' flag
.SH SYNOPSIS
.B "bool" nvme_ctrl_is_unique_discovery_ctrl
.BI "(nvme_ctrl_t c " ");"
.SH ARGUMENTS
.IP "c" 12
Controller to be checked
.SH "RETURN"
Value of the 'unique_discovery_ctrl' flag

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ctrl_list" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ctrl_list" "January 2023" "API Manual" LINUX
.SH NAME
struct nvme_ctrl_list \- Controller List
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_ctrl_metadata_type \- Controller Metadata Element Types
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_next_ns \- Next namespace iterator
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_next_path \- Next path iterator
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_reset \- Initiate a controller reset
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_dhchap_host_key" 9 "nvme_ctrl_set_dhchap_host_key" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_dhchap_host_key" 9 "nvme_ctrl_set_dhchap_host_key" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_dhchap_host_key \- Set host key
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_dhchap_key \- Set controller key
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_discovered \- Set the 'discovered' flag
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_discovery_ctrl \- Set the 'discovery_ctrl' flag
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_persistent \- Set the 'persistent' flag
.SH SYNOPSIS

View file

@ -0,0 +1,15 @@
.TH "nvme_ctrl_set_unique_discovery_ctrl" 9 "nvme_ctrl_set_unique_discovery_ctrl" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_unique_discovery_ctrl \- Set the 'unique_discovery_ctrl' flag
.SH SYNOPSIS
.B "void" nvme_ctrl_set_unique_discovery_ctrl
.BI "(nvme_ctrl_t c " ","
.BI "bool unique " ");"
.SH ARGUMENTS
.IP "c" 12
Controller to be modified
.IP "unique" 12
value of the unique_disc_ctrl flag
.SH "DESCRIPTION"
Sets the 'unique_discovery_ctrl' flag in \fIc\fP to specify wheter
\fIc\fP is a unique discovery controller

View file

@ -1,4 +1,4 @@
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "October 2022" "libnvme API manual" LINUX
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ctrls_filter \- Filter for controllers
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_data_tfr" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_data_tfr" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_data_tfr \- Data transfer direction of the command
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_default_host" 9 "nvme_default_host" "October 2022" "libnvme API manual" LINUX
.TH "nvme_default_host" 9 "nvme_default_host" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_default_host \- Initializes the default host
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "October 2022" "libnvme API manual" LINUX
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_dev_self_test \- Start or abort a self test
.SH SYNOPSIS
@ -15,7 +15,7 @@ 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
Set the 'nsid' field to 0 to not include namespaces in the test. Set to
0xffffffff to test all namespaces. All other values tests a specific
namespace, if present.
.SH "RETURN"

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_directive_dtype" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_dtype" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_directive_dtype \- Directive Types
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_directive_receive_doper" "October 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_receive_doper" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_directive_receive_doper \- Directive Receive Directive Operation
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_directive_recv" 9 "nvme_directive_recv" "October 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv" 9 "nvme_directive_recv" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv \- Receive directive specific data
.SH SYNOPSIS

View file

@ -1,4 +1,4 @@
.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "October 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_identify_parameters \- Directive receive identifier parameters
.SH SYNOPSIS

Some files were not shown because too many files have changed in this diff Show more