[linux-2.6-block.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)

#define A375_UNIT_CONTROL_SHIFT		27
#define A375_UNIT_CONTROL_MASK		0x7
#define A375_READOUT_INVERT		BIT(15)
#define A375_HW_RESETn			BIT(8)
#define A380_HW_RESET			BIT(8)

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 void armada375_init_sensor(struct platform_device *pdev,
				  struct armada_thermal_priv *priv)
{
	unsigned long reg;

	reg = readl(priv->control + 4);
	reg &= ~(A375_UNIT_CONTROL_MASK << A375_UNIT_CONTROL_SHIFT);
	reg &= ~A375_READOUT_INVERT;
	reg &= ~A375_HW_RESETn;

	writel(reg, priv->control + 4);
	mdelay(20);

	reg |= A375_HW_RESETn;
	writel(reg, priv->control + 4);
	mdelay(50);
}

static void armada380_init_sensor(struct platform_device *pdev,
				  struct armada_thermal_priv *priv)
{
	unsigned long reg = readl_relaxed(priv->control);

	/* Reset hardware once */
	if (!(reg & A380_HW_RESET)) {
		reg |= A380_HW_RESET;
		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 armada_thermal_data armada375_data = {
	.is_valid = armada_is_valid,
	.init_sensor = armada375_init_sensor,
	.is_valid_shift = 10,
	.temp_shift = 0,
	.temp_mask = 0x1ff,
	.coef_b = 3171900000UL,
	.coef_m = 10000000UL,
	.coef_div = 13616,
};

static const struct armada_thermal_data armada380_data = {
	.is_valid = armada_is_valid,
	.init_sensor = armada380_init_sensor,
	.is_valid_shift = 10,
	.temp_shift = 0,
	.temp_mask = 0x3ff,
	.coef_b = 2931108200UL,
	.coef_m = 5000000UL,
	.coef_div = 10502,
	.inverted = true,
};

static const struct of_device_id armada_thermal_id_table[] = {
	{
		.compatible = "marvell,armadaxp-thermal",
		.data       = &armadaxp_data,
	},
	{
		.compatible = "marvell,armada370-thermal",
		.data       = &armada370_data,
	},
	{
		.compatible = "marvell,armada375-thermal",
		.data       = &armada375_data,
	},
	{
		.compatible = "marvell,armada380-thermal",
		.data       = &armada380_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",
		.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
e2d5f05b EG	38	#define A375_UNIT_CONTROL_SHIFT 27
	39	#define A375_UNIT_CONTROL_MASK 0x7
	40	#define A375_READOUT_INVERT BIT(15)
	41	#define A375_HW_RESETn BIT(8)
e6e0a68c	42	#define A380_HW_RESET BIT(8)
e2d5f05b	43
66fdb7b6	44	struct armada_thermal_data;
fa0d654c EG	45
	46	/* Marvell EBU Thermal Sensor Dev Structure */
	47	struct armada_thermal_priv {
	48	void __iomem *sensor;
	49	void __iomem *control;
66fdb7b6	50	struct armada_thermal_data *data;
fa0d654c EG	51	};
fa0d654c EG	52
66fdb7b6	53	struct armada_thermal_data {
fa0d654c	54	/* Initialize the sensor */
04bf3d7e EG	55	void (init_sensor)(struct platform_device pdev,
04bf3d7e EG	56	struct armada_thermal_priv *);
fa0d654c EG	57
	58	/* Test for a valid sensor value (optional) */
	59	bool (is_valid)(struct armada_thermal_priv );
9484bc62 EG	60
	61	/* Formula coeficients: temp = (b + m * reg) / div */
	62	unsigned long coef_b;
	63	unsigned long coef_m;
	64	unsigned long coef_div;
fd2c94d5	65	bool inverted;
1fcacca4 EG	66
	67	/* Register shift and mask to access the sensor temperature */
	68	unsigned int temp_shift;
	69	unsigned int temp_mask;
	70	unsigned int is_valid_shift;
fa0d654c EG	71	};
fa0d654c EG	72
04bf3d7e EG	73	static void armadaxp_init_sensor(struct platform_device *pdev,
04bf3d7e EG	74	struct armada_thermal_priv *priv)
fa0d654c EG	75	{
	76	unsigned long reg;
	77
	78	reg = readl_relaxed(priv->control);
	79	reg \|= PMU_TDC0_OTF_CAL_MASK;
	80	writel(reg, priv->control);
	81
	82	/* Reference calibration value */
	83	reg &= ~PMU_TDC0_REF_CAL_CNT_MASK;
	84	reg \|= (0xf1 << PMU_TDC0_REF_CAL_CNT_OFFS);
	85	writel(reg, priv->control);
	86
	87	/* Reset the sensor */
	88	reg = readl_relaxed(priv->control);
	89	writel((reg \| PMU_TDC0_SW_RST_MASK), priv->control);
	90
	91	writel(reg, priv->control);
	92
	93	/* Enable the sensor */
	94	reg = readl_relaxed(priv->sensor);
	95	reg &= ~PMU_TM_DISABLE_MASK;
	96	writel(reg, priv->sensor);
	97	}
	98
04bf3d7e EG	99	static void armada370_init_sensor(struct platform_device *pdev,
04bf3d7e EG	100	struct armada_thermal_priv *priv)
fa0d654c EG	101	{
	102	unsigned long reg;
	103
	104	reg = readl_relaxed(priv->control);
	105	reg \|= PMU_TDC0_OTF_CAL_MASK;
	106	writel(reg, priv->control);
	107
	108	/* Reference calibration value */
	109	reg &= ~PMU_TDC0_REF_CAL_CNT_MASK;
	110	reg \|= (0xf1 << PMU_TDC0_REF_CAL_CNT_OFFS);
	111	writel(reg, priv->control);
	112
	113	reg &= ~PMU_TDC0_START_CAL_MASK;
	114	writel(reg, priv->control);
	115
	116	mdelay(10);
	117	}
	118
e2d5f05b EG	119	static void armada375_init_sensor(struct platform_device *pdev,
	120	struct armada_thermal_priv *priv)
	121	{
	122	unsigned long reg;
e2d5f05b EG	123
	124	reg = readl(priv->control + 4);
	125	reg &= ~(A375_UNIT_CONTROL_MASK << A375_UNIT_CONTROL_SHIFT);
	126	reg &= ~A375_READOUT_INVERT;
	127	reg &= ~A375_HW_RESETn;
	128
e2d5f05b EG	129	writel(reg, priv->control + 4);
	130	mdelay(20);
	131
	132	reg \|= A375_HW_RESETn;
	133	writel(reg, priv->control + 4);
	134	mdelay(50);
	135	}
	136
e6e0a68c EG	137	static void armada380_init_sensor(struct platform_device *pdev,
	138	struct armada_thermal_priv *priv)
	139	{
	140	unsigned long reg = readl_relaxed(priv->control);
	141
	142	/* Reset hardware once */
	143	if (!(reg & A380_HW_RESET)) {
	144	reg \|= A380_HW_RESET;
	145	writel(reg, priv->control);
	146	mdelay(10);
	147	}
	148	}
	149
fa0d654c EG	150	static bool armada_is_valid(struct armada_thermal_priv *priv)
	151	{
	152	unsigned long reg = readl_relaxed(priv->sensor);
	153
1fcacca4	154	return (reg >> priv->data->is_valid_shift) & THERMAL_VALID_MASK;
fa0d654c EG	155	}
	156
	157	static int armada_get_temp(struct thermal_zone_device *thermal,
	158	unsigned long *temp)
	159	{
	160	struct armada_thermal_priv *priv = thermal->devdata;
	161	unsigned long reg;
9484bc62	162	unsigned long m, b, div;
fa0d654c EG	163
fa0d654c EG	164	/* Valid check */
66fdb7b6	165	if (priv->data->is_valid && !priv->data->is_valid(priv)) {
fa0d654c EG	166	dev_err(&thermal->device,
	167	"Temperature sensor reading not valid\n");
	168	return -EIO;
	169	}
	170
	171	reg = readl_relaxed(priv->sensor);
1fcacca4	172	reg = (reg >> priv->data->temp_shift) & priv->data->temp_mask;
9484bc62 EG	173
	174	/* Get formula coeficients */
	175	b = priv->data->coef_b;
	176	m = priv->data->coef_m;
	177	div = priv->data->coef_div;
	178
fd2c94d5 EG	179	if (priv->data->inverted)
	180	temp = ((m reg) - b) / div;
	181	else
	182	temp = (b - (m reg)) / div;
fa0d654c EG	183	return 0;
	184	}
	185
	186	static struct thermal_zone_device_ops ops = {
	187	.get_temp = armada_get_temp,
	188	};
	189
66fdb7b6	190	static const struct armada_thermal_data armadaxp_data = {
fa0d654c	191	.init_sensor = armadaxp_init_sensor,
1fcacca4 EG	192	.temp_shift = 10,
1fcacca4 EG	193	.temp_mask = 0x1ff,
9484bc62 EG	194	.coef_b = 3153000000UL,
	195	.coef_m = 10000000UL,
	196	.coef_div = 13825,
fa0d654c EG	197	};
fa0d654c EG	198
66fdb7b6	199	static const struct armada_thermal_data armada370_data = {
fa0d654c EG	200	.is_valid = armada_is_valid,
fa0d654c EG	201	.init_sensor = armada370_init_sensor,
1fcacca4 EG	202	.is_valid_shift = 9,
	203	.temp_shift = 10,
	204	.temp_mask = 0x1ff,
9484bc62 EG	205	.coef_b = 3153000000UL,
	206	.coef_m = 10000000UL,
	207	.coef_div = 13825,
fa0d654c EG	208	};
fa0d654c EG	209
e2d5f05b EG	210	static const struct armada_thermal_data armada375_data = {
	211	.is_valid = armada_is_valid,
	212	.init_sensor = armada375_init_sensor,
	213	.is_valid_shift = 10,
	214	.temp_shift = 0,
	215	.temp_mask = 0x1ff,
	216	.coef_b = 3171900000UL,
	217	.coef_m = 10000000UL,
	218	.coef_div = 13616,
	219	};
	220
e6e0a68c EG	221	static const struct armada_thermal_data armada380_data = {
	222	.is_valid = armada_is_valid,
	223	.init_sensor = armada380_init_sensor,
	224	.is_valid_shift = 10,
	225	.temp_shift = 0,
	226	.temp_mask = 0x3ff,
efa86858 NH	227	.coef_b = 2931108200UL,
	228	.coef_m = 5000000UL,
	229	.coef_div = 10502,
e6e0a68c EG	230	.inverted = true,
	231	};
	232
fa0d654c EG	233	static const struct of_device_id armada_thermal_id_table[] = {
	234	{
	235	.compatible = "marvell,armadaxp-thermal",
66fdb7b6	236	.data = &armadaxp_data,
fa0d654c EG	237	},
	238	{
	239	.compatible = "marvell,armada370-thermal",
66fdb7b6	240	.data = &armada370_data,
fa0d654c	241	},
e2d5f05b EG	242	{
	243	.compatible = "marvell,armada375-thermal",
	244	.data = &armada375_data,
	245	},
e6e0a68c EG	246	{
	247	.compatible = "marvell,armada380-thermal",
	248	.data = &armada380_data,
	249	},
fa0d654c EG	250	{
	251	/* sentinel */
	252	},
	253	};
	254	MODULE_DEVICE_TABLE(of, armada_thermal_id_table);
	255
	256	static int armada_thermal_probe(struct platform_device *pdev)
	257	{
	258	struct thermal_zone_device *thermal;
	259	const struct of_device_id *match;
	260	struct armada_thermal_priv *priv;
	261	struct resource *res;
	262
	263	match = of_match_device(armada_thermal_id_table, &pdev->dev);
	264	if (!match)
	265	return -ENODEV;
	266
	267	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
	268	if (!priv)
	269	return -ENOMEM;
	270
	271	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
fa0d654c EG	272	priv->sensor = devm_ioremap_resource(&pdev->dev, res);
	273	if (IS_ERR(priv->sensor))
	274	return PTR_ERR(priv->sensor);
	275
	276	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
fa0d654c EG	277	priv->control = devm_ioremap_resource(&pdev->dev, res);
	278	if (IS_ERR(priv->control))
	279	return PTR_ERR(priv->control);
	280
66fdb7b6	281	priv->data = (struct armada_thermal_data *)match->data;
04bf3d7e	282	priv->data->init_sensor(pdev, priv);
fa0d654c EG	283
	284	thermal = thermal_zone_device_register("armada_thermal", 0, 0,
	285	priv, &ops, NULL, 0, 0);
	286	if (IS_ERR(thermal)) {
	287	dev_err(&pdev->dev,
	288	"Failed to register thermal zone device\n");
	289	return PTR_ERR(thermal);
	290	}
	291
	292	platform_set_drvdata(pdev, thermal);
	293
	294	return 0;
	295	}
	296
	297	static int armada_thermal_exit(struct platform_device *pdev)
	298	{
	299	struct thermal_zone_device *armada_thermal =
	300	platform_get_drvdata(pdev);
	301
	302	thermal_zone_device_unregister(armada_thermal);
fa0d654c EG	303
	304	return 0;
	305	}
	306
	307	static struct platform_driver armada_thermal_driver = {
	308	.probe = armada_thermal_probe,
	309	.remove = armada_thermal_exit,
	310	.driver = {
	311	.name = "armada_thermal",
1d089e09	312	.of_match_table = armada_thermal_id_table,
fa0d654c EG	313	},
	314	};
	315
	316	module_platform_driver(armada_thermal_driver);
	317
	318	MODULE_AUTHOR("Ezequiel Garcia <ezequiel.garcia@free-electrons.com>");
	319	MODULE_DESCRIPTION("Armada 370/XP thermal driver");
	320	MODULE_LICENSE("GPL v2");