[linux-2.6-block.git] / drivers / rtc / rtc-ds3232.c

/*
 * RTC client/driver for the Maxim/Dallas DS3232/DS3234 Real-Time Clock
 *
 * Copyright (C) 2009-2011 Freescale Semiconductor.
 * Author: Jack Lan <jack.lan@freescale.com>
 * Copyright (C) 2008 MIMOMax Wireless Ltd.
 *
 * 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.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/interrupt.h>
#include <linux/i2c.h>
#include <linux/spi/spi.h>
#include <linux/rtc.h>
#include <linux/bcd.h>
#include <linux/slab.h>
#include <linux/regmap.h>

#define DS3232_REG_SECONDS	0x00
#define DS3232_REG_MINUTES	0x01
#define DS3232_REG_HOURS	0x02
#define DS3232_REG_AMPM		0x02
#define DS3232_REG_DAY		0x03
#define DS3232_REG_DATE		0x04
#define DS3232_REG_MONTH	0x05
#define DS3232_REG_CENTURY	0x05
#define DS3232_REG_YEAR		0x06
#define DS3232_REG_ALARM1         0x07	/* Alarm 1 BASE */
#define DS3232_REG_ALARM2         0x0B	/* Alarm 2 BASE */
#define DS3232_REG_CR		0x0E	/* Control register */
#	define DS3232_REG_CR_nEOSC        0x80
#       define DS3232_REG_CR_INTCN        0x04
#       define DS3232_REG_CR_A2IE        0x02
#       define DS3232_REG_CR_A1IE        0x01

#define DS3232_REG_SR	0x0F	/* control/status register */
#	define DS3232_REG_SR_OSF   0x80
#       define DS3232_REG_SR_BSY   0x04
#       define DS3232_REG_SR_A2F   0x02
#       define DS3232_REG_SR_A1F   0x01

struct ds3232 {
	struct device *dev;
	struct regmap *regmap;
	int irq;
	struct rtc_device *rtc;

	bool suspended;
};

static int ds3232_check_rtc_status(struct device *dev)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	int ret = 0;
	int control, stat;

	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
	if (ret)
		return ret;

	if (stat & DS3232_REG_SR_OSF)
		dev_warn(dev,
				"oscillator discontinuity flagged, "
				"time unreliable\n");

	stat &= ~(DS3232_REG_SR_OSF | DS3232_REG_SR_A1F | DS3232_REG_SR_A2F);

	ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
	if (ret)
		return ret;

	/* If the alarm is pending, clear it before requesting
	 * the interrupt, so an interrupt event isn't reported
	 * before everything is initialized.
	 */

	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
	if (ret)
		return ret;

	control &= ~(DS3232_REG_CR_A1IE | DS3232_REG_CR_A2IE);
	control |= DS3232_REG_CR_INTCN;

	return regmap_write(ds3232->regmap, DS3232_REG_CR, control);
}

static int ds3232_read_time(struct device *dev, struct rtc_time *time)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	int ret;
	u8 buf[7];
	unsigned int year, month, day, hour, minute, second;
	unsigned int week, twelve_hr, am_pm;
	unsigned int century, add_century = 0;

	ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_SECONDS, buf, 7);
	if (ret)
		return ret;

	second = buf[0];
	minute = buf[1];
	hour = buf[2];
	week = buf[3];
	day = buf[4];
	month = buf[5];
	year = buf[6];

	/* Extract additional information for AM/PM and century */

	twelve_hr = hour & 0x40;
	am_pm = hour & 0x20;
	century = month & 0x80;

	/* Write to rtc_time structure */

	time->tm_sec = bcd2bin(second);
	time->tm_min = bcd2bin(minute);
	if (twelve_hr) {
		/* Convert to 24 hr */
		if (am_pm)
			time->tm_hour = bcd2bin(hour & 0x1F) + 12;
		else
			time->tm_hour = bcd2bin(hour & 0x1F);
	} else {
		time->tm_hour = bcd2bin(hour);
	}

	/* Day of the week in linux range is 0~6 while 1~7 in RTC chip */
	time->tm_wday = bcd2bin(week) - 1;
	time->tm_mday = bcd2bin(day);
	/* linux tm_mon range:0~11, while month range is 1~12 in RTC chip */
	time->tm_mon = bcd2bin(month & 0x7F) - 1;
	if (century)
		add_century = 100;

	time->tm_year = bcd2bin(year) + add_century;

	return rtc_valid_tm(time);
}

static int ds3232_set_time(struct device *dev, struct rtc_time *time)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	u8 buf[7];

	/* Extract time from rtc_time and load into ds3232*/

	buf[0] = bin2bcd(time->tm_sec);
	buf[1] = bin2bcd(time->tm_min);
	buf[2] = bin2bcd(time->tm_hour);
	/* Day of the week in linux range is 0~6 while 1~7 in RTC chip */
	buf[3] = bin2bcd(time->tm_wday + 1);
	buf[4] = bin2bcd(time->tm_mday); /* Date */
	/* linux tm_mon range:0~11, while month range is 1~12 in RTC chip */
	buf[5] = bin2bcd(time->tm_mon + 1);
	if (time->tm_year >= 100) {
		buf[5] |= 0x80;
		buf[6] = bin2bcd(time->tm_year - 100);
	} else {
		buf[6] = bin2bcd(time->tm_year);
	}

	return regmap_bulk_write(ds3232->regmap, DS3232_REG_SECONDS, buf, 7);
}

