[deliverable/linux.git] / drivers / thermal / armada_thermal.c

/*
 * Marvell Armada 370/XP thermal sensor driver
 *
 * Copyright (C) 2013 Marvell
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * 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.
 *
 */
#include <linux/device.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/of.h>
#include <linux/module.h>
#include <linux/delay.h>
#include <linux/platform_device.h>
#include <linux/of_device.h>
#include <linux/thermal.h>

#define THERMAL_VALID_MASK		0x1

/* Thermal Manager Control and Status Register */
#define PMU_TDC0_SW_RST_MASK		(0x1 << 1)
#define PMU_TM_DISABLE_OFFS		0
#define PMU_TM_DISABLE_MASK		(0x1 << PMU_TM_DISABLE_OFFS)
#define PMU_TDC0_REF_CAL_CNT_OFFS	11
#define PMU_TDC0_REF_CAL_CNT_MASK	(0x1ff << PMU_TDC0_REF_CAL_CNT_OFFS)
#define PMU_TDC0_OTF_CAL_MASK		(0x1 << 30)
#define PMU_TDC0_START_CAL_MASK		(0x1 << 25)

struct armada_thermal_data;

/* Marvell EBU Thermal Sensor Dev Structure */
struct armada_thermal_priv {
	void __iomem *sensor;
	void __iomem *control;
	struct armada_thermal_data *data;
};

struct armada_thermal_data {
	/* Initialize the sensor */
	void (*init_sensor)(struct platform_device *pdev,
			    struct armada_thermal_priv *);

	/* Test for a valid sensor value (optional) */
	bool (*is_valid)(struct armada_thermal_priv *);

	/* Formula coeficients: temp = (b + m * reg) / div */
	unsigned long coef_b;
	unsigned long coef_m;
	unsigned long coef_div;
	bool inverted;

	/* Register shift and mask to access the sensor temperature */
	unsigned int temp_shift;
	unsigned int temp_mask;
	unsigned int is_valid_shift;
};

static void armadaxp_init_sensor(struct platform_device *pdev,
				 struct armada_thermal_priv *priv)
{
	unsigned long reg;

	reg = readl_relaxed(priv->control);
	reg |= PMU_TDC0_OTF_CAL_MASK;
	writel(reg, priv->control);

	/* Reference calibration value */
	reg &= ~PMU_TDC0_REF_CAL_CNT_MASK;
	reg |= (0xf1 << PMU_TDC0_REF_CAL_CNT_OFFS);
	writel(reg, priv->control);

	/* Reset the sensor */
	reg = readl_relaxed(priv->control);
	writel((reg | PMU_TDC0_SW_RST_MASK), priv->control);

	writel(reg, priv->control);

	/* Enable the sensor */
	reg = readl_relaxed(priv->sensor);
	reg &= ~PMU_TM_DISABLE_MASK;
	writel(reg, priv->sensor);
}

static void armada370_init_sensor(struct platform_device *pdev,
				  struct armada_thermal_priv *priv)
{
	unsigned long reg;

	reg = readl_relaxed(priv->control);
	reg |= PMU_TDC0_OTF_CAL_MASK;
	writel(reg, priv->control);

	/* Reference calibration value */
	reg &= ~PMU_TDC0_REF_CAL_CNT_MASK;
	reg |= (0xf1 << PMU_TDC0_REF_CAL_CNT_OFFS);
	writel(reg, priv->control);

	reg &= ~PMU_TDC0_START_CAL_MASK;
	writel(reg, priv->control);

	mdelay(10);
}

static bool armada_is_valid(struct armada_thermal_priv *priv)
{
	unsigned long reg = readl_relaxed(priv->sensor);

	return (reg >> priv->data->is_valid_shift) & THERMAL_VALID_MASK;
}

static int armada_get_temp(struct thermal_zone_device *thermal,
			  unsigned long *temp)
{
	struct armada_thermal_priv *priv = thermal->devdata;
	unsigned long reg;
	unsigned long m, b, div;

	/* Valid check */
	if (priv->data->is_valid && !priv->data->is_valid(priv)) {
		dev_err(&thermal->device,
			"Temperature sensor reading not valid\n");
		return -EIO;
	}

	reg = readl_relaxed(priv->sensor);
	reg = (reg >> priv->data->temp_shift) & priv->data->temp_mask;

	/* Get formula coeficients */
	b = priv->data->coef_b;
	m = priv->data->coef_m;
	div = priv->data->coef_div;

	if (priv->data->inverted)
		*temp = ((m * reg) - b) / div;
	else
		*temp = (b - (m * reg)) / div;
	return 0;
}

