SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/hwmon/lm77.c

   1 /*
   2     lm77.c - Part of lm_sensors, Linux kernel modules for hardware
   3              monitoring
   4
   5     Copyright (c) 2004  Andras BALI <drewie@freemail.hu>
   6
   7     Heavily based on lm75.c by Frodo Looijaard <frodol@dds.nl>.  The LM77
   8     is a temperature sensor and thermal window comparator with 0.5 deg
   9     resolution made by National Semiconductor.  Complete datasheet can be
  10     obtained at their site:
  11        http://www.national.com/pf/LM/LM77.html
  12
  13     This program is free software; you can redistribute it and/or modify
  14     it under the terms of the GNU General Public License as published by
  15     the Free Software Foundation; either version 2 of the License, or
  16     (at your option) any later version.
  17
  18     This program is distributed in the hope that it will be useful,
  19     but WITHOUT ANY WARRANTY; without even the implied warranty of
  20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21     GNU General Public License for more details.
  22
  23     You should have received a copy of the GNU General Public License
  24     along with this program; if not, write to the Free Software
  25     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 */
  27
  28 #include <linux/module.h>
  29 #include <linux/init.h>
  30 #include <linux/slab.h>
  31 #include <linux/jiffies.h>
  32 #include <linux/i2c.h>
  33 #include <linux/i2c-sensor.h>
  34 #include <linux/hwmon.h>
  35 #include <linux/err.h>
  36
  37 /* Addresses to scan */
  38 static unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, I2C_CLIENT_END };
  39 static unsigned int normal_isa[] = { I2C_CLIENT_ISA_END };
  40
  41 /* Insmod parameters */
  42 SENSORS_INSMOD_1(lm77);
  43
  44 /* The LM77 registers */
  45 #define LM77_REG_TEMP           0x00
  46 #define LM77_REG_CONF           0x01
  47 #define LM77_REG_TEMP_HYST      0x02
  48 #define LM77_REG_TEMP_CRIT      0x03
  49 #define LM77_REG_TEMP_MIN       0x04
  50 #define LM77_REG_TEMP_MAX       0x05
  51
  52 /* Each client has this additional data */
  53 struct lm77_data {
  54         struct i2c_client       client;
  55         struct class_device *class_dev;
  56         struct semaphore        update_lock;
  57         char                    valid;
  58         unsigned long           last_updated;   /* In jiffies */
  59         int                     temp_input;     /* Temperatures */
  60         int                     temp_crit;
  61         int                     temp_min;
  62         int                     temp_max;
  63         int                     temp_hyst;
  64         u8                      alarms;
  65 };
  66
  67 static int lm77_attach_adapter(struct i2c_adapter *adapter);
  68 static int lm77_detect(struct i2c_adapter *adapter, int address, int kind);
  69 static void lm77_init_client(struct i2c_client *client);
  70 static int lm77_detach_client(struct i2c_client *client);
  71 static u16 lm77_read_value(struct i2c_client *client, u8 reg);
  72 static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value);
  73
  74 static struct lm77_data *lm77_update_device(struct device *dev);
  75
  76
  77 /* This is the driver that will be inserted */
  78 static struct i2c_driver lm77_driver = {
  79         .owner          = THIS_MODULE,
  80         .name           = "lm77",
  81         .flags          = I2C_DF_NOTIFY,
  82         .attach_adapter = lm77_attach_adapter,
  83         .detach_client  = lm77_detach_client,
  84 };
  85
  86 /* straight from the datasheet */
  87 #define LM77_TEMP_MIN (-55000)
  88 #define LM77_TEMP_MAX 125000
  89
  90 /* In the temperature registers, the low 3 bits are not part of the
  91    temperature values; they are the status bits. */
  92 static inline u16 LM77_TEMP_TO_REG(int temp)
  93 {
  94         int ntemp = SENSORS_LIMIT(temp, LM77_TEMP_MIN, LM77_TEMP_MAX);
  95         return (u16)((ntemp / 500) * 8);
  96 }
  97
  98 static inline int LM77_TEMP_FROM_REG(u16 reg)
  99 {
 100         return ((int)reg / 8) * 500;
 101 }
 102
 103 /* sysfs stuff */
 104
 105 /* read routines for temperature limits */
 106 #define show(value)     \
 107 static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf)       \
 108 {                                                               \
 109         struct lm77_data *data = lm77_update_device(dev);       \
 110         return sprintf(buf, "%d\n", data->value);               \
 111 }
 112
 113 show(temp_input);
 114 show(temp_crit);
 115 show(temp_min);
 116 show(temp_max);
 117 show(alarms);
 118
 119 /* read routines for hysteresis values */
 120 static ssize_t show_temp_crit_hyst(struct device *dev, struct device_attribute *attr, char *buf)
 121 {
 122         struct lm77_data *data = lm77_update_device(dev);
 123         return sprintf(buf, "%d\n", data->temp_crit - data->temp_hyst);
 124 }
 125 static ssize_t show_temp_min_hyst(struct device *dev, struct device_attribute *attr, char *buf)
 126 {
 127         struct lm77_data *data = lm77_update_device(dev);
 128         return sprintf(buf, "%d\n", data->temp_min + data->temp_hyst);
 129 }
 130 static ssize_t show_temp_max_hyst(struct device *dev, struct device_attribute *attr, char *buf)
 131 {
 132         struct lm77_data *data = lm77_update_device(dev);
 133         return sprintf(buf, "%d\n", data->temp_max - data->temp_hyst);
 134 }
 135
 136 /* write routines */
 137 #define set(value, reg) \
 138 static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)    \
 139 {                                                                               \
 140         struct i2c_client *client = to_i2c_client(dev);                         \
 141         struct lm77_data *data = i2c_get_clientdata(client);                    \
 142         long val = simple_strtoul(buf, NULL, 10);                               \
 143                                                                                 \
 144         down(&data->update_lock);                                               \
 145         data->value = val;                              \
 146         lm77_write_value(client, reg, LM77_TEMP_TO_REG(data->value));           \
 147         up(&data->update_lock);                                                 \
 148         return count;                                                           \
 149 }
 150
 151 set(temp_min, LM77_REG_TEMP_MIN);
 152 set(temp_max, LM77_REG_TEMP_MAX);
 153
 154 /* hysteresis is stored as a relative value on the chip, so it has to be
 155    converted first */
 156 static ssize_t set_temp_crit_hyst(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 157 {
 158         struct i2c_client *client = to_i2c_client(dev);
 159         struct lm77_data *data = i2c_get_clientdata(client);
 160         unsigned long val = simple_strtoul(buf, NULL, 10);
 161
 162         down(&data->update_lock);
 163         data->temp_hyst = data->temp_crit - val;
 164         lm77_write_value(client, LM77_REG_TEMP_HYST,
 165                          LM77_TEMP_TO_REG(data->temp_hyst));
 166         up(&data->update_lock);
 167         return count;
 168 }
 169
 170 /* preserve hysteresis when setting T_crit */
 171 static ssize_t set_temp_crit(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 172 {
 173         struct i2c_client *client = to_i2c_client(dev);
 174         struct lm77_data *data = i2c_get_clientdata(client);
 175         long val = simple_strtoul(buf, NULL, 10);
 176         int oldcrithyst;
 177
 178         down(&data->update_lock);
 179         oldcrithyst = data->temp_crit - data->temp_hyst;
 180         data->temp_crit = val;
 181         data->temp_hyst = data->temp_crit - oldcrithyst;
 182         lm77_write_value(client, LM77_REG_TEMP_CRIT,
 183                          LM77_TEMP_TO_REG(data->temp_crit));
 184         lm77_write_value(client, LM77_REG_TEMP_HYST,
 185                          LM77_TEMP_TO_REG(data->temp_hyst));
 186         up(&data->update_lock);
 187         return count;
 188 }
 189
 190 static DEVICE_ATTR(temp1_input, S_IRUGO,
 191                    show_temp_input, NULL);
 192 static DEVICE_ATTR(temp1_crit, S_IWUSR | S_IRUGO,
 193                    show_temp_crit, set_temp_crit);
 194 static DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO,
 195                    show_temp_min, set_temp_min);
 196 static DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
 197                    show_temp_max, set_temp_max);
 198
 199 static DEVICE_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO,
 200                    show_temp_crit_hyst, set_temp_crit_hyst);
 201 static DEVICE_ATTR(temp1_min_hyst, S_IRUGO,
 202                    show_temp_min_hyst, NULL);
 203 static DEVICE_ATTR(temp1_max_hyst, S_IRUGO,
 204                    show_temp_max_hyst, NULL);
 205
 206 static DEVICE_ATTR(alarms, S_IRUGO,
 207                    show_alarms, NULL);
 208
 209 static int lm77_attach_adapter(struct i2c_adapter *adapter)
 210 {
 211         if (!(adapter->class & I2C_CLASS_HWMON))
 212                 return 0;
 213         return i2c_detect(adapter, &addr_data, lm77_detect);
 214 }
 215
 216 /* This function is called by i2c_detect */
 217 static int lm77_detect(struct i2c_adapter *adapter, int address, int kind)
 218 {
 219         struct i2c_client *new_client;
 220         struct lm77_data *data;
 221         int err = 0;
 222         const char *name = "";
 223
 224         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 225                                      I2C_FUNC_SMBUS_WORD_DATA))
 226                 goto exit;
 227
 228         /* OK. For now, we presume we have a valid client. We now create the
 229            client structure, even though we cannot fill it completely yet.
 230            But it allows us to access lm77_{read,write}_value. */
 231         if (!(data = kmalloc(sizeof(struct lm77_data), GFP_KERNEL))) {
 232                 err = -ENOMEM;
 233                 goto exit;
 234         }
 235         memset(data, 0, sizeof(struct lm77_data));
 236
 237         new_client = &data->client;
 238         i2c_set_clientdata(new_client, data);
 239         new_client->addr = address;
 240         new_client->adapter = adapter;
 241         new_client->driver = &lm77_driver;
 242         new_client->flags = 0;
 243
 244         /* Here comes the remaining detection.  Since the LM77 has no
 245            register dedicated to identification, we have to rely on the
 246            following tricks:
 247
 248            1. the high 4 bits represent the sign and thus they should
 249               always be the same
 250            2. the high 3 bits are unused in the configuration register
 251            3. addresses 0x06 and 0x07 return the last read value
 252            4. registers cycling over 8-address boundaries
 253
 254            Word-sized registers are high-byte first. */
 255         if (kind < 0) {
 256                 int i, cur, conf, hyst, crit, min, max;
 257
 258                 /* addresses cycling */
 259                 cur = i2c_smbus_read_word_data(new_client, 0);
 260                 conf = i2c_smbus_read_byte_data(new_client, 1);
 261                 hyst = i2c_smbus_read_word_data(new_client, 2);
 262                 crit = i2c_smbus_read_word_data(new_client, 3);
 263                 min = i2c_smbus_read_word_data(new_client, 4);
 264                 max = i2c_smbus_read_word_data(new_client, 5);
 265                 for (i = 8; i <= 0xff; i += 8)
 266                         if (i2c_smbus_read_byte_data(new_client, i + 1) != conf
 267                             || i2c_smbus_read_word_data(new_client, i + 2) != hyst
 268                             || i2c_smbus_read_word_data(new_client, i + 3) != crit
 269                             || i2c_smbus_read_word_data(new_client, i + 4) != min
 270                             || i2c_smbus_read_word_data(new_client, i + 5) != max)
 271                                 goto exit_free;
 272
 273                 /* sign bits */
 274                 if (((cur & 0x00f0) != 0xf0 && (cur & 0x00f0) != 0x0)
 275                     || ((hyst & 0x00f0) != 0xf0 && (hyst & 0x00f0) != 0x0)
 276                     || ((crit & 0x00f0) != 0xf0 && (crit & 0x00f0) != 0x0)
 277                     || ((min & 0x00f0) != 0xf0 && (min & 0x00f0) != 0x0)
 278                     || ((max & 0x00f0) != 0xf0 && (max & 0x00f0) != 0x0))
 279                         goto exit_free;
 280
 281                 /* unused bits */
 282                 if (conf & 0xe0)
 283                         goto exit_free;
 284
 285                 /* 0x06 and 0x07 return the last read value */
 286                 cur = i2c_smbus_read_word_data(new_client, 0);
 287                 if (i2c_smbus_read_word_data(new_client, 6) != cur
 288                     || i2c_smbus_read_word_data(new_client, 7) != cur)
 289                         goto exit_free;
 290                 hyst = i2c_smbus_read_word_data(new_client, 2);
 291                 if (i2c_smbus_read_word_data(new_client, 6) != hyst
 292                     || i2c_smbus_read_word_data(new_client, 7) != hyst)
 293                         goto exit_free;
 294                 min = i2c_smbus_read_word_data(new_client, 4);
 295                 if (i2c_smbus_read_word_data(new_client, 6) != min
 296                     || i2c_smbus_read_word_data(new_client, 7) != min)
 297                         goto exit_free;
 298
 299         }
 300
 301         /* Determine the chip type - only one kind supported! */
 302         if (kind <= 0)
 303                 kind = lm77;
 304
 305         if (kind == lm77) {
 306                 name = "lm77";
 307         }
 308
 309         /* Fill in the remaining client fields and put it into the global list */
 310         strlcpy(new_client->name, name, I2C_NAME_SIZE);
 311         data->valid = 0;
 312         init_MUTEX(&data->update_lock);
 313
 314         /* Tell the I2C layer a new client has arrived */
 315         if ((err = i2c_attach_client(new_client)))
 316                 goto exit_free;
 317
 318         /* Initialize the LM77 chip */
 319         lm77_init_client(new_client);
 320
 321         /* Register sysfs hooks */
 322         data->class_dev = hwmon_device_register(&new_client->dev);
 323         if (IS_ERR(data->class_dev)) {
 324                 err = PTR_ERR(data->class_dev);
 325                 goto exit_detach;
 326         }
 327
 328         device_create_file(&new_client->dev, &dev_attr_temp1_input);
 329         device_create_file(&new_client->dev, &dev_attr_temp1_crit);
 330         device_create_file(&new_client->dev, &dev_attr_temp1_min);
 331         device_create_file(&new_client->dev, &dev_attr_temp1_max);
 332         device_create_file(&new_client->dev, &dev_attr_temp1_crit_hyst);
 333         device_create_file(&new_client->dev, &dev_attr_temp1_min_hyst);
 334         device_create_file(&new_client->dev, &dev_attr_temp1_max_hyst);
 335         device_create_file(&new_client->dev, &dev_attr_alarms);
 336         return 0;
 337
 338 exit_detach:
 339         i2c_detach_client(new_client);
 340 exit_free:
 341         kfree(data);
 342 exit:
 343         return err;
 344 }
 345
 346 static int lm77_detach_client(struct i2c_client *client)
 347 {
 348         struct lm77_data *data = i2c_get_clientdata(client);
 349         hwmon_device_unregister(data->class_dev);
 350         i2c_detach_client(client);
 351         kfree(data);
 352         return 0;
 353 }
 354
 355 /* All registers are word-sized, except for the configuration register.
 356    The LM77 uses the high-byte first convention. */
 357 static u16 lm77_read_value(struct i2c_client *client, u8 reg)
 358 {
 359         if (reg == LM77_REG_CONF)
 360                 return i2c_smbus_read_byte_data(client, reg);
 361         else
 362                 return swab16(i2c_smbus_read_word_data(client, reg));
 363 }
 364
 365 static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value)
 366 {
 367         if (reg == LM77_REG_CONF)
 368                 return i2c_smbus_write_byte_data(client, reg, value);
 369         else
 370                 return i2c_smbus_write_word_data(client, reg, swab16(value));
 371 }
 372
 373 static void lm77_init_client(struct i2c_client *client)
 374 {
 375         /* Initialize the LM77 chip - turn off shutdown mode */
 376         int conf = lm77_read_value(client, LM77_REG_CONF);
 377         if (conf & 1)
 378                 lm77_write_value(client, LM77_REG_CONF, conf & 0xfe);
 379 }
 380
 381 static struct lm77_data *lm77_update_device(struct device *dev)
 382 {
 383         struct i2c_client *client = to_i2c_client(dev);
 384         struct lm77_data *data = i2c_get_clientdata(client);
 385
 386         down(&data->update_lock);
 387
 388         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 389             || !data->valid) {
 390                 dev_dbg(&client->dev, "Starting lm77 update\n");
 391                 data->temp_input =
 392                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 393                                                            LM77_REG_TEMP));
 394                 data->temp_hyst =
 395                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 396                                                            LM77_REG_TEMP_HYST));
 397                 data->temp_crit =
 398                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 399                                                            LM77_REG_TEMP_CRIT));
 400                 data->temp_min =
 401                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 402                                                            LM77_REG_TEMP_MIN));
 403                 data->temp_max =
 404                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 405                                                            LM77_REG_TEMP_MAX));
 406                 data->alarms =
 407                         lm77_read_value(client, LM77_REG_TEMP) & 0x0007;
 408                 data->last_updated = jiffies;
 409                 data->valid = 1;
 410         }
 411
 412         up(&data->update_lock);
 413
 414         return data;
 415 }
 416
 417 static int __init sensors_lm77_init(void)
 418 {
 419         return i2c_add_driver(&lm77_driver);
 420 }
 421
 422 static void __exit sensors_lm77_exit(void)
 423 {
 424         i2c_del_driver(&lm77_driver);
 425 }
 426
 427 MODULE_AUTHOR("Andras BALI <drewie@freemail.hu>");
 428 MODULE_DESCRIPTION("LM77 driver");
 429 MODULE_LICENSE("GPL");
 430
 431 module_init(sensors_lm77_init);
 432 module_exit(sensors_lm77_exit);