blob: a53d7df92ba231314323d3f8adc67f97fb7359e7 [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>
34#include <linux/i2c-sensor.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040035#include <linux/hwmon.h>
36#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38static unsigned short normal_i2c[] = { 0x18, 0x19, 0x1a,
39 0x29, 0x2a, 0x2b,
40 0x4c, 0x4d, 0x4e,
41 I2C_CLIENT_END };
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43/*
44 * Insmod parameters
45 */
46
47SENSORS_INSMOD_1(max1619);
48
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/*
72 * Conversions and various macros
73 */
74
75#define TEMP_FROM_REG(val) ((val & 0x80 ? val-0x100 : val) * 1000)
76#define TEMP_TO_REG(val) ((val < 0 ? val+0x100*1000 : val) / 1000)
77
78/*
79 * Functions declaration
80 */
81
82static int max1619_attach_adapter(struct i2c_adapter *adapter);
83static int max1619_detect(struct i2c_adapter *adapter, int address,
84 int kind);
85static void max1619_init_client(struct i2c_client *client);
86static int max1619_detach_client(struct i2c_client *client);
87static struct max1619_data *max1619_update_device(struct device *dev);
88
89/*
90 * Driver data (common to all clients)
91 */
92
93static struct i2c_driver max1619_driver = {
94 .owner = THIS_MODULE,
95 .name = "max1619",
96 .flags = I2C_DF_NOTIFY,
97 .attach_adapter = max1619_attach_adapter,
98 .detach_client = max1619_detach_client,
99};
100
101/*
102 * Client data (each client gets its own)
103 */
104
105struct max1619_data {
106 struct i2c_client client;
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400107 struct class_device *class_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 struct semaphore update_lock;
109 char valid; /* zero until following fields are valid */
110 unsigned long last_updated; /* in jiffies */
111
112 /* registers values */
113 u8 temp_input1; /* local */
114 u8 temp_input2, temp_low2, temp_high2; /* remote */
115 u8 temp_crit2;
116 u8 temp_hyst2;
117 u8 alarms;
118};
119
120/*
121 * Sysfs stuff
122 */
123
124#define show_temp(value) \
Yani Ioannou8627f9b2005-05-17 06:42:03 -0400125static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126{ \
127 struct max1619_data *data = max1619_update_device(dev); \
128 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->value)); \
129}
130show_temp(temp_input1);
131show_temp(temp_input2);
132show_temp(temp_low2);
133show_temp(temp_high2);
134show_temp(temp_crit2);
135show_temp(temp_hyst2);
136
137#define set_temp2(value, reg) \
Yani Ioannou8627f9b2005-05-17 06:42:03 -0400138static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 size_t count) \
140{ \
141 struct i2c_client *client = to_i2c_client(dev); \
142 struct max1619_data *data = i2c_get_clientdata(client); \
143 long val = simple_strtol(buf, NULL, 10); \
144 \
145 down(&data->update_lock); \
146 data->value = TEMP_TO_REG(val); \
147 i2c_smbus_write_byte_data(client, reg, data->value); \
148 up(&data->update_lock); \
149 return count; \
150}
151
152set_temp2(temp_low2, MAX1619_REG_W_REMOTE_LOW);
153set_temp2(temp_high2, MAX1619_REG_W_REMOTE_HIGH);
154set_temp2(temp_crit2, MAX1619_REG_W_REMOTE_CRIT);
155set_temp2(temp_hyst2, MAX1619_REG_W_TCRIT_HYST);
156
Yani Ioannou8627f9b2005-05-17 06:42:03 -0400157static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
159 struct max1619_data *data = max1619_update_device(dev);
160 return sprintf(buf, "%d\n", data->alarms);
161}
162
163static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input1, NULL);
164static DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_input2, NULL);
165static DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_low2,
166 set_temp_low2);
167static DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_high2,
168 set_temp_high2);
169static DEVICE_ATTR(temp2_crit, S_IWUSR | S_IRUGO, show_temp_crit2,
170 set_temp_crit2);
171static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp_hyst2,
172 set_temp_hyst2);
173static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
174
175/*
176 * Real code
177 */
178
179static int max1619_attach_adapter(struct i2c_adapter *adapter)
180{
181 if (!(adapter->class & I2C_CLASS_HWMON))
182 return 0;
183 return i2c_detect(adapter, &addr_data, max1619_detect);
184}
185
186/*
187 * The following function does more than just detection. If detection
188 * succeeds, it also registers the new chip.
189 */
190static int max1619_detect(struct i2c_adapter *adapter, int address, int kind)
191{
192 struct i2c_client *new_client;
193 struct max1619_data *data;
194 int err = 0;
195 const char *name = "";
196 u8 reg_config=0, reg_convrate=0, reg_status=0;
197 u8 man_id, chip_id;
198 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
199 goto exit;
200
201 if (!(data = kmalloc(sizeof(struct max1619_data), GFP_KERNEL))) {
202 err = -ENOMEM;
203 goto exit;
204 }
205 memset(data, 0, sizeof(struct max1619_data));
206
207 /* The common I2C client data is placed right before the
208 MAX1619-specific data. */
209 new_client = &data->client;
210 i2c_set_clientdata(new_client, data);
211 new_client->addr = address;
212 new_client->adapter = adapter;
213 new_client->driver = &max1619_driver;
214 new_client->flags = 0;
215
216 /*
217 * Now we do the remaining detection. A negative kind means that
218 * the driver was loaded with no force parameter (default), so we
219 * must both detect and identify the chip. A zero kind means that
220 * the driver was loaded with the force parameter, the detection
221 * step shall be skipped. A positive kind means that the driver
222 * was loaded with the force parameter and a given kind of chip is
223 * requested, so both the detection and the identification steps
224 * are skipped.
225 */
226 if (kind < 0) { /* detection */
227 reg_config = i2c_smbus_read_byte_data(new_client,
228 MAX1619_REG_R_CONFIG);
229 reg_convrate = i2c_smbus_read_byte_data(new_client,
230 MAX1619_REG_R_CONVRATE);
231 reg_status = i2c_smbus_read_byte_data(new_client,
232 MAX1619_REG_R_STATUS);
233 if ((reg_config & 0x03) != 0x00
234 || reg_convrate > 0x07 || (reg_status & 0x61 ) !=0x00) {
235 dev_dbg(&adapter->dev,
236 "MAX1619 detection failed at 0x%02x.\n",
237 address);
238 goto exit_free;
239 }
240 }
241
242 if (kind <= 0) { /* identification */
243
244 man_id = i2c_smbus_read_byte_data(new_client,
245 MAX1619_REG_R_MAN_ID);
246 chip_id = i2c_smbus_read_byte_data(new_client,
247 MAX1619_REG_R_CHIP_ID);
248
249 if ((man_id == 0x4D) && (chip_id == 0x04)){
250 kind = max1619;
251 }
252 }
253
254 if (kind <= 0) { /* identification failed */
255 dev_info(&adapter->dev,
256 "Unsupported chip (man_id=0x%02X, "
257 "chip_id=0x%02X).\n", man_id, chip_id);
258 goto exit_free;
259 }
260
261
262 if (kind == max1619){
263 name = "max1619";
264 }
265
266 /* We can fill in the remaining client fields */
267 strlcpy(new_client->name, name, I2C_NAME_SIZE);
268 data->valid = 0;
269 init_MUTEX(&data->update_lock);
270
271 /* Tell the I2C layer a new client has arrived */
272 if ((err = i2c_attach_client(new_client)))
273 goto exit_free;
274
275 /* Initialize the MAX1619 chip */
276 max1619_init_client(new_client);
277
278 /* Register sysfs hooks */
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400279 data->class_dev = hwmon_device_register(&new_client->dev);
280 if (IS_ERR(data->class_dev)) {
281 err = PTR_ERR(data->class_dev);
282 goto exit_detach;
283 }
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 device_create_file(&new_client->dev, &dev_attr_temp1_input);
286 device_create_file(&new_client->dev, &dev_attr_temp2_input);
287 device_create_file(&new_client->dev, &dev_attr_temp2_min);
288 device_create_file(&new_client->dev, &dev_attr_temp2_max);
289 device_create_file(&new_client->dev, &dev_attr_temp2_crit);
290 device_create_file(&new_client->dev, &dev_attr_temp2_crit_hyst);
291 device_create_file(&new_client->dev, &dev_attr_alarms);
292
293 return 0;
294
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400295exit_detach:
296 i2c_detach_client(new_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297exit_free:
298 kfree(data);
299exit:
300 return err;
301}
302
303static void max1619_init_client(struct i2c_client *client)
304{
305 u8 config;
306
307 /*
308 * Start the conversions.
309 */
310 i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONVRATE,
311 5); /* 2 Hz */
312 config = i2c_smbus_read_byte_data(client, MAX1619_REG_R_CONFIG);
313 if (config & 0x40)
314 i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONFIG,
315 config & 0xBF); /* run */
316}
317
318static int max1619_detach_client(struct i2c_client *client)
319{
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400320 struct max1619_data *data = i2c_get_clientdata(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 int err;
322
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400323 hwmon_device_unregister(data->class_dev);
324
Jean Delvare7bef5592005-07-27 22:14:49 +0200325 if ((err = i2c_detach_client(client)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400328 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 return 0;
330}
331
332static struct max1619_data *max1619_update_device(struct device *dev)
333{
334 struct i2c_client *client = to_i2c_client(dev);
335 struct max1619_data *data = i2c_get_clientdata(client);
336
337 down(&data->update_lock);
338
339 if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
340 dev_dbg(&client->dev, "Updating max1619 data.\n");
341 data->temp_input1 = i2c_smbus_read_byte_data(client,
342 MAX1619_REG_R_LOCAL_TEMP);
343 data->temp_input2 = i2c_smbus_read_byte_data(client,
344 MAX1619_REG_R_REMOTE_TEMP);
345 data->temp_high2 = i2c_smbus_read_byte_data(client,
346 MAX1619_REG_R_REMOTE_HIGH);
347 data->temp_low2 = i2c_smbus_read_byte_data(client,
348 MAX1619_REG_R_REMOTE_LOW);
349 data->temp_crit2 = i2c_smbus_read_byte_data(client,
350 MAX1619_REG_R_REMOTE_CRIT);
351 data->temp_hyst2 = i2c_smbus_read_byte_data(client,
352 MAX1619_REG_R_TCRIT_HYST);
353 data->alarms = i2c_smbus_read_byte_data(client,
354 MAX1619_REG_R_STATUS);
355
356 data->last_updated = jiffies;
357 data->valid = 1;
358 }
359
360 up(&data->update_lock);
361
362 return data;
363}
364
365static int __init sensors_max1619_init(void)
366{
367 return i2c_add_driver(&max1619_driver);
368}
369
370static void __exit sensors_max1619_exit(void)
371{
372 i2c_del_driver(&max1619_driver);
373}
374
Jean Delvare368609c2005-07-29 12:15:07 -0700375MODULE_AUTHOR("Alexey Fisher <fishor@mail.ru> and "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 "Jean Delvare <khali@linux-fr.org>");
377MODULE_DESCRIPTION("MAX1619 sensor driver");
378MODULE_LICENSE("GPL");
379
380module_init(sensors_max1619_init);
381module_exit(sensors_max1619_exit);