Received-SPF: pass (google.com: domain of linux-kernel+bounces-141740-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: "Peng Fan (OSS)" <peng.fan@oss.nxp.com>
Date: Fri, 12 Apr 2024 08:21:19 +0800
Subject: [PATCH v9 1/4] firmware: arm_scmi: introduce helper
 get_max_msg_size
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240412-pinctrl-scmi-v9-1-b817344d3a9a@nxp.com>
References: <20240412-pinctrl-scmi-v9-0-b817344d3a9a@nxp.com>
In-Reply-To: <20240412-pinctrl-scmi-v9-0-b817344d3a9a@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: Dhruva Gole <d-gole@ti.com>, 
 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_|AM8PR04MB7970:EE_
X-MS-Office365-Filtering-Correlation-Id: dbc3ff96-531c-4a52-c697-08dc5a855ce3
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:
	KgaywSO+DSPV90Ifrs/x6QgWLmkTwU97qvoqeeAVlQEXLPfHliR83Mlp/DJk1+7XRSQ3ucHsLOSZ8icb5YYmlCS4LH0h9yYzs1Fv8raYt6mpxg0SM95UMZQpBAdiLA7ML5BhpvwrWQFkbRX1LtVsHW8+3e7zc3OsT8+jzh8n0iLTlT23nm2+rSe42rEVnBlcwx6X2ncLJd1KvDWjrdfQvjzAT5paJojlNgohPIksFROax1JGj1l+d7nEQR5jgk0mPB0BDAl3mf5vT5HrzR7TgAQF5jhwk1asg53XZArfTu8KKrgHbB8OCjQJX8CFms7Q5xTvjnPXfAn8fT23bfY5fnetU8o1hJxCVA+oDS6wVwhoZsqyHHDZzb0zQtSjCiPSxz+UdjCBO/p5eW4ty1komxBWtWBftT6wiptfO7wd3oBna16x8lKdsvhMtPZhxqDonAQXnd0njT/NwXsUaxyDk58D5LML4/wOUzSotEFVUWNYIqAzJA0mvDDB6cjpwTTxZBQV9r9CmyCrHpY4Vdx2SZhPpmDg074XlDYc721r/6R/LMs8B9z6W8ewuASFZrULZgYY7eTsKI9POoVoW8ZVZa+fk97jDOr8gAbvsk4mHfZC4Rg8cKJ0yaOc5lzKLf27CvqZi9KCWgTZBI0el1fCeN/zC1+AJjAtoz1tO9wMdxYPVbLnd3wpQCTZRadB5bqDCrA0Se0yqYU+oGAwt5Zgbbiswsdh+u1Wvokcs18odyI=
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)(366007)(1800799015)(52116005)(7416005)(376005)(38350700005);DIR:OUT;SFP:1101;
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?clFYaEdqKzJudmFtZFlGdlBBZFlCQlp4MW5rYTgyVWhhaGVYNE1tOFZCT2Q3?=
 =?utf-8?B?NERqOVVGaytiRVNTZ2VUMkNLTnVSOGgxZ0NZU2d3b005bmJYekRaeU1UOVdn?=
 =?utf-8?B?RzIzc3dRcGNKMDQwZ3B0bThjdU53L0NraXBrSkhZYlV2UHRFTkRxNzFybVMz?=
 =?utf-8?B?YTZUdzdpVzIvQzM4RThaRVlXUlc5NHlFc3BvUlpkMDBzVDcwMlE2RUFBUW9L?=
 =?utf-8?B?OVpmZVIxWU9YeXJRS0x6Y01nd3RUVUxQYmR5NkJ6VmlJR1lCSWRyanlGUGk5?=
 =?utf-8?B?NVIwRGNFTFlVMUpxVkd1Q2NJSnRtVVYzSGt3Y21lRWNxcWk4VnkrTU4yd3dZ?=
 =?utf-8?B?bHBESm9BbXZTU1hUVlpzVE9nTTduYmdBOXNvcHVjY2s3M0hiZTluU2FhVStk?=
 =?utf-8?B?eDgzZU9GeHhyQ3Z2OVBCRDRHWm1HL1VsVEIyNFNJNDFqZ29uMHFoRGRvZ2hh?=
 =?utf-8?B?SCs4WHJNMGVESEFhd3d3V0tLNmVWNkZwcTBFKy9jWmJDK2RQK1VrNm1qR1Va?=
 =?utf-8?B?ZlRCWlNGdGlFZzRvOGQwdDZ3QWNwQmVHd1hJOVRCMWRaTEw1Y3NOOGxrS1Rw?=
 =?utf-8?B?emNpS1dqOExaNnpqUlB5TjI5S1pPRDhRTlpsVjJhMTI3U2lnclZXTHZPeUl0?=
 =?utf-8?B?dmxIR1A1UU9DZ2FqTzZ6UW9DSGorWGM3enl5S05QSVBpdzBTMjRUdk13eGs3?=
 =?utf-8?B?dncyK0dEZWFpV0grVUZFblYvVExCUUV4QVNyUVFNQklRa3lHbzVldWNPb1Nh?=
 =?utf-8?B?MTZobG56dWpoVHpJa3lzZXROc1h4WU1oc1F1c01JcWxmb1dZSncySGs3R2Vu?=
 =?utf-8?B?TitJZ1gwWjU1NkF6RUJZVndUMVBDNU1TRzdxdktoejhpbUlIejlZb2FqYWxW?=
 =?utf-8?B?NDJsd2FKR21XQ0RIb09La09mYWRuWC9QQlpBa1NkdmJSN0lGQ3FEOUxZVjd1?=
 =?utf-8?B?dzQwTDhuNTd4UHhpU0pYN1JWZEQwLzdrNXR6T1JHY1plOVgzanY4djZwVXNI?=
 =?utf-8?B?RkZWaFlROVBRSUQybFVZa0poeDRUODR1eTRJMjhYR01CWTJ3N0JhWEJqUXkz?=
 =?utf-8?B?eGhGa2RVUCt0WmxYd3pUbERZeWZ6eXlnRkJLbTdjcHJ1cUYvMXluVWZKVjBR?=
 =?utf-8?B?bG45QmRCZ0JNZUlqMmI0SnJjMC9QQ0ZaalNqQnZYdUI2bWMrSXhJeWlQeEZB?=
 =?utf-8?B?NEx5aWEzQjRHdkZlOXNlV0tmcWNPRXk1dXo3ckpCejArdnhsYlJrLytkUHhJ?=
 =?utf-8?B?OHdPMU5JUUZvdmsrRXBQa2Jvb3lFRFdXSUo2R2tXa3haMTZPeFpXY3EzNWgy?=
 =?utf-8?B?UDZWT1BoeXY5VkNrNFFiZ1pmaEptNEt5UHc4WmVIN09YOUNOU0VYTm5PaEhC?=
 =?utf-8?B?dlFPWEpXNWZuVjBta2p1ZjY0Rkc2Q1pTWG9hdkhic1MrK3NZNFFFWW1QZnhS?=
 =?utf-8?B?RVYySnI1bHR1enBnQy9Fd0JBaHR1U2F3bk5SNzdFeUQvM2VVWk1yMEs1UkxJ?=
 =?utf-8?B?bENtbG0wNVpoQXd1SUcxOFpHTGZndXFmQS9XcFVBTzROVUNLcXVKNzVVL0t0?=
 =?utf-8?B?SzN1Z2kza1VnTmNqNXBldW5hQmI4TmxTdStVTmI2Q2dXRDU2L25xYUs2ZU5t?=
 =?utf-8?B?d3E5ZWFGNThPZEZNWEgxdHdUQXpRNWNzUmp2bVdoSVI3Z3VucTlVYndqdG5H?=
 =?utf-8?B?OW44Y21iYlBYampESE0xdHJNY2VTY2VFTjY1dGRmQUN5YzZ2K0hVQ3JQVldR?=
 =?utf-8?B?YXNyVnVpdlg2U0tJT0NYd0FkejdyU1hPZUxTUmFyVFFRTW5QMHUxWW42VmRU?=
 =?utf-8?B?bTF5SkdTWHVzeGY2Y2R6Y1pGNFpzTno2cjljaWdKUEw3SDM1ZG44b3U4ZVk2?=
 =?utf-8?B?a3pIVk1qYytwU2hkclBzU2xSYlord0dkcDh2VXNQS1o4Y1FXZ01XVzVqcUIx?=
 =?utf-8?B?S0pxTmhlazNqdzdvMXVVa0svZkJQaHBDdmZVWFBpTzZNZTFZTkpCT1NJUTFh?=
 =?utf-8?B?U0JYSS9nb3oxcDFzY3BLK1M5b0VpeHRxRmY2bi9ZM29xMzV0NFBXMWF5TEVP?=
 =?utf-8?B?RXVTUXNhMmZEQ2x1UWRzNHFyTVA3b2hxbVoyallNbE1pNGJXWDZnNnRkOXFV?=
 =?utf-8?Q?6URL9e1ZFk/9Iv9F12RKyz6Iz?=
X-OriginatorOrg: oss.nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: dbc3ff96-531c-4a52-c697-08dc5a855ce3
X-MS-Exchange-CrossTenant-AuthSource: DU0PR04MB9417.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Apr 2024 00:13:21.6230
 (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: 6GCxTuZdOTM0qWrUgksjH/7eSpRZ8UqaVk1CYhnHpREq4RcktyKd1I6V5pvk2GBO+vAZ+iGgfZTXGj1nS8Axsw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM8PR04MB7970

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>
Reviewed-by: Dhruva Gole <d-gole@ti.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 36e3eb50a8d4..a1e0e8fa4bb7 100644
--- a/drivers/firmware/arm_scmi/driver.c
+++ b/drivers/firmware/arm_scmi/driver.c
@@ -1537,6 +1537,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
@@ -1848,6 +1862,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