* [PATCH] cxl/mem: Clarify UAPI documentation
@ 2021-04-13 14:32 Ben Widawsky
2021-04-14 12:37 ` Jonathan Cameron
0 siblings, 1 reply; 2+ messages in thread
From: Ben Widawsky @ 2021-04-13 14:32 UTC (permalink / raw)
To: linux-cxl
Cc: Ben Widawsky, linux-pci, linux-acpi, ira.weiny, vishal.l.verma,
alison.schofield, dan.j.williams, linux-kernel
Signed-off-by: Ben Widawsky <ben.widawsky@intel.com>
---
include/uapi/linux/cxl_mem.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/include/uapi/linux/cxl_mem.h b/include/uapi/linux/cxl_mem.h
index f6e8a005b113..8dd516ddb098 100644
--- a/include/uapi/linux/cxl_mem.h
+++ b/include/uapi/linux/cxl_mem.h
@@ -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 {
--
2.31.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] cxl/mem: Clarify UAPI documentation
2021-04-13 14:32 [PATCH] cxl/mem: Clarify UAPI documentation Ben Widawsky
@ 2021-04-14 12:37 ` Jonathan Cameron
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Cameron @ 2021-04-14 12:37 UTC (permalink / raw)
To: Ben Widawsky
Cc: linux-cxl, linux-pci, linux-acpi, ira.weiny, vishal.l.verma,
alison.schofield, dan.j.williams, linux-kernel
On Tue, 13 Apr 2021 07:32:47 -0700
Ben Widawsky <ben.widawsky@intel.com> wrote:
> Signed-off-by: Ben Widawsky <ben.widawsky@intel.com>
Sensible update.
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
> include/uapi/linux/cxl_mem.h | 7 +++++++
> 1 file changed, 7 insertions(+)
>
> diff --git a/include/uapi/linux/cxl_mem.h b/include/uapi/linux/cxl_mem.h
> index f6e8a005b113..8dd516ddb098 100644
> --- a/include/uapi/linux/cxl_mem.h
> +++ b/include/uapi/linux/cxl_mem.h
> @@ -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 {
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-04-14 12:39 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-13 14:32 [PATCH] cxl/mem: Clarify UAPI documentation Ben Widawsky
2021-04-14 12:37 ` Jonathan Cameron
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.