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

/*
 * drivers/rtc/rtc-pl031.c
 *
 * Real Time Clock interface for ARM AMBA PrimeCell 031 RTC
 *
 * Author: Deepak Saxena <dsaxena@plexity.net>
 *
 * Copyright 2006 (c) MontaVista Software, Inc.
 *
 * Author: Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>
 * Copyright 2010 (c) ST-Ericsson AB
 *
 * 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/module.h>
#include <linux/rtc.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/amba/bus.h>
#include <linux/io.h>
#include <linux/bcd.h>
#include <linux/delay.h>
#include <linux/pm_wakeirq.h>
#include <linux/slab.h>

/*
 * Register definitions
 */
#define	RTC_DR		0x00	/* Data read register */
#define	RTC_MR		0x04	/* Match register */
#define	RTC_LR		0x08	/* Data load register */
#define	RTC_CR		0x0c	/* Control register */
#define	RTC_IMSC	0x10	/* Interrupt mask and set register */
#define	RTC_RIS		0x14	/* Raw interrupt status register */
#define	RTC_MIS		0x18	/* Masked interrupt status register */
#define	RTC_ICR		0x1c	/* Interrupt clear register */
/* ST variants have additional timer functionality */
#define RTC_TDR		0x20	/* Timer data read register */
#define RTC_TLR		0x24	/* Timer data load register */
#define RTC_TCR		0x28	/* Timer control register */
#define RTC_YDR		0x30	/* Year data read register */
#define RTC_YMR		0x34	/* Year match register */
#define RTC_YLR		0x38	/* Year data load register */

#define RTC_CR_EN	(1 << 0)	/* counter enable bit */
#define RTC_CR_CWEN	(1 << 26)	/* Clockwatch enable bit */

#define RTC_TCR_EN	(1 << 1) /* Periodic timer enable bit */

/* Common bit definitions for Interrupt status and control registers */
#define RTC_BIT_AI	(1 << 0) /* Alarm interrupt bit */
#define RTC_BIT_PI	(1 << 1) /* Periodic interrupt bit. ST variants only. */

/* Common bit definations for ST v2 for reading/writing time */
#define RTC_SEC_SHIFT 0
#define RTC_SEC_MASK (0x3F << RTC_SEC_SHIFT) /* Second [0-59] */
#define RTC_MIN_SHIFT 6
#define RTC_MIN_MASK (0x3F << RTC_MIN_SHIFT) /* Minute [0-59] */
#define RTC_HOUR_SHIFT 12
#define RTC_HOUR_MASK (0x1F << RTC_HOUR_SHIFT) /* Hour [0-23] */
#define RTC_WDAY_SHIFT 17
#define RTC_WDAY_MASK (0x7 << RTC_WDAY_SHIFT) /* Day of Week [1-7] 1=Sunday */
#define RTC_MDAY_SHIFT 20
#define RTC_MDAY_MASK (0x1F << RTC_MDAY_SHIFT) /* Day of Month [1-31] */
#define RTC_MON_SHIFT 25
#define RTC_MON_MASK (0xF << RTC_MON_SHIFT) /* Month [1-12] 1=January */

#define RTC_TIMER_FREQ 32768

/**
 * struct pl031_vendor_data - per-vendor variations
 * @ops: the vendor-specific operations used on this silicon version
 * @clockwatch: if this is an ST Microelectronics silicon version with a
 *	clockwatch function
 * @st_weekday: if this is an ST Microelectronics silicon version that need
 *	the weekday fix
 * @irqflags: special IRQ flags per variant
 */
struct pl031_vendor_data {
	struct rtc_class_ops ops;
	bool clockwatch;
	bool st_weekday;
	unsigned long irqflags;
};

struct pl031_local {
	struct pl031_vendor_data *vendor;
	struct rtc_device *rtc;
	void __iomem *base;
};

static int pl031_alarm_irq_enable(struct device *dev,
	unsigned int enabled)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);
	unsigned long imsc;

	/* Clear any pending alarm interrupts. */
	writel(RTC_BIT_AI, ldata->base + RTC_ICR);

	imsc = readl(ldata->base + RTC_IMSC);

	if (enabled == 1)
		writel(imsc | RTC_BIT_AI, ldata->base + RTC_IMSC);
	else
		writel(imsc & ~RTC_BIT_AI, ldata->base + RTC_IMSC);

	return 0;
}

/*
 * Convert Gregorian date to ST v2 RTC format.
 */
