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
));
275 * zynqmp_clk_register_fixed_factor() - Register fixed factor with the
277 * @name: Name of this clock
279 * @parents: Name of this clock's parents
280 * @num_parents: Number of parents
281 * @nodes: Clock topology node
283 * Return: clock hardware to the registered clock
285 struct clk_hw
*zynqmp_clk_register_fixed_factor(const char *name
, u32 clk_id
,
286 const char * const *parents
,
288 const struct clock_topology
*nodes
)
292 struct zynqmp_pm_query_data qdata
= {0};
293 u32 ret_payload
[PAYLOAD_ARG_CNT
];
296 qdata
.qid
= PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS
;
299 ret
= zynqmp_pm_query_data(qdata
, ret_payload
);
303 mult
= ret_payload
[1];
304 div
= ret_payload
[2];
306 hw
= clk_hw_register_fixed_factor(NULL
, name
,
315 * zynqmp_pm_clock_get_parents() - Get the first 3 parents of clock for given id
316 * @clock_id: Clock ID
317 * @index: Parent index
318 * @response: Parents of the given clock
320 * This function is used to get 3 parents for the clock specified by
323 * This API will return 3 parents with a single response. To get
324 * other parents, master should call same API in loop with new
325 * parent index till error is returned. E.g First call should have
326 * index 0 which will return parents 0,1 and 2. Next call, index
327 * should be 3 which will return parent 3,4 and 5 and so on.
329 * Return: 0 on success else error+reason
331 static int zynqmp_pm_clock_get_parents(u32 clock_id
, u32 index
,
332 struct parents_resp
*response
)
334 struct zynqmp_pm_query_data qdata
= {0};
335 u32 ret_payload
[PAYLOAD_ARG_CNT
];
338 qdata
.qid
= PM_QID_CLOCK_GET_PARENTS
;
339 qdata
.arg1
= clock_id
;
342 ret
= zynqmp_pm_query_data(qdata
, ret_payload
);
343 memcpy(response
, &ret_payload
[1], sizeof(*response
));
349 * zynqmp_pm_clock_get_attributes() - Get the attributes of clock for given id
350 * @clock_id: Clock ID
351 * @response: Clock attributes response
353 * This function is used to get clock's attributes(e.g. valid, clock type, etc).
355 * Return: 0 on success else error+reason
357 static int zynqmp_pm_clock_get_attributes(u32 clock_id
,
358 struct attr_resp
*response
)
360 struct zynqmp_pm_query_data qdata
= {0};
361 u32 ret_payload
[PAYLOAD_ARG_CNT
];
364 qdata
.qid
= PM_QID_CLOCK_GET_ATTRIBUTES
;
365 qdata
.arg1
= clock_id
;
367 ret
= zynqmp_pm_query_data(qdata
, ret_payload
);
368 memcpy(response
, &ret_payload
[1], sizeof(*response
));
374 * __zynqmp_clock_get_topology() - Get topology data of clock from firmware
376 * @topology: Clock topology
377 * @response: Clock topology data received from firmware
378 * @nnodes: Number of nodes
380 * Return: 0 on success else error+reason
382 static int __zynqmp_clock_get_topology(struct clock_topology
*topology
,
383 struct topology_resp
*response
,
389 for (i
= 0; i
< ARRAY_SIZE(response
->topology
); i
++) {
390 type
= FIELD_GET(CLK_TOPOLOGY_TYPE
, response
->topology
[i
]);
391 if (type
== TYPE_INVALID
)
392 return END_OF_TOPOLOGY_NODE
;
393 topology
[*nnodes
].type
= type
;
394 topology
[*nnodes
].flag
= FIELD_GET(CLK_TOPOLOGY_FLAGS
,
395 response
->topology
[i
]);
396 topology
[*nnodes
].type_flag
=
397 FIELD_GET(CLK_TOPOLOGY_TYPE_FLAGS
,
398 response
->topology
[i
]);
399 topology
[*nnodes
].custom_type_flag
=
400 FIELD_GET(CLK_TOPOLOGY_CUSTOM_TYPE_FLAGS
,
401 response
->topology
[i
]);
409 * zynqmp_clock_get_topology() - Get topology of clock from firmware using
411 * @clk_id: Clock index
412 * @topology: Clock topology
413 * @num_nodes: Number of nodes
415 * Return: 0 on success else error+reason
417 static int zynqmp_clock_get_topology(u32 clk_id
,
418 struct clock_topology
*topology
,
422 struct topology_resp response
= { };
425 for (j
= 0; j
<= MAX_NODES
; j
+= ARRAY_SIZE(response
.topology
)) {
426 ret
= zynqmp_pm_clock_get_topology(clock
[clk_id
].clk_id
, j
,
430 ret
= __zynqmp_clock_get_topology(topology
, &response
,
432 if (ret
== END_OF_TOPOLOGY_NODE
)
440 * __zynqmp_clock_get_parents() - Get parents info of clock from firmware
442 * @parents: Clock parents
443 * @response: Clock parents data received from firmware
444 * @nparent: Number of parent
446 * Return: 0 on success else error+reason
448 static int __zynqmp_clock_get_parents(struct clock_parent
*parents
,
449 struct parents_resp
*response
,
453 struct clock_parent
*parent
;
455 for (i
= 0; i
< ARRAY_SIZE(response
->parents
); i
++) {
456 if (response
->parents
[i
] == NA_PARENT
)
457 return END_OF_PARENTS
;
459 parent
= &parents
[i
];
460 parent
->id
= FIELD_GET(CLK_PARENTS_ID
, response
->parents
[i
]);
461 if (response
->parents
[i
] == DUMMY_PARENT
) {
462 strcpy(parent
->name
, "dummy_name");
465 parent
->flag
= FIELD_GET(CLK_PARENTS_FLAGS
,
466 response
->parents
[i
]);
467 if (zynqmp_get_clock_name(parent
->id
, parent
->name
))
477 * zynqmp_clock_get_parents() - Get parents info from firmware using PM_API
478 * @clk_id: Clock index
479 * @parents: Clock parents
480 * @num_parents: Total number of parents
482 * Return: 0 on success else error+reason
484 static int zynqmp_clock_get_parents(u32 clk_id
, struct clock_parent
*parents
,
488 struct parents_resp response
= { };
492 /* Get parents from firmware */
493 ret
= zynqmp_pm_clock_get_parents(clock
[clk_id
].clk_id
, j
,
498 ret
= __zynqmp_clock_get_parents(&parents
[j
], &response
,
500 if (ret
== END_OF_PARENTS
)
502 j
+= ARRAY_SIZE(response
.parents
);
503 } while (*num_parents
<= MAX_PARENT
);
509 * zynqmp_get_parent_list() - Create list of parents name
511 * @clk_id: Clock index
512 * @parent_list: List of parent's name
513 * @num_parents: Total number of parents
515 * Return: 0 on success else error+reason
517 static int zynqmp_get_parent_list(struct device_node
*np
, u32 clk_id
,
518 const char **parent_list
, u32
*num_parents
)
521 u32 total_parents
= clock
[clk_id
].num_parents
;
522 struct clock_topology
*clk_nodes
;
523 struct clock_parent
*parents
;
525 clk_nodes
= clock
[clk_id
].node
;
526 parents
= clock
[clk_id
].parent
;
528 for (i
= 0; i
< total_parents
; i
++) {
529 if (!parents
[i
].flag
) {
530 parent_list
[i
] = parents
[i
].name
;
531 } else if (parents
[i
].flag
== PARENT_CLK_EXTERNAL
) {
532 ret
= of_property_match_string(np
, "clock-names",
535 strcpy(parents
[i
].name
, "dummy_name");
536 parent_list
[i
] = parents
[i
].name
;
538 strcat(parents
[i
].name
,
539 clk_type_postfix
[clk_nodes
[parents
[i
].flag
- 1].
541 parent_list
[i
] = parents
[i
].name
;
545 *num_parents
= total_parents
;
550 * zynqmp_register_clk_topology() - Register clock topology
551 * @clk_id: Clock index
552 * @clk_name: Clock Name
553 * @num_parents: Total number of parents
554 * @parent_names: List of parents name
556 * Return: Returns either clock hardware or error+reason
558 static struct clk_hw
*zynqmp_register_clk_topology(int clk_id
, char *clk_name
,
560 const char **parent_names
)
563 u32 num_nodes
, clk_dev_id
;
564 char *clk_out
[MAX_NODES
];
565 struct clock_topology
*nodes
;
566 struct clk_hw
*hw
= NULL
;
568 nodes
= clock
[clk_id
].node
;
569 num_nodes
= clock
[clk_id
].num_nodes
;
570 clk_dev_id
= clock
[clk_id
].clk_id
;
572 for (j
= 0; j
< num_nodes
; j
++) {
574 * Clock name received from firmware is output clock name.
575 * Intermediate clock names are postfixed with type of clock.
577 if (j
!= (num_nodes
- 1)) {
578 clk_out
[j
] = kasprintf(GFP_KERNEL
, "%s%s", clk_name
,
579 clk_type_postfix
[nodes
[j
].type
]);
581 clk_out
[j
] = kasprintf(GFP_KERNEL
, "%s", clk_name
);
584 if (!clk_topology
[nodes
[j
].type
])
587 hw
= (*clk_topology
[nodes
[j
].type
])(clk_out
[j
], clk_dev_id
,
592 pr_warn_once("%s() 0x%x: %s register fail with %ld\n",
593 __func__
, clk_dev_id
, clk_name
,
596 parent_names
[0] = clk_out
[j
];
599 for (j
= 0; j
< num_nodes
; j
++)
606 * zynqmp_register_clocks() - Register clocks
609 * Return: 0 on success else error code
611 static int zynqmp_register_clocks(struct device_node
*np
)
614 u32 i
, total_parents
= 0, type
= 0;
615 const char *parent_names
[MAX_PARENT
];
617 for (i
= 0; i
< clock_max_idx
; i
++) {
618 char clk_name
[MAX_NAME_LEN
];
620 /* get clock name, continue to next clock if name not found */
621 if (zynqmp_get_clock_name(i
, clk_name
))
624 /* Check if clock is valid and output clock.
625 * Do not register invalid or external clock.
627 ret
= zynqmp_get_clock_type(i
, &type
);
628 if (ret
|| type
!= CLK_TYPE_OUTPUT
)
631 /* Get parents of clock*/
632 if (zynqmp_get_parent_list(np
, i
, parent_names
,
634 WARN_ONCE(1, "No parents found for %s\n",
639 zynqmp_data
->hws
[i
] =
640 zynqmp_register_clk_topology(i
, clk_name
,
645 for (i
= 0; i
< clock_max_idx
; i
++) {
646 if (IS_ERR(zynqmp_data
->hws
[i
])) {
647 pr_err("Zynq Ultrascale+ MPSoC clk %s: register failed with %ld\n",
648 clock
[i
].clk_name
, PTR_ERR(zynqmp_data
->hws
[i
]));
656 * zynqmp_get_clock_info() - Get clock information from firmware using PM_API
658 static void zynqmp_get_clock_info(void)
662 u32 nodetype
, subclass
, class;
663 struct attr_resp attr
;
664 struct name_resp name
;
666 for (i
= 0; i
< clock_max_idx
; i
++) {
667 ret
= zynqmp_pm_clock_get_attributes(i
, &attr
);
671 clock
[i
].valid
= FIELD_GET(CLK_ATTR_VALID
, attr
.attr
[0]);
672 /* skip query for Invalid clock */
673 ret
= zynqmp_is_valid_clock(i
);
674 if (ret
!= CLK_ATTR_VALID
)
677 clock
[i
].type
= FIELD_GET(CLK_ATTR_TYPE
, attr
.attr
[0]) ?
678 CLK_TYPE_EXTERNAL
: CLK_TYPE_OUTPUT
;
680 nodetype
= FIELD_GET(CLK_ATTR_NODE_TYPE
, attr
.attr
[0]);
681 subclass
= FIELD_GET(CLK_ATTR_NODE_SUBCLASS
, attr
.attr
[0]);
682 class = FIELD_GET(CLK_ATTR_NODE_CLASS
, attr
.attr
[0]);
684 clock
[i
].clk_id
= FIELD_PREP(CLK_ATTR_NODE_CLASS
, class) |
685 FIELD_PREP(CLK_ATTR_NODE_SUBCLASS
, subclass
) |
686 FIELD_PREP(CLK_ATTR_NODE_TYPE
, nodetype
) |
687 FIELD_PREP(CLK_ATTR_NODE_INDEX
, i
);
689 zynqmp_pm_clock_get_name(clock
[i
].clk_id
, &name
);
690 if (!strcmp(name
.name
, RESERVED_CLK_NAME
))
692 strncpy(clock
[i
].clk_name
, name
.name
, MAX_NAME_LEN
);
695 /* Get topology of all clock */
696 for (i
= 0; i
< clock_max_idx
; i
++) {
697 ret
= zynqmp_get_clock_type(i
, &type
);
698 if (ret
|| type
!= CLK_TYPE_OUTPUT
)
701 ret
= zynqmp_clock_get_topology(i
, clock
[i
].node
,
702 &clock
[i
].num_nodes
);
706 ret
= zynqmp_clock_get_parents(i
, clock
[i
].parent
,
707 &clock
[i
].num_parents
);
714 * zynqmp_clk_setup() - Setup the clock framework and register clocks
717 * Return: 0 on success else error code
719 static int zynqmp_clk_setup(struct device_node
*np
)
723 ret
= zynqmp_pm_clock_get_num_clocks(&clock_max_idx
);
727 zynqmp_data
= kzalloc(struct_size(zynqmp_data
, hws
, clock_max_idx
),
732 clock
= kcalloc(clock_max_idx
, sizeof(*clock
), GFP_KERNEL
);
738 zynqmp_get_clock_info();
739 zynqmp_register_clocks(np
);
741 zynqmp_data
->num
= clock_max_idx
;
742 of_clk_add_hw_provider(np
, of_clk_hw_onecell_get
, zynqmp_data
);
747 static int zynqmp_clock_probe(struct platform_device
*pdev
)
750 struct device
*dev
= &pdev
->dev
;
752 ret
= zynqmp_clk_setup(dev
->of_node
);
757 static const struct of_device_id zynqmp_clock_of_match
[] = {
758 {.compatible
= "xlnx,zynqmp-clk"},
759 {.compatible
= "xlnx,versal-clk"},
762 MODULE_DEVICE_TABLE(of
, zynqmp_clock_of_match
);
764 static struct platform_driver zynqmp_clock_driver
= {
766 .name
= "zynqmp_clock",
767 .of_match_table
= zynqmp_clock_of_match
,
769 .probe
= zynqmp_clock_probe
,
771 module_platform_driver(zynqmp_clock_driver
);