/*
 * DS3232 has two alarm, we only use alarm1
 * According to linux specification, only support one-shot alarm
 * no periodic alarm mode
 */
static int ds3232_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	int control, stat;
	int ret;
	u8 buf[4];

	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
	if (ret)
		goto out;
	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
	if (ret)
		goto out;
	ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_ALARM1, buf, 4);
	if (ret)
		goto out;

	alarm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
	alarm->time.tm_min = bcd2bin(buf[1] & 0x7F);
	alarm->time.tm_hour = bcd2bin(buf[2] & 0x7F);
	alarm->time.tm_mday = bcd2bin(buf[3] & 0x7F);

	alarm->enabled = !!(control & DS3232_REG_CR_A1IE);
	alarm->pending = !!(stat & DS3232_REG_SR_A1F);

	ret = 0;
out:
	return ret;
}

/*
 * linux rtc-module does not support wday alarm
 * and only 24h time mode supported indeed
 */
static int ds3232_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	int control, stat;
	int ret;
	u8 buf[4];

	if (ds3232->irq <= 0)
		return -EINVAL;

	buf[0] = bin2bcd(alarm->time.tm_sec);
	buf[1] = bin2bcd(alarm->time.tm_min);
	buf[2] = bin2bcd(alarm->time.tm_hour);
	buf[3] = bin2bcd(alarm->time.tm_mday);

	/* clear alarm interrupt enable bit */
	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
	if (ret)
		goto out;
	control &= ~(DS3232_REG_CR_A1IE | DS3232_REG_CR_A2IE);
	ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
	if (ret)
		goto out;

	/* clear any pending alarm flag */
	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
	if (ret)
		goto out;
	stat &= ~(DS3232_REG_SR_A1F | DS3232_REG_SR_A2F);
	ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
	if (ret)
		goto out;

	ret = regmap_bulk_write(ds3232->regmap, DS3232_REG_ALARM1, buf, 4);
	if (ret)
		goto out;

	if (alarm->enabled) {
		control |= DS3232_REG_CR_A1IE;
		ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
	}
out:
	return ret;
}

static int ds3232_update_alarm(struct device *dev, unsigned int enabled)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	int control;
	int ret;

	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
	if (ret)
		return ret;

	if (enabled)
		/* enable alarm1 interrupt */
		control |= DS3232_REG_CR_A1IE;
	else
		/* disable alarm1 interrupt */
		control &= ~(DS3232_REG_CR_A1IE);
	ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);

	return ret;
}

static int ds3232_alarm_irq_enable(struct device *dev, unsigned int enabled)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);

	if (ds3232->irq <= 0)
		return -EINVAL;

	return ds3232_update_alarm(dev, enabled);
}

static irqreturn_t ds3232_irq(int irq, void *dev_id)
{
	struct device *dev = dev_id;
	struct ds3232 *ds3232 = dev_get_drvdata(dev);
	struct mutex *lock = &ds3232->rtc->ops_lock;
	int ret;
	int stat, control;

	mutex_lock(lock);

	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
	if (ret)
		goto unlock;

	if (stat & DS3232_REG_SR_A1F) {
		ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
		if (ret) {
			dev_warn(ds3232->dev,
				 "Read Control Register error %d\n", ret);
		} else {
			/* disable alarm1 interrupt */
			control &= ~(DS3232_REG_CR_A1IE);
			ret = regmap_write(ds3232->regmap, DS3232_REG_CR,
					   control);
			if (ret) {
				dev_warn(ds3232->dev,
					 "Write Control Register error %d\n",
					 ret);
				goto unlock;
			}

			/* clear the alarm pend flag */
			stat &= ~DS3232_REG_SR_A1F;
			ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
			if (ret) {
				dev_warn(ds3232->dev,
					 "Write Status Register error %d\n",
					 ret);
				goto unlock;
			}

			rtc_update_irq(ds3232->rtc, 1, RTC_AF | RTC_IRQF);
		}
	}

unlock:
	mutex_unlock(lock);

	return IRQ_HANDLED;
}

static const struct rtc_class_ops ds3232_rtc_ops = {
	.read_time = ds3232_read_time,
	.set_time = ds3232_set_time,
	.read_alarm = ds3232_read_alarm,
	.set_alarm = ds3232_set_alarm,
	.alarm_irq_enable = ds3232_alarm_irq_enable,
};

