Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 1 | /* |
| 2 | * An rtc/i2c driver for the Dallas DS1672 |
Alessandro Zummo | 3903586 | 2006-04-10 22:54:41 -0700 | [diff] [blame] | 3 | * Copyright 2005-06 Tower Technologies |
| 4 | * |
| 5 | * Author: Alessandro Zummo <a.zummo@towertech.it> |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
| 8 | * it under the terms of the GNU General Public License version 2 as |
| 9 | * published by the Free Software Foundation. |
| 10 | */ |
| 11 | |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 12 | #include <linux/i2c.h> |
| 13 | #include <linux/rtc.h> |
Paul Gortmaker | 2113852 | 2011-05-27 09:57:25 -0400 | [diff] [blame] | 14 | #include <linux/module.h> |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 15 | |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 16 | /* Registers */ |
| 17 | |
| 18 | #define DS1672_REG_CNT_BASE 0 |
| 19 | #define DS1672_REG_CONTROL 4 |
| 20 | #define DS1672_REG_TRICKLE 5 |
| 21 | |
Alessandro Zummo | 3903586 | 2006-04-10 22:54:41 -0700 | [diff] [blame] | 22 | #define DS1672_REG_CONTROL_EOSC 0x80 |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 23 | |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 24 | /* |
| 25 | * In the routines that deal directly with the ds1672 hardware, we use |
| 26 | * rtc_time -- month 0-11, hour 0-23, yr = calendar year-epoch |
Alexandre Belloni | d1fbe69 | 2019-04-07 23:05:34 +0200 | [diff] [blame] | 27 | * Time is set to UTC. |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 28 | */ |
Alexandre Belloni | 7a5670c | 2019-04-07 23:05:37 +0200 | [diff] [blame] | 29 | static int ds1672_read_time(struct device *dev, struct rtc_time *tm) |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 30 | { |
Alexandre Belloni | 7a5670c | 2019-04-07 23:05:37 +0200 | [diff] [blame] | 31 | struct i2c_client *client = to_i2c_client(dev); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 32 | unsigned long time; |
Alexandre Belloni | 10e3efc | 2019-04-07 23:05:35 +0200 | [diff] [blame] | 33 | unsigned char addr = DS1672_REG_CONTROL; |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 34 | unsigned char buf[4]; |
| 35 | |
| 36 | struct i2c_msg msgs[] = { |
Shubhrajyoti D | 2bfc37d | 2012-10-04 17:14:17 -0700 | [diff] [blame] | 37 | {/* setup read ptr */ |
| 38 | .addr = client->addr, |
| 39 | .len = 1, |
| 40 | .buf = &addr |
| 41 | }, |
| 42 | {/* read date */ |
| 43 | .addr = client->addr, |
| 44 | .flags = I2C_M_RD, |
Alexandre Belloni | 10e3efc | 2019-04-07 23:05:35 +0200 | [diff] [blame] | 45 | .len = 1, |
Shubhrajyoti D | 2bfc37d | 2012-10-04 17:14:17 -0700 | [diff] [blame] | 46 | .buf = buf |
| 47 | }, |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 48 | }; |
| 49 | |
Alexandre Belloni | 10e3efc | 2019-04-07 23:05:35 +0200 | [diff] [blame] | 50 | /* read control register */ |
| 51 | if ((i2c_transfer(client->adapter, &msgs[0], 2)) != 2) { |
| 52 | dev_warn(&client->dev, "Unable to read the control register\n"); |
| 53 | return -EIO; |
| 54 | } |
| 55 | |
| 56 | if (buf[0] & DS1672_REG_CONTROL_EOSC) { |
| 57 | dev_warn(&client->dev, "Oscillator not enabled. Set time to enable.\n"); |
| 58 | return -EINVAL; |
| 59 | } |
| 60 | |
| 61 | addr = DS1672_REG_CNT_BASE; |
| 62 | msgs[1].len = 4; |
| 63 | |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 64 | /* read date registers */ |
| 65 | if ((i2c_transfer(client->adapter, &msgs[0], 2)) != 2) { |
Harvey Harrison | 2a4e2b8 | 2008-04-28 02:12:00 -0700 | [diff] [blame] | 66 | dev_err(&client->dev, "%s: read error\n", __func__); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 67 | return -EIO; |
| 68 | } |
| 69 | |
| 70 | dev_dbg(&client->dev, |
Jeff Garzik | 11966ad | 2006-10-04 04:41:53 -0400 | [diff] [blame] | 71 | "%s: raw read data - counters=%02x,%02x,%02x,%02x\n", |
Harvey Harrison | 2a4e2b8 | 2008-04-28 02:12:00 -0700 | [diff] [blame] | 72 | __func__, buf[0], buf[1], buf[2], buf[3]); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 73 | |
Colin Ian King | f0c04c2 | 2019-02-05 18:04:49 +0000 | [diff] [blame] | 74 | time = ((unsigned long)buf[3] << 24) | (buf[2] << 16) | |
| 75 | (buf[1] << 8) | buf[0]; |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 76 | |
Alexandre Belloni | 520d651 | 2019-04-07 23:05:38 +0200 | [diff] [blame] | 77 | rtc_time64_to_tm(time, tm); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 78 | |
| 79 | dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, " |
| 80 | "mday=%d, mon=%d, year=%d, wday=%d\n", |
Harvey Harrison | 2a4e2b8 | 2008-04-28 02:12:00 -0700 | [diff] [blame] | 81 | __func__, tm->tm_sec, tm->tm_min, tm->tm_hour, |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 82 | tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday); |
| 83 | |
| 84 | return 0; |
| 85 | } |
| 86 | |
Alexandre Belloni | 219219d | 2019-04-07 23:05:39 +0200 | [diff] [blame^] | 87 | static int ds1672_set_time(struct device *dev, struct rtc_time *tm) |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 88 | { |
Alexandre Belloni | 7a5670c | 2019-04-07 23:05:37 +0200 | [diff] [blame] | 89 | struct i2c_client *client = to_i2c_client(dev); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 90 | int xfer; |
Kumar Gala | 8a95b25 | 2006-04-10 22:54:39 -0700 | [diff] [blame] | 91 | unsigned char buf[6]; |
Alexandre Belloni | 219219d | 2019-04-07 23:05:39 +0200 | [diff] [blame^] | 92 | unsigned long secs = rtc_tm_to_time64(tm); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 93 | |
| 94 | buf[0] = DS1672_REG_CNT_BASE; |
| 95 | buf[1] = secs & 0x000000FF; |
| 96 | buf[2] = (secs & 0x0000FF00) >> 8; |
| 97 | buf[3] = (secs & 0x00FF0000) >> 16; |
| 98 | buf[4] = (secs & 0xFF000000) >> 24; |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 99 | buf[5] = 0; /* set control reg to enable counting */ |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 100 | |
Kumar Gala | 8a95b25 | 2006-04-10 22:54:39 -0700 | [diff] [blame] | 101 | xfer = i2c_master_send(client, buf, 6); |
| 102 | if (xfer != 6) { |
Harvey Harrison | 2a4e2b8 | 2008-04-28 02:12:00 -0700 | [diff] [blame] | 103 | dev_err(&client->dev, "%s: send: %d\n", __func__, xfer); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 104 | return -EIO; |
| 105 | } |
| 106 | |
| 107 | return 0; |
| 108 | } |
| 109 | |
David Brownell | ff8371a | 2006-09-30 23:28:17 -0700 | [diff] [blame] | 110 | static const struct rtc_class_ops ds1672_rtc_ops = { |
Alexandre Belloni | 7a5670c | 2019-04-07 23:05:37 +0200 | [diff] [blame] | 111 | .read_time = ds1672_read_time, |
Alexandre Belloni | 219219d | 2019-04-07 23:05:39 +0200 | [diff] [blame^] | 112 | .set_time = ds1672_set_time, |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 113 | }; |
| 114 | |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 115 | static int ds1672_probe(struct i2c_client *client, |
| 116 | const struct i2c_device_id *id) |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 117 | { |
| 118 | int err = 0; |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 119 | struct rtc_device *rtc; |
| 120 | |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 121 | dev_dbg(&client->dev, "%s\n", __func__); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 122 | |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 123 | if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) |
| 124 | return -ENODEV; |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 125 | |
Alexandre Belloni | d1fbe69 | 2019-04-07 23:05:34 +0200 | [diff] [blame] | 126 | rtc = devm_rtc_allocate_device(&client->dev); |
| 127 | if (IS_ERR(rtc)) |
| 128 | return PTR_ERR(rtc); |
| 129 | |
| 130 | rtc->ops = &ds1672_rtc_ops; |
| 131 | rtc->range_max = U32_MAX; |
| 132 | |
| 133 | err = rtc_register_device(rtc); |
| 134 | if (err) |
| 135 | return err; |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 136 | |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 137 | if (IS_ERR(rtc)) |
| 138 | return PTR_ERR(rtc); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 139 | |
| 140 | i2c_set_clientdata(client, rtc); |
| 141 | |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 142 | return 0; |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 143 | } |
| 144 | |
Arvind Yadav | 45a6351 | 2017-08-20 00:37:55 +0530 | [diff] [blame] | 145 | static const struct i2c_device_id ds1672_id[] = { |
Alessandro Zummo | fe102c7 | 2008-12-09 13:14:11 -0800 | [diff] [blame] | 146 | { "ds1672", 0 }, |
| 147 | { } |
| 148 | }; |
Axel Lin | 8ad0f5b | 2011-04-18 20:16:57 +0800 | [diff] [blame] | 149 | MODULE_DEVICE_TABLE(i2c, ds1672_id); |
Alessandro Zummo | fe102c7 | 2008-12-09 13:14:11 -0800 | [diff] [blame] | 150 | |
Javier Martinez Canillas | 23194ac | 2017-03-03 11:29:18 -0300 | [diff] [blame] | 151 | static const struct of_device_id ds1672_of_match[] = { |
| 152 | { .compatible = "dallas,ds1672" }, |
| 153 | { } |
| 154 | }; |
| 155 | MODULE_DEVICE_TABLE(of, ds1672_of_match); |
| 156 | |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 157 | static struct i2c_driver ds1672_driver = { |
| 158 | .driver = { |
| 159 | .name = "rtc-ds1672", |
Javier Martinez Canillas | 23194ac | 2017-03-03 11:29:18 -0300 | [diff] [blame] | 160 | .of_match_table = of_match_ptr(ds1672_of_match), |
| 161 | }, |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 162 | .probe = &ds1672_probe, |
Alessandro Zummo | fe102c7 | 2008-12-09 13:14:11 -0800 | [diff] [blame] | 163 | .id_table = ds1672_id, |
Alessandro Zummo | 1716b0f | 2008-10-15 22:03:10 -0700 | [diff] [blame] | 164 | }; |
| 165 | |
Axel Lin | 0abc920 | 2012-03-23 15:02:31 -0700 | [diff] [blame] | 166 | module_i2c_driver(ds1672_driver); |
Alessandro Zummo | edf1aaa | 2006-03-27 01:16:43 -0800 | [diff] [blame] | 167 | |
| 168 | MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>"); |
| 169 | MODULE_DESCRIPTION("Dallas/Maxim DS1672 timekeeper driver"); |
| 170 | MODULE_LICENSE("GPL"); |