Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
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 | ||
1da177e4 LT |
29 | #include <linux/module.h> |
30 | #include <linux/init.h> | |
31 | #include <linux/slab.h> | |
32 | #include <linux/jiffies.h> | |
33 | #include <linux/i2c.h> | |
943b0830 | 34 | #include <linux/hwmon.h> |
71062ffc | 35 | #include <linux/hwmon-sysfs.h> |
943b0830 | 36 | #include <linux/err.h> |
9a61bf63 | 37 | #include <linux/mutex.h> |
a5ebe668 | 38 | #include <linux/sysfs.h> |
1da177e4 LT |
39 | |
40 | static unsigned short normal_i2c[] = { 0x18, 0x19, 0x1a, | |
41 | 0x29, 0x2a, 0x2b, | |
42 | 0x4c, 0x4d, 0x4e, | |
43 | I2C_CLIENT_END }; | |
1da177e4 LT |
44 | |
45 | /* | |
46 | * Insmod parameters | |
47 | */ | |
48 | ||
f4b50261 | 49 | I2C_CLIENT_INSMOD_1(max1619); |
1da177e4 LT |
50 | |
51 | /* | |
52 | * The MAX1619 registers | |
53 | */ | |
54 | ||
55 | #define MAX1619_REG_R_MAN_ID 0xFE | |
56 | #define MAX1619_REG_R_CHIP_ID 0xFF | |
57 | #define MAX1619_REG_R_CONFIG 0x03 | |
58 | #define MAX1619_REG_W_CONFIG 0x09 | |
59 | #define MAX1619_REG_R_CONVRATE 0x04 | |
60 | #define MAX1619_REG_W_CONVRATE 0x0A | |
61 | #define MAX1619_REG_R_STATUS 0x02 | |
62 | #define MAX1619_REG_R_LOCAL_TEMP 0x00 | |
63 | #define MAX1619_REG_R_REMOTE_TEMP 0x01 | |
64 | #define MAX1619_REG_R_REMOTE_HIGH 0x07 | |
65 | #define MAX1619_REG_W_REMOTE_HIGH 0x0D | |
66 | #define MAX1619_REG_R_REMOTE_LOW 0x08 | |
67 | #define MAX1619_REG_W_REMOTE_LOW 0x0E | |
68 | #define MAX1619_REG_R_REMOTE_CRIT 0x10 | |
69 | #define MAX1619_REG_W_REMOTE_CRIT 0x12 | |
70 | #define MAX1619_REG_R_TCRIT_HYST 0x11 | |
71 | #define MAX1619_REG_W_TCRIT_HYST 0x13 | |
72 | ||
73 | /* | |
74 | * Conversions and various macros | |
75 | */ | |
76 | ||
77 | #define TEMP_FROM_REG(val) ((val & 0x80 ? val-0x100 : val) * 1000) | |
78 | #define TEMP_TO_REG(val) ((val < 0 ? val+0x100*1000 : val) / 1000) | |
79 | ||
80 | /* | |
81 | * Functions declaration | |
82 | */ | |
83 | ||
84 | static int max1619_attach_adapter(struct i2c_adapter *adapter); | |
85 | static int max1619_detect(struct i2c_adapter *adapter, int address, | |
86 | int kind); | |
87 | static void max1619_init_client(struct i2c_client *client); | |
88 | static int max1619_detach_client(struct i2c_client *client); | |
89 | static struct max1619_data *max1619_update_device(struct device *dev); | |
90 | ||
91 | /* | |
92 | * Driver data (common to all clients) | |
93 | */ | |
94 | ||
95 | static struct i2c_driver max1619_driver = { | |
cdaf7934 | 96 | .driver = { |
cdaf7934 LR |
97 | .name = "max1619", |
98 | }, | |
1da177e4 LT |
99 | .attach_adapter = max1619_attach_adapter, |
100 | .detach_client = max1619_detach_client, | |
101 | }; | |
102 | ||
103 | /* | |
104 | * Client data (each client gets its own) | |
105 | */ | |
106 | ||
107 | struct max1619_data { | |
108 | struct i2c_client client; | |
1beeffe4 | 109 | struct device *hwmon_dev; |
9a61bf63 | 110 | struct mutex update_lock; |
1da177e4 LT |
111 | char valid; /* zero until following fields are valid */ |
112 | unsigned long last_updated; /* in jiffies */ | |
113 | ||
114 | /* registers values */ | |
115 | u8 temp_input1; /* local */ | |
116 | u8 temp_input2, temp_low2, temp_high2; /* remote */ | |
117 | u8 temp_crit2; | |
118 | u8 temp_hyst2; | |
119 | u8 alarms; | |
120 | }; | |
121 | ||
122 | /* | |
123 | * Sysfs stuff | |
124 | */ | |
125 | ||
126 | #define show_temp(value) \ | |
8627f9ba | 127 | static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf) \ |
1da177e4 LT |
128 | { \ |
129 | struct max1619_data *data = max1619_update_device(dev); \ | |
130 | return sprintf(buf, "%d\n", TEMP_FROM_REG(data->value)); \ | |
131 | } | |
132 | show_temp(temp_input1); | |
133 | show_temp(temp_input2); | |
134 | show_temp(temp_low2); | |
135 | show_temp(temp_high2); | |
136 | show_temp(temp_crit2); | |
137 | show_temp(temp_hyst2); | |
138 | ||
139 | #define set_temp2(value, reg) \ | |
8627f9ba | 140 | static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, \ |
1da177e4 LT |
141 | size_t count) \ |
142 | { \ | |
143 | struct i2c_client *client = to_i2c_client(dev); \ | |
144 | struct max1619_data *data = i2c_get_clientdata(client); \ | |
145 | long val = simple_strtol(buf, NULL, 10); \ | |
146 | \ | |
9a61bf63 | 147 | mutex_lock(&data->update_lock); \ |
1da177e4 LT |
148 | data->value = TEMP_TO_REG(val); \ |
149 | i2c_smbus_write_byte_data(client, reg, data->value); \ | |
9a61bf63 | 150 | mutex_unlock(&data->update_lock); \ |
1da177e4 LT |
151 | return count; \ |
152 | } | |
153 | ||
154 | set_temp2(temp_low2, MAX1619_REG_W_REMOTE_LOW); | |
155 | set_temp2(temp_high2, MAX1619_REG_W_REMOTE_HIGH); | |
156 | set_temp2(temp_crit2, MAX1619_REG_W_REMOTE_CRIT); | |
157 | set_temp2(temp_hyst2, MAX1619_REG_W_TCRIT_HYST); | |
158 | ||
8627f9ba | 159 | static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
160 | { |
161 | struct max1619_data *data = max1619_update_device(dev); | |
162 | return sprintf(buf, "%d\n", data->alarms); | |
163 | } | |
164 | ||
71062ffc JD |
165 | static ssize_t show_alarm(struct device *dev, struct device_attribute *attr, |
166 | char *buf) | |
167 | { | |
168 | int bitnr = to_sensor_dev_attr(attr)->index; | |
169 | struct max1619_data *data = max1619_update_device(dev); | |
170 | return sprintf(buf, "%d\n", (data->alarms >> bitnr) & 1); | |
171 | } | |
172 | ||
1da177e4 LT |
173 | static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input1, NULL); |
174 | static DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_input2, NULL); | |
175 | static DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_low2, | |
176 | set_temp_low2); | |
177 | static DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_high2, | |
178 | set_temp_high2); | |
179 | static DEVICE_ATTR(temp2_crit, S_IWUSR | S_IRUGO, show_temp_crit2, | |
180 | set_temp_crit2); | |
181 | static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp_hyst2, | |
182 | set_temp_hyst2); | |
183 | static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL); | |
71062ffc JD |
184 | static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1); |
185 | static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2); | |
186 | static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3); | |
187 | static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4); | |
1da177e4 | 188 | |
a5ebe668 JD |
189 | static struct attribute *max1619_attributes[] = { |
190 | &dev_attr_temp1_input.attr, | |
191 | &dev_attr_temp2_input.attr, | |
192 | &dev_attr_temp2_min.attr, | |
193 | &dev_attr_temp2_max.attr, | |
194 | &dev_attr_temp2_crit.attr, | |
195 | &dev_attr_temp2_crit_hyst.attr, | |
196 | ||
197 | &dev_attr_alarms.attr, | |
71062ffc JD |
198 | &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr, |
199 | &sensor_dev_attr_temp2_fault.dev_attr.attr, | |
200 | &sensor_dev_attr_temp2_min_alarm.dev_attr.attr, | |
201 | &sensor_dev_attr_temp2_max_alarm.dev_attr.attr, | |
a5ebe668 JD |
202 | NULL |
203 | }; | |
204 | ||
205 | static const struct attribute_group max1619_group = { | |
206 | .attrs = max1619_attributes, | |
207 | }; | |
208 | ||
1da177e4 LT |
209 | /* |
210 | * Real code | |
211 | */ | |
212 | ||
213 | static int max1619_attach_adapter(struct i2c_adapter *adapter) | |
214 | { | |
215 | if (!(adapter->class & I2C_CLASS_HWMON)) | |
216 | return 0; | |
2ed2dc3c | 217 | return i2c_probe(adapter, &addr_data, max1619_detect); |
1da177e4 LT |
218 | } |
219 | ||
220 | /* | |
221 | * The following function does more than just detection. If detection | |
222 | * succeeds, it also registers the new chip. | |
223 | */ | |
224 | static int max1619_detect(struct i2c_adapter *adapter, int address, int kind) | |
225 | { | |
226 | struct i2c_client *new_client; | |
227 | struct max1619_data *data; | |
228 | int err = 0; | |
229 | const char *name = ""; | |
230 | u8 reg_config=0, reg_convrate=0, reg_status=0; | |
b0020e3f | 231 | |
1da177e4 LT |
232 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) |
233 | goto exit; | |
234 | ||
ba9c2e8d | 235 | if (!(data = kzalloc(sizeof(struct max1619_data), GFP_KERNEL))) { |
1da177e4 LT |
236 | err = -ENOMEM; |
237 | goto exit; | |
238 | } | |
1da177e4 LT |
239 | |
240 | /* The common I2C client data is placed right before the | |
241 | MAX1619-specific data. */ | |
242 | new_client = &data->client; | |
243 | i2c_set_clientdata(new_client, data); | |
244 | new_client->addr = address; | |
245 | new_client->adapter = adapter; | |
246 | new_client->driver = &max1619_driver; | |
247 | new_client->flags = 0; | |
248 | ||
249 | /* | |
250 | * Now we do the remaining detection. A negative kind means that | |
251 | * the driver was loaded with no force parameter (default), so we | |
252 | * must both detect and identify the chip. A zero kind means that | |
253 | * the driver was loaded with the force parameter, the detection | |
254 | * step shall be skipped. A positive kind means that the driver | |
255 | * was loaded with the force parameter and a given kind of chip is | |
256 | * requested, so both the detection and the identification steps | |
257 | * are skipped. | |
258 | */ | |
259 | if (kind < 0) { /* detection */ | |
260 | reg_config = i2c_smbus_read_byte_data(new_client, | |
261 | MAX1619_REG_R_CONFIG); | |
262 | reg_convrate = i2c_smbus_read_byte_data(new_client, | |
263 | MAX1619_REG_R_CONVRATE); | |
264 | reg_status = i2c_smbus_read_byte_data(new_client, | |
265 | MAX1619_REG_R_STATUS); | |
266 | if ((reg_config & 0x03) != 0x00 | |
267 | || reg_convrate > 0x07 || (reg_status & 0x61 ) !=0x00) { | |
268 | dev_dbg(&adapter->dev, | |
269 | "MAX1619 detection failed at 0x%02x.\n", | |
270 | address); | |
271 | goto exit_free; | |
272 | } | |
273 | } | |
274 | ||
275 | if (kind <= 0) { /* identification */ | |
b0020e3f | 276 | u8 man_id, chip_id; |
1da177e4 LT |
277 | |
278 | man_id = i2c_smbus_read_byte_data(new_client, | |
279 | MAX1619_REG_R_MAN_ID); | |
280 | chip_id = i2c_smbus_read_byte_data(new_client, | |
281 | MAX1619_REG_R_CHIP_ID); | |
282 | ||
b0020e3f AM |
283 | if ((man_id == 0x4D) && (chip_id == 0x04)) |
284 | kind = max1619; | |
1da177e4 LT |
285 | |
286 | if (kind <= 0) { /* identification failed */ | |
287 | dev_info(&adapter->dev, | |
288 | "Unsupported chip (man_id=0x%02X, " | |
289 | "chip_id=0x%02X).\n", man_id, chip_id); | |
290 | goto exit_free; | |
291 | } | |
b0020e3f | 292 | } |
1da177e4 | 293 | |
b0020e3f | 294 | if (kind == max1619) |
1da177e4 | 295 | name = "max1619"; |
1da177e4 LT |
296 | |
297 | /* We can fill in the remaining client fields */ | |
298 | strlcpy(new_client->name, name, I2C_NAME_SIZE); | |
299 | data->valid = 0; | |
9a61bf63 | 300 | mutex_init(&data->update_lock); |
1da177e4 LT |
301 | |
302 | /* Tell the I2C layer a new client has arrived */ | |
303 | if ((err = i2c_attach_client(new_client))) | |
304 | goto exit_free; | |
305 | ||
306 | /* Initialize the MAX1619 chip */ | |
307 | max1619_init_client(new_client); | |
308 | ||
309 | /* Register sysfs hooks */ | |
a5ebe668 JD |
310 | if ((err = sysfs_create_group(&new_client->dev.kobj, &max1619_group))) |
311 | goto exit_detach; | |
312 | ||
1beeffe4 TJ |
313 | data->hwmon_dev = hwmon_device_register(&new_client->dev); |
314 | if (IS_ERR(data->hwmon_dev)) { | |
315 | err = PTR_ERR(data->hwmon_dev); | |
a5ebe668 | 316 | goto exit_remove_files; |
943b0830 MH |
317 | } |
318 | ||
1da177e4 LT |
319 | return 0; |
320 | ||
a5ebe668 JD |
321 | exit_remove_files: |
322 | sysfs_remove_group(&new_client->dev.kobj, &max1619_group); | |
943b0830 MH |
323 | exit_detach: |
324 | i2c_detach_client(new_client); | |
1da177e4 LT |
325 | exit_free: |
326 | kfree(data); | |
327 | exit: | |
328 | return err; | |
329 | } | |
330 | ||
331 | static void max1619_init_client(struct i2c_client *client) | |
332 | { | |
333 | u8 config; | |
334 | ||
335 | /* | |
336 | * Start the conversions. | |
337 | */ | |
338 | i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONVRATE, | |
339 | 5); /* 2 Hz */ | |
340 | config = i2c_smbus_read_byte_data(client, MAX1619_REG_R_CONFIG); | |
341 | if (config & 0x40) | |
342 | i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONFIG, | |
343 | config & 0xBF); /* run */ | |
344 | } | |
345 | ||
346 | static int max1619_detach_client(struct i2c_client *client) | |
347 | { | |
943b0830 | 348 | struct max1619_data *data = i2c_get_clientdata(client); |
1da177e4 LT |
349 | int err; |
350 | ||
1beeffe4 | 351 | hwmon_device_unregister(data->hwmon_dev); |
a5ebe668 | 352 | sysfs_remove_group(&client->dev.kobj, &max1619_group); |
943b0830 | 353 | |
7bef5594 | 354 | if ((err = i2c_detach_client(client))) |
1da177e4 | 355 | return err; |
1da177e4 | 356 | |
943b0830 | 357 | kfree(data); |
1da177e4 LT |
358 | return 0; |
359 | } | |
360 | ||
361 | static struct max1619_data *max1619_update_device(struct device *dev) | |
362 | { | |
363 | struct i2c_client *client = to_i2c_client(dev); | |
364 | struct max1619_data *data = i2c_get_clientdata(client); | |
365 | ||
9a61bf63 | 366 | mutex_lock(&data->update_lock); |
1da177e4 LT |
367 | |
368 | if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) { | |
369 | dev_dbg(&client->dev, "Updating max1619 data.\n"); | |
370 | data->temp_input1 = i2c_smbus_read_byte_data(client, | |
371 | MAX1619_REG_R_LOCAL_TEMP); | |
372 | data->temp_input2 = i2c_smbus_read_byte_data(client, | |
373 | MAX1619_REG_R_REMOTE_TEMP); | |
374 | data->temp_high2 = i2c_smbus_read_byte_data(client, | |
375 | MAX1619_REG_R_REMOTE_HIGH); | |
376 | data->temp_low2 = i2c_smbus_read_byte_data(client, | |
377 | MAX1619_REG_R_REMOTE_LOW); | |
378 | data->temp_crit2 = i2c_smbus_read_byte_data(client, | |
379 | MAX1619_REG_R_REMOTE_CRIT); | |
380 | data->temp_hyst2 = i2c_smbus_read_byte_data(client, | |
381 | MAX1619_REG_R_TCRIT_HYST); | |
382 | data->alarms = i2c_smbus_read_byte_data(client, | |
383 | MAX1619_REG_R_STATUS); | |
384 | ||
385 | data->last_updated = jiffies; | |
386 | data->valid = 1; | |
387 | } | |
388 | ||
9a61bf63 | 389 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
390 | |
391 | return data; | |
392 | } | |
393 | ||
394 | static int __init sensors_max1619_init(void) | |
395 | { | |
396 | return i2c_add_driver(&max1619_driver); | |
397 | } | |
398 | ||
399 | static void __exit sensors_max1619_exit(void) | |
400 | { | |
401 | i2c_del_driver(&max1619_driver); | |
402 | } | |
403 | ||
368609c5 | 404 | MODULE_AUTHOR("Alexey Fisher <fishor@mail.ru> and " |
1da177e4 LT |
405 | "Jean Delvare <khali@linux-fr.org>"); |
406 | MODULE_DESCRIPTION("MAX1619 sensor driver"); | |
407 | MODULE_LICENSE("GPL"); | |
408 | ||
409 | module_init(sensors_max1619_init); | |
410 | module_exit(sensors_max1619_exit); |