1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic OPP OF helpers
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/cpu.h>
14 #include <linux/errno.h>
15 #include <linux/device.h>
16 #include <linux/of_device.h>
17 #include <linux/pm_domain.h>
18 #include <linux/slab.h>
19 #include <linux/export.h>
20 #include <linux/energy_model.h>
25 * Returns opp descriptor node for a device node, caller must
28 static struct device_node *_opp_of_get_opp_desc_node(struct device_node *np,
31 /* "operating-points-v2" can be an array for power domain providers */
32 return of_parse_phandle(np, "operating-points-v2", index);
35 /* Returns opp descriptor node for a device, caller must do of_node_put() */
36 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
38 return _opp_of_get_opp_desc_node(dev->of_node, 0);
40 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_opp_desc_node);
42 struct opp_table *_managed_opp(struct device *dev, int index)
44 struct opp_table *opp_table, *managed_table = NULL;
45 struct device_node *np;
47 np = _opp_of_get_opp_desc_node(dev->of_node, index);
51 list_for_each_entry(opp_table, &opp_tables, node) {
52 if (opp_table->np == np) {
54 * Multiple devices can point to the same OPP table and
55 * so will have same node-pointer, np.
57 * But the OPPs will be considered as shared only if the
58 * OPP table contains a "opp-shared" property.
60 if (opp_table->shared_opp == OPP_TABLE_ACCESS_SHARED) {
61 _get_opp_table_kref(opp_table);
62 managed_table = opp_table;
74 /* The caller must call dev_pm_opp_put() after the OPP is used */
75 static struct dev_pm_opp *_find_opp_of_np(struct opp_table *opp_table,
76 struct device_node *opp_np)
78 struct dev_pm_opp *opp;
80 mutex_lock(&opp_table->lock);
82 list_for_each_entry(opp, &opp_table->opp_list, node) {
83 if (opp->np == opp_np) {
85 mutex_unlock(&opp_table->lock);
90 mutex_unlock(&opp_table->lock);
95 static struct device_node *of_parse_required_opp(struct device_node *np,
98 return of_parse_phandle(np, "required-opps", index);
101 /* The caller must call dev_pm_opp_put_opp_table() after the table is used */
102 static struct opp_table *_find_table_of_opp_np(struct device_node *opp_np)
104 struct opp_table *opp_table;
105 struct device_node *opp_table_np;
107 opp_table_np = of_get_parent(opp_np);
111 /* It is safe to put the node now as all we need now is its address */
112 of_node_put(opp_table_np);
114 mutex_lock(&opp_table_lock);
115 list_for_each_entry(opp_table, &opp_tables, node) {
116 if (opp_table_np == opp_table->np) {
117 _get_opp_table_kref(opp_table);
118 mutex_unlock(&opp_table_lock);
122 mutex_unlock(&opp_table_lock);
125 return ERR_PTR(-ENODEV);
128 /* Free resources previously acquired by _opp_table_alloc_required_tables() */
129 static void _opp_table_free_required_tables(struct opp_table *opp_table)
131 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
134 if (!required_opp_tables)
137 for (i = 0; i < opp_table->required_opp_count; i++) {
138 if (IS_ERR_OR_NULL(required_opp_tables[i]))
141 dev_pm_opp_put_opp_table(required_opp_tables[i]);
144 kfree(required_opp_tables);
146 opp_table->required_opp_count = 0;
147 opp_table->required_opp_tables = NULL;
148 list_del(&opp_table->lazy);
152 * Populate all devices and opp tables which are part of "required-opps" list.
153 * Checking only the first OPP node should be enough.
155 static void _opp_table_alloc_required_tables(struct opp_table *opp_table,
157 struct device_node *opp_np)
159 struct opp_table **required_opp_tables;
160 struct device_node *required_np, *np;
164 /* Traversing the first OPP node is all we need */
165 np = of_get_next_available_child(opp_np, NULL);
167 dev_warn(dev, "Empty OPP table\n");
172 count = of_count_phandle_with_args(np, "required-opps", NULL);
176 required_opp_tables = kcalloc(count, sizeof(*required_opp_tables),
178 if (!required_opp_tables)
181 opp_table->required_opp_tables = required_opp_tables;
182 opp_table->required_opp_count = count;
184 for (i = 0; i < count; i++) {
185 required_np = of_parse_required_opp(np, i);
187 goto free_required_tables;
189 required_opp_tables[i] = _find_table_of_opp_np(required_np);
190 of_node_put(required_np);
192 if (IS_ERR(required_opp_tables[i]))
196 /* Let's do the linking later on */
198 list_add(&opp_table->lazy, &lazy_opp_tables);
202 free_required_tables:
203 _opp_table_free_required_tables(opp_table);
208 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev,
211 struct device_node *np, *opp_np;
215 * Only required for backward compatibility with v1 bindings, but isn't
216 * harmful for other cases. And so we do it unconditionally.
218 np = of_node_get(dev->of_node);
222 if (!of_property_read_u32(np, "clock-latency", &val))
223 opp_table->clock_latency_ns_max = val;
224 of_property_read_u32(np, "voltage-tolerance",
225 &opp_table->voltage_tolerance_v1);
227 if (of_find_property(np, "#power-domain-cells", NULL))
228 opp_table->is_genpd = true;
230 /* Get OPP table node */
231 opp_np = _opp_of_get_opp_desc_node(np, index);
237 if (of_property_read_bool(opp_np, "opp-shared"))
238 opp_table->shared_opp = OPP_TABLE_ACCESS_SHARED;
240 opp_table->shared_opp = OPP_TABLE_ACCESS_EXCLUSIVE;
242 opp_table->np = opp_np;
244 _opp_table_alloc_required_tables(opp_table, dev, opp_np);
247 void _of_clear_opp_table(struct opp_table *opp_table)
249 _opp_table_free_required_tables(opp_table);
250 of_node_put(opp_table->np);
254 * Release all resources previously acquired with a call to
255 * _of_opp_alloc_required_opps().
257 static void _of_opp_free_required_opps(struct opp_table *opp_table,
258 struct dev_pm_opp *opp)
260 struct dev_pm_opp **required_opps = opp->required_opps;
266 for (i = 0; i < opp_table->required_opp_count; i++) {
267 if (!required_opps[i])
270 /* Put the reference back */
271 dev_pm_opp_put(required_opps[i]);
274 opp->required_opps = NULL;
275 kfree(required_opps);
278 void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp)
280 _of_opp_free_required_opps(opp_table, opp);
281 of_node_put(opp->np);
284 /* Populate all required OPPs which are part of "required-opps" list */
285 static int _of_opp_alloc_required_opps(struct opp_table *opp_table,
286 struct dev_pm_opp *opp)
288 struct dev_pm_opp **required_opps;
289 struct opp_table *required_table;
290 struct device_node *np;
291 int i, ret, count = opp_table->required_opp_count;
296 required_opps = kcalloc(count, sizeof(*required_opps), GFP_KERNEL);
300 opp->required_opps = required_opps;
302 for (i = 0; i < count; i++) {
303 required_table = opp_table->required_opp_tables[i];
305 /* Required table not added yet, we will link later */
306 if (IS_ERR_OR_NULL(required_table))
309 np = of_parse_required_opp(opp->np, i);
312 goto free_required_opps;
315 required_opps[i] = _find_opp_of_np(required_table, np);
318 if (!required_opps[i]) {
319 pr_err("%s: Unable to find required OPP node: %pOF (%d)\n",
320 __func__, opp->np, i);
322 goto free_required_opps;
329 _of_opp_free_required_opps(opp_table, opp);
334 /* Link required OPPs for an individual OPP */
335 static int lazy_link_required_opps(struct opp_table *opp_table,
336 struct opp_table *new_table, int index)
338 struct device_node *required_np;
339 struct dev_pm_opp *opp;
341 list_for_each_entry(opp, &opp_table->opp_list, node) {
342 required_np = of_parse_required_opp(opp->np, index);
343 if (unlikely(!required_np))
346 opp->required_opps[index] = _find_opp_of_np(new_table, required_np);
347 of_node_put(required_np);
349 if (!opp->required_opps[index]) {
350 pr_err("%s: Unable to find required OPP node: %pOF (%d)\n",
351 __func__, opp->np, index);
359 /* Link required OPPs for all OPPs of the newly added OPP table */
360 static void lazy_link_required_opp_table(struct opp_table *new_table)
362 struct opp_table *opp_table, *temp, **required_opp_tables;
363 struct device_node *required_np, *opp_np, *required_table_np;
364 struct dev_pm_opp *opp;
367 mutex_lock(&opp_table_lock);
369 list_for_each_entry_safe(opp_table, temp, &lazy_opp_tables, lazy) {
372 /* opp_np can't be invalid here */
373 opp_np = of_get_next_available_child(opp_table->np, NULL);
375 for (i = 0; i < opp_table->required_opp_count; i++) {
376 required_opp_tables = opp_table->required_opp_tables;
378 /* Required opp-table is already parsed */
379 if (!IS_ERR(required_opp_tables[i]))
382 /* required_np can't be invalid here */
383 required_np = of_parse_required_opp(opp_np, i);
384 required_table_np = of_get_parent(required_np);
386 of_node_put(required_table_np);
387 of_node_put(required_np);
390 * Newly added table isn't the required opp-table for
393 if (required_table_np != new_table->np) {
398 required_opp_tables[i] = new_table;
399 _get_opp_table_kref(new_table);
402 ret = lazy_link_required_opps(opp_table, new_table, i);
404 /* The OPPs will be marked unusable */
412 /* All required opp-tables found, remove from lazy list */
414 list_del_init(&opp_table->lazy);
416 list_for_each_entry(opp, &opp_table->opp_list, node)
417 _required_opps_available(opp, opp_table->required_opp_count);
421 mutex_unlock(&opp_table_lock);
424 static int _bandwidth_supported(struct device *dev, struct opp_table *opp_table)
426 struct device_node *np, *opp_np;
427 struct property *prop;
430 np = of_node_get(dev->of_node);
434 opp_np = _opp_of_get_opp_desc_node(np, 0);
437 opp_np = of_node_get(opp_table->np);
440 /* Lets not fail in case we are parsing opp-v1 bindings */
444 /* Checking only first OPP is sufficient */
445 np = of_get_next_available_child(opp_np, NULL);
448 dev_err(dev, "OPP table empty\n");
452 prop = of_find_property(np, "opp-peak-kBps", NULL);
455 if (!prop || !prop->length)
461 int dev_pm_opp_of_find_icc_paths(struct device *dev,
462 struct opp_table *opp_table)
464 struct device_node *np;
465 int ret, i, count, num_paths;
466 struct icc_path **paths;
468 ret = _bandwidth_supported(dev, opp_table);
470 return 0; /* Empty OPP table is a valid corner-case, let's not fail */
476 np = of_node_get(dev->of_node);
480 count = of_count_phandle_with_args(np, "interconnects",
481 "#interconnect-cells");
486 /* two phandles when #interconnect-cells = <1> */
488 dev_err(dev, "%s: Invalid interconnects values\n", __func__);
492 num_paths = count / 2;
493 paths = kcalloc(num_paths, sizeof(*paths), GFP_KERNEL);
497 for (i = 0; i < num_paths; i++) {
498 paths[i] = of_icc_get_by_index(dev, i);
499 if (IS_ERR(paths[i])) {
500 ret = PTR_ERR(paths[i]);
501 if (ret != -EPROBE_DEFER) {
502 dev_err(dev, "%s: Unable to get path%d: %d\n",
510 opp_table->paths = paths;
511 opp_table->path_count = num_paths;
523 EXPORT_SYMBOL_GPL(dev_pm_opp_of_find_icc_paths);
525 static bool _opp_is_supported(struct device *dev, struct opp_table *opp_table,
526 struct device_node *np)
528 unsigned int levels = opp_table->supported_hw_count;
529 int count, versions, ret, i, j;
532 if (!opp_table->supported_hw) {
534 * In the case that no supported_hw has been set by the
535 * platform but there is an opp-supported-hw value set for
536 * an OPP then the OPP should not be enabled as there is
537 * no way to see if the hardware supports it.
539 if (of_find_property(np, "opp-supported-hw", NULL))
545 count = of_property_count_u32_elems(np, "opp-supported-hw");
546 if (count <= 0 || count % levels) {
547 dev_err(dev, "%s: Invalid opp-supported-hw property (%d)\n",
552 versions = count / levels;
554 /* All levels in at least one of the versions should match */
555 for (i = 0; i < versions; i++) {
556 bool supported = true;
558 for (j = 0; j < levels; j++) {
559 ret = of_property_read_u32_index(np, "opp-supported-hw",
560 i * levels + j, &val);
562 dev_warn(dev, "%s: failed to read opp-supported-hw property at index %d: %d\n",
563 __func__, i * levels + j, ret);
567 /* Check if the level is supported */
568 if (!(val & opp_table->supported_hw[j])) {
581 static u32 *_parse_named_prop(struct dev_pm_opp *opp, struct device *dev,
582 struct opp_table *opp_table,
583 const char *prop_type, bool *triplet)
585 struct property *prop = NULL;
590 /* Search for "opp-<prop_type>-<name>" */
591 if (opp_table->prop_name) {
592 snprintf(name, sizeof(name), "opp-%s-%s", prop_type,
593 opp_table->prop_name);
594 prop = of_find_property(opp->np, name, NULL);
598 /* Search for "opp-<prop_type>" */
599 snprintf(name, sizeof(name), "opp-%s", prop_type);
600 prop = of_find_property(opp->np, name, NULL);
605 count = of_property_count_u32_elems(opp->np, name);
607 dev_err(dev, "%s: Invalid %s property (%d)\n", __func__, name,
609 return ERR_PTR(count);
613 * Initialize regulator_count, if regulator information isn't provided
614 * by the platform. Now that one of the properties is available, fix the
615 * regulator_count to 1.
617 if (unlikely(opp_table->regulator_count == -1))
618 opp_table->regulator_count = 1;
620 if (count != opp_table->regulator_count &&
621 (!triplet || count != opp_table->regulator_count * 3)) {
622 dev_err(dev, "%s: Invalid number of elements in %s property (%u) with supplies (%d)\n",
623 __func__, prop_type, count, opp_table->regulator_count);
624 return ERR_PTR(-EINVAL);
627 out = kmalloc_array(count, sizeof(*out), GFP_KERNEL);
629 return ERR_PTR(-EINVAL);
631 ret = of_property_read_u32_array(opp->np, name, out, count);
633 dev_err(dev, "%s: error parsing %s: %d\n", __func__, name, ret);
635 return ERR_PTR(-EINVAL);
639 *triplet = count != opp_table->regulator_count;
644 static u32 *opp_parse_microvolt(struct dev_pm_opp *opp, struct device *dev,
645 struct opp_table *opp_table, bool *triplet)
649 microvolt = _parse_named_prop(opp, dev, opp_table, "microvolt", triplet);
650 if (IS_ERR(microvolt))
655 * Missing property isn't a problem, but an invalid
656 * entry is. This property isn't optional if regulator
657 * information is provided. Check only for the first OPP, as
658 * regulator_count may get initialized after that to a valid
661 if (list_empty(&opp_table->opp_list) &&
662 opp_table->regulator_count > 0) {
663 dev_err(dev, "%s: opp-microvolt missing although OPP managing regulators\n",
665 return ERR_PTR(-EINVAL);
672 static int opp_parse_supplies(struct dev_pm_opp *opp, struct device *dev,
673 struct opp_table *opp_table)
675 u32 *microvolt, *microamp, *microwatt;
679 microvolt = opp_parse_microvolt(opp, dev, opp_table, &triplet);
680 if (IS_ERR(microvolt))
681 return PTR_ERR(microvolt);
683 microamp = _parse_named_prop(opp, dev, opp_table, "microamp", NULL);
684 if (IS_ERR(microamp)) {
685 ret = PTR_ERR(microamp);
689 microwatt = _parse_named_prop(opp, dev, opp_table, "microwatt", NULL);
690 if (IS_ERR(microwatt)) {
691 ret = PTR_ERR(microwatt);
696 * Initialize regulator_count if it is uninitialized and no properties
699 if (unlikely(opp_table->regulator_count == -1)) {
700 opp_table->regulator_count = 0;
704 for (i = 0, j = 0; i < opp_table->regulator_count; i++) {
706 opp->supplies[i].u_volt = microvolt[j++];
709 opp->supplies[i].u_volt_min = microvolt[j++];
710 opp->supplies[i].u_volt_max = microvolt[j++];
712 opp->supplies[i].u_volt_min = opp->supplies[i].u_volt;
713 opp->supplies[i].u_volt_max = opp->supplies[i].u_volt;
718 opp->supplies[i].u_amp = microamp[i];
721 opp->supplies[i].u_watt = microwatt[i];
734 * dev_pm_opp_of_remove_table() - Free OPP table entries created from static DT
736 * @dev: device pointer used to lookup OPP table.
738 * Free OPPs created using static entries present in DT.
740 void dev_pm_opp_of_remove_table(struct device *dev)
742 dev_pm_opp_remove_table(dev);
744 EXPORT_SYMBOL_GPL(dev_pm_opp_of_remove_table);
746 static int _read_rate(struct dev_pm_opp *new_opp, struct opp_table *opp_table,
747 struct device_node *np)
749 struct property *prop;
753 prop = of_find_property(np, "opp-hz", NULL);
757 count = prop->length / sizeof(u64);
758 if (opp_table->clk_count != count) {
759 pr_err("%s: Count mismatch between opp-hz and clk_count (%d %d)\n",
760 __func__, count, opp_table->clk_count);
764 rates = kmalloc_array(count, sizeof(*rates), GFP_KERNEL);
768 ret = of_property_read_u64_array(np, "opp-hz", rates, count);
770 pr_err("%s: Error parsing opp-hz: %d\n", __func__, ret);
773 * Rate is defined as an unsigned long in clk API, and so
774 * casting explicitly to its type. Must be fixed once rate is 64
775 * bit guaranteed in clk API.
777 for (i = 0; i < count; i++) {
778 new_opp->rates[i] = (unsigned long)rates[i];
780 /* This will happen for frequencies > 4.29 GHz */
781 WARN_ON(new_opp->rates[i] != rates[i]);
790 static int _read_bw(struct dev_pm_opp *new_opp, struct opp_table *opp_table,
791 struct device_node *np, bool peak)
793 const char *name = peak ? "opp-peak-kBps" : "opp-avg-kBps";
794 struct property *prop;
798 prop = of_find_property(np, name, NULL);
802 count = prop->length / sizeof(u32);
803 if (opp_table->path_count != count) {
804 pr_err("%s: Mismatch between %s and paths (%d %d)\n",
805 __func__, name, count, opp_table->path_count);
809 bw = kmalloc_array(count, sizeof(*bw), GFP_KERNEL);
813 ret = of_property_read_u32_array(np, name, bw, count);
815 pr_err("%s: Error parsing %s: %d\n", __func__, name, ret);
819 for (i = 0; i < count; i++) {
821 new_opp->bandwidth[i].peak = kBps_to_icc(bw[i]);
823 new_opp->bandwidth[i].avg = kBps_to_icc(bw[i]);
831 static int _read_opp_key(struct dev_pm_opp *new_opp,
832 struct opp_table *opp_table, struct device_node *np)
837 ret = _read_rate(new_opp, opp_table, np);
840 else if (ret != -ENODEV)
844 * Bandwidth consists of peak and average (optional) values:
845 * opp-peak-kBps = <path1_value path2_value>;
846 * opp-avg-kBps = <path1_value path2_value>;
848 ret = _read_bw(new_opp, opp_table, np, true);
851 ret = _read_bw(new_opp, opp_table, np, false);
854 /* The properties were found but we failed to parse them */
855 if (ret && ret != -ENODEV)
858 if (!of_property_read_u32(np, "opp-level", &new_opp->level))
868 * _opp_add_static_v2() - Allocate static OPPs (As per 'v2' DT bindings)
869 * @opp_table: OPP table
870 * @dev: device for which we do this operation
873 * This function adds an opp definition to the opp table and returns status. The
874 * opp can be controlled using dev_pm_opp_enable/disable functions and may be
875 * removed by dev_pm_opp_remove.
881 * Duplicate OPPs (both freq and volt are same) and opp->available
882 * OR if the OPP is not supported by hardware.
884 * Freq are same and volt are different OR
885 * Duplicate OPPs (both freq and volt are same) and !opp->available
887 * Memory allocation failure
889 * Failed parsing the OPP node
891 static struct dev_pm_opp *_opp_add_static_v2(struct opp_table *opp_table,
892 struct device *dev, struct device_node *np)
894 struct dev_pm_opp *new_opp;
898 new_opp = _opp_allocate(opp_table);
900 return ERR_PTR(-ENOMEM);
902 ret = _read_opp_key(new_opp, opp_table, np);
904 dev_err(dev, "%s: opp key field not found\n", __func__);
908 /* Check if the OPP supports hardware's hierarchy of versions or not */
909 if (!_opp_is_supported(dev, opp_table, np)) {
910 dev_dbg(dev, "OPP not supported by hardware: %s\n",
911 of_node_full_name(np));
915 new_opp->turbo = of_property_read_bool(np, "turbo-mode");
917 new_opp->np = of_node_get(np);
918 new_opp->dynamic = false;
919 new_opp->available = true;
921 ret = _of_opp_alloc_required_opps(opp_table, new_opp);
925 if (!of_property_read_u32(np, "clock-latency-ns", &val))
926 new_opp->clock_latency_ns = val;
928 ret = opp_parse_supplies(new_opp, dev, opp_table);
930 goto free_required_opps;
932 if (opp_table->is_genpd)
933 new_opp->pstate = pm_genpd_opp_to_performance_state(dev, new_opp);
935 ret = _opp_add(dev, new_opp, opp_table);
937 /* Don't return error for duplicate OPPs */
940 goto free_required_opps;
943 /* OPP to select on device suspend */
944 if (of_property_read_bool(np, "opp-suspend")) {
945 if (opp_table->suspend_opp) {
946 /* Pick the OPP with higher rate/bw/level as suspend OPP */
947 if (_opp_compare_key(opp_table, new_opp, opp_table->suspend_opp) == 1) {
948 opp_table->suspend_opp->suspend = false;
949 new_opp->suspend = true;
950 opp_table->suspend_opp = new_opp;
953 new_opp->suspend = true;
954 opp_table->suspend_opp = new_opp;
958 if (new_opp->clock_latency_ns > opp_table->clock_latency_ns_max)
959 opp_table->clock_latency_ns_max = new_opp->clock_latency_ns;
961 pr_debug("%s: turbo:%d rate:%lu uv:%lu uvmin:%lu uvmax:%lu latency:%lu level:%u\n",
962 __func__, new_opp->turbo, new_opp->rates[0],
963 new_opp->supplies[0].u_volt, new_opp->supplies[0].u_volt_min,
964 new_opp->supplies[0].u_volt_max, new_opp->clock_latency_ns,
968 * Notify the changes in the availability of the operable
969 * frequency/voltage list.
971 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
975 _of_opp_free_required_opps(opp_table, new_opp);
979 return ret ? ERR_PTR(ret) : NULL;
982 /* Initializes OPP tables based on new bindings */
983 static int _of_add_opp_table_v2(struct device *dev, struct opp_table *opp_table)
985 struct device_node *np;
987 struct dev_pm_opp *opp;
989 /* OPP table is already initialized for the device */
990 mutex_lock(&opp_table->lock);
991 if (opp_table->parsed_static_opps) {
992 opp_table->parsed_static_opps++;
993 mutex_unlock(&opp_table->lock);
997 opp_table->parsed_static_opps = 1;
998 mutex_unlock(&opp_table->lock);
1000 /* We have opp-table node now, iterate over it and add OPPs */
1001 for_each_available_child_of_node(opp_table->np, np) {
1002 opp = _opp_add_static_v2(opp_table, dev, np);
1005 dev_err(dev, "%s: Failed to add OPP, %d\n", __func__,
1008 goto remove_static_opp;
1014 /* There should be one or more OPPs defined */
1016 dev_err(dev, "%s: no supported OPPs", __func__);
1018 goto remove_static_opp;
1021 list_for_each_entry(opp, &opp_table->opp_list, node) {
1022 /* Any non-zero performance state would enable the feature */
1024 opp_table->genpd_performance_state = true;
1029 lazy_link_required_opp_table(opp_table);
1034 _opp_remove_all_static(opp_table);
1039 /* Initializes OPP tables based on old-deprecated bindings */
1040 static int _of_add_opp_table_v1(struct device *dev, struct opp_table *opp_table)
1042 const struct property *prop;
1046 mutex_lock(&opp_table->lock);
1047 if (opp_table->parsed_static_opps) {
1048 opp_table->parsed_static_opps++;
1049 mutex_unlock(&opp_table->lock);
1053 opp_table->parsed_static_opps = 1;
1054 mutex_unlock(&opp_table->lock);
1056 prop = of_find_property(dev->of_node, "operating-points", NULL);
1059 goto remove_static_opp;
1063 goto remove_static_opp;
1067 * Each OPP is a set of tuples consisting of frequency and
1068 * voltage like <freq-kHz vol-uV>.
1070 nr = prop->length / sizeof(u32);
1072 dev_err(dev, "%s: Invalid OPP table\n", __func__);
1074 goto remove_static_opp;
1079 unsigned long freq = be32_to_cpup(val++) * 1000;
1080 unsigned long volt = be32_to_cpup(val++);
1082 ret = _opp_add_v1(opp_table, dev, freq, volt, false);
1084 dev_err(dev, "%s: Failed to add OPP %ld (%d)\n",
1085 __func__, freq, ret);
1086 goto remove_static_opp;
1094 _opp_remove_all_static(opp_table);
1099 static int _of_add_table_indexed(struct device *dev, int index)
1101 struct opp_table *opp_table;
1106 * If only one phandle is present, then the same OPP table
1107 * applies for all index requests.
1109 count = of_count_phandle_with_args(dev->of_node,
1110 "operating-points-v2", NULL);
1115 opp_table = _add_opp_table_indexed(dev, index, true);
1116 if (IS_ERR(opp_table))
1117 return PTR_ERR(opp_table);
1120 * OPPs have two version of bindings now. Also try the old (v1)
1121 * bindings for backward compatibility with older dtbs.
1124 ret = _of_add_opp_table_v2(dev, opp_table);
1126 ret = _of_add_opp_table_v1(dev, opp_table);
1129 dev_pm_opp_put_opp_table(opp_table);
1134 static void devm_pm_opp_of_table_release(void *data)
1136 dev_pm_opp_of_remove_table(data);
1139 static int _devm_of_add_table_indexed(struct device *dev, int index)
1143 ret = _of_add_table_indexed(dev, index);
1147 return devm_add_action_or_reset(dev, devm_pm_opp_of_table_release, dev);
1151 * devm_pm_opp_of_add_table() - Initialize opp table from device tree
1152 * @dev: device pointer used to lookup OPP table.
1154 * Register the initial OPP table with the OPP library for given device.
1156 * The opp_table structure will be freed after the device is destroyed.
1160 * Duplicate OPPs (both freq and volt are same) and opp->available
1161 * -EEXIST Freq are same and volt are different OR
1162 * Duplicate OPPs (both freq and volt are same) and !opp->available
1163 * -ENOMEM Memory allocation failure
1164 * -ENODEV when 'operating-points' property is not found or is invalid data
1166 * -ENODATA when empty 'operating-points' property is found
1167 * -EINVAL when invalid entries are found in opp-v2 table
1169 int devm_pm_opp_of_add_table(struct device *dev)
1171 return _devm_of_add_table_indexed(dev, 0);
1173 EXPORT_SYMBOL_GPL(devm_pm_opp_of_add_table);
1176 * dev_pm_opp_of_add_table() - Initialize opp table from device tree
1177 * @dev: device pointer used to lookup OPP table.
1179 * Register the initial OPP table with the OPP library for given device.
1183 * Duplicate OPPs (both freq and volt are same) and opp->available
1184 * -EEXIST Freq are same and volt are different OR
1185 * Duplicate OPPs (both freq and volt are same) and !opp->available
1186 * -ENOMEM Memory allocation failure
1187 * -ENODEV when 'operating-points' property is not found or is invalid data
1189 * -ENODATA when empty 'operating-points' property is found
1190 * -EINVAL when invalid entries are found in opp-v2 table
1192 int dev_pm_opp_of_add_table(struct device *dev)
1194 return _of_add_table_indexed(dev, 0);
1196 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table);
1199 * dev_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
1200 * @dev: device pointer used to lookup OPP table.
1201 * @index: Index number.
1203 * Register the initial OPP table with the OPP library for given device only
1204 * using the "operating-points-v2" property.
1206 * Return: Refer to dev_pm_opp_of_add_table() for return values.
1208 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
1210 return _of_add_table_indexed(dev, index);
1212 EXPORT_SYMBOL_GPL(dev_pm_opp_of_add_table_indexed);
1215 * devm_pm_opp_of_add_table_indexed() - Initialize indexed opp table from device tree
1216 * @dev: device pointer used to lookup OPP table.
1217 * @index: Index number.
1219 * This is a resource-managed variant of dev_pm_opp_of_add_table_indexed().
1221 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
1223 return _devm_of_add_table_indexed(dev, index);
1225 EXPORT_SYMBOL_GPL(devm_pm_opp_of_add_table_indexed);
1227 /* CPU device specific helpers */
1230 * dev_pm_opp_of_cpumask_remove_table() - Removes OPP table for @cpumask
1231 * @cpumask: cpumask for which OPP table needs to be removed
1233 * This removes the OPP tables for CPUs present in the @cpumask.
1234 * This should be used only to remove static entries created from DT.
1236 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
1238 _dev_pm_opp_cpumask_remove_table(cpumask, -1);
1240 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_remove_table);
1243 * dev_pm_opp_of_cpumask_add_table() - Adds OPP table for @cpumask
1244 * @cpumask: cpumask for which OPP table needs to be added.
1246 * This adds the OPP tables for CPUs present in the @cpumask.
1248 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
1250 struct device *cpu_dev;
1253 if (WARN_ON(cpumask_empty(cpumask)))
1256 for_each_cpu(cpu, cpumask) {
1257 cpu_dev = get_cpu_device(cpu);
1259 pr_err("%s: failed to get cpu%d device\n", __func__,
1265 ret = dev_pm_opp_of_add_table(cpu_dev);
1268 * OPP may get registered dynamically, don't print error
1271 pr_debug("%s: couldn't find opp table for cpu:%d, %d\n",
1272 __func__, cpu, ret);
1281 /* Free all other OPPs */
1282 _dev_pm_opp_cpumask_remove_table(cpumask, cpu);
1286 EXPORT_SYMBOL_GPL(dev_pm_opp_of_cpumask_add_table);
1289 * Works only for OPP v2 bindings.
1291 * Returns -ENOENT if operating-points-v2 bindings aren't supported.
1294 * dev_pm_opp_of_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with
1295 * @cpu_dev using operating-points-v2
1298 * @cpu_dev: CPU device for which we do this operation
1299 * @cpumask: cpumask to update with information of sharing CPUs
1301 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
1303 * Returns -ENOENT if operating-points-v2 isn't present for @cpu_dev.
1305 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev,
1306 struct cpumask *cpumask)
1308 struct device_node *np, *tmp_np, *cpu_np;
1311 /* Get OPP descriptor node */
1312 np = dev_pm_opp_of_get_opp_desc_node(cpu_dev);
1314 dev_dbg(cpu_dev, "%s: Couldn't find opp node.\n", __func__);
1318 cpumask_set_cpu(cpu_dev->id, cpumask);
1320 /* OPPs are shared ? */
1321 if (!of_property_read_bool(np, "opp-shared"))
1324 for_each_possible_cpu(cpu) {
1325 if (cpu == cpu_dev->id)
1328 cpu_np = of_cpu_device_node_get(cpu);
1330 dev_err(cpu_dev, "%s: failed to get cpu%d node\n",
1336 /* Get OPP descriptor node */
1337 tmp_np = _opp_of_get_opp_desc_node(cpu_np, 0);
1338 of_node_put(cpu_np);
1340 pr_err("%pOF: Couldn't find opp node\n", cpu_np);
1345 /* CPUs are sharing opp node */
1347 cpumask_set_cpu(cpu, cpumask);
1349 of_node_put(tmp_np);
1356 EXPORT_SYMBOL_GPL(dev_pm_opp_of_get_sharing_cpus);
1359 * of_get_required_opp_performance_state() - Search for required OPP and return its performance state.
1360 * @np: Node that contains the "required-opps" property.
1361 * @index: Index of the phandle to parse.
1363 * Returns the performance state of the OPP pointed out by the "required-opps"
1364 * property at @index in @np.
1366 * Return: Zero or positive performance state on success, otherwise negative
1369 int of_get_required_opp_performance_state(struct device_node *np, int index)
1371 struct dev_pm_opp *opp;
1372 struct device_node *required_np;
1373 struct opp_table *opp_table;
1374 int pstate = -EINVAL;
1376 required_np = of_parse_required_opp(np, index);
1380 opp_table = _find_table_of_opp_np(required_np);
1381 if (IS_ERR(opp_table)) {
1382 pr_err("%s: Failed to find required OPP table %pOF: %ld\n",
1383 __func__, np, PTR_ERR(opp_table));
1384 goto put_required_np;
1387 opp = _find_opp_of_np(opp_table, required_np);
1389 pstate = opp->pstate;
1390 dev_pm_opp_put(opp);
1393 dev_pm_opp_put_opp_table(opp_table);
1396 of_node_put(required_np);
1400 EXPORT_SYMBOL_GPL(of_get_required_opp_performance_state);
1403 * dev_pm_opp_get_of_node() - Gets the DT node corresponding to an opp
1404 * @opp: opp for which DT node has to be returned for
1406 * Return: DT node corresponding to the opp, else 0 on success.
1408 * The caller needs to put the node with of_node_put() after using it.
1410 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
1412 if (IS_ERR_OR_NULL(opp)) {
1413 pr_err("%s: Invalid parameters\n", __func__);
1417 return of_node_get(opp->np);
1419 EXPORT_SYMBOL_GPL(dev_pm_opp_get_of_node);
1422 * Callback function provided to the Energy Model framework upon registration.
1423 * It provides the power used by @dev at @kHz if it is the frequency of an
1424 * existing OPP, or at the frequency of the first OPP above @kHz otherwise
1425 * (see dev_pm_opp_find_freq_ceil()). This function updates @kHz to the ceiled
1426 * frequency and @uW to the associated power.
1428 * Returns 0 on success or a proper -EINVAL value in case of error.
1430 static int __maybe_unused
1431 _get_dt_power(struct device *dev, unsigned long *uW, unsigned long *kHz)
1433 struct dev_pm_opp *opp;
1434 unsigned long opp_freq, opp_power;
1436 /* Find the right frequency and related OPP */
1437 opp_freq = *kHz * 1000;
1438 opp = dev_pm_opp_find_freq_ceil(dev, &opp_freq);
1442 opp_power = dev_pm_opp_get_power(opp);
1443 dev_pm_opp_put(opp);
1447 *kHz = opp_freq / 1000;
1454 * Callback function provided to the Energy Model framework upon registration.
1455 * This computes the power estimated by @dev at @kHz if it is the frequency
1456 * of an existing OPP, or at the frequency of the first OPP above @kHz otherwise
1457 * (see dev_pm_opp_find_freq_ceil()). This function updates @kHz to the ceiled
1458 * frequency and @uW to the associated power. The power is estimated as
1459 * P = C * V^2 * f with C being the device's capacitance and V and f
1460 * respectively the voltage and frequency of the OPP.
1462 * Returns -EINVAL if the power calculation failed because of missing
1463 * parameters, 0 otherwise.
1465 static int __maybe_unused _get_power(struct device *dev, unsigned long *uW,
1468 struct dev_pm_opp *opp;
1469 struct device_node *np;
1470 unsigned long mV, Hz;
1475 np = of_node_get(dev->of_node);
1479 ret = of_property_read_u32(np, "dynamic-power-coefficient", &cap);
1485 opp = dev_pm_opp_find_freq_ceil(dev, &Hz);
1489 mV = dev_pm_opp_get_voltage(opp) / 1000;
1490 dev_pm_opp_put(opp);
1494 tmp = (u64)cap * mV * mV * (Hz / 1000000);
1495 /* Provide power in micro-Watts */
1496 do_div(tmp, 1000000);
1498 *uW = (unsigned long)tmp;
1504 static bool _of_has_opp_microwatt_property(struct device *dev)
1506 unsigned long power, freq = 0;
1507 struct dev_pm_opp *opp;
1509 /* Check if at least one OPP has needed property */
1510 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
1514 power = dev_pm_opp_get_power(opp);
1515 dev_pm_opp_put(opp);
1523 * dev_pm_opp_of_register_em() - Attempt to register an Energy Model
1524 * @dev : Device for which an Energy Model has to be registered
1525 * @cpus : CPUs for which an Energy Model has to be registered. For
1526 * other type of devices it should be set to NULL.
1528 * This checks whether the "dynamic-power-coefficient" devicetree property has
1529 * been specified, and tries to register an Energy Model with it if it has.
1530 * Having this property means the voltages are known for OPPs and the EM
1531 * might be calculated.
1533 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus)
1535 struct em_data_callback em_cb;
1536 struct device_node *np;
1540 if (IS_ERR_OR_NULL(dev)) {
1545 nr_opp = dev_pm_opp_get_opp_count(dev);
1551 /* First, try to find more precised Energy Model in DT */
1552 if (_of_has_opp_microwatt_property(dev)) {
1553 EM_SET_ACTIVE_POWER_CB(em_cb, _get_dt_power);
1557 np = of_node_get(dev->of_node);
1564 * Register an EM only if the 'dynamic-power-coefficient' property is
1565 * set in devicetree. It is assumed the voltage values are known if that
1566 * property is set since it is useless otherwise. If voltages are not
1567 * known, just let the EM registration fail with an error to alert the
1568 * user about the inconsistent configuration.
1570 ret = of_property_read_u32(np, "dynamic-power-coefficient", &cap);
1573 dev_dbg(dev, "Couldn't find proper 'dynamic-power-coefficient' in DT\n");
1578 EM_SET_ACTIVE_POWER_CB(em_cb, _get_power);
1581 ret = em_dev_register_perf_domain(dev, nr_opp, &em_cb, cpus, true);
1588 dev_dbg(dev, "Couldn't register Energy Model %d\n", ret);
1591 EXPORT_SYMBOL_GPL(dev_pm_opp_of_register_em);