5e6df4b7b8570e83bdfa06bfa37795fbed7a1bbf
[linux-2.6.git] / drivers / hwmon / adm1021.c
1 /*
2     adm1021.c - Part of lm_sensors, Linux kernel modules for hardware
3              monitoring
4     Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl> and
5     Philip Edelbrock <phil@netroedge.com>
6
7     This program is free software; you can redistribute it and/or modify
8     it under the terms of the GNU General Public License as published by
9     the Free Software Foundation; either version 2 of the License, or
10     (at your option) any later version.
11
12     This program is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15     GNU General Public License for more details.
16
17     You should have received a copy of the GNU General Public License
18     along with this program; if not, write to the Free Software
19     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/jiffies.h>
26 #include <linux/i2c.h>
27 #include <linux/hwmon.h>
28 #include <linux/err.h>
29
30
31 /* Addresses to scan */
32 static unsigned short normal_i2c[] = { 0x18, 0x19, 0x1a,
33                                         0x29, 0x2a, 0x2b,
34                                         0x4c, 0x4d, 0x4e, 
35                                         I2C_CLIENT_END };
36
37 /* Insmod parameters */
38 I2C_CLIENT_INSMOD_8(adm1021, adm1023, max1617, max1617a, thmc10, lm84, gl523sm, mc1066);
39
40 /* adm1021 constants specified below */
41
42 /* The adm1021 registers */
43 /* Read-only */
44 #define ADM1021_REG_TEMP                0x00
45 #define ADM1021_REG_REMOTE_TEMP         0x01
46 #define ADM1021_REG_STATUS              0x02
47 #define ADM1021_REG_MAN_ID              0x0FE   /* 0x41 = AMD, 0x49 = TI, 0x4D = Maxim, 0x23 = Genesys , 0x54 = Onsemi*/
48 #define ADM1021_REG_DEV_ID              0x0FF   /* ADM1021 = 0x0X, ADM1023 = 0x3X */
49 #define ADM1021_REG_DIE_CODE            0x0FF   /* MAX1617A */
50 /* These use different addresses for reading/writing */
51 #define ADM1021_REG_CONFIG_R            0x03
52 #define ADM1021_REG_CONFIG_W            0x09
53 #define ADM1021_REG_CONV_RATE_R         0x04
54 #define ADM1021_REG_CONV_RATE_W         0x0A
55 /* These are for the ADM1023's additional precision on the remote temp sensor */
56 #define ADM1021_REG_REM_TEMP_PREC       0x010
57 #define ADM1021_REG_REM_OFFSET          0x011
58 #define ADM1021_REG_REM_OFFSET_PREC     0x012
59 #define ADM1021_REG_REM_TOS_PREC        0x013
60 #define ADM1021_REG_REM_THYST_PREC      0x014
61 /* limits */
62 #define ADM1021_REG_TOS_R               0x05
63 #define ADM1021_REG_TOS_W               0x0B
64 #define ADM1021_REG_REMOTE_TOS_R        0x07
65 #define ADM1021_REG_REMOTE_TOS_W        0x0D
66 #define ADM1021_REG_THYST_R             0x06
67 #define ADM1021_REG_THYST_W             0x0C
68 #define ADM1021_REG_REMOTE_THYST_R      0x08
69 #define ADM1021_REG_REMOTE_THYST_W      0x0E
70 /* write-only */
71 #define ADM1021_REG_ONESHOT             0x0F
72
73
74 /* Conversions. Rounding and limit checking is only done on the TO_REG
75    variants. Note that you should be a bit careful with which arguments
76    these macros are called: arguments may be evaluated more than once.
77    Fixing this is just not worth it. */
78 /* Conversions  note: 1021 uses normal integer signed-byte format*/
79 #define TEMP_FROM_REG(val)      (val > 127 ? (val-256)*1000 : val*1000)
80 #define TEMP_TO_REG(val)        (SENSORS_LIMIT((val < 0 ? (val/1000)+256 : val/1000),0,255))
81
82 /* Initial values */
83
84 /* Note: Even though I left the low and high limits named os and hyst, 
85 they don't quite work like a thermostat the way the LM75 does.  I.e., 
86 a lower temp than THYST actually triggers an alarm instead of 
87 clearing it.  Weird, ey?   --Phil  */
88
89 /* Each client has this additional data */
90 struct adm1021_data {
91         struct i2c_client client;
92         struct class_device *class_dev;
93         enum chips type;
94
95         struct semaphore update_lock;
96         char valid;             /* !=0 if following fields are valid */
97         unsigned long last_updated;     /* In jiffies */
98
99         u8      temp_max;       /* Register values */
100         u8      temp_hyst;
101         u8      temp_input;
102         u8      remote_temp_max;
103         u8      remote_temp_hyst;
104         u8      remote_temp_input;
105         u8      alarms;
106         /* Special values for ADM1023 only */
107         u8      remote_temp_prec;
108         u8      remote_temp_os_prec;
109         u8      remote_temp_hyst_prec;
110         u8      remote_temp_offset;
111         u8      remote_temp_offset_prec;
112 };
113
114 static int adm1021_attach_adapter(struct i2c_adapter *adapter);
115 static int adm1021_detect(struct i2c_adapter *adapter, int address, int kind);
116 static void adm1021_init_client(struct i2c_client *client);
117 static int adm1021_detach_client(struct i2c_client *client);
118 static int adm1021_read_value(struct i2c_client *client, u8 reg);
119 static int adm1021_write_value(struct i2c_client *client, u8 reg,
120                                u16 value);
121 static struct adm1021_data *adm1021_update_device(struct device *dev);
122
123 /* (amalysh) read only mode, otherwise any limit's writing confuse BIOS */
124 static int read_only;
125
126
127 /* This is the driver that will be inserted */
128 static struct i2c_driver adm1021_driver = {
129         .owner          = THIS_MODULE,
130         .name           = "adm1021",
131         .id             = I2C_DRIVERID_ADM1021,
132         .attach_adapter = adm1021_attach_adapter,
133         .detach_client  = adm1021_detach_client,
134 };
135
136 #define show(value)     \
137 static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf)               \
138 {                                                                       \
139         struct adm1021_data *data = adm1021_update_device(dev);         \
140         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->value));        \
141 }
142 show(temp_max);
143 show(temp_hyst);
144 show(temp_input);
145 show(remote_temp_max);
146 show(remote_temp_hyst);
147 show(remote_temp_input);
148
149 #define show2(value)    \
150 static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf)               \
151 {                                                                       \
152         struct adm1021_data *data = adm1021_update_device(dev);         \
153         return sprintf(buf, "%d\n", data->value);                       \
154 }
155 show2(alarms);
156
157 #define set(value, reg) \
158 static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)    \
159 {                                                               \
160         struct i2c_client *client = to_i2c_client(dev);         \
161         struct adm1021_data *data = i2c_get_clientdata(client); \
162         int temp = simple_strtoul(buf, NULL, 10);               \
163                                                                 \
164         down(&data->update_lock);                               \
165         data->value = TEMP_TO_REG(temp);                        \
166         adm1021_write_value(client, reg, data->value);          \
167         up(&data->update_lock);                                 \
168         return count;                                           \
169 }
170 set(temp_max, ADM1021_REG_TOS_W);
171 set(temp_hyst, ADM1021_REG_THYST_W);
172 set(remote_temp_max, ADM1021_REG_REMOTE_TOS_W);
173 set(remote_temp_hyst, ADM1021_REG_REMOTE_THYST_W);
174
175 static DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max, set_temp_max);
176 static DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_hyst, set_temp_hyst);
177 static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input, NULL);
178 static DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_remote_temp_max, set_remote_temp_max);
179 static DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_remote_temp_hyst, set_remote_temp_hyst);
180 static DEVICE_ATTR(temp2_input, S_IRUGO, show_remote_temp_input, NULL);
181 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
182
183
184 static int adm1021_attach_adapter(struct i2c_adapter *adapter)
185 {
186         if (!(adapter->class & I2C_CLASS_HWMON))
187                 return 0;
188         return i2c_probe(adapter, &addr_data, adm1021_detect);
189 }
190
191 static int adm1021_detect(struct i2c_adapter *adapter, int address, int kind)
192 {
193         int i;
194         struct i2c_client *new_client;
195         struct adm1021_data *data;
196         int err = 0;
197         const char *type_name = "";
198
199         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
200                 goto error0;
201
202         /* OK. For now, we presume we have a valid client. We now create the
203            client structure, even though we cannot fill it completely yet.
204            But it allows us to access adm1021_{read,write}_value. */
205
206         if (!(data = kzalloc(sizeof(struct adm1021_data), GFP_KERNEL))) {
207                 err = -ENOMEM;
208                 goto error0;
209         }
210
211         new_client = &data->client;
212         i2c_set_clientdata(new_client, data);
213         new_client->addr = address;
214         new_client->adapter = adapter;
215         new_client->driver = &adm1021_driver;
216         new_client->flags = 0;
217
218         /* Now, we do the remaining detection. */
219         if (kind < 0) {
220                 if ((adm1021_read_value(new_client, ADM1021_REG_STATUS) & 0x03) != 0x00
221                  || (adm1021_read_value(new_client, ADM1021_REG_CONFIG_R) & 0x3F) != 0x00
222                  || (adm1021_read_value(new_client, ADM1021_REG_CONV_RATE_R) & 0xF8) != 0x00) {
223                         err = -ENODEV;
224                         goto error1;
225                 }
226         }
227
228         /* Determine the chip type. */
229         if (kind <= 0) {
230                 i = adm1021_read_value(new_client, ADM1021_REG_MAN_ID);
231                 if (i == 0x41)
232                         if ((adm1021_read_value(new_client, ADM1021_REG_DEV_ID) & 0x0F0) == 0x030)
233                                 kind = adm1023;
234                         else
235                                 kind = adm1021;
236                 else if (i == 0x49)
237                         kind = thmc10;
238                 else if (i == 0x23)
239                         kind = gl523sm;
240                 else if ((i == 0x4d) &&
241                          (adm1021_read_value(new_client, ADM1021_REG_DEV_ID) == 0x01))
242                         kind = max1617a;
243                 else if (i == 0x54)
244                         kind = mc1066;
245                 /* LM84 Mfr ID in a different place, and it has more unused bits */
246                 else if (adm1021_read_value(new_client, ADM1021_REG_CONV_RATE_R) == 0x00
247                       && (kind == 0 /* skip extra detection */
248                        || ((adm1021_read_value(new_client, ADM1021_REG_CONFIG_R) & 0x7F) == 0x00
249                         && (adm1021_read_value(new_client, ADM1021_REG_STATUS) & 0xAB) == 0x00)))
250                         kind = lm84;
251                 else
252                         kind = max1617;
253         }
254
255         if (kind == max1617) {
256                 type_name = "max1617";
257         } else if (kind == max1617a) {
258                 type_name = "max1617a";
259         } else if (kind == adm1021) {
260                 type_name = "adm1021";
261         } else if (kind == adm1023) {
262                 type_name = "adm1023";
263         } else if (kind == thmc10) {
264                 type_name = "thmc10";
265         } else if (kind == lm84) {
266                 type_name = "lm84";
267         } else if (kind == gl523sm) {
268                 type_name = "gl523sm";
269         } else if (kind == mc1066) {
270                 type_name = "mc1066";
271         }
272
273         /* Fill in the remaining client fields and put it into the global list */
274         strlcpy(new_client->name, type_name, I2C_NAME_SIZE);
275         data->type = kind;
276         data->valid = 0;
277         init_MUTEX(&data->update_lock);
278
279         /* Tell the I2C layer a new client has arrived */
280         if ((err = i2c_attach_client(new_client)))
281                 goto error1;
282
283         /* Initialize the ADM1021 chip */
284         if (kind != lm84)
285                 adm1021_init_client(new_client);
286
287         /* Register sysfs hooks */
288         data->class_dev = hwmon_device_register(&new_client->dev);
289         if (IS_ERR(data->class_dev)) {
290                 err = PTR_ERR(data->class_dev);
291                 goto error2;
292         }
293
294         device_create_file(&new_client->dev, &dev_attr_temp1_max);
295         device_create_file(&new_client->dev, &dev_attr_temp1_min);
296         device_create_file(&new_client->dev, &dev_attr_temp1_input);
297         device_create_file(&new_client->dev, &dev_attr_temp2_max);
298         device_create_file(&new_client->dev, &dev_attr_temp2_min);
299         device_create_file(&new_client->dev, &dev_attr_temp2_input);
300         device_create_file(&new_client->dev, &dev_attr_alarms);
301
302         return 0;
303
304 error2:
305         i2c_detach_client(new_client);
306 error1:
307         kfree(data);
308 error0:
309         return err;
310 }
311
312 static void adm1021_init_client(struct i2c_client *client)
313 {
314         /* Enable ADC and disable suspend mode */
315         adm1021_write_value(client, ADM1021_REG_CONFIG_W,
316                 adm1021_read_value(client, ADM1021_REG_CONFIG_R) & 0xBF);
317         /* Set Conversion rate to 1/sec (this can be tinkered with) */
318         adm1021_write_value(client, ADM1021_REG_CONV_RATE_W, 0x04);
319 }
320
321 static int adm1021_detach_client(struct i2c_client *client)
322 {
323         struct adm1021_data *data = i2c_get_clientdata(client);
324         int err;
325
326         hwmon_device_unregister(data->class_dev);
327
328         if ((err = i2c_detach_client(client)))
329                 return err;
330
331         kfree(data);
332         return 0;
333 }
334
335 /* All registers are byte-sized */
336 static int adm1021_read_value(struct i2c_client *client, u8 reg)
337 {
338         return i2c_smbus_read_byte_data(client, reg);
339 }
340
341 static int adm1021_write_value(struct i2c_client *client, u8 reg, u16 value)
342 {
343         if (!read_only)
344                 return i2c_smbus_write_byte_data(client, reg, value);
345         return 0;
346 }
347
348 static struct adm1021_data *adm1021_update_device(struct device *dev)
349 {
350         struct i2c_client *client = to_i2c_client(dev);
351         struct adm1021_data *data = i2c_get_clientdata(client);
352
353         down(&data->update_lock);
354
355         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
356             || !data->valid) {
357                 dev_dbg(&client->dev, "Starting adm1021 update\n");
358
359                 data->temp_input = adm1021_read_value(client, ADM1021_REG_TEMP);
360                 data->temp_max = adm1021_read_value(client, ADM1021_REG_TOS_R);
361                 data->temp_hyst = adm1021_read_value(client, ADM1021_REG_THYST_R);
362                 data->remote_temp_input = adm1021_read_value(client, ADM1021_REG_REMOTE_TEMP);
363                 data->remote_temp_max = adm1021_read_value(client, ADM1021_REG_REMOTE_TOS_R);
364                 data->remote_temp_hyst = adm1021_read_value(client, ADM1021_REG_REMOTE_THYST_R);
365                 data->alarms = adm1021_read_value(client, ADM1021_REG_STATUS) & 0x7c;
366                 if (data->type == adm1023) {
367                         data->remote_temp_prec = adm1021_read_value(client, ADM1021_REG_REM_TEMP_PREC);
368                         data->remote_temp_os_prec = adm1021_read_value(client, ADM1021_REG_REM_TOS_PREC);
369                         data->remote_temp_hyst_prec = adm1021_read_value(client, ADM1021_REG_REM_THYST_PREC);
370                         data->remote_temp_offset = adm1021_read_value(client, ADM1021_REG_REM_OFFSET);
371                         data->remote_temp_offset_prec = adm1021_read_value(client, ADM1021_REG_REM_OFFSET_PREC);
372                 }
373                 data->last_updated = jiffies;
374                 data->valid = 1;
375         }
376
377         up(&data->update_lock);
378
379         return data;
380 }
381
382 static int __init sensors_adm1021_init(void)
383 {
384         return i2c_add_driver(&adm1021_driver);
385 }
386
387 static void __exit sensors_adm1021_exit(void)
388 {
389         i2c_del_driver(&adm1021_driver);
390 }
391
392 MODULE_AUTHOR ("Frodo Looijaard <frodol@dds.nl> and "
393                 "Philip Edelbrock <phil@netroedge.com>");
394 MODULE_DESCRIPTION("adm1021 driver");
395 MODULE_LICENSE("GPL");
396
397 module_param(read_only, bool, 0);
398 MODULE_PARM_DESC(read_only, "Don't set any values, read only mode");
399
400 module_init(sensors_adm1021_init)
401 module_exit(sensors_adm1021_exit)