static int pl031_stv2_tm_to_time(struct device *dev,
				 struct rtc_time *tm, unsigned long *st_time,
	unsigned long *bcd_year)
{
	int year = tm->tm_year + 1900;
	int wday = tm->tm_wday;

	/* wday masking is not working in hardware so wday must be valid */
	if (wday < -1 || wday > 6) {
		dev_err(dev, "invalid wday value %d\n", tm->tm_wday);
		return -EINVAL;
	} else if (wday == -1) {
		/* wday is not provided, calculate it here */
		unsigned long time;
		struct rtc_time calc_tm;

		rtc_tm_to_time(tm, &time);
		rtc_time_to_tm(time, &calc_tm);
		wday = calc_tm.tm_wday;
	}

	*bcd_year = (bin2bcd(year % 100) | bin2bcd(year / 100) << 8);

	*st_time = ((tm->tm_mon + 1) << RTC_MON_SHIFT)
			|	(tm->tm_mday << RTC_MDAY_SHIFT)
			|	((wday + 1) << RTC_WDAY_SHIFT)
			|	(tm->tm_hour << RTC_HOUR_SHIFT)
			|	(tm->tm_min << RTC_MIN_SHIFT)
			|	(tm->tm_sec << RTC_SEC_SHIFT);

	return 0;
}

/*
 * Convert ST v2 RTC format to Gregorian date.
 */
static int pl031_stv2_time_to_tm(unsigned long st_time, unsigned long bcd_year,
	struct rtc_time *tm)
{
	tm->tm_year = bcd2bin(bcd_year) + (bcd2bin(bcd_year >> 8) * 100);
	tm->tm_mon  = ((st_time & RTC_MON_MASK) >> RTC_MON_SHIFT) - 1;
	tm->tm_mday = ((st_time & RTC_MDAY_MASK) >> RTC_MDAY_SHIFT);
	tm->tm_wday = ((st_time & RTC_WDAY_MASK) >> RTC_WDAY_SHIFT) - 1;
	tm->tm_hour = ((st_time & RTC_HOUR_MASK) >> RTC_HOUR_SHIFT);
	tm->tm_min  = ((st_time & RTC_MIN_MASK) >> RTC_MIN_SHIFT);
	tm->tm_sec  = ((st_time & RTC_SEC_MASK) >> RTC_SEC_SHIFT);

	tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
	tm->tm_year -= 1900;

	return 0;
}

static int pl031_stv2_read_time(struct device *dev, struct rtc_time *tm)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);

	pl031_stv2_time_to_tm(readl(ldata->base + RTC_DR),
			readl(ldata->base + RTC_YDR), tm);

	return 0;
}

static int pl031_stv2_set_time(struct device *dev, struct rtc_time *tm)
{
	unsigned long time;
	unsigned long bcd_year;
	struct pl031_local *ldata = dev_get_drvdata(dev);
	int ret;

	ret = pl031_stv2_tm_to_time(dev, tm, &time, &bcd_year);
	if (ret == 0) {
		writel(bcd_year, ldata->base + RTC_YLR);
		writel(time, ldata->base + RTC_LR);
	}

	return ret;
}

static int pl031_stv2_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);
	int ret;

	ret = pl031_stv2_time_to_tm(readl(ldata->base + RTC_MR),
			readl(ldata->base + RTC_YMR), &alarm->time);

	alarm->pending = readl(ldata->base + RTC_RIS) & RTC_BIT_AI;
	alarm->enabled = readl(ldata->base + RTC_IMSC) & RTC_BIT_AI;

	return ret;
}

static int pl031_stv2_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);
	unsigned long time;
	unsigned long bcd_year;
	int ret;

	/* At the moment, we can only deal with non-wildcarded alarm times. */
	ret = rtc_valid_tm(&alarm->time);
	if (ret == 0) {
		ret = pl031_stv2_tm_to_time(dev, &alarm->time,
					    &time, &bcd_year);
		if (ret == 0) {
			writel(bcd_year, ldata->base + RTC_YMR);
			writel(time, ldata->base + RTC_MR);

			pl031_alarm_irq_enable(dev, alarm->enabled);
		}
	}

	return ret;
}

static irqreturn_t pl031_interrupt(int irq, void *dev_id)
{
	struct pl031_local *ldata = dev_id;
	unsigned long rtcmis;
	unsigned long events = 0;

	rtcmis = readl(ldata->base + RTC_MIS);
	if (rtcmis & RTC_BIT_AI) {
		writel(RTC_BIT_AI, ldata->base + RTC_ICR);
		events |= (RTC_AF | RTC_IRQF);
		rtc_update_irq(ldata->rtc, 1, events);

		return IRQ_HANDLED;
	}

	return IRQ_NONE;
}

static int pl031_read_time(struct device *dev, struct rtc_time *tm)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);

	rtc_time_to_tm(readl(ldata->base + RTC_DR), tm);

	return 0;
}

static int pl031_set_time(struct device *dev, struct rtc_time *tm)
{
	unsigned long time;
	struct pl031_local *ldata = dev_get_drvdata(dev);
	int ret;

	ret = rtc_tm_to_time(tm, &time);

	if (ret == 0)
		writel(time, ldata->base + RTC_LR);

	return ret;
}

