[mirror_ubuntu-jammy-kernel.git] / drivers / thermal / thermal_hwmon.c

// SPDX-License-Identifier: GPL-2.0
/*
 *  thermal_hwmon.c - Generic Thermal Management hwmon support.
 *
 *  Code based on Intel thermal_core.c. Copyrights of the original code:
 *  Copyright (C) 2008 Intel Corp
 *  Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
 *  Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
 *
 *  Copyright (C) 2013 Texas Instruments
 *  Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
 */
#include <linux/err.h>
#include <linux/export.h>
#include <linux/hwmon.h>
#include <linux/slab.h>
#include <linux/thermal.h>

#include "thermal_hwmon.h"

/* hwmon sys I/F */
/* thermal zone devices with the same type share one hwmon device */
struct thermal_hwmon_device {
	char type[THERMAL_NAME_LENGTH];
	struct device *device;
	int count;
	struct list_head tz_list;
	struct list_head node;
};

struct thermal_hwmon_attr {
	struct device_attribute attr;
	char name[16];
};

/* one temperature input for each thermal zone */
struct thermal_hwmon_temp {
	struct list_head hwmon_node;
	struct thermal_zone_device *tz;
	struct thermal_hwmon_attr temp_input;	/* hwmon sys attr */
	struct thermal_hwmon_attr temp_crit;	/* hwmon sys attr */
};

static LIST_HEAD(thermal_hwmon_list);

static DEFINE_MUTEX(thermal_hwmon_list_lock);

static ssize_t
temp_input_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	int temperature;
	int ret;
	struct thermal_hwmon_attr *hwmon_attr
			= container_of(attr, struct thermal_hwmon_attr, attr);
	struct thermal_hwmon_temp *temp
			= container_of(hwmon_attr, struct thermal_hwmon_temp,
				       temp_input);
	struct thermal_zone_device *tz = temp->tz;

	ret = thermal_zone_get_temp(tz, &temperature);

	if (ret)
		return ret;

	return sprintf(buf, "%d\n", temperature);
}

static ssize_t
temp_crit_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct thermal_hwmon_attr *hwmon_attr
			= container_of(attr, struct thermal_hwmon_attr, attr);
	struct thermal_hwmon_temp *temp
			= container_of(hwmon_attr, struct thermal_hwmon_temp,
				       temp_crit);
	struct thermal_zone_device *tz = temp->tz;
	int temperature;
	int ret;

	ret = tz->ops->get_crit_temp(tz, &temperature);
	if (ret)
		return ret;

	return sprintf(buf, "%d\n", temperature);
}


static struct thermal_hwmon_device *
thermal_hwmon_lookup_by_type(const struct thermal_zone_device *tz)
{
	struct thermal_hwmon_device *hwmon;
	char type[THERMAL_NAME_LENGTH];

	mutex_lock(&thermal_hwmon_list_lock);
	list_for_each_entry(hwmon, &thermal_hwmon_list, node) {
		strcpy(type, tz->type);
		strreplace(type, '-', '_');
		if (!strcmp(hwmon->type, type)) {
			mutex_unlock(&thermal_hwmon_list_lock);
			return hwmon;
		}
	}
	mutex_unlock(&thermal_hwmon_list_lock);

	return NULL;
}

/* Find the temperature input matching a given thermal zone */
static struct thermal_hwmon_temp *
thermal_hwmon_lookup_temp(const struct thermal_hwmon_device *hwmon,
			  const struct thermal_zone_device *tz)
{
	struct thermal_hwmon_temp *temp;

	mutex_lock(&thermal_hwmon_list_lock);
	list_for_each_entry(temp, &hwmon->tz_list, hwmon_node)
		if (temp->tz == tz) {
			mutex_unlock(&thermal_hwmon_list_lock);
			return temp;
		}
	mutex_unlock(&thermal_hwmon_list_lock);

	return NULL;
}

static bool thermal_zone_crit_temp_valid(struct thermal_zone_device *tz)
{
	int temp;
	return tz->ops->get_crit_temp && !tz->ops->get_crit_temp(tz, &temp);
}

int thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
{
	struct thermal_hwmon_device *hwmon;
	struct thermal_hwmon_temp *temp;
	int new_hwmon_device = 1;
	int result;

	hwmon = thermal_hwmon_lookup_by_type(tz);
	if (hwmon) {
		new_hwmon_device = 0;
		goto register_sys_interface;
	}

	hwmon = kzalloc(sizeof(*hwmon), GFP_KERNEL);
	if (!hwmon)
		return -ENOMEM;

	INIT_LIST_HEAD(&hwmon->tz_list);
	strlcpy(hwmon->type, tz->type, THERMAL_NAME_LENGTH);
	strreplace(hwmon->type, '-', '_');
	hwmon->device = hwmon_device_register_with_info(&tz->device, hwmon->type,
							hwmon, NULL, NULL);
	if (IS_ERR(hwmon->device)) {
		result = PTR_ERR(hwmon->device);
		goto free_mem;
	}

 register_sys_interface:
	temp = kzalloc(sizeof(*temp), GFP_KERNEL);
	if (!temp) {
		result = -ENOMEM;
		goto unregister_name;
	}

	temp->tz = tz;
	hwmon->count++;

	snprintf(temp->temp_input.name, sizeof(temp->temp_input.name),
		 "temp%d_input", hwmon->count);
	temp->temp_input.attr.attr.name = temp->temp_input.name;
	temp->temp_input.attr.attr.mode = 0444;
	temp->temp_input.attr.show = temp_input_show;
	sysfs_attr_init(&temp->temp_input.attr.attr);
	result = device_create_file(hwmon->device, &temp->temp_input.attr);
	if (result)
		goto free_temp_mem;

	if (thermal_zone_crit_temp_valid(tz)) {
		snprintf(temp->temp_crit.name,
				sizeof(temp->temp_crit.name),
				"temp%d_crit", hwmon->count);
		temp->temp_crit.attr.attr.name = temp->temp_crit.name;
		temp->temp_crit.attr.attr.mode = 0444;
		temp->temp_crit.attr.show = temp_crit_show;
		sysfs_attr_init(&temp->temp_crit.attr.attr);
		result = device_create_file(hwmon->device,
					    &temp->temp_crit.attr);
		if (result)
			goto unregister_input;
	}

	mutex_lock(&thermal_hwmon_list_lock);
	if (new_hwmon_device)
		list_add_tail(&hwmon->node, &thermal_hwmon_list);
	list_add_tail(&temp->hwmon_node, &hwmon->tz_list);
	mutex_unlock(&thermal_hwmon_list_lock);

	return 0;

 unregister_input:
	device_remove_file(hwmon->device, &temp->temp_input.attr);
 free_temp_mem:
	kfree(temp);
 unregister_name:
	if (new_hwmon_device)
		hwmon_device_unregister(hwmon->device);
 free_mem:
	kfree(hwmon);

	return result;
}
EXPORT_SYMBOL_GPL(thermal_add_hwmon_sysfs);

void thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
{
	struct thermal_hwmon_device *hwmon;
	struct thermal_hwmon_temp *temp;

	hwmon = thermal_hwmon_lookup_by_type(tz);
	if (unlikely(!hwmon)) {
		/* Should never happen... */
		dev_dbg(&tz->device, "hwmon device lookup failed!\n");
		return;
	}

	temp = thermal_hwmon_lookup_temp(hwmon, tz);
	if (unlikely(!temp)) {
		/* Should never happen... */
		dev_dbg(&tz->device, "temperature input lookup failed!\n");
		return;
	}

	device_remove_file(hwmon->device, &temp->temp_input.attr);
	if (thermal_zone_crit_temp_valid(tz))
		device_remove_file(hwmon->device, &temp->temp_crit.attr);

	mutex_lock(&thermal_hwmon_list_lock);
	list_del(&temp->hwmon_node);
	kfree(temp);
	if (!list_empty(&hwmon->tz_list)) {
		mutex_unlock(&thermal_hwmon_list_lock);
		return;
	}
	list_del(&hwmon->node);
	mutex_unlock(&thermal_hwmon_list_lock);

	hwmon_device_unregister(hwmon->device);
	kfree(hwmon);
}
EXPORT_SYMBOL_GPL(thermal_remove_hwmon_sysfs);

