[linux-2.6-block.git] / drivers / hwmon / ntc_thermistor.c

/*
 * ntc_thermistor.c - NTC Thermistors
 *
 *  Copyright (C) 2010 Samsung Electronics
 *  MyungJoo Ham <myungjoo.ham@samsung.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include <linux/slab.h>
#include <linux/module.h>
#include <linux/pm_runtime.h>
#include <linux/math64.h>
#include <linux/platform_device.h>
#include <linux/err.h>
#include <linux/of.h>
#include <linux/of_device.h>

#include <linux/platform_data/ntc_thermistor.h>

#include <linux/iio/iio.h>
#include <linux/iio/machine.h>
#include <linux/iio/driver.h>
#include <linux/iio/consumer.h>

#include <linux/hwmon.h>
#include <linux/hwmon-sysfs.h>

struct ntc_compensation {
	int		temp_c;
	unsigned int	ohm;
};

/* Order matters, ntc_match references the entries by index */
static const struct platform_device_id ntc_thermistor_id[] = {
	{ "ncp15wb473", TYPE_NCPXXWB473 },
	{ "ncp18wb473", TYPE_NCPXXWB473 },
	{ "ncp21wb473", TYPE_NCPXXWB473 },
	{ "ncp03wb473", TYPE_NCPXXWB473 },
	{ "ncp15wl333", TYPE_NCPXXWL333 },
	{ },
};

/*
 * A compensation table should be sorted by the values of .ohm
 * in descending order.
 * The following compensation tables are from the specification of Murata NTC
 * Thermistors Datasheet
 */
static const struct ntc_compensation ncpXXwb473[] = {
	{ .temp_c	= -40, .ohm	= 1747920 },
	{ .temp_c	= -35, .ohm	= 1245428 },
	{ .temp_c	= -30, .ohm	= 898485 },
	{ .temp_c	= -25, .ohm	= 655802 },
	{ .temp_c	= -20, .ohm	= 483954 },
	{ .temp_c	= -15, .ohm	= 360850 },
	{ .temp_c	= -10, .ohm	= 271697 },
	{ .temp_c	= -5, .ohm	= 206463 },
	{ .temp_c	= 0, .ohm	= 158214 },
	{ .temp_c	= 5, .ohm	= 122259 },
	{ .temp_c	= 10, .ohm	= 95227 },
	{ .temp_c	= 15, .ohm	= 74730 },
	{ .temp_c	= 20, .ohm	= 59065 },
	{ .temp_c	= 25, .ohm	= 47000 },
	{ .temp_c	= 30, .ohm	= 37643 },
	{ .temp_c	= 35, .ohm	= 30334 },
	{ .temp_c	= 40, .ohm	= 24591 },
	{ .temp_c	= 45, .ohm	= 20048 },
	{ .temp_c	= 50, .ohm	= 16433 },
	{ .temp_c	= 55, .ohm	= 13539 },
	{ .temp_c	= 60, .ohm	= 11209 },
	{ .temp_c	= 65, .ohm	= 9328 },
	{ .temp_c	= 70, .ohm	= 7798 },
	{ .temp_c	= 75, .ohm	= 6544 },
	{ .temp_c	= 80, .ohm	= 5518 },
	{ .temp_c	= 85, .ohm	= 4674 },
	{ .temp_c	= 90, .ohm	= 3972 },
	{ .temp_c	= 95, .ohm	= 3388 },
	{ .temp_c	= 100, .ohm	= 2902 },
	{ .temp_c	= 105, .ohm	= 2494 },
	{ .temp_c	= 110, .ohm	= 2150 },
	{ .temp_c	= 115, .ohm	= 1860 },
	{ .temp_c	= 120, .ohm	= 1615 },
	{ .temp_c	= 125, .ohm	= 1406 },
};
static const struct ntc_compensation ncpXXwl333[] = {
	{ .temp_c	= -40, .ohm	= 1610154 },
	{ .temp_c	= -35, .ohm	= 1130850 },
	{ .temp_c	= -30, .ohm	= 802609 },
	{ .temp_c	= -25, .ohm	= 575385 },
	{ .temp_c	= -20, .ohm	= 416464 },
	{ .temp_c	= -15, .ohm	= 304219 },
	{ .temp_c	= -10, .ohm	= 224193 },
	{ .temp_c	= -5, .ohm	= 166623 },
	{ .temp_c	= 0, .ohm	= 124850 },
	{ .temp_c	= 5, .ohm	= 94287 },
	{ .temp_c	= 10, .ohm	= 71747 },
	{ .temp_c	= 15, .ohm	= 54996 },
	{ .temp_c	= 20, .ohm	= 42455 },
	{ .temp_c	= 25, .ohm	= 33000 },
	{ .temp_c	= 30, .ohm	= 25822 },
	{ .temp_c	= 35, .ohm	= 20335 },
	{ .temp_c	= 40, .ohm	= 16115 },
	{ .temp_c	= 45, .ohm	= 12849 },
	{ .temp_c	= 50, .ohm	= 10306 },
	{ .temp_c	= 55, .ohm	= 8314 },
	{ .temp_c	= 60, .ohm	= 6746 },
	{ .temp_c	= 65, .ohm	= 5503 },
	{ .temp_c	= 70, .ohm	= 4513 },
	{ .temp_c	= 75, .ohm	= 3721 },
	{ .temp_c	= 80, .ohm	= 3084 },
	{ .temp_c	= 85, .ohm	= 2569 },
	{ .temp_c	= 90, .ohm	= 2151 },
	{ .temp_c	= 95, .ohm	= 1809 },
	{ .temp_c	= 100, .ohm	= 1529 },
	{ .temp_c	= 105, .ohm	= 1299 },
	{ .temp_c	= 110, .ohm	= 1108 },
	{ .temp_c	= 115, .ohm	= 949 },
	{ .temp_c	= 120, .ohm	= 817 },
	{ .temp_c	= 125, .ohm	= 707 },
};

