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 unsigned short normal_i2c[] = { 0x18, 0x19, 0x1a,
  35                                         0x29, 0x2a, 0x2b,
  36                                         0x4c, 0x4d, 0x4e,
  37                                         I2C_CLIENT_END };
  38
  39 /* Insmod parameters */
  40 I2C_CLIENT_INSMOD_8(adm1021, adm1023, max1617, max1617a, thmc10, lm84, gl523sm,
  41                         mc1066);
  42
  43 /* adm1021 constants specified below */
  44
  45 /* The adm1021 registers */
  46 /* Read-only */
  47 /* For nr in 0-1 */
  48 #define ADM1021_REG_TEMP(nr)            (nr)
  49 #define ADM1021_REG_STATUS              0x02
  50 /* 0x41 = AD, 0x49 = TI, 0x4D = Maxim, 0x23 = Genesys , 0x54 = Onsemi */
  51 #define ADM1021_REG_MAN_ID              0xFE
  52 /* ADM1021 = 0x0X, ADM1023 = 0x3X */
  53 #define ADM1021_REG_DEV_ID              0xFF
  54 /* These use different addresses for reading/writing */
  55 #define ADM1021_REG_CONFIG_R            0x03
  56 #define ADM1021_REG_CONFIG_W            0x09
  57 #define ADM1021_REG_CONV_RATE_R         0x04
  58 #define ADM1021_REG_CONV_RATE_W         0x0A
  59 /* These are for the ADM1023's additional precision on the remote temp sensor */
  60 #define ADM1023_REG_REM_TEMP_PREC       0x10
  61 #define ADM1023_REG_REM_OFFSET          0x11
  62 #define ADM1023_REG_REM_OFFSET_PREC     0x12
  63 #define ADM1023_REG_REM_TOS_PREC        0x13
  64 #define ADM1023_REG_REM_THYST_PREC      0x14
  65 /* limits */
  66 /* For nr in 0-1 */
  67 #define ADM1021_REG_TOS_R(nr)           (0x05 + 2 * (nr))
  68 #define ADM1021_REG_TOS_W(nr)           (0x0B + 2 * (nr))
  69 #define ADM1021_REG_THYST_R(nr)         (0x06 + 2 * (nr))
  70 #define ADM1021_REG_THYST_W(nr)         (0x0C + 2 * (nr))
  71 /* write-only */
  72 #define ADM1021_REG_ONESHOT             0x0F
  73
  74 /* Initial values */
  75
  76 /* Note: Even though I left the low and high limits named os and hyst,
  77 they don't quite work like a thermostat the way the LM75 does.  I.e.,
  78 a lower temp than THYST actually triggers an alarm instead of
  79 clearing it.  Weird, ey?   --Phil  */
  80
  81 /* Each client has this additional data */
  82 struct adm1021_data {
  83         struct i2c_client client;
  84         struct device *hwmon_dev;
  85         enum chips type;
  86
  87         struct mutex update_lock;
  88         char valid;             /* !=0 if following fields are valid */
  89         unsigned long last_updated;     /* In jiffies */
  90
  91         s8 temp_max[2];         /* Register values */
  92         s8 temp_min[2];
  93         s8 temp[2];
  94         u8 alarms;
  95         /* Special values for ADM1023 only */
  96         u8 remote_temp_prec;
  97         u8 remote_temp_os_prec;
  98         u8 remote_temp_hyst_prec;
  99         u8 remote_temp_offset;
 100         u8 remote_temp_offset_prec;
 101 };
 102
 103 static int adm1021_attach_adapter(struct i2c_adapter *adapter);
 104 static int adm1021_detect(struct i2c_adapter *adapter, int address, int kind);
 105 static void adm1021_init_client(struct i2c_client *client);
 106 static int adm1021_detach_client(struct i2c_client *client);
 107 static struct adm1021_data *adm1021_update_device(struct device *dev);
 108
 109 /* (amalysh) read only mode, otherwise any limit's writing confuse BIOS */
 110 static int read_only;
 111
 112
 113 /* This is the driver that will be inserted */
 114 static struct i2c_driver adm1021_driver = {
 115         .driver = {
 116                 .name   = "adm1021",
 117         },
 118         .attach_adapter = adm1021_attach_adapter,
 119         .detach_client  = adm1021_detach_client,
 120 };
 121
 122 static ssize_t show_temp(struct device *dev,
 123                          struct device_attribute *devattr, char *buf)
 124 {
 125         int index = to_sensor_dev_attr(devattr)->index;
 126         struct adm1021_data *data = adm1021_update_device(dev);
 127
 128         return sprintf(buf, "%d\n", 1000 * data->temp[index]);
 129 }
 130
 131 static ssize_t show_temp_max(struct device *dev,
 132                              struct device_attribute *devattr, char *buf)
 133 {
 134         int index = to_sensor_dev_attr(devattr)->index;
 135         struct adm1021_data *data = adm1021_update_device(dev);
 136
 137         return sprintf(buf, "%d\n", 1000 * data->temp_max[index]);
 138 }
 139
 140 static ssize_t show_temp_min(struct device *dev,
 141                              struct device_attribute *devattr, char *buf)
 142 {
 143         int index = to_sensor_dev_attr(devattr)->index;
 144         struct adm1021_data *data = adm1021_update_device(dev);
 145
 146         return sprintf(buf, "%d\n", 1000 * data->temp_min[index]);
 147 }
 148
 149 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
 150                           char *buf)
 151 {
 152         int index = to_sensor_dev_attr(attr)->index;
 153         struct adm1021_data *data = adm1021_update_device(dev);
 154         return sprintf(buf, "%u\n", (data->alarms >> index) & 1);
 155 }
 156
 157 static ssize_t show_alarms(struct device *dev,
 158                            struct device_attribute *attr,
 159                            char *buf)
 160 {
 161         struct adm1021_data *data = adm1021_update_device(dev);
 162         return sprintf(buf, "%u\n", data->alarms);
 163 }
 164
 165 static ssize_t set_temp_max(struct device *dev,
 166                             struct device_attribute *devattr,
 167                             const char *buf, size_t count)
 168 {
 169         int index = to_sensor_dev_attr(devattr)->index;
 170         struct i2c_client *client = to_i2c_client(dev);
 171         struct adm1021_data *data = i2c_get_clientdata(client);
 172         long temp = simple_strtol(buf, NULL, 10) / 1000;
 173
 174         mutex_lock(&data->update_lock);
 175         data->temp_max[index] = SENSORS_LIMIT(temp, -128, 127);
 176         if (!read_only)
 177                 i2c_smbus_write_byte_data(client, ADM1021_REG_TOS_W(index),
 178                                           data->temp_max[index]);
 179         mutex_unlock(&data->update_lock);
 180
 181         return count;
 182 }
 183
 184 static ssize_t set_temp_min(struct device *dev,
 185                             struct device_attribute *devattr,
 186                             const char *buf, size_t count)
 187 {
 188         int index = to_sensor_dev_attr(devattr)->index;
 189         struct i2c_client *client = to_i2c_client(dev);
 190         struct adm1021_data *data = i2c_get_clientdata(client);
 191         long temp = simple_strtol(buf, NULL, 10) / 1000;
 192
 193         mutex_lock(&data->update_lock);
 194         data->temp_min[index] = SENSORS_LIMIT(temp, -128, 127);
 195         if (!read_only)
 196                 i2c_smbus_write_byte_data(client, ADM1021_REG_THYST_W(index),
 197                                           data->temp_min[index]);
 198         mutex_unlock(&data->update_lock);
 199
 200         return count;
 201 }
 202
 203 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 204 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max,
 205                           set_temp_max, 0);
 206 static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_min,
 207                           set_temp_min, 0);
 208 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
 209 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_max,
 210                           set_temp_max, 1);
 211 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_min,
 212                           set_temp_min, 1);
 213 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
 214 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 5);
 215 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
 216 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
 217 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
 218
 219 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 220
 221 static int adm1021_attach_adapter(struct i2c_adapter *adapter)
 222 {
 223         if (!(adapter->class & I2C_CLASS_HWMON))
 224                 return 0;
 225         return i2c_probe(adapter, &addr_data, adm1021_detect);
 226 }
 227
 228 static struct attribute *adm1021_attributes[] = {
 229         &sensor_dev_attr_temp1_max.dev_attr.attr,
 230         &sensor_dev_attr_temp1_min.dev_attr.attr,
 231         &sensor_dev_attr_temp1_input.dev_attr.attr,
 232         &sensor_dev_attr_temp2_max.dev_attr.attr,
 233         &sensor_dev_attr_temp2_min.dev_attr.attr,
 234         &sensor_dev_attr_temp2_input.dev_attr.attr,
 235         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
 236         &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
 237         &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
 238         &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
 239         &sensor_dev_attr_temp2_fault.dev_attr.attr,
 240         &dev_attr_alarms.attr,
 241         NULL
 242 };
 243
 244 static const struct attribute_group adm1021_group = {
 245         .attrs = adm1021_attributes,
 246 };
 247
 248 static int adm1021_detect(struct i2c_adapter *adapter, int address, int kind)
 249 {
 250         int i;
 251         struct i2c_client *client;
 252         struct adm1021_data *data;
 253         int err = 0;
 254         const char *type_name = "";
 255         int conv_rate, status, config;
 256
 257         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
 258                 pr_debug("adm1021: detect failed, "
 259                          "smbus byte data not supported!\n");
 260                 goto error0;
 261         }
 262
 263         /* OK. For now, we presume we have a valid client. We now create the
 264            client structure, even though we cannot fill it completely yet.
 265            But it allows us to access adm1021 register values. */
 266
 267         if (!(data = kzalloc(sizeof(struct adm1021_data), GFP_KERNEL))) {
 268                 pr_debug("adm1021: detect failed, kzalloc failed!\n");
 269                 err = -ENOMEM;
 270                 goto error0;
 271         }
 272
 273         client = &data->client;
 274         i2c_set_clientdata(client, data);
 275         client->addr = address;
 276         client->adapter = adapter;
 277         client->driver = &adm1021_driver;
 278         status = i2c_smbus_read_byte_data(client, ADM1021_REG_STATUS);
 279         conv_rate = i2c_smbus_read_byte_data(client,
 280                                              ADM1021_REG_CONV_RATE_R);
 281         config = i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R);
 282
 283         /* Now, we do the remaining detection. */
 284         if (kind < 0) {
 285                 if ((status & 0x03) != 0x00 || (config & 0x3F) != 0x00
 286                     || (conv_rate & 0xF8) != 0x00) {
 287                         pr_debug("adm1021: detect failed, "
 288                                  "chip not detected!\n");
 289                         err = -ENODEV;
 290                         goto error1;
 291                 }
 292         }
 293
 294         /* Determine the chip type. */
 295         if (kind <= 0) {
 296                 i = i2c_smbus_read_byte_data(client, ADM1021_REG_MAN_ID);
 297                 if (i == 0x41)
 298                         if ((i2c_smbus_read_byte_data(client,
 299                                         ADM1021_REG_DEV_ID) & 0xF0) == 0x30)
 300                                 kind = adm1023;
 301                         else
 302                                 kind = adm1021;
 303                 else if (i == 0x49)
 304                         kind = thmc10;
 305                 else if (i == 0x23)
 306                         kind = gl523sm;
 307                 else if ((i == 0x4d) &&
 308                          (i2c_smbus_read_byte_data(client,
 309                                                    ADM1021_REG_DEV_ID) == 0x01))
 310                         kind = max1617a;
 311                 else if (i == 0x54)
 312                         kind = mc1066;
 313                 /* LM84 Mfr ID in a different place, and it has more unused bits */
 314                 else if (conv_rate == 0x00
 315                          && (kind == 0 /* skip extra detection */
 316                              || ((config & 0x7F) == 0x00
 317                                  && (status & 0xAB) == 0x00)))
 318                         kind = lm84;
 319                 else
 320                         kind = max1617;
 321         }
 322
 323         if (kind == max1617) {
 324                 type_name = "max1617";
 325         } else if (kind == max1617a) {
 326                 type_name = "max1617a";
 327         } else if (kind == adm1021) {
 328                 type_name = "adm1021";
 329         } else if (kind == adm1023) {
 330                 type_name = "adm1023";
 331         } else if (kind == thmc10) {
 332                 type_name = "thmc10";
 333         } else if (kind == lm84) {
 334                 type_name = "lm84";
 335         } else if (kind == gl523sm) {
 336                 type_name = "gl523sm";
 337         } else if (kind == mc1066) {
 338                 type_name = "mc1066";
 339         }
 340         pr_debug("adm1021: Detected chip %s at adapter %d, address 0x%02x.\n",
 341                  type_name, i2c_adapter_id(adapter), address);
 342
 343         /* Fill in the remaining client fields */
 344         strlcpy(client->name, type_name, I2C_NAME_SIZE);
 345         data->type = kind;
 346         mutex_init(&data->update_lock);
 347
 348         /* Tell the I2C layer a new client has arrived */
 349         if ((err = i2c_attach_client(client)))
 350                 goto error1;
 351
 352         /* Initialize the ADM1021 chip */
 353         if (kind != lm84 && !read_only)
 354                 adm1021_init_client(client);
 355
 356         /* Register sysfs hooks */
 357         if ((err = sysfs_create_group(&client->dev.kobj, &adm1021_group)))
 358                 goto error2;
 359
 360         data->hwmon_dev = hwmon_device_register(&client->dev);
 361         if (IS_ERR(data->hwmon_dev)) {
 362                 err = PTR_ERR(data->hwmon_dev);
 363                 goto error3;
 364         }
 365
 366         return 0;
 367
 368 error3:
 369         sysfs_remove_group(&client->dev.kobj, &adm1021_group);
 370 error2:
 371         i2c_detach_client(client);
 372 error1:
 373         kfree(data);
 374 error0:
 375         return err;
 376 }
 377
 378 static void adm1021_init_client(struct i2c_client *client)
 379 {
 380         /* Enable ADC and disable suspend mode */
 381         i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W,
 382                 i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R) & 0xBF);
 383         /* Set Conversion rate to 1/sec (this can be tinkered with) */
 384         i2c_smbus_write_byte_data(client, ADM1021_REG_CONV_RATE_W, 0x04);
 385 }
 386
 387 static int adm1021_detach_client(struct i2c_client *client)
 388 {
 389         struct adm1021_data *data = i2c_get_clientdata(client);
 390         int err;
 391
 392         hwmon_device_unregister(data->hwmon_dev);
 393         sysfs_remove_group(&client->dev.kobj, &adm1021_group);
 394
 395         if ((err = i2c_detach_client(client)))
 396                 return err;
 397
 398         kfree(data);
 399         return 0;
 400 }
 401
 402 static struct adm1021_data *adm1021_update_device(struct device *dev)
 403 {
 404         struct i2c_client *client = to_i2c_client(dev);
 405         struct adm1021_data *data = i2c_get_clientdata(client);
 406
 407         mutex_lock(&data->update_lock);
 408
 409         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 410             || !data->valid) {
 411                 int i;
 412
 413                 dev_dbg(&client->dev, "Starting adm1021 update\n");
 414
 415                 for (i = 0; i < 2; i++) {
 416                         data->temp[i] = i2c_smbus_read_byte_data(client,
 417                                                 ADM1021_REG_TEMP(i));
 418                         data->temp_max[i] = i2c_smbus_read_byte_data(client,
 419                                                 ADM1021_REG_TOS_R(i));
 420                         data->temp_min[i] = i2c_smbus_read_byte_data(client,
 421                                                 ADM1021_REG_THYST_R(i));
 422                 }
 423                 data->alarms = i2c_smbus_read_byte_data(client,
 424                                                 ADM1021_REG_STATUS) & 0x7c;
 425                 if (data->type == adm1023) {
 426                         data->remote_temp_prec =
 427                                 i2c_smbus_read_byte_data(client,
 428                                                 ADM1023_REG_REM_TEMP_PREC);
 429                         data->remote_temp_os_prec =
 430                                 i2c_smbus_read_byte_data(client,
 431                                                 ADM1023_REG_REM_TOS_PREC);
 432                         data->remote_temp_hyst_prec =
 433                                 i2c_smbus_read_byte_data(client,
 434                                                 ADM1023_REG_REM_THYST_PREC);
 435                         data->remote_temp_offset =
 436                                 i2c_smbus_read_byte_data(client,
 437                                                 ADM1023_REG_REM_OFFSET);
 438                         data->remote_temp_offset_prec =
 439                                 i2c_smbus_read_byte_data(client,
 440                                                 ADM1023_REG_REM_OFFSET_PREC);
 441                 }
 442                 data->last_updated = jiffies;
 443                 data->valid = 1;
 444         }
 445
 446         mutex_unlock(&data->update_lock);
 447
 448         return data;
 449 }
 450
 451 static int __init sensors_adm1021_init(void)
 452 {
 453         return i2c_add_driver(&adm1021_driver);
 454 }
 455
 456 static void __exit sensors_adm1021_exit(void)
 457 {
 458         i2c_del_driver(&adm1021_driver);
 459 }
 460
 461 MODULE_AUTHOR ("Frodo Looijaard <frodol@dds.nl> and "
 462                 "Philip Edelbrock <phil@netroedge.com>");
 463 MODULE_DESCRIPTION("adm1021 driver");
 464 MODULE_LICENSE("GPL");
 465
 466 module_param(read_only, bool, 0);
 467 MODULE_PARM_DESC(read_only, "Don't set any values, read only mode");
 468
 469 module_init(sensors_adm1021_init)
 470 module_exit(sensors_adm1021_exit)