Jetpack/kernel/nvidia/drivers/thermal/tegra_bpmp_thermal.c

/*
 * Copyright (c) 2015-2019, NVIDIA CORPORATION.  All rights reserved.
 *
 * Author:
 *	Mikko Perttunen <mperttunen@nvidia.com>
 *	Aapo Vienamo	<avienamo@nvidia.com>
 *
 * 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/atomic.h>
#include <linux/bitops.h>
#include <linux/clk.h>
#include <linux/debugfs.h>
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/reset.h>
#include <linux/thermal.h>
#include <linux/version.h>
#include <linux/workqueue.h>

#include <soc/tegra/tegra_bpmp.h>
#include <soc/tegra/bpmp_abi.h>

#define CREATE_TRACE_POINTS
#include <trace/events/bpmp_thermal.h>

struct tegra_bpmp_thermal_zone {
	struct tegra_bpmp_thermal *tegra;
	struct thermal_zone_device *tzd;
	unsigned int idx;
	atomic_t needs_update;
};

struct tegra_bpmp_thermal {
	struct device *dev;
	unsigned int zone_count;
	struct tegra_bpmp_thermal_zone *zones;
	struct work_struct tz_device_update_work;
	unsigned int profile_id;
};

static int tegra_bpmp_thermal_get_temp(void *data, int *out_temp)
{
	struct tegra_bpmp_thermal_zone *zone = data;
	struct mrq_thermal_host_to_bpmp_request req;
	union mrq_thermal_bpmp_to_host_response reply;
	int ret;

	req.type = CMD_THERMAL_GET_TEMP;
	req.get_temp.zone = zone->idx;

	ret = tegra_bpmp_send_receive(MRQ_THERMAL, &req, sizeof(req),
				      &reply, sizeof(reply));
	if (ret)
		return ret;

	*out_temp = reply.get_temp.temp;

	return 0;
}

static int tegra_bpmp_thermal_get_trend(void *data, int trip,
		enum thermal_trend *trend)
{
	struct tegra_bpmp_thermal_zone *zone = data;
	int ret;
	int trip_temp, temp, last_temp;

	if (!zone->tzd)
		return -ENODEV;

	ret = zone->tzd->ops->get_trip_temp(zone->tzd, trip, &trip_temp);
	if (ret)
		return ret;

	mutex_lock(&zone->tzd->lock);
	temp = zone->tzd->temperature;
	last_temp = zone->tzd->last_temperature;
	mutex_unlock(&zone->tzd->lock);

	if (temp > trip_temp)
		*trend = (temp >= last_temp) ? THERMAL_TREND_RAISING :
						THERMAL_TREND_STABLE;
	else if (temp < trip_temp)
		*trend = THERMAL_TREND_DROPPING;
	else
		/* start polling if temp > last_temp */
		*trend = (temp > last_temp) ? THERMAL_TREND_RAISING :
						THERMAL_TREND_STABLE;

	return 0;
}

static int tegra_bpmp_set_trips(void *data, int low, int high)
{
	struct tegra_bpmp_thermal_zone *zone = data;
	struct mrq_thermal_host_to_bpmp_request req;
	int ret;

	req.type = CMD_THERMAL_SET_TRIP;
	req.set_trip.zone = zone->idx;
	req.set_trip.enabled = true;
	req.set_trip.low = low;
	req.set_trip.high = high;

	ret = tegra_bpmp_send_receive(MRQ_THERMAL, &req, sizeof(req), NULL, 0);
	return ret;
}

static void tz_device_update_work_fn(struct work_struct *work)
{
	struct tegra_bpmp_thermal *tegra;
	struct tegra_bpmp_thermal_zone *zone;
	int i;

	tegra = container_of(work, struct tegra_bpmp_thermal,
			     tz_device_update_work);

	for (i = 0; i < tegra->zone_count; ++i) {
		zone = &tegra->zones[i];
		if (!zone->tzd)
			continue;
		dev_dbg(tegra->dev, "tzs_to_update[%d]: %d\n", i,
			atomic_read(&zone->needs_update));
		if (atomic_cmpxchg(&zone->needs_update, true, false)) {
#if LINUX_VERSION_CODE < KERNEL_VERSION(4, 9, 0)
			thermal_zone_device_update(zone->tzd);
#else
			thermal_zone_device_update(zone->tzd,
						   THERMAL_EVENT_UNSPECIFIED);
#endif
			trace_bpmp_thermal_zone_trip(zone->tzd,
						     zone->tzd->temperature);
		}
	}
}

static void bpmp_mrq_thermal(int code, void *data, int ch)
{
	struct mrq_thermal_bpmp_to_host_request req;
	struct tegra_bpmp_thermal *tegra = data;
	int zone_idx;

	tegra_bpmp_read_data(ch, &req, sizeof(req));
	zone_idx = req.host_trip_reached.zone;

	if (req.type != CMD_THERMAL_HOST_TRIP_REACHED) {
		dev_err(tegra->dev, "invalid req type: %d\n", req.type);
		tegra_bpmp_mail_return(ch, -EINVAL, 0);
		return;
	}

	if (zone_idx >= tegra->zone_count) {
		dev_err(tegra->dev, "invalid thermal zone: %d\n", zone_idx);
		tegra_bpmp_mail_return(ch, -EINVAL, 0);
		return;
	}

	atomic_set(&tegra->zones[zone_idx].needs_update, true);
	tegra_bpmp_mail_return(ch, 0, 0);

	dev_dbg(tegra->dev, "host trip point reached at zone: %d\n", zone_idx);

	/*
	 * thermal_zone_device_update can't be called here from interrupt
	 * context because it will cause a call to thermal_zone_get_temp
	 * which results in a call to tegra_bpmp_send_receive.
	 * tegra_bpmp_send_receive must be called from thread context.
	 */
	schedule_work(&tegra->tz_device_update_work);
}

static int tegra_bpmp_thermal_get_num_zones(unsigned int *num)
{
	struct mrq_thermal_host_to_bpmp_request req;
	union mrq_thermal_bpmp_to_host_response reply;
	int ret;

	req.type = CMD_THERMAL_GET_NUM_ZONES;

	ret = tegra_bpmp_send_receive(MRQ_THERMAL, &req, sizeof(req),
				      &reply, sizeof(reply));
	if (ret)
		return ret;

	*num = reply.get_num_zones.num;

	return 0;
}

static int tegra_bpmp_thermal_query_abi(unsigned int type)
{
	struct mrq_thermal_host_to_bpmp_request req;
	union mrq_thermal_bpmp_to_host_response reply;
	int err;

	req.type = CMD_THERMAL_QUERY_ABI;
	req.query_abi.type = type;

	err = tegra_bpmp_send_receive(MRQ_THERMAL, &req, sizeof(req),
				      &reply, sizeof(reply));
	return err;
}

static int tegra_bpmp_thermal_abi_probe(void)
{
	unsigned int i;
	unsigned int err;
	unsigned int required_cmds[] = {
		CMD_THERMAL_GET_TEMP,
		CMD_THERMAL_SET_TRIP,
		CMD_THERMAL_GET_NUM_ZONES
	};

	for (i = 0; i < ARRAY_SIZE(required_cmds); ++i) {
		err = tegra_bpmp_thermal_query_abi(required_cmds[i]);
		if (err)
			return err;
	}

	return 0;
}

#ifdef CONFIG_DEBUG_FS
static void tegra_bpmp_thermal_dbgfs_init(struct platform_device *pdev)
{
	struct dentry *root, *file;
	struct tegra_bpmp_thermal *tegra = platform_get_drvdata(pdev);

	root = debugfs_create_dir("tegra_bpmp_thermal", NULL);
	if (!root)
		goto err;

	file = debugfs_create_u32("therm-profile", S_IRUGO, root,
				  &tegra->profile_id);
	if (!file)
		goto err;

	return;
err:
	dev_err(tegra->dev, "debugfs init failed\n");
}
#else
static void tegra_bpmp_thermal_dbgfs_init(struct platform_device *pdev) {}
#endif

static void tegra_bpmp_thermal_dt_parse(struct platform_device *pdev)
{
	unsigned int v;
	struct tegra_bpmp_thermal *tegra = platform_get_drvdata(pdev);

	if (of_property_read_u32(pdev->dev.of_node, "nvidia,therm-profile", &v))
		return;

	tegra->profile_id = v;
}

static struct thermal_zone_of_device_ops tegra_of_thermal_ops = {
	.get_temp = tegra_bpmp_thermal_get_temp,
	.get_trend = tegra_bpmp_thermal_get_trend,
	.set_trips = tegra_bpmp_set_trips,
};

