[people/ms/u-boot.git] / drivers / rtc / m41t11.c

/*
 * (C) Copyright 2002
 * Andrew May, Viasat Inc, amay@viasat.com
 *
 * 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
 */

/*
 * M41T11 Serial Access Timekeeper(R) SRAM
 * can you believe a trademark on that?
 */

/* #define DEBUG 1 */

#include <common.h>
#include <command.h>
#include <rtc.h>
#include <i2c.h>

/*
	I Don't have an example config file but this
	is what should be done.

#define CONFIG_RTC_M41T11 1
#define CONFIG_SYS_I2C_RTC_ADDR 0x68
#if 0
#define CONFIG_SYS_M41T11_EXT_CENTURY_DATA
#else
#define CONFIG_SYS_M41T11_BASE_YEAR 2000
#endif
*/

#if defined(CONFIG_SYS_I2C_RTC_ADDR) && defined(CONFIG_CMD_DATE)

static unsigned bcd2bin (uchar n)
{
	return ((((n >> 4) & 0x0F) * 10) + (n & 0x0F));
}

static unsigned char bin2bcd (unsigned int n)
{
	return (((n / 10) << 4) | (n % 10));
}


/* ------------------------------------------------------------------------- */
/*
  these are simple defines for the chip local to here so they aren't too
  verbose
  DAY/DATE aren't nice but that is how they are on the data sheet
*/
#define RTC_SEC_ADDR       0x0
#define RTC_MIN_ADDR       0x1
#define RTC_HOUR_ADDR      0x2
#define RTC_DAY_ADDR       0x3
#define RTC_DATE_ADDR      0x4
#define RTC_MONTH_ADDR     0x5
#define RTC_YEARS_ADDR     0x6

#define RTC_REG_CNT        7

#define RTC_CONTROL_ADDR   0x7


#ifndef CONFIG_SYS_M41T11_EXT_CENTURY_DATA

#define REG_CNT            (RTC_REG_CNT+1)

/*
  you only get 00-99 for the year we will asume you
  want from the year 2000 if you don't set the config
*/
#ifndef CONFIG_SYS_M41T11_BASE_YEAR
#define CONFIG_SYS_M41T11_BASE_YEAR 2000
#endif

#else
/* we will store extra year info in byte 9*/
#define M41T11_YEAR_DATA   0x8
#define M41T11_YEAR_SIZE   1
#define REG_CNT            (RTC_REG_CNT+1+M41T11_YEAR_SIZE)
#endif

#define M41T11_STORAGE_SZ  (64-REG_CNT)

int rtc_get (struct rtc_time *tmp)
{
	int rel = 0;
	uchar data[RTC_REG_CNT];

	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, data, RTC_REG_CNT);

	if( data[RTC_SEC_ADDR] & 0x80 ){
		printf( "m41t11 RTC Clock stopped!!!\n" );
		rel = -1;
	}
	tmp->tm_sec  = bcd2bin (data[RTC_SEC_ADDR]  & 0x7F);
	tmp->tm_min  = bcd2bin (data[RTC_MIN_ADDR]  & 0x7F);
	tmp->tm_hour = bcd2bin (data[RTC_HOUR_ADDR] & 0x3F);
	tmp->tm_mday = bcd2bin (data[RTC_DATE_ADDR] & 0x3F);
	tmp->tm_mon  = bcd2bin (data[RTC_MONTH_ADDR]& 0x1F);
#ifndef CONFIG_SYS_M41T11_EXT_CENTURY_DATA
	tmp->tm_year = CONFIG_SYS_M41T11_BASE_YEAR
		+ bcd2bin(data[RTC_YEARS_ADDR])
		+ ((data[RTC_HOUR_ADDR]&0x40) ? 100 : 0);
#else
	{
		unsigned char cent;
		i2c_read(CONFIG_SYS_I2C_RTC_ADDR, M41T11_YEAR_DATA, 1, &cent, M41T11_YEAR_SIZE);
		if( !(data[RTC_HOUR_ADDR] & 0x80) ){
			printf( "m41t11 RTC: cann't keep track of years without CEB set\n" );
			rel = -1;
		}
		if( (cent & 0x1) != ((data[RTC_HOUR_ADDR]&0x40)>>7) ){
			/*century flip store off new year*/
			cent += 1;
			i2c_write(CONFIG_SYS_I2C_RTC_ADDR, M41T11_YEAR_DATA, 1, &cent, M41T11_YEAR_SIZE);
		}
		tmp->tm_year =((int)cent*100)+bcd2bin(data[RTC_YEARS_ADDR]);
	}