static int pl031_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);

	rtc_time_to_tm(readl(ldata->base + RTC_MR), &alarm->time);

	alarm->pending = readl(ldata->base + RTC_RIS) & RTC_BIT_AI;
	alarm->enabled = readl(ldata->base + RTC_IMSC) & RTC_BIT_AI;

	return 0;
}

static int pl031_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
{
	struct pl031_local *ldata = dev_get_drvdata(dev);
	unsigned long time;
	int ret;

	/* At the moment, we can only deal with non-wildcarded alarm times. */
	ret = rtc_valid_tm(&alarm->time);
	if (ret == 0) {
		ret = rtc_tm_to_time(&alarm->time, &time);
		if (ret == 0) {
			writel(time, ldata->base + RTC_MR);
			pl031_alarm_irq_enable(dev, alarm->enabled);
		}
	}

	return ret;
}

static int pl031_remove(struct amba_device *adev)
{
	struct pl031_local *ldata = dev_get_drvdata(&adev->dev);

	dev_pm_clear_wake_irq(&adev->dev);
	device_init_wakeup(&adev->dev, false);
	free_irq(adev->irq[0], ldata);
	rtc_device_unregister(ldata->rtc);
	iounmap(ldata->base);
	kfree(ldata);
	amba_release_regions(adev);

	return 0;
}

static int pl031_probe(struct amba_device *adev, const struct amba_id *id)
{
	int ret;
	struct pl031_local *ldata;
	struct pl031_vendor_data *vendor = id->data;
	struct rtc_class_ops *ops = &vendor->ops;
	unsigned long time, data;

	ret = amba_request_regions(adev, NULL);
	if (ret)
		goto err_req;

	ldata = kzalloc(sizeof(struct pl031_local), GFP_KERNEL);
	if (!ldata) {
		ret = -ENOMEM;
		goto out;
	}
	ldata->vendor = vendor;

	ldata->base = ioremap(adev->res.start, resource_size(&adev->res));

	if (!ldata->base) {
		ret = -ENOMEM;
		goto out_no_remap;
	}

	amba_set_drvdata(adev, ldata);

	dev_dbg(&adev->dev, "designer ID = 0x%02x\n", amba_manf(adev));
	dev_dbg(&adev->dev, "revision = 0x%01x\n", amba_rev(adev));

	data = readl(ldata->base + RTC_CR);
	/* Enable the clockwatch on ST Variants */
	if (vendor->clockwatch)
		data |= RTC_CR_CWEN;
	else
		data |= RTC_CR_EN;
	writel(data, ldata->base + RTC_CR);

	/*
	 * On ST PL031 variants, the RTC reset value does not provide correct
	 * weekday for 2000-01-01. Correct the erroneous sunday to saturday.
	 */
	if (vendor->st_weekday) {
		if (readl(ldata->base + RTC_YDR) == 0x2000) {
			time = readl(ldata->base + RTC_DR);
			if ((time &
			     (RTC_MON_MASK | RTC_MDAY_MASK | RTC_WDAY_MASK))
			    == 0x02120000) {
				time = time | (0x7 << RTC_WDAY_SHIFT);
				writel(0x2000, ldata->base + RTC_YLR);
				writel(time, ldata->base + RTC_LR);
			}
		}
	}

	device_init_wakeup(&adev->dev, true);
	ldata->rtc = rtc_device_register("pl031", &adev->dev, ops,
					THIS_MODULE);
	if (IS_ERR(ldata->rtc)) {
		ret = PTR_ERR(ldata->rtc);
		goto out_no_rtc;
	}

	if (request_irq(adev->irq[0], pl031_interrupt,
			vendor->irqflags, "rtc-pl031", ldata)) {
		ret = -EIO;
		goto out_no_irq;
	}
	dev_pm_set_wake_irq(&adev->dev, adev->irq[0]);
	return 0;

out_no_irq:
	rtc_device_unregister(ldata->rtc);
out_no_rtc:
	iounmap(ldata->base);
out_no_remap:
	kfree(ldata);
out:
	amba_release_regions(adev);
err_req:

	return ret;
}

/* Operations for the original ARM version */
static struct pl031_vendor_data arm_pl031 = {
	.ops = {
		.read_time = pl031_read_time,
		.set_time = pl031_set_time,
		.read_alarm = pl031_read_alarm,
		.set_alarm = pl031_set_alarm,
		.alarm_irq_enable = pl031_alarm_irq_enable,
	},
};

/* The First ST derivative */
static struct pl031_vendor_data stv1_pl031 = {
	.ops = {
		.read_time = pl031_read_time,
		.set_time = pl031_set_time,
		.read_alarm = pl031_read_alarm,
		.set_alarm = pl031_set_alarm,
		.alarm_irq_enable = pl031_alarm_irq_enable,
	},
	.clockwatch = true,
	.st_weekday = true,
};