static struct thermal_zone_device_ops ops = {
	.get_temp = armada_get_temp,
};

static const struct armada_thermal_data armadaxp_data = {
	.init_sensor = armadaxp_init_sensor,
	.temp_shift = 10,
	.temp_mask = 0x1ff,
	.coef_b = 3153000000UL,
	.coef_m = 10000000UL,
	.coef_div = 13825,
};

static const struct armada_thermal_data armada370_data = {
	.is_valid = armada_is_valid,
	.init_sensor = armada370_init_sensor,
	.is_valid_shift = 9,
	.temp_shift = 10,
	.temp_mask = 0x1ff,
	.coef_b = 3153000000UL,
	.coef_m = 10000000UL,
	.coef_div = 13825,
};

static const struct of_device_id armada_thermal_id_table[] = {
	{
		.compatible = "marvell,armadaxp-thermal",
		.data       = &armadaxp_data,
	},
	{
		.compatible = "marvell,armada370-thermal",
		.data       = &armada370_data,
	},
	{
		/* sentinel */
	},
};
MODULE_DEVICE_TABLE(of, armada_thermal_id_table);

static int armada_thermal_probe(struct platform_device *pdev)
{
	struct thermal_zone_device *thermal;
	const struct of_device_id *match;
	struct armada_thermal_priv *priv;
	struct resource *res;

	match = of_match_device(armada_thermal_id_table, &pdev->dev);
	if (!match)
		return -ENODEV;

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

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	priv->sensor = devm_ioremap_resource(&pdev->dev, res);
	if (IS_ERR(priv->sensor))
		return PTR_ERR(priv->sensor);

	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	priv->control = devm_ioremap_resource(&pdev->dev, res);
	if (IS_ERR(priv->control))
		return PTR_ERR(priv->control);

	priv->data = (struct armada_thermal_data *)match->data;
	priv->data->init_sensor(pdev, priv);

	thermal = thermal_zone_device_register("armada_thermal", 0, 0,
					       priv, &ops, NULL, 0, 0);
	if (IS_ERR(thermal)) {
		dev_err(&pdev->dev,
			"Failed to register thermal zone device\n");
		return PTR_ERR(thermal);
	}

	platform_set_drvdata(pdev, thermal);

	return 0;
}

static int armada_thermal_exit(struct platform_device *pdev)
{
	struct thermal_zone_device *armada_thermal =
		platform_get_drvdata(pdev);

	thermal_zone_device_unregister(armada_thermal);

	return 0;
}

static struct platform_driver armada_thermal_driver = {
	.probe = armada_thermal_probe,
	.remove = armada_thermal_exit,
	.driver = {
		.name = "armada_thermal",
		.owner = THIS_MODULE,
		.of_match_table = armada_thermal_id_table,
	},
};

module_platform_driver(armada_thermal_driver);

