From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 21:41:32 +0200 Subject: Adding upstream version 2.8. Signed-off-by: Daniel Baumann --- Documentation/nvme-security-recv.txt | 89 ++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 Documentation/nvme-security-recv.txt (limited to 'Documentation/nvme-security-recv.txt') diff --git a/Documentation/nvme-security-recv.txt b/Documentation/nvme-security-recv.txt new file mode 100644 index 0000000..ef77531 --- /dev/null +++ b/Documentation/nvme-security-recv.txt @@ -0,0 +1,89 @@ +nvme-security-recv(1) +===================== + +NAME +---- +nvme-security-recv - Security Recv command + +SYNOPSIS +-------- +[verse] +'nvme security-recv' [--size= | -x ] + [--secp= | -p ] + [--spsp= | -s ] + [--nssf= | -N ] + [--al= | -t ] + [--namespace-id= | -n ] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] + +DESCRIPTION +----------- +The Security Receive command transfers the status and data result of +one or more Security Send commands that were previously submitted to +the controller. + +The association between a Security Receive command and previous Security +Send commands is dependent on the Security Protocol. The format of the +data to be transferred is dependent on the Security Protocol. Refer to +SPC-4 for Security Protocol details. + +Each Security Receive command returns the appropriate data corresponding +to a Security Send command as defined by the rules of the Security +Protocol. The Security Receive command data may not be retained if there +is a loss of communication between the controller and host, or if a +controller reset occurs. + +OPTIONS +------- +-n :: +--namespace-id=:: + Target a specific namespace for this security command. + +-N :: +--nssf=:: + NVMe Security Specific field. If using security protocol EAh + assigned for NVMe use, the NVMe security specific field indicates + which reply memory buffer target. + +-x :: +--size=:: + Size of buffer to allocate. One success it will be printed + to STDOUT. + +-p :: +--secp=:: + Security Protocol: This field specifies the security protocol + as defined in SPC-4. The controller shall fail the command with + Invalid Parameter indicated if a reserved value of the Security + Protocol is specified. + +-s :: +--spsp=:: + SP Specific: The value of this field is specific to the Security + Protocol as defined in SPC-4. + +-t :: +--al=:: + Allocation Length: The value of this field is specific to the + Security Protocol as defined in SPC-4. + +-b:: +--raw-binary:: + Print the raw buffer to stdout. Defaults to print in hex. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + +EXAMPLES +-------- +No Examples + +NVME +---- +Part of the nvme-user suite -- cgit v1.2.3