Merging upstream version 1.9.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
432344d511
commit
ff5afdb431
928 changed files with 6732 additions and 1442 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -12,6 +12,7 @@ compile_commands.json
|
|||
|
||||
.build
|
||||
.cache
|
||||
.vscode/
|
||||
|
||||
subprojects/*
|
||||
!subprojects/*.wrap
|
||||
|
|
|
@ -16,3 +16,4 @@ functions.
|
|||
.. include:: rst/filters.rst
|
||||
.. include:: rst/util.rst
|
||||
.. include:: rst/log.rst
|
||||
.. include:: rst/nbft.rst
|
||||
|
|
|
@ -12,7 +12,7 @@ copyright = '2020, Keith Busch'
|
|||
author = 'Keith Busch <kbusch@kernel.org>'
|
||||
master_doc = 'index'
|
||||
|
||||
release = '1.8'
|
||||
release = '1.9'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
|
|
@ -98,6 +98,14 @@
|
|||
"description": "Controller DH-HMAC-CHAP key",
|
||||
"type": "string"
|
||||
},
|
||||
"keyring": {
|
||||
"description": "Keyring for TLS key lookup",
|
||||
"type": "string"
|
||||
},
|
||||
"tls_key": {
|
||||
"description": "TLS key for the connection",
|
||||
"type": "string"
|
||||
},
|
||||
"nr_io_queues": {
|
||||
"description": "Number of I/O queues",
|
||||
"type": "integer"
|
||||
|
@ -156,14 +164,6 @@
|
|||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"keyring": {
|
||||
"description": "Keyring for TLS key lookup",
|
||||
"type": "integer"
|
||||
},
|
||||
"tls_key": {
|
||||
"description": "TLS key for the connection",
|
||||
"type": "integer"
|
||||
},
|
||||
"tls": {
|
||||
"description": "Enable TLS encryption",
|
||||
"type": "boolean",
|
||||
|
|
|
@ -98,6 +98,14 @@
|
|||
"description": "Controller DH-HMAC-CHAP key",
|
||||
"type": "string"
|
||||
},
|
||||
"keyring": {
|
||||
"description": "Keyring for TLS key lookup",
|
||||
"type": "string"
|
||||
},
|
||||
"tls_key": {
|
||||
"description": "TLS key for the connection",
|
||||
"type": "string"
|
||||
},
|
||||
"nr_io_queues": {
|
||||
"description": "Number of I/O queues",
|
||||
"type": "integer"
|
||||
|
@ -156,14 +164,6 @@
|
|||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"keyring": {
|
||||
"description": "Keyring for TLS key lookup",
|
||||
"type": "integer"
|
||||
},
|
||||
"tls_key": {
|
||||
"description": "TLS key for the connection",
|
||||
"type": "integer"
|
||||
},
|
||||
"tls": {
|
||||
"description": "Enable TLS encryption",
|
||||
"type": "boolean",
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_control" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_control" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_control_flags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_desc_type" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_discovery" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_discovery_flags" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_discovery_flags \- Discovery Descriptor Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_header" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_header" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_heap_obj" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_hfi" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_hfi_flags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_host" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_host_flags" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_host_flags \- Host Flags
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_discovery" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_discovery \- Discovery Descriptor
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_info_hfi" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_hfi" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_host" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_info_nid_type" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_security" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nbft_info_subsystem_ns \- Subsystem Namespace (SSNS) info
|
||||
.SH SYNOPSIS
|
||||
|
@ -40,6 +40,10 @@ struct nbft_info_subsystem_ns {
|
|||
.br
|
||||
.BI " char *dhcp_root_path_string;"
|
||||
.br
|
||||
.BI " bool discovered;"
|
||||
.br
|
||||
.BI " bool unavailable;"
|
||||
.br
|
||||
.BI "
|
||||
};
|
||||
.br
|
||||
|
@ -92,3 +96,9 @@ Descriptor) or 0 if not supported.
|
|||
.IP "dhcp_root_path_string" 12
|
||||
DHCP Root Path Override string (SSNS Extended
|
||||
Information Descriptor).
|
||||
.IP "discovered" 12
|
||||
Indicates that this namespace was acquired
|
||||
through discovery.
|
||||
.IP "unavailable" 12
|
||||
Namespace is unavailable as indicated by
|
||||
the pre-OS driver.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nbft_security" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_security" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_security_flags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_security_secret_type" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_ssns" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_ssns_flags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_ssns_trflags" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nbft_trtype" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nbft_trtype \- NBFT Interface Transport Types (Figure 7)
|
||||
.SH SYNOPSIS
|
||||
|
|
12
doc/man/nvme_acq.2
Normal file
12
doc/man/nvme_acq.2
Normal file
|
@ -0,0 +1,12 @@
|
|||
.TH "libnvme" 9 "enum nvme_acq" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_acq \- This field indicates the admin completion queue base address
|
||||
.SH SYNOPSIS
|
||||
enum nvme_acq {
|
||||
.br
|
||||
.BI " NVME_ACQ_ACQB_SHIFT"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_ACQ_ACQB_SHIFT" 12
|
||||
Shift amount to get the admin completion queue base
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_admin_opcode" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_admin_opcode" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_error" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_notice" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_info_smart" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ae_type" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ana_group_desc" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_ana_log" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_ana_state" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_apst_entry" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_apst_entry \- Autonomous Power State Transition
|
||||
.SH SYNOPSIS
|
||||
|
|
30
doc/man/nvme_aqa.2
Normal file
30
doc/man/nvme_aqa.2
Normal file
|
@ -0,0 +1,30 @@
|
|||
.TH "libnvme" 9 "enum nvme_aqa" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_aqa \- This field indicates the admin queue attributes
|
||||
.SH SYNOPSIS
|
||||
enum nvme_aqa {
|
||||
.br
|
||||
.BI " NVME_AQA_ASQS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_AQA_ACQS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_AQA_ASQS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_AQA_ACQS_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_AQA_ASQS_SHIFT" 12
|
||||
Shift amount to get the admin submission queue size
|
||||
.IP "NVME_AQA_ACQS_SHIFT" 12
|
||||
Shift amount to get the admin completion queue size
|
||||
.IP "NVME_AQA_ASQS_MASK" 12
|
||||
Mask to get the admin submission queue size
|
||||
.IP "NVME_AQA_ACQS_MASK" 12
|
||||
Mask to get the admin completion queue size
|
12
doc/man/nvme_asq.2
Normal file
12
doc/man/nvme_asq.2
Normal file
|
@ -0,0 +1,12 @@
|
|||
.TH "libnvme" 9 "enum nvme_asq" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_asq \- This field indicates the admin submission queue base address
|
||||
.SH SYNOPSIS
|
||||
enum nvme_asq {
|
||||
.br
|
||||
.BI " NVME_ASQ_ASQB_SHIFT"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_ASQ_ASQB_SHIFT" 12
|
||||
Shift amount to get the admin submission queue base
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_boot_partition" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_boot_partition" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_boot_partition \- Boot Partition Log
|
||||
.SH SYNOPSIS
|
||||
|
|
34
doc/man/nvme_boot_partition_info.2
Normal file
34
doc/man/nvme_boot_partition_info.2
Normal file
|
@ -0,0 +1,34 @@
|
|||
.TH "libnvme" 9 "enum nvme_boot_partition_info" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_boot_partition_info \- This field indicates the boot partition information
|
||||
.SH SYNOPSIS
|
||||
enum nvme_boot_partition_info {
|
||||
.br
|
||||
.BI " NVME_BOOT_PARTITION_INFO_BPSZ_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BOOT_PARTITION_INFO_ABPID_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BOOT_PARTITION_INFO_BPSZ_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BOOT_PARTITION_INFO_ABPID_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_BOOT_PARTITION_INFO_BPSZ_SHIFT" 12
|
||||
Shift amount to get the boot partition size from
|
||||
the \fIstruct nvme_boot_partition\fP.bpinfo field.
|
||||
.IP "NVME_BOOT_PARTITION_INFO_ABPID_SHIFT" 12
|
||||
Shift amount to get the active boot partition ID
|
||||
from the \fIstruct nvme_boot_partition\fP.bpinfo field.
|
||||
.IP "NVME_BOOT_PARTITION_INFO_BPSZ_MASK" 12
|
||||
Mask to get the boot partition size from the
|
||||
\fIstruct nvme_boot_partition\fP.bpinfo field.
|
||||
.IP "NVME_BOOT_PARTITION_INFO_ABPID_MASK" 12
|
||||
Mask to get the active boot partition ID from the
|
||||
\fIstruct nvme_boot_partition\fP.bpinfo field.
|
66
doc/man/nvme_bpinfo.2
Normal file
66
doc/man/nvme_bpinfo.2
Normal file
|
@ -0,0 +1,66 @@
|
|||
.TH "libnvme" 9 "enum nvme_bpinfo" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_bpinfo \- This field indicates the boot partition information
|
||||
.SH SYNOPSIS
|
||||
enum nvme_bpinfo {
|
||||
.br
|
||||
.BI " NVME_BPINFO_BPSZ_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BRS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_ABPID_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BPSZ_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BRS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_ABPID_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BRS_NONE"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BRS_READ_IN_PROGRESS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BRS_READ_SUCCESS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPINFO_BRS_READ_ERROR"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_BPINFO_BPSZ_SHIFT" 12
|
||||
Shift amount to get the boot partition size
|
||||
.IP "NVME_BPINFO_BRS_SHIFT" 12
|
||||
Shift amount to get the boot read status
|
||||
.IP "NVME_BPINFO_ABPID_SHIFT" 12
|
||||
Shift amount to get the active boot partition ID
|
||||
.IP "NVME_BPINFO_BPSZ_MASK" 12
|
||||
Mask to get the boot partition size
|
||||
.IP "NVME_BPINFO_BRS_MASK" 12
|
||||
Mask to get the boot read status
|
||||
.IP "NVME_BPINFO_ABPID_MASK" 12
|
||||
Mask to get the active boot partition ID
|
||||
.IP "NVME_BPINFO_BRS_NONE" 12
|
||||
No boot partition read operation requested
|
||||
.IP "NVME_BPINFO_BRS_READ_IN_PROGRESS" 12
|
||||
Boot partition read in progress
|
||||
.IP "NVME_BPINFO_BRS_READ_SUCCESS" 12
|
||||
Boot partition read completed successfully
|
||||
.IP "NVME_BPINFO_BRS_READ_ERROR" 12
|
||||
Error completing boot partition read
|
12
doc/man/nvme_bpmbl.2
Normal file
12
doc/man/nvme_bpmbl.2
Normal file
|
@ -0,0 +1,12 @@
|
|||
.TH "libnvme" 9 "enum nvme_bpmbl" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_bpmbl \- This field indicates the boot partition memory buffer location
|
||||
.SH SYNOPSIS
|
||||
enum nvme_bpmbl {
|
||||
.br
|
||||
.BI " NVME_BPMBL_BMBBA_SHIFT"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_BPMBL_BMBBA_SHIFT" 12
|
||||
Shift amount to get the boot partition memory buffer base address
|
42
doc/man/nvme_bprsel.2
Normal file
42
doc/man/nvme_bprsel.2
Normal file
|
@ -0,0 +1,42 @@
|
|||
.TH "libnvme" 9 "enum nvme_bprsel" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_bprsel \- This field indicates the boot partition read select
|
||||
.SH SYNOPSIS
|
||||
enum nvme_bprsel {
|
||||
.br
|
||||
.BI " NVME_BPRSEL_BPRSZ_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPRSEL_BPROF_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPRSEL_BPID_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPRSEL_BPRSZ_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPRSEL_BPROF_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_BPRSEL_BPID_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_BPRSEL_BPRSZ_SHIFT" 12
|
||||
Shift amount to get the boot partition read size
|
||||
.IP "NVME_BPRSEL_BPROF_SHIFT" 12
|
||||
Shift amount to get the boot partition read offset
|
||||
.IP "NVME_BPRSEL_BPID_SHIFT" 12
|
||||
Shift amount to get the boot partition identifier
|
||||
.IP "NVME_BPRSEL_BPRSZ_MASK" 12
|
||||
Mask to get the boot partition read size
|
||||
.IP "NVME_BPRSEL_BPROF_MASK" 12
|
||||
Mask to get the boot partition read offset
|
||||
.IP "NVME_BPRSEL_BPID_MASK" 12
|
||||
Mask to get the boot partition identifier
|
252
doc/man/nvme_cap.2
Normal file
252
doc/man/nvme_cap.2
Normal file
|
@ -0,0 +1,252 @@
|
|||
.TH "libnvme" 9 "enum nvme_cap" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cap \- This field indicates the controller capabilities register
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cap {
|
||||
.br
|
||||
.BI " NVME_CAP_MQES_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CQR_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_AMS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_TO_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_DSTRD_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_NSSRC_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CSS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_BPS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CPS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_MPSMIN_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_MPSMAX_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_PMRS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CMBS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_NSSS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CRMS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_MQES_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CQR_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_AMS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_TO_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_DSTRD_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_NSSRC_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CSS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_BPS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CPS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_MPSMIN_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_MPSMAX_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_PMRS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CMBS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_NSSS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CRMS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_AMS_WRR"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_AMS_VS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CSS_NVM"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CSS_CSI"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CSS_ADMIN"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CPS_NONE"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CPS_CTRL"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CPS_DOMAIN"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CPS_NVMS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CRWMS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CAP_CRIMS"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CAP_MQES_SHIFT" 12
|
||||
Shift amount to get the maximum queue entries supported
|
||||
.IP "NVME_CAP_CQR_SHIFT" 12
|
||||
Shift amount to get the contiguous queues required
|
||||
.IP "NVME_CAP_AMS_SHIFT" 12
|
||||
Shift amount to get the arbitration mechanism supported
|
||||
.IP "NVME_CAP_TO_SHIFT" 12
|
||||
Shift amount to get the timeout
|
||||
.IP "NVME_CAP_DSTRD_SHIFT" 12
|
||||
Shift amount to get the doorbell stride
|
||||
.IP "NVME_CAP_NSSRC_SHIFT" 12
|
||||
Shift amount to get the NVM subsystem reset supported
|
||||
.IP "NVME_CAP_CSS_SHIFT" 12
|
||||
Shift amount to get the command sets supported
|
||||
.IP "NVME_CAP_BPS_SHIFT" 12
|
||||
Shift amount to get the boot partition support
|
||||
.IP "NVME_CAP_CPS_SHIFT" 12
|
||||
Shift amount to get the controller power scope
|
||||
.IP "NVME_CAP_MPSMIN_SHIFT" 12
|
||||
Shift amount to get the memory page size minimum
|
||||
.IP "NVME_CAP_MPSMAX_SHIFT" 12
|
||||
Shift amount to get the memory page size maximum
|
||||
.IP "NVME_CAP_PMRS_SHIFT" 12
|
||||
Shift amount to get the persistent memory region supported
|
||||
.IP "NVME_CAP_CMBS_SHIFT" 12
|
||||
Shift amount to get the controller memory buffer supported
|
||||
.IP "NVME_CAP_NSSS_SHIFT" 12
|
||||
Shift amount to get the NVM subsystem shutdown supported
|
||||
.IP "NVME_CAP_CRMS_SHIFT" 12
|
||||
Shift amount to get the controller ready modes supported
|
||||
.IP "NVME_CAP_MQES_MASK" 12
|
||||
Mask to get the maximum queue entries supported
|
||||
.IP "NVME_CAP_CQR_MASK" 12
|
||||
Mask to get the contiguous queues required
|
||||
.IP "NVME_CAP_AMS_MASK" 12
|
||||
Mask to get the arbitration mechanism supported
|
||||
.IP "NVME_CAP_TO_MASK" 12
|
||||
Mask to get the timeout
|
||||
.IP "NVME_CAP_DSTRD_MASK" 12
|
||||
Mask to get the doorbell stride
|
||||
.IP "NVME_CAP_NSSRC_MASK" 12
|
||||
Mask to get the NVM subsystem reset supported
|
||||
.IP "NVME_CAP_CSS_MASK" 12
|
||||
Mask to get the command sets supported
|
||||
.IP "NVME_CAP_BPS_MASK" 12
|
||||
Mask to get the boot partition support
|
||||
.IP "NVME_CAP_CPS_MASK" 12
|
||||
Mask to get the controller power scope
|
||||
.IP "NVME_CAP_MPSMIN_MASK" 12
|
||||
Mask to get the memory page size minimum
|
||||
.IP "NVME_CAP_MPSMAX_MASK" 12
|
||||
Mask to get the memory page size maximum
|
||||
.IP "NVME_CAP_PMRS_MASK" 12
|
||||
Mask to get the persistent memory region supported
|
||||
.IP "NVME_CAP_CMBS_MASK" 12
|
||||
Mask to get the controller memory buffer supported
|
||||
.IP "NVME_CAP_NSSS_MASK" 12
|
||||
Mask to get the NVM subsystem shutdown supported
|
||||
.IP "NVME_CAP_CRMS_MASK" 12
|
||||
Mask to get the controller ready modes supported
|
||||
.IP "NVME_CAP_AMS_WRR" 12
|
||||
Weighted round robin with urgent priority class
|
||||
.IP "NVME_CAP_AMS_VS" 12
|
||||
Vendor specific
|
||||
.IP "NVME_CAP_CSS_NVM" 12
|
||||
NVM command set or a discovery controller
|
||||
.IP "NVME_CAP_CSS_CSI" 12
|
||||
Controller supports one or more I/O command sets
|
||||
.IP "NVME_CAP_CSS_ADMIN" 12
|
||||
No I/O command set is supported
|
||||
.IP "NVME_CAP_CPS_NONE" 12
|
||||
Not reported
|
||||
.IP "NVME_CAP_CPS_CTRL" 12
|
||||
Controller scope
|
||||
.IP "NVME_CAP_CPS_DOMAIN" 12
|
||||
Domain scope
|
||||
.IP "NVME_CAP_CPS_NVMS" 12
|
||||
NVM subsystem scope
|
||||
.IP "NVME_CAP_CRWMS" 12
|
||||
Controller ready with media support
|
||||
.IP "NVME_CAP_CRIMS" 12
|
||||
Controller ready independent of media support
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_capacity_mgmt \- Capacity management command
|
||||
.SH SYNOPSIS
|
||||
|
|
168
doc/man/nvme_cc.2
Normal file
168
doc/man/nvme_cc.2
Normal file
|
@ -0,0 +1,168 @@
|
|||
.TH "libnvme" 9 "enum nvme_cc" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cc \- This field indicates the controller configuration
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cc {
|
||||
.br
|
||||
.BI " NVME_CC_EN_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CSS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_MPS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_AMS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_SHN_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_IOSQES_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_IOCQES_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CRIME_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_EN_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CSS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_MPS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_AMS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_SHN_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CRIME_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_IOSQES_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_IOCQES_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CSS_NVM"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CSS_CSI"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CSS_ADMIN"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_AMS_RR"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_AMS_WRRU"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_AMS_VS"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_SHN_NONE"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_SHN_NORMAL"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_SHN_ABRUPT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CRWME"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CC_CRIME"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CC_EN_SHIFT" 12
|
||||
Shift amount to get the enable
|
||||
.IP "NVME_CC_CSS_SHIFT" 12
|
||||
Shift amount to get the I/O command set selected
|
||||
.IP "NVME_CC_MPS_SHIFT" 12
|
||||
Shift amount to get the memory page size
|
||||
.IP "NVME_CC_AMS_SHIFT" 12
|
||||
Shift amount to get the arbitration mechanism selected
|
||||
.IP "NVME_CC_SHN_SHIFT" 12
|
||||
Shift amount to get the shutdown notification
|
||||
.IP "NVME_CC_IOSQES_SHIFT" 12
|
||||
Shift amount to get the I/O submission queue entry size
|
||||
.IP "NVME_CC_IOCQES_SHIFT" 12
|
||||
Shift amount to get the I/O completion queue entry size
|
||||
.IP "NVME_CC_CRIME_SHIFT" 12
|
||||
Shift amount to get the controller ready independent of media enable
|
||||
.IP "NVME_CC_EN_MASK" 12
|
||||
Mask to get the enable
|
||||
.IP "NVME_CC_CSS_MASK" 12
|
||||
Mask to get the I/O command set selected
|
||||
.IP "NVME_CC_MPS_MASK" 12
|
||||
Mask to get the memory page size
|
||||
.IP "NVME_CC_AMS_MASK" 12
|
||||
Mask to get the arbitration mechanism selected
|
||||
.IP "NVME_CC_SHN_MASK" 12
|
||||
Mask to get the shutdown notification
|
||||
.IP "NVME_CC_CRIME_MASK" 12
|
||||
Mask to get the I/O submission queue entry size
|
||||
.IP "NVME_CC_IOSQES_MASK" 12
|
||||
Mask to get the I/O completion queue entry size
|
||||
.IP "NVME_CC_IOCQES_MASK" 12
|
||||
Mask to get the controller ready independent of media enable
|
||||
.IP "NVME_CC_CSS_NVM" 12
|
||||
NVM command set
|
||||
.IP "NVME_CC_CSS_CSI" 12
|
||||
All supported I/O command sets
|
||||
.IP "NVME_CC_CSS_ADMIN" 12
|
||||
Admin command set only
|
||||
.IP "NVME_CC_AMS_RR" 12
|
||||
Round robin
|
||||
.IP "NVME_CC_AMS_WRRU" 12
|
||||
Weighted round robin with urgent priority class
|
||||
.IP "NVME_CC_AMS_VS" 12
|
||||
Vendor specific
|
||||
.IP "NVME_CC_SHN_NONE" 12
|
||||
No notification; no effect
|
||||
.IP "NVME_CC_SHN_NORMAL" 12
|
||||
Normal shutdown notification
|
||||
.IP "NVME_CC_SHN_ABRUPT" 12
|
||||
Abrupt shutdown notification
|
||||
.IP "NVME_CC_CRWME" 12
|
||||
Controller ready with media enable
|
||||
.IP "NVME_CC_CRIME" 12
|
||||
Controller ready independent of media enable
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_change_ns_event" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_change_ns_event" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_channel_config_desc" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_cmb_size \- Calculate size of the controller memory buffer
|
||||
.SH SYNOPSIS
|
||||
|
|
66
doc/man/nvme_cmbebs.2
Normal file
66
doc/man/nvme_cmbebs.2
Normal file
|
@ -0,0 +1,66 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmbebs" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmbebs \- This field indicates the controller memory buffer elasticity buffer size
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmbebs {
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBSZU_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_RBB_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBWBZ_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBSZU_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_RBB_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBWBZ_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBSZU_B"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBSZU_1K"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBSZU_1M"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBEBS_CMBSZU_1G"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMBEBS_CMBSZU_SHIFT" 12
|
||||
Shift amount to get the CMB elasticity buffer size units
|
||||
.IP "NVME_CMBEBS_RBB_SHIFT" 12
|
||||
Shift amount to get the read bypass behavior
|
||||
.IP "NVME_CMBEBS_CMBWBZ_SHIFT" 12
|
||||
Shift amount to get the CMB elasiticity buffer size base
|
||||
.IP "NVME_CMBEBS_CMBSZU_MASK" 12
|
||||
Mask to get the CMB elasticity buffer size units
|
||||
.IP "NVME_CMBEBS_RBB_MASK" 12
|
||||
Mask to get the read bypass behavior
|
||||
.IP "NVME_CMBEBS_CMBWBZ_MASK" 12
|
||||
Mask to get the CMB elasiticity buffer size base
|
||||
.IP "NVME_CMBEBS_CMBSZU_B" 12
|
||||
Bytes granularity
|
||||
.IP "NVME_CMBEBS_CMBSZU_1K" 12
|
||||
1 KiB granularity
|
||||
.IP "NVME_CMBEBS_CMBSZU_1M" 12
|
||||
1 MiB granularity
|
||||
.IP "NVME_CMBEBS_CMBSZU_1G" 12
|
||||
1 GiB granularity
|
102
doc/man/nvme_cmbloc.2
Normal file
102
doc/man/nvme_cmbloc.2
Normal file
|
@ -0,0 +1,102 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmbloc" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmbloc \- This field indicates the controller memory buffer location
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmbloc {
|
||||
.br
|
||||
.BI " NVME_CMBLOC_BIR_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CQMMS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CQPDS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CDPLMS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CDPCILS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CDMMMS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CQDA_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_OFST_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_BIR_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CQMMS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CQPDS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CDPLMS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CDPCILS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CDMMMS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_CQDA_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBLOC_OFST_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMBLOC_BIR_SHIFT" 12
|
||||
Shift amount to get the base indicator register
|
||||
.IP "NVME_CMBLOC_CQMMS_SHIFT" 12
|
||||
Shift amount to get the CMB queue mixed memory support
|
||||
.IP "NVME_CMBLOC_CQPDS_SHIFT" 12
|
||||
Shift amount to get the CMB queue physically discontiguous support
|
||||
.IP "NVME_CMBLOC_CDPLMS_SHIFT" 12
|
||||
Shift amount to get the CMB data pointer mixed locations support
|
||||
.IP "NVME_CMBLOC_CDPCILS_SHIFT" 12
|
||||
Shift amount to get the CMB data pointer and command independent locations support
|
||||
.IP "NVME_CMBLOC_CDMMMS_SHIFT" 12
|
||||
Shift amount to get the CMB data metadata mixed memory support
|
||||
.IP "NVME_CMBLOC_CQDA_SHIFT" 12
|
||||
Shift amount to get the CMB queue dword alignment
|
||||
.IP "NVME_CMBLOC_OFST_SHIFT" 12
|
||||
Shift amount to get the offset
|
||||
.IP "NVME_CMBLOC_BIR_MASK" 12
|
||||
Mask to get the base indicator register
|
||||
.IP "NVME_CMBLOC_CQMMS_MASK" 12
|
||||
Mask to get the CMB queue mixed memory support
|
||||
.IP "NVME_CMBLOC_CQPDS_MASK" 12
|
||||
Mask to get the CMB queue physically discontiguous support
|
||||
.IP "NVME_CMBLOC_CDPLMS_MASK" 12
|
||||
Mask to get the CMB data pointer mixed locations support
|
||||
.IP "NVME_CMBLOC_CDPCILS_MASK" 12
|
||||
Mask to get the CMB data pointer and command independent locations support
|
||||
.IP "NVME_CMBLOC_CDMMMS_MASK" 12
|
||||
Mask to get the CMB data metadata mixed memory support
|
||||
.IP "NVME_CMBLOC_CQDA_MASK" 12
|
||||
Mask to get the CMB queue dword alignment
|
||||
.IP "NVME_CMBLOC_OFST_MASK" 12
|
||||
Mask to get the offset
|
36
doc/man/nvme_cmbmsc.2
Normal file
36
doc/man/nvme_cmbmsc.2
Normal file
|
@ -0,0 +1,36 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmbmsc" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmbmsc \- This field indicates the controller memory buffer memory space control
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmbmsc {
|
||||
.br
|
||||
.BI " NVME_CMBMSC_CRE_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBMSC_CMSE_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBMSC_CBA_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBMSC_CRE_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBMSC_CMSE_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMBMSC_CRE_SHIFT" 12
|
||||
Shift amount to get the capabilities registers enabled
|
||||
.IP "NVME_CMBMSC_CMSE_SHIFT" 12
|
||||
Shift amount to get the controller memory space enable
|
||||
.IP "NVME_CMBMSC_CBA_SHIFT" 12
|
||||
Shift amount to get the controller base address
|
||||
.IP "NVME_CMBMSC_CRE_MASK" 12
|
||||
Mask to get the capabilities registers enabled
|
||||
.IP "NVME_CMBMSC_CMSE_MASK" 12
|
||||
Mask to get the controller memory space enable
|
18
doc/man/nvme_cmbsts.2
Normal file
18
doc/man/nvme_cmbsts.2
Normal file
|
@ -0,0 +1,18 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmbsts" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmbsts \- This field indicates the controller memory buffer status
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmbsts {
|
||||
.br
|
||||
.BI " NVME_CMBSTS_CBAI_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSTS_CBAI_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMBSTS_CBAI_SHIFT" 12
|
||||
Shift amount to get the controller base address invalid
|
||||
.IP "NVME_CMBSTS_CBAI_MASK" 12
|
||||
Mask to get the controller base address invalid
|
54
doc/man/nvme_cmbswtp.2
Normal file
54
doc/man/nvme_cmbswtp.2
Normal file
|
@ -0,0 +1,54 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmbswtp" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmbswtp \- This field indicates the controller memory buffer sustained write throughput
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmbswtp {
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTU_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTV_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTU_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTV_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTU_B"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTU_1K"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTU_1M"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSWTP_CMBSWTU_1G"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMBSWTP_CMBSWTU_SHIFT" 12
|
||||
Shift amount to get the CMB sustained write throughput units
|
||||
.IP "NVME_CMBSWTP_CMBSWTV_SHIFT" 12
|
||||
Shift amount to get the CMB sustained write throughput
|
||||
.IP "NVME_CMBSWTP_CMBSWTU_MASK" 12
|
||||
Mask to get the CMB sustained write throughput units
|
||||
.IP "NVME_CMBSWTP_CMBSWTV_MASK" 12
|
||||
Mask to get the CMB sustained write throughput
|
||||
.IP "NVME_CMBSWTP_CMBSWTU_B" 12
|
||||
Bytes/second granularity
|
||||
.IP "NVME_CMBSWTP_CMBSWTU_1K" 12
|
||||
1 KiB/second granularity
|
||||
.IP "NVME_CMBSWTP_CMBSWTU_1M" 12
|
||||
1 MiB/second granularity
|
||||
.IP "NVME_CMBSWTP_CMBSWTU_1G" 12
|
||||
1 GiB/second granularity
|
132
doc/man/nvme_cmbsz.2
Normal file
132
doc/man/nvme_cmbsz.2
Normal file
|
@ -0,0 +1,132 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmbsz" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmbsz \- This field indicates the controller memory buffer size
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmbsz {
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SQS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_CQS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_LISTS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_RDS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_WDS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZ_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SQS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_CQS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_LISTS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_RDS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_WDS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZ_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_4K"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_64K"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_1M"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_16M"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_256M"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_4G"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMBSZ_SZU_64G"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMBSZ_SQS_SHIFT" 12
|
||||
Shift amount to get the submission queue support
|
||||
.IP "NVME_CMBSZ_CQS_SHIFT" 12
|
||||
Shift amount to get the completion queue support
|
||||
.IP "NVME_CMBSZ_LISTS_SHIFT" 12
|
||||
Shift amount to get the PLP SGL list support
|
||||
.IP "NVME_CMBSZ_RDS_SHIFT" 12
|
||||
Shift amount to get the read data support
|
||||
.IP "NVME_CMBSZ_WDS_SHIFT" 12
|
||||
Shift amount to get the write data support
|
||||
.IP "NVME_CMBSZ_SZU_SHIFT" 12
|
||||
Shift amount to get the size units
|
||||
.IP "NVME_CMBSZ_SZ_SHIFT" 12
|
||||
Shift amount to get the size
|
||||
.IP "NVME_CMBSZ_SQS_MASK" 12
|
||||
Mask to get the submission queue support
|
||||
.IP "NVME_CMBSZ_CQS_MASK" 12
|
||||
Mask to get the completion queue support
|
||||
.IP "NVME_CMBSZ_LISTS_MASK" 12
|
||||
Mask to get the PLP SGL list support
|
||||
.IP "NVME_CMBSZ_RDS_MASK" 12
|
||||
Mask to get the read data support
|
||||
.IP "NVME_CMBSZ_WDS_MASK" 12
|
||||
Mask to get the write data support
|
||||
.IP "NVME_CMBSZ_SZU_MASK" 12
|
||||
Mask to get the size units
|
||||
.IP "NVME_CMBSZ_SZ_MASK" 12
|
||||
Mask to get the size
|
||||
.IP "NVME_CMBSZ_SZU_4K" 12
|
||||
4 KiB
|
||||
.IP "NVME_CMBSZ_SZU_64K" 12
|
||||
64 KiB
|
||||
.IP "NVME_CMBSZ_SZU_1M" 12
|
||||
1 MiB
|
||||
.IP "NVME_CMBSZ_SZU_16M" 12
|
||||
16 MiB
|
||||
.IP "NVME_CMBSZ_SZU_256M" 12
|
||||
256 MiB
|
||||
.IP "NVME_CMBSZ_SZU_4G" 12
|
||||
4 GiB
|
||||
.IP "NVME_CMBSZ_SZU_64G" 12
|
||||
64 GiB
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_effects" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_effects" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
|
||||
.SH SYNOPSIS
|
||||
|
@ -84,6 +84,10 @@ enum nvme_cmd_get_log_lid {
|
|||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_LOG_LID_CMD_AND_FEAT_LOCKDOWN"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_LOG_LID_BOOT_PARTITION"
|
||||
,
|
||||
.br
|
||||
|
@ -164,6 +168,8 @@ Supported Capacity Configuration Lis
|
|||
Feature Identifiers Supported and Effects
|
||||
.IP "NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS" 12
|
||||
NVMe-MI Commands Supported and Effects
|
||||
.IP "NVME_LOG_LID_CMD_AND_FEAT_LOCKDOWN" 12
|
||||
Command and Feature Lockdown
|
||||
.IP "NVME_LOG_LID_BOOT_PARTITION" 12
|
||||
Boot Partition
|
||||
.IP "NVME_LOG_LID_PHY_RX_EOM" 12
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
|
||||
.SH SYNOPSIS
|
||||
|
|
66
doc/man/nvme_cmic.2
Normal file
66
doc/man/nvme_cmic.2
Normal file
|
@ -0,0 +1,66 @@
|
|||
.TH "libnvme" 9 "enum nvme_cmic" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_cmic \- This field indicates the controller multi-path I/O and NS sharing capabilities
|
||||
.SH SYNOPSIS
|
||||
enum nvme_cmic {
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_PORT_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_CTRL_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_SRIOV_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_ANA_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_RSVD_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_PORT_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_CTRL_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_SRIOV_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_ANA_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CMIC_MULTI_RSVD_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CMIC_MULTI_PORT_SHIFT" 12
|
||||
Shift amount to get the NVM subsystem port
|
||||
.IP "NVME_CMIC_MULTI_CTRL_SHIFT" 12
|
||||
Shift amount to get the controllers
|
||||
.IP "NVME_CMIC_MULTI_SRIOV_SHIFT" 12
|
||||
Shift amount to get the SR-IOV virtual function
|
||||
.IP "NVME_CMIC_MULTI_ANA_SHIFT" 12
|
||||
Shift amount to get the asymmetric namespace access reporting
|
||||
.IP "NVME_CMIC_MULTI_RSVD_SHIFT" 12
|
||||
Shift amount to get the reserved
|
||||
.IP "NVME_CMIC_MULTI_PORT_MASK" 12
|
||||
Mask to get the NVM subsystem port
|
||||
.IP "NVME_CMIC_MULTI_CTRL_MASK" 12
|
||||
Mask to get the controllers
|
||||
.IP "NVME_CMIC_MULTI_SRIOV_MASK" 12
|
||||
Mask to get the SR-IOV virtual function
|
||||
.IP "NVME_CMIC_MULTI_ANA_MASK" 12
|
||||
Mask to get the asymmetric namespace access reporting
|
||||
.IP "NVME_CMIC_MULTI_RSVD_MASK" 12
|
||||
Mask to get the reserved
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_compare" 9 "nvme_compare" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_compare" 9 "nvme_compare" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_connect_err" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_constants" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_copy" 9 "nvme_copy" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_copy \- Copy command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_copy_range" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range" "May 2024" "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" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range_f1" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_copy_range_f1 \- Copy - Source Range Entries Descriptor Format 1h
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_copy_range_f2" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range_f2" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_copy_range_f2 \- Copy - Source Range Entries Descriptor Format 2h
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "struct nvme_copy_range_f3" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "struct nvme_copy_range_f3" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
struct nvme_copy_range_f3 \- Copy - Source Range Entries Descriptor Format 3h
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_copy_range_sopt" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_copy_range_sopt" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_copy_range_sopt \- NVMe Copy Range Source Options
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_create_root" 9 "nvme_create_root" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_create_root \- Initialize root object
|
||||
.SH SYNOPSIS
|
||||
|
|
30
doc/man/nvme_crto.2
Normal file
30
doc/man/nvme_crto.2
Normal file
|
@ -0,0 +1,30 @@
|
|||
.TH "libnvme" 9 "enum nvme_crto" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_crto \- This field indicates the controller ready timeouts
|
||||
.SH SYNOPSIS
|
||||
enum nvme_crto {
|
||||
.br
|
||||
.BI " NVME_CRTO_CRWMT_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CRTO_CRIMT_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CRTO_CRWMT_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CRTO_CRIMT_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CRTO_CRWMT_SHIFT" 12
|
||||
Shift amount to get the controller ready with media timeout
|
||||
.IP "NVME_CRTO_CRIMT_SHIFT" 12
|
||||
Shift amount to get the controller ready independent of media timeout
|
||||
.IP "NVME_CRTO_CRWMT_MASK" 12
|
||||
Mask to get the controller ready with media timeout
|
||||
.IP "NVME_CRTO_CRIMT_MASK" 12
|
||||
Mask to get the controller ready independent of media timeout
|
|
@ -1,4 +1,4 @@
|
|||
.TH "libnvme" 9 "enum nvme_csi" "February 2024" "API Manual" LINUX
|
||||
.TH "libnvme" 9 "enum nvme_csi" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_csi \- Defined command set indicators
|
||||
.SH SYNOPSIS
|
||||
|
|
102
doc/man/nvme_csts.2
Normal file
102
doc/man/nvme_csts.2
Normal file
|
@ -0,0 +1,102 @@
|
|||
.TH "libnvme" 9 "enum nvme_csts" "May 2024" "API Manual" LINUX
|
||||
.SH NAME
|
||||
enum nvme_csts \- This field indicates the controller status register
|
||||
.SH SYNOPSIS
|
||||
enum nvme_csts {
|
||||
.br
|
||||
.BI " NVME_CSTS_RDY_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_CFS_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_SHST_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_NSSRO_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_PP_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_ST_SHIFT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_RDY_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_CFS_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_SHST_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_NSSRO_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_PP_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_ST_MASK"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_SHST_NORMAL"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_SHST_OCCUR"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_SHST_CMPLT"
|
||||
,
|
||||
.br
|
||||
.br
|
||||
.BI " NVME_CSTS_SHN_MASK"
|
||||
|
||||
};
|
||||
.SH Constants
|
||||
.IP "NVME_CSTS_RDY_SHIFT" 12
|
||||
Shift amount to get the ready
|
||||
.IP "NVME_CSTS_CFS_SHIFT" 12
|
||||
Shift amount to get the controller fatal status
|
||||
.IP "NVME_CSTS_SHST_SHIFT" 12
|
||||
Shift amount to get the shutdown status
|
||||
.IP "NVME_CSTS_NSSRO_SHIFT" 12
|
||||
Shift amount to get the NVM subsystem reset occurred
|
||||
.IP "NVME_CSTS_PP_SHIFT" 12
|
||||
Shift amount to get the processing paused
|
||||
.IP "NVME_CSTS_ST_SHIFT" 12
|
||||
Shift amount to get the shutdown type
|
||||
.IP "NVME_CSTS_RDY_MASK" 12
|
||||
Mask to get the ready
|
||||
.IP "NVME_CSTS_CFS_MASK" 12
|
||||
Mask to get the controller fatal status
|
||||
.IP "NVME_CSTS_SHST_MASK" 12
|
||||
Mask to get the shutdown status
|
||||
.IP "NVME_CSTS_NSSRO_MASK" 12
|
||||
Mask to get the NVM subsystem reset occurred
|
||||
.IP "NVME_CSTS_PP_MASK" 12
|
||||
Mask to get the processing paused
|
||||
.IP "NVME_CSTS_ST_MASK" 12
|
||||
Mask to get the shutdown type
|
||||
.IP "NVME_CSTS_SHST_NORMAL" 12
|
||||
Normal operation
|
||||
.IP "NVME_CSTS_SHST_OCCUR" 12
|
||||
Shutdown processing occurring
|
||||
.IP "NVME_CSTS_SHST_CMPLT" 12
|
||||
Shutdown processing complete
|
||||
.IP "NVME_CSTS_SHN_MASK" 12
|
||||
Deprecated mask to get the shutdown status
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_config_match \- Check if ctrl @c matches config params
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_find \- Locate an existing controller
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "May 2024" "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" "February 2024" "libnvme API manual" LINUX
|
||||
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "May 2024" "libnvme API manual" LINUX
|
||||
.SH NAME
|
||||
nvme_ctrl_for_each_ns_safe \- Traverse namespaces
|
||||
.SH SYNOPSIS
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue