[mirror_ubuntu-focal-kernel.git] / drivers / thermal / rcar_thermal.c

// SPDX-License-Identifier: GPL-2.0
/*
 *  R-Car THS/TSC thermal sensor driver
 *
 * Copyright (C) 2012 Renesas Solutions Corp.
 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 */
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/irq.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/reboot.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/thermal.h>

#include "thermal_hwmon.h"

#define IDLE_INTERVAL	5000

#define COMMON_STR	0x00
#define COMMON_ENR	0x04
#define COMMON_INTMSK	0x0c

#define REG_POSNEG	0x20
#define REG_FILONOFF	0x28
#define REG_THSCR	0x2c
#define REG_THSSR	0x30
#define REG_INTCTRL	0x34

/* THSCR */
#define CPCTL	(1 << 12)

/* THSSR */
#define CTEMP	0x3f

struct rcar_thermal_common {
	void __iomem *base;
	struct device *dev;
	struct list_head head;
	spinlock_t lock;
};

struct rcar_thermal_chip {
	unsigned int use_of_thermal : 1;
	unsigned int has_filonoff : 1;
	unsigned int irq_per_ch : 1;
	unsigned int needs_suspend_resume : 1;
	unsigned int nirqs;
};

static const struct rcar_thermal_chip rcar_thermal = {
	.use_of_thermal = 0,
	.has_filonoff = 1,
	.irq_per_ch = 0,
	.needs_suspend_resume = 0,
	.nirqs = 1,
};

static const struct rcar_thermal_chip rcar_gen2_thermal = {
	.use_of_thermal = 1,
	.has_filonoff = 1,
	.irq_per_ch = 0,
	.needs_suspend_resume = 0,
	.nirqs = 1,
};

static const struct rcar_thermal_chip rcar_gen3_thermal = {
	.use_of_thermal = 1,
	.has_filonoff = 0,
	.irq_per_ch = 1,
	.needs_suspend_resume = 1,
	/*
	 * The Gen3 chip has 3 interrupts, but this driver uses only 2
	 * interrupts to detect a temperature change, rise or fall.
	 */
	.nirqs = 2,
};

struct rcar_thermal_priv {
	void __iomem *base;
	struct rcar_thermal_common *common;
	struct thermal_zone_device *zone;
	const struct rcar_thermal_chip *chip;
	struct delayed_work work;
	struct mutex lock;
	struct list_head list;
	int id;
	u32 ctemp;
};

#define rcar_thermal_for_each_priv(pos, common)	\
	list_for_each_entry(pos, &common->head, list)

#define MCELSIUS(temp)			((temp) * 1000)
#define rcar_zone_to_priv(zone)		((zone)->devdata)
#define rcar_priv_to_dev(priv)		((priv)->common->dev)
#define rcar_has_irq_support(priv)	((priv)->common->base)
#define rcar_id_to_shift(priv)		((priv)->id * 8)

static const struct of_device_id rcar_thermal_dt_ids[] = {
	{
		.compatible = "renesas,rcar-thermal",
		.data = &rcar_thermal,
	},
	{
		.compatible = "renesas,rcar-gen2-thermal",
		 .data = &rcar_gen2_thermal,
	},
	{
		.compatible = "renesas,thermal-r8a77995",
		.data = &rcar_gen3_thermal,
	},
	{},
};
MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);

/*
 *		basic functions
 */
#define rcar_thermal_common_read(c, r) \
	_rcar_thermal_common_read(c, COMMON_ ##r)
static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
				     u32 reg)
{
	return ioread32(common->base + reg);
}

#define rcar_thermal_common_write(c, r, d) \
	_rcar_thermal_common_write(c, COMMON_ ##r, d)
static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
				       u32 reg, u32 data)
{
	iowrite32(data, common->base + reg);
}

#define rcar_thermal_common_bset(c, r, m, d) \
	_rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
				      u32 reg, u32 mask, u32 data)
{
	u32 val;

	val = ioread32(common->base + reg);
	val &= ~mask;
	val |= (data & mask);
	iowrite32(val, common->base + reg);
}

#define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
{
	return ioread32(priv->base + reg);
}

#define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
				u32 reg, u32 data)
{
	iowrite32(data, priv->base + reg);
}

#define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
			       u32 mask, u32 data)
{
	u32 val;

	val = ioread32(priv->base + reg);
	val &= ~mask;
	val |= (data & mask);
	iowrite32(val, priv->base + reg);
}

/*
 *		zone device functions
 */
static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
{
	struct device *dev = rcar_priv_to_dev(priv);
	int i;
	u32 ctemp, old, new;
	int ret = -EINVAL;

	mutex_lock(&priv->lock);

	/*
	 * TSC decides a value of CPTAP automatically,
	 * and this is the conditions which validate interrupt.
	 */
	rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);

	ctemp = 0;
	old = ~0;
	for (i = 0; i < 128; i++) {
		/*
		 * we need to wait 300us after changing comparator offset
		 * to get stable temperature.
		 * see "Usage Notes" on datasheet
		 */
		udelay(300);

		new = rcar_thermal_read(priv, THSSR) & CTEMP;
		if (new == old) {
			ctemp = new;
			break;
		}
		old = new;
	}

	if (!ctemp) {
		dev_err(dev, "thermal sensor was broken\n");
		goto err_out_unlock;
	}

	/*
	 * enable IRQ
	 */
	if (rcar_has_irq_support(priv)) {
		if (priv->chip->has_filonoff)
			rcar_thermal_write(priv, FILONOFF, 0);

		/* enable Rising/Falling edge interrupt */
		rcar_thermal_write(priv, POSNEG,  0x1);
		rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) |
						   ((ctemp - 1) << 0)));
	}

	dev_dbg(dev, "thermal%d  %d -> %d\n", priv->id, priv->ctemp, ctemp);

	priv->ctemp = ctemp;
	ret = 0;
err_out_unlock:
	mutex_unlock(&priv->lock);
	return ret;
}

static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
					 int *temp)
{
	int tmp;
	int ret;

	ret = rcar_thermal_update_temp(priv);
	if (ret < 0)
		return ret;

	mutex_lock(&priv->lock);
	tmp =  MCELSIUS((priv->ctemp * 5) - 65);
	mutex_unlock(&priv->lock);

	if ((tmp < MCELSIUS(-45)) || (tmp > MCELSIUS(125))) {
		struct device *dev = rcar_priv_to_dev(priv);

		dev_err(dev, "it couldn't measure temperature correctly\n");
		return -EIO;
	}

	*temp = tmp;

	return 0;
}

static int rcar_thermal_of_get_temp(void *data, int *temp)
{
	struct rcar_thermal_priv *priv = data;

	return rcar_thermal_get_current_temp(priv, temp);
}

static int rcar_thermal_get_temp(struct thermal_zone_device *zone, int *temp)
{
	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);

	return rcar_thermal_get_current_temp(priv, temp);
}

static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
				      int trip, enum thermal_trip_type *type)
{
	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
	struct device *dev = rcar_priv_to_dev(priv);

	/* see rcar_thermal_get_temp() */
	switch (trip) {
	case 0: /* +90 <= temp */
		*type = THERMAL_TRIP_CRITICAL;
		break;
	default:
		dev_err(dev, "rcar driver trip error\n");
		return -EINVAL;
	}

	return 0;
}

static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
				      int trip, int *temp)
{
	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
	struct device *dev = rcar_priv_to_dev(priv);

	/* see rcar_thermal_get_temp() */
	switch (trip) {
	case 0: /* +90 <= temp */
		*temp = MCELSIUS(90);
		break;
	default:
		dev_err(dev, "rcar driver trip error\n");
		return -EINVAL;
	}

	return 0;
}

static int rcar_thermal_notify(struct thermal_zone_device *zone,
			       int trip, enum thermal_trip_type type)
{
	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
	struct device *dev = rcar_priv_to_dev(priv);

	switch (type) {
	case THERMAL_TRIP_CRITICAL:
		/* FIXME */
		dev_warn(dev, "Thermal reached to critical temperature\n");
		break;
	default:
		break;
	}

	return 0;
}

static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
	.get_temp	= rcar_thermal_of_get_temp,
};

static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
	.get_temp	= rcar_thermal_get_temp,
	.get_trip_type	= rcar_thermal_get_trip_type,
	.get_trip_temp	= rcar_thermal_get_trip_temp,
	.notify		= rcar_thermal_notify,
};

/*
 *		interrupt
 */
#define rcar_thermal_irq_enable(p)	_rcar_thermal_irq_ctrl(p, 1)
#define rcar_thermal_irq_disable(p)	_rcar_thermal_irq_ctrl(p, 0)
static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
{
	struct rcar_thermal_common *common = priv->common;
	unsigned long flags;
	u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */

	if (!rcar_has_irq_support(priv))
		return;

	spin_lock_irqsave(&common->lock, flags);

	rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);

	spin_unlock_irqrestore(&common->lock, flags);
}

static void rcar_thermal_work(struct work_struct *work)
{
	struct rcar_thermal_priv *priv;
	int cctemp, nctemp;
	int ret;

	priv = container_of(work, struct rcar_thermal_priv, work.work);

	ret = rcar_thermal_get_current_temp(priv, &cctemp);
	if (ret < 0)
		return;

	ret = rcar_thermal_update_temp(priv);
	if (ret < 0)
		return;

	rcar_thermal_irq_enable(priv);

	ret = rcar_thermal_get_current_temp(priv, &nctemp);
	if (ret < 0)
		return;

	if (nctemp != cctemp)
		thermal_zone_device_update(priv->zone,
					   THERMAL_EVENT_UNSPECIFIED);
}

static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
{
	struct device *dev = rcar_priv_to_dev(priv);

	status = (status >> rcar_id_to_shift(priv)) & 0x3;

	if (status) {
		dev_dbg(dev, "thermal%d %s%s\n",
			priv->id,
			(status & 0x2) ? "Rising " : "",
			(status & 0x1) ? "Falling" : "");
	}

	return status;
}

static irqreturn_t rcar_thermal_irq(int irq, void *data)
{
	struct rcar_thermal_common *common = data;
	struct rcar_thermal_priv *priv;
	unsigned long flags;
	u32 status, mask;

	spin_lock_irqsave(&common->lock, flags);

	mask	= rcar_thermal_common_read(common, INTMSK);
	status	= rcar_thermal_common_read(common, STR);
	rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);

	spin_unlock_irqrestore(&common->lock, flags);

	status = status & ~mask;

	/*
	 * check the status
	 */
	rcar_thermal_for_each_priv(priv, common) {
		if (rcar_thermal_had_changed(priv, status)) {
			rcar_thermal_irq_disable(priv);
			schedule_delayed_work(&priv->work,
					      msecs_to_jiffies(300));
		}
	}

	return IRQ_HANDLED;
}

/*
 *		platform functions
 */
