Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
adm1025.c
Go to the documentation of this file.
1 /*
2  * adm1025.c
3  *
4  * Copyright (C) 2000 Chen-Yuan Wu <[email protected]>
5  * Copyright (C) 2003-2009 Jean Delvare <[email protected]>
6  *
7  * The ADM1025 is a sensor chip made by Analog Devices. It reports up to 6
8  * voltages (including its own power source) and up to two temperatures
9  * (its own plus up to one external one). Voltages are scaled internally
10  * (which is not the common way) with ratios such that the nominal value
11  * of each voltage correspond to a register value of 192 (which means a
12  * resolution of about 0.5% of the nominal value). Temperature values are
13  * reported with a 1 deg resolution and a 3 deg accuracy. Complete
14  * datasheet can be obtained from Analog's website at:
15  * http://www.onsemi.com/PowerSolutions/product.do?id=ADM1025
16  *
17  * This driver also supports the ADM1025A, which differs from the ADM1025
18  * only in that it has "open-drain VID inputs while the ADM1025 has
19  * on-chip 100k pull-ups on the VID inputs". It doesn't make any
20  * difference for us.
21  *
22  * This driver also supports the NE1619, a sensor chip made by Philips.
23  * That chip is similar to the ADM1025A, with a few differences. The only
24  * difference that matters to us is that the NE1619 has only two possible
25  * addresses while the ADM1025A has a third one. Complete datasheet can be
26  * obtained from Philips's website at:
27  * http://www.semiconductors.philips.com/pip/NE1619DS.html
28  *
29  * Since the ADM1025 was the first chipset supported by this driver, most
30  * comments will refer to this chipset, but are actually general and
31  * concern all supported chipsets, unless mentioned otherwise.
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License
44  * along with this program; if not, write to the Free Software
45  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
46  */
47 
48 #include <linux/module.h>
49 #include <linux/init.h>
50 #include <linux/slab.h>
51 #include <linux/jiffies.h>
52 #include <linux/i2c.h>
53 #include <linux/hwmon.h>
54 #include <linux/hwmon-sysfs.h>
55 #include <linux/hwmon-vid.h>
56 #include <linux/err.h>
57 #include <linux/mutex.h>
58 
59 /*
60  * Addresses to scan
61  * ADM1025 and ADM1025A have three possible addresses: 0x2c, 0x2d and 0x2e.
62  * NE1619 has two possible addresses: 0x2c and 0x2d.
63  */
64 
65 static const unsigned short normal_i2c[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END };
66 
67 enum chips { adm1025, ne1619 };
68 
69 /*
70  * The ADM1025 registers
71  */
72 
73 #define ADM1025_REG_MAN_ID 0x3E
74 #define ADM1025_REG_CHIP_ID 0x3F
75 #define ADM1025_REG_CONFIG 0x40
76 #define ADM1025_REG_STATUS1 0x41
77 #define ADM1025_REG_STATUS2 0x42
78 #define ADM1025_REG_IN(nr) (0x20 + (nr))
79 #define ADM1025_REG_IN_MAX(nr) (0x2B + (nr) * 2)
80 #define ADM1025_REG_IN_MIN(nr) (0x2C + (nr) * 2)
81 #define ADM1025_REG_TEMP(nr) (0x26 + (nr))
82 #define ADM1025_REG_TEMP_HIGH(nr) (0x37 + (nr) * 2)
83 #define ADM1025_REG_TEMP_LOW(nr) (0x38 + (nr) * 2)
84 #define ADM1025_REG_VID 0x47
85 #define ADM1025_REG_VID4 0x49
86 
87 /*
88  * Conversions and various macros
89  * The ADM1025 uses signed 8-bit values for temperatures.
90  */
91 
92 static const int in_scale[6] = { 2500, 2250, 3300, 5000, 12000, 3300 };
93 
94 #define IN_FROM_REG(reg, scale) (((reg) * (scale) + 96) / 192)
95 #define IN_TO_REG(val, scale) ((val) <= 0 ? 0 : \
96  (val) * 192 >= (scale) * 255 ? 255 : \
97  ((val) * 192 + (scale) / 2) / (scale))
98 
99 #define TEMP_FROM_REG(reg) ((reg) * 1000)
100 #define TEMP_TO_REG(val) ((val) <= -127500 ? -128 : \
101  (val) >= 126500 ? 127 : \
102  (((val) < 0 ? (val) - 500 : \
103  (val) + 500) / 1000))
104 
105 /*
106  * Functions declaration
107  */
108 
109 static int adm1025_probe(struct i2c_client *client,
110  const struct i2c_device_id *id);
111 static int adm1025_detect(struct i2c_client *client,
112  struct i2c_board_info *info);
113 static void adm1025_init_client(struct i2c_client *client);
114 static int adm1025_remove(struct i2c_client *client);
115 static struct adm1025_data *adm1025_update_device(struct device *dev);
116 
117 /*
118  * Driver data (common to all clients)
119  */
120 
121 static const struct i2c_device_id adm1025_id[] = {
122  { "adm1025", adm1025 },
123  { "ne1619", ne1619 },
124  { }
125 };
126 MODULE_DEVICE_TABLE(i2c, adm1025_id);
127 
128 static struct i2c_driver adm1025_driver = {
129  .class = I2C_CLASS_HWMON,
130  .driver = {
131  .name = "adm1025",
132  },
133  .probe = adm1025_probe,
134  .remove = adm1025_remove,
135  .id_table = adm1025_id,
136  .detect = adm1025_detect,
137  .address_list = normal_i2c,
138 };
139 
140 /*
141  * Client data (each client gets its own)
142  */
143 
144 struct adm1025_data {
145  struct device *hwmon_dev;
147  char valid; /* zero until following fields are valid */
148  unsigned long last_updated; /* in jiffies */
149 
150  u8 in[6]; /* register value */
151  u8 in_max[6]; /* register value */
152  u8 in_min[6]; /* register value */
153  s8 temp[2]; /* register value */
154  s8 temp_min[2]; /* register value */
155  s8 temp_max[2]; /* register value */
156  u16 alarms; /* register values, combined */
157  u8 vid; /* register values, combined */
159 };
160 
161 /*
162  * Sysfs stuff
163  */
164 
165 static ssize_t
166 show_in(struct device *dev, struct device_attribute *attr, char *buf)
167 {
168  int index = to_sensor_dev_attr(attr)->index;
169  struct adm1025_data *data = adm1025_update_device(dev);
170  return sprintf(buf, "%u\n", IN_FROM_REG(data->in[index],
171  in_scale[index]));
172 }
173 
174 static ssize_t
175 show_in_min(struct device *dev, struct device_attribute *attr, char *buf)
176 {
177  int index = to_sensor_dev_attr(attr)->index;
178  struct adm1025_data *data = adm1025_update_device(dev);
179  return sprintf(buf, "%u\n", IN_FROM_REG(data->in_min[index],
180  in_scale[index]));
181 }
182 
183 static ssize_t
184 show_in_max(struct device *dev, struct device_attribute *attr, char *buf)
185 {
186  int index = to_sensor_dev_attr(attr)->index;
187  struct adm1025_data *data = adm1025_update_device(dev);
188  return sprintf(buf, "%u\n", IN_FROM_REG(data->in_max[index],
189  in_scale[index]));
190 }
191 
192 static ssize_t
193 show_temp(struct device *dev, struct device_attribute *attr, char *buf)
194 {
195  int index = to_sensor_dev_attr(attr)->index;
196  struct adm1025_data *data = adm1025_update_device(dev);
197  return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[index]));
198 }
199 
200 static ssize_t
201 show_temp_min(struct device *dev, struct device_attribute *attr, char *buf)
202 {
203  int index = to_sensor_dev_attr(attr)->index;
204  struct adm1025_data *data = adm1025_update_device(dev);
205  return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_min[index]));
206 }
207 
208 static ssize_t
209 show_temp_max(struct device *dev, struct device_attribute *attr, char *buf)
210 {
211  int index = to_sensor_dev_attr(attr)->index;
212  struct adm1025_data *data = adm1025_update_device(dev);
213  return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_max[index]));
214 }
215 
216 static ssize_t set_in_min(struct device *dev, struct device_attribute *attr,
217  const char *buf, size_t count)
218 {
219  int index = to_sensor_dev_attr(attr)->index;
220  struct i2c_client *client = to_i2c_client(dev);
221  struct adm1025_data *data = i2c_get_clientdata(client);
222  long val;
223  int err;
224 
225  err = kstrtol(buf, 10, &val);
226  if (err)
227  return err;
228 
229  mutex_lock(&data->update_lock);
230  data->in_min[index] = IN_TO_REG(val, in_scale[index]);
232  data->in_min[index]);
233  mutex_unlock(&data->update_lock);
234  return count;
235 }
236 
237 static ssize_t set_in_max(struct device *dev, struct device_attribute *attr,
238  const char *buf, size_t count)
239 {
240  int index = to_sensor_dev_attr(attr)->index;
241  struct i2c_client *client = to_i2c_client(dev);
242  struct adm1025_data *data = i2c_get_clientdata(client);
243  long val;
244  int err;
245 
246  err = kstrtol(buf, 10, &val);
247  if (err)
248  return err;
249 
250  mutex_lock(&data->update_lock);
251  data->in_max[index] = IN_TO_REG(val, in_scale[index]);
253  data->in_max[index]);
254  mutex_unlock(&data->update_lock);
255  return count;
256 }
257 
258 #define set_in(offset) \
259 static SENSOR_DEVICE_ATTR(in##offset##_input, S_IRUGO, \
260  show_in, NULL, offset); \
261 static SENSOR_DEVICE_ATTR(in##offset##_min, S_IWUSR | S_IRUGO, \
262  show_in_min, set_in_min, offset); \
263 static SENSOR_DEVICE_ATTR(in##offset##_max, S_IWUSR | S_IRUGO, \
264  show_in_max, set_in_max, offset)
265 set_in(0);
266 set_in(1);
267 set_in(2);
268 set_in(3);
269 set_in(4);
270 set_in(5);
271 
272 static ssize_t set_temp_min(struct device *dev, struct device_attribute *attr,
273  const char *buf, size_t count)
274 {
275  int index = to_sensor_dev_attr(attr)->index;
276  struct i2c_client *client = to_i2c_client(dev);
277  struct adm1025_data *data = i2c_get_clientdata(client);
278  long val;
279  int err;
280 
281  err = kstrtol(buf, 10, &val);
282  if (err)
283  return err;
284 
285  mutex_lock(&data->update_lock);
286  data->temp_min[index] = TEMP_TO_REG(val);
288  data->temp_min[index]);
289  mutex_unlock(&data->update_lock);
290  return count;
291 }
292 
293 static ssize_t set_temp_max(struct device *dev, struct device_attribute *attr,
294  const char *buf, size_t count)
295 {
296  int index = to_sensor_dev_attr(attr)->index;
297  struct i2c_client *client = to_i2c_client(dev);
298  struct adm1025_data *data = i2c_get_clientdata(client);
299  long val;
300  int err;
301 
302  err = kstrtol(buf, 10, &val);
303  if (err)
304  return err;
305 
306  mutex_lock(&data->update_lock);
307  data->temp_max[index] = TEMP_TO_REG(val);
309  data->temp_max[index]);
310  mutex_unlock(&data->update_lock);
311  return count;
312 }
313 
314 #define set_temp(offset) \
315 static SENSOR_DEVICE_ATTR(temp##offset##_input, S_IRUGO, \
316  show_temp, NULL, offset - 1); \
317 static SENSOR_DEVICE_ATTR(temp##offset##_min, S_IWUSR | S_IRUGO, \
318  show_temp_min, set_temp_min, offset - 1); \
319 static SENSOR_DEVICE_ATTR(temp##offset##_max, S_IWUSR | S_IRUGO, \
320  show_temp_max, set_temp_max, offset - 1)
321 set_temp(1);
322 set_temp(2);
323 
324 static ssize_t
325 show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
326 {
327  struct adm1025_data *data = adm1025_update_device(dev);
328  return sprintf(buf, "%u\n", data->alarms);
329 }
330 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
331 
332 static ssize_t
333 show_alarm(struct device *dev, struct device_attribute *attr, char *buf)
334 {
335  int bitnr = to_sensor_dev_attr(attr)->index;
336  struct adm1025_data *data = adm1025_update_device(dev);
337  return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
338 }
339 static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
340 static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
341 static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
342 static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
343 static SENSOR_DEVICE_ATTR(in4_alarm, S_IRUGO, show_alarm, NULL, 8);
344 static SENSOR_DEVICE_ATTR(in5_alarm, S_IRUGO, show_alarm, NULL, 9);
345 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 5);
346 static SENSOR_DEVICE_ATTR(temp2_alarm, S_IRUGO, show_alarm, NULL, 4);
347 static SENSOR_DEVICE_ATTR(temp1_fault, S_IRUGO, show_alarm, NULL, 14);
348 
349 static ssize_t
350 show_vid(struct device *dev, struct device_attribute *attr, char *buf)
351 {
352  struct adm1025_data *data = adm1025_update_device(dev);
353  return sprintf(buf, "%u\n", vid_from_reg(data->vid, data->vrm));
354 }
355 static DEVICE_ATTR(cpu0_vid, S_IRUGO, show_vid, NULL);
356 
357 static ssize_t
358 show_vrm(struct device *dev, struct device_attribute *attr, char *buf)
359 {
360  struct adm1025_data *data = dev_get_drvdata(dev);
361  return sprintf(buf, "%u\n", data->vrm);
362 }
363 static ssize_t set_vrm(struct device *dev, struct device_attribute *attr,
364  const char *buf, size_t count)
365 {
366  struct adm1025_data *data = dev_get_drvdata(dev);
367  unsigned long val;
368  int err;
369 
370  err = kstrtoul(buf, 10, &val);
371  if (err)
372  return err;
373 
374  data->vrm = val;
375  return count;
376 }
377 static DEVICE_ATTR(vrm, S_IRUGO | S_IWUSR, show_vrm, set_vrm);
378 
379 /*
380  * Real code
381  */
382 
383 static struct attribute *adm1025_attributes[] = {
384  &sensor_dev_attr_in0_input.dev_attr.attr,
385  &sensor_dev_attr_in1_input.dev_attr.attr,
386  &sensor_dev_attr_in2_input.dev_attr.attr,
387  &sensor_dev_attr_in3_input.dev_attr.attr,
388  &sensor_dev_attr_in5_input.dev_attr.attr,
389  &sensor_dev_attr_in0_min.dev_attr.attr,
390  &sensor_dev_attr_in1_min.dev_attr.attr,
391  &sensor_dev_attr_in2_min.dev_attr.attr,
392  &sensor_dev_attr_in3_min.dev_attr.attr,
393  &sensor_dev_attr_in5_min.dev_attr.attr,
394  &sensor_dev_attr_in0_max.dev_attr.attr,
395  &sensor_dev_attr_in1_max.dev_attr.attr,
396  &sensor_dev_attr_in2_max.dev_attr.attr,
397  &sensor_dev_attr_in3_max.dev_attr.attr,
398  &sensor_dev_attr_in5_max.dev_attr.attr,
399  &sensor_dev_attr_in0_alarm.dev_attr.attr,
400  &sensor_dev_attr_in1_alarm.dev_attr.attr,
401  &sensor_dev_attr_in2_alarm.dev_attr.attr,
402  &sensor_dev_attr_in3_alarm.dev_attr.attr,
403  &sensor_dev_attr_in5_alarm.dev_attr.attr,
404  &sensor_dev_attr_temp1_input.dev_attr.attr,
405  &sensor_dev_attr_temp2_input.dev_attr.attr,
406  &sensor_dev_attr_temp1_min.dev_attr.attr,
407  &sensor_dev_attr_temp2_min.dev_attr.attr,
408  &sensor_dev_attr_temp1_max.dev_attr.attr,
409  &sensor_dev_attr_temp2_max.dev_attr.attr,
410  &sensor_dev_attr_temp1_alarm.dev_attr.attr,
411  &sensor_dev_attr_temp2_alarm.dev_attr.attr,
412  &sensor_dev_attr_temp1_fault.dev_attr.attr,
413  &dev_attr_alarms.attr,
414  &dev_attr_cpu0_vid.attr,
415  &dev_attr_vrm.attr,
416  NULL
417 };
418 
419 static const struct attribute_group adm1025_group = {
420  .attrs = adm1025_attributes,
421 };
422 
423 static struct attribute *adm1025_attributes_in4[] = {
424  &sensor_dev_attr_in4_input.dev_attr.attr,
425  &sensor_dev_attr_in4_min.dev_attr.attr,
426  &sensor_dev_attr_in4_max.dev_attr.attr,
427  &sensor_dev_attr_in4_alarm.dev_attr.attr,
428  NULL
429 };
430 
431 static const struct attribute_group adm1025_group_in4 = {
432  .attrs = adm1025_attributes_in4,
433 };
434 
435 /* Return 0 if detection is successful, -ENODEV otherwise */
436 static int adm1025_detect(struct i2c_client *client,
437  struct i2c_board_info *info)
438 {
439  struct i2c_adapter *adapter = client->adapter;
440  const char *name;
441  u8 man_id, chip_id;
442 
443  if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
444  return -ENODEV;
445 
446  /* Check for unused bits */
447  if ((i2c_smbus_read_byte_data(client, ADM1025_REG_CONFIG) & 0x80)
448  || (i2c_smbus_read_byte_data(client, ADM1025_REG_STATUS1) & 0xC0)
449  || (i2c_smbus_read_byte_data(client, ADM1025_REG_STATUS2) & 0xBC)) {
450  dev_dbg(&adapter->dev, "ADM1025 detection failed at 0x%02x\n",
451  client->addr);
452  return -ENODEV;
453  }
454 
455  /* Identification */
457  if ((chip_id & 0xF0) != 0x20)
458  return -ENODEV;
459 
461  if (man_id == 0x41)
462  name = "adm1025";
463  else if (man_id == 0xA1 && client->addr != 0x2E)
464  name = "ne1619";
465  else
466  return -ENODEV;
467 
468  strlcpy(info->type, name, I2C_NAME_SIZE);
469 
470  return 0;
471 }
472 
473 static int adm1025_probe(struct i2c_client *client,
474  const struct i2c_device_id *id)
475 {
476  struct adm1025_data *data;
477  int err;
478  u8 config;
479 
480  data = devm_kzalloc(&client->dev, sizeof(struct adm1025_data),
481  GFP_KERNEL);
482  if (!data)
483  return -ENOMEM;
484 
485  i2c_set_clientdata(client, data);
486  mutex_init(&data->update_lock);
487 
488  /* Initialize the ADM1025 chip */
489  adm1025_init_client(client);
490 
491  /* Register sysfs hooks */
492  err = sysfs_create_group(&client->dev.kobj, &adm1025_group);
493  if (err)
494  return err;
495 
496  /* Pin 11 is either in4 (+12V) or VID4 */
498  if (!(config & 0x20)) {
499  err = sysfs_create_group(&client->dev.kobj, &adm1025_group_in4);
500  if (err)
501  goto exit_remove;
502  }
503 
504  data->hwmon_dev = hwmon_device_register(&client->dev);
505  if (IS_ERR(data->hwmon_dev)) {
506  err = PTR_ERR(data->hwmon_dev);
507  goto exit_remove;
508  }
509 
510  return 0;
511 
512 exit_remove:
513  sysfs_remove_group(&client->dev.kobj, &adm1025_group);
514  sysfs_remove_group(&client->dev.kobj, &adm1025_group_in4);
515  return err;
516 }
517 
518 static void adm1025_init_client(struct i2c_client *client)
519 {
520  u8 reg;
521  struct adm1025_data *data = i2c_get_clientdata(client);
522  int i;
523 
524  data->vrm = vid_which_vrm();
525 
526  /*
527  * Set high limits
528  * Usually we avoid setting limits on driver init, but it happens
529  * that the ADM1025 comes with stupid default limits (all registers
530  * set to 0). In case the chip has not gone through any limit
531  * setting yet, we better set the high limits to the max so that
532  * no alarm triggers.
533  */
534  for (i = 0; i < 6; i++) {
535  reg = i2c_smbus_read_byte_data(client,
536  ADM1025_REG_IN_MAX(i));
537  if (reg == 0)
540  0xFF);
541  }
542  for (i = 0; i < 2; i++) {
543  reg = i2c_smbus_read_byte_data(client,
545  if (reg == 0)
548  0x7F);
549  }
550 
551  /*
552  * Start the conversions
553  */
555  if (!(reg & 0x01))
557  (reg&0x7E)|0x01);
558 }
559 
560 static int adm1025_remove(struct i2c_client *client)
561 {
562  struct adm1025_data *data = i2c_get_clientdata(client);
563 
565  sysfs_remove_group(&client->dev.kobj, &adm1025_group);
566  sysfs_remove_group(&client->dev.kobj, &adm1025_group_in4);
567 
568  return 0;
569 }
570 
571 static struct adm1025_data *adm1025_update_device(struct device *dev)
572 {
573  struct i2c_client *client = to_i2c_client(dev);
574  struct adm1025_data *data = i2c_get_clientdata(client);
575 
576  mutex_lock(&data->update_lock);
577 
578  if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
579  int i;
580 
581  dev_dbg(&client->dev, "Updating data.\n");
582  for (i = 0; i < 6; i++) {
583  data->in[i] = i2c_smbus_read_byte_data(client,
584  ADM1025_REG_IN(i));
585  data->in_min[i] = i2c_smbus_read_byte_data(client,
586  ADM1025_REG_IN_MIN(i));
587  data->in_max[i] = i2c_smbus_read_byte_data(client,
588  ADM1025_REG_IN_MAX(i));
589  }
590  for (i = 0; i < 2; i++) {
591  data->temp[i] = i2c_smbus_read_byte_data(client,
592  ADM1025_REG_TEMP(i));
593  data->temp_min[i] = i2c_smbus_read_byte_data(client,
595  data->temp_max[i] = i2c_smbus_read_byte_data(client,
597  }
598  data->alarms = i2c_smbus_read_byte_data(client,
600  | (i2c_smbus_read_byte_data(client,
601  ADM1025_REG_STATUS2) << 8);
602  data->vid = (i2c_smbus_read_byte_data(client,
603  ADM1025_REG_VID) & 0x0f)
604  | ((i2c_smbus_read_byte_data(client,
605  ADM1025_REG_VID4) & 0x01) << 4);
606 
607  data->last_updated = jiffies;
608  data->valid = 1;
609  }
610 
611  mutex_unlock(&data->update_lock);
612 
613  return data;
614 }
615 
616 module_i2c_driver(adm1025_driver);
617 
618 MODULE_AUTHOR("Jean Delvare <[email protected]>");
619 MODULE_DESCRIPTION("ADM1025 driver");
620 MODULE_LICENSE("GPL");