#endif
	tmp->tm_wday = bcd2bin (data[RTC_DAY_ADDR]  & 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 rel;
}

int rtc_set (struct rtc_time *tmp)
{
	uchar data[RTC_REG_CNT];

	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);

	data[RTC_SEC_ADDR]    = bin2bcd(tmp->tm_sec) &  0x7F;/*just in case*/
	data[RTC_MIN_ADDR]    = bin2bcd(tmp->tm_min);
	data[RTC_HOUR_ADDR]   = bin2bcd(tmp->tm_hour) & 0x3F;/*handle cent stuff later*/
	data[RTC_DATE_ADDR]   = bin2bcd(tmp->tm_mday) & 0x3F;
	data[RTC_MONTH_ADDR]  = bin2bcd(tmp->tm_mon);
	data[RTC_DAY_ADDR]    = bin2bcd(tmp->tm_wday) & 0x07;

	data[RTC_HOUR_ADDR]   |= 0x80;/*we will always use CEB*/

	data[RTC_YEARS_ADDR]  = bin2bcd(tmp->tm_year%100);/*same thing either way*/
#ifndef CONFIG_SYS_M41T11_EXT_CENTURY_DATA
	if( ((tmp->tm_year - CONFIG_SYS_M41T11_BASE_YEAR) > 200) ||
	    (tmp->tm_year < CONFIG_SYS_M41T11_BASE_YEAR) ){
		printf( "m41t11 RTC setting year out of range!!need recompile\n" );
	}
	data[RTC_HOUR_ADDR] |= (tmp->tm_year - CONFIG_SYS_M41T11_BASE_YEAR) > 100 ? 0x40 : 0;
#else
	{
		unsigned char cent;
		cent = tmp->tm_year ? tmp->tm_year / 100 : 0;
		data[RTC_HOUR_ADDR] |= (cent & 0x1) ? 0x40 : 0;
		i2c_write(CONFIG_SYS_I2C_RTC_ADDR, M41T11_YEAR_DATA, 1, &cent, M41T11_YEAR_SIZE);
	}
#endif
	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, data, RTC_REG_CNT);

	return 0;
}

void rtc_reset (void)
{
	unsigned char val;
	/* clear all control & status registers */
	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, &val, 1);
	val = val & 0x7F;/*make sure we are running*/
	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, &val, RTC_REG_CNT);

	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, RTC_CONTROL_ADDR, 1, &val, 1);
	val = val & 0x3F;/*turn off freq test keep calibration*/
	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, RTC_CONTROL_ADDR, 1, &val, 1);
}

int rtc_store(int addr, unsigned char* data, int size)
{
	/*don't let things wrap onto the time on a write*/
	if( (addr+size) >= M41T11_STORAGE_SZ )
		return 1;
	return i2c_write( CONFIG_SYS_I2C_RTC_ADDR, REG_CNT+addr, 1, data, size );
}

int rtc_recall(int addr, unsigned char* data, int size)
{
	return i2c_read( CONFIG_SYS_I2C_RTC_ADDR, REG_CNT+addr, 1, data, size );
}

#endif
Commit	Line	Data
affae2bf WD	1	/*
	2	* (C) Copyright 2002
	3	* Andrew May, Viasat Inc, amay@viasat.com
	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public License as
	7	* published by the Free Software Foundation; either version 2 of
	8	* the License, or (at your option) any later version.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	18	* MA 02111-1307 USA
	19	*/
	20
	21	/*
	22	* M41T11 Serial Access Timekeeper(R) SRAM
	23	* can you believe a trademark on that?
	24	*/
	25
e6325153 WD	26	/* #define DEBUG 1 */
e6325153 WD	27
affae2bf WD	28	#include <common.h>
	29	#include <command.h>
	30	#include <rtc.h>
	31	#include <i2c.h>
	32
	33	/*
	34	I Don't have an example config file but this
	35	is what should be done.
	36
	37	#define CONFIG_RTC_M41T11 1
6d0f6bcf	38	#define CONFIG_SYS_I2C_RTC_ADDR 0x68
affae2bf	39	#if 0
6d0f6bcf	40	#define CONFIG_SYS_M41T11_EXT_CENTURY_DATA
affae2bf	41	#else
6d0f6bcf	42	#define CONFIG_SYS_M41T11_BASE_YEAR 2000
affae2bf WD	43	#endif
	44	*/
	45