MODULE_AUTHOR("Ezequiel Garcia <ezequiel.garcia@free-electrons.com>");
MODULE_DESCRIPTION("Armada 370/XP thermal driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
fa0d654c EG	1	/*
	2	* Marvell Armada 370/XP thermal sensor driver
	3	*
	4	* Copyright (C) 2013 Marvell
	5	*
	6	* This software is licensed under the terms of the GNU General Public
	7	* License version 2, as published by the Free Software Foundation, and
	8	* may be copied, distributed, and modified under those terms.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	*/
	16	#include <linux/device.h>
	17	#include <linux/err.h>
	18	#include <linux/io.h>
	19	#include <linux/kernel.h>
	20	#include <linux/of.h>
	21	#include <linux/module.h>
	22	#include <linux/delay.h>
	23	#include <linux/platform_device.h>
	24	#include <linux/of_device.h>
	25	#include <linux/thermal.h>
	26
fa0d654c	27	#define THERMAL_VALID_MASK 0x1
fa0d654c EG	28
	29	/* Thermal Manager Control and Status Register */
	30	#define PMU_TDC0_SW_RST_MASK (0x1 << 1)
	31	#define PMU_TM_DISABLE_OFFS 0
	32	#define PMU_TM_DISABLE_MASK (0x1 << PMU_TM_DISABLE_OFFS)
	33	#define PMU_TDC0_REF_CAL_CNT_OFFS 11
	34	#define PMU_TDC0_REF_CAL_CNT_MASK (0x1ff << PMU_TDC0_REF_CAL_CNT_OFFS)
	35	#define PMU_TDC0_OTF_CAL_MASK (0x1 << 30)
	36	#define PMU_TDC0_START_CAL_MASK (0x1 << 25)
	37
66fdb7b6	38	struct armada_thermal_data;
fa0d654c EG	39
	40	/* Marvell EBU Thermal Sensor Dev Structure */
	41	struct armada_thermal_priv {
	42	void __iomem *sensor;
	43	void __iomem *control;
66fdb7b6	44	struct armada_thermal_data *data;
fa0d654c EG	45	};
fa0d654c EG	46
66fdb7b6	47	struct armada_thermal_data {
fa0d654c	48	/* Initialize the sensor */
04bf3d7e EG	49	void (init_sensor)(struct platform_device pdev,
04bf3d7e EG	50	struct armada_thermal_priv *);
fa0d654c EG	51
	52	/* Test for a valid sensor value (optional) */
	53	bool (is_valid)(struct armada_thermal_priv );
9484bc62 EG	54
	55	/* Formula coeficients: temp = (b + m * reg) / div */
	56	unsigned long coef_b;
	57	unsigned long coef_m;
	58	unsigned long coef_div;
fd2c94d5	59	bool inverted;
1fcacca4 EG	60
	61	/* Register shift and mask to access the sensor temperature */
	62	unsigned int temp_shift;
	63	unsigned int temp_mask;
	64	unsigned int is_valid_shift;
fa0d654c EG	65	};
fa0d654c EG	66
04bf3d7e EG	67	static void armadaxp_init_sensor(struct platform_device *pdev,
04bf3d7e EG	68	struct armada_thermal_priv *priv)
fa0d654c EG	69	{
	70	unsigned long reg;
	71
	72	reg = readl_relaxed(priv->control);
	73	reg \|= PMU_TDC0_OTF_CAL_MASK;
	74	writel(reg, priv->control);
	75
	76	/* Reference calibration value */
	77	reg &= ~PMU_TDC0_REF_CAL_CNT_MASK;
	78	reg \|= (0xf1 << PMU_TDC0_REF_CAL_CNT_OFFS);
	79	writel(reg, priv->control);
	80
	81	/* Reset the sensor */
	82	reg = readl_relaxed(priv->control);
	83	writel((reg \| PMU_TDC0_SW_RST_MASK), priv->control);
	84
	85	writel(reg, priv->control);
	86
	87	/* Enable the sensor */
	88	reg = readl_relaxed(priv->sensor);
	89	reg &= ~PMU_TM_DISABLE_MASK;
	90	writel(reg, priv->sensor);
	91	}
	92
04bf3d7e EG	93	static void armada370_init_sensor(struct platform_device *pdev,
04bf3d7e EG	94	struct armada_thermal_priv *priv)
fa0d654c EG	95	{
	96	unsigned long reg;
	97
	98	reg = readl_relaxed(priv->control);
	99	reg \|= PMU_TDC0_OTF_CAL_MASK;
	100	writel(reg, priv->control);
	101
	102	/* Reference calibration value */
	103	reg &= ~PMU_TDC0_REF_CAL_CNT_MASK;
	104	reg \|= (0xf1 << PMU_TDC0_REF_CAL_CNT_OFFS);
	105	writel(reg, priv->control);
	106
	107	reg &= ~PMU_TDC0_START_CAL_MASK;
	108	writel(reg, priv->control);
	109
	110	mdelay(10);
	111	}
	112
	113	static bool armada_is_valid(struct armada_thermal_priv *priv)
	114	{
	115	unsigned long reg = readl_relaxed(priv->sensor);
	116
1fcacca4	117	return (reg >> priv->data->is_valid_shift) & THERMAL_VALID_MASK;
fa0d654c EG	118	}
	119
	120	static int armada_get_temp(struct thermal_zone_device *thermal,
	121	unsigned long *temp)
	122	{
	123	struct armada_thermal_priv *priv = thermal->devdata;
	124	unsigned long reg;
9484bc62	125	unsigned long m, b, div;
fa0d654c EG	126
fa0d654c EG	127	/* Valid check */
66fdb7b6	128	if (priv->data->is_valid && !priv->data->is_valid(priv)) {
fa0d654c EG	129	dev_err(&thermal->device,
	130	"Temperature sensor reading not valid\n");
	131	return -EIO;
	132	}
	133
	134	reg = readl_relaxed(priv->sensor);
1fcacca4	135	reg = (reg >> priv->data->temp_shift) & priv->data->temp_mask;
9484bc62 EG	136
	137	/* Get formula coeficients */
	138	b = priv->data->coef_b;
	139	m = priv->data->coef_m;
	140	div = priv->data->coef_div;
	141
fd2c94d5 EG	142	if (priv->data->inverted)
	143	temp = ((m reg) - b) / div;
	144	else
	145	temp = (b - (m reg)) / div;
fa0d654c EG	146	return 0;
	147	}
	148
	149	static struct thermal_zone_device_ops ops = {
	150	.get_temp = armada_get_temp,
	151	};
	152
66fdb7b6	153	static const struct armada_thermal_data armadaxp_data = {
fa0d654c	154	.init_sensor = armadaxp_init_sensor,
1fcacca4 EG	155	.temp_shift = 10,
1fcacca4 EG	156	.temp_mask = 0x1ff,
9484bc62 EG	157	.coef_b = 3153000000UL,
	158	.coef_m = 10000000UL,
	159	.coef_div = 13825,
fa0d654c EG	160	};
fa0d654c EG	161
66fdb7b6	162	static const struct armada_thermal_data armada370_data = {
fa0d654c EG	163	.is_valid = armada_is_valid,
fa0d654c EG	164	.init_sensor = armada370_init_sensor,
1fcacca4 EG	165	.is_valid_shift = 9,
	166	.temp_shift = 10,
	167	.temp_mask = 0x1ff,
9484bc62 EG	168	.coef_b = 3153000000UL,
	169	.coef_m = 10000000UL,
	170	.coef_div = 13825,
fa0d654c EG	171	};
	172
	173	static const struct of_device_id armada_thermal_id_table[] = {
	174	{
	175	.compatible = "marvell,armadaxp-thermal",
66fdb7b6	176	.data = &armadaxp_data,
fa0d654c EG	177	},
	178	{
	179	.compatible = "marvell,armada370-thermal",
66fdb7b6	180	.data = &armada370_data,
fa0d654c EG	181	},
	182	{
	183	/* sentinel */
	184	},
	185	};
	186	MODULE_DEVICE_TABLE(of, armada_thermal_id_table);
	187
	188	static int armada_thermal_probe(struct platform_device *pdev)
	189	{
	190	struct thermal_zone_device *thermal;
	191	const struct of_device_id *match;
	192	struct armada_thermal_priv *priv;
	193	struct resource *res;
	194
	195	match = of_match_device(armada_thermal_id_table, &pdev->dev);
	196	if (!match)
	197	return -ENODEV;
	198
	199	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
	200	if (!priv)
	201	return -ENOMEM;
	202
	203	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
fa0d654c EG	204	priv->sensor = devm_ioremap_resource(&pdev->dev, res);
	205	if (IS_ERR(priv->sensor))
	206	return PTR_ERR(priv->sensor);
	207
	208	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
fa0d654c EG	209	priv->control = devm_ioremap_resource(&pdev->dev, res);
	210	if (IS_ERR(priv->control))
	211	return PTR_ERR(priv->control);
	212
66fdb7b6	213	priv->data = (struct armada_thermal_data *)match->data;
04bf3d7e	214	priv->data->init_sensor(pdev, priv);
fa0d654c EG	215
	216	thermal = thermal_zone_device_register("armada_thermal", 0, 0,
	217	priv, &ops, NULL, 0, 0);
	218	if (IS_ERR(thermal)) {
	219	dev_err(&pdev->dev,
	220	"Failed to register thermal zone device\n");
	221	return PTR_ERR(thermal);
	222	}
	223
	224	platform_set_drvdata(pdev, thermal);
	225
	226	return 0;
	227	}
	228
	229	static int armada_thermal_exit(struct platform_device *pdev)
	230	{
	231	struct thermal_zone_device *armada_thermal =
	232	platform_get_drvdata(pdev);
	233
	234	thermal_zone_device_unregister(armada_thermal);
fa0d654c EG	235
	236	return 0;
	237	}
	238
	239	static struct platform_driver armada_thermal_driver = {
	240	.probe = armada_thermal_probe,
	241	.remove = armada_thermal_exit,
	242	.driver = {
	243	.name = "armada_thermal",
	244	.owner = THIS_MODULE,
1d089e09	245	.of_match_table = armada_thermal_id_table,
fa0d654c EG	246	},
	247	};
	248
	249	module_platform_driver(armada_thermal_driver);
	250
	251	MODULE_AUTHOR("Ezequiel Garcia <ezequiel.garcia@free-electrons.com>");
	252	MODULE_DESCRIPTION("Armada 370/XP thermal driver");
	253	MODULE_LICENSE("GPL v2");