a155-U-u1/kernel-5.10/drivers/soc/mediatek/mtk-mmdvfs.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (C) 2019 MediaTek Inc.
 */
#include <linux/clk.h>
#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/module.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/pm_opp.h>
#include <linux/regulator/consumer.h>
#include "../../misc/mediatek/smi/mtk-smi-dbg.h"

#define MMDVFS_DBG
#define MAX_OPP_NUM (6)
#define MAX_MUX_NUM (10)
#define MAX_HOPPING_CLK_NUM (2)

#if IS_ENABLED(CONFIG_MMPROFILE)
#include "../../misc/mediatek/mmp/mmprofile.h"

struct mmdvfs_mmp_events_t {
	mmp_event mmdvfs;
	mmp_event freq_change;
};
static struct mmdvfs_mmp_events_t mmdvfs_mmp_events;
#endif

enum {
	ACTION_DEFAULT,
	ACTION_IHDM, /* Voltage Increase: Hopping First, Decrease: MUX First*/
};

struct mmdvfs_mux_data {
	const char *mux_name;
	struct clk *mux;
	struct clk *clk_src[MAX_OPP_NUM];
};

struct mmdvfs_hopping_data {
	const char *hopping_name;
	struct clk *hopping_clk;
	u32 hopping_rate[MAX_OPP_NUM];
};

struct mmdvfs_drv_data {
	bool need_change_voltage;
	u32 request_voltage;
	u32 num_muxes;
	struct mmdvfs_mux_data muxes[MAX_MUX_NUM];
	u32 num_hoppings;
	struct mmdvfs_hopping_data hoppings[MAX_HOPPING_CLK_NUM];
	u32 action;
	struct notifier_block nb;
	u32 voltages[MAX_OPP_NUM];
	u32 num_voltages;
};

static struct regulator *vcore_reg_id;

#define MMDVFS_RECORD_NUM (10)
struct mmdvfs_opp_record {
	struct notifier_block nb;
	u8 idx;
	ktime_t time[MMDVFS_RECORD_NUM];
	u8 opp_level[MMDVFS_RECORD_NUM];
};

static struct mmdvfs_opp_record *mmdvfs_dbg;

static u32 log_level;
enum mmdvfs_log_level {
	log_freq = 0,
};

static BLOCKING_NOTIFIER_HEAD(mmdvfs_notifier_list);

/**
 * register_mmdvfs_notifier - register multimedia clk changing notifier
 * @nb: notifier block
 *
 * Register notifier block to receive clk changing  notification.
 */
int register_mmdvfs_notifier(struct notifier_block *nb)
{
	return blocking_notifier_chain_register(&mmdvfs_notifier_list, nb);
}
EXPORT_SYMBOL_GPL(register_mmdvfs_notifier);

/**
 * unregister_mmdvfs_notifier - unregister multimedia clk changing notifier
 * @nb: notifier block
 *
 * Unregister clk changing notifier block.
 */
int unregister_mmdvfs_notifier(struct notifier_block *nb)
{
	return blocking_notifier_chain_unregister(&mmdvfs_notifier_list, nb);
}
EXPORT_SYMBOL_GPL(unregister_mmdvfs_notifier);

static void set_all_muxes(struct mmdvfs_drv_data *drv_data, u32 opp_level)
{
	u32 num_muxes = drv_data->num_muxes;
	u32 i;
	struct clk *mux, *clk_src;
	s32 err;

	for (i = 0; i < num_muxes; i++) {
		mux = drv_data->muxes[i].mux;
		clk_src = drv_data->muxes[i].clk_src[opp_level];
		err = clk_prepare_enable(mux);
		if (err) {
			pr_notice("prepare mux(%s) fail:%d opp_level:%d\n",
				  drv_data->muxes[i].mux_name, err, opp_level);
			continue;
		}
		err = clk_set_parent(mux, clk_src);
		if (err)
			pr_notice("set parent(%s) fail:%d opp_level:%d\n",
				  drv_data->muxes[i].mux_name, err, opp_level);
		clk_disable_unprepare(mux);
	}
}