struct ntc_data {
	struct device *hwmon_dev;
	struct ntc_thermistor_platform_data *pdata;
	const struct ntc_compensation *comp;
	struct device *dev;
	int n_comp;
	char name[PLATFORM_NAME_SIZE];
};

#if defined(CONFIG_OF) && IS_ENABLED(CONFIG_IIO)
static int ntc_adc_iio_read(struct ntc_thermistor_platform_data *pdata)
{
	struct iio_channel *channel = pdata->chan;
	s64 result;
	int val, ret;

	ret = iio_read_channel_raw(channel, &val);
	if (ret < 0) {
		pr_err("read channel() error: %d\n", ret);
		return ret;
	}

	/* unit: mV */
	result = pdata->pullup_uv * (s64) val;
	result >>= 12;

	return (int)result;
}

static const struct of_device_id ntc_match[] = {
	{ .compatible = "murata,ncp15wb473",
		.data = &ntc_thermistor_id[0] },
	{ .compatible = "murata,ncp18wb473",
		.data = &ntc_thermistor_id[1] },
	{ .compatible = "murata,ncp21wb473",
		.data = &ntc_thermistor_id[2] },
	{ .compatible = "murata,ncp03wb473",
		.data = &ntc_thermistor_id[3] },
	{ .compatible = "murata,ncp15wl333",
		.data = &ntc_thermistor_id[4] },

	/* Usage of vendor name "ntc" is deprecated */
	{ .compatible = "ntc,ncp15wb473",
		.data = &ntc_thermistor_id[0] },
	{ .compatible = "ntc,ncp18wb473",
		.data = &ntc_thermistor_id[1] },
	{ .compatible = "ntc,ncp21wb473",
		.data = &ntc_thermistor_id[2] },
	{ .compatible = "ntc,ncp03wb473",
		.data = &ntc_thermistor_id[3] },
	{ .compatible = "ntc,ncp15wl333",
		.data = &ntc_thermistor_id[4] },
	{ },
};
MODULE_DEVICE_TABLE(of, ntc_match);

