8d9a5a98afe61a876d34c796d74c19f7490eb510
[firefly-linux-kernel-4.4.55.git] / drivers / hwmon / jc42.c
1 /*
2  * jc42.c - driver for Jedec JC42.4 compliant temperature sensors
3  *
4  * Copyright (c) 2010  Ericsson AB.
5  *
6  * Derived from lm77.c by Andras BALI <drewie@freemail.hu>.
7  *
8  * JC42.4 compliant temperature sensors are typically used on memory modules.
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 as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <linux/jiffies.h>
29 #include <linux/i2c.h>
30 #include <linux/hwmon.h>
31 #include <linux/hwmon-sysfs.h>
32 #include <linux/err.h>
33 #include <linux/mutex.h>
34
35 /* Addresses to scan */
36 static const unsigned short normal_i2c[] = {
37         0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, I2C_CLIENT_END };
38
39 /* JC42 registers. All registers are 16 bit. */
40 #define JC42_REG_CAP            0x00
41 #define JC42_REG_CONFIG         0x01
42 #define JC42_REG_TEMP_UPPER     0x02
43 #define JC42_REG_TEMP_LOWER     0x03
44 #define JC42_REG_TEMP_CRITICAL  0x04
45 #define JC42_REG_TEMP           0x05
46 #define JC42_REG_MANID          0x06
47 #define JC42_REG_DEVICEID       0x07
48
49 /* Status bits in temperature register */
50 #define JC42_ALARM_CRIT_BIT     15
51 #define JC42_ALARM_MAX_BIT      14
52 #define JC42_ALARM_MIN_BIT      13
53
54 /* Configuration register defines */
55 #define JC42_CFG_CRIT_ONLY      (1 << 2)
56 #define JC42_CFG_TCRIT_LOCK     (1 << 6)
57 #define JC42_CFG_EVENT_LOCK     (1 << 7)
58 #define JC42_CFG_SHUTDOWN       (1 << 8)
59 #define JC42_CFG_HYST_SHIFT     9
60 #define JC42_CFG_HYST_MASK      0x03
61
62 /* Capabilities */
63 #define JC42_CAP_RANGE          (1 << 2)
64
65 /* Manufacturer IDs */
66 #define ADT_MANID               0x11d4  /* Analog Devices */
67 #define MAX_MANID               0x004d  /* Maxim */
68 #define IDT_MANID               0x00b3  /* IDT */
69 #define MCP_MANID               0x0054  /* Microchip */
70 #define NXP_MANID               0x1131  /* NXP Semiconductors */
71 #define ONS_MANID               0x1b09  /* ON Semiconductor */
72 #define STM_MANID               0x104a  /* ST Microelectronics */
73
74 /* Supported chips */
75
76 /* Analog Devices */
77 #define ADT7408_DEVID           0x0801
78 #define ADT7408_DEVID_MASK      0xffff
79
80 /* IDT */
81 #define TS3000B3_DEVID          0x2903  /* Also matches TSE2002B3 */
82 #define TS3000B3_DEVID_MASK     0xffff
83
84 /* Maxim */
85 #define MAX6604_DEVID           0x3e00
86 #define MAX6604_DEVID_MASK      0xffff
87
88 /* Microchip */
89 #define MCP98242_DEVID          0x2000
90 #define MCP98242_DEVID_MASK     0xfffc
91
92 #define MCP98243_DEVID          0x2100
93 #define MCP98243_DEVID_MASK     0xfffc
94
95 #define MCP9843_DEVID           0x0000  /* Also matches mcp9805 */
96 #define MCP9843_DEVID_MASK      0xfffe
97
98 /* NXP */
99 #define SE97_DEVID              0xa200
100 #define SE97_DEVID_MASK         0xfffc
101
102 #define SE98_DEVID              0xa100
103 #define SE98_DEVID_MASK         0xfffc
104
105 /* ON Semiconductor */
106 #define CAT6095_DEVID           0x0800  /* Also matches CAT34TS02 */
107 #define CAT6095_DEVID_MASK      0xffe0
108
109 /* ST Microelectronics */
110 #define STTS424_DEVID           0x0101
111 #define STTS424_DEVID_MASK      0xffff
112
113 #define STTS424E_DEVID          0x0000
114 #define STTS424E_DEVID_MASK     0xfffe
115
116 #define STTS2002_DEVID          0x0300
117 #define STTS2002_DEVID_MASK     0xffff
118
119 #define STTS3000_DEVID          0x0200
120 #define STTS3000_DEVID_MASK     0xffff
121
122 static u16 jc42_hysteresis[] = { 0, 1500, 3000, 6000 };
123
124 struct jc42_chips {
125         u16 manid;
126         u16 devid;
127         u16 devid_mask;
128 };
129
130 static struct jc42_chips jc42_chips[] = {
131         { ADT_MANID, ADT7408_DEVID, ADT7408_DEVID_MASK },
132         { IDT_MANID, TS3000B3_DEVID, TS3000B3_DEVID_MASK },
133         { MAX_MANID, MAX6604_DEVID, MAX6604_DEVID_MASK },
134         { MCP_MANID, MCP98242_DEVID, MCP98242_DEVID_MASK },
135         { MCP_MANID, MCP98243_DEVID, MCP98243_DEVID_MASK },
136         { MCP_MANID, MCP9843_DEVID, MCP9843_DEVID_MASK },
137         { NXP_MANID, SE97_DEVID, SE97_DEVID_MASK },
138         { ONS_MANID, CAT6095_DEVID, CAT6095_DEVID_MASK },
139         { NXP_MANID, SE98_DEVID, SE98_DEVID_MASK },
140         { STM_MANID, STTS424_DEVID, STTS424_DEVID_MASK },
141         { STM_MANID, STTS424E_DEVID, STTS424E_DEVID_MASK },
142         { STM_MANID, STTS2002_DEVID, STTS2002_DEVID_MASK },
143         { STM_MANID, STTS3000_DEVID, STTS3000_DEVID_MASK },
144 };
145
146 /* Each client has this additional data */
147 struct jc42_data {
148         struct device   *hwmon_dev;
149         struct mutex    update_lock;    /* protect register access */
150         bool            extended;       /* true if extended range supported */
151         bool            valid;
152         unsigned long   last_updated;   /* In jiffies */
153         u16             orig_config;    /* original configuration */
154         u16             config;         /* current configuration */
155         u16             temp_input;     /* Temperatures */
156         u16             temp_crit;
157         u16             temp_min;
158         u16             temp_max;
159 };
160
161 static int jc42_probe(struct i2c_client *client,
162                       const struct i2c_device_id *id);
163 static int jc42_detect(struct i2c_client *client, struct i2c_board_info *info);
164 static int jc42_remove(struct i2c_client *client);
165 static int jc42_read_value(struct i2c_client *client, u8 reg);
166 static int jc42_write_value(struct i2c_client *client, u8 reg, u16 value);
167
168 static struct jc42_data *jc42_update_device(struct device *dev);
169
170 static const struct i2c_device_id jc42_id[] = {
171         { "adt7408", 0 },
172         { "cat94ts02", 0 },
173         { "cat6095", 0 },
174         { "jc42", 0 },
175         { "max6604", 0 },
176         { "mcp9805", 0 },
177         { "mcp98242", 0 },
178         { "mcp98243", 0 },
179         { "mcp9843", 0 },
180         { "se97", 0 },
181         { "se97b", 0 },
182         { "se98", 0 },
183         { "stts424", 0 },
184         { "stts2002", 0 },
185         { "stts3000", 0 },
186         { "tse2002b3", 0 },
187         { "ts3000b3", 0 },
188         { }
189 };
190 MODULE_DEVICE_TABLE(i2c, jc42_id);
191
192 #ifdef CONFIG_PM
193
194 static int jc42_suspend(struct device *dev)
195 {
196         struct i2c_client *client = to_i2c_client(dev);
197         struct jc42_data *data = i2c_get_clientdata(client);
198
199         data->config |= JC42_CFG_SHUTDOWN;
200         jc42_write_value(client, JC42_REG_CONFIG, data->config);
201         return 0;
202 }
203
204 static int jc42_resume(struct device *dev)
205 {
206         struct i2c_client *client = to_i2c_client(dev);
207         struct jc42_data *data = i2c_get_clientdata(client);
208
209         data->config &= ~JC42_CFG_SHUTDOWN;
210         jc42_write_value(client, JC42_REG_CONFIG, data->config);
211         return 0;
212 }
213
214 static const struct dev_pm_ops jc42_dev_pm_ops = {
215         .suspend = jc42_suspend,
216         .resume = jc42_resume,
217 };
218
219 #define JC42_DEV_PM_OPS (&jc42_dev_pm_ops)
220 #else
221 #define JC42_DEV_PM_OPS NULL
222 #endif /* CONFIG_PM */
223
224 /* This is the driver that will be inserted */
225 static struct i2c_driver jc42_driver = {
226         .class          = I2C_CLASS_SPD,
227         .driver = {
228                 .name   = "jc42",
229                 .pm = JC42_DEV_PM_OPS,
230         },
231         .probe          = jc42_probe,
232         .remove         = jc42_remove,
233         .id_table       = jc42_id,
234         .detect         = jc42_detect,
235         .address_list   = normal_i2c,
236 };
237
238 #define JC42_TEMP_MIN_EXTENDED  (-40000)
239 #define JC42_TEMP_MIN           0
240 #define JC42_TEMP_MAX           125000
241
242 static u16 jc42_temp_to_reg(int temp, bool extended)
243 {
244         int ntemp = SENSORS_LIMIT(temp,
245                                   extended ? JC42_TEMP_MIN_EXTENDED :
246                                   JC42_TEMP_MIN, JC42_TEMP_MAX);
247
248         /* convert from 0.001 to 0.0625 resolution */
249         return (ntemp * 2 / 125) & 0x1fff;
250 }
251
252 static int jc42_temp_from_reg(s16 reg)
253 {
254         reg &= 0x1fff;
255
256         /* sign extend register */
257         if (reg & 0x1000)
258                 reg |= 0xf000;
259
260         /* convert from 0.0625 to 0.001 resolution */
261         return reg * 125 / 2;
262 }
263
264 /* sysfs stuff */
265
266 /* read routines for temperature limits */
267 #define show(value)     \
268 static ssize_t show_##value(struct device *dev,                         \
269                             struct device_attribute *attr,              \
270                             char *buf)                                  \
271 {                                                                       \
272         struct jc42_data *data = jc42_update_device(dev);               \
273         if (IS_ERR(data))                                               \
274                 return PTR_ERR(data);                                   \
275         return sprintf(buf, "%d\n", jc42_temp_from_reg(data->value));   \
276 }
277
278 show(temp_input);
279 show(temp_crit);
280 show(temp_min);
281 show(temp_max);
282
283 /* read routines for hysteresis values */
284 static ssize_t show_temp_crit_hyst(struct device *dev,
285                                    struct device_attribute *attr, char *buf)
286 {
287         struct jc42_data *data = jc42_update_device(dev);
288         int temp, hyst;
289
290         if (IS_ERR(data))
291                 return PTR_ERR(data);
292
293         temp = jc42_temp_from_reg(data->temp_crit);
294         hyst = jc42_hysteresis[(data->config >> JC42_CFG_HYST_SHIFT)
295                                & JC42_CFG_HYST_MASK];
296         return sprintf(buf, "%d\n", temp - hyst);
297 }
298
299 static ssize_t show_temp_max_hyst(struct device *dev,
300                                   struct device_attribute *attr, char *buf)
301 {
302         struct jc42_data *data = jc42_update_device(dev);
303         int temp, hyst;
304
305         if (IS_ERR(data))
306                 return PTR_ERR(data);
307
308         temp = jc42_temp_from_reg(data->temp_max);
309         hyst = jc42_hysteresis[(data->config >> JC42_CFG_HYST_SHIFT)
310                                & JC42_CFG_HYST_MASK];
311         return sprintf(buf, "%d\n", temp - hyst);
312 }
313
314 /* write routines */
315 #define set(value, reg) \
316 static ssize_t set_##value(struct device *dev,                          \
317                            struct device_attribute *attr,               \
318                            const char *buf, size_t count)               \
319 {                                                                       \
320         struct i2c_client *client = to_i2c_client(dev);                 \
321         struct jc42_data *data = i2c_get_clientdata(client);            \
322         int err, ret = count;                                           \
323         long val;                                                       \
324         if (strict_strtol(buf, 10, &val) < 0)                           \
325                 return -EINVAL;                                         \
326         mutex_lock(&data->update_lock);                                 \
327         data->value = jc42_temp_to_reg(val, data->extended);            \
328         err = jc42_write_value(client, reg, data->value);               \
329         if (err < 0)                                                    \
330                 ret = err;                                              \
331         mutex_unlock(&data->update_lock);                               \
332         return ret;                                                     \
333 }
334
335 set(temp_min, JC42_REG_TEMP_LOWER);
336 set(temp_max, JC42_REG_TEMP_UPPER);
337 set(temp_crit, JC42_REG_TEMP_CRITICAL);
338
339 /* JC42.4 compliant chips only support four hysteresis values.
340  * Pick best choice and go from there. */
341 static ssize_t set_temp_crit_hyst(struct device *dev,
342                                   struct device_attribute *attr,
343                                   const char *buf, size_t count)
344 {
345         struct i2c_client *client = to_i2c_client(dev);
346         struct jc42_data *data = i2c_get_clientdata(client);
347         unsigned long val;
348         int diff, hyst;
349         int err;
350         int ret = count;
351
352         if (strict_strtoul(buf, 10, &val) < 0)
353                 return -EINVAL;
354
355         diff = jc42_temp_from_reg(data->temp_crit) - val;
356         hyst = 0;
357         if (diff > 0) {
358                 if (diff < 2250)
359                         hyst = 1;       /* 1.5 degrees C */
360                 else if (diff < 4500)
361                         hyst = 2;       /* 3.0 degrees C */
362                 else
363                         hyst = 3;       /* 6.0 degrees C */
364         }
365
366         mutex_lock(&data->update_lock);
367         data->config = (data->config
368                         & ~(JC42_CFG_HYST_MASK << JC42_CFG_HYST_SHIFT))
369           | (hyst << JC42_CFG_HYST_SHIFT);
370         err = jc42_write_value(client, JC42_REG_CONFIG, data->config);
371         if (err < 0)
372                 ret = err;
373         mutex_unlock(&data->update_lock);
374         return ret;
375 }
376
377 static ssize_t show_alarm(struct device *dev,
378                           struct device_attribute *attr, char *buf)
379 {
380         u16 bit = to_sensor_dev_attr(attr)->index;
381         struct jc42_data *data = jc42_update_device(dev);
382         u16 val;
383
384         if (IS_ERR(data))
385                 return PTR_ERR(data);
386
387         val = data->temp_input;
388         if (bit != JC42_ALARM_CRIT_BIT && (data->config & JC42_CFG_CRIT_ONLY))
389                 val = 0;
390         return sprintf(buf, "%u\n", (val >> bit) & 1);
391 }
392
393 static DEVICE_ATTR(temp1_input, S_IRUGO,
394                    show_temp_input, NULL);
395 static DEVICE_ATTR(temp1_crit, S_IRUGO,
396                    show_temp_crit, set_temp_crit);
397 static DEVICE_ATTR(temp1_min, S_IRUGO,
398                    show_temp_min, set_temp_min);
399 static DEVICE_ATTR(temp1_max, S_IRUGO,
400                    show_temp_max, set_temp_max);
401
402 static DEVICE_ATTR(temp1_crit_hyst, S_IRUGO,
403                    show_temp_crit_hyst, set_temp_crit_hyst);
404 static DEVICE_ATTR(temp1_max_hyst, S_IRUGO,
405                    show_temp_max_hyst, NULL);
406
407 static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL,
408                           JC42_ALARM_CRIT_BIT);
409 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL,
410                           JC42_ALARM_MIN_BIT);
411 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL,
412                           JC42_ALARM_MAX_BIT);
413
414 static struct attribute *jc42_attributes[] = {
415         &dev_attr_temp1_input.attr,
416         &dev_attr_temp1_crit.attr,
417         &dev_attr_temp1_min.attr,
418         &dev_attr_temp1_max.attr,
419         &dev_attr_temp1_crit_hyst.attr,
420         &dev_attr_temp1_max_hyst.attr,
421         &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr,
422         &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
423         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
424         NULL
425 };
426
427 static mode_t jc42_attribute_mode(struct kobject *kobj,
428                                   struct attribute *attr, int index)
429 {
430         struct device *dev = container_of(kobj, struct device, kobj);
431         struct i2c_client *client = to_i2c_client(dev);
432         struct jc42_data *data = i2c_get_clientdata(client);
433         unsigned int config = data->config;
434         bool readonly;
435
436         if (attr == &dev_attr_temp1_crit.attr)
437                 readonly = config & JC42_CFG_TCRIT_LOCK;
438         else if (attr == &dev_attr_temp1_min.attr ||
439                  attr == &dev_attr_temp1_max.attr)
440                 readonly = config & JC42_CFG_EVENT_LOCK;
441         else if (attr == &dev_attr_temp1_crit_hyst.attr)
442                 readonly = config & (JC42_CFG_EVENT_LOCK | JC42_CFG_TCRIT_LOCK);
443         else
444                 readonly = true;
445
446         return S_IRUGO | (readonly ? 0 : S_IWUSR);
447 }
448
449 static const struct attribute_group jc42_group = {
450         .attrs = jc42_attributes,
451         .is_visible = jc42_attribute_mode,
452 };
453
454 /* Return 0 if detection is successful, -ENODEV otherwise */
455 static int jc42_detect(struct i2c_client *new_client,
456                        struct i2c_board_info *info)
457 {
458         struct i2c_adapter *adapter = new_client->adapter;
459         int i, config, cap, manid, devid;
460
461         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
462                                      I2C_FUNC_SMBUS_WORD_DATA))
463                 return -ENODEV;
464
465         cap = jc42_read_value(new_client, JC42_REG_CAP);
466         config = jc42_read_value(new_client, JC42_REG_CONFIG);
467         manid = jc42_read_value(new_client, JC42_REG_MANID);
468         devid = jc42_read_value(new_client, JC42_REG_DEVICEID);
469
470         if (cap < 0 || config < 0 || manid < 0 || devid < 0)
471                 return -ENODEV;
472
473         if ((cap & 0xff00) || (config & 0xf800))
474                 return -ENODEV;
475
476         for (i = 0; i < ARRAY_SIZE(jc42_chips); i++) {
477                 struct jc42_chips *chip = &jc42_chips[i];
478                 if (manid == chip->manid &&
479                     (devid & chip->devid_mask) == chip->devid) {
480                         strlcpy(info->type, "jc42", I2C_NAME_SIZE);
481                         return 0;
482                 }
483         }
484         return -ENODEV;
485 }
486
487 static int jc42_probe(struct i2c_client *new_client,
488                       const struct i2c_device_id *id)
489 {
490         struct jc42_data *data;
491         int config, cap, err;
492
493         data = kzalloc(sizeof(struct jc42_data), GFP_KERNEL);
494         if (!data) {
495                 err = -ENOMEM;
496                 goto exit;
497         }
498
499         i2c_set_clientdata(new_client, data);
500         mutex_init(&data->update_lock);
501
502         cap = jc42_read_value(new_client, JC42_REG_CAP);
503         if (cap < 0) {
504                 err = -EINVAL;
505                 goto exit_free;
506         }
507         data->extended = !!(cap & JC42_CAP_RANGE);
508
509         config = jc42_read_value(new_client, JC42_REG_CONFIG);
510         if (config < 0) {
511                 err = -EINVAL;
512                 goto exit_free;
513         }
514         data->orig_config = config;
515         if (config & JC42_CFG_SHUTDOWN) {
516                 config &= ~JC42_CFG_SHUTDOWN;
517                 jc42_write_value(new_client, JC42_REG_CONFIG, config);
518         }
519         data->config = config;
520
521         /* Register sysfs hooks */
522         err = sysfs_create_group(&new_client->dev.kobj, &jc42_group);
523         if (err)
524                 goto exit_free;
525
526         data->hwmon_dev = hwmon_device_register(&new_client->dev);
527         if (IS_ERR(data->hwmon_dev)) {
528                 err = PTR_ERR(data->hwmon_dev);
529                 goto exit_remove;
530         }
531
532         return 0;
533
534 exit_remove:
535         sysfs_remove_group(&new_client->dev.kobj, &jc42_group);
536 exit_free:
537         kfree(data);
538 exit:
539         return err;
540 }
541
542 static int jc42_remove(struct i2c_client *client)
543 {
544         struct jc42_data *data = i2c_get_clientdata(client);
545         hwmon_device_unregister(data->hwmon_dev);
546         sysfs_remove_group(&client->dev.kobj, &jc42_group);
547         if (data->config != data->orig_config)
548                 jc42_write_value(client, JC42_REG_CONFIG, data->orig_config);
549         kfree(data);
550         return 0;
551 }
552
553 /* All registers are word-sized. */
554 static int jc42_read_value(struct i2c_client *client, u8 reg)
555 {
556         int ret = i2c_smbus_read_word_data(client, reg);
557         if (ret < 0)
558                 return ret;
559         return swab16(ret);
560 }
561
562 static int jc42_write_value(struct i2c_client *client, u8 reg, u16 value)
563 {
564         return i2c_smbus_write_word_data(client, reg, swab16(value));
565 }
566
567 static struct jc42_data *jc42_update_device(struct device *dev)
568 {
569         struct i2c_client *client = to_i2c_client(dev);
570         struct jc42_data *data = i2c_get_clientdata(client);
571         struct jc42_data *ret = data;
572         int val;
573
574         mutex_lock(&data->update_lock);
575
576         if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
577                 val = jc42_read_value(client, JC42_REG_TEMP);
578                 if (val < 0) {
579                         ret = ERR_PTR(val);
580                         goto abort;
581                 }
582                 data->temp_input = val;
583
584                 val = jc42_read_value(client, JC42_REG_TEMP_CRITICAL);
585                 if (val < 0) {
586                         ret = ERR_PTR(val);
587                         goto abort;
588                 }
589                 data->temp_crit = val;
590
591                 val = jc42_read_value(client, JC42_REG_TEMP_LOWER);
592                 if (val < 0) {
593                         ret = ERR_PTR(val);
594                         goto abort;
595                 }
596                 data->temp_min = val;
597
598                 val = jc42_read_value(client, JC42_REG_TEMP_UPPER);
599                 if (val < 0) {
600                         ret = ERR_PTR(val);
601                         goto abort;
602                 }
603                 data->temp_max = val;
604
605                 data->last_updated = jiffies;
606                 data->valid = true;
607         }
608 abort:
609         mutex_unlock(&data->update_lock);
610         return ret;
611 }
612
613 static int __init sensors_jc42_init(void)
614 {
615         return i2c_add_driver(&jc42_driver);
616 }
617
618 static void __exit sensors_jc42_exit(void)
619 {
620         i2c_del_driver(&jc42_driver);
621 }
622
623 MODULE_AUTHOR("Guenter Roeck <guenter.roeck@ericsson.com>");
624 MODULE_DESCRIPTION("JC42 driver");
625 MODULE_LICENSE("GPL");
626
627 module_init(sensors_jc42_init);
628 module_exit(sensors_jc42_exit);