[mirror_ubuntu-artful-kernel.git] / drivers / rtc / rtc-at91rm9200.c

/*
 *	Real Time Clock interface for Linux on Atmel AT91RM9200
 *
 *	Copyright (C) 2002 Rick Bronson
 *
 *	Converted to RTC class model by Andrew Victor
 *
 *	Ported to Linux 2.6 by Steven Scholz
 *	Based on s3c2410-rtc.c Simtec Electronics
 *
 *	Based on sa1100-rtc.c by Nils Faerber
 *	Based on rtc.c by Paul Gortmaker
 *
 *	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.
 *
 */

#include <linux/bcd.h>
#include <linux/clk.h>
#include <linux/completion.h>
#include <linux/interrupt.h>
#include <linux/ioctl.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/of_device.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/rtc.h>
#include <linux/spinlock.h>
#include <linux/suspend.h>
#include <linux/time.h>
#include <linux/uaccess.h>

#include "rtc-at91rm9200.h"

#define at91_rtc_read(field) \
	readl_relaxed(at91_rtc_regs + field)
#define at91_rtc_write(field, val) \
	writel_relaxed((val), at91_rtc_regs + field)

#define AT91_RTC_EPOCH		1900UL	/* just like arch/arm/common/rtctime.c */

struct at91_rtc_config {
	bool use_shadow_imr;
};

static const struct at91_rtc_config *at91_rtc_config;
static DECLARE_COMPLETION(at91_rtc_updated);
static DECLARE_COMPLETION(at91_rtc_upd_rdy);
static unsigned int at91_alarm_year = AT91_RTC_EPOCH;
static void __iomem *at91_rtc_regs;
static int irq;
static DEFINE_SPINLOCK(at91_rtc_lock);
static u32 at91_rtc_shadow_imr;
static bool suspended;
static DEFINE_SPINLOCK(suspended_lock);
static unsigned long cached_events;
static u32 at91_rtc_imr;
static struct clk *sclk;

static void at91_rtc_write_ier(u32 mask)
{
	unsigned long flags;

	spin_lock_irqsave(&at91_rtc_lock, flags);
	at91_rtc_shadow_imr |= mask;
	at91_rtc_write(AT91_RTC_IER, mask);
	spin_unlock_irqrestore(&at91_rtc_lock, flags);
}

static void at91_rtc_write_idr(u32 mask)
{
	unsigned long flags;

	spin_lock_irqsave(&at91_rtc_lock, flags);
	at91_rtc_write(AT91_RTC_IDR, mask);
	/*
	 * Register read back (of any RTC-register) needed to make sure
	 * IDR-register write has reached the peripheral before updating
	 * shadow mask.
	 *
	 * Note that there is still a possibility that the mask is updated
	 * before interrupts have actually been disabled in hardware. The only
	 * way to be certain would be to poll the IMR-register, which is is
	 * the very register we are trying to emulate. The register read back
	 * is a reasonable heuristic.
	 */
	at91_rtc_read(AT91_RTC_SR);
	at91_rtc_shadow_imr &= ~mask;
	spin_unlock_irqrestore(&at91_rtc_lock, flags);
}

static u32 at91_rtc_read_imr(void)
{
	unsigned long flags;
	u32 mask;

	if (at91_rtc_config->use_shadow_imr) {
		spin_lock_irqsave(&at91_rtc_lock, flags);
		mask = at91_rtc_shadow_imr;
		spin_unlock_irqrestore(&at91_rtc_lock, flags);
	} else {
		mask = at91_rtc_read(AT91_RTC_IMR);
	}

	return mask;
}

/*
 * Decode time/date into rtc_time structure
 */
static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
				struct rtc_time *tm)
{
	unsigned int time, date;

	/* must read twice in case it changes */
	do {
		time = at91_rtc_read(timereg);
		date = at91_rtc_read(calreg);
	} while ((time != at91_rtc_read(timereg)) ||
			(date != at91_rtc_read(calreg)));

	tm->tm_sec  = bcd2bin((time & AT91_RTC_SEC) >> 0);
	tm->tm_min  = bcd2bin((time & AT91_RTC_MIN) >> 8);
	tm->tm_hour = bcd2bin((time & AT91_RTC_HOUR) >> 16);

	/*
	 * The Calendar Alarm register does not have a field for
	 * the year - so these will return an invalid value.  When an
	 * alarm is set, at91_alarm_year will store the current year.
	 */
	tm->tm_year  = bcd2bin(date & AT91_RTC_CENT) * 100;	/* century */
	tm->tm_year += bcd2bin((date & AT91_RTC_YEAR) >> 8);	/* year */

	tm->tm_wday = bcd2bin((date & AT91_RTC_DAY) >> 21) - 1;	/* day of the week [0-6], Sunday=0 */
	tm->tm_mon  = bcd2bin((date & AT91_RTC_MONTH) >> 16) - 1;
	tm->tm_mday = bcd2bin((date & AT91_RTC_DATE) >> 24);
}

/*
 * Read current time and date in RTC
 */
static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
{
	at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
	tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
	tm->tm_year = tm->tm_year - 1900;

	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
		1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
		tm->tm_hour, tm->tm_min, tm->tm_sec);

	return 0;
}

/*
 * Set current time and date in RTC
 */
