drivers/hwmon/lm75.c

   1 /*
   2     lm75.c - Part of lm_sensors, Linux kernel modules for hardware
   3              monitoring
   4     Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #include <linux/module.h>
  22 #include <linux/init.h>
  23 #include <linux/slab.h>
  24 #include <linux/jiffies.h>
  25 #include <linux/i2c.h>
  26 #include <linux/hwmon.h>
  27 #include <linux/hwmon-sysfs.h>
  28 #include <linux/err.h>
  29 #include <linux/mutex.h>
  30 #include "lm75.h"
  31
  32
  33 /*
  34  * This driver handles the LM75 and compatible digital temperature sensors.
  35  */
  36
  37 enum lm75_type {                /* keep sorted in alphabetical order */
  38         ds1775,
  39         ds75,
  40         lm75,
  41         lm75a,
  42         max6625,
  43         max6626,
  44         mcp980x,
  45         stds75,
  46         tcn75,
  47         tmp100,
  48         tmp101,
  49         tmp105,
  50         tmp175,
  51         tmp275,
  52         tmp75,
  53 };
  54
  55 /* Addresses scanned */
  56 static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, 0x4c,
  57                                         0x4d, 0x4e, 0x4f, I2C_CLIENT_END };
  58
  59
  60 /* The LM75 registers */
  61 #define LM75_REG_CONF           0x01
  62 static const u8 LM75_REG_TEMP[3] = {
  63         0x00,           /* input */
  64         0x03,           /* max */
  65         0x02,           /* hyst */
  66 };
  67
  68 /* Each client has this additional data */
  69 struct lm75_data {
  70         struct device           *hwmon_dev;
  71         struct mutex            update_lock;
  72         u8                      orig_conf;
  73         char                    valid;          /* !=0 if registers are valid */
  74         unsigned long           last_updated;   /* In jiffies */
  75         u16                     temp[3];        /* Register values,
  76                                                    0 = input
  77                                                    1 = max
  78                                                    2 = hyst */
  79 };
  80
  81 static int lm75_read_value(struct i2c_client *client, u8 reg);
  82 static int lm75_write_value(struct i2c_client *client, u8 reg, u16 value);
  83 static struct lm75_data *lm75_update_device(struct device *dev);
  84
  85
  86 /*-----------------------------------------------------------------------*/
  87
  88 /* sysfs attributes for hwmon */
  89
  90 static ssize_t show_temp(struct device *dev, struct device_attribute *da,
  91                          char *buf)
  92 {
  93         struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
  94         struct lm75_data *data = lm75_update_device(dev);
  95         return sprintf(buf, "%d\n",
  96                        LM75_TEMP_FROM_REG(data->temp[attr->index]));
  97 }
  98
  99 static ssize_t set_temp(struct device *dev, struct device_attribute *da,
 100                         const char *buf, size_t count)
 101 {
 102         struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
 103         struct i2c_client *client = to_i2c_client(dev);
 104         struct lm75_data *data = i2c_get_clientdata(client);
 105         int nr = attr->index;
 106         long temp = simple_strtol(buf, NULL, 10);
 107
 108         mutex_lock(&data->update_lock);
 109         data->temp[nr] = LM75_TEMP_TO_REG(temp);
 110         lm75_write_value(client, LM75_REG_TEMP[nr], data->temp[nr]);
 111         mutex_unlock(&data->update_lock);
 112         return count;
 113 }
 114
 115 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
 116                         show_temp, set_temp, 1);
 117 static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IWUSR | S_IRUGO,
 118                         show_temp, set_temp, 2);
 119 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 120
 121 static struct attribute *lm75_attributes[] = {
 122         &sensor_dev_attr_temp1_input.dev_attr.attr,
 123         &sensor_dev_attr_temp1_max.dev_attr.attr,
 124         &sensor_dev_attr_temp1_max_hyst.dev_attr.attr,
 125
 126         NULL
 127 };
 128
 129 static const struct attribute_group lm75_group = {
 130         .attrs = lm75_attributes,
 131 };
 132
 133 /*-----------------------------------------------------------------------*/
 134
 135 /* device probe and removal */
 136
 137 static int
 138 lm75_probe(struct i2c_client *client, const struct i2c_device_id *id)
 139 {
 140         struct lm75_data *data;
 141         int status;
 142         u8 set_mask, clr_mask;
 143         int new;
 144
 145         if (!i2c_check_functionality(client->adapter,
 146                         I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA))
 147                 return -EIO;
 148
 149         data = kzalloc(sizeof(struct lm75_data), GFP_KERNEL);
 150         if (!data)
 151                 return -ENOMEM;
 152
 153         i2c_set_clientdata(client, data);
 154         mutex_init(&data->update_lock);
 155
 156         /* Set to LM75 resolution (9 bits, 1/2 degree C) and range.
 157          * Then tweak to be more precise when appropriate.
 158          */
 159         set_mask = 0;
 160         clr_mask = (1 << 0)                     /* continuous conversions */
 161                 | (1 << 6) | (1 << 5);          /* 9-bit mode */
 162
 163         /* configure as specified */
 164         status = lm75_read_value(client, LM75_REG_CONF);
 165         if (status < 0) {
 166                 dev_dbg(&client->dev, "Can't read config? %d\n", status);
 167                 goto exit_free;
 168         }
 169         data->orig_conf = status;
 170         new = status & ~clr_mask;
 171         new |= set_mask;
 172         if (status != new)
 173                 lm75_write_value(client, LM75_REG_CONF, new);
 174         dev_dbg(&client->dev, "Config %02x\n", new);
 175
 176         /* Register sysfs hooks */
 177         status = sysfs_create_group(&client->dev.kobj, &lm75_group);
 178         if (status)
 179                 goto exit_free;
 180
 181         data->hwmon_dev = hwmon_device_register(&client->dev);
 182         if (IS_ERR(data->hwmon_dev)) {
 183                 status = PTR_ERR(data->hwmon_dev);
 184                 goto exit_remove;
 185         }
 186
 187         dev_info(&client->dev, "%s: sensor '%s'\n",
 188                  dev_name(data->hwmon_dev), client->name);
 189
 190         return 0;
 191
 192 exit_remove:
 193         sysfs_remove_group(&client->dev.kobj, &lm75_group);
 194 exit_free:
 195         kfree(data);
 196         return status;
 197 }
 198
 199 static int lm75_remove(struct i2c_client *client)
 200 {
 201         struct lm75_data *data = i2c_get_clientdata(client);
 202
 203         hwmon_device_unregister(data->hwmon_dev);
 204         sysfs_remove_group(&client->dev.kobj, &lm75_group);
 205         lm75_write_value(client, LM75_REG_CONF, data->orig_conf);
 206         kfree(data);
 207         return 0;
 208 }
 209
 210 static const struct i2c_device_id lm75_ids[] = {
 211         { "ds1775", ds1775, },
 212         { "ds75", ds75, },
 213         { "lm75", lm75, },
 214         { "lm75a", lm75a, },
 215         { "max6625", max6625, },
 216         { "max6626", max6626, },
 217         { "mcp980x", mcp980x, },
 218         { "stds75", stds75, },
 219         { "tcn75", tcn75, },
 220         { "tmp100", tmp100, },
 221         { "tmp101", tmp101, },
 222         { "tmp105", tmp105, },
 223         { "tmp175", tmp175, },
 224         { "tmp275", tmp275, },
 225         { "tmp75", tmp75, },
 226         { /* LIST END */ }
 227 };
 228 MODULE_DEVICE_TABLE(i2c, lm75_ids);
 229
 230 /* Return 0 if detection is successful, -ENODEV otherwise */
 231 static int lm75_detect(struct i2c_client *new_client,
 232                        struct i2c_board_info *info)
 233 {
 234         struct i2c_adapter *adapter = new_client->adapter;
 235         int i;
 236         int cur, conf, hyst, os;
 237
 238         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 239                                      I2C_FUNC_SMBUS_WORD_DATA))
 240                 return -ENODEV;
 241
 242         /* Now, we do the remaining detection. There is no identification-
 243            dedicated register so we have to rely on several tricks:
 244            unused bits, registers cycling over 8-address boundaries,
 245            addresses 0x04-0x07 returning the last read value.
 246            The cycling+unused addresses combination is not tested,
 247            since it would significantly slow the detection down and would
 248            hardly add any value. */
 249
 250         /* Unused addresses */
 251         cur = i2c_smbus_read_word_data(new_client, 0);
 252         conf = i2c_smbus_read_byte_data(new_client, 1);
 253         hyst = i2c_smbus_read_word_data(new_client, 2);
 254         if (i2c_smbus_read_word_data(new_client, 4) != hyst
 255          || i2c_smbus_read_word_data(new_client, 5) != hyst
 256          || i2c_smbus_read_word_data(new_client, 6) != hyst
 257          || i2c_smbus_read_word_data(new_client, 7) != hyst)
 258                 return -ENODEV;
 259         os = i2c_smbus_read_word_data(new_client, 3);
 260         if (i2c_smbus_read_word_data(new_client, 4) != os
 261          || i2c_smbus_read_word_data(new_client, 5) != os
 262          || i2c_smbus_read_word_data(new_client, 6) != os
 263          || i2c_smbus_read_word_data(new_client, 7) != os)
 264                 return -ENODEV;
 265
 266         /* Unused bits */
 267         if (conf & 0xe0)
 268                 return -ENODEV;
 269
 270         /* Addresses cycling */
 271         for (i = 8; i < 0xff; i += 8) {
 272                 if (i2c_smbus_read_byte_data(new_client, i + 1) != conf
 273                  || i2c_smbus_read_word_data(new_client, i + 2) != hyst
 274                  || i2c_smbus_read_word_data(new_client, i + 3) != os)
 275                         return -ENODEV;
 276         }
 277
 278         strlcpy(info->type, "lm75", I2C_NAME_SIZE);
 279
 280         return 0;
 281 }
 282
 283 #ifdef CONFIG_PM
 284 static int lm75_suspend(struct device *dev)
 285 {
 286         int status;
 287         struct i2c_client *client = to_i2c_client(dev);
 288         status = lm75_read_value(client, LM75_REG_CONF);
 289         if (status < 0) {
 290                 dev_dbg(&client->dev, "Can't read config? %d\n", status);
 291                 return status;
 292         }
 293         status = status | LM75_SHUTDOWN;
 294         lm75_write_value(client, LM75_REG_CONF, status);
 295         return 0;
 296 }
 297
 298 static int lm75_resume(struct device *dev)
 299 {
 300         int status;
 301         struct i2c_client *client = to_i2c_client(dev);
 302         status = lm75_read_value(client, LM75_REG_CONF);
 303         if (status < 0) {
 304                 dev_dbg(&client->dev, "Can't read config? %d\n", status);
 305                 return status;
 306         }
 307         status = status & ~LM75_SHUTDOWN;
 308         lm75_write_value(client, LM75_REG_CONF, status);
 309         return 0;
 310 }
 311
 312 static const struct dev_pm_ops lm75_dev_pm_ops = {
 313         .suspend        = lm75_suspend,
 314         .resume         = lm75_resume,
 315 };
 316 #define LM75_DEV_PM_OPS (&lm75_dev_pm_ops)
 317 #else
 318 #define LM75_DEV_PM_OPS NULL
 319 #endif /* CONFIG_PM */
 320
 321 static struct i2c_driver lm75_driver = {
 322         .class          = I2C_CLASS_HWMON,
 323         .driver = {
 324                 .name   = "lm75",
 325                 .pm     = LM75_DEV_PM_OPS,
 326         },
 327         .probe          = lm75_probe,
 328         .remove         = lm75_remove,
 329         .id_table       = lm75_ids,
 330         .detect         = lm75_detect,
 331         .address_list   = normal_i2c,
 332 };
 333
 334 /*-----------------------------------------------------------------------*/
 335
 336 /* register access */
 337
 338 /* All registers are word-sized, except for the configuration register.
 339    LM75 uses a high-byte first convention, which is exactly opposite to
 340    the SMBus standard. */
 341 static int lm75_read_value(struct i2c_client *client, u8 reg)
 342 {
 343         int value;
 344
 345         if (reg == LM75_REG_CONF)
 346                 return i2c_smbus_read_byte_data(client, reg);
 347
 348         value = i2c_smbus_read_word_data(client, reg);
 349         return (value < 0) ? value : swab16(value);
 350 }
 351
 352 static int lm75_write_value(struct i2c_client *client, u8 reg, u16 value)
 353 {
 354         if (reg == LM75_REG_CONF)
 355                 return i2c_smbus_write_byte_data(client, reg, value);
 356         else
 357                 return i2c_smbus_write_word_data(client, reg, swab16(value));
 358 }
 359
 360 static struct lm75_data *lm75_update_device(struct device *dev)
 361 {
 362         struct i2c_client *client = to_i2c_client(dev);
 363         struct lm75_data *data = i2c_get_clientdata(client);
 364
 365         mutex_lock(&data->update_lock);
 366
 367         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 368             || !data->valid) {
 369                 int i;
 370                 dev_dbg(&client->dev, "Starting lm75 update\n");
 371
 372                 for (i = 0; i < ARRAY_SIZE(data->temp); i++) {
 373                         int status;
 374
 375                         status = lm75_read_value(client, LM75_REG_TEMP[i]);
 376                         if (status < 0)
 377                                 dev_dbg(&client->dev, "reg %d, err %d\n",
 378                                                 LM75_REG_TEMP[i], status);
 379                         else
 380                                 data->temp[i] = status;
 381                 }
 382                 data->last_updated = jiffies;
 383                 data->valid = 1;
 384         }
 385
 386         mutex_unlock(&data->update_lock);
 387
 388         return data;
 389 }
 390
 391 /*-----------------------------------------------------------------------*/
 392
 393 /* module glue */
 394
 395 static int __init sensors_lm75_init(void)
 396 {
 397         return i2c_add_driver(&lm75_driver);
 398 }
 399
 400 static void __exit sensors_lm75_exit(void)
 401 {
 402         i2c_del_driver(&lm75_driver);
 403 }
 404
 405 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>");
 406 MODULE_DESCRIPTION("LM75 driver");
 407 MODULE_LICENSE("GPL");
 408
 409 module_init(sensors_lm75_init);
 410 module_exit(sensors_lm75_exit);