6d0f6bcf	46	#if defined(CONFIG_SYS_I2C_RTC_ADDR) && defined(CONFIG_CMD_DATE)
affae2bf	47
affae2bf WD	48	static unsigned bcd2bin (uchar n)
	49	{
	50	return ((((n >> 4) & 0x0F) * 10) + (n & 0x0F));
	51	}
	52
	53	static unsigned char bin2bcd (unsigned int n)
	54	{
	55	return (((n / 10) << 4) \| (n % 10));
	56	}
	57
	58
	59	/* ------------------------------------------------------------------------- */
	60	/*
	61	these are simple defines for the chip local to here so they aren't too
	62	verbose
	63	DAY/DATE aren't nice but that is how they are on the data sheet
	64	*/
	65	#define RTC_SEC_ADDR 0x0
	66	#define RTC_MIN_ADDR 0x1
	67	#define RTC_HOUR_ADDR 0x2
	68	#define RTC_DAY_ADDR 0x3
	69	#define RTC_DATE_ADDR 0x4
	70	#define RTC_MONTH_ADDR 0x5
	71	#define RTC_YEARS_ADDR 0x6
	72
	73	#define RTC_REG_CNT 7
	74
	75	#define RTC_CONTROL_ADDR 0x7
	76
	77
6d0f6bcf	78	#ifndef CONFIG_SYS_M41T11_EXT_CENTURY_DATA
affae2bf WD	79
	80	#define REG_CNT (RTC_REG_CNT+1)
	81
	82	/*
	83	you only get 00-99 for the year we will asume you
	84	want from the year 2000 if you don't set the config
	85	*/
6d0f6bcf JCPV	86	#ifndef CONFIG_SYS_M41T11_BASE_YEAR
6d0f6bcf JCPV	87	#define CONFIG_SYS_M41T11_BASE_YEAR 2000
affae2bf WD	88	#endif
	89
	90	#else
	91	/* we will store extra year info in byte 9*/
	92	#define M41T11_YEAR_DATA 0x8
	93	#define M41T11_YEAR_SIZE 1
	94	#define REG_CNT (RTC_REG_CNT+1+M41T11_YEAR_SIZE)
	95	#endif
	96
	97	#define M41T11_STORAGE_SZ (64-REG_CNT)
	98
b73a19e1	99	int rtc_get (struct rtc_time *tmp)
affae2bf	100	{
b73a19e1	101	int rel = 0;
8bde7f77	102	uchar data[RTC_REG_CNT];
affae2bf	103
6d0f6bcf	104	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, data, RTC_REG_CNT);
affae2bf	105
8bde7f77 WD	106	if( data[RTC_SEC_ADDR] & 0x80 ){
8bde7f77 WD	107	printf( "m41t11 RTC Clock stopped!!!\n" );
b73a19e1	108	rel = -1;
8bde7f77	109	}
affae2bf WD	110	tmp->tm_sec = bcd2bin (data[RTC_SEC_ADDR] & 0x7F);
	111	tmp->tm_min = bcd2bin (data[RTC_MIN_ADDR] & 0x7F);
	112	tmp->tm_hour = bcd2bin (data[RTC_HOUR_ADDR] & 0x3F);
	113	tmp->tm_mday = bcd2bin (data[RTC_DATE_ADDR] & 0x3F);
	114	tmp->tm_mon = bcd2bin (data[RTC_MONTH_ADDR]& 0x1F);
6d0f6bcf JCPV	115	#ifndef CONFIG_SYS_M41T11_EXT_CENTURY_DATA
6d0f6bcf JCPV	116	tmp->tm_year = CONFIG_SYS_M41T11_BASE_YEAR
8bde7f77 WD	117	+ bcd2bin(data[RTC_YEARS_ADDR])
8bde7f77 WD	118	+ ((data[RTC_HOUR_ADDR]&0x40) ? 100 : 0);
affae2bf	119	#else
8bde7f77 WD	120	{
8bde7f77 WD	121	unsigned char cent;
6d0f6bcf	122	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, M41T11_YEAR_DATA, 1, &cent, M41T11_YEAR_SIZE);
8bde7f77 WD	123	if( !(data[RTC_HOUR_ADDR] & 0x80) ){
8bde7f77 WD	124	printf( "m41t11 RTC: cann't keep track of years without CEB set\n" );
b73a19e1	125	rel = -1;
8bde7f77 WD	126	}
	127	if( (cent & 0x1) != ((data[RTC_HOUR_ADDR]&0x40)>>7) ){
	128	/century flip store off new year/
	129	cent += 1;
6d0f6bcf	130	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, M41T11_YEAR_DATA, 1, &cent, M41T11_YEAR_SIZE);
8bde7f77 WD	131	}
	132	tmp->tm_year =((int)cent*100)+bcd2bin(data[RTC_YEARS_ADDR]);
	133	}
