blob: c24d1e18f56c96f4ee08b53f0b0e285bb84cd93c [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
David Brownellf96411a2008-10-20 23:50:05 +02002/*
Balaji T Kef3b7d02009-12-13 21:30:48 +01003 * rtc-twl.c -- TWL Real Time Clock interface
David Brownellf96411a2008-10-20 23:50:05 +02004 *
5 * Copyright (C) 2007 MontaVista Software, Inc
6 * Author: Alexandre Rusev <source@mvista.com>
7 *
8 * Based on original TI driver twl4030-rtc.c
9 * Copyright (C) 2006 Texas Instruments, Inc.
10 *
11 * Based on rtc-omap.c
12 * Copyright (C) 2003 MontaVista Software, Inc.
13 * Author: George G. Davis <gdavis@mvista.com> or <source@mvista.com>
14 * Copyright (C) 2006 David Brownell
David Brownellf96411a2008-10-20 23:50:05 +020015 */
16
Joe Perchesa737e832015-04-16 12:46:14 -070017#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
David Brownellf96411a2008-10-20 23:50:05 +020019#include <linux/kernel.h>
Anton Vorontsov2fac6672009-01-06 14:42:11 -080020#include <linux/errno.h>
David Brownellf96411a2008-10-20 23:50:05 +020021#include <linux/init.h>
22#include <linux/module.h>
23#include <linux/types.h>
24#include <linux/rtc.h>
25#include <linux/bcd.h>
26#include <linux/platform_device.h>
27#include <linux/interrupt.h>
Sachin Kamatc8a60462013-02-21 16:44:28 -080028#include <linux/of.h>
David Brownellf96411a2008-10-20 23:50:05 +020029
Wolfram Sanga2054252017-08-14 18:34:24 +020030#include <linux/mfd/twl.h>
David Brownellf96411a2008-10-20 23:50:05 +020031
Nicolae Rosiae3e7f952016-11-23 10:55:56 +020032enum twl_class {
33 TWL_4030 = 0,
34 TWL_6030,
35};
David Brownellf96411a2008-10-20 23:50:05 +020036
37/*
38 * RTC block register offsets (use TWL_MODULE_RTC)
39 */
Balaji T Ka6b49ff2009-12-13 22:16:31 +010040enum {
41 REG_SECONDS_REG = 0,
42 REG_MINUTES_REG,
43 REG_HOURS_REG,
44 REG_DAYS_REG,
45 REG_MONTHS_REG,
46 REG_YEARS_REG,
47 REG_WEEKS_REG,
David Brownellf96411a2008-10-20 23:50:05 +020048
Balaji T Ka6b49ff2009-12-13 22:16:31 +010049 REG_ALARM_SECONDS_REG,
50 REG_ALARM_MINUTES_REG,
51 REG_ALARM_HOURS_REG,
52 REG_ALARM_DAYS_REG,
53 REG_ALARM_MONTHS_REG,
54 REG_ALARM_YEARS_REG,
David Brownellf96411a2008-10-20 23:50:05 +020055
Balaji T Ka6b49ff2009-12-13 22:16:31 +010056 REG_RTC_CTRL_REG,
57 REG_RTC_STATUS_REG,
58 REG_RTC_INTERRUPTS_REG,
David Brownellf96411a2008-10-20 23:50:05 +020059
Balaji T Ka6b49ff2009-12-13 22:16:31 +010060 REG_RTC_COMP_LSB_REG,
61 REG_RTC_COMP_MSB_REG,
62};
Tobias Klauser2e840672010-03-05 13:44:23 -080063static const u8 twl4030_rtc_reg_map[] = {
Balaji T Ka6b49ff2009-12-13 22:16:31 +010064 [REG_SECONDS_REG] = 0x00,
65 [REG_MINUTES_REG] = 0x01,
66 [REG_HOURS_REG] = 0x02,
67 [REG_DAYS_REG] = 0x03,
68 [REG_MONTHS_REG] = 0x04,
69 [REG_YEARS_REG] = 0x05,
70 [REG_WEEKS_REG] = 0x06,
71
72 [REG_ALARM_SECONDS_REG] = 0x07,
73 [REG_ALARM_MINUTES_REG] = 0x08,
74 [REG_ALARM_HOURS_REG] = 0x09,
75 [REG_ALARM_DAYS_REG] = 0x0A,
76 [REG_ALARM_MONTHS_REG] = 0x0B,
77 [REG_ALARM_YEARS_REG] = 0x0C,
78
79 [REG_RTC_CTRL_REG] = 0x0D,
80 [REG_RTC_STATUS_REG] = 0x0E,
81 [REG_RTC_INTERRUPTS_REG] = 0x0F,
82
83 [REG_RTC_COMP_LSB_REG] = 0x10,
84 [REG_RTC_COMP_MSB_REG] = 0x11,
85};
Tobias Klauser2e840672010-03-05 13:44:23 -080086static const u8 twl6030_rtc_reg_map[] = {
Balaji T Ka6b49ff2009-12-13 22:16:31 +010087 [REG_SECONDS_REG] = 0x00,
88 [REG_MINUTES_REG] = 0x01,
89 [REG_HOURS_REG] = 0x02,
90 [REG_DAYS_REG] = 0x03,
91 [REG_MONTHS_REG] = 0x04,
92 [REG_YEARS_REG] = 0x05,
93 [REG_WEEKS_REG] = 0x06,
94
95 [REG_ALARM_SECONDS_REG] = 0x08,
96 [REG_ALARM_MINUTES_REG] = 0x09,
97 [REG_ALARM_HOURS_REG] = 0x0A,
98 [REG_ALARM_DAYS_REG] = 0x0B,
99 [REG_ALARM_MONTHS_REG] = 0x0C,
100 [REG_ALARM_YEARS_REG] = 0x0D,
101
102 [REG_RTC_CTRL_REG] = 0x10,
103 [REG_RTC_STATUS_REG] = 0x11,
104 [REG_RTC_INTERRUPTS_REG] = 0x12,
105
106 [REG_RTC_COMP_LSB_REG] = 0x13,
107 [REG_RTC_COMP_MSB_REG] = 0x14,
108};
David Brownellf96411a2008-10-20 23:50:05 +0200109
110/* RTC_CTRL_REG bitfields */
111#define BIT_RTC_CTRL_REG_STOP_RTC_M 0x01
112#define BIT_RTC_CTRL_REG_ROUND_30S_M 0x02
113#define BIT_RTC_CTRL_REG_AUTO_COMP_M 0x04
114#define BIT_RTC_CTRL_REG_MODE_12_24_M 0x08
115#define BIT_RTC_CTRL_REG_TEST_MODE_M 0x10
116#define BIT_RTC_CTRL_REG_SET_32_COUNTER_M 0x20
117#define BIT_RTC_CTRL_REG_GET_TIME_M 0x40
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700118#define BIT_RTC_CTRL_REG_RTC_V_OPT 0x80
David Brownellf96411a2008-10-20 23:50:05 +0200119
120/* RTC_STATUS_REG bitfields */
121#define BIT_RTC_STATUS_REG_RUN_M 0x02
122#define BIT_RTC_STATUS_REG_1S_EVENT_M 0x04
123#define BIT_RTC_STATUS_REG_1M_EVENT_M 0x08
124#define BIT_RTC_STATUS_REG_1H_EVENT_M 0x10
125#define BIT_RTC_STATUS_REG_1D_EVENT_M 0x20
126#define BIT_RTC_STATUS_REG_ALARM_M 0x40
127#define BIT_RTC_STATUS_REG_POWER_UP_M 0x80
128
129/* RTC_INTERRUPTS_REG bitfields */
130#define BIT_RTC_INTERRUPTS_REG_EVERY_M 0x03
131#define BIT_RTC_INTERRUPTS_REG_IT_TIMER_M 0x04
132#define BIT_RTC_INTERRUPTS_REG_IT_ALARM_M 0x08
133
134
135/* REG_SECONDS_REG through REG_YEARS_REG is how many registers? */
136#define ALL_TIME_REGS 6
137
138/*----------------------------------------------------------------------*/
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200139struct twl_rtc {
140 struct device *dev;
141 struct rtc_device *rtc;
142 u8 *reg_map;
143 /*
144 * Cache the value for timer/alarm interrupts register; this is
145 * only changed by callers holding rtc ops lock (or resume).
146 */
147 unsigned char rtc_irq_bits;
148 bool wake_enabled;
149#ifdef CONFIG_PM_SLEEP
150 unsigned char irqstat;
151#endif
152 enum twl_class class;
153};
David Brownellf96411a2008-10-20 23:50:05 +0200154
155/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100156 * Supports 1 byte read from TWL RTC register.
David Brownellf96411a2008-10-20 23:50:05 +0200157 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200158static int twl_rtc_read_u8(struct twl_rtc *twl_rtc, u8 *data, u8 reg)
David Brownellf96411a2008-10-20 23:50:05 +0200159{
160 int ret;
161
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200162 ret = twl_i2c_read_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
David Brownellf96411a2008-10-20 23:50:05 +0200163 if (ret < 0)
Joe Perchesa737e832015-04-16 12:46:14 -0700164 pr_err("Could not read TWL register %X - error %d\n", reg, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200165 return ret;
166}
167
168/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100169 * Supports 1 byte write to TWL RTC registers.
David Brownellf96411a2008-10-20 23:50:05 +0200170 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200171static int twl_rtc_write_u8(struct twl_rtc *twl_rtc, u8 data, u8 reg)
David Brownellf96411a2008-10-20 23:50:05 +0200172{
173 int ret;
174
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200175 ret = twl_i2c_write_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
David Brownellf96411a2008-10-20 23:50:05 +0200176 if (ret < 0)
Joe Perchesa737e832015-04-16 12:46:14 -0700177 pr_err("Could not write TWL register %X - error %d\n",
178 reg, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200179 return ret;
180}
181
182/*
Alessandro Zummoa7483842009-01-15 13:50:52 -0800183 * Enable 1/second update and/or alarm interrupts.
David Brownellf96411a2008-10-20 23:50:05 +0200184 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200185static int set_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
David Brownellf96411a2008-10-20 23:50:05 +0200186{
187 unsigned char val;
188 int ret;
189
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700190 /* if the bit is set, return from here */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200191 if (twl_rtc->rtc_irq_bits & bit)
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700192 return 0;
193
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200194 val = twl_rtc->rtc_irq_bits | bit;
Alessandro Zummoa7483842009-01-15 13:50:52 -0800195 val &= ~BIT_RTC_INTERRUPTS_REG_EVERY_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200196 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200197 if (ret == 0)
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200198 twl_rtc->rtc_irq_bits = val;
David Brownellf96411a2008-10-20 23:50:05 +0200199
200 return ret;
201}
202
203/*
Alessandro Zummoa7483842009-01-15 13:50:52 -0800204 * Disable update and/or alarm interrupts.
David Brownellf96411a2008-10-20 23:50:05 +0200205 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200206static int mask_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
David Brownellf96411a2008-10-20 23:50:05 +0200207{
208 unsigned char val;
209 int ret;
210
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700211 /* if the bit is clear, return from here */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200212 if (!(twl_rtc->rtc_irq_bits & bit))
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700213 return 0;
214
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200215 val = twl_rtc->rtc_irq_bits & ~bit;
216 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200217 if (ret == 0)
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200218 twl_rtc->rtc_irq_bits = val;
David Brownellf96411a2008-10-20 23:50:05 +0200219
220 return ret;
221}
222
Balaji T Kef3b7d02009-12-13 21:30:48 +0100223static int twl_rtc_alarm_irq_enable(struct device *dev, unsigned enabled)
David Brownellf96411a2008-10-20 23:50:05 +0200224{
Kevin Hilmanae845892013-07-03 15:07:53 -0700225 struct platform_device *pdev = to_platform_device(dev);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200226 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
Kevin Hilmanae845892013-07-03 15:07:53 -0700227 int irq = platform_get_irq(pdev, 0);
David Brownellf96411a2008-10-20 23:50:05 +0200228 int ret;
229
Kevin Hilmanae845892013-07-03 15:07:53 -0700230 if (enabled) {
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200231 ret = set_rtc_irq_bit(twl_rtc,
232 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
233 if (device_can_wakeup(dev) && !twl_rtc->wake_enabled) {
Kevin Hilmanae845892013-07-03 15:07:53 -0700234 enable_irq_wake(irq);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200235 twl_rtc->wake_enabled = true;
Kevin Hilmanae845892013-07-03 15:07:53 -0700236 }
237 } else {
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200238 ret = mask_rtc_irq_bit(twl_rtc,
239 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
240 if (twl_rtc->wake_enabled) {
Kevin Hilmanae845892013-07-03 15:07:53 -0700241 disable_irq_wake(irq);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200242 twl_rtc->wake_enabled = false;
Kevin Hilmanae845892013-07-03 15:07:53 -0700243 }
244 }
David Brownellf96411a2008-10-20 23:50:05 +0200245
246 return ret;
247}
248
David Brownellf96411a2008-10-20 23:50:05 +0200249/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100250 * Gets current TWL RTC time and date parameters.
David Brownellf96411a2008-10-20 23:50:05 +0200251 *
252 * The RTC's time/alarm representation is not what gmtime(3) requires
253 * Linux to use:
254 *
255 * - Months are 1..12 vs Linux 0-11
256 * - Years are 0..99 vs Linux 1900..N (we assume 21st century)
257 */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100258static int twl_rtc_read_time(struct device *dev, struct rtc_time *tm)
David Brownellf96411a2008-10-20 23:50:05 +0200259{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200260 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100261 unsigned char rtc_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200262 int ret;
263 u8 save_control;
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700264 u8 rtc_control;
David Brownellf96411a2008-10-20 23:50:05 +0200265
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200266 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700267 if (ret < 0) {
268 dev_err(dev, "%s: reading CTRL_REG, error %d\n", __func__, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200269 return ret;
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700270 }
271 /* for twl6030/32 make sure BIT_RTC_CTRL_REG_GET_TIME_M is clear */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200272 if (twl_rtc->class == TWL_6030) {
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700273 if (save_control & BIT_RTC_CTRL_REG_GET_TIME_M) {
274 save_control &= ~BIT_RTC_CTRL_REG_GET_TIME_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200275 ret = twl_rtc_write_u8(twl_rtc, save_control,
276 REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700277 if (ret < 0) {
278 dev_err(dev, "%s clr GET_TIME, error %d\n",
279 __func__, ret);
280 return ret;
281 }
282 }
283 }
David Brownellf96411a2008-10-20 23:50:05 +0200284
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700285 /* Copy RTC counting registers to static registers or latches */
286 rtc_control = save_control | BIT_RTC_CTRL_REG_GET_TIME_M;
David Brownellf96411a2008-10-20 23:50:05 +0200287
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700288 /* for twl6030/32 enable read access to static shadowed registers */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200289 if (twl_rtc->class == TWL_6030)
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700290 rtc_control |= BIT_RTC_CTRL_REG_RTC_V_OPT;
291
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200292 ret = twl_rtc_write_u8(twl_rtc, rtc_control, REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700293 if (ret < 0) {
294 dev_err(dev, "%s: writing CTRL_REG, error %d\n", __func__, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200295 return ret;
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700296 }
David Brownellf96411a2008-10-20 23:50:05 +0200297
Balaji T Kef3b7d02009-12-13 21:30:48 +0100298 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200299 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200300
301 if (ret < 0) {
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700302 dev_err(dev, "%s: reading data, error %d\n", __func__, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200303 return ret;
304 }
305
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700306 /* for twl6030 restore original state of rtc control register */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200307 if (twl_rtc->class == TWL_6030) {
308 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700309 if (ret < 0) {
310 dev_err(dev, "%s: restore CTRL_REG, error %d\n",
311 __func__, ret);
312 return ret;
313 }
314 }
315
David Brownellf96411a2008-10-20 23:50:05 +0200316 tm->tm_sec = bcd2bin(rtc_data[0]);
317 tm->tm_min = bcd2bin(rtc_data[1]);
318 tm->tm_hour = bcd2bin(rtc_data[2]);
319 tm->tm_mday = bcd2bin(rtc_data[3]);
320 tm->tm_mon = bcd2bin(rtc_data[4]) - 1;
321 tm->tm_year = bcd2bin(rtc_data[5]) + 100;
322
323 return ret;
324}
325
Balaji T Kef3b7d02009-12-13 21:30:48 +0100326static int twl_rtc_set_time(struct device *dev, struct rtc_time *tm)
David Brownellf96411a2008-10-20 23:50:05 +0200327{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200328 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
David Brownellf96411a2008-10-20 23:50:05 +0200329 unsigned char save_control;
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100330 unsigned char rtc_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200331 int ret;
332
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100333 rtc_data[0] = bin2bcd(tm->tm_sec);
334 rtc_data[1] = bin2bcd(tm->tm_min);
335 rtc_data[2] = bin2bcd(tm->tm_hour);
336 rtc_data[3] = bin2bcd(tm->tm_mday);
337 rtc_data[4] = bin2bcd(tm->tm_mon + 1);
338 rtc_data[5] = bin2bcd(tm->tm_year - 100);
David Brownellf96411a2008-10-20 23:50:05 +0200339
340 /* Stop RTC while updating the TC registers */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200341 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200342 if (ret < 0)
343 goto out;
344
345 save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200346 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200347 if (ret < 0)
348 goto out;
349
350 /* update all the time registers in one shot */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100351 ret = twl_i2c_write(TWL_MODULE_RTC, rtc_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200352 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200353 if (ret < 0) {
354 dev_err(dev, "rtc_set_time error %d\n", ret);
355 goto out;
356 }
357
358 /* Start back RTC */
359 save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200360 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200361
362out:
363 return ret;
364}
365
366/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100367 * Gets current TWL RTC alarm time.
David Brownellf96411a2008-10-20 23:50:05 +0200368 */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100369static int twl_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
David Brownellf96411a2008-10-20 23:50:05 +0200370{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200371 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100372 unsigned char rtc_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200373 int ret;
374
Balaji T Kef3b7d02009-12-13 21:30:48 +0100375 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200376 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200377 if (ret < 0) {
378 dev_err(dev, "rtc_read_alarm error %d\n", ret);
379 return ret;
380 }
381
382 /* some of these fields may be wildcard/"match all" */
383 alm->time.tm_sec = bcd2bin(rtc_data[0]);
384 alm->time.tm_min = bcd2bin(rtc_data[1]);
385 alm->time.tm_hour = bcd2bin(rtc_data[2]);
386 alm->time.tm_mday = bcd2bin(rtc_data[3]);
387 alm->time.tm_mon = bcd2bin(rtc_data[4]) - 1;
388 alm->time.tm_year = bcd2bin(rtc_data[5]) + 100;
389
390 /* report cached alarm enable state */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200391 if (twl_rtc->rtc_irq_bits & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M)
David Brownellf96411a2008-10-20 23:50:05 +0200392 alm->enabled = 1;
393
394 return ret;
395}
396
Balaji T Kef3b7d02009-12-13 21:30:48 +0100397static int twl_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
David Brownellf96411a2008-10-20 23:50:05 +0200398{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200399 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
400
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100401 unsigned char alarm_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200402 int ret;
403
Balaji T Kef3b7d02009-12-13 21:30:48 +0100404 ret = twl_rtc_alarm_irq_enable(dev, 0);
David Brownellf96411a2008-10-20 23:50:05 +0200405 if (ret)
406 goto out;
407
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100408 alarm_data[0] = bin2bcd(alm->time.tm_sec);
409 alarm_data[1] = bin2bcd(alm->time.tm_min);
410 alarm_data[2] = bin2bcd(alm->time.tm_hour);
411 alarm_data[3] = bin2bcd(alm->time.tm_mday);
412 alarm_data[4] = bin2bcd(alm->time.tm_mon + 1);
413 alarm_data[5] = bin2bcd(alm->time.tm_year - 100);
David Brownellf96411a2008-10-20 23:50:05 +0200414
415 /* update all the alarm registers in one shot */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100416 ret = twl_i2c_write(TWL_MODULE_RTC, alarm_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200417 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200418 if (ret) {
419 dev_err(dev, "rtc_set_alarm error %d\n", ret);
420 goto out;
421 }
422
423 if (alm->enabled)
Balaji T Kef3b7d02009-12-13 21:30:48 +0100424 ret = twl_rtc_alarm_irq_enable(dev, 1);
David Brownellf96411a2008-10-20 23:50:05 +0200425out:
426 return ret;
427}
428
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200429static irqreturn_t twl_rtc_interrupt(int irq, void *data)
David Brownellf96411a2008-10-20 23:50:05 +0200430{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200431 struct twl_rtc *twl_rtc = data;
Venu Byravarasu2778ebc2012-03-23 15:02:34 -0700432 unsigned long events;
David Brownellf96411a2008-10-20 23:50:05 +0200433 int ret = IRQ_NONE;
434 int res;
435 u8 rd_reg;
436
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200437 res = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200438 if (res)
439 goto out;
440 /*
441 * Figure out source of interrupt: ALARM or TIMER in RTC_STATUS_REG.
442 * only one (ALARM or RTC) interrupt source may be enabled
443 * at time, we also could check our results
444 * by reading RTS_INTERRUPTS_REGISTER[IT_TIMER,IT_ALARM]
445 */
446 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
Venu Byravarasu2778ebc2012-03-23 15:02:34 -0700447 events = RTC_IRQF | RTC_AF;
David Brownellf96411a2008-10-20 23:50:05 +0200448 else
Venu Byravarasu2778ebc2012-03-23 15:02:34 -0700449 events = RTC_IRQF | RTC_PF;
David Brownellf96411a2008-10-20 23:50:05 +0200450
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200451 res = twl_rtc_write_u8(twl_rtc, BIT_RTC_STATUS_REG_ALARM_M,
452 REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200453 if (res)
454 goto out;
455
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200456 if (twl_rtc->class == TWL_4030) {
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100457 /* Clear on Read enabled. RTC_IT bit of TWL4030_INT_PWR_ISR1
458 * needs 2 reads to clear the interrupt. One read is done in
459 * do_twl_pwrirq(). Doing the second read, to clear
460 * the bit.
461 *
462 * FIXME the reason PWR_ISR1 needs an extra read is that
463 * RTC_IF retriggered until we cleared REG_ALARM_M above.
464 * But re-reading like this is a bad hack; by doing so we
465 * risk wrongly clearing status for some other IRQ (losing
466 * the interrupt). Be smarter about handling RTC_UF ...
467 */
468 res = twl_i2c_read_u8(TWL4030_MODULE_INT,
David Brownellf96411a2008-10-20 23:50:05 +0200469 &rd_reg, TWL4030_INT_PWR_ISR1);
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100470 if (res)
471 goto out;
472 }
David Brownellf96411a2008-10-20 23:50:05 +0200473
474 /* Notify RTC core on event */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200475 rtc_update_irq(twl_rtc->rtc, 1, events);
David Brownellf96411a2008-10-20 23:50:05 +0200476
477 ret = IRQ_HANDLED;
478out:
479 return ret;
480}
481
Julia Lawall34c7b3a2016-08-31 10:05:25 +0200482static const struct rtc_class_ops twl_rtc_ops = {
Balaji T Kef3b7d02009-12-13 21:30:48 +0100483 .read_time = twl_rtc_read_time,
484 .set_time = twl_rtc_set_time,
485 .read_alarm = twl_rtc_read_alarm,
486 .set_alarm = twl_rtc_set_alarm,
487 .alarm_irq_enable = twl_rtc_alarm_irq_enable,
David Brownellf96411a2008-10-20 23:50:05 +0200488};
489
490/*----------------------------------------------------------------------*/
491
Greg Kroah-Hartman5a167f42012-12-21 13:09:38 -0800492static int twl_rtc_probe(struct platform_device *pdev)
David Brownellf96411a2008-10-20 23:50:05 +0200493{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200494 struct twl_rtc *twl_rtc;
Nicolae Rosia1c02cbfe2016-11-23 10:55:57 +0200495 struct device_node *np = pdev->dev.of_node;
Todd Poynor7e72c682011-08-10 20:20:36 -0700496 int ret = -EINVAL;
David Brownellf96411a2008-10-20 23:50:05 +0200497 int irq = platform_get_irq(pdev, 0);
498 u8 rd_reg;
499
Nicolae Rosia1c02cbfe2016-11-23 10:55:57 +0200500 if (!np) {
501 dev_err(&pdev->dev, "no DT info\n");
502 return -EINVAL;
503 }
504
Anton Vorontsov2fac6672009-01-06 14:42:11 -0800505 if (irq <= 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800506 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200507
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200508 twl_rtc = devm_kzalloc(&pdev->dev, sizeof(*twl_rtc), GFP_KERNEL);
509 if (!twl_rtc)
510 return -ENOMEM;
Peter Ujfalusid3869ff2013-07-03 15:07:55 -0700511
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200512 if (twl_class_is_4030()) {
513 twl_rtc->class = TWL_4030;
514 twl_rtc->reg_map = (u8 *)twl4030_rtc_reg_map;
515 } else if (twl_class_is_6030()) {
516 twl_rtc->class = TWL_6030;
517 twl_rtc->reg_map = (u8 *)twl6030_rtc_reg_map;
518 } else {
519 dev_err(&pdev->dev, "TWL Class not supported.\n");
520 return -EINVAL;
521 }
522
523 ret = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200524 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800525 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200526
527 if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
528 dev_warn(&pdev->dev, "Power up reset detected.\n");
529
530 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
531 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
532
533 /* Clear RTC Power up reset and pending alarm interrupts */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200534 ret = twl_rtc_write_u8(twl_rtc, rd_reg, REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200535 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800536 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200537
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200538 if (twl_rtc->class == TWL_6030) {
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100539 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
540 REG_INT_MSK_LINE_A);
541 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
542 REG_INT_MSK_STS_A);
543 }
544
Venu Byravarasuf7439bc2012-03-23 15:02:33 -0700545 dev_info(&pdev->dev, "Enabling TWL-RTC\n");
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200546 ret = twl_rtc_write_u8(twl_rtc, BIT_RTC_CTRL_REG_STOP_RTC_M,
547 REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200548 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800549 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200550
Kevin Hilman8dcebaa92012-09-17 14:09:17 -0700551 /* ensure interrupts are disabled, bootloaders can be strange */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200552 ret = twl_rtc_write_u8(twl_rtc, 0, REG_RTC_INTERRUPTS_REG);
Kevin Hilman8dcebaa92012-09-17 14:09:17 -0700553 if (ret < 0)
554 dev_warn(&pdev->dev, "unable to disable interrupt\n");
555
David Brownellf96411a2008-10-20 23:50:05 +0200556 /* init cached IRQ enable bits */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200557 ret = twl_rtc_read_u8(twl_rtc, &twl_rtc->rtc_irq_bits,
558 REG_RTC_INTERRUPTS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200559 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800560 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200561
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200562 platform_set_drvdata(pdev, twl_rtc);
Grygorii Strashkob99b94b2013-07-31 13:53:41 -0700563 device_init_wakeup(&pdev->dev, 1);
564
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200565 twl_rtc->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800566 &twl_rtc_ops, THIS_MODULE);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200567 if (IS_ERR(twl_rtc->rtc)) {
Todd Poynor7e72c682011-08-10 20:20:36 -0700568 dev_err(&pdev->dev, "can't register RTC device, err %ld\n",
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200569 PTR_ERR(twl_rtc->rtc));
570 return PTR_ERR(twl_rtc->rtc);
Todd Poynor7e72c682011-08-10 20:20:36 -0700571 }
572
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800573 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
574 twl_rtc_interrupt,
575 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200576 dev_name(&twl_rtc->rtc->dev), twl_rtc);
Todd Poynor7e72c682011-08-10 20:20:36 -0700577 if (ret < 0) {
578 dev_err(&pdev->dev, "IRQ is not free.\n");
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800579 return ret;
Todd Poynor7e72c682011-08-10 20:20:36 -0700580 }
581
Todd Poynor7e72c682011-08-10 20:20:36 -0700582 return 0;
David Brownellf96411a2008-10-20 23:50:05 +0200583}
584
585/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100586 * Disable all TWL RTC module interrupts.
David Brownellf96411a2008-10-20 23:50:05 +0200587 * Sets status flag to free.
588 */
Greg Kroah-Hartman5a167f42012-12-21 13:09:38 -0800589static int twl_rtc_remove(struct platform_device *pdev)
David Brownellf96411a2008-10-20 23:50:05 +0200590{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200591 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
592
David Brownellf96411a2008-10-20 23:50:05 +0200593 /* leave rtc running, but disable irqs */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200594 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
595 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
596 if (twl_rtc->class == TWL_6030) {
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100597 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
598 REG_INT_MSK_LINE_A);
599 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
600 REG_INT_MSK_STS_A);
601 }
602
David Brownellf96411a2008-10-20 23:50:05 +0200603 return 0;
604}
605
Balaji T Kef3b7d02009-12-13 21:30:48 +0100606static void twl_rtc_shutdown(struct platform_device *pdev)
David Brownellf96411a2008-10-20 23:50:05 +0200607{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200608 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
609
Matti Halmecafa1d82009-01-15 13:50:56 -0800610 /* mask timer interrupts, but leave alarm interrupts on to enable
611 power-on when alarm is triggered */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200612 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
David Brownellf96411a2008-10-20 23:50:05 +0200613}
614
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700615#ifdef CONFIG_PM_SLEEP
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700616static int twl_rtc_suspend(struct device *dev)
David Brownellf96411a2008-10-20 23:50:05 +0200617{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200618 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
David Brownellf96411a2008-10-20 23:50:05 +0200619
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200620 twl_rtc->irqstat = twl_rtc->rtc_irq_bits;
621
622 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
David Brownellf96411a2008-10-20 23:50:05 +0200623 return 0;
624}
625
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700626static int twl_rtc_resume(struct device *dev)
David Brownellf96411a2008-10-20 23:50:05 +0200627{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200628 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
629
630 set_rtc_irq_bit(twl_rtc, twl_rtc->irqstat);
David Brownellf96411a2008-10-20 23:50:05 +0200631 return 0;
632}
David Brownellf96411a2008-10-20 23:50:05 +0200633#endif
634
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700635static SIMPLE_DEV_PM_OPS(twl_rtc_pm_ops, twl_rtc_suspend, twl_rtc_resume);
636
Benoit Cousson948170f2012-01-10 15:10:59 -0800637static const struct of_device_id twl_rtc_of_match[] = {
638 {.compatible = "ti,twl4030-rtc", },
639 { },
640};
641MODULE_DEVICE_TABLE(of, twl_rtc_of_match);
David Brownellf96411a2008-10-20 23:50:05 +0200642
643static struct platform_driver twl4030rtc_driver = {
Balaji T Kef3b7d02009-12-13 21:30:48 +0100644 .probe = twl_rtc_probe,
Greg Kroah-Hartman5a167f42012-12-21 13:09:38 -0800645 .remove = twl_rtc_remove,
Balaji T Kef3b7d02009-12-13 21:30:48 +0100646 .shutdown = twl_rtc_shutdown,
David Brownellf96411a2008-10-20 23:50:05 +0200647 .driver = {
Benoit Cousson948170f2012-01-10 15:10:59 -0800648 .name = "twl_rtc",
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700649 .pm = &twl_rtc_pm_ops,
Nicolae Rosia1c02cbfe2016-11-23 10:55:57 +0200650 .of_match_table = twl_rtc_of_match,
David Brownellf96411a2008-10-20 23:50:05 +0200651 },
652};
653
Peter Ujfalusi5ee67482013-07-03 15:07:56 -0700654module_platform_driver(twl4030rtc_driver);
David Brownellf96411a2008-10-20 23:50:05 +0200655
656MODULE_AUTHOR("Texas Instruments, MontaVista Software");
657MODULE_LICENSE("GPL");