diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
commit | 2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch) | |
tree | ac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_mi_admin_security_recv.2 | |
parent | Initial commit. (diff) | |
download | libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip |
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/man/nvme_mi_admin_security_recv.2 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_security_recv.2 b/doc/man/nvme_mi_admin_security_recv.2 new file mode 100644 index 0000000..b101ab0 --- /dev/null +++ b/doc/man/nvme_mi_admin_security_recv.2 @@ -0,0 +1,25 @@ +.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "January 2023" "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" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |