nvme/libnvme
1
0
Fork 0
Code Issues Activity

Merging upstream version 1.11.1.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 10:51:37 +01:00
parent 2a5a900abc
commit bd2208f611
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
915 changed files with 1370 additions and 1396 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/rst/fabrics.rst
View file

@ -7,7 +7,7 @@ Fabrics-specific definitions.
.. c:struct:: nvme_fabrics_config
.. c:type:: struct nvme_fabrics_config
Defines all linux nvme fabrics initiator options
@ -104,7 +104,7 @@ Fabrics-specific definitions.
.. c:struct:: nvme_fabrics_uri
.. c:type:: struct nvme_fabrics_uri
Parsed URI structure
@ -430,7 +430,7 @@ Consider using nvmf_get_discovery_wargs() instead.
.. c:struct:: nvme_get_discovery_args
.. c:type:: struct nvme_get_discovery_args
Arguments for nvmf_get_discovery_wargs()

10
doc/rst/ioctl.rst
View file

@ -7,7 +7,7 @@ Linux NVMe ioctl interface functions
.. c:struct:: nvme_passthru_cmd
.. c:type:: struct nvme_passthru_cmd
nvme passthrough command structure
@ -96,7 +96,7 @@ Linux NVMe ioctl interface functions
.. c:struct:: nvme_passthru_cmd64
.. c:type:: struct nvme_passthru_cmd64
64-bit nvme passthrough command structure
@ -189,7 +189,7 @@ Linux NVMe ioctl interface functions
.. c:struct:: nvme_uring_cmd
.. c:type:: struct nvme_uring_cmd
nvme uring command structure
@ -276,9 +276,7 @@ Linux NVMe ioctl interface functions
.. c:macro:: sizeof_args
``sizeof_args (type, member, align)``
.. c:function:: sizeof_args (type, member, align)
Helper function used to determine structure sizes

6
doc/rst/linux.rst
View file

