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 <linux/of.h>
  31 #include <linux/thermal.h>
  32 #include "lm75.h"
  33
  34
  35 /*
  36  * This driver handles the LM75 and compatible digital temperature sensors.
  37  */
  38
  39 enum lm75_type {                /* keep sorted in alphabetical order */
  40         adt75,
  41         ds1775,
  42         ds75,
  43         ds7505,
  44         lm75,
  45         lm75a,
  46         max6625,
  47         max6626,
  48         mcp980x,
  49         stds75,
  50         tcn75,
  51         tmp100,
  52         tmp101,
  53         tmp105,
  54         tmp175,
  55         tmp275,
  56         tmp75,
  57 };
  58
  59 /* Addresses scanned */
  60 static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, 0x4c,
  61                                         0x4d, 0x4e, 0x4f, I2C_CLIENT_END };
  62
  63
  64 /* The LM75 registers */
  65 #define LM75_REG_CONF           0x01
  66 static const u8 LM75_REG_TEMP[3] = {
  67         0x00,           /* input */
  68         0x03,           /* max */
  69         0x02,           /* hyst */
  70 };
  71
  72 /* Each client has this additional data */
  73 struct lm75_data {
  74         struct device           *hwmon_dev;
  75         struct thermal_zone_device      *tz;
  76         struct mutex            update_lock;
  77         u8                      orig_conf;
  78         u8                      resolution;     /* In bits, between 9 and 12 */
  79         u8                      resolution_limits;
  80         char                    valid;          /* !=0 if registers are valid */
  81         unsigned long           last_updated;   /* In jiffies */
  82         unsigned long           sample_time;    /* In jiffies */
  83         s16                     temp[3];        /* Register values,
  84                                                    0 = input
  85                                                    1 = max
  86                                                    2 = hyst */
  87 };
  88
  89 static int lm75_read_value(struct i2c_client *client, u8 reg);
  90 static int lm75_write_value(struct i2c_client *client, u8 reg, u16 value);
  91 static struct lm75_data *lm75_update_device(struct device *dev);
  92
  93
  94 /*-----------------------------------------------------------------------*/
  95
  96 static inline long lm75_reg_to_mc(s16 temp, u8 resolution)
  97 {
  98         return ((temp >> (16 - resolution)) * 1000) >> (resolution - 8);
  99 }
 100
 101 /* sysfs attributes for hwmon */
 102
 103 static int lm75_read_temp(void *dev, long *temp)
 104 {
 105         struct lm75_data *data = lm75_update_device(dev);
 106
 107         if (IS_ERR(data))
 108                 return PTR_ERR(data);
 109
 110         *temp = lm75_reg_to_mc(data->temp[0], data->resolution);
 111
 112         return 0;
 113 }
 114
 115 static ssize_t show_temp(struct device *dev, struct device_attribute *da,
 116                          char *buf)
 117 {
 118         struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
 119         struct lm75_data *data = lm75_update_device(dev);
 120
 121         if (IS_ERR(data))
 122                 return PTR_ERR(data);
 123
 124         return sprintf(buf, "%ld\n", lm75_reg_to_mc(data->temp[attr->index],
 125                                                     data->resolution));
 126 }
 127
 128 static ssize_t set_temp(struct device *dev, struct device_attribute *da,
 129                         const char *buf, size_t count)
 130 {
 131         struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
 132         struct i2c_client *client = to_i2c_client(dev);
 133         struct lm75_data *data = i2c_get_clientdata(client);
 134         int nr = attr->index;
 135         long temp;
 136         int error;
 137         u8 resolution;
 138
 139         error = kstrtol(buf, 10, &temp);
 140         if (error)
 141                 return error;
 142
 143         /*
 144          * Resolution of limit registers is assumed to be the same as the
 145          * temperature input register resolution unless given explicitly.
 146          */
 147         if (attr->index && data->resolution_limits)
 148                 resolution = data->resolution_limits;
 149         else
 150                 resolution = data->resolution;
 151
 152         mutex_lock(&data->update_lock);
 153         temp = clamp_val(temp, LM75_TEMP_MIN, LM75_TEMP_MAX);
 154         data->temp[nr] = DIV_ROUND_CLOSEST(temp  << (resolution - 8),
 155                                            1000) << (16 - resolution);
 156         lm75_write_value(client, LM75_REG_TEMP[nr], data->temp[nr]);
 157         mutex_unlock(&data->update_lock);
 158         return count;
 159 }
 160
 161 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
 162                         show_temp, set_temp, 1);
 163 static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IWUSR | S_IRUGO,
 164                         show_temp, set_temp, 2);
 165 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 166
 167 static struct attribute *lm75_attributes[] = {
 168         &sensor_dev_attr_temp1_input.dev_attr.attr,
 169         &sensor_dev_attr_temp1_max.dev_attr.attr,
 170         &sensor_dev_attr_temp1_max_hyst.dev_attr.attr,
 171
 172         NULL
 173 };
 174
 175 static const struct attribute_group lm75_group = {
 176         .attrs = lm75_attributes,
 177 };
 178
 179 /*-----------------------------------------------------------------------*/
 180
 181 /* device probe and removal */
 182
 183 static int
 184 lm75_probe(struct i2c_client *client, const struct i2c_device_id *id)
 185 {
 186         struct lm75_data *data;
 187         int status;
 188         u8 set_mask, clr_mask;
 189         int new;
 190         enum lm75_type kind = id->driver_data;
 191
 192         if (!i2c_check_functionality(client->adapter,
 193                         I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA))
 194                 return -EIO;
 195
 196         data = devm_kzalloc(&client->dev, sizeof(struct lm75_data), GFP_KERNEL);
 197         if (!data)
 198                 return -ENOMEM;
 199
 200         i2c_set_clientdata(client, data);
 201         mutex_init(&data->update_lock);
 202
 203         /* Set to LM75 resolution (9 bits, 1/2 degree C) and range.
 204          * Then tweak to be more precise when appropriate.
 205          */
 206         set_mask = 0;
 207         clr_mask = LM75_SHUTDOWN;               /* continuous conversions */
 208
 209         switch (kind) {
 210         case adt75:
 211                 clr_mask |= 1 << 5;             /* not one-shot mode */
 212                 data->resolution = 12;
 213                 data->sample_time = HZ / 8;
 214                 break;
 215         case ds1775:
 216         case ds75:
 217         case stds75:
 218                 clr_mask |= 3 << 5;
 219                 set_mask |= 2 << 5;             /* 11-bit mode */
 220                 data->resolution = 11;
 221                 data->sample_time = HZ;
 222                 break;
 223         case ds7505:
 224                 set_mask |= 3 << 5;             /* 12-bit mode */
 225                 data->resolution = 12;
 226                 data->sample_time = HZ / 4;
 227                 break;
 228         case lm75:
 229         case lm75a:
 230                 data->resolution = 9;
 231                 data->sample_time = HZ / 2;
 232                 break;
 233         case max6625:
 234                 data->resolution = 9;
 235                 data->sample_time = HZ / 4;
 236                 break;
 237         case max6626:
 238                 data->resolution = 12;
 239                 data->resolution_limits = 9;
 240                 data->sample_time = HZ / 4;
 241                 break;
 242         case tcn75:
 243                 data->resolution = 9;
 244                 data->sample_time = HZ / 8;
 245                 break;
 246         case mcp980x:
 247                 data->resolution_limits = 9;
 248                 /* fall through */
 249         case tmp100:
 250         case tmp101:
 251                 set_mask |= 3 << 5;             /* 12-bit mode */
 252                 data->resolution = 12;
 253                 data->sample_time = HZ;
 254                 clr_mask |= 1 << 7;             /* not one-shot mode */
 255                 break;
 256         case tmp105:
 257         case tmp175:
 258         case tmp275:
 259         case tmp75:
 260                 set_mask |= 3 << 5;             /* 12-bit mode */
 261                 clr_mask |= 1 << 7;             /* not one-shot mode */
 262                 data->resolution = 12;
 263                 data->sample_time = HZ / 2;
 264                 break;
 265         }
 266
 267         /* configure as specified */
 268         status = lm75_read_value(client, LM75_REG_CONF);
 269         if (status < 0) {
 270                 dev_dbg(&client->dev, "Can't read config? %d\n", status);
 271                 return status;
 272         }
 273         data->orig_conf = status;
 274         new = status & ~clr_mask;
 275         new |= set_mask;
 276         if (status != new)
 277                 lm75_write_value(client, LM75_REG_CONF, new);
 278         dev_dbg(&client->dev, "Config %02x\n", new);
 279
 280         /* Register sysfs hooks */
 281         status = sysfs_create_group(&client->dev.kobj, &lm75_group);
 282         if (status)
 283                 return status;
 284
 285         data->hwmon_dev = hwmon_device_register(&client->dev);
 286         if (IS_ERR(data->hwmon_dev)) {
 287                 status = PTR_ERR(data->hwmon_dev);
 288                 goto exit_remove;
 289         }
 290
 291         data->tz = thermal_zone_of_sensor_register(&client->dev,
 292                                                    0,
 293                                                    &client->dev,
 294                                                    lm75_read_temp, NULL);
 295         if (IS_ERR(data->tz))
 296                 data->tz = NULL;
 297
 298         dev_info(&client->dev, "%s: sensor '%s'\n",
 299                  dev_name(data->hwmon_dev), client->name);
 300
 301         return 0;
 302
 303 exit_remove:
 304         sysfs_remove_group(&client->dev.kobj, &lm75_group);
 305         return status;
 306 }
 307
 308 static int lm75_remove(struct i2c_client *client)
 309 {
 310         struct lm75_data *data = i2c_get_clientdata(client);
 311
 312         thermal_zone_of_sensor_unregister(&client->dev, data->tz);
 313         hwmon_device_unregister(data->hwmon_dev);
 314         sysfs_remove_group(&client->dev.kobj, &lm75_group);
 315         lm75_write_value(client, LM75_REG_CONF, data->orig_conf);
 316         return 0;
 317 }
 318
 319 static const struct i2c_device_id lm75_ids[] = {
 320         { "adt75", adt75, },
 321         { "ds1775", ds1775, },
 322         { "ds75", ds75, },
 323         { "ds7505", ds7505, },
 324         { "lm75", lm75, },
 325         { "lm75a", lm75a, },
 326         { "max6625", max6625, },
 327         { "max6626", max6626, },
 328         { "mcp980x", mcp980x, },
 329         { "stds75", stds75, },
 330         { "tcn75", tcn75, },
 331         { "tmp100", tmp100, },
 332         { "tmp101", tmp101, },
 333         { "tmp105", tmp105, },
 334         { "tmp175", tmp175, },
 335         { "tmp275", tmp275, },
 336         { "tmp75", tmp75, },
 337         { /* LIST END */ }
 338 };
 339 MODULE_DEVICE_TABLE(i2c, lm75_ids);
 340
 341 #define LM75A_ID 0xA1
 342
 343 /* Return 0 if detection is successful, -ENODEV otherwise */
 344 static int lm75_detect(struct i2c_client *new_client,
 345                        struct i2c_board_info *info)
 346 {
 347         struct i2c_adapter *adapter = new_client->adapter;
 348         int i;
 349         int conf, hyst, os;
 350         bool is_lm75a = 0;
 351
 352         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 353                                      I2C_FUNC_SMBUS_WORD_DATA))
 354                 return -ENODEV;
 355
 356         /*
 357          * Now, we do the remaining detection. There is no identification-
 358          * dedicated register so we have to rely on several tricks:
 359          * unused bits, registers cycling over 8-address boundaries,
 360          * addresses 0x04-0x07 returning the last read value.
 361          * The cycling+unused addresses combination is not tested,
 362          * since it would significantly slow the detection down and would
 363          * hardly add any value.
 364          *
 365          * The National Semiconductor LM75A is different than earlier
 366          * LM75s.  It has an ID byte of 0xaX (where X is the chip
 367          * revision, with 1 being the only revision in existence) in
 368          * register 7, and unused registers return 0xff rather than the
 369          * last read value.
 370          *
 371          * Note that this function only detects the original National
 372          * Semiconductor LM75 and the LM75A. Clones from other vendors
 373          * aren't detected, on purpose, because they are typically never
 374          * found on PC hardware. They are found on embedded designs where
 375          * they can be instantiated explicitly so detection is not needed.
 376          * The absence of identification registers on all these clones
 377          * would make their exhaustive detection very difficult and weak,
 378          * and odds are that the driver would bind to unsupported devices.
 379          */
 380
 381         /* Unused bits */
 382         conf = i2c_smbus_read_byte_data(new_client, 1);
 383         if (conf & 0xe0)
 384                 return -ENODEV;
 385
 386         /* First check for LM75A */
 387         if (i2c_smbus_read_byte_data(new_client, 7) == LM75A_ID) {
 388                 /* LM75A returns 0xff on unused registers so
 389                    just to be sure we check for that too. */
 390                 if (i2c_smbus_read_byte_data(new_client, 4) != 0xff
 391                  || i2c_smbus_read_byte_data(new_client, 5) != 0xff
 392                  || i2c_smbus_read_byte_data(new_client, 6) != 0xff)
 393                         return -ENODEV;
 394                 is_lm75a = 1;
 395                 hyst = i2c_smbus_read_byte_data(new_client, 2);
 396                 os = i2c_smbus_read_byte_data(new_client, 3);
 397         } else { /* Traditional style LM75 detection */
 398                 /* Unused addresses */
 399                 hyst = i2c_smbus_read_byte_data(new_client, 2);
 400                 if (i2c_smbus_read_byte_data(new_client, 4) != hyst
 401                  || i2c_smbus_read_byte_data(new_client, 5) != hyst
 402                  || i2c_smbus_read_byte_data(new_client, 6) != hyst
 403                  || i2c_smbus_read_byte_data(new_client, 7) != hyst)
 404                         return -ENODEV;
 405                 os = i2c_smbus_read_byte_data(new_client, 3);
 406                 if (i2c_smbus_read_byte_data(new_client, 4) != os
 407                  || i2c_smbus_read_byte_data(new_client, 5) != os
 408                  || i2c_smbus_read_byte_data(new_client, 6) != os
 409                  || i2c_smbus_read_byte_data(new_client, 7) != os)
 410                         return -ENODEV;
 411         }
 412
 413         /* Addresses cycling */
 414         for (i = 8; i <= 248; i += 40) {
 415                 if (i2c_smbus_read_byte_data(new_client, i + 1) != conf
 416                  || i2c_smbus_read_byte_data(new_client, i + 2) != hyst
 417                  || i2c_smbus_read_byte_data(new_client, i + 3) != os)
 418                         return -ENODEV;
 419                 if (is_lm75a && i2c_smbus_read_byte_data(new_client, i + 7)
 420                                 != LM75A_ID)
 421                         return -ENODEV;
 422         }
 423
 424         strlcpy(info->type, is_lm75a ? "lm75a" : "lm75", I2C_NAME_SIZE);
 425
 426         return 0;
 427 }
 428
 429 #ifdef CONFIG_PM
 430 static int lm75_suspend(struct device *dev)
 431 {
 432         int status;
 433         struct i2c_client *client = to_i2c_client(dev);
 434         status = lm75_read_value(client, LM75_REG_CONF);
 435         if (status < 0) {
 436                 dev_dbg(&client->dev, "Can't read config? %d\n", status);
 437                 return status;
 438         }
 439         status = status | LM75_SHUTDOWN;
 440         lm75_write_value(client, LM75_REG_CONF, status);
 441         return 0;
 442 }
 443
 444 static int lm75_resume(struct device *dev)
 445 {
 446         int status;
 447         struct i2c_client *client = to_i2c_client(dev);
 448         status = lm75_read_value(client, LM75_REG_CONF);
 449         if (status < 0) {
 450                 dev_dbg(&client->dev, "Can't read config? %d\n", status);
 451                 return status;
 452         }
 453         status = status & ~LM75_SHUTDOWN;
 454         lm75_write_value(client, LM75_REG_CONF, status);
 455         return 0;
 456 }
 457
 458 static const struct dev_pm_ops lm75_dev_pm_ops = {
 459         .suspend        = lm75_suspend,
 460         .resume         = lm75_resume,
 461 };
 462 #define LM75_DEV_PM_OPS (&lm75_dev_pm_ops)
 463 #else
 464 #define LM75_DEV_PM_OPS NULL
 465 #endif /* CONFIG_PM */
 466
 467 static struct i2c_driver lm75_driver = {
 468         .class          = I2C_CLASS_HWMON,
 469         .driver = {
 470                 .name   = "lm75",
 471                 .pm     = LM75_DEV_PM_OPS,
 472         },
 473         .probe          = lm75_probe,
 474         .remove         = lm75_remove,
 475         .id_table       = lm75_ids,
 476         .detect         = lm75_detect,
 477         .address_list   = normal_i2c,
 478 };
 479
 480 /*-----------------------------------------------------------------------*/
 481
 482 /* register access */
 483
 484 /*
 485  * All registers are word-sized, except for the configuration register.
 486  * LM75 uses a high-byte first convention, which is exactly opposite to
 487  * the SMBus standard.
 488  */
 489 static int lm75_read_value(struct i2c_client *client, u8 reg)
 490 {
 491         if (reg == LM75_REG_CONF)
 492                 return i2c_smbus_read_byte_data(client, reg);
 493         else
 494                 return i2c_smbus_read_word_swapped(client, reg);
 495 }
 496
 497 static int lm75_write_value(struct i2c_client *client, u8 reg, u16 value)
 498 {
 499         if (reg == LM75_REG_CONF)
 500                 return i2c_smbus_write_byte_data(client, reg, value);
 501         else
 502                 return i2c_smbus_write_word_swapped(client, reg, value);
 503 }
 504
 505 static struct lm75_data *lm75_update_device(struct device *dev)
 506 {
 507         struct i2c_client *client = to_i2c_client(dev);
 508         struct lm75_data *data = i2c_get_clientdata(client);
 509         struct lm75_data *ret = data;
 510
 511         mutex_lock(&data->update_lock);
 512
 513         if (time_after(jiffies, data->last_updated + data->sample_time)
 514             || !data->valid) {
 515                 int i;
 516                 dev_dbg(&client->dev, "Starting lm75 update\n");
 517
 518                 for (i = 0; i < ARRAY_SIZE(data->temp); i++) {
 519                         int status;
 520
 521                         status = lm75_read_value(client, LM75_REG_TEMP[i]);
 522                         if (unlikely(status < 0)) {
 523                                 dev_dbg(dev,
 524                                         "LM75: Failed to read value: reg %d, error %d\n",
 525                                         LM75_REG_TEMP[i], status);
 526                                 ret = ERR_PTR(status);
 527                                 data->valid = 0;
 528                                 goto abort;
 529                         }
 530                         data->temp[i] = status;
 531                 }
 532                 data->last_updated = jiffies;
 533                 data->valid = 1;
 534         }
 535
 536 abort:
 537         mutex_unlock(&data->update_lock);
 538         return ret;
 539 }
 540
 541 module_i2c_driver(lm75_driver);
 542
 543 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>");
 544 MODULE_DESCRIPTION("LM75 driver");
 545 MODULE_LICENSE("GPL");