drivers/i2c/chips/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/config.h>
  29 #include <linux/module.h>
  30 #include <linux/init.h>
  31 #include <linux/slab.h>
  32 #include <linux/i2c.h>
  33 #include <linux/i2c-sensor.h>
  34
  35
  36 /* Addresses to scan */
  37 static unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, I2C_CLIENT_END };
  38 static unsigned int normal_isa[] = { I2C_CLIENT_ISA_END };
  39
  40 /* Insmod parameters */
  41 SENSORS_INSMOD_1(lm77);
  42
  43 /* The LM77 registers */
  44 #define LM77_REG_TEMP           0x00
  45 #define LM77_REG_CONF           0x01
  46 #define LM77_REG_TEMP_HYST      0x02
  47 #define LM77_REG_TEMP_CRIT      0x03
  48 #define LM77_REG_TEMP_MIN       0x04
  49 #define LM77_REG_TEMP_MAX       0x05
  50
  51 /* Each client has this additional data */
  52 struct lm77_data {
  53         struct i2c_client       client;
  54         struct semaphore        update_lock;
  55         char                    valid;
  56         unsigned long           last_updated;   /* In jiffies */
  57         int                     temp_input;     /* Temperatures */
  58         int                     temp_crit;
  59         int                     temp_min;
  60         int                     temp_max;
  61         int                     temp_hyst;
  62         u8                      alarms;
  63 };
  64
  65 static int lm77_attach_adapter(struct i2c_adapter *adapter);
  66 static int lm77_detect(struct i2c_adapter *adapter, int address, int kind);
  67 static void lm77_init_client(struct i2c_client *client);
  68 static int lm77_detach_client(struct i2c_client *client);
  69 static u16 lm77_read_value(struct i2c_client *client, u8 reg);
  70 static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value);
  71
  72 static struct lm77_data *lm77_update_device(struct device *dev);
  73
  74
  75 /* This is the driver that will be inserted */
  76 static struct i2c_driver lm77_driver = {
  77         .owner          = THIS_MODULE,
  78         .name           = "lm77",
  79         .flags          = I2C_DF_NOTIFY,
  80         .attach_adapter = lm77_attach_adapter,
  81         .detach_client  = lm77_detach_client,
  82 };
  83
  84 static int lm77_id;
  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, 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, 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, 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, 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, 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         data->value = simple_strtoul(buf, NULL, 10);                            \
 143         lm77_write_value(client, reg, LM77_TEMP_TO_REG(data->value));           \
 144         return count;                                                           \
 145 }
 146
 147 set(temp_min, LM77_REG_TEMP_MIN);
 148 set(temp_max, LM77_REG_TEMP_MAX);
 149
 150 /* hysteresis is stored as a relative value on the chip, so it has to be
 151    converted first */
 152 static ssize_t set_temp_crit_hyst(struct device *dev, const char *buf, size_t count)
 153 {
 154         struct i2c_client *client = to_i2c_client(dev);
 155         struct lm77_data *data = i2c_get_clientdata(client);
 156         data->temp_hyst = data->temp_crit - simple_strtoul(buf, NULL, 10);
 157         lm77_write_value(client, LM77_REG_TEMP_HYST,
 158                          LM77_TEMP_TO_REG(data->temp_hyst));
 159         return count;
 160 }
 161
 162 /* preserve hysteresis when setting T_crit */
 163 static ssize_t set_temp_crit(struct device *dev, const char *buf, size_t count)
 164 {
 165         struct i2c_client *client = to_i2c_client(dev);
 166         struct lm77_data *data = i2c_get_clientdata(client);
 167         int oldcrithyst = data->temp_crit - data->temp_hyst;
 168         data->temp_crit = simple_strtoul(buf, NULL, 10);
 169         data->temp_hyst = data->temp_crit - oldcrithyst;
 170         lm77_write_value(client, LM77_REG_TEMP_CRIT,
 171                          LM77_TEMP_TO_REG(data->temp_crit));
 172         lm77_write_value(client, LM77_REG_TEMP_HYST,
 173                          LM77_TEMP_TO_REG(data->temp_hyst));
 174         return count;
 175 }
 176
 177 static DEVICE_ATTR(temp1_input, S_IRUGO,
 178                    show_temp_input, NULL);
 179 static DEVICE_ATTR(temp1_crit, S_IWUSR | S_IRUGO,
 180                    show_temp_crit, set_temp_crit);
 181 static DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO,
 182                    show_temp_min, set_temp_min);
 183 static DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
 184                    show_temp_max, set_temp_max);
 185
 186 static DEVICE_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO,
 187                    show_temp_crit_hyst, set_temp_crit_hyst);
 188 static DEVICE_ATTR(temp1_min_hyst, S_IRUGO,
 189                    show_temp_min_hyst, NULL);
 190 static DEVICE_ATTR(temp1_max_hyst, S_IRUGO,
 191                    show_temp_max_hyst, NULL);
 192
 193 static DEVICE_ATTR(alarms, S_IRUGO,
 194                    show_alarms, NULL);
 195
 196 static int lm77_attach_adapter(struct i2c_adapter *adapter)
 197 {
 198         if (!(adapter->class & I2C_CLASS_HWMON))
 199                 return 0;
 200         return i2c_detect(adapter, &addr_data, lm77_detect);
 201 }
 202
 203 /* This function is called by i2c_detect */
 204 static int lm77_detect(struct i2c_adapter *adapter, int address, int kind)
 205 {
 206         struct i2c_client *new_client;
 207         struct lm77_data *data;
 208         int err = 0;
 209         const char *name = "";
 210
 211         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 212                                      I2C_FUNC_SMBUS_WORD_DATA))
 213                 goto exit;
 214
 215         /* OK. For now, we presume we have a valid client. We now create the
 216            client structure, even though we cannot fill it completely yet.
 217            But it allows us to access lm77_{read,write}_value. */
 218         if (!(data = kmalloc(sizeof(struct lm77_data), GFP_KERNEL))) {
 219                 err = -ENOMEM;
 220                 goto exit;
 221         }
 222         memset(data, 0, sizeof(struct lm77_data));
 223
 224         new_client = &data->client;
 225         i2c_set_clientdata(new_client, data);
 226         new_client->addr = address;
 227         new_client->adapter = adapter;
 228         new_client->driver = &lm77_driver;
 229         new_client->flags = 0;
 230
 231         /* Here comes the remaining detection.  Since the LM77 has no
 232            register dedicated to identification, we have to rely on the
 233            following tricks:
 234
 235            1. the high 4 bits represent the sign and thus they should
 236               always be the same
 237            2. the high 3 bits are unused in the configuration register
 238            3. addresses 0x06 and 0x07 return the last read value
 239            4. registers cycling over 8-address boundaries
 240
 241            Word-sized registers are high-byte first. */
 242         if (kind < 0) {
 243                 int i, cur, conf, hyst, crit, min, max;
 244
 245                 /* addresses cycling */
 246                 cur = i2c_smbus_read_word_data(new_client, 0);
 247                 conf = i2c_smbus_read_byte_data(new_client, 1);
 248                 hyst = i2c_smbus_read_word_data(new_client, 2);
 249                 crit = i2c_smbus_read_word_data(new_client, 3);
 250                 min = i2c_smbus_read_word_data(new_client, 4);
 251                 max = i2c_smbus_read_word_data(new_client, 5);
 252                 for (i = 8; i <= 0xff; i += 8)
 253                         if (i2c_smbus_read_byte_data(new_client, i + 1) != conf
 254                             || i2c_smbus_read_word_data(new_client, i + 2) != hyst
 255                             || i2c_smbus_read_word_data(new_client, i + 3) != crit
 256                             || i2c_smbus_read_word_data(new_client, i + 4) != min
 257                             || i2c_smbus_read_word_data(new_client, i + 5) != max)
 258                                 goto exit_free;
 259
 260                 /* sign bits */
 261                 if (((cur & 0x00f0) != 0xf0 && (cur & 0x00f0) != 0x0)
 262                     || ((hyst & 0x00f0) != 0xf0 && (hyst & 0x00f0) != 0x0)
 263                     || ((crit & 0x00f0) != 0xf0 && (crit & 0x00f0) != 0x0)
 264                     || ((min & 0x00f0) != 0xf0 && (min & 0x00f0) != 0x0)
 265                     || ((max & 0x00f0) != 0xf0 && (max & 0x00f0) != 0x0))
 266                         goto exit_free;
 267
 268                 /* unused bits */
 269                 if (conf & 0xe0)
 270                         goto exit_free;
 271
 272                 /* 0x06 and 0x07 return the last read value */
 273                 cur = i2c_smbus_read_word_data(new_client, 0);
 274                 if (i2c_smbus_read_word_data(new_client, 6) != cur
 275                     || i2c_smbus_read_word_data(new_client, 7) != cur)
 276                         goto exit_free;
 277                 hyst = i2c_smbus_read_word_data(new_client, 2);
 278                 if (i2c_smbus_read_word_data(new_client, 6) != hyst
 279                     || i2c_smbus_read_word_data(new_client, 7) != hyst)
 280                         goto exit_free;
 281                 min = i2c_smbus_read_word_data(new_client, 4);
 282                 if (i2c_smbus_read_word_data(new_client, 6) != min
 283                     || i2c_smbus_read_word_data(new_client, 7) != min)
 284                         goto exit_free;
 285
 286         }
 287
 288         /* Determine the chip type - only one kind supported! */
 289         if (kind <= 0)
 290                 kind = lm77;
 291
 292         if (kind == lm77) {
 293                 name = "lm77";
 294         }
 295
 296         /* Fill in the remaining client fields and put it into the global list */
 297         strlcpy(new_client->name, name, I2C_NAME_SIZE);
 298
 299         new_client->id = lm77_id++;
 300         data->valid = 0;
 301         init_MUTEX(&data->update_lock);
 302
 303         /* Tell the I2C layer a new client has arrived */
 304         if ((err = i2c_attach_client(new_client)))
 305                 goto exit_free;
 306
 307         /* Initialize the LM77 chip */
 308         lm77_init_client(new_client);
 309
 310         /* Register sysfs hooks */
 311         device_create_file(&new_client->dev, &dev_attr_temp1_input);
 312         device_create_file(&new_client->dev, &dev_attr_temp1_crit);
 313         device_create_file(&new_client->dev, &dev_attr_temp1_min);
 314         device_create_file(&new_client->dev, &dev_attr_temp1_max);
 315         device_create_file(&new_client->dev, &dev_attr_temp1_crit_hyst);
 316         device_create_file(&new_client->dev, &dev_attr_temp1_min_hyst);
 317         device_create_file(&new_client->dev, &dev_attr_temp1_max_hyst);
 318         device_create_file(&new_client->dev, &dev_attr_alarms);
 319         return 0;
 320
 321 exit_free:
 322         kfree(data);
 323 exit:
 324         return err;
 325 }
 326
 327 static int lm77_detach_client(struct i2c_client *client)
 328 {
 329         i2c_detach_client(client);
 330         kfree(i2c_get_clientdata(client));
 331         return 0;
 332 }
 333
 334 /* All registers are word-sized, except for the configuration register.
 335    The LM77 uses the high-byte first convention. */
 336 static u16 lm77_read_value(struct i2c_client *client, u8 reg)
 337 {
 338         if (reg == LM77_REG_CONF)
 339                 return i2c_smbus_read_byte_data(client, reg);
 340         else
 341                 return swab16(i2c_smbus_read_word_data(client, reg));
 342 }
 343
 344 static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value)
 345 {
 346         if (reg == LM77_REG_CONF)
 347                 return i2c_smbus_write_byte_data(client, reg, value);
 348         else
 349                 return i2c_smbus_write_word_data(client, reg, swab16(value));
 350 }
 351
 352 static void lm77_init_client(struct i2c_client *client)
 353 {
 354         /* Initialize the LM77 chip - turn off shutdown mode */
 355         int conf = lm77_read_value(client, LM77_REG_CONF);
 356         if (conf & 1)
 357                 lm77_write_value(client, LM77_REG_CONF, conf & 0xfe);
 358 }
 359
 360 static struct lm77_data *lm77_update_device(struct device *dev)
 361 {
 362         struct i2c_client *client = to_i2c_client(dev);
 363         struct lm77_data *data = i2c_get_clientdata(client);
 364
 365         down(&data->update_lock);
 366
 367         if ((jiffies - data->last_updated > HZ + HZ / 2) ||
 368             (jiffies < data->last_updated) || !data->valid) {
 369                 dev_dbg(&client->dev, "Starting lm77 update\n");
 370                 data->temp_input =
 371                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 372                                                            LM77_REG_TEMP));
 373                 data->temp_hyst =
 374                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 375                                                            LM77_REG_TEMP_HYST));
 376                 data->temp_crit =
 377                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 378                                                            LM77_REG_TEMP_CRIT));
 379                 data->temp_min =
 380                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 381                                                            LM77_REG_TEMP_MIN));
 382                 data->temp_max =
 383                         LM77_TEMP_FROM_REG(lm77_read_value(client,
 384                                                            LM77_REG_TEMP_MAX));
 385                 data->alarms =
 386                         lm77_read_value(client, LM77_REG_TEMP) & 0x0007;
 387                 data->last_updated = jiffies;
 388                 data->valid = 1;
 389         }
 390
 391         up(&data->update_lock);
 392
 393         return data;
 394 }
 395
 396 static int __init sensors_lm77_init(void)
 397 {
 398         return i2c_add_driver(&lm77_driver);
 399 }
 400
 401 static void __exit sensors_lm77_exit(void)
 402 {
 403         i2c_del_driver(&lm77_driver);
 404 }
 405
 406 MODULE_AUTHOR("Andras BALI <drewie@freemail.hu>");
 407 MODULE_DESCRIPTION("LM77 driver");
 408 MODULE_LICENSE("GPL");
 409
 410 module_init(sensors_lm77_init);
 411 module_exit(sensors_lm77_exit);