static void devm_thermal_hwmon_release(struct device *dev, void *res)
{
	thermal_remove_hwmon_sysfs(*(struct thermal_zone_device **)res);
}

int devm_thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
{
	struct thermal_zone_device **ptr;
	int ret;

	ptr = devres_alloc(devm_thermal_hwmon_release, sizeof(*ptr),
			   GFP_KERNEL);
	if (!ptr)
		return -ENOMEM;

	ret = thermal_add_hwmon_sysfs(tz);
	if (ret) {
		devres_free(ptr);
		return ret;
	}

	*ptr = tz;
	devres_add(&tz->device, ptr);

	return ret;
}
EXPORT_SYMBOL_GPL(devm_thermal_add_hwmon_sysfs);
Commit	Line	Data
7e3c0381	1	// SPDX-License-Identifier: GPL-2.0
0dd88793 EV	2	/*
	3	* thermal_hwmon.c - Generic Thermal Management hwmon support.
	4	*
	5	* Code based on Intel thermal_core.c. Copyrights of the original code:
	6	* Copyright (C) 2008 Intel Corp
	7	* Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
	8	* Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
	9	*
	10	* Copyright (C) 2013 Texas Instruments
	11	* Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
0dd88793	12	*/
1330e04f	13	#include <linux/err.h>
e5ebf357	14	#include <linux/export.h>
0dd88793	15	#include <linux/hwmon.h>
0dd88793	16	#include <linux/slab.h>
1330e04f AK	17	#include <linux/thermal.h>
1330e04f AK	18
0dd88793 EV	19	#include "thermal_hwmon.h"
	20
	21	/* hwmon sys I/F */
	22	/* thermal zone devices with the same type share one hwmon device */
	23	struct thermal_hwmon_device {
	24	char type[THERMAL_NAME_LENGTH];
	25	struct device *device;
	26	int count;
	27	struct list_head tz_list;
	28	struct list_head node;
	29	};
	30
	31	struct thermal_hwmon_attr {
	32	struct device_attribute attr;
	33	char name[16];
	34	};
	35
	36	/* one temperature input for each thermal zone */
	37	struct thermal_hwmon_temp {
	38	struct list_head hwmon_node;
	39	struct thermal_zone_device *tz;
	40	struct thermal_hwmon_attr temp_input; /* hwmon sys attr */
	41	struct thermal_hwmon_attr temp_crit; /* hwmon sys attr */
	42	};
	43
	44	static LIST_HEAD(thermal_hwmon_list);
	45
	46	static DEFINE_MUTEX(thermal_hwmon_list_lock);
	47
