nvme/libnvme
1
0
Fork 0
Code Issues Activity

Merging upstream version 1.6.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 10:12:19 +01:00
parent adbb3a10cc
commit 6add9877e4
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
871 changed files with 8481 additions and 1502 deletions
Download patch file Download diff file Expand all files Collapse all files

36
doc/man/nvme_get_telemetry_log.2 Normal file
View file

@ -0,0 +1,36 @@
.TH "nvme_get_telemetry_log" 9 "nvme_get_telemetry_log" "September 2023" "libnvme API manual" LINUX
.SH NAME
nvme_get_telemetry_log \- Get specified telemetry log
.SH SYNOPSIS
.B "int" nvme_get_telemetry_log
.BI "(int fd " ","
.BI "bool create " ","
.BI "bool ctrl " ","
.BI "bool rae " ","
.BI "size_t max_data_tx " ","
.BI "enum nvme_telemetry_da da " ","
.BI "struct nvme_telemetry_log **log " ","
.BI "size_t *size " ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "create" 12
Generate new host initated telemetry capture
.IP "ctrl" 12
Get controller Initiated log
.IP "rae" 12
Retain asynchronous events
.IP "max_data_tx" 12
Set the max data transfer size to be used retrieving telemetry.
.IP "da" 12
Log page data area, valid values: \fIenum nvme_telemetry_da\fP.
.IP "log" 12
On success, set to the value of the allocated and retrieved log.
.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.