1 // SPDX-License-Identifier: GPL-2.0
3 * Zynq UltraScale+ MPSoC clock controller
5 * Copyright (C) 2016-2019 Xilinx
7 * Based on drivers/clk/zynq/clkc.c
10 #include <linux/bitfield.h>
11 #include <linux/clk.h>
12 #include <linux/clk-provider.h>
13 #include <linux/module.h>
14 #include <linux/of_platform.h>
15 #include <linux/slab.h>
16 #include <linux/string.h>
18 #include "clk-zynqmp.h"
20 #define MAX_PARENT 100
22 #define MAX_NAME_LEN 50
24 /* Flags for parents */
25 #define PARENT_CLK_SELF 0
26 #define PARENT_CLK_NODE1 1
27 #define PARENT_CLK_NODE2 2
28 #define PARENT_CLK_NODE3 3
29 #define PARENT_CLK_NODE4 4
30 #define PARENT_CLK_EXTERNAL 5
32 #define END_OF_CLK_NAME "END_OF_CLK"
33 #define END_OF_TOPOLOGY_NODE 1
34 #define END_OF_PARENTS 1
35 #define RESERVED_CLK_NAME ""
37 #define CLK_GET_NAME_RESP_LEN 16
38 #define CLK_GET_TOPOLOGY_RESP_WORDS 3
39 #define CLK_GET_PARENTS_RESP_WORDS 3
40 #define CLK_GET_ATTR_RESP_WORDS 1
48 * struct clock_parent - Clock parent
50 * @id: Parent clock ID
54 char name[MAX_NAME_LEN];
60 * struct zynqmp_clock - Clock
61 * @clk_name: Clock name
62 * @valid: Validity flag of clock
63 * @type: Clock type (Output/External)
64 * @node: Clock topology nodes
65 * @num_nodes: Number of nodes present in topology
66 * @parent: Parent of clock
67 * @num_parents: Number of parents of clock
71 char clk_name[MAX_NAME_LEN];
74 struct clock_topology node[MAX_NODES];
76 struct clock_parent parent[MAX_PARENT];
82 char name[CLK_GET_NAME_RESP_LEN];
85 struct topology_resp {
86 #define CLK_TOPOLOGY_TYPE GENMASK(3, 0)
87 #define CLK_TOPOLOGY_CUSTOM_TYPE_FLAGS GENMASK(7, 4)
88 #define CLK_TOPOLOGY_FLAGS GENMASK(23, 8)
89 #define CLK_TOPOLOGY_TYPE_FLAGS GENMASK(31, 24)
90 u32 topology[CLK_GET_TOPOLOGY_RESP_WORDS];
94 #define NA_PARENT 0xFFFFFFFF
95 #define DUMMY_PARENT 0xFFFFFFFE
96 #define CLK_PARENTS_ID GENMASK(15, 0)
97 #define CLK_PARENTS_FLAGS GENMASK(31, 16)
98 u32 parents[CLK_GET_PARENTS_RESP_WORDS];
102 #define CLK_ATTR_VALID BIT(0)
103 #define CLK_ATTR_TYPE BIT(2)
104 #define CLK_ATTR_NODE_INDEX GENMASK(13, 0)
105 #define CLK_ATTR_NODE_TYPE GENMASK(19, 14)
106 #define CLK_ATTR_NODE_SUBCLASS GENMASK(25, 20)
107 #define CLK_ATTR_NODE_CLASS GENMASK(31, 26)
108 u32 attr[CLK_GET_ATTR_RESP_WORDS];
111 static const char clk_type_postfix[][10] = {
115 [TYPE_DIV1] = "_div1",
116 [TYPE_DIV2] = "_div2",
117 [TYPE_FIXEDFACTOR] = "_ff",
121 static struct clk_hw *(* const clk_topology[]) (const char *name, u32 clk_id,
122 const char * const *parents,
124 const struct clock_topology *nodes)
126 [TYPE_INVALID] = NULL,
127 [TYPE_MUX] = zynqmp_clk_register_mux,
128 [TYPE_PLL] = zynqmp_clk_register_pll,
129 [TYPE_FIXEDFACTOR] = zynqmp_clk_register_fixed_factor,
130 [TYPE_DIV1] = zynqmp_clk_register_divider,
131 [TYPE_DIV2] = zynqmp_clk_register_divider,
132 [TYPE_GATE] = zynqmp_clk_register_gate
135 static struct zynqmp_clock *clock;
136 static struct clk_hw_onecell_data *zynqmp_data;
137 static unsigned int clock_max_idx;
140 * zynqmp_is_valid_clock() - Check whether clock is valid or not
141 * @clk_id: Clock index
143 * Return: 1 if clock is valid, 0 if clock is invalid else error code
145 static inline int zynqmp_is_valid_clock(u32 clk_id)
147 if (clk_id >= clock_max_idx)
150 return clock[clk_id].valid;
154 * zynqmp_get_clock_name() - Get name of clock from Clock index
155 * @clk_id: Clock index
156 * @clk_name: Name of clock
158 * Return: 0 on success else error code
160 static int zynqmp_get_clock_name(u32 clk_id, char *clk_name)
164 ret = zynqmp_is_valid_clock(clk_id);
166 strncpy(clk_name, clock[clk_id].clk_name, MAX_NAME_LEN);
170 return ret == 0 ? -EINVAL : ret;
174 * zynqmp_get_clock_type() - Get type of clock
175 * @clk_id: Clock index
176 * @type: Clock type: CLK_TYPE_OUTPUT or CLK_TYPE_EXTERNAL
178 * Return: 0 on success else error code
180 static int zynqmp_get_clock_type(u32 clk_id, u32 *type)
184 ret = zynqmp_is_valid_clock(clk_id);
186 *type = clock[clk_id].type;
190 return ret == 0 ? -EINVAL : ret;
194 * zynqmp_pm_clock_get_num_clocks() - Get number of clocks in system
195 * @nclocks: Number of clocks in system/board.
197 * Call firmware API to get number of clocks.
199 * Return: 0 on success else error code.
201 static int zynqmp_pm_clock_get_num_clocks(u32 *nclocks)
203 struct zynqmp_pm_query_data qdata = {0};
204 u32 ret_payload[PAYLOAD_ARG_CNT];
207 qdata.qid = PM_QID_CLOCK_GET_NUM_CLOCKS;
209 ret = zynqmp_pm_query_data(qdata, ret_payload);
210 *nclocks = ret_payload[1];
216 * zynqmp_pm_clock_get_name() - Get the name of clock for given id
217 * @clock_id: ID of the clock to be queried
218 * @response: Name of the clock with the given id
220 * This function is used to get name of clock specified by given
225 static int zynqmp_pm_clock_get_name(u32 clock_id,
226 struct name_resp *response)
228 struct zynqmp_pm_query_data qdata = {0};
229 u32 ret_payload[PAYLOAD_ARG_CNT];
231 qdata.qid = PM_QID_CLOCK_GET_NAME;
232 qdata.arg1 = clock_id;
234 zynqmp_pm_query_data(qdata, ret_payload);
235 memcpy(response, ret_payload, sizeof(*response));
241 * zynqmp_pm_clock_get_topology() - Get the topology of clock for given id
242 * @clock_id: ID of the clock to be queried
243 * @index: Node index of clock topology
244 * @response: Buffer used for the topology response
246 * This function is used to get topology information for the clock
247 * specified by given clock ID.
249 * This API will return 3 node of topology with a single response. To get
250 * other nodes, master should call same API in loop with new
251 * index till error is returned. E.g First call should have
252 * index 0 which will return nodes 0,1 and 2. Next call, index
253 * should be 3 which will return nodes 3,4 and 5 and so on.
255 * Return: 0 on success else error+reason
257 static int zynqmp_pm_clock_get_topology(u32 clock_id, u32 index,
258 struct topology_resp *response)
260 struct zynqmp_pm_query_data qdata = {0};
261 u32 ret_payload[PAYLOAD_ARG_CNT];
264 qdata.qid = PM_QID_CLOCK_GET_TOPOLOGY;
265 qdata.arg1 = clock_id;
268 ret = zynqmp_pm_query_data(qdata, ret_payload);
269 memcpy(response, &ret_payload[1], sizeof(*response));
274 unsigned long zynqmp_clk_map_common_ccf_flags(const u32 zynqmp_flag)
276 unsigned long ccf_flag = 0;
278 if (zynqmp_flag & ZYNQMP_CLK_SET_RATE_GATE)
279 ccf_flag |= CLK_SET_RATE_GATE;
280 if (zynqmp_flag & ZYNQMP_CLK_SET_PARENT_GATE)
281 ccf_flag |= CLK_SET_PARENT_GATE;
282 if (zynqmp_flag & ZYNQMP_CLK_SET_RATE_PARENT)
283 ccf_flag |= CLK_SET_RATE_PARENT;
284 if (zynqmp_flag & ZYNQMP_CLK_IGNORE_UNUSED)
285 ccf_flag |= CLK_IGNORE_UNUSED;
286 if (zynqmp_flag & ZYNQMP_CLK_SET_RATE_NO_REPARENT)
287 ccf_flag |= CLK_SET_RATE_NO_REPARENT;
288 if (zynqmp_flag & ZYNQMP_CLK_IS_CRITICAL)
289 ccf_flag |= CLK_IS_CRITICAL;
295 * zynqmp_clk_register_fixed_factor() - Register fixed factor with the
297 * @name: Name of this clock
299 * @parents: Name of this clock's parents
300 * @num_parents: Number of parents
301 * @nodes: Clock topology node
303 * Return: clock hardware to the registered clock
305 struct clk_hw *zynqmp_clk_register_fixed_factor(const char *name, u32 clk_id,
306 const char * const *parents,
308 const struct clock_topology *nodes)
312 struct zynqmp_pm_query_data qdata = {0};
313 u32 ret_payload[PAYLOAD_ARG_CNT];
317 qdata.qid = PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS;
320 ret = zynqmp_pm_query_data(qdata, ret_payload);
324 mult = ret_payload[1];
325 div = ret_payload[2];
327 flag = zynqmp_clk_map_common_ccf_flags(nodes->flag);
329 hw = clk_hw_register_fixed_factor(NULL, name,
338 * zynqmp_pm_clock_get_parents() - Get the first 3 parents of clock for given id
339 * @clock_id: Clock ID
340 * @index: Parent index
341 * @response: Parents of the given clock
343 * This function is used to get 3 parents for the clock specified by
346 * This API will return 3 parents with a single response. To get
347 * other parents, master should call same API in loop with new
348 * parent index till error is returned. E.g First call should have
349 * index 0 which will return parents 0,1 and 2. Next call, index
350 * should be 3 which will return parent 3,4 and 5 and so on.
352 * Return: 0 on success else error+reason
354 static int zynqmp_pm_clock_get_parents(u32 clock_id, u32 index,
355 struct parents_resp *response)
357 struct zynqmp_pm_query_data qdata = {0};
358 u32 ret_payload[PAYLOAD_ARG_CNT];
361 qdata.qid = PM_QID_CLOCK_GET_PARENTS;
362 qdata.arg1 = clock_id;
365 ret = zynqmp_pm_query_data(qdata, ret_payload);
366 memcpy(response, &ret_payload[1], sizeof(*response));
372 * zynqmp_pm_clock_get_attributes() - Get the attributes of clock for given id
373 * @clock_id: Clock ID
374 * @response: Clock attributes response
376 * This function is used to get clock's attributes(e.g. valid, clock type, etc).
378 * Return: 0 on success else error+reason
380 static int zynqmp_pm_clock_get_attributes(u32 clock_id,
381 struct attr_resp *response)
383 struct zynqmp_pm_query_data qdata = {0};
384 u32 ret_payload[PAYLOAD_ARG_CNT];
387 qdata.qid = PM_QID_CLOCK_GET_ATTRIBUTES;
388 qdata.arg1 = clock_id;
390 ret = zynqmp_pm_query_data(qdata, ret_payload);
391 memcpy(response, &ret_payload[1], sizeof(*response));
397 * __zynqmp_clock_get_topology() - Get topology data of clock from firmware
399 * @topology: Clock topology
400 * @response: Clock topology data received from firmware
401 * @nnodes: Number of nodes
403 * Return: 0 on success else error+reason
405 static int __zynqmp_clock_get_topology(struct clock_topology *topology,
406 struct topology_resp *response,
412 for (i = 0; i < ARRAY_SIZE(response->topology); i++) {
413 type = FIELD_GET(CLK_TOPOLOGY_TYPE, response->topology[i]);
414 if (type == TYPE_INVALID)
415 return END_OF_TOPOLOGY_NODE;
416 topology[*nnodes].type = type;
417 topology[*nnodes].flag = FIELD_GET(CLK_TOPOLOGY_FLAGS,
418 response->topology[i]);
419 topology[*nnodes].type_flag =
420 FIELD_GET(CLK_TOPOLOGY_TYPE_FLAGS,
421 response->topology[i]);
422 topology[*nnodes].custom_type_flag =
423 FIELD_GET(CLK_TOPOLOGY_CUSTOM_TYPE_FLAGS,
424 response->topology[i]);
432 * zynqmp_clock_get_topology() - Get topology of clock from firmware using
434 * @clk_id: Clock index
435 * @topology: Clock topology
436 * @num_nodes: Number of nodes
438 * Return: 0 on success else error+reason
440 static int zynqmp_clock_get_topology(u32 clk_id,
441 struct clock_topology *topology,
445 struct topology_resp response = { };
448 for (j = 0; j <= MAX_NODES; j += ARRAY_SIZE(response.topology)) {
449 ret = zynqmp_pm_clock_get_topology(clock[clk_id].clk_id, j,
453 ret = __zynqmp_clock_get_topology(topology, &response,
455 if (ret == END_OF_TOPOLOGY_NODE)
463 * __zynqmp_clock_get_parents() - Get parents info of clock from firmware
465 * @parents: Clock parents
466 * @response: Clock parents data received from firmware
467 * @nparent: Number of parent
469 * Return: 0 on success else error+reason
471 static int __zynqmp_clock_get_parents(struct clock_parent *parents,
472 struct parents_resp *response,
476 struct clock_parent *parent;
478 for (i = 0; i < ARRAY_SIZE(response->parents); i++) {
479 if (response->parents[i] == NA_PARENT)
480 return END_OF_PARENTS;
482 parent = &parents[i];
483 parent->id = FIELD_GET(CLK_PARENTS_ID, response->parents[i]);
484 if (response->parents[i] == DUMMY_PARENT) {
485 strcpy(parent->name, "dummy_name");
488 parent->flag = FIELD_GET(CLK_PARENTS_FLAGS,
489 response->parents[i]);
490 if (zynqmp_get_clock_name(parent->id, parent->name))
500 * zynqmp_clock_get_parents() - Get parents info from firmware using PM_API
501 * @clk_id: Clock index
502 * @parents: Clock parents
503 * @num_parents: Total number of parents
505 * Return: 0 on success else error+reason
507 static int zynqmp_clock_get_parents(u32 clk_id, struct clock_parent *parents,
511 struct parents_resp response = { };
515 /* Get parents from firmware */
516 ret = zynqmp_pm_clock_get_parents(clock[clk_id].clk_id, j,
521 ret = __zynqmp_clock_get_parents(&parents[j], &response,
523 if (ret == END_OF_PARENTS)
525 j += ARRAY_SIZE(response.parents);
526 } while (*num_parents <= MAX_PARENT);
532 * zynqmp_get_parent_list() - Create list of parents name
534 * @clk_id: Clock index
535 * @parent_list: List of parent's name
536 * @num_parents: Total number of parents
538 * Return: 0 on success else error+reason
540 static int zynqmp_get_parent_list(struct device_node *np, u32 clk_id,
541 const char **parent_list, u32 *num_parents)
544 u32 total_parents = clock[clk_id].num_parents;
545 struct clock_topology *clk_nodes;
546 struct clock_parent *parents;
548 clk_nodes = clock[clk_id].node;
549 parents = clock[clk_id].parent;
551 for (i = 0; i < total_parents; i++) {
552 if (!parents[i].flag) {
553 parent_list[i] = parents[i].name;
554 } else if (parents[i].flag == PARENT_CLK_EXTERNAL) {
555 ret = of_property_match_string(np, "clock-names",
558 strcpy(parents[i].name, "dummy_name");
559 parent_list[i] = parents[i].name;
561 strcat(parents[i].name,
562 clk_type_postfix[clk_nodes[parents[i].flag - 1].
564 parent_list[i] = parents[i].name;
568 *num_parents = total_parents;
573 * zynqmp_register_clk_topology() - Register clock topology
574 * @clk_id: Clock index
575 * @clk_name: Clock Name
576 * @num_parents: Total number of parents
577 * @parent_names: List of parents name
579 * Return: Returns either clock hardware or error+reason
581 static struct clk_hw *zynqmp_register_clk_topology(int clk_id, char *clk_name,
583 const char **parent_names)
586 u32 num_nodes, clk_dev_id;
587 char *clk_out[MAX_NODES];
588 struct clock_topology *nodes;
589 struct clk_hw *hw = NULL;
591 nodes = clock[clk_id].node;
592 num_nodes = clock[clk_id].num_nodes;
593 clk_dev_id = clock[clk_id].clk_id;
595 for (j = 0; j < num_nodes; j++) {
597 * Clock name received from firmware is output clock name.
598 * Intermediate clock names are postfixed with type of clock.
600 if (j != (num_nodes - 1)) {
601 clk_out[j] = kasprintf(GFP_KERNEL, "%s%s", clk_name,
602 clk_type_postfix[nodes[j].type]);
604 clk_out[j] = kasprintf(GFP_KERNEL, "%s", clk_name);
607 if (!clk_topology[nodes[j].type])
610 hw = (*clk_topology[nodes[j].type])(clk_out[j], clk_dev_id,
615 pr_warn_once("%s() 0x%x: %s register fail with %ld\n",
616 __func__, clk_dev_id, clk_name,
619 parent_names[0] = clk_out[j];
622 for (j = 0; j < num_nodes; j++)
629 * zynqmp_register_clocks() - Register clocks
632 * Return: 0 on success else error code
634 static int zynqmp_register_clocks(struct device_node *np)
637 u32 i, total_parents = 0, type = 0;
638 const char *parent_names[MAX_PARENT];
640 for (i = 0; i < clock_max_idx; i++) {
641 char clk_name[MAX_NAME_LEN];
643 /* get clock name, continue to next clock if name not found */
644 if (zynqmp_get_clock_name(i, clk_name))
647 /* Check if clock is valid and output clock.
648 * Do not register invalid or external clock.
650 ret = zynqmp_get_clock_type(i, &type);
651 if (ret || type != CLK_TYPE_OUTPUT)
654 /* Get parents of clock*/
655 if (zynqmp_get_parent_list(np, i, parent_names,
657 WARN_ONCE(1, "No parents found for %s\n",
662 zynqmp_data->hws[i] =
663 zynqmp_register_clk_topology(i, clk_name,
668 for (i = 0; i < clock_max_idx; i++) {
669 if (IS_ERR(zynqmp_data->hws[i])) {
670 pr_err("Zynq Ultrascale+ MPSoC clk %s: register failed with %ld\n",
671 clock[i].clk_name, PTR_ERR(zynqmp_data->hws[i]));
679 * zynqmp_get_clock_info() - Get clock information from firmware using PM_API
681 static void zynqmp_get_clock_info(void)
685 u32 nodetype, subclass, class;
686 struct attr_resp attr;
687 struct name_resp name;
689 for (i = 0; i < clock_max_idx; i++) {
690 ret = zynqmp_pm_clock_get_attributes(i, &attr);
694 clock[i].valid = FIELD_GET(CLK_ATTR_VALID, attr.attr[0]);
695 /* skip query for Invalid clock */
696 ret = zynqmp_is_valid_clock(i);
697 if (ret != CLK_ATTR_VALID)
700 clock[i].type = FIELD_GET(CLK_ATTR_TYPE, attr.attr[0]) ?
701 CLK_TYPE_EXTERNAL : CLK_TYPE_OUTPUT;
703 nodetype = FIELD_GET(CLK_ATTR_NODE_TYPE, attr.attr[0]);
704 subclass = FIELD_GET(CLK_ATTR_NODE_SUBCLASS, attr.attr[0]);
705 class = FIELD_GET(CLK_ATTR_NODE_CLASS, attr.attr[0]);
707 clock[i].clk_id = FIELD_PREP(CLK_ATTR_NODE_CLASS, class) |
708 FIELD_PREP(CLK_ATTR_NODE_SUBCLASS, subclass) |
709 FIELD_PREP(CLK_ATTR_NODE_TYPE, nodetype) |
710 FIELD_PREP(CLK_ATTR_NODE_INDEX, i);
712 zynqmp_pm_clock_get_name(clock[i].clk_id, &name);
713 if (!strcmp(name.name, RESERVED_CLK_NAME))
715 strncpy(clock[i].clk_name, name.name, MAX_NAME_LEN);
718 /* Get topology of all clock */
719 for (i = 0; i < clock_max_idx; i++) {
720 ret = zynqmp_get_clock_type(i, &type);
721 if (ret || type != CLK_TYPE_OUTPUT)
724 ret = zynqmp_clock_get_topology(i, clock[i].node,
725 &clock[i].num_nodes);
729 ret = zynqmp_clock_get_parents(i, clock[i].parent,
730 &clock[i].num_parents);
737 * zynqmp_clk_setup() - Setup the clock framework and register clocks
740 * Return: 0 on success else error code
742 static int zynqmp_clk_setup(struct device_node *np)
746 ret = zynqmp_pm_clock_get_num_clocks(&clock_max_idx);
750 zynqmp_data = kzalloc(struct_size(zynqmp_data, hws, clock_max_idx),
755 clock = kcalloc(clock_max_idx, sizeof(*clock), GFP_KERNEL);
761 zynqmp_get_clock_info();
762 zynqmp_register_clocks(np);
764 zynqmp_data->num = clock_max_idx;
765 return of_clk_add_hw_provider(np, of_clk_hw_onecell_get, zynqmp_data);
768 static int zynqmp_clock_probe(struct platform_device *pdev)
771 struct device *dev = &pdev->dev;
773 ret = zynqmp_clk_setup(dev->of_node);
778 static const struct of_device_id zynqmp_clock_of_match[] = {
779 {.compatible = "xlnx,zynqmp-clk"},
780 {.compatible = "xlnx,versal-clk"},
783 MODULE_DEVICE_TABLE(of, zynqmp_clock_of_match);
785 static struct platform_driver zynqmp_clock_driver = {
787 .name = "zynqmp_clock",
788 .of_match_table = zynqmp_clock_of_match,
790 .probe = zynqmp_clock_probe,
792 module_platform_driver(zynqmp_clock_driver);