10ac2a08fSDmitry Baryshkov /* SPDX-License-Identifier: GPL-2.0 */
20ac2a08fSDmitry Baryshkov /*
30ac2a08fSDmitry Baryshkov * Copyright (c) 2023, Linaro Ltd.
40ac2a08fSDmitry Baryshkov */
50ac2a08fSDmitry Baryshkov
60ac2a08fSDmitry Baryshkov #include <linux/clk.h>
70ac2a08fSDmitry Baryshkov #include <linux/device.h>
80ac2a08fSDmitry Baryshkov #include <linux/interconnect-clk.h>
90ac2a08fSDmitry Baryshkov #include <linux/interconnect-provider.h>
100ac2a08fSDmitry Baryshkov
110ac2a08fSDmitry Baryshkov struct icc_clk_node {
120ac2a08fSDmitry Baryshkov struct clk *clk;
130ac2a08fSDmitry Baryshkov bool enabled;
140ac2a08fSDmitry Baryshkov };
150ac2a08fSDmitry Baryshkov
160ac2a08fSDmitry Baryshkov struct icc_clk_provider {
170ac2a08fSDmitry Baryshkov struct icc_provider provider;
180ac2a08fSDmitry Baryshkov int num_clocks;
19*b1e0cdb0SKees Cook struct icc_clk_node clocks[] __counted_by(num_clocks);
200ac2a08fSDmitry Baryshkov };
210ac2a08fSDmitry Baryshkov
220ac2a08fSDmitry Baryshkov #define to_icc_clk_provider(_provider) \
230ac2a08fSDmitry Baryshkov container_of(_provider, struct icc_clk_provider, provider)
240ac2a08fSDmitry Baryshkov
icc_clk_set(struct icc_node * src,struct icc_node * dst)250ac2a08fSDmitry Baryshkov static int icc_clk_set(struct icc_node *src, struct icc_node *dst)
260ac2a08fSDmitry Baryshkov {
270ac2a08fSDmitry Baryshkov struct icc_clk_node *qn = src->data;
280ac2a08fSDmitry Baryshkov int ret;
290ac2a08fSDmitry Baryshkov
300ac2a08fSDmitry Baryshkov if (!qn || !qn->clk)
310ac2a08fSDmitry Baryshkov return 0;
320ac2a08fSDmitry Baryshkov
330ac2a08fSDmitry Baryshkov if (!src->peak_bw) {
340ac2a08fSDmitry Baryshkov if (qn->enabled)
350ac2a08fSDmitry Baryshkov clk_disable_unprepare(qn->clk);
360ac2a08fSDmitry Baryshkov qn->enabled = false;
370ac2a08fSDmitry Baryshkov
380ac2a08fSDmitry Baryshkov return 0;
390ac2a08fSDmitry Baryshkov }
400ac2a08fSDmitry Baryshkov
410ac2a08fSDmitry Baryshkov if (!qn->enabled) {
420ac2a08fSDmitry Baryshkov ret = clk_prepare_enable(qn->clk);
430ac2a08fSDmitry Baryshkov if (ret)
440ac2a08fSDmitry Baryshkov return ret;
450ac2a08fSDmitry Baryshkov qn->enabled = true;
460ac2a08fSDmitry Baryshkov }
470ac2a08fSDmitry Baryshkov
480ac2a08fSDmitry Baryshkov return clk_set_rate(qn->clk, icc_units_to_bps(src->peak_bw));
490ac2a08fSDmitry Baryshkov }
500ac2a08fSDmitry Baryshkov
icc_clk_get_bw(struct icc_node * node,u32 * avg,u32 * peak)510ac2a08fSDmitry Baryshkov static int icc_clk_get_bw(struct icc_node *node, u32 *avg, u32 *peak)
520ac2a08fSDmitry Baryshkov {
530ac2a08fSDmitry Baryshkov struct icc_clk_node *qn = node->data;
540ac2a08fSDmitry Baryshkov
550ac2a08fSDmitry Baryshkov if (!qn || !qn->clk)
560ac2a08fSDmitry Baryshkov *peak = INT_MAX;
570ac2a08fSDmitry Baryshkov else
580ac2a08fSDmitry Baryshkov *peak = Bps_to_icc(clk_get_rate(qn->clk));
590ac2a08fSDmitry Baryshkov
600ac2a08fSDmitry Baryshkov return 0;
610ac2a08fSDmitry Baryshkov }
620ac2a08fSDmitry Baryshkov
630ac2a08fSDmitry Baryshkov /**
640ac2a08fSDmitry Baryshkov * icc_clk_register() - register a new clk-based interconnect provider
650ac2a08fSDmitry Baryshkov * @dev: device supporting this provider
660ac2a08fSDmitry Baryshkov * @first_id: an ID of the first provider's node
670ac2a08fSDmitry Baryshkov * @num_clocks: number of instances of struct icc_clk_data
680ac2a08fSDmitry Baryshkov * @data: data for the provider
690ac2a08fSDmitry Baryshkov *
700ac2a08fSDmitry Baryshkov * Registers and returns a clk-based interconnect provider. It is a simple
710ac2a08fSDmitry Baryshkov * wrapper around COMMON_CLK framework, allowing other devices to vote on the
720ac2a08fSDmitry Baryshkov * clock rate.
730ac2a08fSDmitry Baryshkov *
740ac2a08fSDmitry Baryshkov * Return: 0 on success, or an error code otherwise
750ac2a08fSDmitry Baryshkov */
icc_clk_register(struct device * dev,unsigned int first_id,unsigned int num_clocks,const struct icc_clk_data * data)760ac2a08fSDmitry Baryshkov struct icc_provider *icc_clk_register(struct device *dev,
770ac2a08fSDmitry Baryshkov unsigned int first_id,
780ac2a08fSDmitry Baryshkov unsigned int num_clocks,
790ac2a08fSDmitry Baryshkov const struct icc_clk_data *data)
800ac2a08fSDmitry Baryshkov {
810ac2a08fSDmitry Baryshkov struct icc_clk_provider *qp;
820ac2a08fSDmitry Baryshkov struct icc_provider *provider;
830ac2a08fSDmitry Baryshkov struct icc_onecell_data *onecell;
840ac2a08fSDmitry Baryshkov struct icc_node *node;
850ac2a08fSDmitry Baryshkov int ret, i, j;
860ac2a08fSDmitry Baryshkov
870ac2a08fSDmitry Baryshkov onecell = devm_kzalloc(dev, struct_size(onecell, nodes, 2 * num_clocks), GFP_KERNEL);
880ac2a08fSDmitry Baryshkov if (!onecell)
890ac2a08fSDmitry Baryshkov return ERR_PTR(-ENOMEM);
900ac2a08fSDmitry Baryshkov
910ac2a08fSDmitry Baryshkov qp = devm_kzalloc(dev, struct_size(qp, clocks, num_clocks), GFP_KERNEL);
920ac2a08fSDmitry Baryshkov if (!qp)
930ac2a08fSDmitry Baryshkov return ERR_PTR(-ENOMEM);
940ac2a08fSDmitry Baryshkov
950ac2a08fSDmitry Baryshkov qp->num_clocks = num_clocks;
960ac2a08fSDmitry Baryshkov
970ac2a08fSDmitry Baryshkov provider = &qp->provider;
980ac2a08fSDmitry Baryshkov provider->dev = dev;
990ac2a08fSDmitry Baryshkov provider->get_bw = icc_clk_get_bw;
1000ac2a08fSDmitry Baryshkov provider->set = icc_clk_set;
1010ac2a08fSDmitry Baryshkov provider->aggregate = icc_std_aggregate;
1020ac2a08fSDmitry Baryshkov provider->xlate = of_icc_xlate_onecell;
1030ac2a08fSDmitry Baryshkov INIT_LIST_HEAD(&provider->nodes);
1040ac2a08fSDmitry Baryshkov provider->data = onecell;
1050ac2a08fSDmitry Baryshkov
1060ac2a08fSDmitry Baryshkov icc_provider_init(provider);
1070ac2a08fSDmitry Baryshkov
1080ac2a08fSDmitry Baryshkov for (i = 0, j = 0; i < num_clocks; i++) {
1090ac2a08fSDmitry Baryshkov qp->clocks[i].clk = data[i].clk;
1100ac2a08fSDmitry Baryshkov
1110ac2a08fSDmitry Baryshkov node = icc_node_create(first_id + j);
1120ac2a08fSDmitry Baryshkov if (IS_ERR(node)) {
1130ac2a08fSDmitry Baryshkov ret = PTR_ERR(node);
1140ac2a08fSDmitry Baryshkov goto err;
1150ac2a08fSDmitry Baryshkov }
1160ac2a08fSDmitry Baryshkov
1170ac2a08fSDmitry Baryshkov node->name = devm_kasprintf(dev, GFP_KERNEL, "%s_master", data[i].name);
1180ac2a08fSDmitry Baryshkov node->data = &qp->clocks[i];
1190ac2a08fSDmitry Baryshkov icc_node_add(node, provider);
1200ac2a08fSDmitry Baryshkov /* link to the next node, slave */
1210ac2a08fSDmitry Baryshkov icc_link_create(node, first_id + j + 1);
1220ac2a08fSDmitry Baryshkov onecell->nodes[j++] = node;
1230ac2a08fSDmitry Baryshkov
1240ac2a08fSDmitry Baryshkov node = icc_node_create(first_id + j);
1250ac2a08fSDmitry Baryshkov if (IS_ERR(node)) {
1260ac2a08fSDmitry Baryshkov ret = PTR_ERR(node);
1270ac2a08fSDmitry Baryshkov goto err;
1280ac2a08fSDmitry Baryshkov }
1290ac2a08fSDmitry Baryshkov
1300ac2a08fSDmitry Baryshkov node->name = devm_kasprintf(dev, GFP_KERNEL, "%s_slave", data[i].name);
1310ac2a08fSDmitry Baryshkov /* no data for slave node */
1320ac2a08fSDmitry Baryshkov icc_node_add(node, provider);
1330ac2a08fSDmitry Baryshkov onecell->nodes[j++] = node;
1340ac2a08fSDmitry Baryshkov }
1350ac2a08fSDmitry Baryshkov
1360ac2a08fSDmitry Baryshkov onecell->num_nodes = j;
1370ac2a08fSDmitry Baryshkov
1380ac2a08fSDmitry Baryshkov ret = icc_provider_register(provider);
1390ac2a08fSDmitry Baryshkov if (ret)
1400ac2a08fSDmitry Baryshkov goto err;
1410ac2a08fSDmitry Baryshkov
1420ac2a08fSDmitry Baryshkov return provider;
1430ac2a08fSDmitry Baryshkov
1440ac2a08fSDmitry Baryshkov err:
1450ac2a08fSDmitry Baryshkov icc_nodes_remove(provider);
1460ac2a08fSDmitry Baryshkov
1470ac2a08fSDmitry Baryshkov return ERR_PTR(ret);
1480ac2a08fSDmitry Baryshkov }
149a1f7e721SDmitry Baryshkov EXPORT_SYMBOL_GPL(icc_clk_register);
1500ac2a08fSDmitry Baryshkov
1510ac2a08fSDmitry Baryshkov /**
1520ac2a08fSDmitry Baryshkov * icc_clk_unregister() - unregister a previously registered clk interconnect provider
1530ac2a08fSDmitry Baryshkov * @provider: provider returned by icc_clk_register()
1540ac2a08fSDmitry Baryshkov */
icc_clk_unregister(struct icc_provider * provider)1550ac2a08fSDmitry Baryshkov void icc_clk_unregister(struct icc_provider *provider)
1560ac2a08fSDmitry Baryshkov {
1570ac2a08fSDmitry Baryshkov struct icc_clk_provider *qp = container_of(provider, struct icc_clk_provider, provider);
1580ac2a08fSDmitry Baryshkov int i;
1590ac2a08fSDmitry Baryshkov
1600ac2a08fSDmitry Baryshkov icc_provider_deregister(&qp->provider);
1610ac2a08fSDmitry Baryshkov icc_nodes_remove(&qp->provider);
1620ac2a08fSDmitry Baryshkov
1630ac2a08fSDmitry Baryshkov for (i = 0; i < qp->num_clocks; i++) {
1640ac2a08fSDmitry Baryshkov struct icc_clk_node *qn = &qp->clocks[i];
1650ac2a08fSDmitry Baryshkov
1660ac2a08fSDmitry Baryshkov if (qn->enabled)
1670ac2a08fSDmitry Baryshkov clk_disable_unprepare(qn->clk);
1680ac2a08fSDmitry Baryshkov }
1690ac2a08fSDmitry Baryshkov }
170a1f7e721SDmitry Baryshkov EXPORT_SYMBOL_GPL(icc_clk_unregister);
171a1f7e721SDmitry Baryshkov
172a1f7e721SDmitry Baryshkov MODULE_LICENSE("GPL");
173a1f7e721SDmitry Baryshkov MODULE_DESCRIPTION("Interconnect wrapper for clocks");
174a1f7e721SDmitry Baryshkov MODULE_AUTHOR("Dmitry Baryshkov <dmitry.baryshkov@linaro.org>");
175