[deliverable/linux.git] / drivers / rtc / rtc-rs5c372.c

/*
 * An I2C driver for the Ricoh RS5C372 RTC
 *
 * Copyright (C) 2005 Pavel Mironchik <pmironchik@optifacio.net>
 * Copyright (C) 2006 Tower Technologies
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/i2c.h>
#include <linux/rtc.h>
#include <linux/bcd.h>

#define DRV_VERSION "0.2"

/* Addresses to scan */
static unsigned short normal_i2c[] = { /* 0x32,*/ I2C_CLIENT_END };

/* Insmod parameters */
I2C_CLIENT_INSMOD;

#define RS5C372_REG_SECS	0
#define RS5C372_REG_MINS	1
#define RS5C372_REG_HOURS	2
#define RS5C372_REG_WDAY	3
#define RS5C372_REG_DAY		4
#define RS5C372_REG_MONTH	5
#define RS5C372_REG_YEAR	6
#define RS5C372_REG_TRIM	7

#define RS5C372_TRIM_XSL	0x80
#define RS5C372_TRIM_MASK	0x7F

#define RS5C372_REG_BASE	0

static int rs5c372_attach(struct i2c_adapter *adapter);
static int rs5c372_detach(struct i2c_client *client);
static int rs5c372_probe(struct i2c_adapter *adapter, int address, int kind);

static struct i2c_driver rs5c372_driver = {
	.driver		= {
		.name	= "rs5c372",
	},
	.attach_adapter	= &rs5c372_attach,
	.detach_client	= &rs5c372_detach,
};

static int rs5c372_get_datetime(struct i2c_client *client, struct rtc_time *tm)
{
	unsigned char buf[7] = { RS5C372_REG_BASE };

	/* this implements the 1st reading method, according
	 * to the datasheet. buf[0] is initialized with
	 * address ptr and transmission format register.
	 */
	struct i2c_msg msgs[] = {
		{ client->addr, 0, 1, buf },
		{ client->addr, I2C_M_RD, 7, buf },
	};

	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
		dev_err(&client->dev, "%s: read error\n", __FUNCTION__);
		return -EIO;
	}

	tm->tm_sec = BCD2BIN(buf[RS5C372_REG_SECS] & 0x7f);
	tm->tm_min = BCD2BIN(buf[RS5C372_REG_MINS] & 0x7f);
	tm->tm_hour = BCD2BIN(buf[RS5C372_REG_HOURS] & 0x3f);
	tm->tm_wday = BCD2BIN(buf[RS5C372_REG_WDAY] & 0x07);
	tm->tm_mday = BCD2BIN(buf[RS5C372_REG_DAY] & 0x3f);

	/* tm->tm_mon is zero-based */
	tm->tm_mon = BCD2BIN(buf[RS5C372_REG_MONTH] & 0x1f) - 1;

	/* year is 1900 + tm->tm_year */
	tm->tm_year = BCD2BIN(buf[RS5C372_REG_YEAR]) + 100;

	dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
		"mday=%d, mon=%d, year=%d, wday=%d\n",
		__FUNCTION__,
		tm->tm_sec, tm->tm_min, tm->tm_hour,
		tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);

	return 0;
}

static int rs5c372_set_datetime(struct i2c_client *client, struct rtc_time *tm)
{
	unsigned char buf[8] = { RS5C372_REG_BASE };

	dev_dbg(&client->dev,
		"%s: secs=%d, mins=%d, hours=%d "
		"mday=%d, mon=%d, year=%d, wday=%d\n",
		__FUNCTION__, tm->tm_sec, tm->tm_min, tm->tm_hour,
		tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);

	buf[1] = BIN2BCD(tm->tm_sec);
	buf[2] = BIN2BCD(tm->tm_min);
	buf[3] = BIN2BCD(tm->tm_hour);
	buf[4] = BIN2BCD(tm->tm_wday);
	buf[5] = BIN2BCD(tm->tm_mday);
	buf[6] = BIN2BCD(tm->tm_mon + 1);
	buf[7] = BIN2BCD(tm->tm_year - 100);

	if ((i2c_master_send(client, buf, 8)) != 8) {
		dev_err(&client->dev, "%s: write error\n", __FUNCTION__);
		return -EIO;
	}

	return 0;
}

