From 30de0a5e1fec42589469e5ec8951d15d364df63a Mon Sep 17 00:00:00 2001 From: Igor Skalkin Date: Thu, 5 Nov 2020 22:21:08 +0100 Subject: [PATCH] firmware: arm_scmi: Document that max_msg is a per channel type limit struct scmi_desc.max_msg specifies a limit for the pending messages. This limit is a per SCMI channel type (tx, rx) limit. State that explicitly in the inline documentation. The following patch will add an op to override the limit per channel type. Co-developed-by: Peter Hilber Signed-off-by: Peter Hilber Signed-off-by: Igor Skalkin Signed-off-by: Vasyl Vavrychuk --- drivers/firmware/arm_scmi/common.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/firmware/arm_scmi/common.h b/drivers/firmware/arm_scmi/common.h index aed192238177..38e6aabbe3dd 100644 --- a/drivers/firmware/arm_scmi/common.h +++ b/drivers/firmware/arm_scmi/common.h @@ -231,8 +231,8 @@ struct scmi_transport_ops { * * @ops: Pointer to the transport specific ops structure * @max_rx_timeout_ms: Timeout for communication with SoC (in Milliseconds) - * @max_msg: Maximum number of messages that can be pending - * simultaneously in the system + * @max_msg: Maximum number of messages for a channel type (tx or rx) that can + * be pending simultaneously in the system * @max_msg_size: Maximum size of data per message that can be handled. */ struct scmi_desc {