diff options
Diffstat (limited to 'doc/man/nvme_get_host_telemetry.2')
| -rw-r--r-- | doc/man/nvme_get_host_telemetry.2 | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/man/nvme_get_host_telemetry.2 b/doc/man/nvme_get_host_telemetry.2 new file mode 100644 index 0000000..5355a3c --- /dev/null +++ b/doc/man/nvme_get_host_telemetry.2 @@ -0,0 +1,24 @@ +.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "January 2023" "libnvme API manual" LINUX +.SH NAME +nvme_get_host_telemetry \- Get host telemetry log +.SH SYNOPSIS +.B "int" nvme_get_host_telemetry +.BI "(int fd " "," +.BI "struct nvme_telemetry_log **log " "," +.BI "enum nvme_telemetry_da da " "," +.BI "size_t *size " ");" +.SH ARGUMENTS +.IP "fd" 12 +File descriptor of nvme device +.IP "log" 12 +On success, set to the value of the allocated and retrieved log. +.IP "da" 12 +Log page data area, valid values: \fIenum nvme_telemetry_da\fP +.IP "size" 12 +Ptr to the telemetry log size, so it can be returned +.SH "DESCRIPTION" +The total size allocated can be calculated as: +(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |