blob: ccf54f06396bf251bf42be6007c40db21b84a5c6 [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,
Lucas Stach550fcb82013-05-07 16:18:11 -070071 rtc_r2221tl,
David Brownellcb26b572007-01-05 16:36:37 -080072 rtc_rs5c372a,
73 rtc_rs5c372b,
74 rtc_rv5c386,
75 rtc_rv5c387a,
76};
77
Jean Delvare3760f732008-04-29 23:11:40 +020078static const struct i2c_device_id rs5c372_id[] = {
Paul Mundt37fc5e22008-10-15 22:03:03 -070079 { "r2025sd", rtc_r2025sd },
Lucas Stach550fcb82013-05-07 16:18:11 -070080 { "r2221tl", rtc_r2221tl },
Jean Delvare3760f732008-04-29 23:11:40 +020081 { "rs5c372a", rtc_rs5c372a },
82 { "rs5c372b", rtc_rs5c372b },
83 { "rv5c386", rtc_rv5c386 },
84 { "rv5c387a", rtc_rv5c387a },
85 { }
86};
87MODULE_DEVICE_TABLE(i2c, rs5c372_id);
88
David Brownellcb26b572007-01-05 16:36:37 -080089/* REVISIT: this assumes that:
90 * - we're in the 21st century, so it's safe to ignore the century
91 * bit for rv5c38[67] (REG_MONTH bit 7);
92 * - we should use ALARM_A not ALARM_B (may be wrong on some boards)
93 */
Riku Voipioc6f24f92006-12-06 20:39:13 -080094struct rs5c372 {
David Brownellcb26b572007-01-05 16:36:37 -080095 struct i2c_client *client;
96 struct rtc_device *rtc;
97 enum rtc_type type;
98 unsigned time24:1;
99 unsigned has_irq:1;
Paul Mundt0053dc02008-10-15 22:03:01 -0700100 unsigned smbus:1;
David Brownellcb26b572007-01-05 16:36:37 -0800101 char buf[17];
102 char *regs;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800103};
104
David Brownellcb26b572007-01-05 16:36:37 -0800105static int rs5c_get_regs(struct rs5c372 *rs5c)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800106{
David Brownellcb26b572007-01-05 16:36:37 -0800107 struct i2c_client *client = rs5c->client;
108 struct i2c_msg msgs[] = {
Shubhrajyoti Da6067572012-10-04 17:14:22 -0700109 {
110 .addr = client->addr,
111 .flags = I2C_M_RD,
112 .len = sizeof(rs5c->buf),
113 .buf = rs5c->buf
114 },
David Brownellcb26b572007-01-05 16:36:37 -0800115 };
Alessandro Zummo7520b942006-03-27 01:16:45 -0800116
David Brownellcb26b572007-01-05 16:36:37 -0800117 /* This implements the third reading method from the datasheet, using
118 * an internal address that's reset after each transaction (by STOP)
119 * to 0x0f ... so we read extra registers, and skip the first one.
120 *
121 * The first method doesn't work with the iop3xx adapter driver, on at
122 * least 80219 chips; this works around that bug.
Paul Mundt0053dc02008-10-15 22:03:01 -0700123 *
124 * The third method on the other hand doesn't work for the SMBus-only
125 * configurations, so we use the the first method there, stripping off
126 * the extra register in the process.
Alessandro Zummo7520b942006-03-27 01:16:45 -0800127 */
Paul Mundt0053dc02008-10-15 22:03:01 -0700128 if (rs5c->smbus) {
129 int addr = RS5C_ADDR(RS5C372_REG_SECS);
130 int size = sizeof(rs5c->buf) - 1;
131
132 if (i2c_smbus_read_i2c_block_data(client, addr, size,
133 rs5c->buf + 1) != size) {
134 dev_warn(&client->dev, "can't read registers\n");
135 return -EIO;
136 }
137 } else {
138 if ((i2c_transfer(client->adapter, msgs, 1)) != 1) {
139 dev_warn(&client->dev, "can't read registers\n");
140 return -EIO;
141 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800142 }
143
David Brownellcb26b572007-01-05 16:36:37 -0800144 dev_dbg(&client->dev,
145 "%02x %02x %02x (%02x) %02x %02x %02x (%02x), "
146 "%02x %02x %02x, %02x %02x %02x; %02x %02x\n",
147 rs5c->regs[0], rs5c->regs[1], rs5c->regs[2], rs5c->regs[3],
148 rs5c->regs[4], rs5c->regs[5], rs5c->regs[6], rs5c->regs[7],
149 rs5c->regs[8], rs5c->regs[9], rs5c->regs[10], rs5c->regs[11],
150 rs5c->regs[12], rs5c->regs[13], rs5c->regs[14], rs5c->regs[15]);
151
152 return 0;
153}
154
155static unsigned rs5c_reg2hr(struct rs5c372 *rs5c, unsigned reg)
156{
157 unsigned hour;
158
159 if (rs5c->time24)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700160 return bcd2bin(reg & 0x3f);
David Brownellcb26b572007-01-05 16:36:37 -0800161
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700162 hour = bcd2bin(reg & 0x1f);
David Brownellcb26b572007-01-05 16:36:37 -0800163 if (hour == 12)
164 hour = 0;
165 if (reg & 0x20)
166 hour += 12;
167 return hour;
168}
169
170static unsigned rs5c_hr2reg(struct rs5c372 *rs5c, unsigned hour)
171{
172 if (rs5c->time24)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700173 return bin2bcd(hour);
David Brownellcb26b572007-01-05 16:36:37 -0800174
175 if (hour > 12)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700176 return 0x20 | bin2bcd(hour - 12);
David Brownellcb26b572007-01-05 16:36:37 -0800177 if (hour == 12)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700178 return 0x20 | bin2bcd(12);
David Brownellcb26b572007-01-05 16:36:37 -0800179 if (hour == 0)
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700180 return bin2bcd(12);
181 return bin2bcd(hour);
David Brownellcb26b572007-01-05 16:36:37 -0800182}
183
184static int rs5c372_get_datetime(struct i2c_client *client, struct rtc_time *tm)
185{
186 struct rs5c372 *rs5c = i2c_get_clientdata(client);
187 int status = rs5c_get_regs(rs5c);
188
189 if (status < 0)
190 return status;
191
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700192 tm->tm_sec = bcd2bin(rs5c->regs[RS5C372_REG_SECS] & 0x7f);
193 tm->tm_min = bcd2bin(rs5c->regs[RS5C372_REG_MINS] & 0x7f);
David Brownellcb26b572007-01-05 16:36:37 -0800194 tm->tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C372_REG_HOURS]);
195
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700196 tm->tm_wday = bcd2bin(rs5c->regs[RS5C372_REG_WDAY] & 0x07);
197 tm->tm_mday = bcd2bin(rs5c->regs[RS5C372_REG_DAY] & 0x3f);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800198
199 /* tm->tm_mon is zero-based */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700200 tm->tm_mon = bcd2bin(rs5c->regs[RS5C372_REG_MONTH] & 0x1f) - 1;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800201
202 /* year is 1900 + tm->tm_year */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700203 tm->tm_year = bcd2bin(rs5c->regs[RS5C372_REG_YEAR]) + 100;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800204
205 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
206 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700207 __func__,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800208 tm->tm_sec, tm->tm_min, tm->tm_hour,
209 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
210
David Brownellcb26b572007-01-05 16:36:37 -0800211 /* rtc might need initialization */
212 return rtc_valid_tm(tm);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800213}
214
215static int rs5c372_set_datetime(struct i2c_client *client, struct rtc_time *tm)
216{
David Brownellcb26b572007-01-05 16:36:37 -0800217 struct rs5c372 *rs5c = i2c_get_clientdata(client);
Wolfram Sang11836492010-12-21 17:24:24 -0800218 unsigned char buf[7];
Paul Mundt0053dc02008-10-15 22:03:01 -0700219 int addr;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800220
David Brownellcb26b572007-01-05 16:36:37 -0800221 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d "
Alessandro Zummo7520b942006-03-27 01:16:45 -0800222 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700223 __func__,
David Brownellcb26b572007-01-05 16:36:37 -0800224 tm->tm_sec, tm->tm_min, tm->tm_hour,
Alessandro Zummo7520b942006-03-27 01:16:45 -0800225 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
226
Paul Mundt0053dc02008-10-15 22:03:01 -0700227 addr = RS5C_ADDR(RS5C372_REG_SECS);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700228 buf[0] = bin2bcd(tm->tm_sec);
229 buf[1] = bin2bcd(tm->tm_min);
Paul Mundt0053dc02008-10-15 22:03:01 -0700230 buf[2] = rs5c_hr2reg(rs5c, tm->tm_hour);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700231 buf[3] = bin2bcd(tm->tm_wday);
232 buf[4] = bin2bcd(tm->tm_mday);
233 buf[5] = bin2bcd(tm->tm_mon + 1);
234 buf[6] = bin2bcd(tm->tm_year - 100);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800235
Paul Mundt0053dc02008-10-15 22:03:01 -0700236 if (i2c_smbus_write_i2c_block_data(client, addr, sizeof(buf), buf) < 0) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700237 dev_err(&client->dev, "%s: write error\n", __func__);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800238 return -EIO;
239 }
240
241 return 0;
242}
243
David Brownellcb26b572007-01-05 16:36:37 -0800244#if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
245#define NEED_TRIM
246#endif
247
248#if defined(CONFIG_RTC_INTF_SYSFS) || defined(CONFIG_RTC_INTF_SYSFS_MODULE)
249#define NEED_TRIM
250#endif
251
252#ifdef NEED_TRIM
Alessandro Zummo7520b942006-03-27 01:16:45 -0800253static int rs5c372_get_trim(struct i2c_client *client, int *osc, int *trim)
254{
Riku Voipioc6f24f92006-12-06 20:39:13 -0800255 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
David Brownellcb26b572007-01-05 16:36:37 -0800256 u8 tmp = rs5c372->regs[RS5C372_REG_TRIM];
Alessandro Zummo7520b942006-03-27 01:16:45 -0800257
Alessandro Zummo7520b942006-03-27 01:16:45 -0800258 if (osc)
Riku Voipioc6f24f92006-12-06 20:39:13 -0800259 *osc = (tmp & RS5C372_TRIM_XSL) ? 32000 : 32768;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800260
Adrian Bunk17ad78e2006-11-25 11:09:29 -0800261 if (trim) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700262 dev_dbg(&client->dev, "%s: raw trim=%x\n", __func__, tmp);
David Brownellcb26b572007-01-05 16:36:37 -0800263 tmp &= RS5C372_TRIM_MASK;
264 if (tmp & 0x3e) {
265 int t = tmp & 0x3f;
266
267 if (tmp & 0x40)
268 t = (~t | (s8)0xc0) + 1;
269 else
270 t = t - 1;
271
272 tmp = t * 2;
273 } else
274 tmp = 0;
275 *trim = tmp;
Adrian Bunk17ad78e2006-11-25 11:09:29 -0800276 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800277
278 return 0;
279}
David Brownellcb26b572007-01-05 16:36:37 -0800280#endif
Alessandro Zummo7520b942006-03-27 01:16:45 -0800281
282static int rs5c372_rtc_read_time(struct device *dev, struct rtc_time *tm)
283{
284 return rs5c372_get_datetime(to_i2c_client(dev), tm);
285}
286
287static int rs5c372_rtc_set_time(struct device *dev, struct rtc_time *tm)
288{
289 return rs5c372_set_datetime(to_i2c_client(dev), tm);
290}
291
David Brownellcb26b572007-01-05 16:36:37 -0800292
John Stultz16380c12011-02-02 17:02:41 -0800293static int rs5c_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
294{
295 struct i2c_client *client = to_i2c_client(dev);
296 struct rs5c372 *rs5c = i2c_get_clientdata(client);
297 unsigned char buf;
298 int status, addr;
299
300 buf = rs5c->regs[RS5C_REG_CTRL1];
301
302 if (!rs5c->has_irq)
303 return -EINVAL;
304
305 status = rs5c_get_regs(rs5c);
306 if (status < 0)
307 return status;
308
309 addr = RS5C_ADDR(RS5C_REG_CTRL1);
310 if (enabled)
311 buf |= RS5C_CTRL1_AALE;
312 else
313 buf &= ~RS5C_CTRL1_AALE;
314
315 if (i2c_smbus_write_byte_data(client, addr, buf) < 0) {
Jingoo Han0c6516e2013-02-21 16:45:27 -0800316 dev_warn(dev, "can't update alarm\n");
John Stultz16380c12011-02-02 17:02:41 -0800317 status = -EIO;
318 } else
319 rs5c->regs[RS5C_REG_CTRL1] = buf;
320
321 return status;
322}
323
324
David Brownellcb26b572007-01-05 16:36:37 -0800325/* NOTE: Since RTC_WKALM_{RD,SET} were originally defined for EFI,
326 * which only exposes a polled programming interface; and since
327 * these calls map directly to those EFI requests; we don't demand
328 * we have an IRQ for this chip when we go through this API.
329 *
330 * The older x86_pc derived RTC_ALM_{READ,SET} calls require irqs
331 * though, managed through RTC_AIE_{ON,OFF} requests.
332 */
333
334static int rs5c_read_alarm(struct device *dev, struct rtc_wkalrm *t)
335{
336 struct i2c_client *client = to_i2c_client(dev);
337 struct rs5c372 *rs5c = i2c_get_clientdata(client);
338 int status;
339
340 status = rs5c_get_regs(rs5c);
341 if (status < 0)
342 return status;
343
344 /* report alarm time */
345 t->time.tm_sec = 0;
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700346 t->time.tm_min = bcd2bin(rs5c->regs[RS5C_REG_ALARM_A_MIN] & 0x7f);
David Brownellcb26b572007-01-05 16:36:37 -0800347 t->time.tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C_REG_ALARM_A_HOURS]);
348 t->time.tm_mday = -1;
349 t->time.tm_mon = -1;
350 t->time.tm_year = -1;
351 t->time.tm_wday = -1;
352 t->time.tm_yday = -1;
353 t->time.tm_isdst = -1;
354
355 /* ... and status */
356 t->enabled = !!(rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE);
357 t->pending = !!(rs5c->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_AAFG);
358
359 return 0;
360}
361
362static int rs5c_set_alarm(struct device *dev, struct rtc_wkalrm *t)
363{
364 struct i2c_client *client = to_i2c_client(dev);
365 struct rs5c372 *rs5c = i2c_get_clientdata(client);
Paul Mundt0053dc02008-10-15 22:03:01 -0700366 int status, addr, i;
367 unsigned char buf[3];
David Brownellcb26b572007-01-05 16:36:37 -0800368
369 /* only handle up to 24 hours in the future, like RTC_ALM_SET */
370 if (t->time.tm_mday != -1
371 || t->time.tm_mon != -1
372 || t->time.tm_year != -1)
373 return -EINVAL;
374
375 /* REVISIT: round up tm_sec */
376
377 /* if needed, disable irq (clears pending status) */
378 status = rs5c_get_regs(rs5c);
379 if (status < 0)
380 return status;
381 if (rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE) {
Paul Mundt0053dc02008-10-15 22:03:01 -0700382 addr = RS5C_ADDR(RS5C_REG_CTRL1);
383 buf[0] = rs5c->regs[RS5C_REG_CTRL1] & ~RS5C_CTRL1_AALE;
384 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0) {
Jingoo Han0c6516e2013-02-21 16:45:27 -0800385 dev_dbg(dev, "can't disable alarm\n");
David Brownellcb26b572007-01-05 16:36:37 -0800386 return -EIO;
387 }
Paul Mundt0053dc02008-10-15 22:03:01 -0700388 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
David Brownellcb26b572007-01-05 16:36:37 -0800389 }
390
391 /* set alarm */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700392 buf[0] = bin2bcd(t->time.tm_min);
Paul Mundt0053dc02008-10-15 22:03:01 -0700393 buf[1] = rs5c_hr2reg(rs5c, t->time.tm_hour);
394 buf[2] = 0x7f; /* any/all days */
395
396 for (i = 0; i < sizeof(buf); i++) {
397 addr = RS5C_ADDR(RS5C_REG_ALARM_A_MIN + i);
398 if (i2c_smbus_write_byte_data(client, addr, buf[i]) < 0) {
Jingoo Han0c6516e2013-02-21 16:45:27 -0800399 dev_dbg(dev, "can't set alarm time\n");
Paul Mundt0053dc02008-10-15 22:03:01 -0700400 return -EIO;
401 }
David Brownellcb26b572007-01-05 16:36:37 -0800402 }
403
404 /* ... and maybe enable its irq */
405 if (t->enabled) {
Paul Mundt0053dc02008-10-15 22:03:01 -0700406 addr = RS5C_ADDR(RS5C_REG_CTRL1);
407 buf[0] = rs5c->regs[RS5C_REG_CTRL1] | RS5C_CTRL1_AALE;
408 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0)
Jingoo Han0c6516e2013-02-21 16:45:27 -0800409 dev_warn(dev, "can't enable alarm\n");
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:
Lucas Stach550fcb82013-05-07 16:18:11 -0700534 case rtc_r2221tl:
Paul Mundt0053dc02008-10-15 22:03:01 -0700535 case rtc_rv5c386:
536 case rtc_rv5c387a:
537 buf[0] |= RV5C387_CTRL1_24;
538 rs5c372->time24 = 1;
539 break;
540 default:
541 /* impossible */
542 break;
543 }
544
545 for (i = 0; i < sizeof(buf); i++) {
546 addr = RS5C_ADDR(RS5C_REG_CTRL1 + i);
547 ret = i2c_smbus_write_byte_data(rs5c372->client, addr, buf[i]);
548 if (unlikely(ret < 0))
549 return ret;
550 }
551
552 rs5c372->regs[RS5C_REG_CTRL1] = buf[0];
553 rs5c372->regs[RS5C_REG_CTRL2] = buf[1];
554
555 return 0;
556}
557
Jean Delvared2653e92008-04-29 23:11:39 +0200558static int rs5c372_probe(struct i2c_client *client,
559 const struct i2c_device_id *id)
Alessandro Zummo7520b942006-03-27 01:16:45 -0800560{
561 int err = 0;
Paul Mundt0053dc02008-10-15 22:03:01 -0700562 int smbus_mode = 0;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800563 struct rs5c372 *rs5c372;
David Brownellcb26b572007-01-05 16:36:37 -0800564 struct rtc_time tm;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800565
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700566 dev_dbg(&client->dev, "%s\n", __func__);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800567
Paul Mundt0053dc02008-10-15 22:03:01 -0700568 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C |
569 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK)) {
570 /*
571 * If we don't have any master mode adapter, try breaking
572 * it down in to the barest of capabilities.
573 */
574 if (i2c_check_functionality(client->adapter,
575 I2C_FUNC_SMBUS_BYTE_DATA |
576 I2C_FUNC_SMBUS_I2C_BLOCK))
577 smbus_mode = 1;
578 else {
579 /* Still no good, give up */
580 err = -ENODEV;
581 goto exit;
582 }
Alessandro Zummo7520b942006-03-27 01:16:45 -0800583 }
584
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700585 rs5c372 = devm_kzalloc(&client->dev, sizeof(struct rs5c372),
586 GFP_KERNEL);
587 if (!rs5c372) {
Alessandro Zummo7520b942006-03-27 01:16:45 -0800588 err = -ENOMEM;
589 goto exit;
590 }
David Brownellcb26b572007-01-05 16:36:37 -0800591
David Brownellcb26b572007-01-05 16:36:37 -0800592 rs5c372->client = client;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800593 i2c_set_clientdata(client, rs5c372);
Jean Delvare3760f732008-04-29 23:11:40 +0200594 rs5c372->type = id->driver_data;
Riku Voipioc6f24f92006-12-06 20:39:13 -0800595
Paul Mundte2bfe342008-04-28 02:11:57 -0700596 /* we read registers 0x0f then 0x00-0x0f; skip the first one */
597 rs5c372->regs = &rs5c372->buf[1];
Paul Mundt0053dc02008-10-15 22:03:01 -0700598 rs5c372->smbus = smbus_mode;
Paul Mundte2bfe342008-04-28 02:11:57 -0700599
David Brownellcb26b572007-01-05 16:36:37 -0800600 err = rs5c_get_regs(rs5c372);
601 if (err < 0)
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700602 goto exit;
David Brownellcb26b572007-01-05 16:36:37 -0800603
David Brownellcb26b572007-01-05 16:36:37 -0800604 /* clock may be set for am/pm or 24 hr time */
605 switch (rs5c372->type) {
606 case rtc_rs5c372a:
607 case rtc_rs5c372b:
608 /* alarm uses ALARM_A; and nINTRA on 372a, nINTR on 372b.
609 * so does periodic irq, except some 327a modes.
610 */
611 if (rs5c372->regs[RS5C_REG_CTRL2] & RS5C372_CTRL2_24)
612 rs5c372->time24 = 1;
613 break;
Paul Mundt37fc5e22008-10-15 22:03:03 -0700614 case rtc_r2025sd:
Lucas Stach550fcb82013-05-07 16:18:11 -0700615 case rtc_r2221tl:
David Brownellcb26b572007-01-05 16:36:37 -0800616 case rtc_rv5c386:
617 case rtc_rv5c387a:
618 if (rs5c372->regs[RS5C_REG_CTRL1] & RV5C387_CTRL1_24)
619 rs5c372->time24 = 1;
620 /* alarm uses ALARM_W; and nINTRB for alarm and periodic
621 * irq, on both 386 and 387
622 */
623 break;
624 default:
625 dev_err(&client->dev, "unknown RTC type\n");
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700626 goto exit;
David Brownellcb26b572007-01-05 16:36:37 -0800627 }
628
629 /* if the oscillator lost power and no other software (like
630 * the bootloader) set it up, do it here.
Paul Mundt37fc5e22008-10-15 22:03:03 -0700631 *
632 * The R2025S/D does this a little differently than the other
633 * parts, so we special case that..
David Brownellcb26b572007-01-05 16:36:37 -0800634 */
Paul Mundt0053dc02008-10-15 22:03:01 -0700635 err = rs5c_oscillator_setup(rs5c372);
636 if (unlikely(err < 0)) {
637 dev_err(&client->dev, "setup error\n");
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700638 goto exit;
David Brownellcb26b572007-01-05 16:36:37 -0800639 }
640
641 if (rs5c372_get_datetime(client, &tm) < 0)
642 dev_warn(&client->dev, "clock needs to be set\n");
643
644 dev_info(&client->dev, "%s found, %s, driver version " DRV_VERSION "\n",
645 ({ char *s; switch (rs5c372->type) {
Paul Mundt37fc5e22008-10-15 22:03:03 -0700646 case rtc_r2025sd: s = "r2025sd"; break;
Lucas Stach550fcb82013-05-07 16:18:11 -0700647 case rtc_r2221tl: s = "r2221tl"; break;
David Brownellcb26b572007-01-05 16:36:37 -0800648 case rtc_rs5c372a: s = "rs5c372a"; break;
649 case rtc_rs5c372b: s = "rs5c372b"; break;
650 case rtc_rv5c386: s = "rv5c386"; break;
651 case rtc_rv5c387a: s = "rv5c387a"; break;
652 default: s = "chip"; break;
653 }; s;}),
654 rs5c372->time24 ? "24hr" : "am/pm"
655 );
656
David Brownelld8154612007-07-17 04:04:55 -0700657 /* REVISIT use client->irq to register alarm irq ... */
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700658 rs5c372->rtc = devm_rtc_device_register(&client->dev,
659 rs5c372_driver.driver.name,
660 &rs5c372_rtc_ops, THIS_MODULE);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800661
Riku Voipioc6f24f92006-12-06 20:39:13 -0800662 if (IS_ERR(rs5c372->rtc)) {
663 err = PTR_ERR(rs5c372->rtc);
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700664 goto exit;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800665 }
666
David Brownellcb26b572007-01-05 16:36:37 -0800667 err = rs5c_sysfs_register(&client->dev);
Riku Voipioc6f24f92006-12-06 20:39:13 -0800668 if (err)
Jingoo Hanb8a4b4e2013-04-29 16:20:52 -0700669 goto exit;
Alessandro Zummo7520b942006-03-27 01:16:45 -0800670
671 return 0;
672
Alessandro Zummo7520b942006-03-27 01:16:45 -0800673exit:
674 return err;
675}
676
David Brownelld8154612007-07-17 04:04:55 -0700677static int rs5c372_remove(struct i2c_client *client)
David Brownellcb26b572007-01-05 16:36:37 -0800678{
David Brownelld8154612007-07-17 04:04:55 -0700679 rs5c_sysfs_unregister(&client->dev);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800680 return 0;
681}
682
David Brownellcb26b572007-01-05 16:36:37 -0800683static struct i2c_driver rs5c372_driver = {
684 .driver = {
685 .name = "rtc-rs5c372",
686 },
David Brownelld8154612007-07-17 04:04:55 -0700687 .probe = rs5c372_probe,
688 .remove = rs5c372_remove,
Jean Delvare3760f732008-04-29 23:11:40 +0200689 .id_table = rs5c372_id,
David Brownellcb26b572007-01-05 16:36:37 -0800690};
691
Axel Lin0abc9202012-03-23 15:02:31 -0700692module_i2c_driver(rs5c372_driver);
Alessandro Zummo7520b942006-03-27 01:16:45 -0800693
694MODULE_AUTHOR(
695 "Pavel Mironchik <pmironchik@optifacio.net>, "
Paul Mundt0053dc02008-10-15 22:03:01 -0700696 "Alessandro Zummo <a.zummo@towertech.it>, "
697 "Paul Mundt <lethal@linux-sh.org>");
Alessandro Zummo7520b942006-03-27 01:16:45 -0800698MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
699MODULE_LICENSE("GPL");
700MODULE_VERSION(DRV_VERSION);