Received-SPF: pass (google.com: domain of linux-kernel+bounces-132316-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: "Peng Fan (OSS)" <peng.fan@oss.nxp.com>
Date: Fri, 05 Apr 2024 09:59:32 +0800
Subject: [PATCH v8 1/4] firmware: arm_scmi: introduce helper
 get_max_msg_size
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240405-pinctrl-scmi-v8-1-5fc8e33871bf@nxp.com>
References: <20240405-pinctrl-scmi-v8-0-5fc8e33871bf@nxp.com>
In-Reply-To: <20240405-pinctrl-scmi-v8-0-5fc8e33871bf@nxp.com>
To: Sudeep Holla <sudeep.holla@arm.com>, 
 Cristian Marussi <cristian.marussi@arm.com>, Rob Herring <robh@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, 
 Linus Walleij <linus.walleij@linaro.org>, 
 Dan Carpenter <dan.carpenter@linaro.org>
Cc: Andy Shevchenko <andy.shevchenko@gmail.com>, 
 linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, 
 devicetree@vger.kernel.org, linux-gpio@vger.kernel.org, 
 Peng Fan <peng.fan@nxp.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: DU0PR04MB9417:EE_|AS1PR04MB9334:EE_
X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True
X-MS-Exchange-SenderADCheck: 1
X-MS-Exchange-AntiSpam-Relay: 0
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info:
	g9dfYGQpdcCOKQ8McC+8G15rjDNZ4jlFM9AOLx658oZd7XHdHopuO+jT3i+32LZww+7fdPw8me6KVOAf0gHM4549P+b/YtoHg/LfQOXozSUGugidZ1+uvi5hoJSP+4oz2x8zMYDSAexJ5QnhfbrVX7CEj1WfKToV3CzG5pL51dt7xk9khbN/vJHUoH7fAF0mpmGe8nuzSZ/W3ILvY04GZKdTuVauuBFGiNPISEbENVSd7pYfAnyg12hisPlxO4UJtbrnTxgTW0jg+JF3Tqz+2/zNfgGdeknhXvG1DCaj/DHqPY7QQx13BnsjHQSuFYmh6clDv+C5FOPur6HqdrTva/Yg1WaF+27U6K6mqNkfp5OiPOFynpY9vhn8yv/hfvrHHsumKzqYw0SnryzFLMTYXmOaI1M+Fgc7IMNiqSLjAV3HNeaMbQ+5o4TgfGL0x8ZFmYM/Kgy0Eh2PpKfbsId9p0xLcQKnssiN6hXV2VE54wpuhjhrHUjCrzh34sC/6w6q9DsK6t5XKbh03jWVDIZNjxfwbStIazuxHekfYQxs6rGShZUQdqsuNbwOIiIBZxTQjYivaHJV8YvwxJJYy+5ygfaTX4XKyzTSvOUqIzT36jCWDf6X15T2vI5iWYMYtvf9eKUXKw0BWERo/eNHGE+CypqtARB1p8cgBc1eaUXdW4khSJqip9KpO/YbbuOwlFtbvmo18J0IfZ0ZAKsOadsUxWrAiQGuYG/Cc99wfC+Q1B8=
X-Forefront-Antispam-Report:
	CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:DU0PR04MB9417.eurprd04.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230031)(1800799015)(366007)(7416005)(52116005)(376005)(38350700005);DIR:OUT;SFP:1102;
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?VUFtV01IZTRhRjJmNTBDTEhKcTJKbmFmUmp0YVg4d0JxRTNKK1B1ZHRXRlI1?=
 =?utf-8?B?VTN4RWxXVy9yR2FEZDBISFJvR1RGZWZKaFdDTGJ3QjMwalBXeDM0K1pXUmpi?=
 =?utf-8?B?N0ZKUGMwdUs3YjlCYUdiUUh5ZHhKTUEyUWdYOXRHNndSQlUyUmVBUjl2QnVI?=
 =?utf-8?B?SUJsL0NKWm5jU281czk3aTJqV3JhWHN6N3kyYW1vZG42SlFqVXEwSTFuL0tG?=
 =?utf-8?B?VXZaOGVOTTZMVTh2YkxydEJFNEVYd1hCQVRGRWtpckl4dzhaUFZXMjlBMlBw?=
 =?utf-8?B?TUNKS0pEZzF3amprUk9rTWhCM3BtSVptTktjWktuSlRyV2VHelZxVTN0ZFpU?=
 =?utf-8?B?NGxtR1JBSVlndFN5ajhicGthaTE2NmYyUDhYVStESzFNZXY2dWZqajVkVVJn?=
 =?utf-8?B?ZzlBRU0yQW1sc3Zyc3pMdjNHTkFQeW1YYmcyaFR1SGZlTTI2eFZDYkgzWUZi?=
 =?utf-8?B?Y05aN1MvcExMVXVtakVwWFdmS01xYklJd0JJMzJER2ZacUpVQmYvTTZVWnpF?=
 =?utf-8?B?RytrNU5peDlsRkl6TFFNOCtrSHdrNjJDbjBsZjRISU91NCtkeTNRbk5md0hh?=
 =?utf-8?B?N01oWUI4T3ZpelM1WklKajRMOXQrZ21uWWczSUdQV2t3Zm9nUTI4WGdVWlRv?=
 =?utf-8?B?U1ptcUx2VGY5VURYQkJIb2pOUnUzMHhEdm9kK0M2Rm4zTngzMFNCM284dHRE?=
 =?utf-8?B?aWlneUNsa1Q3SmwvMzRnVXNvU0cycHBXS29tV2wzMDNOV0pSakZkanlyd0FX?=
 =?utf-8?B?SWt0RkRrYjgzL3NXYm81cjVneGNSQU9sWVNDMUt2V1BodVNLbVJCSWJaV3Ji?=
 =?utf-8?B?Z25mcGNleDZhU2trM2w3djZtajdRNDRqN25tbVhON3d5RFZXWG96UURNOHYw?=
 =?utf-8?B?M2VkMXgrYUhHZDE1cGhQNXU3OFVwTXhKaXUybFlvWTVFTVdUT1B0YkRNZS9a?=
 =?utf-8?B?TWwzNHBUWUFFUVl0cGpLR2FrckllRlgycGpkc3AwamlXNHQzVVpKcFI1L3Bw?=
 =?utf-8?B?L0FjUHhva2N2Q3hUSVJWeUVHQUlCMVgyRDJGeTVKWkYzWlE2dTQraWNyNlpW?=
 =?utf-8?B?RGVzVytvMmFvclVmTDg3Zk13Tk9vYVpqN0hWRzFRSXRwN2h1bzVsQW9KOTFR?=
 =?utf-8?B?WHBaMm93NURTK2cwM1Y5ZVhBeDNSdlJGY1hhaTNtQXA3bjZLUnR3ZUNVS3JN?=
 =?utf-8?B?cjF5ZmpOMG5rQVgyVU0weHhXR3dGN1V2TjYybGVCeHltUFc1Q2lHQ2plQ0ZD?=
 =?utf-8?B?RlY1UElnTlBJVFFjcTR1RXRzVndyS1k0KzIxeGdJVjJHWTVaWnBBR1hyNlht?=
 =?utf-8?B?MlFlQnBSM0JGRVBmWi85b1hOWnVsc0ZzWU5HeXJ2SmwvZU0rRE52MkRkRDEw?=
 =?utf-8?B?R2h3SkNoRWtkYXVxdFR4a3VMQXVvYitOMUxJRGs2UEo3YTRlVEdOZ0E4d1M2?=
 =?utf-8?B?eGhuN0t5d0dmbzZFUWlSUFFwaElCL2hkaTlyM25ldEVZZE91b05NSHpCblIz?=
 =?utf-8?B?S2pOUm1YMHl0b1FtdUdjME50TEtURU1DZmJ0cERqZy83M2JRVlplc1JkWG1z?=
 =?utf-8?B?ZFBFUUJhbEZkM0RDZ1J6ak1ETS9oMGhBSW5NR3pQQmM1N2VBeUhhU2xnc015?=
 =?utf-8?B?MktQMlZsUVFMMm5jVkg5Ym1lYlRqV25KR2V1ekdEelhncTR6NWV3VHBTZzNo?=
 =?utf-8?B?bVRPN3pMV2g1cStTMnpaeW56a3dGekxRR0JTckNnN2Y0OWFvckVYT3dlQVJp?=
 =?utf-8?B?TGMxc2VnU1A2bmszRXNSelJzR2RNTm8zb0pwT2JDWS9zb2ZJb2xNaG01bis3?=
 =?utf-8?B?aWZiQkl1Y1FIU3M1ZGV4c3ZCTVR3aVBnNzJ0c3Byb1gwaWpLUk5tNEZOa1k0?=
 =?utf-8?B?UW1GUFhqQVVvbUV5ek5iOGN2eHJzRExwQmlCOVVHRDBYVkY0UG5SVnNwNzBt?=
 =?utf-8?B?aXlFQ0tvWm5zeGhlcjdwZUsvN3BEb2trSm85TnFPV3RiNnBldFNTbWN0R0s3?=
 =?utf-8?B?RTRvWVVkZDRDZTRFQU9PZ3NTV3ZJdXdiZ1NLTktRc3EzTjkwT2owQ200SUNk?=
 =?utf-8?B?TjJQcHZIWDRGS0Q1TWpveXBid0g1MFcvNlNpdG9aSXF2Z055Ylo5bTNDN01W?=
 =?utf-8?Q?brHAqQumnW+JOqzBhz2dIcApz?=