static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
{
	unsigned long cr;

	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
		1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
		tm->tm_hour, tm->tm_min, tm->tm_sec);

	wait_for_completion(&at91_rtc_upd_rdy);

	/* Stop Time/Calendar from counting */
	cr = at91_rtc_read(AT91_RTC_CR);
	at91_rtc_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM);

	at91_rtc_write_ier(AT91_RTC_ACKUPD);
	wait_for_completion(&at91_rtc_updated);	/* wait for ACKUPD interrupt */
	at91_rtc_write_idr(AT91_RTC_ACKUPD);

	at91_rtc_write(AT91_RTC_TIMR,
			  bin2bcd(tm->tm_sec) << 0
			| bin2bcd(tm->tm_min) << 8
			| bin2bcd(tm->tm_hour) << 16);

	at91_rtc_write(AT91_RTC_CALR,
			  bin2bcd((tm->tm_year + 1900) / 100)	/* century */
			| bin2bcd(tm->tm_year % 100) << 8	/* year */
			| bin2bcd(tm->tm_mon + 1) << 16		/* tm_mon starts at zero */
			| bin2bcd(tm->tm_wday + 1) << 21	/* day of the week [0-6], Sunday=0 */
			| bin2bcd(tm->tm_mday) << 24);

	/* Restart Time/Calendar */
	cr = at91_rtc_read(AT91_RTC_CR);
	at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_SECEV);
	at91_rtc_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM));
	at91_rtc_write_ier(AT91_RTC_SECEV);

	return 0;
}

/*
 * Read alarm time and date in RTC
 */
static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
{
	struct rtc_time *tm = &alrm->time;

	at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
	tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
	tm->tm_year = at91_alarm_year - 1900;

	alrm->enabled = (at91_rtc_read_imr() & AT91_RTC_ALARM)
			? 1 : 0;

	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
		1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
		tm->tm_hour, tm->tm_min, tm->tm_sec);

	return 0;
}

/*
 * Set alarm time and date in RTC
 */
static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
{
	struct rtc_time tm;

	at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm);

	at91_alarm_year = tm.tm_year;

	tm.tm_mon = alrm->time.tm_mon;
	tm.tm_mday = alrm->time.tm_mday;
	tm.tm_hour = alrm->time.tm_hour;
	tm.tm_min = alrm->time.tm_min;
	tm.tm_sec = alrm->time.tm_sec;

	at91_rtc_write_idr(AT91_RTC_ALARM);
	at91_rtc_write(AT91_RTC_TIMALR,
		  bin2bcd(tm.tm_sec) << 0
		| bin2bcd(tm.tm_min) << 8
		| bin2bcd(tm.tm_hour) << 16
		| AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
	at91_rtc_write(AT91_RTC_CALALR,
		  bin2bcd(tm.tm_mon + 1) << 16		/* tm_mon starts at zero */
		| bin2bcd(tm.tm_mday) << 24
		| AT91_RTC_DATEEN | AT91_RTC_MTHEN);

	if (alrm->enabled) {
		at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
		at91_rtc_write_ier(AT91_RTC_ALARM);
	}

	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
		at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
		tm.tm_min, tm.tm_sec);

	return 0;
}

static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
{
	dev_dbg(dev, "%s(): cmd=%08x\n", __func__, enabled);

	if (enabled) {
		at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
		at91_rtc_write_ier(AT91_RTC_ALARM);
	} else
		at91_rtc_write_idr(AT91_RTC_ALARM);

	return 0;
}
/*
 * Provide additional RTC information in /proc/driver/rtc
 */
static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
{
	unsigned long imr = at91_rtc_read_imr();

	seq_printf(seq, "update_IRQ\t: %s\n",
			(imr & AT91_RTC_ACKUPD) ? "yes" : "no");
	seq_printf(seq, "periodic_IRQ\t: %s\n",
			(imr & AT91_RTC_SECEV) ? "yes" : "no");

	return 0;
}

/*
 * IRQ handler for the RTC
 */
static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
{
	struct platform_device *pdev = dev_id;
	struct rtc_device *rtc = platform_get_drvdata(pdev);
	unsigned int rtsr;
	unsigned long events = 0;
	int ret = IRQ_NONE;

	spin_lock(&suspended_lock);
	rtsr = at91_rtc_read(AT91_RTC_SR) & at91_rtc_read_imr();
	if (rtsr) {		/* this interrupt is shared!  Is it ours? */
		if (rtsr & AT91_RTC_ALARM)
			events |= (RTC_AF | RTC_IRQF);
		if (rtsr & AT91_RTC_SECEV) {
			complete(&at91_rtc_upd_rdy);
			at91_rtc_write_idr(AT91_RTC_SECEV);
		}
		if (rtsr & AT91_RTC_ACKUPD)
			complete(&at91_rtc_updated);

		at91_rtc_write(AT91_RTC_SCCR, rtsr);	/* clear status reg */

		if (!suspended) {
			rtc_update_irq(rtc, 1, events);

			dev_dbg(&pdev->dev, "%s(): num=%ld, events=0x%02lx\n",
				__func__, events >> 8, events & 0x000000FF);
		} else {
			cached_events |= events;
			at91_rtc_write_idr(at91_rtc_imr);
			pm_system_wakeup();
		}

		ret = IRQ_HANDLED;
	}
	spin_unlock(&suspended_lock);

	return ret;
}

static const struct at91_rtc_config at91rm9200_config = {
};

static const struct at91_rtc_config at91sam9x5_config = {
	.use_shadow_imr	= true,
};

