drivers/i2c/chips/adm1021.c

   1 /*
   2     adm1021.c - Part of lm_sensors, Linux kernel modules for hardware
   3              monitoring
   4     Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl> and
   5     Philip Edelbrock <phil@netroedge.com>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include <linux/config.h>
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/slab.h>
  26 #include <linux/i2c.h>
  27 #include <linux/i2c-sensor.h>
  28
  29
  30 /* Registers */
  31 #define ADM1021_SYSCTL_TEMP             1200
  32 #define ADM1021_SYSCTL_REMOTE_TEMP      1201
  33 #define ADM1021_SYSCTL_DIE_CODE         1202
  34 #define ADM1021_SYSCTL_ALARMS           1203
  35
  36 #define ADM1021_ALARM_TEMP_HIGH         0x40
  37 #define ADM1021_ALARM_TEMP_LOW          0x20
  38 #define ADM1021_ALARM_RTEMP_HIGH        0x10
  39 #define ADM1021_ALARM_RTEMP_LOW         0x08
  40 #define ADM1021_ALARM_RTEMP_NA          0x04
  41
  42 /* Addresses to scan */
  43 static unsigned short normal_i2c[] = { 0x18, 0x19, 0x1a,
  44                                         0x29, 0x2a, 0x2b,
  45                                         0x4c, 0x4d, 0x4e,
  46                                         I2C_CLIENT_END };
  47 static unsigned int normal_isa[] = { I2C_CLIENT_ISA_END };
  48
  49 /* Insmod parameters */
  50 SENSORS_INSMOD_8(adm1021, adm1023, max1617, max1617a, thmc10, lm84, gl523sm, mc1066);
  51
  52 /* adm1021 constants specified below */
  53
  54 /* The adm1021 registers */
  55 /* Read-only */
  56 #define ADM1021_REG_TEMP                0x00
  57 #define ADM1021_REG_REMOTE_TEMP         0x01
  58 #define ADM1021_REG_STATUS              0x02
  59 #define ADM1021_REG_MAN_ID              0x0FE   /* 0x41 = AMD, 0x49 = TI, 0x4D = Maxim, 0x23 = Genesys , 0x54 = Onsemi*/
  60 #define ADM1021_REG_DEV_ID              0x0FF   /* ADM1021 = 0x0X, ADM1023 = 0x3X */
  61 #define ADM1021_REG_DIE_CODE            0x0FF   /* MAX1617A */
  62 /* These use different addresses for reading/writing */
  63 #define ADM1021_REG_CONFIG_R            0x03
  64 #define ADM1021_REG_CONFIG_W            0x09
  65 #define ADM1021_REG_CONV_RATE_R         0x04
  66 #define ADM1021_REG_CONV_RATE_W         0x0A
  67 /* These are for the ADM1023's additional precision on the remote temp sensor */
  68 #define ADM1021_REG_REM_TEMP_PREC       0x010
  69 #define ADM1021_REG_REM_OFFSET          0x011
  70 #define ADM1021_REG_REM_OFFSET_PREC     0x012
  71 #define ADM1021_REG_REM_TOS_PREC        0x013
  72 #define ADM1021_REG_REM_THYST_PREC      0x014
  73 /* limits */
  74 #define ADM1021_REG_TOS_R               0x05
  75 #define ADM1021_REG_TOS_W               0x0B
  76 #define ADM1021_REG_REMOTE_TOS_R        0x07
  77 #define ADM1021_REG_REMOTE_TOS_W        0x0D
  78 #define ADM1021_REG_THYST_R             0x06
  79 #define ADM1021_REG_THYST_W             0x0C
  80 #define ADM1021_REG_REMOTE_THYST_R      0x08
  81 #define ADM1021_REG_REMOTE_THYST_W      0x0E
  82 /* write-only */
  83 #define ADM1021_REG_ONESHOT             0x0F
  84
  85
  86 /* Conversions. Rounding and limit checking is only done on the TO_REG
  87    variants. Note that you should be a bit careful with which arguments
  88    these macros are called: arguments may be evaluated more than once.
  89    Fixing this is just not worth it. */
  90 /* Conversions  note: 1021 uses normal integer signed-byte format*/
  91 #define TEMP_FROM_REG(val)      (val > 127 ? (val-256)*1000 : val*1000)
  92 #define TEMP_TO_REG(val)        (SENSORS_LIMIT((val < 0 ? (val/1000)+256 : val/1000),0,255))
  93
  94 /* Initial values */
  95
  96 /* Note: Even though I left the low and high limits named os and hyst,
  97 they don't quite work like a thermostat the way the LM75 does.  I.e.,
  98 a lower temp than THYST actually triggers an alarm instead of
  99 clearing it.  Weird, ey?   --Phil  */
 100
 101 /* Each client has this additional data */
 102 struct adm1021_data {
 103         struct i2c_client client;
 104         enum chips type;
 105
 106         struct semaphore update_lock;
 107         char valid;             /* !=0 if following fields are valid */
 108         unsigned long last_updated;     /* In jiffies */
 109
 110         u8      temp_max;       /* Register values */
 111         u8      temp_hyst;
 112         u8      temp_input;
 113         u8      remote_temp_max;
 114         u8      remote_temp_hyst;
 115         u8      remote_temp_input;
 116         u8      alarms;
 117         /* special values for ADM1021 only */
 118         u8      die_code;
 119         /* Special values for ADM1023 only */
 120         u8      remote_temp_prec;
 121         u8      remote_temp_os_prec;
 122         u8      remote_temp_hyst_prec;
 123         u8      remote_temp_offset;
 124         u8      remote_temp_offset_prec;
 125 };
 126
 127 static int adm1021_attach_adapter(struct i2c_adapter *adapter);
 128 static int adm1021_detect(struct i2c_adapter *adapter, int address, int kind);
 129 static void adm1021_init_client(struct i2c_client *client);
 130 static int adm1021_detach_client(struct i2c_client *client);
 131 static int adm1021_read_value(struct i2c_client *client, u8 reg);
 132 static int adm1021_write_value(struct i2c_client *client, u8 reg,
 133                                u16 value);
 134 static struct adm1021_data *adm1021_update_device(struct device *dev);
 135
 136 /* (amalysh) read only mode, otherwise any limit's writing confuse BIOS */
 137 static int read_only = 0;
 138
 139
 140 /* This is the driver that will be inserted */
 141 static struct i2c_driver adm1021_driver = {
 142         .owner          = THIS_MODULE,
 143         .name           = "adm1021",
 144         .id             = I2C_DRIVERID_ADM1021,
 145         .flags          = I2C_DF_NOTIFY,
 146         .attach_adapter = adm1021_attach_adapter,
 147         .detach_client  = adm1021_detach_client,
 148 };
 149
 150 static int adm1021_id;
 151
 152 #define show(value)     \
 153 static ssize_t show_##value(struct device *dev, char *buf)              \
 154 {                                                                       \
 155         struct adm1021_data *data = adm1021_update_device(dev);         \
 156         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->value));        \
 157 }
 158 show(temp_max);
 159 show(temp_hyst);
 160 show(temp_input);
 161 show(remote_temp_max);
 162 show(remote_temp_hyst);
 163 show(remote_temp_input);
 164
 165 #define show2(value)    \
 166 static ssize_t show_##value(struct device *dev, char *buf)              \
 167 {                                                                       \
 168         struct adm1021_data *data = adm1021_update_device(dev);         \
 169         return sprintf(buf, "%d\n", data->value);                       \
 170 }
 171 show2(alarms);
 172 show2(die_code);
 173
 174 #define set(value, reg) \
 175 static ssize_t set_##value(struct device *dev, const char *buf, size_t count)   \
 176 {                                                               \
 177         struct i2c_client *client = to_i2c_client(dev);         \
 178         struct adm1021_data *data = i2c_get_clientdata(client); \
 179         int temp = simple_strtoul(buf, NULL, 10);               \
 180                                                                 \
 181         data->value = TEMP_TO_REG(temp);                        \
 182         adm1021_write_value(client, reg, data->value);          \
 183         return count;                                           \
 184 }
 185 set(temp_max, ADM1021_REG_TOS_W);
 186 set(temp_hyst, ADM1021_REG_THYST_W);
 187 set(remote_temp_max, ADM1021_REG_REMOTE_TOS_W);
 188 set(remote_temp_hyst, ADM1021_REG_REMOTE_THYST_W);
 189
 190 static DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max, set_temp_max);
 191 static DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_hyst, set_temp_hyst);
 192 static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input, NULL);
 193 static DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_remote_temp_max, set_remote_temp_max);
 194 static DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_remote_temp_hyst, set_remote_temp_hyst);
 195 static DEVICE_ATTR(temp2_input, S_IRUGO, show_remote_temp_input, NULL);
 196 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 197 static DEVICE_ATTR(die_code, S_IRUGO, show_die_code, NULL);
 198
 199
 200 static int adm1021_attach_adapter(struct i2c_adapter *adapter)
 201 {
 202         if (!(adapter->class & I2C_CLASS_HWMON))
 203                 return 0;
 204         return i2c_detect(adapter, &addr_data, adm1021_detect);
 205 }
 206
 207 static int adm1021_detect(struct i2c_adapter *adapter, int address, int kind)
 208 {
 209         int i;
 210         struct i2c_client *new_client;
 211         struct adm1021_data *data;
 212         int err = 0;
 213         const char *type_name = "";
 214
 215         /* Make sure we aren't probing the ISA bus!! This is just a safety check
 216            at this moment; i2c_detect really won't call us. */
 217 #ifdef DEBUG
 218         if (i2c_is_isa_adapter(adapter)) {
 219                 dev_dbg(&adapter->dev, "adm1021_detect called for an ISA bus adapter?!?\n");
 220                 return 0;
 221         }
 222 #endif
 223
 224         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 225                 goto error0;
 226
 227         /* OK. For now, we presume we have a valid client. We now create the
 228            client structure, even though we cannot fill it completely yet.
 229            But it allows us to access adm1021_{read,write}_value. */
 230
 231         if (!(data = kmalloc(sizeof(struct adm1021_data), GFP_KERNEL))) {
 232                 err = -ENOMEM;
 233                 goto error0;
 234         }
 235         memset(data, 0, sizeof(struct adm1021_data));
 236
 237         new_client = &data->client;
 238         i2c_set_clientdata(new_client, data);
 239         new_client->addr = address;
 240         new_client->adapter = adapter;
 241         new_client->driver = &adm1021_driver;
 242         new_client->flags = 0;
 243
 244         /* Now, we do the remaining detection. */
 245         if (kind < 0) {
 246                 if ((adm1021_read_value(new_client, ADM1021_REG_STATUS) & 0x03) != 0x00
 247                  || (adm1021_read_value(new_client, ADM1021_REG_CONFIG_R) & 0x3F) != 0x00
 248                  || (adm1021_read_value(new_client, ADM1021_REG_CONV_RATE_R) & 0xF8) != 0x00) {
 249                         err = -ENODEV;
 250                         goto error1;
 251                 }
 252         }
 253
 254         /* Determine the chip type. */
 255         if (kind <= 0) {
 256                 i = adm1021_read_value(new_client, ADM1021_REG_MAN_ID);
 257                 if (i == 0x41)
 258                         if ((adm1021_read_value(new_client, ADM1021_REG_DEV_ID) & 0x0F0) == 0x030)
 259                                 kind = adm1023;
 260                         else
 261                                 kind = adm1021;
 262                 else if (i == 0x49)
 263                         kind = thmc10;
 264                 else if (i == 0x23)
 265                         kind = gl523sm;
 266                 else if ((i == 0x4d) &&
 267                          (adm1021_read_value(new_client, ADM1021_REG_DEV_ID) == 0x01))
 268                         kind = max1617a;
 269                 else if (i == 0x54)
 270                         kind = mc1066;
 271                 /* LM84 Mfr ID in a different place, and it has more unused bits */
 272                 else if (adm1021_read_value(new_client, ADM1021_REG_CONV_RATE_R) == 0x00
 273                       && (kind == 0 /* skip extra detection */
 274                        || ((adm1021_read_value(new_client, ADM1021_REG_CONFIG_R) & 0x7F) == 0x00
 275                         && (adm1021_read_value(new_client, ADM1021_REG_STATUS) & 0xAB) == 0x00)))
 276                         kind = lm84;
 277                 else
 278                         kind = max1617;
 279         }
 280
 281         if (kind == max1617) {
 282                 type_name = "max1617";
 283         } else if (kind == max1617a) {
 284                 type_name = "max1617a";
 285         } else if (kind == adm1021) {
 286                 type_name = "adm1021";
 287         } else if (kind == adm1023) {
 288                 type_name = "adm1023";
 289         } else if (kind == thmc10) {
 290                 type_name = "thmc10";
 291         } else if (kind == lm84) {
 292                 type_name = "lm84";
 293         } else if (kind == gl523sm) {
 294                 type_name = "gl523sm";
 295         } else if (kind == mc1066) {
 296                 type_name = "mc1066";
 297         }
 298
 299         /* Fill in the remaining client fields and put it into the global list */
 300         strlcpy(new_client->name, type_name, I2C_NAME_SIZE);
 301         data->type = kind;
 302
 303         new_client->id = adm1021_id++;
 304         data->valid = 0;
 305         init_MUTEX(&data->update_lock);
 306
 307         /* Tell the I2C layer a new client has arrived */
 308         if ((err = i2c_attach_client(new_client)))
 309                 goto error1;
 310
 311         /* Initialize the ADM1021 chip */
 312         if (kind != lm84)
 313                 adm1021_init_client(new_client);
 314
 315         /* Register sysfs hooks */
 316         device_create_file(&new_client->dev, &dev_attr_temp1_max);
 317         device_create_file(&new_client->dev, &dev_attr_temp1_min);
 318         device_create_file(&new_client->dev, &dev_attr_temp1_input);
 319         device_create_file(&new_client->dev, &dev_attr_temp2_max);
 320         device_create_file(&new_client->dev, &dev_attr_temp2_min);
 321         device_create_file(&new_client->dev, &dev_attr_temp2_input);
 322         device_create_file(&new_client->dev, &dev_attr_alarms);
 323         if (data->type == adm1021)
 324                 device_create_file(&new_client->dev, &dev_attr_die_code);
 325
 326         return 0;
 327
 328 error1:
 329         kfree(data);
 330 error0:
 331         return err;
 332 }
 333
 334 static void adm1021_init_client(struct i2c_client *client)
 335 {
 336         /* Enable ADC and disable suspend mode */
 337         adm1021_write_value(client, ADM1021_REG_CONFIG_W,
 338                 adm1021_read_value(client, ADM1021_REG_CONFIG_R) & 0xBF);
 339         /* Set Conversion rate to 1/sec (this can be tinkered with) */
 340         adm1021_write_value(client, ADM1021_REG_CONV_RATE_W, 0x04);
 341 }
 342
 343 static int adm1021_detach_client(struct i2c_client *client)
 344 {
 345         int err;
 346
 347         if ((err = i2c_detach_client(client))) {
 348                 dev_err(&client->dev, "Client deregistration failed, client not detached.\n");
 349                 return err;
 350         }
 351
 352         kfree(i2c_get_clientdata(client));
 353         return 0;
 354 }
 355
 356 /* All registers are byte-sized */
 357 static int adm1021_read_value(struct i2c_client *client, u8 reg)
 358 {
 359         return i2c_smbus_read_byte_data(client, reg);
 360 }
 361
 362 static int adm1021_write_value(struct i2c_client *client, u8 reg, u16 value)
 363 {
 364         if (!read_only)
 365                 return i2c_smbus_write_byte_data(client, reg, value);
 366         return 0;
 367 }
 368
 369 static struct adm1021_data *adm1021_update_device(struct device *dev)
 370 {
 371         struct i2c_client *client = to_i2c_client(dev);
 372         struct adm1021_data *data = i2c_get_clientdata(client);
 373
 374         down(&data->update_lock);
 375
 376         if ((jiffies - data->last_updated > HZ + HZ / 2) ||
 377             (jiffies < data->last_updated) || !data->valid) {
 378                 dev_dbg(&client->dev, "Starting adm1021 update\n");
 379
 380                 data->temp_input = adm1021_read_value(client, ADM1021_REG_TEMP);
 381                 data->temp_max = adm1021_read_value(client, ADM1021_REG_TOS_R);
 382                 data->temp_hyst = adm1021_read_value(client, ADM1021_REG_THYST_R);
 383                 data->remote_temp_input = adm1021_read_value(client, ADM1021_REG_REMOTE_TEMP);
 384                 data->remote_temp_max = adm1021_read_value(client, ADM1021_REG_REMOTE_TOS_R);
 385                 data->remote_temp_hyst = adm1021_read_value(client, ADM1021_REG_REMOTE_THYST_R);
 386                 data->alarms = adm1021_read_value(client, ADM1021_REG_STATUS) & 0xec;
 387                 if (data->type == adm1021)
 388                         data->die_code = adm1021_read_value(client, ADM1021_REG_DIE_CODE);
 389                 if (data->type == adm1023) {
 390                         data->remote_temp_prec = adm1021_read_value(client, ADM1021_REG_REM_TEMP_PREC);
 391                         data->remote_temp_os_prec = adm1021_read_value(client, ADM1021_REG_REM_TOS_PREC);
 392                         data->remote_temp_hyst_prec = adm1021_read_value(client, ADM1021_REG_REM_THYST_PREC);
 393                         data->remote_temp_offset = adm1021_read_value(client, ADM1021_REG_REM_OFFSET);
 394                         data->remote_temp_offset_prec = adm1021_read_value(client, ADM1021_REG_REM_OFFSET_PREC);
 395                 }
 396                 data->last_updated = jiffies;
 397                 data->valid = 1;
 398         }
 399
 400         up(&data->update_lock);
 401
 402         return data;
 403 }
 404
 405 static int __init sensors_adm1021_init(void)
 406 {
 407         return i2c_add_driver(&adm1021_driver);
 408 }
 409
 410 static void __exit sensors_adm1021_exit(void)
 411 {
 412         i2c_del_driver(&adm1021_driver);
 413 }
 414
 415 MODULE_AUTHOR ("Frodo Looijaard <frodol@dds.nl> and "
 416                 "Philip Edelbrock <phil@netroedge.com>");
 417 MODULE_DESCRIPTION("adm1021 driver");
 418 MODULE_LICENSE("GPL");
 419
 420 module_param(read_only, bool, 0);
 421 MODULE_PARM_DESC(read_only, "Don't set any values, read only mode");
 422
 423 module_init(sensors_adm1021_init)
 424 module_exit(sensors_adm1021_exit)