drivers/hwmon/emc1403.c

   1 /*
   2  * emc1403.c - SMSC Thermal Driver
   3  *
   4  * Copyright (C) 2008 Intel Corp
   5  *
   6  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; version 2 of the License.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  20  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/slab.h>
  26 #include <linux/i2c.h>
  27 #include <linux/hwmon.h>
  28 #include <linux/hwmon-sysfs.h>
  29 #include <linux/err.h>
  30 #include <linux/sysfs.h>
  31 #include <linux/mutex.h>
  32 #include <linux/regmap.h>
  33
  34 #define THERMAL_PID_REG         0xfd
  35 #define THERMAL_SMSC_ID_REG     0xfe
  36 #define THERMAL_REVISION_REG    0xff
  37
  38 enum emc1403_chip { emc1402, emc1403, emc1404 };
  39
  40 struct thermal_data {
  41         struct regmap *regmap;
  42         struct mutex mutex;
  43         const struct attribute_group *groups[4];
  44 };
  45
  46 static ssize_t show_temp(struct device *dev,
  47                         struct device_attribute *attr, char *buf)
  48 {
  49         struct sensor_device_attribute *sda = to_sensor_dev_attr(attr);
  50         struct thermal_data *data = dev_get_drvdata(dev);
  51         unsigned int val;
  52         int retval;
  53
  54         retval = regmap_read(data->regmap, sda->index, &val);
  55         if (retval < 0)
  56                 return retval;
  57         return sprintf(buf, "%d000\n", val);
  58 }
  59
  60 static ssize_t show_bit(struct device *dev,
  61                         struct device_attribute *attr, char *buf)
  62 {
  63         struct sensor_device_attribute_2 *sda = to_sensor_dev_attr_2(attr);
  64         struct thermal_data *data = dev_get_drvdata(dev);
  65         unsigned int val;
  66         int retval;
  67
  68         retval = regmap_read(data->regmap, sda->nr, &val);
  69         if (retval < 0)
  70                 return retval;
  71         return sprintf(buf, "%d\n", !!(val & sda->index));
  72 }
  73
  74 static ssize_t store_temp(struct device *dev,
  75                 struct device_attribute *attr, const char *buf, size_t count)
  76 {
  77         struct sensor_device_attribute *sda = to_sensor_dev_attr(attr);
  78         struct thermal_data *data = dev_get_drvdata(dev);
  79         unsigned long val;
  80         int retval;
  81
  82         if (kstrtoul(buf, 10, &val))
  83                 return -EINVAL;
  84         retval = regmap_write(data->regmap, sda->index,
  85                               DIV_ROUND_CLOSEST(val, 1000));
  86         if (retval < 0)
  87                 return retval;
  88         return count;
  89 }
  90
  91 static ssize_t store_bit(struct device *dev,
  92                 struct device_attribute *attr, const char *buf, size_t count)
  93 {
  94         struct sensor_device_attribute_2 *sda = to_sensor_dev_attr_2(attr);
  95         struct thermal_data *data = dev_get_drvdata(dev);
  96         unsigned long val;
  97         int retval;
  98
  99         if (kstrtoul(buf, 10, &val))
 100                 return -EINVAL;
 101
 102         retval = regmap_update_bits(data->regmap, sda->nr, sda->index,
 103                                     val ? sda->index : 0);
 104         if (retval < 0)
 105                 return retval;
 106         return count;
 107 }
 108
 109 static ssize_t show_hyst(struct device *dev,
 110                         struct device_attribute *attr, char *buf)
 111 {
 112         struct sensor_device_attribute *sda = to_sensor_dev_attr(attr);
 113         struct thermal_data *data = dev_get_drvdata(dev);
 114         struct regmap *regmap = data->regmap;
 115         unsigned int limit;
 116         unsigned int hyst;
 117         int retval;
 118
 119         retval = regmap_read(regmap, sda->index, &limit);
 120         if (retval < 0)
 121                 return retval;
 122
 123         retval = regmap_read(regmap, 0x21, &hyst);
 124         if (retval < 0)
 125                 return retval;
 126
 127         return sprintf(buf, "%d000\n", limit - hyst);
 128 }
 129
 130 static ssize_t store_hyst(struct device *dev,
 131                 struct device_attribute *attr, const char *buf, size_t count)
 132 {
 133         struct sensor_device_attribute *sda = to_sensor_dev_attr(attr);
 134         struct thermal_data *data = dev_get_drvdata(dev);
 135         struct regmap *regmap = data->regmap;
 136         unsigned int limit;
 137         int retval;
 138         int hyst;
 139         unsigned long val;
 140
 141         if (kstrtoul(buf, 10, &val))
 142                 return -EINVAL;
 143
 144         mutex_lock(&data->mutex);
 145         retval = regmap_read(regmap, sda->index, &limit);
 146         if (retval < 0)
 147                 goto fail;
 148
 149         hyst = limit * 1000 - val;
 150         hyst = clamp_val(DIV_ROUND_CLOSEST(hyst, 1000), 0, 255);
 151         retval = regmap_write(regmap, 0x21, hyst);
 152         if (retval == 0)
 153                 retval = count;
 154 fail:
 155         mutex_unlock(&data->mutex);
 156         return retval;
 157 }
 158
 159 /*
 160  *      Sensors. We pass the actual i2c register to the methods.
 161  */
 162
 163 static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO | S_IWUSR,
 164         show_temp, store_temp, 0x06);
 165 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO | S_IWUSR,
 166         show_temp, store_temp, 0x05);
 167 static SENSOR_DEVICE_ATTR(temp1_crit, S_IRUGO | S_IWUSR,
 168         show_temp, store_temp, 0x20);
 169 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0x00);
 170 static SENSOR_DEVICE_ATTR_2(temp1_min_alarm, S_IRUGO,
 171         show_bit, NULL, 0x36, 0x01);
 172 static SENSOR_DEVICE_ATTR_2(temp1_max_alarm, S_IRUGO,
 173         show_bit, NULL, 0x35, 0x01);
 174 static SENSOR_DEVICE_ATTR_2(temp1_crit_alarm, S_IRUGO,
 175         show_bit, NULL, 0x37, 0x01);
 176 static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IRUGO, show_hyst, NULL, 0x05);
 177 static SENSOR_DEVICE_ATTR(temp1_crit_hyst, S_IRUGO | S_IWUSR,
 178         show_hyst, store_hyst, 0x20);
 179
 180 static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO | S_IWUSR,
 181         show_temp, store_temp, 0x08);
 182 static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO | S_IWUSR,
 183         show_temp, store_temp, 0x07);
 184 static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO | S_IWUSR,
 185         show_temp, store_temp, 0x19);
 186 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 0x01);
 187 static SENSOR_DEVICE_ATTR_2(temp2_fault, S_IRUGO, show_bit, NULL, 0x1b, 0x02);
 188 static SENSOR_DEVICE_ATTR_2(temp2_min_alarm, S_IRUGO,
 189         show_bit, NULL, 0x36, 0x02);
 190 static SENSOR_DEVICE_ATTR_2(temp2_max_alarm, S_IRUGO,
 191         show_bit, NULL, 0x35, 0x02);
 192 static SENSOR_DEVICE_ATTR_2(temp2_crit_alarm, S_IRUGO,
 193         show_bit, NULL, 0x37, 0x02);
 194 static SENSOR_DEVICE_ATTR(temp2_max_hyst, S_IRUGO, show_hyst, NULL, 0x07);
 195 static SENSOR_DEVICE_ATTR(temp2_crit_hyst, S_IRUGO, show_hyst, NULL, 0x19);
 196
 197 static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO | S_IWUSR,
 198         show_temp, store_temp, 0x16);
 199 static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO | S_IWUSR,
 200         show_temp, store_temp, 0x15);
 201 static SENSOR_DEVICE_ATTR(temp3_crit, S_IRUGO | S_IWUSR,
 202         show_temp, store_temp, 0x1A);
 203 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 0x23);
 204 static SENSOR_DEVICE_ATTR_2(temp3_fault, S_IRUGO, show_bit, NULL, 0x1b, 0x04);
 205 static SENSOR_DEVICE_ATTR_2(temp3_min_alarm, S_IRUGO,
 206         show_bit, NULL, 0x36, 0x04);
 207 static SENSOR_DEVICE_ATTR_2(temp3_max_alarm, S_IRUGO,
 208         show_bit, NULL, 0x35, 0x04);
 209 static SENSOR_DEVICE_ATTR_2(temp3_crit_alarm, S_IRUGO,
 210         show_bit, NULL, 0x37, 0x04);
 211 static SENSOR_DEVICE_ATTR(temp3_max_hyst, S_IRUGO, show_hyst, NULL, 0x15);
 212 static SENSOR_DEVICE_ATTR(temp3_crit_hyst, S_IRUGO, show_hyst, NULL, 0x1A);
 213
 214 static SENSOR_DEVICE_ATTR(temp4_min, S_IRUGO | S_IWUSR,
 215         show_temp, store_temp, 0x2D);
 216 static SENSOR_DEVICE_ATTR(temp4_max, S_IRUGO | S_IWUSR,
 217         show_temp, store_temp, 0x2C);
 218 static SENSOR_DEVICE_ATTR(temp4_crit, S_IRUGO | S_IWUSR,
 219         show_temp, store_temp, 0x30);
 220 static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp, NULL, 0x2A);
 221 static SENSOR_DEVICE_ATTR_2(temp4_fault, S_IRUGO, show_bit, NULL, 0x1b, 0x08);
 222 static SENSOR_DEVICE_ATTR_2(temp4_min_alarm, S_IRUGO,
 223         show_bit, NULL, 0x36, 0x08);
 224 static SENSOR_DEVICE_ATTR_2(temp4_max_alarm, S_IRUGO,
 225         show_bit, NULL, 0x35, 0x08);
 226 static SENSOR_DEVICE_ATTR_2(temp4_crit_alarm, S_IRUGO,
 227         show_bit, NULL, 0x37, 0x08);
 228 static SENSOR_DEVICE_ATTR(temp4_max_hyst, S_IRUGO, show_hyst, NULL, 0x2C);
 229 static SENSOR_DEVICE_ATTR(temp4_crit_hyst, S_IRUGO, show_hyst, NULL, 0x30);
 230
 231 static SENSOR_DEVICE_ATTR_2(power_state, S_IRUGO | S_IWUSR,
 232         show_bit, store_bit, 0x03, 0x40);
 233
 234 static struct attribute *emc1402_attrs[] = {
 235         &sensor_dev_attr_temp1_min.dev_attr.attr,
 236         &sensor_dev_attr_temp1_max.dev_attr.attr,
 237         &sensor_dev_attr_temp1_crit.dev_attr.attr,
 238         &sensor_dev_attr_temp1_input.dev_attr.attr,
 239         &sensor_dev_attr_temp1_max_hyst.dev_attr.attr,
 240         &sensor_dev_attr_temp1_crit_hyst.dev_attr.attr,
 241
 242         &sensor_dev_attr_temp2_min.dev_attr.attr,
 243         &sensor_dev_attr_temp2_max.dev_attr.attr,
 244         &sensor_dev_attr_temp2_crit.dev_attr.attr,
 245         &sensor_dev_attr_temp2_input.dev_attr.attr,
 246         &sensor_dev_attr_temp2_max_hyst.dev_attr.attr,
 247         &sensor_dev_attr_temp2_crit_hyst.dev_attr.attr,
 248
 249         &sensor_dev_attr_power_state.dev_attr.attr,
 250         NULL
 251 };
 252
 253 static const struct attribute_group emc1402_group = {
 254                 .attrs = emc1402_attrs,
 255 };
 256
 257 static struct attribute *emc1403_attrs[] = {
 258         &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
 259         &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
 260         &sensor_dev_attr_temp1_crit_alarm.dev_attr.attr,
 261
 262         &sensor_dev_attr_temp2_fault.dev_attr.attr,
 263         &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
 264         &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
 265         &sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
 266
 267         &sensor_dev_attr_temp3_min.dev_attr.attr,
 268         &sensor_dev_attr_temp3_max.dev_attr.attr,
 269         &sensor_dev_attr_temp3_crit.dev_attr.attr,
 270         &sensor_dev_attr_temp3_input.dev_attr.attr,
 271         &sensor_dev_attr_temp3_fault.dev_attr.attr,
 272         &sensor_dev_attr_temp3_min_alarm.dev_attr.attr,
 273         &sensor_dev_attr_temp3_max_alarm.dev_attr.attr,
 274         &sensor_dev_attr_temp3_crit_alarm.dev_attr.attr,
 275         &sensor_dev_attr_temp3_max_hyst.dev_attr.attr,
 276         &sensor_dev_attr_temp3_crit_hyst.dev_attr.attr,
 277         NULL
 278 };
 279
 280 static const struct attribute_group emc1403_group = {
 281         .attrs = emc1403_attrs,
 282 };
 283
 284 static struct attribute *emc1404_attrs[] = {
 285         &sensor_dev_attr_temp4_min.dev_attr.attr,
 286         &sensor_dev_attr_temp4_max.dev_attr.attr,
 287         &sensor_dev_attr_temp4_crit.dev_attr.attr,
 288         &sensor_dev_attr_temp4_input.dev_attr.attr,
 289         &sensor_dev_attr_temp4_fault.dev_attr.attr,
 290         &sensor_dev_attr_temp4_min_alarm.dev_attr.attr,
 291         &sensor_dev_attr_temp4_max_alarm.dev_attr.attr,
 292         &sensor_dev_attr_temp4_crit_alarm.dev_attr.attr,
 293         &sensor_dev_attr_temp4_max_hyst.dev_attr.attr,
 294         &sensor_dev_attr_temp4_crit_hyst.dev_attr.attr,
 295         NULL
 296 };
 297
 298 static const struct attribute_group emc1404_group = {
 299         .attrs = emc1404_attrs,
 300 };
 301
 302 /*
 303  * EMC14x2 uses a different register and different bits to report alarm and
 304  * fault status. For simplicity, provide a separate attribute group for this
 305  * chip series.
 306  * Since we can not re-use the same attribute names, create a separate attribute
 307  * array.
 308  */
 309 static struct sensor_device_attribute_2 emc1402_alarms[] = {
 310         SENSOR_ATTR_2(temp1_min_alarm, S_IRUGO, show_bit, NULL, 0x02, 0x20),
 311         SENSOR_ATTR_2(temp1_max_alarm, S_IRUGO, show_bit, NULL, 0x02, 0x40),
 312         SENSOR_ATTR_2(temp1_crit_alarm, S_IRUGO, show_bit, NULL, 0x02, 0x01),
 313
 314         SENSOR_ATTR_2(temp2_fault, S_IRUGO, show_bit, NULL, 0x02, 0x04),
 315         SENSOR_ATTR_2(temp2_min_alarm, S_IRUGO, show_bit, NULL, 0x02, 0x08),
 316         SENSOR_ATTR_2(temp2_max_alarm, S_IRUGO, show_bit, NULL, 0x02, 0x10),
 317         SENSOR_ATTR_2(temp2_crit_alarm, S_IRUGO, show_bit, NULL, 0x02, 0x02),
 318 };
 319
 320 static struct attribute *emc1402_alarm_attrs[] = {
 321         &emc1402_alarms[0].dev_attr.attr,
 322         &emc1402_alarms[1].dev_attr.attr,
 323         &emc1402_alarms[2].dev_attr.attr,
 324         &emc1402_alarms[3].dev_attr.attr,
 325         &emc1402_alarms[4].dev_attr.attr,
 326         &emc1402_alarms[5].dev_attr.attr,
 327         &emc1402_alarms[6].dev_attr.attr,
 328         NULL,
 329 };
 330
 331 static const struct attribute_group emc1402_alarm_group = {
 332         .attrs = emc1402_alarm_attrs,
 333 };
 334
 335 static int emc1403_detect(struct i2c_client *client,
 336                         struct i2c_board_info *info)
 337 {
 338         int id;
 339         /* Check if thermal chip is SMSC and EMC1403 or EMC1423 */
 340
 341         id = i2c_smbus_read_byte_data(client, THERMAL_SMSC_ID_REG);
 342         if (id != 0x5d)
 343                 return -ENODEV;
 344
 345         id = i2c_smbus_read_byte_data(client, THERMAL_PID_REG);
 346         switch (id) {
 347         case 0x20:
 348                 strlcpy(info->type, "emc1402", I2C_NAME_SIZE);
 349                 break;
 350         case 0x21:
 351                 strlcpy(info->type, "emc1403", I2C_NAME_SIZE);
 352                 break;
 353         case 0x22:
 354                 strlcpy(info->type, "emc1422", I2C_NAME_SIZE);
 355                 break;
 356         case 0x23:
 357                 strlcpy(info->type, "emc1423", I2C_NAME_SIZE);
 358                 break;
 359         case 0x25:
 360                 strlcpy(info->type, "emc1404", I2C_NAME_SIZE);
 361                 break;
 362         case 0x27:
 363                 strlcpy(info->type, "emc1424", I2C_NAME_SIZE);
 364                 break;
 365         default:
 366                 return -ENODEV;
 367         }
 368
 369         id = i2c_smbus_read_byte_data(client, THERMAL_REVISION_REG);
 370         if (id < 0x01 || id > 0x04)
 371                 return -ENODEV;
 372
 373         return 0;
 374 }
 375
 376 static bool emc1403_regmap_is_volatile(struct device *dev, unsigned int reg)
 377 {
 378         switch (reg) {
 379         case 0x00:      /* internal diode high byte */
 380         case 0x01:      /* external diode 1 high byte */
 381         case 0x02:      /* status */
 382         case 0x10:      /* external diode 1 low byte */
 383         case 0x1b:      /* external diode fault */
 384         case 0x23:      /* external diode 2 high byte */
 385         case 0x24:      /* external diode 2 low byte */
 386         case 0x29:      /* internal diode low byte */
 387         case 0x2a:      /* externl diode 3 high byte */
 388         case 0x2b:      /* external diode 3 low byte */
 389         case 0x35:      /* high limit status */
 390         case 0x36:      /* low limit status */
 391         case 0x37:      /* therm limit status */
 392                 return true;
 393         default:
 394                 return false;
 395         }
 396 }
 397
 398 static struct regmap_config emc1403_regmap_config = {
 399         .reg_bits = 8,
 400         .val_bits = 8,
 401         .cache_type = REGCACHE_RBTREE,
 402         .volatile_reg = emc1403_regmap_is_volatile,
 403 };
 404
 405 static int emc1403_probe(struct i2c_client *client,
 406                         const struct i2c_device_id *id)
 407 {
 408         struct thermal_data *data;
 409         struct device *hwmon_dev;
 410
 411         data = devm_kzalloc(&client->dev, sizeof(struct thermal_data),
 412                             GFP_KERNEL);
 413         if (data == NULL)
 414                 return -ENOMEM;
 415
 416         data->regmap = devm_regmap_init_i2c(client, &emc1403_regmap_config);
 417         if (IS_ERR(data->regmap))
 418                 return PTR_ERR(data->regmap);
 419
 420         mutex_init(&data->mutex);
 421
 422         switch (id->driver_data) {
 423         case emc1404:
 424                 data->groups[2] = &emc1404_group;
 425         case emc1403:
 426                 data->groups[1] = &emc1403_group;
 427         case emc1402:
 428                 data->groups[0] = &emc1402_group;
 429         }
 430
 431         if (id->driver_data == emc1402)
 432                 data->groups[1] = &emc1402_alarm_group;
 433
 434         hwmon_dev = devm_hwmon_device_register_with_groups(&client->dev,
 435                                                            client->name, data,
 436                                                            data->groups);
 437         if (IS_ERR(hwmon_dev))
 438                 return PTR_ERR(hwmon_dev);
 439
 440         dev_info(&client->dev, "%s Thermal chip found\n", id->name);
 441         return 0;
 442 }
 443
 444 static const unsigned short emc1403_address_list[] = {
 445         0x18, 0x1c, 0x29, 0x4c, 0x4d, 0x5c, I2C_CLIENT_END
 446 };
 447
 448 /* Last digit of chip name indicates number of channels */
 449 static const struct i2c_device_id emc1403_idtable[] = {
 450         { "emc1402", emc1402 },
 451         { "emc1403", emc1403 },
 452         { "emc1404", emc1404 },
 453         { "emc1422", emc1402 },
 454         { "emc1423", emc1403 },
 455         { "emc1424", emc1404 },
 456         { }
 457 };
 458 MODULE_DEVICE_TABLE(i2c, emc1403_idtable);
 459
 460 static struct i2c_driver sensor_emc1403 = {
 461         .class = I2C_CLASS_HWMON,
 462         .driver = {
 463                 .name = "emc1403",
 464         },
 465         .detect = emc1403_detect,
 466         .probe = emc1403_probe,
 467         .id_table = emc1403_idtable,
 468         .address_list = emc1403_address_list,
 469 };
 470
 471 module_i2c_driver(sensor_emc1403);
 472
 473 MODULE_AUTHOR("Kalhan Trisal <kalhan.trisal@intel.com");
 474 MODULE_DESCRIPTION("emc1403 Thermal Driver");
 475 MODULE_LICENSE("GPL v2");