static int rs5c372_get_trim(struct i2c_client *client, int *osc, int *trim)
{
	unsigned char buf = RS5C372_REG_TRIM;

	struct i2c_msg msgs[] = {
		{ client->addr, 0, 1, &buf },
		{ client->addr, I2C_M_RD, 1, &buf },
	};

	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
		dev_err(&client->dev, "%s: read error\n", __FUNCTION__);
		return -EIO;
	}

	if (osc)
		*osc = (buf & RS5C372_TRIM_XSL) ? 32000 : 32768;

	if (trim) {
		*trim = buf & RS5C372_TRIM_MASK;
		dev_dbg(&client->dev, "%s: raw trim=%x\n", __FUNCTION__, *trim);
	}

	return 0;
}

static int rs5c372_rtc_read_time(struct device *dev, struct rtc_time *tm)
{
	return rs5c372_get_datetime(to_i2c_client(dev), tm);
}

static int rs5c372_rtc_set_time(struct device *dev, struct rtc_time *tm)
{
	return rs5c372_set_datetime(to_i2c_client(dev), tm);
}

static int rs5c372_rtc_proc(struct device *dev, struct seq_file *seq)
{
	int err, osc, trim;

	err = rs5c372_get_trim(to_i2c_client(dev), &osc, &trim);
	if (err == 0) {
		seq_printf(seq, "%d.%03d KHz\n", osc / 1000, osc % 1000);
		seq_printf(seq, "trim\t: %d\n", trim);
	}

	return 0;
}

static const struct rtc_class_ops rs5c372_rtc_ops = {
	.proc		= rs5c372_rtc_proc,
	.read_time	= rs5c372_rtc_read_time,
	.set_time	= rs5c372_rtc_set_time,
};

static ssize_t rs5c372_sysfs_show_trim(struct device *dev,
				struct device_attribute *attr, char *buf)
{
	int err, trim;

	err = rs5c372_get_trim(to_i2c_client(dev), NULL, &trim);
	if (err)
		return err;

	return sprintf(buf, "0x%2x\n", trim);
}
static DEVICE_ATTR(trim, S_IRUGO, rs5c372_sysfs_show_trim, NULL);

static ssize_t rs5c372_sysfs_show_osc(struct device *dev,
				struct device_attribute *attr, char *buf)
{
	int err, osc;

	err = rs5c372_get_trim(to_i2c_client(dev), &osc, NULL);
	if (err)
		return err;

	return sprintf(buf, "%d.%03d KHz\n", osc / 1000, osc % 1000);
}
static DEVICE_ATTR(osc, S_IRUGO, rs5c372_sysfs_show_osc, NULL);

static int rs5c372_attach(struct i2c_adapter *adapter)
{
	return i2c_probe(adapter, &addr_data, rs5c372_probe);
}

static int rs5c372_probe(struct i2c_adapter *adapter, int address, int kind)
{
	int err = 0;
	struct i2c_client *client;
	struct rtc_device *rtc;

	dev_dbg(&adapter->dev, "%s\n", __FUNCTION__);

	if (!i2c_check_functionality(adapter, I2C_FUNC_I2C)) {
		err = -ENODEV;
		goto exit;
	}

	if (!(client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL))) {
		err = -ENOMEM;
		goto exit;
	}

	/* I2C client */
	client->addr = address;
	client->driver = &rs5c372_driver;
	client->adapter = adapter;

	strlcpy(client->name, rs5c372_driver.driver.name, I2C_NAME_SIZE);

	/* Inform the i2c layer */
	if ((err = i2c_attach_client(client)))
		goto exit_kfree;

	dev_info(&client->dev, "chip found, driver version " DRV_VERSION "\n");

	rtc = rtc_device_register(rs5c372_driver.driver.name, &client->dev,
				&rs5c372_rtc_ops, THIS_MODULE);

	if (IS_ERR(rtc)) {
		err = PTR_ERR(rtc);
		goto exit_detach;
	}

	i2c_set_clientdata(client, rtc);

	err = device_create_file(&client->dev, &dev_attr_trim);
	if (err) goto exit_devreg;
	err = device_create_file(&client->dev, &dev_attr_osc);
	if (err) goto exit_trim;

	return 0;