X-OriginatorOrg: oss.nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8b766d00-8ad2-49cf-80e7-08dc5512ec3b
X-MS-Exchange-CrossTenant-AuthSource: DU0PR04MB9417.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Apr 2024 01:51:34.2107
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: lANtDZAk84Tkv0d9S2t+ox0JJHJbEHIoQ3+D1/HwqKlUj+o7/1s1RKyF7O+4Cr8AJXA3gxUAWS7zDtFJ7YK9pg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS1PR04MB9334

From: Peng Fan <peng.fan@nxp.com>

When Agent sending data to SCMI server, the Agent driver could check
the size to avoid protocol buffer overflow. So introduce the helper
get_max_msg_size.

Reviewed-by: Cristian Marussi <cristian.marussi@arm.com>
Signed-off-by: Peng Fan <peng.fan@nxp.com>
---
 drivers/firmware/arm_scmi/driver.c    | 15 +++++++++++++++
 drivers/firmware/arm_scmi/protocols.h |  2 ++
 2 files changed, 17 insertions(+)

diff --git a/drivers/firmware/arm_scmi/driver.c b/drivers/firmware/arm_scmi/driver.c
index 2709598f3008..415e6f510057 100644
--- a/drivers/firmware/arm_scmi/driver.c
+++ b/drivers/firmware/arm_scmi/driver.c
@@ -1488,6 +1488,20 @@ static int scmi_common_extended_name_get(const struct scmi_protocol_handle *ph,
 	return ret;
 }
 
