From patchwork Thu Jul 18 07:41:54 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Peng Fan \(OSS\)" X-Patchwork-Id: 813286 Received: from AS8PR04CU009.outbound.protection.outlook.com (mail-westeuropeazon11011045.outbound.protection.outlook.com [52.101.70.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A5DE578B50; Thu, 18 Jul 2024 07:33:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.101.70.45 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721287999; cv=fail; b=IRnoJrwgrWLM8LOMmpEcmJ13g0n7HPwkFgeE0Ie+5QWnW/1M1+ZxXb8hXZ0u5DES56NHsA6H6Va74OPWGuz9at4hPBceuqCdubEsIbuMiufo32gfjyZbE4Ah+XqYfWbjZ/uVlUwWKtUxaPAcnhAHZd2L7XJF4v//8DmlQPSsYts= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721287999; c=relaxed/simple; bh=E5LpsSI+IBisa2obdH4gzsQzu8srJbB8PmQjInA7uFI=; h=From:Date:Subject:Content-Type:Message-Id:References:In-Reply-To: To:Cc:MIME-Version; b=pt0unNsT9zjIE1Tk+uTgOZCLMS8zFbIe8Jp37jGKtvvUo+a7ABzYOdbap7f0SalSbLlAvNCcRw4Npk4iy0tRKpBg3n5CsOhMX78hoM1uPCQ4D0g98oe4L8vOOrXJFBWUXRslJvAJshJ4f+CU+q6i95n5n1EimEvjgd4IL37Vlo0= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=oss.nxp.com; spf=pass smtp.mailfrom=oss.nxp.com; dkim=pass (1024-bit key) header.d=NXP1.onmicrosoft.com header.i=@NXP1.onmicrosoft.com header.b=Oi5CCZvh; arc=fail smtp.client-ip=52.101.70.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=oss.nxp.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=oss.nxp.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=NXP1.onmicrosoft.com header.i=@NXP1.onmicrosoft.com header.b="Oi5CCZvh" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=iH9N2dcvKVta1IgFEz6rVv4/1dNMMg3YjAFHI75GxLJr0kq+60DNtfnAGW5JMHGOdqOoKzq5NFHz6lsqS7oviYaW+S2a8XChEHR+PuARCh2zi/2bI6WRI5xMa6NlvKcpyDrSSg1eNaHv2zWAuJKPUe5n2HaJ+rsvKUKl12GTIhEUDvLa1wUkUXxukYT8sd7xa7Ayw0gI8P19F87l1hgg6GGiL81KyLlsUKPgdKAOY7qTOEOt9wmSQAWcUacs/bPcqh+HkVIxftQ0CRZzGKOW5uD/VbfJ/fOYfC1J0RVWt0fPLZZG6gSUWTYY+QmCLWUB+9kWGAczuYsYjw+vFMPL/g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=9xkagEKIddeT9VSxKdk2VEbIxtLknUAa+k5fp4B5DyM=; b=HRpuXqn/Wor06ycy3fUFBmve1JyE9Yvw0dShNtqbALts3+iTVuAVtjLtecpxUn6q6RPWIVs58ZGeTAymSNe3jN5VACwBx+D+CAweOj85D+Zs4a+ZjdGkS3SJOwDOGpge662TTZLi+sWFrLgdnrqUlGngYJ3O1TK8b5bS45/ELzx+jQP5sgmc8fWevziUYnSaXt73hk5Xb52p31ulqx4wqIkwa3fmHdfMa4OHFsQzA4K/UFH0ueRSeR4PtlL4GGOhk8YZckTBnhAa9/GxsdHFuGOt/FYI5hAGZkesiE4g0ImfK/kVgMIsAKhki3PyWAvDJTRh1wUj4Y2pOwpZNpq3Rg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oss.nxp.com; dmarc=pass action=none header.from=oss.nxp.com; dkim=pass header.d=oss.nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=NXP1.onmicrosoft.com; s=selector2-NXP1-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=9xkagEKIddeT9VSxKdk2VEbIxtLknUAa+k5fp4B5DyM=; b=Oi5CCZvhKJxpVdcx2q1UKiex+veXn3zq0W7rA8R0s1mi/e205mEb9oUGEAalk0EJj7GJq263exURHjC2ST45I2+ZbESSloLN2OcpL64j6vEGYTpdBt84btSskqe6ZfcBgN6OUrzdy7LIwFp+imv28yzJpXlICmPhpVoUml/3eXA= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=oss.nxp.com; Received: from PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) by DU4PR04MB10457.eurprd04.prod.outlook.com (2603:10a6:10:561::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7784.16; Thu, 18 Jul 2024 07:33:13 +0000 Received: from PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630]) by PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630%4]) with mapi id 15.20.7762.020; Thu, 18 Jul 2024 07:33:13 +0000 From: "Peng Fan (OSS)" Date: Thu, 18 Jul 2024 15:41:54 +0800 Subject: [PATCH v6 2/7] firmware: arm_scmi: add initial support for i.MX BBM protocol Message-Id: <20240718-imx95-bbm-misc-v2-v6-2-18f008e16e9d@nxp.com> References: <20240718-imx95-bbm-misc-v2-v6-0-18f008e16e9d@nxp.com> In-Reply-To: <20240718-imx95-bbm-misc-v2-v6-0-18f008e16e9d@nxp.com> To: Sudeep Holla , Cristian Marussi , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Alexandre Belloni , Dmitry Torokhov Cc: Peng Fan , arm-scmi@vger.kernel.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, imx@lists.linux.dev, linux-rtc@vger.kernel.org, linux-input@vger.kernel.org X-Mailer: b4 0.12.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1721288528; l=13923; i=peng.fan@nxp.com; s=20230812; h=from:subject:message-id; bh=m4/zUnBHrvUCml6LwbVFtKf2AEb1qkvpVEohGFcAPm0=; b=egMFvfpmIl9jECaizNKqWYP7F4mMKqfzSeHZPbApLHRLsGrqfXUvWqi6Ps2KU8bsASE4YtHZI Q1PZV9EYFvjAEqJZsXiwwLNQqmCzFWxAN2iKUqqXkQl7lvZOpZMZ8+s X-Developer-Key: i=peng.fan@nxp.com; a=ed25519; pk=I4sJg7atIT1g63H7bb5lDRGR2gJW14RKDD0wFL8TT1g= X-ClientProxiedBy: SI1PR02CA0046.apcprd02.prod.outlook.com (2603:1096:4:1f5::14) To PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) Precedence: bulk X-Mailing-List: linux-input@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: PAXPR04MB8459:EE_|DU4PR04MB10457:EE_ X-MS-Office365-Filtering-Correlation-Id: ead6aa7a-3191-4d16-205c-08dca6fbe1a6 X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|366016|52116014|376014|7416014|921020|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?q?BZJdXiBKoN3Fj6Gw/x8K8PZ8O92wfkZ?= =?utf-8?q?gw7sOTRKnIAmxd+8Yzeyeu50k7+3LHeMDD0R5H0sSJ7TvXDMRtlCnCbWMVwS6HN/o?= =?utf-8?q?ut2270Tx+mE/EPs5bfBHUY/l0e5V6hgHT80lH9SJxLopa6s8ugIIgFx1PKQCSW+MT?= =?utf-8?q?kzmCumWPVagB+dhG/FEl0GxWVAmJ9tV9DUOuZMrbY/qfJbzuZQlW7zq0CUfbmSLf9?= =?utf-8?q?mn/AuZmylDeFA1Y33XfBq+qC7Rp0OX5ESa8ox9sff2KRM/gn7Iveoufhs5gHgTpce?= =?utf-8?q?fPfhNqRxh0zknHzlInzjsvJCtE1R9JVkflfihdNaHZ0lFCOgWBtlHRbr5E0dlPUgV?= =?utf-8?q?ZEoWc+UomWrmJg+4TFkW2GFL2AqiNtkoHo0HFnjhoZB2J39g/rmUjATGB1eUkupPy?= =?utf-8?q?lwniT2umOFKNtu5tMp4O6n/RtE0GubkNGmfNAGGMoxAblNqqUOuQ66mlElN6IwTA6?= =?utf-8?q?GDA6r5Q0ulYo21It6zFwBfc9ltPr/YgNYw7ErTx8/v0VzAG6ozXWdvVbxUmU4zO92?= =?utf-8?q?KV7MU74DdYllpx8u/zIs6dIbUy6Wt1fl1XltW6RGy+/567RdfWJFezXXFOHCyp1iM?= =?utf-8?q?KcQd4BDqohvzT/sCcLQ9dmnE5jG9aHUwh6HxaXqHqgPtjlTOrMeWEd/N+om+aVN+C?= =?utf-8?q?crpU7Zlw5WMB02hyQklxY62ilQ/idoGLjZI6Teb6oahPmzkOSCJ3MNSxHl63C50aw?= =?utf-8?q?BIfIVAdGdyMSxsnk/YVGfO7hh61NDsZaqGGOO3iUuwly2QTyrVw8YK4pVdQH76+eY?= =?utf-8?q?eyhkhmqNEytirnTL5M40ZxoaAJwD4kimN6YH2FZQMgN9h2n+aL/G06lPtv4hygFAt?= =?utf-8?q?+p60VdbA3wtUjLCXW7ly9IDDp50PKAmufidPkrwgzAY0un/cC7w+03JMvb+URbtzU?= =?utf-8?q?RybgFsG0u83gJTL6epblb89p1UQCvUcrsjbv/2NMSuNm6QAjXmU7Z1HiyHSkbWa2J?= =?utf-8?q?BwPjzoqKklPKyh2W7S0sC8fz+rFCHP/tbP6af8APAKCaYrxDGbX91uog/VMmxFOsb?= =?utf-8?q?Ck4ZoeGpmXS/+B24D2yBIWys6QgqcxPCtE4vecVz0ay2u1V0mlBf4lXAmquHDSqU4?= =?utf-8?q?k6TnOVCNtubdtfdzXbIDP5v3buU0ij+mWbXr7LmRhok/V2+1d5gIlfLXtM0CFxrx8?= =?utf-8?q?/lgsgLN9GT9UZplXd3UJvoqHYH+bHumg9AMm0Dy9Rxp8LSNwHxdbWFdsKzEBU5ZXA?= =?utf-8?q?QudydRbxATAxRodn8cTvQAij/FeZruvpld8UUd8LmAPt8o8riYIt2RRqDe+d/0icn?= =?utf-8?q?GAkRyOUh3qhzhX9Nxrnx1dyQ4PAfqqSKuNajK5EJRLpcKUePmoAUlAL7yvBZF8WUb?= =?utf-8?q?nW+UV1brHBgMet8BGRnGTGLAxvk5Yh8nf731gQzSZNhV57gWUGZiAlA=3D?= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PAXPR04MB8459.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(1800799024)(366016)(52116014)(376014)(7416014)(921020)(38350700014); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?tP+IjKKeRQ+FzQxxdck5UbbNJwer?= =?utf-8?q?w/S2Wb41BPRNcnz7+O1eZAqYmVTBxqWTtGQedcJbnTe2iQdAMGG2qXce/SW9cWWpv?= =?utf-8?q?3ZDJufSf8Qk/dWwhwfkQksOtxjk281DyD4a0XWxXXhcheM8c2ncY+NOtmMnWHbd8Z?= =?utf-8?q?r3xEcBimF6oVIMqs9pGYtojT7+ChwU6RF4jNc/rQRL6rUsDdIIzCASPE+FnJh/yiZ?= =?utf-8?q?lshYDC4tWjB7OAxjAtfWWAGfYINZU2VeV6LzoRlPVMmIAKIvdvro92YUbGmqm6ZL+?= =?utf-8?q?uVShEaV9HrNZo1BQJf7OxU5ZAwl45g1jQC5ufPka9uEH7vK5bLnKByhHK26SJ1Hgt?= =?utf-8?q?TIw+0mXp+OP/VLlHPr9UIMLUecRlecPcr1KxXezk3oxF7RO4RPANm7drzGvEsWUqV?= =?utf-8?q?XKEy+FsHK6SO3gabj848Ijerb/aZmN4zlIfg91wqM94Wj8vMIzKikaV1j/ThVBqya?= =?utf-8?q?bQhMCLeLlaevGBMhLX8bHVXVKWRVwhdSRokBzE4UAmsgjKyVtisLNi8d/Za3XSYe4?= =?utf-8?q?yhp3DRx1EYS5Tj/RR5hSx/8ABAHa8+1N8NbOn5kc4p7MQb/aPNdrg2gR72Aql/0FR?= =?utf-8?q?NaIwe3PPpInDKW5HbuDVyIlCrgcaEzeSegS+O3NzFjSkIqfX9O+N9C1BRiuEkW58A?= =?utf-8?q?P9LyR/J34X92K28vBO429FQD+aV/S/6n47V5TPYogGi54ipEUXhF75yXusmTi/HLX?= =?utf-8?q?Fqga8mkXatQZadCVcRJKShyohvfG8bp6sskY5wxDdGiTht/4WAXgCbdyJQ6fnQoqR?= =?utf-8?q?mMvW+0AhntZuou/rezWY3+whloYnfqRIPqdxUim37lYEIdzYf6DfpY0Sg+TWlQF+P?= =?utf-8?q?ETykTcQli2/4FjAmi6iZjc6d48YobD5naY0nH++0dfw0gteSEWBIS2F4cOHsjkBYZ?= =?utf-8?q?FY4wnYX/8FC2nho1TS1dg2LC+RzxUNNo3CuC5aBvBDWGTDp/kSP3qcee8fZQT3nn9?= =?utf-8?q?iyXh33tE2Dc1/ztW3Owrtj2+zmvj7ahSQLJv8M1PE7oqwOMELej3qny4iu01YQzA0?= =?utf-8?q?K3FBRIuOqn6xEYP5Kc6iineVC8rQYzKw/Nz6iaGFScfNKu5p7neaAqArZpYc3aeKP?= =?utf-8?q?3vPAH2rqJs26/V1mMIZeRl1WDhL76Ch2GgbqYsesSV7tO9pi4qnQPtYXdVAPZOJNM?= =?utf-8?q?bZht0Z9A7AqNt0gYshdimUMMygNpN0f79tY+UJWCB8yjC81Xu4ifWSKGq/bA74Q2b?= =?utf-8?q?PeTFHcK0fL66QfDoMbSXUl+9wDANFY8oQnjK3Vv7BuX7ppcdmvEpxZ3zPU2W66vmb?= =?utf-8?q?rM8SV3tM4zHMj+bYSOFe9YsitobT+VbBEotkCAsjz+KGUnRJAJlPuVnJk8hDb6Qug?= =?utf-8?q?+nlQcE3xd26bOrUZp6bylVGLZ1XFvzI+xE7J/IJOdsQxalIKcO5rDMb3vQKPrcHMp?= =?utf-8?q?4ZdXx0PtmGf7lWQc3GnnQVquoKko3yIiCoPmZv73teeUzyBvN3AexbeKcPrXqJYA8?= =?utf-8?q?xw7M1mKVmO/gIXeMwsvTZOvz+JxcN8Lq7EvUkPnX0ISMj4QpuhizViD6w3g6SGcGc?= =?utf-8?q?zzNDv6nQdjWA?= X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: ead6aa7a-3191-4d16-205c-08dca6fbe1a6 X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8459.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Jul 2024 07:33:13.3919 (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: GJZlkMWJD1AC5ZiRpfDheaDiBODQiMtrcvx2wxZ4mzE6PTcQU8Z/Q16s/6pUfNh6ph1fuQgeT0YytnJ8b3BuSA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU4PR04MB10457 From: Peng Fan i.MX95 has a battery-backed module(BBM), which has persistent storage (GPR), an RTC, and the ON/OFF button. The System Manager(SM) firmware use SCMI vendor protocol(SCMI BBM) to let agent be able to use GPR, RTC and ON/OFF button. Reviewed-by: Cristian Marussi Signed-off-by: Peng Fan --- drivers/firmware/arm_scmi/Kconfig | 2 + drivers/firmware/arm_scmi/Makefile | 1 + drivers/firmware/arm_scmi/imx/Kconfig | 14 ++ drivers/firmware/arm_scmi/imx/Makefile | 2 + drivers/firmware/arm_scmi/imx/imx-sm-bbm.c | 379 +++++++++++++++++++++++++++++ include/linux/scmi_imx_protocol.h | 42 ++++ 6 files changed, 440 insertions(+) diff --git a/drivers/firmware/arm_scmi/Kconfig b/drivers/firmware/arm_scmi/Kconfig index aa5842be19b2..79846cbaf71b 100644 --- a/drivers/firmware/arm_scmi/Kconfig +++ b/drivers/firmware/arm_scmi/Kconfig @@ -180,4 +180,6 @@ config ARM_SCMI_POWER_CONTROL called scmi_power_control. Note this may needed early in boot to catch early shutdown/reboot SCMI requests. +source "drivers/firmware/arm_scmi/imx/Kconfig" + endmenu diff --git a/drivers/firmware/arm_scmi/Makefile b/drivers/firmware/arm_scmi/Makefile index fd59f58ce8a2..fb9407fef60c 100644 --- a/drivers/firmware/arm_scmi/Makefile +++ b/drivers/firmware/arm_scmi/Makefile @@ -16,6 +16,7 @@ scmi-module-objs := $(scmi-driver-y) $(scmi-protocols-y) $(scmi-transport-y) obj-$(CONFIG_ARM_SCMI_PROTOCOL) += scmi-core.o obj-$(CONFIG_ARM_SCMI_PROTOCOL) += scmi-module.o +obj-$(CONFIG_ARM_SCMI_PROTOCOL) += imx/ obj-$(CONFIG_ARM_SCMI_POWER_CONTROL) += scmi_power_control.o diff --git a/drivers/firmware/arm_scmi/imx/Kconfig b/drivers/firmware/arm_scmi/imx/Kconfig new file mode 100644 index 000000000000..4b6ac7febe8f --- /dev/null +++ b/drivers/firmware/arm_scmi/imx/Kconfig @@ -0,0 +1,14 @@ +# SPDX-License-Identifier: GPL-2.0-only +menu "ARM SCMI NXP i.MX Vendor Protocols" + +config IMX_SCMI_BBM_EXT + tristate "i.MX SCMI BBM EXTENSION" + depends on ARM_SCMI_PROTOCOL || (COMPILE_TEST && OF) + default y if ARCH_MXC + help + This enables i.MX System BBM control logic which supports RTC + and BUTTON. + + This driver can also be built as a module. + +endmenu diff --git a/drivers/firmware/arm_scmi/imx/Makefile b/drivers/firmware/arm_scmi/imx/Makefile new file mode 100644 index 000000000000..a7dbdd20dbb9 --- /dev/null +++ b/drivers/firmware/arm_scmi/imx/Makefile @@ -0,0 +1,2 @@ +# SPDX-License-Identifier: GPL-2.0-only +obj-$(CONFIG_IMX_SCMI_BBM_EXT) += imx-sm-bbm.o diff --git a/drivers/firmware/arm_scmi/imx/imx-sm-bbm.c b/drivers/firmware/arm_scmi/imx/imx-sm-bbm.c new file mode 100644 index 000000000000..017183caaadb --- /dev/null +++ b/drivers/firmware/arm_scmi/imx/imx-sm-bbm.c @@ -0,0 +1,379 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * System Control and Management Interface (SCMI) NXP BBM Protocol + * + * Copyright 2024 NXP + */ + +#define pr_fmt(fmt) "SCMI Notifications BBM - " fmt + +#include +#include +#include +#include +#include +#include +#include + +#include "../protocols.h" +#include "../notify.h" + +#define SCMI_PROTOCOL_SUPPORTED_VERSION 0x10000 + +enum scmi_imx_bbm_protocol_cmd { + IMX_BBM_GPR_SET = 0x3, + IMX_BBM_GPR_GET = 0x4, + IMX_BBM_RTC_ATTRIBUTES = 0x5, + IMX_BBM_RTC_TIME_SET = 0x6, + IMX_BBM_RTC_TIME_GET = 0x7, + IMX_BBM_RTC_ALARM_SET = 0x8, + IMX_BBM_BUTTON_GET = 0x9, + IMX_BBM_RTC_NOTIFY = 0xA, + IMX_BBM_BUTTON_NOTIFY = 0xB, +}; + +#define GET_RTCS_NR(x) le32_get_bits((x), GENMASK(23, 16)) +#define GET_GPRS_NR(x) le32_get_bits((x), GENMASK(15, 0)) + +#define SCMI_IMX_BBM_NOTIFY_RTC_UPDATED BIT(2) +#define SCMI_IMX_BBM_NOTIFY_RTC_ROLLOVER BIT(1) +#define SCMI_IMX_BBM_NOTIFY_RTC_ALARM BIT(0) + +#define SCMI_IMX_BBM_RTC_ALARM_ENABLE_FLAG BIT(0) + +#define SCMI_IMX_BBM_NOTIFY_RTC_FLAG \ + (SCMI_IMX_BBM_NOTIFY_RTC_UPDATED | SCMI_IMX_BBM_NOTIFY_RTC_ROLLOVER | \ + SCMI_IMX_BBM_NOTIFY_RTC_ALARM) + +#define SCMI_IMX_BBM_EVENT_RTC_MASK GENMASK(31, 24) + +struct scmi_imx_bbm_info { + u32 version; + int nr_rtc; + int nr_gpr; +}; + +struct scmi_msg_imx_bbm_protocol_attributes { + __le32 attributes; +}; + +struct scmi_imx_bbm_set_time { + __le32 id; + __le32 flags; + __le32 value_low; + __le32 value_high; +}; + +struct scmi_imx_bbm_get_time { + __le32 id; + __le32 flags; +}; + +struct scmi_imx_bbm_alarm_time { + __le32 id; + __le32 flags; + __le32 value_low; + __le32 value_high; +}; + +struct scmi_msg_imx_bbm_rtc_notify { + __le32 rtc_id; + __le32 flags; +}; + +struct scmi_msg_imx_bbm_button_notify { + __le32 flags; +}; + +struct scmi_imx_bbm_notify_payld { + __le32 flags; +}; + +static int scmi_imx_bbm_attributes_get(const struct scmi_protocol_handle *ph, + struct scmi_imx_bbm_info *pi) +{ + int ret; + struct scmi_xfer *t; + struct scmi_msg_imx_bbm_protocol_attributes *attr; + + ret = ph->xops->xfer_get_init(ph, PROTOCOL_ATTRIBUTES, 0, sizeof(*attr), &t); + if (ret) + return ret; + + attr = t->rx.buf; + + ret = ph->xops->do_xfer(ph, t); + if (!ret) { + pi->nr_rtc = GET_RTCS_NR(attr->attributes); + pi->nr_gpr = GET_GPRS_NR(attr->attributes); + } + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int scmi_imx_bbm_notify(const struct scmi_protocol_handle *ph, + u32 src_id, int message_id, bool enable) +{ + int ret; + struct scmi_xfer *t; + + if (message_id == IMX_BBM_RTC_NOTIFY) { + struct scmi_msg_imx_bbm_rtc_notify *rtc_notify; + + ret = ph->xops->xfer_get_init(ph, message_id, + sizeof(*rtc_notify), 0, &t); + if (ret) + return ret; + + rtc_notify = t->tx.buf; + rtc_notify->rtc_id = cpu_to_le32(0); + rtc_notify->flags = + cpu_to_le32(enable ? SCMI_IMX_BBM_NOTIFY_RTC_FLAG : 0); + } else if (message_id == IMX_BBM_BUTTON_NOTIFY) { + struct scmi_msg_imx_bbm_button_notify *button_notify; + + ret = ph->xops->xfer_get_init(ph, message_id, + sizeof(*button_notify), 0, &t); + if (ret) + return ret; + + button_notify = t->tx.buf; + button_notify->flags = cpu_to_le32(enable ? 1 : 0); + } else { + return -EINVAL; + } + + ret = ph->xops->do_xfer(ph, t); + + ph->xops->xfer_put(ph, t); + return ret; +} + +static enum scmi_imx_bbm_protocol_cmd evt_2_cmd[] = { + IMX_BBM_RTC_NOTIFY, + IMX_BBM_BUTTON_NOTIFY +}; + +static int scmi_imx_bbm_set_notify_enabled(const struct scmi_protocol_handle *ph, + u8 evt_id, u32 src_id, bool enable) +{ + int ret, cmd_id; + + if (evt_id >= ARRAY_SIZE(evt_2_cmd)) + return -EINVAL; + + cmd_id = evt_2_cmd[evt_id]; + ret = scmi_imx_bbm_notify(ph, src_id, cmd_id, enable); + if (ret) + pr_debug("FAIL_ENABLED - evt[%X] dom[%d] - ret:%d\n", + evt_id, src_id, ret); + + return ret; +} + +static void *scmi_imx_bbm_fill_custom_report(const struct scmi_protocol_handle *ph, + u8 evt_id, ktime_t timestamp, + const void *payld, size_t payld_sz, + void *report, u32 *src_id) +{ + const struct scmi_imx_bbm_notify_payld *p = payld; + struct scmi_imx_bbm_notif_report *r = report; + + if (sizeof(*p) != payld_sz) + return NULL; + + if (evt_id == SCMI_EVENT_IMX_BBM_RTC) { + r->is_rtc = true; + r->is_button = false; + r->timestamp = timestamp; + r->rtc_id = le32_get_bits(p->flags, SCMI_IMX_BBM_EVENT_RTC_MASK); + r->rtc_evt = le32_get_bits(p->flags, SCMI_IMX_BBM_NOTIFY_RTC_FLAG); + dev_dbg(ph->dev, "RTC: %d evt: %x\n", r->rtc_id, r->rtc_evt); + *src_id = r->rtc_evt; + } else if (evt_id == SCMI_EVENT_IMX_BBM_BUTTON) { + r->is_rtc = false; + r->is_button = true; + r->timestamp = timestamp; + dev_dbg(ph->dev, "BBM Button\n"); + *src_id = 0; + } else { + WARN_ON_ONCE(1); + return NULL; + } + + return r; +} + +static const struct scmi_event scmi_imx_bbm_events[] = { + { + .id = SCMI_EVENT_IMX_BBM_RTC, + .max_payld_sz = sizeof(struct scmi_imx_bbm_notify_payld), + .max_report_sz = sizeof(struct scmi_imx_bbm_notif_report), + }, + { + .id = SCMI_EVENT_IMX_BBM_BUTTON, + .max_payld_sz = sizeof(struct scmi_imx_bbm_notify_payld), + .max_report_sz = sizeof(struct scmi_imx_bbm_notif_report), + }, +}; + +static const struct scmi_event_ops scmi_imx_bbm_event_ops = { + .set_notify_enabled = scmi_imx_bbm_set_notify_enabled, + .fill_custom_report = scmi_imx_bbm_fill_custom_report, +}; + +static const struct scmi_protocol_events scmi_imx_bbm_protocol_events = { + .queue_sz = SCMI_PROTO_QUEUE_SZ, + .ops = &scmi_imx_bbm_event_ops, + .evts = scmi_imx_bbm_events, + .num_events = ARRAY_SIZE(scmi_imx_bbm_events), + .num_sources = 1, +}; + +static int scmi_imx_bbm_rtc_time_set(const struct scmi_protocol_handle *ph, + u32 rtc_id, u64 sec) +{ + struct scmi_imx_bbm_info *pi = ph->get_priv(ph); + struct scmi_imx_bbm_set_time *cfg; + struct scmi_xfer *t; + int ret; + + if (rtc_id >= pi->nr_rtc) + return -EINVAL; + + ret = ph->xops->xfer_get_init(ph, IMX_BBM_RTC_TIME_SET, sizeof(*cfg), 0, &t); + if (ret) + return ret; + + cfg = t->tx.buf; + cfg->id = cpu_to_le32(rtc_id); + cfg->flags = 0; + cfg->value_low = cpu_to_le32(lower_32_bits(sec)); + cfg->value_high = cpu_to_le32(upper_32_bits(sec)); + + ret = ph->xops->do_xfer(ph, t); + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int scmi_imx_bbm_rtc_time_get(const struct scmi_protocol_handle *ph, + u32 rtc_id, u64 *value) +{ + struct scmi_imx_bbm_info *pi = ph->get_priv(ph); + struct scmi_imx_bbm_get_time *cfg; + struct scmi_xfer *t; + int ret; + + if (rtc_id >= pi->nr_rtc) + return -EINVAL; + + ret = ph->xops->xfer_get_init(ph, IMX_BBM_RTC_TIME_GET, sizeof(*cfg), + sizeof(u64), &t); + if (ret) + return ret; + + cfg = t->tx.buf; + cfg->id = cpu_to_le32(rtc_id); + cfg->flags = 0; + + ret = ph->xops->do_xfer(ph, t); + if (!ret) + *value = get_unaligned_le64(t->rx.buf); + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int scmi_imx_bbm_rtc_alarm_set(const struct scmi_protocol_handle *ph, + u32 rtc_id, bool enable, u64 sec) +{ + struct scmi_imx_bbm_info *pi = ph->get_priv(ph); + struct scmi_imx_bbm_alarm_time *cfg; + struct scmi_xfer *t; + int ret; + + if (rtc_id >= pi->nr_rtc) + return -EINVAL; + + ret = ph->xops->xfer_get_init(ph, IMX_BBM_RTC_ALARM_SET, sizeof(*cfg), 0, &t); + if (ret) + return ret; + + cfg = t->tx.buf; + cfg->id = cpu_to_le32(rtc_id); + cfg->flags = enable ? SCMI_IMX_BBM_RTC_ALARM_ENABLE_FLAG : 0; + cfg->value_low = cpu_to_le32(lower_32_bits(sec)); + cfg->value_high = cpu_to_le32(upper_32_bits(sec)); + + ret = ph->xops->do_xfer(ph, t); + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int scmi_imx_bbm_button_get(const struct scmi_protocol_handle *ph, u32 *state) +{ + struct scmi_xfer *t; + int ret; + + ret = ph->xops->xfer_get_init(ph, IMX_BBM_BUTTON_GET, 0, sizeof(u32), &t); + if (ret) + return ret; + + ret = ph->xops->do_xfer(ph, t); + if (!ret) + *state = get_unaligned_le32(t->rx.buf); + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static const struct scmi_imx_bbm_proto_ops scmi_imx_bbm_proto_ops = { + .rtc_time_get = scmi_imx_bbm_rtc_time_get, + .rtc_time_set = scmi_imx_bbm_rtc_time_set, + .rtc_alarm_set = scmi_imx_bbm_rtc_alarm_set, + .button_get = scmi_imx_bbm_button_get, +}; + +static int scmi_imx_bbm_protocol_init(const struct scmi_protocol_handle *ph) +{ + u32 version; + int ret; + struct scmi_imx_bbm_info *binfo; + + ret = ph->xops->version_get(ph, &version); + if (ret) + return ret; + + dev_info(ph->dev, "NXP SM BBM Version %d.%d\n", + PROTOCOL_REV_MAJOR(version), PROTOCOL_REV_MINOR(version)); + + binfo = devm_kzalloc(ph->dev, sizeof(*binfo), GFP_KERNEL); + if (!binfo) + return -ENOMEM; + + ret = scmi_imx_bbm_attributes_get(ph, binfo); + if (ret) + return ret; + + return ph->set_priv(ph, binfo, version); +} + +static const struct scmi_protocol scmi_imx_bbm = { + .id = SCMI_PROTOCOL_IMX_BBM, + .owner = THIS_MODULE, + .instance_init = &scmi_imx_bbm_protocol_init, + .ops = &scmi_imx_bbm_proto_ops, + .events = &scmi_imx_bbm_protocol_events, + .supported_version = SCMI_PROTOCOL_SUPPORTED_VERSION, + .vendor_id = "NXP", + .sub_vendor_id = "IMX", +}; +module_scmi_protocol(scmi_imx_bbm); diff --git a/include/linux/scmi_imx_protocol.h b/include/linux/scmi_imx_protocol.h new file mode 100644 index 000000000000..2df2ea0f1809 --- /dev/null +++ b/include/linux/scmi_imx_protocol.h @@ -0,0 +1,42 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* + * SCMI Message Protocol driver NXP extension header + * + * Copyright 2024 NXP. + */ + +#ifndef _LINUX_SCMI_NXP_PROTOCOL_H +#define _LINUX_SCMI_NXP_PROTOCOL_H + +#include +#include +#include +#include + +enum scmi_nxp_protocol { + SCMI_PROTOCOL_IMX_BBM = 0x81, +}; + +struct scmi_imx_bbm_proto_ops { + int (*rtc_time_set)(const struct scmi_protocol_handle *ph, u32 id, + uint64_t sec); + int (*rtc_time_get)(const struct scmi_protocol_handle *ph, u32 id, + u64 *val); + int (*rtc_alarm_set)(const struct scmi_protocol_handle *ph, u32 id, + bool enable, u64 sec); + int (*button_get)(const struct scmi_protocol_handle *ph, u32 *state); +}; + +enum scmi_nxp_notification_events { + SCMI_EVENT_IMX_BBM_RTC = 0x0, + SCMI_EVENT_IMX_BBM_BUTTON = 0x1, +}; + +struct scmi_imx_bbm_notif_report { + bool is_rtc; + bool is_button; + ktime_t timestamp; + unsigned int rtc_id; + unsigned int rtc_evt; +}; +#endif From patchwork Thu Jul 18 07:41:56 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Peng Fan \(OSS\)" X-Patchwork-Id: 813285 Received: from DU2PR03CU002.outbound.protection.outlook.com (mail-northeuropeazon11012059.outbound.protection.outlook.com [52.101.66.59]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id F1E637D3E3; Thu, 18 Jul 2024 07:33:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.101.66.59 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721288011; cv=fail; b=tmf64epBxmqw9v3S7Yx7sN9ra7QNFqmkqvHHoQhcbrFxIylJicLz4YtuwO3Elm/3En8JzPm4L6nYxAjS9B4B7yEu5vrlZR+B1e8vuzHXiPg/Y6XHFiocbp6wrdwqSjWsSVxGA6OgGsgS2KHorB99krcAMi5l3meomG/6tWKV7DA= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721288011; c=relaxed/simple; bh=5R7x1rhj1TYPjKc6u9bHCeGcNZSKvIA3B92jHkks3vc=; h=From:Date:Subject:Content-Type:Message-Id:References:In-Reply-To: To:Cc:MIME-Version; b=p5N2+ZTk9k8S+Z13ECohIHKHE/cTa6tzGtRKq5ruI814Xv46BrjPOIzN4lGkvaNQV1o4FKbLyB2pNk9BRp/2ob115n0bLmt/qwN0c8wf7PpMNLLrmVED+7SxI/rQ/3VZypFcWNyDfNCJ7vV5tl9xXZr57oVwOxcvdN+3oZok/Pw= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=oss.nxp.com; spf=pass smtp.mailfrom=oss.nxp.com; dkim=pass (1024-bit key) header.d=NXP1.onmicrosoft.com header.i=@NXP1.onmicrosoft.com header.b=Kmj/4G//; arc=fail smtp.client-ip=52.101.66.59 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=oss.nxp.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=oss.nxp.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=NXP1.onmicrosoft.com header.i=@NXP1.onmicrosoft.com header.b="Kmj/4G//" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=phAc4YjfyWp1MBM+k94ffWsPu6EDkJKSgp9ql978R0eF/bdyXcXen8waCJDEbgYwQIXD1sjalWRGR+A26E5LENrAjV7LmX0XIZnYPd1BQ9T5fAIKldh35cGENHF5XM88CDZcFdB67l9uXmtCFkQFMvPecOmADeWg/TOxqQ5mMTBSq9L7Mr3H75RaDTw9NPinei+CldJVbkY/MZtU5fUmL+1IQ94/Eif8qC5yzJW0CJ6IO4zqKY89yJ7cqYonjmAQKJuGukNKmTfSqFIA5fkMpn7/RxFFbqjppgUA0SOMSm2FUX2MZiJbVav0NGi9WvALSW55AMCMhHD0b0pK1HkUfw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=VKqRmRGJCU2bjse9FkKJJPqPuq+AJgTGg1aQq7hRCcE=; b=izaTKtp6jfTqRWCExDTLt3Gc9nfXaYRWbvberXwLO0j02vm3PcBoPiTN1jW9GFZAT1Bl0NBRv1+uk9800Mhaoci9WrDI8CIKqWVr1TYoy8ViEEWbVzmhgL/K//QfOZHAJd9qJ2lVSNZ252dXAoxPwdUZ5hqAOh0vsNdavhYW1SXpO8aGImNGA67y9GFKMlHkMTQI1y4rg6eN56xuml87X/nmLPIhaf8R4N9HafatsVV72Fwa/30jRUCZLyxa9fMn58saCfpkJR24/L0Wh2a/0yBjJM2uO2uN7w6LhIdET6wC4JBDTRyjngiLVoIbKe5ZA7KibL7YC2bdaHsZevODNQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oss.nxp.com; dmarc=pass action=none header.from=oss.nxp.com; dkim=pass header.d=oss.nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=NXP1.onmicrosoft.com; s=selector2-NXP1-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=VKqRmRGJCU2bjse9FkKJJPqPuq+AJgTGg1aQq7hRCcE=; b=Kmj/4G//guzz0UaUPo0PQ6H/cDo+SgqPfVPVOptPY7tB8AN2NhOqguWD2rx6aUcBfKjXBJuL10MRdBG40bALoj0kUd21QTGSXK517mVgc+gz4gYUwOjNdylNZDV5K6qL3JG3uVOVOvdNq5NwvpjTe9A5SsNfHfAsvZmo9ZSeUsU= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=oss.nxp.com; Received: from PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) by DU4PR04MB10457.eurprd04.prod.outlook.com (2603:10a6:10:561::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7784.16; Thu, 18 Jul 2024 07:33:24 +0000 Received: from PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630]) by PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630%4]) with mapi id 15.20.7762.020; Thu, 18 Jul 2024 07:33:24 +0000 From: "Peng Fan (OSS)" Date: Thu, 18 Jul 2024 15:41:56 +0800 Subject: [PATCH v6 4/7] firmware: arm_scmi: add NXP i.MX95 SCMI documentation Message-Id: <20240718-imx95-bbm-misc-v2-v6-4-18f008e16e9d@nxp.com> References: <20240718-imx95-bbm-misc-v2-v6-0-18f008e16e9d@nxp.com> In-Reply-To: <20240718-imx95-bbm-misc-v2-v6-0-18f008e16e9d@nxp.com> To: Sudeep Holla , Cristian Marussi , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Alexandre Belloni , Dmitry Torokhov Cc: Peng Fan , arm-scmi@vger.kernel.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, imx@lists.linux.dev, linux-rtc@vger.kernel.org, linux-input@vger.kernel.org X-Mailer: b4 0.12.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1721288528; l=55298; i=peng.fan@nxp.com; s=20230812; h=from:subject:message-id; bh=awGI47uCRhda8RgNOE4cyUBLlzqkWBO1IIkfhQqujqA=; b=NWUroJqmgV5POPZ5+CH8a616/CC7X1nDFU98BjRvzr0iCDaSjdWyX3TbdzoC1vfx90i8DptmO UNhMqh0lFf2AUqToJBkzrDkT0F41osn2N/OqA017GrA5TvNrIcKKRxe X-Developer-Key: i=peng.fan@nxp.com; a=ed25519; pk=I4sJg7atIT1g63H7bb5lDRGR2gJW14RKDD0wFL8TT1g= X-ClientProxiedBy: SI1PR02CA0046.apcprd02.prod.outlook.com (2603:1096:4:1f5::14) To PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) Precedence: bulk X-Mailing-List: linux-input@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: PAXPR04MB8459:EE_|DU4PR04MB10457:EE_ X-MS-Office365-Filtering-Correlation-Id: 3c1ba13c-7b10-4f40-924c-08dca6fbe817 X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|366016|52116014|376014|7416014|921020|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?q?i7Ke3key800+B/LEEVXMTiN455/akYp?= =?utf-8?q?OuviBZP0R3QIa8ERVbqo1XzarE2IrcV38MYUVLxv/PjXzL9wj/wwtP3OodF0AO8xp?= =?utf-8?q?mcFQGkXrcHJzqP1wjhZ2orrVGSM0W/eYqMhG8MHoP+IP5Mymgviny94dIBPdi/A2o?= =?utf-8?q?BhfyAnorVWDif8jGUaH4E3UWm8fDgZJsiX8Spmw5VAb3OSkqAjHXcSniM5/BRIuNF?= =?utf-8?q?5rqdczo/Qulb+3yrOjwZDlEhjA7/VBTJZ5sSerdD14Qnz4Re6PwmucF9X1iKlHMmR?= =?utf-8?q?RoY2MYrdGfMgL4K4WoAl2zyDGKbgXhspl61FemvNy3IfRqXNTgk/xAfh6ClNsP0X1?= =?utf-8?q?nZYkSEtERt2YxaLsT0jHnC+cIOYKgBRgGuFEE/J3BEG70j+NepPPKnD0mX1J30olZ?= =?utf-8?q?+06q61tf+XGjnTNOKmkaEDGL3HzaMUw6g13Dknt5IQvUrYZ91e4NL68DC8HLZtdDw?= =?utf-8?q?WcqQYkz7/C2qcSsRxZ1/mImPSr+AzgLlpRYssCN0Tr1SqIBUkJZwAglVM262R02aT?= =?utf-8?q?LzFyCR/9AUFHdW6k5LCIi993+VzGBnODmh7RcSqEe3UHG3OTSU9SpuEtL6d9Ye2U5?= =?utf-8?q?2bgOIMtwC/4PwRQ1LOc85YshB3aLajffO3WkpK6Wu9L7TkOkZaa9ASTHHkWwbcD9c?= =?utf-8?q?SW9kRodsa0pAgf5f2Ifo3FORVG/6Iis/NNUYnTGg4qzbPHBBsIUgmcgRelxWZB1y/?= =?utf-8?q?SDLnl00HbZ8lbX36dqYaXNwkiWSUJ8o2NaGwh4COFT9S32e/D0PWXEL00cKhv2ooO?= =?utf-8?q?yGwDxvrHXcjV8RRrxQ64gznJiPDxa6khKVvcg7+xLFeNjMpXTmAt3rExToUs458ix?= =?utf-8?q?U5XgrxXjipuf4dQ45sr9HNv2YolRal+Lib9mrirGK3fj4TzWSAnM20OzLluJdU3/k?= =?utf-8?q?N3bHcUdjRP4fe27awRth4TTyaa1pyuDmh7z0ReDWh/e0qGZav+bKR2e5BtmEKjhog?= =?utf-8?q?zaakws04dghxfnc/mgW025ZuwCzRGP3d1j1owOJQ7VmPgpw9Ujg71htizu+EXlFLV?= =?utf-8?q?7AOSGgiprFt1TJ6C7r4mH9IgN0BI4oXlfu8pPTpKh1OjTl4SJ0uGw6OBGv5fXZhcR?= =?utf-8?q?JjZ8WBPEC6Sh/p1bj3YWvqxaUeXf2T/D8VsYMN8jkWn6nHoP7ukzyUj26F+n/d80r?= =?utf-8?q?MFHFF4OmoX2jFll0vNacl7lNkXC9iP9bGC8WYTHkgk01tW7wYkWPlLvuRjdZaQfxr?= =?utf-8?q?dN0LrFS7wVS+oFt7DeS8+BLOjMyKaDicyNYf13/JOP75KX5obUU/EoXxhKygc8Jry?= =?utf-8?q?bziyXhYNQrU6PPFJngs4KmGJVmHKzYd64hMuGRAPPgdhW3y8CGSmfGct4p789Hjlb?= =?utf-8?q?cnSoRm+/mOUeSAsNEx9cy7Snmk9W99oNjOhvMIyER37ncYDBsrq1gHY=3D?= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PAXPR04MB8459.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(1800799024)(366016)(52116014)(376014)(7416014)(921020)(38350700014); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?JIJZAc9Yg97jFJMBczR+q0Nlw9/D?= =?utf-8?q?BOpczO1aEjDXSEoeojwL2BmB6q4Vqmj5d+z7E+8eiycTaoyZO+RHOTUkIe+hPH7LK?= =?utf-8?q?xn1IUVaIS7hNbO3iCxeFqNYIO+yMTPbUtxpClcRUpBenu3DUbm0Vl8Ra05O6R6uaJ?= =?utf-8?q?jOYDbYm+Ia1B+sBGxNu1WFN606M+QmJVM/+v3lQq74U9dfRpl6g0dYdf7F1b/YhtP?= =?utf-8?q?d0yQD7V1RnJ6AJvkGecs56liI6LOWMAEJ/kVT13W1HD9nfXcSS5t86WpEh1RhVSY3?= =?utf-8?q?dOKD9Oh/8PVJzTFrcvUvW7WZ9RF5pPRCTgBtLz//BcG4KJvrcmbWhcsMHq5DsaTAj?= =?utf-8?q?JgwURbXY4XcHo5T1RcPjjfUB93P0ulnLO8TqQ9aPmCgdvvvWtFcUymNFon6KmT9qy?= =?utf-8?q?HjnLJQ5CM81/3i5l25MGr9nV+i59curyoRrYLlWWRcBkh1kEHcKDaMMaMAAOx3JLY?= =?utf-8?q?jm7/QkKqgqjq8uWOKt0xaV2tzEDtaQ6iXTDM0s229OAmJnaxrdjf93E4kqa0WdP91?= =?utf-8?q?+pfOFiJPdkcJcm4T2u+KFxTy02kFZBJasGSzS1YWMzG5qrxQeWucQfbHwf4Rb6xc2?= =?utf-8?q?ooTgzUoTbc445JSgchSMU6Z+PopgsLFatSKJP4e3HT5biX9swIu8YYtRp7PnE+SOf?= =?utf-8?q?Z2uN0wTRQVra0XgVLXBWIJc5I2NgBnLz1Gs8yN0mpePY/1p2ITK7jHnNT+jvqXgx7?= =?utf-8?q?EuY9AchPHKG+Z2GoBBz8bbtCoovDmzTUiQFdvLuaAzRuXypem1tFg8JNRFC1n6XlP?= =?utf-8?q?lKEwfWQJpwpAmg4pCLNE1Lhv3MY9000c/LW1ysndl2g/FO1WxcRgDUmlZSV+ffWxx?= =?utf-8?q?5OCMaePnQkq8mvyWGpKaazpSR/4b+0LmIbTACwCP44hca2tfVc012gvWXIsHthNlI?= =?utf-8?q?bt/VhEkr5y01kDqzLR4Gz2/Dh+cTAuldf/lcPX8bCsyLFTnNsYLS7CxkcGUA/m5k2?= =?utf-8?q?hkBiv0BfoZcXNpsW5xoaBX17hhK02lhU1d5sT92XsNYKTSZKeyiR89SmVsV81w5HZ?= =?utf-8?q?/5KJUN8KqPlLiwXKAvJnMogzsgTiEdgJim3B9/pJT+WLY8emKUzWvE6tCVnryioIR?= =?utf-8?q?1LYj51uZLy49zRlICAxbJdIOpfArq8BXN0Dq7KC5ZuI6A7OZFSprvz/nv0hMsUPRD?= =?utf-8?q?SEbDmX5dZZxvO8ExWNM/aFJ5WyGRgxj4osRYzwajaauuz9HwapfSYtRNfNHLaGFZB?= =?utf-8?q?TSr02s91yJOZ3gEnO31L31hp4x8iNLynw9DYMTBm9b6CyC97o7eeQmMeIN5lJ76Ir?= =?utf-8?q?IAA2TY+SQcn9PMqxMOjFFBbaRLkcqAt4AOdtPLbmBMh51OoxziNV1IUvMtvbS5zBp?= =?utf-8?q?Mebix4afznm7ui0Wo1WG7lIPkldd8UdCyvgRZufhkEmcV0dQLaZ/TsXuGuq3d+GI1?= =?utf-8?q?5C/qz0Jcwd8CpbekMYTobMXqoi4WUAeM+g+cCDkOlXXnMLlBpbvb4ZCkKIJWaeORu?= =?utf-8?q?bjuzh7JwQWw3ymVMJfjqjXwouRVfjXo8oC0U5EGATVlTwWDLdxgQl7dr8Ia1JIzNY?= =?utf-8?q?Kf9YDlfLAyLF?= X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 3c1ba13c-7b10-4f40-924c-08dca6fbe817 X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8459.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Jul 2024 07:33:24.2681 (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: gQAIdG7RF85lEL88BJQpHNgkypHYJYd6rHXhv2kQH9MHVsV2FDL77OWz5DejWj3sGLp3fg2dm3NcRMbZQSAIVA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU4PR04MB10457 From: Peng Fan Add NXP i.MX95 System Control Management Interface(SCMI) vendor extensions protocol documentation. Reviewed-by: Cristian Marussi Signed-off-by: Peng Fan --- drivers/firmware/arm_scmi/imx/imx95.rst | 886 ++++++++++++++++++++++++++++++++ 1 file changed, 886 insertions(+) diff --git a/drivers/firmware/arm_scmi/imx/imx95.rst b/drivers/firmware/arm_scmi/imx/imx95.rst new file mode 100644 index 000000000000..6a9e53c17df1 --- /dev/null +++ b/drivers/firmware/arm_scmi/imx/imx95.rst @@ -0,0 +1,886 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. include:: + +=============================================================================== +i.MX95 System Control and Management Interface(SCMI) Vendor Protocols Extension +=============================================================================== + +:Copyright: |copy| 2024 NXP + +:Author: Peng Fan + +The System Manager (SM) is a low-level system function which runs on a System +Control Processor (SCP) to support isolation and management of power domains, +clocks, resets, sensors, pins, etc. on complex application processors. It often +runs on a Cortex-M processor and provides an abstraction to many of the +underlying features of the hardware. The primary purpose of the SM is to allow +isolation between software running on different cores in the SoC. It does this +by having exclusive access to critical resources such as those controlling +power, clocks, reset, PMIC, etc. and then providing an RPC interface to those +clients. This allows the SM to provide access control, arbitration, and +aggregation policies for those shared critical resources. + +SM introduces a concept Logic Machine(LM) which is analogous to VM and each has +its own instance of SCMI. All normal SCMI calls only apply to that LM. That +includes boot, shutdown, reset, suspend, wake, etc. Each LM (e.g. A55 and M7) +are completely isolated from the others and each LM has its own communication +channels talking to the same SCMI server. + +This document covers all the information necessary to understand, maintain, +port, and deploy the SM on supported processors. + +The SM implements an interface compliant with the Arm SCMI Specification +with additional vendor specific extensions. + +SCMI_BBM: System Control and Management BBM Vendor Protocol +============================================================== + +This protocol is intended provide access to the battery-backed module. This +contains persistent storage (GPR), an RTC, and the ON/OFF button. The protocol +can also provide access to similar functions implemented via external board +components. The BBM protocol provides functions to: + +- Describe the protocol version. +- Discover implementation attributes. +- Read/write GPR +- Discover the RTCs available in the system. +- Read/write the RTC time in seconds and ticks +- Set an alarm (per LM) in seconds +- Get notifications on RTC update, alarm, or rollover. +- Get notification on ON/OFF button activity. + +For most SoC, there is one on-chip RTC (e.g. in BBNSM) and this is RTC ID 0. +Board code can add additional GPR and RTC. + +GPR are not aggregated. The RTC time is also not aggregated. Setting these +sets for all so normally exclusive access would be granted to one agent for +each. However, RTC alarms are maintained for each LM and the hardware is +programmed with the next nearest alarm time. So only one agent in an LM should +be given access rights to set an RTC alarm. + +Commands: +_________ + +PROTOCOL_VERSION +~~~~~~~~~~~~~~~~ + +message_id: 0x0 +protocol_id: 0x81 + ++---------------+--------------------------------------------------------------+ +|Return values | ++---------------+--------------------------------------------------------------+ +|Name |Description | ++---------------+--------------------------------------------------------------+ +|int32 status | See ARM SCMI Specification for status code definitions. | ++---------------+--------------------------------------------------------------+ +|uint32 version | For this revision of the specification, this value must be | +| | 0x10000. | ++---------------+--------------------------------------------------------------+ + +PROTOCOL_ATTRIBUTES +~~~~~~~~~~~~~~~~~~~ + +message_id: 0x1 +protocol_id: 0x81 + ++---------------+--------------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status | See ARM SCMI Specification for status code definitions. | ++------------------+-----------------------------------------------------------+ +|uint32 attributes | Bits[31:8] Number of RTCs. | +| | Bits[15:0] Number of persistent storage (GPR) words. | ++------------------+-----------------------------------------------------------+ + +PROTOCOL_MESSAGE_ATTRIBUTES +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +message_id: 0x2 +protocol_id: 0x81 + ++---------------+--------------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: in case the message is implemented and available | +| |to use. | +| |NOT_FOUND: if the message identified by message_id is | +| |invalid or not implemented | ++------------------+-----------------------------------------------------------+ +|uint32 attributes |Flags that are associated with a specific function in the | +| |protocol. For all functions in this protocol, this | +| |parameter has a value of 0 | ++------------------+-----------------------------------------------------------+ + +BBM_GPR_SET +~~~~~~~~~~~ + +message_id: 0x3 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of GPR to write | ++------------------+-----------------------------------------------------------+ +|uint32 value |32-bit value to write to the GPR | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the GPR was successfully written. | +| |NOT_FOUND: if the index is not valid. | +| |DENIED: if the agent does not have permission to write | +| |the specified GPR | ++------------------+-----------------------------------------------------------+ + +BBM_GPR_GET +~~~~~~~~~~~ + +message_id: 0x4 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of GPR to read | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the GPR was successfully read. | +| |NOT_FOUND: if the index is not valid. | +| |DENIED: if the agent does not have permission to read | +| |the specified GPR. | ++------------------+-----------------------------------------------------------+ +|uint32 value |32-bit value read from the GPR | ++------------------+-----------------------------------------------------------+ + +BBM_RTC_ATTRIBUTES +~~~~~~~~~~~~~~~~~~ + +message_id: 0x5 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of RTC | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: returned the attributes. | +| |NOT_FOUND: Index is invalid. | ++------------------+-----------------------------------------------------------+ +|uint32 attributes |Bit[31:24] Bit width of RTC seconds. | +| |Bit[23:16] Bit width of RTC ticks. | +| |Bits[15:0] RTC ticks per second | ++------------------+-----------------------------------------------------------+ +|uint8 name[16] |Null-terminated ASCII string of up to 16 bytes in length | +| |describing the RTC name | ++------------------+-----------------------------------------------------------+ + +BBM_RTC_TIME_SET +~~~~~~~~~~~~~~~~ + +message_id: 0x6 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of RTC | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Bits[31:1] Reserved, must be zero. | +| |Bit[0] RTC time format: | +| |Set to 1 if the time is in ticks. | +| |Set to 0 if the time is in seconds | ++------------------+-----------------------------------------------------------+ +|uint32 time[2] |Lower word: Lower 32 bits of the time in seconds/ticks. | +| |Upper word: Upper 32 bits of the time in seconds/ticks. | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: RTC time was successfully set. | +| |NOT_FOUND: rtcId pertains to a non-existent RTC. | +| |INVALID_PARAMETERS: time is not valid | +| |(beyond the range of the RTC). | +| |DENIED: the agent does not have permission to set the RTC. | ++------------------+-----------------------------------------------------------+ + +BBM_RTC_TIME_GET +~~~~~~~~~~~~~~~~ + +message_id: 0x7 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of RTC | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Bits[31:1] Reserved, must be zero. | +| |Bit[0] RTC time format: | +| |Set to 1 if the time is in ticks. | +| |Set to 0 if the time is in seconds | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: RTC time was successfully get. | +| |NOT_FOUND: rtcId pertains to a non-existent RTC. | ++------------------+-----------------------------------------------------------+ +|uint32 time[2] |Lower word: Lower 32 bits of the time in seconds/ticks. | +| |Upper word: Upper 32 bits of the time in seconds/ticks. | ++------------------+-----------------------------------------------------------+ + +BBM_RTC_ALARM_SET +~~~~~~~~~~~~~~~~~ + +message_id: 0x8 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of RTC | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Bits[31:1] Reserved, must be zero. | +| |Bit[0] RTC enable flag: | +| |Set to 1 if the RTC alarm should be enabled. | +| |Set to 0 if the RTC alarm should be disabled | ++------------------+-----------------------------------------------------------+ +|uint32 time[2] |Lower word: Lower 32 bits of the time in seconds. | +| |Upper word: Upper 32 bits of the time in seconds. | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: RTC time was successfully set. | +| |NOT_FOUND: rtcId pertains to a non-existent RTC. | +| |INVALID_PARAMETERS: time is not valid | +| |(beyond the range of the RTC). | +| |DENIED: the agent does not have permission to set the RTC | +| |alarm | ++------------------+-----------------------------------------------------------+ + +BBM_BUTTON_GET +~~~~~~~~~~~~~~ + +message_id: 0x9 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the button status was read. | +| |Other value: ARM SCMI Specification status code definitions| ++------------------+-----------------------------------------------------------+ +|uint32 state |State of the ON/OFF button. 1: ON, 0: OFF | ++------------------+-----------------------------------------------------------+ + +BBM_RTC_NOTIFY +~~~~~~~~~~~~~~ + +message_id: 0xA +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of RTC | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Notification flags | +| |Bits[31:3] Reserved, must be zero. | +| |Bit[2] Update enable: | +| |Set to 1 to send notification. | +| |Set to 0 if no notification. | +| |Bit[1] Rollover enable: | +| |Set to 1 to send notification. | +| |Set to 0 if no notification. | +| |Bit[0] Alarm enable: | +| |Set to 1 to send notification. | +| |Set to 0 if no notification | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: notification configuration was successfully | +| |updated. | +| |NOT_FOUND: rtcId pertains to a non-existent RTC. | +| |DENIED: the agent does not have permission to request RTC | +| |notifications. | ++------------------+-----------------------------------------------------------+ + +BBM_BUTTON_NOTIFY +~~~~~~~~~~~~~~~~~ + +message_id: 0xB +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Notification flags | +| |Bits[31:1] Reserved, must be zero. | +| |Bit[0] Enable button: | +| |Set to 1 to send notification. | +| |Set to 0 if no notification | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: notification configuration was successfully | +| |updated. | +| |DENIED: the agent does not have permission to request | +| |button notifications. | ++------------------+-----------------------------------------------------------+ + +NEGOTIATE_PROTOCOL_VERSION +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +message_id: 0x10 +protocol_id: 0x81 + ++--------------------+---------------------------------------------------------+ +|Parameters | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|uint32 version |The negotiated protocol version the agent intends to use | ++--------------------+---------------------------------------------------------+ +|Return values | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|int32 status |SUCCESS: if the negotiated protocol version is supported | +| |by the platform. All commands, responses, and | +| |notifications post successful return of this command must| +| |comply with the negotiated version. | +| |NOT_SUPPORTED: if the protocol version is not supported. | ++--------------------+---------------------------------------------------------+ + +Notifications +_____________ + +BBM_RTC_EVENT +~~~~~~~~~~~~~ + +message_id: 0x0 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 flags |RTC events: | +| |Bits[31:2] Reserved, must be zero. | +| |Bit[1] RTC rollover notification: | +| |1 RTC rollover detected. | +| |0 no RTC rollover detected. | +| |Bit[0] RTC alarm notification: | +| |1 RTC alarm generated. | +| |0 no RTC alarm generated. | ++------------------+-----------------------------------------------------------+ + +BBM_BUTTON_EVENT +~~~~~~~~~~~~~~~~ + +message_id: 0x1 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 flags |RTC events: | ++------------------+-----------------------------------------------------------+ +| |Button events: | +| |Bits[31:1] Reserved, must be zero. | +| |Bit[0] Button notification: | +| |1 button change detected. | +| |0 no button change detected. | ++------------------+-----------------------------------------------------------+ + +SCMI_MISC: System Control and Management MISC Vendor Protocol +================================================================ + +Provides miscellaneous functions. This includes controls that are miscellaneous +settings/actions that must be exposed from the SM to agents. They are device +specific and are usually define to access bit fields in various mix block +control modules, IOMUX_GPR, and other GPR/CSR owned by the SM. This protocol +supports the following functions: + +- Describe the protocol version. +- Discover implementation attributes. +- Set/Get a control. +- Initiate an action on a control. +- Obtain platform (i.e. SM) build information. +- Obtain ROM passover data. +- Read boot/shutdown/reset information for the LM or the system. + +Commands: +_________ + +PROTOCOL_VERSION +~~~~~~~~~~~~~~~~ + +message_id: 0x0 +protocol_id: 0x84 + ++---------------+--------------------------------------------------------------+ +|Return values | ++---------------+--------------------------------------------------------------+ +|Name |Description | ++---------------+--------------------------------------------------------------+ +|int32 status | See ARM SCMI Specification for status code definitions. | ++---------------+--------------------------------------------------------------+ +|uint32 version | For this revision of the specification, this value must be | +| | 0x10000. | ++---------------+--------------------------------------------------------------+ + +PROTOCOL_ATTRIBUTES +~~~~~~~~~~~~~~~~~~~ + +message_id: 0x1 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status | See ARM SCMI Specification for status code definitions. | ++------------------+-----------------------------------------------------------+ +|uint32 attributes |Protocol attributes: | +| |Bits[31:24] Reserved, must be zero. | +| |Bits[23:16] Number of reset reasons. | +| |Bits[15:0] Number of controls | ++------------------+-----------------------------------------------------------+ + +PROTOCOL_MESSAGE_ATTRIBUTES +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +message_id: 0x2 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: in case the message is implemented and available | +| |to use. | +| |NOT_FOUND: if the message identified by message_id is | +| |invalid or not implemented | ++------------------+-----------------------------------------------------------+ +|uint32 attributes |Flags that are associated with a specific function in the | +| |protocol. For all functions in this protocol, this | +| |parameter has a value of 0 | ++------------------+-----------------------------------------------------------+ + +MISC_CONTROL_SET +~~~~~~~~~~~~~~~~ + +message_id: 0x3 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of the control | ++------------------+-----------------------------------------------------------+ +|uint32 num |Size of the value data in words | ++------------------+-----------------------------------------------------------+ +|uint32 val[8] |value data array | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the control was set successfully. | +| |NOT_FOUND: if the index is not valid. | +| |DENIED: if the agent does not have permission to set the | +| |control | ++------------------+-----------------------------------------------------------+ + +MISC_CONTROL_GET +~~~~~~~~~~~~~~~~ + +message_id: 0x4 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of the control | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the control was get successfully. | +| |NOT_FOUND: if the index is not valid. | +| |DENIED: if the agent does not have permission to get the | +| |control | ++------------------+-----------------------------------------------------------+ +|uint32 num |Size of the return data in words, max 8 | ++------------------+-----------------------------------------------------------+ +|uint32 | | +|val[0, num - 1] |value data array | ++------------------+-----------------------------------------------------------+ + +MISC_CONTROL_ACTION +~~~~~~~~~~~~~~~~~~~ + +message_id: 0x5 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of the control | ++------------------+-----------------------------------------------------------+ +|uint32 action |Action for the control | ++------------------+-----------------------------------------------------------+ +|uint32 numarg |Size of the argument data, max 8 | ++------------------+-----------------------------------------------------------+ +|uint32 | | +|arg[0, numarg -1] |Argument data array | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the action was set successfully. | +| |NOT_FOUND: if the index is not valid. | +| |DENIED: if the agent does not have permission to get the | +| |control | ++------------------+-----------------------------------------------------------+ +|uint32 num |Size of the return data in words, max 8 | ++------------------+-----------------------------------------------------------+ +|uint32 | | +|val[0, num - 1] |value data array | ++------------------+-----------------------------------------------------------+ + +MISC_DISCOVER_BUILD_INFO +~~~~~~~~~~~~~~~~~~~~~~~~ + +This function is used to obtain the build commit, data, time, number. + +message_id: 0x6 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the build info was got successfully. | +| |NOT_SUPPORTED: if the data is not available. | ++------------------+-----------------------------------------------------------+ +|uint32 buildnum |Build number | ++------------------+-----------------------------------------------------------+ +|uint32 buildcommit|Most significant 32 bits of the git commit hash | ++------------------+-----------------------------------------------------------+ +|uint8 date[16] |Date of build. Null terminated ASCII string of up to 16 | +| |bytes in length | ++------------------+-----------------------------------------------------------+ +|uint8 time[16] |Time of build. Null terminated ASCII string of up to 16 | +| |bytes in length | ++------------------+-----------------------------------------------------------+ + +MISC_ROM_PASSOVER_GET +~~~~~~~~~~~~~~~~~~~~~ + +ROM passover data is information exported by ROM and could be used by others. +It includes boot device, instance, type, mode and etc. This function is used +to obtain the ROM passover data. The returned block of words is structured as +defined in the ROM passover section in the SoC RM. + +message_id: 0x7 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if the data was got successfully. | +| |NOT_SUPPORTED: if the data is not available. | ++------------------+-----------------------------------------------------------+ +|uint32 num |Size of the passover data in words, max 13 | ++------------------+-----------------------------------------------------------+ +|uint32_t | | +|data[0, num - 1] |Passover data array | ++------------------+-----------------------------------------------------------+ + +MISC_CONTROL_NOTIFY +~~~~~~~~~~~~~~~~~~~ + +message_id: 0x8 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 index |Index of control | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Notification flags, varies by control | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: notification configuration was successfully | +| |updated. | +| |NOT_FOUND: control id not exists. | +| |INVALID_PARAMETERS: if the input attributes flag specifies | +| |unsupported or invalid configurations.. | +| |DENIED: if the calling agent is not permitted to request | +| |the notification. | ++------------------+-----------------------------------------------------------+ + +MISC_RESET_REASON_ATTRIBUTES +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +message_id: 0x9 +protocol_id: 0x84 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 reasonid |Identifier for the reason | ++------------------+-----------------------------------------------------------+ +|Return values | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|int32 status |SUCCESS: if valid reason attributes are returned | +| |NOT_FOUND: if reasonId pertains to a non-existent reason. | ++------------------+-----------------------------------------------------------+ +|uint32 attributes |Reason attributes. This parameter has the following | +| |format: Bits[31:0] Reserved, must be zero | +| |Bits[15:0] Number of persistent storage (GPR) words. | ++------------------+-----------------------------------------------------------+ +|uint8 name[16] |Null-terminated ASCII string of up to 16 bytes in length | +| |describing the reason | ++------------------+-----------------------------------------------------------+ + +MISC_RESET_REASON_GET +~~~~~~~~~~~~~~~~~~~~~ + +message_id: 0xA +protocol_id: 0x84 + ++--------------------+---------------------------------------------------------+ +|Parameters | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|uint32 flags |Reason flags. This parameter has the following format: | +| |Bits[31:1] Reserved, must be zero. | +| |Bit[0] System: | +| |Set to 1 to return the system reason. | +| |Set to 0 to return the LM reason | ++--------------------+---------------------------------------------------------+ +|Return values | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|int32 status |SUCCESS: reset reason return | ++--------------------+---------------------------------------------------------+ +|uint32 bootflags |Boot reason flags. This parameter has the format: | +| |Bits[31] Valid. | +| |Set to 1 if the entire reason is valid. | +| |Set to 0 if the entire reason is not valid. | +| |Bits[30:29] Reserved, must be zero. | +| |Bit[28] Valid origin: | +| |Set to 1 if the origin field is valid. | +| |Set to 0 if the origin field is not valid. | +| |Bits[27:24] Origin. | +| |Bit[23] Valid err ID: | +| |Set to 1 if the error ID field is valid. | +| |Set to 0 if the error ID field is not valid. | +| |Bits[22:8] Error ID. | +| |Bit[7:0] Reason | ++--------------------+---------------------------------------------------------+ +|uint32 shutdownflags|Shutdown reason flags. This parameter has the format: | +| |Bits[31] Valid. | +| |Set to 1 if the entire reason is valid. | +| |Set to 0 if the entire reason is not valid. | +| |Bits[30:29] Number of valid extended info words. | +| |Bit[28] Valid origin: | +| |Set to 1 if the origin field is valid. | +| |Set to 0 if the origin field is not valid. | +| |Bits[27:24] Origin. | +| |Bit[23] Valid err ID: | +| |Set to 1 if the error ID field is valid. | +| |Set to 0 if the error ID field is not valid. | +| |Bits[22:8] Error ID. | +| |Bit[7:0] Reason | ++--------------------+---------------------------------------------------------+ +|uint32 extinfo[8] |Array of extended info words | ++--------------------+---------------------------------------------------------+ + +MISC_SI_INFO_GET +~~~~~~~~~~~~~~~~ + +message_id: 0xB +protocol_id: 0x84 + ++--------------------+---------------------------------------------------------+ +|Return values | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|int32 status |SUCCESS: silicon info return | ++--------------------+---------------------------------------------------------+ +|uint32 deviceid |Silicon specific device ID | ++--------------------+---------------------------------------------------------+ +|uint32 sirev |Silicon specific revision | ++--------------------+---------------------------------------------------------+ +|uint32 partnum |Silicon specific part number | ++--------------------+---------------------------------------------------------+ +|uint8 siname[16] |Silicon name/revision. Null terminated ASCII string of up| +| |to 16 bytes in length | ++--------------------+---------------------------------------------------------+ + +MISC_CFG_INFO_GET +~~~~~~~~~~~~~~~~~ + +message_id: 0xC +protocol_id: 0x84 + ++--------------------+---------------------------------------------------------+ +|Return values | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|int32 status |SUCCESS: config name return | +| |NOT_SUPPORTED: name not available | ++--------------------+---------------------------------------------------------+ +|uint32 msel |Mode selector value | ++--------------------+---------------------------------------------------------+ +|uint8 cfgname[16] |config file basename. Null terminated ASCII string of up | +| |to 16 bytes in length | ++--------------------+---------------------------------------------------------+ + +MISC_SYSLOG_GET +~~~~~~~~~~~~~~~ + +message_id: 0xD +protocol_id: 0x84 + ++--------------------+---------------------------------------------------------+ +|Parameters | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|uint32 flags |Device specific flags that might impact the data returned| +| |or clearing of the data | ++--------------------+---------------------------------------------------------+ +|uint32 logindex |Index to the first log word. Will be the first element in| +| |the return array | ++--------------------+---------------------------------------------------------+ +|Return values | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|int32 status |SUCCESS: system log return | ++--------------------+---------------------------------------------------------+ +|uint32 numLogflags |Descriptor for the log data returned by this call. | +| |Bits[31:20] Number of remaining log words. | +| |Bits[15:12] Reserved, must be zero. | +| |Bits[11:0] Number of log words that are returned by this | +| |call | ++--------------------+---------------------------------------------------------+ +|uint32 syslog[N] |Log data array, N is defined in bits[11:0] of numLogflags| ++--------------------+---------------------------------------------------------+ + +NEGOTIATE_PROTOCOL_VERSION +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +message_id: 0x10 +protocol_id: 0x84 + ++--------------------+---------------------------------------------------------+ +|Parameters | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|uint32 version |The negotiated protocol version the agent intends to use | ++--------------------+---------------------------------------------------------+ +|Return values | ++--------------------+---------------------------------------------------------+ +|Name |Description | ++--------------------+---------------------------------------------------------+ +|int32 status |SUCCESS: if the negotiated protocol version is supported | +| |by the platform. All commands, responses, and | +| |notifications post successful return of this command must| +| |comply with the negotiated version. | +| |NOT_SUPPORTED: if the protocol version is not supported. | ++--------------------+---------------------------------------------------------+ + +Notifications +_____________ + +MISC_CONTROL_EVENT +~~~~~~~~~~~~~~~~~~ + +message_id: 0x0 +protocol_id: 0x81 + ++------------------+-----------------------------------------------------------+ +|Parameters | ++------------------+-----------------------------------------------------------+ +|Name |Description | ++------------------+-----------------------------------------------------------+ +|uint32 ctrlid |Identifier for the control that caused the event. | ++------------------+-----------------------------------------------------------+ +|uint32 flags |Event flags, varies by control. | ++------------------+-----------------------------------------------------------+ From patchwork Thu Jul 18 07:41:58 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Peng Fan \(OSS\)" X-Patchwork-Id: 813284 Received: from DB3PR0202CU003.outbound.protection.outlook.com (mail-northeuropeazon11011062.outbound.protection.outlook.com [52.101.65.62]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E6A8480638; Thu, 18 Jul 2024 07:33:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.101.65.62 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721288020; cv=fail; b=MmTLSHrIN8sTJxH570BgVi2g0+fC9MQAKrK6Z0cdBtJe3L/tkUiILrHN5a3/wjQgK/8tbvyUcBZcQFexcnKvA6sHNxm+JbufpgiHY03cSpiUZNArYoKbXLTOrqvw1KfymNfnEUfR+O9FOhRG4NK2Kz638J6uCBa3KRrYejLsP+c= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721288020; c=relaxed/simple; bh=lB0din7YUuASkUYMScY/zMN+DX9irTFze5qsm4nmRik=; h=From:Date:Subject:Content-Type:Message-Id:References:In-Reply-To: To:Cc:MIME-Version; b=QIWN5ZsQ6fM/BjSHhjxQq0BU0t16qY6pW/AoNgUL8OI4WkTlpjW+ZmZWZUbeLE48Br/r+9Am+xrvMeWB3ppwWnhEeOSlHC+aX07ORW+9i4mqvsK7v7WRZmnDzlcvhcT78QSbpDwv+XbL8oFR/Wvs4jF5C8SoSKwqQo4m9n4QZaA= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=oss.nxp.com; spf=pass smtp.mailfrom=oss.nxp.com; dkim=pass (1024-bit key) header.d=NXP1.onmicrosoft.com header.i=@NXP1.onmicrosoft.com header.b=P4SUAsDn; arc=fail smtp.client-ip=52.101.65.62 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=oss.nxp.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=oss.nxp.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=NXP1.onmicrosoft.com header.i=@NXP1.onmicrosoft.com header.b="P4SUAsDn" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=Ev0FjIhoobc34/HglEqRtqErXYfc6PWqS6yKbs8mI3IcKuGrfOWfpmtfmfq0MAmfqvja95NDecnnogVIIPNaUolExownZ0WYfsyjBYmvxEGjzS05dV3lQTm96wmiu0r9jMwFhkAtDfv8oodk2nL/R5V+ygjzFSlUT6xuoNOANah3ARQ4OFOvAYYsT91nWtIMVYCPuqyQf4oQ0Bs14YjrBbSQvNq/onKpvrPpISb177XWqqk23/NQi1CPPQgSN31ED+LJzoN2EUw3M6dVBJ3mQQ/zAGB7oSWWjuI4zkgQ6MkfDlBTXPdrEQHtd3ihhxPWt1WpjpbMMR8Q/jgs8QGaig== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=2y1quUvokU0Up4oQp8r3/9zDfWHRyol2aqI1a4ysBr4=; b=RIyzEJsFepTE9C44vFUwaMgi8bwrxksCvYsy4FMCgH0PmzSSxr1v2rN0lEPv3f14H0zNaYOsJqUCJ/TJLg2GdTOPhBPMwzBfzxnNjrxeNDGD4OvqGSk7CSAIsl5GNYqipDRocYc9qBRq0zSkET6OJ9RbejPU6nFJtGJkPaoLLp4qLVnULKfYKxwDMDt/9FDcNUgJ/vSWTvqSzUqF0h+7PHHcOCwZtPgo5Zr0JsBvkaoJEiUKIOsv0DdH9Zm3txexL5FMAVcp/IFlL2DvYDTAqkd0uDAvwYlfWXg9zlJiFW/eXuAZh4i7rcqj92vUCAmSQoUpBIaeLbi9eZ6UBfihoQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oss.nxp.com; dmarc=pass action=none header.from=oss.nxp.com; dkim=pass header.d=oss.nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=NXP1.onmicrosoft.com; s=selector2-NXP1-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=2y1quUvokU0Up4oQp8r3/9zDfWHRyol2aqI1a4ysBr4=; b=P4SUAsDnjgox1+Hghb8BkHqO85PiHEm8gtbAoSvMAZU8VzXmGhZIDutEv+jIOMwqL3RkvVJrHIEGvzB/Q2fApJrsPs4Ybgse6TpT5qC9zcQTLYE7cTKhCVsoCr3JjaFwiHUC8CbVA9v2bHK2/6XvO2O3jyUpa/2xOPzTLbycECM= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=oss.nxp.com; Received: from PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) by DU4PR04MB10457.eurprd04.prod.outlook.com (2603:10a6:10:561::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7784.16; Thu, 18 Jul 2024 07:33:35 +0000 Received: from PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630]) by PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630%4]) with mapi id 15.20.7762.020; Thu, 18 Jul 2024 07:33:34 +0000 From: "Peng Fan (OSS)" Date: Thu, 18 Jul 2024 15:41:58 +0800 Subject: [PATCH v6 6/7] rtc: support i.MX95 BBM RTC Message-Id: <20240718-imx95-bbm-misc-v2-v6-6-18f008e16e9d@nxp.com> References: <20240718-imx95-bbm-misc-v2-v6-0-18f008e16e9d@nxp.com> In-Reply-To: <20240718-imx95-bbm-misc-v2-v6-0-18f008e16e9d@nxp.com> To: Sudeep Holla , Cristian Marussi , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Alexandre Belloni , Dmitry Torokhov Cc: Peng Fan , arm-scmi@vger.kernel.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, imx@lists.linux.dev, linux-rtc@vger.kernel.org, linux-input@vger.kernel.org X-Mailer: b4 0.12.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1721288528; l=6360; i=peng.fan@nxp.com; s=20230812; h=from:subject:message-id; bh=Oy5Gyoso0Y/G/kwZwRlXVgA45ZaX4xes2SzW2BSybKo=; b=UooGqUwQLeY4oe45kIQCm7dZbgJOYK8IfktPuFuUCX4/fVei42lH1hL/3EhMfMtvSbbhLchNK MVqqgU+QZVyAstleaZVKdySeDh+NFDrwbIFAmbCup6kIxHucKN8o2uB X-Developer-Key: i=peng.fan@nxp.com; a=ed25519; pk=I4sJg7atIT1g63H7bb5lDRGR2gJW14RKDD0wFL8TT1g= X-ClientProxiedBy: SI1PR02CA0046.apcprd02.prod.outlook.com (2603:1096:4:1f5::14) To PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) Precedence: bulk X-Mailing-List: linux-input@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: PAXPR04MB8459:EE_|DU4PR04MB10457:EE_ X-MS-Office365-Filtering-Correlation-Id: 475db741-ad46-48b5-cfe4-08dca6fbee7f X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|366016|52116014|376014|7416014|921020|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?q?qkdYYDXAIO1htEfMNmyB/b5/xDjWdVC?= =?utf-8?q?+XCtIqlCPubJ8mjRqEMqJjDDhSnxAwdejSdGv7US8uliHOqIjMoYRRhT5Dc/qjsoL?= =?utf-8?q?R8AK+e4EcByaU7/jfo+/n4E/GWTyKSlYAeOPK6TwYWJPmSWnNKzBrhBU86i+BRTyO?= =?utf-8?q?+nyK21hKBpVFkl/scCo/whLqDOSym2C1HnZczpRXCRHD79XNVQ2NjS/mXQzglwtAy?= =?utf-8?q?CNbkwvL9ycJ0RUd79rwtpYXTUUA6mPK3JOe1lSyWn7DyhxO00pvepNb9uM4+umJIB?= =?utf-8?q?0ZX4h0LdruqmgDlnJVHc6ir3QziKXx2M1p9D/V9O3DhCir6vO1yg9YvKS9SznIf8C?= =?utf-8?q?F2NzwGc5nK+hixyFo7oshuyl2fqys9X5ZT7mV5DxALmzrccazfoj6GiZDWYjT7meb?= =?utf-8?q?NReJjN3zymPyPfiW71Km1enRkhANuGOFr+hA5TBkImoxERmkMW/7jIZKdh6odYOYb?= =?utf-8?q?Z+rL+Nf3sk52q56x+y8mAL5DAF4QSmR9HlaR4OlTR94H5VD/aHZHnMkCUMEx6lOeR?= =?utf-8?q?3s6amiTYY0BPRkPPHimEffDxxCihW7JV9SjSEKgXkrzg9f8j7dRr8IVJ8SNpfPwS9?= =?utf-8?q?K/XmfFK6HiXpt7FAXbQuEdLyUkqEpHtlcK/hRAQ28xuK5NgKdA0MZYHpqLWk5Cqkq?= =?utf-8?q?ZIgwDq4GgOWMaNLbe7Pn23HhDTGgQ1cMketXGzm7+0k8qfH0L5Xm2SEsaDC17kaa1?= =?utf-8?q?gAJOhV3pAiRNK5DMqXCoWXv+Oolwme/VPwVGi6AQBxomfYiU5NULCvx3JtZkqg77e?= =?utf-8?q?r3V0jKxBZr4jDSUaRl9plWQrzFmFxzi2yzM0T6Elr+njKIaicyTzLremokDCWg8C3?= =?utf-8?q?jfvJEv0SLHo3iWXyURXzEsHveZIVCe3zpPFH64Ny6cLoZuomtFVJINOyB4RZun535?= =?utf-8?q?UIgFK3ONtcD0QgerfQW2m/AfyuT3ZZc5IopOR4TrhDEKvrzd1tALGRDlJ1e5bHjTU?= =?utf-8?q?q0yF6LjEfpVQnqd/Whsi+A7V7P4199QCtEXI+KSNId8ZnQF2sxabrXY/4FmeMDblk?= =?utf-8?q?bN84sFhnMgF9AESDvXT0pDp71hsjjPRVrlRBYMK72vXESn53g4RfHg8bn5RnsRuVs?= =?utf-8?q?urfjdUdI685QiEjC2PJyljzvaNQlSi7yeEW7UgXTkps2mAZ0BHdmWjGnV3fmQCaS8?= =?utf-8?q?ZTLuRpP1g4I3Vfgm0u9Lrbgw1yiS/e3V0JPupECOl6dxOk1UvQt4L+KjbEHfF+2Uw?= =?utf-8?q?OmgC8XMp5bYWw+wZYWpTpbw3RrwD8psEyi5y73dqpiBAydbatWwbQ63Ghlp9LwapZ?= =?utf-8?q?1rfGgnIbhJAdZubIkleq5d1ON4ox0pvolJgSTKNHyJxp3Gr1GOkIn/5zoSXAeohV2?= =?utf-8?q?QZNQZZJ4fbteqR/5YF3v48yUpAXfMeC6k9A8Sy1uQeTnm7cr9Cy5JpM=3D?= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PAXPR04MB8459.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(1800799024)(366016)(52116014)(376014)(7416014)(921020)(38350700014); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?AC8vOipPpWoW19bZOY8haxKeSH5p?= =?utf-8?q?Qp3PccKtptU8seRXz3xnb51viStwGMhHmpCdzK48/pUCJB5tzbZLtCXexKqc46JkQ?= =?utf-8?q?OGXk8mPAqa7wNeZFS88WeJaubSIOTyTGYXKRfrGW8CZ7ViYldyLoKqOn+6MCBbQNO?= =?utf-8?q?2xZHu/dtenA/RxUzT33n9yfn7eDqjcrmJcRoEODQ/usa618QFb/SKn4u06d7gYo7E?= =?utf-8?q?e7Ret4K1osTn7qW2EDfrlgOj2vGffLns0o2oyLrnPkyvZ1+6WClOe5wFXJJ4krnwy?= =?utf-8?q?eb+ClIF4FpXo0Jp01s5w5xQ0lIU05lheGF1AyR2rIN6gSOIMn6yN4CXDIxWGRVQtO?= =?utf-8?q?YM4/jmYAKvCN27YJmsQomIAoX0dLmK4hnUuf71aYjxv5hCynMhFCfGdW8wt6xReYu?= =?utf-8?q?SxvencBgaolIybJvCxRLKAS2Gka93k2wtTRwRkZEO0CYBoSET17+f/lRf7gR7Ol9K?= =?utf-8?q?9UIL2i9FhwCaREcMs4sEjoRnd3Mys/DYTLqJfFqj8d9hcyHvTFZHo4rYF6kOCsZ29?= =?utf-8?q?+TqAysBFxextCPAMh4Ih7wQ7UDm2PJzoHgq1zBdzhox8YZOkHgdFhNmYqbT9sm0Cq?= =?utf-8?q?wtbSgVTnzM80BTB4sPPO3k1kW/KQgz/Z/OzBJ+Qe8GOZ0Lf1lpjuXAf3SmTlW6ksR?= =?utf-8?q?LflqTvZW5RJoDqlEjlGFDu8ZAxccTOsy40yEucT2qFIrM+5dePGTURtdBQrrM3J6+?= =?utf-8?q?FxVLjhByBjTJkJAgoKckqYyyDHMirbSTfuo9jr4M13ALB/BImLNxB+G33tAV6QE0T?= =?utf-8?q?k3SWdATT6h37PL7zA1yYmtLdvjhbeMf8Z3pyUNkdGTxe31cEBgkXSoRQHA52pET0B?= =?utf-8?q?jHDhpiA1nPqdXRIFVVkD34vpjiMfghLDOyxbMHROQJH0Etm9HiDdVyqMI9vYPYihq?= =?utf-8?q?gobiCsyMJ0YJ0w4RJ2Tv0gBOWiEfR9hys4qXV1+/82V+B2auil5y8Xu0SZBI6NY79?= =?utf-8?q?XC3BLeGnp2+pauKUarcZWOIbZLuhvtyEUaiun8MX/uKQqnpVQy69ecraVAlKOsnmV?= =?utf-8?q?Elh390Jm0meYVljqAloqw/m56ePNmWPcOVxbX+gCKeiEVjTXNLZVu5tlmLGGL2Rgr?= =?utf-8?q?tVi0eP9MkqDw4ZkynHh/VSsJp5pHwHWTFWKV8wIbyMMu4kqRl2dv3VTSChY9tlwlf?= =?utf-8?q?nunThMRlGESll4JNNyhKj1Qbn90V3tZFrpH1yaifm53aqxIZm80RlkCKOFyVg+MrW?= =?utf-8?q?VAZ7y1o4tFsSTm7F6o6ihRXGZhnjsGVW0FIB7zoX8gtTrQQPSMmcGS+airDVF7Zkx?= =?utf-8?q?+LctSZMZOL/mASIzG5M2rzl7RXdgvp4Zo2lZhBgj2MoNjQiSZdln815TOagfxxjWT?= =?utf-8?q?pfFdMQwS4nVi8QHUjeNR9WZzYbWYo2Ty/izbjLQBDCUmU7BklBLR9te7uFJNQgifQ?= =?utf-8?q?AB57+oS26yqEPSuxxCOucrYnHVglTvaSMAsFH7Ykrz/s+8mMEQz3xUrJ0IfYKgkpA?= =?utf-8?q?peJdq2La0y1cu3kbEmeLw8ebH5peExA6CggeXRPsWYnMjIFxdZFbQYgmbNnqtO3X/?= =?utf-8?q?qHH3irupXJsG?= X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 475db741-ad46-48b5-cfe4-08dca6fbee7f X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8459.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Jul 2024 07:33:34.9005 (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: hE2p74/rIiNvChS+MEZpKWFcyASgI9ELRR4Tdyy/wTHKuTFj5JegEtUyOogAguJXatPKVhxFXLumo/poaea96g== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU4PR04MB10457 From: Peng Fan The BBM module provides RTC feature. To i.MX95, this module is managed by System Manager and exported System Control Management Interface(SCMI). Linux could use i.MX SCMI BBM Extension protocol to use RTC feature. This driver is to use SCMI interface to get/set RTC. Reviewed-by: Cristian Marussi Signed-off-by: Peng Fan --- drivers/rtc/Kconfig | 8 +++ drivers/rtc/Makefile | 1 + drivers/rtc/rtc-imx-sm-bbm.c | 162 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 171 insertions(+) diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig index 2a95b05982ad..8122bfeba8c0 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -1827,6 +1827,14 @@ config RTC_DRV_BBNSM This driver can also be built as a module, if so, the module will be called "rtc-bbnsm". +config RTC_DRV_IMX_BBM_SCMI + depends on IMX_SCMI_BBM_EXT || COMPILE_TEST + default y if ARCH_MXC + tristate "NXP i.MX BBM SCMI RTC support" + help + If you say yes here you get support for the NXP i.MX BBSM SCMI + RTC module. + config RTC_DRV_IMX_SC depends on IMX_SCU depends on HAVE_ARM_SMCCC diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile index 3004e372f25f..8ee79cb18322 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -74,6 +74,7 @@ obj-$(CONFIG_RTC_DRV_HID_SENSOR_TIME) += rtc-hid-sensor-time.o obj-$(CONFIG_RTC_DRV_HYM8563) += rtc-hym8563.o obj-$(CONFIG_RTC_DRV_IMXDI) += rtc-imxdi.o obj-$(CONFIG_RTC_DRV_IMX_SC) += rtc-imx-sc.o +obj-$(CONFIG_RTC_DRV_IMX_BBM_SCMI) += rtc-imx-sm-bbm.o obj-$(CONFIG_RTC_DRV_ISL12022) += rtc-isl12022.o obj-$(CONFIG_RTC_DRV_ISL12026) += rtc-isl12026.o obj-$(CONFIG_RTC_DRV_ISL1208) += rtc-isl1208.o diff --git a/drivers/rtc/rtc-imx-sm-bbm.c b/drivers/rtc/rtc-imx-sm-bbm.c new file mode 100644 index 000000000000..daa472be7c80 --- /dev/null +++ b/drivers/rtc/rtc-imx-sm-bbm.c @@ -0,0 +1,162 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright 2024 NXP. + */ + +#include +#include +#include +#include +#include +#include + +struct scmi_imx_bbm { + const struct scmi_imx_bbm_proto_ops *ops; + struct rtc_device *rtc_dev; + struct scmi_protocol_handle *ph; + struct notifier_block nb; +}; + +static int scmi_imx_bbm_read_time(struct device *dev, struct rtc_time *tm) +{ + struct scmi_imx_bbm *bbnsm = dev_get_drvdata(dev); + struct scmi_protocol_handle *ph = bbnsm->ph; + u64 val; + int ret; + + ret = bbnsm->ops->rtc_time_get(ph, 0, &val); + if (ret) + return ret; + + rtc_time64_to_tm(val, tm); + + return 0; +} + +static int scmi_imx_bbm_set_time(struct device *dev, struct rtc_time *tm) +{ + struct scmi_imx_bbm *bbnsm = dev_get_drvdata(dev); + struct scmi_protocol_handle *ph = bbnsm->ph; + u64 val; + + val = rtc_tm_to_time64(tm); + + return bbnsm->ops->rtc_time_set(ph, 0, val); +} + +static int scmi_imx_bbm_alarm_irq_enable(struct device *dev, unsigned int enable) +{ + struct scmi_imx_bbm *bbnsm = dev_get_drvdata(dev); + struct scmi_protocol_handle *ph = bbnsm->ph; + + /* scmi_imx_bbm_set_alarm enables the irq, just handle disable here */ + if (!enable) + return bbnsm->ops->rtc_alarm_set(ph, 0, false, 0); + + return 0; +} + +static int scmi_imx_bbm_set_alarm(struct device *dev, struct rtc_wkalrm *alrm) +{ + struct scmi_imx_bbm *bbnsm = dev_get_drvdata(dev); + struct scmi_protocol_handle *ph = bbnsm->ph; + struct rtc_time *alrm_tm = &alrm->time; + u64 val; + + val = rtc_tm_to_time64(alrm_tm); + + return bbnsm->ops->rtc_alarm_set(ph, 0, true, val); +} + +static const struct rtc_class_ops smci_imx_bbm_rtc_ops = { + .read_time = scmi_imx_bbm_read_time, + .set_time = scmi_imx_bbm_set_time, + .set_alarm = scmi_imx_bbm_set_alarm, + .alarm_irq_enable = scmi_imx_bbm_alarm_irq_enable, +}; + +static int scmi_imx_bbm_rtc_notifier(struct notifier_block *nb, unsigned long event, void *data) +{ + struct scmi_imx_bbm *bbnsm = container_of(nb, struct scmi_imx_bbm, nb); + struct scmi_imx_bbm_notif_report *r = data; + + if (r->is_rtc) + rtc_update_irq(bbnsm->rtc_dev, 1, RTC_AF | RTC_IRQF); + else + pr_err("Unexpected bbm event: %s\n", __func__); + + return 0; +} + +static int scmi_imx_bbm_rtc_init(struct scmi_device *sdev) +{ + const struct scmi_handle *handle = sdev->handle; + struct device *dev = &sdev->dev; + struct scmi_imx_bbm *bbnsm = dev_get_drvdata(dev); + int ret; + + bbnsm->rtc_dev = devm_rtc_allocate_device(dev); + if (IS_ERR(bbnsm->rtc_dev)) + return PTR_ERR(bbnsm->rtc_dev); + + bbnsm->rtc_dev->ops = &smci_imx_bbm_rtc_ops; + bbnsm->rtc_dev->range_max = U32_MAX; + + bbnsm->nb.notifier_call = &scmi_imx_bbm_rtc_notifier; + ret = handle->notify_ops->devm_event_notifier_register(sdev, SCMI_PROTOCOL_IMX_BBM, + SCMI_EVENT_IMX_BBM_RTC, + NULL, &bbnsm->nb); + if (ret) + return ret; + + return devm_rtc_register_device(bbnsm->rtc_dev); +} + +static int scmi_imx_bbm_rtc_probe(struct scmi_device *sdev) +{ + const struct scmi_handle *handle = sdev->handle; + struct device *dev = &sdev->dev; + struct scmi_protocol_handle *ph; + struct scmi_imx_bbm *bbnsm; + int ret; + + if (!handle) + return -ENODEV; + + bbnsm = devm_kzalloc(dev, sizeof(*bbnsm), GFP_KERNEL); + if (!bbnsm) + return -ENOMEM; + + bbnsm->ops = handle->devm_protocol_get(sdev, SCMI_PROTOCOL_IMX_BBM, &ph); + if (IS_ERR(bbnsm->ops)) + return PTR_ERR(bbnsm->ops); + + bbnsm->ph = ph; + + device_init_wakeup(dev, true); + + dev_set_drvdata(dev, bbnsm); + + ret = scmi_imx_bbm_rtc_init(sdev); + if (ret) + device_init_wakeup(dev, false); + + return ret; +} + +static const struct scmi_device_id scmi_id_table[] = { + { SCMI_PROTOCOL_IMX_BBM, "imx-bbm-rtc" }, + { }, +}; +MODULE_DEVICE_TABLE(scmi, scmi_id_table); + +static struct scmi_driver scmi_imx_bbm_rtc_driver = { + .name = "scmi-imx-bbm-rtc", + .probe = scmi_imx_bbm_rtc_probe, + .id_table = scmi_id_table, +}; +module_scmi_driver(scmi_imx_bbm_rtc_driver); + +MODULE_AUTHOR("Peng Fan "); +MODULE_DESCRIPTION("IMX SM BBM RTC driver"); +MODULE_LICENSE("GPL");