exit_trim:
	device_remove_file(&client->dev, &dev_attr_trim);

exit_devreg:
	rtc_device_unregister(rtc);

exit_detach:
	i2c_detach_client(client);

exit_kfree:
	kfree(client);

exit:
	return err;
}

static int rs5c372_detach(struct i2c_client *client)
{
	int err;
	struct rtc_device *rtc = i2c_get_clientdata(client);

	if (rtc)
		rtc_device_unregister(rtc);

	if ((err = i2c_detach_client(client)))
		return err;

	kfree(client);

	return 0;
}

static __init int rs5c372_init(void)
{
	return i2c_add_driver(&rs5c372_driver);
}

static __exit void rs5c372_exit(void)
{
	i2c_del_driver(&rs5c372_driver);
}

module_init(rs5c372_init);
module_exit(rs5c372_exit);

MODULE_AUTHOR(
		"Pavel Mironchik <pmironchik@optifacio.net>, "
		"Alessandro Zummo <a.zummo@towertech.it>");
MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
7520b94d AZ	1	/*
	2	* An I2C driver for the Ricoh RS5C372 RTC
	3	*
	4	* Copyright (C) 2005 Pavel Mironchik <pmironchik@optifacio.net>
	5	* Copyright (C) 2006 Tower Technologies
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11
	12	#include <linux/i2c.h>
	13	#include <linux/rtc.h>
	14	#include <linux/bcd.h>
	15
	16	#define DRV_VERSION "0.2"
	17
	18	/* Addresses to scan */
	19	static unsigned short normal_i2c[] = { /* 0x32,*/ I2C_CLIENT_END };
	20
	21	/* Insmod parameters */
	22	I2C_CLIENT_INSMOD;
	23
	24	#define RS5C372_REG_SECS 0
	25	#define RS5C372_REG_MINS 1
	26	#define RS5C372_REG_HOURS 2
	27	#define RS5C372_REG_WDAY 3
	28	#define RS5C372_REG_DAY 4
	29	#define RS5C372_REG_MONTH 5
	30	#define RS5C372_REG_YEAR 6
	31	#define RS5C372_REG_TRIM 7
	32
	33	#define RS5C372_TRIM_XSL 0x80
	34	#define RS5C372_TRIM_MASK 0x7F
	35
	36	#define RS5C372_REG_BASE 0
	37
	38	static int rs5c372_attach(struct i2c_adapter *adapter);
	39	static int rs5c372_detach(struct i2c_client *client);
	40	static int rs5c372_probe(struct i2c_adapter *adapter, int address, int kind);
	41
	42	static struct i2c_driver rs5c372_driver = {
	43	.driver = {
	44	.name = "rs5c372",
	45	},
	46	.attach_adapter = &rs5c372_attach,
	47	.detach_client = &rs5c372_detach,
	48	};
	49
	50	static int rs5c372_get_datetime(struct i2c_client client, struct rtc_time tm)
	51	{
	52	unsigned char buf[7] = { RS5C372_REG_BASE };
	53
	54	/* this implements the 1st reading method, according
	55	* to the datasheet. buf[0] is initialized with
	56	* address ptr and transmission format register.
	57	*/
	58	struct i2c_msg msgs[] = {
	59	{ client->addr, 0, 1, buf },
	60	{ client->addr, I2C_M_RD, 7, buf },
	61	};
	62
	63	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
	64	dev_err(&client->dev, "%s: read error\n", __FUNCTION__);
65	return -EIO;
66	}
67
68	tm->tm_sec = BCD2BIN(buf[RS5C372_REG_SECS] & 0x7f);
69	tm->tm_min = BCD2BIN(buf[RS5C372_REG_MINS] & 0x7f);
70	tm->tm_hour = BCD2BIN(buf[RS5C372_REG_HOURS] & 0x3f);
71	tm->tm_wday = BCD2BIN(buf[RS5C372_REG_WDAY] & 0x07);
72	tm->tm_mday = BCD2BIN(buf[RS5C372_REG_DAY] & 0x3f);
73
74	/* tm->tm_mon is zero-based */
75	tm->tm_mon = BCD2BIN(buf[RS5C372_REG_MONTH] & 0x1f) - 1;
76
77	/* year is 1900 + tm->tm_year */
78	tm->tm_year = BCD2BIN(buf[RS5C372_REG_YEAR]) + 100;
79
80	dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
81	"mday=%d, mon=%d, year=%d, wday=%d\n",
82	__FUNCTION__,
83	tm->tm_sec, tm->tm_min, tm->tm_hour,
84	tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
85
86	return 0;
87	}
88
89	static int rs5c372_set_datetime(struct i2c_client client, struct rtc_time tm)
90	{
91	unsigned char buf[8] = { RS5C372_REG_BASE };
92
93	dev_dbg(&client->dev,
11966adc	94	"%s: secs=%d, mins=%d, hours=%d "
7520b94d AZ	95	"mday=%d, mon=%d, year=%d, wday=%d\n",
	96	__FUNCTION__, tm->tm_sec, tm->tm_min, tm->tm_hour,
	97	tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
	98
	99	buf[1] = BIN2BCD(tm->tm_sec);
	100	buf[2] = BIN2BCD(tm->tm_min);
	101	buf[3] = BIN2BCD(tm->tm_hour);
	102	buf[4] = BIN2BCD(tm->tm_wday);
	103	buf[5] = BIN2BCD(tm->tm_mday);
	104	buf[6] = BIN2BCD(tm->tm_mon + 1);
	105	buf[7] = BIN2BCD(tm->tm_year - 100);
	106
	107	if ((i2c_master_send(client, buf, 8)) != 8) {
	108	dev_err(&client->dev, "%s: write error\n", __FUNCTION__);
	109	return -EIO;
	110	}
	111
	112	return 0;
	113	}
	114
	115	static int rs5c372_get_trim(struct i2c_client client, int osc, int *trim)
	116	{
	117	unsigned char buf = RS5C372_REG_TRIM;
	118
	119	struct i2c_msg msgs[] = {
	120	{ client->addr, 0, 1, &buf },
	121	{ client->addr, I2C_M_RD, 1, &buf },
	122	};
	123
	124	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
	125	dev_err(&client->dev, "%s: read error\n", __FUNCTION__);
	126	return -EIO;
	127	}
	128
7520b94d AZ	129	if (osc)
	130	*osc = (buf & RS5C372_TRIM_XSL) ? 32000 : 32768;
	131
17ad78e5	132	if (trim) {
7520b94d	133	*trim = buf & RS5C372_TRIM_MASK;
17ad78e5 AB	134	dev_dbg(&client->dev, "%s: raw trim=%x\n", __FUNCTION__, *trim);
17ad78e5 AB	135	}
7520b94d AZ	136
	137	return 0;
	138	}
	139
	140	static int rs5c372_rtc_read_time(struct device dev, struct rtc_time tm)
	141	{
	142	return rs5c372_get_datetime(to_i2c_client(dev), tm);
	143	}
	144
	145	static int rs5c372_rtc_set_time(struct device dev, struct rtc_time tm)
	146	{
	147	return rs5c372_set_datetime(to_i2c_client(dev), tm);
	148	}
	149
	150	static int rs5c372_rtc_proc(struct device dev, struct seq_file seq)
	151	{
	152	int err, osc, trim;
	153
adfb4341 AZ	154	err = rs5c372_get_trim(to_i2c_client(dev), &osc, &trim);
adfb4341 AZ	155	if (err == 0) {
7520b94d AZ	156	seq_printf(seq, "%d.%03d KHz\n", osc / 1000, osc % 1000);
	157	seq_printf(seq, "trim\t: %d\n", trim);
	158	}
	159
	160	return 0;
	161	}
	162