0dd88793 EV	48	static ssize_t
	49	temp_input_show(struct device dev, struct device_attribute attr, char *buf)
	50	{
17e8351a	51	int temperature;
0dd88793 EV	52	int ret;
	53	struct thermal_hwmon_attr *hwmon_attr
	54	= container_of(attr, struct thermal_hwmon_attr, attr);
	55	struct thermal_hwmon_temp *temp
	56	= container_of(hwmon_attr, struct thermal_hwmon_temp,
	57	temp_input);
	58	struct thermal_zone_device *tz = temp->tz;
	59
	60	ret = thermal_zone_get_temp(tz, &temperature);
	61
	62	if (ret)
	63	return ret;
	64
17e8351a	65	return sprintf(buf, "%d\n", temperature);
0dd88793 EV	66	}
	67
	68	static ssize_t
	69	temp_crit_show(struct device dev, struct device_attribute attr, char *buf)
	70	{
	71	struct thermal_hwmon_attr *hwmon_attr
	72	= container_of(attr, struct thermal_hwmon_attr, attr);
	73	struct thermal_hwmon_temp *temp
	74	= container_of(hwmon_attr, struct thermal_hwmon_temp,
	75	temp_crit);
	76	struct thermal_zone_device *tz = temp->tz;
17e8351a	77	int temperature;
0dd88793 EV	78	int ret;
0dd88793 EV	79
f37fabb8	80	ret = tz->ops->get_crit_temp(tz, &temperature);
0dd88793 EV	81	if (ret)
	82	return ret;
	83
17e8351a	84	return sprintf(buf, "%d\n", temperature);
0dd88793 EV	85	}
	86
	87
	88	static struct thermal_hwmon_device *
	89	thermal_hwmon_lookup_by_type(const struct thermal_zone_device *tz)
	90	{
	91	struct thermal_hwmon_device *hwmon;
8c7aa184	92	char type[THERMAL_NAME_LENGTH];
0dd88793 EV	93
0dd88793 EV	94	mutex_lock(&thermal_hwmon_list_lock);
8c7aa184 SM	95	list_for_each_entry(hwmon, &thermal_hwmon_list, node) {
	96	strcpy(type, tz->type);
	97	strreplace(type, '-', '_');
	98	if (!strcmp(hwmon->type, type)) {
0dd88793 EV	99	mutex_unlock(&thermal_hwmon_list_lock);
	100	return hwmon;
	101	}
8c7aa184	102	}
0dd88793 EV	103	mutex_unlock(&thermal_hwmon_list_lock);
	104
	105	return NULL;
	106	}
	107
	108	/* Find the temperature input matching a given thermal zone */
	109	static struct thermal_hwmon_temp *
	110	thermal_hwmon_lookup_temp(const struct thermal_hwmon_device *hwmon,
	111	const struct thermal_zone_device *tz)
	112	{
	113	struct thermal_hwmon_temp *temp;
	114
	115	mutex_lock(&thermal_hwmon_list_lock);
	116	list_for_each_entry(temp, &hwmon->tz_list, hwmon_node)
	117	if (temp->tz == tz) {
	118	mutex_unlock(&thermal_hwmon_list_lock);
	119	return temp;
	120	}
	121	mutex_unlock(&thermal_hwmon_list_lock);
	122
	123	return NULL;
	124	}
	125
e8db5d67 AL	126	static bool thermal_zone_crit_temp_valid(struct thermal_zone_device *tz)
e8db5d67 AL	127	{
17e8351a	128	int temp;
e8db5d67 AL	129	return tz->ops->get_crit_temp && !tz->ops->get_crit_temp(tz, &temp);
	130	}
	131
0dd88793 EV	132	int thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
	133	{
	134	struct thermal_hwmon_device *hwmon;
	135	struct thermal_hwmon_temp *temp;
	136	int new_hwmon_device = 1;
	137	int result;
	138
	139	hwmon = thermal_hwmon_lookup_by_type(tz);
	140	if (hwmon) {
	141	new_hwmon_device = 0;
	142	goto register_sys_interface;
	143	}
	144
	145	hwmon = kzalloc(sizeof(*hwmon), GFP_KERNEL);
	146	if (!hwmon)
	147	return -ENOMEM;
	148
	149	INIT_LIST_HEAD(&hwmon->tz_list);
	150	strlcpy(hwmon->type, tz->type, THERMAL_NAME_LENGTH);
409ef0ba	151	strreplace(hwmon->type, '-', '_');
f6b6b52e	152	hwmon->device = hwmon_device_register_with_info(&tz->device, hwmon->type,
e782bc16	153	hwmon, NULL, NULL);
0dd88793 EV	154	if (IS_ERR(hwmon->device)) {
	155	result = PTR_ERR(hwmon->device);
	156	goto free_mem;
	157	}
0dd88793 EV	158
	159	register_sys_interface:
	160	temp = kzalloc(sizeof(*temp), GFP_KERNEL);
	161	if (!temp) {
	162	result = -ENOMEM;
	163	goto unregister_name;
	164	}
	165
	166	temp->tz = tz;
	167	hwmon->count++;
	168
	169	snprintf(temp->temp_input.name, sizeof(temp->temp_input.name),
	170	"temp%d_input", hwmon->count);
	171	temp->temp_input.attr.attr.name = temp->temp_input.name;
	172	temp->temp_input.attr.attr.mode = 0444;
	173	temp->temp_input.attr.show = temp_input_show;
	174	sysfs_attr_init(&temp->temp_input.attr.attr);
	175	result = device_create_file(hwmon->device, &temp->temp_input.attr);
	176	if (result)
	177	goto free_temp_mem;
	178
e8db5d67 AL	179	if (thermal_zone_crit_temp_valid(tz)) {
	180	snprintf(temp->temp_crit.name,
	181	sizeof(temp->temp_crit.name),
0dd88793	182	"temp%d_crit", hwmon->count);
e8db5d67 AL	183	temp->temp_crit.attr.attr.name = temp->temp_crit.name;
	184	temp->temp_crit.attr.attr.mode = 0444;
	185	temp->temp_crit.attr.show = temp_crit_show;
	186	sysfs_attr_init(&temp->temp_crit.attr.attr);
	187	result = device_create_file(hwmon->device,
	188	&temp->temp_crit.attr);
	189	if (result)
	190	goto unregister_input;
0dd88793 EV	191	}
	192
	193	mutex_lock(&thermal_hwmon_list_lock);
	194	if (new_hwmon_device)
	195	list_add_tail(&hwmon->node, &thermal_hwmon_list);
	196	list_add_tail(&temp->hwmon_node, &hwmon->tz_list);
	197	mutex_unlock(&thermal_hwmon_list_lock);
	198
	199	return 0;
	200
	201	unregister_input:
	202	device_remove_file(hwmon->device, &temp->temp_input.attr);
	203	free_temp_mem:
	204	kfree(temp);
	205	unregister_name:
e782bc16	206	if (new_hwmon_device)
0dd88793	207	hwmon_device_unregister(hwmon->device);
0dd88793	208	free_mem:
030a48b0	209	kfree(hwmon);
0dd88793 EV	210
	211	return result;
	212	}