/* And the second ST derivative */
static struct pl031_vendor_data stv2_pl031 = {
	.ops = {
		.read_time = pl031_stv2_read_time,
		.set_time = pl031_stv2_set_time,
		.read_alarm = pl031_stv2_read_alarm,
		.set_alarm = pl031_stv2_set_alarm,
		.alarm_irq_enable = pl031_alarm_irq_enable,
	},
	.clockwatch = true,
	.st_weekday = true,
	/*
	 * This variant shares the IRQ with another block and must not
	 * suspend that IRQ line.
	 * TODO check if it shares with IRQF_NO_SUSPEND user, else we can
	 * remove IRQF_COND_SUSPEND
	 */
	.irqflags = IRQF_SHARED | IRQF_COND_SUSPEND,
};

static struct amba_id pl031_ids[] = {
	{
		.id = 0x00041031,
		.mask = 0x000fffff,
		.data = &arm_pl031,
	},
	/* ST Micro variants */
	{
		.id = 0x00180031,
		.mask = 0x00ffffff,
		.data = &stv1_pl031,
	},
	{
		.id = 0x00280031,
		.mask = 0x00ffffff,
		.data = &stv2_pl031,
	},
	{0, 0},
};

MODULE_DEVICE_TABLE(amba, pl031_ids);

static struct amba_driver pl031_driver = {
	.drv = {
		.name = "rtc-pl031",
	},
	.id_table = pl031_ids,
	.probe = pl031_probe,
	.remove = pl031_remove,
};

module_amba_driver(pl031_driver);

