drivers/hwmon/lm63.c

   1 /*
   2  * lm63.c - driver for the National Semiconductor LM63 temperature sensor
   3  *          with integrated fan control
   4  * Copyright (C) 2004-2008  Jean Delvare <khali@linux-fr.org>
   5  * Based on the lm90 driver.
   6  *
   7  * The LM63 is a sensor chip made by National Semiconductor. It measures
   8  * two temperatures (its own and one external one) and the speed of one
   9  * fan, those speed it can additionally control. Complete datasheet can be
  10  * obtained from National's website at:
  11  *   http://www.national.com/pf/LM/LM63.html
  12  *
  13  * The LM63 is basically an LM86 with fan speed monitoring and control
  14  * capabilities added. It misses some of the LM86 features though:
  15  *  - No low limit for local temperature.
  16  *  - No critical limit for local temperature.
  17  *  - Critical limit for remote temperature can be changed only once. We
  18  *    will consider that the critical limit is read-only.
  19  *
  20  * The datasheet isn't very clear about what the tachometer reading is.
  21  * I had a explanation from National Semiconductor though. The two lower
  22  * bits of the read value have to be masked out. The value is still 16 bit
  23  * in width.
  24  *
  25  * This program is free software; you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation; either version 2 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License
  36  * along with this program; if not, write to the Free Software
  37  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  38  */
  39
  40 #include <linux/module.h>
  41 #include <linux/init.h>
  42 #include <linux/slab.h>
  43 #include <linux/jiffies.h>
  44 #include <linux/i2c.h>
  45 #include <linux/hwmon-sysfs.h>
  46 #include <linux/hwmon.h>
  47 #include <linux/err.h>
  48 #include <linux/mutex.h>
  49 #include <linux/sysfs.h>
  50 #include <linux/types.h>
  51
  52 /*
  53  * Addresses to scan
  54  * Address is fully defined internally and cannot be changed.
  55  */
  56
  57 static const unsigned short normal_i2c[] = { 0x18, 0x4c, 0x4e, I2C_CLIENT_END };
  58
  59 /*
  60  * The LM63 registers
  61  */
  62
  63 #define LM63_REG_CONFIG1                0x03
  64 #define LM63_REG_CONVRATE               0x04
  65 #define LM63_REG_CONFIG2                0xBF
  66 #define LM63_REG_CONFIG_FAN             0x4A
  67
  68 #define LM63_REG_TACH_COUNT_MSB         0x47
  69 #define LM63_REG_TACH_COUNT_LSB         0x46
  70 #define LM63_REG_TACH_LIMIT_MSB         0x49
  71 #define LM63_REG_TACH_LIMIT_LSB         0x48
  72
  73 #define LM63_REG_PWM_VALUE              0x4C
  74 #define LM63_REG_PWM_FREQ               0x4D
  75
  76 #define LM63_REG_LOCAL_TEMP             0x00
  77 #define LM63_REG_LOCAL_HIGH             0x05
  78
  79 #define LM63_REG_REMOTE_TEMP_MSB        0x01
  80 #define LM63_REG_REMOTE_TEMP_LSB        0x10
  81 #define LM63_REG_REMOTE_OFFSET_MSB      0x11
  82 #define LM63_REG_REMOTE_OFFSET_LSB      0x12
  83 #define LM63_REG_REMOTE_HIGH_MSB        0x07
  84 #define LM63_REG_REMOTE_HIGH_LSB        0x13
  85 #define LM63_REG_REMOTE_LOW_MSB         0x08
  86 #define LM63_REG_REMOTE_LOW_LSB         0x14
  87 #define LM63_REG_REMOTE_TCRIT           0x19
  88 #define LM63_REG_REMOTE_TCRIT_HYST      0x21
  89
  90 #define LM63_REG_ALERT_STATUS           0x02
  91 #define LM63_REG_ALERT_MASK             0x16
  92
  93 #define LM63_REG_MAN_ID                 0xFE
  94 #define LM63_REG_CHIP_ID                0xFF
  95
  96 #define LM96163_REG_TRUTHERM            0x30
  97 #define LM96163_REG_REMOTE_TEMP_U_MSB   0x31
  98 #define LM96163_REG_REMOTE_TEMP_U_LSB   0x32
  99 #define LM96163_REG_CONFIG_ENHANCED     0x45
 100
 101 #define LM63_MAX_CONVRATE               9
 102
 103 #define LM63_MAX_CONVRATE_HZ            32
 104 #define LM96163_MAX_CONVRATE_HZ         26
 105
 106 /*
 107  * Conversions and various macros
 108  * For tachometer counts, the LM63 uses 16-bit values.
 109  * For local temperature and high limit, remote critical limit and hysteresis
 110  * value, it uses signed 8-bit values with LSB = 1 degree Celsius.
 111  * For remote temperature, low and high limits, it uses signed 11-bit values
 112  * with LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
 113  * For LM64 the actual remote diode temperature is 16 degree Celsius higher
 114  * than the register reading. Remote temperature setpoints have to be
 115  * adapted accordingly.
 116  */
 117
 118 #define FAN_FROM_REG(reg)       ((reg) == 0xFFFC || (reg) == 0 ? 0 : \
 119                                  5400000 / (reg))
 120 #define FAN_TO_REG(val)         ((val) <= 82 ? 0xFFFC : \
 121                                  (5400000 / (val)) & 0xFFFC)
 122 #define TEMP8_FROM_REG(reg)     ((reg) * 1000)
 123 #define TEMP8_TO_REG(val)       ((val) <= -128000 ? -128 : \
 124                                  (val) >= 127000 ? 127 : \
 125                                  (val) < 0 ? ((val) - 500) / 1000 : \
 126                                  ((val) + 500) / 1000)
 127 #define TEMP8U_TO_REG(val)      ((val) <= 0 ? 0 : \
 128                                  (val) >= 255000 ? 255 : \
 129                                  ((val) + 500) / 1000)
 130 #define TEMP11_FROM_REG(reg)    ((reg) / 32 * 125)
 131 #define TEMP11_TO_REG(val)      ((val) <= -128000 ? 0x8000 : \
 132                                  (val) >= 127875 ? 0x7FE0 : \
 133                                  (val) < 0 ? ((val) - 62) / 125 * 32 : \
 134                                  ((val) + 62) / 125 * 32)
 135 #define TEMP11U_TO_REG(val)     ((val) <= 0 ? 0 : \
 136                                  (val) >= 255875 ? 0xFFE0 : \
 137                                  ((val) + 62) / 125 * 32)
 138 #define HYST_TO_REG(val)        ((val) <= 0 ? 0 : \
 139                                  (val) >= 127000 ? 127 : \
 140                                  ((val) + 500) / 1000)
 141
 142 #define UPDATE_INTERVAL(max, rate) \
 143                         ((1000 << (LM63_MAX_CONVRATE - (rate))) / (max))
 144
 145 /*
 146  * Functions declaration
 147  */
 148
 149 static int lm63_probe(struct i2c_client *client,
 150                       const struct i2c_device_id *id);
 151 static int lm63_remove(struct i2c_client *client);
 152
 153 static struct lm63_data *lm63_update_device(struct device *dev);
 154
 155 static int lm63_detect(struct i2c_client *client, struct i2c_board_info *info);
 156 static void lm63_init_client(struct i2c_client *client);
 157
 158 enum chips { lm63, lm64, lm96163 };
 159
 160 /*
 161  * Driver data (common to all clients)
 162  */
 163
 164 static const struct i2c_device_id lm63_id[] = {
 165         { "lm63", lm63 },
 166         { "lm64", lm64 },
 167         { "lm96163", lm96163 },
 168         { }
 169 };
 170 MODULE_DEVICE_TABLE(i2c, lm63_id);
 171
 172 static struct i2c_driver lm63_driver = {
 173         .class          = I2C_CLASS_HWMON,
 174         .driver = {
 175                 .name   = "lm63",
 176         },
 177         .probe          = lm63_probe,
 178         .remove         = lm63_remove,
 179         .id_table       = lm63_id,
 180         .detect         = lm63_detect,
 181         .address_list   = normal_i2c,
 182 };
 183
 184 /*
 185  * Client data (each client gets its own)
 186  */
 187
 188 struct lm63_data {
 189         struct device *hwmon_dev;
 190         struct mutex update_lock;
 191         char valid; /* zero until following fields are valid */
 192         unsigned long last_updated; /* in jiffies */
 193         enum chips kind;
 194         int temp2_offset;
 195
 196         int update_interval;    /* in milliseconds */
 197         int max_convrate_hz;
 198
 199         /* registers values */
 200         u8 config, config_fan;
 201         u16 fan[2];     /* 0: input
 202                            1: low limit */
 203         u8 pwm1_freq;
 204         u8 pwm1_value;
 205         s8 temp8[3];    /* 0: local input
 206                            1: local high limit
 207                            2: remote critical limit */
 208         s16 temp11[4];  /* 0: remote input
 209                            1: remote low limit
 210                            2: remote high limit
 211                            3: remote offset */
 212         u16 temp11u;    /* remote input (unsigned) */
 213         u8 temp2_crit_hyst;
 214         u8 alarms;
 215         bool pwm_highres;
 216         bool remote_unsigned; /* true if unsigned remote upper limits */
 217         bool trutherm;
 218 };
 219
 220 static inline int temp8_from_reg(struct lm63_data *data, int nr)
 221 {
 222         if (data->remote_unsigned)
 223                 return TEMP8_FROM_REG((u8)data->temp8[nr]);
 224         return TEMP8_FROM_REG(data->temp8[nr]);
 225 }
 226
 227 /*
 228  * Sysfs callback functions and files
 229  */
 230
 231 static ssize_t show_fan(struct device *dev, struct device_attribute *devattr,
 232                         char *buf)
 233 {
 234         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 235         struct lm63_data *data = lm63_update_device(dev);
 236         return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[attr->index]));
 237 }
 238
 239 static ssize_t set_fan(struct device *dev, struct device_attribute *dummy,
 240                        const char *buf, size_t count)
 241 {
 242         struct i2c_client *client = to_i2c_client(dev);
 243         struct lm63_data *data = i2c_get_clientdata(client);
 244         unsigned long val;
 245         int err;
 246
 247         err = kstrtoul(buf, 10, &val);
 248         if (err)
 249                 return err;
 250
 251         mutex_lock(&data->update_lock);
 252         data->fan[1] = FAN_TO_REG(val);
 253         i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_LSB,
 254                                   data->fan[1] & 0xFF);
 255         i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_MSB,
 256                                   data->fan[1] >> 8);
 257         mutex_unlock(&data->update_lock);
 258         return count;
 259 }
 260
 261 static ssize_t show_pwm1(struct device *dev, struct device_attribute *dummy,
 262                          char *buf)
 263 {
 264         struct lm63_data *data = lm63_update_device(dev);
 265         int pwm;
 266
 267         if (data->pwm_highres)
 268                 pwm = data->pwm1_value;
 269         else
 270                 pwm = data->pwm1_value >= 2 * data->pwm1_freq ?
 271                        255 : (data->pwm1_value * 255 + data->pwm1_freq) /
 272                        (2 * data->pwm1_freq);
 273
 274         return sprintf(buf, "%d\n", pwm);
 275 }
 276
 277 static ssize_t set_pwm1(struct device *dev, struct device_attribute *dummy,
 278                         const char *buf, size_t count)
 279 {
 280         struct i2c_client *client = to_i2c_client(dev);
 281         struct lm63_data *data = i2c_get_clientdata(client);
 282         unsigned long val;
 283         int err;
 284
 285         if (!(data->config_fan & 0x20)) /* register is read-only */
 286                 return -EPERM;
 287
 288         err = kstrtoul(buf, 10, &val);
 289         if (err)
 290                 return err;
 291
 292         val = SENSORS_LIMIT(val, 0, 255);
 293         mutex_lock(&data->update_lock);
 294         data->pwm1_value = data->pwm_highres ? val :
 295                            (val * data->pwm1_freq * 2 + 127) / 255;
 296         i2c_smbus_write_byte_data(client, LM63_REG_PWM_VALUE, data->pwm1_value);
 297         mutex_unlock(&data->update_lock);
 298         return count;
 299 }
 300
 301 static ssize_t show_pwm1_enable(struct device *dev,
 302                                 struct device_attribute *dummy, char *buf)
 303 {
 304         struct lm63_data *data = lm63_update_device(dev);
 305         return sprintf(buf, "%d\n", data->config_fan & 0x20 ? 1 : 2);
 306 }
 307
 308 /*
 309  * There are 8bit registers for both local(temp1) and remote(temp2) sensor.
 310  * For remote sensor registers temp2_offset has to be considered,
 311  * for local sensor it must not.
 312  * So we need separate 8bit accessors for local and remote sensor.
 313  */
 314 static ssize_t show_local_temp8(struct device *dev,
 315                                 struct device_attribute *devattr,
 316                                 char *buf)
 317 {
 318         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 319         struct lm63_data *data = lm63_update_device(dev);
 320         return sprintf(buf, "%d\n", TEMP8_FROM_REG(data->temp8[attr->index]));
 321 }
 322
 323 static ssize_t show_remote_temp8(struct device *dev,
 324                                  struct device_attribute *devattr,
 325                                  char *buf)
 326 {
 327         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 328         struct lm63_data *data = lm63_update_device(dev);
 329         return sprintf(buf, "%d\n", temp8_from_reg(data, attr->index)
 330                        + data->temp2_offset);
 331 }
 332
 333 static ssize_t set_temp8(struct device *dev, struct device_attribute *devattr,
 334                          const char *buf, size_t count)
 335 {
 336         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 337         struct i2c_client *client = to_i2c_client(dev);
 338         struct lm63_data *data = i2c_get_clientdata(client);
 339         int nr = attr->index;
 340         int reg = nr == 2 ? LM63_REG_REMOTE_TCRIT : LM63_REG_LOCAL_HIGH;
 341         long val;
 342         int err;
 343         int temp;
 344
 345         err = kstrtol(buf, 10, &val);
 346         if (err)
 347                 return err;
 348
 349         mutex_lock(&data->update_lock);
 350         if (nr == 2) {
 351                 if (data->remote_unsigned)
 352                         temp = TEMP8U_TO_REG(val - data->temp2_offset);
 353                 else
 354                         temp = TEMP8_TO_REG(val - data->temp2_offset);
 355         } else {
 356                 temp = TEMP8_TO_REG(val);
 357         }
 358         data->temp8[nr] = temp;
 359         i2c_smbus_write_byte_data(client, reg, temp);
 360         mutex_unlock(&data->update_lock);
 361         return count;
 362 }
 363
 364 static ssize_t show_temp11(struct device *dev, struct device_attribute *devattr,
 365                            char *buf)
 366 {
 367         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 368         struct lm63_data *data = lm63_update_device(dev);
 369         int nr = attr->index;
 370         int temp;
 371
 372         if (!nr) {
 373                 /*
 374                  * Use unsigned temperature unless its value is zero.
 375                  * If it is zero, use signed temperature.
 376                  */
 377                 if (data->temp11u)
 378                         temp = TEMP11_FROM_REG(data->temp11u);
 379                 else
 380                         temp = TEMP11_FROM_REG(data->temp11[nr]);
 381         } else {
 382                 if (data->remote_unsigned && nr == 2)
 383                         temp = TEMP11_FROM_REG((u16)data->temp11[nr]);
 384                 else
 385                         temp = TEMP11_FROM_REG(data->temp11[nr]);
 386         }
 387         return sprintf(buf, "%d\n", temp + data->temp2_offset);
 388 }
 389
 390 static ssize_t set_temp11(struct device *dev, struct device_attribute *devattr,
 391                           const char *buf, size_t count)
 392 {
 393         static const u8 reg[6] = {
 394                 LM63_REG_REMOTE_LOW_MSB,
 395                 LM63_REG_REMOTE_LOW_LSB,
 396                 LM63_REG_REMOTE_HIGH_MSB,
 397                 LM63_REG_REMOTE_HIGH_LSB,
 398                 LM63_REG_REMOTE_OFFSET_MSB,
 399                 LM63_REG_REMOTE_OFFSET_LSB,
 400         };
 401
 402         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 403         struct i2c_client *client = to_i2c_client(dev);
 404         struct lm63_data *data = i2c_get_clientdata(client);
 405         long val;
 406         int err;
 407         int nr = attr->index;
 408
 409         err = kstrtol(buf, 10, &val);
 410         if (err)
 411                 return err;
 412
 413         mutex_lock(&data->update_lock);
 414         if (data->remote_unsigned && nr == 2)
 415                 data->temp11[nr] = TEMP11U_TO_REG(val - data->temp2_offset);
 416         else
 417                 data->temp11[nr] = TEMP11_TO_REG(val - data->temp2_offset);
 418
 419         i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2],
 420                                   data->temp11[nr] >> 8);
 421         i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2 + 1],
 422                                   data->temp11[nr] & 0xff);
 423         mutex_unlock(&data->update_lock);
 424         return count;
 425 }
 426
 427 /*
 428  * Hysteresis register holds a relative value, while we want to present
 429  * an absolute to user-space
 430  */
 431 static ssize_t show_temp2_crit_hyst(struct device *dev,
 432                                     struct device_attribute *dummy, char *buf)
 433 {
 434         struct lm63_data *data = lm63_update_device(dev);
 435         return sprintf(buf, "%d\n", temp8_from_reg(data, 2)
 436                        + data->temp2_offset
 437                        - TEMP8_FROM_REG(data->temp2_crit_hyst));
 438 }
 439
 440 /*
 441  * And now the other way around, user-space provides an absolute
 442  * hysteresis value and we have to store a relative one
 443  */
 444 static ssize_t set_temp2_crit_hyst(struct device *dev,
 445                                    struct device_attribute *dummy,
 446                                    const char *buf, size_t count)
 447 {
 448         struct i2c_client *client = to_i2c_client(dev);
 449         struct lm63_data *data = i2c_get_clientdata(client);
 450         long val;
 451         int err;
 452         long hyst;
 453
 454         err = kstrtol(buf, 10, &val);
 455         if (err)
 456                 return err;
 457
 458         mutex_lock(&data->update_lock);
 459         hyst = temp8_from_reg(data, 2) + data->temp2_offset - val;
 460         i2c_smbus_write_byte_data(client, LM63_REG_REMOTE_TCRIT_HYST,
 461                                   HYST_TO_REG(hyst));
 462         mutex_unlock(&data->update_lock);
 463         return count;
 464 }
 465
 466 /*
 467  * Set conversion rate.
 468  * client->update_lock must be held when calling this function.
 469  */
 470 static void lm63_set_convrate(struct i2c_client *client, struct lm63_data *data,
 471                               unsigned int interval)
 472 {
 473         int i;
 474         unsigned int update_interval;
 475
 476         /* Shift calculations to avoid rounding errors */
 477         interval <<= 6;
 478
 479         /* find the nearest update rate */
 480         update_interval = (1 << (LM63_MAX_CONVRATE + 6)) * 1000
 481           / data->max_convrate_hz;
 482         for (i = 0; i < LM63_MAX_CONVRATE; i++, update_interval >>= 1)
 483                 if (interval >= update_interval * 3 / 4)
 484                         break;
 485
 486         i2c_smbus_write_byte_data(client, LM63_REG_CONVRATE, i);
 487         data->update_interval = UPDATE_INTERVAL(data->max_convrate_hz, i);
 488 }
 489
 490 static ssize_t show_update_interval(struct device *dev,
 491                                     struct device_attribute *attr, char *buf)
 492 {
 493         struct lm63_data *data = dev_get_drvdata(dev);
 494
 495         return sprintf(buf, "%u\n", data->update_interval);
 496 }
 497
 498 static ssize_t set_update_interval(struct device *dev,
 499                                    struct device_attribute *attr,
 500                                    const char *buf, size_t count)
 501 {
 502         struct i2c_client *client = to_i2c_client(dev);
 503         struct lm63_data *data = i2c_get_clientdata(client);
 504         unsigned long val;
 505         int err;
 506
 507         err = kstrtoul(buf, 10, &val);
 508         if (err)
 509                 return err;
 510
 511         mutex_lock(&data->update_lock);
 512         lm63_set_convrate(client, data, SENSORS_LIMIT(val, 0, 100000));
 513         mutex_unlock(&data->update_lock);
 514
 515         return count;
 516 }
 517
 518 static ssize_t show_type(struct device *dev, struct device_attribute *attr,
 519                          char *buf)
 520 {
 521         struct i2c_client *client = to_i2c_client(dev);
 522         struct lm63_data *data = i2c_get_clientdata(client);
 523
 524         return sprintf(buf, data->trutherm ? "1\n" : "2\n");
 525 }
 526
 527 static ssize_t set_type(struct device *dev, struct device_attribute *attr,
 528                         const char *buf, size_t count)
 529 {
 530         struct i2c_client *client = to_i2c_client(dev);
 531         struct lm63_data *data = i2c_get_clientdata(client);
 532         unsigned long val;
 533         int ret;
 534         u8 reg;
 535
 536         ret = kstrtoul(buf, 10, &val);
 537         if (ret < 0)
 538                 return ret;
 539         if (val != 1 && val != 2)
 540                 return -EINVAL;
 541
 542         mutex_lock(&data->update_lock);
 543         data->trutherm = val == 1;
 544         reg = i2c_smbus_read_byte_data(client, LM96163_REG_TRUTHERM) & ~0x02;
 545         i2c_smbus_write_byte_data(client, LM96163_REG_TRUTHERM,
 546                                   reg | (data->trutherm ? 0x02 : 0x00));
 547         data->valid = 0;
 548         mutex_unlock(&data->update_lock);
 549
 550         return count;
 551 }
 552
 553 static ssize_t show_alarms(struct device *dev, struct device_attribute *dummy,
 554                            char *buf)
 555 {
 556         struct lm63_data *data = lm63_update_device(dev);
 557         return sprintf(buf, "%u\n", data->alarms);
 558 }
 559
 560 static ssize_t show_alarm(struct device *dev, struct device_attribute *devattr,
 561                           char *buf)
 562 {
 563         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 564         struct lm63_data *data = lm63_update_device(dev);
 565         int bitnr = attr->index;
 566
 567         return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
 568 }
 569
 570 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
 571 static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR | S_IRUGO, show_fan,
 572         set_fan, 1);
 573
 574 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, show_pwm1, set_pwm1);
 575 static DEVICE_ATTR(pwm1_enable, S_IRUGO, show_pwm1_enable, NULL);
 576
 577 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_local_temp8, NULL, 0);
 578 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_local_temp8,
 579         set_temp8, 1);
 580
 581 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp11, NULL, 0);
 582 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp11,
 583         set_temp11, 1);
 584 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp11,
 585         set_temp11, 2);
 586 static SENSOR_DEVICE_ATTR(temp2_offset, S_IWUSR | S_IRUGO, show_temp11,
 587         set_temp11, 3);
 588 static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_remote_temp8,
 589         set_temp8, 2);
 590 static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp2_crit_hyst,
 591         set_temp2_crit_hyst);
 592
 593 static DEVICE_ATTR(temp2_type, S_IWUSR | S_IRUGO, show_type, set_type);
 594
 595 /* Individual alarm files */
 596 static SENSOR_DEVICE_ATTR(fan1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
 597 static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
 598 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
 599 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
 600 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
 601 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
 602 /* Raw alarm file for compatibility */
 603 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 604
 605 static DEVICE_ATTR(update_interval, S_IRUGO | S_IWUSR, show_update_interval,
 606                    set_update_interval);
 607
 608 static struct attribute *lm63_attributes[] = {
 609         &dev_attr_pwm1.attr,
 610         &dev_attr_pwm1_enable.attr,
 611         &sensor_dev_attr_temp1_input.dev_attr.attr,
 612         &sensor_dev_attr_temp2_input.dev_attr.attr,
 613         &sensor_dev_attr_temp2_min.dev_attr.attr,
 614         &sensor_dev_attr_temp1_max.dev_attr.attr,
 615         &sensor_dev_attr_temp2_max.dev_attr.attr,
 616         &sensor_dev_attr_temp2_offset.dev_attr.attr,
 617         &sensor_dev_attr_temp2_crit.dev_attr.attr,
 618         &dev_attr_temp2_crit_hyst.attr,
 619
 620         &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
 621         &sensor_dev_attr_temp2_fault.dev_attr.attr,
 622         &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
 623         &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
 624         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
 625         &dev_attr_alarms.attr,
 626         &dev_attr_update_interval.attr,
 627         NULL
 628 };
 629
 630 /*
 631  * On LM63, temp2_crit can be set only once, which should be job
 632  * of the bootloader.
 633  * On LM64, temp2_crit can always be set.
 634  * On LM96163, temp2_crit can be set if bit 1 of the configuration
 635  * register is true.
 636  */
 637 static umode_t lm63_attribute_mode(struct kobject *kobj,
 638                                    struct attribute *attr, int index)
 639 {
 640         struct device *dev = container_of(kobj, struct device, kobj);
 641         struct i2c_client *client = to_i2c_client(dev);
 642         struct lm63_data *data = i2c_get_clientdata(client);
 643
 644         if (attr == &sensor_dev_attr_temp2_crit.dev_attr.attr
 645             && (data->kind == lm64 ||
 646                 (data->kind == lm96163 && (data->config & 0x02))))
 647                 return attr->mode | S_IWUSR;
 648
 649         return attr->mode;
 650 }
 651
 652 static const struct attribute_group lm63_group = {
 653         .is_visible = lm63_attribute_mode,
 654         .attrs = lm63_attributes,
 655 };
 656
 657 static struct attribute *lm63_attributes_fan1[] = {
 658         &sensor_dev_attr_fan1_input.dev_attr.attr,
 659         &sensor_dev_attr_fan1_min.dev_attr.attr,
 660
 661         &sensor_dev_attr_fan1_min_alarm.dev_attr.attr,
 662         NULL
 663 };
 664
 665 static const struct attribute_group lm63_group_fan1 = {
 666         .attrs = lm63_attributes_fan1,
 667 };
 668
 669 /*
 670  * Real code
 671  */
 672
 673 /* Return 0 if detection is successful, -ENODEV otherwise */
 674 static int lm63_detect(struct i2c_client *new_client,
 675                        struct i2c_board_info *info)
 676 {
 677         struct i2c_adapter *adapter = new_client->adapter;
 678         u8 man_id, chip_id, reg_config1, reg_config2;
 679         u8 reg_alert_status, reg_alert_mask;
 680         int address = new_client->addr;
 681
 682         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 683                 return -ENODEV;
 684
 685         man_id = i2c_smbus_read_byte_data(new_client, LM63_REG_MAN_ID);
 686         chip_id = i2c_smbus_read_byte_data(new_client, LM63_REG_CHIP_ID);
 687
 688         reg_config1 = i2c_smbus_read_byte_data(new_client,
 689                       LM63_REG_CONFIG1);
 690         reg_config2 = i2c_smbus_read_byte_data(new_client,
 691                       LM63_REG_CONFIG2);
 692         reg_alert_status = i2c_smbus_read_byte_data(new_client,
 693                            LM63_REG_ALERT_STATUS);
 694         reg_alert_mask = i2c_smbus_read_byte_data(new_client,
 695                          LM63_REG_ALERT_MASK);
 696
 697         if (man_id != 0x01 /* National Semiconductor */
 698          || (reg_config1 & 0x18) != 0x00
 699          || (reg_config2 & 0xF8) != 0x00
 700          || (reg_alert_status & 0x20) != 0x00
 701          || (reg_alert_mask & 0xA4) != 0xA4) {
 702                 dev_dbg(&adapter->dev,
 703                         "Unsupported chip (man_id=0x%02X, chip_id=0x%02X)\n",
 704                         man_id, chip_id);
 705                 return -ENODEV;
 706         }
 707
 708         if (chip_id == 0x41 && address == 0x4c)
 709                 strlcpy(info->type, "lm63", I2C_NAME_SIZE);
 710         else if (chip_id == 0x51 && (address == 0x18 || address == 0x4e))
 711                 strlcpy(info->type, "lm64", I2C_NAME_SIZE);
 712         else if (chip_id == 0x49 && address == 0x4c)
 713                 strlcpy(info->type, "lm96163", I2C_NAME_SIZE);
 714         else
 715                 return -ENODEV;
 716
 717         return 0;
 718 }
 719
 720 static int lm63_probe(struct i2c_client *new_client,
 721                       const struct i2c_device_id *id)
 722 {
 723         struct lm63_data *data;
 724         int err;
 725
 726         data = kzalloc(sizeof(struct lm63_data), GFP_KERNEL);
 727         if (!data) {
 728                 err = -ENOMEM;
 729                 goto exit;
 730         }
 731
 732         i2c_set_clientdata(new_client, data);
 733         data->valid = 0;
 734         mutex_init(&data->update_lock);
 735
 736         /* Set the device type */
 737         data->kind = id->driver_data;
 738         if (data->kind == lm64)
 739                 data->temp2_offset = 16000;
 740
 741         /* Initialize chip */
 742         lm63_init_client(new_client);
 743
 744         /* Register sysfs hooks */
 745         err = sysfs_create_group(&new_client->dev.kobj, &lm63_group);
 746         if (err)
 747                 goto exit_free;
 748         if (data->config & 0x04) { /* tachometer enabled */
 749                 err = sysfs_create_group(&new_client->dev.kobj,
 750                                          &lm63_group_fan1);
 751                 if (err)
 752                         goto exit_remove_files;
 753         }
 754         if (data->kind == lm96163) {
 755                 err = device_create_file(&new_client->dev,
 756                                          &dev_attr_temp2_type);
 757                 if (err)
 758                         goto exit_remove_files;
 759         }
 760
 761         data->hwmon_dev = hwmon_device_register(&new_client->dev);
 762         if (IS_ERR(data->hwmon_dev)) {
 763                 err = PTR_ERR(data->hwmon_dev);
 764                 goto exit_remove_files;
 765         }
 766
 767         return 0;
 768
 769 exit_remove_files:
 770         device_remove_file(&new_client->dev, &dev_attr_temp2_type);
 771         sysfs_remove_group(&new_client->dev.kobj, &lm63_group);
 772         sysfs_remove_group(&new_client->dev.kobj, &lm63_group_fan1);
 773 exit_free:
 774         kfree(data);
 775 exit:
 776         return err;
 777 }
 778
 779 /*
 780  * Ideally we shouldn't have to initialize anything, since the BIOS
 781  * should have taken care of everything
 782  */
 783 static void lm63_init_client(struct i2c_client *client)
 784 {
 785         struct lm63_data *data = i2c_get_clientdata(client);
 786         u8 convrate;
 787
 788         data->config = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
 789         data->config_fan = i2c_smbus_read_byte_data(client,
 790                                                     LM63_REG_CONFIG_FAN);
 791
 792         /* Start converting if needed */
 793         if (data->config & 0x40) { /* standby */
 794                 dev_dbg(&client->dev, "Switching to operational mode\n");
 795                 data->config &= 0xA7;
 796                 i2c_smbus_write_byte_data(client, LM63_REG_CONFIG1,
 797                                           data->config);
 798         }
 799         /* Tachometer is always enabled on LM64 */
 800         if (data->kind == lm64)
 801                 data->config |= 0x04;
 802
 803         /* We may need pwm1_freq before ever updating the client data */
 804         data->pwm1_freq = i2c_smbus_read_byte_data(client, LM63_REG_PWM_FREQ);
 805         if (data->pwm1_freq == 0)
 806                 data->pwm1_freq = 1;
 807
 808         switch (data->kind) {
 809         case lm63:
 810         case lm64:
 811                 data->max_convrate_hz = LM63_MAX_CONVRATE_HZ;
 812                 break;
 813         case lm96163:
 814                 data->max_convrate_hz = LM96163_MAX_CONVRATE_HZ;
 815                 data->trutherm
 816                   = i2c_smbus_read_byte_data(client,
 817                                              LM96163_REG_TRUTHERM) & 0x02;
 818                 break;
 819         }
 820         convrate = i2c_smbus_read_byte_data(client, LM63_REG_CONVRATE);
 821         if (unlikely(convrate > LM63_MAX_CONVRATE))
 822                 convrate = LM63_MAX_CONVRATE;
 823         data->update_interval = UPDATE_INTERVAL(data->max_convrate_hz,
 824                                                 convrate);
 825
 826         /*
 827          * For LM96163, check if high resolution PWM
 828          * and unsigned temperature format is enabled.
 829          */
 830         if (data->kind == lm96163) {
 831                 u8 config_enhanced
 832                   = i2c_smbus_read_byte_data(client,
 833                                              LM96163_REG_CONFIG_ENHANCED);
 834                 if ((config_enhanced & 0x10)
 835                     && !(data->config_fan & 0x08) && data->pwm1_freq == 8)
 836                         data->pwm_highres = true;
 837                 if (config_enhanced & 0x08)
 838                         data->remote_unsigned = true;
 839         }
 840
 841         /* Show some debug info about the LM63 configuration */
 842         if (data->kind == lm63)
 843                 dev_dbg(&client->dev, "Alert/tach pin configured for %s\n",
 844                         (data->config & 0x04) ? "tachometer input" :
 845                         "alert output");
 846         dev_dbg(&client->dev, "PWM clock %s kHz, output frequency %u Hz\n",
 847                 (data->config_fan & 0x08) ? "1.4" : "360",
 848                 ((data->config_fan & 0x08) ? 700 : 180000) / data->pwm1_freq);
 849         dev_dbg(&client->dev, "PWM output active %s, %s mode\n",
 850                 (data->config_fan & 0x10) ? "low" : "high",
 851                 (data->config_fan & 0x20) ? "manual" : "auto");
 852 }
 853
 854 static int lm63_remove(struct i2c_client *client)
 855 {
 856         struct lm63_data *data = i2c_get_clientdata(client);
 857
 858         hwmon_device_unregister(data->hwmon_dev);
 859         device_remove_file(&client->dev, &dev_attr_temp2_type);
 860         sysfs_remove_group(&client->dev.kobj, &lm63_group);
 861         sysfs_remove_group(&client->dev.kobj, &lm63_group_fan1);
 862
 863         kfree(data);
 864         return 0;
 865 }
 866
 867 static struct lm63_data *lm63_update_device(struct device *dev)
 868 {
 869         struct i2c_client *client = to_i2c_client(dev);
 870         struct lm63_data *data = i2c_get_clientdata(client);
 871         unsigned long next_update;
 872
 873         mutex_lock(&data->update_lock);
 874
 875         next_update = data->last_updated
 876           + msecs_to_jiffies(data->update_interval) + 1;
 877
 878         if (time_after(jiffies, next_update) || !data->valid) {
 879                 if (data->config & 0x04) { /* tachometer enabled  */
 880                         /* order matters for fan1_input */
 881                         data->fan[0] = i2c_smbus_read_byte_data(client,
 882                                        LM63_REG_TACH_COUNT_LSB) & 0xFC;
 883                         data->fan[0] |= i2c_smbus_read_byte_data(client,
 884                                         LM63_REG_TACH_COUNT_MSB) << 8;
 885                         data->fan[1] = (i2c_smbus_read_byte_data(client,
 886                                         LM63_REG_TACH_LIMIT_LSB) & 0xFC)
 887                                      | (i2c_smbus_read_byte_data(client,
 888                                         LM63_REG_TACH_LIMIT_MSB) << 8);
 889                 }
 890
 891                 data->pwm1_freq = i2c_smbus_read_byte_data(client,
 892                                   LM63_REG_PWM_FREQ);
 893                 if (data->pwm1_freq == 0)
 894                         data->pwm1_freq = 1;
 895                 data->pwm1_value = i2c_smbus_read_byte_data(client,
 896                                    LM63_REG_PWM_VALUE);
 897
 898                 data->temp8[0] = i2c_smbus_read_byte_data(client,
 899                                  LM63_REG_LOCAL_TEMP);
 900                 data->temp8[1] = i2c_smbus_read_byte_data(client,
 901                                  LM63_REG_LOCAL_HIGH);
 902
 903                 /* order matters for temp2_input */
 904                 data->temp11[0] = i2c_smbus_read_byte_data(client,
 905                                   LM63_REG_REMOTE_TEMP_MSB) << 8;
 906                 data->temp11[0] |= i2c_smbus_read_byte_data(client,
 907                                    LM63_REG_REMOTE_TEMP_LSB);
 908                 data->temp11[1] = (i2c_smbus_read_byte_data(client,
 909                                   LM63_REG_REMOTE_LOW_MSB) << 8)
 910                                 | i2c_smbus_read_byte_data(client,
 911                                   LM63_REG_REMOTE_LOW_LSB);
 912                 data->temp11[2] = (i2c_smbus_read_byte_data(client,
 913                                   LM63_REG_REMOTE_HIGH_MSB) << 8)
 914                                 | i2c_smbus_read_byte_data(client,
 915                                   LM63_REG_REMOTE_HIGH_LSB);
 916                 data->temp11[3] = (i2c_smbus_read_byte_data(client,
 917                                   LM63_REG_REMOTE_OFFSET_MSB) << 8)
 918                                 | i2c_smbus_read_byte_data(client,
 919                                   LM63_REG_REMOTE_OFFSET_LSB);
 920
 921                 if (data->kind == lm96163)
 922                         data->temp11u = (i2c_smbus_read_byte_data(client,
 923                                         LM96163_REG_REMOTE_TEMP_U_MSB) << 8)
 924                                       | i2c_smbus_read_byte_data(client,
 925                                         LM96163_REG_REMOTE_TEMP_U_LSB);
 926
 927                 data->temp8[2] = i2c_smbus_read_byte_data(client,
 928                                  LM63_REG_REMOTE_TCRIT);
 929                 data->temp2_crit_hyst = i2c_smbus_read_byte_data(client,
 930                                         LM63_REG_REMOTE_TCRIT_HYST);
 931
 932                 data->alarms = i2c_smbus_read_byte_data(client,
 933                                LM63_REG_ALERT_STATUS) & 0x7F;
 934
 935                 data->last_updated = jiffies;
 936                 data->valid = 1;
 937         }
 938
 939         mutex_unlock(&data->update_lock);
 940
 941         return data;
 942 }
 943
 944 static int __init sensors_lm63_init(void)
 945 {
 946         return i2c_add_driver(&lm63_driver);
 947 }
 948
 949 static void __exit sensors_lm63_exit(void)
 950 {
 951         i2c_del_driver(&lm63_driver);
 952 }
 953
 954 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
 955 MODULE_DESCRIPTION("LM63 driver");
 956 MODULE_LICENSE("GPL");
 957
 958 module_init(sensors_lm63_init);
 959 module_exit(sensors_lm63_exit);