static int rcar_thermal_remove(struct platform_device *pdev)
{
	struct rcar_thermal_common *common = platform_get_drvdata(pdev);
	struct device *dev = &pdev->dev;
	struct rcar_thermal_priv *priv;

	rcar_thermal_for_each_priv(priv, common) {
		rcar_thermal_irq_disable(priv);
		if (priv->chip->use_of_thermal)
			thermal_remove_hwmon_sysfs(priv->zone);
		else
			thermal_zone_device_unregister(priv->zone);
	}

	pm_runtime_put(dev);
	pm_runtime_disable(dev);

	return 0;
}

static int rcar_thermal_probe(struct platform_device *pdev)
{
	struct rcar_thermal_common *common;
	struct rcar_thermal_priv *priv;
	struct device *dev = &pdev->dev;
	struct resource *res, *irq;
	const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
	int mres = 0;
	int i;
	int ret = -ENODEV;
	int idle = IDLE_INTERVAL;
	u32 enr_bits = 0;

	common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
	if (!common)
		return -ENOMEM;

	platform_set_drvdata(pdev, common);

	INIT_LIST_HEAD(&common->head);
	spin_lock_init(&common->lock);
	common->dev = dev;

	pm_runtime_enable(dev);
	pm_runtime_get_sync(dev);

	for (i = 0; i < chip->nirqs; i++) {
		irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
		if (!irq)
			continue;
		if (!common->base) {
			/*
			 * platform has IRQ support.
			 * Then, driver uses common registers
			 * rcar_has_irq_support() will be enabled
			 */
			res = platform_get_resource(pdev, IORESOURCE_MEM,
						    mres++);
			common->base = devm_ioremap_resource(dev, res);
			if (IS_ERR(common->base))
				return PTR_ERR(common->base);

			idle = 0; /* polling delay is not needed */
		}

		ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
				       IRQF_SHARED, dev_name(dev), common);
		if (ret) {
			dev_err(dev, "irq request failed\n ");
			goto error_unregister;
		}

		/* update ENR bits */
		if (chip->irq_per_ch)
			enr_bits |= 1 << i;
	}

	for (i = 0;; i++) {
		res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
		if (!res)
			break;

		priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
		if (!priv) {
			ret = -ENOMEM;
			goto error_unregister;
		}

		priv->base = devm_ioremap_resource(dev, res);
		if (IS_ERR(priv->base)) {
			ret = PTR_ERR(priv->base);
			goto error_unregister;
		}

		priv->common = common;
		priv->id = i;
		priv->chip = chip;
		mutex_init(&priv->lock);
		INIT_LIST_HEAD(&priv->list);
		INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
		ret = rcar_thermal_update_temp(priv);
		if (ret < 0)
			goto error_unregister;

		if (chip->use_of_thermal)
			priv->zone = devm_thermal_zone_of_sensor_register(
						dev, i, priv,
						&rcar_thermal_zone_of_ops);
		else
			priv->zone = thermal_zone_device_register(
						"rcar_thermal",
						1, 0, priv,
						&rcar_thermal_zone_ops, NULL, 0,
						idle);
		if (IS_ERR(priv->zone)) {
			dev_err(dev, "can't register thermal zone\n");
			ret = PTR_ERR(priv->zone);
			priv->zone = NULL;
			goto error_unregister;
		}

		if (chip->use_of_thermal) {
			/*
			 * thermal_zone doesn't enable hwmon as default,
			 * but, enable it here to keep compatible
			 */
			priv->zone->tzp->no_hwmon = false;
			ret = thermal_add_hwmon_sysfs(priv->zone);
			if (ret)
				goto error_unregister;
		}

		rcar_thermal_irq_enable(priv);

		list_move_tail(&priv->list, &common->head);

		/* update ENR bits */
		if (!chip->irq_per_ch)
			enr_bits |= 3 << (i * 8);
	}

	if (common->base && enr_bits)
		rcar_thermal_common_write(common, ENR, enr_bits);

	dev_info(dev, "%d sensor probed\n", i);

	return 0;

error_unregister:
	rcar_thermal_remove(pdev);

	return ret;
}

#ifdef CONFIG_PM_SLEEP
static int rcar_thermal_suspend(struct device *dev)
{
	struct rcar_thermal_common *common = dev_get_drvdata(dev);
	struct rcar_thermal_priv *priv = list_first_entry(&common->head,
							  typeof(*priv), list);

	if (priv->chip->needs_suspend_resume) {
		rcar_thermal_common_write(common, ENR, 0);
		rcar_thermal_irq_disable(priv);
		rcar_thermal_bset(priv, THSCR, CPCTL, 0);
	}

	return 0;
}

static int rcar_thermal_resume(struct device *dev)
{
	struct rcar_thermal_common *common = dev_get_drvdata(dev);
	struct rcar_thermal_priv *priv = list_first_entry(&common->head,
							  typeof(*priv), list);
	int ret;

	if (priv->chip->needs_suspend_resume) {
		ret = rcar_thermal_update_temp(priv);
		if (ret < 0)
			return ret;
		rcar_thermal_irq_enable(priv);
		rcar_thermal_common_write(common, ENR, 0x03);
	}

	return 0;
}
#endif

static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
			 rcar_thermal_resume);

static struct platform_driver rcar_thermal_driver = {
	.driver	= {
		.name	= "rcar_thermal",
		.pm = &rcar_thermal_pm_ops,
		.of_match_table = rcar_thermal_dt_ids,
	},
	.probe		= rcar_thermal_probe,
	.remove		= rcar_thermal_remove,
};
module_platform_driver(rcar_thermal_driver);

MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
Commit	Line	Data
c9545790	1	// SPDX-License-Identifier: GPL-2.0
1e426ffd KM	2	/*
	3	* R-Car THS/TSC thermal sensor driver
	4	*
	5	* Copyright (C) 2012 Renesas Solutions Corp.
	6	* Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
1e426ffd KM	7	*/
	8	#include <linux/delay.h>
	9	#include <linux/err.h>
e0a5172e KM	10	#include <linux/irq.h>
e0a5172e KM	11	#include <linux/interrupt.h>
1e426ffd KM	12	#include <linux/io.h>
1e426ffd KM	13	#include <linux/module.h>
8b477ea5	14	#include <linux/of_device.h>
1e426ffd	15	#include <linux/platform_device.h>
51d45d25	16	#include <linux/pm_runtime.h>
d2a73e22	17	#include <linux/reboot.h>
1e426ffd KM	18	#include <linux/slab.h>
	19	#include <linux/spinlock.h>
	20	#include <linux/thermal.h>
	21
64a411e8 KM	22	#include "thermal_hwmon.h"
64a411e8 KM	23
d2a73e22 KM	24	#define IDLE_INTERVAL 5000
d2a73e22 KM	25
e0a5172e KM	26	#define COMMON_STR 0x00
	27	#define COMMON_ENR 0x04
	28	#define COMMON_INTMSK 0x0c
	29
	30	#define REG_POSNEG 0x20
	31	#define REG_FILONOFF 0x28
e9137a58 KM	32	#define REG_THSCR 0x2c
e9137a58 KM	33	#define REG_THSSR 0x30
e0a5172e	34	#define REG_INTCTRL 0x34
1e426ffd KM	35
1e426ffd KM	36	/* THSCR */
f8f53e18	37	#define CPCTL (1 << 12)
1e426ffd KM	38
	39	/* THSSR */
	40	#define CTEMP 0x3f
	41
3676d1dd KM	42	struct rcar_thermal_common {
	43	void __iomem *base;
	44	struct device *dev;
	45	struct list_head head;
e0a5172e	46	spinlock_t lock;
3676d1dd	47	};
1e426ffd	48
1969d9dc YK	49	struct rcar_thermal_chip {
	50	unsigned int use_of_thermal : 1;
	51	unsigned int has_filonoff : 1;
	52	unsigned int irq_per_ch : 1;
	53	unsigned int needs_suspend_resume : 1;
	54	unsigned int nirqs;
	55	};
	56
	57	static const struct rcar_thermal_chip rcar_thermal = {
	58	.use_of_thermal = 0,
	59	.has_filonoff = 1,
	60	.irq_per_ch = 0,
	61	.needs_suspend_resume = 0,
	62	.nirqs = 1,
	63	};
	64
	65	static const struct rcar_thermal_chip rcar_gen2_thermal = {
	66	.use_of_thermal = 1,
	67	.has_filonoff = 1,
	68	.irq_per_ch = 0,
	69	.needs_suspend_resume = 0,
	70	.nirqs = 1,
	71	};
	72
	73	static const struct rcar_thermal_chip rcar_gen3_thermal = {
	74	.use_of_thermal = 1,
	75	.has_filonoff = 0,
	76	.irq_per_ch = 1,
	77	.needs_suspend_resume = 1,
	78	/*
	79	* The Gen3 chip has 3 interrupts, but this driver uses only 2
	80	* interrupts to detect a temperature change, rise or fall.
	81	*/
	82	.nirqs = 2,
	83	};
	84
1e426ffd KM	85	struct rcar_thermal_priv {
1e426ffd KM	86	void __iomem *base;
3676d1dd KM	87	struct rcar_thermal_common *common;
3676d1dd KM	88	struct thermal_zone_device *zone;
1969d9dc	89	const struct rcar_thermal_chip *chip;
e0a5172e	90	struct delayed_work work;
b2bbc6a2	91	struct mutex lock;
3676d1dd	92	struct list_head list;
e0a5172e	93	int id;
913015c6	94	u32 ctemp;
1e426ffd KM	95	};
1e426ffd KM	96
3676d1dd KM	97	#define rcar_thermal_for_each_priv(pos, common) \
	98	list_for_each_entry(pos, &common->head, list)
	99
c499703e	100	#define MCELSIUS(temp) ((temp) * 1000)
9dde8f86	101	#define rcar_zone_to_priv(zone) ((zone)->devdata)
3676d1dd KM	102	#define rcar_priv_to_dev(priv) ((priv)->common->dev)
3676d1dd KM	103	#define rcar_has_irq_support(priv) ((priv)->common->base)
e0a5172e KM	104	#define rcar_id_to_shift(priv) ((priv)->id * 8)
e0a5172e KM	105
ca1e4558	106	static const struct of_device_id rcar_thermal_dt_ids[] = {
1969d9dc YK	107	{
	108	.compatible = "renesas,rcar-thermal",
	109	.data = &rcar_thermal,
	110	},
	111	{
	112	.compatible = "renesas,rcar-gen2-thermal",
	113	.data = &rcar_gen2_thermal,
	114	},
	115	{
	116	.compatible = "renesas,thermal-r8a77995",
	117	.data = &rcar_gen3_thermal,
	118	},
ca1e4558 KM	119	{},
	120	};
	121	MODULE_DEVICE_TABLE(of, rcar_thermal_dt_ids);
	122
1e426ffd KM	123	/*
	124	* basic functions
	125	*/
