blob: f647a3307ebc5c12ec0509c1a3046630901b456e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Guenter Roeck19f2c052012-01-14 13:26:08 -08002 * ds1621.c - Part of lm_sensors, Linux kernel modules for hardware
3 * monitoring
4 * Christian W. Zuckschwerdt <zany@triq.net> 2000-11-23
5 * based on lm75.c by Frodo Looijaard <frodol@dds.nl>
6 * Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with
7 * the help of Jean Delvare <khali@linux-fr.org>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
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>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040029#include <linux/hwmon.h>
Jean Delvare46a2e712007-06-09 10:11:15 -040030#include <linux/hwmon-sysfs.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040031#include <linux/err.h>
Ingo Molnar9a61bf62006-01-18 23:19:26 +010032#include <linux/mutex.h>
Jean Delvarea5ebe662006-09-24 21:24:46 +020033#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include "lm75.h"
35
36/* Addresses to scan */
Mark M. Hoffman25e9c862008-02-17 22:28:03 -050037static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, 0x4c,
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 0x4d, 0x4e, 0x4f, I2C_CLIENT_END };
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40/* Insmod parameters */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041static int polarity = -1;
42module_param(polarity, int, 0);
43MODULE_PARM_DESC(polarity, "Output's polarity: 0 = active high, 1 = active low");
44
45/* Many DS1621 constants specified below */
46/* Config register used for detection */
47/* 7 6 5 4 3 2 1 0 */
48/* |Done|THF |TLF |NVB | X | X |POL |1SHOT| */
49#define DS1621_REG_CONFIG_NVB 0x10
50#define DS1621_REG_CONFIG_POLARITY 0x02
51#define DS1621_REG_CONFIG_1SHOT 0x01
52#define DS1621_REG_CONFIG_DONE 0x80
53
54/* The DS1621 registers */
Jean Delvare46a2e712007-06-09 10:11:15 -040055static const u8 DS1621_REG_TEMP[3] = {
56 0xAA, /* input, word, RO */
57 0xA2, /* min, word, RW */
58 0xA1, /* max, word, RW */
59};
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#define DS1621_REG_CONF 0xAC /* byte, RW */
61#define DS1621_COM_START 0xEE /* no data */
62#define DS1621_COM_STOP 0x22 /* no data */
63
64/* The DS1621 configuration register */
65#define DS1621_ALARM_TEMP_HIGH 0x40
66#define DS1621_ALARM_TEMP_LOW 0x20
67
Jean Delvare75819f02007-06-09 10:11:15 -040068/* Conversions */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#define ALARMS_FROM_REG(val) ((val) & \
Guenter Roeck19f2c052012-01-14 13:26:08 -080070 (DS1621_ALARM_TEMP_HIGH | DS1621_ALARM_TEMP_LOW))
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72/* Each client has this additional data */
73struct ds1621_data {
Tony Jones1beeffe2007-08-20 13:46:20 -070074 struct device *hwmon_dev;
Ingo Molnar9a61bf62006-01-18 23:19:26 +010075 struct mutex update_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 char valid; /* !=0 if following fields are valid */
77 unsigned long last_updated; /* In jiffies */
78
Jean Delvare46a2e712007-06-09 10:11:15 -040079 u16 temp[3]; /* Register values, word */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 u8 conf; /* Register encoding, combined */
81};
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083static void ds1621_init_client(struct i2c_client *client)
84{
Jean Delvaree4879e22009-03-30 21:46:40 +020085 u8 conf, new_conf;
86
87 new_conf = conf = i2c_smbus_read_byte_data(client, DS1621_REG_CONF);
Steven Cole44bbe872005-05-03 18:21:25 -060088 /* switch to continuous conversion mode */
Jean Delvaree4879e22009-03-30 21:46:40 +020089 new_conf &= ~DS1621_REG_CONFIG_1SHOT;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91 /* setup output polarity */
92 if (polarity == 0)
Jean Delvaree4879e22009-03-30 21:46:40 +020093 new_conf &= ~DS1621_REG_CONFIG_POLARITY;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 else if (polarity == 1)
Jean Delvaree4879e22009-03-30 21:46:40 +020095 new_conf |= DS1621_REG_CONFIG_POLARITY;
Guenter Roeck19f2c052012-01-14 13:26:08 -080096
Jean Delvaree4879e22009-03-30 21:46:40 +020097 if (conf != new_conf)
98 i2c_smbus_write_byte_data(client, DS1621_REG_CONF, new_conf);
Guenter Roeck19f2c052012-01-14 13:26:08 -080099
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 /* start conversion */
101 i2c_smbus_write_byte(client, DS1621_COM_START);
102}
103
Jean Delvare9202add2009-03-30 21:46:40 +0200104static struct ds1621_data *ds1621_update_client(struct device *dev)
105{
106 struct i2c_client *client = to_i2c_client(dev);
107 struct ds1621_data *data = i2c_get_clientdata(client);
108 u8 new_conf;
109
110 mutex_lock(&data->update_lock);
111
112 if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
113 || !data->valid) {
114 int i;
115
116 dev_dbg(&client->dev, "Starting ds1621 update\n");
117
Jean Delvare594592d2009-03-30 21:46:40 +0200118 data->conf = i2c_smbus_read_byte_data(client, DS1621_REG_CONF);
Jean Delvare9202add2009-03-30 21:46:40 +0200119
120 for (i = 0; i < ARRAY_SIZE(data->temp); i++)
Jean Delvare90f41022011-11-04 12:00:47 +0100121 data->temp[i] = i2c_smbus_read_word_swapped(client,
Jean Delvare594592d2009-03-30 21:46:40 +0200122 DS1621_REG_TEMP[i]);
Jean Delvare9202add2009-03-30 21:46:40 +0200123
124 /* reset alarms if necessary */
125 new_conf = data->conf;
126 if (data->temp[0] > data->temp[1]) /* input > min */
127 new_conf &= ~DS1621_ALARM_TEMP_LOW;
128 if (data->temp[0] < data->temp[2]) /* input < max */
129 new_conf &= ~DS1621_ALARM_TEMP_HIGH;
130 if (data->conf != new_conf)
Jean Delvare594592d2009-03-30 21:46:40 +0200131 i2c_smbus_write_byte_data(client, DS1621_REG_CONF,
132 new_conf);
Jean Delvare9202add2009-03-30 21:46:40 +0200133
134 data->last_updated = jiffies;
135 data->valid = 1;
136 }
137
138 mutex_unlock(&data->update_lock);
139
140 return data;
141}
142
Jean Delvare46a2e712007-06-09 10:11:15 -0400143static ssize_t show_temp(struct device *dev, struct device_attribute *da,
144 char *buf)
145{
146 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
147 struct ds1621_data *data = ds1621_update_client(dev);
148 return sprintf(buf, "%d\n",
149 LM75_TEMP_FROM_REG(data->temp[attr->index]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150}
151
Jean Delvare46a2e712007-06-09 10:11:15 -0400152static ssize_t set_temp(struct device *dev, struct device_attribute *da,
153 const char *buf, size_t count)
154{
155 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
156 struct i2c_client *client = to_i2c_client(dev);
Jean Delvaree4879e22009-03-30 21:46:40 +0200157 struct ds1621_data *data = i2c_get_clientdata(client);
Guenter Roeck19f2c052012-01-14 13:26:08 -0800158 long val;
159 int err;
160
161 err = kstrtol(buf, 10, &val);
162 if (err)
163 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Jean Delvare46a2e712007-06-09 10:11:15 -0400165 mutex_lock(&data->update_lock);
Guenter Roeck19f2c052012-01-14 13:26:08 -0800166 data->temp[attr->index] = LM75_TEMP_TO_REG(val);
Jean Delvare90f41022011-11-04 12:00:47 +0100167 i2c_smbus_write_word_swapped(client, DS1621_REG_TEMP[attr->index],
168 data->temp[attr->index]);
Jean Delvare46a2e712007-06-09 10:11:15 -0400169 mutex_unlock(&data->update_lock);
170 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
Jean Delvare46a2e712007-06-09 10:11:15 -0400173static ssize_t show_alarms(struct device *dev, struct device_attribute *da,
174 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175{
176 struct ds1621_data *data = ds1621_update_client(dev);
177 return sprintf(buf, "%d\n", ALARMS_FROM_REG(data->conf));
178}
179
Jean Delvare87f0f312007-06-09 10:11:15 -0400180static ssize_t show_alarm(struct device *dev, struct device_attribute *da,
181 char *buf)
182{
183 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
184 struct ds1621_data *data = ds1621_update_client(dev);
185 return sprintf(buf, "%d\n", !!(data->conf & attr->index));
186}
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
Jean Delvare46a2e712007-06-09 10:11:15 -0400189static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
190static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp, set_temp, 1);
191static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, set_temp, 2);
Jean Delvare87f0f312007-06-09 10:11:15 -0400192static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL,
193 DS1621_ALARM_TEMP_LOW);
194static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL,
195 DS1621_ALARM_TEMP_HIGH);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Jean Delvarea5ebe662006-09-24 21:24:46 +0200197static struct attribute *ds1621_attributes[] = {
Jean Delvare46a2e712007-06-09 10:11:15 -0400198 &sensor_dev_attr_temp1_input.dev_attr.attr,
199 &sensor_dev_attr_temp1_min.dev_attr.attr,
200 &sensor_dev_attr_temp1_max.dev_attr.attr,
Jean Delvare87f0f312007-06-09 10:11:15 -0400201 &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
202 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
Jean Delvarea5ebe662006-09-24 21:24:46 +0200203 &dev_attr_alarms.attr,
204 NULL
205};
206
207static const struct attribute_group ds1621_group = {
208 .attrs = ds1621_attributes,
209};
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Jean Delvare70313ea2008-07-16 19:30:11 +0200212/* Return 0 if detection is successful, -ENODEV otherwise */
Jean Delvare310ec792009-12-14 21:17:23 +0100213static int ds1621_detect(struct i2c_client *client,
Jean Delvare70313ea2008-07-16 19:30:11 +0200214 struct i2c_board_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215{
Jean Delvare70313ea2008-07-16 19:30:11 +0200216 struct i2c_adapter *adapter = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 int conf, temp;
Jean Delvare70313ea2008-07-16 19:30:11 +0200218 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Guenter Roeck19f2c052012-01-14 13:26:08 -0800220 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA
221 | I2C_FUNC_SMBUS_WORD_DATA
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 | I2C_FUNC_SMBUS_WRITE_BYTE))
Jean Delvare70313ea2008-07-16 19:30:11 +0200223 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Guenter Roeck19f2c052012-01-14 13:26:08 -0800225 /*
226 * Now, we do the remaining detection. It is lousy.
227 *
228 * The NVB bit should be low if no EEPROM write has been requested
229 * during the latest 10ms, which is highly improbable in our case.
230 */
Jean Delvare52df6442009-12-09 20:35:57 +0100231 conf = i2c_smbus_read_byte_data(client, DS1621_REG_CONF);
232 if (conf < 0 || conf & DS1621_REG_CONFIG_NVB)
233 return -ENODEV;
234 /* The 7 lowest bits of a temperature should always be 0. */
235 for (i = 0; i < ARRAY_SIZE(DS1621_REG_TEMP); i++) {
236 temp = i2c_smbus_read_word_data(client, DS1621_REG_TEMP[i]);
237 if (temp < 0 || (temp & 0x7f00))
Jean Delvare70313ea2008-07-16 19:30:11 +0200238 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 }
240
Jean Delvare70313ea2008-07-16 19:30:11 +0200241 strlcpy(info->type, "ds1621", I2C_NAME_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Jean Delvare70313ea2008-07-16 19:30:11 +0200243 return 0;
244}
245
246static int ds1621_probe(struct i2c_client *client,
247 const struct i2c_device_id *id)
248{
249 struct ds1621_data *data;
250 int err;
251
252 data = kzalloc(sizeof(struct ds1621_data), GFP_KERNEL);
253 if (!data) {
254 err = -ENOMEM;
255 goto exit;
256 }
257
258 i2c_set_clientdata(client, data);
259 mutex_init(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 /* Initialize the DS1621 chip */
Jean Delvare75819f02007-06-09 10:11:15 -0400262 ds1621_init_client(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264 /* Register sysfs hooks */
Guenter Roeck19f2c052012-01-14 13:26:08 -0800265 err = sysfs_create_group(&client->dev.kobj, &ds1621_group);
266 if (err)
Jean Delvare70313ea2008-07-16 19:30:11 +0200267 goto exit_free;
Jean Delvarea5ebe662006-09-24 21:24:46 +0200268
Tony Jones1beeffe2007-08-20 13:46:20 -0700269 data->hwmon_dev = hwmon_device_register(&client->dev);
270 if (IS_ERR(data->hwmon_dev)) {
271 err = PTR_ERR(data->hwmon_dev);
Jean Delvarea5ebe662006-09-24 21:24:46 +0200272 goto exit_remove_files;
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400273 }
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 return 0;
276
Guenter Roeck19f2c052012-01-14 13:26:08 -0800277 exit_remove_files:
Jean Delvare75819f02007-06-09 10:11:15 -0400278 sysfs_remove_group(&client->dev.kobj, &ds1621_group);
Guenter Roeck19f2c052012-01-14 13:26:08 -0800279 exit_free:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 kfree(data);
Guenter Roeck19f2c052012-01-14 13:26:08 -0800281 exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 return err;
283}
284
Jean Delvare70313ea2008-07-16 19:30:11 +0200285static int ds1621_remove(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400287 struct ds1621_data *data = i2c_get_clientdata(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Tony Jones1beeffe2007-08-20 13:46:20 -0700289 hwmon_device_unregister(data->hwmon_dev);
Jean Delvarea5ebe662006-09-24 21:24:46 +0200290 sysfs_remove_group(&client->dev.kobj, &ds1621_group);
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400291
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400292 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294 return 0;
295}
296
Jean Delvare9202add2009-03-30 21:46:40 +0200297static const struct i2c_device_id ds1621_id[] = {
Jean Delvare1f86df42009-12-14 21:17:26 +0100298 { "ds1621", 0 },
299 { "ds1625", 0 },
Jean Delvare9202add2009-03-30 21:46:40 +0200300 { }
301};
302MODULE_DEVICE_TABLE(i2c, ds1621_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Jean Delvare9202add2009-03-30 21:46:40 +0200304/* This is the driver that will be inserted */
305static struct i2c_driver ds1621_driver = {
306 .class = I2C_CLASS_HWMON,
307 .driver = {
308 .name = "ds1621",
309 },
310 .probe = ds1621_probe,
311 .remove = ds1621_remove,
312 .id_table = ds1621_id,
313 .detect = ds1621_detect,
Jean Delvarec3813d62009-12-14 21:17:25 +0100314 .address_list = normal_i2c,
Jean Delvare9202add2009-03-30 21:46:40 +0200315};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Axel Linf0967ee2012-01-20 15:38:18 +0800317module_i2c_driver(ds1621_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
319MODULE_AUTHOR("Christian W. Zuckschwerdt <zany@triq.net>");
320MODULE_DESCRIPTION("DS1621 driver");
321MODULE_LICENSE("GPL");