global: Move remaining CONFIG_SYS_* to CFG_SYS_*
[platform/kernel/u-boot.git] / drivers / rtc / ds3231.c
index 95cb186..bd32ed2 100644 (file)
@@ -1,24 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2006
  * Markus Klotzbuecher, mk@denx.de
  *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
+ * (C) Copyright 2019 NXP
+ * Chuanhua Han <chuanhua.han@nxp.com>
  */
 
 /*
 
 #include <common.h>
 #include <command.h>
+#include <dm.h>
+#include <log.h>
 #include <rtc.h>
 #include <i2c.h>
 
-#if defined(CONFIG_RTC_DS3231) && defined(CONFIG_CMD_DATE)
-
-/*---------------------------------------------------------------------*/
-#undef DEBUG_RTC
-
-#ifdef DEBUG_RTC
-#define DEBUGR(fmt,args...) printf(fmt ,##args)
-#else
-#define DEBUGR(fmt,args...)
-#endif
-/*---------------------------------------------------------------------*/
-
 /*
  * RTC register addresses
  */
 #define RTC_STAT_BIT_A1F       0x1     /* Alarm 1 flag                 */
 #define RTC_STAT_BIT_A2F       0x2     /* Alarm 2 flag                 */
 #define RTC_STAT_BIT_OSF       0x80    /* Oscillator stop flag         */
+#define RTC_STAT_BIT_BB32KHZ   0x40    /* Battery backed 32KHz Output  */
+#define RTC_STAT_BIT_EN32KHZ   0x8     /* Enable 32KHz Output  */
 
 
+#if !CONFIG_IS_ENABLED(DM_RTC)
 static uchar rtc_read (uchar reg);
 static void rtc_write (uchar reg, uchar val);
-static uchar bin2bcd (unsigned int n);
-static unsigned bcd2bin (uchar c);
 
 
 /*
@@ -101,7 +78,7 @@ int rtc_get (struct rtc_time *tmp)
        mon_cent = rtc_read (RTC_MON_REG_ADDR);
        year = rtc_read (RTC_YR_REG_ADDR);
 
-       DEBUGR ("Get RTC year: %02x mon/cent: %02x mday: %02x wday: %02x "
+       debug("Get RTC year: %02x mon/cent: %02x mday: %02x wday: %02x "
                "hr: %02x min: %02x sec: %02x control: %02x status: %02x\n",
                year, mon_cent, mday, wday, hour, min, sec, control, status);
 
@@ -123,7 +100,7 @@ int rtc_get (struct rtc_time *tmp)
        tmp->tm_yday = 0;
        tmp->tm_isdst= 0;
 
-       DEBUGR ("Get DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
+       debug("Get DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
                tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
                tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 
@@ -134,11 +111,11 @@ int rtc_get (struct rtc_time *tmp)
 /*
  * Set the RTC
  */
