rtc-m41t80.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909
  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. #include <linux/bcd.h>
  16. #include <linux/i2c.h>
  17. #include <linux/init.h>
  18. #include <linux/kernel.h>
  19. #include <linux/module.h>
  20. #include <linux/rtc.h>
  21. #include <linux/slab.h>
  22. #include <linux/mutex.h>
  23. #include <linux/string.h>
  24. #ifdef CONFIG_RTC_DRV_M41T80_WDT
  25. #include <linux/fs.h>
  26. #include <linux/ioctl.h>
  27. #include <linux/miscdevice.h>
  28. #include <linux/reboot.h>
  29. #include <linux/watchdog.h>
  30. #endif
  31. #define M41T80_REG_SSEC 0
  32. #define M41T80_REG_SEC 1
  33. #define M41T80_REG_MIN 2
  34. #define M41T80_REG_HOUR 3
  35. #define M41T80_REG_WDAY 4
  36. #define M41T80_REG_DAY 5
  37. #define M41T80_REG_MON 6
  38. #define M41T80_REG_YEAR 7
  39. #define M41T80_REG_ALARM_MON 0xa
  40. #define M41T80_REG_ALARM_DAY 0xb
  41. #define M41T80_REG_ALARM_HOUR 0xc
  42. #define M41T80_REG_ALARM_MIN 0xd
  43. #define M41T80_REG_ALARM_SEC 0xe
  44. #define M41T80_REG_FLAGS 0xf
  45. #define M41T80_REG_SQW 0x13
  46. #define M41T80_DATETIME_REG_SIZE (M41T80_REG_YEAR + 1)
  47. #define M41T80_ALARM_REG_SIZE \
  48. (M41T80_REG_ALARM_SEC + 1 - M41T80_REG_ALARM_MON)
  49. #define M41T80_SEC_ST (1 << 7) /* ST: Stop Bit */
  50. #define M41T80_ALMON_AFE (1 << 7) /* AFE: AF Enable Bit */
  51. #define M41T80_ALMON_SQWE (1 << 6) /* SQWE: SQW Enable Bit */
  52. #define M41T80_ALHOUR_HT (1 << 6) /* HT: Halt Update Bit */
  53. #define M41T80_FLAGS_AF (1 << 6) /* AF: Alarm Flag Bit */
  54. #define M41T80_FLAGS_BATT_LOW (1 << 4) /* BL: Battery Low Bit */
  55. #define M41T80_WATCHDOG_RB2 (1 << 7) /* RB: Watchdog resolution */
  56. #define M41T80_WATCHDOG_RB1 (1 << 1) /* RB: Watchdog resolution */
  57. #define M41T80_WATCHDOG_RB0 (1 << 0) /* RB: Watchdog resolution */
  58. #define M41T80_FEATURE_HT (1 << 0) /* Halt feature */
  59. #define M41T80_FEATURE_BL (1 << 1) /* Battery low indicator */
  60. #define M41T80_FEATURE_SQ (1 << 2) /* Squarewave feature */
  61. #define M41T80_FEATURE_WD (1 << 3) /* Extra watchdog resolution */
  62. #define M41T80_FEATURE_SQ_ALT (1 << 4) /* RSx bits are in reg 4 */
  63. #define DRV_VERSION "0.05"
  64. static DEFINE_MUTEX(m41t80_rtc_mutex);
  65. static const struct i2c_device_id m41t80_id[] = {
  66. { "m41t62", M41T80_FEATURE_SQ | M41T80_FEATURE_SQ_ALT },
  67. { "m41t65", M41T80_FEATURE_HT | M41T80_FEATURE_WD },
  68. { "m41t80", M41T80_FEATURE_SQ },
  69. { "m41t81", M41T80_FEATURE_HT | M41T80_FEATURE_SQ},
  70. { "m41t81s", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
  71. { "m41t82", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
  72. { "m41t83", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
  73. { "m41st84", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
  74. { "m41st85", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
  75. { "m41st87", M41T80_FEATURE_HT | M41T80_FEATURE_BL | M41T80_FEATURE_SQ },
  76. { }
  77. };
  78. MODULE_DEVICE_TABLE(i2c, m41t80_id);
  79. struct m41t80_data {
  80. u8 features;
  81. struct rtc_device *rtc;
  82. };
  83. static int m41t80_get_datetime(struct i2c_client *client,
  84. struct rtc_time *tm)
  85. {
  86. u8 buf[M41T80_DATETIME_REG_SIZE], dt_addr[1] = { M41T80_REG_SEC };
  87. struct i2c_msg msgs[] = {
  88. {
  89. .addr = client->addr,
  90. .flags = 0,
  91. .len = 1,
  92. .buf = dt_addr,
  93. },
  94. {
  95. .addr = client->addr,
  96. .flags = I2C_M_RD,
  97. .len = M41T80_DATETIME_REG_SIZE - M41T80_REG_SEC,
  98. .buf = buf + M41T80_REG_SEC,
  99. },
  100. };
  101. if (i2c_transfer(client->adapter, msgs, 2) < 0) {
  102. dev_err(&client->dev, "read error\n");
  103. return -EIO;
  104. }
  105. tm->tm_sec = bcd2bin(buf[M41T80_REG_SEC] & 0x7f);
  106. tm->tm_min = bcd2bin(buf[M41T80_REG_MIN] & 0x7f);
  107. tm->tm_hour = bcd2bin(buf[M41T80_REG_HOUR] & 0x3f);
  108. tm->tm_mday = bcd2bin(buf[M41T80_REG_DAY] & 0x3f);
  109. tm->tm_wday = buf[M41T80_REG_WDAY] & 0x07;
  110. tm->tm_mon = bcd2bin(buf[M41T80_REG_MON] & 0x1f) - 1;
  111. /* assume 20YY not 19YY, and ignore the Century Bit */
  112. tm->tm_year = bcd2bin(buf[M41T80_REG_YEAR]) + 100;
  113. return rtc_valid_tm(tm);
  114. }
  115. /* Sets the given date and time to the real time clock. */
  116. static int m41t80_set_datetime(struct i2c_client *client, struct rtc_time *tm)
  117. {
  118. u8 wbuf[1 + M41T80_DATETIME_REG_SIZE];
  119. u8 *buf = &wbuf[1];
  120. u8 dt_addr[1] = { M41T80_REG_SEC };
  121. struct i2c_msg msgs_in[] = {
  122. {
  123. .addr = client->addr,
  124. .flags = 0,
  125. .len = 1,
  126. .buf = dt_addr,
  127. },
  128. {
  129. .addr = client->addr,
  130. .flags = I2C_M_RD,
  131. .len = M41T80_DATETIME_REG_SIZE - M41T80_REG_SEC,
  132. .buf = buf + M41T80_REG_SEC,
  133. },
  134. };
  135. struct i2c_msg msgs[] = {
  136. {
  137. .addr = client->addr,
  138. .flags = 0,
  139. .len = 1 + M41T80_DATETIME_REG_SIZE,
  140. .buf = wbuf,
  141. },
  142. };
  143. /* Read current reg values into buf[1..7] */
  144. if (i2c_transfer(client->adapter, msgs_in, 2) < 0) {
  145. dev_err(&client->dev, "read error\n");
  146. return -EIO;
  147. }
  148. wbuf[0] = 0; /* offset into rtc's regs */
  149. /* Merge time-data and register flags into buf[0..7] */
  150. buf[M41T80_REG_SSEC] = 0;
  151. buf[M41T80_REG_SEC] =
  152. bin2bcd(tm->tm_sec) | (buf[M41T80_REG_SEC] & ~0x7f);
  153. buf[M41T80_REG_MIN] =
  154. bin2bcd(tm->tm_min) | (buf[M41T80_REG_MIN] & ~0x7f);
  155. buf[M41T80_REG_HOUR] =
  156. bin2bcd(tm->tm_hour) | (buf[M41T80_REG_HOUR] & ~0x3f) ;
  157. buf[M41T80_REG_WDAY] =
  158. (tm->tm_wday & 0x07) | (buf[M41T80_REG_WDAY] & ~0x07);
  159. buf[M41T80_REG_DAY] =
  160. bin2bcd(tm->tm_mday) | (buf[M41T80_REG_DAY] & ~0x3f);
  161. buf[M41T80_REG_MON] =
  162. bin2bcd(tm->tm_mon + 1) | (buf[M41T80_REG_MON] & ~0x1f);
  163. /* assume 20YY not 19YY */
  164. buf[M41T80_REG_YEAR] = bin2bcd(tm->tm_year % 100);
  165. if (i2c_transfer(client->adapter, msgs, 1) != 1) {
  166. dev_err(&client->dev, "write error\n");
  167. return -EIO;
  168. }
  169. return 0;
  170. }
  171. #if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
  172. static int m41t80_rtc_proc(struct device *dev, struct seq_file *seq)
  173. {
  174. struct i2c_client *client = to_i2c_client(dev);
  175. struct m41t80_data *clientdata = i2c_get_clientdata(client);
  176. u8 reg;
  177. if (clientdata->features & M41T80_FEATURE_BL) {
  178. reg = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
  179. seq_printf(seq, "battery\t\t: %s\n",
  180. (reg & M41T80_FLAGS_BATT_LOW) ? "exhausted" : "ok");
  181. }
  182. return 0;
  183. }
  184. #else
  185. #define m41t80_rtc_proc NULL
  186. #endif
  187. static int m41t80_rtc_read_time(struct device *dev, struct rtc_time *tm)
  188. {
  189. return m41t80_get_datetime(to_i2c_client(dev), tm);
  190. }
  191. static int m41t80_rtc_set_time(struct device *dev, struct rtc_time *tm)
  192. {
  193. return m41t80_set_datetime(to_i2c_client(dev), tm);
  194. }
  195. static int m41t80_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
  196. {
  197. struct i2c_client *client = to_i2c_client(dev);
  198. int rc;
  199. rc = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
  200. if (rc < 0)
  201. goto err;
  202. if (enabled)
  203. rc |= M41T80_ALMON_AFE;
  204. else
  205. rc &= ~M41T80_ALMON_AFE;
  206. if (i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON, rc) < 0)
  207. goto err;
  208. return 0;
  209. err:
  210. return -EIO;
  211. }
  212. static int m41t80_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *t)
  213. {
  214. struct i2c_client *client = to_i2c_client(dev);
  215. u8 wbuf[1 + M41T80_ALARM_REG_SIZE];
  216. u8 *buf = &wbuf[1];
  217. u8 *reg = buf - M41T80_REG_ALARM_MON;
  218. u8 dt_addr[1] = { M41T80_REG_ALARM_MON };
  219. struct i2c_msg msgs_in[] = {
  220. {
  221. .addr = client->addr,
  222. .flags = 0,
  223. .len = 1,
  224. .buf = dt_addr,
  225. },
  226. {
  227. .addr = client->addr,
  228. .flags = I2C_M_RD,
  229. .len = M41T80_ALARM_REG_SIZE,
  230. .buf = buf,
  231. },
  232. };
  233. struct i2c_msg msgs[] = {
  234. {
  235. .addr = client->addr,
  236. .flags = 0,
  237. .len = 1 + M41T80_ALARM_REG_SIZE,
  238. .buf = wbuf,
  239. },
  240. };
  241. if (i2c_transfer(client->adapter, msgs_in, 2) < 0) {
  242. dev_err(&client->dev, "read error\n");
  243. return -EIO;
  244. }
  245. reg[M41T80_REG_ALARM_MON] &= ~(0x1f | M41T80_ALMON_AFE);
  246. reg[M41T80_REG_ALARM_DAY] = 0;
  247. reg[M41T80_REG_ALARM_HOUR] &= ~(0x3f | 0x80);
  248. reg[M41T80_REG_ALARM_MIN] = 0;
  249. reg[M41T80_REG_ALARM_SEC] = 0;
  250. wbuf[0] = M41T80_REG_ALARM_MON; /* offset into rtc's regs */
  251. reg[M41T80_REG_ALARM_SEC] |= t->time.tm_sec >= 0 ?
  252. bin2bcd(t->time.tm_sec) : 0x80;
  253. reg[M41T80_REG_ALARM_MIN] |= t->time.tm_min >= 0 ?
  254. bin2bcd(t->time.tm_min) : 0x80;
  255. reg[M41T80_REG_ALARM_HOUR] |= t->time.tm_hour >= 0 ?
  256. bin2bcd(t->time.tm_hour) : 0x80;
  257. reg[M41T80_REG_ALARM_DAY] |= t->time.tm_mday >= 0 ?
  258. bin2bcd(t->time.tm_mday) : 0x80;
  259. if (t->time.tm_mon >= 0)
  260. reg[M41T80_REG_ALARM_MON] |= bin2bcd(t->time.tm_mon + 1);
  261. else
  262. reg[M41T80_REG_ALARM_DAY] |= 0x40;
  263. if (i2c_transfer(client->adapter, msgs, 1) != 1) {
  264. dev_err(&client->dev, "write error\n");
  265. return -EIO;
  266. }
  267. if (t->enabled) {
  268. reg[M41T80_REG_ALARM_MON] |= M41T80_ALMON_AFE;
  269. if (i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
  270. reg[M41T80_REG_ALARM_MON]) < 0) {
  271. dev_err(&client->dev, "write error\n");
  272. return -EIO;
  273. }
  274. }
  275. return 0;
  276. }
  277. static int m41t80_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *t)
  278. {
  279. struct i2c_client *client = to_i2c_client(dev);
  280. u8 buf[M41T80_ALARM_REG_SIZE + 1]; /* all alarm regs and flags */
  281. u8 dt_addr[1] = { M41T80_REG_ALARM_MON };
  282. u8 *reg = buf - M41T80_REG_ALARM_MON;
  283. struct i2c_msg msgs[] = {
  284. {
  285. .addr = client->addr,
  286. .flags = 0,
  287. .len = 1,
  288. .buf = dt_addr,
  289. },
  290. {
  291. .addr = client->addr,
  292. .flags = I2C_M_RD,
  293. .len = M41T80_ALARM_REG_SIZE + 1,
  294. .buf = buf,
  295. },
  296. };
  297. if (i2c_transfer(client->adapter, msgs, 2) < 0) {
  298. dev_err(&client->dev, "read error\n");
  299. return -EIO;
  300. }
  301. t->time.tm_sec = -1;
  302. t->time.tm_min = -1;
  303. t->time.tm_hour = -1;
  304. t->time.tm_mday = -1;
  305. t->time.tm_mon = -1;
  306. if (!(reg[M41T80_REG_ALARM_SEC] & 0x80))
  307. t->time.tm_sec = bcd2bin(reg[M41T80_REG_ALARM_SEC] & 0x7f);
  308. if (!(reg[M41T80_REG_ALARM_MIN] & 0x80))
  309. t->time.tm_min = bcd2bin(reg[M41T80_REG_ALARM_MIN] & 0x7f);
  310. if (!(reg[M41T80_REG_ALARM_HOUR] & 0x80))
  311. t->time.tm_hour = bcd2bin(reg[M41T80_REG_ALARM_HOUR] & 0x3f);
  312. if (!(reg[M41T80_REG_ALARM_DAY] & 0x80))
  313. t->time.tm_mday = bcd2bin(reg[M41T80_REG_ALARM_DAY] & 0x3f);
  314. if (!(reg[M41T80_REG_ALARM_DAY] & 0x40))
  315. t->time.tm_mon = bcd2bin(reg[M41T80_REG_ALARM_MON] & 0x1f) - 1;
  316. t->time.tm_year = -1;
  317. t->time.tm_wday = -1;
  318. t->time.tm_yday = -1;
  319. t->time.tm_isdst = -1;
  320. t->enabled = !!(reg[M41T80_REG_ALARM_MON] & M41T80_ALMON_AFE);
  321. t->pending = !!(reg[M41T80_REG_FLAGS] & M41T80_FLAGS_AF);
  322. return 0;
  323. }
  324. static struct rtc_class_ops m41t80_rtc_ops = {
  325. .read_time = m41t80_rtc_read_time,
  326. .set_time = m41t80_rtc_set_time,
  327. /*
  328. * XXX - m41t80 alarm functionality is reported broken.
  329. * until it is fixed, don't register alarm functions.
  330. *
  331. .read_alarm = m41t80_rtc_read_alarm,
  332. .set_alarm = m41t80_rtc_set_alarm,
  333. */
  334. .proc = m41t80_rtc_proc,
  335. /*
  336. * See above comment on broken alarm
  337. *
  338. .alarm_irq_enable = m41t80_rtc_alarm_irq_enable,
  339. */
  340. };
  341. #if defined(CONFIG_RTC_INTF_SYSFS) || defined(CONFIG_RTC_INTF_SYSFS_MODULE)
  342. static ssize_t m41t80_sysfs_show_flags(struct device *dev,
  343. struct device_attribute *attr, char *buf)
  344. {
  345. struct i2c_client *client = to_i2c_client(dev);
  346. int val;
  347. val = i2c_smbus_read_byte_data(client, M41T80_REG_FLAGS);
  348. if (val < 0)
  349. return -EIO;
  350. return sprintf(buf, "%#x\n", val);
  351. }
  352. static DEVICE_ATTR(flags, S_IRUGO, m41t80_sysfs_show_flags, NULL);
  353. static ssize_t m41t80_sysfs_show_sqwfreq(struct device *dev,
  354. struct device_attribute *attr, char *buf)
  355. {
  356. struct i2c_client *client = to_i2c_client(dev);
  357. struct m41t80_data *clientdata = i2c_get_clientdata(client);
  358. int val, reg_sqw;
  359. if (!(clientdata->features & M41T80_FEATURE_SQ))
  360. return -EINVAL;
  361. reg_sqw = M41T80_REG_SQW;
  362. if (clientdata->features & M41T80_FEATURE_SQ_ALT)
  363. reg_sqw = M41T80_REG_WDAY;
  364. val = i2c_smbus_read_byte_data(client, reg_sqw);
  365. if (val < 0)
  366. return -EIO;
  367. val = (val >> 4) & 0xf;
  368. switch (val) {
  369. case 0:
  370. break;
  371. case 1:
  372. val = 32768;
  373. break;
  374. default:
  375. val = 32768 >> val;
  376. }
  377. return sprintf(buf, "%d\n", val);
  378. }
  379. static ssize_t m41t80_sysfs_set_sqwfreq(struct device *dev,
  380. struct device_attribute *attr,
  381. const char *buf, size_t count)
  382. {
  383. struct i2c_client *client = to_i2c_client(dev);
  384. struct m41t80_data *clientdata = i2c_get_clientdata(client);
  385. int almon, sqw, reg_sqw;
  386. int val = simple_strtoul(buf, NULL, 0);
  387. if (!(clientdata->features & M41T80_FEATURE_SQ))
  388. return -EINVAL;
  389. if (val) {
  390. if (!is_power_of_2(val))
  391. return -EINVAL;
  392. val = ilog2(val);
  393. if (val == 15)
  394. val = 1;
  395. else if (val < 14)
  396. val = 15 - val;
  397. else
  398. return -EINVAL;
  399. }
  400. /* disable SQW, set SQW frequency & re-enable */
  401. almon = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_MON);
  402. if (almon < 0)
  403. return -EIO;
  404. reg_sqw = M41T80_REG_SQW;
  405. if (clientdata->features & M41T80_FEATURE_SQ_ALT)
  406. reg_sqw = M41T80_REG_WDAY;
  407. sqw = i2c_smbus_read_byte_data(client, reg_sqw);
  408. if (sqw < 0)
  409. return -EIO;
  410. sqw = (sqw & 0x0f) | (val << 4);
  411. if (i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
  412. almon & ~M41T80_ALMON_SQWE) < 0 ||
  413. i2c_smbus_write_byte_data(client, reg_sqw, sqw) < 0)
  414. return -EIO;
  415. if (val && i2c_smbus_write_byte_data(client, M41T80_REG_ALARM_MON,
  416. almon | M41T80_ALMON_SQWE) < 0)
  417. return -EIO;
  418. return count;
  419. }
  420. static DEVICE_ATTR(sqwfreq, S_IRUGO | S_IWUSR,
  421. m41t80_sysfs_show_sqwfreq, m41t80_sysfs_set_sqwfreq);
  422. static struct attribute *attrs[] = {
  423. &dev_attr_flags.attr,
  424. &dev_attr_sqwfreq.attr,
  425. NULL,
  426. };
  427. static struct attribute_group attr_group = {
  428. .attrs = attrs,
  429. };
  430. static int m41t80_sysfs_register(struct device *dev)
  431. {
  432. return sysfs_create_group(&dev->kobj, &attr_group);
  433. }
  434. #else
  435. static int m41t80_sysfs_register(struct device *dev)
  436. {
  437. return 0;
  438. }
  439. #endif
  440. #ifdef CONFIG_RTC_DRV_M41T80_WDT
  441. /*
  442. *****************************************************************************
  443. *
  444. * Watchdog Driver
  445. *
  446. *****************************************************************************
  447. */
  448. static struct i2c_client *save_client;
  449. /* Default margin */
  450. #define WD_TIMO 60 /* 1..31 seconds */
  451. static int wdt_margin = WD_TIMO;
  452. module_param(wdt_margin, int, 0);
  453. MODULE_PARM_DESC(wdt_margin, "Watchdog timeout in seconds (default 60s)");
  454. static unsigned long wdt_is_open;
  455. static int boot_flag;
  456. /**
  457. * wdt_ping:
  458. *
  459. * Reload counter one with the watchdog timeout. We don't bother reloading
  460. * the cascade counter.
  461. */
  462. static void wdt_ping(void)
  463. {
  464. unsigned char i2c_data[2];
  465. struct i2c_msg msgs1[1] = {
  466. {
  467. .addr = save_client->addr,
  468. .flags = 0,
  469. .len = 2,
  470. .buf = i2c_data,
  471. },
  472. };
  473. struct m41t80_data *clientdata = i2c_get_clientdata(save_client);
  474. i2c_data[0] = 0x09; /* watchdog register */
  475. if (wdt_margin > 31)
  476. i2c_data[1] = (wdt_margin & 0xFC) | 0x83; /* resolution = 4s */
  477. else
  478. /*
  479. * WDS = 1 (0x80), mulitplier = WD_TIMO, resolution = 1s (0x02)
  480. */
  481. i2c_data[1] = wdt_margin<<2 | 0x82;
  482. /*
  483. * M41T65 has three bits for watchdog resolution. Don't set bit 7, as
  484. * that would be an invalid resolution.
  485. */
  486. if (clientdata->features & M41T80_FEATURE_WD)
  487. i2c_data[1] &= ~M41T80_WATCHDOG_RB2;
  488. i2c_transfer(save_client->adapter, msgs1, 1);
  489. }
  490. /**
  491. * wdt_disable:
  492. *
  493. * disables watchdog.
  494. */
  495. static void wdt_disable(void)
  496. {
  497. unsigned char i2c_data[2], i2c_buf[0x10];
  498. struct i2c_msg msgs0[2] = {
  499. {
  500. .addr = save_client->addr,
  501. .flags = 0,
  502. .len = 1,
  503. .buf = i2c_data,
  504. },
  505. {
  506. .addr = save_client->addr,
  507. .flags = I2C_M_RD,
  508. .len = 1,
  509. .buf = i2c_buf,
  510. },
  511. };
  512. struct i2c_msg msgs1[1] = {
  513. {
  514. .addr = save_client->addr,
  515. .flags = 0,
  516. .len = 2,
  517. .buf = i2c_data,
  518. },
  519. };
  520. i2c_data[0] = 0x09;
  521. i2c_transfer(save_client->adapter, msgs0, 2);
  522. i2c_data[0] = 0x09;
  523. i2c_data[1] = 0x00;
  524. i2c_transfer(save_client->adapter, msgs1, 1);
  525. }
  526. /**
  527. * wdt_write:
  528. * @file: file handle to the watchdog
  529. * @buf: buffer to write (unused as data does not matter here
  530. * @count: count of bytes
  531. * @ppos: pointer to the position to write. No seeks allowed
  532. *
  533. * A write to a watchdog device is defined as a keepalive signal. Any
  534. * write of data will do, as we we don't define content meaning.
  535. */
  536. static ssize_t wdt_write(struct file *file, const char __user *buf,
  537. size_t count, loff_t *ppos)
  538. {
  539. if (count) {
  540. wdt_ping();
  541. return 1;
  542. }
  543. return 0;
  544. }
  545. static ssize_t wdt_read(struct file *file, char __user *buf,
  546. size_t count, loff_t *ppos)
  547. {
  548. return 0;
  549. }
  550. /**
  551. * wdt_ioctl:
  552. * @inode: inode of the device
  553. * @file: file handle to the device
  554. * @cmd: watchdog command
  555. * @arg: argument pointer
  556. *
  557. * The watchdog API defines a common set of functions for all watchdogs
  558. * according to their available features. We only actually usefully support
  559. * querying capabilities and current status.
  560. */
  561. static int wdt_ioctl(struct file *file, unsigned int cmd,
  562. unsigned long arg)
  563. {
  564. int new_margin, rv;
  565. static struct watchdog_info ident = {
  566. .options = WDIOF_POWERUNDER | WDIOF_KEEPALIVEPING |
  567. WDIOF_SETTIMEOUT,
  568. .firmware_version = 1,
  569. .identity = "M41T80 WTD"
  570. };
  571. switch (cmd) {
  572. case WDIOC_GETSUPPORT:
  573. return copy_to_user((struct watchdog_info __user *)arg, &ident,
  574. sizeof(ident)) ? -EFAULT : 0;
  575. case WDIOC_GETSTATUS:
  576. case WDIOC_GETBOOTSTATUS:
  577. return put_user(boot_flag, (int __user *)arg);
  578. case WDIOC_KEEPALIVE:
  579. wdt_ping();
  580. return 0;
  581. case WDIOC_SETTIMEOUT:
  582. if (get_user(new_margin, (int __user *)arg))
  583. return -EFAULT;
  584. /* Arbitrary, can't find the card's limits */
  585. if (new_margin < 1 || new_margin > 124)
  586. return -EINVAL;
  587. wdt_margin = new_margin;
  588. wdt_ping();
  589. /* Fall */
  590. case WDIOC_GETTIMEOUT:
  591. return put_user(wdt_margin, (int __user *)arg);
  592. case WDIOC_SETOPTIONS:
  593. if (copy_from_user(&rv, (int __user *)arg, sizeof(int)))
  594. return -EFAULT;
  595. if (rv & WDIOS_DISABLECARD) {
  596. pr_info("rtc-m41t80: disable watchdog\n");
  597. wdt_disable();
  598. }
  599. if (rv & WDIOS_ENABLECARD) {
  600. pr_info("rtc-m41t80: enable watchdog\n");
  601. wdt_ping();
  602. }
  603. return -EINVAL;
  604. }
  605. return -ENOTTY;
  606. }
  607. static long wdt_unlocked_ioctl(struct file *file, unsigned int cmd,
  608. unsigned long arg)
  609. {
  610. int ret;
  611. mutex_lock(&m41t80_rtc_mutex);
  612. ret = wdt_ioctl(file, cmd, arg);
  613. mutex_unlock(&m41t80_rtc_mutex);
  614. return ret;
  615. }
  616. /**
  617. * wdt_open:
  618. * @inode: inode of device
  619. * @file: file handle to device
  620. *
  621. */
  622. static int wdt_open(struct inode *inode, struct file *file)
  623. {
  624. if (MINOR(inode->i_rdev) == WATCHDOG_MINOR) {
  625. mutex_lock(&m41t80_rtc_mutex);
  626. if (test_and_set_bit(0, &wdt_is_open)) {
  627. mutex_unlock(&m41t80_rtc_mutex);
  628. return -EBUSY;
  629. }
  630. /*
  631. * Activate
  632. */
  633. wdt_is_open = 1;
  634. mutex_unlock(&m41t80_rtc_mutex);
  635. return nonseekable_open(inode, file);
  636. }
  637. return -ENODEV;
  638. }
  639. /**
  640. * wdt_close:
  641. * @inode: inode to board
  642. * @file: file handle to board
  643. *
  644. */
  645. static int wdt_release(struct inode *inode, struct file *file)
  646. {
  647. if (MINOR(inode->i_rdev) == WATCHDOG_MINOR)
  648. clear_bit(0, &wdt_is_open);
  649. return 0;
  650. }
  651. /**
  652. * notify_sys:
  653. * @this: our notifier block
  654. * @code: the event being reported
  655. * @unused: unused
  656. *
  657. * Our notifier is called on system shutdowns. We want to turn the card
  658. * off at reboot otherwise the machine will reboot again during memory
  659. * test or worse yet during the following fsck. This would suck, in fact
  660. * trust me - if it happens it does suck.
  661. */
  662. static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
  663. void *unused)
  664. {
  665. if (code == SYS_DOWN || code == SYS_HALT)
  666. /* Disable Watchdog */
  667. wdt_disable();
  668. return NOTIFY_DONE;
  669. }
  670. static const struct file_operations wdt_fops = {
  671. .owner = THIS_MODULE,
  672. .read = wdt_read,
  673. .unlocked_ioctl = wdt_unlocked_ioctl,
  674. .write = wdt_write,
  675. .open = wdt_open,
  676. .release = wdt_release,
  677. .llseek = no_llseek,
  678. };
  679. static struct miscdevice wdt_dev = {
  680. .minor = WATCHDOG_MINOR,
  681. .name = "watchdog",
  682. .fops = &wdt_fops,
  683. };
  684. /*
  685. * The WDT card needs to learn about soft shutdowns in order to
  686. * turn the timebomb registers off.
  687. */
  688. static struct notifier_block wdt_notifier = {
  689. .notifier_call = wdt_notify_sys,
  690. };
  691. #endif /* CONFIG_RTC_DRV_M41T80_WDT */
  692. /*
  693. *****************************************************************************
  694. *
  695. * Driver Interface
  696. *
  697. *****************************************************************************
  698. */
  699. static int m41t80_probe(struct i2c_client *client,
  700. const struct i2c_device_id *id)
  701. {
  702. int rc = 0;
  703. struct rtc_device *rtc = NULL;
  704. struct rtc_time tm;
  705. struct m41t80_data *clientdata = NULL;
  706. if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C
  707. | I2C_FUNC_SMBUS_BYTE_DATA)) {
  708. rc = -ENODEV;
  709. goto exit;
  710. }
  711. dev_info(&client->dev,
  712. "chip found, driver version " DRV_VERSION "\n");
  713. clientdata = kzalloc(sizeof(*clientdata), GFP_KERNEL);
  714. if (!clientdata) {
  715. rc = -ENOMEM;
  716. goto exit;
  717. }
  718. clientdata->features = id->driver_data;
  719. i2c_set_clientdata(client, clientdata);
  720. rtc = rtc_device_register(client->name, &client->dev,
  721. &m41t80_rtc_ops, THIS_MODULE);
  722. if (IS_ERR(rtc)) {
  723. rc = PTR_ERR(rtc);
  724. rtc = NULL;
  725. goto exit;
  726. }
  727. clientdata->rtc = rtc;
  728. /* Make sure HT (Halt Update) bit is cleared */
  729. rc = i2c_smbus_read_byte_data(client, M41T80_REG_ALARM_HOUR);
  730. if (rc < 0)
  731. goto ht_err;
  732. if (rc & M41T80_ALHOUR_HT) {
  733. if (clientdata->features & M41T80_FEATURE_HT) {
  734. m41t80_get_datetime(client, &tm);
  735. dev_info(&client->dev, "HT bit was set!\n");
  736. dev_info(&client->dev,
  737. "Power Down at "
  738. "%04i-%02i-%02i %02i:%02i:%02i\n",
  739. tm.tm_year + 1900,
  740. tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
  741. tm.tm_min, tm.tm_sec);
  742. }
  743. if (i2c_smbus_write_byte_data(client,
  744. M41T80_REG_ALARM_HOUR,
  745. rc & ~M41T80_ALHOUR_HT) < 0)
  746. goto ht_err;
  747. }
  748. /* Make sure ST (stop) bit is cleared */
  749. rc = i2c_smbus_read_byte_data(client, M41T80_REG_SEC);
  750. if (rc < 0)
  751. goto st_err;
  752. if (rc & M41T80_SEC_ST) {
  753. if (i2c_smbus_write_byte_data(client, M41T80_REG_SEC,
  754. rc & ~M41T80_SEC_ST) < 0)
  755. goto st_err;
  756. }
  757. rc = m41t80_sysfs_register(&client->dev);
  758. if (rc)
  759. goto exit;
  760. #ifdef CONFIG_RTC_DRV_M41T80_WDT
  761. if (clientdata->features & M41T80_FEATURE_HT) {
  762. save_client = client;
  763. rc = misc_register(&wdt_dev);
  764. if (rc)
  765. goto exit;
  766. rc = register_reboot_notifier(&wdt_notifier);
  767. if (rc) {
  768. misc_deregister(&wdt_dev);
  769. goto exit;
  770. }
  771. }
  772. #endif
  773. return 0;
  774. st_err:
  775. rc = -EIO;
  776. dev_err(&client->dev, "Can't clear ST bit\n");
  777. goto exit;
  778. ht_err:
  779. rc = -EIO;
  780. dev_err(&client->dev, "Can't clear HT bit\n");
  781. goto exit;
  782. exit:
  783. if (rtc)
  784. rtc_device_unregister(rtc);
  785. kfree(clientdata);
  786. return rc;
  787. }
  788. static int m41t80_remove(struct i2c_client *client)
  789. {
  790. struct m41t80_data *clientdata = i2c_get_clientdata(client);
  791. struct rtc_device *rtc = clientdata->rtc;
  792. #ifdef CONFIG_RTC_DRV_M41T80_WDT
  793. if (clientdata->features & M41T80_FEATURE_HT) {
  794. misc_deregister(&wdt_dev);
  795. unregister_reboot_notifier(&wdt_notifier);
  796. }
  797. #endif
  798. if (rtc)
  799. rtc_device_unregister(rtc);
  800. kfree(clientdata);
  801. return 0;
  802. }
  803. static struct i2c_driver m41t80_driver = {
  804. .driver = {
  805. .name = "rtc-m41t80",
  806. },
  807. .probe = m41t80_probe,
  808. .remove = m41t80_remove,
  809. .id_table = m41t80_id,
  810. };
  811. module_i2c_driver(m41t80_driver);
  812. MODULE_AUTHOR("Alexander Bigga <ab@mycable.de>");
  813. MODULE_DESCRIPTION("ST Microelectronics M41T80 series RTC I2C Client Driver");
  814. MODULE_LICENSE("GPL");
  815. MODULE_VERSION(DRV_VERSION);