e9137a58 KM	126	#define rcar_thermal_common_read(c, r) \
	127	_rcar_thermal_common_read(c, COMMON_ ##r)
	128	static u32 _rcar_thermal_common_read(struct rcar_thermal_common *common,
	129	u32 reg)
	130	{
	131	return ioread32(common->base + reg);
	132	}
	133
	134	#define rcar_thermal_common_write(c, r, d) \
	135	_rcar_thermal_common_write(c, COMMON_ ##r, d)
	136	static void _rcar_thermal_common_write(struct rcar_thermal_common *common,
	137	u32 reg, u32 data)
	138	{
	139	iowrite32(data, common->base + reg);
	140	}
	141
	142	#define rcar_thermal_common_bset(c, r, m, d) \
	143	_rcar_thermal_common_bset(c, COMMON_ ##r, m, d)
	144	static void _rcar_thermal_common_bset(struct rcar_thermal_common *common,
	145	u32 reg, u32 mask, u32 data)
	146	{
	147	u32 val;
	148
	149	val = ioread32(common->base + reg);
	150	val &= ~mask;
	151	val \|= (data & mask);
	152	iowrite32(val, common->base + reg);
	153	}
e9137a58 KM	154
	155	#define rcar_thermal_read(p, r) _rcar_thermal_read(p, REG_ ##r)
	156	static u32 _rcar_thermal_read(struct rcar_thermal_priv *priv, u32 reg)
1e426ffd	157	{
b2bbc6a2	158	return ioread32(priv->base + reg);
1e426ffd KM	159	}
1e426ffd KM	160
e9137a58 KM	161	#define rcar_thermal_write(p, r, d) _rcar_thermal_write(p, REG_ ##r, d)
	162	static void _rcar_thermal_write(struct rcar_thermal_priv *priv,
	163	u32 reg, u32 data)
1e426ffd	164	{
1e426ffd	165	iowrite32(data, priv->base + reg);
1e426ffd	166	}
1e426ffd	167
e9137a58 KM	168	#define rcar_thermal_bset(p, r, m, d) _rcar_thermal_bset(p, REG_ ##r, m, d)
	169	static void _rcar_thermal_bset(struct rcar_thermal_priv *priv, u32 reg,
	170	u32 mask, u32 data)
1e426ffd	171	{
1e426ffd KM	172	u32 val;
1e426ffd KM	173
1e426ffd KM	174	val = ioread32(priv->base + reg);
	175	val &= ~mask;
	176	val \|= (data & mask);
	177	iowrite32(val, priv->base + reg);
1e426ffd KM	178	}
	179
	180	/*
	181	* zone device functions
	182	*/
e0a5172e	183	static int rcar_thermal_update_temp(struct rcar_thermal_priv *priv)
1e426ffd	184	{
f8f53e18 KM	185	struct device *dev = rcar_priv_to_dev(priv);
f8f53e18 KM	186	int i;
913015c6	187	u32 ctemp, old, new;
f0e68fc3	188	int ret = -EINVAL;
f8f53e18	189
b2bbc6a2 KM	190	mutex_lock(&priv->lock);
b2bbc6a2 KM	191
f8f53e18 KM	192	/*
	193	* TSC decides a value of CPTAP automatically,
	194	* and this is the conditions which validate interrupt.
	195	*/
	196	rcar_thermal_bset(priv, THSCR, CPCTL, CPCTL);
	197
	198	ctemp = 0;
	199	old = ~0;
	200	for (i = 0; i < 128; i++) {
1e426ffd KM	201	/*
	202	* we need to wait 300us after changing comparator offset
	203	* to get stable temperature.
	204	* see "Usage Notes" on datasheet
	205	*/
1e426ffd KM	206	udelay(300);
1e426ffd KM	207
f8f53e18 KM	208	new = rcar_thermal_read(priv, THSSR) & CTEMP;
	209	if (new == old) {
	210	ctemp = new;
1e426ffd KM	211	break;
1e426ffd KM	212	}
f8f53e18	213	old = new;
1e426ffd KM	214	}
1e426ffd KM	215
f8f53e18 KM	216	if (!ctemp) {
f8f53e18 KM	217	dev_err(dev, "thermal sensor was broken\n");
f0e68fc3	218	goto err_out_unlock;
f8f53e18 KM	219	}
f8f53e18 KM	220
e0a5172e KM	221	/*
	222	* enable IRQ
	223	*/
	224	if (rcar_has_irq_support(priv)) {
1969d9dc YK	225	if (priv->chip->has_filonoff)
1969d9dc YK	226	rcar_thermal_write(priv, FILONOFF, 0);
e0a5172e KM	227
	228	/* enable Rising/Falling edge interrupt */
	229	rcar_thermal_write(priv, POSNEG, 0x1);
	230	rcar_thermal_write(priv, INTCTRL, (((ctemp - 0) << 8) \|
	231	((ctemp - 1) << 0)));
	232	}
	233
	234	dev_dbg(dev, "thermal%d %d -> %d\n", priv->id, priv->ctemp, ctemp);
	235
	236	priv->ctemp = ctemp;
f0e68fc3 WY	237	ret = 0;
f0e68fc3 WY	238	err_out_unlock:
b2bbc6a2	239	mutex_unlock(&priv->lock);
f0e68fc3	240	return ret;
1e426ffd KM	241	}
1e426ffd KM	242
8b477ea5 KM	243	static int rcar_thermal_get_current_temp(struct rcar_thermal_priv *priv,
8b477ea5 KM	244	int *temp)
e0a5172e	245	{
5440c40b	246	int tmp;
a1ade565	247	int ret;
e0a5172e	248
a1ade565 KM	249	ret = rcar_thermal_update_temp(priv);
	250	if (ret < 0)
	251	return ret;
e0a5172e KM	252
e0a5172e KM	253	mutex_lock(&priv->lock);
5440c40b	254	tmp = MCELSIUS((priv->ctemp * 5) - 65);
e0a5172e KM	255	mutex_unlock(&priv->lock);
e0a5172e KM	256
5440c40b KM	257	if ((tmp < MCELSIUS(-45)) \|\| (tmp > MCELSIUS(125))) {
	258	struct device *dev = rcar_priv_to_dev(priv);
	259
	260	dev_err(dev, "it couldn't measure temperature correctly\n");
	261	return -EIO;
	262	}
	263
	264	*temp = tmp;
	265
e0a5172e KM	266	return 0;
	267	}
	268
8b477ea5 KM	269	static int rcar_thermal_of_get_temp(void data, int temp)
	270	{
	271	struct rcar_thermal_priv *priv = data;
	272
	273	return rcar_thermal_get_current_temp(priv, temp);
	274	}
	275
	276	static int rcar_thermal_get_temp(struct thermal_zone_device zone, int temp)
	277	{
	278	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
	279
	280	return rcar_thermal_get_current_temp(priv, temp);
	281	}
	282
d2a73e22 KM	283	static int rcar_thermal_get_trip_type(struct thermal_zone_device *zone,
	284	int trip, enum thermal_trip_type *type)
	285	{
	286	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
3676d1dd	287	struct device *dev = rcar_priv_to_dev(priv);
d2a73e22 KM	288
	289	/* see rcar_thermal_get_temp() */
	290	switch (trip) {
	291	case 0: /* +90 <= temp */
	292	*type = THERMAL_TRIP_CRITICAL;
	293	break;
	294	default:
3676d1dd	295	dev_err(dev, "rcar driver trip error\n");
d2a73e22 KM	296	return -EINVAL;
	297	}
	298
	299	return 0;
	300	}
	301
	302	static int rcar_thermal_get_trip_temp(struct thermal_zone_device *zone,
17e8351a	303	int trip, int *temp)
d2a73e22 KM	304	{
d2a73e22 KM	305	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
3676d1dd	306	struct device *dev = rcar_priv_to_dev(priv);
d2a73e22 KM	307
	308	/* see rcar_thermal_get_temp() */
	309	switch (trip) {
	310	case 0: /* +90 <= temp */
	311	*temp = MCELSIUS(90);
	312	break;
	313	default:
3676d1dd	314	dev_err(dev, "rcar driver trip error\n");
d2a73e22 KM	315	return -EINVAL;
	316	}
	317
	318	return 0;
	319	}
	320
	321	static int rcar_thermal_notify(struct thermal_zone_device *zone,
	322	int trip, enum thermal_trip_type type)
	323	{
	324	struct rcar_thermal_priv *priv = rcar_zone_to_priv(zone);
3676d1dd	325	struct device *dev = rcar_priv_to_dev(priv);
d2a73e22 KM	326
	327	switch (type) {
	328	case THERMAL_TRIP_CRITICAL:
	329	/* FIXME */
3676d1dd	330	dev_warn(dev, "Thermal reached to critical temperature\n");
d2a73e22 KM	331	break;
	332	default:
	333	break;
	334	}
	335
	336	return 0;
	337	}
	338
8b477ea5 KM	339	static const struct thermal_zone_of_device_ops rcar_thermal_zone_of_ops = {
	340	.get_temp = rcar_thermal_of_get_temp,
	341	};
	342
1e426ffd	343	static struct thermal_zone_device_ops rcar_thermal_zone_ops = {
d2a73e22 KM	344	.get_temp = rcar_thermal_get_temp,
	345	.get_trip_type = rcar_thermal_get_trip_type,
	346	.get_trip_temp = rcar_thermal_get_trip_temp,
	347	.notify = rcar_thermal_notify,
1e426ffd KM	348	};
1e426ffd KM	349
e0a5172e KM	350	/*
	351	* interrupt
	352	*/
	353	#define rcar_thermal_irq_enable(p) _rcar_thermal_irq_ctrl(p, 1)
	354	#define rcar_thermal_irq_disable(p) _rcar_thermal_irq_ctrl(p, 0)
	355	static void _rcar_thermal_irq_ctrl(struct rcar_thermal_priv *priv, int enable)
	356	{
	357	struct rcar_thermal_common *common = priv->common;
	358	unsigned long flags;
	359	u32 mask = 0x3 << rcar_id_to_shift(priv); /* enable Rising/Falling */
	360
ffbcdf8a KM	361	if (!rcar_has_irq_support(priv))
	362	return;
	363
e0a5172e KM	364	spin_lock_irqsave(&common->lock, flags);
	365
	366	rcar_thermal_common_bset(common, INTMSK, mask, enable ? 0 : mask);
	367
	368	spin_unlock_irqrestore(&common->lock, flags);
	369	}
	370
	371	static void rcar_thermal_work(struct work_struct *work)
	372	{
	373	struct rcar_thermal_priv *priv;
17e8351a	374	int cctemp, nctemp;
a1ade565	375	int ret;
e0a5172e KM	376
	377	priv = container_of(work, struct rcar_thermal_priv, work.work);
	378
8b477ea5 KM	379	ret = rcar_thermal_get_current_temp(priv, &cctemp);
	380	if (ret < 0)
	381	return;
	382
a1ade565 KM	383	ret = rcar_thermal_update_temp(priv);
	384	if (ret < 0)
	385	return;
	386
e0a5172e	387	rcar_thermal_irq_enable(priv);
9477165e	388
8b477ea5 KM	389	ret = rcar_thermal_get_current_temp(priv, &nctemp);
	390	if (ret < 0)
	391	return;
	392
9477165e	393	if (nctemp != cctemp)
0e70f466 SP	394	thermal_zone_device_update(priv->zone,
0e70f466 SP	395	THERMAL_EVENT_UNSPECIFIED);
e0a5172e KM	396	}
	397
	398	static u32 rcar_thermal_had_changed(struct rcar_thermal_priv *priv, u32 status)
	399	{
	400	struct device *dev = rcar_priv_to_dev(priv);
	401
	402	status = (status >> rcar_id_to_shift(priv)) & 0x3;
	403
206c0cba	404	if (status) {
e0a5172e KM	405	dev_dbg(dev, "thermal%d %s%s\n",
	406	priv->id,
	407	(status & 0x2) ? "Rising " : "",
	408	(status & 0x1) ? "Falling" : "");
	409	}
	410
	411	return status;
	412	}
	413
	414	static irqreturn_t rcar_thermal_irq(int irq, void *data)
	415	{
	416	struct rcar_thermal_common *common = data;
	417	struct rcar_thermal_priv *priv;
	418	unsigned long flags;
	419	u32 status, mask;
	420
	421	spin_lock_irqsave(&common->lock, flags);
	422
	423	mask = rcar_thermal_common_read(common, INTMSK);
	424	status = rcar_thermal_common_read(common, STR);
	425	rcar_thermal_common_write(common, STR, 0x000F0F0F & mask);
	426
	427	spin_unlock_irqrestore(&common->lock, flags);
	428
	429	status = status & ~mask;
	430
	431	/*
	432	* check the status
	433	*/
	434	rcar_thermal_for_each_priv(priv, common) {
	435	if (rcar_thermal_had_changed(priv, status)) {
	436	rcar_thermal_irq_disable(priv);
	437	schedule_delayed_work(&priv->work,
	438	msecs_to_jiffies(300));
	439	}
	440	}
	441
	442	return IRQ_HANDLED;
	443	}
	444
1e426ffd KM	445	/*
	446	* platform functions
	447	*/
84f0e490 KM	448	static int rcar_thermal_remove(struct platform_device *pdev)
	449	{
	450	struct rcar_thermal_common *common = platform_get_drvdata(pdev);
	451	struct device *dev = &pdev->dev;
	452	struct rcar_thermal_priv *priv;
	453
	454	rcar_thermal_for_each_priv(priv, common) {
ffbcdf8a	455	rcar_thermal_irq_disable(priv);
1969d9dc	456	if (priv->chip->use_of_thermal)
64a411e8	457	thermal_remove_hwmon_sysfs(priv->zone);
d4b23c5c BDP	458	else
d4b23c5c BDP	459	thermal_zone_device_unregister(priv->zone);
84f0e490 KM	460	}
	461
	462	pm_runtime_put(dev);
	463	pm_runtime_disable(dev);
	464
	465	return 0;
	466	}
	467
1e426ffd KM	468	static int rcar_thermal_probe(struct platform_device *pdev)
1e426ffd KM	469	{
3676d1dd	470	struct rcar_thermal_common *common;
1e426ffd	471	struct rcar_thermal_priv *priv;
3676d1dd KM	472	struct device *dev = &pdev->dev;
3676d1dd KM	473	struct resource res, irq;
1969d9dc	474	const struct rcar_thermal_chip *chip = of_device_get_match_data(dev);
3676d1dd KM	475	int mres = 0;
3676d1dd KM	476	int i;
fb84d990	477	int ret = -ENODEV;
e0a5172e	478	int idle = IDLE_INTERVAL;
11313746	479	u32 enr_bits = 0;
1e426ffd	480
3676d1dd	481	common = devm_kzalloc(dev, sizeof(*common), GFP_KERNEL);
b0a60d88	482	if (!common)
1e426ffd	483	return -ENOMEM;
1e426ffd	484
84f0e490 KM	485	platform_set_drvdata(pdev, common);
84f0e490 KM	486
3676d1dd	487	INIT_LIST_HEAD(&common->head);
e0a5172e	488	spin_lock_init(&common->lock);
3676d1dd KM	489	common->dev = dev;
3676d1dd KM	490
51d45d25 KM	491	pm_runtime_enable(dev);
	492	pm_runtime_get_sync(dev);
	493
1969d9dc YK	494	for (i = 0; i < chip->nirqs; i++) {
	495	irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
	496	if (!irq)
	497	continue;
	498	if (!common->base) {
	499	/*
	500	* platform has IRQ support.
	501	* Then, driver uses common registers
	502	* rcar_has_irq_support() will be enabled
	503	*/
	504	res = platform_get_resource(pdev, IORESOURCE_MEM,
	505	mres++);
	506	common->base = devm_ioremap_resource(dev, res);
	507	if (IS_ERR(common->base))
	508	return PTR_ERR(common->base);
	509
	510	idle = 0; /* polling delay is not needed */
	511	}
e0a5172e	512
1969d9dc YK	513	ret = devm_request_irq(dev, irq->start, rcar_thermal_irq,
	514	IRQF_SHARED, dev_name(dev), common);
	515	if (ret) {
	516	dev_err(dev, "irq request failed\n ");
	517	goto error_unregister;
	518	}
	519
	520	/* update ENR bits */
	521	if (chip->irq_per_ch)
	522	enr_bits \|= 1 << i;
1e426ffd KM	523	}
1e426ffd KM	524
3676d1dd KM	525	for (i = 0;; i++) {
	526	res = platform_get_resource(pdev, IORESOURCE_MEM, mres++);
	527	if (!res)
	528	break;
	529
	530	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
	531	if (!priv) {
1dc20828 KM	532	ret = -ENOMEM;
1dc20828 KM	533	goto error_unregister;
3676d1dd KM	534	}
3676d1dd KM	535
5095526f	536	priv->base = devm_ioremap_resource(dev, res);
1dc20828 KM	537	if (IS_ERR(priv->base)) {
	538	ret = PTR_ERR(priv->base);
	539	goto error_unregister;
	540	}
3676d1dd KM	541
3676d1dd KM	542	priv->common = common;
e0a5172e	543	priv->id = i;
1969d9dc	544	priv->chip = chip;
3676d1dd KM	545	mutex_init(&priv->lock);
3676d1dd KM	546	INIT_LIST_HEAD(&priv->list);
e0a5172e	547	INIT_DELAYED_WORK(&priv->work, rcar_thermal_work);
a1ade565 KM	548	ret = rcar_thermal_update_temp(priv);
	549	if (ret < 0)
	550	goto error_unregister;
3676d1dd	551
1969d9dc	552	if (chip->use_of_thermal)
5e325868	553	priv->zone = devm_thermal_zone_of_sensor_register(
8b477ea5 KM	554	dev, i, priv,
	555	&rcar_thermal_zone_of_ops);
	556	else
	557	priv->zone = thermal_zone_device_register(
	558	"rcar_thermal",
3676d1dd KM	559	1, 0, priv,
3676d1dd KM	560	&rcar_thermal_zone_ops, NULL, 0,
e0a5172e	561	idle);
3676d1dd KM	562	if (IS_ERR(priv->zone)) {
3676d1dd KM	563	dev_err(dev, "can't register thermal zone\n");
fb84d990	564	ret = PTR_ERR(priv->zone);
87260d3f	565	priv->zone = NULL;
3676d1dd KM	566	goto error_unregister;
	567	}
	568
1969d9dc	569	if (chip->use_of_thermal) {
64a411e8 KM	570	/*
	571	* thermal_zone doesn't enable hwmon as default,
	572	* but, enable it here to keep compatible
	573	*/
	574	priv->zone->tzp->no_hwmon = false;
	575	ret = thermal_add_hwmon_sysfs(priv->zone);
	576	if (ret)
	577	goto error_unregister;
	578	}
	579
ffbcdf8a	580	rcar_thermal_irq_enable(priv);
1dc20828 KM	581
1dc20828 KM	582	list_move_tail(&priv->list, &common->head);
11313746 YS	583
11313746 YS	584	/* update ENR bits */
1969d9dc YK	585	if (!chip->irq_per_ch)
1969d9dc YK	586	enr_bits \|= 3 << (i * 8);
1e426ffd KM	587	}
1e426ffd KM	588
542cdf40	589	if (common->base && enr_bits)
11313746 YS	590	rcar_thermal_common_write(common, ENR, enr_bits);
11313746 YS	591
3db46c93	592	dev_info(dev, "%d sensor probed\n", i);
1e426ffd KM	593
1e426ffd KM	594	return 0;
3676d1dd KM	595
3676d1dd KM	596	error_unregister:
84f0e490	597	rcar_thermal_remove(pdev);
51d45d25	598
fb84d990	599	return ret;
1e426ffd KM	600	}
1e426ffd KM	601
1969d9dc YK	602	#ifdef CONFIG_PM_SLEEP
	603	static int rcar_thermal_suspend(struct device *dev)
	604	{
	605	struct rcar_thermal_common *common = dev_get_drvdata(dev);
	606	struct rcar_thermal_priv *priv = list_first_entry(&common->head,
	607	typeof(*priv), list);
	608
	609	if (priv->chip->needs_suspend_resume) {
	610	rcar_thermal_common_write(common, ENR, 0);
	611	rcar_thermal_irq_disable(priv);
	612	rcar_thermal_bset(priv, THSCR, CPCTL, 0);
	613	}
	614
	615	return 0;
	616	}
	617
	618	static int rcar_thermal_resume(struct device *dev)
	619	{
	620	struct rcar_thermal_common *common = dev_get_drvdata(dev);
	621	struct rcar_thermal_priv *priv = list_first_entry(&common->head,
	622	typeof(*priv), list);
	623	int ret;
	624
	625	if (priv->chip->needs_suspend_resume) {
	626	ret = rcar_thermal_update_temp(priv);
	627	if (ret < 0)
	628	return ret;
	629	rcar_thermal_irq_enable(priv);
	630	rcar_thermal_common_write(common, ENR, 0x03);
	631	}
	632
	633	return 0;
	634	}
	635	#endif
	636
	637	static SIMPLE_DEV_PM_OPS(rcar_thermal_pm_ops, rcar_thermal_suspend,
	638	rcar_thermal_resume);
	639
1e426ffd KM	640	static struct platform_driver rcar_thermal_driver = {
	641	.driver = {
	642	.name = "rcar_thermal",
1969d9dc	643	.pm = &rcar_thermal_pm_ops,
76cc1887	644	.of_match_table = rcar_thermal_dt_ids,
1e426ffd KM	645	},
	646	.probe = rcar_thermal_probe,
	647	.remove = rcar_thermal_remove,
	648	};
	649	module_platform_driver(rcar_thermal_driver);
	650
c9545790	651	MODULE_LICENSE("GPL v2");
1e426ffd KM	652	MODULE_DESCRIPTION("R-Car THS/TSC thermal sensor driver");
1e426ffd KM	653	MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");