summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_security_recv.2
blob: cb658d4171a9b07f85895f4594dd416181e8a8f4 (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
.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_security_recv \- Perform a Security Receive command on a controller.
.SH SYNOPSIS
.B "int" nvme_mi_admin_security_recv
.BI "(nvme_mi_ctrl_t ctrl "  ","
.BI "struct nvme_security_receive_args *args "  ");"
.SH ARGUMENTS
.IP "ctrl" 12
Controller to send command to
.IP "args" 12
Security Receive command arguments
.SH "DESCRIPTION"
Performs a Security Receive Admin command as specified by \fIargs\fP. Response
data is stored in \fIargs->data\fP, which should be a buffer of \fIargs->data_len\fP
bytes. Resulting data length is stored in \fIargs->data_len\fP on successful
command completion.

Security Receive data length should not be greater than 4096 bytes to
comply with specification limits.

See: \fIstruct nvme_get_log_args\fP
.SH "RETURN"
0 on success, non-zero on failure