@ -34,7 +34,7 @@ The nvme command status if a response was received (see
.. c:enum:: nvme_telemetry_da
.. c:type:: enum nvme_telemetry_da
Telemetry Log Data Area
@ -352,7 +352,7 @@ errno set otherwise.
.. c:enum:: nvme_hmac_alg
.. c:type:: enum nvme_hmac_alg
HMAC algorithm
@ -541,7 +541,7 @@ inaccessible.
Key id of the new key or 0 with errno set otherwise.
.. c:macro:: nvme_scan_tls_keys_cb_t
.. c:type:: nvme_scan_tls_keys_cb_t
**Typedef**: Callback for iterating TLS keys

54
doc/rst/mi.rst
View file

@ -73,9 +73,7 @@ are:
with a couple of accommodations for older spec types, particularly NVMe-MI
1.1, where possible.
.. c:macro:: NVME_MI_MSGTYPE_NVME
``NVME_MI_MSGTYPE_NVME ()``
.. c:function:: NVME_MI_MSGTYPE_NVME ()
MCTP message type for NVMe-MI messages.
@ -91,7 +89,7 @@ bit (0x80) set.
.. c:enum:: nvme_mi_message_type
.. c:type:: enum nvme_mi_message_type
NVMe-MI message type field.
@ -117,7 +115,7 @@ byte). Not to be confused with the MCTP message type in byte 0.
.. c:enum:: nvme_mi_ror
.. c:type:: enum nvme_mi_ror
Request or response field.
@ -132,7 +130,7 @@ byte). Not to be confused with the MCTP message type in byte 0.
.. c:enum:: nvme_mi_resp_status
.. c:type:: enum nvme_mi_resp_status
values for the response status field
@ -198,7 +196,7 @@ byte). Not to be confused with the MCTP message type in byte 0.
.. c:struct:: nvme_mi_msg_hdr
.. c:type:: struct nvme_mi_msg_hdr
General MI message header.
@ -236,7 +234,7 @@ section 3.1. This is used for all message types, MI and Admin.
.. c:struct:: nvme_mi_msg_resp
.. c:type:: struct nvme_mi_msg_resp
Generic response type.
@ -270,7 +268,7 @@ will define parts of the reserved data, and may add further fields.
.. c:enum:: nvme_mi_mi_opcode
.. c:type:: enum nvme_mi_mi_opcode
Operation code for supported NVMe-MI commands.
@ -291,7 +289,7 @@ will define parts of the reserved data, and may add further fields.
.. c:struct:: nvme_mi_mi_req_hdr
.. c:type:: struct nvme_mi_mi_req_hdr
MI request message header.
@ -331,7 +329,7 @@ Wire format for MI request message headers, defined in section 5 of NVMe-MI.
.. c:struct:: nvme_mi_mi_resp_hdr
.. c:type:: struct nvme_mi_mi_resp_hdr
MI response message header.
@ -364,7 +362,7 @@ Wire format for MI response message header, defined in section 5 of NVMe-MI.
.. c:enum:: nvme_mi_dtyp
.. c:type:: enum nvme_mi_dtyp
Data Structure Type field.
@ -396,7 +394,7 @@ indicate the particular structure to query from the endpoint.
.. c:enum:: nvme_mi_config_id
.. c:type:: enum nvme_mi_config_id
NVMe-MI Configuration identifier.
@ -423,7 +421,7 @@ See :c:type:`nvme_mi_mi_config_get`() and :c:type:`nvme_mi_config_set`().
.. c:enum:: nvme_mi_config_smbus_freq
.. c:type:: enum nvme_mi_config_smbus_freq
SMBus/I2C frequency values
@ -446,7 +444,7 @@ Values used in the SMBus Frequency device configuration. See
.. c:struct:: nvme_mi_admin_req_hdr
.. c:type:: struct nvme_mi_admin_req_hdr
Admin command request header.
@ -536,7 +534,7 @@ NVMe-MI.
.. c:struct:: nvme_mi_admin_resp_hdr
.. c:type:: struct nvme_mi_admin_resp_hdr
Admin command response header.
@ -580,7 +578,7 @@ queue data, plus optional response data.
.. c:enum:: nvme_mi_control_opcode
.. c:type:: enum nvme_mi_control_opcode
Operation code for Control Primitives.
@ -604,7 +602,7 @@ queue data, plus optional response data.
.. c:struct:: nvme_mi_control_req
.. c:type:: struct nvme_mi_control_req
The Control Primitive request.
@ -713,7 +711,7 @@ endpoint to determine model-specific details.
.. c:type:: nvme_mi_ep_t
.. c:type:: typedef nvme_mi_ep_t
MI Endpoint object.
@ -772,9 +770,7 @@ next endpoint MI endpoint object after **e** under this root, or NULL
See: :c:type:`nvme_mi_first_endpoint`, :c:type:`nvme_mi_for_each_endpoint`
.. c:macro:: nvme_mi_for_each_endpoint
``nvme_mi_for_each_endpoint (m, e)``
.. c:function:: nvme_mi_for_each_endpoint (m, e)
Iterator for NVMe-MI endpoints.
@ -787,9 +783,7 @@ See: :c:type:`nvme_mi_first_endpoint`, :c:type:`nvme_mi_for_each_endpoint`
:c:type:`nvme_mi_ep_t` object, set on each iteration
.. c:macro:: nvme_mi_for_each_endpoint_safe
``nvme_mi_for_each_endpoint_safe (m, e, _e)``
.. c:function:: nvme_mi_for_each_endpoint_safe (m, e, _e)
Iterator for NVMe-MI endpoints, allowing deletion during traversal
@ -859,7 +853,7 @@ Returns the current timeout value, in milliseconds, for this endpoint.
.. c:type:: nvme_mi_ctrl_t
.. c:type:: typedef nvme_mi_ctrl_t
NVMe-MI Controller object.
@ -910,9 +904,7 @@ next MI controller object after **c** under this endpoint, or NULL
See: :c:type:`nvme_mi_first_ctrl`, :c:type:`nvme_mi_for_each_ctrl`
.. c:macro:: nvme_mi_for_each_ctrl
``nvme_mi_for_each_ctrl (ep, c)``
.. c:function:: nvme_mi_for_each_ctrl (ep, c)
Iterator for NVMe-MI controllers.
@ -933,9 +925,7 @@ call :c:type:`nvme_mi_scan_ep`() to scan for the controllers first.
See: :c:type:`nvme_mi_scan_ep`()
.. c:macro:: nvme_mi_for_each_ctrl_safe
``nvme_mi_for_each_ctrl_safe (ep, c, _c)``
.. c:function:: nvme_mi_for_each_ctrl_safe (ep, c, _c)
Iterator for NVMe-MI controllers, allowing deletion during traversal

62
doc/rst/nbft.rst
View file

