Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
02fe2fd9 GR |
2 | * lm77.c - Part of lm_sensors, Linux kernel modules for hardware |
3 | * monitoring | |
4 | * | |
5 | * Copyright (c) 2004 Andras BALI <drewie@freemail.hu> | |
6 | * | |
7 | * Heavily based on lm75.c by Frodo Looijaard <frodol@dds.nl>. The LM77 | |
8 | * is a temperature sensor and thermal window comparator with 0.5 deg | |
9 | * resolution made by National Semiconductor. Complete datasheet can be | |
10 | * obtained at their site: | |
11 | * http://www.national.com/pf/LM/LM77.html | |
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. | |
02fe2fd9 | 22 | */ |
1da177e4 | 23 | |
1da177e4 LT |
24 | #include <linux/module.h> |
25 | #include <linux/init.h> | |
26 | #include <linux/slab.h> | |
27 | #include <linux/jiffies.h> | |
28 | #include <linux/i2c.h> | |
943b0830 | 29 | #include <linux/hwmon.h> |
1f52af0f | 30 | #include <linux/hwmon-sysfs.h> |
943b0830 | 31 | #include <linux/err.h> |
9a61bf63 | 32 | #include <linux/mutex.h> |
1da177e4 LT |
33 | |
34 | /* Addresses to scan */ | |
25e9c86d MH |
35 | static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, |
36 | I2C_CLIENT_END }; | |
1da177e4 | 37 | |
1da177e4 LT |
38 | /* The LM77 registers */ |
39 | #define LM77_REG_TEMP 0x00 | |
40 | #define LM77_REG_CONF 0x01 | |
41 | #define LM77_REG_TEMP_HYST 0x02 | |
42 | #define LM77_REG_TEMP_CRIT 0x03 | |
43 | #define LM77_REG_TEMP_MIN 0x04 | |
44 | #define LM77_REG_TEMP_MAX 0x05 | |
45 | ||
48dbd6ff GR |
46 | enum temp_index { |
47 | t_input = 0, | |
48 | t_crit, | |
49 | t_min, | |
50 | t_max, | |
51 | t_hyst, | |
52 | t_num_temp | |
53 | }; | |
54 | ||
55 | static const u8 temp_regs[t_num_temp] = { | |
56 | [t_input] = LM77_REG_TEMP, | |
57 | [t_min] = LM77_REG_TEMP_MIN, | |
58 | [t_max] = LM77_REG_TEMP_MAX, | |
59 | [t_crit] = LM77_REG_TEMP_CRIT, | |
60 | [t_hyst] = LM77_REG_TEMP_HYST, | |
61 | }; | |
62 | ||
1da177e4 LT |
63 | /* Each client has this additional data */ |
64 | struct lm77_data { | |
02fe2fd9 | 65 | struct device *hwmon_dev; |
9a61bf63 | 66 | struct mutex update_lock; |
1da177e4 LT |
67 | char valid; |
68 | unsigned long last_updated; /* In jiffies */ | |
48dbd6ff | 69 | int temp[t_num_temp]; /* index using temp_index */ |
1da177e4 LT |
70 | u8 alarms; |
71 | }; | |
72 | ||
1da177e4 LT |
73 | /* straight from the datasheet */ |
74 | #define LM77_TEMP_MIN (-55000) | |
75 | #define LM77_TEMP_MAX 125000 | |
76 | ||
02fe2fd9 GR |
77 | /* |
78 | * In the temperature registers, the low 3 bits are not part of the | |
79 | * temperature values; they are the status bits. | |
80 | */ | |
413b6451 | 81 | static inline s16 LM77_TEMP_TO_REG(int temp) |
1da177e4 | 82 | { |
2a844c14 | 83 | int ntemp = clamp_val(temp, LM77_TEMP_MIN, LM77_TEMP_MAX); |
413b6451 | 84 | return (ntemp / 500) * 8; |
1da177e4 LT |
85 | } |
86 | ||
413b6451 | 87 | static inline int LM77_TEMP_FROM_REG(s16 reg) |
1da177e4 | 88 | { |
413b6451 | 89 | return (reg / 8) * 500; |
1da177e4 LT |
90 | } |
91 | ||
9f9edcd4 GR |
92 | /* |
93 | * All registers are word-sized, except for the configuration register. | |
94 | * The LM77 uses the high-byte first convention. | |
95 | */ | |
96 | static u16 lm77_read_value(struct i2c_client *client, u8 reg) | |
97 | { | |
98 | if (reg == LM77_REG_CONF) | |
99 | return i2c_smbus_read_byte_data(client, reg); | |
100 | else | |
101 | return i2c_smbus_read_word_swapped(client, reg); | |
102 | } | |
103 | ||
104 | static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value) | |
105 | { | |
106 | if (reg == LM77_REG_CONF) | |
107 | return i2c_smbus_write_byte_data(client, reg, value); | |
108 | else | |
109 | return i2c_smbus_write_word_swapped(client, reg, value); | |
110 | } | |
111 | ||
112 | static struct lm77_data *lm77_update_device(struct device *dev) | |
113 | { | |
114 | struct i2c_client *client = to_i2c_client(dev); | |
115 | struct lm77_data *data = i2c_get_clientdata(client); | |
48dbd6ff | 116 | int i; |
9f9edcd4 GR |
117 | |
118 | mutex_lock(&data->update_lock); | |
119 | ||
120 | if (time_after(jiffies, data->last_updated + HZ + HZ / 2) | |
121 | || !data->valid) { | |
122 | dev_dbg(&client->dev, "Starting lm77 update\n"); | |
48dbd6ff GR |
123 | for (i = 0; i < t_num_temp; i++) { |
124 | data->temp[i] = | |
125 | LM77_TEMP_FROM_REG(lm77_read_value(client, | |
126 | temp_regs[i])); | |
127 | } | |
9f9edcd4 GR |
128 | data->alarms = |
129 | lm77_read_value(client, LM77_REG_TEMP) & 0x0007; | |
130 | data->last_updated = jiffies; | |
131 | data->valid = 1; | |
132 | } | |
133 | ||
134 | mutex_unlock(&data->update_lock); | |
135 | ||
136 | return data; | |
137 | } | |
138 | ||
1da177e4 LT |
139 | /* sysfs stuff */ |
140 | ||
48dbd6ff GR |
141 | static ssize_t show_temp(struct device *dev, struct device_attribute *devattr, |
142 | char *buf) | |
1da177e4 | 143 | { |
48dbd6ff | 144 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
1da177e4 | 145 | struct lm77_data *data = lm77_update_device(dev); |
48dbd6ff GR |
146 | |
147 | return sprintf(buf, "%d\n", data->temp[attr->index]); | |
1da177e4 | 148 | } |
48dbd6ff GR |
149 | |
150 | static ssize_t show_temp_hyst(struct device *dev, | |
151 | struct device_attribute *devattr, char *buf) | |
1da177e4 | 152 | { |
48dbd6ff | 153 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
1da177e4 | 154 | struct lm77_data *data = lm77_update_device(dev); |
48dbd6ff GR |
155 | int nr = attr->index; |
156 | int temp; | |
1da177e4 | 157 | |
48dbd6ff GR |
158 | temp = nr == t_min ? data->temp[nr] + data->temp[t_hyst] : |
159 | data->temp[nr] - data->temp[t_hyst]; | |
1da177e4 | 160 | |
48dbd6ff GR |
161 | return sprintf(buf, "%d\n", temp); |
162 | } | |
1da177e4 | 163 | |
48dbd6ff GR |
164 | static ssize_t set_temp(struct device *dev, struct device_attribute *devattr, |
165 | const char *buf, size_t count) | |
1da177e4 | 166 | { |
48dbd6ff | 167 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
1da177e4 LT |
168 | struct i2c_client *client = to_i2c_client(dev); |
169 | struct lm77_data *data = i2c_get_clientdata(client); | |
48dbd6ff GR |
170 | int nr = attr->index; |
171 | long val; | |
02fe2fd9 GR |
172 | int err; |
173 | ||
48dbd6ff | 174 | err = kstrtol(buf, 10, &val); |
02fe2fd9 GR |
175 | if (err) |
176 | return err; | |
1da177e4 | 177 | |
9a61bf63 | 178 | mutex_lock(&data->update_lock); |
48dbd6ff GR |
179 | data->temp[nr] = val; |
180 | lm77_write_value(client, temp_regs[nr], LM77_TEMP_TO_REG(val)); | |
9a61bf63 | 181 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
182 | return count; |
183 | } | |
184 | ||
48dbd6ff GR |
185 | /* |
186 | * hysteresis is stored as a relative value on the chip, so it has to be | |
187 | * converted first. | |
188 | */ | |
189 | static ssize_t set_temp_hyst(struct device *dev, | |
190 | struct device_attribute *devattr, | |
02fe2fd9 | 191 | const char *buf, size_t count) |
1da177e4 LT |
192 | { |
193 | struct i2c_client *client = to_i2c_client(dev); | |
194 | struct lm77_data *data = i2c_get_clientdata(client); | |
02fe2fd9 GR |
195 | unsigned long val; |
196 | int err; | |
197 | ||
198 | err = kstrtoul(buf, 10, &val); | |
199 | if (err) | |
200 | return err; | |
201 | ||
9a61bf63 | 202 | mutex_lock(&data->update_lock); |
48dbd6ff GR |
203 | data->temp[t_hyst] = data->temp[t_crit] - val; |
204 | lm77_write_value(client, LM77_REG_TEMP_HYST, | |
205 | LM77_TEMP_TO_REG(data->temp[t_hyst])); | |
9a61bf63 | 206 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
207 | return count; |
208 | } | |
209 | ||
1f52af0f JD |
210 | static ssize_t show_alarm(struct device *dev, struct device_attribute *attr, |
211 | char *buf) | |
212 | { | |
213 | int bitnr = to_sensor_dev_attr(attr)->index; | |
214 | struct lm77_data *data = lm77_update_device(dev); | |
215 | return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1); | |
216 | } | |
217 | ||
48dbd6ff GR |
218 | static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, t_input); |
219 | static SENSOR_DEVICE_ATTR(temp1_crit, S_IWUSR | S_IRUGO, show_temp, set_temp, | |
220 | t_crit); | |
221 | static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp, set_temp, | |
222 | t_min); | |
223 | static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, set_temp, | |
224 | t_max); | |
225 | ||
226 | static SENSOR_DEVICE_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO, show_temp_hyst, | |
227 | set_temp_hyst, t_crit); | |
228 | static SENSOR_DEVICE_ATTR(temp1_min_hyst, S_IRUGO, show_temp_hyst, NULL, t_min); | |
229 | static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IRUGO, show_temp_hyst, NULL, t_max); | |
1da177e4 | 230 | |
1f52af0f JD |
231 | static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL, 2); |
232 | static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 0); | |
233 | static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 1); | |
1da177e4 | 234 | |
0501a381 | 235 | static struct attribute *lm77_attributes[] = { |
48dbd6ff GR |
236 | &sensor_dev_attr_temp1_input.dev_attr.attr, |
237 | &sensor_dev_attr_temp1_crit.dev_attr.attr, | |
238 | &sensor_dev_attr_temp1_min.dev_attr.attr, | |
239 | &sensor_dev_attr_temp1_max.dev_attr.attr, | |
240 | &sensor_dev_attr_temp1_crit_hyst.dev_attr.attr, | |
241 | &sensor_dev_attr_temp1_min_hyst.dev_attr.attr, | |
242 | &sensor_dev_attr_temp1_max_hyst.dev_attr.attr, | |
1f52af0f JD |
243 | &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr, |
244 | &sensor_dev_attr_temp1_min_alarm.dev_attr.attr, | |
245 | &sensor_dev_attr_temp1_max_alarm.dev_attr.attr, | |
0501a381 MH |
246 | NULL |
247 | }; | |
248 | ||
249 | static const struct attribute_group lm77_group = { | |
250 | .attrs = lm77_attributes, | |
251 | }; | |
252 | ||
a189dd62 | 253 | /* Return 0 if detection is successful, -ENODEV otherwise */ |
efd2d117 | 254 | static int lm77_detect(struct i2c_client *client, struct i2c_board_info *info) |
1da177e4 | 255 | { |
efd2d117 | 256 | struct i2c_adapter *adapter = client->adapter; |
747d9bed | 257 | int i, cur, conf, hyst, crit, min, max; |
1da177e4 LT |
258 | |
259 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA | | |
260 | I2C_FUNC_SMBUS_WORD_DATA)) | |
a189dd62 | 261 | return -ENODEV; |
1da177e4 | 262 | |
02fe2fd9 GR |
263 | /* |
264 | * Here comes the remaining detection. Since the LM77 has no | |
265 | * register dedicated to identification, we have to rely on the | |
266 | * following tricks: | |
267 | * | |
268 | * 1. the high 4 bits represent the sign and thus they should | |
269 | * always be the same | |
270 | * 2. the high 3 bits are unused in the configuration register | |
271 | * 3. addresses 0x06 and 0x07 return the last read value | |
272 | * 4. registers cycling over 8-address boundaries | |
273 | * | |
274 | * Word-sized registers are high-byte first. | |
275 | */ | |
1da177e4 | 276 | |
747d9bed | 277 | /* addresses cycling */ |
efd2d117 GR |
278 | cur = i2c_smbus_read_word_data(client, 0); |
279 | conf = i2c_smbus_read_byte_data(client, 1); | |
280 | hyst = i2c_smbus_read_word_data(client, 2); | |
281 | crit = i2c_smbus_read_word_data(client, 3); | |
282 | min = i2c_smbus_read_word_data(client, 4); | |
283 | max = i2c_smbus_read_word_data(client, 5); | |
747d9bed | 284 | for (i = 8; i <= 0xff; i += 8) { |
efd2d117 GR |
285 | if (i2c_smbus_read_byte_data(client, i + 1) != conf |
286 | || i2c_smbus_read_word_data(client, i + 2) != hyst | |
287 | || i2c_smbus_read_word_data(client, i + 3) != crit | |
288 | || i2c_smbus_read_word_data(client, i + 4) != min | |
289 | || i2c_smbus_read_word_data(client, i + 5) != max) | |
a189dd62 | 290 | return -ENODEV; |
747d9bed | 291 | } |
1da177e4 | 292 | |
747d9bed JD |
293 | /* sign bits */ |
294 | if (((cur & 0x00f0) != 0xf0 && (cur & 0x00f0) != 0x0) | |
295 | || ((hyst & 0x00f0) != 0xf0 && (hyst & 0x00f0) != 0x0) | |
296 | || ((crit & 0x00f0) != 0xf0 && (crit & 0x00f0) != 0x0) | |
297 | || ((min & 0x00f0) != 0xf0 && (min & 0x00f0) != 0x0) | |
298 | || ((max & 0x00f0) != 0xf0 && (max & 0x00f0) != 0x0)) | |
299 | return -ENODEV; | |
1da177e4 | 300 | |
747d9bed JD |
301 | /* unused bits */ |
302 | if (conf & 0xe0) | |
303 | return -ENODEV; | |
304 | ||
305 | /* 0x06 and 0x07 return the last read value */ | |
efd2d117 GR |
306 | cur = i2c_smbus_read_word_data(client, 0); |
307 | if (i2c_smbus_read_word_data(client, 6) != cur | |
308 | || i2c_smbus_read_word_data(client, 7) != cur) | |
747d9bed | 309 | return -ENODEV; |
efd2d117 GR |
310 | hyst = i2c_smbus_read_word_data(client, 2); |
311 | if (i2c_smbus_read_word_data(client, 6) != hyst | |
312 | || i2c_smbus_read_word_data(client, 7) != hyst) | |
747d9bed | 313 | return -ENODEV; |
efd2d117 GR |
314 | min = i2c_smbus_read_word_data(client, 4); |
315 | if (i2c_smbus_read_word_data(client, 6) != min | |
316 | || i2c_smbus_read_word_data(client, 7) != min) | |
747d9bed | 317 | return -ENODEV; |
1da177e4 | 318 | |
a189dd62 | 319 | strlcpy(info->type, "lm77", I2C_NAME_SIZE); |
1da177e4 | 320 | |
a189dd62 JD |
321 | return 0; |
322 | } | |
323 | ||
9f9edcd4 GR |
324 | static void lm77_init_client(struct i2c_client *client) |
325 | { | |
326 | /* Initialize the LM77 chip - turn off shutdown mode */ | |
327 | int conf = lm77_read_value(client, LM77_REG_CONF); | |
328 | if (conf & 1) | |
329 | lm77_write_value(client, LM77_REG_CONF, conf & 0xfe); | |
330 | } | |
331 | ||
efd2d117 | 332 | static int lm77_probe(struct i2c_client *client, const struct i2c_device_id *id) |
a189dd62 | 333 | { |
efd2d117 | 334 | struct device *dev = &client->dev; |
a189dd62 JD |
335 | struct lm77_data *data; |
336 | int err; | |
337 | ||
52714c04 GR |
338 | data = devm_kzalloc(dev, sizeof(struct lm77_data), GFP_KERNEL); |
339 | if (!data) | |
340 | return -ENOMEM; | |
1da177e4 | 341 | |
efd2d117 | 342 | i2c_set_clientdata(client, data); |
9a61bf63 | 343 | mutex_init(&data->update_lock); |
1da177e4 | 344 | |
1da177e4 | 345 | /* Initialize the LM77 chip */ |
efd2d117 | 346 | lm77_init_client(client); |
1da177e4 LT |
347 | |
348 | /* Register sysfs hooks */ | |
efd2d117 | 349 | err = sysfs_create_group(&dev->kobj, &lm77_group); |
02fe2fd9 | 350 | if (err) |
52714c04 | 351 | return err; |
0501a381 | 352 | |
efd2d117 | 353 | data->hwmon_dev = hwmon_device_register(dev); |
1beeffe4 TJ |
354 | if (IS_ERR(data->hwmon_dev)) { |
355 | err = PTR_ERR(data->hwmon_dev); | |
0501a381 | 356 | goto exit_remove; |
943b0830 MH |
357 | } |
358 | ||
1da177e4 LT |
359 | return 0; |
360 | ||
0501a381 | 361 | exit_remove: |
efd2d117 | 362 | sysfs_remove_group(&dev->kobj, &lm77_group); |
1da177e4 LT |
363 | return err; |
364 | } | |
365 | ||
a189dd62 | 366 | static int lm77_remove(struct i2c_client *client) |
1da177e4 | 367 | { |
943b0830 | 368 | struct lm77_data *data = i2c_get_clientdata(client); |
1beeffe4 | 369 | hwmon_device_unregister(data->hwmon_dev); |
0501a381 | 370 | sysfs_remove_group(&client->dev.kobj, &lm77_group); |
1da177e4 LT |
371 | return 0; |
372 | } | |
373 | ||
9f9edcd4 GR |
374 | static const struct i2c_device_id lm77_id[] = { |
375 | { "lm77", 0 }, | |
376 | { } | |
377 | }; | |
378 | MODULE_DEVICE_TABLE(i2c, lm77_id); | |
1da177e4 | 379 | |
9f9edcd4 GR |
380 | /* This is the driver that will be inserted */ |
381 | static struct i2c_driver lm77_driver = { | |
382 | .class = I2C_CLASS_HWMON, | |
383 | .driver = { | |
384 | .name = "lm77", | |
385 | }, | |
386 | .probe = lm77_probe, | |
387 | .remove = lm77_remove, | |
388 | .id_table = lm77_id, | |
389 | .detect = lm77_detect, | |
390 | .address_list = normal_i2c, | |
391 | }; | |
1da177e4 | 392 | |
f0967eea | 393 | module_i2c_driver(lm77_driver); |
1da177e4 LT |
394 | |
395 | MODULE_AUTHOR("Andras BALI <drewie@freemail.hu>"); | |
396 | MODULE_DESCRIPTION("LM77 driver"); | |
397 | MODULE_LICENSE("GPL"); |