Loading...
1/*
2 * An I2C driver for Ricoh RS5C372, R2025S/D and RV5C38[67] RTCs
3 *
4 * Copyright (C) 2005 Pavel Mironchik <pmironchik@optifacio.net>
5 * Copyright (C) 2006 Tower Technologies
6 * Copyright (C) 2008 Paul Mundt
7 *
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>
16#include <linux/slab.h>
17#include <linux/module.h>
18
19#define DRV_VERSION "0.6"
20
21
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 */
28#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
36# define RS5C372_TRIM_XSL 0x80
37# define RS5C372_TRIM_MASK 0x7F
38
39#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
42
43#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) */
46
47#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)
57# define R2025_CTRL2_XST (1 << 5)
58# define RS5C_CTRL2_XSTP (1 << 4) /* only if !R2025S/D */
59# define RS5C_CTRL2_CTFG (1 << 2)
60# define RS5C_CTRL2_AAFG (1 << 1) /* or WAFG */
61# define RS5C_CTRL2_BAFG (1 << 0) /* or DAFG */
62
63
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,
70 rtc_r2025sd,
71 rtc_rs5c372a,
72 rtc_rs5c372b,
73 rtc_rv5c386,
74 rtc_rv5c387a,
75};
76
77static const struct i2c_device_id rs5c372_id[] = {
78 { "r2025sd", rtc_r2025sd },
79 { "rs5c372a", rtc_rs5c372a },
80 { "rs5c372b", rtc_rs5c372b },
81 { "rv5c386", rtc_rv5c386 },
82 { "rv5c387a", rtc_rv5c387a },
83 { }
84};
85MODULE_DEVICE_TABLE(i2c, rs5c372_id);
86
87/* 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 */
92struct rs5c372 {
93 struct i2c_client *client;
94 struct rtc_device *rtc;
95 enum rtc_type type;
96 unsigned time24:1;
97 unsigned has_irq:1;
98 unsigned smbus:1;
99 char buf[17];
100 char *regs;
101};
102
103static int rs5c_get_regs(struct rs5c372 *rs5c)
104{
105 struct i2c_client *client = rs5c->client;
106 struct i2c_msg msgs[] = {
107 { client->addr, I2C_M_RD, sizeof rs5c->buf, rs5c->buf },
108 };
109
110 /* This implements the third reading method from the datasheet, using
111 * an internal address that's reset after each transaction (by STOP)
112 * to 0x0f ... so we read extra registers, and skip the first one.
113 *
114 * The first method doesn't work with the iop3xx adapter driver, on at
115 * least 80219 chips; this works around that bug.
116 *
117 * The third method on the other hand doesn't work for the SMBus-only
118 * configurations, so we use the the first method there, stripping off
119 * the extra register in the process.
120 */
121 if (rs5c->smbus) {
122 int addr = RS5C_ADDR(RS5C372_REG_SECS);
123 int size = sizeof(rs5c->buf) - 1;
124
125 if (i2c_smbus_read_i2c_block_data(client, addr, size,
126 rs5c->buf + 1) != size) {
127 dev_warn(&client->dev, "can't read registers\n");
128 return -EIO;
129 }
130 } else {
131 if ((i2c_transfer(client->adapter, msgs, 1)) != 1) {
132 dev_warn(&client->dev, "can't read registers\n");
133 return -EIO;
134 }
135 }
136
137 dev_dbg(&client->dev,
138 "%02x %02x %02x (%02x) %02x %02x %02x (%02x), "
139 "%02x %02x %02x, %02x %02x %02x; %02x %02x\n",
140 rs5c->regs[0], rs5c->regs[1], rs5c->regs[2], rs5c->regs[3],
141 rs5c->regs[4], rs5c->regs[5], rs5c->regs[6], rs5c->regs[7],
142 rs5c->regs[8], rs5c->regs[9], rs5c->regs[10], rs5c->regs[11],
143 rs5c->regs[12], rs5c->regs[13], rs5c->regs[14], rs5c->regs[15]);
144
145 return 0;
146}
147
148static unsigned rs5c_reg2hr(struct rs5c372 *rs5c, unsigned reg)
149{
150 unsigned hour;
151
152 if (rs5c->time24)
153 return bcd2bin(reg & 0x3f);
154
155 hour = bcd2bin(reg & 0x1f);
156 if (hour == 12)
157 hour = 0;
158 if (reg & 0x20)
159 hour += 12;
160 return hour;
161}
162
163static unsigned rs5c_hr2reg(struct rs5c372 *rs5c, unsigned hour)
164{
165 if (rs5c->time24)
166 return bin2bcd(hour);
167
168 if (hour > 12)
169 return 0x20 | bin2bcd(hour - 12);
170 if (hour == 12)
171 return 0x20 | bin2bcd(12);
172 if (hour == 0)
173 return bin2bcd(12);
174 return bin2bcd(hour);
175}
176
177static int rs5c372_get_datetime(struct i2c_client *client, struct rtc_time *tm)
178{
179 struct rs5c372 *rs5c = i2c_get_clientdata(client);
180 int status = rs5c_get_regs(rs5c);
181
182 if (status < 0)
183 return status;
184
185 tm->tm_sec = bcd2bin(rs5c->regs[RS5C372_REG_SECS] & 0x7f);
186 tm->tm_min = bcd2bin(rs5c->regs[RS5C372_REG_MINS] & 0x7f);
187 tm->tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C372_REG_HOURS]);
188
189 tm->tm_wday = bcd2bin(rs5c->regs[RS5C372_REG_WDAY] & 0x07);
190 tm->tm_mday = bcd2bin(rs5c->regs[RS5C372_REG_DAY] & 0x3f);
191
192 /* tm->tm_mon is zero-based */
193 tm->tm_mon = bcd2bin(rs5c->regs[RS5C372_REG_MONTH] & 0x1f) - 1;
194
195 /* year is 1900 + tm->tm_year */
196 tm->tm_year = bcd2bin(rs5c->regs[RS5C372_REG_YEAR]) + 100;
197
198 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
199 "mday=%d, mon=%d, year=%d, wday=%d\n",
200 __func__,
201 tm->tm_sec, tm->tm_min, tm->tm_hour,
202 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
203
204 /* rtc might need initialization */
205 return rtc_valid_tm(tm);
206}
207
208static int rs5c372_set_datetime(struct i2c_client *client, struct rtc_time *tm)
209{
210 struct rs5c372 *rs5c = i2c_get_clientdata(client);
211 unsigned char buf[7];
212 int addr;
213
214 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d "
215 "mday=%d, mon=%d, year=%d, wday=%d\n",
216 __func__,
217 tm->tm_sec, tm->tm_min, tm->tm_hour,
218 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
219
220 addr = RS5C_ADDR(RS5C372_REG_SECS);
221 buf[0] = bin2bcd(tm->tm_sec);
222 buf[1] = bin2bcd(tm->tm_min);
223 buf[2] = rs5c_hr2reg(rs5c, tm->tm_hour);
224 buf[3] = bin2bcd(tm->tm_wday);
225 buf[4] = bin2bcd(tm->tm_mday);
226 buf[5] = bin2bcd(tm->tm_mon + 1);
227 buf[6] = bin2bcd(tm->tm_year - 100);
228
229 if (i2c_smbus_write_i2c_block_data(client, addr, sizeof(buf), buf) < 0) {
230 dev_err(&client->dev, "%s: write error\n", __func__);
231 return -EIO;
232 }
233
234 return 0;
235}
236
237#if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
238#define NEED_TRIM
239#endif
240
241#if defined(CONFIG_RTC_INTF_SYSFS) || defined(CONFIG_RTC_INTF_SYSFS_MODULE)
242#define NEED_TRIM
243#endif
244
245#ifdef NEED_TRIM
246static int rs5c372_get_trim(struct i2c_client *client, int *osc, int *trim)
247{
248 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
249 u8 tmp = rs5c372->regs[RS5C372_REG_TRIM];
250
251 if (osc)
252 *osc = (tmp & RS5C372_TRIM_XSL) ? 32000 : 32768;
253
254 if (trim) {
255 dev_dbg(&client->dev, "%s: raw trim=%x\n", __func__, tmp);
256 tmp &= RS5C372_TRIM_MASK;
257 if (tmp & 0x3e) {
258 int t = tmp & 0x3f;
259
260 if (tmp & 0x40)
261 t = (~t | (s8)0xc0) + 1;
262 else
263 t = t - 1;
264
265 tmp = t * 2;
266 } else
267 tmp = 0;
268 *trim = tmp;
269 }
270
271 return 0;
272}
273#endif
274
275static int rs5c372_rtc_read_time(struct device *dev, struct rtc_time *tm)
276{
277 return rs5c372_get_datetime(to_i2c_client(dev), tm);
278}
279
280static int rs5c372_rtc_set_time(struct device *dev, struct rtc_time *tm)
281{
282 return rs5c372_set_datetime(to_i2c_client(dev), tm);
283}
284
285
286static int rs5c_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
287{
288 struct i2c_client *client = to_i2c_client(dev);
289 struct rs5c372 *rs5c = i2c_get_clientdata(client);
290 unsigned char buf;
291 int status, addr;
292
293 buf = rs5c->regs[RS5C_REG_CTRL1];
294
295 if (!rs5c->has_irq)
296 return -EINVAL;
297
298 status = rs5c_get_regs(rs5c);
299 if (status < 0)
300 return status;
301
302 addr = RS5C_ADDR(RS5C_REG_CTRL1);
303 if (enabled)
304 buf |= RS5C_CTRL1_AALE;
305 else
306 buf &= ~RS5C_CTRL1_AALE;
307
308 if (i2c_smbus_write_byte_data(client, addr, buf) < 0) {
309 printk(KERN_WARNING "%s: can't update alarm\n",
310 rs5c->rtc->name);
311 status = -EIO;
312 } else
313 rs5c->regs[RS5C_REG_CTRL1] = buf;
314
315 return status;
316}
317
318
319/* NOTE: Since RTC_WKALM_{RD,SET} were originally defined for EFI,
320 * which only exposes a polled programming interface; and since
321 * these calls map directly to those EFI requests; we don't demand
322 * we have an IRQ for this chip when we go through this API.
323 *
324 * The older x86_pc derived RTC_ALM_{READ,SET} calls require irqs
325 * though, managed through RTC_AIE_{ON,OFF} requests.
326 */
327
328static int rs5c_read_alarm(struct device *dev, struct rtc_wkalrm *t)
329{
330 struct i2c_client *client = to_i2c_client(dev);
331 struct rs5c372 *rs5c = i2c_get_clientdata(client);
332 int status;
333
334 status = rs5c_get_regs(rs5c);
335 if (status < 0)
336 return status;
337
338 /* report alarm time */
339 t->time.tm_sec = 0;
340 t->time.tm_min = bcd2bin(rs5c->regs[RS5C_REG_ALARM_A_MIN] & 0x7f);
341 t->time.tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C_REG_ALARM_A_HOURS]);
342 t->time.tm_mday = -1;
343 t->time.tm_mon = -1;
344 t->time.tm_year = -1;
345 t->time.tm_wday = -1;
346 t->time.tm_yday = -1;
347 t->time.tm_isdst = -1;
348
349 /* ... and status */
350 t->enabled = !!(rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE);
351 t->pending = !!(rs5c->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_AAFG);
352
353 return 0;
354}
355
356static int rs5c_set_alarm(struct device *dev, struct rtc_wkalrm *t)
357{
358 struct i2c_client *client = to_i2c_client(dev);
359 struct rs5c372 *rs5c = i2c_get_clientdata(client);
360 int status, addr, i;
361 unsigned char buf[3];
362
363 /* only handle up to 24 hours in the future, like RTC_ALM_SET */
364 if (t->time.tm_mday != -1
365 || t->time.tm_mon != -1
366 || t->time.tm_year != -1)
367 return -EINVAL;
368
369 /* REVISIT: round up tm_sec */
370
371 /* if needed, disable irq (clears pending status) */
372 status = rs5c_get_regs(rs5c);
373 if (status < 0)
374 return status;
375 if (rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE) {
376 addr = RS5C_ADDR(RS5C_REG_CTRL1);
377 buf[0] = rs5c->regs[RS5C_REG_CTRL1] & ~RS5C_CTRL1_AALE;
378 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0) {
379 pr_debug("%s: can't disable alarm\n", rs5c->rtc->name);
380 return -EIO;
381 }
382 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
383 }
384
385 /* set alarm */
386 buf[0] = bin2bcd(t->time.tm_min);
387 buf[1] = rs5c_hr2reg(rs5c, t->time.tm_hour);
388 buf[2] = 0x7f; /* any/all days */
389
390 for (i = 0; i < sizeof(buf); i++) {
391 addr = RS5C_ADDR(RS5C_REG_ALARM_A_MIN + i);
392 if (i2c_smbus_write_byte_data(client, addr, buf[i]) < 0) {
393 pr_debug("%s: can't set alarm time\n", rs5c->rtc->name);
394 return -EIO;
395 }
396 }
397
398 /* ... and maybe enable its irq */
399 if (t->enabled) {
400 addr = RS5C_ADDR(RS5C_REG_CTRL1);
401 buf[0] = rs5c->regs[RS5C_REG_CTRL1] | RS5C_CTRL1_AALE;
402 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0)
403 printk(KERN_WARNING "%s: can't enable alarm\n",
404 rs5c->rtc->name);
405 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
406 }
407
408 return 0;
409}
410
411#if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
412
413static int rs5c372_rtc_proc(struct device *dev, struct seq_file *seq)
414{
415 int err, osc, trim;
416
417 err = rs5c372_get_trim(to_i2c_client(dev), &osc, &trim);
418 if (err == 0) {
419 seq_printf(seq, "crystal\t\t: %d.%03d KHz\n",
420 osc / 1000, osc % 1000);
421 seq_printf(seq, "trim\t\t: %d\n", trim);
422 }
423
424 return 0;
425}
426
427#else
428#define rs5c372_rtc_proc NULL
429#endif
430
431static const struct rtc_class_ops rs5c372_rtc_ops = {
432 .proc = rs5c372_rtc_proc,
433 .read_time = rs5c372_rtc_read_time,
434 .set_time = rs5c372_rtc_set_time,
435 .read_alarm = rs5c_read_alarm,
436 .set_alarm = rs5c_set_alarm,
437 .alarm_irq_enable = rs5c_rtc_alarm_irq_enable,
438};
439
440#if defined(CONFIG_RTC_INTF_SYSFS) || defined(CONFIG_RTC_INTF_SYSFS_MODULE)
441
442static ssize_t rs5c372_sysfs_show_trim(struct device *dev,
443 struct device_attribute *attr, char *buf)
444{
445 int err, trim;
446
447 err = rs5c372_get_trim(to_i2c_client(dev), NULL, &trim);
448 if (err)
449 return err;
450
451 return sprintf(buf, "%d\n", trim);
452}
453static DEVICE_ATTR(trim, S_IRUGO, rs5c372_sysfs_show_trim, NULL);
454
455static ssize_t rs5c372_sysfs_show_osc(struct device *dev,
456 struct device_attribute *attr, char *buf)
457{
458 int err, osc;
459
460 err = rs5c372_get_trim(to_i2c_client(dev), &osc, NULL);
461 if (err)
462 return err;
463
464 return sprintf(buf, "%d.%03d KHz\n", osc / 1000, osc % 1000);
465}
466static DEVICE_ATTR(osc, S_IRUGO, rs5c372_sysfs_show_osc, NULL);
467
468static int rs5c_sysfs_register(struct device *dev)
469{
470 int err;
471
472 err = device_create_file(dev, &dev_attr_trim);
473 if (err)
474 return err;
475 err = device_create_file(dev, &dev_attr_osc);
476 if (err)
477 device_remove_file(dev, &dev_attr_trim);
478
479 return err;
480}
481
482static void rs5c_sysfs_unregister(struct device *dev)
483{
484 device_remove_file(dev, &dev_attr_trim);
485 device_remove_file(dev, &dev_attr_osc);
486}
487
488#else
489static int rs5c_sysfs_register(struct device *dev)
490{
491 return 0;
492}
493
494static void rs5c_sysfs_unregister(struct device *dev)
495{
496 /* nothing */
497}
498#endif /* SYSFS */
499
500static struct i2c_driver rs5c372_driver;
501
502static int rs5c_oscillator_setup(struct rs5c372 *rs5c372)
503{
504 unsigned char buf[2];
505 int addr, i, ret = 0;
506
507 if (rs5c372->type == rtc_r2025sd) {
508 if (!(rs5c372->regs[RS5C_REG_CTRL2] & R2025_CTRL2_XST))
509 return ret;
510 rs5c372->regs[RS5C_REG_CTRL2] &= ~R2025_CTRL2_XST;
511 } else {
512 if (!(rs5c372->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_XSTP))
513 return ret;
514 rs5c372->regs[RS5C_REG_CTRL2] &= ~RS5C_CTRL2_XSTP;
515 }
516
517 addr = RS5C_ADDR(RS5C_REG_CTRL1);
518 buf[0] = rs5c372->regs[RS5C_REG_CTRL1];
519 buf[1] = rs5c372->regs[RS5C_REG_CTRL2];
520
521 /* use 24hr mode */
522 switch (rs5c372->type) {
523 case rtc_rs5c372a:
524 case rtc_rs5c372b:
525 buf[1] |= RS5C372_CTRL2_24;
526 rs5c372->time24 = 1;
527 break;
528 case rtc_r2025sd:
529 case rtc_rv5c386:
530 case rtc_rv5c387a:
531 buf[0] |= RV5C387_CTRL1_24;
532 rs5c372->time24 = 1;
533 break;
534 default:
535 /* impossible */
536 break;
537 }
538
539 for (i = 0; i < sizeof(buf); i++) {
540 addr = RS5C_ADDR(RS5C_REG_CTRL1 + i);
541 ret = i2c_smbus_write_byte_data(rs5c372->client, addr, buf[i]);
542 if (unlikely(ret < 0))
543 return ret;
544 }
545
546 rs5c372->regs[RS5C_REG_CTRL1] = buf[0];
547 rs5c372->regs[RS5C_REG_CTRL2] = buf[1];
548
549 return 0;
550}
551
552static int rs5c372_probe(struct i2c_client *client,
553 const struct i2c_device_id *id)
554{
555 int err = 0;
556 int smbus_mode = 0;
557 struct rs5c372 *rs5c372;
558 struct rtc_time tm;
559
560 dev_dbg(&client->dev, "%s\n", __func__);
561
562 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C |
563 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK)) {
564 /*
565 * If we don't have any master mode adapter, try breaking
566 * it down in to the barest of capabilities.
567 */
568 if (i2c_check_functionality(client->adapter,
569 I2C_FUNC_SMBUS_BYTE_DATA |
570 I2C_FUNC_SMBUS_I2C_BLOCK))
571 smbus_mode = 1;
572 else {
573 /* Still no good, give up */
574 err = -ENODEV;
575 goto exit;
576 }
577 }
578
579 if (!(rs5c372 = kzalloc(sizeof(struct rs5c372), GFP_KERNEL))) {
580 err = -ENOMEM;
581 goto exit;
582 }
583
584 rs5c372->client = client;
585 i2c_set_clientdata(client, rs5c372);
586 rs5c372->type = id->driver_data;
587
588 /* we read registers 0x0f then 0x00-0x0f; skip the first one */
589 rs5c372->regs = &rs5c372->buf[1];
590 rs5c372->smbus = smbus_mode;
591
592 err = rs5c_get_regs(rs5c372);
593 if (err < 0)
594 goto exit_kfree;
595
596 /* clock may be set for am/pm or 24 hr time */
597 switch (rs5c372->type) {
598 case rtc_rs5c372a:
599 case rtc_rs5c372b:
600 /* alarm uses ALARM_A; and nINTRA on 372a, nINTR on 372b.
601 * so does periodic irq, except some 327a modes.
602 */
603 if (rs5c372->regs[RS5C_REG_CTRL2] & RS5C372_CTRL2_24)
604 rs5c372->time24 = 1;
605 break;
606 case rtc_r2025sd:
607 case rtc_rv5c386:
608 case rtc_rv5c387a:
609 if (rs5c372->regs[RS5C_REG_CTRL1] & RV5C387_CTRL1_24)
610 rs5c372->time24 = 1;
611 /* alarm uses ALARM_W; and nINTRB for alarm and periodic
612 * irq, on both 386 and 387
613 */
614 break;
615 default:
616 dev_err(&client->dev, "unknown RTC type\n");
617 goto exit_kfree;
618 }
619
620 /* if the oscillator lost power and no other software (like
621 * the bootloader) set it up, do it here.
622 *
623 * The R2025S/D does this a little differently than the other
624 * parts, so we special case that..
625 */
626 err = rs5c_oscillator_setup(rs5c372);
627 if (unlikely(err < 0)) {
628 dev_err(&client->dev, "setup error\n");
629 goto exit_kfree;
630 }
631
632 if (rs5c372_get_datetime(client, &tm) < 0)
633 dev_warn(&client->dev, "clock needs to be set\n");
634
635 dev_info(&client->dev, "%s found, %s, driver version " DRV_VERSION "\n",
636 ({ char *s; switch (rs5c372->type) {
637 case rtc_r2025sd: s = "r2025sd"; break;
638 case rtc_rs5c372a: s = "rs5c372a"; break;
639 case rtc_rs5c372b: s = "rs5c372b"; break;
640 case rtc_rv5c386: s = "rv5c386"; break;
641 case rtc_rv5c387a: s = "rv5c387a"; break;
642 default: s = "chip"; break;
643 }; s;}),
644 rs5c372->time24 ? "24hr" : "am/pm"
645 );
646
647 /* REVISIT use client->irq to register alarm irq ... */
648
649 rs5c372->rtc = rtc_device_register(rs5c372_driver.driver.name,
650 &client->dev, &rs5c372_rtc_ops, THIS_MODULE);
651
652 if (IS_ERR(rs5c372->rtc)) {
653 err = PTR_ERR(rs5c372->rtc);
654 goto exit_kfree;
655 }
656
657 err = rs5c_sysfs_register(&client->dev);
658 if (err)
659 goto exit_devreg;
660
661 return 0;
662
663exit_devreg:
664 rtc_device_unregister(rs5c372->rtc);
665
666exit_kfree:
667 kfree(rs5c372);
668
669exit:
670 return err;
671}
672
673static int rs5c372_remove(struct i2c_client *client)
674{
675 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
676
677 rtc_device_unregister(rs5c372->rtc);
678 rs5c_sysfs_unregister(&client->dev);
679 kfree(rs5c372);
680 return 0;
681}
682
683static struct i2c_driver rs5c372_driver = {
684 .driver = {
685 .name = "rtc-rs5c372",
686 },
687 .probe = rs5c372_probe,
688 .remove = rs5c372_remove,
689 .id_table = rs5c372_id,
690};
691
692module_i2c_driver(rs5c372_driver);
693
694MODULE_AUTHOR(
695 "Pavel Mironchik <pmironchik@optifacio.net>, "
696 "Alessandro Zummo <a.zummo@towertech.it>, "
697 "Paul Mundt <lethal@linux-sh.org>");
698MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
699MODULE_LICENSE("GPL");
700MODULE_VERSION(DRV_VERSION);
1/*
2 * An I2C driver for Ricoh RS5C372, R2025S/D and RV5C38[67] RTCs
3 *
4 * Copyright (C) 2005 Pavel Mironchik <pmironchik@optifacio.net>
5 * Copyright (C) 2006 Tower Technologies
6 * Copyright (C) 2008 Paul Mundt
7 *
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>
16#include <linux/slab.h>
17#include <linux/module.h>
18
19/*
20 * Ricoh has a family of I2C based RTCs, which differ only slightly from
21 * each other. Differences center on pinout (e.g. how many interrupts,
22 * output clock, etc) and how the control registers are used. The '372
23 * is significant only because that's the one this driver first supported.
24 */
25#define RS5C372_REG_SECS 0
26#define RS5C372_REG_MINS 1
27#define RS5C372_REG_HOURS 2
28#define RS5C372_REG_WDAY 3
29#define RS5C372_REG_DAY 4
30#define RS5C372_REG_MONTH 5
31#define RS5C372_REG_YEAR 6
32#define RS5C372_REG_TRIM 7
33# define RS5C372_TRIM_XSL 0x80
34# define RS5C372_TRIM_MASK 0x7F
35
36#define RS5C_REG_ALARM_A_MIN 8 /* or ALARM_W */
37#define RS5C_REG_ALARM_A_HOURS 9
38#define RS5C_REG_ALARM_A_WDAY 10
39
40#define RS5C_REG_ALARM_B_MIN 11 /* or ALARM_D */
41#define RS5C_REG_ALARM_B_HOURS 12
42#define RS5C_REG_ALARM_B_WDAY 13 /* (ALARM_B only) */
43
44#define RS5C_REG_CTRL1 14
45# define RS5C_CTRL1_AALE (1 << 7) /* or WALE */
46# define RS5C_CTRL1_BALE (1 << 6) /* or DALE */
47# define RV5C387_CTRL1_24 (1 << 5)
48# define RS5C372A_CTRL1_SL1 (1 << 5)
49# define RS5C_CTRL1_CT_MASK (7 << 0)
50# define RS5C_CTRL1_CT0 (0 << 0) /* no periodic irq */
51# define RS5C_CTRL1_CT4 (4 << 0) /* 1 Hz level irq */
52#define RS5C_REG_CTRL2 15
53# define RS5C372_CTRL2_24 (1 << 5)
54# define R2025_CTRL2_XST (1 << 5)
55# define RS5C_CTRL2_XSTP (1 << 4) /* only if !R2025S/D */
56# define RS5C_CTRL2_CTFG (1 << 2)
57# define RS5C_CTRL2_AAFG (1 << 1) /* or WAFG */
58# define RS5C_CTRL2_BAFG (1 << 0) /* or DAFG */
59
60
61/* to read (style 1) or write registers starting at R */
62#define RS5C_ADDR(R) (((R) << 4) | 0)
63
64
65enum rtc_type {
66 rtc_undef = 0,
67 rtc_r2025sd,
68 rtc_r2221tl,
69 rtc_rs5c372a,
70 rtc_rs5c372b,
71 rtc_rv5c386,
72 rtc_rv5c387a,
73};
74
75static const struct i2c_device_id rs5c372_id[] = {
76 { "r2025sd", rtc_r2025sd },
77 { "r2221tl", rtc_r2221tl },
78 { "rs5c372a", rtc_rs5c372a },
79 { "rs5c372b", rtc_rs5c372b },
80 { "rv5c386", rtc_rv5c386 },
81 { "rv5c387a", rtc_rv5c387a },
82 { }
83};
84MODULE_DEVICE_TABLE(i2c, rs5c372_id);
85
86/* REVISIT: this assumes that:
87 * - we're in the 21st century, so it's safe to ignore the century
88 * bit for rv5c38[67] (REG_MONTH bit 7);
89 * - we should use ALARM_A not ALARM_B (may be wrong on some boards)
90 */
91struct rs5c372 {
92 struct i2c_client *client;
93 struct rtc_device *rtc;
94 enum rtc_type type;
95 unsigned time24:1;
96 unsigned has_irq:1;
97 unsigned smbus:1;
98 char buf[17];
99 char *regs;
100};
101
102static int rs5c_get_regs(struct rs5c372 *rs5c)
103{
104 struct i2c_client *client = rs5c->client;
105 struct i2c_msg msgs[] = {
106 {
107 .addr = client->addr,
108 .flags = I2C_M_RD,
109 .len = sizeof(rs5c->buf),
110 .buf = rs5c->buf
111 },
112 };
113
114 /* This implements the third reading method from the datasheet, using
115 * an internal address that's reset after each transaction (by STOP)
116 * to 0x0f ... so we read extra registers, and skip the first one.
117 *
118 * The first method doesn't work with the iop3xx adapter driver, on at
119 * least 80219 chips; this works around that bug.
120 *
121 * The third method on the other hand doesn't work for the SMBus-only
122 * configurations, so we use the the first method there, stripping off
123 * the extra register in the process.
124 */
125 if (rs5c->smbus) {
126 int addr = RS5C_ADDR(RS5C372_REG_SECS);
127 int size = sizeof(rs5c->buf) - 1;
128
129 if (i2c_smbus_read_i2c_block_data(client, addr, size,
130 rs5c->buf + 1) != size) {
131 dev_warn(&client->dev, "can't read registers\n");
132 return -EIO;
133 }
134 } else {
135 if ((i2c_transfer(client->adapter, msgs, 1)) != 1) {
136 dev_warn(&client->dev, "can't read registers\n");
137 return -EIO;
138 }
139 }
140
141 dev_dbg(&client->dev,
142 "%3ph (%02x) %3ph (%02x), %3ph, %3ph; %02x %02x\n",
143 rs5c->regs + 0, rs5c->regs[3],
144 rs5c->regs + 4, rs5c->regs[7],
145 rs5c->regs + 8, rs5c->regs + 11,
146 rs5c->regs[14], rs5c->regs[15]);
147
148 return 0;
149}
150
151static unsigned rs5c_reg2hr(struct rs5c372 *rs5c, unsigned reg)
152{
153 unsigned hour;
154
155 if (rs5c->time24)
156 return bcd2bin(reg & 0x3f);
157
158 hour = bcd2bin(reg & 0x1f);
159 if (hour == 12)
160 hour = 0;
161 if (reg & 0x20)
162 hour += 12;
163 return hour;
164}
165
166static unsigned rs5c_hr2reg(struct rs5c372 *rs5c, unsigned hour)
167{
168 if (rs5c->time24)
169 return bin2bcd(hour);
170
171 if (hour > 12)
172 return 0x20 | bin2bcd(hour - 12);
173 if (hour == 12)
174 return 0x20 | bin2bcd(12);
175 if (hour == 0)
176 return bin2bcd(12);
177 return bin2bcd(hour);
178}
179
180static int rs5c372_get_datetime(struct i2c_client *client, struct rtc_time *tm)
181{
182 struct rs5c372 *rs5c = i2c_get_clientdata(client);
183 int status = rs5c_get_regs(rs5c);
184
185 if (status < 0)
186 return status;
187
188 tm->tm_sec = bcd2bin(rs5c->regs[RS5C372_REG_SECS] & 0x7f);
189 tm->tm_min = bcd2bin(rs5c->regs[RS5C372_REG_MINS] & 0x7f);
190 tm->tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C372_REG_HOURS]);
191
192 tm->tm_wday = bcd2bin(rs5c->regs[RS5C372_REG_WDAY] & 0x07);
193 tm->tm_mday = bcd2bin(rs5c->regs[RS5C372_REG_DAY] & 0x3f);
194
195 /* tm->tm_mon is zero-based */
196 tm->tm_mon = bcd2bin(rs5c->regs[RS5C372_REG_MONTH] & 0x1f) - 1;
197
198 /* year is 1900 + tm->tm_year */
199 tm->tm_year = bcd2bin(rs5c->regs[RS5C372_REG_YEAR]) + 100;
200
201 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
202 "mday=%d, mon=%d, year=%d, wday=%d\n",
203 __func__,
204 tm->tm_sec, tm->tm_min, tm->tm_hour,
205 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
206
207 /* rtc might need initialization */
208 return rtc_valid_tm(tm);
209}
210
211static int rs5c372_set_datetime(struct i2c_client *client, struct rtc_time *tm)
212{
213 struct rs5c372 *rs5c = i2c_get_clientdata(client);
214 unsigned char buf[7];
215 int addr;
216
217 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d "
218 "mday=%d, mon=%d, year=%d, wday=%d\n",
219 __func__,
220 tm->tm_sec, tm->tm_min, tm->tm_hour,
221 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
222
223 addr = RS5C_ADDR(RS5C372_REG_SECS);
224 buf[0] = bin2bcd(tm->tm_sec);
225 buf[1] = bin2bcd(tm->tm_min);
226 buf[2] = rs5c_hr2reg(rs5c, tm->tm_hour);
227 buf[3] = bin2bcd(tm->tm_wday);
228 buf[4] = bin2bcd(tm->tm_mday);
229 buf[5] = bin2bcd(tm->tm_mon + 1);
230 buf[6] = bin2bcd(tm->tm_year - 100);
231
232 if (i2c_smbus_write_i2c_block_data(client, addr, sizeof(buf), buf) < 0) {
233 dev_err(&client->dev, "%s: write error\n", __func__);
234 return -EIO;
235 }
236
237 return 0;
238}
239
240#if IS_ENABLED(CONFIG_RTC_INTF_PROC)
241#define NEED_TRIM
242#endif
243
244#if IS_ENABLED(CONFIG_RTC_INTF_SYSFS)
245#define NEED_TRIM
246#endif
247
248#ifdef NEED_TRIM
249static int rs5c372_get_trim(struct i2c_client *client, int *osc, int *trim)
250{
251 struct rs5c372 *rs5c372 = i2c_get_clientdata(client);
252 u8 tmp = rs5c372->regs[RS5C372_REG_TRIM];
253
254 if (osc)
255 *osc = (tmp & RS5C372_TRIM_XSL) ? 32000 : 32768;
256
257 if (trim) {
258 dev_dbg(&client->dev, "%s: raw trim=%x\n", __func__, tmp);
259 tmp &= RS5C372_TRIM_MASK;
260 if (tmp & 0x3e) {
261 int t = tmp & 0x3f;
262
263 if (tmp & 0x40)
264 t = (~t | (s8)0xc0) + 1;
265 else
266 t = t - 1;
267
268 tmp = t * 2;
269 } else
270 tmp = 0;
271 *trim = tmp;
272 }
273
274 return 0;
275}
276#endif
277
278static int rs5c372_rtc_read_time(struct device *dev, struct rtc_time *tm)
279{
280 return rs5c372_get_datetime(to_i2c_client(dev), tm);
281}
282
283static int rs5c372_rtc_set_time(struct device *dev, struct rtc_time *tm)
284{
285 return rs5c372_set_datetime(to_i2c_client(dev), tm);
286}
287
288
289static int rs5c_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
290{
291 struct i2c_client *client = to_i2c_client(dev);
292 struct rs5c372 *rs5c = i2c_get_clientdata(client);
293 unsigned char buf;
294 int status, addr;
295
296 buf = rs5c->regs[RS5C_REG_CTRL1];
297
298 if (!rs5c->has_irq)
299 return -EINVAL;
300
301 status = rs5c_get_regs(rs5c);
302 if (status < 0)
303 return status;
304
305 addr = RS5C_ADDR(RS5C_REG_CTRL1);
306 if (enabled)
307 buf |= RS5C_CTRL1_AALE;
308 else
309 buf &= ~RS5C_CTRL1_AALE;
310
311 if (i2c_smbus_write_byte_data(client, addr, buf) < 0) {
312 dev_warn(dev, "can't update alarm\n");
313 status = -EIO;
314 } else
315 rs5c->regs[RS5C_REG_CTRL1] = buf;
316
317 return status;
318}
319
320
321/* NOTE: Since RTC_WKALM_{RD,SET} were originally defined for EFI,
322 * which only exposes a polled programming interface; and since
323 * these calls map directly to those EFI requests; we don't demand
324 * we have an IRQ for this chip when we go through this API.
325 *
326 * The older x86_pc derived RTC_ALM_{READ,SET} calls require irqs
327 * though, managed through RTC_AIE_{ON,OFF} requests.
328 */
329
330static int rs5c_read_alarm(struct device *dev, struct rtc_wkalrm *t)
331{
332 struct i2c_client *client = to_i2c_client(dev);
333 struct rs5c372 *rs5c = i2c_get_clientdata(client);
334 int status;
335
336 status = rs5c_get_regs(rs5c);
337 if (status < 0)
338 return status;
339
340 /* report alarm time */
341 t->time.tm_sec = 0;
342 t->time.tm_min = bcd2bin(rs5c->regs[RS5C_REG_ALARM_A_MIN] & 0x7f);
343 t->time.tm_hour = rs5c_reg2hr(rs5c, rs5c->regs[RS5C_REG_ALARM_A_HOURS]);
344
345 /* ... and status */
346 t->enabled = !!(rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE);
347 t->pending = !!(rs5c->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_AAFG);
348
349 return 0;
350}
351
352static int rs5c_set_alarm(struct device *dev, struct rtc_wkalrm *t)
353{
354 struct i2c_client *client = to_i2c_client(dev);
355 struct rs5c372 *rs5c = i2c_get_clientdata(client);
356 int status, addr, i;
357 unsigned char buf[3];
358
359 /* only handle up to 24 hours in the future, like RTC_ALM_SET */
360 if (t->time.tm_mday != -1
361 || t->time.tm_mon != -1
362 || t->time.tm_year != -1)
363 return -EINVAL;
364
365 /* REVISIT: round up tm_sec */
366
367 /* if needed, disable irq (clears pending status) */
368 status = rs5c_get_regs(rs5c);
369 if (status < 0)
370 return status;
371 if (rs5c->regs[RS5C_REG_CTRL1] & RS5C_CTRL1_AALE) {
372 addr = RS5C_ADDR(RS5C_REG_CTRL1);
373 buf[0] = rs5c->regs[RS5C_REG_CTRL1] & ~RS5C_CTRL1_AALE;
374 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0) {
375 dev_dbg(dev, "can't disable alarm\n");
376 return -EIO;
377 }
378 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
379 }
380
381 /* set alarm */
382 buf[0] = bin2bcd(t->time.tm_min);
383 buf[1] = rs5c_hr2reg(rs5c, t->time.tm_hour);
384 buf[2] = 0x7f; /* any/all days */
385
386 for (i = 0; i < sizeof(buf); i++) {
387 addr = RS5C_ADDR(RS5C_REG_ALARM_A_MIN + i);
388 if (i2c_smbus_write_byte_data(client, addr, buf[i]) < 0) {
389 dev_dbg(dev, "can't set alarm time\n");
390 return -EIO;
391 }
392 }
393
394 /* ... and maybe enable its irq */
395 if (t->enabled) {
396 addr = RS5C_ADDR(RS5C_REG_CTRL1);
397 buf[0] = rs5c->regs[RS5C_REG_CTRL1] | RS5C_CTRL1_AALE;
398 if (i2c_smbus_write_byte_data(client, addr, buf[0]) < 0)
399 dev_warn(dev, "can't enable alarm\n");
400 rs5c->regs[RS5C_REG_CTRL1] = buf[0];
401 }
402
403 return 0;
404}
405
406#if IS_ENABLED(CONFIG_RTC_INTF_PROC)
407
408static int rs5c372_rtc_proc(struct device *dev, struct seq_file *seq)
409{
410 int err, osc, trim;
411
412 err = rs5c372_get_trim(to_i2c_client(dev), &osc, &trim);
413 if (err == 0) {
414 seq_printf(seq, "crystal\t\t: %d.%03d KHz\n",
415 osc / 1000, osc % 1000);
416 seq_printf(seq, "trim\t\t: %d\n", trim);
417 }
418
419 return 0;
420}
421
422#else
423#define rs5c372_rtc_proc NULL
424#endif
425
426static const struct rtc_class_ops rs5c372_rtc_ops = {
427 .proc = rs5c372_rtc_proc,
428 .read_time = rs5c372_rtc_read_time,
429 .set_time = rs5c372_rtc_set_time,
430 .read_alarm = rs5c_read_alarm,
431 .set_alarm = rs5c_set_alarm,
432 .alarm_irq_enable = rs5c_rtc_alarm_irq_enable,
433};
434
435#if IS_ENABLED(CONFIG_RTC_INTF_SYSFS)
436
437static ssize_t rs5c372_sysfs_show_trim(struct device *dev,
438 struct device_attribute *attr, char *buf)
439{
440 int err, trim;
441
442 err = rs5c372_get_trim(to_i2c_client(dev), NULL, &trim);
443 if (err)
444 return err;
445
446 return sprintf(buf, "%d\n", trim);
447}
448static DEVICE_ATTR(trim, S_IRUGO, rs5c372_sysfs_show_trim, NULL);
449
450static ssize_t rs5c372_sysfs_show_osc(struct device *dev,
451 struct device_attribute *attr, char *buf)
452{
453 int err, osc;
454
455 err = rs5c372_get_trim(to_i2c_client(dev), &osc, NULL);
456 if (err)
457 return err;
458
459 return sprintf(buf, "%d.%03d KHz\n", osc / 1000, osc % 1000);
460}
461static DEVICE_ATTR(osc, S_IRUGO, rs5c372_sysfs_show_osc, NULL);
462
463static int rs5c_sysfs_register(struct device *dev)
464{
465 int err;
466
467 err = device_create_file(dev, &dev_attr_trim);
468 if (err)
469 return err;
470 err = device_create_file(dev, &dev_attr_osc);
471 if (err)
472 device_remove_file(dev, &dev_attr_trim);
473
474 return err;
475}
476
477static void rs5c_sysfs_unregister(struct device *dev)
478{
479 device_remove_file(dev, &dev_attr_trim);
480 device_remove_file(dev, &dev_attr_osc);
481}
482
483#else
484static int rs5c_sysfs_register(struct device *dev)
485{
486 return 0;
487}
488
489static void rs5c_sysfs_unregister(struct device *dev)
490{
491 /* nothing */
492}
493#endif /* SYSFS */
494
495static struct i2c_driver rs5c372_driver;
496
497static int rs5c_oscillator_setup(struct rs5c372 *rs5c372)
498{
499 unsigned char buf[2];
500 int addr, i, ret = 0;
501
502 if (rs5c372->type == rtc_r2025sd) {
503 if (rs5c372->regs[RS5C_REG_CTRL2] & R2025_CTRL2_XST)
504 return ret;
505 rs5c372->regs[RS5C_REG_CTRL2] |= R2025_CTRL2_XST;
506 } else {
507 if (!(rs5c372->regs[RS5C_REG_CTRL2] & RS5C_CTRL2_XSTP))
508 return ret;
509 rs5c372->regs[RS5C_REG_CTRL2] &= ~RS5C_CTRL2_XSTP;
510 }
511
512 addr = RS5C_ADDR(RS5C_REG_CTRL1);
513 buf[0] = rs5c372->regs[RS5C_REG_CTRL1];
514 buf[1] = rs5c372->regs[RS5C_REG_CTRL2];
515
516 /* use 24hr mode */
517 switch (rs5c372->type) {
518 case rtc_rs5c372a:
519 case rtc_rs5c372b:
520 buf[1] |= RS5C372_CTRL2_24;
521 rs5c372->time24 = 1;
522 break;
523 case rtc_r2025sd:
524 case rtc_r2221tl:
525 case rtc_rv5c386:
526 case rtc_rv5c387a:
527 buf[0] |= RV5C387_CTRL1_24;
528 rs5c372->time24 = 1;
529 break;
530 default:
531 /* impossible */
532 break;
533 }
534
535 for (i = 0; i < sizeof(buf); i++) {
536 addr = RS5C_ADDR(RS5C_REG_CTRL1 + i);
537 ret = i2c_smbus_write_byte_data(rs5c372->client, addr, buf[i]);
538 if (unlikely(ret < 0))
539 return ret;
540 }
541
542 rs5c372->regs[RS5C_REG_CTRL1] = buf[0];
543 rs5c372->regs[RS5C_REG_CTRL2] = buf[1];
544
545 return 0;
546}
547
548static int rs5c372_probe(struct i2c_client *client,
549 const struct i2c_device_id *id)
550{
551 int err = 0;
552 int smbus_mode = 0;
553 struct rs5c372 *rs5c372;
554 struct rtc_time tm;
555
556 dev_dbg(&client->dev, "%s\n", __func__);
557
558 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C |
559 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK)) {
560 /*
561 * If we don't have any master mode adapter, try breaking
562 * it down in to the barest of capabilities.
563 */
564 if (i2c_check_functionality(client->adapter,
565 I2C_FUNC_SMBUS_BYTE_DATA |
566 I2C_FUNC_SMBUS_I2C_BLOCK))
567 smbus_mode = 1;
568 else {
569 /* Still no good, give up */
570 err = -ENODEV;
571 goto exit;
572 }
573 }
574
575 rs5c372 = devm_kzalloc(&client->dev, sizeof(struct rs5c372),
576 GFP_KERNEL);
577 if (!rs5c372) {
578 err = -ENOMEM;
579 goto exit;
580 }
581
582 rs5c372->client = client;
583 i2c_set_clientdata(client, rs5c372);
584 rs5c372->type = id->driver_data;
585
586 /* we read registers 0x0f then 0x00-0x0f; skip the first one */
587 rs5c372->regs = &rs5c372->buf[1];
588 rs5c372->smbus = smbus_mode;
589
590 err = rs5c_get_regs(rs5c372);
591 if (err < 0)
592 goto exit;
593
594 /* clock may be set for am/pm or 24 hr time */
595 switch (rs5c372->type) {
596 case rtc_rs5c372a:
597 case rtc_rs5c372b:
598 /* alarm uses ALARM_A; and nINTRA on 372a, nINTR on 372b.
599 * so does periodic irq, except some 327a modes.
600 */
601 if (rs5c372->regs[RS5C_REG_CTRL2] & RS5C372_CTRL2_24)
602 rs5c372->time24 = 1;
603 break;
604 case rtc_r2025sd:
605 case rtc_r2221tl:
606 case rtc_rv5c386:
607 case rtc_rv5c387a:
608 if (rs5c372->regs[RS5C_REG_CTRL1] & RV5C387_CTRL1_24)
609 rs5c372->time24 = 1;
610 /* alarm uses ALARM_W; and nINTRB for alarm and periodic
611 * irq, on both 386 and 387
612 */
613 break;
614 default:
615 dev_err(&client->dev, "unknown RTC type\n");
616 goto exit;
617 }
618
619 /* if the oscillator lost power and no other software (like
620 * the bootloader) set it up, do it here.
621 *
622 * The R2025S/D does this a little differently than the other
623 * parts, so we special case that..
624 */
625 err = rs5c_oscillator_setup(rs5c372);
626 if (unlikely(err < 0)) {
627 dev_err(&client->dev, "setup error\n");
628 goto exit;
629 }
630
631 if (rs5c372_get_datetime(client, &tm) < 0)
632 dev_warn(&client->dev, "clock needs to be set\n");
633
634 dev_info(&client->dev, "%s found, %s\n",
635 ({ char *s; switch (rs5c372->type) {
636 case rtc_r2025sd: s = "r2025sd"; break;
637 case rtc_r2221tl: s = "r2221tl"; break;
638 case rtc_rs5c372a: s = "rs5c372a"; break;
639 case rtc_rs5c372b: s = "rs5c372b"; break;
640 case rtc_rv5c386: s = "rv5c386"; break;
641 case rtc_rv5c387a: s = "rv5c387a"; break;
642 default: s = "chip"; break;
643 }; s;}),
644 rs5c372->time24 ? "24hr" : "am/pm"
645 );
646
647 /* REVISIT use client->irq to register alarm irq ... */
648 rs5c372->rtc = devm_rtc_device_register(&client->dev,
649 rs5c372_driver.driver.name,
650 &rs5c372_rtc_ops, THIS_MODULE);
651
652 if (IS_ERR(rs5c372->rtc)) {
653 err = PTR_ERR(rs5c372->rtc);
654 goto exit;
655 }
656
657 err = rs5c_sysfs_register(&client->dev);
658 if (err)
659 goto exit;
660
661 return 0;
662
663exit:
664 return err;
665}
666
667static int rs5c372_remove(struct i2c_client *client)
668{
669 rs5c_sysfs_unregister(&client->dev);
670 return 0;
671}
672
673static struct i2c_driver rs5c372_driver = {
674 .driver = {
675 .name = "rtc-rs5c372",
676 },
677 .probe = rs5c372_probe,
678 .remove = rs5c372_remove,
679 .id_table = rs5c372_id,
680};
681
682module_i2c_driver(rs5c372_driver);
683
684MODULE_AUTHOR(
685 "Pavel Mironchik <pmironchik@optifacio.net>, "
686 "Alessandro Zummo <a.zummo@towertech.it>, "
687 "Paul Mundt <lethal@linux-sh.org>");
688MODULE_DESCRIPTION("Ricoh RS5C372 RTC driver");
689MODULE_LICENSE("GPL");