blob: c18c39212ce680929b72c07e0ebe6305bb2675d8 [file] [log] [blame]
David Brownellf96411a2008-10-20 23:50:05 +02001/*
Balaji T Kef3b7d02009-12-13 21:30:48 +01002 * rtc-twl.c -- TWL Real Time Clock interface
David Brownellf96411a2008-10-20 23:50:05 +02003 *
4 * Copyright (C) 2007 MontaVista Software, Inc
5 * Author: Alexandre Rusev <source@mvista.com>
6 *
7 * Based on original TI driver twl4030-rtc.c
8 * Copyright (C) 2006 Texas Instruments, Inc.
9 *
10 * Based on rtc-omap.c
11 * Copyright (C) 2003 MontaVista Software, Inc.
12 * Author: George G. Davis <gdavis@mvista.com> or <source@mvista.com>
13 * Copyright (C) 2006 David Brownell
14 *
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version
18 * 2 of the License, or (at your option) any later version.
19 */
20
Joe Perchesa737e832015-04-16 12:46:14 -070021#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
David Brownellf96411a2008-10-20 23:50:05 +020023#include <linux/kernel.h>
Anton Vorontsov2fac6672009-01-06 14:42:11 -080024#include <linux/errno.h>
David Brownellf96411a2008-10-20 23:50:05 +020025#include <linux/init.h>
26#include <linux/module.h>
27#include <linux/types.h>
28#include <linux/rtc.h>
29#include <linux/bcd.h>
30#include <linux/platform_device.h>
31#include <linux/interrupt.h>
Sachin Kamatc8a60462013-02-21 16:44:28 -080032#include <linux/of.h>
David Brownellf96411a2008-10-20 23:50:05 +020033
Santosh Shilimkarb07682b2009-12-13 20:05:51 +010034#include <linux/i2c/twl.h>
David Brownellf96411a2008-10-20 23:50:05 +020035
Nicolae Rosiae3e7f952016-11-23 10:55:56 +020036enum twl_class {
37 TWL_4030 = 0,
38 TWL_6030,
39};
David Brownellf96411a2008-10-20 23:50:05 +020040
41/*
42 * RTC block register offsets (use TWL_MODULE_RTC)
43 */
Balaji T Ka6b49ff2009-12-13 22:16:31 +010044enum {
45 REG_SECONDS_REG = 0,
46 REG_MINUTES_REG,
47 REG_HOURS_REG,
48 REG_DAYS_REG,
49 REG_MONTHS_REG,
50 REG_YEARS_REG,
51 REG_WEEKS_REG,
David Brownellf96411a2008-10-20 23:50:05 +020052
Balaji T Ka6b49ff2009-12-13 22:16:31 +010053 REG_ALARM_SECONDS_REG,
54 REG_ALARM_MINUTES_REG,
55 REG_ALARM_HOURS_REG,
56 REG_ALARM_DAYS_REG,
57 REG_ALARM_MONTHS_REG,
58 REG_ALARM_YEARS_REG,
David Brownellf96411a2008-10-20 23:50:05 +020059
Balaji T Ka6b49ff2009-12-13 22:16:31 +010060 REG_RTC_CTRL_REG,
61 REG_RTC_STATUS_REG,
62 REG_RTC_INTERRUPTS_REG,
David Brownellf96411a2008-10-20 23:50:05 +020063
Balaji T Ka6b49ff2009-12-13 22:16:31 +010064 REG_RTC_COMP_LSB_REG,
65 REG_RTC_COMP_MSB_REG,
66};
Tobias Klauser2e840672010-03-05 13:44:23 -080067static const u8 twl4030_rtc_reg_map[] = {
Balaji T Ka6b49ff2009-12-13 22:16:31 +010068 [REG_SECONDS_REG] = 0x00,
69 [REG_MINUTES_REG] = 0x01,
70 [REG_HOURS_REG] = 0x02,
71 [REG_DAYS_REG] = 0x03,
72 [REG_MONTHS_REG] = 0x04,
73 [REG_YEARS_REG] = 0x05,
74 [REG_WEEKS_REG] = 0x06,
75
76 [REG_ALARM_SECONDS_REG] = 0x07,
77 [REG_ALARM_MINUTES_REG] = 0x08,
78 [REG_ALARM_HOURS_REG] = 0x09,
79 [REG_ALARM_DAYS_REG] = 0x0A,
80 [REG_ALARM_MONTHS_REG] = 0x0B,
81 [REG_ALARM_YEARS_REG] = 0x0C,
82
83 [REG_RTC_CTRL_REG] = 0x0D,
84 [REG_RTC_STATUS_REG] = 0x0E,
85 [REG_RTC_INTERRUPTS_REG] = 0x0F,
86
87 [REG_RTC_COMP_LSB_REG] = 0x10,
88 [REG_RTC_COMP_MSB_REG] = 0x11,
89};
Tobias Klauser2e840672010-03-05 13:44:23 -080090static const u8 twl6030_rtc_reg_map[] = {
Balaji T Ka6b49ff2009-12-13 22:16:31 +010091 [REG_SECONDS_REG] = 0x00,
92 [REG_MINUTES_REG] = 0x01,
93 [REG_HOURS_REG] = 0x02,
94 [REG_DAYS_REG] = 0x03,
95 [REG_MONTHS_REG] = 0x04,
96 [REG_YEARS_REG] = 0x05,
97 [REG_WEEKS_REG] = 0x06,
98
99 [REG_ALARM_SECONDS_REG] = 0x08,
100 [REG_ALARM_MINUTES_REG] = 0x09,
101 [REG_ALARM_HOURS_REG] = 0x0A,
102 [REG_ALARM_DAYS_REG] = 0x0B,
103 [REG_ALARM_MONTHS_REG] = 0x0C,
104 [REG_ALARM_YEARS_REG] = 0x0D,
105
106 [REG_RTC_CTRL_REG] = 0x10,
107 [REG_RTC_STATUS_REG] = 0x11,
108 [REG_RTC_INTERRUPTS_REG] = 0x12,
109
110 [REG_RTC_COMP_LSB_REG] = 0x13,
111 [REG_RTC_COMP_MSB_REG] = 0x14,
112};
David Brownellf96411a2008-10-20 23:50:05 +0200113
114/* RTC_CTRL_REG bitfields */
115#define BIT_RTC_CTRL_REG_STOP_RTC_M 0x01
116#define BIT_RTC_CTRL_REG_ROUND_30S_M 0x02
117#define BIT_RTC_CTRL_REG_AUTO_COMP_M 0x04
118#define BIT_RTC_CTRL_REG_MODE_12_24_M 0x08
119#define BIT_RTC_CTRL_REG_TEST_MODE_M 0x10
120#define BIT_RTC_CTRL_REG_SET_32_COUNTER_M 0x20
121#define BIT_RTC_CTRL_REG_GET_TIME_M 0x40
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700122#define BIT_RTC_CTRL_REG_RTC_V_OPT 0x80
David Brownellf96411a2008-10-20 23:50:05 +0200123
124/* RTC_STATUS_REG bitfields */
125#define BIT_RTC_STATUS_REG_RUN_M 0x02
126#define BIT_RTC_STATUS_REG_1S_EVENT_M 0x04
127#define BIT_RTC_STATUS_REG_1M_EVENT_M 0x08
128#define BIT_RTC_STATUS_REG_1H_EVENT_M 0x10
129#define BIT_RTC_STATUS_REG_1D_EVENT_M 0x20
130#define BIT_RTC_STATUS_REG_ALARM_M 0x40
131#define BIT_RTC_STATUS_REG_POWER_UP_M 0x80
132
133/* RTC_INTERRUPTS_REG bitfields */
134#define BIT_RTC_INTERRUPTS_REG_EVERY_M 0x03
135#define BIT_RTC_INTERRUPTS_REG_IT_TIMER_M 0x04
136#define BIT_RTC_INTERRUPTS_REG_IT_ALARM_M 0x08
137
138
139/* REG_SECONDS_REG through REG_YEARS_REG is how many registers? */
140#define ALL_TIME_REGS 6
141
142/*----------------------------------------------------------------------*/
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200143struct twl_rtc {
144 struct device *dev;
145 struct rtc_device *rtc;
146 u8 *reg_map;
147 /*
148 * Cache the value for timer/alarm interrupts register; this is
149 * only changed by callers holding rtc ops lock (or resume).
150 */
151 unsigned char rtc_irq_bits;
152 bool wake_enabled;
153#ifdef CONFIG_PM_SLEEP
154 unsigned char irqstat;
155#endif
156 enum twl_class class;
157};
David Brownellf96411a2008-10-20 23:50:05 +0200158
159/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100160 * Supports 1 byte read from TWL RTC register.
David Brownellf96411a2008-10-20 23:50:05 +0200161 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200162static int twl_rtc_read_u8(struct twl_rtc *twl_rtc, u8 *data, u8 reg)
David Brownellf96411a2008-10-20 23:50:05 +0200163{
164 int ret;
165
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200166 ret = twl_i2c_read_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
David Brownellf96411a2008-10-20 23:50:05 +0200167 if (ret < 0)
Joe Perchesa737e832015-04-16 12:46:14 -0700168 pr_err("Could not read TWL register %X - error %d\n", reg, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200169 return ret;
170}
171
172/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100173 * Supports 1 byte write to TWL RTC registers.
David Brownellf96411a2008-10-20 23:50:05 +0200174 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200175static int twl_rtc_write_u8(struct twl_rtc *twl_rtc, u8 data, u8 reg)
David Brownellf96411a2008-10-20 23:50:05 +0200176{
177 int ret;
178
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200179 ret = twl_i2c_write_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
David Brownellf96411a2008-10-20 23:50:05 +0200180 if (ret < 0)
Joe Perchesa737e832015-04-16 12:46:14 -0700181 pr_err("Could not write TWL register %X - error %d\n",
182 reg, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200183 return ret;
184}
185
186/*
Alessandro Zummoa7483842009-01-15 13:50:52 -0800187 * Enable 1/second update and/or alarm interrupts.
David Brownellf96411a2008-10-20 23:50:05 +0200188 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200189static int set_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
David Brownellf96411a2008-10-20 23:50:05 +0200190{
191 unsigned char val;
192 int ret;
193
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700194 /* if the bit is set, return from here */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200195 if (twl_rtc->rtc_irq_bits & bit)
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700196 return 0;
197
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200198 val = twl_rtc->rtc_irq_bits | bit;
Alessandro Zummoa7483842009-01-15 13:50:52 -0800199 val &= ~BIT_RTC_INTERRUPTS_REG_EVERY_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200200 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200201 if (ret == 0)
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200202 twl_rtc->rtc_irq_bits = val;
David Brownellf96411a2008-10-20 23:50:05 +0200203
204 return ret;
205}
206
207/*
Alessandro Zummoa7483842009-01-15 13:50:52 -0800208 * Disable update and/or alarm interrupts.
David Brownellf96411a2008-10-20 23:50:05 +0200209 */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200210static int mask_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
David Brownellf96411a2008-10-20 23:50:05 +0200211{
212 unsigned char val;
213 int ret;
214
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700215 /* if the bit is clear, return from here */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200216 if (!(twl_rtc->rtc_irq_bits & bit))
Venu Byravarasuce9f6502012-03-23 15:02:32 -0700217 return 0;
218
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200219 val = twl_rtc->rtc_irq_bits & ~bit;
220 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200221 if (ret == 0)
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200222 twl_rtc->rtc_irq_bits = val;
David Brownellf96411a2008-10-20 23:50:05 +0200223
224 return ret;
225}
226
Balaji T Kef3b7d02009-12-13 21:30:48 +0100227static int twl_rtc_alarm_irq_enable(struct device *dev, unsigned enabled)
David Brownellf96411a2008-10-20 23:50:05 +0200228{
Kevin Hilmanae845892013-07-03 15:07:53 -0700229 struct platform_device *pdev = to_platform_device(dev);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200230 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
Kevin Hilmanae845892013-07-03 15:07:53 -0700231 int irq = platform_get_irq(pdev, 0);
David Brownellf96411a2008-10-20 23:50:05 +0200232 int ret;
233
Kevin Hilmanae845892013-07-03 15:07:53 -0700234 if (enabled) {
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200235 ret = set_rtc_irq_bit(twl_rtc,
236 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
237 if (device_can_wakeup(dev) && !twl_rtc->wake_enabled) {
Kevin Hilmanae845892013-07-03 15:07:53 -0700238 enable_irq_wake(irq);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200239 twl_rtc->wake_enabled = true;
Kevin Hilmanae845892013-07-03 15:07:53 -0700240 }
241 } else {
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200242 ret = mask_rtc_irq_bit(twl_rtc,
243 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
244 if (twl_rtc->wake_enabled) {
Kevin Hilmanae845892013-07-03 15:07:53 -0700245 disable_irq_wake(irq);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200246 twl_rtc->wake_enabled = false;
Kevin Hilmanae845892013-07-03 15:07:53 -0700247 }
248 }
David Brownellf96411a2008-10-20 23:50:05 +0200249
250 return ret;
251}
252
David Brownellf96411a2008-10-20 23:50:05 +0200253/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100254 * Gets current TWL RTC time and date parameters.
David Brownellf96411a2008-10-20 23:50:05 +0200255 *
256 * The RTC's time/alarm representation is not what gmtime(3) requires
257 * Linux to use:
258 *
259 * - Months are 1..12 vs Linux 0-11
260 * - Years are 0..99 vs Linux 1900..N (we assume 21st century)
261 */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100262static int twl_rtc_read_time(struct device *dev, struct rtc_time *tm)
David Brownellf96411a2008-10-20 23:50:05 +0200263{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200264 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100265 unsigned char rtc_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200266 int ret;
267 u8 save_control;
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700268 u8 rtc_control;
David Brownellf96411a2008-10-20 23:50:05 +0200269
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200270 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700271 if (ret < 0) {
272 dev_err(dev, "%s: reading CTRL_REG, error %d\n", __func__, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200273 return ret;
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700274 }
275 /* for twl6030/32 make sure BIT_RTC_CTRL_REG_GET_TIME_M is clear */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200276 if (twl_rtc->class == TWL_6030) {
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700277 if (save_control & BIT_RTC_CTRL_REG_GET_TIME_M) {
278 save_control &= ~BIT_RTC_CTRL_REG_GET_TIME_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200279 ret = twl_rtc_write_u8(twl_rtc, save_control,
280 REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700281 if (ret < 0) {
282 dev_err(dev, "%s clr GET_TIME, error %d\n",
283 __func__, ret);
284 return ret;
285 }
286 }
287 }
David Brownellf96411a2008-10-20 23:50:05 +0200288
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700289 /* Copy RTC counting registers to static registers or latches */
290 rtc_control = save_control | BIT_RTC_CTRL_REG_GET_TIME_M;
David Brownellf96411a2008-10-20 23:50:05 +0200291
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700292 /* for twl6030/32 enable read access to static shadowed registers */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200293 if (twl_rtc->class == TWL_6030)
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700294 rtc_control |= BIT_RTC_CTRL_REG_RTC_V_OPT;
295
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200296 ret = twl_rtc_write_u8(twl_rtc, rtc_control, REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700297 if (ret < 0) {
298 dev_err(dev, "%s: writing CTRL_REG, error %d\n", __func__, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200299 return ret;
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700300 }
David Brownellf96411a2008-10-20 23:50:05 +0200301
Balaji T Kef3b7d02009-12-13 21:30:48 +0100302 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200303 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200304
305 if (ret < 0) {
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700306 dev_err(dev, "%s: reading data, error %d\n", __func__, ret);
David Brownellf96411a2008-10-20 23:50:05 +0200307 return ret;
308 }
309
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700310 /* for twl6030 restore original state of rtc control register */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200311 if (twl_rtc->class == TWL_6030) {
312 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
Konstantin Shlyakhovoyf3ec4342012-04-12 12:49:15 -0700313 if (ret < 0) {
314 dev_err(dev, "%s: restore CTRL_REG, error %d\n",
315 __func__, ret);
316 return ret;
317 }
318 }
319
David Brownellf96411a2008-10-20 23:50:05 +0200320 tm->tm_sec = bcd2bin(rtc_data[0]);
321 tm->tm_min = bcd2bin(rtc_data[1]);
322 tm->tm_hour = bcd2bin(rtc_data[2]);
323 tm->tm_mday = bcd2bin(rtc_data[3]);
324 tm->tm_mon = bcd2bin(rtc_data[4]) - 1;
325 tm->tm_year = bcd2bin(rtc_data[5]) + 100;
326
327 return ret;
328}
329
Balaji T Kef3b7d02009-12-13 21:30:48 +0100330static int twl_rtc_set_time(struct device *dev, struct rtc_time *tm)
David Brownellf96411a2008-10-20 23:50:05 +0200331{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200332 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
David Brownellf96411a2008-10-20 23:50:05 +0200333 unsigned char save_control;
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100334 unsigned char rtc_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200335 int ret;
336
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100337 rtc_data[0] = bin2bcd(tm->tm_sec);
338 rtc_data[1] = bin2bcd(tm->tm_min);
339 rtc_data[2] = bin2bcd(tm->tm_hour);
340 rtc_data[3] = bin2bcd(tm->tm_mday);
341 rtc_data[4] = bin2bcd(tm->tm_mon + 1);
342 rtc_data[5] = bin2bcd(tm->tm_year - 100);
David Brownellf96411a2008-10-20 23:50:05 +0200343
344 /* Stop RTC while updating the TC registers */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200345 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200346 if (ret < 0)
347 goto out;
348
349 save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200350 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200351 if (ret < 0)
352 goto out;
353
354 /* update all the time registers in one shot */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100355 ret = twl_i2c_write(TWL_MODULE_RTC, rtc_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200356 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200357 if (ret < 0) {
358 dev_err(dev, "rtc_set_time error %d\n", ret);
359 goto out;
360 }
361
362 /* Start back RTC */
363 save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200364 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200365
366out:
367 return ret;
368}
369
370/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100371 * Gets current TWL RTC alarm time.
David Brownellf96411a2008-10-20 23:50:05 +0200372 */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100373static int twl_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
David Brownellf96411a2008-10-20 23:50:05 +0200374{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200375 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100376 unsigned char rtc_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200377 int ret;
378
Balaji T Kef3b7d02009-12-13 21:30:48 +0100379 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200380 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200381 if (ret < 0) {
382 dev_err(dev, "rtc_read_alarm error %d\n", ret);
383 return ret;
384 }
385
386 /* some of these fields may be wildcard/"match all" */
387 alm->time.tm_sec = bcd2bin(rtc_data[0]);
388 alm->time.tm_min = bcd2bin(rtc_data[1]);
389 alm->time.tm_hour = bcd2bin(rtc_data[2]);
390 alm->time.tm_mday = bcd2bin(rtc_data[3]);
391 alm->time.tm_mon = bcd2bin(rtc_data[4]) - 1;
392 alm->time.tm_year = bcd2bin(rtc_data[5]) + 100;
393
394 /* report cached alarm enable state */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200395 if (twl_rtc->rtc_irq_bits & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M)
David Brownellf96411a2008-10-20 23:50:05 +0200396 alm->enabled = 1;
397
398 return ret;
399}
400
Balaji T Kef3b7d02009-12-13 21:30:48 +0100401static int twl_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
David Brownellf96411a2008-10-20 23:50:05 +0200402{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200403 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
404
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100405 unsigned char alarm_data[ALL_TIME_REGS];
David Brownellf96411a2008-10-20 23:50:05 +0200406 int ret;
407
Balaji T Kef3b7d02009-12-13 21:30:48 +0100408 ret = twl_rtc_alarm_irq_enable(dev, 0);
David Brownellf96411a2008-10-20 23:50:05 +0200409 if (ret)
410 goto out;
411
Peter Ujfalusi14591d82012-11-13 09:28:45 +0100412 alarm_data[0] = bin2bcd(alm->time.tm_sec);
413 alarm_data[1] = bin2bcd(alm->time.tm_min);
414 alarm_data[2] = bin2bcd(alm->time.tm_hour);
415 alarm_data[3] = bin2bcd(alm->time.tm_mday);
416 alarm_data[4] = bin2bcd(alm->time.tm_mon + 1);
417 alarm_data[5] = bin2bcd(alm->time.tm_year - 100);
David Brownellf96411a2008-10-20 23:50:05 +0200418
419 /* update all the alarm registers in one shot */
Balaji T Kef3b7d02009-12-13 21:30:48 +0100420 ret = twl_i2c_write(TWL_MODULE_RTC, alarm_data,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200421 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
David Brownellf96411a2008-10-20 23:50:05 +0200422 if (ret) {
423 dev_err(dev, "rtc_set_alarm error %d\n", ret);
424 goto out;
425 }
426
427 if (alm->enabled)
Balaji T Kef3b7d02009-12-13 21:30:48 +0100428 ret = twl_rtc_alarm_irq_enable(dev, 1);
David Brownellf96411a2008-10-20 23:50:05 +0200429out:
430 return ret;
431}
432
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200433static irqreturn_t twl_rtc_interrupt(int irq, void *data)
David Brownellf96411a2008-10-20 23:50:05 +0200434{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200435 struct twl_rtc *twl_rtc = data;
Venu Byravarasu2778ebc2012-03-23 15:02:34 -0700436 unsigned long events;
David Brownellf96411a2008-10-20 23:50:05 +0200437 int ret = IRQ_NONE;
438 int res;
439 u8 rd_reg;
440
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200441 res = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200442 if (res)
443 goto out;
444 /*
445 * Figure out source of interrupt: ALARM or TIMER in RTC_STATUS_REG.
446 * only one (ALARM or RTC) interrupt source may be enabled
447 * at time, we also could check our results
448 * by reading RTS_INTERRUPTS_REGISTER[IT_TIMER,IT_ALARM]
449 */
450 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
Venu Byravarasu2778ebc2012-03-23 15:02:34 -0700451 events = RTC_IRQF | RTC_AF;
David Brownellf96411a2008-10-20 23:50:05 +0200452 else
Venu Byravarasu2778ebc2012-03-23 15:02:34 -0700453 events = RTC_IRQF | RTC_PF;
David Brownellf96411a2008-10-20 23:50:05 +0200454
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200455 res = twl_rtc_write_u8(twl_rtc, BIT_RTC_STATUS_REG_ALARM_M,
456 REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200457 if (res)
458 goto out;
459
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200460 if (twl_rtc->class == TWL_4030) {
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100461 /* Clear on Read enabled. RTC_IT bit of TWL4030_INT_PWR_ISR1
462 * needs 2 reads to clear the interrupt. One read is done in
463 * do_twl_pwrirq(). Doing the second read, to clear
464 * the bit.
465 *
466 * FIXME the reason PWR_ISR1 needs an extra read is that
467 * RTC_IF retriggered until we cleared REG_ALARM_M above.
468 * But re-reading like this is a bad hack; by doing so we
469 * risk wrongly clearing status for some other IRQ (losing
470 * the interrupt). Be smarter about handling RTC_UF ...
471 */
472 res = twl_i2c_read_u8(TWL4030_MODULE_INT,
David Brownellf96411a2008-10-20 23:50:05 +0200473 &rd_reg, TWL4030_INT_PWR_ISR1);
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100474 if (res)
475 goto out;
476 }
David Brownellf96411a2008-10-20 23:50:05 +0200477
478 /* Notify RTC core on event */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200479 rtc_update_irq(twl_rtc->rtc, 1, events);
David Brownellf96411a2008-10-20 23:50:05 +0200480
481 ret = IRQ_HANDLED;
482out:
483 return ret;
484}
485
Julia Lawall34c7b3a2016-08-31 10:05:25 +0200486static const struct rtc_class_ops twl_rtc_ops = {
Balaji T Kef3b7d02009-12-13 21:30:48 +0100487 .read_time = twl_rtc_read_time,
488 .set_time = twl_rtc_set_time,
489 .read_alarm = twl_rtc_read_alarm,
490 .set_alarm = twl_rtc_set_alarm,
491 .alarm_irq_enable = twl_rtc_alarm_irq_enable,
David Brownellf96411a2008-10-20 23:50:05 +0200492};
493
494/*----------------------------------------------------------------------*/
495
Greg Kroah-Hartman5a167f42012-12-21 13:09:38 -0800496static int twl_rtc_probe(struct platform_device *pdev)
David Brownellf96411a2008-10-20 23:50:05 +0200497{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200498 struct twl_rtc *twl_rtc;
Nicolae Rosia1c02cbfe2016-11-23 10:55:57 +0200499 struct device_node *np = pdev->dev.of_node;
Todd Poynor7e72c682011-08-10 20:20:36 -0700500 int ret = -EINVAL;
David Brownellf96411a2008-10-20 23:50:05 +0200501 int irq = platform_get_irq(pdev, 0);
502 u8 rd_reg;
503
Nicolae Rosia1c02cbfe2016-11-23 10:55:57 +0200504 if (!np) {
505 dev_err(&pdev->dev, "no DT info\n");
506 return -EINVAL;
507 }
508
Anton Vorontsov2fac6672009-01-06 14:42:11 -0800509 if (irq <= 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800510 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200511
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200512 twl_rtc = devm_kzalloc(&pdev->dev, sizeof(*twl_rtc), GFP_KERNEL);
513 if (!twl_rtc)
514 return -ENOMEM;
Peter Ujfalusid3869ff2013-07-03 15:07:55 -0700515
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200516 if (twl_class_is_4030()) {
517 twl_rtc->class = TWL_4030;
518 twl_rtc->reg_map = (u8 *)twl4030_rtc_reg_map;
519 } else if (twl_class_is_6030()) {
520 twl_rtc->class = TWL_6030;
521 twl_rtc->reg_map = (u8 *)twl6030_rtc_reg_map;
522 } else {
523 dev_err(&pdev->dev, "TWL Class not supported.\n");
524 return -EINVAL;
525 }
526
527 ret = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200528 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800529 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200530
531 if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
532 dev_warn(&pdev->dev, "Power up reset detected.\n");
533
534 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
535 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
536
537 /* Clear RTC Power up reset and pending alarm interrupts */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200538 ret = twl_rtc_write_u8(twl_rtc, rd_reg, REG_RTC_STATUS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200539 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800540 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200541
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200542 if (twl_rtc->class == TWL_6030) {
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100543 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
544 REG_INT_MSK_LINE_A);
545 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
546 REG_INT_MSK_STS_A);
547 }
548
Venu Byravarasuf7439bc2012-03-23 15:02:33 -0700549 dev_info(&pdev->dev, "Enabling TWL-RTC\n");
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200550 ret = twl_rtc_write_u8(twl_rtc, BIT_RTC_CTRL_REG_STOP_RTC_M,
551 REG_RTC_CTRL_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200552 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800553 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200554
Kevin Hilman8dcebaa92012-09-17 14:09:17 -0700555 /* ensure interrupts are disabled, bootloaders can be strange */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200556 ret = twl_rtc_write_u8(twl_rtc, 0, REG_RTC_INTERRUPTS_REG);
Kevin Hilman8dcebaa92012-09-17 14:09:17 -0700557 if (ret < 0)
558 dev_warn(&pdev->dev, "unable to disable interrupt\n");
559
David Brownellf96411a2008-10-20 23:50:05 +0200560 /* init cached IRQ enable bits */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200561 ret = twl_rtc_read_u8(twl_rtc, &twl_rtc->rtc_irq_bits,
562 REG_RTC_INTERRUPTS_REG);
David Brownellf96411a2008-10-20 23:50:05 +0200563 if (ret < 0)
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800564 return ret;
David Brownellf96411a2008-10-20 23:50:05 +0200565
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200566 platform_set_drvdata(pdev, twl_rtc);
Grygorii Strashkob99b94b2013-07-31 13:53:41 -0700567 device_init_wakeup(&pdev->dev, 1);
568
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200569 twl_rtc->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800570 &twl_rtc_ops, THIS_MODULE);
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200571 if (IS_ERR(twl_rtc->rtc)) {
Todd Poynor7e72c682011-08-10 20:20:36 -0700572 dev_err(&pdev->dev, "can't register RTC device, err %ld\n",
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200573 PTR_ERR(twl_rtc->rtc));
574 return PTR_ERR(twl_rtc->rtc);
Todd Poynor7e72c682011-08-10 20:20:36 -0700575 }
576
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800577 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
578 twl_rtc_interrupt,
579 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200580 dev_name(&twl_rtc->rtc->dev), twl_rtc);
Todd Poynor7e72c682011-08-10 20:20:36 -0700581 if (ret < 0) {
582 dev_err(&pdev->dev, "IRQ is not free.\n");
Jingoo Hanf53eeb82014-01-23 15:55:06 -0800583 return ret;
Todd Poynor7e72c682011-08-10 20:20:36 -0700584 }
585
Todd Poynor7e72c682011-08-10 20:20:36 -0700586 return 0;
David Brownellf96411a2008-10-20 23:50:05 +0200587}
588
589/*
Balaji T Kef3b7d02009-12-13 21:30:48 +0100590 * Disable all TWL RTC module interrupts.
David Brownellf96411a2008-10-20 23:50:05 +0200591 * Sets status flag to free.
592 */
Greg Kroah-Hartman5a167f42012-12-21 13:09:38 -0800593static int twl_rtc_remove(struct platform_device *pdev)
David Brownellf96411a2008-10-20 23:50:05 +0200594{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200595 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
596
David Brownellf96411a2008-10-20 23:50:05 +0200597 /* leave rtc running, but disable irqs */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200598 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
599 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
600 if (twl_rtc->class == TWL_6030) {
Balaji T Ka6b49ff2009-12-13 22:16:31 +0100601 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
602 REG_INT_MSK_LINE_A);
603 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
604 REG_INT_MSK_STS_A);
605 }
606
David Brownellf96411a2008-10-20 23:50:05 +0200607 return 0;
608}
609
Balaji T Kef3b7d02009-12-13 21:30:48 +0100610static void twl_rtc_shutdown(struct platform_device *pdev)
David Brownellf96411a2008-10-20 23:50:05 +0200611{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200612 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
613
Matti Halmecafa1d82009-01-15 13:50:56 -0800614 /* mask timer interrupts, but leave alarm interrupts on to enable
615 power-on when alarm is triggered */
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200616 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
David Brownellf96411a2008-10-20 23:50:05 +0200617}
618
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700619#ifdef CONFIG_PM_SLEEP
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700620static int twl_rtc_suspend(struct device *dev)
David Brownellf96411a2008-10-20 23:50:05 +0200621{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200622 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
David Brownellf96411a2008-10-20 23:50:05 +0200623
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200624 twl_rtc->irqstat = twl_rtc->rtc_irq_bits;
625
626 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
David Brownellf96411a2008-10-20 23:50:05 +0200627 return 0;
628}
629
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700630static int twl_rtc_resume(struct device *dev)
David Brownellf96411a2008-10-20 23:50:05 +0200631{
Nicolae Rosiae3e7f952016-11-23 10:55:56 +0200632 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
633
634 set_rtc_irq_bit(twl_rtc, twl_rtc->irqstat);
David Brownellf96411a2008-10-20 23:50:05 +0200635 return 0;
636}
David Brownellf96411a2008-10-20 23:50:05 +0200637#endif
638
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700639static SIMPLE_DEV_PM_OPS(twl_rtc_pm_ops, twl_rtc_suspend, twl_rtc_resume);
640
Benoit Cousson948170f2012-01-10 15:10:59 -0800641static const struct of_device_id twl_rtc_of_match[] = {
642 {.compatible = "ti,twl4030-rtc", },
643 { },
644};
645MODULE_DEVICE_TABLE(of, twl_rtc_of_match);
David Brownellf96411a2008-10-20 23:50:05 +0200646
647static struct platform_driver twl4030rtc_driver = {
Balaji T Kef3b7d02009-12-13 21:30:48 +0100648 .probe = twl_rtc_probe,
Greg Kroah-Hartman5a167f42012-12-21 13:09:38 -0800649 .remove = twl_rtc_remove,
Balaji T Kef3b7d02009-12-13 21:30:48 +0100650 .shutdown = twl_rtc_shutdown,
David Brownellf96411a2008-10-20 23:50:05 +0200651 .driver = {
Benoit Cousson948170f2012-01-10 15:10:59 -0800652 .name = "twl_rtc",
Jingoo Hanb9d8c462013-04-29 16:21:04 -0700653 .pm = &twl_rtc_pm_ops,
Nicolae Rosia1c02cbfe2016-11-23 10:55:57 +0200654 .of_match_table = twl_rtc_of_match,
David Brownellf96411a2008-10-20 23:50:05 +0200655 },
656};
657
Peter Ujfalusi5ee67482013-07-03 15:07:56 -0700658module_platform_driver(twl4030rtc_driver);
David Brownellf96411a2008-10-20 23:50:05 +0200659
660MODULE_AUTHOR("Texas Instruments, MontaVista Software");
661MODULE_LICENSE("GPL");