blob: 7897754f3a5c3187a77786325ae3ab875af457fc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * max1619.c - Part of lm_sensors, Linux kernel modules for hardware
3 * monitoring
4 * Copyright (C) 2003-2004 Alexey Fisher <fishor@mail.ru>
5 * Jean Delvare <khali@linux-fr.org>
6 *
7 * Based on the lm90 driver. The MAX1619 is a sensor chip made by Maxim.
8 * It reports up to two temperatures (its own plus up to
9 * one external one). Complete datasheet can be
10 * obtained from Maxim's website at:
11 * http://pdfserv.maxim-ic.com/en/ds/MAX1619.pdf
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 */
27
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/module.h>
30#include <linux/init.h>
31#include <linux/slab.h>
32#include <linux/jiffies.h>
33#include <linux/i2c.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040034#include <linux/hwmon.h>
Jean Delvare71062ff2008-01-06 15:27:59 +010035#include <linux/hwmon-sysfs.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040036#include <linux/err.h>
Ingo Molnar9a61bf62006-01-18 23:19:26 +010037#include <linux/mutex.h>
Jean Delvarea5ebe662006-09-24 21:24:46 +020038#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Mark M. Hoffman25e9c862008-02-17 22:28:03 -050040static const unsigned short normal_i2c[] = {
41 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END };
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43/*
44 * Insmod parameters
45 */
46
Jean Delvaref4b50262005-07-31 21:49:03 +020047I2C_CLIENT_INSMOD_1(max1619);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49/*
50 * The MAX1619 registers
51 */
52
53#define MAX1619_REG_R_MAN_ID 0xFE
54#define MAX1619_REG_R_CHIP_ID 0xFF
55#define MAX1619_REG_R_CONFIG 0x03
56#define MAX1619_REG_W_CONFIG 0x09
57#define MAX1619_REG_R_CONVRATE 0x04
58#define MAX1619_REG_W_CONVRATE 0x0A
59#define MAX1619_REG_R_STATUS 0x02
60#define MAX1619_REG_R_LOCAL_TEMP 0x00
61#define MAX1619_REG_R_REMOTE_TEMP 0x01
62#define MAX1619_REG_R_REMOTE_HIGH 0x07
63#define MAX1619_REG_W_REMOTE_HIGH 0x0D
64#define MAX1619_REG_R_REMOTE_LOW 0x08
65#define MAX1619_REG_W_REMOTE_LOW 0x0E
66#define MAX1619_REG_R_REMOTE_CRIT 0x10
67#define MAX1619_REG_W_REMOTE_CRIT 0x12
68#define MAX1619_REG_R_TCRIT_HYST 0x11
69#define MAX1619_REG_W_TCRIT_HYST 0x13
70
71/*
Andrew Mortona80e8ee2008-10-17 17:51:16 +020072 * Conversions
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 */
74
Andrew Mortona80e8ee2008-10-17 17:51:16 +020075static int temp_from_reg(int val)
76{
77 return (val & 0x80 ? val-0x100 : val) * 1000;
78}
79
80static int temp_to_reg(int val)
81{
82 return (val < 0 ? val+0x100*1000 : val) / 1000;
83}
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85/*
86 * Functions declaration
87 */
88
Jean Delvarec6d3f6f2008-07-16 19:30:15 +020089static int max1619_probe(struct i2c_client *client,
90 const struct i2c_device_id *id);
91static int max1619_detect(struct i2c_client *client, int kind,
92 struct i2c_board_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093static void max1619_init_client(struct i2c_client *client);
Jean Delvarec6d3f6f2008-07-16 19:30:15 +020094static int max1619_remove(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095static struct max1619_data *max1619_update_device(struct device *dev);
96
97/*
98 * Driver data (common to all clients)
99 */
100
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200101static const struct i2c_device_id max1619_id[] = {
102 { "max1619", max1619 },
103 { }
104};
105MODULE_DEVICE_TABLE(i2c, max1619_id);
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107static struct i2c_driver max1619_driver = {
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200108 .class = I2C_CLASS_HWMON,
Laurent Riffardcdaf7932005-11-26 20:37:41 +0100109 .driver = {
Laurent Riffardcdaf7932005-11-26 20:37:41 +0100110 .name = "max1619",
111 },
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200112 .probe = max1619_probe,
113 .remove = max1619_remove,
114 .id_table = max1619_id,
115 .detect = max1619_detect,
116 .address_data = &addr_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117};
118
119/*
120 * Client data (each client gets its own)
121 */
122
123struct max1619_data {
Tony Jones1beeffe2007-08-20 13:46:20 -0700124 struct device *hwmon_dev;
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100125 struct mutex update_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 char valid; /* zero until following fields are valid */
127 unsigned long last_updated; /* in jiffies */
128
129 /* registers values */
130 u8 temp_input1; /* local */
131 u8 temp_input2, temp_low2, temp_high2; /* remote */
132 u8 temp_crit2;
133 u8 temp_hyst2;
134 u8 alarms;
135};
136
137/*
138 * Sysfs stuff
139 */
140
141#define show_temp(value) \
Yani Ioannou8627f9b2005-05-17 06:42:03 -0400142static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{ \
144 struct max1619_data *data = max1619_update_device(dev); \
Andrew Mortona80e8ee2008-10-17 17:51:16 +0200145 return sprintf(buf, "%d\n", temp_from_reg(data->value)); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147show_temp(temp_input1);
148show_temp(temp_input2);
149show_temp(temp_low2);
150show_temp(temp_high2);
151show_temp(temp_crit2);
152show_temp(temp_hyst2);
153
154#define set_temp2(value, reg) \
Yani Ioannou8627f9b2005-05-17 06:42:03 -0400155static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 size_t count) \
157{ \
158 struct i2c_client *client = to_i2c_client(dev); \
159 struct max1619_data *data = i2c_get_clientdata(client); \
160 long val = simple_strtol(buf, NULL, 10); \
161 \
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100162 mutex_lock(&data->update_lock); \
Andrew Mortona80e8ee2008-10-17 17:51:16 +0200163 data->value = temp_to_reg(val); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 i2c_smbus_write_byte_data(client, reg, data->value); \
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100165 mutex_unlock(&data->update_lock); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 return count; \
167}
168
169set_temp2(temp_low2, MAX1619_REG_W_REMOTE_LOW);
170set_temp2(temp_high2, MAX1619_REG_W_REMOTE_HIGH);
171set_temp2(temp_crit2, MAX1619_REG_W_REMOTE_CRIT);
172set_temp2(temp_hyst2, MAX1619_REG_W_TCRIT_HYST);
173
Yani Ioannou8627f9b2005-05-17 06:42:03 -0400174static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175{
176 struct max1619_data *data = max1619_update_device(dev);
177 return sprintf(buf, "%d\n", data->alarms);
178}
179
Jean Delvare71062ff2008-01-06 15:27:59 +0100180static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
181 char *buf)
182{
183 int bitnr = to_sensor_dev_attr(attr)->index;
184 struct max1619_data *data = max1619_update_device(dev);
185 return sprintf(buf, "%d\n", (data->alarms >> bitnr) & 1);
186}
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input1, NULL);
189static DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_input2, NULL);
190static DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_low2,
191 set_temp_low2);
192static DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_high2,
193 set_temp_high2);
194static DEVICE_ATTR(temp2_crit, S_IWUSR | S_IRUGO, show_temp_crit2,
195 set_temp_crit2);
196static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp_hyst2,
197 set_temp_hyst2);
198static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
Jean Delvare71062ff2008-01-06 15:27:59 +0100199static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
200static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
201static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
202static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Jean Delvarea5ebe662006-09-24 21:24:46 +0200204static struct attribute *max1619_attributes[] = {
205 &dev_attr_temp1_input.attr,
206 &dev_attr_temp2_input.attr,
207 &dev_attr_temp2_min.attr,
208 &dev_attr_temp2_max.attr,
209 &dev_attr_temp2_crit.attr,
210 &dev_attr_temp2_crit_hyst.attr,
211
212 &dev_attr_alarms.attr,
Jean Delvare71062ff2008-01-06 15:27:59 +0100213 &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
214 &sensor_dev_attr_temp2_fault.dev_attr.attr,
215 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
216 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
Jean Delvarea5ebe662006-09-24 21:24:46 +0200217 NULL
218};
219
220static const struct attribute_group max1619_group = {
221 .attrs = max1619_attributes,
222};
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224/*
225 * Real code
226 */
227
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200228/* Return 0 if detection is successful, -ENODEV otherwise */
229static int max1619_detect(struct i2c_client *new_client, int kind,
230 struct i2c_board_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200232 struct i2c_adapter *adapter = new_client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 u8 reg_config=0, reg_convrate=0, reg_status=0;
Andrew Mortonb0020e32005-11-07 01:01:49 -0800234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200236 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 /*
239 * Now we do the remaining detection. A negative kind means that
240 * the driver was loaded with no force parameter (default), so we
241 * must both detect and identify the chip. A zero kind means that
242 * the driver was loaded with the force parameter, the detection
243 * step shall be skipped. A positive kind means that the driver
244 * was loaded with the force parameter and a given kind of chip is
245 * requested, so both the detection and the identification steps
246 * are skipped.
247 */
248 if (kind < 0) { /* detection */
249 reg_config = i2c_smbus_read_byte_data(new_client,
250 MAX1619_REG_R_CONFIG);
251 reg_convrate = i2c_smbus_read_byte_data(new_client,
252 MAX1619_REG_R_CONVRATE);
253 reg_status = i2c_smbus_read_byte_data(new_client,
254 MAX1619_REG_R_STATUS);
255 if ((reg_config & 0x03) != 0x00
256 || reg_convrate > 0x07 || (reg_status & 0x61 ) !=0x00) {
257 dev_dbg(&adapter->dev,
258 "MAX1619 detection failed at 0x%02x.\n",
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200259 new_client->addr);
260 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 }
262 }
263
264 if (kind <= 0) { /* identification */
Andrew Mortonb0020e32005-11-07 01:01:49 -0800265 u8 man_id, chip_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267 man_id = i2c_smbus_read_byte_data(new_client,
268 MAX1619_REG_R_MAN_ID);
269 chip_id = i2c_smbus_read_byte_data(new_client,
270 MAX1619_REG_R_CHIP_ID);
271
Andrew Mortonb0020e32005-11-07 01:01:49 -0800272 if ((man_id == 0x4D) && (chip_id == 0x04))
273 kind = max1619;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275 if (kind <= 0) { /* identification failed */
276 dev_info(&adapter->dev,
277 "Unsupported chip (man_id=0x%02X, "
278 "chip_id=0x%02X).\n", man_id, chip_id);
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200279 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 }
282
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200283 strlcpy(info->type, "max1619", I2C_NAME_SIZE);
Andrew Mortonb0020e32005-11-07 01:01:49 -0800284
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200285 return 0;
286}
287
288static int max1619_probe(struct i2c_client *new_client,
289 const struct i2c_device_id *id)
290{
291 struct max1619_data *data;
292 int err;
293
294 data = kzalloc(sizeof(struct max1619_data), GFP_KERNEL);
295 if (!data) {
296 err = -ENOMEM;
297 goto exit;
298 }
299
300 i2c_set_clientdata(new_client, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 data->valid = 0;
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100302 mutex_init(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 /* Initialize the MAX1619 chip */
305 max1619_init_client(new_client);
306
307 /* Register sysfs hooks */
Jean Delvarea5ebe662006-09-24 21:24:46 +0200308 if ((err = sysfs_create_group(&new_client->dev.kobj, &max1619_group)))
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200309 goto exit_free;
Jean Delvarea5ebe662006-09-24 21:24:46 +0200310
Tony Jones1beeffe2007-08-20 13:46:20 -0700311 data->hwmon_dev = hwmon_device_register(&new_client->dev);
312 if (IS_ERR(data->hwmon_dev)) {
313 err = PTR_ERR(data->hwmon_dev);
Jean Delvarea5ebe662006-09-24 21:24:46 +0200314 goto exit_remove_files;
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400315 }
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 return 0;
318
Jean Delvarea5ebe662006-09-24 21:24:46 +0200319exit_remove_files:
320 sysfs_remove_group(&new_client->dev.kobj, &max1619_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321exit_free:
322 kfree(data);
323exit:
324 return err;
325}
326
327static void max1619_init_client(struct i2c_client *client)
328{
329 u8 config;
330
331 /*
332 * Start the conversions.
333 */
334 i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONVRATE,
335 5); /* 2 Hz */
336 config = i2c_smbus_read_byte_data(client, MAX1619_REG_R_CONFIG);
337 if (config & 0x40)
338 i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONFIG,
339 config & 0xBF); /* run */
340}
341
Jean Delvarec6d3f6f2008-07-16 19:30:15 +0200342static int max1619_remove(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400344 struct max1619_data *data = i2c_get_clientdata(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Tony Jones1beeffe2007-08-20 13:46:20 -0700346 hwmon_device_unregister(data->hwmon_dev);
Jean Delvarea5ebe662006-09-24 21:24:46 +0200347 sysfs_remove_group(&client->dev.kobj, &max1619_group);
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400348
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400349 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 return 0;
351}
352
353static struct max1619_data *max1619_update_device(struct device *dev)
354{
355 struct i2c_client *client = to_i2c_client(dev);
356 struct max1619_data *data = i2c_get_clientdata(client);
357
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100358 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
361 dev_dbg(&client->dev, "Updating max1619 data.\n");
362 data->temp_input1 = i2c_smbus_read_byte_data(client,
363 MAX1619_REG_R_LOCAL_TEMP);
364 data->temp_input2 = i2c_smbus_read_byte_data(client,
365 MAX1619_REG_R_REMOTE_TEMP);
366 data->temp_high2 = i2c_smbus_read_byte_data(client,
367 MAX1619_REG_R_REMOTE_HIGH);
368 data->temp_low2 = i2c_smbus_read_byte_data(client,
369 MAX1619_REG_R_REMOTE_LOW);
370 data->temp_crit2 = i2c_smbus_read_byte_data(client,
371 MAX1619_REG_R_REMOTE_CRIT);
372 data->temp_hyst2 = i2c_smbus_read_byte_data(client,
373 MAX1619_REG_R_TCRIT_HYST);
374 data->alarms = i2c_smbus_read_byte_data(client,
375 MAX1619_REG_R_STATUS);
376
377 data->last_updated = jiffies;
378 data->valid = 1;
379 }
380
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100381 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 return data;
384}
385
386static int __init sensors_max1619_init(void)
387{
388 return i2c_add_driver(&max1619_driver);
389}
390
391static void __exit sensors_max1619_exit(void)
392{
393 i2c_del_driver(&max1619_driver);
394}
395
Jean Delvare368609c2005-07-29 12:15:07 -0700396MODULE_AUTHOR("Alexey Fisher <fishor@mail.ru> and "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 "Jean Delvare <khali@linux-fr.org>");
398MODULE_DESCRIPTION("MAX1619 sensor driver");
399MODULE_LICENSE("GPL");
400
401module_init(sensors_max1619_init);
402module_exit(sensors_max1619_exit);