rtc-m41t80.c 23 KB

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