static void set_all_hoppings(struct mmdvfs_drv_data *drv_data, u32 opp_level)
{
	u32 num_hoppings = drv_data->num_hoppings;
	u32 i, hopping_rate;
	struct clk *hopping;
	s32 err;

	for (i = 0; i < num_hoppings; i++) {
		hopping = drv_data->hoppings[i].hopping_clk;
		hopping_rate = drv_data->hoppings[i].hopping_rate[opp_level];
		err = clk_prepare_enable(hopping);
		if (err) {
			pr_notice("prepare hopping(%s) fail:%d opp_level:%d\n",
				  drv_data->hoppings[i].hopping_name,
				  err, opp_level);
			continue;
		}
		err = clk_set_rate(hopping, hopping_rate);
		if (err)
			pr_notice("set %s rate(%u) fail:%d opp_level:%d\n",
				  drv_data->hoppings[i].hopping_name,
				  hopping_rate, err, opp_level);
		clk_disable_unprepare(hopping);
	}
}

static int mmdvfs_dbg_log_cb(struct notifier_block *nb,
		unsigned long value, void *v)
{
	int i;

	pr_notice("[smi] mmdvfs dump opp level start\n");
	for (i = mmdvfs_dbg->idx; i < MMDVFS_RECORD_NUM; i++) {
		pr_notice("[smi] (time, opp_level) = (%18llu, %d))\n",
				mmdvfs_dbg->time[i], mmdvfs_dbg->opp_level[i]);
	}
	for (i = 0; i < mmdvfs_dbg->idx; i++) {
		pr_notice("[smi] (time, opp_level) = (%18llu, %d))\n",
				mmdvfs_dbg->time[i], mmdvfs_dbg->opp_level[i]);
	}
	pr_notice("[smi] mmdvfs opp level end\n");

	return 0;
}

static void set_all_clk(struct mmdvfs_drv_data *drv_data,
			u32 voltage, bool vol_inc)
{
	s32 i;
	u32 opp_level;

	for (i = drv_data->num_voltages - 1; i >= 0; i--) {
		if (voltage >= drv_data->voltages[i]) {
			opp_level = i;
			break;
		}
	}
	if (i < 0)
		opp_level = 0;

	switch (drv_data->action) {
	/* Voltage Increase: Hopping First, Decrease: MUX First*/
	case ACTION_IHDM:
		if (vol_inc) {
			set_all_hoppings(drv_data, opp_level);
			set_all_muxes(drv_data, opp_level);
		} else {
			set_all_muxes(drv_data, opp_level);
			set_all_hoppings(drv_data, opp_level);
		}
		break;
	default:
		set_all_muxes(drv_data, opp_level);
		break;
	}
	blocking_notifier_call_chain(&mmdvfs_notifier_list, opp_level, NULL);
	if (log_level & 1 << log_freq)
		pr_notice("set clk to opp level:%d\n", opp_level);

	/* Record mmdvfs opp log*/
	mmdvfs_dbg->time[mmdvfs_dbg->idx] = ktime_get();
	mmdvfs_dbg->opp_level[mmdvfs_dbg->idx] = opp_level;
	mmdvfs_dbg->idx = (mmdvfs_dbg->idx + 1) % MMDVFS_RECORD_NUM;

#if IS_ENABLED(CONFIG_MMPROFILE)
	mmprofile_log_ex(
		mmdvfs_mmp_events.freq_change,
		MMPROFILE_FLAG_PULSE, vol_inc, opp_level);
#endif
}

static int regulator_event_notify(struct notifier_block *nb,
				  unsigned long event, void *data)
{
	unsigned long uV;
	struct mmdvfs_drv_data *drv_data;
	struct pre_voltage_change_data *pvc_data;

	drv_data = container_of(nb, struct mmdvfs_drv_data, nb);

	if (event == REGULATOR_EVENT_PRE_VOLTAGE_CHANGE) {
		pvc_data = data;
		uV = pvc_data->min_uV;
		if (uV < pvc_data->old_uV) {
			set_all_clk(drv_data, uV, false);
			drv_data->request_voltage = uV;
		} else if (uV > pvc_data->old_uV || unlikely(drv_data->request_voltage == 0)) {
			drv_data->need_change_voltage = true;
		}
		if (log_level & 1 << log_freq)
			pr_notice("regulator event=PRE_VOLTAGE_CHANGE old=%lu new=%lu\n",
				pvc_data->old_uV, pvc_data->min_uV);
	} else if (event == REGULATOR_EVENT_VOLTAGE_CHANGE) {
		uV = (unsigned long)data;
		if (drv_data->need_change_voltage) {
			set_all_clk(drv_data, uV, true);
			drv_data->need_change_voltage = false;
			drv_data->request_voltage = uV;
		}
		if (log_level & 1 << log_freq)
			pr_notice("regulator event=VOLTAGE_CHANGE voltage=%lu\n", uV);
	} else if (event == REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE) {
		uV = (unsigned long)data;
		/* If clk was changed, restore to previous setting */
		if (uV != drv_data->request_voltage) {
			set_all_clk(drv_data, uV,
				    uV > drv_data->request_voltage);
			drv_data->need_change_voltage = false;
			drv_data->request_voltage = uV;
		}
		pr_info("regulator event=ABORT_VOLTAGE_CHANGE voltage=%lu\n",
			uV);
	}
	return 0;
}

