2 * Generic OPP OF helpers
4 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/cpu.h>
17 #include <linux/errno.h>
18 #include <linux/device.h>
19 #include <linux/of_device.h>
20 #include <linux/pm_domain.h>
21 #include <linux/slab.h>
22 #include <linux/export.h>
26 static struct opp_table
*_managed_opp(const struct device_node
*np
)
28 struct opp_table
*opp_table
, *managed_table
= NULL
;
30 mutex_lock(&opp_table_lock
);
32 list_for_each_entry(opp_table
, &opp_tables
, node
) {
33 if (opp_table
->np
== np
) {
35 * Multiple devices can point to the same OPP table and
36 * so will have same node-pointer, np.
38 * But the OPPs will be considered as shared only if the
39 * OPP table contains a "opp-shared" property.
41 if (opp_table
->shared_opp
== OPP_TABLE_ACCESS_SHARED
) {
42 _get_opp_table_kref(opp_table
);
43 managed_table
= opp_table
;
50 mutex_unlock(&opp_table_lock
);
55 void _of_init_opp_table(struct opp_table
*opp_table
, struct device
*dev
)
57 struct device_node
*np
;
60 * Only required for backward compatibility with v1 bindings, but isn't
61 * harmful for other cases. And so we do it unconditionally.
63 np
= of_node_get(dev
->of_node
);
67 if (!of_property_read_u32(np
, "clock-latency", &val
))
68 opp_table
->clock_latency_ns_max
= val
;
69 of_property_read_u32(np
, "voltage-tolerance",
70 &opp_table
->voltage_tolerance_v1
);
75 static bool _opp_is_supported(struct device
*dev
, struct opp_table
*opp_table
,
76 struct device_node
*np
)
78 unsigned int count
= opp_table
->supported_hw_count
;
82 if (!opp_table
->supported_hw
) {
84 * In the case that no supported_hw has been set by the
85 * platform but there is an opp-supported-hw value set for
86 * an OPP then the OPP should not be enabled as there is
87 * no way to see if the hardware supports it.
89 if (of_find_property(np
, "opp-supported-hw", NULL
))
96 ret
= of_property_read_u32_index(np
, "opp-supported-hw", count
,
99 dev_warn(dev
, "%s: failed to read opp-supported-hw property at index %d: %d\n",
100 __func__
, count
, ret
);
104 /* Both of these are bitwise masks of the versions */
105 if (!(version
& opp_table
->supported_hw
[count
]))
112 static int opp_parse_supplies(struct dev_pm_opp
*opp
, struct device
*dev
,
113 struct opp_table
*opp_table
)
115 u32
*microvolt
, *microamp
= NULL
;
116 int supplies
= opp_table
->regulator_count
, vcount
, icount
, ret
, i
, j
;
117 struct property
*prop
= NULL
;
120 /* Search for "opp-microvolt-<name>" */
121 if (opp_table
->prop_name
) {
122 snprintf(name
, sizeof(name
), "opp-microvolt-%s",
123 opp_table
->prop_name
);
124 prop
= of_find_property(opp
->np
, name
, NULL
);
128 /* Search for "opp-microvolt" */
129 sprintf(name
, "opp-microvolt");
130 prop
= of_find_property(opp
->np
, name
, NULL
);
132 /* Missing property isn't a problem, but an invalid entry is */
134 if (unlikely(supplies
== -1)) {
135 /* Initialize regulator_count */
136 opp_table
->regulator_count
= 0;
143 dev_err(dev
, "%s: opp-microvolt missing although OPP managing regulators\n",
149 if (unlikely(supplies
== -1)) {
150 /* Initialize regulator_count */
151 supplies
= opp_table
->regulator_count
= 1;
152 } else if (unlikely(!supplies
)) {
153 dev_err(dev
, "%s: opp-microvolt wasn't expected\n", __func__
);
157 vcount
= of_property_count_u32_elems(opp
->np
, name
);
159 dev_err(dev
, "%s: Invalid %s property (%d)\n",
160 __func__
, name
, vcount
);
164 /* There can be one or three elements per supply */
165 if (vcount
!= supplies
&& vcount
!= supplies
* 3) {
166 dev_err(dev
, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
167 __func__
, name
, vcount
, supplies
);
171 microvolt
= kmalloc_array(vcount
, sizeof(*microvolt
), GFP_KERNEL
);
175 ret
= of_property_read_u32_array(opp
->np
, name
, microvolt
, vcount
);
177 dev_err(dev
, "%s: error parsing %s: %d\n", __func__
, name
, ret
);
182 /* Search for "opp-microamp-<name>" */
184 if (opp_table
->prop_name
) {
185 snprintf(name
, sizeof(name
), "opp-microamp-%s",
186 opp_table
->prop_name
);
187 prop
= of_find_property(opp
->np
, name
, NULL
);
191 /* Search for "opp-microamp" */
192 sprintf(name
, "opp-microamp");
193 prop
= of_find_property(opp
->np
, name
, NULL
);
197 icount
= of_property_count_u32_elems(opp
->np
, name
);
199 dev_err(dev
, "%s: Invalid %s property (%d)\n", __func__
,
205 if (icount
!= supplies
) {
206 dev_err(dev
, "%s: Invalid number of elements in %s property (%d) with supplies (%d)\n",
207 __func__
, name
, icount
, supplies
);
212 microamp
= kmalloc_array(icount
, sizeof(*microamp
), GFP_KERNEL
);
218 ret
= of_property_read_u32_array(opp
->np
, name
, microamp
,
221 dev_err(dev
, "%s: error parsing %s: %d\n", __func__
,
228 for (i
= 0, j
= 0; i
< supplies
; i
++) {
229 opp
->supplies
[i
].u_volt
= microvolt
[j
++];
231 if (vcount
== supplies
) {
232 opp
->supplies
[i
].u_volt_min
= opp
->supplies
[i
].u_volt
;
233 opp
->supplies
[i
].u_volt_max
= opp
->supplies
[i
].u_volt
;
235 opp
->supplies
[i
].u_volt_min
= microvolt
[j
++];
236 opp
->supplies
[i
].u_volt_max
= microvolt
[j
++];
240 opp
->supplies
[i
].u_amp
= microamp
[i
];
252 * dev_pm_opp_of_remove_table() - Free OPP table entries created from static DT
254 * @dev: device pointer used to lookup OPP table.
256 * Free OPPs created using static entries present in DT.
258 void dev_pm_opp_of_remove_table(struct device
*dev
)
260 _dev_pm_opp_find_and_remove_table(dev
, false);
262 EXPORT_SYMBOL_GPL(dev_pm_opp_of_remove_table
);
264 /* Returns opp descriptor node for a device node, caller must
265 * do of_node_put() */
266 static struct device_node
*_opp_of_get_opp_desc_node(struct device_node
*np
,
269 /* "operating-points-v2" can be an array for power domain providers */
270 return of_parse_phandle(np
, "operating-points-v2", index
);
273 /* Returns opp descriptor node for a device, caller must do of_node_put() */
274 struct device_node
*dev_pm_opp_of_get_opp_desc_node(struct device
*dev
)
276 return _opp_of_get_opp_desc_node(dev
->of_node
, 0);
278 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_opp_desc_node
);
281 * _opp_add_static_v2() - Allocate static OPPs (As per 'v2' DT bindings)
282 * @opp_table: OPP table
283 * @dev: device for which we do this operation
286 * This function adds an opp definition to the opp table and returns status. The
287 * opp can be controlled using dev_pm_opp_enable/disable functions and may be
288 * removed by dev_pm_opp_remove.
292 * Duplicate OPPs (both freq and volt are same) and opp->available
293 * -EEXIST Freq are same and volt are different OR
294 * Duplicate OPPs (both freq and volt are same) and !opp->available
295 * -ENOMEM Memory allocation failure
296 * -EINVAL Failed parsing the OPP node
298 static int _opp_add_static_v2(struct opp_table
*opp_table
, struct device
*dev
,
299 struct device_node
*np
)
301 struct dev_pm_opp
*new_opp
;
305 bool rate_not_available
= false;
307 new_opp
= _opp_allocate(opp_table
);
311 ret
= of_property_read_u64(np
, "opp-hz", &rate
);
313 /* "opp-hz" is optional for devices like power domains. */
314 if (!of_find_property(dev
->of_node
, "#power-domain-cells",
316 dev_err(dev
, "%s: opp-hz not found\n", __func__
);
320 rate_not_available
= true;
323 * Rate is defined as an unsigned long in clk API, and so
324 * casting explicitly to its type. Must be fixed once rate is 64
325 * bit guaranteed in clk API.
327 new_opp
->rate
= (unsigned long)rate
;
330 /* Check if the OPP supports hardware's hierarchy of versions or not */
331 if (!_opp_is_supported(dev
, opp_table
, np
)) {
332 dev_dbg(dev
, "OPP not supported by hardware: %llu\n", rate
);
336 new_opp
->turbo
= of_property_read_bool(np
, "turbo-mode");
339 new_opp
->dynamic
= false;
340 new_opp
->available
= true;
342 if (!of_property_read_u32(np
, "clock-latency-ns", &val
))
343 new_opp
->clock_latency_ns
= val
;
345 new_opp
->pstate
= of_genpd_opp_to_performance_state(dev
, np
);
347 ret
= opp_parse_supplies(new_opp
, dev
, opp_table
);
351 ret
= _opp_add(dev
, new_opp
, opp_table
, rate_not_available
);
353 /* Don't return error for duplicate OPPs */
359 /* OPP to select on device suspend */
360 if (of_property_read_bool(np
, "opp-suspend")) {
361 if (opp_table
->suspend_opp
) {
362 dev_warn(dev
, "%s: Multiple suspend OPPs found (%lu %lu)\n",
363 __func__
, opp_table
->suspend_opp
->rate
,
366 new_opp
->suspend
= true;
367 opp_table
->suspend_opp
= new_opp
;
371 if (new_opp
->clock_latency_ns
> opp_table
->clock_latency_ns_max
)
372 opp_table
->clock_latency_ns_max
= new_opp
->clock_latency_ns
;
374 pr_debug("%s: turbo:%d rate:%lu uv:%lu uvmin:%lu uvmax:%lu latency:%lu\n",
375 __func__
, new_opp
->turbo
, new_opp
->rate
,
376 new_opp
->supplies
[0].u_volt
, new_opp
->supplies
[0].u_volt_min
,
377 new_opp
->supplies
[0].u_volt_max
, new_opp
->clock_latency_ns
);
380 * Notify the changes in the availability of the operable
381 * frequency/voltage list.
383 blocking_notifier_call_chain(&opp_table
->head
, OPP_EVENT_ADD
, new_opp
);
392 /* Initializes OPP tables based on new bindings */
393 static int _of_add_opp_table_v2(struct device
*dev
, struct device_node
*opp_np
)
395 struct device_node
*np
;
396 struct opp_table
*opp_table
;
397 int ret
= 0, count
= 0, pstate_count
= 0;
398 struct dev_pm_opp
*opp
;
400 opp_table
= _managed_opp(opp_np
);
402 /* OPPs are already managed */
403 if (!_add_opp_dev(dev
, opp_table
))
408 opp_table
= dev_pm_opp_get_opp_table(dev
);
412 /* We have opp-table node now, iterate over it and add OPPs */
413 for_each_available_child_of_node(opp_np
, np
) {
416 ret
= _opp_add_static_v2(opp_table
, dev
, np
);
418 dev_err(dev
, "%s: Failed to add OPP, %d\n", __func__
,
420 _dev_pm_opp_remove_table(opp_table
, dev
, false);
426 /* There should be one of more OPP defined */
427 if (WARN_ON(!count
)) {
432 list_for_each_entry(opp
, &opp_table
->opp_list
, node
)
433 pstate_count
+= !!opp
->pstate
;
435 /* Either all or none of the nodes shall have performance state set */
436 if (pstate_count
&& pstate_count
!= count
) {
437 dev_err(dev
, "Not all nodes have performance state set (%d: %d)\n",
438 count
, pstate_count
);
440 _dev_pm_opp_remove_table(opp_table
, dev
, false);
445 opp_table
->genpd_performance_state
= true;
447 opp_table
->np
= opp_np
;
448 if (of_property_read_bool(opp_np
, "opp-shared"))
449 opp_table
->shared_opp
= OPP_TABLE_ACCESS_SHARED
;
451 opp_table
->shared_opp
= OPP_TABLE_ACCESS_EXCLUSIVE
;
454 dev_pm_opp_put_opp_table(opp_table
);
459 /* Initializes OPP tables based on old-deprecated bindings */
460 static int _of_add_opp_table_v1(struct device
*dev
)
462 struct opp_table
*opp_table
;
463 const struct property
*prop
;
467 prop
= of_find_property(dev
->of_node
, "operating-points", NULL
);
474 * Each OPP is a set of tuples consisting of frequency and
475 * voltage like <freq-kHz vol-uV>.
477 nr
= prop
->length
/ sizeof(u32
);
479 dev_err(dev
, "%s: Invalid OPP table\n", __func__
);
483 opp_table
= dev_pm_opp_get_opp_table(dev
);
489 unsigned long freq
= be32_to_cpup(val
++) * 1000;
490 unsigned long volt
= be32_to_cpup(val
++);
492 ret
= _opp_add_v1(opp_table
, dev
, freq
, volt
, false);
494 dev_err(dev
, "%s: Failed to add OPP %ld (%d)\n",
495 __func__
, freq
, ret
);
496 _dev_pm_opp_remove_table(opp_table
, dev
, false);
502 dev_pm_opp_put_opp_table(opp_table
);
507 * dev_pm_opp_of_add_table() - Initialize opp table from device tree
508 * @dev: device pointer used to lookup OPP table.
510 * Register the initial OPP table with the OPP library for given device.
514 * Duplicate OPPs (both freq and volt are same) and opp->available
515 * -EEXIST Freq are same and volt are different OR
516 * Duplicate OPPs (both freq and volt are same) and !opp->available
517 * -ENOMEM Memory allocation failure
518 * -ENODEV when 'operating-points' property is not found or is invalid data
520 * -ENODATA when empty 'operating-points' property is found
521 * -EINVAL when invalid entries are found in opp-v2 table
523 int dev_pm_opp_of_add_table(struct device
*dev
)
525 struct device_node
*opp_np
;
529 * OPPs have two version of bindings now. The older one is deprecated,
530 * try for the new binding first.
532 opp_np
= dev_pm_opp_of_get_opp_desc_node(dev
);
535 * Try old-deprecated bindings for backward compatibility with
538 return _of_add_opp_table_v1(dev
);
541 ret
= _of_add_opp_table_v2(dev
, opp_np
);
546 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table
);
549 * dev_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
550 * @dev: device pointer used to lookup OPP table.
551 * @index: Index number.
553 * Register the initial OPP table with the OPP library for given device only
554 * using the "operating-points-v2" property.
558 * Duplicate OPPs (both freq and volt are same) and opp->available
559 * -EEXIST Freq are same and volt are different OR
560 * Duplicate OPPs (both freq and volt are same) and !opp->available
561 * -ENOMEM Memory allocation failure
562 * -ENODEV when 'operating-points' property is not found or is invalid data
564 * -ENODATA when empty 'operating-points' property is found
565 * -EINVAL when invalid entries are found in opp-v2 table
567 int dev_pm_opp_of_add_table_indexed(struct device
*dev
, int index
)
569 struct device_node
*opp_np
;
573 opp_np
= _opp_of_get_opp_desc_node(dev
->of_node
, index
);
576 * If only one phandle is present, then the same OPP table
577 * applies for all index requests.
579 count
= of_count_phandle_with_args(dev
->of_node
,
580 "operating-points-v2", NULL
);
581 if (count
== 1 && index
) {
589 ret
= _of_add_opp_table_v2(dev
, opp_np
);
594 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table_indexed
);
596 /* CPU device specific helpers */
599 * dev_pm_opp_of_cpumask_remove_table() - Removes OPP table for @cpumask
600 * @cpumask: cpumask for which OPP table needs to be removed
602 * This removes the OPP tables for CPUs present in the @cpumask.
603 * This should be used only to remove static entries created from DT.
605 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask
*cpumask
)
607 _dev_pm_opp_cpumask_remove_table(cpumask
, true);
609 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_remove_table
);
612 * dev_pm_opp_of_cpumask_add_table() - Adds OPP table for @cpumask
613 * @cpumask: cpumask for which OPP table needs to be added.
615 * This adds the OPP tables for CPUs present in the @cpumask.
617 int dev_pm_opp_of_cpumask_add_table(const struct cpumask
*cpumask
)
619 struct device
*cpu_dev
;
622 WARN_ON(cpumask_empty(cpumask
));
624 for_each_cpu(cpu
, cpumask
) {
625 cpu_dev
= get_cpu_device(cpu
);
627 pr_err("%s: failed to get cpu%d device\n", __func__
,
632 ret
= dev_pm_opp_of_add_table(cpu_dev
);
635 * OPP may get registered dynamically, don't print error
638 pr_debug("%s: couldn't find opp table for cpu:%d, %d\n",
641 /* Free all other OPPs */
642 dev_pm_opp_of_cpumask_remove_table(cpumask
);
649 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_add_table
);
652 * Works only for OPP v2 bindings.
654 * Returns -ENOENT if operating-points-v2 bindings aren't supported.
657 * dev_pm_opp_of_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with
658 * @cpu_dev using operating-points-v2
661 * @cpu_dev: CPU device for which we do this operation
662 * @cpumask: cpumask to update with information of sharing CPUs
664 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
666 * Returns -ENOENT if operating-points-v2 isn't present for @cpu_dev.
668 int dev_pm_opp_of_get_sharing_cpus(struct device
*cpu_dev
,
669 struct cpumask
*cpumask
)
671 struct device_node
*np
, *tmp_np
, *cpu_np
;
674 /* Get OPP descriptor node */
675 np
= dev_pm_opp_of_get_opp_desc_node(cpu_dev
);
677 dev_dbg(cpu_dev
, "%s: Couldn't find opp node.\n", __func__
);
681 cpumask_set_cpu(cpu_dev
->id
, cpumask
);
683 /* OPPs are shared ? */
684 if (!of_property_read_bool(np
, "opp-shared"))
687 for_each_possible_cpu(cpu
) {
688 if (cpu
== cpu_dev
->id
)
691 cpu_np
= of_cpu_device_node_get(cpu
);
693 dev_err(cpu_dev
, "%s: failed to get cpu%d node\n",
699 /* Get OPP descriptor node */
700 tmp_np
= _opp_of_get_opp_desc_node(cpu_np
, 0);
703 pr_err("%pOF: Couldn't find opp node\n", cpu_np
);
708 /* CPUs are sharing opp node */
710 cpumask_set_cpu(cpu
, cpumask
);
719 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_sharing_cpus
);
722 * of_dev_pm_opp_find_required_opp() - Search for required OPP.
723 * @dev: The device whose OPP node is referenced by the 'np' DT node.
724 * @np: Node that contains the "required-opps" property.
726 * Returns the OPP of the device 'dev', whose phandle is present in the "np"
727 * node. Although the "required-opps" property supports having multiple
728 * phandles, this helper routine only parses the very first phandle in the list.
730 * Return: Matching opp, else returns ERR_PTR in case of error and should be
731 * handled using IS_ERR.
733 * The callers are required to call dev_pm_opp_put() for the returned OPP after
736 struct dev_pm_opp
*of_dev_pm_opp_find_required_opp(struct device
*dev
,
737 struct device_node
*np
)
739 struct dev_pm_opp
*temp_opp
, *opp
= ERR_PTR(-ENODEV
);
740 struct device_node
*required_np
;
741 struct opp_table
*opp_table
;
743 opp_table
= _find_opp_table(dev
);
744 if (IS_ERR(opp_table
))
745 return ERR_CAST(opp_table
);
747 required_np
= of_parse_phandle(np
, "required-opps", 0);
748 if (unlikely(!required_np
)) {
749 dev_err(dev
, "Unable to parse required-opps\n");
753 mutex_lock(&opp_table
->lock
);
755 list_for_each_entry(temp_opp
, &opp_table
->opp_list
, node
) {
756 if (temp_opp
->available
&& temp_opp
->np
== required_np
) {
759 /* Increment the reference count of OPP */
765 mutex_unlock(&opp_table
->lock
);
767 of_node_put(required_np
);
769 dev_pm_opp_put_opp_table(opp_table
);
773 EXPORT_SYMBOL_GPL(of_dev_pm_opp_find_required_opp
);
776 * dev_pm_opp_get_of_node() - Gets the DT node corresponding to an opp
777 * @opp: opp for which DT node has to be returned for
779 * Return: DT node corresponding to the opp, else 0 on success.
781 * The caller needs to put the node with of_node_put() after using it.
783 struct device_node
*dev_pm_opp_get_of_node(struct dev_pm_opp
*opp
)
785 if (IS_ERR_OR_NULL(opp
)) {
786 pr_err("%s: Invalid parameters\n", __func__
);
790 return of_node_get(opp
->np
);
792 EXPORT_SYMBOL_GPL(dev_pm_opp_get_of_node
);