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 <<<<<<< HEAD:drivers/hwmon/adm1029.c
  43 static unsigned short normal_i2c[] = {
  44         0x28, 0x29, 0x2a,
  45         0x2b, 0x2c, 0x2d,
  46         0x2e, 0x2f, I2C_CLIENT_END
  47 =======
  48 static const unsigned short normal_i2c[] = { 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d,
  49                                                 0x2e, 0x2f, I2C_CLIENT_END
  50 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/hwmon/adm1029.c
  51 };
  52
  53 /*
  54  * Insmod parameters
  55  */
  56
  57 I2C_CLIENT_INSMOD_1(adm1029);
  58
  59 /*
  60  * The ADM1029 registers
  61  * Manufacturer ID is 0x41 for Analog Devices
  62  */
  63
  64 #define ADM1029_REG_MAN_ID                      0x0D
  65 #define ADM1029_REG_CHIP_ID                     0x0E
  66 #define ADM1029_REG_CONFIG                      0x01
  67 #define ADM1029_REG_NB_FAN_SUPPORT              0x02
  68
  69 #define ADM1029_REG_TEMP_DEVICES_INSTALLED      0x06
  70
  71 #define ADM1029_REG_LOCAL_TEMP                  0xA0
  72 #define ADM1029_REG_REMOTE1_TEMP                0xA1
  73 #define ADM1029_REG_REMOTE2_TEMP                0xA2
  74
  75 #define ADM1029_REG_LOCAL_TEMP_HIGH             0x90
  76 #define ADM1029_REG_REMOTE1_TEMP_HIGH           0x91
  77 #define ADM1029_REG_REMOTE2_TEMP_HIGH           0x92
  78
  79 #define ADM1029_REG_LOCAL_TEMP_LOW              0x98
  80 #define ADM1029_REG_REMOTE1_TEMP_LOW            0x99
  81 #define ADM1029_REG_REMOTE2_TEMP_LOW            0x9A
  82
  83 #define ADM1029_REG_FAN1                        0x70
  84 #define ADM1029_REG_FAN2                        0x71
  85
  86 #define ADM1029_REG_FAN1_MIN                    0x78
  87 #define ADM1029_REG_FAN2_MIN                    0x79
  88
  89 #define ADM1029_REG_FAN1_CONFIG                 0x68
  90 #define ADM1029_REG_FAN2_CONFIG                 0x69
  91
  92 #define TEMP_FROM_REG(val)      ((val) * 1000)
  93
  94 #define DIV_FROM_REG(val)       ( 1 << (((val) >> 6) - 1))
  95
  96 /* Registers to be checked by adm1029_update_device() */
  97 static const u8 ADM1029_REG_TEMP[] = {
  98         ADM1029_REG_LOCAL_TEMP,
  99         ADM1029_REG_REMOTE1_TEMP,
 100         ADM1029_REG_REMOTE2_TEMP,
 101         ADM1029_REG_LOCAL_TEMP_HIGH,
 102         ADM1029_REG_REMOTE1_TEMP_HIGH,
 103         ADM1029_REG_REMOTE2_TEMP_HIGH,
 104         ADM1029_REG_LOCAL_TEMP_LOW,
 105         ADM1029_REG_REMOTE1_TEMP_LOW,
 106         ADM1029_REG_REMOTE2_TEMP_LOW,
 107 };
 108
 109 static const u8 ADM1029_REG_FAN[] = {
 110         ADM1029_REG_FAN1,
 111         ADM1029_REG_FAN2,
 112         ADM1029_REG_FAN1_MIN,
 113         ADM1029_REG_FAN2_MIN,
 114 };
 115
 116 static const u8 ADM1029_REG_FAN_DIV[] = {
 117         ADM1029_REG_FAN1_CONFIG,
 118         ADM1029_REG_FAN2_CONFIG,
 119 };
 120
 121 /*
 122  * Functions declaration
 123  */
 124
 125 static int adm1029_attach_adapter(struct i2c_adapter *adapter);
 126 static int adm1029_detect(struct i2c_adapter *adapter, int address, int kind);
 127 static int adm1029_detach_client(struct i2c_client *client);
 128 static struct adm1029_data *adm1029_update_device(struct device *dev);
 129 static int adm1029_init_client(struct i2c_client *client);
 130
 131 /*
 132  * Driver data (common to all clients)
 133  */
 134
 135 static struct i2c_driver adm1029_driver = {
 136         .driver = {
 137                 .name = "adm1029",
 138         },
 139         .attach_adapter = adm1029_attach_adapter,
 140         .detach_client = adm1029_detach_client,
 141 };
 142
 143 /*
 144  * Client data (each client gets its own)
 145  */
 146
 147 struct adm1029_data {
 148         struct i2c_client client;
 149         struct device *hwmon_dev;
 150         struct mutex update_lock;
 151         char valid;             /* zero until following fields are valid */
 152         unsigned long last_updated;     /* in jiffies */
 153
 154         /* registers values, signed for temperature, unsigned for other stuff */
 155         s8 temp[ARRAY_SIZE(ADM1029_REG_TEMP)];
 156         u8 fan[ARRAY_SIZE(ADM1029_REG_FAN)];
 157         u8 fan_div[ARRAY_SIZE(ADM1029_REG_FAN_DIV)];
 158 };
 159
 160 /*
 161  * Sysfs stuff
 162  */
 163
 164 static ssize_t
 165 show_temp(struct device *dev, struct device_attribute *devattr, char *buf)
 166 {
 167         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 168         struct adm1029_data *data = adm1029_update_device(dev);
 169         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
 170 }
 171
 172 static ssize_t
 173 show_fan(struct device *dev, struct device_attribute *devattr, char *buf)
 174 {
 175         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 176         struct adm1029_data *data = adm1029_update_device(dev);
 177         u16 val;
 178         if (data->fan[attr->index] == 0 || data->fan_div[attr->index] == 0
 179             || data->fan[attr->index] == 255) {
 180                 return sprintf(buf, "0\n");
 181         }
 182
 183         val = 1880 * 120 / DIV_FROM_REG(data->fan_div[attr->index])
 184             / data->fan[attr->index];
 185         return sprintf(buf, "%d\n", val);
 186 }
 187
 188 static ssize_t
 189 show_fan_div(struct device *dev, struct device_attribute *devattr, char *buf)
 190 {
 191         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 192         struct adm1029_data *data = adm1029_update_device(dev);
 193         if (data->fan_div[attr->index] == 0)
 194                 return sprintf(buf, "0\n");
 195         return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[attr->index]));
 196 }
 197
 198 static ssize_t set_fan_div(struct device *dev,
 199             struct device_attribute *devattr, const char *buf, size_t count)
 200 {
 201         struct i2c_client *client = to_i2c_client(dev);
 202         struct adm1029_data *data = i2c_get_clientdata(client);
 203         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 204         long val = simple_strtol(buf, NULL, 10);
 205         u8 reg;
 206
 207         mutex_lock(&data->update_lock);
 208
 209         /*Read actual config */
 210         reg = i2c_smbus_read_byte_data(client,
 211                                        ADM1029_REG_FAN_DIV[attr->index]);
 212
 213         switch (val) {
 214         case 1:
 215                 val = 1;
 216                 break;
 217         case 2:
 218                 val = 2;
 219                 break;
 220         case 4:
 221                 val = 3;
 222                 break;
 223         default:
 224                 mutex_unlock(&data->update_lock);
 225                 dev_err(&client->dev, "fan_div value %ld not "
 226                         "supported. Choose one of 1, 2 or 4!\n", val);
 227                 return -EINVAL;
 228         }
 229         /* Update the value */
 230         reg = (reg & 0x3F) | (val << 6);
 231
 232         /* Write value */
 233         i2c_smbus_write_byte_data(client,
 234                                   ADM1029_REG_FAN_DIV[attr->index], reg);
 235         mutex_unlock(&data->update_lock);
 236
 237         return count;
 238 }
 239
 240 /*
 241 Access rights on sysfs, S_IRUGO stand for Is Readable by User, Group and Others
 242                         S_IWUSR stand for Is Writable by User
 243 */
 244 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 245 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
 246 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
 247
 248 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 3);
 249 static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO, show_temp, NULL, 4);
 250 static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO, show_temp, NULL, 5);
 251
 252 static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO, show_temp, NULL, 6);
 253 static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO, show_temp, NULL, 7);
 254 static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO, show_temp, NULL, 8);
 255
 256 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
 257 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1);
 258
 259 static SENSOR_DEVICE_ATTR(fan1_min, S_IRUGO, show_fan, NULL, 2);
 260 static SENSOR_DEVICE_ATTR(fan2_min, S_IRUGO, show_fan, NULL, 3);
 261
 262 static SENSOR_DEVICE_ATTR(fan1_div, S_IRUGO | S_IWUSR,
 263                           show_fan_div, set_fan_div, 0);
 264 static SENSOR_DEVICE_ATTR(fan2_div, S_IRUGO | S_IWUSR,
 265                           show_fan_div, set_fan_div, 1);
 266
 267 static struct attribute *adm1029_attributes[] = {
 268         &sensor_dev_attr_temp1_input.dev_attr.attr,
 269         &sensor_dev_attr_temp1_min.dev_attr.attr,
 270         &sensor_dev_attr_temp1_max.dev_attr.attr,
 271         &sensor_dev_attr_temp2_input.dev_attr.attr,
 272         &sensor_dev_attr_temp2_min.dev_attr.attr,
 273         &sensor_dev_attr_temp2_max.dev_attr.attr,
 274         &sensor_dev_attr_temp3_input.dev_attr.attr,
 275         &sensor_dev_attr_temp3_min.dev_attr.attr,
 276         &sensor_dev_attr_temp3_max.dev_attr.attr,
 277         &sensor_dev_attr_fan1_input.dev_attr.attr,
 278         &sensor_dev_attr_fan2_input.dev_attr.attr,
 279         &sensor_dev_attr_fan1_min.dev_attr.attr,
 280         &sensor_dev_attr_fan2_min.dev_attr.attr,
 281         &sensor_dev_attr_fan1_div.dev_attr.attr,
 282         &sensor_dev_attr_fan2_div.dev_attr.attr,
 283         NULL
 284 };
 285
 286 static const struct attribute_group adm1029_group = {
 287         .attrs = adm1029_attributes,
 288 };
 289
 290 /*
 291  * Real code
 292  */
 293
 294 static int adm1029_attach_adapter(struct i2c_adapter *adapter)
 295 {
 296         if (!(adapter->class & I2C_CLASS_HWMON))
 297                 return 0;
 298         return i2c_probe(adapter, &addr_data, adm1029_detect);
 299 }
 300
 301 /*
 302  * The following function does more than just detection. If detection
 303  * succeeds, it also registers the new chip.
 304  */
 305
 306 static int adm1029_detect(struct i2c_adapter *adapter, int address, int kind)
 307 {
 308         struct i2c_client *client;
 309         struct adm1029_data *data;
 310         int err = 0;
 311         const char *name = "";
 312         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 313                 goto exit;
 314
 315         if (!(data = kzalloc(sizeof(struct adm1029_data), GFP_KERNEL))) {
 316                 err = -ENOMEM;
 317                 goto exit;
 318         }
 319
 320         client = &data->client;
 321         i2c_set_clientdata(client, data);
 322         client->addr = address;
 323         client->adapter = adapter;
 324         client->driver = &adm1029_driver;
 325
 326         /* Now we do the detection and identification. A negative kind
 327          * means that the driver was loaded with no force parameter
 328          * (default), so we must both detect and identify the chip
 329          * (actually there is only one possible kind of chip for now, adm1029).
 330          * A zero kind means that the driver was loaded with the force
 331          * parameter, the detection step shall be skipped. A positive kind
 332          * means that the driver was loaded with the force parameter and a
 333          * given kind of chip is requested, so both the detection and the
 334          * identification steps are skipped. */
 335
 336         /* Default to an adm1029 if forced */
 337         if (kind == 0)
 338                 kind = adm1029;
 339
 340         /* ADM1029 doesn't have CHIP ID, check just MAN ID
 341          * For better detection we check also ADM1029_TEMP_DEVICES_INSTALLED,
 342          * ADM1029_REG_NB_FAN_SUPPORT and compare it with possible values
 343          * documented
 344          */
 345
 346         if (kind <= 0) {        /* identification */
 347                 u8 man_id, chip_id, temp_devices_installed, nb_fan_support;
 348
 349                 man_id = i2c_smbus_read_byte_data(client, ADM1029_REG_MAN_ID);
 350                 chip_id = i2c_smbus_read_byte_data(client, ADM1029_REG_CHIP_ID);
 351                 temp_devices_installed = i2c_smbus_read_byte_data(client,
 352                                         ADM1029_REG_TEMP_DEVICES_INSTALLED);
 353                 nb_fan_support = i2c_smbus_read_byte_data(client,
 354                                                 ADM1029_REG_NB_FAN_SUPPORT);
 355                 /* 0x41 is Analog Devices */
 356                 if (man_id == 0x41 && (temp_devices_installed & 0xf9) == 0x01
 357                     && nb_fan_support == 0x03) {
 358                         if ((chip_id & 0xF0) == 0x00) {
 359                                 kind = adm1029;
 360                         } else {
 361                                 /* There are no "official" CHIP ID, so actually
 362                                  * we use Major/Minor revision for that */
 363                                 printk(KERN_INFO
 364                                        "adm1029: Unknown major revision %x, "
 365                                        "please let us know\n", chip_id);
 366                         }
 367                 }
 368
 369                 if (kind <= 0) {        /* identification failed */
 370                         pr_debug("adm1029: Unsupported chip (man_id=0x%02X, "
 371                                  "chip_id=0x%02X)\n", man_id, chip_id);
 372                         goto exit_free;
 373                 }
 374         }
 375
 376         if (kind == adm1029) {
 377                 name = "adm1029";
 378         }
 379
 380         /* We can fill in the remaining client fields */
 381         strlcpy(client->name, name, I2C_NAME_SIZE);
 382         mutex_init(&data->update_lock);
 383
 384         /* Tell the I2C layer a new client has arrived */
 385         if ((err = i2c_attach_client(client)))
 386                 goto exit_free;
 387
 388         /*
 389          * Initialize the ADM1029 chip
 390          * Check config register
 391          */
 392         if (adm1029_init_client(client) == 0)
 393                 goto exit_detach;
 394
 395         /* Register sysfs hooks */
 396         if ((err = sysfs_create_group(&client->dev.kobj, &adm1029_group)))
 397                 goto exit_detach;
 398
 399         data->hwmon_dev = hwmon_device_register(&client->dev);
 400         if (IS_ERR(data->hwmon_dev)) {
 401                 err = PTR_ERR(data->hwmon_dev);
 402                 goto exit_remove_files;
 403         }
 404
 405         return 0;
 406
 407  exit_remove_files:
 408         sysfs_remove_group(&client->dev.kobj, &adm1029_group);
 409  exit_detach:
 410         i2c_detach_client(client);
 411  exit_free:
 412         kfree(data);
 413  exit:
 414         return err;
 415 }
 416
 417 static int adm1029_init_client(struct i2c_client *client)
 418 {
 419         u8 config;
 420         config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
 421         if ((config & 0x10) == 0) {
 422                 i2c_smbus_write_byte_data(client, ADM1029_REG_CONFIG,
 423                                           config | 0x10);
 424         }
 425         /* recheck config */
 426         config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
 427         if ((config & 0x10) == 0) {
 428                 dev_err(&client->dev, "Initialization failed!\n");
 429                 return 0;
 430         }
 431         return 1;
 432 }
 433
 434 static int adm1029_detach_client(struct i2c_client *client)
 435 {
 436         struct adm1029_data *data = i2c_get_clientdata(client);
 437         int err;
 438
 439         hwmon_device_unregister(data->hwmon_dev);
 440         sysfs_remove_group(&client->dev.kobj, &adm1029_group);
 441
 442         if ((err = i2c_detach_client(client)))
 443                 return err;
 444
 445         kfree(data);
 446         return 0;
 447 }
 448
 449 /*
 450 function that update the status of the chips (temperature for exemple)
 451 */
 452 static struct adm1029_data *adm1029_update_device(struct device *dev)
 453 {
 454         struct i2c_client *client = to_i2c_client(dev);
 455         struct adm1029_data *data = i2c_get_clientdata(client);
 456
 457         mutex_lock(&data->update_lock);
 458         /*
 459          * Use the "cache" Luke, don't recheck values
 460          * if there are already checked not a long time later
 461          */
 462         if (time_after(jiffies, data->last_updated + HZ * 2)
 463          || !data->valid) {
 464                 int nr;
 465
 466                 dev_dbg(&client->dev, "Updating adm1029 data\n");
 467
 468                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_TEMP); nr++) {
 469                         data->temp[nr] =
 470                             i2c_smbus_read_byte_data(client,
 471                                                      ADM1029_REG_TEMP[nr]);
 472                 }
 473                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN); nr++) {
 474                         data->fan[nr] =
 475                             i2c_smbus_read_byte_data(client,
 476                                                      ADM1029_REG_FAN[nr]);
 477                 }
 478                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN_DIV); nr++) {
 479                         data->fan_div[nr] =
 480                             i2c_smbus_read_byte_data(client,
 481                                                      ADM1029_REG_FAN_DIV[nr]);
 482                 }
 483
 484                 data->last_updated = jiffies;
 485                 data->valid = 1;
 486         }
 487
 488         mutex_unlock(&data->update_lock);
 489
 490         return data;
 491 }
 492
 493 /*
 494         Common module stuff
 495 */
 496 static int __init sensors_adm1029_init(void)
 497 {
 498
 499         return i2c_add_driver(&adm1029_driver);
 500 }
 501
 502 static void __exit sensors_adm1029_exit(void)
 503 {
 504
 505         i2c_del_driver(&adm1029_driver);
 506 }
 507
 508 MODULE_AUTHOR("Corentin LABBE <corentin.labbe@geomatys.fr>");
 509 MODULE_DESCRIPTION("adm1029 driver");
 510 MODULE_LICENSE("GPL v2");
 511
 512 module_init(sensors_adm1029_init);
 513 module_exit(sensors_adm1029_exit);