#ifdef CONFIG_OF
static const struct of_device_id at91_rtc_dt_ids[] = {
	{
		.compatible = "atmel,at91rm9200-rtc",
		.data = &at91rm9200_config,
	}, {
		.compatible = "atmel,at91sam9x5-rtc",
		.data = &at91sam9x5_config,
	}, {
		/* sentinel */
	}
};
MODULE_DEVICE_TABLE(of, at91_rtc_dt_ids);
#endif

static const struct at91_rtc_config *
at91_rtc_get_config(struct platform_device *pdev)
{
	const struct of_device_id *match;

	if (pdev->dev.of_node) {
		match = of_match_node(at91_rtc_dt_ids, pdev->dev.of_node);
		if (!match)
			return NULL;
		return (const struct at91_rtc_config *)match->data;
	}

	return &at91rm9200_config;
}

static const struct rtc_class_ops at91_rtc_ops = {
	.read_time	= at91_rtc_readtime,
	.set_time	= at91_rtc_settime,
	.read_alarm	= at91_rtc_readalarm,
	.set_alarm	= at91_rtc_setalarm,
	.proc		= at91_rtc_proc,
	.alarm_irq_enable = at91_rtc_alarm_irq_enable,
};

/*
 * Initialize and install RTC driver
 */
static int __init at91_rtc_probe(struct platform_device *pdev)
{
	struct rtc_device *rtc;
	struct resource *regs;
	int ret = 0;

	at91_rtc_config = at91_rtc_get_config(pdev);
	if (!at91_rtc_config)
		return -ENODEV;

	regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!regs) {
		dev_err(&pdev->dev, "no mmio resource defined\n");
		return -ENXIO;
	}

	irq = platform_get_irq(pdev, 0);
	if (irq < 0) {
		dev_err(&pdev->dev, "no irq resource defined\n");
		return -ENXIO;
	}

	at91_rtc_regs = devm_ioremap(&pdev->dev, regs->start,
				     resource_size(regs));
	if (!at91_rtc_regs) {
		dev_err(&pdev->dev, "failed to map registers, aborting.\n");
		return -ENOMEM;
	}

	sclk = devm_clk_get(&pdev->dev, NULL);
	if (IS_ERR(sclk))
		return PTR_ERR(sclk);

	ret = clk_prepare_enable(sclk);
	if (ret) {
		dev_err(&pdev->dev, "Could not enable slow clock\n");
		return ret;
	}

	at91_rtc_write(AT91_RTC_CR, 0);
	at91_rtc_write(AT91_RTC_MR, 0);		/* 24 hour mode */

	/* Disable all interrupts */
	at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
					AT91_RTC_SECEV | AT91_RTC_TIMEV |
					AT91_RTC_CALEV);

	ret = devm_request_irq(&pdev->dev, irq, at91_rtc_interrupt,
			       IRQF_SHARED | IRQF_COND_SUSPEND,
			       "at91_rtc", pdev);
	if (ret) {
		dev_err(&pdev->dev, "IRQ %d already in use.\n", irq);
		goto err_clk;
	}

	/* cpu init code should really have flagged this device as
	 * being wake-capable; if it didn't, do that here.
	 */
	if (!device_can_wakeup(&pdev->dev))
		device_init_wakeup(&pdev->dev, 1);

	rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
				&at91_rtc_ops, THIS_MODULE);
	if (IS_ERR(rtc)) {
		ret = PTR_ERR(rtc);
		goto err_clk;
	}
	platform_set_drvdata(pdev, rtc);

	/* enable SECEV interrupt in order to initialize at91_rtc_upd_rdy
	 * completion.
	 */
	at91_rtc_write_ier(AT91_RTC_SECEV);

	dev_info(&pdev->dev, "AT91 Real Time Clock driver.\n");
	return 0;

err_clk:
	clk_disable_unprepare(sclk);

	return ret;
}

/*
 * Disable and remove the RTC driver
 */
static int __exit at91_rtc_remove(struct platform_device *pdev)
{
	/* Disable all interrupts */
	at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
					AT91_RTC_SECEV | AT91_RTC_TIMEV |
					AT91_RTC_CALEV);

	clk_disable_unprepare(sclk);

	return 0;
}

static void at91_rtc_shutdown(struct platform_device *pdev)
{
	/* Disable all interrupts */
	at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
					AT91_RTC_SECEV | AT91_RTC_TIMEV |
					AT91_RTC_CALEV);
}

#ifdef CONFIG_PM_SLEEP

/* AT91RM9200 RTC Power management control */

static int at91_rtc_suspend(struct device *dev)
{
	/* this IRQ is shared with DBGU and other hardware which isn't
	 * necessarily doing PM like we are...
	 */
	at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);

	at91_rtc_imr = at91_rtc_read_imr()
			& (AT91_RTC_ALARM|AT91_RTC_SECEV);
	if (at91_rtc_imr) {
		if (device_may_wakeup(dev)) {
			unsigned long flags;

			enable_irq_wake(irq);

			spin_lock_irqsave(&suspended_lock, flags);
			suspended = true;
			spin_unlock_irqrestore(&suspended_lock, flags);
		} else {
			at91_rtc_write_idr(at91_rtc_imr);
		}
	}
	return 0;
}

static int at91_rtc_resume(struct device *dev)
{
	struct rtc_device *rtc = dev_get_drvdata(dev);

	if (at91_rtc_imr) {
		if (device_may_wakeup(dev)) {
			unsigned long flags;

			spin_lock_irqsave(&suspended_lock, flags);

			if (cached_events) {
				rtc_update_irq(rtc, 1, cached_events);
				cached_events = 0;
			}

			suspended = false;
			spin_unlock_irqrestore(&suspended_lock, flags);

			disable_irq_wake(irq);
		}
		at91_rtc_write_ier(at91_rtc_imr);
	}
	return 0;
}
#endif

