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