-void rtc_set (struct rtc_time *tmp)
+int rtc_set (struct rtc_time *tmp)
 {
        uchar century;
 
-       DEBUGR ("Set DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
+       debug("Set DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
                tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
                tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 
@@ -152,6 +129,8 @@ void rtc_set (struct rtc_time *tmp)
        rtc_write (RTC_HR_REG_ADDR, bin2bcd (tmp->tm_hour));
        rtc_write (RTC_MIN_REG_ADDR, bin2bcd (tmp->tm_min));
        rtc_write (RTC_SEC_REG_ADDR, bin2bcd (tmp->tm_sec));
+
+       return 0;
 }
 
 
@@ -167,6 +146,16 @@ void rtc_reset (void)
        rtc_write (RTC_CTL_REG_ADDR, RTC_CTL_BIT_RS1 | RTC_CTL_BIT_RS2);
 }
 
+/*
+ * Enable 32KHz output
+ */
+#ifdef CONFIG_RTC_ENABLE_32KHZ_OUTPUT
+void rtc_enable_32khz_output(void)
+{
+       rtc_write(RTC_STAT_REG_ADDR,
+                 RTC_STAT_BIT_BB32KHZ | RTC_STAT_BIT_EN32KHZ);
+}
+#endif
 
 /*
  * Helper functions
@@ -175,23 +164,129 @@ void rtc_reset (void)
 static
 uchar rtc_read (uchar reg)
 {
-       return (i2c_reg_read (CFG_I2C_RTC_ADDR, reg));
+       return (i2c_reg_read (CFG_SYS_I2C_RTC_ADDR, reg));
 }
 
 
 static void rtc_write (uchar reg, uchar val)
 {
-       i2c_reg_write (CFG_I2C_RTC_ADDR, reg, val);
+       i2c_reg_write (CFG_SYS_I2C_RTC_ADDR, reg, val);
+}
+#else
+static int ds3231_rtc_get(struct udevice *dev, struct rtc_time *tmp)
+{
+       uchar sec, min, hour, mday, wday, mon_cent, year, status;
+
+       status = dm_i2c_reg_read(dev, RTC_STAT_REG_ADDR);
+       sec = dm_i2c_reg_read(dev, RTC_SEC_REG_ADDR);
+       min = dm_i2c_reg_read(dev, RTC_MIN_REG_ADDR);
+       hour = dm_i2c_reg_read(dev, RTC_HR_REG_ADDR);
+       wday = dm_i2c_reg_read(dev, RTC_DAY_REG_ADDR);
+       mday = dm_i2c_reg_read(dev, RTC_DATE_REG_ADDR);
+       mon_cent = dm_i2c_reg_read(dev, RTC_MON_REG_ADDR);
+       year = dm_i2c_reg_read(dev, RTC_YR_REG_ADDR);
+
+       if (status & RTC_STAT_BIT_OSF) {
+               printf("### Warning: RTC oscillator has stopped\n");
+               /* clear the OSF flag */
+               dm_i2c_reg_write(dev, RTC_STAT_REG_ADDR,
+                                dm_i2c_reg_read(dev, RTC_STAT_REG_ADDR)
+                                               & ~RTC_STAT_BIT_OSF);
+               return -EINVAL;
+       }
+
+       tmp->tm_sec  = bcd2bin(sec & 0x7F);
+       tmp->tm_min  = bcd2bin(min & 0x7F);
+       tmp->tm_hour = bcd2bin(hour & 0x3F);
+       tmp->tm_mday = bcd2bin(mday & 0x3F);
+       tmp->tm_mon  = bcd2bin(mon_cent & 0x1F);
+       tmp->tm_year = bcd2bin(year) + ((mon_cent & 0x80) ? 2000 : 1900);
+       tmp->tm_wday = bcd2bin((wday - 1) & 0x07);
+       tmp->tm_yday = 0;
+       tmp->tm_isdst = 0;
+
+       debug("Get DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
+             tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
+             tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
+
+       return 0;
+}
+
+static int ds3231_rtc_set(struct udevice *dev, const struct rtc_time *tmp)
+{
+       uchar century;
+
+       debug("Set DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
+             tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
+             tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
+
+       dm_i2c_reg_write(dev, RTC_YR_REG_ADDR, bin2bcd(tmp->tm_year % 100));
+
+       century = (tmp->tm_year >= 2000) ? 0x80 : 0;
+       dm_i2c_reg_write(dev, RTC_MON_REG_ADDR, bin2bcd(tmp->tm_mon) | century);
+
+       dm_i2c_reg_write(dev, RTC_DAY_REG_ADDR, bin2bcd(tmp->tm_wday + 1));
+       dm_i2c_reg_write(dev, RTC_DATE_REG_ADDR, bin2bcd(tmp->tm_mday));
+       dm_i2c_reg_write(dev, RTC_HR_REG_ADDR, bin2bcd(tmp->tm_hour));
+       dm_i2c_reg_write(dev, RTC_MIN_REG_ADDR, bin2bcd(tmp->tm_min));
+       dm_i2c_reg_write(dev, RTC_SEC_REG_ADDR, bin2bcd(tmp->tm_sec));
+
+       return 0;
+}
+
+static int ds3231_rtc_reset(struct udevice *dev)
+{
+       int ret;
+
+       ret = dm_i2c_reg_write(dev, RTC_CTL_REG_ADDR,
+                              RTC_CTL_BIT_RS1 | RTC_CTL_BIT_RS2);
+       if (ret < 0)
+               return ret;
+
+       return 0;
 }
 
-static unsigned bcd2bin (uchar n)
+static int ds3231_probe(struct udevice *dev)
 {
-       return ((((n >> 4) & 0x0F) * 10) + (n & 0x0F));
+       i2c_set_chip_flags(dev, DM_I2C_CHIP_RD_ADDRESS |
+                       DM_I2C_CHIP_WR_ADDRESS);
+
+       return 0;
 }
 
-static unsigned char bin2bcd (unsigned int n)
+#ifdef CONFIG_RTC_ENABLE_32KHZ_OUTPUT
+int rtc_enable_32khz_output(int busnum, int chip_addr)
 {
-       return (((n / 10) << 4) | (n % 10));
+       int ret;
+       struct udevice *dev;
+
+       ret = i2c_get_chip_for_busnum(busnum, chip_addr, 1, &dev);
+       if (!ret) {
+               ret = dm_i2c_reg_write(dev, RTC_STAT_REG_ADDR,
+                                      RTC_STAT_BIT_BB32KHZ |
+                                      RTC_STAT_BIT_EN32KHZ);
+       }
+       return ret;
 }
+#endif
 
+static const struct rtc_ops ds3231_rtc_ops = {
+       .get = ds3231_rtc_get,
+       .set = ds3231_rtc_set,
+       .reset = ds3231_rtc_reset,
+};
+
+static const struct udevice_id ds3231_rtc_ids[] = {
+       { .compatible = "dallas,ds3231" },
+       { .compatible = "dallas,ds3232" },
+       { }
+};
+
+U_BOOT_DRIVER(rtc_ds3231) = {
+       .name   = "rtc-ds3231",
+       .id     = UCLASS_RTC,
+       .probe  = ds3231_probe,
+       .of_match = ds3231_rtc_ids,
+       .ops    = &ds3231_rtc_ops,
+};
 #endif