cxl/mem: Clarify UAPI documentation
PATCH 1/1 cxl/mem: Clarify UAPI documentation
Signed-off-by Ben Widawsky <[email protected]>
--- include/uapi/linux/cxl_mem.h | 7 +++++++ 1 file changed, 7 insertions(+)
include/uapi/linux/cxl_mem.h +7 -0
@@ -81,6 +81,13 @@ static const struct {* - @size_in = -1 * - @size_out = 0 * +* Commands which have a variable length input likely have a minimum length. +* This is not enforced by the UAPI, and therefore might look like the command +* succeeded when sending too small of an input payload. Caution should be taken +* by checking the @cxl_send_command.retval for such cases. For commands with a +* variable length output, the caller is free to consume as little or as much as +* they want. +* * See struct cxl_mem_query_commands. */ struct cxl_command_info {
Signature · 1 line
2.31.1
Quoted 1 line · On Tue, 13 Apr 2021 07:32:47 -0700 Ben Widawsky <[email protected]> wrote:
Signed-off-by Ben Widawsky <[email protected]>
Sensible update.
Acked-by Jonathan Cameron <[email protected]>
Quoted 22 lines
--- include/uapi/linux/cxl_mem.h | 7 +++++++ 1 file changed, 7 insertions(+)include/uapi/linux/cxl_mem.h +7
-0@@ -81,6 +81,13 @@ static const struct {* - @size_in = -1 * - @size_out = 0 * +* Commands which have a variable length input likely have a minimum length. +* This is not enforced by the UAPI, and therefore might look like the command +* succeeded when sending too small of an input payload. Caution should be taken +* by checking the @cxl_send_command.retval for such cases. For commands with a +* variable length output, the caller is free to consume as little or as much as +* they want. +* * See struct cxl_mem_query_commands. */ struct cxl_command_info {