static int ds3232_probe(struct device *dev, struct regmap *regmap, int irq,
			const char *name)
{
	struct ds3232 *ds3232;
	int ret;

	ds3232 = devm_kzalloc(dev, sizeof(*ds3232), GFP_KERNEL);
	if (!ds3232)
		return -ENOMEM;

	ds3232->regmap = regmap;
	ds3232->irq = irq;
	ds3232->dev = dev;
	dev_set_drvdata(dev, ds3232);

	ret = ds3232_check_rtc_status(dev);
	if (ret)
		return ret;

	ds3232->rtc = devm_rtc_device_register(dev, name, &ds3232_rtc_ops,
						THIS_MODULE);
	if (IS_ERR(ds3232->rtc))
		return PTR_ERR(ds3232->rtc);

	if (ds3232->irq > 0) {
		ret = devm_request_threaded_irq(dev, ds3232->irq, NULL,
						ds3232_irq,
						IRQF_SHARED | IRQF_ONESHOT,
						name, dev);
		if (ret) {
			ds3232->irq = 0;
			dev_err(dev, "unable to request IRQ\n");
		} else
			device_init_wakeup(dev, 1);
	}

	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int ds3232_suspend(struct device *dev)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);

	if (device_may_wakeup(dev)) {
		if (enable_irq_wake(ds3232->irq))
			dev_warn_once(dev, "Cannot set wakeup source\n");
	}

	return 0;
}

static int ds3232_resume(struct device *dev)
{
	struct ds3232 *ds3232 = dev_get_drvdata(dev);

	if (device_may_wakeup(dev))
		disable_irq_wake(ds3232->irq);

	return 0;
}
#endif

static const struct dev_pm_ops ds3232_pm_ops = {
	SET_SYSTEM_SLEEP_PM_OPS(ds3232_suspend, ds3232_resume)
};

#if IS_ENABLED(CONFIG_I2C)

static int ds3232_i2c_probe(struct i2c_client *client,
			    const struct i2c_device_id *id)
{
	struct regmap *regmap;
	static const struct regmap_config config = {
		.reg_bits = 8,
		.val_bits = 8,
	};

	regmap = devm_regmap_init_i2c(client, &config);
	if (IS_ERR(regmap)) {
		dev_err(&client->dev, "%s: regmap allocation failed: %ld\n",
			__func__, PTR_ERR(regmap));
		return PTR_ERR(regmap);
	}

	return ds3232_probe(&client->dev, regmap, client->irq, client->name);
}

