From patchwork Fri May 24 08:56:45 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: 13672837 Received: from EUR05-DB8-obe.outbound.protection.outlook.com (mail-db8eur05on2041.outbound.protection.outlook.com [40.107.20.41]) (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 6D77312A151 for ; Fri, 24 May 2024 08:48:17 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=40.107.20.41 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1716540499; cv=fail; b=Dnq563awTjNHbZcSm+4URkBmMwrzGtG9HgmGCvyq+GRVMMQZP0omQmkgw6RM3keS9FrM0We19W+jUaqrx9Ow9YDlRenFSDYl1y0yHfskEnt8ygIyQXoYTDWjEqpqPZG4V/013JaqnKOxNtMBJnCTeZzwMZuYDFu9lG04wxoqd7M= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1716540499; c=relaxed/simple; bh=OcwkAzpACFTgLbGgtrLeYYIXMip8rieT8eRRolhkmx0=; h=From:Date:Subject:Content-Type:Message-Id:References:In-Reply-To: To:Cc:MIME-Version; b=HGI5p5yH6By0/fDKNtG9a3rpKZsSGk74kLymERGhjlgzaiExw2i9QgftaIMxamIi2Ipft5TZtu05AZygrHRToz1Yd+UxvvTBAUVcnmwoLgxZXYRZ4rpxR/4FaDEsnotQ5a5lqAdB+yvFJP9p2i07xbXNpJcqbmJxtprXwsb3STE= 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=HEWofvCn; arc=fail smtp.client-ip=40.107.20.41 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="HEWofvCn" ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=atJYFbZtcj7Ip+OHbTgR9iSvSg1Fn2SCgD+ARMfPdLSK6JA3uEYo7aWPJOxPsRqSY6soiNQQQZW/dTWcmNiHQmhw4SEpLvmExJH2P3rAclS0/gJaSPgIoe4xpEuTZsdFf/+6PxGzsppV3U0Yv7wS5epYzaS9RM0dYx8UQ6O69emQggFpCrOlIO/eaMwk0xyjhPbVNGs29JsAg+CQvWNLznDga5iWjoShLvUV+NQLFFMtxHEJW/5k4W8TygSymcNzWD1GUrTgwMP9NNu2Ul4AKUOuyk3JWy90UwszP96M1XerU5NU9DOmK0Gi32BYS/l7Q6U92wbdOyzjTzefaIxfVw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; 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=SDIiQ0WXldpS1c0zaz2zUEuRzwAAaQlxl5NUitHzIMk=; b=eL6E9puI65lFooGTxb4M/pJlkVeAcWGpm27vVGDdcYM+Xvwu5JjrGp+jiQgEJLvU0zf8d1+vTe0di/aD59aZWsKIuGy5WiVvxsX8/6tliEtRNFgkT5lbzal/Ua5oTroeXitb/Ao117N6DXsAqpxK2D8gCeqHCuvVPcuQ8z5b3RME39mZO32KoEwczgqdZnU8bOkx+e70CnfB+DoR9aMYDFNvFzXFNksxNmRgii90ns61oY5JQP6hWS35gsARwpKx9nLbAtEn6H39wUZGJgA27mgWwU1161OwsX4lTOy2zFedhJFSJHL2WzRSrF+CizSkf0ZwvU4aon9/eQTNuLavkg== 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=SDIiQ0WXldpS1c0zaz2zUEuRzwAAaQlxl5NUitHzIMk=; b=HEWofvCnWfEMLJyFvQZbHzsMvDS5g7m1xmCv79zSv1nar02QAw1wqpvEuwkSTLnIZTuHtMVXWFSMniF2HIXqVmVhBTkZJMcLmbx+IZpxRFQaDTF6pF/TVX2O7aCrSuQMJo5CNbxZKFLDONVlipJfQtJgkfbdJoKL2NuAIyxK8LA= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=oss.nxp.com; Received: from DU0PR04MB9417.eurprd04.prod.outlook.com (2603:10a6:10:358::11) by VI1PR04MB7149.eurprd04.prod.outlook.com (2603:10a6:800:12e::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7611.22; Fri, 24 May 2024 08:48:13 +0000 Received: from DU0PR04MB9417.eurprd04.prod.outlook.com ([fe80::557f:6fcf:a5a7:981c]) by DU0PR04MB9417.eurprd04.prod.outlook.com ([fe80::557f:6fcf:a5a7:981c%7]) with mapi id 15.20.7611.016; Fri, 24 May 2024 08:48:13 +0000 From: "Peng Fan (OSS)" Date: Fri, 24 May 2024 16:56:45 +0800 Subject: [PATCH v4 3/6] firmware: arm_scmi: add initial support for i.MX BBM protocol Message-Id: <20240524-imx95-bbm-misc-v2-v4-3-dc456995d590@nxp.com> References: <20240524-imx95-bbm-misc-v2-v4-0-dc456995d590@nxp.com> In-Reply-To: <20240524-imx95-bbm-misc-v2-v4-0-dc456995d590@nxp.com> To: Jonathan Corbet , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Sudeep Holla , Cristian Marussi , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Peng Fan Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, imx@lists.linux.dev, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org X-Mailer: b4 0.12.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1716541024; l=13836; i=peng.fan@nxp.com; s=20230812; h=from:subject:message-id; bh=LiEwtdf7o7H0ejhXmj7WnyGO4q5yLREiDmkzoa9AJTE=; b=ho5i5/6eHOq1JXzSaicvgEyzWSQvdVGwFnFMh8VIPGxFiwTrxqqY+HB+2lWSumhi+b6QoW81a YtOUyTRKpKNCS+qKNLV2iLuGxAIIJ8LGGB/P7IKhkooi2+/9NHFLiIf X-Developer-Key: i=peng.fan@nxp.com; a=ed25519; pk=I4sJg7atIT1g63H7bb5lDRGR2gJW14RKDD0wFL8TT1g= X-ClientProxiedBy: SI1PR02CA0023.apcprd02.prod.outlook.com (2603:1096:4:1f4::19) To DU0PR04MB9417.eurprd04.prod.outlook.com (2603:10a6:10:358::11) Precedence: bulk X-Mailing-List: imx@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DU0PR04MB9417:EE_|VI1PR04MB7149:EE_ X-MS-Office365-Filtering-Correlation-Id: 543a458b-45ed-469e-8c27-08dc7bce3f5a X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230031|366007|376005|7416005|52116005|1800799015|921011|38350700005; X-Microsoft-Antispam-Message-Info: =?utf-8?q?AkgFUuf8xrZHsowsbb2qUtDLhsaCS+N?= =?utf-8?q?+ae9A/8olbU8rpY5iuzeXAgJ3ZxoRKqmxVxmuQJXQkaQDI5GgWs6W5JnHq0Wlmxpe?= =?utf-8?q?vCASBFtETyjD1u7VwyDWHPW90psMGJdHqVIgQMM/IxHj2Cu85Rdtm3ww2Cdqf6fct?= =?utf-8?q?Ig3bvifX98BqguXOt5+n332spwDbOvx1d++Kew8iUpGo+U4EANC9NALQKSGp7JWTo?= =?utf-8?q?liBZrIrEzbIDfL5LOmMWCQaskdqDltN6OWC4Kwmj9Xvp9nCmLwWIdI539EpmHjV7Q?= =?utf-8?q?YpxpxRTjBqh+kDh4E8wFRMEhSBQbskb69yuvRsjuG0bJEbWx4E8AxVmh/+Fvalvng?= =?utf-8?q?m6WNOor/EVrsSAVzKnz3uHEx+HiQv8kA8rTjocLuSvJmIaTK67e0yi0mo31mAcsyC?= =?utf-8?q?kLkutvjPnoV2Xsfcx/kmXqdWuMu5BR7q2OF/xpnU/43kYPbygzi2Lj3RoTlbSHZLB?= =?utf-8?q?vyovECu5sUJKfa29onpy2jNwpKmFaR8uXeotWXGgLF3saheHzJkjo23fIDj6hhObP?= =?utf-8?q?5Yf9CN02zIy8TPBYF1JaLVZJihq2mWQ4D3uRvgchCPULlEz24pc3Z6XM2RY67UGJZ?= =?utf-8?q?pFhqO6DUGCW5mDVpBq1da61ISJ87FUcbP+2jpjmvAUDiHAmYU96QFXW6OUoOzOC9h?= =?utf-8?q?P6jPV5Z434VNo2DR7wKIEcwcgcW0JJtIj0i0Z8SUITIGITgG6Bp8ILVYjAYzIchDS?= =?utf-8?q?NDck7fznLkEYe+7K4w/bpDnPxFwXUPCzbcQ5LTNed7xmqd3/zCMrbZzuLYLnGdhrf?= =?utf-8?q?Cj5WHSMCXzUWhZ3XDh5SmPulxlglpXiSTmt7aC3Yl+m0VhDp0mIjhImWKI/Y1V3pw?= =?utf-8?q?JUZGaIbWjsmopgH1DGtIcHVrzZ1vEcOS+l4XMYk6gkX94zSTIpIMXN6zUpxXhEhNW?= =?utf-8?q?NS8aaJndcY8OSS48sUZ377/K8Od+XNWg5LNnd2/madzF/uumUkngjSF7ku5OiW99+?= =?utf-8?q?nat6jNAOjm/CWbMx57sHJSPWZ+c6Eb/DDfQbdIafR2ubI8mL8RIuIjl6eLy/tQHg+?= =?utf-8?q?9+hcXBhgq03KmI3vFb2ijUWBmGoBE2AAL1lDraV33AqBKET5hpODCzenIGsBaWLZc?= =?utf-8?q?XbDQo4zozluMnXk+9Sor56bt5kxqWxNAFk8W/ZSJU+sp0XN2ldwkYI15pcUtdVMu6?= =?utf-8?q?gu4QVTkDxbg+coLRazI0yRvsyz9SIzMsQzN8eWY4b3nVwlPc1Vd+J/mRyUqSdtLoM?= =?utf-8?q?ymhmPMWQ7HTC48VjZUhY4Ee0i4I4iKL54wM4K+0TK+GtpCB4TWyXx0aem5Rkn1r2V?= =?utf-8?q?QMuMSgYY0o2FEkMzc62D9ae++f4Xg14whKr0ubwUiFZMdxrjMUDXT/TE=3D?= 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)(376005)(7416005)(52116005)(1800799015)(921011)(38350700005);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?QAsn1pckTPLs2vtMVUZQwxCZ21Zg?= =?utf-8?q?+F7SV24sUlYmmXDHOix3AsNzaDyY2x9l4/+q0gJbE1GnMhiwF97LrjhnXmNJSpUyM?= =?utf-8?q?UGtsR2FcqJ/HBTO/zFffem8JI9b5zRpI8Cn0sOQzyoIFPfr5cJXXil0TKA1yDIzDe?= =?utf-8?q?veVxyymBUuHfoXV+TUNsrdgCqAUI/YErBc9AMPiiIw6RIeccjFwu15DjzLSNY0Lwt?= =?utf-8?q?CbK31ZaoIypyLG4jIHKIa0Y1hA7ojnDJJNHyRkNFrc4e871gUfavB5jOXNaShf8dX?= =?utf-8?q?S296m0GlQDJIvVE+/vkEueUr64aTNX5aCbLRVUDat8J2MjNNKTc0ccvZ4ls153xxB?= =?utf-8?q?QOljmw/nrU1vj0vfCe3xvl+IB9z4XDwbNy6XdOQ0uf0s/QvU7+Ho8Lr6EAPChJ+H5?= =?utf-8?q?gqdbwS/AP6JfkNoek3Ury3WVKP2o7PJLHC/K1pASSfZz1iqgvaPqPKfdRzQhP0DRa?= =?utf-8?q?UNXjvNVkNIn+jhpfBGE1TYytb1rJArM4BA62IMw/hOesmQPCBzwW4PdplSEgae5nP?= =?utf-8?q?JC4vAxmWobgLWxbzFw5llKjf45YE6RI1j5i4n3Q4tVWzaJZFO4zgLk1RJRNgDIWZW?= =?utf-8?q?ZB01KgJzlTNxFc1/WPq16atGw9f6sdTLsYblRTzMQdhaiJdnCw4fAuWGogNYr8RrX?= =?utf-8?q?xJRBeK/qOB/XfB0kH2lI9N10wGziWjvMkoufLInXIvsL8rpSVF7n4d0aWvbTY/fyq?= =?utf-8?q?Aq35YvLa5LmLZsG8W2LtNIHQlWy3NNK+TBehCKXcYE7DNEtuxghB/eNCkCM0KW7AQ?= =?utf-8?q?3T0Nudw6uye7tkgJ+olQjpiozi81ceYBC1Lzg+T6z9eLiezCQXRkvZ6dpKPPFtDdw?= =?utf-8?q?LPt0uoyZU4Ny28zybPQg8Nvahe2Efsj9LXnnpVWq8+KoGY0mVXsXBlCEvQNfPKuel?= =?utf-8?q?5Afoul2oQ8JcYtMdOsrYHOflz052uY4ZMU29jDQNgEqbpzwOtlUDTULz+mojs5fC1?= =?utf-8?q?8fJa9Sf0zcqOTzxMuvaCm+HiF9jn7ymJluIRaDWpG1GfqmH6eX9VKkUIeBZxGAP3b?= =?utf-8?q?jx55/75QWSqyH7/Ar9vwrOp/iHjZsiSIL0POI+YKHOolPyJweM6YWnDrM9n/4TdxK?= =?utf-8?q?rJBGmMvWM2UV9o6Bp1oAASMk5u9KI5jDLAQafzGVtzyG2YhtCRLZ5k0IQ3EzcqLFr?= =?utf-8?q?08FCdh0jIw1+/rZAkW5YbHuCEDdAziQyP0pz2I6vY+AOwz+9PixqXb8TxuvqMP9VD?= =?utf-8?q?+BL3qd6ysxhPGKDuqH3uRszZE7SQfklt+zTUuVrWAKJoqs9CpnVgdzeMsOj0QCahs?= =?utf-8?q?d1lOwwiZuiZm9lkaw2iMYDoOD1X+w4GCay/cREICmxq/1gmYS0SdS4J04RV2EorKf?= =?utf-8?q?lfJ3mI+9M4ccqtZ+xVm9qmODYDqw974VwRd539vbxjfx4GoCqbU8bUN6gfz0Vjlp9?= =?utf-8?q?UGTZDQcn5B2uRwcfIaT2ZMxsd5ALjtAgLLXOR39nLk+U21zI2u0Sw6BZE6WeRvnpF?= =?utf-8?q?7ZMCJQYE9m2Mebg+dGSAQ8uqNFl5Q02haDTKDOoptZQnPtCiStps/mZ0JUKSXMKSa?= =?utf-8?q?xUNpu0e6JCnC?= X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 543a458b-45ed-469e-8c27-08dc7bce3f5a X-MS-Exchange-CrossTenant-AuthSource: DU0PR04MB9417.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 May 2024 08:48:13.6867 (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: H2OdhUjYpDKCItjwLmbDozUeHVIfneLaxXTxUCZWVE1MQGEC91hq/t7Mj3AJyIfN7X8yUFB5btKBj0sMQa9RuQ== X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB7149 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. Signed-off-by: Peng Fan Reviewed-by: Cristian Marussi --- 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 | 380 +++++++++++++++++++++++++++++ include/linux/scmi_imx_protocol.h | 42 ++++ 6 files changed, 441 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..3f8321d247ae --- /dev/null +++ b/drivers/firmware/arm_scmi/imx/imx-sm-bbm.c @@ -0,0 +1,380 @@ +// 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_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 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, 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 = SCMI_IMX_BBM_RTC_ALARM_ENABLE_FLAG; + 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 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 = "i.MX95 EVK", +}; + +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..e59aedaa4aec --- /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, + 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