blob: 27217898abe1e263c10b2ce334170f6478b9fba2 [file] [log] [blame]
Atsushi Nemotocaaff562007-07-17 04:05:02 -07001/*
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
Joe Perchesa737e832015-04-16 12:46:14 -070016#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17
Maciej W. Rozycki35aa64f2008-07-23 21:30:29 -070018#include <linux/bcd.h>
19#include <linux/i2c.h>
Atsushi Nemotocaaff562007-07-17 04:05:02 -070020#include <linux/init.h>
Maciej W. Rozycki9fb1f682008-05-12 14:02:38 -070021#include <linux/kernel.h>
Maciej W. Rozycki35aa64f2008-07-23 21:30:29 -070022#include <linux/module.h>
23#include <linux/rtc.h>
Atsushi Nemotocaaff562007-07-17 04:05:02 -070024#include <linux/slab.h>
Arnd Bergmann613655f2010-06-02 14:28:52 +020025#include <linux/mutex.h>
Atsushi Nemotocaaff562007-07-17 04:05:02 -070026#include <linux/string.h>
Atsushi Nemoto617780d2007-07-17 04:05:04 -070027#ifdef CONFIG_RTC_DRV_M41T80_WDT
Atsushi Nemoto617780d2007-07-17 04:05:04 -070028#include <linux/fs.h>
29#include <linux/ioctl.h>
Maciej W. Rozycki35aa64f2008-07-23 21:30:29 -070030#include <linux/miscdevice.h>
31#include <linux/reboot.h>
32#include <linux/watchdog.h>
Atsushi Nemoto617780d2007-07-17 04:05:04 -070033#endif
Atsushi Nemotocaaff562007-07-17 04:05:02 -070034
35#define M41T80_REG_SSEC 0
36#define M41T80_REG_SEC 1
37#define M41T80_REG_MIN 2
38#define M41T80_REG_HOUR 3
39#define M41T80_REG_WDAY 4
40#define M41T80_REG_DAY 5
41#define M41T80_REG_MON 6
42#define M41T80_REG_YEAR 7
43#define M41T80_REG_ALARM_MON 0xa
44#define M41T80_REG_ALARM_DAY 0xb
45#define M41T80_REG_ALARM_HOUR 0xc
46#define M41T80_REG_ALARM_MIN 0xd
47#define M41T80_REG_ALARM_SEC 0xe
48#define M41T80_REG_FLAGS 0xf
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 (1 << 7) /* ST: Stop Bit */
56#define M41T80_ALMON_AFE (1 << 7) /* AFE: AF Enable Bit */
57#define M41T80_ALMON_SQWE (1 << 6) /* SQWE: SQW Enable Bit */
58#define M41T80_ALHOUR_HT (1 << 6) /* HT: Halt Update Bit */
59#define M41T80_FLAGS_AF (1 << 6) /* AF: Alarm Flag Bit */
60#define M41T80_FLAGS_BATT_LOW (1 << 4) /* BL: Battery Low Bit */
Steven A. Falcod3a126f2008-10-15 22:03:07 -070061#define M41T80_WATCHDOG_RB2 (1 << 7) /* RB: Watchdog resolution */
62#define M41T80_WATCHDOG_RB1 (1 << 1) /* RB: Watchdog resolution */
63#define M41T80_WATCHDOG_RB0 (1 << 0) /* RB: Watchdog resolution */
Atsushi Nemotocaaff562007-07-17 04:05:02 -070064
Steven A. Falcod3a126f2008-10-15 22:03:07 -070065#define M41T80_FEATURE_HT (1 << 0) /* Halt feature */
66#define M41T80_FEATURE_BL (1 << 1) /* Battery low indicator */
67#define M41T80_FEATURE_SQ (1 << 2) /* Squarewave feature */
68#define M41T80_FEATURE_WD (1 << 3) /* Extra watchdog resolution */
Daniel Glocknerf30281f2009-04-02 16:57:03 -070069#define M41T80_FEATURE_SQ_ALT (1 << 4) /* RSx bits are in reg 4 */
Atsushi Nemotocaaff562007-07-17 04:05:02 -070070
Arnd Bergmann613655f2010-06-02 14:28:52 +020071static DEFINE_MUTEX(m41t80_rtc_mutex);
Jean Delvare3760f732008-04-29 23:11:40 +020072static const struct i2c_device_id m41t80_id[] = {
Daniel Glocknerf30281f2009-04-02 16:57:03 -070073 { "m41t62", M41T80_FEATURE_SQ | M41T80_FEATURE_SQ_ALT },
Steven A. Falcod3a126f2008-10-15 22:03:07 -070074 { "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 },
Wolfram Sang6b1a5232014-06-06 14:35:47 -070083 { "rv4162", M41T80_FEATURE_SQ | M41T80_FEATURE_WD | M41T80_FEATURE_SQ_ALT },
Jean Delvare3760f732008-04-29 23:11:40 +020084 { }
Atsushi Nemotocaaff562007-07-17 04:05:02 -070085};
Jean Delvare3760f732008-04-29 23:11:40 +020086MODULE_DEVICE_TABLE(i2c, m41t80_id);
Atsushi Nemotocaaff562007-07-17 04:05:02 -070087
88struct m41t80_data {
Jean Delvare3760f732008-04-29 23:11:40 +020089 u8 features;
Atsushi Nemotocaaff562007-07-17 04:05:02 -070090 struct rtc_device *rtc;
91};
92
93static int m41t80_get_datetime(struct i2c_client *client,
94 struct rtc_time *tm)
95{
96 u8 buf[M41T80_DATETIME_REG_SIZE], dt_addr[1] = { M41T80_REG_SEC };
97 struct i2c_msg msgs[] = {
98 {
99 .addr = client->addr,
100 .flags = 0,
101 .len = 1,
102 .buf = dt_addr,
103 },
104 {
105 .addr = client->addr,
106 .flags = I2C_M_RD,
107 .len = M41T80_DATETIME_REG_SIZE - M41T80_REG_SEC,
108 .buf = buf + M41T80_REG_SEC,
109 },
110 };
111
112 if (i2c_transfer(client->adapter, msgs, 2) < 0) {
113 dev_err(&client->dev, "read error\n");
114 return -EIO;
115 }
116
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700117 tm->tm_sec = bcd2bin(buf[M41T80_REG_SEC] & 0x7f);
118 tm->tm_min = bcd2bin(buf[M41T80_REG_MIN] & 0x7f);
119 tm->tm_hour = bcd2bin(buf[M41T80_REG_HOUR] & 0x3f);
120 tm->tm_mday = bcd2bin(buf[M41T80_REG_DAY] & 0x3f);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700121 tm->tm_wday = buf[M41T80_REG_WDAY] & 0x07;
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700122 tm->tm_mon = bcd2bin(buf[M41T80_REG_MON] & 0x1f) - 1;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700123
124 /* assume 20YY not 19YY, and ignore the Century Bit */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700125 tm->tm_year = bcd2bin(buf[M41T80_REG_YEAR]) + 100;
Wan ZongShunb485fe52010-08-10 18:02:15 -0700126 return rtc_valid_tm(tm);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700127}
128
129/* Sets the given date and time to the real time clock. */
130static int m41t80_set_datetime(struct i2c_client *client, struct rtc_time *tm)
131{
132 u8 wbuf[1 + M41T80_DATETIME_REG_SIZE];
133 u8 *buf = &wbuf[1];
134 u8 dt_addr[1] = { M41T80_REG_SEC };
135 struct i2c_msg msgs_in[] = {
136 {
137 .addr = client->addr,
138 .flags = 0,
139 .len = 1,
140 .buf = dt_addr,
141 },
142 {
143 .addr = client->addr,
144 .flags = I2C_M_RD,
145 .len = M41T80_DATETIME_REG_SIZE - M41T80_REG_SEC,
146 .buf = buf + M41T80_REG_SEC,
147 },
148 };
149 struct i2c_msg msgs[] = {
150 {
151 .addr = client->addr,
152 .flags = 0,
153 .len = 1 + M41T80_DATETIME_REG_SIZE,
154 .buf = wbuf,
155 },
156 };
157
158 /* Read current reg values into buf[1..7] */
159 if (i2c_transfer(client->adapter, msgs_in, 2) < 0) {
160 dev_err(&client->dev, "read error\n");
161 return -EIO;
162 }
163
164 wbuf[0] = 0; /* offset into rtc's regs */
165 /* Merge time-data and register flags into buf[0..7] */
166 buf[M41T80_REG_SSEC] = 0;
167 buf[M41T80_REG_SEC] =
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700168 bin2bcd(tm->tm_sec) | (buf[M41T80_REG_SEC] & ~0x7f);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700169 buf[M41T80_REG_MIN] =
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700170 bin2bcd(tm->tm_min) | (buf[M41T80_REG_MIN] & ~0x7f);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700171 buf[M41T80_REG_HOUR] =
Sachin Kamate46527d2013-07-03 15:05:52 -0700172 bin2bcd(tm->tm_hour) | (buf[M41T80_REG_HOUR] & ~0x3f);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700173 buf[M41T80_REG_WDAY] =
174 (tm->tm_wday & 0x07) | (buf[M41T80_REG_WDAY] & ~0x07);
175 buf[M41T80_REG_DAY] =
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700176 bin2bcd(tm->tm_mday) | (buf[M41T80_REG_DAY] & ~0x3f);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700177 buf[M41T80_REG_MON] =
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700178 bin2bcd(tm->tm_mon + 1) | (buf[M41T80_REG_MON] & ~0x1f);
Stefan Christbcebd812016-03-15 14:22:26 +0100179
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700180 /* assume 20YY not 19YY */
Stefan Christbcebd812016-03-15 14:22:26 +0100181 if (tm->tm_year < 100 || tm->tm_year > 199) {
182 dev_err(&client->dev, "Year must be between 2000 and 2099. It's %d.\n",
183 tm->tm_year + 1900);
184 return -EINVAL;
185 }
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700186 buf[M41T80_REG_YEAR] = bin2bcd(tm->tm_year % 100);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700187
188 if (i2c_transfer(client->adapter, msgs, 1) != 1) {
189 dev_err(&client->dev, "write error\n");
190 return -EIO;
191 }
192 return 0;
193}
194
195#if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
196static int m41t80_rtc_proc(struct device *dev, struct seq_file *seq)
197{
198 struct i2c_client *client = to_i2c_client(dev);
199 struct m41t80_data *clientdata = i2c_get_clientdata(client);
200 u8 reg;
201
Jean Delvare3760f732008-04-29 23:11:40 +0200202 if (clientdata->features & M41T80_FEATURE_BL) {
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700203 reg = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
204 seq_printf(seq, "battery\t\t: %s\n",
205 (reg & M41T80_FLAGS_BATT_LOW) ? "exhausted" : "ok");
206 }
207 return 0;
208}
209#else
210#define m41t80_rtc_proc NULL
211#endif
212
213static int m41t80_rtc_read_time(struct device *dev, struct rtc_time *tm)
214{
215 return m41t80_get_datetime(to_i2c_client(dev), tm);
216}
217
218static int m41t80_rtc_set_time(struct device *dev, struct rtc_time *tm)
219{
220 return m41t80_set_datetime(to_i2c_client(dev), tm);
221}
222
Paul Bolle48e97662012-10-04 17:14:35 -0700223/*
224 * XXX - m41t80 alarm functionality is reported broken.
225 * until it is fixed, don't register alarm functions.
226 */
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700227static struct rtc_class_ops m41t80_rtc_ops = {
228 .read_time = m41t80_rtc_read_time,
229 .set_time = m41t80_rtc_set_time,
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700230 .proc = m41t80_rtc_proc,
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700231};
232
Mylène Josserandef6b3122016-03-29 08:55:58 +0200233static ssize_t flags_show(struct device *dev,
234 struct device_attribute *attr, char *buf)
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700235{
236 struct i2c_client *client = to_i2c_client(dev);
237 int val;
238
239 val = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
240 if (val < 0)
Wolfram Sang85d77042014-06-06 14:35:46 -0700241 return val;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700242 return sprintf(buf, "%#x\n", val);
243}
Mylène Josserandef6b3122016-03-29 08:55:58 +0200244static DEVICE_ATTR_RO(flags);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700245
Mylène Josserandef6b3122016-03-29 08:55:58 +0200246static ssize_t sqwfreq_show(struct device *dev,
247 struct device_attribute *attr, char *buf)
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700248{
249 struct i2c_client *client = to_i2c_client(dev);
Steven A. Falcod3a126f2008-10-15 22:03:07 -0700250 struct m41t80_data *clientdata = i2c_get_clientdata(client);
Daniel Glocknerf30281f2009-04-02 16:57:03 -0700251 int val, reg_sqw;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700252
Steven A. Falcod3a126f2008-10-15 22:03:07 -0700253 if (!(clientdata->features & M41T80_FEATURE_SQ))
254 return -EINVAL;
255
Daniel Glocknerf30281f2009-04-02 16:57:03 -0700256 reg_sqw = M41T80_REG_SQW;
257 if (clientdata->features & M41T80_FEATURE_SQ_ALT)
258 reg_sqw = M41T80_REG_WDAY;
259 val = i2c_smbus_read_byte_data(client, reg_sqw);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700260 if (val < 0)
Wolfram Sang85d77042014-06-06 14:35:46 -0700261 return val;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700262 val = (val >> 4) & 0xf;
263 switch (val) {
264 case 0:
265 break;
266 case 1:
267 val = 32768;
268 break;
269 default:
270 val = 32768 >> val;
271 }
272 return sprintf(buf, "%d\n", val);
273}
Mylène Josserandef6b3122016-03-29 08:55:58 +0200274
275static ssize_t sqwfreq_store(struct device *dev,
276 struct device_attribute *attr,
277 const char *buf, size_t count)
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700278{
279 struct i2c_client *client = to_i2c_client(dev);
Steven A. Falcod3a126f2008-10-15 22:03:07 -0700280 struct m41t80_data *clientdata = i2c_get_clientdata(client);
Wolfram Sang85d77042014-06-06 14:35:46 -0700281 int almon, sqw, reg_sqw, rc;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700282 int val = simple_strtoul(buf, NULL, 0);
283
Steven A. Falcod3a126f2008-10-15 22:03:07 -0700284 if (!(clientdata->features & M41T80_FEATURE_SQ))
285 return -EINVAL;
286
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700287 if (val) {
288 if (!is_power_of_2(val))
289 return -EINVAL;
290 val = ilog2(val);
291 if (val == 15)
292 val = 1;
293 else if (val < 14)
294 val = 15 - val;
295 else
296 return -EINVAL;
297 }
298 /* disable SQW, set SQW frequency & re-enable */
299 almon = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
300 if (almon < 0)
Wolfram Sang85d77042014-06-06 14:35:46 -0700301 return almon;
Daniel Glocknerf30281f2009-04-02 16:57:03 -0700302 reg_sqw = M41T80_REG_SQW;
303 if (clientdata->features & M41T80_FEATURE_SQ_ALT)
304 reg_sqw = M41T80_REG_WDAY;
305 sqw = i2c_smbus_read_byte_data(client, reg_sqw);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700306 if (sqw < 0)
Wolfram Sang85d77042014-06-06 14:35:46 -0700307 return sqw;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700308 sqw = (sqw & 0x0f) | (val << 4);
Wolfram Sang85d77042014-06-06 14:35:46 -0700309
310 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
311 almon & ~M41T80_ALMON_SQWE);
312 if (rc < 0)
313 return rc;
314
315 if (val) {
316 rc = i2c_smbus_write_byte_data(client, reg_sqw, sqw);
317 if (rc < 0)
318 return rc;
319
320 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
321 almon | M41T80_ALMON_SQWE);
322 if (rc <0)
323 return rc;
324 }
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700325 return count;
326}
Mylène Josserandef6b3122016-03-29 08:55:58 +0200327static DEVICE_ATTR_RW(sqwfreq);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700328
329static struct attribute *attrs[] = {
330 &dev_attr_flags.attr,
331 &dev_attr_sqwfreq.attr,
332 NULL,
333};
334static struct attribute_group attr_group = {
335 .attrs = attrs,
336};
337
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700338#ifdef CONFIG_RTC_DRV_M41T80_WDT
339/*
340 *****************************************************************************
341 *
342 * Watchdog Driver
343 *
344 *****************************************************************************
345 */
346static struct i2c_client *save_client;
347
348/* Default margin */
349#define WD_TIMO 60 /* 1..31 seconds */
350
351static int wdt_margin = WD_TIMO;
352module_param(wdt_margin, int, 0);
353MODULE_PARM_DESC(wdt_margin, "Watchdog timeout in seconds (default 60s)");
354
355static unsigned long wdt_is_open;
356static int boot_flag;
357
358/**
359 * wdt_ping:
360 *
361 * Reload counter one with the watchdog timeout. We don't bother reloading
362 * the cascade counter.
363 */
364static void wdt_ping(void)
365{
366 unsigned char i2c_data[2];
367 struct i2c_msg msgs1[1] = {
368 {
369 .addr = save_client->addr,
370 .flags = 0,
371 .len = 2,
372 .buf = i2c_data,
373 },
374 };
Steven A. Falcod3a126f2008-10-15 22:03:07 -0700375 struct m41t80_data *clientdata = i2c_get_clientdata(save_client);
376
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700377 i2c_data[0] = 0x09; /* watchdog register */
378
379 if (wdt_margin > 31)
380 i2c_data[1] = (wdt_margin & 0xFC) | 0x83; /* resolution = 4s */
381 else
382 /*
383 * WDS = 1 (0x80), mulitplier = WD_TIMO, resolution = 1s (0x02)
384 */
385 i2c_data[1] = wdt_margin<<2 | 0x82;
386
Steven A. Falcod3a126f2008-10-15 22:03:07 -0700387 /*
388 * M41T65 has three bits for watchdog resolution. Don't set bit 7, as
389 * that would be an invalid resolution.
390 */
391 if (clientdata->features & M41T80_FEATURE_WD)
392 i2c_data[1] &= ~M41T80_WATCHDOG_RB2;
393
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700394 i2c_transfer(save_client->adapter, msgs1, 1);
395}
396
397/**
398 * wdt_disable:
399 *
400 * disables watchdog.
401 */
402static void wdt_disable(void)
403{
404 unsigned char i2c_data[2], i2c_buf[0x10];
405 struct i2c_msg msgs0[2] = {
406 {
407 .addr = save_client->addr,
408 .flags = 0,
409 .len = 1,
410 .buf = i2c_data,
411 },
412 {
413 .addr = save_client->addr,
414 .flags = I2C_M_RD,
415 .len = 1,
416 .buf = i2c_buf,
417 },
418 };
419 struct i2c_msg msgs1[1] = {
420 {
421 .addr = save_client->addr,
422 .flags = 0,
423 .len = 2,
424 .buf = i2c_data,
425 },
426 };
427
428 i2c_data[0] = 0x09;
429 i2c_transfer(save_client->adapter, msgs0, 2);
430
431 i2c_data[0] = 0x09;
432 i2c_data[1] = 0x00;
433 i2c_transfer(save_client->adapter, msgs1, 1);
434}
435
436/**
437 * wdt_write:
438 * @file: file handle to the watchdog
439 * @buf: buffer to write (unused as data does not matter here
440 * @count: count of bytes
441 * @ppos: pointer to the position to write. No seeks allowed
442 *
443 * A write to a watchdog device is defined as a keepalive signal. Any
444 * write of data will do, as we we don't define content meaning.
445 */
446static ssize_t wdt_write(struct file *file, const char __user *buf,
447 size_t count, loff_t *ppos)
448{
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700449 if (count) {
450 wdt_ping();
451 return 1;
452 }
453 return 0;
454}
455
456static ssize_t wdt_read(struct file *file, char __user *buf,
457 size_t count, loff_t *ppos)
458{
459 return 0;
460}
461
462/**
463 * wdt_ioctl:
464 * @inode: inode of the device
465 * @file: file handle to the device
466 * @cmd: watchdog command
467 * @arg: argument pointer
468 *
469 * The watchdog API defines a common set of functions for all watchdogs
470 * according to their available features. We only actually usefully support
471 * querying capabilities and current status.
472 */
Arnd Bergmann55929332010-04-27 00:24:05 +0200473static int wdt_ioctl(struct file *file, unsigned int cmd,
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700474 unsigned long arg)
475{
476 int new_margin, rv;
477 static struct watchdog_info ident = {
478 .options = WDIOF_POWERUNDER | WDIOF_KEEPALIVEPING |
479 WDIOF_SETTIMEOUT,
480 .firmware_version = 1,
481 .identity = "M41T80 WTD"
482 };
483
484 switch (cmd) {
485 case WDIOC_GETSUPPORT:
486 return copy_to_user((struct watchdog_info __user *)arg, &ident,
487 sizeof(ident)) ? -EFAULT : 0;
488
489 case WDIOC_GETSTATUS:
490 case WDIOC_GETBOOTSTATUS:
491 return put_user(boot_flag, (int __user *)arg);
492 case WDIOC_KEEPALIVE:
493 wdt_ping();
494 return 0;
495 case WDIOC_SETTIMEOUT:
496 if (get_user(new_margin, (int __user *)arg))
497 return -EFAULT;
498 /* Arbitrary, can't find the card's limits */
499 if (new_margin < 1 || new_margin > 124)
500 return -EINVAL;
501 wdt_margin = new_margin;
502 wdt_ping();
503 /* Fall */
504 case WDIOC_GETTIMEOUT:
505 return put_user(wdt_margin, (int __user *)arg);
506
507 case WDIOC_SETOPTIONS:
508 if (copy_from_user(&rv, (int __user *)arg, sizeof(int)))
509 return -EFAULT;
510
511 if (rv & WDIOS_DISABLECARD) {
Joe Perchesa737e832015-04-16 12:46:14 -0700512 pr_info("disable watchdog\n");
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700513 wdt_disable();
514 }
515
516 if (rv & WDIOS_ENABLECARD) {
Joe Perchesa737e832015-04-16 12:46:14 -0700517 pr_info("enable watchdog\n");
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700518 wdt_ping();
519 }
520
521 return -EINVAL;
522 }
523 return -ENOTTY;
524}
525
Arnd Bergmann55929332010-04-27 00:24:05 +0200526static long wdt_unlocked_ioctl(struct file *file, unsigned int cmd,
527 unsigned long arg)
528{
529 int ret;
530
Arnd Bergmann613655f2010-06-02 14:28:52 +0200531 mutex_lock(&m41t80_rtc_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +0200532 ret = wdt_ioctl(file, cmd, arg);
Arnd Bergmann613655f2010-06-02 14:28:52 +0200533 mutex_unlock(&m41t80_rtc_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +0200534
535 return ret;
536}
537
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700538/**
539 * wdt_open:
540 * @inode: inode of device
541 * @file: file handle to device
542 *
543 */
544static int wdt_open(struct inode *inode, struct file *file)
545{
546 if (MINOR(inode->i_rdev) == WATCHDOG_MINOR) {
Arnd Bergmann613655f2010-06-02 14:28:52 +0200547 mutex_lock(&m41t80_rtc_mutex);
Arnd Bergmann41012732008-05-20 19:16:39 +0200548 if (test_and_set_bit(0, &wdt_is_open)) {
Arnd Bergmann613655f2010-06-02 14:28:52 +0200549 mutex_unlock(&m41t80_rtc_mutex);
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700550 return -EBUSY;
Arnd Bergmann41012732008-05-20 19:16:39 +0200551 }
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700552 /*
553 * Activate
554 */
555 wdt_is_open = 1;
Arnd Bergmann613655f2010-06-02 14:28:52 +0200556 mutex_unlock(&m41t80_rtc_mutex);
Jan Blunck09eeb1f2010-05-26 14:44:47 -0700557 return nonseekable_open(inode, file);
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700558 }
559 return -ENODEV;
560}
561
562/**
563 * wdt_close:
564 * @inode: inode to board
565 * @file: file handle to board
566 *
567 */
568static int wdt_release(struct inode *inode, struct file *file)
569{
570 if (MINOR(inode->i_rdev) == WATCHDOG_MINOR)
571 clear_bit(0, &wdt_is_open);
572 return 0;
573}
574
575/**
576 * notify_sys:
577 * @this: our notifier block
578 * @code: the event being reported
579 * @unused: unused
580 *
581 * Our notifier is called on system shutdowns. We want to turn the card
582 * off at reboot otherwise the machine will reboot again during memory
583 * test or worse yet during the following fsck. This would suck, in fact
584 * trust me - if it happens it does suck.
585 */
586static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
587 void *unused)
588{
589 if (code == SYS_DOWN || code == SYS_HALT)
590 /* Disable Watchdog */
591 wdt_disable();
592 return NOTIFY_DONE;
593}
594
595static const struct file_operations wdt_fops = {
596 .owner = THIS_MODULE,
597 .read = wdt_read,
Arnd Bergmann55929332010-04-27 00:24:05 +0200598 .unlocked_ioctl = wdt_unlocked_ioctl,
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700599 .write = wdt_write,
600 .open = wdt_open,
601 .release = wdt_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200602 .llseek = no_llseek,
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700603};
604
605static struct miscdevice wdt_dev = {
606 .minor = WATCHDOG_MINOR,
607 .name = "watchdog",
608 .fops = &wdt_fops,
609};
610
611/*
612 * The WDT card needs to learn about soft shutdowns in order to
613 * turn the timebomb registers off.
614 */
615static struct notifier_block wdt_notifier = {
616 .notifier_call = wdt_notify_sys,
617};
618#endif /* CONFIG_RTC_DRV_M41T80_WDT */
619
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700620/*
621 *****************************************************************************
622 *
623 * Driver Interface
624 *
625 *****************************************************************************
626 */
Mylène Josserandef6b3122016-03-29 08:55:58 +0200627
628static void m41t80_remove_sysfs_group(void *_dev)
629{
630 struct device *dev = _dev;
631
632 sysfs_remove_group(&dev->kobj, &attr_group);
633}
634
Jean Delvared2653e92008-04-29 23:11:39 +0200635static int m41t80_probe(struct i2c_client *client,
636 const struct i2c_device_id *id)
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700637{
Jean Delvare3760f732008-04-29 23:11:40 +0200638 int rc = 0;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700639 struct rtc_device *rtc = NULL;
640 struct rtc_time tm;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700641 struct m41t80_data *clientdata = NULL;
642
643 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700644 | I2C_FUNC_SMBUS_BYTE_DATA))
645 return -ENODEV;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700646
Jingoo Han4ebabb72013-04-29 16:20:42 -0700647 clientdata = devm_kzalloc(&client->dev, sizeof(*clientdata),
648 GFP_KERNEL);
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700649 if (!clientdata)
650 return -ENOMEM;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700651
John Stultza015dbc2011-05-06 17:24:27 -0700652 clientdata->features = id->driver_data;
653 i2c_set_clientdata(client, clientdata);
654
Jingoo Han4ebabb72013-04-29 16:20:42 -0700655 rtc = devm_rtc_device_register(&client->dev, client->name,
656 &m41t80_rtc_ops, THIS_MODULE);
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700657 if (IS_ERR(rtc))
658 return PTR_ERR(rtc);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700659
660 clientdata->rtc = rtc;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700661
662 /* Make sure HT (Halt Update) bit is cleared */
663 rc = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_HOUR);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700664
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700665 if (rc >= 0 && rc & M41T80_ALHOUR_HT) {
Jean Delvare3760f732008-04-29 23:11:40 +0200666 if (clientdata->features & M41T80_FEATURE_HT) {
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700667 m41t80_get_datetime(client, &tm);
668 dev_info(&client->dev, "HT bit was set!\n");
669 dev_info(&client->dev,
670 "Power Down at "
671 "%04i-%02i-%02i %02i:%02i:%02i\n",
672 tm.tm_year + 1900,
673 tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
674 tm.tm_min, tm.tm_sec);
675 }
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700676 rc = i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_HOUR,
677 rc & ~M41T80_ALHOUR_HT);
678 }
679
680 if (rc < 0) {
681 dev_err(&client->dev, "Can't clear HT bit\n");
Wolfram Sang85d77042014-06-06 14:35:46 -0700682 return rc;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700683 }
684
685 /* Make sure ST (stop) bit is cleared */
686 rc = i2c_smbus_read_byte_data(client, M41T80_REG_SEC);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700687
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700688 if (rc >= 0 && rc & M41T80_SEC_ST)
689 rc = i2c_smbus_write_byte_data(client, M41T80_REG_SEC,
690 rc & ~M41T80_SEC_ST);
691 if (rc < 0) {
692 dev_err(&client->dev, "Can't clear ST bit\n");
Wolfram Sang85d77042014-06-06 14:35:46 -0700693 return rc;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700694 }
695
Mylène Josserandef6b3122016-03-29 08:55:58 +0200696 /* Export sysfs entries */
697 rc = sysfs_create_group(&(&client->dev)->kobj, &attr_group);
698 if (rc) {
699 dev_err(&client->dev, "Failed to create sysfs group: %d\n", rc);
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700700 return rc;
Mylène Josserandef6b3122016-03-29 08:55:58 +0200701 }
702
703 rc = devm_add_action(&client->dev, m41t80_remove_sysfs_group,
704 &client->dev);
705 if (rc) {
706 m41t80_remove_sysfs_group(&client->dev);
707 dev_err(&client->dev,
708 "Failed to add sysfs cleanup action: %d\n", rc);
709 return rc;
710 }
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700711
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700712#ifdef CONFIG_RTC_DRV_M41T80_WDT
Jean Delvare3760f732008-04-29 23:11:40 +0200713 if (clientdata->features & M41T80_FEATURE_HT) {
Maciej W. Rozycki417607d2008-05-12 14:02:35 -0700714 save_client = client;
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700715 rc = misc_register(&wdt_dev);
716 if (rc)
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700717 return rc;
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700718 rc = register_reboot_notifier(&wdt_notifier);
719 if (rc) {
720 misc_deregister(&wdt_dev);
Wolfram Sangc67fedf2014-06-06 14:35:45 -0700721 return rc;
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700722 }
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700723 }
724#endif
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700725 return 0;
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700726}
727
728static int m41t80_remove(struct i2c_client *client)
729{
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700730#ifdef CONFIG_RTC_DRV_M41T80_WDT
Jingoo Han4ebabb72013-04-29 16:20:42 -0700731 struct m41t80_data *clientdata = i2c_get_clientdata(client);
732
Jean Delvare3760f732008-04-29 23:11:40 +0200733 if (clientdata->features & M41T80_FEATURE_HT) {
Atsushi Nemoto617780d2007-07-17 04:05:04 -0700734 misc_deregister(&wdt_dev);
735 unregister_reboot_notifier(&wdt_notifier);
736 }
737#endif
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700738
739 return 0;
740}
741
742static struct i2c_driver m41t80_driver = {
743 .driver = {
David Brownellafe1ab42007-08-22 14:01:27 -0700744 .name = "rtc-m41t80",
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700745 },
746 .probe = m41t80_probe,
747 .remove = m41t80_remove,
Jean Delvare3760f732008-04-29 23:11:40 +0200748 .id_table = m41t80_id,
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700749};
750
Axel Lin0abc9202012-03-23 15:02:31 -0700751module_i2c_driver(m41t80_driver);
Atsushi Nemotocaaff562007-07-17 04:05:02 -0700752
753MODULE_AUTHOR("Alexander Bigga <ab@mycable.de>");
754MODULE_DESCRIPTION("ST Microelectronics M41T80 series RTC I2C Client Driver");
755MODULE_LICENSE("GPL");