static const struct i2c_device_id ds3232_id[] = {
	{ "ds3232", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, ds3232_id);

static struct i2c_driver ds3232_driver = {
	.driver = {
		.name = "rtc-ds3232",
		.pm	= &ds3232_pm_ops,
	},
	.probe = ds3232_i2c_probe,
	.id_table = ds3232_id,
};

static int ds3232_register_driver(void)
{
	return i2c_add_driver(&ds3232_driver);
}

static void ds3232_unregister_driver(void)
{
	i2c_del_driver(&ds3232_driver);
}

#else

static int ds3232_register_driver(void)
{
	return 0;
}

static void ds3232_unregister_driver(void)
{
}

#endif

#if IS_ENABLED(CONFIG_SPI_MASTER)

static int ds3234_probe(struct spi_device *spi)
{
	int res;
	unsigned int tmp;
	static const struct regmap_config config = {
		.reg_bits = 8,
		.val_bits = 8,
		.write_flag_mask = 0x80,
	};
	struct regmap *regmap;

	regmap = devm_regmap_init_spi(spi, &config);
	if (IS_ERR(regmap)) {
		dev_err(&spi->dev, "%s: regmap allocation failed: %ld\n",
			__func__, PTR_ERR(regmap));
		return PTR_ERR(regmap);
	}

	spi->mode = SPI_MODE_3;
	spi->bits_per_word = 8;
	spi_setup(spi);

	res = regmap_read(regmap, DS3232_REG_SECONDS, &tmp);
	if (res)
		return res;

	/* Control settings
	 *
	 * CONTROL_REG
	 * BIT 7	6	5	4	3	2	1	0
	 *     EOSC	BBSQW	CONV	RS2	RS1	INTCN	A2IE	A1IE
	 *
	 *     0	0	0	1	1	1	0	0
	 *
	 * CONTROL_STAT_REG
	 * BIT 7	6	5	4	3	2	1	0
	 *     OSF	BB32kHz	CRATE1	CRATE0	EN32kHz	BSY	A2F	A1F
	 *
	 *     1	0	0	0	1	0	0	0
	 */
	res = regmap_read(regmap, DS3232_REG_CR, &tmp);
	if (res)
		return res;
	res = regmap_write(regmap, DS3232_REG_CR, tmp & 0x1c);
	if (res)
		return res;

	res = regmap_read(regmap, DS3232_REG_SR, &tmp);
	if (res)
		return res;
	res = regmap_write(regmap, DS3232_REG_SR, tmp & 0x88);
	if (res)
		return res;

	/* Print our settings */
	res = regmap_read(regmap, DS3232_REG_CR, &tmp);
	if (res)
		return res;
	dev_info(&spi->dev, "Control Reg: 0x%02x\n", tmp);

	res = regmap_read(regmap, DS3232_REG_SR, &tmp);
	if (res)
		return res;
	dev_info(&spi->dev, "Ctrl/Stat Reg: 0x%02x\n", tmp);

	return ds3232_probe(&spi->dev, regmap, spi->irq, "ds3234");
}

static struct spi_driver ds3234_driver = {
	.driver = {
		.name	 = "ds3234",
	},
	.probe	 = ds3234_probe,
};

static int ds3234_register_driver(void)
{
	return spi_register_driver(&ds3234_driver);
}

static void ds3234_unregister_driver(void)
{
	spi_unregister_driver(&ds3234_driver);
}

#else

static int ds3234_register_driver(void)
{
	return 0;
}

static void ds3234_unregister_driver(void)
{
}

#endif

static int __init ds323x_init(void)
{
	int ret;

	ret = ds3232_register_driver();
	if (ret) {
		pr_err("Failed to register ds3232 driver: %d\n", ret);
		return ret;
	}

	ret = ds3234_register_driver();
	if (ret) {
		pr_err("Failed to register ds3234 driver: %d\n", ret);
		ds3232_unregister_driver();
	}

	return ret;
}
module_init(ds323x_init)

static void __exit ds323x_exit(void)
{
	ds3234_unregister_driver();
	ds3232_unregister_driver();
}
module_exit(ds323x_exit)

MODULE_AUTHOR("Srikanth Srinivasan <srikanth.srinivasan@freescale.com>");
MODULE_AUTHOR("Dennis Aberilla <denzzzhome@yahoo.com>");
MODULE_DESCRIPTION("Maxim/Dallas DS3232/DS3234 RTC Driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("spi:ds3234");
Commit	Line	Data
c03675f0	1	/*
080481f5	2	* RTC client/driver for the Maxim/Dallas DS3232/DS3234 Real-Time Clock
c03675f0	3	*
a2d6d2fa	4	* Copyright (C) 2009-2011 Freescale Semiconductor.
f46418c5	5	* Author: Jack Lan <jack.lan@freescale.com>
080481f5	6	* Copyright (C) 2008 MIMOMax Wireless Ltd.
c03675f0 RZ	7	*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2 of the License, or (at your
	11	* option) any later version.
	12	*/
c03675f0	13
a737e835 JP	14	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
a737e835 JP	15
c03675f0 RZ	16	#include <linux/kernel.h>
	17	#include <linux/module.h>
	18	#include <linux/interrupt.h>
	19	#include <linux/i2c.h>
080481f5	20	#include <linux/spi/spi.h>
c03675f0 RZ	21	#include <linux/rtc.h>
c03675f0 RZ	22	#include <linux/bcd.h>
c03675f0	23	#include <linux/slab.h>
370927c4	24	#include <linux/regmap.h>
c03675f0 RZ	25
	26	#define DS3232_REG_SECONDS 0x00
	27	#define DS3232_REG_MINUTES 0x01
	28	#define DS3232_REG_HOURS 0x02
	29	#define DS3232_REG_AMPM 0x02
	30	#define DS3232_REG_DAY 0x03
	31	#define DS3232_REG_DATE 0x04
	32	#define DS3232_REG_MONTH 0x05
	33	#define DS3232_REG_CENTURY 0x05
	34	#define DS3232_REG_YEAR 0x06
	35	#define DS3232_REG_ALARM1 0x07 /* Alarm 1 BASE */
	36	#define DS3232_REG_ALARM2 0x0B /* Alarm 2 BASE */
	37	#define DS3232_REG_CR 0x0E /* Control register */
	38	# define DS3232_REG_CR_nEOSC 0x80
	39	# define DS3232_REG_CR_INTCN 0x04
	40	# define DS3232_REG_CR_A2IE 0x02
	41	# define DS3232_REG_CR_A1IE 0x01
	42
	43	#define DS3232_REG_SR 0x0F /* control/status register */
	44	# define DS3232_REG_SR_OSF 0x80
	45	# define DS3232_REG_SR_BSY 0x04
	46	# define DS3232_REG_SR_A2F 0x02
	47	# define DS3232_REG_SR_A1F 0x01
	48
	49	struct ds3232 {
370927c4 AM	50	struct device *dev;
	51	struct regmap *regmap;
	52	int irq;
c03675f0	53	struct rtc_device *rtc;
c03675f0	54
c93a3ae2	55	bool suspended;
c03675f0 RZ	56	};
c03675f0 RZ	57
370927c4	58	static int ds3232_check_rtc_status(struct device *dev)
c03675f0	59	{
370927c4	60	struct ds3232 *ds3232 = dev_get_drvdata(dev);
c03675f0 RZ	61	int ret = 0;
	62	int control, stat;
	63
370927c4 AM	64	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
	65	if (ret)
	66	return ret;
c03675f0 RZ	67
c03675f0 RZ	68	if (stat & DS3232_REG_SR_OSF)
370927c4	69	dev_warn(dev,
c03675f0 RZ	70	"oscillator discontinuity flagged, "
	71	"time unreliable\n");
	72
	73	stat &= ~(DS3232_REG_SR_OSF \| DS3232_REG_SR_A1F \| DS3232_REG_SR_A2F);
	74
370927c4 AM	75	ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
370927c4 AM	76	if (ret)
c03675f0 RZ	77	return ret;
	78
	79	/* If the alarm is pending, clear it before requesting
	80	* the interrupt, so an interrupt event isn't reported
	81	* before everything is initialized.
	82	*/
	83
370927c4 AM	84	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
	85	if (ret)
	86	return ret;
c03675f0 RZ	87
	88	control &= ~(DS3232_REG_CR_A1IE \| DS3232_REG_CR_A2IE);
	89	control \|= DS3232_REG_CR_INTCN;
	90
370927c4	91	return regmap_write(ds3232->regmap, DS3232_REG_CR, control);
c03675f0 RZ	92	}
	93
	94	static int ds3232_read_time(struct device dev, struct rtc_time time)
	95	{
370927c4	96	struct ds3232 *ds3232 = dev_get_drvdata(dev);
c03675f0 RZ	97	int ret;
	98	u8 buf[7];
	99	unsigned int year, month, day, hour, minute, second;
	100	unsigned int week, twelve_hr, am_pm;
	101	unsigned int century, add_century = 0;
	102
370927c4 AM	103	ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_SECONDS, buf, 7);
370927c4 AM	104	if (ret)
c03675f0	105	return ret;
c03675f0 RZ	106
	107	second = buf[0];
	108	minute = buf[1];
	109	hour = buf[2];
	110	week = buf[3];
	111	day = buf[4];
	112	month = buf[5];
	113	year = buf[6];
	114
	115	/* Extract additional information for AM/PM and century */
	116
	117	twelve_hr = hour & 0x40;
	118	am_pm = hour & 0x20;
	119	century = month & 0x80;
	120
	121	/* Write to rtc_time structure */
	122
	123	time->tm_sec = bcd2bin(second);
	124	time->tm_min = bcd2bin(minute);
	125	if (twelve_hr) {
	126	/* Convert to 24 hr */
	127	if (am_pm)
	128	time->tm_hour = bcd2bin(hour & 0x1F) + 12;
	129	else
	130	time->tm_hour = bcd2bin(hour & 0x1F);
	131	} else {
	132	time->tm_hour = bcd2bin(hour);
	133	}
	134
a2d6d2fa LX	135	/* Day of the week in linux range is 0~6 while 1~7 in RTC chip */
a2d6d2fa LX	136	time->tm_wday = bcd2bin(week) - 1;
c03675f0	137	time->tm_mday = bcd2bin(day);
a2d6d2fa LX	138	/* linux tm_mon range:0~11, while month range is 1~12 in RTC chip */
a2d6d2fa LX	139	time->tm_mon = bcd2bin(month & 0x7F) - 1;
c03675f0 RZ	140	if (century)
	141	add_century = 100;
	142
	143	time->tm_year = bcd2bin(year) + add_century;
	144
	145	return rtc_valid_tm(time);
	146	}
	147
	148	static int ds3232_set_time(struct device dev, struct rtc_time time)
	149	{
370927c4	150	struct ds3232 *ds3232 = dev_get_drvdata(dev);
c03675f0 RZ	151	u8 buf[7];
	152
	153	/* Extract time from rtc_time and load into ds3232*/
	154
	155	buf[0] = bin2bcd(time->tm_sec);
	156	buf[1] = bin2bcd(time->tm_min);
	157	buf[2] = bin2bcd(time->tm_hour);
a2d6d2fa LX	158	/* Day of the week in linux range is 0~6 while 1~7 in RTC chip */
a2d6d2fa LX	159	buf[3] = bin2bcd(time->tm_wday + 1);
c03675f0	160	buf[4] = bin2bcd(time->tm_mday); /* Date */
a2d6d2fa LX	161	/* linux tm_mon range:0~11, while month range is 1~12 in RTC chip */
a2d6d2fa LX	162	buf[5] = bin2bcd(time->tm_mon + 1);
c03675f0 RZ	163	if (time->tm_year >= 100) {
	164	buf[5] \|= 0x80;
	165	buf[6] = bin2bcd(time->tm_year - 100);
	166	} else {
	167	buf[6] = bin2bcd(time->tm_year);
	168	}
	169
370927c4	170	return regmap_bulk_write(ds3232->regmap, DS3232_REG_SECONDS, buf, 7);
c03675f0 RZ	171	}
c03675f0 RZ	172
f46418c5 LCB	173	/*
	174	* DS3232 has two alarm, we only use alarm1
	175	* According to linux specification, only support one-shot alarm
	176	* no periodic alarm mode
	177	*/
	178	static int ds3232_read_alarm(struct device dev, struct rtc_wkalrm alarm)
	179	{
370927c4	180	struct ds3232 *ds3232 = dev_get_drvdata(dev);
f46418c5 LCB	181	int control, stat;
	182	int ret;
	183	u8 buf[4];
	184
370927c4 AM	185	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
370927c4 AM	186	if (ret)
f46418c5	187	goto out;
370927c4 AM	188	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
370927c4 AM	189	if (ret)
f46418c5	190	goto out;
370927c4 AM	191	ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_ALARM1, buf, 4);
370927c4 AM	192	if (ret)
f46418c5 LCB	193	goto out;
	194
	195	alarm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
	196	alarm->time.tm_min = bcd2bin(buf[1] & 0x7F);
	197	alarm->time.tm_hour = bcd2bin(buf[2] & 0x7F);
	198	alarm->time.tm_mday = bcd2bin(buf[3] & 0x7F);
	199
f46418c5 LCB	200	alarm->enabled = !!(control & DS3232_REG_CR_A1IE);
	201	alarm->pending = !!(stat & DS3232_REG_SR_A1F);
	202
	203	ret = 0;
	204	out:
f46418c5 LCB	205	return ret;
	206	}
	207
	208	/*
	209	* linux rtc-module does not support wday alarm
	210	* and only 24h time mode supported indeed
	211	*/
	212	static int ds3232_set_alarm(struct device dev, struct rtc_wkalrm alarm)
	213	{
370927c4	214	struct ds3232 *ds3232 = dev_get_drvdata(dev);
f46418c5 LCB	215	int control, stat;
	216	int ret;
	217	u8 buf[4];
	218
370927c4	219	if (ds3232->irq <= 0)
f46418c5 LCB	220	return -EINVAL;
f46418c5 LCB	221
f46418c5 LCB	222	buf[0] = bin2bcd(alarm->time.tm_sec);
	223	buf[1] = bin2bcd(alarm->time.tm_min);
	224	buf[2] = bin2bcd(alarm->time.tm_hour);
	225	buf[3] = bin2bcd(alarm->time.tm_mday);
	226
	227	/* clear alarm interrupt enable bit */
370927c4 AM	228	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
370927c4 AM	229	if (ret)
f46418c5	230	goto out;
f46418c5	231	control &= ~(DS3232_REG_CR_A1IE \| DS3232_REG_CR_A2IE);
370927c4 AM	232	ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
370927c4 AM	233	if (ret)
f46418c5 LCB	234	goto out;
	235
	236	/* clear any pending alarm flag */
370927c4 AM	237	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
370927c4 AM	238	if (ret)
f46418c5	239	goto out;
f46418c5	240	stat &= ~(DS3232_REG_SR_A1F \| DS3232_REG_SR_A2F);
370927c4 AM	241	ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
370927c4 AM	242	if (ret)
f46418c5 LCB	243	goto out;
f46418c5 LCB	244
370927c4	245	ret = regmap_bulk_write(ds3232->regmap, DS3232_REG_ALARM1, buf, 4);
7b4393a6 AM	246	if (ret)
7b4393a6 AM	247	goto out;
f46418c5 LCB	248
	249	if (alarm->enabled) {
	250	control \|= DS3232_REG_CR_A1IE;
370927c4	251	ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
f46418c5 LCB	252	}
f46418c5 LCB	253	out:
f46418c5 LCB	254	return ret;
	255	}
	256