ff8371ac	163	static const struct rtc_class_ops rs5c372_rtc_ops = {
7520b94d AZ	164	.proc = rs5c372_rtc_proc,
	165	.read_time = rs5c372_rtc_read_time,
	166	.set_time = rs5c372_rtc_set_time,
	167	};
	168
	169	static ssize_t rs5c372_sysfs_show_trim(struct device *dev,
	170	struct device_attribute attr, char buf)
	171	{
82896072	172	int err, trim;
7520b94d	173
82896072 AZ	174	err = rs5c372_get_trim(to_i2c_client(dev), NULL, &trim);
	175	if (err)
	176	return err;
7520b94d	177
82896072	178	return sprintf(buf, "0x%2x\n", trim);
7520b94d AZ	179	}
	180	static DEVICE_ATTR(trim, S_IRUGO, rs5c372_sysfs_show_trim, NULL);
	181
	182	static ssize_t rs5c372_sysfs_show_osc(struct device *dev,
	183	struct device_attribute attr, char buf)
	184	{
82896072	185	int err, osc;
7520b94d	186
82896072 AZ	187	err = rs5c372_get_trim(to_i2c_client(dev), &osc, NULL);
	188	if (err)
	189	return err;
7520b94d	190
82896072	191	return sprintf(buf, "%d.%03d KHz\n", osc / 1000, osc % 1000);
7520b94d AZ	192	}
	193	static DEVICE_ATTR(osc, S_IRUGO, rs5c372_sysfs_show_osc, NULL);
	194
	195	static int rs5c372_attach(struct i2c_adapter *adapter)
	196	{
7520b94d AZ	197	return i2c_probe(adapter, &addr_data, rs5c372_probe);
	198	}
	199
	200	static int rs5c372_probe(struct i2c_adapter *adapter, int address, int kind)
	201	{
	202	int err = 0;
	203	struct i2c_client *client;
	204	struct rtc_device *rtc;
	205
	206	dev_dbg(&adapter->dev, "%s\n", __FUNCTION__);
	207
	208	if (!i2c_check_functionality(adapter, I2C_FUNC_I2C)) {
	209	err = -ENODEV;
	210	goto exit;
	211	}
	212
	213	if (!(client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL))) {
	214	err = -ENOMEM;
	215	goto exit;
	216	}
	217
	218	/* I2C client */
	219	client->addr = address;
	220	client->driver = &rs5c372_driver;
	221	client->adapter = adapter;
	222
	223	strlcpy(client->name, rs5c372_driver.driver.name, I2C_NAME_SIZE);
	224
	225	/* Inform the i2c layer */
	226	if ((err = i2c_attach_client(client)))
	227	goto exit_kfree;
	228
	229	dev_info(&client->dev, "chip found, driver version " DRV_VERSION "\n");
	230
	231	rtc = rtc_device_register(rs5c372_driver.driver.name, &client->dev,
	232	&rs5c372_rtc_ops, THIS_MODULE);
	233
	234	if (IS_ERR(rtc)) {
	235	err = PTR_ERR(rtc);
7520b94d AZ	236	goto exit_detach;
	237	}
	238
	239	i2c_set_clientdata(client, rtc);
	240
