From patchwork Fri Aug 23 09:05:18 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: 13774805 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 146EBC52D7C for ; Fri, 23 Aug 2024 09:05:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:MIME-Version:Cc:To: In-Reply-To:References:Message-Id:Content-Transfer-Encoding:Content-Type: Subject:Date:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=93Iby0bRJgZa3j0s4ibGUUk5t3AtRn05uBADIkTFaqs=; b=Kz4TBmsbI6Vg3rnM1S5W9nKcGI KwCz6oTb4Oh88Tmmqt1CuOe+yEX6zG4QepDiaK6qNZ+X/rOXDGJCqnRJ/Ar0l7HPdmJNDB3WzoFNT tdiM0/Owkrx3kNXf1+tJaKWjA/kjtamWkUWfsAPSQFI5oEtIllUDcti4K6Jx0z4og6zEvHWJngOhP 9Z8lhdAm4aB/OijpjK9a60axHaqCDu6mre+UIhFcladbyxbazf82EgdXhDqnLcFfK+dRyYFcfb+Qx CrJvT7s5ESeMxgueo4gDDJbZTwdUKWw/VPq24OVfVgckg+3EcYcZvirLsZdrxhcogzZpWfUhFA8s7 0ghgx+Tw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1shQE3-0000000G1Br-1ZAv; Fri, 23 Aug 2024 09:04:55 +0000 Received: from mail-am7eur03on20601.outbound.protection.outlook.com ([2a01:111:f403:260e::601] helo=EUR03-AM7-obe.outbound.protection.outlook.com) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1shQ6M-0000000Fyg2-2CxV for linux-arm-kernel@lists.infradead.org; Fri, 23 Aug 2024 08:57:00 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=Wbzp9TTCh9xWnntKVjVyapHA7hUuU2AN5SDtY7Px/RBVo/BPgfrNCiqZtnEJzG7U2Sfv+6cek7sw5IoSiAFK3L4ttRrhMWXv/m+s1T6tnnrxw9/OiVLIzKfIQTZZgU1X9mxxrBKY3OH4gGmr0YVv1Gv+daYWVgp3kvoEq8OTndMqD5BBOENkJz8sTsKLuIG3ylbDcxkAJOFAvDBx0xsEQJDOGw6sVhsMV60BLQaXwf6wQrQm3mJjOEPGbr38LpF1kHGnoskvuKhz3WE2mrnlnOBGuZQQPZiXWJaYwjBDN4S35EdcPEdJBDbKsmLBvUmE+ZB3+UvayzOzGap96oFM6A== 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=93Iby0bRJgZa3j0s4ibGUUk5t3AtRn05uBADIkTFaqs=; b=l6QV0yFN2LXTNueL+tC6KnDoX4j5dHs4hmn0vRhxqEBnsAvocmetqDoieJjfN1di8wFt4QS8bCWgDlq5xQRpOSam/A9768kDtQTSHDp4rnLTP4hQQUsorw8wEtw9iNtPgxBeWhHLDa8oPmulANFfQfzud2XB8C0yjHvG6e1y7Q7LXY0OabQW1HgmMEB4n7tvoT34FxOPKtdA0s9JmNDHe9rW8u/OFCk9PY9283QIacMTI3uyRi8b7UCxrcAFUS5KL8o7ijic4hZAwDQvNzLvw5FmAbM2oHR+edkErETP4eyLSgiqEd8zPhJm2EJuDvjEDKONqcw5r6SnQpEtOgWcXw== 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=selector1-NXP1-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=93Iby0bRJgZa3j0s4ibGUUk5t3AtRn05uBADIkTFaqs=; b=VOJJL+R/kdJR2HWMX9NHlnnzIujaa5TqSzbfWg65UF0W/hehksIybopig5oPeR9wn57dpSuFBCy53l0knfD695W4Tw/++kVrNWX7kMu+1FMRXwUP3MXTN8I6UNuD5MRqbIW8c9d6N8vAlnBHIhjeabD1aCGqhXPbMgQOKRuBfK867oMZadYQ9YtezhcJT3s1xx59dW5lk7PzDWrp01SwbmiRmyZvHI5yT8fcB4+EG2Slu4qCi7ca+x7u1OtES2faNtlyABwTJnFHhMuf6voZ1WZos09F/UL2OwWiLd+IDP1w43/q3rJXuCq1e+Uu8fKOS0fvzADXnDFJ3rl/rxPk7A== 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 PA1PR04MB10892.eurprd04.prod.outlook.com (2603:10a6:102:488::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7897.19; Fri, 23 Aug 2024 08:56:55 +0000 Received: from PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630]) by PAXPR04MB8459.eurprd04.prod.outlook.com ([fe80::165a:30a2:5835:9630%6]) with mapi id 15.20.7897.014; Fri, 23 Aug 2024 08:56:55 +0000 From: "Peng Fan (OSS)" Date: Fri, 23 Aug 2024 17:05:18 +0800 Subject: [PATCH v8 2/7] firmware: arm_scmi: add initial support for i.MX BBM protocol Message-Id: <20240823-imx95-bbm-misc-v2-v8-2-e600ed9e9271@nxp.com> References: <20240823-imx95-bbm-misc-v2-v8-0-e600ed9e9271@nxp.com> In-Reply-To: <20240823-imx95-bbm-misc-v2-v8-0-e600ed9e9271@nxp.com> To: Sudeep Holla , Cristian Marussi , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Peng Fan , Alexandre Belloni , Dmitry Torokhov Cc: 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.14.1 X-Developer-Signature: v=1; a=ed25519-sha256; t=1724403944; l=14046; i=peng.fan@nxp.com; s=20230812; h=from:subject:message-id; bh=v2Js2Zvagh5LoyvFSfyUnRSKey1cPVTbHPUtPegBylM=; b=GDtKbupGOhA/l8V8VJE/scsLcpMYSBr1ttxHADCupPRjxeKX/vhkhZzV1Cs0PKUZkp6StAMhZ qvDiWmUmUZQDo/vSSgQIwSBTxMeT8EzXmZKVJTnXvqYToYhG2xv6UVz X-Developer-Key: i=peng.fan@nxp.com; a=ed25519; pk=I4sJg7atIT1g63H7bb5lDRGR2gJW14RKDD0wFL8TT1g= X-ClientProxiedBy: SG2PR01CA0173.apcprd01.prod.exchangelabs.com (2603:1096:4:28::29) To PAXPR04MB8459.eurprd04.prod.outlook.com (2603:10a6:102:1da::15) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: PAXPR04MB8459:EE_|PA1PR04MB10892:EE_ X-MS-Office365-Filtering-Correlation-Id: b68227a4-b177-436b-3079-08dcc3518a11 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|366016|52116014|376014|1800799024|7416014|921020|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?q?4OXTOuDjYXKJABDlAtJOjFy1lDiZrp3?= =?utf-8?q?4+FX6vKZim5/yaFHY/QchZzxbQjUWJYAlKljY3KNg+oGcflWMAuJHZjc7el8gU2Xh?= =?utf-8?q?ZQiacjOdMTdviEUFOjcd6xDN6hCyJOt4l7pBdit/Ep8f2ukgAQt6c2BMtrbmdhCnl?= =?utf-8?q?xQu+TPmqyB7GxLXmDVYT87aMbXHyZLmP3eRabXBreLgTX7wgOXiRz6gmqiJofLijQ?= =?utf-8?q?/ib9N7rZgPhI9GuYg6rqlhx4+URnN0eESgfuLnYZLytLfGLnRe+cp/DvJGtL+aTxZ?= =?utf-8?q?cdjNi5zgguv4gLb9tCLKGwhrtSi5TbfR2uTEWMnvOsY3Skep4BIuCrB7g+RlENBwq?= =?utf-8?q?BaUXZd+znAiM7PtBMyg4CnBMQb6cSLMvGmFV57bDMmYH/e7xsC66rUMydB9M5SPol?= =?utf-8?q?T16aUzLNFLdwIiHW/IywKoBxi1poxssKFpfzLTHkclce792U/gUvdNEQQegaFAj4C?= =?utf-8?q?L3TSAR1T1owwh0WlznDHRfm/3h5sqSxcIR0oQUaU9NNE0xOmTUDCrjnuVxRdDAF3O?= =?utf-8?q?QjE481Eabn2zLFx+hfLujTgVj+PmGj8iNu7exra11N8A2097P9xvW1t+nksQPRu4u?= =?utf-8?q?qYs5Ni+j9zeK9swEchB6szczJw6AXCX0YcckXC9MmticBzlp8LJdgW3QpWRlsg6Ia?= =?utf-8?q?sui69Gcsqkj9P+ueCaWXQJTAeN8CY3Cm/5v6cwI8bsHRopDf0+mlulDmOoY8fAJB3?= =?utf-8?q?yG9hNXhz7jEdftw13qcPY86uRWyzK1G89ntBB8qC/DYtgcuaNbKko1Q2N3KgaOof+?= =?utf-8?q?Vzf+GNJZDdZUkwH2cVSu90pAaLscbImBFi4LjvZ12Dpv1olSPbUEf8hDra5KFfBvH?= =?utf-8?q?jncWkPoHK2FmcjyO7MtSN/JU8ScTB8M0oGYEBVPvNHFOGDMllYQGFPs37sK4/zGMj?= =?utf-8?q?6NArqYdHx5uhGQ0B5wus+Yc7GU46vVr+Xc8mhjR9jqz+wXM8gPieDtXsgh5tBqXjM?= =?utf-8?q?rWwHRSG80g+l0Zm3UNmuowdf1G3ZTRxk3MEvCSEJit6P9Ef+KkAq8Kf/BM3JEHX/G?= =?utf-8?q?nsm/GtlhpsNeNzbmrXGwac9DJORoudmWLwgiU2qakQuBiUf0mpexVaukbo7DTvHcr?= =?utf-8?q?mOruIahSdMKvhNDIANx6iaD9bm4yX4ggI5VvaKQQux8iEI0/xw+X2thLODdj4GRuB?= =?utf-8?q?Vd3Km5JPS+fd82IecLlFAPfyWe7fdDAMUGMaPn26nGrOd+ObijmPWoInXMyWgFAaP?= =?utf-8?q?ywEaWuf+SQV1ts4EQUfqlv1nppuqQoLenv0EEzVteswRNn/fVS34mt0PXvAvibv6O?= =?utf-8?q?fpVssTwbX1Etuq10+xv97JYH7Pe4D7yEUGcEATAfoMtBjm2iAktuBe62XGM4Cz2/q?= =?utf-8?q?/AeszFGG7aixFR1o7hEy+LORAfEJH3qnHCbEPmPuokqAofJ2nfsP7pM=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)(366016)(52116014)(376014)(1800799024)(7416014)(921020)(38350700014);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?7JGOKqgTAEUlx+VDgNXTy0lIaVN1?= =?utf-8?q?VOA8n95dlzll4RLnxxlD55ujHkFDLozI1q3SuvMw6A9d/BoBbtpckKiKMbUSOw9LL?= =?utf-8?q?6+IDDIS6uKHvuPadXgA+w2hkRR3/tlrshFjSlaRY/zeV5eYK75eaKvA/1C2b2cMm6?= =?utf-8?q?20I/xfMhKt33cbb+ut+C9rOwLBMMvwLxsAVHcxHTZNXHjAbOA0JOQ+vWg/dyEL9aZ?= =?utf-8?q?lRhwXl3ujcS/3S7r48SOb9q7oharE3ol9VkpCK6QzCPnc6N04POZ388Dx3GYMEbTq?= =?utf-8?q?k1COQx8jgnWTqd4kRdhk1vwS+0TPTkKzRJ/02UCMt6RtOqzH+IPWFP7ZMSpQXBzwm?= =?utf-8?q?v+b5hd69Fe2aBXVm9z1N0GsA/OPDIbEWUdiMaaHgJj/4dlKniNHke8gUZCemw3fMa?= =?utf-8?q?ERaOEMwF9mKu6BtL4rOU3OkHNQXTwjh32SwLcdrwszkN8auJcs/9sf6fj7Y8MHs3n?= =?utf-8?q?oPl5xYX4cpYOSBjiLVFH1JtMdbvoj0fvrmVCijQ/d5iUHT3qN5dntyeSZxRWfWcKn?= =?utf-8?q?g9FRBHDAGwQIoh8btaiyP6u8zb5TD2GArXEotMjEy44YHnpWaSd7nslESUJVBw953?= =?utf-8?q?FoIAaVpMD3tqxM+m5do5DZUch9tXvUvfECWbhKkCRlj9Nn4/iG+X8joc61aPWhETG?= =?utf-8?q?QIUA5oG4+7BQcO6+xaXCH6hWebtYqAfCRt7u4lbz88wM6DUl3k62qiCbaYdv7ZTuF?= =?utf-8?q?2IYs4/ODPEXwulEeeO/VcccY0QRSAQLJFIMeoXeAnqC6Hhq+j3RuBnbJMp4x1sIPy?= =?utf-8?q?dTrRD7ycSEShNqAisDvZovLe6TnsEtCCZWD41UAUyfauxjKZtTN74NqGsFo0sgutj?= =?utf-8?q?cRYXBZ7rj9b8X+hOgAOqrzz6SYX7Tx+ij6Q80dM8H7xUyEwHpGcHJv3v6oaZgkuBy?= =?utf-8?q?DUEboUb74VG/5LiilwfrAltL2VmF/GM2RC1OzkXrjvMZ4iK7E8GFHcPqXyh2NfcV/?= =?utf-8?q?nRuTZ/lJQT7Ad4MrsCO7O4kzMhng1lCscdLMITrJAfJSkGTrcDmkH7oH0iAAc4AqA?= =?utf-8?q?9VyLcuXjUUVjuB9xJUX6uqnzc7PcrzKSYax83Yk//a8cAUBCQbEIN+GQYjA51Eyka?= =?utf-8?q?7fsVg0y7GMUny0gYvg05HRDDjX/xRJY5NHFserWSKH0D8bCnd+yZ3rKqAbI+QS3vx?= =?utf-8?q?x9MHl/7EZNZOMBVu/Aa3dNMI+spVr4JjHZZaIi/weqT6gSc9wqFOe+VdtG8V9p1o/?= =?utf-8?q?+clWomOnNOIil4dDQ/5ARgRaiyFpQuaPH9b2vibHUfcJxDpYny57VaCGFbb2cO8Ka?= =?utf-8?q?i6JfE+ocTzC2dw4tZqIeJtgDVq8JNtt5Ayq/E05Mqa3KrNNQ+9pglrTCESwfB503s?= =?utf-8?q?sAaYdgGhPpFEGk37Chy109L4oKVtS6rXn27Dpy8zQiNudfiBdh9cbkHIGcUF9Z20x?= =?utf-8?q?lSJmxC5ORGzcbGKA9Mkf6+a9772nXTZBRKjZ6kBsmpWoTpTwIw7owtiayAi3etf2v?= =?utf-8?q?iEU55FZmuJQc2QC8O3Sya5fToUD+wm3kTjjeiUhgRfwztFXqD/qTRzVjM4TZy/OBx?= =?utf-8?q?dSKNjhpM1/j3?= X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: b68227a4-b177-436b-3079-08dcc3518a11 X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8459.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Aug 2024 08:56:55.6907 (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: YraZ4w4yIlRjN2NpRxDWrP1NJazEOLJjN52OMD9FuVz0flIYYAoHAciejfist5WgsZormxG9/kFldSjxuSSUxA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: PA1PR04MB10892 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240823_015658_776649_D3BD195B X-CRM114-Status: GOOD ( 14.56 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org 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 | 1 + drivers/firmware/arm_scmi/Makefile | 1 + drivers/firmware/arm_scmi/vendors/imx/Kconfig | 13 + drivers/firmware/arm_scmi/vendors/imx/Makefile | 2 + drivers/firmware/arm_scmi/vendors/imx/imx-sm-bbm.c | 379 +++++++++++++++++++++ include/linux/scmi_imx_protocol.h | 42 +++ 6 files changed, 438 insertions(+) diff --git a/drivers/firmware/arm_scmi/Kconfig b/drivers/firmware/arm_scmi/Kconfig index 67053c1862d1..dabd874641d0 100644 --- a/drivers/firmware/arm_scmi/Kconfig +++ b/drivers/firmware/arm_scmi/Kconfig @@ -70,6 +70,7 @@ config ARM_SCMI_DEBUG_COUNTERS SCMI monitoring. source "drivers/firmware/arm_scmi/transports/Kconfig" +source "drivers/firmware/arm_scmi/vendors/imx/Kconfig" endif #ARM_SCMI_PROTOCOL diff --git a/drivers/firmware/arm_scmi/Makefile b/drivers/firmware/arm_scmi/Makefile index 9659b7d1b963..9ac81adff567 100644 --- a/drivers/firmware/arm_scmi/Makefile +++ b/drivers/firmware/arm_scmi/Makefile @@ -11,6 +11,7 @@ scmi-protocols-y += pinctrl.o scmi-module-objs := $(scmi-driver-y) $(scmi-protocols-y) $(scmi-transport-y) obj-$(CONFIG_ARM_SCMI_PROTOCOL) += transports/ +obj-$(CONFIG_ARM_SCMI_PROTOCOL) += vendors/imx/ obj-$(CONFIG_ARM_SCMI_PROTOCOL) += scmi-core.o obj-$(CONFIG_ARM_SCMI_PROTOCOL) += scmi-module.o diff --git a/drivers/firmware/arm_scmi/vendors/imx/Kconfig b/drivers/firmware/arm_scmi/vendors/imx/Kconfig new file mode 100644 index 000000000000..51ccbd038627 --- /dev/null +++ b/drivers/firmware/arm_scmi/vendors/imx/Kconfig @@ -0,0 +1,13 @@ +# 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/vendors/imx/Makefile b/drivers/firmware/arm_scmi/vendors/imx/Makefile new file mode 100644 index 000000000000..a7dbdd20dbb9 --- /dev/null +++ b/drivers/firmware/arm_scmi/vendors/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/vendors/imx/imx-sm-bbm.c b/drivers/firmware/arm_scmi/vendors/imx/imx-sm-bbm.c new file mode 100644 index 000000000000..0df7ca135c34 --- /dev/null +++ b/drivers/firmware/arm_scmi/vendors/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