static const struct of_device_id of_mmdvfs_match_tbl[] = {
	{
		.compatible = "mediatek,mmdvfs",
	},
	{}
};

#ifdef MMDVFS_DBG
struct mmdvfs_dbg_data {
	struct mmdvfs_drv_data *drv_data;
	struct regulator *reg;
	s32 force_step;
	s32 vote_step;
	bool is_notifier_registered;
};

struct mmdvfs_dbg_data *dbg_data;

int mmdvfs_dbg_clk_set(int step, bool is_force)
{
	struct mmdvfs_drv_data *drv_data;
	s32 ret = 0;
	u32 v_real = 0;
	int volt = 0;
	s32 last_force_step;

	if (!dbg_data) {
		pr_notice("%s: dbg_data is not ready!\n", __func__);
		return -EINVAL;
	}
	drv_data = dbg_data->drv_data;

	if (!drv_data) {
		pr_notice("%s: drv_data is not ready!\n", __func__);
		return -EINVAL;
	}

	if (step >= (int)drv_data->num_voltages) {
		pr_notice("%s: invalid force_step(%d)\n", __func__, step);
		return -EINVAL;
	}

	if (is_force) {
		last_force_step = dbg_data->force_step;
		dbg_data->force_step = step;
	} else {
		dbg_data->vote_step = step;
	}

	if (step < 0) {
		if (is_force && !dbg_data->is_notifier_registered) {
			ret = devm_regulator_register_notifier(
					dbg_data->reg, &drv_data->nb);
			dbg_data->is_notifier_registered = true;
			if (ret)
				pr_notice("%s: failed to register notifier(%d)\n",
					__func__, ret);
		}

		regulator_set_voltage(dbg_data->reg, 0, INT_MAX);
	} else {
		volt = drv_data->voltages[drv_data->num_voltages-1-step];
		if (is_force) {
			if (dbg_data->is_notifier_registered) {
				devm_regulator_unregister_notifier(
						dbg_data->reg, &drv_data->nb);
				dbg_data->is_notifier_registered = false;
			}
			if ((last_force_step < 0 && volt > drv_data->request_voltage)
				|| (last_force_step >= 0 && step < last_force_step)) {
				regulator_set_voltage(
					dbg_data->reg, volt, INT_MAX);
				if (!IS_ERR(vcore_reg_id)) {
					v_real = regulator_get_voltage(vcore_reg_id);
					pr_notice("%s: step=%d volt=%d r_volt=%d is_force=%d\n",
							__func__, step, volt, v_real, is_force);
				}
				set_all_clk(drv_data, volt, true);
			} else {
				set_all_clk(drv_data, volt, false);
				regulator_set_voltage(
					dbg_data->reg, volt, INT_MAX);
				if (!IS_ERR(vcore_reg_id)) {
					v_real = regulator_get_voltage(vcore_reg_id);
					pr_notice("%s: step=%d volt=%d r_volt=%d is_force=%d\n",
							__func__, step, volt, v_real, is_force);
				}
			}
		} else {
			regulator_set_voltage(dbg_data->reg, volt, INT_MAX);
		}
	}
	pr_notice("%s: step=%d volt=%d is_force=%d\n", __func__, step, volt, is_force);
	return ret;
}

int set_force_step(const char *val, const struct kernel_param *kp)
{
	int result;
	int new_force_step;

	result = kstrtoint(val, 0, &new_force_step);
	if (result) {
		pr_notice("mmdvfs set force step failed: %d\n", result);
		return result;
	}
	return mmdvfs_dbg_clk_set(new_force_step, true);
}

static struct kernel_param_ops set_force_step_ops = {
	.set = set_force_step,
};
module_param_cb(force_step, &set_force_step_ops, NULL, 0644);
MODULE_PARM_DESC(force_step, "force mmdvfs to specified step");

int set_vote_step(const char *val, const struct kernel_param *kp)
{
	int result;
	int vote_step;

	result = kstrtoint(val, 0, &vote_step);
	if (result) {
		pr_notice("mmdvfs set vote step failed: %d\n", result);
		return result;
	}

	return mmdvfs_dbg_clk_set(vote_step, false);
}

