Merging upstream version 1.6.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
adbb3a10cc
commit
6add9877e4
GPG key ID:
FBB4F0E80A80222F
871 changed files with 8481 additions and 1502 deletions
51
.github/workflows/build.yml
vendored
51
.github/workflows/build.yml
vendored
|
|
@ -17,9 +17,9 @@ jobs:
|
|||
compiler: [gcc, clang]
|
||||
buildtype: [debug, release]
|
||||
container:
|
||||
image: ghcr.io/igaw/linux-nvme/debian:0.30
|
||||
image: ghcr.io/igaw/linux-nvme/debian:latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
|
@ -40,33 +40,22 @@ jobs:
|
|||
matrix:
|
||||
include:
|
||||
- arch: armhf
|
||||
port: armhf
|
||||
compiler: gcc-arm-linux-gnueabihf
|
||||
packages:
|
||||
- arch: s390x
|
||||
port: s390x
|
||||
compiler: gcc-s390x-linux-gnu
|
||||
packages: libgcc-s1:s390x
|
||||
- arch: ppc64le
|
||||
port: ppc64el
|
||||
compiler: gcc-powerpc64le-linux-gnu
|
||||
packges:
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: set up arm architecture
|
||||
run: |
|
||||
export release=$(lsb_release -c -s)
|
||||
sudo dpkg --add-architecture ${{ matrix.port }}
|
||||
sudo sed -i -e 's/deb http/deb [arch=amd64] http/g' /etc/apt/sources.list
|
||||
sudo dd of=/etc/apt/sources.list.d/${{ matrix.arch }}.list <<EOF
|
||||
deb [arch=${{ matrix.port }}] http://ports.ubuntu.com/ $release main universe restricted"
|
||||
deb [arch=${{ matrix.port }}] http://ports.ubuntu.com/ $release-updates main universe restricted"
|
||||
EOF
|
||||
sudo apt update
|
||||
sudo apt install -y meson pkg-config qemu-user-static ${{ matrix.compiler}} libjson-c-dev:${{ matrix.port }} ${{ matrix.packages }}
|
||||
- name: build
|
||||
run: |
|
||||
- uses: actions/checkout@v4
|
||||
- name: enable foreign arch
|
||||
uses: dbhi/qus/action@main
|
||||
- name: compile and run unit tests
|
||||
uses: mosteo-actions/docker-run@v1
|
||||
with:
|
||||
image: ghcr.io/igaw/linux-nvme/ubuntu-cross-${{ matrix.arch }}:latest
|
||||
guest-dir: /build
|
||||
host-dir: ${{ github.workspace }}
|
||||
command: |
|
||||
scripts/build.sh -b release -c gcc -t ${{ matrix.arch }} cross
|
||||
params: "--platform linux/amd64"
|
||||
pull-params: "--platform linux/amd64"
|
||||
- uses: actions/upload-artifact@v3
|
||||
name: upload logs
|
||||
if: failure()
|
||||
|
|
@ -79,9 +68,9 @@ jobs:
|
|||
name: libdbus
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/igaw/linux-nvme/debian:0.30
|
||||
image: ghcr.io/igaw/linux-nvme/debian:latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
|
@ -100,10 +89,10 @@ jobs:
|
|||
name: fallback shared libraries
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/igaw/linux-nvme/debian:0.30
|
||||
image: ghcr.io/igaw/linux-nvme/debian:latest
|
||||
if: github.ref == 'refs/heads/master'
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
|
@ -121,9 +110,9 @@ jobs:
|
|||
name: muon minimal static
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/igaw/linux-nvme/debian:0.30
|
||||
image: ghcr.io/igaw/linux-nvme/debian:latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- name: build
|
||||
run: |
|
||||
scripts/build.sh -m muon
|
||||
|
|
|
|||
29
.github/workflows/coverage.yml
vendored
29
.github/workflows/coverage.yml
vendored
|
|
@ -9,30 +9,13 @@ jobs:
|
|||
code-coverage:
|
||||
name: code coverage
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/igaw/linux-nvme/debian.python:latest
|
||||
steps:
|
||||
- name: install libraries
|
||||
run: sudo apt-get install libjson-c-dev libdbus-1-dev lcov
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- uses: BSFishy/meson-build@v1.0.3
|
||||
with:
|
||||
# Can't use 'coverage' here, see
|
||||
# https://github.com/BSFishy/meson-build/issues/4
|
||||
action: test
|
||||
options: --verbose
|
||||
setup-options: >
|
||||
--werror
|
||||
--buildtype=release
|
||||
--wrap-mode=nofallback
|
||||
-Dlibdbus=enabled
|
||||
-Db_coverage=true
|
||||
meson-version: 0.61.2
|
||||
- name: Generate Coverage Report
|
||||
# Can't use meson here, see
|
||||
# https://github.com/mesonbuild/meson/issues/7895
|
||||
run: ninja -C build coverage --verbose
|
||||
- uses: actions/checkout@v4
|
||||
- name: build
|
||||
run: |
|
||||
scripts/build.sh coverage
|
||||
- uses: codecov/codecov-action@v3
|
||||
with:
|
||||
fail_ci_if_error: false
|
||||
|
|
|
|||
8
.github/workflows/release-python.yml
vendored
8
.github/workflows/release-python.yml
vendored
|
|
@ -15,11 +15,13 @@ jobs:
|
|||
build_sdist:
|
||||
name: Build source distribution
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/igaw/linux-nvme/debian.python:latest
|
||||
steps:
|
||||
- name: install libraries
|
||||
run: sudo apt-get install gcc pkg-config libjson-c-dev libssl-dev python3-dev
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/checkout@v3
|
||||
- name: Allow workspace
|
||||
run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
|
||||
|
||||
- name: Build sdist
|
||||
run: pipx run build --sdist
|
||||
|
|
|
|||
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
|
|
@ -14,7 +14,7 @@ jobs:
|
|||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- uses: ncipollo/release-action@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
|
|||
|
|
@ -2,9 +2,6 @@
|
|||
|
||||
version: 2
|
||||
|
||||
python:
|
||||
system_packages: true
|
||||
|
||||
build:
|
||||
os: ubuntu-22.04
|
||||
tools:
|
||||
|
|
|
|||
12
README.md
12
README.md
|
|
@ -1,7 +1,7 @@
|
|||
# libnvme
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://pypi.org/project/libnvme/)
|
||||
[](https://pypi.org/project/libnvme/)
|
||||
|
||||
|
|
@ -106,7 +106,7 @@ completely "clean" all the build artifacts, one need only delete the
|
|||
To compile:
|
||||
|
||||
```
|
||||
meson -C .build
|
||||
meson compile -C .build
|
||||
```
|
||||
|
||||
## To install libnvme
|
||||
|
|
@ -145,10 +145,10 @@ A few build options can be specified on the command line when invoking meson.
|
|||
| docs | [false], html, man, rst, all | Install documentation |
|
||||
| docs-build | [false], true | Enable build documentation |
|
||||
| python | [auto], enabled, disabled | Whether to build the Python bindings. When set to `auto`, the default, meson will check for the presence of the tools and libraries (e.g. `swig`) required to build the Python bindings. If found, meson will configure the project to build the Python bindings. If a tool or library is missing, then the Python bindings won't be built. Setting this to `enabled`, forces the Python bindings to be built. When set to `disabled`, meson will configure the project to not build the Python bindings.<br />Example: `meson setup .build -Dpython=disabled` |
|
||||
| openssl | [auto], enabled, disabled | Enables OpenSSL dependend features (e.g. authentication), adds build dependency on OpenSSL |
|
||||
| libdbus | auto, enabled, [disabled] | Enables D-Bus dependend features (libnvme-mi: End point discovery), adds build dependency on libdbus |
|
||||
| openssl | [auto], enabled, disabled | Enables OpenSSL dependent features (e.g. TLS over TCP), adds build dependency on OpenSSL |
|
||||
| libdbus | auto, enabled, [disabled] | Enables D-Bus dependent features (libnvme-mi: End point discovery), adds build dependency on libdbus |
|
||||
| json-c | [auto], enabled, disabled | (recommended) Enables JSON-C dependend features (e.g. config.json parsing), adds build depdency on json-c |
|
||||
| keyutils | [auto], enabled, disabled | Enables keyutils dependend features (e.g. TLS over TCP), adds build dependency on keyutils |
|
||||
| keyutils | [auto], enabled, disabled | Enables keyutils dependent features (e.g. authentication), adds build dependency on keyutils |
|
||||
|
||||
See the full configuration options with
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ copyright = '2020, Keith Busch'
|
|||
author = 'Keith Busch <kbusch@kernel.org>'
|
||||
master_doc = 'index'
|
||||
|
||||
release = '1.5'
|
||||
release = '1.6'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_control" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_control" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_control \- NBFT Table - Control Descriptor (Figure 8)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_control_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_control_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_control_flags \- Control Descriptor Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_desc_type" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_desc_type" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_desc_type \- NBFT Elements - Descriptor Types (Figure 5)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_discovery" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_discovery" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_discovery \- Discovery Descriptor (Figure 24)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_discovery_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_discovery_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_discovery_flags \- Discovery Descriptor Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_header" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_header" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_header \- NBFT Table - Header (Figure 8)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_heap_obj" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_heap_obj" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_heap_obj \- NBFT Header Driver Signature
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_hfi" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_hfi" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_hfi \- Host Fabric Interface (HFI) Descriptor (Figure 11)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_hfi_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_hfi_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_hfi_flags \- HFI Descriptor Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP (Figure 13)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_hfi_info_tcp_flags \- HFI Transport Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_host" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_host" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_host \- Host Descriptor (Figure 9)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_host_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_host_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_host_flags \- Host Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info \- The parsed NBFT table data.
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_discovery" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_discovery" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_discovery \- Discovery Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_hfi" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_hfi" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_hfi \- Host Fabric Interface (HFI) Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_host" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_host" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_host \- Host Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_info_nid_type" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_info_nid_type" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_info_nid_type \- Namespace Identifier Type (NIDT)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_info_primary_admin_host_flag \- Primary Administrative Host Descriptor Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_security" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_security" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_security \- Security Profile Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_subsystem_ns \- Subsystem Namespace (SSNS) info
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_security" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_security" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_security \- Security Profile Descriptor (Figure 21)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_security_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_security_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_security_flags \- Security Profile Descriptor Flags (Figure 22)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_security_secret_type" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_security_secret_type" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_security_secret_type \- Security Profile Descriptor Secret Type
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_ssns" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_ssns" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_ssns \- Subsystem Namespace (SSNS) Descriptor (Figure 15)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_ssns_ext_info \- Subsystem and Namespace Extended Information Descriptor (Figure 19)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_ssns_ext_info_flags \- Subsystem and Namespace Extended Information Descriptor Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_ssns_flags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_ssns_flags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_ssns_flags \- Subsystem and Namespace Specific Flags Field (Figure 16)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_ssns_trflags" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_ssns_trflags" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_ssns_trflags \- SSNS Transport Specific Flags Field (Figure 17)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nbft_trtype" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_trtype" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_trtype \- NBFT Interface Transport Types (Figure 7)
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_admin_opcode" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_admin_opcode" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_admin_passthru \- Submit an nvme passthrough command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_error" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_error" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_notice" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_notice" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_info_smart" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_smart" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ae_type" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_type" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ae_type \- Asynchronous Event Type
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_ana_group_desc" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ana_group_desc" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_ana_group_desc \- ANA Group Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_ana_log" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ana_log" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_ana_log \- Asymmetric Namespace Access Log
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_ana_state" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ana_state" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_apst_entry" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_apst_entry" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_apst_entry \- Autonomous Power State Transition
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_boot_partition" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_boot_partition" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_boot_partition \- Boot Partition Log
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_capacity_mgmt \- Capacity management command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_change_ns_event" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_change_ns_event" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_change_ns_event \- Change Namespace Event Data
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_channel_config_desc" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_channel_config_desc" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_channel_config_desc \- Channel Configuration Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_cmb_size \- Calculate size of the controller memory buffer
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_effects" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_effects" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_effects \- Commands Supported and Effects
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_cmd_effects_log \- Commands Supported and Effects Log
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "September 2023" "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" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "September 2023" "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" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "September 2023" "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" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -88,6 +88,10 @@ enum nvme_cmd_get_log_lid {
|
|||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_LOG_LID_PHY_RX_EOM"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_LOG_LID_FDP_CONFIGS"
|
||||
,
|
||||
.br
|
||||
|
|
@ -162,6 +166,8 @@ Feature Identifiers Supported and Effects
|
|||
NVMe-MI Commands Supported and Effects
|
||||
.IP "NVME_LOG_LID_BOOT_PARTITION" 12
|
||||
Boot Partition
|
||||
.IP "NVME_LOG_LID_PHY_RX_EOM" 12
|
||||
Physical Interface Receiver Eye Opening Measurement
|
||||
.IP "NVME_LOG_LID_FDP_CONFIGS" 12
|
||||
FDP Configurations
|
||||
.IP "NVME_LOG_LID_FDP_RUH_USAGE" 12
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_compare" 9 "nvme_compare" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_compare" 9 "nvme_compare" "September 2023" "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" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_connect_err" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_connect_err \- nvme connect error codes
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_constants" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_constants" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_constants \- A place to stash various constant nvme values
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_copy" 9 "nvme_copy" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_copy" 9 "nvme_copy" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_copy \- Copy command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_copy_range" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_copy_range_f1" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range_f1" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_copy_range_f1 \- Copy - Source Range Entries Descriptor Format 1h
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_create_root" 9 "nvme_create_root" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_create_root \- Initialize root object
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_csi" "June 2023" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_csi" "September 2023" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_csi \- Defined command set indicators
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
33
doc/man/nvme_ctrl_config_match.2
Normal file
33
doc/man/nvme_ctrl_config_match.2
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_config_match \- Check if ctrl @c matches config params
|
||||
.SH SYNOPSIS
|
||||
.B "bool" nvme_ctrl_config_match
|
||||
.BI "(struct nvme_ctrl *c " ","
|
||||
.BI "const char *transport " ","
|
||||
.BI "const char *traddr " ","
|
||||
.BI "const char *trsvcid " ","
|
||||
.BI "const char *subsysnqn " ","
|
||||
.BI "const char *host_traddr " ","
|
||||
.BI "const char *host_iface " ");"
|
||||
.SH ARGUMENTS
|
||||
.IP "c" 12
|
||||
An existing controller instance
|
||||
.IP "transport" 12
|
||||
Transport name
|
||||
.IP "traddr" 12
|
||||
Transport address
|
||||
.IP "trsvcid" 12
|
||||
Transport service identifier
|
||||
.IP "subsysnqn" 12
|
||||
Subsystem NQN
|
||||
.IP "host_traddr" 12
|
||||
Host transport address
|
||||
.IP "host_iface" 12
|
||||
Host interface name
|
||||
.SH "DESCRIPTION"
|
||||
Check that controller \fIc\fP matches parameters: \fItransport\fP, \fItraddr\fP,
|
||||
\fItrsvcid\fP, \fIsubsysnqn\fP, \fIhost_traddr\fP, and \fIhost_iface\fP. Parameters set
|
||||
to NULL will be ignored.
|
||||
.SH "RETURN"
|
||||
true if there's a match, false otherwise.
|
||||
37
doc/man/nvme_ctrl_find.2
Normal file
37
doc/man/nvme_ctrl_find.2
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_find \- Locate an existing controller
|
||||
.SH SYNOPSIS
|
||||
.B "nvme_ctrl_t" nvme_ctrl_find
|
||||
.BI "(nvme_subsystem_t s " ","
|
||||
.BI "const char *transport " ","
|
||||
.BI "const char *traddr " ","
|
||||
.BI "const char *trsvcid " ","
|
||||
.BI "const char *subsysnqn " ","
|
||||
.BI "const char *host_traddr " ","
|
||||
.BI "const char *host_iface " ");"
|
||||
.SH ARGUMENTS
|
||||
.IP "s" 12
|
||||
\fInvme_subsystem_t\fP object
|
||||
.IP "transport" 12
|
||||
Transport name
|
||||
.IP "traddr" 12
|
||||
Transport address
|
||||
.IP "trsvcid" 12
|
||||
Transport service identifier
|
||||
.IP "subsysnqn" 12
|
||||
Subsystem NQN
|
||||
.IP "host_traddr" 12
|
||||
Host transport address
|
||||
.IP "host_iface" 12
|
||||
Host interface name
|
||||
.SH "DESCRIPTION"
|
||||
Lookup a controller in \fIs\fP based on \fItransport\fP, \fItraddr\fP, \fItrsvcid\fP,
|
||||
\fIsubsysnqn\fP, \fIhost_traddr\fP, and \fIhost_iface\fP. \fItransport\fP must be specified,
|
||||
other fields may be required depending on the transport. Parameters set
|
||||
to NULL will be ignored.
|
||||
|
||||
Unlike \fBnvme_lookup_ctrl\fP, this function does not create a new object if
|
||||
an existing controller cannot be found.
|
||||
.SH "RETURN"
|
||||
Controller instance on success, NULL otherwise.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "September 2023" "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_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_dhchap_host_key \- Return host key
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_fd \- Get associated file descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -7,5 +7,12 @@ nvme_ctrl_get_fd \- Get associated file descriptor
|
|||
.SH ARGUMENTS
|
||||
.IP "c" 12
|
||||
Controller instance
|
||||
.SH "DESCRIPTION"
|
||||
libnvme will \fBopen\fP the file (if not already opened) and keep
|
||||
an internal copy of the file descriptor. Following calls to
|
||||
this API retrieve the internal cached copy of the file
|
||||
descriptor. The file will remain opened and the fd will
|
||||
remain cached until the controller object is deleted or
|
||||
\fBnvme_ctrl_release_fd\fP is called.
|
||||
.SH "RETURN"
|
||||
File descriptor associated with \fIc\fP or -1
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "September 2023" "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_phy_slot" 9 "nvme_ctrl_get_phy_slot" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_phy_slot" 9 "nvme_ctrl_get_phy_slot" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_phy_slot \- PCI physical slot number of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "September 2023" "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" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_serial \- Serial number of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_sqsize \- SQ size of a controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
|||
17
doc/man/nvme_ctrl_get_src_addr.2
Normal file
17
doc/man/nvme_ctrl_get_src_addr.2
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
.TH "nvme_ctrl_get_src_addr" 9 "nvme_ctrl_get_src_addr" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_src_addr \- Extract src_addr from the c->address string
|
||||
.SH SYNOPSIS
|
||||
.B "char *" nvme_ctrl_get_src_addr
|
||||
.BI "(nvme_ctrl_t c " ","
|
||||
.BI "char *src_addr " ","
|
||||
.BI "size_t src_addr_len " ");"
|
||||
.SH ARGUMENTS
|
||||
.IP "c" 12
|
||||
Controller instance
|
||||
.IP "src_addr" 12
|
||||
Where to copy the src_addr. Size must be at least INET6_ADDRSTRLEN.
|
||||
.IP "src_addr_len" 12
|
||||
Length of the buffer \fIsrc_addr\fP.
|
||||
.SH "RETURN"
|
||||
Pointer to \fIsrc_addr\fP on success. NULL on failure to extract the src_addr.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "June 2023" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "September 2023" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_get_state \- Running state of an controller
|
||||
nvme_ctrl_get_state \- Running state of a controller
|
||||
.SH SYNOPSIS
|
||||
.B "const char *" nvme_ctrl_get_state
|
||||
.BI "(nvme_ctrl_t c " ");"
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue