blob: 76f565ae384d623d78acffbdf9b124149df67efe [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>
Alessandro Zummo7520b942006-03-27 01:16:45 -080018
Paul Mundt0053dc02008-10-15 22:03:01 -070019#define DRV_VERSION "0.6"
Alessandro Zummo7520b942006-03-27 01:16:45 -080020
David Brownellcb26b572007-01-05 16:36:37 -080021
22/*
23 * Ricoh has a family of I2C based RTCs, which differ only slightly from
24 * each other. Differences center on pinout (e.g. how many interrupts,
25 * output clock, etc) and how the control registers are used. The '372
26 * is significant only because that's the one this driver first supported.
27 */
Alessandro Zummo7520b942006-03-27 01:16:45 -080028#define RS5C372_REG_SECS 0
29#define RS5C372_REG_MINS 1
30#define RS5C372_REG_HOURS 2
31#define RS5C372_REG_WDAY 3
32#define RS5C372_REG_DAY 4
33#define RS5C372_REG_MONTH 5
34#define RS5C372_REG_YEAR 6
35#define RS5C372_REG_TRIM 7
David Brownellcb26b572007-01-05 16:36:37 -080036# define RS5C372_TRIM_XSL 0x80
37# define RS5C372_TRIM_MASK 0x7F
Alessandro Zummo7520b942006-03-27 01:16:45 -080038
David Brownellcb26b572007-01-05 16:36:37 -080039#define RS5C_REG_ALARM_A_MIN 8 /* or ALARM_W */
40#define RS5C_REG_ALARM_A_HOURS 9
41#define RS5C_REG_ALARM_A_WDAY 10
Alessandro Zummo7520b942006-03-27 01:16:45 -080042
David Brownellcb26b572007-01-05 16:36:37 -080043#define RS5C_REG_ALARM_B_MIN 11 /* or ALARM_D */
44#define RS5C_REG_ALARM_B_HOURS 12
45#define RS5C_REG_ALARM_B_WDAY 13 /* (ALARM_B only) */
Alessandro Zummo7520b942006-03-27 01:16:45 -080046
David Brownellcb26b572007-01-05 16:36:37 -080047#define RS5C_REG_CTRL1 14
48# define RS5C_CTRL1_AALE (1 << 7) /* or WALE */
49# define RS5C_CTRL1_BALE (1 << 6) /* or DALE */
50# define RV5C387_CTRL1_24 (1 << 5)
51# define RS5C372A_CTRL1_SL1 (1 << 5)
52# define RS5C_CTRL1_CT_MASK (7 << 0)
53# define RS5C_CTRL1_CT0 (0 << 0) /* no periodic irq */
54# define RS5C_CTRL1_CT4 (4 << 0) /* 1 Hz level irq */
55#define RS5C_REG_CTRL2 15
56# define RS5C372_CTRL2_24 (1 << 5)
Paul Mundt37fc5e22008-10-15 22:03:03 -070057# define R2025_CTRL2_XST (1 << 5)
58# define RS5C_CTRL2_XSTP (1 << 4) /* only if !R2025S/D */
David Brownellcb26b572007-01-05 16:36:37 -080059# define RS5C_CTRL2_CTFG (1 << 2)
60# define RS5C_CTRL2_AAFG (1 << 1) /* or WAFG */
61# define RS5C_CTRL2_BAFG (1 << 0) /* or DAFG */
Alessandro Zummo7520b942006-03-27 01:16:45 -080062
David Brownellcb26b572007-01-05 16:36:37 -080063
64/* to read (style 1) or write registers starting at R */
65#define RS5C_ADDR(R) (((R) << 4) | 0)
66
67
68enum rtc_type {
69 rtc_undef = 0,
Paul Mundt37fc5e22008-10-15 22:03:03 -070070 rtc_r2025sd,
David Brownellcb26b572007-01-05 16:36:37 -080071 rtc_rs5c372a,
72 rtc_rs5c372b,
73 rtc_rv5c386,
74 rtc_rv5c387a,
75};
76
Jean Delvare3760f732008-04-29 23:11:40 +020077static const struct i2c_device_id rs5c372_id[] = {
Paul Mundt37fc5e22008-10-15 22:03:03 -070078 { "r2025sd", rtc_r2025sd },
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
David Brownellcb26b572007-01-05 16:36:37 -080087/* REVISIT: this assumes that:
88 * - we're in the 21st century, so it's safe to ignore the century
89 * bit for rv5c38[67] (REG_MONTH bit 7);
90 * - we should use ALARM_A not ALARM_B (may be wrong on some boards)
91 */
Riku Voipioc6f24f92006-12-06 20:39:13 -080092struct rs5c372 {
David Brownellcb26b572007-01-05 16:36:37 -080093 struct i2c_client *client;
94 struct rtc_device *rtc;
95 enum rtc_type type;
96 unsigned time24:1;
97 unsigned has_irq:1;
Paul Mundt0053dc02008-10-15 22:03:01 -070098 unsigned smbus:1;
David Brownellcb26b572007-01-05 16:36:37 -080099 char buf[17];
100 char *regs;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800101};
102
David Brownellcb26b572007-01-05 16:36:37 -0800103static int rs5c_get_regs(struct rs5c372 *rs5c)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800104{
David Brownellcb26b572007-01-05 16:36:37 -0800105 struct i2c_client *client = rs5c->client;
106 struct i2c_msg msgs[] = {
Shubhrajyoti Da6067572012-10-04 17:14:22 -0700107 {
108 .addr = client->addr,
109 .flags = I2C_M_RD,
110 .len = sizeof(rs5c->buf),
111 .buf = rs5c->buf
112 },
David Brownellcb26b572007-01-05 16:36:37 -0800113 };
Alessandro Zummo7520b942006-03-27 01:16:45 -0800114
David Brownellcb26b572007-01-05 16:36:37 -0800115 /* This implements the third reading method from the datasheet, using
116 * an internal address that's reset after each transaction (by STOP)
117 * to 0x0f ... so we read extra registers, and skip the first one.
118 *
119 * The first method doesn't work with the iop3xx adapter driver, on at
120 * least 80219 chips; this works around that bug.
Paul Mundt0053dc02008-10-15 22:03:01 -0700121 *
122 * The third method on the other hand doesn't work for the SMBus-only
123 * configurations, so we use the the first method there, stripping off
124 * the extra register in the process.
Alessandro Zummo7520b942006-03-27 01:16:45 -0800125 */
Paul Mundt0053dc02008-10-15 22:03:01 -0700126 if (rs5c->smbus) {
127 int addr = RS5C_ADDR(RS5C372_REG_SECS);
128 int size = sizeof(rs5c->buf) - 1;
129
130 if (i2c_smbus_read_i2c_block_data(client, addr, size,
131 rs5c->buf + 1) != size) {
132 dev_warn(&client->dev, "can't read registers\n");
133 return -EIO;
134 }
135 } else {
136 if ((i2c_transfer(client->adapter, msgs, 1)) != 1) {
137 dev_warn(&client->dev, "can't read registers\n");
138 return -EIO;
139 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800140 }
141
David Brownellcb26b572007-01-05 16:36:37 -0800142 dev_dbg(&client->dev,
143 "%02x %02x %02x (%02x) %02x %02x %02x (%02x), "
144 "%02x %02x %02x, %02x %02x %02x; %02x %02x\n",
145 rs5c->regs[0], rs5c->regs[1], rs5c->regs[2], rs5c->regs[3],
146 rs5c->regs[4], rs5c->regs[5], rs5c->regs[6], rs5c->regs[7],
147 rs5c->regs[8], rs5c->regs[9], rs5c->regs[10], rs5c->regs[11],
148 rs5c->regs[12], rs5c->regs[13], rs5c->regs[14], rs5c->regs[15]);
149
150 return 0;
151}
152
153static unsigned rs5c_reg2hr(struct rs5c372 *rs5c, unsigned reg)
154{
155 unsigned hour;
156
157 if (rs5c->time24)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700158 return bcd2bin(reg & 0x3f);
David Brownellcb26b572007-01-05 16:36:37 -0800159
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700160 hour = bcd2bin(reg & 0x1f);
David Brownellcb26b572007-01-05 16:36:37 -0800161 if (hour == 12)
162 hour = 0;
163 if (reg & 0x20)
164 hour += 12;
165 return hour;
166}
167
168static unsigned rs5c_hr2reg(struct rs5c372 *rs5c, unsigned hour)
169{
170 if (rs5c->time24)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700171 return bin2bcd(hour);
David Brownellcb26b572007-01-05 16:36:37 -0800172
173 if (hour > 12)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700174 return 0x20 | bin2bcd(hour - 12);
David Brownellcb26b572007-01-05 16:36:37 -0800175 if (hour == 12)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700176 return 0x20 | bin2bcd(12);
David Brownellcb26b572007-01-05 16:36:37 -0800177 if (hour == 0)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700178 return bin2bcd(12);
179 return bin2bcd(hour);
David Brownellcb26b572007-01-05 16:36:37 -0800180}
181
182static int rs5c372_get_datetime(struct i2c_client *client, struct rtc_time *tm)
183{
184 struct rs5c372 *rs5c = i2c_get_clientdata(client);
185 int status = rs5c_get_regs(rs5c);
186
187 if (status < 0)
188 return status;
189
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700190 tm->tm_sec = bcd2bin(rs5c->regs[RS5C372_REG_SECS] & 0x7f);
191 tm->tm_min = bcd2bin(rs5c->regs[RS5C372_REG_MINS] & 0x7f);
David Brownellcb26b572007-01-05 16:36:37 -0800192 tm->tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C372_REG_HOURS]);
193
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700194 tm->tm_wday = bcd2bin(rs5c->regs[RS5C372_REG_WDAY] & 0x07);
195 tm->tm_mday = bcd2bin(rs5c->regs[RS5C372_REG_DAY] & 0x3f);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800196
197 /* tm->tm_mon is zero-based */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700198 tm->tm_mon = bcd2bin(rs5c->regs[RS5C372_REG_MONTH] & 0x1f) - 1;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800199
200 /* year is 1900 + tm->tm_year */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700201 tm->tm_year = bcd2bin(rs5c->regs[RS5C372_REG_YEAR]) + 100;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800202
203 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
204 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700205 __func__,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800206 tm->tm_sec, tm->tm_min, tm->tm_hour,
207 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
208
David Brownellcb26b572007-01-05 16:36:37 -0800209 /* rtc might need initialization */
210 return rtc_valid_tm(tm);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800211}
212
213static int rs5c372_set_datetime(struct i2c_client *client, struct rtc_time *tm)
214{
David Brownellcb26b572007-01-05 16:36:37 -0800215 struct rs5c372 *rs5c = i2c_get_clientdata(client);
Wolfram Sang11836492010-12-21 17:24:24 -0800216 unsigned char buf[7];
Paul Mundt0053dc02008-10-15 22:03:01 -0700217 int addr;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800218
David Brownellcb26b572007-01-05 16:36:37 -0800219 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d "
Alessandro Zummo7520b942006-03-27 01:16:45 -0800220 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700221 __func__,
David Brownellcb26b572007-01-05 16:36:37 -0800222 tm->tm_sec, tm->tm_min, tm->tm_hour,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800223 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
224
Paul Mundt0053dc02008-10-15 22:03:01 -0700225 addr = RS5C_ADDR(RS5C372_REG_SECS);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700226 buf[0] = bin2bcd(tm->tm_sec);
227 buf[1] = bin2bcd(tm->tm_min);
Paul Mundt0053dc02008-10-15 22:03:01 -0700228 buf[2] = rs5c_hr2reg(rs5c, tm->tm_hour);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700229 buf[3] = bin2bcd(tm->tm_wday);
230 buf[4] = bin2bcd(tm->tm_mday);
231 buf[5] = bin2bcd(tm->tm_mon + 1);
232 buf[6] = bin2bcd(tm->tm_year - 100);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800233
Paul Mundt0053dc02008-10-15 22:03:01 -0700234 if (i2c_smbus_write_i2c_block_data(client, addr, sizeof(buf), buf) < 0) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700235 dev_err(&client->dev, "%s: write error\n", __func__);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800236 return -EIO;
237 }
238
239 return 0;
240}
241
David Brownellcb26b572007-01-05 16:36:37 -0800242#if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
243#define NEED_TRIM
244#endif
245
246#if defined(CONFIG_RTC_INTF_SYSFS) || defined(CONFIG_RTC_INTF_SYSFS_MODULE)
247#define NEED_TRIM
248#endif
249
250#ifdef NEED_TRIM
Alessandro Zummo7520b942006-03-27 01:16:45 -0800251static int rs5c372_get_trim(struct i2c_client *client, int *osc, int *trim)
252{
Riku Voipioc6f24f92006-12-06 20:39:13 -0800253 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
David Brownellcb26b572007-01-05 16:36:37 -0800254 u8 tmp = rs5c372->regs[RS5C372_REG_TRIM];
Alessandro Zummo7520b942006-03-27 01:16:45 -0800255
Alessandro Zummo7520b942006-03-27 01:16:45 -0800256 if (osc)
Riku Voipioc6f24f92006-12-06 20:39:13 -0800257 *osc = (tmp & RS5C372_TRIM_XSL) ? 32000 : 32768;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800258
Adrian Bunk17ad78e2006-11-25 11:09:29 -0800259 if (trim) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700260 dev_dbg(&client->dev, "%s: raw trim=%x\n", __func__, tmp);
David Brownellcb26b572007-01-05 16:36:37 -0800261 tmp &= RS5C372_TRIM_MASK;
262 if (tmp & 0x3e) {
263 int t = tmp & 0x3f;
264
265 if (tmp & 0x40)
266 t = (~t | (s8)0xc0) + 1;
267 else
268 t = t - 1;
269
270 tmp = t * 2;
271 } else
272 tmp = 0;
273 *trim = tmp;
Adrian Bunk17ad78e2006-11-25 11:09:29 -0800274 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800275
276 return 0;
277}
David Brownellcb26b572007-01-05 16:36:37 -0800278#endif
Alessandro Zummo7520b942006-03-27 01:16:45 -0800279
280static int rs5c372_rtc_read_time(struct device *dev, struct rtc_time *tm)
281{
282 return rs5c372_get_datetime(to_i2c_client(dev), tm);
283}
284
285static int rs5c372_rtc_set_time(struct device *dev, struct rtc_time *tm)
286{
287 return rs5c372_set_datetime(to_i2c_client(dev), tm);
288}
289
David Brownellcb26b572007-01-05 16:36:37 -0800290
John Stultz16380c12011-02-02 17:02:41 -0800291static int rs5c_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
292{
293 struct i2c_client *client = to_i2c_client(dev);
294 struct rs5c372 *rs5c = i2c_get_clientdata(client);
295 unsigned char buf;
296 int status, addr;
297
298 buf = rs5c->regs[RS5C_REG_CTRL1];
299
300 if (!rs5c->has_irq)
301 return -EINVAL;
302
303 status = rs5c_get_regs(rs5c);
304 if (status < 0)
305 return status;
306
307 addr = RS5C_ADDR(RS5C_REG_CTRL1);
308 if (enabled)
309 buf |= RS5C_CTRL1_AALE;
310 else
311 buf &= ~RS5C_CTRL1_AALE;
312
313 if (i2c_smbus_write_byte_data(client, addr, buf) < 0) {
314 printk(KERN_WARNING "%s: can't update alarm\n",
315 rs5c->rtc->name);
316 status = -EIO;
317 } else
318 rs5c->regs[RS5C_REG_CTRL1] = buf;
319
320 return status;
321}
322
323
David Brownellcb26b572007-01-05 16:36:37 -0800324/* NOTE: Since RTC_WKALM_{RD,SET} were originally defined for EFI,
325 * which only exposes a polled programming interface; and since
326 * these calls map directly to those EFI requests; we don't demand
327 * we have an IRQ for this chip when we go through this API.
328 *
329 * The older x86_pc derived RTC_ALM_{READ,SET} calls require irqs
330 * though, managed through RTC_AIE_{ON,OFF} requests.
331 */
332
333static int rs5c_read_alarm(struct device *dev, struct rtc_wkalrm *t)
334{
335 struct i2c_client *client = to_i2c_client(dev);
336 struct rs5c372 *rs5c = i2c_get_clientdata(client);
337 int status;
338
339 status = rs5c_get_regs(rs5c);
340 if (status < 0)
341 return status;
342
343 /* report alarm time */
344 t->time.tm_sec = 0;
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700345 t->time.tm_min = bcd2bin(rs5c->regs[RS5C_REG_ALARM_A_MIN] & 0x7f);
David Brownellcb26b572007-01-05 16:36:37 -0800346 t->time.tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C_REG_ALARM_A_HOURS]);
347 t->time.tm_mday = -1;
348 t->time.tm_mon = -1;
349 t->time.tm_year = -1;
350 t->time.tm_wday = -1;
351 t->time.tm_yday = -1;
352 t->time.tm_isdst = -1;
353
354 /* ... and status */
355 t->enabled = !!(rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE);
356 t->pending = !!(rs5c->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_AAFG);
357
358 return 0;
359}
360
361static int rs5c_set_alarm(struct device *dev, struct rtc_wkalrm *t)
362{
363 struct i2c_client *client = to_i2c_client(dev);
364 struct rs5c372 *rs5c = i2c_get_clientdata(client);
Paul Mundt0053dc02008-10-15 22:03:01 -0700365 int status, addr, i;
366 unsigned char buf[3];
David Brownellcb26b572007-01-05 16:36:37 -0800367
368 /* only handle up to 24 hours in the future, like RTC_ALM_SET */
369 if (t->time.tm_mday != -1
370 || t->time.tm_mon != -1
371 || t->time.tm_year != -1)
372 return -EINVAL;
373
374 /* REVISIT: round up tm_sec */
375
376 /* if needed, disable irq (clears pending status) */
377 status = rs5c_get_regs(rs5c);
378 if (status < 0)
379 return status;
380 if (rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE) {
Paul Mundt0053dc02008-10-15 22:03:01 -0700381 addr = RS5C_ADDR(RS5C_REG_CTRL1);
382 buf[0] = rs5c->regs[RS5C_REG_CTRL1] & ~RS5C_CTRL1_AALE;
383 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0) {
David Brownellcb26b572007-01-05 16:36:37 -0800384 pr_debug("%s: can't disable alarm\n", rs5c->rtc->name);
385 return -EIO;
386 }
Paul Mundt0053dc02008-10-15 22:03:01 -0700387 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
David Brownellcb26b572007-01-05 16:36:37 -0800388 }
389
390 /* set alarm */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700391 buf[0] = bin2bcd(t->time.tm_min);
Paul Mundt0053dc02008-10-15 22:03:01 -0700392 buf[1] = rs5c_hr2reg(rs5c, t->time.tm_hour);
393 buf[2] = 0x7f; /* any/all days */
394
395 for (i = 0; i < sizeof(buf); i++) {
396 addr = RS5C_ADDR(RS5C_REG_ALARM_A_MIN + i);
397 if (i2c_smbus_write_byte_data(client, addr, buf[i]) < 0) {
398 pr_debug("%s: can't set alarm time\n", rs5c->rtc->name);
399 return -EIO;
400 }
David Brownellcb26b572007-01-05 16:36:37 -0800401 }
402
403 /* ... and maybe enable its irq */
404 if (t->enabled) {
Paul Mundt0053dc02008-10-15 22:03:01 -0700405 addr = RS5C_ADDR(RS5C_REG_CTRL1);
406 buf[0] = rs5c->regs[RS5C_REG_CTRL1] | RS5C_CTRL1_AALE;
407 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0)
David Brownellcb26b572007-01-05 16:36:37 -0800408 printk(KERN_WARNING "%s: can't enable alarm\n",
409 rs5c->rtc->name);
Paul Mundt0053dc02008-10-15 22:03:01 -0700410 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
David Brownellcb26b572007-01-05 16:36:37 -0800411 }
412
413 return 0;
414}
415
416#if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
417
Alessandro Zummo7520b942006-03-27 01:16:45 -0800418static int rs5c372_rtc_proc(struct device *dev, struct seq_file *seq)
419{
420 int err, osc, trim;
421
Alessandro Zummoadfb4342006-04-10 22:54:43 -0700422 err = rs5c372_get_trim(to_i2c_client(dev), &osc, &trim);
423 if (err == 0) {
David Brownellcb26b572007-01-05 16:36:37 -0800424 seq_printf(seq, "crystal\t\t: %d.%03d KHz\n",
425 osc / 1000, osc % 1000);
426 seq_printf(seq, "trim\t\t: %d\n", trim);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800427 }
428
429 return 0;
430}
431
David Brownellcb26b572007-01-05 16:36:37 -0800432#else
433#define rs5c372_rtc_proc NULL
434#endif
435
David Brownellff8371a2006-09-30 23:28:17 -0700436static const struct rtc_class_ops rs5c372_rtc_ops = {
Alessandro Zummo7520b942006-03-27 01:16:45 -0800437 .proc = rs5c372_rtc_proc,
438 .read_time = rs5c372_rtc_read_time,
439 .set_time = rs5c372_rtc_set_time,
David Brownellcb26b572007-01-05 16:36:37 -0800440 .read_alarm = rs5c_read_alarm,
441 .set_alarm = rs5c_set_alarm,
John Stultz16380c12011-02-02 17:02:41 -0800442 .alarm_irq_enable = rs5c_rtc_alarm_irq_enable,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800443};
444
David Brownellcb26b572007-01-05 16:36:37 -0800445#if defined(CONFIG_RTC_INTF_SYSFS) || defined(CONFIG_RTC_INTF_SYSFS_MODULE)
446
Alessandro Zummo7520b942006-03-27 01:16:45 -0800447static ssize_t rs5c372_sysfs_show_trim(struct device *dev,
448 struct device_attribute *attr, char *buf)
449{
Alessandro Zummo82896072006-04-10 22:54:44 -0700450 int err, trim;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800451
Alessandro Zummo82896072006-04-10 22:54:44 -0700452 err = rs5c372_get_trim(to_i2c_client(dev), NULL, &trim);
453 if (err)
454 return err;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800455
David Brownellcb26b572007-01-05 16:36:37 -0800456 return sprintf(buf, "%d\n", trim);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800457}
458static DEVICE_ATTR(trim, S_IRUGO, rs5c372_sysfs_show_trim, NULL);
459
460static ssize_t rs5c372_sysfs_show_osc(struct device *dev,
461 struct device_attribute *attr, char *buf)
462{
Alessandro Zummo82896072006-04-10 22:54:44 -0700463 int err, osc;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800464
Alessandro Zummo82896072006-04-10 22:54:44 -0700465 err = rs5c372_get_trim(to_i2c_client(dev), &osc, NULL);
466 if (err)
467 return err;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800468
Alessandro Zummo82896072006-04-10 22:54:44 -0700469 return sprintf(buf, "%d.%03d KHz\n", osc / 1000, osc % 1000);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800470}
471static DEVICE_ATTR(osc, S_IRUGO, rs5c372_sysfs_show_osc, NULL);
472
David Brownellcb26b572007-01-05 16:36:37 -0800473static int rs5c_sysfs_register(struct device *dev)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800474{
David Brownellcb26b572007-01-05 16:36:37 -0800475 int err;
476
477 err = device_create_file(dev, &dev_attr_trim);
478 if (err)
479 return err;
480 err = device_create_file(dev, &dev_attr_osc);
481 if (err)
482 device_remove_file(dev, &dev_attr_trim);
483
484 return err;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800485}
486
David Brownelld8154612007-07-17 04:04:55 -0700487static void rs5c_sysfs_unregister(struct device *dev)
488{
489 device_remove_file(dev, &dev_attr_trim);
490 device_remove_file(dev, &dev_attr_osc);
491}
492
David Brownellcb26b572007-01-05 16:36:37 -0800493#else
494static int rs5c_sysfs_register(struct device *dev)
495{
496 return 0;
497}
David Brownelld8154612007-07-17 04:04:55 -0700498
499static void rs5c_sysfs_unregister(struct device *dev)
500{
501 /* nothing */
502}
David Brownellcb26b572007-01-05 16:36:37 -0800503#endif /* SYSFS */
504
505static struct i2c_driver rs5c372_driver;
506
Paul Mundt0053dc02008-10-15 22:03:01 -0700507static int rs5c_oscillator_setup(struct rs5c372 *rs5c372)
508{
509 unsigned char buf[2];
510 int addr, i, ret = 0;
511
Paul Mundt37fc5e22008-10-15 22:03:03 -0700512 if (rs5c372->type == rtc_r2025sd) {
513 if (!(rs5c372->regs[RS5C_REG_CTRL2] & R2025_CTRL2_XST))
514 return ret;
515 rs5c372->regs[RS5C_REG_CTRL2] &= ~R2025_CTRL2_XST;
516 } else {
517 if (!(rs5c372->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_XSTP))
518 return ret;
519 rs5c372->regs[RS5C_REG_CTRL2] &= ~RS5C_CTRL2_XSTP;
520 }
Paul Mundt0053dc02008-10-15 22:03:01 -0700521
522 addr = RS5C_ADDR(RS5C_REG_CTRL1);
523 buf[0] = rs5c372->regs[RS5C_REG_CTRL1];
524 buf[1] = rs5c372->regs[RS5C_REG_CTRL2];
525
526 /* use 24hr mode */
527 switch (rs5c372->type) {
528 case rtc_rs5c372a:
529 case rtc_rs5c372b:
530 buf[1] |= RS5C372_CTRL2_24;
531 rs5c372->time24 = 1;
532 break;
Paul Mundt37fc5e22008-10-15 22:03:03 -0700533 case rtc_r2025sd:
Paul Mundt0053dc02008-10-15 22:03:01 -0700534 case rtc_rv5c386:
535 case rtc_rv5c387a:
536 buf[0] |= RV5C387_CTRL1_24;
537 rs5c372->time24 = 1;
538 break;
539 default:
540 /* impossible */
541 break;
542 }
543
544 for (i = 0; i < sizeof(buf); i++) {
545 addr = RS5C_ADDR(RS5C_REG_CTRL1 + i);
546 ret = i2c_smbus_write_byte_data(rs5c372->client, addr, buf[i]);
547 if (unlikely(ret < 0))
548 return ret;
549 }
550
551 rs5c372->regs[RS5C_REG_CTRL1] = buf[0];
552 rs5c372->regs[RS5C_REG_CTRL2] = buf[1];
553
554 return 0;
555}
556
Jean Delvared2653e92008-04-29 23:11:39 +0200557static int rs5c372_probe(struct i2c_client *client,
558 const struct i2c_device_id *id)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800559{
560 int err = 0;
Paul Mundt0053dc02008-10-15 22:03:01 -0700561 int smbus_mode = 0;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800562 struct rs5c372 *rs5c372;
David Brownellcb26b572007-01-05 16:36:37 -0800563 struct rtc_time tm;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800564
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700565 dev_dbg(&client->dev, "%s\n", __func__);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800566
Paul Mundt0053dc02008-10-15 22:03:01 -0700567 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C |
568 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK)) {
569 /*
570 * If we don't have any master mode adapter, try breaking
571 * it down in to the barest of capabilities.
572 */
573 if (i2c_check_functionality(client->adapter,
574 I2C_FUNC_SMBUS_BYTE_DATA |
575 I2C_FUNC_SMBUS_I2C_BLOCK))
576 smbus_mode = 1;
577 else {
578 /* Still no good, give up */
579 err = -ENODEV;
580 goto exit;
581 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800582 }
583
Riku Voipioc6f24f92006-12-06 20:39:13 -0800584 if (!(rs5c372 = kzalloc(sizeof(struct rs5c372), GFP_KERNEL))) {
Alessandro Zummo7520b942006-03-27 01:16:45 -0800585 err = -ENOMEM;
586 goto exit;
587 }
David Brownellcb26b572007-01-05 16:36:37 -0800588
David Brownellcb26b572007-01-05 16:36:37 -0800589 rs5c372->client = client;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800590 i2c_set_clientdata(client, rs5c372);
Jean Delvare3760f732008-04-29 23:11:40 +0200591 rs5c372->type = id->driver_data;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800592
Paul Mundte2bfe342008-04-28 02:11:57 -0700593 /* we read registers 0x0f then 0x00-0x0f; skip the first one */
594 rs5c372->regs = &rs5c372->buf[1];
Paul Mundt0053dc02008-10-15 22:03:01 -0700595 rs5c372->smbus = smbus_mode;
Paul Mundte2bfe342008-04-28 02:11:57 -0700596
David Brownellcb26b572007-01-05 16:36:37 -0800597 err = rs5c_get_regs(rs5c372);
598 if (err < 0)
David Brownelld8154612007-07-17 04:04:55 -0700599 goto exit_kfree;
David Brownellcb26b572007-01-05 16:36:37 -0800600
David Brownellcb26b572007-01-05 16:36:37 -0800601 /* clock may be set for am/pm or 24 hr time */
602 switch (rs5c372->type) {
603 case rtc_rs5c372a:
604 case rtc_rs5c372b:
605 /* alarm uses ALARM_A; and nINTRA on 372a, nINTR on 372b.
606 * so does periodic irq, except some 327a modes.
607 */
608 if (rs5c372->regs[RS5C_REG_CTRL2] & RS5C372_CTRL2_24)
609 rs5c372->time24 = 1;
610 break;
Paul Mundt37fc5e22008-10-15 22:03:03 -0700611 case rtc_r2025sd:
David Brownellcb26b572007-01-05 16:36:37 -0800612 case rtc_rv5c386:
613 case rtc_rv5c387a:
614 if (rs5c372->regs[RS5C_REG_CTRL1] & RV5C387_CTRL1_24)
615 rs5c372->time24 = 1;
616 /* alarm uses ALARM_W; and nINTRB for alarm and periodic
617 * irq, on both 386 and 387
618 */
619 break;
620 default:
621 dev_err(&client->dev, "unknown RTC type\n");
David Brownelld8154612007-07-17 04:04:55 -0700622 goto exit_kfree;
David Brownellcb26b572007-01-05 16:36:37 -0800623 }
624
625 /* if the oscillator lost power and no other software (like
626 * the bootloader) set it up, do it here.
Paul Mundt37fc5e22008-10-15 22:03:03 -0700627 *
628 * The R2025S/D does this a little differently than the other
629 * parts, so we special case that..
David Brownellcb26b572007-01-05 16:36:37 -0800630 */
Paul Mundt0053dc02008-10-15 22:03:01 -0700631 err = rs5c_oscillator_setup(rs5c372);
632 if (unlikely(err < 0)) {
633 dev_err(&client->dev, "setup error\n");
634 goto exit_kfree;
David Brownellcb26b572007-01-05 16:36:37 -0800635 }
636
637 if (rs5c372_get_datetime(client, &tm) < 0)
638 dev_warn(&client->dev, "clock needs to be set\n");
639
640 dev_info(&client->dev, "%s found, %s, driver version " DRV_VERSION "\n",
641 ({ char *s; switch (rs5c372->type) {
Paul Mundt37fc5e22008-10-15 22:03:03 -0700642 case rtc_r2025sd: s = "r2025sd"; break;
David Brownellcb26b572007-01-05 16:36:37 -0800643 case rtc_rs5c372a: s = "rs5c372a"; break;
644 case rtc_rs5c372b: s = "rs5c372b"; break;
645 case rtc_rv5c386: s = "rv5c386"; break;
646 case rtc_rv5c387a: s = "rv5c387a"; break;
647 default: s = "chip"; break;
648 }; s;}),
649 rs5c372->time24 ? "24hr" : "am/pm"
650 );
651
David Brownelld8154612007-07-17 04:04:55 -0700652 /* REVISIT use client->irq to register alarm irq ... */
Alessandro Zummo7520b942006-03-27 01:16:45 -0800653
Riku Voipioc6f24f92006-12-06 20:39:13 -0800654 rs5c372->rtc = rtc_device_register(rs5c372_driver.driver.name,
655 &client->dev, &rs5c372_rtc_ops, THIS_MODULE);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800656
Riku Voipioc6f24f92006-12-06 20:39:13 -0800657 if (IS_ERR(rs5c372->rtc)) {
658 err = PTR_ERR(rs5c372->rtc);
David Brownelld8154612007-07-17 04:04:55 -0700659 goto exit_kfree;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800660 }
661
David Brownellcb26b572007-01-05 16:36:37 -0800662 err = rs5c_sysfs_register(&client->dev);
Riku Voipioc6f24f92006-12-06 20:39:13 -0800663 if (err)
664 goto exit_devreg;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800665
666 return 0;
667
Jeff Garzik91046a82006-12-06 20:35:34 -0800668exit_devreg:
Riku Voipioc6f24f92006-12-06 20:39:13 -0800669 rtc_device_unregister(rs5c372->rtc);
Jeff Garzik91046a82006-12-06 20:35:34 -0800670
Alessandro Zummo7520b942006-03-27 01:16:45 -0800671exit_kfree:
Riku Voipioc6f24f92006-12-06 20:39:13 -0800672 kfree(rs5c372);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800673
674exit:
675 return err;
676}
677
David Brownelld8154612007-07-17 04:04:55 -0700678static int rs5c372_remove(struct i2c_client *client)
David Brownellcb26b572007-01-05 16:36:37 -0800679{
Riku Voipioc6f24f92006-12-06 20:39:13 -0800680 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800681
David Brownelld8154612007-07-17 04:04:55 -0700682 rtc_device_unregister(rs5c372->rtc);
683 rs5c_sysfs_unregister(&client->dev);
Riku Voipioc6f24f92006-12-06 20:39:13 -0800684 kfree(rs5c372);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800685 return 0;
686}
687
David Brownellcb26b572007-01-05 16:36:37 -0800688static struct i2c_driver rs5c372_driver = {
689 .driver = {
690 .name = "rtc-rs5c372",
691 },
David Brownelld8154612007-07-17 04:04:55 -0700692 .probe = rs5c372_probe,
693 .remove = rs5c372_remove,
Jean Delvare3760f732008-04-29 23:11:40 +0200694 .id_table = rs5c372_id,
David Brownellcb26b572007-01-05 16:36:37 -0800695};
696
Axel Lin0abc9202012-03-23 15:02:31 -0700697module_i2c_driver(rs5c372_driver);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800698
699MODULE_AUTHOR(
700 "Pavel Mironchik <pmironchik@optifacio.net>, "
Paul Mundt0053dc02008-10-15 22:03:01 -0700701 "Alessandro Zummo <a.zummo@towertech.it>, "
702 "Paul Mundt <lethal@linux-sh.org>");
Alessandro Zummo7520b942006-03-27 01:16:45 -0800703MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
704MODULE_LICENSE("GPL");
705MODULE_VERSION(DRV_VERSION);