static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);

static struct platform_driver at91_rtc_driver = {
	.remove		= __exit_p(at91_rtc_remove),
	.shutdown	= at91_rtc_shutdown,
	.driver		= {
		.name	= "at91_rtc",
		.pm	= &at91_rtc_pm_ops,
		.of_match_table = of_match_ptr(at91_rtc_dt_ids),
	},
};

module_platform_driver_probe(at91_rtc_driver, at91_rtc_probe);

MODULE_AUTHOR("Rick Bronson");
MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:at91_rtc");
Commit	Line	Data
788b1fc6 AV	1	/*
	2	* Real Time Clock interface for Linux on Atmel AT91RM9200
	3	*
	4	* Copyright (C) 2002 Rick Bronson
	5	*
	6	* Converted to RTC class model by Andrew Victor
	7	*
	8	* Ported to Linux 2.6 by Steven Scholz
	9	* Based on s3c2410-rtc.c Simtec Electronics
	10	*
	11	* Based on sa1100-rtc.c by Nils Faerber
	12	* Based on rtc.c by Paul Gortmaker
	13	*
	14	* This program is free software; you can redistribute it and/or
	15	* modify it under the terms of the GNU General Public License
	16	* as published by the Free Software Foundation; either version
	17	* 2 of the License, or (at your option) any later version.
	18	*
	19	*/
	20
788b1fc6	21	#include <linux/bcd.h>
11f67a8b	22	#include <linux/clk.h>
74000eb1	23	#include <linux/completion.h>
788b1fc6 AV	24	#include <linux/interrupt.h>
788b1fc6 AV	25	#include <linux/ioctl.h>
14070ade	26	#include <linux/io.h>
74000eb1 AB	27	#include <linux/kernel.h>
74000eb1 AB	28	#include <linux/module.h>
7c1b68d4	29	#include <linux/of_device.h>
74000eb1 AB	30	#include <linux/of.h>
	31	#include <linux/platform_device.h>
	32	#include <linux/rtc.h>
	33	#include <linux/spinlock.h>
dd1f1f39	34	#include <linux/suspend.h>
74000eb1	35	#include <linux/time.h>
8ecc0bf4	36	#include <linux/uaccess.h>
fb0d4ec4	37
75984df0	38	#include "rtc-at91rm9200.h"
d73e3cd7	39
d28bdfc5	40	#define at91_rtc_read(field) \
6da7bb1e	41	readl_relaxed(at91_rtc_regs + field)
d28bdfc5	42	#define at91_rtc_write(field, val) \
6da7bb1e	43	writel_relaxed((val), at91_rtc_regs + field)
788b1fc6	44
788b1fc6 AV	45	#define AT91_RTC_EPOCH 1900UL /* just like arch/arm/common/rtctime.c */
788b1fc6 AV	46
de645475	47	struct at91_rtc_config {
e9f08bbe	48	bool use_shadow_imr;
de645475 JH	49	};
	50
	51	static const struct at91_rtc_config *at91_rtc_config;
788b1fc6	52	static DECLARE_COMPLETION(at91_rtc_updated);
2fe121e1	53	static DECLARE_COMPLETION(at91_rtc_upd_rdy);
788b1fc6	54	static unsigned int at91_alarm_year = AT91_RTC_EPOCH;
d28bdfc5 JCPV	55	static void __iomem *at91_rtc_regs;
d28bdfc5 JCPV	56	static int irq;
e9f08bbe JH	57	static DEFINE_SPINLOCK(at91_rtc_lock);
e9f08bbe JH	58	static u32 at91_rtc_shadow_imr;
dd1f1f39 BB	59	static bool suspended;
	60	static DEFINE_SPINLOCK(suspended_lock);
	61	static unsigned long cached_events;
	62	static u32 at91_rtc_imr;
11f67a8b	63	static struct clk *sclk;
788b1fc6	64
e304fcd0 JH	65	static void at91_rtc_write_ier(u32 mask)
e304fcd0 JH	66	{
e9f08bbe JH	67	unsigned long flags;
	68
	69	spin_lock_irqsave(&at91_rtc_lock, flags);
	70	at91_rtc_shadow_imr \|= mask;
e304fcd0	71	at91_rtc_write(AT91_RTC_IER, mask);
e9f08bbe	72	spin_unlock_irqrestore(&at91_rtc_lock, flags);
e304fcd0 JH	73	}
	74
	75	static void at91_rtc_write_idr(u32 mask)
	76	{
e9f08bbe JH	77	unsigned long flags;
	78
	79	spin_lock_irqsave(&at91_rtc_lock, flags);
e304fcd0	80	at91_rtc_write(AT91_RTC_IDR, mask);
e9f08bbe JH	81	/*
	82	* Register read back (of any RTC-register) needed to make sure
	83	* IDR-register write has reached the peripheral before updating
	84	* shadow mask.
	85	*
	86	* Note that there is still a possibility that the mask is updated
	87	* before interrupts have actually been disabled in hardware. The only
	88	* way to be certain would be to poll the IMR-register, which is is
	89	* the very register we are trying to emulate. The register read back
	90	* is a reasonable heuristic.
	91	*/
	92	at91_rtc_read(AT91_RTC_SR);
	93	at91_rtc_shadow_imr &= ~mask;
	94	spin_unlock_irqrestore(&at91_rtc_lock, flags);
e304fcd0 JH	95	}
	96
	97	static u32 at91_rtc_read_imr(void)
	98	{
e9f08bbe JH	99	unsigned long flags;
	100	u32 mask;
	101
	102	if (at91_rtc_config->use_shadow_imr) {
	103	spin_lock_irqsave(&at91_rtc_lock, flags);
	104	mask = at91_rtc_shadow_imr;
	105	spin_unlock_irqrestore(&at91_rtc_lock, flags);
	106	} else {
	107	mask = at91_rtc_read(AT91_RTC_IMR);
	108	}
	109
	110	return mask;
e304fcd0 JH	111	}
e304fcd0 JH	112
788b1fc6 AV	113	/*
	114	* Decode time/date into rtc_time structure
	115	*/