7b4393a6	257	static int ds3232_update_alarm(struct device *dev, unsigned int enabled)
f46418c5	258	{
370927c4	259	struct ds3232 *ds3232 = dev_get_drvdata(dev);
f46418c5 LCB	260	int control;
f46418c5 LCB	261	int ret;
f46418c5	262
370927c4 AM	263	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
370927c4 AM	264	if (ret)
fc1dcb0b	265	return ret;
f46418c5	266
7522297e	267	if (enabled)
f46418c5 LCB	268	/* enable alarm1 interrupt */
	269	control \|= DS3232_REG_CR_A1IE;
	270	else
	271	/* disable alarm1 interrupt */
	272	control &= ~(DS3232_REG_CR_A1IE);
7b4393a6	273	ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
f46418c5	274
7b4393a6	275	return ret;
f46418c5 LCB	276	}
	277
	278	static int ds3232_alarm_irq_enable(struct device *dev, unsigned int enabled)
	279	{
370927c4	280	struct ds3232 *ds3232 = dev_get_drvdata(dev);
f46418c5	281
370927c4	282	if (ds3232->irq <= 0)
f46418c5 LCB	283	return -EINVAL;
f46418c5 LCB	284
7b4393a6	285	return ds3232_update_alarm(dev, enabled);
f46418c5 LCB	286	}
f46418c5 LCB	287
c03675f0 RZ	288	static irqreturn_t ds3232_irq(int irq, void *dev_id)
c03675f0 RZ	289	{
370927c4 AM	290	struct device *dev = dev_id;
370927c4 AM	291	struct ds3232 *ds3232 = dev_get_drvdata(dev);
fc1dcb0b	292	struct mutex *lock = &ds3232->rtc->ops_lock;
370927c4	293	int ret;
c03675f0 RZ	294	int stat, control;
c03675f0 RZ	295
fc1dcb0b	296	mutex_lock(lock);
c03675f0	297
370927c4 AM	298	ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
370927c4 AM	299	if (ret)
c03675f0 RZ	300	goto unlock;
	301
	302	if (stat & DS3232_REG_SR_A1F) {
370927c4 AM	303	ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
370927c4 AM	304	if (ret) {
95c60c1c AM	305	dev_warn(ds3232->dev,
95c60c1c AM	306	"Read Control Register error %d\n", ret);
c93a3ae2 WD	307	} else {
	308	/* disable alarm1 interrupt */
	309	control &= ~(DS3232_REG_CR_A1IE);
7b4393a6 AM	310	ret = regmap_write(ds3232->regmap, DS3232_REG_CR,
	311	control);
	312	if (ret) {
	313	dev_warn(ds3232->dev,
	314	"Write Control Register error %d\n",
	315	ret);
	316	goto unlock;
	317	}
c93a3ae2 WD	318
	319	/* clear the alarm pend flag */
	320	stat &= ~DS3232_REG_SR_A1F;
7b4393a6 AM	321	ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
	322	if (ret) {
	323	dev_warn(ds3232->dev,
	324	"Write Status Register error %d\n",
	325	ret);
	326	goto unlock;
	327	}
c93a3ae2 WD	328
c93a3ae2 WD	329	rtc_update_irq(ds3232->rtc, 1, RTC_AF \| RTC_IRQF);
c93a3ae2	330	}
c03675f0 RZ	331	}
c03675f0 RZ	332
c03675f0	333	unlock:
fc1dcb0b	334	mutex_unlock(lock);
95c60c1c AM	335
95c60c1c AM	336	return IRQ_HANDLED;
c03675f0 RZ	337	}
	338
	339	static const struct rtc_class_ops ds3232_rtc_ops = {
	340	.read_time = ds3232_read_time,
	341	.set_time = ds3232_set_time,
f46418c5 LCB	342	.read_alarm = ds3232_read_alarm,
	343	.set_alarm = ds3232_set_alarm,
	344	.alarm_irq_enable = ds3232_alarm_irq_enable,
c03675f0 RZ	345	};
c03675f0 RZ	346
370927c4 AM	347	static int ds3232_probe(struct device dev, struct regmap regmap, int irq,
370927c4 AM	348	const char *name)
c03675f0 RZ	349	{
	350	struct ds3232 *ds3232;
	351	int ret;
	352
370927c4	353	ds3232 = devm_kzalloc(dev, sizeof(*ds3232), GFP_KERNEL);
c03675f0 RZ	354	if (!ds3232)
	355	return -ENOMEM;
	356
370927c4 AM	357	ds3232->regmap = regmap;
	358	ds3232->irq = irq;
	359	ds3232->dev = dev;
	360	dev_set_drvdata(dev, ds3232);
c03675f0	361
370927c4	362	ret = ds3232_check_rtc_status(dev);
c03675f0	363	if (ret)
66714612	364	return ret;
c03675f0	365
b4b77f3c QG	366	ds3232->rtc = devm_rtc_device_register(dev, name, &ds3232_rtc_ops,
	367	THIS_MODULE);
	368	if (IS_ERR(ds3232->rtc))
	369	return PTR_ERR(ds3232->rtc);
	370
370927c4	371	if (ds3232->irq > 0) {
95c60c1c AM	372	ret = devm_request_threaded_irq(dev, ds3232->irq, NULL,
	373	ds3232_irq,
	374	IRQF_SHARED \| IRQF_ONESHOT,
	375	name, dev);
c03675f0	376	if (ret) {
370927c4 AM	377	ds3232->irq = 0;
	378	dev_err(dev, "unable to request IRQ\n");
	379	} else
	380	device_init_wakeup(dev, 1);
c03675f0	381	}
370927c4	382
b4b77f3c	383	return 0;
c03675f0 RZ	384	}
c03675f0 RZ	385
c93a3ae2 WD	386	#ifdef CONFIG_PM_SLEEP
	387	static int ds3232_suspend(struct device *dev)
	388	{
	389	struct ds3232 *ds3232 = dev_get_drvdata(dev);
c93a3ae2	390
95c60c1c AM	391	if (device_may_wakeup(dev)) {
95c60c1c AM	392	if (enable_irq_wake(ds3232->irq))
dc2280eb	393	dev_warn_once(dev, "Cannot set wakeup source\n");
c93a3ae2 WD	394	}
	395
	396	return 0;
	397	}
	398
	399	static int ds3232_resume(struct device *dev)
	400	{
	401	struct ds3232 *ds3232 = dev_get_drvdata(dev);
c93a3ae2	402
95c60c1c AM	403	if (device_may_wakeup(dev))
95c60c1c AM	404	disable_irq_wake(ds3232->irq);
c93a3ae2 WD	405
	406	return 0;
	407	}
	408	#endif
	409
	410	static const struct dev_pm_ops ds3232_pm_ops = {
	411	SET_SYSTEM_SLEEP_PM_OPS(ds3232_suspend, ds3232_resume)
	412	};
	413