MODULE_AUTHOR("Deepak Saxena <dsaxena@plexity.net>");
MODULE_DESCRIPTION("ARM AMBA PL031 RTC Driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
8ae6e163 DS	1	/*
	2	* drivers/rtc/rtc-pl031.c
	3	*
	4	* Real Time Clock interface for ARM AMBA PrimeCell 031 RTC
	5	*
	6	* Author: Deepak Saxena <dsaxena@plexity.net>
	7	*
	8	* Copyright 2006 (c) MontaVista Software, Inc.
	9	*
c72881e8 LW	10	* Author: Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>
	11	* Copyright 2010 (c) ST-Ericsson AB
	12	*
8ae6e163 DS	13	* This program is free software; you can redistribute it and/or
	14	* modify it under the terms of the GNU General Public License
	15	* as published by the Free Software Foundation; either version
	16	* 2 of the License, or (at your option) any later version.
	17	*/
8ae6e163 DS	18	#include <linux/module.h>
	19	#include <linux/rtc.h>
	20	#include <linux/init.h>
8ae6e163	21	#include <linux/interrupt.h>
8ae6e163	22	#include <linux/amba/bus.h>
2dba8518	23	#include <linux/io.h>
c72881e8 LW	24	#include <linux/bcd.h>
c72881e8 LW	25	#include <linux/delay.h>
eff6dd41	26	#include <linux/pm_wakeirq.h>
5a0e3ad6	27	#include <linux/slab.h>
8ae6e163 DS	28
	29	/*
	30	* Register definitions
	31	*/
	32	#define RTC_DR 0x00 /* Data read register */
	33	#define RTC_MR 0x04 /* Match register */
	34	#define RTC_LR 0x08 /* Data load register */
	35	#define RTC_CR 0x0c /* Control register */
	36	#define RTC_IMSC 0x10 /* Interrupt mask and set register */
	37	#define RTC_RIS 0x14 /* Raw interrupt status register */
	38	#define RTC_MIS 0x18 /* Masked interrupt status register */
	39	#define RTC_ICR 0x1c /* Interrupt clear register */
c72881e8 LW	40	/* ST variants have additional timer functionality */
	41	#define RTC_TDR 0x20 /* Timer data read register */
	42	#define RTC_TLR 0x24 /* Timer data load register */
	43	#define RTC_TCR 0x28 /* Timer control register */
	44	#define RTC_YDR 0x30 /* Year data read register */
	45	#define RTC_YMR 0x34 /* Year match register */
	46	#define RTC_YLR 0x38 /* Year data load register */
	47
e7e034e1	48	#define RTC_CR_EN (1 << 0) /* counter enable bit */
c72881e8 LW	49	#define RTC_CR_CWEN (1 << 26) /* Clockwatch enable bit */
	50
	51	#define RTC_TCR_EN (1 << 1) /* Periodic timer enable bit */
	52
	53	/* Common bit definitions for Interrupt status and control registers */
	54	#define RTC_BIT_AI (1 << 0) /* Alarm interrupt bit */
	55	#define RTC_BIT_PI (1 << 1) /* Periodic interrupt bit. ST variants only. */
	56
	57	/* Common bit definations for ST v2 for reading/writing time */
	58	#define RTC_SEC_SHIFT 0
	59	#define RTC_SEC_MASK (0x3F << RTC_SEC_SHIFT) /* Second [0-59] */
	60	#define RTC_MIN_SHIFT 6
	61	#define RTC_MIN_MASK (0x3F << RTC_MIN_SHIFT) /* Minute [0-59] */
	62	#define RTC_HOUR_SHIFT 12
	63	#define RTC_HOUR_MASK (0x1F << RTC_HOUR_SHIFT) /* Hour [0-23] */
	64	#define RTC_WDAY_SHIFT 17
	65	#define RTC_WDAY_MASK (0x7 << RTC_WDAY_SHIFT) /* Day of Week [1-7] 1=Sunday */
	66	#define RTC_MDAY_SHIFT 20
	67	#define RTC_MDAY_MASK (0x1F << RTC_MDAY_SHIFT) /* Day of Month [1-31] */
	68	#define RTC_MON_SHIFT 25
	69	#define RTC_MON_MASK (0xF << RTC_MON_SHIFT) /* Month [1-12] 1=January */
	70
	71	#define RTC_TIMER_FREQ 32768
8ae6e163	72
aff05ed5 LW	73	/**
	74	* struct pl031_vendor_data - per-vendor variations
	75	* @ops: the vendor-specific operations used on this silicon version
1bb457fc LW	76	* @clockwatch: if this is an ST Microelectronics silicon version with a
	77	* clockwatch function
	78	* @st_weekday: if this is an ST Microelectronics silicon version that need
	79	* the weekday fix
559a6fc0	80	* @irqflags: special IRQ flags per variant
aff05ed5 LW	81	*/
	82	struct pl031_vendor_data {
	83	struct rtc_class_ops ops;
1bb457fc LW	84	bool clockwatch;
1bb457fc LW	85	bool st_weekday;
559a6fc0	86	unsigned long irqflags;
aff05ed5 LW	87	};
aff05ed5 LW	88
8ae6e163	89	struct pl031_local {
aff05ed5	90	struct pl031_vendor_data *vendor;
8ae6e163 DS	91	struct rtc_device *rtc;
	92	void __iomem *base;
	93	};
	94
c72881e8 LW	95	static int pl031_alarm_irq_enable(struct device *dev,
	96	unsigned int enabled)
	97	{
	98	struct pl031_local *ldata = dev_get_drvdata(dev);
	99	unsigned long imsc;
	100
	101	/* Clear any pending alarm interrupts. */
	102	writel(RTC_BIT_AI, ldata->base + RTC_ICR);
	103
	104	imsc = readl(ldata->base + RTC_IMSC);
	105
	106	if (enabled == 1)
	107	writel(imsc \| RTC_BIT_AI, ldata->base + RTC_IMSC);
	108	else
	109	writel(imsc & ~RTC_BIT_AI, ldata->base + RTC_IMSC);
	110
	111	return 0;
	112	}
	113
	114	/*
	115	* Convert Gregorian date to ST v2 RTC format.
	116	*/
	117	static int pl031_stv2_tm_to_time(struct device *dev,
	118	struct rtc_time tm, unsigned long st_time,
	119	unsigned long *bcd_year)
	120	{
	121	int year = tm->tm_year + 1900;
	122	int wday = tm->tm_wday;
	123
	124	/* wday masking is not working in hardware so wday must be valid */
	125	if (wday < -1 \|\| wday > 6) {
	126	dev_err(dev, "invalid wday value %d\n", tm->tm_wday);
	127	return -EINVAL;
	128	} else if (wday == -1) {
	129	/* wday is not provided, calculate it here */
	130	unsigned long time;
	131	struct rtc_time calc_tm;
	132
	133	rtc_tm_to_time(tm, &time);
	134	rtc_time_to_tm(time, &calc_tm);
	135	wday = calc_tm.tm_wday;
	136	}
	137
	138	*bcd_year = (bin2bcd(year % 100) \| bin2bcd(year / 100) << 8);
	139
	140	*st_time = ((tm->tm_mon + 1) << RTC_MON_SHIFT)
	141	\| (tm->tm_mday << RTC_MDAY_SHIFT)
	142	\| ((wday + 1) << RTC_WDAY_SHIFT)
	143	\| (tm->tm_hour << RTC_HOUR_SHIFT)
	144	\| (tm->tm_min << RTC_MIN_SHIFT)
	145	\| (tm->tm_sec << RTC_SEC_SHIFT);
	146
	147	return 0;
	148	}
	149
	150	/*
	151	* Convert ST v2 RTC format to Gregorian date.
	152	*/
	153	static int pl031_stv2_time_to_tm(unsigned long st_time, unsigned long bcd_year,
	154	struct rtc_time *tm)
	155	{
	156	tm->tm_year = bcd2bin(bcd_year) + (bcd2bin(bcd_year >> 8) * 100);
	157	tm->tm_mon = ((st_time & RTC_MON_MASK) >> RTC_MON_SHIFT) - 1;
	158	tm->tm_mday = ((st_time & RTC_MDAY_MASK) >> RTC_MDAY_SHIFT);
159	tm->tm_wday = ((st_time & RTC_WDAY_MASK) >> RTC_WDAY_SHIFT) - 1;
160	tm->tm_hour = ((st_time & RTC_HOUR_MASK) >> RTC_HOUR_SHIFT);
161	tm->tm_min = ((st_time & RTC_MIN_MASK) >> RTC_MIN_SHIFT);
162	tm->tm_sec = ((st_time & RTC_SEC_MASK) >> RTC_SEC_SHIFT);
163
164	tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
165	tm->tm_year -= 1900;
166
167	return 0;
168	}
169
170	static int pl031_stv2_read_time(struct device dev, struct rtc_time tm)
171	{
172	struct pl031_local *ldata = dev_get_drvdata(dev);
173
174	pl031_stv2_time_to_tm(readl(ldata->base + RTC_DR),
175	readl(ldata->base + RTC_YDR), tm);
176
177	return 0;
178	}
179
180	static int pl031_stv2_set_time(struct device dev, struct rtc_time tm)
181	{
182	unsigned long time;
183	unsigned long bcd_year;
184	struct pl031_local *ldata = dev_get_drvdata(dev);
185	int ret;
186
187	ret = pl031_stv2_tm_to_time(dev, tm, &time, &bcd_year);
188	if (ret == 0) {
189	writel(bcd_year, ldata->base + RTC_YLR);
190	writel(time, ldata->base + RTC_LR);
191	}
192
193	return ret;
194	}
195
196	static int pl031_stv2_read_alarm(struct device dev, struct rtc_wkalrm alarm)
8ae6e163	197	{
c72881e8 LW	198	struct pl031_local *ldata = dev_get_drvdata(dev);
c72881e8 LW	199	int ret;
8ae6e163	200
c72881e8 LW	201	ret = pl031_stv2_time_to_tm(readl(ldata->base + RTC_MR),
c72881e8 LW	202	readl(ldata->base + RTC_YMR), &alarm->time);
8ae6e163	203
c72881e8 LW	204	alarm->pending = readl(ldata->base + RTC_RIS) & RTC_BIT_AI;
	205	alarm->enabled = readl(ldata->base + RTC_IMSC) & RTC_BIT_AI;
	206
	207	return ret;
8ae6e163 DS	208	}
8ae6e163 DS	209
c72881e8	210	static int pl031_stv2_set_alarm(struct device dev, struct rtc_wkalrm alarm)
8ae6e163 DS	211	{
8ae6e163 DS	212	struct pl031_local *ldata = dev_get_drvdata(dev);
c72881e8 LW	213	unsigned long time;
	214	unsigned long bcd_year;
	215	int ret;
	216
	217	/* At the moment, we can only deal with non-wildcarded alarm times. */
	218	ret = rtc_valid_tm(&alarm->time);
	219	if (ret == 0) {
	220	ret = pl031_stv2_tm_to_time(dev, &alarm->time,
	221	&time, &bcd_year);
	222	if (ret == 0) {
	223	writel(bcd_year, ldata->base + RTC_YMR);
	224	writel(time, ldata->base + RTC_MR);
	225
	226	pl031_alarm_irq_enable(dev, alarm->enabled);
	227	}
	228	}
	229
	230	return ret;
	231	}
	232
	233	static irqreturn_t pl031_interrupt(int irq, void *dev_id)
	234	{
	235	struct pl031_local *ldata = dev_id;
	236	unsigned long rtcmis;
	237	unsigned long events = 0;
	238
	239	rtcmis = readl(ldata->base + RTC_MIS);
ac2dee59 RK	240	if (rtcmis & RTC_BIT_AI) {
	241	writel(RTC_BIT_AI, ldata->base + RTC_ICR);
	242	events \|= (RTC_AF \| RTC_IRQF);
c72881e8	243	rtc_update_irq(ldata->rtc, 1, events);
8ae6e163	244
c72881e8	245	return IRQ_HANDLED;
8ae6e163 DS	246	}
8ae6e163 DS	247
c72881e8	248	return IRQ_NONE;
8ae6e163 DS	249	}
	250
	251	static int pl031_read_time(struct device dev, struct rtc_time tm)
	252	{
	253	struct pl031_local *ldata = dev_get_drvdata(dev);
	254
2934d6a8	255	rtc_time_to_tm(readl(ldata->base + RTC_DR), tm);
8ae6e163 DS	256
	257	return 0;
	258	}
	259
	260	static int pl031_set_time(struct device dev, struct rtc_time tm)
	261	{
	262	unsigned long time;
	263	struct pl031_local *ldata = dev_get_drvdata(dev);
c72881e8	264	int ret;
8ae6e163	265
c72881e8	266	ret = rtc_tm_to_time(tm, &time);
8ae6e163	267
c72881e8 LW	268	if (ret == 0)
	269	writel(time, ldata->base + RTC_LR);
	270
	271	return ret;
8ae6e163 DS	272	}
	273
	274	static int pl031_read_alarm(struct device dev, struct rtc_wkalrm alarm)
	275	{
	276	struct pl031_local *ldata = dev_get_drvdata(dev);
	277
2934d6a8	278	rtc_time_to_tm(readl(ldata->base + RTC_MR), &alarm->time);
c72881e8 LW	279
	280	alarm->pending = readl(ldata->base + RTC_RIS) & RTC_BIT_AI;
	281	alarm->enabled = readl(ldata->base + RTC_IMSC) & RTC_BIT_AI;
8ae6e163 DS	282
	283	return 0;
	284	}
	285
	286	static int pl031_set_alarm(struct device dev, struct rtc_wkalrm alarm)
	287	{
	288	struct pl031_local *ldata = dev_get_drvdata(dev);
	289	unsigned long time;
c72881e8 LW	290	int ret;
	291
	292	/* At the moment, we can only deal with non-wildcarded alarm times. */
	293	ret = rtc_valid_tm(&alarm->time);
	294	if (ret == 0) {
	295	ret = rtc_tm_to_time(&alarm->time, &time);
	296	if (ret == 0) {
	297	writel(time, ldata->base + RTC_MR);
	298	pl031_alarm_irq_enable(dev, alarm->enabled);
	299	}
	300	}
	301
	302	return ret;
	303	}
	304
8ae6e163 DS	305	static int pl031_remove(struct amba_device *adev)
	306	{
	307	struct pl031_local *ldata = dev_get_drvdata(&adev->dev);
	308
eff6dd41 SH	309	dev_pm_clear_wake_irq(&adev->dev);
eff6dd41 SH	310	device_init_wakeup(&adev->dev, false);
cac29af6	311	free_irq(adev->irq[0], ldata);
2dba8518 RK	312	rtc_device_unregister(ldata->rtc);
	313	iounmap(ldata->base);
	314	kfree(ldata);
	315	amba_release_regions(adev);
8ae6e163 DS	316
	317	return 0;
	318	}
	319
aa25afad	320	static int pl031_probe(struct amba_device adev, const struct amba_id id)
8ae6e163 DS	321	{
	322	int ret;
	323	struct pl031_local *ldata;
aff05ed5 LW	324	struct pl031_vendor_data *vendor = id->data;
aff05ed5 LW	325	struct rtc_class_ops *ops = &vendor->ops;
e7e034e1	326	unsigned long time, data;
8ae6e163	327
2dba8518 RK	328	ret = amba_request_regions(adev, NULL);
	329	if (ret)
	330	goto err_req;
8ae6e163	331
c72881e8	332	ldata = kzalloc(sizeof(struct pl031_local), GFP_KERNEL);
8ae6e163 DS	333	if (!ldata) {
	334	ret = -ENOMEM;
	335	goto out;
	336	}
aff05ed5	337	ldata->vendor = vendor;
8ae6e163	338
dc890c2d	339	ldata->base = ioremap(adev->res.start, resource_size(&adev->res));
c72881e8	340
8ae6e163 DS	341	if (!ldata->base) {
	342	ret = -ENOMEM;
	343	goto out_no_remap;
	344	}
	345
2dba8518 RK	346	amba_set_drvdata(adev, ldata);
2dba8518 RK	347
1bb457fc LW	348	dev_dbg(&adev->dev, "designer ID = 0x%02x\n", amba_manf(adev));
1bb457fc LW	349	dev_dbg(&adev->dev, "revision = 0x%01x\n", amba_rev(adev));
8ae6e163	350
e7e034e1	351	data = readl(ldata->base + RTC_CR);
c72881e8	352	/* Enable the clockwatch on ST Variants */
1bb457fc	353	if (vendor->clockwatch)
e7e034e1	354	data \|= RTC_CR_CWEN;
3399cfb5 LW	355	else
	356	data \|= RTC_CR_EN;
	357	writel(data, ldata->base + RTC_CR);
c72881e8	358
c0a5f4a0 RK	359	/*
	360	* On ST PL031 variants, the RTC reset value does not provide correct
	361	* weekday for 2000-01-01. Correct the erroneous sunday to saturday.
	362	*/
1bb457fc	363	if (vendor->st_weekday) {
c0a5f4a0 RK	364	if (readl(ldata->base + RTC_YDR) == 0x2000) {
	365	time = readl(ldata->base + RTC_DR);
	366	if ((time &
	367	(RTC_MON_MASK \| RTC_MDAY_MASK \| RTC_WDAY_MASK))
	368	== 0x02120000) {
	369	time = time \| (0x7 << RTC_WDAY_SHIFT);
	370	writel(0x2000, ldata->base + RTC_YLR);
	371	writel(time, ldata->base + RTC_LR);
	372	}
	373	}
	374	}
	375
eff6dd41	376	device_init_wakeup(&adev->dev, true);
c72881e8 LW	377	ldata->rtc = rtc_device_register("pl031", &adev->dev, ops,
c72881e8 LW	378	THIS_MODULE);
8ae6e163 DS	379	if (IS_ERR(ldata->rtc)) {
	380	ret = PTR_ERR(ldata->rtc);
	381	goto out_no_rtc;
	382	}
	383
c72881e8	384	if (request_irq(adev->irq[0], pl031_interrupt,
559a6fc0	385	vendor->irqflags, "rtc-pl031", ldata)) {
c72881e8 LW	386	ret = -EIO;
	387	goto out_no_irq;
	388	}
eff6dd41	389	dev_pm_set_wake_irq(&adev->dev, adev->irq[0]);
8ae6e163 DS	390	return 0;
8ae6e163 DS	391
8ae6e163	392	out_no_irq:
c72881e8 LW	393	rtc_device_unregister(ldata->rtc);
c72881e8 LW	394	out_no_rtc:
8ae6e163 DS	395	iounmap(ldata->base);
8ae6e163 DS	396	out_no_remap:
8ae6e163 DS	397	kfree(ldata);
8ae6e163 DS	398	out:
2dba8518 RK	399	amba_release_regions(adev);
2dba8518 RK	400	err_req:
c72881e8	401
8ae6e163 DS	402	return ret;
	403	}
	404
c72881e8	405	/* Operations for the original ARM version */
aff05ed5 LW	406	static struct pl031_vendor_data arm_pl031 = {
	407	.ops = {
	408	.read_time = pl031_read_time,
	409	.set_time = pl031_set_time,
	410	.read_alarm = pl031_read_alarm,
	411	.set_alarm = pl031_set_alarm,
	412	.alarm_irq_enable = pl031_alarm_irq_enable,
	413	},
c72881e8 LW	414	};
	415
	416	/* The First ST derivative */
aff05ed5 LW	417	static struct pl031_vendor_data stv1_pl031 = {
	418	.ops = {
	419	.read_time = pl031_read_time,
	420	.set_time = pl031_set_time,
	421	.read_alarm = pl031_read_alarm,
	422	.set_alarm = pl031_set_alarm,
	423	.alarm_irq_enable = pl031_alarm_irq_enable,
	424	},
1bb457fc LW	425	.clockwatch = true,
1bb457fc LW	426	.st_weekday = true,
c72881e8 LW	427	};
	428
	429	/* And the second ST derivative */
aff05ed5 LW	430	static struct pl031_vendor_data stv2_pl031 = {
	431	.ops = {
	432	.read_time = pl031_stv2_read_time,
	433	.set_time = pl031_stv2_set_time,
	434	.read_alarm = pl031_stv2_read_alarm,
	435	.set_alarm = pl031_stv2_set_alarm,
	436	.alarm_irq_enable = pl031_alarm_irq_enable,
	437	},
1bb457fc LW	438	.clockwatch = true,
1bb457fc LW	439	.st_weekday = true,
559a6fc0 MW	440	/*
	441	* This variant shares the IRQ with another block and must not
	442	* suspend that IRQ line.
eff6dd41 SH	443	* TODO check if it shares with IRQF_NO_SUSPEND user, else we can
eff6dd41 SH	444	* remove IRQF_COND_SUSPEND
559a6fc0	445	*/
eff6dd41	446	.irqflags = IRQF_SHARED \| IRQF_COND_SUSPEND,
c72881e8 LW	447	};
c72881e8 LW	448
2c39c9e1	449	static struct amba_id pl031_ids[] = {
8ae6e163	450	{
2934d6a8 LW	451	.id = 0x00041031,
2934d6a8 LW	452	.mask = 0x000fffff,
aff05ed5	453	.data = &arm_pl031,
c72881e8 LW	454	},
	455	/* ST Micro variants */
	456	{
	457	.id = 0x00180031,
	458	.mask = 0x00ffffff,
aff05ed5	459	.data = &stv1_pl031,
c72881e8 LW	460	},
	461	{
	462	.id = 0x00280031,
	463	.mask = 0x00ffffff,
aff05ed5	464	.data = &stv2_pl031,
2934d6a8	465	},
8ae6e163 DS	466	{0, 0},
	467	};
	468
f5feac2a DM	469	MODULE_DEVICE_TABLE(amba, pl031_ids);
f5feac2a DM	470
8ae6e163 DS	471	static struct amba_driver pl031_driver = {
	472	.drv = {
	473	.name = "rtc-pl031",
	474	},
	475	.id_table = pl031_ids,
	476	.probe = pl031_probe,
	477	.remove = pl031_remove,
	478	};
	479
9e5ed094	480	module_amba_driver(pl031_driver);
8ae6e163	481
27675ef0	482	MODULE_AUTHOR("Deepak Saxena <dsaxena@plexity.net>");
8ae6e163 DS	483	MODULE_DESCRIPTION("ARM AMBA PL031 RTC Driver");
8ae6e163 DS	484	MODULE_LICENSE("GPL");