summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_ctrl_telemetry.2
blob: 79d55d614642005695aba632a45a14562bf203a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_get_ctrl_telemetry \- Get controller telemetry log
.SH SYNOPSIS
.B "int" nvme_get_ctrl_telemetry
.BI "(int fd "  ","
.BI "bool rae "  ","
.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 "rae" 12
Retain asynchronous events
.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.