080481f5 AM	414	#if IS_ENABLED(CONFIG_I2C)
080481f5 AM	415
370927c4 AM	416	static int ds3232_i2c_probe(struct i2c_client *client,
	417	const struct i2c_device_id *id)
	418	{
	419	struct regmap *regmap;
	420	static const struct regmap_config config = {
	421	.reg_bits = 8,
	422	.val_bits = 8,
	423	};
	424
	425	regmap = devm_regmap_init_i2c(client, &config);
	426	if (IS_ERR(regmap)) {
	427	dev_err(&client->dev, "%s: regmap allocation failed: %ld\n",
	428	__func__, PTR_ERR(regmap));
	429	return PTR_ERR(regmap);
	430	}
	431
	432	return ds3232_probe(&client->dev, regmap, client->irq, client->name);
	433	}
	434
c03675f0 RZ	435	static const struct i2c_device_id ds3232_id[] = {
	436	{ "ds3232", 0 },
	437	{ }
	438	};
	439	MODULE_DEVICE_TABLE(i2c, ds3232_id);
	440
	441	static struct i2c_driver ds3232_driver = {
	442	.driver = {
	443	.name = "rtc-ds3232",
c93a3ae2	444	.pm = &ds3232_pm_ops,
c03675f0	445	},
370927c4	446	.probe = ds3232_i2c_probe,
c03675f0 RZ	447	.id_table = ds3232_id,
c03675f0 RZ	448	};
080481f5 AM	449
	450	static int ds3232_register_driver(void)
	451	{
	452	return i2c_add_driver(&ds3232_driver);
	453	}
	454
	455	static void ds3232_unregister_driver(void)
	456	{
	457	i2c_del_driver(&ds3232_driver);
	458	}
	459
	460	#else
	461
	462	static int ds3232_register_driver(void)
	463	{
	464	return 0;
	465	}
	466
	467	static void ds3232_unregister_driver(void)
	468	{
	469	}
	470
	471	#endif
	472
	473	#if IS_ENABLED(CONFIG_SPI_MASTER)
	474
	475	static int ds3234_probe(struct spi_device *spi)
	476	{
	477	int res;
	478	unsigned int tmp;
	479	static const struct regmap_config config = {
	480	.reg_bits = 8,
	481	.val_bits = 8,
	482	.write_flag_mask = 0x80,
	483	};
	484	struct regmap *regmap;
	485
	486	regmap = devm_regmap_init_spi(spi, &config);
	487	if (IS_ERR(regmap)) {
	488	dev_err(&spi->dev, "%s: regmap allocation failed: %ld\n",
	489	__func__, PTR_ERR(regmap));
	490	return PTR_ERR(regmap);
	491	}
	492
	493	spi->mode = SPI_MODE_3;
	494	spi->bits_per_word = 8;
	495	spi_setup(spi);
	496
	497	res = regmap_read(regmap, DS3232_REG_SECONDS, &tmp);
	498	if (res)
	499	return res;
	500
	501	/* Control settings
	502	*
	503	* CONTROL_REG
	504	* BIT 7 6 5 4 3 2 1 0
	505	* EOSC BBSQW CONV RS2 RS1 INTCN A2IE A1IE
	506	*
	507	* 0 0 0 1 1 1 0 0
	508	*
	509	* CONTROL_STAT_REG
	510	* BIT 7 6 5 4 3 2 1 0
	511	* OSF BB32kHz CRATE1 CRATE0 EN32kHz BSY A2F A1F
	512	*
513	* 1 0 0 0 1 0 0 0
514	*/
515	res = regmap_read(regmap, DS3232_REG_CR, &tmp);
516	if (res)
517	return res;
518	res = regmap_write(regmap, DS3232_REG_CR, tmp & 0x1c);
519	if (res)
520	return res;
521
522	res = regmap_read(regmap, DS3232_REG_SR, &tmp);
523	if (res)
524	return res;
525	res = regmap_write(regmap, DS3232_REG_SR, tmp & 0x88);
526	if (res)
527	return res;
528
529	/* Print our settings */
530	res = regmap_read(regmap, DS3232_REG_CR, &tmp);
531	if (res)
532	return res;
533	dev_info(&spi->dev, "Control Reg: 0x%02x\n", tmp);
534
535	res = regmap_read(regmap, DS3232_REG_SR, &tmp);
536	if (res)
537	return res;
538	dev_info(&spi->dev, "Ctrl/Stat Reg: 0x%02x\n", tmp);
539
540	return ds3232_probe(&spi->dev, regmap, spi->irq, "ds3234");
541	}
542
080481f5 AM	543	static struct spi_driver ds3234_driver = {
	544	.driver = {
	545	.name = "ds3234",
	546	},
	547	.probe = ds3234_probe,
080481f5 AM	548	};
	549
	550	static int ds3234_register_driver(void)
	551	{
	552	return spi_register_driver(&ds3234_driver);
	553	}
	554
	555	static void ds3234_unregister_driver(void)
	556	{
	557	spi_unregister_driver(&ds3234_driver);
	558	}
	559
	560	#else
	561
	562	static int ds3234_register_driver(void)
	563	{
	564	return 0;
	565	}
	566
	567	static void ds3234_unregister_driver(void)
	568	{
	569	}
	570
	571	#endif
	572
	573	static int __init ds323x_init(void)
	574	{
	575	int ret;
	576
	577	ret = ds3232_register_driver();
	578	if (ret) {
	579	pr_err("Failed to register ds3232 driver: %d\n", ret);
	580	return ret;
	581	}
	582
	583	ret = ds3234_register_driver();
	584	if (ret) {
	585	pr_err("Failed to register ds3234 driver: %d\n", ret);
	586	ds3232_unregister_driver();
	587	}
	588
	589	return ret;
	590	}
	591	module_init(ds323x_init)
	592
	593	static void __exit ds323x_exit(void)
	594	{
	595	ds3234_unregister_driver();
	596	ds3232_unregister_driver();
	597	}
	598	module_exit(ds323x_exit)
c03675f0 RZ	599
c03675f0 RZ	600	MODULE_AUTHOR("Srikanth Srinivasan <srikanth.srinivasan@freescale.com>");
080481f5 AM	601	MODULE_AUTHOR("Dennis Aberilla <denzzzhome@yahoo.com>");
080481f5 AM	602	MODULE_DESCRIPTION("Maxim/Dallas DS3232/DS3234 RTC Driver");
c03675f0	603	MODULE_LICENSE("GPL");
080481f5	604	MODULE_ALIAS("spi:ds3234");