drivers/hwmon/lm83.c

   1 /*
   2  * lm83.c - Part of lm_sensors, Linux kernel modules for hardware
   3  *          monitoring
   4  * Copyright (C) 2003-2006  Jean Delvare <khali@linux-fr.org>
   5  *
   6  * Heavily inspired from the lm78, lm75 and adm1021 drivers. The LM83 is
   7  * a sensor chip made by National Semiconductor. It reports up to four
   8  * temperatures (its own plus up to three external ones) with a 1 deg
   9  * resolution and a 3-4 deg accuracy. Complete datasheet can be obtained
  10  * from National's website at:
  11  *   http://www.national.com/pf/LM/LM83.html
  12  * Since the datasheet omits to give the chip stepping code, I give it
  13  * here: 0x03 (at register 0xff).
  14  *
  15  * Also supports the LM82 temp sensor, which is basically a stripped down
  16  * model of the LM83.  Datasheet is here:
  17  * http://www.national.com/pf/LM/LM82.html
  18  *
  19  * This program is free software; you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation; either version 2 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program; if not, write to the Free Software
  31  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  32  */
  33
  34 #include <linux/module.h>
  35 #include <linux/init.h>
  36 #include <linux/slab.h>
  37 #include <linux/jiffies.h>
  38 #include <linux/i2c.h>
  39 #include <linux/hwmon-sysfs.h>
  40 #include <linux/hwmon.h>
  41 #include <linux/err.h>
  42 #include <linux/mutex.h>
  43
  44 /*
  45  * Addresses to scan
  46  * Address is selected using 2 three-level pins, resulting in 9 possible
  47  * addresses.
  48  */
  49
  50 static unsigned short normal_i2c[] = { 0x18, 0x19, 0x1a,
  51                                         0x29, 0x2a, 0x2b,
  52                                         0x4c, 0x4d, 0x4e,
  53                                         I2C_CLIENT_END };
  54
  55 /*
  56  * Insmod parameters
  57  */
  58
  59 I2C_CLIENT_INSMOD_2(lm83, lm82);
  60
  61 /*
  62  * The LM83 registers
  63  * Manufacturer ID is 0x01 for National Semiconductor.
  64  */
  65
  66 #define LM83_REG_R_MAN_ID               0xFE
  67 #define LM83_REG_R_CHIP_ID              0xFF
  68 #define LM83_REG_R_CONFIG               0x03
  69 #define LM83_REG_W_CONFIG               0x09
  70 #define LM83_REG_R_STATUS1              0x02
  71 #define LM83_REG_R_STATUS2              0x35
  72 #define LM83_REG_R_LOCAL_TEMP           0x00
  73 #define LM83_REG_R_LOCAL_HIGH           0x05
  74 #define LM83_REG_W_LOCAL_HIGH           0x0B
  75 #define LM83_REG_R_REMOTE1_TEMP         0x30
  76 #define LM83_REG_R_REMOTE1_HIGH         0x38
  77 #define LM83_REG_W_REMOTE1_HIGH         0x50
  78 #define LM83_REG_R_REMOTE2_TEMP         0x01
  79 #define LM83_REG_R_REMOTE2_HIGH         0x07
  80 #define LM83_REG_W_REMOTE2_HIGH         0x0D
  81 #define LM83_REG_R_REMOTE3_TEMP         0x31
  82 #define LM83_REG_R_REMOTE3_HIGH         0x3A
  83 #define LM83_REG_W_REMOTE3_HIGH         0x52
  84 #define LM83_REG_R_TCRIT                0x42
  85 #define LM83_REG_W_TCRIT                0x5A
  86
  87 /*
  88  * Conversions and various macros
  89  * The LM83 uses signed 8-bit values with LSB = 1 degree Celsius.
  90  */
  91
  92 #define TEMP_FROM_REG(val)      ((val) * 1000)
  93 #define TEMP_TO_REG(val)        ((val) <= -128000 ? -128 : \
  94                                  (val) >= 127000 ? 127 : \
  95                                  (val) < 0 ? ((val) - 500) / 1000 : \
  96                                  ((val) + 500) / 1000)
  97
  98 static const u8 LM83_REG_R_TEMP[] = {
  99         LM83_REG_R_LOCAL_TEMP,
 100         LM83_REG_R_REMOTE1_TEMP,
 101         LM83_REG_R_REMOTE2_TEMP,
 102         LM83_REG_R_REMOTE3_TEMP,
 103         LM83_REG_R_LOCAL_HIGH,
 104         LM83_REG_R_REMOTE1_HIGH,
 105         LM83_REG_R_REMOTE2_HIGH,
 106         LM83_REG_R_REMOTE3_HIGH,
 107         LM83_REG_R_TCRIT,
 108 };
 109
 110 static const u8 LM83_REG_W_HIGH[] = {
 111         LM83_REG_W_LOCAL_HIGH,
 112         LM83_REG_W_REMOTE1_HIGH,
 113         LM83_REG_W_REMOTE2_HIGH,
 114         LM83_REG_W_REMOTE3_HIGH,
 115         LM83_REG_W_TCRIT,
 116 };
 117
 118 /*
 119  * Functions declaration
 120  */
 121
 122 static int lm83_attach_adapter(struct i2c_adapter *adapter);
 123 static int lm83_detect(struct i2c_adapter *adapter, int address, int kind);
 124 static int lm83_detach_client(struct i2c_client *client);
 125 static struct lm83_data *lm83_update_device(struct device *dev);
 126
 127 /*
 128  * Driver data (common to all clients)
 129  */
 130
 131 static struct i2c_driver lm83_driver = {
 132         .driver = {
 133                 .name   = "lm83",
 134         },
 135         .id             = I2C_DRIVERID_LM83,
 136         .attach_adapter = lm83_attach_adapter,
 137         .detach_client  = lm83_detach_client,
 138 };
 139
 140 /*
 141  * Client data (each client gets its own)
 142  */
 143
 144 struct lm83_data {
 145         struct i2c_client client;
 146         struct class_device *class_dev;
 147         struct mutex update_lock;
 148         char valid; /* zero until following fields are valid */
 149         unsigned long last_updated; /* in jiffies */
 150
 151         /* registers values */
 152         s8 temp[9];     /* 0..3: input 1-4,
 153                            4..7: high limit 1-4,
 154                            8   : critical limit */
 155         u16 alarms; /* bitvector, combined */
 156 };
 157
 158 /*
 159  * Sysfs stuff
 160  */
 161
 162 static ssize_t show_temp(struct device *dev, struct device_attribute *devattr,
 163                          char *buf)
 164 {
 165         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 166         struct lm83_data *data = lm83_update_device(dev);
 167         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
 168 }
 169
 170 static ssize_t set_temp(struct device *dev, struct device_attribute *devattr,
 171                         const char *buf, size_t count)
 172 {
 173         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 174         struct i2c_client *client = to_i2c_client(dev);
 175         struct lm83_data *data = i2c_get_clientdata(client);
 176         long val = simple_strtol(buf, NULL, 10);
 177         int nr = attr->index;
 178
 179         mutex_lock(&data->update_lock);
 180         data->temp[nr] = TEMP_TO_REG(val);
 181         i2c_smbus_write_byte_data(client, LM83_REG_W_HIGH[nr - 4],
 182                                   data->temp[nr]);
 183         mutex_unlock(&data->update_lock);
 184         return count;
 185 }
 186
 187 static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy,
 188                            char *buf)
 189 {
 190         struct lm83_data *data = lm83_update_device(dev);
 191         return sprintf(buf, "%d\n", data->alarms);
 192 }
 193
 194 static ssize_t show_alarm(struct device *dev, struct device_attribute
 195                           *devattr, char *buf)
 196 {
 197         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 198         struct lm83_data *data = lm83_update_device(dev);
 199         int bitnr = attr->index;
 200
 201         return sprintf(buf, "%d\n", (data->alarms >> bitnr) & 1);
 202 }
 203
 204 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 205 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
 206 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
 207 static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp, NULL, 3);
 208 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp,
 209         set_temp, 4);
 210 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp,
 211         set_temp, 5);
 212 static SENSOR_DEVICE_ATTR(temp3_max, S_IWUSR | S_IRUGO, show_temp,
 213         set_temp, 6);
 214 static SENSOR_DEVICE_ATTR(temp4_max, S_IWUSR | S_IRUGO, show_temp,
 215         set_temp, 7);
 216 static SENSOR_DEVICE_ATTR(temp1_crit, S_IRUGO, show_temp, NULL, 8);
 217 static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_temp, NULL, 8);
 218 static SENSOR_DEVICE_ATTR(temp3_crit, S_IWUSR | S_IRUGO, show_temp,
 219         set_temp, 8);
 220 static SENSOR_DEVICE_ATTR(temp4_crit, S_IRUGO, show_temp, NULL, 8);
 221
 222 /* Individual alarm files */
 223 static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL, 0);
 224 static SENSOR_DEVICE_ATTR(temp3_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
 225 static SENSOR_DEVICE_ATTR(temp3_input_fault, S_IRUGO, show_alarm, NULL, 2);
 226 static SENSOR_DEVICE_ATTR(temp3_max_alarm, S_IRUGO, show_alarm, NULL, 4);
 227 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
 228 static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 8);
 229 static SENSOR_DEVICE_ATTR(temp4_crit_alarm, S_IRUGO, show_alarm, NULL, 9);
 230 static SENSOR_DEVICE_ATTR(temp4_input_fault, S_IRUGO, show_alarm, NULL, 10);
 231 static SENSOR_DEVICE_ATTR(temp4_max_alarm, S_IRUGO, show_alarm, NULL, 12);
 232 static SENSOR_DEVICE_ATTR(temp2_input_fault, S_IRUGO, show_alarm, NULL, 13);
 233 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 15);
 234 /* Raw alarm file for compatibility */
 235 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 236
 237 /*
 238  * Real code
 239  */
 240
 241 static int lm83_attach_adapter(struct i2c_adapter *adapter)
 242 {
 243         if (!(adapter->class & I2C_CLASS_HWMON))
 244                 return 0;
 245         return i2c_probe(adapter, &addr_data, lm83_detect);
 246 }
 247
 248 /*
 249  * The following function does more than just detection. If detection
 250  * succeeds, it also registers the new chip.
 251  */
 252 static int lm83_detect(struct i2c_adapter *adapter, int address, int kind)
 253 {
 254         struct i2c_client *new_client;
 255         struct lm83_data *data;
 256         int err = 0;
 257         const char *name = "";
 258
 259         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 260                 goto exit;
 261
 262         if (!(data = kzalloc(sizeof(struct lm83_data), GFP_KERNEL))) {
 263                 err = -ENOMEM;
 264                 goto exit;
 265         }
 266
 267         /* The common I2C client data is placed right after the
 268          * LM83-specific data. */
 269         new_client = &data->client;
 270         i2c_set_clientdata(new_client, data);
 271         new_client->addr = address;
 272         new_client->adapter = adapter;
 273         new_client->driver = &lm83_driver;
 274         new_client->flags = 0;
 275
 276         /* Now we do the detection and identification. A negative kind
 277          * means that the driver was loaded with no force parameter
 278          * (default), so we must both detect and identify the chip
 279          * (actually there is only one possible kind of chip for now, LM83).
 280          * A zero kind means that the driver was loaded with the force
 281          * parameter, the detection step shall be skipped. A positive kind
 282          * means that the driver was loaded with the force parameter and a
 283          * given kind of chip is requested, so both the detection and the
 284          * identification steps are skipped. */
 285
 286         /* Default to an LM83 if forced */
 287         if (kind == 0)
 288                 kind = lm83;
 289
 290         if (kind < 0) { /* detection */
 291                 if (((i2c_smbus_read_byte_data(new_client, LM83_REG_R_STATUS1)
 292                     & 0xA8) != 0x00) ||
 293                     ((i2c_smbus_read_byte_data(new_client, LM83_REG_R_STATUS2)
 294                     & 0x48) != 0x00) ||
 295                     ((i2c_smbus_read_byte_data(new_client, LM83_REG_R_CONFIG)
 296                     & 0x41) != 0x00)) {
 297                         dev_dbg(&adapter->dev,
 298                             "LM83 detection failed at 0x%02x.\n", address);
 299                         goto exit_free;
 300                 }
 301         }
 302
 303         if (kind <= 0) { /* identification */
 304                 u8 man_id, chip_id;
 305
 306                 man_id = i2c_smbus_read_byte_data(new_client,
 307                     LM83_REG_R_MAN_ID);
 308                 chip_id = i2c_smbus_read_byte_data(new_client,
 309                     LM83_REG_R_CHIP_ID);
 310
 311                 if (man_id == 0x01) { /* National Semiconductor */
 312                         if (chip_id == 0x03) {
 313                                 kind = lm83;
 314                         } else
 315                         if (chip_id == 0x01) {
 316                                 kind = lm82;
 317                         }
 318                 }
 319
 320                 if (kind <= 0) { /* identification failed */
 321                         dev_info(&adapter->dev,
 322                             "Unsupported chip (man_id=0x%02X, "
 323                             "chip_id=0x%02X).\n", man_id, chip_id);
 324                         goto exit_free;
 325                 }
 326         }
 327
 328         if (kind == lm83) {
 329                 name = "lm83";
 330         } else
 331         if (kind == lm82) {
 332                 name = "lm82";
 333         }
 334
 335         /* We can fill in the remaining client fields */
 336         strlcpy(new_client->name, name, I2C_NAME_SIZE);
 337         data->valid = 0;
 338         mutex_init(&data->update_lock);
 339
 340         /* Tell the I2C layer a new client has arrived */
 341         if ((err = i2c_attach_client(new_client)))
 342                 goto exit_free;
 343
 344         /*
 345          * Initialize the LM83 chip
 346          * (Nothing to do for this one.)
 347          */
 348
 349         /* Register sysfs hooks */
 350         data->class_dev = hwmon_device_register(&new_client->dev);
 351         if (IS_ERR(data->class_dev)) {
 352                 err = PTR_ERR(data->class_dev);
 353                 goto exit_detach;
 354         }
 355
 356         /*
 357          * The LM82 can only monitor one external diode which is
 358          * at the same register as the LM83 temp3 entry - so we
 359          * declare 1 and 3 common, and then 2 and 4 only for the LM83.
 360          */
 361
 362         device_create_file(&new_client->dev,
 363                            &sensor_dev_attr_temp1_input.dev_attr);
 364         device_create_file(&new_client->dev,
 365                            &sensor_dev_attr_temp3_input.dev_attr);
 366
 367         device_create_file(&new_client->dev,
 368                            &sensor_dev_attr_temp1_max.dev_attr);
 369         device_create_file(&new_client->dev,
 370                            &sensor_dev_attr_temp3_max.dev_attr);
 371
 372         device_create_file(&new_client->dev,
 373                            &sensor_dev_attr_temp1_crit.dev_attr);
 374         device_create_file(&new_client->dev,
 375                            &sensor_dev_attr_temp3_crit.dev_attr);
 376
 377         device_create_file(&new_client->dev,
 378                            &sensor_dev_attr_temp3_input_fault.dev_attr);
 379         device_create_file(&new_client->dev,
 380                            &sensor_dev_attr_temp1_max_alarm.dev_attr);
 381         device_create_file(&new_client->dev,
 382                            &sensor_dev_attr_temp3_max_alarm.dev_attr);
 383         device_create_file(&new_client->dev,
 384                            &sensor_dev_attr_temp1_crit_alarm.dev_attr);
 385         device_create_file(&new_client->dev,
 386                            &sensor_dev_attr_temp3_crit_alarm.dev_attr);
 387         device_create_file(&new_client->dev, &dev_attr_alarms);
 388
 389         if (kind == lm83) {
 390                 device_create_file(&new_client->dev,
 391                                    &sensor_dev_attr_temp2_input.dev_attr);
 392                 device_create_file(&new_client->dev,
 393                                    &sensor_dev_attr_temp4_input.dev_attr);
 394
 395                 device_create_file(&new_client->dev,
 396                                    &sensor_dev_attr_temp2_max.dev_attr);
 397                 device_create_file(&new_client->dev,
 398                                    &sensor_dev_attr_temp4_max.dev_attr);
 399
 400                 device_create_file(&new_client->dev,
 401                                    &sensor_dev_attr_temp2_crit.dev_attr);
 402                 device_create_file(&new_client->dev,
 403                                    &sensor_dev_attr_temp4_crit.dev_attr);
 404
 405                 device_create_file(&new_client->dev,
 406                                 &sensor_dev_attr_temp2_input_fault.dev_attr);
 407                 device_create_file(&new_client->dev,
 408                                 &sensor_dev_attr_temp4_input_fault.dev_attr);
 409                 device_create_file(&new_client->dev,
 410                                 &sensor_dev_attr_temp2_max_alarm.dev_attr);
 411                 device_create_file(&new_client->dev,
 412                                 &sensor_dev_attr_temp4_max_alarm.dev_attr);
 413                 device_create_file(&new_client->dev,
 414                                 &sensor_dev_attr_temp2_crit_alarm.dev_attr);
 415                 device_create_file(&new_client->dev,
 416                                 &sensor_dev_attr_temp4_crit_alarm.dev_attr);
 417         }
 418
 419         return 0;
 420
 421 exit_detach:
 422         i2c_detach_client(new_client);
 423 exit_free:
 424         kfree(data);
 425 exit:
 426         return err;
 427 }
 428
 429 static int lm83_detach_client(struct i2c_client *client)
 430 {
 431         struct lm83_data *data = i2c_get_clientdata(client);
 432         int err;
 433
 434         hwmon_device_unregister(data->class_dev);
 435
 436         if ((err = i2c_detach_client(client)))
 437                 return err;
 438
 439         kfree(data);
 440         return 0;
 441 }
 442
 443 static struct lm83_data *lm83_update_device(struct device *dev)
 444 {
 445         struct i2c_client *client = to_i2c_client(dev);
 446         struct lm83_data *data = i2c_get_clientdata(client);
 447
 448         mutex_lock(&data->update_lock);
 449
 450         if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
 451                 int nr;
 452
 453                 dev_dbg(&client->dev, "Updating lm83 data.\n");
 454                 for (nr = 0; nr < 9; nr++) {
 455                         data->temp[nr] =
 456                             i2c_smbus_read_byte_data(client,
 457                             LM83_REG_R_TEMP[nr]);
 458                 }
 459                 data->alarms =
 460                     i2c_smbus_read_byte_data(client, LM83_REG_R_STATUS1)
 461                     + (i2c_smbus_read_byte_data(client, LM83_REG_R_STATUS2)
 462                     << 8);
 463
 464                 data->last_updated = jiffies;
 465                 data->valid = 1;
 466         }
 467
 468         mutex_unlock(&data->update_lock);
 469
 470         return data;
 471 }
 472
 473 static int __init sensors_lm83_init(void)
 474 {
 475         return i2c_add_driver(&lm83_driver);
 476 }
 477
 478 static void __exit sensors_lm83_exit(void)
 479 {
 480         i2c_del_driver(&lm83_driver);
 481 }
 482
 483 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
 484 MODULE_DESCRIPTION("LM83 driver");
 485 MODULE_LICENSE("GPL");
 486
 487 module_init(sensors_lm83_init);
 488 module_exit(sensors_lm83_exit);