drivers/hwmon/adm1021.c

   1 /*
   2  * adm1021.c - Part of lm_sensors, Linux kernel modules for hardware
   3  *             monitoring
   4  * Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl> and
   5  *                           Philip Edelbrock <phil@netroedge.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <linux/module.h>
  23 #include <linux/init.h>
  24 #include <linux/slab.h>
  25 #include <linux/jiffies.h>
  26 #include <linux/i2c.h>
  27 #include <linux/hwmon.h>
  28 #include <linux/hwmon-sysfs.h>
  29 #include <linux/err.h>
  30 #include <linux/mutex.h>
  31
  32
  33 /* Addresses to scan */
  34 static const unsigned short normal_i2c[] = {
  35         0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END };
  36
  37 enum chips {
  38         adm1021, adm1023, max1617, max1617a, thmc10, lm84, gl523sm, mc1066 };
  39
  40 /* adm1021 constants specified below */
  41
  42 /* The adm1021 registers */
  43 /* Read-only */
  44 /* For nr in 0-1 */
  45 #define ADM1021_REG_TEMP(nr)            (nr)
  46 #define ADM1021_REG_STATUS              0x02
  47 /* 0x41 = AD, 0x49 = TI, 0x4D = Maxim, 0x23 = Genesys , 0x54 = Onsemi */
  48 #define ADM1021_REG_MAN_ID              0xFE
  49 /* ADM1021 = 0x0X, ADM1023 = 0x3X */
  50 #define ADM1021_REG_DEV_ID              0xFF
  51 /* These use different addresses for reading/writing */
  52 #define ADM1021_REG_CONFIG_R            0x03
  53 #define ADM1021_REG_CONFIG_W            0x09
  54 #define ADM1021_REG_CONV_RATE_R         0x04
  55 #define ADM1021_REG_CONV_RATE_W         0x0A
  56 /* These are for the ADM1023's additional precision on the remote temp sensor */
  57 #define ADM1023_REG_REM_TEMP_PREC       0x10
  58 #define ADM1023_REG_REM_OFFSET          0x11
  59 #define ADM1023_REG_REM_OFFSET_PREC     0x12
  60 #define ADM1023_REG_REM_TOS_PREC        0x13
  61 #define ADM1023_REG_REM_THYST_PREC      0x14
  62 /* limits */
  63 /* For nr in 0-1 */
  64 #define ADM1021_REG_TOS_R(nr)           (0x05 + 2 * (nr))
  65 #define ADM1021_REG_TOS_W(nr)           (0x0B + 2 * (nr))
  66 #define ADM1021_REG_THYST_R(nr)         (0x06 + 2 * (nr))
  67 #define ADM1021_REG_THYST_W(nr)         (0x0C + 2 * (nr))
  68 /* write-only */
  69 #define ADM1021_REG_ONESHOT             0x0F
  70
  71 /* Initial values */
  72
  73 /*
  74  * Note: Even though I left the low and high limits named os and hyst,
  75  * they don't quite work like a thermostat the way the LM75 does.  I.e.,
  76  * a lower temp than THYST actually triggers an alarm instead of
  77  * clearing it.  Weird, ey?   --Phil
  78  */
  79
  80 /* Each client has this additional data */
  81 struct adm1021_data {
  82         struct device *hwmon_dev;
  83         enum chips type;
  84
  85         struct mutex update_lock;
  86         char valid;             /* !=0 if following fields are valid */
  87         char low_power;         /* !=0 if device in low power mode */
  88         unsigned long last_updated;     /* In jiffies */
  89
  90         int temp_max[2];                /* Register values */
  91         int temp_min[2];
  92         int temp[2];
  93         u8 alarms;
  94         /* Special values for ADM1023 only */
  95         u8 remote_temp_offset;
  96         u8 remote_temp_offset_prec;
  97 };
  98
  99 static int adm1021_probe(struct i2c_client *client,
 100                          const struct i2c_device_id *id);
 101 static int adm1021_detect(struct i2c_client *client,
 102                           struct i2c_board_info *info);
 103 static void adm1021_init_client(struct i2c_client *client);
 104 static int adm1021_remove(struct i2c_client *client);
 105 static struct adm1021_data *adm1021_update_device(struct device *dev);
 106
 107 /* (amalysh) read only mode, otherwise any limit's writing confuse BIOS */
 108 static bool read_only;
 109
 110
 111 static const struct i2c_device_id adm1021_id[] = {
 112         { "adm1021", adm1021 },
 113         { "adm1023", adm1023 },
 114         { "max1617", max1617 },
 115         { "max1617a", max1617a },
 116         { "thmc10", thmc10 },
 117         { "lm84", lm84 },
 118         { "gl523sm", gl523sm },
 119         { "mc1066", mc1066 },
 120         { }
 121 };
 122 MODULE_DEVICE_TABLE(i2c, adm1021_id);
 123
 124 /* This is the driver that will be inserted */
 125 static struct i2c_driver adm1021_driver = {
 126         .class          = I2C_CLASS_HWMON,
 127         .driver = {
 128                 .name   = "adm1021",
 129         },
 130         .probe          = adm1021_probe,
 131         .remove         = adm1021_remove,
 132         .id_table       = adm1021_id,
 133         .detect         = adm1021_detect,
 134         .address_list   = normal_i2c,
 135 };
 136
 137 static ssize_t show_temp(struct device *dev,
 138                          struct device_attribute *devattr, char *buf)
 139 {
 140         int index = to_sensor_dev_attr(devattr)->index;
 141         struct adm1021_data *data = adm1021_update_device(dev);
 142
 143         return sprintf(buf, "%d\n", data->temp[index]);
 144 }
 145
 146 static ssize_t show_temp_max(struct device *dev,
 147                              struct device_attribute *devattr, char *buf)
 148 {
 149         int index = to_sensor_dev_attr(devattr)->index;
 150         struct adm1021_data *data = adm1021_update_device(dev);
 151
 152         return sprintf(buf, "%d\n", data->temp_max[index]);
 153 }
 154
 155 static ssize_t show_temp_min(struct device *dev,
 156                              struct device_attribute *devattr, char *buf)
 157 {
 158         int index = to_sensor_dev_attr(devattr)->index;
 159         struct adm1021_data *data = adm1021_update_device(dev);
 160
 161         return sprintf(buf, "%d\n", data->temp_min[index]);
 162 }
 163
 164 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
 165                           char *buf)
 166 {
 167         int index = to_sensor_dev_attr(attr)->index;
 168         struct adm1021_data *data = adm1021_update_device(dev);
 169         return sprintf(buf, "%u\n", (data->alarms >> index) & 1);
 170 }
 171
 172 static ssize_t show_alarms(struct device *dev,
 173                            struct device_attribute *attr,
 174                            char *buf)
 175 {
 176         struct adm1021_data *data = adm1021_update_device(dev);
 177         return sprintf(buf, "%u\n", data->alarms);
 178 }
 179
 180 static ssize_t set_temp_max(struct device *dev,
 181                             struct device_attribute *devattr,
 182                             const char *buf, size_t count)
 183 {
 184         int index = to_sensor_dev_attr(devattr)->index;
 185         struct i2c_client *client = to_i2c_client(dev);
 186         struct adm1021_data *data = i2c_get_clientdata(client);
 187         long temp;
 188         int reg_val, err;
 189
 190         err = kstrtol(buf, 10, &temp);
 191         if (err)
 192                 return err;
 193         temp /= 1000;
 194
 195         mutex_lock(&data->update_lock);
 196         reg_val = clamp_val(temp, -128, 127);
 197         data->temp_max[index] = reg_val * 1000;
 198         if (!read_only)
 199                 i2c_smbus_write_byte_data(client, ADM1021_REG_TOS_W(index),
 200                                           reg_val);
 201         mutex_unlock(&data->update_lock);
 202
 203         return count;
 204 }
 205
 206 static ssize_t set_temp_min(struct device *dev,
 207                             struct device_attribute *devattr,
 208                             const char *buf, size_t count)
 209 {
 210         int index = to_sensor_dev_attr(devattr)->index;
 211         struct i2c_client *client = to_i2c_client(dev);
 212         struct adm1021_data *data = i2c_get_clientdata(client);
 213         long temp;
 214         int reg_val, err;
 215
 216         err = kstrtol(buf, 10, &temp);
 217         if (err)
 218                 return err;
 219         temp /= 1000;
 220
 221         mutex_lock(&data->update_lock);
 222         reg_val = clamp_val(temp, -128, 127);
 223         data->temp_min[index] = reg_val * 1000;
 224         if (!read_only)
 225                 i2c_smbus_write_byte_data(client, ADM1021_REG_THYST_W(index),
 226                                           reg_val);
 227         mutex_unlock(&data->update_lock);
 228
 229         return count;
 230 }
 231
 232 static ssize_t show_low_power(struct device *dev,
 233                               struct device_attribute *devattr, char *buf)
 234 {
 235         struct adm1021_data *data = adm1021_update_device(dev);
 236         return sprintf(buf, "%d\n", data->low_power);
 237 }
 238
 239 static ssize_t set_low_power(struct device *dev,
 240                              struct device_attribute *devattr,
 241                              const char *buf, size_t count)
 242 {
 243         struct i2c_client *client = to_i2c_client(dev);
 244         struct adm1021_data *data = i2c_get_clientdata(client);
 245         char low_power;
 246         unsigned long val;
 247         int err;
 248
 249         err = kstrtoul(buf, 10, &val);
 250         if (err)
 251                 return err;
 252         low_power = val != 0;
 253
 254         mutex_lock(&data->update_lock);
 255         if (low_power != data->low_power) {
 256                 int config = i2c_smbus_read_byte_data(
 257                         client, ADM1021_REG_CONFIG_R);
 258                 data->low_power = low_power;
 259                 i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W,
 260                         (config & 0xBF) | (low_power << 6));
 261         }
 262         mutex_unlock(&data->update_lock);
 263
 264         return count;
 265 }
 266
 267
 268 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 269 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max,
 270                           set_temp_max, 0);
 271 static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_min,
 272                           set_temp_min, 0);
 273 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
 274 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_max,
 275                           set_temp_max, 1);
 276 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_min,
 277                           set_temp_min, 1);
 278 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
 279 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 5);
 280 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
 281 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
 282 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
 283
 284 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 285 static DEVICE_ATTR(low_power, S_IWUSR | S_IRUGO, show_low_power, set_low_power);
 286
 287 static struct attribute *adm1021_attributes[] = {
 288         &sensor_dev_attr_temp1_max.dev_attr.attr,
 289         &sensor_dev_attr_temp1_min.dev_attr.attr,
 290         &sensor_dev_attr_temp1_input.dev_attr.attr,
 291         &sensor_dev_attr_temp2_max.dev_attr.attr,
 292         &sensor_dev_attr_temp2_min.dev_attr.attr,
 293         &sensor_dev_attr_temp2_input.dev_attr.attr,
 294         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
 295         &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
 296         &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
 297         &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
 298         &sensor_dev_attr_temp2_fault.dev_attr.attr,
 299         &dev_attr_alarms.attr,
 300         &dev_attr_low_power.attr,
 301         NULL
 302 };
 303
 304 static const struct attribute_group adm1021_group = {
 305         .attrs = adm1021_attributes,
 306 };
 307
 308 /* Return 0 if detection is successful, -ENODEV otherwise */
 309 static int adm1021_detect(struct i2c_client *client,
 310                           struct i2c_board_info *info)
 311 {
 312         struct i2c_adapter *adapter = client->adapter;
 313         const char *type_name;
 314         int conv_rate, status, config, man_id, dev_id;
 315
 316         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
 317                 pr_debug("detect failed, smbus byte data not supported!\n");
 318                 return -ENODEV;
 319         }
 320
 321         status = i2c_smbus_read_byte_data(client, ADM1021_REG_STATUS);
 322         conv_rate = i2c_smbus_read_byte_data(client,
 323                                              ADM1021_REG_CONV_RATE_R);
 324         config = i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R);
 325
 326         /* Check unused bits */
 327         if ((status & 0x03) || (config & 0x3F) || (conv_rate & 0xF8)) {
 328                 pr_debug("detect failed, chip not detected!\n");
 329                 return -ENODEV;
 330         }
 331
 332         /* Determine the chip type. */
 333         man_id = i2c_smbus_read_byte_data(client, ADM1021_REG_MAN_ID);
 334         dev_id = i2c_smbus_read_byte_data(client, ADM1021_REG_DEV_ID);
 335
 336         if (man_id < 0 || dev_id < 0)
 337                 return -ENODEV;
 338
 339         if (man_id == 0x4d && dev_id == 0x01)
 340                 type_name = "max1617a";
 341         else if (man_id == 0x41) {
 342                 if ((dev_id & 0xF0) == 0x30)
 343                         type_name = "adm1023";
 344                 else if ((dev_id & 0xF0) == 0x00)
 345                         type_name = "adm1021";
 346                 else
 347                         return -ENODEV;
 348         } else if (man_id == 0x49)
 349                 type_name = "thmc10";
 350         else if (man_id == 0x23)
 351                 type_name = "gl523sm";
 352         else if (man_id == 0x54)
 353                 type_name = "mc1066";
 354         else {
 355                 int lte, rte, lhi, rhi, llo, rlo;
 356
 357                 /* extra checks for LM84 and MAX1617 to avoid misdetections */
 358
 359                 llo = i2c_smbus_read_byte_data(client, ADM1021_REG_THYST_R(0));
 360                 rlo = i2c_smbus_read_byte_data(client, ADM1021_REG_THYST_R(1));
 361
 362                 /* fail if any of the additional register reads failed */
 363                 if (llo < 0 || rlo < 0)
 364                         return -ENODEV;
 365
 366                 lte = i2c_smbus_read_byte_data(client, ADM1021_REG_TEMP(0));
 367                 rte = i2c_smbus_read_byte_data(client, ADM1021_REG_TEMP(1));
 368                 lhi = i2c_smbus_read_byte_data(client, ADM1021_REG_TOS_R(0));
 369                 rhi = i2c_smbus_read_byte_data(client, ADM1021_REG_TOS_R(1));
 370
 371                 /*
 372                  * Fail for negative temperatures and negative high limits.
 373                  * This check also catches read errors on the tested registers.
 374                  */
 375                 if ((s8)lte < 0 || (s8)rte < 0 || (s8)lhi < 0 || (s8)rhi < 0)
 376                         return -ENODEV;
 377
 378                 /* fail if all registers hold the same value */
 379                 if (lte == rte && lte == lhi && lte == rhi && lte == llo
 380                     && lte == rlo)
 381                         return -ENODEV;
 382
 383                 /*
 384                  * LM84 Mfr ID is in a different place,
 385                  * and it has more unused bits.
 386                  */
 387                 if (conv_rate == 0x00
 388                     && (config & 0x7F) == 0x00
 389                     && (status & 0xAB) == 0x00) {
 390                         type_name = "lm84";
 391                 } else {
 392                         /* fail if low limits are larger than high limits */
 393                         if ((s8)llo > lhi || (s8)rlo > rhi)
 394                                 return -ENODEV;
 395                         type_name = "max1617";
 396                 }
 397         }
 398
 399         pr_debug("Detected chip %s at adapter %d, address 0x%02x.\n",
 400                  type_name, i2c_adapter_id(adapter), client->addr);
 401         strlcpy(info->type, type_name, I2C_NAME_SIZE);
 402
 403         return 0;
 404 }
 405
 406 static int adm1021_probe(struct i2c_client *client,
 407                          const struct i2c_device_id *id)
 408 {
 409         struct adm1021_data *data;
 410         int err;
 411
 412         data = devm_kzalloc(&client->dev, sizeof(struct adm1021_data),
 413                             GFP_KERNEL);
 414         if (!data)
 415                 return -ENOMEM;
 416
 417         i2c_set_clientdata(client, data);
 418         data->type = id->driver_data;
 419         mutex_init(&data->update_lock);
 420
 421         /* Initialize the ADM1021 chip */
 422         if (data->type != lm84 && !read_only)
 423                 adm1021_init_client(client);
 424
 425         /* Register sysfs hooks */
 426         err = sysfs_create_group(&client->dev.kobj, &adm1021_group);
 427         if (err)
 428                 return err;
 429
 430         data->hwmon_dev = hwmon_device_register(&client->dev);
 431         if (IS_ERR(data->hwmon_dev)) {
 432                 err = PTR_ERR(data->hwmon_dev);
 433                 goto error;
 434         }
 435
 436         return 0;
 437
 438 error:
 439         sysfs_remove_group(&client->dev.kobj, &adm1021_group);
 440         return err;
 441 }
 442
 443 static void adm1021_init_client(struct i2c_client *client)
 444 {
 445         /* Enable ADC and disable suspend mode */
 446         i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W,
 447                 i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R) & 0xBF);
 448         /* Set Conversion rate to 1/sec (this can be tinkered with) */
 449         i2c_smbus_write_byte_data(client, ADM1021_REG_CONV_RATE_W, 0x04);
 450 }
 451
 452 static int adm1021_remove(struct i2c_client *client)
 453 {
 454         struct adm1021_data *data = i2c_get_clientdata(client);
 455
 456         hwmon_device_unregister(data->hwmon_dev);
 457         sysfs_remove_group(&client->dev.kobj, &adm1021_group);
 458
 459         return 0;
 460 }
 461
 462 static struct adm1021_data *adm1021_update_device(struct device *dev)
 463 {
 464         struct i2c_client *client = to_i2c_client(dev);
 465         struct adm1021_data *data = i2c_get_clientdata(client);
 466
 467         mutex_lock(&data->update_lock);
 468
 469         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 470             || !data->valid) {
 471                 int i;
 472
 473                 dev_dbg(&client->dev, "Starting adm1021 update\n");
 474
 475                 for (i = 0; i < 2; i++) {
 476                         data->temp[i] = 1000 *
 477                                 (s8) i2c_smbus_read_byte_data(
 478                                         client, ADM1021_REG_TEMP(i));
 479                         data->temp_max[i] = 1000 *
 480                                 (s8) i2c_smbus_read_byte_data(
 481                                         client, ADM1021_REG_TOS_R(i));
 482                         data->temp_min[i] = 1000 *
 483                                 (s8) i2c_smbus_read_byte_data(
 484                                         client, ADM1021_REG_THYST_R(i));
 485                 }
 486                 data->alarms = i2c_smbus_read_byte_data(client,
 487                                                 ADM1021_REG_STATUS) & 0x7c;
 488                 if (data->type == adm1023) {
 489                         /*
 490                          * The ADM1023 provides 3 extra bits of precision for
 491                          * the remote sensor in extra registers.
 492                          */
 493                         data->temp[1] += 125 * (i2c_smbus_read_byte_data(
 494                                 client, ADM1023_REG_REM_TEMP_PREC) >> 5);
 495                         data->temp_max[1] += 125 * (i2c_smbus_read_byte_data(
 496                                 client, ADM1023_REG_REM_TOS_PREC) >> 5);
 497                         data->temp_min[1] += 125 * (i2c_smbus_read_byte_data(
 498                                 client, ADM1023_REG_REM_THYST_PREC) >> 5);
 499                         data->remote_temp_offset =
 500                                 i2c_smbus_read_byte_data(client,
 501                                                 ADM1023_REG_REM_OFFSET);
 502                         data->remote_temp_offset_prec =
 503                                 i2c_smbus_read_byte_data(client,
 504                                                 ADM1023_REG_REM_OFFSET_PREC);
 505                 }
 506                 data->last_updated = jiffies;
 507                 data->valid = 1;
 508         }
 509
 510         mutex_unlock(&data->update_lock);
 511
 512         return data;
 513 }
 514
 515 module_i2c_driver(adm1021_driver);
 516
 517 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
 518                 "Philip Edelbrock <phil@netroedge.com>");
 519 MODULE_DESCRIPTION("adm1021 driver");
 520 MODULE_LICENSE("GPL");
 521
 522 module_param(read_only, bool, 0);
 523 MODULE_PARM_DESC(read_only, "Don't set any values, read only mode");