Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * I2C client/driver for the ST M41T80 family of i2c rtc chips.
4 *
5 * Author: Alexander Bigga <ab@mycable.de>
6 *
7 * Based on m41t00.c by Mark A. Greer <mgreer@mvista.com>
8 *
9 * 2006 (c) mycable GmbH
10 */
11
12#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13
14#include <linux/bcd.h>
15#include <linux/clk-provider.h>
16#include <linux/i2c.h>
17#include <linux/init.h>
18#include <linux/kernel.h>
19#include <linux/module.h>
20#include <linux/of_device.h>
21#include <linux/rtc.h>
22#include <linux/slab.h>
23#include <linux/mutex.h>
24#include <linux/string.h>
25#ifdef CONFIG_RTC_DRV_M41T80_WDT
26#include <linux/fs.h>
27#include <linux/ioctl.h>
28#include <linux/miscdevice.h>
29#include <linux/reboot.h>
30#include <linux/watchdog.h>
31#endif
32
33#define M41T80_REG_SSEC 0x00
34#define M41T80_REG_SEC 0x01
35#define M41T80_REG_MIN 0x02
36#define M41T80_REG_HOUR 0x03
37#define M41T80_REG_WDAY 0x04
38#define M41T80_REG_DAY 0x05
39#define M41T80_REG_MON 0x06
40#define M41T80_REG_YEAR 0x07
41#define M41T80_REG_ALARM_MON 0x0a
42#define M41T80_REG_ALARM_DAY 0x0b
43#define M41T80_REG_ALARM_HOUR 0x0c
44#define M41T80_REG_ALARM_MIN 0x0d
45#define M41T80_REG_ALARM_SEC 0x0e
46#define M41T80_REG_FLAGS 0x0f
47#define M41T80_REG_SQW 0x13
48
49#define M41T80_DATETIME_REG_SIZE (M41T80_REG_YEAR + 1)
50#define M41T80_ALARM_REG_SIZE \
51 (M41T80_REG_ALARM_SEC + 1 - M41T80_REG_ALARM_MON)
52
53#define M41T80_SQW_MAX_FREQ 32768
54
55#define M41T80_SEC_ST BIT(7) /* ST: Stop Bit */
56#define M41T80_ALMON_AFE BIT(7) /* AFE: AF Enable Bit */
57#define M41T80_ALMON_SQWE BIT(6) /* SQWE: SQW Enable Bit */
58#define M41T80_ALHOUR_HT BIT(6) /* HT: Halt Update Bit */
59#define M41T80_FLAGS_OF BIT(2) /* OF: Oscillator Failure Bit */
60#define M41T80_FLAGS_AF BIT(6) /* AF: Alarm Flag Bit */
61#define M41T80_FLAGS_BATT_LOW BIT(4) /* BL: Battery Low Bit */
62#define M41T80_WATCHDOG_RB2 BIT(7) /* RB: Watchdog resolution */
63#define M41T80_WATCHDOG_RB1 BIT(1) /* RB: Watchdog resolution */
64#define M41T80_WATCHDOG_RB0 BIT(0) /* RB: Watchdog resolution */
65
66#define M41T80_FEATURE_HT BIT(0) /* Halt feature */
67#define M41T80_FEATURE_BL BIT(1) /* Battery low indicator */
68#define M41T80_FEATURE_SQ BIT(2) /* Squarewave feature */
69#define M41T80_FEATURE_WD BIT(3) /* Extra watchdog resolution */
70#define M41T80_FEATURE_SQ_ALT BIT(4) /* RSx bits are in reg 4 */
71
72static const struct i2c_device_id m41t80_id[] = {
73 { "m41t62", M41T80_FEATURE_SQ | M41T80_FEATURE_SQ_ALT },
74 { "m41t65", M41T80_FEATURE_HT | M41T80_FEATURE_WD },
75 { "m41t80", M41T80_FEATURE_SQ },
76 { "m41t81", M41T80_FEATURE_HT | M41T80_FEATURE_SQ},
77 { "m41t81s", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
78 { "m41t82", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
79 { "m41t83", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
80 { "m41st84", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
81 { "m41st85", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
82 { "m41st87", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
83 { "rv4162", M41T80_FEATURE_SQ | M41T80_FEATURE_WD | M41T80_FEATURE_SQ_ALT },
84 { }
85};
86MODULE_DEVICE_TABLE(i2c, m41t80_id);
87
88static const __maybe_unused struct of_device_id m41t80_of_match[] = {
89 {
90 .compatible = "st,m41t62",
91 .data = (void *)(M41T80_FEATURE_SQ | M41T80_FEATURE_SQ_ALT)
92 },
93 {
94 .compatible = "st,m41t65",
95 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_WD)
96 },
97 {
98 .compatible = "st,m41t80",
99 .data = (void *)(M41T80_FEATURE_SQ)
100 },
101 {
102 .compatible = "st,m41t81",
103 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_SQ)
104 },
105 {
106 .compatible = "st,m41t81s",
107 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ)
108 },
109 {
110 .compatible = "st,m41t82",
111 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ)
112 },
113 {
114 .compatible = "st,m41t83",
115 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ)
116 },
117 {
118 .compatible = "st,m41t84",
119 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ)
120 },
121 {
122 .compatible = "st,m41t85",
123 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ)
124 },
125 {
126 .compatible = "st,m41t87",
127 .data = (void *)(M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ)
128 },
129 {
130 .compatible = "microcrystal,rv4162",
131 .data = (void *)(M41T80_FEATURE_SQ | M41T80_FEATURE_WD | M41T80_FEATURE_SQ_ALT)
132 },
133 /* DT compatibility only, do not use compatibles below: */
134 {
135 .compatible = "st,rv4162",
136 .data = (void *)(M41T80_FEATURE_SQ | M41T80_FEATURE_WD | M41T80_FEATURE_SQ_ALT)
137 },
138 {
139 .compatible = "rv4162",
140 .data = (void *)(M41T80_FEATURE_SQ | M41T80_FEATURE_WD | M41T80_FEATURE_SQ_ALT)
141 },
142 { }
143};
144MODULE_DEVICE_TABLE(of, m41t80_of_match);
145
146struct m41t80_data {
147 unsigned long features;
148 struct i2c_client *client;
149 struct rtc_device *rtc;
150#ifdef CONFIG_COMMON_CLK
151 struct clk_hw sqw;
152 unsigned long freq;
153 unsigned int sqwe;
154#endif
155};
156
157static irqreturn_t m41t80_handle_irq(int irq, void *dev_id)
158{
159 struct i2c_client *client = dev_id;
160 struct m41t80_data *m41t80 = i2c_get_clientdata(client);
161 unsigned long events = 0;
162 int flags, flags_afe;
163
164 rtc_lock(m41t80->rtc);
165
166 flags_afe = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
167 if (flags_afe < 0) {
168 rtc_unlock(m41t80->rtc);
169 return IRQ_NONE;
170 }
171
172 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
173 if (flags <= 0) {
174 rtc_unlock(m41t80->rtc);
175 return IRQ_NONE;
176 }
177
178 if (flags & M41T80_FLAGS_AF) {
179 flags &= ~M41T80_FLAGS_AF;
180 flags_afe &= ~M41T80_ALMON_AFE;
181 events |= RTC_AF;
182 }
183
184 if (events) {
185 rtc_update_irq(m41t80->rtc, 1, events);
186 i2c_smbus_write_byte_data(client, M41T80_REG_FLAGS, flags);
187 i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
188 flags_afe);
189 }
190
191 rtc_unlock(m41t80->rtc);
192
193 return IRQ_HANDLED;
194}
195
196static int m41t80_rtc_read_time(struct device *dev, struct rtc_time *tm)
197{
198 struct i2c_client *client = to_i2c_client(dev);
199 unsigned char buf[8];
200 int err, flags;
201
202 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
203 if (flags < 0)
204 return flags;
205
206 if (flags & M41T80_FLAGS_OF) {
207 dev_err(&client->dev, "Oscillator failure, data is invalid.\n");
208 return -EINVAL;
209 }
210
211 err = i2c_smbus_read_i2c_block_data(client, M41T80_REG_SSEC,
212 sizeof(buf), buf);
213 if (err < 0) {
214 dev_err(&client->dev, "Unable to read date\n");
215 return err;
216 }
217
218 tm->tm_sec = bcd2bin(buf[M41T80_REG_SEC] & 0x7f);
219 tm->tm_min = bcd2bin(buf[M41T80_REG_MIN] & 0x7f);
220 tm->tm_hour = bcd2bin(buf[M41T80_REG_HOUR] & 0x3f);
221 tm->tm_mday = bcd2bin(buf[M41T80_REG_DAY] & 0x3f);
222 tm->tm_wday = buf[M41T80_REG_WDAY] & 0x07;
223 tm->tm_mon = bcd2bin(buf[M41T80_REG_MON] & 0x1f) - 1;
224
225 /* assume 20YY not 19YY, and ignore the Century Bit */
226 tm->tm_year = bcd2bin(buf[M41T80_REG_YEAR]) + 100;
227 return 0;
228}
229
230static int m41t80_rtc_set_time(struct device *dev, struct rtc_time *tm)
231{
232 struct i2c_client *client = to_i2c_client(dev);
233 struct m41t80_data *clientdata = i2c_get_clientdata(client);
234 unsigned char buf[8];
235 int err, flags;
236
237 buf[M41T80_REG_SSEC] = 0;
238 buf[M41T80_REG_SEC] = bin2bcd(tm->tm_sec);
239 buf[M41T80_REG_MIN] = bin2bcd(tm->tm_min);
240 buf[M41T80_REG_HOUR] = bin2bcd(tm->tm_hour);
241 buf[M41T80_REG_DAY] = bin2bcd(tm->tm_mday);
242 buf[M41T80_REG_MON] = bin2bcd(tm->tm_mon + 1);
243 buf[M41T80_REG_YEAR] = bin2bcd(tm->tm_year - 100);
244 buf[M41T80_REG_WDAY] = tm->tm_wday;
245
246 /* If the square wave output is controlled in the weekday register */
247 if (clientdata->features & M41T80_FEATURE_SQ_ALT) {
248 int val;
249
250 val = i2c_smbus_read_byte_data(client, M41T80_REG_WDAY);
251 if (val < 0)
252 return val;
253
254 buf[M41T80_REG_WDAY] |= (val & 0xf0);
255 }
256
257 err = i2c_smbus_write_i2c_block_data(client, M41T80_REG_SSEC,
258 sizeof(buf), buf);
259 if (err < 0) {
260 dev_err(&client->dev, "Unable to write to date registers\n");
261 return err;
262 }
263
264 /* Clear the OF bit of Flags Register */
265 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
266 if (flags < 0)
267 return flags;
268
269 err = i2c_smbus_write_byte_data(client, M41T80_REG_FLAGS,
270 flags & ~M41T80_FLAGS_OF);
271 if (err < 0) {
272 dev_err(&client->dev, "Unable to write flags register\n");
273 return err;
274 }
275
276 return err;
277}
278
279static int m41t80_rtc_proc(struct device *dev, struct seq_file *seq)
280{
281 struct i2c_client *client = to_i2c_client(dev);
282 struct m41t80_data *clientdata = i2c_get_clientdata(client);
283 int reg;
284
285 if (clientdata->features & M41T80_FEATURE_BL) {
286 reg = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
287 if (reg < 0)
288 return reg;
289 seq_printf(seq, "battery\t\t: %s\n",
290 (reg & M41T80_FLAGS_BATT_LOW) ? "exhausted" : "ok");
291 }
292 return 0;
293}
294
295static int m41t80_alarm_irq_enable(struct device *dev, unsigned int enabled)
296{
297 struct i2c_client *client = to_i2c_client(dev);
298 int flags, retval;
299
300 flags = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
301 if (flags < 0)
302 return flags;
303
304 if (enabled)
305 flags |= M41T80_ALMON_AFE;
306 else
307 flags &= ~M41T80_ALMON_AFE;
308
309 retval = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON, flags);
310 if (retval < 0) {
311 dev_err(dev, "Unable to enable alarm IRQ %d\n", retval);
312 return retval;
313 }
314 return 0;
315}
316
317static int m41t80_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
318{
319 struct i2c_client *client = to_i2c_client(dev);
320 u8 alarmvals[5];
321 int ret, err;
322
323 alarmvals[0] = bin2bcd(alrm->time.tm_mon + 1);
324 alarmvals[1] = bin2bcd(alrm->time.tm_mday);
325 alarmvals[2] = bin2bcd(alrm->time.tm_hour);
326 alarmvals[3] = bin2bcd(alrm->time.tm_min);
327 alarmvals[4] = bin2bcd(alrm->time.tm_sec);
328
329 /* Clear AF and AFE flags */
330 ret = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
331 if (ret < 0)
332 return ret;
333 err = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
334 ret & ~(M41T80_ALMON_AFE));
335 if (err < 0) {
336 dev_err(dev, "Unable to clear AFE bit\n");
337 return err;
338 }
339
340 /* Keep SQWE bit value */
341 alarmvals[0] |= (ret & M41T80_ALMON_SQWE);
342
343 ret = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
344 if (ret < 0)
345 return ret;
346
347 err = i2c_smbus_write_byte_data(client, M41T80_REG_FLAGS,
348 ret & ~(M41T80_FLAGS_AF));
349 if (err < 0) {
350 dev_err(dev, "Unable to clear AF bit\n");
351 return err;
352 }
353
354 /* Write the alarm */
355 err = i2c_smbus_write_i2c_block_data(client, M41T80_REG_ALARM_MON,
356 5, alarmvals);
357 if (err)
358 return err;
359
360 /* Enable the alarm interrupt */
361 if (alrm->enabled) {
362 alarmvals[0] |= M41T80_ALMON_AFE;
363 err = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
364 alarmvals[0]);
365 if (err)
366 return err;
367 }
368
369 return 0;
370}
371
372static int m41t80_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
373{
374 struct i2c_client *client = to_i2c_client(dev);
375 u8 alarmvals[5];
376 int flags, ret;
377
378 ret = i2c_smbus_read_i2c_block_data(client, M41T80_REG_ALARM_MON,
379 5, alarmvals);
380 if (ret != 5)
381 return ret < 0 ? ret : -EIO;
382
383 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
384 if (flags < 0)
385 return flags;
386
387 alrm->time.tm_sec = bcd2bin(alarmvals[4] & 0x7f);
388 alrm->time.tm_min = bcd2bin(alarmvals[3] & 0x7f);
389 alrm->time.tm_hour = bcd2bin(alarmvals[2] & 0x3f);
390 alrm->time.tm_mday = bcd2bin(alarmvals[1] & 0x3f);
391 alrm->time.tm_mon = bcd2bin(alarmvals[0] & 0x3f) - 1;
392
393 alrm->enabled = !!(alarmvals[0] & M41T80_ALMON_AFE);
394 alrm->pending = (flags & M41T80_FLAGS_AF) && alrm->enabled;
395
396 return 0;
397}
398
399static const struct rtc_class_ops m41t80_rtc_ops = {
400 .read_time = m41t80_rtc_read_time,
401 .set_time = m41t80_rtc_set_time,
402 .proc = m41t80_rtc_proc,
403 .read_alarm = m41t80_read_alarm,
404 .set_alarm = m41t80_set_alarm,
405 .alarm_irq_enable = m41t80_alarm_irq_enable,
406};
407
408#ifdef CONFIG_PM_SLEEP
409static int m41t80_suspend(struct device *dev)
410{
411 struct i2c_client *client = to_i2c_client(dev);
412
413 if (client->irq >= 0 && device_may_wakeup(dev))
414 enable_irq_wake(client->irq);
415
416 return 0;
417}
418
419static int m41t80_resume(struct device *dev)
420{
421 struct i2c_client *client = to_i2c_client(dev);
422
423 if (client->irq >= 0 && device_may_wakeup(dev))
424 disable_irq_wake(client->irq);
425
426 return 0;
427}
428#endif
429
430static SIMPLE_DEV_PM_OPS(m41t80_pm, m41t80_suspend, m41t80_resume);
431
432#ifdef CONFIG_COMMON_CLK
433#define sqw_to_m41t80_data(_hw) container_of(_hw, struct m41t80_data, sqw)
434
435static unsigned long m41t80_decode_freq(int setting)
436{
437 return (setting == 0) ? 0 : (setting == 1) ? M41T80_SQW_MAX_FREQ :
438 M41T80_SQW_MAX_FREQ >> setting;
439}
440
441static unsigned long m41t80_get_freq(struct m41t80_data *m41t80)
442{
443 struct i2c_client *client = m41t80->client;
444 int reg_sqw = (m41t80->features & M41T80_FEATURE_SQ_ALT) ?
445 M41T80_REG_WDAY : M41T80_REG_SQW;
446 int ret = i2c_smbus_read_byte_data(client, reg_sqw);
447
448 if (ret < 0)
449 return 0;
450 return m41t80_decode_freq(ret >> 4);
451}
452
453static unsigned long m41t80_sqw_recalc_rate(struct clk_hw *hw,
454 unsigned long parent_rate)
455{
456 return sqw_to_m41t80_data(hw)->freq;
457}
458
459static long m41t80_sqw_round_rate(struct clk_hw *hw, unsigned long rate,
460 unsigned long *prate)
461{
462 if (rate >= M41T80_SQW_MAX_FREQ)
463 return M41T80_SQW_MAX_FREQ;
464 if (rate >= M41T80_SQW_MAX_FREQ / 4)
465 return M41T80_SQW_MAX_FREQ / 4;
466 if (!rate)
467 return 0;
468 return 1 << ilog2(rate);
469}
470
471static int m41t80_sqw_set_rate(struct clk_hw *hw, unsigned long rate,
472 unsigned long parent_rate)
473{
474 struct m41t80_data *m41t80 = sqw_to_m41t80_data(hw);
475 struct i2c_client *client = m41t80->client;
476 int reg_sqw = (m41t80->features & M41T80_FEATURE_SQ_ALT) ?
477 M41T80_REG_WDAY : M41T80_REG_SQW;
478 int reg, ret, val = 0;
479
480 if (rate >= M41T80_SQW_MAX_FREQ)
481 val = 1;
482 else if (rate >= M41T80_SQW_MAX_FREQ / 4)
483 val = 2;
484 else if (rate)
485 val = 15 - ilog2(rate);
486
487 reg = i2c_smbus_read_byte_data(client, reg_sqw);
488 if (reg < 0)
489 return reg;
490
491 reg = (reg & 0x0f) | (val << 4);
492
493 ret = i2c_smbus_write_byte_data(client, reg_sqw, reg);
494 if (!ret)
495 m41t80->freq = m41t80_decode_freq(val);
496 return ret;
497}
498
499static int m41t80_sqw_control(struct clk_hw *hw, bool enable)
500{
501 struct m41t80_data *m41t80 = sqw_to_m41t80_data(hw);
502 struct i2c_client *client = m41t80->client;
503 int ret = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
504
505 if (ret < 0)
506 return ret;
507
508 if (enable)
509 ret |= M41T80_ALMON_SQWE;
510 else
511 ret &= ~M41T80_ALMON_SQWE;
512
513 ret = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON, ret);
514 if (!ret)
515 m41t80->sqwe = enable;
516 return ret;
517}
518
519static int m41t80_sqw_prepare(struct clk_hw *hw)
520{
521 return m41t80_sqw_control(hw, 1);
522}
523
524static void m41t80_sqw_unprepare(struct clk_hw *hw)
525{
526 m41t80_sqw_control(hw, 0);
527}
528
529static int m41t80_sqw_is_prepared(struct clk_hw *hw)
530{
531 return sqw_to_m41t80_data(hw)->sqwe;
532}
533
534static const struct clk_ops m41t80_sqw_ops = {
535 .prepare = m41t80_sqw_prepare,
536 .unprepare = m41t80_sqw_unprepare,
537 .is_prepared = m41t80_sqw_is_prepared,
538 .recalc_rate = m41t80_sqw_recalc_rate,
539 .round_rate = m41t80_sqw_round_rate,
540 .set_rate = m41t80_sqw_set_rate,
541};
542
543static struct clk *m41t80_sqw_register_clk(struct m41t80_data *m41t80)
544{
545 struct i2c_client *client = m41t80->client;
546 struct device_node *node = client->dev.of_node;
547 struct device_node *fixed_clock;
548 struct clk *clk;
549 struct clk_init_data init;
550 int ret;
551
552 fixed_clock = of_get_child_by_name(node, "clock");
553 if (fixed_clock) {
554 /*
555 * skip registering square wave clock when a fixed
556 * clock has been registered. The fixed clock is
557 * registered automatically when being referenced.
558 */
559 of_node_put(fixed_clock);
560 return NULL;
561 }
562
563 /* First disable the clock */
564 ret = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
565 if (ret < 0)
566 return ERR_PTR(ret);
567 ret = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
568 ret & ~(M41T80_ALMON_SQWE));
569 if (ret < 0)
570 return ERR_PTR(ret);
571
572 init.name = "m41t80-sqw";
573 init.ops = &m41t80_sqw_ops;
574 init.flags = 0;
575 init.parent_names = NULL;
576 init.num_parents = 0;
577 m41t80->sqw.init = &init;
578 m41t80->freq = m41t80_get_freq(m41t80);
579
580 /* optional override of the clockname */
581 of_property_read_string(node, "clock-output-names", &init.name);
582
583 /* register the clock */
584 clk = clk_register(&client->dev, &m41t80->sqw);
585 if (!IS_ERR(clk))
586 of_clk_add_provider(node, of_clk_src_simple_get, clk);
587
588 return clk;
589}
590#endif
591
592#ifdef CONFIG_RTC_DRV_M41T80_WDT
593/*
594 *****************************************************************************
595 *
596 * Watchdog Driver
597 *
598 *****************************************************************************
599 */
600static DEFINE_MUTEX(m41t80_rtc_mutex);
601static struct i2c_client *save_client;
602
603/* Default margin */
604#define WD_TIMO 60 /* 1..31 seconds */
605
606static int wdt_margin = WD_TIMO;
607module_param(wdt_margin, int, 0);
608MODULE_PARM_DESC(wdt_margin, "Watchdog timeout in seconds (default 60s)");
609
610static unsigned long wdt_is_open;
611static int boot_flag;
612
613/**
614 * wdt_ping - Reload counter one with the watchdog timeout.
615 * We don't bother reloading the cascade counter.
616 */
617static void wdt_ping(void)
618{
619 unsigned char i2c_data[2];
620 struct i2c_msg msgs1[1] = {
621 {
622 .addr = save_client->addr,
623 .flags = 0,
624 .len = 2,
625 .buf = i2c_data,
626 },
627 };
628 struct m41t80_data *clientdata = i2c_get_clientdata(save_client);
629
630 i2c_data[0] = 0x09; /* watchdog register */
631
632 if (wdt_margin > 31)
633 i2c_data[1] = (wdt_margin & 0xFC) | 0x83; /* resolution = 4s */
634 else
635 /*
636 * WDS = 1 (0x80), mulitplier = WD_TIMO, resolution = 1s (0x02)
637 */
638 i2c_data[1] = wdt_margin << 2 | 0x82;
639
640 /*
641 * M41T65 has three bits for watchdog resolution. Don't set bit 7, as
642 * that would be an invalid resolution.
643 */
644 if (clientdata->features & M41T80_FEATURE_WD)
645 i2c_data[1] &= ~M41T80_WATCHDOG_RB2;
646
647 i2c_transfer(save_client->adapter, msgs1, 1);
648}
649
650/**
651 * wdt_disable - disables watchdog.
652 */
653static void wdt_disable(void)
654{
655 unsigned char i2c_data[2], i2c_buf[0x10];
656 struct i2c_msg msgs0[2] = {
657 {
658 .addr = save_client->addr,
659 .flags = 0,
660 .len = 1,
661 .buf = i2c_data,
662 },
663 {
664 .addr = save_client->addr,
665 .flags = I2C_M_RD,
666 .len = 1,
667 .buf = i2c_buf,
668 },
669 };
670 struct i2c_msg msgs1[1] = {
671 {
672 .addr = save_client->addr,
673 .flags = 0,
674 .len = 2,
675 .buf = i2c_data,
676 },
677 };
678
679 i2c_data[0] = 0x09;
680 i2c_transfer(save_client->adapter, msgs0, 2);
681
682 i2c_data[0] = 0x09;
683 i2c_data[1] = 0x00;
684 i2c_transfer(save_client->adapter, msgs1, 1);
685}
686
687/**
688 * wdt_write - write to watchdog.
689 * @file: file handle to the watchdog
690 * @buf: buffer to write (unused as data does not matter here
691 * @count: count of bytes
692 * @ppos: pointer to the position to write. No seeks allowed
693 *
694 * A write to a watchdog device is defined as a keepalive signal. Any
695 * write of data will do, as we don't define content meaning.
696 */
697static ssize_t wdt_write(struct file *file, const char __user *buf,
698 size_t count, loff_t *ppos)
699{
700 if (count) {
701 wdt_ping();
702 return 1;
703 }
704 return 0;
705}
706
707static ssize_t wdt_read(struct file *file, char __user *buf,
708 size_t count, loff_t *ppos)
709{
710 return 0;
711}
712
713/**
714 * wdt_ioctl - ioctl handler to set watchdog.
715 * @file: file handle to the device
716 * @cmd: watchdog command
717 * @arg: argument pointer
718 *
719 * The watchdog API defines a common set of functions for all watchdogs
720 * according to their available features. We only actually usefully support
721 * querying capabilities and current status.
722 */
723static int wdt_ioctl(struct file *file, unsigned int cmd,
724 unsigned long arg)
725{
726 int new_margin, rv;
727 static struct watchdog_info ident = {
728 .options = WDIOF_POWERUNDER | WDIOF_KEEPALIVEPING |
729 WDIOF_SETTIMEOUT,
730 .firmware_version = 1,
731 .identity = "M41T80 WTD"
732 };
733
734 switch (cmd) {
735 case WDIOC_GETSUPPORT:
736 return copy_to_user((struct watchdog_info __user *)arg, &ident,
737 sizeof(ident)) ? -EFAULT : 0;
738
739 case WDIOC_GETSTATUS:
740 case WDIOC_GETBOOTSTATUS:
741 return put_user(boot_flag, (int __user *)arg);
742 case WDIOC_KEEPALIVE:
743 wdt_ping();
744 return 0;
745 case WDIOC_SETTIMEOUT:
746 if (get_user(new_margin, (int __user *)arg))
747 return -EFAULT;
748 /* Arbitrary, can't find the card's limits */
749 if (new_margin < 1 || new_margin > 124)
750 return -EINVAL;
751 wdt_margin = new_margin;
752 wdt_ping();
753 fallthrough;
754 case WDIOC_GETTIMEOUT:
755 return put_user(wdt_margin, (int __user *)arg);
756
757 case WDIOC_SETOPTIONS:
758 if (copy_from_user(&rv, (int __user *)arg, sizeof(int)))
759 return -EFAULT;
760
761 if (rv & WDIOS_DISABLECARD) {
762 pr_info("disable watchdog\n");
763 wdt_disable();
764 }
765
766 if (rv & WDIOS_ENABLECARD) {
767 pr_info("enable watchdog\n");
768 wdt_ping();
769 }
770
771 return -EINVAL;
772 }
773 return -ENOTTY;
774}
775
776static long wdt_unlocked_ioctl(struct file *file, unsigned int cmd,
777 unsigned long arg)
778{
779 int ret;
780
781 mutex_lock(&m41t80_rtc_mutex);
782 ret = wdt_ioctl(file, cmd, arg);
783 mutex_unlock(&m41t80_rtc_mutex);
784
785 return ret;
786}
787
788/**
789 * wdt_open - open a watchdog.
790 * @inode: inode of device
791 * @file: file handle to device
792 *
793 */
794static int wdt_open(struct inode *inode, struct file *file)
795{
796 if (iminor(inode) == WATCHDOG_MINOR) {
797 mutex_lock(&m41t80_rtc_mutex);
798 if (test_and_set_bit(0, &wdt_is_open)) {
799 mutex_unlock(&m41t80_rtc_mutex);
800 return -EBUSY;
801 }
802 /*
803 * Activate
804 */
805 wdt_is_open = 1;
806 mutex_unlock(&m41t80_rtc_mutex);
807 return stream_open(inode, file);
808 }
809 return -ENODEV;
810}
811
812/**
813 * wdt_release - release a watchdog.
814 * @inode: inode to board
815 * @file: file handle to board
816 *
817 */
818static int wdt_release(struct inode *inode, struct file *file)
819{
820 if (iminor(inode) == WATCHDOG_MINOR)
821 clear_bit(0, &wdt_is_open);
822 return 0;
823}
824
825/**
826 * wdt_notify_sys - notify to watchdog.
827 * @this: our notifier block
828 * @code: the event being reported
829 * @unused: unused
830 *
831 * Our notifier is called on system shutdowns. We want to turn the card
832 * off at reboot otherwise the machine will reboot again during memory
833 * test or worse yet during the following fsck. This would suck, in fact
834 * trust me - if it happens it does suck.
835 */
836static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
837 void *unused)
838{
839 if (code == SYS_DOWN || code == SYS_HALT)
840 /* Disable Watchdog */
841 wdt_disable();
842 return NOTIFY_DONE;
843}
844
845static const struct file_operations wdt_fops = {
846 .owner = THIS_MODULE,
847 .read = wdt_read,
848 .unlocked_ioctl = wdt_unlocked_ioctl,
849 .compat_ioctl = compat_ptr_ioctl,
850 .write = wdt_write,
851 .open = wdt_open,
852 .release = wdt_release,
853 .llseek = no_llseek,
854};
855
856static struct miscdevice wdt_dev = {
857 .minor = WATCHDOG_MINOR,
858 .name = "watchdog",
859 .fops = &wdt_fops,
860};
861
862/*
863 * The WDT card needs to learn about soft shutdowns in order to
864 * turn the timebomb registers off.
865 */
866static struct notifier_block wdt_notifier = {
867 .notifier_call = wdt_notify_sys,
868};
869#endif /* CONFIG_RTC_DRV_M41T80_WDT */
870
871/*
872 *****************************************************************************
873 *
874 * Driver Interface
875 *
876 *****************************************************************************
877 */
878
879static int m41t80_probe(struct i2c_client *client)
880{
881 struct i2c_adapter *adapter = client->adapter;
882 int rc = 0;
883 struct rtc_time tm;
884 struct m41t80_data *m41t80_data = NULL;
885 bool wakeup_source = false;
886
887 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_I2C_BLOCK |
888 I2C_FUNC_SMBUS_BYTE_DATA)) {
889 dev_err(&adapter->dev, "doesn't support I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK\n");
890 return -ENODEV;
891 }
892
893 m41t80_data = devm_kzalloc(&client->dev, sizeof(*m41t80_data),
894 GFP_KERNEL);
895 if (!m41t80_data)
896 return -ENOMEM;
897
898 m41t80_data->client = client;
899 if (client->dev.of_node) {
900 m41t80_data->features = (unsigned long)
901 of_device_get_match_data(&client->dev);
902 } else {
903 const struct i2c_device_id *id = i2c_match_id(m41t80_id, client);
904 m41t80_data->features = id->driver_data;
905 }
906 i2c_set_clientdata(client, m41t80_data);
907
908 m41t80_data->rtc = devm_rtc_allocate_device(&client->dev);
909 if (IS_ERR(m41t80_data->rtc))
910 return PTR_ERR(m41t80_data->rtc);
911
912#ifdef CONFIG_OF
913 wakeup_source = of_property_read_bool(client->dev.of_node,
914 "wakeup-source");
915#endif
916 if (client->irq > 0) {
917 rc = devm_request_threaded_irq(&client->dev, client->irq,
918 NULL, m41t80_handle_irq,
919 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
920 "m41t80", client);
921 if (rc) {
922 dev_warn(&client->dev, "unable to request IRQ, alarms disabled\n");
923 client->irq = 0;
924 wakeup_source = false;
925 }
926 }
927 if (client->irq > 0 || wakeup_source)
928 device_init_wakeup(&client->dev, true);
929 else
930 clear_bit(RTC_FEATURE_ALARM, m41t80_data->rtc->features);
931
932 m41t80_data->rtc->ops = &m41t80_rtc_ops;
933 m41t80_data->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000;
934 m41t80_data->rtc->range_max = RTC_TIMESTAMP_END_2099;
935
936 if (client->irq <= 0)
937 clear_bit(RTC_FEATURE_UPDATE_INTERRUPT, m41t80_data->rtc->features);
938
939 /* Make sure HT (Halt Update) bit is cleared */
940 rc = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_HOUR);
941
942 if (rc >= 0 && rc & M41T80_ALHOUR_HT) {
943 if (m41t80_data->features & M41T80_FEATURE_HT) {
944 m41t80_rtc_read_time(&client->dev, &tm);
945 dev_info(&client->dev, "HT bit was set!\n");
946 dev_info(&client->dev, "Power Down at %ptR\n", &tm);
947 }
948 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_HOUR,
949 rc & ~M41T80_ALHOUR_HT);
950 }
951
952 if (rc < 0) {
953 dev_err(&client->dev, "Can't clear HT bit\n");
954 return rc;
955 }
956
957 /* Make sure ST (stop) bit is cleared */
958 rc = i2c_smbus_read_byte_data(client, M41T80_REG_SEC);
959
960 if (rc >= 0 && rc & M41T80_SEC_ST)
961 rc = i2c_smbus_write_byte_data(client, M41T80_REG_SEC,
962 rc & ~M41T80_SEC_ST);
963 if (rc < 0) {
964 dev_err(&client->dev, "Can't clear ST bit\n");
965 return rc;
966 }
967
968#ifdef CONFIG_RTC_DRV_M41T80_WDT
969 if (m41t80_data->features & M41T80_FEATURE_HT) {
970 save_client = client;
971 rc = misc_register(&wdt_dev);
972 if (rc)
973 return rc;
974 rc = register_reboot_notifier(&wdt_notifier);
975 if (rc) {
976 misc_deregister(&wdt_dev);
977 return rc;
978 }
979 }
980#endif
981#ifdef CONFIG_COMMON_CLK
982 if (m41t80_data->features & M41T80_FEATURE_SQ)
983 m41t80_sqw_register_clk(m41t80_data);
984#endif
985
986 rc = devm_rtc_register_device(m41t80_data->rtc);
987 if (rc)
988 return rc;
989
990 return 0;
991}
992
993static void m41t80_remove(struct i2c_client *client)
994{
995#ifdef CONFIG_RTC_DRV_M41T80_WDT
996 struct m41t80_data *clientdata = i2c_get_clientdata(client);
997
998 if (clientdata->features & M41T80_FEATURE_HT) {
999 misc_deregister(&wdt_dev);
1000 unregister_reboot_notifier(&wdt_notifier);
1001 }
1002#endif
1003}
1004
1005static struct i2c_driver m41t80_driver = {
1006 .driver = {
1007 .name = "rtc-m41t80",
1008 .of_match_table = of_match_ptr(m41t80_of_match),
1009 .pm = &m41t80_pm,
1010 },
1011 .probe_new = m41t80_probe,
1012 .remove = m41t80_remove,
1013 .id_table = m41t80_id,
1014};
1015
1016module_i2c_driver(m41t80_driver);
1017
1018MODULE_AUTHOR("Alexander Bigga <ab@mycable.de>");
1019MODULE_DESCRIPTION("ST Microelectronics M41T80 series RTC I2C Client Driver");
1020MODULE_LICENSE("GPL");
1/*
2 * I2C client/driver for the ST M41T80 family of i2c rtc chips.
3 *
4 * Author: Alexander Bigga <ab@mycable.de>
5 *
6 * Based on m41t00.c by Mark A. Greer <mgreer@mvista.com>
7 *
8 * 2006 (c) mycable GmbH
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13 *
14 */
15
16#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17
18#include <linux/bcd.h>
19#include <linux/i2c.h>
20#include <linux/init.h>
21#include <linux/kernel.h>
22#include <linux/module.h>
23#include <linux/rtc.h>
24#include <linux/slab.h>
25#include <linux/mutex.h>
26#include <linux/string.h>
27#ifdef CONFIG_RTC_DRV_M41T80_WDT
28#include <linux/fs.h>
29#include <linux/ioctl.h>
30#include <linux/miscdevice.h>
31#include <linux/reboot.h>
32#include <linux/watchdog.h>
33#endif
34
35#define M41T80_REG_SSEC 0x00
36#define M41T80_REG_SEC 0x01
37#define M41T80_REG_MIN 0x02
38#define M41T80_REG_HOUR 0x03
39#define M41T80_REG_WDAY 0x04
40#define M41T80_REG_DAY 0x05
41#define M41T80_REG_MON 0x06
42#define M41T80_REG_YEAR 0x07
43#define M41T80_REG_ALARM_MON 0x0a
44#define M41T80_REG_ALARM_DAY 0x0b
45#define M41T80_REG_ALARM_HOUR 0x0c
46#define M41T80_REG_ALARM_MIN 0x0d
47#define M41T80_REG_ALARM_SEC 0x0e
48#define M41T80_REG_FLAGS 0x0f
49#define M41T80_REG_SQW 0x13
50
51#define M41T80_DATETIME_REG_SIZE (M41T80_REG_YEAR + 1)
52#define M41T80_ALARM_REG_SIZE \
53 (M41T80_REG_ALARM_SEC + 1 - M41T80_REG_ALARM_MON)
54
55#define M41T80_SEC_ST BIT(7) /* ST: Stop Bit */
56#define M41T80_ALMON_AFE BIT(7) /* AFE: AF Enable Bit */
57#define M41T80_ALMON_SQWE BIT(6) /* SQWE: SQW Enable Bit */
58#define M41T80_ALHOUR_HT BIT(6) /* HT: Halt Update Bit */
59#define M41T80_FLAGS_OF BIT(2) /* OF: Oscillator Failure Bit */
60#define M41T80_FLAGS_AF BIT(6) /* AF: Alarm Flag Bit */
61#define M41T80_FLAGS_BATT_LOW BIT(4) /* BL: Battery Low Bit */
62#define M41T80_WATCHDOG_RB2 BIT(7) /* RB: Watchdog resolution */
63#define M41T80_WATCHDOG_RB1 BIT(1) /* RB: Watchdog resolution */
64#define M41T80_WATCHDOG_RB0 BIT(0) /* RB: Watchdog resolution */
65
66#define M41T80_FEATURE_HT BIT(0) /* Halt feature */
67#define M41T80_FEATURE_BL BIT(1) /* Battery low indicator */
68#define M41T80_FEATURE_SQ BIT(2) /* Squarewave feature */
69#define M41T80_FEATURE_WD BIT(3) /* Extra watchdog resolution */
70#define M41T80_FEATURE_SQ_ALT BIT(4) /* RSx bits are in reg 4 */
71
72static DEFINE_MUTEX(m41t80_rtc_mutex);
73static const struct i2c_device_id m41t80_id[] = {
74 { "m41t62", M41T80_FEATURE_SQ | M41T80_FEATURE_SQ_ALT },
75 { "m41t65", M41T80_FEATURE_HT | M41T80_FEATURE_WD },
76 { "m41t80", M41T80_FEATURE_SQ },
77 { "m41t81", M41T80_FEATURE_HT | M41T80_FEATURE_SQ},
78 { "m41t81s", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
79 { "m41t82", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
80 { "m41t83", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
81 { "m41st84", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
82 { "m41st85", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
83 { "m41st87", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
84 { "rv4162", M41T80_FEATURE_SQ | M41T80_FEATURE_WD | M41T80_FEATURE_SQ_ALT },
85 { }
86};
87MODULE_DEVICE_TABLE(i2c, m41t80_id);
88
89struct m41t80_data {
90 u8 features;
91 struct rtc_device *rtc;
92};
93
94static irqreturn_t m41t80_handle_irq(int irq, void *dev_id)
95{
96 struct i2c_client *client = dev_id;
97 struct m41t80_data *m41t80 = i2c_get_clientdata(client);
98 struct mutex *lock = &m41t80->rtc->ops_lock;
99 unsigned long events = 0;
100 int flags, flags_afe;
101
102 mutex_lock(lock);
103
104 flags_afe = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
105 if (flags_afe < 0) {
106 mutex_unlock(lock);
107 return IRQ_NONE;
108 }
109
110 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
111 if (flags <= 0) {
112 mutex_unlock(lock);
113 return IRQ_NONE;
114 }
115
116 if (flags & M41T80_FLAGS_AF) {
117 flags &= ~M41T80_FLAGS_AF;
118 flags_afe &= ~M41T80_ALMON_AFE;
119 events |= RTC_AF;
120 }
121
122 if (events) {
123 rtc_update_irq(m41t80->rtc, 1, events);
124 i2c_smbus_write_byte_data(client, M41T80_REG_FLAGS, flags);
125 i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
126 flags_afe);
127 }
128
129 mutex_unlock(lock);
130
131 return IRQ_HANDLED;
132}
133
134static int m41t80_get_datetime(struct i2c_client *client,
135 struct rtc_time *tm)
136{
137 unsigned char buf[8];
138 int err, flags;
139
140 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
141 if (flags < 0)
142 return flags;
143
144 if (flags & M41T80_FLAGS_OF) {
145 dev_err(&client->dev, "Oscillator failure, data is invalid.\n");
146 return -EINVAL;
147 }
148
149 err = i2c_smbus_read_i2c_block_data(client, M41T80_REG_SSEC,
150 sizeof(buf), buf);
151 if (err < 0) {
152 dev_err(&client->dev, "Unable to read date\n");
153 return -EIO;
154 }
155
156 tm->tm_sec = bcd2bin(buf[M41T80_REG_SEC] & 0x7f);
157 tm->tm_min = bcd2bin(buf[M41T80_REG_MIN] & 0x7f);
158 tm->tm_hour = bcd2bin(buf[M41T80_REG_HOUR] & 0x3f);
159 tm->tm_mday = bcd2bin(buf[M41T80_REG_DAY] & 0x3f);
160 tm->tm_wday = buf[M41T80_REG_WDAY] & 0x07;
161 tm->tm_mon = bcd2bin(buf[M41T80_REG_MON] & 0x1f) - 1;
162
163 /* assume 20YY not 19YY, and ignore the Century Bit */
164 tm->tm_year = bcd2bin(buf[M41T80_REG_YEAR]) + 100;
165 return rtc_valid_tm(tm);
166}
167
168/* Sets the given date and time to the real time clock. */
169static int m41t80_set_datetime(struct i2c_client *client, struct rtc_time *tm)
170{
171 unsigned char buf[8];
172 int err, flags;
173
174 if (tm->tm_year < 100 || tm->tm_year > 199)
175 return -EINVAL;
176
177 buf[M41T80_REG_SSEC] = 0;
178 buf[M41T80_REG_SEC] = bin2bcd(tm->tm_sec);
179 buf[M41T80_REG_MIN] = bin2bcd(tm->tm_min);
180 buf[M41T80_REG_HOUR] = bin2bcd(tm->tm_hour);
181 buf[M41T80_REG_DAY] = bin2bcd(tm->tm_mday);
182 buf[M41T80_REG_MON] = bin2bcd(tm->tm_mon + 1);
183 buf[M41T80_REG_YEAR] = bin2bcd(tm->tm_year - 100);
184 buf[M41T80_REG_WDAY] = tm->tm_wday;
185
186 err = i2c_smbus_write_i2c_block_data(client, M41T80_REG_SSEC,
187 sizeof(buf), buf);
188 if (err < 0) {
189 dev_err(&client->dev, "Unable to write to date registers\n");
190 return err;
191 }
192
193 /* Clear the OF bit of Flags Register */
194 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
195 if (flags < 0)
196 return flags;
197
198 if (i2c_smbus_write_byte_data(client, M41T80_REG_FLAGS,
199 flags & ~M41T80_FLAGS_OF)) {
200 dev_err(&client->dev, "Unable to write flags register\n");
201 return -EIO;
202 }
203
204 return err;
205}
206
207static int m41t80_rtc_proc(struct device *dev, struct seq_file *seq)
208{
209 struct i2c_client *client = to_i2c_client(dev);
210 struct m41t80_data *clientdata = i2c_get_clientdata(client);
211 u8 reg;
212
213 if (clientdata->features & M41T80_FEATURE_BL) {
214 reg = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
215 seq_printf(seq, "battery\t\t: %s\n",
216 (reg & M41T80_FLAGS_BATT_LOW) ? "exhausted" : "ok");
217 }
218 return 0;
219}
220
221static int m41t80_rtc_read_time(struct device *dev, struct rtc_time *tm)
222{
223 return m41t80_get_datetime(to_i2c_client(dev), tm);
224}
225
226static int m41t80_rtc_set_time(struct device *dev, struct rtc_time *tm)
227{
228 return m41t80_set_datetime(to_i2c_client(dev), tm);
229}
230
231static int m41t80_alarm_irq_enable(struct device *dev, unsigned int enabled)
232{
233 struct i2c_client *client = to_i2c_client(dev);
234 int flags, retval;
235
236 flags = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
237 if (flags < 0)
238 return flags;
239
240 if (enabled)
241 flags |= M41T80_ALMON_AFE;
242 else
243 flags &= ~M41T80_ALMON_AFE;
244
245 retval = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON, flags);
246 if (retval < 0) {
247 dev_err(dev, "Unable to enable alarm IRQ %d\n", retval);
248 return retval;
249 }
250 return 0;
251}
252
253static int m41t80_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
254{
255 struct i2c_client *client = to_i2c_client(dev);
256 u8 alarmvals[5];
257 int ret, err;
258
259 alarmvals[0] = bin2bcd(alrm->time.tm_mon + 1);
260 alarmvals[1] = bin2bcd(alrm->time.tm_mday);
261 alarmvals[2] = bin2bcd(alrm->time.tm_hour);
262 alarmvals[3] = bin2bcd(alrm->time.tm_min);
263 alarmvals[4] = bin2bcd(alrm->time.tm_sec);
264
265 /* Clear AF and AFE flags */
266 ret = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
267 if (ret < 0)
268 return ret;
269 err = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
270 ret & ~(M41T80_ALMON_AFE));
271 if (err < 0) {
272 dev_err(dev, "Unable to clear AFE bit\n");
273 return err;
274 }
275
276 ret = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
277 if (ret < 0)
278 return ret;
279
280 err = i2c_smbus_write_byte_data(client, M41T80_REG_FLAGS,
281 ret & ~(M41T80_FLAGS_AF));
282 if (err < 0) {
283 dev_err(dev, "Unable to clear AF bit\n");
284 return err;
285 }
286
287 /* Write the alarm */
288 err = i2c_smbus_write_i2c_block_data(client, M41T80_REG_ALARM_MON,
289 5, alarmvals);
290 if (err)
291 return err;
292
293 /* Enable the alarm interrupt */
294 if (alrm->enabled) {
295 alarmvals[0] |= M41T80_ALMON_AFE;
296 err = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
297 alarmvals[0]);
298 if (err)
299 return err;
300 }
301
302 return 0;
303}
304
305static int m41t80_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
306{
307 struct i2c_client *client = to_i2c_client(dev);
308 u8 alarmvals[5];
309 int flags, ret;
310
311 ret = i2c_smbus_read_i2c_block_data(client, M41T80_REG_ALARM_MON,
312 5, alarmvals);
313 if (ret != 5)
314 return ret < 0 ? ret : -EIO;
315
316 flags = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
317 if (flags < 0)
318 return flags;
319
320 alrm->time.tm_sec = bcd2bin(alarmvals[4] & 0x7f);
321 alrm->time.tm_min = bcd2bin(alarmvals[3] & 0x7f);
322 alrm->time.tm_hour = bcd2bin(alarmvals[2] & 0x3f);
323 alrm->time.tm_mday = bcd2bin(alarmvals[1] & 0x3f);
324 alrm->time.tm_mon = bcd2bin(alarmvals[0] & 0x3f);
325
326 alrm->enabled = !!(alarmvals[0] & M41T80_ALMON_AFE);
327 alrm->pending = (flags & M41T80_FLAGS_AF) && alrm->enabled;
328
329 return 0;
330}
331
332static struct rtc_class_ops m41t80_rtc_ops = {
333 .read_time = m41t80_rtc_read_time,
334 .set_time = m41t80_rtc_set_time,
335 .proc = m41t80_rtc_proc,
336};
337
338#ifdef CONFIG_PM_SLEEP
339static int m41t80_suspend(struct device *dev)
340{
341 struct i2c_client *client = to_i2c_client(dev);
342
343 if (client->irq >= 0 && device_may_wakeup(dev))
344 enable_irq_wake(client->irq);
345
346 return 0;
347}
348
349static int m41t80_resume(struct device *dev)
350{
351 struct i2c_client *client = to_i2c_client(dev);
352
353 if (client->irq >= 0 && device_may_wakeup(dev))
354 disable_irq_wake(client->irq);
355
356 return 0;
357}
358#endif
359
360static SIMPLE_DEV_PM_OPS(m41t80_pm, m41t80_suspend, m41t80_resume);
361
362static ssize_t flags_show(struct device *dev,
363 struct device_attribute *attr, char *buf)
364{
365 struct i2c_client *client = to_i2c_client(dev);
366 int val;
367
368 val = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
369 if (val < 0)
370 return val;
371 return sprintf(buf, "%#x\n", val);
372}
373static DEVICE_ATTR_RO(flags);
374
375static ssize_t sqwfreq_show(struct device *dev,
376 struct device_attribute *attr, char *buf)
377{
378 struct i2c_client *client = to_i2c_client(dev);
379 struct m41t80_data *clientdata = i2c_get_clientdata(client);
380 int val, reg_sqw;
381
382 if (!(clientdata->features & M41T80_FEATURE_SQ))
383 return -EINVAL;
384
385 reg_sqw = M41T80_REG_SQW;
386 if (clientdata->features & M41T80_FEATURE_SQ_ALT)
387 reg_sqw = M41T80_REG_WDAY;
388 val = i2c_smbus_read_byte_data(client, reg_sqw);
389 if (val < 0)
390 return val;
391 val = (val >> 4) & 0xf;
392 switch (val) {
393 case 0:
394 break;
395 case 1:
396 val = 32768;
397 break;
398 default:
399 val = 32768 >> val;
400 }
401 return sprintf(buf, "%d\n", val);
402}
403
404static ssize_t sqwfreq_store(struct device *dev,
405 struct device_attribute *attr,
406 const char *buf, size_t count)
407{
408 struct i2c_client *client = to_i2c_client(dev);
409 struct m41t80_data *clientdata = i2c_get_clientdata(client);
410 int almon, sqw, reg_sqw, rc;
411 unsigned long val;
412
413 rc = kstrtoul(buf, 0, &val);
414 if (rc < 0)
415 return rc;
416
417 if (!(clientdata->features & M41T80_FEATURE_SQ))
418 return -EINVAL;
419
420 if (val) {
421 if (!is_power_of_2(val))
422 return -EINVAL;
423 val = ilog2(val);
424 if (val == 15)
425 val = 1;
426 else if (val < 14)
427 val = 15 - val;
428 else
429 return -EINVAL;
430 }
431 /* disable SQW, set SQW frequency & re-enable */
432 almon = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
433 if (almon < 0)
434 return almon;
435 reg_sqw = M41T80_REG_SQW;
436 if (clientdata->features & M41T80_FEATURE_SQ_ALT)
437 reg_sqw = M41T80_REG_WDAY;
438 sqw = i2c_smbus_read_byte_data(client, reg_sqw);
439 if (sqw < 0)
440 return sqw;
441 sqw = (sqw & 0x0f) | (val << 4);
442
443 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
444 almon & ~M41T80_ALMON_SQWE);
445 if (rc < 0)
446 return rc;
447
448 if (val) {
449 rc = i2c_smbus_write_byte_data(client, reg_sqw, sqw);
450 if (rc < 0)
451 return rc;
452
453 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
454 almon | M41T80_ALMON_SQWE);
455 if (rc < 0)
456 return rc;
457 }
458 return count;
459}
460static DEVICE_ATTR_RW(sqwfreq);
461
462static struct attribute *attrs[] = {
463 &dev_attr_flags.attr,
464 &dev_attr_sqwfreq.attr,
465 NULL,
466};
467
468static struct attribute_group attr_group = {
469 .attrs = attrs,
470};
471
472#ifdef CONFIG_RTC_DRV_M41T80_WDT
473/*
474 *****************************************************************************
475 *
476 * Watchdog Driver
477 *
478 *****************************************************************************
479 */
480static struct i2c_client *save_client;
481
482/* Default margin */
483#define WD_TIMO 60 /* 1..31 seconds */
484
485static int wdt_margin = WD_TIMO;
486module_param(wdt_margin, int, 0);
487MODULE_PARM_DESC(wdt_margin, "Watchdog timeout in seconds (default 60s)");
488
489static unsigned long wdt_is_open;
490static int boot_flag;
491
492/**
493 * wdt_ping:
494 *
495 * Reload counter one with the watchdog timeout. We don't bother reloading
496 * the cascade counter.
497 */
498static void wdt_ping(void)
499{
500 unsigned char i2c_data[2];
501 struct i2c_msg msgs1[1] = {
502 {
503 .addr = save_client->addr,
504 .flags = 0,
505 .len = 2,
506 .buf = i2c_data,
507 },
508 };
509 struct m41t80_data *clientdata = i2c_get_clientdata(save_client);
510
511 i2c_data[0] = 0x09; /* watchdog register */
512
513 if (wdt_margin > 31)
514 i2c_data[1] = (wdt_margin & 0xFC) | 0x83; /* resolution = 4s */
515 else
516 /*
517 * WDS = 1 (0x80), mulitplier = WD_TIMO, resolution = 1s (0x02)
518 */
519 i2c_data[1] = wdt_margin << 2 | 0x82;
520
521 /*
522 * M41T65 has three bits for watchdog resolution. Don't set bit 7, as
523 * that would be an invalid resolution.
524 */
525 if (clientdata->features & M41T80_FEATURE_WD)
526 i2c_data[1] &= ~M41T80_WATCHDOG_RB2;
527
528 i2c_transfer(save_client->adapter, msgs1, 1);
529}
530
531/**
532 * wdt_disable:
533 *
534 * disables watchdog.
535 */
536static void wdt_disable(void)
537{
538 unsigned char i2c_data[2], i2c_buf[0x10];
539 struct i2c_msg msgs0[2] = {
540 {
541 .addr = save_client->addr,
542 .flags = 0,
543 .len = 1,
544 .buf = i2c_data,
545 },
546 {
547 .addr = save_client->addr,
548 .flags = I2C_M_RD,
549 .len = 1,
550 .buf = i2c_buf,
551 },
552 };
553 struct i2c_msg msgs1[1] = {
554 {
555 .addr = save_client->addr,
556 .flags = 0,
557 .len = 2,
558 .buf = i2c_data,
559 },
560 };
561
562 i2c_data[0] = 0x09;
563 i2c_transfer(save_client->adapter, msgs0, 2);
564
565 i2c_data[0] = 0x09;
566 i2c_data[1] = 0x00;
567 i2c_transfer(save_client->adapter, msgs1, 1);
568}
569
570/**
571 * wdt_write:
572 * @file: file handle to the watchdog
573 * @buf: buffer to write (unused as data does not matter here
574 * @count: count of bytes
575 * @ppos: pointer to the position to write. No seeks allowed
576 *
577 * A write to a watchdog device is defined as a keepalive signal. Any
578 * write of data will do, as we we don't define content meaning.
579 */
580static ssize_t wdt_write(struct file *file, const char __user *buf,
581 size_t count, loff_t *ppos)
582{
583 if (count) {
584 wdt_ping();
585 return 1;
586 }
587 return 0;
588}
589
590static ssize_t wdt_read(struct file *file, char __user *buf,
591 size_t count, loff_t *ppos)
592{
593 return 0;
594}
595
596/**
597 * wdt_ioctl:
598 * @inode: inode of the device
599 * @file: file handle to the device
600 * @cmd: watchdog command
601 * @arg: argument pointer
602 *
603 * The watchdog API defines a common set of functions for all watchdogs
604 * according to their available features. We only actually usefully support
605 * querying capabilities and current status.
606 */
607static int wdt_ioctl(struct file *file, unsigned int cmd,
608 unsigned long arg)
609{
610 int new_margin, rv;
611 static struct watchdog_info ident = {
612 .options = WDIOF_POWERUNDER | WDIOF_KEEPALIVEPING |
613 WDIOF_SETTIMEOUT,
614 .firmware_version = 1,
615 .identity = "M41T80 WTD"
616 };
617
618 switch (cmd) {
619 case WDIOC_GETSUPPORT:
620 return copy_to_user((struct watchdog_info __user *)arg, &ident,
621 sizeof(ident)) ? -EFAULT : 0;
622
623 case WDIOC_GETSTATUS:
624 case WDIOC_GETBOOTSTATUS:
625 return put_user(boot_flag, (int __user *)arg);
626 case WDIOC_KEEPALIVE:
627 wdt_ping();
628 return 0;
629 case WDIOC_SETTIMEOUT:
630 if (get_user(new_margin, (int __user *)arg))
631 return -EFAULT;
632 /* Arbitrary, can't find the card's limits */
633 if (new_margin < 1 || new_margin > 124)
634 return -EINVAL;
635 wdt_margin = new_margin;
636 wdt_ping();
637 /* Fall */
638 case WDIOC_GETTIMEOUT:
639 return put_user(wdt_margin, (int __user *)arg);
640
641 case WDIOC_SETOPTIONS:
642 if (copy_from_user(&rv, (int __user *)arg, sizeof(int)))
643 return -EFAULT;
644
645 if (rv & WDIOS_DISABLECARD) {
646 pr_info("disable watchdog\n");
647 wdt_disable();
648 }
649
650 if (rv & WDIOS_ENABLECARD) {
651 pr_info("enable watchdog\n");
652 wdt_ping();
653 }
654
655 return -EINVAL;
656 }
657 return -ENOTTY;
658}
659
660static long wdt_unlocked_ioctl(struct file *file, unsigned int cmd,
661 unsigned long arg)
662{
663 int ret;
664
665 mutex_lock(&m41t80_rtc_mutex);
666 ret = wdt_ioctl(file, cmd, arg);
667 mutex_unlock(&m41t80_rtc_mutex);
668
669 return ret;
670}
671
672/**
673 * wdt_open:
674 * @inode: inode of device
675 * @file: file handle to device
676 *
677 */
678static int wdt_open(struct inode *inode, struct file *file)
679{
680 if (MINOR(inode->i_rdev) == WATCHDOG_MINOR) {
681 mutex_lock(&m41t80_rtc_mutex);
682 if (test_and_set_bit(0, &wdt_is_open)) {
683 mutex_unlock(&m41t80_rtc_mutex);
684 return -EBUSY;
685 }
686 /*
687 * Activate
688 */
689 wdt_is_open = 1;
690 mutex_unlock(&m41t80_rtc_mutex);
691 return nonseekable_open(inode, file);
692 }
693 return -ENODEV;
694}
695
696/**
697 * wdt_close:
698 * @inode: inode to board
699 * @file: file handle to board
700 *
701 */
702static int wdt_release(struct inode *inode, struct file *file)
703{
704 if (MINOR(inode->i_rdev) == WATCHDOG_MINOR)
705 clear_bit(0, &wdt_is_open);
706 return 0;
707}
708
709/**
710 * notify_sys:
711 * @this: our notifier block
712 * @code: the event being reported
713 * @unused: unused
714 *
715 * Our notifier is called on system shutdowns. We want to turn the card
716 * off at reboot otherwise the machine will reboot again during memory
717 * test or worse yet during the following fsck. This would suck, in fact
718 * trust me - if it happens it does suck.
719 */
720static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
721 void *unused)
722{
723 if (code == SYS_DOWN || code == SYS_HALT)
724 /* Disable Watchdog */
725 wdt_disable();
726 return NOTIFY_DONE;
727}
728
729static const struct file_operations wdt_fops = {
730 .owner = THIS_MODULE,
731 .read = wdt_read,
732 .unlocked_ioctl = wdt_unlocked_ioctl,
733 .write = wdt_write,
734 .open = wdt_open,
735 .release = wdt_release,
736 .llseek = no_llseek,
737};
738
739static struct miscdevice wdt_dev = {
740 .minor = WATCHDOG_MINOR,
741 .name = "watchdog",
742 .fops = &wdt_fops,
743};
744
745/*
746 * The WDT card needs to learn about soft shutdowns in order to
747 * turn the timebomb registers off.
748 */
749static struct notifier_block wdt_notifier = {
750 .notifier_call = wdt_notify_sys,
751};
752#endif /* CONFIG_RTC_DRV_M41T80_WDT */
753
754/*
755 *****************************************************************************
756 *
757 * Driver Interface
758 *
759 *****************************************************************************
760 */
761
762static void m41t80_remove_sysfs_group(void *_dev)
763{
764 struct device *dev = _dev;
765
766 sysfs_remove_group(&dev->kobj, &attr_group);
767}
768
769static int m41t80_probe(struct i2c_client *client,
770 const struct i2c_device_id *id)
771{
772 struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
773 int rc = 0;
774 struct rtc_device *rtc = NULL;
775 struct rtc_time tm;
776 struct m41t80_data *m41t80_data = NULL;
777
778 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_I2C_BLOCK |
779 I2C_FUNC_SMBUS_BYTE_DATA)) {
780 dev_err(&adapter->dev, "doesn't support I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_I2C_BLOCK\n");
781 return -ENODEV;
782 }
783
784 m41t80_data = devm_kzalloc(&client->dev, sizeof(*m41t80_data),
785 GFP_KERNEL);
786 if (!m41t80_data)
787 return -ENOMEM;
788
789 m41t80_data->features = id->driver_data;
790 i2c_set_clientdata(client, m41t80_data);
791
792 if (client->irq > 0) {
793 rc = devm_request_threaded_irq(&client->dev, client->irq,
794 NULL, m41t80_handle_irq,
795 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
796 "m41t80", client);
797 if (rc) {
798 dev_warn(&client->dev, "unable to request IRQ, alarms disabled\n");
799 client->irq = 0;
800 } else {
801 m41t80_rtc_ops.read_alarm = m41t80_read_alarm;
802 m41t80_rtc_ops.set_alarm = m41t80_set_alarm;
803 m41t80_rtc_ops.alarm_irq_enable = m41t80_alarm_irq_enable;
804 /* Enable the wakealarm */
805 device_init_wakeup(&client->dev, true);
806 }
807 }
808
809 rtc = devm_rtc_device_register(&client->dev, client->name,
810 &m41t80_rtc_ops, THIS_MODULE);
811 if (IS_ERR(rtc))
812 return PTR_ERR(rtc);
813
814 m41t80_data->rtc = rtc;
815
816 /* Make sure HT (Halt Update) bit is cleared */
817 rc = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_HOUR);
818
819 if (rc >= 0 && rc & M41T80_ALHOUR_HT) {
820 if (m41t80_data->features & M41T80_FEATURE_HT) {
821 m41t80_get_datetime(client, &tm);
822 dev_info(&client->dev, "HT bit was set!\n");
823 dev_info(&client->dev,
824 "Power Down at %04i-%02i-%02i %02i:%02i:%02i\n",
825 tm.tm_year + 1900,
826 tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
827 tm.tm_min, tm.tm_sec);
828 }
829 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_HOUR,
830 rc & ~M41T80_ALHOUR_HT);
831 }
832
833 if (rc < 0) {
834 dev_err(&client->dev, "Can't clear HT bit\n");
835 return rc;
836 }
837
838 /* Make sure ST (stop) bit is cleared */
839 rc = i2c_smbus_read_byte_data(client, M41T80_REG_SEC);
840
841 if (rc >= 0 && rc & M41T80_SEC_ST)
842 rc = i2c_smbus_write_byte_data(client, M41T80_REG_SEC,
843 rc & ~M41T80_SEC_ST);
844 if (rc < 0) {
845 dev_err(&client->dev, "Can't clear ST bit\n");
846 return rc;
847 }
848
849 /* Export sysfs entries */
850 rc = sysfs_create_group(&(&client->dev)->kobj, &attr_group);
851 if (rc) {
852 dev_err(&client->dev, "Failed to create sysfs group: %d\n", rc);
853 return rc;
854 }
855
856 rc = devm_add_action_or_reset(&client->dev, m41t80_remove_sysfs_group,
857 &client->dev);
858 if (rc) {
859 dev_err(&client->dev,
860 "Failed to add sysfs cleanup action: %d\n", rc);
861 return rc;
862 }
863
864#ifdef CONFIG_RTC_DRV_M41T80_WDT
865 if (m41t80_data->features & M41T80_FEATURE_HT) {
866 save_client = client;
867 rc = misc_register(&wdt_dev);
868 if (rc)
869 return rc;
870 rc = register_reboot_notifier(&wdt_notifier);
871 if (rc) {
872 misc_deregister(&wdt_dev);
873 return rc;
874 }
875 }
876#endif
877 return 0;
878}
879
880static int m41t80_remove(struct i2c_client *client)
881{
882#ifdef CONFIG_RTC_DRV_M41T80_WDT
883 struct m41t80_data *clientdata = i2c_get_clientdata(client);
884
885 if (clientdata->features & M41T80_FEATURE_HT) {
886 misc_deregister(&wdt_dev);
887 unregister_reboot_notifier(&wdt_notifier);
888 }
889#endif
890
891 return 0;
892}
893
894static struct i2c_driver m41t80_driver = {
895 .driver = {
896 .name = "rtc-m41t80",
897 .pm = &m41t80_pm,
898 },
899 .probe = m41t80_probe,
900 .remove = m41t80_remove,
901 .id_table = m41t80_id,
902};
903
904module_i2c_driver(m41t80_driver);
905
906MODULE_AUTHOR("Alexander Bigga <ab@mycable.de>");
907MODULE_DESCRIPTION("ST Microelectronics M41T80 series RTC I2C Client Driver");
908MODULE_LICENSE("GPL");