drivers/hwmon/adm1029.c

   1 /*
   2  * adm1029.c - Part of lm_sensors, Linux kernel modules for hardware monitoring
   3  *
   4  * Copyright (C) 2006 Corentin LABBE <corentin.labbe@geomatys.fr>
   5  *
   6  * Based on LM83 Driver by Jean Delvare <khali@linux-fr.org>
   7  *
   8  * Give only processor, motherboard temperatures and fan tachs
   9  * Very rare chip please let me know if you use it
  10  *
  11  * http://www.analog.com/UploadedFiles/Data_Sheets/ADM1029.pdf
  12  *
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation version 2 of the License
  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/module.h>
  29 #include <linux/init.h>
  30 #include <linux/slab.h>
  31 #include <linux/jiffies.h>
  32 #include <linux/i2c.h>
  33 #include <linux/hwmon-sysfs.h>
  34 #include <linux/hwmon.h>
  35 #include <linux/err.h>
  36 #include <linux/mutex.h>
  37
  38 /*
  39  * Addresses to scan
  40  */
  41
  42 static const unsigned short normal_i2c[] = { 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d,
  43                                                 0x2e, 0x2f, I2C_CLIENT_END
  44 };
  45
  46 /*
  47  * The ADM1029 registers
  48  * Manufacturer ID is 0x41 for Analog Devices
  49  */
  50
  51 #define ADM1029_REG_MAN_ID                      0x0D
  52 #define ADM1029_REG_CHIP_ID                     0x0E
  53 #define ADM1029_REG_CONFIG                      0x01
  54 #define ADM1029_REG_NB_FAN_SUPPORT              0x02
  55
  56 #define ADM1029_REG_TEMP_DEVICES_INSTALLED      0x06
  57
  58 #define ADM1029_REG_LOCAL_TEMP                  0xA0
  59 #define ADM1029_REG_REMOTE1_TEMP                0xA1
  60 #define ADM1029_REG_REMOTE2_TEMP                0xA2
  61
  62 #define ADM1029_REG_LOCAL_TEMP_HIGH             0x90
  63 #define ADM1029_REG_REMOTE1_TEMP_HIGH           0x91
  64 #define ADM1029_REG_REMOTE2_TEMP_HIGH           0x92
  65
  66 #define ADM1029_REG_LOCAL_TEMP_LOW              0x98
  67 #define ADM1029_REG_REMOTE1_TEMP_LOW            0x99
  68 #define ADM1029_REG_REMOTE2_TEMP_LOW            0x9A
  69
  70 #define ADM1029_REG_FAN1                        0x70
  71 #define ADM1029_REG_FAN2                        0x71
  72
  73 #define ADM1029_REG_FAN1_MIN                    0x78
  74 #define ADM1029_REG_FAN2_MIN                    0x79
  75
  76 #define ADM1029_REG_FAN1_CONFIG                 0x68
  77 #define ADM1029_REG_FAN2_CONFIG                 0x69
  78
  79 #define TEMP_FROM_REG(val)      ((val) * 1000)
  80
  81 #define DIV_FROM_REG(val)       ( 1 << (((val) >> 6) - 1))
  82
  83 /* Registers to be checked by adm1029_update_device() */
  84 static const u8 ADM1029_REG_TEMP[] = {
  85         ADM1029_REG_LOCAL_TEMP,
  86         ADM1029_REG_REMOTE1_TEMP,
  87         ADM1029_REG_REMOTE2_TEMP,
  88         ADM1029_REG_LOCAL_TEMP_HIGH,
  89         ADM1029_REG_REMOTE1_TEMP_HIGH,
  90         ADM1029_REG_REMOTE2_TEMP_HIGH,
  91         ADM1029_REG_LOCAL_TEMP_LOW,
  92         ADM1029_REG_REMOTE1_TEMP_LOW,
  93         ADM1029_REG_REMOTE2_TEMP_LOW,
  94 };
  95
  96 static const u8 ADM1029_REG_FAN[] = {
  97         ADM1029_REG_FAN1,
  98         ADM1029_REG_FAN2,
  99         ADM1029_REG_FAN1_MIN,
 100         ADM1029_REG_FAN2_MIN,
 101 };
 102
 103 static const u8 ADM1029_REG_FAN_DIV[] = {
 104         ADM1029_REG_FAN1_CONFIG,
 105         ADM1029_REG_FAN2_CONFIG,
 106 };
 107
 108 /*
 109  * Functions declaration
 110  */
 111
 112 static int adm1029_probe(struct i2c_client *client,
 113                          const struct i2c_device_id *id);
 114 static int adm1029_detect(struct i2c_client *client,
 115                           struct i2c_board_info *info);
 116 static int adm1029_remove(struct i2c_client *client);
 117 static struct adm1029_data *adm1029_update_device(struct device *dev);
 118 static int adm1029_init_client(struct i2c_client *client);
 119
 120 /*
 121  * Driver data (common to all clients)
 122  */
 123
 124 static const struct i2c_device_id adm1029_id[] = {
 125         { "adm1029", 0 },
 126         { }
 127 };
 128 MODULE_DEVICE_TABLE(i2c, adm1029_id);
 129
 130 static struct i2c_driver adm1029_driver = {
 131         .class          = I2C_CLASS_HWMON,
 132         .driver = {
 133                 .name = "adm1029",
 134         },
 135         .probe          = adm1029_probe,
 136         .remove         = adm1029_remove,
 137         .id_table       = adm1029_id,
 138         .detect         = adm1029_detect,
 139         .address_list   = normal_i2c,
 140 };
 141
 142 /*
 143  * Client data (each client gets its own)
 144  */
 145
 146 struct adm1029_data {
 147         struct device *hwmon_dev;
 148         struct mutex update_lock;
 149         char valid;             /* zero until following fields are valid */
 150         unsigned long last_updated;     /* in jiffies */
 151
 152         /* registers values, signed for temperature, unsigned for other stuff */
 153         s8 temp[ARRAY_SIZE(ADM1029_REG_TEMP)];
 154         u8 fan[ARRAY_SIZE(ADM1029_REG_FAN)];
 155         u8 fan_div[ARRAY_SIZE(ADM1029_REG_FAN_DIV)];
 156 };
 157
 158 /*
 159  * Sysfs stuff
 160  */
 161
 162 static ssize_t
 163 show_temp(struct device *dev, struct device_attribute *devattr, char *buf)
 164 {
 165         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 166         struct adm1029_data *data = adm1029_update_device(dev);
 167         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
 168 }
 169
 170 static ssize_t
 171 show_fan(struct device *dev, struct device_attribute *devattr, char *buf)
 172 {
 173         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 174         struct adm1029_data *data = adm1029_update_device(dev);
 175         u16 val;
 176         if (data->fan[attr->index] == 0
 177             || (data->fan_div[attr->index] & 0xC0) == 0
 178             || data->fan[attr->index] == 255) {
 179                 return sprintf(buf, "0\n");
 180         }
 181
 182         val = 1880 * 120 / DIV_FROM_REG(data->fan_div[attr->index])
 183             / data->fan[attr->index];
 184         return sprintf(buf, "%d\n", val);
 185 }
 186
 187 static ssize_t
 188 show_fan_div(struct device *dev, struct device_attribute *devattr, char *buf)
 189 {
 190         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 191         struct adm1029_data *data = adm1029_update_device(dev);
 192         if ((data->fan_div[attr->index] & 0xC0) == 0)
 193                 return sprintf(buf, "0\n");
 194         return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[attr->index]));
 195 }
 196
 197 static ssize_t set_fan_div(struct device *dev,
 198             struct device_attribute *devattr, const char *buf, size_t count)
 199 {
 200         struct i2c_client *client = to_i2c_client(dev);
 201         struct adm1029_data *data = i2c_get_clientdata(client);
 202         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 203         long val = simple_strtol(buf, NULL, 10);
 204         u8 reg;
 205
 206         mutex_lock(&data->update_lock);
 207
 208         /*Read actual config */
 209         reg = i2c_smbus_read_byte_data(client,
 210                                        ADM1029_REG_FAN_DIV[attr->index]);
 211
 212         switch (val) {
 213         case 1:
 214                 val = 1;
 215                 break;
 216         case 2:
 217                 val = 2;
 218                 break;
 219         case 4:
 220                 val = 3;
 221                 break;
 222         default:
 223                 mutex_unlock(&data->update_lock);
 224                 dev_err(&client->dev, "fan_div value %ld not "
 225                         "supported. Choose one of 1, 2 or 4!\n", val);
 226                 return -EINVAL;
 227         }
 228         /* Update the value */
 229         reg = (reg & 0x3F) | (val << 6);
 230
 231         /* Write value */
 232         i2c_smbus_write_byte_data(client,
 233                                   ADM1029_REG_FAN_DIV[attr->index], reg);
 234         mutex_unlock(&data->update_lock);
 235
 236         return count;
 237 }
 238
 239 /*
 240 Access rights on sysfs, S_IRUGO stand for Is Readable by User, Group and Others
 241                         S_IWUSR stand for Is Writable by User
 242 */
 243 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 244 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
 245 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
 246
 247 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 3);
 248 static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO, show_temp, NULL, 4);
 249 static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO, show_temp, NULL, 5);
 250
 251 static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO, show_temp, NULL, 6);
 252 static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO, show_temp, NULL, 7);
 253 static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO, show_temp, NULL, 8);
 254
 255 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
 256 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1);
 257
 258 static SENSOR_DEVICE_ATTR(fan1_min, S_IRUGO, show_fan, NULL, 2);
 259 static SENSOR_DEVICE_ATTR(fan2_min, S_IRUGO, show_fan, NULL, 3);
 260
 261 static SENSOR_DEVICE_ATTR(fan1_div, S_IRUGO | S_IWUSR,
 262                           show_fan_div, set_fan_div, 0);
 263 static SENSOR_DEVICE_ATTR(fan2_div, S_IRUGO | S_IWUSR,
 264                           show_fan_div, set_fan_div, 1);
 265
 266 static struct attribute *adm1029_attributes[] = {
 267         &sensor_dev_attr_temp1_input.dev_attr.attr,
 268         &sensor_dev_attr_temp1_min.dev_attr.attr,
 269         &sensor_dev_attr_temp1_max.dev_attr.attr,
 270         &sensor_dev_attr_temp2_input.dev_attr.attr,
 271         &sensor_dev_attr_temp2_min.dev_attr.attr,
 272         &sensor_dev_attr_temp2_max.dev_attr.attr,
 273         &sensor_dev_attr_temp3_input.dev_attr.attr,
 274         &sensor_dev_attr_temp3_min.dev_attr.attr,
 275         &sensor_dev_attr_temp3_max.dev_attr.attr,
 276         &sensor_dev_attr_fan1_input.dev_attr.attr,
 277         &sensor_dev_attr_fan2_input.dev_attr.attr,
 278         &sensor_dev_attr_fan1_min.dev_attr.attr,
 279         &sensor_dev_attr_fan2_min.dev_attr.attr,
 280         &sensor_dev_attr_fan1_div.dev_attr.attr,
 281         &sensor_dev_attr_fan2_div.dev_attr.attr,
 282         NULL
 283 };
 284
 285 static const struct attribute_group adm1029_group = {
 286         .attrs = adm1029_attributes,
 287 };
 288
 289 /*
 290  * Real code
 291  */
 292
 293 /* Return 0 if detection is successful, -ENODEV otherwise */
 294 static int adm1029_detect(struct i2c_client *client,
 295                           struct i2c_board_info *info)
 296 {
 297         struct i2c_adapter *adapter = client->adapter;
 298         u8 man_id, chip_id, temp_devices_installed, nb_fan_support;
 299
 300         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 301                 return -ENODEV;
 302
 303         /* ADM1029 doesn't have CHIP ID, check just MAN ID
 304          * For better detection we check also ADM1029_TEMP_DEVICES_INSTALLED,
 305          * ADM1029_REG_NB_FAN_SUPPORT and compare it with possible values
 306          * documented
 307          */
 308
 309         man_id = i2c_smbus_read_byte_data(client, ADM1029_REG_MAN_ID);
 310         chip_id = i2c_smbus_read_byte_data(client, ADM1029_REG_CHIP_ID);
 311         temp_devices_installed = i2c_smbus_read_byte_data(client,
 312                                         ADM1029_REG_TEMP_DEVICES_INSTALLED);
 313         nb_fan_support = i2c_smbus_read_byte_data(client,
 314                                                 ADM1029_REG_NB_FAN_SUPPORT);
 315         /* 0x41 is Analog Devices */
 316         if (man_id != 0x41 || (temp_devices_installed & 0xf9) != 0x01
 317             || nb_fan_support != 0x03)
 318                 return -ENODEV;
 319
 320         if ((chip_id & 0xF0) != 0x00) {
 321                 /* There are no "official" CHIP ID, so actually
 322                  * we use Major/Minor revision for that */
 323                 pr_info("adm1029: Unknown major revision %x, "
 324                         "please let us know\n", chip_id);
 325                 return -ENODEV;
 326         }
 327
 328         strlcpy(info->type, "adm1029", I2C_NAME_SIZE);
 329
 330         return 0;
 331 }
 332
 333 static int adm1029_probe(struct i2c_client *client,
 334                          const struct i2c_device_id *id)
 335 {
 336         struct adm1029_data *data;
 337         int err;
 338
 339         data = kzalloc(sizeof(struct adm1029_data), GFP_KERNEL);
 340         if (!data) {
 341                 err = -ENOMEM;
 342                 goto exit;
 343         }
 344
 345         i2c_set_clientdata(client, data);
 346         mutex_init(&data->update_lock);
 347
 348         /*
 349          * Initialize the ADM1029 chip
 350          * Check config register
 351          */
 352         if (adm1029_init_client(client) == 0) {
 353                 err = -ENODEV;
 354                 goto exit_free;
 355         }
 356
 357         /* Register sysfs hooks */
 358         if ((err = sysfs_create_group(&client->dev.kobj, &adm1029_group)))
 359                 goto exit_free;
 360
 361         data->hwmon_dev = hwmon_device_register(&client->dev);
 362         if (IS_ERR(data->hwmon_dev)) {
 363                 err = PTR_ERR(data->hwmon_dev);
 364                 goto exit_remove_files;
 365         }
 366
 367         return 0;
 368
 369  exit_remove_files:
 370         sysfs_remove_group(&client->dev.kobj, &adm1029_group);
 371  exit_free:
 372         kfree(data);
 373  exit:
 374         return err;
 375 }
 376
 377 static int adm1029_init_client(struct i2c_client *client)
 378 {
 379         u8 config;
 380         config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
 381         if ((config & 0x10) == 0) {
 382                 i2c_smbus_write_byte_data(client, ADM1029_REG_CONFIG,
 383                                           config | 0x10);
 384         }
 385         /* recheck config */
 386         config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
 387         if ((config & 0x10) == 0) {
 388                 dev_err(&client->dev, "Initialization failed!\n");
 389                 return 0;
 390         }
 391         return 1;
 392 }
 393
 394 static int adm1029_remove(struct i2c_client *client)
 395 {
 396         struct adm1029_data *data = i2c_get_clientdata(client);
 397
 398         hwmon_device_unregister(data->hwmon_dev);
 399         sysfs_remove_group(&client->dev.kobj, &adm1029_group);
 400
 401         kfree(data);
 402         return 0;
 403 }
 404
 405 /*
 406 function that update the status of the chips (temperature for example)
 407 */
 408 static struct adm1029_data *adm1029_update_device(struct device *dev)
 409 {
 410         struct i2c_client *client = to_i2c_client(dev);
 411         struct adm1029_data *data = i2c_get_clientdata(client);
 412
 413         mutex_lock(&data->update_lock);
 414         /*
 415          * Use the "cache" Luke, don't recheck values
 416          * if there are already checked not a long time later
 417          */
 418         if (time_after(jiffies, data->last_updated + HZ * 2)
 419          || !data->valid) {
 420                 int nr;
 421
 422                 dev_dbg(&client->dev, "Updating adm1029 data\n");
 423
 424                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_TEMP); nr++) {
 425                         data->temp[nr] =
 426                             i2c_smbus_read_byte_data(client,
 427                                                      ADM1029_REG_TEMP[nr]);
 428                 }
 429                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN); nr++) {
 430                         data->fan[nr] =
 431                             i2c_smbus_read_byte_data(client,
 432                                                      ADM1029_REG_FAN[nr]);
 433                 }
 434                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN_DIV); nr++) {
 435                         data->fan_div[nr] =
 436                             i2c_smbus_read_byte_data(client,
 437                                                      ADM1029_REG_FAN_DIV[nr]);
 438                 }
 439
 440                 data->last_updated = jiffies;
 441                 data->valid = 1;
 442         }
 443
 444         mutex_unlock(&data->update_lock);
 445
 446         return data;
 447 }
 448
 449 /*
 450         Common module stuff
 451 */
 452 static int __init sensors_adm1029_init(void)
 453 {
 454
 455         return i2c_add_driver(&adm1029_driver);
 456 }
 457
 458 static void __exit sensors_adm1029_exit(void)
 459 {
 460
 461         i2c_del_driver(&adm1029_driver);
 462 }
 463
 464 MODULE_AUTHOR("Corentin LABBE <corentin.labbe@geomatys.fr>");
 465 MODULE_DESCRIPTION("adm1029 driver");
 466 MODULE_LICENSE("GPL v2");
 467
 468 module_init(sensors_adm1029_init);
 469 module_exit(sensors_adm1029_exit);