@ -9,7 +9,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_desc_type
.. c:type:: enum nbft_desc_type
NBFT Elements - Descriptor Types (Figure 5)
@ -56,7 +56,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_trtype
.. c:type:: enum nbft_trtype
NBFT Interface Transport Types (Figure 7)
@ -68,7 +68,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_heap_obj
.. c:type:: struct nbft_heap_obj
NBFT Header Driver Signature
@ -94,7 +94,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_header
.. c:type:: struct nbft_header
NBFT Table - Header (Figure 8)
@ -193,7 +193,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_control
.. c:type:: struct nbft_control
NBFT Table - Control Descriptor (Figure 8)
@ -368,7 +368,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_control_flags
.. c:type:: enum nbft_control_flags
Control Descriptor Flags
@ -380,7 +380,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_host
.. c:type:: struct nbft_host
Host Descriptor (Figure 9)
@ -422,7 +422,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_host_flags
.. c:type:: enum nbft_host_flags
Host Flags
@ -479,7 +479,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_hfi
.. c:type:: struct nbft_hfi
Host Fabric Interface (HFI) Descriptor (Figure 11)
@ -529,7 +529,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_hfi_flags
.. c:type:: enum nbft_hfi_flags
HFI Descriptor Flags
@ -542,7 +542,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_hfi_info_tcp
.. c:type:: struct nbft_hfi_info_tcp
HFI Transport Info Descriptor - NVMe/TCP (Figure 13)
@ -685,7 +685,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_hfi_info_tcp_flags
.. c:type:: enum nbft_hfi_info_tcp_flags
HFI Transport Flags
@ -714,7 +714,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_ssns
.. c:type:: struct nbft_ssns
Subsystem Namespace (SSNS) Descriptor (Figure 15)
@ -879,7 +879,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_ssns_flags
.. c:type:: enum nbft_ssns_flags
Subsystem and Namespace Specific Flags Field (Figure 16)
@ -970,7 +970,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_ssns_trflags
.. c:type:: enum nbft_ssns_trflags
SSNS Transport Specific Flags Field (Figure 17)
@ -1008,7 +1008,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_ssns_ext_info
.. c:type:: struct nbft_ssns_ext_info
Subsystem and Namespace Extended Information Descriptor (Figure 19)
@ -1069,7 +1069,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_ssns_ext_info_flags
.. c:type:: enum nbft_ssns_ext_info_flags
Subsystem and Namespace Extended Information Descriptor Flags
@ -1091,7 +1091,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_security
.. c:type:: struct nbft_security
Security Profile Descriptor (Figure 21)
@ -1195,7 +1195,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_security_flags
.. c:type:: enum nbft_security_flags
Security Profile Descriptor Flags (Figure 22)
@ -1317,7 +1317,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_security_secret_type
.. c:type:: enum nbft_security_secret_type
Security Profile Descriptor Secret Type
@ -1333,7 +1333,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_discovery
.. c:type:: struct nbft_discovery
Discovery Descriptor (Figure 24)
@ -1410,7 +1410,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_discovery_flags
.. c:type:: enum nbft_discovery_flags
Discovery Descriptor Flags
@ -1424,7 +1424,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_info_primary_admin_host_flag
.. c:type:: enum nbft_info_primary_admin_host_flag
Primary Administrative Host Descriptor Flags
@ -1454,7 +1454,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info_host
.. c:type:: struct nbft_info_host
Host Descriptor
@ -1496,7 +1496,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info_hfi_info_tcp
.. c:type:: struct nbft_info_hfi_info_tcp
HFI Transport Info Descriptor - NVMe/TCP
@ -1585,7 +1585,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info_hfi
.. c:type:: struct nbft_info_hfi
Host Fabric Interface (HFI) Descriptor
@ -1615,7 +1615,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info_discovery
.. c:type:: struct nbft_info_discovery
Discovery Descriptor
@ -1655,7 +1655,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info_security
.. c:type:: struct nbft_info_security
Security Profile Descriptor
@ -1677,7 +1677,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:enum:: nbft_info_nid_type
.. c:type:: enum nbft_info_nid_type
Namespace Identifier Type (NIDT)
@ -1698,7 +1698,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info_subsystem_ns
.. c:type:: struct nbft_info_subsystem_ns
Subsystem Namespace (SSNS) info
@ -1808,7 +1808,7 @@ Note: this API is currently unstable, subject to further additions.
.. c:struct:: nbft_info
.. c:type:: struct nbft_info
The parsed NBFT table data.

56
doc/rst/tree.rst
View file