affae2bf WD	134	#endif
	135	tmp->tm_wday = bcd2bin (data[RTC_DAY_ADDR] & 0x07);
	136	tmp->tm_yday = 0;
	137	tmp->tm_isdst= 0;
	138
	139	debug ( "Get DATE: %4d-%02d-%02d (wday=%d) TIME: %2d:%02d:%02d\n",
	140	tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
	141	tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
b73a19e1 YT	142
b73a19e1 YT	143	return rel;
affae2bf WD	144	}
affae2bf WD	145
d1e23194	146	int rtc_set (struct rtc_time *tmp)
affae2bf	147	{
8bde7f77	148	uchar data[RTC_REG_CNT];
affae2bf WD	149
	150	debug ( "Set DATE: %4d-%02d-%02d (wday=%d) TIME: %2d:%02d:%02d\n",
	151	tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
	152	tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
	153
	154	data[RTC_SEC_ADDR] = bin2bcd(tmp->tm_sec) & 0x7F;/just in case/
	155	data[RTC_MIN_ADDR] = bin2bcd(tmp->tm_min);
	156	data[RTC_HOUR_ADDR] = bin2bcd(tmp->tm_hour) & 0x3F;/handle cent stuff later/
	157	data[RTC_DATE_ADDR] = bin2bcd(tmp->tm_mday) & 0x3F;
	158	data[RTC_MONTH_ADDR] = bin2bcd(tmp->tm_mon);
	159	data[RTC_DAY_ADDR] = bin2bcd(tmp->tm_wday) & 0x07;
	160
8bde7f77	161	data[RTC_HOUR_ADDR] \|= 0x80;/we will always use CEB/
affae2bf	162
8bde7f77	163	data[RTC_YEARS_ADDR] = bin2bcd(tmp->tm_year%100);/same thing either way/
6d0f6bcf JCPV	164	#ifndef CONFIG_SYS_M41T11_EXT_CENTURY_DATA
	165	if( ((tmp->tm_year - CONFIG_SYS_M41T11_BASE_YEAR) > 200) \|\|
	166	(tmp->tm_year < CONFIG_SYS_M41T11_BASE_YEAR) ){
8bde7f77 WD	167	printf( "m41t11 RTC setting year out of range!!need recompile\n" );
8bde7f77 WD	168	}
6d0f6bcf	169	data[RTC_HOUR_ADDR] \|= (tmp->tm_year - CONFIG_SYS_M41T11_BASE_YEAR) > 100 ? 0x40 : 0;
affae2bf	170	#else
8bde7f77 WD	171	{
	172	unsigned char cent;
	173	cent = tmp->tm_year ? tmp->tm_year / 100 : 0;
	174	data[RTC_HOUR_ADDR] \|= (cent & 0x1) ? 0x40 : 0;
6d0f6bcf	175	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, M41T11_YEAR_DATA, 1, &cent, M41T11_YEAR_SIZE);
8bde7f77	176	}
affae2bf	177	#endif
6d0f6bcf	178	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, data, RTC_REG_CNT);
d1e23194 JCPV	179
d1e23194 JCPV	180	return 0;
affae2bf WD	181	}
	182
	183	void rtc_reset (void)
	184	{
8bde7f77	185	unsigned char val;
affae2bf	186	/* clear all control & status registers */
6d0f6bcf	187	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, &val, 1);
8bde7f77	188	val = val & 0x7F;/make sure we are running/
6d0f6bcf	189	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, RTC_SEC_ADDR, 1, &val, RTC_REG_CNT);
affae2bf	190
6d0f6bcf	191	i2c_read(CONFIG_SYS_I2C_RTC_ADDR, RTC_CONTROL_ADDR, 1, &val, 1);
8bde7f77	192	val = val & 0x3F;/turn off freq test keep calibration/
6d0f6bcf	193	i2c_write(CONFIG_SYS_I2C_RTC_ADDR, RTC_CONTROL_ADDR, 1, &val, 1);
affae2bf WD	194	}
	195
	196	int rtc_store(int addr, unsigned char* data, int size)
	197	{
8bde7f77 WD	198	/don't let things wrap onto the time on a write/
	199	if( (addr+size) >= M41T11_STORAGE_SZ )
	200	return 1;
6d0f6bcf	201	return i2c_write( CONFIG_SYS_I2C_RTC_ADDR, REG_CNT+addr, 1, data, size );
affae2bf WD	202	}
	203
	204	int rtc_recall(int addr, unsigned char* data, int size)
	205	{
6d0f6bcf	206	return i2c_read( CONFIG_SYS_I2C_RTC_ADDR, REG_CNT+addr, 1, data, size );
affae2bf WD	207	}
affae2bf WD	208
068b60a0	209	#endif