summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_telemetry_ctrl.2
blob: 2fa418fd9a5f83f9c80ed0c6a09b4c098c6d877a (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_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_telemetry_ctrl \- Get Telemetry Controller-Initiated log page
.SH SYNOPSIS
.B "int" nvme_get_log_telemetry_ctrl
.BI "(int fd "  ","
.BI "bool rae "  ","
.BI "__u64 offset "  ","
.BI "__u32 len "  ","
.BI "void *log "  ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "rae" 12
Retain asynchronous events
.IP "offset" 12
Offset into the telemetry data
.IP "len" 12
Length of provided user buffer to hold the log data in bytes
.IP "log" 12
User address for log page data
.SH "DESCRIPTION"
Retrieves the Telemetry Controller-Initiated log page at the requested offset
using the previously existing capture.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.