@ -694,9 +694,7 @@ First :c:type:`nvme_ns_t` object of an **s** iterator
Next :c:type:`nvme_ns_t` object of an **s** iterator
.. c:macro:: nvme_for_each_host_safe
``nvme_for_each_host_safe (r, h, _h)``
.. c:function:: nvme_for_each_host_safe (r, h, _h)
Traverse host list
@ -712,9 +710,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
Temporary :c:type:`nvme_host_t` object
.. c:macro:: nvme_for_each_host
``nvme_for_each_host (r, h)``
.. c:function:: nvme_for_each_host (r, h)
Traverse host list
@ -727,9 +723,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
:c:type:`nvme_host_t` object
.. c:macro:: nvme_for_each_subsystem_safe
``nvme_for_each_subsystem_safe (h, s, _s)``
.. c:function:: nvme_for_each_subsystem_safe (h, s, _s)
Traverse subsystems
@ -745,9 +739,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
Temporary :c:type:`nvme_subsystem_t` object
.. c:macro:: nvme_for_each_subsystem
``nvme_for_each_subsystem (h, s)``
.. c:function:: nvme_for_each_subsystem (h, s)
Traverse subsystems
@ -760,9 +752,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
:c:type:`nvme_subsystem_t` object
.. c:macro:: nvme_subsystem_for_each_ctrl_safe
``nvme_subsystem_for_each_ctrl_safe (s, c, _c)``
.. c:function:: nvme_subsystem_for_each_ctrl_safe (s, c, _c)
Traverse controllers
@ -778,9 +768,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
A :c:type:`nvme_ctrl_t_node` to use as temporary storage
.. c:macro:: nvme_subsystem_for_each_ctrl
``nvme_subsystem_for_each_ctrl (s, c)``
.. c:function:: nvme_subsystem_for_each_ctrl (s, c)
Traverse controllers
@ -793,9 +781,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
Controller instance
.. c:macro:: nvme_ctrl_for_each_ns_safe
``nvme_ctrl_for_each_ns_safe (c, n, _n)``
.. c:function:: nvme_ctrl_for_each_ns_safe (c, n, _n)
Traverse namespaces
@ -811,9 +797,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
A :c:type:`nvme_ns_t_node` to use as temporary storage
.. c:macro:: nvme_ctrl_for_each_ns
``nvme_ctrl_for_each_ns (c, n)``
.. c:function:: nvme_ctrl_for_each_ns (c, n)
Traverse namespaces
@ -826,9 +810,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
:c:type:`nvme_ns_t` object
.. c:macro:: nvme_ctrl_for_each_path_safe
``nvme_ctrl_for_each_path_safe (c, p, _p)``
.. c:function:: nvme_ctrl_for_each_path_safe (c, p, _p)
Traverse paths
@ -844,9 +826,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
A :c:type:`nvme_path_t_node` to use as temporary storage
.. c:macro:: nvme_ctrl_for_each_path
``nvme_ctrl_for_each_path (c, p)``
.. c:function:: nvme_ctrl_for_each_path (c, p)
Traverse paths
@ -859,9 +839,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
:c:type:`nvme_path_t` object
.. c:macro:: nvme_subsystem_for_each_ns_safe
``nvme_subsystem_for_each_ns_safe (s, n, _n)``
.. c:function:: nvme_subsystem_for_each_ns_safe (s, n, _n)
Traverse namespaces
@ -877,9 +855,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
A :c:type:`nvme_ns_t_node` to use as temporary storage
.. c:macro:: nvme_subsystem_for_each_ns
``nvme_subsystem_for_each_ns (s, n)``
.. c:function:: nvme_subsystem_for_each_ns (s, n)
Traverse namespaces
@ -892,9 +868,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
:c:type:`nvme_ns_t` object
.. c:macro:: nvme_namespace_for_each_path_safe
``nvme_namespace_for_each_path_safe (n, p, _p)``
.. c:function:: nvme_namespace_for_each_path_safe (n, p, _p)
Traverse paths
@ -910,9 +884,7 @@ Next :c:type:`nvme_ns_t` object of an **s** iterator
A :c:type:`nvme_path_t_node` to use as temporary storage
.. c:macro:: nvme_namespace_for_each_path
``nvme_namespace_for_each_path (n, p)``
.. c:function:: nvme_namespace_for_each_path (n, p)
Traverse paths

687
doc/rst/types.rst
View file

File diff suppressed because it is too large Load diff

8
doc/rst/util.rst
View file

@ -7,7 +7,7 @@ libnvme utility functions
.. c:enum:: nvme_connect_err
.. c:type:: enum nvme_connect_err
nvme connect error codes
@ -487,9 +487,7 @@ If **s** starts with **prefix**, then return a pointer within **s** at
the first character after the matched **prefix**. NULL otherwise.
.. c:macro:: round_up
``round_up (val, mult)``
.. c:function:: round_up (val, mult)
Round a value **val** to the next multiple specified by **mult**.
@ -572,7 +570,7 @@ Pointer to the next element in the array.
.. c:enum:: nvme_version
.. c:type:: enum nvme_version
Selector for version to be returned by **nvme_get_version**