From nobody Wed Dec 31 05:21:39 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2705BC4332F for ; Tue, 7 Nov 2023 09:47:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233846AbjKGJrM (ORCPT ); Tue, 7 Nov 2023 04:47:12 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36446 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229776AbjKGJrK (ORCPT ); Tue, 7 Nov 2023 04:47:10 -0500 Received: from mail-wm1-x332.google.com (mail-wm1-x332.google.com [IPv6:2a00:1450:4864:20::332]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 20EBFDF for ; Tue, 7 Nov 2023 01:47:05 -0800 (PST) Received: by mail-wm1-x332.google.com with SMTP id 5b1f17b1804b1-4081ccf69dcso38123185e9.0 for ; Tue, 07 Nov 2023 01:47:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20230601.gappssmtp.com; s=20230601; t=1699350423; x=1699955223; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=7cVDRIKB7UpPyg/gCWoDLMvND7PtkjZQwLFTRyhjc3I=; b=oIdu5gl9LqFT+pcW8IYi7MwgP7cKdyOnS7hzoUC4V5/yC+adpW/HgAlhGf+dcBzmSK FMTxUa8tevX410a5TGS6Z4oqSP9RxrVO2mcwqDOBdMVTOlg3T1Yjnxeqez48VXlr26KW qTgzN6WghnokxtdzOVnmSd6nXy+lNMABMQjDXI1aQ3t5krxo0U0nMN0Y7Hxf8TNCNn8b FBlR+SRD+EfV6E9thIUtIk8+gFJ0IFanyJOhF/Rpt4gGkEELOCY+o9j9vKNRzMZi53gj 4V8GBwh8GY8goA3y8HSSh4R17qYc1FQs3IHr/tedumbxuIDgqwSBjKqdiNsr/Sn4BzHf /isg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699350423; x=1699955223; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=7cVDRIKB7UpPyg/gCWoDLMvND7PtkjZQwLFTRyhjc3I=; b=STa8kyIyuGdYLwPvP3JlJVLG9I0Co3eDVXQJLmlPFP8HSZNIdaaR9bi8XG88XejfpD AO0TUwuZOBMzPMMKJIKP+uMqDF/JsGzt4XlPGsAEfjJw27c+M3WRKKOuNxLFL+1QoVvX tsrdV1H39yMXU/pb/7qlHjswYiuppJSwbmMdLDNFZ9oIqofn1buVhK5BmLChalwWeKiz UifUnC0UqTUI/Sggcx/cjfaUFCQPoUzgRkaIrVji+rfxRCPBAQGsxWAzbCDFRptCVQsN vbgBy6umNQjjlMjGq4hmFKypu5+dK6t2W9Xn09759Mm8jKyH/3ReRF6lTDcHknOvFbso HRXQ== X-Gm-Message-State: AOJu0YxTGtYJv8viiKk+75aiAmSWL16fub+j6Rpa94dxDPnzS9nhdrAM 3/axl3aDl/6XxBoPg3cCRKdG+Q== X-Google-Smtp-Source: AGHT+IEGIL9CF6yd8NXUEMaUB5WnLZx9wOBEs/IlxxKNdHXu9DnXKHMBZwrKlY8Mrku8QDsUjuytwA== X-Received: by 2002:a05:600c:3306:b0:405:3f06:d2ef with SMTP id q6-20020a05600c330600b004053f06d2efmr2342616wmp.4.1699350423338; Tue, 07 Nov 2023 01:47:03 -0800 (PST) Received: from localhost.localdomain (abordeaux-655-1-152-60.w90-5.abo.wanadoo.fr. [90.5.9.60]) by smtp.gmail.com with ESMTPSA id bg19-20020a05600c3c9300b0040531f5c51asm15419909wmb.5.2023.11.07.01.47.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Nov 2023 01:47:02 -0800 (PST) From: Esteban Blanc To: a.zummo@towertech.it, alexandre.belloni@bootlin.com Cc: andy.shevchenko@gmail.com, linux-kernel@vger.kernel.org, linux-rtc@vger.kernel.org, jpanis@baylibre.com, jneanne@baylibre.com, eblanc@baylibre.com, u-kumar1@ti.com Subject: [PATCH v9] rtc: tps6594: Add driver for TPS6594 RTC Date: Tue, 7 Nov 2023 10:47:01 +0100 Message-Id: <20231107094701.2223486-1-eblanc@baylibre.com> X-Mailer: git-send-email 2.40.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" TPS6594 PMIC is a MFD. This patch adds support for the RTC found inside TPS6594 family of PMIC. Alarm is also supported. Signed-off-by: Esteban Blanc Reviewed-by: Andy Shevchenko Acked-by: Alexandre Belloni Tested-by: Thomas Richard --- Notes: This patch was picked in V7 from a series since there is no dependency = between the two patches. =20 Changes since v8: https://lore.kernel.org/lkml/20231102132616.1130960-1-eblanc@baylibre.c= om/ - Drop MODULE_ALIAS in favor of ID table as requested by Krzysztof Kozl= owski. The Reviewed-by and Acked-by tags were kept as this new version does no= t change the driver inner working. =20 Changes since v7: https://lore.kernel.org/lkml/20230628133021.500477-1-eblanc@baylibre.co= m/ - Remove useless variable and comment - Fix a typo =20 Here is the old cover-letter: TPS6594 is a Power Management IC which provides regulators and others features like GPIOs, RTC, watchdog, ESMs (Error Signal Monitor), and PFSM (Pre-configurable Finite State Machine). The SoC and the PMIC can communicate through the I2C or SPI interfaces. TPS6594 is the super-set device while TPS6593 and LP8764 are derivative= s. =20 This series adds support to TI TPS6594 PMIC and its derivatives. =20 This should be applied on top of other patch series: - https://lore.kernel.org/all/20230511095126.105104-1-jpanis@baylibre.c= om/ For core MFD driver. The necessary part of this patch series is alrea= dy applied in linux-next. =20 The features implemented in this series are: - RTC (child device) - Pinmux/GPIO (child device) - Regulator (child device) =20 RTC description: The TPS6594 family has an RTC built-in, except for LP8764. It provides time and an alarm. =20 Pinmux/GPIO: TPS6594 family has 11 GPIOs. Those GPIO can also serve different functions such as I2C or SPI interface, watchdog disable functions. The driver provides both pinmuxing for the functions and GPIO capabilit= y. =20 Regulator: TPS6594/TPS6593: 5 BUCKs and 4LDOs LP8764: 4 BUCKs and no LDO Bucks can be used in multipahse mode. =20 Regulators were applied to linux-next by Mark Brown on 06/06/2023 so th= is patch has been dropped from the patch series. There were some pending comments from Andy Shevchenko so a follow up pa= tch will be sent later. =20 Changes since v1: https://lore.kernel.org/all/20230224133129.887203-1-eblanc@baylibre.com/ Rtc: - Removed struct tps6594_rtc. - Removed some dev_err messages. - Removed some comments. - Remove some whitespaces in comments and error messages. - Check if RTC is running before reading a timestamp in read_rtc. - Stop RTC at the end of probe to wait for a timestamp to be set. - Add default MFD_TPS6594 to Kconfig. =20 Pinctrl: - Removed #define DEBUG. - Add default MFD_TPS6594 to Kconfig. - Fix typo and reword help message of Kconfig. =20 Regulators: Further to Mark Brown review: - File header whole block C++ style. - Configuring modes not supported: omit all mode operations - Log the error before notifying. - Request the interrupts while registering the regulators (then remove the lookup function). Further to Matti review: - Postponed: devm_regulator_irq_helper() and regulator_irq_map_event_simple() can probably be used but code. refactoring is not so trivial. This can be done later as an enhanceme= nt after this patch list is merged. Buck Multi phase management: - Multiphase property can take an array when 2 multi phase buck, buck12 and buck34. - Configuration multi phase buck34 without multiphase buck12 is not supported (when only one multiphase, must be buck12). Not clear from = the spec but confirmed by TI. - Supported multiphase conficurations: buck12, buck123, buck1234, buck12 + buck34. - All interrupts are attached to the multiphase buck (ie: for regulator buck12, buck1 & buck2 interrupts are registered). =20 Changes since v2: https://lore.kernel.org/all/20230328091448.648452-1-eblanc@baylibre.com/ Rtc: - Add logic to avoid reinitializing a working clock. - Fix some multiline comments format. =20 Regulators: Further to Mark Brown review: - Log the error before notifying. - Request the interrupts while registering the regulators. Further to Krzysztof Kozlowski: https://lore.kernel.org/all/75f0a18d-aed9-8610-2925-4e604b4b0241@baylib= re.com/ - Remove ti, multi-phase-id property which is redundant with buck dts n= aming rules. =20 Changes since v3: https://lore.kernel.org/lkml/20230414101217.1342891-1-eblanc@baylibre.c= om/ RTC: - Add wakeup source =20 Pinctrl: - Switch to GPIO_REGMAP framework =20 Change since v4: https://lore.kernel.org/lkml/20230512141755.1712358-1-eblanc@baylibre.c= om/ Update Copyright notice date Reorder includes =20 RTC: - Rework some comments, fixing punctuation and style - Use NANO macro from units.h for PPB_MULT - Rework to use bitwise types - Remove unnecessary casts - Add SAFETY comments - Use `dev_err_probe(...)` instead of print then return =20 Pinctrl: - Reword help message and add module name in Kconfig - Rework code to use struct pinfunction and PINCTRL_PINFUNCTION() macro - Remove unnecessary casts - Use `dev_err_probe(...)` instead of print then return - Replace TPS6594_REG_GPIO1_CONF with a comment for TPS6594_REG_GPIOX_C= ONF =20 Regulators: - nits: Add missing tabs, standard spaces, group "buck_multi". - Use OF dedicated of_node_cmp API instead of standard strcmp. - Use devm_kmalloc_array(...) API instead of devm_kmalloc(...) wherever possible. - return dev_err_probe(...) wherever possible. =20 Changes since v5: https://lore.kernel.org/lkml/20230522163115.2592883-1-eblanc@baylibre.c= om/ =20 Pinctrl: - Rework code for clarity - Rework macro to fix checkpatch macro argument reuse - Coding style fixes - Reword some comments =20 Rtc: - Grammar fixes - Removed unused macros - Use type MIN/MAX macro instead of magic numbers - Fix return code in calibration - Use cpu_to_le16 and le16_to_cpu APIs instead of casting. - Reintroduce mdelay before reading BIT_RUN as otherwise both AM62 and = J784S4 will report a -ENODEV on a working RTC. =20 Changes since v6: https://lore.kernel.org/all/20230612125248.1235581-1-eblanc@baylibre.co= m/ =20 Pinctrl: - Remove a comment drivers/rtc/Kconfig | 12 + drivers/rtc/Makefile | 1 + drivers/rtc/rtc-tps6594.c | 454 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 467 insertions(+) create mode 100644 drivers/rtc/rtc-tps6594.c diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig index d7502433c78a..65a97e2b58f8 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -578,6 +578,18 @@ config RTC_DRV_TPS6586X along with alarm. This driver supports the RTC driver for the TPS6586X RTC module. =20 +config RTC_DRV_TPS6594 + tristate "TI TPS6594 RTC driver" + depends on MFD_TPS6594 + default MFD_TPS6594 + help + TI Power Management IC TPS6594 supports RTC functionality + along with alarm. This driver supports the RTC driver for + the TPS6594 RTC module. + + This driver can also be built as a module. If so, the module + will be called rtc-tps6594. + config RTC_DRV_TPS65910 tristate "TI TPS65910 RTC driver" depends on MFD_TPS65910 diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile index fd209883ee2e..5ed28639300c 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -175,6 +175,7 @@ obj-$(CONFIG_RTC_DRV_TEGRA) +=3D rtc-tegra.o obj-$(CONFIG_RTC_DRV_TEST) +=3D rtc-test.o obj-$(CONFIG_RTC_DRV_TI_K3) +=3D rtc-ti-k3.o obj-$(CONFIG_RTC_DRV_TPS6586X) +=3D rtc-tps6586x.o +obj-$(CONFIG_RTC_DRV_TPS6594) +=3D rtc-tps6594.o obj-$(CONFIG_RTC_DRV_TPS65910) +=3D rtc-tps65910.o obj-$(CONFIG_RTC_DRV_TWL4030) +=3D rtc-twl.o obj-$(CONFIG_RTC_DRV_VT8500) +=3D rtc-vt8500.o diff --git a/drivers/rtc/rtc-tps6594.c b/drivers/rtc/rtc-tps6594.c new file mode 100644 index 000000000000..838ae8562a35 --- /dev/null +++ b/drivers/rtc/rtc-tps6594.c @@ -0,0 +1,454 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * RTC driver for tps6594 PMIC + * + * Copyright (C) 2023 BayLibre Incorporated - https://www.baylibre.com/ + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +// Total number of RTC registers needed to set time +#define NUM_TIME_REGS (TPS6594_REG_RTC_WEEKS - TPS6594_REG_RTC_SECONDS + 1) + +// Total number of RTC alarm registers +#define NUM_TIME_ALARM_REGS (NUM_TIME_REGS - 1) + +/* + * Min and max values supported by 'offset' interface (swapped sign). + * After conversion, the values do not exceed the range [-32767, 33767] + * which COMP_REG must conform to. + */ +#define MIN_OFFSET (-277774) +#define MAX_OFFSET (277774) + +// Number of ticks per hour +#define TICKS_PER_HOUR (32768 * 3600) + +// Multiplier for ppb conversions +#define PPB_MULT NANO + +static int tps6594_rtc_alarm_irq_enable(struct device *dev, + unsigned int enabled) +{ + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + u8 val; + + val =3D enabled ? TPS6594_BIT_IT_ALARM : 0; + + return regmap_update_bits(tps->regmap, TPS6594_REG_RTC_INTERRUPTS, + TPS6594_BIT_IT_ALARM, val); +} + +/* Pulse GET_TIME field of RTC_CTRL_1 to store a timestamp in shadow regis= ters. */ +static int tps6594_rtc_shadow_timestamp(struct device *dev, struct tps6594= *tps) +{ + int ret; + + /* + * Set GET_TIME to 0. Next time we set GET_TIME to 1 we will be sure to s= tore + * an up-to-date timestamp. + */ + ret =3D regmap_clear_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_GET_TIME); + if (ret < 0) + return ret; + + /* + * Copy content of RTC registers to shadow registers or latches to read + * a coherent timestamp. + */ + return regmap_set_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_GET_TIME); +} + +static int tps6594_rtc_read_time(struct device *dev, struct rtc_time *tm) +{ + unsigned char rtc_data[NUM_TIME_REGS]; + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + int ret; + + // Check if RTC is running. + ret =3D regmap_test_bits(tps->regmap, TPS6594_REG_RTC_STATUS, + TPS6594_BIT_RUN); + if (ret < 0) + return ret; + if (ret =3D=3D 0) + return -EINVAL; + + ret =3D tps6594_rtc_shadow_timestamp(dev, tps); + if (ret < 0) + return ret; + + // Read shadowed RTC registers. + ret =3D regmap_bulk_read(tps->regmap, TPS6594_REG_RTC_SECONDS, rtc_data, + NUM_TIME_REGS); + if (ret < 0) + return ret; + + tm->tm_sec =3D bcd2bin(rtc_data[0]); + tm->tm_min =3D bcd2bin(rtc_data[1]); + tm->tm_hour =3D bcd2bin(rtc_data[2]); + tm->tm_mday =3D bcd2bin(rtc_data[3]); + tm->tm_mon =3D bcd2bin(rtc_data[4]) - 1; + tm->tm_year =3D bcd2bin(rtc_data[5]) + 100; + tm->tm_wday =3D bcd2bin(rtc_data[6]); + + return 0; +} + +static int tps6594_rtc_set_time(struct device *dev, struct rtc_time *tm) +{ + unsigned char rtc_data[NUM_TIME_REGS]; + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + int ret; + + rtc_data[0] =3D bin2bcd(tm->tm_sec); + rtc_data[1] =3D bin2bcd(tm->tm_min); + rtc_data[2] =3D bin2bcd(tm->tm_hour); + rtc_data[3] =3D bin2bcd(tm->tm_mday); + rtc_data[4] =3D bin2bcd(tm->tm_mon + 1); + rtc_data[5] =3D bin2bcd(tm->tm_year - 100); + rtc_data[6] =3D bin2bcd(tm->tm_wday); + + // Stop RTC while updating the RTC time registers. + ret =3D regmap_clear_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_STOP_RTC); + if (ret < 0) + return ret; + + // Update all the time registers in one shot. + ret =3D regmap_bulk_write(tps->regmap, TPS6594_REG_RTC_SECONDS, rtc_data, + NUM_TIME_REGS); + if (ret < 0) + return ret; + + // Start back RTC. + return regmap_set_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_STOP_RTC); +} + +static int tps6594_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *a= lm) +{ + unsigned char alarm_data[NUM_TIME_ALARM_REGS]; + u32 int_val; + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + int ret; + + ret =3D regmap_bulk_read(tps->regmap, TPS6594_REG_ALARM_SECONDS, + alarm_data, NUM_TIME_ALARM_REGS); + if (ret < 0) + return ret; + + alm->time.tm_sec =3D bcd2bin(alarm_data[0]); + alm->time.tm_min =3D bcd2bin(alarm_data[1]); + alm->time.tm_hour =3D bcd2bin(alarm_data[2]); + alm->time.tm_mday =3D bcd2bin(alarm_data[3]); + alm->time.tm_mon =3D bcd2bin(alarm_data[4]) - 1; + alm->time.tm_year =3D bcd2bin(alarm_data[5]) + 100; + + ret =3D regmap_read(tps->regmap, TPS6594_REG_RTC_INTERRUPTS, &int_val); + if (ret < 0) + return ret; + + alm->enabled =3D int_val & TPS6594_BIT_IT_ALARM; + + return 0; +} + +static int tps6594_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *al= m) +{ + unsigned char alarm_data[NUM_TIME_ALARM_REGS]; + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + int ret; + + // Disable alarm irq before changing the alarm timestamp. + ret =3D tps6594_rtc_alarm_irq_enable(dev, 0); + if (ret) + return ret; + + alarm_data[0] =3D bin2bcd(alm->time.tm_sec); + alarm_data[1] =3D bin2bcd(alm->time.tm_min); + alarm_data[2] =3D bin2bcd(alm->time.tm_hour); + alarm_data[3] =3D bin2bcd(alm->time.tm_mday); + alarm_data[4] =3D bin2bcd(alm->time.tm_mon + 1); + alarm_data[5] =3D bin2bcd(alm->time.tm_year - 100); + + // Update all the alarm registers in one shot. + ret =3D regmap_bulk_write(tps->regmap, TPS6594_REG_ALARM_SECONDS, + alarm_data, NUM_TIME_ALARM_REGS); + if (ret < 0) + return ret; + + if (alm->enabled) + ret =3D tps6594_rtc_alarm_irq_enable(dev, 1); + + return ret; +} + +static int tps6594_rtc_set_calibration(struct device *dev, int calibration) +{ + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + __le16 value; + int ret; + + /* + * TPS6594 uses two's complement 16 bit value for compensation of RTC + * crystal inaccuracies. One time every hour when seconds counter + * increments from 0 to 1 compensation value will be added to internal + * RTC counter value. + * + * Valid range for compensation value: [-32767 .. 32767]. + */ + if (calibration < S16_MIN + 1 || calibration > S16_MAX) + return -ERANGE; + + value =3D cpu_to_le16(calibration); + + // Update all the compensation registers in one shot. + ret =3D regmap_bulk_write(tps->regmap, TPS6594_REG_RTC_COMP_LSB, &value, + sizeof(value)); + if (ret < 0) + return ret; + + // Enable automatic compensation. + return regmap_set_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_AUTO_COMP); +} + +static int tps6594_rtc_get_calibration(struct device *dev, int *calibratio= n) +{ + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + unsigned int ctrl; + __le16 value; + int ret; + + ret =3D regmap_read(tps->regmap, TPS6594_REG_RTC_CTRL_1, &ctrl); + if (ret < 0) + return ret; + + // If automatic compensation is not enabled report back zero. + if (!(ctrl & TPS6594_BIT_AUTO_COMP)) { + *calibration =3D 0; + return 0; + } + + ret =3D regmap_bulk_read(tps->regmap, TPS6594_REG_RTC_COMP_LSB, &value, + sizeof(value)); + if (ret < 0) + return ret; + + *calibration =3D le16_to_cpu(value); + + return 0; +} + +static int tps6594_rtc_read_offset(struct device *dev, long *offset) +{ + int calibration; + s64 tmp; + int ret; + + ret =3D tps6594_rtc_get_calibration(dev, &calibration); + if (ret < 0) + return ret; + + // Convert from RTC calibration register format to ppb format. + tmp =3D calibration * PPB_MULT; + + if (tmp < 0) + tmp -=3D TICKS_PER_HOUR / 2LL; + else + tmp +=3D TICKS_PER_HOUR / 2LL; + tmp =3D div_s64(tmp, TICKS_PER_HOUR); + + /* + * SAFETY: + * Computatiion is the reverse operation of the one done in + * `tps6594_rtc_set_offset`. The safety remarks applie here too. + */ + + /* + * Offset value operates in negative way, so swap sign. + * See 8.3.10.5, (32768 - COMP_REG). + */ + *offset =3D (long)-tmp; + + return 0; +} + +static int tps6594_rtc_set_offset(struct device *dev, long offset) +{ + int calibration; + s64 tmp; + + // Make sure offset value is within supported range. + if (offset < MIN_OFFSET || offset > MAX_OFFSET) + return -ERANGE; + + // Convert from ppb format to RTC calibration register format. + + tmp =3D offset * TICKS_PER_HOUR; + if (tmp < 0) + tmp -=3D PPB_MULT / 2LL; + else + tmp +=3D PPB_MULT / 2LL; + tmp =3D div_s64(tmp, PPB_MULT); + + /* + * SAFETY: + * - tmp =3D offset * TICK_PER_HOUR : + * `offset` can't be more than 277774, so `tmp` can't exceed 277774000000= 000 + * which is lower than the maximum value in an `s64` (2^63-1). No overflo= w here. + * + * - tmp +=3D TICK_PER_HOUR / 2LL : + * tmp will have a maximum value of 277774117964800 which is still inferi= or to 2^63-1. + */ + + // Offset value operates in negative way, so swap sign. + calibration =3D (int)-tmp; + + return tps6594_rtc_set_calibration(dev, calibration); +} + +static irqreturn_t tps6594_rtc_interrupt(int irq, void *rtc) +{ + struct device *dev =3D rtc; + struct tps6594 *tps =3D dev_get_drvdata(dev->parent); + struct rtc_device *rtc_dev =3D dev_get_drvdata(dev); + int ret; + u32 rtc_reg; + + ret =3D regmap_read(tps->regmap, TPS6594_REG_RTC_STATUS, &rtc_reg); + if (ret) + return IRQ_NONE; + + rtc_update_irq(rtc_dev, 1, RTC_IRQF | RTC_AF); + + return IRQ_HANDLED; +} + +static const struct rtc_class_ops tps6594_rtc_ops =3D { + .read_time =3D tps6594_rtc_read_time, + .set_time =3D tps6594_rtc_set_time, + .read_alarm =3D tps6594_rtc_read_alarm, + .set_alarm =3D tps6594_rtc_set_alarm, + .alarm_irq_enable =3D tps6594_rtc_alarm_irq_enable, + .read_offset =3D tps6594_rtc_read_offset, + .set_offset =3D tps6594_rtc_set_offset, +}; + +static int tps6594_rtc_probe(struct platform_device *pdev) +{ + struct tps6594 *tps =3D dev_get_drvdata(pdev->dev.parent); + struct device *dev =3D &pdev->dev; + struct rtc_device *rtc; + int irq; + int ret; + + rtc =3D devm_kzalloc(dev, sizeof(*rtc), GFP_KERNEL); + if (!rtc) + return -ENOMEM; + + rtc =3D devm_rtc_allocate_device(dev); + if (IS_ERR(rtc)) + return PTR_ERR(rtc); + + // Enable crystal oscillator. + ret =3D regmap_set_bits(tps->regmap, TPS6594_REG_RTC_CTRL_2, + TPS6594_BIT_XTAL_EN); + if (ret < 0) + return ret; + + ret =3D regmap_test_bits(tps->regmap, TPS6594_REG_RTC_STATUS, + TPS6594_BIT_RUN); + if (ret < 0) + return ret; + // RTC not running. + if (ret =3D=3D 0) { + ret =3D regmap_set_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_STOP_RTC); + if (ret < 0) + return ret; + + /* + * On some boards, a 40 ms delay is needed before BIT_RUN is set. + * 80 ms should provide sufficient margin. + */ + mdelay(80); + + /* + * RTC should be running now. Check if this is the case. + * If not it might be a missing oscillator. + */ + ret =3D regmap_test_bits(tps->regmap, TPS6594_REG_RTC_STATUS, + TPS6594_BIT_RUN); + if (ret < 0) + return ret; + if (ret =3D=3D 0) + return -ENODEV; + + // Stop RTC until first call to `tps6594_rtc_set_time`. + ret =3D regmap_clear_bits(tps->regmap, TPS6594_REG_RTC_CTRL_1, + TPS6594_BIT_STOP_RTC); + if (ret < 0) + return ret; + } + + platform_set_drvdata(pdev, rtc); + + irq =3D platform_get_irq_byname(pdev, TPS6594_IRQ_NAME_ALARM); + if (irq < 0) + return dev_err_probe(dev, irq, "Failed to get irq\n"); + + ret =3D devm_request_threaded_irq(dev, irq, NULL, tps6594_rtc_interrupt, + IRQF_ONESHOT, TPS6594_IRQ_NAME_ALARM, + dev); + if (ret < 0) + return dev_err_probe(dev, ret, + "Failed to request_threaded_irq\n"); + + ret =3D device_init_wakeup(dev, true); + if (ret < 0) + return dev_err_probe(dev, ret, + "Failed to init rtc as wakeup source\n"); + + rtc->ops =3D &tps6594_rtc_ops; + rtc->range_min =3D RTC_TIMESTAMP_BEGIN_2000; + rtc->range_max =3D RTC_TIMESTAMP_END_2099; + + return devm_rtc_register_device(rtc); +} + +static const struct platform_device_id tps6594_rtc_id_table[] =3D { + { "tps6594-rtc", }, + {} +}; +MODULE_DEVICE_TABLE(platform, tps6594_rtc_id_table); + +static struct platform_driver tps6594_rtc_driver =3D { + .probe =3D tps6594_rtc_probe, + .driver =3D { + .name =3D "tps6594-rtc", + }, + .id_table =3D tps6594_rtc_id_table, +}; + +module_platform_driver(tps6594_rtc_driver); +MODULE_AUTHOR("Esteban Blanc "); +MODULE_DESCRIPTION("TPS6594 RTC driver"); +MODULE_LICENSE("GPL"); --=20 2.40.1