static struct kernel_param_ops set_vote_step_ops = {
	.set = set_vote_step,
};
module_param_cb(vote_step, &set_vote_step_ops, NULL, 0644);
MODULE_PARM_DESC(vote_step, "vote mmdvfs to specified step");

module_param(log_level, uint, 0644);
MODULE_PARM_DESC(log_level, "mmdvfs log level");
#endif /* MMDVFS_DBG */

#define MAX_DUMP (PAGE_SIZE - 1)
struct mmdvfs_drv_data *drv_data;
int dump_setting(char *buf, const struct kernel_param *kp)
{
	u32 i, j;
	int length = 0;

	length += snprintf(buf + length, MAX_DUMP  - length,
		"mux number:%d\n", drv_data->num_muxes);
	length += snprintf(buf + length, MAX_DUMP  - length,
		"mux:");
	for (i = 0; i < drv_data->num_muxes; i++) {
		length += snprintf(buf + length, MAX_DUMP  - length,
		"%s ", drv_data->muxes[i].mux_name);
	}
	length += snprintf(buf + length, MAX_DUMP  - length,
		"\n");
	length += snprintf(buf + length, MAX_DUMP  - length,
		"hopping number:%d\n", drv_data->num_hoppings);
	for (i = 0; i < drv_data->num_hoppings; i++) {
		length += snprintf(buf + length, MAX_DUMP  - length,
		"%s: ", drv_data->hoppings[i].hopping_name);
		for (j = 0; j < MAX_OPP_NUM; j++) {
			if (!drv_data->hoppings[i].hopping_rate[j])
				break;
			length += snprintf(buf + length, MAX_DUMP  - length,
				"%d ", drv_data->hoppings[i].hopping_rate[j]);
		}
		length += snprintf(buf + length, MAX_DUMP  - length,
		"\n");
	}
	length += snprintf(buf + length, MAX_DUMP  - length,
		"action: %d\n", drv_data->action);
	length += snprintf(buf + length, MAX_DUMP  - length,
		"voltage level:");
	for (i = 0; i < MAX_OPP_NUM; i++) {
		if (!drv_data->voltages[i])
			break;
		length += snprintf(buf + length, MAX_DUMP  - length,
		"%d ", drv_data->voltages[i]);
	}
	length += snprintf(buf + length, MAX_DUMP  - length,
		"\n");
	length += snprintf(buf + length, MAX_DUMP  - length,
		"request voltage:%d\n", drv_data->request_voltage);
#ifdef MMDVFS_DBG
	length += snprintf(buf + length, MAX_DUMP  - length,
		"force_step:%d\n", dbg_data->force_step);
	length += snprintf(buf + length, MAX_DUMP  - length,
		"vote_step:%d\n", dbg_data->vote_step);
#endif
	if (length >= MAX_DUMP)
		length = MAX_DUMP - 1;

	return length;
}

static struct kernel_param_ops dump_param_ops = {.get = dump_setting};
module_param_cb(dump_setting, &dump_param_ops, NULL, 0444);
MODULE_PARM_DESC(dump_setting, "dump mmdvfs current setting");

static int mmdvfs_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct regulator *reg;
	u32 num_mux = 0, num_hopping = 0;
	u32 num_clksrc, hopping_rate, num_hopping_rate;
	struct property *mux_prop, *clksrc_prop;
	struct property *hopping_prop, *hopping_rate_prop;
	const char *mux_name, *clksrc_name, *hopping_name;
	char prop_name[32];
	const __be32 *p;
	s32 ret;
	unsigned long freq;
	struct dev_pm_opp *opp;

#if IS_ENABLED(CONFIG_MMPROFILE)
	mmprofile_enable(1);
	if (mmdvfs_mmp_events.mmdvfs == 0) {
		mmdvfs_mmp_events.mmdvfs =
			mmprofile_register_event(MMP_ROOT_EVENT, "MMDVFS");
		mmdvfs_mmp_events.freq_change =	mmprofile_register_event(
			mmdvfs_mmp_events.mmdvfs, "freq_change");
		mmprofile_enable_event_recursive(mmdvfs_mmp_events.mmdvfs, 1);
	}
	mmprofile_start(1);
