diff options
Diffstat (limited to 'doc/rst')
| -rw-r--r-- | doc/rst/fabrics.rst | 6 | ||||
| -rw-r--r-- | doc/rst/ioctl.rst | 10 | ||||
| -rw-r--r-- | doc/rst/linux.rst | 6 | ||||
| -rw-r--r-- | doc/rst/mi.rst | 54 | ||||
| -rw-r--r-- | doc/rst/nbft.rst | 62 | ||||
| -rw-r--r-- | doc/rst/tree.rst | 56 | ||||
| -rw-r--r-- | doc/rst/types.rst | 687 | ||||
| -rw-r--r-- | doc/rst/util.rst | 8 |
8 files changed, 421 insertions, 468 deletions
diff --git a/doc/rst/fabrics.rst b/doc/rst/fabrics.rst index 6c8831b..67ca051 100644 --- a/doc/rst/fabrics.rst +++ b/doc/rst/fabrics.rst @@ -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() diff --git a/doc/rst/ioctl.rst b/doc/rst/ioctl.rst index 015f05b..50123d4 100644 --- a/doc/rst/ioctl.rst +++ b/doc/rst/ioctl.rst @@ -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 diff --git a/doc/rst/linux.rst b/doc/rst/linux.rst index 2693373..f975a23 100644 --- a/doc/rst/linux.rst +++ b/doc/rst/linux.rst @@ -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 diff --git a/doc/rst/mi.rst b/doc/rst/mi.rst index e9d2e56..8dfaaf9 100644 --- a/doc/rst/mi.rst +++ b/doc/rst/mi.rst @@ -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 diff --git a/doc/rst/nbft.rst b/doc/rst/nbft.rst index 2a7b72f..984049b 100644 --- a/doc/rst/nbft.rst +++ b/doc/rst/nbft.rst @@ -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. diff --git a/doc/rst/tree.rst b/doc/rst/tree.rst index fd3b684..4cbc863 100644 --- a/doc/rst/tree.rst +++ b/doc/rst/tree.rst @@ -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 diff --git a/doc/rst/types.rst b/doc/rst/types.rst index 245afce..dd60493 100644 --- a/doc/rst/types.rst +++ b/doc/rst/types.rst @@ -5,9 +5,7 @@ NVMe standard definitions -.. c:macro:: NVME_GET - -``NVME_GET (value, name)`` +.. c:function:: NVME_GET (value, name) extract field from complex value @@ -30,9 +28,7 @@ sub-field. The 'name' field from 'value' -.. c:macro:: NVME_SET - -``NVME_SET (value, name)`` +.. c:function:: NVME_SET (value, name) set field into complex value @@ -49,9 +45,7 @@ The 'name' field from 'value' The 'name' field from 'value' -.. c:macro:: NVME_CHECK - -``NVME_CHECK (value, name, check)`` +.. c:function:: NVME_CHECK (value, name, check) check value to compare field value @@ -71,9 +65,7 @@ The 'name' field from 'value' The result of compare the value and the sub-field value -.. c:macro:: NVME_VAL - -``NVME_VAL (name)`` +.. c:function:: NVME_VAL (name) get mask value shifted @@ -89,7 +81,7 @@ The mask value shifted -.. c:enum:: nvme_constants +.. c:type:: enum nvme_constants A place to stash various constant nvme values @@ -204,7 +196,7 @@ The mask value shifted -.. c:enum:: nvme_csi +.. c:type:: enum nvme_csi Defined command set indicators @@ -222,7 +214,7 @@ The mask value shifted -.. c:enum:: nvme_register_offsets +.. c:type:: enum nvme_register_offsets controller registers for all transports. This is the layout of BAR0/1 for PCIe, and properties for fabrics. @@ -336,7 +328,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_cap +.. c:type:: enum nvme_cap This field indicates the controller capabilities register @@ -468,7 +460,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_vs +.. c:type:: enum nvme_vs This field indicates the version @@ -495,7 +487,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_cc +.. c:type:: enum nvme_cc This field indicates the controller configuration @@ -585,7 +577,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_csts +.. c:type:: enum nvme_csts This field indicates the controller status register @@ -642,7 +634,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_aqa +.. c:type:: enum nvme_aqa This field indicates the admin queue attributes @@ -663,7 +655,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_asq +.. c:type:: enum nvme_asq This field indicates the admin submission queue base address @@ -675,7 +667,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_acq +.. c:type:: enum nvme_acq This field indicates the admin completion queue base address @@ -687,7 +679,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_cmbloc +.. c:type:: enum nvme_cmbloc This field indicates the controller memory buffer location @@ -744,7 +736,7 @@ true if given offset is 64bit register, otherwise it returns false. -.. c:enum:: nvme_cmbsz +.. c:type:: enum nvme_cmbsz This field indicates the controller memory buffer size @@ -830,7 +822,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_bpinfo +.. c:type:: enum nvme_bpinfo This field indicates the boot partition information @@ -869,7 +861,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_bprsel +.. c:type:: enum nvme_bprsel This field indicates the boot partition read select @@ -896,7 +888,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_bpmbl +.. c:type:: enum nvme_bpmbl This field indicates the boot partition memory buffer location @@ -908,7 +900,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_cmbmsc +.. c:type:: enum nvme_cmbmsc This field indicates the controller memory buffer memory space control @@ -932,7 +924,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_cmbsts +.. c:type:: enum nvme_cmbsts This field indicates the controller memory buffer status @@ -947,7 +939,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_unit +.. c:type:: enum nvme_unit Defined buffer size and write throughput granularity units @@ -968,7 +960,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_cmbebs +.. c:type:: enum nvme_cmbebs This field indicates the controller memory buffer elasticity buffer size @@ -1007,7 +999,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_cmbswtp +.. c:type:: enum nvme_cmbswtp This field indicates the controller memory buffer sustained write throughput @@ -1040,7 +1032,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_crto +.. c:type:: enum nvme_crto This field indicates the controller ready timeouts @@ -1061,7 +1053,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_pmrcap +.. c:type:: enum nvme_pmrcap This field indicates the persistent memory region capabilities @@ -1124,7 +1116,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_pmrctl +.. c:type:: enum nvme_pmrctl This field indicates the persistent memory region control @@ -1139,7 +1131,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_pmrsts +.. c:type:: enum nvme_pmrsts This field indicates the persistent memory region status @@ -1172,7 +1164,7 @@ size of controller memory buffer in bytes -.. c:enum:: nvme_pmrebs +.. c:type:: enum nvme_pmrebs This field indicates the persistent memory region elasticity buffer size @@ -1225,7 +1217,7 @@ size of controller persistent memory buffer in bytes -.. c:enum:: nvme_pmrswtp +.. c:type:: enum nvme_pmrswtp This field indicates the persistent memory region sustained write throughput @@ -1272,7 +1264,7 @@ throughput of controller persistent memory buffer in bytes/second -.. c:enum:: nvme_pmrmsc +.. c:type:: enum nvme_pmrmsc This field indicates the persistent memory region memory space control @@ -1290,7 +1282,7 @@ throughput of controller persistent memory buffer in bytes/second -.. c:enum:: nvme_flbas +.. c:type:: enum nvme_flbas This field indicates the formatted LBA size @@ -1317,7 +1309,7 @@ throughput of controller persistent memory buffer in bytes/second -.. c:enum:: nvme_psd_flags +.. c:type:: enum nvme_psd_flags Possible flag values in nvme power state descriptor @@ -1340,7 +1332,7 @@ throughput of controller persistent memory buffer in bytes/second -.. c:enum:: nvme_psd_ps +.. c:type:: enum nvme_psd_ps Known values for :c:type:`struct nvme_psd <nvme_psd>` ``ips`` and ``aps``. Use with nvme_psd_power_scale() to extract the power scale field to match this enum. @@ -1372,7 +1364,7 @@ power scale value -.. c:enum:: nvme_psd_workload +.. c:type:: enum nvme_psd_workload Specifies a workload hint in the Power Management Feature (see :c:type:`struct nvme_psd <nvme_psd>`.apw) to inform the NVM subsystem or indicate the conditions for the active power level. @@ -1401,7 +1393,7 @@ power scale value -.. c:struct:: nvme_id_psd +.. c:type:: struct nvme_id_psd Power Management data structure @@ -1502,7 +1494,7 @@ power scale value -.. c:struct:: nvme_id_ctrl +.. c:type:: struct nvme_id_ctrl Identify Controller data structure @@ -2092,7 +2084,7 @@ power scale value -.. c:enum:: nvme_cmic +.. c:type:: enum nvme_cmic This field indicates the controller multi-path I/O and NS sharing capabilities @@ -2131,7 +2123,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_cmic +.. c:type:: enum nvme_id_ctrl_cmic Controller Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem. @@ -2165,7 +2157,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_oaes +.. c:type:: enum nvme_id_ctrl_oaes Optional Asynchronous Events Supported @@ -2291,7 +2283,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_ctratt +.. c:type:: enum nvme_id_ctrl_ctratt Controller attributes @@ -2353,13 +2345,16 @@ power scale value ``NVME_CTRL_CTRATT_HMBR`` HMB Restrict Non-Operational Power State Access +``NVME_CTRL_CTRATT_RHII`` + Reservations and Host Identifier Interaction + ``NVME_CTRL_CTRATT_FDPS`` Flexible Data Placement supported -.. c:enum:: nvme_id_ctrl_cntrltype +.. c:type:: enum nvme_id_ctrl_cntrltype Controller types @@ -2377,7 +2372,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_dctype +.. c:type:: enum nvme_id_ctrl_dctype Discovery Controller types @@ -2395,7 +2390,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_nvmsr +.. c:type:: enum nvme_id_ctrl_nvmsr This field reports information associated with the NVM Subsystem, see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.nvmsr. @@ -2414,7 +2409,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_vwci +.. c:type:: enum nvme_id_ctrl_vwci This field indicates information about remaining number of times that VPD contents are able to be updated using the VPD Write command, see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.vwci. @@ -2439,7 +2434,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_mec +.. c:type:: enum nvme_id_ctrl_mec Flags indicating the capabilities of the Management Endpoint in the Controller, :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.mec. @@ -2456,7 +2451,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_oacs +.. c:type:: enum nvme_id_ctrl_oacs Flags indicating the optional Admin commands and features supported by the controller, see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.oacs. @@ -2510,7 +2505,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_frmw +.. c:type:: enum nvme_id_ctrl_frmw Flags and values indicates capabilities regarding firmware updates from :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.frmw. @@ -2535,7 +2530,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_lpa +.. c:type:: enum nvme_id_ctrl_lpa Flags indicating optional attributes for log pages that are accessed via the Get Log Page command. @@ -2582,7 +2577,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_avscc +.. c:type:: enum nvme_id_ctrl_avscc Flags indicating the configuration settings for Admin Vendor Specific command handling. @@ -2596,7 +2591,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_apsta +.. c:type:: enum nvme_id_ctrl_apsta Flags indicating the attributes of the autonomous power state transition feature. @@ -2609,7 +2604,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_rpmbs +.. c:type:: enum nvme_id_ctrl_rpmbs This field indicates if the controller supports one or more Replay Protected Memory Blocks, from :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.rpmbs. @@ -2630,7 +2625,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_dsto +.. c:type:: enum nvme_id_ctrl_dsto Flags indicating the optional Device Self-test command or operation behaviors supported by the controller or NVM subsystem. @@ -2643,7 +2638,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_hctm +.. c:type:: enum nvme_id_ctrl_hctm Flags indicate the attributes of the host controlled thermal management feature @@ -2658,7 +2653,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_sanicap +.. c:type:: enum nvme_id_ctrl_sanicap Indicates attributes for sanitize operations. @@ -2690,7 +2685,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_anacap +.. c:type:: enum nvme_id_ctrl_anacap This field indicates the capabilities associated with Asymmetric Namespace Access Reporting. @@ -2731,7 +2726,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_sqes +.. c:type:: enum nvme_id_ctrl_sqes Defines the required and maximum Submission Queue entry size when using the NVM Command Set. @@ -2748,7 +2743,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_cqes +.. c:type:: enum nvme_id_ctrl_cqes Defines the required and maximum Completion Queue entry size when using the NVM Command Set. @@ -2765,7 +2760,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_oncs +.. c:type:: enum nvme_id_ctrl_oncs This field indicates the optional NVM commands and features supported by the controller. @@ -2825,7 +2820,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_fuses +.. c:type:: enum nvme_id_ctrl_fuses This field indicates the fused operations that the controller supports. @@ -2838,7 +2833,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_fna +.. c:type:: enum nvme_id_ctrl_fna This field indicates attributes for the Format NVM command. @@ -2901,7 +2896,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_vwc +.. c:type:: enum nvme_id_ctrl_vwc Volatile write cache @@ -2920,7 +2915,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_nvscc +.. c:type:: enum nvme_id_ctrl_nvscc This field indicates the configuration settings for NVM Vendor Specific command handling. @@ -2933,7 +2928,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_nwpc +.. c:type:: enum nvme_id_ctrl_nwpc This field indicates the optional namespace write protection capabilities supported by the controller. @@ -2962,7 +2957,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_sgls +.. c:type:: enum nvme_id_ctrl_sgls This field indicates if SGLs are supported for the NVM Command Set and the particular SGL types supported. @@ -2987,7 +2982,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_fcatt +.. c:type:: enum nvme_id_ctrl_fcatt This field indicates attributes of the controller that are specific to NVMe over Fabrics. @@ -3001,7 +2996,7 @@ power scale value -.. c:enum:: nvme_id_ctrl_ofcs +.. c:type:: enum nvme_id_ctrl_ofcs Indicate whether the controller supports optional fabric commands. @@ -3015,7 +3010,7 @@ power scale value -.. c:struct:: nvme_lbaf +.. c:type:: struct nvme_lbaf LBA Format Data Structure @@ -3046,7 +3041,7 @@ power scale value -.. c:enum:: nvme_lbaf_rp +.. c:type:: enum nvme_lbaf_rp This field indicates the relative performance of the LBA format indicated relative to other LBA formats supported by the controller. @@ -3071,7 +3066,7 @@ power scale value -.. c:struct:: nvme_id_ns +.. c:type:: struct nvme_id_ns Identify Namespace data structure @@ -3310,7 +3305,7 @@ power scale value -.. c:enum:: nvme_id_nsfeat +.. c:type:: enum nvme_id_nsfeat This field defines features of the namespace. @@ -3348,7 +3343,7 @@ power scale value -.. c:enum:: nvme_id_ns_flbas +.. c:type:: enum nvme_id_ns_flbas This field indicates the LBA data size & metadata size combination that the namespace has been formatted with @@ -3377,7 +3372,7 @@ power scale value -.. c:enum:: nvme_nvm_id_ns_elbaf +.. c:type:: enum nvme_nvm_id_ns_elbaf This field indicates the extended LBA format @@ -3398,7 +3393,7 @@ power scale value -.. c:enum:: nvme_nvm_id_ns_pif +.. c:type:: enum nvme_nvm_id_ns_pif This field indicates the type of the Protection Information Format @@ -3422,7 +3417,7 @@ power scale value -.. c:enum:: nvme_id_ns_mc +.. c:type:: enum nvme_id_ns_mc This field indicates the capabilities for metadata. @@ -3440,7 +3435,7 @@ power scale value -.. c:enum:: nvme_id_ns_dpc +.. c:type:: enum nvme_id_ns_dpc This field indicates the capabilities for the end-to-end data protection feature. @@ -3471,7 +3466,7 @@ power scale value -.. c:enum:: nvme_id_ns_dps +.. c:type:: enum nvme_id_ns_dps This field indicates the Type settings for the end-to-end data protection feature. @@ -3500,7 +3495,7 @@ power scale value -.. c:enum:: nvme_id_ns_nmic +.. c:type:: enum nvme_id_ns_nmic This field specifies multi-path I/O and namespace sharing capabilities of the namespace. @@ -3513,7 +3508,7 @@ power scale value -.. c:enum:: nvme_id_ns_rescap +.. c:type:: enum nvme_id_ns_rescap This field indicates the reservation capabilities of the namespace. @@ -3554,7 +3549,7 @@ power scale value -.. c:enum:: nvme_nd_ns_fpi +.. c:type:: enum nvme_nd_ns_fpi If a format operation is in progress, this field indicates the percentage of the namespace that remains to be formatted. @@ -3570,7 +3565,7 @@ power scale value -.. c:enum:: nvme_id_ns_dlfeat +.. c:type:: enum nvme_id_ns_dlfeat This field indicates information about features that affect deallocating logical blocks for this namespace. @@ -3605,7 +3600,7 @@ power scale value -.. c:enum:: nvme_id_ns_attr +.. c:type:: enum nvme_id_ns_attr Specifies attributes of the namespace. @@ -3619,7 +3614,7 @@ power scale value -.. c:struct:: nvme_ns_id_desc +.. c:type:: struct nvme_ns_id_desc Namespace identifier type descriptor @@ -3655,7 +3650,7 @@ power scale value -.. c:enum:: nvme_ns_id_desc_nidt +.. c:type:: enum nvme_ns_id_desc_nidt Known namespace identifier types @@ -3679,7 +3674,7 @@ power scale value -.. c:struct:: nvme_nvmset_attr +.. c:type:: struct nvme_nvmset_attr NVM Set Attributes Entry @@ -3731,7 +3726,7 @@ power scale value -.. c:struct:: nvme_id_nvmset_list +.. c:type:: struct nvme_id_nvmset_list NVM set list @@ -3760,7 +3755,7 @@ power scale value -.. c:struct:: nvme_id_independent_id_ns +.. c:type:: struct nvme_id_independent_id_ns Identify - I/O Command Set Independent Identify Namespace Data Structure @@ -3822,7 +3817,7 @@ power scale value -.. c:struct:: nvme_id_ns_granularity_desc +.. c:type:: struct nvme_id_ns_granularity_desc Namespace Granularity Descriptor @@ -3847,7 +3842,7 @@ power scale value -.. c:struct:: nvme_id_ns_granularity_list +.. c:type:: struct nvme_id_ns_granularity_list Namespace Granularity List @@ -3884,7 +3879,7 @@ power scale value -.. c:struct:: nvme_id_uuid_list_entry +.. c:type:: struct nvme_id_uuid_list_entry UUID List Entry @@ -3913,7 +3908,7 @@ power scale value -.. c:enum:: nvme_id_uuid +.. c:type:: enum nvme_id_uuid Identifier Association @@ -3930,7 +3925,7 @@ power scale value -.. c:struct:: nvme_id_uuid_list +.. c:type:: struct nvme_id_uuid_list UUID list @@ -3955,7 +3950,7 @@ power scale value -.. c:struct:: nvme_ctrl_list +.. c:type:: struct nvme_ctrl_list Controller List @@ -3980,7 +3975,7 @@ power scale value -.. c:struct:: nvme_ns_list +.. c:type:: struct nvme_ns_list Namespace List @@ -4001,7 +3996,7 @@ power scale value -.. c:struct:: nvme_id_ctrl_nvm +.. c:type:: struct nvme_id_ctrl_nvm I/O Command Set Specific Identify Controller data structure @@ -4062,7 +4057,7 @@ power scale value -.. c:struct:: nvme_nvm_id_ns +.. c:type:: struct nvme_nvm_id_ns NVME Command Set I/O Command Set Specific Identify Namespace Data Structure @@ -4131,7 +4126,7 @@ power scale value -.. c:struct:: nvme_zns_lbafe +.. c:type:: struct nvme_zns_lbafe LBA Format Extension Data Structure @@ -4160,7 +4155,7 @@ power scale value -.. c:struct:: nvme_zns_id_ns +.. c:type:: struct nvme_zns_id_ns Zoned Namespace Command Set Specific Identify Namespace Data Structure @@ -4253,7 +4248,7 @@ power scale value -.. c:struct:: nvme_zns_id_ctrl +.. c:type:: struct nvme_zns_id_ctrl I/O Command Set Specific Identify Controller Data Structure for the Zoned Namespace Command Set @@ -4278,7 +4273,7 @@ power scale value -.. c:struct:: nvme_primary_ctrl_cap +.. c:type:: struct nvme_primary_ctrl_cap Identify - Controller Capabilities Structure @@ -4367,7 +4362,7 @@ power scale value -.. c:struct:: nvme_secondary_ctrl +.. c:type:: struct nvme_secondary_ctrl Secondary Controller Entry @@ -4416,7 +4411,7 @@ power scale value -.. c:struct:: nvme_secondary_ctrl_list +.. c:type:: struct nvme_secondary_ctrl_list Secondary Controller List @@ -4445,7 +4440,7 @@ power scale value -.. c:struct:: nvme_id_iocs +.. c:type:: struct nvme_id_iocs NVMe Identify IO Command Set data structure @@ -4466,7 +4461,7 @@ power scale value -.. c:struct:: nvme_id_domain_attr +.. c:type:: struct nvme_id_domain_attr Domain Attributes Entry @@ -4507,7 +4502,7 @@ power scale value -.. c:struct:: nvme_id_domain_list +.. c:type:: struct nvme_id_domain_list Domain List @@ -4536,7 +4531,7 @@ power scale value -.. c:struct:: nvme_id_endurance_group_list +.. c:type:: struct nvme_id_endurance_group_list Endurance Group List @@ -4561,7 +4556,7 @@ power scale value -.. c:struct:: nvme_supported_log_pages +.. c:type:: struct nvme_supported_log_pages Supported Log Pages - Log @@ -4586,7 +4581,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_error_log_page +.. c:type:: struct nvme_error_log_page Error Information Log Entry (Log Identifier 01h) @@ -4713,7 +4708,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_smart_log +.. c:type:: struct nvme_smart_log SMART / Health Information Log (Log Identifier 02h) @@ -4954,7 +4949,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_smart_crit +.. c:type:: enum nvme_smart_crit Critical Warning @@ -4993,7 +4988,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_smart_egcw +.. c:type:: enum nvme_smart_egcw Endurance Group Critical Warning Summary @@ -5018,7 +5013,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_firmware_slot +.. c:type:: struct nvme_firmware_slot Firmware Slot Information Log @@ -5051,7 +5046,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_cmd_effects_log +.. c:type:: struct nvme_cmd_effects_log Commands Supported and Effects Log @@ -5080,7 +5075,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_cmd_effects +.. c:type:: enum nvme_cmd_effects Commands Supported and Effects @@ -5113,7 +5108,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_st_result +.. c:type:: struct nvme_st_result Self-test Result @@ -5196,7 +5191,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_status_result +.. c:type:: enum nvme_status_result Result of the device self-test operation @@ -5250,7 +5245,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_st_code +.. c:type:: enum nvme_st_code Self-test Code value @@ -5278,7 +5273,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_st_curr_op +.. c:type:: enum nvme_st_curr_op Current Device Self-Test Operation @@ -5310,7 +5305,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_st_valid_diag_info +.. c:type:: enum nvme_st_valid_diag_info Valid Diagnostic Information @@ -5335,7 +5330,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_self_test_log +.. c:type:: struct nvme_self_test_log Device Self-test (Log Identifier 06h) @@ -5384,7 +5379,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:enum:: nvme_cmd_get_log_telemetry_host_lsp +.. c:type:: enum nvme_cmd_get_log_telemetry_host_lsp Telemetry Host-Initiated log specific field @@ -5399,7 +5394,7 @@ Supported Log Pages (Log Identifier 00h) -.. c:struct:: nvme_telemetry_log +.. c:type:: struct nvme_telemetry_log Retrieve internal data specific to the manufacturer. @@ -5495,7 +5490,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_endurance_group_log +.. c:type:: struct nvme_endurance_group_log Endurance Group Information Log @@ -5588,7 +5583,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_eg_critical_warning_flags +.. c:type:: enum nvme_eg_critical_warning_flags Endurance Group Information Log - Critical Warning @@ -5608,7 +5603,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_aggregate_endurance_group_event +.. c:type:: struct nvme_aggregate_endurance_group_event Endurance Group Event Aggregate @@ -5633,7 +5628,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_nvmset_predictable_lat_log +.. c:type:: struct nvme_nvmset_predictable_lat_log Predictable Latency Mode - Deterministic Threshold Configuration Data @@ -5706,7 +5701,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_nvmeset_pl_status +.. c:type:: enum nvme_nvmeset_pl_status Predictable Latency Per NVM Set Log - Status @@ -5724,7 +5719,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_nvmset_pl_events +.. c:type:: enum nvme_nvmset_pl_events Predictable Latency Per NVM Set Log - Event Type @@ -5752,7 +5747,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_aggregate_predictable_lat_event +.. c:type:: struct nvme_aggregate_predictable_lat_event Predictable Latency Event Aggregate Log Page @@ -5777,7 +5772,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_ana_group_desc +.. c:type:: struct nvme_ana_group_desc ANA Group Descriptor @@ -5818,7 +5813,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ana_state +.. c:type:: enum nvme_ana_state ANA Group Descriptor - Asymmetric Namespace Access State @@ -5842,7 +5837,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_ana_log +.. c:type:: struct nvme_ana_log Asymmetric Namespace Access Log @@ -5875,7 +5870,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_persistent_event_log +.. c:type:: struct nvme_persistent_event_log Persistent Event Log @@ -5968,7 +5963,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_pel_rci +.. c:type:: enum nvme_pel_rci This field indicates the persistent event log reporting context @@ -6009,7 +6004,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_pel_rci_rcpit +.. c:type:: enum nvme_pel_rci_rcpit Persistent Event Log Reporting Context - Port Identifier Type @@ -6027,7 +6022,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_persistent_event_entry +.. c:type:: struct nvme_persistent_event_entry Persistent Event @@ -6084,7 +6079,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_persistent_event_types +.. c:type:: enum nvme_persistent_event_types Persistent event log events @@ -6141,7 +6136,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_pel_ehai +.. c:type:: enum nvme_pel_ehai This field indicates the persistent event header additional information @@ -6166,7 +6161,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_pel_ehai_pit +.. c:type:: enum nvme_pel_ehai_pit Persistent Event Header Additional Information - Port Identifier Type @@ -6187,7 +6182,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fw_commit_event +.. c:type:: struct nvme_fw_commit_event Firmware Commit Event Data @@ -6232,7 +6227,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_timestamp +.. c:type:: struct nvme_timestamp Timestamp - Data Structure for Get Features @@ -6261,7 +6256,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_time_stamp_change_event +.. c:type:: struct nvme_time_stamp_change_event Timestamp Change Event @@ -6286,7 +6281,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_power_on_reset_info_list +.. c:type:: struct nvme_power_on_reset_info_list Controller Reset Information @@ -6331,7 +6326,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_nss_hw_err_event +.. c:type:: struct nvme_nss_hw_err_event NVM Subsystem Hardware Error Event @@ -6360,7 +6355,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_change_ns_event +.. c:type:: struct nvme_change_ns_event Change Namespace Event Data @@ -6429,7 +6424,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_format_nvm_start_event +.. c:type:: struct nvme_format_nvm_start_event Format NVM Start Event Data @@ -6462,7 +6457,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_format_nvm_compln_event +.. c:type:: struct nvme_format_nvm_compln_event Format NVM Completion Event Data @@ -6499,7 +6494,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_sanitize_start_event +.. c:type:: struct nvme_sanitize_start_event Sanitize Start Event Data @@ -6528,7 +6523,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_sanitize_compln_event +.. c:type:: struct nvme_sanitize_compln_event Sanitize Completion Event Data @@ -6561,7 +6556,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_set_feature_event +.. c:type:: struct nvme_set_feature_event Set Feature Event Data @@ -6586,7 +6581,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_set_feat_event_layout +.. c:type:: enum nvme_set_feat_event_layout This field indicates the set feature event layout @@ -6619,7 +6614,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_thermal_exc_event +.. c:type:: struct nvme_thermal_exc_event Thermal Excursion Event Data @@ -6644,7 +6639,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lba_rd +.. c:type:: struct nvme_lba_rd LBA Range Descriptor @@ -6673,7 +6668,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lbas_ns_element +.. c:type:: struct nvme_lbas_ns_element LBA Status Log Namespace Element @@ -6710,7 +6705,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_lba_status_atype +.. c:type:: enum nvme_lba_status_atype Action type the controller uses to return LBA status @@ -6731,7 +6726,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lba_status_log +.. c:type:: struct nvme_lba_status_log LBA Status Information Log @@ -6772,7 +6767,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_eg_event_aggregate_log +.. c:type:: struct nvme_eg_event_aggregate_log Endurance Group Event Aggregate @@ -6797,7 +6792,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fid_supported_effects +.. c:type:: enum nvme_fid_supported_effects FID Supported and Effects Data Structure definitions @@ -6848,7 +6843,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fid_supported_effects_log +.. c:type:: struct nvme_fid_supported_effects_log Feature Identifiers Supported and Effects @@ -6869,7 +6864,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_mi_cmd_supported_effects +.. c:type:: enum nvme_mi_cmd_supported_effects MI Command Supported and Effects Data Structure @@ -6917,7 +6912,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_mi_cmd_supported_effects_log +.. c:type:: struct nvme_mi_cmd_supported_effects_log NVMe-MI Commands Supported and Effects Log @@ -6942,7 +6937,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_boot_partition +.. c:type:: struct nvme_boot_partition Boot Partition Log @@ -6980,7 +6975,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_boot_partition_info +.. c:type:: enum nvme_boot_partition_info This field indicates the boot partition information @@ -7005,7 +7000,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_eom_lane_desc +.. c:type:: struct nvme_eom_lane_desc EOM Lane Descriptor @@ -7074,7 +7069,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_phy_rx_eom_log +.. c:type:: struct nvme_phy_rx_eom_log Physical Interface Receiver Eye Opening Measurement Log @@ -7179,7 +7174,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_eom_optional_data_present +.. c:type:: enum nvme_eom_optional_data_present EOM Optional Data Present Fields @@ -7212,7 +7207,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_eom_optional_data +.. c:type:: enum nvme_eom_optional_data EOM Optional Data Present Fields (Deprecated) @@ -7227,7 +7222,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_phy_rx_eom_progress +.. c:type:: enum nvme_phy_rx_eom_progress EOM In Progress Values @@ -7245,7 +7240,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_media_unit_stat_desc +.. c:type:: struct nvme_media_unit_stat_desc Media Unit Status Descriptor @@ -7298,7 +7293,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_media_unit_stat_log +.. c:type:: struct nvme_media_unit_stat_log Media Unit Status @@ -7335,7 +7330,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_media_unit_config_desc +.. c:type:: struct nvme_media_unit_config_desc Media Unit Configuration Descriptor @@ -7364,7 +7359,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_channel_config_desc +.. c:type:: struct nvme_channel_config_desc Channel Configuration Descriptor @@ -7394,7 +7389,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_end_grp_chan_desc +.. c:type:: struct nvme_end_grp_chan_desc Endurance Group Channel Configuration Descriptor @@ -7420,7 +7415,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_end_grp_config_desc +.. c:type:: struct nvme_end_grp_config_desc Endurance Group Configuration Descriptor @@ -7473,7 +7468,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_capacity_config_desc +.. c:type:: struct nvme_capacity_config_desc Capacity Configuration structure definitions @@ -7512,7 +7507,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_supported_cap_config_list_log +.. c:type:: struct nvme_supported_cap_config_list_log Supported Capacity Configuration list log page @@ -7542,7 +7537,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lockdown_log +.. c:type:: struct nvme_lockdown_log Command and Feature Lockdown Log @@ -7575,7 +7570,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_resv_notification_log +.. c:type:: struct nvme_resv_notification_log Reservation Notification Log @@ -7616,7 +7611,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_resv_notify_rnlpt +.. c:type:: enum nvme_resv_notify_rnlpt Reservation Notification Log - Reservation Notification Log Page Type @@ -7637,7 +7632,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_sanitize_log_page +.. c:type:: struct nvme_sanitize_log_page Sanitize Status (Log Identifier 81h) @@ -7763,7 +7758,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_sanitize_sstat +.. c:type:: enum nvme_sanitize_sstat Sanitize Status (SSTAT) @@ -7843,7 +7838,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_sanitize_ssi +.. c:type:: enum nvme_sanitize_ssi Sanitize State Information (SSI) @@ -7908,7 +7903,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_zns_changed_zone_log +.. c:type:: struct nvme_zns_changed_zone_log ZNS Changed Zone List log @@ -7937,7 +7932,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_zns_zt +.. c:type:: enum nvme_zns_zt Zone Descriptor Data Structure - Zone Type @@ -7949,7 +7944,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_zns_za +.. c:type:: enum nvme_zns_za Zone Descriptor Data Structure @@ -7972,7 +7967,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_zns_zs +.. c:type:: enum nvme_zns_zs Zone Descriptor Data Structure - Zone State @@ -8002,7 +7997,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_zns_desc +.. c:type:: struct nvme_zns_desc Zone Descriptor Data Structure @@ -8055,7 +8050,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_zone_report +.. c:type:: struct nvme_zone_report Report Zones Data Structure @@ -8084,7 +8079,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_ruh_type +.. c:type:: enum nvme_fdp_ruh_type Reclaim Unit Handle Type @@ -8099,7 +8094,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_ruh_desc +.. c:type:: struct nvme_fdp_ruh_desc Reclaim Unit Handle Descriptor @@ -8124,7 +8119,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_config_fdpa +.. c:type:: enum nvme_fdp_config_fdpa FDP Attributes @@ -8151,7 +8146,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_lockdown_log_scope +.. c:type:: enum nvme_lockdown_log_scope lockdown log page scope attributes @@ -8172,7 +8167,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_lockdown_log_contents +.. c:type:: enum nvme_lockdown_log_contents lockdown log page content attributes @@ -8190,7 +8185,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_lockdown_scope_contents +.. c:type:: enum nvme_lockdown_scope_contents Lockdown Log shift and mask @@ -8211,7 +8206,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_config_desc +.. c:type:: struct nvme_fdp_config_desc FDP Configuration Descriptor @@ -8272,7 +8267,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_config_log +.. c:type:: struct nvme_fdp_config_log FDP Configurations Log Page @@ -8313,7 +8308,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_ruha +.. c:type:: enum nvme_fdp_ruha Reclaim Unit Handle Attributes @@ -8334,7 +8329,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_ruhu_desc +.. c:type:: struct nvme_fdp_ruhu_desc Reclaim Unit Handle Usage Descriptor @@ -8359,7 +8354,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_ruhu_log +.. c:type:: struct nvme_fdp_ruhu_log Reclaim Unit Handle Usage Log Page @@ -8388,7 +8383,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_stats_log +.. c:type:: struct nvme_fdp_stats_log FDP Statistics Log Page @@ -8421,7 +8416,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_event_type +.. c:type:: enum nvme_fdp_event_type FDP Event Types @@ -8448,7 +8443,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_event_realloc_flags +.. c:type:: enum nvme_fdp_event_realloc_flags Media Reallocated Event Type Specific Flags @@ -8460,7 +8455,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_event_realloc +.. c:type:: struct nvme_fdp_event_realloc Media Reallocated Event Type Specific Information @@ -8497,7 +8492,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_event_flags +.. c:type:: enum nvme_fdp_event_flags FDP Event Flags @@ -8515,7 +8510,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_event +.. c:type:: struct nvme_fdp_event FDP Event @@ -8572,7 +8567,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_events_log +.. c:type:: struct nvme_fdp_events_log FDP Events Log Page @@ -8601,7 +8596,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_feat_fdp_events_cdw11 +.. c:type:: struct nvme_feat_fdp_events_cdw11 FDP Events Feature Command Dword 11 @@ -8630,7 +8625,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_fdp_supported_event_attributes +.. c:type:: enum nvme_fdp_supported_event_attributes Supported FDP Event Attributes @@ -8645,7 +8640,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_supported_event_desc +.. c:type:: struct nvme_fdp_supported_event_desc Supported FDP Event Descriptor @@ -8670,7 +8665,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_ruh_status_desc +.. c:type:: struct nvme_fdp_ruh_status_desc Reclaim Unit Handle Status Descriptor @@ -8707,7 +8702,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_fdp_ruh_status +.. c:type:: struct nvme_fdp_ruh_status Reclaim Unit Handle Status @@ -8736,7 +8731,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lba_status_desc +.. c:type:: struct nvme_lba_status_desc LBA Status Descriptor Entry @@ -8773,7 +8768,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lba_status +.. c:type:: struct nvme_lba_status LBA Status Descriptor List @@ -8806,7 +8801,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_lba_status_cmpc +.. c:type:: enum nvme_lba_status_cmpc Get LBA Status Command Completion Condition @@ -8828,7 +8823,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_feat_auto_pst +.. c:type:: struct nvme_feat_auto_pst Autonomous Power State Transition @@ -8849,7 +8844,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_apst_entry +.. c:type:: enum nvme_apst_entry Autonomous Power State Transition @@ -8870,7 +8865,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_metadata_element_desc +.. c:type:: struct nvme_metadata_element_desc Metadata Element Descriptor @@ -8903,7 +8898,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_host_metadata +.. c:type:: struct nvme_host_metadata Host Metadata Data Structure @@ -8941,7 +8936,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ctrl_metadata_type +.. c:type:: enum nvme_ctrl_metadata_type Controller Metadata Element Types @@ -9004,7 +8999,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ns_metadata_type +.. c:type:: enum nvme_ns_metadata_type Namespace Metadata Element Types @@ -9029,7 +9024,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lba_range_type_entry +.. c:type:: struct nvme_lba_range_type_entry LBA Range Type - Data Structure Entry @@ -9074,7 +9069,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_lbart +.. c:type:: enum nvme_lbart LBA Range Type - Data Structure Entry @@ -9104,7 +9099,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_lba_range_type +.. c:type:: struct nvme_lba_range_type LBA Range Type @@ -9125,7 +9120,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_plm_config +.. c:type:: struct nvme_plm_config Predictable Latency Mode - Deterministic Threshold Configuration Data Structure @@ -9166,7 +9161,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_feat_host_behavior +.. c:type:: struct nvme_feat_host_behavior Host Behavior Support - Data Structure @@ -9207,7 +9202,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_host_behavior_support +.. c:type:: enum nvme_host_behavior_support Enable Advanced Command @@ -9219,7 +9214,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_dsm_range +.. c:type:: struct nvme_dsm_range Dataset Management - Range Definition @@ -9248,7 +9243,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_copy_range +.. c:type:: struct nvme_copy_range Copy - Source Range Entries Descriptor Format @@ -9294,7 +9289,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_copy_range_f1 +.. c:type:: struct nvme_copy_range_f1 Copy - Source Range Entries Descriptor Format 1h @@ -9340,7 +9335,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_copy_range_sopt +.. c:type:: enum nvme_copy_range_sopt NVMe Copy Range Source Options @@ -9352,7 +9347,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_copy_range_f2 +.. c:type:: struct nvme_copy_range_f2 Copy - Source Range Entries Descriptor Format 2h @@ -9406,7 +9401,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_copy_range_f3 +.. c:type:: struct nvme_copy_range_f3 Copy - Source Range Entries Descriptor Format 3h @@ -9464,7 +9459,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_registered_ctrl +.. c:type:: struct nvme_registered_ctrl Registered Controller Data Structure @@ -9501,7 +9496,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_registered_ctrl_ext +.. c:type:: struct nvme_registered_ctrl_ext Registered Controller Extended Data Structure @@ -9542,7 +9537,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_resv_status +.. c:type:: struct nvme_resv_status Reservation Status Data Structure @@ -9605,7 +9600,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_streams_directive_params +.. c:type:: struct nvme_streams_directive_params Streams Directive - Return Parameters Data Structure @@ -9662,7 +9657,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_streams_directive_status +.. c:type:: struct nvme_streams_directive_status Streams Directive - Get Status Data Structure @@ -9687,7 +9682,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_id_directives +.. c:type:: struct nvme_id_directives Identify Directive - Return Parameters Data Structure @@ -9716,7 +9711,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_directive_types +.. c:type:: enum nvme_directive_types Directives Supported or Enabled @@ -9734,7 +9729,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvme_host_mem_buf_attrs +.. c:type:: struct nvme_host_mem_buf_attrs Host Memory Buffer - Attributes Data Structure @@ -9771,7 +9766,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ae_type +.. c:type:: enum nvme_ae_type Asynchronous Event Type @@ -9795,7 +9790,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ae_info_error +.. c:type:: enum nvme_ae_info_error Asynchronous Event Information - Error Status @@ -9822,7 +9817,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ae_info_smart +.. c:type:: enum nvme_ae_info_smart Asynchronous Event Information - SMART / Health Status @@ -9840,7 +9835,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ae_info_css_nvm +.. c:type:: enum nvme_ae_info_css_nvm Asynchronous Event Information - I/O Command Specific Status @@ -9859,7 +9854,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_ae_info_notice +.. c:type:: enum nvme_ae_info_notice Asynchronous Event Information - Notice @@ -9892,7 +9887,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvme_subsys_type +.. c:type:: enum nvme_subsys_type Type of the NVM subsystem. @@ -9923,7 +9918,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_disc_eflags +.. c:type:: enum nvmf_disc_eflags Discovery Log Page entry flags. @@ -9960,7 +9955,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:union:: nvmf_tsas +.. c:type:: union nvmf_tsas Transport Specific Address Subtype @@ -9998,7 +9993,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvmf_disc_log_entry +.. c:type:: struct nvmf_disc_log_entry Discovery Log Page entry @@ -10100,7 +10095,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_trtype +.. c:type:: enum nvmf_trtype Transport Type codes for Discovery Log Page entry TRTYPE field @@ -10128,7 +10123,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_addr_family +.. c:type:: enum nvmf_addr_family Address Family codes for Discovery Log Page entry ADRFAM field @@ -10156,7 +10151,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_treq +.. c:type:: enum nvmf_treq Transport Requirements codes for Discovery Log Page entry TREQ field @@ -10177,7 +10172,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_rdma_qptype +.. c:type:: enum nvmf_rdma_qptype RDMA QP Service Type codes for Discovery Log Page entry TSAS RDMA_QPTYPE field @@ -10192,7 +10187,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_rdma_prtype +.. c:type:: enum nvmf_rdma_prtype RDMA Provider Type codes for Discovery Log Page entry TSAS RDMA_PRTYPE field @@ -10216,7 +10211,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_rdma_cms +.. c:type:: enum nvmf_rdma_cms RDMA Connection Management Service Type codes for Discovery Log Page entry TSAS RDMA_CMS field @@ -10228,7 +10223,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_tcp_sectype +.. c:type:: enum nvmf_tcp_sectype Transport Specific Address Subtype Definition for NVMe/TCP Transport @@ -10248,7 +10243,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_log_discovery_lid_support +.. c:type:: enum nvmf_log_discovery_lid_support Discovery log specific support @@ -10269,7 +10264,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_log_discovery_lsp +.. c:type:: enum nvmf_log_discovery_lsp Discovery log specific field @@ -10290,7 +10285,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvmf_discovery_log +.. c:type:: struct nvmf_discovery_log Discovery Log Page (Log Identifier 70h) @@ -10334,7 +10329,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_dim_tas +.. c:type:: enum nvmf_dim_tas Discovery Information Management Task @@ -10352,7 +10347,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_dim_entfmt +.. c:type:: enum nvmf_dim_entfmt Discovery Information Management Entry Format @@ -10367,7 +10362,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_dim_etype +.. c:type:: enum nvmf_dim_etype Discovery Information Management Entity Type @@ -10385,7 +10380,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:enum:: nvmf_exattype +.. c:type:: enum nvmf_exattype Extended Attribute Type @@ -10400,7 +10395,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvmf_ext_attr +.. c:type:: struct nvmf_ext_attr Extended Attribute (EXAT) @@ -10430,7 +10425,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:struct:: nvmf_ext_die +.. c:type:: struct nvmf_ext_die Extended Discovery Information Entry (DIE) @@ -10515,7 +10510,7 @@ bytes, in size. This log captures the controller’s internal state. -.. c:union:: nvmf_die +.. c:type:: union nvmf_die Discovery Information Entry (DIE) @@ -10555,7 +10550,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvmf_dim_data +.. c:type:: struct nvmf_dim_data Discovery Information Management (DIM) - Data @@ -10624,7 +10619,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvmf_connect_data +.. c:type:: struct nvmf_connect_data Data payload for the 'connect' command @@ -10665,7 +10660,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_read_nvm_ss_info +.. c:type:: struct nvme_mi_read_nvm_ss_info NVM Subsystem Information Data Structure @@ -10698,7 +10693,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_port_pcie +.. c:type:: struct nvme_mi_port_pcie PCIe Port Specific Data @@ -10743,7 +10738,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_port_smb +.. c:type:: struct nvme_mi_port_smb SMBus Port Specific Data @@ -10784,7 +10779,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_read_port_info +.. c:type:: struct nvme_mi_read_port_info Port Information Data Structure @@ -10830,7 +10825,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_read_ctrl_info +.. c:type:: struct nvme_mi_read_ctrl_info Controller Information Data Structure @@ -10883,7 +10878,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_osc +.. c:type:: struct nvme_mi_osc Optionally Supported Command Data Structure @@ -10908,7 +10903,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_read_sc_list +.. c:type:: struct nvme_mi_read_sc_list Management Endpoint Buffer Supported Command List Data Structure @@ -10934,7 +10929,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_nvm_ss_health_status +.. c:type:: struct nvme_mi_nvm_ss_health_status Subsystem Management Data Structure @@ -10975,7 +10970,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:enum:: nvme_mi_ccs +.. c:type:: enum nvme_mi_ccs Get State Control Primitive Success Response Fields - Control Primitive Specific Response @@ -11020,7 +11015,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_ctrl_health_status +.. c:type:: struct nvme_mi_ctrl_health_status Controller Health Data Structure (CHDS) @@ -11065,7 +11060,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:enum:: nvme_mi_csts +.. c:type:: enum nvme_mi_csts Controller Health Data Structure (CHDS) - Controller Status (CSTS) @@ -11095,7 +11090,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:enum:: nvme_mi_cwarn +.. c:type:: enum nvme_mi_cwarn Controller Health Data Structure (CHDS) - Critical Warning (CWARN) @@ -11119,7 +11114,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_vpd_mra +.. c:type:: struct nvme_mi_vpd_mra NVMe MultiRecord Area @@ -11200,7 +11195,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_vpd_ppmra +.. c:type:: struct nvme_mi_vpd_ppmra NVMe PCIe Port MultiRecord Area @@ -11253,7 +11248,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_vpd_telem +.. c:type:: struct nvme_mi_vpd_telem Vital Product Data Element Descriptor @@ -11287,7 +11282,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:enum:: nvme_mi_elem +.. c:type:: enum nvme_mi_elem Element Descriptor Types @@ -11317,7 +11312,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_vpd_tra +.. c:type:: struct nvme_mi_vpd_tra Vital Product Data Topology MultiRecord @@ -11350,7 +11345,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_vpd_mr_common +.. c:type:: struct nvme_mi_vpd_mr_common NVMe MultiRecord Area @@ -11404,7 +11399,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:struct:: nvme_mi_vpd_hdr +.. c:type:: struct nvme_mi_vpd_hdr Vital Product Data Common Header @@ -11457,7 +11452,7 @@ entries are of a variable lengths (TEL), TEL is always a multiple of -.. c:enum:: nvme_status_field +.. c:type:: enum nvme_status_field Defines all parts of the nvme status field: status code, status code type, and additional flags. @@ -12280,7 +12275,7 @@ status code -.. c:enum:: nvme_status_type +.. c:type:: enum nvme_status_type type encoding for NVMe return values, when represented as an int. @@ -12362,7 +12357,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_admin_opcode +.. c:type:: enum nvme_admin_opcode Known NVMe admin opcodes @@ -12476,7 +12471,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_identify_cns +.. c:type:: enum nvme_identify_cns Identify - CNS Values @@ -12575,7 +12570,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_cmd_get_log_lid +.. c:type:: enum nvme_cmd_get_log_lid Get Log Page -Log Page Identifiers @@ -12704,7 +12699,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_features_id +.. c:type:: enum nvme_features_id Features - Feature Identifiers @@ -12821,7 +12816,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_feat +.. c:type:: enum nvme_feat Features Access Shifts/Masks values @@ -13038,7 +13033,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_get_features_sel +.. c:type:: enum nvme_get_features_sel Get Features - Select @@ -13059,7 +13054,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_cmd_format_mset +.. c:type:: enum nvme_cmd_format_mset Format NVM - Metadata Settings @@ -13076,7 +13071,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_cmd_format_pi +.. c:type:: enum nvme_cmd_format_pi Format NVM - Protection Information @@ -13097,7 +13092,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_cmd_format_pil +.. c:type:: enum nvme_cmd_format_pil Format NVM - Protection Information Location @@ -13114,7 +13109,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_cmd_format_ses +.. c:type:: enum nvme_cmd_format_ses Format NVM - Secure Erase Settings @@ -13141,7 +13136,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_ns_mgmt_sel +.. c:type:: enum nvme_ns_mgmt_sel Namespace Management - Select @@ -13156,7 +13151,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_ns_attach_sel +.. c:type:: enum nvme_ns_attach_sel Namespace Attachment - Select @@ -13171,7 +13166,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_fw_commit_ca +.. c:type:: enum nvme_fw_commit_ca Firmware Commit - Commit Action @@ -13215,7 +13210,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_directive_dtype +.. c:type:: enum nvme_directive_dtype Directive Types @@ -13230,7 +13225,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_directive_receive_doper +.. c:type:: enum nvme_directive_receive_doper Directive Receive Directive Operation @@ -13247,7 +13242,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_directive_send_doper +.. c:type:: enum nvme_directive_send_doper Directive Send Directive Operation @@ -13262,7 +13257,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_directive_send_identify_endir +.. c:type:: enum nvme_directive_send_identify_endir Enable Directive @@ -13275,7 +13270,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_sanitize_sanact +.. c:type:: enum nvme_sanitize_sanact Sanitize Action @@ -13299,7 +13294,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_dst_stc +.. c:type:: enum nvme_dst_stc Action taken by the Device Self-test command @@ -13320,7 +13315,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_virt_mgmt_act +.. c:type:: enum nvme_virt_mgmt_act Virtualization Management - Action @@ -13342,7 +13337,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_virt_mgmt_rt +.. c:type:: enum nvme_virt_mgmt_rt Virtualization Management - Resource Type @@ -13357,7 +13352,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_ns_write_protect_cfg +.. c:type:: enum nvme_ns_write_protect_cfg Write Protection - Write Protection State @@ -13378,7 +13373,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_log_ana_lsp +.. c:type:: enum nvme_log_ana_lsp Asymmetric Namespace Access - Return Groups Only @@ -13391,7 +13386,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_log_phy_rx_eom_action +.. c:type:: enum nvme_log_phy_rx_eom_action Physical Interface Receiver Eye Opening Measurement Action @@ -13409,7 +13404,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_log_phy_rx_eom_quality +.. c:type:: enum nvme_log_phy_rx_eom_quality Physical Interface Receiver Eye Opening Measurement Quality @@ -13427,7 +13422,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_pevent_log_action +.. c:type:: enum nvme_pevent_log_action Persistent Event Log - Action @@ -13445,7 +13440,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_feat_tmpthresh_thsel +.. c:type:: enum nvme_feat_tmpthresh_thsel Temperature Threshold - Threshold Type Select @@ -13460,7 +13455,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_features_async_event_config_flags +.. c:type:: enum nvme_features_async_event_config_flags Asynchronous Event Configuration configuration flags @@ -13497,7 +13492,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_feat_plm_window_select +.. c:type:: enum nvme_feat_plm_window_select Predictable Latency Per NVM Set Log @@ -13512,7 +13507,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_feat_resv_notify_flags +.. c:type:: enum nvme_feat_resv_notify_flags Reservation Notification Configuration @@ -13530,7 +13525,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_feat_nswpcfg_state +.. c:type:: enum nvme_feat_nswpcfg_state Write Protection - Write Protection State @@ -13551,7 +13546,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_fctype +.. c:type:: enum nvme_fctype Fabrics Command Types @@ -13578,7 +13573,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_data_tfr +.. c:type:: enum nvme_data_tfr Data transfer direction of the command @@ -13599,7 +13594,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_io_opcode +.. c:type:: enum nvme_io_opcode Opcodes for I/O Commands @@ -13665,7 +13660,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_kv_opcode +.. c:type:: enum nvme_kv_opcode Opcodes for KV Commands @@ -13704,7 +13699,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_io_control_flags +.. c:type:: enum nvme_io_control_flags I/O control flags @@ -13743,7 +13738,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_io_dsm_flags +.. c:type:: enum nvme_io_dsm_flags Dataset Management flags @@ -13797,7 +13792,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_dsm_attributes +.. c:type:: enum nvme_dsm_attributes Dataset Management attributes @@ -13815,7 +13810,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_resv_rtype +.. c:type:: enum nvme_resv_rtype Reservation Type Encoding @@ -13842,7 +13837,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_resv_racqa +.. c:type:: enum nvme_resv_racqa Reservation Acquire - Reservation Acquire Action @@ -13860,7 +13855,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_resv_rrega +.. c:type:: enum nvme_resv_rrega Reservation Register - Reservation Register Action @@ -13878,7 +13873,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_resv_cptpl +.. c:type:: enum nvme_resv_cptpl Reservation Register - Change Persist Through Power Loss State @@ -13898,7 +13893,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_resv_rrela +.. c:type:: enum nvme_resv_rrela Reservation Release - Reservation Release Action @@ -13913,7 +13908,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_zns_send_action +.. c:type:: enum nvme_zns_send_action Zone Management Send - Zone Send Action @@ -13943,7 +13938,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_zns_recv_action +.. c:type:: enum nvme_zns_recv_action Zone Management Receive - Zone Receive Action Specific Features @@ -13958,7 +13953,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_zns_report_options +.. c:type:: enum nvme_zns_report_options Zone Management Receive - Zone Receive Action Specific Field @@ -13991,7 +13986,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_io_mgmt_recv_mo +.. c:type:: enum nvme_io_mgmt_recv_mo I/O Management Receive - Management Operation @@ -14003,7 +13998,7 @@ true if **status** is of the specified type and value -.. c:enum:: nvme_io_mgmt_send_mo +.. c:type:: enum nvme_io_mgmt_send_mo I/O Management Send - Management Operation @@ -14015,7 +14010,7 @@ true if **status** is of the specified type and value -.. c:struct:: nvme_ns_mgmt_host_sw_specified +.. c:type:: struct nvme_ns_mgmt_host_sw_specified Namespace management Host Software Specified Fields. diff --git a/doc/rst/util.rst b/doc/rst/util.rst index 6d024ed..f8d4a52 100644 --- a/doc/rst/util.rst +++ b/doc/rst/util.rst @@ -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** |