e7a8bb12 AM	116	static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
e7a8bb12 AM	117	struct rtc_time *tm)
788b1fc6 AV	118	{
	119	unsigned int time, date;
	120
	121	/* must read twice in case it changes */
	122	do {
d28bdfc5 JCPV	123	time = at91_rtc_read(timereg);
	124	date = at91_rtc_read(calreg);
	125	} while ((time != at91_rtc_read(timereg)) \|\|
	126	(date != at91_rtc_read(calreg)));
788b1fc6	127
fe20ba70 AB	128	tm->tm_sec = bcd2bin((time & AT91_RTC_SEC) >> 0);
	129	tm->tm_min = bcd2bin((time & AT91_RTC_MIN) >> 8);
	130	tm->tm_hour = bcd2bin((time & AT91_RTC_HOUR) >> 16);
788b1fc6 AV	131
	132	/*
	133	* The Calendar Alarm register does not have a field for
	134	* the year - so these will return an invalid value. When an
25985edc	135	* alarm is set, at91_alarm_year will store the current year.
788b1fc6	136	*/
fe20ba70 AB	137	tm->tm_year = bcd2bin(date & AT91_RTC_CENT) * 100; /* century */
fe20ba70 AB	138	tm->tm_year += bcd2bin((date & AT91_RTC_YEAR) >> 8); /* year */
788b1fc6	139
fe20ba70 AB	140	tm->tm_wday = bcd2bin((date & AT91_RTC_DAY) >> 21) - 1; /* day of the week [0-6], Sunday=0 */
	141	tm->tm_mon = bcd2bin((date & AT91_RTC_MONTH) >> 16) - 1;
	142	tm->tm_mday = bcd2bin((date & AT91_RTC_DATE) >> 24);
788b1fc6 AV	143	}
	144
	145	/*
	146	* Read current time and date in RTC
	147	*/
	148	static int at91_rtc_readtime(struct device dev, struct rtc_time tm)
	149	{
	150	at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
	151	tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
	152	tm->tm_year = tm->tm_year - 1900;
	153
6588208c	154	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12 AM	155	1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
e7a8bb12 AM	156	tm->tm_hour, tm->tm_min, tm->tm_sec);
788b1fc6 AV	157
	158	return 0;
	159	}
	160
	161	/*
	162	* Set current time and date in RTC
	163	*/
	164	static int at91_rtc_settime(struct device dev, struct rtc_time tm)
	165	{
	166	unsigned long cr;
	167
6588208c	168	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12 AM	169	1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
e7a8bb12 AM	170	tm->tm_hour, tm->tm_min, tm->tm_sec);
788b1fc6	171
2fe121e1 BB	172	wait_for_completion(&at91_rtc_upd_rdy);
2fe121e1 BB	173
788b1fc6	174	/* Stop Time/Calendar from counting */
d28bdfc5 JCPV	175	cr = at91_rtc_read(AT91_RTC_CR);
d28bdfc5 JCPV	176	at91_rtc_write(AT91_RTC_CR, cr \| AT91_RTC_UPDCAL \| AT91_RTC_UPDTIM);
788b1fc6	177
e304fcd0	178	at91_rtc_write_ier(AT91_RTC_ACKUPD);
e7a8bb12	179	wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */
e304fcd0	180	at91_rtc_write_idr(AT91_RTC_ACKUPD);
788b1fc6	181
d28bdfc5	182	at91_rtc_write(AT91_RTC_TIMR,
fe20ba70 AB	183	bin2bcd(tm->tm_sec) << 0
	184	\| bin2bcd(tm->tm_min) << 8
	185	\| bin2bcd(tm->tm_hour) << 16);
788b1fc6	186
d28bdfc5	187	at91_rtc_write(AT91_RTC_CALR,
fe20ba70 AB	188	bin2bcd((tm->tm_year + 1900) / 100) /* century */
	189	\| bin2bcd(tm->tm_year % 100) << 8 /* year */
	190	\| bin2bcd(tm->tm_mon + 1) << 16 /* tm_mon starts at zero */
	191	\| bin2bcd(tm->tm_wday + 1) << 21 /* day of the week [0-6], Sunday=0 */
	192	\| bin2bcd(tm->tm_mday) << 24);
