blob: d4eff8d7131fd171769cc4238e8f550758e30b53 [file] [log] [blame]
Alessandro Zummo7520b942006-03-27 01:16:45 -08001/*
Paul Mundt37fc5e22008-10-15 22:03:03 -07002 * An I2C driver for Ricoh RS5C372, R2025S/D and RV5C38[67] RTCs
Alessandro Zummo7520b942006-03-27 01:16:45 -08003 *
4 * Copyright (C) 2005 Pavel Mironchik <pmironchik@optifacio.net>
5 * Copyright (C) 2006 Tower Technologies
Paul Mundt0053dc02008-10-15 22:03:01 -07006 * Copyright (C) 2008 Paul Mundt
Alessandro Zummo7520b942006-03-27 01:16:45 -08007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#include <linux/i2c.h>
14#include <linux/rtc.h>
15#include <linux/bcd.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090016#include <linux/slab.h>
Paul Gortmaker21138522011-05-27 09:57:25 -040017#include <linux/module.h>
Javier Martinez Canillasff764b82017-03-03 11:29:24 -030018#include <linux/of_device.h>
Alessandro Zummo7520b942006-03-27 01:16:45 -080019
David Brownellcb26b572007-01-05 16:36:37 -080020/*
21 * Ricoh has a family of I2C based RTCs, which differ only slightly from
22 * each other. Differences center on pinout (e.g. how many interrupts,
23 * output clock, etc) and how the control registers are used. The '372
24 * is significant only because that's the one this driver first supported.
25 */
Alessandro Zummo7520b942006-03-27 01:16:45 -080026#define RS5C372_REG_SECS 0
27#define RS5C372_REG_MINS 1
28#define RS5C372_REG_HOURS 2
29#define RS5C372_REG_WDAY 3
30#define RS5C372_REG_DAY 4
31#define RS5C372_REG_MONTH 5
32#define RS5C372_REG_YEAR 6
33#define RS5C372_REG_TRIM 7
David Brownellcb26b572007-01-05 16:36:37 -080034# define RS5C372_TRIM_XSL 0x80
35# define RS5C372_TRIM_MASK 0x7F
Alessandro Zummo7520b942006-03-27 01:16:45 -080036
David Brownellcb26b572007-01-05 16:36:37 -080037#define RS5C_REG_ALARM_A_MIN 8 /* or ALARM_W */
38#define RS5C_REG_ALARM_A_HOURS 9
39#define RS5C_REG_ALARM_A_WDAY 10
Alessandro Zummo7520b942006-03-27 01:16:45 -080040
David Brownellcb26b572007-01-05 16:36:37 -080041#define RS5C_REG_ALARM_B_MIN 11 /* or ALARM_D */
42#define RS5C_REG_ALARM_B_HOURS 12
43#define RS5C_REG_ALARM_B_WDAY 13 /* (ALARM_B only) */
Alessandro Zummo7520b942006-03-27 01:16:45 -080044
David Brownellcb26b572007-01-05 16:36:37 -080045#define RS5C_REG_CTRL1 14
46# define RS5C_CTRL1_AALE (1 << 7) /* or WALE */
47# define RS5C_CTRL1_BALE (1 << 6) /* or DALE */
48# define RV5C387_CTRL1_24 (1 << 5)
49# define RS5C372A_CTRL1_SL1 (1 << 5)
50# define RS5C_CTRL1_CT_MASK (7 << 0)
51# define RS5C_CTRL1_CT0 (0 << 0) /* no periodic irq */
52# define RS5C_CTRL1_CT4 (4 << 0) /* 1 Hz level irq */
53#define RS5C_REG_CTRL2 15
54# define RS5C372_CTRL2_24 (1 << 5)
Paul Mundt37fc5e22008-10-15 22:03:03 -070055# define R2025_CTRL2_XST (1 << 5)
56# define RS5C_CTRL2_XSTP (1 << 4) /* only if !R2025S/D */
David Brownellcb26b572007-01-05 16:36:37 -080057# define RS5C_CTRL2_CTFG (1 << 2)
58# define RS5C_CTRL2_AAFG (1 << 1) /* or WAFG */
59# define RS5C_CTRL2_BAFG (1 << 0) /* or DAFG */
Alessandro Zummo7520b942006-03-27 01:16:45 -080060
David Brownellcb26b572007-01-05 16:36:37 -080061
62/* to read (style 1) or write registers starting at R */
63#define RS5C_ADDR(R) (((R) << 4) | 0)
64
65
66enum rtc_type {
67 rtc_undef = 0,
Paul Mundt37fc5e22008-10-15 22:03:03 -070068 rtc_r2025sd,
Lucas Stach550fcb82013-05-07 16:18:11 -070069 rtc_r2221tl,
David Brownellcb26b572007-01-05 16:36:37 -080070 rtc_rs5c372a,
71 rtc_rs5c372b,
72 rtc_rv5c386,
73 rtc_rv5c387a,
74};
75
Jean Delvare3760f732008-04-29 23:11:40 +020076static const struct i2c_device_id rs5c372_id[] = {
Paul Mundt37fc5e22008-10-15 22:03:03 -070077 { "r2025sd", rtc_r2025sd },
Lucas Stach550fcb82013-05-07 16:18:11 -070078 { "r2221tl", rtc_r2221tl },
Jean Delvare3760f732008-04-29 23:11:40 +020079 { "rs5c372a", rtc_rs5c372a },
80 { "rs5c372b", rtc_rs5c372b },
81 { "rv5c386", rtc_rv5c386 },
82 { "rv5c387a", rtc_rv5c387a },
83 { }
84};
85MODULE_DEVICE_TABLE(i2c, rs5c372_id);
86
Javier Martinez Canillasff764b82017-03-03 11:29:24 -030087static const struct of_device_id rs5c372_of_match[] = {
88 {
89 .compatible = "ricoh,r2025sd",
90 .data = (void *)rtc_r2025sd
91 },
92 {
93 .compatible = "ricoh,r2221tl",
94 .data = (void *)rtc_r2221tl
95 },
96 {
97 .compatible = "ricoh,rs5c372a",
98 .data = (void *)rtc_rs5c372a
99 },
100 {
101 .compatible = "ricoh,rs5c372b",
102 .data = (void *)rtc_rs5c372b
103 },
104 {
105 .compatible = "ricoh,rv5c386",
106 .data = (void *)rtc_rv5c386
107 },
108 {
109 .compatible = "ricoh,rv5c387a",
110 .data = (void *)rtc_rv5c387a
111 },
112 { }
113};
114MODULE_DEVICE_TABLE(of, rs5c372_of_match);
115
David Brownellcb26b572007-01-05 16:36:37 -0800116/* REVISIT: this assumes that:
117 * - we're in the 21st century, so it's safe to ignore the century
118 * bit for rv5c38[67] (REG_MONTH bit 7);
119 * - we should use ALARM_A not ALARM_B (may be wrong on some boards)
120 */
Riku Voipioc6f24f92006-12-06 20:39:13 -0800121struct rs5c372 {
David Brownellcb26b572007-01-05 16:36:37 -0800122 struct i2c_client *client;
123 struct rtc_device *rtc;
124 enum rtc_type type;
125 unsigned time24:1;
126 unsigned has_irq:1;
Paul Mundt0053dc02008-10-15 22:03:01 -0700127 unsigned smbus:1;
David Brownellcb26b572007-01-05 16:36:37 -0800128 char buf[17];
129 char *regs;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800130};
131
David Brownellcb26b572007-01-05 16:36:37 -0800132static int rs5c_get_regs(struct rs5c372 *rs5c)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800133{
David Brownellcb26b572007-01-05 16:36:37 -0800134 struct i2c_client *client = rs5c->client;
135 struct i2c_msg msgs[] = {
Shubhrajyoti Da6067572012-10-04 17:14:22 -0700136 {
137 .addr = client->addr,
138 .flags = I2C_M_RD,
139 .len = sizeof(rs5c->buf),
140 .buf = rs5c->buf
141 },
David Brownellcb26b572007-01-05 16:36:37 -0800142 };
Alessandro Zummo7520b942006-03-27 01:16:45 -0800143
David Brownellcb26b572007-01-05 16:36:37 -0800144 /* This implements the third reading method from the datasheet, using
145 * an internal address that's reset after each transaction (by STOP)
146 * to 0x0f ... so we read extra registers, and skip the first one.
147 *
148 * The first method doesn't work with the iop3xx adapter driver, on at
149 * least 80219 chips; this works around that bug.
Paul Mundt0053dc02008-10-15 22:03:01 -0700150 *
151 * The third method on the other hand doesn't work for the SMBus-only
152 * configurations, so we use the the first method there, stripping off
153 * the extra register in the process.
Alessandro Zummo7520b942006-03-27 01:16:45 -0800154 */
Paul Mundt0053dc02008-10-15 22:03:01 -0700155 if (rs5c->smbus) {
156 int addr = RS5C_ADDR(RS5C372_REG_SECS);
157 int size = sizeof(rs5c->buf) - 1;
158
159 if (i2c_smbus_read_i2c_block_data(client, addr, size,
160 rs5c->buf + 1) != size) {
161 dev_warn(&client->dev, "can't read registers\n");
162 return -EIO;
163 }
164 } else {
165 if ((i2c_transfer(client->adapter, msgs, 1)) != 1) {
166 dev_warn(&client->dev, "can't read registers\n");
167 return -EIO;
168 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800169 }
170
David Brownellcb26b572007-01-05 16:36:37 -0800171 dev_dbg(&client->dev,
Andy Shevchenkob513e522014-10-13 15:53:12 -0700172 "%3ph (%02x) %3ph (%02x), %3ph, %3ph; %02x %02x\n",
173 rs5c->regs + 0, rs5c->regs[3],
174 rs5c->regs + 4, rs5c->regs[7],
175 rs5c->regs + 8, rs5c->regs + 11,
176 rs5c->regs[14], rs5c->regs[15]);
David Brownellcb26b572007-01-05 16:36:37 -0800177
178 return 0;
179}
180
181static unsigned rs5c_reg2hr(struct rs5c372 *rs5c, unsigned reg)
182{
183 unsigned hour;
184
185 if (rs5c->time24)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700186 return bcd2bin(reg & 0x3f);
David Brownellcb26b572007-01-05 16:36:37 -0800187
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700188 hour = bcd2bin(reg & 0x1f);
David Brownellcb26b572007-01-05 16:36:37 -0800189 if (hour == 12)
190 hour = 0;
191 if (reg & 0x20)
192 hour += 12;
193 return hour;
194}
195
196static unsigned rs5c_hr2reg(struct rs5c372 *rs5c, unsigned hour)
197{
198 if (rs5c->time24)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700199 return bin2bcd(hour);
David Brownellcb26b572007-01-05 16:36:37 -0800200
201 if (hour > 12)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700202 return 0x20 | bin2bcd(hour - 12);
David Brownellcb26b572007-01-05 16:36:37 -0800203 if (hour == 12)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700204 return 0x20 | bin2bcd(12);
David Brownellcb26b572007-01-05 16:36:37 -0800205 if (hour == 0)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700206 return bin2bcd(12);
207 return bin2bcd(hour);
David Brownellcb26b572007-01-05 16:36:37 -0800208}
209
210static int rs5c372_get_datetime(struct i2c_client *client, struct rtc_time *tm)
211{
212 struct rs5c372 *rs5c = i2c_get_clientdata(client);
213 int status = rs5c_get_regs(rs5c);
214
215 if (status < 0)
216 return status;
217
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700218 tm->tm_sec = bcd2bin(rs5c->regs[RS5C372_REG_SECS] & 0x7f);
219 tm->tm_min = bcd2bin(rs5c->regs[RS5C372_REG_MINS] & 0x7f);
David Brownellcb26b572007-01-05 16:36:37 -0800220 tm->tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C372_REG_HOURS]);
221
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700222 tm->tm_wday = bcd2bin(rs5c->regs[RS5C372_REG_WDAY] & 0x07);
223 tm->tm_mday = bcd2bin(rs5c->regs[RS5C372_REG_DAY] & 0x3f);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800224
225 /* tm->tm_mon is zero-based */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700226 tm->tm_mon = bcd2bin(rs5c->regs[RS5C372_REG_MONTH] & 0x1f) - 1;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800227
228 /* year is 1900 + tm->tm_year */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700229 tm->tm_year = bcd2bin(rs5c->regs[RS5C372_REG_YEAR]) + 100;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800230
231 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
232 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700233 __func__,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800234 tm->tm_sec, tm->tm_min, tm->tm_hour,
235 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
236
David Brownellcb26b572007-01-05 16:36:37 -0800237 /* rtc might need initialization */
238 return rtc_valid_tm(tm);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800239}
240
241static int rs5c372_set_datetime(struct i2c_client *client, struct rtc_time *tm)
242{
David Brownellcb26b572007-01-05 16:36:37 -0800243 struct rs5c372 *rs5c = i2c_get_clientdata(client);
Wolfram Sang11836492010-12-21 17:24:24 -0800244 unsigned char buf[7];
Paul Mundt0053dc02008-10-15 22:03:01 -0700245 int addr;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800246
David Brownellcb26b572007-01-05 16:36:37 -0800247 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d "
Alessandro Zummo7520b942006-03-27 01:16:45 -0800248 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700249 __func__,
David Brownellcb26b572007-01-05 16:36:37 -0800250 tm->tm_sec, tm->tm_min, tm->tm_hour,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800251 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
252
Paul Mundt0053dc02008-10-15 22:03:01 -0700253 addr = RS5C_ADDR(RS5C372_REG_SECS);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700254 buf[0] = bin2bcd(tm->tm_sec);
255 buf[1] = bin2bcd(tm->tm_min);
Paul Mundt0053dc02008-10-15 22:03:01 -0700256 buf[2] = rs5c_hr2reg(rs5c, tm->tm_hour);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700257 buf[3] = bin2bcd(tm->tm_wday);
258 buf[4] = bin2bcd(tm->tm_mday);
259 buf[5] = bin2bcd(tm->tm_mon + 1);
260 buf[6] = bin2bcd(tm->tm_year - 100);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800261
Paul Mundt0053dc02008-10-15 22:03:01 -0700262 if (i2c_smbus_write_i2c_block_data(client, addr, sizeof(buf), buf) < 0) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700263 dev_err(&client->dev, "%s: write error\n", __func__);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800264 return -EIO;
265 }
266
267 return 0;
268}
269
Javier Martinez Canillas6fca3fc2016-04-26 18:17:35 -0400270#if IS_ENABLED(CONFIG_RTC_INTF_PROC)
David Brownellcb26b572007-01-05 16:36:37 -0800271#define NEED_TRIM
272#endif
273
Javier Martinez Canillas6fca3fc2016-04-26 18:17:35 -0400274#if IS_ENABLED(CONFIG_RTC_INTF_SYSFS)
David Brownellcb26b572007-01-05 16:36:37 -0800275#define NEED_TRIM
276#endif
277
278#ifdef NEED_TRIM
Alessandro Zummo7520b942006-03-27 01:16:45 -0800279static int rs5c372_get_trim(struct i2c_client *client, int *osc, int *trim)
280{
Riku Voipioc6f24f92006-12-06 20:39:13 -0800281 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
David Brownellcb26b572007-01-05 16:36:37 -0800282 u8 tmp = rs5c372->regs[RS5C372_REG_TRIM];
Alessandro Zummo7520b942006-03-27 01:16:45 -0800283
Alessandro Zummo7520b942006-03-27 01:16:45 -0800284 if (osc)
Riku Voipioc6f24f92006-12-06 20:39:13 -0800285 *osc = (tmp & RS5C372_TRIM_XSL) ? 32000 : 32768;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800286
Adrian Bunk17ad78e2006-11-25 11:09:29 -0800287 if (trim) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700288 dev_dbg(&client->dev, "%s: raw trim=%x\n", __func__, tmp);
David Brownellcb26b572007-01-05 16:36:37 -0800289 tmp &= RS5C372_TRIM_MASK;
290 if (tmp & 0x3e) {
291 int t = tmp & 0x3f;
292
293 if (tmp & 0x40)
294 t = (~t | (s8)0xc0) + 1;
295 else
296 t = t - 1;
297
298 tmp = t * 2;
299 } else
300 tmp = 0;
301 *trim = tmp;
Adrian Bunk17ad78e2006-11-25 11:09:29 -0800302 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800303
304 return 0;
305}
David Brownellcb26b572007-01-05 16:36:37 -0800306#endif
Alessandro Zummo7520b942006-03-27 01:16:45 -0800307
308static int rs5c372_rtc_read_time(struct device *dev, struct rtc_time *tm)
309{
310 return rs5c372_get_datetime(to_i2c_client(dev), tm);
311}
312
313static int rs5c372_rtc_set_time(struct device *dev, struct rtc_time *tm)
314{
315 return rs5c372_set_datetime(to_i2c_client(dev), tm);
316}
317
David Brownellcb26b572007-01-05 16:36:37 -0800318
John Stultz16380c12011-02-02 17:02:41 -0800319static int rs5c_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
320{
321 struct i2c_client *client = to_i2c_client(dev);
322 struct rs5c372 *rs5c = i2c_get_clientdata(client);
323 unsigned char buf;
324 int status, addr;
325
326 buf = rs5c->regs[RS5C_REG_CTRL1];
327
328 if (!rs5c->has_irq)
329 return -EINVAL;
330
331 status = rs5c_get_regs(rs5c);
332 if (status < 0)
333 return status;
334
335 addr = RS5C_ADDR(RS5C_REG_CTRL1);
336 if (enabled)
337 buf |= RS5C_CTRL1_AALE;
338 else
339 buf &= ~RS5C_CTRL1_AALE;
340
341 if (i2c_smbus_write_byte_data(client, addr, buf) < 0) {
Jingoo Han0c6516e2013-02-21 16:45:27 -0800342 dev_warn(dev, "can't update alarm\n");
John Stultz16380c12011-02-02 17:02:41 -0800343 status = -EIO;
344 } else
345 rs5c->regs[RS5C_REG_CTRL1] = buf;
346
347 return status;
348}
349
350
David Brownellcb26b572007-01-05 16:36:37 -0800351/* NOTE: Since RTC_WKALM_{RD,SET} were originally defined for EFI,
352 * which only exposes a polled programming interface; and since
353 * these calls map directly to those EFI requests; we don't demand
354 * we have an IRQ for this chip when we go through this API.
355 *
356 * The older x86_pc derived RTC_ALM_{READ,SET} calls require irqs
357 * though, managed through RTC_AIE_{ON,OFF} requests.
358 */
359
360static int rs5c_read_alarm(struct device *dev, struct rtc_wkalrm *t)
361{
362 struct i2c_client *client = to_i2c_client(dev);
363 struct rs5c372 *rs5c = i2c_get_clientdata(client);
364 int status;
365
366 status = rs5c_get_regs(rs5c);
367 if (status < 0)
368 return status;
369
370 /* report alarm time */
371 t->time.tm_sec = 0;
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700372 t->time.tm_min = bcd2bin(rs5c->regs[RS5C_REG_ALARM_A_MIN] & 0x7f);
David Brownellcb26b572007-01-05 16:36:37 -0800373 t->time.tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C_REG_ALARM_A_HOURS]);
David Brownellcb26b572007-01-05 16:36:37 -0800374
375 /* ... and status */
376 t->enabled = !!(rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE);
377 t->pending = !!(rs5c->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_AAFG);
378
379 return 0;
380}
381
382static int rs5c_set_alarm(struct device *dev, struct rtc_wkalrm *t)
383{
384 struct i2c_client *client = to_i2c_client(dev);
385 struct rs5c372 *rs5c = i2c_get_clientdata(client);
Paul Mundt0053dc02008-10-15 22:03:01 -0700386 int status, addr, i;
387 unsigned char buf[3];
David Brownellcb26b572007-01-05 16:36:37 -0800388
389 /* only handle up to 24 hours in the future, like RTC_ALM_SET */
390 if (t->time.tm_mday != -1
391 || t->time.tm_mon != -1
392 || t->time.tm_year != -1)
393 return -EINVAL;
394
395 /* REVISIT: round up tm_sec */
396
397 /* if needed, disable irq (clears pending status) */
398 status = rs5c_get_regs(rs5c);
399 if (status < 0)
400 return status;
401 if (rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE) {
Paul Mundt0053dc02008-10-15 22:03:01 -0700402 addr = RS5C_ADDR(RS5C_REG_CTRL1);
403 buf[0] = rs5c->regs[RS5C_REG_CTRL1] & ~RS5C_CTRL1_AALE;
404 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0) {
Jingoo Han0c6516e2013-02-21 16:45:27 -0800405 dev_dbg(dev, "can't disable alarm\n");
David Brownellcb26b572007-01-05 16:36:37 -0800406 return -EIO;
407 }
Paul Mundt0053dc02008-10-15 22:03:01 -0700408 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
David Brownellcb26b572007-01-05 16:36:37 -0800409 }
410
411 /* set alarm */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700412 buf[0] = bin2bcd(t->time.tm_min);
Paul Mundt0053dc02008-10-15 22:03:01 -0700413 buf[1] = rs5c_hr2reg(rs5c, t->time.tm_hour);
414 buf[2] = 0x7f; /* any/all days */
415
416 for (i = 0; i < sizeof(buf); i++) {
417 addr = RS5C_ADDR(RS5C_REG_ALARM_A_MIN + i);
418 if (i2c_smbus_write_byte_data(client, addr, buf[i]) < 0) {
Jingoo Han0c6516e2013-02-21 16:45:27 -0800419 dev_dbg(dev, "can't set alarm time\n");
Paul Mundt0053dc02008-10-15 22:03:01 -0700420 return -EIO;
421 }
David Brownellcb26b572007-01-05 16:36:37 -0800422 }
423
424 /* ... and maybe enable its irq */
425 if (t->enabled) {
Paul Mundt0053dc02008-10-15 22:03:01 -0700426 addr = RS5C_ADDR(RS5C_REG_CTRL1);
427 buf[0] = rs5c->regs[RS5C_REG_CTRL1] | RS5C_CTRL1_AALE;
428 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0)
Jingoo Han0c6516e2013-02-21 16:45:27 -0800429 dev_warn(dev, "can't enable alarm\n");
Paul Mundt0053dc02008-10-15 22:03:01 -0700430 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
David Brownellcb26b572007-01-05 16:36:37 -0800431 }
432
433 return 0;
434}
435
Javier Martinez Canillas6fca3fc2016-04-26 18:17:35 -0400436#if IS_ENABLED(CONFIG_RTC_INTF_PROC)
David Brownellcb26b572007-01-05 16:36:37 -0800437
Alessandro Zummo7520b942006-03-27 01:16:45 -0800438static int rs5c372_rtc_proc(struct device *dev, struct seq_file *seq)
439{
440 int err, osc, trim;
441
Alessandro Zummoadfb4342006-04-10 22:54:43 -0700442 err = rs5c372_get_trim(to_i2c_client(dev), &osc, &trim);
443 if (err == 0) {
David Brownellcb26b572007-01-05 16:36:37 -0800444 seq_printf(seq, "crystal\t\t: %d.%03d KHz\n",
445 osc / 1000, osc % 1000);
446 seq_printf(seq, "trim\t\t: %d\n", trim);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800447 }
448
449 return 0;
450}
451
David Brownellcb26b572007-01-05 16:36:37 -0800452#else
453#define rs5c372_rtc_proc NULL
454#endif
455
David Brownellff8371a2006-09-30 23:28:17 -0700456static const struct rtc_class_ops rs5c372_rtc_ops = {
Alessandro Zummo7520b942006-03-27 01:16:45 -0800457 .proc = rs5c372_rtc_proc,
458 .read_time = rs5c372_rtc_read_time,
459 .set_time = rs5c372_rtc_set_time,
David Brownellcb26b572007-01-05 16:36:37 -0800460 .read_alarm = rs5c_read_alarm,
461 .set_alarm = rs5c_set_alarm,
John Stultz16380c12011-02-02 17:02:41 -0800462 .alarm_irq_enable = rs5c_rtc_alarm_irq_enable,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800463};
464
Javier Martinez Canillas6fca3fc2016-04-26 18:17:35 -0400465#if IS_ENABLED(CONFIG_RTC_INTF_SYSFS)
David Brownellcb26b572007-01-05 16:36:37 -0800466
Alessandro Zummo7520b942006-03-27 01:16:45 -0800467static ssize_t rs5c372_sysfs_show_trim(struct device *dev,
468 struct device_attribute *attr, char *buf)
469{
Alessandro Zummo82896072006-04-10 22:54:44 -0700470 int err, trim;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800471
Alessandro Zummo82896072006-04-10 22:54:44 -0700472 err = rs5c372_get_trim(to_i2c_client(dev), NULL, &trim);
473 if (err)
474 return err;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800475
David Brownellcb26b572007-01-05 16:36:37 -0800476 return sprintf(buf, "%d\n", trim);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800477}
478static DEVICE_ATTR(trim, S_IRUGO, rs5c372_sysfs_show_trim, NULL);
479
480static ssize_t rs5c372_sysfs_show_osc(struct device *dev,
481 struct device_attribute *attr, char *buf)
482{
Alessandro Zummo82896072006-04-10 22:54:44 -0700483 int err, osc;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800484
Alessandro Zummo82896072006-04-10 22:54:44 -0700485 err = rs5c372_get_trim(to_i2c_client(dev), &osc, NULL);
486 if (err)
487 return err;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800488
Alessandro Zummo82896072006-04-10 22:54:44 -0700489 return sprintf(buf, "%d.%03d KHz\n", osc / 1000, osc % 1000);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800490}
491static DEVICE_ATTR(osc, S_IRUGO, rs5c372_sysfs_show_osc, NULL);
492
David Brownellcb26b572007-01-05 16:36:37 -0800493static int rs5c_sysfs_register(struct device *dev)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800494{
David Brownellcb26b572007-01-05 16:36:37 -0800495 int err;
496
497 err = device_create_file(dev, &dev_attr_trim);
498 if (err)
499 return err;
500 err = device_create_file(dev, &dev_attr_osc);
501 if (err)
502 device_remove_file(dev, &dev_attr_trim);
503
504 return err;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800505}
506
David Brownelld8154612007-07-17 04:04:55 -0700507static void rs5c_sysfs_unregister(struct device *dev)
508{
509 device_remove_file(dev, &dev_attr_trim);
510 device_remove_file(dev, &dev_attr_osc);
511}
512
David Brownellcb26b572007-01-05 16:36:37 -0800513#else
514static int rs5c_sysfs_register(struct device *dev)
515{
516 return 0;
517}
David Brownelld8154612007-07-17 04:04:55 -0700518
519static void rs5c_sysfs_unregister(struct device *dev)
520{
521 /* nothing */
522}
David Brownellcb26b572007-01-05 16:36:37 -0800523#endif /* SYSFS */
524
525static struct i2c_driver rs5c372_driver;
526
Paul Mundt0053dc02008-10-15 22:03:01 -0700527static int rs5c_oscillator_setup(struct rs5c372 *rs5c372)
528{
529 unsigned char buf[2];
530 int addr, i, ret = 0;
531
Paul Mundt37fc5e22008-10-15 22:03:03 -0700532 if (rs5c372->type == rtc_r2025sd) {
Thomas Koellera9dbe552010-06-02 15:53:05 +0200533 if (rs5c372->regs[RS5C_REG_CTRL2] & R2025_CTRL2_XST)
Paul Mundt37fc5e22008-10-15 22:03:03 -0700534 return ret;
Thomas Koellera9dbe552010-06-02 15:53:05 +0200535 rs5c372->regs[RS5C_REG_CTRL2] |= R2025_CTRL2_XST;
Paul Mundt37fc5e22008-10-15 22:03:03 -0700536 } else {
537 if (!(rs5c372->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_XSTP))
538 return ret;
539 rs5c372->regs[RS5C_REG_CTRL2] &= ~RS5C_CTRL2_XSTP;
540 }
Paul Mundt0053dc02008-10-15 22:03:01 -0700541
542 addr = RS5C_ADDR(RS5C_REG_CTRL1);
543 buf[0] = rs5c372->regs[RS5C_REG_CTRL1];
544 buf[1] = rs5c372->regs[RS5C_REG_CTRL2];
545
546 /* use 24hr mode */
547 switch (rs5c372->type) {
548 case rtc_rs5c372a:
549 case rtc_rs5c372b:
550 buf[1] |= RS5C372_CTRL2_24;
551 rs5c372->time24 = 1;
552 break;
Paul Mundt37fc5e22008-10-15 22:03:03 -0700553 case rtc_r2025sd:
Lucas Stach550fcb82013-05-07 16:18:11 -0700554 case rtc_r2221tl:
Paul Mundt0053dc02008-10-15 22:03:01 -0700555 case rtc_rv5c386:
556 case rtc_rv5c387a:
557 buf[0] |= RV5C387_CTRL1_24;
558 rs5c372->time24 = 1;
559 break;
560 default:
561 /* impossible */
562 break;
563 }
564
565 for (i = 0; i < sizeof(buf); i++) {
566 addr = RS5C_ADDR(RS5C_REG_CTRL1 + i);
567 ret = i2c_smbus_write_byte_data(rs5c372->client, addr, buf[i]);
568 if (unlikely(ret < 0))
569 return ret;
570 }
571
572 rs5c372->regs[RS5C_REG_CTRL1] = buf[0];
573 rs5c372->regs[RS5C_REG_CTRL2] = buf[1];
574
575 return 0;
576}
577
Jean Delvared2653e92008-04-29 23:11:39 +0200578static int rs5c372_probe(struct i2c_client *client,
579 const struct i2c_device_id *id)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800580{
581 int err = 0;
Paul Mundt0053dc02008-10-15 22:03:01 -0700582 int smbus_mode = 0;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800583 struct rs5c372 *rs5c372;
David Brownellcb26b572007-01-05 16:36:37 -0800584 struct rtc_time tm;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800585
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700586 dev_dbg(&client->dev, "%s\n", __func__);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800587
Paul Mundt0053dc02008-10-15 22:03:01 -0700588 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C |
589 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK)) {
590 /*
591 * If we don't have any master mode adapter, try breaking
592 * it down in to the barest of capabilities.
593 */
594 if (i2c_check_functionality(client->adapter,
595 I2C_FUNC_SMBUS_BYTE_DATA |
596 I2C_FUNC_SMBUS_I2C_BLOCK))
597 smbus_mode = 1;
598 else {
599 /* Still no good, give up */
600 err = -ENODEV;
601 goto exit;
602 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800603 }
604
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700605 rs5c372 = devm_kzalloc(&client->dev, sizeof(struct rs5c372),
606 GFP_KERNEL);
607 if (!rs5c372) {
Alessandro Zummo7520b942006-03-27 01:16:45 -0800608 err = -ENOMEM;
609 goto exit;
610 }
David Brownellcb26b572007-01-05 16:36:37 -0800611
David Brownellcb26b572007-01-05 16:36:37 -0800612 rs5c372->client = client;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800613 i2c_set_clientdata(client, rs5c372);
Javier Martinez Canillasff764b82017-03-03 11:29:24 -0300614 if (client->dev.of_node)
615 rs5c372->type = (enum rtc_type)
616 of_device_get_match_data(&client->dev);
617 else
618 rs5c372->type = id->driver_data;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800619
Paul Mundte2bfe342008-04-28 02:11:57 -0700620 /* we read registers 0x0f then 0x00-0x0f; skip the first one */
621 rs5c372->regs = &rs5c372->buf[1];
Paul Mundt0053dc02008-10-15 22:03:01 -0700622 rs5c372->smbus = smbus_mode;
Paul Mundte2bfe342008-04-28 02:11:57 -0700623
David Brownellcb26b572007-01-05 16:36:37 -0800624 err = rs5c_get_regs(rs5c372);
625 if (err < 0)
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700626 goto exit;
David Brownellcb26b572007-01-05 16:36:37 -0800627
David Brownellcb26b572007-01-05 16:36:37 -0800628 /* clock may be set for am/pm or 24 hr time */
629 switch (rs5c372->type) {
630 case rtc_rs5c372a:
631 case rtc_rs5c372b:
632 /* alarm uses ALARM_A; and nINTRA on 372a, nINTR on 372b.
633 * so does periodic irq, except some 327a modes.
634 */
635 if (rs5c372->regs[RS5C_REG_CTRL2] & RS5C372_CTRL2_24)
636 rs5c372->time24 = 1;
637 break;
Paul Mundt37fc5e22008-10-15 22:03:03 -0700638 case rtc_r2025sd:
Lucas Stach550fcb82013-05-07 16:18:11 -0700639 case rtc_r2221tl:
David Brownellcb26b572007-01-05 16:36:37 -0800640 case rtc_rv5c386:
641 case rtc_rv5c387a:
642 if (rs5c372->regs[RS5C_REG_CTRL1] & RV5C387_CTRL1_24)
643 rs5c372->time24 = 1;
644 /* alarm uses ALARM_W; and nINTRB for alarm and periodic
645 * irq, on both 386 and 387
646 */
647 break;
648 default:
649 dev_err(&client->dev, "unknown RTC type\n");
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700650 goto exit;
David Brownellcb26b572007-01-05 16:36:37 -0800651 }
652
653 /* if the oscillator lost power and no other software (like
654 * the bootloader) set it up, do it here.
Paul Mundt37fc5e22008-10-15 22:03:03 -0700655 *
656 * The R2025S/D does this a little differently than the other
657 * parts, so we special case that..
David Brownellcb26b572007-01-05 16:36:37 -0800658 */
Paul Mundt0053dc02008-10-15 22:03:01 -0700659 err = rs5c_oscillator_setup(rs5c372);
660 if (unlikely(err < 0)) {
661 dev_err(&client->dev, "setup error\n");
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700662 goto exit;
David Brownellcb26b572007-01-05 16:36:37 -0800663 }
664
665 if (rs5c372_get_datetime(client, &tm) < 0)
666 dev_warn(&client->dev, "clock needs to be set\n");
667
Alexandre Bellonifa569112016-03-31 15:07:26 +0200668 dev_info(&client->dev, "%s found, %s\n",
David Brownellcb26b572007-01-05 16:36:37 -0800669 ({ char *s; switch (rs5c372->type) {
Paul Mundt37fc5e22008-10-15 22:03:03 -0700670 case rtc_r2025sd: s = "r2025sd"; break;
Lucas Stach550fcb82013-05-07 16:18:11 -0700671 case rtc_r2221tl: s = "r2221tl"; break;
David Brownellcb26b572007-01-05 16:36:37 -0800672 case rtc_rs5c372a: s = "rs5c372a"; break;
673 case rtc_rs5c372b: s = "rs5c372b"; break;
674 case rtc_rv5c386: s = "rv5c386"; break;
675 case rtc_rv5c387a: s = "rv5c387a"; break;
676 default: s = "chip"; break;
677 }; s;}),
678 rs5c372->time24 ? "24hr" : "am/pm"
679 );
680
David Brownelld8154612007-07-17 04:04:55 -0700681 /* REVISIT use client->irq to register alarm irq ... */
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700682 rs5c372->rtc = devm_rtc_device_register(&client->dev,
683 rs5c372_driver.driver.name,
684 &rs5c372_rtc_ops, THIS_MODULE);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800685
Riku Voipioc6f24f92006-12-06 20:39:13 -0800686 if (IS_ERR(rs5c372->rtc)) {
687 err = PTR_ERR(rs5c372->rtc);
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700688 goto exit;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800689 }
690
David Brownellcb26b572007-01-05 16:36:37 -0800691 err = rs5c_sysfs_register(&client->dev);
Riku Voipioc6f24f92006-12-06 20:39:13 -0800692 if (err)
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700693 goto exit;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800694
695 return 0;
696
Alessandro Zummo7520b942006-03-27 01:16:45 -0800697exit:
698 return err;
699}
700
David Brownelld8154612007-07-17 04:04:55 -0700701static int rs5c372_remove(struct i2c_client *client)
David Brownellcb26b572007-01-05 16:36:37 -0800702{
David Brownelld8154612007-07-17 04:04:55 -0700703 rs5c_sysfs_unregister(&client->dev);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800704 return 0;
705}
706
David Brownellcb26b572007-01-05 16:36:37 -0800707static struct i2c_driver rs5c372_driver = {
708 .driver = {
709 .name = "rtc-rs5c372",
Javier Martinez Canillasff764b82017-03-03 11:29:24 -0300710 .of_match_table = of_match_ptr(rs5c372_of_match),
David Brownellcb26b572007-01-05 16:36:37 -0800711 },
David Brownelld8154612007-07-17 04:04:55 -0700712 .probe = rs5c372_probe,
713 .remove = rs5c372_remove,
Jean Delvare3760f732008-04-29 23:11:40 +0200714 .id_table = rs5c372_id,
David Brownellcb26b572007-01-05 16:36:37 -0800715};
716
Axel Lin0abc9202012-03-23 15:02:31 -0700717module_i2c_driver(rs5c372_driver);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800718
719MODULE_AUTHOR(
720 "Pavel Mironchik <pmironchik@optifacio.net>, "
Paul Mundt0053dc02008-10-15 22:03:01 -0700721 "Alessandro Zummo <a.zummo@towertech.it>, "
722 "Paul Mundt <lethal@linux-sh.org>");
Alessandro Zummo7520b942006-03-27 01:16:45 -0800723MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
724MODULE_LICENSE("GPL");