static struct ntc_thermistor_platform_data *
ntc_thermistor_parse_dt(struct platform_device *pdev)
{
	struct iio_channel *chan;
	struct device_node *np = pdev->dev.of_node;
	struct ntc_thermistor_platform_data *pdata;

	if (!np)
		return NULL;

	pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
	if (!pdata)
		return ERR_PTR(-ENOMEM);

	chan = iio_channel_get(&pdev->dev, NULL);
	if (IS_ERR(chan))
		return ERR_CAST(chan);

	if (of_property_read_u32(np, "pullup-uv", &pdata->pullup_uv))
		return ERR_PTR(-ENODEV);
	if (of_property_read_u32(np, "pullup-ohm", &pdata->pullup_ohm))
		return ERR_PTR(-ENODEV);
	if (of_property_read_u32(np, "pulldown-ohm", &pdata->pulldown_ohm))
		return ERR_PTR(-ENODEV);

	if (of_find_property(np, "connected-positive", NULL))
		pdata->connect = NTC_CONNECTED_POSITIVE;
	else /* status change should be possible if not always on. */
		pdata->connect = NTC_CONNECTED_GROUND;

	pdata->chan = chan;
	pdata->read_uv = ntc_adc_iio_read;

	return pdata;
}
static void ntc_iio_channel_release(struct ntc_thermistor_platform_data *pdata)
{
	if (pdata->chan)
		iio_channel_release(pdata->chan);
}
#else
static struct ntc_thermistor_platform_data *
ntc_thermistor_parse_dt(struct platform_device *pdev)
{
	return NULL;
}

#define ntc_match	NULL

static void ntc_iio_channel_release(struct ntc_thermistor_platform_data *pdata)
{ }
#endif

static inline u64 div64_u64_safe(u64 dividend, u64 divisor)
{
	if (divisor == 0 && dividend == 0)
		return 0;
	if (divisor == 0)
		return UINT_MAX;
	return div64_u64(dividend, divisor);
}

static int get_ohm_of_thermistor(struct ntc_data *data, unsigned int uv)
{
	struct ntc_thermistor_platform_data *pdata = data->pdata;
	u64 mv = uv / 1000;
	u64 pmv = pdata->pullup_uv / 1000;
	u64 n, puo, pdo;
	puo = pdata->pullup_ohm;
	pdo = pdata->pulldown_ohm;

	if (mv == 0) {
		if (pdata->connect == NTC_CONNECTED_POSITIVE)
			return INT_MAX;
		return 0;
	}
	if (mv >= pmv)
		return (pdata->connect == NTC_CONNECTED_POSITIVE) ?
			0 : INT_MAX;

	if (pdata->connect == NTC_CONNECTED_POSITIVE && puo == 0)
		n = div64_u64_safe(pdo * (pmv - mv), mv);
	else if (pdata->connect == NTC_CONNECTED_GROUND && pdo == 0)
		n = div64_u64_safe(puo * mv, pmv - mv);
	else if (pdata->connect == NTC_CONNECTED_POSITIVE)
		n = div64_u64_safe(pdo * puo * (pmv - mv),
				puo * mv - pdo * (pmv - mv));
	else
		n = div64_u64_safe(pdo * puo * mv, pdo * (pmv - mv) - puo * mv);

	if (n > INT_MAX)
		n = INT_MAX;
	return n;
}