788b1fc6 AV	193
788b1fc6 AV	194	/* Restart Time/Calendar */
d28bdfc5	195	cr = at91_rtc_read(AT91_RTC_CR);
2fe121e1	196	at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_SECEV);
d28bdfc5	197	at91_rtc_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL \| AT91_RTC_UPDTIM));
2fe121e1	198	at91_rtc_write_ier(AT91_RTC_SECEV);
788b1fc6 AV	199
	200	return 0;
	201	}
	202
	203	/*
	204	* Read alarm time and date in RTC
	205	*/
	206	static int at91_rtc_readalarm(struct device dev, struct rtc_wkalrm alrm)
	207	{
	208	struct rtc_time *tm = &alrm->time;
	209
	210	at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
	211	tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
	212	tm->tm_year = at91_alarm_year - 1900;
	213
e304fcd0	214	alrm->enabled = (at91_rtc_read_imr() & AT91_RTC_ALARM)
a2db8dfc DB	215	? 1 : 0;
a2db8dfc DB	216
6588208c	217	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12 AM	218	1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
e7a8bb12 AM	219	tm->tm_hour, tm->tm_min, tm->tm_sec);
788b1fc6 AV	220
	221	return 0;
	222	}
	223
	224	/*
	225	* Set alarm time and date in RTC
	226	*/
	227	static int at91_rtc_setalarm(struct device dev, struct rtc_wkalrm alrm)
	228	{
	229	struct rtc_time tm;
	230
	231	at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm);
	232
	233	at91_alarm_year = tm.tm_year;
	234
eb3c2272 LP	235	tm.tm_mon = alrm->time.tm_mon;
eb3c2272 LP	236	tm.tm_mday = alrm->time.tm_mday;
788b1fc6 AV	237	tm.tm_hour = alrm->time.tm_hour;
	238	tm.tm_min = alrm->time.tm_min;
	239	tm.tm_sec = alrm->time.tm_sec;
	240
e304fcd0	241	at91_rtc_write_idr(AT91_RTC_ALARM);
d28bdfc5	242	at91_rtc_write(AT91_RTC_TIMALR,
fe20ba70 AB	243	bin2bcd(tm.tm_sec) << 0
	244	\| bin2bcd(tm.tm_min) << 8
	245	\| bin2bcd(tm.tm_hour) << 16
788b1fc6	246	\| AT91_RTC_HOUREN \| AT91_RTC_MINEN \| AT91_RTC_SECEN);
d28bdfc5	247	at91_rtc_write(AT91_RTC_CALALR,
fe20ba70 AB	248	bin2bcd(tm.tm_mon + 1) << 16 /* tm_mon starts at zero */
fe20ba70 AB	249	\| bin2bcd(tm.tm_mday) << 24
788b1fc6 AV	250	\| AT91_RTC_DATEEN \| AT91_RTC_MTHEN);
788b1fc6 AV	251
449321b3	252	if (alrm->enabled) {
d28bdfc5	253	at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
e304fcd0	254	at91_rtc_write_ier(AT91_RTC_ALARM);
449321b3	255	}
5d4675a8	256
6588208c	257	dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12 AM	258	at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
e7a8bb12 AM	259	tm.tm_min, tm.tm_sec);
788b1fc6 AV	260
	261	return 0;
	262	}
	263
16380c15 JS	264	static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
16380c15 JS	265	{
6588208c	266	dev_dbg(dev, "%s(): cmd=%08x\n", __func__, enabled);
16380c15 JS	267
16380c15 JS	268	if (enabled) {
d28bdfc5	269	at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
e304fcd0	270	at91_rtc_write_ier(AT91_RTC_ALARM);
e24b0bfa	271	} else
e304fcd0	272	at91_rtc_write_idr(AT91_RTC_ALARM);
16380c15 JS	273
	274	return 0;
	275	}
788b1fc6 AV	276	/*
	277	* Provide additional RTC information in /proc/driver/rtc
	278	*/
	279	static int at91_rtc_proc(struct device dev, struct seq_file seq)
	280	{
e304fcd0	281	unsigned long imr = at91_rtc_read_imr();
e24b0bfa	282
e7a8bb12	283	seq_printf(seq, "update_IRQ\t: %s\n",
e24b0bfa	284	(imr & AT91_RTC_ACKUPD) ? "yes" : "no");
e7a8bb12	285	seq_printf(seq, "periodic_IRQ\t: %s\n",
e24b0bfa	286	(imr & AT91_RTC_SECEV) ? "yes" : "no");
788b1fc6 AV	287
	288	return 0;
	289	}
	290
	291	/*
	292	* IRQ handler for the RTC
	293	*/
7d12e780	294	static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
788b1fc6	295	{
e7a8bb12	296	struct platform_device *pdev = dev_id;
788b1fc6 AV	297	struct rtc_device *rtc = platform_get_drvdata(pdev);
	298	unsigned int rtsr;
	299	unsigned long events = 0;
dd1f1f39	300	int ret = IRQ_NONE;
788b1fc6	301
dd1f1f39	302	spin_lock(&suspended_lock);
e304fcd0	303	rtsr = at91_rtc_read(AT91_RTC_SR) & at91_rtc_read_imr();
788b1fc6 AV	304	if (rtsr) { /* this interrupt is shared! Is it ours? */
	305	if (rtsr & AT91_RTC_ALARM)
	306	events \|= (RTC_AF \| RTC_IRQF);
2fe121e1 BB	307	if (rtsr & AT91_RTC_SECEV) {
	308	complete(&at91_rtc_upd_rdy);
	309	at91_rtc_write_idr(AT91_RTC_SECEV);
	310	}
788b1fc6 AV	311	if (rtsr & AT91_RTC_ACKUPD)
	312	complete(&at91_rtc_updated);
	313
d28bdfc5	314	at91_rtc_write(AT91_RTC_SCCR, rtsr); /* clear status reg */
788b1fc6	315
dd1f1f39 BB	316	if (!suspended) {
dd1f1f39 BB	317	rtc_update_irq(rtc, 1, events);
788b1fc6	318
dd1f1f39 BB	319	dev_dbg(&pdev->dev, "%s(): num=%ld, events=0x%02lx\n",
	320	__func__, events >> 8, events & 0x000000FF);
	321	} else {
	322	cached_events \|= events;
	323	at91_rtc_write_idr(at91_rtc_imr);
	324	pm_system_wakeup();
	325	}
788b1fc6	326
dd1f1f39	327	ret = IRQ_HANDLED;
788b1fc6	328	}
88601683	329	spin_unlock(&suspended_lock);
dd1f1f39 BB	330
dd1f1f39 BB	331	return ret;
788b1fc6 AV	332	}
788b1fc6 AV	333
de645475 JH	334	static const struct at91_rtc_config at91rm9200_config = {
	335	};
	336
