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