91046a8a JG	241	err = device_create_file(&client->dev, &dev_attr_trim);
	242	if (err) goto exit_devreg;
	243	err = device_create_file(&client->dev, &dev_attr_osc);
	244	if (err) goto exit_trim;
7520b94d AZ	245
	246	return 0;
	247
91046a8a JG	248	exit_trim:
	249	device_remove_file(&client->dev, &dev_attr_trim);
	250
	251	exit_devreg:
	252	rtc_device_unregister(rtc);
	253
7520b94d AZ	254	exit_detach:
	255	i2c_detach_client(client);
	256
	257	exit_kfree:
	258	kfree(client);
	259
	260	exit:
	261	return err;
	262	}
	263
	264	static int rs5c372_detach(struct i2c_client *client)
	265	{
	266	int err;
	267	struct rtc_device *rtc = i2c_get_clientdata(client);
	268
7520b94d AZ	269	if (rtc)
	270	rtc_device_unregister(rtc);
	271
	272	if ((err = i2c_detach_client(client)))
	273	return err;
	274
	275	kfree(client);
	276
	277	return 0;
	278	}
	279
	280	static __init int rs5c372_init(void)
	281	{
	282	return i2c_add_driver(&rs5c372_driver);
	283	}
	284
	285	static __exit void rs5c372_exit(void)
	286	{
	287	i2c_del_driver(&rs5c372_driver);
	288	}
	289
	290	module_init(rs5c372_init);
	291	module_exit(rs5c372_exit);
	292
	293	MODULE_AUTHOR(
	294	"Pavel Mironchik <pmironchik@optifacio.net>, "
	295	"Alessandro Zummo <a.zummo@towertech.it>");
	296	MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
	297	MODULE_LICENSE("GPL");
	298	MODULE_VERSION(DRV_VERSION);