f4c59243	213	EXPORT_SYMBOL_GPL(thermal_add_hwmon_sysfs);
0dd88793 EV	214
	215	void thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
	216	{
	217	struct thermal_hwmon_device *hwmon;
	218	struct thermal_hwmon_temp *temp;
	219
	220	hwmon = thermal_hwmon_lookup_by_type(tz);
	221	if (unlikely(!hwmon)) {
	222	/* Should never happen... */
	223	dev_dbg(&tz->device, "hwmon device lookup failed!\n");
	224	return;
	225	}
	226
	227	temp = thermal_hwmon_lookup_temp(hwmon, tz);
	228	if (unlikely(!temp)) {
	229	/* Should never happen... */
	230	dev_dbg(&tz->device, "temperature input lookup failed!\n");
	231	return;
	232	}
	233
	234	device_remove_file(hwmon->device, &temp->temp_input.attr);
e8db5d67	235	if (thermal_zone_crit_temp_valid(tz))
0dd88793 EV	236	device_remove_file(hwmon->device, &temp->temp_crit.attr);
	237
	238	mutex_lock(&thermal_hwmon_list_lock);
	239	list_del(&temp->hwmon_node);
	240	kfree(temp);
	241	if (!list_empty(&hwmon->tz_list)) {
	242	mutex_unlock(&thermal_hwmon_list_lock);
	243	return;
	244	}
	245	list_del(&hwmon->node);
	246	mutex_unlock(&thermal_hwmon_list_lock);
	247
0dd88793 EV	248	hwmon_device_unregister(hwmon->device);
	249	kfree(hwmon);
	250	}
f4c59243	251	EXPORT_SYMBOL_GPL(thermal_remove_hwmon_sysfs);
c7fc403e AS	252
	253	static void devm_thermal_hwmon_release(struct device dev, void res)
	254	{
	255	thermal_remove_hwmon_sysfs((struct thermal_zone_device *)res);
	256	}
	257
	258	int devm_thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
	259	{
	260	struct thermal_zone_device **ptr;
	261	int ret;
	262
	263	ptr = devres_alloc(devm_thermal_hwmon_release, sizeof(*ptr),
	264	GFP_KERNEL);
	265	if (!ptr)
	266	return -ENOMEM;
	267
	268	ret = thermal_add_hwmon_sysfs(tz);
	269	if (ret) {
	270	devres_free(ptr);
	271	return ret;
	272	}
	273
	274	*ptr = tz;
	275	devres_add(&tz->device, ptr);
	276
	277	return ret;
	278	}
	279	EXPORT_SYMBOL_GPL(devm_thermal_add_hwmon_sysfs);