rtc-m41t80.c 23 KB

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