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 phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4E7AAC04A95 for ; Tue, 25 Oct 2022 14:24:00 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 73C3484D43; Tue, 25 Oct 2022 16:23:57 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="EqwUhFPR"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 94C3184D44; Tue, 25 Oct 2022 16:23:54 +0200 (CEST) Received: from mail-lj1-x22c.google.com (mail-lj1-x22c.google.com [IPv6:2a00:1450:4864:20::22c]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 00CBC806C7 for ; Tue, 25 Oct 2022 16:23:50 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=saproj@gmail.com Received: by mail-lj1-x22c.google.com with SMTP id bx35so11122702ljb.2 for ; Tue, 25 Oct 2022 07:23:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=tIG+ho0LEKaWvyTf/zp8dSShSFmI/BnjVmMRMYLdNoc=; b=EqwUhFPRnynXg59ASnt7aw/dlP0deacGkRfXIqEbrZGYuF58hxD9JspcquoAVncAkt 3g3aYKxahL2RAhwIMBmP4nEcrpH5YiQlmZvSuhuhCK0uxx12F+PpyReOFps7WV8VoyND cnmX24DVoZpr2JVm/LrxJln9HKaUj0jQFYEg/stbi9wSP5oMGMvUF0kWgvWiOfLgPMIS tNSJ2yixX3ZBcz5sXoUprRZZQrKb16/xmGKh6Xfg7lKG9uA1xE7C7nQaoXbiUoJUM+fC FRPHK75JPchpSzF4wv9+3EeOQrrIKoyk2tHHXLqbxD2UBhFc1uzHVG215XQiKmiqrYW8 kpKg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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=tIG+ho0LEKaWvyTf/zp8dSShSFmI/BnjVmMRMYLdNoc=; b=TztcnyiF6xNOL0/UNhM9gBjkHVulS0Z7mlABbve3ULuNLzqrA3+A+d9PZJDVkzFBCv 1lKB2mGIjm89GBAOeLCa2ZARb/1TsNCg70bPLDXuGgEZRRZ8/MFTgWj39kSM+KVAzaVg iwRcFdO1aAZN5enYQxsZRb6Xv9bQDuZiuEYhIlzOZJ3c3uDnBy2hMqf4s2ATT8X0w/vJ aVgLYZ8RERSvMVapRVRA2p+FthPpXNvhFdfMm5lOSrdU/3mou+xa/k9iwqhQSiCn7BDB dxN+klUsgsC8JKHlU4AR1XqYczt+WlRScXUNJZqS/XT8zGgt7UyF+CT5/wq641z1+vKD l+9A== X-Gm-Message-State: ACrzQf3/ayFnVzEIes4uctO7H91lIRclGAsJdRrfd6m64+6YM7/UBFtd gkB/TWf9JDdGtgQPEMBte1HHAPa7W74= X-Google-Smtp-Source: AMsMyM7FLu/fZ7+iAMvuiZyYgOXwy6W4zLepOfsqzDpdavHS0fQiItUSmViK2Z0OqrtiVcKYmZQAdg== X-Received: by 2002:a2e:9c0c:0:b0:274:7384:fcd with SMTP id s12-20020a2e9c0c000000b0027473840fcdmr11363183lji.352.1666707830129; Tue, 25 Oct 2022 07:23:50 -0700 (PDT) Received: from saproj-Latitude-5501.yandex.net ([2a02:6b8:0:40c:262c:9650:241e:63e8]) by smtp.gmail.com with ESMTPSA id t7-20020a056512208700b004aa95889063sm437588lfr.43.2022.10.25.07.23.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Oct 2022 07:23:49 -0700 (PDT) From: Sergei Antonov To: u-boot@lists.denx.de Cc: Sergei Antonov Subject: [PATCH] rtc: add ht1380 driver Date: Tue, 25 Oct 2022 17:23:26 +0300 Message-Id: <20221025142326.339332-1-saproj@gmail.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean Support Holtek HT1380/HT1381 Serial Timekeeper Chip. Datasheet: https://www.holtek.com.tw/documents/10179/11842/ht1380_1v130.pdf Signed-off-by: Sergei Antonov --- drivers/rtc/Kconfig | 7 + drivers/rtc/Makefile | 1 + drivers/rtc/ht1380.c | 303 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 311 insertions(+) create mode 100644 drivers/rtc/ht1380.c diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig index 23963271928a..f62ee43b0f89 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -220,4 +220,11 @@ config RTC_ZYNQMP Say "yes" here to support the on chip real time clock present on Xilinx ZynqMP SoC. +config RTC_HT1380 + bool "Enable Holtek HT1380/HT1381 RTC driver" + depends on DM_RTC && DM_GPIO + help + Say "yes" here to get support for Holtek HT1380/HT1381 + Serial Timekeeper Chip. + endmenu diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile index d621be622848..d04ac8fb0938 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -24,6 +24,7 @@ obj-$(CONFIG_RTC_DS3231) += ds3231.o obj-$(CONFIG_RTC_DS3232) += ds3232.o obj-$(CONFIG_RTC_EMULATION) += emul_rtc.o obj-$(CONFIG_RTC_FTRTC010) += ftrtc010.o +obj-$(CONFIG_RTC_HT1380) += ht1380.o obj-$(CONFIG_SANDBOX) += i2c_rtc_emul.o obj-$(CONFIG_RTC_IMXDI) += imxdi.o obj-$(CONFIG_RTC_ISL1208) += isl1208.o diff --git a/drivers/rtc/ht1380.c b/drivers/rtc/ht1380.c new file mode 100644 index 000000000000..af28b5f25fcd --- /dev/null +++ b/drivers/rtc/ht1380.c @@ -0,0 +1,303 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Holtek HT1380/HT1381 Serial Timekeeper Chip + */ + +#include +#include +#include +#include +#include +#include + +struct ht1380_priv { + struct gpio_desc rst_desc; + struct gpio_desc clk_desc; + struct gpio_desc dat_desc; +}; + +enum registers { + SEC, + MIN, + HOUR, + MDAY, + MONTH, + WDAY, + YEAR, + WP, + N_REGS +}; + +static const int BURST = 0xBE; +static const int READ = 1; + +static void ht1380_half_period_delay(void) +{ + /* Delay for half a period. 1 us complies with the 500 KHz maximum + input serial clock limit given by the datasheet. */ + udelay(1); +} + +static int ht1380_send_byte(struct ht1380_priv *priv, int byte) +{ + int ret; + + for (int bit = 0; bit < 8; bit++) { + ret = dm_gpio_set_value(&priv->dat_desc, byte >> bit & 1); + if (ret) + break; + ht1380_half_period_delay(); + + ret = dm_gpio_set_value(&priv->clk_desc, 1); + if (ret) + break; + ht1380_half_period_delay(); + + ret = dm_gpio_set_value(&priv->clk_desc, 0); + if (ret) + break; + } + + return ret; +} + +static int ht1380_reset_off(struct ht1380_priv *priv) +{ + const unsigned int T_CC = 4; /* us, Reset to Clock Setup */ + int ret; + + /* Go out of RESET state. + Make sure we make the minimal delay required by the datasheet. */ + ret = dm_gpio_set_value(&priv->rst_desc, 1); + udelay(T_CC); + return ret; +} + +static int ht1380_reset_on(struct ht1380_priv *priv) +{ + const unsigned int T_CWH = 4; /* us, Reset Inactive Time */ + int ret; + + /* Enter RESET state. + Make sure we make the minimal delay required by the datasheet. */ + ret = dm_gpio_set_value(&priv->rst_desc, 0); + udelay(T_CWH); + return ret; +} + +static int ht1380_rtc_get(struct udevice *dev, struct rtc_time *tm) +{ + struct ht1380_priv *priv = dev_get_priv(dev); + int ret, i, bit, reg[N_REGS]; + + ret = dm_gpio_set_value(&priv->clk_desc, 0); + if (ret) + return ret; + + ret = dm_gpio_set_dir_flags(&priv->dat_desc, GPIOD_IS_OUT); + if (ret) + return ret; + + ret = ht1380_reset_off(priv); + if (ret) + goto exit; + + ret = ht1380_send_byte(priv, BURST + READ); + if (ret) + goto exit; + + ret = dm_gpio_set_dir_flags(&priv->dat_desc, GPIOD_IS_IN); + if (ret) + goto exit; + + for (i = 0; i < N_REGS; i++) { + reg[i] = 0; + + for (bit = 0; bit < 8; bit++) { + ht1380_half_period_delay(); + + ret = dm_gpio_set_value(&priv->clk_desc, 1); + if (ret) + goto exit; + ht1380_half_period_delay(); + + reg[i] |= dm_gpio_get_value(&priv->dat_desc) << bit; + ret = dm_gpio_set_value(&priv->clk_desc, 0); + if (ret) + goto exit; + } + } + + ret = -EINVAL; + + /* Correctness check: some bits are always zero */ + if ((reg[MIN] & 0x80) || (reg[HOUR] & 0x40) || (reg[MDAY] & 0xC0) || + (reg[MONTH] & 0xE0) || (reg[WDAY] & 0xF8) || (reg[WP] & 0x7F)) + goto exit; + + /* Correctness check: some registers are always > 0 */ + if (!reg[MDAY] || !reg[MONTH] || !reg[WDAY]) + goto exit; + + tm->tm_sec = bcd2bin(reg[SEC]); + tm->tm_min = bcd2bin(reg[MIN]); + if (reg[HOUR] & 0x80) { + /* AM-PM Mode, range is 01-12 */ + tm->tm_hour = bcd2bin(reg[HOUR] & 0x1F) % 12; + if (reg[HOUR] & 0x20) { + /* it is PM (otherwise AM) */ + tm->tm_hour += 12; + } + } else { + /* 24-hour Mode, range is 0-23 */ + tm->tm_hour = bcd2bin(reg[HOUR]); + } + tm->tm_mday = bcd2bin(reg[MDAY]); + tm->tm_mon = bcd2bin(reg[MONTH]); + tm->tm_year = 2000 + bcd2bin(reg[YEAR]); + tm->tm_wday = bcd2bin(reg[WDAY]) - 1; + tm->tm_yday = 0; + tm->tm_isdst = 0; + + ret = 0; + +exit: + ht1380_reset_on(priv); + return ret; +} + +static int ht1380_write_protection_off(struct ht1380_priv *priv) +{ + int ret; + const int PROTECT = 0x8E; + + ret = ht1380_reset_off(priv); + if (ret) + return ret; + + ret = ht1380_send_byte(priv, PROTECT); + if (ret) + return ret; + ret = ht1380_send_byte(priv, 0); /* WP bit is 0 */ + if (ret) + return ret; + + return ht1380_reset_on(priv); +} + +static int ht1380_rtc_set(struct udevice *dev, const struct rtc_time *tm) +{ + struct ht1380_priv *priv = dev_get_priv(dev); + int ret, i, reg[N_REGS]; + + ret = dm_gpio_set_value(&priv->clk_desc, 0); + if (ret) + return ret; + + ret = dm_gpio_set_dir_flags(&priv->dat_desc, GPIOD_IS_OUT); + if (ret) + goto exit; + + ret = ht1380_write_protection_off(priv); + if (ret) + goto exit; + + reg[SEC] = bin2bcd(tm->tm_sec); + reg[MIN] = bin2bcd(tm->tm_min); + reg[HOUR] = bin2bcd(tm->tm_hour); + reg[MDAY] = bin2bcd(tm->tm_mday); + reg[MONTH] = bin2bcd(tm->tm_mon); + reg[WDAY] = bin2bcd(tm->tm_wday) + 1; + reg[YEAR] = bin2bcd(tm->tm_year - 2000); + reg[WP] = 0x80; /* WP bit is 1 */ + + ret = ht1380_reset_off(priv); + if (ret) + goto exit; + + ret = ht1380_send_byte(priv, BURST); + for (i = 0; i < N_REGS && ret; i++) + ret = ht1380_send_byte(priv, reg[i]); + +exit: + ht1380_reset_on(priv); + return ret; +} + +static int ht1380_probe(struct udevice *dev) +{ + int ret; + struct ht1380_priv *priv; + + priv = dev_get_priv(dev); + if (!priv) + return -EINVAL; + + ret = gpio_request_by_name(dev, "rst-gpio", 0, + &priv->rst_desc, 0); + if (ret) + goto fail_rst; + + ret = gpio_request_by_name(dev, "clk-gpio", 0, + &priv->clk_desc, 0); + if (ret) + goto fail_clk; + + ret = gpio_request_by_name(dev, "dat-gpio", 0, + &priv->dat_desc, 0); + if (ret) + goto fail_dat; + + ret = dm_gpio_set_dir_flags(&priv->clk_desc, GPIOD_IS_OUT); + if (ret) + goto fail; + + ret = dm_gpio_set_dir_flags(&priv->rst_desc, GPIOD_IS_OUT); + if (ret) + goto fail; + + ret = ht1380_reset_on(priv); + if (ret) + goto fail; + + return 0; + +fail: + dm_gpio_free(dev, &priv->dat_desc); +fail_dat: + dm_gpio_free(dev, &priv->clk_desc); +fail_clk: + dm_gpio_free(dev, &priv->rst_desc); +fail_rst: + return ret; +} + +static int ht1380_remove(struct udevice *dev) +{ + struct ht1380_priv *priv = dev_get_priv(dev); + + dm_gpio_free(dev, &priv->rst_desc); + dm_gpio_free(dev, &priv->clk_desc); + dm_gpio_free(dev, &priv->dat_desc); + return 0; +} + +static const struct rtc_ops ht1380_rtc_ops = { + .get = ht1380_rtc_get, + .set = ht1380_rtc_set, +}; + +static const struct udevice_id ht1380_rtc_ids[] = { + { .compatible = "holtek,ht1380" }, + { } +}; + +U_BOOT_DRIVER(rtc_ht1380) = { + .name = "rtc-ht1380", + .id = UCLASS_RTC, + .probe = ht1380_probe, + .remove = ht1380_remove, + .of_match = ht1380_rtc_ids, + .ops = &ht1380_rtc_ops, + .priv_auto = sizeof(struct ht1380_priv), +}; -- 2.34.1