static const struct of_device_id tegra_bpmp_thermal_of_match[] = {
	{
		.compatible = "nvidia,tegra186-bpmp-thermal",
	},
	{ },
};
MODULE_DEVICE_TABLE(of, tegra_bpmp_thermal_of_match);

static int tegra_bpmp_thermal_probe(struct platform_device *pdev)
{
	struct tegra_bpmp_thermal *tegra;
	struct thermal_zone_device *tzd;
	unsigned int i;
	int err;

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

	tegra->dev = &pdev->dev;

	err = tegra_bpmp_thermal_abi_probe();
	if (err) {
		dev_err(tegra->dev,
			"BPMP ABI probe failed\n");
		return err;
	}

	err = tegra_bpmp_thermal_get_num_zones(&tegra->zone_count);
	if (err) {
		dev_err(tegra->dev,
			"failed to get the number of zones: %d\n", err);
		return err;
	}

	tegra->zones = devm_kzalloc(tegra->dev,
				    tegra->zone_count * sizeof(*tegra->zones),
				    GFP_KERNEL);
	if (!tegra->zones)
		return -ENOMEM;

	INIT_WORK(&tegra->tz_device_update_work, tz_device_update_work_fn);
	err = tegra_bpmp_request_mrq(MRQ_THERMAL, bpmp_mrq_thermal, tegra);
	if (err) {
		dev_err(tegra->dev, "failed to register mrq handler: %d\n",
			err);
		return err;
	}

	/* Initialize thermal zones */
	for (i = 0; i < tegra->zone_count; ++i) {
		int temp;
		tegra->zones[i].idx = i;
		tegra->zones[i].tegra = tegra;
		atomic_set(&tegra->zones[i].needs_update, false);

		err = tegra_bpmp_thermal_get_temp(&tegra->zones[i], &temp);
		if (err < 0)
			continue;

		tzd = thermal_zone_of_sensor_register(tegra->dev, i,
						      &tegra->zones[i],
						      &tegra_of_thermal_ops);

		if (IS_ERR(tzd)) {
			err = PTR_ERR(tzd);
			if (err != -ENODEV)
				dev_notice(tegra->dev,
				"zone %d not supported, err %d\n", i, err);
			tzd = NULL;
		}

		tegra->zones[i].tzd = tzd;
		atomic_set(&tegra->zones[i].needs_update, true);
	}

	platform_set_drvdata(pdev, tegra);

	/* now that all the zones are set up, force a zone-update to set the
	* initial limits correctly
	* one such use case is where BPMP side thermal driver (that comes up
	* before host thermal driver) gets its limits set as THERMAL_MIN_LOW
	* and THERMAL_MAX_HIGH and stays at those limits, generating no
	* IRQs. Because of this there is no trigger to zone-update on host
	* side (CMD_THERMAL_HOST_TRIP_REACHED is never received on host);
	* and no meaningful limits are ever set.
	*/
	schedule_work(&tegra->tz_device_update_work);
	tegra_bpmp_thermal_dt_parse(pdev);
	tegra_bpmp_thermal_dbgfs_init(pdev);

	return 0;

}

static int tegra_bpmp_thermal_remove(struct platform_device *pdev)
{
	struct tegra_bpmp_thermal *tegra = platform_get_drvdata(pdev);
	unsigned int i;

	flush_work(&tegra->tz_device_update_work);

	for (i = 0; i < tegra->zone_count; ++i)
		thermal_zone_of_sensor_unregister(&pdev->dev,
						  tegra->zones[i].tzd);

	tegra_bpmp_cancel_mrq(MRQ_THERMAL);

	return 0;
}

static struct platform_driver tegra_bpmp_thermal_driver = {
	.probe = tegra_bpmp_thermal_probe,
	.remove = tegra_bpmp_thermal_remove,
	.driver = {
		.name = "tegra-bpmp-thermal",
		.of_match_table = tegra_bpmp_thermal_of_match,
	},
};
module_platform_driver(tegra_bpmp_thermal_driver);

MODULE_AUTHOR("Aapo Vienamo <avienamo@nvidia.com>");
MODULE_DESCRIPTION("NVIDIA Tegra BPMP thermal management driver");
MODULE_LICENSE("GPL v2");