Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * lm83.c - Part of lm_sensors, Linux kernel modules for hardware | |
3 | * monitoring | |
7c81c60f | 4 | * Copyright (C) 2003-2009 Jean Delvare <jdelvare@suse.de> |
1da177e4 LT |
5 | * |
6 | * Heavily inspired from the lm78, lm75 and adm1021 drivers. The LM83 is | |
7 | * a sensor chip made by National Semiconductor. It reports up to four | |
8 | * temperatures (its own plus up to three external ones) with a 1 deg | |
9 | * resolution and a 3-4 deg accuracy. Complete datasheet can be obtained | |
10 | * from National's website at: | |
11 | * http://www.national.com/pf/LM/LM83.html | |
12 | * Since the datasheet omits to give the chip stepping code, I give it | |
13 | * here: 0x03 (at register 0xff). | |
14 | * | |
43cb7ebe JC |
15 | * Also supports the LM82 temp sensor, which is basically a stripped down |
16 | * model of the LM83. Datasheet is here: | |
17 | * http://www.national.com/pf/LM/LM82.html | |
18 | * | |
1da177e4 LT |
19 | * This program is free software; you can redistribute it and/or modify |
20 | * it under the terms of the GNU General Public License as published by | |
21 | * the Free Software Foundation; either version 2 of the License, or | |
22 | * (at your option) any later version. | |
23 | * | |
24 | * This program is distributed in the hope that it will be useful, | |
25 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
26 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
27 | * GNU General Public License for more details. | |
1da177e4 LT |
28 | */ |
29 | ||
1da177e4 LT |
30 | #include <linux/module.h> |
31 | #include <linux/init.h> | |
32 | #include <linux/slab.h> | |
33 | #include <linux/jiffies.h> | |
34 | #include <linux/i2c.h> | |
10c08f81 | 35 | #include <linux/hwmon-sysfs.h> |
943b0830 MH |
36 | #include <linux/hwmon.h> |
37 | #include <linux/err.h> | |
9a61bf63 | 38 | #include <linux/mutex.h> |
0e39e01c | 39 | #include <linux/sysfs.h> |
1da177e4 LT |
40 | |
41 | /* | |
42 | * Addresses to scan | |
43 | * Address is selected using 2 three-level pins, resulting in 9 possible | |
44 | * addresses. | |
45 | */ | |
46 | ||
25e9c86d MH |
47 | static const unsigned short normal_i2c[] = { |
48 | 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END }; | |
1da177e4 | 49 | |
e5e9f44c | 50 | enum chips { lm83, lm82 }; |
1da177e4 LT |
51 | |
52 | /* | |
53 | * The LM83 registers | |
54 | * Manufacturer ID is 0x01 for National Semiconductor. | |
55 | */ | |
56 | ||
57 | #define LM83_REG_R_MAN_ID 0xFE | |
58 | #define LM83_REG_R_CHIP_ID 0xFF | |
59 | #define LM83_REG_R_CONFIG 0x03 | |
60 | #define LM83_REG_W_CONFIG 0x09 | |
61 | #define LM83_REG_R_STATUS1 0x02 | |
62 | #define LM83_REG_R_STATUS2 0x35 | |
63 | #define LM83_REG_R_LOCAL_TEMP 0x00 | |
64 | #define LM83_REG_R_LOCAL_HIGH 0x05 | |
65 | #define LM83_REG_W_LOCAL_HIGH 0x0B | |
66 | #define LM83_REG_R_REMOTE1_TEMP 0x30 | |
67 | #define LM83_REG_R_REMOTE1_HIGH 0x38 | |
68 | #define LM83_REG_W_REMOTE1_HIGH 0x50 | |
69 | #define LM83_REG_R_REMOTE2_TEMP 0x01 | |
70 | #define LM83_REG_R_REMOTE2_HIGH 0x07 | |
71 | #define LM83_REG_W_REMOTE2_HIGH 0x0D | |
72 | #define LM83_REG_R_REMOTE3_TEMP 0x31 | |
73 | #define LM83_REG_R_REMOTE3_HIGH 0x3A | |
74 | #define LM83_REG_W_REMOTE3_HIGH 0x52 | |
75 | #define LM83_REG_R_TCRIT 0x42 | |
76 | #define LM83_REG_W_TCRIT 0x5A | |
77 | ||
78 | /* | |
79 | * Conversions and various macros | |
44bbe87e | 80 | * The LM83 uses signed 8-bit values with LSB = 1 degree Celsius. |
1da177e4 LT |
81 | */ |
82 | ||
83 | #define TEMP_FROM_REG(val) ((val) * 1000) | |
84 | #define TEMP_TO_REG(val) ((val) <= -128000 ? -128 : \ | |
85 | (val) >= 127000 ? 127 : \ | |
86 | (val) < 0 ? ((val) - 500) / 1000 : \ | |
87 | ((val) + 500) / 1000) | |
88 | ||
89 | static const u8 LM83_REG_R_TEMP[] = { | |
90 | LM83_REG_R_LOCAL_TEMP, | |
91 | LM83_REG_R_REMOTE1_TEMP, | |
92 | LM83_REG_R_REMOTE2_TEMP, | |
1a86c051 | 93 | LM83_REG_R_REMOTE3_TEMP, |
1da177e4 LT |
94 | LM83_REG_R_LOCAL_HIGH, |
95 | LM83_REG_R_REMOTE1_HIGH, | |
96 | LM83_REG_R_REMOTE2_HIGH, | |
1a86c051 JD |
97 | LM83_REG_R_REMOTE3_HIGH, |
98 | LM83_REG_R_TCRIT, | |
1da177e4 LT |
99 | }; |
100 | ||
101 | static const u8 LM83_REG_W_HIGH[] = { | |
102 | LM83_REG_W_LOCAL_HIGH, | |
103 | LM83_REG_W_REMOTE1_HIGH, | |
104 | LM83_REG_W_REMOTE2_HIGH, | |
1a86c051 JD |
105 | LM83_REG_W_REMOTE3_HIGH, |
106 | LM83_REG_W_TCRIT, | |
1da177e4 LT |
107 | }; |
108 | ||
1da177e4 LT |
109 | /* |
110 | * Client data (each client gets its own) | |
111 | */ | |
112 | ||
113 | struct lm83_data { | |
1beeffe4 | 114 | struct device *hwmon_dev; |
9a61bf63 | 115 | struct mutex update_lock; |
1da177e4 LT |
116 | char valid; /* zero until following fields are valid */ |
117 | unsigned long last_updated; /* in jiffies */ | |
118 | ||
119 | /* registers values */ | |
1a86c051 JD |
120 | s8 temp[9]; /* 0..3: input 1-4, |
121 | 4..7: high limit 1-4, | |
122 | 8 : critical limit */ | |
1da177e4 LT |
123 | u16 alarms; /* bitvector, combined */ |
124 | }; | |
125 | ||
41936370 GR |
126 | static struct lm83_data *lm83_update_device(struct device *dev) |
127 | { | |
128 | struct i2c_client *client = to_i2c_client(dev); | |
129 | struct lm83_data *data = i2c_get_clientdata(client); | |
130 | ||
131 | mutex_lock(&data->update_lock); | |
132 | ||
133 | if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) { | |
134 | int nr; | |
135 | ||
136 | dev_dbg(&client->dev, "Updating lm83 data.\n"); | |
137 | for (nr = 0; nr < 9; nr++) { | |
138 | data->temp[nr] = | |
139 | i2c_smbus_read_byte_data(client, | |
140 | LM83_REG_R_TEMP[nr]); | |
141 | } | |
142 | data->alarms = | |
143 | i2c_smbus_read_byte_data(client, LM83_REG_R_STATUS1) | |
144 | + (i2c_smbus_read_byte_data(client, LM83_REG_R_STATUS2) | |
145 | << 8); | |
146 | ||
147 | data->last_updated = jiffies; | |
148 | data->valid = 1; | |
149 | } | |
150 | ||
151 | mutex_unlock(&data->update_lock); | |
152 | ||
153 | return data; | |
154 | } | |
155 | ||
1da177e4 LT |
156 | /* |
157 | * Sysfs stuff | |
158 | */ | |
159 | ||
1a86c051 JD |
160 | static ssize_t show_temp(struct device *dev, struct device_attribute *devattr, |
161 | char *buf) | |
162 | { | |
163 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
164 | struct lm83_data *data = lm83_update_device(dev); | |
165 | return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index])); | |
1da177e4 | 166 | } |
1a86c051 JD |
167 | |
168 | static ssize_t set_temp(struct device *dev, struct device_attribute *devattr, | |
169 | const char *buf, size_t count) | |
170 | { | |
171 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
172 | struct i2c_client *client = to_i2c_client(dev); | |
173 | struct lm83_data *data = i2c_get_clientdata(client); | |
b3789a0d | 174 | long val; |
1a86c051 | 175 | int nr = attr->index; |
b3789a0d FM |
176 | int err; |
177 | ||
178 | err = kstrtol(buf, 10, &val); | |
179 | if (err < 0) | |
180 | return err; | |
1a86c051 | 181 | |
9a61bf63 | 182 | mutex_lock(&data->update_lock); |
1a86c051 JD |
183 | data->temp[nr] = TEMP_TO_REG(val); |
184 | i2c_smbus_write_byte_data(client, LM83_REG_W_HIGH[nr - 4], | |
185 | data->temp[nr]); | |
9a61bf63 | 186 | mutex_unlock(&data->update_lock); |
1a86c051 | 187 | return count; |
1da177e4 | 188 | } |
1da177e4 | 189 | |
1a86c051 JD |
190 | static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy, |
191 | char *buf) | |
1da177e4 LT |
192 | { |
193 | struct lm83_data *data = lm83_update_device(dev); | |
194 | return sprintf(buf, "%d\n", data->alarms); | |
195 | } | |
196 | ||
2d45771e JD |
197 | static ssize_t show_alarm(struct device *dev, struct device_attribute |
198 | *devattr, char *buf) | |
199 | { | |
200 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
201 | struct lm83_data *data = lm83_update_device(dev); | |
202 | int bitnr = attr->index; | |
203 | ||
204 | return sprintf(buf, "%d\n", (data->alarms >> bitnr) & 1); | |
205 | } | |
206 | ||
1a86c051 JD |
207 | static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0); |
208 | static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1); | |
209 | static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2); | |
210 | static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp, NULL, 3); | |
211 | static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, | |
212 | set_temp, 4); | |
213 | static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp, | |
214 | set_temp, 5); | |
215 | static SENSOR_DEVICE_ATTR(temp3_max, S_IWUSR | S_IRUGO, show_temp, | |
216 | set_temp, 6); | |
217 | static SENSOR_DEVICE_ATTR(temp4_max, S_IWUSR | S_IRUGO, show_temp, | |
218 | set_temp, 7); | |
219 | static SENSOR_DEVICE_ATTR(temp1_crit, S_IRUGO, show_temp, NULL, 8); | |
220 | static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_temp, NULL, 8); | |
221 | static SENSOR_DEVICE_ATTR(temp3_crit, S_IWUSR | S_IRUGO, show_temp, | |
222 | set_temp, 8); | |
223 | static SENSOR_DEVICE_ATTR(temp4_crit, S_IRUGO, show_temp, NULL, 8); | |
2d45771e JD |
224 | |
225 | /* Individual alarm files */ | |
226 | static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL, 0); | |
227 | static SENSOR_DEVICE_ATTR(temp3_crit_alarm, S_IRUGO, show_alarm, NULL, 1); | |
7817a39e | 228 | static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_alarm, NULL, 2); |
2d45771e JD |
229 | static SENSOR_DEVICE_ATTR(temp3_max_alarm, S_IRUGO, show_alarm, NULL, 4); |
230 | static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6); | |
231 | static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 8); | |
232 | static SENSOR_DEVICE_ATTR(temp4_crit_alarm, S_IRUGO, show_alarm, NULL, 9); | |
7817a39e | 233 | static SENSOR_DEVICE_ATTR(temp4_fault, S_IRUGO, show_alarm, NULL, 10); |
2d45771e | 234 | static SENSOR_DEVICE_ATTR(temp4_max_alarm, S_IRUGO, show_alarm, NULL, 12); |
7817a39e | 235 | static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 13); |
2d45771e JD |
236 | static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 15); |
237 | /* Raw alarm file for compatibility */ | |
1da177e4 LT |
238 | static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL); |
239 | ||
0e39e01c JD |
240 | static struct attribute *lm83_attributes[] = { |
241 | &sensor_dev_attr_temp1_input.dev_attr.attr, | |
242 | &sensor_dev_attr_temp3_input.dev_attr.attr, | |
243 | &sensor_dev_attr_temp1_max.dev_attr.attr, | |
244 | &sensor_dev_attr_temp3_max.dev_attr.attr, | |
245 | &sensor_dev_attr_temp1_crit.dev_attr.attr, | |
246 | &sensor_dev_attr_temp3_crit.dev_attr.attr, | |
247 | ||
248 | &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr, | |
249 | &sensor_dev_attr_temp3_crit_alarm.dev_attr.attr, | |
7817a39e | 250 | &sensor_dev_attr_temp3_fault.dev_attr.attr, |
0e39e01c JD |
251 | &sensor_dev_attr_temp3_max_alarm.dev_attr.attr, |
252 | &sensor_dev_attr_temp1_max_alarm.dev_attr.attr, | |
253 | &dev_attr_alarms.attr, | |
254 | NULL | |
255 | }; | |
256 | ||
257 | static const struct attribute_group lm83_group = { | |
258 | .attrs = lm83_attributes, | |
259 | }; | |
260 | ||
261 | static struct attribute *lm83_attributes_opt[] = { | |
262 | &sensor_dev_attr_temp2_input.dev_attr.attr, | |
263 | &sensor_dev_attr_temp4_input.dev_attr.attr, | |
264 | &sensor_dev_attr_temp2_max.dev_attr.attr, | |
265 | &sensor_dev_attr_temp4_max.dev_attr.attr, | |
266 | &sensor_dev_attr_temp2_crit.dev_attr.attr, | |
267 | &sensor_dev_attr_temp4_crit.dev_attr.attr, | |
268 | ||
269 | &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr, | |
270 | &sensor_dev_attr_temp4_crit_alarm.dev_attr.attr, | |
7817a39e | 271 | &sensor_dev_attr_temp4_fault.dev_attr.attr, |
0e39e01c | 272 | &sensor_dev_attr_temp4_max_alarm.dev_attr.attr, |
7817a39e | 273 | &sensor_dev_attr_temp2_fault.dev_attr.attr, |
0e39e01c JD |
274 | &sensor_dev_attr_temp2_max_alarm.dev_attr.attr, |
275 | NULL | |
276 | }; | |
277 | ||
278 | static const struct attribute_group lm83_group_opt = { | |
279 | .attrs = lm83_attributes_opt, | |
280 | }; | |
281 | ||
1da177e4 LT |
282 | /* |
283 | * Real code | |
284 | */ | |
285 | ||
b6aacdce | 286 | /* Return 0 if detection is successful, -ENODEV otherwise */ |
310ec792 | 287 | static int lm83_detect(struct i2c_client *new_client, |
b6aacdce | 288 | struct i2c_board_info *info) |
1da177e4 | 289 | { |
b6aacdce | 290 | struct i2c_adapter *adapter = new_client->adapter; |
b57dc394 JD |
291 | const char *name; |
292 | u8 man_id, chip_id; | |
1da177e4 LT |
293 | |
294 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) | |
b6aacdce | 295 | return -ENODEV; |
1da177e4 | 296 | |
b57dc394 JD |
297 | /* Detection */ |
298 | if ((i2c_smbus_read_byte_data(new_client, LM83_REG_R_STATUS1) & 0xA8) || | |
299 | (i2c_smbus_read_byte_data(new_client, LM83_REG_R_STATUS2) & 0x48) || | |
300 | (i2c_smbus_read_byte_data(new_client, LM83_REG_R_CONFIG) & 0x41)) { | |
301 | dev_dbg(&adapter->dev, "LM83 detection failed at 0x%02x\n", | |
302 | new_client->addr); | |
303 | return -ENODEV; | |
1da177e4 LT |
304 | } |
305 | ||
b57dc394 JD |
306 | /* Identification */ |
307 | man_id = i2c_smbus_read_byte_data(new_client, LM83_REG_R_MAN_ID); | |
308 | if (man_id != 0x01) /* National Semiconductor */ | |
309 | return -ENODEV; | |
1da177e4 | 310 | |
b57dc394 JD |
311 | chip_id = i2c_smbus_read_byte_data(new_client, LM83_REG_R_CHIP_ID); |
312 | switch (chip_id) { | |
313 | case 0x03: | |
1da177e4 | 314 | name = "lm83"; |
b57dc394 JD |
315 | break; |
316 | case 0x01: | |
43cb7ebe | 317 | name = "lm82"; |
b57dc394 JD |
318 | break; |
319 | default: | |
320 | /* identification failed */ | |
321 | dev_info(&adapter->dev, | |
322 | "Unsupported chip (man_id=0x%02X, chip_id=0x%02X)\n", | |
323 | man_id, chip_id); | |
324 | return -ENODEV; | |
1da177e4 LT |
325 | } |
326 | ||
b6aacdce JD |
327 | strlcpy(info->type, name, I2C_NAME_SIZE); |
328 | ||
329 | return 0; | |
330 | } | |
331 | ||
332 | static int lm83_probe(struct i2c_client *new_client, | |
333 | const struct i2c_device_id *id) | |
334 | { | |
335 | struct lm83_data *data; | |
336 | int err; | |
337 | ||
c087f73a GR |
338 | data = devm_kzalloc(&new_client->dev, sizeof(struct lm83_data), |
339 | GFP_KERNEL); | |
340 | if (!data) | |
341 | return -ENOMEM; | |
b6aacdce JD |
342 | |
343 | i2c_set_clientdata(new_client, data); | |
9a61bf63 | 344 | mutex_init(&data->update_lock); |
1da177e4 | 345 | |
1da177e4 | 346 | /* |
0e39e01c | 347 | * Register sysfs hooks |
43cb7ebe JC |
348 | * The LM82 can only monitor one external diode which is |
349 | * at the same register as the LM83 temp3 entry - so we | |
350 | * declare 1 and 3 common, and then 2 and 4 only for the LM83. | |
351 | */ | |
352 | ||
b3789a0d FM |
353 | err = sysfs_create_group(&new_client->dev.kobj, &lm83_group); |
354 | if (err) | |
c087f73a | 355 | return err; |
1da177e4 | 356 | |
b6aacdce | 357 | if (id->driver_data == lm83) { |
b3789a0d FM |
358 | err = sysfs_create_group(&new_client->dev.kobj, |
359 | &lm83_group_opt); | |
360 | if (err) | |
0e39e01c JD |
361 | goto exit_remove_files; |
362 | } | |
363 | ||
1beeffe4 TJ |
364 | data->hwmon_dev = hwmon_device_register(&new_client->dev); |
365 | if (IS_ERR(data->hwmon_dev)) { | |
366 | err = PTR_ERR(data->hwmon_dev); | |
0e39e01c | 367 | goto exit_remove_files; |
43cb7ebe JC |
368 | } |
369 | ||
1da177e4 LT |
370 | return 0; |
371 | ||
0e39e01c JD |
372 | exit_remove_files: |
373 | sysfs_remove_group(&new_client->dev.kobj, &lm83_group); | |
374 | sysfs_remove_group(&new_client->dev.kobj, &lm83_group_opt); | |
1da177e4 LT |
375 | return err; |
376 | } | |
377 | ||
b6aacdce | 378 | static int lm83_remove(struct i2c_client *client) |
1da177e4 | 379 | { |
943b0830 | 380 | struct lm83_data *data = i2c_get_clientdata(client); |
1da177e4 | 381 | |
1beeffe4 | 382 | hwmon_device_unregister(data->hwmon_dev); |
0e39e01c JD |
383 | sysfs_remove_group(&client->dev.kobj, &lm83_group); |
384 | sysfs_remove_group(&client->dev.kobj, &lm83_group_opt); | |
943b0830 | 385 | |
1da177e4 LT |
386 | return 0; |
387 | } | |
388 | ||
41936370 GR |
389 | /* |
390 | * Driver data (common to all clients) | |
391 | */ | |
1da177e4 | 392 | |
41936370 GR |
393 | static const struct i2c_device_id lm83_id[] = { |
394 | { "lm83", lm83 }, | |
395 | { "lm82", lm82 }, | |
396 | { } | |
397 | }; | |
398 | MODULE_DEVICE_TABLE(i2c, lm83_id); | |
1da177e4 | 399 | |
41936370 GR |
400 | static struct i2c_driver lm83_driver = { |
401 | .class = I2C_CLASS_HWMON, | |
402 | .driver = { | |
403 | .name = "lm83", | |
404 | }, | |
405 | .probe = lm83_probe, | |
406 | .remove = lm83_remove, | |
407 | .id_table = lm83_id, | |
408 | .detect = lm83_detect, | |
409 | .address_list = normal_i2c, | |
410 | }; | |
1da177e4 | 411 | |
f0967eea | 412 | module_i2c_driver(lm83_driver); |
1da177e4 | 413 | |
7c81c60f | 414 | MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>"); |
1da177e4 LT |
415 | MODULE_DESCRIPTION("LM83 driver"); |
416 | MODULE_LICENSE("GPL"); |