2 * lm63.c - driver for the National Semiconductor LM63 temperature sensor
3 * with integrated fan control
4 * Copyright (C) 2004-2008 Jean Delvare <jdelvare@suse.de>
5 * Based on the lm90 driver.
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
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.
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
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.
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.
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.
40 #include <linux/module.h>
41 #include <linux/init.h>
42 #include <linux/slab.h>
43 #include <linux/jiffies.h>
44 #include <linux/i2c.h>
45 #include <linux/hwmon-sysfs.h>
46 #include <linux/hwmon.h>
47 #include <linux/err.h>
48 #include <linux/mutex.h>
49 #include <linux/sysfs.h>
50 #include <linux/types.h>
54 * Address is fully defined internally and cannot be changed except for
55 * LM64 which has one pin dedicated to address selection.
56 * LM63 and LM96163 have address 0x4c.
57 * LM64 can have address 0x18 or 0x4e.
60 static const unsigned short normal_i2c[] = { 0x18, 0x4c, 0x4e, I2C_CLIENT_END };
66 #define LM63_REG_CONFIG1 0x03
67 #define LM63_REG_CONVRATE 0x04
68 #define LM63_REG_CONFIG2 0xBF
69 #define LM63_REG_CONFIG_FAN 0x4A
71 #define LM63_REG_TACH_COUNT_MSB 0x47
72 #define LM63_REG_TACH_COUNT_LSB 0x46
73 #define LM63_REG_TACH_LIMIT_MSB 0x49
74 #define LM63_REG_TACH_LIMIT_LSB 0x48
76 #define LM63_REG_PWM_VALUE 0x4C
77 #define LM63_REG_PWM_FREQ 0x4D
78 #define LM63_REG_LUT_TEMP_HYST 0x4F
79 #define LM63_REG_LUT_TEMP(nr) (0x50 + 2 * (nr))
80 #define LM63_REG_LUT_PWM(nr) (0x51 + 2 * (nr))
82 #define LM63_REG_LOCAL_TEMP 0x00
83 #define LM63_REG_LOCAL_HIGH 0x05
85 #define LM63_REG_REMOTE_TEMP_MSB 0x01
86 #define LM63_REG_REMOTE_TEMP_LSB 0x10
87 #define LM63_REG_REMOTE_OFFSET_MSB 0x11
88 #define LM63_REG_REMOTE_OFFSET_LSB 0x12
89 #define LM63_REG_REMOTE_HIGH_MSB 0x07
90 #define LM63_REG_REMOTE_HIGH_LSB 0x13
91 #define LM63_REG_REMOTE_LOW_MSB 0x08
92 #define LM63_REG_REMOTE_LOW_LSB 0x14
93 #define LM63_REG_REMOTE_TCRIT 0x19
94 #define LM63_REG_REMOTE_TCRIT_HYST 0x21
96 #define LM63_REG_ALERT_STATUS 0x02
97 #define LM63_REG_ALERT_MASK 0x16
99 #define LM63_REG_MAN_ID 0xFE
100 #define LM63_REG_CHIP_ID 0xFF
102 #define LM96163_REG_TRUTHERM 0x30
103 #define LM96163_REG_REMOTE_TEMP_U_MSB 0x31
104 #define LM96163_REG_REMOTE_TEMP_U_LSB 0x32
105 #define LM96163_REG_CONFIG_ENHANCED 0x45
107 #define LM63_MAX_CONVRATE 9
109 #define LM63_MAX_CONVRATE_HZ 32
110 #define LM96163_MAX_CONVRATE_HZ 26
113 * Conversions and various macros
114 * For tachometer counts, the LM63 uses 16-bit values.
115 * For local temperature and high limit, remote critical limit and hysteresis
116 * value, it uses signed 8-bit values with LSB = 1 degree Celsius.
117 * For remote temperature, low and high limits, it uses signed 11-bit values
118 * with LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
119 * For LM64 the actual remote diode temperature is 16 degree Celsius higher
120 * than the register reading. Remote temperature setpoints have to be
121 * adapted accordingly.
124 #define FAN_FROM_REG(reg) ((reg) == 0xFFFC || (reg) == 0 ? 0 : \
126 #define FAN_TO_REG(val) ((val) <= 82 ? 0xFFFC : \
127 (5400000 / (val)) & 0xFFFC)
128 #define TEMP8_FROM_REG(reg) ((reg) * 1000)
129 #define TEMP8_TO_REG(val) DIV_ROUND_CLOSEST(clamp_val((val), -128000, \
131 #define TEMP8U_TO_REG(val) DIV_ROUND_CLOSEST(clamp_val((val), 0, \
133 #define TEMP11_FROM_REG(reg) ((reg) / 32 * 125)
134 #define TEMP11_TO_REG(val) (DIV_ROUND_CLOSEST(clamp_val((val), -128000, \
136 #define TEMP11U_TO_REG(val) (DIV_ROUND_CLOSEST(clamp_val((val), 0, \
138 #define HYST_TO_REG(val) DIV_ROUND_CLOSEST(clamp_val((val), 0, 127000), \
141 #define UPDATE_INTERVAL(max, rate) \
142 ((1000 << (LM63_MAX_CONVRATE - (rate))) / (max))
144 enum chips { lm63, lm64, lm96163 };
147 * Client data (each client gets its own)
151 struct i2c_client *client;
152 struct mutex update_lock;
153 const struct attribute_group *groups[5];
154 char valid; /* zero until following fields are valid */
155 char lut_valid; /* zero until lut fields are valid */
156 unsigned long last_updated; /* in jiffies */
157 unsigned long lut_last_updated; /* in jiffies */
161 int update_interval; /* in milliseconds */
163 int lut_size; /* 8 or 12 */
165 /* registers values */
166 u8 config, config_fan;
167 u16 fan[2]; /* 0: input
170 u8 pwm1[13]; /* 0: current output
171 1-12: lookup table */
172 s8 temp8[15]; /* 0: local input
174 2: remote critical limit
175 3-14: lookup table */
176 s16 temp11[4]; /* 0: remote input
180 u16 temp11u; /* remote input (unsigned) */
185 bool lut_temp_highres;
186 bool remote_unsigned; /* true if unsigned remote upper limits */
190 static inline int temp8_from_reg(struct lm63_data *data, int nr)
192 if (data->remote_unsigned)
193 return TEMP8_FROM_REG((u8)data->temp8[nr]);
194 return TEMP8_FROM_REG(data->temp8[nr]);
197 static inline int lut_temp_from_reg(struct lm63_data *data, int nr)
199 return data->temp8[nr] * (data->lut_temp_highres ? 500 : 1000);
202 static inline int lut_temp_to_reg(struct lm63_data *data, long val)
204 val -= data->temp2_offset;
205 if (data->lut_temp_highres)
206 return DIV_ROUND_CLOSEST(clamp_val(val, 0, 127500), 500);
208 return DIV_ROUND_CLOSEST(clamp_val(val, 0, 127000), 1000);
212 * Update the lookup table register cache.
213 * client->update_lock must be held when calling this function.
215 static void lm63_update_lut(struct lm63_data *data)
217 struct i2c_client *client = data->client;
220 if (time_after(jiffies, data->lut_last_updated + 5 * HZ) ||
222 for (i = 0; i < data->lut_size; i++) {
223 data->pwm1[1 + i] = i2c_smbus_read_byte_data(client,
224 LM63_REG_LUT_PWM(i));
225 data->temp8[3 + i] = i2c_smbus_read_byte_data(client,
226 LM63_REG_LUT_TEMP(i));
228 data->lut_temp_hyst = i2c_smbus_read_byte_data(client,
229 LM63_REG_LUT_TEMP_HYST);
231 data->lut_last_updated = jiffies;
236 static struct lm63_data *lm63_update_device(struct device *dev)
238 struct lm63_data *data = dev_get_drvdata(dev);
239 struct i2c_client *client = data->client;
240 unsigned long next_update;
242 mutex_lock(&data->update_lock);
244 next_update = data->last_updated +
245 msecs_to_jiffies(data->update_interval);
246 if (time_after(jiffies, next_update) || !data->valid) {
247 if (data->config & 0x04) { /* tachometer enabled */
248 /* order matters for fan1_input */
249 data->fan[0] = i2c_smbus_read_byte_data(client,
250 LM63_REG_TACH_COUNT_LSB) & 0xFC;
251 data->fan[0] |= i2c_smbus_read_byte_data(client,
252 LM63_REG_TACH_COUNT_MSB) << 8;
253 data->fan[1] = (i2c_smbus_read_byte_data(client,
254 LM63_REG_TACH_LIMIT_LSB) & 0xFC)
255 | (i2c_smbus_read_byte_data(client,
256 LM63_REG_TACH_LIMIT_MSB) << 8);
259 data->pwm1_freq = i2c_smbus_read_byte_data(client,
261 if (data->pwm1_freq == 0)
263 data->pwm1[0] = i2c_smbus_read_byte_data(client,
266 data->temp8[0] = i2c_smbus_read_byte_data(client,
267 LM63_REG_LOCAL_TEMP);
268 data->temp8[1] = i2c_smbus_read_byte_data(client,
269 LM63_REG_LOCAL_HIGH);
271 /* order matters for temp2_input */
272 data->temp11[0] = i2c_smbus_read_byte_data(client,
273 LM63_REG_REMOTE_TEMP_MSB) << 8;
274 data->temp11[0] |= i2c_smbus_read_byte_data(client,
275 LM63_REG_REMOTE_TEMP_LSB);
276 data->temp11[1] = (i2c_smbus_read_byte_data(client,
277 LM63_REG_REMOTE_LOW_MSB) << 8)
278 | i2c_smbus_read_byte_data(client,
279 LM63_REG_REMOTE_LOW_LSB);
280 data->temp11[2] = (i2c_smbus_read_byte_data(client,
281 LM63_REG_REMOTE_HIGH_MSB) << 8)
282 | i2c_smbus_read_byte_data(client,
283 LM63_REG_REMOTE_HIGH_LSB);
284 data->temp11[3] = (i2c_smbus_read_byte_data(client,
285 LM63_REG_REMOTE_OFFSET_MSB) << 8)
286 | i2c_smbus_read_byte_data(client,
287 LM63_REG_REMOTE_OFFSET_LSB);
289 if (data->kind == lm96163)
290 data->temp11u = (i2c_smbus_read_byte_data(client,
291 LM96163_REG_REMOTE_TEMP_U_MSB) << 8)
292 | i2c_smbus_read_byte_data(client,
293 LM96163_REG_REMOTE_TEMP_U_LSB);
295 data->temp8[2] = i2c_smbus_read_byte_data(client,
296 LM63_REG_REMOTE_TCRIT);
297 data->temp2_crit_hyst = i2c_smbus_read_byte_data(client,
298 LM63_REG_REMOTE_TCRIT_HYST);
300 data->alarms = i2c_smbus_read_byte_data(client,
301 LM63_REG_ALERT_STATUS) & 0x7F;
303 data->last_updated = jiffies;
307 lm63_update_lut(data);
309 mutex_unlock(&data->update_lock);
315 * Trip points in the lookup table should be in ascending order for both
316 * temperatures and PWM output values.
318 static int lm63_lut_looks_bad(struct device *dev, struct lm63_data *data)
322 mutex_lock(&data->update_lock);
323 lm63_update_lut(data);
325 for (i = 1; i < data->lut_size; i++) {
326 if (data->pwm1[1 + i - 1] > data->pwm1[1 + i]
327 || data->temp8[3 + i - 1] > data->temp8[3 + i]) {
329 "Lookup table doesn't look sane (check entries %d and %d)\n",
334 mutex_unlock(&data->update_lock);
336 return i == data->lut_size ? 0 : 1;
340 * Sysfs callback functions and files
343 static ssize_t show_fan(struct device *dev, struct device_attribute *devattr,
346 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
347 struct lm63_data *data = lm63_update_device(dev);
348 return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[attr->index]));
351 static ssize_t set_fan(struct device *dev, struct device_attribute *dummy,
352 const char *buf, size_t count)
354 struct lm63_data *data = dev_get_drvdata(dev);
355 struct i2c_client *client = data->client;
359 err = kstrtoul(buf, 10, &val);
363 mutex_lock(&data->update_lock);
364 data->fan[1] = FAN_TO_REG(val);
365 i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_LSB,
366 data->fan[1] & 0xFF);
367 i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_MSB,
369 mutex_unlock(&data->update_lock);
373 static ssize_t show_pwm1(struct device *dev, struct device_attribute *devattr,
376 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
377 struct lm63_data *data = lm63_update_device(dev);
378 int nr = attr->index;
381 if (data->pwm_highres)
382 pwm = data->pwm1[nr];
384 pwm = data->pwm1[nr] >= 2 * data->pwm1_freq ?
385 255 : (data->pwm1[nr] * 255 + data->pwm1_freq) /
386 (2 * data->pwm1_freq);
388 return sprintf(buf, "%d\n", pwm);
391 static ssize_t set_pwm1(struct device *dev, struct device_attribute *devattr,
392 const char *buf, size_t count)
394 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
395 struct lm63_data *data = dev_get_drvdata(dev);
396 struct i2c_client *client = data->client;
397 int nr = attr->index;
402 if (!(data->config_fan & 0x20)) /* register is read-only */
405 err = kstrtoul(buf, 10, &val);
409 reg = nr ? LM63_REG_LUT_PWM(nr - 1) : LM63_REG_PWM_VALUE;
410 val = clamp_val(val, 0, 255);
412 mutex_lock(&data->update_lock);
413 data->pwm1[nr] = data->pwm_highres ? val :
414 (val * data->pwm1_freq * 2 + 127) / 255;
415 i2c_smbus_write_byte_data(client, reg, data->pwm1[nr]);
416 mutex_unlock(&data->update_lock);
420 static ssize_t show_pwm1_enable(struct device *dev,
421 struct device_attribute *dummy, char *buf)
423 struct lm63_data *data = lm63_update_device(dev);
424 return sprintf(buf, "%d\n", data->config_fan & 0x20 ? 1 : 2);
427 static ssize_t set_pwm1_enable(struct device *dev,
428 struct device_attribute *dummy,
429 const char *buf, size_t count)
431 struct lm63_data *data = dev_get_drvdata(dev);
432 struct i2c_client *client = data->client;
436 err = kstrtoul(buf, 10, &val);
439 if (val < 1 || val > 2)
443 * Only let the user switch to automatic mode if the lookup table
446 if (val == 2 && lm63_lut_looks_bad(dev, data))
449 mutex_lock(&data->update_lock);
450 data->config_fan = i2c_smbus_read_byte_data(client,
451 LM63_REG_CONFIG_FAN);
453 data->config_fan |= 0x20;
455 data->config_fan &= ~0x20;
456 i2c_smbus_write_byte_data(client, LM63_REG_CONFIG_FAN,
458 mutex_unlock(&data->update_lock);
463 * There are 8bit registers for both local(temp1) and remote(temp2) sensor.
464 * For remote sensor registers temp2_offset has to be considered,
465 * for local sensor it must not.
466 * So we need separate 8bit accessors for local and remote sensor.
468 static ssize_t show_local_temp8(struct device *dev,
469 struct device_attribute *devattr,
472 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
473 struct lm63_data *data = lm63_update_device(dev);
474 return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[attr->index]));
477 static ssize_t show_remote_temp8(struct device *dev,
478 struct device_attribute *devattr,
481 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
482 struct lm63_data *data = lm63_update_device(dev);
483 return sprintf(buf, "%d\n", temp8_from_reg(data, attr->index)
484 + data->temp2_offset);
487 static ssize_t show_lut_temp(struct device *dev,
488 struct device_attribute *devattr,
491 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
492 struct lm63_data *data = lm63_update_device(dev);
493 return sprintf(buf, "%d\n", lut_temp_from_reg(data, attr->index)
494 + data->temp2_offset);
497 static ssize_t set_temp8(struct device *dev, struct device_attribute *devattr,
498 const char *buf, size_t count)
500 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
501 struct lm63_data *data = dev_get_drvdata(dev);
502 struct i2c_client *client = data->client;
503 int nr = attr->index;
509 err = kstrtol(buf, 10, &val);
513 mutex_lock(&data->update_lock);
516 reg = LM63_REG_REMOTE_TCRIT;
517 if (data->remote_unsigned)
518 temp = TEMP8U_TO_REG(val - data->temp2_offset);
520 temp = TEMP8_TO_REG(val - data->temp2_offset);
523 reg = LM63_REG_LOCAL_HIGH;
524 temp = TEMP8_TO_REG(val);
526 default: /* lookup table */
527 reg = LM63_REG_LUT_TEMP(nr - 3);
528 temp = lut_temp_to_reg(data, val);
530 data->temp8[nr] = temp;
531 i2c_smbus_write_byte_data(client, reg, temp);
532 mutex_unlock(&data->update_lock);
536 static ssize_t show_temp11(struct device *dev, struct device_attribute *devattr,
539 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
540 struct lm63_data *data = lm63_update_device(dev);
541 int nr = attr->index;
546 * Use unsigned temperature unless its value is zero.
547 * If it is zero, use signed temperature.
550 temp = TEMP11_FROM_REG(data->temp11u);
552 temp = TEMP11_FROM_REG(data->temp11[nr]);
554 if (data->remote_unsigned && nr == 2)
555 temp = TEMP11_FROM_REG((u16)data->temp11[nr]);
557 temp = TEMP11_FROM_REG(data->temp11[nr]);
559 return sprintf(buf, "%d\n", temp + data->temp2_offset);
562 static ssize_t set_temp11(struct device *dev, struct device_attribute *devattr,
563 const char *buf, size_t count)
565 static const u8 reg[6] = {
566 LM63_REG_REMOTE_LOW_MSB,
567 LM63_REG_REMOTE_LOW_LSB,
568 LM63_REG_REMOTE_HIGH_MSB,
569 LM63_REG_REMOTE_HIGH_LSB,
570 LM63_REG_REMOTE_OFFSET_MSB,
571 LM63_REG_REMOTE_OFFSET_LSB,
574 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
575 struct lm63_data *data = dev_get_drvdata(dev);
576 struct i2c_client *client = data->client;
579 int nr = attr->index;
581 err = kstrtol(buf, 10, &val);
585 mutex_lock(&data->update_lock);
586 if (data->remote_unsigned && nr == 2)
587 data->temp11[nr] = TEMP11U_TO_REG(val - data->temp2_offset);
589 data->temp11[nr] = TEMP11_TO_REG(val - data->temp2_offset);
591 i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2],
592 data->temp11[nr] >> 8);
593 i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2 + 1],
594 data->temp11[nr] & 0xff);
595 mutex_unlock(&data->update_lock);
600 * Hysteresis register holds a relative value, while we want to present
601 * an absolute to user-space
603 static ssize_t show_temp2_crit_hyst(struct device *dev,
604 struct device_attribute *dummy, char *buf)
606 struct lm63_data *data = lm63_update_device(dev);
607 return sprintf(buf, "%d\n", temp8_from_reg(data, 2)
609 - TEMP8_FROM_REG(data->temp2_crit_hyst));
612 static ssize_t show_lut_temp_hyst(struct device *dev,
613 struct device_attribute *devattr, char *buf)
615 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
616 struct lm63_data *data = lm63_update_device(dev);
618 return sprintf(buf, "%d\n", lut_temp_from_reg(data, attr->index)
620 - TEMP8_FROM_REG(data->lut_temp_hyst));
624 * And now the other way around, user-space provides an absolute
625 * hysteresis value and we have to store a relative one
627 static ssize_t set_temp2_crit_hyst(struct device *dev,
628 struct device_attribute *dummy,
629 const char *buf, size_t count)
631 struct lm63_data *data = dev_get_drvdata(dev);
632 struct i2c_client *client = data->client;
637 err = kstrtol(buf, 10, &val);
641 mutex_lock(&data->update_lock);
642 hyst = temp8_from_reg(data, 2) + data->temp2_offset - val;
643 i2c_smbus_write_byte_data(client, LM63_REG_REMOTE_TCRIT_HYST,
645 mutex_unlock(&data->update_lock);
650 * Set conversion rate.
651 * client->update_lock must be held when calling this function.
653 static void lm63_set_convrate(struct lm63_data *data, unsigned int interval)
655 struct i2c_client *client = data->client;
656 unsigned int update_interval;
659 /* Shift calculations to avoid rounding errors */
662 /* find the nearest update rate */
663 update_interval = (1 << (LM63_MAX_CONVRATE + 6)) * 1000
664 / data->max_convrate_hz;
665 for (i = 0; i < LM63_MAX_CONVRATE; i++, update_interval >>= 1)
666 if (interval >= update_interval * 3 / 4)
669 i2c_smbus_write_byte_data(client, LM63_REG_CONVRATE, i);
670 data->update_interval = UPDATE_INTERVAL(data->max_convrate_hz, i);
673 static ssize_t show_update_interval(struct device *dev,
674 struct device_attribute *attr, char *buf)
676 struct lm63_data *data = dev_get_drvdata(dev);
678 return sprintf(buf, "%u\n", data->update_interval);
681 static ssize_t set_update_interval(struct device *dev,
682 struct device_attribute *attr,
683 const char *buf, size_t count)
685 struct lm63_data *data = dev_get_drvdata(dev);
689 err = kstrtoul(buf, 10, &val);
693 mutex_lock(&data->update_lock);
694 lm63_set_convrate(data, clamp_val(val, 0, 100000));
695 mutex_unlock(&data->update_lock);
700 static ssize_t show_type(struct device *dev, struct device_attribute *attr,
703 struct lm63_data *data = dev_get_drvdata(dev);
705 return sprintf(buf, data->trutherm ? "1\n" : "2\n");
708 static ssize_t set_type(struct device *dev, struct device_attribute *attr,
709 const char *buf, size_t count)
711 struct lm63_data *data = dev_get_drvdata(dev);
712 struct i2c_client *client = data->client;
717 ret = kstrtoul(buf, 10, &val);
720 if (val != 1 && val != 2)
723 mutex_lock(&data->update_lock);
724 data->trutherm = val == 1;
725 reg = i2c_smbus_read_byte_data(client, LM96163_REG_TRUTHERM) & ~0x02;
726 i2c_smbus_write_byte_data(client, LM96163_REG_TRUTHERM,
727 reg | (data->trutherm ? 0x02 : 0x00));
729 mutex_unlock(&data->update_lock);
734 static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy,
737 struct lm63_data *data = lm63_update_device(dev);
738 return sprintf(buf, "%u\n", data->alarms);
741 static ssize_t show_alarm(struct device *dev, struct device_attribute *devattr,
744 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
745 struct lm63_data *data = lm63_update_device(dev);
746 int bitnr = attr->index;
748 return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
751 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
752 static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR | S_IRUGO, show_fan,
755 static SENSOR_DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, show_pwm1, set_pwm1, 0);
756 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
757 show_pwm1_enable, set_pwm1_enable);
758 static SENSOR_DEVICE_ATTR(pwm1_auto_point1_pwm, S_IWUSR | S_IRUGO,
759 show_pwm1, set_pwm1, 1);
760 static SENSOR_DEVICE_ATTR(pwm1_auto_point1_temp, S_IWUSR | S_IRUGO,
761 show_lut_temp, set_temp8, 3);
762 static SENSOR_DEVICE_ATTR(pwm1_auto_point1_temp_hyst, S_IRUGO,
763 show_lut_temp_hyst, NULL, 3);
764 static SENSOR_DEVICE_ATTR(pwm1_auto_point2_pwm, S_IWUSR | S_IRUGO,
765 show_pwm1, set_pwm1, 2);
766 static SENSOR_DEVICE_ATTR(pwm1_auto_point2_temp, S_IWUSR | S_IRUGO,
767 show_lut_temp, set_temp8, 4);
768 static SENSOR_DEVICE_ATTR(pwm1_auto_point2_temp_hyst, S_IRUGO,
769 show_lut_temp_hyst, NULL, 4);
770 static SENSOR_DEVICE_ATTR(pwm1_auto_point3_pwm, S_IWUSR | S_IRUGO,
771 show_pwm1, set_pwm1, 3);
772 static SENSOR_DEVICE_ATTR(pwm1_auto_point3_temp, S_IWUSR | S_IRUGO,
773 show_lut_temp, set_temp8, 5);
774 static SENSOR_DEVICE_ATTR(pwm1_auto_point3_temp_hyst, S_IRUGO,
775 show_lut_temp_hyst, NULL, 5);
776 static SENSOR_DEVICE_ATTR(pwm1_auto_point4_pwm, S_IWUSR | S_IRUGO,
777 show_pwm1, set_pwm1, 4);
778 static SENSOR_DEVICE_ATTR(pwm1_auto_point4_temp, S_IWUSR | S_IRUGO,
779 show_lut_temp, set_temp8, 6);
780 static SENSOR_DEVICE_ATTR(pwm1_auto_point4_temp_hyst, S_IRUGO,
781 show_lut_temp_hyst, NULL, 6);
782 static SENSOR_DEVICE_ATTR(pwm1_auto_point5_pwm, S_IWUSR | S_IRUGO,
783 show_pwm1, set_pwm1, 5);
784 static SENSOR_DEVICE_ATTR(pwm1_auto_point5_temp, S_IWUSR | S_IRUGO,
785 show_lut_temp, set_temp8, 7);
786 static SENSOR_DEVICE_ATTR(pwm1_auto_point5_temp_hyst, S_IRUGO,
787 show_lut_temp_hyst, NULL, 7);
788 static SENSOR_DEVICE_ATTR(pwm1_auto_point6_pwm, S_IWUSR | S_IRUGO,
789 show_pwm1, set_pwm1, 6);
790 static SENSOR_DEVICE_ATTR(pwm1_auto_point6_temp, S_IWUSR | S_IRUGO,
791 show_lut_temp, set_temp8, 8);
792 static SENSOR_DEVICE_ATTR(pwm1_auto_point6_temp_hyst, S_IRUGO,
793 show_lut_temp_hyst, NULL, 8);
794 static SENSOR_DEVICE_ATTR(pwm1_auto_point7_pwm, S_IWUSR | S_IRUGO,
795 show_pwm1, set_pwm1, 7);
796 static SENSOR_DEVICE_ATTR(pwm1_auto_point7_temp, S_IWUSR | S_IRUGO,
797 show_lut_temp, set_temp8, 9);
798 static SENSOR_DEVICE_ATTR(pwm1_auto_point7_temp_hyst, S_IRUGO,
799 show_lut_temp_hyst, NULL, 9);
800 static SENSOR_DEVICE_ATTR(pwm1_auto_point8_pwm, S_IWUSR | S_IRUGO,
801 show_pwm1, set_pwm1, 8);
802 static SENSOR_DEVICE_ATTR(pwm1_auto_point8_temp, S_IWUSR | S_IRUGO,
803 show_lut_temp, set_temp8, 10);
804 static SENSOR_DEVICE_ATTR(pwm1_auto_point8_temp_hyst, S_IRUGO,
805 show_lut_temp_hyst, NULL, 10);
806 static SENSOR_DEVICE_ATTR(pwm1_auto_point9_pwm, S_IWUSR | S_IRUGO,
807 show_pwm1, set_pwm1, 9);
808 static SENSOR_DEVICE_ATTR(pwm1_auto_point9_temp, S_IWUSR | S_IRUGO,
809 show_lut_temp, set_temp8, 11);
810 static SENSOR_DEVICE_ATTR(pwm1_auto_point9_temp_hyst, S_IRUGO,
811 show_lut_temp_hyst, NULL, 11);
812 static SENSOR_DEVICE_ATTR(pwm1_auto_point10_pwm, S_IWUSR | S_IRUGO,
813 show_pwm1, set_pwm1, 10);
814 static SENSOR_DEVICE_ATTR(pwm1_auto_point10_temp, S_IWUSR | S_IRUGO,
815 show_lut_temp, set_temp8, 12);
816 static SENSOR_DEVICE_ATTR(pwm1_auto_point10_temp_hyst, S_IRUGO,
817 show_lut_temp_hyst, NULL, 12);
818 static SENSOR_DEVICE_ATTR(pwm1_auto_point11_pwm, S_IWUSR | S_IRUGO,
819 show_pwm1, set_pwm1, 11);
820 static SENSOR_DEVICE_ATTR(pwm1_auto_point11_temp, S_IWUSR | S_IRUGO,
821 show_lut_temp, set_temp8, 13);
822 static SENSOR_DEVICE_ATTR(pwm1_auto_point11_temp_hyst, S_IRUGO,
823 show_lut_temp_hyst, NULL, 13);
824 static SENSOR_DEVICE_ATTR(pwm1_auto_point12_pwm, S_IWUSR | S_IRUGO,
825 show_pwm1, set_pwm1, 12);
826 static SENSOR_DEVICE_ATTR(pwm1_auto_point12_temp, S_IWUSR | S_IRUGO,
827 show_lut_temp, set_temp8, 14);
828 static SENSOR_DEVICE_ATTR(pwm1_auto_point12_temp_hyst, S_IRUGO,
829 show_lut_temp_hyst, NULL, 14);
831 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_local_temp8, NULL, 0);
832 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_local_temp8,
835 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp11, NULL, 0);
836 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp11,
838 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp11,
840 static SENSOR_DEVICE_ATTR(temp2_offset, S_IWUSR | S_IRUGO, show_temp11,
842 static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_remote_temp8,
844 static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp2_crit_hyst,
845 set_temp2_crit_hyst);
847 static DEVICE_ATTR(temp2_type, S_IWUSR | S_IRUGO, show_type, set_type);
849 /* Individual alarm files */
850 static SENSOR_DEVICE_ATTR(fan1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
851 static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
852 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
853 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
854 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
855 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
856 /* Raw alarm file for compatibility */
857 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
859 static DEVICE_ATTR(update_interval, S_IRUGO | S_IWUSR, show_update_interval,
860 set_update_interval);
862 static struct attribute *lm63_attributes[] = {
863 &sensor_dev_attr_pwm1.dev_attr.attr,
864 &dev_attr_pwm1_enable.attr,
865 &sensor_dev_attr_pwm1_auto_point1_pwm.dev_attr.attr,
866 &sensor_dev_attr_pwm1_auto_point1_temp.dev_attr.attr,
867 &sensor_dev_attr_pwm1_auto_point1_temp_hyst.dev_attr.attr,
868 &sensor_dev_attr_pwm1_auto_point2_pwm.dev_attr.attr,
869 &sensor_dev_attr_pwm1_auto_point2_temp.dev_attr.attr,
870 &sensor_dev_attr_pwm1_auto_point2_temp_hyst.dev_attr.attr,
871 &sensor_dev_attr_pwm1_auto_point3_pwm.dev_attr.attr,
872 &sensor_dev_attr_pwm1_auto_point3_temp.dev_attr.attr,
873 &sensor_dev_attr_pwm1_auto_point3_temp_hyst.dev_attr.attr,
874 &sensor_dev_attr_pwm1_auto_point4_pwm.dev_attr.attr,
875 &sensor_dev_attr_pwm1_auto_point4_temp.dev_attr.attr,
876 &sensor_dev_attr_pwm1_auto_point4_temp_hyst.dev_attr.attr,
877 &sensor_dev_attr_pwm1_auto_point5_pwm.dev_attr.attr,
878 &sensor_dev_attr_pwm1_auto_point5_temp.dev_attr.attr,
879 &sensor_dev_attr_pwm1_auto_point5_temp_hyst.dev_attr.attr,
880 &sensor_dev_attr_pwm1_auto_point6_pwm.dev_attr.attr,
881 &sensor_dev_attr_pwm1_auto_point6_temp.dev_attr.attr,
882 &sensor_dev_attr_pwm1_auto_point6_temp_hyst.dev_attr.attr,
883 &sensor_dev_attr_pwm1_auto_point7_pwm.dev_attr.attr,
884 &sensor_dev_attr_pwm1_auto_point7_temp.dev_attr.attr,
885 &sensor_dev_attr_pwm1_auto_point7_temp_hyst.dev_attr.attr,
886 &sensor_dev_attr_pwm1_auto_point8_pwm.dev_attr.attr,
887 &sensor_dev_attr_pwm1_auto_point8_temp.dev_attr.attr,
888 &sensor_dev_attr_pwm1_auto_point8_temp_hyst.dev_attr.attr,
890 &sensor_dev_attr_temp1_input.dev_attr.attr,
891 &sensor_dev_attr_temp2_input.dev_attr.attr,
892 &sensor_dev_attr_temp2_min.dev_attr.attr,
893 &sensor_dev_attr_temp1_max.dev_attr.attr,
894 &sensor_dev_attr_temp2_max.dev_attr.attr,
895 &sensor_dev_attr_temp2_offset.dev_attr.attr,
896 &sensor_dev_attr_temp2_crit.dev_attr.attr,
897 &dev_attr_temp2_crit_hyst.attr,
899 &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
900 &sensor_dev_attr_temp2_fault.dev_attr.attr,
901 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
902 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
903 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
904 &dev_attr_alarms.attr,
905 &dev_attr_update_interval.attr,
909 static struct attribute *lm63_attributes_temp2_type[] = {
910 &dev_attr_temp2_type.attr,
914 static const struct attribute_group lm63_group_temp2_type = {
915 .attrs = lm63_attributes_temp2_type,
918 static struct attribute *lm63_attributes_extra_lut[] = {
919 &sensor_dev_attr_pwm1_auto_point9_pwm.dev_attr.attr,
920 &sensor_dev_attr_pwm1_auto_point9_temp.dev_attr.attr,
921 &sensor_dev_attr_pwm1_auto_point9_temp_hyst.dev_attr.attr,
922 &sensor_dev_attr_pwm1_auto_point10_pwm.dev_attr.attr,
923 &sensor_dev_attr_pwm1_auto_point10_temp.dev_attr.attr,
924 &sensor_dev_attr_pwm1_auto_point10_temp_hyst.dev_attr.attr,
925 &sensor_dev_attr_pwm1_auto_point11_pwm.dev_attr.attr,
926 &sensor_dev_attr_pwm1_auto_point11_temp.dev_attr.attr,
927 &sensor_dev_attr_pwm1_auto_point11_temp_hyst.dev_attr.attr,
928 &sensor_dev_attr_pwm1_auto_point12_pwm.dev_attr.attr,
929 &sensor_dev_attr_pwm1_auto_point12_temp.dev_attr.attr,
930 &sensor_dev_attr_pwm1_auto_point12_temp_hyst.dev_attr.attr,
934 static const struct attribute_group lm63_group_extra_lut = {
935 .attrs = lm63_attributes_extra_lut,
939 * On LM63, temp2_crit can be set only once, which should be job
941 * On LM64, temp2_crit can always be set.
942 * On LM96163, temp2_crit can be set if bit 1 of the configuration
945 static umode_t lm63_attribute_mode(struct kobject *kobj,
946 struct attribute *attr, int index)
948 struct device *dev = container_of(kobj, struct device, kobj);
949 struct lm63_data *data = dev_get_drvdata(dev);
951 if (attr == &sensor_dev_attr_temp2_crit.dev_attr.attr
952 && (data->kind == lm64 ||
953 (data->kind == lm96163 && (data->config & 0x02))))
954 return attr->mode | S_IWUSR;
959 static const struct attribute_group lm63_group = {
960 .is_visible = lm63_attribute_mode,
961 .attrs = lm63_attributes,
964 static struct attribute *lm63_attributes_fan1[] = {
965 &sensor_dev_attr_fan1_input.dev_attr.attr,
966 &sensor_dev_attr_fan1_min.dev_attr.attr,
968 &sensor_dev_attr_fan1_min_alarm.dev_attr.attr,
972 static const struct attribute_group lm63_group_fan1 = {
973 .attrs = lm63_attributes_fan1,
980 /* Return 0 if detection is successful, -ENODEV otherwise */
981 static int lm63_detect(struct i2c_client *client,
982 struct i2c_board_info *info)
984 struct i2c_adapter *adapter = client->adapter;
985 u8 man_id, chip_id, reg_config1, reg_config2;
986 u8 reg_alert_status, reg_alert_mask;
987 int address = client->addr;
989 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
992 man_id = i2c_smbus_read_byte_data(client, LM63_REG_MAN_ID);
993 chip_id = i2c_smbus_read_byte_data(client, LM63_REG_CHIP_ID);
995 reg_config1 = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
996 reg_config2 = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG2);
997 reg_alert_status = i2c_smbus_read_byte_data(client,
998 LM63_REG_ALERT_STATUS);
999 reg_alert_mask = i2c_smbus_read_byte_data(client, LM63_REG_ALERT_MASK);
1001 if (man_id != 0x01 /* National Semiconductor */
1002 || (reg_config1 & 0x18) != 0x00
1003 || (reg_config2 & 0xF8) != 0x00
1004 || (reg_alert_status & 0x20) != 0x00
1005 || (reg_alert_mask & 0xA4) != 0xA4) {
1006 dev_dbg(&adapter->dev,
1007 "Unsupported chip (man_id=0x%02X, chip_id=0x%02X)\n",
1012 if (chip_id == 0x41 && address == 0x4c)
1013 strlcpy(info->type, "lm63", I2C_NAME_SIZE);
1014 else if (chip_id == 0x51 && (address == 0x18 || address == 0x4e))
1015 strlcpy(info->type, "lm64", I2C_NAME_SIZE);
1016 else if (chip_id == 0x49 && address == 0x4c)
1017 strlcpy(info->type, "lm96163", I2C_NAME_SIZE);
1025 * Ideally we shouldn't have to initialize anything, since the BIOS
1026 * should have taken care of everything
1028 static void lm63_init_client(struct lm63_data *data)
1030 struct i2c_client *client = data->client;
1031 struct device *dev = &client->dev;
1034 data->config = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
1035 data->config_fan = i2c_smbus_read_byte_data(client,
1036 LM63_REG_CONFIG_FAN);
1038 /* Start converting if needed */
1039 if (data->config & 0x40) { /* standby */
1040 dev_dbg(dev, "Switching to operational mode\n");
1041 data->config &= 0xA7;
1042 i2c_smbus_write_byte_data(client, LM63_REG_CONFIG1,
1045 /* Tachometer is always enabled on LM64 */
1046 if (data->kind == lm64)
1047 data->config |= 0x04;
1049 /* We may need pwm1_freq before ever updating the client data */
1050 data->pwm1_freq = i2c_smbus_read_byte_data(client, LM63_REG_PWM_FREQ);
1051 if (data->pwm1_freq == 0)
1052 data->pwm1_freq = 1;
1054 switch (data->kind) {
1057 data->max_convrate_hz = LM63_MAX_CONVRATE_HZ;
1061 data->max_convrate_hz = LM96163_MAX_CONVRATE_HZ;
1062 data->lut_size = 12;
1064 = i2c_smbus_read_byte_data(client,
1065 LM96163_REG_TRUTHERM) & 0x02;
1068 convrate = i2c_smbus_read_byte_data(client, LM63_REG_CONVRATE);
1069 if (unlikely(convrate > LM63_MAX_CONVRATE))
1070 convrate = LM63_MAX_CONVRATE;
1071 data->update_interval = UPDATE_INTERVAL(data->max_convrate_hz,
1075 * For LM96163, check if high resolution PWM
1076 * and unsigned temperature format is enabled.
1078 if (data->kind == lm96163) {
1080 = i2c_smbus_read_byte_data(client,
1081 LM96163_REG_CONFIG_ENHANCED);
1082 if (config_enhanced & 0x20)
1083 data->lut_temp_highres = true;
1084 if ((config_enhanced & 0x10)
1085 && !(data->config_fan & 0x08) && data->pwm1_freq == 8)
1086 data->pwm_highres = true;
1087 if (config_enhanced & 0x08)
1088 data->remote_unsigned = true;
1091 /* Show some debug info about the LM63 configuration */
1092 if (data->kind == lm63)
1093 dev_dbg(dev, "Alert/tach pin configured for %s\n",
1094 (data->config & 0x04) ? "tachometer input" :
1096 dev_dbg(dev, "PWM clock %s kHz, output frequency %u Hz\n",
1097 (data->config_fan & 0x08) ? "1.4" : "360",
1098 ((data->config_fan & 0x08) ? 700 : 180000) / data->pwm1_freq);
1099 dev_dbg(dev, "PWM output active %s, %s mode\n",
1100 (data->config_fan & 0x10) ? "low" : "high",
1101 (data->config_fan & 0x20) ? "manual" : "auto");
1104 static int lm63_probe(struct i2c_client *client,
1105 const struct i2c_device_id *id)
1107 struct device *dev = &client->dev;
1108 struct device *hwmon_dev;
1109 struct lm63_data *data;
1112 data = devm_kzalloc(dev, sizeof(struct lm63_data), GFP_KERNEL);
1116 data->client = client;
1117 mutex_init(&data->update_lock);
1119 /* Set the device type */
1120 data->kind = id->driver_data;
1121 if (data->kind == lm64)
1122 data->temp2_offset = 16000;
1124 /* Initialize chip */
1125 lm63_init_client(data);
1127 /* Register sysfs hooks */
1128 data->groups[groups++] = &lm63_group;
1129 if (data->config & 0x04) /* tachometer enabled */
1130 data->groups[groups++] = &lm63_group_fan1;
1132 if (data->kind == lm96163) {
1133 data->groups[groups++] = &lm63_group_temp2_type;
1134 data->groups[groups++] = &lm63_group_extra_lut;
1137 hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
1138 data, data->groups);
1139 return PTR_ERR_OR_ZERO(hwmon_dev);
1143 * Driver data (common to all clients)
1146 static const struct i2c_device_id lm63_id[] = {
1149 { "lm96163", lm96163 },
1152 MODULE_DEVICE_TABLE(i2c, lm63_id);
1154 static struct i2c_driver lm63_driver = {
1155 .class = I2C_CLASS_HWMON,
1159 .probe = lm63_probe,
1160 .id_table = lm63_id,
1161 .detect = lm63_detect,
1162 .address_list = normal_i2c,
1165 module_i2c_driver(lm63_driver);
1167 MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
1168 MODULE_DESCRIPTION("LM63 driver");
1169 MODULE_LICENSE("GPL");