rtc: rv8803: let the core handle range
[linux-2.6-microblaze.git] / drivers / rtc / rtc-rv8803.c
1 /*
2  * RTC driver for the Micro Crystal RV8803
3  *
4  * Copyright (C) 2015 Micro Crystal SA
5  *
6  * Alexandre Belloni <alexandre.belloni@free-electrons.com>
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
14 #include <linux/bcd.h>
15 #include <linux/bitops.h>
16 #include <linux/log2.h>
17 #include <linux/i2c.h>
18 #include <linux/interrupt.h>
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/of_device.h>
22 #include <linux/rtc.h>
23
24 #define RV8803_I2C_TRY_COUNT            4
25
26 #define RV8803_SEC                      0x00
27 #define RV8803_MIN                      0x01
28 #define RV8803_HOUR                     0x02
29 #define RV8803_WEEK                     0x03
30 #define RV8803_DAY                      0x04
31 #define RV8803_MONTH                    0x05
32 #define RV8803_YEAR                     0x06
33 #define RV8803_RAM                      0x07
34 #define RV8803_ALARM_MIN                0x08
35 #define RV8803_ALARM_HOUR               0x09
36 #define RV8803_ALARM_WEEK_OR_DAY        0x0A
37 #define RV8803_EXT                      0x0D
38 #define RV8803_FLAG                     0x0E
39 #define RV8803_CTRL                     0x0F
40
41 #define RV8803_EXT_WADA                 BIT(6)
42
43 #define RV8803_FLAG_V1F                 BIT(0)
44 #define RV8803_FLAG_V2F                 BIT(1)
45 #define RV8803_FLAG_AF                  BIT(3)
46 #define RV8803_FLAG_TF                  BIT(4)
47 #define RV8803_FLAG_UF                  BIT(5)
48
49 #define RV8803_CTRL_RESET               BIT(0)
50
51 #define RV8803_CTRL_EIE                 BIT(2)
52 #define RV8803_CTRL_AIE                 BIT(3)
53 #define RV8803_CTRL_TIE                 BIT(4)
54 #define RV8803_CTRL_UIE                 BIT(5)
55
56 #define RX8900_BACKUP_CTRL              0x18
57 #define RX8900_FLAG_SWOFF               BIT(2)
58 #define RX8900_FLAG_VDETOFF             BIT(3)
59
60 enum rv8803_type {
61         rv_8803,
62         rx_8900
63 };
64
65 struct rv8803_data {
66         struct i2c_client *client;
67         struct rtc_device *rtc;
68         struct mutex flags_lock;
69         u8 ctrl;
70         enum rv8803_type type;
71 };
72
73 static int rv8803_read_reg(const struct i2c_client *client, u8 reg)
74 {
75         int try = RV8803_I2C_TRY_COUNT;
76         s32 ret;
77
78         /*
79          * There is a 61µs window during which the RTC does not acknowledge I2C
80          * transfers. In that case, ensure that there are multiple attempts.
81          */
82         do
83                 ret = i2c_smbus_read_byte_data(client, reg);
84         while ((ret == -ENXIO || ret == -EIO) && --try);
85         if (ret < 0)
86                 dev_err(&client->dev, "Unable to read register 0x%02x\n", reg);
87
88         return ret;
89 }
90
91 static int rv8803_read_regs(const struct i2c_client *client,
92                             u8 reg, u8 count, u8 *values)
93 {
94         int try = RV8803_I2C_TRY_COUNT;
95         s32 ret;
96
97         do
98                 ret = i2c_smbus_read_i2c_block_data(client, reg, count, values);
99         while ((ret == -ENXIO || ret == -EIO) && --try);
100         if (ret != count) {
101                 dev_err(&client->dev,
102                         "Unable to read registers 0x%02x..0x%02x\n",
103                         reg, reg + count - 1);
104                 return ret < 0 ? ret : -EIO;
105         }
106
107         return 0;
108 }
109
110 static int rv8803_write_reg(const struct i2c_client *client, u8 reg, u8 value)
111 {
112         int try = RV8803_I2C_TRY_COUNT;
113         s32 ret;
114
115         do
116                 ret = i2c_smbus_write_byte_data(client, reg, value);
117         while ((ret == -ENXIO || ret == -EIO) && --try);
118         if (ret)
119                 dev_err(&client->dev, "Unable to write register 0x%02x\n", reg);
120
121         return ret;
122 }
123
124 static int rv8803_write_regs(const struct i2c_client *client,
125                              u8 reg, u8 count, const u8 *values)
126 {
127         int try = RV8803_I2C_TRY_COUNT;
128         s32 ret;
129
130         do
131                 ret = i2c_smbus_write_i2c_block_data(client, reg, count,
132                                                      values);
133         while ((ret == -ENXIO || ret == -EIO) && --try);
134         if (ret)
135                 dev_err(&client->dev,
136                         "Unable to write registers 0x%02x..0x%02x\n",
137                         reg, reg + count - 1);
138
139         return ret;
140 }
141
142 static irqreturn_t rv8803_handle_irq(int irq, void *dev_id)
143 {
144         struct i2c_client *client = dev_id;
145         struct rv8803_data *rv8803 = i2c_get_clientdata(client);
146         unsigned long events = 0;
147         int flags;
148
149         mutex_lock(&rv8803->flags_lock);
150
151         flags = rv8803_read_reg(client, RV8803_FLAG);
152         if (flags <= 0) {
153                 mutex_unlock(&rv8803->flags_lock);
154                 return IRQ_NONE;
155         }
156
157         if (flags & RV8803_FLAG_V1F)
158                 dev_warn(&client->dev, "Voltage low, temperature compensation stopped.\n");
159
160         if (flags & RV8803_FLAG_V2F)
161                 dev_warn(&client->dev, "Voltage low, data loss detected.\n");
162
163         if (flags & RV8803_FLAG_TF) {
164                 flags &= ~RV8803_FLAG_TF;
165                 rv8803->ctrl &= ~RV8803_CTRL_TIE;
166                 events |= RTC_PF;
167         }
168
169         if (flags & RV8803_FLAG_AF) {
170                 flags &= ~RV8803_FLAG_AF;
171                 rv8803->ctrl &= ~RV8803_CTRL_AIE;
172                 events |= RTC_AF;
173         }
174
175         if (flags & RV8803_FLAG_UF) {
176                 flags &= ~RV8803_FLAG_UF;
177                 rv8803->ctrl &= ~RV8803_CTRL_UIE;
178                 events |= RTC_UF;
179         }
180
181         if (events) {
182                 rtc_update_irq(rv8803->rtc, 1, events);
183                 rv8803_write_reg(client, RV8803_FLAG, flags);
184                 rv8803_write_reg(rv8803->client, RV8803_CTRL, rv8803->ctrl);
185         }
186
187         mutex_unlock(&rv8803->flags_lock);
188
189         return IRQ_HANDLED;
190 }
191
192 static int rv8803_get_time(struct device *dev, struct rtc_time *tm)
193 {
194         struct rv8803_data *rv8803 = dev_get_drvdata(dev);
195         u8 date1[7];
196         u8 date2[7];
197         u8 *date = date1;
198         int ret, flags;
199
200         flags = rv8803_read_reg(rv8803->client, RV8803_FLAG);
201         if (flags < 0)
202                 return flags;
203
204         if (flags & RV8803_FLAG_V2F) {
205                 dev_warn(dev, "Voltage low, data is invalid.\n");
206                 return -EINVAL;
207         }
208
209         ret = rv8803_read_regs(rv8803->client, RV8803_SEC, 7, date);
210         if (ret)
211                 return ret;
212
213         if ((date1[RV8803_SEC] & 0x7f) == bin2bcd(59)) {
214                 ret = rv8803_read_regs(rv8803->client, RV8803_SEC, 7, date2);
215                 if (ret)
216                         return ret;
217
218                 if ((date2[RV8803_SEC] & 0x7f) != bin2bcd(59))
219                         date = date2;
220         }
221
222         tm->tm_sec  = bcd2bin(date[RV8803_SEC] & 0x7f);
223         tm->tm_min  = bcd2bin(date[RV8803_MIN] & 0x7f);
224         tm->tm_hour = bcd2bin(date[RV8803_HOUR] & 0x3f);
225         tm->tm_wday = ilog2(date[RV8803_WEEK] & 0x7f);
226         tm->tm_mday = bcd2bin(date[RV8803_DAY] & 0x3f);
227         tm->tm_mon  = bcd2bin(date[RV8803_MONTH] & 0x1f) - 1;
228         tm->tm_year = bcd2bin(date[RV8803_YEAR]) + 100;
229
230         return 0;
231 }
232
233 static int rv8803_set_time(struct device *dev, struct rtc_time *tm)
234 {
235         struct rv8803_data *rv8803 = dev_get_drvdata(dev);
236         u8 date[7];
237         int ctrl, flags, ret;
238
239         ctrl = rv8803_read_reg(rv8803->client, RV8803_CTRL);
240         if (ctrl < 0)
241                 return ctrl;
242
243         /* Stop the clock */
244         ret = rv8803_write_reg(rv8803->client, RV8803_CTRL,
245                                ctrl | RV8803_CTRL_RESET);
246         if (ret)
247                 return ret;
248
249         date[RV8803_SEC]   = bin2bcd(tm->tm_sec);
250         date[RV8803_MIN]   = bin2bcd(tm->tm_min);
251         date[RV8803_HOUR]  = bin2bcd(tm->tm_hour);
252         date[RV8803_WEEK]  = 1 << (tm->tm_wday);
253         date[RV8803_DAY]   = bin2bcd(tm->tm_mday);
254         date[RV8803_MONTH] = bin2bcd(tm->tm_mon + 1);
255         date[RV8803_YEAR]  = bin2bcd(tm->tm_year - 100);
256
257         ret = rv8803_write_regs(rv8803->client, RV8803_SEC, 7, date);
258         if (ret)
259                 return ret;
260
261         /* Restart the clock */
262         ret = rv8803_write_reg(rv8803->client, RV8803_CTRL,
263                                ctrl & ~RV8803_CTRL_RESET);
264         if (ret)
265                 return ret;
266
267         mutex_lock(&rv8803->flags_lock);
268
269         flags = rv8803_read_reg(rv8803->client, RV8803_FLAG);
270         if (flags < 0) {
271                 mutex_unlock(&rv8803->flags_lock);
272                 return flags;
273         }
274
275         ret = rv8803_write_reg(rv8803->client, RV8803_FLAG,
276                                flags & ~(RV8803_FLAG_V1F | RV8803_FLAG_V2F));
277
278         mutex_unlock(&rv8803->flags_lock);
279
280         return ret;
281 }
282
283 static int rv8803_get_alarm(struct device *dev, struct rtc_wkalrm *alrm)
284 {
285         struct rv8803_data *rv8803 = dev_get_drvdata(dev);
286         struct i2c_client *client = rv8803->client;
287         u8 alarmvals[3];
288         int flags, ret;
289
290         ret = rv8803_read_regs(client, RV8803_ALARM_MIN, 3, alarmvals);
291         if (ret)
292                 return ret;
293
294         flags = rv8803_read_reg(client, RV8803_FLAG);
295         if (flags < 0)
296                 return flags;
297
298         alrm->time.tm_sec  = 0;
299         alrm->time.tm_min  = bcd2bin(alarmvals[0] & 0x7f);
300         alrm->time.tm_hour = bcd2bin(alarmvals[1] & 0x3f);
301         alrm->time.tm_mday = bcd2bin(alarmvals[2] & 0x3f);
302
303         alrm->enabled = !!(rv8803->ctrl & RV8803_CTRL_AIE);
304         alrm->pending = (flags & RV8803_FLAG_AF) && alrm->enabled;
305
306         return 0;
307 }
308
309 static int rv8803_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
310 {
311         struct i2c_client *client = to_i2c_client(dev);
312         struct rv8803_data *rv8803 = dev_get_drvdata(dev);
313         u8 alarmvals[3];
314         u8 ctrl[2];
315         int ret, err;
316
317         /* The alarm has no seconds, round up to nearest minute */
318         if (alrm->time.tm_sec) {
319                 time64_t alarm_time = rtc_tm_to_time64(&alrm->time);
320
321                 alarm_time += 60 - alrm->time.tm_sec;
322                 rtc_time64_to_tm(alarm_time, &alrm->time);
323         }
324
325         mutex_lock(&rv8803->flags_lock);
326
327         ret = rv8803_read_regs(client, RV8803_FLAG, 2, ctrl);
328         if (ret) {
329                 mutex_unlock(&rv8803->flags_lock);
330                 return ret;
331         }
332
333         alarmvals[0] = bin2bcd(alrm->time.tm_min);
334         alarmvals[1] = bin2bcd(alrm->time.tm_hour);
335         alarmvals[2] = bin2bcd(alrm->time.tm_mday);
336
337         if (rv8803->ctrl & (RV8803_CTRL_AIE | RV8803_CTRL_UIE)) {
338                 rv8803->ctrl &= ~(RV8803_CTRL_AIE | RV8803_CTRL_UIE);
339                 err = rv8803_write_reg(rv8803->client, RV8803_CTRL,
340                                        rv8803->ctrl);
341                 if (err) {
342                         mutex_unlock(&rv8803->flags_lock);
343                         return err;
344                 }
345         }
346
347         ctrl[1] &= ~RV8803_FLAG_AF;
348         err = rv8803_write_reg(rv8803->client, RV8803_FLAG, ctrl[1]);
349         mutex_unlock(&rv8803->flags_lock);
350         if (err)
351                 return err;
352
353         err = rv8803_write_regs(rv8803->client, RV8803_ALARM_MIN, 3, alarmvals);
354         if (err)
355                 return err;
356
357         if (alrm->enabled) {
358                 if (rv8803->rtc->uie_rtctimer.enabled)
359                         rv8803->ctrl |= RV8803_CTRL_UIE;
360                 if (rv8803->rtc->aie_timer.enabled)
361                         rv8803->ctrl |= RV8803_CTRL_AIE;
362
363                 err = rv8803_write_reg(rv8803->client, RV8803_CTRL,
364                                        rv8803->ctrl);
365                 if (err)
366                         return err;
367         }
368
369         return 0;
370 }
371
372 static int rv8803_alarm_irq_enable(struct device *dev, unsigned int enabled)
373 {
374         struct i2c_client *client = to_i2c_client(dev);
375         struct rv8803_data *rv8803 = dev_get_drvdata(dev);
376         int ctrl, flags, err;
377
378         ctrl = rv8803->ctrl;
379
380         if (enabled) {
381                 if (rv8803->rtc->uie_rtctimer.enabled)
382                         ctrl |= RV8803_CTRL_UIE;
383                 if (rv8803->rtc->aie_timer.enabled)
384                         ctrl |= RV8803_CTRL_AIE;
385         } else {
386                 if (!rv8803->rtc->uie_rtctimer.enabled)
387                         ctrl &= ~RV8803_CTRL_UIE;
388                 if (!rv8803->rtc->aie_timer.enabled)
389                         ctrl &= ~RV8803_CTRL_AIE;
390         }
391
392         mutex_lock(&rv8803->flags_lock);
393         flags = rv8803_read_reg(client, RV8803_FLAG);
394         if (flags < 0) {
395                 mutex_unlock(&rv8803->flags_lock);
396                 return flags;
397         }
398         flags &= ~(RV8803_FLAG_AF | RV8803_FLAG_UF);
399         err = rv8803_write_reg(client, RV8803_FLAG, flags);
400         mutex_unlock(&rv8803->flags_lock);
401         if (err)
402                 return err;
403
404         if (ctrl != rv8803->ctrl) {
405                 rv8803->ctrl = ctrl;
406                 err = rv8803_write_reg(client, RV8803_CTRL, rv8803->ctrl);
407                 if (err)
408                         return err;
409         }
410
411         return 0;
412 }
413
414 static int rv8803_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
415 {
416         struct i2c_client *client = to_i2c_client(dev);
417         struct rv8803_data *rv8803 = dev_get_drvdata(dev);
418         int flags, ret = 0;
419
420         switch (cmd) {
421         case RTC_VL_READ:
422                 flags = rv8803_read_reg(client, RV8803_FLAG);
423                 if (flags < 0)
424                         return flags;
425
426                 if (flags & RV8803_FLAG_V1F)
427                         dev_warn(&client->dev, "Voltage low, temperature compensation stopped.\n");
428
429                 if (flags & RV8803_FLAG_V2F)
430                         dev_warn(&client->dev, "Voltage low, data loss detected.\n");
431
432                 flags &= RV8803_FLAG_V1F | RV8803_FLAG_V2F;
433
434                 if (copy_to_user((void __user *)arg, &flags, sizeof(int)))
435                         return -EFAULT;
436
437                 return 0;
438
439         case RTC_VL_CLR:
440                 mutex_lock(&rv8803->flags_lock);
441                 flags = rv8803_read_reg(client, RV8803_FLAG);
442                 if (flags < 0) {
443                         mutex_unlock(&rv8803->flags_lock);
444                         return flags;
445                 }
446
447                 flags &= ~(RV8803_FLAG_V1F | RV8803_FLAG_V2F);
448                 ret = rv8803_write_reg(client, RV8803_FLAG, flags);
449                 mutex_unlock(&rv8803->flags_lock);
450                 if (ret)
451                         return ret;
452
453                 return 0;
454
455         default:
456                 return -ENOIOCTLCMD;
457         }
458 }
459
460 static int rv8803_nvram_write(void *priv, unsigned int offset, void *val,
461                               size_t bytes)
462 {
463         int ret;
464
465         ret = rv8803_write_reg(priv, RV8803_RAM, *(u8 *)val);
466         if (ret)
467                 return ret;
468
469         return 0;
470 }
471
472 static int rv8803_nvram_read(void *priv, unsigned int offset,
473                              void *val, size_t bytes)
474 {
475         int ret;
476
477         ret = rv8803_read_reg(priv, RV8803_RAM);
478         if (ret < 0)
479                 return ret;
480
481         *(u8 *)val = ret;
482
483         return 0;
484 }
485
486 static struct rtc_class_ops rv8803_rtc_ops = {
487         .read_time = rv8803_get_time,
488         .set_time = rv8803_set_time,
489         .ioctl = rv8803_ioctl,
490 };
491
492 static int rx8900_trickle_charger_init(struct rv8803_data *rv8803)
493 {
494         struct i2c_client *client = rv8803->client;
495         struct device_node *node = client->dev.of_node;
496         int err;
497         u8 flags;
498
499         if (!node)
500                 return 0;
501
502         if (rv8803->type != rx_8900)
503                 return 0;
504
505         err = i2c_smbus_read_byte_data(rv8803->client, RX8900_BACKUP_CTRL);
506         if (err < 0)
507                 return err;
508
509         flags = ~(RX8900_FLAG_VDETOFF | RX8900_FLAG_SWOFF) & (u8)err;
510
511         if (of_property_read_bool(node, "epson,vdet-disable"))
512                 flags |= RX8900_FLAG_VDETOFF;
513
514         if (of_property_read_bool(node, "trickle-diode-disable"))
515                 flags |= RX8900_FLAG_SWOFF;
516
517         return i2c_smbus_write_byte_data(rv8803->client, RX8900_BACKUP_CTRL,
518                                          flags);
519 }
520
521 static int rv8803_probe(struct i2c_client *client,
522                         const struct i2c_device_id *id)
523 {
524         struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
525         struct rv8803_data *rv8803;
526         int err, flags;
527         struct nvmem_config nvmem_cfg = {
528                 .name = "rv8803_nvram",
529                 .word_size = 1,
530                 .stride = 1,
531                 .size = 1,
532                 .reg_read = rv8803_nvram_read,
533                 .reg_write = rv8803_nvram_write,
534                 .priv = client,
535         };
536
537         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
538                                      I2C_FUNC_SMBUS_I2C_BLOCK)) {
539                 dev_err(&adapter->dev, "doesn't support I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK\n");
540                 return -EIO;
541         }
542
543         rv8803 = devm_kzalloc(&client->dev, sizeof(struct rv8803_data),
544                               GFP_KERNEL);
545         if (!rv8803)
546                 return -ENOMEM;
547
548         mutex_init(&rv8803->flags_lock);
549         rv8803->client = client;
550         if (client->dev.of_node)
551                 rv8803->type = (enum rv8803_type)
552                         of_device_get_match_data(&client->dev);
553         else
554                 rv8803->type = id->driver_data;
555         i2c_set_clientdata(client, rv8803);
556
557         flags = rv8803_read_reg(client, RV8803_FLAG);
558         if (flags < 0)
559                 return flags;
560
561         if (flags & RV8803_FLAG_V1F)
562                 dev_warn(&client->dev, "Voltage low, temperature compensation stopped.\n");
563
564         if (flags & RV8803_FLAG_V2F)
565                 dev_warn(&client->dev, "Voltage low, data loss detected.\n");
566
567         if (flags & RV8803_FLAG_AF)
568                 dev_warn(&client->dev, "An alarm maybe have been missed.\n");
569
570         rv8803->rtc = devm_rtc_allocate_device(&client->dev);
571         if (IS_ERR(rv8803->rtc)) {
572                 return PTR_ERR(rv8803->rtc);
573         }
574
575         if (client->irq > 0) {
576                 err = devm_request_threaded_irq(&client->dev, client->irq,
577                                                 NULL, rv8803_handle_irq,
578                                                 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
579                                                 "rv8803", client);
580                 if (err) {
581                         dev_warn(&client->dev, "unable to request IRQ, alarms disabled\n");
582                         client->irq = 0;
583                 } else {
584                         rv8803_rtc_ops.read_alarm = rv8803_get_alarm;
585                         rv8803_rtc_ops.set_alarm = rv8803_set_alarm;
586                         rv8803_rtc_ops.alarm_irq_enable = rv8803_alarm_irq_enable;
587                 }
588         }
589
590         err = rv8803_write_reg(rv8803->client, RV8803_EXT, RV8803_EXT_WADA);
591         if (err)
592                 return err;
593
594         err = rx8900_trickle_charger_init(rv8803);
595         if (err) {
596                 dev_err(&client->dev, "failed to init charger\n");
597                 return err;
598         }
599
600         rv8803->rtc->ops = &rv8803_rtc_ops;
601         rv8803->rtc->nvram_old_abi = true;
602         rv8803->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000;
603         rv8803->rtc->range_max = RTC_TIMESTAMP_END_2099;
604         err = rtc_register_device(rv8803->rtc);
605         if (err)
606                 return err;
607
608         rtc_nvmem_register(rv8803->rtc, &nvmem_cfg);
609
610         rv8803->rtc->max_user_freq = 1;
611
612         return 0;
613 }
614
615 static const struct i2c_device_id rv8803_id[] = {
616         { "rv8803", rv_8803 },
617         { "rx8803", rv_8803 },
618         { "rx8900", rx_8900 },
619         { }
620 };
621 MODULE_DEVICE_TABLE(i2c, rv8803_id);
622
623 static const struct of_device_id rv8803_of_match[] = {
624         {
625                 .compatible = "microcrystal,rv8803",
626                 .data = (void *)rv_8803
627         },
628         {
629                 .compatible = "epson,rx8803",
630                 .data = (void *)rv_8803
631         },
632         {
633                 .compatible = "epson,rx8900",
634                 .data = (void *)rx_8900
635         },
636         { }
637 };
638 MODULE_DEVICE_TABLE(of, rv8803_of_match);
639
640 static struct i2c_driver rv8803_driver = {
641         .driver = {
642                 .name = "rtc-rv8803",
643                 .of_match_table = of_match_ptr(rv8803_of_match),
644         },
645         .probe          = rv8803_probe,
646         .id_table       = rv8803_id,
647 };
648 module_i2c_driver(rv8803_driver);
649
650 MODULE_AUTHOR("Alexandre Belloni <alexandre.belloni@free-electrons.com>");
651 MODULE_DESCRIPTION("Micro Crystal RV8803 RTC driver");
652 MODULE_LICENSE("GPL v2");