static void lookup_comp(struct ntc_data *data, unsigned int ohm,
			int *i_low, int *i_high)
{
	int start, end, mid;

	/*
	 * Handle special cases: Resistance is higher than or equal to
	 * resistance in first table entry, or resistance is lower or equal
	 * to resistance in last table entry.
	 * In these cases, return i_low == i_high, either pointing to the
	 * beginning or to the end of the table depending on the condition.
	 */
	if (ohm >= data->comp[0].ohm) {
		*i_low = 0;
		*i_high = 0;
		return;
	}
	if (ohm <= data->comp[data->n_comp - 1].ohm) {
		*i_low = data->n_comp - 1;
		*i_high = data->n_comp - 1;
		return;
	}

	/* Do a binary search on compensation table */
	start = 0;
	end = data->n_comp;
	while (start < end) {
		mid = start + (end - start) / 2;
		/*
		 * start <= mid < end
		 * data->comp[start].ohm > ohm >= data->comp[end].ohm
		 *
		 * We could check for "ohm == data->comp[mid].ohm" here, but
		 * that is a quite unlikely condition, and we would have to
		 * check again after updating start. Check it at the end instead
		 * for simplicity.
		 */
		if (ohm >= data->comp[mid].ohm) {
			end = mid;
		} else {
			start = mid + 1;
			/*
			 * ohm >= data->comp[start].ohm might be true here,
			 * since we set start to mid + 1. In that case, we are
			 * done. We could keep going, but the condition is quite
			 * likely to occur, so it is worth checking for it.
			 */
			if (ohm >= data->comp[start].ohm)
				end = start;
		}
		/*
		 * start <= end
		 * data->comp[start].ohm >= ohm >= data->comp[end].ohm
		 */
	}
	/*
	 * start == end
	 * ohm >= data->comp[end].ohm
	 */
	*i_low = end;
	if (ohm == data->comp[end].ohm)
		*i_high = end;
	else
		*i_high = end - 1;
}

static int get_temp_mc(struct ntc_data *data, unsigned int ohm)
{
	int low, high;
	int temp;

	lookup_comp(data, ohm, &low, &high);
	if (low == high) {
		/* Unable to use linear approximation */
		temp = data->comp[low].temp_c * 1000;
	} else {
		temp = data->comp[low].temp_c * 1000 +
			((data->comp[high].temp_c - data->comp[low].temp_c) *
			 1000 * ((int)ohm - (int)data->comp[low].ohm)) /
			((int)data->comp[high].ohm - (int)data->comp[low].ohm);
	}
	return temp;
}

static int ntc_thermistor_get_ohm(struct ntc_data *data)
{
	int read_uv;

	if (data->pdata->read_ohm)
		return data->pdata->read_ohm();

	if (data->pdata->read_uv) {
		read_uv = data->pdata->read_uv(data->pdata);
		if (read_uv < 0)
			return read_uv;
		return get_ohm_of_thermistor(data, read_uv);
	}
	return -EINVAL;
}

static ssize_t ntc_show_name(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct ntc_data *data = dev_get_drvdata(dev);

	return sprintf(buf, "%s\n", data->name);
}

static ssize_t ntc_show_type(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	return sprintf(buf, "4\n");
}

static ssize_t ntc_show_temp(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct ntc_data *data = dev_get_drvdata(dev);
	int ohm;

	ohm = ntc_thermistor_get_ohm(data);
	if (ohm < 0)
		return ohm;

	return sprintf(buf, "%d\n", get_temp_mc(data, ohm));
}

static SENSOR_DEVICE_ATTR(temp1_type, S_IRUGO, ntc_show_type, NULL, 0);
static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, ntc_show_temp, NULL, 0);
static DEVICE_ATTR(name, S_IRUGO, ntc_show_name, NULL);

static struct attribute *ntc_attributes[] = {
	&dev_attr_name.attr,
	&sensor_dev_attr_temp1_type.dev_attr.attr,
	&sensor_dev_attr_temp1_input.dev_attr.attr,
	NULL,
};

static const struct attribute_group ntc_attr_group = {
	.attrs = ntc_attributes,
};

