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 { | |
5975dfbf | 65 | struct i2c_client *client; |
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 | { |
99765db2 | 83 | return (temp / 500) * 8; |
1da177e4 LT |
84 | } |
85 | ||
413b6451 | 86 | static inline int LM77_TEMP_FROM_REG(s16 reg) |
1da177e4 | 87 | { |
413b6451 | 88 | return (reg / 8) * 500; |
1da177e4 LT |
89 | } |
90 | ||
9f9edcd4 GR |
91 | /* |
92 | * All registers are word-sized, except for the configuration register. | |
93 | * The LM77 uses the high-byte first convention. | |
94 | */ | |
95 | static u16 lm77_read_value(struct i2c_client *client, u8 reg) | |
96 | { | |
97 | if (reg == LM77_REG_CONF) | |
98 | return i2c_smbus_read_byte_data(client, reg); | |
99 | else | |
100 | return i2c_smbus_read_word_swapped(client, reg); | |
101 | } | |
102 | ||
103 | static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value) | |
104 | { | |
105 | if (reg == LM77_REG_CONF) | |
106 | return i2c_smbus_write_byte_data(client, reg, value); | |
107 | else | |
108 | return i2c_smbus_write_word_swapped(client, reg, value); | |
109 | } | |
110 | ||
111 | static struct lm77_data *lm77_update_device(struct device *dev) | |
112 | { | |
5975dfbf GR |
113 | struct lm77_data *data = dev_get_drvdata(dev); |
114 | struct i2c_client *client = data->client; | |
48dbd6ff | 115 | int i; |
9f9edcd4 GR |
116 | |
117 | mutex_lock(&data->update_lock); | |
118 | ||
119 | if (time_after(jiffies, data->last_updated + HZ + HZ / 2) | |
120 | || !data->valid) { | |
121 | dev_dbg(&client->dev, "Starting lm77 update\n"); | |
48dbd6ff GR |
122 | for (i = 0; i < t_num_temp; i++) { |
123 | data->temp[i] = | |
124 | LM77_TEMP_FROM_REG(lm77_read_value(client, | |
125 | temp_regs[i])); | |
126 | } | |
9f9edcd4 GR |
127 | data->alarms = |
128 | lm77_read_value(client, LM77_REG_TEMP) & 0x0007; | |
129 | data->last_updated = jiffies; | |
130 | data->valid = 1; | |
131 | } | |
132 | ||
133 | mutex_unlock(&data->update_lock); | |
134 | ||
135 | return data; | |
136 | } | |
137 | ||
1da177e4 LT |
138 | /* sysfs stuff */ |
139 | ||
97b539d5 | 140 | static ssize_t temp_show(struct device *dev, struct device_attribute *devattr, |
48dbd6ff | 141 | char *buf) |
1da177e4 | 142 | { |
48dbd6ff | 143 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
1da177e4 | 144 | struct lm77_data *data = lm77_update_device(dev); |
48dbd6ff GR |
145 | |
146 | return sprintf(buf, "%d\n", data->temp[attr->index]); | |
1da177e4 | 147 | } |
48dbd6ff | 148 | |
97b539d5 | 149 | static ssize_t temp_hyst_show(struct device *dev, |
48dbd6ff | 150 | struct device_attribute *devattr, char *buf) |
1da177e4 | 151 | { |
48dbd6ff | 152 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
1da177e4 | 153 | struct lm77_data *data = lm77_update_device(dev); |
48dbd6ff GR |
154 | int nr = attr->index; |
155 | int temp; | |
1da177e4 | 156 | |
48dbd6ff GR |
157 | temp = nr == t_min ? data->temp[nr] + data->temp[t_hyst] : |
158 | data->temp[nr] - data->temp[t_hyst]; | |
1da177e4 | 159 | |
48dbd6ff GR |
160 | return sprintf(buf, "%d\n", temp); |
161 | } | |
1da177e4 | 162 | |
97b539d5 GR |
163 | static ssize_t temp_store(struct device *dev, |
164 | struct device_attribute *devattr, const char *buf, | |
165 | size_t count) | |
1da177e4 | 166 | { |
48dbd6ff | 167 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
5975dfbf GR |
168 | struct lm77_data *data = dev_get_drvdata(dev); |
169 | struct i2c_client *client = data->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 | |
99765db2 | 178 | val = clamp_val(val, LM77_TEMP_MIN, LM77_TEMP_MAX); |
9a61bf63 | 179 | mutex_lock(&data->update_lock); |
48dbd6ff GR |
180 | data->temp[nr] = val; |
181 | lm77_write_value(client, temp_regs[nr], LM77_TEMP_TO_REG(val)); | |
9a61bf63 | 182 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
183 | return count; |
184 | } | |
185 | ||
48dbd6ff GR |
186 | /* |
187 | * hysteresis is stored as a relative value on the chip, so it has to be | |
188 | * converted first. | |
189 | */ | |
97b539d5 GR |
190 | static ssize_t temp_hyst_store(struct device *dev, |
191 | struct device_attribute *devattr, | |
192 | const char *buf, size_t count) | |
1da177e4 | 193 | { |
5975dfbf GR |
194 | struct lm77_data *data = dev_get_drvdata(dev); |
195 | struct i2c_client *client = data->client; | |
99765db2 | 196 | long val; |
02fe2fd9 GR |
197 | int err; |
198 | ||
99765db2 | 199 | err = kstrtol(buf, 10, &val); |
02fe2fd9 GR |
200 | if (err) |
201 | return err; | |
202 | ||
9a61bf63 | 203 | mutex_lock(&data->update_lock); |
99765db2 AL |
204 | val = clamp_val(data->temp[t_crit] - val, LM77_TEMP_MIN, LM77_TEMP_MAX); |
205 | data->temp[t_hyst] = val; | |
48dbd6ff GR |
206 | lm77_write_value(client, LM77_REG_TEMP_HYST, |
207 | LM77_TEMP_TO_REG(data->temp[t_hyst])); | |
9a61bf63 | 208 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
209 | return count; |
210 | } | |
211 | ||
97b539d5 | 212 | static ssize_t alarm_show(struct device *dev, struct device_attribute *attr, |
1f52af0f JD |
213 | char *buf) |
214 | { | |
215 | int bitnr = to_sensor_dev_attr(attr)->index; | |
216 | struct lm77_data *data = lm77_update_device(dev); | |
217 | return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1); | |
218 | } | |
219 | ||
97b539d5 GR |
220 | static SENSOR_DEVICE_ATTR_RO(temp1_input, temp, t_input); |
221 | static SENSOR_DEVICE_ATTR_RW(temp1_crit, temp, t_crit); | |
222 | static SENSOR_DEVICE_ATTR_RW(temp1_min, temp, t_min); | |
223 | static SENSOR_DEVICE_ATTR_RW(temp1_max, temp, t_max); | |
224 | ||
225 | static SENSOR_DEVICE_ATTR_RW(temp1_crit_hyst, temp_hyst, t_crit); | |
226 | static SENSOR_DEVICE_ATTR_RO(temp1_min_hyst, temp_hyst, t_min); | |
227 | static SENSOR_DEVICE_ATTR_RO(temp1_max_hyst, temp_hyst, t_max); | |
228 | ||
229 | static SENSOR_DEVICE_ATTR_RO(temp1_crit_alarm, alarm, 2); | |
230 | static SENSOR_DEVICE_ATTR_RO(temp1_min_alarm, alarm, 0); | |
231 | static SENSOR_DEVICE_ATTR_RO(temp1_max_alarm, alarm, 1); | |
1da177e4 | 232 | |
5975dfbf | 233 | static struct attribute *lm77_attrs[] = { |
48dbd6ff GR |
234 | &sensor_dev_attr_temp1_input.dev_attr.attr, |
235 | &sensor_dev_attr_temp1_crit.dev_attr.attr, | |
236 | &sensor_dev_attr_temp1_min.dev_attr.attr, | |
237 | &sensor_dev_attr_temp1_max.dev_attr.attr, | |
238 | &sensor_dev_attr_temp1_crit_hyst.dev_attr.attr, | |
239 | &sensor_dev_attr_temp1_min_hyst.dev_attr.attr, | |
240 | &sensor_dev_attr_temp1_max_hyst.dev_attr.attr, | |
1f52af0f JD |
241 | &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr, |
242 | &sensor_dev_attr_temp1_min_alarm.dev_attr.attr, | |
243 | &sensor_dev_attr_temp1_max_alarm.dev_attr.attr, | |
0501a381 MH |
244 | NULL |
245 | }; | |
5975dfbf | 246 | ATTRIBUTE_GROUPS(lm77); |
0501a381 | 247 | |
a189dd62 | 248 | /* Return 0 if detection is successful, -ENODEV otherwise */ |
efd2d117 | 249 | static int lm77_detect(struct i2c_client *client, struct i2c_board_info *info) |
1da177e4 | 250 | { |
efd2d117 | 251 | struct i2c_adapter *adapter = client->adapter; |
747d9bed | 252 | int i, cur, conf, hyst, crit, min, max; |
1da177e4 LT |
253 | |
254 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA | | |
255 | I2C_FUNC_SMBUS_WORD_DATA)) | |
a189dd62 | 256 | return -ENODEV; |
1da177e4 | 257 | |
02fe2fd9 GR |
258 | /* |
259 | * Here comes the remaining detection. Since the LM77 has no | |
260 | * register dedicated to identification, we have to rely on the | |
261 | * following tricks: | |
262 | * | |
263 | * 1. the high 4 bits represent the sign and thus they should | |
264 | * always be the same | |
265 | * 2. the high 3 bits are unused in the configuration register | |
266 | * 3. addresses 0x06 and 0x07 return the last read value | |
267 | * 4. registers cycling over 8-address boundaries | |
268 | * | |
269 | * Word-sized registers are high-byte first. | |
270 | */ | |
1da177e4 | 271 | |
747d9bed | 272 | /* addresses cycling */ |
efd2d117 GR |
273 | cur = i2c_smbus_read_word_data(client, 0); |
274 | conf = i2c_smbus_read_byte_data(client, 1); | |
275 | hyst = i2c_smbus_read_word_data(client, 2); | |
276 | crit = i2c_smbus_read_word_data(client, 3); | |
277 | min = i2c_smbus_read_word_data(client, 4); | |
278 | max = i2c_smbus_read_word_data(client, 5); | |
747d9bed | 279 | for (i = 8; i <= 0xff; i += 8) { |
efd2d117 GR |
280 | if (i2c_smbus_read_byte_data(client, i + 1) != conf |
281 | || i2c_smbus_read_word_data(client, i + 2) != hyst | |
282 | || i2c_smbus_read_word_data(client, i + 3) != crit | |
283 | || i2c_smbus_read_word_data(client, i + 4) != min | |
284 | || i2c_smbus_read_word_data(client, i + 5) != max) | |
a189dd62 | 285 | return -ENODEV; |
747d9bed | 286 | } |
1da177e4 | 287 | |
747d9bed JD |
288 | /* sign bits */ |
289 | if (((cur & 0x00f0) != 0xf0 && (cur & 0x00f0) != 0x0) | |
290 | || ((hyst & 0x00f0) != 0xf0 && (hyst & 0x00f0) != 0x0) | |
291 | || ((crit & 0x00f0) != 0xf0 && (crit & 0x00f0) != 0x0) | |
292 | || ((min & 0x00f0) != 0xf0 && (min & 0x00f0) != 0x0) | |
293 | || ((max & 0x00f0) != 0xf0 && (max & 0x00f0) != 0x0)) | |
294 | return -ENODEV; | |
1da177e4 | 295 | |
747d9bed JD |
296 | /* unused bits */ |
297 | if (conf & 0xe0) | |
298 | return -ENODEV; | |
299 | ||
300 | /* 0x06 and 0x07 return the last read value */ | |
efd2d117 GR |
301 | cur = i2c_smbus_read_word_data(client, 0); |
302 | if (i2c_smbus_read_word_data(client, 6) != cur | |
303 | || i2c_smbus_read_word_data(client, 7) != cur) | |
747d9bed | 304 | return -ENODEV; |
efd2d117 GR |
305 | hyst = i2c_smbus_read_word_data(client, 2); |
306 | if (i2c_smbus_read_word_data(client, 6) != hyst | |
307 | || i2c_smbus_read_word_data(client, 7) != hyst) | |
747d9bed | 308 | return -ENODEV; |
efd2d117 GR |
309 | min = i2c_smbus_read_word_data(client, 4); |
310 | if (i2c_smbus_read_word_data(client, 6) != min | |
311 | || i2c_smbus_read_word_data(client, 7) != min) | |
747d9bed | 312 | return -ENODEV; |
1da177e4 | 313 | |
a189dd62 | 314 | strlcpy(info->type, "lm77", I2C_NAME_SIZE); |
1da177e4 | 315 | |
a189dd62 JD |
316 | return 0; |
317 | } | |
318 | ||
9f9edcd4 GR |
319 | static void lm77_init_client(struct i2c_client *client) |
320 | { | |
321 | /* Initialize the LM77 chip - turn off shutdown mode */ | |
322 | int conf = lm77_read_value(client, LM77_REG_CONF); | |
323 | if (conf & 1) | |
324 | lm77_write_value(client, LM77_REG_CONF, conf & 0xfe); | |
325 | } | |
326 | ||
efd2d117 | 327 | static int lm77_probe(struct i2c_client *client, const struct i2c_device_id *id) |
a189dd62 | 328 | { |
efd2d117 | 329 | struct device *dev = &client->dev; |
5975dfbf | 330 | struct device *hwmon_dev; |
a189dd62 | 331 | struct lm77_data *data; |
a189dd62 | 332 | |
52714c04 GR |
333 | data = devm_kzalloc(dev, sizeof(struct lm77_data), GFP_KERNEL); |
334 | if (!data) | |
335 | return -ENOMEM; | |
1da177e4 | 336 | |
5975dfbf | 337 | data->client = client; |
9a61bf63 | 338 | mutex_init(&data->update_lock); |
1da177e4 | 339 | |
1da177e4 | 340 | /* Initialize the LM77 chip */ |
efd2d117 | 341 | lm77_init_client(client); |
1da177e4 | 342 | |
5975dfbf GR |
343 | hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name, |
344 | data, lm77_groups); | |
345 | return PTR_ERR_OR_ZERO(hwmon_dev); | |
1da177e4 LT |
346 | } |
347 | ||
9f9edcd4 GR |
348 | static const struct i2c_device_id lm77_id[] = { |
349 | { "lm77", 0 }, | |
350 | { } | |
351 | }; | |
352 | MODULE_DEVICE_TABLE(i2c, lm77_id); | |
1da177e4 | 353 | |
9f9edcd4 GR |
354 | /* This is the driver that will be inserted */ |
355 | static struct i2c_driver lm77_driver = { | |
356 | .class = I2C_CLASS_HWMON, | |
357 | .driver = { | |
358 | .name = "lm77", | |
359 | }, | |
360 | .probe = lm77_probe, | |
9f9edcd4 GR |
361 | .id_table = lm77_id, |
362 | .detect = lm77_detect, | |
363 | .address_list = normal_i2c, | |
364 | }; | |
1da177e4 | 365 | |
f0967eea | 366 | module_i2c_driver(lm77_driver); |
1da177e4 LT |
367 | |
368 | MODULE_AUTHOR("Andras BALI <drewie@freemail.hu>"); | |
369 | MODULE_DESCRIPTION("LM77 driver"); | |
370 | MODULE_LICENSE("GPL"); |