drivers/hwmon/ntc_thermistor.c

   1 /*
   2  * ntc_thermistor.c - NTC Thermistors
   3  *
   4  *  Copyright (C) 2010 Samsung Electronics
   5  *  MyungJoo Ham <myungjoo.ham@samsung.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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  */
  22
  23 #include <linux/slab.h>
  24 #include <linux/module.h>
  25 #include <linux/pm_runtime.h>
  26 #include <linux/math64.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/err.h>
  29 #include <linux/of.h>
  30 #include <linux/of_device.h>
  31
  32 #include <linux/platform_data/ntc_thermistor.h>
  33
  34 #include <linux/iio/iio.h>
  35 #include <linux/iio/machine.h>
  36 #include <linux/iio/driver.h>
  37 #include <linux/iio/consumer.h>
  38
  39 #include <linux/hwmon.h>
  40 #include <linux/hwmon-sysfs.h>
  41
  42 struct ntc_compensation {
  43         int             temp_c;
  44         unsigned int    ohm;
  45 };
  46
  47 static const struct platform_device_id ntc_thermistor_id[] = {
  48         { "ncp15wb473", TYPE_NCPXXWB473 },
  49         { "ncp18wb473", TYPE_NCPXXWB473 },
  50         { "ncp21wb473", TYPE_NCPXXWB473 },
  51         { "ncp03wb473", TYPE_NCPXXWB473 },
  52         { "ncp15wl333", TYPE_NCPXXWL333 },
  53         { },
  54 };
  55
  56 /*
  57  * A compensation table should be sorted by the values of .ohm
  58  * in descending order.
  59  * The following compensation tables are from the specification of Murata NTC
  60  * Thermistors Datasheet
  61  */
  62 static const struct ntc_compensation ncpXXwb473[] = {
  63         { .temp_c       = -40, .ohm     = 1747920 },
  64         { .temp_c       = -35, .ohm     = 1245428 },
  65         { .temp_c       = -30, .ohm     = 898485 },
  66         { .temp_c       = -25, .ohm     = 655802 },
  67         { .temp_c       = -20, .ohm     = 483954 },
  68         { .temp_c       = -15, .ohm     = 360850 },
  69         { .temp_c       = -10, .ohm     = 271697 },
  70         { .temp_c       = -5, .ohm      = 206463 },
  71         { .temp_c       = 0, .ohm       = 158214 },
  72         { .temp_c       = 5, .ohm       = 122259 },
  73         { .temp_c       = 10, .ohm      = 95227 },
  74         { .temp_c       = 15, .ohm      = 74730 },
  75         { .temp_c       = 20, .ohm      = 59065 },
  76         { .temp_c       = 25, .ohm      = 47000 },
  77         { .temp_c       = 30, .ohm      = 37643 },
  78         { .temp_c       = 35, .ohm      = 30334 },
  79         { .temp_c       = 40, .ohm      = 24591 },
  80         { .temp_c       = 45, .ohm      = 20048 },
  81         { .temp_c       = 50, .ohm      = 16433 },
  82         { .temp_c       = 55, .ohm      = 13539 },
  83         { .temp_c       = 60, .ohm      = 11209 },
  84         { .temp_c       = 65, .ohm      = 9328 },
  85         { .temp_c       = 70, .ohm      = 7798 },
  86         { .temp_c       = 75, .ohm      = 6544 },
  87         { .temp_c       = 80, .ohm      = 5518 },
  88         { .temp_c       = 85, .ohm      = 4674 },
  89         { .temp_c       = 90, .ohm      = 3972 },
  90         { .temp_c       = 95, .ohm      = 3388 },
  91         { .temp_c       = 100, .ohm     = 2902 },
  92         { .temp_c       = 105, .ohm     = 2494 },
  93         { .temp_c       = 110, .ohm     = 2150 },
  94         { .temp_c       = 115, .ohm     = 1860 },
  95         { .temp_c       = 120, .ohm     = 1615 },
  96         { .temp_c       = 125, .ohm     = 1406 },
  97 };
  98 static const struct ntc_compensation ncpXXwl333[] = {
  99         { .temp_c       = -40, .ohm     = 1610154 },
 100         { .temp_c       = -35, .ohm     = 1130850 },
 101         { .temp_c       = -30, .ohm     = 802609 },
 102         { .temp_c       = -25, .ohm     = 575385 },
 103         { .temp_c       = -20, .ohm     = 416464 },
 104         { .temp_c       = -15, .ohm     = 304219 },
 105         { .temp_c       = -10, .ohm     = 224193 },
 106         { .temp_c       = -5, .ohm      = 166623 },
 107         { .temp_c       = 0, .ohm       = 124850 },
 108         { .temp_c       = 5, .ohm       = 94287 },
 109         { .temp_c       = 10, .ohm      = 71747 },
 110         { .temp_c       = 15, .ohm      = 54996 },
 111         { .temp_c       = 20, .ohm      = 42455 },
 112         { .temp_c       = 25, .ohm      = 33000 },
 113         { .temp_c       = 30, .ohm      = 25822 },
 114         { .temp_c       = 35, .ohm      = 20335 },
 115         { .temp_c       = 40, .ohm      = 16115 },
 116         { .temp_c       = 45, .ohm      = 12849 },
 117         { .temp_c       = 50, .ohm      = 10306 },
 118         { .temp_c       = 55, .ohm      = 8314 },
 119         { .temp_c       = 60, .ohm      = 6746 },
 120         { .temp_c       = 65, .ohm      = 5503 },
 121         { .temp_c       = 70, .ohm      = 4513 },
 122         { .temp_c       = 75, .ohm      = 3721 },
 123         { .temp_c       = 80, .ohm      = 3084 },
 124         { .temp_c       = 85, .ohm      = 2569 },
 125         { .temp_c       = 90, .ohm      = 2151 },
 126         { .temp_c       = 95, .ohm      = 1809 },
 127         { .temp_c       = 100, .ohm     = 1529 },
 128         { .temp_c       = 105, .ohm     = 1299 },
 129         { .temp_c       = 110, .ohm     = 1108 },
 130         { .temp_c       = 115, .ohm     = 949 },
 131         { .temp_c       = 120, .ohm     = 817 },
 132         { .temp_c       = 125, .ohm     = 707 },
 133 };
 134
 135 struct ntc_data {
 136         struct device *hwmon_dev;
 137         struct ntc_thermistor_platform_data *pdata;
 138         const struct ntc_compensation *comp;
 139         struct device *dev;
 140         int n_comp;
 141         char name[PLATFORM_NAME_SIZE];
 142 };
 143
 144 #if defined(CONFIG_OF) && IS_ENABLED(CONFIG_IIO)
 145 static int ntc_adc_iio_read(struct ntc_thermistor_platform_data *pdata)
 146 {
 147         struct iio_channel *channel = pdata->chan;
 148         s64 result;
 149         int val, ret;
 150
 151         ret = iio_read_channel_raw(channel, &val);
 152         if (ret < 0) {
 153                 pr_err("read channel() error: %d\n", ret);
 154                 return ret;
 155         }
 156
 157         /* unit: mV */
 158         result = pdata->pullup_uv * (s64) val;
 159         result >>= 12;
 160
 161         return (int)result;
 162 }
 163
 164 static const struct of_device_id ntc_match[] = {
 165         { .compatible = "ntc,ncp15wb473",
 166                 .data = &ntc_thermistor_id[TYPE_NCPXXWB473] },
 167         { .compatible = "ntc,ncp18wb473",
 168                 .data = &ntc_thermistor_id[TYPE_NCPXXWB473] },
 169         { .compatible = "ntc,ncp21wb473",
 170                 .data = &ntc_thermistor_id[TYPE_NCPXXWB473] },
 171         { .compatible = "ntc,ncp03wb473",
 172                 .data = &ntc_thermistor_id[TYPE_NCPXXWB473] },
 173         { .compatible = "ntc,ncp15wl333",
 174                 .data = &ntc_thermistor_id[TYPE_NCPXXWL333] },
 175         { },
 176 };
 177 MODULE_DEVICE_TABLE(of, ntc_match);
 178
 179 static struct ntc_thermistor_platform_data *
 180 ntc_thermistor_parse_dt(struct platform_device *pdev)
 181 {
 182         struct iio_channel *chan;
 183         struct device_node *np = pdev->dev.of_node;
 184         struct ntc_thermistor_platform_data *pdata;
 185
 186         if (!np)
 187                 return NULL;
 188
 189         pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
 190         if (!pdata)
 191                 return ERR_PTR(-ENOMEM);
 192
 193         chan = iio_channel_get(&pdev->dev, NULL);
 194         if (IS_ERR(chan))
 195                 return ERR_CAST(chan);
 196
 197         if (of_property_read_u32(np, "pullup-uv", &pdata->pullup_uv))
 198                 return ERR_PTR(-ENODEV);
 199         if (of_property_read_u32(np, "pullup-ohm", &pdata->pullup_ohm))
 200                 return ERR_PTR(-ENODEV);
 201         if (of_property_read_u32(np, "pulldown-ohm", &pdata->pulldown_ohm))
 202                 return ERR_PTR(-ENODEV);
 203
 204         if (of_find_property(np, "connected-positive", NULL))
 205                 pdata->connect = NTC_CONNECTED_POSITIVE;
 206         else /* status change should be possible if not always on. */
 207                 pdata->connect = NTC_CONNECTED_GROUND;
 208
 209         pdata->chan = chan;
 210         pdata->read_uv = ntc_adc_iio_read;
 211
 212         return pdata;
 213 }
 214 static void ntc_iio_channel_release(struct ntc_thermistor_platform_data *pdata)
 215 {
 216         if (pdata->chan)
 217                 iio_channel_release(pdata->chan);
 218 }
 219 #else
 220 static struct ntc_thermistor_platform_data *
 221 ntc_thermistor_parse_dt(struct platform_device *pdev)
 222 {
 223         return NULL;
 224 }
 225
 226 #define ntc_match       NULL
 227
 228 static void ntc_iio_channel_release(struct ntc_thermistor_platform_data *pdata)
 229 { }
 230 #endif
 231
 232 static inline u64 div64_u64_safe(u64 dividend, u64 divisor)
 233 {
 234         if (divisor == 0 && dividend == 0)
 235                 return 0;
 236         if (divisor == 0)
 237                 return UINT_MAX;
 238         return div64_u64(dividend, divisor);
 239 }
 240
 241 static int get_ohm_of_thermistor(struct ntc_data *data, unsigned int uv)
 242 {
 243         struct ntc_thermistor_platform_data *pdata = data->pdata;
 244         u64 mv = uv / 1000;
 245         u64 pmv = pdata->pullup_uv / 1000;
 246         u64 n, puo, pdo;
 247         puo = pdata->pullup_ohm;
 248         pdo = pdata->pulldown_ohm;
 249
 250         if (mv == 0) {
 251                 if (pdata->connect == NTC_CONNECTED_POSITIVE)
 252                         return INT_MAX;
 253                 return 0;
 254         }
 255         if (mv >= pmv)
 256                 return (pdata->connect == NTC_CONNECTED_POSITIVE) ?
 257                         0 : INT_MAX;
 258
 259         if (pdata->connect == NTC_CONNECTED_POSITIVE && puo == 0)
 260                 n = div64_u64_safe(pdo * (pmv - mv), mv);
 261         else if (pdata->connect == NTC_CONNECTED_GROUND && pdo == 0)
 262                 n = div64_u64_safe(puo * mv, pmv - mv);
 263         else if (pdata->connect == NTC_CONNECTED_POSITIVE)
 264                 n = div64_u64_safe(pdo * puo * (pmv - mv),
 265                                 puo * mv - pdo * (pmv - mv));
 266         else
 267                 n = div64_u64_safe(pdo * puo * mv, pdo * (pmv - mv) - puo * mv);
 268
 269         if (n > INT_MAX)
 270                 n = INT_MAX;
 271         return n;
 272 }
 273
 274 static void lookup_comp(struct ntc_data *data, unsigned int ohm,
 275                         int *i_low, int *i_high)
 276 {
 277         int start, end, mid;
 278
 279         /*
 280          * Handle special cases: Resistance is higher than or equal to
 281          * resistance in first table entry, or resistance is lower or equal
 282          * to resistance in last table entry.
 283          * In these cases, return i_low == i_high, either pointing to the
 284          * beginning or to the end of the table depending on the condition.
 285          */
 286         if (ohm >= data->comp[0].ohm) {
 287                 *i_low = 0;
 288                 *i_high = 0;
 289                 return;
 290         }
 291         if (ohm <= data->comp[data->n_comp - 1].ohm) {
 292                 *i_low = data->n_comp - 1;
 293                 *i_high = data->n_comp - 1;
 294                 return;
 295         }
 296
 297         /* Do a binary search on compensation table */
 298         start = 0;
 299         end = data->n_comp;
 300         while (start < end) {
 301                 mid = start + (end - start) / 2;
 302                 /*
 303                  * start <= mid < end
 304                  * data->comp[start].ohm > ohm >= data->comp[end].ohm
 305                  *
 306                  * We could check for "ohm == data->comp[mid].ohm" here, but
 307                  * that is a quite unlikely condition, and we would have to
 308                  * check again after updating start. Check it at the end instead
 309                  * for simplicity.
 310                  */
 311                 if (ohm >= data->comp[mid].ohm) {
 312                         end = mid;
 313                 } else {
 314                         start = mid + 1;
 315                         /*
 316                          * ohm >= data->comp[start].ohm might be true here,
 317                          * since we set start to mid + 1. In that case, we are
 318                          * done. We could keep going, but the condition is quite
 319                          * likely to occur, so it is worth checking for it.
 320                          */
 321                         if (ohm >= data->comp[start].ohm)
 322                                 end = start;
 323                 }
 324                 /*
 325                  * start <= end
 326                  * data->comp[start].ohm >= ohm >= data->comp[end].ohm
 327                  */
 328         }
 329         /*
 330          * start == end
 331          * ohm >= data->comp[end].ohm
 332          */
 333         *i_low = end;
 334         if (ohm == data->comp[end].ohm)
 335                 *i_high = end;
 336         else
 337                 *i_high = end - 1;
 338 }
 339
 340 static int get_temp_mc(struct ntc_data *data, unsigned int ohm)
 341 {
 342         int low, high;
 343         int temp;
 344
 345         lookup_comp(data, ohm, &low, &high);
 346         if (low == high) {
 347                 /* Unable to use linear approximation */
 348                 temp = data->comp[low].temp_c * 1000;
 349         } else {
 350                 temp = data->comp[low].temp_c * 1000 +
 351                         ((data->comp[high].temp_c - data->comp[low].temp_c) *
 352                          1000 * ((int)ohm - (int)data->comp[low].ohm)) /
 353                         ((int)data->comp[high].ohm - (int)data->comp[low].ohm);
 354         }
 355         return temp;
 356 }
 357
 358 static int ntc_thermistor_get_ohm(struct ntc_data *data)
 359 {
 360         int read_uv;
 361
 362         if (data->pdata->read_ohm)
 363                 return data->pdata->read_ohm();
 364
 365         if (data->pdata->read_uv) {
 366                 read_uv = data->pdata->read_uv(data->pdata);
 367                 if (read_uv < 0)
 368                         return read_uv;
 369                 return get_ohm_of_thermistor(data, read_uv);
 370         }
 371         return -EINVAL;
 372 }
 373
 374 static ssize_t ntc_show_name(struct device *dev,
 375                 struct device_attribute *attr, char *buf)
 376 {
 377         struct ntc_data *data = dev_get_drvdata(dev);
 378
 379         return sprintf(buf, "%s\n", data->name);
 380 }
 381
 382 static ssize_t ntc_show_type(struct device *dev,
 383                 struct device_attribute *attr, char *buf)
 384 {
 385         return sprintf(buf, "4\n");
 386 }
 387
 388 static ssize_t ntc_show_temp(struct device *dev,
 389                 struct device_attribute *attr, char *buf)
 390 {
 391         struct ntc_data *data = dev_get_drvdata(dev);
 392         int ohm;
 393
 394         ohm = ntc_thermistor_get_ohm(data);
 395         if (ohm < 0)
 396                 return ohm;
 397
 398         return sprintf(buf, "%d\n", get_temp_mc(data, ohm));
 399 }
 400
 401 static SENSOR_DEVICE_ATTR(temp1_type, S_IRUGO, ntc_show_type, NULL, 0);
 402 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, ntc_show_temp, NULL, 0);
 403 static DEVICE_ATTR(name, S_IRUGO, ntc_show_name, NULL);
 404
 405 static struct attribute *ntc_attributes[] = {
 406         &dev_attr_name.attr,
 407         &sensor_dev_attr_temp1_type.dev_attr.attr,
 408         &sensor_dev_attr_temp1_input.dev_attr.attr,
 409         NULL,
 410 };
 411
 412 static const struct attribute_group ntc_attr_group = {
 413         .attrs = ntc_attributes,
 414 };
 415
 416 static int ntc_thermistor_probe(struct platform_device *pdev)
 417 {
 418         const struct of_device_id *of_id =
 419                         of_match_device(of_match_ptr(ntc_match), &pdev->dev);
 420         const struct platform_device_id *pdev_id;
 421         struct ntc_thermistor_platform_data *pdata;
 422         struct ntc_data *data;
 423         int ret;
 424
 425         pdata = ntc_thermistor_parse_dt(pdev);
 426         if (IS_ERR(pdata))
 427                 return PTR_ERR(pdata);
 428         else if (pdata == NULL)
 429                 pdata = dev_get_platdata(&pdev->dev);
 430
 431         if (!pdata) {
 432                 dev_err(&pdev->dev, "No platform init data supplied.\n");
 433                 return -ENODEV;
 434         }
 435
 436         /* Either one of the two is required. */
 437         if (!pdata->read_uv && !pdata->read_ohm) {
 438                 dev_err(&pdev->dev,
 439                         "Both read_uv and read_ohm missing. Need either one of the two.\n");
 440                 return -EINVAL;
 441         }
 442
 443         if (pdata->read_uv && pdata->read_ohm) {
 444                 dev_warn(&pdev->dev,
 445                          "Only one of read_uv and read_ohm is needed; ignoring read_uv.\n");
 446                 pdata->read_uv = NULL;
 447         }
 448
 449         if (pdata->read_uv && (pdata->pullup_uv == 0 ||
 450                                 (pdata->pullup_ohm == 0 && pdata->connect ==
 451                                  NTC_CONNECTED_GROUND) ||
 452                                 (pdata->pulldown_ohm == 0 && pdata->connect ==
 453                                  NTC_CONNECTED_POSITIVE) ||
 454                                 (pdata->connect != NTC_CONNECTED_POSITIVE &&
 455                                  pdata->connect != NTC_CONNECTED_GROUND))) {
 456                 dev_err(&pdev->dev,
 457                         "Required data to use read_uv not supplied.\n");
 458                 return -EINVAL;
 459         }
 460
 461         data = devm_kzalloc(&pdev->dev, sizeof(struct ntc_data), GFP_KERNEL);
 462         if (!data)
 463                 return -ENOMEM;
 464
 465         pdev_id = of_id ? of_id->data : platform_get_device_id(pdev);
 466
 467         data->dev = &pdev->dev;
 468         data->pdata = pdata;
 469         strlcpy(data->name, pdev_id->name, sizeof(data->name));
 470
 471         switch (pdev_id->driver_data) {
 472         case TYPE_NCPXXWB473:
 473                 data->comp = ncpXXwb473;
 474                 data->n_comp = ARRAY_SIZE(ncpXXwb473);
 475                 break;
 476         case TYPE_NCPXXWL333:
 477                 data->comp = ncpXXwl333;
 478                 data->n_comp = ARRAY_SIZE(ncpXXwl333);
 479                 break;
 480         default:
 481                 dev_err(&pdev->dev, "Unknown device type: %lu(%s)\n",
 482                                 pdev_id->driver_data, pdev_id->name);
 483                 return -EINVAL;
 484         }
 485
 486         platform_set_drvdata(pdev, data);
 487
 488         ret = sysfs_create_group(&data->dev->kobj, &ntc_attr_group);
 489         if (ret) {
 490                 dev_err(data->dev, "unable to create sysfs files\n");
 491                 return ret;
 492         }
 493
 494         data->hwmon_dev = hwmon_device_register(data->dev);
 495         if (IS_ERR(data->hwmon_dev)) {
 496                 dev_err(data->dev, "unable to register as hwmon device.\n");
 497                 ret = PTR_ERR(data->hwmon_dev);
 498                 goto err_after_sysfs;
 499         }
 500
 501         dev_info(&pdev->dev, "Thermistor type: %s successfully probed.\n",
 502                                                                 pdev->name);
 503
 504         return 0;
 505 err_after_sysfs:
 506         sysfs_remove_group(&data->dev->kobj, &ntc_attr_group);
 507         ntc_iio_channel_release(pdata);
 508         return ret;
 509 }
 510
 511 static int ntc_thermistor_remove(struct platform_device *pdev)
 512 {
 513         struct ntc_data *data = platform_get_drvdata(pdev);
 514         struct ntc_thermistor_platform_data *pdata = data->pdata;
 515
 516         hwmon_device_unregister(data->hwmon_dev);
 517         sysfs_remove_group(&data->dev->kobj, &ntc_attr_group);
 518         ntc_iio_channel_release(pdata);
 519
 520         return 0;
 521 }
 522
 523 static struct platform_driver ntc_thermistor_driver = {
 524         .driver = {
 525                 .name = "ntc-thermistor",
 526                 .owner = THIS_MODULE,
 527                 .of_match_table = of_match_ptr(ntc_match),
 528         },
 529         .probe = ntc_thermistor_probe,
 530         .remove = ntc_thermistor_remove,
 531         .id_table = ntc_thermistor_id,
 532 };
 533
 534 module_platform_driver(ntc_thermistor_driver);
 535
 536 MODULE_DESCRIPTION("NTC Thermistor Driver");
 537 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
 538 MODULE_LICENSE("GPL");
 539 MODULE_ALIAS("platform:ntc-thermistor");