blob: 78473570b9df6c9292466705709a45581e97a801 [file] [log] [blame]
Marian Balakowicz6e53e272006-03-14 15:59:25 +01001/*
2 * (C) Copyright 2001, 2002, 2003
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 * Keith Outwater, keith_outwater@mvis.com`
5 * Steven Scholz, steven.scholz@imc-berlin.de
6 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02007 * SPDX-License-Identifier: GPL-2.0+
Marian Balakowicz6e53e272006-03-14 15:59:25 +01008 */
9
10/*
11 * Date & Time support (no alarms) for Dallas Semiconductor (now Maxim)
12 * DS1374 Real Time Clock (RTC).
13 *
14 * based on ds1337.c
15 */
16
17#include <common.h>
18#include <command.h>
19#include <rtc.h>
20#include <i2c.h>
21
Michal Simek871c18d2008-07-14 19:45:37 +020022#if defined(CONFIG_CMD_DATE)
Marian Balakowicz6e53e272006-03-14 15:59:25 +010023
24/*---------------------------------------------------------------------*/
25#undef DEBUG_RTC
26#define DEBUG_RTC
27
28#ifdef DEBUG_RTC
29#define DEBUGR(fmt,args...) printf(fmt ,##args)
30#else
31#define DEBUGR(fmt,args...)
32#endif
33/*---------------------------------------------------------------------*/
34
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020035#ifndef CONFIG_SYS_I2C_RTC_ADDR
36# define CONFIG_SYS_I2C_RTC_ADDR 0x68
Marian Balakowicz6e53e272006-03-14 15:59:25 +010037#endif
38
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020039#if defined(CONFIG_RTC_DS1374) && (CONFIG_SYS_I2C_SPEED > 400000)
Marian Balakowicz6e53e272006-03-14 15:59:25 +010040# error The DS1374 is specified up to 400kHz in fast mode!
41#endif
42
43/*
44 * RTC register addresses
45 */
46#define RTC_TOD_CNT_BYTE0_ADDR 0x00 /* TimeOfDay */
47#define RTC_TOD_CNT_BYTE1_ADDR 0x01
48#define RTC_TOD_CNT_BYTE2_ADDR 0x02
49#define RTC_TOD_CNT_BYTE3_ADDR 0x03
50
51#define RTC_WD_ALM_CNT_BYTE0_ADDR 0x04
52#define RTC_WD_ALM_CNT_BYTE1_ADDR 0x05
53#define RTC_WD_ALM_CNT_BYTE2_ADDR 0x06
54
55#define RTC_CTL_ADDR 0x07 /* RTC-CoNTrol-register */
56#define RTC_SR_ADDR 0x08 /* RTC-StatusRegister */
57#define RTC_TCS_DS_ADDR 0x09 /* RTC-TrickleChargeSelect DiodeSelect-register */
58
59#define RTC_CTL_BIT_AIE (1<<0) /* Bit 0 - Alarm Interrupt enable */
60#define RTC_CTL_BIT_RS1 (1<<1) /* Bit 1/2 - Rate Select square wave output */
61#define RTC_CTL_BIT_RS2 (1<<2) /* Bit 2/2 - Rate Select square wave output */
62#define RTC_CTL_BIT_WDSTR (1<<3) /* Bit 3 - Watchdog Reset Steering */
63#define RTC_CTL_BIT_BBSQW (1<<4) /* Bit 4 - Battery-Backed Square-Wave */
64#define RTC_CTL_BIT_WD_ALM (1<<5) /* Bit 5 - Watchdoc/Alarm Counter Select */
65#define RTC_CTL_BIT_WACE (1<<6) /* Bit 6 - Watchdog/Alarm Counter Enable WACE*/
66#define RTC_CTL_BIT_EN_OSC (1<<7) /* Bit 7 - Enable Oscilator */
67
68#define RTC_SR_BIT_AF 0x01 /* Bit 0 = Alarm Flag */
69#define RTC_SR_BIT_OSF 0x80 /* Bit 7 - Osc Stop Flag */
70
Marian Balakowicz6e53e272006-03-14 15:59:25 +010071const char RtcTodAddr[] = {
72 RTC_TOD_CNT_BYTE0_ADDR,
73 RTC_TOD_CNT_BYTE1_ADDR,
74 RTC_TOD_CNT_BYTE2_ADDR,
75 RTC_TOD_CNT_BYTE3_ADDR
76};
77
78static uchar rtc_read (uchar reg);
York Sun472d5462013-04-01 11:29:11 -070079static void rtc_write(uchar reg, uchar val, bool set);
Marian Balakowicz6e53e272006-03-14 15:59:25 +010080static void rtc_write_raw (uchar reg, uchar val);
81
82/*
83 * Get the current time from the RTC
84 */
Yuri Tikhonovb73a19e2008-03-20 17:56:04 +030085int rtc_get (struct rtc_time *tm){
86 int rel = 0;
Marian Balakowicz6e53e272006-03-14 15:59:25 +010087 unsigned long time1, time2;
88 unsigned int limit;
89 unsigned char tmp;
90 unsigned int i;
91
92 /*
93 * Since the reads are being performed one byte at a time,
Wolfgang Denkcf48eb92006-04-16 10:51:58 +020094 * there is a chance that a carry will occur during the read.
Marian Balakowicz6e53e272006-03-14 15:59:25 +010095 * To detect this, 2 reads are performed and compared.
96 */
97 limit = 10;
98 do {
99 i = 4;
100 time1 = 0;
101 while (i--) {
102 tmp = rtc_read(RtcTodAddr[i]);
103 time1 = (time1 << 8) | (tmp & 0xff);
104 }
105
106 i = 4;
107 time2 = 0;
108 while (i--) {
109 tmp = rtc_read(RtcTodAddr[i]);
110 time2 = (time2 << 8) | (tmp & 0xff);
111 }
112 } while ((time1 != time2) && limit--);
113
114 if (time1 != time2) {
115 printf("can't get consistent time from rtc chip\n");
Yuri Tikhonovb73a19e2008-03-20 17:56:04 +0300116 rel = -1;
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100117 }
118
Kim Phillips4109df62008-07-10 14:00:15 -0500119 DEBUGR ("Get RTC s since 1.1.1970: %ld\n", time1);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100120
Simon Glass9f9276c2015-04-20 12:37:18 -0600121 rtc_to_tm(time1, tm); /* To Gregorian Date */
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100122
Yuri Tikhonovb73a19e2008-03-20 17:56:04 +0300123 if (rtc_read(RTC_SR_ADDR) & RTC_SR_BIT_OSF) {
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100124 printf ("### Warning: RTC oscillator has stopped\n");
Yuri Tikhonovb73a19e2008-03-20 17:56:04 +0300125 rel = -1;
126 }
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100127
128 DEBUGR ("Get DATE: %4d-%02d-%02d (wday=%d) TIME: %2d:%02d:%02d\n",
129 tm->tm_year, tm->tm_mon, tm->tm_mday, tm->tm_wday,
130 tm->tm_hour, tm->tm_min, tm->tm_sec);
Yuri Tikhonovb73a19e2008-03-20 17:56:04 +0300131
132 return rel;
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100133}
134
135/*
136 * Set the RTC
137 */
Jean-Christophe PLAGNIOL-VILLARDd1e23192008-09-01 23:06:23 +0200138int rtc_set (struct rtc_time *tmp){
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100139
140 unsigned long time;
141 unsigned i;
142
143 DEBUGR ("Set DATE: %4d-%02d-%02d (wday=%d) TIME: %2d:%02d:%02d\n",
144 tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
145 tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
146
147 if (tmp->tm_year < 1970 || tmp->tm_year > 2069)
148 printf("WARNING: year should be between 1970 and 2069!\n");
149
Simon Glass71420982015-04-20 12:37:19 -0600150 time = rtc_mktime(tmp);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100151
Kim Phillips4109df62008-07-10 14:00:15 -0500152 DEBUGR ("Set RTC s since 1.1.1970: %ld (0x%02lx)\n", time, time);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100153
154 /* write to RTC_TOD_CNT_BYTEn_ADDR */
155 for (i = 0; i <= 3; i++) {
156 rtc_write_raw(RtcTodAddr[i], (unsigned char)(time & 0xff));
157 time = time >> 8;
158 }
159
160 /* Start clock */
York Sun472d5462013-04-01 11:29:11 -0700161 rtc_write(RTC_CTL_ADDR, RTC_CTL_BIT_EN_OSC, false);
Jean-Christophe PLAGNIOL-VILLARDd1e23192008-09-01 23:06:23 +0200162
163 return 0;
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100164}
165
166/*
167 * Reset the RTC. We setting the date back to 1970-01-01.
168 * We also enable the oscillator output on the SQW/OUT pin and program
169 * it for 32,768 Hz output. Note that according to the datasheet, turning
170 * on the square wave output increases the current drain on the backup
171 * battery to something between 480nA and 800nA.
172 */
173void rtc_reset (void){
174
175 struct rtc_time tmp;
176
177 /* clear status flags */
York Sun472d5462013-04-01 11:29:11 -0700178 rtc_write(RTC_SR_ADDR, (RTC_SR_BIT_AF|RTC_SR_BIT_OSF), false); /* clearing OSF and AF */
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100179
180 /* Initialise DS1374 oriented to MPC8349E-ADS */
181 rtc_write (RTC_CTL_ADDR, (RTC_CTL_BIT_EN_OSC
182 |RTC_CTL_BIT_WACE
York Sun472d5462013-04-01 11:29:11 -0700183 |RTC_CTL_BIT_AIE), false);/* start osc, disable WACE, clear AIE
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100184 - set to 0 */
185 rtc_write (RTC_CTL_ADDR, (RTC_CTL_BIT_WD_ALM
186 |RTC_CTL_BIT_WDSTR
187 |RTC_CTL_BIT_RS1
188 |RTC_CTL_BIT_RS2
York Sun472d5462013-04-01 11:29:11 -0700189 |RTC_CTL_BIT_BBSQW), true);/* disable WD/ALM, WDSTR set to INT-pin,
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100190 set BBSQW and SQW to 32k
191 - set to 1 */
192 tmp.tm_year = 1970;
193 tmp.tm_mon = 1;
194 tmp.tm_mday= 1;
195 tmp.tm_hour = 0;
196 tmp.tm_min = 0;
197 tmp.tm_sec = 0;
198
199 rtc_set(&tmp);
200
201 printf("RTC: %4d-%02d-%02d %2d:%02d:%02d UTC\n",
202 tmp.tm_year, tmp.tm_mon, tmp.tm_mday,
203 tmp.tm_hour, tmp.tm_min, tmp.tm_sec);
204
York Sun472d5462013-04-01 11:29:11 -0700205 rtc_write(RTC_WD_ALM_CNT_BYTE2_ADDR, 0xAC, true);
206 rtc_write(RTC_WD_ALM_CNT_BYTE1_ADDR, 0xDE, true);
207 rtc_write(RTC_WD_ALM_CNT_BYTE2_ADDR, 0xAD, true);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100208}
209
210/*
211 * Helper functions
212 */
213static uchar rtc_read (uchar reg)
214{
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200215 return (i2c_reg_read (CONFIG_SYS_I2C_RTC_ADDR, reg));
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100216}
217
York Sun472d5462013-04-01 11:29:11 -0700218static void rtc_write(uchar reg, uchar val, bool set)
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100219{
York Sun472d5462013-04-01 11:29:11 -0700220 if (set == true) {
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200221 val |= i2c_reg_read (CONFIG_SYS_I2C_RTC_ADDR, reg);
222 i2c_reg_write (CONFIG_SYS_I2C_RTC_ADDR, reg, val);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100223 } else {
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200224 val = i2c_reg_read (CONFIG_SYS_I2C_RTC_ADDR, reg) & ~val;
225 i2c_reg_write (CONFIG_SYS_I2C_RTC_ADDR, reg, val);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100226 }
227}
228
229static void rtc_write_raw (uchar reg, uchar val)
230{
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200231 i2c_reg_write (CONFIG_SYS_I2C_RTC_ADDR, reg, val);
Marian Balakowicz6e53e272006-03-14 15:59:25 +0100232}
Jon Loeliger068b60a2007-07-10 10:27:39 -0500233#endif