static int ntc_thermistor_probe(struct platform_device *pdev)
{
	const struct of_device_id *of_id =
			of_match_device(of_match_ptr(ntc_match), &pdev->dev);
	const struct platform_device_id *pdev_id;
	struct ntc_thermistor_platform_data *pdata;
	struct ntc_data *data;
	int ret;

	pdata = ntc_thermistor_parse_dt(pdev);
	if (IS_ERR(pdata))
		return PTR_ERR(pdata);
	else if (pdata == NULL)
		pdata = dev_get_platdata(&pdev->dev);

	if (!pdata) {
		dev_err(&pdev->dev, "No platform init data supplied.\n");
		return -ENODEV;
	}

	/* Either one of the two is required. */
	if (!pdata->read_uv && !pdata->read_ohm) {
		dev_err(&pdev->dev,
			"Both read_uv and read_ohm missing. Need either one of the two.\n");
		return -EINVAL;
	}

	if (pdata->read_uv && pdata->read_ohm) {
		dev_warn(&pdev->dev,
			 "Only one of read_uv and read_ohm is needed; ignoring read_uv.\n");
		pdata->read_uv = NULL;
	}

	if (pdata->read_uv && (pdata->pullup_uv == 0 ||
				(pdata->pullup_ohm == 0 && pdata->connect ==
				 NTC_CONNECTED_GROUND) ||
				(pdata->pulldown_ohm == 0 && pdata->connect ==
				 NTC_CONNECTED_POSITIVE) ||
				(pdata->connect != NTC_CONNECTED_POSITIVE &&
				 pdata->connect != NTC_CONNECTED_GROUND))) {
		dev_err(&pdev->dev,
			"Required data to use read_uv not supplied.\n");
		return -EINVAL;
	}

	data = devm_kzalloc(&pdev->dev, sizeof(struct ntc_data), GFP_KERNEL);
	if (!data)
		return -ENOMEM;

	pdev_id = of_id ? of_id->data : platform_get_device_id(pdev);

	data->dev = &pdev->dev;
	data->pdata = pdata;
	strlcpy(data->name, pdev_id->name, sizeof(data->name));

	switch (pdev_id->driver_data) {
	case TYPE_NCPXXWB473:
		data->comp = ncpXXwb473;
		data->n_comp = ARRAY_SIZE(ncpXXwb473);
		break;
	case TYPE_NCPXXWL333:
		data->comp = ncpXXwl333;
		data->n_comp = ARRAY_SIZE(ncpXXwl333);
		break;
	default:
		dev_err(&pdev->dev, "Unknown device type: %lu(%s)\n",
				pdev_id->driver_data, pdev_id->name);
		return -EINVAL;
	}

	platform_set_drvdata(pdev, data);

	ret = sysfs_create_group(&data->dev->kobj, &ntc_attr_group);
	if (ret) {
		dev_err(data->dev, "unable to create sysfs files\n");
		return ret;
	}

	data->hwmon_dev = hwmon_device_register(data->dev);
	if (IS_ERR(data->hwmon_dev)) {
		dev_err(data->dev, "unable to register as hwmon device.\n");
		ret = PTR_ERR(data->hwmon_dev);
		goto err_after_sysfs;
	}

	dev_info(&pdev->dev, "Thermistor type: %s successfully probed.\n",
								pdev_id->name);

	return 0;
err_after_sysfs:
	sysfs_remove_group(&data->dev->kobj, &ntc_attr_group);
	ntc_iio_channel_release(pdata);
	return ret;
}

static int ntc_thermistor_remove(struct platform_device *pdev)
{
	struct ntc_data *data = platform_get_drvdata(pdev);
	struct ntc_thermistor_platform_data *pdata = data->pdata;

	hwmon_device_unregister(data->hwmon_dev);
	sysfs_remove_group(&data->dev->kobj, &ntc_attr_group);
	ntc_iio_channel_release(pdata);

	return 0;
}

static struct platform_driver ntc_thermistor_driver = {
	.driver = {
		.name = "ntc-thermistor",
		.owner = THIS_MODULE,
		.of_match_table = of_match_ptr(ntc_match),
	},
	.probe = ntc_thermistor_probe,
	.remove = ntc_thermistor_remove,
	.id_table = ntc_thermistor_id,
};

module_platform_driver(ntc_thermistor_driver);

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