+/**
+ * scmi_common_get_max_msg_size  - Get maximum message size
+ * @ph: A protocol handle reference.
+ *
+ * Return: Maximum message size for the current protocol.
+ */
+static int scmi_common_get_max_msg_size(const struct scmi_protocol_handle *ph)
+{
+	const struct scmi_protocol_instance *pi = ph_to_pi(ph);
+	struct scmi_info *info = handle_to_scmi_info(pi->handle);
+
+	return info->desc->max_msg_size;
+}
+
 /**
  * struct scmi_iterator  - Iterator descriptor
  * @msg: A reference to the message TX buffer; filled by @prepare_message with
@@ -1799,6 +1813,7 @@ static int scmi_protocol_msg_check(const struct scmi_protocol_handle *ph,
 
 static const struct scmi_proto_helpers_ops helpers_ops = {
 	.extended_name_get = scmi_common_extended_name_get,
+	.get_max_msg_size = scmi_common_get_max_msg_size,
 	.iter_response_init = scmi_iterator_init,
 	.iter_response_run = scmi_iterator_run,
 	.protocol_msg_check = scmi_protocol_msg_check,
diff --git a/drivers/firmware/arm_scmi/protocols.h b/drivers/firmware/arm_scmi/protocols.h
index 317d3fb32676..3e91536a77a3 100644
--- a/drivers/firmware/arm_scmi/protocols.h
+++ b/drivers/firmware/arm_scmi/protocols.h
@@ -258,6 +258,7 @@ struct scmi_fc_info {
  * @fastchannel_init: A common helper used to initialize FC descriptors by
  *		      gathering FC descriptions from the SCMI platform server.
  * @fastchannel_db_ring: A common helper to ring a FC doorbell.
+ * @get_max_msg_size: A common helper to get the maximum message size.
  */
 struct scmi_proto_helpers_ops {
 	int (*extended_name_get)(const struct scmi_protocol_handle *ph,
@@ -277,6 +278,7 @@ struct scmi_proto_helpers_ops {
 				 struct scmi_fc_db_info **p_db,
 				 u32 *rate_limit);
 	void (*fastchannel_db_ring)(struct scmi_fc_db_info *db);
+	int (*get_max_msg_size)(const struct scmi_protocol_handle *ph);
 };
 
 /**

-- 
2.37.1