blob: 508cb291f71bfc35681bfda50dbad88a1a8a8dc2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * lm63.c - driver for the National Semiconductor LM63 temperature sensor
3 * with integrated fan control
Jean Delvared5957be2008-07-16 19:30:13 +02004 * Copyright (C) 2004-2008 Jean Delvare <khali@linux-fr.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Based on the lm90 driver.
6 *
7 * The LM63 is a sensor chip made by National Semiconductor. It measures
8 * two temperatures (its own and one external one) and the speed of one
9 * fan, those speed it can additionally control. Complete datasheet can be
10 * obtained from National's website at:
11 * http://www.national.com/pf/LM/LM63.html
12 *
13 * The LM63 is basically an LM86 with fan speed monitoring and control
14 * capabilities added. It misses some of the LM86 features though:
15 * - No low limit for local temperature.
16 * - No critical limit for local temperature.
17 * - Critical limit for remote temperature can be changed only once. We
18 * will consider that the critical limit is read-only.
19 *
20 * The datasheet isn't very clear about what the tachometer reading is.
21 * I had a explanation from National Semiconductor though. The two lower
22 * bits of the read value have to be masked out. The value is still 16 bit
23 * in width.
24 *
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
29 *
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
34 *
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
38 */
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/module.h>
41#include <linux/init.h>
42#include <linux/slab.h>
43#include <linux/jiffies.h>
44#include <linux/i2c.h>
Jean Delvare10c08f82005-06-06 19:34:45 +020045#include <linux/hwmon-sysfs.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040046#include <linux/hwmon.h>
47#include <linux/err.h>
Ingo Molnar9a61bf62006-01-18 23:19:26 +010048#include <linux/mutex.h>
Jean Delvare0e39e012006-09-24 21:16:40 +020049#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51/*
52 * Addresses to scan
53 * Address is fully defined internally and cannot be changed.
54 */
55
Matthew Garrett10f2ed32010-05-27 19:58:38 +020056static const unsigned short normal_i2c[] = { 0x18, 0x4c, 0x4e, I2C_CLIENT_END };
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * The LM63 registers
60 */
61
62#define LM63_REG_CONFIG1 0x03
63#define LM63_REG_CONFIG2 0xBF
64#define LM63_REG_CONFIG_FAN 0x4A
65
66#define LM63_REG_TACH_COUNT_MSB 0x47
67#define LM63_REG_TACH_COUNT_LSB 0x46
68#define LM63_REG_TACH_LIMIT_MSB 0x49
69#define LM63_REG_TACH_LIMIT_LSB 0x48
70
71#define LM63_REG_PWM_VALUE 0x4C
72#define LM63_REG_PWM_FREQ 0x4D
73
74#define LM63_REG_LOCAL_TEMP 0x00
75#define LM63_REG_LOCAL_HIGH 0x05
76
77#define LM63_REG_REMOTE_TEMP_MSB 0x01
78#define LM63_REG_REMOTE_TEMP_LSB 0x10
79#define LM63_REG_REMOTE_OFFSET_MSB 0x11
80#define LM63_REG_REMOTE_OFFSET_LSB 0x12
81#define LM63_REG_REMOTE_HIGH_MSB 0x07
82#define LM63_REG_REMOTE_HIGH_LSB 0x13
83#define LM63_REG_REMOTE_LOW_MSB 0x08
84#define LM63_REG_REMOTE_LOW_LSB 0x14
85#define LM63_REG_REMOTE_TCRIT 0x19
86#define LM63_REG_REMOTE_TCRIT_HYST 0x21
87
88#define LM63_REG_ALERT_STATUS 0x02
89#define LM63_REG_ALERT_MASK 0x16
90
91#define LM63_REG_MAN_ID 0xFE
92#define LM63_REG_CHIP_ID 0xFF
93
94/*
95 * Conversions and various macros
96 * For tachometer counts, the LM63 uses 16-bit values.
97 * For local temperature and high limit, remote critical limit and hysteresis
Steven Cole44bbe872005-05-03 18:21:25 -060098 * value, it uses signed 8-bit values with LSB = 1 degree Celsius.
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 * For remote temperature, low and high limits, it uses signed 11-bit values
Steven Cole44bbe872005-05-03 18:21:25 -0600100 * with LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
Dirk Eibach2778fb12011-02-09 04:51:34 -0500101 * For LM64 the actual remote diode temperature is 16 degree Celsius higher
102 * than the register reading. Remote temperature setpoints have to be
103 * adapted accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 */
105
106#define FAN_FROM_REG(reg) ((reg) == 0xFFFC || (reg) == 0 ? 0 : \
107 5400000 / (reg))
108#define FAN_TO_REG(val) ((val) <= 82 ? 0xFFFC : \
109 (5400000 / (val)) & 0xFFFC)
110#define TEMP8_FROM_REG(reg) ((reg) * 1000)
111#define TEMP8_TO_REG(val) ((val) <= -128000 ? -128 : \
112 (val) >= 127000 ? 127 : \
113 (val) < 0 ? ((val) - 500) / 1000 : \
114 ((val) + 500) / 1000)
115#define TEMP11_FROM_REG(reg) ((reg) / 32 * 125)
116#define TEMP11_TO_REG(val) ((val) <= -128000 ? 0x8000 : \
117 (val) >= 127875 ? 0x7FE0 : \
118 (val) < 0 ? ((val) - 62) / 125 * 32 : \
119 ((val) + 62) / 125 * 32)
120#define HYST_TO_REG(val) ((val) <= 0 ? 0 : \
121 (val) >= 127000 ? 127 : \
122 ((val) + 500) / 1000)
123
124/*
125 * Functions declaration
126 */
127
Jean Delvared5957be2008-07-16 19:30:13 +0200128static int lm63_probe(struct i2c_client *client,
129 const struct i2c_device_id *id);
130static int lm63_remove(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132static struct lm63_data *lm63_update_device(struct device *dev);
133
Jean Delvare310ec792009-12-14 21:17:23 +0100134static int lm63_detect(struct i2c_client *client, struct i2c_board_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135static void lm63_init_client(struct i2c_client *client);
136
Matthew Garrett10f2ed32010-05-27 19:58:38 +0200137enum chips { lm63, lm64 };
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139/*
140 * Driver data (common to all clients)
141 */
142
Jean Delvared5957be2008-07-16 19:30:13 +0200143static const struct i2c_device_id lm63_id[] = {
Matthew Garrett10f2ed32010-05-27 19:58:38 +0200144 { "lm63", lm63 },
145 { "lm64", lm64 },
Jean Delvared5957be2008-07-16 19:30:13 +0200146 { }
147};
148MODULE_DEVICE_TABLE(i2c, lm63_id);
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150static struct i2c_driver lm63_driver = {
Jean Delvared5957be2008-07-16 19:30:13 +0200151 .class = I2C_CLASS_HWMON,
Laurent Riffardcdaf7932005-11-26 20:37:41 +0100152 .driver = {
Laurent Riffardcdaf7932005-11-26 20:37:41 +0100153 .name = "lm63",
154 },
Jean Delvared5957be2008-07-16 19:30:13 +0200155 .probe = lm63_probe,
156 .remove = lm63_remove,
157 .id_table = lm63_id,
158 .detect = lm63_detect,
Jean Delvarec3813d62009-12-14 21:17:25 +0100159 .address_list = normal_i2c,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160};
161
162/*
163 * Client data (each client gets its own)
164 */
165
166struct lm63_data {
Tony Jones1beeffe2007-08-20 13:46:20 -0700167 struct device *hwmon_dev;
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100168 struct mutex update_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 char valid; /* zero until following fields are valid */
170 unsigned long last_updated; /* in jiffies */
Dirk Eibach2778fb12011-02-09 04:51:34 -0500171 int kind;
172 int temp2_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174 /* registers values */
175 u8 config, config_fan;
Jean Delvarebc51ae12005-06-05 20:32:27 +0200176 u16 fan[2]; /* 0: input
177 1: low limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 u8 pwm1_freq;
179 u8 pwm1_value;
Jean Delvarebc51ae12005-06-05 20:32:27 +0200180 s8 temp8[3]; /* 0: local input
181 1: local high limit
182 2: remote critical limit */
183 s16 temp11[3]; /* 0: remote input
184 1: remote low limit
185 2: remote high limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 u8 temp2_crit_hyst;
187 u8 alarms;
188};
189
190/*
191 * Sysfs callback functions and files
192 */
193
Jean Delvarebc51ae12005-06-05 20:32:27 +0200194static ssize_t show_fan(struct device *dev, struct device_attribute *devattr,
195 char *buf)
196{
197 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
198 struct lm63_data *data = lm63_update_device(dev);
199 return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[attr->index]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Jean Delvarebc51ae12005-06-05 20:32:27 +0200202static ssize_t set_fan(struct device *dev, struct device_attribute *dummy,
203 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
205 struct i2c_client *client = to_i2c_client(dev);
206 struct lm63_data *data = i2c_get_clientdata(client);
207 unsigned long val = simple_strtoul(buf, NULL, 10);
208
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100209 mutex_lock(&data->update_lock);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200210 data->fan[1] = FAN_TO_REG(val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_LSB,
Jean Delvarebc51ae12005-06-05 20:32:27 +0200212 data->fan[1] & 0xFF);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_MSB,
Jean Delvarebc51ae12005-06-05 20:32:27 +0200214 data->fan[1] >> 8);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100215 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 return count;
217}
218
Jean Delvarebc51ae12005-06-05 20:32:27 +0200219static ssize_t show_pwm1(struct device *dev, struct device_attribute *dummy,
220 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221{
222 struct lm63_data *data = lm63_update_device(dev);
223 return sprintf(buf, "%d\n", data->pwm1_value >= 2 * data->pwm1_freq ?
224 255 : (data->pwm1_value * 255 + data->pwm1_freq) /
225 (2 * data->pwm1_freq));
226}
227
Jean Delvarebc51ae12005-06-05 20:32:27 +0200228static ssize_t set_pwm1(struct device *dev, struct device_attribute *dummy,
229 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
231 struct i2c_client *client = to_i2c_client(dev);
232 struct lm63_data *data = i2c_get_clientdata(client);
233 unsigned long val;
234
235 if (!(data->config_fan & 0x20)) /* register is read-only */
236 return -EPERM;
237
238 val = simple_strtoul(buf, NULL, 10);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100239 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 data->pwm1_value = val <= 0 ? 0 :
241 val >= 255 ? 2 * data->pwm1_freq :
242 (val * data->pwm1_freq * 2 + 127) / 255;
243 i2c_smbus_write_byte_data(client, LM63_REG_PWM_VALUE, data->pwm1_value);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100244 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 return count;
246}
247
Jean Delvarebc51ae12005-06-05 20:32:27 +0200248static ssize_t show_pwm1_enable(struct device *dev, struct device_attribute *dummy,
249 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 struct lm63_data *data = lm63_update_device(dev);
252 return sprintf(buf, "%d\n", data->config_fan & 0x20 ? 1 : 2);
253}
254
Dirk Eibach2778fb12011-02-09 04:51:34 -0500255/*
256 * There are 8bit registers for both local(temp1) and remote(temp2) sensor.
257 * For remote sensor registers temp2_offset has to be considered,
258 * for local sensor it must not.
259 * So we need separate 8bit accessors for local and remote sensor.
260 */
261static ssize_t show_local_temp8(struct device *dev,
262 struct device_attribute *devattr,
263 char *buf)
Jean Delvarebc51ae12005-06-05 20:32:27 +0200264{
265 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
266 struct lm63_data *data = lm63_update_device(dev);
267 return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[attr->index]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Dirk Eibach2778fb12011-02-09 04:51:34 -0500270static ssize_t show_remote_temp8(struct device *dev,
271 struct device_attribute *devattr,
272 char *buf)
273{
274 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
275 struct lm63_data *data = lm63_update_device(dev);
276 return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[attr->index])
277 + data->temp2_offset);
278}
279
280static ssize_t set_local_temp8(struct device *dev,
281 struct device_attribute *dummy,
282 const char *buf, size_t count)
Jean Delvarebc51ae12005-06-05 20:32:27 +0200283{
284 struct i2c_client *client = to_i2c_client(dev);
285 struct lm63_data *data = i2c_get_clientdata(client);
286 long val = simple_strtol(buf, NULL, 10);
287
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100288 mutex_lock(&data->update_lock);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200289 data->temp8[1] = TEMP8_TO_REG(val);
290 i2c_smbus_write_byte_data(client, LM63_REG_LOCAL_HIGH, data->temp8[1]);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100291 mutex_unlock(&data->update_lock);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200292 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
Jean Delvarebc51ae12005-06-05 20:32:27 +0200294
295static ssize_t show_temp11(struct device *dev, struct device_attribute *devattr,
296 char *buf)
297{
298 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
299 struct lm63_data *data = lm63_update_device(dev);
Dirk Eibach2778fb12011-02-09 04:51:34 -0500300 return sprintf(buf, "%d\n", TEMP11_FROM_REG(data->temp11[attr->index])
301 + data->temp2_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302}
Jean Delvarebc51ae12005-06-05 20:32:27 +0200303
304static ssize_t set_temp11(struct device *dev, struct device_attribute *devattr,
305 const char *buf, size_t count)
306{
307 static const u8 reg[4] = {
308 LM63_REG_REMOTE_LOW_MSB,
309 LM63_REG_REMOTE_LOW_LSB,
310 LM63_REG_REMOTE_HIGH_MSB,
311 LM63_REG_REMOTE_HIGH_LSB,
312 };
313
314 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
315 struct i2c_client *client = to_i2c_client(dev);
316 struct lm63_data *data = i2c_get_clientdata(client);
317 long val = simple_strtol(buf, NULL, 10);
318 int nr = attr->index;
319
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100320 mutex_lock(&data->update_lock);
Dirk Eibach2778fb12011-02-09 04:51:34 -0500321 data->temp11[nr] = TEMP11_TO_REG(val - data->temp2_offset);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200322 i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2],
323 data->temp11[nr] >> 8);
324 i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2 + 1],
325 data->temp11[nr] & 0xff);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100326 mutex_unlock(&data->update_lock);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200327 return count;
328}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330/* Hysteresis register holds a relative value, while we want to present
331 an absolute to user-space */
Jean Delvarebc51ae12005-06-05 20:32:27 +0200332static ssize_t show_temp2_crit_hyst(struct device *dev, struct device_attribute *dummy,
333 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334{
335 struct lm63_data *data = lm63_update_device(dev);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200336 return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[2])
Dirk Eibach2778fb12011-02-09 04:51:34 -0500337 + data->temp2_offset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 - TEMP8_FROM_REG(data->temp2_crit_hyst));
339}
340
341/* And now the other way around, user-space provides an absolute
342 hysteresis value and we have to store a relative one */
Jean Delvarebc51ae12005-06-05 20:32:27 +0200343static ssize_t set_temp2_crit_hyst(struct device *dev, struct device_attribute *dummy,
344 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
346 struct i2c_client *client = to_i2c_client(dev);
347 struct lm63_data *data = i2c_get_clientdata(client);
348 long val = simple_strtol(buf, NULL, 10);
349 long hyst;
350
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100351 mutex_lock(&data->update_lock);
Dirk Eibach2778fb12011-02-09 04:51:34 -0500352 hyst = TEMP8_FROM_REG(data->temp8[2]) + data->temp2_offset - val;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 i2c_smbus_write_byte_data(client, LM63_REG_REMOTE_TCRIT_HYST,
354 HYST_TO_REG(hyst));
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100355 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 return count;
357}
358
Jean Delvarebc51ae12005-06-05 20:32:27 +0200359static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy,
360 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
362 struct lm63_data *data = lm63_update_device(dev);
363 return sprintf(buf, "%u\n", data->alarms);
364}
365
Jean Delvare2d457712006-09-24 20:52:15 +0200366static ssize_t show_alarm(struct device *dev, struct device_attribute *devattr,
367 char *buf)
368{
369 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
370 struct lm63_data *data = lm63_update_device(dev);
371 int bitnr = attr->index;
372
373 return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
374}
375
Jean Delvarebc51ae12005-06-05 20:32:27 +0200376static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
377static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR | S_IRUGO, show_fan,
378 set_fan, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, show_pwm1, set_pwm1);
381static DEVICE_ATTR(pwm1_enable, S_IRUGO, show_pwm1_enable, NULL);
382
Dirk Eibach2778fb12011-02-09 04:51:34 -0500383static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_local_temp8, NULL, 0);
384static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_local_temp8,
385 set_local_temp8, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Jean Delvarebc51ae12005-06-05 20:32:27 +0200387static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp11, NULL, 0);
388static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp11,
389 set_temp11, 1);
390static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp11,
391 set_temp11, 2);
Dirk Eibach2778fb12011-02-09 04:51:34 -0500392/*
393 * On LM63, temp2_crit can be set only once, which should be job
394 * of the bootloader.
395 */
396static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_remote_temp8,
397 NULL, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp2_crit_hyst,
399 set_temp2_crit_hyst);
400
Jean Delvare2d457712006-09-24 20:52:15 +0200401/* Individual alarm files */
402static SENSOR_DEVICE_ATTR(fan1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
403static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
Jean Delvare7817a392007-06-09 10:11:16 -0400404static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
Jean Delvare2d457712006-09-24 20:52:15 +0200405static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
406static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
407static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
408/* Raw alarm file for compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
410
Jean Delvare0e39e012006-09-24 21:16:40 +0200411static struct attribute *lm63_attributes[] = {
412 &dev_attr_pwm1.attr,
413 &dev_attr_pwm1_enable.attr,
414 &sensor_dev_attr_temp1_input.dev_attr.attr,
415 &sensor_dev_attr_temp2_input.dev_attr.attr,
416 &sensor_dev_attr_temp2_min.dev_attr.attr,
417 &sensor_dev_attr_temp1_max.dev_attr.attr,
418 &sensor_dev_attr_temp2_max.dev_attr.attr,
419 &sensor_dev_attr_temp2_crit.dev_attr.attr,
420 &dev_attr_temp2_crit_hyst.attr,
421
422 &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
Jean Delvare7817a392007-06-09 10:11:16 -0400423 &sensor_dev_attr_temp2_fault.dev_attr.attr,
Jean Delvare0e39e012006-09-24 21:16:40 +0200424 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
425 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
426 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
427 &dev_attr_alarms.attr,
428 NULL
429};
430
431static const struct attribute_group lm63_group = {
432 .attrs = lm63_attributes,
433};
434
435static struct attribute *lm63_attributes_fan1[] = {
436 &sensor_dev_attr_fan1_input.dev_attr.attr,
437 &sensor_dev_attr_fan1_min.dev_attr.attr,
438
439 &sensor_dev_attr_fan1_min_alarm.dev_attr.attr,
440 NULL
441};
442
443static const struct attribute_group lm63_group_fan1 = {
444 .attrs = lm63_attributes_fan1,
445};
446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447/*
448 * Real code
449 */
450
Jean Delvared5957be2008-07-16 19:30:13 +0200451/* Return 0 if detection is successful, -ENODEV otherwise */
Jean Delvare310ec792009-12-14 21:17:23 +0100452static int lm63_detect(struct i2c_client *new_client,
Jean Delvared5957be2008-07-16 19:30:13 +0200453 struct i2c_board_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454{
Jean Delvared5957be2008-07-16 19:30:13 +0200455 struct i2c_adapter *adapter = new_client->adapter;
Jean Delvare52df6442009-12-09 20:35:57 +0100456 u8 man_id, chip_id, reg_config1, reg_config2;
457 u8 reg_alert_status, reg_alert_mask;
Matthew Garrett10f2ed32010-05-27 19:58:38 +0200458 int address = new_client->addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
Jean Delvared5957be2008-07-16 19:30:13 +0200461 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
Jean Delvare52df6442009-12-09 20:35:57 +0100463 man_id = i2c_smbus_read_byte_data(new_client, LM63_REG_MAN_ID);
464 chip_id = i2c_smbus_read_byte_data(new_client, LM63_REG_CHIP_ID);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Jean Delvare52df6442009-12-09 20:35:57 +0100466 reg_config1 = i2c_smbus_read_byte_data(new_client,
467 LM63_REG_CONFIG1);
468 reg_config2 = i2c_smbus_read_byte_data(new_client,
469 LM63_REG_CONFIG2);
470 reg_alert_status = i2c_smbus_read_byte_data(new_client,
471 LM63_REG_ALERT_STATUS);
472 reg_alert_mask = i2c_smbus_read_byte_data(new_client,
473 LM63_REG_ALERT_MASK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Jean Delvare52df6442009-12-09 20:35:57 +0100475 if (man_id != 0x01 /* National Semiconductor */
Jean Delvare52df6442009-12-09 20:35:57 +0100476 || (reg_config1 & 0x18) != 0x00
477 || (reg_config2 & 0xF8) != 0x00
478 || (reg_alert_status & 0x20) != 0x00
479 || (reg_alert_mask & 0xA4) != 0xA4) {
480 dev_dbg(&adapter->dev,
481 "Unsupported chip (man_id=0x%02X, chip_id=0x%02X)\n",
482 man_id, chip_id);
483 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 }
485
Matthew Garrett10f2ed32010-05-27 19:58:38 +0200486 if (chip_id == 0x41 && address == 0x4c)
487 strlcpy(info->type, "lm63", I2C_NAME_SIZE);
488 else if (chip_id == 0x51 && (address == 0x18 || address == 0x4e))
489 strlcpy(info->type, "lm64", I2C_NAME_SIZE);
490 else
491 return -ENODEV;
Jean Delvared5957be2008-07-16 19:30:13 +0200492
493 return 0;
494}
495
496static int lm63_probe(struct i2c_client *new_client,
497 const struct i2c_device_id *id)
498{
499 struct lm63_data *data;
500 int err;
501
502 data = kzalloc(sizeof(struct lm63_data), GFP_KERNEL);
503 if (!data) {
504 err = -ENOMEM;
505 goto exit;
506 }
507
508 i2c_set_clientdata(new_client, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 data->valid = 0;
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100510 mutex_init(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Dirk Eibach2778fb12011-02-09 04:51:34 -0500512 /* Set the device type */
513 data->kind = id->driver_data;
514 if (data->kind == lm64)
515 data->temp2_offset = 16000;
516
517 /* Initialize chip */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 lm63_init_client(new_client);
519
520 /* Register sysfs hooks */
Jean Delvare0e39e012006-09-24 21:16:40 +0200521 if ((err = sysfs_create_group(&new_client->dev.kobj,
522 &lm63_group)))
Jean Delvared5957be2008-07-16 19:30:13 +0200523 goto exit_free;
Jean Delvare0e39e012006-09-24 21:16:40 +0200524 if (data->config & 0x04) { /* tachometer enabled */
525 if ((err = sysfs_create_group(&new_client->dev.kobj,
526 &lm63_group_fan1)))
527 goto exit_remove_files;
528 }
529
Tony Jones1beeffe2007-08-20 13:46:20 -0700530 data->hwmon_dev = hwmon_device_register(&new_client->dev);
531 if (IS_ERR(data->hwmon_dev)) {
532 err = PTR_ERR(data->hwmon_dev);
Jean Delvare0e39e012006-09-24 21:16:40 +0200533 goto exit_remove_files;
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400534 }
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 return 0;
537
Jean Delvare0e39e012006-09-24 21:16:40 +0200538exit_remove_files:
539 sysfs_remove_group(&new_client->dev.kobj, &lm63_group);
540 sysfs_remove_group(&new_client->dev.kobj, &lm63_group_fan1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541exit_free:
542 kfree(data);
543exit:
544 return err;
545}
546
547/* Idealy we shouldn't have to initialize anything, since the BIOS
548 should have taken care of everything */
549static void lm63_init_client(struct i2c_client *client)
550{
551 struct lm63_data *data = i2c_get_clientdata(client);
552
553 data->config = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
554 data->config_fan = i2c_smbus_read_byte_data(client,
555 LM63_REG_CONFIG_FAN);
556
557 /* Start converting if needed */
558 if (data->config & 0x40) { /* standby */
Joe Perches898eb712007-10-18 03:06:30 -0700559 dev_dbg(&client->dev, "Switching to operational mode\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 data->config &= 0xA7;
561 i2c_smbus_write_byte_data(client, LM63_REG_CONFIG1,
562 data->config);
563 }
564
565 /* We may need pwm1_freq before ever updating the client data */
566 data->pwm1_freq = i2c_smbus_read_byte_data(client, LM63_REG_PWM_FREQ);
567 if (data->pwm1_freq == 0)
568 data->pwm1_freq = 1;
569
570 /* Show some debug info about the LM63 configuration */
571 dev_dbg(&client->dev, "Alert/tach pin configured for %s\n",
572 (data->config & 0x04) ? "tachometer input" :
573 "alert output");
574 dev_dbg(&client->dev, "PWM clock %s kHz, output frequency %u Hz\n",
575 (data->config_fan & 0x08) ? "1.4" : "360",
576 ((data->config_fan & 0x08) ? 700 : 180000) / data->pwm1_freq);
577 dev_dbg(&client->dev, "PWM output active %s, %s mode\n",
578 (data->config_fan & 0x10) ? "low" : "high",
579 (data->config_fan & 0x20) ? "manual" : "auto");
580}
581
Jean Delvared5957be2008-07-16 19:30:13 +0200582static int lm63_remove(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400584 struct lm63_data *data = i2c_get_clientdata(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Tony Jones1beeffe2007-08-20 13:46:20 -0700586 hwmon_device_unregister(data->hwmon_dev);
Jean Delvare0e39e012006-09-24 21:16:40 +0200587 sysfs_remove_group(&client->dev.kobj, &lm63_group);
588 sysfs_remove_group(&client->dev.kobj, &lm63_group_fan1);
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400589
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400590 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 return 0;
592}
593
594static struct lm63_data *lm63_update_device(struct device *dev)
595{
596 struct i2c_client *client = to_i2c_client(dev);
597 struct lm63_data *data = i2c_get_clientdata(client);
598
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100599 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
601 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
602 if (data->config & 0x04) { /* tachometer enabled */
603 /* order matters for fan1_input */
Jean Delvarebc51ae12005-06-05 20:32:27 +0200604 data->fan[0] = i2c_smbus_read_byte_data(client,
605 LM63_REG_TACH_COUNT_LSB) & 0xFC;
606 data->fan[0] |= i2c_smbus_read_byte_data(client,
607 LM63_REG_TACH_COUNT_MSB) << 8;
608 data->fan[1] = (i2c_smbus_read_byte_data(client,
609 LM63_REG_TACH_LIMIT_LSB) & 0xFC)
610 | (i2c_smbus_read_byte_data(client,
611 LM63_REG_TACH_LIMIT_MSB) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 }
613
614 data->pwm1_freq = i2c_smbus_read_byte_data(client,
615 LM63_REG_PWM_FREQ);
616 if (data->pwm1_freq == 0)
617 data->pwm1_freq = 1;
618 data->pwm1_value = i2c_smbus_read_byte_data(client,
619 LM63_REG_PWM_VALUE);
620
Jean Delvarebc51ae12005-06-05 20:32:27 +0200621 data->temp8[0] = i2c_smbus_read_byte_data(client,
622 LM63_REG_LOCAL_TEMP);
623 data->temp8[1] = i2c_smbus_read_byte_data(client,
624 LM63_REG_LOCAL_HIGH);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626 /* order matters for temp2_input */
Jean Delvarebc51ae12005-06-05 20:32:27 +0200627 data->temp11[0] = i2c_smbus_read_byte_data(client,
628 LM63_REG_REMOTE_TEMP_MSB) << 8;
629 data->temp11[0] |= i2c_smbus_read_byte_data(client,
630 LM63_REG_REMOTE_TEMP_LSB);
631 data->temp11[1] = (i2c_smbus_read_byte_data(client,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 LM63_REG_REMOTE_LOW_MSB) << 8)
633 | i2c_smbus_read_byte_data(client,
634 LM63_REG_REMOTE_LOW_LSB);
Jean Delvarebc51ae12005-06-05 20:32:27 +0200635 data->temp11[2] = (i2c_smbus_read_byte_data(client,
636 LM63_REG_REMOTE_HIGH_MSB) << 8)
637 | i2c_smbus_read_byte_data(client,
638 LM63_REG_REMOTE_HIGH_LSB);
639 data->temp8[2] = i2c_smbus_read_byte_data(client,
640 LM63_REG_REMOTE_TCRIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 data->temp2_crit_hyst = i2c_smbus_read_byte_data(client,
642 LM63_REG_REMOTE_TCRIT_HYST);
643
644 data->alarms = i2c_smbus_read_byte_data(client,
645 LM63_REG_ALERT_STATUS) & 0x7F;
646
647 data->last_updated = jiffies;
648 data->valid = 1;
649 }
650
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100651 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
653 return data;
654}
655
656static int __init sensors_lm63_init(void)
657{
658 return i2c_add_driver(&lm63_driver);
659}
660
661static void __exit sensors_lm63_exit(void)
662{
663 i2c_del_driver(&lm63_driver);
664}
665
666MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
667MODULE_DESCRIPTION("LM63 driver");
668MODULE_LICENSE("GPL");
669
670module_init(sensors_lm63_init);
671module_exit(sensors_lm63_exit);