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/hwmon.h>
  34 #include <linux/hwmon-sysfs.h>
  35 #include <linux/err.h>
  36 #include <linux/mutex.h>
  37
  38 /* Addresses to scan */
  39 static unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, I2C_CLIENT_END };
  40
  41 /* Insmod parameters */
  42 I2C_CLIENT_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 device           *hwmon_dev;
  56         struct mutex            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         .driver = {
  80                 .name   = "lm77",
  81         },
  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 s16 LM77_TEMP_TO_REG(int temp)
  93 {
  94         int ntemp = SENSORS_LIMIT(temp, LM77_TEMP_MIN, LM77_TEMP_MAX);
  95         return (ntemp / 500) * 8;
  96 }
  97
  98 static inline int LM77_TEMP_FROM_REG(s16 reg)
  99 {
 100         return (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
 118 /* read routines for hysteresis values */
 119 static ssize_t show_temp_crit_hyst(struct device *dev, struct device_attribute *attr, char *buf)
 120 {
 121         struct lm77_data *data = lm77_update_device(dev);
 122         return sprintf(buf, "%d\n", data->temp_crit - data->temp_hyst);
 123 }
 124 static ssize_t show_temp_min_hyst(struct device *dev, struct device_attribute *attr, char *buf)
 125 {
 126         struct lm77_data *data = lm77_update_device(dev);
 127         return sprintf(buf, "%d\n", data->temp_min + data->temp_hyst);
 128 }
 129 static ssize_t show_temp_max_hyst(struct device *dev, struct device_attribute *attr, char *buf)
 130 {
 131         struct lm77_data *data = lm77_update_device(dev);
 132         return sprintf(buf, "%d\n", data->temp_max - data->temp_hyst);
 133 }
 134
 135 /* write routines */
 136 #define set(value, reg) \
 137 static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)    \
 138 {                                                                               \
 139         struct i2c_client *client = to_i2c_client(dev);                         \
 140         struct lm77_data *data = i2c_get_clientdata(client);                    \
 141         long val = simple_strtol(buf, NULL, 10);                                \
 142                                                                                 \
 143         mutex_lock(&data->update_lock);                                         \
 144         data->value = val;                              \
 145         lm77_write_value(client, reg, LM77_TEMP_TO_REG(data->value));           \
 146         mutex_unlock(&data->update_lock);                                       \
 147         return count;                                                           \
 148 }
 149
 150 set(temp_min, LM77_REG_TEMP_MIN);
 151 set(temp_max, LM77_REG_TEMP_MAX);
 152
 153 /* hysteresis is stored as a relative value on the chip, so it has to be
 154    converted first */
 155 static ssize_t set_temp_crit_hyst(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 156 {
 157         struct i2c_client *client = to_i2c_client(dev);
 158         struct lm77_data *data = i2c_get_clientdata(client);
 159         unsigned long val = simple_strtoul(buf, NULL, 10);
 160
 161         mutex_lock(&data->update_lock);
 162         data->temp_hyst = data->temp_crit - val;
 163         lm77_write_value(client, LM77_REG_TEMP_HYST,
 164                          LM77_TEMP_TO_REG(data->temp_hyst));
 165         mutex_unlock(&data->update_lock);
 166         return count;
 167 }
 168
 169 /* preserve hysteresis when setting T_crit */
 170 static ssize_t set_temp_crit(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
 171 {
 172         struct i2c_client *client = to_i2c_client(dev);
 173         struct lm77_data *data = i2c_get_clientdata(client);
 174         long val = simple_strtoul(buf, NULL, 10);
 175         int oldcrithyst;
 176
 177         mutex_lock(&data->update_lock);
 178         oldcrithyst = data->temp_crit - data->temp_hyst;
 179         data->temp_crit = val;
 180         data->temp_hyst = data->temp_crit - oldcrithyst;
 181         lm77_write_value(client, LM77_REG_TEMP_CRIT,
 182                          LM77_TEMP_TO_REG(data->temp_crit));
 183         lm77_write_value(client, LM77_REG_TEMP_HYST,
 184                          LM77_TEMP_TO_REG(data->temp_hyst));
 185         mutex_unlock(&data->update_lock);
 186         return count;
 187 }
 188
 189 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
 190                           char *buf)
 191 {
 192         int bitnr = to_sensor_dev_attr(attr)->index;
 193         struct lm77_data *data = lm77_update_device(dev);
 194         return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
 195 }
 196
 197 static DEVICE_ATTR(temp1_input, S_IRUGO,
 198                    show_temp_input, NULL);
 199 static DEVICE_ATTR(temp1_crit, S_IWUSR | S_IRUGO,
 200                    show_temp_crit, set_temp_crit);
 201 static DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO,
 202                    show_temp_min, set_temp_min);
 203 static DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
 204                    show_temp_max, set_temp_max);
 205
 206 static DEVICE_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO,
 207                    show_temp_crit_hyst, set_temp_crit_hyst);
 208 static DEVICE_ATTR(temp1_min_hyst, S_IRUGO,
 209                    show_temp_min_hyst, NULL);
 210 static DEVICE_ATTR(temp1_max_hyst, S_IRUGO,
 211                    show_temp_max_hyst, NULL);
 212
 213 static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL, 2);
 214 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
 215 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 1);
 216
 217 static int lm77_attach_adapter(struct i2c_adapter *adapter)
 218 {
 219         if (!(adapter->class & I2C_CLASS_HWMON))
 220                 return 0;
 221         return i2c_probe(adapter, &addr_data, lm77_detect);
 222 }
 223
 224 static struct attribute *lm77_attributes[] = {
 225         &dev_attr_temp1_input.attr,
 226         &dev_attr_temp1_crit.attr,
 227         &dev_attr_temp1_min.attr,
 228         &dev_attr_temp1_max.attr,
 229         &dev_attr_temp1_crit_hyst.attr,
 230         &dev_attr_temp1_min_hyst.attr,
 231         &dev_attr_temp1_max_hyst.attr,
 232         &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr,
 233         &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
 234         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
 235         NULL
 236 };
 237
 238 static const struct attribute_group lm77_group = {
 239         .attrs = lm77_attributes,
 240 };
 241
 242 /* This function is called by i2c_probe */
 243 static int lm77_detect(struct i2c_adapter *adapter, int address, int kind)
 244 {
 245         struct i2c_client *new_client;
 246         struct lm77_data *data;
 247         int err = 0;
 248         const char *name = "";
 249
 250         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 251                                      I2C_FUNC_SMBUS_WORD_DATA))
 252                 goto exit;
 253
 254         /* OK. For now, we presume we have a valid client. We now create the
 255            client structure, even though we cannot fill it completely yet.
 256            But it allows us to access lm77_{read,write}_value. */
 257         if (!(data = kzalloc(sizeof(struct lm77_data), GFP_KERNEL))) {
 258                 err = -ENOMEM;
 259                 goto exit;
 260         }
 261
 262         new_client = &data->client;
 263         i2c_set_clientdata(new_client, data);
 264         new_client->addr = address;
 265         new_client->adapter = adapter;
 266         new_client->driver = &lm77_driver;
 267         new_client->flags = 0;
 268
 269         /* Here comes the remaining detection.  Since the LM77 has no
 270            register dedicated to identification, we have to rely on the
 271            following tricks:
 272
 273            1. the high 4 bits represent the sign and thus they should
 274               always be the same
 275            2. the high 3 bits are unused in the configuration register
 276            3. addresses 0x06 and 0x07 return the last read value
 277            4. registers cycling over 8-address boundaries
 278
 279            Word-sized registers are high-byte first. */
 280         if (kind < 0) {
 281                 int i, cur, conf, hyst, crit, min, max;
 282
 283                 /* addresses cycling */
 284                 cur = i2c_smbus_read_word_data(new_client, 0);
 285                 conf = i2c_smbus_read_byte_data(new_client, 1);
 286                 hyst = i2c_smbus_read_word_data(new_client, 2);
 287                 crit = i2c_smbus_read_word_data(new_client, 3);
 288                 min = i2c_smbus_read_word_data(new_client, 4);
 289                 max = i2c_smbus_read_word_data(new_client, 5);
 290                 for (i = 8; i <= 0xff; i += 8)
 291                         if (i2c_smbus_read_byte_data(new_client, i + 1) != conf
 292                             || i2c_smbus_read_word_data(new_client, i + 2) != hyst
 293                             || i2c_smbus_read_word_data(new_client, i + 3) != crit
 294                             || i2c_smbus_read_word_data(new_client, i + 4) != min
 295                             || i2c_smbus_read_word_data(new_client, i + 5) != max)
 296                                 goto exit_free;
 297
 298                 /* sign bits */
 299                 if (((cur & 0x00f0) != 0xf0 && (cur & 0x00f0) != 0x0)
 300                     || ((hyst & 0x00f0) != 0xf0 && (hyst & 0x00f0) != 0x0)
 301                     || ((crit & 0x00f0) != 0xf0 && (crit & 0x00f0) != 0x0)
 302                     || ((min & 0x00f0) != 0xf0 && (min & 0x00f0) != 0x0)
 303                     || ((max & 0x00f0) != 0xf0 && (max & 0x00f0) != 0x0))
 304                         goto exit_free;
 305
 306                 /* unused bits */
 307                 if (conf & 0xe0)
 308                         goto exit_free;
 309
 310                 /* 0x06 and 0x07 return the last read value */
 311                 cur = i2c_smbus_read_word_data(new_client, 0);
 312                 if (i2c_smbus_read_word_data(new_client, 6) != cur
 313                     || i2c_smbus_read_word_data(new_client, 7) != cur)
 314                         goto exit_free;
 315                 hyst = i2c_smbus_read_word_data(new_client, 2);
 316                 if (i2c_smbus_read_word_data(new_client, 6) != hyst
 317                     || i2c_smbus_read_word_data(new_client, 7) != hyst)
 318                         goto exit_free;
 319                 min = i2c_smbus_read_word_data(new_client, 4);
 320                 if (i2c_smbus_read_word_data(new_client, 6) != min
 321                     || i2c_smbus_read_word_data(new_client, 7) != min)
 322                         goto exit_free;
 323
 324         }
 325
 326         /* Determine the chip type - only one kind supported! */
 327         if (kind <= 0)
 328                 kind = lm77;
 329
 330         if (kind == lm77) {
 331                 name = "lm77";
 332         }
 333
 334         /* Fill in the remaining client fields and put it into the global list */
 335         strlcpy(new_client->name, name, I2C_NAME_SIZE);
 336         data->valid = 0;
 337         mutex_init(&data->update_lock);
 338
 339         /* Tell the I2C layer a new client has arrived */
 340         if ((err = i2c_attach_client(new_client)))
 341                 goto exit_free;
 342
 343         /* Initialize the LM77 chip */
 344         lm77_init_client(new_client);
 345
 346         /* Register sysfs hooks */
 347         if ((err = sysfs_create_group(&new_client->dev.kobj, &lm77_group)))
 348                 goto exit_detach;
 349
 350         data->hwmon_dev = hwmon_device_register(&new_client->dev);
 351         if (IS_ERR(data->hwmon_dev)) {
 352                 err = PTR_ERR(data->hwmon_dev);
 353                 goto exit_remove;
 354         }
 355
 356         return 0;
 357
 358 exit_remove:
 359         sysfs_remove_group(&new_client->dev.kobj, &lm77_group);
 360 exit_detach:
 361         i2c_detach_client(new_client);
 362 exit_free:
 363         kfree(data);
 364 exit:
 365         return err;
 366 }
 367
 368 static int lm77_detach_client(struct i2c_client *client)
 369 {
 370         struct lm77_data *data = i2c_get_clientdata(client);
 371         hwmon_device_unregister(data->hwmon_dev);
 372         sysfs_remove_group(&client->dev.kobj, &lm77_group);
 373         i2c_detach_client(client);
 374         kfree(data);
 375         return 0;
 376 }
 377
 378 /* All registers are word-sized, except for the configuration register.
 379    The LM77 uses the high-byte first convention. */
 380 static u16 lm77_read_value(struct i2c_client *client, u8 reg)
 381 {
 382         if (reg == LM77_REG_CONF)
 383                 return i2c_smbus_read_byte_data(client, reg);
 384         else
 385                 return swab16(i2c_smbus_read_word_data(client, reg));
 386 }
 387
 388 static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value)
 389 {
 390         if (reg == LM77_REG_CONF)
 391                 return i2c_smbus_write_byte_data(client, reg, value);
 392         else
 393                 return i2c_smbus_write_word_data(client, reg, swab16(value));
 394 }
 395
 396 static void lm77_init_client(struct i2c_client *client)
 397 {
 398         /* Initialize the LM77 chip - turn off shutdown mode */
 399         int conf = lm77_read_value(client, LM77_REG_CONF);
 400         if (conf & 1)
 401                 lm77_write_value(client, LM77_REG_CONF, conf & 0xfe);
 402 }
 403
 404 static struct lm77_data *lm77_update_device(struct device *dev)
 405 {
 406         struct i2c_client *client = to_i2c_client(dev);
 407         struct lm77_data *data = i2c_get_clientdata(client);
 408
 409         mutex_lock(&data->update_lock);
 410
 411         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 412             || !data->valid) {
 413                 dev_dbg(&client->dev, "Starting lm77 update\n");
 414                 data->temp_input =
 415                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 416                                                            LM77_REG_TEMP));
 417                 data->temp_hyst =
 418                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 419                                                            LM77_REG_TEMP_HYST));
 420                 data->temp_crit =
 421                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 422                                                            LM77_REG_TEMP_CRIT));
 423                 data->temp_min =
 424                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 425                                                            LM77_REG_TEMP_MIN));
 426                 data->temp_max =
 427                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 428                                                            LM77_REG_TEMP_MAX));
 429                 data->alarms =
 430                         lm77_read_value(client, LM77_REG_TEMP) & 0x0007;
 431                 data->last_updated = jiffies;
 432                 data->valid = 1;
 433         }
 434
 435         mutex_unlock(&data->update_lock);
 436
 437         return data;
 438 }
 439
 440 static int __init sensors_lm77_init(void)
 441 {
 442         return i2c_add_driver(&lm77_driver);
 443 }
 444
 445 static void __exit sensors_lm77_exit(void)
 446 {
 447         i2c_del_driver(&lm77_driver);
 448 }
 449
 450 MODULE_AUTHOR("Andras BALI <drewie@freemail.hu>");
 451 MODULE_DESCRIPTION("LM77 driver");
 452 MODULE_LICENSE("GPL");
 453
 454 module_init(sensors_lm77_init);
 455 module_exit(sensors_lm77_exit);