From patchwork Thu Oct 31 08:35:55 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ciprian Costea X-Patchwork-Id: 13857716 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 3216EE6895D for ; Thu, 31 Oct 2024 08:41:31 +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: Content-Transfer-Encoding:Content-Type:References:In-Reply-To:Message-ID:Date :Subject:Cc:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=wWaawxt77xC7mKWZ021v9pDtAqdlR6gtuXp4zwKk9E4=; b=dhI8IkFxkjPQZL9fSb0qirxiT0 rMTNFmBj0YtQayvGDIwXyZGlZ+Vd4F8f/QfpHYkguEbDlziwiHAFYUl3xyhz56zTGq9unFgT1B4a7 tUnoxvdqXIxNGR0LeMjMKDgbj8QI6HjF2kWJPdgWPGGFESv2WKXmspBPshVnG/wKlFPL5RA1DoDW1 9OtMYkchlHUJ0x2yLhZgTj8pFUFpUQv/aFSP89Ve5Q2Js79Q7Xp5rQ1c7U776w8j4URx+nbTCmezS MRB7Jc7CxTRoMxXxo3ha9gHEjzGoLHPcdeIaoYgSQvEJKusww3933iDAAqit9DPI5KJCZ8z8TeONl 1H681xdw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98 #2 (Red Hat Linux)) id 1t6Qk0-00000002yHl-1vQx; Thu, 31 Oct 2024 08:41:16 +0000 Received: from mail-am0eur02on20601.outbound.protection.outlook.com ([2a01:111:f403:2606::601] helo=EUR02-AM0-obe.outbound.protection.outlook.com) by bombadil.infradead.org with esmtps (Exim 4.98 #2 (Red Hat Linux)) id 1t6Qf7-00000002xUe-1Flj for linux-arm-kernel@lists.infradead.org; Thu, 31 Oct 2024 08:36:15 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=spCCmr1/cSpv+R/dGoFVy43lpzWg0KNmgVOLo2Fg3K7hvptUvq6JU8Pit+fNqFeWP/vD9/jDfx7rVIg9SqvTnOfPVhcOBIPk1u8fJES434GGPwyOYrf3s4Iw+U50LYRWcnB9vIyaSlR2hywF3c5Ylhyk3NkQC/0CMgbvSUsOg3a75CNWfC5WdwOwypwMvllqGP3ol4xe5BttqwnYoP/1ZrVEOkJcI9/tOXTDQxScqYHiwGTqyO6Z/QxiNHtwLldTdcATwei35t5Xdr48I4V1q2xYzntJfqqTkzVI2lQpZ5Kaf5GKFUgDfEnJctLGbU9Fq/c2dtsLB5VriCM2KxF2bA== 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=wWaawxt77xC7mKWZ021v9pDtAqdlR6gtuXp4zwKk9E4=; b=TugtEVmpdViwi3L8okpTvOtrRz90Xo5/iLyL7ZPeIYf27Gpz+8mgbpJOt52SRA7pikLj8yC2iPjYhrT+uUgmRztHNhjpxnV5nLurqFrrIujt8tVCdyMBltlFtBMsYq2d6vV2pbQLuOg8kz1dAByr04eMrWdGbxOB24icAF40Jm2AWArkItnXD0CIJyIl7+ADxIOZyyKGobERQIhUNGXpQqX0cySaGNuDJ+VUNyUYgA+T0do5YgVRq2DpkIy/Ze2eX4FX4LPcnkccD9Ba4bh2f1UYBnYQFNu6HDlK9DiPZYwjfx8mt8SWozgZgRyucAZnfZE6Mma4t6RDK9mJlZt5tw== 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=wWaawxt77xC7mKWZ021v9pDtAqdlR6gtuXp4zwKk9E4=; b=EhgaPzAuOG8H1iiEzvDzFIE5ZswIbufkWBCCkdBAcVdOLKtARJZeMYy5HRXxPHmNvPhhtaIVntSv+Kh/tmxzyeEpMWj8Q48eAl+5/i+YXeqB6G2bpevWgJ1b9t+zirmIsT2YqJpmffN4sV91zWuz58L+PLPxE/ZIEA79dT2Xd3x/wPVEIhlon6lQwOXjmKJ35wePb6hjzhVaZygYNqzFRtN6Z1ucR0kTzh5O+3fkiwTRuREz8MCWJNh/yffKqM7cpEBdzFDIRBwcIEpPH2X/e0ubFwaTdbl6HLNNw9cFuGnzpUL6yMfK0kbWXy/FGgf6/zhE8UrHNOYWXugM8eqjag== Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=oss.nxp.com; Received: from DU0PR04MB9251.eurprd04.prod.outlook.com (2603:10a6:10:352::15) by VI1PR04MB7199.eurprd04.prod.outlook.com (2603:10a6:800:11d::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8093.32; Thu, 31 Oct 2024 08:36:04 +0000 Received: from DU0PR04MB9251.eurprd04.prod.outlook.com ([fe80::708f:69ee:15df:6ebd]) by DU0PR04MB9251.eurprd04.prod.outlook.com ([fe80::708f:69ee:15df:6ebd%6]) with mapi id 15.20.8093.025; Thu, 31 Oct 2024 08:36:04 +0000 From: Ciprian Costea To: Alexandre Belloni , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Catalin Marinas , Will Deacon Cc: linux-rtc@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, NXP S32 Linux Team , Christophe Lizzi , Alberto Ruiz , Enric Balletbo , Ciprian Marian Costea , Bogdan Hamciuc , Ghennadi Procopciuc Subject: [PATCH v3 2/4] rtc: s32g: add NXP S32G2/S32G3 SoC support Date: Thu, 31 Oct 2024 10:35:55 +0200 Message-ID: <20241031083557.2156751-3-ciprianmarian.costea@oss.nxp.com> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20241031083557.2156751-1-ciprianmarian.costea@oss.nxp.com> References: <20241031083557.2156751-1-ciprianmarian.costea@oss.nxp.com> X-ClientProxiedBy: AM0PR04CA0143.eurprd04.prod.outlook.com (2603:10a6:208:55::48) To DU0PR04MB9251.eurprd04.prod.outlook.com (2603:10a6:10:352::15) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DU0PR04MB9251:EE_|VI1PR04MB7199:EE_ X-MS-Office365-Filtering-Correlation-Id: 7dd8dd6c-1c09-4344-c419-08dcf9870eed 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|7416014|376014|366016|1800799024; X-Microsoft-Antispam-Message-Info: =?utf-8?q?3Niemn3u1TQkQ/ojmLKlJE/mE2EEHRs?= =?utf-8?q?73QHPfSjTzwVIg5/XUdcLlkSYc7r3TxH+5QY+673f0C2bZW/01i8qQk2eueMU5FZo?= =?utf-8?q?zi0SNertfp7UQEd9MyW4ecu+qBpJLRFPA30W/yCrbDIzxEK6ZCtAurWuBSVVUgMbS?= =?utf-8?q?mPDc+NQMFE1Pe9W4nIroArmFn3e0qNmnSo/Xj8BHavujoAhDIJTL5sHNhmiJnrASg?= =?utf-8?q?CVetQe45Ow4kYJFVmp6VQya+8OlpQeGGZi3UhY+VlyLZ67VTd/r1Gxw0IyqPjbE4H?= =?utf-8?q?X/J4TmSauRnuK+Rz0u1Eg1BKUWKutXMUxJWtzMfoVtKHxlKskN2qIao+UcfmBop/2?= =?utf-8?q?SNzxFgCM4rZapMc9nrPD+uyekR4YFU7DeaPrgZz+M5OLs+Oc659ICEPawge4PKc+6?= =?utf-8?q?G2yxP6tYI7Ud/RzLPaOVE60xyYNAwfhl0dcG1sLUS6nk2XDuvEiYv7T7UFCcroZL7?= =?utf-8?q?8dDhxA640hInYRL81Lbs4hef01qpoSwHfRX94a+Ajz0/go30hHioxhEZEqJnzjoa8?= =?utf-8?q?CzhYYCDQuRjpHGcR2fMMVsC87EyuflXaLaIL/EjQBbbB135NqobP7rDw82C0EZqgx?= =?utf-8?q?Jj2bTvUpmlYpE4yA24EoV1DDsRMHXtsQukK6Bt8ngN3AOLTGITLImLGDPyhAfyZOE?= =?utf-8?q?SH1jE8emz4gs3YO7xOruiKioWKcY2Y+p6ReC8/kV0GANmZe+Y2//tDd9HF1rX64dP?= =?utf-8?q?9KCu1fcJFCbNpkO21FHYW0Xgm6amO49M8Q4YuUkA0qFBo6yO51AQlsXUeIcTUMmcM?= =?utf-8?q?iSsvzlwFIJrK/y/jChwCMW3XvpzgW+2PH3lA4phFKgLQhgMYRlO9ys2sJJwP4/kx7?= =?utf-8?q?9iO4vLniRUOC1/UZyXuO9ak1H36/BL7R/S3RJaQ/srZBLXW+YyoqTYSZEkXT7r5TX?= =?utf-8?q?5hrUNDBL3aBMlmY7k5x3cxMI7QE+G4xE7pIIpMX9McJ7QybThO2EQDCOMPaZMiryF?= =?utf-8?q?Xkz05UgLs7RZvtsHmuDbcIiKSwGaRYYYPewZJgtVhU5LXEc4FBId2V1SFueXcVwsS?= =?utf-8?q?cn02gW85YkMgGpIXT3p9ya+IVQUkZON2u66NqBDcTr/MIkUqUyJhdb9DtDiviiG90?= =?utf-8?q?BdEgzHhRlXx4UuNJX+ZDO8S1fVETNTtWNnYIJeAnmLg2t0GMB78LIEm2F5FTaifzP?= =?utf-8?q?5Ow3/3JuGrqYZTNUdgINtTuqDczDtSpgytzaISQV6IXWZ8prTM3tADFno12Vr1u5a?= =?utf-8?q?kPLk498jLK9W/z0cn7wrvmcx/eG36PrMF7JnFJMpEP3sKhjMTyCk4JVGY=3D?= X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:DU0PR04MB9251.eurprd04.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230040)(7416014)(376014)(366016)(1800799024);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?Vao94CjyTVXFBioYd8vSbm0e3zIm?= =?utf-8?q?rE+oyDlil1lXDsUwFLrchZXEkBeuld0+UEfjTbLtwA6RX5KPZyv0Ua6l1Y+6qMKzZ?= =?utf-8?q?1E+GNk4EuHCvfjVlFiFRHcC+s+4OypvpU/mBtZWrFn4TKnqEsYiZARjHJ7btrdOfI?= =?utf-8?q?kM/u7wi8ck0su5suNxq83zfBenV1LuvMMKApqu2aqGZIf2/01FhfUZVG03tJCgoPl?= =?utf-8?q?sw02i4O+KsDjS+8VXTF530M53W5zcActnCGuXu7JUzD6cTe8Tn59h1QC44UuO4BPl?= =?utf-8?q?pyniO/rXMAnesOybyDhBdnVkeOL2Lfde0ZNjtDZ8V6Q9to5sep83UuE4NOTfbPimK?= =?utf-8?q?o+kPUvEGKHU8HqPBVf4PmZzuJvFbKBYtvWy5qLKPGo6IyfBO0YlkxWD7Ya6Q0qX5q?= =?utf-8?q?2xuMyo0HQ0n+GlydcHpa1n4TtyQddinfkR4hVh1zx5FV3xgVazoN63aXuLGVL/3qn?= =?utf-8?q?aGGbqvyDEzZeZ7KvR1/V1vxFd5wsF0m3aLguQb16G3AFaaCga1j8pSeZnAX5XAGA1?= =?utf-8?q?I79a+qmMcLc+/K2rTsfY7s1VlgXB0dSIXNyn6p8dTaT+NccyPnciP+36EH+8DWh5v?= =?utf-8?q?tkw75YkOVLvxK2tji3PlbrzQFYgBs2LYBwjKMYD//7uQjc+4WqmcjvGPhlpHL6SRd?= =?utf-8?q?6Vz0bzT+Wl+X4z7wc19jAuF6TcKzKEfvnsB8VeAcBjME8QZGmhHYR1z65H8IuB0q5?= =?utf-8?q?ZU48awODebC76cs/MmPecEewZUvuKWs9CWBF9wgktsEY1daGzloFeMuK/cHAKMSO2?= =?utf-8?q?6G7P4bAaI1a5WYfPnGzIv4LwQ+sAbYplVwnUA/Hgeh0C9BPPJqhz8QVz8r1TiHPV3?= =?utf-8?q?bdVorjUjAM35JIYabpvdrZvU9y2vH77BH/omcTR10B84JtOFpELXzyykcSFvwXdhn?= =?utf-8?q?R40WXwDasLEIvx4GX0sFF+ja/gyw/BK8rNVAJe87dkk0cJWsKZwOlyCEKHF/Aqo66?= =?utf-8?q?a3lIRcO1RC++O2E0c6NLJMkIOK+g81deMDVV4BPDB2O+LbzdarYfQYe7OsxfIvcI4?= =?utf-8?q?ecvY+bqEjsH5PwCffOEQWHsgAhZpdDv/wb80D+6EiBk3SqTKICgays83ntiAYO+M8?= =?utf-8?q?BiZdtT1TduUSe+5IMnfs/4xYDcIrjTQ/tZ7r339y5OxI4AapntSJcitqH6ldXSCgR?= =?utf-8?q?JttQA/o1Bi2r9jKZjgktwOSWVanpcE+JvJ0/OnAb6yb+tyL419iZ3yuYzTwX3PaTv?= =?utf-8?q?OKRTWHnPjEb/uWdeA23r35wqcYIIsLrh4jmwBe8Bj3IS13puGD0fmml0rWVO/iJv5?= =?utf-8?q?ECDDrnjNk+hLM+ZvlndAaFSXhjtQgQgZQMclZV/Fel11BLn7+9jFYwmoSGuup0/om?= =?utf-8?q?LAu5+8slYJNkDbHxWbndPjqb//eTuhPzAjtuLDRIobAbZU1unHi0YwzSiV2ifUlbP?= =?utf-8?q?/xVf2CGJgZsDpoEm1lgrHppg+AfxmbwVR96kKlQXhz3deTIE3TjvomMG7i+x4x8ZO?= =?utf-8?q?PyAiKXhbb2hfTMrDGm0eCMFmMf/EFHXbpYlPiUsoKGwm/UeA/RdsPpf8JsXpht2Mx?= =?utf-8?q?IQjvszyxTVkb+iQrnfrEZPjJTBM5/Cfb4Q=3D=3D?= X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 7dd8dd6c-1c09-4344-c419-08dcf9870eed X-MS-Exchange-CrossTenant-AuthSource: DU0PR04MB9251.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Oct 2024 08:36:04.8160 (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: T+JqzI+LqDyScBYMivivW9wxvwdWk3jvu2NtmHDCfHnjVrtHo3DDllBLr7KAq2W2DSimIYEaOSCSXKPRdni5HBf833tTJC+YHF2kqsyK0Ak= X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB7199 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20241031_013613_554677_25273D18 X-CRM114-Status: GOOD ( 23.80 ) 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: Ciprian Marian Costea Add a RTC driver for NXP S32G2/S32G3 SoCs. The RTC module is used to enable Suspend to RAM (STR) support on NXP S32G2/S32G3 SoC based boards. RTC tracks clock time during system suspend. RTC from S32G2/S32G3 is not battery-powered and it is not kept alive during system reset. Co-developed-by: Bogdan Hamciuc Signed-off-by: Bogdan Hamciuc Co-developed-by: Ghennadi Procopciuc Signed-off-by: Ghennadi Procopciuc Signed-off-by: Ciprian Marian Costea --- drivers/rtc/Kconfig | 11 + drivers/rtc/Makefile | 1 + drivers/rtc/rtc-s32g.c | 803 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 815 insertions(+) create mode 100644 drivers/rtc/rtc-s32g.c diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig index e87c3d74565c..18fc3577f6cd 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -2054,4 +2054,15 @@ config RTC_DRV_SSD202D This driver can also be built as a module, if so, the module will be called "rtc-ssd20xd". +config RTC_DRV_S32G + tristate "RTC driver for S32G2/S32G3 SoCs" + depends on ARCH_S32 || COMPILE_TEST + depends on COMMON_CLK + help + Say yes to enable RTC driver for platforms based on the + S32G2/S32G3 SoC family. + + This RTC module can be used as a wakeup source. + Please note that it is not battery-powered. + endif # RTC_CLASS diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile index 8ee79cb18322..a63d010a753c 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -158,6 +158,7 @@ obj-$(CONFIG_RTC_DRV_RX8025) += rtc-rx8025.o obj-$(CONFIG_RTC_DRV_RX8111) += rtc-rx8111.o obj-$(CONFIG_RTC_DRV_RX8581) += rtc-rx8581.o obj-$(CONFIG_RTC_DRV_RZN1) += rtc-rzn1.o +obj-$(CONFIG_RTC_DRV_S32G) += rtc-s32g.o obj-$(CONFIG_RTC_DRV_S35390A) += rtc-s35390a.o obj-$(CONFIG_RTC_DRV_S3C) += rtc-s3c.o obj-$(CONFIG_RTC_DRV_S5M) += rtc-s5m.o diff --git a/drivers/rtc/rtc-s32g.c b/drivers/rtc/rtc-s32g.c new file mode 100644 index 000000000000..a05e23ece72a --- /dev/null +++ b/drivers/rtc/rtc-s32g.c @@ -0,0 +1,803 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Copyright 2024 NXP + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#define RTCC_OFFSET 0x4ul +#define RTCS_OFFSET 0x8ul +#define RTCCNT_OFFSET 0xCul +#define APIVAL_OFFSET 0x10ul +#define RTCVAL_OFFSET 0x14ul + +/* RTCC fields */ +#define RTCC_CNTEN BIT(31) +#define RTCC_RTCIE_SHIFT 30 +#define RTCC_RTCIE BIT(RTCC_RTCIE_SHIFT) +#define RTCC_ROVREN BIT(28) +#define RTCC_APIEN BIT(15) +#define RTCC_APIIE BIT(14) +#define RTCC_CLKSEL_OFFSET 12 +#define RTCC_CLKSEL_MASK GENMASK(13, 12) +#define RTCC_CLKSEL(n) (((n) << 12) & RTCC_CLKSEL_MASK) +#define RTCC_DIV512EN BIT(11) +#define RTCC_DIV32EN BIT(10) + +/* RTCS fields */ +#define RTCS_RTCF BIT(29) +#define RTCS_INV_RTC BIT(18) +#define RTCS_APIF BIT(13) +#define RTCS_ROVRF BIT(10) + +#define ROLLOVER_VAL GENMASK(31, 0) +#define RTC_SYNCH_TIMEOUT (100 * USEC_PER_MSEC) + +#define RTC_CLK_MUX_SIZE 4 + +/* + * S32G2 and S32G3 SoCs have RTC clock source 1 reserved and + * should not be used. + */ +#define RTC_QUIRK_SRC1_RESERVED BIT(2) + +#define to_rtcpriv(_hw) container_of(_hw, struct rtc_priv, clk) + +enum { + RTC_CLK_SRC0 = 0, + RTC_CLK_SRC1, + RTC_CLK_SRC2, + RTC_CLK_SRC3 +}; + +enum { + DIV1 = 1, + DIV32 = 32, + DIV512 = 512, + DIV512_32 = 16384 +}; + +struct rtc_time_base { + s64 sec; + u64 cycles; + u64 rollovers; + struct rtc_time tm; +}; + +struct rtc_priv { + struct rtc_device *rdev; + u8 __iomem *rtc_base; + struct clk_hw clk; + struct clk *ipg; + const struct rtc_soc_data *rtc_data; + struct rtc_time_base base; + u64 rtc_hz; + u64 rollovers; + int dt_irq_id; + int runtime_src_idx; + int suspend_src_idx; + u32 runtime_div; + u32 suspend_div; +}; + +struct rtc_soc_data { + int default_runtime_src_idx; + int default_suspend_src_idx; + u32 default_runtime_div; + u32 default_suspend_div; + u32 quirks; +}; + +static const struct rtc_soc_data rtc_s32g2_data = { + .default_runtime_src_idx = RTC_CLK_SRC2, + .default_suspend_src_idx = RTC_CLK_MUX_SIZE + RTC_CLK_SRC0, + .default_runtime_div = DIV512, + .default_suspend_div = DIV512, + .quirks = RTC_QUIRK_SRC1_RESERVED, +}; + +static int is_src1_reserved(struct rtc_priv *priv) +{ + return priv->rtc_data->quirks & RTC_QUIRK_SRC1_RESERVED; +} + +static u64 cycles_to_sec(u64 hz, u64 cycles) +{ + return div_u64(cycles, hz); +} + +/* + * Convert a number of seconds to a value suitable for RTCVAL in our clock's + * current configuration. + * @rtcval: The value to go into RTCVAL[RTCVAL] + * Returns: 0 for success, -EINVAL if @seconds push the counter at least + * twice the rollover interval + */ +static int sec_to_rtcval(const struct rtc_priv *priv, + unsigned long seconds, u32 *rtcval) +{ + u32 rtccnt, delta_cnt; + u32 target_cnt = 0; + + /* For now, support at most one rollover of the counter */ + if (!seconds || seconds > cycles_to_sec(priv->rtc_hz, ROLLOVER_VAL)) + return -EINVAL; + + /* + * RTCCNT is read-only; we must return a value relative to the + * current value of the counter (and hope we don't linger around + * too much before we get to enable the interrupt) + */ + delta_cnt = seconds * priv->rtc_hz; + rtccnt = ioread32(priv->rtc_base + RTCCNT_OFFSET); + + if (~rtccnt < delta_cnt) + target_cnt = (delta_cnt - ~rtccnt); + else + target_cnt = rtccnt + delta_cnt; + + /* + * According to RTCVAL register description, + * its minimum value should be 4. + */ + if (unlikely(target_cnt < 4)) + target_cnt = 4; + + *rtcval = target_cnt; + + return 0; +} + +static irqreturn_t rtc_handler(int irq, void *dev) +{ + struct rtc_priv *priv = platform_get_drvdata(dev); + u32 status; + + status = ioread32(priv->rtc_base + RTCS_OFFSET); + if (status & RTCS_ROVRF) { + if (priv->rollovers == ULONG_MAX) + priv->rollovers = 0; + else + priv->rollovers++; + } + + if (status & RTCS_RTCF) { + iowrite32(0x0, priv->rtc_base + RTCVAL_OFFSET); + rtc_update_irq(priv->rdev, 1, RTC_AF); + } + + if (status & RTCS_APIF) + rtc_update_irq(priv->rdev, 1, RTC_PF); + + iowrite32(status, priv->rtc_base + RTCS_OFFSET); + + return IRQ_HANDLED; +} + +static int get_time_left(struct device *dev, struct rtc_priv *priv, + u32 *sec) +{ + u32 rtccnt = ioread32(priv->rtc_base + RTCCNT_OFFSET); + u32 rtcval = ioread32(priv->rtc_base + RTCVAL_OFFSET); + + if (rtcval < rtccnt) { + dev_err(dev, "RTC timer expired before entering suspend\n"); + return -EIO; + } + + *sec = cycles_to_sec(priv->rtc_hz, rtcval - rtccnt); + + return 0; +} + +static s64 s32g_rtc_get_time_or_alrm(struct rtc_priv *priv, + u32 offset) +{ + u64 cycles, base_cycles; + u32 counter; + s64 sec; + + counter = ioread32(priv->rtc_base + offset); + cycles = priv->rollovers * ROLLOVER_VAL + counter; + base_cycles = priv->base.cycles + priv->base.rollovers * ROLLOVER_VAL; + + if (cycles < base_cycles) + return -EINVAL; + + cycles -= base_cycles; + sec = priv->base.sec + cycles_to_sec(priv->rtc_hz, cycles); + + return sec; +} + +static int s32g_rtc_read_time(struct device *dev, + struct rtc_time *tm) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + s64 sec; + + if (!tm) + return -EINVAL; + + sec = s32g_rtc_get_time_or_alrm(priv, RTCCNT_OFFSET); + if (sec < 0) + return -EINVAL; + + rtc_time64_to_tm(sec, tm); + + return 0; +} + +static int s32g_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + u32 rtcc, sec_left; + s64 sec; + + if (!alrm) + return -EINVAL; + + sec = s32g_rtc_get_time_or_alrm(priv, RTCVAL_OFFSET); + if (sec < 0) + return -EINVAL; + + rtc_time64_to_tm(sec, &alrm->time); + + rtcc = ioread32(priv->rtc_base + RTCC_OFFSET); + alrm->enabled = sec && (rtcc & RTCC_RTCIE); + + alrm->pending = 0; + if (alrm->enabled && !get_time_left(dev, priv, &sec_left)) + alrm->pending = !!sec_left; + + return 0; +} + +static int s32g_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + u32 rtcc; + + if (!priv->dt_irq_id) + return -EIO; + + /* + * RTCIE cannot be deasserted because it will also disable the + * rollover interrupt. + */ + rtcc = ioread32(priv->rtc_base + RTCC_OFFSET); + if (enabled) + rtcc |= RTCC_RTCIE; + + iowrite32(rtcc, priv->rtc_base + RTCC_OFFSET); + + return 0; +} + +static int s32g_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + struct rtc_time time_crt; + long long t_crt, t_alrm; + u32 rtcval, rtcs; + int ret = 0; + + iowrite32(0x0, priv->rtc_base + RTCVAL_OFFSET); + + t_alrm = rtc_tm_to_time64(&alrm->time); + + /* + * Assuming the alarm is being set relative to the same time + * returned by our s32g_rtc_read_time callback + */ + ret = s32g_rtc_read_time(dev, &time_crt); + if (ret) + return ret; + + t_crt = rtc_tm_to_time64(&time_crt); + if (t_alrm <= t_crt) { + dev_warn(dev, "Alarm is set in the past\n"); + return -EINVAL; + } + + ret = sec_to_rtcval(priv, t_alrm - t_crt, &rtcval); + if (ret) { + /* + * Rollover support enables RTC alarm + * for a maximum timespan of ~3 months. + */ + dev_warn(dev, "Alarm is set too far in the future\n"); + return ret; + } + + ret = read_poll_timeout(ioread32, rtcs, !(rtcs & RTCS_INV_RTC), + 0, RTC_SYNCH_TIMEOUT, false, priv->rtc_base + RTCS_OFFSET); + if (ret) { + dev_err(dev, "Synchronization failed\n"); + return ret; + } + + iowrite32(rtcval, priv->rtc_base + RTCVAL_OFFSET); + + return 0; +} + +static int s32g_rtc_set_time(struct device *dev, + struct rtc_time *time) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + + if (!time) + return -EINVAL; + + priv->base.rollovers = priv->rollovers; + priv->base.cycles = ioread32(priv->rtc_base + RTCCNT_OFFSET); + priv->base.sec = rtc_tm_to_time64(time); + + return 0; +} + +/* + * Disable the 32-bit free running counter. + * This allows Clock Source and Divisors selection + * to be performed without causing synchronization issues. + */ +static void s32g_rtc_disable(struct rtc_priv *priv) +{ + u32 rtcc = ioread32(priv->rtc_base + RTCC_OFFSET); + + rtcc &= ~RTCC_CNTEN; + iowrite32(rtcc, priv->rtc_base + RTCC_OFFSET); +} + +static void s32g_rtc_enable(struct rtc_priv *priv) +{ + u32 rtcc = ioread32(priv->rtc_base + RTCC_OFFSET); + + rtcc |= RTCC_CNTEN; + iowrite32(rtcc, priv->rtc_base + RTCC_OFFSET); +} + +static int get_div_config(unsigned long req_rate, + unsigned long prate) +{ + if (req_rate == prate) + return DIV1; + else if (req_rate == prate / (DIV512 * DIV32)) + return DIV512_32; + else if (req_rate == prate / DIV512) + return DIV512; + else if (req_rate == prate / DIV32) + return DIV32; + + return 0; +} + +static void adjust_dividers(struct rtc_priv *priv, + u32 div_val, u32 *reg) +{ + switch (div_val) { + case DIV512_32: + *reg |= RTCC_DIV512EN; + *reg |= RTCC_DIV32EN; + break; + case DIV512: + *reg |= RTCC_DIV512EN; + break; + case DIV32: + *reg |= RTCC_DIV32EN; + break; + default: + return; + } + + priv->rtc_hz /= div_val; +} + +static unsigned long get_prate_by_index(struct clk_hw *hw, + u8 index) +{ + struct clk_hw *parent; + + parent = clk_hw_get_parent_by_index(hw, index); + if (!parent) + return -EINVAL; + + return clk_hw_get_rate(parent); +} + +static int rtc_clk_determine_rate(struct clk_hw *hw, + struct clk_rate_request *req) +{ + struct rtc_priv *priv = to_rtcpriv(hw); + struct device *dev = priv->rdev->dev.parent; + int i, num_parents = clk_hw_get_num_parents(hw); + u32 config; + + for (i = 0; i < num_parents; i++) { + config = get_div_config(req->rate, get_prate_by_index(hw, i)); + if (config) { + if (i < RTC_CLK_MUX_SIZE) + /* Runtime clk source divisors */ + priv->runtime_div = config; + else + /* Suspend clk source divisors */ + priv->suspend_div = config; + + return 0; + } + } + + dev_err(dev, "Failed to determine RTC clock rate\n"); + return -EINVAL; +} + +static u8 rtc_clk_get_parent(struct clk_hw *hw) +{ + struct rtc_priv *priv = to_rtcpriv(hw); + + return (ioread32(priv->rtc_base + RTCC_OFFSET) & + RTCC_CLKSEL_MASK) >> RTCC_CLKSEL_OFFSET; +} + +static int rtc_clk_src_switch(struct clk_hw *hw, u8 src) +{ + struct rtc_priv *priv = to_rtcpriv(hw); + struct device *dev = priv->rdev->dev.parent; + u32 rtcc = 0; + + switch (src % RTC_CLK_MUX_SIZE) { + case RTC_CLK_SRC0: + rtcc |= RTCC_CLKSEL(RTC_CLK_SRC0); + break; + case RTC_CLK_SRC1: + if (is_src1_reserved(priv)) + return -EOPNOTSUPP; + rtcc |= RTCC_CLKSEL(RTC_CLK_SRC1); + break; + case RTC_CLK_SRC2: + rtcc |= RTCC_CLKSEL(RTC_CLK_SRC2); + break; + case RTC_CLK_SRC3: + rtcc |= RTCC_CLKSEL(RTC_CLK_SRC3); + break; + default: + dev_err(dev, "Invalid clock mux parent: %d\n", src); + return -EINVAL; + } + + priv->rtc_hz = get_prate_by_index(hw, src); + if (!priv->rtc_hz) { + dev_err(dev, "Failed to get RTC frequency\n"); + return -EINVAL; + } + + if (src < RTC_CLK_MUX_SIZE) + adjust_dividers(priv, priv->runtime_div, &rtcc); + else + adjust_dividers(priv, priv->suspend_div, &rtcc); + + rtcc |= RTCC_RTCIE | RTCC_ROVREN; + /* + * Make sure the CNTEN is 0 before we configure + * the clock source and dividers. + */ + s32g_rtc_disable(priv); + iowrite32(rtcc, priv->rtc_base + RTCC_OFFSET); + s32g_rtc_enable(priv); + + return 0; +} + +static int rtc_clk_set_parent(struct clk_hw *hw, u8 index) +{ + struct rtc_priv *priv = to_rtcpriv(hw); + + /* + * 0-3 IDs are Runtime clk sources + * 4-7 IDs are Suspend clk sources + */ + if (index < RTC_CLK_MUX_SIZE) { + /* Runtime clk source */ + priv->runtime_src_idx = index; + return 0; + } else if (index < RTC_CLK_MUX_SIZE * 2) { + /* Suspend clk source */ + priv->suspend_src_idx = index; + return 0; + } + + return -EINVAL; +} + +static const struct rtc_class_ops rtc_ops = { + .read_time = s32g_rtc_read_time, + .set_time = s32g_rtc_set_time, + .read_alarm = s32g_rtc_read_alarm, + .set_alarm = s32g_rtc_set_alarm, + .alarm_irq_enable = s32g_rtc_alarm_irq_enable, +}; + +static const struct clk_ops rtc_clk_ops = { + .determine_rate = rtc_clk_determine_rate, + .get_parent = rtc_clk_get_parent, + .set_parent = rtc_clk_set_parent, +}; + +static int priv_dts_init(struct rtc_priv *priv, struct device *dev) +{ + struct platform_device *pdev = to_platform_device(dev); + + priv->ipg = devm_clk_get(dev, "ipg"); + if (IS_ERR(priv->ipg)) { + dev_err(dev, "Failed to get 'ipg' clock\n"); + return PTR_ERR(priv->ipg); + } + + priv->dt_irq_id = platform_get_irq(pdev, 0); + if (priv->dt_irq_id < 0) { + dev_err(dev, "Error reading interrupt # from dts\n"); + return priv->dt_irq_id; + } + + return 0; +} + +static int rtc_probe(struct platform_device *pdev) +{ + struct device *dev = &pdev->dev; + struct rtc_priv *priv; + static const char *parents[RTC_CLK_MUX_SIZE * 2] = { + "rtc_runtime_s0", + "rtc_runtime_s1", + "rtc_runtime_s2", + "rtc_runtime_s3", + "rtc_standby_s0", + "rtc_standby_s1", + "rtc_standby_s2", + "rtc_standby_s3" + }; + struct clk_init_data clk_init = { + .name = "rtc_clk", + .ops = &rtc_clk_ops, + .flags = 0, + .parent_names = parents, + .num_parents = ARRAY_SIZE(parents), + }; + int ret = 0; + + priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); + if (!priv) + return -ENOMEM; + + priv->rtc_data = of_device_get_match_data(dev); + if (!priv->rtc_data) + return -ENODEV; + + priv->rtc_base = devm_platform_ioremap_resource(pdev, 0); + if (IS_ERR(priv->rtc_base)) + return dev_err_probe(dev, PTR_ERR(priv->rtc_base), + "Failed to map registers\n"); + + device_init_wakeup(dev, true); + + ret = priv_dts_init(priv, dev); + if (ret) + return ret; + + ret = clk_prepare_enable(priv->ipg); + if (ret) { + dev_err(dev, "Cannot enable 'ipg' clock, error: %d\n", ret); + return ret; + } + + priv->rdev = devm_rtc_allocate_device(dev); + if (IS_ERR(priv->rdev)) { + dev_err(dev, "Failed to allocate RTC device\n"); + ret = PTR_ERR(priv->rdev); + goto disable_rtc; + } + + if (!of_property_present(dev->of_node, + "assigned-clock-parents")) { + /* + * If parent clocks are not specified via DT + * use SoC specific defaults for clock source mux + * and divisors. + */ + priv->runtime_src_idx = priv->rtc_data->default_runtime_src_idx; + priv->suspend_src_idx = priv->rtc_data->default_suspend_src_idx; + priv->runtime_div = priv->rtc_data->default_runtime_div; + priv->suspend_div = priv->rtc_data->default_suspend_div; + } else { + priv->runtime_src_idx = -EINVAL; + priv->suspend_src_idx = -EINVAL; + } + + priv->clk.init = &clk_init; + ret = devm_clk_hw_register(dev, &priv->clk); + if (ret) { + dev_err(dev, "Failed to register rtc_clk clk\n"); + goto disable_ipg_clk; + } + + ret = of_clk_add_hw_provider(dev->of_node, + of_clk_hw_simple_get, priv->clk.clk); + if (ret) { + dev_err(dev, "Failed to add rtc_clk clk provider\n"); + goto disable_ipg_clk; + } + + if (priv->runtime_src_idx < 0) { + ret = priv->runtime_src_idx; + dev_err(dev, "RTC runtime clock source is not specified\n"); + goto disable_ipg_clk; + } + + ret = rtc_clk_src_switch(&priv->clk, priv->runtime_src_idx); + if (ret) { + dev_err(dev, "Failed clk source switch, err: %d\n", ret); + goto disable_ipg_clk; + } + + platform_set_drvdata(pdev, priv); + priv->rdev->ops = &rtc_ops; + + ret = devm_rtc_register_device(priv->rdev); + if (ret) { + dev_err(dev, "Failed to register RTC device\n"); + goto disable_rtc; + } + + ret = devm_request_irq(dev, priv->dt_irq_id, + rtc_handler, 0, dev_name(dev), pdev); + if (ret) { + dev_err(dev, "Request interrupt %d failed, error: %d\n", + priv->dt_irq_id, ret); + goto disable_rtc; + } + + return 0; + +disable_ipg_clk: + clk_disable_unprepare(priv->ipg); +disable_rtc: + s32g_rtc_disable(priv); + return ret; +} + +static void rtc_remove(struct platform_device *pdev) +{ + struct rtc_priv *priv = platform_get_drvdata(pdev); + + s32g_rtc_disable(priv); +} + +static void __maybe_unused enable_api_irq(struct device *dev, unsigned int enabled) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + u32 api_irq = RTCC_APIEN | RTCC_APIIE; + u32 rtcc; + + rtcc = ioread32(priv->rtc_base + RTCC_OFFSET); + if (enabled) + rtcc |= api_irq; + else + rtcc &= ~api_irq; + iowrite32(rtcc, priv->rtc_base + RTCC_OFFSET); +} + +static int __maybe_unused rtc_suspend(struct device *dev) +{ + struct rtc_priv *init_priv = dev_get_drvdata(dev); + struct rtc_priv priv; + long long base_sec; + int ret = 0; + u32 rtcval; + u32 sec; + + if (!device_may_wakeup(dev)) + return 0; + + if (init_priv->suspend_src_idx < 0) + return 0; + + if (rtc_clk_get_parent(&init_priv->clk) == init_priv->suspend_src_idx) + return 0; + + /* Save last known timestamp before we switch clocks and reinit RTC */ + ret = s32g_rtc_read_time(dev, &init_priv->base.tm); + if (ret) + return ret; + + /* + * Use a local copy of the RTC control block to + * avoid restoring it on resume path. + */ + memcpy(&priv, init_priv, sizeof(priv)); + + ret = get_time_left(dev, init_priv, &sec); + if (ret) + return ret; + + /* Adjust for the number of seconds we'll be asleep */ + base_sec = rtc_tm_to_time64(&init_priv->base.tm); + base_sec += sec; + rtc_time64_to_tm(base_sec, &init_priv->base.tm); + + ret = rtc_clk_src_switch(&priv.clk, priv.suspend_src_idx); + if (ret) { + dev_err(dev, "Failed clk source switch, err: %d\n", ret); + return ret; + } + + ret = sec_to_rtcval(&priv, sec, &rtcval); + if (ret) { + dev_warn(dev, "Alarm is too far in the future\n"); + return ret; + } + + s32g_rtc_alarm_irq_enable(dev, 0); + enable_api_irq(dev, 1); + iowrite32(rtcval, priv.rtc_base + APIVAL_OFFSET); + iowrite32(0, priv.rtc_base + RTCVAL_OFFSET); + + return ret; +} + +static int __maybe_unused rtc_resume(struct device *dev) +{ + struct rtc_priv *priv = dev_get_drvdata(dev); + int ret; + + if (!device_may_wakeup(dev)) + return 0; + + if (rtc_clk_get_parent(&priv->clk) == priv->runtime_src_idx) + return 0; + + /* Disable wake-up interrupts */ + enable_api_irq(dev, 0); + + ret = rtc_clk_src_switch(&priv->clk, priv->runtime_src_idx); + if (ret) { + dev_err(dev, "Failed clk source switch, err: %d\n", ret); + return ret; + } + + /* + * Now RTCCNT has just been reset, and is out of sync with priv->base; + * reapply the saved time settings + */ + return s32g_rtc_set_time(dev, &priv->base.tm); +} + +static const struct of_device_id rtc_dt_ids[] = { + { .compatible = "nxp,s32g2-rtc", .data = &rtc_s32g2_data}, + { /* sentinel */ }, +}; + +static SIMPLE_DEV_PM_OPS(rtc_pm_ops, + rtc_suspend, rtc_resume); + +static struct platform_driver rtc_driver = { + .driver = { + .name = "s32g-rtc", + .pm = &rtc_pm_ops, + .of_match_table = rtc_dt_ids, + }, + .probe = rtc_probe, + .remove = rtc_remove, +}; +module_platform_driver(rtc_driver); + +MODULE_AUTHOR("NXP"); +MODULE_DESCRIPTION("NXP RTC driver for S32G2/S32G3"); +MODULE_LICENSE("GPL");