1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2019 Xilinx, Inc.
9 #include <dm/device_compat.h>
10 #include <linux/bitops.h>
11 #include <linux/bitfield.h>
13 #include <clk-uclass.h>
16 #include <asm/arch/sys_proto.h>
17 #include <zynqmp_firmware.h>
18 #include <linux/err.h>
20 #define MAX_PARENT 100
22 #define MAX_NAME_LEN 50
24 #define CLK_TYPE_SHIFT 2
26 #define PM_API_PAYLOAD_LEN 3
28 #define NA_PARENT 0xFFFFFFFF
29 #define DUMMY_PARENT 0xFFFFFFFE
31 #define CLK_TYPE_FIELD_LEN 4
32 #define CLK_TOPOLOGY_NODE_OFFSET 16
33 #define NODES_PER_RESP 3
35 #define CLK_TYPE_FIELD_MASK 0xF
36 #define CLK_FLAG_FIELD_MASK GENMASK(21, 8)
37 #define CLK_TYPE_FLAG_FIELD_MASK GENMASK(31, 24)
38 #define CLK_TYPE_FLAG2_FIELD_MASK GENMASK(7, 4)
39 #define CLK_TYPE_FLAG_BITS 8
41 #define CLK_PARENTS_ID_LEN 16
42 #define CLK_PARENTS_ID_MASK 0xFFFF
44 #define END_OF_TOPOLOGY_NODE 1
45 #define END_OF_PARENTS 1
47 #define CLK_VALID_MASK 0x1
48 #define NODE_CLASS_SHIFT 26U
49 #define NODE_SUBCLASS_SHIFT 20U
50 #define NODE_TYPE_SHIFT 14U
51 #define NODE_INDEX_SHIFT 0U
53 #define CLK_GET_NAME_RESP_LEN 16
54 #define CLK_GET_TOPOLOGY_RESP_WORDS 3
55 #define CLK_GET_PARENTS_RESP_WORDS 3
56 #define CLK_GET_ATTR_RESP_WORDS 1
58 #define NODE_SUBCLASS_CLOCK_PLL 1
59 #define NODE_SUBCLASS_CLOCK_OUT 2
60 #define NODE_SUBCLASS_CLOCK_REF 3
62 #define NODE_CLASS_CLOCK 2
63 #define NODE_CLASS_MASK 0x3F
65 #define CLOCK_NODE_TYPE_MUX 1
66 #define CLOCK_NODE_TYPE_DIV 4
67 #define CLOCK_NODE_TYPE_GATE 6
71 PM_QID_CLOCK_GET_NAME,
72 PM_QID_CLOCK_GET_TOPOLOGY,
73 PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS,
74 PM_QID_CLOCK_GET_PARENTS,
75 PM_QID_CLOCK_GET_ATTRIBUTES,
76 PM_QID_PINCTRL_GET_NUM_PINS,
77 PM_QID_PINCTRL_GET_NUM_FUNCTIONS,
78 PM_QID_PINCTRL_GET_NUM_FUNCTION_GROUPS,
79 PM_QID_PINCTRL_GET_FUNCTION_NAME,
80 PM_QID_PINCTRL_GET_FUNCTION_GROUPS,
81 PM_QID_PINCTRL_GET_PIN_GROUPS,
82 PM_QID_CLOCK_GET_NUM_CLOCKS,
83 PM_QID_CLOCK_GET_MAX_DIVISOR,
92 char name[MAX_NAME_LEN];
97 struct clock_topology {
103 struct versal_clock {
104 char clk_name[MAX_NAME_LEN];
107 struct clock_topology node[MAX_NODES];
109 struct clock_parent parent[MAX_PARENT];
114 struct versal_clk_priv {
115 struct versal_clock *clk;
118 static ulong alt_ref_clk;
119 static ulong pl_alt_ref_clk;
120 static ulong ref_clk;
122 struct versal_pm_query_data {
129 static struct versal_clock *clock;
130 static unsigned int clock_max_idx;
132 #define PM_QUERY_DATA 35
134 static int versal_pm_query(struct versal_pm_query_data qdata, u32 *ret_payload)
138 regs.regs[0] = PM_SIP_SVC | PM_QUERY_DATA;
139 regs.regs[1] = ((u64)qdata.arg1 << 32) | qdata.qid;
140 regs.regs[2] = ((u64)qdata.arg3 << 32) | qdata.arg2;
145 ret_payload[0] = (u32)regs.regs[0];
146 ret_payload[1] = upper_32_bits(regs.regs[0]);
147 ret_payload[2] = (u32)regs.regs[1];
148 ret_payload[3] = upper_32_bits(regs.regs[1]);
149 ret_payload[4] = (u32)regs.regs[2];
152 return qdata.qid == PM_QID_CLOCK_GET_NAME ? 0 : regs.regs[0];
155 static inline int versal_is_valid_clock(u32 clk_id)
157 if (clk_id >= clock_max_idx)
160 return clock[clk_id].valid;
163 static int versal_get_clock_name(u32 clk_id, char *clk_name)
167 ret = versal_is_valid_clock(clk_id);
169 strncpy(clk_name, clock[clk_id].clk_name, MAX_NAME_LEN);
173 return ret == 0 ? -EINVAL : ret;
176 static int versal_get_clock_type(u32 clk_id, u32 *type)
180 ret = versal_is_valid_clock(clk_id);
182 *type = clock[clk_id].type;
186 return ret == 0 ? -EINVAL : ret;
189 static int versal_pm_clock_get_num_clocks(u32 *nclocks)
191 struct versal_pm_query_data qdata = {0};
192 u32 ret_payload[PAYLOAD_ARG_CNT];
195 qdata.qid = PM_QID_CLOCK_GET_NUM_CLOCKS;
197 ret = versal_pm_query(qdata, ret_payload);
198 *nclocks = ret_payload[1];
203 static int versal_pm_clock_get_name(u32 clock_id, char *name)
205 struct versal_pm_query_data qdata = {0};
206 u32 ret_payload[PAYLOAD_ARG_CNT];
209 qdata.qid = PM_QID_CLOCK_GET_NAME;
210 qdata.arg1 = clock_id;
212 ret = versal_pm_query(qdata, ret_payload);
215 memcpy(name, ret_payload, CLK_GET_NAME_RESP_LEN);
220 static int versal_pm_clock_get_topology(u32 clock_id, u32 index, u32 *topology)
222 struct versal_pm_query_data qdata = {0};
223 u32 ret_payload[PAYLOAD_ARG_CNT];
226 qdata.qid = PM_QID_CLOCK_GET_TOPOLOGY;
227 qdata.arg1 = clock_id;
230 ret = versal_pm_query(qdata, ret_payload);
231 memcpy(topology, &ret_payload[1], CLK_GET_TOPOLOGY_RESP_WORDS * 4);
236 static int versal_pm_clock_get_parents(u32 clock_id, u32 index, u32 *parents)
238 struct versal_pm_query_data qdata = {0};
239 u32 ret_payload[PAYLOAD_ARG_CNT];
242 qdata.qid = PM_QID_CLOCK_GET_PARENTS;
243 qdata.arg1 = clock_id;
246 ret = versal_pm_query(qdata, ret_payload);
247 memcpy(parents, &ret_payload[1], CLK_GET_PARENTS_RESP_WORDS * 4);
252 static int versal_pm_clock_get_attributes(u32 clock_id, u32 *attr)
254 struct versal_pm_query_data qdata = {0};
255 u32 ret_payload[PAYLOAD_ARG_CNT];
258 qdata.qid = PM_QID_CLOCK_GET_ATTRIBUTES;
259 qdata.arg1 = clock_id;
261 ret = versal_pm_query(qdata, ret_payload);
262 memcpy(attr, &ret_payload[1], CLK_GET_ATTR_RESP_WORDS * 4);
267 static int __versal_clock_get_topology(struct clock_topology *topology,
268 u32 *data, u32 *nnodes)
272 for (i = 0; i < PM_API_PAYLOAD_LEN; i++) {
273 if (!(data[i] & CLK_TYPE_FIELD_MASK))
274 return END_OF_TOPOLOGY_NODE;
275 topology[*nnodes].type = data[i] & CLK_TYPE_FIELD_MASK;
276 topology[*nnodes].flag = FIELD_GET(CLK_FLAG_FIELD_MASK,
278 topology[*nnodes].type_flag =
279 FIELD_GET(CLK_TYPE_FLAG_FIELD_MASK, data[i]);
280 topology[*nnodes].type_flag |=
281 FIELD_GET(CLK_TYPE_FLAG2_FIELD_MASK, data[i]) <<
283 debug("topology type:0x%x, flag:0x%x, type_flag:0x%x\n",
284 topology[*nnodes].type, topology[*nnodes].flag,
285 topology[*nnodes].type_flag);
292 static int versal_clock_get_topology(u32 clk_id,
293 struct clock_topology *topology,
297 u32 pm_resp[PM_API_PAYLOAD_LEN] = {0};
300 for (j = 0; j <= MAX_NODES; j += 3) {
301 ret = versal_pm_clock_get_topology(clock[clk_id].clk_id, j,
305 ret = __versal_clock_get_topology(topology, pm_resp, num_nodes);
306 if (ret == END_OF_TOPOLOGY_NODE)
313 static int __versal_clock_get_parents(struct clock_parent *parents, u32 *data,
317 struct clock_parent *parent;
319 for (i = 0; i < PM_API_PAYLOAD_LEN; i++) {
320 if (data[i] == NA_PARENT)
321 return END_OF_PARENTS;
323 parent = &parents[i];
324 parent->id = data[i] & CLK_PARENTS_ID_MASK;
325 if (data[i] == DUMMY_PARENT) {
326 strcpy(parent->name, "dummy_name");
329 parent->flag = data[i] >> CLK_PARENTS_ID_LEN;
330 if (versal_get_clock_name(parent->id, parent->name))
333 debug("parent name:%s\n", parent->name);
340 static int versal_clock_get_parents(u32 clk_id, struct clock_parent *parents,
344 u32 pm_resp[PM_API_PAYLOAD_LEN] = {0};
348 /* Get parents from firmware */
349 ret = versal_pm_clock_get_parents(clock[clk_id].clk_id, j,
354 ret = __versal_clock_get_parents(&parents[j], pm_resp,
356 if (ret == END_OF_PARENTS)
358 j += PM_API_PAYLOAD_LEN;
359 } while (*num_parents <= MAX_PARENT);
364 static u32 versal_clock_get_div(u32 clk_id)
366 u32 ret_payload[PAYLOAD_ARG_CNT];
369 xilinx_pm_request(PM_CLOCK_GETDIVIDER, clk_id, 0, 0, 0, ret_payload);
370 div = ret_payload[1];
375 static u32 versal_clock_set_div(u32 clk_id, u32 div)
377 u32 ret_payload[PAYLOAD_ARG_CNT];
379 xilinx_pm_request(PM_CLOCK_SETDIVIDER, clk_id, div, 0, 0, ret_payload);
384 static u64 versal_clock_ref(u32 clk_id)
386 u32 ret_payload[PAYLOAD_ARG_CNT];
389 xilinx_pm_request(PM_CLOCK_GETPARENT, clk_id, 0, 0, 0, ret_payload);
390 ref = ret_payload[0];
394 return pl_alt_ref_clk;
398 static u64 versal_clock_get_pll_rate(u32 clk_id)
400 u32 ret_payload[PAYLOAD_ARG_CNT];
405 u32 parent_rate, parent_id;
406 u32 id = clk_id & 0xFFF;
408 xilinx_pm_request(PM_CLOCK_GETSTATE, clk_id, 0, 0, 0, ret_payload);
409 res = ret_payload[1];
411 printf("0%x PLL not enabled\n", clk_id);
415 parent_id = clock[clock[id].parent[0].id].clk_id;
416 parent_rate = versal_clock_ref(parent_id);
418 xilinx_pm_request(PM_CLOCK_GETDIVIDER, clk_id, 0, 0, 0, ret_payload);
419 fbdiv = ret_payload[1];
420 xilinx_pm_request(PM_CLOCK_PLL_GETPARAM, clk_id, 2, 0, 0, ret_payload);
421 frac = ret_payload[1];
423 freq = (fbdiv * parent_rate) >> (1 << frac);
428 static u32 versal_clock_mux(u32 clk_id)
431 u32 id = clk_id & 0xFFF;
433 for (i = 0; i < clock[id].num_nodes; i++)
434 if (clock[id].node[i].type == CLOCK_NODE_TYPE_MUX)
440 static u32 versal_clock_get_parentid(u32 clk_id)
443 u32 ret_payload[PAYLOAD_ARG_CNT];
444 u32 id = clk_id & 0xFFF;
446 if (versal_clock_mux(clk_id)) {
447 xilinx_pm_request(PM_CLOCK_GETPARENT, clk_id, 0, 0, 0,
449 parent_id = ret_payload[1];
452 debug("parent_id:0x%x\n", clock[clock[id].parent[parent_id].id].clk_id);
453 return clock[clock[id].parent[parent_id].id].clk_id;
456 static u32 versal_clock_gate(u32 clk_id)
458 u32 id = clk_id & 0xFFF;
461 for (i = 0; i < clock[id].num_nodes; i++)
462 if (clock[id].node[i].type == CLOCK_NODE_TYPE_GATE)
468 static u32 versal_clock_div(u32 clk_id)
471 u32 id = clk_id & 0xFFF;
473 for (i = 0; i < clock[id].num_nodes; i++)
474 if (clock[id].node[i].type == CLOCK_NODE_TYPE_DIV)
480 static u32 versal_clock_pll(u32 clk_id, u64 *clk_rate)
482 if (((clk_id >> NODE_SUBCLASS_SHIFT) & NODE_CLASS_MASK) ==
483 NODE_SUBCLASS_CLOCK_PLL &&
484 ((clk_id >> NODE_CLASS_SHIFT) & NODE_CLASS_MASK) ==
486 *clk_rate = versal_clock_get_pll_rate(clk_id);
493 static u64 versal_clock_calc(u32 clk_id)
499 if (versal_clock_pll(clk_id, &clk_rate))
502 parent_id = versal_clock_get_parentid(clk_id);
503 if (((parent_id >> NODE_SUBCLASS_SHIFT) &
504 NODE_CLASS_MASK) == NODE_SUBCLASS_CLOCK_REF)
505 return versal_clock_ref(clk_id);
510 clk_rate = versal_clock_calc(parent_id);
512 if (versal_clock_div(clk_id)) {
513 div = versal_clock_get_div(clk_id);
514 clk_rate = DIV_ROUND_CLOSEST(clk_rate, div);
520 static int versal_clock_get_rate(u32 clk_id, u64 *clk_rate)
522 if (((clk_id >> NODE_SUBCLASS_SHIFT) &
523 NODE_CLASS_MASK) == NODE_SUBCLASS_CLOCK_REF)
524 *clk_rate = versal_clock_ref(clk_id);
526 if (versal_clock_pll(clk_id, clk_rate))
529 if (((clk_id >> NODE_SUBCLASS_SHIFT) &
530 NODE_CLASS_MASK) == NODE_SUBCLASS_CLOCK_OUT &&
531 ((clk_id >> NODE_CLASS_SHIFT) &
532 NODE_CLASS_MASK) == NODE_CLASS_CLOCK) {
533 if (!versal_clock_gate(clk_id) && !versal_clock_mux(clk_id))
535 *clk_rate = versal_clock_calc(clk_id);
542 int soc_clk_dump(void)
545 u32 type, ret, i = 0;
547 printf("\n ****** VERSAL CLOCKS *****\n");
549 printf("alt_ref_clk:%ld pl_alt_ref_clk:%ld ref_clk:%ld\n",
550 alt_ref_clk, pl_alt_ref_clk, ref_clk);
551 for (i = 0; i < clock_max_idx; i++) {
552 debug("%s\n", clock[i].clk_name);
553 ret = versal_get_clock_type(i, &type);
554 if (ret || type != CLK_TYPE_OUTPUT)
557 ret = versal_clock_get_rate(clock[i].clk_id, &clk_rate);
560 printf("clk: %s freq:%lld\n",
561 clock[i].clk_name, clk_rate);
567 static void versal_get_clock_info(void)
570 u32 attr, type = 0, nodetype, subclass, class;
572 for (i = 0; i < clock_max_idx; i++) {
573 ret = versal_pm_clock_get_attributes(i, &attr);
577 clock[i].valid = attr & CLK_VALID_MASK;
579 /* skip query for Invalid clock */
580 ret = versal_is_valid_clock(i);
581 if (ret != CLK_VALID_MASK)
584 clock[i].type = ((attr >> CLK_TYPE_SHIFT) & 0x1) ?
585 CLK_TYPE_EXTERNAL : CLK_TYPE_OUTPUT;
586 nodetype = (attr >> NODE_TYPE_SHIFT) & NODE_CLASS_MASK;
587 subclass = (attr >> NODE_SUBCLASS_SHIFT) & NODE_CLASS_MASK;
588 class = (attr >> NODE_CLASS_SHIFT) & NODE_CLASS_MASK;
590 clock[i].clk_id = (class << NODE_CLASS_SHIFT) |
591 (subclass << NODE_SUBCLASS_SHIFT) |
592 (nodetype << NODE_TYPE_SHIFT) |
593 (i << NODE_INDEX_SHIFT);
595 ret = versal_pm_clock_get_name(clock[i].clk_id,
599 debug("clk name:%s, Valid:%d, type:%d, clk_id:0x%x\n",
600 clock[i].clk_name, clock[i].valid,
601 clock[i].type, clock[i].clk_id);
604 /* Get topology of all clock */
605 for (i = 0; i < clock_max_idx; i++) {
606 ret = versal_get_clock_type(i, &type);
607 if (ret || type != CLK_TYPE_OUTPUT)
609 debug("clk name:%s\n", clock[i].clk_name);
610 ret = versal_clock_get_topology(i, clock[i].node,
611 &clock[i].num_nodes);
615 ret = versal_clock_get_parents(i, clock[i].parent,
616 &clock[i].num_parents);
622 int versal_clock_setup(void)
626 ret = versal_pm_clock_get_num_clocks(&clock_max_idx);
630 debug("%s, clock_max_idx:0x%x\n", __func__, clock_max_idx);
631 clock = calloc(clock_max_idx, sizeof(*clock));
635 versal_get_clock_info();
640 static int versal_clock_get_freq_by_name(char *name, struct udevice *dev,
646 ret = clk_get_by_name(dev, name, &clk);
648 dev_err(dev, "failed to get %s\n", name);
652 *freq = clk_get_rate(&clk);
653 if (IS_ERR_VALUE(*freq)) {
654 dev_err(dev, "failed to get rate %s\n", name);
661 static int versal_clk_probe(struct udevice *dev)
664 struct versal_clk_priv *priv = dev_get_priv(dev);
666 debug("%s\n", __func__);
668 ret = versal_clock_get_freq_by_name("alt_ref_clk", dev, &alt_ref_clk);
672 ret = versal_clock_get_freq_by_name("pl_alt_ref_clk",
673 dev, &pl_alt_ref_clk);
677 ret = versal_clock_get_freq_by_name("ref_clk", dev, &ref_clk);
681 versal_clock_setup();
688 static ulong versal_clk_get_rate(struct clk *clk)
690 struct versal_clk_priv *priv = dev_get_priv(clk->dev);
695 debug("%s\n", __func__);
697 clk_id = priv->clk[id].clk_id;
699 versal_clock_get_rate(clk_id, &clk_rate);
704 static ulong versal_clk_set_rate(struct clk *clk, ulong rate)
706 struct versal_clk_priv *priv = dev_get_priv(clk->dev);
713 debug("%s\n", __func__);
715 clk_id = priv->clk[id].clk_id;
717 ret = versal_clock_get_rate(clk_id, &clk_rate);
719 printf("Clock is not a Gate:0x%x\n", clk_id);
724 if (versal_clock_div(clk_id)) {
725 div = versal_clock_get_div(clk_id);
727 div = DIV_ROUND_CLOSEST(clk_rate, rate);
728 versal_clock_set_div(clk_id, div);
729 debug("%s, div:%d, newrate:%lld\n", __func__,
730 div, DIV_ROUND_CLOSEST(clk_rate, div));
731 return DIV_ROUND_CLOSEST(clk_rate, div);
733 clk_id = versal_clock_get_parentid(clk_id);
734 } while (((clk_id >> NODE_SUBCLASS_SHIFT) &
735 NODE_CLASS_MASK) != NODE_SUBCLASS_CLOCK_REF);
737 printf("Clock didn't has Divisors:0x%x\n", priv->clk[id].clk_id);
742 static struct clk_ops versal_clk_ops = {
743 .set_rate = versal_clk_set_rate,
744 .get_rate = versal_clk_get_rate,
747 static const struct udevice_id versal_clk_ids[] = {
748 { .compatible = "xlnx,versal-clk" },
752 U_BOOT_DRIVER(versal_clk) = {
753 .name = "versal-clk",
755 .of_match = versal_clk_ids,
756 .probe = versal_clk_probe,
757 .ops = &versal_clk_ops,
758 .priv_auto_alloc_size = sizeof(struct versal_clk_priv),