blob: 365dc6505148758dfac6621390133a2a2c7fc210 [file] [log] [blame]
Alessandro Zummo1fec7c62006-03-27 01:16:42 -08001/*
2 * An i2c driver for the Xicor/Intersil X1205 RTC
3 * Copyright 2004 Karen Spearel
4 * Copyright 2005 Alessandro Zummo
5 *
6 * please send all reports to:
Sachin Kamat66e3f102013-07-03 15:06:07 -07007 * Karen Spearel <kas111 at gmail dot com>
Alessandro Zummo1fec7c62006-03-27 01:16:42 -08008 * Alessandro Zummo <a.zummo@towertech.it>
9 *
10 * based on a lot of other RTC drivers.
11 *
Jean Delvare890e0372007-07-12 14:12:28 +020012 * Information and datasheet:
13 * http://www.intersil.com/cda/deviceinfo/0,1477,X1205,00.html
14 *
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080015 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License version 2 as
17 * published by the Free Software Foundation.
18 */
19
20#include <linux/i2c.h>
21#include <linux/bcd.h>
22#include <linux/rtc.h>
23#include <linux/delay.h>
Paul Gortmaker21138522011-05-27 09:57:25 -040024#include <linux/module.h>
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080025
Alessandro Zummo4edac2b2008-04-28 02:11:54 -070026#define DRV_VERSION "1.0.8"
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080027
28/* offsets into CCR area */
29
30#define CCR_SEC 0
31#define CCR_MIN 1
32#define CCR_HOUR 2
33#define CCR_MDAY 3
34#define CCR_MONTH 4
35#define CCR_YEAR 5
36#define CCR_WDAY 6
37#define CCR_Y2K 7
38
39#define X1205_REG_SR 0x3F /* status register */
40#define X1205_REG_Y2K 0x37
41#define X1205_REG_DW 0x36
42#define X1205_REG_YR 0x35
43#define X1205_REG_MO 0x34
44#define X1205_REG_DT 0x33
45#define X1205_REG_HR 0x32
46#define X1205_REG_MN 0x31
47#define X1205_REG_SC 0x30
48#define X1205_REG_DTR 0x13
49#define X1205_REG_ATR 0x12
50#define X1205_REG_INT 0x11
51#define X1205_REG_0 0x10
52#define X1205_REG_Y2K1 0x0F
53#define X1205_REG_DWA1 0x0E
54#define X1205_REG_YRA1 0x0D
55#define X1205_REG_MOA1 0x0C
56#define X1205_REG_DTA1 0x0B
57#define X1205_REG_HRA1 0x0A
58#define X1205_REG_MNA1 0x09
59#define X1205_REG_SCA1 0x08
60#define X1205_REG_Y2K0 0x07
61#define X1205_REG_DWA0 0x06
62#define X1205_REG_YRA0 0x05
63#define X1205_REG_MOA0 0x04
64#define X1205_REG_DTA0 0x03
65#define X1205_REG_HRA0 0x02
66#define X1205_REG_MNA0 0x01
67#define X1205_REG_SCA0 0x00
68
69#define X1205_CCR_BASE 0x30 /* Base address of CCR */
70#define X1205_ALM0_BASE 0x00 /* Base address of ALARM0 */
71
72#define X1205_SR_RTCF 0x01 /* Clock failure */
73#define X1205_SR_WEL 0x02 /* Write Enable Latch */
74#define X1205_SR_RWEL 0x04 /* Register Write Enable */
Michael Hamel471d47e2008-07-04 09:59:30 -070075#define X1205_SR_AL0 0x20 /* Alarm 0 match */
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080076
77#define X1205_DTR_DTR0 0x01
78#define X1205_DTR_DTR1 0x02
79#define X1205_DTR_DTR2 0x04
80
81#define X1205_HR_MIL 0x80 /* Set in ccr.hour for 24 hr mode */
82
Michael Hamel471d47e2008-07-04 09:59:30 -070083#define X1205_INT_AL0E 0x20 /* Alarm 0 enable */
84
Alessandro Zummo4edac2b2008-04-28 02:11:54 -070085static struct i2c_driver x1205_driver;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080086
87/*
88 * In the routines that deal directly with the x1205 hardware, we use
89 * rtc_time -- month 0-11, hour 0-23, yr = calendar year-epoch
90 * Epoch is initialized as 2000. Time is set to UTC.
91 */
92static int x1205_get_datetime(struct i2c_client *client, struct rtc_time *tm,
93 unsigned char reg_base)
94{
95 unsigned char dt_addr[2] = { 0, reg_base };
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080096 unsigned char buf[8];
Michael Hamel471d47e2008-07-04 09:59:30 -070097 int i;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -080098
99 struct i2c_msg msgs[] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700100 {/* setup read ptr */
101 .addr = client->addr,
102 .len = 2,
103 .buf = dt_addr
104 },
105 {/* read date */
106 .addr = client->addr,
107 .flags = I2C_M_RD,
108 .len = 8,
109 .buf = buf
110 },
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800111 };
112
113 /* read date registers */
Michael Hamel471d47e2008-07-04 09:59:30 -0700114 if (i2c_transfer(client->adapter, &msgs[0], 2) != 2) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700115 dev_err(&client->dev, "%s: read error\n", __func__);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800116 return -EIO;
117 }
118
119 dev_dbg(&client->dev,
120 "%s: raw read data - sec=%02x, min=%02x, hr=%02x, "
121 "mday=%02x, mon=%02x, year=%02x, wday=%02x, y2k=%02x\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700122 __func__,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800123 buf[0], buf[1], buf[2], buf[3],
124 buf[4], buf[5], buf[6], buf[7]);
125
Michael Hamel471d47e2008-07-04 09:59:30 -0700126 /* Mask out the enable bits if these are alarm registers */
127 if (reg_base < X1205_CCR_BASE)
128 for (i = 0; i <= 4; i++)
129 buf[i] &= 0x7F;
130
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700131 tm->tm_sec = bcd2bin(buf[CCR_SEC]);
132 tm->tm_min = bcd2bin(buf[CCR_MIN]);
133 tm->tm_hour = bcd2bin(buf[CCR_HOUR] & 0x3F); /* hr is 0-23 */
134 tm->tm_mday = bcd2bin(buf[CCR_MDAY]);
135 tm->tm_mon = bcd2bin(buf[CCR_MONTH]) - 1; /* mon is 0-11 */
136 tm->tm_year = bcd2bin(buf[CCR_YEAR])
137 + (bcd2bin(buf[CCR_Y2K]) * 100) - 1900;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800138 tm->tm_wday = buf[CCR_WDAY];
139
140 dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
141 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700142 __func__,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800143 tm->tm_sec, tm->tm_min, tm->tm_hour,
144 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
145
146 return 0;
147}
148
149static int x1205_get_status(struct i2c_client *client, unsigned char *sr)
150{
151 static unsigned char sr_addr[2] = { 0, X1205_REG_SR };
152
153 struct i2c_msg msgs[] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700154 { /* setup read ptr */
155 .addr = client->addr,
156 .len = 2,
157 .buf = sr_addr
158 },
159 { /* read status */
160 .addr = client->addr,
161 .flags = I2C_M_RD,
162 .len = 1,
163 .buf = sr
164 },
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800165 };
166
167 /* read status register */
Michael Hamel471d47e2008-07-04 09:59:30 -0700168 if (i2c_transfer(client->adapter, &msgs[0], 2) != 2) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700169 dev_err(&client->dev, "%s: read error\n", __func__);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800170 return -EIO;
171 }
172
173 return 0;
174}
175
176static int x1205_set_datetime(struct i2c_client *client, struct rtc_time *tm,
Johannes Weinerd973b632009-12-15 16:46:16 -0800177 u8 reg_base, unsigned char alm_enable)
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800178{
Johannes Weinerd973b632009-12-15 16:46:16 -0800179 int i, xfer;
Michael Hamel471d47e2008-07-04 09:59:30 -0700180 unsigned char rdata[10] = { 0, reg_base };
Johannes Weinerd973b632009-12-15 16:46:16 -0800181 unsigned char *buf = rdata + 2;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800182
183 static const unsigned char wel[3] = { 0, X1205_REG_SR,
184 X1205_SR_WEL };
185
186 static const unsigned char rwel[3] = { 0, X1205_REG_SR,
187 X1205_SR_WEL | X1205_SR_RWEL };
188
189 static const unsigned char diswe[3] = { 0, X1205_REG_SR, 0 };
190
191 dev_dbg(&client->dev,
Johannes Weinerd973b632009-12-15 16:46:16 -0800192 "%s: sec=%d min=%d hour=%d mday=%d mon=%d year=%d wday=%d\n",
193 __func__, tm->tm_sec, tm->tm_min, tm->tm_hour, tm->tm_mday,
194 tm->tm_mon, tm->tm_year, tm->tm_wday);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800195
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700196 buf[CCR_SEC] = bin2bcd(tm->tm_sec);
197 buf[CCR_MIN] = bin2bcd(tm->tm_min);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800198
199 /* set hour and 24hr bit */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700200 buf[CCR_HOUR] = bin2bcd(tm->tm_hour) | X1205_HR_MIL;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800201
Johannes Weinerd973b632009-12-15 16:46:16 -0800202 buf[CCR_MDAY] = bin2bcd(tm->tm_mday);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800203
Johannes Weinerd973b632009-12-15 16:46:16 -0800204 /* month, 1 - 12 */
205 buf[CCR_MONTH] = bin2bcd(tm->tm_mon + 1);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800206
Johannes Weinerd973b632009-12-15 16:46:16 -0800207 /* year, since the rtc epoch*/
208 buf[CCR_YEAR] = bin2bcd(tm->tm_year % 100);
209 buf[CCR_WDAY] = tm->tm_wday & 0x07;
210 buf[CCR_Y2K] = bin2bcd((tm->tm_year + 1900) / 100);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800211
Michael Hamel471d47e2008-07-04 09:59:30 -0700212 /* If writing alarm registers, set compare bits on registers 0-4 */
213 if (reg_base < X1205_CCR_BASE)
214 for (i = 0; i <= 4; i++)
215 buf[i] |= 0x80;
216
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800217 /* this sequence is required to unlock the chip */
Sachin Kamat66e3f102013-07-03 15:06:07 -0700218 xfer = i2c_master_send(client, wel, 3);
219 if (xfer != 3) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700220 dev_err(&client->dev, "%s: wel - %d\n", __func__, xfer);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800221 return -EIO;
222 }
223
Sachin Kamat66e3f102013-07-03 15:06:07 -0700224 xfer = i2c_master_send(client, rwel, 3);
225 if (xfer != 3) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700226 dev_err(&client->dev, "%s: rwel - %d\n", __func__, xfer);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800227 return -EIO;
228 }
229
Johannes Weinerd973b632009-12-15 16:46:16 -0800230 xfer = i2c_master_send(client, rdata, sizeof(rdata));
231 if (xfer != sizeof(rdata)) {
Michael Hamel471d47e2008-07-04 09:59:30 -0700232 dev_err(&client->dev,
233 "%s: result=%d addr=%02x, data=%02x\n",
234 __func__,
235 xfer, rdata[1], rdata[2]);
236 return -EIO;
237 }
238
239 /* If we wrote to the nonvolatile region, wait 10msec for write cycle*/
240 if (reg_base < X1205_CCR_BASE) {
241 unsigned char al0e[3] = { 0, X1205_REG_INT, 0 };
242
243 msleep(10);
244
245 /* ...and set or clear the AL0E bit in the INT register */
246
247 /* Need to set RWEL again as the write has cleared it */
248 xfer = i2c_master_send(client, rwel, 3);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800249 if (xfer != 3) {
250 dev_err(&client->dev,
Michael Hamel471d47e2008-07-04 09:59:30 -0700251 "%s: aloe rwel - %d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700252 __func__,
Michael Hamel471d47e2008-07-04 09:59:30 -0700253 xfer);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800254 return -EIO;
255 }
Michael Hamel471d47e2008-07-04 09:59:30 -0700256
257 if (alm_enable)
258 al0e[2] = X1205_INT_AL0E;
259
260 xfer = i2c_master_send(client, al0e, 3);
261 if (xfer != 3) {
262 dev_err(&client->dev,
263 "%s: al0e - %d\n",
264 __func__,
265 xfer);
266 return -EIO;
267 }
268
269 /* and wait 10msec again for this write to complete */
270 msleep(10);
271 }
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800272
273 /* disable further writes */
Sachin Kamat66e3f102013-07-03 15:06:07 -0700274 xfer = i2c_master_send(client, diswe, 3);
275 if (xfer != 3) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700276 dev_err(&client->dev, "%s: diswe - %d\n", __func__, xfer);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800277 return -EIO;
278 }
279
280 return 0;
281}
282
283static int x1205_fix_osc(struct i2c_client *client)
284{
285 int err;
286 struct rtc_time tm;
287
Johannes Weinercb8799e2009-12-01 13:17:49 -0800288 memset(&tm, 0, sizeof(tm));
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800289
Johannes Weinerd973b632009-12-15 16:46:16 -0800290 err = x1205_set_datetime(client, &tm, X1205_CCR_BASE, 0);
Michael Hamel471d47e2008-07-04 09:59:30 -0700291 if (err < 0)
292 dev_err(&client->dev, "unable to restart the oscillator\n");
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800293
294 return err;
295}
296
297static int x1205_get_dtrim(struct i2c_client *client, int *trim)
298{
299 unsigned char dtr;
300 static unsigned char dtr_addr[2] = { 0, X1205_REG_DTR };
301
302 struct i2c_msg msgs[] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700303 { /* setup read ptr */
304 .addr = client->addr,
305 .len = 2,
306 .buf = dtr_addr
307 },
308 { /* read dtr */
309 .addr = client->addr,
310 .flags = I2C_M_RD,
311 .len = 1,
312 .buf = &dtr
313 },
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800314 };
315
316 /* read dtr register */
Michael Hamel471d47e2008-07-04 09:59:30 -0700317 if (i2c_transfer(client->adapter, &msgs[0], 2) != 2) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700318 dev_err(&client->dev, "%s: read error\n", __func__);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800319 return -EIO;
320 }
321
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700322 dev_dbg(&client->dev, "%s: raw dtr=%x\n", __func__, dtr);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800323
324 *trim = 0;
325
326 if (dtr & X1205_DTR_DTR0)
327 *trim += 20;
328
329 if (dtr & X1205_DTR_DTR1)
330 *trim += 10;
331
332 if (dtr & X1205_DTR_DTR2)
333 *trim = -*trim;
334
335 return 0;
336}
337
338static int x1205_get_atrim(struct i2c_client *client, int *trim)
339{
340 s8 atr;
341 static unsigned char atr_addr[2] = { 0, X1205_REG_ATR };
342
343 struct i2c_msg msgs[] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700344 {/* setup read ptr */
345 .addr = client->addr,
346 .len = 2,
347 .buf = atr_addr
348 },
349 {/* read atr */
350 .addr = client->addr,
351 .flags = I2C_M_RD,
352 .len = 1,
353 .buf = &atr
354 },
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800355 };
356
357 /* read atr register */
Michael Hamel471d47e2008-07-04 09:59:30 -0700358 if (i2c_transfer(client->adapter, &msgs[0], 2) != 2) {
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700359 dev_err(&client->dev, "%s: read error\n", __func__);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800360 return -EIO;
361 }
362
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700363 dev_dbg(&client->dev, "%s: raw atr=%x\n", __func__, atr);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800364
365 /* atr is a two's complement value on 6 bits,
366 * perform sign extension. The formula is
367 * Catr = (atr * 0.25pF) + 11.00pF.
368 */
369 if (atr & 0x20)
370 atr |= 0xC0;
371
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700372 dev_dbg(&client->dev, "%s: raw atr=%x (%d)\n", __func__, atr, atr);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800373
374 *trim = (atr * 250) + 11000;
375
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700376 dev_dbg(&client->dev, "%s: real=%d\n", __func__, *trim);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800377
378 return 0;
379}
380
Sachin Kamat66e3f102013-07-03 15:06:07 -0700381struct x1205_limit {
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800382 unsigned char reg, mask, min, max;
383};
384
385static int x1205_validate_client(struct i2c_client *client)
386{
387 int i, xfer;
388
389 /* Probe array. We will read the register at the specified
390 * address and check if the given bits are zero.
391 */
392 static const unsigned char probe_zero_pattern[] = {
393 /* register, mask */
394 X1205_REG_SR, 0x18,
395 X1205_REG_DTR, 0xF8,
396 X1205_REG_ATR, 0xC0,
397 X1205_REG_INT, 0x18,
398 X1205_REG_0, 0xFF,
399 };
400
401 static const struct x1205_limit probe_limits_pattern[] = {
402 /* register, mask, min, max */
403 { X1205_REG_Y2K, 0xFF, 19, 20 },
404 { X1205_REG_DW, 0xFF, 0, 6 },
405 { X1205_REG_YR, 0xFF, 0, 99 },
406 { X1205_REG_MO, 0xFF, 0, 12 },
407 { X1205_REG_DT, 0xFF, 0, 31 },
408 { X1205_REG_HR, 0x7F, 0, 23 },
409 { X1205_REG_MN, 0xFF, 0, 59 },
410 { X1205_REG_SC, 0xFF, 0, 59 },
411 { X1205_REG_Y2K1, 0xFF, 19, 20 },
412 { X1205_REG_Y2K0, 0xFF, 19, 20 },
413 };
414
415 /* check that registers have bits a 0 where expected */
416 for (i = 0; i < ARRAY_SIZE(probe_zero_pattern); i += 2) {
417 unsigned char buf;
418
419 unsigned char addr[2] = { 0, probe_zero_pattern[i] };
420
421 struct i2c_msg msgs[2] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700422 {
423 .addr = client->addr,
424 .len = 2,
425 .buf = addr
426 },
427 {
428 .addr = client->addr,
429 .flags = I2C_M_RD,
430 .len = 1,
431 .buf = &buf
432 },
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800433 };
434
Sachin Kamat66e3f102013-07-03 15:06:07 -0700435 xfer = i2c_transfer(client->adapter, msgs, 2);
436 if (xfer != 2) {
David Brownella14e1892006-12-10 02:19:02 -0800437 dev_err(&client->dev,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800438 "%s: could not read register %x\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700439 __func__, probe_zero_pattern[i]);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800440
441 return -EIO;
442 }
443
444 if ((buf & probe_zero_pattern[i+1]) != 0) {
David Brownella14e1892006-12-10 02:19:02 -0800445 dev_err(&client->dev,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800446 "%s: register=%02x, zero pattern=%d, value=%x\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700447 __func__, probe_zero_pattern[i], i, buf);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800448
449 return -ENODEV;
450 }
451 }
452
453 /* check limits (only registers with bcd values) */
454 for (i = 0; i < ARRAY_SIZE(probe_limits_pattern); i++) {
455 unsigned char reg, value;
456
457 unsigned char addr[2] = { 0, probe_limits_pattern[i].reg };
458
459 struct i2c_msg msgs[2] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700460 {
461 .addr = client->addr,
462 .len = 2,
463 .buf = addr
464 },
465 {
466 .addr = client->addr,
467 .flags = I2C_M_RD,
468 .len = 1,
469 .buf = &reg
470 },
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800471 };
472
Sachin Kamat66e3f102013-07-03 15:06:07 -0700473 xfer = i2c_transfer(client->adapter, msgs, 2);
474 if (xfer != 2) {
David Brownella14e1892006-12-10 02:19:02 -0800475 dev_err(&client->dev,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800476 "%s: could not read register %x\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700477 __func__, probe_limits_pattern[i].reg);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800478
479 return -EIO;
480 }
481
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700482 value = bcd2bin(reg & probe_limits_pattern[i].mask);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800483
484 if (value > probe_limits_pattern[i].max ||
485 value < probe_limits_pattern[i].min) {
David Brownella14e1892006-12-10 02:19:02 -0800486 dev_dbg(&client->dev,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800487 "%s: register=%x, lim pattern=%d, value=%d\n",
Harvey Harrison2a4e2b82008-04-28 02:12:00 -0700488 __func__, probe_limits_pattern[i].reg,
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800489 i, value);
490
491 return -ENODEV;
492 }
493 }
494
495 return 0;
496}
497
498static int x1205_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
499{
Michael Hamel471d47e2008-07-04 09:59:30 -0700500 int err;
501 unsigned char intreg, status;
502 static unsigned char int_addr[2] = { 0, X1205_REG_INT };
503 struct i2c_client *client = to_i2c_client(dev);
504 struct i2c_msg msgs[] = {
Shubhrajyoti Dc3fe92b2012-10-04 17:14:18 -0700505 { /* setup read ptr */
506 .addr = client->addr,
507 .len = 2,
508 .buf = int_addr
509 },
510 {/* read INT register */
511
512 .addr = client->addr,
513 .flags = I2C_M_RD,
514 .len = 1,
515 .buf = &intreg
516 },
Michael Hamel471d47e2008-07-04 09:59:30 -0700517 };
518
519 /* read interrupt register and status register */
520 if (i2c_transfer(client->adapter, &msgs[0], 2) != 2) {
521 dev_err(&client->dev, "%s: read error\n", __func__);
522 return -EIO;
523 }
524 err = x1205_get_status(client, &status);
525 if (err == 0) {
526 alrm->pending = (status & X1205_SR_AL0) ? 1 : 0;
527 alrm->enabled = (intreg & X1205_INT_AL0E) ? 1 : 0;
528 err = x1205_get_datetime(client, &alrm->time, X1205_ALM0_BASE);
529 }
530 return err;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800531}
532
533static int x1205_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
534{
535 return x1205_set_datetime(to_i2c_client(dev),
Johannes Weinerd973b632009-12-15 16:46:16 -0800536 &alrm->time, X1205_ALM0_BASE, alrm->enabled);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800537}
538
539static int x1205_rtc_read_time(struct device *dev, struct rtc_time *tm)
540{
541 return x1205_get_datetime(to_i2c_client(dev),
542 tm, X1205_CCR_BASE);
543}
544
545static int x1205_rtc_set_time(struct device *dev, struct rtc_time *tm)
546{
547 return x1205_set_datetime(to_i2c_client(dev),
Johannes Weinerd973b632009-12-15 16:46:16 -0800548 tm, X1205_CCR_BASE, 0);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800549}
550
551static int x1205_rtc_proc(struct device *dev, struct seq_file *seq)
552{
553 int err, dtrim, atrim;
554
Sachin Kamat66e3f102013-07-03 15:06:07 -0700555 err = x1205_get_dtrim(to_i2c_client(dev), &dtrim);
556 if (!err)
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800557 seq_printf(seq, "digital_trim\t: %d ppm\n", dtrim);
558
Sachin Kamat66e3f102013-07-03 15:06:07 -0700559 err = x1205_get_atrim(to_i2c_client(dev), &atrim);
560 if (!err)
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800561 seq_printf(seq, "analog_trim\t: %d.%02d pF\n",
562 atrim / 1000, atrim % 1000);
563 return 0;
564}
565
David Brownellff8371a2006-09-30 23:28:17 -0700566static const struct rtc_class_ops x1205_rtc_ops = {
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800567 .proc = x1205_rtc_proc,
568 .read_time = x1205_rtc_read_time,
569 .set_time = x1205_rtc_set_time,
570 .read_alarm = x1205_rtc_read_alarm,
571 .set_alarm = x1205_rtc_set_alarm,
572};
573
574static ssize_t x1205_sysfs_show_atrim(struct device *dev,
575 struct device_attribute *attr, char *buf)
576{
Alessandro Zummo015aefb2006-04-10 22:54:42 -0700577 int err, atrim;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800578
Alessandro Zummo015aefb2006-04-10 22:54:42 -0700579 err = x1205_get_atrim(to_i2c_client(dev), &atrim);
580 if (err)
581 return err;
582
583 return sprintf(buf, "%d.%02d pF\n", atrim / 1000, atrim % 1000);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800584}
585static DEVICE_ATTR(atrim, S_IRUGO, x1205_sysfs_show_atrim, NULL);
586
587static ssize_t x1205_sysfs_show_dtrim(struct device *dev,
588 struct device_attribute *attr, char *buf)
589{
Alessandro Zummo015aefb2006-04-10 22:54:42 -0700590 int err, dtrim;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800591
Alessandro Zummo015aefb2006-04-10 22:54:42 -0700592 err = x1205_get_dtrim(to_i2c_client(dev), &dtrim);
593 if (err)
594 return err;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800595
Alessandro Zummo015aefb2006-04-10 22:54:42 -0700596 return sprintf(buf, "%d ppm\n", dtrim);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800597}
598static DEVICE_ATTR(dtrim, S_IRUGO, x1205_sysfs_show_dtrim, NULL);
599
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700600static int x1205_sysfs_register(struct device *dev)
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800601{
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700602 int err;
603
604 err = device_create_file(dev, &dev_attr_atrim);
605 if (err)
606 return err;
607
608 err = device_create_file(dev, &dev_attr_dtrim);
609 if (err)
610 device_remove_file(dev, &dev_attr_atrim);
611
612 return err;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800613}
614
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700615static void x1205_sysfs_unregister(struct device *dev)
616{
617 device_remove_file(dev, &dev_attr_atrim);
618 device_remove_file(dev, &dev_attr_dtrim);
619}
620
621
Jean Delvared2653e92008-04-29 23:11:39 +0200622static int x1205_probe(struct i2c_client *client,
623 const struct i2c_device_id *id)
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800624{
625 int err = 0;
626 unsigned char sr;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800627 struct rtc_device *rtc;
628
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700629 dev_dbg(&client->dev, "%s\n", __func__);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800630
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700631 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
632 return -ENODEV;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800633
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700634 if (x1205_validate_client(client) < 0)
635 return -ENODEV;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800636
637 dev_info(&client->dev, "chip found, driver version " DRV_VERSION "\n");
638
Jingoo Han17581712013-04-29 16:19:55 -0700639 rtc = devm_rtc_device_register(&client->dev, x1205_driver.driver.name,
640 &x1205_rtc_ops, THIS_MODULE);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800641
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700642 if (IS_ERR(rtc))
643 return PTR_ERR(rtc);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800644
645 i2c_set_clientdata(client, rtc);
646
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300647 /* Check for power failures and eventually enable the osc */
Sachin Kamat66e3f102013-07-03 15:06:07 -0700648 err = x1205_get_status(client, &sr);
649 if (!err) {
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800650 if (sr & X1205_SR_RTCF) {
651 dev_err(&client->dev,
652 "power failure detected, "
653 "please set the clock\n");
654 udelay(50);
655 x1205_fix_osc(client);
656 }
Sachin Kamat66e3f102013-07-03 15:06:07 -0700657 } else {
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800658 dev_err(&client->dev, "couldn't read status\n");
Sachin Kamat66e3f102013-07-03 15:06:07 -0700659 }
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800660
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700661 err = x1205_sysfs_register(&client->dev);
662 if (err)
Jingoo Han17581712013-04-29 16:19:55 -0700663 return err;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800664
665 return 0;
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800666}
667
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700668static int x1205_remove(struct i2c_client *client)
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800669{
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700670 x1205_sysfs_unregister(&client->dev);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800671 return 0;
672}
673
Jean Delvare3760f732008-04-29 23:11:40 +0200674static const struct i2c_device_id x1205_id[] = {
675 { "x1205", 0 },
676 { }
677};
678MODULE_DEVICE_TABLE(i2c, x1205_id);
679
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700680static struct i2c_driver x1205_driver = {
681 .driver = {
682 .name = "rtc-x1205",
683 },
684 .probe = x1205_probe,
685 .remove = x1205_remove,
Jean Delvare3760f732008-04-29 23:11:40 +0200686 .id_table = x1205_id,
Alessandro Zummo4edac2b2008-04-28 02:11:54 -0700687};
688
Axel Lin0abc9202012-03-23 15:02:31 -0700689module_i2c_driver(x1205_driver);
Alessandro Zummo1fec7c62006-03-27 01:16:42 -0800690
691MODULE_AUTHOR(
692 "Karen Spearel <kas111 at gmail dot com>, "
693 "Alessandro Zummo <a.zummo@towertech.it>");
694MODULE_DESCRIPTION("Xicor/Intersil X1205 RTC driver");
695MODULE_LICENSE("GPL");
696MODULE_VERSION(DRV_VERSION);