bba00e59 JH	337	static const struct at91_rtc_config at91sam9x5_config = {
	338	.use_shadow_imr = true,
	339	};
	340
de645475 JH	341	#ifdef CONFIG_OF
	342	static const struct of_device_id at91_rtc_dt_ids[] = {
	343	{
	344	.compatible = "atmel,at91rm9200-rtc",
	345	.data = &at91rm9200_config,
bba00e59 JH	346	}, {
	347	.compatible = "atmel,at91sam9x5-rtc",
	348	.data = &at91sam9x5_config,
de645475 JH	349	}, {
	350	/* sentinel */
	351	}
	352	};
	353	MODULE_DEVICE_TABLE(of, at91_rtc_dt_ids);
	354	#endif
	355
	356	static const struct at91_rtc_config *
	357	at91_rtc_get_config(struct platform_device *pdev)
	358	{
	359	const struct of_device_id *match;
	360
	361	if (pdev->dev.of_node) {
	362	match = of_match_node(at91_rtc_dt_ids, pdev->dev.of_node);
	363	if (!match)
	364	return NULL;
	365	return (const struct at91_rtc_config *)match->data;
	366	}
	367
	368	return &at91rm9200_config;
	369	}
	370
ff8371ac	371	static const struct rtc_class_ops at91_rtc_ops = {
788b1fc6 AV	372	.read_time = at91_rtc_readtime,
	373	.set_time = at91_rtc_settime,
	374	.read_alarm = at91_rtc_readalarm,
	375	.set_alarm = at91_rtc_setalarm,
	376	.proc = at91_rtc_proc,
16380c15	377	.alarm_irq_enable = at91_rtc_alarm_irq_enable,
788b1fc6 AV	378	};
	379
	380	/*
	381	* Initialize and install RTC driver
	382	*/
	383	static int __init at91_rtc_probe(struct platform_device *pdev)
	384	{
	385	struct rtc_device *rtc;
d28bdfc5 JCPV	386	struct resource *regs;
d28bdfc5 JCPV	387	int ret = 0;
788b1fc6	388
de645475 JH	389	at91_rtc_config = at91_rtc_get_config(pdev);
	390	if (!at91_rtc_config)
	391	return -ENODEV;
	392
d28bdfc5 JCPV	393	regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	394	if (!regs) {
	395	dev_err(&pdev->dev, "no mmio resource defined\n");
	396	return -ENXIO;
	397	}
	398
	399	irq = platform_get_irq(pdev, 0);
	400	if (irq < 0) {
	401	dev_err(&pdev->dev, "no irq resource defined\n");
	402	return -ENXIO;
	403	}
	404
f3766250 SK	405	at91_rtc_regs = devm_ioremap(&pdev->dev, regs->start,
f3766250 SK	406	resource_size(regs));
d28bdfc5 JCPV	407	if (!at91_rtc_regs) {
	408	dev_err(&pdev->dev, "failed to map registers, aborting.\n");
	409	return -ENOMEM;
	410	}
	411
11f67a8b AB	412	sclk = devm_clk_get(&pdev->dev, NULL);
	413	if (IS_ERR(sclk))
	414	return PTR_ERR(sclk);
	415
	416	ret = clk_prepare_enable(sclk);
	417	if (ret) {
	418	dev_err(&pdev->dev, "Could not enable slow clock\n");
	419	return ret;
	420	}
	421
d28bdfc5 JCPV	422	at91_rtc_write(AT91_RTC_CR, 0);
d28bdfc5 JCPV	423	at91_rtc_write(AT91_RTC_MR, 0); /* 24 hour mode */
788b1fc6 AV	424
788b1fc6 AV	425	/* Disable all interrupts */
e304fcd0	426	at91_rtc_write_idr(AT91_RTC_ACKUPD \| AT91_RTC_ALARM \|
e7a8bb12 AM	427	AT91_RTC_SECEV \| AT91_RTC_TIMEV \|
e7a8bb12 AM	428	AT91_RTC_CALEV);
788b1fc6	429
f3766250	430	ret = devm_request_irq(&pdev->dev, irq, at91_rtc_interrupt,
dd1f1f39 BB	431	IRQF_SHARED \| IRQF_COND_SUSPEND,
dd1f1f39 BB	432	"at91_rtc", pdev);
788b1fc6	433	if (ret) {
6588208c	434	dev_err(&pdev->dev, "IRQ %d already in use.\n", irq);
11f67a8b	435	goto err_clk;
788b1fc6 AV	436	}
788b1fc6 AV	437
5d4675a8 DB	438	/* cpu init code should really have flagged this device as
	439	* being wake-capable; if it didn't, do that here.
	440	*/
	441	if (!device_can_wakeup(&pdev->dev))
	442	device_init_wakeup(&pdev->dev, 1);
	443
f3766250	444	rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
e7a8bb12	445	&at91_rtc_ops, THIS_MODULE);
11f67a8b AB	446	if (IS_ERR(rtc)) {
	447	ret = PTR_ERR(rtc);
	448	goto err_clk;
	449	}
