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 or more OPPs defined */
428 dev_err(dev, "%s: no supported OPPs", __func__);
433 list_for_each_entry(opp, &opp_table->opp_list, node)
434 pstate_count += !!opp->pstate;
436 /* Either all or none of the nodes shall have performance state set */
437 if (pstate_count && pstate_count != count) {
438 dev_err(dev, "Not all nodes have performance state set (%d: %d)\n",
439 count, pstate_count);
441 _dev_pm_opp_remove_table(opp_table, dev, false);
446 opp_table->genpd_performance_state = true;
448 opp_table->np = opp_np;
449 if (of_property_read_bool(opp_np, "opp-shared"))
450 opp_table->shared_opp = OPP_TABLE_ACCESS_SHARED;
452 opp_table->shared_opp = OPP_TABLE_ACCESS_EXCLUSIVE;
455 dev_pm_opp_put_opp_table(opp_table);
460 /* Initializes OPP tables based on old-deprecated bindings */
461 static int _of_add_opp_table_v1(struct device *dev)
463 struct opp_table *opp_table;
464 const struct property *prop;
468 prop = of_find_property(dev->of_node, "operating-points", NULL);
475 * Each OPP is a set of tuples consisting of frequency and
476 * voltage like <freq-kHz vol-uV>.
478 nr = prop->length / sizeof(u32);
480 dev_err(dev, "%s: Invalid OPP table\n", __func__);
484 opp_table = dev_pm_opp_get_opp_table(dev);
490 unsigned long freq = be32_to_cpup(val++) * 1000;
491 unsigned long volt = be32_to_cpup(val++);
493 ret = _opp_add_v1(opp_table, dev, freq, volt, false);
495 dev_err(dev, "%s: Failed to add OPP %ld (%d)\n",
496 __func__, freq, ret);
497 _dev_pm_opp_remove_table(opp_table, dev, false);
503 dev_pm_opp_put_opp_table(opp_table);
508 * dev_pm_opp_of_add_table() - Initialize opp table from device tree
509 * @dev: device pointer used to lookup OPP table.
511 * Register the initial OPP table with the OPP library for given device.
515 * Duplicate OPPs (both freq and volt are same) and opp->available
516 * -EEXIST Freq are same and volt are different OR
517 * Duplicate OPPs (both freq and volt are same) and !opp->available
518 * -ENOMEM Memory allocation failure
519 * -ENODEV when 'operating-points' property is not found or is invalid data
521 * -ENODATA when empty 'operating-points' property is found
522 * -EINVAL when invalid entries are found in opp-v2 table
524 int dev_pm_opp_of_add_table(struct device *dev)
526 struct device_node *opp_np;
530 * OPPs have two version of bindings now. The older one is deprecated,
531 * try for the new binding first.
533 opp_np = dev_pm_opp_of_get_opp_desc_node(dev);
536 * Try old-deprecated bindings for backward compatibility with
539 return _of_add_opp_table_v1(dev);
542 ret = _of_add_opp_table_v2(dev, opp_np);
547 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table);
550 * dev_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
551 * @dev: device pointer used to lookup OPP table.
552 * @index: Index number.
554 * Register the initial OPP table with the OPP library for given device only
555 * using the "operating-points-v2" property.
559 * Duplicate OPPs (both freq and volt are same) and opp->available
560 * -EEXIST Freq are same and volt are different OR
561 * Duplicate OPPs (both freq and volt are same) and !opp->available
562 * -ENOMEM Memory allocation failure
563 * -ENODEV when 'operating-points' property is not found or is invalid data
565 * -ENODATA when empty 'operating-points' property is found
566 * -EINVAL when invalid entries are found in opp-v2 table
568 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
570 struct device_node *opp_np;
574 opp_np = _opp_of_get_opp_desc_node(dev->of_node, index);
577 * If only one phandle is present, then the same OPP table
578 * applies for all index requests.
580 count = of_count_phandle_with_args(dev->of_node,
581 "operating-points-v2", NULL);
582 if (count == 1 && index) {
590 ret = _of_add_opp_table_v2(dev, opp_np);
595 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table_indexed);
597 /* CPU device specific helpers */
600 * dev_pm_opp_of_cpumask_remove_table() - Removes OPP table for @cpumask
601 * @cpumask: cpumask for which OPP table needs to be removed
603 * This removes the OPP tables for CPUs present in the @cpumask.
604 * This should be used only to remove static entries created from DT.
606 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
608 _dev_pm_opp_cpumask_remove_table(cpumask, true);
610 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_remove_table);
613 * dev_pm_opp_of_cpumask_add_table() - Adds OPP table for @cpumask
614 * @cpumask: cpumask for which OPP table needs to be added.
616 * This adds the OPP tables for CPUs present in the @cpumask.
618 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
620 struct device *cpu_dev;
623 WARN_ON(cpumask_empty(cpumask));
625 for_each_cpu(cpu, cpumask) {
626 cpu_dev = get_cpu_device(cpu);
628 pr_err("%s: failed to get cpu%d device\n", __func__,
633 ret = dev_pm_opp_of_add_table(cpu_dev);
636 * OPP may get registered dynamically, don't print error
639 pr_debug("%s: couldn't find opp table for cpu:%d, %d\n",
642 /* Free all other OPPs */
643 dev_pm_opp_of_cpumask_remove_table(cpumask);
650 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_add_table);
653 * Works only for OPP v2 bindings.
655 * Returns -ENOENT if operating-points-v2 bindings aren't supported.
658 * dev_pm_opp_of_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with
659 * @cpu_dev using operating-points-v2
662 * @cpu_dev: CPU device for which we do this operation
663 * @cpumask: cpumask to update with information of sharing CPUs
665 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
667 * Returns -ENOENT if operating-points-v2 isn't present for @cpu_dev.
669 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev,
670 struct cpumask *cpumask)
672 struct device_node *np, *tmp_np, *cpu_np;
675 /* Get OPP descriptor node */
676 np = dev_pm_opp_of_get_opp_desc_node(cpu_dev);
678 dev_dbg(cpu_dev, "%s: Couldn't find opp node.\n", __func__);
682 cpumask_set_cpu(cpu_dev->id, cpumask);
684 /* OPPs are shared ? */
685 if (!of_property_read_bool(np, "opp-shared"))
688 for_each_possible_cpu(cpu) {
689 if (cpu == cpu_dev->id)
692 cpu_np = of_cpu_device_node_get(cpu);
694 dev_err(cpu_dev, "%s: failed to get cpu%d node\n",
700 /* Get OPP descriptor node */
701 tmp_np = _opp_of_get_opp_desc_node(cpu_np, 0);
704 pr_err("%pOF: Couldn't find opp node\n", cpu_np);
709 /* CPUs are sharing opp node */
711 cpumask_set_cpu(cpu, cpumask);
720 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_sharing_cpus);
723 * of_dev_pm_opp_find_required_opp() - Search for required OPP.
724 * @dev: The device whose OPP node is referenced by the 'np' DT node.
725 * @np: Node that contains the "required-opps" property.
727 * Returns the OPP of the device 'dev', whose phandle is present in the "np"
728 * node. Although the "required-opps" property supports having multiple
729 * phandles, this helper routine only parses the very first phandle in the list.
731 * Return: Matching opp, else returns ERR_PTR in case of error and should be
732 * handled using IS_ERR.
734 * The callers are required to call dev_pm_opp_put() for the returned OPP after
737 struct dev_pm_opp *of_dev_pm_opp_find_required_opp(struct device *dev,
738 struct device_node *np)
740 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ENODEV);
741 struct device_node *required_np;
742 struct opp_table *opp_table;
744 opp_table = _find_opp_table(dev);
745 if (IS_ERR(opp_table))
746 return ERR_CAST(opp_table);
748 required_np = of_parse_phandle(np, "required-opps", 0);
749 if (unlikely(!required_np)) {
750 dev_err(dev, "Unable to parse required-opps\n");
754 mutex_lock(&opp_table->lock);
756 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
757 if (temp_opp->available && temp_opp->np == required_np) {
760 /* Increment the reference count of OPP */
766 mutex_unlock(&opp_table->lock);
768 of_node_put(required_np);
770 dev_pm_opp_put_opp_table(opp_table);
774 EXPORT_SYMBOL_GPL(of_dev_pm_opp_find_required_opp);
777 * dev_pm_opp_get_of_node() - Gets the DT node corresponding to an opp
778 * @opp: opp for which DT node has to be returned for
780 * Return: DT node corresponding to the opp, else 0 on success.
782 * The caller needs to put the node with of_node_put() after using it.
784 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
786 if (IS_ERR_OR_NULL(opp)) {
787 pr_err("%s: Invalid parameters\n", __func__);
791 return of_node_get(opp->np);
793 EXPORT_SYMBOL_GPL(dev_pm_opp_get_of_node);