drivers/hwmon/max1619.c

   1 /*
   2  * max1619.c - Part of lm_sensors, Linux kernel modules for hardware
   3  *             monitoring
   4  * Copyright (C) 2003-2004 Alexey Fisher <fishor@mail.ru>
   5  *                         Jean Delvare <khali@linux-fr.org>
   6  *
   7  * Based on the lm90 driver. The MAX1619 is a sensor chip made by Maxim.
   8  * It reports up to two temperatures (its own plus up to
   9  * one external one). Complete datasheet can be
  10  * obtained from Maxim's website at:
  11  *   http://pdfserv.maxim-ic.com/en/ds/MAX1619.pdf
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  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
  29 #include <linux/module.h>
  30 #include <linux/init.h>
  31 #include <linux/slab.h>
  32 #include <linux/jiffies.h>
  33 #include <linux/i2c.h>
  34 #include <linux/hwmon.h>
  35 #include <linux/hwmon-sysfs.h>
  36 #include <linux/err.h>
  37 #include <linux/mutex.h>
  38 #include <linux/sysfs.h>
  39
  40 static const unsigned short normal_i2c[] = {
  41         0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END };
  42
  43 /*
  44  * Insmod parameters
  45  */
  46
  47 I2C_CLIENT_INSMOD_1(max1619);
  48
  49 /*
  50  * The MAX1619 registers
  51  */
  52
  53 #define MAX1619_REG_R_MAN_ID            0xFE
  54 #define MAX1619_REG_R_CHIP_ID           0xFF
  55 #define MAX1619_REG_R_CONFIG            0x03
  56 #define MAX1619_REG_W_CONFIG            0x09
  57 #define MAX1619_REG_R_CONVRATE          0x04
  58 #define MAX1619_REG_W_CONVRATE          0x0A
  59 #define MAX1619_REG_R_STATUS            0x02
  60 #define MAX1619_REG_R_LOCAL_TEMP        0x00
  61 #define MAX1619_REG_R_REMOTE_TEMP       0x01
  62 #define MAX1619_REG_R_REMOTE_HIGH       0x07
  63 #define MAX1619_REG_W_REMOTE_HIGH       0x0D
  64 #define MAX1619_REG_R_REMOTE_LOW        0x08
  65 #define MAX1619_REG_W_REMOTE_LOW        0x0E
  66 #define MAX1619_REG_R_REMOTE_CRIT       0x10
  67 #define MAX1619_REG_W_REMOTE_CRIT       0x12
  68 #define MAX1619_REG_R_TCRIT_HYST        0x11
  69 #define MAX1619_REG_W_TCRIT_HYST        0x13
  70
  71 /*
  72  * Conversions and various macros
  73  */
  74
  75 #define TEMP_FROM_REG(val)      ((val & 0x80 ? val-0x100 : val) * 1000)
  76 #define TEMP_TO_REG(val)        ((val < 0 ? val+0x100*1000 : val) / 1000)
  77
  78 /*
  79  * Functions declaration
  80  */
  81
  82 static int max1619_attach_adapter(struct i2c_adapter *adapter);
  83 static int max1619_detect(struct i2c_adapter *adapter, int address,
  84         int kind);
  85 static void max1619_init_client(struct i2c_client *client);
  86 static int max1619_detach_client(struct i2c_client *client);
  87 static struct max1619_data *max1619_update_device(struct device *dev);
  88
  89 /*
  90  * Driver data (common to all clients)
  91  */
  92
  93 static struct i2c_driver max1619_driver = {
  94         .driver = {
  95                 .name   = "max1619",
  96         },
  97         .attach_adapter = max1619_attach_adapter,
  98         .detach_client  = max1619_detach_client,
  99 };
 100
 101 /*
 102  * Client data (each client gets its own)
 103  */
 104
 105 struct max1619_data {
 106         struct i2c_client client;
 107         struct device *hwmon_dev;
 108         struct mutex update_lock;
 109         char valid; /* zero until following fields are valid */
 110         unsigned long last_updated; /* in jiffies */
 111
 112         /* registers values */
 113         u8 temp_input1; /* local */
 114         u8 temp_input2, temp_low2, temp_high2; /* remote */
 115         u8 temp_crit2;
 116         u8 temp_hyst2;
 117         u8 alarms;
 118 };
 119
 120 /*
 121  * Sysfs stuff
 122  */
 123
 124 #define show_temp(value) \
 125 static ssize_t show_##value(struct device *dev, struct device_attribute *attr, char *buf) \
 126 { \
 127         struct max1619_data *data = max1619_update_device(dev); \
 128         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->value)); \
 129 }
 130 show_temp(temp_input1);
 131 show_temp(temp_input2);
 132 show_temp(temp_low2);
 133 show_temp(temp_high2);
 134 show_temp(temp_crit2);
 135 show_temp(temp_hyst2);
 136
 137 #define set_temp2(value, reg) \
 138 static ssize_t set_##value(struct device *dev, struct device_attribute *attr, const char *buf, \
 139         size_t count) \
 140 { \
 141         struct i2c_client *client = to_i2c_client(dev); \
 142         struct max1619_data *data = i2c_get_clientdata(client); \
 143         long val = simple_strtol(buf, NULL, 10); \
 144  \
 145         mutex_lock(&data->update_lock); \
 146         data->value = TEMP_TO_REG(val); \
 147         i2c_smbus_write_byte_data(client, reg, data->value); \
 148         mutex_unlock(&data->update_lock); \
 149         return count; \
 150 }
 151
 152 set_temp2(temp_low2, MAX1619_REG_W_REMOTE_LOW);
 153 set_temp2(temp_high2, MAX1619_REG_W_REMOTE_HIGH);
 154 set_temp2(temp_crit2, MAX1619_REG_W_REMOTE_CRIT);
 155 set_temp2(temp_hyst2, MAX1619_REG_W_TCRIT_HYST);
 156
 157 static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
 158 {
 159         struct max1619_data *data = max1619_update_device(dev);
 160         return sprintf(buf, "%d\n", data->alarms);
 161 }
 162
 163 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
 164                           char *buf)
 165 {
 166         int bitnr = to_sensor_dev_attr(attr)->index;
 167         struct max1619_data *data = max1619_update_device(dev);
 168         return sprintf(buf, "%d\n", (data->alarms >> bitnr) & 1);
 169 }
 170
 171 static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input1, NULL);
 172 static DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_input2, NULL);
 173 static DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_low2,
 174         set_temp_low2);
 175 static DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_high2,
 176         set_temp_high2);
 177 static DEVICE_ATTR(temp2_crit, S_IWUSR | S_IRUGO, show_temp_crit2,
 178         set_temp_crit2);
 179 static DEVICE_ATTR(temp2_crit_hyst, S_IWUSR | S_IRUGO, show_temp_hyst2,
 180         set_temp_hyst2);
 181 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 182 static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
 183 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
 184 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
 185 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
 186
 187 static struct attribute *max1619_attributes[] = {
 188         &dev_attr_temp1_input.attr,
 189         &dev_attr_temp2_input.attr,
 190         &dev_attr_temp2_min.attr,
 191         &dev_attr_temp2_max.attr,
 192         &dev_attr_temp2_crit.attr,
 193         &dev_attr_temp2_crit_hyst.attr,
 194
 195         &dev_attr_alarms.attr,
 196         &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
 197         &sensor_dev_attr_temp2_fault.dev_attr.attr,
 198         &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
 199         &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
 200         NULL
 201 };
 202
 203 static const struct attribute_group max1619_group = {
 204         .attrs = max1619_attributes,
 205 };
 206
 207 /*
 208  * Real code
 209  */
 210
 211 static int max1619_attach_adapter(struct i2c_adapter *adapter)
 212 {
 213         if (!(adapter->class & I2C_CLASS_HWMON))
 214                 return 0;
 215         return i2c_probe(adapter, &addr_data, max1619_detect);
 216 }
 217
 218 /*
 219  * The following function does more than just detection. If detection
 220  * succeeds, it also registers the new chip.
 221  */
 222 static int max1619_detect(struct i2c_adapter *adapter, int address, int kind)
 223 {
 224         struct i2c_client *new_client;
 225         struct max1619_data *data;
 226         int err = 0;
 227         const char *name = "";
 228         u8 reg_config=0, reg_convrate=0, reg_status=0;
 229
 230         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 231                 goto exit;
 232
 233         if (!(data = kzalloc(sizeof(struct max1619_data), GFP_KERNEL))) {
 234                 err = -ENOMEM;
 235                 goto exit;
 236         }
 237
 238         /* The common I2C client data is placed right before the
 239            MAX1619-specific data. */
 240         new_client = &data->client;
 241         i2c_set_clientdata(new_client, data);
 242         new_client->addr = address;
 243         new_client->adapter = adapter;
 244         new_client->driver = &max1619_driver;
 245         new_client->flags = 0;
 246
 247         /*
 248          * Now we do the remaining detection. A negative kind means that
 249          * the driver was loaded with no force parameter (default), so we
 250          * must both detect and identify the chip. A zero kind means that
 251          * the driver was loaded with the force parameter, the detection
 252          * step shall be skipped. A positive kind means that the driver
 253          * was loaded with the force parameter and a given kind of chip is
 254          * requested, so both the detection and the identification steps
 255          * are skipped.
 256          */
 257         if (kind < 0) { /* detection */
 258                 reg_config = i2c_smbus_read_byte_data(new_client,
 259                               MAX1619_REG_R_CONFIG);
 260                 reg_convrate = i2c_smbus_read_byte_data(new_client,
 261                                MAX1619_REG_R_CONVRATE);
 262                 reg_status = i2c_smbus_read_byte_data(new_client,
 263                                 MAX1619_REG_R_STATUS);
 264                 if ((reg_config & 0x03) != 0x00
 265                  || reg_convrate > 0x07 || (reg_status & 0x61 ) !=0x00) {
 266                         dev_dbg(&adapter->dev,
 267                                 "MAX1619 detection failed at 0x%02x.\n",
 268                                 address);
 269                         goto exit_free;
 270                 }
 271         }
 272
 273         if (kind <= 0) { /* identification */
 274                 u8 man_id, chip_id;
 275
 276                 man_id = i2c_smbus_read_byte_data(new_client,
 277                          MAX1619_REG_R_MAN_ID);
 278                 chip_id = i2c_smbus_read_byte_data(new_client,
 279                           MAX1619_REG_R_CHIP_ID);
 280
 281                 if ((man_id == 0x4D) && (chip_id == 0x04))
 282                         kind = max1619;
 283
 284                 if (kind <= 0) { /* identification failed */
 285                         dev_info(&adapter->dev,
 286                             "Unsupported chip (man_id=0x%02X, "
 287                             "chip_id=0x%02X).\n", man_id, chip_id);
 288                         goto exit_free;
 289                 }
 290         }
 291
 292         if (kind == max1619)
 293                 name = "max1619";
 294
 295         /* We can fill in the remaining client fields */
 296         strlcpy(new_client->name, name, I2C_NAME_SIZE);
 297         data->valid = 0;
 298         mutex_init(&data->update_lock);
 299
 300         /* Tell the I2C layer a new client has arrived */
 301         if ((err = i2c_attach_client(new_client)))
 302                 goto exit_free;
 303
 304         /* Initialize the MAX1619 chip */
 305         max1619_init_client(new_client);
 306
 307         /* Register sysfs hooks */
 308         if ((err = sysfs_create_group(&new_client->dev.kobj, &max1619_group)))
 309                 goto exit_detach;
 310
 311         data->hwmon_dev = hwmon_device_register(&new_client->dev);
 312         if (IS_ERR(data->hwmon_dev)) {
 313                 err = PTR_ERR(data->hwmon_dev);
 314                 goto exit_remove_files;
 315         }
 316
 317         return 0;
 318
 319 exit_remove_files:
 320         sysfs_remove_group(&new_client->dev.kobj, &max1619_group);
 321 exit_detach:
 322         i2c_detach_client(new_client);
 323 exit_free:
 324         kfree(data);
 325 exit:
 326         return err;
 327 }
 328
 329 static void max1619_init_client(struct i2c_client *client)
 330 {
 331         u8 config;
 332
 333         /*
 334          * Start the conversions.
 335          */
 336         i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONVRATE,
 337                                   5); /* 2 Hz */
 338         config = i2c_smbus_read_byte_data(client, MAX1619_REG_R_CONFIG);
 339         if (config & 0x40)
 340                 i2c_smbus_write_byte_data(client, MAX1619_REG_W_CONFIG,
 341                                           config & 0xBF); /* run */
 342 }
 343
 344 static int max1619_detach_client(struct i2c_client *client)
 345 {
 346         struct max1619_data *data = i2c_get_clientdata(client);
 347         int err;
 348
 349         hwmon_device_unregister(data->hwmon_dev);
 350         sysfs_remove_group(&client->dev.kobj, &max1619_group);
 351
 352         if ((err = i2c_detach_client(client)))
 353                 return err;
 354
 355         kfree(data);
 356         return 0;
 357 }
 358
 359 static struct max1619_data *max1619_update_device(struct device *dev)
 360 {
 361         struct i2c_client *client = to_i2c_client(dev);
 362         struct max1619_data *data = i2c_get_clientdata(client);
 363
 364         mutex_lock(&data->update_lock);
 365
 366         if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
 367                 dev_dbg(&client->dev, "Updating max1619 data.\n");
 368                 data->temp_input1 = i2c_smbus_read_byte_data(client,
 369                                         MAX1619_REG_R_LOCAL_TEMP);
 370                 data->temp_input2 = i2c_smbus_read_byte_data(client,
 371                                         MAX1619_REG_R_REMOTE_TEMP);
 372                 data->temp_high2 = i2c_smbus_read_byte_data(client,
 373                                         MAX1619_REG_R_REMOTE_HIGH);
 374                 data->temp_low2 = i2c_smbus_read_byte_data(client,
 375                                         MAX1619_REG_R_REMOTE_LOW);
 376                 data->temp_crit2 = i2c_smbus_read_byte_data(client,
 377                                         MAX1619_REG_R_REMOTE_CRIT);
 378                 data->temp_hyst2 = i2c_smbus_read_byte_data(client,
 379                                         MAX1619_REG_R_TCRIT_HYST);
 380                 data->alarms = i2c_smbus_read_byte_data(client,
 381                                         MAX1619_REG_R_STATUS);
 382
 383                 data->last_updated = jiffies;
 384                 data->valid = 1;
 385         }
 386
 387         mutex_unlock(&data->update_lock);
 388
 389         return data;
 390 }
 391
 392 static int __init sensors_max1619_init(void)
 393 {
 394         return i2c_add_driver(&max1619_driver);
 395 }
 396
 397 static void __exit sensors_max1619_exit(void)
 398 {
 399         i2c_del_driver(&max1619_driver);
 400 }
 401
 402 MODULE_AUTHOR("Alexey Fisher <fishor@mail.ru> and "
 403         "Jean Delvare <khali@linux-fr.org>");
 404 MODULE_DESCRIPTION("MAX1619 sensor driver");
 405 MODULE_LICENSE("GPL");
 406
 407 module_init(sensors_max1619_init);
 408 module_exit(sensors_max1619_exit);