drivers/hwmon/lm77.c

   1 /*
   2  * lm77.c - Part of lm_sensors, Linux kernel modules for hardware
   3  *          monitoring
   4  *
   5  * Copyright (c) 2004  Andras BALI <drewie@freemail.hu>
   6  *
   7  * Heavily based on lm75.c by Frodo Looijaard <frodol@dds.nl>.  The LM77
   8  * is a temperature sensor and thermal window comparator with 0.5 deg
   9  * resolution made by National Semiconductor.  Complete datasheet can be
  10  * obtained at their site:
  11  *      http://www.national.com/pf/LM/LM77.html
  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
  24 #include <linux/module.h>
  25 #include <linux/init.h>
  26 #include <linux/slab.h>
  27 #include <linux/jiffies.h>
  28 #include <linux/i2c.h>
  29 #include <linux/hwmon.h>
  30 #include <linux/hwmon-sysfs.h>
  31 #include <linux/err.h>
  32 #include <linux/mutex.h>
  33
  34 /* Addresses to scan */
  35 static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b,
  36                                                 I2C_CLIENT_END };
  37
  38 /* The LM77 registers */
  39 #define LM77_REG_TEMP           0x00
  40 #define LM77_REG_CONF           0x01
  41 #define LM77_REG_TEMP_HYST      0x02
  42 #define LM77_REG_TEMP_CRIT      0x03
  43 #define LM77_REG_TEMP_MIN       0x04
  44 #define LM77_REG_TEMP_MAX       0x05
  45
  46 enum temp_index {
  47         t_input = 0,
  48         t_crit,
  49         t_min,
  50         t_max,
  51         t_hyst,
  52         t_num_temp
  53 };
  54
  55 static const u8 temp_regs[t_num_temp] = {
  56         [t_input] = LM77_REG_TEMP,
  57         [t_min] = LM77_REG_TEMP_MIN,
  58         [t_max] = LM77_REG_TEMP_MAX,
  59         [t_crit] = LM77_REG_TEMP_CRIT,
  60         [t_hyst] = LM77_REG_TEMP_HYST,
  61 };
  62
  63 /* Each client has this additional data */
  64 struct lm77_data {
  65         struct device           *hwmon_dev;
  66         struct mutex            update_lock;
  67         char                    valid;
  68         unsigned long           last_updated;   /* In jiffies */
  69         int                     temp[t_num_temp]; /* index using temp_index */
  70         u8                      alarms;
  71 };
  72
  73 /* straight from the datasheet */
  74 #define LM77_TEMP_MIN (-55000)
  75 #define LM77_TEMP_MAX 125000
  76
  77 /*
  78  * In the temperature registers, the low 3 bits are not part of the
  79  * temperature values; they are the status bits.
  80  */
  81 static inline s16 LM77_TEMP_TO_REG(int temp)
  82 {
  83         int ntemp = clamp_val(temp, LM77_TEMP_MIN, LM77_TEMP_MAX);
  84         return (ntemp / 500) * 8;
  85 }
  86
  87 static inline int LM77_TEMP_FROM_REG(s16 reg)
  88 {
  89         return (reg / 8) * 500;
  90 }
  91
  92 /*
  93  * All registers are word-sized, except for the configuration register.
  94  * The LM77 uses the high-byte first convention.
  95  */
  96 static u16 lm77_read_value(struct i2c_client *client, u8 reg)
  97 {
  98         if (reg == LM77_REG_CONF)
  99                 return i2c_smbus_read_byte_data(client, reg);
 100         else
 101                 return i2c_smbus_read_word_swapped(client, reg);
 102 }
 103
 104 static int lm77_write_value(struct i2c_client *client, u8 reg, u16 value)
 105 {
 106         if (reg == LM77_REG_CONF)
 107                 return i2c_smbus_write_byte_data(client, reg, value);
 108         else
 109                 return i2c_smbus_write_word_swapped(client, reg, value);
 110 }
 111
 112 static struct lm77_data *lm77_update_device(struct device *dev)
 113 {
 114         struct i2c_client *client = to_i2c_client(dev);
 115         struct lm77_data *data = i2c_get_clientdata(client);
 116         int i;
 117
 118         mutex_lock(&data->update_lock);
 119
 120         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 121             || !data->valid) {
 122                 dev_dbg(&client->dev, "Starting lm77 update\n");
 123                 for (i = 0; i < t_num_temp; i++) {
 124                         data->temp[i] =
 125                           LM77_TEMP_FROM_REG(lm77_read_value(client,
 126                                                              temp_regs[i]));
 127                 }
 128                 data->alarms =
 129                         lm77_read_value(client, LM77_REG_TEMP) & 0x0007;
 130                 data->last_updated = jiffies;
 131                 data->valid = 1;
 132         }
 133
 134         mutex_unlock(&data->update_lock);
 135
 136         return data;
 137 }
 138
 139 /* sysfs stuff */
 140
 141 static ssize_t show_temp(struct device *dev, struct device_attribute *devattr,
 142                          char *buf)
 143 {
 144         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 145         struct lm77_data *data = lm77_update_device(dev);
 146
 147         return sprintf(buf, "%d\n", data->temp[attr->index]);
 148 }
 149
 150 static ssize_t show_temp_hyst(struct device *dev,
 151                               struct device_attribute *devattr, char *buf)
 152 {
 153         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 154         struct lm77_data *data = lm77_update_device(dev);
 155         int nr = attr->index;
 156         int temp;
 157
 158         temp = nr == t_min ? data->temp[nr] + data->temp[t_hyst] :
 159                              data->temp[nr] - data->temp[t_hyst];
 160
 161         return sprintf(buf, "%d\n", temp);
 162 }
 163
 164 static ssize_t set_temp(struct device *dev, struct device_attribute *devattr,
 165                         const char *buf, size_t count)
 166 {
 167         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 168         struct i2c_client *client = to_i2c_client(dev);
 169         struct lm77_data *data = i2c_get_clientdata(client);
 170         int nr = attr->index;
 171         long val;
 172         int err;
 173
 174         err = kstrtol(buf, 10, &val);
 175         if (err)
 176                 return err;
 177
 178         mutex_lock(&data->update_lock);
 179         data->temp[nr] = val;
 180         lm77_write_value(client, temp_regs[nr], LM77_TEMP_TO_REG(val));
 181         mutex_unlock(&data->update_lock);
 182         return count;
 183 }
 184
 185 /*
 186  * hysteresis is stored as a relative value on the chip, so it has to be
 187  * converted first.
 188  */
 189 static ssize_t set_temp_hyst(struct device *dev,
 190                              struct device_attribute *devattr,
 191                              const char *buf, size_t count)
 192 {
 193         struct i2c_client *client = to_i2c_client(dev);
 194         struct lm77_data *data = i2c_get_clientdata(client);
 195         unsigned long val;
 196         int err;
 197
 198         err = kstrtoul(buf, 10, &val);
 199         if (err)
 200                 return err;
 201
 202         mutex_lock(&data->update_lock);
 203         data->temp[t_hyst] = data->temp[t_crit] - val;
 204         lm77_write_value(client, LM77_REG_TEMP_HYST,
 205                          LM77_TEMP_TO_REG(data->temp[t_hyst]));
 206         mutex_unlock(&data->update_lock);
 207         return count;
 208 }
 209
 210 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
 211                           char *buf)
 212 {
 213         int bitnr = to_sensor_dev_attr(attr)->index;
 214         struct lm77_data *data = lm77_update_device(dev);
 215         return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
 216 }
 217
 218 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, t_input);
 219 static SENSOR_DEVICE_ATTR(temp1_crit, S_IWUSR | S_IRUGO, show_temp, set_temp,
 220                           t_crit);
 221 static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp, set_temp,
 222                           t_min);
 223 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, set_temp,
 224                           t_max);
 225
 226 static SENSOR_DEVICE_ATTR(temp1_crit_hyst, S_IWUSR | S_IRUGO, show_temp_hyst,
 227                           set_temp_hyst, t_crit);
 228 static SENSOR_DEVICE_ATTR(temp1_min_hyst, S_IRUGO, show_temp_hyst, NULL, t_min);
 229 static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IRUGO, show_temp_hyst, NULL, t_max);
 230
 231 static SENSOR_DEVICE_ATTR(temp1_crit_alarm, S_IRUGO, show_alarm, NULL, 2);
 232 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
 233 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 1);
 234
 235 static struct attribute *lm77_attributes[] = {
 236         &sensor_dev_attr_temp1_input.dev_attr.attr,
 237         &sensor_dev_attr_temp1_crit.dev_attr.attr,
 238         &sensor_dev_attr_temp1_min.dev_attr.attr,
 239         &sensor_dev_attr_temp1_max.dev_attr.attr,
 240         &sensor_dev_attr_temp1_crit_hyst.dev_attr.attr,
 241         &sensor_dev_attr_temp1_min_hyst.dev_attr.attr,
 242         &sensor_dev_attr_temp1_max_hyst.dev_attr.attr,
 243         &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr,
 244         &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
 245         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
 246         NULL
 247 };
 248
 249 static const struct attribute_group lm77_group = {
 250         .attrs = lm77_attributes,
 251 };
 252
 253 /* Return 0 if detection is successful, -ENODEV otherwise */
 254 static int lm77_detect(struct i2c_client *client, struct i2c_board_info *info)
 255 {
 256         struct i2c_adapter *adapter = client->adapter;
 257         int i, cur, conf, hyst, crit, min, max;
 258
 259         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 260                                      I2C_FUNC_SMBUS_WORD_DATA))
 261                 return -ENODEV;
 262
 263         /*
 264          * Here comes the remaining detection.  Since the LM77 has no
 265          * register dedicated to identification, we have to rely on the
 266          * following tricks:
 267          *
 268          * 1. the high 4 bits represent the sign and thus they should
 269          *    always be the same
 270          * 2. the high 3 bits are unused in the configuration register
 271          * 3. addresses 0x06 and 0x07 return the last read value
 272          * 4. registers cycling over 8-address boundaries
 273          *
 274          * Word-sized registers are high-byte first.
 275          */
 276
 277         /* addresses cycling */
 278         cur = i2c_smbus_read_word_data(client, 0);
 279         conf = i2c_smbus_read_byte_data(client, 1);
 280         hyst = i2c_smbus_read_word_data(client, 2);
 281         crit = i2c_smbus_read_word_data(client, 3);
 282         min = i2c_smbus_read_word_data(client, 4);
 283         max = i2c_smbus_read_word_data(client, 5);
 284         for (i = 8; i <= 0xff; i += 8) {
 285                 if (i2c_smbus_read_byte_data(client, i + 1) != conf
 286                  || i2c_smbus_read_word_data(client, i + 2) != hyst
 287                  || i2c_smbus_read_word_data(client, i + 3) != crit
 288                  || i2c_smbus_read_word_data(client, i + 4) != min
 289                  || i2c_smbus_read_word_data(client, i + 5) != max)
 290                         return -ENODEV;
 291         }
 292
 293         /* sign bits */
 294         if (((cur & 0x00f0) != 0xf0 && (cur & 0x00f0) != 0x0)
 295          || ((hyst & 0x00f0) != 0xf0 && (hyst & 0x00f0) != 0x0)
 296          || ((crit & 0x00f0) != 0xf0 && (crit & 0x00f0) != 0x0)
 297          || ((min & 0x00f0) != 0xf0 && (min & 0x00f0) != 0x0)
 298          || ((max & 0x00f0) != 0xf0 && (max & 0x00f0) != 0x0))
 299                 return -ENODEV;
 300
 301         /* unused bits */
 302         if (conf & 0xe0)
 303                 return -ENODEV;
 304
 305         /* 0x06 and 0x07 return the last read value */
 306         cur = i2c_smbus_read_word_data(client, 0);
 307         if (i2c_smbus_read_word_data(client, 6) != cur
 308          || i2c_smbus_read_word_data(client, 7) != cur)
 309                 return -ENODEV;
 310         hyst = i2c_smbus_read_word_data(client, 2);
 311         if (i2c_smbus_read_word_data(client, 6) != hyst
 312          || i2c_smbus_read_word_data(client, 7) != hyst)
 313                 return -ENODEV;
 314         min = i2c_smbus_read_word_data(client, 4);
 315         if (i2c_smbus_read_word_data(client, 6) != min
 316          || i2c_smbus_read_word_data(client, 7) != min)
 317                 return -ENODEV;
 318
 319         strlcpy(info->type, "lm77", I2C_NAME_SIZE);
 320
 321         return 0;
 322 }
 323
 324 static void lm77_init_client(struct i2c_client *client)
 325 {
 326         /* Initialize the LM77 chip - turn off shutdown mode */
 327         int conf = lm77_read_value(client, LM77_REG_CONF);
 328         if (conf & 1)
 329                 lm77_write_value(client, LM77_REG_CONF, conf & 0xfe);
 330 }
 331
 332 static int lm77_probe(struct i2c_client *client, const struct i2c_device_id *id)
 333 {
 334         struct device *dev = &client->dev;
 335         struct lm77_data *data;
 336         int err;
 337
 338         data = devm_kzalloc(dev, sizeof(struct lm77_data), GFP_KERNEL);
 339         if (!data)
 340                 return -ENOMEM;
 341
 342         i2c_set_clientdata(client, data);
 343         mutex_init(&data->update_lock);
 344
 345         /* Initialize the LM77 chip */
 346         lm77_init_client(client);
 347
 348         /* Register sysfs hooks */
 349         err = sysfs_create_group(&dev->kobj, &lm77_group);
 350         if (err)
 351                 return err;
 352
 353         data->hwmon_dev = hwmon_device_register(dev);
 354         if (IS_ERR(data->hwmon_dev)) {
 355                 err = PTR_ERR(data->hwmon_dev);
 356                 goto exit_remove;
 357         }
 358
 359         return 0;
 360
 361 exit_remove:
 362         sysfs_remove_group(&dev->kobj, &lm77_group);
 363         return err;
 364 }
 365
 366 static int lm77_remove(struct i2c_client *client)
 367 {
 368         struct lm77_data *data = i2c_get_clientdata(client);
 369         hwmon_device_unregister(data->hwmon_dev);
 370         sysfs_remove_group(&client->dev.kobj, &lm77_group);
 371         return 0;
 372 }
 373
 374 static const struct i2c_device_id lm77_id[] = {
 375         { "lm77", 0 },
 376         { }
 377 };
 378 MODULE_DEVICE_TABLE(i2c, lm77_id);
 379
 380 /* This is the driver that will be inserted */
 381 static struct i2c_driver lm77_driver = {
 382         .class          = I2C_CLASS_HWMON,
 383         .driver = {
 384                 .name   = "lm77",
 385         },
 386         .probe          = lm77_probe,
 387         .remove         = lm77_remove,
 388         .id_table       = lm77_id,
 389         .detect         = lm77_detect,
 390         .address_list   = normal_i2c,
 391 };
 392
 393 module_i2c_driver(lm77_driver);
 394
 395 MODULE_AUTHOR("Andras BALI <drewie@freemail.hu>");
 396 MODULE_DESCRIPTION("LM77 driver");
 397 MODULE_LICENSE("GPL");