a3b3a58876213353e1e35fac1c80fca605c88a47
[linux-3.10.git] / drivers / hwmon / ds1621.c
1 /*
2     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 */
23
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>
29 #include <linux/i2c-sensor.h>
30 #include <linux/hwmon.h>
31 #include <linux/err.h>
32 #include "lm75.h"
33
34 /* Addresses to scan */
35 static unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, 0x4c,
36                                         0x4d, 0x4e, 0x4f, I2C_CLIENT_END };
37
38 /* Insmod parameters */
39 SENSORS_INSMOD_1(ds1621);
40 static int polarity = -1;
41 module_param(polarity, int, 0);
42 MODULE_PARM_DESC(polarity, "Output's polarity: 0 = active high, 1 = active low");
43
44 /* Many DS1621 constants specified below */
45 /* Config register used for detection         */
46 /*  7    6    5    4    3    2    1    0      */
47 /* |Done|THF |TLF |NVB | X  | X  |POL |1SHOT| */
48 #define DS1621_REG_CONFIG_NVB           0x10
49 #define DS1621_REG_CONFIG_POLARITY      0x02
50 #define DS1621_REG_CONFIG_1SHOT         0x01
51 #define DS1621_REG_CONFIG_DONE          0x80
52
53 /* The DS1621 registers */
54 #define DS1621_REG_TEMP                 0xAA /* word, RO */
55 #define DS1621_REG_TEMP_MIN             0xA1 /* word, RW */
56 #define DS1621_REG_TEMP_MAX             0xA2 /* word, RW */
57 #define DS1621_REG_CONF                 0xAC /* byte, RW */
58 #define DS1621_COM_START                0xEE /* no data */
59 #define DS1621_COM_STOP                 0x22 /* no data */
60
61 /* The DS1621 configuration register */
62 #define DS1621_ALARM_TEMP_HIGH          0x40
63 #define DS1621_ALARM_TEMP_LOW           0x20
64
65 /* Conversions. Rounding and limit checking is only done on the TO_REG
66    variants. Note that you should be a bit careful with which arguments
67    these macros are called: arguments may be evaluated more than once.
68    Fixing this is just not worth it. */
69 #define ALARMS_FROM_REG(val) ((val) & \
70                               (DS1621_ALARM_TEMP_HIGH | DS1621_ALARM_TEMP_LOW))
71
72 /* Each client has this additional data */
73 struct ds1621_data {
74         struct i2c_client client;
75         struct class_device *class_dev;
76         struct semaphore update_lock;
77         char valid;                     /* !=0 if following fields are valid */
78         unsigned long last_updated;     /* In jiffies */
79
80         u16 temp, temp_min, temp_max;   /* Register values, word */
81         u8 conf;                        /* Register encoding, combined */
82 };
83
84 static int ds1621_attach_adapter(struct i2c_adapter *adapter);
85 static int ds1621_detect(struct i2c_adapter *adapter, int address,
86                          int kind);
87 static void ds1621_init_client(struct i2c_client *client);
88 static int ds1621_detach_client(struct i2c_client *client);
89 static struct ds1621_data *ds1621_update_client(struct device *dev);
90
91 /* This is the driver that will be inserted */
92 static struct i2c_driver ds1621_driver = {
93         .owner          = THIS_MODULE,
94         .name           = "ds1621",
95         .id             = I2C_DRIVERID_DS1621,
96         .flags          = I2C_DF_NOTIFY,
97         .attach_adapter = ds1621_attach_adapter,
98         .detach_client  = ds1621_detach_client,
99 };
100
101 /* All registers are word-sized, except for the configuration register.
102    DS1621 uses a high-byte first convention, which is exactly opposite to
103    the usual practice. */
104 static int ds1621_read_value(struct i2c_client *client, u8 reg)
105 {
106         if (reg == DS1621_REG_CONF)
107                 return i2c_smbus_read_byte_data(client, reg);
108         else
109                 return swab16(i2c_smbus_read_word_data(client, reg));
110 }
111
112 /* All registers are word-sized, except for the configuration register.
113    DS1621 uses a high-byte first convention, which is exactly opposite to
114    the usual practice. */
115 static int ds1621_write_value(struct i2c_client *client, u8 reg, u16 value)
116 {
117         if (reg == DS1621_REG_CONF)
118                 return i2c_smbus_write_byte_data(client, reg, value);
119         else
120                 return i2c_smbus_write_word_data(client, reg, swab16(value));
121 }
122
123 static void ds1621_init_client(struct i2c_client *client)
124 {
125         int reg = ds1621_read_value(client, DS1621_REG_CONF);
126         /* switch to continuous conversion mode */
127         reg &= ~ DS1621_REG_CONFIG_1SHOT;
128
129         /* setup output polarity */
130         if (polarity == 0)
131                 reg &= ~DS1621_REG_CONFIG_POLARITY;
132         else if (polarity == 1)
133                 reg |= DS1621_REG_CONFIG_POLARITY;
134         
135         ds1621_write_value(client, DS1621_REG_CONF, reg);
136         
137         /* start conversion */
138         i2c_smbus_write_byte(client, DS1621_COM_START);
139 }
140
141 #define show(value)                                                     \
142 static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf)               \
143 {                                                                       \
144         struct ds1621_data *data = ds1621_update_client(dev);           \
145         return sprintf(buf, "%d\n", LM75_TEMP_FROM_REG(data->value));   \
146 }
147
148 show(temp);
149 show(temp_min);
150 show(temp_max);
151
152 #define set_temp(suffix, value, reg)                                    \
153 static ssize_t set_temp_##suffix(struct device *dev, struct device_attribute *attr, const char *buf,    \
154                                  size_t count)                          \
155 {                                                                       \
156         struct i2c_client *client = to_i2c_client(dev);                 \
157         struct ds1621_data *data = ds1621_update_client(dev);           \
158         u16 val = LM75_TEMP_TO_REG(simple_strtoul(buf, NULL, 10));      \
159                                                                         \
160         down(&data->update_lock);                                       \
161         data->value = val;                                              \
162         ds1621_write_value(client, reg, data->value);                   \
163         up(&data->update_lock);                                         \
164         return count;                                                   \
165 }
166
167 set_temp(min, temp_min, DS1621_REG_TEMP_MIN);
168 set_temp(max, temp_max, DS1621_REG_TEMP_MAX);
169
170 static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
171 {
172         struct ds1621_data *data = ds1621_update_client(dev);
173         return sprintf(buf, "%d\n", ALARMS_FROM_REG(data->conf));
174 }
175
176 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
177 static DEVICE_ATTR(temp1_input, S_IRUGO , show_temp, NULL);
178 static DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO , show_temp_min, set_temp_min);
179 static DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max, set_temp_max);
180
181
182 static int ds1621_attach_adapter(struct i2c_adapter *adapter)
183 {
184         return i2c_probe(adapter, &addr_data, ds1621_detect);
185 }
186
187 /* This function is called by i2c_probe */
188 int ds1621_detect(struct i2c_adapter *adapter, int address,
189                   int kind)
190 {
191         int conf, temp;
192         struct i2c_client *new_client;
193         struct ds1621_data *data;
194         int err = 0;
195
196         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA 
197                                      | I2C_FUNC_SMBUS_WORD_DATA 
198                                      | I2C_FUNC_SMBUS_WRITE_BYTE))
199                 goto exit;
200
201         /* OK. For now, we presume we have a valid client. We now create the
202            client structure, even though we cannot fill it completely yet.
203            But it allows us to access ds1621_{read,write}_value. */
204         if (!(data = kmalloc(sizeof(struct ds1621_data), GFP_KERNEL))) {
205                 err = -ENOMEM;
206                 goto exit;
207         }
208         memset(data, 0, sizeof(struct ds1621_data));
209         
210         new_client = &data->client;
211         i2c_set_clientdata(new_client, data);
212         new_client->addr = address;
213         new_client->adapter = adapter;
214         new_client->driver = &ds1621_driver;
215         new_client->flags = 0;
216
217
218         /* Now, we do the remaining detection. It is lousy. */
219         if (kind < 0) {
220                 /* The NVB bit should be low if no EEPROM write has been 
221                    requested during the latest 10ms, which is highly 
222                    improbable in our case. */
223                 conf = ds1621_read_value(new_client, DS1621_REG_CONF);
224                 if (conf & DS1621_REG_CONFIG_NVB)
225                         goto exit_free;
226                 /* The 7 lowest bits of a temperature should always be 0. */
227                 temp = ds1621_read_value(new_client, DS1621_REG_TEMP);
228                 if (temp & 0x007f)
229                         goto exit_free;
230                 temp = ds1621_read_value(new_client, DS1621_REG_TEMP_MIN);
231                 if (temp & 0x007f)
232                         goto exit_free;
233                 temp = ds1621_read_value(new_client, DS1621_REG_TEMP_MAX);
234                 if (temp & 0x007f)
235                         goto exit_free;
236         }
237
238         /* Determine the chip type - only one kind supported! */
239         if (kind <= 0)
240                 kind = ds1621;
241
242         /* Fill in remaining client fields and put it into the global list */
243         strlcpy(new_client->name, "ds1621", I2C_NAME_SIZE);
244         data->valid = 0;
245         init_MUTEX(&data->update_lock);
246
247         /* Tell the I2C layer a new client has arrived */
248         if ((err = i2c_attach_client(new_client)))
249                 goto exit_free;
250
251         /* Initialize the DS1621 chip */
252         ds1621_init_client(new_client);
253
254         /* Register sysfs hooks */
255         data->class_dev = hwmon_device_register(&new_client->dev);
256         if (IS_ERR(data->class_dev)) {
257                 err = PTR_ERR(data->class_dev);
258                 goto exit_detach;
259         }
260
261         device_create_file(&new_client->dev, &dev_attr_alarms);
262         device_create_file(&new_client->dev, &dev_attr_temp1_input);
263         device_create_file(&new_client->dev, &dev_attr_temp1_min);
264         device_create_file(&new_client->dev, &dev_attr_temp1_max);
265         
266         return 0;
267
268 /* OK, this is not exactly good programming practice, usually. But it is
269    very code-efficient in this case. */
270       exit_detach:
271         i2c_detach_client(new_client);
272       exit_free:
273         kfree(data);
274       exit:
275         return err;
276 }
277
278 static int ds1621_detach_client(struct i2c_client *client)
279 {
280         struct ds1621_data *data = i2c_get_clientdata(client);
281         int err;
282
283         hwmon_device_unregister(data->class_dev);
284
285         if ((err = i2c_detach_client(client)))
286                 return err;
287
288         kfree(data);
289
290         return 0;
291 }
292
293
294 static struct ds1621_data *ds1621_update_client(struct device *dev)
295 {
296         struct i2c_client *client = to_i2c_client(dev);
297         struct ds1621_data *data = i2c_get_clientdata(client);
298         u8 new_conf;
299
300         down(&data->update_lock);
301
302         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
303             || !data->valid) {
304
305                 dev_dbg(&client->dev, "Starting ds1621 update\n");
306
307                 data->conf = ds1621_read_value(client, DS1621_REG_CONF);
308
309                 data->temp = ds1621_read_value(client, DS1621_REG_TEMP);
310                 
311                 data->temp_min = ds1621_read_value(client,
312                                                     DS1621_REG_TEMP_MIN);
313                 data->temp_max = ds1621_read_value(client,
314                                                     DS1621_REG_TEMP_MAX);
315
316                 /* reset alarms if necessary */
317                 new_conf = data->conf;
318                 if (data->temp < data->temp_min)
319                         new_conf &= ~DS1621_ALARM_TEMP_LOW;
320                 if (data->temp > data->temp_max)
321                         new_conf &= ~DS1621_ALARM_TEMP_HIGH;
322                 if (data->conf != new_conf)
323                         ds1621_write_value(client, DS1621_REG_CONF,
324                                            new_conf);
325
326                 data->last_updated = jiffies;
327                 data->valid = 1;
328         }
329
330         up(&data->update_lock);
331
332         return data;
333 }
334
335 static int __init ds1621_init(void)
336 {
337         return i2c_add_driver(&ds1621_driver);
338 }
339
340 static void __exit ds1621_exit(void)
341 {
342         i2c_del_driver(&ds1621_driver);
343 }
344
345
346 MODULE_AUTHOR("Christian W. Zuckschwerdt <zany@triq.net>");
347 MODULE_DESCRIPTION("DS1621 driver");
348 MODULE_LICENSE("GPL");
349
350 module_init(ds1621_init);
351 module_exit(ds1621_exit);