#endif

	drv_data = devm_kzalloc(dev, sizeof(*drv_data), GFP_KERNEL);
	if (!drv_data)
		return -ENOMEM;
	of_property_for_each_string(dev->of_node, "mediatek,support_mux",
				    mux_prop, mux_name) {
		if (num_mux >= MAX_MUX_NUM) {
			pr_notice("Too many items in support_mux\n");
			return -EINVAL;
		}
		drv_data->muxes[num_mux].mux = devm_clk_get(dev, mux_name);
		drv_data->muxes[num_mux].mux_name = mux_name;
		snprintf(prop_name, sizeof(prop_name) - 1,
			 "mediatek,mux_%s", mux_name);
		num_clksrc = 0;
		of_property_for_each_string(dev->of_node, prop_name,
					    clksrc_prop, clksrc_name) {
			if (num_clksrc >= MAX_OPP_NUM) {
				pr_notice("Too many items in %s\n", prop_name);
				return -EINVAL;
			}
			drv_data->muxes[num_mux].clk_src[num_clksrc] =
				devm_clk_get(dev, clksrc_name);
			num_clksrc++;
		}
		num_mux++;
	}

	drv_data->num_muxes = num_mux;
	of_property_for_each_string(dev->of_node, "mediatek,support_hopping",
				    hopping_prop, hopping_name) {
		if (num_hopping >= MAX_HOPPING_CLK_NUM) {
			pr_notice("Too many items in support_hopping\n");
			return -EINVAL;
		}
		drv_data->hoppings[num_hopping].hopping_clk =
					devm_clk_get(dev, hopping_name);
		drv_data->hoppings[num_hopping].hopping_name = hopping_name;
		snprintf(prop_name, sizeof(prop_name) - 1,
			 "mediatek,hopping_%s", hopping_name);
		num_hopping_rate = 0;
		of_property_for_each_u32(dev->of_node, prop_name,
					 hopping_rate_prop, p, hopping_rate) {
			if (num_hopping_rate >= MAX_OPP_NUM) {
				pr_notice("Too many items in %s\n", prop_name);
				return -EINVAL;
			}
			drv_data->hoppings[num_hopping].hopping_rate
					[num_hopping_rate] = hopping_rate;
			num_hopping_rate++;
		}
		num_hopping++;
	}
	drv_data->num_hoppings = num_hopping;
	of_property_read_u32(dev->of_node,
			     "mediatek,action", &drv_data->action);
	/* Get voltage info from opp table */
	dev_pm_opp_of_add_table(dev);
	freq = 0;
	while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {
		drv_data->voltages[drv_data->num_voltages] =
			dev_pm_opp_get_voltage(opp);
		freq++;
		drv_data->num_voltages++;
		dev_pm_opp_put(opp);
	}
	reg = devm_regulator_get(dev, "dvfsrc-vcore");
	if (IS_ERR(reg))
		return PTR_ERR(reg);
#ifdef MMDVFS_DBG
	dbg_data = devm_kzalloc(dev, sizeof(*dbg_data), GFP_KERNEL);
	if (!dbg_data)
		return -ENOMEM;
	dbg_data->drv_data = drv_data;
	dbg_data->reg = reg;
	dbg_data->force_step = -1;
	dbg_data->vote_step = -1;
	dbg_data->is_notifier_registered = true;
#endif
	drv_data->nb.notifier_call = regulator_event_notify;
	ret = devm_regulator_register_notifier(reg, &drv_data->nb);
	if (ret)
		pr_notice("Failed to register notifier: %d\n", ret);

	vcore_reg_id = regulator_get(dev, "_vcore");
	if (IS_ERR(vcore_reg_id)) {
		pr_info("regulator_get vcore_reg_id failed: %ld\n",
				PTR_ERR(vcore_reg_id));
	}

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

	mmdvfs_dbg->nb.notifier_call = mmdvfs_dbg_log_cb;
	mtk_smi_dbg_register_notifier(&mmdvfs_dbg->nb);

	return ret;
}

static struct platform_driver mmdvfs_drv = {
	.probe = mmdvfs_probe,
	.driver = {
		.name = "mtk-mmdvfs",
		.of_match_table = of_mmdvfs_match_tbl,
	},
};

static int __init mtk_mmdvfs_init(void)
{
	s32 status;

	status = platform_driver_register(&mmdvfs_drv);
	if (status) {
		pr_notice("Failed to register MMDVFS driver(%d)\n", status);
		return -ENODEV;
	}
	return 0;
}

static void __exit mtk_mmdvfs_exit(void)
{
	platform_driver_unregister(&mmdvfs_drv);
}

module_init(mtk_mmdvfs_init);
module_exit(mtk_mmdvfs_exit);
MODULE_DESCRIPTION("MTK MMDVFS driver");
MODULE_AUTHOR("Anthony Huang<anthony.huang@mediatek.com>");
MODULE_LICENSE("GPL");