788b1fc6 AV	450	platform_set_drvdata(pdev, rtc);
788b1fc6 AV	451
2fe121e1 BB	452	/* enable SECEV interrupt in order to initialize at91_rtc_upd_rdy
	453	* completion.
	454	*/
	455	at91_rtc_write_ier(AT91_RTC_SECEV);
	456
6588208c	457	dev_info(&pdev->dev, "AT91 Real Time Clock driver.\n");
788b1fc6	458	return 0;
11f67a8b AB	459
	460	err_clk:
	461	clk_disable_unprepare(sclk);
	462
	463	return ret;
788b1fc6 AV	464	}
	465
	466	/*
	467	* Disable and remove the RTC driver
	468	*/
5d4675a8	469	static int __exit at91_rtc_remove(struct platform_device *pdev)
788b1fc6	470	{
788b1fc6	471	/* Disable all interrupts */
e304fcd0	472	at91_rtc_write_idr(AT91_RTC_ACKUPD \| AT91_RTC_ALARM \|
e7a8bb12 AM	473	AT91_RTC_SECEV \| AT91_RTC_TIMEV \|
e7a8bb12 AM	474	AT91_RTC_CALEV);
788b1fc6	475
11f67a8b AB	476	clk_disable_unprepare(sclk);
11f67a8b AB	477
788b1fc6 AV	478	return 0;
	479	}
	480
51a0d036 JH	481	static void at91_rtc_shutdown(struct platform_device *pdev)
	482	{
	483	/* Disable all interrupts */
	484	at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ACKUPD \| AT91_RTC_ALARM \|
	485	AT91_RTC_SECEV \| AT91_RTC_TIMEV \|
	486	AT91_RTC_CALEV);
	487	}
	488
6975a9c1	489	#ifdef CONFIG_PM_SLEEP
788b1fc6 AV	490
	491	/* AT91RM9200 RTC Power management control */
	492
dac94d9e	493	static int at91_rtc_suspend(struct device *dev)
788b1fc6	494	{
90b4d648 DB	495	/* this IRQ is shared with DBGU and other hardware which isn't
	496	* necessarily doing PM like we are...
	497	*/
921372bf WY	498	at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
921372bf WY	499
e304fcd0	500	at91_rtc_imr = at91_rtc_read_imr()
e24b0bfa JH	501	& (AT91_RTC_ALARM\|AT91_RTC_SECEV);
e24b0bfa JH	502	if (at91_rtc_imr) {
dd1f1f39 BB	503	if (device_may_wakeup(dev)) {
	504	unsigned long flags;
	505
d28bdfc5	506	enable_irq_wake(irq);
dd1f1f39 BB	507
	508	spin_lock_irqsave(&suspended_lock, flags);
	509	suspended = true;
	510	spin_unlock_irqrestore(&suspended_lock, flags);
	511	} else {
e304fcd0	512	at91_rtc_write_idr(at91_rtc_imr);
dd1f1f39	513	}
e24b0bfa	514	}
788b1fc6 AV	515	return 0;
	516	}
	517
dac94d9e	518	static int at91_rtc_resume(struct device *dev)
788b1fc6	519	{
dd1f1f39 BB	520	struct rtc_device *rtc = dev_get_drvdata(dev);
dd1f1f39 BB	521
e24b0bfa	522	if (at91_rtc_imr) {
dd1f1f39 BB	523	if (device_may_wakeup(dev)) {
	524	unsigned long flags;
	525
	526	spin_lock_irqsave(&suspended_lock, flags);
	527
	528	if (cached_events) {
	529	rtc_update_irq(rtc, 1, cached_events);
	530	cached_events = 0;
	531	}
	532
	533	suspended = false;
	534	spin_unlock_irqrestore(&suspended_lock, flags);
	535
d28bdfc5	536	disable_irq_wake(irq);
dd1f1f39 BB	537	}
dd1f1f39 BB	538	at91_rtc_write_ier(at91_rtc_imr);
90b4d648	539	}
788b1fc6 AV	540	return 0;
788b1fc6 AV	541	}
788b1fc6 AV	542	#endif
788b1fc6 AV	543
6975a9c1 JH	544	static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);
6975a9c1 JH	545
788b1fc6	546	static struct platform_driver at91_rtc_driver = {
5d4675a8	547	.remove = __exit_p(at91_rtc_remove),
51a0d036	548	.shutdown = at91_rtc_shutdown,
788b1fc6 AV	549	.driver = {
788b1fc6 AV	550	.name = "at91_rtc",
6975a9c1	551	.pm = &at91_rtc_pm_ops,
7c1b68d4	552	.of_match_table = of_match_ptr(at91_rtc_dt_ids),
788b1fc6 AV	553	},
	554	};
	555
ac36960f	556	module_platform_driver_probe(at91_rtc_driver, at91_rtc_probe);
788b1fc6 AV	557
	558	MODULE_AUTHOR("Rick Bronson");
	559	MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
	560	MODULE_LICENSE("GPL");
ad28a07b	561	MODULE_ALIAS("platform:at91_rtc");